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

   1 /*\r
   2     FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /**\r
  67  * Creates two sets of two tasks.  The tasks within a set share a variable, access \r
  68  * to which is guarded by a semaphore.\r
  69  * \r
  70  * Each task starts by attempting to obtain the semaphore.  On obtaining a \r
  71  * semaphore a task checks to ensure that the guarded variable has an expected \r
  72  * value.  It then clears the variable to zero before counting it back up to the \r
  73  * expected value in increments of 1.  After each increment the variable is checked \r
  74  * to ensure it contains the value to which it was just set. When the starting \r
  75  * value is again reached the task releases the semaphore giving the other task in \r
  76  * the set a chance to do exactly the same thing.  The starting value is high \r
  77  * enough to ensure that a tick is likely to occur during the incrementing loop.\r
  78  *\r
  79  * An error is flagged if at any time during the process a shared variable is \r
  80  * found to have a value other than that expected.  Such an occurrence would \r
  81  * suggest an error in the mutual exclusion mechanism by which access to the \r
  82  * variable is restricted.\r
  83  *\r
  84  * The first set of two tasks poll their semaphore.  The second set use blocking \r
  85  * calls.\r
  86  *\r
  87  * \page SemTestC semtest.c\r
  88  * \ingroup DemoFiles\r
  89  * <HR>\r
  90  */\r
  91 \r
  92 /*\r
  93 Changes from V1.2.0:\r
  94 \r
  95         + The tasks that operate at the idle priority now use a lower expected\r
  96           count than those running at a higher priority.  This prevents the low\r
  97           priority tasks from signaling an error because they have not been \r
  98           scheduled enough time for each of them to count the shared variable to\r
  99           the high value.\r
 100 \r
 101 Changes from V2.0.0\r
 102 \r
 103         + Delay periods are now specified using variables and constants of\r
 104           TickType_t rather than unsigned long.\r
 105 \r
 106 Changes from V2.1.1\r
 107 \r
 108         + The stack size now uses configMINIMAL_STACK_SIZE.\r
 109         + String constants made file scope to decrease stack depth on 8051 port.\r
 110 */\r
 111 \r
 112 #include <stdlib.h>\r
 113 \r
 114 /* Scheduler include files. */\r
 115 #include "FreeRTOS.h"\r
 116 #include "task.h"\r
 117 #include "semphr.h"\r
 118 \r
 119 /* Demo app include files. */\r
 120 #include "semtest.h"\r
 121 #include "print.h"\r
 122 \r
 123 /* The value to which the shared variables are counted. */\r
 124 #define semtstBLOCKING_EXPECTED_VALUE           ( ( unsigned long ) 0xfff )\r
 125 #define semtstNON_BLOCKING_EXPECTED_VALUE       ( ( unsigned long ) 0xff  )\r
 126 \r
 127 #define semtstSTACK_SIZE                        configMINIMAL_STACK_SIZE\r
 128 \r
 129 #define semtstNUM_TASKS                         ( 4 )\r
 130 \r
 131 #define semtstDELAY_FACTOR                      ( ( TickType_t ) 10 )\r
 132 \r
 133 /* The task function as described at the top of the file. */\r
 134 static void prvSemaphoreTest( void *pvParameters );\r
 135 \r
 136 /* Structure used to pass parameters to each task. */\r
 137 typedef struct SEMAPHORE_PARAMETERS\r
 138 {\r
 139         SemaphoreHandle_t xSemaphore;\r
 140         volatile unsigned long *pulSharedVariable;\r
 141         TickType_t xBlockTime;\r
 142 } xSemaphoreParameters;\r
 143 \r
 144 /* Variables used to check that all the tasks are still running without errors. */\r
 145 static volatile short sCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 146 static volatile short sNextCheckVariable = 0;\r
 147 \r
 148 /* Strings to print if USE_STDIO is defined. */\r
 149 const char * const pcPollingSemaphoreTaskError = "Guarded shared variable in unexpected state.\r\n";\r
 150 const char * const pcSemaphoreTaskStart = "Guarded shared variable task started.\r\n";\r
 151 \r
 152 /*-----------------------------------------------------------*/\r
 153 \r
 154 void vStartSemaphoreTasks( unsigned portBASE_TYPE uxPriority )\r
 155 {\r
 156 xSemaphoreParameters *pxFirstSemaphoreParameters, *pxSecondSemaphoreParameters;\r
 157 const TickType_t xBlockTime = ( TickType_t ) 100;\r
 158 \r
 159         /* Create the structure used to pass parameters to the first two tasks. */\r
 160         pxFirstSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 161 \r
 162         if( pxFirstSemaphoreParameters != NULL )\r
 163         {\r
 164                 /* Create the semaphore used by the first two tasks. */\r
 165                 vSemaphoreCreateBinary( pxFirstSemaphoreParameters->xSemaphore );\r
 166 \r
 167                 if( pxFirstSemaphoreParameters->xSemaphore != NULL )\r
 168                 {\r
 169                         /* Create the variable which is to be shared by the first two tasks. */\r
 170                         pxFirstSemaphoreParameters->pulSharedVariable = ( unsigned long * ) pvPortMalloc( sizeof( unsigned long ) );\r
 171 \r
 172                         /* Initialise the share variable to the value the tasks expect. */\r
 173                         *( pxFirstSemaphoreParameters->pulSharedVariable ) = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 174 \r
 175                         /* The first two tasks do not block on semaphore calls. */\r
 176                         pxFirstSemaphoreParameters->xBlockTime = ( TickType_t ) 0;\r
 177 \r
 178                         /* Spawn the first two tasks.  As they poll they operate at the idle priority. */\r
 179                         xTaskCreate( prvSemaphoreTest, "PolSEM1", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( TaskHandle_t * ) NULL );\r
 180                         xTaskCreate( prvSemaphoreTest, "PolSEM2", semtstSTACK_SIZE, ( void * ) pxFirstSemaphoreParameters, tskIDLE_PRIORITY, ( TaskHandle_t * ) NULL );\r
 181                 }\r
 182         }\r
 183 \r
 184         /* Do exactly the same to create the second set of tasks, only this time \r
 185         provide a block time for the semaphore calls. */\r
 186         pxSecondSemaphoreParameters = ( xSemaphoreParameters * ) pvPortMalloc( sizeof( xSemaphoreParameters ) );\r
 187         if( pxSecondSemaphoreParameters != NULL )\r
 188         {\r
 189                 vSemaphoreCreateBinary( pxSecondSemaphoreParameters->xSemaphore );\r
 190 \r
 191                 if( pxSecondSemaphoreParameters->xSemaphore != NULL )\r
 192                 {\r
 193                         pxSecondSemaphoreParameters->pulSharedVariable = ( unsigned long * ) pvPortMalloc( sizeof( unsigned long ) );\r
 194                         *( pxSecondSemaphoreParameters->pulSharedVariable ) = semtstBLOCKING_EXPECTED_VALUE;\r
 195                         pxSecondSemaphoreParameters->xBlockTime = xBlockTime / portTICK_PERIOD_MS;\r
 196 \r
 197                         xTaskCreate( prvSemaphoreTest, "BlkSEM1", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( TaskHandle_t * ) NULL );\r
 198                         xTaskCreate( prvSemaphoreTest, "BlkSEM2", semtstSTACK_SIZE, ( void * ) pxSecondSemaphoreParameters, uxPriority, ( TaskHandle_t * ) NULL );\r
 199                 }\r
 200         }\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 static void prvSemaphoreTest( void *pvParameters )\r
 205 {\r
 206 xSemaphoreParameters *pxParameters;\r
 207 volatile unsigned long *pulSharedVariable, ulExpectedValue;\r
 208 unsigned long ulCounter;\r
 209 short sError = pdFALSE, sCheckVariableToUse;\r
 210 \r
 211         /* See which check variable to use.  sNextCheckVariable is not semaphore \r
 212         protected! */\r
 213         portENTER_CRITICAL();\r
 214                 sCheckVariableToUse = sNextCheckVariable;\r
 215                 sNextCheckVariable++;\r
 216         portEXIT_CRITICAL();\r
 217 \r
 218         /* Queue a message for printing to say the task has started. */\r
 219         vPrintDisplayMessage( &pcSemaphoreTaskStart );\r
 220 \r
 221         /* A structure is passed in as the parameter.  This contains the shared \r
 222         variable being guarded. */\r
 223         pxParameters = ( xSemaphoreParameters * ) pvParameters;\r
 224         pulSharedVariable = pxParameters->pulSharedVariable;\r
 225 \r
 226         /* If we are blocking we use a much higher count to ensure loads of context\r
 227         switches occur during the count. */\r
 228         if( pxParameters->xBlockTime > ( TickType_t ) 0 )\r
 229         {\r
 230                 ulExpectedValue = semtstBLOCKING_EXPECTED_VALUE;\r
 231         }\r
 232         else\r
 233         {\r
 234                 ulExpectedValue = semtstNON_BLOCKING_EXPECTED_VALUE;\r
 235         }\r
 236 \r
 237         for( ;; )\r
 238         {\r
 239                 /* Try to obtain the semaphore. */\r
 240                 if( xSemaphoreTake( pxParameters->xSemaphore, pxParameters->xBlockTime ) == pdPASS )\r
 241                 {\r
 242                         /* We have the semaphore and so expect any other tasks using the\r
 243                         shared variable to have left it in the state we expect to find\r
 244                         it. */\r
 245                         if( *pulSharedVariable != ulExpectedValue )\r
 246                         {\r
 247                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 248                                 sError = pdTRUE;\r
 249                         }\r
 250                         \r
 251                         /* Clear the variable, then count it back up to the expected value\r
 252                         before releasing the semaphore.  Would expect a context switch or\r
 253                         two during this time. */\r
 254                         for( ulCounter = ( unsigned long ) 0; ulCounter <= ulExpectedValue; ulCounter++ )\r
 255                         {\r
 256                                 *pulSharedVariable = ulCounter;\r
 257                                 if( *pulSharedVariable != ulCounter )\r
 258                                 {\r
 259                                         if( sError == pdFALSE )\r
 260                                         {\r
 261                                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 262                                         }\r
 263                                         sError = pdTRUE;\r
 264                                 }\r
 265                         }\r
 266 \r
 267                         /* Release the semaphore, and if no errors have occurred increment the check\r
 268                         variable. */\r
 269                         if(     xSemaphoreGive( pxParameters->xSemaphore ) == pdFALSE )\r
 270                         {\r
 271                                 vPrintDisplayMessage( &pcPollingSemaphoreTaskError );\r
 272                                 sError = pdTRUE;\r
 273                         }\r
 274 \r
 275                         if( sError == pdFALSE )\r
 276                         {\r
 277                                 if( sCheckVariableToUse < semtstNUM_TASKS )\r
 278                                 {\r
 279                                         ( sCheckVariables[ sCheckVariableToUse ] )++;\r
 280                                 }\r
 281                         }\r
 282 \r
 283                         /* If we have a block time then we are running at a priority higher\r
 284                         than the idle priority.  This task takes a long time to complete\r
 285                         a cycle (deliberately so to test the guarding) so will be starving\r
 286                         out lower priority tasks.  Block for some time to allow give lower\r
 287                         priority tasks some processor time. */\r
 288                         vTaskDelay( pxParameters->xBlockTime * semtstDELAY_FACTOR );\r
 289                 }\r
 290                 else\r
 291                 {\r
 292                         if( pxParameters->xBlockTime == ( TickType_t ) 0 )\r
 293                         {\r
 294                                 /* We have not got the semaphore yet, so no point using the\r
 295                                 processor.  We are not blocking when attempting to obtain the\r
 296                                 semaphore. */\r
 297                                 taskYIELD();\r
 298                         }\r
 299                 }\r
 300         }\r
 301 }\r
 302 /*-----------------------------------------------------------*/\r
 303 \r
 304 /* This is called to check that all the created tasks are still running. */\r
 305 portBASE_TYPE xAreSemaphoreTasksStillRunning( void )\r
 306 {\r
 307 static short sLastCheckVariables[ semtstNUM_TASKS ] = { 0 };\r
 308 portBASE_TYPE xTask, xReturn = pdTRUE;\r
 309 \r
 310         for( xTask = 0; xTask < semtstNUM_TASKS; xTask++ )\r
 311         {\r
 312                 if( sLastCheckVariables[ xTask ] == sCheckVariables[ xTask ] )\r
 313                 {\r
 314                         xReturn = pdFALSE;\r
 315                 }\r
 316 \r
 317                 sLastCheckVariables[ xTask ] = sCheckVariables[ xTask ];\r
 318         }\r
 319 \r
 320         return xReturn;\r
 321 }\r
 322 \r
 323 \r