8.1.4

Author: quantum-leaps

CMakeLists.txt

@@ -50,7 +50,7 @@ endif()
 
 project(
     qpc
-    VERSION "8.1.3"
+    VERSION "8.1.4"
     DESCRIPTION "QPC library"
     LANGUAGES C ASM
 )

examples

@@ -43,7 +43,9 @@
 
 // forward declarations (NOTE must be consistent with "qp.h")
 struct QEvt;
-typedef struct QEvt const * QEvtPtr;
+typedef struct {
+    struct QEvt const *e;
+} QEvtPtr;
 
 //============================================================================
 //! @class QEQueue

include/qequeue.h

@@ -30,10 +30,10 @@
 #define QP_H_
 
 //============================================================================
-#define QP_VERSION_STR  "8.1.3"
-#define QP_VERSION      813U
-// <VER>=813 <DATE>=260309
-#define QP_RELEASE      0x64D7FC82U
+#define QP_VERSION_STR  "8.1.4"
+#define QP_VERSION      814U
+// <VER>=814 <DATE>=260413
+#define QP_RELEASE      0x64C81E01U
 
 //----------------------------------------------------------------------------
 // default configuration settings
@@ -132,7 +132,9 @@ bool QEvt_verify_(QEvt const * const me);
 
 #ifndef QEQUEUE_H_
 // NOTE must be consistent with "qequeue.h"
-typedef QEvt const * QEvtPtr;
+typedef struct {
+    QEvt const *e;
+} QEvtPtr;
 #endif
 
 #define QEVT_DYNAMIC           ((uint8_t)0)

include/qp.h

