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/spinlock.h>
  60
  61 #include <sys/thread2.h>
  62 #include <sys/spinlock2.h>
  63 #include <sys/mplock2.h>
  64
  65 #include <vm/vm.h>
  66 #include <vm/vm_param.h>
  67 #include <vm/vm_kern.h>
  68 #include <vm/vm_object.h>
  69 #include <vm/vm_page.h>
  70 #include <vm/vm_map.h>
  71 #include <vm/vm_pager.h>
  72 #include <vm/vm_extern.h>
  73 #include <vm/vm_zone.h>
  74
  75 #include <machine/stdarg.h>
  76 #include <machine/smp.h>
  77
  78 #include "opt_ddb.h"
  79 #ifdef DDB
  80 #include <ddb/ddb.h>
  81 #endif
  82
  83 extern int lwkt_sched_debug;
  84
  85 #ifndef LWKT_NUM_POOL_TOKENS
  86 #define LWKT_NUM_POOL_TOKENS    4001    /* prime number */
  87 #endif
  88
  89 struct lwkt_pool_token {
  90         struct lwkt_token       token;
  91 } __cachealign;
  92
  93 static struct lwkt_pool_token   pool_tokens[LWKT_NUM_POOL_TOKENS];
  94 struct spinlock         tok_debug_spin = SPINLOCK_INITIALIZER(&tok_debug_spin, "tok_debug_spin");
  95
  96 #define TOKEN_STRING    "REF=%p TOK=%p TD=%p"
  97 #define TOKEN_ARGS      lwkt_tokref_t ref, lwkt_token_t tok, struct thread *td
  98 #define CONTENDED_STRING        TOKEN_STRING " (contention started)"
  99 #define UNCONTENDED_STRING      TOKEN_STRING " (contention stopped)"
 100 #if !defined(KTR_TOKENS)
 101 #define KTR_TOKENS      KTR_ALL
 102 #endif
 103
 104 KTR_INFO_MASTER(tokens);
 105 KTR_INFO(KTR_TOKENS, tokens, fail, 0, TOKEN_STRING, TOKEN_ARGS);
 106 KTR_INFO(KTR_TOKENS, tokens, succ, 1, TOKEN_STRING, TOKEN_ARGS);
 107 #if 0
 108 KTR_INFO(KTR_TOKENS, tokens, release, 2, TOKEN_STRING, TOKEN_ARGS);
 109 KTR_INFO(KTR_TOKENS, tokens, remote, 3, TOKEN_STRING, TOKEN_ARGS);
 110 KTR_INFO(KTR_TOKENS, tokens, reqremote, 4, TOKEN_STRING, TOKEN_ARGS);
 111 KTR_INFO(KTR_TOKENS, tokens, reqfail, 5, TOKEN_STRING, TOKEN_ARGS);
 112 KTR_INFO(KTR_TOKENS, tokens, drain, 6, TOKEN_STRING, TOKEN_ARGS);
 113 KTR_INFO(KTR_TOKENS, tokens, contention_start, 7, CONTENDED_STRING, TOKEN_ARGS);
 114 KTR_INFO(KTR_TOKENS, tokens, contention_stop, 7, UNCONTENDED_STRING, TOKEN_ARGS);
 115 #endif
 116
 117 #define logtoken(name, ref)                                             \
 118         KTR_LOG(tokens_ ## name, ref, ref->tr_tok, curthread)
 119
 120 /*
 121  * Global tokens.  These replace the MP lock for major subsystem locking.
 122  * These tokens are initially used to lockup both global and individual
 123  * operations.
 124  *
 125  * Once individual structures get their own locks these tokens are used
 126  * only to protect global lists & other variables and to interlock
 127  * allocations and teardowns and such.
 128  *
 129  * The UP initializer causes token acquisition to also acquire the MP lock
 130  * for maximum compatibility.  The feature may be enabled and disabled at
 131  * any time, the MP state is copied to the tokref when the token is acquired
 132  * and will not race against sysctl changes.
 133  */
 134 struct lwkt_token mp_token = LWKT_TOKEN_INITIALIZER(mp_token);
 135 struct lwkt_token pmap_token = LWKT_TOKEN_INITIALIZER(pmap_token);
 136 struct lwkt_token dev_token = LWKT_TOKEN_INITIALIZER(dev_token);
 137 struct lwkt_token vm_token = LWKT_TOKEN_INITIALIZER(vm_token);
 138 struct lwkt_token vmspace_token = LWKT_TOKEN_INITIALIZER(vmspace_token);
 139 struct lwkt_token kvm_token = LWKT_TOKEN_INITIALIZER(kvm_token);
 140 struct lwkt_token sigio_token = LWKT_TOKEN_INITIALIZER(sigio_token);
 141 struct lwkt_token tty_token = LWKT_TOKEN_INITIALIZER(tty_token);
 142 struct lwkt_token vnode_token = LWKT_TOKEN_INITIALIZER(vnode_token);
 143
 144 static int lwkt_token_spin = 5;
 145 SYSCTL_INT(_lwkt, OID_AUTO, token_spin, CTLFLAG_RW,
 146     &lwkt_token_spin, 0, "Decontention spin loops");
 147
 148 /*
 149  * The collision count is bumped every time the LWKT scheduler fails
 150  * to acquire needed tokens in addition to a normal lwkt_gettoken()
 151  * stall.
 152  */
 153 SYSCTL_LONG(_lwkt, OID_AUTO, mp_collisions, CTLFLAG_RW,
 154     &mp_token.t_collisions, 0, "Collision counter of mp_token");
 155 SYSCTL_LONG(_lwkt, OID_AUTO, pmap_collisions, CTLFLAG_RW,
 156     &pmap_token.t_collisions, 0, "Collision counter of pmap_token");
 157 SYSCTL_LONG(_lwkt, OID_AUTO, dev_collisions, CTLFLAG_RW,
 158     &dev_token.t_collisions, 0, "Collision counter of dev_token");
 159 SYSCTL_LONG(_lwkt, OID_AUTO, vm_collisions, CTLFLAG_RW,
 160     &vm_token.t_collisions, 0, "Collision counter of vm_token");
 161 SYSCTL_LONG(_lwkt, OID_AUTO, vmspace_collisions, CTLFLAG_RW,
 162     &vmspace_token.t_collisions, 0, "Collision counter of vmspace_token");
 163 SYSCTL_LONG(_lwkt, OID_AUTO, kvm_collisions, CTLFLAG_RW,
 164     &kvm_token.t_collisions, 0, "Collision counter of kvm_token");
 165 SYSCTL_LONG(_lwkt, OID_AUTO, sigio_collisions, CTLFLAG_RW,
 166     &sigio_token.t_collisions, 0, "Collision counter of sigio_token");
 167 SYSCTL_LONG(_lwkt, OID_AUTO, tty_collisions, CTLFLAG_RW,
 168     &tty_token.t_collisions, 0, "Collision counter of tty_token");
 169 SYSCTL_LONG(_lwkt, OID_AUTO, vnode_collisions, CTLFLAG_RW,
 170     &vnode_token.t_collisions, 0, "Collision counter of vnode_token");
 171
 172 int tokens_debug_output;
 173 SYSCTL_INT(_lwkt, OID_AUTO, tokens_debug_output, CTLFLAG_RW,
 174     &tokens_debug_output, 0, "Generate stack trace N times");
 175
 176 static int _lwkt_getalltokens_sorted(thread_t td);
 177
 178 /*
 179  * Acquire the initial mplock
 180  *
 181  * (low level boot only)
 182  */
 183 void
 184 cpu_get_initial_mplock(void)
 185 {
 186         KKASSERT(mp_token.t_ref == NULL);
 187         if (lwkt_trytoken(&mp_token) == FALSE)
 188                 panic("cpu_get_initial_mplock");
 189 }
 190
 191 /*
 192  * Return a pool token given an address.  Use a prime number to reduce
 193  * overlaps.
 194  */
 195 static __inline
 196 lwkt_token_t
 197 _lwkt_token_pool_lookup(void *ptr)
 198 {
 199         u_int i;
 200
 201         i = (u_int)(uintptr_t)ptr % LWKT_NUM_POOL_TOKENS;
 202         return (&pool_tokens[i].token);
 203 }
 204
 205 /*
 206  * Initialize a tokref_t prior to making it visible in the thread's
 207  * token array.
 208  */
 209 static __inline
 210 void
 211 _lwkt_tokref_init(lwkt_tokref_t ref, lwkt_token_t tok, thread_t td, long excl)
 212 {
 213         ref->tr_tok = tok;
 214         ref->tr_count = excl;
 215         ref->tr_owner = td;
 216 }
 217
 218 /*
 219  * Attempt to acquire a shared or exclusive token.  Returns TRUE on success,
 220  * FALSE on failure.
 221  *
 222  * If TOK_EXCLUSIVE is set in mode we are attempting to get an exclusive
 223  * token, otherwise are attempting to get a shared token.
 224  *
 225  * If TOK_EXCLREQ is set in mode this is a blocking operation, otherwise
 226  * it is a non-blocking operation (for both exclusive or shared acquisions).
 227  */
 228 static __inline
 229 int
 230 _lwkt_trytokref(lwkt_tokref_t ref, thread_t td, long mode)
 231 {
 232         lwkt_token_t tok;
 233         lwkt_tokref_t oref;
 234         long count;
 235
 236         tok = ref->tr_tok;
 237         KASSERT(((mode & TOK_EXCLREQ) == 0 ||   /* non blocking */
 238                 td->td_gd->gd_intr_nesting_level == 0 ||
 239                 panic_cpu_gd == mycpu),
 240                 ("Attempt to acquire token %p not already "
 241                 "held in hard code section", tok));
 242
 243         if (mode & TOK_EXCLUSIVE) {
 244                 /*
 245                  * Attempt to get an exclusive token
 246                  */
 247                 count = tok->t_count;
 248
 249                 for (;;) {
 250                         oref = tok->t_ref;      /* can be NULL */
 251                         cpu_ccfence();
 252                         if ((count & ~TOK_EXCLREQ) == 0) {
 253                                 /*
 254                                  * It is possible to get the exclusive bit.
 255                                  * We must clear TOK_EXCLREQ on successful
 256                                  * acquisition.
 257                                  */
 258                                 if (atomic_fcmpset_long(&tok->t_count, &count,
 259                                                         (count & ~TOK_EXCLREQ) |
 260                                                         TOK_EXCLUSIVE)) {
 261                                         KKASSERT(tok->t_ref == NULL);
 262                                         tok->t_ref = ref;
 263                                         return TRUE;
 264                                 }
 265                                 /* retry */
 266                         } else if ((count & TOK_EXCLUSIVE) &&
 267                                    oref >= &td->td_toks_base &&
 268                                    oref < td->td_toks_stop) {
 269                                 /*
 270                                  * Our thread already holds the exclusive
 271                                  * bit, we treat this tokref as a shared
 272                                  * token (sorta) to make the token release
 273                                  * code easier.  Treating this as a shared
 274                                  * token allows us to simply increment the
 275                                  * count field.
 276                                  *
 277                                  * NOTE: oref cannot race above if it
 278                                  *       happens to be ours, so we're good.
 279                                  *       But we must still have a stable
 280                                  *       variable for both parts of the
 281                                  *       comparison.
 282                                  *
 283                                  * NOTE: Since we already have an exclusive
 284                                  *       lock and don't need to check EXCLREQ
 285                                  *       we can just use an atomic_add here
 286                                  */
 287                                 atomic_add_long(&tok->t_count, TOK_INCR);
 288                                 ref->tr_count &= ~TOK_EXCLUSIVE;
 289                                 return TRUE;
 290                         } else if ((mode & TOK_EXCLREQ) &&
 291                                    (count & TOK_EXCLREQ) == 0) {
 292                                 /*
 293                                  * Unable to get the exclusive bit but being
 294                                  * asked to set the exclusive-request bit.
 295                                  * Since we are going to retry anyway just
 296                                  * set the bit unconditionally.
 297                                  */
 298                                 atomic_set_long(&tok->t_count, TOK_EXCLREQ);
 299                                 return FALSE;
 300                         } else {
 301                                 /*
 302                                  * Unable to get the exclusive bit and not
 303                                  * being asked to set the exclusive-request
 304                                  * (aka lwkt_trytoken()), or EXCLREQ was
 305                                  * already set.
 306                                  */
 307                                 cpu_pause();
 308                                 return FALSE;
 309                         }
 310                         /* retry */
 311                 }
 312         } else {
 313                 /*
 314                  * Attempt to get a shared token.  Note that TOK_EXCLREQ
 315                  * for shared tokens simply means the caller intends to
 316                  * block.  We never actually set the bit in tok->t_count.
 317                  *
 318                  * Due to the token's no-deadlock guarantee, and complications
 319                  * created by the sorted reacquisition code, we can only
 320                  * give exclusive requests priority over shared requests
 321                  * in situations where the thread holds only one token.
 322                  */
 323                 count = tok->t_count;
 324
 325                 for (;;) {
 326                         oref = tok->t_ref;      /* can be NULL */
 327                         cpu_ccfence();
 328                         if ((count & (TOK_EXCLUSIVE|TOK_EXCLREQ)) == 0 ||
 329                             ((count & TOK_EXCLUSIVE) == 0 &&
 330                             td->td_toks_stop != &td->td_toks_base + 1)
 331                         ) {
 332                                 /*
 333                                  * It may be possible to get the token shared.
 334                                  */
 335                                 if ((atomic_fetchadd_long(&tok->t_count, TOK_INCR) & TOK_EXCLUSIVE) == 0) {
 336                                         return TRUE;
 337                                 }
 338                                 count = atomic_fetchadd_long(&tok->t_count,
 339                                                              -TOK_INCR);
 340                                 count -= TOK_INCR;
 341                                 /* retry */
 342                         } else if ((count & TOK_EXCLUSIVE) &&
 343                                    oref >= &td->td_toks_base &&
 344                                    oref < td->td_toks_stop) {
 345                                 /*
 346                                  * We own the exclusive bit on the token so
 347                                  * we can in fact also get it shared.
 348                                  */
 349                                 atomic_add_long(&tok->t_count, TOK_INCR);
 350                                 return TRUE;
 351                         } else {
 352                                 /*
 353                                  * We failed to get the token shared
 354                                  */
 355                                 return FALSE;
 356                         }
 357                         /* retry */
 358                 }
 359         }
 360 }
 361
 362 static __inline
 363 int
 364 _lwkt_trytokref_spin(lwkt_tokref_t ref, thread_t td, long mode)
 365 {
 366         int spin;
 367
 368         if (_lwkt_trytokref(ref, td, mode))
 369                 return TRUE;
 370         for (spin = lwkt_token_spin; spin > 0; --spin) {
 371                 cpu_pause();
 372                 cpu_pause();
 373                 if (_lwkt_trytokref(ref, td, mode))
 374                         return TRUE;
 375         }
 376         return FALSE;
 377 }
 378
 379 /*
 380  * Release a token that we hold.
 381  */
 382 static __inline
 383 void
 384 _lwkt_reltokref(lwkt_tokref_t ref, thread_t td)
 385 {
 386         lwkt_token_t tok;
 387         long count;
 388
 389         tok = ref->tr_tok;
 390         count = tok->t_count;
 391
 392         for (;;) {
 393                 cpu_ccfence();
 394                 if (tok->t_ref == ref) {
 395                         /*
 396                          * We are an exclusive holder.  We must clear tr_ref
 397                          * before we clear the TOK_EXCLUSIVE bit.  If we are
 398                          * unable to clear the bit we must restore
 399                          * tok->t_ref.
 400                          */
 401                         KKASSERT(count & TOK_EXCLUSIVE);
 402                         tok->t_ref = NULL;
 403                         if (atomic_fcmpset_long(&tok->t_count, &count,
 404                                                 count & ~TOK_EXCLUSIVE)) {
 405                                 return;
 406                         }
 407                         tok->t_ref = ref;
 408                         /* retry */
 409                 } else {
 410                         /*
 411                          * We are a shared holder
 412                          */
 413                         KKASSERT(count & TOK_COUNTMASK);
 414                         if (atomic_fcmpset_long(&tok->t_count, &count,
 415                                                 count - TOK_INCR)) {
 416                                 return;
 417                         }
 418                         /* retry */
 419                 }
 420                 /* retry */
 421         }
 422 }
 423
 424 /*
 425  * Obtain all the tokens required by the specified thread on the current
 426  * cpu, return 0 on failure and non-zero on success.  If a failure occurs
 427  * any partially acquired tokens will be released prior to return.
 428  *
 429  * lwkt_getalltokens is called by the LWKT scheduler to re-acquire all
 430  * tokens that the thread had to release when it switched away.
 431  *
 432  * If spinning is non-zero this function acquires the tokens in a particular
 433  * order to deal with potential deadlocks.  We simply use address order for
 434  * the case.
 435  *
 436  * Called from a critical section.
 437  */
 438 int
 439 lwkt_getalltokens(thread_t td, int spinning)
 440 {
 441         lwkt_tokref_t scan;
 442         lwkt_token_t tok;
 443
 444         if (spinning)
 445                 return(_lwkt_getalltokens_sorted(td));
 446
 447         /*
 448          * Acquire tokens in forward order, assign or validate tok->t_ref.
 449          */
 450         for (scan = &td->td_toks_base; scan < td->td_toks_stop; ++scan) {
 451                 tok = scan->tr_tok;
 452                 for (;;) {
 453                         /*
 454                          * Only try really hard on the last token
 455                          */
 456                         if (scan == td->td_toks_stop - 1) {
 457                             if (_lwkt_trytokref_spin(scan, td, scan->tr_count))
 458                                     break;
 459                         } else {
 460                             if (_lwkt_trytokref(scan, td, scan->tr_count))
 461                                     break;
 462                         }
 463
 464                         /*
 465                          * Otherwise we failed to acquire all the tokens.
 466                          * Release whatever we did get.
 467                          */
 468                         KASSERT(tok->t_desc,
 469                                 ("token %p is not initialized", tok));
 470                         td->td_gd->gd_cnt.v_lock_name[0] = 't';
 471                         strncpy(td->td_gd->gd_cnt.v_lock_name + 1,
 472                                 tok->t_desc,
 473                                 sizeof(td->td_gd->gd_cnt.v_lock_name) - 2);
 474                         if (lwkt_sched_debug > 0) {
 475                                 --lwkt_sched_debug;
 476                                 kprintf("toka %p %s %s\n",
 477                                         tok, tok->t_desc, td->td_comm);
 478                         }
 479                         td->td_wmesg = tok->t_desc;
 480                         ++tok->t_collisions;
 481                         while (--scan >= &td->td_toks_base)
 482                                 _lwkt_reltokref(scan, td);
 483                         return(FALSE);
 484                 }
 485         }
 486         return (TRUE);
 487 }
 488
 489 /*
 490  * Release all tokens owned by the specified thread on the current cpu.
 491  *
 492  * This code is really simple.  Even in cases where we own all the tokens
 493  * note that t_ref may not match the scan for recursively held tokens which
 494  * are held deeper in the stack, or for the case where a lwkt_getalltokens()
 495  * failed.
 496  *
 497  * Tokens are released in reverse order to reduce chasing race failures.
 498  *
 499  * Called from a critical section.
 500  */
 501 void
 502 lwkt_relalltokens(thread_t td)
 503 {
 504         lwkt_tokref_t scan;
 505
 506         /*
 507          * Weird order is to try to avoid a panic loop
 508          */
 509         if (td->td_toks_have) {
 510                 scan = td->td_toks_have;
 511                 td->td_toks_have = NULL;
 512         } else {
 513                 scan = td->td_toks_stop;
 514         }
 515         while (--scan >= &td->td_toks_base)
 516                 _lwkt_reltokref(scan, td);
 517 }
 518
 519 /*
 520  * This is the decontention version of lwkt_getalltokens().  The tokens are
 521  * acquired in address-sorted order to deal with any deadlocks.  Ultimately
 522  * token failures will spin into the scheduler and get here.
 523  *
 524  * Called from critical section
 525  */
 526 static
 527 int
 528 _lwkt_getalltokens_sorted(thread_t td)
 529 {
 530         lwkt_tokref_t sort_array[LWKT_MAXTOKENS];
 531         lwkt_tokref_t scan;
 532         lwkt_token_t tok;
 533         int i;
 534         int j;
 535         int n;
 536
 537         /*
 538          * Sort the token array.  Yah yah, I know this isn't fun.
 539          *
 540          * NOTE: Recursively acquired tokens are ordered the same as in the
 541          *       td_toks_array so we can always get the earliest one first.
 542          *       This is particularly important when a token is acquired
 543          *       exclusively multiple times, as only the first acquisition
 544          *       is treated as an exclusive token.
 545          */
 546         i = 0;
 547         scan = &td->td_toks_base;
 548         while (scan < td->td_toks_stop) {
 549                 for (j = 0; j < i; ++j) {
 550                         if (scan->tr_tok < sort_array[j]->tr_tok)
 551                                 break;
 552                 }
 553                 if (j != i) {
 554                         bcopy(sort_array + j, sort_array + j + 1,
 555                               (i - j) * sizeof(lwkt_tokref_t));
 556                 }
 557                 sort_array[j] = scan;
 558                 ++scan;
 559                 ++i;
 560         }
 561         n = i;
 562
 563         /*
 564          * Acquire tokens in forward order, assign or validate tok->t_ref.
 565          */
 566         for (i = 0; i < n; ++i) {
 567                 scan = sort_array[i];
 568                 tok = scan->tr_tok;
 569                 for (;;) {
 570                         /*
 571                          * Only try really hard on the last token
 572                          */
 573                         if (scan == td->td_toks_stop - 1) {
 574                             if (_lwkt_trytokref_spin(scan, td, scan->tr_count))
 575                                     break;
 576                         } else {
 577                             if (_lwkt_trytokref(scan, td, scan->tr_count))
 578                                     break;
 579                         }
 580
 581                         /*
 582                          * Otherwise we failed to acquire all the tokens.
 583                          * Release whatever we did get.
 584                          */
 585                         td->td_gd->gd_cnt.v_lock_name[0] = 't';
 586                         strncpy(td->td_gd->gd_cnt.v_lock_name + 1,
 587                                 tok->t_desc,
 588                                 sizeof(td->td_gd->gd_cnt.v_lock_name) - 2);
 589                         if (lwkt_sched_debug > 0) {
 590                                 --lwkt_sched_debug;
 591                                 kprintf("tokb %p %s %s\n",
 592                                         tok, tok->t_desc, td->td_comm);
 593                         }
 594                         td->td_wmesg = tok->t_desc;
 595                         ++tok->t_collisions;
 596                         while (--i >= 0) {
 597                                 scan = sort_array[i];
 598                                 _lwkt_reltokref(scan, td);
 599                         }
 600                         return(FALSE);
 601                 }
 602         }
 603
 604         /*
 605          * We were successful, there is no need for another core to signal
 606          * us.
 607          */
 608         return (TRUE);
 609 }
 610
 611 /*
 612  * Get a serializing token.  This routine can block.
 613  */
 614 void
 615 lwkt_gettoken(lwkt_token_t tok)
 616 {
 617         thread_t td = curthread;
 618         lwkt_tokref_t ref;
 619
 620         ref = td->td_toks_stop;
 621         KKASSERT(ref < &td->td_toks_end);
 622         ++td->td_toks_stop;
 623         cpu_ccfence();
 624         _lwkt_tokref_init(ref, tok, td, TOK_EXCLUSIVE|TOK_EXCLREQ);
 625
 626 #ifdef DEBUG_LOCKS
 627         /*
 628          * Taking an exclusive token after holding it shared will
 629          * livelock. Scan for that case and assert.
 630          */
 631         lwkt_tokref_t tk;
 632         int found = 0;
 633         for (tk = &td->td_toks_base; tk < ref; tk++) {
 634                 if (tk->tr_tok != tok)
 635                         continue;
 636
 637                 found++;
 638                 if (tk->tr_count & TOK_EXCLUSIVE)
 639                         goto good;
 640         }
 641         /* We found only shared instances of this token if found >0 here */
 642         KASSERT((found == 0), ("Token %p s/x livelock", tok));
 643 good:
 644 #endif
 645
 646         if (_lwkt_trytokref_spin(ref, td, TOK_EXCLUSIVE|TOK_EXCLREQ))
 647                 return;
 648
 649         /*
 650          * Give up running if we can't acquire the token right now.
 651          *
 652          * Since the tokref is already active the scheduler now
 653          * takes care of acquisition, so we need only call
 654          * lwkt_switch().
 655          *
 656          * Since we failed this was not a recursive token so upon
 657          * return tr_tok->t_ref should be assigned to this specific
 658          * ref.
 659          */
 660         td->td_wmesg = tok->t_desc;
 661         ++tok->t_collisions;
 662         logtoken(fail, ref);
 663         td->td_toks_have = td->td_toks_stop - 1;
 664
 665         if (tokens_debug_output > 0) {
 666                 --tokens_debug_output;
 667                 spin_lock(&tok_debug_spin);
 668                 kprintf("Excl Token thread %p %s %s\n",
 669                         td, tok->t_desc, td->td_comm);
 670                 print_backtrace(6);
 671                 kprintf("\n");
 672                 spin_unlock(&tok_debug_spin);
 673         }
 674
 675         lwkt_switch();
 676         logtoken(succ, ref);
 677         KKASSERT(tok->t_ref == ref);
 678 }
 679
 680 /*
 681  * Similar to gettoken but we acquire a shared token instead of an exclusive
 682  * token.
 683  */
 684 void
 685 lwkt_gettoken_shared(lwkt_token_t tok)
 686 {
 687         thread_t td = curthread;
 688         lwkt_tokref_t ref;
 689
 690         ref = td->td_toks_stop;
 691         KKASSERT(ref < &td->td_toks_end);
 692         ++td->td_toks_stop;
 693         cpu_ccfence();
 694         _lwkt_tokref_init(ref, tok, td, TOK_EXCLREQ);
 695
 696 #ifdef DEBUG_LOCKS
 697         /*
 698          * Taking a pool token in shared mode is a bad idea; other
 699          * addresses deeper in the call stack may hash to the same pool
 700          * token and you may end up with an exclusive-shared livelock.
 701          * Warn in this condition.
 702          */
 703         if ((tok >= &pool_tokens[0].token) &&
 704             (tok < &pool_tokens[LWKT_NUM_POOL_TOKENS].token))
 705                 kprintf("Warning! Taking pool token %p in shared mode\n", tok);
 706 #endif
 707
 708
 709         if (_lwkt_trytokref_spin(ref, td, TOK_EXCLREQ))
 710                 return;
 711
 712         /*
 713          * Give up running if we can't acquire the token right now.
 714          *
 715          * Since the tokref is already active the scheduler now
 716          * takes care of acquisition, so we need only call
 717          * lwkt_switch().
 718          *
 719          * Since we failed this was not a recursive token so upon
 720          * return tr_tok->t_ref should be assigned to this specific
 721          * ref.
 722          */
 723         td->td_wmesg = tok->t_desc;
 724         ++tok->t_collisions;
 725         logtoken(fail, ref);
 726         td->td_toks_have = td->td_toks_stop - 1;
 727
 728         if (tokens_debug_output > 0) {
 729                 --tokens_debug_output;
 730                 spin_lock(&tok_debug_spin);
 731                 kprintf("Shar Token thread %p %s %s\n",
 732                         td, tok->t_desc, td->td_comm);
 733                 print_backtrace(6);
 734                 kprintf("\n");
 735                 spin_unlock(&tok_debug_spin);
 736         }
 737
 738         lwkt_switch();
 739         logtoken(succ, ref);
 740 }
 741
 742 /*
 743  * Attempt to acquire a token, return TRUE on success, FALSE on failure.
 744  *
 745  * We setup the tokref in case we actually get the token (if we switch later
 746  * it becomes mandatory so we set TOK_EXCLREQ), but we call trytokref without
 747  * TOK_EXCLREQ in case we fail.
 748  */
 749 int
 750 lwkt_trytoken(lwkt_token_t tok)
 751 {
 752         thread_t td = curthread;
 753         lwkt_tokref_t ref;
 754
 755         ref = td->td_toks_stop;
 756         KKASSERT(ref < &td->td_toks_end);
 757         ++td->td_toks_stop;
 758         cpu_ccfence();
 759         _lwkt_tokref_init(ref, tok, td, TOK_EXCLUSIVE|TOK_EXCLREQ);
 760
 761         if (_lwkt_trytokref(ref, td, TOK_EXCLUSIVE))
 762                 return TRUE;
 763
 764         /*
 765          * Failed, unpend the request
 766          */
 767         cpu_ccfence();
 768         --td->td_toks_stop;
 769         ++tok->t_collisions;
 770         return FALSE;
 771 }
 772
 773 lwkt_token_t
 774 lwkt_getpooltoken(void *ptr)
 775 {
 776         lwkt_token_t tok;
 777
 778         tok = _lwkt_token_pool_lookup(ptr);
 779         lwkt_gettoken(tok);
 780         return (tok);
 781 }
 782
 783 /*
 784  * Release a serializing token.
 785  *
 786  * WARNING!  All tokens must be released in reverse order.  This will be
 787  *           asserted.
 788  */
 789 void
 790 lwkt_reltoken(lwkt_token_t tok)
 791 {
 792         thread_t td = curthread;
 793         lwkt_tokref_t ref;
 794
 795         /*
 796          * Remove ref from thread token list and assert that it matches
 797          * the token passed in.  Tokens must be released in reverse order.
 798          */
 799         ref = td->td_toks_stop - 1;
 800         KKASSERT(ref >= &td->td_toks_base && ref->tr_tok == tok);
 801         _lwkt_reltokref(ref, td);
 802         cpu_sfence();
 803         td->td_toks_stop = ref;
 804 }
 805
 806 /*
 807  * It is faster for users of lwkt_getpooltoken() to use the returned
 808  * token and just call lwkt_reltoken(), but for convenience we provide
 809  * this function which looks the token up based on the ident.
 810  */
 811 void
 812 lwkt_relpooltoken(void *ptr)
 813 {
 814         lwkt_token_t tok = _lwkt_token_pool_lookup(ptr);
 815         lwkt_reltoken(tok);
 816 }
 817
 818 /*
 819  * Return a count of the number of token refs the thread has to the
 820  * specified token, whether it currently owns the token or not.
 821  */
 822 int
 823 lwkt_cnttoken(lwkt_token_t tok, thread_t td)
 824 {
 825         lwkt_tokref_t scan;
 826         int count = 0;
 827
 828         for (scan = &td->td_toks_base; scan < td->td_toks_stop; ++scan) {
 829                 if (scan->tr_tok == tok)
 830                         ++count;
 831         }
 832         return(count);
 833 }
 834
 835 /*
 836  * Pool tokens are used to provide a type-stable serializing token
 837  * pointer that does not race against disappearing data structures.
 838  *
 839  * This routine is called in early boot just after we setup the BSP's
 840  * globaldata structure.
 841  */
 842 void
 843 lwkt_token_pool_init(void)
 844 {
 845         int i;
 846
 847         for (i = 0; i < LWKT_NUM_POOL_TOKENS; ++i)
 848                 lwkt_token_init(&pool_tokens[i].token, "pool");
 849 }
 850
 851 lwkt_token_t
 852 lwkt_token_pool_lookup(void *ptr)
 853 {
 854         return (_lwkt_token_pool_lookup(ptr));
 855 }
 856
 857 /*
 858  * Initialize a token.
 859  */
 860 void
 861 lwkt_token_init(lwkt_token_t tok, const char *desc)
 862 {
 863         tok->t_count = 0;
 864         tok->t_ref = NULL;
 865         tok->t_collisions = 0;
 866         tok->t_desc = desc;
 867 }
 868
 869 void
 870 lwkt_token_uninit(lwkt_token_t tok)
 871 {
 872         /* empty */
 873 }
 874
 875 /*
 876  * Exchange the two most recent tokens on the tokref stack.  This allows
 877  * you to release a token out of order.
 878  *
 879  * We have to be careful about the case where the top two tokens are
 880  * the same token.  In this case tok->t_ref will point to the deeper
 881  * ref and must remain pointing to the deeper ref.  If we were to swap
 882  * it the first release would clear the token even though a second
 883  * ref is still present.
 884  *
 885  * Only exclusively held tokens contain a reference to the tokref which
 886  * has to be flipped along with the swap.
 887  */
 888 void
 889 lwkt_token_swap(void)
 890 {
 891         lwkt_tokref_t ref1, ref2;
 892         lwkt_token_t tok1, tok2;
 893         long count1, count2;
 894         thread_t td = curthread;
 895
 896         crit_enter();
 897
 898         ref1 = td->td_toks_stop - 1;
 899         ref2 = td->td_toks_stop - 2;
 900         KKASSERT(ref1 >= &td->td_toks_base);
 901         KKASSERT(ref2 >= &td->td_toks_base);
 902
 903         tok1 = ref1->tr_tok;
 904         tok2 = ref2->tr_tok;
 905         count1 = ref1->tr_count;
 906         count2 = ref2->tr_count;
 907
 908         if (tok1 != tok2) {
 909                 ref1->tr_tok = tok2;
 910                 ref1->tr_count = count2;
 911                 ref2->tr_tok = tok1;
 912                 ref2->tr_count = count1;
 913                 if (tok1->t_ref == ref1)
 914                         tok1->t_ref = ref2;
 915                 if (tok2->t_ref == ref2)
 916                         tok2->t_ref = ref1;
 917         }
 918
 919         crit_exit();
 920 }
 921
 922 #ifdef DDB
 923 DB_SHOW_COMMAND(tokens, db_tok_all)
 924 {
 925         struct lwkt_token *tok, **ptr;
 926         struct lwkt_token *toklist[16] = {
 927                 &mp_token,
 928                 &pmap_token,
 929                 &dev_token,
 930                 &vm_token,
 931                 &vmspace_token,
 932                 &kvm_token,
 933                 &sigio_token,
 934                 &tty_token,
 935                 &vnode_token,
 936                 NULL
 937         };
 938
 939         ptr = toklist;
 940         for (tok = *ptr; tok; tok = *(++ptr)) {
 941                 db_printf("tok=%p tr_owner=%p t_colissions=%ld t_desc=%s\n", tok,
 942                     (tok->t_ref ? tok->t_ref->tr_owner : NULL),
 943                     tok->t_collisions, tok->t_desc);
 944         }
 945 }
 946 #endif /* DDB */