5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * IPRT - Multiple Release Event Semaphore, Windows.
d05e58c15346e272284b3db3adae55a8fb8977davboxsync * @remarks This file is identical to semevent-win.cpp except for the 2nd
d05e58c15346e272284b3db3adae55a8fb8977davboxsync * CreateEvent parameter, the reset function and the "Multi" infix.
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync * Copyright (C) 2006-2010 Oracle Corporation
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * available from http://www.virtualbox.org. This file is free software;
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * you can redistribute it and/or modify it under the terms of the GNU
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * General Public License (GPL) as published by the Free Software
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * The contents of this file may alternatively be used under the terms
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * of the Common Development and Distribution License Version 1.0
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * VirtualBox OSE distribution, in which case the provisions of the
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * CDDL are applicable instead of those of the GPL.
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * You may elect to license modified versions of this file under the
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * terms and conditions of either the GPL or the CDDL or both.
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync/*******************************************************************************
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync* Header Files *
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync*******************************************************************************/
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync/*******************************************************************************
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync* Defined Constants And Macros *
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync*******************************************************************************/
d05e58c15346e272284b3db3adae55a8fb8977davboxsync /** Magic value (RTSEMEVENTMULTI_MAGIC). */
d05e58c15346e272284b3db3adae55a8fb8977davboxsync /** The event handle. */
d05e58c15346e272284b3db3adae55a8fb8977davboxsync /** Signallers. */
d05e58c15346e272284b3db3adae55a8fb8977davboxsync /** Indicates that lock validation should be performed. */
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, ...)
ab93606043a9881487aa83be04191d2f4ea24071vboxsync AssertReturn(!(fFlags & ~RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL), VERR_INVALID_PARAMETER);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = (struct RTSEMEVENTMULTIINTERNAL *)RTMemAlloc(sizeof(*pThis));
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * Create the semaphore.
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * (Manual reset, not signaled, private event object.)
d05e58c15346e272284b3db3adae55a8fb8977davboxsync if (pThis->hev != NULL) /* not INVALID_HANDLE_VALUE */
2e42e0850e182e37277fe28ba5b5d1c37018e783vboxsync RTLockValidatorRecSharedInit(&pThis->Signallers, hClass, RTLOCKVAL_SUB_CLASS_ANY, pThis,
2e42e0850e182e37277fe28ba5b5d1c37018e783vboxsync true /*fSignaller*/, !(fFlags & RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL),
2e42e0850e182e37277fe28ba5b5d1c37018e783vboxsync "RTSemEventMulti-%u", ASMAtomicIncU32(&s_iSemEventMultiAnon) - 1);
2e42e0850e182e37277fe28ba5b5d1c37018e783vboxsync RTLockValidatorRecSharedInitV(&pThis->Signallers, hClass, RTLOCKVAL_SUB_CLASS_ANY, pThis,
2e42e0850e182e37277fe28ba5b5d1c37018e783vboxsync true /*fSignaller*/, !(fFlags & RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL),
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI hEventMultiSem)
ab93606043a9881487aa83be04191d2f4ea24071vboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, VERR_INVALID_HANDLE);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync * Invalidate the handle and close the semaphore.
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturn(ASMAtomicCmpXchgU32(&pThis->u32Magic, ~RTSEMEVENTMULTI_MAGIC, RTSEMEVENTMULTI_MAGIC), VERR_INVALID_HANDLE);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync RTLockValidatorRecSharedDelete(&pThis->Signallers);
ab93606043a9881487aa83be04191d2f4ea24071vboxsync AssertMsgFailed(("Destroy hEventMultiSem %p failed, lasterr=%u (%Rrc)\n", pThis, dwErr, rc));
d05e58c15346e272284b3db3adae55a8fb8977davboxsync /* Leak it. */
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI hEventMultiSem)
d05e58c15346e272284b3db3adae55a8fb8977davboxsync * Validate input.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, VERR_INVALID_HANDLE);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync int rc9 = RTLockValidatorRecSharedCheckSignaller(&pThis->Signallers, NIL_RTTHREAD);
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * Signal the object.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync AssertMsgFailed(("Signaling hEventMultiSem %p failed, lasterr=%d\n", pThis, dwErr));
ab93606043a9881487aa83be04191d2f4ea24071vboxsyncRTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI hEventMultiSem)
d05e58c15346e272284b3db3adae55a8fb8977davboxsync * Validate input.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, VERR_INVALID_HANDLE);
5964f60ed7fb52a3c4becbe83c9429f9b2f119c2vboxsync * Reset the object.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync AssertMsgFailed(("Resetting hEventMultiSem %p failed, lasterr=%d\n", pThis, dwErr));
3e39de9ed8b88fa8907468a77bef44d10049b12avboxsync/** Goto avoidance. */
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsyncrtSemEventWaitHandleStatus(struct RTSEMEVENTMULTIINTERNAL *pThis, uint32_t fFlags, DWORD rc)
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync case WAIT_IO_COMPLETION: return fFlags & RTSEMWAIT_FLAGS_RESUME ? VERR_TIMEOUT : VERR_INTERRUPTED;
ab93606043a9881487aa83be04191d2f4ea24071vboxsync AssertMsgFailed(("Wait on hEventMultiSem %p failed, rc=%d lasterr=%d\n", pThis, rc, GetLastError()));
3e39de9ed8b88fa8907468a77bef44d10049b12avboxsync AssertMsgFailed(("WaitForSingleObject(event) -> rc=%d while converted lasterr=%d\n", rc, rc2));
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsyncDECLINLINE(int) rtSemEventMultiWinWait(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
d05e58c15346e272284b3db3adae55a8fb8977davboxsync * Validate input.
ab93606043a9881487aa83be04191d2f4ea24071vboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, VERR_INVALID_HANDLE);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync * Convert the timeout to a millisecond count.
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync uTimeout = uTimeout < UINT64_MAX - UINT32_C(1000000) / 2
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync ? (uTimeout + UINT32_C(1000000) / 2) / UINT32_C(1000000)
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync * Do the wait.
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync rc = WaitForSingleObjectEx(pThis->hev, 0 /*Timeout*/, TRUE /*fAlertable*/);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync while (rc == WAIT_IO_COMPLETION && (fFlags & RTSEMWAIT_FLAGS_RESUME));
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync return rtSemEventWaitHandleStatus(pThis, fFlags, rc);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync int rc9 = RTLockValidatorRecSharedCheckBlocking(&pThis->Signallers, hThreadSelf, pSrcPos, false,
d05e58c15346e272284b3db3adae55a8fb8977davboxsync RTThreadBlocking(hThreadSelf, RTTHREADSTATE_EVENT_MULTI, true);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync rc = WaitForSingleObjectEx(pThis->hev, dwMsTimeout, TRUE /*fAlertable*/);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync if (rc == WAIT_IO_COMPLETION && (fFlags & RTSEMWAIT_FLAGS_RESUME))
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync rc = WaitForSingleObjectEx(pThis->hev, dwMsTimeout, TRUE /*fAlertable*/);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync RTThreadUnblocked(hThreadSelf, RTTHREADSTATE_EVENT_MULTI);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync return rtSemEventWaitHandleStatus(pThis, fFlags, rc);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsyncRTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync return rtSemEventMultiWinWait(hEventMultiSem, fFlags, uTimeout, NULL);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync return rtSemEventMultiWinWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsyncRTDECL(int) RTSemEventMultiWaitExDebug(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
93d83967c7ad57b530ecfa5cfbe82f6b986dd58avboxsync return rtSemEventMultiWinWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
333e7ab9cd83b32080826d06ac7b1951c684ccb5vboxsyncRTDECL(void) RTSemEventMultiSetSignaller(RTSEMEVENTMULTI hEventMultiSem, RTTHREAD hThread)
d05e58c15346e272284b3db3adae55a8fb8977davboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturnVoid(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync ASMAtomicWriteBool(&pThis->fEverHadSignallers, true);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync RTLockValidatorRecSharedResetOwner(&pThis->Signallers, hThread, NULL);
333e7ab9cd83b32080826d06ac7b1951c684ccb5vboxsyncRTDECL(void) RTSemEventMultiAddSignaller(RTSEMEVENTMULTI hEventMultiSem, RTTHREAD hThread)
d05e58c15346e272284b3db3adae55a8fb8977davboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturnVoid(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync ASMAtomicWriteBool(&pThis->fEverHadSignallers, true);
d05e58c15346e272284b3db3adae55a8fb8977davboxsync RTLockValidatorRecSharedAddOwner(&pThis->Signallers, hThread, NULL);
333e7ab9cd83b32080826d06ac7b1951c684ccb5vboxsyncRTDECL(void) RTSemEventMultiRemoveSignaller(RTSEMEVENTMULTI hEventMultiSem, RTTHREAD hThread)
d05e58c15346e272284b3db3adae55a8fb8977davboxsync struct RTSEMEVENTMULTIINTERNAL *pThis = hEventMultiSem;
d05e58c15346e272284b3db3adae55a8fb8977davboxsync AssertReturnVoid(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC);