SuperTinyKernel™ RTOS 1.08.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
stk::sync::SemaphoreT< T > Class Template Referencefinal

Counting semaphore primitive for resource management and signaling, with a selectable counter type. More...

#include <stk_sync_semaphore.h>

Inheritance diagram for stk::sync::SemaphoreT< T >:
Collaboration diagram for stk::sync::SemaphoreT< T >:

Classes

struct  ReadTag
 Selects how the counter is read: WIDE is true if T is wider than a pointer. More...

Public Types

typedef T CounterValueType
 Counter value type.
typedef DLHeadType ListHeadType
 List head type for ISyncObject elements.
typedef DLEntryType ListEntryType
 List entry type of ISyncObject elements.
enum  
 A tag for type-safe casts done by CastListEntryToParent. More...
typedef DListEntry< ISyncObject, TClosedLoop > DLEntryType
 Convenience alias for this entry type. Used to avoid repeating the full template spelling.
typedef DListHead< ISyncObject, TClosedLoop > DLHeadType
 Convenience alias for the corresponding list head type.

Public Member Functions

 SemaphoreT (T initial_count=0U, T max_count=COUNT_MAX)
 Constructor.
 ~SemaphoreT ()
 Destructor.
EWaitResult WaitEx (Timeout timeout_ticks=WAIT_INFINITE)
 Wait for a signal (decrement counter), preserving the full wait outcome.
bool Wait (Timeout timeout_ticks=WAIT_INFINITE)
 Wait for a signal (decrement counter).
bool TryWait ()
 Poll the semaphore without blocking (decrement counter if available).
void Signal ()
 Post a signal (increment counter).
bool TrySignal ()
 Try to post a signal without exceeding max_count.
bool TrySignal (const T ceiling)
 Try to post a signal without exceeding a caller-supplied ceiling.
T GetCount () const
 Get current counter value.
void AddWaitObject (IWaitObject *wobj) override
 Called by kernel when a new task starts waiting on this event.
void RemoveWaitObject (IWaitObject *wobj) override
 Called by kernel when a waiting task is being removed (timeout expired, wait aborted, task terminated etc.).
const IWaitObject::ListHeadType & GetWaitList () const override
 Get list of tasks blocked on this object.
virtual bool Tick (Timeout elapsed_ticks)
 Called by kernel on every system tick to handle timeout logic of waiting tasks.
Weight FindWeightHigherThan (Weight comp) const
 Find higher weight within linked wait objects.
TId GetFirstWaiterTid () const
 Get id of the task which is first in the wait list (FIFO order), i.e. the one that WakeOne() would wake next.
DLHeadType * GetHead ()
 Get the list head this entry currently belongs to.
DLEntryType * GetNext ()
 Get the next entry in the list.
DLEntryType * GetPrev ()
 Get the previous entry in the list.
bool IsLinked () const
 Check whether this entry is currently a member of any list.
 operator ISyncObject * ()
 Implicit conversion to a mutable pointer to the host object (T).
 operator const ISyncObject * () const
 Implicit conversion to a const pointer to the host object (T).
void SetTraceName (const char *name)
 Set name.
const char * GetTraceName () const
 Get name.

Static Public Member Functions

static void AddWaitObject (IWaitObject::ListHeadType &wlist, IWaitObject *wobj)
 Called by kernel when a new task starts waiting on this event.
static void RemoveWaitObject (IWaitObject::ListHeadType &wlist, IWaitObject *wobj)
 Called by kernel when a waiting task is being removed (timeout expired, wait aborted, task terminated etc.).
static void WakeOne (IWaitObject::ListHeadType &wlist)
 Wake the first task in the wait list (FIFO order).
static void WakeAll (IWaitObject::ListHeadType &wlist)
 Wake all tasks currently in the wait list.

Static Public Attributes

static constexpr T COUNT_MAX = static_cast<T>(~static_cast<T>(0U))
 Max count value supported (maximum value of T).

Protected Member Functions

void WakeOne () override
 Wake the first task in the wait list (FIFO order).
void WakeAll () override
 Wake all tasks currently in the wait list.
IWaitObject::ListHeadType & GetMutableWaitList () override
 Get list of tasks blocked on this object.

Protected Attributes

IWaitObject::ListHeadType m_wait_list
 Tasks blocked on this object.

Private Member Functions

 SemaphoreT (const SemaphoreT &)=delete
SemaphoreT & operator= (const SemaphoreT &)=delete
T ReadCount (ReadTag< false >) const
 Counter fits the native word: a single load is atomic.
T ReadCount (ReadTag< true >) const
 Counter is wider than the native word: a plain load may be split into several, guard it.
bool TrySignalLimited (const T limit)
 Common signal path: hand off to a waiter or increment up to limit.
void Link (DLHeadType *head, DLEntryType *next, DLEntryType *prev)
 Wire this entry into a list between prev and next.
void Unlink ()
 Remove this entry from its current list.

Private Attributes

T m_count
 Internal resource counter.
T m_count_max
 Counter max limit.
DLHeadType * m_head
 Owning list head, or NULL when the entry is not linked.
DLEntryType * m_next
 Next entry in the list, or NULL (open list boundary) / first entry (closed loop).
