VirtualBox

source: vbox/trunk/src/VBox/Runtime/r0drv/nt/semeventmulti-r0drv-nt.cpp@ 61572

Last change on this file since 61572 was 57358, checked in by vboxsync, 9 years ago

*: scm cleanup run.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 9.8 KB
Line 
1/* $Id: semeventmulti-r0drv-nt.cpp 57358 2015-08-14 15:16:38Z vboxsync $ */
2/** @file
3 * IPRT - Multiple Release Event Semaphores, Ring-0 Driver, NT.
4 */
5
6/*
7 * Copyright (C) 2006-2015 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 RTSEMEVENTMULTI_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 RTSEMEVENTMULTIINTERNAL
53{
54 /** Magic value (RTSEMEVENTMULTI_MAGIC). */
55 uint32_t volatile u32Magic;
56 /** Reference counter. */
57 uint32_t volatile cRefs;
58 /** The NT Event object. */
59 KEVENT Event;
60} RTSEMEVENTMULTIINTERNAL, *PRTSEMEVENTMULTIINTERNAL;
61
62
63RTDECL(int) RTSemEventMultiCreate(PRTSEMEVENTMULTI phEventMultiSem)
64{
65 return RTSemEventMultiCreateEx(phEventMultiSem, 0 /*fFlags*/, NIL_RTLOCKVALCLASS, NULL);
66}
67
68
69RTDECL(int) RTSemEventMultiCreateEx(PRTSEMEVENTMULTI phEventMultiSem, uint32_t fFlags, RTLOCKVALCLASS hClass,
70 const char *pszNameFmt, ...)
71{
72 AssertReturn(!(fFlags & ~RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL), VERR_INVALID_PARAMETER);
73
74 AssertCompile(sizeof(RTSEMEVENTMULTIINTERNAL) > sizeof(void *));
75 PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
76 if (pThis)
77 {
78 pThis->u32Magic = RTSEMEVENTMULTI_MAGIC;
79 pThis->cRefs = 1;
80 KeInitializeEvent(&pThis->Event, NotificationEvent, FALSE /* not signalled */);
81
82 *phEventMultiSem = 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) rtR0SemEventMultiNtRetain(PRTSEMEVENTMULTIINTERNAL 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) rtR0SemEventMultiNtRelease(PRTSEMEVENTMULTIINTERNAL pThis)
107{
108 if (ASMAtomicDecU32(&pThis->cRefs) == 0)
109 RTMemFree(pThis);
110}
111
112
113RTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI hEventMultiSem)
114{
115 /*
116 * Validate input.
117 */
118 PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
119 if (pThis == NIL_RTSEMEVENTMULTI)
120 return VINF_SUCCESS;
121 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
122 AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
123
124 /*
125 * Invalidate it and signal the object just in case.
126 */
127 ASMAtomicIncU32(&pThis->u32Magic);
128 KeSetEvent(&pThis->Event, 0xfff, FALSE);
129 rtR0SemEventMultiNtRelease(pThis);
130 return VINF_SUCCESS;
131}
132
133
134RTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI hEventMultiSem)
135{
136 /*
137 * Validate input.
138 */
139 PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
140 if (!pThis)
141 return VERR_INVALID_PARAMETER;
142 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
143 AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
144 rtR0SemEventMultiNtRetain(pThis);
145
146 /*
147 * Signal the event object.
148 */
149 KeSetEvent(&pThis->Event, 1, FALSE);
150
151 rtR0SemEventMultiNtRelease(pThis);
152 return VINF_SUCCESS;
153}
154
155
156RTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI hEventMultiSem)
157{
158 /*
159 * Validate input.
160 */
161 PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
162 if (!pThis)
163 return VERR_INVALID_PARAMETER;
164 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
165 AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
166 rtR0SemEventMultiNtRetain(pThis);
167
168 /*
169 * Reset the event object.
170 */
171 KeResetEvent(&pThis->Event);
172
173 rtR0SemEventMultiNtRelease(pThis);
174 return VINF_SUCCESS;
175}
176
177
178/**
179 * Worker for RTSemEventMultiWaitEx and RTSemEventMultiWaitExDebug.
180 *
181 * @returns VBox status code.
182 * @param pThis The event semaphore.
183 * @param fFlags See RTSemEventMultiWaitEx.
184 * @param uTimeout See RTSemEventMultiWaitEx.
185 * @param pSrcPos The source code position of the wait.
186 */
187DECLINLINE(int) rtR0SemEventMultiNtWait(PRTSEMEVENTMULTIINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
188 PCRTLOCKVALSRCPOS pSrcPos)
189{
190 /*
191 * Validate input.
192 */
193 if (!pThis)
194 return VERR_INVALID_PARAMETER;
195 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
196 AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
197 AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
198
199 rtR0SemEventMultiNtRetain(pThis);
200
201 /*
202 * Convert the timeout to a relative one because KeWaitForSingleObject
203 * takes system time instead of interrupt time as input for absolute
204 * timeout specifications. So, we're best of by giving it relative time.
205 *
206 * Lazy bird converts uTimeout to relative nanoseconds and then to Nt time.
207 */
208 if (!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
209 {
210 if (fFlags & RTSEMWAIT_FLAGS_MILLISECS)
211 uTimeout = uTimeout < UINT64_MAX / UINT32_C(1000000) * UINT32_C(1000000)
212 ? uTimeout * UINT32_C(1000000)
213 : UINT64_MAX;
214 if (uTimeout == UINT64_MAX)
215 fFlags |= RTSEMWAIT_FLAGS_INDEFINITE;
216 else
217 {
218 if (fFlags & RTSEMWAIT_FLAGS_ABSOLUTE)
219 {
220 uint64_t u64Now = RTTimeSystemNanoTS();
221 uTimeout = u64Now < uTimeout
222 ? uTimeout - u64Now
223 : 0;
224 }
225 }
226 }
227
228 /*
229 * Wait for it.
230 * We're assuming interruptible waits should happen at UserMode level.
231 */
232 NTSTATUS rcNt;
233 BOOLEAN fInterruptible = !!(fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE);
234 KPROCESSOR_MODE WaitMode = fInterruptible ? UserMode : KernelMode;
235 if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
236 rcNt = KeWaitForSingleObject(&pThis->Event, Executive, WaitMode, fInterruptible, NULL);
237 else
238 {
239 LARGE_INTEGER Timeout;
240 Timeout.QuadPart = -(int64_t)(uTimeout / 100);
241 rcNt = KeWaitForSingleObject(&pThis->Event, Executive, WaitMode, fInterruptible, &Timeout);
242 }
243 int rc;
244 if (pThis->u32Magic == RTSEMEVENTMULTI_MAGIC)
245 {
246 switch (rcNt)
247 {
248 case STATUS_SUCCESS:
249 rc = VINF_SUCCESS;
250 break;
251 case STATUS_ALERTED:
252 rc = VERR_INTERRUPTED;
253 break;
254 case STATUS_USER_APC:
255 rc = VERR_INTERRUPTED;
256 break;
257 case STATUS_TIMEOUT:
258 rc = VERR_TIMEOUT;
259 break;
260 default:
261 AssertMsgFailed(("pThis->u32Magic=%RX32 pThis=%p: wait returned %lx!\n",
262 pThis->u32Magic, pThis, (long)rcNt));
263 rc = VERR_INTERNAL_ERROR_4;
264 break;
265 }
266 }
267 else
268 rc = VERR_SEM_DESTROYED;
269
270 rtR0SemEventMultiNtRelease(pThis);
271 return rc;
272}
273
274
275RTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
276{
277#ifndef RTSEMEVENT_STRICT
278 return rtR0SemEventMultiNtWait(hEventMultiSem, fFlags, uTimeout, NULL);
279#else
280 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
281 return rtR0SemEventMultiNtWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
282#endif
283}
284
285
286RTDECL(int) RTSemEventMultiWaitExDebug(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
287 RTHCUINTPTR uId, RT_SRC_POS_DECL)
288{
289 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
290 return rtR0SemEventMultiNtWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
291}
292
293
294RTDECL(uint32_t) RTSemEventMultiGetResolution(void)
295{
296 return RTTimerGetSystemGranularity();
297}
298
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