Skip to content

Commit b4dd327

Browse files
freshgodfreshgod
committed
Add CMock+Unity unit tests for FreeRTOS-Kernel PR #1418
Add a new SMP test suite scheduler_core_mask covering the vTaskSetSchedulerCoreMask() and uxTaskGetSchedulerCoreMask() APIs introduced by FreeRTOS/FreeRTOS-Kernel#1418. Also add taskTASK_SCHEDULED_TO_YIELD alias to global_vars.h so that test files can reference the same macro name used in tasks.c.
1 parent b72aef2 commit b4dd327

6 files changed

Lines changed: 978 additions & 0 deletions

File tree

‎FreeRTOS/Test/CMock/smp/Makefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ SUITES += multiple_priorities_no_timeslice_mock
1616
# SUITS for configASSERT
1717
SUITES += config_assert
1818

19+
# SUITE for configUSE_SCHEDULER_CORE_MASK
20+
SUITES += scheduler_core_mask
21+
1922
# PROJECT and SUITE variables are determined based on path like so:
2023
# $(UT_ROOT_DIR)/$(PROJECT)/$(SUITE)
2124
PROJECT := $(lastword $(subst /, ,$(dir $(abspath $(MAKEFILE_ABSPATH)))))

‎FreeRTOS/Test/CMock/smp/global_vars.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252

5353
/* Indicates that the task is actively running but scheduled to yield. */
5454
#define taskTASK_YIELDING ( TaskRunning_t ) ( -2 )
55+
#define taskTASK_SCHEDULED_TO_YIELD taskTASK_YIELDING
5556

5657
#if ( configUSE_16_BIT_TICKS == 1 )
5758
#define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U

