1ec62699c757c02c40eb97eb5ffb5cc8ce3b9898
[dragonfly.git] / sys / kern / lwkt_token.c
1 /*
2  * Copyright (c) 2003,2004,2009 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
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
16  *    distribution.
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.
20  * 
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
32  * SUCH DAMAGE.
33  */
34
35 /*
36  * lwkt_token - Implement soft token locks.
37  *
38  * Tokens are locks which serialize a thread only while the thread is
39  * running.  If the thread blocks all tokens are released, then reacquired
40  * when the thread resumes.
41  *
42  * This implementation requires no critical sections or spin locks, but
43  * does use atomic_cmpset_ptr().
44  *
45  * Tokens may be recursively acquired by the same thread.  However the
46  * caller must be sure to release such tokens in reverse order.
47  */
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/proc.h>
52 #include <sys/rtprio.h>
53 #include <sys/queue.h>
54 #include <sys/sysctl.h>
55 #include <sys/ktr.h>
56 #include <sys/kthread.h>
57 #include <machine/cpu.h>
58 #include <sys/lock.h>
59 #include <sys/caps.h>
60 #include <sys/spinlock.h>
61
62 #include <sys/thread2.h>
63 #include <sys/spinlock2.h>
64 #include <sys/mplock2.h>
65
66 #include <vm/vm.h>
67 #include <vm/vm_param.h>
68 #include <vm/vm_kern.h>
69 #include <vm/vm_object.h>
70 #include <vm/vm_page.h>
71 #include <vm/vm_map.h>
72 #include <vm/vm_pager.h>
73 #include <vm/vm_extern.h>
74 #include <vm/vm_zone.h>
75
76 #include <machine/stdarg.h>
77 #include <machine/smp.h>
78
79 #ifndef LWKT_NUM_POOL_TOKENS
80 #define LWKT_NUM_POOL_TOKENS    1024    /* power of 2 */
81 #endif
82 #define LWKT_MASK_POOL_TOKENS   (LWKT_NUM_POOL_TOKENS - 1)
83
84 #ifdef INVARIANTS
85 static int token_debug = 0;
86 #endif
87
88 static lwkt_token       pool_tokens[LWKT_NUM_POOL_TOKENS];
89
90 #define TOKEN_STRING    "REF=%p TOK=%p TD=%p"
91 #define CONTENDED_STRING        "REF=%p TOK=%p TD=%p (contention started)"
92 #define UNCONTENDED_STRING      "REF=%p TOK=%p TD=%p (contention stopped)"
93 #if !defined(KTR_TOKENS)
94 #define KTR_TOKENS      KTR_ALL
95 #endif
96
97 KTR_INFO_MASTER(tokens);
98 KTR_INFO(KTR_TOKENS, tokens, fail, 0, TOKEN_STRING, sizeof(void *) * 3);
99 KTR_INFO(KTR_TOKENS, tokens, succ, 1, TOKEN_STRING, sizeof(void *) * 3);
100 #if 0
101 KTR_INFO(KTR_TOKENS, tokens, release, 2, TOKEN_STRING, sizeof(void *) * 3);
102 KTR_INFO(KTR_TOKENS, tokens, remote, 3, TOKEN_STRING, sizeof(void *) * 3);
103 KTR_INFO(KTR_TOKENS, tokens, reqremote, 4, TOKEN_STRING, sizeof(void *) * 3);
104 KTR_INFO(KTR_TOKENS, tokens, reqfail, 5, TOKEN_STRING, sizeof(void *) * 3);
105 KTR_INFO(KTR_TOKENS, tokens, drain, 6, TOKEN_STRING, sizeof(void *) * 3);
106 KTR_INFO(KTR_TOKENS, tokens, contention_start, 7, CONTENDED_STRING, sizeof(void *) * 3);
107 KTR_INFO(KTR_TOKENS, tokens, contention_stop, 7, UNCONTENDED_STRING, sizeof(void *) * 3);
108 #endif
109
110 #define logtoken(name, ref)                                             \
111         KTR_LOG(tokens_ ## name, ref, ref->tr_tok, curthread)
112
113 #ifdef INVARIANTS
114 SYSCTL_INT(_lwkt, OID_AUTO, token_debug, CTLFLAG_RW, &token_debug, 0, "");
115 #endif
116
117 /*
118  * Global tokens.  These replace the MP lock for major subsystem locking.
119  * These tokens are initially used to lockup both global and individual
120  * operations.
121  *
122  * Once individual structures get their own locks these tokens are used
123  * only to protect global lists & other variables and to interlock
124  * allocations and teardowns and such.
125  *
126  * The UP initializer causes token acquisition to also acquire the MP lock
127  * for maximum compatibility.  The feature may be enabled and disabled at
128  * any time, the MP state is copied to the tokref when the token is acquired
129  * and will not race against sysctl changes.
130  */
131 struct lwkt_token pmap_token = LWKT_TOKEN_UP_INITIALIZER(pmap_token);
132 struct lwkt_token dev_token = LWKT_TOKEN_UP_INITIALIZER(dev_token);
133 struct lwkt_token vm_token = LWKT_TOKEN_UP_INITIALIZER(vm_token);
134 struct lwkt_token vmspace_token = LWKT_TOKEN_UP_INITIALIZER(vmspace_token);
135 struct lwkt_token kvm_token = LWKT_TOKEN_UP_INITIALIZER(kvm_token);
136 struct lwkt_token proc_token = LWKT_TOKEN_UP_INITIALIZER(proc_token);
137 struct lwkt_token tty_token = LWKT_TOKEN_UP_INITIALIZER(tty_token);
138 struct lwkt_token vnode_token = LWKT_TOKEN_UP_INITIALIZER(vnode_token);
139 struct lwkt_token vmobj_token = LWKT_TOKEN_UP_INITIALIZER(vmobj_token);
140
141 SYSCTL_INT(_lwkt, OID_AUTO, pmap_mpsafe,
142            CTLFLAG_RW, &pmap_token.t_flags, 0, "");
143 SYSCTL_INT(_lwkt, OID_AUTO, dev_mpsafe,
144            CTLFLAG_RW, &dev_token.t_flags, 0, "");
145 SYSCTL_INT(_lwkt, OID_AUTO, vm_mpsafe,
146            CTLFLAG_RW, &vm_token.t_flags, 0, "");
147 SYSCTL_INT(_lwkt, OID_AUTO, vmspace_mpsafe,
148            CTLFLAG_RW, &vmspace_token.t_flags, 0, "");
149 SYSCTL_INT(_lwkt, OID_AUTO, kvm_mpsafe,
150            CTLFLAG_RW, &kvm_token.t_flags, 0, "");
151 SYSCTL_INT(_lwkt, OID_AUTO, proc_mpsafe,
152            CTLFLAG_RW, &proc_token.t_flags, 0, "");
153 SYSCTL_INT(_lwkt, OID_AUTO, tty_mpsafe,
154            CTLFLAG_RW, &tty_token.t_flags, 0, "");
155 SYSCTL_INT(_lwkt, OID_AUTO, vnode_mpsafe,
156            CTLFLAG_RW, &vnode_token.t_flags, 0, "");
157 SYSCTL_INT(_lwkt, OID_AUTO, vmobj_mpsafe,
158            CTLFLAG_RW, &vmobj_token.t_flags, 0, "");
159
160 /*
161  * The collision count is bumped every time the LWKT scheduler fails
162  * to acquire needed tokens in addition to a normal lwkt_gettoken()
163  * stall.
164  */
165 SYSCTL_LONG(_lwkt, OID_AUTO, pmap_collisions,
166             CTLFLAG_RW, &pmap_token.t_collisions, 0, "");
167 SYSCTL_LONG(_lwkt, OID_AUTO, dev_collisions,
168             CTLFLAG_RW, &dev_token.t_collisions, 0, "");
169 SYSCTL_LONG(_lwkt, OID_AUTO, vm_collisions,
170             CTLFLAG_RW, &vm_token.t_collisions, 0, "");
171 SYSCTL_LONG(_lwkt, OID_AUTO, vmspace_collisions,
172             CTLFLAG_RW, &vmspace_token.t_collisions, 0, "");
173 SYSCTL_LONG(_lwkt, OID_AUTO, kvm_collisions,
174             CTLFLAG_RW, &kvm_token.t_collisions, 0, "");
175 SYSCTL_LONG(_lwkt, OID_AUTO, proc_collisions,
176             CTLFLAG_RW, &proc_token.t_collisions, 0, "");
177 SYSCTL_LONG(_lwkt, OID_AUTO, tty_collisions,
178             CTLFLAG_RW, &tty_token.t_collisions, 0, "");
179 SYSCTL_LONG(_lwkt, OID_AUTO, vnode_collisions,
180             CTLFLAG_RW, &vnode_token.t_collisions, 0, "");
181
182 /*
183  * Return a pool token given an address
184  */
185 static __inline
186 lwkt_token_t
187 _lwkt_token_pool_lookup(void *ptr)
188 {
189         int i;
190
191         i = ((int)(intptr_t)ptr >> 2) ^ ((int)(intptr_t)ptr >> 12);
192         return(&pool_tokens[i & LWKT_MASK_POOL_TOKENS]);
193 }
194
195 /*
196  * Initialize a tokref_t prior to making it visible in the thread's
197  * token array.
198  *
199  * As an optimization we set the MPSAFE flag if the thread is already
200  * holding the MP lock.  This bypasses unncessary calls to get_mplock() and
201  * rel_mplock() on tokens which are not normally MPSAFE when the thread
202  * is already holding the MP lock.
203  */
204 static __inline
205 void
206 _lwkt_tokref_init(lwkt_tokref_t ref, lwkt_token_t tok, thread_t td)
207 {
208         ref->tr_tok = tok;
209         ref->tr_owner = td;
210         ref->tr_flags = tok->t_flags;
211 #ifdef SMP
212         if (td->td_mpcount)
213 #endif
214                 ref->tr_flags |= LWKT_TOKEN_MPSAFE;
215 }
216
217 /*
218  * Obtain all the tokens required by the specified thread on the current
219  * cpu, return 0 on failure and non-zero on success.  If a failure occurs
220  * any partially acquired tokens will be released prior to return.
221  *
222  * lwkt_getalltokens is called by the LWKT scheduler to acquire all
223  * tokens that the thread had acquired prior to going to sleep.
224  *
225  * The scheduler is responsible for maintaining the MP lock count, so
226  * we don't need to deal with tr_flags here.  We also do not do any
227  * logging here.  The logging done by lwkt_gettoken() is plenty good
228  * enough to get a feel for it.
229  *
230  * Called from a critical section.
231  */
232 int
233 lwkt_getalltokens(thread_t td, const char **msgp, const void **addrp)
234 {
235         lwkt_tokref_t scan;
236         lwkt_tokref_t ref;
237         lwkt_token_t tok;
238
239         /*
240          * Acquire tokens in forward order, assign or validate tok->t_ref.
241          */
242         for (scan = &td->td_toks_base; scan < td->td_toks_stop; ++scan) {
243                 tok = scan->tr_tok;
244                 for (;;) {
245                         /*
246                          * Try to acquire the token if we do not already have
247                          * it.
248                          *
249                          * NOTE: If atomic_cmpset_ptr() fails we have to
250                          *       loop and try again.  It just means we
251                          *       lost a cpu race.
252                          */
253                         ref = tok->t_ref;
254                         if (ref == NULL) {
255                                 if (atomic_cmpset_ptr(&tok->t_ref, NULL, scan))
256                                         break;
257                                 continue;
258                         }
259
260                         /*
261                          * Test if ref is already recursively held by this
262                          * thread.  We cannot safely dereference tok->t_ref
263                          * (it might belong to another thread and is thus
264                          * unstable), but we don't have to. We can simply
265                          * range-check it.
266                          */
267                         if (ref >= &td->td_toks_base && ref < td->td_toks_stop)
268                                 break;
269
270                         /*
271                          * Otherwise we failed to acquire all the tokens.
272                          * Undo and return.
273                          */
274                         *msgp = tok->t_desc;
275                         *addrp = scan->tr_stallpc;
276                         atomic_add_long(&tok->t_collisions, 1);
277                         lwkt_relalltokens(td);
278                         return(FALSE);
279                 }
280         }
281         return (TRUE);
282 }
283
284 /*
285  * Release all tokens owned by the specified thread on the current cpu.
286  *
287  * This code is really simple.  Even in cases where we own all the tokens
288  * note that t_ref may not match the scan for recursively held tokens,
289  * or for the case where a lwkt_getalltokens() failed.
290  *
291  * The scheduler is responsible for maintaining the MP lock count, so
292  * we don't need to deal with tr_flags here.
293  * 
294  * Called from a critical section.
295  */
296 void
297 lwkt_relalltokens(thread_t td)
298 {
299         lwkt_tokref_t scan;
300         lwkt_token_t tok;
301
302         for (scan = &td->td_toks_base; scan < td->td_toks_stop; ++scan) {
303                 tok = scan->tr_tok;
304                 if (tok->t_ref == scan)
305                         tok->t_ref = NULL;
306         }
307 }
308
309 /*
310  * Token acquisition helper function.  The caller must have already
311  * made nref visible by adjusting td_toks_stop and will be responsible
312  * for the disposition of nref on either success or failure.
313  *
314  * When acquiring tokens recursively we want tok->t_ref to point to
315  * the outer (first) acquisition so it gets cleared only on the last
316  * release.
317  */
318 static __inline
319 int
320 _lwkt_trytokref2(lwkt_tokref_t nref, thread_t td)
321 {
322         lwkt_token_t tok;
323         lwkt_tokref_t ref;
324
325         KKASSERT(td->td_gd->gd_intr_nesting_level == 0);
326
327         /*
328          * Make sure the compiler does not reorder prior instructions
329          * beyond this demark.
330          */
331         cpu_ccfence();
332
333         /*
334          * Attempt to gain ownership
335          */
336         tok = nref->tr_tok;
337         for (;;) {
338                 /*
339                  * Try to acquire the token if we do not already have
340                  * it.
341                  */
342                 ref = tok->t_ref;
343                 if (ref == NULL) {
344                         /*
345                          * NOTE: If atomic_cmpset_ptr() fails we have to
346                          *       loop and try again.  It just means we
347                          *       lost a cpu race.
348                          */
349                         if (atomic_cmpset_ptr(&tok->t_ref, NULL, nref))
350                                 return (TRUE);
351                         continue;
352                 }
353
354                 /*
355                  * Test if ref is already recursively held by this
356                  * thread.  We cannot safely dereference tok->t_ref
357                  * (it might belong to another thread and is thus
358                  * unstable), but we don't have to. We can simply
359                  * range-check it.
360                  */
361                 if (ref >= &td->td_toks_base && ref < td->td_toks_stop)
362                         return(TRUE);
363
364                 /*
365                  * Otherwise we failed.
366                  */
367                 return(FALSE);
368         }
369 }
370
371 /*
372  * Acquire a serializing token.  This routine does not block.
373  */
374 static __inline
375 int
376 _lwkt_trytokref(lwkt_tokref_t ref, thread_t td)
377 {
378         if ((ref->tr_flags & LWKT_TOKEN_MPSAFE) == 0) {
379                 if (try_mplock() == 0)
380                         return (FALSE);
381         }
382         if (_lwkt_trytokref2(ref, td) == FALSE) {
383                 /*
384                  * Cleanup, deactivate the failed token.
385                  */
386                 --td->td_toks_stop;
387                 if ((ref->tr_flags & LWKT_TOKEN_MPSAFE) == 0)
388                         rel_mplock();
389                 return (FALSE);
390         }
391         return (TRUE);
392 }
393
394 /*
395  * Acquire a serializing token.  This routine can block.
396  */
397 static __inline
398 void
399 _lwkt_gettokref(lwkt_tokref_t ref, thread_t td, const void **stkframe)
400 {
401         if ((ref->tr_flags & LWKT_TOKEN_MPSAFE) == 0)
402                 get_mplock();
403         if (_lwkt_trytokref2(ref, td) == FALSE) {
404                 /*
405                  * Give up running if we can't acquire the token right now.
406                  *
407                  * Since the tokref is already active the scheduler now
408                  * takes care of acquisition, so we need only call
409                  * lwkt_switch().
410                  *
411                  * Since we failed this was not a recursive token so upon
412                  * return tr_tok->t_ref should be assigned to this specific
413                  * ref.
414                  */
415                 ref->tr_stallpc = stkframe[-1];
416                 atomic_add_long(&ref->tr_tok->t_collisions, 1);
417                 logtoken(fail, ref);
418                 lwkt_switch();
419                 logtoken(succ, ref);
420                 KKASSERT(ref->tr_tok->t_ref == ref);
421         }
422 }
423
424 void
425 lwkt_gettoken(lwkt_token_t tok)
426 {
427         thread_t td = curthread;
428         lwkt_tokref_t ref;
429
430         ref = td->td_toks_stop;
431         KKASSERT(ref < &td->td_toks_end);
432         _lwkt_tokref_init(ref, tok, td);
433         ++td->td_toks_stop;
434         _lwkt_gettokref(ref, td, (const void **)&tok);
435 }
436
437 lwkt_token_t
438 lwkt_getpooltoken(void *ptr)
439 {
440         thread_t td = curthread;
441         lwkt_token_t tok;
442         lwkt_tokref_t ref;
443
444         ref = td->td_toks_stop;
445         KKASSERT(ref < &td->td_toks_end);
446         tok = _lwkt_token_pool_lookup(ptr);
447         _lwkt_tokref_init(ref, tok, td);
448         ++td->td_toks_stop;
449         _lwkt_gettokref(ref, td, (const void **)&ptr);
450         return(tok);
451 }
452
453 int
454 lwkt_trytoken(lwkt_token_t tok)
455 {
456         thread_t td = curthread;
457         lwkt_tokref_t ref;
458
459         ref = td->td_toks_stop;
460         KKASSERT(ref < &td->td_toks_end);
461         _lwkt_tokref_init(ref, tok, td);
462         ++td->td_toks_stop;
463         return(_lwkt_trytokref(ref, td));
464 }
465
466 /*
467  * Release a serializing token.
468  *
469  * WARNING!  All tokens must be released in reverse order.  This will be
470  *           asserted.
471  */
472 void
473 lwkt_reltoken(lwkt_token_t tok)
474 {
475         thread_t td = curthread;
476         lwkt_tokref_t ref;
477
478         /*
479          * Remove ref from thread token list and assert that it matches
480          * the token passed in.  Tokens must be released in reverse order.
481          */
482         ref = td->td_toks_stop - 1;
483         KKASSERT(ref >= &td->td_toks_base && ref->tr_tok == tok);
484         td->td_toks_stop = ref;
485
486         /*
487          * If the token was not MPSAFE release the MP lock.
488          */
489         if ((ref->tr_flags & LWKT_TOKEN_MPSAFE) == 0)
490                 rel_mplock();
491
492         /*
493          * Make sure the compiler does not reorder the clearing of
494          * tok->t_ref.
495          */
496         cpu_ccfence();
497
498         /*
499          * Only clear the token if it matches ref.  If ref was a recursively
500          * acquired token it may not match.
501          */
502         if (tok->t_ref == ref)
503                 tok->t_ref = NULL;
504 }
505
506 /*
507  * Pool tokens are used to provide a type-stable serializing token
508  * pointer that does not race against disappearing data structures.
509  *
510  * This routine is called in early boot just after we setup the BSP's
511  * globaldata structure.
512  */
513 void
514 lwkt_token_pool_init(void)
515 {
516         int i;
517
518         for (i = 0; i < LWKT_NUM_POOL_TOKENS; ++i)
519                 lwkt_token_init(&pool_tokens[i], 1, "pool");
520 }
521
522 lwkt_token_t
523 lwkt_token_pool_lookup(void *ptr)
524 {
525         return (_lwkt_token_pool_lookup(ptr));
526 }
527
528 /*
529  * Initialize a token.  If mpsafe is 0, the MP lock is acquired before
530  * acquiring the token and released after releasing the token.
531  */
532 void
533 lwkt_token_init(lwkt_token_t tok, int mpsafe, const char *desc)
534 {
535         tok->t_ref = NULL;
536         tok->t_flags = mpsafe ? LWKT_TOKEN_MPSAFE : 0;
537         tok->t_collisions = 0;
538         tok->t_desc = desc;
539 }
540
541 void
542 lwkt_token_uninit(lwkt_token_t tok)
543 {
544         /* empty */
545 }
546
547 #if 0
548 int
549 lwkt_token_is_stale(lwkt_tokref_t ref)
550 {
551         lwkt_token_t tok = ref->tr_tok;
552
553         KKASSERT(tok->t_owner == curthread && ref->tr_state == 1 &&
554                  tok->t_count > 0);
555
556         /* Token is not stale */
557         if (tok->t_lastowner == tok->t_owner)
558                 return (FALSE);
559
560         /*
561          * The token is stale. Reset to not stale so that the next call to
562          * lwkt_token_is_stale will return "not stale" unless the token
563          * was acquired in-between by another thread.
564          */
565         tok->t_lastowner = tok->t_owner;
566         return (TRUE);
567 }
568 #endif