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

   1 /*\r
   2     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /**\r
  71  * Create a single persistent task which periodically dynamically creates another\r
  72  * two tasks.  The original task is called the creator task, the two tasks it\r
  73  * creates are called suicidal tasks.\r
  74  *\r
  75  * One of the created suicidal tasks kill one other suicidal task before killing\r
  76  * itself - leaving just the original task remaining.\r
  77  *\r
  78  * The creator task must be spawned after all of the other demo application tasks\r
  79  * as it keeps a check on the number of tasks under the scheduler control.  The\r
  80  * number of tasks it expects to see running should never be greater than the\r
  81  * number of tasks that were in existence when the creator task was spawned, plus\r
  82  * one set of four suicidal tasks.  If this number is exceeded an error is flagged.\r
  83  *\r
  84  * \page DeathC death.c\r
  85  * \ingroup DemoFiles\r
  86  * <HR>\r
  87  */\r
  88 \r
  89 \r
  90 #include <stdlib.h>\r
  91 \r
  92 /* Scheduler include files. */\r
  93 #include "FreeRTOS.h"\r
  94 #include "task.h"\r
  95 \r
  96 /* Demo program include files. */\r
  97 #include "death.h"\r
  98 \r
  99 #define deathSTACK_SIZE         ( configMINIMAL_STACK_SIZE + 60 )\r
 100 \r
 101 /* The task originally created which is responsible for periodically dynamically\r
 102 creating another four tasks. */\r
 103 static portTASK_FUNCTION_PROTO( vCreateTasks, pvParameters );\r
 104 \r
 105 /* The task function of the dynamically created tasks. */\r
 106 static portTASK_FUNCTION_PROTO( vSuicidalTask, pvParameters );\r
 107 \r
 108 /* A variable which is incremented every time the dynamic tasks are created.  This\r
 109 is used to check that the task is still running. */\r
 110 static volatile uint16_t usCreationCount = 0;\r
 111 \r
 112 /* Used to store the number of tasks that were originally running so the creator\r
 113 task can tell if any of the suicidal tasks have failed to die.\r
 114 */\r
 115 static volatile UBaseType_t uxTasksRunningAtStart = 0;\r
 116 \r
 117 /* When a task deletes itself, it stack and TCB are cleaned up by the Idle task.\r
 118 Under heavy load the idle task might not get much processing time, so it would\r
 119 be legitimate for several tasks to remain undeleted for a short period.  There\r
 120 may also be a few other unexpected tasks if, for example, the tasks that test\r
 121 static allocation are also being used. */\r
 122 static const UBaseType_t uxMaxNumberOfExtraTasksRunning = 3;\r
 123 \r
 124 /* Used to store a handle to the task that should be killed by a suicidal task,\r
 125 before it kills itself. */\r
 126 TaskHandle_t xCreatedTask;\r
 127 \r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 void vCreateSuicidalTasks( UBaseType_t uxPriority )\r
 131 {\r
 132         xTaskCreate( vCreateTasks, "CREATOR", deathSTACK_SIZE, ( void * ) NULL, uxPriority, NULL );\r
 133 \r
 134         /* Record the number of tasks that are running now so we know if any of the\r
 135         suicidal tasks have failed to be killed. */\r
 136         uxTasksRunningAtStart = ( UBaseType_t ) uxTaskGetNumberOfTasks();\r
 137 \r
 138         /* FreeRTOS.org versions before V3.0 started the idle-task as the very\r
 139         first task. The idle task was then already included in uxTasksRunningAtStart.\r
 140         From FreeRTOS V3.0 on, the idle task is started when the scheduler is\r
 141         started. Therefore the idle task is not yet accounted for. We correct\r
 142         this by increasing uxTasksRunningAtStart by 1. */\r
 143         uxTasksRunningAtStart++;\r
 144 \r
 145         /* From FreeRTOS version 7.0.0 can optionally create a timer service task.\r
 146         If this is done, then uxTasksRunningAtStart needs incrementing again as that\r
 147         too is created when the scheduler is started. */\r
 148         #if configUSE_TIMERS == 1\r
 149         {\r
 150                 uxTasksRunningAtStart++;\r
 151         }\r
 152         #endif\r
 153 }\r
 154 /*-----------------------------------------------------------*/\r
 155 \r
 156 static portTASK_FUNCTION( vSuicidalTask, pvParameters )\r
 157 {\r
 158 volatile long l1, l2;\r
 159 TaskHandle_t xTaskToKill;\r
 160 const TickType_t xDelay = pdMS_TO_TICKS( ( TickType_t ) 200 );\r
 161 \r
 162         if( pvParameters != NULL )\r
 163         {\r
 164                 /* This task is periodically created four times.  Two created tasks are\r
 165                 passed a handle to the other task so it can kill it before killing itself.\r
 166                 The other task is passed in null. */\r
 167                 xTaskToKill = *( TaskHandle_t* )pvParameters;\r
 168         }\r
 169         else\r
 170         {\r
 171                 xTaskToKill = NULL;\r
 172         }\r
 173 \r
 174         for( ;; )\r
 175         {\r
 176                 /* Do something random just to use some stack and registers. */\r
 177                 l1 = 2;\r
 178                 l2 = 89;\r
 179                 l2 *= l1;\r
 180                 vTaskDelay( xDelay );\r
 181 \r
 182                 if( xTaskToKill != NULL )\r
 183                 {\r
 184                         /* Make sure the other task has a go before we delete it. */\r
 185                         vTaskDelay( ( TickType_t ) 0 );\r
 186 \r
 187                         /* Kill the other task that was created by vCreateTasks(). */\r
 188                         vTaskDelete( xTaskToKill );\r
 189 \r
 190                         /* Kill ourselves. */\r
 191                         vTaskDelete( NULL );\r
 192                 }\r
 193         }\r
 194 }/*lint !e818 !e550 Function prototype must be as per standard for task functions. */\r
 195 /*-----------------------------------------------------------*/\r
 196 \r
 197 static portTASK_FUNCTION( vCreateTasks, pvParameters )\r
 198 {\r
 199 const TickType_t xDelay = pdMS_TO_TICKS( ( TickType_t ) 1000 );\r
 200 UBaseType_t uxPriority;\r
 201 \r
 202         /* Remove compiler warning about unused parameter. */\r
 203         ( void ) pvParameters;\r
 204 \r
 205         uxPriority = uxTaskPriorityGet( NULL );\r
 206 \r
 207         for( ;; )\r
 208         {\r
 209                 /* Just loop round, delaying then creating the four suicidal tasks. */\r
 210                 vTaskDelay( xDelay );\r
 211 \r
 212                 xCreatedTask = NULL;\r
 213 \r
 214                 xTaskCreate( vSuicidalTask, "SUICID1", configMINIMAL_STACK_SIZE, NULL, uxPriority, &xCreatedTask );\r
 215                 xTaskCreate( vSuicidalTask, "SUICID2", configMINIMAL_STACK_SIZE, &xCreatedTask, uxPriority, NULL );\r
 216 \r
 217                 ++usCreationCount;\r
 218         }\r
 219 }\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 /* This is called to check that the creator task is still running and that there\r
 223 are not any more than four extra tasks. */\r
 224 BaseType_t xIsCreateTaskStillRunning( void )\r
 225 {\r
 226 static uint16_t usLastCreationCount = 0xfff;\r
 227 BaseType_t xReturn = pdTRUE;\r
 228 static UBaseType_t uxTasksRunningNow;\r
 229 \r
 230         if( usLastCreationCount == usCreationCount )\r
 231         {\r
 232                 xReturn = pdFALSE;\r
 233         }\r
 234         else\r
 235         {\r
 236                 usLastCreationCount = usCreationCount;\r
 237         }\r
 238 \r
 239         uxTasksRunningNow = ( UBaseType_t ) uxTaskGetNumberOfTasks();\r
 240 \r
 241         if( uxTasksRunningNow < uxTasksRunningAtStart )\r
 242         {\r
 243                 xReturn = pdFALSE;\r
 244         }\r
 245         else if( ( uxTasksRunningNow - uxTasksRunningAtStart ) > uxMaxNumberOfExtraTasksRunning )\r
 246         {\r
 247                 xReturn = pdFALSE;\r
 248         }\r
 249         else\r
 250         {\r
 251                 /* Everything is okay. */\r
 252         }\r
 253 \r
 254         return xReturn;\r
 255 }\r
 256 \r
 257 \r