VirtualBox

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

Last change on this file since 92247 was 90488, checked in by vboxsync, 3 years ago

IPRT: Added RTSemEventIsSignalSafe and RTSemEventMultiIsSignalSafe - ring-0 only. bugref:6695
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 9.0 KB
Line 
1/* $Id: semevent-r0drv-nt.cpp 90488 2021-08-03 09:17:59Z vboxsync $ */
2/** @file
3 * IPRT - Single Release Event Semaphores, Ring-0 Driver, NT.
4 */
5
6/*
7 * Copyright (C) 2006-2020 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 RT_NOREF2(hClass, pszNameFmt);
75
76 PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)RTMemAlloc(sizeof(*pThis));
77 if (pThis)
78 {
79 pThis->u32Magic = RTSEMEVENT_MAGIC;
80 pThis->cRefs = 1;
81 KeInitializeEvent(&pThis->Event, SynchronizationEvent, FALSE /* not signalled */);
82
83 *phEventSem = pThis;
84 return VINF_SUCCESS;
85 }
86 return VERR_NO_MEMORY;
87}
88
89
90/**
91 * Retains a reference to the semaphore.
92 *
93 * @param pThis The semaphore to retain.
94 */
95DECLINLINE(void) rtR0SemEventNtRetain(PRTSEMEVENTINTERNAL pThis)
96{
97 uint32_t cRefs = ASMAtomicIncU32(&pThis->cRefs);
98 Assert(cRefs < 100000); NOREF(cRefs);
99}
100
101
102/**
103 * Releases a reference to the semaphore.
104 *
105 * @param pThis The semaphore to release
106 */
107DECLINLINE(void) rtR0SemEventNtRelease(PRTSEMEVENTINTERNAL pThis)
108{
109 if (ASMAtomicDecU32(&pThis->cRefs) == 0)
110 RTMemFree(pThis);
111}
112
113
114RTDECL(int) RTSemEventDestroy(RTSEMEVENT hEventSem)
115{
116 /*
117 * Validate input.
118 */
119 PRTSEMEVENTINTERNAL pThis = hEventSem;
120 if (pThis == NIL_RTSEMEVENT)
121 return VINF_SUCCESS;
122 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
123 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis), VERR_INVALID_HANDLE);
124
125 /*
126 * Invalidate it and signal the object just in case.
127 */
128 ASMAtomicIncU32(&pThis->u32Magic);
129 KeSetEvent(&pThis->Event, 0xfff, FALSE);
130 rtR0SemEventNtRelease(pThis);
131 return VINF_SUCCESS;
132}
133
134
135RTDECL(int) RTSemEventSignal(RTSEMEVENT hEventSem)
136{
137 /*
138 * Validate input.
139 */
140 PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)hEventSem;
141 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
142 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis), VERR_INVALID_HANDLE);
143 rtR0SemEventNtRetain(pThis);
144
145 /*
146 * Signal the event object.
147 */
148 KeSetEvent(&pThis->Event, 1, FALSE);
149
150 rtR0SemEventNtRelease(pThis);
151 return VINF_SUCCESS;
152}
153
154
155
156/**
157 * Worker for RTSemEventWaitEx and RTSemEventWaitExDebug.
158 *
159 * @returns VBox status code.
160 * @param pThis The event semaphore.
161 * @param fFlags See RTSemEventWaitEx.
162 * @param uTimeout See RTSemEventWaitEx.
163 * @param pSrcPos The source code position of the wait.
164 */
165DECLINLINE(int) rtR0SemEventNtWait(PRTSEMEVENTINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
166 PCRTLOCKVALSRCPOS pSrcPos)
167{
168 /*
169 * Validate input.
170 */
171 if (!pThis)
172 return VERR_INVALID_PARAMETER;
173 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
174 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
175 AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
176 NOREF(pSrcPos);
177
178 rtR0SemEventNtRetain(pThis);
179
180 /*
181 * Convert the timeout to a relative one because KeWaitForSingleObject
182 * takes system time instead of interrupt time as input for absolute
183 * timeout specifications. So, we're best off by giving it relative time.
184 *
185 * Lazy bird converts uTimeout to relative nanoseconds and then to Nt time.
186 */
187 if (!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
188 {
189 if (fFlags & RTSEMWAIT_FLAGS_MILLISECS)
190 uTimeout = uTimeout < UINT64_MAX / UINT32_C(1000000) * UINT32_C(1000000)
191 ? uTimeout * UINT32_C(1000000)
192 : UINT64_MAX;
193 if (uTimeout == UINT64_MAX)
194 fFlags |= RTSEMWAIT_FLAGS_INDEFINITE;
195 else
196 {
197 if (fFlags & RTSEMWAIT_FLAGS_ABSOLUTE)
198 {
199 uint64_t u64Now = RTTimeSystemNanoTS();
200 uTimeout = u64Now < uTimeout
201 ? uTimeout - u64Now
202 : 0;
203 }
204 }
205 }
206
207 /*
208 * Wait for it.
209 * We're assuming interruptible waits should happen at UserMode level.
210 */
211 NTSTATUS rcNt;
212 BOOLEAN fInterruptible = !!(fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE);
213 KPROCESSOR_MODE WaitMode = fInterruptible ? UserMode : KernelMode;
214 if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
215 rcNt = KeWaitForSingleObject(&pThis->Event, Executive, WaitMode, fInterruptible, NULL);
216 else
217 {
218 LARGE_INTEGER Timeout;
219 Timeout.QuadPart = -(int64_t)(uTimeout / 100);
220 rcNt = KeWaitForSingleObject(&pThis->Event, Executive, WaitMode, fInterruptible, &Timeout);
221 }
222 int rc;
223 if (pThis->u32Magic == RTSEMEVENT_MAGIC)
224 {
225 switch (rcNt)
226 {
227 case STATUS_SUCCESS:
228 rc = VINF_SUCCESS;
229 break;
230 case STATUS_ALERTED:
231 rc = VERR_INTERRUPTED;
232 break;
233 case STATUS_USER_APC:
234 rc = VERR_INTERRUPTED;
235 break;
236 case STATUS_TIMEOUT:
237 rc = VERR_TIMEOUT;
238 break;
239 default:
240 AssertMsgFailed(("pThis->u32Magic=%RX32 pThis=%p: wait returned %lx!\n",
241 pThis->u32Magic, pThis, (long)rcNt));
242 rc = VERR_INTERNAL_ERROR_4;
243 break;
244 }
245 }
246 else
247 rc = VERR_SEM_DESTROYED;
248
249 rtR0SemEventNtRelease(pThis);
250 return rc;
251}
252
253
254RTDECL(int) RTSemEventWaitEx(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout)
255{
256#ifndef RTSEMEVENT_STRICT
257 return rtR0SemEventNtWait(hEventSem, fFlags, uTimeout, NULL);
258#else
259 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
260 return rtR0SemEventNtWait(hEventSem, fFlags, uTimeout, &SrcPos);
261#endif
262}
263
264
265RTDECL(int) RTSemEventWaitExDebug(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout,
266 RTHCUINTPTR uId, RT_SRC_POS_DECL)
267{
268 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
269 return rtR0SemEventNtWait(hEventSem, fFlags, uTimeout, &SrcPos);
270}
271
272
273RTDECL(uint32_t) RTSemEventGetResolution(void)
274{
275 return RTTimerGetSystemGranularity();
276}
277
278
279RTR0DECL(bool) RTSemEventIsSignalSafe(void)
280{
281 return KeGetCurrentIrql() <= DISPATCH_LEVEL;
282}
283
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