semeventmulti-r0drv-darwin.cpp@ 75704

Last change on this file since 75704 was 75704, checked in by vboxsync, 6 years ago
IPRT/r0drv/darwin: RTSemEventSignal and RTSemEventMultiSignal seems to work fine with interrupts disabled and/or from interrupt context. bugref:4686
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 15.9 KB

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

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Runtime/r0drv/darwin/semeventmulti-r0drv-darwin.cpp@ 75704

Download in other formats: