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

Include dependency graph for test_eventflags.cpp:

Go to the source code of this file.

Classes
class	stk::test::eventflags::SetWaitAnyTask< _AccessMode >
	Tests WAIT_ANY (OR) semantics: a single flag unblocks a waiting task. More...
class	stk::test::eventflags::SetWaitAllTask< _AccessMode >
	Tests WAIT_ALL (AND) semantics: all requested flags must be set before unblocking. More...
class	stk::test::eventflags::ClearTask< _AccessMode >
	Tests Clear() return value and effect on subsequent Wait() calls. More...
class	stk::test::eventflags::NoClearTask< _AccessMode >
	Tests NO_CLEAR option: matched flags are not consumed after a successful Wait(). More...
class	stk::test::eventflags::TimeoutTask< _AccessMode >
	Tests Wait() timeout when the required flags are never set. More...
class	stk::test::eventflags::TryWaitTask< _AccessMode >
	Tests TryWait() non-blocking poll. More...
class	stk::test::eventflags::GetTask< _AccessMode >
	Tests Get() returns a non-destructive snapshot of the flags word. More...
class	stk::test::eventflags::MultiWaiterAnyTask< _AccessMode >
	Tests WAIT_ANY with multiple concurrent waiters watching different flag subsets. More...
class	stk::test::eventflags::MultiWaiterAllTask< _AccessMode >
	Tests WAIT_ALL with multiple concurrent waiters, each requiring the full flag set. More...
class	stk::test::eventflags::InitialFlagsTask< _AccessMode >
	Tests EventFlags constructed with a non-zero initial flags word. More...

Namespaces
namespace	stk
	Namespace of STK package.
namespace	stk::test
	Namespace of the test inventory.
namespace	stk::test::eventflags
	Namespace of EventFlags test.

Macros
#define	_STK_EF_TEST_TASKS_MAX 5
#define	_STK_EF_TEST_TIMEOUT 300
#define	_STK_EF_TEST_SHORT_SLEEP 10
#define	_STK_EF_TEST_LONG_SLEEP 100
#define	_STK_EF_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::eventflags::ResetTestState (uint32_t initial_flags=0U)
static bool	NeedsExtendedTasks (const char *test_name)
template<class TaskType>
static int32_t	RunTest (const char *test_name, int32_t param=0, uint32_t initial_flags=0U)
int	main (int argc, char **argv)

Variables
	STK_TEST_DECL_ASSERT
static const uint32_t	FLAG_A = (1U << 0)
static const uint32_t	FLAG_B = (1U << 1)
static const uint32_t	FLAG_C = (1U << 2)
static const uint32_t	FLAG_D = (1U << 3)
static volatile int32_t	stk::test::eventflags::g_TestResult = 0
static volatile int32_t	stk::test::eventflags::g_SharedCounter = 0
static volatile bool	stk::test::eventflags::g_TestComplete = false
static Kernel< KERNEL_DYNAMIC\|KERNEL_SYNC, 5, SwitchStrategyRR, PlatformDefault >	stk::test::eventflags::g_Kernel
static sync::EventFlags	stk::test::eventflags::g_Flags

Macro Definition Documentation

◆ _STK_EF_STACK_SIZE

#define _STK_EF_STACK_SIZE 256

Definition at line 31 of file test_eventflags.cpp.

◆ _STK_EF_TEST_LONG_SLEEP

#define _STK_EF_TEST_LONG_SLEEP 100

Definition at line 26 of file test_eventflags.cpp.

◆ _STK_EF_TEST_SHORT_SLEEP

#define _STK_EF_TEST_SHORT_SLEEP 10

Definition at line 25 of file test_eventflags.cpp.

◆ _STK_EF_TEST_TASKS_MAX

#define _STK_EF_TEST_TASKS_MAX 5

Definition at line 23 of file test_eventflags.cpp.

Referenced by main(), and stk::test::eventflags::MultiWaiterAnyTask< _AccessMode >::Run().

◆ _STK_EF_TEST_TIMEOUT

#define _STK_EF_TEST_TIMEOUT 300

Definition at line 24 of file test_eventflags.cpp.

Referenced by stk::test::eventflags::ClearTask< _AccessMode >::Run(), stk::test::eventflags::GetTask< _AccessMode >::Run(), stk::test::eventflags::MultiWaiterAllTask< _AccessMode >::Run(), stk::test::eventflags::MultiWaiterAnyTask< _AccessMode >::Run(), stk::test::eventflags::NoClearTask< _AccessMode >::Run(), stk::test::eventflags::SetWaitAllTask< _AccessMode >::Run(), and stk::test::eventflags::SetWaitAnyTask< _AccessMode >::Run().

◆ STK_TASK

#define STK_TASK static

Definition at line 32 of file test_eventflags.cpp.

Function Documentation

◆ main()

int main	(	int	argc,
		char **	argv )

Definition at line 711 of file test_eventflags.cpp.

