semeventmulti-r0drv-linux.c revision d1c36fd86d36726777e3d6f9d040573e0aaf30de
5b281ba489ca18f0380d7efc7a5108b606cce449vboxsync * IPRT - Multiple Release Event Semaphores, Ring-0 Driver, Linux.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Copyright (C) 2006-2010 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.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Header Files *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync*******************************************************************************/
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Defined Constants And Macros *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync*******************************************************************************/
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/** @name fStateAndGen values
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/** The state bit number. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/** The state mask. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#define RTSEMEVENTMULTILNX_STATE_MASK RT_BIT_32(RTSEMEVENTMULTILNX_STATE_BIT)
9197680d465154232353e065bfc7e7b0fe026b97vboxsync/** The generation mask. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#define RTSEMEVENTMULTILNX_GEN_MASK ~RTSEMEVENTMULTILNX_STATE_MASK
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/** The generation shift. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/** The initial variable value. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#define RTSEMEVENTMULTILNX_STATE_GEN_INIT UINT32_C(0xfffffffc)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Structures and Typedefs *
ab93606043a9881487aa83be04191d2f4ea24071vboxsync*******************************************************************************/
ab93606043a9881487aa83be04191d2f4ea24071vboxsync * Linux event semaphore.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync /** Magic value (RTSEMEVENTMULTI_MAGIC). */
ab93606043a9881487aa83be04191d2f4ea24071vboxsync /** The object state bit and generation counter.
29c2b5255de6d54cace83d114cc1ada61afd1047vboxsync * The generation counter is incremented every time the object is */
29c2b5255de6d54cace83d114cc1ada61afd1047vboxsync /** Reference counter. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /** The wait queue. */
9197680d465154232353e065bfc7e7b0fe026b97vboxsync} RTSEMEVENTMULTIINTERNAL, *PRTSEMEVENTMULTIINTERNAL;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiCreate(PRTSEMEVENTMULTI phEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return RTSemEventMultiCreateEx(phEventMultiSem, 0 /*fFlags*/, NIL_RTLOCKVALCLASS, NULL);
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiCreateEx(PRTSEMEVENTMULTI phEventMultiSem, uint32_t fFlags, RTLOCKVALCLASS hClass,
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync const char *pszNameFmt, ...)
ab93606043a9881487aa83be04191d2f4ea24071vboxsync AssertReturn(!(fFlags & ~RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL), VERR_INVALID_PARAMETER);
ab93606043a9881487aa83be04191d2f4ea24071vboxsync pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync pThis->fStateAndGen = RTSEMEVENTMULTILNX_STATE_GEN_INIT;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Retain a reference to the semaphore.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param pThis The semaphore.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncDECLINLINE(void) rtR0SemEventMultiLnxRetain(PRTSEMEVENTMULTIINTERNAL pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Release a reference, destroy the thing if necessary.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param pThis The semaphore.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncDECLINLINE(void) rtR0SemEventMultiLnxRelease(PRTSEMEVENTMULTIINTERNAL pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (RT_UNLIKELY(ASMAtomicDecU32(&pThis->cRefs) == 0))
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI hEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
9197680d465154232353e065bfc7e7b0fe026b97vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync * Invalidate it and signal the object just in case.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicWriteU32(&pThis->u32Magic, ~RTSEMEVENTMULTI_MAGIC);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicAndU32(&pThis->fStateAndGen, RTSEMEVENTMULTILNX_GEN_MASK);
b79e4344bf4eb8033fd06d560cd864192728bd0bvboxsyncRTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI hEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
fe4be2b043180249b7f7d5b22aced0bfe75764c4vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Signal the event object. The cause of the parnoia here is racing to try
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * deal with racing RTSemEventMultiSignal calls (should probably be
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * forbidden, but it's relatively easy to handle).
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync fNew = fOld = ASMAtomicUoReadU32(&pThis->fStateAndGen);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync while (!ASMAtomicCmpXchgU32(&pThis->fStateAndGen, fNew, fOld));
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI hEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
fe4be2b043180249b7f7d5b22aced0bfe75764c4vboxsync * Reset it.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicAndU32(&pThis->fStateAndGen, ~RTSEMEVENTMULTILNX_STATE_MASK);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Worker for RTSemEventMultiWaitEx and RTSemEventMultiWaitExDebug.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @returns VBox status code.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param pThis The event semaphore.
98ead928220b4ddc6626c581287987ae2416ba35vboxsyncstatic int rtR0SemEventMultiLnxWait(PRTSEMEVENTMULTIINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
ab93606043a9881487aa83be04191d2f4ea24071vboxsync * Validate the input.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Is the event already signalled or do we have to wait?
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync fOrgStateAndGen = ASMAtomicUoReadU32(&pThis->fStateAndGen);
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync if (fOrgStateAndGen & RTSEMEVENTMULTILNX_STATE_MASK)
return rc;
RTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
#ifndef RTSEMEVENT_STRICT