6d182a97f79804d08fc1d111d0e29fc1fc6c0a5f
[dragonfly.git] / 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 int     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", sizeof(void *));
97 KTR_INFO(KTR_TSLEEP, tsleep, tsleep_end, 1, "tsleep exit", 0);
98 KTR_INFO(KTR_TSLEEP, tsleep, wakeup_beg, 2, "wakeup enter %p", sizeof(void *));
99 KTR_INFO(KTR_TSLEEP, tsleep, wakeup_end, 3, "wakeup exit", 0);
100 KTR_INFO(KTR_TSLEEP, tsleep, ilockfail,  4, "interlock failed %p", sizeof(void *));
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 #ifdef SMP
121 static void     tsleep_wakeup_remote(struct thread *td);
122 #endif
123
124 /*
125  * Adjust the scheduler quantum.  The quantum is specified in microseconds.
126  * Note that 'tick' is in microseconds per tick.
127  */
128 static int
129 sysctl_kern_quantum(SYSCTL_HANDLER_ARGS)
130 {
131         int error, new_val;
132
133         new_val = sched_quantum * ustick;
134         error = sysctl_handle_int(oidp, &new_val, 0, req);
135         if (error != 0 || req->newptr == NULL)
136                 return (error);
137         if (new_val < ustick)
138                 return (EINVAL);
139         sched_quantum = new_val / ustick;
140         hogticks = 2 * sched_quantum;
141         return (0);
142 }
143
144 SYSCTL_PROC(_kern, OID_AUTO, quantum, CTLTYPE_INT|CTLFLAG_RW,
145         0, sizeof sched_quantum, sysctl_kern_quantum, "I", "");
146
147 /*
148  * If `ccpu' is not equal to `exp(-1/20)' and you still want to use the
149  * faster/more-accurate formula, you'll have to estimate CCPU_SHIFT below
150  * and possibly adjust FSHIFT in "param.h" so that (FSHIFT >= CCPU_SHIFT).
151  *
152  * To estimate CCPU_SHIFT for exp(-1/20), the following formula was used:
153  *     1 - exp(-1/20) ~= 0.0487 ~= 0.0488 == 1 (fixed pt, *11* bits).
154  *
155  * If you don't want to bother with the faster/more-accurate formula, you
156  * can set CCPU_SHIFT to (FSHIFT + 1) which will use a slower/less-accurate
157  * (more general) method of calculating the %age of CPU used by a process.
158  *
159  * decay 95% of `lwp_pctcpu' in 60 seconds; see CCPU_SHIFT before changing
160  */
161 #define CCPU_SHIFT      11
162
163 static fixpt_t ccpu = 0.95122942450071400909 * FSCALE; /* exp(-1/20) */
164 SYSCTL_INT(_kern, OID_AUTO, ccpu, CTLFLAG_RD, &ccpu, 0, "");
165
166 /*
167  * kernel uses `FSCALE', userland (SHOULD) use kern.fscale 
168  */
169 int     fscale __unused = FSCALE;       /* exported to systat */
170 SYSCTL_INT(_kern, OID_AUTO, fscale, CTLFLAG_RD, 0, FSCALE, "");
171
172 /*
173  * Recompute process priorities, once a second.
174  *
175  * Since the userland schedulers are typically event oriented, if the
176  * estcpu calculation at wakeup() time is not sufficient to make a
177  * process runnable relative to other processes in the system we have
178  * a 1-second recalc to help out.
179  *
180  * This code also allows us to store sysclock_t data in the process structure
181  * without fear of an overrun, since sysclock_t are guarenteed to hold 
182  * several seconds worth of count.
183  *
184  * WARNING!  callouts can preempt normal threads.  However, they will not
185  * preempt a thread holding a spinlock so we *can* safely use spinlocks.
186  */
187 static int schedcpu_stats(struct proc *p, void *data __unused);
188 static int schedcpu_resource(struct proc *p, void *data __unused);
189
190 static void
191 schedcpu(void *arg)
192 {
193         allproc_scan(schedcpu_stats, NULL);
194         allproc_scan(schedcpu_resource, NULL);
195         wakeup((caddr_t)&lbolt);
196         wakeup((caddr_t)&lbolt_syncer);
197         callout_reset(&schedcpu_callout, hz, schedcpu, NULL);
198 }
199
200 /*
201  * General process statistics once a second
202  */
203 static int
204 schedcpu_stats(struct proc *p, void *data __unused)
205 {
206         struct lwp *lp;
207
208         /*
209          * Threads may not be completely set up if process in SIDL state.
210          */
211         if (p->p_stat == SIDL)
212                 return(0);
213
214         PHOLD(p);
215         if (lwkt_trytoken(&p->p_token) == FALSE) {
216                 PRELE(p);
217                 return(0);
218         }
219
220         p->p_swtime++;
221         FOREACH_LWP_IN_PROC(lp, p) {
222                 if (lp->lwp_stat == LSSLEEP)
223                         lp->lwp_slptime++;
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_flag & P_XCPU) == 0) {
285                         p->p_flag |= 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  */
406 static __inline void
407 _tsleep_remove(thread_t td)
408 {
409         globaldata_t gd = mycpu;
410         int id;
411
412         KKASSERT(td->td_gd == gd && IN_CRITICAL_SECT(td));
413         if (td->td_flags & TDF_TSLEEPQ) {
414                 td->td_flags &= ~TDF_TSLEEPQ;
415                 id = LOOKUP(td->td_wchan);
416                 TAILQ_REMOVE(&gd->gd_tsleep_hash[id], td, td_sleepq);
417                 if (TAILQ_FIRST(&gd->gd_tsleep_hash[id]) == NULL)
418                         atomic_clear_cpumask(&slpque_cpumasks[id], gd->gd_cpumask);
419                 td->td_wchan = NULL;
420                 td->td_wdomain = 0;
421         }
422 }
423
424 void
425 tsleep_remove(thread_t td)
426 {
427         _tsleep_remove(td);
428 }
429
430 /*
431  * This function removes a thread from the tsleep queue and schedules
432  * it.  This function may act asynchronously.  The target thread may be
433  * sleeping on a different cpu.
434  *
435  * This function mus be called while in a critical section but if the
436  * target thread is sleeping on a different cpu we cannot safely probe
437  * td_flags.
438  *
439  * This function is only called from a different cpu via setrunnable()
440  * when the thread is in a known sleep.  However, multiple wakeups are
441  * possible and we must hold the td to prevent a race against the thread
442  * exiting.
443  */
444 static __inline
445 void
446 _tsleep_wakeup(struct thread *td)
447 {
448 #ifdef SMP
449         globaldata_t gd = mycpu;
450
451         if (td->td_gd != gd) {
452                 lwkt_hold(td);
453                 lwkt_send_ipiq(td->td_gd, (ipifunc1_t)tsleep_wakeup_remote, td);
454                 return;
455         }
456 #endif
457         _tsleep_remove(td);
458         if (td->td_flags & TDF_TSLEEP_DESCHEDULED) {
459                 td->td_flags &= ~TDF_TSLEEP_DESCHEDULED;
460                 lwkt_schedule(td);
461         }
462 }
463
464 #ifdef SMP
465 static
466 void
467 tsleep_wakeup_remote(struct thread *td)
468 {
469         _tsleep_wakeup(td);
470         lwkt_rele(td);
471 }
472 #endif
473
474
475 /*
476  * General sleep call.  Suspends the current process until a wakeup is
477  * performed on the specified identifier.  The process will then be made
478  * runnable with the specified priority.  Sleeps at most timo/hz seconds
479  * (0 means no timeout).  If flags includes PCATCH flag, signals are checked
480  * before and after sleeping, else signals are not checked.  Returns 0 if
481  * awakened, EWOULDBLOCK if the timeout expires.  If PCATCH is set and a
482  * signal needs to be delivered, ERESTART is returned if the current system
483  * call should be restarted if possible, and EINTR is returned if the system
484  * call should be interrupted by the signal (return EINTR).
485  *
486  * Note that if we are a process, we release_curproc() before messing with
487  * the LWKT scheduler.
488  *
489  * During autoconfiguration or after a panic, a sleep will simply
490  * lower the priority briefly to allow interrupts, then return.
491  *
492  * WARNING!  This code can't block (short of switching away), or bad things
493  *           will happen.  No getting tokens, no blocking locks, etc.
494  */
495 int
496 tsleep(const volatile void *ident, int flags, const char *wmesg, int timo)
497 {
498         struct thread *td = curthread;
499         struct lwp *lp = td->td_lwp;
500         struct proc *p = td->td_proc;           /* may be NULL */
501         globaldata_t gd;
502         int sig;
503         int catch;
504         int error;
505         int oldpri;
506         struct callout thandle;
507
508         /*
509          * NOTE: removed KTRPOINT, it could cause races due to blocking
510          * even in stable.  Just scrap it for now.
511          */
512         if (!tsleep_crypto_dump && (tsleep_now_works == 0 || panicstr)) {
513                 /*
514                  * After a panic, or before we actually have an operational
515                  * softclock, just give interrupts a chance, then just return;
516                  *
517                  * don't run any other procs or panic below,
518                  * in case this is the idle process and already asleep.
519                  */
520                 splz();
521                 oldpri = td->td_pri;
522                 lwkt_setpri_self(safepri);
523                 lwkt_switch();
524                 lwkt_setpri_self(oldpri);
525                 return (0);
526         }
527         logtsleep2(tsleep_beg, ident);
528         gd = td->td_gd;
529         KKASSERT(td != &gd->gd_idlethread);     /* you must be kidding! */
530
531         /*
532          * NOTE: all of this occurs on the current cpu, including any
533          * callout-based wakeups, so a critical section is a sufficient
534          * interlock.
535          *
536          * The entire sequence through to where we actually sleep must
537          * run without breaking the critical section.
538          */
539         catch = flags & PCATCH;
540         error = 0;
541         sig = 0;
542
543         crit_enter_quick(td);
544
545         KASSERT(ident != NULL, ("tsleep: no ident"));
546         KASSERT(lp == NULL ||
547                 lp->lwp_stat == LSRUN ||        /* Obvious */
548                 lp->lwp_stat == LSSTOP,         /* Set in tstop */
549                 ("tsleep %p %s %d",
550                         ident, wmesg, lp->lwp_stat));
551
552         /*
553          * We interlock the sleep queue if the caller has not already done
554          * it for us.  This must be done before we potentially acquire any
555          * tokens or we can loose the wakeup.
556          */
557         if ((flags & PINTERLOCKED) == 0) {
558                 _tsleep_interlock(gd, ident, flags);
559         }
560
561         /*
562          * Setup for the current process (if this is a process). 
563          *
564          * We hold the process token if lp && catch.  The resume
565          * code will release it.
566          */
567         if (lp) {
568                 if (catch) {
569                         /*
570                          * Early termination if PCATCH was set and a
571                          * signal is pending, interlocked with the
572                          * critical section.
573                          *
574                          * Early termination only occurs when tsleep() is
575                          * entered while in a normal LSRUN state.
576                          */
577                         if ((sig = CURSIG(lp)) != 0)
578                                 goto resume;
579
580                         /*
581                          * Causes ksignal to wake us up if a signal is
582                          * received (interlocked with p->p_token).
583                          */
584                         lp->lwp_flag |= LWP_SINTR;
585                 }
586         } else {
587                 KKASSERT(p == NULL);
588         }
589
590         /*
591          * Make sure the current process has been untangled from
592          * the userland scheduler and initialize slptime to start
593          * counting.
594          */
595         if (lp) {
596                 p->p_usched->release_curproc(lp);
597                 lp->lwp_slptime = 0;
598         }
599
600         /*
601          * If the interlocked flag is set but our cpu bit in the slpqueue
602          * is no longer set, then a wakeup was processed inbetween the
603          * tsleep_interlock() (ours or the callers), and here.  This can
604          * occur under numerous circumstances including when we release the
605          * current process.
606          *
607          * Extreme loads can cause the sending of an IPI (e.g. wakeup()'s)
608          * to process incoming IPIs, thus draining incoming wakeups.
609          */
610         if ((td->td_flags & TDF_TSLEEPQ) == 0) {
611                 logtsleep2(ilockfail, ident);
612                 goto resume;
613         }
614
615         /*
616          * scheduling is blocked while in a critical section.  Coincide
617          * the descheduled-by-tsleep flag with the descheduling of the
618          * lwkt.
619          *
620          * The timer callout is localized on our cpu and interlocked by
621          * our critical section.
622          */
623         lwkt_deschedule_self(td);
624         td->td_flags |= TDF_TSLEEP_DESCHEDULED;
625         td->td_wmesg = wmesg;
626
627         /*
628          * Setup the timeout, if any.  The timeout is only operable while
629          * the thread is flagged descheduled.
630          */
631         KKASSERT((td->td_flags & TDF_TIMEOUT) == 0);
632         if (timo) {
633                 callout_init_mp(&thandle);
634                 callout_reset(&thandle, timo, endtsleep, td);
635         }
636
637         /*
638          * Beddy bye bye.
639          */
640         if (lp) {
641                 /*
642                  * Ok, we are sleeping.  Place us in the SSLEEP state.
643                  */
644                 KKASSERT((lp->lwp_flag & LWP_ONRUNQ) == 0);
645                 /*
646                  * tstop() sets LSSTOP, so don't fiddle with that.
647                  */
648                 if (lp->lwp_stat != LSSTOP)
649                         lp->lwp_stat = LSSLEEP;
650                 lp->lwp_ru.ru_nvcsw++;
651                 lwkt_switch();
652                 td->td_flags &= ~TDF_TSLEEP_DESCHEDULED;
653
654                 /*
655                  * And when we are woken up, put us back in LSRUN.  If we
656                  * slept for over a second, recalculate our estcpu.
657                  */
658                 lp->lwp_stat = LSRUN;
659                 if (lp->lwp_slptime)
660                         p->p_usched->recalculate(lp);
661                 lp->lwp_slptime = 0;
662         } else {
663                 lwkt_switch();
664                 td->td_flags &= ~TDF_TSLEEP_DESCHEDULED;
665         }
666
667         /* 
668          * Make sure we haven't switched cpus while we were asleep.  It's
669          * not supposed to happen.  Cleanup our temporary flags.
670          */
671         KKASSERT(gd == td->td_gd);
672
673         /*
674          * Cleanup the timeout.  If the timeout has already occured thandle
675          * has already been stopped, otherwise stop thandle.
676          */
677         if (timo) {
678                 if (td->td_flags & TDF_TIMEOUT) {
679                         td->td_flags &= ~TDF_TIMEOUT;
680                         error = EWOULDBLOCK;
681                 } else {
682                         /* does not block when on same cpu */
683                         callout_stop(&thandle);
684                 }
685         }
686
687         /*
688          * Make sure we have been removed from the sleepq.  In most
689          * cases this will have been done for us already but it is
690          * possible for a scheduling IPI to be in-flight from a
691          * previous tsleep/tsleep_interlock() or due to a straight-out
692          * call to lwkt_schedule() (in the case of an interrupt thread),
693          * causing a spurious wakeup.
694          */
695         _tsleep_remove(td);
696         td->td_wmesg = NULL;
697
698         /*
699          * Figure out the correct error return.  If interrupted by a
700          * signal we want to return EINTR or ERESTART.  
701          */
702 resume:
703         if (p) {
704                 if (catch && error == 0) {
705                         if (sig != 0 || (sig = CURSIG(lp))) {
706                                 if (SIGISMEMBER(p->p_sigacts->ps_sigintr, sig))
707                                         error = EINTR;
708                                 else
709                                         error = ERESTART;
710                         }
711                 }
712                 lp->lwp_flag &= ~(LWP_BREAKTSLEEP | LWP_SINTR);
713         }
714         logtsleep1(tsleep_end);
715         crit_exit_quick(td);
716         return (error);
717 }
718
719 /*
720  * Interlocked spinlock sleep.  An exclusively held spinlock must
721  * be passed to ssleep().  The function will atomically release the
722  * spinlock and tsleep on the ident, then reacquire the spinlock and
723  * return.
724  *
725  * This routine is fairly important along the critical path, so optimize it
726  * heavily.
727  */
728 int
729 ssleep(const volatile void *ident, struct spinlock *spin, int flags,
730        const char *wmesg, int timo)
731 {
732         globaldata_t gd = mycpu;
733         int error;
734
735         _tsleep_interlock(gd, ident, flags);
736         spin_unlock_quick(gd, spin);
737         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
738         spin_lock_quick(gd, spin);
739
740         return (error);
741 }
742
743 int
744 lksleep(const volatile void *ident, struct lock *lock, int flags,
745         const char *wmesg, int timo)
746 {
747         globaldata_t gd = mycpu;
748         int error;
749
750         _tsleep_interlock(gd, ident, flags);
751         lockmgr(lock, LK_RELEASE);
752         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
753         lockmgr(lock, LK_EXCLUSIVE);
754
755         return (error);
756 }
757
758 /*
759  * Interlocked mutex sleep.  An exclusively held mutex must be passed
760  * to mtxsleep().  The function will atomically release the mutex
761  * and tsleep on the ident, then reacquire the mutex and return.
762  */
763 int
764 mtxsleep(const volatile void *ident, struct mtx *mtx, int flags,
765          const char *wmesg, int timo)
766 {
767         globaldata_t gd = mycpu;
768         int error;
769
770         _tsleep_interlock(gd, ident, flags);
771         mtx_unlock(mtx);
772         error = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
773         mtx_lock_ex_quick(mtx, wmesg);
774
775         return (error);
776 }
777
778 /*
779  * Interlocked serializer sleep.  An exclusively held serializer must
780  * be passed to zsleep().  The function will atomically release
781  * the serializer and tsleep on the ident, then reacquire the serializer
782  * and return.
783  */
784 int
785 zsleep(const volatile void *ident, struct lwkt_serialize *slz, int flags,
786        const char *wmesg, int timo)
787 {
788         globaldata_t gd = mycpu;
789         int ret;
790
791         ASSERT_SERIALIZED(slz);
792
793         _tsleep_interlock(gd, ident, flags);
794         lwkt_serialize_exit(slz);
795         ret = tsleep(ident, flags | PINTERLOCKED, wmesg, timo);
796         lwkt_serialize_enter(slz);
797
798         return ret;
799 }
800
801 /*
802  * Directly block on the LWKT thread by descheduling it.  This
803  * is much faster then tsleep(), but the only legal way to wake
804  * us up is to directly schedule the thread.
805  *
806  * Setting TDF_SINTR will cause new signals to directly schedule us.
807  *
808  * This routine must be called while in a critical section.
809  */
810 int
811 lwkt_sleep(const char *wmesg, int flags)
812 {
813         thread_t td = curthread;
814         int sig;
815
816         if ((flags & PCATCH) == 0 || td->td_lwp == NULL) {
817                 td->td_flags |= TDF_BLOCKED;
818                 td->td_wmesg = wmesg;
819                 lwkt_deschedule_self(td);
820                 lwkt_switch();
821                 td->td_wmesg = NULL;
822                 td->td_flags &= ~TDF_BLOCKED;
823                 return(0);
824         }
825         if ((sig = CURSIG(td->td_lwp)) != 0) {
826                 if (SIGISMEMBER(td->td_proc->p_sigacts->ps_sigintr, sig))
827                         return(EINTR);
828                 else
829                         return(ERESTART);
830                         
831         }
832         td->td_flags |= TDF_BLOCKED | TDF_SINTR;
833         td->td_wmesg = wmesg;
834         lwkt_deschedule_self(td);
835         lwkt_switch();
836         td->td_flags &= ~(TDF_BLOCKED | TDF_SINTR);
837         td->td_wmesg = NULL;
838         return(0);
839 }
840
841 /*
842  * Implement the timeout for tsleep.
843  *
844  * We set LWP_BREAKTSLEEP to indicate that an event has occured, but
845  * we only call setrunnable if the process is not stopped.
846  *
847  * This type of callout timeout is scheduled on the same cpu the process
848  * is sleeping on.  Also, at the moment, the MP lock is held.
849  */
850 static void
851 endtsleep(void *arg)
852 {
853         thread_t td = arg;
854         struct lwp *lp;
855
856         KKASSERT(td->td_gd == mycpu);
857         crit_enter();
858
859         /*
860          * Do this before we potentially block acquiring the token.  Setting
861          * TDF_TIMEOUT tells tsleep that we have already stopped the callout.
862          */
863         lwkt_hold(td);
864         td->td_flags |= TDF_TIMEOUT;
865
866         /*
867          * This can block
868          */
869         if ((lp = td->td_lwp) != NULL)
870                 lwkt_gettoken(&lp->lwp_token);
871
872         /*
873          * Only do nominal wakeup processing if TDF_TIMEOUT and
874          * TDF_TSLEEP_DESCHEDULED are both still set.  Otherwise
875          * we raced a wakeup or we began executing and raced due to
876          * blocking in the token above, and should do nothing.
877          */
878         if ((td->td_flags & (TDF_TIMEOUT | TDF_TSLEEP_DESCHEDULED)) ==
879             (TDF_TIMEOUT | TDF_TSLEEP_DESCHEDULED)) {
880                 if (lp) {
881                         lp->lwp_flag |= LWP_BREAKTSLEEP;
882                         if (lp->lwp_proc->p_stat != SSTOP)
883                                 setrunnable(lp);
884                 } else {
885                         _tsleep_wakeup(td);
886                 }
887         }
888         if (lp)
889                 lwkt_reltoken(&lp->lwp_token);
890         lwkt_rele(td);
891         crit_exit();
892 }
893
894 /*
895  * Make all processes sleeping on the specified identifier runnable.
896  * count may be zero or one only.
897  *
898  * The domain encodes the sleep/wakeup domain AND the first cpu to check
899  * (which is always the current cpu).  As we iterate across cpus
900  *
901  * This call may run without the MP lock held.  We can only manipulate thread
902  * state on the cpu owning the thread.  We CANNOT manipulate process state
903  * at all.
904  *
905  * _wakeup() can be passed to an IPI so we can't use (const volatile
906  * void *ident).
907  */
908 static void
909 _wakeup(void *ident, int domain)
910 {
911         struct tslpque *qp;
912         struct thread *td;
913         struct thread *ntd;
914         globaldata_t gd;
915 #ifdef SMP
916         cpumask_t mask;
917 #endif
918         int id;
919
920         crit_enter();
921         logtsleep2(wakeup_beg, ident);
922         gd = mycpu;
923         id = LOOKUP(ident);
924         qp = &gd->gd_tsleep_hash[id];
925 restart:
926         for (td = TAILQ_FIRST(qp); td != NULL; td = ntd) {
927                 ntd = TAILQ_NEXT(td, td_sleepq);
928                 if (td->td_wchan == ident && 
929                     td->td_wdomain == (domain & PDOMAIN_MASK)
930                 ) {
931                         KKASSERT(td->td_gd == gd);
932                         _tsleep_remove(td);
933                         if (td->td_flags & TDF_TSLEEP_DESCHEDULED) {
934                                 td->td_flags &= ~TDF_TSLEEP_DESCHEDULED;
935                                 lwkt_schedule(td);
936                                 if (domain & PWAKEUP_ONE)
937                                         goto done;
938                         }
939                         goto restart;
940                 }
941         }
942
943 #ifdef SMP
944         /*
945          * We finished checking the current cpu but there still may be
946          * more work to do.  Either wakeup_one was requested and no matching
947          * thread was found, or a normal wakeup was requested and we have
948          * to continue checking cpus.
949          *
950          * It should be noted that this scheme is actually less expensive then
951          * the old scheme when waking up multiple threads, since we send 
952          * only one IPI message per target candidate which may then schedule
953          * multiple threads.  Before we could have wound up sending an IPI
954          * message for each thread on the target cpu (!= current cpu) that
955          * needed to be woken up.
956          *
957          * NOTE: Wakeups occuring on remote cpus are asynchronous.  This
958          * should be ok since we are passing idents in the IPI rather then
959          * thread pointers.
960          */
961         if ((domain & PWAKEUP_MYCPU) == 0 &&
962             (mask = slpque_cpumasks[id] & gd->gd_other_cpus) != 0) {
963                 lwkt_send_ipiq2_mask(mask, _wakeup, ident,
964                                      domain | PWAKEUP_MYCPU);
965         }
966 #endif
967 done:
968         logtsleep1(wakeup_end);
969         crit_exit();
970 }
971
972 /*
973  * Wakeup all threads tsleep()ing on the specified ident, on all cpus
974  */
975 void
976 wakeup(const volatile void *ident)
977 {
978     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid));
979 }
980
981 /*
982  * Wakeup one thread tsleep()ing on the specified ident, on any cpu.
983  */
984 void
985 wakeup_one(const volatile void *ident)
986 {
987     /* XXX potentially round-robin the first responding cpu */
988     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(0, mycpu->gd_cpuid) | PWAKEUP_ONE);
989 }
990
991 /*
992  * Wakeup threads tsleep()ing on the specified ident on the current cpu
993  * only.
994  */
995 void
996 wakeup_mycpu(const volatile void *ident)
997 {
998     _wakeup(__DEALL(ident), PWAKEUP_MYCPU);
999 }
1000
1001 /*
1002  * Wakeup one thread tsleep()ing on the specified ident on the current cpu
1003  * only.
1004  */
1005 void
1006 wakeup_mycpu_one(const volatile void *ident)
1007 {
1008     /* XXX potentially round-robin the first responding cpu */
1009     _wakeup(__DEALL(ident), PWAKEUP_MYCPU|PWAKEUP_ONE);
1010 }
1011
1012 /*
1013  * Wakeup all thread tsleep()ing on the specified ident on the specified cpu
1014  * only.
1015  */
1016 void
1017 wakeup_oncpu(globaldata_t gd, const volatile void *ident)
1018 {
1019 #ifdef SMP
1020     if (gd == mycpu) {
1021         _wakeup(__DEALL(ident), PWAKEUP_MYCPU);
1022     } else {
1023         lwkt_send_ipiq2(gd, _wakeup, __DEALL(ident), PWAKEUP_MYCPU);
1024     }
1025 #else
1026     _wakeup(__DEALL(ident), PWAKEUP_MYCPU);
1027 #endif
1028 }
1029
1030 /*
1031  * Wakeup one thread tsleep()ing on the specified ident on the specified cpu
1032  * only.
1033  */
1034 void
1035 wakeup_oncpu_one(globaldata_t gd, const volatile void *ident)
1036 {
1037 #ifdef SMP
1038     if (gd == mycpu) {
1039         _wakeup(__DEALL(ident), PWAKEUP_MYCPU | PWAKEUP_ONE);
1040     } else {
1041         lwkt_send_ipiq2(gd, _wakeup, __DEALL(ident),
1042                         PWAKEUP_MYCPU | PWAKEUP_ONE);
1043     }
1044 #else
1045     _wakeup(__DEALL(ident), PWAKEUP_MYCPU | PWAKEUP_ONE);
1046 #endif
1047 }
1048
1049 /*
1050  * Wakeup all threads waiting on the specified ident that slept using
1051  * the specified domain, on all cpus.
1052  */
1053 void
1054 wakeup_domain(const volatile void *ident, int domain)
1055 {
1056     _wakeup(__DEALL(ident), PWAKEUP_ENCODE(domain, mycpu->gd_cpuid));
1057 }
1058
1059 /*
1060  * Wakeup one thread waiting on the specified ident that slept using
1061  * the specified  domain, on any cpu.
1062  */
1063 void
1064 wakeup_domain_one(const volatile void *ident, int domain)
1065 {
1066     /* XXX potentially round-robin the first responding cpu */
1067     _wakeup(__DEALL(ident),
1068             PWAKEUP_ENCODE(domain, mycpu->gd_cpuid) | PWAKEUP_ONE);
1069 }
1070
1071 /*
1072  * setrunnable()
1073  *
1074  * Make a process runnable.  lp->lwp_proc->p_token must be held on call.
1075  * This only has an effect if we are in SSLEEP.  We only break out of the
1076  * tsleep if LWP_BREAKTSLEEP is set, otherwise we just fix-up the state.
1077  *
1078  * NOTE: With p_token held we can only safely manipulate the process
1079  * structure and the lp's lwp_stat.
1080  */
1081 void
1082 setrunnable(struct lwp *lp)
1083 {
1084         ASSERT_LWKT_TOKEN_HELD(&lp->lwp_token);
1085         crit_enter();
1086         if (lp->lwp_stat == LSSTOP)
1087                 lp->lwp_stat = LSSLEEP;
1088         if (lp->lwp_stat == LSSLEEP && (lp->lwp_flag & LWP_BREAKTSLEEP))
1089                 _tsleep_wakeup(lp->lwp_thread);
1090         crit_exit();
1091 }
1092
1093 /*
1094  * The process is stopped due to some condition, usually because p_stat is
1095  * set to SSTOP, but also possibly due to being traced.  
1096  *
1097  * NOTE!  If the caller sets SSTOP, the caller must also clear P_WAITED
1098  * because the parent may check the child's status before the child actually
1099  * gets to this routine.
1100  *
1101  * This routine is called with the current lwp only, typically just
1102  * before returning to userland.
1103  *
1104  * Setting LWP_BREAKTSLEEP before entering the tsleep will cause a passive
1105  * SIGCONT to break out of the tsleep.
1106  */
1107 void
1108 tstop(void)
1109 {
1110         struct lwp *lp = curthread->td_lwp;
1111         struct proc *p = lp->lwp_proc;
1112         struct proc *q;
1113
1114         crit_enter();
1115         /*
1116          * If LWP_WSTOP is set, we were sleeping
1117          * while our process was stopped.  At this point
1118          * we were already counted as stopped.
1119          */
1120         if ((lp->lwp_flag & LWP_WSTOP) == 0) {
1121                 /*
1122                  * If we're the last thread to stop, signal
1123                  * our parent.
1124                  */
1125                 p->p_nstopped++;
1126                 lp->lwp_flag |= LWP_WSTOP;
1127                 wakeup(&p->p_nstopped);
1128                 if (p->p_nstopped == p->p_nthreads) {
1129                         /*
1130                          * Token required to interlock kern_wait()
1131                          */
1132                         q = p->p_pptr;
1133                         PHOLD(q);
1134                         lwkt_gettoken(&q->p_token);
1135                         p->p_flag &= ~P_WAITED;
1136                         wakeup(p->p_pptr);
1137                         if ((q->p_sigacts->ps_flag & PS_NOCLDSTOP) == 0)
1138                                 ksignal(q, SIGCHLD);
1139                         lwkt_reltoken(&q->p_token);
1140                         PRELE(q);
1141                 }
1142         }
1143         while (p->p_stat == SSTOP) {
1144                 lp->lwp_flag |= LWP_BREAKTSLEEP;
1145                 lp->lwp_stat = LSSTOP;
1146                 tsleep(p, 0, "stop", 0);
1147         }
1148         p->p_nstopped--;
1149         lp->lwp_flag &= ~LWP_WSTOP;
1150         crit_exit();
1151 }
1152
1153 /*
1154  * Compute a tenex style load average of a quantity on
1155  * 1, 5 and 15 minute intervals.
1156  */
1157 static int loadav_count_runnable(struct lwp *p, void *data);
1158
1159 static void
1160 loadav(void *arg)
1161 {
1162         struct loadavg *avg;
1163         int i, nrun;
1164
1165         nrun = 0;
1166         alllwp_scan(loadav_count_runnable, &nrun);
1167         avg = &averunnable;
1168         for (i = 0; i < 3; i++) {
1169                 avg->ldavg[i] = (cexp[i] * avg->ldavg[i] +
1170                     nrun * FSCALE * (FSCALE - cexp[i])) >> FSHIFT;
1171         }
1172
1173         /*
1174          * Schedule the next update to occur after 5 seconds, but add a
1175          * random variation to avoid synchronisation with processes that
1176          * run at regular intervals.
1177          */
1178         callout_reset(&loadav_callout, hz * 4 + (int)(krandom() % (hz * 2 + 1)),
1179                       loadav, NULL);
1180 }
1181
1182 static int
1183 loadav_count_runnable(struct lwp *lp, void *data)
1184 {
1185         int *nrunp = data;
1186         thread_t td;
1187
1188         switch (lp->lwp_stat) {
1189         case LSRUN:
1190                 if ((td = lp->lwp_thread) == NULL)
1191                         break;
1192                 if (td->td_flags & TDF_BLOCKED)
1193                         break;
1194                 ++*nrunp;
1195                 break;
1196         default:
1197                 break;
1198         }
1199         lwkt_yield();
1200         return(0);
1201 }
1202
1203 /* ARGSUSED */
1204 static void
1205 sched_setup(void *dummy)
1206 {
1207         callout_init_mp(&loadav_callout);
1208         callout_init_mp(&schedcpu_callout);
1209
1210         /* Kick off timeout driven events by calling first time. */
1211         schedcpu(NULL);
1212         loadav(NULL);
1213 }
1214