mirror of
https://github.com/FreeRTOS/FreeRTOS-Kernel.git
synced 2025-10-14 00:37:44 -04:00
Add SMP schedule affinity on target test (#1172)
* Add SMP schedule affinity on target test --------- Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com> Co-authored-by: Gaurav Aggarwal <aggarg@amazon.com> Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
This commit is contained in:
chinglee-iot
GitHub
parent
ec0eae4c0f
commit
d9ced6e8ac
4 changed files with 400 additions and 0 deletions
|
|
@ -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/schedule_affinity)
|
||||
set(TEST_SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/../../../../../tests/smp/schedule_affinity)
|
||||
|
||||
add_library(schedule_affinity INTERFACE)
|
||||
target_sources(schedule_affinity INTERFACE
|
||||
${BOARD_LIBRARY_DIR}/main.c
|
||||
${CMAKE_CURRENT_LIST_DIR}/schedule_affinity_test_runner.c
|
||||
${TEST_SOURCE_DIR}/schedule_affinity.c)
|
||||
|
||||
target_include_directories(schedule_affinity INTERFACE
|
||||
${CMAKE_CURRENT_LIST_DIR}/../../..
|
||||
${TEST_INCLUDE_PATHS}
|
||||
)
|
||||
|
||||
target_link_libraries(schedule_affinity INTERFACE
|
||||
FreeRTOS-Kernel
|
||||
FreeRTOS-Kernel-Heap4
|
||||
${BOARD_LINK_LIBRARIES})
|
||||
|
||||
add_executable(test_schedule_affinity)
|
||||
enable_board_functions(test_schedule_affinity)
|
||||
target_link_libraries(test_schedule_affinity schedule_affinity)
|
||||
target_include_directories(test_schedule_affinity PUBLIC
|
||||
${BOARD_INCLUDE_PATHS})
|
||||
target_compile_definitions(test_schedule_affinity PRIVATE
|
||||
${BOARD_DEFINES}
|
||||
)
|
||||
|
|
@ -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 schedule_affinity_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. */
|
||||
vRunScheduleAffinityTest();
|
||||
|
||||
vTaskDelete( NULL );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
void vRunTest( void )
|
||||
{
|
||||
xTaskCreate( prvTestRunnerTask,
|
||||
"testRunner",
|
||||
configMINIMAL_STACK_SIZE,
|
||||
NULL,
|
||||
configMAX_PRIORITIES - 1,
|
||||
NULL );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
|
@ -0,0 +1,231 @@
|
|||
/*
|
||||
* 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 schedule_affinity.c
|
||||
* @brief The scheduler shall not schedule a task that is pinned to a specific core on any other core.
|
||||
*
|
||||
* Procedure:
|
||||
* - Create 2 * ( num of cores ) tasks ( T0, ..., Tn-1, Tn, ..., T2n-1 ).
|
||||
* - Pin T0 to core 0, T1 to core 1, and so on.
|
||||
* - Pin Tn to core 0, Tn+1 to core 1, and so on. Note that this way Tx and
|
||||
* Tn+x are pinned to the same core.
|
||||
* - Verify the following conditions:
|
||||
* - Tx+n is not running when Tx is running.
|
||||
* - Tx is not running when Tx+n is running.
|
||||
* - Both Tx and Tx+n can only run on core x.
|
||||
* Expected:
|
||||
* - All tasks will only run on the cores that they were pinned to.
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* Kernel includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* Unit testing support functions. */
|
||||
#include "unity.h"
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief Timeout value to stop test.
|
||||
*/
|
||||
#define TEST_TIMEOUT_MS ( 1000 )
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
#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 ( configMAX_PRIORITIES <= ( configNUMBER_OF_CORES + 2 ) )
|
||||
#error configMAX_PRIORITIES must be larger than ( configNUMBER_OF_CORES + 2 ) to avoid scheduling idle tasks unexpectedly.
|
||||
#endif /* if ( configMAX_PRIORITIES <= ( configNUMBER_OF_CORES + 2 ) ) */
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief Test case "Schedule Affinity".
|
||||
*/
|
||||
void Test_ScheduleAffinity( void );
|
||||
|
||||
/**
|
||||
* @brief The task function that verifies that tasks are pinned to correct core.
|
||||
*/
|
||||
static void prvTaskCheckPinCore( void * pvParameters );
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief Handles of the tasks created in this test.
|
||||
*/
|
||||
static TaskHandle_t xTaskHandles[ configNUMBER_OF_CORES * 2 ];
|
||||
|
||||
/**
|
||||
* @brief Indexes of the tasks created in this test.
|
||||
*/
|
||||
static uint32_t xTaskIndexes[ configNUMBER_OF_CORES * 2 ];
|
||||
|
||||
/**
|
||||
* @brief Test results for tasks T0~T2n-1.
|
||||
*/
|
||||
static BaseType_t xTestResults[ configNUMBER_OF_CORES * 2 ] = { pdFAIL };
|
||||
|
||||
/**
|
||||
* @brief Flag to indicate that all tasks in this test are created.
|
||||
*/
|
||||
static volatile BaseType_t xAllTasksCreated = pdFALSE;
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
static void prvTaskCheckPinCore( void * pvParameters )
|
||||
{
|
||||
uint32_t currentTaskIdx = *( ( uint32_t * ) pvParameters );
|
||||
uint32_t pinToSameCoreTaskIdx;
|
||||
eTaskState taskState;
|
||||
BaseType_t testResult = pdPASS;
|
||||
BaseType_t xCore;
|
||||
|
||||
/* Busy looping here to wait for test runner to create all the test tasks.
|
||||
* Test runner has timeout to prevent infinite blocking here. */
|
||||
while( xAllTasksCreated == pdFALSE )
|
||||
{
|
||||
}
|
||||
|
||||
/* Find out the task index which is pinned to the same core. */
|
||||
if( currentTaskIdx >= configNUMBER_OF_CORES )
|
||||
{
|
||||
pinToSameCoreTaskIdx = currentTaskIdx - configNUMBER_OF_CORES;
|
||||
xCore = pinToSameCoreTaskIdx;
|
||||
}
|
||||
else
|
||||
{
|
||||
pinToSameCoreTaskIdx = currentTaskIdx + configNUMBER_OF_CORES;
|
||||
xCore = currentTaskIdx;
|
||||
}
|
||||
|
||||
/* Verify that the task is running on the core it is pinned to. */
|
||||
taskState = eTaskGetState( xTaskHandles[ currentTaskIdx ] );
|
||||
|
||||
if( taskState != eRunning )
|
||||
{
|
||||
testResult = pdFAIL;
|
||||
}
|
||||
|
||||
if( xCore != portGET_CORE_ID() )
|
||||
{
|
||||
testResult = pdFAIL;
|
||||
}
|
||||
|
||||
/* Verify that the other task pinned to the same core is not running. */
|
||||
taskState = eTaskGetState( xTaskHandles[ pinToSameCoreTaskIdx ] );
|
||||
|
||||
if( taskState == eRunning )
|
||||
{
|
||||
testResult = pdFAIL;
|
||||
}
|
||||
|
||||
xTestResults[ currentTaskIdx ] = testResult;
|
||||
|
||||
/* Suspend the test task. */
|
||||
vTaskSuspend( NULL );
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
void Test_ScheduleAffinity( void )
|
||||
{
|
||||
uint32_t i;
|
||||
BaseType_t xTaskCreationResult;
|
||||
|
||||
/* Create ( configNUMBER_OF_CORES * 2 ) low priority tasks. */
|
||||
for( i = 0; i < ( configNUMBER_OF_CORES * 2 ); i++ )
|
||||
{
|
||||
xTaskCreationResult = xTaskCreateAffinitySet( prvTaskCheckPinCore,
|
||||
"CheckPinCore",
|
||||
configMINIMAL_STACK_SIZE,
|
||||
&( xTaskIndexes[ i ] ),
|
||||
configMAX_PRIORITIES - 2 - ( i % configNUMBER_OF_CORES ),
|
||||
( 1U << ( i % configNUMBER_OF_CORES ) ),
|
||||
&( xTaskHandles[ i ] ) );
|
||||
|
||||
TEST_ASSERT_EQUAL_MESSAGE( pdPASS, xTaskCreationResult, "Task creation failed." );
|
||||
}
|
||||
|
||||
/* Wait for test tasks finish test. */
|
||||
xAllTasksCreated = pdTRUE;
|
||||
vTaskDelay( pdMS_TO_TICKS( TEST_TIMEOUT_MS ) );
|
||||
|
||||
/* Verify the test result. */
|
||||
for( i = 0; i < ( configNUMBER_OF_CORES * 2 ); i++ )
|
||||
{
|
||||
TEST_ASSERT_TRUE( xTestResults[ i ] == pdPASS );
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/* Runs before every test, put init calls here. */
|
||||
void setUp( void )
|
||||
{
|
||||
uint32_t i;
|
||||
|
||||
xAllTasksCreated = pdFALSE;
|
||||
|
||||
for( i = 0; i < ( configNUMBER_OF_CORES * 2 ); i++ )
|
||||
{
|
||||
xTaskIndexes[ i ] = i;
|
||||
xTaskHandles[ i ] = NULL;
|
||||
xTestResults[ i ] = pdFAIL;
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/* Runs after every test, put clean-up calls here. */
|
||||
void tearDown( void )
|
||||
{
|
||||
uint32_t i;
|
||||
|
||||
/* Delete all the tasks created in the test. */
|
||||
for( i = 0; i < ( configNUMBER_OF_CORES * 2 ); i++ )
|
||||
{
|
||||
if( xTaskHandles[ i ] != NULL )
|
||||
{
|
||||
vTaskDelete( xTaskHandles[ i ] );
|
||||
xTaskHandles[ i ] = NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief Entry point for test runner to run schedule affinity test.
|
||||
*/
|
||||
void vRunScheduleAffinityTest( void )
|
||||
{
|
||||
UNITY_BEGIN();
|
||||
|
||||
RUN_TEST( Test_ScheduleAffinity );
|
||||
|
||||
UNITY_END();
|
||||
}
|
||||
/*-----------------------------------------------------------*/
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
/*
|
||||
* 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_CORE_AFFINITY
|
||||
#undef configUSE_CORE_AFFINITY
|
||||
#endif /* ifdef configUSE_CORE_AFFINITY */
|
||||
|
||||
#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_CORE_AFFINITY 1
|
||||
#define configUSE_TIME_SLICING 1
|
||||
#define configUSE_PREEMPTION 1
|
||||
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
/**
|
||||
* @brief Entry point for test runner to run schedule affinity test.
|
||||
*/
|
||||
void vRunScheduleAffinityTest( void );
|
||||
|
||||
/*-----------------------------------------------------------*/
|
||||
|
||||
#endif /* ifndef TEST_CONFIG_H */
|
||||
Loading…
Add table
Add a link
Reference in a new issue