1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
/* $Id: sleepqueue-r0drv-netbsd.h $ */
/** @file
* IPRT - NetBSD Ring-0 Driver Helpers for Abstracting Sleep Queues,
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef IPRT_INCLUDED_SRC_r0drv_netbsd_sleepqueue_r0drv_netbsd_h
#define IPRT_INCLUDED_SRC_r0drv_netbsd_sleepqueue_r0drv_netbsd_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include "the-netbsd-kernel.h"
#include <iprt/asm-math.h>
#include <iprt/err.h>
#include <iprt/time.h>
static syncobj_t vbox_syncobj = {
SOBJ_SLEEPQ_SORTED,
sleepq_unsleep,
sleepq_changepri,
sleepq_lendpri,
syncobj_noowner,
};
/**
* Kernel mode NetBSD wait state structure.
*/
typedef struct RTR0SEMBSDSLEEP
{
/** The absolute timeout given as nano seconds since the start of the
* monotonic clock. */
uint64_t uNsAbsTimeout;
/** The timeout in ticks. Updated after waiting. */
int iTimeout;
/** Set if it's an indefinite wait. */
bool fIndefinite;
/** Set if we've already timed out.
* Set by rtR0SemBsdWaitDoIt and read by rtR0SemBsdWaitHasTimedOut. */
bool fTimedOut;
/** Flag whether the wait was interrupted. */
bool fInterrupted;
/** flag whether the wait is interruptible or not. */
bool fInterruptible;
/** Opaque wait channel id. */
wchan_t wchan;
sleepq_t *sq;
kmutex_t *sq_lock;
} RTR0SEMBSDSLEEP;
/** Pointer to a NetBSD wait state. */
typedef RTR0SEMBSDSLEEP *PRTR0SEMBSDSLEEP;
/**
* Updates the timeout of the NetBSD wait.
*
* @returns RTSEMWAIT_FLAGS_INDEFINITE if the timeout value is too big.
* 0 otherwise
* @param pWait The wait structure.
* @param uTimeout The relative timeout in nanoseconds.
*/
DECLINLINE(void) rtR0SemBsdWaitUpdateTimeout(PRTR0SEMBSDSLEEP pWait)
{
/* Convert absolute timeout to ticks */
uint64_t now = RTTimeNanoTS();
if (now >= pWait->uNsAbsTimeout) {
pWait->iTimeout = 0;
} else {
uint64_t nanos = pWait->uNsAbsTimeout - now;
pWait->iTimeout = hz * nanos / 1000000000;
/* for 1ms wait, wait at least one tick ?? */
if ((pWait->iTimeout == 0) && (nanos >= 1000000)) {
pWait->iTimeout = 1;
}
}
}
/**
* Initializes a wait.
*
* The caller MUST check the wait condition BEFORE calling this function or the
* timeout logic will be flawed.
*
* @returns VINF_SUCCESS or VERR_TIMEOUT.
* @param pWait The wait structure.
* @param fFlags The wait flags.
* @param uTimeout The timeout.
* @param pvWaitChan The opaque wait channel.
*/
DECLINLINE(int) rtR0SemBsdWaitInit(PRTR0SEMBSDSLEEP pWait, uint32_t fFlags, uint64_t uTimeout,
void *pvWaitChan)
{
if (fFlags & RTSEMWAIT_FLAGS_INDEFINITE) {
pWait->fIndefinite = true;
pWait->iTimeout = 0;
pWait->uNsAbsTimeout = 0;
} else {
if (fFlags & RTSEMWAIT_FLAGS_RELATIVE) {
if (fFlags & RTSEMWAIT_FLAGS_MILLISECS) {
pWait->uNsAbsTimeout = uTimeout * 1000000 + RTTimeSystemNanoTS();
} else {
pWait->uNsAbsTimeout = uTimeout + RTTimeSystemNanoTS();
}
} else {
if (fFlags & RTSEMWAIT_FLAGS_MILLISECS) {
pWait->uNsAbsTimeout = uTimeout * 1000000;
} else {
pWait->uNsAbsTimeout = uTimeout;
}
}
rtR0SemBsdWaitUpdateTimeout(pWait);
if (pWait->iTimeout == 0) {
return VERR_TIMEOUT;
}
}
pWait->fTimedOut = false;
/*
* Initialize the wait queue related bits.
*/
pWait->fInterruptible = fFlags & RTSEMWAIT_FLAGS_INTERRUPTIBLE
? true : false;
pWait->fInterrupted = false;
pWait->wchan = pvWaitChan;
pWait->sq = NULL;
pWait->sq_lock = NULL;
return VINF_SUCCESS;
}
/**
* Prepares the next wait.
*
* This must be called before rtR0SemBsdWaitDoIt, and the caller should check
* the exit conditions inbetween the two calls.
*
* @param pWait The wait structure.
*/
DECLINLINE(void) rtR0SemBsdWaitPrepare(PRTR0SEMBSDSLEEP pWait)
{
pWait->sq = sleeptab_lookup(&sleeptab, pWait->wchan, &pWait->sq_lock);
}
/**
* Do the actual wait.
*
* @param pWait The wait structure.
*/
DECLINLINE(void) rtR0SemBsdWaitDoIt(PRTR0SEMBSDSLEEP pWait)
{
#if __NetBSD_Prereq__(9,99,57)
#define sleepq_enqueue(sq, wchan, wmesg, sobj) \
sleepq_enqueue((sq), (wchan), (wmesg), (sobj), true)
#endif
sleepq_enter(pWait->sq, curlwp, pWait->sq_lock);
sleepq_enqueue(pWait->sq, pWait->wchan, "VBoxIS", &vbox_syncobj);
pWait->sq = NULL;
pWait->sq_lock = NULL;
int error = sleepq_block(pWait->iTimeout, pWait->fInterruptible
#if __NetBSD_Prereq__(9,99,98) /* a bit later, actually... */
, &vbox_syncobj
#endif
);
if (error == EWOULDBLOCK) {
if (!pWait->fIndefinite) {
pWait->fTimedOut = true;
}
} else if (error == ERESTART) {
if (pWait->fInterruptible) {
pWait->fInterrupted = true;
} else if (!pWait->fIndefinite) {
rtR0SemBsdWaitUpdateTimeout(pWait);
if (pWait->iTimeout == 0) {
pWait->fTimedOut = true;
}
}
} else if (error == EINTR) {
if (pWait->fInterruptible) {
pWait->fInterrupted = true;
} else if (!pWait->fIndefinite) {
rtR0SemBsdWaitUpdateTimeout(pWait);
if (pWait->iTimeout == 0) {
pWait->fTimedOut = true;
}
}
} else if (error) {
AssertMsgFailed(("sleepq_block -> %d\n", error));
}
}
/**
* Checks if a NetBSD wait was interrupted.
*
* @returns true / false
* @param pWait The wait structure.
* @remarks This shall be called before the first rtR0SemLnxWaitDoIt().
*/
DECLINLINE(bool) rtR0SemBsdWaitWasInterrupted(PRTR0SEMBSDSLEEP pWait)
{
return pWait->fInterrupted;
}
/**
* Checks if a NetBSD wait has timed out.
*
* @returns true / false
* @param pWait The wait structure.
*/
DECLINLINE(bool) rtR0SemBsdWaitHasTimedOut(PRTR0SEMBSDSLEEP pWait)
{
return pWait->fTimedOut;
}
/**
* Deletes a NetBSD wait.
*
* @param pWait The wait structure.
*/
DECLINLINE(void) rtR0SemBsdWaitDelete(PRTR0SEMBSDSLEEP pWait)
{
if (pWait->sq_lock != NULL) {
mutex_spin_exit(pWait->sq_lock);
pWait->sq = NULL;
pWait->sq_lock = NULL;
}
}
/**
* Signals the wait channel.
*
* @param pvWaitChan The opaque wait channel handle.
*/
DECLINLINE(void) rtR0SemBsdSignal(void *pvWaitChan)
{
kmutex_t *mp;
sleepq_t *sq = sleeptab_lookup(&sleeptab, pvWaitChan, &mp);
sleepq_wake(sq, pvWaitChan, 1, mp);
}
/**
* Wakes up all waiters on the wait channel.
*
* @param pvWaitChan The opaque wait channel handle.
*/
DECLINLINE(void) rtR0SemBsdBroadcast(void *pvWaitChan)
{
kmutex_t *mp;
sleepq_t *sq = sleeptab_lookup(&sleeptab, pvWaitChan, &mp);
sleepq_wake(sq, pvWaitChan, ~0u, mp);
}
/**
* Gets the max resolution of the timeout machinery.
*
* @returns Resolution specified in nanoseconds.
*/
DECLINLINE(uint32_t) rtR0SemBsdWaitGetResolution(void)
{
return 1000000000 / hz; /* ns */
}
#endif /* !IPRT_INCLUDED_SRC_r0drv_netbsd_sleepqueue_r0drv_netbsd_h */
|
