nuttx/sched/group/group_create.c

258 lines
7.5 KiB
C
Raw Normal View History

/****************************************************************************
* sched/group/group_create.c
*
* 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 <sched.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/irq.h>
#include <nuttx/fs/fs.h>
#include <nuttx/kmalloc.h>
#include <nuttx/semaphore.h>
#include <nuttx/sched.h>
#include "sched/sched.h"
#include "group/group.h"
#include "tls/tls.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Is this worth making a configuration option? */
#define GROUP_INITIAL_MEMBERS 4
/****************************************************************************
* Public Data
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: group_inherit_identity
*
* Description:
* All inherit the user identity from the parent task group.
*
* Input Parameters:
* group - The new task group.
*
* Returned Value:
* None
*
* Assumptions:
* The parent of the new task is the task at the head of the assigned task
* list for the current CPU.
*
****************************************************************************/
#ifdef CONFIG_SCHED_USER_IDENTITY
static inline void group_inherit_identity(FAR struct task_group_s *group)
{
FAR struct tcb_s *rtcb = this_task();
FAR struct task_group_s *rgroup = rtcb->group;
/* Inherit the user identity from the parent task group. */
DEBUGASSERT(group != NULL);
group->tg_uid = rgroup->tg_uid;
group->tg_gid = rgroup->tg_gid;
group->tg_euid = rgroup->tg_euid;
group->tg_egid = rgroup->tg_egid;
}
#else
# define group_inherit_identity(group)
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: group_allocate
*
* Description:
* Create and a new task group structure for the specified TCB. This
* function is called as part of the task creation sequence. The structure
* allocated and zeroed, but otherwise uninitialized. The full creation
* of the group of a two step process: (1) First, this function allocates
* group structure early in the task creation sequence in order to provide
* a group container, then (2) group_initialize() is called to set up the
* group membership.
*
* Input Parameters:
* tcb - The tcb in need of the task group.
* ttype - Type of the thread that is the parent of the group
*
* Returned Value:
* 0 (OK) on success; a negated errno value on failure.
*
* Assumptions:
* Called during task creation in a safe context. No special precautions
* are required here.
*
****************************************************************************/
int group_allocate(FAR struct task_tcb_s *tcb, uint8_t ttype)
{
FAR struct task_group_s *group;
int ret;
DEBUGASSERT(tcb && !tcb->cmn.group);
/* Allocate the group structure and assign it to the TCB */
group = kmm_zalloc(sizeof(struct task_group_s));
if (!group)
{
return -ENOMEM;
}
#if defined(CONFIG_MM_KERNEL_HEAP)
/* If this group is being created for a privileged thread, then all
* elements of the group must be created for privileged access.
*/
if ((ttype & TCB_FLAG_TTYPE_MASK) == TCB_FLAG_TTYPE_KERNEL)
{
group->tg_flags |= GROUP_FLAG_PRIVILEGED;
}
#endif /* defined(CONFIG_MM_KERNEL_HEAP) */
#ifdef HAVE_GROUP_MEMBERS
/* Allocate space to hold GROUP_INITIAL_MEMBERS members of the group */
group->tg_members = kmm_malloc(GROUP_INITIAL_MEMBERS * sizeof(pid_t));
if (!group->tg_members)
{
ret = -ENOMEM;
goto errout_with_group;
}
/* Number of members in allocation */
group->tg_mxmembers = GROUP_INITIAL_MEMBERS;
#endif
/* Attach the group to the TCB */
tcb->cmn.group = group;
/* Inherit the user identity from the parent task group */
group_inherit_identity(group);
/* Initialize file descriptors for the TCB */
files_initlist(&group->tg_filelist);
2023-01-10 10:54:49 +01:00
/* Alloc task info for group */
2023-01-10 10:54:49 +01:00
ret = task_init_info(group);
if (ret < 0)
{
goto errout_with_member;
}
#ifndef CONFIG_DISABLE_PTHREAD
/* Initialize the pthread join mutex */
nxmutex_init(&group->tg_joinlock);
#endif
#if defined(CONFIG_SCHED_WAITPID) && !defined(CONFIG_SCHED_HAVE_PARENT)
/* Initialize the exit/wait semaphores */
nxsem_init(&group->tg_exitsem, 0, 0);
#endif
return OK;
errout_with_member:
#ifdef HAVE_GROUP_MEMBERS
kmm_free(group->tg_members);
errout_with_group:
#endif
kmm_free(group);
return ret;
}
/****************************************************************************
* Name: group_initialize
*
* Description:
* Add the task as the initial member of the group. The full creation of
* the group of a two step process: (1) First, this group structure is
* allocated by group_allocate() early in the task creation sequence, then
* (2) this function is called to set up the initial group membership.
*
* Input Parameters:
* tcb - The tcb in need of the task group.
*
* Returned Value:
* None.
*
* Assumptions:
* Called during task creation in a safe context. No special precautions
* are required here.
*
****************************************************************************/
void group_initialize(FAR struct task_tcb_s *tcb)
{
FAR struct task_group_s *group;
DEBUGASSERT(tcb && tcb->cmn.group);
group = tcb->cmn.group;
/* Allocate mm_map list if required */
mm_map_initialize(&group->tg_mm_map,
(tcb->cmn.flags & TCB_FLAG_TTYPE_KERNEL) != 0);
#ifdef HAVE_GROUP_MEMBERS
/* Assign the PID of this new task as a member of the group. */
group->tg_members[0] = tcb->cmn.pid;
#endif
/* Save the ID of the main task within the group of threads. This needed
2020-10-29 01:12:53 +01:00
* for things like SIGCHLD. It ID is also saved in the TCB of the main
* task but is also retained in the group which may persist after the main
* task has exited.
*/
group->tg_pid = tcb->cmn.pid;
/* Mark that there is one member in the group, the main task */
group->tg_nmembers = 1;
}