stk::test::TaskMock< _AccessMode > Class Template Reference

Task mock. More...

#include <stktest.h>

Inheritance diagram for stk::test::TaskMock< _AccessMode >:

Collaboration diagram for stk::test::TaskMock< _AccessMode >:

Public Types
enum

Public Member Functions
	TaskMock ()
Word *	GetStack () const
	Get pointer to the stack memory.
size_t	GetStackSize () const
	Get number of elements of the stack memory array.
size_t	GetStackSizeBytes () const
	Get size of the memory in bytes.
EAccessMode	GetAccessMode () const
	Get hardware access mode of the user task.
virtual void	OnExit ()
	Default no-op handler. Override to implement join semantics (signal a waiting joiner).
virtual int32_t	GetWeight () const
	Default weight of 1. Override in subclass if custom scheduling weight is needed.
virtual TId	GetId () const
	Get object's own address as its Id. Unique per task instance, requires no manual assignment.
virtual const char *	GetTraceName () const
	Override in subclass to supply a name for SEGGER SystemView tracing. Returns NULL by default.
virtual size_t	GetStackSpace ()
	Get available stack space.

Public Attributes
uint32_t	m_deadline_missed
	duration of workload if deadline is missed in HRT mode

Private Member Functions
void	Run ()
	Entry point of the user task.
void	OnDeadlineMissed (uint32_t duration)
	Default no-op handler. Override in subclass to log or handle missed deadlines.

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

Detailed Description

template<EAccessMode _AccessMode>
class stk::test::TaskMock< _AccessMode >

Task mock.

Note

QEMU allocates small stack for the function, therefore stack size is limited to STACK_SIZE_MIN for tests to pass (256 was causing a hard fault).

Definition at line 382 of file stktest.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Definition at line 52 of file stk_helper.h.

{ STACK_SIZE = _StackSize }; 

Constructor & Destructor Documentation

TaskMock()

template<EAccessMode _AccessMode>

stk::test::TaskMock< _AccessMode >::TaskMock ( )

inline

Definition at line 385 of file stktest.h.

               : m_deadline_missed(0)
    {}

References m_deadline_missed.

Member Function Documentation

GetAccessMode()

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

inlinevirtualinherited

Get hardware access mode of the user task.

Implements stk::ITask.

Definition at line 57 of file stk_helper.h.

{ return _AccessMode; }

GetId()

virtual TId stk::Task< _StackSize, _AccessMode >::GetId ( ) const

inlinevirtualinherited

Get object's own address as its Id. Unique per task instance, requires no manual assignment.

Implements stk::ITask.

Definition at line 77 of file stk_helper.h.

{ return hw::PtrToWord(this); }

GetStack()

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

inlinevirtualinherited

Get pointer to the stack memory.

Implements stk::IStackMemory.

Definition at line 54 of file stk_helper.h.

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

GetStackSize()

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

inlinevirtualinherited

Get number of elements of the stack memory array.

Implements stk::IStackMemory.

Definition at line 55 of file stk_helper.h.

{ return _StackSize; }

GetStackSizeBytes()

size_t stk::Task< _StackSize, _AccessMode >::GetStackSizeBytes ( ) const

inlinevirtualinherited

Get size of the memory in bytes.

Implements stk::IStackMemory.

Definition at line 56 of file stk_helper.h.

{ return _StackSize * sizeof(Word); }

GetStackSpace()

virtual size_t stk::IStackMemory::GetStackSpace ( )

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

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

GetTraceName()

virtual const char * stk::Task< _StackSize, _AccessMode >::GetTraceName ( ) const

inlinevirtualinherited

Override in subclass to supply a name for SEGGER SystemView tracing. Returns NULL by default.

Implements stk::ITask.

Definition at line 81 of file stk_helper.h.

{ return nullptr; }

GetWeight()

virtual int32_t stk::Task< _StackSize, _AccessMode >::GetWeight ( ) const

inlinevirtualinherited

Default weight of 1. Override in subclass if custom scheduling weight is needed.

Note

Only relevant when using SwitchStrategySmoothWeightedRoundRobin. Prefer TaskW for compile-time weight assignment.

Implements stk::ITask.

Definition at line 73 of file stk_helper.h.

{ return 1; }

OnDeadlineMissed()

template<EAccessMode _AccessMode>

void stk::test::TaskMock< _AccessMode >::OnDeadlineMissed ( uint32_t duration )

inlineprivatevirtual

Default no-op handler. Override in subclass to log or handle missed deadlines.

Note

HRT deadline misses are only possible when the kernel is started with KERNEL_HRT.

Reimplemented from stk::Task< STACK_SIZE_MIN, _AccessMode >.

Definition at line 393 of file stktest.h.

    {
        // call base (to achieve full coverage)
        Task<STACK_SIZE_MIN, _AccessMode>::OnDeadlineMissed(duration);
 
        m_deadline_missed = duration;
    }

References m_deadline_missed, and stk::Task< _StackSize, _AccessMode >::OnDeadlineMissed().

Here is the call graph for this function:

OnExit()

virtual void stk::Task< _StackSize, _AccessMode >::OnExit ( )

inlinevirtualinherited

Default no-op handler. Override to implement join semantics (signal a waiting joiner).

Note

Called by the kernel only in KERNEL_DYNAMIC mode.

Implements stk::ITask.

Definition at line 67 of file stk_helper.h.

{}

Run()

template<EAccessMode _AccessMode>

void stk::test::TaskMock< _AccessMode >::Run ( )

inlineprivatevirtual

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()
{
    while (true)
    {
        // task logic here
    }
}

Implements stk::ITask.

Definition at line 391 of file stktest.h.

{}

Member Data Documentation

m_deadline_missed

template<EAccessMode _AccessMode>

uint32_t stk::test::TaskMock< _AccessMode >::m_deadline_missed

duration of workload if deadline is missed in HRT mode

Definition at line 388 of file stktest.h.

Referenced by OnDeadlineMissed(), TaskMock(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), and stk::test::TEST().

m_stack

StackMemoryDef<_StackSize>::Type stk::Task< _StackSize, _AccessMode >::m_stack

privateinherited

Stack memory region, 16-byte aligned.

Definition at line 103 of file stk_helper.h.

---

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

• stktest.h