‎FreeRTOS/Test/CMock/smp/scheduler_core_mask/FreeRTOSConfig.h‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
/*
2+
* FreeRTOS V202212.00
3+
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4+
*
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
* this software and associated documentation files (the "Software"), to deal in
7+
* the Software without restriction, including without limitation the rights to
8+
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
* the Software, and to permit persons to whom the Software is furnished to do so,
10+
* subject to the following conditions:
11+
*
12+
* The above copyright notice and this permission notice shall be included in all
13+
* copies or substantial portions of the Software.
14+
*
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
*
22+
* https://www.FreeRTOS.org
23+
* https://github.com/FreeRTOS
24+
*
25+
*/
26+
27+
28+
#ifndef FREERTOS_CONFIG_H
29+
#define FREERTOS_CONFIG_H
30+
31+
#include "fake_assert.h"
32+
33+
/*-----------------------------------------------------------
34+
* Application specific definitions.
35+
*
36+
* These definitions should be adjusted for your particular hardware and
37+
* application requirements.
38+
*
39+
* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
40+
* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE. See
41+
* https://www.FreeRTOS.org/a00110.html
42+
*----------------------------------------------------------*/
43+
44+
/* SMP test specific configuration */
45+
#define configRUN_MULTIPLE_PRIORITIES 1
46+
#define configNUMBER_OF_CORES 2
47+
#define configUSE_CORE_AFFINITY 1
48+
#define configUSE_TIME_SLICING 0
49+
#define configUSE_TASK_PREEMPTION_DISABLE 0
50+
#define configUSE_SCHEDULER_CORE_MASK 1
51+
#define configTICK_CORE 0
52+
53+
/* OS Configuration */
54+
#define configUSE_PREEMPTION 1
55+
#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
56+
#define configUSE_IDLE_HOOK 0
57+
#define configUSE_TICK_HOOK 0
58+
#define configUSE_DAEMON_TASK_STARTUP_HOOK 1
59+
#define configTICK_RATE_HZ ( 1000 )
60+
#define configMINIMAL_STACK_SIZE ( ( unsigned short ) 70 )
61+
#define configTOTAL_HEAP_SIZE ( ( size_t ) ( 52 * 1024 ) )
62+
#define configMAX_TASK_NAME_LEN ( 12 )
63+
#define configUSE_TRACE_FACILITY 1
64+
#define configUSE_16_BIT_TICKS 0
65+
#define configIDLE_SHOULD_YIELD 1
66+
#define configUSE_MUTEXES 1
67+
#define configCHECK_FOR_STACK_OVERFLOW 0
68+
#define configUSE_RECURSIVE_MUTEXES 1
69+
#define configQUEUE_REGISTRY_SIZE 20
70+
#define configUSE_MALLOC_FAILED_HOOK 1
71+
#define configUSE_APPLICATION_TASK_TAG 1
72+
#define configUSE_COUNTING_SEMAPHORES 1
73+
#define configUSE_ALTERNATIVE_API 0
74+
#define configUSE_QUEUE_SETS 1
75+
#define configUSE_TASK_NOTIFICATIONS 1
76+
#define configTASK_NOTIFICATION_ARRAY_ENTRIES 5
77+
#define configSUPPORT_STATIC_ALLOCATION 1
78+
#define configSUPPORT_DYNAMIC_ALLOCATION 1
79+
#define configINITIAL_TICK_COUNT ( ( TickType_t ) 0 )
80+
#define configSTREAM_BUFFER_TRIGGER_LEVEL_TEST_MARGIN 1
81+
#define portREMOVE_STATIC_QUALIFIER 1
82+
#define portCRITICAL_NESTING_IN_TCB 1
83+
#define portSTACK_GROWTH ( 1 )
84+
#define configUSE_MINIMAL_IDLE_HOOK 0 /* Keep this for backward compatibility. */
85+
#define configUSE_PASSIVE_IDLE_HOOK 0
86+
87+
#define configNUM_THREAD_LOCAL_STORAGE_POINTERS 4
88+
89+
/* Software timer related configuration options. */
90+
#define configUSE_TIMERS 1
91+
#define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
92+
#define configTIMER_QUEUE_LENGTH 20
93+
#define configTIMER_TASK_STACK_DEPTH ( configMINIMAL_STACK_SIZE * 2 )
94+
95+
#define configMAX_PRIORITIES ( 7 )
96+
97+
/* Run time stats gathering configuration options. */
98+
unsigned long ulGetRunTimeCounterValue( void ); /* Prototype of function that returns run time counter. */
99+
void vConfigureTimerForRunTimeStats( void ); /* Prototype of function that initialises the run time counter. */
100+
#define configGENERATE_RUN_TIME_STATS 0
101+
#define portGET_RUN_TIME_COUNTER_VALUE() ulGetRunTimeCounterValue()
102+
#define portUSING_MPU_WRAPPERS 0
103+
#define portHAS_STACK_OVERFLOW_CHECKING 0
104+
#define configENABLE_MPU 0
105+
106+
/* Co-routine related configuration options. */
107+
#define configUSE_CO_ROUTINES 0
108+
#define configMAX_CO_ROUTINE_PRIORITIES ( 2 )
109+
110+
/* This demo makes use of one or more example stats formatting functions. These
111+
* format the raw data provided by the uxTaskGetSystemState() function in to human
112+
* readable ASCII form. See the notes in the implementation of vTaskList() within
113+
* FreeRTOS/Source/tasks.c for limitations. */
114+
#define configUSE_STATS_FORMATTING_FUNCTIONS 1
115+
116+
/* Set the following definitions to 1 to include the API function, or zero
117+
* to exclude the API function. In most cases the linker will remove unused
118+
* functions anyway. */
119+
#define INCLUDE_vTaskPrioritySet 1
120+
#define INCLUDE_uxTaskPriorityGet 1
121+
#define INCLUDE_vTaskDelete 1
122+
#define INCLUDE_vTaskCleanUpResources 0
123+
#define INCLUDE_vTaskSuspend 1
124+
#define INCLUDE_vTaskDelayUntil 1
125+
#define INCLUDE_vTaskDelay 1
126+
#define INCLUDE_uxTaskGetStackHighWaterMark 1
127+
#define INCLUDE_xTaskGetSchedulerState 1
128+
#define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
129+
#define INCLUDE_xTaskGetIdleTaskHandle 1
130+
#define INCLUDE_xTaskGetCurrentTaskHandle 1
131+
#define INCLUDE_xTaskGetHandle 1
132+
#define INCLUDE_eTaskGetState 1
133+
#define INCLUDE_xSemaphoreGetMutexHolder 1
134+
#define INCLUDE_xTimerPendFunctionCall 1
135+
#define INCLUDE_xTaskAbortDelay 1
136+
#define INCLUDE_xTaskGetCurrentTaskHandle 1
137+
138+
/* It is a good idea to define configASSERT() while developing. configASSERT()
139+
* uses the same semantics as the standard C assert() macro. */
140+
#define configASSERT( x ) \
141+
do \
142+
{ \
143+
if( x ) \
144+
{ \
145+
vFakeAssert( true, __FILE__, __LINE__ ); \
146+
} \
147+
else \
148+
{ \
149+
vFakeAssert( false, __FILE__, __LINE__ ); \
150+
} \
151+
} while( 0 )
152+
153+
#define configINCLUDE_MESSAGE_BUFFER_AMP_DEMO 0
154+
#if ( configINCLUDE_MESSAGE_BUFFER_AMP_DEMO == 1 )
155+
extern void vGenerateCoreBInterrupt( void * xUpdatedMessageBuffer );
156+
#define sbSEND_COMPLETED( pxStreamBuffer ) vGenerateCoreBInterrupt( pxStreamBuffer )
157+
#endif /* configINCLUDE_MESSAGE_BUFFER_AMP_DEMO */
158+
159+
#endif /* FREERTOS_CONFIG_H */

