stk::IStackMemory Class Reference

Interface for a stack memory region. More...

#include <stk_common.h>

Inheritance diagram for stk::IStackMemory:

Public Member Functions
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	GetStackSpace () const
	Get available stack space.

Protected Member Functions
	~IStackMemory ()=default
	Destructor.

Detailed Description

Interface for a stack memory region.

Definition at line 412 of file stk_common.h.

Constructor & Destructor Documentation

~IStackMemory()

stk::IStackMemory::~IStackMemory ( )

protecteddefault

Destructor.

Note

Protected by design. Prevents unsafe polymorphic delete.

Member Function Documentation

GetStack()

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

pure virtual

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< TMode, TSize, TStrategy, TPlatform >::KernelTask::IsMemoryOfSP(), 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 virtual

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(), and stk::Kernel< TMode, TSize, TStrategy, TPlatform >::KernelTask::IsMemoryOfSP().

Here is the caller graph for this function:

GetStackSpace()

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

inlinevirtual

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

---

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

• stk_common.h