github-forks
/
FreeRTOS
mirror of https://github.com/FreeRTOS/FreeRTOS.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add SMP suspend scheduler on target test (#1184)

Browse Source 
* Add SMP suspend scheduler on target test

* Code review suggestion

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>

---------

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
Co-authored-by: Gaurav Aggarwal <aggarg@amazon.com>
pull/1183/head^2
chinglee-iot 1 year ago committed by GitHub
parent 5be0af160b
commit 9cb29445cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 422 additions and 0 deletions
Show Stats Download Patch File Download Diff File

33
FreeRTOS/Test/Target/boards/pico/tests/smp/suspend_scheduler/CMakeLists.txt
Unescape Escape View File

@ -0,0 +1,33 @@
cmake_minimum_required(VERSION 3.13)
project(example C CXX ASM)
set(CMAKE_C_STANDARD 11)
set(CMAKE_CXX_STANDARD 17)
set(TEST_INCLUDE_PATHS ${CMAKE_CURRENT_LIST_DIR}/../../../../../tests/smp/suspend_scheduler)
set(TEST_SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/../../../../../tests/smp/suspend_scheduler)
add_library(suspend_scheduler INTERFACE)
target_sources(suspend_scheduler INTERFACE
${BOARD_LIBRARY_DIR}/main.c
${CMAKE_CURRENT_LIST_DIR}/suspend_scheduler_test_runner.c
${TEST_SOURCE_DIR}/suspend_scheduler.c)
target_include_directories(suspend_scheduler INTERFACE
${CMAKE_CURRENT_LIST_DIR}/../../..
${TEST_INCLUDE_PATHS}
)
target_link_libraries(suspend_scheduler INTERFACE
FreeRTOS-Kernel
FreeRTOS-Kernel-Heap4
${BOARD_LINK_LIBRARIES})
add_executable(test_suspend_scheduler)
enable_board_functions(test_suspend_scheduler)
target_link_libraries(test_suspend_scheduler suspend_scheduler)
target_include_directories(test_suspend_scheduler PUBLIC
${BOARD_INCLUDE_PATHS})
target_compile_definitions(test_suspend_scheduler PRIVATE
${BOARD_DEFINES}
)

73
FreeRTOS/Test/Target/boards/pico/tests/smp/suspend_scheduler/suspend_scheduler_test_runner.c
Unescape Escape View File

@ -0,0 +1,73 @@
/*
* FreeRTOS V202212.00
* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*
*/
/**
* @file suspend_scheduler_test_runner.c
* @brief The implementation of main function to start test runner task.
*
* Procedure:
* - Initialize environment.
* - Run the test case.
*/
/* Kernel includes. */
#include "FreeRTOS.h"
#include "task.h"
/* Unit testing support functions. */
#include "unity.h"
/* Pico includes. */
#include "pico/multicore.h"
#include "pico/stdlib.h"
/*-----------------------------------------------------------*/
static void prvTestRunnerTask( void * pvParameters );
/*-----------------------------------------------------------*/
static void prvTestRunnerTask( void * pvParameters )
{
( void ) pvParameters;
/* Run test case. */
vRunSuspendSchedulerTest();
vTaskDelete( NULL );
}
/*-----------------------------------------------------------*/
void vRunTest( void )
{
xTaskCreate( prvTestRunnerTask,
"testRunner",
configMINIMAL_STACK_SIZE,
NULL,
configMAX_PRIORITIES - 1,
NULL );
}
/*-----------------------------------------------------------*/

258
FreeRTOS/Test/Target/tests/smp/suspend_scheduler/suspend_scheduler.c
Unescape Escape View File

