Add unit tests for stream buffer callback overrides (#832)

* Add tests for streambuffer callback

* Add concurrent readers writers test

* Update manifest
This commit is contained in:
Ravishankar Bhagavandas 2022-07-29 13:16:52 -07:00 committed by GitHub
parent 8e881fe73c
commit 9058c39aed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 1365 additions and 55 deletions

@ -1 +1 @@
Subproject commit 356fff8028734dc50a46972b2e315e2871b0a12e Subproject commit 349e80331460c1a1f844be4eac1bf3175049f025

View file

@ -107,6 +107,7 @@ void vConfigureTimerForRunTimeStats( void ); /* Prototype of function that in
#define INCLUDE_xTaskGetSchedulerState 1 #define INCLUDE_xTaskGetSchedulerState 1
#define INCLUDE_xTimerGetTimerDaemonTaskHandle 1 #define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
#define INCLUDE_xTaskGetIdleTaskHandle 1 #define INCLUDE_xTaskGetIdleTaskHandle 1
#define INCLUDE_xTaskGetCurrentTaskHandle 1
#define INCLUDE_xTaskGetHandle 1 #define INCLUDE_xTaskGetHandle 1
#define INCLUDE_eTaskGetState 1 #define INCLUDE_eTaskGetState 1
#define INCLUDE_xSemaphoreGetMutexHolder 1 #define INCLUDE_xSemaphoreGetMutexHolder 1

View file

@ -109,6 +109,7 @@ void vConfigureTimerForRunTimeStats( void ); /* Prototype of function that in
#define INCLUDE_xTaskGetSchedulerState 1 #define INCLUDE_xTaskGetSchedulerState 1
#define INCLUDE_xTimerGetTimerDaemonTaskHandle 1 #define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
#define INCLUDE_xTaskGetIdleTaskHandle 1 #define INCLUDE_xTaskGetIdleTaskHandle 1
#define INCLUDE_xTaskGetCurrentTaskHandle 1
#define INCLUDE_xTaskGetHandle 1 #define INCLUDE_xTaskGetHandle 1
#define INCLUDE_eTaskGetState 1 #define INCLUDE_eTaskGetState 1
#define INCLUDE_xSemaphoreGetMutexHolder 1 #define INCLUDE_xSemaphoreGetMutexHolder 1

View file

@ -1,43 +1,15 @@
# indent with spaces # Indent with spaces
.RECIPEPREFIX := $(.RECIPEPREFIX) $(.RECIPEPREFIX) .RECIPEPREFIX := $(.RECIPEPREFIX) $(.RECIPEPREFIX)
# Do not move this line below the include # Do not move this line below the include
MAKEFILE_ABSPATH := $(abspath $(lastword $(MAKEFILE_LIST))) MAKEFILE_ABSPATH := $(abspath $(lastword $(MAKEFILE_LIST)))
include ../makefile.in include ../makefile.in
# PROJECT_SRC lists the .c files under test # SUITES lists the suites contained in subdirectories of this directory
PROJECT_SRC := stream_buffer.c SUITES += api
SUITES += callback
# PROJECT_DEPS_SRC list the .c file that are dependencies of PROJECT_SRC files # PROJECT and SUITE variables are determined based on path like so:
# Files in PROJECT_DEPS_SRC are excluded from coverage measurements # $(UT_ROOT_DIR)/$(PROJECT)/$(SUITE)
PROJECT_DEPS_SRC := PROJECT := $(lastword $(subst /, ,$(dir $(abspath $(MAKEFILE_ABSPATH)))))
# PROJECT_HEADER_DEPS: headers that should be excluded from coverage measurements. include ../subdir.mk
PROJECT_HEADER_DEPS := FreeRTOS.h
# SUITE_UT_SRC: .c files that contain test cases (must end in _utest.c)
SUITE_UT_SRC := stream_buffer_utest.c
# SUITE_SUPPORT_SRC: .c files used for testing that do not contain test cases.
# Paths are relative to PROJECT_DIR
SUITE_SUPPORT_SRC :=
# List the headers used by PROJECT_SRC that you would like to mock
MOCK_FILES_FP := $(KERNEL_DIR)/include/task.h
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_assert.h
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_port.h
# List any addiitonal flags needed by the preprocessor
CPPFLAGS += -DportUSING_MPU_WRAPPERS=0
# List any addiitonal flags needed by the compiler
CFLAGS +=
# Try not to edit beyond this line unless necessary.
# Project is determined based on path: $(UT_ROOT_DIR)/$(PROJECT)
PROJECT := $(lastword $(subst /, ,$(dir $(abspath $(MAKEFILE_ABSPATH)))))
export
include ../testdir.mk

View file

@ -0,0 +1,139 @@
/*
* FreeRTOS V202112.00
* Copyright (C) 2020 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 FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H
#include "fake_assert.h"
/*-----------------------------------------------------------
* Application specific definitions.
*
* These definitions should be adjusted for your particular hardware and
* application requirements.
*
* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE. See
* http://www.freertos.org/a00110.html
*----------------------------------------------------------*/
#define configUSE_PREEMPTION 1
#define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
#define configUSE_IDLE_HOOK 1
#define configUSE_TICK_HOOK 1
#define configUSE_DAEMON_TASK_STARTUP_HOOK 1
#define configTICK_RATE_HZ ( 1000 ) /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */
#define configMINIMAL_STACK_SIZE ( ( unsigned short ) 70 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the win32 thread. */
#define configTOTAL_HEAP_SIZE ( ( size_t ) ( 52 * 1024 ) )
#define configMAX_TASK_NAME_LEN ( 12 )
#define configUSE_TRACE_FACILITY 1
#define configUSE_16_BIT_TICKS 0
#define configIDLE_SHOULD_YIELD 1
#define configUSE_MUTEXES 1
#define configCHECK_FOR_STACK_OVERFLOW 0
#define configUSE_RECURSIVE_MUTEXES 1
#define configQUEUE_REGISTRY_SIZE 20
#define configUSE_MALLOC_FAILED_HOOK 1
#define configUSE_APPLICATION_TASK_TAG 1
#define configUSE_COUNTING_SEMAPHORES 1
#define configUSE_ALTERNATIVE_API 0
#define configUSE_QUEUE_SETS 1
#define configUSE_TASK_NOTIFICATIONS 1
#define configTASK_NOTIFICATION_ARRAY_ENTRIES 5
#define configSUPPORT_STATIC_ALLOCATION 1
#define configINITIAL_TICK_COUNT ( ( TickType_t ) 0 ) /* For test. */
#define configSTREAM_BUFFER_TRIGGER_LEVEL_TEST_MARGIN 1 /* As there are a lot of tasks running. */
/* Software timer related configuration options. */
#define configUSE_TIMERS 1
#define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
#define configTIMER_QUEUE_LENGTH 20
#define configTIMER_TASK_STACK_DEPTH ( configMINIMAL_STACK_SIZE * 2 )
#define configMAX_PRIORITIES ( 7 )
/* Run time stats gathering configuration options. */
unsigned long ulGetRunTimeCounterValue( void ); /* Prototype of function that returns run time counter. */
void vConfigureTimerForRunTimeStats( void ); /* Prototype of function that initialises the run time counter. */
#define configGENERATE_RUN_TIME_STATS 1
#define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() vConfigureTimerForRunTimeStats()
#define portGET_RUN_TIME_COUNTER_VALUE() ulGetRunTimeCounterValue()
/* Co-routine related configuration options. */
#define configUSE_CO_ROUTINES 0
#define configMAX_CO_ROUTINE_PRIORITIES ( 2 )
/* This demo makes use of one or more example stats formatting functions. These
* format the raw data provided by the uxTaskGetSystemState() function in to human
* readable ASCII form. See the notes in the implementation of vTaskList() within
* FreeRTOS/Source/tasks.c for limitations. */
#define configUSE_STATS_FORMATTING_FUNCTIONS 1
/* Set the following definitions to 1 to include the API function, or zero
* to exclude the API function. In most cases the linker will remove unused
* functions anyway. */
#define INCLUDE_vTaskPrioritySet 1
#define INCLUDE_uxTaskPriorityGet 1
#define INCLUDE_vTaskDelete 1
#define INCLUDE_vTaskCleanUpResources 0
#define INCLUDE_vTaskSuspend 1
#define INCLUDE_vTaskDelayUntil 1
#define INCLUDE_vTaskDelay 1
#define INCLUDE_uxTaskGetStackHighWaterMark 1
#define INCLUDE_xTaskGetSchedulerState 1
#define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
#define INCLUDE_xTaskGetIdleTaskHandle 1
#define INCLUDE_xTaskGetCurrentTaskHandle 1
#define INCLUDE_xTaskGetHandle 1
#define INCLUDE_eTaskGetState 1
#define INCLUDE_xSemaphoreGetMutexHolder 1
#define INCLUDE_xTimerPendFunctionCall 1
#define INCLUDE_xTaskAbortDelay 1
/* It is a good idea to define configASSERT() while developing. configASSERT()
* uses the same semantics as the standard C assert() macro. */
#define configASSERT( x ) \
do \
{ \
if( x ) \
{ \
vFakeAssert( true, __FILE__, __LINE__ ); \
} \
else \
{ \
vFakeAssert( false, __FILE__, __LINE__ ); \
} \
} while( 0 )
#define mtCOVERAGE_TEST_MARKER() __asm volatile ( "NOP" )
#define configINCLUDE_MESSAGE_BUFFER_AMP_DEMO 0
#if ( configINCLUDE_MESSAGE_BUFFER_AMP_DEMO == 1 )
extern void vGenerateCoreBInterrupt( void * xUpdatedMessageBuffer );
#define sbSEND_COMPLETED( pxStreamBuffer ) vGenerateCoreBInterrupt( pxStreamBuffer )
#endif /* configINCLUDE_MESSAGE_BUFFER_AMP_DEMO */
#endif /* FREERTOS_CONFIG_H */

View file

@ -0,0 +1,43 @@
# indent with spaces
.RECIPEPREFIX := $(.RECIPEPREFIX) $(.RECIPEPREFIX)
# Do not move this line below the include
MAKEFILE_ABSPATH := $(abspath $(lastword $(MAKEFILE_LIST)))
include ../../makefile.in
# PROJECT_SRC lists the .c files under test
PROJECT_SRC := stream_buffer.c
# PROJECT_DEPS_SRC list the .c file that are dependencies of PROJECT_SRC files
# Files in PROJECT_DEPS_SRC are excluded from coverage measurements
PROJECT_DEPS_SRC :=
# PROJECT_HEADER_DEPS: headers that should be excluded from coverage measurements.
PROJECT_HEADER_DEPS := FreeRTOS.h
# SUITE_UT_SRC: .c files that contain test cases (must end in _utest.c)
SUITE_UT_SRC := stream_buffer_api_utest.c
# SUITE_SUPPORT_SRC: .c files used for testing that do not contain test cases.
# Paths are relative to PROJECT_DIR
SUITE_SUPPORT_SRC :=
# List the headers used by PROJECT_SRC that you would like to mock
MOCK_FILES_FP := $(KERNEL_DIR)/include/task.h
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_assert.h
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_port.h
# List any addiitonal flags needed by the preprocessor
CPPFLAGS += -DportUSING_MPU_WRAPPERS=0
# List any addiitonal flags needed by the compiler
CFLAGS +=
# Try not to edit beyond this line unless necessary.
# Project / Suite are determined based on path: $(UT_ROOT_DIR)/$(PROJECT)/$(SUITE)
PROJECT := $(lastword $(subst /, ,$(dir $(abspath $(MAKEFILE_ABSPATH)/../))))
SUITE := $(lastword $(subst /, ,$(dir $(MAKEFILE_ABSPATH))))
export
include ../../testdir.mk

View file

@ -85,20 +85,20 @@
* @details Use this macro when the call passed in as a parameter is expected * @details Use this macro when the call passed in as a parameter is expected
* to cause invalid memory access. * to cause invalid memory access.
*/ */
#define EXPECT_ASSERT_BREAK( call ) \ #define EXPECT_ASSERT_BREAK( call ) \
do \ do \
{ \ { \
shouldAbortOnAssertion = true; \ shouldAbortOnAssertion = true; \
CEXCEPTION_T e = CEXCEPTION_NONE; \ CEXCEPTION_T e = CEXCEPTION_NONE; \
Try \ Try \
{ \ { \
call; \ call; \
TEST_FAIL(); \ TEST_FAIL_MESSAGE( "Expected Assert!" ); \
} \ } \
Catch( e ) \ Catch( e ) \
{ \ { \
TEST_ASSERT_EQUAL( configASSERT_E, e ); \ TEST_ASSERT_EQUAL( configASSERT_E, e ); \
} \ } \
} while( 0 ) } while( 0 )
@ -183,7 +183,7 @@ static BaseType_t streamBufferReceiveCallback( UBaseType_t uxIndexToWaitOn,
size_t dataReceived = 0; size_t dataReceived = 0;
/* Receive enough bytes (full size) from stream buffer to wake up sender task. */ /* Receive enough bytes (full size) from stream buffer to wake up sender task. */
dataReceived = xStreamBufferReceive( xStreamBuffer, data, TEST_STREAM_BUFFER_SIZE, 0 ); dataReceived = xStreamBufferReceive( xStreamBuffer, data, TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE, dataReceived ); TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE, dataReceived );
return pdTRUE; return pdTRUE;
} }
@ -291,7 +291,7 @@ static BaseType_t streamBufferSendCallback( UBaseType_t uxIndexToWaitOn,
size_t dataSent = 0; size_t dataSent = 0;
/* Send enough (trigger level) bytes to stream buffer to wake up the receiver Task. */ /* Send enough (trigger level) bytes to stream buffer to wake up the receiver Task. */
dataSent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, 0 ); dataSent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, dataSent ); TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, dataSent );
return pdTRUE; return pdTRUE;
} }
@ -712,6 +712,46 @@ void test_xStreamBufferSend_blocking( void )
vStreamBufferDelete( xStreamBuffer ); vStreamBufferDelete( xStreamBuffer );
} }
/**
* @brief This test case validates that multiple concurrent writers are not allowed on a stream buffer.
* The API should cause an assert fail, if a second task tries to write to the stream buffer
* while first task is blocked writing onto it.
*/
void test_xStreamBufferSend_concurrent_writers( void )
{
uint8_t data[ TEST_STREAM_BUFFER_SIZE ] = { 0 };
size_t sent = 0;
vTaskSetTimeOutState_Ignore();
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( senderTask );
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Create a stream buffer of test sample size. */
xStreamBuffer = xStreamBufferCreate( TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_TRIGGER_LEVEL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE, xStreamBufferSpacesAvailable( xStreamBuffer ) );
/* Sending upto full size of stream buffer should not block. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE, sent );
TEST_ASSERT_EQUAL( 0, xStreamBufferSpacesAvailable( xStreamBuffer ) );
/*
* Sending data to a stream buffer now should cause the sender task to block by calling xTaskGenericNotifyWait callback.
* Withing the callback a second sender tries to send data to same stream buffer which will
* cause the assert to fail.
*/
xTaskGenericNotifyWait_StubWithCallback( streamBufferSendCallback );
xTaskGenericNotify_StubWithCallback( senderTaskNotificationCallback );
xTaskCheckForTimeOut_IgnoreAndReturn( pdFALSE );
EXPECT_ASSERT_BREAK( ( void ) xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_WAIT_TICKS ) );
validate_and_clear_assertions();
vStreamBufferDelete( xStreamBuffer );
}
/** /**
* @brief Validates that stream buffer does not block if zero wait time is passed. * @brief Validates that stream buffer does not block if zero wait time is passed.
*/ */
@ -848,6 +888,42 @@ void test_xStreamBufferReceive_blocking( void )
vStreamBufferDelete( xStreamBuffer ); vStreamBufferDelete( xStreamBuffer );
} }
/**
* @brief This test case validates that multiple concurrent readers are not allowed on a stream buffer.
* The API should cause an assert fail if a second task tries to read from the stream buffer
* while the first task is blocked reading from it.
*/
void test_xStreamBufferReceive_concurrent_readers( void )
{
uint8_t data[ TEST_STREAM_BUFFER_SIZE ] = { 0xAA };
vTaskSetTimeOutState_Ignore();
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( receiverTask );
xTaskGenericNotify_StubWithCallback( receiverTaskNotificationCallback );
xTaskCheckForTimeOut_IgnoreAndReturn( pdFALSE );
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Create a stream buffer of sample size. */
xStreamBuffer = xStreamBufferCreate( TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_TRIGGER_LEVEL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
TEST_ASSERT_EQUAL( 0, xStreamBufferBytesAvailable( xStreamBuffer ) );
/*
* Receiving from an empty buffer causes the task to wait by calling xTaskGenericNotifyWait callback.
* A second reader trying to read concurrently from stream buffer will cause assert statement
* to fail.
*/
xTaskGenericNotifyWait_StubWithCallback( streamBufferReceiveCallback );
xTaskCheckForTimeOut_IgnoreAndReturn( pdFALSE );
EXPECT_ASSERT_BREAK( ( void ) xStreamBufferReceive( xStreamBuffer, data, TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_WAIT_TICKS ) );
validate_and_clear_assertions();
vStreamBufferDelete( xStreamBuffer );
}
/** /**
* @brief Validates that receiver task does not block if zero wait ticks are passed. * @brief Validates that receiver task does not block if zero wait ticks are passed.
*/ */

View file

@ -0,0 +1,148 @@
/*
* FreeRTOS V202112.00
* Copyright (C) 2020 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 FREERTOS_CONFIG_H
#define FREERTOS_CONFIG_H
#include "fake_assert.h"
/*-----------------------------------------------------------
* Application specific definitions.
*
* These definitions should be adjusted for your particular hardware and
* application requirements.
*
* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE. See
* http://www.freertos.org/a00110.html
*----------------------------------------------------------*/
#define configUSE_PREEMPTION 1
#define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
#define configUSE_IDLE_HOOK 1
#define configUSE_TICK_HOOK 1
#define configUSE_DAEMON_TASK_STARTUP_HOOK 1
#define configTICK_RATE_HZ ( 1000 ) /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */
#define configMINIMAL_STACK_SIZE ( ( unsigned short ) 70 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the win32 thread. */
#define configTOTAL_HEAP_SIZE ( ( size_t ) ( 52 * 1024 ) )
#define configMAX_TASK_NAME_LEN ( 12 )
#define configUSE_TRACE_FACILITY 1
#define configUSE_16_BIT_TICKS 0
#define configIDLE_SHOULD_YIELD 1
#define configUSE_MUTEXES 1
#define configCHECK_FOR_STACK_OVERFLOW 0
#define configUSE_RECURSIVE_MUTEXES 1
#define configQUEUE_REGISTRY_SIZE 20
#define configUSE_MALLOC_FAILED_HOOK 1
#define configUSE_APPLICATION_TASK_TAG 1
#define configUSE_COUNTING_SEMAPHORES 1
#define configUSE_ALTERNATIVE_API 0
#define configUSE_QUEUE_SETS 1
#define configUSE_SB_COMPLETED_CALLBACK 1
#define configUSE_TASK_NOTIFICATIONS 1
#define configTASK_NOTIFICATION_ARRAY_ENTRIES 5
#define configSUPPORT_STATIC_ALLOCATION 1
#define configINITIAL_TICK_COUNT ( ( TickType_t ) 0 ) /* For test. */
#define configSTREAM_BUFFER_TRIGGER_LEVEL_TEST_MARGIN 1 /* As there are a lot of tasks running. */
/* Software timer related configuration options. */
#define configUSE_TIMERS 1
#define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
#define configTIMER_QUEUE_LENGTH 20
#define configTIMER_TASK_STACK_DEPTH ( configMINIMAL_STACK_SIZE * 2 )
#define configMAX_PRIORITIES ( 7 )
/* Run time stats gathering configuration options. */
unsigned long ulGetRunTimeCounterValue( void ); /* Prototype of function that returns run time counter. */
void vConfigureTimerForRunTimeStats( void ); /* Prototype of function that initialises the run time counter. */
#define configGENERATE_RUN_TIME_STATS 1
#define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() vConfigureTimerForRunTimeStats()
#define portGET_RUN_TIME_COUNTER_VALUE() ulGetRunTimeCounterValue()
/* Co-routine related configuration options. */
#define configUSE_CO_ROUTINES 0
#define configMAX_CO_ROUTINE_PRIORITIES ( 2 )
/* This demo makes use of one or more example stats formatting functions. These
* format the raw data provided by the uxTaskGetSystemState() function in to human
* readable ASCII form. See the notes in the implementation of vTaskList() within
* FreeRTOS/Source/tasks.c for limitations. */
#define configUSE_STATS_FORMATTING_FUNCTIONS 1
/* Set the following definitions to 1 to include the API function, or zero
* to exclude the API function. In most cases the linker will remove unused
* functions anyway. */
#define INCLUDE_vTaskPrioritySet 1
#define INCLUDE_uxTaskPriorityGet 1
#define INCLUDE_vTaskDelete 1
#define INCLUDE_vTaskCleanUpResources 0
#define INCLUDE_vTaskSuspend 1
#define INCLUDE_vTaskDelayUntil 1
#define INCLUDE_vTaskDelay 1
#define INCLUDE_uxTaskGetStackHighWaterMark 1
#define INCLUDE_xTaskGetSchedulerState 1
#define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
#define INCLUDE_xTaskGetIdleTaskHandle 1
#define INCLUDE_xTaskGetCurrentTaskHandle 1
#define INCLUDE_xTaskGetHandle 1
#define INCLUDE_eTaskGetState 1
#define INCLUDE_xSemaphoreGetMutexHolder 1
#define INCLUDE_xTimerPendFunctionCall 1
#define INCLUDE_xTaskAbortDelay 1
/* It is a good idea to define configASSERT() while developing. configASSERT()
* uses the same semantics as the standard C assert() macro. */
#define configASSERT( x ) \
do \
{ \
if( x ) \
{ \
vFakeAssert( true, __FILE__, __LINE__ ); \
} \
else \
{ \
vFakeAssert( false, __FILE__, __LINE__ ); \
} \
} while( 0 )
#define mtCOVERAGE_TEST_MARKER() __asm volatile ( "NOP" )
extern void vDefaultSendCompletedStub( void * xStreamBuffer );
#define sbSEND_COMPLETED( pxStreamBuffer ) vDefaultSendCompletedStub( pxStreamBuffer )
extern void vDefaultSendCompletedFromISRStub( void * xStreamBuffer,
long * const pxTaskWoken );
#define sbSEND_COMPLETE_FROM_ISR( pxStreamBuffer, pxTaskWoken ) vDefaultSendCompletedFromISRStub( pxStreamBuffer, pxTaskWoken )
extern void vDefaultReceiveCompletedStub( void * xStreamBuffer );
#define sbRECEIVE_COMPLETED( pxStreamBuffer ) vDefaultReceiveCompletedStub( pxStreamBuffer )
extern void vDefaultReceiveCompletedFromISRStub( void * xStreamBuffer,
long * const pxTaskWoken );
#define sbRECEIVE_COMPLETED_FROM_ISR( pxStreamBuffer, pxTaskWoken ) vDefaultReceiveCompletedFromISRStub( pxStreamBuffer, pxTaskWoken )
#endif /* FREERTOS_CONFIG_H */

View file

@ -0,0 +1,44 @@
# indent with spaces
.RECIPEPREFIX := $(.RECIPEPREFIX) $(.RECIPEPREFIX)
# Do not move this line below the include
MAKEFILE_ABSPATH := $(abspath $(lastword $(MAKEFILE_LIST)))
include ../../makefile.in
# PROJECT_SRC lists the .c files under test
PROJECT_SRC := stream_buffer.c
# PROJECT_DEPS_SRC list the .c file that are dependencies of PROJECT_SRC files
# Files in PROJECT_DEPS_SRC are excluded from coverage measurements
PROJECT_DEPS_SRC :=
# PROJECT_HEADER_DEPS: headers that should be excluded from coverage measurements.
PROJECT_HEADER_DEPS := FreeRTOS.h
# SUITE_UT_SRC: .c files that contain test cases (must end in _utest.c)
SUITE_UT_SRC := stream_buffer_callback_utest.c
# SUITE_SUPPORT_SRC: .c files used for testing that do not contain test cases.
# Paths are relative to PROJECT_DIR
SUITE_SUPPORT_SRC :=
# List the headers used by PROJECT_SRC that you would like to mock
MOCK_FILES_FP := $(KERNEL_DIR)/include/task.h
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_assert.h
MOCK_FILES_FP += $(UT_ROOT_DIR)/config/fake_port.h
# List any addiitonal flags needed by the preprocessor
CPPFLAGS += -DportUSING_MPU_WRAPPERS=0
# List any addiitonal flags needed by the compiler
CFLAGS +=
# Try not to edit beyond this line unless necessary.
# Project / Suite are determined based on path: $(UT_ROOT_DIR)/$(PROJECT)/$(SUITE)
PROJECT := $(lastword $(subst /, ,$(dir $(abspath $(MAKEFILE_ABSPATH)/../))))
SUITE := $(lastword $(subst /, ,$(dir $(MAKEFILE_ABSPATH))))
export
include ../../testdir.mk

View file

@ -0,0 +1,886 @@
/*
* FreeRTOS V202112.00
* Copyright (C) 2020 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 stream_buffer_callback_utest.c */
/* C runtime includes. */
#include <stdlib.h>
#include <stdbool.h>
/* Stream Buffer includes */
#include "FreeRTOS.h"
#include "FreeRTOSConfig.h"
#include "stream_buffer.h"
/* Test includes. */
#include "unity.h"
#include "unity_memory.h"
#include "CException.h"
/* Mock includes. */
#include "mock_task.h"
#include "mock_fake_assert.h"
#include "mock_fake_port.h"
/**
* @brief Sample size in bytes of the stream buffer used for test.
* The size is kept short enough so that the buffer can be allocated on stack.
*/
#define TEST_STREAM_BUFFER_SIZE ( 64U )
/**
* @brief Sample trigger level in bytes used for stream buffer tests.
* When a receiver task is blocked waiting for data, trigger level determines how much bytes should
* be available before which receiver task can be unblocked.
*/
#define TEST_STREAM_BUFFER_TRIGGER_LEVEL ( 32U )
/**
* @brief Maximum unsigned long value that can be passed as a stream buffer size so as to
* trigger an integer overflow.
*/
#define TEST_STREAM_BUFFER_MAX_UINT_SIZE ( ~( size_t ) ( 0UL ) )
/**
* @brief A value used to test setting and getting stream buffer number.
*/
#define TEST_STREAM_BUFFER_NUMBER ( 0xFFU )
/**
* @brief Wait ticks passed into from tests if the stream buffer is full while sending data or
* empty while receiving data.
*/
#define TEST_STREAM_BUFFER_WAIT_TICKS ( 1000U )
/**
* @brief CException code for when a configASSERT should be intercepted.
*/
#define configASSERT_E 0xAA101
/**
* @brief Expect a configASSERT from the function called.
* Break out of the called function when this occurs.
* @details Use this macro when the call passed in as a parameter is expected
* to cause invalid memory access.
*/
#define EXPECT_ASSERT_BREAK( call ) \
do \
{ \
shouldAbortOnAssertion = true; \
CEXCEPTION_T e = CEXCEPTION_NONE; \
Try \
{ \
call; \
TEST_FAIL(); \
} \
Catch( e ) \
{ \
TEST_ASSERT_EQUAL( configASSERT_E, e ); \
} \
} while( 0 )
/* ============================ GLOBAL VARIABLES =========================== */
/**
* @brief Global counter for the number of assertions in code.
*/
static int assertionFailed = 0;
/**
* @brief Global counter to keep track of how many times a send callback was invoked from a stream buffer.
*/
static int sendCallbackInvoked = 0;
/**
* @brief Global counter to keep track of how many times a send callback was invoked from a stream buffer in ISR.
*/
static int sendCallbackInvokedFromISR = 0;
/**
* @brief Global counter to keep track of how many times a receiver callback was invoked from a stream buffer.
*/
static int receiveCallbackInvoked = 0;
/**
* @brief Global counter to keep track of how many times a receiver callback was invoked from a stream buffer in ISR.
*/
static int receiveCallbackInvokedFromISR = 0;
/**
* @brief Global counter to keep track of how many times a default callback was invoked.
*/
static int defaultCallbackInvoked = 0;
/**
* @brief Global Stream buffer handle used for tests.
*/
static StreamBufferHandle_t xStreamBuffer;
/**
* @brief Flag which denotes if test need to abort on assertion.
*/
static BaseType_t shouldAbortOnAssertion;
/**
* @brief Variable used to record the total dynamic size allocated in a test.
*/
static size_t dynamicMemoryAllocated = 0;
/* ========================== CALLBACK FUNCTIONS =========================== */
void * pvPortMalloc( size_t xSize )
{
dynamicMemoryAllocated += xSize;
return unity_malloc( xSize );
}
void vPortFree( void * pv )
{
return unity_free( pv );
}
static void vFakeAssertStub( bool x,
char * file,
int line,
int cmock_num_calls )
{
if( !x )
{
assertionFailed++;
if( shouldAbortOnAssertion == pdTRUE )
{
Throw( configASSERT_E );
}
}
}
static void sendCompletedStub( StreamBufferHandle_t xCallingStreamBuffer,
BaseType_t xInsideISR,
BaseType_t * const pxHigherPriorityTaskWoken )
{
size_t dataAvailable = 0;
TEST_ASSERT_NOT_NULL( xCallingStreamBuffer );
TEST_ASSERT_TRUE( ( xInsideISR == pdFALSE ) || ( pxHigherPriorityTaskWoken != NULL ) );
TEST_ASSERT_FALSE( ( xInsideISR == pdFALSE ) && ( pxHigherPriorityTaskWoken != NULL ) );
/* Validate that atleast trigger level bytes are available from stream buffer. */
dataAvailable = xStreamBufferBytesAvailable( xCallingStreamBuffer );
TEST_ASSERT_GREATER_OR_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, dataAvailable );
if( xInsideISR )
{
sendCallbackInvokedFromISR++;
( *pxHigherPriorityTaskWoken ) = pdTRUE;
}
else
{
sendCallbackInvoked++;
}
}
void vDefaultSendCompletedStub( void * xStreamBuffer )
{
size_t dataAvailable = 0;
TEST_ASSERT_NOT_NULL( xStreamBuffer );
/* Validate that atleast trigger level bytes are available from stream buffer. */
dataAvailable = xStreamBufferBytesAvailable( xStreamBuffer );
TEST_ASSERT_GREATER_OR_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, dataAvailable );
defaultCallbackInvoked++;
sendCallbackInvoked++;
}
void vDefaultSendCompletedFromISRStub( void * xStreamBuffer,
BaseType_t * const pxTaskWoken )
{
size_t dataAvailable = 0;
TEST_ASSERT_NOT_NULL( xStreamBuffer );
/* Validate that atleast trigger level bytes are available from stream buffer. */
dataAvailable = xStreamBufferBytesAvailable( xStreamBuffer );
TEST_ASSERT_GREATER_OR_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, dataAvailable );
defaultCallbackInvoked++;
sendCallbackInvokedFromISR++;
( *pxTaskWoken ) = pdTRUE;
}
static void receiveCompletedStub( StreamBufferHandle_t xCallingStreamBuffer,
BaseType_t xInsideISR,
BaseType_t * const pxHigherPriorityTaskWoken )
{
TEST_ASSERT_NOT_NULL( xCallingStreamBuffer );
TEST_ASSERT_TRUE( ( xInsideISR == pdFALSE ) || ( pxHigherPriorityTaskWoken != NULL ) );
TEST_ASSERT_FALSE( ( xInsideISR == pdFALSE ) && ( pxHigherPriorityTaskWoken != NULL ) );
/* Validates that stream buffer has some free space to send data */
TEST_ASSERT_EQUAL( pdFALSE, xStreamBufferIsFull( xCallingStreamBuffer ) );
if( xInsideISR )
{
receiveCallbackInvokedFromISR++;
( *pxHigherPriorityTaskWoken ) = pdTRUE;
}
else
{
receiveCallbackInvoked++;
}
}
void vDefaultReceiveCompletedStub( void * xStreamBuffer )
{
TEST_ASSERT_NOT_NULL( xStreamBuffer );
/* Validates that stream buffer has some free space to send data */
TEST_ASSERT_EQUAL( pdFALSE, xStreamBufferIsFull( xStreamBuffer ) );
receiveCallbackInvoked++;
defaultCallbackInvoked++;
}
void vDefaultReceiveCompletedFromISRStub( void * xStreamBuffer,
BaseType_t * const pxTaskWoken )
{
TEST_ASSERT_NOT_NULL( xStreamBuffer );
/* Validates that stream buffer has some free space to send data */
TEST_ASSERT_EQUAL( pdFALSE, xStreamBufferIsFull( xStreamBuffer ) );
receiveCallbackInvokedFromISR++;
defaultCallbackInvoked++;
( *pxTaskWoken ) = pdTRUE;
}
static void validate_stream_buffer_init_state( StreamBufferHandle_t xStreamBuffer,
size_t bufferSize )
{
TEST_ASSERT_TRUE( xStreamBufferIsEmpty( xStreamBuffer ) );
TEST_ASSERT_FALSE( xStreamBufferIsFull( xStreamBuffer ) );
TEST_ASSERT_EQUAL( bufferSize, xStreamBufferSpacesAvailable( xStreamBuffer ) );
TEST_ASSERT_EQUAL( 0U, xStreamBufferBytesAvailable( xStreamBuffer ) );
TEST_ASSERT_EQUAL( 0U, xStreamBufferNextMessageLengthBytes( xStreamBuffer ) );
TEST_ASSERT_EQUAL( 0, ucStreamBufferGetStreamBufferType( xStreamBuffer ) );
}
/*******************************************************************************
* Unity fixtures
******************************************************************************/
void setUp( void )
{
assertionFailed = 0;
xStreamBuffer = NULL;
sendCallbackInvoked = 0;
sendCallbackInvokedFromISR = 0;
receiveCallbackInvoked = 0;
receiveCallbackInvokedFromISR = 0;
defaultCallbackInvoked = 0;
shouldAbortOnAssertion = pdTRUE;
dynamicMemoryAllocated = 0;
mock_task_Init();
mock_fake_assert_Init();
mock_fake_port_Init();
vFakePortEnterCriticalSection_Ignore();
vFakePortExitCriticalSection_Ignore();
ulFakePortSetInterruptMaskFromISR_IgnoreAndReturn( 0U );
vFakePortClearInterruptMaskFromISR_Ignore();
vFakeAssert_StubWithCallback( vFakeAssertStub );
/* Track calls to malloc / free */
UnityMalloc_StartTest();
}
/*! called before each test case */
void tearDown( void )
{
TEST_ASSERT_EQUAL_MESSAGE( 0, assertionFailed, "Assertion check failed in code." );
UnityMalloc_EndTest();
mock_task_Verify();
mock_task_Destroy();
mock_fake_assert_Verify();
mock_fake_assert_Destroy();
mock_fake_port_Verify();
mock_fake_port_Destroy();
}
/*! called at the beginning of the whole suite */
void suiteSetUp()
{
}
/*! called at the end of the whole suite */
int suiteTearDown( int numFailures )
{
return numFailures;
}
/* ============================== Test Cases ============================== */
/**
* @brief Tests backwards compatibility with the existing API. Calling StreamBufferCreate() should
* create a stream buffer successfully with per instance callbacks set to NULL.
*/
void test_xStreamBufferCreate_NoCallback( void )
{
StaticStreamBuffer_t * pxStreamBufferStruct;
xStreamBuffer = xStreamBufferCreate( TEST_STREAM_BUFFER_SIZE, TEST_STREAM_BUFFER_TRIGGER_LEVEL );
TEST_ASSERT_NOT_EQUAL( NULL, xStreamBuffer );
/* Verify internal memory allocated is equal to size of the struct + buffer size + 1. */
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE + 1U + sizeof( StaticStreamBuffer_t ), dynamicMemoryAllocated );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
/* Set a stream buffer number and get it. */
vStreamBufferSetStreamBufferNumber( xStreamBuffer, TEST_STREAM_BUFFER_NUMBER );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_NUMBER, uxStreamBufferGetStreamBufferNumber( xStreamBuffer ) );
pxStreamBufferStruct = ( StaticStreamBuffer_t * ) ( xStreamBuffer );
TEST_ASSERT_NULL( pxStreamBufferStruct->pvDummy5[ 0 ] );
TEST_ASSERT_NULL( pxStreamBufferStruct->pvDummy5[ 1 ] );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests succesful creation of dynamic stream buffer with callbacks.
*/
void test_xStreamBufferCreate_WithCallback( void )
{
StaticStreamBuffer_t * pxStreamBufferStruct;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
sendCompletedStub,
receiveCompletedStub );
TEST_ASSERT_NOT_EQUAL( NULL, xStreamBuffer );
/* Verify internal memory allocated is equal to size of the struct + buffer size + 1. */
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE + 1U + sizeof( StaticStreamBuffer_t ), dynamicMemoryAllocated );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
/* Set a stream buffer number and get it. */
vStreamBufferSetStreamBufferNumber( xStreamBuffer, TEST_STREAM_BUFFER_NUMBER );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_NUMBER, uxStreamBufferGetStreamBufferNumber( xStreamBuffer ) );
pxStreamBufferStruct = ( StaticStreamBuffer_t * ) ( xStreamBuffer );
TEST_ASSERT_EQUAL( sendCompletedStub, pxStreamBufferStruct->pvDummy5[ 0 ] );
TEST_ASSERT_EQUAL( receiveCompletedStub, pxStreamBufferStruct->pvDummy5[ 1 ] );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests backwards compatibility with the existing API. Calling StreamBufferCreateStatic() should
* create a stream buffer successfully with per instance callbacks set to NULL.
*/
void test_xStreamBufferCreateStatic_NoCallback( void )
{
StaticStreamBuffer_t streamBufferStruct;
/* The size of stream buffer array should be one greater than the required size of stream buffer. */
uint8_t streamBufferArray[ TEST_STREAM_BUFFER_SIZE + 1 ] = { 0 };
xStreamBuffer = xStreamBufferCreateStatic( sizeof( streamBufferArray ), TEST_STREAM_BUFFER_TRIGGER_LEVEL, streamBufferArray, &streamBufferStruct );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
TEST_ASSERT_NULL( streamBufferStruct.pvDummy5[ 0 ] );
TEST_ASSERT_NULL( streamBufferStruct.pvDummy5[ 1 ] );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests successful creation of static stream buffer with callbacks.
*/
void test_xStreamBufferCreateStatic_WithCallback( void )
{
StaticStreamBuffer_t streamBufferStruct;
/* The size of stream buffer array should be one greater than the required size of stream buffer. */
uint8_t streamBufferArray[ TEST_STREAM_BUFFER_SIZE + 1 ] = { 0 };
xStreamBuffer = xStreamBufferCreateStaticWithCallback( sizeof( streamBufferArray ),
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
streamBufferArray,
&streamBufferStruct,
sendCompletedStub,
receiveCompletedStub );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
TEST_ASSERT_EQUAL( sendCompletedStub, streamBufferStruct.pvDummy5[ 0 ] );
TEST_ASSERT_EQUAL( receiveCompletedStub, streamBufferStruct.pvDummy5[ 1 ] );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests send completed callback is invoked by a sender task sending atleast bytes
* equal to trigger level into the streambuffer.
*/
void test_xStreamBufferSend_CallbackInvoked( void )
{
size_t sent = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
sendCompletedStub,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Send data equal to trigger level bytes should invoke the send completed callback. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
TEST_ASSERT_EQUAL( 1, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 0, sendCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, defaultCallbackInvoked );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests send completed callback is not invoked if less than
* trigger level bytes are sent to the streambuffer.
*/
void test_xStreamBufferSend_CallbackNotInvoked( void )
{
size_t sent = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
sendCompletedStub,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Send data less than trigger level bytes should not invoke the send completed callback. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL - 1U, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL - 1U, sent );
TEST_ASSERT_EQUAL( 0, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 0, sendCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, defaultCallbackInvoked );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests default callback is invoked if the user provided send callback is NULL
*/
void test_xStreamBufferSend_DefaultCallbackInvoked( void )
{
size_t sent = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Send data equal to trigger level bytes should invoke the default send completed callback. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
TEST_ASSERT_EQUAL( 1, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 0, sendCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 1, defaultCallbackInvoked );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests send completed callback is invoked by sending atleast bytes
* equal to trigger level from an ISR.
*/
void test_xStreamBufferSendFromISR_CallbackInvoked( void )
{
size_t sent = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
BaseType_t highPriorityTaskWoken = pdFALSE;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
sendCompletedStub,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Send data equal to trigger level bytes from should invoke the send completed callback with ISR flag. */
sent = xStreamBufferSendFromISR( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, &highPriorityTaskWoken );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
TEST_ASSERT_EQUAL( 1, sendCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 0, defaultCallbackInvoked );
TEST_ASSERT_EQUAL( pdTRUE, highPriorityTaskWoken );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests send completed callback is not invoked by sending less than trigger bytes
* from an ISR.
*/
void test_xStreamBufferSendFromISR_CallbackNotInvoked( void )
{
size_t sent = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
BaseType_t highPriorityTaskWoken = pdFALSE;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
sendCompletedStub,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Send data less than trigger level bytes from should not invoke the send completed callback with ISR flag. */
sent = xStreamBufferSendFromISR( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL - 1, &highPriorityTaskWoken );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL - 1, sent );
TEST_ASSERT_EQUAL( 0, sendCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 0, defaultCallbackInvoked );
TEST_ASSERT_EQUAL( pdFALSE, highPriorityTaskWoken );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests default send completed callback is invoked by sending atleast bytes
* equal to trigger level from an ISR and send callback set to NULL.
*/
void test_xStreamBufferSendFromISR_DefaultCallbackInvoked( void )
{
size_t sent = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
BaseType_t highPriorityTaskWoken = pdFALSE;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
/* Send data equal to trigger level bytes from should invoke the send completed callback with ISR flag. */
sent = xStreamBufferSendFromISR( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, &highPriorityTaskWoken );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
TEST_ASSERT_EQUAL( 1, sendCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 1, defaultCallbackInvoked );
TEST_ASSERT_EQUAL( pdTRUE, highPriorityTaskWoken );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests receive completed callback is invoked by a task receiving atleast 1 bytes
* from the streambuffer.
*/
void test_xStreamBufferReceive_CallbackInvoked( void )
{
size_t sent = 0, received = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
receiveCompletedStub );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( NULL );
/* Send upto trigger level bytes in stream buffer. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
/* Receive one byte of data should invoke the receive completed callback. */
received = xStreamBufferReceive( xStreamBuffer, data, 1U, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( 1U, received );
TEST_ASSERT_EQUAL( 1, receiveCallbackInvoked );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvokedFromISR );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests receive completed callback is not invoked zero bytes are received from stream buffer.
*/
void test_xStreamBufferReceive_CallbackNotInvoked( void )
{
size_t received = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
receiveCompletedStub );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( NULL );
xTaskGenericNotifyWait_ExpectAndReturn( 0, 0, 0, NULL, TEST_STREAM_BUFFER_WAIT_TICKS, pdTRUE );
xTaskCheckForTimeOut_IgnoreAndReturn( pdTRUE );
/* Receive zero bytes should not invoke the receive completed callback. */
received = xStreamBufferReceive( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( 0U, received );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvoked );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, defaultCallbackInvoked );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests default receive completed callback is invoked by a task receiving atleast 1 bytes
* from the streambuffer and receive callback set to NULL.
*/
void test_xStreamBufferReceive_DefaultCallbackInvoked( void )
{
size_t sent = 0, received = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( NULL );
/* Send upto trigger level bytes in stream buffer. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
TEST_ASSERT_EQUAL( 1, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 1, defaultCallbackInvoked );
/* Receive one byte of data should invoke the receive completed callback. */
received = xStreamBufferReceive( xStreamBuffer, data, 1U, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( 1U, received );
TEST_ASSERT_EQUAL( 1, receiveCallbackInvoked );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 2, defaultCallbackInvoked );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests receive completed callback is invoked from an ISR receiving atleast 1 bytes
* from the streambuffer.
*/
void test_xStreamBufferReceiveFromISR_CallbackInvoked( void )
{
size_t sent = 0, received = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
BaseType_t highPriorityTaskWoken = pdFALSE;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
receiveCompletedStub );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( NULL );
/* Send upto trigger level bytes in stream buffer. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
/* Receive one byte of data from ISR should invoke the receive completed callback. */
received = xStreamBufferReceiveFromISR( xStreamBuffer, data, 1U, &highPriorityTaskWoken );
TEST_ASSERT_EQUAL( 1U, received );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvoked );
TEST_ASSERT_EQUAL( 1, receiveCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( pdTRUE, highPriorityTaskWoken );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests receive completed callback is not invoked if zero bytes are received from an ISR.
*/
void test_xStreamBufferReceiveFromISR_CallbackNotInvoked( void )
{
size_t received = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
BaseType_t highPriorityTaskWoken = pdFALSE;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
receiveCompletedStub );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
/* Receive zero bytes should not invoke the receive completed callback. */
received = xStreamBufferReceiveFromISR( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, &highPriorityTaskWoken );
TEST_ASSERT_EQUAL( 0U, received );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvoked );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 0, defaultCallbackInvoked );
TEST_ASSERT_EQUAL( pdFALSE, highPriorityTaskWoken );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests default completed callback is invoked from an ISR receiving atleast 1 bytes
* from the streambuffer and user receive callback is NULL.
*/
void test_xStreamBufferReceiveFromISR_DefaultCallbackInvoked( void )
{
size_t sent = 0, received = 0;
uint8_t data[ TEST_STREAM_BUFFER_TRIGGER_LEVEL ] = { 0xFF };
BaseType_t highPriorityTaskWoken = pdFALSE;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
NULL,
NULL );
TEST_ASSERT_NOT_NULL( xStreamBuffer );
validate_stream_buffer_init_state( xStreamBuffer, TEST_STREAM_BUFFER_SIZE );
vTaskSetTimeOutState_Ignore();
vTaskSuspendAll_Ignore();
xTaskResumeAll_IgnoreAndReturn( pdTRUE );
xTaskGenericNotifyStateClear_IgnoreAndReturn( pdTRUE );
xTaskGetCurrentTaskHandle_IgnoreAndReturn( NULL );
/* Send upto trigger level bytes in stream buffer. */
sent = xStreamBufferSend( xStreamBuffer, data, TEST_STREAM_BUFFER_TRIGGER_LEVEL, TEST_STREAM_BUFFER_WAIT_TICKS );
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_TRIGGER_LEVEL, sent );
TEST_ASSERT_EQUAL( 1, sendCallbackInvoked );
TEST_ASSERT_EQUAL( 1, defaultCallbackInvoked );
/* Receive one byte of data from ISR should invoke the receive completed callback. */
received = xStreamBufferReceiveFromISR( xStreamBuffer, data, 1U, &highPriorityTaskWoken );
TEST_ASSERT_EQUAL( 1U, received );
TEST_ASSERT_EQUAL( 0, receiveCallbackInvoked );
TEST_ASSERT_EQUAL( 1, receiveCallbackInvokedFromISR );
TEST_ASSERT_EQUAL( 2, defaultCallbackInvoked );
TEST_ASSERT_EQUAL( pdTRUE, highPriorityTaskWoken );
vStreamBufferDelete( xStreamBuffer );
}
/**
* @brief Tests both send and receive callbacks are retained after a streambuffer
* reset.
*/
void test_xStreamBufferReset_CallbackRetained( void )
{
StaticStreamBuffer_t * pxStreamBufferStruct;
BaseType_t xStatus = pdFAIL;
xStreamBuffer = xStreamBufferCreateWithCallback( TEST_STREAM_BUFFER_SIZE,
TEST_STREAM_BUFFER_TRIGGER_LEVEL,
sendCompletedStub,
receiveCompletedStub );
TEST_ASSERT_NOT_EQUAL( NULL, xStreamBuffer );
/* Verify internal memory allocated is equal to size of the struct + buffer size + 1. */
TEST_ASSERT_EQUAL( TEST_STREAM_BUFFER_SIZE + 1U + sizeof( StaticStreamBuffer_t ), dynamicMemoryAllocated );
/* Verify the fields within stream buffer struct for send and receive completed stubs */
pxStreamBufferStruct = ( StaticStreamBuffer_t * ) ( xStreamBuffer );
TEST_ASSERT_EQUAL( sendCompletedStub, pxStreamBufferStruct->pvDummy5[ 0 ] );
TEST_ASSERT_EQUAL( receiveCompletedStub, pxStreamBufferStruct->pvDummy5[ 1 ] );
/* Reset Stream buffer */
xStatus = xStreamBufferReset( xStreamBuffer );
TEST_ASSERT_EQUAL( pdPASS, xStatus );
/* Verify that the send and receive completed callbacks are retained after reset. */
TEST_ASSERT_EQUAL( sendCompletedStub, pxStreamBufferStruct->pvDummy5[ 0 ] );
TEST_ASSERT_EQUAL( receiveCompletedStub, pxStreamBufferStruct->pvDummy5[ 1 ] );
vStreamBufferDelete( xStreamBuffer );
}

View file

@ -4,7 +4,7 @@ description: "This is the standard distribution of FreeRTOS."
dependencies: dependencies:
- name: "FreeRTOS-Kernel" - name: "FreeRTOS-Kernel"
version: "356fff802" version: "349e803"
repository: repository:
type: "git" type: "git"
url: "https://github.com/FreeRTOS/FreeRTOS-Kernel.git" url: "https://github.com/FreeRTOS/FreeRTOS-Kernel.git"