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

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 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.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*\r
  29  * Creates six tasks that operate on three queues as follows:\r
  30  *\r
  31  * The first two tasks send and receive an incrementing number to/from a queue.\r
  32  * One task acts as a producer and the other as the consumer.  The consumer is a\r
  33  * higher priority than the producer and is set to block on queue reads.  The queue\r
  34  * only has space for one item - as soon as the producer posts a message on the\r
  35  * queue the consumer will unblock, pre-empt the producer, and remove the item.\r
  36  *\r
  37  * The second two tasks work the other way around.  Again the queue used only has\r
  38  * enough space for one item.  This time the consumer has a lower priority than the\r
  39  * producer.  The producer will try to post on the queue blocking when the queue is\r
  40  * full.  When the consumer wakes it will remove the item from the queue, causing\r
  41  * the producer to unblock, pre-empt the consumer, and immediately re-fill the\r
  42  * queue.\r
  43  *\r
  44  * The last two tasks use the same queue producer and consumer functions.  This time the queue has\r
  45  * enough space for lots of items and the tasks operate at the same priority.  The\r
  46  * producer will execute, placing items into the queue.  The consumer will start\r
  47  * executing when either the queue becomes full (causing the producer to block) or\r
  48  * a context switch occurs (tasks of the same priority will time slice).\r
  49  *\r
  50  */\r
  51 \r
  52 #include <stdlib.h>\r
  53 \r
  54 /* Scheduler include files. */\r
  55 #include "FreeRTOS.h"\r
  56 #include "task.h"\r
  57 #include "queue.h"\r
  58 \r
  59 /* Demo program include files. */\r
  60 #include "BlockQ.h"\r
  61 \r
  62 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
  63 #define blckqNUM_TASK_SETS      ( 3 )\r
  64 \r
  65 #if( configSUPPORT_DYNAMIC_ALLOCATION == 0 )\r
  66         #error This example cannot be used if dynamic allocation is not allowed.\r
  67 #endif\r
  68 \r
  69 /* Structure used to pass parameters to the blocking queue tasks. */\r
  70 typedef struct BLOCKING_QUEUE_PARAMETERS\r
  71 {\r
  72         QueueHandle_t xQueue;                                   /*< The queue to be used by the task. */\r
  73         TickType_t xBlockTime;                          /*< The block time to use on queue reads/writes. */\r
  74         volatile short *psCheckVariable;        /*< Incremented on each successful cycle to check the task is still running. */\r
  75 } xBlockingQueueParameters;\r
  76 \r
  77 /* Task function that creates an incrementing number and posts it on a queue. */\r
  78 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
  79 \r
  80 /* Task function that removes the incrementing number from a queue and checks that\r
  81 it is the expected number. */\r
  82 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
  83 \r
  84 /* Variables which are incremented each time an item is removed from a queue, and\r
  85 found to be the expected value.\r
  86 These are used to check that the tasks are still running. */\r
  87 static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
  88 \r
  89 /* Variable which are incremented each time an item is posted on a queue.   These\r
  90 are used to check that the tasks are still running. */\r
  91 static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
  92 \r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95 void vStartBlockingQueueTasks( UBaseType_t uxPriority )\r
  96 {\r
  97 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
  98 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
  99 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 100 const UBaseType_t uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 101 const TickType_t xBlockTime = pdMS_TO_TICKS( ( TickType_t ) 1000 );\r
 102 const TickType_t xDontBlock = ( TickType_t ) 0;\r
 103 \r
 104         /* Create the first two tasks as described at the top of the file. */\r
 105 \r
 106         /* First create the structure used to pass parameters to the consumer tasks. */\r
 107         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 108 \r
 109         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 110         Pass a pointer to the queue in the parameter structure. */\r
 111         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( UBaseType_t ) sizeof( uint16_t ) );\r
 112 \r
 113         /* The consumer is created first so gets a block time as described above. */\r
 114         pxQueueParameters1->xBlockTime = xBlockTime;\r
 115 \r
 116         /* Pass in the variable that this task is going to increment so we can check it\r
 117         is still running. */\r
 118         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 119 \r
 120         /* Create the structure used to pass parameters to the producer task. */\r
 121         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 122 \r
 123         /* Pass the queue to this task also, using the parameter structure. */\r
 124         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 125 \r
 126         /* The producer is not going to block - as soon as it posts the consumer will\r
 127         wake and remove the item so the producer should always have room to post. */\r
 128         pxQueueParameters2->xBlockTime = xDontBlock;\r
 129 \r
 130         /* Pass in the variable that this task is going to increment so we can check\r
 131         it is still running. */\r
 132         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 133 \r
 134 \r
 135         /* Note the producer has a lower priority than the consumer when the tasks are\r
 136         spawned. */\r
 137         xTaskCreate( vBlockingQueueConsumer, "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 138         xTaskCreate( vBlockingQueueProducer, "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 139 \r
 140 \r
 141 \r
 142         /* Create the second two tasks as described at the top of the file.   This uses\r
 143         the same mechanism but reverses the task priorities. */\r
 144 \r
 145         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 146         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( UBaseType_t ) sizeof( uint16_t ) );\r
 147         pxQueueParameters3->xBlockTime = xDontBlock;\r
 148         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 149 \r
 150         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 151         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 152         pxQueueParameters4->xBlockTime = xBlockTime;\r
 153         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 154 \r
 155         xTaskCreate( vBlockingQueueConsumer, "QConsB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 156         xTaskCreate( vBlockingQueueProducer, "QProdB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 157 \r
 158 \r
 159 \r
 160         /* Create the last two tasks as described above.  The mechanism is again just\r
 161         the same.  This time both parameter structures are given a block time. */\r
 162         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 163         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( UBaseType_t ) sizeof( uint16_t ) );\r
 164         pxQueueParameters5->xBlockTime = xBlockTime;\r
 165         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 166 \r
 167         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 168         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 169         pxQueueParameters6->xBlockTime = xBlockTime;\r
 170         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] );\r
 171 \r
 172         xTaskCreate( vBlockingQueueProducer, "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 173         xTaskCreate( vBlockingQueueConsumer, "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 178 {\r
 179 uint16_t usValue = 0;\r
 180 xBlockingQueueParameters *pxQueueParameters;\r
 181 short sErrorEverOccurred = pdFALSE;\r
 182 \r
 183         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 184 \r
 185         for( ;; )\r
 186         {\r
 187                 if( xQueueSend( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 188                 {\r
 189                         sErrorEverOccurred = pdTRUE;\r
 190                 }\r
 191                 else\r
 192                 {\r
 193                         /* We have successfully posted a message, so increment the variable\r
 194                         used to check we are still running. */\r
 195                         if( sErrorEverOccurred == pdFALSE )\r
 196                         {\r
 197                                 ( *pxQueueParameters->psCheckVariable )++;\r
 198                         }\r
 199 \r
 200                         /* Increment the variable we are going to post next time round.  The\r
 201                         consumer will expect the numbers to     follow in numerical order. */\r
 202                         ++usValue;\r
 203 \r
 204                         #if configUSE_PREEMPTION == 0\r
 205                                 taskYIELD();\r
 206                         #endif\r
 207                 }\r
 208         }\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 213 {\r
 214 uint16_t usData, usExpectedValue = 0;\r
 215 xBlockingQueueParameters *pxQueueParameters;\r
 216 short sErrorEverOccurred = pdFALSE;\r
 217 \r
 218         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 219 \r
 220         for( ;; )\r
 221         {\r
 222                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 223                 {\r
 224                         if( usData != usExpectedValue )\r
 225                         {\r
 226                                 /* Catch-up. */\r
 227                                 usExpectedValue = usData;\r
 228 \r
 229                                 sErrorEverOccurred = pdTRUE;\r
 230                         }\r
 231                         else\r
 232                         {\r
 233                                 /* We have successfully received a message, so increment the\r
 234                                 variable used to check we are still running. */\r
 235                                 if( sErrorEverOccurred == pdFALSE )\r
 236                                 {\r
 237                                         ( *pxQueueParameters->psCheckVariable )++;\r
 238                                 }\r
 239 \r
 240                                 /* Increment the value we expect to remove from the queue next time\r
 241                                 round. */\r
 242                                 ++usExpectedValue;\r
 243                         }\r
 244 \r
 245                         #if configUSE_PREEMPTION == 0\r
 246                         {\r
 247                                 if( pxQueueParameters->xBlockTime == 0 )\r
 248                                 {\r
 249                                         taskYIELD();\r
 250                                 }\r
 251                         }\r
 252                         #endif\r
 253                 }\r
 254         }\r
 255 }\r
 256 /*-----------------------------------------------------------*/\r
 257 \r
 258 /* This is called to check that all the created tasks are still running. */\r
 259 BaseType_t xAreBlockingQueuesStillRunning( void )\r
 260 {\r
 261 static short sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 262 static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 263 BaseType_t xReturn = pdPASS, xTasks;\r
 264 \r
 265         /* Not too worried about mutual exclusion on these variables as they are 16\r
 266         bits and we are only reading them. We also only care to see if they have\r
 267         changed or not.\r
 268 \r
 269         Loop through each check variable to and return pdFALSE if any are found not\r
 270         to have changed since the last call. */\r
 271 \r
 272         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 273         {\r
 274                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 275                 {\r
 276                         xReturn = pdFALSE;\r
 277                 }\r
 278                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 279 \r
 280 \r
 281                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 282                 {\r
 283                         xReturn = pdFALSE;\r
 284                 }\r
 285                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 286         }\r
 287 \r
 288         return xReturn;\r
 289 }\r
 290 \r