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

   1 /*\r
   2         FreeRTOS.org V4.3.0 - Copyright (C) 2003-2007 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         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 /**\r
  37  * Create a single persistent task which periodically dynamically creates another \r
  38  * four tasks.  The original task is called the creator task, the four tasks it \r
  39  * creates are called suicidal tasks.\r
  40  *\r
  41  * Two of the created suicidal tasks kill one other suicidal task before killing \r
  42  * themselves - leaving just the original task remaining.  \r
  43  *\r
  44  * The creator task must be spawned after all of the other demo application tasks \r
  45  * as it keeps a check on the number of tasks under the scheduler control.  The \r
  46  * number of tasks it expects to see running should never be greater than the \r
  47  * number of tasks that were in existence when the creator task was spawned, plus \r
  48  * one set of four suicidal tasks.  If this number is exceeded an error is flagged.\r
  49  *\r
  50  * \page DeathC death.c\r
  51  * \ingroup DemoFiles\r
  52  * <HR>\r
  53  */\r
  54 \r
  55 /*\r
  56 Changes from V2.0.0\r
  57 \r
  58         + Delay periods are now specified using variables and constants of\r
  59           portTickType rather than unsigned portLONG.\r
  60 */\r
  61 \r
  62 #include <stdlib.h>\r
  63 \r
  64 /* Scheduler include files. */\r
  65 #include "FreeRTOS.h"\r
  66 #include "task.h"\r
  67 \r
  68 /* Demo program include files. */\r
  69 #include "death.h"\r
  70 #include "print.h"\r
  71 \r
  72 #define deathSTACK_SIZE         ( ( unsigned portSHORT ) 512 )\r
  73 \r
  74 /* The task originally created which is responsible for periodically dynamically \r
  75 creating another four tasks. */\r
  76 static void vCreateTasks( void *pvParameters );\r
  77 \r
  78 /* The task function of the dynamically created tasks. */\r
  79 static void vSuicidalTask( void *pvParameters );\r
  80 \r
  81 /* A variable which is incremented every time the dynamic tasks are created.  This \r
  82 is used to check that the task is still running. */\r
  83 static volatile portSHORT sCreationCount = 0;\r
  84 \r
  85 /* Used to store the number of tasks that were originally running so the creator \r
  86 task can tell if any of the suicidal tasks have failed to die. */\r
  87 static volatile unsigned portBASE_TYPE uxTasksRunningAtStart = 0;\r
  88 static const unsigned portBASE_TYPE uxMaxNumberOfExtraTasksRunning = 5;\r
  89 \r
  90 /* Used to store a handle to the tasks that should be killed by a suicidal task, \r
  91 before it kills itself. */\r
  92 xTaskHandle xCreatedTask1, xCreatedTask2;\r
  93 \r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 void vCreateSuicidalTasks( unsigned portBASE_TYPE uxPriority )\r
  97 {\r
  98 unsigned portBASE_TYPE *puxPriority;\r
  99 \r
 100         /* Create the Creator tasks - passing in as a parameter the priority at which \r
 101         the suicidal tasks should be created. */\r
 102         puxPriority = ( unsigned portBASE_TYPE * ) pvPortMalloc( sizeof( unsigned portBASE_TYPE ) );\r
 103         *puxPriority = uxPriority;\r
 104 \r
 105         xTaskCreate( vCreateTasks, "CREATOR", deathSTACK_SIZE, ( void * ) puxPriority, uxPriority, NULL );\r
 106 \r
 107         /* Record the number of tasks that are running now so we know if any of the \r
 108         suicidal tasks have failed to be killed. */\r
 109         uxTasksRunningAtStart = uxTaskGetNumberOfTasks();\r
 110 }\r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 static void vSuicidalTask( void *pvParameters )\r
 114 {\r
 115 portDOUBLE d1, d2;\r
 116 xTaskHandle xTaskToKill;\r
 117 const portTickType xDelay = ( portTickType ) 500 / portTICK_RATE_MS;\r
 118 \r
 119         if( pvParameters != NULL )\r
 120         {\r
 121                 /* This task is periodically created four times.  Tow created tasks are \r
 122                 passed a handle to the other task so it can kill it before killing itself.  \r
 123                 The other task is passed in null. */\r
 124                 xTaskToKill = *( xTaskHandle* )pvParameters;\r
 125         }\r
 126         else\r
 127         {\r
 128                 xTaskToKill = NULL;\r
 129         }\r
 130 \r
 131         for( ;; )\r
 132         {\r
 133                 /* Do something random just to use some stack and registers. */\r
 134                 d1 = 2.4;\r
 135                 d2 = 89.2;\r
 136                 d2 *= d1;\r
 137                 vTaskDelay( xDelay );\r
 138 \r
 139                 if( xTaskToKill != NULL )\r
 140                 {\r
 141                         /* Make sure the other task has a go before we delete it. */\r
 142                         vTaskDelay( ( portTickType ) 0 );\r
 143                         /* Kill the other task that was created by vCreateTasks(). */\r
 144                         vTaskDelete( xTaskToKill );\r
 145                         /* Kill ourselves. */\r
 146                         vTaskDelete( NULL );\r
 147                 }\r
 148         }\r
 149 }/*lint !e818 !e550 Function prototype must be as per standard for task functions. */\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 static void vCreateTasks( void *pvParameters )\r
 153 {\r
 154 const portTickType xDelay = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 155 unsigned portBASE_TYPE uxPriority;\r
 156 const portCHAR * const pcTaskStartMsg = "Create task started.\r\n";\r
 157 \r
 158         /* Queue a message for printing to say the task has started. */\r
 159         vPrintDisplayMessage( &pcTaskStartMsg );\r
 160 \r
 161         uxPriority = *( unsigned portBASE_TYPE * ) pvParameters;\r
 162         vPortFree( pvParameters );\r
 163 \r
 164         for( ;; )\r
 165         {\r
 166                 /* Just loop round, delaying then creating the four suicidal tasks. */\r
 167                 vTaskDelay( xDelay );\r
 168 \r
 169                 xTaskCreate( vSuicidalTask, "SUICIDE1", deathSTACK_SIZE, NULL, uxPriority, &xCreatedTask1 );\r
 170                 xTaskCreate( vSuicidalTask, "SUICIDE2", deathSTACK_SIZE, &xCreatedTask1, uxPriority, NULL );\r
 171 \r
 172                 xTaskCreate( vSuicidalTask, "SUICIDE1", deathSTACK_SIZE, NULL, uxPriority, &xCreatedTask2 );\r
 173                 xTaskCreate( vSuicidalTask, "SUICIDE2", deathSTACK_SIZE, &xCreatedTask2, uxPriority, NULL );\r
 174 \r
 175                 ++sCreationCount;\r
 176         }\r
 177 }\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 /* This is called to check that the creator task is still running and that there \r
 181 are not any more than four extra tasks. */\r
 182 portBASE_TYPE xIsCreateTaskStillRunning( void )\r
 183 {\r
 184 static portSHORT sLastCreationCount = 0;\r
 185 portSHORT sReturn = pdTRUE;\r
 186 unsigned portBASE_TYPE uxTasksRunningNow;\r
 187 \r
 188         if( sLastCreationCount == sCreationCount )\r
 189         {\r
 190                 sReturn = pdFALSE;\r
 191         }\r
 192         \r
 193         uxTasksRunningNow = uxTaskGetNumberOfTasks();\r
 194 \r
 195         if( uxTasksRunningNow < uxTasksRunningAtStart )\r
 196         {\r
 197                 sReturn = pdFALSE;\r
 198         }\r
 199         else if( ( uxTasksRunningNow - uxTasksRunningAtStart ) > uxMaxNumberOfExtraTasksRunning )\r
 200         {\r
 201                 sReturn = pdFALSE;\r
 202         }\r
 203         else\r
 204         {\r
 205                 /* Everything is okay. */\r
 206         }\r
 207 \r
 208         return sReturn;\r
 209 }\r
 210 \r
 211 \r