git.sur5r.net Git - freertos/blob - Demo/Common/Minimal/semtest.c

   1 /*\r
   2         FreeRTOS.org V4.3.0 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 /*\r
  37  * Creates two sets of two tasks.  The tasks within a set share a variable, access \r
  38  * to which is guarded by a semaphore.\r
  39  * \r
  40  * Each task starts by attempting to obtain the semaphore.  On obtaining a \r
  41  * semaphore a task checks to ensure that the guarded variable has an expected \r
  42  * value.  It then clears the variable to zero before counting it back up to the \r
  43  * expected value in increments of 1.  After each increment the variable is checked \r
  44  * to ensure it contains the value to which it was just set. When the starting \r
  45  * value is again reached the task releases the semaphore giving the other task in \r
  46  * the set a chance to do exactly the same thing.  The starting value is high \r
  47  * enough to ensure that a tick is likely to occur during the incrementing loop.\r
  48  *\r
  49  * An error is flagged if at any time during the process a shared variable is \r
  50  * found to have a value other than that expected.  Such an occurrence would \r
  51  * suggest an error in the mutual exclusion mechanism by which access to the \r
  52  * variable is restricted.\r
  53  *\r
  54  * The first set of two tasks poll their semaphore.  The second set use blocking \r
  55  * calls.\r
  56  *\r
  57  */\r
  58 \r
  59 \r
  60 #include <stdlib.h>\r
  61 \r
  62 /* Scheduler include files. */\r
  63 #include "FreeRTOS.h"\r
  64 #include "task.h"\r
  65 #include "semphr.h"\r
  66 \r
  67 /* Demo app include files. */\r
  68 #include "semtest.h"\r
  69 \r
  70 /* The value to which the shared variables are counted. */\r
  71 #define semtstBLOCKING_EXPECTED_VALUE           ( ( unsigned portLONG ) 0xfff )\r
  72 #define semtstNON_BLOCKING_EXPECTED_VALUE       ( ( unsigned portLONG ) 0xff  )\r
  73 \r
  74 #define semtstSTACK_SIZE                        configMINIMAL_STACK_SIZE\r
  75 \r
  76 #define semtstNUM_TASKS                         ( 4 )\r
  77 \r
  78 #define semtstDELAY_FACTOR                      ( ( portTickType ) 10 )\r
  79 \r
  80 /* The task function as described at the top of the file. */\r
  81 static portTASK_FUNCTION_PROTO( prvSemaphoreTest, pvParameters );\r
  82 \r
  83 /* Structure used to pass parameters to each task. */\r
  84 typedef struct SEMAPHORE_PARAMETERS\r
  85 {\r
  86         xSemaphoreHandle xSemaphore;\r
  87         volatile unsigned portLONG *pulSharedVariable;\r
  88         portTickType xBlockTime;\r
  89 } xSemaphoreParameters;\r
  90 \r
  91 /* Variables used to check that all the tasks are still running without errors. */\r
  92 static volatile portSHORT sCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
  93 static volatile portSHORT sNextCheckVariable = 0;\r
  94 \r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 void vStartSemaphoreTasks( unsigned portBASE_TYPE uxPriority )\r
  98 {\r
  99 xSemaphoreParameters *pxFirstSemaphoreParameters, *pxSecondSemaphoreParameters;\r
 100 const portTickType xBlockTime = ( portTickType ) 100;\r
 101 \r
 102         /* Create the structure used to pass parameters to the first two tasks. */\r
 103         pxFirstSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 104 \r
 105         if( pxFirstSemaphoreParameters != NULL )\r
 106         {\r
 107                 /* Create the semaphore used by the first two tasks. */\r
 108                 vSemaphoreCreateBinary( pxFirstSemaphoreParameters->xSemaphore );\r
 109 \r
 110                 if( pxFirstSemaphoreParameters->xSemaphore != NULL )\r
 111                 {\r
 112                         /* Create the variable which is to be shared by the first two tasks. */\r
 113                         pxFirstSemaphoreParameters->pulSharedVariable = ( unsigned portLONG * ) pvPortMalloc( sizeof( unsigned portLONG ) );\r
 114 \r
 115                         /* Initialise the share variable to the value the tasks expect. */\r
 116                         *( pxFirstSemaphoreParameters->pulSharedVariable ) = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 117 \r
 118                         /* The first two tasks do not block on semaphore calls. */\r
 119                         pxFirstSemaphoreParameters->xBlockTime = ( portTickType ) 0;\r
 120 \r
 121                         /* Spawn the first two tasks.  As they poll they operate at the idle priority. */\r
 122                         xTaskCreate( prvSemaphoreTest, ( signed portCHAR * ) "PolSEM1", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
 123                         xTaskCreate( prvSemaphoreTest, ( signed portCHAR * ) "PolSEM2", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
 124                 }\r
 125         }\r
 126 \r
 127         /* Do exactly the same to create the second set of tasks, only this time \r
 128         provide a block time for the semaphore calls. */\r
 129         pxSecondSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 130         if( pxSecondSemaphoreParameters != NULL )\r
 131         {\r
 132                 vSemaphoreCreateBinary( pxSecondSemaphoreParameters->xSemaphore );\r
 133 \r
 134                 if( pxSecondSemaphoreParameters->xSemaphore != NULL )\r
 135                 {\r
 136                         pxSecondSemaphoreParameters->pulSharedVariable = ( unsigned portLONG * ) pvPortMalloc( sizeof( unsigned portLONG ) );\r
 137                         *( pxSecondSemaphoreParameters->pulSharedVariable ) = semtstBLOCKING_EXPECTED_VALUE;\r
 138                         pxSecondSemaphoreParameters->xBlockTime = xBlockTime / portTICK_RATE_MS;\r
 139 \r
 140                         xTaskCreate( prvSemaphoreTest, ( signed portCHAR * ) "BlkSEM1", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
 141                         xTaskCreate( prvSemaphoreTest, ( signed portCHAR * ) "BlkSEM2", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
 142                 }\r
 143         }\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 static portTASK_FUNCTION( prvSemaphoreTest, pvParameters )\r
 148 {\r
 149 xSemaphoreParameters *pxParameters;\r
 150 volatile unsigned portLONG *pulSharedVariable, ulExpectedValue;\r
 151 unsigned portLONG ulCounter;\r
 152 portSHORT sError = pdFALSE, sCheckVariableToUse;\r
 153 \r
 154         /* See which check variable to use.  sNextCheckVariable is not semaphore \r
 155         protected! */\r
 156         portENTER_CRITICAL();\r
 157                 sCheckVariableToUse = sNextCheckVariable;\r
 158                 sNextCheckVariable++;\r
 159         portEXIT_CRITICAL();\r
 160 \r
 161         /* A structure is passed in as the parameter.  This contains the shared \r
 162         variable being guarded. */\r
 163         pxParameters = ( xSemaphoreParameters * ) pvParameters;\r
 164         pulSharedVariable = pxParameters->pulSharedVariable;\r
 165 \r
 166         /* If we are blocking we use a much higher count to ensure loads of context\r
 167         switches occur during the count. */\r
 168         if( pxParameters->xBlockTime > ( portTickType ) 0 )\r
 169         {\r
 170                 ulExpectedValue = semtstBLOCKING_EXPECTED_VALUE;\r
 171         }\r
 172         else\r
 173         {\r
 174                 ulExpectedValue = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 175         }\r
 176 \r
 177         for( ;; )\r
 178         {\r
 179                 /* Try to obtain the semaphore. */\r
 180                 if( xSemaphoreTake( pxParameters->xSemaphore, pxParameters->xBlockTime ) == pdPASS )\r
 181                 {\r
 182                         /* We have the semaphore and so expect any other tasks using the\r
 183                         shared variable to have left it in the state we expect to find\r
 184                         it. */\r
 185                         if( *pulSharedVariable != ulExpectedValue )\r
 186                         {\r
 187                                 sError = pdTRUE;\r
 188                         }\r
 189                         \r
 190                         /* Clear the variable, then count it back up to the expected value\r
 191                         before releasing the semaphore.  Would expect a context switch or\r
 192                         two during this time. */\r
 193                         for( ulCounter = ( unsigned portLONG ) 0; ulCounter <= ulExpectedValue; ulCounter++ )\r
 194                         {\r
 195                                 *pulSharedVariable = ulCounter;\r
 196                                 if( *pulSharedVariable != ulCounter )\r
 197                                 {\r
 198                                         sError = pdTRUE;\r
 199                                 }\r
 200                         }\r
 201 \r
 202                         /* Release the semaphore, and if no errors have occurred increment the check\r
 203                         variable. */\r
 204                         if(     xSemaphoreGive( pxParameters->xSemaphore ) == pdFALSE )\r
 205                         {\r
 206                                 sError = pdTRUE;\r
 207                         }\r
 208 \r
 209                         if( sError == pdFALSE )\r
 210                         {\r
 211                                 if( sCheckVariableToUse < semtstNUM_TASKS )\r
 212                                 {\r
 213                                         ( sCheckVariables[ sCheckVariableToUse ] )++;\r
 214                                 }\r
 215                         }\r
 216 \r
 217                         /* If we have a block time then we are running at a priority higher\r
 218                         than the idle priority.  This task takes a long time to complete\r
 219                         a cycle (deliberately so to test the guarding) so will be starving\r
 220                         out lower priority tasks.  Block for some time to allow give lower\r
 221                         priority tasks some processor time. */\r
 222                         vTaskDelay( pxParameters->xBlockTime * semtstDELAY_FACTOR );\r
 223                 }\r
 224                 else\r
 225                 {\r
 226                         if( pxParameters->xBlockTime == ( portTickType ) 0 )\r
 227                         {\r
 228                                 /* We have not got the semaphore yet, so no point using the\r
 229                                 processor.  We are not blocking when attempting to obtain the\r
 230                                 semaphore. */\r
 231                                 taskYIELD();\r
 232                         }\r
 233                 }\r
 234         }\r
 235 }\r
 236 /*-----------------------------------------------------------*/\r
 237 \r
 238 /* This is called to check that all the created tasks are still running. */\r
 239 portBASE_TYPE xAreSemaphoreTasksStillRunning( void )\r
 240 {\r
 241 static portSHORT sLastCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 242 portBASE_TYPE xTask, xReturn = pdTRUE;\r
 243 \r
 244         for( xTask = 0; xTask < semtstNUM_TASKS; xTask++ )\r
 245         {\r
 246                 if( sLastCheckVariables[ xTask ] == sCheckVariables[ xTask ] )\r
 247                 {\r
 248                         xReturn = pdFALSE;\r
 249                 }\r
 250 \r
 251                 sLastCheckVariables[ xTask ] = sCheckVariables[ xTask ];\r
 252         }\r
 253 \r
 254         return xReturn;\r
 255 }\r
 256 \r
 257 \r