79template <u
int8_t TMode, u
int32_t TSize,
class TStrategy,
class TPlatform>
81#ifndef _STK_UNDER_TEST
225 return m_user->GetWeight();
260 return m_hrt[0].periodicity;
279 return m_hrt[0].deadline;
299 return (
m_hrt[0].deadline -
m_hrt[0].duration);
323 sleep_ticks =
Min(sleep_ticks, task_sleep);
328 sleep_ticks =
Min(sleep_ticks, task_sleep);
333 sleep_ticks =
Min(sleep_ticks, task_sleep);
442 void Wake(
bool timeout)
override
588 return (SP >= start) && (SP <= end);
605 m_hrt[0].periodicity = periodicity_tc;
606 m_hrt[0].deadline = deadline_tc;
608 if (start_delay_tc > 0)
635 m_hrt[0].duration = 0;
636 m_hrt[0].done =
false;
650 m_user->OnDeadlineMissed(duration);
659 m_hrt[0].done =
true;
660 __stk_full_memfence();
668 return (duration >
m_hrt[0].deadline);
694 __stk_full_memfence();
750 const Ticks deadline = now + ticks;
753 for (; now < deadline; now =
GetTicks())
781 return m_kernel->m_platform.SleepUntil(timestamp);
795 m_kernel->OnTaskSleepCancel(task_id);
803 m_kernel->m_platform.SwitchToNext();
810 return m_kernel->m_platform.Wait(sobj, mutex, ticks);
823 return m_kernel->m_platform.Suspend();
836 return m_kernel->m_platform.Resume(elapsed_ticks);
848 m_kernel->OnInheritWeight(tid, weight);
856 m_kernel->OnRestoreWeight(tid, sobj);
920 #if !STK_TICKLESS_IDLE
922 "STK_TICKLESS_IDLE must be defined to 1 for KERNEL_TICKLESS");
952 Stack *exit_trap =
nullptr;
1017 Timeout start_delay_tc)
override
1049 if (task !=
nullptr)
1076 if (task !=
nullptr)
1078 task->ScheduleRemoval();
1111 suspended = !task->IsSleeping();
1112 if (suspended ==
true)
1141 if (task->IsSleeping())
1159 for (
size_t i = 0U; i < limit; ++i)
1164 tasks[count++] = task;
1183 for (
size_t i = 0U; i < limit; ++i)
1188 user_tasks[count++] = task->GetUserTask();
1211 #if STK_SEGGER_SYSVIEW
1212 SEGGER_SYSVIEW_Start();
1218 SendTaskTraceInfo(task);
1303 #if STK_NEED_TASK_ID
1317 #if STK_NEED_TASK_ID
1332 KernelTask *new_task =
nullptr;
1345 if (new_task ==
nullptr)
1348 #if defined(NDEBUG) && !defined(_STK_ASSERT_REDIRECT)
1371 #if STK_SEGGER_SYSVIEW
1373 SEGGER_SYSVIEW_OnTaskCreate(task->GetUserStackPtr()->tid);
1375 SendTaskTraceInfo(task);
1404 task->HrtInit(periodicity_tc, deadline_tc, start_delay_tc);
1418 typename KernelTask::AddTaskRequest req = { .user_task = user_task };
1419 caller->m_srt[0].add_task_req = &req;
1425 if (caller->m_srt[0].add_task_req !=
nullptr)
1430 STK_ASSERT(caller->m_srt[0].add_task_req ==
nullptr);
1439 KernelTask *found_task =
nullptr;
1444 if (task->GetUserTask() == user_task)
1460 KernelTask *found_task =
nullptr;
1465 if (task->GetUserStackPtr() == stack)
1483 KernelTask *found_task =
nullptr;
1498 if (!task->IsBusy())
1504 if (task->IsMemoryOfSP(SP))
1523 #if STK_SEGGER_SYSVIEW
1524 SEGGER_SYSVIEW_OnTaskTerminate(task->GetUserStackPtr()->tid);
1528 task->GetUserTask()->
OnExit();
1555 if (task->IsSleeping())
1559 task->m_state &= ~KernelTask::STATE_SLEEP_PENDING;
1572 KernelTask *next =
nullptr;
1582 active = next->GetUserStackPtr();
1586 next->HrtOnSwitchedIn();
1608 #if STK_SEGGER_SYSVIEW
1609 SEGGER_SYSVIEW_OnTaskStartExec(
m_task_now->tid);
1646 #
if STK_TICKLESS_IDLE
1651 #if !STK_TICKLESS_IDLE
1660 #if STK_TICKLESS_IDLE
1688 task->HrtOnWorkCompleted();
1693 task->ScheduleSleep(ticks);
1698 task->BusyWaitWhileSleeping();
1717 task->ScheduleSleep(
static_cast<Timeout>(
Min(delta,
static_cast<Ticks>(INT32_MAX))));
1726 task->BusyWaitWhileSleeping();
1733 if (task !=
nullptr)
1737 if (task->IsSleeping())
1752 task->ScheduleRemoval();
1774 task->m_wait_obj->SetupWait(sync_obj, timeout);
1777 if (sync_obj->
GetHead() ==
nullptr)
1789 task->BusyWaitWhileSleeping();
1794 return task->m_wait_obj;
1808 return task->GetTid();
1839 STK_ASSERT(TStrategy::WEIGHT_API && TStrategy::PRIORITY_INHERITANCE_API);
1846 const Weight prev_weight = task->GetWeight();
1848 if (prev_weight < weight)
1850 task->SetCurrentWeight(weight);
1851 m_strategy.OnTaskWeightChange(task, prev_weight);
1859 STK_ASSERT(TStrategy::WEIGHT_API && TStrategy::PRIORITY_INHERITANCE_API);
1864 const Weight prev_weight = task->GetWeight();
1869 m_strategy.OnTaskWeightChange(task, prev_weight);
1907 if (task->IsSleeping())
1912 if (task->IsPendingRemoval())
1929 task->m_state &= ~KernelTask::STATE_SLEEP_PENDING;
1937 task->m_time_sleep += elapsed_ticks;
1943 if (!task->IsSleeping())
1956 task->m_hrt[0].duration += elapsed_ticks;
1959 if (task->HrtIsDeadlineMissed(task->m_hrt[0].duration))
1982 if ((sleep_ticks > 1) && task->IsBusy())
1984 sleep_ticks = task->GetSleepTicks(sleep_ticks);
1998 while (itr !=
nullptr)
2002 if (!
static_cast<ISyncObject *
>(itr)->Tick(elapsed_ticks))
2029 if (task->m_srt[0].add_task_req !=
nullptr)
2033 task->m_srt[0].add_task_req =
nullptr;
2034 __stk_full_memfence();
2050 next =
static_cast<KernelTask *
>(
m_strategy.GetNext());
2053 if (next !=
nullptr)
2083#ifdef _STK_UNDER_TEST
2099 KernelTask *
const now =
m_task_now, *next =
nullptr;
2100 bool switch_context =
false;
2107 switch_context =
StateSwitch(now, next, idle, active);
2111 switch_context =
StateSleep(now, next, idle, active);
2115 switch_context =
StateWake(now, next, idle, active);
2119 switch_context =
StateExit(now, next, idle, active);
2130 return switch_context;
2145 bool switch_context =
false;
2150 idle = now->GetUserStackPtr();
2151 active = next->GetUserStackPtr();
2165 if (now->m_hrt[0].done)
2168 next->HrtOnSwitchedIn();
2172 #if STK_SEGGER_SYSVIEW
2174 SEGGER_SYSVIEW_OnTaskStartReady(next->GetUserStackPtr()->tid);
2177 switch_context =
true;
2180 return switch_context;
2197 active = next->GetUserStackPtr();
2205 #if STK_SEGGER_SYSVIEW
2206 SEGGER_SYSVIEW_OnTaskStartReady(next->GetUserStackPtr()->tid);
2211 next->HrtOnSwitchedIn();
2231 idle = now->GetUserStackPtr();
2236 #if STK_SEGGER_SYSVIEW
2242 if (!now->IsPendingRemoval())
2300#if STK_SEGGER_SYSVIEW
2305 void SendTaskTraceInfo(KernelTask *task)
2309 SEGGER_SYSVIEW_TASKINFO info =
2311 .TaskID = task->GetUserStackPtr()->tid,
2312 .sName = task->GetUserTask()->GetTraceName(),
2314 .StackBase =
hw::PtrToWord(task->GetUserTask()->GetStack()),
2315 .StackSize = task->GetUserTask()->GetStackSizeBytes()
2317 SEGGER_SYSVIEW_SendTaskInfo(&info);
2348 STK_STATIC_ASSERT_N(KERNEL_MODE_MUST_BE_SET, (TStrategy::PRIORITY_INHERITANCE_API && TStrategy::WEIGHT_API) ||
2349 !TStrategy::PRIORITY_INHERITANCE_API);
#define STK_UNUSED(X)
Explicitly marks a variable as unused to suppress compiler warnings.
#define STK_STATIC_ASSERT_N(NAME, X)
Compile-time assertion with a user-defined name suffix.
#define __stk_forceinline
Forces compiler to always inline the decorated function, regardless of optimisation level.
#define STK_ASSERT(e)
Runtime assertion. Halts execution if the expression e evaluates to false.
#define __stk_attr_noinline
Prevents compiler from inlining the decorated function (function prefix).
#define __stk_constexpr_cpp17
constexpr definition for C++17 and above.
#define STK_STATIC_ASSERT_DESC(X, DESC)
Compile-time assertion with a custom error description. Produces a compilation error if X is false.
#define STK_STACK_MEMORY_FILLER
Sentinel value written to the entire stack region at initialization (stack watermark pattern).
#define STK_VIRT_DTOR
Makes destructors virtual and compliant to strict rules if STK_STRICT_COMPLIANCY=0.
Contains helper implementations which simplify user-side code.
Earliest Deadline First (EDF) task-switching strategy (stk::SwitchStrategyEDF).
Fixed-priority preemptive task-switching strategy with round-robin within each priority level (stk::S...
Rate-Monotonic (RM) and Deadline-Monotonic (DM) task-switching strategies (stk::SwitchStrategyMonoton...
Round-Robin task-switching strategy (stk::SwitchStrategyRoundRobin / stk::SwitchStrategyRR).
Smooth Weighted Round-Robin task-switching strategy (stk::SwitchStrategySmoothWeightedRoundRobin / st...
Namespace of STK package.
uintptr_t Word
Native processor word type.
@ TRACE_EVENT_SLEEP
Task entered sleep / blocked state.
@ TRACE_EVENT_SWITCH
Task context switch event (task became active).
static constexpr ITask * GetUserTaskFromTid(TId task_id) noexcept
Get task instance from its identifier.
static constexpr Timeout NO_WAIT
Timeout value: return immediately if the synchronization object is not yet signaled (non-blocking pol...
int64_t Ticks
Ticks value.
int32_t Timeout
Timeout time (ticks).
static constexpr T Max(T a, T b)
Compile-time maximum of two values.
@ STACK_SLEEP_TRAP
Stack of the Sleep trap.
@ STACK_USER_TASK
Stack of the user task.
@ STACK_EXIT_TRAP
Stack of the Exit trap.
static __stk_forceinline void STK_KERNEL_PANIC(stk::EKernelPanicId id)
Called when the kernel detects an unrecoverable internal fault.
static constexpr Weight DEFAULT_WEIGHT
Weight value: default weight of value (1) (see SwitchStrategySmoothWeightedRoundRobin).
static constexpr Weight NO_WEIGHT
Weight value: weight is not set.
@ PERIODICITY_DEFAULT
Default periodicity (microseconds), 1 millisecond.
@ PERIODICITY_MAX
Maximum periodicity (microseconds), 99 milliseconds (note: this value is the highest working on a rea...
Timeout GetInitialSleepTicks()
static constexpr Timeout WAIT_INFINITE
Timeout value: block indefinitely until the synchronization object is signaled.
static constexpr TId TID_NONE
Reserved task/thread id representing zero/none thread id.
@ SYS_TASK_ID_EXIT
Exit trap.
@ SYS_TASK_ID_SLEEP
Sleep trap.
static constexpr T Min(T a, T b)
Compile-time minimum of two values.
static constexpr TId GetTidFromUserTask(const ITask *task) noexcept
Get task identifier from ITask instance.
uint64_t Cycles
Cycles value.
int32_t Weight
Weight value (aka priority).
@ ACCESS_PRIVILEGED
Privileged access mode (access to hardware is fully unrestricted).
@ KERNEL_TICKLESS
Tickless mode. To use this mode STK_TICKLESS_IDLE must be defined to 1 in stk_config....
@ KERNEL_SYNC
Synchronization support (see Event).
@ KERNEL_HRT
Hard Real-Time (HRT) behavior (tasks are scheduled periodically and have an execution deadline,...
@ KERNEL_STATIC
All tasks are static and can not exit.
@ KERNEL_DYNAMIC
Tasks can be added or removed and therefore exit when done.
@ KERNEL_PANIC_BAD_MODE
Kernel is in bad/unsupported mode for the current operation.
@ KERNEL_PANIC_BAD_STATE
Kernel entered unexpected (bad) state.
Memory-related primitives.
__stk_forceinline void WriteVolatile64(volatile T *addr, T value)
Atomically write a 64-bit volatile value.
static constexpr Word PtrToWord(T *const ptr) noexcept
Cast a pointer to a CPU register-width integer.
bool IsInsideISR()
Check whether the CPU is currently executing inside a hardware interrupt service routine (ISR).
__stk_forceinline T ReadVolatile64(volatile const T *addr)
Atomically read a 64-bit volatile value.
volatile uint8_t m_request
void OnStop() override
Called by the platform driver after a scheduler stop (all tasks have exited).
bool UpdateFsmState(Stack *&idle, Stack *&active)
Update FSM state.
stk::SwitchStrategyFP32 m_strategy
KernelTask * AllocateNewTask(ITask *user_task)
Allocate new instance of KernelTask.
void RequestAddTask(ITask *const user_task)
Request to add new task.
void OnTaskExit(Stack *stack) override
Called from the Thread process when task finished (its Run function exited by return).
void OnTaskSleepCancel(TId task_id)
EFsmState
Finite-state machine (FSM) state. Encodes what the kernel is currently doing between two consecutive ...
KernelTask * FindTaskByStack(const Stack *stack)
Find kernel task by the bound Stack instance.
KernelTask TaskStorageType[TASKS_MAX]
KernelTask array type used as a storage for the KernelTask instances.
~Kernel()=default
Destructor.
bool OnTick(Stack *&idle, Stack *&active, Timeout &ticks) override
Process one scheduler tick. Called from the platform timer/tick ISR.
SleepTrapStack m_sleep_trap[1]
volatile EKernelState m_kstate
void OnSuspend(bool suspended) override
Called from the Thread process to suspend scheduling.
SyncObjectList m_sync_list[STK_ALLOCATE_COUNT< TMode, KERNEL_SYNC, 1U, 0U >::Value]
static constexpr Timeout YIELD_TICKS
void ScheduleTaskRemoval(ITask *user_task) override
Schedule task removal from scheduling (exit).
EFsmState GetNewFsmState(KernelTask *&next)
Get new FSM state.
void RemoveTask(ITask *user_task) override
Remove a previously added task from the kernel before Start().
StackMemoryWrapper< STACK_SIZE_MIN > ExitTrapStackMemory
Stack memory wrapper type for the exit trap.
void OnRestoreWeight(TId tid, ISyncObject *sobj)
void OnStart(Stack *&active) override
Called by platform driver immediately after a scheduler start (first tick).
static constexpr size_t TASKS_MAX
ExitTrapStack m_exit_trap[STK_ALLOCATE_COUNT< TMode, KERNEL_DYNAMIC, 1U, 0U >::Value]
bool StateWake(KernelTask *now, KernelTask *next, Stack *&idle, Stack *&active)
Wakes up after sleeping.
KernelTask * FindTaskBySP(Word SP)
Find kernel task for a Stack Pointer (SP).
void InitTraps()
Initialize stack of the traps.
static constexpr bool IsHrtMode()
void AddTask(ITask *user_task) override
Register task for a soft real-time (SRT) scheduling.
ISyncObject::ListHeadType SyncObjectList
Intrusive list of active ISyncObject instances registered with this kernel. Each sync object in this ...
EFsmEvent
Finite-state machine (FSM) event. Computed by FetchNextEvent() each tick based on strategy output and...
StackMemoryWrapper<((32U))> SleepTrapStackMemory
Stack memory wrapper type for the sleep trap.
size_t EnumerateKernelTasks(ArrayView< IKernelTask * > tasks) override
Enumerate kernel tasks.
static constexpr bool IsSyncMode()
KernelTask * FindTaskByUserTask(const ITask *user_task)
Find kernel task by the bound ITask instance.
static bool IsValidFsmState(EFsmState state)
Check if FSM state is valid.
void OnInheritWeight(TId tid, Weight weight)
void ResumeTask(ITask *user_task) override
Resume task.
void OnTaskSleep(Word caller_SP, Timeout ticks) override
Called by Thread process (via IKernelService::Sleep) for exclusion of the calling process from schedu...
void Start() override
Start the scheduler. This call does not return until all tasks have exited (KERNEL_DYNAMIC mode) or i...
TaskStorageType m_task_storage
static constexpr bool IsTicklessMode()
void RemoveTask(KernelTask *task)
Remove kernel task.
void AddKernelTask(KernelTask *task)
Add kernel task to the scheduling strategy.
EKernelState GetState() const override
Get kernel state.
ERequest
Bitmask flags for pending inter-task requests that must be processed by the kernel on the next tick (...
IWaitObject * OnTaskWait(Word caller_SP, ISyncObject *sync_obj, IMutex *mutex, Timeout timeout) override
Called from the Thread process when task needs to wait.
bool StateExit(KernelTask *now, KernelTask *next, Stack *&idle, Stack *&active)
Exits from scheduling.
IPlatform * GetPlatform() override
Get platform driver instance owned by this kernel.
void AllocateAndAddNewTask(ITask *user_task)
Allocate new instance of KernelTask and add it into the scheduling process.
void OnTaskSwitch(Word caller_SP) override
Called by Thread process (via IKernelService::SwitchToNext) to switch to a next task.
void Initialize(uint32_t resolution_us=PERIODICITY_DEFAULT) override
Initialize kernel.
stk::PlatformDefault m_platform
void HrtAllocateAndAddNewTask(ITask *user_task, Timeout periodicity_tc, Timeout deadline_tc, Timeout start_delay_tc)
Allocate new instance of KernelTask and add it into the HRT scheduling process.
TId OnGetTid(Word caller_SP) override
Called from the Thread process when for getting task/thread id of the process.
size_t EnumerateTasks(ArrayView< ITask * > user_tasks) override
Enumerate user tasks.
Timeout UpdateTasks(const Timeout elapsed_ticks)
Update tasks (sleep, requests).
void ScheduleAddTask()
Signal the kernel to process a pending AddTask request on the next tick.
bool IsInitialized() const
Check whether Initialize() has been called and completed successfully.
static constexpr bool IsDynamicMode()
ITaskSwitchStrategy * GetSwitchStrategy() override
Get task-switching strategy instance owned by this kernel.
bool StateSwitch(KernelTask *now, KernelTask *next, Stack *&idle, Stack *&active)
Switches contexts.
void AddTask(ITask *user_task, Timeout periodicity_tc, Timeout deadline_tc, Timeout start_delay_tc) override
Register a task for hard real-time (HRT) scheduling.
Kernel()
Construct the kernel with all storage zero-initialized and the request flag set to ~0 (indicating uni...
void UpdateTaskRequest()
Update pending task requests.
bool StateSleep(KernelTask *now, KernelTask *next, Stack *&idle, Stack *&active)
Enters into a sleeping mode.
Timeout UpdateTaskState(const Timeout elapsed_ticks)
Update task state: process removals, advance sleep timers, and track HRT durations.
void UpdateSyncObjects(const Timeout elapsed_ticks)
Update synchronization objects.
static constexpr bool IsStaticMode()
bool IsStarted() const
Check whether scheduler is currently running.
bool OnTaskSleepUntil(Word caller_SP, Ticks timestamp) override
Called by Thread process (via IKernelService::SleepUntil) for exclusion of the calling process from s...
const EFsmState m_fsm[FSM_STATE_MAX][FSM_EVENT_MAX]
void SuspendTask(ITask *user_task, bool &suspended) override
Suspend task.
EFsmEvent FetchNextEvent(KernelTask *&next)
Fetch next event for the FSM.
Internal per-slot kernel descriptor that wraps a user ITask instance.
Weight GetCurrentWeight() const override
Get current (run-time) scheduling weight.
KernelTask()
Construct a free (unbound) task slot. All fields set to zero/null.
void ScheduleSleep(Timeout ticks)
Put the task into a sleeping state for the specified number of ticks.
Timeout GetSleepTicks(Timeout sleep_ticks)
TId GetTid() const
Get task identifier.
Stack GetUserStack() const
Get stack descriptor for this task slot.
EStateFlags
Bitmask of transient state flags. Set by the task or the kernel and consumed (cleared) during UpdateT...
@ STATE_REMOVE_PENDING
Task returned from its Run function; slot will be freed on the next tick (KERNEL_DYNAMIC only).
@ STATE_SLEEP_PENDING
Task called Sleep/SleepUntil/Yield; strategy's OnTaskSleep() will be invoked on the next tick (sleep-...
@ STATE_NONE
No pending state flags.
Timeout GetHrtPeriodicity() const override
Get HRT scheduling periodicity.
bool HrtIsDeadlineMissed(Timeout duration) const
Check if deadline missed.
SrtInfo m_srt[STK_ALLOCATE_COUNT< TMode, KERNEL_HRT, 0U, 1U >::Value]
SRT metadata. Zero-size (no memory) in KERNEL_HRT mode.
void ScheduleRemoval()
Schedule the removal of the task from the kernel on next tick.
Stack m_stack
Stack descriptor (SP register value + access mode + optional tid).
void Bind(TPlatform *platform, ITask *user_task)
Bind this slot to a user task: set access mode, task ID, and initialize the stack.
~KernelTask()=default
Destructor.
Weight m_rt_weight[STK_ALLOCATE_COUNT< TStrategy::WEIGHT_API, 1U, 1U, 0U >::Value]
Run-time weight for weighted-round-robin scheduling. Zero-size for unweighted strategies.
void HrtHardFailDeadline(IPlatform *platform)
Hard-fail HRT task when it missed its deadline.
void HrtInit(Timeout periodicity_tc, Timeout deadline_tc, Timeout start_delay_tc)
Initialize task with HRT info.
volatile uint32_t m_state
Bitmask of EStateFlags. Written by task thread, read/cleared by kernel tick.
void BusyWaitWhileSleeping() const
Block further execution of the task's context while in sleeping state.
ITask * m_user
Bound user task, or NULL when slot is free.
Timeout GetHrtRelativeDeadline() const override
Get remaining HRT deadline (ticks left before the deadline expires).
void SetCurrentWeight(Weight weight) override
Update the run-time scheduling weight (weighted strategies only).
bool IsBusy() const
Check whether this slot is bound to a user task.
bool IsSleeping() const override
Check whether this task is currently sleeping (waiting for a tick or a wake event).
Stack * GetUserStackPtr()
Get pointer to user Stack.
HrtInfo m_hrt[STK_ALLOCATE_COUNT< TMode, KERNEL_HRT, 1U, 0U >::Value]
HRT metadata. Zero-size (no memory) in non-HRT mode.
void HrtOnWorkCompleted()
Called when task process called IKernelService::SwitchToNext to inform Kernel that work is completed.
void Wake() override
Wake this task on the next scheduling tick.
Weight GetWeight() const override
Get static scheduling weight from the user task.
volatile Timeout m_time_sleep
Sleep countdown: negative while sleeping (absolute value = ticks remaining), zero when awake.
bool IsPendingRemoval() const
Check if task is pending removal.
Timeout GetHrtDeadline() const override
Get absolute HRT deadline (ticks elapsed since task was activated).
void HrtOnSwitchedOut(IPlatform *)
Called when task is switched out from the scheduling process.
void Unbind()
Reset this slot to the free (unbound) state, clearing all scheduling metadata.
void HrtOnSwitchedIn()
Called when task is switched into the scheduling process.
bool IsMemoryOfSP(Word SP) const
Check if Stack Pointer (SP) belongs to this task.
ITask * GetUserTask() override
Get bound user task.
WaitObject m_wait_obj[STK_ALLOCATE_COUNT< TMode, KERNEL_SYNC, 1U, 0U >::Value]
Embedded wait object for synchronization. Zero-size (no memory) if KERNEL_SYNC is not set.
Payload for an in-flight AddTask() request issued by a running task.
ITask * user_task
User task to add. Must remain valid for the lifetime of its kernel slot.
Per-task soft real-time (SRT) metadata.
void Clear()
Clear all fields, ready for slot re-use.
AddTaskRequest * add_task_req
Per-task Hard Real-Time (HRT) scheduling metadata.
void Clear()
Clear all fields, ready for slot re-use or re-activation.
volatile bool done
Set to true when the task signals work completion (via Yield() or on exit). Triggers HrtOnSwitchedOut...
Timeout deadline
Maximum allowed active duration in ticks (relative to switch-in). Exceeding this triggers OnDeadlineM...
Timeout periodicity
Activation period in ticks: the task is re-activated every this many ticks.
Timeout duration
Ticks spent in the active (non-sleeping) state in the current period. Incremented by UpdateTaskState(...
Concrete implementation of IWaitObject, embedded in each KernelTask slot.
bool IsWaiting() const
Check if busy with waiting.
Timeout m_time_wait
Ticks remaining until timeout. Decremented each tick; WAIT_INFINITE means no timeout.
void Wake(bool timeout) override
Wake the waiting task (called by ISyncObject when it signals).
~WaitObject()=default
Destructor.
bool Tick(Timeout elapsed_ticks) override
Advance the timeout countdown by one tick.
bool IsTimeout() const override
Check whether the wait expired due to timeout.
void SetupWait(ISyncObject *sync_obj, Timeout timeout)
Configure and arm this wait object for a new wait operation.
TId GetTid() const override
Get the TId of the task that owns this wait object.
volatile bool m_timeout
true if the wait expired due to timeout rather than a Wake() signal.
ISyncObject * m_sync_obj
Sync object this wait is registered with, or NULL when not waiting.
KernelTask * m_task
Back-pointer to the owning KernelTask. Set once at construction; never changes.
Payload stored in the sync object's kernel-side list entry while a task is waiting.
ISyncObject * sync_obj
Sync object whose Tick() will be called each kernel tick.
KernelService()
Construct an uninitialized service instance (m_platform = null, m_ticks = 0).
Timeout Suspend() override
Suspend scheduling.
void SwitchToNext() override
Notify scheduler to switch to the next task (yield).
volatile Ticks m_ticks
Global tick counter. Written via hw::WriteVolatile64() by IncrementTick() (ISR context); read via hw:...
uint32_t GetSysTimerFrequency() const override
Get system timer frequency.
void Sleep(Timeout ticks) override
Put calling process into a sleep state.
Kernel * m_kernel
Pointer to the Kernel.
Ticks GetTicks() const override
Get number of ticks elapsed since kernel start.
void SleepCancel(TId task_id) override
Cancel sleep of the task.
void Resume(Timeout elapsed_ticks) override
Resume scheduling after a prior Suspend() call.
bool SleepUntil(Ticks timestamp) override
Put calling process into a sleep state until the specified timestamp.
void RestoreWeight(TId tid, ISyncObject *sobj) override
Restore weight of the task to the original value.
~KernelService()=default
Destructor.
void InheritWeight(TId tid, Weight weight) override
Inherit weight for the task.
Cycles GetSysTimerCount() const override
Get system timer count value.
uint32_t GetTickResolution() const override
Get number of microseconds in one tick.
void Delay(Timeout ticks) override
Delay calling process.
TId GetTid() const override
Get thread Id of the currently running task.
void IncrementTicks(Ticks advance)
Increment counter by value.
IWaitObject * Wait(ISyncObject *sobj, IMutex *mutex, Timeout ticks) override
Put calling process into a waiting state until synchronization object is signaled or timeout occurs.
void Initialize(Kernel *kernel)
Initialize instance.
Storage bundle for the sleep trap: a Stack descriptor paired with its backing memory.
SleepTrapStackMemory::MemoryType Memory
Memory memory
Backing stack memory array. Size: STK_SLEEP_TRAP_STACK_SIZE elements of Word.
Stack stack
Stack descriptor (SP register value + access mode). Initialized by InitTraps() on every Start().
Storage bundle for the exit trap: a Stack descriptor paired with its backing memory.
Memory memory
Backing stack memory array. Size: STACK_SIZE_MIN elements of Word.
ExitTrapStackMemory::MemoryType Memory
Stack stack
Stack descriptor (SP register value + access mode). Initialized by InitTraps() on every Start().
RAII guard that enters the critical section on construction and exits it on destruction.
Lightweight, non-owning view over a contiguous sequence of elements.
size_t GetSize() const
Get number of elements in the view.
EAccessMode access_mode
Hardware access mode of the owning task (see EAccessMode).
virtual const Word * GetStack() const =0
Get pointer to the stack memory.
DLEntryType ListEntryType
List entry type of ISyncObject elements.
virtual void AddWaitObject(IWaitObject *wobj)
Called by kernel when a new task starts waiting on this event.
DLHeadType ListHeadType
List head type for ISyncObject elements.
Weight FindWeightHigherThan(Weight comp) const
Find higher weight within linked wait objects.
Interface for mutex synchronization primitive.
virtual void Unlock()=0
Unlock the mutex.
virtual void Lock()=0
Lock the mutex.
Interface for a user task.
virtual EAccessMode GetAccessMode() const =0
Get hardware access mode of the user task.
TId GetId() const
Get task Id set by application.
virtual void OnExit()
Called by the kernel before removal from the scheduling (see stk::KERNEL_DYNAMIC).
Scheduling-strategy-facing interface for a kernel task slot.
Interface for a platform driver.
virtual void ProcessHardFault()=0
Cause a hard fault of the system.
Interface for a back-end event handler.
Interface for a task switching strategy implementation.
Interface for the implementation of the kernel of the scheduler. It supports Soft and Hard Real-Time ...
Interface for the kernel services exposed to the user processes during run-time when Kernel started s...
static constexpr size_t Value
Adapts an externally-owned stack memory array to the IStackMemory interface.
StackMemoryDef< _StackSize >::Type MemoryType
DLEntryType * GetNext()
Get the next entry in the list.
DLHeadType * GetHead()
Get the list head this entry currently belongs to.