Make task_init() and task_activate() internal OS functions.

-Move task_init() and task_activate() prototypes from include/sched.h to include/nuttx/sched.h.  These are internal OS functions and should not be exposed to the user.
-Remove references to task_init() and task_activate() from the User Manual.
-Rename task_init() to nxtask_init() since since it is an OS internal function
-Rename task_activate() to nxtask_activate since it is an OS internal function
This commit is contained in:
Gregory Nutt
2020-05-25 15:30:40 -06:00
committed by Abdelatif Guettouche
parent dd9d9878ad
commit 82debdc213
29 changed files with 138 additions and 256 deletions
+16 -30
View File
@@ -1,35 +1,20 @@
/****************************************************************************
* sched/task/task_activate.c
*
* Copyright (C) 2007-2009, 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
@@ -43,6 +28,7 @@
#include <debug.h>
#include <nuttx/irq.h>
#include <nuttx/sched.h>
#include <nuttx/arch.h>
#include <nuttx/sched_note.h>
@@ -51,7 +37,7 @@
****************************************************************************/
/****************************************************************************
* Name: task_activate
* Name: nxtask_activate
*
* Description:
* This function activates tasks initialized by nxtask_setup_scheduler().
@@ -59,7 +45,7 @@
* scheduler.
*
* Input Parameters:
* tcb - The TCB for the task for the task (same as the task_init
* tcb - The TCB for the task for the task (same as the nxtask_init
* argument).
*
* Returned Value:
@@ -67,7 +53,7 @@
*
****************************************************************************/
int task_activate(FAR struct tcb_s *tcb)
int nxtask_activate(FAR struct tcb_s *tcb)
{
irqstate_t flags = enter_critical_section();
+1 -1
View File
@@ -145,7 +145,7 @@ static int nxthread_create(FAR const char *name, uint8_t ttype,
/* Activate the task */
ret = task_activate((FAR struct tcb_s *)tcb);
ret = nxtask_activate((FAR struct tcb_s *)tcb);
if (ret < OK)
{
/* The TCB was added to the active task list by
+3 -3
View File
@@ -41,7 +41,7 @@
****************************************************************************/
/****************************************************************************
* Name: task_init
* Name: nxtask_init
*
* Description:
* This function initializes a Task Control Block (TCB) in preparation for
@@ -51,7 +51,7 @@
* Unlike task_create():
* 1. Allocate the TCB. The pre-allocated TCB is passed in argv.
* 2. Allocate the stack. The pre-allocated stack is passed in argv.
* 3. Activate the task. This must be done by calling task_activate().
* 3. Activate the task. This must be done by calling nxtask_activate().
*
* Input Parameters:
* tcb - Address of the new task's TCB
@@ -73,7 +73,7 @@
*
****************************************************************************/
int task_init(FAR struct tcb_s *tcb, const char *name, int priority,
int nxtask_init(FAR struct tcb_s *tcb, const char *name, int priority,
FAR uint32_t *stack, uint32_t stack_size,
main_t entry, FAR char * const argv[])
{
+1 -1
View File
@@ -201,7 +201,7 @@ int task_restart(pid_t pid)
/* Activate the task. */
ret = task_activate((FAR struct tcb_s *)tcb);
ret = nxtask_activate((FAR struct tcb_s *)tcb);
if (ret != OK)
{
nxtask_terminate(pid, true);
+3 -2
View File
@@ -607,7 +607,8 @@ static inline int nxtask_setup_stackargs(FAR struct task_tcb_s *tcb,
* This functions initializes a Task Control Block (TCB) in preparation
* for starting a new task.
*
* nxtask_setup_scheduler() is called from task_init() and nxtask_start().
* nxtask_setup_scheduler() is called from nxtask_init() and
* nxtask_start().
*
* Input Parameters:
* tcb - Address of the new task's TCB
@@ -676,7 +677,7 @@ int pthread_setup_scheduler(FAR struct pthread_tcb_s *tcb, int priority,
* This functions sets up parameters in the Task Control Block (TCB) in
* preparation for starting a new thread.
*
* nxtask_setup_arguments() is called only from task_init() and
* nxtask_setup_arguments() is called only from nxtask_init() and
* nxtask_start() to create a new task. In the "normal" case, the argv[]
* array is a structure in the TCB, the arguments are cloned via strdup.
*
+3 -3
View File
@@ -176,9 +176,9 @@ errout:
* to perform these operations?
* A: Good idea, except that existing nxtask_starthook() implementation
* cannot be used here unless we get rid of task_create and, instead,
* use task_init() and task_activate(). start_taskhook() could then
* be called between task_init() and task_activate(). task_restart()
* would still be an issue.
* use nxtask_init() and nxtask_activate(). start_taskhook() could then
* be called between nxtask_init() and nxtask_activate().
* task_restart() would still be an issue.
*
* Input Parameters:
* Standard task start-up parameters
+1 -1
View File
@@ -434,7 +434,7 @@ pid_t nxtask_start_vfork(FAR struct task_tcb_s *child)
/* Activate the task */
ret = task_activate((FAR struct tcb_s *)child);
ret = nxtask_activate((FAR struct tcb_s *)child);
if (ret < OK)
{
nxtask_abort_vfork(child, -ret);