test_timerhost.cpp File Reference

#include <stk_config.h>
#include <stk.h>
#include <time/stk_time_timer.h>
#include <assert.h>
#include <string.h>
#include "stktest_context.h"

Include dependency graph for test_timerhost.cpp:

Go to the source code of this file.

Classes
class	stk::test::timer::TestTimer
	Concrete timer implementation that increments g_ExpiredCount on each expiry. More...
class	stk::test::timer::OneShotTimerTask< _AccessMode >
	Tests that a one-shot timer fires exactly once at the expected time. More...
class	stk::test::timer::PeriodicTimerTask< _AccessMode >
	Tests that a periodic timer fires repeatedly at regular intervals. More...
class	stk::test::timer::MultipleTimersTask< _AccessMode >
	Tests that multiple concurrent timers with different periods fire independently. More...
class	stk::test::timer::StopTimerTask< _AccessMode >
	Tests that Stop() cancels a pending timer before it fires. More...
class	stk::test::timer::ResetPeriodicTimerTask< _AccessMode >
	Tests that Reset() reanchors a periodic timer's deadline from now. More...
class	stk::test::timer::RestartTimerTask< _AccessMode >
	Tests that Restart() atomically stops and re-starts a timer. More...
class	stk::test::timer::StartOrResetTask< _AccessMode >
	Tests StartOrReset(): starts if inactive, resets if active+periodic. More...
class	stk::test::timer::SetPeriodTask< _AccessMode >
	Tests SetPeriod(): changes reload period without affecting current deadline. More...
class	stk::test::timer::StressTestTask< _AccessMode >
	Stress test of TimerHost under full five-task contention. More...

Namespaces
namespace	stk
	Namespace of STK package.
namespace	stk::test
	Namespace of the test inventory.
namespace	stk::test::timer
	Namespace of TimerHost test.

Macros
#define	_STK_TIMER_TEST_TIMEOUT   1000
#define	_STK_TIMER_TEST_SHORT_SLEEP   10
#define	_STK_TIMER_TEST_LONG_SLEEP   100
#define	_STK_TIMER_STACK_SIZE   256
#define	_STK_TIMER_TEST_TASKS_MAX   5
#define	STK_TASK   static

Functions
static void	stk::test::timer::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::timer::g_TestResult = 0
static volatile int32_t	stk::test::timer::g_SharedCounter = 0
static volatile int32_t	stk::test::timer::g_ExpiredCount = 0
static sync::Event	stk::test::timer::g_LastExpired [5]
static volatile int64_t	stk::test::timer::g_ExpiredTime [5] = {0}
static Kernel< KERNEL_DYNAMIC|KERNEL_SYNC, 5+stk::time::TimerHost::TASK_COUNT, SwitchStrategyRR, PlatformDefault >	stk::test::timer::g_Kernel
static time::TimerHost	stk::test::timer::g_TimerHost

Macro Definition Documentation

_STK_TIMER_STACK_SIZE

#define _STK_TIMER_STACK_SIZE   256

Definition at line 26 of file test_timerhost.cpp.

_STK_TIMER_TEST_LONG_SLEEP

#define _STK_TIMER_TEST_LONG_SLEEP   100

Definition at line 25 of file test_timerhost.cpp.

Referenced by stk::test::timer::OneShotTimerTask< _AccessMode >::Run(), stk::test::timer::RestartTimerTask< _AccessMode >::Run(), and stk::test::timer::StopTimerTask< _AccessMode >::Run().

_STK_TIMER_TEST_SHORT_SLEEP

#define _STK_TIMER_TEST_SHORT_SLEEP   10

Definition at line 24 of file test_timerhost.cpp.

Referenced by stk::test::timer::OneShotTimerTask< _AccessMode >::Run(), stk::test::timer::ResetPeriodicTimerTask< _AccessMode >::Run(), stk::test::timer::RestartTimerTask< _AccessMode >::Run(), stk::test::timer::SetPeriodTask< _AccessMode >::Run(), stk::test::timer::StartOrResetTask< _AccessMode >::Run(), and stk::test::timer::StressTestTask< _AccessMode >::Run().

_STK_TIMER_TEST_TASKS_MAX