@@ -100,18 +100,19 @@ bool QActive_post_(QActive * const me,
     Q_REQUIRE_INCRIT(100, e != (QEvt *)0);
 
     // the number of free slots available in the embOS queue
-    uint_fast16_t const nFree =
-        (uint_fast16_t)(me->eQueue.maxMsg - me->eQueue.nofMsg);
-
-    bool status = ((margin == QF_NO_MARGIN) || (nFree > (QEQueueCtr)margin));
+    QEQueueCtr const nFree =
+        (QEQueueCtr)(me->eQueue.maxMsg - me->eQueue.nofMsg);
 
+    bool status = ((margin == QF_NO_MARGIN)
+        || (nFree > (QEQueueCtr)margin));
     if (status) { // should try to post the event?
 #if (QF_MAX_EPOOL > 0U)
         if (e->poolNum_ != 0U) { // is it a mutable event?
             QEvt_refCtr_inc_(e); // increment the reference counter
         }
 #endif // (QF_MAX_EPOOL > 0U)
 
+        // assume that event posting will be successful, see NOTE3
         QS_BEGIN_PRE(QS_QF_ACTIVE_POST, me->prio)
             QS_TIME_PRE();      // timestamp
             QS_OBJ_PRE(sender); // the sender object
@@ -122,15 +123,19 @@ bool QActive_post_(QActive * const me,
             QS_EQC_PRE(0U);     // min # free entries (unknown)
         QS_END_PRE()
 
-        QF_CRIT_EXIT(); // exit crit.sect. before calling Zephyr API
+        QF_CRIT_EXIT(); // exit crit.sect. before calling RTOS API
+
+        // post the following evtPtr to the RTOS queue, see NOTE3
+        QEvtPtr const evtPtr = {
+            e
+        };
+        status = (OS_MAILBOX_Put(&me->eQueue,
+            (OS_CONST_PTR void *)&evtPtr) == '\0');
 
-        // post the event to the embOS event queue, see NOTE3
-        status = (OS_MAILBOX_Put(&me->eQueue, (OS_CONST_PTR void *)&e) == '\0');
+        QF_CRIT_ENTRY(); // re-enter crit.sec.
     }
 
     if (!status) { // event NOT posted?
-        QF_CRIT_ENTRY();
-
         // posting is allowed to fail only when margin != QF_NO_MARGIN
         Q_ASSERT_INCRIT(130, margin != QF_NO_MARGIN);
 
@@ -140,7 +145,7 @@ bool QActive_post_(QActive * const me,
             QS_SIG_PRE(e->sig); // the signal of the event
             QS_OBJ_PRE(me);     // this active object (recipient)
             QS_2U8_PRE(e->poolNum_, e->refCtr_); // pool-Num & ref-Count
-            QS_EQC_PRE(nFree);  // # free entries available
+            QS_EQC_PRE(nFree);  // # free entries
             QS_EQC_PRE(margin); // margin requested
         QS_END_PRE()
 
@@ -150,6 +155,9 @@ bool QActive_post_(QActive * const me,
         QF_gc(e); // recycle the event to avoid a leak
 #endif
     }
+    else {
+        QF_CRIT_EXIT();
+    }
 
     return status;
 }
@@ -179,11 +187,16 @@ void QActive_postLIFO_(QActive * const me, QEvt const * const e) {
 
     QF_CRIT_EXIT(); // exit crit.sect. before calling RTOS API
 
-    char err = OS_MAILBOX_PutFront(&me->eQueue, (OS_CONST_PTR void *)&e);
+    // post the following evtPtr to the RTOS queue, see NOTE3
+    QEvtPtr const evtPtr = {
+        e
+    };
+    char const err = OS_MAILBOX_PutFront(&me->eQueue,
+        (OS_CONST_PTR void *)&evtPtr);
 
 #ifndef Q_UNSAFE
     QF_CRIT_ENTRY();
-    // LIFO posting to embOS mailbox must succeed, see NOTE3
+    // LIFO posting to the RTOS queue must succeed, see NOTE3
     Q_ASSERT_INCRIT(230, err == '\0');
     QF_CRIT_EXIT();
 #else
@@ -194,21 +207,21 @@ void QActive_postLIFO_(QActive * const me, QEvt const * const e) {
 //! @private @memberof QActive
 QEvt const *QActive_get_(QActive * const me) {
     // wait for an event (forever)
-    QEvtPtr e;
-    OS_MAILBOX_GetBlocked(&me->eQueue, (void *)&e);
+    QEvtPtr evtPtr;
+    OS_MAILBOX_GetBlocked(&me->eQueue, (void *)&evtPtr);
 
     QS_CRIT_STAT
     QS_CRIT_ENTRY();
     QS_BEGIN_PRE(QS_QF_ACTIVE_GET, me->prio)
         QS_TIME_PRE();       // timestamp
-        QS_SIG_PRE(e->sig);  // the signal of this event
+        QS_SIG_PRE(evtPtr.e->sig); // the signal of this event
         QS_OBJ_PRE(me);      // this active object
-        QS_2U8_PRE(e->poolNum_, e->refCtr_); // pool-Num & ref-Count
+        QS_2U8_PRE(evtPtr.e->poolNum_, evtPtr.e->refCtr_);
         QS_EQC_PRE(me->eQueue.maxMsg - me->eQueue.nofMsg); // # free entries
     QS_END_PRE()
     QS_CRIT_EXIT();
 
-    return e;
+    return evtPtr.e;
 }
 //............................................................................
 //! @static @public @memberof QActive
@@ -243,7 +256,7 @@ void QActive_start(QActive * const me,
                 (OS_UINT)qLen,
                 (void *)&qSto[0]);
 
-    me->prio  = (uint8_t)(prioSpec & 0xFFU); // QF-priority of the AO
+    me->prio  = (uint8_t)(prioSpec & 0xFFU); // QP-priority
     me->pthre = 0U; // preemption-threshold (not used for AO registration)
     QActive_register_(me); // make QF aware of this AO
 
@@ -297,6 +310,7 @@ void QActive_setAttr(QActive *const me, uint32_t attr1, void const *attr2) {
 }
 
 //============================================================================
+// QF customization
 
 //............................................................................
 void QF_init(void) {
@@ -317,7 +331,7 @@ int_t QF_run(void) {
     QS_CRIT_EXIT();
 #endif // Q_SPY
 
-    OS_Start(); // start embOS multitasking
+    OS_Start(); // start embOS multitasking (does NOT return)
 
     return 0; // this unreachable return keeps the compiler happy
 }

ports/embos/qf_port.c

@@ -96,19 +96,19 @@ bool QActive_post_(QActive * const me,
     Q_REQUIRE_INCRIT(100, e != (QEvt *)0);
 
     // the number of free slots available in the FreeRTOS queue
-    uint_fast16_t const nFree =
-        (uint_fast16_t)FREERTOS_QUEUE_GET_FREE(me);
-
-    // should we try to post the event?
-    bool status = ((margin == QF_NO_MARGIN) || (nFree > (QEQueueCtr)margin));
+    QEQueueCtr const nFree =
+        (QEQueueCtr)FREERTOS_QUEUE_GET_FREE(me);
 
+    bool status = ((margin == QF_NO_MARGIN)
+        || (nFree > (QEQueueCtr)margin));
     if (status) { // should try to post the event?
 #if (QF_MAX_EPOOL > 0U)
         if (e->poolNum_ != 0U) { // is it a mutable event?
             QEvt_refCtr_inc_(e); // increment the reference counter
         }
 #endif // (QF_MAX_EPOOL > 0U)
 
+        // assume that event posting will be successful, see NOTE3
         QS_BEGIN_PRE(QS_QF_ACTIVE_POST, me->prio)
             QS_TIME_PRE();      // timestamp
             QS_OBJ_PRE(sender); // the sender object
@@ -121,14 +121,17 @@ bool QActive_post_(QActive * const me,
 
         QF_CRIT_EXIT(); // exit crit.sect. before calling RTOS API
 
-        // post the event to the FreeRTOS event queue, see NOTE3
+        // post the following evtPtr to the RTOS event queue, see NOTE3
+        QEvtPtr const evtPtr = {
+            e
+        };
         status = (xQueueSendToBack(
-            me->eQueue, (void const *)&e, (TickType_t)0) == pdPASS);
+            me->eQueue, (void const *)&evtPtr, 0U) == pdPASS);
+
+        QF_CRIT_ENTRY(); // re-enter crit.sec.
     }
 
     if (!status) { // event NOT posted?
-        QF_CRIT_ENTRY();
-
         // posting is allowed to fail only when margin != QF_NO_MARGIN
         Q_ASSERT_INCRIT(130, margin != QF_NO_MARGIN);
 
@@ -138,7 +141,7 @@ bool QActive_post_(QActive * const me,
             QS_SIG_PRE(e->sig); // the signal of the event
             QS_OBJ_PRE(me);     // this active object (recipient)
             QS_2U8_PRE(e->poolNum_, e->refCtr_); // pool-Num & ref-Count
-            QS_EQC_PRE(nFree);  // # free entries available
+            QS_EQC_PRE(nFree);  // # free entries
             QS_EQC_PRE(margin); // margin requested
         QS_END_PRE()
 
@@ -148,6 +151,9 @@ bool QActive_post_(QActive * const me,
         QF_gc(e); // recycle the event to avoid a leak
 #endif
     }
+    else {
+        QF_CRIT_EXIT();
+    }
 
     return status;
 }
@@ -171,14 +177,18 @@ void QActive_postLIFO_(QActive * const me, QEvt const * const e) {
         QS_SIG_PRE(e->sig);  // the signal of this event
         QS_OBJ_PRE(me);      // this active object
         QS_2U8_PRE(e->poolNum_, e->refCtr_); // pool-Num & ref-Count
-        QS_EQC_PRE(FREERTOS_QUEUE_GET_FREE(me)); // # free entries available
+        QS_EQC_PRE(FREERTOS_QUEUE_GET_FREE(me)); // # free entries
         QS_EQC_PRE(0U);      // min # free entries (unknown)
     QS_END_PRE()
 
     QF_CRIT_EXIT(); // exit crit.sect. before calling RTOS API
 
+    // post the following evtPtr to the RTOS event queue, see NOTE3
+    QEvtPtr const evtPtr = {
+        e
+    };
     BaseType_t const err =
-        xQueueSendToFront(me->eQueue, (void const *)&e, (TickType_t)0);
+        xQueueSendToFront(me->eQueue, (void const *)&evtPtr, 0U);
 
 #ifndef Q_UNSAFE
     QF_CRIT_ENTRY();
@@ -193,8 +203,9 @@ void QActive_postLIFO_(QActive * const me, QEvt const * const e) {
 //! @private @memberof QActive
 QEvt const *QActive_get_(QActive * const me) {
     // wait for an event (forever)
-    QEvtPtr e;
-    BaseType_t const err = xQueueReceive(me->eQueue, (void *)&e, portMAX_DELAY);
+    QEvtPtr evtPtr;
+    BaseType_t const err = xQueueReceive(me->eQueue,
+        (void *)&evtPtr, portMAX_DELAY);
 
     QF_CRIT_STAT
     QF_CRIT_ENTRY();
@@ -207,15 +218,15 @@ QEvt const *QActive_get_(QActive * const me) {
 
     QS_BEGIN_PRE(QS_QF_ACTIVE_GET, me->prio)
         QS_TIME_PRE();       // timestamp
-        QS_SIG_PRE(e->sig);  // the signal of this event
+        QS_SIG_PRE(evtPtr.e->sig); // the signal of this event
         QS_OBJ_PRE(me);      // this active object
-        QS_2U8_PRE(e->poolNum_, e->refCtr_); // pool-Num & ref-Count
+        QS_2U8_PRE(evtPtr.e->poolNum_, evtPtr.e->refCtr_);
         QS_EQC_PRE(FREERTOS_QUEUE_GET_FREE(me)); // # free entries available
     QS_END_PRE()
 
     QF_CRIT_EXIT();
 
-    return e;
+    return evtPtr.e;
 }
 //............................................................................
 //! @static @public @memberof QActive
@@ -343,12 +354,12 @@ bool QActive_postFromISR_(QActive * const me,
     Q_REQUIRE_INCRIT(600, e != (QEvt *)0);
 
     // the number of free slots available in the FreeRTOS queue
-    uint_fast16_t const nFree =
-        (uint_fast16_t)FREERTOS_QUEUE_GET_FREE(me);
+    QEQueueCtr const nFree =
+        (QEQueueCtr)FREERTOS_QUEUE_GET_FREE(me);
 
     // should we try to post the event?
-    bool status = ((margin == QF_NO_MARGIN) || (nFree > (QEQueueCtr)margin));
-
+    bool status = ((margin == QF_NO_MARGIN)
+        || (nFree > (QEQueueCtr)margin));
     if (status) { // should try to post the event?
 #if (QF_MAX_EPOOL > 0U)
         if (e->poolNum_ != 0U) { // is it a mutable event?
@@ -369,14 +380,17 @@ bool QActive_postFromISR_(QActive * const me,
         // exit crit.sect. before calling RTOS API
         portCLEAR_INTERRUPT_MASK_FROM_ISR(uxSavedInterruptStatus);
 
-        // post the event to the FreeRTOS event queue, see NOTE3
+        // post the following evtPtr to the RTOS event queue, see NOTE3
+        QEvtPtr const evtPtr = {
+            e
+        };
         status = (xQueueSendToBackFromISR(me->eQueue,
-            (void const *)&e, pxHigherPriorityTaskWoken) == pdPASS);
-    }
+            (void const *)&evtPtr, pxHigherPriorityTaskWoken) == pdPASS);
 
-    if (!status) { // event NOT posted?
         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
+    }
 
+    if (!status) { // event NOT posted?
         // posting is allowed to fail only when margin != QF_NO_MARGIN
         Q_ASSERT_INCRIT(630, margin != QF_NO_MARGIN);
 
@@ -396,6 +410,9 @@ bool QActive_postFromISR_(QActive * const me,
         QF_gcFromISR(e); // recycle the event to avoid a leak
 #endif
     }
+    else {
+        portCLEAR_INTERRUPT_MASK_FROM_ISR(uxSavedInterruptStatus);
+    }
 
     return status;
 }

ports/freertos/qf_port.c

@@ -268,7 +268,7 @@ int QF_run(void) {
 #endif
 
             QF_CRIT_ENTRY();
-            if (a->eQueue.frontEvt == (QEvt *)0) { // empty queue?
+            if (a->eQueue.frontEvt.e == (QEvt *)0) { // empty queue?
                 QPSet_remove(&QF_readySet_, p);
             }
         }

ports/posix-qv/qf_port.c

@@ -97,7 +97,7 @@ void QF_onClockTick(void);
 
 // QF event queue customization for POSIX...
 #define QACTIVE_EQUEUE_WAIT_(me_) do { \
-    while ((me_)->eQueue.frontEvt == (QEvt *)0) { \
+    while ((me_)->eQueue.frontEvt.e == (QEvt *)0) { \
         Q_ASSERT_INCRIT(400, QF_critSectNest_ == 1); \
         --QF_critSectNest_; \
         pthread_cond_wait(&(me_)->osObject, &QF_critSectMutex_); \

ports/posix/qp_port.h

@@ -206,7 +206,7 @@ static void handle_evts(void) {
         QF_gc(e); // check if the event is garbage, and collect it if so
         QS_FLUSH();
 #endif
-        if (a->eQueue.frontEvt == (QEvt*)0) { // empty queue?
+        if (a->eQueue.frontEvt.e == (QEvt*)0) { // empty queue?
             QPSet_remove(&QF_readySet_, p);
         }
     }