kern_rwlock.c revision 1.19 1 1.19 ad /* $NetBSD: kern_rwlock.c,v 1.19 2008/04/04 17:25:09 ad Exp $ */
2 1.2 ad
3 1.2 ad /*-
4 1.16 ad * Copyright (c) 2002, 2006, 2007, 2008 The NetBSD Foundation, Inc.
5 1.2 ad * All rights reserved.
6 1.2 ad *
7 1.2 ad * This code is derived from software contributed to The NetBSD Foundation
8 1.2 ad * by Jason R. Thorpe and Andrew Doran.
9 1.2 ad *
10 1.2 ad * Redistribution and use in source and binary forms, with or without
11 1.2 ad * modification, are permitted provided that the following conditions
12 1.2 ad * are met:
13 1.2 ad * 1. Redistributions of source code must retain the above copyright
14 1.2 ad * notice, this list of conditions and the following disclaimer.
15 1.2 ad * 2. Redistributions in binary form must reproduce the above copyright
16 1.2 ad * notice, this list of conditions and the following disclaimer in the
17 1.2 ad * documentation and/or other materials provided with the distribution.
18 1.2 ad * 3. All advertising materials mentioning features or use of this software
19 1.2 ad * must display the following acknowledgement:
20 1.2 ad * This product includes software developed by the NetBSD
21 1.2 ad * Foundation, Inc. and its contributors.
22 1.2 ad * 4. Neither the name of The NetBSD Foundation nor the names of its
23 1.2 ad * contributors may be used to endorse or promote products derived
24 1.2 ad * from this software without specific prior written permission.
25 1.2 ad *
26 1.2 ad * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 1.2 ad * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 1.2 ad * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 1.2 ad * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 1.2 ad * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 1.2 ad * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 1.2 ad * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 1.2 ad * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 1.2 ad * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 1.2 ad * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 1.2 ad * POSSIBILITY OF SUCH DAMAGE.
37 1.2 ad */
38 1.2 ad
39 1.2 ad /*
40 1.2 ad * Kernel reader/writer lock implementation, modeled after those
41 1.2 ad * found in Solaris, a description of which can be found in:
42 1.2 ad *
43 1.2 ad * Solaris Internals: Core Kernel Architecture, Jim Mauro and
44 1.2 ad * Richard McDougall.
45 1.2 ad */
46 1.2 ad
47 1.10 dsl #include <sys/cdefs.h>
48 1.19 ad __KERNEL_RCSID(0, "$NetBSD: kern_rwlock.c,v 1.19 2008/04/04 17:25:09 ad Exp $");
49 1.10 dsl
50 1.2 ad #include "opt_multiprocessor.h"
51 1.2 ad
52 1.2 ad #define __RWLOCK_PRIVATE
53 1.2 ad
54 1.2 ad #include <sys/param.h>
55 1.2 ad #include <sys/proc.h>
56 1.2 ad #include <sys/rwlock.h>
57 1.2 ad #include <sys/sched.h>
58 1.2 ad #include <sys/sleepq.h>
59 1.2 ad #include <sys/systm.h>
60 1.2 ad #include <sys/lockdebug.h>
61 1.11 ad #include <sys/cpu.h>
62 1.14 ad #include <sys/atomic.h>
63 1.15 ad #include <sys/lock.h>
64 1.2 ad
65 1.2 ad #include <dev/lockstat.h>
66 1.2 ad
67 1.2 ad /*
68 1.2 ad * LOCKDEBUG
69 1.2 ad */
70 1.2 ad
71 1.2 ad #if defined(LOCKDEBUG)
72 1.2 ad
73 1.2 ad #define RW_WANTLOCK(rw, op) \
74 1.12 yamt LOCKDEBUG_WANTLOCK(RW_DEBUG_P(rw), (rw), \
75 1.2 ad (uintptr_t)__builtin_return_address(0), op == RW_READER);
76 1.2 ad #define RW_LOCKED(rw, op) \
77 1.12 yamt LOCKDEBUG_LOCKED(RW_DEBUG_P(rw), (rw), \
78 1.2 ad (uintptr_t)__builtin_return_address(0), op == RW_READER);
79 1.2 ad #define RW_UNLOCKED(rw, op) \
80 1.12 yamt LOCKDEBUG_UNLOCKED(RW_DEBUG_P(rw), (rw), \
81 1.2 ad (uintptr_t)__builtin_return_address(0), op == RW_READER);
82 1.2 ad #define RW_DASSERT(rw, cond) \
83 1.2 ad do { \
84 1.2 ad if (!(cond)) \
85 1.11 ad rw_abort(rw, __func__, "assertion failed: " #cond); \
86 1.2 ad } while (/* CONSTCOND */ 0);
87 1.2 ad
88 1.2 ad #else /* LOCKDEBUG */
89 1.2 ad
90 1.2 ad #define RW_WANTLOCK(rw, op) /* nothing */
91 1.2 ad #define RW_LOCKED(rw, op) /* nothing */
92 1.2 ad #define RW_UNLOCKED(rw, op) /* nothing */
93 1.2 ad #define RW_DASSERT(rw, cond) /* nothing */
94 1.2 ad
95 1.2 ad #endif /* LOCKDEBUG */
96 1.2 ad
97 1.2 ad /*
98 1.2 ad * DIAGNOSTIC
99 1.2 ad */
100 1.2 ad
101 1.2 ad #if defined(DIAGNOSTIC)
102 1.2 ad
103 1.2 ad #define RW_ASSERT(rw, cond) \
104 1.2 ad do { \
105 1.2 ad if (!(cond)) \
106 1.11 ad rw_abort(rw, __func__, "assertion failed: " #cond); \
107 1.2 ad } while (/* CONSTCOND */ 0)
108 1.2 ad
109 1.2 ad #else
110 1.2 ad
111 1.2 ad #define RW_ASSERT(rw, cond) /* nothing */
112 1.2 ad
113 1.2 ad #endif /* DIAGNOSTIC */
114 1.2 ad
115 1.2 ad /*
116 1.2 ad * For platforms that use 'simple' RW locks.
117 1.2 ad */
118 1.2 ad #ifdef __HAVE_SIMPLE_RW_LOCKS
119 1.12 yamt #define RW_ACQUIRE(rw, old, new) RW_CAS1(&(rw)->rw_owner, old, new)
120 1.12 yamt #define RW_RELEASE(rw, old, new) RW_CAS1(&(rw)->rw_owner, old, new)
121 1.12 yamt #define RW_SETDEBUG(rw, on) ((rw)->rw_owner |= (on) ? RW_DEBUG : 0)
122 1.12 yamt #define RW_DEBUG_P(rw) (((rw)->rw_owner & RW_DEBUG) != 0)
123 1.12 yamt #if defined(LOCKDEBUG)
124 1.12 yamt #define RW_INHERITDEBUG(new, old) (new) |= (old) & RW_DEBUG
125 1.12 yamt #else /* defined(LOCKDEBUG) */
126 1.12 yamt #define RW_INHERITDEBUG(new, old) /* nothing */
127 1.12 yamt #endif /* defined(LOCKDEBUG) */
128 1.12 yamt
129 1.12 yamt static inline int
130 1.12 yamt RW_CAS1(volatile uintptr_t *ptr, uintptr_t old, uintptr_t new)
131 1.12 yamt {
132 1.12 yamt
133 1.12 yamt RW_INHERITDEBUG(new, old);
134 1.12 yamt return RW_CAS(ptr, old, new);
135 1.12 yamt }
136 1.2 ad
137 1.2 ad static inline int
138 1.2 ad RW_SET_WAITERS(krwlock_t *rw, uintptr_t need, uintptr_t set)
139 1.2 ad {
140 1.2 ad uintptr_t old;
141 1.2 ad
142 1.2 ad if (((old = rw->rw_owner) & need) == 0)
143 1.2 ad return 0;
144 1.2 ad return RW_CAS(&rw->rw_owner, old, old | set);
145 1.2 ad }
146 1.2 ad #endif /* __HAVE_SIMPLE_RW_LOCKS */
147 1.2 ad
148 1.2 ad /*
149 1.2 ad * For platforms that do not provide stubs, or for the LOCKDEBUG case.
150 1.2 ad */
151 1.2 ad #ifdef LOCKDEBUG
152 1.2 ad #undef __HAVE_RW_STUBS
153 1.2 ad #endif
154 1.2 ad
155 1.2 ad #ifndef __HAVE_RW_STUBS
156 1.6 itohy __strong_alias(rw_enter,rw_vector_enter);
157 1.6 itohy __strong_alias(rw_exit,rw_vector_exit);
158 1.16 ad __strong_alias(rw_tryenter,rw_vector_tryenter);
159 1.2 ad #endif
160 1.2 ad
161 1.7 ad static void rw_dump(volatile void *);
162 1.7 ad static lwp_t *rw_owner(wchan_t);
163 1.19 ad extern int mutex_onproc(uintptr_t, struct cpu_info **); /* XXX */
164 1.2 ad
165 1.2 ad lockops_t rwlock_lockops = {
166 1.2 ad "Reader / writer lock",
167 1.2 ad 1,
168 1.2 ad rw_dump
169 1.2 ad };
170 1.2 ad
171 1.4 yamt syncobj_t rw_syncobj = {
172 1.4 yamt SOBJ_SLEEPQ_SORTED,
173 1.4 yamt turnstile_unsleep,
174 1.4 yamt turnstile_changepri,
175 1.4 yamt sleepq_lendpri,
176 1.4 yamt rw_owner,
177 1.4 yamt };
178 1.4 yamt
179 1.2 ad /*
180 1.2 ad * rw_dump:
181 1.2 ad *
182 1.2 ad * Dump the contents of a rwlock structure.
183 1.2 ad */
184 1.11 ad static void
185 1.2 ad rw_dump(volatile void *cookie)
186 1.2 ad {
187 1.2 ad volatile krwlock_t *rw = cookie;
188 1.2 ad
189 1.2 ad printf_nolog("owner/count : %#018lx flags : %#018x\n",
190 1.2 ad (long)RW_OWNER(rw), (int)RW_FLAGS(rw));
191 1.2 ad }
192 1.2 ad
193 1.2 ad /*
194 1.11 ad * rw_abort:
195 1.11 ad *
196 1.11 ad * Dump information about an error and panic the system. This
197 1.11 ad * generates a lot of machine code in the DIAGNOSTIC case, so
198 1.11 ad * we ask the compiler to not inline it.
199 1.11 ad */
200 1.11 ad #if __GNUC_PREREQ__(3, 0)
201 1.11 ad __attribute ((noinline))
202 1.11 ad #endif
203 1.11 ad static void
204 1.11 ad rw_abort(krwlock_t *rw, const char *func, const char *msg)
205 1.11 ad {
206 1.11 ad
207 1.11 ad if (panicstr != NULL)
208 1.11 ad return;
209 1.11 ad
210 1.12 yamt LOCKDEBUG_ABORT(rw, &rwlock_lockops, func, msg);
211 1.11 ad }
212 1.11 ad
213 1.11 ad /*
214 1.2 ad * rw_init:
215 1.2 ad *
216 1.2 ad * Initialize a rwlock for use.
217 1.2 ad */
218 1.2 ad void
219 1.2 ad rw_init(krwlock_t *rw)
220 1.2 ad {
221 1.12 yamt bool dodebug;
222 1.2 ad
223 1.2 ad memset(rw, 0, sizeof(*rw));
224 1.2 ad
225 1.12 yamt dodebug = LOCKDEBUG_ALLOC(rw, &rwlock_lockops,
226 1.11 ad (uintptr_t)__builtin_return_address(0));
227 1.12 yamt RW_SETDEBUG(rw, dodebug);
228 1.2 ad }
229 1.2 ad
230 1.2 ad /*
231 1.2 ad * rw_destroy:
232 1.2 ad *
233 1.2 ad * Tear down a rwlock.
234 1.2 ad */
235 1.2 ad void
236 1.2 ad rw_destroy(krwlock_t *rw)
237 1.2 ad {
238 1.2 ad
239 1.12 yamt RW_ASSERT(rw, (rw->rw_owner & ~RW_DEBUG) == 0);
240 1.12 yamt LOCKDEBUG_FREE(RW_DEBUG_P(rw), rw);
241 1.2 ad }
242 1.2 ad
243 1.2 ad /*
244 1.2 ad * rw_vector_enter:
245 1.2 ad *
246 1.2 ad * Acquire a rwlock.
247 1.2 ad */
248 1.2 ad void
249 1.2 ad rw_vector_enter(krwlock_t *rw, const krw_t op)
250 1.2 ad {
251 1.2 ad uintptr_t owner, incr, need_wait, set_wait, curthread;
252 1.19 ad struct cpu_info *ci;
253 1.2 ad turnstile_t *ts;
254 1.2 ad int queue;
255 1.7 ad lwp_t *l;
256 1.2 ad LOCKSTAT_TIMER(slptime);
257 1.19 ad LOCKSTAT_TIMER(spintime);
258 1.19 ad LOCKSTAT_COUNTER(spincnt);
259 1.2 ad LOCKSTAT_FLAG(lsflag);
260 1.2 ad
261 1.2 ad l = curlwp;
262 1.2 ad curthread = (uintptr_t)l;
263 1.2 ad
264 1.13 ad RW_ASSERT(rw, !cpu_intr_p());
265 1.2 ad RW_ASSERT(rw, curthread != 0);
266 1.2 ad RW_WANTLOCK(rw, op);
267 1.2 ad
268 1.2 ad if (panicstr == NULL) {
269 1.2 ad LOCKDEBUG_BARRIER(&kernel_lock, 1);
270 1.2 ad }
271 1.2 ad
272 1.2 ad /*
273 1.2 ad * We play a slight trick here. If we're a reader, we want
274 1.2 ad * increment the read count. If we're a writer, we want to
275 1.2 ad * set the owner field and whe WRITE_LOCKED bit.
276 1.2 ad *
277 1.2 ad * In the latter case, we expect those bits to be zero,
278 1.2 ad * therefore we can use an add operation to set them, which
279 1.2 ad * means an add operation for both cases.
280 1.2 ad */
281 1.2 ad if (__predict_true(op == RW_READER)) {
282 1.2 ad incr = RW_READ_INCR;
283 1.2 ad set_wait = RW_HAS_WAITERS;
284 1.2 ad need_wait = RW_WRITE_LOCKED | RW_WRITE_WANTED;
285 1.2 ad queue = TS_READER_Q;
286 1.2 ad } else {
287 1.2 ad RW_DASSERT(rw, op == RW_WRITER);
288 1.2 ad incr = curthread | RW_WRITE_LOCKED;
289 1.2 ad set_wait = RW_HAS_WAITERS | RW_WRITE_WANTED;
290 1.2 ad need_wait = RW_WRITE_LOCKED | RW_THREAD;
291 1.2 ad queue = TS_WRITER_Q;
292 1.2 ad }
293 1.2 ad
294 1.2 ad LOCKSTAT_ENTER(lsflag);
295 1.2 ad
296 1.19 ad for (ci = NULL;;) {
297 1.2 ad /*
298 1.2 ad * Read the lock owner field. If the need-to-wait
299 1.2 ad * indicator is clear, then try to acquire the lock.
300 1.2 ad */
301 1.2 ad owner = rw->rw_owner;
302 1.2 ad if ((owner & need_wait) == 0) {
303 1.2 ad if (RW_ACQUIRE(rw, owner, owner + incr)) {
304 1.2 ad /* Got it! */
305 1.2 ad break;
306 1.2 ad }
307 1.2 ad
308 1.2 ad /*
309 1.2 ad * Didn't get it -- spin around again (we'll
310 1.2 ad * probably sleep on the next iteration).
311 1.2 ad */
312 1.2 ad continue;
313 1.2 ad }
314 1.2 ad
315 1.2 ad if (panicstr != NULL)
316 1.2 ad return;
317 1.2 ad if (RW_OWNER(rw) == curthread)
318 1.11 ad rw_abort(rw, __func__, "locking against myself");
319 1.2 ad
320 1.19 ad #ifdef MULTIPROCESSOR
321 1.19 ad /*
322 1.19 ad * If the lock owner is running on another CPU, and
323 1.19 ad * there are no existing waiters, then spin.
324 1.19 ad */
325 1.19 ad if ((owner & (RW_WRITE_LOCKED|RW_HAS_WAITERS)) ==
326 1.19 ad RW_WRITE_LOCKED && mutex_onproc(owner, &ci)) {
327 1.19 ad LOCKSTAT_START_TIMER(lsflag, spintime);
328 1.19 ad u_int count = SPINLOCK_BACKOFF_MIN;
329 1.19 ad for (;;) {
330 1.19 ad owner = rw->rw_owner;
331 1.19 ad if ((owner & (RW_WRITE_LOCKED|RW_HAS_WAITERS))
332 1.19 ad != RW_WRITE_LOCKED)
333 1.19 ad break;
334 1.19 ad if (!mutex_onproc(owner, &ci))
335 1.19 ad break;
336 1.19 ad SPINLOCK_BACKOFF(count);
337 1.19 ad }
338 1.19 ad LOCKSTAT_STOP_TIMER(lsflag, spintime);
339 1.19 ad LOCKSTAT_COUNT(spincnt, 1);
340 1.19 ad if ((owner & need_wait) == 0)
341 1.19 ad continue;
342 1.19 ad }
343 1.19 ad #endif
344 1.19 ad
345 1.2 ad /*
346 1.2 ad * Grab the turnstile chain lock. Once we have that, we
347 1.2 ad * can adjust the waiter bits and sleep queue.
348 1.2 ad */
349 1.2 ad ts = turnstile_lookup(rw);
350 1.2 ad
351 1.2 ad /*
352 1.2 ad * Mark the rwlock as having waiters. If the set fails,
353 1.2 ad * then we may not need to sleep and should spin again.
354 1.2 ad */
355 1.2 ad if (!RW_SET_WAITERS(rw, need_wait, set_wait)) {
356 1.2 ad turnstile_exit(rw);
357 1.2 ad continue;
358 1.2 ad }
359 1.2 ad
360 1.2 ad LOCKSTAT_START_TIMER(lsflag, slptime);
361 1.2 ad
362 1.4 yamt turnstile_block(ts, queue, rw, &rw_syncobj);
363 1.2 ad
364 1.2 ad /* If we wake up and arrive here, we've been handed the lock. */
365 1.2 ad RW_RECEIVE(rw);
366 1.2 ad
367 1.2 ad LOCKSTAT_STOP_TIMER(lsflag, slptime);
368 1.2 ad LOCKSTAT_EVENT(lsflag, rw,
369 1.2 ad LB_RWLOCK | (op == RW_WRITER ? LB_SLEEP1 : LB_SLEEP2),
370 1.2 ad 1, slptime);
371 1.2 ad
372 1.2 ad break;
373 1.2 ad }
374 1.2 ad
375 1.19 ad LOCKSTAT_EVENT(lsflag, rw, LB_RWLOCK | LB_SPIN, spincnt, spintime);
376 1.2 ad LOCKSTAT_EXIT(lsflag);
377 1.2 ad
378 1.2 ad RW_DASSERT(rw, (op != RW_READER && RW_OWNER(rw) == curthread) ||
379 1.2 ad (op == RW_READER && RW_COUNT(rw) != 0));
380 1.2 ad RW_LOCKED(rw, op);
381 1.2 ad }
382 1.2 ad
383 1.2 ad /*
384 1.2 ad * rw_vector_exit:
385 1.2 ad *
386 1.2 ad * Release a rwlock.
387 1.2 ad */
388 1.2 ad void
389 1.2 ad rw_vector_exit(krwlock_t *rw)
390 1.2 ad {
391 1.2 ad uintptr_t curthread, owner, decr, new;
392 1.2 ad turnstile_t *ts;
393 1.2 ad int rcnt, wcnt;
394 1.7 ad lwp_t *l;
395 1.2 ad
396 1.2 ad curthread = (uintptr_t)curlwp;
397 1.2 ad RW_ASSERT(rw, curthread != 0);
398 1.2 ad
399 1.11 ad if (panicstr != NULL)
400 1.2 ad return;
401 1.2 ad
402 1.2 ad /*
403 1.2 ad * Again, we use a trick. Since we used an add operation to
404 1.2 ad * set the required lock bits, we can use a subtract to clear
405 1.2 ad * them, which makes the read-release and write-release path
406 1.2 ad * the same.
407 1.2 ad */
408 1.2 ad owner = rw->rw_owner;
409 1.2 ad if (__predict_false((owner & RW_WRITE_LOCKED) != 0)) {
410 1.2 ad RW_UNLOCKED(rw, RW_WRITER);
411 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_WRITE_LOCKED) != 0);
412 1.2 ad RW_ASSERT(rw, RW_OWNER(rw) == curthread);
413 1.2 ad decr = curthread | RW_WRITE_LOCKED;
414 1.2 ad } else {
415 1.2 ad RW_UNLOCKED(rw, RW_READER);
416 1.2 ad RW_ASSERT(rw, (rw->rw_owner & RW_WRITE_LOCKED) == 0);
417 1.2 ad RW_ASSERT(rw, RW_COUNT(rw) != 0);
418 1.2 ad decr = RW_READ_INCR;
419 1.2 ad }
420 1.2 ad
421 1.2 ad /*
422 1.2 ad * Compute what we expect the new value of the lock to be. Only
423 1.2 ad * proceed to do direct handoff if there are waiters, and if the
424 1.2 ad * lock would become unowned.
425 1.2 ad */
426 1.2 ad for (;; owner = rw->rw_owner) {
427 1.2 ad new = (owner - decr);
428 1.2 ad if ((new & (RW_THREAD | RW_HAS_WAITERS)) == RW_HAS_WAITERS)
429 1.2 ad break;
430 1.2 ad if (RW_RELEASE(rw, owner, new))
431 1.2 ad return;
432 1.2 ad }
433 1.2 ad
434 1.2 ad for (;;) {
435 1.2 ad /*
436 1.2 ad * Grab the turnstile chain lock. This gets the interlock
437 1.2 ad * on the sleep queue. Once we have that, we can adjust the
438 1.2 ad * waiter bits.
439 1.2 ad */
440 1.2 ad ts = turnstile_lookup(rw);
441 1.2 ad RW_DASSERT(rw, ts != NULL);
442 1.3 ad RW_DASSERT(rw, (rw->rw_owner & RW_HAS_WAITERS) != 0);
443 1.2 ad
444 1.2 ad owner = rw->rw_owner;
445 1.2 ad wcnt = TS_WAITERS(ts, TS_WRITER_Q);
446 1.2 ad rcnt = TS_WAITERS(ts, TS_READER_Q);
447 1.2 ad
448 1.2 ad /*
449 1.2 ad * Give the lock away.
450 1.2 ad *
451 1.2 ad * If we are releasing a write lock, then wake all
452 1.2 ad * outstanding readers. If we are releasing a read
453 1.2 ad * lock, then wake one writer.
454 1.2 ad */
455 1.2 ad if (rcnt == 0 || (decr == RW_READ_INCR && wcnt != 0)) {
456 1.2 ad RW_DASSERT(rw, wcnt != 0);
457 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_WRITE_WANTED) != 0);
458 1.2 ad
459 1.2 ad /*
460 1.2 ad * Give the lock to the longest waiting
461 1.2 ad * writer.
462 1.2 ad */
463 1.2 ad l = TS_FIRST(ts, TS_WRITER_Q);
464 1.2 ad new = (uintptr_t)l | RW_WRITE_LOCKED;
465 1.2 ad
466 1.2 ad if (wcnt > 1)
467 1.2 ad new |= RW_HAS_WAITERS | RW_WRITE_WANTED;
468 1.2 ad else if (rcnt != 0)
469 1.2 ad new |= RW_HAS_WAITERS;
470 1.2 ad
471 1.2 ad RW_GIVE(rw);
472 1.2 ad if (!RW_RELEASE(rw, owner, new)) {
473 1.2 ad /* Oops, try again. */
474 1.2 ad turnstile_exit(rw);
475 1.2 ad continue;
476 1.2 ad }
477 1.2 ad
478 1.2 ad /* Wake the writer. */
479 1.7 ad turnstile_wakeup(ts, TS_WRITER_Q, 1, l);
480 1.2 ad } else {
481 1.2 ad RW_DASSERT(rw, rcnt != 0);
482 1.2 ad
483 1.2 ad /*
484 1.3 ad * Give the lock to all blocked readers. If there
485 1.3 ad * is a writer waiting, new readers that arrive
486 1.3 ad * after the release will be blocked out.
487 1.2 ad */
488 1.2 ad new = rcnt << RW_READ_COUNT_SHIFT;
489 1.2 ad if (wcnt != 0)
490 1.2 ad new |= RW_HAS_WAITERS | RW_WRITE_WANTED;
491 1.12 yamt
492 1.2 ad RW_GIVE(rw);
493 1.2 ad if (!RW_RELEASE(rw, owner, new)) {
494 1.2 ad /* Oops, try again. */
495 1.2 ad turnstile_exit(rw);
496 1.2 ad continue;
497 1.2 ad }
498 1.2 ad
499 1.2 ad /* Wake up all sleeping readers. */
500 1.2 ad turnstile_wakeup(ts, TS_READER_Q, rcnt, NULL);
501 1.2 ad }
502 1.2 ad
503 1.2 ad break;
504 1.2 ad }
505 1.2 ad }
506 1.2 ad
507 1.2 ad /*
508 1.16 ad * rw_vector_tryenter:
509 1.2 ad *
510 1.2 ad * Try to acquire a rwlock.
511 1.2 ad */
512 1.2 ad int
513 1.16 ad rw_vector_tryenter(krwlock_t *rw, const krw_t op)
514 1.2 ad {
515 1.2 ad uintptr_t curthread, owner, incr, need_wait;
516 1.2 ad
517 1.2 ad curthread = (uintptr_t)curlwp;
518 1.2 ad
519 1.2 ad RW_ASSERT(rw, curthread != 0);
520 1.2 ad
521 1.2 ad if (op == RW_READER) {
522 1.2 ad incr = RW_READ_INCR;
523 1.2 ad need_wait = RW_WRITE_LOCKED | RW_WRITE_WANTED;
524 1.2 ad } else {
525 1.2 ad RW_DASSERT(rw, op == RW_WRITER);
526 1.2 ad incr = curthread | RW_WRITE_LOCKED;
527 1.2 ad need_wait = RW_WRITE_LOCKED | RW_THREAD;
528 1.2 ad }
529 1.2 ad
530 1.2 ad for (;;) {
531 1.2 ad owner = rw->rw_owner;
532 1.2 ad if ((owner & need_wait) == 0) {
533 1.2 ad if (RW_ACQUIRE(rw, owner, owner + incr)) {
534 1.2 ad /* Got it! */
535 1.2 ad break;
536 1.2 ad }
537 1.2 ad continue;
538 1.2 ad }
539 1.2 ad return 0;
540 1.2 ad }
541 1.2 ad
542 1.16 ad RW_WANTLOCK(rw, op);
543 1.2 ad RW_LOCKED(rw, op);
544 1.2 ad RW_DASSERT(rw, (op != RW_READER && RW_OWNER(rw) == curthread) ||
545 1.2 ad (op == RW_READER && RW_COUNT(rw) != 0));
546 1.7 ad
547 1.2 ad return 1;
548 1.2 ad }
549 1.2 ad
550 1.2 ad /*
551 1.2 ad * rw_downgrade:
552 1.2 ad *
553 1.2 ad * Downgrade a write lock to a read lock.
554 1.2 ad */
555 1.2 ad void
556 1.2 ad rw_downgrade(krwlock_t *rw)
557 1.2 ad {
558 1.2 ad uintptr_t owner, curthread, new;
559 1.2 ad turnstile_t *ts;
560 1.2 ad int rcnt, wcnt;
561 1.2 ad
562 1.2 ad curthread = (uintptr_t)curlwp;
563 1.2 ad RW_ASSERT(rw, curthread != 0);
564 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_WRITE_LOCKED) != 0);
565 1.2 ad RW_ASSERT(rw, RW_OWNER(rw) == curthread);
566 1.2 ad RW_UNLOCKED(rw, RW_WRITER);
567 1.2 ad
568 1.2 ad owner = rw->rw_owner;
569 1.2 ad if ((owner & RW_HAS_WAITERS) == 0) {
570 1.2 ad /*
571 1.2 ad * There are no waiters, so we can do this the easy way.
572 1.2 ad * Try swapping us down to one read hold. If it fails, the
573 1.2 ad * lock condition has changed and we most likely now have
574 1.2 ad * waiters.
575 1.2 ad */
576 1.2 ad if (RW_RELEASE(rw, owner, RW_READ_INCR)) {
577 1.2 ad RW_LOCKED(rw, RW_READER);
578 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_WRITE_LOCKED) == 0);
579 1.2 ad RW_DASSERT(rw, RW_COUNT(rw) != 0);
580 1.2 ad return;
581 1.2 ad }
582 1.2 ad }
583 1.2 ad
584 1.2 ad /*
585 1.2 ad * Grab the turnstile chain lock. This gets the interlock
586 1.2 ad * on the sleep queue. Once we have that, we can adjust the
587 1.2 ad * waiter bits.
588 1.2 ad */
589 1.2 ad for (;;) {
590 1.2 ad ts = turnstile_lookup(rw);
591 1.2 ad RW_DASSERT(rw, ts != NULL);
592 1.2 ad
593 1.2 ad owner = rw->rw_owner;
594 1.2 ad rcnt = TS_WAITERS(ts, TS_READER_Q);
595 1.2 ad wcnt = TS_WAITERS(ts, TS_WRITER_Q);
596 1.2 ad
597 1.2 ad /*
598 1.2 ad * If there are no readers, just preserve the waiters
599 1.2 ad * bits, swap us down to one read hold and return.
600 1.2 ad */
601 1.2 ad if (rcnt == 0) {
602 1.2 ad RW_DASSERT(rw, wcnt != 0);
603 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_WRITE_WANTED) != 0);
604 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_HAS_WAITERS) != 0);
605 1.2 ad
606 1.2 ad new = RW_READ_INCR | RW_HAS_WAITERS | RW_WRITE_WANTED;
607 1.2 ad if (!RW_RELEASE(rw, owner, new)) {
608 1.2 ad /* Oops, try again. */
609 1.2 ad turnstile_exit(ts);
610 1.2 ad continue;
611 1.2 ad }
612 1.2 ad break;
613 1.2 ad }
614 1.2 ad
615 1.2 ad /*
616 1.2 ad * Give the lock to all blocked readers. We may
617 1.2 ad * retain one read hold if downgrading. If there
618 1.2 ad * is a writer waiting, new readers will be blocked
619 1.2 ad * out.
620 1.2 ad */
621 1.2 ad new = (rcnt << RW_READ_COUNT_SHIFT) + RW_READ_INCR;
622 1.2 ad if (wcnt != 0)
623 1.2 ad new |= RW_HAS_WAITERS | RW_WRITE_WANTED;
624 1.2 ad
625 1.2 ad RW_GIVE(rw);
626 1.2 ad if (!RW_RELEASE(rw, owner, new)) {
627 1.2 ad /* Oops, try again. */
628 1.2 ad turnstile_exit(rw);
629 1.2 ad continue;
630 1.2 ad }
631 1.2 ad
632 1.2 ad /* Wake up all sleeping readers. */
633 1.2 ad turnstile_wakeup(ts, TS_READER_Q, rcnt, NULL);
634 1.2 ad break;
635 1.2 ad }
636 1.2 ad
637 1.2 ad RW_LOCKED(rw, RW_READER);
638 1.2 ad RW_DASSERT(rw, (rw->rw_owner & RW_WRITE_LOCKED) == 0);
639 1.2 ad RW_DASSERT(rw, RW_COUNT(rw) != 0);
640 1.2 ad }
641 1.2 ad
642 1.2 ad /*
643 1.2 ad * rw_tryupgrade:
644 1.2 ad *
645 1.2 ad * Try to upgrade a read lock to a write lock. We must be the
646 1.2 ad * only reader.
647 1.2 ad */
648 1.2 ad int
649 1.2 ad rw_tryupgrade(krwlock_t *rw)
650 1.2 ad {
651 1.2 ad uintptr_t owner, curthread, new;
652 1.2 ad
653 1.2 ad curthread = (uintptr_t)curlwp;
654 1.2 ad RW_ASSERT(rw, curthread != 0);
655 1.2 ad RW_WANTLOCK(rw, RW_WRITER);
656 1.2 ad
657 1.2 ad for (;;) {
658 1.2 ad owner = rw->rw_owner;
659 1.2 ad RW_ASSERT(rw, (owner & RW_WRITE_LOCKED) == 0);
660 1.2 ad if ((owner & RW_THREAD) != RW_READ_INCR) {
661 1.2 ad RW_ASSERT(rw, (owner & RW_THREAD) != 0);
662 1.2 ad return 0;
663 1.2 ad }
664 1.2 ad new = curthread | RW_WRITE_LOCKED | (owner & ~RW_THREAD);
665 1.2 ad if (RW_ACQUIRE(rw, owner, new))
666 1.2 ad break;
667 1.2 ad }
668 1.2 ad
669 1.2 ad RW_UNLOCKED(rw, RW_READER);
670 1.2 ad RW_LOCKED(rw, RW_WRITER);
671 1.2 ad RW_DASSERT(rw, rw->rw_owner & RW_WRITE_LOCKED);
672 1.2 ad RW_DASSERT(rw, RW_OWNER(rw) == curthread);
673 1.2 ad
674 1.2 ad return 1;
675 1.2 ad }
676 1.2 ad
677 1.2 ad /*
678 1.2 ad * rw_read_held:
679 1.2 ad *
680 1.2 ad * Returns true if the rwlock is held for reading. Must only be
681 1.2 ad * used for diagnostic assertions, and never be used to make
682 1.2 ad * decisions about how to use a rwlock.
683 1.2 ad */
684 1.2 ad int
685 1.2 ad rw_read_held(krwlock_t *rw)
686 1.2 ad {
687 1.2 ad uintptr_t owner;
688 1.2 ad
689 1.2 ad if (panicstr != NULL)
690 1.2 ad return 1;
691 1.2 ad
692 1.2 ad owner = rw->rw_owner;
693 1.2 ad return (owner & RW_WRITE_LOCKED) == 0 && (owner & RW_THREAD) != 0;
694 1.2 ad }
695 1.2 ad
696 1.2 ad /*
697 1.2 ad * rw_write_held:
698 1.2 ad *
699 1.2 ad * Returns true if the rwlock is held for writing. Must only be
700 1.2 ad * used for diagnostic assertions, and never be used to make
701 1.2 ad * decisions about how to use a rwlock.
702 1.2 ad */
703 1.2 ad int
704 1.2 ad rw_write_held(krwlock_t *rw)
705 1.2 ad {
706 1.2 ad
707 1.2 ad if (panicstr != NULL)
708 1.2 ad return 1;
709 1.2 ad
710 1.17 ad return (rw->rw_owner & (RW_WRITE_LOCKED | RW_THREAD)) ==
711 1.18 ad (RW_WRITE_LOCKED | (uintptr_t)curlwp);
712 1.2 ad }
713 1.2 ad
714 1.2 ad /*
715 1.2 ad * rw_lock_held:
716 1.2 ad *
717 1.2 ad * Returns true if the rwlock is held for reading or writing. Must
718 1.2 ad * only be used for diagnostic assertions, and never be used to make
719 1.2 ad * decisions about how to use a rwlock.
720 1.2 ad */
721 1.2 ad int
722 1.2 ad rw_lock_held(krwlock_t *rw)
723 1.2 ad {
724 1.2 ad
725 1.2 ad if (panicstr != NULL)
726 1.2 ad return 1;
727 1.2 ad
728 1.2 ad return (rw->rw_owner & RW_THREAD) != 0;
729 1.2 ad }
730 1.4 yamt
731 1.5 ad /*
732 1.5 ad * rw_owner:
733 1.5 ad *
734 1.5 ad * Return the current owner of an RW lock, but only if it is write
735 1.5 ad * held. Used for priority inheritance.
736 1.5 ad */
737 1.7 ad static lwp_t *
738 1.4 yamt rw_owner(wchan_t obj)
739 1.4 yamt {
740 1.4 yamt krwlock_t *rw = (void *)(uintptr_t)obj; /* discard qualifiers */
741 1.4 yamt uintptr_t owner = rw->rw_owner;
742 1.4 yamt
743 1.4 yamt if ((owner & RW_WRITE_LOCKED) == 0)
744 1.4 yamt return NULL;
745 1.4 yamt
746 1.4 yamt return (void *)(owner & RW_THREAD);
747 1.4 yamt }
748