2013-02-06 16:43:28 +01:00
|
|
|
/****************************************************************************
|
2021-03-08 22:39:04 +01:00
|
|
|
* sched/group/group_killchildren.c
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
2020-05-16 17:06:29 +02:00
|
|
|
* 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
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
2020-05-16 17:06:29 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
2020-05-16 17:06:29 +02:00
|
|
|
* 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.
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
2023-03-10 01:20:48 +01:00
|
|
|
#include <assert.h>
|
2021-05-14 04:45:57 +02:00
|
|
|
#include <debug.h>
|
2023-03-10 01:20:48 +01:00
|
|
|
#include <pthread.h>
|
|
|
|
#include <sched.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <sys/types.h>
|
2013-02-06 16:43:28 +01:00
|
|
|
|
2018-08-29 15:33:28 +02:00
|
|
|
#include <nuttx/sched.h>
|
2023-10-24 16:23:22 +02:00
|
|
|
#include <nuttx/signal.h>
|
2018-08-29 15:33:28 +02:00
|
|
|
|
|
|
|
#include "sched/sched.h"
|
2014-08-08 22:06:42 +02:00
|
|
|
#include "group/group.h"
|
2013-02-06 16:43:28 +01:00
|
|
|
|
2015-09-01 15:04:09 +02:00
|
|
|
#ifdef HAVE_GROUP_MEMBERS
|
2013-02-06 16:43:28 +01:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2015-10-03 15:25:53 +02:00
|
|
|
/****************************************************************************
|
2020-05-16 17:06:29 +02:00
|
|
|
* Name: group_kill_children_handler
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Callback from group_foreachchild that handles one member of the group.
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2018-08-29 23:50:01 +02:00
|
|
|
* pid - The ID of the group member that may be signaled.
|
2013-02-06 16:43:28 +01:00
|
|
|
* arg - The PID of the thread to be retained.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2018-09-02 21:51:52 +02:00
|
|
|
* 0 (OK) always
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
2015-10-03 15:25:53 +02:00
|
|
|
****************************************************************************/
|
2013-02-06 16:43:28 +01:00
|
|
|
|
2023-05-11 14:26:00 +02:00
|
|
|
#if defined(CONFIG_GROUP_KILL_CHILDREN_TIMEOUT_MS) && \
|
|
|
|
CONFIG_GROUP_KILL_CHILDREN_TIMEOUT_MS != 0
|
2020-05-16 17:06:29 +02:00
|
|
|
static int group_kill_children_handler(pid_t pid, FAR void *arg)
|
2023-05-11 14:26:00 +02:00
|
|
|
{
|
|
|
|
/* Cancel all threads except for the one specified by the argument */
|
|
|
|
|
|
|
|
if (pid != (pid_t)((uintptr_t)arg))
|
|
|
|
{
|
|
|
|
pthread_kill(pid, SIGTERM);
|
|
|
|
}
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: group_cancel_children_handler
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Callback from group_foreachchild that handles one member of the group.
|
|
|
|
*
|
|
|
|
* Input Parameters:
|
|
|
|
* pid - The ID of the group member that may be signaled.
|
|
|
|
* arg - The PID of the thread to be retained.
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* 0 (OK) always
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
static int group_cancel_children_handler(pid_t pid, FAR void *arg)
|
2013-02-06 16:43:28 +01:00
|
|
|
{
|
2018-08-29 15:33:28 +02:00
|
|
|
FAR struct tcb_s *rtcb;
|
2018-08-29 23:50:01 +02:00
|
|
|
int ret;
|
2013-02-06 16:43:28 +01:00
|
|
|
|
2018-08-29 15:33:28 +02:00
|
|
|
/* Cancel all threads except for the one specified by the argument */
|
2013-02-06 16:43:28 +01:00
|
|
|
|
|
|
|
if (pid != (pid_t)((uintptr_t)arg))
|
|
|
|
{
|
2018-08-29 15:33:28 +02:00
|
|
|
/* Cancel this thread. This is a forced cancellation. Make sure that
|
|
|
|
* cancellation is not disabled by the task/thread. That bit will
|
2022-10-19 12:33:30 +02:00
|
|
|
* prevent pthread_cancel() or nxtask_delete() from doing what they
|
|
|
|
* need to do.
|
2018-08-29 15:33:28 +02:00
|
|
|
*/
|
|
|
|
|
2020-05-09 16:04:45 +02:00
|
|
|
rtcb = nxsched_get_tcb(pid);
|
2018-08-29 23:50:01 +02:00
|
|
|
if (rtcb != NULL)
|
2018-08-29 15:33:28 +02:00
|
|
|
{
|
2018-08-29 23:50:01 +02:00
|
|
|
/* This is a forced cancellation. Make sure that cancellation is
|
|
|
|
* not disabled by the task/thread. That bit would prevent
|
|
|
|
* pthread_cancel() or task_delete() from doing what they need
|
|
|
|
* to do.
|
|
|
|
*/
|
|
|
|
|
|
|
|
rtcb->flags &= ~TCB_FLAG_NONCANCELABLE;
|
|
|
|
|
|
|
|
/* 'pid' could refer to the main task of the thread. That pid
|
|
|
|
* will appear in the group member list as well!
|
|
|
|
*/
|
|
|
|
|
|
|
|
if ((rtcb->flags & TCB_FLAG_TTYPE_MASK) == TCB_FLAG_TTYPE_PTHREAD)
|
|
|
|
{
|
|
|
|
ret = pthread_cancel(pid);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2022-10-19 12:33:30 +02:00
|
|
|
ret = nxtask_delete(pid);
|
2018-08-29 23:50:01 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
serr("ERROR: Failed to kill %d: %d\n", ret, pid);
|
|
|
|
}
|
2018-08-29 15:33:28 +02:00
|
|
|
}
|
2013-02-06 16:43:28 +01:00
|
|
|
}
|
|
|
|
|
2019-03-01 17:50:02 +01:00
|
|
|
/* Always return zero. We need to visit each member of the group. */
|
2018-08-29 23:50:01 +02:00
|
|
|
|
|
|
|
return OK;
|
2013-02-06 16:43:28 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
2020-05-16 17:06:29 +02:00
|
|
|
* Name: group_kill_children
|
2013-02-06 16:43:28 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Delete all children of a task except for the specified task. This is
|
2018-08-29 23:50:01 +02:00
|
|
|
* used by the task restart logic and by the default signal handling
|
|
|
|
* abnormal termination logic. When the main task is restarted or killed,
|
2013-02-06 16:43:28 +01:00
|
|
|
* all of its child pthreads must be terminated.
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2013-02-06 16:43:28 +01:00
|
|
|
* tcb - TCB of the task to be retained.
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2013-02-06 16:43:28 +01:00
|
|
|
* None
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2020-06-03 13:33:56 +02:00
|
|
|
int group_kill_children(FAR struct tcb_s *tcb)
|
2013-02-06 16:43:28 +01:00
|
|
|
{
|
2018-08-29 23:50:01 +02:00
|
|
|
int ret;
|
|
|
|
|
2023-02-16 09:13:27 +01:00
|
|
|
DEBUGASSERT(tcb->group);
|
|
|
|
|
2023-05-11 14:26:00 +02:00
|
|
|
if (tcb->group->tg_flags & GROUP_FLAG_EXITING)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2021-02-03 01:34:14 +01:00
|
|
|
#ifdef CONFIG_SMP
|
|
|
|
/* NOTE: sched_lock() is not enough for SMP
|
|
|
|
* because tcb->group will be accessed from the child tasks
|
|
|
|
*/
|
|
|
|
|
|
|
|
irqstate_t flags = enter_critical_section();
|
|
|
|
#else
|
2018-08-29 23:50:01 +02:00
|
|
|
/* Lock the scheduler so that there this thread will not lose priority
|
|
|
|
* until all of its children are suspended.
|
|
|
|
*/
|
|
|
|
|
|
|
|
sched_lock();
|
2021-02-03 01:34:14 +01:00
|
|
|
#endif
|
2023-02-16 09:13:27 +01:00
|
|
|
|
|
|
|
/* Tell the children that this group has started exiting */
|
|
|
|
|
|
|
|
tcb->group->tg_flags |= GROUP_FLAG_EXITING;
|
|
|
|
|
2023-05-11 14:26:00 +02:00
|
|
|
#if defined(CONFIG_GROUP_KILL_CHILDREN_TIMEOUT_MS) && \
|
|
|
|
CONFIG_GROUP_KILL_CHILDREN_TIMEOUT_MS != 0
|
|
|
|
/* Send SIGTERM for each first */
|
|
|
|
|
|
|
|
group_foreachchild(tcb->group, group_kill_children_handler,
|
|
|
|
(FAR void *)((uintptr_t)tcb->pid));
|
|
|
|
|
|
|
|
/* Wait a bit for child exit */
|
|
|
|
|
|
|
|
ret = CONFIG_GROUP_KILL_CHILDREN_TIMEOUT_MS;
|
|
|
|
while (1)
|
|
|
|
{
|
|
|
|
if (tcb->group->tg_nmembers <= 1)
|
2023-10-24 16:23:22 +02:00
|
|
|
{
|
2023-05-11 14:26:00 +02:00
|
|
|
break;
|
2023-10-24 16:23:22 +02:00
|
|
|
}
|
2023-05-11 14:26:00 +02:00
|
|
|
|
2023-10-24 16:23:22 +02:00
|
|
|
nxsig_usleep(USEC_PER_MSEC);
|
2023-05-11 14:26:00 +02:00
|
|
|
|
|
|
|
# if CONFIG_GROUP_KILL_CHILDREN_TIMEOUT_MS > 0
|
|
|
|
if (--ret < 0)
|
|
|
|
{
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
# endif
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Force cancel/delete again */
|
|
|
|
|
|
|
|
ret = group_foreachchild(tcb->group, group_cancel_children_handler,
|
2020-06-03 13:33:56 +02:00
|
|
|
(FAR void *)((uintptr_t)tcb->pid));
|
2023-02-16 09:13:27 +01:00
|
|
|
|
2021-02-03 01:34:14 +01:00
|
|
|
#ifdef CONFIG_SMP
|
|
|
|
leave_critical_section(flags);
|
|
|
|
#else
|
2018-08-29 23:50:01 +02:00
|
|
|
sched_unlock();
|
2021-02-03 01:34:14 +01:00
|
|
|
#endif
|
2018-08-29 23:50:01 +02:00
|
|
|
return ret;
|
2013-02-06 16:43:28 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
#endif /* HAVE_GROUP_MEMBERS */
|