VirtualBox

source: vbox/trunk/src/VBox/Runtime/r0drv/darwin/semevent-r0drv-darwin.cpp@ 94293

Last change on this file since 94293 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 14.7 KB
Line 
1/* $Id: semevent-r0drv-darwin.cpp 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * IPRT - Single Release Event Semaphores, Ring-0 Driver, Darwin.
4 */
5
6/*
7 * Copyright (C) 2006-2022 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-darwin-kernel.h"
33#include "internal/iprt.h"
34#include <iprt/semaphore.h>
35
36#include <iprt/assert.h>
37#include <iprt/asm.h>
38#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
39# include <iprt/asm-amd64-x86.h>
40#endif
41#include <iprt/err.h>
42#include <iprt/list.h>
43#include <iprt/lockvalidator.h>
44#include <iprt/mem.h>
45#include <iprt/mp.h>
46#include <iprt/thread.h>
47#include <iprt/time.h>
48
49#include "internal/magics.h"
50
51
52/*********************************************************************************************************************************
53* Structures and Typedefs *
54*********************************************************************************************************************************/
55/**
56 * Waiter entry. Lives on the stack.
57 */
58typedef struct RTSEMEVENTDARWINENTRY
59{
60 /** The list node. */
61 RTLISTNODE Node;
62 /** Flag set when waking up the thread by signal or destroy. */
63 bool volatile fWokenUp;
64} RTSEMEVENTDARWINENTRY;
65/** Pointer to waiter entry. */
66typedef RTSEMEVENTDARWINENTRY *PRTSEMEVENTDARWINENTRY;
67
68
69/**
70 * Darwin event semaphore.
71 */
72typedef struct RTSEMEVENTINTERNAL
73{
74 /** Magic value (RTSEMEVENT_MAGIC). */
75 uint32_t volatile u32Magic;
76 /** Reference counter. */
77 uint32_t volatile cRefs;
78 /** Set if there are blocked threads. */
79 bool volatile fHaveBlockedThreads;
80 /** Set if the event object is signaled. */
81 bool volatile fSignaled;
82 /** List of waiting and woken up threads. */
83 RTLISTANCHOR WaitList;
84 /** The spinlock protecting us. */
85 lck_spin_t *pSpinlock;
86} RTSEMEVENTINTERNAL, *PRTSEMEVENTINTERNAL;
87
88
89
90RTDECL(int) RTSemEventCreate(PRTSEMEVENT phEventSem)
91{
92 return RTSemEventCreateEx(phEventSem, 0 /*fFlags*/, NIL_RTLOCKVALCLASS, NULL);
93}
94
95
96RTDECL(int) RTSemEventCreateEx(PRTSEMEVENT phEventSem, uint32_t fFlags, RTLOCKVALCLASS hClass, const char *pszNameFmt, ...)
97{
98 RT_NOREF(hClass, pszNameFmt);
99 AssertCompile(sizeof(RTSEMEVENTINTERNAL) > sizeof(void *));
100 AssertReturn(!(fFlags & ~(RTSEMEVENT_FLAGS_NO_LOCK_VAL | RTSEMEVENT_FLAGS_BOOTSTRAP_HACK)), VERR_INVALID_PARAMETER);
101 Assert(!(fFlags & RTSEMEVENT_FLAGS_BOOTSTRAP_HACK) || (fFlags & RTSEMEVENT_FLAGS_NO_LOCK_VAL));
102 AssertPtrReturn(phEventSem, VERR_INVALID_POINTER);
103 RT_ASSERT_PREEMPTIBLE();
104 IPRT_DARWIN_SAVE_EFL_AC();
105
106 PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)RTMemAlloc(sizeof(*pThis));
107 if (pThis)
108 {
109 pThis->u32Magic = RTSEMEVENT_MAGIC;
110 pThis->cRefs = 1;
111 pThis->fHaveBlockedThreads = false;
112 pThis->fSignaled = false;
113 RTListInit(&pThis->WaitList);
114 Assert(g_pDarwinLockGroup);
115 pThis->pSpinlock = lck_spin_alloc_init(g_pDarwinLockGroup, LCK_ATTR_NULL);
116 if (pThis->pSpinlock)
117 {
118 *phEventSem = pThis;
119 IPRT_DARWIN_RESTORE_EFL_AC();
120 return VINF_SUCCESS;
121 }
122
123 pThis->u32Magic = 0;
124 RTMemFree(pThis);
125 }
126 IPRT_DARWIN_RESTORE_EFL_AC();
127 return VERR_NO_MEMORY;
128}
129
130
131/**
132 * Retain a reference to the semaphore.
133 *
134 * @param pThis The semaphore.
135 */
136DECLINLINE(void) rtR0SemEventDarwinRetain(PRTSEMEVENTINTERNAL pThis)
137{
138 uint32_t cRefs = ASMAtomicIncU32(&pThis->cRefs);
139 Assert(cRefs && cRefs < 100000); RT_NOREF_PV(cRefs);
140}
141
142
143/**
144 * Release a reference, destroy the thing if necessary.
145 *
146 * @param pThis The semaphore.
147 */
148DECLINLINE(void) rtR0SemEventDarwinRelease(PRTSEMEVENTINTERNAL pThis)
149{
150 if (RT_UNLIKELY(ASMAtomicDecU32(&pThis->cRefs) == 0))
151 {
152 Assert(pThis->u32Magic != RTSEMEVENT_MAGIC);
153 IPRT_DARWIN_SAVE_EFL_AC();
154
155 lck_spin_destroy(pThis->pSpinlock, g_pDarwinLockGroup);
156 RTMemFree(pThis);
157
158 IPRT_DARWIN_RESTORE_EFL_AC();
159 }
160}
161
162RTDECL(int) RTSemEventDestroy(RTSEMEVENT hEventSem)
163{
164 PRTSEMEVENTINTERNAL pThis = hEventSem;
165 if (pThis == NIL_RTSEMEVENT)
166 return VINF_SUCCESS;
167 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
168 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
169 RT_ASSERT_INTS_ON();
170 IPRT_DARWIN_SAVE_EFL_AC();
171
172 RTCCUINTREG const fIntSaved = ASMIntDisableFlags();
173 lck_spin_lock(pThis->pSpinlock);
174
175 ASMAtomicWriteU32(&pThis->u32Magic, ~RTSEMEVENT_MAGIC); /* make the handle invalid */
176 ASMAtomicWriteBool(&pThis->fSignaled, false);
177
178 /* abort waiting threads. */
179 PRTSEMEVENTDARWINENTRY pWaiter;
180 RTListForEach(&pThis->WaitList, pWaiter, RTSEMEVENTDARWINENTRY, Node)
181 {
182 pWaiter->fWokenUp = true;
183 thread_wakeup_prim((event_t)pWaiter, FALSE /* all threads */, THREAD_RESTART);
184 }
185
186 lck_spin_unlock(pThis->pSpinlock);
187 ASMSetFlags(fIntSaved);
188 rtR0SemEventDarwinRelease(pThis);
189
190 IPRT_DARWIN_RESTORE_EFL_AC();
191 return VINF_SUCCESS;
192}
193
194
195RTDECL(int) RTSemEventSignal(RTSEMEVENT hEventSem)
196{
197 PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)hEventSem;
198 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
199 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC,
200 ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic),
201 VERR_INVALID_HANDLE);
202 RT_ASSERT_PREEMPT_CPUID_VAR();
203
204 /*
205 * Coming here with interrupts disabled should be okay. The thread_wakeup_prim KPI is used
206 * by the interrupt handler IOFilterInterruptEventSource::disableInterruptOccurred() via
207 * signalWorkAvailable(). The only problem is if we have to destroy the event structure,
208 * as RTMemFree does not work with interrupts disabled (IOFree/kfree takes zone mutex).
209 */
210 //RT_ASSERT_INTS_ON(); - we may be called from interrupt context, which seems to be perfectly fine.
211 IPRT_DARWIN_SAVE_EFL_AC();
212
213 RTCCUINTREG const fIntSaved = ASMIntDisableFlags();
214 rtR0SemEventDarwinRetain(pThis);
215 lck_spin_lock(pThis->pSpinlock);
216
217 /*
218 * Wake up one thread.
219 */
220 ASMAtomicWriteBool(&pThis->fSignaled, true);
221
222 PRTSEMEVENTDARWINENTRY pWaiter;
223 RTListForEach(&pThis->WaitList, pWaiter, RTSEMEVENTDARWINENTRY, Node)
224 {
225 if (!pWaiter->fWokenUp)
226 {
227 pWaiter->fWokenUp = true;
228 thread_wakeup_prim((event_t)pWaiter, FALSE /* all threads */, THREAD_AWAKENED);
229 ASMAtomicWriteBool(&pThis->fSignaled, false);
230 break;
231 }
232 }
233
234 lck_spin_unlock(pThis->pSpinlock);
235 ASMSetFlags(fIntSaved);
236 rtR0SemEventDarwinRelease(pThis);
237
238 RT_ASSERT_PREEMPT_CPUID();
239 AssertMsg((fSavedEfl & X86_EFL_IF) == (ASMGetFlags() & X86_EFL_IF), ("fSavedEfl=%#x cur=%#x\n",(uint32_t)fSavedEfl, ASMGetFlags()));
240 IPRT_DARWIN_RESTORE_EFL_AC();
241 return VINF_SUCCESS;
242}
243
244
245/**
246 * Worker for RTSemEventWaitEx and RTSemEventWaitExDebug.
247 *
248 * @returns VBox status code.
249 * @param pThis The event semaphore.
250 * @param fFlags See RTSemEventWaitEx.
251 * @param uTimeout See RTSemEventWaitEx.
252 * @param pSrcPos The source code position of the wait.
253 */
254static int rtR0SemEventDarwinWait(PRTSEMEVENTINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
255 PCRTLOCKVALSRCPOS pSrcPos)
256{
257 RT_NOREF(pSrcPos);
258
259 /*
260 * Validate the input.
261 */
262 AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
263 AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
264 AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
265 IPRT_DARWIN_SAVE_EFL_AC();
266
267 RTCCUINTREG const fIntSaved = ASMIntDisableFlags();
268 rtR0SemEventDarwinRetain(pThis);
269 lck_spin_lock(pThis->pSpinlock);
270
271 /*
272 * In the signaled state?
273 */
274 int rc;
275 if (ASMAtomicCmpXchgBool(&pThis->fSignaled, false, true))
276 rc = VINF_SUCCESS;
277 else
278 {
279 /*
280 * We have to wait. So, we'll need to convert the timeout and figure
281 * out if it's indefinite or not.
282 */
283 uint64_t uNsAbsTimeout = 1;
284 if (!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
285 {
286 if (fFlags & RTSEMWAIT_FLAGS_MILLISECS)
287 uTimeout = uTimeout < UINT64_MAX / UINT32_C(1000000) * UINT32_C(1000000)
288 ? uTimeout * UINT32_C(1000000)
289 : UINT64_MAX;
290 if (uTimeout == UINT64_MAX)
291 fFlags |= RTSEMWAIT_FLAGS_INDEFINITE;
292 else
293 {
294 uint64_t u64Now;
295 if (fFlags & RTSEMWAIT_FLAGS_RELATIVE)
296 {
297 if (uTimeout != 0)
298 {
299 u64Now = RTTimeSystemNanoTS();
300 uNsAbsTimeout = u64Now + uTimeout;
301 if (uNsAbsTimeout < u64Now) /* overflow */
302 fFlags |= RTSEMWAIT_FLAGS_INDEFINITE;
303 }
304 }
305 else
306 {
307 uNsAbsTimeout = uTimeout;
308 u64Now = RTTimeSystemNanoTS();
309 uTimeout = u64Now < uTimeout ? uTimeout - u64Now : 0;
310 }
311 }
312 }
313
314 if ( !(fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
315 && uTimeout == 0)
316 {
317 /*
318 * Poll call, we already checked the condition above so no need to
319 * wait for anything.
320 */
321 rc = VERR_TIMEOUT;
322 }
323 else
324 {
325 RTSEMEVENTDARWINENTRY Waiter;
326 Waiter.fWokenUp = false;
327 RTListAppend(&pThis->WaitList, &Waiter.Node);
328
329 for (;;)
330 {
331 /*
332 * Do the actual waiting.
333 */
334 ASMAtomicWriteBool(&pThis->fHaveBlockedThreads, true);
335 wait_interrupt_t fInterruptible = fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE ? THREAD_ABORTSAFE : THREAD_UNINT;
336 wait_result_t rcWait;
337 if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
338 rcWait = lck_spin_sleep(pThis->pSpinlock, LCK_SLEEP_DEFAULT, (event_t)&Waiter, fInterruptible);
339 else
340 {
341 uint64_t u64AbsTime;
342 nanoseconds_to_absolutetime(uNsAbsTimeout, &u64AbsTime);
343 rcWait = lck_spin_sleep_deadline(pThis->pSpinlock, LCK_SLEEP_DEFAULT,
344 (event_t)&Waiter, fInterruptible, u64AbsTime);
345 }
346
347 /*
348 * Deal with the wait result.
349 */
350 if (RT_LIKELY(pThis->u32Magic == RTSEMEVENT_MAGIC))
351 {
352 switch (rcWait)
353 {
354 case THREAD_AWAKENED:
355 if (RT_LIKELY(Waiter.fWokenUp))
356 rc = VINF_SUCCESS;
357 else if (fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE)
358 rc = VERR_INTERRUPTED;
359 else
360 continue; /* Seen this happen after fork/exec/something. */
361 break;
362
363 case THREAD_TIMED_OUT:
364 Assert(!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE));
365 rc = !Waiter.fWokenUp ? VERR_TIMEOUT : VINF_SUCCESS;
366 break;
367
368 case THREAD_INTERRUPTED:
369 Assert(fInterruptible != THREAD_UNINT);
370 rc = !Waiter.fWokenUp ? VERR_INTERRUPTED : VINF_SUCCESS;
371 break;
372
373 case THREAD_RESTART:
374 AssertMsg(pThis->u32Magic == ~RTSEMEVENT_MAGIC, ("%#x\n", pThis->u32Magic));
375 rc = VERR_SEM_DESTROYED;
376 break;
377
378 default:
379 AssertMsgFailed(("rcWait=%d\n", rcWait));
380 rc = VERR_INTERNAL_ERROR_3;
381 break;
382 }
383 }
384 else
385 rc = VERR_SEM_DESTROYED;
386 break;
387 }
388
389 RTListNodeRemove(&Waiter.Node);
390 }
391 }
392
393 lck_spin_unlock(pThis->pSpinlock);
394 ASMSetFlags(fIntSaved);
395 rtR0SemEventDarwinRelease(pThis);
396
397 IPRT_DARWIN_RESTORE_EFL_AC();
398 return rc;
399}
400
401
402RTDECL(int) RTSemEventWaitEx(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout)
403{
404#ifndef RTSEMEVENT_STRICT
405 return rtR0SemEventDarwinWait(hEventSem, fFlags, uTimeout, NULL);
406#else
407 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
408 return rtR0SemEventDarwinWait(hEventSem, fFlags, uTimeout, &SrcPos);
409#endif
410}
411
412
413RTDECL(int) RTSemEventWaitExDebug(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout,
414 RTHCUINTPTR uId, RT_SRC_POS_DECL)
415{
416 RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
417 return rtR0SemEventDarwinWait(hEventSem, fFlags, uTimeout, &SrcPos);
418}
419
420
421RTDECL(uint32_t) RTSemEventGetResolution(void)
422{
423 uint64_t cNs;
424 absolutetime_to_nanoseconds(1, &cNs);
425 return (uint32_t)cNs ? (uint32_t)cNs : 0;
426}
427
428
429RTR0DECL(bool) RTSemEventIsSignalSafe(void)
430{
431 /** @todo check the code... */
432 return false;
433}
434RT_EXPORT_SYMBOL(RTSemEventIsSignalSafe);
435
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