From: richardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Date: Mon, 14 Feb 2011 13:47:50 +0000 (+0000)
Subject: Add some configASSERT() calls.
X-Git-Tag: V7.0.0~52
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=bf99b657e3b24fa5a71fc80af01722f257ff1e5a;p=freertos

Add some configASSERT() calls.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1297 1d2547de-c912-0410-9cb9-b8ca96c0e9e2
---

diff --git a/Source/queue.c b/Source/queue.c
index c08d4c174..25374c77c 100644
--- a/Source/queue.c
+++ b/Source/queue.c
@@ -287,6 +287,8 @@ xQueueHandle xReturn = NULL;
 		}
 	}
 
+	configASSERT( xReturn );
+
 	return xReturn;
 }
 /*-----------------------------------------------------------*/
@@ -333,6 +335,7 @@ xQueueHandle xReturn = NULL;
 			traceCREATE_MUTEX_FAILED();
 		}
 
+		configASSERT( pxNewQueue );
 		return pxNewQueue;
 	}
 
@@ -345,6 +348,8 @@ xQueueHandle xReturn = NULL;
 	{
 	portBASE_TYPE xReturn;
 
+		configASSERT( pxMutex );
+
 		/* If this is the task that holds the mutex then pxMutexHolder will not
 		change outside of this task.  If this task does not hold the mutex then
 		pxMutexHolder can never coincidentally equal the tasks handle, and as
@@ -392,6 +397,8 @@ xQueueHandle xReturn = NULL;
 	{
 	portBASE_TYPE xReturn;
 
+		configASSERT( pxMutex );
+
 		/* Comments regarding mutual exclusion as per those within
 		xQueueGiveMutexRecursive(). */
 
@@ -443,6 +450,7 @@ xQueueHandle xReturn = NULL;
 			traceCREATE_COUNTING_SEMAPHORE_FAILED();
 		}
 
+		configASSERT( pxHandle );
 		return pxHandle;
 	}
 
@@ -454,6 +462,9 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle pxQueue, const void * const
 signed portBASE_TYPE xEntryTimeSet = pdFALSE;
 xTimeOutType xTimeOut;
 
+	configASSERT( pxQueue );
+	configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
+
 	/* This function relaxes the coding standard somewhat to allow return
 	statements within the function itself.  This is done in the interest
 	of execution time efficiency. */
@@ -572,6 +583,9 @@ xTimeOutType xTimeOut;
 	signed portBASE_TYPE xEntryTimeSet = pdFALSE;
 	xTimeOutType xTimeOut;
 
