]> begriffs open source - freertos/blob - FreeRTOS/Demo/Common/Minimal/death.c
Prepare for V7.3.0 release.
[freertos] / FreeRTOS / Demo / Common / Minimal / death.c
1 /*\r
2     FreeRTOS V7.3.0 - Copyright (C) 2012 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     >>>NOTE<<< The modification to the GPL is included to allow you to\r
33     distribute a combined work that includes FreeRTOS without being obliged to\r
34     provide the source code for proprietary components outside of the FreeRTOS\r
35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
38     more details. You should have received a copy of the GNU General Public\r
39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
41     by writing to Richard Barry, contact details for whom are available on the\r
42     FreeRTOS WEB site.\r
43 \r
44     1 tab == 4 spaces!\r
45     \r
46     ***************************************************************************\r
47      *                                                                       *\r
48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
49      *    not run, what could be wrong?"                                     *\r
50      *                                                                       *\r
51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
52      *                                                                       *\r
53     ***************************************************************************\r
54 \r
55     \r
56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
57     and contact details.  \r
58     \r
59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
60     including FreeRTOS+Trace - an indispensable productivity tool.\r
61 \r
62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
63     the code with commercial support, indemnification, and middleware, under \r
64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
65     provide a safety engineered and independently SIL3 certified version under \r
66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
67 */\r
68 \r
69 /**\r
70  * Create a single persistent task which periodically dynamically creates another\r
71  * two tasks.  The original task is called the creator task, the two tasks it\r
72  * creates are called suicidal tasks.\r
73  *\r
74  * One of the created suicidal tasks kill one other suicidal task before killing\r
75  * itself - leaving just the original task remaining.\r
76  *\r
77  * The creator task must be spawned after all of the other demo application tasks\r
78  * as it keeps a check on the number of tasks under the scheduler control.  The\r
79  * number of tasks it expects to see running should never be greater than the\r
80  * number of tasks that were in existence when the creator task was spawned, plus\r
81  * one set of four suicidal tasks.  If this number is exceeded an error is flagged.\r
82  *\r
83  * \page DeathC death.c\r
84  * \ingroup DemoFiles\r
85  * <HR>\r
86  */\r
87 \r
88 /*\r
89 Changes from V3.0.0\r
90         + CreationCount sizes changed from unsigned portBASE_TYPE to\r
91           unsigned short to minimize the risk of overflowing.\r
92         \r
93         + Reset of usLastCreationCount added\r
94         \r
95 Changes from V3.1.0\r
96         + Changed the dummy calculation to use variables of type long, rather than\r
97           float.  This allows the file to be used with ports that do not support\r
98           floating point.\r
99 \r
100 */\r
101 \r
102 #include <stdlib.h>\r
103 \r
104 /* Scheduler include files. */\r
105 #include "FreeRTOS.h"\r
106 #include "task.h"\r
107 \r
108 /* Demo program include files. */\r
109 #include "death.h"\r
110 \r
111 #define deathSTACK_SIZE         ( configMINIMAL_STACK_SIZE + 60 )\r
112 \r
113 /* The task originally created which is responsible for periodically dynamically\r
114 creating another four tasks. */\r
115 static portTASK_FUNCTION_PROTO( vCreateTasks, pvParameters );\r
116 \r
117 /* The task function of the dynamically created tasks. */\r
118 static portTASK_FUNCTION_PROTO( vSuicidalTask, pvParameters );\r
119 \r
120 /* A variable which is incremented every time the dynamic tasks are created.  This\r
121 is used to check that the task is still running. */\r
122 static volatile unsigned short usCreationCount = 0;\r
123 \r
124 /* Used to store the number of tasks that were originally running so the creator\r
125 task can tell if any of the suicidal tasks have failed to die.\r
126 */\r
127 static volatile unsigned portBASE_TYPE uxTasksRunningAtStart = 0;\r
128 \r
129 /* Tasks are deleted by the idle task.  Under heavy load the idle task might\r
130 not get much processing time, so it would be legitimate for several tasks to\r
131 remain undeleted for a short period. */\r
132 static const unsigned portBASE_TYPE uxMaxNumberOfExtraTasksRunning = 3;\r
133 \r
134 /* Used to store a handle to the task that should be killed by a suicidal task,\r
135 before it kills itself. */\r
136 xTaskHandle xCreatedTask;\r
137 \r
138 /*-----------------------------------------------------------*/\r
139 \r
140 void vCreateSuicidalTasks( unsigned portBASE_TYPE uxPriority )\r
141 {\r
142 unsigned portBASE_TYPE *puxPriority;\r
143 \r
144         /* Create the Creator tasks - passing in as a parameter the priority at which\r
145         the suicidal tasks should be created. */\r
146         puxPriority = ( unsigned portBASE_TYPE * ) pvPortMalloc( sizeof( unsigned portBASE_TYPE ) );\r
147         *puxPriority = uxPriority;\r
148 \r
149         xTaskCreate( vCreateTasks, ( signed char * ) "CREATOR", deathSTACK_SIZE, ( void * ) puxPriority, uxPriority, NULL );\r
150 \r
151         /* Record the number of tasks that are running now so we know if any of the\r
152         suicidal tasks have failed to be killed. */\r
153         uxTasksRunningAtStart = ( unsigned portBASE_TYPE ) uxTaskGetNumberOfTasks();\r
154         \r
155         /* FreeRTOS.org versions before V3.0 started the idle-task as the very\r
156         first task. The idle task was then already included in uxTasksRunningAtStart.\r
157         From FreeRTOS V3.0 on, the idle task is started when the scheduler is\r
158         started. Therefore the idle task is not yet accounted for. We correct\r
159         this by increasing uxTasksRunningAtStart by 1. */\r
160         uxTasksRunningAtStart++;\r
161         \r
162         /* From FreeRTOS version 7.0.0 can optionally create a timer service task.  \r
163         If this is done, then uxTasksRunningAtStart needs incrementing again as that\r
164         too is created when the scheduler is started. */\r
165         #if configUSE_TIMERS == 1\r
166                 uxTasksRunningAtStart++;\r
167         #endif\r
168 }\r
169 /*-----------------------------------------------------------*/\r
170                                         \r
171 static portTASK_FUNCTION( vSuicidalTask, pvParameters )\r
172 {\r
173 volatile long l1, l2;\r
174 xTaskHandle xTaskToKill;\r
175 const portTickType xDelay = ( portTickType ) 200 / portTICK_RATE_MS;\r
176 \r
177         if( pvParameters != NULL )\r
178         {\r
179                 /* This task is periodically created four times.  Two created tasks are\r
180                 passed a handle to the other task so it can kill it before killing itself.\r
181                 The other task is passed in null. */\r
182                 xTaskToKill = *( xTaskHandle* )pvParameters;\r
183         }\r
184         else\r
185         {\r
186                 xTaskToKill = NULL;\r
187         }\r
188 \r
189         for( ;; )\r
190         {\r
191                 /* Do something random just to use some stack and registers. */\r
192                 l1 = 2;\r
193                 l2 = 89;\r
194                 l2 *= l1;\r
195                 vTaskDelay( xDelay );\r
196 \r
197                 if( xTaskToKill != NULL )\r
198                 {\r
199                         /* Make sure the other task has a go before we delete it. */\r
200                         vTaskDelay( ( portTickType ) 0 );\r
201 \r
202                         /* Kill the other task that was created by vCreateTasks(). */\r
203                         vTaskDelete( xTaskToKill );\r
204 \r
205                         /* Kill ourselves. */\r
206                         vTaskDelete( NULL );\r
207                 }\r
208         }\r
209 }/*lint !e818 !e550 Function prototype must be as per standard for task functions. */\r
210 /*-----------------------------------------------------------*/\r
211 \r
212 static portTASK_FUNCTION( vCreateTasks, pvParameters )\r
213 {\r
214 const portTickType xDelay = ( portTickType ) 1000 / portTICK_RATE_MS;\r
215 unsigned portBASE_TYPE uxPriority;\r
216 \r
217         uxPriority = *( unsigned portBASE_TYPE * ) pvParameters;\r
218         vPortFree( pvParameters );\r
219 \r
220         for( ;; )\r
221         {\r
222                 /* Just loop round, delaying then creating the four suicidal tasks. */\r
223                 vTaskDelay( xDelay );\r
224 \r
225                 xCreatedTask = NULL;\r
226 \r
227                 xTaskCreate( vSuicidalTask, ( signed char * ) "SUICID1", configMINIMAL_STACK_SIZE, NULL, uxPriority, &xCreatedTask );\r
228                 xTaskCreate( vSuicidalTask, ( signed char * ) "SUICID2", configMINIMAL_STACK_SIZE, &xCreatedTask, uxPriority, NULL );\r
229 \r
230                 ++usCreationCount;\r
231         }\r
232 }\r
233 /*-----------------------------------------------------------*/\r
234 \r
235 /* This is called to check that the creator task is still running and that there\r
236 are not any more than four extra tasks. */\r
237 portBASE_TYPE xIsCreateTaskStillRunning( void )\r
238 {\r
239 static unsigned short usLastCreationCount = 0xfff;\r
240 portBASE_TYPE xReturn = pdTRUE;\r
241 static unsigned portBASE_TYPE uxTasksRunningNow;\r
242 \r
243         if( usLastCreationCount == usCreationCount )\r
244         {\r
245                 xReturn = pdFALSE;\r
246         }\r
247         else\r
248         {\r
249                 usLastCreationCount = usCreationCount;\r
250         }\r
251         \r
252         uxTasksRunningNow = ( unsigned portBASE_TYPE ) uxTaskGetNumberOfTasks();\r
253 \r
254         if( uxTasksRunningNow < uxTasksRunningAtStart )\r
255         {\r
256                 xReturn = pdFALSE;\r
257         }\r
258         else if( ( uxTasksRunningNow - uxTasksRunningAtStart ) > uxMaxNumberOfExtraTasksRunning )\r
259         {\r
260                 xReturn = pdFALSE;\r
261         }\r
262         else\r
263         {\r
264                 /* Everything is okay. */\r
265         }\r
266 \r
267         return xReturn;\r
268 }\r
269 \r
270 \r