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
 222                 /*
 223                  * Only recalculate processes that are active or have slept
 224                  * less then 2 seconds.  The schedulers understand this.
 225                  */
 226                 if (lp->lwp_slptime <= 1) {
 227                         p->p_usched->recalculate(lp);
 228                 } else {
 229                         lp->lwp_pctcpu = (lp->lwp_pctcpu * ccpu) >> FSHIFT;
 230                 }
 231         }
 232         lwkt_reltoken(&p->p_token);
 233         lwkt_yield();
 234         PRELE(p);
 235         return(0);
 236 }
 237
 238 /*
 239  * Resource checks.  XXX break out since ksignal/killproc can block,
 240  * limiting us to one process killed per second.  There is probably
 241  * a better way.
 242  */
 243 static int
 244 schedcpu_resource(struct proc *p, void *data __unused)
 245 {
 246         u_int64_t ttime;
 247         struct lwp *lp;
 248
 249         if (p->p_stat == SIDL)
 250                 return(0);
 251
 252         PHOLD(p);
 253         if (lwkt_trytoken(&p->p_token) == FALSE) {
 254                 PRELE(p);
 255                 return(0);
 256         }
 257
 258         if (p->p_stat == SZOMB || p->p_limit == NULL) {
 259                 lwkt_reltoken(&p->p_token);
 260                 PRELE(p);
 261                 return(0);
 262         }
 263
 264         ttime = 0;
 265         FOREACH_LWP_IN_PROC(lp, p) {
 266                 /*
 267                  * We may have caught an lp in the middle of being
 268                  * created, lwp_thread can be NULL.
 269                  */
 270                 if (lp->lwp_thread) {
 271                         ttime += lp->lwp_thread->td_sticks;
 272                         ttime += lp->lwp_thread->td_uticks;
 273                 }
 274         }
 275
 276         switch(plimit_testcpulimit(p->p_limit, ttime)) {
 277         case PLIMIT_TESTCPU_KILL:
 278                 killproc(p, "exceeded maximum CPU limit");
 279                 break;
 280         case PLIMIT_TESTCPU_XCPU:
 281                 if ((p->p_flags & P_XCPU) == 0) {
 282                         p->p_flags |= P_XCPU;
 283                         ksignal(p, SIGXCPU);
 284                 }
 285                 break;
 286         default:
 287                 break;
 288         }
 289         lwkt_reltoken(&p->p_token);
 290         lwkt_yield();
 291         PRELE(p);
 292         return(0);
 293 }
 294
 295 /*
 296  * This is only used by ps.  Generate a cpu percentage use over
 297  * a period of one second.
 298  *
 299  * MPSAFE
 300  */
 301 void
 302 updatepcpu(struct lwp *lp, int cpticks, int ttlticks)
 303 {
 304         fixpt_t acc;
 305         int remticks;
 306
 307         acc = (cpticks << FSHIFT) / ttlticks;
 308         if (ttlticks >= ESTCPUFREQ) {
 309                 lp->lwp_pctcpu = acc;
 310         } else {
 311                 remticks = ESTCPUFREQ - ttlticks;
 312                 lp->lwp_pctcpu = (acc * ttlticks + lp->lwp_pctcpu * remticks) /
 313                                 ESTCPUFREQ;
 314         }
 315 }
 316
 317 /*
 318  * tsleep/wakeup hash table parameters.  Try to find the sweet spot for
 319  * like addresses being slept on.
 320  */
 321 #define TABLESIZE       4001
 322 #define LOOKUP(x)       (((u_int)(uintptr_t)(x)) % TABLESIZE)
 323
 324 static cpumask_t slpque_cpumasks[TABLESIZE];
 325
 326 /*
 327  * General scheduler initialization.  We force a reschedule 25 times
 328  * a second by default.  Note that cpu0 is initialized in early boot and
 329  * cannot make any high level calls.
 330  *
 331  * Each cpu has its own sleep queue.
 332  */
 333 void
 334 sleep_gdinit(globaldata_t gd)
 335 {
 336         static struct tslpque slpque_cpu0[TABLESIZE];
 337         int i;
 338
 339         if (gd->gd_cpuid == 0) {
 340                 sched_quantum = (hz + 24) / 25;
 341                 hogticks = 2 * sched_quantum;
 342
 343                 gd->gd_tsleep_hash = slpque_cpu0;
 344         } else {
 345                 gd->gd_tsleep_hash = kmalloc(sizeof(slpque_cpu0),
 346                                             M_TSLEEP, M_WAITOK | M_ZERO);
 347         }
 348         for (i = 0; i < TABLESIZE; ++i)
 349                 TAILQ_INIT(&gd->gd_tsleep_hash[i]);
 350 }
 351
 352 /*
 353  * This is a dandy function that allows us to interlock tsleep/wakeup
 354  * operations with unspecified upper level locks, such as lockmgr locks,
 355  * simply by holding a critical section.  The sequence is:
 356  *
 357  *      (acquire upper level lock)
 358  *      tsleep_interlock(blah)
 359  *      (release upper level lock)
 360  *      tsleep(blah, ...)
 361  *
 362  * Basically this functions queues us on the tsleep queue without actually
 363  * descheduling us.  When tsleep() is later called with PINTERLOCK it
 364  * assumes the thread was already queued, otherwise it queues it there.
 365  *
 366  * Thus it is possible to receive the wakeup prior to going to sleep and
 367  * the race conditions are covered.
 368  */
 369 static __inline void
 370 _tsleep_interlock(globaldata_t gd, const volatile void *ident, int flags)
 371 {
 372         thread_t td = gd->gd_curthread;
 373         int id;
 374
 375         crit_enter_quick(td);
 376         if (td->td_flags & TDF_TSLEEPQ) {
 377                 id = LOOKUP(td->td_wchan);
 378                 TAILQ_REMOVE(&gd->gd_tsleep_hash[id], td, td_sleepq);
 379                 if (TAILQ_FIRST(&gd->gd_tsleep_hash[id]) == NULL) {
 380                         atomic_clear_cpumask(&slpque_cpumasks[id],
 381                                              gd->gd_cpumask);
 382                 }
 383         } else {
 384                 td->td_flags |= TDF_TSLEEPQ;
 385         }
 386         id = LOOKUP(ident);
 387         TAILQ_INSERT_TAIL(&gd->gd_tsleep_hash[id], td, td_sleepq);
 388         atomic_set_cpumask(&slpque_cpumasks[id], gd->gd_cpumask);
 389         td->td_wchan = ident;
 390         td->td_wdomain = flags & PDOMAIN_MASK;
 391         crit_exit_quick(td);
 392 }
 393
 394 void
 395 tsleep_interlock(const volatile void *ident, int flags)
 396 {
 397         _tsleep_interlock(mycpu, ident, flags);
 398 }
 399
 400 /*
 401  * Remove thread from sleepq.  Must be called with a critical section held.
 402  * The thread must not be migrating.
 403  */
 404 static __inline void
 405 _tsleep_remove(thread_t td)
 406 {
 407         globaldata_t gd = mycpu;
 408         int id;
 409
 410         KKASSERT(td->td_gd == gd && IN_CRITICAL_SECT(td));
 411         KKASSERT((td->td_flags & TDF_MIGRATING) == 0);
 412         if (td->td_flags & TDF_TSLEEPQ) {
 413                 td->td_flags &= ~TDF_TSLEEPQ;
 414                 id = LOOKUP(td->td_wchan);
 415                 TAILQ_REMOVE(&gd->gd_tsleep_hash[id], td, td_sleepq);
 416                 if (TAILQ_FIRST(&gd->gd_tsleep_hash[id]) == NULL)
 417                         atomic_clear_cpumask(&slpque_cpumasks[id], gd->gd_cpumask);
 418                 td->td_wchan = NULL;
 419                 td->td_wdomain = 0;
 420         }
 421 }
 422
 423 void
 424 tsleep_remove(thread_t td)
 425 {
 426         _tsleep_remove(td);
 427 }
 428
 429 /*
 430  * General sleep call.  Suspends the current process until a wakeup is
 431  * performed on the specified identifier.  The process will then be made
 432  * runnable with the specified priority.  Sleeps at most timo/hz seconds
 433  * (0 means no timeout).  If flags includes PCATCH flag, signals are checked
 434  * before and after sleeping, else signals are not checked.  Returns 0 if
 435  * awakened, EWOULDBLOCK if the timeout expires.  If PCATCH is set and a
 436  * signal needs to be delivered, ERESTART is returned if the current system
 437  * call should be restarted if possible, and EINTR is returned if the system
 438  * call should be interrupted by the signal (return EINTR).
 439  *
 440  * Note that if we are a process, we release_curproc() before messing with
 441  * the LWKT scheduler.
 442  *
 443  * During autoconfiguration or after a panic, a sleep will simply
 444  * lower the priority briefly to allow interrupts, then return.
 445  *
 446  * WARNING!  This code can't block (short of switching away), or bad things
 447  *           will happen.  No getting tokens, no blocking locks, etc.
 448  */
 449 int
 450 tsleep(const volatile void *ident, int flags, const char *wmesg, int timo)
 451 {
 452         struct thread *td = curthread;
 453         struct lwp *lp = td->td_lwp;
 454         struct proc *p = td->td_proc;           /* may be NULL */
 455         globaldata_t gd;
 456         int sig;
 457         int catch;
 458         int error;
 459         int oldpri;
 460         struct callout thandle;
 461
 462         /*
 463          * NOTE: removed KTRPOINT, it could cause races due to blocking
 464          * even in stable.  Just scrap it for now.
 465          */
 466         if (!tsleep_crypto_dump && (tsleep_now_works == 0 || panicstr)) {
 467                 /*
 468                  * After a panic, or before we actually have an operational
 469                  * softclock, just give interrupts a chance, then just return;
 470                  *
 471                  * don't run any other procs or panic below,
 472                  * in case this is the idle process and already asleep.
 473                  */
 474                 splz();
 475                 oldpri = td->td_pri;
 476                 lwkt_setpri_self(safepri);
 477                 lwkt_switch();
 478                 lwkt_setpri_self(oldpri);
 479                 return (0);
 480         }
 481         logtsleep2(tsleep_beg, ident);
 482         gd = td->td_gd;
 483         KKASSERT(td != &gd->gd_idlethread);     /* you must be kidding! */
 484         td->td_wakefromcpu = gd->gd_cpuid;      /* overwritten by _wakeup */
 485
 486         /*
 487          * NOTE: all of this occurs on the current cpu, including any
 488          * callout-based wakeups, so a critical section is a sufficient
 489          * interlock.
 490          *
 491          * The entire sequence through to where we actually sleep must
 492          * run without breaking the critical section.
 493          */
 494         catch = flags & PCATCH;
 495         error = 0;
 496         sig = 0;
 497
 498         crit_enter_quick(td);
 499
 500         KASSERT(ident != NULL, ("tsleep: no ident"));
 501         KASSERT(lp == NULL ||
 502                 lp->lwp_stat == LSRUN ||        /* Obvious */
 503                 lp->lwp_stat == LSSTOP,         /* Set in tstop */
 504                 ("tsleep %p %s %d",
 505                         ident, wmesg, lp->lwp_stat));
 506
 507         /*
 508          * We interlock the sleep queue if the caller has not already done
 509          * it for us.  This must be done before we potentially acquire any
 510          * tokens or we can loose the wakeup.
 511          */
 512         if ((flags & PINTERLOCKED) == 0) {
 513                 _tsleep_interlock(gd, ident, flags);
 514         }
 515
 516         /*
 517          * Setup for the current process (if this is a process).  We must
 518          * interlock with lwp_token to avoid remote wakeup races via
 519          * setrunnable()
 520          */
 521         if (lp) {
 522                 lwkt_gettoken(&lp->lwp_token);
 523                 if (catch) {
 524                         /*
 525                          * Early termination if PCATCH was set and a
 526                          * signal is pending, interlocked with the
 527                          * critical section.
 528                          *
 529                          * Early termination only occurs when tsleep() is
 530                          * entered while in a normal LSRUN state.
 531                          */
 532                         if ((sig = CURSIG(lp)) != 0)
 533                                 goto resume;
 534
 535                         /*
 536                          * Causes ksignal to wake us up if a signal is
 537                          * received (interlocked with p->p_token).
 538                          */
 539                         lp->lwp_flags |= LWP_SINTR;
 540                 }
 541         } else {
 542                 KKASSERT(p == NULL);
 543         }
 544
 545         /*
 546          * Make sure the current process has been untangled from
 547          * the userland scheduler and initialize slptime to start
 548          * counting.
 549          *
 550          * NOTE: td->td_wakefromcpu is pre-set by the release function
 551          *       for the dfly scheduler, and then adjusted by _wakeup()
 552          */
 553         if (lp) {
 554                 p->p_usched->release_curproc(lp);
 555                 lp->lwp_slptime = 0;
 556         }
 557
 558         /*
 559          * If the interlocked flag is set but our cpu bit in the slpqueue
 560          * is no longer set, then a wakeup was processed inbetween the
 561          * tsleep_interlock() (ours or the callers), and here.  This can
 562          * occur under numerous circumstances including when we release the
 563          * current process.
 564          *
 565          * Extreme loads can cause the sending of an IPI (e.g. wakeup()'s)
 566          * to process incoming IPIs, thus draining incoming wakeups.
 567          */
 568         if ((td->td_flags & TDF_TSLEEPQ) == 0) {
 569                 logtsleep2(ilockfail, ident);
 570                 goto resume;
 571         }
 572
 573         /*
 574          * scheduling is blocked while in a critical section.  Coincide
 575          * the descheduled-by-tsleep flag with the descheduling of the
 576          * lwkt.
 577          *
 578          * The timer callout is localized on our cpu and interlocked by
 579          * our critical section.
 580          */
 581         lwkt_deschedule_self(td);
 582         td->td_flags |= TDF_TSLEEP_DESCHEDULED;
 583         td->td_wmesg = wmesg;
 584
 585         /*
 586          * Setup the timeout, if any.  The timeout is only operable while
 587          * the thread is flagged descheduled.
 588          */
 589         KKASSERT((td->td_flags & TDF_TIMEOUT) == 0);
 590         if (timo) {
 591                 callout_init_mp(&thandle);
 592                 callout_reset(&thandle, timo, endtsleep, td);
 593         }
 594
 595         /*
 596          * Beddy bye bye.
 597          */
 598         if (lp) {
 599                 /*
 600                  * Ok, we are sleeping.  Place us in the SSLEEP state.
 601                  */
 602                 KKASSERT((lp->lwp_mpflags & LWP_MP_ONRUNQ) == 0);
 603
 604                 /*
 605                  * tstop() sets LSSTOP, so don't fiddle with that.
 606                  */
 607                 if (lp->lwp_stat != LSSTOP)
 608                         lp->lwp_stat = LSSLEEP;
 609                 lp->lwp_ru.ru_nvcsw++;
 610                 if (gd->gd_sleeping_lwp)
 611                         p->p_usched->uload_update(gd->gd_sleeping_lwp);
 612                 gd->gd_sleeping_lwp = lp;
 613                 lwkt_switch();
 614                 if (gd->gd_sleeping_lwp == lp)
 615                         gd->gd_sleeping_lwp = NULL;
 616                 p->p_usched->uload_update(lp);
 617
 618                 /*
 619                  * And when we are woken up, put us back in LSRUN.  If we
 620                  * slept for over a second, recalculate our estcpu.
 621                  */
 622                 lp->lwp_stat = LSRUN;
 623                 if (lp->lwp_slptime)
 624                         p->p_usched->recalculate(lp);
 625                 lp->lwp_slptime = 0;
 626         } else {
 627                 lwkt_switch();
 628         }
 629
 630         /*
 631          * Make sure we haven't switched cpus while we were asleep.  It's
 632          * not supposed to happen.  Cleanup our temporary flags.
 633          */
 634         KKASSERT(gd == td->td_gd);
 635
 636         /*
 637          * Cleanup the timeout.  If the timeout has already occured thandle
 638          * has already been stopped, otherwise stop thandle.  If the timeout
 639          * is running (the callout thread must be blocked trying to get
 640          * lwp_token) then wait for us to get scheduled.
 641          */
 642         if (timo) {
 643                 while (td->td_flags & TDF_TIMEOUT_RUNNING) {
 644                         lwkt_deschedule_self(td);
 645                         td->td_wmesg = "tsrace";
 646                         lwkt_switch();
 647                         kprintf("td %p %s: timeout race\n", td, td->td_comm);
 648                 }
 649                 if (td->td_flags & TDF_TIMEOUT) {
 650                         td->td_flags &= ~TDF_TIMEOUT;
 651                         error = EWOULDBLOCK;
 652                 } else {
 653                         /* does not block when on same cpu */
 654                         callout_stop(&thandle);
 655                 }
 656         }
 657         td->td_flags &= ~TDF_TSLEEP_DESCHEDULED;
 658
 659         /*
 660          * Make sure we have been removed from the sleepq.  In most
 661          * cases this will have been done for us already but it is
 662          * possible for a scheduling IPI to be in-flight from a
 663          * previous tsleep/tsleep_interlock() or due to a straight-out
 664          * call to lwkt_schedule() (in the case of an interrupt thread),
 665          * causing a spurious wakeup.
 666          */
 667         _tsleep_remove(td);
 668         td->td_wmesg = NULL;
 669
 670         /*
 671          * Figure out the correct error return.  If interrupted by a
 672          * signal we want to return EINTR or ERESTART.
 673          */
 674 resume:
 675         if (lp) {
 676                 if (catch && error == 0) {
 677                         if (sig != 0 || (sig = CURSIG(lp))) {
 678                                 if (SIGISMEMBER(p->p_sigacts->ps_sigintr, sig))
 679                                         error = EINTR;
 680                                 else
 681                                         error = ERESTART;
 682                         }
 683                 }
 684                 lp->lwp_flags &= ~LWP_SINTR;
 685                 lwkt_reltoken(&lp->lwp_token);
 686         }
 687         logtsleep1(tsleep_end);
 688         crit_exit_quick(td);
 689         return (error);
 690 }
 691
 692 /*
 693  * Interlocked spinlock sleep.  An exclusively held spinlock must
 694  * be passed to ssleep().  The function will atomically release the
 695  * spinlock and tsleep on the ident, then reacquire the spinlock and
 696  * return.
 697  *
 698  * This routine is fairly important along the critical path, so optimize it
 699  * heavily.
 700  */
 701 int
 702 ssleep(const volatile void *ident, struct spinlock *spin, int flags,
 703        const char *wmesg, int timo)
 704 {
 705         globaldata_t gd = mycpu;
 706         int error;
 707
 708         _tsleep_interlock(gd, ident, flags);
 709         spin_unlock_quick(gd, spin);
 710         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 711         spin_lock_quick(gd, spin);
 712
 713         return (error);
 714 }
 715
 716 int
 717 lksleep(const volatile void *ident, struct lock *lock, int flags,
 718         const char *wmesg, int timo)
 719 {
 720         globaldata_t gd = mycpu;
 721         int error;
 722
 723         _tsleep_interlock(gd, ident, flags);
 724         lockmgr(lock, LK_RELEASE);
 725         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 726         lockmgr(lock, LK_EXCLUSIVE);
 727
 728         return (error);
 729 }
 730
 731 /*
 732  * Interlocked mutex sleep.  An exclusively held mutex must be passed
 733  * to mtxsleep().  The function will atomically release the mutex
 734  * and tsleep on the ident, then reacquire the mutex and return.
 735  */
 736 int
 737 mtxsleep(const volatile void *ident, struct mtx *mtx, int flags,
 738          const char *wmesg, int timo)
 739 {
 740         globaldata_t gd = mycpu;
 741         int error;
 742
 743         _tsleep_interlock(gd, ident, flags);
 744         mtx_unlock(mtx);
 745         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 746         mtx_lock_ex_quick(mtx, wmesg);
 747
 748         return (error);
 749 }
 750
 751 /*
 752  * Interlocked serializer sleep.  An exclusively held serializer must
 753  * be passed to zsleep().  The function will atomically release
 754  * the serializer and tsleep on the ident, then reacquire the serializer
 755  * and return.
 756  */
 757 int
 758 zsleep(const volatile void *ident, struct lwkt_serialize *slz, int flags,
 759        const char *wmesg, int timo)
 760 {
 761         globaldata_t gd = mycpu;
 762         int ret;
 763
 764         ASSERT_SERIALIZED(slz);
 765
 766         _tsleep_interlock(gd, ident, flags);
 767         lwkt_serialize_exit(slz);
 768         ret = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
 769         lwkt_serialize_enter(slz);
 770
 771         return ret;
 772 }
 773
 774 /*
 775  * Directly block on the LWKT thread by descheduling it.  This
 776  * is much faster then tsleep(), but the only legal way to wake
 777  * us up is to directly schedule the thread.
 778  *
 779  * Setting TDF_SINTR will cause new signals to directly schedule us.
 780  *
 781  * This routine must be called while in a critical section.
 782  */
 783 int
 784 lwkt_sleep(const char *wmesg, int flags)
 785 {
 786         thread_t td = curthread;
 787         int sig;
 788
 789         if ((flags & PCATCH) == 0 || td->td_lwp == NULL) {
 790                 td->td_flags |= TDF_BLOCKED;
 791                 td->td_wmesg = wmesg;
 792                 lwkt_deschedule_self(td);
 793                 lwkt_switch();
 794                 td->td_wmesg = NULL;
 795                 td->td_flags &= ~TDF_BLOCKED;
 796                 return(0);
 797         }
 798         if ((sig = CURSIG(td->td_lwp)) != 0) {
 799                 if (SIGISMEMBER(td->td_proc->p_sigacts->ps_sigintr, sig))
 800                         return(EINTR);
 801                 else
 802                         return(ERESTART);
 803
 804         }
 805         td->td_flags |= TDF_BLOCKED | TDF_SINTR;
 806         td->td_wmesg = wmesg;
 807         lwkt_deschedule_self(td);
 808         lwkt_switch();
 809         td->td_flags &= ~(TDF_BLOCKED | TDF_SINTR);
 810         td->td_wmesg = NULL;
 811         return(0);
 812 }
 813
 814 /*
 815  * Implement the timeout for tsleep.
 816  *
 817  * This type of callout timeout is scheduled on the same cpu the process
 818  * is sleeping on.  Also, at the moment, the MP lock is held.
 819  */
 820 static void
 821 endtsleep(void *arg)
 822 {
 823         thread_t td = arg;
 824         struct lwp *lp;
 825
 826         /*
 827          * We are going to have to get the lwp_token, which means we might
 828          * block.  This can race a tsleep getting woken up by other means
 829          * so set TDF_TIMEOUT_RUNNING to force the tsleep to wait for our
 830          * processing to complete (sorry tsleep!).
 831          *
 832          * We can safely set td_flags because td MUST be on the same cpu
 833          * as we are.
 834          */
 835         KKASSERT(td->td_gd == mycpu);
 836         crit_enter();
 837         td->td_flags |= TDF_TIMEOUT_RUNNING | TDF_TIMEOUT;
 838
 839         /*
 840          * This can block but TDF_TIMEOUT_RUNNING will prevent the thread
 841          * from exiting the tsleep on us.  The flag is interlocked by virtue
 842          * of lp being on the same cpu as we are.
 843          */
 844         if ((lp = td->td_lwp) != NULL)
 845                 lwkt_gettoken(&lp->lwp_token);
 846
 847         KKASSERT(td->td_flags & TDF_TSLEEP_DESCHEDULED);
 848
 849         if (lp) {
 850                 if (lp->lwp_proc->p_stat != SSTOP)
 851                         setrunnable(lp);
 852                 lwkt_reltoken(&lp->lwp_token);
 853         } else {
 854                 _tsleep_remove(td);
 855                 lwkt_schedule(td);
 856         }
 857         KKASSERT(td->td_gd == mycpu);
 858         td->td_flags &= ~TDF_TIMEOUT_RUNNING;
 859         crit_exit();
 860 }
 861
 862 /*
 863  * Make all processes sleeping on the specified identifier runnable.
 864  * count may be zero or one only.
 865  *
 866  * The domain encodes the sleep/wakeup domain, flags, plus the originating
 867  * cpu.
 868  *
 869  * This call may run without the MP lock held.  We can only manipulate thread
 870  * state on the cpu owning the thread.  We CANNOT manipulate process state
 871  * at all.
 872  *
 873  * _wakeup() can be passed to an IPI so we can't use (const volatile
 874  * void *ident).
 875  */
 876 static void
 877 _wakeup(void *ident, int domain)
 878 {
 879         struct tslpque *qp;
 880         struct thread *td;
 881         struct thread *ntd;
 882         globaldata_t gd;
 883 #ifdef SMP
 884         cpumask_t mask;
 885 #endif
 886         int id;
 887
 888         crit_enter();
 889         logtsleep2(wakeup_beg, ident);
 890         gd = mycpu;
 891         id = LOOKUP(ident);
 892         qp = &gd->gd_tsleep_hash[id];
 893 restart:
 894         for (td = TAILQ_FIRST(qp); td != NULL; td = ntd) {
 895                 ntd = TAILQ_NEXT(td, td_sleepq);
 896                 if (td->td_wchan == ident &&
 897                     td->td_wdomain == (domain & PDOMAIN_MASK)
 898                 ) {
 899                         KKASSERT(td->td_gd == gd);
 900                         _tsleep_remove(td);
 901                         td->td_wakefromcpu = PWAKEUP_DECODE(domain);
 902                         if (td->td_flags & TDF_TSLEEP_DESCHEDULED) {
 903                                 lwkt_schedule(td);
 904                                 if (domain & PWAKEUP_ONE)
 905                                         goto done;
 906                         }
 907                         goto restart;
 908                 }
 909         }
 910
 911 #ifdef SMP
 912         /*
 913          * We finished checking the current cpu but there still may be
 914          * more work to do.  Either wakeup_one was requested and no matching
 915          * thread was found, or a normal wakeup was requested and we have
 916          * to continue checking cpus.
 917          *
 918          * It should be noted that this scheme is actually less expensive then
 919          * the old scheme when waking up multiple threads, since we send
 920          * only one IPI message per target candidate which may then schedule
 921          * multiple threads.  Before we could have wound up sending an IPI
 922          * message for each thread on the target cpu (!= current cpu) that
 923          * needed to be woken up.
 924          *
 925          * NOTE: Wakeups occuring on remote cpus are asynchronous.  This
 926          * should be ok since we are passing idents in the IPI rather then
 927          * thread pointers.
 928          */
 929         if ((domain & PWAKEUP_MYCPU) == 0 &&
 930             (mask = slpque_cpumasks[id] & gd->gd_other_cpus) != 0) {
 931                 lwkt_send_ipiq2_mask(mask, _wakeup, ident,
 932                                      domain | PWAKEUP_MYCPU);
 933         }
 934 #endif
 935 done:
 936         logtsleep1(wakeup_end);
 937         crit_exit();
 938 }
 939
 940 /*
 941  * Wakeup all threads tsleep()ing on the specified ident, on all cpus
 942  */
 943 void
 944 wakeup(const volatile void *ident)
 945 {
 946     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid));
 947 }
 948
 949 /*
 950  * Wakeup one thread tsleep()ing on the specified ident, on any cpu.
 951  */
 952 void
 953 wakeup_one(const volatile void *ident)
 954 {
 955     /* XXX potentially round-robin the first responding cpu */
 956     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) |
 957                             PWAKEUP_ONE);
 958 }
 959
 960 /*
 961  * Wakeup threads tsleep()ing on the specified ident on the current cpu
 962  * only.
 963  */
 964 void
 965 wakeup_mycpu(const volatile void *ident)
 966 {
 967     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) |
 968                             PWAKEUP_MYCPU);
 969 }
 970
 971 /*
 972  * Wakeup one thread tsleep()ing on the specified ident on the current cpu
 973  * only.
 974  */
 975 void
 976 wakeup_mycpu_one(const volatile void *ident)
 977 {
 978     /* XXX potentially round-robin the first responding cpu */
 979     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) |
 980                             PWAKEUP_MYCPU | PWAKEUP_ONE);
 981 }
 982
 983 /*
 984  * Wakeup all thread tsleep()ing on the specified ident on the specified cpu
 985  * only.
 986  */
 987 void
 988 wakeup_oncpu(globaldata_t gd, const volatile void *ident)
 989 {
 990 #ifdef SMP
 991     globaldata_t mygd = mycpu;
 992     if (gd == mycpu) {
 993         _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
 994                                 PWAKEUP_MYCPU);
 995     } else {
 996         lwkt_send_ipiq2(gd, _wakeup, __DEALL(ident),
 997                         PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
 998                         PWAKEUP_MYCPU);
 999     }
