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

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