2008-01-30 22:59:12 +01:00
|
|
|
/****************************************************************************
|
2014-08-08 22:21:48 +02:00
|
|
|
* sched/pthread/pthread_condtimedwait.c
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2020-04-06 00:33:44 +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
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2020-04-06 00:33:44 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2020-04-06 00:33:44 +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.
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2008-01-30 22:59:12 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-30 22:59:12 +01:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Included Files
|
2008-01-30 22:59:12 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2009-12-14 19:39:29 +01:00
|
|
|
#include <nuttx/config.h>
|
2007-02-27 22:17:21 +01:00
|
|
|
#include <nuttx/compiler.h>
|
2009-12-14 19:39:29 +01:00
|
|
|
|
2009-12-14 20:30:18 +01:00
|
|
|
#include <stdint.h>
|
2020-03-13 07:44:16 +01:00
|
|
|
#include <stdarg.h>
|
2007-02-18 00:21:28 +01:00
|
|
|
#include <unistd.h>
|
|
|
|
#include <pthread.h>
|
|
|
|
#include <signal.h>
|
|
|
|
#include <time.h>
|
|
|
|
#include <errno.h>
|
2013-02-06 16:43:28 +01:00
|
|
|
#include <assert.h>
|
2007-02-18 00:21:28 +01:00
|
|
|
#include <debug.h>
|
2009-12-14 20:30:18 +01:00
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
#include <nuttx/irq.h>
|
2014-08-21 19:16:55 +02:00
|
|
|
#include <nuttx/wdog.h>
|
2017-10-07 18:57:09 +02:00
|
|
|
#include <nuttx/signal.h>
|
2016-12-10 16:08:26 +01:00
|
|
|
#include <nuttx/cancelpt.h>
|
2014-08-21 19:16:55 +02:00
|
|
|
|
2014-08-09 01:53:55 +02:00
|
|
|
#include "sched/sched.h"
|
2014-08-08 20:55:02 +02:00
|
|
|
#include "pthread/pthread.h"
|
2014-08-08 22:43:02 +02:00
|
|
|
#include "clock/clock.h"
|
2014-08-08 20:44:44 +02:00
|
|
|
#include "signal/signal.h"
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-30 22:59:12 +01:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Private Functions
|
2008-01-30 22:59:12 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-30 22:59:12 +01:00
|
|
|
/****************************************************************************
|
2012-07-14 21:30:31 +02:00
|
|
|
* Name: pthread_condtimedout
|
2007-02-27 22:17:21 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This function is called if the timeout elapses before
|
|
|
|
* the condition is signaled.
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2007-02-27 22:17:21 +01:00
|
|
|
* argc - the number of arguments (should be 2)
|
2007-03-29 15:28:27 +02:00
|
|
|
* pid - the task ID of the task to wakeup
|
2007-02-27 22:17:21 +01:00
|
|
|
* signo - The signal to use to wake up the task
|
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2007-02-27 22:17:21 +01:00
|
|
|
* None
|
|
|
|
*
|
|
|
|
* Assumptions:
|
|
|
|
*
|
2008-01-30 22:59:12 +01:00
|
|
|
****************************************************************************/
|
2007-02-27 22:17:21 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
static void pthread_condtimedout(int argc, wdparm_t arg1, ...)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2020-03-13 07:44:16 +01:00
|
|
|
pid_t pid = (pid_t)arg1;
|
|
|
|
int signo;
|
|
|
|
va_list ap;
|
2013-02-05 20:50:37 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
/* Retrieve the variadic argument */
|
2013-02-05 20:50:37 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
va_start(ap, arg1);
|
|
|
|
signo = (int)va_arg(ap, wdparm_t);
|
|
|
|
va_end(ap);
|
2013-02-05 20:50:37 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
#ifdef HAVE_GROUP_MEMBERS
|
2013-02-05 20:50:37 +01:00
|
|
|
{
|
2020-03-13 07:44:16 +01:00
|
|
|
FAR struct tcb_s *tcb;
|
|
|
|
siginfo_t info;
|
|
|
|
|
|
|
|
/* The logic below if equivalent to nxsig_queue(), but uses
|
|
|
|
* nxsig_tcbdispatch() instead of nxsig_dispatch(). This avoids the
|
|
|
|
* group signal deliver logic and assures, instead, that the signal is
|
|
|
|
* delivered specifically to this thread that is known to be waiting on
|
|
|
|
* the signal.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Get the waiting TCB. sched_gettcb() might return NULL if the task
|
|
|
|
* has exited for some reason.
|
|
|
|
*/
|
|
|
|
|
|
|
|
tcb = sched_gettcb(pid);
|
|
|
|
if (tcb)
|
|
|
|
{
|
|
|
|
/* Create the siginfo structure */
|
2013-02-05 20:50:37 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
info.si_signo = signo;
|
|
|
|
info.si_code = SI_QUEUE;
|
|
|
|
info.si_errno = ETIMEDOUT;
|
|
|
|
info.si_value.sival_ptr = NULL;
|
2013-02-05 20:50:37 +01:00
|
|
|
#ifdef CONFIG_SCHED_HAVE_PARENT
|
2020-03-13 07:44:16 +01:00
|
|
|
info.si_pid = pid;
|
|
|
|
info.si_status = OK;
|
2013-02-05 20:50:37 +01:00
|
|
|
#endif
|
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
/* Process the receipt of the signal. The scheduler is not locked
|
|
|
|
* as is normally the case when this function is called because we
|
|
|
|
* are in a watchdog timer interrupt handler.
|
|
|
|
*/
|
2013-02-05 20:50:37 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
nxsig_tcbdispatch(tcb, &info);
|
|
|
|
}
|
2013-02-05 20:50:37 +01:00
|
|
|
}
|
|
|
|
#else /* HAVE_GROUP_MEMBERS */
|
2020-03-13 07:44:16 +01:00
|
|
|
{
|
|
|
|
/* Things are a little easier if there are not group members. We can
|
|
|
|
* just use nxsig_queue().
|
|
|
|
*/
|
2013-02-05 20:50:37 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
union sigval value;
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
/* Send the specified signal to the specified task. */
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2020-03-13 07:44:16 +01:00
|
|
|
value.sival_ptr = NULL;
|
|
|
|
nxsig_queue((int)pid, signo, value);
|
|
|
|
}
|
2013-02-05 20:50:37 +01:00
|
|
|
|
|
|
|
#endif /* HAVE_GROUP_MEMBERS */
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
|
2008-01-30 22:59:12 +01:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Public Functions
|
2008-01-30 22:59:12 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-30 22:59:12 +01:00
|
|
|
/****************************************************************************
|
2012-07-14 21:30:31 +02:00
|
|
|
* Name: pthread_cond_timedwait
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* A thread can perform a timed wait on a condition variable.
|
|
|
|
*
|
2018-03-13 16:52:27 +01:00
|
|
|
* Input Parameters:
|
2007-02-27 22:17:21 +01:00
|
|
|
* cond - the condition variable to wait on
|
|
|
|
* mutex - the mutex that protects the condition variable
|
|
|
|
* abstime - wait until this absolute time
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2018-02-01 17:00:02 +01:00
|
|
|
* Returned Value:
|
2017-03-26 19:22:17 +02:00
|
|
|
* OK (0) on success; A non-zero errno value is returned on failure.
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
|
|
|
* Assumptions:
|
2017-03-26 19:22:17 +02:00
|
|
|
* Timing is of resolution 1 msec, with +/-1 millisecond accuracy.
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2008-01-30 22:59:12 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2020-04-06 00:33:44 +02:00
|
|
|
int pthread_cond_timedwait(FAR pthread_cond_t *cond,
|
|
|
|
FAR pthread_mutex_t *mutex,
|
2008-01-30 22:59:12 +01:00
|
|
|
FAR const struct timespec *abstime)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2016-02-07 00:44:41 +01:00
|
|
|
FAR struct tcb_s *rtcb = this_task();
|
2017-04-11 19:03:25 +02:00
|
|
|
irqstate_t flags;
|
2018-06-16 20:16:13 +02:00
|
|
|
sclock_t ticks;
|
2013-02-06 16:43:28 +01:00
|
|
|
int mypid = (int)getpid();
|
|
|
|
int ret = OK;
|
|
|
|
int status;
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2016-06-12 00:42:42 +02:00
|
|
|
sinfo("cond=0x%p mutex=0x%p abstime=0x%p\n", cond, mutex, abstime);
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2013-02-06 16:43:28 +01:00
|
|
|
DEBUGASSERT(rtcb->waitdog == NULL);
|
|
|
|
|
2016-12-09 23:50:34 +01:00
|
|
|
/* pthread_cond_timedwait() is a cancellation point */
|
|
|
|
|
2020-01-02 17:49:34 +01:00
|
|
|
enter_cancellation_point();
|
2016-12-09 23:50:34 +01:00
|
|
|
|
2007-02-18 00:21:28 +01:00
|
|
|
/* Make sure that non-NULL references were provided. */
|
|
|
|
|
|
|
|
if (!cond || !mutex)
|
|
|
|
{
|
|
|
|
ret = EINVAL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Make sure that the caller holds the mutex */
|
|
|
|
|
|
|
|
else if (mutex->pid != mypid)
|
|
|
|
{
|
|
|
|
ret = EPERM;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* If no wait time is provided, this function degenerates to
|
|
|
|
* the same behavior as pthread_cond_wait().
|
|
|
|
*/
|
|
|
|
|
|
|
|
else if (!abstime)
|
|
|
|
{
|
|
|
|
ret = pthread_cond_wait(cond, mutex);
|
|
|
|
}
|
|
|
|
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* Create a watchdog */
|
|
|
|
|
2013-02-06 16:43:28 +01:00
|
|
|
rtcb->waitdog = wd_create();
|
|
|
|
if (!rtcb->waitdog)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
|
|
|
ret = EINVAL;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2016-06-12 00:42:42 +02:00
|
|
|
sinfo("Give up mutex...\n");
|
2007-02-18 00:21:28 +01:00
|
|
|
|
|
|
|
/* We must disable pre-emption and interrupts here so that
|
|
|
|
* the time stays valid until the wait begins. This adds
|
|
|
|
* complexity because we assure that interrupts and
|
|
|
|
* pre-emption are re-enabled correctly.
|
|
|
|
*/
|
|
|
|
|
|
|
|
sched_lock();
|
2016-02-14 15:17:46 +01:00
|
|
|
flags = enter_critical_section();
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2020-04-06 00:33:44 +02:00
|
|
|
/* Convert the timespec to clock ticks. We must disable pre-
|
|
|
|
* emption here so that this time stays valid until the wait
|
|
|
|
* begins.
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2007-03-21 18:21:26 +01:00
|
|
|
ret = clock_abstime2ticks(CLOCK_REALTIME, abstime, &ticks);
|
2007-02-18 00:21:28 +01:00
|
|
|
if (ret)
|
|
|
|
{
|
|
|
|
/* Restore interrupts (pre-emption will be enabled when
|
2017-03-26 19:22:17 +02:00
|
|
|
* we fall through the if/then/else)
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
leave_critical_section(flags);
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2020-04-06 00:33:44 +02:00
|
|
|
/* Check the absolute time to wait. If it is now or in the
|
|
|
|
* past, then just return with the timedout condition.
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
if (ticks <= 0)
|
|
|
|
{
|
2020-04-06 00:33:44 +02:00
|
|
|
/* Restore interrupts and indicate that we have already
|
|
|
|
* timed out. (pre-emption will be enabled when we fall
|
|
|
|
* through the if/then/else
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
leave_critical_section(flags);
|
2007-02-18 00:21:28 +01:00
|
|
|
ret = ETIMEDOUT;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2020-04-06 00:33:44 +02:00
|
|
|
#ifndef CONFIG_PTHREAD_MUTEX_UNSAFE
|
|
|
|
uint8_t mflags;
|
|
|
|
#endif
|
|
|
|
#ifdef CONFIG_PTHREAD_MUTEX_TYPES
|
|
|
|
uint8_t type;
|
|
|
|
int16_t nlocks;
|
|
|
|
#endif
|
2007-02-18 00:21:28 +01:00
|
|
|
/* Give up the mutex */
|
|
|
|
|
2015-06-16 16:27:38 +02:00
|
|
|
mutex->pid = -1;
|
2020-04-06 00:33:44 +02:00
|
|
|
#ifndef CONFIG_PTHREAD_MUTEX_UNSAFE
|
|
|
|
mflags = mutex->flags;
|
|
|
|
#endif
|
|
|
|
#ifdef CONFIG_PTHREAD_MUTEX_TYPES
|
|
|
|
type = mutex->type;
|
|
|
|
nlocks = mutex->nlocks;
|
|
|
|
#endif
|
|
|
|
ret = pthread_mutex_give(mutex);
|
2017-03-26 19:22:17 +02:00
|
|
|
if (ret != 0)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2020-04-06 00:33:44 +02:00
|
|
|
/* Restore interrupts (pre-emption will be enabled
|
|
|
|
* when we fall through the if/then/else)
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
leave_critical_section(flags);
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* Start the watchdog */
|
|
|
|
|
2020-01-02 17:49:34 +01:00
|
|
|
wd_start(rtcb->waitdog, ticks,
|
2020-03-13 07:44:16 +01:00
|
|
|
pthread_condtimedout,
|
|
|
|
2, (wdparm_t)mypid,
|
|
|
|
(wdparm_t)SIGCONDTIMEDOUT);
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2020-04-06 00:33:44 +02:00
|
|
|
/* Take the condition semaphore. Do not restore
|
|
|
|
* interrupts until we return from the wait. This is
|
|
|
|
* necessary to make sure that the watchdog timer and
|
|
|
|
* the condition wait are started atomically.
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2017-10-04 23:22:27 +02:00
|
|
|
status = nxsem_wait((FAR sem_t *)&cond->sem);
|
2007-02-18 00:21:28 +01:00
|
|
|
|
|
|
|
/* Did we get the condition semaphore. */
|
|
|
|
|
2017-10-04 23:22:27 +02:00
|
|
|
if (status < 0)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2017-10-04 23:22:27 +02:00
|
|
|
/* NO.. Handle the special case where the semaphore
|
|
|
|
* wait was awakened by the receipt of a signal --
|
2020-04-06 00:33:44 +02:00
|
|
|
* presumably the signal posted by
|
|
|
|
* pthread_condtimedout().
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2017-10-04 23:22:27 +02:00
|
|
|
if (status == -EINTR)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2017-10-10 16:43:10 +02:00
|
|
|
swarn("WARNING: Timedout!\n");
|
2007-02-18 00:21:28 +01:00
|
|
|
ret = ETIMEDOUT;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2017-10-04 23:22:27 +02:00
|
|
|
ret = status;
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
}
|
2007-03-19 17:39:14 +01:00
|
|
|
|
2020-04-06 00:33:44 +02:00
|
|
|
/* The interrupts stay disabled until after we sample
|
|
|
|
* the errno. This is because when debug is enabled
|
|
|
|
* and the console is used for debug output, then the
|
|
|
|
* errno can be altered by interrupt handling! (bad)
|
2007-03-19 17:39:14 +01:00
|
|
|
*/
|
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
leave_critical_section(flags);
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Reacquire the mutex (retaining the ret). */
|
|
|
|
|
2016-06-12 00:42:42 +02:00
|
|
|
sinfo("Re-locking...\n");
|
2017-04-11 19:03:25 +02:00
|
|
|
|
2019-02-24 21:04:24 +01:00
|
|
|
status = pthread_mutex_take(mutex, NULL, false);
|
2017-03-26 19:22:17 +02:00
|
|
|
if (status == OK)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2020-04-06 00:33:44 +02:00
|
|
|
mutex->pid = mypid;
|
|
|
|
#ifndef CONFIG_PTHREAD_MUTEX_UNSAFE
|
|
|
|
mutex->flags = mflags;
|
|
|
|
#endif
|
|
|
|
#ifdef CONFIG_PTHREAD_MUTEX_TYPES
|
|
|
|
mutex->type = type;
|
|
|
|
mutex->nlocks = nlocks;
|
|
|
|
#endif
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
2017-03-26 19:22:17 +02:00
|
|
|
else if (ret == 0)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2020-04-06 00:33:44 +02:00
|
|
|
ret = status;
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Re-enable pre-emption (It is expected that interrupts
|
|
|
|
* have already been re-enabled in the above logic)
|
|
|
|
*/
|
|
|
|
|
|
|
|
sched_unlock();
|
|
|
|
}
|
|
|
|
|
|
|
|
/* We no longer need the watchdog */
|
|
|
|
|
2013-02-06 16:43:28 +01:00
|
|
|
wd_delete(rtcb->waitdog);
|
|
|
|
rtcb->waitdog = NULL;
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-09 23:50:34 +01:00
|
|
|
leave_cancellation_point();
|
2016-06-12 00:42:42 +02:00
|
|
|
sinfo("Returning %d\n", ret);
|
2007-02-18 00:21:28 +01:00
|
|
|
return ret;
|
|
|
|
}
|