incubator-nuttx/sched/task/task_spawnparms.c

375 lines
10 KiB
C

/****************************************************************************
* sched/task/task_spawnparms.c
*
* SPDX-License-Identifier: Apache-2.0
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <fcntl.h>
#include <spawn.h>
#include <assert.h>
#include <debug.h>
#include <errno.h>
#include <nuttx/mutex.h>
#include <nuttx/signal.h>
#include <nuttx/spawn.h>
#include <nuttx/fs/fs.h>
#include "task/spawn.h"
#include "task/task.h"
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: nxspawn_close, nxspawn_dup2, and nxspawn_open
*
* Description:
* Implement individual file actions
*
* Input Parameters:
* action - describes the action to be performed
*
* Returned Value:
* posix_spawn() and posix_spawnp() will return zero on success.
* Otherwise, an error number will be returned as the function return
* value to indicate the error.
*
****************************************************************************/
static inline void
nxspawn_close(FAR struct tcb_s *tcb,
FAR struct spawn_close_file_action_s *action)
{
/* The return value from nx_close() is ignored */
sinfo("Closing fd=%d\n", action->fd);
nx_close_from_tcb(tcb, action->fd);
}
static inline int nxspawn_dup2(FAR struct tcb_s *tcb,
FAR struct spawn_dup2_file_action_s *action)
{
/* Perform the dup */
sinfo("Dup'ing %d->%d\n", action->fd1, action->fd2);
return nx_dup2_from_tcb(tcb, action->fd1, action->fd2);
}
static inline int nxspawn_open(FAR struct tcb_s *tcb,
FAR struct spawn_open_file_action_s *action)
{
int ret = OK;
int fd;
/* Open the file */
sinfo("Open'ing path=%s oflags=%04x mode=%04x\n",
action->path, action->oflags, action->mode);
nx_close_from_tcb(tcb, action->fd);
fd = nx_open_from_tcb(tcb, action->path, action->oflags, action->mode);
if (fd < 0)
{
ret = fd;
}
else if (fd != action->fd)
{
ret = nx_dup2_from_tcb(tcb, fd, action->fd);
if (ret >= 0)
{
ret = OK;
}
nx_close_from_tcb(tcb, fd);
}
return ret;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: spawn_execattrs
*
* Description:
* Set attributes of the new child task after it has been spawned.
*
* Input Parameters:
*
* pid - The pid of the new task.
* attr - The attributes to use
*
* Returned Value:
* Errors are not reported by this function. This is not because errors
* cannot occur, but rather that the new task has already been started
* so there is no graceful way to handle errors detected in this context
* (unless we delete the new task and recover).
*
* Assumptions:
* That task has been started but has not yet executed because pre-
* emption is disabled.
*
****************************************************************************/
int spawn_execattrs(pid_t pid, FAR const posix_spawnattr_t *attr)
{
struct sched_param param;
int ret;
DEBUGASSERT(attr);
/* Now set the attributes. Note that we ignore all of the return values
* here because we have already successfully started the task. If we
* return an error value, then we would also have to stop the task.
*/
/* Firstly, set the signal mask if requested to do so */
if ((attr->flags & POSIX_SPAWN_SETSIGMASK) != 0)
{
FAR struct tcb_s *tcb = nxsched_get_tcb(pid);
if (tcb)
{
tcb->sigprocmask = attr->sigmask;
}
}
/* If we are only setting the priority, then call sched_setparm()
* to set the priority of the of the new task.
*/
if ((attr->flags & POSIX_SPAWN_SETSCHEDPARAM) != 0)
{
#ifdef CONFIG_SCHED_SPORADIC
/* Get the current sporadic scheduling parameters. Those will not be
* modified.
*/
ret = nxsched_get_param(pid, &param);
if (ret < 0)
{
return ret;
}
#endif
/* Get the priority from the attributes */
param.sched_priority = attr->priority;
/* If we are setting *both* the priority and the scheduler,
* then we will call nxsched_set_scheduler() below.
*/
if ((attr->flags & POSIX_SPAWN_SETSCHEDULER) == 0)
{
sinfo("Setting priority=%d for pid=%d\n",
param.sched_priority, pid);
ret = nxsched_set_param(pid, &param);
if (ret < 0)
{
return ret;
}
}
}
/* If we are only changing the scheduling policy, then reset
* the priority to the default value (the same as this thread) in
* preparation for the nxsched_set_scheduler() call below.
*/
else if ((attr->flags & POSIX_SPAWN_SETSCHEDULER) != 0)
{
ret = nxsched_get_param(0, &param);
if (ret < 0)
{
return ret;
}
}
/* Are we setting the scheduling policy? If so, use the priority
* setting determined above.
*/
if ((attr->flags & POSIX_SPAWN_SETSCHEDULER) != 0)
{
sinfo("Setting policy=%d priority=%d for pid=%d\n",
attr->policy, param.sched_priority, pid);
#ifdef CONFIG_SCHED_SPORADIC
/* But take the sporadic scheduler parameters from the attributes */
param.sched_ss_low_priority = (int)attr->low_priority;
param.sched_ss_max_repl = (int)attr->max_repl;
param.sched_ss_repl_period.tv_sec = attr->repl_period.tv_sec;
param.sched_ss_repl_period.tv_nsec = attr->repl_period.tv_nsec;
param.sched_ss_init_budget.tv_sec = attr->budget.tv_sec;
param.sched_ss_init_budget.tv_nsec = attr->budget.tv_nsec;
#endif
nxsched_set_scheduler(pid, attr->policy, &param);
}
return OK;
}
/****************************************************************************
* Name: spawn_file_actions
*
* Description:
* Perform Spawn file object that specifies file-related actions
*
* Input Parameters:
*
* actions - The spawn file actions
*
* Returned Value:
* 0 (OK) on success; A negated errno value is returned on failure.
*
****************************************************************************/
int spawn_file_actions(FAR struct tcb_s *tcb,
FAR const posix_spawn_file_actions_t *actions)
{
FAR struct spawn_general_file_action_s *entry;
int ret = OK;
/* Execute each file action */
for (entry = (FAR struct spawn_general_file_action_s *)actions;
entry && ret >= 0;
entry = entry->flink)
{
switch (entry->action)
{
case SPAWN_FILE_ACTION_CLOSE:
/* Ignore return value of nxspawn_close(),
* Closing an invalid file descriptor will
* not cause the action fail.
*/
nxspawn_close(tcb, (FAR void *)entry);
break;
case SPAWN_FILE_ACTION_DUP2:
ret = nxspawn_dup2(tcb, (FAR void *)entry);
break;
case SPAWN_FILE_ACTION_OPEN:
ret = nxspawn_open(tcb, (FAR void *)entry);
break;
case SPAWN_FILE_ACTION_NONE:
default:
serr("ERROR: Unknown action: %d\n", entry->action);
ret = -EINVAL;
break;
}
}
return ret;
}
/****************************************************************************
* Name: spawn_file_is_duplicateable
*
* Description:
* Check the input file descriptor is duplicateable from spawn actions
*
* Input Parameters:
*
* actions - The spawn file actions
* fd - file descriptor
*
* Returned Value:
* True is returned if file descriptor is duplicate able
*
****************************************************************************/
bool
spawn_file_is_duplicateable(FAR const posix_spawn_file_actions_t *actions,
int fd, bool cloexec)
{
FAR struct spawn_general_file_action_s *entry;
FAR struct spawn_close_file_action_s *close;
FAR struct spawn_open_file_action_s *open;
FAR struct spawn_dup2_file_action_s *dup2;
/* check each file action */
for (entry = (FAR struct spawn_general_file_action_s *)actions;
entry != NULL;
entry = entry->flink)
{
switch (entry->action)
{
case SPAWN_FILE_ACTION_CLOSE:
close = (FAR struct spawn_close_file_action_s *)entry;
if (close->fd == fd)
{
return false;
}
break;
case SPAWN_FILE_ACTION_DUP2:
dup2 = (FAR struct spawn_dup2_file_action_s *)entry;
if (dup2->fd1 == fd)
{
return true;
}
else if (dup2->fd2 == fd)
{
return false;
}
break;
case SPAWN_FILE_ACTION_OPEN:
open = (FAR struct spawn_open_file_action_s *)entry;
if (open->fd == fd)
{
return false;
}
break;
default:
break;
}
}
if (cloexec)
{
return false;
}
return true;
}