{
    (void)argc;
    (void)argv;
 
    using namespace stk::test::eventflags;
 
    TestContext::ShowTestSuitePrologue();
 
    int total_failures = 0, total_success = 0;
 
    printf("--------------\n");
 
    g_Kernel.Initialize();
 
    // Test 1: WAIT_ANY — one Set() unblocks exactly one consumer per call
    if (RunTest<SetWaitAnyTask<ACCESS_PRIVILEGED>>("SetWaitAny", 20) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
#ifndef __ARM_ARCH_6M__
 
    // Test 2: WAIT_ALL — Wait() blocks until all requested bits are simultaneously set
    if (RunTest<SetWaitAllTask<ACCESS_PRIVILEGED>>("SetWaitAll") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 3: Clear() returns pre-clear value; cleared bits block subsequent waiters
    if (RunTest<ClearTask<ACCESS_PRIVILEGED>>("Clear") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 4: NO_CLEAR option — matched flags are not consumed; next Wait() still succeeds
    if (RunTest<NoClearTask<ACCESS_PRIVILEGED>>("NoClear") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 5: Wait() returns ERROR_TIMEOUT within the expected window when flags are never set
    if (RunTest<TimeoutTask<ACCESS_PRIVILEGED>>("Timeout") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 6: TryWait() returns immediately; auto-clears on success; fails when flags absent
    if (RunTest<TryWaitTask<ACCESS_PRIVILEGED>>("TryWait") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 7: Get() is non-destructive; reflects Set() and Clear() without consuming flags
    if (RunTest<GetTask<ACCESS_PRIVILEGED>>("Get") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 8: Multiple concurrent WAIT_ANY waiters, each with a unique flag bit
    if (RunTest<MultiWaiterAnyTask<ACCESS_PRIVILEGED>>("MultiWaiterAny") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 9: Multiple concurrent WAIT_ALL waiters — all must eventually receive the full mask
    if (RunTest<MultiWaiterAllTask<ACCESS_PRIVILEGED>>("MultiWaiterAll", _STK_EF_TEST_TASKS_MAX - 1) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 10: Constructor initial_flags — fast-path Wait() succeeds; cleared flag then times out
    if (RunTest<InitialFlagsTask<ACCESS_PRIVILEGED>>("InitialFlags", 0, FLAG_A) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
#endif // __ARM_ARCH_6M__
 
    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_EF_TEST_TASKS_MAX, stk::test::TestContext::DEFAULT_FAILURE_EXIT_CODE, FLAG_A, stk::test::eventflags::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 653 of file test_eventflags.cpp.

{
    return (strcmp(test_name, "SetWaitAll")    != 0) &&
           (strcmp(test_name, "Clear")         != 0) &&
           (strcmp(test_name, "NoClear")       != 0) &&
           (strcmp(test_name, "Timeout")       != 0) &&
           (strcmp(test_name, "TryWait")       != 0) &&
           (strcmp(test_name, "Get")           != 0) &&
           (strcmp(test_name, "InitialFlags")  != 0);
}

Referenced by RunTest().

Here is the caller graph for this function:

◆ operator delete()

void operator delete	(	void *	,
		void *	)

inlinenoexcept

Definition at line 37 of file test_eventflags.cpp.

37{ /* nothing for placement delete */ }

◆ operator new()

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

inlinenoexcept

Definition at line 36 of file test_eventflags.cpp.

36{ return ptr; }

◆ RunTest()

template<class TaskType>

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

static

Definition at line 668 of file test_eventflags.cpp.

{
    using namespace stk;
    using namespace stk::test;
    using namespace stk::test::eventflags;
 
    printf("Test: %s\n", test_name);
 
    ResetTestState(initial_flags);
 
    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::eventflags::g_Kernel, stk::test::eventflags::g_TestResult, NeedsExtendedTasks(), stk::test::eventflags::ResetTestState(), STK_TASK, and stk::test::TestContext::SUCCESS_EXIT_CODE.

Here is the call graph for this function:

Variable Documentation

◆ FLAG_A

const uint32_t FLAG_A = (1U << 0)

static

Definition at line 41 of file test_eventflags.cpp.

◆ FLAG_B

const uint32_t FLAG_B = (1U << 1)

static

Definition at line 42 of file test_eventflags.cpp.

Referenced by stk::test::eventflags::ClearTask< _AccessMode >::Run(), stk::test::eventflags::MultiWaiterAllTask< _AccessMode >::Run(), stk::test::eventflags::MultiWaiterAnyTask< _AccessMode >::Run(), stk::test::eventflags::SetWaitAllTask< _AccessMode >::Run(), and stk::test::eventflags::SetWaitAnyTask< _AccessMode >::Run().

◆ FLAG_C

const uint32_t FLAG_C = (1U << 2)

static

Definition at line 43 of file test_eventflags.cpp.

Referenced by stk::test::eventflags::GetTask< _AccessMode >::Run(), stk::test::eventflags::MultiWaiterAnyTask< _AccessMode >::Run(), stk::test::eventflags::SetWaitAllTask< _AccessMode >::Run(), and stk::test::eventflags::SetWaitAnyTask< _AccessMode >::Run().

◆ FLAG_D

const uint32_t FLAG_D = (1U << 3)

static

Definition at line 44 of file test_eventflags.cpp.

Referenced by stk::test::eventflags::MultiWaiterAnyTask< _AccessMode >::Run(), and stk::test::eventflags::SetWaitAnyTask< _AccessMode >::Run().

◆ STK_TEST_DECL_ASSERT

STK_TEST_DECL_ASSERT

Definition at line 21 of file test_eventflags.cpp.

Classes

Namespaces

Macros

Functions

Variables

Macro Definition Documentation

◆ _STK_EF_STACK_SIZE

◆ _STK_EF_TEST_LONG_SLEEP

◆ _STK_EF_TEST_SHORT_SLEEP

◆ _STK_EF_TEST_TASKS_MAX

◆ _STK_EF_TEST_TIMEOUT

◆ STK_TASK

Function Documentation

◆ main()

◆ NeedsExtendedTasks()

◆ operator delete()

◆ operator new()

◆ RunTest()

Variable Documentation

◆ FLAG_A

◆ FLAG_B

◆ FLAG_C

◆ FLAG_D

◆ STK_TEST_DECL_ASSERT