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::Event Class Referencefinal

Binary synchronization event (signaled / non-signaled) primitive. More...

#include <stk_sync_event.h>

Inheritance diagram for stk::sync::Event:
Collaboration diagram for stk::sync::Event:

Public Types

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

 Event (bool manual_reset=false, bool initial_state=false)
 Constructor.
 ~Event ()
 Destructor.
bool Set ()
 Set event to signaled state.
bool Reset ()
 Reset event to non-signaled state.
EWaitResult WaitEx (Timeout timeout_ticks=WAIT_INFINITE)
 Wait until event becomes signaled or the timeout expires, preserving the full wait outcome.
bool Wait (Timeout timeout_ticks=WAIT_INFINITE)
 Wait until event becomes signaled or the timeout expires.
bool TryWait ()
 Poll event state without blocking.
void Pulse ()
 Pulse event: attempt to release waiters and then reset (Win32 PulseEvent() semantics).
void AddWaitObject (IWaitObject *wobj) override
 Called by kernel when a new task starts waiting on this event.
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.

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

 Event (const Event &)=delete
Event & operator= (const Event &)=delete
void RemoveWaitObject (IWaitObject *wobj) override
 Called by kernel when a waiting task is being removed (timeout expired, wait aborted, task terminated etc.).
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

bool m_manual_reset
 true = manual-reset event, false = auto-reset
bool m_signaled
 current signaled state of the event
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

Binary synchronization event (signaled / non-signaled) primitive.

Supports two operation modes:

  • Auto-reset (default): Set() wakes one waiting task and automatically resets.
  • Manual-reset: Set() wakes all waiting tasks; state remains signaled until Reset().

Additionally, supports Pulse(): attempt to release waiters and then reset (Win32 PulseEvent() semantics).

Note
Follows Win32 PulseEvent() behavior:
  • For auto-reset events: releases one waiting thread (if any) and resets to non-signaled.
  • For manual-reset events: releases all waiting threads (if any) and resets to non-signaled.
  • If no threads are waiting, resets to non-signaled.
Warning
Pulse semantics are inherently racy and considered unreliable in many Win32 usage scenarios. Prefer explicit Set() + Reset() patterns when possible.
// Example: Task synchronization using Event
stk::sync::Event g_DataReadyEvt;
void Task_Producer() {
// ... produce data ...
// notify Task_Consumer that data is ready
g_DataReadyEvt.Set();
}
void Task_Consumer() {
// wait for a data-ready notification signal from Task_Producer with 1s timeout
if (g_DataReadyEvt.Wait(1000)) {
// ... process data ...
}
}
Binary synchronization event (signaled / non-signaled) primitive.
bool Set()
Set event to signaled state.
bool Wait(Timeout timeout_ticks=WAIT_INFINITE)
Wait until event becomes signaled or the timeout expires.
See also
ISyncObject, IWaitObject, IKernelService::Wait
Note
Only available when kernel is compiled with KERNEL_SYNC mode enabled.
Examples
blinky_mc/example.cpp, secure_task/example.cpp, and sync/example.cpp.

Definition at line 61 of file stk_sync_event.h.

Member Typedef Documentation

◆ 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

◆ Event() [1/2]

stk::sync::Event::Event ( bool manual_reset = false,
bool initial_state = false )
inlineexplicit

Constructor.

Parameters
[in]manual_resetIf true creates a manual-reset event (stays signaled until explicitly reset). If false (default) creates an auto-reset event.
[in]initial_stateInitial state of the event: true = signaled, false = non-signaled.

Definition at line 69 of file stk_sync_event.h.

70 : m_manual_reset(manual_reset), m_signaled(initial_state)
71 {}
bool m_signaled
current signaled state of the event
bool m_manual_reset
true = manual-reset event, false = auto-reset

References m_manual_reset, and m_signaled.

Referenced by Event().

Here is the caller graph for this function:

◆ ~Event()

stk::sync::Event::~Event ( )
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 78 of file stk_sync_event.h.

79 {
80 STK_ASSERT(m_wait_list.IsEmpty()); // API contract: must not be destroyed with waiting tasks
81 }
#define STK_ASSERT(e)
Runtime assertion. Halts execution if the expression e evaluates to false.
Definition stk_defs.h:532
IWaitObject::ListHeadType m_wait_list
Tasks blocked on this object.
Definition stk_helper.h:311

References stk::SyncObjectBase::m_wait_list, STK_ASSERT, and STK_VIRT_DTOR.

Referenced by stk::pthread::ReleaseThreadResources().

Here is the caller graph for this function:

◆ Event() [2/2]

stk::sync::Event::Event ( const Event & )
privatedelete

References Event().

Here is the call graph for this function:

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:

◆ 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=()

Event & stk::sync::Event::operator= ( const Event & )
privatedelete

◆ Pulse()

void stk::sync::Event::Pulse ( )
inline

Pulse event: attempt to release waiters and then reset (Win32 PulseEvent() semantics).

Note
Follows Win32 PulseEvent() behavior:
  • For auto-reset events: releases one waiting thread (if any) and resets to non-signaled.
  • For manual-reset events: releases all waiting threads (if any) and resets to non-signaled.
  • If no threads are waiting, resets to non-signaled.