DLEntryType * m_prev
 Previous entry in the list, or NULL (open list boundary) / last entry (closed loop).

Detailed Description

template<typename T>
class stk::sync::SemaphoreT< T >

Counting semaphore primitive for resource management and signaling, with a selectable counter type.

Counting semaphore maintains an internal counter to manage access to a limited number of resources. Unlike a Condition Variable, a Semaphore is stateful: if Signal() is called when no tasks are waiting, the signal is "remembered" by incrementing the internal counter.

Template Parameters
TUnsigned integer type used for the counter and its limit (e.g. uint8_t, uint16_t, uint32_t, uint64_t). Signed types are rejected at compile time. Note that uint8_t does not necessarily reduce the object size because of alignment padding, verify with sizeof() on your target before relying on it. A type wider than a pointer (e.g. uint64_t on a 32-bit MCU) is supported: all counter updates are done under the critical section, and GetCount() takes it as well so that the value can not be read torn.
Note
This implementation uses a Direct Handover policy: when a task is waiting, Signal() gives the resource "token" directly to the first task in the wait list without incrementing the counter. The waking task is then guaranteed ownership of that token upon returning from Wait().
// Example: Resource throttling
// Initialize with 3 permits (e.g., max 3 concurrent tasks accessing the same resource)
stk::sync::Semaphore g_Limiter(3);
void Worker() {
// attempt to acquire a permit with a 1000 tick timeout
if (g_Limiter.Wait(1000)) {
// ... access limited resource ...
// release the permit back to the semaphore
g_Limiter.Signal();
}
}
// Example: wide counter (e.g. counting bytes or credits)
// Example: 64-bit counter (e.g. a port where a native unsigned type is 64-bit wide)
SemaphoreT< uint16_t > Semaphore
Default counting semaphore with a 16-bit counter (max count 0xFFFF).
Counting semaphore primitive for resource management and signaling, with a selectable counter type.
See also
Semaphore, ISyncObject, IWaitObject, IKernelService::Wait
Note
Only available when kernel is compiled with KERNEL_SYNC mode enabled.

Definition at line 71 of file stk_sync_semaphore.h.

Member Typedef Documentation

◆ CounterValueType

template<typename T>
typedef T stk::sync::SemaphoreT< T >::CounterValueType

Counter value type.

Definition at line 78 of file stk_sync_semaphore.h.

◆ DLEntryType

typedef DListEntry<ISyncObject, TClosedLoop> stk::detail::DListEntry< ISyncObject, TClosedLoop >::DLEntryType
inherited

Convenience alias for this entry type. Used to avoid repeating the full template spelling.

Definition at line 75 of file stk_linked_list.h.

◆ DLHeadType

typedef DListHead<ISyncObject, TClosedLoop> stk::detail::DListEntry< ISyncObject, TClosedLoop >::DLHeadType
inherited

Convenience alias for the corresponding list head type.

Definition at line 80 of file stk_linked_list.h.

◆ ListEntryType

List entry type of ISyncObject elements.

Definition at line 672 of file stk_common.h.

◆ ListHeadType

List head type for ISyncObject elements.

Definition at line 667 of file stk_common.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

A tag for type-safe casts done by CastListEntryToParent.

See also
CastListEntryToParent.

Definition at line 70 of file stk_linked_list.h.

70{ DLEntryTag = 1 };
Intrusive doubly-linked list node. Embed this as a base class in any object (T) that needs to partici...

Constructor & Destructor Documentation

◆ SemaphoreT() [1/2]

template<typename T>
stk::sync::SemaphoreT< T >::SemaphoreT ( T initial_count = 0U,
T max_count = COUNT_MAX )
inlineexplicit

Constructor.

Initializes the semaphore with a specific count and maximum limit. Setting initial_count to a non-zero value allows for immediate resource acquisition.

Parameters
[in]initial_countStarting value of the internal counter (available permits).
[in]max_countMaximum value the counter is allowed to reach.
Precondition
initial_count <= max_count.
Note
Triggers an assertion in a debug build if initial_count exceeds max_count.

Definition at line 93 of file stk_sync_semaphore.h.

95 {
96 STK_ASSERT(initial_count <= max_count); // API contract: initial count must not exceed maximum
97 }
#define STK_ASSERT(e)
Runtime assertion. Halts execution if the expression e evaluates to false.
Definition stk_defs.h:532
T m_count_max
Counter max limit.
T m_count
Internal resource counter.

◆ ~SemaphoreT()

template<typename T>
stk::sync::SemaphoreT< T >::~SemaphoreT ( )
inline

Destructor.

Note
If tasks are still waiting at destruction time it is considered a logical error (dangling waiters). An assertion is triggered in debug builds.
MISRA deviation: [STK-DEV-005] Rule 10-3-2.

Definition at line 105 of file stk_sync_semaphore.h.

106 {
107 STK_ASSERT(m_wait_list.IsEmpty()); // API contract: must not be destroyed with waiting tasks
108 }
IWaitObject::ListHeadType m_wait_list
Tasks blocked on this object.
Definition stk_helper.h:311

◆ SemaphoreT() [2/2]

template<typename T>
stk::sync::SemaphoreT< T >::SemaphoreT ( const SemaphoreT< T > & )
privatedelete

