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

   1 /*\r
   2         FreeRTOS.org V5.1.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  * Create a single persistent task which periodically dynamically creates another\r
  52  * two tasks.  The original task is called the creator task, the two tasks it\r
  53  * creates are called suicidal tasks.\r
  54  *\r
  55  * One of the created suicidal tasks kill one other suicidal task before killing\r
  56  * itself - leaving just the original task remaining.\r
  57  *\r
  58  * The creator task must be spawned after all of the other demo application tasks\r
  59  * as it keeps a check on the number of tasks under the scheduler control.  The\r
  60  * number of tasks it expects to see running should never be greater than the\r
  61  * number of tasks that were in existence when the creator task was spawned, plus\r
  62  * one set of four suicidal tasks.  If this number is exceeded an error is flagged.\r
  63  *\r
  64  * \page DeathC death.c\r
  65  * \ingroup DemoFiles\r
  66  * <HR>\r
  67  */\r
  68 \r
  69 /*\r
  70 Changes from V3.0.0\r
  71         + CreationCount sizes changed from unsigned portBASE_TYPE to\r
  72           unsigned portSHORT to minimize the risk of overflowing.\r
  73         \r
  74         + Reset of usLastCreationCount added\r
  75         \r
  76 Changes from V3.1.0\r
  77         + Changed the dummy calculation to use variables of type long, rather than\r
  78           float.  This allows the file to be used with ports that do not support\r
  79           floating point.\r
  80 \r
  81 */\r
  82 \r
  83 #include <stdlib.h>\r
  84 \r
  85 /* Scheduler include files. */\r
  86 #include "FreeRTOS.h"\r
  87 #include "task.h"\r
  88 \r
  89 /* Demo program include files. */\r
  90 #include "death.h"\r
  91 \r
  92 #define deathSTACK_SIZE         ( configMINIMAL_STACK_SIZE + 60 )\r
  93 \r
  94 /* The task originally created which is responsible for periodically dynamically\r
  95 creating another four tasks. */\r
  96 static portTASK_FUNCTION_PROTO( vCreateTasks, pvParameters );\r
  97 \r
  98 /* The task function of the dynamically created tasks. */\r
  99 static portTASK_FUNCTION_PROTO( vSuicidalTask, pvParameters );\r
 100 \r
 101 /* A variable which is incremented every time the dynamic tasks are created.  This\r
 102 is used to check that the task is still running. */\r
 103 static volatile unsigned portSHORT usCreationCount = 0;\r
 104 \r
 105 /* Used to store the number of tasks that were originally running so the creator\r
 106 task can tell if any of the suicidal tasks have failed to die.\r
 107 */\r
 108 static volatile unsigned portBASE_TYPE uxTasksRunningAtStart = 0;\r
 109 \r
 110 /* Tasks are deleted by the idle task.  Under heavy load the idle task might\r
 111 not get much processing time, so it would be legitimate for several tasks to\r
 112 remain undeleted for a short period. */\r
 113 static const unsigned portBASE_TYPE uxMaxNumberOfExtraTasksRunning = 2;\r
 114 \r
 115 /* Used to store a handle to the task that should be killed by a suicidal task,\r
 116 before it kills itself. */\r
 117 xTaskHandle xCreatedTask;\r
 118 \r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 void vCreateSuicidalTasks( unsigned portBASE_TYPE uxPriority )\r
 122 {\r
 123 unsigned portBASE_TYPE *puxPriority;\r
 124 \r
 125         /* Create the Creator tasks - passing in as a parameter the priority at which\r
 126         the suicidal tasks should be created. */\r
 127         puxPriority = ( unsigned portBASE_TYPE * ) pvPortMalloc( sizeof( unsigned portBASE_TYPE ) );\r
 128         *puxPriority = uxPriority;\r
 129 \r
 130         xTaskCreate( vCreateTasks, ( signed portCHAR * ) "CREATOR", deathSTACK_SIZE, ( void * ) puxPriority, uxPriority, NULL );\r
 131 \r
 132         /* Record the number of tasks that are running now so we know if any of the\r
 133         suicidal tasks have failed to be killed. */\r
 134         uxTasksRunningAtStart = ( unsigned portBASE_TYPE ) uxTaskGetNumberOfTasks();\r
 135         \r
 136         /* FreeRTOS.org versions before V3.0 started the idle-task as the very\r
 137         first task. The idle task was then already included in uxTasksRunningAtStart.\r
 138         From FreeRTOS V3.0 on, the idle task is started when the scheduler is\r
 139         started. Therefore the idle task is not yet accounted for. We correct\r
 140         this by increasing uxTasksRunningAtStart by 1. */\r
 141         uxTasksRunningAtStart++;\r
 142 }\r
 143 /*-----------------------------------------------------------*/\r
 144                                         \r
 145 static portTASK_FUNCTION( vSuicidalTask, pvParameters )\r
 146 {\r
 147 volatile portLONG l1, l2;\r
 148 xTaskHandle xTaskToKill;\r
 149 const portTickType xDelay = ( portTickType ) 200 / portTICK_RATE_MS;\r
 150 \r
 151         if( pvParameters != NULL )\r
 152         {\r
 153                 /* This task is periodically created four times.  Two created tasks are\r
 154                 passed a handle to the other task so it can kill it before killing itself.\r
 155                 The other task is passed in null. */\r
 156                 xTaskToKill = *( xTaskHandle* )pvParameters;\r
 157         }\r
 158         else\r
 159         {\r
 160                 xTaskToKill = NULL;\r
 161         }\r
 162 \r
 163         for( ;; )\r
 164         {\r
 165                 /* Do something random just to use some stack and registers. */\r
 166                 l1 = 2;\r
 167                 l2 = 89;\r
 168                 l2 *= l1;\r
 169                 vTaskDelay( xDelay );\r
 170 \r
 171                 if( xTaskToKill != NULL )\r
 172                 {\r
 173                         /* Make sure the other task has a go before we delete it. */\r
 174                         vTaskDelay( ( portTickType ) 0 );\r
 175 \r
 176                         /* Kill the other task that was created by vCreateTasks(). */\r
 177                         vTaskDelete( xTaskToKill );\r
 178 \r
 179                         /* Kill ourselves. */\r
 180                         vTaskDelete( NULL );\r
 181                 }\r
 182         }\r
 183 }/*lint !e818 !e550 Function prototype must be as per standard for task functions. */\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 static portTASK_FUNCTION( vCreateTasks, pvParameters )\r
 187 {\r
 188 const portTickType xDelay = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 189 unsigned portBASE_TYPE uxPriority;\r
 190 \r
 191         uxPriority = *( unsigned portBASE_TYPE * ) pvParameters;\r
 192         vPortFree( pvParameters );\r
 193 \r
 194         for( ;; )\r
 195         {\r
 196                 /* Just loop round, delaying then creating the four suicidal tasks. */\r
 197                 vTaskDelay( xDelay );\r
 198 \r
 199                 xCreatedTask = NULL;\r
 200 \r
 201                 xTaskCreate( vSuicidalTask, ( signed portCHAR * ) "SUICID1", configMINIMAL_STACK_SIZE, NULL, uxPriority, &xCreatedTask );\r
 202                 xTaskCreate( vSuicidalTask, ( signed portCHAR * ) "SUICID2", configMINIMAL_STACK_SIZE, &xCreatedTask, uxPriority, NULL );\r
 203 \r
 204                 ++usCreationCount;\r
 205         }\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 /* This is called to check that the creator task is still running and that there\r
 210 are not any more than four extra tasks. */\r
 211 portBASE_TYPE xIsCreateTaskStillRunning( void )\r
 212 {\r
 213 static unsigned portSHORT usLastCreationCount = 0xfff;\r
 214 portBASE_TYPE xReturn = pdTRUE;\r
 215 static unsigned portBASE_TYPE uxTasksRunningNow;\r
 216 \r
 217         if( usLastCreationCount == usCreationCount )\r
 218         {\r
 219                 xReturn = pdFALSE;\r
 220         }\r
 221         else\r
 222         {\r
 223                 usLastCreationCount = usCreationCount;\r
 224         }\r
 225         \r
 226         uxTasksRunningNow = ( unsigned portBASE_TYPE ) uxTaskGetNumberOfTasks();\r
 227 \r
 228         if( uxTasksRunningNow < uxTasksRunningAtStart )\r
 229         {\r
 230                 xReturn = pdFALSE;\r
 231         }\r
 232         else if( ( uxTasksRunningNow - uxTasksRunningAtStart ) > uxMaxNumberOfExtraTasksRunning )\r
 233         {\r
 234                 xReturn = pdFALSE;\r
 235         }\r
 236         else\r
 237         {\r
 238                 /* Everything is okay. */\r
 239         }\r
 240 \r
 241         return xReturn;\r
 242 }\r
 243 \r
 244 \r