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.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)kern_synch.c 8.9 (Berkeley) 5/19/95
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include "opt_kdtrace.h"
41 #include "opt_ktrace.h"
42 #include "opt_sched.h"
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/condvar.h>
48 #include <sys/kernel.h>
51 #include <sys/mutex.h>
53 #include <sys/resourcevar.h>
54 #include <sys/sched.h>
56 #include <sys/signalvar.h>
57 #include <sys/sleepqueue.h>
60 #include <sys/sysctl.h>
61 #include <sys/sysproto.h>
62 #include <sys/vmmeter.h>
65 #include <sys/ktrace.h>
68 #include <machine/cpu.h>
72 #include <vm/vm_param.h>
76 #define KTDSTATE(td) \
77 (((td)->td_inhibitors & TDI_SLEEPING) != 0 ? "sleep" : \
78 ((td)->td_inhibitors & TDI_SUSPENDED) != 0 ? "suspended" : \
79 ((td)->td_inhibitors & TDI_SWAPPED) != 0 ? "swapped" : \
80 ((td)->td_inhibitors & TDI_LOCK) != 0 ? "blocked" : \
81 ((td)->td_inhibitors & TDI_IWAIT) != 0 ? "iwait" : "yielding")
83 static void synch_setup(void *dummy);
84 SYSINIT(synch_setup, SI_SUB_KICK_SCHEDULER, SI_ORDER_FIRST, synch_setup,
88 static uint8_t pause_wchan[MAXCPU];
90 static struct callout loadav_callout;
92 struct loadavg averunnable =
93 { {0, 0, 0}, FSCALE }; /* load average, of runnable procs */
95 * Constants for averages over 1, 5, and 15 minutes
96 * when sampling at 5 second intervals.
98 static fixpt_t cexp[3] = {
99 0.9200444146293232 * FSCALE, /* exp(-1/12) */
100 0.9834714538216174 * FSCALE, /* exp(-1/60) */
101 0.9944598480048967 * FSCALE, /* exp(-1/180) */
104 /* kernel uses `FSCALE', userland (SHOULD) use kern.fscale */
105 SYSCTL_INT(_kern, OID_AUTO, fscale, CTLFLAG_RD, SYSCTL_NULL_INT_PTR, FSCALE, "");
107 static void loadav(void *arg);
109 SDT_PROVIDER_DECLARE(sched);
110 SDT_PROBE_DEFINE(sched, , , preempt);
113 * These probes reference Solaris features that are not implemented in FreeBSD.
114 * Create the probes anyway for compatibility with existing D scripts; they'll
117 SDT_PROBE_DEFINE(sched, , , cpucaps__sleep);
118 SDT_PROBE_DEFINE(sched, , , cpucaps__wakeup);
119 SDT_PROBE_DEFINE(sched, , , schedctl__nopreempt);
120 SDT_PROBE_DEFINE(sched, , , schedctl__preempt);
121 SDT_PROBE_DEFINE(sched, , , schedctl__yield);
124 sleepinit(void *unused)
127 hogticks = (hz / 10) * 2; /* Default only. */
132 * vmem tries to lock the sleepq mutexes when free'ing kva, so make sure
135 SYSINIT(sleepinit, SI_SUB_KMEM, SI_ORDER_ANY, sleepinit, 0);
138 * General sleep call. Suspends the current thread until a wakeup is
139 * performed on the specified identifier. The thread will then be made
140 * runnable with the specified priority. Sleeps at most sbt units of time
141 * (0 means no timeout). If pri includes the PCATCH flag, let signals
142 * interrupt the sleep, otherwise ignore them while sleeping. Returns 0 if
143 * awakened, EWOULDBLOCK if the timeout expires. If PCATCH is set and a
144 * signal becomes pending, ERESTART is returned if the current system
145 * call should be restarted if possible, and EINTR is returned if the system
146 * call should be interrupted by the signal (return EINTR).
148 * The lock argument is unlocked before the caller is suspended, and
149 * re-locked before _sleep() returns. If priority includes the PDROP
150 * flag the lock is not re-locked before returning.
153 _sleep(void *ident, struct lock_object *lock, int priority,
154 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags)
158 struct lock_class *class;
159 uintptr_t lock_state;
160 int catch, pri, rval, sleepq_flags;
161 WITNESS_SAVE_DECL(lock_witness);
166 if (KTRPOINT(td, KTR_CSW))
169 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, lock,
170 "Sleeping on \"%s\"", wmesg);
171 KASSERT(sbt != 0 || mtx_owned(&Giant) || lock != NULL,
172 ("sleeping without a lock"));
173 KASSERT(p != NULL, ("msleep1"));
174 KASSERT(ident != NULL && TD_IS_RUNNING(td), ("msleep"));
175 if (priority & PDROP)
176 KASSERT(lock != NULL && lock != &Giant.lock_object,
177 ("PDROP requires a non-Giant lock"));
179 class = LOCK_CLASS(lock);
183 if (cold || SCHEDULER_STOPPED()) {
185 * During autoconfiguration, just return;
186 * don't run any other threads or panic below,
187 * in case this is the idle thread and already asleep.
188 * XXX: this used to do "s = splhigh(); splx(safepri);
189 * splx(s);" to give interrupts a chance, but there is
190 * no way to give interrupts a chance now.
192 if (lock != NULL && priority & PDROP)
193 class->lc_unlock(lock);
196 catch = priority & PCATCH;
197 pri = priority & PRIMASK;
200 * If we are already on a sleep queue, then remove us from that
201 * sleep queue first. We have to do this to handle recursive
204 if (TD_ON_SLEEPQ(td))
205 sleepq_remove(td, td->td_wchan);
207 if ((uint8_t *)ident >= &pause_wchan[0] &&
208 (uint8_t *)ident <= &pause_wchan[MAXCPU - 1])
209 sleepq_flags = SLEEPQ_PAUSE;
211 sleepq_flags = SLEEPQ_SLEEP;
213 sleepq_flags |= SLEEPQ_INTERRUPTIBLE;
216 CTR5(KTR_PROC, "sleep: thread %ld (pid %ld, %s) on %s (%p)",
217 td->td_tid, p->p_pid, td->td_name, wmesg, ident);
219 if (lock == &Giant.lock_object)
220 mtx_assert(&Giant, MA_OWNED);
222 if (lock != NULL && lock != &Giant.lock_object &&
223 !(class->lc_flags & LC_SLEEPABLE)) {
224 WITNESS_SAVE(lock, lock_witness);
225 lock_state = class->lc_unlock(lock);
227 /* GCC needs to follow the Yellow Brick Road */
231 * We put ourselves on the sleep queue and start our timeout
232 * before calling thread_suspend_check, as we could stop there,
233 * and a wakeup or a SIGCONT (or both) could occur while we were
234 * stopped without resuming us. Thus, we must be ready for sleep
235 * when cursig() is called. If the wakeup happens while we're
236 * stopped, then td will no longer be on a sleep queue upon
237 * return from cursig().
239 sleepq_add(ident, lock, wmesg, sleepq_flags, 0);
241 sleepq_set_timeout_sbt(ident, sbt, pr, flags);
242 if (lock != NULL && class->lc_flags & LC_SLEEPABLE) {
243 sleepq_release(ident);
244 WITNESS_SAVE(lock, lock_witness);
245 lock_state = class->lc_unlock(lock);
248 if (sbt != 0 && catch)
249 rval = sleepq_timedwait_sig(ident, pri);
251 rval = sleepq_timedwait(ident, pri);
253 rval = sleepq_wait_sig(ident, pri);
255 sleepq_wait(ident, pri);
259 if (KTRPOINT(td, KTR_CSW))
263 if (lock != NULL && lock != &Giant.lock_object && !(priority & PDROP)) {
264 class->lc_lock(lock, lock_state);
265 WITNESS_RESTORE(lock, lock_witness);
271 msleep_spin_sbt(void *ident, struct mtx *mtx, const char *wmesg,
272 sbintime_t sbt, sbintime_t pr, int flags)
277 WITNESS_SAVE_DECL(mtx);
281 KASSERT(mtx != NULL, ("sleeping without a mutex"));
282 KASSERT(p != NULL, ("msleep1"));
283 KASSERT(ident != NULL && TD_IS_RUNNING(td), ("msleep"));
285 if (cold || SCHEDULER_STOPPED()) {
287 * During autoconfiguration, just return;
288 * don't run any other threads or panic below,
289 * in case this is the idle thread and already asleep.
290 * XXX: this used to do "s = splhigh(); splx(safepri);
291 * splx(s);" to give interrupts a chance, but there is
292 * no way to give interrupts a chance now.
298 CTR5(KTR_PROC, "msleep_spin: thread %ld (pid %ld, %s) on %s (%p)",
299 td->td_tid, p->p_pid, td->td_name, wmesg, ident);
302 mtx_assert(mtx, MA_OWNED | MA_NOTRECURSED);
303 WITNESS_SAVE(&mtx->lock_object, mtx);
304 mtx_unlock_spin(mtx);
307 * We put ourselves on the sleep queue and start our timeout.
309 sleepq_add(ident, &mtx->lock_object, wmesg, SLEEPQ_SLEEP, 0);
311 sleepq_set_timeout_sbt(ident, sbt, pr, flags);
314 * Can't call ktrace with any spin locks held so it can lock the
315 * ktrace_mtx lock, and WITNESS_WARN considers it an error to hold
316 * any spin lock. Thus, we have to drop the sleepq spin lock while
317 * we handle those requests. This is safe since we have placed our
318 * thread on the sleep queue already.
321 if (KTRPOINT(td, KTR_CSW)) {
322 sleepq_release(ident);
328 sleepq_release(ident);
329 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "Sleeping on \"%s\"",
334 rval = sleepq_timedwait(ident, 0);
336 sleepq_wait(ident, 0);
340 if (KTRPOINT(td, KTR_CSW))
345 WITNESS_RESTORE(&mtx->lock_object, mtx);
350 * pause() delays the calling thread by the given number of system ticks.
351 * During cold bootup, pause() uses the DELAY() function instead of
352 * the tsleep() function to do the waiting. The "timo" argument must be
353 * greater than or equal to zero. A "timo" value of zero is equivalent
354 * to a "timo" value of one.
357 pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags)
359 KASSERT(sbt >= 0, ("pause: timeout must be >= 0"));
361 /* silently convert invalid timeouts */
365 if (cold || kdb_active) {
367 * We delay one second at a time to avoid overflowing the
368 * system specific DELAY() function(s):
370 while (sbt >= SBT_1S) {
374 /* Do the delay remainder, if any */
375 sbt = (sbt + SBT_1US - 1) / SBT_1US;
380 return (_sleep(&pause_wchan[curcpu], NULL, 0, wmesg, sbt, pr, flags));
384 * Make all threads sleeping on the specified identifier runnable.
392 wakeup_swapper = sleepq_broadcast(ident, SLEEPQ_SLEEP, 0, 0);
393 sleepq_release(ident);
394 if (wakeup_swapper) {
395 KASSERT(ident != &proc0,
396 ("wakeup and wakeup_swapper and proc0"));
402 * Make a thread sleeping on the specified identifier runnable.
403 * May wake more than one thread if a target thread is currently
407 wakeup_one(void *ident)
412 wakeup_swapper = sleepq_signal(ident, SLEEPQ_SLEEP, 0, 0);
413 sleepq_release(ident);
421 thread_unlock(curthread);
424 panic("%s: did not reenter debugger", __func__);
428 * The machine independent parts of context switching.
431 mi_switch(int flags, struct thread *newtd)
433 uint64_t runtime, new_switchtime;
436 td = curthread; /* XXX */
437 THREAD_LOCK_ASSERT(td, MA_OWNED | MA_NOTRECURSED);
438 KASSERT(!TD_ON_RUNQ(td), ("mi_switch: called by old code"));
440 if (!TD_ON_LOCK(td) && !TD_IS_RUNNING(td))
441 mtx_assert(&Giant, MA_NOTOWNED);
443 KASSERT(td->td_critnest == 1 || panicstr,
444 ("mi_switch: switch in a critical section"));
445 KASSERT((flags & (SW_INVOL | SW_VOL)) != 0,
446 ("mi_switch: switch must be voluntary or involuntary"));
447 KASSERT(newtd != curthread, ("mi_switch: preempting back to ourself"));
450 * Don't perform context switches from the debugger.
454 if (SCHEDULER_STOPPED())
456 if (flags & SW_VOL) {
457 td->td_ru.ru_nvcsw++;
458 td->td_swvoltick = ticks;
460 td->td_ru.ru_nivcsw++;
462 SCHED_STAT_INC(sched_switch_stats[flags & SW_TYPE_MASK]);
465 * Compute the amount of time during which the current
466 * thread was running, and add that to its total so far.
468 new_switchtime = cpu_ticks();
469 runtime = new_switchtime - PCPU_GET(switchtime);
470 td->td_runtime += runtime;
471 td->td_incruntime += runtime;
472 PCPU_SET(switchtime, new_switchtime);
473 td->td_generation++; /* bump preempt-detect counter */
474 PCPU_INC(cnt.v_swtch);
475 PCPU_SET(switchticks, ticks);
476 CTR4(KTR_PROC, "mi_switch: old thread %ld (td_sched %p, pid %ld, %s)",
477 td->td_tid, td->td_sched, td->td_proc->p_pid, td->td_name);
478 #if (KTR_COMPILE & KTR_SCHED) != 0
479 if (TD_IS_IDLETHREAD(td))
480 KTR_STATE1(KTR_SCHED, "thread", sched_tdname(td), "idle",
481 "prio:%d", td->td_priority);
483 KTR_STATE3(KTR_SCHED, "thread", sched_tdname(td), KTDSTATE(td),
484 "prio:%d", td->td_priority, "wmesg:\"%s\"", td->td_wmesg,
485 "lockname:\"%s\"", td->td_lockname);
487 SDT_PROBE0(sched, , , preempt);
491 sched_switch(td, newtd, flags);
492 KTR_STATE1(KTR_SCHED, "thread", sched_tdname(td), "running",
493 "prio:%d", td->td_priority);
495 CTR4(KTR_PROC, "mi_switch: new thread %ld (td_sched %p, pid %ld, %s)",
496 td->td_tid, td->td_sched, td->td_proc->p_pid, td->td_name);
499 * If the last thread was exiting, finish cleaning it up.
501 if ((td = PCPU_GET(deadthread))) {
502 PCPU_SET(deadthread, NULL);
508 * Change thread state to be runnable, placing it on the run queue if
509 * it is in memory. If it is swapped out, return true so our caller
510 * will know to awaken the swapper.
513 setrunnable(struct thread *td)
516 THREAD_LOCK_ASSERT(td, MA_OWNED);
517 KASSERT(td->td_proc->p_state != PRS_ZOMBIE,
518 ("setrunnable: pid %d is a zombie", td->td_proc->p_pid));
519 switch (td->td_state) {
525 * If we are only inhibited because we are swapped out
526 * then arange to swap in this process. Otherwise just return.
528 if (td->td_inhibitors != TDI_SWAPPED)
534 printf("state is 0x%x", td->td_state);
535 panic("setrunnable(2)");
537 if ((td->td_flags & TDF_INMEM) == 0) {
538 if ((td->td_flags & TDF_SWAPINREQ) == 0) {
539 td->td_flags |= TDF_SWAPINREQ;
548 * Compute a tenex style load average of a quantity on
549 * 1, 5 and 15 minute intervals.
560 for (i = 0; i < 3; i++)
561 avg->ldavg[i] = (cexp[i] * avg->ldavg[i] +
562 nrun * FSCALE * (FSCALE - cexp[i])) >> FSHIFT;
565 * Schedule the next update to occur after 5 seconds, but add a
566 * random variation to avoid synchronisation with processes that
567 * run at regular intervals.
569 callout_reset_sbt(&loadav_callout,
570 SBT_1US * (4000000 + (int)(random() % 2000001)), SBT_1US,
571 loadav, NULL, C_DIRECT_EXEC | C_PREL(32));
576 synch_setup(void *dummy)
578 callout_init(&loadav_callout, CALLOUT_MPSAFE);
580 /* Kick off timeout driven events by calling first time. */
588 return ((u_int)ticks - (u_int)curthread->td_swvoltick >= hogticks);
596 kern_yield(PRI_USER);
607 if (prio == PRI_USER)
608 prio = td->td_user_pri;
610 sched_prio(td, prio);
611 mi_switch(SW_VOL | SWT_RELINQUISH, NULL);
617 * General purpose yield system call.
620 sys_yield(struct thread *td, struct yield_args *uap)
624 if (PRI_BASE(td->td_pri_class) == PRI_TIMESHARE)
625 sched_prio(td, PRI_MAX_TIMESHARE);
626 mi_switch(SW_VOL | SWT_RELINQUISH, NULL);
628 td->td_retval[0] = 0;