Member Function Documentation

◆ AddWaitObject() [1/2]

void stk::ISyncObject::AddWaitObject ( IWaitObject::ListHeadType & wlist,
IWaitObject * wobj )
inlinestaticinherited

Called by kernel when a new task starts waiting on this event.

Parameters
[in]wlistWait list.
[in]wobjWait object representing blocked task.
Note
Utility for AddWaitObject and ARM TrustZone support.

Definition at line 679 of file stk_common.h.

680 {
681 STK_ASSERT(wobj->GetHead() == nullptr);
682 wlist.LinkBack(wobj);
683 }

References stk::detail::DListEntry< T, TClosedLoop >::GetHead(), stk::detail::DListHead< T, TClosedLoop >::LinkBack(), and STK_ASSERT.

Referenced by stk::SyncObjectBase::AddWaitObject(), and stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::WaitObject::SetupWait().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddWaitObject() [2/2]

void stk::SyncObjectBase::AddWaitObject ( IWaitObject * wobj)
inlineoverridevirtualinherited

Called by kernel when a new task starts waiting on this event.

Parameters
[in]wobjWait object representing blocked task.
Note
Must be called inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection).

Implements stk::ISyncObject.

Definition at line 255 of file stk_helper.h.

256 {
258 }
static void AddWaitObject(IWaitObject::ListHeadType &wlist, IWaitObject *wobj)
Called by kernel when a new task starts waiting on this event.
Definition stk_common.h:679

References stk::ISyncObject::AddWaitObject(), and m_wait_list.

Here is the call graph for this function:

◆ FindWeightHigherThan()

Weight stk::ISyncObject::FindWeightHigherThan ( Weight comp) const
inlineinherited

Find higher weight within linked wait objects.

Implementation of ISyncObject::FindWeightHigherThan, see ISyncObject. Placed here as it depends on GetUserTaskFromTid.

Parameters
[in]compWeight to compare with.
Returns
Higher weight value than comp, or NO_WEIGHT if there is no object with a higher weight.
Note
Must be called inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection).

Definition at line 349 of file stk_helper.h.

350{
351 Weight max_weight = NO_WEIGHT;
352 const IWaitObject *itr = detail::DListCast::ListEntryToParent<const IWaitObject>(GetWaitList().GetFirst());
353
354 while (itr != nullptr)
355 {
356 const Weight w = GetUserTaskFromTid(itr->GetTid())->GetWeight();
357 if (w > max_weight)
358 {
359 max_weight = w;
360 }
361
363 }
364
365 return ((max_weight > comp) ? max_weight : NO_WEIGHT);
366}
ITask * GetUserTaskFromTid(TId task_id) noexcept
Get task instance from its identifier.
Definition stk_arch.h:784
static constexpr Weight NO_WEIGHT
Weight value: weight is not set.
Definition stk_common.h:285
int32_t Weight
Weight value (aka priority).
Definition stk_common.h:236
virtual const IWaitObject::ListHeadType & GetWaitList() const =0
Get list of tasks blocked on this object.
virtual Weight GetWeight() const
Get static base weight of the task.
Definition stk_common.h:997
static __stk_forceinline TTargetType * ListEntryToParent(TSourceType *const lentry)
Casts an intrusive list entry to the concrete type that derives from it.

References stk::detail::DListEntry< T, TClosedLoop >::GetNext(), stk::IWaitObject::GetTid(), stk::GetUserTaskFromTid(), GetWaitList(), stk::ITask::GetWeight(), stk::detail::DListCast::ListEntryToParent(), and stk::NO_WEIGHT.

Referenced by stk::Kernel< TMode, TSize, TStrategy, TPlatform >::OnRestoreWeight(), stk::sync::FastMutex::Unlock(), and stk::sync::Mutex::Unlock().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetCount()

template<typename T>
T stk::sync::SemaphoreT< T >::GetCount ( ) const
inline

Get current counter value.

Returns
Advisory snapshot of the counter. May be stale by the time the caller acts on it.
Note
ISR-safe. If T is not wider than a pointer the value is read directly (a single aligned load on all supported STK architectures), otherwise (e.g. uint64_t on a 32-bit MCU) it is read under a critical section so it can not be torn by a concurrent update. Not safe for read-modify-write use.

Definition at line 184 of file stk_sync_semaphore.h.

184{ return ReadCount(ReadTag<(sizeof(T) > sizeof(void *))>()); }
T ReadCount(ReadTag< false >) const
Counter fits the native word: a single load is atomic.
Selects how the counter is read: WIDE is true if T is wider than a pointer.

Referenced by sem_getvalue(), stk_sem_get_count(), and xTaskNotifyStateClearIndexed().

Here is the caller graph for this function:

◆ GetFirstWaiterTid()

TId stk::ISyncObject::GetFirstWaiterTid ( ) const
inlineinherited

Get id of the task which is first in the wait list (FIFO order), i.e. the one that WakeOne() would wake next.

Returns
TId of the first waiter, or TID_NONE if no tasks are currently waiting.
Note
Read-only introspection for diagnostics / telemetry.
The result is a snapshot: call inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection) if the list may change concurrently.
See also
GetWaitList

