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

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