1000 #else
1001     _wakeup(__DEALL(ident), PWAKEUP_MYCPU);
1002 #endif
1003 }
1004
1005 /*
1006  * Wakeup one thread tsleep()ing on the specified ident on the specified cpu
1007  * only.
1008  */
1009 void
1010 wakeup_oncpu_one(globaldata_t gd, const volatile void *ident)
1011 {
1012 #ifdef SMP
1013     globaldata_t mygd = mycpu;
1014     if (gd == mygd) {
1015         _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
1016                                 PWAKEUP_MYCPU | PWAKEUP_ONE);
1017     } else {
1018         lwkt_send_ipiq2(gd, _wakeup, __DEALL(ident),
1019                         PWAKEUP_ENCODE(0, mygd->gd_cpuid) |
1020                         PWAKEUP_MYCPU | PWAKEUP_ONE);
1021     }
1022 #else
1023     _wakeup(__DEALL(ident), PWAKEUP_MYCPU | PWAKEUP_ONE);
1024 #endif
1025 }
1026
1027 /*
1028  * Wakeup all threads waiting on the specified ident that slept using
1029  * the specified domain, on all cpus.
1030  */
1031 void
1032 wakeup_domain(const volatile void *ident, int domain)
1033 {
1034     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(domain, mycpu->gd_cpuid));
1035 }
1036
1037 /*
1038  * Wakeup one thread waiting on the specified ident that slept using
1039  * the specified  domain, on any cpu.
1040  */
1041 void
1042 wakeup_domain_one(const volatile void *ident, int domain)
1043 {
1044     /* XXX potentially round-robin the first responding cpu */
1045     _wakeup(__DEALL(ident),
1046             PWAKEUP_ENCODE(domain, mycpu->gd_cpuid) | PWAKEUP_ONE);
1047 }
1048
1049 /*
1050  * setrunnable()
1051  *
1052  * Make a process runnable.  lp->lwp_token must be held on call and this
1053  * function must be called from the cpu owning lp.
1054  *
1055  * This only has an effect if we are in LSSTOP or LSSLEEP.
1056  */
1057 void
1058 setrunnable(struct lwp *lp)
1059 {
1060         thread_t td = lp->lwp_thread;
1061
1062         ASSERT_LWKT_TOKEN_HELD(&lp->lwp_token);
1063         KKASSERT(td->td_gd == mycpu);
1064         crit_enter();
1065         if (lp->lwp_stat == LSSTOP)
1066                 lp->lwp_stat = LSSLEEP;
1067         if (lp->lwp_stat == LSSLEEP) {
1068                 _tsleep_remove(td);
1069                 lwkt_schedule(td);
1070         } else if (td->td_flags & TDF_SINTR) {
1071                 lwkt_schedule(td);
1072         }
1073         crit_exit();
1074 }
1075
1076 /*
1077  * The process is stopped due to some condition, usually because p_stat is
1078  * set to SSTOP, but also possibly due to being traced.
1079  *
1080  * Caller must hold p->p_token
1081  *
1082  * NOTE!  If the caller sets SSTOP, the caller must also clear P_WAITED
1083  * because the parent may check the child's status before the child actually
1084  * gets to this routine.
1085  *
1086  * This routine is called with the current lwp only, typically just
1087  * before returning to userland if the process state is detected as
1088  * possibly being in a stopped state.
1089  */
1090 void
1091 tstop(void)
1092 {
1093         struct lwp *lp = curthread->td_lwp;
1094         struct proc *p = lp->lwp_proc;
1095         struct proc *q;
1096
1097         lwkt_gettoken(&lp->lwp_token);
1098         crit_enter();
1099
1100         /*
1101          * If LWP_MP_WSTOP is set, we were sleeping
1102          * while our process was stopped.  At this point
1103          * we were already counted as stopped.
1104          */
1105         if ((lp->lwp_mpflags & LWP_MP_WSTOP) == 0) {
1106                 /*
1107                  * If we're the last thread to stop, signal
1108                  * our parent.
1109                  */
1110                 p->p_nstopped++;
1111                 atomic_set_int(&lp->lwp_mpflags, LWP_MP_WSTOP);
1112                 wakeup(&p->p_nstopped);
1113                 if (p->p_nstopped == p->p_nthreads) {
1114                         /*
1115                          * Token required to interlock kern_wait()
1116                          */
1117                         q = p->p_pptr;
1118                         PHOLD(q);
1119                         lwkt_gettoken(&q->p_token);
1120                         p->p_flags &= ~P_WAITED;
1121                         wakeup(p->p_pptr);
1122                         if ((q->p_sigacts->ps_flag & PS_NOCLDSTOP) == 0)
1123                                 ksignal(q, SIGCHLD);
1124                         lwkt_reltoken(&q->p_token);
1125                         PRELE(q);
1126                 }
1127         }
1128         while (p->p_stat == SSTOP) {
1129                 lp->lwp_stat = LSSTOP;
1130                 tsleep(p, 0, "stop", 0);
1131         }
1132         p->p_nstopped--;
1133         atomic_clear_int(&lp->lwp_mpflags, LWP_MP_WSTOP);
1134         crit_exit();
1135         lwkt_reltoken(&lp->lwp_token);
1136 }
1137
1138 /*
1139  * Compute a tenex style load average of a quantity on
1140  * 1, 5 and 15 minute intervals.
1141  */
1142 static int loadav_count_runnable(struct lwp *p, void *data);
1143
1144 static void
1145 loadav(void *arg)
1146 {
1147         struct loadavg *avg;
1148         int i, nrun;
1149
1150         nrun = 0;
1151         alllwp_scan(loadav_count_runnable, &nrun);
1152         avg = &averunnable;
1153         for (i = 0; i < 3; i++) {
1154                 avg->ldavg[i] = (cexp[i] * avg->ldavg[i] +
1155                     nrun * FSCALE * (FSCALE - cexp[i])) >> FSHIFT;
1156         }
1157
1158         /*
1159          * Schedule the next update to occur after 5 seconds, but add a
1160          * random variation to avoid synchronisation with processes that
1161          * run at regular intervals.
1162          */
1163         callout_reset(&loadav_callout, hz * 4 + (int)(krandom() % (hz * 2 + 1)),
1164                       loadav, NULL);
1165 }
1166
1167 static int
1168 loadav_count_runnable(struct lwp *lp, void *data)
1169 {
1170         int *nrunp = data;
1171         thread_t td;
1172
1173         switch (lp->lwp_stat) {
1174         case LSRUN:
1175                 if ((td = lp->lwp_thread) == NULL)
1176                         break;
1177                 if (td->td_flags & TDF_BLOCKED)
1178                         break;
1179                 ++*nrunp;
1180                 break;
1181         default:
1182                 break;
1183         }
1184         lwkt_yield();
1185         return(0);
1186 }
1187
1188 /* ARGSUSED */
1189 static void
1190 sched_setup(void *dummy)
1191 {
1192         callout_init_mp(&loadav_callout);
1193         callout_init_mp(&schedcpu_callout);
1194
1195         /* Kick off timeout driven events by calling first time. */
1196         schedcpu(NULL);
1197         loadav(NULL);
1198 }
1199