test_mutex.cpp File Reference

#include <stk_config.h>
#include <stk.h>
#include <sync/stk_sync_mutex.h>
#include <assert.h>
#include <string.h>
#include "stktest_context.h"

Include dependency graph for test_mutex.cpp:

Go to the source code of this file.

Classes
class	stk::test::mutex::BasicLockUnlockTask< _AccessMode >
	Tests basic lock/unlock functionality. More...
class	stk::test::mutex::RecursiveLockTask< _AccessMode >
	Tests recursive locking capability. More...
class	stk::test::mutex::TryLockTask< _AccessMode >
	Tests TryLock() non-blocking behavior. More...
class	stk::test::mutex::TimedLockTask< _AccessMode >
	Tests TimedLock() timeout behavior. More...
class	stk::test::mutex::FIFOOrderTask< _AccessMode >
	Tests FIFO ordering of waiting threads. More...
class	stk::test::mutex::StressTestTask< _AccessMode >
	Stress test with many lock/unlock cycles. More...
class	stk::test::mutex::RecursiveDepthTask< _AccessMode >
	Tests deep recursive locking. More...
class	stk::test::mutex::InterTaskCoordinationTask< _AccessMode >
	Tests mutex for coordinating work between tasks. More...

Namespaces
namespace	stk
	Namespace of STK package.
namespace	stk::test
	Namespace of the test inventory.
namespace	stk::test::mutex
	Namespace of Mutex test.

Macros
#define	_STK_MUTEX_TEST_TASKS_MAX   5
#define	_STK_MUTEX_TEST_TIMEOUT   1000
#define	_STK_MUTEX_TEST_SHORT_SLEEP   10
#define	_STK_MUTEX_TEST_LONG_SLEEP   100
#define	_STK_MUTEX_STACK_SIZE   256
#define	STK_TASK   static

Functions
static void	stk::test::mutex::ResetTestState ()
static bool	NeedsExtendedTasks (const char *test_name)
static bool	NeedsThreeTasks (const char *test_name)
template<class TaskType>
static int32_t	RunTest (const char *test_name, int32_t param=0)
int	main (int argc, char **argv)

Variables
	STK_TEST_DECL_ASSERT
static volatile int32_t	stk::test::mutex::g_TestResult = 0
static volatile int32_t	stk::test::mutex::g_SharedCounter = 0
static volatile int32_t	stk::test::mutex::g_AcquisitionOrder [5] = {0}
static volatile int32_t	stk::test::mutex::g_OrderIndex = 0
static volatile bool	stk::test::mutex::g_TestComplete = false
static volatile int32_t	stk::test::mutex::g_InstancesDone = 0
static Kernel< KERNEL_DYNAMIC|KERNEL_SYNC|(STK_TICKLESS_IDLE ? KERNEL_TICKLESS :0), 5, SwitchStrategyRR, PlatformDefault >	stk::test::mutex::g_Kernel
static sync::Mutex	stk::test::mutex::g_TestMutex

Macro Definition Documentation

_STK_MUTEX_STACK_SIZE

#define _STK_MUTEX_STACK_SIZE   256

Definition at line 31 of file test_mutex.cpp.

_STK_MUTEX_TEST_LONG_SLEEP

#define _STK_MUTEX_TEST_LONG_SLEEP   100

Definition at line 26 of file test_mutex.cpp.

Referenced by stk::test::mutex::RecursiveDepthTask< _AccessMode >::Run(), stk::test::mutex::TimedLockTask< _AccessMode >::Run(), and stk::test::mutex::TryLockTask< _AccessMode >::Run().

_STK_MUTEX_TEST_SHORT_SLEEP

#define _STK_MUTEX_TEST_SHORT_SLEEP   10

Definition at line 25 of file test_mutex.cpp.

Referenced by stk::test::mutex::BasicLockUnlockTask< _AccessMode >::Run(), stk::test::mutex::FIFOOrderTask< _AccessMode >::Run(), stk::test::mutex::InterTaskCoordinationTask< _AccessMode >::Run(), stk::test::mutex::RecursiveLockTask< _AccessMode >::Run(), stk::test::mutex::StressTestTask< _AccessMode >::Run(), stk::test::mutex::TimedLockTask< _AccessMode >::Run(), and stk::test::mutex::TryLockTask< _AccessMode >::Run().

_STK_MUTEX_TEST_TASKS_MAX

#define _STK_MUTEX_TEST_TASKS_MAX   5

Definition at line 23 of file test_mutex.cpp.

Referenced by stk::test::mutex::ResetTestState(), stk::test::mutex::BasicLockUnlockTask< _AccessMode >::Run(), stk::test::mutex::FIFOOrderTask< _AccessMode >::Run(), stk::test::mutex::InterTaskCoordinationTask< _AccessMode >::Run(), stk::test::mutex::RecursiveDepthTask< _AccessMode >::Run(), stk::test::mutex::RecursiveLockTask< _AccessMode >::Run(), and stk::test::mutex::StressTestTask< _AccessMode >::Run().

_STK_MUTEX_TEST_TIMEOUT

#define _STK_MUTEX_TEST_TIMEOUT   1000

Definition at line 24 of file test_mutex.cpp.

STK_TASK

#define STK_TASK   static

Definition at line 32 of file test_mutex.cpp.

Function Documentation

main()

int main	(	int	argc,
		char **	argv )

Definition at line 588 of file test_mutex.cpp.

{
    (void)argc;
    (void)argv;
 
    using namespace stk::test::mutex;
 
    TestContext::ShowTestSuitePrologue();
 
    int total_failures = 0, total_success = 0;
 
    printf("--------------\n");
 
    g_Kernel.Initialize();
 
#ifndef __ARM_ARCH_6M__
 
    // Test 1: Basic Lock/Unlock with mutual exclusion
    if (RunTest<BasicLockUnlockTask<ACCESS_PRIVILEGED>>("BasicLockUnlock", 100) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 2: Recursive locking
    if (RunTest<RecursiveLockTask<ACCESS_PRIVILEGED>>("RecursiveLock") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 3: TryLock non-blocking behavior
    if (RunTest<TryLockTask<ACCESS_PRIVILEGED>>("TryLock") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 4: TimedLock timeout behavior
    if (RunTest<TimedLockTask<ACCESS_PRIVILEGED>>("TimedLock") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 5: FIFO ordering
    if (RunTest<FIFOOrderTask<ACCESS_PRIVILEGED>>("FIFOOrder") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 6: Deep recursion
    if (RunTest<RecursiveDepthTask<ACCESS_PRIVILEGED>>("RecursiveDepth") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 7: Inter-task coordination
    if (RunTest<InterTaskCoordinationTask<ACCESS_PRIVILEGED>>("InterTaskCoordination") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
#endif // __ARM_ARCH_6M__
 
    // Test 8: Stress test
    if (RunTest<StressTestTask<ACCESS_PRIVILEGED>>("StressTest", 400) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    int32_t final_result = (total_failures == 0 ? TestContext::SUCCESS_EXIT_CODE : TestContext::DEFAULT_FAILURE_EXIT_CODE);
 
    printf("##############\n");
    printf("Total tests: %d\n", total_failures + total_success);
    printf("Failures: %d\n", (int)total_failures);
 
    TestContext::ShowTestSuiteEpilogue(final_result);
    return final_result;
}

References stk::test::TestContext::DEFAULT_FAILURE_EXIT_CODE, stk::test::mutex::g_Kernel, RunTest(), stk::test::TestContext::ShowTestSuiteEpilogue(), stk::test::TestContext::ShowTestSuitePrologue(), and stk::test::TestContext::SUCCESS_EXIT_CODE.

Here is the call graph for this function:

NeedsExtendedTasks()

bool NeedsExtendedTasks ( const char * test_name )

static

Definition at line 527 of file test_mutex.cpp.

{
    return  (strcmp(test_name, "TryLock")   != 0) &&
            (strcmp(test_name, "TimedLock") != 0);
}

Referenced by RunTest().

Here is the caller graph for this function:

NeedsThreeTasks()

bool NeedsThreeTasks ( const char * test_name )

static

Definition at line 537 of file test_mutex.cpp.

{
    return  (strcmp(test_name, "TryLock") != 0);
}

Referenced by RunTest().

Here is the caller graph for this function:

RunTest()

template<class TaskType>

int32_t RunTest ( const char * test_name, int32_t param = 0 )

static

Definition at line 546 of file test_mutex.cpp.

{
    using namespace stk;
    using namespace stk::test;
    using namespace stk::test::mutex;
 
    printf("Test: %s\n", test_name);
 
    ResetTestState();
 
    // Create tasks based on test type
    STK_TASK TaskType task0(0, param);
    STK_TASK TaskType task1(1, param);
    TaskType task2(2, param);
    TaskType task3(3, param);
    TaskType task4(4, param);
 
    g_Kernel.AddTask(&task0);
    g_Kernel.AddTask(&task1);
 
    if (NeedsThreeTasks(test_name))
        g_Kernel.AddTask(&task2);
 
    if (NeedsExtendedTasks(test_name))
    {
        g_Kernel.AddTask(&task3);
        g_Kernel.AddTask(&task4);
    }
 
    g_Kernel.Start();
 
    int32_t result = (g_TestResult ? TestContext::SUCCESS_EXIT_CODE : TestContext::DEFAULT_FAILURE_EXIT_CODE);
 
    printf("Result: %s\n", result == TestContext::SUCCESS_EXIT_CODE ? "PASS" : "FAIL");
    printf("--------------\n");
 
    return result;
}

References stk::test::TestContext::DEFAULT_FAILURE_EXIT_CODE, stk::test::mutex::g_Kernel, stk::test::mutex::g_TestResult, NeedsExtendedTasks(), NeedsThreeTasks(), stk::test::mutex::ResetTestState(), STK_TASK, and stk::test::TestContext::SUCCESS_EXIT_CODE.

Here is the call graph for this function:

Variable Documentation

STK_TEST_DECL_ASSERT

STK_TEST_DECL_ASSERT

Definition at line 21 of file test_mutex.cpp.