stk::ITask Class Reference

Interface for a user task. More...

#include <stk_common.h>

Inheritance diagram for stk::ITask:

Collaboration diagram for stk::ITask:

Public Member Functions
virtual void	Run ()=0
	Entry point of the user task.
virtual EAccessMode	GetAccessMode () const =0
	Get hardware access mode of the user task.
virtual void	OnDeadlineMissed (uint32_t duration)
	Called by the scheduler if deadline of the task is missed when Kernel is operating in Hard Real-Time mode (see stk::KERNEL_HRT).
virtual void	OnExit ()
	Called by the kernel before removal from the scheduling (see stk::KERNEL_DYNAMIC).
virtual Weight	GetWeight () const
	Get static base weight of the task.
TId	GetId () const
	Get task Id set by application.
virtual const char *	GetTraceName () const
	Get task trace name set by application.
virtual const Word *	GetStack () const =0
	Get pointer to the stack memory.
virtual size_t	GetStackSize () const =0
	Get number of elements of the stack memory array.
virtual size_t	GetStackSizeBytes () const =0
	Get size of the memory in bytes.
virtual size_t	GetStackSpace () const
	Get available stack space.

Detailed Description

Interface for a user task.

Note

Inherit this interface by your thread/task class to make it schedulable by the Kernel.

Usage example:

class MyTask : public stk::Task<256, ACCESS_USER>
{
    void Run() override
    {
        while (true)
        {
            // task logic here
        }
    }
};
 
MyTask task1, task2;
kernel.AddTask(&task1);
kernel.AddTask(&task2);

Definition at line 588 of file stk_common.h.

Member Function Documentation

GetAccessMode()

virtual EAccessMode stk::ITask::GetAccessMode ( ) const

pure virtual

Get hardware access mode of the user task.

Implemented in FrtosTask, stk::Task< _StackSize, _AccessMode >, stk::TaskW< _Weight, _StackSize, _AccessMode >, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Referenced by stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::Bind().

Here is the caller graph for this function:

GetId()

TId stk::ITask::GetId ( ) const

inline

Get task Id set by application.

Implementation of ITask::GetId, see ITask. Placed here as it depends on GetTidFromUserTask.

Returns

Application-defined task identifier. Return 0 if unused.

Note

Used for debugging and tracing only. The kernel does not interpret this value.

Definition at line 234 of file stk_helper.h.

{
    return GetTidFromUserTask(this);
}

References stk::GetTidFromUserTask().

Referenced by stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::Bind(), and stk_task_get_id().

Here is the call graph for this function:

Here is the caller graph for this function:

GetStack()

virtual const Word * stk::IStackMemory::GetStack ( ) const

pure virtualinherited

Get pointer to the stack memory.

Implemented in FrtosTask, stk::StackMemoryWrapper< _StackSize >, stk::StackMemoryWrapper< STACK_SIZE_MIN >, stk::StackMemoryWrapper<((32U))>, stk::Task< _StackSize, _AccessMode >, stk::TaskW< _Weight, _StackSize, _AccessMode >, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Referenced by stk::Kernel< stk::KERNEL_DYNAMIC|stk::KERNEL_SYNC|stk::KERNEL_TICKLESS, 16U, stk::SwitchStrategyFP32, stk::PlatformDefault >::AllocateNewTask(), GetStackSpace(), stk::Kernel< stk::KERNEL_DYNAMIC|stk::KERNEL_SYNC|stk::KERNEL_TICKLESS, 16U, stk::SwitchStrategyFP32, stk::PlatformDefault >::StateSwitch(), and stk::Kernel< stk::KERNEL_DYNAMIC|stk::KERNEL_SYNC|stk::KERNEL_TICKLESS, 16U, stk::SwitchStrategyFP32, stk::PlatformDefault >::StateWake().

Here is the caller graph for this function:

GetStackSize()

virtual size_t stk::IStackMemory::GetStackSize ( ) const

pure virtualinherited

Get number of elements of the stack memory array.

Implemented in FrtosTask, stk::StackMemoryWrapper< _StackSize >, stk::StackMemoryWrapper< STACK_SIZE_MIN >, stk::StackMemoryWrapper<((32U))>, stk::Task< _StackSize, _AccessMode >, stk::TaskW< _Weight, _StackSize, _AccessMode >, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Referenced by GetStackSpace().

Here is the caller graph for this function:

GetStackSizeBytes()

virtual size_t stk::IStackMemory::GetStackSizeBytes ( ) const

pure virtualinherited

Get size of the memory in bytes.

