semevent-r0drv-netbsd.c@ 96407

Last change on this file since 96407 was 96407, checked in by vboxsync, 2 years ago
scm copyright and license note update
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 9.7 KB

Line
1	/* $Id: semevent-r0drv-netbsd.c 96407 2022-08-22 17:43:14Z vboxsync $ */
2	/** @file
3	* IPRT - Single Release Event Semaphores, Ring-0 Driver, NetBSD.
4	*/
5
6	/*
7	* Contributed by knut st. osmundsen.
8	*
9	* Copyright (C) 2007-2022 Oracle and/or its affiliates.
10	*
11	* This file is part of VirtualBox base platform packages, as
12	* available from https://www.virtualbox.org.
13	*
14	* This program is free software; you can redistribute it and/or
15	* modify it under the terms of the GNU General Public License
16	* as published by the Free Software Foundation, in version 3 of the
17	* License.
18	*
19	* This program is distributed in the hope that it will be useful, but
20	* WITHOUT ANY WARRANTY; without even the implied warranty of
21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22	* General Public License for more details.
23	*
24	* You should have received a copy of the GNU General Public License
25	* along with this program; if not, see <https://www.gnu.org/licenses>.
26	*
27	* The contents of this file may alternatively be used under the terms
28	* of the Common Development and Distribution License Version 1.0
29	* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
30	* in the VirtualBox distribution, in which case the provisions of the
31	* CDDL are applicable instead of those of the GPL.
32	*
33	* You may elect to license modified versions of this file under the
34	* terms and conditions of either the GPL or the CDDL or both.
35	*
36	* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
37	* --------------------------------------------------------------------
38	*
39	* Copyright (c) 2007 knut st. osmundsen <bird-src-spam@anduin.net>
40	*
41	* Permission is hereby granted, free of charge, to any person
42	* obtaining a copy of this software and associated documentation
43	* files (the "Software"), to deal in the Software without
44	* restriction, including without limitation the rights to use,
45	* copy, modify, merge, publish, distribute, sublicense, and/or sell
46	* copies of the Software, and to permit persons to whom the
47	* Software is furnished to do so, subject to the following
48	* conditions:
49	*
50	* The above copyright notice and this permission notice shall be
51	* included in all copies or substantial portions of the Software.
52	*
53	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
54	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
55	* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
56	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
57	* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
58	* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
59	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
60	* OTHER DEALINGS IN THE SOFTWARE.
61	*/
62
63
64	/*********************************************************************************************************************************
65	* Header Files *
66	*********************************************************************************************************************************/
67	#define RTSEMEVENT_WITHOUT_REMAPPING
68	#include "the-netbsd-kernel.h"
69	#include "internal/iprt.h"
70	#include <iprt/semaphore.h>
71
72	#include <iprt/asm.h>
73	#include <iprt/assert.h>
74	#include <iprt/err.h>
75	#include <iprt/lockvalidator.h>
76	#include <iprt/mem.h>
77
78	#include "sleepqueue-r0drv-netbsd.h"
79	#include "internal/magics.h"
80
81
82	/*********************************************************************************************************************************
83	* Structures and Typedefs *
84	*********************************************************************************************************************************/
85	/**
86	* NetBSD event semaphore.
87	*/
88	typedef struct RTSEMEVENTINTERNAL
89	{
90	/** Magic value (RTSEMEVENT_MAGIC). */
91	uint32_t volatile u32Magic;
92	/** The object status - !0 when signaled and 0 when reset. */
93	uint32_t volatile fState;
94	/** Reference counter. */
95	uint32_t volatile cRefs;
96	} RTSEMEVENTINTERNAL, *PRTSEMEVENTINTERNAL;
97
98
99	RTDECL(int) RTSemEventCreate(PRTSEMEVENT phEventSem)
100	{
101	return RTSemEventCreateEx(phEventSem, 0 /fFlags/, NIL_RTLOCKVALCLASS, NULL);
102	}
103
104
105	RTDECL(int) RTSemEventCreateEx(PRTSEMEVENT phEventSem, uint32_t fFlags, RTLOCKVALCLASS hClass, const char *pszNameFmt, ...)
106	{
107	AssertCompile(sizeof(RTSEMEVENTINTERNAL) > sizeof(void *));
108	AssertReturn(!(fFlags & ~(RTSEMEVENT_FLAGS_NO_LOCK_VAL \| RTSEMEVENT_FLAGS_BOOTSTRAP_HACK)), VERR_INVALID_PARAMETER);
109	Assert(!(fFlags & RTSEMEVENT_FLAGS_BOOTSTRAP_HACK) \|\| (fFlags & RTSEMEVENT_FLAGS_NO_LOCK_VAL));
110	AssertPtrReturn(phEventSem, VERR_INVALID_POINTER);
111
112	PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)RTMemAllocZ(sizeof(*pThis));
113	if (!pThis)
114	return VERR_NO_MEMORY;
115
116	pThis->u32Magic = RTSEMEVENT_MAGIC;
117	pThis->cRefs = 1;
118	pThis->fState = 0;
119
120	*phEventSem = pThis;
121	return VINF_SUCCESS;
122	}
123
124
125	/**
126	* Retains a reference to the event semaphore.
127	*
128	* @param pThis The event semaphore.
129	*/
130	DECLINLINE(void) rtR0SemEventBsdRetain(PRTSEMEVENTINTERNAL pThis)
131	{
132	uint32_t cRefs = ASMAtomicIncU32(&pThis->cRefs);
133	Assert(cRefs < 100000); NOREF(cRefs);
134	}
135
136
137	/**
138	* Releases a reference to the event semaphore.
139	*
140	* @param pThis The event semaphore.
141	*/
142	DECLINLINE(void) rtR0SemEventBsdRelease(PRTSEMEVENTINTERNAL pThis)
143	{
144	if (RT_UNLIKELY(ASMAtomicDecU32(&pThis->cRefs) == 0))
145	RTMemFree(pThis);
146	}
147
148
149	RTDECL(int) RTSemEventDestroy(RTSEMEVENT hEventSem)
150	{
151	/*
152	* Validate input.
153	*/
154	PRTSEMEVENTINTERNAL pThis = hEventSem;
155	if (pThis == NIL_RTSEMEVENT)
156	return VINF_SUCCESS;
157	AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis), VERR_INVALID_HANDLE);
158	Assert(pThis->cRefs > 0);
159
160	/*
161	* Invalidate it and signal the object just in case.
162	*/
163	ASMAtomicWriteU32(&pThis->u32Magic, ~RTSEMEVENT_MAGIC);
164	ASMAtomicWriteU32(&pThis->fState, 0);
165	rtR0SemBsdBroadcast(pThis);
166	rtR0SemEventBsdRelease(pThis);
167	return VINF_SUCCESS;
168	}
169
170
171	RTDECL(int) RTSemEventSignal(RTSEMEVENT hEventSem)
172	{
173	/*
174	* Validate input.
175	*/
176	PRTSEMEVENTINTERNAL pThis = (PRTSEMEVENTINTERNAL)hEventSem;
177	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
178	AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis), VERR_INVALID_HANDLE);
179	rtR0SemEventBsdRetain(pThis);
180
181	/*
182	* Signal the event object.
183	*/
184	ASMAtomicWriteU32(&pThis->fState, 1);
185	rtR0SemBsdSignal(pThis);
186	rtR0SemEventBsdRelease(pThis);
187	return VINF_SUCCESS;
188	}
189
190	/**
191	* Worker for RTSemEventWaitEx and RTSemEventWaitExDebug.
192	*
193	* @returns VBox status code.
194	* @param pThis The event semaphore.
195	* @param fFlags See RTSemEventWaitEx.
196	* @param uTimeout See RTSemEventWaitEx.
197	* @param pSrcPos The source code position of the wait.
198	*/
199	static int rtR0SemEventWait(PRTSEMEVENTINTERNAL pThis, uint32_t fFlags, uint64_t uTimeout,
200	PCRTLOCKVALSRCPOS pSrcPos)
201	{
202	int rc;
203
204	/*
205	* Validate the input.
206	*/
207	AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
208	AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
209	AssertReturn(RTSEMWAIT_FLAGS_ARE_VALID(fFlags), VERR_INVALID_PARAMETER);
210	rtR0SemEventBsdRetain(pThis);
211
212	/*
213	* Try grab the event without setting up the wait.
214	*/
215	if (ASMAtomicCmpXchgU32(&pThis->fState, 0, 1))
216	rc = VINF_SUCCESS;
217	else
218	{
219	/*
220	* We have to wait.
221	*/
222	RTR0SEMBSDSLEEP Wait;
223	rc = rtR0SemBsdWaitInit(&Wait, fFlags, uTimeout, pThis);
224	if (RT_SUCCESS(rc))
225	{
226	for (;;)
227	{
228	/* The destruction test. */
229	if (RT_UNLIKELY(pThis->u32Magic != RTSEMEVENT_MAGIC))
230	rc = VERR_SEM_DESTROYED;
231	else
232	{
233	rtR0SemBsdWaitPrepare(&Wait);
234
235	/* Check the exit conditions. */
236	if (RT_UNLIKELY(pThis->u32Magic != RTSEMEVENT_MAGIC))
237	rc = VERR_SEM_DESTROYED;
238	else if (ASMAtomicCmpXchgU32(&pThis->fState, 0, 1))
239	rc = VINF_SUCCESS;
240	else if (rtR0SemBsdWaitHasTimedOut(&Wait))
241	rc = VERR_TIMEOUT;
242	else if (rtR0SemBsdWaitWasInterrupted(&Wait))
243	rc = VERR_INTERRUPTED;
244	else
245	{
246	/* Do the wait and then recheck the conditions. */
247	rtR0SemBsdWaitDoIt(&Wait);
248	continue;
249	}
250	}
251	break;
252	}
253
254	rtR0SemBsdWaitDelete(&Wait);
255	}
256	}
257
258	rtR0SemEventBsdRelease(pThis);
259	return rc;
260	}
261
262
263	RTDECL(int) RTSemEventWaitEx(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout)
264	{
265	#ifndef RTSEMEVENT_STRICT
266	return rtR0SemEventWait(hEventSem, fFlags, uTimeout, NULL);
267	#else
268	RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_NORMAL_API();
269	return rtR0SemEventWait(hEventSem, fFlags, uTimeout, &SrcPos);
270	#endif
271	}
272	RT_EXPORT_SYMBOL(RTSemEventWaitEx);
273
274
275	RTDECL(int) RTSemEventWaitExDebug(RTSEMEVENT hEventSem, uint32_t fFlags, uint64_t uTimeout,
276	RTHCUINTPTR uId, RT_SRC_POS_DECL)
277	{
278	RTLOCKVALSRCPOS SrcPos = RTLOCKVALSRCPOS_INIT_DEBUG_API();
279	return rtR0SemEventWait(hEventSem, fFlags, uTimeout, &SrcPos);
280	}
281	RT_EXPORT_SYMBOL(RTSemEventWaitExDebug);
282
283
284	RTDECL(uint32_t) RTSemEventGetResolution(void)
285	{
286	return 1000000000 / hz;
287	}
288
289	RTR0DECL(bool) RTSemEventIsSignalSafe(void)
290	{
291	/** @todo check the code... */
292	return false;
293	}
294

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

source: vbox/trunk/src/VBox/Runtime/r0drv/netbsd/semevent-r0drv-netbsd.c@ 96407

Download in other formats: