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

   1 /*\r
   2     FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76         The tasks defined on this page demonstrate the use of recursive mutexes.\r
  77 \r
  78         For recursive mutex functionality the created mutex should be created using\r
  79         xSemaphoreCreateRecursiveMutex(), then be manipulated\r
  80         using the xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() API\r
  81         functions.\r
  82 \r
  83         This demo creates three tasks all of which access the same recursive mutex:\r
  84 \r
  85         prvRecursiveMutexControllingTask() has the highest priority so executes \r
  86         first and grabs the mutex.  It then performs some recursive accesses - \r
  87         between each of which it sleeps for a short period to let the lower \r
  88         priority tasks execute.  When it has completed its demo functionality\r
  89         it gives the mutex back before suspending itself.\r
  90 \r
  91         prvRecursiveMutexBlockingTask() attempts to access the mutex by performing\r
  92         a blocking 'take'.  The blocking task has a lower priority than the \r
  93         controlling     task so by the time it executes the mutex has already been\r
  94         taken by the controlling task,  causing the blocking task to block.  It \r
  95         does not unblock until the controlling task has given the mutex back, \r
  96         and it does not actually run until the controlling task has suspended \r
  97         itself (due to the relative priorities).  When it eventually does obtain\r
  98         the mutex all it does is give the mutex back prior to also suspending \r
  99         itself.  At this point both the controlling task and the blocking task are \r
 100         suspended.\r
 101 \r
 102         prvRecursiveMutexPollingTask() runs at the idle priority.  It spins round\r
 103         a tight loop attempting to obtain the mutex with a non-blocking call.  As\r
 104         the lowest priority task it will not successfully obtain the mutex until\r
 105         both the controlling and blocking tasks are suspended.  Once it eventually \r
 106         does obtain the mutex it first unsuspends both the controlling task and\r
 107         blocking task prior to giving the mutex back - resulting in the polling\r
 108         task temporarily inheriting the controlling tasks priority.\r
 109 */\r
 110 \r
 111 /* Scheduler include files. */\r
 112 #include "FreeRTOS.h"\r
 113 #include "task.h"\r
 114 #include "semphr.h"\r
 115 \r
 116 /* Demo app include files. */\r
 117 #include "recmutex.h"\r
 118 \r
 119 /* Priorities assigned to the three tasks. */\r
 120 #define recmuCONTROLLING_TASK_PRIORITY  ( tskIDLE_PRIORITY + 2 )\r
 121 #define recmuBLOCKING_TASK_PRIORITY             ( tskIDLE_PRIORITY + 1 )\r
 122 #define recmuPOLLING_TASK_PRIORITY              ( tskIDLE_PRIORITY + 0 )\r
 123 \r
 124 /* The recursive call depth. */\r
 125 #define recmuMAX_COUNT                                  ( 10 )\r
 126 \r
 127 /* Misc. */\r
 128 #define recmuSHORT_DELAY                                ( 20 / portTICK_RATE_MS )\r
 129 #define recmuNO_DELAY                                   ( ( portTickType ) 0 )\r
 130 #define recmuTWO_TICK_DELAY                             ( ( portTickType ) 2 )\r
 131 \r
 132 /* The three tasks as described at the top of this file. */\r
 133 static void prvRecursiveMutexControllingTask( void *pvParameters );\r
 134 static void prvRecursiveMutexBlockingTask( void *pvParameters );\r
 135 static void prvRecursiveMutexPollingTask( void *pvParameters );\r
 136 \r
 137 /* The mutex used by the demo. */\r
 138 static xSemaphoreHandle xMutex;\r
 139 \r
 140 /* Variables used to detect and latch errors. */\r
 141 static volatile portBASE_TYPE xErrorOccurred = pdFALSE, xControllingIsSuspended = pdFALSE, xBlockingIsSuspended = pdFALSE;\r
 142 static volatile unsigned portBASE_TYPE uxControllingCycles = 0, uxBlockingCycles = 0, uxPollingCycles = 0;\r
 143 \r
 144 /* Handles of the two higher priority tasks, required so they can be resumed \r
 145 (unsuspended). */\r
 146 static xTaskHandle xControllingTaskHandle, xBlockingTaskHandle;\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 void vStartRecursiveMutexTasks( void )\r
 151 {\r
 152         /* Just creates the mutex and the three tasks. */\r
 153 \r
 154         xMutex = xSemaphoreCreateRecursiveMutex();\r
 155 \r
 156         /* vQueueAddToRegistry() adds the mutex to the registry, if one is\r
 157         in use.  The registry is provided as a means for kernel aware \r
 158         debuggers to locate mutex and has no purpose if a kernel aware debugger\r
 159         is not being used.  The call to vQueueAddToRegistry() will be removed\r
 160         by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is \r
 161         defined to be less than 1. */\r
 162         vQueueAddToRegistry( ( xQueueHandle ) xMutex, ( signed portCHAR * ) "Recursive_Mutex" );\r
 163 \r
 164 \r
 165         if( xMutex != NULL )\r
 166         {\r
 167                 xTaskCreate( prvRecursiveMutexControllingTask, ( signed portCHAR * ) "Rec1", configMINIMAL_STACK_SIZE, NULL, recmuCONTROLLING_TASK_PRIORITY, &xControllingTaskHandle );\r
 168         xTaskCreate( prvRecursiveMutexBlockingTask, ( signed portCHAR * ) "Rec2", configMINIMAL_STACK_SIZE, NULL, recmuBLOCKING_TASK_PRIORITY, &xBlockingTaskHandle );\r
 169         xTaskCreate( prvRecursiveMutexPollingTask, ( signed portCHAR * ) "Rec3", configMINIMAL_STACK_SIZE, NULL, recmuPOLLING_TASK_PRIORITY, NULL );\r
 170         }\r
 171 }\r
 172 /*-----------------------------------------------------------*/\r
 173 \r
 174 static void prvRecursiveMutexControllingTask( void *pvParameters )\r
 175 {\r
 176 unsigned portBASE_TYPE ux;\r
 177 \r
 178         /* Just to remove compiler warning. */\r
 179         ( void ) pvParameters;\r
 180 \r
 181         for( ;; )\r
 182         {\r
 183                 /* Should not be able to 'give' the mutex, as we have not yet 'taken'\r
 184                 it.   The first time through, the mutex will not have been used yet,\r
 185                 subsequent times through, at this point the mutex will be held by the\r
 186                 polling task. */\r
 187                 if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )\r
 188                 {\r
 189                         xErrorOccurred = pdTRUE;\r
 190                 }\r
 191 \r
 192                 for( ux = 0; ux < recmuMAX_COUNT; ux++ )\r
 193                 {\r
 194                         /* We should now be able to take the mutex as many times as\r
 195                         we like.\r
 196                         \r
 197                         The first time through the mutex will be immediately available, on\r
 198                         subsequent times through the mutex will be held by the polling task\r
 199                         at this point and this Take will cause the polling task to inherit\r
 200                         the priority of this task.  In this case the block time must be\r
 201                         long enough to ensure the polling task will execute again before the\r
 202                         block time expires.  If the block time does expire then the error\r
 203                         flag will be set here. */\r
 204                         if( xSemaphoreTakeRecursive( xMutex, recmuTWO_TICK_DELAY ) != pdPASS )\r
 205                         {\r
 206                                 xErrorOccurred = pdTRUE;\r
 207                         }\r
 208 \r
 209                         /* Ensure the other task attempting to access the mutex (and the\r
 210                         other demo tasks) are able to execute to ensure they either block\r
 211                         (where a block time is specified) or return an error (where no \r
 212                         block time is specified) as the mutex is held by this task. */\r
 213                         vTaskDelay( recmuSHORT_DELAY );\r
 214                 }\r
 215 \r
 216                 /* For each time we took the mutex, give it back. */\r
 217                 for( ux = 0; ux < recmuMAX_COUNT; ux++ )\r
 218                 {\r
 219                         /* Ensure the other task attempting to access the mutex (and the\r
 220                         other demo tasks) are able to execute. */\r
 221                         vTaskDelay( recmuSHORT_DELAY );\r
 222 \r
 223                         /* We should now be able to give the mutex as many times as we\r
 224                         took it.  When the mutex is available again the Blocking task\r
 225                         should be unblocked but not run because it has a lower priority\r
 226                         than this task.  The polling task should also not run at this point\r
 227                         as it too has a lower priority than this task. */\r
 228                         if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )\r
 229                         {\r
 230                                 xErrorOccurred = pdTRUE;\r
 231                         }\r
 232                 }\r
 233 \r
 234                 /* Having given it back the same number of times as it was taken, we\r
 235                 should no longer be the mutex owner, so the next give sh ould fail. */\r
 236                 if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )\r
 237                 {\r
 238                         xErrorOccurred = pdTRUE;\r
 239                 }\r
 240 \r
 241                 /* Keep count of the number of cycles this task has performed so a \r
 242                 stall can be detected. */\r
 243                 uxControllingCycles++;\r
 244 \r
 245                 /* Suspend ourselves to the blocking task can execute. */\r
 246                 xControllingIsSuspended = pdTRUE;\r
 247                 vTaskSuspend( NULL );\r
 248                 xControllingIsSuspended = pdFALSE;\r
 249         }\r
 250 }\r
 251 /*-----------------------------------------------------------*/\r
 252 \r
 253 static void prvRecursiveMutexBlockingTask( void *pvParameters )\r
 254 {\r
 255         /* Just to remove compiler warning. */\r
 256         ( void ) pvParameters;\r
 257 \r
 258         for( ;; )\r
 259         {\r
 260                 /* This task will run while the controlling task is blocked, and the\r
 261                 controlling task will block only once it has the mutex - therefore\r
 262                 this call should block until the controlling task has given up the \r
 263                 mutex, and not actually execute past this call until the controlling \r
 264                 task is suspended. */\r
 265                 if( xSemaphoreTakeRecursive( xMutex, portMAX_DELAY ) == pdPASS )\r
 266                 {\r
 267                         if( xControllingIsSuspended != pdTRUE )\r
 268                         {\r
 269                                 /* Did not expect to execute until the controlling task was\r
 270                                 suspended. */\r
 271                                 xErrorOccurred = pdTRUE;\r
 272                         }\r
 273                         else\r
 274                         {\r
 275                                 /* Give the mutex back before suspending ourselves to allow\r
 276                                 the polling task to obtain the mutex. */\r
 277                                 if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )\r
 278                                 {\r
 279                                         xErrorOccurred = pdTRUE;\r
 280                                 }\r
 281 \r
 282                                 xBlockingIsSuspended = pdTRUE;\r
 283                                 vTaskSuspend( NULL );\r
 284                                 xBlockingIsSuspended = pdFALSE;\r
 285                         }\r
 286                 }\r
 287                 else\r
 288                 {\r
 289                         /* We should not leave the xSemaphoreTakeRecursive() function\r
 290                         until the mutex was obtained. */\r
 291                         xErrorOccurred = pdTRUE;\r
 292                 }\r
 293 \r
 294                 /* The controlling and blocking tasks should be in lock step. */\r
 295                 if( uxControllingCycles != ( uxBlockingCycles + 1 ) )\r
 296                 {\r
 297                         xErrorOccurred = pdTRUE;\r
 298                 }\r
 299 \r
 300                 /* Keep count of the number of cycles this task has performed so a \r
 301                 stall can be detected. */\r
 302                 uxBlockingCycles++;\r
 303         }\r
 304 }\r
 305 /*-----------------------------------------------------------*/\r
 306 \r
 307 static void prvRecursiveMutexPollingTask( void *pvParameters )\r
 308 {\r
 309         /* Just to remove compiler warning. */\r
 310         ( void ) pvParameters;\r
 311 \r
 312         for( ;; )\r
 313         {\r
 314                 /* Keep attempting to obtain the mutex.  We should only obtain it when\r
 315                 the blocking task has suspended itself, which in turn should only\r
 316                 happen when the controlling task is also suspended. */\r
 317                 if( xSemaphoreTakeRecursive( xMutex, recmuNO_DELAY ) == pdPASS )\r
 318                 {\r
 319                         /* Is the blocking task suspended? */\r
 320                         if( ( xBlockingIsSuspended != pdTRUE ) || ( xControllingIsSuspended != pdTRUE ) )\r
 321                         {\r
 322                                 xErrorOccurred = pdTRUE;\r
 323                         }\r
 324                         else\r
 325                         {\r
 326                                 /* Keep count of the number of cycles this task has performed \r
 327                                 so a stall can be detected. */\r
 328                                 uxPollingCycles++;\r
 329 \r
 330                                 /* We can resume the other tasks here even though they have a\r
 331                                 higher priority than the polling task.  When they execute they\r
 332                                 will attempt to obtain the mutex but fail because the polling\r
 333                                 task is still the mutex holder.  The polling task (this task)\r
 334                                 will then inherit the higher priority.  The Blocking task will\r
 335                                 block indefinitely when it attempts to obtain the mutex, the\r
 336                                 Controlling task will only block for a fixed period and an\r
 337                                 error will be latched if the polling task has not returned the\r
 338                                 mutex by the time this fixed period has expired. */\r
 339                                 vTaskResume( xBlockingTaskHandle );\r
 340                 vTaskResume( xControllingTaskHandle );\r
 341                         \r
 342                                 /* The other two tasks should now have executed and no longer\r
 343                                 be suspended. */\r
 344                                 if( ( xBlockingIsSuspended == pdTRUE ) || ( xControllingIsSuspended == pdTRUE ) )\r
 345                                 {\r
 346                                         xErrorOccurred = pdTRUE;\r
 347                                 }                               \r
 348                         \r
 349                                 /* Release the mutex, disinheriting the higher priority again. */\r
 350                                 if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )\r
 351                                 {\r
 352                                         xErrorOccurred = pdTRUE;\r
 353                                 }\r
 354                         }\r
 355                 }\r
 356 \r
 357                 #if configUSE_PREEMPTION == 0\r
 358                 {\r
 359                         taskYIELD();\r
 360                 }\r
 361                 #endif\r
 362         }\r
 363 }\r
 364 /*-----------------------------------------------------------*/\r
 365 \r
 366 /* This is called to check that all the created tasks are still running. */\r
 367 portBASE_TYPE xAreRecursiveMutexTasksStillRunning( void )\r
 368 {\r
 369 portBASE_TYPE xReturn;\r
 370 static unsigned portBASE_TYPE uxLastControllingCycles = 0, uxLastBlockingCycles = 0, uxLastPollingCycles = 0;\r
 371 \r
 372         /* Is the controlling task still cycling? */\r
 373         if( uxLastControllingCycles == uxControllingCycles )\r
 374         {\r
 375                 xErrorOccurred = pdTRUE;\r
 376         }\r
 377         else\r
 378         {\r
 379                 uxLastControllingCycles = uxControllingCycles;\r
 380         }\r
 381 \r
 382         /* Is the blocking task still cycling? */\r
 383         if( uxLastBlockingCycles == uxBlockingCycles )\r
 384         {\r
 385                 xErrorOccurred = pdTRUE;\r
 386         }\r
 387         else\r
 388         {\r
 389                 uxLastBlockingCycles = uxBlockingCycles;\r
 390         }\r
 391 \r
 392         /* Is the polling task still cycling? */\r
 393         if( uxLastPollingCycles == uxPollingCycles )\r
 394         {\r
 395                 xErrorOccurred = pdTRUE;\r
 396         }\r
 397         else\r
 398         {\r
 399                 uxLastPollingCycles = uxPollingCycles;\r
 400         }\r
 401 \r
 402         if( xErrorOccurred == pdTRUE )\r
 403         {\r
 404                 xReturn = pdFAIL;\r
 405         }\r
 406         else\r
 407         {\r
 408                 xReturn = pdTRUE;\r
 409         }\r
 410 \r
 411         return xReturn;\r
 412 }\r
 413 \r
 414 \r
 415 \r
 416 \r