Definition at line 777 of file stk_common.h.

778 {
779 const IWaitObject *const obj = detail::DListCast::ListEntryToParent<const IWaitObject>(
780 GetWaitList().GetFirst());
781
782 return ((obj != nullptr) ? obj->GetTid() : TID_NONE);
783 }
static constexpr TId TID_NONE
Reserved task/thread id representing zero/none thread id.
Definition stk_common.h:268

References stk::IWaitObject::GetTid(), GetWaitList(), stk::detail::DListCast::ListEntryToParent(), and stk::TID_NONE.

Here is the call graph for this function:

◆ GetHead()

DLHeadType * stk::detail::DListEntry< ISyncObject, TClosedLoop >::GetHead ( )
inlineinherited

Get the list head this entry currently belongs to.

Returns
Pointer to the owning DListHead, or NULL if the entry is not linked.

Definition at line 85 of file stk_linked_list.h.

85{ return m_head; }

Referenced by stk::SyncObjectBase::~SyncObjectBase().

Here is the caller graph for this function:

◆ GetMutableWaitList()

IWaitObject::ListHeadType & stk::SyncObjectBase::GetMutableWaitList ( )
inlineoverrideprotectedvirtualinherited

Get list of tasks blocked on this object.

Implements stk::ISyncObject.

Definition at line 306 of file stk_helper.h.

307 {
308 return m_wait_list;
309 }

References m_wait_list.

◆ GetNext()

DLEntryType * stk::detail::DListEntry< ISyncObject, TClosedLoop >::GetNext ( )
inlineinherited

Get the next entry in the list.

Returns
Next entry. In an open list NULL for the last entry; in a closed loop the last entry wraps to the first one, so the result is never NULL for a linked entry.

Definition at line 96 of file stk_linked_list.h.

96{ return m_next; }

◆ GetPrev()

DLEntryType * stk::detail::DListEntry< ISyncObject, TClosedLoop >::GetPrev ( )
inlineinherited

Get the previous entry in the list.

Returns
Previous entry. In an open list NULL for the first entry; in a closed loop the first entry wraps to the last one, so the result is never NULL for a linked entry.

Definition at line 106 of file stk_linked_list.h.

106{ return m_prev; }

◆ GetTraceName()

const char * stk::ITraceable::GetTraceName ( ) const
inlineinherited

Get name.

Returns
Name string, or NULL if not set or if STK_SYNC_DEBUG_NAMES is 0.

Definition at line 629 of file stk_common.h.

630 {
631 #if STK_SYNC_DEBUG_NAMES
632 return m_trace_name;
633 #else
634 return nullptr;
635 #endif
636 }

◆ GetWaitList()

const IWaitObject::ListHeadType & stk::SyncObjectBase::GetWaitList ( ) const
inlineoverridevirtualinherited

Get list of tasks blocked on this object.

Note
Read-only access for diagnostics / telemetry.
The result is a snapshot: call inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection) if the list may change concurrently.

Implements stk::ISyncObject.

Definition at line 265 of file stk_helper.h.

266 {
267 return m_wait_list;
268 }

References m_wait_list.

◆ IsLinked()

bool stk::detail::DListEntry< ISyncObject, TClosedLoop >::IsLinked ( ) const
inlineinherited

Check whether this entry is currently a member of any list.

Returns
true if linked (m_head != NULL); false otherwise.

Definition at line 115 of file stk_linked_list.h.

115{ return (GetHead() != nullptr); }

◆ Link()

void stk::detail::DListEntry< ISyncObject, TClosedLoop >::Link ( DLHeadType * head,
DLEntryType * next,
DLEntryType * prev )
inlineprivateinherited

Wire this entry into a list between prev and next.

Parameters
[in]headThe owning DListHead. Stored as a back-pointer for IsLinked() and ownership checks.
[in]nextThe entry that will follow this one, or NULL if this becomes the last entry.
[in]prevThe entry that will precede this one, or NULL if this becomes the first entry.
Note
Called exclusively by DListHead::Link(). Assumes the entry is not currently linked. Updates the neighbours' forward/back pointers to splice this entry in.

Definition at line 150 of file stk_linked_list.h.

151 {
152 m_head = head;
153 m_next = next;
154 m_prev = prev;
155
156 if (m_prev != nullptr)
157 {
158 m_prev->m_next = this;
159 }
160
161 if (m_next != nullptr)
162 {
163 m_next->m_prev = this;
164 }
165 }
DLEntryType * m_next
Next entry in the list, or NULL (open list boundary) / first entry (closed loop).
DLEntryType * m_prev
Previous entry in the list, or NULL (open list boundary) / last entry (closed loop).

◆ operator const ISyncObject *()

stk::detail::DListEntry< ISyncObject, TClosedLoop >::operator const ISyncObject * ( ) const
inlineinherited

Implicit conversion to a const pointer to the host object (T).

Note
Safe because T must derive from DListEntry<T, TClosedLoop>. Eliminates the need for explicit static_cast at call sites.
MISRA deviation: [STK-DEV-004] Rule 5-2-x.

Definition at line 129 of file stk_linked_list.h.

129{ return static_cast<const T *>(this); }

◆ operator ISyncObject *()

