5b281ba489ca18f0380d7efc7a5108b606cce449vboxsync * IPRT - Multiple Release Event Semaphores, Ring-0 Driver, Linux.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2011 Oracle Corporation
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * available from http://www.virtualbox.org. This file is free software;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * The contents of this file may alternatively be used under the terms
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * of the Common Development and Distribution License Version 1.0
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution, in which case the provisions of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * CDDL are applicable instead of those of the GPL.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * You may elect to license modified versions of this file under the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * terms and conditions of either the GPL or the CDDL or both.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Header Files *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync*******************************************************************************/
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/*******************************************************************************
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync* Defined Constants And Macros *
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync*******************************************************************************/
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/** @name fStateAndGen values
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/** The state bit number. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/** The state mask. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync#define RTSEMEVENTMULTILNX_STATE_MASK RT_BIT_32(RTSEMEVENTMULTILNX_STATE_BIT)
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/** The generation mask. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync#define RTSEMEVENTMULTILNX_GEN_MASK ~RTSEMEVENTMULTILNX_STATE_MASK
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/** The generation shift. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync/** The initial variable value. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync#define RTSEMEVENTMULTILNX_STATE_GEN_INIT UINT32_C(0xfffffffc)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Structures and Typedefs *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync*******************************************************************************/
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Linux event semaphore.
9197680d465154232353e065bfc7e7b0fe026b97vboxsync /** Magic value (RTSEMEVENTMULTI_MAGIC). */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync /** The object state bit and generation counter.
81a2bceb78e8b2f05efef55789b1689b31b3acacvboxsync * The generation counter is incremented every time the object is
81a2bceb78e8b2f05efef55789b1689b31b3acacvboxsync * signalled. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync /** Reference counter. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /** The wait queue. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync} RTSEMEVENTMULTIINTERNAL, *PRTSEMEVENTMULTIINTERNAL;
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiCreate(PRTSEMEVENTMULTI phEventMultiSem)
ab93606043a9881487aa83be04191d2f4ea24071vboxsync return RTSemEventMultiCreateEx(phEventMultiSem, 0 /*fFlags*/, NIL_RTLOCKVALCLASS, NULL);
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiCreateEx(PRTSEMEVENTMULTI phEventMultiSem, uint32_t fFlags, RTLOCKVALCLASS hClass,
ab93606043a9881487aa83be04191d2f4ea24071vboxsync const char *pszNameFmt, ...)
29c2b5255de6d54cace83d114cc1ada61afd1047vboxsync AssertReturn(!(fFlags & ~RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL), VERR_INVALID_PARAMETER);
29c2b5255de6d54cace83d114cc1ada61afd1047vboxsync pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync pThis->fStateAndGen = RTSEMEVENTMULTILNX_STATE_GEN_INIT;
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * Retain a reference to the semaphore.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * @param pThis The semaphore.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsyncDECLINLINE(void) rtR0SemEventMultiLnxRetain(PRTSEMEVENTMULTIINTERNAL pThis)
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * Release a reference, destroy the thing if necessary.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * @param pThis The semaphore.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsyncDECLINLINE(void) rtR0SemEventMultiLnxRelease(PRTSEMEVENTMULTIINTERNAL pThis)
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync if (RT_UNLIKELY(ASMAtomicDecU32(&pThis->cRefs) == 0))
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI hEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
9197680d465154232353e065bfc7e7b0fe026b97vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Invalidate it and signal the object just in case.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync ASMAtomicWriteU32(&pThis->u32Magic, ~RTSEMEVENTMULTI_MAGIC);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync ASMAtomicAndU32(&pThis->fStateAndGen, RTSEMEVENTMULTILNX_GEN_MASK);
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI hEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
9197680d465154232353e065bfc7e7b0fe026b97vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * Signal the event object. The cause of the paranoia here is racing to try
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * deal with racing RTSemEventMultiSignal calls (should probably be
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * forbidden, but it's relatively easy to handle).
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync fNew = fOld = ASMAtomicUoReadU32(&pThis->fStateAndGen);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync while (!ASMAtomicCmpXchgU32(&pThis->fStateAndGen, fNew, fOld));
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI hEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
9197680d465154232353e065bfc7e7b0fe026b97vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Reset it.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync ASMAtomicAndU32(&pThis->fStateAndGen, ~RTSEMEVENTMULTILNX_STATE_MASK);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * Worker for RTSemEventMultiWaitEx and RTSemEventMultiWaitExDebug.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @returns VBox status code.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param pThis The event semaphore.
683eff3070b1b86fe71b71af7fda82766ea19d17vboxsync * @param fFlags See RTSemEventMultiWaitEx.
683eff3070b1b86fe71b71af7fda82766ea19d17vboxsync * @param uTimeout See RTSemEventMultiWaitEx.
683eff3070b1b86fe71b71af7fda82766ea19d17vboxsync * @param pSrcPos The source code position of the wait.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsyncstatic int rtR0SemEventMultiLnxWait(PRTSEMEVENTMULTIINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * Validate the input.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
81a2bceb78e8b2f05efef55789b1689b31b3acacvboxsync AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * Is the event already signalled or do we have to wait?
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync fOrgStateAndGen = ASMAtomicUoReadU32(&pThis->fStateAndGen);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync if (fOrgStateAndGen & RTSEMEVENTMULTILNX_STATE_MASK)
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync * We have to wait.
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync rc = rtR0SemLnxWaitInit(&Wait, fFlags, uTimeout, &pThis->Head);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync /* The destruction test. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync if (RT_UNLIKELY(pThis->u32Magic != RTSEMEVENTMULTI_MAGIC))
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync /* Check the exit conditions. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync if (RT_UNLIKELY(pThis->u32Magic != RTSEMEVENTMULTI_MAGIC))
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync else if (ASMAtomicUoReadU32(&pThis->fStateAndGen) != fOrgStateAndGen)
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync /* Do the wait and then recheck the conditions. */
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsyncRTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync return rtR0SemEventMultiLnxWait(hEventMultiSem, fFlags, uTimeout, NULL);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync return rtR0SemEventMultiLnxWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsyncRTDECL(int) RTSemEventMultiWaitExDebug(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
d1c36fd86d36726777e3d6f9d040573e0aaf30devboxsync RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();