]> git.sur5r.net Git - freertos/blob - Demo/Common/Minimal/AltQTest.c
Add volatile qualifier to loop counters used to detect stalled tasks.
[freertos] / Demo / Common / Minimal / AltQTest.c
1 /*\r
2         FreeRTOS.org V5.0.0 - Copyright (C) 2003-2008 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     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
30     * and even write all or part of your application on your behalf.          *\r
31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
32     * expedite your project.                                                  *\r
33     *                                                                         *\r
34     ***************************************************************************\r
35     ***************************************************************************\r
36 \r
37         Please ensure to read the configuration and relevant port sections of the\r
38         online documentation.\r
39 \r
40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
41         contact details.\r
42 \r
43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
44         critical systems.\r
45 \r
46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
47         licensing and training services.\r
48 */\r
49 \r
50 \r
51 /* \r
52  * This file implements the same demo and test as GenQTest.c, but uses the \r
53  * light weight API in place of the fully featured API.\r
54  *\r
55  * See the comments at the top of GenQTest.c for a description.\r
56  */\r
57 \r
58 \r
59 #include <stdlib.h>\r
60 \r
61 /* Scheduler include files. */\r
62 #include "FreeRTOS.h"\r
63 #include "task.h"\r
64 #include "queue.h"\r
65 #include "semphr.h"\r
66 \r
67 /* Demo program include files. */\r
68 #include "AltQTest.h"\r
69 \r
70 #define genqQUEUE_LENGTH                ( 5 )\r
71 #define genqNO_BLOCK                    ( 0 )\r
72 \r
73 #define genqMUTEX_LOW_PRIORITY          ( tskIDLE_PRIORITY )\r
74 #define genqMUTEX_TEST_PRIORITY         ( tskIDLE_PRIORITY + 1 )\r
75 #define genqMUTEX_MEDIUM_PRIORITY       ( tskIDLE_PRIORITY + 2 )\r
76 #define genqMUTEX_HIGH_PRIORITY         ( tskIDLE_PRIORITY + 3 )\r
77 \r
78 /*-----------------------------------------------------------*/\r
79 \r
80 /*\r
81  * Tests the behaviour of the xQueueAltSendToFront() and xQueueAltSendToBack()\r
82  * macros by using both to fill a queue, then reading from the queue to\r
83  * check the resultant queue order is as expected.  Queue data is also\r
84  * peeked.\r
85  */\r
86 static void prvSendFrontAndBackTest( void *pvParameters );\r
87 \r
88 /*\r
89  * The following three tasks are used to demonstrate the mutex behaviour.\r
90  * Each task is given a different priority to demonstrate the priority\r
91  * inheritance mechanism.\r
92  *\r
93  * The low priority task obtains a mutex.  After this a high priority task\r
94  * attempts to obtain the same mutex, causing its priority to be inherited\r
95  * by the low priority task.  The task with the inherited high priority then\r
96  * resumes a medium priority task to ensure it is not blocked by the medium\r
97  * priority task while it holds the inherited high priority.  Once the mutex\r
98  * is returned the task with the inherited priority returns to its original\r
99  * low priority, and is therefore immediately preempted by first the high\r
100  * priority task and then the medium prioroity task before it can continue.\r
101  */\r
102 static void prvLowPriorityMutexTask( void *pvParameters );\r
103 static void prvMediumPriorityMutexTask( void *pvParameters );\r
104 static void prvHighPriorityMutexTask( void *pvParameters );\r
105 \r
106 /*-----------------------------------------------------------*/\r
107 \r
108 /* Flag that will be latched to pdTRUE should any unexpected behaviour be\r
109 detected in any of the tasks. */\r
110 static portBASE_TYPE xErrorDetected = pdFALSE;\r
111 \r
112 /* Counters that are incremented on each cycle of a test.  This is used to\r
113 detect a stalled task - a test that is no longer running. */\r
114 static volatile unsigned portLONG ulLoopCounter = 0;\r
115 static volatile unsigned portLONG ulLoopCounter2 = 0;\r
116 \r
117 /* The variable that is guarded by the mutex in the mutex demo tasks. */\r
118 static volatile unsigned portLONG ulGuardedVariable = 0;\r
119 \r
120 /* Handles used in the mutext test to suspend and resume the high and medium\r
121 priority mutex test tasks. */\r
122 static xTaskHandle xHighPriorityMutexTask, xMediumPriorityMutexTask;\r
123 \r
124 /*-----------------------------------------------------------*/\r
125 \r
126 void vStartAltGenericQueueTasks( unsigned portBASE_TYPE uxPriority )\r
127 {\r
128 xQueueHandle xQueue;\r
129 xSemaphoreHandle xMutex;\r
130 \r
131         /* Create the queue that we are going to use for the\r
132         prvSendFrontAndBackTest demo. */\r
133         xQueue = xQueueCreate( genqQUEUE_LENGTH, sizeof( unsigned portLONG ) );\r
134 \r
135         /* Create the demo task and pass it the queue just created.  We are\r
136         passing the queue handle by value so it does not matter that it is\r
137         declared on the stack here. */\r
138         xTaskCreate( prvSendFrontAndBackTest, ( signed portCHAR * ) "FGenQ", configMINIMAL_STACK_SIZE, ( void * ) xQueue, uxPriority, NULL );\r
139 \r
140         /* Create the mutex used by the prvMutexTest task. */\r
141         xMutex = xSemaphoreCreateMutex();\r
142 \r
143         /* Create the mutex demo tasks and pass it the mutex just created.  We are\r
144         passing the mutex handle by value so it does not matter that it is declared\r
145         on the stack here. */\r
146         xTaskCreate( prvLowPriorityMutexTask, ( signed portCHAR * ) "FMuLow", configMINIMAL_STACK_SIZE, ( void * ) xMutex, genqMUTEX_LOW_PRIORITY, NULL );\r
147         xTaskCreate( prvMediumPriorityMutexTask, ( signed portCHAR * ) "FMuMed", configMINIMAL_STACK_SIZE, NULL, genqMUTEX_MEDIUM_PRIORITY, &xMediumPriorityMutexTask );\r
148         xTaskCreate( prvHighPriorityMutexTask, ( signed portCHAR * ) "FMuHigh", configMINIMAL_STACK_SIZE, ( void * ) xMutex, genqMUTEX_HIGH_PRIORITY, &xHighPriorityMutexTask );\r
149 }\r
150 /*-----------------------------------------------------------*/\r
151 \r
152 static void prvSendFrontAndBackTest( void *pvParameters )\r
153 {\r
154 unsigned portLONG ulData, ulData2;\r
155 xQueueHandle xQueue;\r
156 \r
157         #ifdef USE_STDIO\r
158         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
159         \r
160                 const portCHAR * const pcTaskStartMsg = "Alt queue SendToFront/SendToBack/Peek test started.\r\n";\r
161 \r
162                 /* Queue a message for printing to say the task has started. */\r
163                 vPrintDisplayMessage( &pcTaskStartMsg );\r
164         #endif\r
165 \r
166         xQueue = ( xQueueHandle ) pvParameters;\r
167 \r
168         for( ;; )\r
169         {\r
170                 /* The queue is empty, so sending an item to the back of the queue\r
171                 should have the same efect as sending it to the front of the queue.\r
172 \r
173                 First send to the front and check everything is as expected. */\r
174                 xQueueAltSendToFront( xQueue, ( void * ) &ulLoopCounter, genqNO_BLOCK );\r
175 \r
176                 if( uxQueueMessagesWaiting( xQueue ) != 1 )\r
177                 {\r
178                         xErrorDetected = pdTRUE;\r
179                 }\r
180 \r
181                 if( xQueueAltReceive( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != pdPASS )\r
182                 {\r
183                         xErrorDetected = pdTRUE;\r
184                 }\r
185 \r
186                 /* The data we sent to the queue should equal the data we just received\r
187                 from the queue. */\r
188                 if( ulLoopCounter != ulData )\r
189                 {\r
190                         xErrorDetected = pdTRUE;\r
191                 }\r
192 \r
193                 /* Then do the same, sending the data to the back, checking everything\r
194                 is as expected. */\r
195                 if( uxQueueMessagesWaiting( xQueue ) != 0 )\r
196                 {\r
197                         xErrorDetected = pdTRUE;\r
198                 }\r
199 \r
200                 xQueueAltSendToBack( xQueue, ( void * ) &ulLoopCounter, genqNO_BLOCK );\r
201 \r
202                 if( uxQueueMessagesWaiting( xQueue ) != 1 )\r
203                 {\r
204                         xErrorDetected = pdTRUE;\r
205                 }\r
206 \r
207                 if( xQueueAltReceive( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != pdPASS )\r
208                 {\r
209                         xErrorDetected = pdTRUE;\r
210                 }\r
211 \r
212                 if( uxQueueMessagesWaiting( xQueue ) != 0 )\r
213                 {\r
214                         xErrorDetected = pdTRUE;\r
215                 }\r
216 \r
217                 /* The data we sent to the queue should equal the data we just received\r
218                 from the queue. */\r
219                 if( ulLoopCounter != ulData )\r
220                 {\r
221                         xErrorDetected = pdTRUE;\r
222                 }\r
223 \r
224                 #if configUSE_PREEMPTION == 0\r
225                         taskYIELD();\r
226                 #endif\r
227 \r
228 \r
229 \r
230                 /* Place 2, 3, 4 into the queue, adding items to the back of the queue. */\r
231                 for( ulData = 2; ulData < 5; ulData++ )\r
232                 {\r
233                         xQueueAltSendToBack( xQueue, ( void * ) &ulData, genqNO_BLOCK );\r
234                 }\r
235 \r
236                 /* Now the order in the queue should be 2, 3, 4, with 2 being the first\r
237                 thing to be read out.  Now add 1 then 0 to the front of the queue. */\r
238                 if( uxQueueMessagesWaiting( xQueue ) != 3 )\r
239                 {\r
240                         xErrorDetected = pdTRUE;\r
241                 }\r
242                 ulData = 1;\r
243                 xQueueAltSendToFront( xQueue, ( void * ) &ulData, genqNO_BLOCK );\r
244                 ulData = 0;\r
245                 xQueueAltSendToFront( xQueue, ( void * ) &ulData, genqNO_BLOCK );\r
246 \r
247                 /* Now the queue should be full, and when we read the data out we\r
248                 should receive 0, 1, 2, 3, 4. */\r
249                 if( uxQueueMessagesWaiting( xQueue ) != 5 )\r
250                 {\r
251                         xErrorDetected = pdTRUE;\r
252                 }\r
253 \r
254                 if( xQueueAltSendToFront( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != errQUEUE_FULL )\r
255                 {\r
256                         xErrorDetected = pdTRUE;\r
257                 }\r
258 \r
259                 if( xQueueAltSendToBack( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != errQUEUE_FULL )\r
260                 {\r
261                         xErrorDetected = pdTRUE;\r
262                 }\r
263 \r
264                 #if configUSE_PREEMPTION == 0\r
265                         taskYIELD();\r
266                 #endif\r
267 \r
268                 /* Check the data we read out is in the expected order. */\r
269                 for( ulData = 0; ulData < genqQUEUE_LENGTH; ulData++ )\r
270                 {\r
271                         /* Try peeking the data first. */\r
272                         if( xQueueAltPeek( xQueue, &ulData2, genqNO_BLOCK ) != pdPASS )\r
273                         {\r
274                                 xErrorDetected = pdTRUE;\r
275                         }\r
276 \r
277                         if( ulData != ulData2 )\r
278                         {\r
279                                 xErrorDetected = pdTRUE;\r
280                         }\r
281                         \r
282 \r
283                         /* Now try receiving the data for real.  The value should be the\r
284                         same.  Clobber the value first so we know we really received it. */\r
285                         ulData2 = ~ulData2;\r
286                         if( xQueueAltReceive( xQueue, &ulData2, genqNO_BLOCK ) != pdPASS )\r
287                         {\r
288                                 xErrorDetected = pdTRUE;\r
289                         }\r
290 \r
291                         if( ulData != ulData2 )\r
292                         {\r
293                                 xErrorDetected = pdTRUE;\r
294                         }\r
295                 }\r
296 \r
297                 /* The queue should now be empty again. */\r
298                 if( uxQueueMessagesWaiting( xQueue ) != 0 )\r
299                 {\r
300                         xErrorDetected = pdTRUE;\r
301                 }\r
302 \r
303                 #if configUSE_PREEMPTION == 0\r
304                         taskYIELD();\r
305                 #endif\r
306 \r
307 \r
308                 /* Our queue is empty once more, add 10, 11 to the back. */\r
309                 ulData = 10;\r
310                 if( xQueueAltSendToBack( xQueue, &ulData, genqNO_BLOCK ) != pdPASS )\r
311                 {\r
312                         xErrorDetected = pdTRUE;\r
313                 }\r
314                 ulData = 11;\r
315                 if( xQueueAltSendToBack( xQueue, &ulData, genqNO_BLOCK ) != pdPASS )\r
316                 {\r
317                         xErrorDetected = pdTRUE;\r
318                 }\r
319 \r
320                 if( uxQueueMessagesWaiting( xQueue ) != 2 )\r
321                 {\r
322                         xErrorDetected = pdTRUE;\r
323                 }\r
324 \r
325                 /* Now we should have 10, 11 in the queue.  Add 7, 8, 9 to the\r
326                 front. */\r
327                 for( ulData = 9; ulData >= 7; ulData-- )\r
328                 {\r
329                         if( xQueueAltSendToFront( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != pdPASS )\r
330                         {\r
331                                 xErrorDetected = pdTRUE;\r
332                         }\r
333                 }\r
334 \r
335                 /* Now check that the queue is full, and that receiving data provides\r
336                 the expected sequence of 7, 8, 9, 10, 11. */\r
337                 if( uxQueueMessagesWaiting( xQueue ) != 5 )\r
338                 {\r
339                         xErrorDetected = pdTRUE;\r
340                 }\r
341 \r
342                 if( xQueueAltSendToFront( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != errQUEUE_FULL )\r
343                 {\r
344                         xErrorDetected = pdTRUE;\r
345                 }\r
346 \r
347                 if( xQueueAltSendToBack( xQueue, ( void * ) &ulData, genqNO_BLOCK ) != errQUEUE_FULL )\r
348                 {\r
349                         xErrorDetected = pdTRUE;\r
350                 }\r
351 \r
352                 #if configUSE_PREEMPTION == 0\r
353                         taskYIELD();\r
354                 #endif\r
355 \r
356                 /* Check the data we read out is in the expected order. */\r
357                 for( ulData = 7; ulData < ( 7 + genqQUEUE_LENGTH ); ulData++ )\r
358                 {\r
359                         if( xQueueAltReceive( xQueue, &ulData2, genqNO_BLOCK ) != pdPASS )\r
360                         {\r
361                                 xErrorDetected = pdTRUE;\r
362                         }\r
363 \r
364                         if( ulData != ulData2 )\r
365                         {\r
366                                 xErrorDetected = pdTRUE;\r
367                         }\r
368                 }\r
369 \r
370                 if( uxQueueMessagesWaiting( xQueue ) != 0 )\r
371                 {\r
372                         xErrorDetected = pdTRUE;\r
373                 }\r
374 \r
375                 ulLoopCounter++;\r
376         }\r
377 }\r
378 /*-----------------------------------------------------------*/\r
379 \r
380 static void prvLowPriorityMutexTask( void *pvParameters )\r
381 {\r
382 xSemaphoreHandle xMutex = ( xSemaphoreHandle ) pvParameters;\r
383 \r
384         #ifdef USE_STDIO\r
385         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
386         \r
387                 const portCHAR * const pcTaskStartMsg = "Fast mutex with priority inheritance test started.\r\n";\r
388 \r
389                 /* Queue a message for printing to say the task has started. */\r
390                 vPrintDisplayMessage( &pcTaskStartMsg );\r
391         #endif\r
392 \r
393         ( void ) pvParameters;\r
394 \r
395 \r
396         for( ;; )\r
397         {\r
398                 /* Take the mutex.  It should be available now. */\r
399                 if( xSemaphoreAltTake( xMutex, genqNO_BLOCK ) != pdPASS )\r
400                 {\r
401                         xErrorDetected = pdTRUE;\r
402                 }\r
403 \r
404                 /* Set our guarded variable to a known start value. */\r
405                 ulGuardedVariable = 0;\r
406 \r
407                 /* Our priority should be as per that assigned when the task was\r
408                 created. */\r
409                 if( uxTaskPriorityGet( NULL ) != genqMUTEX_LOW_PRIORITY )\r
410                 {\r
411                         xErrorDetected = pdTRUE;\r
412                 }\r
413 \r
414                 /* Now unsuspend the high priority task.  This will attempt to take the\r
415                 mutex, and block when it finds it cannot obtain it. */\r
416                 vTaskResume( xHighPriorityMutexTask );\r
417 \r
418                 /* We should now have inherited the prioritoy of the high priority task,\r
419                 as by now it will have attempted to get the mutex. */\r
420                 if( uxTaskPriorityGet( NULL ) != genqMUTEX_HIGH_PRIORITY )\r
421                 {\r
422                         xErrorDetected = pdTRUE;\r
423                 }\r
424 \r
425                 /* We can attempt to set our priority to the test priority - between the\r
426                 idle priority and the medium/high test priorities, but our actual\r
427                 prioroity should remain at the high priority. */\r
428                 vTaskPrioritySet( NULL, genqMUTEX_TEST_PRIORITY );\r
429                 if( uxTaskPriorityGet( NULL ) != genqMUTEX_HIGH_PRIORITY )\r
430                 {\r
431                         xErrorDetected = pdTRUE;\r
432                 }\r
433 \r
434                 /* Now unsuspend the medium priority task.  This should not run as our\r
435                 inherited priority is above that of the medium priority task. */\r
436                 vTaskResume( xMediumPriorityMutexTask );\r
437 \r
438                 /* If the did run then it will have incremented our guarded variable. */\r
439                 if( ulGuardedVariable != 0 )\r
440                 {\r
441                         xErrorDetected = pdTRUE;\r
442                 }\r
443 \r
444                 /* When we give back the semaphore our priority should be disinherited\r
445                 back to the priority to which we attempted to set ourselves.  This means\r
446                 that when the high priority task next blocks, the medium priority task\r
447                 should execute and increment the guarded variable.   When we next run\r
448                 both the high and medium priority tasks will have been suspended again. */\r
449                 if( xSemaphoreAltGive( xMutex ) != pdPASS )\r
450                 {\r
451                         xErrorDetected = pdTRUE;\r
452                 }\r
453 \r
454                 /* Check that the guarded variable did indeed increment... */\r
455                 if( ulGuardedVariable != 1 )\r
456                 {\r
457                         xErrorDetected = pdTRUE;\r
458                 }\r
459 \r
460                 /* ... and that our priority has been disinherited to\r
461                 genqMUTEX_TEST_PRIORITY. */\r
462                 if( uxTaskPriorityGet( NULL ) != genqMUTEX_TEST_PRIORITY )\r
463                 {\r
464                         xErrorDetected = pdTRUE;\r
465                 }\r
466 \r
467                 /* Set our priority back to our original priority ready for the next\r
468                 loop around this test. */\r
469                 vTaskPrioritySet( NULL, genqMUTEX_LOW_PRIORITY );\r
470 \r
471                 /* Just to show we are still running. */\r
472                 ulLoopCounter2++;\r
473 \r
474                 #if configUSE_PREEMPTION == 0\r
475                         taskYIELD();\r
476                 #endif          \r
477         }\r
478 }\r
479 /*-----------------------------------------------------------*/\r
480 \r
481 static void prvMediumPriorityMutexTask( void *pvParameters )\r
482 {\r
483         ( void ) pvParameters;\r
484 \r
485         for( ;; )\r
486         {\r
487                 /* The medium priority task starts by suspending itself.  The low\r
488                 priority task will unsuspend this task when required. */\r
489                 vTaskSuspend( NULL );\r
490 \r
491                 /* When this task unsuspends all it does is increment the guarded\r
492                 variable, this is so the low priority task knows that it has\r
493                 executed. */\r
494                 ulGuardedVariable++;\r
495         }\r
496 }\r
497 /*-----------------------------------------------------------*/\r
498 \r
499 static void prvHighPriorityMutexTask( void *pvParameters )\r
500 {\r
501 xSemaphoreHandle xMutex = ( xSemaphoreHandle ) pvParameters;\r
502 \r
503         ( void ) pvParameters;\r
504 \r
505         for( ;; )\r
506         {\r
507                 /* The high priority task starts by suspending itself.  The low\r
508                 priority task will unsuspend this task when required. */\r
509                 vTaskSuspend( NULL );\r
510 \r
511                 /* When this task unsuspends all it does is attempt to obtain\r
512                 the mutex.  It should find the mutex is not available so a\r
513                 block time is specified. */\r
514                 if( xSemaphoreAltTake( xMutex, portMAX_DELAY ) != pdPASS )\r
515                 {\r
516                         xErrorDetected = pdTRUE;\r
517                 }\r
518 \r
519                 /* When we eventually obtain the mutex we just give it back then\r
520                 return to suspend ready for the next test. */\r
521                 if( xSemaphoreAltGive( xMutex ) != pdPASS )\r
522                 {\r
523                         xErrorDetected = pdTRUE;\r
524                 }               \r
525         }\r
526 }\r
527 /*-----------------------------------------------------------*/\r
528 \r
529 /* This is called to check that all the created tasks are still running. */\r
530 portBASE_TYPE xAreAltGenericQueueTasksStillRunning( void )\r
531 {\r
532 static unsigned portLONG ulLastLoopCounter = 0, ulLastLoopCounter2 = 0;\r
533 \r
534         /* If the demo task is still running then we expect the loopcounters to\r
535         have incremented since this function was last called. */\r
536         if( ulLastLoopCounter == ulLoopCounter )\r
537         {\r
538                 xErrorDetected = pdTRUE;\r
539         }\r
540 \r
541         if( ulLastLoopCounter2 == ulLoopCounter2 )\r
542         {\r
543                 xErrorDetected = pdTRUE;\r
544         }\r
545 \r
546         ulLastLoopCounter = ulLoopCounter;\r
547         ulLastLoopCounter2 = ulLoopCounter2;    \r
548 \r
549         /* Errors detected in the task itself will have latched xErrorDetected\r
550         to true. */\r
551 \r
552         return !xErrorDetected;\r
553 }\r
554 \r
555 \r