stk::detail::DListEntry< ISyncObject, TClosedLoop >::operator ISyncObject* ( )
inlineinherited

Implicit conversion to a mutable pointer to the host object (T).

Note
Safe because T must derive from DListEntry<T, TClosedLoop>. Eliminates the need for explicit static_cast at call sites.
MISRA deviation: [STK-DEV-004] Rule 5-2-x.

Definition at line 122 of file stk_linked_list.h.

122{ return static_cast<T *>(this); }

◆ operator=()

template<typename T>
SemaphoreT & stk::sync::SemaphoreT< T >::operator= ( const SemaphoreT< T > & )
privatedelete

◆ ReadCount() [1/2]

template<typename T>
T stk::sync::SemaphoreT< T >::ReadCount ( ReadTag< false > ) const
inlineprivate

Counter fits the native word: a single load is atomic.

Definition at line 193 of file stk_sync_semaphore.h.

193{ return m_count; }

Referenced by stk::sync::SemaphoreT< uint16_t >::GetCount().

Here is the caller graph for this function:

◆ ReadCount() [2/2]

template<typename T>
T stk::sync::SemaphoreT< T >::ReadCount ( ReadTag< true > ) const
inlineprivate

Counter is wider than the native word: a plain load may be split into several, guard it.

Definition at line 196 of file stk_sync_semaphore.h.

197 {
199 return m_count;
200 }

◆ RemoveWaitObject() [1/2]

void stk::ISyncObject::RemoveWaitObject ( IWaitObject::ListHeadType & wlist,
IWaitObject * wobj )
inlinestaticinherited

Called by kernel when a waiting task is being removed (timeout expired, wait aborted, task terminated etc.).

Parameters
[in]wlistWait list.
[in]wobjWait object to remove from the wait list.
Note
Utility for RemoveWaitObject and ARM TrustZone support.

Definition at line 696 of file stk_common.h.

697 {
698 STK_ASSERT(wobj->GetHead() == &wlist);
699 wlist.Unlink(wobj);
700 }

References stk::detail::DListEntry< T, TClosedLoop >::GetHead(), STK_ASSERT, and stk::detail::DListHead< T, TClosedLoop >::Unlink().

Referenced by stk::SyncObjectBase::RemoveWaitObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RemoveWaitObject() [2/2]

void stk::SyncObjectBase::RemoveWaitObject ( IWaitObject * wobj)
inlineoverridevirtualinherited

Called by kernel when a waiting task is being removed (timeout expired, wait aborted, task terminated etc.).

Parameters
[in]wobjWait object to remove from the wait list.
Note
Must be called inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection).

Implements stk::ISyncObject.

Definition at line 260 of file stk_helper.h.