ISR-safe.
Warning
Pulse semantics are inherently racy and considered unreliable in many Win32 usage scenarios. Prefer explicit Set() + Reset() patterns when possible.

Definition at line 205 of file stk_sync_event.h.

206{
207 const ScopedCriticalSection cs_;
208
209 // transition to signaled so that WakeOne/WakeAll can release waiters:
210 // m_signaled is only visible as true while this critical section is held —
211 // any woken task will have the event auto-reset in RemoveWaitObject before
212 // it can observe m_signaled via Wait() or TryWait()
213 m_signaled = true;
214 __stk_full_memfence();
215
216 if (!m_wait_list.IsEmpty())
217 {
218 if (m_manual_reset)
219 {
220 WakeAll();
221 }
222 else
223 {
224 WakeOne(); // auto-reset applied in RemoveWaitObject
225 }
226 }
227
228 // force return to non-signaled regardless of whether anyone was waiting
229 m_signaled = false;
230 __stk_full_memfence();
231}
void WakeAll() override
Wake all tasks currently in the wait list.
Definition stk_helper.h:301
void WakeOne() override
Wake the first task in the wait list (FIFO order).
Definition stk_helper.h:296

References m_manual_reset, m_signaled, stk::SyncObjectBase::m_wait_list, stk::SyncObjectBase::WakeAll(), and stk::SyncObjectBase::WakeOne().

Referenced by stk_event_pulse().

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

◆ 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::sync::Event::RemoveWaitObject ( IWaitObject * wobj)
inlineoverrideprivatevirtual

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 298 of file stk_sync_event.h.

