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

Include dependency graph for test_condvar.cpp:

Go to the source code of this file.

Classes
class	stk::test::condvar::NotifyOneWakesTask< _AccessMode >
	Tests that NotifyOne() wakes exactly one waiting task per call. More...
class	stk::test::condvar::NotifyAllWakesTask< _AccessMode >
	Tests that NotifyAll() wakes every waiting task in one call. More...
class	stk::test::condvar::TimeoutExpiresTask< _AccessMode >
	Tests that Wait() returns false within the expected time when no notification arrives. More...
class	stk::test::condvar::MutexReacquiredTask< _AccessMode >
	Tests that Wait() atomically releases the mutex and re-acquires it before returning. More...
class	stk::test::condvar::PredicateLoopTask< _AccessMode >
	Tests the canonical spurious-wakeup-safe predicate loop pattern. More...
class	stk::test::condvar::NotifyOneOrderTask< _AccessMode >
	Tests that NotifyOne() releases waiters in FIFO arrival order. More...
class	stk::test::condvar::NoWaitTimeoutTask< _AccessMode >
	Tests that Wait(NO_WAIT) returns false immediately without blocking. More...
class	stk::test::condvar::StressTestTask< _AccessMode >
	Stress test of ConditionVariable under full five-task contention. More...

Namespaces
namespace	stk
	Namespace of STK package.
namespace	stk::test
	Namespace of the test inventory.
namespace	stk::test::condvar
	Namespace of ConditionVariable test.

Macros
#define	_STK_CV_TEST_TASKS_MAX 5
#define	_STK_CV_TEST_TIMEOUT 300
#define	_STK_CV_TEST_SHORT_SLEEP 10
#define	_STK_CV_TEST_LONG_SLEEP 100
#define	_STK_CV_STACK_SIZE 256
#define	STK_TASK static

