From fd1e0a17e27b59cc236394c0766feea7278e1d00 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Thu, 25 Apr 2013 16:23:30 -0600 Subject: Move task_terminate to its own C file to prevent drawing task_delete into the link --- nuttx/ChangeLog | 3 + nuttx/sched/Makefile | 2 +- nuttx/sched/task_delete.c | 116 +------------------------- nuttx/sched/task_terminate.c | 189 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 195 insertions(+), 115 deletions(-) create mode 100644 nuttx/sched/task_terminate.c diff --git a/nuttx/ChangeLog b/nuttx/ChangeLog index e6cbea97d..4467e4088 100644 --- a/nuttx/ChangeLog +++ b/nuttx/ChangeLog @@ -4632,3 +4632,6 @@ compilation so that the useless TIOCSERGSTRUCT ioctl logic is not build unless CONFIG_DEBUG and CONFIG_SERIAL_TIOCSERGSTRUCT are defined. + * sched/task_delete.c and task_terminate.c: Most task_terminate() + out of task_delete.c into its own C file. This should prevent + dragging task_delete() into the link when it is never called. diff --git a/nuttx/sched/Makefile b/nuttx/sched/Makefile index c711a35fa..18b95b68c 100644 --- a/nuttx/sched/Makefile +++ b/nuttx/sched/Makefile @@ -44,7 +44,7 @@ MISC_SRCS += sched_garbage.c sched_getfiles.c sched_getsockets.c sched_getstream TSK_SRCS = prctl.c exit.c getpid.c TSK_SRCS += task_create.c task_init.c task_setup.c task_activate.c task_start.c TSK_SRCS += task_delete.c task_exit.c task_exithook.c task_recover.c -TSK_SRCS += task_restart.c task_spawn.c task_spawnparms.c +TSK_SRCS += task_restart.c task_spawn.c task_spawnparms.c task_terminate.c TSK_SRCS += sched_addreadytorun.c sched_removereadytorun.c sched_addprioritized.c TSK_SRCS += sched_mergepending.c sched_addblocked.c sched_removeblocked.c TSK_SRCS += sched_free.c sched_gettcb.c sched_verifytcb.c sched_releasetcb.c diff --git a/nuttx/sched/task_delete.c b/nuttx/sched/task_delete.c index 1cf9f97e5..ead1811c3 100644 --- a/nuttx/sched/task_delete.c +++ b/nuttx/sched/task_delete.c @@ -39,14 +39,11 @@ #include -#include #include -#include + +#include #include "os_internal.h" -#ifndef CONFIG_DISABLE_SIGNALS -# include "sig_internal.h" -#endif /**************************************************************************** * Definitions @@ -76,115 +73,6 @@ * Public Functions ****************************************************************************/ -/**************************************************************************** - * Name: task_terminate - * - * Description: - * This function causes a specified task to cease to exist. Its stack and - * TCB will be deallocated. This function is the internal implementation - * of the task_delete() function. It includes and additional parameter - * to determine if blocking is permitted or not. - * - * This function is the final function called all task termination - * sequences. task_terminate() is called only from task_delete() (with - * nonblocking == false) and from task_exit() (with nonblocking == true). - * - * The path through task_exit() supports the final stops of the exit(), - * _exit(), and pthread_exit - * - * - pthread_exit(). Calls _exit() - * - exit(). Calls _exit() - * - _exit(). Calls task_exit() making the currently running task - * non-running. task_exit then calls task_terminate() (with nonblocking - * == true) to terminate the non-running task. - * - * NOTE: that the state of non-blocking is irrelevant when called through - * exit() and pthread_exit(). In those cases task_exithook() has already - * been called with nonblocking == false; - * - * Inputs: - * pid - The task ID of the task to delete. A pid of zero - * signifies the calling task. - * nonblocking - True: The task is an unhealthy, partially torn down - * state and is not permitted to block. - * - * Return Value: - * OK on success; or ERROR on failure - * - * This function can fail if the provided pid does not correspond to a - * task (errno is not set) - * - ****************************************************************************/ - -int task_terminate(pid_t pid, bool nonblocking) -{ - FAR struct tcb_s *dtcb; - irqstate_t saved_state; - int ret = ERROR; - - /* Make sure the task does not become ready-to-run while we are futzing with - * its TCB by locking ourselves as the executing task. - */ - - sched_lock(); - - /* Find for the TCB associated with matching pid */ - - dtcb = sched_gettcb(pid); - if (!dtcb) - { - /* This pid does not correspond to any known task */ - - sched_unlock(); - return ERROR; - } - - /* Verify our internal sanity */ - - if (dtcb->task_state == TSTATE_TASK_RUNNING || - dtcb->task_state >= NUM_TASK_STATES) - { - sched_unlock(); - PANIC(); - } - - /* Perform common task termination logic (flushing streams, calling - * functions registered by at_exit/on_exit, etc.). We need to do - * this as early as possible so that higher level clean-up logic - * can run in a healthy tasking environment. - * - * In the case where the task exits via exit(), task_exithook() - * may be called twice. - * - * I suppose EXIT_SUCCESS is an appropriate return value??? - */ - - task_exithook(dtcb, EXIT_SUCCESS, nonblocking); - - /* Remove the task from the OS's tasks lists. */ - - saved_state = irqsave(); - dq_rem((FAR dq_entry_t*)dtcb, (dq_queue_t*)g_tasklisttable[dtcb->task_state].list); - dtcb->task_state = TSTATE_TASK_INVALID; - irqrestore(saved_state); - - /* At this point, the TCB should no longer be accessible to the system */ - - sched_unlock(); - - /* Since all tasks pass through this function as the final step in their - * exit sequence, this is an appropriate place to inform any instrumentation - * layer that the task no longer exists. - */ - - sched_note_stop(dtcb); - - /* Deallocate its TCB */ - - sched_releasetcb(dtcb, dtcb->flags & TCB_FLAG_TTYPE_MASK); - return ret; -} - /**************************************************************************** * Name: task_delete * diff --git a/nuttx/sched/task_terminate.c b/nuttx/sched/task_terminate.c new file mode 100644 index 000000000..af8915d33 --- /dev/null +++ b/nuttx/sched/task_terminate.c @@ -0,0 +1,189 @@ +/**************************************************************************** + * sched/task_terminate.c + * + * Copyright (C) 2007-2009, 2011-2013 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include + +#include +#include +#include + +#include +#include + +#include "os_internal.h" +#ifndef CONFIG_DISABLE_SIGNALS +# include "sig_internal.h" +#endif + +/**************************************************************************** + * Definitions + ****************************************************************************/ + +/**************************************************************************** + * Private Type Declarations + ****************************************************************************/ + +/**************************************************************************** + * Global Variables + ****************************************************************************/ + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +/**************************************************************************** + * Private Function Prototypes + ****************************************************************************/ + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: task_terminate + * + * Description: + * This function causes a specified task to cease to exist. Its stack and + * TCB will be deallocated. This function is the internal implementation + * of the task_delete() function. It includes and additional parameter + * to determine if blocking is permitted or not. + * + * This function is the final function called all task termination + * sequences. task_terminate() is called only from task_delete() (with + * nonblocking == false) and from task_exit() (with nonblocking == true). + * + * The path through task_exit() supports the final stops of the exit(), + * _exit(), and pthread_exit + * + * - pthread_exit(). Calls _exit() + * - exit(). Calls _exit() + * - _exit(). Calls task_exit() making the currently running task + * non-running. task_exit then calls task_terminate() (with nonblocking + * == true) to terminate the non-running task. + * + * NOTE: that the state of non-blocking is irrelevant when called through + * exit() and pthread_exit(). In those cases task_exithook() has already + * been called with nonblocking == false; + * + * Inputs: + * pid - The task ID of the task to delete. A pid of zero + * signifies the calling task. + * nonblocking - True: The task is an unhealthy, partially torn down + * state and is not permitted to block. + * + * Return Value: + * OK on success; or ERROR on failure + * + * This function can fail if the provided pid does not correspond to a + * task (errno is not set) + * + ****************************************************************************/ + +int task_terminate(pid_t pid, bool nonblocking) +{ + FAR struct tcb_s *dtcb; + irqstate_t saved_state; + int ret = ERROR; + + /* Make sure the task does not become ready-to-run while we are futzing with + * its TCB by locking ourselves as the executing task. + */ + + sched_lock(); + + /* Find for the TCB associated with matching pid */ + + dtcb = sched_gettcb(pid); + if (!dtcb) + { + /* This pid does not correspond to any known task */ + + sched_unlock(); + return ERROR; + } + + /* Verify our internal sanity */ + + if (dtcb->task_state == TSTATE_TASK_RUNNING || + dtcb->task_state >= NUM_TASK_STATES) + { + sched_unlock(); + PANIC(); + } + + /* Perform common task termination logic (flushing streams, calling + * functions registered by at_exit/on_exit, etc.). We need to do + * this as early as possible so that higher level clean-up logic + * can run in a healthy tasking environment. + * + * In the case where the task exits via exit(), task_exithook() + * may be called twice. + * + * I suppose EXIT_SUCCESS is an appropriate return value??? + */ + + task_exithook(dtcb, EXIT_SUCCESS, nonblocking); + + /* Remove the task from the OS's tasks lists. */ + + saved_state = irqsave(); + dq_rem((FAR dq_entry_t*)dtcb, (dq_queue_t*)g_tasklisttable[dtcb->task_state].list); + dtcb->task_state = TSTATE_TASK_INVALID; + irqrestore(saved_state); + + /* At this point, the TCB should no longer be accessible to the system */ + + sched_unlock(); + + /* Since all tasks pass through this function as the final step in their + * exit sequence, this is an appropriate place to inform any instrumentation + * layer that the task no longer exists. + */ + + sched_note_stop(dtcb); + + /* Deallocate its TCB */ + + sched_releasetcb(dtcb, dtcb->flags & TCB_FLAG_TTYPE_MASK); + return ret; +} -- cgit v1.2.3