stk::test::spinlock::TryLockContendedTask< _AccessMode > Class Template Reference

Tests TryLock() returns false immediately when the lock is held by another task. More...

Inheritance diagram for stk::test::spinlock::TryLockContendedTask< _AccessMode >:

Collaboration diagram for stk::test::spinlock::TryLockContendedTask< _AccessMode >:

Public Types
enum

Public Member Functions
	TryLockContendedTask (uint8_t task_id, int32_t)
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	OnDeadlineMissed (uint32_t duration)
	Default no-op handler. Override in subclass to log or handle missed deadlines.
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.

Private Member Functions
void	Run ()
	Entry point of the user task.

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

Detailed Description

template<EAccessMode _AccessMode>
class stk::test::spinlock::TryLockContendedTask< _AccessMode >

Tests TryLock() returns false immediately when the lock is held by another task.

Note

Task 0 holds the lock for an extended period; task 1 calls TryLock() and verifies it returns false quickly without blocking.

Definition at line 186 of file test_spinlock.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Definition at line 52 of file stk_helper.h.

{ STACK_SIZE = _StackSize }; 

Constructor & Destructor Documentation

TryLockContendedTask()

template<EAccessMode _AccessMode>

stk::test::spinlock::TryLockContendedTask< _AccessMode >::TryLockContendedTask ( uint8_t task_id, int32_t  )

inline

Definition at line 191 of file test_spinlock.cpp.

                                                   : m_task_id(task_id)
    {}

References m_task_id.

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 72 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); }

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 76 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 68 of file stk_helper.h.

{ return 1; }

OnDeadlineMissed()

virtual void stk::Task< _StackSize, _AccessMode >::OnDeadlineMissed ( uint32_t duration )

inlinevirtualinherited

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.

Implements stk::ITask.

Definition at line 62 of file stk_helper.h.

{ (void)duration; }

Run()

template<EAccessMode _AccessMode>

void stk::test::spinlock::TryLockContendedTask< _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 195 of file test_spinlock.cpp.

    {
        if (m_task_id == 0)
        {
            // Acquire and hold; signal task 1 that the lock is held
            g_TestSpinLock.Lock();
            g_SharedCounter = 1;
            stk::Sleep(_STK_SL_TEST_LONG_SLEEP);
            g_TestSpinLock.Unlock();
        }
        else
        if (m_task_id == 1)
        {
            // Wait until task 0 signals it has acquired the lock
            while (g_SharedCounter == 0)
                stk::Yield();
 
            int64_t start   = GetTimeNowMs();
            bool acquired   = g_TestSpinLock.TryLock();
            int64_t elapsed = GetTimeNowMs() - start;
 
            // Must fail immediately: task 0 holds the lock
            if (!acquired && elapsed < _STK_SL_TEST_SHORT_SLEEP)
                ++g_SharedCounter; // 2: correctly returned false immediately
 
            if (acquired)
                g_TestSpinLock.Unlock();
        }
        else
        if (m_task_id == 2)
        {
            stk::Sleep(_STK_SL_TEST_LONG_SLEEP + _STK_SL_TEST_SHORT_SLEEP);
 
            printf("try-lock contended: counter=%d (expected 2)\n", (int)g_SharedCounter);
 
            if (g_SharedCounter == 2)
                g_TestResult = 1;
        }
 
        ++g_InstancesDone;
    }

References _STK_SL_TEST_LONG_SLEEP, _STK_SL_TEST_SHORT_SLEEP, stk::test::spinlock::g_InstancesDone, stk::test::spinlock::g_SharedCounter, stk::test::spinlock::g_TestResult, stk::test::spinlock::g_TestSpinLock, stk::GetTimeNowMs(), m_task_id, stk::Sleep(), and stk::Yield().

Here is the call graph for this function:

Member Data Documentation

m_stack

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

privateinherited

Stack memory region, 16-byte aligned.

Definition at line 98 of file stk_helper.h.

m_task_id

template<EAccessMode _AccessMode>

uint8_t stk::test::spinlock::TryLockContendedTask< _AccessMode >::m_task_id

private

Definition at line 188 of file test_spinlock.cpp.

Referenced by Run(), and TryLockContendedTask().

---

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

• test_spinlock.cpp