semeventmulti-r0drv-darwin.cpp@ 48935

Last change on this file since 48935 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: 14.3 KB

Line
1	/* $Id: semeventmulti-r0drv-darwin.cpp 48935 2013-10-07 21:19:37Z vboxsync $ */
2	/** @file
3	* IPRT - Multiple Release Event Semaphores, Ring-0 Driver, Darwin.
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 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	AssertReturn(!(fFlags & ~RTSEMEVENTMULTI_FLAGS_NO_LOCK_VAL), VERR_INVALID_PARAMETER);
103	AssertCompile(sizeof(RTSEMEVENTMULTIINTERNAL) > sizeof(void *));
104	AssertPtrReturn(phEventMultiSem, VERR_INVALID_POINTER);
105	RT_ASSERT_PREEMPTIBLE();
106
107	PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
108	if (pThis)
109	{
110	pThis->u32Magic = RTSEMEVENTMULTI_MAGIC;
111	pThis->fStateAndGen = RTSEMEVENTMULTIDARWIN_STATE_GEN_INIT;
112	pThis->cRefs = 1;
113	pThis->fHaveBlockedThreads = false;
114	Assert(g_pDarwinLockGroup);
115	pThis->pSpinlock = lck_spin_alloc_init(g_pDarwinLockGroup, LCK_ATTR_NULL);
116	if (pThis->pSpinlock)
117	{
118	*phEventMultiSem = pThis;
119	return VINF_SUCCESS;
120	}
121
122	pThis->u32Magic = 0;
123	RTMemFree(pThis);
124	}
125	return VERR_NO_MEMORY;
126	}
127
128
129	/**
130	* Retain a reference to the semaphore.
131	*
132	* @param pThis The semaphore.
133	*/
134	DECLINLINE(void) rtR0SemEventMultiDarwinRetain(PRTSEMEVENTMULTIINTERNAL pThis)
135	{
136	uint32_t cRefs = ASMAtomicIncU32(&pThis->cRefs);
137	Assert(cRefs && cRefs < 100000);
138	}
139
140
141	/**
142	* Release a reference, destroy the thing if necessary.
143	*
144	* @param pThis The semaphore.
145	*/
146	DECLINLINE(void) rtR0SemEventMultiDarwinRelease(PRTSEMEVENTMULTIINTERNAL pThis)
147	{
148	if (RT_UNLIKELY(ASMAtomicDecU32(&pThis->cRefs) == 0))
149	{
150	Assert(pThis->u32Magic != RTSEMEVENTMULTI_MAGIC);
151	lck_spin_destroy(pThis->pSpinlock, g_pDarwinLockGroup);
152	RTMemFree(pThis);
153	}
154	}
155
156
157	RTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI hEventMultiSem)
158	{
159	PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
160	if (pThis == NIL_RTSEMEVENTMULTI)
161	return VINF_SUCCESS;
162	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
163	AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
164	Assert(pThis->cRefs > 0);
165	RT_ASSERT_INTS_ON();
166
167	lck_spin_lock(pThis->pSpinlock);
168
169	ASMAtomicWriteU32(&pThis->u32Magic, ~RTSEMEVENTMULTI_MAGIC); /* make the handle invalid */
170	ASMAtomicAndU32(&pThis->fStateAndGen, RTSEMEVENTMULTIDARWIN_GEN_MASK);
171	if (pThis->fHaveBlockedThreads)
172	{
173	/* abort waiting threads. */
174	thread_wakeup_prim((event_t)pThis, FALSE /* all threads */, THREAD_RESTART);
175	}
176
177	lck_spin_unlock(pThis->pSpinlock);
178	rtR0SemEventMultiDarwinRelease(pThis);
179
180	return VINF_SUCCESS;
181	}
182
183
184	RTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI hEventMultiSem)
185	{
186	PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
187	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
188	AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
189	RT_ASSERT_PREEMPT_CPUID_VAR();
190	RT_ASSERT_INTS_ON();
191
192	rtR0SemEventMultiDarwinRetain(pThis);
193	lck_spin_lock(pThis->pSpinlock);
194
195	/*
196	* Set the signal and increment the generation counter.
197	*/
198	uint32_t fNew = ASMAtomicUoReadU32(&pThis->fStateAndGen);
199	fNew += 1 << RTSEMEVENTMULTIDARWIN_GEN_SHIFT;
200	fNew \|= RTSEMEVENTMULTIDARWIN_STATE_MASK;
201	ASMAtomicWriteU32(&pThis->fStateAndGen, fNew);
202
203	/*
204	* Wake up all sleeping threads.
205	*/
206	if (pThis->fHaveBlockedThreads)
207	{
208	ASMAtomicWriteBool(&pThis->fHaveBlockedThreads, false);
209	thread_wakeup_prim((event_t)pThis, FALSE /* all threads */, THREAD_AWAKENED);
210	}
211
212	lck_spin_unlock(pThis->pSpinlock);
213	rtR0SemEventMultiDarwinRelease(pThis);
214
215	RT_ASSERT_PREEMPT_CPUID();
216	return VINF_SUCCESS;
217	}
218
219
220	RTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI hEventMultiSem)
221	{
222	PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)hEventMultiSem;
223	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
224	AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
225	RT_ASSERT_PREEMPT_CPUID_VAR();
226	RT_ASSERT_INTS_ON();
227
228	rtR0SemEventMultiDarwinRetain(pThis);
229	lck_spin_lock(pThis->pSpinlock);
230
231	ASMAtomicAndU32(&pThis->fStateAndGen, ~RTSEMEVENTMULTIDARWIN_STATE_MASK);
232
233	lck_spin_unlock(pThis->pSpinlock);
234	rtR0SemEventMultiDarwinRelease(pThis);
235
236	RT_ASSERT_PREEMPT_CPUID();
237	return VINF_SUCCESS;
238	}
239
240
241	/**
242	* Worker for RTSemEventMultiWaitEx and RTSemEventMultiWaitExDebug.
243	*
244	* @returns VBox status code.
245	* @param pThis The event semaphore.
246	* @param fFlags See RTSemEventMultiWaitEx.
247	* @param uTimeout See RTSemEventMultiWaitEx.
248	* @param pSrcPos The source code position of the wait.
249	*/
250	static int rtR0SemEventMultiDarwinWait(PRTSEMEVENTMULTIINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
251	PCRTLOCKVALSRCPOS pSrcPos)
252	{
253	/*
254	* Validate input.
255	*/
256	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
257	AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("pThis=%p u32Magic=%#x\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
258	AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
259	if (uTimeout != 0 \|\| (fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
260	RT_ASSERT_PREEMPTIBLE();
261
262	rtR0SemEventMultiDarwinRetain(pThis);
263	lck_spin_lock(pThis->pSpinlock);
264
265	/*
266	* Is the event already signalled or do we have to wait?
267	*/
268	int rc;
269	uint32_t const fOrgStateAndGen = ASMAtomicUoReadU32(&pThis->fStateAndGen);
270	if (fOrgStateAndGen & RTSEMEVENTMULTIDARWIN_STATE_MASK)
271	rc = VINF_SUCCESS;
272	else
273	{
274	/*
275	* We have to wait. So, we'll need to convert the timeout and figure
276	* out if it's indefinite or not.
277	*/
278	uint64_t uNsAbsTimeout = 1;
279	if (!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE))
280	{
281	if (fFlags & RTSEMWAIT_FLAGS_MILLISECS)
282	uTimeout = uTimeout < UINT64_MAX / UINT32_C(1000000) * UINT32_C(1000000)
283	? uTimeout * UINT32_C(1000000)
284	: UINT64_MAX;
285	if (uTimeout == UINT64_MAX)
286	fFlags \|= RTSEMWAIT_FLAGS_INDEFINITE;
287	else
288	{
289	uint64_t u64Now;
290	if (fFlags & RTSEMWAIT_FLAGS_RELATIVE)
291	{
292	if (uTimeout != 0)
293	{
294	u64Now = RTTimeSystemNanoTS();
295	uNsAbsTimeout = u64Now + uTimeout;
296	if (uNsAbsTimeout < u64Now) /* overflow */
297	fFlags \|= RTSEMWAIT_FLAGS_INDEFINITE;
298	}
299	}
300	else
301	{
302	uNsAbsTimeout = uTimeout;
303	u64Now = RTTimeSystemNanoTS();
304	uTimeout = u64Now < uTimeout ? uTimeout - u64Now : 0;
305	}
306	}
307	}
308
309	if ( !(fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
310	&& uTimeout == 0)
311	{
312	/*
313	* Poll call, we already checked the condition above so no need to
314	* wait for anything.
315	*/
316	rc = VERR_TIMEOUT;
317	}
318	else
319	{
320	for (;;)
321	{
322	/*
323	* Do the actual waiting.
324	*/
325	ASMAtomicWriteBool(&pThis->fHaveBlockedThreads, true);
326	wait_interrupt_t fInterruptible = fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE ? THREAD_ABORTSAFE : THREAD_UNINT;
327	wait_result_t rcWait;
328	if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE)
329	rcWait = lck_spin_sleep(pThis->pSpinlock, LCK_SLEEP_DEFAULT, (event_t)pThis, fInterruptible);
330	else
331	{
332	uint64_t u64AbsTime;
333	nanoseconds_to_absolutetime(uNsAbsTimeout, &u64AbsTime);
334	rcWait = lck_spin_sleep_deadline(pThis->pSpinlock, LCK_SLEEP_DEFAULT,
335	(event_t)pThis, fInterruptible, u64AbsTime);
336	}
337
338	/*
339	* Deal with the wait result.
340	*/
341	if (RT_LIKELY(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC))
342	{
343	switch (rcWait)
344	{
345	case THREAD_AWAKENED:
346	if (RT_LIKELY(ASMAtomicUoReadU32(&pThis->fStateAndGen) != fOrgStateAndGen))
347	rc = VINF_SUCCESS;
348	else if (fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE)
349	rc = VERR_INTERRUPTED;
350	else
351	continue; /* Seen this happen after fork/exec/something. */
352	break;
353
354	case THREAD_TIMED_OUT:
355	Assert(!(fFlags & RTSEMWAIT_FLAGS_INDEFINITE));
356	rc = VERR_TIMEOUT;
357	break;
358
359	case THREAD_INTERRUPTED:
360	Assert(fInterruptible != THREAD_UNINT);
361	rc = VERR_INTERRUPTED;
362	break;
363
364	case THREAD_RESTART:
365	AssertMsg(pThis->u32Magic == ~RTSEMEVENTMULTI_MAGIC, ("%#x\n", pThis->u32Magic));
366	rc = VERR_SEM_DESTROYED;
367	break;
368
369	default:
370	AssertMsgFailed(("rcWait=%d\n", rcWait));
371	rc = VERR_INTERNAL_ERROR_3;
372	break;
373	}
374	}
375	else
376	rc = VERR_SEM_DESTROYED;
377	break;
378	}
379	}
380	}
381
382	lck_spin_unlock(pThis->pSpinlock);
383	rtR0SemEventMultiDarwinRelease(pThis);
384	return rc;
385	}
386
387	RTDECL(int) RTSemEventMultiWaitEx(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout)
388	{
389	#ifndef RTSEMEVENT_STRICT
390	return rtR0SemEventMultiDarwinWait(hEventMultiSem, fFlags, uTimeout, NULL);
391	#else
392	RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
393	return rtR0SemEventMultiDarwinWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
394	#endif
395	}
396
397
398	RTDECL(int) RTSemEventMultiWaitExDebug(RTSEMEVENTMULTI hEventMultiSem, uint32_t fFlags, uint64_t uTimeout,
399	RTHCUINTPTR uId, RT_SRC_POS_DECL)
400	{
401	RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
402	return rtR0SemEventMultiDarwinWait(hEventMultiSem, fFlags, uTimeout, &SrcPos);
403	}
404
405
406	RTDECL(uint32_t) RTSemEventMultiGetResolution(void)
407	{
408	uint64_t cNs;
409	absolutetime_to_nanoseconds(1, &cNs);
410	return (uint32_t)cNs ? (uint32_t)cNs : 0;
411	}
412

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

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

Download in other formats: