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

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