VirtualBox

source: vbox/trunk/src/VBox/Runtime/r0drv/nt/semevent-r0drv-nt.cpp@ 53517

Last change on this file since 53517 was 48935, checked in by vboxsync, 11 years ago

Runtime: Whitespace and svn:keyword cleanups by scm.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 8.6 KB
Line 
1/* $Id: semevent-r0drv-nt.cpp 48935 2013-10-07 21:19:37Z vboxsync $ */
2/** @file
3 * IPRT - Single Release Event Semaphores, Ring-0 Driver, NT.
4 */
5
6/*
7 * Copyright (C) 2006-2011 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*******************************************************************************
29* Header Files *
30*******************************************************************************/
31#define RTSEMEVENT_WITHOUT_REMAPPING
32#include "the-nt-kernel.h"
33#include <iprt/semaphore.h>
34
35#include <iprt/asm.h>
36#include <iprt/assert.h>
37#include <iprt/err.h>
38#include <iprt/lockvalidator.h>
39#include <iprt/mem.h>
40#include <iprt/time.h>
41#include <iprt/timer.h>
42
43#include "internal/magics.h"
44
45
46/*******************************************************************************
47* Structures and Typedefs *
48*******************************************************************************/
49/**
50 * NT event semaphore.
51 */
52typedef struct RTSEMEVENTINTERNAL
53{
54 /** Magic value (RTSEMEVENT_MAGIC). */
55 uint32_t volatile u32Magic;
56 /** Reference counter. */
57 uint32_t volatile cRefs;
58 /** The NT Event object. */
59 KEVENT Event;
60} RTSEMEVENTINTERNAL, *PRTSEMEVENTINTERNAL;
61
62
63RTDECL(int) RTSemEventCreate(PRTSEMEVENT phEventSem)
64{
65 return RTSemEventCreateEx(phEventSem, 0 /*fFlags*/, NIL_RTLOCKVALCLASS, NULL);
66}
67
68
69RTDECL(int) RTSemEventCreateEx(PRTSEMEVENT phEventSem, uint32_t fFlags, RTLOCKVALCLASS hClass, const char *pszNameFmt, ...)
70{
71 AssertReturn(!(fFlags & ~(RTSEMEVENT_FLAGS_NO_LOCK_VAL | RTSEMEVENT_FLAGS_BOOTSTRAP_HACK)), VERR_INVALID_PARAMETER);
72 Assert(!(fFlags & RTSEMEVENT_FLAGS_BOOTSTRAP_HACK) || (fFlags & RTSEMEVENT_FLAGS_NO_LOCK_VAL));
73 AssertCompile(sizeof(RTSEMEVENTINTERNAL) > sizeof(void *));
74
75 PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)RTMemAlloc(sizeof(*pThis));
76 if (pThis)
77 {
78 pThis->u32Magic = RTSEMEVENT_MAGIC;
79 pThis->cRefs = 1;
80 KeInitializeEvent(&pThis->Event, SynchronizationEvent, FALSE /* not signalled */);
81
82 *phEventSem = pThis;
83 return VINF_SUCCESS;
84 }
85 return VERR_NO_MEMORY;
86}
87
88
89/**
90 * Retains a reference to the semaphore.
91 *
92 * @param pThis The semaphore to retain.
93 */
94DECLINLINE(void) rtR0SemEventNtRetain(PRTSEMEVENTINTERNAL pThis)
95{
96 uint32_t cRefs = ASMAtomicIncU32(&pThis->cRefs);
97 Assert(cRefs < 100000); NOREF(cRefs);
98}
99
100
101/**
102 * Releases a reference to the semaphore.
103 *
104 * @param pThis The semaphore to release
105 */
106DECLINLINE(void) rtR0SemEventNtRelease(PRTSEMEVENTINTERNAL pThis)
107{
108 if (ASMAtomicDecU32(&pThis->cRefs) == 0)
109 RTMemFree(pThis);
110}
111
112
113RTDECL(int) RTSemEventDestroy(RTSEMEVENT hEventSem)
114{
115 /*
116 * Validate input.
117 */
118 PRTSEMEVENTINTERNAL pThis = hEventSem;
119 if (pThis == NIL_RTSEMEVENT)
120 return VINF_SUCCESS;
121 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
122 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis), VERR_INVALID_HANDLE);
123
124 /*
125 * Invalidate it and signal the object just in case.
126 */
127 ASMAtomicIncU32(&pThis->u32Magic);
128 KeSetEvent(&pThis->Event, 0xfff, FALSE);
129 rtR0SemEventNtRelease(pThis);
130 return VINF_SUCCESS;
131}
132
133
134RTDECL(int) RTSemEventSignal(RTSEMEVENT hEventSem)
135{
136 /*
137 * Validate input.
138 */
139 PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)hEventSem;
140 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
141 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis), VERR_INVALID_HANDLE);
142 rtR0SemEventNtRetain(pThis);
143
144 /*
145 * Signal the event object.
146 */
147 KeSetEvent(&pThis->Event, 1, FALSE);
148
149 rtR0SemEventNtRelease(pThis);
150 return VINF_SUCCESS;
151}
152
153
154
155/**
156 * Worker for RTSemEventWaitEx and RTSemEventWaitExDebug.
157 *
158 * @returns VBox status code.
159 * @param pThis The event semaphore.
160 * @param fFlags See RTSemEventWaitEx.
161 * @param uTimeout See RTSemEventWaitEx.
162 * @param pSrcPos The source code position of the wait.
163 */
164DECLINLINE(int) rtR0SemEventNtWait(PRTSEMEVENTINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
165 PCRTLOCKVALSRCPOS pSrcPos)
166{
167 /*
168 * Validate input.
169 */
170 if (!pThis)
171 return VERR_INVALID_PARAMETER;
172 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
173 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
174 AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
175
176 rtR0SemEventNtRetain(pThis);
177
178 /*
179 * Convert the timeout to a relative one because KeWaitForSingleObject
180 * takes system time instead of interrupt time as input for absolute
181 * timeout specifications. So, we're best of by giving it relative time.
182 *
183 * Lazy bird converts uTimeout to relative nanoseconds and then to Nt time.
184 */
185 if (!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
186 {
187 if (fFlags & RTSEMWAIT_FLAGS_MILLISECS)
188 uTimeout = uTimeout < UINT64_MAX / UINT32_C(1000000) * UINT32_C(1000000)
189 ? uTimeout * UINT32_C(1000000)
190 : UINT64_MAX;
191 if (uTimeout == UINT64_MAX)
192 fFlags |= RTSEMWAIT_FLAGS_INDEFINITE;
193 else
194 {
195 if (fFlags & RTSEMWAIT_FLAGS_ABSOLUTE)
196 {
197 uint64_t u64Now = RTTimeSystemNanoTS();
198 uTimeout = u64Now < uTimeout
199 ? uTimeout - u64Now
200 : 0;
201 }
202 }
203 }
204
205 /*
206 * Wait for it.
207 * We're assuming interruptible waits should happen at UserMode level.
208 */
209 NTSTATUS rcNt;
210 BOOLEAN fInterruptible = !!(fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE);
211 KPROCESSOR_MODE WaitMode = fInterruptible ? UserMode : KernelMode;
212 if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
213 rcNt = KeWaitForSingleObject(&pThis->Event, Executive, WaitMode, fInterruptible, NULL);
214 else
215 {
216 LARGE_INTEGER Timeout;
217 Timeout.QuadPart = -(int64_t)(uTimeout / 100);
218 rcNt = KeWaitForSingleObject(&pThis->Event, Executive, WaitMode, fInterruptible, &Timeout);
219 }
220 int rc;
221 if (pThis->u32Magic == RTSEMEVENT_MAGIC)
222 {
223 switch (rcNt)
224 {
225 case STATUS_SUCCESS:
226 rc = VINF_SUCCESS;
227 break;
228 case STATUS_ALERTED:
229 rc = VERR_INTERRUPTED;
230 break;
231 case STATUS_USER_APC:
232 rc = VERR_INTERRUPTED;
233 break;
234 case STATUS_TIMEOUT:
235 rc = VERR_TIMEOUT;
236 break;
237 default:
238 AssertMsgFailed(("pThis->u32Magic=%RX32 pThis=%p: wait returned %lx!\n",
239 pThis->u32Magic, pThis, (long)rcNt));
240 rc = VERR_INTERNAL_ERROR_4;
241 break;
242 }
243 }
244 else
245 rc = VERR_SEM_DESTROYED;
246
247 rtR0SemEventNtRelease(pThis);
248 return rc;
249}
250
251
252RTDECL(int) RTSemEventWaitEx(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout)
253{
254#ifndef RTSEMEVENT_STRICT
255 return rtR0SemEventNtWait(hEventSem, fFlags, uTimeout, NULL);
256#else
257 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
258 return rtR0SemEventNtWait(hEventSem, fFlags, uTimeout, &SrcPos);
259#endif
260}
261
262
263RTDECL(int) RTSemEventWaitExDebug(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout,
264 RTHCUINTPTR uId, RT_SRC_POS_DECL)
265{
266 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
267 return rtR0SemEventNtWait(hEventSem, fFlags, uTimeout, &SrcPos);
268}
269
270
271RTDECL(uint32_t) RTSemEventGetResolution(void)
272{
273 return RTTimerGetSystemGranularity();
274}
275
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette