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

   1 /*\r
   2     FreeRTOS V7.4.1 - 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  * four tasks.  The original task is called the creator task, the four tasks it \r
  78  * creates are called suicidal tasks.\r
  79  *\r
  80  * Two of the created suicidal tasks kill one other suicidal task before killing \r
  81  * themselves - 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 V2.0.0\r
  96 \r
  97         + Delay periods are now specified using variables and constants of\r
  98           portTickType rather than unsigned long.\r
  99 */\r
 100 \r
 101 #include <stdlib.h>\r
 102 \r
 103 /* Scheduler include files. */\r
 104 #include "FreeRTOS.h"\r
 105 #include "task.h"\r
 106 \r
 107 /* Demo program include files. */\r
 108 #include "death.h"\r
 109 #include "print.h"\r
 110 \r
 111 #define deathSTACK_SIZE         ( ( unsigned short ) 512 )\r
 112 \r
 113 /* The task originally created which is responsible for periodically dynamically \r
 114 creating another four tasks. */\r
 115 static void vCreateTasks( void *pvParameters );\r
 116 \r
 117 /* The task function of the dynamically created tasks. */\r
 118 static void vSuicidalTask( void *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 short sCreationCount = 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 static volatile unsigned portBASE_TYPE uxTasksRunningAtStart = 0;\r
 127 static const unsigned portBASE_TYPE uxMaxNumberOfExtraTasksRunning = 5;\r
 128 \r
 129 /* Used to store a handle to the tasks that should be killed by a suicidal task, \r
 130 before it kills itself. */\r
 131 xTaskHandle xCreatedTask1, xCreatedTask2;\r
 132 \r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 void vCreateSuicidalTasks( unsigned portBASE_TYPE uxPriority )\r
 136 {\r
 137 unsigned portBASE_TYPE *puxPriority;\r
 138 \r
 139         /* Create the Creator tasks - passing in as a parameter the priority at which \r
 140         the suicidal tasks should be created. */\r
 141         puxPriority = ( unsigned portBASE_TYPE * ) pvPortMalloc( sizeof( unsigned portBASE_TYPE ) );\r
 142         *puxPriority = uxPriority;\r
 143 \r
 144         xTaskCreate( vCreateTasks, "CREATOR", deathSTACK_SIZE, ( void * ) puxPriority, uxPriority, NULL );\r
 145 \r
 146         /* Record the number of tasks that are running now so we know if any of the \r
 147         suicidal tasks have failed to be killed. */\r
 148         uxTasksRunningAtStart = uxTaskGetNumberOfTasks();\r
 149 }\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 static void vSuicidalTask( void *pvParameters )\r
 153 {\r
 154 portDOUBLE d1, d2;\r
 155 xTaskHandle xTaskToKill;\r
 156 const portTickType xDelay = ( portTickType ) 500 / portTICK_RATE_MS;\r
 157 \r
 158         if( pvParameters != NULL )\r
 159         {\r
 160                 /* This task is periodically created four times.  Tow created tasks are \r
 161                 passed a handle to the other task so it can kill it before killing itself.  \r
 162                 The other task is passed in null. */\r
 163                 xTaskToKill = *( xTaskHandle* )pvParameters;\r
 164         }\r
 165         else\r
 166         {\r
 167                 xTaskToKill = NULL;\r
 168         }\r
 169 \r
 170         for( ;; )\r
 171         {\r
 172                 /* Do something random just to use some stack and registers. */\r
 173                 d1 = 2.4;\r
 174                 d2 = 89.2;\r
 175                 d2 *= d1;\r
 176                 vTaskDelay( xDelay );\r
 177 \r
 178                 if( xTaskToKill != NULL )\r
 179                 {\r
 180                         /* Make sure the other task has a go before we delete it. */\r
 181                         vTaskDelay( ( portTickType ) 0 );\r
 182                         /* Kill the other task that was created by vCreateTasks(). */\r
 183                         vTaskDelete( xTaskToKill );\r
 184                         /* Kill ourselves. */\r
 185                         vTaskDelete( NULL );\r
 186                 }\r
 187         }\r
 188 }/*lint !e818 !e550 Function prototype must be as per standard for task functions. */\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 static void vCreateTasks( void *pvParameters )\r
 192 {\r
 193 const portTickType xDelay = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 194 unsigned portBASE_TYPE uxPriority;\r
 195 const char * const pcTaskStartMsg = "Create task started.\r\n";\r
 196 \r
 197         /* Queue a message for printing to say the task has started. */\r
 198         vPrintDisplayMessage( &pcTaskStartMsg );\r
 199 \r
 200         uxPriority = *( unsigned portBASE_TYPE * ) pvParameters;\r
 201         vPortFree( pvParameters );\r
 202 \r
 203         for( ;; )\r
 204         {\r
 205                 /* Just loop round, delaying then creating the four suicidal tasks. */\r
 206                 vTaskDelay( xDelay );\r
 207 \r
 208                 xTaskCreate( vSuicidalTask, "SUICIDE1", deathSTACK_SIZE, NULL, uxPriority, &xCreatedTask1 );\r
 209                 xTaskCreate( vSuicidalTask, "SUICIDE2", deathSTACK_SIZE, &xCreatedTask1, uxPriority, NULL );\r
 210 \r
 211                 xTaskCreate( vSuicidalTask, "SUICIDE1", deathSTACK_SIZE, NULL, uxPriority, &xCreatedTask2 );\r
 212                 xTaskCreate( vSuicidalTask, "SUICIDE2", deathSTACK_SIZE, &xCreatedTask2, uxPriority, NULL );\r
 213 \r
 214                 ++sCreationCount;\r
 215         }\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 /* This is called to check that the creator task is still running and that there \r
 220 are not any more than four extra tasks. */\r
 221 portBASE_TYPE xIsCreateTaskStillRunning( void )\r
 222 {\r
 223 static short sLastCreationCount = 0;\r
 224 short sReturn = pdTRUE;\r
 225 unsigned portBASE_TYPE uxTasksRunningNow;\r
 226 \r
 227         if( sLastCreationCount == sCreationCount )\r
 228         {\r
 229                 sReturn = pdFALSE;\r
 230         }\r
 231         \r
 232         uxTasksRunningNow = uxTaskGetNumberOfTasks();\r
 233 \r
 234         if( uxTasksRunningNow < uxTasksRunningAtStart )\r
 235         {\r
 236                 sReturn = pdFALSE;\r
 237         }\r
 238         else if( ( uxTasksRunningNow - uxTasksRunningAtStart ) > uxMaxNumberOfExtraTasksRunning )\r
 239         {\r
 240                 sReturn = pdFALSE;\r
 241         }\r
 242         else\r
 243         {\r
 244                 /* Everything is okay. */\r
 245         }\r
 246 \r
 247         return sReturn;\r
 248 }\r
 249 \r
 250 \r