sys/kern/kern_synch.c

   1 /*-
   2  * Copyright (c) 1982, 1986, 1990, 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)kern_synch.c        8.9 (Berkeley) 5/19/95
  39  * $FreeBSD: src/sys/kern/kern_synch.c,v 1.87.2.6 2002/10/13 07:29:53 kbyanc Exp $
  40  * $DragonFly: src/sys/kern/kern_synch.c,v 1.91 2008/09/09 04:06:13 dillon Exp $
  41  */
  42
  43 #include "opt_ktrace.h"
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/proc.h>
  48 #include <sys/kernel.h>
  49 #include <sys/signalvar.h>
  50 #include <sys/resourcevar.h>
  51 #include <sys/vmmeter.h>
  52 #include <sys/sysctl.h>
  53 #include <sys/lock.h>
  54 #include <sys/uio.h>
  55 #ifdef KTRACE
  56 #include <sys/ktrace.h>
  57 #endif
  58 #include <sys/xwait.h>
  59 #include <sys/ktr.h>
  60 #include <sys/serialize.h>
  61
  62 #include <sys/signal2.h>
  63 #include <sys/thread2.h>
  64 #include <sys/spinlock2.h>
  65 #include <sys/mutex2.h>
  66
  67 #include <machine/cpu.h>
  68 #include <machine/smp.h>
  69
  70 TAILQ_HEAD(tslpque, thread);
  71
  72 static void sched_setup (void *dummy);
  73 SYSINIT(sched_setup, SI_SUB_KICK_SCHEDULER, SI_ORDER_FIRST, sched_setup, NULL)
  74
  75 int     hogticks;
  76 int     lbolt;
  77 void    *lbolt_syncer;
  78 int     sched_quantum;          /* Roundrobin scheduling quantum in ticks. */
  79 int     ncpus;
  80 int     ncpus2, ncpus2_shift, ncpus2_mask;      /* note: mask not cpumask_t */
  81 int     ncpus_fit, ncpus_fit_mask;              /* note: mask not cpumask_t */
  82 int     safepri;
  83 int     tsleep_now_works;
  84 int     tsleep_crypto_dump = 0;
  85
  86 static struct callout loadav_callout;
  87 static struct callout schedcpu_callout;
  88 MALLOC_DEFINE(M_TSLEEP, "tslpque", "tsleep queues");
  89
  90 #define __DEALL(ident)  __DEQUALIFY(void *, ident)
  91
  92 #if !defined(KTR_TSLEEP)
  93 #define KTR_TSLEEP      KTR_ALL
  94 #endif
  95 KTR_INFO_MASTER(tsleep);
  96 KTR_INFO(KTR_TSLEEP, tsleep, tsleep_beg, 0, "tsleep enter %p", const volatile void *ident);
  97 KTR_INFO(KTR_TSLEEP, tsleep, tsleep_end, 1, "tsleep exit");
  98 KTR_INFO(KTR_TSLEEP, tsleep, wakeup_beg, 2, "wakeup enter %p", const volatile void *ident);
  99 KTR_INFO(KTR_TSLEEP, tsleep, wakeup_end, 3, "wakeup exit");
 100 KTR_INFO(KTR_TSLEEP, tsleep, ilockfail,  4, "interlock failed %p", const volatile void *ident);
 101
 102 #define logtsleep1(name)        KTR_LOG(tsleep_ ## name)
 103 #define logtsleep2(name, val)   KTR_LOG(tsleep_ ## name, val)
 104
 105 struct loadavg averunnable =
 106         { {0, 0, 0}, FSCALE };  /* load average, of runnable procs */
 107 /*
 108  * Constants for averages over 1, 5, and 15 minutes
 109  * when sampling at 5 second intervals.
 110  */
 111 static fixpt_t cexp[3] = {
 112         0.9200444146293232 * FSCALE,    /* exp(-1/12) */
 113         0.9834714538216174 * FSCALE,    /* exp(-1/60) */
 114         0.9944598480048967 * FSCALE,    /* exp(-1/180) */
 115 };
 116
 117 static void     endtsleep (void *);
 118 static void     loadav (void *arg);
 119 static void     schedcpu (void *arg);
 120
 121 /*
 122  * Adjust the scheduler quantum.  The quantum is specified in microseconds.
 123  * Note that 'tick' is in microseconds per tick.
 124  */
 125 static int
 126 sysctl_kern_quantum(SYSCTL_HANDLER_ARGS)
 127 {
 128         int error, new_val;
 129
 130         new_val = sched_quantum * ustick;
 131         error = sysctl_handle_int(oidp, &new_val, 0, req);
 132         if (error != 0 || req->newptr == NULL)
 133                 return (error);
 134         if (new_val < ustick)
 135                 return (EINVAL);
 136         sched_quantum = new_val / ustick;
 137         hogticks = 2 * sched_quantum;
 138         return (0);
 139 }
 140
 141 SYSCTL_PROC(_kern, OID_AUTO, quantum, CTLTYPE_INT|CTLFLAG_RW,
 142         0, sizeof sched_quantum, sysctl_kern_quantum, "I", "");
 143
 144 /*
 145  * If `ccpu' is not equal to `exp(-1/20)' and you still want to use the
 146  * faster/more-accurate formula, you'll have to estimate CCPU_SHIFT below
 147  * and possibly adjust FSHIFT in "param.h" so that (FSHIFT >= CCPU_SHIFT).
 148  *
 149  * To estimate CCPU_SHIFT for exp(-1/20), the following formula was used:
 150  *     1 - exp(-1/20) ~= 0.0487 ~= 0.0488 == 1 (fixed pt, *11* bits).
 151  *
 152  * If you don't want to bother with the faster/more-accurate formula, you
 153  * can set CCPU_SHIFT to (FSHIFT + 1) which will use a slower/less-accurate
 154  * (more general) method of calculating the %age of CPU used by a process.
 155  *
 156  * decay 95% of `lwp_pctcpu' in 60 seconds; see CCPU_SHIFT before changing
 157  */
 158 #define CCPU_SHIFT      11
 159
 160 static fixpt_t ccpu = 0.95122942450071400909 * FSCALE; /* exp(-1/20) */
 161 SYSCTL_INT(_kern, OID_AUTO, ccpu, CTLFLAG_RD, &ccpu, 0, "");
 162
 163 /*
 164  * kernel uses `FSCALE', userland (SHOULD) use kern.fscale
 165  */
 166 int     fscale __unused = FSCALE;       /* exported to systat */
 167 SYSCTL_INT(_kern, OID_AUTO, fscale, CTLFLAG_RD, 0, FSCALE, "");
 168
 169 /*
 170  * Recompute process priorities, once a second.
 171  *
 172  * Since the userland schedulers are typically event oriented, if the
 173  * estcpu calculation at wakeup() time is not sufficient to make a
 174  * process runnable relative to other processes in the system we have
 175  * a 1-second recalc to help out.
 176  *
 177  * This code also allows us to store sysclock_t data in the process structure
 178  * without fear of an overrun, since sysclock_t are guarenteed to hold
 179  * several seconds worth of count.
 180  *
 181  * WARNING!  callouts can preempt normal threads.  However, they will not
 182  * preempt a thread holding a spinlock so we *can* safely use spinlocks.
 183  */
 184 static int schedcpu_stats(struct proc *p, void *data __unused);
 185 static int schedcpu_resource(struct proc *p, void *data __unused);
 186
 187 static void
 188 schedcpu(void *arg)
 189 {
 190         allproc_scan(schedcpu_stats, NULL);
 191         allproc_scan(schedcpu_resource, NULL);
 192         wakeup((caddr_t)&lbolt);
 193         wakeup(lbolt_syncer);
 194         callout_reset(&schedcpu_callout, hz, schedcpu, NULL);
 195 }
 196
 197 /*
 198  * General process statistics once a second
 199  */
 200 static int
 201 schedcpu_stats(struct proc *p, void *data __unused)
 202 {
 203         struct lwp *lp;
 204
 205         /*
 206          * Threads may not be completely set up if process in SIDL state.
 207          */
 208         if (p->p_stat == SIDL)
 209                 return(0);
 210
 211         PHOLD(p);
 212         if (lwkt_trytoken(&p->p_token) == FALSE) {
 213                 PRELE(p);
 214                 return(0);
 215         }
 216
 217         p->p_swtime++;
 218         FOREACH_LWP_IN_PROC(lp, p) {
 219                 if (lp->lwp_stat == LSSLEEP) {
 220                         ++lp->lwp_slptime;
 221                         if (lp->lwp_slptime == 1)
 222                                 p->p_usched->uload_update(lp);
 223                 }
 224
 225                 /*
 226                  * Only recalculate processes that are active or have slept
 227                  * less then 2 seconds.  The schedulers understand this.
 228                  */
 229                 if (lp->lwp_slptime <= 1) {
 230                         p->p_usched->recalculate(lp);
 231                 } else {
 232                         lp->lwp_pctcpu = (lp->lwp_pctcpu * ccpu) >> FSHIFT;
 233                 }
 234         }
 235         lwkt_reltoken(&p->p_token);
 236         lwkt_yield();
 237         PRELE(p);
 238         return(0);
 239 }
 240
 241 /*
 242  * Resource checks.  XXX break out since ksignal/killproc can block,
 243  * limiting us to one process killed per second.  There is probably
 244  * a better way.
 245  */
 246 static int
 247 schedcpu_resource(struct proc *p, void *data __unused)
 248 {
 249         u_int64_t ttime;
 250         struct lwp *lp;
 251
 252         if (p->p_stat == SIDL)
 253                 return(0);
 254
 255         PHOLD(p);
 256         if (lwkt_trytoken(&p->p_token) == FALSE) {
 257                 PRELE(p);
 258                 return(0);
 259         }
 260
 261         if (p->p_stat == SZOMB || p->p_limit == NULL) {
 262                 lwkt_reltoken(&p->p_token);
 263                 PRELE(p);
 264                 return(0);
 265         }
 266
 267         ttime = 0;
 268         FOREACH_LWP_IN_PROC(lp, p) {
 269                 /*
 270                  * We may have caught an lp in the middle of being
 271                  * created, lwp_thread can be NULL.
 272                  */
 273                 if (lp->lwp_thread) {
 274                         ttime += lp->lwp_thread->td_sticks;
 275                         ttime += lp->lwp_thread->td_uticks;
 276                 }
 277         }
 278
 279         switch(plimit_testcpulimit(p->p_limit, ttime)) {
 280         case PLIMIT_TESTCPU_KILL:
 281                 killproc(p, "exceeded maximum CPU limit");
 282                 break;
 283         case PLIMIT_TESTCPU_XCPU:
 284                 if ((p->p_flags & P_XCPU) == 0) {
 285                         p->p_flags |= P_XCPU;
 286                         ksignal(p, SIGXCPU);
 287                 }
 288                 break;
 289         default:
 290                 break;
 291         }
 292         lwkt_reltoken(&p->p_token);
 293         lwkt_yield();
 294         PRELE(p);
 295         return(0);
 296 }
 297
 298 /*
 299  * This is only used by ps.  Generate a cpu percentage use over
 300  * a period of one second.
 301  *
 302  * MPSAFE
 303  */
 304 void
 305 updatepcpu(struct lwp *lp, int cpticks, int ttlticks)
 306 {
 307         fixpt_t acc;
 308         int remticks;
 309
 310         acc = (cpticks << FSHIFT) / ttlticks;
 311         if (ttlticks >= ESTCPUFREQ) {
 312                 lp->lwp_pctcpu = acc;
 313         } else {
 314                 remticks = ESTCPUFREQ - ttlticks;
 315                 lp->lwp_pctcpu = (acc * ttlticks + lp->lwp_pctcpu * remticks) /
 316                                 ESTCPUFREQ;
 317         }
 318 }
 319
 320 /*
 321  * tsleep/wakeup hash table parameters.  Try to find the sweet spot for
 322  * like addresses being slept on.
 323  */
 324 #define TABLESIZE       4001
 325 #define LOOKUP(x)       (((u_int)(uintptr_t)(x)) % TABLESIZE)
 326
 327 static cpumask_t slpque_cpumasks[TABLESIZE];
 328
 329 /*
 330  * General scheduler initialization.  We force a reschedule 25 times
 331  * a second by default.  Note that cpu0 is initialized in early boot and
 332  * cannot make any high level calls.
 333  *
 334  * Each cpu has its own sleep queue.
 335  */
 336 void
 337 sleep_gdinit(globaldata_t gd)
 338 {
 339         static struct tslpque slpque_cpu0[TABLESIZE];
 340         int i;
 341
 342         if (gd->gd_cpuid == 0) {
 343                 sched_quantum = (hz + 24) / 25;
 344                 hogticks = 2 * sched_quantum;
 345
 346                 gd->gd_tsleep_hash = slpque_cpu0;
 347         } else {
 348                 gd->gd_tsleep_hash = kmalloc(sizeof(slpque_cpu0),
 349                                             M_TSLEEP, M_WAITOK | M_ZERO);
 350         }
 351         for (i = 0; i < TABLESIZE; ++i)
 352                 TAILQ_INIT(&gd->gd_tsleep_hash[i]);
 353 }
 354
 355 /*
 356  * This is a dandy function that allows us to interlock tsleep/wakeup
 357  * operations with unspecified upper level locks, such as lockmgr locks,
 358  * simply by holding a critical section.  The sequence is:
 359  *
 360  *      (acquire upper level lock)
 361  *      tsleep_interlock(blah)
 362  *      (release upper level lock)
 363  *      tsleep(blah, ...)
 364  *
 365  * Basically this functions queues us on the tsleep queue without actually
 366  * descheduling us.  When tsleep() is later called with PINTERLOCK it
 367  * assumes the thread was already queued, otherwise it queues it there.
 368  *
 369  * Thus it is possible to receive the wakeup prior to going to sleep and
 370  * the race conditions are covered.
 371  */
 372 static __inline void
 373 _tsleep_interlock(globaldata_t gd, const volatile void *ident, int flags)
 374 {
 375         thread_t td = gd->gd_curthread;
 376         int id;
 377
 378         crit_enter_quick(td);
 379         if (td->td_flags & TDF_TSLEEPQ) {
 380                 id = LOOKUP(td->td_wchan);
 381                 TAILQ_REMOVE(&gd->gd_tsleep_hash[id], td, td_sleepq);
 382                 if (TAILQ_FIRST(&gd->gd_tsleep_hash[id]) == NULL) {
 383                         atomic_clear_cpumask(&slpque_cpumasks[id],
 384                                              gd->gd_cpumask);
 385                 }
 386         } else {
 387                 td->td_flags |= TDF_TSLEEPQ;
 388         }
 389         id = LOOKUP(ident);
 390         TAILQ_INSERT_TAIL(&gd->gd_tsleep_hash[id], td, td_sleepq);
 391         atomic_set_cpumask(&slpque_cpumasks[id], gd->gd_cpumask);
 392         td->td_wchan = ident;
 393         td->td_wdomain = flags & PDOMAIN_MASK;
 394         crit_exit_quick(td);
 395 }
 396
 397 void
 398 tsleep_interlock(const volatile void *ident, int flags)
 399 {
 400         _tsleep_interlock(mycpu, ident, flags);
 401 }
 402
 403 /*
 404  * Remove thread from sleepq.  Must be called with a critical section held.
 405  * The thread must not be migrating.
 406  */
 407 static __inline void
 408 _tsleep_remove(thread_t td)
 409 {
 410         globaldata_t gd = mycpu;
 411         int id;
 412
 413         KKASSERT(td->td_gd == gd && IN_CRITICAL_SECT(td));
 414         KKASSERT((td->td_flags & TDF_MIGRATING) == 0);
 415         if (td->td_flags & TDF_TSLEEPQ) {
 416                 td->td_flags &= ~TDF_TSLEEPQ;
 417                 id = LOOKUP(td->td_wchan);
 418                 TAILQ_REMOVE(&gd->gd_tsleep_hash[id], td, td_sleepq);
 419                 if (TAILQ_FIRST(&gd->gd_tsleep_hash[id]) == NULL)
 420                         atomic_clear_cpumask(&slpque_cpumasks[id], gd->gd_cpumask);
 421                 td->td_wchan = NULL;
 422                 td->td_wdomain = 0;
 423         }
 424 }
 425
 426 void
 427 tsleep_remove(thread_t td)
 428 {
 429         _tsleep_remove(td);
 430 }
 431
 432 /*
 433  * General sleep call.  Suspends the current process until a wakeup is
 434  * performed on the specified identifier.  The process will then be made
 435  * runnable with the specified priority.  Sleeps at most timo/hz seconds
 436  * (0 means no timeout).  If flags includes PCATCH flag, signals are checked
 437  * before and after sleeping, else signals are not checked.  Returns 0 if
 438  * awakened, EWOULDBLOCK if the timeout expires.  If PCATCH is set and a
 439  * signal needs to be delivered, ERESTART is returned if the current system
 440  * call should be restarted if possible, and EINTR is returned if the system
 441  * call should be interrupted by the signal (return EINTR).
 442  *
 443  * Note that if we are a process, we release_curproc() before messing with
 444  * the LWKT scheduler.
 445  *
 446  * During autoconfiguration or after a panic, a sleep will simply
 447  * lower the priority briefly to allow interrupts, then return.
 448  *
 449  * WARNING!  This code can't block (short of switching away), or bad things
 450  *           will happen.  No getting tokens, no blocking locks, etc.
 451  */
 452 int
 453 tsleep(const volatile void *ident, int flags, const char *wmesg, int timo)
 454 {
 455         struct thread *td = curthread;
 456         struct lwp *lp = td->td_lwp;
 457         struct proc *p = td->td_proc;           /* may be NULL */
 458         globaldata_t gd;
 459         int sig;
 460         int catch;
 461         int error;
 462         int oldpri;
 463         struct callout thandle;
 464
 465         /*
 466          * Currently a severe hack.  Make sure any delayed wakeups
 467          * are flushed before we sleep or we might deadlock on whatever
 468          * event we are sleeping on.
 469          */
 470         if (td->td_flags & TDF_DELAYED_WAKEUP)
 471                 wakeup_end_delayed();
 472
 473         /*
 474          * NOTE: removed KTRPOINT, it could cause races due to blocking
 475          * even in stable.  Just scrap it for now.
 476          */
 477         if (!tsleep_crypto_dump && (tsleep_now_works == 0 || panicstr)) {
 478                 /*
 479                  * After a panic, or before we actually have an operational
 480                  * softclock, just give interrupts a chance, then just return;
 481                  *
 482                  * don't run any other procs or panic below,
 483                  * in case this is the idle process and already asleep.
 484                  */
 485                 splz();
 486                 oldpri = td->td_pri;
 487                 lwkt_setpri_self(safepri);
 488                 lwkt_switch();
 489                 lwkt_setpri_self(oldpri);
 490                 return (0);
 491         }
 492         logtsleep2(tsleep_beg, ident);
 493         gd = td->td_gd;
 494         KKASSERT(td != &gd->gd_idlethread);     /* you must be kidding! */
 495         td->td_wakefromcpu = -1;                /* overwritten by _wakeup */
 496
 497         /*
 498          * NOTE: all of this occurs on the current cpu, including any
 499          * callout-based wakeups, so a critical section is a sufficient
 500          * interlock.
 501          *
 502          * The entire sequence through to where we actually sleep must
 503          * run without breaking the critical section.
 504          */
 505         catch = flags & PCATCH;
 506         error = 0;
 507         sig = 0;
 508
 509         crit_enter_quick(td);
 510
 511         KASSERT(ident != NULL, ("tsleep: no ident"));
 512         KASSERT(lp == NULL ||
 513                 lp->lwp_stat == LSRUN ||        /* Obvious */
 514                 lp->lwp_stat == LSSTOP,         /* Set in tstop */
 515                 ("tsleep %p %s %d",
 516                         ident, wmesg, lp->lwp_stat));
 517
 518         /*
 519          * We interlock the sleep queue if the caller has not already done
 520          * it for us.  This must be done before we potentially acquire any
 521          * tokens or we can loose the wakeup.
 522          */
 523         if ((flags & PINTERLOCKED) == 0) {
 524                 _tsleep_interlock(gd, ident, flags);
 525         }
 526
 527         /*
 528          * Setup for the current process (if this is a process).  We must
 529          * interlock with lwp_token to avoid remote wakeup races via
 530          * setrunnable()
 531          */
 532         if (lp) {
 533                 lwkt_gettoken(&lp->lwp_token);
 534                 if (catch) {
 535                         /*
 536                          * Early termination if PCATCH was set and a
 537                          * signal is pending, interlocked with the
 538                          * critical section.
 539                          *
 540                          * Early termination only occurs when tsleep() is
 541                          * entered while in a normal LSRUN state.
 542                          */
 543                         if ((sig = CURSIG(lp)) != 0)
 544                                 goto resume;
 545
 546                         /*
 547                          * Causes ksignal to wake us up if a signal is
 548                          * received (interlocked with p->p_token).
 549                          */
 550                         lp->lwp_flags |= LWP_SINTR;
 551                 }
 552         } else {
 553                 KKASSERT(p == NULL);
 554         }
 555
 556         /*
 557          * Make sure the current process has been untangled from
 558          * the userland scheduler and initialize slptime to start
 559          * counting.
 560          *
 561          * NOTE: td->td_wakefromcpu is pre-set by the release function
 562          *       for the dfly scheduler, and then adjusted by _wakeup()
 563          */
 564         if (lp) {
 565                 p->p_usched->release_curproc(lp);
 566                 lp->lwp_slptime = 0;
 567         }
 568
 569         /*
 570          * If the interlocked flag is set but our cpu bit in the slpqueue
 571          * is no longer set, then a wakeup was processed inbetween the
 572          * tsleep_interlock() (ours or the callers), and here.  This can
 573          * occur under numerous circumstances including when we release the
 574          * current process.
 575          *
 576          * Extreme loads can cause the sending of an IPI (e.g. wakeup()'s)
 577          * to process incoming IPIs, thus draining incoming wakeups.
 578          */
 579         if ((td->td_flags & TDF_TSLEEPQ) == 0) {
 580                 logtsleep2(ilockfail, ident);
 581                 goto resume;
 582         }
 583
 584         /*
 585          * scheduling is blocked while in a critical section.  Coincide
 586          * the descheduled-by-tsleep flag with the descheduling of the
 587          * lwkt.
 588          *
 589          * The timer callout is localized on our cpu and interlocked by
 590          * our critical section.
 591          */
 592         lwkt_deschedule_self(td);
 593         td->td_flags |= TDF_TSLEEP_DESCHEDULED;
 594         td->td_wmesg = wmesg;
 595
 596         /*
 597          * Setup the timeout, if any.  The timeout is only operable while
 598          * the thread is flagged descheduled.
 599          */
 600         KKASSERT((td->td_flags & TDF_TIMEOUT) == 0);
 601         if (timo) {
 602                 callout_init_mp(&thandle);
 603                 callout_reset(&thandle, timo, endtsleep, td);
 604         }
 605
 606         /*
 607          * Beddy bye bye.
 608          */
 609         if (lp) {
 610                 /*
 611                  * Ok, we are sleeping.  Place us in the SSLEEP state.
 612                  */
 613                 KKASSERT((lp->lwp_mpflags & LWP_MP_ONRUNQ) == 0);
 614
 615                 /*
 616                  * tstop() sets LSSTOP, so don't fiddle with that.
 617                  */
 618                 if (lp->lwp_stat != LSSTOP)
 619                         lp->lwp_stat = LSSLEEP;
 620                 lp->lwp_ru.ru_nvcsw++;
 621                 p->p_usched->uload_update(lp);
 622                 lwkt_switch();
 623
 624                 /*
 625                  * And when we are woken up, put us back in LSRUN.  If we
 626                  * slept for over a second, recalculate our estcpu.
 627                  */
 628                 lp->lwp_stat = LSRUN;
 629                 if (lp->lwp_slptime) {
 630                         p->p_usched->uload_update(lp);
 631                         p->p_usched->recalculate(lp);
 632                 }
 633                 lp->lwp_slptime = 0;
 634         } else {
 635                 lwkt_switch();
 636         }
 637
 638         /*
 639          * Make sure we haven't switched cpus while we were asleep.  It's
 640          * not supposed to happen.  Cleanup our temporary flags.
 641          */
 642         KKASSERT(gd == td->td_gd);
 643
 644         /*
 645          * Cleanup the timeout.  If the timeout has already occured thandle
 646          * has already been stopped, otherwise stop thandle.  If the timeout
 647          * is running (the callout thread must be blocked trying to get
 648          * lwp_token) then wait for us to get scheduled.
 649          */
 650         if (timo) {
 651                 while (td->td_flags & TDF_TIMEOUT_RUNNING) {
 652                         lwkt_deschedule_self(td);
 653                         td->td_wmesg = "tsrace";
 654                         lwkt_switch();
 655                         kprintf("td %p %s: timeout race\n", td, td->td_comm);
 656                 }
 657                 if (td->td_flags & TDF_TIMEOUT) {
 658                         td->td_flags &= ~TDF_TIMEOUT;
 659                         error = EWOULDBLOCK;
 660                 } else {
 661                         /* does not block when on same cpu */
 662                         callout_stop(&thandle);
 663                 }
 664         }
 665         td->td_flags &= ~TDF_TSLEEP_DESCHEDULED;
 666
 667         /*
 668          * Make sure we have been removed from the sleepq.  In most
 669          * cases this will have been done for us already but it is
 670          * possible for a scheduling IPI to be in-flight from a
 671          * previous tsleep/tsleep_interlock() or due to a straight-out
 672          * call to lwkt_schedule() (in the case of an interrupt thread),
 673          * causing a spurious wakeup.
 674          */
 675         _tsleep_remove(td);
 676         td->td_wmesg = NULL;
 677
 678         /*
 679          * Figure out the correct error return.  If interrupted by a
 680          * signal we want to return EINTR or ERESTART.
 681          */
 682 resume:
 683         if (lp) {
 684                 if (catch && error == 0) {
 685                         if (sig != 0 || (sig = CURSIG(lp))) {
 686                                 if (SIGISMEMBER(p->p_sigacts->ps_sigintr, sig))
 687                                         error = EINTR;
 688                                 else
 689                                         error = ERESTART;
 690                         }
 691                 }
 692                 lp->lwp_flags &= ~LWP_SINTR;
 693                 lwkt_reltoken(&lp->lwp_token);
 694         }
 695         logtsleep1(tsleep_end);
 696         crit_exit_quick(td);
 697         return (error);
 698 }
 699
 700 /*
 701  * Interlocked spinlock sleep.  An exclusively held spinlock must
 702  * be passed to ssleep().  The function will atomically release the
 703  * spinlock and tsleep on the ident, then reacquire the spinlock and
 704  * return.
 705  *
 706  * This routine is fairly important along the critical path, so optimize it
 707  * heavily.
 708  */
 709 int
 710 ssleep(const volatile void *ident, struct spinlock *spin, int flags,
 711        const char *wmesg, int timo)
 712 {
 713         globaldata_t gd = mycpu;
 714         int error;
 715
 716         _tsleep_interlock(gd, ident, flags);
 717         spin_unlock_quick(gd, spin);
 718         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 719         spin_lock_quick(gd, spin);
 720
 721         return (error);
 722 }
 723
 724 int
 725 lksleep(const volatile void *ident, struct lock *lock, int flags,
 726         const char *wmesg, int timo)
 727 {
 728         globaldata_t gd = mycpu;
 729         int error;
 730
 731         _tsleep_interlock(gd, ident, flags);
 732         lockmgr(lock, LK_RELEASE);
 733         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 734         lockmgr(lock, LK_EXCLUSIVE);
 735
 736         return (error);
 737 }
 738
 739 /*
 740  * Interlocked mutex sleep.  An exclusively held mutex must be passed
 741  * to mtxsleep().  The function will atomically release the mutex
 742  * and tsleep on the ident, then reacquire the mutex and return.
 743  */
 744 int
 745 mtxsleep(const volatile void *ident, struct mtx *mtx, int flags,
 746          const char *wmesg, int timo)
 747 {
 748         globaldata_t gd = mycpu;
 749         int error;
 750
 751         _tsleep_interlock(gd, ident, flags);
 752         mtx_unlock(mtx);
 753         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 754         mtx_lock_ex_quick(mtx, wmesg);
 755
 756         return (error);
 757 }
 758
 759 /*
 760  * Interlocked serializer sleep.  An exclusively held serializer must
 761  * be passed to zsleep().  The function will atomically release
 762  * the serializer and tsleep on the ident, then reacquire the serializer
 763  * and return.
 764  */
 765 int
 766 zsleep(const volatile void *ident, struct lwkt_serialize *slz, int flags,
 767        const char *wmesg, int timo)
 768 {
 769         globaldata_t gd = mycpu;
 770         int ret;
 771
 772         ASSERT_SERIALIZED(slz);
 773
 774         _tsleep_interlock(gd, ident, flags);
 775         lwkt_serialize_exit(slz);
 776         ret = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 777         lwkt_serialize_enter(slz);
 778
 779         return ret;
 780 }
 781
 782 /*
 783  * Directly block on the LWKT thread by descheduling it.  This
 784  * is much faster then tsleep(), but the only legal way to wake
 785  * us up is to directly schedule the thread.
 786  *
 787  * Setting TDF_SINTR will cause new signals to directly schedule us.
 788  *
 789  * This routine must be called while in a critical section.
 790  */
 791 int
 792 lwkt_sleep(const char *wmesg, int flags)
 793 {
 794         thread_t td = curthread;
 795         int sig;
 796
 797         if ((flags & PCATCH) == 0 || td->td_lwp == NULL) {
 798                 td->td_flags |= TDF_BLOCKED;
 799                 td->td_wmesg = wmesg;
 800                 lwkt_deschedule_self(td);
 801                 lwkt_switch();
 802                 td->td_wmesg = NULL;
 803                 td->td_flags &= ~TDF_BLOCKED;
 804                 return(0);
 805         }
 806         if ((sig = CURSIG(td->td_lwp)) != 0) {
 807                 if (SIGISMEMBER(td->td_proc->p_sigacts->ps_sigintr, sig))
 808                         return(EINTR);
 809                 else
 810                         return(ERESTART);
 811
 812         }
 813         td->td_flags |= TDF_BLOCKED | TDF_SINTR;
 814         td->td_wmesg = wmesg;
 815         lwkt_deschedule_self(td);
 816         lwkt_switch();
 817         td->td_flags &= ~(TDF_BLOCKED | TDF_SINTR);
 818         td->td_wmesg = NULL;
 819         return(0);
 820 }
 821
 822 /*
 823  * Implement the timeout for tsleep.
 824  *
 825  * This type of callout timeout is scheduled on the same cpu the process
 826  * is sleeping on.  Also, at the moment, the MP lock is held.
 827  */
 828 static void
 829 endtsleep(void *arg)
 830 {
 831         thread_t td = arg;
 832         struct lwp *lp;
 833
 834         /*
 835          * We are going to have to get the lwp_token, which means we might
 836          * block.  This can race a tsleep getting woken up by other means
 837          * so set TDF_TIMEOUT_RUNNING to force the tsleep to wait for our
 838          * processing to complete (sorry tsleep!).
 839          *
 840          * We can safely set td_flags because td MUST be on the same cpu
 841          * as we are.
 842          */
 843         KKASSERT(td->td_gd == mycpu);
 844         crit_enter();
 845         td->td_flags |= TDF_TIMEOUT_RUNNING | TDF_TIMEOUT;
 846
 847         /*
 848          * This can block but TDF_TIMEOUT_RUNNING will prevent the thread
 849          * from exiting the tsleep on us.  The flag is interlocked by virtue
 850          * of lp being on the same cpu as we are.
 851          */
 852         if ((lp = td->td_lwp) != NULL)
 853                 lwkt_gettoken(&lp->lwp_token);
 854
 855         KKASSERT(td->td_flags & TDF_TSLEEP_DESCHEDULED);
 856
 857         if (lp) {
 858                 if (lp->lwp_proc->p_stat != SSTOP)
 859                         setrunnable(lp);
 860                 lwkt_reltoken(&lp->lwp_token);
 861         } else {
 862                 _tsleep_remove(td);
 863                 lwkt_schedule(td);
 864         }
 865         KKASSERT(td->td_gd == mycpu);
 866         td->td_flags &= ~TDF_TIMEOUT_RUNNING;
 867         crit_exit();
 868 }
 869
 870 /*
 871  * Make all processes sleeping on the specified identifier runnable.
 872  * count may be zero or one only.
 873  *
 874  * The domain encodes the sleep/wakeup domain, flags, plus the originating
 875  * cpu.
 876  *
 877  * This call may run without the MP lock held.  We can only manipulate thread
 878  * state on the cpu owning the thread.  We CANNOT manipulate process state
 879  * at all.
 880  *
 881  * _wakeup() can be passed to an IPI so we can't use (const volatile
 882  * void *ident).
 883  */
 884 static void
 885 _wakeup(void *ident, int domain)
 886 {
 887         struct tslpque *qp;
 888         struct thread *td;
 889         struct thread *ntd;
 890         globaldata_t gd;
 891 #ifdef SMP
 892         cpumask_t mask;
 893 #endif
 894         int id;
 895
 896         crit_enter();
 897         logtsleep2(wakeup_beg, ident);
 898         gd = mycpu;
 899         id = LOOKUP(ident);
 900         qp = &gd->gd_tsleep_hash[id];
 901 restart:
 902         for (td = TAILQ_FIRST(qp); td != NULL; td = ntd) {
 903                 ntd = TAILQ_NEXT(td, td_sleepq);
 904                 if (td->td_wchan == ident &&
 905                     td->td_wdomain == (domain & PDOMAIN_MASK)
 906                 ) {
 907                         KKASSERT(td->td_gd == gd);
 908                         _tsleep_remove(td);
 909                         td->td_wakefromcpu = PWAKEUP_DECODE(domain);
 910                         if (td->td_flags & TDF_TSLEEP_DESCHEDULED) {
 911                                 lwkt_schedule(td);
 912                                 if (domain & PWAKEUP_ONE)
 913                                         goto done;
 914                         }
 915                         goto restart;
 916                 }
 917         }
 918
 919 #ifdef SMP
 920         /*
 921          * We finished checking the current cpu but there still may be
 922          * more work to do.  Either wakeup_one was requested and no matching
 923          * thread was found, or a normal wakeup was requested and we have
 924          * to continue checking cpus.
 925          *
 926          * It should be noted that this scheme is actually less expensive then
 927          * the old scheme when waking up multiple threads, since we send
 928          * only one IPI message per target candidate which may then schedule
 929          * multiple threads.  Before we could have wound up sending an IPI
 930          * message for each thread on the target cpu (!= current cpu) that
 931          * needed to be woken up.
 932          *
 933          * NOTE: Wakeups occuring on remote cpus are asynchronous.  This
 934          * should be ok since we are passing idents in the IPI rather then
 935          * thread pointers.
 936          */
 937         if ((domain & PWAKEUP_MYCPU) == 0 &&
 938             (mask = slpque_cpumasks[id] & gd->gd_other_cpus) != 0) {
 939                 lwkt_send_ipiq2_mask(mask, _wakeup, ident,
 940                                      domain | PWAKEUP_MYCPU);
 941         }
 942 #endif
 943 done:
 944         logtsleep1(wakeup_end);
 945         crit_exit();
 946 }
 947
 948 /*
 949  * Wakeup all threads tsleep()ing on the specified ident, on all cpus
 950  */
 951 void
 952 wakeup(const volatile void *ident)
 953 {
 954     globaldata_t gd = mycpu;
 955     thread_t td = gd->gd_curthread;
 956
 957     if (td && (td->td_flags & TDF_DELAYED_WAKEUP)) {
 958         if (!atomic_cmpset_ptr(&gd->gd_delayed_wakeup[0], NULL, ident)) {
 959             if (!atomic_cmpset_ptr(&gd->gd_delayed_wakeup[1], NULL, ident))
 960                 _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, gd->gd_cpuid));
 961         }
 962         return;
 963     }
 964     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, gd->gd_cpuid));
 965 }
 966
 967 /*
 968  * Wakeup one thread tsleep()ing on the specified ident, on any cpu.
 969  */
 970 void
 971 wakeup_one(const volatile void *ident)
 972 {
 973     /* XXX potentially round-robin the first responding cpu */
 974     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) |
 975                             PWAKEUP_ONE);
 976 }
 977
 978 /*
 979  * Wakeup threads tsleep()ing on the specified ident on the current cpu
 980  * only.
 981  */
 982 void
 983 wakeup_mycpu(const volatile void *ident)
 984 {
 985     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) |
 986                             PWAKEUP_MYCPU);
 987 }
 988
 989 /*
 990  * Wakeup one thread tsleep()ing on the specified ident on the current cpu
 991  * only.
 992  */
 993 void
 994 wakeup_mycpu_one(const volatile void *ident)
 995 {
 996     /* XXX potentially round-robin the first responding cpu */
 997     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) |
 998                             PWAKEUP_MYCPU | PWAKEUP_ONE);
 999 }