299{
301
302 // kernel invariant: auto-reset is applied here, not at the Set()/Pulse() call site,
303 // when a task wakes due to a signal (not a timeout), the event transitions back to
304 // non-signaled so that subsequent Wait() calls block until the next Set()
306 {
307 if (wobj->GetState() == IWaitObject::STATE_SIGNALED)
308 {
309 m_signaled = false;
310 __stk_full_memfence();
311 }
312 }
313}
@ STATE_SIGNALED
Wake signaled.
Definition stk_common.h:562
void RemoveWaitObject(IWaitObject *wobj) override
Called by kernel when a waiting task is being removed (timeout expired, wait aborted,...
Definition stk_helper.h:260

References stk::IWaitObject::GetState(), m_manual_reset, m_signaled, stk::SyncObjectBase::RemoveWaitObject(), and stk::IWaitObject::STATE_SIGNALED.

Here is the call graph for this function:

◆ Reset()

bool stk::sync::Event::Reset ( )
inline

Reset event to non-signaled state.

Returns
true if state was changed from signaled to non-signaled, false if event was already non-signaled.
Note
Has no practical effect on auto-reset events that are already non-signaled. Mainly used with manual-reset events.
ISR-safe.
Examples
blinky_mc/example.cpp, and secure_task/example.cpp.

Definition at line 189 of file stk_sync_event.h.

190{
191 const ScopedCriticalSection cs_;
192
193 const bool prev = m_signaled;
194
195 m_signaled = false;
196 __stk_full_memfence();
197
198 return prev;
199}

References m_signaled.

Referenced by stk_event_reset().

Here is the caller graph for this function:

◆ Set()

bool stk::sync::Event::Set ( )
inline

Set event to signaled state.

Returns
true if state was changed from non-signaled to signaled, false if event was already signaled.
Note
- In auto-reset mode: wakes one waiting task (if any) and immediately resets.
  • In manual-reset mode: wakes all waiting tasks (if any); state remains set.
  • If already signaled, does nothing and returns false.
Warning
The return value indicates whether the event state changed, not whether any waiting task was woken. A return of false means the event was already signaled, not that no task woke.
Note
ISR-safe.
Examples
secure_task/example.cpp, and sync/example.cpp.

Definition at line 158 of file stk_sync_event.h.

159{
160 const ScopedCriticalSection cs_;
161 bool status = true;
162
163 if (m_signaled)
164 {
165 status = false;
166 }
167 else
168 {
169 m_signaled = true;
170 __stk_full_memfence();
171
172 if (m_manual_reset)
173 {
174 WakeAll();
175 }
176 else
177 {
178 WakeOne(); // auto-reset is applied in RemoveWaitObject when the waiter is removed
179 }
180 }
181
182 return status;
183}

References m_manual_reset, m_signaled, stk::SyncObjectBase::WakeAll(), and stk::SyncObjectBase::WakeOne().

Referenced by stk::time::TimerHost::ProcessCommands(), CtrlTask< _AccessMode >::Run(), LedTask< _Priority, _AccessMode >::Run(), and stk_event_set().

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:

◆ 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:

◆ TryWait()

bool stk::sync::Event::TryWait ( )
inline

Poll event state without blocking.

Checks if the event is currently signaled. If signaled, performs the auto-reset (if auto-reset mode is active) and returns immediately without yielding the CPU or entering a wait list.

Note
ISR-safe.
Returns
true if event was signaled at the time of the call, false if event was not signaled.

Definition at line 275 of file stk_sync_event.h.

276{
277 const ScopedCriticalSection cs_;
278 bool result = false;
279
280 if (m_signaled)
281 {
282 if (!m_manual_reset)
283 {
284 m_signaled = false;
285 __stk_full_memfence();
286 }
287
288 result = true;
289 }
290
291 return result;
292}

References m_manual_reset, and m_signaled.

Referenced by stk_event_trywait().

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()

bool stk::sync::Event::Wait ( Timeout timeout_ticks = WAIT_INFINITE)
inline

Wait until event becomes signaled or the timeout expires.

Parameters
[in]timeout_ticksMaximum time to wait (ticks). Use WAIT_INFINITE for no timeout (wait forever).
Warning
ISR-safe only with timeout_ticks = NO_WAIT, ISR-unsafe otherwise.
Returns
true if event was signaled (wait succeeded), false otherwise (timeout, cancellation or NO_WAIT on a non-signaled event). Use WaitEx() to tell these apart.
Examples
blinky_mc/example.cpp, secure_task/example.cpp, and sync/example.cpp.

Definition at line 122 of file stk_sync_event.h.

122{ return (WaitEx(timeout_ticks) == WAIT_RESULT_SIGNAL); }
@ WAIT_RESULT_SIGNAL
The wake was caused by a signal.
Definition stk_common.h:140
EWaitResult WaitEx(Timeout timeout_ticks=WAIT_INFINITE)
Wait until event becomes signaled or the timeout expires, preserving the full wait outcome.

References stk::WAIT_INFINITE, stk::WAIT_RESULT_SIGNAL, and WaitEx().

Referenced by CtrlTask< _AccessMode >::Run(), LedTask< _Priority, _AccessMode >::Run(), and stk_event_wait().

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

◆ WaitEx()

EWaitResult stk::sync::Event::WaitEx ( Timeout timeout_ticks = WAIT_INFINITE)
inline

Wait until event becomes signaled or the timeout expires, preserving the full wait outcome.

Parameters
[in]timeout_ticksMaximum time to wait (ticks). Use WAIT_INFINITE for no timeout (wait forever).
Warning
ISR-safe only with timeout_ticks = NO_WAIT, ISR-unsafe otherwise.
Returns
WAIT_RESULT_SIGNAL if the event was signaled, WAIT_RESULT_TIMEOUT if the event was not signaled and the timeout expired (or NO_WAIT was passed), WAIT_RESULT_CANCELED if the wait was cancelled via IKernel::CancelTaskWait() (the event state is not consumed), WAIT_RESULT_FAIL if the kernel rejected the wait.

Definition at line 237 of file stk_sync_event.h.

238{
239 ScopedCriticalSection cs_;
240
241 // NO_WAIT on a non-signaled event is reported as an immediately-expired timeout
243
244 // fast path: already signaled
245 if (m_signaled)
246 {
247 if (!m_manual_reset)
248 {
249 m_signaled = false;
250 __stk_full_memfence();
251 }
252
253 result = WAIT_RESULT_SIGNAL;
254 }
255 // slow path: block until Set() signals the event or timeout expires
256 else if (timeout_ticks != NO_WAIT)
257 {
258 STK_ASSERT(!hw::IsInsideISR()); // API contract: caller must not be in ISR if timeout_ticks!=NO_WAIT
259
260 result = IKernelService::GetInstance()->Wait(this, &cs_, timeout_ticks);
261 }
262 else
263 {
264 // non-blocking poll: event not signaled, return immediately
265 // result is WAIT_RESULT_TIMEOUT already, so noop
266 }
267
268 return result;
269}
static constexpr Timeout NO_WAIT
Timeout value: return immediately if the synchronization object is not yet signaled (non-blocking pol...
Definition stk_common.h:280
EWaitResult
Wait result (see IKernelService::Wait).
Definition stk_common.h:138
@ WAIT_RESULT_TIMEOUT
The wake was caused by a timeout expiry.
Definition stk_common.h:141
bool IsInsideISR()
Check whether the CPU is currently executing inside a hardware interrupt service routine (ISR).
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_manual_reset, m_signaled, stk::NO_WAIT, STK_ASSERT, stk::IKernelService::Wait(), stk::WAIT_RESULT_SIGNAL, and stk::WAIT_RESULT_TIMEOUT.

Referenced by stk::time::TimerHost::Execute(), JoinThread(), stk_event_wait_ex(), and 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

◆ 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_manual_reset

bool stk::sync::Event::m_manual_reset
private

true = manual-reset event, false = auto-reset

Definition at line 150 of file stk_sync_event.h.

Referenced by Event(), Pulse(), RemoveWaitObject(), Set(), TryWait(), and WaitEx().

◆ 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_signaled

bool stk::sync::Event::m_signaled
private

current signaled state of the event

Definition at line 151 of file stk_sync_event.h.

Referenced by Event(), Pulse(), RemoveWaitObject(), Reset(), Set(), TryWait(), and WaitEx().

◆ m_wait_list


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