‎FreeRTOS/Test/CMock/smp/scheduler_core_mask/Makefile‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# indent with spaces
2+
.RECIPEPREFIX := $(.RECIPEPREFIX) $(.RECIPEPREFIX)
3+
4+
# Do not move this line below the include
5+
MAKEFILE_ABSPATH := $(abspath $(lastword $(MAKEFILE_LIST)))
6+
include ../../makefile.in
7+
8+
# PROJECT_SRC lists the .c files under test
9+
PROJECT_SRC := tasks.c
10+
11+
# PROJECT_DEPS_SRC lists the .c files that are dependencies of PROJECT_SRC files
12+
# Files in PROJECT_DEPS_SRC are excluded from coverage measurements
13+
PROJECT_DEPS_SRC := list.c queue.c
14+
15+
# PROJECT_HEADER_DEPS: headers that should be excluded from coverage measurements.
16+
PROJECT_HEADER_DEPS := FreeRTOS.h
17+
18+
# SUITE_UT_SRC: .c files that contain test cases (must end in _utest.c)
19+
# Functional file listed first, coverage file second.
20+
SUITE_UT_SRC := scheduler_core_mask_utest.c covg_scheduler_core_mask_utest.c
21+
22+
# SUITE_SUPPORT_SRC: .c files used for testing that do not contain test cases.
23+
# Paths are relative to PROJECT_DIR
24+
SUITE_SUPPORT_SRC := smp_utest_common.c
25+
26+
# List the headers used by PROJECT_SRC that you would like to mock
27+
MOCK_FILES_FP += $(KERNEL_DIR)/include/timers.h
28+
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_assert.h
29+
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_port.h
30+
31+
# List any additional flags needed by the preprocessor
32+
CPPFLAGS +=
33+
34+
# List any additional flags needed by the compiler
35+
CFLAGS +=
36+
37+
# Try not to edit beyond this line unless necessary.
38+
39+
# Project is determined based on path: $(UT_ROOT_DIR)/$(PROJECT)
40+
PROJECT := $(lastword $(subst /, ,$(dir $(abspath $(MAKEFILE_ABSPATH)/../))))
41+
SUITE := $(lastword $(subst /, ,$(dir $(MAKEFILE_ABSPATH))))
42+
43+
# Make variables available to included makefile
44+
export
45+
46+
include ../../testdir.mk

0 commit comments

Comments
 (0)