2008-01-31 18:59:22 +01:00
|
|
|
/****************************************************************************
|
2014-08-08 21:53:29 +02:00
|
|
|
* sched/semaphore/sem_wait.c
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
2016-02-14 15:17:46 +01:00
|
|
|
* Copyright (C) 2007-2013, 2016 Gregory Nutt. All rights reserved.
|
2012-03-23 21:14:21 +01:00
|
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
*
|
|
|
|
* 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.
|
2008-01-31 18:59:22 +01:00
|
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
2007-02-18 00:21:28 +01:00
|
|
|
* 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.
|
|
|
|
*
|
2008-01-31 18:59:22 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-31 18:59:22 +01:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Included Files
|
2008-01-31 18:59:22 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2009-12-14 19:39:29 +01:00
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
2009-12-14 22:15:18 +01:00
|
|
|
#include <stdbool.h>
|
2007-02-18 00:21:28 +01:00
|
|
|
#include <semaphore.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include <assert.h>
|
2016-02-14 15:17:46 +01:00
|
|
|
|
|
|
|
#include <nuttx/irq.h>
|
2007-02-18 00:21:28 +01:00
|
|
|
#include <nuttx/arch.h>
|
2009-03-10 12:41:20 +01:00
|
|
|
|
2014-08-09 01:53:55 +02:00
|
|
|
#include "sched/sched.h"
|
2014-08-08 21:53:29 +02:00
|
|
|
#include "semaphore/semaphore.h"
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-31 18:59:22 +01:00
|
|
|
/****************************************************************************
|
2007-02-18 00:21:28 +01:00
|
|
|
* Public Functions
|
2008-01-31 18:59:22 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-31 18:59:22 +01:00
|
|
|
/****************************************************************************
|
2012-07-14 21:30:31 +02:00
|
|
|
* Name: sem_wait
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
|
|
|
* Description:
|
2008-01-31 18:59:22 +01:00
|
|
|
* This function attempts to lock the semaphore referenced by 'sem'. If
|
|
|
|
* the semaphore value is (<=) zero, then the calling task will not return
|
|
|
|
* until it successfully acquires the lock.
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
|
|
|
* Parameters:
|
|
|
|
* sem - Semaphore descriptor.
|
|
|
|
*
|
|
|
|
* Return Value:
|
|
|
|
* 0 (OK), or -1 (ERROR) is unsuccessful
|
2008-01-31 18:59:22 +01:00
|
|
|
* If this function returns -1 (ERROR), then the cause of the failure will
|
|
|
|
* be reported in 'errno' as:
|
2007-02-18 00:21:28 +01:00
|
|
|
* - EINVAL: Invalid attempt to get the semaphore
|
2008-01-31 18:59:22 +01:00
|
|
|
* - EINTR: The wait was interrupted by the receipt of a signal.
|
2007-02-18 00:21:28 +01:00
|
|
|
*
|
|
|
|
* Assumptions:
|
|
|
|
*
|
2008-01-31 18:59:22 +01:00
|
|
|
****************************************************************************/
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2008-01-31 18:59:22 +01:00
|
|
|
int sem_wait(FAR sem_t *sem)
|
2007-02-18 00:21:28 +01:00
|
|
|
{
|
2016-02-07 00:44:41 +01:00
|
|
|
FAR struct tcb_s *rtcb = this_task();
|
2016-02-14 15:17:46 +01:00
|
|
|
irqstate_t flags;
|
2013-02-04 19:46:28 +01:00
|
|
|
int ret = ERROR;
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2007-03-10 01:17:29 +01:00
|
|
|
/* This API should not be called from interrupt handlers */
|
|
|
|
|
2015-04-23 15:15:55 +02:00
|
|
|
DEBUGASSERT(up_interrupt_context() == false);
|
2007-03-10 01:17:29 +01:00
|
|
|
|
2016-06-28 16:06:30 +02:00
|
|
|
/* Make sure we were supplied with a valid semaphore. */
|
2007-02-18 00:21:28 +01:00
|
|
|
|
|
|
|
if (sem)
|
|
|
|
{
|
|
|
|
/* The following operations must be performed with interrupts
|
|
|
|
* disabled because sem_post() may be called from an interrupt
|
|
|
|
* handler.
|
|
|
|
*/
|
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
flags = enter_critical_section();
|
2007-02-18 00:21:28 +01:00
|
|
|
|
|
|
|
/* Check if the lock is available */
|
|
|
|
|
|
|
|
if (sem->semcount > 0)
|
|
|
|
{
|
|
|
|
/* It is, let the task take the semaphore. */
|
|
|
|
|
|
|
|
sem->semcount--;
|
2009-03-10 12:41:20 +01:00
|
|
|
sem_addholder(sem);
|
2007-02-18 00:21:28 +01:00
|
|
|
rtcb->waitsem = NULL;
|
|
|
|
ret = OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* The semaphore is NOT available, We will have to block the
|
|
|
|
* current thread of execution.
|
|
|
|
*/
|
|
|
|
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* First, verify that the task is not already waiting on a
|
|
|
|
* semaphore
|
|
|
|
*/
|
|
|
|
|
2013-04-25 23:19:59 +02:00
|
|
|
ASSERT(rtcb->waitsem == NULL);
|
2007-02-18 00:21:28 +01:00
|
|
|
|
2009-03-09 00:33:41 +01:00
|
|
|
/* Handle the POSIX semaphore (but don't set the owner yet) */
|
2007-02-18 00:21:28 +01:00
|
|
|
|
|
|
|
sem->semcount--;
|
|
|
|
|
|
|
|
/* Save the waited on semaphore in the TCB */
|
|
|
|
|
|
|
|
rtcb->waitsem = sem;
|
|
|
|
|
2009-03-09 00:33:41 +01:00
|
|
|
/* If priority inheritance is enabled, then check the priority of
|
|
|
|
* the holder of the semaphore.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef CONFIG_PRIORITY_INHERITANCE
|
|
|
|
/* Disable context switching. The following operations must be
|
|
|
|
* atomic with regard to the scheduler.
|
|
|
|
*/
|
|
|
|
|
|
|
|
sched_lock();
|
2009-03-10 12:41:20 +01:00
|
|
|
|
|
|
|
/* Boost the priority of any threads holding a count on the
|
|
|
|
* semaphore.
|
|
|
|
*/
|
|
|
|
|
|
|
|
sem_boostpriority(sem);
|
2009-03-09 00:33:41 +01:00
|
|
|
#endif
|
2007-02-18 00:21:28 +01:00
|
|
|
/* Add the TCB to the prioritized semaphore wait queue */
|
|
|
|
|
2014-07-31 23:01:37 +02:00
|
|
|
set_errno(0);
|
2007-02-18 00:21:28 +01:00
|
|
|
up_block_task(rtcb, TSTATE_WAIT_SEM);
|
|
|
|
|
|
|
|
/* When we resume at this point, either (1) the semaphore has been
|
|
|
|
* assigned to this thread of execution, or (2) the semaphore wait
|
2011-07-20 15:19:07 +02:00
|
|
|
* has been interrupted by a signal or a timeout. We can detect these
|
|
|
|
* latter cases be examining the errno value.
|
2010-09-10 04:34:19 +02:00
|
|
|
*
|
2011-07-20 15:19:07 +02:00
|
|
|
* In the event that the semaphore wait was interrupted by a signal or
|
|
|
|
* a timeout, certain semaphore clean-up operations have already been
|
2010-09-10 04:34:19 +02:00
|
|
|
* performed (see sem_waitirq.c). Specifically:
|
|
|
|
*
|
|
|
|
* - sem_canceled() was called to restore the priority of all threads
|
|
|
|
* that hold a reference to the semaphore,
|
|
|
|
* - The semaphore count was decremented, and
|
|
|
|
* - tcb->waitsem was nullifed.
|
|
|
|
*
|
|
|
|
* It is necesaary to do these things in sem_waitirq.c because a long
|
|
|
|
* time may elapse between the time that the signal was issued and
|
|
|
|
* this thread is awakened and this leaves a door open to several
|
|
|
|
* race conditions.
|
2007-02-18 00:21:28 +01:00
|
|
|
*/
|
|
|
|
|
2014-07-31 23:01:37 +02:00
|
|
|
if (get_errno() != EINTR && get_errno() != ETIMEDOUT)
|
2007-03-19 17:38:47 +01:00
|
|
|
{
|
2011-07-20 15:19:07 +02:00
|
|
|
/* Not awakened by a signal or a timeout... We hold the semaphore */
|
2009-03-09 00:33:41 +01:00
|
|
|
|
2009-03-10 12:41:20 +01:00
|
|
|
sem_addholder(sem);
|
2007-03-19 17:38:47 +01:00
|
|
|
ret = OK;
|
|
|
|
}
|
2009-03-12 02:53:20 +01:00
|
|
|
|
|
|
|
#ifdef CONFIG_PRIORITY_INHERITANCE
|
|
|
|
sched_unlock();
|
|
|
|
#endif
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Interrupts may now be enabled. */
|
|
|
|
|
2016-02-14 15:17:46 +01:00
|
|
|
leave_critical_section(flags);
|
2007-02-18 00:21:28 +01:00
|
|
|
}
|
2016-06-28 16:06:30 +02:00
|
|
|
else
|
|
|
|
{
|
|
|
|
set_errno(EINVAL);
|
|
|
|
}
|
2007-02-18 00:21:28 +01:00
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|