QP/C++  5.9.5
QP::QF Class Reference

QF services. More...

#include <qf.h>

Static Public Member Functions

static char_t const * getVersion (void)
 get the current QF version number string of the form X.Y.Z
 
static void init (void)
 QF initialization. More...
 
static void psInit (QSubscrList *const subscrSto, enum_t const maxSignal)
 Publish-subscribe initialization. More...
 
static void poolInit (void *const poolSto, uint_fast32_t const poolSize, uint_fast16_t const evtSize)
 Event pool initialization for dynamic allocation of events. More...
 
static uint_fast16_t poolGetMaxBlockSize (void)
 Obtain the block size of any registered event pools. More...
 
static int_t run (void)
 Transfers control to QF to run the application. More...
 
static void onStartup (void)
 Startup QF callback.
 
static void onCleanup (void)
 Cleanup QF callback.
 
static void stop (void)
 Function invoked by the application layer to stop the QF application and return control to the OS/Kernel. More...
 
static void publish_ (QEvt const *e, void const *sender)
 Publish event to the framework. More...
 
static void tickX_ (uint_fast8_t const tickRate, void const *const sender)
 Processes all armed time events at every clock tick. More...
 
static bool noTimeEvtsActiveX (uint_fast8_t const tickRate)
 Returns true if all time events are inactive and false any time event is active. More...
 
static uint_fast16_t getPoolMin (uint_fast8_t const poolId)
 This function returns the minimum of free entries of the given event pool. More...
 
static uint_fast16_t getQueueMin (uint_fast8_t const prio)
 This function returns the minimum of free entries of the given event queue. More...
 
static QEvtnewX_ (uint_fast16_t const evtSize, uint_fast16_t const margin, enum_t const sig)
 Internal QP implementation of the dynamic event allocator. More...
 
static void gc (QEvt const *e)
 Recycle a dynamic event. More...
 
static QEvt const * newRef_ (QEvt const *const e, QEvt const *const evtRef)
 Internal QF implementation of the event reference creator. More...
 
static void remove_ (QActive *const a)
 Remove the active object from the framework. More...
 
static void thread_ (QActive *act)
 Thread routine for executing an active object act.
 
static void add_ (QActive *const a)
 Register an active object to be managed by the framework. More...
 
static void bzero (void *const start, uint_fast16_t len)
 Clear a specified region of memory to zero. More...
 

Static Public Attributes

static QActiveactive_ [QF_MAX_ACTIVE+1]
 array of registered active objects
 

Friends

class QActive
 
class QTimeEvt
 

Detailed Description

QF services.

Description
This class groups together QF services. It has only static members and should not be instantiated.

Definition at line 479 of file qf.h.

Member Function Documentation

◆ add_()

void QP::QF::add_ ( QActive *const  a)
static

Register an active object to be managed by the framework.

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::QActive::start().
Parameters
[in]apointer to the active object to add to the framework.
Note
The priority of the active object a should be set before calling this function.
See also
QP::QF::remove_()

Definition at line 69 of file qf_act.cpp.

◆ bzero()

void QP::QF::bzero ( void *const  start,
uint_fast16_t  len 
)
static

Clear a specified region of memory to zero.

Description
Clears a memory buffer by writing zeros byte-by-byte.
Parameters
[in]startpointer to the beginning of a memory buffer.
[in]lenlength 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.

Definition at line 147 of file qf_act.cpp.

◆ gc()

void QP::QF::gc ( QEvt const *  e)
static

Recycle a dynamic event.

Description
This function implements a simple garbage collector for dynamic events. Only dynamic events are candidates for recycling. (A dynamic event is one that is allocated from an event pool, which is determined as non-zero e->poolId_ attribute.) Next, the function decrements the reference counter of the event (e->refCtr_), and recycles the event only if the counter drops to zero (meaning that no more references are outstanding for this event). The dynamic event is recycled by returning it to the pool from which it was originally allocated.
Parameters
[in]epointer to the event to recycle
Note
QF invokes the garbage collector at all appropriate contexts, when an event can become garbage (automatic garbage collection), so the application code should have no need to call QP::QF::gc() directly. The QP::QF::gc() function is exposed only for special cases when your application sends dynamic events to the "raw" thread-safe queues (see QP::QEQueue). Such queues are processed outside of QF and the automatic garbage collection is NOT performed for these events. In this case you need to call QP::QF::gc() explicitly.

