begriffs open source - freertos/blob - 20080217/Demo/Common/Full/semtest.c

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