+		configASSERT( pxQueue );
+		configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
+
 		for( ;; )
 		{
 			taskENTER_CRITICAL();
@@ -647,6 +661,9 @@ xTimeOutType xTimeOut;
 	xTimeOutType xTimeOut;
 	signed char *pcOriginalReadPosition;
 
+		configASSERT( pxQueue );
+		configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
+
 		for( ;; )
 		{
 			taskENTER_CRITICAL();
@@ -770,6 +787,10 @@ signed portBASE_TYPE xQueueGenericSendFromISR( xQueueHandle pxQueue, const void
 signed portBASE_TYPE xReturn;
 unsigned portBASE_TYPE uxSavedInterruptStatus;
 
+	configASSERT( pxQueue );
+	configASSERT( pxHigherPriorityTaskWoken );
+	configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
+
 	/* Similar to xQueueGenericSend, except we don't block if there is no room
 	in the queue.  Also we don't directly wake a task that was blocked on a
 	queue read, instead we return a flag to say whether a context switch is
@@ -824,6 +845,9 @@ signed portBASE_TYPE xEntryTimeSet = pdFALSE;
 xTimeOutType xTimeOut;
 signed char *pcOriginalReadPosition;
 
+	configASSERT( pxQueue );
+	configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
+
 	/* This function relaxes the coding standard somewhat to allow return
 	statements within the function itself.  This is done in the interest
 	of execution time efficiency. */
@@ -970,6 +994,10 @@ signed portBASE_TYPE xQueueReceiveFromISR( xQueueHandle pxQueue, void * const pv
 signed portBASE_TYPE xReturn;
 unsigned portBASE_TYPE uxSavedInterruptStatus;
 
+	configASSERT( pxQueue );
+	configASSERT( pxTaskWoken );
+	configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( unsigned portBASE_TYPE ) 0U ) ) );
+
 	uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
 	{
 		/* We cannot block from an ISR, so check there is data available. */
@@ -1020,6 +1048,8 @@ unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle pxQueue )
 {
 unsigned portBASE_TYPE uxReturn;
 
+	configASSERT( pxQueue );
+
 	taskENTER_CRITICAL();
 		uxReturn = pxQueue->uxMessagesWaiting;
 	taskEXIT_CRITICAL();
@@ -1032,6 +1062,8 @@ unsigned portBASE_TYPE uxQueueMessagesWaitingFromISR( const xQueueHandle pxQueue
 {
 unsigned portBASE_TYPE uxReturn;
 
+	configASSERT( pxQueue );
+
 	uxReturn = pxQueue->uxMessagesWaiting;
 
 	return uxReturn;
@@ -1040,6 +1072,8 @@ unsigned portBASE_TYPE uxReturn;
 
 void vQueueDelete( xQueueHandle pxQueue )
 {
+	configASSERT( pxQueue );
+
 	traceQUEUE_DELETE( pxQueue );
 	vQueueUnregisterQueue( pxQueue );
 	vPortFree( pxQueue->pcHead );
@@ -1179,6 +1213,7 @@ signed portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle pxQueue )
 {
 signed portBASE_TYPE xReturn;
 
+	configASSERT( pxQueue );
 	xReturn = ( pxQueue->uxMessagesWaiting == ( unsigned portBASE_TYPE ) 0 );
 
 	return xReturn;
@@ -1201,6 +1236,7 @@ signed portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle pxQueue )
 {
 signed portBASE_TYPE xReturn;
 
+	configASSERT( pxQueue );
 	xReturn = ( pxQueue->uxMessagesWaiting == pxQueue->uxLength );
 
 	return xReturn;
diff --git a/Source/tasks.c b/Source/tasks.c
index 70b629d3f..122fedcb6 100644
--- a/Source/tasks.c
+++ b/Source/tasks.c
@@ -429,6 +429,9 @@ signed portBASE_TYPE xTaskGenericCreate( pdTASK_CODE pxTaskCode, const signed ch
 signed portBASE_TYPE xReturn;
 tskTCB * pxNewTCB;
 
+	configASSERT( pxTaskCode );
+	configASSERT( ( uxPriority < configMAX_PRIORITIES ) );
+
 	/* Allocate the memory required by the TCB and stack for the new task,
 	checking that the allocation was successful. */
 	pxNewTCB = prvAllocateTCBAndStack( usStackDepth, puxStackBuffer );
@@ -451,6 +454,9 @@ tskTCB * pxNewTCB;
 			uxPriority &= ~portPRIVILEGE_BIT;
 		#endif /* portUSING_MPU_WRAPPERS == 1 */
 
+		/* Check the alignment of the stack buffer is correct. */
+		configASSERT( !( ( unsigned long ) pxNewTCB->pxStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) );
+
 		/* Calculate the top of stack address.  This depends on whether the
 		stack grows from high memory to low (as per the 80x86) or visa versa.
 		portSTACK_GROWTH is used to make the result positive or negative as
@@ -459,6 +465,9 @@ tskTCB * pxNewTCB;
 		{
 			pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - ( unsigned short ) 1 );
 			pxTopOfStack = ( portSTACK_TYPE * ) ( ( ( unsigned long ) pxTopOfStack ) & ( ( unsigned long ) ~portBYTE_ALIGNMENT_MASK  ) );
+
+			/* Check the alignment of the calculated top of stack is correct. */
+			configASSERT( !( ( unsigned long ) pxTopOfStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) );
 		}
 		#else
 		{
@@ -488,6 +497,9 @@ tskTCB * pxNewTCB;
 		}
 		#endif
 
+		/* Check the alignment of the initialised stack. */
+		configASSERT( !( ( unsigned long ) pxNewTCB->pxTopOfStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) );
+
 		if( ( void * ) pxCreatedTask != NULL )
 		{
 			/* Pass the TCB out - in an anonymous way.  The calling function/
@@ -647,6 +659,9 @@ tskTCB * pxNewTCB;
 	portTickType xTimeToWake;
 	portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;
 
+		configASSERT( pxPreviousWakeTime );
+		configASSERT( ( xTimeIncrement > 0 ) );
+
 		vTaskSuspendAll();
 		{
 			/* Generate the tick time at which the task wants to wake. */
@@ -748,19 +763,6 @@ tskTCB * pxNewTCB;
 #endif
 /*-----------------------------------------------------------*/
 
-void vTaskUnblockTask( xTaskHandle pxTask )
-{
-tskTCB *pxTCB = ( tskTCB * ) pxTask;
-
-	/* This function is not intended to be a public API function and definitely
-	is not for generic use as it assumes pxTask is not the running task and not
-	suspended, does not remove the task from any event lists it might be
-	blocked on, and does not take care of mutual exclusion. */
-	vListRemove( &( pxTCB->xGenericListItem ) );
-	prvAddTaskToReadyQueue( pxTCB );
-}
-/*-----------------------------------------------------------*/
-
 #if ( INCLUDE_uxTaskPriorityGet == 1 )
 
 	unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )
@@ -791,6 +793,8 @@ tskTCB *pxTCB = ( tskTCB * ) pxTask;
 	unsigned portBASE_TYPE uxCurrentPriority;
 	portBASE_TYPE xYieldRequired = pdFALSE;
 
+		configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );
+
 		/* Ensure the new priority is valid. */
 		if( uxNewPriority >= configMAX_PRIORITIES )
 		{
@@ -960,6 +964,9 @@ tskTCB *pxTCB = ( tskTCB * ) pxTask;
 	portBASE_TYPE xReturn = pdFALSE;
 	const tskTCB * const pxTCB = ( tskTCB * ) xTask;
 
+		/* It does not make sense to check if the calling task is suspended. */
+		configASSERT( xTask );
+
 		/* Is the task we are attempting to resume actually in the
 		suspended list? */
 		if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )
@@ -990,6 +997,9 @@ tskTCB *pxTCB = ( tskTCB * ) pxTask;
 	{
 	tskTCB *pxTCB;
 
+		/* It does not make sense to resume the calling task. */
+		configASSERT( pxTaskToResume );
+
 		/* Remove the task from whichever list it is currently in, and place
 		it in the ready list. */
 		pxTCB = ( tskTCB * ) pxTaskToResume;
@@ -1033,6 +1043,8 @@ tskTCB *pxTCB = ( tskTCB * ) pxTask;
 	portBASE_TYPE xYieldRequired = pdFALSE;
 	tskTCB *pxTCB;
 
+		configASSERT( pxTaskToResume );
+
 		pxTCB = ( tskTCB * ) pxTaskToResume;
 
 		if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
@@ -1115,6 +1127,9 @@ portBASE_TYPE xReturn;
 			/* Should only reach here if a task calls xTaskEndScheduler(). */
 		}
 	}
+
+	/* This line will only be reached if the kernel could not be started. */
+	configASSERT( xReturn );
 }
 /*-----------------------------------------------------------*/
 
@@ -1142,6 +1157,10 @@ signed portBASE_TYPE xTaskResumeAll( void )
 register tskTCB *pxTCB;
 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
 
+	/* If uxSchedulerSuspended is zero then this function does not match a
+	previous call to vTaskSuspendAll(). */
+	configASSERT( uxSchedulerSuspended );
+
 	/* It is possible that an ISR caused a task to be removed from an event
 	list while the scheduler was suspended.  If this was the case then the
 	removed task will have been added to the xPendingReadyList.  Once the
@@ -1237,7 +1256,14 @@ portTickType xTicks;
 
 portTickType xTaskGetTickCountFromISR( void )
 {
-	return xTickCount;
+portTickType xReturn;
+unsigned portBASE_TYPE uxSavedInterruptStatus;
+
+	uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
+	xReturn = xTickCount;
+	portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
+
+	return xReturn;
 }
 /*-----------------------------------------------------------*/
 
@@ -1391,6 +1417,9 @@ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )
 
 	void vTaskStartTrace( signed char * pcBuffer, unsigned long ulBufferSize )
 	{
+		configASSERT( pcBuffer );
+		configASSERT( ulBufferSize );
+
 		taskENTER_CRITICAL();
 		{
 			pcTraceBuffer = ( signed char * )pcBuffer;
@@ -1685,6 +1714,7 @@ void vTaskSwitchContext( void )
 		/* Find the highest priority queue that contains ready tasks. */
 		while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )
 		{
+			configASSERT( uxTopReadyPriority );
 			--uxTopReadyPriority;
 		}
 	
@@ -1702,6 +1732,8 @@ void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicks
 {
 portTickType xTimeToWake;
 
+	configASSERT( pxEventList );
+
 	/* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
 	SCHEDULER SUSPENDED. */
 
@@ -1750,6 +1782,8 @@ portTickType xTimeToWake;
 	{
 	portTickType xTimeToWake;
 
+		configASSERT( pxEventList );
+
 		/* This function should not be called by application code hence the
 		'Restricted' in its name.  It is not part of the public API.  It is
 		designed for use by kernel code, and has special calling requirements -
@@ -1795,6 +1829,7 @@ portBASE_TYPE xReturn;
 	This function assumes that a check has already been made to ensure that
 	pxEventList is not empty. */
 	pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );
+	configASSERT( pxUnblockedTCB );
 	vListRemove( &( pxUnblockedTCB->xEventListItem ) );
 
 	if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
@@ -1828,6 +1863,7 @@ portBASE_TYPE xReturn;
 
 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )
 {
+	configASSERT( pxTimeOut );
 	pxTimeOut->xOverflowCount = xNumOfOverflows;
 	pxTimeOut->xTimeOnEntering = xTickCount;
 }
@@ -1837,6 +1873,9 @@ portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType
 {
 portBASE_TYPE xReturn;
 
+	configASSERT( pxTimeOut );
+	configASSERT( pxTicksToWait );
+
 	taskENTER_CRITICAL();
 	{
 		#if ( INCLUDE_vTaskSuspend == 1 )
@@ -2030,6 +2069,8 @@ static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const
 	{
 	tskTCB *pxTCB;
 	
+		configASSERT( xRegions );
+
 		if( xTaskToModify == pxCurrentTCB )
 		{
 			xTaskToModify = NULL;
@@ -2385,6 +2426,8 @@ tskTCB *pxNewTCB;
 	{
 	tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
 
+		configASSERT( pxMutexHolder );
+
 		if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )
 		{
 			/* Adjust the mutex holder state to account for its new priority. */