semeventmulti-r0drv-darwin.cpp revision e0e7da0420be1398d23ffa9953686d3a43619abd
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * IPRT - Multiple Release Event Semaphores, Ring-0 Driver, Darwin.
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2006-2010 Oracle Corporation
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * available from http://www.virtualbox.org. This file is free software;
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * General Public License (GPL) as published by the Free Software
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * The contents of this file may alternatively be used under the terms
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * of the Common Development and Distribution License Version 1.0
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * CDDL are applicable instead of those of the GPL.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * You may elect to license modified versions of this file under the
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * terms and conditions of either the GPL or the CDDL or both.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/*******************************************************************************
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync* Header Files *
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync*******************************************************************************/
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/*******************************************************************************
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync* Defined Constants And Macros *
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync*******************************************************************************/
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/** @name fStateAndGen values
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/** The state bit number. */
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/** The state mask. */
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync#define RTSEMEVENTMULTIDARWIN_STATE_MASK RT_BIT_32(RTSEMEVENTMULTIDARWIN_STATE_BIT)
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync/** The generation mask. */
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync#define RTSEMEVENTMULTIDARWIN_GEN_MASK ~RTSEMEVENTMULTIDARWIN_STATE_MASK
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync/** The generation shift. */
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync/** The initial variable value. */
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync#define RTSEMEVENTMULTIDARWIN_STATE_GEN_INIT UINT32_C(0xfffffffc)
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync/*******************************************************************************
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync* Structures and Typedefs *
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync*******************************************************************************/
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync * Darwin multiple release event semaphore.
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync /** Magic value (RTSEMEVENTMULTI_MAGIC). */
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync /** The object state bit and generation counter.
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync * The generation counter is incremented every time the object is
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync * signalled. */
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync /** Reference counter. */
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync /** Set if there are blocked threads. */
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync /** The spinlock protecting us. */
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync} RTSEMEVENTMULTIINTERNAL, *PRTSEMEVENTMULTIINTERNAL;
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsyncRTDECL(int) RTSemEventMultiCreate(PRTSEMEVENTMULTI phEventMultiSem)
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync return RTSemEventMultiCreateEx(phEventMultiSem, 0 /*fFlags*/, NIL_RTLOCKVALCLASS, NULL);
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsyncRTDECL(int) RTSemEventMultiCreateEx(PRTSEMEVENTMULTI phEventMultiSem, uint32_t fFlags, RTLOCKVALCLASS hClass,
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync const char *pszNameFmt, ...)
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync AssertReturn(!(fFlags & ~RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL), VERR_INVALID_PARAMETER);
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync AssertCompile(sizeof(RTSEMEVENTMULTIINTERNAL) > sizeof(void *));
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync AssertPtrReturn(phEventMultiSem, VERR_INVALID_POINTER);
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync pThis->fStateAndGen = RTSEMEVENTMULTIDARWIN_STATE_GEN_INIT;
4a9af9a8062589b741444d717d2dd1ed22b0f583vboxsync pThis->pSpinlock = lck_spin_alloc_init(g_pDarwinLockGroup, LCK_ATTR_NULL);
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync * Retain a reference to the semaphore.
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync * @param pThis The semaphore.
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsyncDECLINLINE(void) rtR0SemEventMultiDarwinRetain(PRTSEMEVENTMULTIINTERNAL pThis)
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync * Release a reference, destroy the thing if necessary.
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync * @param pThis The semaphore.
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsyncDECLINLINE(void) rtR0SemEventMultiDarwinRelease(PRTSEMEVENTMULTIINTERNAL pThis)
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync if (RT_UNLIKELY(ASMAtomicDecU32(&pThis->cRefs) == 0))
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync lck_spin_destroy(pThis->pSpinlock, g_pDarwinLockGroup);
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsyncRTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI hEventMultiSem)
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
1c0d3d017f9a45748b4839bf6622b53e83a4f1f8vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync ASMAtomicWriteU32(&pThis->u32Magic, ~RTSEMEVENTMULTI_MAGIC); /* make the handle invalid */
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync ASMAtomicAndU32(&pThis->fStateAndGen, RTSEMEVENTMULTIDARWIN_GEN_MASK);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync /* abort waiting threads. */
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync thread_wakeup_prim((event_t)pThis, FALSE /* all threads */, THREAD_RESTART);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsyncRTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI hEventMultiSem)
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * Set the signal and increment the generation counter.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync uint32_t fNew = ASMAtomicUoReadU32(&pThis->fStateAndGen);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * Wake up all sleeping threads.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync ASMAtomicWriteBool(&pThis->fHaveBlockedThreads, false);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync thread_wakeup_prim((event_t)pThis, FALSE /* all threads */, THREAD_AWAKENED);
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsyncRTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI hEventMultiSem)
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
7b4ea63789001468ec3662bdfcd6432bf89095dfvboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
46737b2c6b2da473108a7670c3682d88474bd8b9vboxsync ASMAtomicAndU32(&pThis->fStateAndGen, ~RTSEMEVENTMULTIDARWIN_STATE_MASK);
73ba84f95f918cc170be38908ad240fbb2f8f354vboxsync * Worker for RTSemEventMultiWaitEx and RTSemEventMultiWaitExDebug.
73ba84f95f918cc170be38908ad240fbb2f8f354vboxsync * @returns VBox status code.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * @param pThis The event semaphore.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * @param fFlags See RTSemEventMultiWaitEx.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * @param uTimeout See RTSemEventMultiWaitEx.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * @param pSrcPos The source code position of the wait.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsyncstatic int rtR0SemEventMultiDarwinWait(PRTSEMEVENTMULTIINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync * Validate input.
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync if (uTimeout != 0 || (fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync * Is the event already signalled or do we have to wait?
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync uint32_t const fOrgStateAndGen = ASMAtomicUoReadU32(&pThis->fStateAndGen);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync if (fOrgStateAndGen & RTSEMEVENTMULTIDARWIN_STATE_MASK)
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync * We have to wait. So, we'll need to convert the timeout and figure
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync * out if it's indefinite or not.
bdbed0b8e7fb553d01417fdc976a76f3b287dbe2vboxsync uTimeout = uTimeout < UINT64_MAX / UINT32_C(1000000) * UINT32_C(1000000)
359416647a711739d1b14addbf399178949a1a60vboxsync uTimeout = u64Now < uTimeout ? uTimeout - u64Now : 0;
1389294d44ac76b0a25f5655756c9d39855a73efvboxsync * Poll call, we already checked the condition above so no need to
73ba84f95f918cc170be38908ad240fbb2f8f354vboxsync * wait for anything.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * Do the actual waiting.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync ASMAtomicWriteBool(&pThis->fHaveBlockedThreads, true);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync wait_interrupt_t fInterruptible = fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE ? THREAD_ABORTSAFE : THREAD_UNINT;
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync rcWait = lck_spin_sleep(pThis->pSpinlock, LCK_SLEEP_DEFAULT, (event_t)pThis, fInterruptible);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync nanoseconds_to_absolutetime(uNsAbsTimeout, &u64AbsTime);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync rcWait = lck_spin_sleep_deadline(pThis->pSpinlock, LCK_SLEEP_DEFAULT,
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync * Deal with the wait result.
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync if (RT_LIKELY(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC))
359416647a711739d1b14addbf399178949a1a60vboxsync if (RT_LIKELY(ASMAtomicUoReadU32(&pThis->fStateAndGen) != fOrgStateAndGen))
359416647a711739d1b14addbf399178949a1a60vboxsync continue; /* Seen this happen after fork/exec/something. */
359416647a711739d1b14addbf399178949a1a60vboxsync AssertMsg(pThis->u32Magic == ~RTSEMEVENTMULTI_MAGIC, ("%#x\n", pThis->u32Magic));
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsyncRTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync return rtR0SemEventMultiDarwinWait(hEventMultiSem, fFlags, uTimeout, NULL);
9055f61bb57d2a625c6434d55beac7565c3b3c0dvboxsync RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
359416647a711739d1b14addbf399178949a1a60vboxsync return rtR0SemEventMultiDarwinWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
359416647a711739d1b14addbf399178949a1a60vboxsyncRTDECL(int) RTSemEventMultiWaitExDebug(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
359416647a711739d1b14addbf399178949a1a60vboxsync RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();