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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 /*\r
  30         The tasks defined on this page demonstrate the use of recursive mutexes.\r
  31 \r
  32         For recursive mutex functionality the created mutex should be created using\r
  33         xSemaphoreCreateRecursiveMutex(), then be manipulated\r
  34         using the xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() API\r
  35         functions.\r
  36 \r
  37         This demo creates three tasks all of which access the same recursive mutex:\r
  38 \r
  39         prvRecursiveMutexControllingTask() has the highest priority so executes\r
  40         first and grabs the mutex.  It then performs some recursive accesses -\r
  41         between each of which it sleeps for a short period to let the lower\r
  42         priority tasks execute.  When it has completed its demo functionality\r
  43         it gives the mutex back before suspending itself.\r
  44 \r
  45         prvRecursiveMutexBlockingTask() attempts to access the mutex by performing\r
  46         a blocking 'take'.  The blocking task has a lower priority than the\r
  47         controlling     task so by the time it executes the mutex has already been\r
  48         taken by the controlling task,  causing the blocking task to block.  It\r
  49         does not unblock until the controlling task has given the mutex back,\r
  50         and it does not actually run until the controlling task has suspended\r
  51         itself (due to the relative priorities).  When it eventually does obtain\r
  52         the mutex all it does is give the mutex back prior to also suspending\r
  53         itself.  At this point both the controlling task and the blocking task are\r
  54         suspended.\r
  55 \r
  56         prvRecursiveMutexPollingTask() runs at the idle priority.  It spins round\r
  57         a tight loop attempting to obtain the mutex with a non-blocking call.  As\r
  58         the lowest priority task it will not successfully obtain the mutex until\r
  59         both the controlling and blocking tasks are suspended.  Once it eventually\r
  60         does obtain the mutex it first unsuspends both the controlling task and\r
  61         blocking task prior to giving the mutex back - resulting in the polling\r
  62         task temporarily inheriting the controlling tasks priority.\r
  63 */\r
  64 \r
  65 /* Scheduler include files. */\r
  66 #include "FreeRTOS.h"\r
  67 #include "task.h"\r
  68 #include "semphr.h"\r
  69 \r
  70 /* Demo app include files. */\r
  71 #include "recmutex.h"\r
  72 \r
  73 /* Priorities assigned to the three tasks.  recmuCONTROLLING_TASK_PRIORITY can\r
  74 be overridden by a definition in FreeRTOSConfig.h. */\r
  75 #ifndef recmuCONTROLLING_TASK_PRIORITY\r
  76         #define recmuCONTROLLING_TASK_PRIORITY  ( tskIDLE_PRIORITY + 2 )\r
  77 #endif\r
  78 #define recmuBLOCKING_TASK_PRIORITY             ( tskIDLE_PRIORITY + 1 )\r
  79 #define recmuPOLLING_TASK_PRIORITY              ( tskIDLE_PRIORITY + 0 )\r
  80 \r
  81 /* The recursive call depth. */\r
  82 #define recmuMAX_COUNT                                  ( 10 )\r
  83 \r
  84 /* Misc. */\r
  85 #define recmuSHORT_DELAY                                ( pdMS_TO_TICKS( 20 ) )\r
  86 #define recmuNO_DELAY                                   ( ( TickType_t ) 0 )\r
  87 #define recmu15ms_DELAY                                 ( pdMS_TO_TICKS( 15 ) )\r
  88 \r
  89 /* The three tasks as described at the top of this file. */\r
  90 static void prvRecursiveMutexControllingTask( void *pvParameters );\r
  91 static void prvRecursiveMutexBlockingTask( void *pvParameters );\r
  92 static void prvRecursiveMutexPollingTask( void *pvParameters );\r
  93 \r
  94 /* The mutex used by the demo. */\r
  95 static SemaphoreHandle_t xMutex;\r
  96 \r
  97 /* Variables used to detect and latch errors. */\r
  98 static volatile BaseType_t xErrorOccurred = pdFALSE, xControllingIsSuspended = pdFALSE, xBlockingIsSuspended = pdFALSE;\r
  99 static volatile UBaseType_t uxControllingCycles = 0, uxBlockingCycles = 0, uxPollingCycles = 0;\r
 100 \r
 101 /* Handles of the two higher priority tasks, required so they can be resumed\r
 102 (unsuspended). */\r
 103 static TaskHandle_t xControllingTaskHandle, xBlockingTaskHandle;\r
 104 \r
 105 /*-----------------------------------------------------------*/\r
 106 \r
 107 void vStartRecursiveMutexTasks( void )\r
 108 {\r
 109         /* Just creates the mutex and the three tasks. */\r
 110 \r
 111         xMutex = xSemaphoreCreateRecursiveMutex();\r
 112 \r
 113         if( xMutex != NULL )\r
 114         {\r
 115                 /* vQueueAddToRegistry() adds the mutex to the registry, if one is\r
 116                 in use.  The registry is provided as a means for kernel aware\r
 117                 debuggers to locate mutex and has no purpose if a kernel aware debugger\r
 118                 is not being used.  The call to vQueueAddToRegistry() will be removed\r
 119                 by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is\r
 120                 defined to be less than 1. */\r
 121                 vQueueAddToRegistry( ( QueueHandle_t ) xMutex, "Recursive_Mutex" );\r
 122 \r
 123                 xTaskCreate( prvRecursiveMutexControllingTask, "Rec1", configMINIMAL_STACK_SIZE, NULL, recmuCONTROLLING_TASK_PRIORITY, &xControllingTaskHandle );\r
 124                 xTaskCreate( prvRecursiveMutexBlockingTask, "Rec2", configMINIMAL_STACK_SIZE, NULL, recmuBLOCKING_TASK_PRIORITY, &xBlockingTaskHandle );\r
 125                 xTaskCreate( prvRecursiveMutexPollingTask, "Rec3", configMINIMAL_STACK_SIZE, NULL, recmuPOLLING_TASK_PRIORITY, NULL );\r
 126         }\r
 127 }\r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 static void prvRecursiveMutexControllingTask( void *pvParameters )\r
 131 {\r
 132 UBaseType_t ux;\r
 133 \r
 134         /* Just to remove compiler warning. */\r
 135         ( void ) pvParameters;\r
 136 \r
 137         for( ;; )\r
 138         {\r
 139                 /* Should not be able to 'give' the mutex, as we have not yet 'taken'\r
 140                 it.   The first time through, the mutex will not have been used yet,\r
 141                 subsequent times through, at this point the mutex will be held by the\r
 142                 polling task. */\r
 143                 if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )\r
 144                 {\r
 145                         xErrorOccurred = pdTRUE;\r
 146                 }\r
 147 \r
 148                 for( ux = 0; ux < recmuMAX_COUNT; ux++ )\r
 149                 {\r
 150                         /* We should now be able to take the mutex as many times as\r
 151                         we like.\r
 152 \r
 153                         The first time through the mutex will be immediately available, on\r
 154                         subsequent times through the mutex will be held by the polling task\r
 155                         at this point and this Take will cause the polling task to inherit\r
 156                         the priority of this task.  In this case the block time must be\r
 157                         long enough to ensure the polling task will execute again before the\r
 158                         block time expires.  If the block time does expire then the error\r
 159                         flag will be set here. */\r
 160                         if( xSemaphoreTakeRecursive( xMutex, recmu15ms_DELAY ) != pdPASS )\r
 161                         {\r
 162                                 xErrorOccurred = pdTRUE;\r
 163                         }\r
 164 \r
 165                         /* Ensure the other task attempting to access the mutex (and the\r
 166                         other demo tasks) are able to execute to ensure they either block\r
 167                         (where a block time is specified) or return an error (where no\r
 168                         block time is specified) as the mutex is held by this task. */\r
 169                         vTaskDelay( recmuSHORT_DELAY );\r
 170                 }\r
 171 \r
 172                 /* For each time we took the mutex, give it back. */\r
 173                 for( ux = 0; ux < recmuMAX_COUNT; ux++ )\r
 174                 {\r
 175                         /* Ensure the other task attempting to access the mutex (and the\r
 176                         other demo tasks) are able to execute. */\r
 177                         vTaskDelay( recmuSHORT_DELAY );\r
 178 \r
 179                         /* We should now be able to give the mutex as many times as we\r
 180                         took it.  When the mutex is available again the Blocking task\r
 181                         should be unblocked but not run because it has a lower priority\r
 182                         than this task.  The polling task should also not run at this point\r
 183                         as it too has a lower priority than this task. */\r
 184                         if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )\r
 185                         {\r
 186                                 xErrorOccurred = pdTRUE;\r
 187                         }\r
 188 \r
 189                         #if( configUSE_PREEMPTION == 0 )\r
 190                                 taskYIELD();\r
 191                         #endif\r
 192                 }\r
 193 \r
 194                 /* Having given it back the same number of times as it was taken, we\r
 195                 should no longer be the mutex owner, so the next give should fail. */\r
 196                 if( xSemaphoreGiveRecursive( xMutex ) == pdPASS )\r
 197                 {\r
 198                         xErrorOccurred = pdTRUE;\r
 199                 }\r
 200 \r
 201                 /* Keep count of the number of cycles this task has performed so a\r
 202                 stall can be detected. */\r
 203                 uxControllingCycles++;\r
 204 \r
 205                 /* Suspend ourselves so the blocking task can execute. */\r
 206                 xControllingIsSuspended = pdTRUE;\r
 207                 vTaskSuspend( NULL );\r
 208                 xControllingIsSuspended = pdFALSE;\r
 209         }\r
 210 }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213 static void prvRecursiveMutexBlockingTask( void *pvParameters )\r
 214 {\r
 215         /* Just to remove compiler warning. */\r
 216         ( void ) pvParameters;\r
 217 \r
 218         for( ;; )\r
 219         {\r
 220                 /* This task will run while the controlling task is blocked, and the\r
 221                 controlling task will block only once it has the mutex - therefore\r
 222                 this call should block until the controlling task has given up the\r
 223                 mutex, and not actually execute past this call until the controlling\r
 224                 task is suspended.  portMAX_DELAY - 1 is used instead of portMAX_DELAY\r
 225                 to ensure the task's state is reported as Blocked and not Suspended in\r
 226                 a later call to configASSERT() (within the polling task). */\r
 227                 if( xSemaphoreTakeRecursive( xMutex, ( portMAX_DELAY - 1 ) ) == pdPASS )\r
 228                 {\r
 229                         if( xControllingIsSuspended != pdTRUE )\r
 230                         {\r
 231                                 /* Did not expect to execute until the controlling task was\r
 232                                 suspended. */\r
 233                                 xErrorOccurred = pdTRUE;\r
 234                         }\r
 235                         else\r
 236                         {\r
 237                                 /* Give the mutex back before suspending ourselves to allow\r
 238                                 the polling task to obtain the mutex. */\r
 239                                 if( xSemaphoreGiveRecursive( xMutex ) != pdPASS )\r
 240                                 {\r
 241                                         xErrorOccurred = pdTRUE;\r
 242                                 }\r
 243 \r
 244                                 xBlockingIsSuspended = pdTRUE;\r
 245                                 vTaskSuspend( NULL );\r
 246                                 xBlockingIsSuspended = pdFALSE;\r
 247                         }\r
 248                 }\r
 249                 else\r
 250                 {\r
 251                         /* We should not leave the xSemaphoreTakeRecursive() function\r
 252                         until the mutex was obtained. */\r
 253                         xErrorOccurred = pdTRUE;\r
 254                 }\r
 255 \r
 256                 /* The controlling and blocking tasks should be in lock step. */\r
 257                 if( uxControllingCycles != ( uxBlockingCycles + 1 ) )\r
 258                 {\r
 259                         xErrorOccurred = pdTRUE;\r
 260                 }\r
 261 \r
 262                 /* Keep count of the number of cycles this task has performed so a\r
 263                 stall can be detected. */\r
 264                 uxBlockingCycles++;\r
 265         }\r
 266 }\r
 267 /*-----------------------------------------------------------*/\r
 268 \r
 269 static void prvRecursiveMutexPollingTask( void *pvParameters )\r
 270 {\r
 271         /* Just to remove compiler warning. */\r
 272         ( void ) pvParameters;\r
 273 \r
 274         for( ;; )\r
 275         {\r
 276                 /* Keep attempting to obtain the mutex.  It should only be obtained when\r
 277                 the blocking task has suspended itself, which in turn should only\r
 278                 happen when the controlling task is also suspended. */\r
 279                 if( xSemaphoreTakeRecursive( xMutex, recmuNO_DELAY ) == pdPASS )\r
 280                 {\r
 281                         #if( INCLUDE_eTaskGetState == 1 )\r
 282                         {\r
 283                                 configASSERT( eTaskGetState( xControllingTaskHandle ) == eSuspended );\r
 284                                 configASSERT( eTaskGetState( xBlockingTaskHandle ) == eSuspended );\r
 285                         }\r
 286                         #endif /* INCLUDE_eTaskGetState */\r
 287 \r
 288                         /* Is the blocking task suspended? */\r
 289                         if( ( xBlockingIsSuspended != pdTRUE ) || ( xControllingIsSuspended != pdTRUE ) )\r
 290                         {\r
 291                                 xErrorOccurred = pdTRUE;\r
 292                         }\r
 293                         else\r
 294                         {\r
 295                                 /* Keep count of the number of cycles this task has performed\r
 296                                 so a stall can be detected. */\r
 297                                 uxPollingCycles++;\r
 298 \r
 299                                 /* We can resume the other tasks here even though they have a\r
 300                                 higher priority than the polling task.  When they execute they\r
 301                                 will attempt to obtain the mutex but fail because the polling\r
 302                                 task is still the mutex holder.  The polling task (this task)\r
 303                                 will then inherit the higher priority.  The Blocking task will\r
 304                                 block indefinitely when it attempts to obtain the mutex, the\r
 305                                 Controlling task will only block for a fixed period and an\r
 306                                 error will be latched if the polling task has not returned the\r
 307                                 mutex by the time this fixed period has expired. */\r
 308                                 vTaskResume( xBlockingTaskHandle );\r
 309                                 #if( configUSE_PREEMPTION == 0 )\r
 310                                         taskYIELD();\r
 311                                 #endif\r
 312 \r
 313                                 vTaskResume( xControllingTaskHandle );\r
 314                                 #if( configUSE_PREEMPTION == 0 )\r
 315                                         taskYIELD();\r
 316                                 #endif\r
 317 \r
 318                                 /* The other two tasks should now have executed and no longer\r
 319                                 be suspended. */\r
 320                                 if( ( xBlockingIsSuspended == pdTRUE ) || ( xControllingIsSuspended == pdTRUE ) )\r
 321                                 {\r
 322                                         xErrorOccurred = pdTRUE;\r
 323                                 }\r
 324 \r
 325                                 #if( INCLUDE_uxTaskPriorityGet == 1 )\r
 326                                 {\r
 327                                         /* Check priority inherited. */\r
 328                                         configASSERT( uxTaskPriorityGet( NULL ) == recmuCONTROLLING_TASK_PRIORITY );\r
 329                                 }\r
 330                                 #endif /* INCLUDE_uxTaskPriorityGet */\r
 331 \r
 332                                 #if( INCLUDE_eTaskGetState == 1 )\r
 333                                 {\r
 334                                         configASSERT( eTaskGetState( xControllingTaskHandle ) == eBlocked );\r
 335                                         configASSERT( eTaskGetState( xBlockingTaskHandle ) == eBlocked );\r
 336                                 }\r
 337                                 #endif /* INCLUDE_eTaskGetState */\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                                 #if( INCLUDE_uxTaskPriorityGet == 1 )\r
 346                                 {\r
 347                                         /* Check priority disinherited. */\r
 348                                         configASSERT( uxTaskPriorityGet( NULL ) == recmuPOLLING_TASK_PRIORITY );\r
 349                                 }\r
 350                                 #endif /* INCLUDE_uxTaskPriorityGet */\r
 351                         }\r
 352                 }\r
 353 \r
 354                 #if configUSE_PREEMPTION == 0\r
 355                 {\r
 356                         taskYIELD();\r
 357                 }\r
 358                 #endif\r
 359         }\r
 360 }\r
 361 /*-----------------------------------------------------------*/\r
 362 \r
 363 /* This is called to check that all the created tasks are still running. */\r
 364 BaseType_t xAreRecursiveMutexTasksStillRunning( void )\r
 365 {\r
 366 BaseType_t xReturn;\r
 367 static UBaseType_t uxLastControllingCycles = 0, uxLastBlockingCycles = 0, uxLastPollingCycles = 0;\r
 368 \r
 369         /* Is the controlling task still cycling? */\r
 370         if( uxLastControllingCycles == uxControllingCycles )\r
 371         {\r
 372                 xErrorOccurred = pdTRUE;\r
 373         }\r
 374         else\r
 375         {\r
 376                 uxLastControllingCycles = uxControllingCycles;\r
 377         }\r
 378 \r
 379         /* Is the blocking task still cycling? */\r
 380         if( uxLastBlockingCycles == uxBlockingCycles )\r
 381         {\r
 382                 xErrorOccurred = pdTRUE;\r
 383         }\r
 384         else\r
 385         {\r
 386                 uxLastBlockingCycles = uxBlockingCycles;\r
 387         }\r
 388 \r
 389         /* Is the polling task still cycling? */\r
 390         if( uxLastPollingCycles == uxPollingCycles )\r
 391         {\r
 392                 xErrorOccurred = pdTRUE;\r
 393         }\r
 394         else\r
 395         {\r
 396                 uxLastPollingCycles = uxPollingCycles;\r
 397         }\r
 398 \r
 399         if( xErrorOccurred == pdTRUE )\r
 400         {\r
 401                 xReturn = pdFAIL;\r
 402         }\r
 403         else\r
 404         {\r
 405                 xReturn = pdPASS;\r
 406         }\r
 407 \r
 408         return xReturn;\r
 409 }\r
 410 \r
 411 \r
 412 \r
 413 \r