Definition at line 197 of file qf_dyn.cpp.

◆ getPoolMin()

uint_fast16_t QP::QF::getPoolMin ( uint_fast8_t const  poolId)
static

This function returns the minimum of free entries of the given event pool.

Description
This function obtains the minimum number of free blocks in the given event pool since this pool has been initialized by a call to QP::QF::poolInit().
Parameters
[in]poolIdevent pool ID in the range 1..QF_maxPool_, where QF_maxPool_ is the number of event pools initialized with the function QP::QF::poolInit().
Returns
the minimum number of unused blocks in the given event pool.
Precondition
the poolId must be in range

Definition at line 294 of file qf_mem.cpp.

◆ getQueueMin()

uint_fast16_t QP::QF::getQueueMin ( uint_fast8_t const  prio)
static

This function returns the minimum of free entries of the given event queue.

Description
Queries the minimum of free ever present in the given event queue of an active object with priority prio, since the active object was started.
Note
QP::QF::getQueueMin() is available only when the native QF event queue implementation is used. Requesting the queue minimum of an unused priority level raises an assertion in the QF. (A priority level becomes used in QF after the call to the QP::QF::add_() function.)
Parameters
[in]prioPriority of the active object, whose queue is queried
Returns
the minimum of free ever present in the given event queue of an active object with priority prio, since the active object was started.

Definition at line 319 of file qf_actq.cpp.

◆ init()

void QP::QF::init ( void  )
static

QF initialization.

Description
Initializes QF and must be called exactly once before any other QF function. Typcially, QP::QF::init() is called from main() even before initializing the Board Support Package (BSP).
Note
QP::QF::init() clears the internal QF variables, so that the framework can start correctly even if the startup code fails to clear the uninitialized data (as is required by the C Standard).
Description
Initializes QF and must be called exactly once before any other QF function. Typically, QF_init() is called from main() even before initializing the Board Support Package (BSP).
Note
QF::init() clears the internal QF variables, so that the framework can start correctly even if the startup code fails to clear the uninitialized data (as is required by the C+ Standard).

Definition at line 77 of file qk.cpp.

◆ newRef_()

QEvt const * QP::QF::newRef_ ( QEvt const *const  e,
QEvt const *const  evtRef 
)
static

Internal QF implementation of the event reference creator.

Description
Creates and returns a new reference to the current event e
Parameters
[in]epointer to the current event
[in]evtRefthe event reference
Returns
the newly created reference to the event e
Note
The application code should not call this function directly. The only allowed use is thorough the macro Q_NEW_REF().

Definition at line 257 of file qf_dyn.cpp.

◆ newX_()

QEvt * QP::QF::newX_ ( uint_fast16_t const  evtSize,
uint_fast16_t const  margin,
enum_t const  sig 
)
static

Internal QP implementation of the dynamic event allocator.

Description
Allocates an event dynamically from one of the QF event pools.
Parameters
[in]evtSizethe size (in bytes) of the event to allocate
[in]marginthe number of un-allocated events still available in a given event pool after the allocation completes The special value QP::QF_NO_MARGIN means that this function will assert if allocation fails.
[in]sigthe signal to be assigned to the allocated event
Returns
pointer to the newly allocated event. This pointer can be NULL only if margin!=0 and the event cannot be allocated with the specified margin still available in the given pool.
Note
The internal QF function QP::QF::newX_() raises an assertion when the margin argument is QP::QF_NO_MARGIN and allocation of the event turns out to be impossible due to event pool depletion, or incorrect (too big) size of the requested event.
The application code should not call this function directly. The only allowed use is thorough the macros Q_NEW() or Q_NEW_X().

Definition at line 129 of file qf_dyn.cpp.

◆ noTimeEvtsActiveX()

bool QP::QF::noTimeEvtsActiveX ( uint_fast8_t const  tickRate)
static

Returns true if all time events are inactive and false any time event is active.

Description
Find out if any time events are armed at the given clock tick rate.
Parameters
[in]tickRatesystem clock tick rate to find out about.
Returns
'true' if no time events are armed at the given tick rate and 'false' otherwise.
Note
This function should be called in critical section.
Precondition
the tick rate must be in range

Definition at line 197 of file qf_time.cpp.

◆ poolGetMaxBlockSize()

uint_fast16_t QP::QF::poolGetMaxBlockSize ( void  )
static

Obtain the block size of any registered event pools.

Description
Obtain the block size of any registered event pools

Definition at line 276 of file qf_dyn.cpp.

◆ poolInit()

void QP::QF::poolInit ( void *const  poolSto,
uint_fast32_t const  poolSize,
uint_fast16_t const  evtSize 
)
static

Event pool initialization for dynamic allocation of events.

Description
This function initializes one event pool at a time and must be called exactly once for each event pool before the pool can be used.

Many RTOSes provide fixed block-size heaps, a.k.a. memory pools that can be adapted for QF event pools. In case such support is missing, QF provides a native QF event pool implementation. The macro QF_EPOOL_TYPE_ determines the type of event pool used by a particular QF port. See class QP::QMPool for more information.
Parameters
[in]poolStopointer to the storage for the event pool
[in]poolSizesize of the storage for the pool in bytes
[in]evtSizethe block-size of the pool in bytes, which determines the maximum size of events that can be allocated from the pool
Note
You might initialize many event pools by making many consecutive calls to the QF_poolInit() function. However, for the simplicity of the internal implementation, you must initialize event pools in the ascending order of the event size.
The actual number of events available in the pool might be actually less than (poolSize / evtSize) due to the internal alignment of the blocks that the pool might perform. You can always check the capacity of the pool by calling QF_getPoolMin().
The dynamic allocation of events is optional, meaning that you might choose not to use dynamic events. In that case calling QP::QF::poolInit() and using up memory for the memory blocks is unnecessary.
See also
QF initialization example for QP::QF::init()
Precondition
cannot exceed the number of available memory pools
please initialize event pools in ascending order of evtSize

Definition at line 90 of file qf_dyn.cpp.

◆ psInit()

void QP::QF::psInit ( QSubscrList *const  subscrSto,
enum_t const  maxSignal 
)
static

Publish-subscribe initialization.

Description
This function initializes the publish-subscribe facilities of QF and must be called exactly once before any subscriptions/publications occur in the application.
Parameters
[in]subscrStopointer to the array of subscriber lists
[in]maxSignalthe dimension of the subscriber array and at the same time the maximum signal that can be published or subscribed.

The array of subscriber-lists is indexed by signals and provides a mapping between the signals and subscriber-lists. The subscriber-lists are bitmasks of type QP::QSubscrList, each bit in the bit mask corresponding to the unique priority of an active object. The size of the QP::QSubscrList bitmask depends on the value of the QF_MAX_ACTIVE macro.

Note
The publish-subscribe facilities are optional, meaning that you might choose not to use publish-subscribe. In that case calling QF::psInit() and using up memory for the subscriber-lists is unnecessary.
See also
QP::QSubscrList
Usage
The following example shows the typical initialization sequence of QF:
#include "qp_port.h"
#include "dpp.h"
#include "bsp.h"
namespace DPP {
//............................................................................
int_t main(void) {
// statically allocated storage for various QP facilities
static QP::QEvt const *tableQueueSto[N_PHILO];
static QP::QEvt const *philoQueueSto[N_PHILO][N_PHILO];
static QP::QSubscrList subscrSto[MAX_PUB_SIG];
static QF_MPOOL_EL(TableEvt) smlPoolSto[2*N_PHILO];
QP::QF::init(); // initialize the framework and the underlying RT kernel
BSP::init(); // initialize the BSP
// object dictionaries...
QS_OBJ_DICTIONARY(smlPoolSto);
QS_OBJ_DICTIONARY(tableQueueSto);
QS_OBJ_DICTIONARY(philoQueueSto[0]);
QS_OBJ_DICTIONARY(philoQueueSto[1]);
QS_OBJ_DICTIONARY(philoQueueSto[2]);
QS_OBJ_DICTIONARY(philoQueueSto[3]);
QS_OBJ_DICTIONARY(philoQueueSto[4]);
QP::QF::psInit(subscrSto, Q_DIM(subscrSto)); // init publish-subscribe
// initialize event pools...
QP::QF::poolInit(smlPoolSto,
sizeof(smlPoolSto), sizeof(smlPoolSto[0]));
// start the active objects...
for (uint8_t n = 0U; n < N_PHILO; ++n) {
AO_Philo[n]->start((uint8_t)(n + 1U),
philoQueueSto[n], Q_DIM(philoQueueSto[n]),
(void *)0, 0U);
}
AO_Table->start((uint8_t)(N_PHILO + 1U),
tableQueueSto, Q_DIM(tableQueueSto),
(void *)0, 0U);
return QP::QF::run(); // run the QF application
}
} // namespace DPP