1000
1001 /*
1002  * Wakeup all thread tsleep()ing on the specified ident on the specified cpu
1003  * only.
1004  */
1005 void
1006 wakeup_oncpu(globaldata_t gd, const volatile void *ident)
1007 {
1008 #ifdef SMP
1009     globaldata_t mygd = mycpu;
1010     if (gd == mycpu) {
1011         _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
1012                                 PWAKEUP_MYCPU);
1013     } else {
1014         lwkt_send_ipiq2(gd, _wakeup, __DEALL(ident),
1015                         PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
1016                         PWAKEUP_MYCPU);
1017     }
1018 #else
1019     _wakeup(__DEALL(ident), PWAKEUP_MYCPU);
1020 #endif
1021 }
1022
1023 /*
1024  * Wakeup one thread tsleep()ing on the specified ident on the specified cpu
1025  * only.
1026  */
1027 void
1028 wakeup_oncpu_one(globaldata_t gd, const volatile void *ident)
1029 {
1030 #ifdef SMP
1031     globaldata_t mygd = mycpu;
1032     if (gd == mygd) {
1033         _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
1034                                 PWAKEUP_MYCPU | PWAKEUP_ONE);
1035     } else {
1036         lwkt_send_ipiq2(gd, _wakeup, __DEALL(ident),
1037                         PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
1038                         PWAKEUP_MYCPU | PWAKEUP_ONE);
1039     }
1040 #else
1041     _wakeup(__DEALL(ident), PWAKEUP_MYCPU | PWAKEUP_ONE);
1042 #endif
1043 }
1044
1045 /*
1046  * Wakeup all threads waiting on the specified ident that slept using
1047  * the specified domain, on all cpus.
1048  */
1049 void
1050 wakeup_domain(const volatile void *ident, int domain)
1051 {
1052     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(domain, mycpu->gd_cpuid));
1053 }
1054
1055 /*
1056  * Wakeup one thread waiting on the specified ident that slept using
1057  * the specified  domain, on any cpu.
1058  */
1059 void
1060 wakeup_domain_one(const volatile void *ident, int domain)
1061 {
1062     /* XXX potentially round-robin the first responding cpu */
1063     _wakeup(__DEALL(ident),
1064             PWAKEUP_ENCODE(domain, mycpu->gd_cpuid) | PWAKEUP_ONE);
1065 }
1066
1067 void
1068 wakeup_start_delayed(void)
1069 {
1070     globaldata_t gd = mycpu;
1071
1072     crit_enter();
1073     gd->gd_curthread->td_flags |= TDF_DELAYED_WAKEUP;
1074     crit_exit();
1075 }
1076
1077 void
1078 wakeup_end_delayed(void)
1079 {
1080     globaldata_t gd = mycpu;
1081
1082     if (gd->gd_curthread->td_flags & TDF_DELAYED_WAKEUP) {
1083         crit_enter();
1084         gd->gd_curthread->td_flags &= ~TDF_DELAYED_WAKEUP;
1085         if (gd->gd_delayed_wakeup[0] || gd->gd_delayed_wakeup[1]) {
1086             if (gd->gd_delayed_wakeup[0]) {
1087                     wakeup(gd->gd_delayed_wakeup[0]);
1088                     gd->gd_delayed_wakeup[0] = NULL;
1089             }
1090             if (gd->gd_delayed_wakeup[1]) {
1091                     wakeup(gd->gd_delayed_wakeup[1]);
1092                     gd->gd_delayed_wakeup[1] = NULL;
1093             }
1094         }
1095         crit_exit();
1096     }
1097 }
1098
1099 /*
1100  * setrunnable()
1101  *
1102  * Make a process runnable.  lp->lwp_token must be held on call and this
1103  * function must be called from the cpu owning lp.
1104  *
1105  * This only has an effect if we are in LSSTOP or LSSLEEP.
1106  */
1107 void
1108 setrunnable(struct lwp *lp)
1109 {
1110         thread_t td = lp->lwp_thread;
1111
1112         ASSERT_LWKT_TOKEN_HELD(&lp->lwp_token);
1113         KKASSERT(td->td_gd == mycpu);
1114         crit_enter();
1115         if (lp->lwp_stat == LSSTOP)
1116                 lp->lwp_stat = LSSLEEP;
1117         if (lp->lwp_stat == LSSLEEP) {
1118                 _tsleep_remove(td);
1119                 lwkt_schedule(td);
1120         } else if (td->td_flags & TDF_SINTR) {
1121                 lwkt_schedule(td);
1122         }
1123         crit_exit();
1124 }
1125
1126 /*
1127  * The process is stopped due to some condition, usually because p_stat is
1128  * set to SSTOP, but also possibly due to being traced.
1129  *
1130  * Caller must hold p->p_token
1131  *
1132  * NOTE!  If the caller sets SSTOP, the caller must also clear P_WAITED
1133  * because the parent may check the child's status before the child actually
1134  * gets to this routine.
1135  *
1136  * This routine is called with the current lwp only, typically just
1137  * before returning to userland if the process state is detected as
1138  * possibly being in a stopped state.
1139  */
1140 void
1141 tstop(void)
1142 {
1143         struct lwp *lp = curthread->td_lwp;
1144         struct proc *p = lp->lwp_proc;
1145         struct proc *q;
1146
1147         lwkt_gettoken(&lp->lwp_token);
1148         crit_enter();
1149
1150         /*
1151          * If LWP_MP_WSTOP is set, we were sleeping
1152          * while our process was stopped.  At this point
1153          * we were already counted as stopped.
1154          */
1155         if ((lp->lwp_mpflags & LWP_MP_WSTOP) == 0) {
1156                 /*
1157                  * If we're the last thread to stop, signal
1158                  * our parent.
1159                  */
1160                 p->p_nstopped++;
1161                 atomic_set_int(&lp->lwp_mpflags, LWP_MP_WSTOP);
1162                 wakeup(&p->p_nstopped);
1163                 if (p->p_nstopped == p->p_nthreads) {
1164                         /*
1165                          * Token required to interlock kern_wait()
1166                          */
1167                         q = p->p_pptr;
1168                         PHOLD(q);
1169                         lwkt_gettoken(&q->p_token);
1170                         p->p_flags &= ~P_WAITED;
1171                         wakeup(p->p_pptr);
1172                         if ((q->p_sigacts->ps_flag & PS_NOCLDSTOP) == 0)
1173                                 ksignal(q, SIGCHLD);
1174                         lwkt_reltoken(&q->p_token);
1175                         PRELE(q);
1176                 }
1177         }
1178         while (p->p_stat == SSTOP) {
1179                 lp->lwp_stat = LSSTOP;
1180                 tsleep(p, 0, "stop", 0);
1181         }
1182         p->p_nstopped--;
1183         atomic_clear_int(&lp->lwp_mpflags, LWP_MP_WSTOP);
1184         crit_exit();
1185         lwkt_reltoken(&lp->lwp_token);
1186 }
1187
1188 /*
1189  * Compute a tenex style load average of a quantity on
1190  * 1, 5 and 15 minute intervals.
1191  */
1192 static int loadav_count_runnable(struct lwp *p, void *data);
1193
1194 static void
1195 loadav(void *arg)
1196 {
1197         struct loadavg *avg;
1198         int i, nrun;
1199
1200         nrun = 0;
1201         alllwp_scan(loadav_count_runnable, &nrun);
1202         avg = &averunnable;
1203         for (i = 0; i < 3; i++) {
1204                 avg->ldavg[i] = (cexp[i] * avg->ldavg[i] +
1205                     nrun * FSCALE * (FSCALE - cexp[i])) >> FSHIFT;
1206         }
1207
1208         /*
1209          * Schedule the next update to occur after 5 seconds, but add a
1210          * random variation to avoid synchronisation with processes that
1211          * run at regular intervals.
1212          */
1213         callout_reset(&loadav_callout, hz * 4 + (int)(krandom() % (hz * 2 + 1)),
1214                       loadav, NULL);
1215 }
1216
1217 static int
1218 loadav_count_runnable(struct lwp *lp, void *data)
1219 {
1220         int *nrunp = data;
1221         thread_t td;
1222
1223         switch (lp->lwp_stat) {
1224         case LSRUN:
1225                 if ((td = lp->lwp_thread) == NULL)
1226                         break;
1227                 if (td->td_flags & TDF_BLOCKED)
1228                         break;
1229                 ++*nrunp;
1230                 break;
1231         default:
1232                 break;
1233         }
1234         lwkt_yield();
1235         return(0);
1236 }
1237
1238 /* ARGSUSED */
1239 static void
1240 sched_setup(void *dummy)
1241 {
1242         callout_init_mp(&loadav_callout);
1243         callout_init_mp(&schedcpu_callout);
1244
1245         /* Kick off timeout driven events by calling first time. */
1246         schedcpu(NULL);
1247         loadav(NULL);
1248 }
1249