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

   1 /*\r
   2         FreeRTOS.org V4.4.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  * \page SemTestC semtest.c\r
  58  * \ingroup DemoFiles\r
  59  * <HR>\r
  60  */\r
  61 \r
  62 /*\r
  63 Changes from V1.2.0:\r
  64 \r
  65         + The tasks that operate at the idle priority now use a lower expected\r
  66           count than those running at a higher priority.  This prevents the low\r
  67           priority tasks from signaling an error because they have not been \r
  68           scheduled enough time for each of them to count the shared variable to\r
  69           the high value.\r
  70 \r
  71 Changes from V2.0.0\r
  72 \r
  73         + Delay periods are now specified using variables and constants of\r
  74           portTickType rather than unsigned portLONG.\r
  75 \r
  76 Changes from V2.1.1\r
  77 \r
  78         + The stack size now uses configMINIMAL_STACK_SIZE.\r
  79         + String constants made file scope to decrease stack depth on 8051 port.\r
  80 */\r
  81 \r
  82 #include <stdlib.h>\r
  83 \r
  84 /* Scheduler include files. */\r
  85 #include "FreeRTOS.h"\r
  86 #include "task.h"\r
  87 #include "semphr.h"\r
  88 \r
  89 /* Demo app include files. */\r
  90 #include "semtest.h"\r
  91 #include "print.h"\r
  92 \r
  93 /* The value to which the shared variables are counted. */\r
  94 #define semtstBLOCKING_EXPECTED_VALUE           ( ( unsigned portLONG ) 0xfff )\r
  95 #define semtstNON_BLOCKING_EXPECTED_VALUE       ( ( unsigned portLONG ) 0xff  )\r
  96 \r
  97 #define semtstSTACK_SIZE                        configMINIMAL_STACK_SIZE\r
  98 \r
  99 #define semtstNUM_TASKS                         ( 4 )\r
 100 \r
 101 #define semtstDELAY_FACTOR                      ( ( portTickType ) 10 )\r
 102 \r
 103 /* The task function as described at the top of the file. */\r
 104 static void prvSemaphoreTest( void *pvParameters );\r
 105 \r
 106 /* Structure used to pass parameters to each task. */\r
 107 typedef struct SEMAPHORE_PARAMETERS\r
 108 {\r
 109         xSemaphoreHandle xSemaphore;\r
 110         volatile unsigned portLONG *pulSharedVariable;\r
 111         portTickType xBlockTime;\r
 112 } xSemaphoreParameters;\r
 113 \r
 114 /* Variables used to check that all the tasks are still running without errors. */\r
 115 static volatile portSHORT sCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 116 static volatile portSHORT sNextCheckVariable = 0;\r
 117 \r
 118 /* Strings to print if USE_STDIO is defined. */\r
 119 const portCHAR * const pcPollingSemaphoreTaskError = "Guarded shared variable in unexpected state.\r\n";\r
 120 const portCHAR * const pcSemaphoreTaskStart = "Guarded shared variable task started.\r\n";\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 void vStartSemaphoreTasks( unsigned portBASE_TYPE uxPriority )\r
 125 {\r
 126 xSemaphoreParameters *pxFirstSemaphoreParameters, *pxSecondSemaphoreParameters;\r
 127 const portTickType xBlockTime = ( portTickType ) 100;\r
 128 \r
 129         /* Create the structure used to pass parameters to the first two tasks. */\r
 130         pxFirstSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 131 \r
 132         if( pxFirstSemaphoreParameters != NULL )\r
 133         {\r
 134                 /* Create the semaphore used by the first two tasks. */\r
 135                 vSemaphoreCreateBinary( pxFirstSemaphoreParameters->xSemaphore );\r
 136 \r
 137                 if( pxFirstSemaphoreParameters->xSemaphore != NULL )\r
 138                 {\r
 139                         /* Create the variable which is to be shared by the first two tasks. */\r
 140                         pxFirstSemaphoreParameters->pulSharedVariable = ( unsigned portLONG * ) pvPortMalloc( sizeof( unsigned portLONG ) );\r
 141 \r
 142                         /* Initialise the share variable to the value the tasks expect. */\r
 143                         *( pxFirstSemaphoreParameters->pulSharedVariable ) = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 144 \r
 145                         /* The first two tasks do not block on semaphore calls. */\r
 146                         pxFirstSemaphoreParameters->xBlockTime = ( portTickType ) 0;\r
 147 \r
 148                         /* Spawn the first two tasks.  As they poll they operate at the idle priority. */\r
 149                         xTaskCreate( prvSemaphoreTest, "PolSEM1", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
 150                         xTaskCreate( prvSemaphoreTest, "PolSEM2", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
 151                 }\r
 152         }\r
 153 \r
 154         /* Do exactly the same to create the second set of tasks, only this time \r
 155         provide a block time for the semaphore calls. */\r
 156         pxSecondSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 157         if( pxSecondSemaphoreParameters != NULL )\r
 158         {\r
 159                 vSemaphoreCreateBinary( pxSecondSemaphoreParameters->xSemaphore );\r
 160 \r
 161                 if( pxSecondSemaphoreParameters->xSemaphore != NULL )\r
 162                 {\r
 163                         pxSecondSemaphoreParameters->pulSharedVariable = ( unsigned portLONG * ) pvPortMalloc( sizeof( unsigned portLONG ) );\r
 164                         *( pxSecondSemaphoreParameters->pulSharedVariable ) = semtstBLOCKING_EXPECTED_VALUE;\r
 165                         pxSecondSemaphoreParameters->xBlockTime = xBlockTime / portTICK_RATE_MS;\r
 166 \r
 167                         xTaskCreate( prvSemaphoreTest, "BlkSEM1", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
 168                         xTaskCreate( prvSemaphoreTest, "BlkSEM2", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( xTaskHandle * ) NULL );\r
 169                 }\r
 170         }\r
 171 }\r
 172 /*-----------------------------------------------------------*/\r
 173 \r
 174 static void prvSemaphoreTest( void *pvParameters )\r
 175 {\r
 176 xSemaphoreParameters *pxParameters;\r
 177 volatile unsigned portLONG *pulSharedVariable, ulExpectedValue;\r
 178 unsigned portLONG ulCounter;\r
 179 portSHORT sError = pdFALSE, sCheckVariableToUse;\r
 180 \r
 181         /* See which check variable to use.  sNextCheckVariable is not semaphore \r
 182         protected! */\r
 183         portENTER_CRITICAL();\r
 184                 sCheckVariableToUse = sNextCheckVariable;\r
 185                 sNextCheckVariable++;\r
 186         portEXIT_CRITICAL();\r
 187 \r
 188         /* Queue a message for printing to say the task has started. */\r
 189         vPrintDisplayMessage( &pcSemaphoreTaskStart );\r
 190 \r
 191         /* A structure is passed in as the parameter.  This contains the shared \r
 192         variable being guarded. */\r
 193         pxParameters = ( xSemaphoreParameters * ) pvParameters;\r
 194         pulSharedVariable = pxParameters->pulSharedVariable;\r
 195 \r
 196         /* If we are blocking we use a much higher count to ensure loads of context\r
 197         switches occur during the count. */\r
 198         if( pxParameters->xBlockTime > ( portTickType ) 0 )\r
 199         {\r
 200                 ulExpectedValue = semtstBLOCKING_EXPECTED_VALUE;\r
 201         }\r
 202         else\r
 203         {\r
 204                 ulExpectedValue = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 205         }\r
 206 \r
 207         for( ;; )\r
 208         {\r
 209                 /* Try to obtain the semaphore. */\r
 210                 if( xSemaphoreTake( pxParameters->xSemaphore, pxParameters->xBlockTime ) == pdPASS )\r
 211                 {\r
 212                         /* We have the semaphore and so expect any other tasks using the\r
 213                         shared variable to have left it in the state we expect to find\r
 214                         it. */\r
 215                         if( *pulSharedVariable != ulExpectedValue )\r
 216                         {\r
 217                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 218                                 sError = pdTRUE;\r
 219                         }\r
 220                         \r
 221                         /* Clear the variable, then count it back up to the expected value\r
 222                         before releasing the semaphore.  Would expect a context switch or\r
 223                         two during this time. */\r
 224                         for( ulCounter = ( unsigned portLONG ) 0; ulCounter <= ulExpectedValue; ulCounter++ )\r
 225                         {\r
 226                                 *pulSharedVariable = ulCounter;\r
 227                                 if( *pulSharedVariable != ulCounter )\r
 228                                 {\r
 229                                         if( sError == pdFALSE )\r
 230                                         {\r
 231                                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 232                                         }\r
 233                                         sError = pdTRUE;\r
 234                                 }\r
 235                         }\r
 236 \r
 237                         /* Release the semaphore, and if no errors have occurred increment the check\r
 238                         variable. */\r
 239                         if(     xSemaphoreGive( pxParameters->xSemaphore ) == pdFALSE )\r
 240                         {\r
 241                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 242                                 sError = pdTRUE;\r
 243                         }\r
 244 \r
 245                         if( sError == pdFALSE )\r
 246                         {\r
 247                                 if( sCheckVariableToUse < semtstNUM_TASKS )\r
 248                                 {\r
 249                                         ( sCheckVariables[ sCheckVariableToUse ] )++;\r
 250                                 }\r
 251                         }\r
 252 \r
 253                         /* If we have a block time then we are running at a priority higher\r
 254                         than the idle priority.  This task takes a long time to complete\r
 255                         a cycle (deliberately so to test the guarding) so will be starving\r
 256                         out lower priority tasks.  Block for some time to allow give lower\r
 257                         priority tasks some processor time. */\r
 258                         vTaskDelay( pxParameters->xBlockTime * semtstDELAY_FACTOR );\r
 259                 }\r
 260                 else\r
 261                 {\r
 262                         if( pxParameters->xBlockTime == ( portTickType ) 0 )\r
 263                         {\r
 264                                 /* We have not got the semaphore yet, so no point using the\r
 265                                 processor.  We are not blocking when attempting to obtain the\r
 266                                 semaphore. */\r
 267                                 taskYIELD();\r
 268                         }\r
 269                 }\r
 270         }\r
 271 }\r
 272 /*-----------------------------------------------------------*/\r
 273 \r
 274 /* This is called to check that all the created tasks are still running. */\r
 275 portBASE_TYPE xAreSemaphoreTasksStillRunning( void )\r
 276 {\r
 277 static portSHORT sLastCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 278 portBASE_TYPE xTask, xReturn = pdTRUE;\r
 279 \r
 280         for( xTask = 0; xTask < semtstNUM_TASKS; xTask++ )\r
 281         {\r
 282                 if( sLastCheckVariables[ xTask ] == sCheckVariables[ xTask ] )\r
 283                 {\r
 284                         xReturn = pdFALSE;\r
 285                 }\r
 286 \r
 287                 sLastCheckVariables[ xTask ] = sCheckVariables[ xTask ];\r
 288         }\r
 289 \r
 290         return xReturn;\r
 291 }\r
 292 \r
 293 \r