stk::TaskW< _Weight, _StackSize, _AccessMode > Class Template Reference

Partial implementation of the user task with a compile-time scheduling weight. Use when the kernel is configured with SwitchStrategySmoothWeightedRoundRobin. More...

#include <stk_helper.h>

Inheritance diagram for stk::TaskW< _Weight, _StackSize, _AccessMode >:

Collaboration diagram for stk::TaskW< _Weight, _StackSize, _AccessMode >:

Public Types
enum	{ STACK_SIZE = _StackSize }

Public Member Functions
const Word *	GetStack () const override
	Get pointer to the stack memory.
size_t	GetStackSize () const override
	Get number of elements of the stack memory array.
EAccessMode	GetAccessMode () const override
	Get hardware access mode of the user task.
Weight	GetWeight () const override
	Get static base weight of the task.
virtual void	Run ()=0
	Entry point of the user task.
virtual IStackMemory *	GetSecureStackMemory ()
	Get pointer to the stack memory.
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).
TId	GetId () const
	Get task Id set by application.
virtual const char *	GetTraceName () const
	Get task trace name set by application.
virtual size_t	GetStackSpace () const
	Get available stack space.

Protected Member Functions
	TaskW (const TaskW &)=delete
TaskW &	operator= (const TaskW &)=delete
	TaskW ()
	Initializes task instance and zero-initializes its internal stack memory.
	~TaskW ()=default
	Destructor.

Private Attributes
StackMemoryDef< _StackSize >::Type	m_stack
	Stack memory region, 16-byte aligned.

Detailed Description

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>
class stk::TaskW< _Weight, _StackSize, _AccessMode >

Partial implementation of the user task with a compile-time scheduling weight. Use when the kernel is configured with SwitchStrategySmoothWeightedRoundRobin.

Template Parameters

_Weight	Static scheduling weight (positive, non-zero 24-bit integer). Higher values cause this task to receive proportionally more CPU time.
_StackSize	Stack size in elements of Word.
_AccessMode	Hardware access mode (ACCESS_USER or ACCESS_PRIVILEGED).

Note

Hard Real-Time mode (KERNEL_HRT) is not supported for weighted tasks. OnDeadlineMissed() will trigger an assertion if HRT scheduling is attempted.

See Task for full usage example and implementation guidance.

Definition at line 95 of file stk_helper.h.

Member Enumeration Documentation

anonymous enum

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

anonymous enum

Enumerator
STACK_SIZE

Definition at line 98 of file stk_helper.h.

{ STACK_SIZE = _StackSize }; 

Constructor & Destructor Documentation

TaskW() [1/2]

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

stk::TaskW< _Weight, _StackSize, _AccessMode >::TaskW ( const TaskW< _Weight, _StackSize, _AccessMode > & )

protecteddelete

Referenced by operator=().

Here is the caller graph for this function:

TaskW() [2/2]

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

stk::TaskW< _Weight, _StackSize, _AccessMode >::TaskW ( )

inlineprotected

Initializes task instance and zero-initializes its internal stack memory.

The constructor is protected to ensure that the Task class can only be instantiated through a derived subclass. It handles the allocation (if applicable) and zero-initialization of the m_stack member based on the _StackSize template parameter.

Definition at line 115 of file stk_helper.h.

: m_stack() {}

References m_stack.

~TaskW()

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

stk::TaskW< _Weight, _StackSize, _AccessMode >::~TaskW ( )

protecteddefault

Destructor.

Note

MISRA deviation: [STK-DEV-005] Rule 10-3-2.

References STK_VIRT_DTOR.

Member Function Documentation

GetAccessMode()

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

EAccessMode stk::TaskW< _Weight, _StackSize, _AccessMode >::GetAccessMode ( ) const

inlineoverridevirtual

Get hardware access mode of the user task.

Implements stk::ITask.

Definition at line 102 of file stk_helper.h.

{ return _AccessMode; }

GetId()

TId stk::ITask::GetId ( ) const

inlineinherited

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

GetSecureStackMemory()

virtual IStackMemory * stk::ITask::GetSecureStackMemory ( )

inlinevirtualinherited

Get pointer to the stack memory.

Note

Optional. ARM TrustZone only.

Returns

Pointer to the Secure stack memory.

Definition at line 692 of file stk_common.h.

{ return nullptr; }

GetStack()

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

const Word * stk::TaskW< _Weight, _StackSize, _AccessMode >::GetStack ( ) const

inlineoverridevirtual

Get pointer to the stack memory.

Implements stk::IStackMemory.

Definition at line 100 of file stk_helper.h.

{ return const_cast<Word *>(m_stack); }

References m_stack.

GetStackSize()

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

size_t stk::TaskW< _Weight, _StackSize, _AccessMode >::GetStackSize ( ) const

inlineoverridevirtual

Get number of elements of the stack memory array.

Implements stk::IStackMemory.

Definition at line 101 of file stk_helper.h.

{ return _StackSize; }

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 336 of file stk_common.h.

    {
        const ArrayView<const Word> stack(GetStack(), GetStackSize());
        const size_t total_size = stack.GetSize();
        size_t space = 0U;
 
        for (size_t i = 0U; i < total_size; ++i)
        {
            if (stack[i] == STK_STACK_MEMORY_FILLER)
            {
                space = i + 1U;
            }
            else
            {
                break; // terminate loop as soon as watermark ends
            }
        }
 
        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

inlinevirtualinherited

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 735 of file stk_common.h.

{ return nullptr; }

GetWeight()

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

Weight stk::TaskW< _Weight, _StackSize, _AccessMode >::GetWeight ( ) const

inlineoverridevirtual

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 from stk::ITask.

Definition at line 103 of file stk_helper.h.

{ return _Weight; }

OnDeadlineMissed()

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

inlinevirtualinherited

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 705 of file stk_common.h.

{ STK_UNUSED(duration); }

References STK_UNUSED.

OnExit()

virtual void stk::ITask::OnExit ( )

inlinevirtualinherited

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

operator=()

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

TaskW & stk::TaskW< _Weight, _StackSize, _AccessMode >::operator= ( const TaskW< _Weight, _StackSize, _AccessMode > & )

protecteddelete

References TaskW().

Here is the call graph for this function:

Run()

virtual void stk::ITask::Run ( )

pure virtualinherited

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.

Member Data Documentation

m_stack

template<Weight _Weight, size_t _StackSize, EAccessMode _AccessMode>

StackMemoryDef<_StackSize>::Type stk::TaskW< _Weight, _StackSize, _AccessMode >::m_stack

private

Stack memory region, 16-byte aligned.

Definition at line 123 of file stk_helper.h.

Referenced by GetStack(), and TaskW().

---

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

• stk_helper.h