261 {
263 }
static void RemoveWaitObject(IWaitObject::ListHeadType &wlist, IWaitObject *wobj)
Called by kernel when a waiting task is being removed (timeout expired, wait aborted,...
Definition stk_common.h:696

References m_wait_list, and stk::ISyncObject::RemoveWaitObject().

Referenced by stk::sync::Event::RemoveWaitObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetTraceName()

void stk::ITraceable::SetTraceName ( const char * name)
inlineinherited

Set name.

Parameters
[in]nameNull-terminated string or NULL.
Note
If STK_SYNC_DEBUG_NAMES is 0 then calling this function has no effect.
Examples
sync/example.cpp.

Definition at line 617 of file stk_common.h.

618 {
619 #if STK_SYNC_DEBUG_NAMES
620 m_trace_name = name;
621 #else
622 STK_UNUSED(name);
623 #endif
624 }
#define STK_UNUSED(X)
Explicitly marks a variable as unused to suppress compiler warnings.
Definition stk_defs.h:715

References STK_UNUSED.

Referenced by stk::memory::BlockMemoryPool::BlockMemoryPool(), stk::memory::BlockMemoryPool::BlockMemoryPool(), stk::memory::BytePool::BytePool(), stk::memory::BytePool::BytePool(), RunExample(), tx_block_pool_create(), tx_mutex_create(), and tx_queue_create().

Here is the caller graph for this function:

◆ Signal()

template<typename T>
void stk::sync::SemaphoreT< T >::Signal ( )
inline

Post a signal (increment counter).

Note
Gives "token" directly to the waking task. The count is not incremented, and the waking task does not decrement it.
ISR-safe.
Warning
API contract: the counter must not already be at max_count with no task waiting. Violating this triggers an assertion in a debug build. Use TrySignal() instead if a signal that would exceed max_count should be tolerated (e.g. a redundant post) rather than treated as a caller error.

Definition at line 267 of file stk_sync_semaphore.h.

268{
269 const bool success = TrySignal();
271 STK_ASSERT(success); // API contract: the count must not exceed maximum
272}
bool TrySignal()
Try to post a signal without exceeding max_count.

References STK_ASSERT, STK_UNUSED, and TrySignal().

Referenced by stk_sem_signal().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Tick()

bool stk::ISyncObject::Tick ( Timeout elapsed_ticks)
inlinevirtualinherited

Called by kernel on every system tick to handle timeout logic of waiting tasks.

Implementation of ISyncObject::Tick, see ISyncObject. Placed here as it depends on hw namespace.

Parameters
[in]elapsed_ticksNumber of ticks elapsed between this and previous calls, in case of KERNEL_TICKLESS mode this value can be >1, for non-tickless mode it is always 1.
Returns
true if this synchronization object still has waiters with a finite timeout and requires further tick calls. false if the wait list is empty or all remaining waiters have infinite timeouts, signaling to the kernel that it may stop calling Tick() for this object until a new waiter is added.
Note
When this method returns false, the kernel unlinks this object from its active sync list. It will be re-linked automatically when the next waiter is added via AddWaitObject().
Does not need to be called inside critical section.

Definition at line 315 of file stk_helper.h.

316{
318
319 // note: ScopedCriticalSection usage
320 //
321 // Single-core: no critical section needed - Tick() runs from the tick ISR,
322 // which cannot be re-entered on the local core.
323 //
324 // Multi-core: critical section is required because the tick handler on
325 // each core may call Tick() concurrently for the same sync object,
326 // and ISyncObject::Tick() is not re-entrant.
327#if (STK_ARCH_CPU_COUNT > 1)
328 const hw::CriticalSection::ScopedLock cs_;
329#endif
330
331 IWaitObject *itr = detail::DListCast::ListEntryToParent<IWaitObject>(wlist.GetFirst());
332
333 while (itr != nullptr)
334 {
335 IWaitObject *const next = detail::DListCast::ListEntryToParent<IWaitObject>(itr->GetNext());
336
337 if (!itr->Tick(elapsed_ticks))
338 {
339 itr->Wake(true);
340 }
341
342 itr = next;
343 }
344
345 return !wlist.IsEmpty();
346}
DLHeadType ListHeadType
List head type for IWaitObject elements.
Definition stk_common.h:548
virtual IWaitObject::ListHeadType & GetMutableWaitList()=0
Get list of tasks blocked on this object.

References stk::detail::DListHead< T, TClosedLoop >::GetFirst(), GetMutableWaitList(), stk::detail::DListEntry< T, TClosedLoop >::GetNext(), stk::detail::DListHead< T, TClosedLoop >::IsEmpty(), stk::detail::DListCast::ListEntryToParent(), stk::IWaitObject::Tick(), and stk::IWaitObject::Wake().

Here is the call graph for this function:

◆ TrySignal() [1/2]

template<typename T>
bool stk::sync::SemaphoreT< T >::TrySignal ( )
inline

Try to post a signal without exceeding max_count.

Identical to Signal(), except that if the counter is already at max_count and no task is waiting, this returns false instead of asserting. The check and the increment (or hand-off to a waiter) happen atomically under the same critical section, so this is safe to call from multiple concurrent signalers without racing each other the way a separate GetCount() check followed by Signal() would.

Note
ISR-safe.
Returns
true if signaled (incremented, or handed directly to a waiter), false if the counter was already at max_count and nobody was waiting.

Definition at line 279 of file stk_sync_semaphore.h.

280{
282}
bool TrySignalLimited(const T limit)
Common signal path: hand off to a waiter or increment up to limit.

References m_count_max, and TrySignalLimited().

Referenced by cy_rtos_thread_set_notification(), cy_rtos_thread_terminate(), sem_post(), Signal(), stk_sem_trysignal(), stk_sem_trysignal_ceiling(), ulTaskNotifyTakeIndexed(), xTaskNotifyAndQueryIndexed(), xTaskNotifyGiveIndexed(), and xTaskNotifyIndexed().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TrySignal() [2/2]

template<typename T>
bool stk::sync::SemaphoreT< T >::TrySignal ( const T ceiling)
inline

Try to post a signal without exceeding a caller-supplied ceiling.

Same as TrySignal(), but the counter is additionally limited by ceiling (the effective limit is the smaller of ceiling and the max_count given at construction). Intended for APIs where the ceiling is a per-call argument (e.g. ThreadX tx_semaphore_ceiling_put). The check and the increment (or hand-off to a waiter) are atomic.

Parameters
[in]ceilingMaximum counter value allowed for this call.
Note
ISR-safe.
Returns
true if signaled (incremented, or handed directly to a waiter), false if the counter was already at or above the effective limit and nobody was waiting.

Definition at line 285 of file stk_sync_semaphore.h.

286{
287 // effective limit is the smaller of the per-call ceiling and the per-object maximum
289}

References m_count_max, and TrySignalLimited().

Here is the call graph for this function:

◆ TrySignalLimited()

template<typename T>
bool stk::sync::SemaphoreT< T >::TrySignalLimited ( const T limit)
inlineprivate

Common signal path: hand off to a waiter or increment up to limit.

Parameters
[in]limitEffective counter limit for this call.
Returns
true if signaled, false if saturated with no waiter.

Definition at line 292 of file stk_sync_semaphore.h.

293{
294 bool success = true;
295
296 // guard
298
299 if (m_wait_list.IsEmpty())
300 {
301 if (m_count >= limit)
302 {
303 // counter already saturated and no one is waiting to hand the token to directly
304 success = false;
305 }
306 else
307 {
308 // no one is waiting, save signal for later
309 m_count = static_cast<T>(m_count + 1U);
310 }
311 }
312 else
313 {
314 // give signal directly to the first waiting task
315 WakeOne();
316 }
317
318 return success;
319}
void WakeOne() override
Wake the first task in the wait list (FIFO order).
Definition stk_helper.h:296

References m_count, stk::SyncObjectBase::m_wait_list, and stk::SyncObjectBase::WakeOne().

Referenced by TrySignal(), and TrySignal().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TryWait()

template<typename T>
bool stk::sync::SemaphoreT< T >::TryWait ( )
inline

Poll the semaphore without blocking (decrement counter if available).

Checks if a resource token is available. If so, decrements the counter and returns immediately without yielding the CPU or touching the kernel wait list. If the counter is zero, returns immediately with false.

Note
ISR-safe.
Returns
true if a resource token was acquired, false if count was zero.

Definition at line 136 of file stk_sync_semaphore.h.

136{ return Wait(NO_WAIT); }
bool Wait(Timeout timeout_ticks=WAIT_INFINITE)
Wait for a signal (decrement counter).

Referenced by stk_sem_trywait(), and xTaskNotifyStateClearIndexed().

Here is the caller graph for this function:

◆ Unlink()

void stk::detail::DListEntry< ISyncObject, TClosedLoop >::Unlink ( )
inlineprivateinherited

Remove this entry from its current list.

Note
Called exclusively by DListHead::Unlink(). Patches the neighbours' pointers to bridge over this entry, then clears m_head, m_next, and m_prev to NULL so the entry is in a clean unlinked state.
Does not update DListHead::m_count or m_first / m_last — those are the responsibility of the calling DListHead::Unlink().

Definition at line 174 of file stk_linked_list.h.

175 {
176 if (m_prev != nullptr)
177 {
179 }
180
181 if (m_next != nullptr)
182 {
184 }
185
186 m_head = nullptr;
187 m_next = nullptr;
188 m_prev = nullptr;
189 }

◆ Wait()

template<typename T>
bool stk::sync::SemaphoreT< T >::Wait ( Timeout timeout_ticks = WAIT_INFINITE)
inline

Wait for a signal (decrement counter).

Parameters
[in]timeout_ticksMaximum time to wait (ticks).
Warning
ISR-safe only with timeout_ticks = NO_WAIT, ISR-unsafe otherwise.
Returns
True if acquired, false otherwise (timeout, cancellation or NO_WAIT with no token available). Use WaitEx() to tell these apart.

Definition at line 127 of file stk_sync_semaphore.h.

EWaitResult WaitEx(Timeout timeout_ticks=WAIT_INFINITE)
Wait for a signal (decrement counter), preserving the full wait outcome.

Referenced by stk_sem_wait(), stk::sync::SemaphoreT< uint16_t >::TryWait(), ulTaskNotifyTakeIndexed(), and xTaskNotifyWaitIndexed().

Here is the caller graph for this function:

◆ WaitEx()

template<typename T>
EWaitResult stk::sync::SemaphoreT< T >::WaitEx ( Timeout timeout_ticks = WAIT_INFINITE)
inline

Wait for a signal (decrement counter), preserving the full wait outcome.

Parameters
[in]timeout_ticksMaximum time to wait (ticks).
Warning
ISR-safe only with timeout_ticks = NO_WAIT, ISR-unsafe otherwise.
Returns
WAIT_RESULT_SIGNAL if a token was acquired, WAIT_RESULT_TIMEOUT if no token was available and the timeout expired (or NO_WAIT was passed), WAIT_RESULT_CANCELED if the wait was cancelled via IKernel::CancelTaskWait(), WAIT_RESULT_FAIL if the kernel rejected the wait. A non-signal result never consumes a token.

Definition at line 230 of file stk_sync_semaphore.h.

231{
232 // guard
234
235 // NO_WAIT with no token available is reported as an immediately-expired timeout
237
238 // fast path: resource is available
239 if (m_count != 0U)
240 {
241 m_count = static_cast<T>(m_count - 1U);
243 }
244 // slow path: block until Signal() or timeout
245 else if (timeout_ticks != NO_WAIT)
246 {
247 STK_ASSERT(!hw::IsInsideISR()); // API contract: caller must not be in ISR if timeout_ticks!=NO_WAIT
248
249 // note: after waking, if not a timeout, we effectively own the resource that Signal() produced
250 // but didn't put into m_count (see logic of if (m_wait_list.IsEmpty()) in TrySignalLimited())
252 }
253 // try lock behavior (timeout_ticks=NO_WAIT)
254 else
255 {
256 // result is WAIT_RESULT_TIMEOUT already, noop
257 }
258
259 return result;
260}
static IKernelService * GetInstance()
Get CPU-local instance of the kernel service.
virtual EWaitResult Wait(ISyncObject *sobj, IMutex *mutex, Timeout timeout)=0
Put calling process into a waiting state until synchronization object is signaled or timeout occurs.

References stk::IKernelService::GetInstance(), stk::hw::IsInsideISR(), m_count, stk::NO_WAIT, STK_ASSERT, stk::IKernelService::Wait(), stk::WAIT_RESULT_SIGNAL, and stk::WAIT_RESULT_TIMEOUT.

Referenced by cy_rtos_thread_join(), cy_rtos_thread_wait_notification(), osSemaphoreAcquire(), stk_sem_wait_ex(), and stk::sync::SemaphoreT< uint16_t >::Wait().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WakeAll() [1/2]

void stk::ISyncObject::WakeAll ( IWaitObject::ListHeadType & wlist)
inlinestaticinherited

Wake all tasks currently in the wait list.

Parameters
[in]wlistWait list.
Note
Each woken task is notified with timeout=false, indicating a successful signal (not a timeout expiry).
Does nothing if no tasks are currently waiting.
Utility for WakeAll and ARM TrustZone support.

Definition at line 752 of file stk_common.h.

753 {
754 for (IWaitObject *obj = detail::DListCast::ListEntryToParent<IWaitObject>(wlist.GetFirst());
755 obj != nullptr;
757 {
758 obj->Wake(false);
759 }
760 }

References stk::detail::DListHead< T, TClosedLoop >::GetFirst(), and stk::detail::DListCast::ListEntryToParent().

Here is the call graph for this function:

◆ WakeAll() [2/2]

void stk::SyncObjectBase::WakeAll ( )
inlineoverrideprotectedvirtualinherited

Wake all tasks currently in the wait list.

Note
Each woken task is notified with timeout=false, indicating a successful signal (not a timeout expiry).
Does nothing if no tasks are currently waiting.
Must be called inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection).

Implements stk::ISyncObject.

Definition at line 301 of file stk_helper.h.

302 {
303 IKernelService::GetInstance()->Wake(this, true);
304 }
virtual void Wake(ISyncObject *sobj, bool all)=0
Wake one or all tasks currently waiting on a synchronization object.

References stk::IKernelService::GetInstance(), and stk::IKernelService::Wake().

Referenced by stk::sync::ConditionVariable::NotifyAll_CS(), stk::sync::Event::Pulse(), and stk::sync::Event::Set().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WakeOne() [1/2]

void stk::ISyncObject::WakeOne ( IWaitObject::ListHeadType & wlist)
inlinestaticinherited

Wake the first task in the wait list (FIFO order).

Parameters
[in]wlistWait list.
Note
The woken task is notified with timeout=false, indicating a successful signal (not a timeout expiry).
Does nothing if no tasks are currently waiting.
Utility for WakeOne and ARM TrustZone support.

Definition at line 736 of file stk_common.h.

737 {
738 IWaitObject *const obj = detail::DListCast::ListEntryToParent<IWaitObject>(wlist.GetFirst());
739 if (obj != nullptr)
740 {
741 obj->Wake(false);
742 }
743 }

References stk::detail::DListHead< T, TClosedLoop >::GetFirst(), stk::detail::DListCast::ListEntryToParent(), and stk::IWaitObject::Wake().

Here is the call graph for this function:

◆ WakeOne() [2/2]

void stk::SyncObjectBase::WakeOne ( )
inlineoverrideprotectedvirtualinherited

Wake the first task in the wait list (FIFO order).

Note
The woken task is notified with timeout=false, indicating a successful signal (not a timeout expiry).
Does nothing if no tasks are currently waiting.
Must be called inside the critical section (see hw::CriticalSection, sync::ScopedCrticalSection).

Implements stk::ISyncObject.

Definition at line 296 of file stk_helper.h.

297 {
298 IKernelService::GetInstance()->Wake(this, false);
299 }

References stk::IKernelService::GetInstance(), and stk::IKernelService::Wake().

Referenced by stk::sync::ConditionVariable::NotifyOne_CS(), stk::sync::Event::Pulse(), stk::sync::Event::Set(), and stk::sync::SemaphoreT< T >::TrySignalLimited().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ COUNT_MAX

template<typename T>
T stk::sync::SemaphoreT< T >::COUNT_MAX = static_cast<T>(~static_cast<T>(0U))
staticconstexpr

Max count value supported (maximum value of T).

Definition at line 82 of file stk_sync_semaphore.h.

Referenced by stk_sem_create().

◆ m_count

template<typename T>
T stk::sync::SemaphoreT< T >::m_count
private

Internal resource counter.

Definition at line 208 of file stk_sync_semaphore.h.

Referenced by TrySignalLimited(), and WaitEx().

◆ m_count_max

template<typename T>
T stk::sync::SemaphoreT< T >::m_count_max
private

Counter max limit.

Definition at line 209 of file stk_sync_semaphore.h.

Referenced by TrySignal(), and TrySignal().

◆ m_head

DLHeadType* stk::detail::DListEntry< ISyncObject, TClosedLoop >::m_head
privateinherited

Owning list head, or NULL when the entry is not linked.

Definition at line 191 of file stk_linked_list.h.

◆ m_next

DLEntryType* stk::detail::DListEntry< ISyncObject, TClosedLoop >::m_next
privateinherited

Next entry in the list, or NULL (open list boundary) / first entry (closed loop).

Definition at line 192 of file stk_linked_list.h.

◆ m_prev

DLEntryType* stk::detail::DListEntry< ISyncObject, TClosedLoop >::m_prev
privateinherited

Previous entry in the list, or NULL (open list boundary) / last entry (closed loop).

Definition at line 193 of file stk_linked_list.h.

◆ m_wait_list


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