Implemented in FrtosTask, stk::StackMemoryWrapper< _StackSize >, stk::StackMemoryWrapper< STACK_SIZE_MIN >, stk::StackMemoryWrapper<((32U))>, stk::Task< _StackSize, _AccessMode >, stk::TaskW< _Weight, _StackSize, _AccessMode >, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

GetStackSpace()

virtual size_t stk::IStackMemory::GetStackSpace ( ) const

inlinevirtualinherited

Get available stack space.

Returns

Number of elements of the stack memory array remaining on the stack (computed via the watermark pattern). Returns 0 if the stack has been fully used or the watermark STK_STACK_MEMORY_FILLER was overwritten.

Warning

Stack type: Bottom to Top (index[0]).

Definition at line 318 of file stk_common.h.

    {
        ArrayView<const Word> stack(GetStack(), GetStackSize());
      
        // count leading Words equal to STK_STACK_MEMORY_FILLER (watermark)
        size_t space = 0U;
        for ( ; (space < stack.GetSize()) && (stack[space] == STK_STACK_MEMORY_FILLER); ++space)
        {}
 
        return space;
    }

References stk::ArrayView< T >::GetSize(), GetStack(), GetStackSize(), and STK_STACK_MEMORY_FILLER.

Referenced by FrtosTask::GetStackHighWaterMark(), and osThreadGetStackSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTraceName()

virtual const char * stk::ITask::GetTraceName ( ) const

inlinevirtual

Get task trace name set by application.

Returns

Null-terminated name string, or NULL if unused.

Note

Used for debugging and tracing only (e.g. SEGGER SystemView). Kernel does not interpret this value.

Reimplemented in FrtosTask, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Definition at line 648 of file stk_common.h.

{ return nullptr; }

GetWeight()

virtual Weight stk::ITask::GetWeight ( ) const

inlinevirtual

Get static base weight of the task.

Returns

Static weight value of the task (must be non-zero, positive 24-bit number).

See also

SwitchStrategyFixedPriority, SwitchStrategySmoothWeightedRoundRobin, IKernelTask::GetWeight, IKernelService::InheritWeight, IKernelService::RestoreWeight

Reimplemented in FrtosTask, stk::TaskW< _Weight, _StackSize, _AccessMode >, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Definition at line 635 of file stk_common.h.

{ return DEFAULT_WEIGHT; }

References stk::DEFAULT_WEIGHT.

Referenced by stk::ISyncObject::FindWeightHigherThan().

Here is the caller graph for this function:

OnDeadlineMissed()

virtual void stk::ITask::OnDeadlineMissed ( uint32_t duration )

inlinevirtual

Called by the scheduler if deadline of the task is missed when Kernel is operating in Hard Real-Time mode (see stk::KERNEL_HRT).

Parameters

[in]

duration

Elapsed active time in ticks at the point the deadline was detected. Always greater than the task's configured deadline (ticks).

Note

Optional handler. Use it for fault logging.

After this call returns, IPlatform::ProcessHardFault() is invoked and the system enters a safe state. This function should not attempt to recover scheduling.

Reimplemented in FrtosTask, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Definition at line 618 of file stk_common.h.

{ STK_UNUSED(duration); }

References STK_UNUSED.

OnExit()

virtual void stk::ITask::OnExit ( )

inlinevirtual

Called by the kernel before removal from the scheduling (see stk::KERNEL_DYNAMIC).

Note

The task's stack is no longer in use but the ITask object itself is still valid.

The default no-op implementation is sufficient for detached tasks. Override to implement join semantics (signal a waiting joiner).

Called in kernel/tick context - keep it short. ISR-safe primitives only (e.g. stk::sync::Semaphore::Signal(), stk::sync::EventFlags::Set()).

KERNEL_DYNAMIC only. Never called in KERNEL_STATIC mode.

Reimplemented in FrtosTask, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

Definition at line 628 of file stk_common.h.

{}

Referenced by stk::Kernel< stk::KERNEL_DYNAMIC|stk::KERNEL_SYNC|stk::KERNEL_TICKLESS, 16U, stk::SwitchStrategyFP32, stk::PlatformDefault >::RemoveTask().

Here is the caller graph for this function:

Run()

virtual void stk::ITask::Run ( )

pure virtual

Entry point of the user task.

Note

Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.

Warning

If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.

void Run( override)
{
    while (true)
    {
        // task logic here
    }
}

Implemented in FrtosTask, stk::time::TimerHost::TimerWorkerTask, StkThread, and TaskWrapper.

---

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

• stk_common.h
• stk_helper.h