#define _STK_TIMER_TEST_TASKS_MAX   5

Definition at line 31 of file test_timerhost.cpp.

Referenced by stk::test::timer::ResetTestState(), and stk::test::timer::StressTestTask< _AccessMode >::Run().

_STK_TIMER_TEST_TIMEOUT

#define _STK_TIMER_TEST_TIMEOUT   1000

Definition at line 23 of file test_timerhost.cpp.

STK_TASK

#define STK_TASK   static

Definition at line 32 of file test_timerhost.cpp.

Function Documentation

main()

int main	(	int	argc,
		char **	argv )

Definition at line 738 of file test_timerhost.cpp.

{
    (void)argc;
    (void)argv;
 
    using namespace stk::test::timer;
 
    TestContext::ShowTestSuitePrologue();
 
    int total_failures = 0, total_success = 0;
 
    printf("--------------\n");
 
    g_Kernel.Initialize();
 
#ifndef __ARM_ARCH_6M__
 
    // Test 1: One-shot timer fires exactly once at expected time
    if (RunTest<OneShotTimerTask<ACCESS_PRIVILEGED>>("OneShotTimer") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 2: Periodic timer fires repeatedly at regular intervals
    if (RunTest<PeriodicTimerTask<ACCESS_PRIVILEGED>>("PeriodicTimer") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 3: Multiple concurrent timers with different periods fire independently
    if (RunTest<MultipleTimersTask<ACCESS_PRIVILEGED>>("MultipleTimers") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 4: Stop() cancels pending timer before it fires
    if (RunTest<StopTimerTask<ACCESS_PRIVILEGED>>("StopTimer") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 5: Reset() reanchors periodic timer's deadline from now
    if (RunTest<ResetPeriodicTimerTask<ACCESS_PRIVILEGED>>("ResetPeriodicTimer") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 6: Restart() atomically stops and re-starts timer
    if (RunTest<RestartTimerTask<ACCESS_PRIVILEGED>>("RestartTimer") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 7: StartOrReset() starts if inactive, resets if active+periodic
    if (RunTest<StartOrResetTask<ACCESS_PRIVILEGED>>("StartOrReset") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    // Test 8: SetPeriod() changes reload period without affecting current deadline
    if (RunTest<SetPeriodTask<ACCESS_PRIVILEGED>>("SetPeriod") != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
#endif // __ARM_ARCH_6M__
 
    // Test 9: Stress test under full five-task contention with varying timer delays
    if (RunTest<StressTestTask<ACCESS_PRIVILEGED>>("StressTest", 20) != TestContext::SUCCESS_EXIT_CODE)
        total_failures++;
    else
        total_success++;
 
    g_TimerHost.Shutdown();
 
    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::timer::g_Kernel, stk::test::timer::g_TimerHost, 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 683 of file test_timerhost.cpp.

{
    return (strcmp(test_name, "StressTest") == 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 692 of file test_timerhost.cpp.

{
    using namespace stk;
    using namespace stk::test;
    using namespace stk::test::timer;
 
    printf("Test: %s\n", test_name);
 
    ResetTestState();
 
    g_TimerHost.Initialize(&g_Kernel, stk::ACCESS_PRIVILEGED);
 
    // Create tasks based on test type
    STK_TASK TaskType task0(0, param);
    STK_TASK TaskType task1(1, param);
#if (_STK_TIMER_TEST_TASKS_MAX > 2)
    TaskType task2(2, param);
    TaskType task3(3, param);
    TaskType task4(4, param);
#endif
 
    g_Kernel.AddTask(&task0);
    g_Kernel.AddTask(&task1);
 
#if (_STK_TIMER_TEST_TASKS_MAX > 2)
    if (NeedsExtendedTasks(test_name))
    {
        g_Kernel.AddTask(&task2);
        g_Kernel.AddTask(&task3);
        g_Kernel.AddTask(&task4);
    }
#endif
 
    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::ACCESS_PRIVILEGED, stk::test::TestContext::DEFAULT_FAILURE_EXIT_CODE, stk::test::timer::g_Kernel, stk::test::timer::g_TestResult, stk::test::timer::g_TimerHost, NeedsExtendedTasks(), stk::test::timer::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_timerhost.cpp.