qxk.hpp

Go to the documentation of this file.

//============================================================================
// QP/C++ Real-Time Embedded Framework (RTEF)
// Copyright (C) 2005 Quantum Leaps, LLC. All rights reserved.
//
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
//
// This software is dual-licensed under the terms of the open source GNU
// General Public License version 3 (or any later version), or alternatively,
// under the terms of one of the closed source Quantum Leaps commercial
// licenses.
//
// The terms of the open source GNU General Public License version 3
// can be found at: <www.gnu.org/licenses/gpl-3.0>
//
// The terms of the closed source Quantum Leaps commercial licenses
// can be found at: <www.state-machine.com/licensing>
//
// Redistributions in source code must retain this top-level comment block.
// Plagiarizing this software to sidestep the license obligations is illegal.
//
// Contact information:
// <www.state-machine.com>
// <info@state-machine.com>
//============================================================================
 
#ifndef QXK_HPP
#define QXK_HPP
 
#include "qequeue.hpp"  // QXK kernel uses the native QF event queue
#include "qmpool.hpp"   // QXK kernel uses the native QF memory pool
#include "qpset.hpp"    // QXK kernel uses the native QF priority set
 
//============================================================================
// QF configuration for QXK -- data members of the QActive class...
 
// QXK event-queue used for AOs
#define QF_EQUEUE_TYPE      QEQueue
 
// QXK OS-object used to store the private stack poiner for extended threads.
// (The private stack pointer is NULL for basic-threads).
//
#define QF_OS_OBJECT_TYPE   void*
 
// QXK thread type used to store the private Thread-Local Storage pointer.
#define QF_THREAD_TYPE      void*
 
#define QXK_TLS(type_) (static_cast<type_>(QXK_current()->m_thread))
 
 
//============================================================================
namespace QP {
    class QActive; // forward declaration
} // namespace QP
 
//============================================================================
extern "C" {
 
struct QXK_Attr {
    QP::QActive * volatile curr;      
    QP::QActive * volatile next;      
    std::uint8_t volatile actPrio;    
    std::uint8_t volatile lockPrio;   
    std::uint8_t volatile lockHolder; 
    std::uint8_t volatile intNest;    
    QP::QActive * idleThread;         
    QP::QPSet readySet;               
};
 
extern QXK_Attr QXK_attr_;
 
std::uint_fast8_t QXK_sched_(void) noexcept;
 
// the currently executing AOs.
//
void QXK_activate_(void);
 
QP::QActive *QXK_current(void) noexcept;
 
#ifdef QXK_ON_CONTEXT_SW
 
    void QXK_onContextSw(QP::QActive *prev, QP::QActive *next);
 
#endif // QXK_ON_CONTEXT_SW
 
} // extern "C"
 
//============================================================================
namespace QP {
 
using QSchedStatus = std::uint_fast16_t;
 
//============================================================================
class QXK {
public:
    static QSchedStatus schedLock(std::uint_fast8_t const ceiling) noexcept;
 
    static void schedUnlock(QSchedStatus const stat) noexcept;
 
    static void onIdle(void);
};
 
} // namespace QP
 
 
//============================================================================
// interface used only inside QF, but not in applications
 
#ifdef QP_IMPL
 
    #ifndef QXK_ISR_CONTEXT_
        // (ISR vs. thread).
        #define QXK_ISR_CONTEXT_() \
            (QXK_attr_.intNest != 0U)
    #endif // QXK_ISR_CONTEXT_
 
    // QXK-specific scheduler locking
    // that needs to be preserved to allow nesting of locks.
    //
    #define QF_SCHED_STAT_ QSchedStatus lockStat_;
 
    #define QF_SCHED_LOCK_(prio_) do {           \
        if (QXK_ISR_CONTEXT_()) {                \
            lockStat_ = 0xFFU;                   \
        } else {                                 \
            lockStat_ = QXK::schedLock((prio_)); \
        }                                        \
    } while (false)
 
    #define QF_SCHED_UNLOCK_() do {      \
        if (lockStat_ != 0xFFU) {        \
            QXK::schedUnlock(lockStat_); \
        }                                \
    } while (false)
 
    // QXK-specific native event queue operations...
    #define QACTIVE_EQUEUE_WAIT_(me_) \
        Q_ASSERT_ID(110, (me_)->m_eQueue.m_frontEvt != nullptr)
 
    #define QACTIVE_EQUEUE_SIGNAL_(me_) do {                   \
        QXK_attr_.readySet.insert(                             \
            static_cast<std::uint_fast8_t>((me_)->m_dynPrio)); \
        if (!QXK_ISR_CONTEXT_()) {                             \
            if (QXK_sched_() != 0U) {                          \
                QXK_activate_();                               \
            }                                                  \
        }                                                      \
    } while (false)
 
    // QXK-specific native QF event pool operations...
    #define QF_EPOOL_TYPE_  QMPool
    #define QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_) \
        (p_).init((poolSto_), (poolSize_), (evtSize_))
    #define QF_EPOOL_EVENT_SIZE_(p_)  ((p_).m_blockSize)
    #define QF_EPOOL_GET_(p_, e_, m_, qs_id_) \
        ((e_) = static_cast<QEvt *>((p_).get((m_), (qs_id_))))
    #define QF_EPOOL_PUT_(p_, e_, qs_id_) ((p_).put((e_), (qs_id_)))
 
#endif // QP_IMPL
 
#endif // QXK_HPP