Definition at line 86 of file qf_ps.cpp.

◆ publish_()

void QP::QF::publish_ ( QEvt const *  e,
void const *  sender 
)
static

Publish event to the framework.

Description
This function posts (using the FIFO policy) the event e to all active objects that have subscribed to the signal e->sig, which is called multicasting. The multicasting performed in this function is very efficient based on reference-counting inside the published event ("zero-copy" event multicasting). This function is designed to be callable from any part of the system, including ISRs, device drivers, and active objects.
Note
To avoid any unexpected re-ordering of events posted into AO queues, the event multicasting is performed with scheduler locked. However, the scheduler is locked only up to the priority level of the highest- priority subscriber, so any AOs of even higher priority, which did not subscribe to this event are not affected.
Precondition
the published signal must be within the configured range

Definition at line 118 of file qf_ps.cpp.

◆ remove_()

void QP::QF::remove_ ( QActive *const  a)
static

Remove the active object from the framework.

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::QActive::stop().
Parameters
[in]apointer 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.
See also
QP::QF::add_()

Definition at line 103 of file qf_act.cpp.

◆ run()

int_t QP::QF::run ( void  )
static

Transfers control to QF to run the application.

Description
QP::QF::run() is typically called from your startup code after you initialize the QF and start at least one active object with QP::QActive::start().
Returns
QP::QF::run() typically does not return in embedded applications. However, when QP runs on top of an operating system, QP::QF::run() might return and in this case the return represents the error code (0 for success). Typically the value returned from QP::QF::run() is subsequently passed on as return from main().
Note
This function is strongly platform-dependent and is not implemented in the QF, but either in the QF port or in the Board Support Package (BSP) for the given application. All QF ports must implement QP::QF::run().
Description
QP::QF::run() is typically called from your startup code after you initialize the QF and start at least one basic- or extended-thread (with QP::QActive::start() or QP::QXThread::start(), respectively).
Returns
In QXK, the QF::run() function does not return.

Definition at line 139 of file qk.cpp.

◆ stop()

void QP::QF::stop ( void  )
static

Function invoked by the application layer to stop the QF application and return control to the OS/Kernel.

Description
This function stops the QF application. After calling this function, QF attempts to gracefully stop the application. This graceful shutdown might take some time to complete. The typical use of this function is for terminating the QF application to return back to the operating system or for handling fatal errors that require shutting down (and possibly re-setting) the system.
See also
QP::QF::onCleanup()
Description
This function stops the QF application. After calling this function, QF attempts to gracefully stop the application. This graceful shutdown might take some time to complete. The typical use of this function is for terminating the QF application to return back to the operating system or for handling fatal errors that require shutting down (and possibly re-setting) the system.
See also
QF::onCleanup()

Definition at line 106 of file qk.cpp.

◆ tickX_()

void QP::QF::tickX_ ( uint_fast8_t const  tickRate,
void const *const  sender 
)
static

Processes all armed time events at every clock tick.

Description
This function must be called periodically from a time-tick ISR or from a task so that QF can manage the timeout events assigned to the given system clock tick rate.
Parameters
[in]tickRatesystem clock tick rate serviced in this call.
Note
this function should be called only via the macro TICK_X()
the calls to QP::QF::tickX_() with different tick rate argument can preempt each other. For example, higher clock tick rates might be serviced from interrupts while others from tasks (active objects).
See also
QP::QTimeEvt.

Definition at line 76 of file qf_time.cpp.


The documentation for this class was generated from the following files: