2 * Copyright (c) 2005 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sys/kern/lwkt_serialize.c,v 1.18 2008/10/04 14:22:44 swildner Exp $
37 * This API provides a fast locked-bus-cycle-based serializer. It's
38 * basically a low level NON-RECURSIVE exclusive lock that can be held across
39 * a blocking condition. It is NOT a mutex.
41 * This serializer is primarily designed for low level situations and
42 * interrupt/device interaction. There are two primary facilities. First,
43 * the serializer facility itself. Second, an integrated interrupt handler
44 * disablement facility.
47 #include "opt_serializer.h"
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
53 #include <sys/rtprio.h>
54 #include <sys/queue.h>
55 #include <sys/thread2.h>
56 #include <sys/serialize.h>
57 #include <sys/sysctl.h>
59 #include <sys/kthread.h>
60 #include <machine/cpu.h>
61 #include <machine/cpufunc.h>
62 #include <machine/specialreg.h>
72 #define SLZ_KTR_STRING "slz=%p"
73 #define SLZ_KTR_ARG_SIZE (sizeof(void *))
75 #ifndef KTR_SERIALIZER
76 #define KTR_SERIALIZER KTR_ALL
80 KTR_INFO(KTR_SERIALIZER
, slz
, enter_beg
, 0, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
81 KTR_INFO(KTR_SERIALIZER
, slz
, sleep_beg
, 1, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
82 KTR_INFO(KTR_SERIALIZER
, slz
, sleep_end
, 2, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
83 KTR_INFO(KTR_SERIALIZER
, slz
, exit_end
, 3, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
84 KTR_INFO(KTR_SERIALIZER
, slz
, wakeup_beg
, 4, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
85 KTR_INFO(KTR_SERIALIZER
, slz
, wakeup_end
, 5, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
86 KTR_INFO(KTR_SERIALIZER
, slz
, try, 6, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
87 KTR_INFO(KTR_SERIALIZER
, slz
, tryfail
, 7, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
88 KTR_INFO(KTR_SERIALIZER
, slz
, tryok
, 8, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
90 KTR_INFO(KTR_SERIALIZER
, slz
, spinbo
, 9,
91 "slz=%p bo1=%d bo=%d", (sizeof(void *) + (2 * sizeof(int))));
93 KTR_INFO(KTR_SERIALIZER
, slz
, enter_end
, 10, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
94 KTR_INFO(KTR_SERIALIZER
, slz
, exit_beg
, 11, SLZ_KTR_STRING
, SLZ_KTR_ARG_SIZE
);
96 #define logslz(name, slz) KTR_LOG(slz_ ## name, slz)
98 #define logslz_spinbo(slz, bo1, bo) KTR_LOG(slz_spinbo, slz, bo1, bo)
101 static void lwkt_serialize_sleep(void *info
);
102 static void lwkt_serialize_wakeup(void *info
);
105 static void lwkt_serialize_adaptive_sleep(void *bo
);
107 static int slz_backoff_limit
= 128;
108 SYSCTL_INT(_debug
, OID_AUTO
, serialize_bolimit
, CTLFLAG_RW
,
109 &slz_backoff_limit
, 0, "");
111 static int slz_backoff_shift
= 1;
112 SYSCTL_INT(_debug
, OID_AUTO
, serialize_boshift
, CTLFLAG_RW
,
113 &slz_backoff_shift
, 0, "");
115 static int slz_backoff_round
;
116 TUNABLE_INT("debug.serialize_boround", &slz_backoff_round
);
117 SYSCTL_INT(_debug
, OID_AUTO
, serialize_boround
, CTLFLAG_RW
,
118 &slz_backoff_round
, 0, "");
122 lwkt_serialize_init(lwkt_serialize_t s
)
124 atomic_intr_init(&s
->interlock
);
126 s
->last_td
= (void *)-4;
136 lwkt_serialize_adaptive_enter(lwkt_serialize_t s
)
138 struct exp_backoff bo
;
144 ASSERT_NOT_SERIALIZED(s
);
146 logslz(enter_beg
, s
);
147 atomic_intr_cond_enter(&s
->interlock
, lwkt_serialize_adaptive_sleep
, &bo
);
148 logslz(enter_end
, s
);
150 s
->last_td
= curthread
;
152 #ifdef PROFILE_SERIALIZER
159 lwkt_serialize_enter(lwkt_serialize_t s
)
161 ASSERT_NOT_SERIALIZED(s
);
163 logslz(enter_beg
, s
);
164 atomic_intr_cond_enter(&s
->interlock
, lwkt_serialize_sleep
, s
);
165 logslz(enter_end
, s
);
167 s
->last_td
= curthread
;
169 #ifdef PROFILE_SERIALIZER
175 * Returns non-zero on success
178 lwkt_serialize_try(lwkt_serialize_t s
)
182 ASSERT_NOT_SERIALIZED(s
);
184 #ifdef PROFILE_SERIALIZER
188 if ((error
= atomic_intr_cond_try(&s
->interlock
)) == 0) {
190 s
->last_td
= curthread
;
195 #ifdef PROFILE_SERIALIZER
203 lwkt_serialize_exit(lwkt_serialize_t s
)
205 ASSERT_SERIALIZED(s
);
207 s
->last_td
= (void *)-2;
210 atomic_intr_cond_exit(&s
->interlock
, lwkt_serialize_wakeup
, s
);
215 * Interrupt handler disablement support, used by drivers. Non-stackable
219 lwkt_serialize_handler_disable(lwkt_serialize_t s
)
221 atomic_intr_handler_disable(&s
->interlock
);
225 lwkt_serialize_handler_enable(lwkt_serialize_t s
)
227 atomic_intr_handler_enable(&s
->interlock
);
231 lwkt_serialize_handler_call(lwkt_serialize_t s
, void (*func
)(void *, void *),
232 void *arg
, void *frame
)
235 * note: a return value of 0 indicates that the interrupt handler is
238 if (atomic_intr_handler_is_enabled(&s
->interlock
) == 0) {
239 logslz(enter_beg
, s
);
240 atomic_intr_cond_enter(&s
->interlock
, lwkt_serialize_sleep
, s
);
241 logslz(enter_end
, s
);
243 s
->last_td
= curthread
;
245 #ifdef PROFILE_SERIALIZER
248 if (atomic_intr_handler_is_enabled(&s
->interlock
) == 0)
251 ASSERT_SERIALIZED(s
);
253 s
->last_td
= (void *)-2;
256 atomic_intr_cond_exit(&s
->interlock
, lwkt_serialize_wakeup
, s
);
262 * Similar to handler_call but does not block. Returns 0 on success,
266 lwkt_serialize_handler_try(lwkt_serialize_t s
, void (*func
)(void *, void *),
267 void *arg
, void *frame
)
270 * note: a return value of 0 indicates that the interrupt handler is
273 if (atomic_intr_handler_is_enabled(&s
->interlock
) == 0) {
274 #ifdef PROFILE_SERIALIZER
278 if (atomic_intr_cond_try(&s
->interlock
) == 0) {
280 s
->last_td
= curthread
;
286 ASSERT_SERIALIZED(s
);
288 s
->last_td
= (void *)-2;
291 atomic_intr_cond_exit(&s
->interlock
, lwkt_serialize_wakeup
, s
);
296 #ifdef PROFILE_SERIALIZER
307 * It is possible to race an interrupt which acquires and releases the
308 * bit, then calls wakeup before we actually go to sleep, so we
309 * need to check that the interlock is still acquired from within
310 * a critical section prior to sleeping.
313 lwkt_serialize_sleep(void *info
)
315 lwkt_serialize_t s
= info
;
318 if (atomic_intr_cond_test(&s
->interlock
) != 0) {
319 #ifdef PROFILE_SERIALIZER
322 logslz(sleep_beg
, s
);
323 tsleep(s
, 0, "slize", 0);
324 logslz(sleep_end
, s
);
332 lwkt_serialize_adaptive_sleep(void *arg
)
334 struct exp_backoff
*bo
= arg
;
335 lwkt_serialize_t s
= bo
->s
;
339 * Randomize backoff value
341 #ifdef _RDTSC_SUPPORTED_
342 if (cpu_feature
& CPUID_TSC
) {
344 (((u_long
)rdtsc() ^ (((u_long
)curthread
) >> 5)) &
345 (bo
->backoff
- 1)) + 1;
348 backoff
= bo
->backoff
;
350 logslz_spinbo(s
, bo
->backoff
, backoff
);
355 for (; backoff
; --backoff
)
357 if (bo
->backoff
< slz_backoff_limit
) {
358 bo
->backoff
<<= slz_backoff_shift
;
363 if (bo
->round
>= slz_backoff_round
)
371 if (atomic_intr_cond_test(&s
->interlock
) != 0) {
372 #ifdef PROFILE_SERIALIZER
375 logslz(sleep_beg
, s
);
376 tsleep(s
, 0, "slize", 0);
377 logslz(sleep_end
, s
);
385 lwkt_serialize_wakeup(void *info
)
387 logslz(wakeup_beg
, info
);
389 logslz(wakeup_end
, info
);
394 lwkt_serialize_sysinit(void *dummy __unused
)
396 if (slz_backoff_round
<= 0)
397 slz_backoff_round
= ncpus
* 2;
399 SYSINIT(lwkt_serialize
, SI_SUB_PRE_DRIVERS
, SI_ORDER_SECOND
,
400 lwkt_serialize_sysinit
, NULL
);