Functions
void *	operator new (std::size_t, void *ptr) noexcept
void	operator delete (void , void ) noexcept
static void	stk::test::condvar::ResetTestState ()
static bool	NeedsExtendedTasks (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::condvar::g_TestResult = 0
static volatile int32_t	stk::test::condvar::g_SharedCounter = 0
static volatile int32_t	stk::test::condvar::g_AcquisitionOrder [5] = {0}
static volatile int32_t	stk::test::condvar::g_OrderIndex = 0
static volatile bool	stk::test::condvar::g_TestComplete = false
static volatile int32_t	stk::test::condvar::g_InstancesDone = 0
static Kernel< KERNEL_DYNAMIC\|KERNEL_SYNC, 5, SwitchStrategyRR, PlatformDefault >	stk::test::condvar::g_Kernel
static sync::Mutex	stk::test::condvar::g_TestMutex
static sync::ConditionVariable	stk::test::condvar::g_TestCond

Macro Definition Documentation

◆ _STK_CV_STACK_SIZE

#define _STK_CV_STACK_SIZE 256

Definition at line 32 of file test_condvar.cpp.

◆ _STK_CV_TEST_LONG_SLEEP

#define _STK_CV_TEST_LONG_SLEEP 100

Definition at line 27 of file test_condvar.cpp.

Referenced by stk::test::condvar::MutexReacquiredTask< _AccessMode >::Run(), stk::test::condvar::NotifyAllWakesTask< _AccessMode >::Run(), stk::test::condvar::NotifyOneOrderTask< _AccessMode >::Run(), stk::test::condvar::NotifyOneWakesTask< _AccessMode >::Run(), stk::test::condvar::PredicateLoopTask< _AccessMode >::Run(), and stk::test::condvar::StressTestTask< _AccessMode >::Run().

◆ _STK_CV_TEST_SHORT_SLEEP

#define _STK_CV_TEST_SHORT_SLEEP 10

Definition at line 26 of file test_condvar.cpp.

◆ _STK_CV_TEST_TASKS_MAX

#define _STK_CV_TEST_TASKS_MAX 5

Definition at line 24 of file test_condvar.cpp.

Referenced by stk::test::condvar::ResetTestState(), stk::test::condvar::NotifyAllWakesTask< _AccessMode >::Run(), stk::test::condvar::NotifyOneOrderTask< _AccessMode >::Run(), stk::test::condvar::PredicateLoopTask< _AccessMode >::Run(), and stk::test::condvar::StressTestTask< _AccessMode >::Run().

◆ _STK_CV_TEST_TIMEOUT

#define _STK_CV_TEST_TIMEOUT 300

Definition at line 25 of file test_condvar.cpp.

Referenced by stk::test::condvar::MutexReacquiredTask< _AccessMode >::Run(), stk::test::condvar::NotifyAllWakesTask< _AccessMode >::Run(), stk::test::condvar::NotifyOneOrderTask< _AccessMode >::Run(), stk::test::condvar::NotifyOneWakesTask< _AccessMode >::Run(), stk::test::condvar::NoWaitTimeoutTask< _AccessMode >::Run(), stk::test::condvar::PredicateLoopTask< _AccessMode >::Run(), and stk::test::condvar::TimeoutExpiresTask< _AccessMode >::Run().

◆ STK_TASK

#define STK_TASK static

Definition at line 33 of file test_condvar.cpp.

Referenced by RunTest(), RunTest(), RunTest(), RunTest(), RunTest(), RunTest(), RunTest(), RunTest(), and RunTest().

Function Documentation

◆ main()

int main	(	int	argc,
		char **	argv )

Definition at line 635 of file test_condvar.cpp.

{
    (void)argc;
    (void)argv;
 
    using namespace stk::test::condvar;
 
    TestContext::ShowTestSuitePrologue();
 
    int total_failures = 0, total_success = 0;
 
    printf("--------------\n");
 
    g_Kernel.Initialize();
 
#ifndef __ARM_ARCH_6M__
 
    // Test 1: NotifyOne() wakes exactly one waiting task per call
    if (RunTest<NotifyOneWakesTask<ACCESS_PRIVILEGED>>("NotifyOneWakes", 20) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 2: NotifyAll() wakes every waiting task in a single call
    if (RunTest<NotifyAllWakesTask<ACCESS_PRIVILEGED>>("NotifyAllWakes") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 3: Wait() returns false within correct time window when no notification arrives (tasks 0-2 only)
    if (RunTest<TimeoutExpiresTask<ACCESS_PRIVILEGED>>("TimeoutExpires") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 4: Wait() atomically releases mutex and re-acquires it before returning (tasks 0-2 only)
    if (RunTest<MutexReacquiredTask<ACCESS_PRIVILEGED>>("MutexReacquired") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 5: Spurious-wakeup-safe predicate loop correctly drives all consumers to completion
    if (RunTest<PredicateLoopTask<ACCESS_PRIVILEGED>>("PredicateLoop") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 6: NotifyOne() releases waiters in FIFO arrival order
    if (RunTest<NotifyOneOrderTask<ACCESS_PRIVILEGED>>("NotifyOneOrder") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 7: Wait(NO_WAIT) returns false immediately without blocking (tasks 0-2 only)
    if (RunTest<NoWaitTimeoutTask<ACCESS_PRIVILEGED>>("NoWaitTimeout") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
#endif // __ARM_ARCH_6M__
 
    // Test 8: Stress test under full five-task contention with alternating producer/consumer roles
    if (RunTest<StressTestTask<ACCESS_PRIVILEGED>>("StressTest", 100) != 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", total_failures);
 
    TestContext::ShowTestSuiteEpilogue(final_result);
    return final_result;
}

References stk::test::TestContext::DEFAULT_FAILURE_EXIT_CODE, stk::test::condvar::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 584 of file test_condvar.cpp.

{
    return  (strcmp(test_name, "TimeoutExpires")   != 0) &&
            (strcmp(test_name, "MutexReacquired")  != 0) &&
            (strcmp(test_name, "NoWaitTimeout")    != 0);
}

Referenced by RunTest().

Here is the caller graph for this function:

◆ operator delete()

void operator delete	(	void *	,
		void *	)

inlinenoexcept

Definition at line 38 of file test_condvar.cpp.

38{ /* nothing for placement delete */ }

◆ operator new()

void * operator new	(	std::size_t	,
		void *	ptr )

inlinenoexcept

Definition at line 37 of file test_condvar.cpp.

37{ return ptr; }

◆ RunTest()

template<class TaskType>

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

static

Definition at line 595 of file test_condvar.cpp.

{
    using namespace stk;
    using namespace stk::test;
    using namespace stk::test::condvar;
 
    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);
    STK_TASK TaskType task2(2, param);
    TaskType task3(3, param);
    TaskType task4(4, param);
 
    g_Kernel.AddTask(&task0);
    g_Kernel.AddTask(&task1);
    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::condvar::g_Kernel, stk::test::condvar::g_TestResult, NeedsExtendedTasks(), stk::test::condvar::ResetTestState(), STK_TASK, and stk::test::TestContext::SUCCESS_EXIT_CODE.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ STK_TEST_DECL_ASSERT

STK_TEST_DECL_ASSERT

Definition at line 22 of file test_condvar.cpp.

Classes

Namespaces

Macros

Functions

Variables