semevent-r0drv-nt.cpp revision 67c26773eca4a576449ffa8f289fa344fc7b8176
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync/* $Id$ */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync/** @file
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * innotek Portable Runtime - Single Release Event Semaphores, Ring-0 Driver, NT.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync/*
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * Copyright (C) 2006-2007 innotek GmbH
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync *
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * available from http://www.virtualbox.org. This file is free software;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * General Public License as published by the Free Software Foundation,
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync/*******************************************************************************
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync* Header Files *
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync*******************************************************************************/
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include "the-nt-kernel.h"
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include <iprt/semaphore.h>
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include <iprt/alloc.h>
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include <iprt/assert.h>
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include <iprt/asm.h>
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include <iprt/err.h>
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync#include "internal/magics.h"
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync/*******************************************************************************
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync* Structures and Typedefs *
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync*******************************************************************************/
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync/**
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * NT event semaphore.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsynctypedef struct RTSEMEVENTINTERNAL
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /** Magic value (RTSEMEVENT_MAGIC). */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync uint32_t volatile u32Magic;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /** The NT Event object. */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync KEVENT Event;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync} RTSEMEVENTINTERNAL, *PRTSEMEVENTINTERNAL;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsyncRTDECL(int) RTSemEventCreate(PRTSEMEVENT pEventSem)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync Assert(sizeof(RTSEMEVENTINTERNAL) > sizeof(void *));
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync PRTSEMEVENTINTERNAL pEventInt = (PRTSEMEVENTINTERNAL)RTMemAlloc(sizeof(*pEventInt));
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (pEventInt)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync {
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync pEventInt->u32Magic = RTSEMEVENT_MAGIC;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync KeInitializeEvent(&pEventInt->Event, SynchronizationEvent, FALSE);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync *pEventSem = pEventInt;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VINF_SUCCESS;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync }
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_NO_MEMORY;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync}
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsyncRTDECL(int) RTSemEventDestroy(RTSEMEVENT EventSem)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /*
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * Validate input.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync PRTSEMEVENTINTERNAL pEventInt = (PRTSEMEVENTINTERNAL)EventSem;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (!pEventInt)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_INVALID_PARAMETER;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (pEventInt->u32Magic != RTSEMEVENT_MAGIC)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync {
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync AssertMsgFailed(("pEventInt->u32Magic=%RX32 pEventInt=%p\n", pEventInt->u32Magic, pEventInt));
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_INVALID_PARAMETER;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync }
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /*
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * Invalidate it and signal the object just in case.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync ASMAtomicIncU32(&pEventInt->u32Magic);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync KeSetEvent(&pEventInt->Event, 0xfff, FALSE);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync RTMemFree(pEventInt);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VINF_SUCCESS;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync}
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsyncRTDECL(int) RTSemEventSignal(RTSEMEVENT EventSem)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /*
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * Validate input.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync PRTSEMEVENTINTERNAL pEventInt = (PRTSEMEVENTINTERNAL)EventSem;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (!pEventInt)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_INVALID_PARAMETER;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if ( !pEventInt
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync || pEventInt->u32Magic != RTSEMEVENT_MAGIC)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync {
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync AssertMsgFailed(("pEventInt->u32Magic=%RX32 pEventInt=%p\n", pEventInt ? pEventInt->u32Magic : 0, pEventInt));
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_INVALID_PARAMETER;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync }
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /*
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * Signal the event object.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync KeSetEvent(&pEventInt->Event, 1, FALSE);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VINF_SUCCESS;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync}
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsyncstatic int rtSemEventWait(RTSEMEVENT EventSem, unsigned cMillies, bool fInterruptible)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync /*
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync * Validate input.
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync */
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync PRTSEMEVENTINTERNAL pEventInt = (PRTSEMEVENTINTERNAL)EventSem;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (!pEventInt)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_INVALID_PARAMETER;
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync if ( !pEventInt
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync || pEventInt->u32Magic != RTSEMEVENT_MAGIC)
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync {
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync AssertMsgFailed(("pEventInt->u32Magic=%RX32 pEventInt=%p\n", pEventInt ? pEventInt->u32Magic : 0, pEventInt));
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync return VERR_INVALID_PARAMETER;
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync }
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync /*
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync * Wait for it.
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync */
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync NTSTATUS rcNt;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (cMillies == RT_INDEFINITE_WAIT)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync rcNt = KeWaitForSingleObject(&pEventInt->Event, Executive, KernelMode, fInterruptible, NULL);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync else
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync {
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync LARGE_INTEGER Timeout;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync Timeout.QuadPart = -(int64_t)cMillies * 10000;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync rcNt = KeWaitForSingleObject(&pEventInt->Event, Executive, KernelMode, fInterruptible, &Timeout);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync }
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync switch (rcNt)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync {
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync case STATUS_SUCCESS:
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync if (pEventInt->u32Magic == RTSEMEVENT_MAGIC)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VINF_SUCCESS;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_SEM_DESTROYED;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync case STATUS_ALERTED:
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return VERR_INTERRUPTED;
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync case STATUS_USER_APC:
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync return VERR_INTERRUPTED;
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync case STATUS_TIMEOUT:
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync return VERR_TIMEOUT;
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync default:
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync AssertMsgFailed(("pEventInt->u32Magic=%RX32 pEventInt=%p: wait returned %lx!\n",
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync pEventInt->u32Magic, pEventInt, (long)rcNt));
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync return VERR_INTERNAL_ERROR;
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync }
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync}
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsyncRTDECL(int) RTSemEventWait(RTSEMEVENT EventSem, unsigned cMillies)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync return rtSemEventWait(EventSem, cMillies, false /* fInterruptible */);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync}
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsyncRTDECL(int) RTSemEventWaitNoResume(RTSEMEVENT EventSem, unsigned cMillies)
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync{
b011d23442f2b9e7208db889ff4b5ffe2c8effc8vboxsync return rtSemEventWait(EventSem, cMillies, true /* fInterruptible */);
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync}
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync
e1fd337d575f2a4c053c6fe7a811e2fd1a31e874vboxsync