@ -0,0 +1,258 @@
/*
* FreeRTOS V202212.00
* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*
*/
/**
* @file suspend_scheduler.c
* @brief Context switch shall not happen when the scheduler is suspended.
*
* Procedure:
* - Create 1 low priority task, T0.
* - Create n - 1 medium priority tasks, T1 ~ T(n - 1).
* - Suspend the scheduler in test runner task.
* - Increase T0's priority to high priority.
* - Verify that T0 is not running.
* - Resume the scheduler in test runner.
* - Verify that T0 is running.
* Expected:
* - T0 must not run even when its priority is raised when the scheduler is
* suspended.
*/
/* Standard includes. */
#include <stdint.h>
/* Kernel includes. */
#include "FreeRTOS.h"
#include "task.h"
/* Unit testing support functions. */
#include "unity.h"
/*-----------------------------------------------------------*/
/**
* @brief Time to wait for other cores to run.
*/
#define TEST_BUSY_LOOPING_COUNT ( 10000 )
/**
* @brief Nop operation for busy looping.
*/
#ifdef portNOP
#define TEST_NOP portNOP
#else
#define TEST_NOP() __asm volatile ( "nop" )
#endif
/*-----------------------------------------------------------*/
/**
* @brief Task function for task T0.
*/
static void prvPriorityChangeTask( void * pvParameters );
/**
* @brief Task function for tasks T1~Tn-1 to occupy cores.
*/
static void prvBusyRunningTask( void * pvParameters );
/**
* @brief Test case "Suspend Scheduler".
*/
void Test_SuspendScheduler( void );
/*-----------------------------------------------------------*/
#if ( configNUMBER_OF_CORES < 2 )
#error This test is for FreeRTOS SMP and therefore, requires at least 2 cores.
#endif /* if ( configNUMBER_OF_CORES < 2 ) */
#if ( configRUN_MULTIPLE_PRIORITIES != 1 )
#error test_config.h must be included at the end of FreeRTOSConfig.h.
#endif /* if ( configRUN_MULTIPLE_PRIORITIES != 1 ) */
#if ( configMAX_PRIORITIES <= 3 )
#error configMAX_PRIORITIES must be larger than 3 to avoid scheduling idle tasks unexpectedly.
#endif /* if ( configMAX_PRIORITIES <= 3 ) */
/*-----------------------------------------------------------*/
/**
* @brief Handles of the tasks created in this test.
*/
static TaskHandle_t xTaskHandles[ configNUMBER_OF_CORES ];
/**
* @brief A flag to indicate that the task T0 got a chance to run.
*/
static volatile BaseType_t xTaskT0IsRunning = pdFALSE;
/*-----------------------------------------------------------*/
static void prvPriorityChangeTask( void * pvParameters )
{
/* pvParameters is not used in this task. */
( void ) pvParameters;
/* Set the flag to indicate that the test task is running. */
xTaskT0IsRunning = pdTRUE;
/* Busy looping here to occupy the core. */
for( ; ; )
{
TEST_NOP();
}
}
/*-----------------------------------------------------------*/
static void prvBusyRunningTask( void * pvParameters )
{
/* pvParameters is not used in this task. */
( void ) pvParameters;
/* Busy looping here to occupy the core. */
for( ; ; )
{
TEST_NOP();
}
}
/*-----------------------------------------------------------*/
void Test_SuspendScheduler( void )
{
uint32_t i;
BaseType_t xTaskT0RunningStatus;
BaseType_t xTaskCreationResult;
/* Create ( configNUMBER_OF_CORES - 1 ) busy running tasks with medium
* priority. */
for( i = 0; i < ( configNUMBER_OF_CORES - 1 ); i++ )
{
xTaskCreationResult = xTaskCreate( prvBusyRunningTask,
"BusyRun",
configMINIMAL_STACK_SIZE,
NULL,
configMAX_PRIORITIES - 2,
&( xTaskHandles[ i ] ) );
TEST_ASSERT_EQUAL_MESSAGE( pdPASS, xTaskCreationResult, "Task creation failed." );
}
/* Create the task T0 with lower priority. */
xTaskCreationResult = xTaskCreate( prvPriorityChangeTask,
"TestTask",
configMINIMAL_STACK_SIZE,
NULL,
configMAX_PRIORITIES - 3,
&( xTaskHandles[ configNUMBER_OF_CORES - 1 ] ) );
TEST_ASSERT_EQUAL_MESSAGE( pdPASS, xTaskCreationResult, "Task creation failed." );
/* Busy loop here to wait for other cores. */
for( i = 0; i < TEST_BUSY_LOOPING_COUNT; i++ )
{
TEST_NOP();
}
/* Verify that the task T0 is not running. The TestRunner task and tasks
* T1 ~ T(n - 1) have higher priority than T0 and therefore, the scheduler
* won't select T0 to run. */
TEST_ASSERT_EQUAL( pdFALSE, xTaskT0IsRunning );
/* Raise the priority of task T0 when the scheduler is suspended. T0 now has
* higher priority than other running tasks. However, T0 should not start
* running until the scheduler is resumed. */
vTaskSuspendAll();
{
/* Raise the task T0's priority. */
vTaskPrioritySet( xTaskHandles[ configNUMBER_OF_CORES - 1 ], configMAX_PRIORITIES - 1 );
/* Busy looping here to wait for other cores. */
for( i = 0; i < TEST_BUSY_LOOPING_COUNT; i++ )
{
TEST_NOP();
}
/* Verify the status later to prevent test framework jump to tearDown function. */
xTaskT0RunningStatus = xTaskT0IsRunning;
}
( void ) xTaskResumeAll();
/* Verify that the task T0 was not scheduled when the scheduler was
* suspended. */
TEST_ASSERT_EQUAL( pdFALSE, xTaskT0RunningStatus );
/* Busy looping here to wait for other cores. */
for( i = 0; i < TEST_BUSY_LOOPING_COUNT; i++ )
{
TEST_NOP();
}
/* Verify that the task T0 is scheduled after resuming the scheduler. */
TEST_ASSERT_EQUAL( pdTRUE, xTaskT0IsRunning );
}
/*-----------------------------------------------------------*/
/* Runs before every test, put init calls here. */
void setUp( void )
{
uint32_t i;
xTaskT0IsRunning = pdFALSE;
for( i = 0; i < configNUMBER_OF_CORES; i++ )
{
xTaskHandles[ i ] = NULL;
}
}
/*-----------------------------------------------------------*/
/* Runs after every test, put clean-up calls here. */
void tearDown( void )
{
uint32_t i;
/* Delete all the tasks. */
for( i = 0; i < configNUMBER_OF_CORES; i++ )
{
if( xTaskHandles[ i ] != NULL )
{
vTaskDelete( xTaskHandles[ i ] );
xTaskHandles[ i ] = NULL;
}
}
}
/*-----------------------------------------------------------*/
/**
* @brief Entry point for test runner to run suspend scheduler test.
*/
void vRunSuspendSchedulerTest( void )
{
UNITY_BEGIN();
RUN_TEST( Test_SuspendScheduler );
UNITY_END();
}
/*-----------------------------------------------------------*/

58
FreeRTOS/Test/Target/tests/smp/suspend_scheduler/test_config.h
Unescape Escape View File

@ -0,0 +1,58 @@
/*
* FreeRTOS V202212.00
* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*
*/
#ifndef TEST_CONFIG_H
#define TEST_CONFIG_H
/* This file must be included at the end of the FreeRTOSConfig.h. It contains
* any FreeRTOS specific configurations that the test requires. */
#ifdef configRUN_MULTIPLE_PRIORITIES
#undef configRUN_MULTIPLE_PRIORITIES
#endif /* ifdef configRUN_MULTIPLE_PRIORITIES */
#ifdef configUSE_TIME_SLICING
#undef configUSE_TIME_SLICING
#endif /* ifdef configUSE_TIME_SLICING */
#ifdef configUSE_PREEMPTION
#undef configUSE_PREEMPTION
#endif /* ifdef configUSE_PREEMPTION */
#define configRUN_MULTIPLE_PRIORITIES 1
#define configUSE_TIME_SLICING 1
#define configUSE_PREEMPTION 1
/*-----------------------------------------------------------*/
/**
* @brief Entry point for test runner to run suspend scheduler test.
*/
void vRunSuspendSchedulerTest( void );
/*-----------------------------------------------------------*/
#endif /* ifndef TEST_CONFIG_H */
Write Preview
Loading…
Cancel
Save