GitHub/qpcpp
1
0
Fork 0
mirror of https://github.com/QuantumLeaps/qpcpp.git synced 2025-01-28 06:02:56 +08:00
Code Issues Projects Releases Wiki Activity
qpcpp/source/qf_act.cpp
Quantum Leaps ad40d87874 5.6.1
2015-12-31 14:56:37 -05:00

357 lines
18 KiB
C++
Raw Blame History

/// @file
/// @brief QP::QMActive services and QF support code
/// @ingroup qf
/// @cond
///***************************************************************************
/// Last updated for version 5.6.0
/// Last updated on 2015-12-26
///
/// Q u a n t u m L e a P s
/// ---------------------------
/// innovating embedded systems
///
/// Copyright (C) Quantum Leaps. All rights reserved.
///
/// This program is open source software: you can redistribute it and/or
/// modify it under the terms of the GNU General Public License as published
/// by the Free Software Foundation, either version 3 of the License, or
/// (at your option) any later version.
///
/// Alternatively, this program may be distributed and modified under the
/// terms of Quantum Leaps commercial licenses, which expressly supersede
/// the GNU General Public License and are specifically designed for
/// licensees interested in retaining the proprietary status of their code.
///
/// This program is distributed in the hope that it will be useful,
/// but WITHOUT ANY WARRANTY; without even the implied warranty of
/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
/// GNU General Public License for more details.
///
/// You should have received a copy of the GNU General Public License
/// along with this program. If not, see <http://www.gnu.org/licenses/>.
///
/// Contact information:
/// http://www.state-machine.com
/// mailto:info@state-machine.com
///***************************************************************************
/// @endcond
#define QP_IMPL // this is QP implementation
#include "qf_port.h" // QF port
#include "qf_pkg.h" // QF package-scope interface
#include "qassert.h" // QP embedded systems-friendly assertions
#ifdef Q_SPY // QS software tracing enabled?
#include "qs_port.h" // include QS port
#else
#include "qs_dummy.h" // disable the QS software tracing
#endif // Q_SPY
namespace QP {
Q_DEFINE_THIS_MODULE("qf_act")
// public objects ************************************************************
QMActive *QF::active_[QF_MAX_ACTIVE + 1]; // to be used by QF ports only
//****************************************************************************
/// @description
/// This function adds a given active object to the active objects managed
/// by the QF framework. It should not be called by the application directly,
/// only through the function QP::QMActive::start().
///
/// @param[in] a pointer to the active object to add to the framework.
///
/// @note The priority of the active object @p a should be set before calling
/// this function.
///
/// @sa QP::QF::remove_()
///
void QF::add_(QMActive * const a) {
uint_fast8_t p = a->m_prio;
Q_REQUIRE_ID(100, (static_cast<uint_fast8_t>(0) < p)
&& (p <= static_cast<uint_fast8_t>(QF_MAX_ACTIVE))
&& (active_[p] == static_cast<QMActive *>(0)));
QF_CRIT_STAT_
QF_CRIT_ENTRY_();
active_[p] = a; // registger the active object at this priority
QS_BEGIN_NOCRIT_(QS_QF_ACTIVE_ADD, QS::priv_.aoObjFilter, a)
QS_TIME_(); // timestamp
QS_OBJ_(a); // the active object
QS_U8_(p); // the priority of the active object
QS_END_NOCRIT_()
QF_CRIT_EXIT_();
}
//****************************************************************************
/// @description
/// This function removes a given active object from the active objects
/// managed by the QF framework. It should not be called by the application
/// directly, only through the function QP::QMActive::stop().
///
/// @param[in] a pointer to the active object to remove from the framework.
///
/// @note The active object that is removed from the framework can no longer
/// participate in the publish-subscribe event exchange.
///
/// @sa QP::QF::add_()
///
void QF::remove_(QMActive const * const a) {
uint_fast8_t p = a->m_prio;
Q_REQUIRE_ID(200, (static_cast<uint_fast8_t>(0) < p)
&& (p <= static_cast<uint_fast8_t>(QF_MAX_ACTIVE))
&& (active_[p] == a));
QF_CRIT_STAT_
QF_CRIT_ENTRY_();
active_[p] = static_cast<QMActive *>(0); // free-up the priority level
QS_BEGIN_NOCRIT_(QS_QF_ACTIVE_REMOVE, QS::priv_.aoObjFilter, a)
QS_TIME_(); // timestamp
QS_OBJ_(a); // the active object
QS_U8_(p); // the priority of the active object
QS_END_NOCRIT_()
QF_CRIT_EXIT_();
}
//****************************************************************************
/// @description
/// macro to encapsulate pointer increment, which violates MISRA-C:2004
/// required rule 17.4 (pointer arithmetic used).
///
/// @param[in] p_ pointer to be incremented.
///
#define QF_PTR_INC_(p_) (++(p_))
//****************************************************************************
/// @description
/// Clears a memory buffer by writing zeros byte-by-byte.
///
/// @param[in] start pointer to the beginning of a memory buffer.
/// @param[in] len length of the memory buffer to clear (in bytes)
///
/// @note The main application of this function is clearing the internal QF
/// variables upon startup. This is done to avoid problems with non-standard
/// startup code provided with some compilers and toolsets (e.g., TI DSPs or
/// Microchip MPLAB), which does not zero the uninitialized variables, as
/// required by the ANSI C standard.
///
void QF::bzero(void * const start, uint_fast16_t len) {
uint8_t *ptr = static_cast<uint8_t *>(start);
while (len != static_cast<uint_fast16_t>(0)) {
*ptr = static_cast<uint8_t>(0);
QF_PTR_INC_(ptr);
--len;
}
}
// power-of-two lookup tables ************************************************
uint8_t const QF_pwr2Lkup[65] = {
static_cast<uint8_t>(0x00), // unused location
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80),
static_cast<uint8_t>(0x01), static_cast<uint8_t>(0x02),
static_cast<uint8_t>(0x04), static_cast<uint8_t>(0x08),
static_cast<uint8_t>(0x10), static_cast<uint8_t>(0x20),
static_cast<uint8_t>(0x40), static_cast<uint8_t>(0x80)
};
uint8_t const QF_invPwr2Lkup[65] = {
static_cast<uint8_t>(0xFF), // unused location
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F),
static_cast<uint8_t>(0xFE), static_cast<uint8_t>(0xFD),
static_cast<uint8_t>(0xFB), static_cast<uint8_t>(0xF7),
static_cast<uint8_t>(0xEF), static_cast<uint8_t>(0xDF),
static_cast<uint8_t>(0xBF), static_cast<uint8_t>(0x7F)
};
uint8_t const QF_div8Lkup[65] = {
static_cast<uint8_t>(0), // unused location
static_cast<uint8_t>(0), static_cast<uint8_t>(0), static_cast<uint8_t>(0),
static_cast<uint8_t>(0), static_cast<uint8_t>(0), static_cast<uint8_t>(0),
static_cast<uint8_t>(0), static_cast<uint8_t>(0),
static_cast<uint8_t>(1), static_cast<uint8_t>(1), static_cast<uint8_t>(1),
static_cast<uint8_t>(1), static_cast<uint8_t>(1), static_cast<uint8_t>(1),
static_cast<uint8_t>(1), static_cast<uint8_t>(1),
static_cast<uint8_t>(2), static_cast<uint8_t>(2), static_cast<uint8_t>(2),
static_cast<uint8_t>(2), static_cast<uint8_t>(2), static_cast<uint8_t>(2),
static_cast<uint8_t>(2), static_cast<uint8_t>(2),
static_cast<uint8_t>(3), static_cast<uint8_t>(3), static_cast<uint8_t>(3),
static_cast<uint8_t>(3), static_cast<uint8_t>(3), static_cast<uint8_t>(3),
static_cast<uint8_t>(3), static_cast<uint8_t>(3),
static_cast<uint8_t>(4), static_cast<uint8_t>(4), static_cast<uint8_t>(4),
static_cast<uint8_t>(4), static_cast<uint8_t>(4), static_cast<uint8_t>(4),
static_cast<uint8_t>(4), static_cast<uint8_t>(4),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7)
};
/* log-base-2 lookup table **************************************************/
#ifdef QF_LOG2LKUP
uint8_t const QF_log2Lkup[256] = {
static_cast<uint8_t>(0),
static_cast<uint8_t>(1),
static_cast<uint8_t>(2), static_cast<uint8_t>(2),
static_cast<uint8_t>(3), static_cast<uint8_t>(3), static_cast<uint8_t>(3),
static_cast<uint8_t>(3),
static_cast<uint8_t>(4), static_cast<uint8_t>(4), static_cast<uint8_t>(4),
static_cast<uint8_t>(4), static_cast<uint8_t>(4), static_cast<uint8_t>(4),
static_cast<uint8_t>(4), static_cast<uint8_t>(4),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5), static_cast<uint8_t>(5), static_cast<uint8_t>(5),
static_cast<uint8_t>(5),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(6), static_cast<uint8_t>(6),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7), static_cast<uint8_t>(7), static_cast<uint8_t>(7),
static_cast<uint8_t>(7),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8), static_cast<uint8_t>(8),
static_cast<uint8_t>(8), static_cast<uint8_t>(8)
};
#endif // #ifdef QF_LOG2LKUP
} // namespace QP
Reference in New Issue View Git Blame Copy Permalink