semeventmulti-posix.cpp revision dd118948e6e1d931cfbdd3f2dea0d81d509c2d1b
/* $Id$ */
/** @file
* IPRT - Multiple Release Event Semaphore, POSIX.
*/
/*
* Copyright (C) 2006-2007 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <iprt/semaphore.h>
#include <iprt/lockvalidator.h>
#include <errno.h>
#include <pthread.h>
#include <unistd.h>
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/** Posix internal representation of a Mutex Multi semaphore.
* The POSIX implementation uses a mutex and a condition variable to implement
* the automatic reset event semaphore semantics. */
struct RTSEMEVENTMULTIINTERNAL
{
/** pthread condition. */
/** pthread mutex which protects the condition and the event state. */
/** The state of the semaphore.
* This is operated while owning mutex and using atomic updating. */
/** Number of waiters. */
#ifdef RTSEMEVENTMULTI_STRICT
/** Signallers. */
/** Indicates that lock validation should be performed. */
bool volatile fEverHadSignallers;
#endif
/** Set if we're using the monotonic clock. */
bool fMonotonicClock;
};
/** The valus of the u32State variable in RTSEMEVENTMULTIINTERNAL.
* @{ */
/** The object isn't initialized. */
#define EVENTMULTI_STATE_UNINITIALIZED 0
/** The semaphore is signaled. */
#define EVENTMULTI_STATE_SIGNALED 0xff00ff00
/** The semaphore is not signaled. */
#define EVENTMULTI_STATE_NOT_SIGNALED 0x00ff00ff
/** @} */
{
}
RTDECL(int) RTSemEventMultiCreateEx(PRTSEMEVENTMULTI phEventMultiSem, uint32_t fFlags, RTLOCKVALCLASS hClass,
const char *pszNameFmt, ...)
{
/*
* Allocate semaphore handle.
*/
int rc;
struct RTSEMEVENTMULTIINTERNAL *pThis = (struct RTSEMEVENTMULTIINTERNAL *)RTMemAlloc(sizeof(struct RTSEMEVENTMULTIINTERNAL));
if (pThis)
{
/*
* Create the condition variable.
*/
if (!rc)
{
#if defined(CLOCK_MONOTONIC) \
|| /** @todo check other platforms */ 0)
/* ASSUMES RTTimeSystemNanoTS() == RTTimeNanoTS() == clock_gettime(CLOCK_MONOTONIC). */
#else
pThis->fMonotonicClock = false;
#endif
if (!rc)
{
/*
* Create the semaphore.
*/
if (!rc)
{
if (!rc)
{
#ifdef RTSEMEVENTMULTI_STRICT
if (!pszNameFmt)
{
static uint32_t volatile s_iSemEventMultiAnon = 0;
}
else
{
pszNameFmt, va);
}
pThis->fEverHadSignallers = false;
#endif
*phEventMultiSem = pThis;
return VINF_SUCCESS;
}
}
}
}
}
else
rc = VERR_NO_MEMORY;
return rc;
}
{
/*
* Validate handle.
*/
if (pThis == NIL_RTSEMEVENTMULTI)
return VINF_SUCCESS;
AssertReturn(u32 == EVENTMULTI_STATE_NOT_SIGNALED || u32 == EVENTMULTI_STATE_SIGNALED, VERR_INVALID_HANDLE);
/*
* Abort all waiters forcing them to return failure.
*/
int rc;
for (int i = 30; i > 0; i--)
{
break;
usleep(1000);
}
if (rc)
{
return RTErrConvertFromErrno(rc);
}
/*
* Destroy the semaphore
* If it's busy we'll wait a bit to give the threads a chance to be scheduled.
*/
for (int i = 30; i > 0; i--)
{
break;
usleep(1000);
}
if (rc)
{
return RTErrConvertFromErrno(rc);
}
/*
* Free the semaphore memory and be gone.
*/
#ifdef RTSEMEVENTMULTI_STRICT
#endif
return VINF_SUCCESS;
}
{
/*
* Validate input.
*/
AssertReturn(u32 == EVENTMULTI_STATE_NOT_SIGNALED || u32 == EVENTMULTI_STATE_SIGNALED, VERR_INVALID_HANDLE);
#ifdef RTSEMEVENTMULTI_STRICT
if (pThis->fEverHadSignallers)
{
if (RT_FAILURE(rc9))
return rc9;
}
#endif
/*
* Lock the mutex semaphore.
*/
if (rc)
{
return RTErrConvertFromErrno(rc);
}
/*
* Check the state.
*/
{
}
{
}
else
/*
* Release the mutex and return.
*/
if (rc)
return RTErrConvertFromErrno(rc);
if (rc2)
return RTErrConvertFromErrno(rc2);
return VINF_SUCCESS;
}
{
/*
* Validate input.
*/
AssertReturn(u32 == EVENTMULTI_STATE_NOT_SIGNALED || u32 == EVENTMULTI_STATE_SIGNALED, VERR_INVALID_HANDLE);
/*
* Lock the mutex semaphore.
*/
if (rc)
{
return RTErrConvertFromErrno(rc);
}
/*
* Check the state.
*/
/*
* Release the mutex and return.
*/
if (rc)
{
return RTErrConvertFromErrno(rc);
}
return VINF_SUCCESS;
}
/**
* Handle polling (timeout already expired at the time of the call).
*
* @returns VINF_SUCCESs, VERR_TIMEOUT, VERR_SEM_DESTROYED.
* @param pThis The semaphore.
*/
{
AssertMsgReturn(!rc, ("Failed to lock event multi sem %p, rc=%d.\n", pThis, rc), RTErrConvertFromErrno(rc));
return u32State == EVENTMULTI_STATE_SIGNALED
}
/**
* Implemens the indefinite wait.
*
* @returns See RTSemEventMultiWaitEx.
* @param pThis The semaphore.
* @param fFlags See RTSemEventMultiWaitEx.
* @param pSrcPos The source position, can be NULL.
*/
static int rtSemEventMultiPosixWaitIndefinite(struct RTSEMEVENTMULTIINTERNAL *pThis, uint32_t fFlags, PCRTLOCKVALSRCPOS pSrcPos)
{
/* take mutex */
AssertMsgReturn(!rc, ("Failed to lock event multi sem %p, rc=%d.\n", pThis, rc), RTErrConvertFromErrno(rc));
for (;;)
{
/* check state. */
{
return u32State == EVENTMULTI_STATE_SIGNALED
}
/* wait */
#ifdef RTSEMEVENTMULTI_STRICT
if (pThis->fEverHadSignallers)
{
if (RT_FAILURE(rc))
{
return rc;
}
}
#else
#endif
if (RT_UNLIKELY(rc))
{
return RTErrConvertFromErrno(rc);
}
}
}
/**
* Implements the timed wait.
*
* @returns See RTSemEventMultiWaitEx
* @param pThis The semaphore.
* @param fFlags See RTSemEventMultiWaitEx.
* @param uTimeout See RTSemEventMultiWaitEx.
* @param pSrcPos The source position, can be NULL.
*/
static int rtSemEventMultiPosixWaitTimed(struct RTSEMEVENTMULTIINTERNAL *pThis, uint32_t fFlags, uint64_t uTimeout,
{
/*
* Convert uTimeout to a relative value in nano seconds.
*/
if (fFlags & RTSEMWAIT_FLAGS_MILLISECS)
: UINT64_MAX;
if (fFlags & RTSEMWAIT_FLAGS_ABSOLUTE)
{
}
if (uTimeout == 0)
return rtSemEventMultiPosixWaitPoll(pThis);
/*
* Get current time and calc end of deadline relative to real time.
*/
if (!pThis->fMonotonicClock)
{
#ifdef RT_OS_DARWIN
#else
#endif
{
}
/* Note! No need to complete uAbsTimeout for RTSEMWAIT_FLAGS_RELATIVE in this path. */
}
else
{
/* ASSUMES RTTimeSystemNanoTS() == RTTimeNanoTS() == clock_gettime(CLOCK_MONOTONIC). */
if (fFlags & RTSEMWAIT_FLAGS_RELATIVE)
}
/*
* To business!
*/
/* take mutex */
for (;;)
{
/* check state. */
{
return u32State == EVENTMULTI_STATE_SIGNALED
}
/* wait */
#ifdef RTSEMEVENTMULTI_STRICT
if (pThis->fEverHadSignallers)
{
if (RT_FAILURE(rc))
{
return rc;
}
}
#else
#endif
if ( rc
&& ( rc != EINTR /* according to SuS this function shall not return EINTR, but linux man page says differently. */
|| (fFlags & RTSEMWAIT_FLAGS_NORESUME)) )
{
return RTErrConvertFromErrno(rc);
}
/* check the absolute deadline. */
}
}
DECLINLINE(int) rtSemEventMultiPosixWait(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
{
/*
* Validate input.
*/
AssertReturn(u32 == EVENTMULTI_STATE_NOT_SIGNALED || u32 == EVENTMULTI_STATE_SIGNALED, VERR_INVALID_HANDLE);
/*
* Optimize the case where the event is signalled.
*/
{
return rc;
}
/*
* Indefinite or timed wait?
*/
if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
}
RTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
{
#ifndef RTSEMEVENT_STRICT
#else
#endif
}
RTDECL(int) RTSemEventMultiWaitExDebug(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
{
}
{
#ifdef RTSEMEVENTMULTI_STRICT
#endif
}
{
#ifdef RTSEMEVENTMULTI_STRICT
#endif
}
{
#ifdef RTSEMEVENTMULTI_STRICT
#endif
}