2 * Copyright (c) 2004 John Baldwin <jhb@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the author nor the names of any co-contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * Implementation of sleep queues used to hold queue of threads blocked on
32 * a wait channel. Sleep queues different from turnstiles in that wait
33 * channels are not owned by anyone, so there is no priority propagation.
34 * Sleep queues can also provide a timeout and can also be interrupted by
35 * signals. That said, there are several similarities between the turnstile
36 * and sleep queue implementations. (Note: turnstiles were implemented
37 * first.) For example, both use a hash table of the same size where each
38 * bucket is referred to as a "chain" that contains both a spin lock and
39 * a linked list of queues. An individual queue is located by using a hash
40 * to pick a chain, locking the chain, and then walking the chain searching
41 * for the queue. This means that a wait channel object does not need to
42 * embed it's queue head just as locks do not embed their turnstile queue
43 * head. Threads also carry around a sleep queue that they lend to the
44 * wait channel when blocking. Just as in turnstiles, the queue includes
45 * a free list of the sleep queues of other threads blocked on the same
46 * wait channel in the case of multiple waiters.
48 * Some additional functionality provided by sleep queues include the
49 * ability to set a timeout. The timeout is managed using a per-thread
50 * callout that resumes a thread if it is asleep. A thread may also
51 * catch signals while it is asleep (aka an interruptible sleep). The
52 * signal code uses sleepq_abort() to interrupt a sleeping thread. Finally,
53 * sleep queues also provide some extra assertions. One is not allowed to
54 * mix the sleep/wakeup and cv APIs for a given wait channel. Also, one
55 * must consistently use the same lock to synchronize with a wait channel,
56 * though this check is currently only a warning for sleep/wakeup due to
57 * pre-existing abuse of that API. The same lock must also be held when
58 * awakening threads, though that is currently only enforced for condition
62 #include <sys/cdefs.h>
63 __FBSDID("$FreeBSD$");
65 #include "opt_sleepqueue_profiling.h"
67 #include "opt_kdtrace.h"
68 #include "opt_sched.h"
70 #include <sys/param.h>
71 #include <sys/systm.h>
73 #include <sys/kernel.h>
75 #include <sys/mutex.h>
78 #include <sys/sched.h>
80 #include <sys/signalvar.h>
81 #include <sys/sleepqueue.h>
82 #include <sys/sysctl.h>
91 * Constants for the hash table of sleep queue chains.
92 * SC_TABLESIZE must be a power of two for SC_MASK to work properly.
94 #define SC_TABLESIZE 256 /* Must be power of 2. */
95 #define SC_MASK (SC_TABLESIZE - 1)
97 #define SC_HASH(wc) ((((uintptr_t)(wc) >> SC_SHIFT) ^ (uintptr_t)(wc)) & \
99 #define SC_LOOKUP(wc) &sleepq_chains[SC_HASH(wc)]
102 * There two different lists of sleep queues. Both lists are connected
103 * via the sq_hash entries. The first list is the sleep queue chain list
104 * that a sleep queue is on when it is attached to a wait channel. The
105 * second list is the free list hung off of a sleep queue that is attached
108 * Each sleep queue also contains the wait channel it is attached to, the
109 * list of threads blocked on that wait channel, flags specific to the
110 * wait channel, and the lock used to synchronize with a wait channel.
111 * The flags are used to catch mismatches between the various consumers
112 * of the sleep queue API (e.g. sleep/wakeup and condition variables).
113 * The lock pointer is only used when invariants are enabled for various
117 * c - sleep queue chain lock
120 TAILQ_HEAD(, thread) sq_blocked[NR_SLEEPQS]; /* (c) Blocked threads. */
121 u_int sq_blockedcnt[NR_SLEEPQS]; /* (c) N. of blocked threads. */
122 LIST_ENTRY(sleepqueue) sq_hash; /* (c) Chain and free list. */
123 LIST_HEAD(, sleepqueue) sq_free; /* (c) Free queues. */
124 void *sq_wchan; /* (c) Wait channel. */
125 int sq_type; /* (c) Queue type. */
127 struct lock_object *sq_lock; /* (c) Associated lock. */
131 struct sleepqueue_chain {
132 LIST_HEAD(, sleepqueue) sc_queues; /* List of sleep queues. */
133 struct mtx sc_lock; /* Spin lock for this chain. */
134 #ifdef SLEEPQUEUE_PROFILING
135 u_int sc_depth; /* Length of sc_queues. */
136 u_int sc_max_depth; /* Max length of sc_queues. */
140 #ifdef SLEEPQUEUE_PROFILING
141 u_int sleepq_max_depth;
142 static SYSCTL_NODE(_debug, OID_AUTO, sleepq, CTLFLAG_RD, 0, "sleepq profiling");
143 static SYSCTL_NODE(_debug_sleepq, OID_AUTO, chains, CTLFLAG_RD, 0,
144 "sleepq chain stats");
145 SYSCTL_UINT(_debug_sleepq, OID_AUTO, max_depth, CTLFLAG_RD, &sleepq_max_depth,
146 0, "maxmimum depth achieved of a single chain");
148 static void sleepq_profile(const char *wmesg);
149 static int prof_enabled;
151 static struct sleepqueue_chain sleepq_chains[SC_TABLESIZE];
152 static uma_zone_t sleepq_zone;
155 * Prototypes for non-exported routines.
157 static int sleepq_catch_signals(void *wchan, int pri);
158 static int sleepq_check_signals(void);
159 static int sleepq_check_timeout(void);
161 static void sleepq_dtor(void *mem, int size, void *arg);
163 static int sleepq_init(void *mem, int size, int flags);
164 static int sleepq_resume_thread(struct sleepqueue *sq, struct thread *td,
166 static void sleepq_switch(void *wchan, int pri);
167 static void sleepq_timeout(void *arg);
169 SDT_PROBE_DECLARE(sched, , , sleep);
170 SDT_PROBE_DECLARE(sched, , , wakeup);
173 * Early initialization of sleep queues that is called from the sleepinit()
177 init_sleepqueues(void)
179 #ifdef SLEEPQUEUE_PROFILING
180 struct sysctl_oid *chain_oid;
185 for (i = 0; i < SC_TABLESIZE; i++) {
186 LIST_INIT(&sleepq_chains[i].sc_queues);
187 mtx_init(&sleepq_chains[i].sc_lock, "sleepq chain", NULL,
188 MTX_SPIN | MTX_RECURSE);
189 #ifdef SLEEPQUEUE_PROFILING
190 snprintf(chain_name, sizeof(chain_name), "%d", i);
191 chain_oid = SYSCTL_ADD_NODE(NULL,
192 SYSCTL_STATIC_CHILDREN(_debug_sleepq_chains), OID_AUTO,
193 chain_name, CTLFLAG_RD, NULL, "sleepq chain stats");
194 SYSCTL_ADD_UINT(NULL, SYSCTL_CHILDREN(chain_oid), OID_AUTO,
195 "depth", CTLFLAG_RD, &sleepq_chains[i].sc_depth, 0, NULL);
196 SYSCTL_ADD_UINT(NULL, SYSCTL_CHILDREN(chain_oid), OID_AUTO,
197 "max_depth", CTLFLAG_RD, &sleepq_chains[i].sc_max_depth, 0,
201 sleepq_zone = uma_zcreate("SLEEPQUEUE", sizeof(struct sleepqueue),
203 NULL, sleepq_dtor, sleepq_init, NULL, UMA_ALIGN_CACHE, 0);
205 NULL, NULL, sleepq_init, NULL, UMA_ALIGN_CACHE, 0);
208 thread0.td_sleepqueue = sleepq_alloc();
212 * Get a sleep queue for a new thread.
218 return (uma_zalloc(sleepq_zone, M_WAITOK));
222 * Free a sleep queue when a thread is destroyed.
225 sleepq_free(struct sleepqueue *sq)
228 uma_zfree(sleepq_zone, sq);
232 * Lock the sleep queue chain associated with the specified wait channel.
235 sleepq_lock(void *wchan)
237 struct sleepqueue_chain *sc;
239 sc = SC_LOOKUP(wchan);
240 mtx_lock_spin(&sc->sc_lock);
244 * Look up the sleep queue associated with a given wait channel in the hash
245 * table locking the associated sleep queue chain. If no queue is found in
246 * the table, NULL is returned.
249 sleepq_lookup(void *wchan)
251 struct sleepqueue_chain *sc;
252 struct sleepqueue *sq;
254 KASSERT(wchan != NULL, ("%s: invalid NULL wait channel", __func__));
255 sc = SC_LOOKUP(wchan);
256 mtx_assert(&sc->sc_lock, MA_OWNED);
257 LIST_FOREACH(sq, &sc->sc_queues, sq_hash)
258 if (sq->sq_wchan == wchan)
264 * Unlock the sleep queue chain associated with a given wait channel.
267 sleepq_release(void *wchan)
269 struct sleepqueue_chain *sc;
271 sc = SC_LOOKUP(wchan);
272 mtx_unlock_spin(&sc->sc_lock);
276 * Places the current thread on the sleep queue for the specified wait
277 * channel. If INVARIANTS is enabled, then it associates the passed in
278 * lock with the sleepq to make sure it is held when that sleep queue is
282 sleepq_add(void *wchan, struct lock_object *lock, const char *wmesg, int flags,
285 struct sleepqueue_chain *sc;
286 struct sleepqueue *sq;
290 sc = SC_LOOKUP(wchan);
291 mtx_assert(&sc->sc_lock, MA_OWNED);
292 MPASS(td->td_sleepqueue != NULL);
293 MPASS(wchan != NULL);
294 MPASS((queue >= 0) && (queue < NR_SLEEPQS));
296 /* If this thread is not allowed to sleep, die a horrible death. */
297 KASSERT(td->td_no_sleeping == 0,
298 ("%s: td %p to sleep on wchan %p with sleeping prohibited",
299 __func__, td, wchan));
301 /* Look up the sleep queue associated with the wait channel 'wchan'. */
302 sq = sleepq_lookup(wchan);
305 * If the wait channel does not already have a sleep queue, use
306 * this thread's sleep queue. Otherwise, insert the current thread
307 * into the sleep queue already in use by this wait channel.
313 sq = td->td_sleepqueue;
314 for (i = 0; i < NR_SLEEPQS; i++) {
315 KASSERT(TAILQ_EMPTY(&sq->sq_blocked[i]),
316 ("thread's sleep queue %d is not empty", i));
317 KASSERT(sq->sq_blockedcnt[i] == 0,
318 ("thread's sleep queue %d count mismatches", i));
320 KASSERT(LIST_EMPTY(&sq->sq_free),
321 ("thread's sleep queue has a non-empty free list"));
322 KASSERT(sq->sq_wchan == NULL, ("stale sq_wchan pointer"));
325 #ifdef SLEEPQUEUE_PROFILING
327 if (sc->sc_depth > sc->sc_max_depth) {
328 sc->sc_max_depth = sc->sc_depth;
329 if (sc->sc_max_depth > sleepq_max_depth)
330 sleepq_max_depth = sc->sc_max_depth;
333 sq = td->td_sleepqueue;
334 LIST_INSERT_HEAD(&sc->sc_queues, sq, sq_hash);
335 sq->sq_wchan = wchan;
336 sq->sq_type = flags & SLEEPQ_TYPE;
338 MPASS(wchan == sq->sq_wchan);
339 MPASS(lock == sq->sq_lock);
340 MPASS((flags & SLEEPQ_TYPE) == sq->sq_type);
341 LIST_INSERT_HEAD(&sq->sq_free, td->td_sleepqueue, sq_hash);
344 TAILQ_INSERT_TAIL(&sq->sq_blocked[queue], td, td_slpq);
345 sq->sq_blockedcnt[queue]++;
346 td->td_sleepqueue = NULL;
347 td->td_sqqueue = queue;
348 td->td_wchan = wchan;
349 td->td_wmesg = wmesg;
350 if (flags & SLEEPQ_INTERRUPTIBLE) {
351 td->td_flags |= TDF_SINTR;
352 td->td_flags &= ~TDF_SLEEPABORT;
358 * Sets a timeout that will remove the current thread from the specified
359 * sleep queue after timo ticks if the thread has not already been awakened.
362 sleepq_set_timeout_sbt(void *wchan, sbintime_t sbt, sbintime_t pr,
365 struct sleepqueue_chain *sc;
369 sc = SC_LOOKUP(wchan);
370 mtx_assert(&sc->sc_lock, MA_OWNED);
371 MPASS(TD_ON_SLEEPQ(td));
372 MPASS(td->td_sleepqueue == NULL);
373 MPASS(wchan != NULL);
374 callout_reset_sbt_on(&td->td_slpcallout, sbt, pr,
375 sleepq_timeout, td, PCPU_GET(cpuid), flags | C_DIRECT_EXEC);
379 * Return the number of actual sleepers for the specified queue.
382 sleepq_sleepcnt(void *wchan, int queue)
384 struct sleepqueue *sq;
386 KASSERT(wchan != NULL, ("%s: invalid NULL wait channel", __func__));
387 MPASS((queue >= 0) && (queue < NR_SLEEPQS));
388 sq = sleepq_lookup(wchan);
391 return (sq->sq_blockedcnt[queue]);
395 * Marks the pending sleep of the current thread as interruptible and
396 * makes an initial check for pending signals before putting a thread
397 * to sleep. Enters and exits with the thread lock held. Thread lock
398 * may have transitioned from the sleepq lock to a run lock.
401 sleepq_catch_signals(void *wchan, int pri)
403 struct sleepqueue_chain *sc;
404 struct sleepqueue *sq;
412 sc = SC_LOOKUP(wchan);
413 mtx_assert(&sc->sc_lock, MA_OWNED);
414 MPASS(wchan != NULL);
415 if ((td->td_pflags & TDP_WAKEUP) != 0) {
416 td->td_pflags &= ~TDP_WAKEUP;
423 * See if there are any pending signals for this thread. If not
424 * we can switch immediately. Otherwise do the signal processing
428 if ((td->td_flags & (TDF_NEEDSIGCHK | TDF_NEEDSUSPCHK)) == 0) {
429 sleepq_switch(wchan, pri);
433 mtx_unlock_spin(&sc->sc_lock);
434 CTR3(KTR_PROC, "sleepq catching signals: thread %p (pid %ld, %s)",
435 (void *)td, (long)p->p_pid, td->td_name);
438 mtx_lock(&ps->ps_mtx);
441 mtx_unlock(&ps->ps_mtx);
442 ret = thread_suspend_check(1);
443 MPASS(ret == 0 || ret == EINTR || ret == ERESTART);
445 if (SIGISMEMBER(ps->ps_sigintr, sig))
449 mtx_unlock(&ps->ps_mtx);
452 * Lock the per-process spinlock prior to dropping the PROC_LOCK
453 * to avoid a signal delivery race. PROC_LOCK, PROC_SLOCK, and
454 * thread_lock() are currently held in tdsendsignal().
457 mtx_lock_spin(&sc->sc_lock);
462 sleepq_switch(wchan, pri);
467 * There were pending signals and this thread is still
468 * on the sleep queue, remove it from the sleep queue.
470 if (TD_ON_SLEEPQ(td)) {
471 sq = sleepq_lookup(wchan);
472 if (sleepq_resume_thread(sq, td, 0)) {
475 * This thread hasn't gone to sleep yet, so it
476 * should not be swapped out.
478 panic("not waking up swapper");
482 mtx_unlock_spin(&sc->sc_lock);
483 MPASS(td->td_lock != &sc->sc_lock);
488 * Switches to another thread if we are still asleep on a sleep queue.
489 * Returns with thread lock.
492 sleepq_switch(void *wchan, int pri)
494 struct sleepqueue_chain *sc;
495 struct sleepqueue *sq;
499 sc = SC_LOOKUP(wchan);
500 mtx_assert(&sc->sc_lock, MA_OWNED);
501 THREAD_LOCK_ASSERT(td, MA_OWNED);
504 * If we have a sleep queue, then we've already been woken up, so
507 if (td->td_sleepqueue != NULL) {
508 mtx_unlock_spin(&sc->sc_lock);
513 * If TDF_TIMEOUT is set, then our sleep has been timed out
514 * already but we are still on the sleep queue, so dequeue the
517 if (td->td_flags & TDF_TIMEOUT) {
518 MPASS(TD_ON_SLEEPQ(td));
519 sq = sleepq_lookup(wchan);
520 if (sleepq_resume_thread(sq, td, 0)) {
523 * This thread hasn't gone to sleep yet, so it
524 * should not be swapped out.
526 panic("not waking up swapper");
529 mtx_unlock_spin(&sc->sc_lock);
532 #ifdef SLEEPQUEUE_PROFILING
534 sleepq_profile(td->td_wmesg);
536 MPASS(td->td_sleepqueue == NULL);
537 sched_sleep(td, pri);
538 thread_lock_set(td, &sc->sc_lock);
539 SDT_PROBE0(sched, , , sleep);
541 mi_switch(SW_VOL | SWT_SLEEPQ, NULL);
542 KASSERT(TD_IS_RUNNING(td), ("running but not TDS_RUNNING"));
543 CTR3(KTR_PROC, "sleepq resume: thread %p (pid %ld, %s)",
544 (void *)td, (long)td->td_proc->p_pid, (void *)td->td_name);
548 * Check to see if we timed out.
551 sleepq_check_timeout(void)
556 THREAD_LOCK_ASSERT(td, MA_OWNED);
559 * If TDF_TIMEOUT is set, we timed out.
561 if (td->td_flags & TDF_TIMEOUT) {
562 td->td_flags &= ~TDF_TIMEOUT;
563 return (EWOULDBLOCK);
567 * If TDF_TIMOFAIL is set, the timeout ran after we had
568 * already been woken up.
570 if (td->td_flags & TDF_TIMOFAIL)
571 td->td_flags &= ~TDF_TIMOFAIL;
574 * If callout_stop() fails, then the timeout is running on
575 * another CPU, so synchronize with it to avoid having it
576 * accidentally wake up a subsequent sleep.
578 else if (callout_stop(&td->td_slpcallout) == 0) {
579 td->td_flags |= TDF_TIMEOUT;
581 mi_switch(SW_INVOL | SWT_SLEEPQTIMO, NULL);
587 * Check to see if we were awoken by a signal.
590 sleepq_check_signals(void)
595 THREAD_LOCK_ASSERT(td, MA_OWNED);
597 /* We are no longer in an interruptible sleep. */
598 if (td->td_flags & TDF_SINTR)
599 td->td_flags &= ~TDF_SINTR;
601 if (td->td_flags & TDF_SLEEPABORT) {
602 td->td_flags &= ~TDF_SLEEPABORT;
603 return (td->td_intrval);
610 * Block the current thread until it is awakened from its sleep queue.
613 sleepq_wait(void *wchan, int pri)
618 MPASS(!(td->td_flags & TDF_SINTR));
620 sleepq_switch(wchan, pri);
625 * Block the current thread until it is awakened from its sleep queue
626 * or it is interrupted by a signal.
629 sleepq_wait_sig(void *wchan, int pri)
634 rcatch = sleepq_catch_signals(wchan, pri);
635 rval = sleepq_check_signals();
636 thread_unlock(curthread);
643 * Block the current thread until it is awakened from its sleep queue
644 * or it times out while waiting.
647 sleepq_timedwait(void *wchan, int pri)
653 MPASS(!(td->td_flags & TDF_SINTR));
655 sleepq_switch(wchan, pri);
656 rval = sleepq_check_timeout();
663 * Block the current thread until it is awakened from its sleep queue,
664 * it is interrupted by a signal, or it times out waiting to be awakened.
667 sleepq_timedwait_sig(void *wchan, int pri)
669 int rcatch, rvalt, rvals;
671 rcatch = sleepq_catch_signals(wchan, pri);
672 rvalt = sleepq_check_timeout();
673 rvals = sleepq_check_signals();
674 thread_unlock(curthread);
683 * Returns the type of sleepqueue given a waitchannel.
686 sleepq_type(void *wchan)
688 struct sleepqueue *sq;
691 MPASS(wchan != NULL);
694 sq = sleepq_lookup(wchan);
696 sleepq_release(wchan);
700 sleepq_release(wchan);
705 * Removes a thread from a sleep queue and makes it
709 sleepq_resume_thread(struct sleepqueue *sq, struct thread *td, int pri)
711 struct sleepqueue_chain *sc;
714 MPASS(sq->sq_wchan != NULL);
715 MPASS(td->td_wchan == sq->sq_wchan);
716 MPASS(td->td_sqqueue < NR_SLEEPQS && td->td_sqqueue >= 0);
717 THREAD_LOCK_ASSERT(td, MA_OWNED);
718 sc = SC_LOOKUP(sq->sq_wchan);
719 mtx_assert(&sc->sc_lock, MA_OWNED);
721 SDT_PROBE2(sched, , , wakeup, td, td->td_proc);
723 /* Remove the thread from the queue. */
724 sq->sq_blockedcnt[td->td_sqqueue]--;
725 TAILQ_REMOVE(&sq->sq_blocked[td->td_sqqueue], td, td_slpq);
728 * Get a sleep queue for this thread. If this is the last waiter,
729 * use the queue itself and take it out of the chain, otherwise,
730 * remove a queue from the free list.
732 if (LIST_EMPTY(&sq->sq_free)) {
733 td->td_sleepqueue = sq;
737 #ifdef SLEEPQUEUE_PROFILING
741 td->td_sleepqueue = LIST_FIRST(&sq->sq_free);
742 LIST_REMOVE(td->td_sleepqueue, sq_hash);
746 td->td_flags &= ~TDF_SINTR;
748 CTR3(KTR_PROC, "sleepq_wakeup: thread %p (pid %ld, %s)",
749 (void *)td, (long)td->td_proc->p_pid, td->td_name);
751 /* Adjust priority if requested. */
752 MPASS(pri == 0 || (pri >= PRI_MIN && pri <= PRI_MAX));
753 if (pri != 0 && td->td_priority > pri &&
754 PRI_BASE(td->td_pri_class) == PRI_TIMESHARE)
758 * Note that thread td might not be sleeping if it is running
759 * sleepq_catch_signals() on another CPU or is blocked on its
760 * proc lock to check signals. There's no need to mark the
761 * thread runnable in that case.
763 if (TD_IS_SLEEPING(td)) {
765 return (setrunnable(td));
772 * UMA zone item deallocator.
775 sleepq_dtor(void *mem, int size, void *arg)
777 struct sleepqueue *sq;
781 for (i = 0; i < NR_SLEEPQS; i++) {
782 MPASS(TAILQ_EMPTY(&sq->sq_blocked[i]));
783 MPASS(sq->sq_blockedcnt[i] == 0);
789 * UMA zone item initializer.
792 sleepq_init(void *mem, int size, int flags)
794 struct sleepqueue *sq;
799 for (i = 0; i < NR_SLEEPQS; i++) {
800 TAILQ_INIT(&sq->sq_blocked[i]);
801 sq->sq_blockedcnt[i] = 0;
803 LIST_INIT(&sq->sq_free);
808 * Find the highest priority thread sleeping on a wait channel and resume it.
811 sleepq_signal(void *wchan, int flags, int pri, int queue)
813 struct sleepqueue *sq;
814 struct thread *td, *besttd;
817 CTR2(KTR_PROC, "sleepq_signal(%p, %d)", wchan, flags);
818 KASSERT(wchan != NULL, ("%s: invalid NULL wait channel", __func__));
819 MPASS((queue >= 0) && (queue < NR_SLEEPQS));
820 sq = sleepq_lookup(wchan);
823 KASSERT(sq->sq_type == (flags & SLEEPQ_TYPE),
824 ("%s: mismatch between sleep/wakeup and cv_*", __func__));
827 * Find the highest priority thread on the queue. If there is a
828 * tie, use the thread that first appears in the queue as it has
829 * been sleeping the longest since threads are always added to
830 * the tail of sleep queues.
833 TAILQ_FOREACH(td, &sq->sq_blocked[queue], td_slpq) {
834 if (besttd == NULL || td->td_priority < besttd->td_priority)
837 MPASS(besttd != NULL);
839 wakeup_swapper = sleepq_resume_thread(sq, besttd, pri);
840 thread_unlock(besttd);
841 return (wakeup_swapper);
845 * Resume all threads sleeping on a specified wait channel.
848 sleepq_broadcast(void *wchan, int flags, int pri, int queue)
850 struct sleepqueue *sq;
851 struct thread *td, *tdn;
854 CTR2(KTR_PROC, "sleepq_broadcast(%p, %d)", wchan, flags);
855 KASSERT(wchan != NULL, ("%s: invalid NULL wait channel", __func__));
856 MPASS((queue >= 0) && (queue < NR_SLEEPQS));
857 sq = sleepq_lookup(wchan);
860 KASSERT(sq->sq_type == (flags & SLEEPQ_TYPE),
861 ("%s: mismatch between sleep/wakeup and cv_*", __func__));
863 /* Resume all blocked threads on the sleep queue. */
865 TAILQ_FOREACH_SAFE(td, &sq->sq_blocked[queue], td_slpq, tdn) {
867 if (sleepq_resume_thread(sq, td, pri))
871 return (wakeup_swapper);
875 * Time sleeping threads out. When the timeout expires, the thread is
876 * removed from the sleep queue and made runnable if it is still asleep.
879 sleepq_timeout(void *arg)
881 struct sleepqueue_chain *sc;
882 struct sleepqueue *sq;
889 CTR3(KTR_PROC, "sleepq_timeout: thread %p (pid %ld, %s)",
890 (void *)td, (long)td->td_proc->p_pid, (void *)td->td_name);
893 * First, see if the thread is asleep and get the wait channel if
897 if (TD_IS_SLEEPING(td) && TD_ON_SLEEPQ(td)) {
898 wchan = td->td_wchan;
899 sc = SC_LOOKUP(wchan);
900 THREAD_LOCKPTR_ASSERT(td, &sc->sc_lock);
901 sq = sleepq_lookup(wchan);
903 td->td_flags |= TDF_TIMEOUT;
904 wakeup_swapper = sleepq_resume_thread(sq, td, 0);
912 * If the thread is on the SLEEPQ but isn't sleeping yet, it
913 * can either be on another CPU in between sleepq_add() and
914 * one of the sleepq_*wait*() routines or it can be in
915 * sleepq_catch_signals().
917 if (TD_ON_SLEEPQ(td)) {
918 td->td_flags |= TDF_TIMEOUT;
924 * Now check for the edge cases. First, if TDF_TIMEOUT is set,
925 * then the other thread has already yielded to us, so clear
926 * the flag and resume it. If TDF_TIMEOUT is not set, then the
927 * we know that the other thread is not on a sleep queue, but it
928 * hasn't resumed execution yet. In that case, set TDF_TIMOFAIL
929 * to let it know that the timeout has already run and doesn't
930 * need to be canceled.
932 if (td->td_flags & TDF_TIMEOUT) {
933 MPASS(TD_IS_SLEEPING(td));
934 td->td_flags &= ~TDF_TIMEOUT;
936 wakeup_swapper = setrunnable(td);
938 td->td_flags |= TDF_TIMOFAIL;
945 * Resumes a specific thread from the sleep queue associated with a specific
946 * wait channel if it is on that queue.
949 sleepq_remove(struct thread *td, void *wchan)
951 struct sleepqueue *sq;
955 * Look up the sleep queue for this wait channel, then re-check
956 * that the thread is asleep on that channel, if it is not, then
959 MPASS(wchan != NULL);
961 sq = sleepq_lookup(wchan);
963 * We can not lock the thread here as it may be sleeping on a
964 * different sleepq. However, holding the sleepq lock for this
965 * wchan can guarantee that we do not miss a wakeup for this
966 * channel. The asserts below will catch any false positives.
968 if (!TD_ON_SLEEPQ(td) || td->td_wchan != wchan) {
969 sleepq_release(wchan);
972 /* Thread is asleep on sleep queue sq, so wake it up. */
975 MPASS(td->td_wchan == wchan);
976 wakeup_swapper = sleepq_resume_thread(sq, td, 0);
978 sleepq_release(wchan);
984 * Abort a thread as if an interrupt had occurred. Only abort
985 * interruptible waits (unfortunately it isn't safe to abort others).
988 sleepq_abort(struct thread *td, int intrval)
990 struct sleepqueue *sq;
993 THREAD_LOCK_ASSERT(td, MA_OWNED);
994 MPASS(TD_ON_SLEEPQ(td));
995 MPASS(td->td_flags & TDF_SINTR);
996 MPASS(intrval == EINTR || intrval == ERESTART);
999 * If the TDF_TIMEOUT flag is set, just leave. A
1000 * timeout is scheduled anyhow.
1002 if (td->td_flags & TDF_TIMEOUT)
1005 CTR3(KTR_PROC, "sleepq_abort: thread %p (pid %ld, %s)",
1006 (void *)td, (long)td->td_proc->p_pid, (void *)td->td_name);
1007 td->td_intrval = intrval;
1008 td->td_flags |= TDF_SLEEPABORT;
1010 * If the thread has not slept yet it will find the signal in
1011 * sleepq_catch_signals() and call sleepq_resume_thread. Otherwise
1012 * we have to do it here.
1014 if (!TD_IS_SLEEPING(td))
1016 wchan = td->td_wchan;
1017 MPASS(wchan != NULL);
1018 sq = sleepq_lookup(wchan);
1021 /* Thread is asleep on sleep queue sq, so wake it up. */
1022 return (sleepq_resume_thread(sq, td, 0));
1025 #ifdef SLEEPQUEUE_PROFILING
1026 #define SLEEPQ_PROF_LOCATIONS 1024
1027 #define SLEEPQ_SBUFSIZE 512
1028 struct sleepq_prof {
1029 LIST_ENTRY(sleepq_prof) sp_link;
1030 const char *sp_wmesg;
1034 LIST_HEAD(sqphead, sleepq_prof);
1036 struct sqphead sleepq_prof_free;
1037 struct sqphead sleepq_hash[SC_TABLESIZE];
1038 static struct sleepq_prof sleepq_profent[SLEEPQ_PROF_LOCATIONS];
1039 static struct mtx sleepq_prof_lock;
1040 MTX_SYSINIT(sleepq_prof_lock, &sleepq_prof_lock, "sleepq_prof", MTX_SPIN);
1043 sleepq_profile(const char *wmesg)
1045 struct sleepq_prof *sp;
1047 mtx_lock_spin(&sleepq_prof_lock);
1048 if (prof_enabled == 0)
1050 LIST_FOREACH(sp, &sleepq_hash[SC_HASH(wmesg)], sp_link)
1051 if (sp->sp_wmesg == wmesg)
1053 sp = LIST_FIRST(&sleepq_prof_free);
1056 sp->sp_wmesg = wmesg;
1057 LIST_REMOVE(sp, sp_link);
1058 LIST_INSERT_HEAD(&sleepq_hash[SC_HASH(wmesg)], sp, sp_link);
1062 mtx_unlock_spin(&sleepq_prof_lock);
1067 sleepq_prof_reset(void)
1069 struct sleepq_prof *sp;
1073 mtx_lock_spin(&sleepq_prof_lock);
1074 enabled = prof_enabled;
1076 for (i = 0; i < SC_TABLESIZE; i++)
1077 LIST_INIT(&sleepq_hash[i]);
1078 LIST_INIT(&sleepq_prof_free);
1079 for (i = 0; i < SLEEPQ_PROF_LOCATIONS; i++) {
1080 sp = &sleepq_profent[i];
1081 sp->sp_wmesg = NULL;
1083 LIST_INSERT_HEAD(&sleepq_prof_free, sp, sp_link);
1085 prof_enabled = enabled;
1086 mtx_unlock_spin(&sleepq_prof_lock);
1090 enable_sleepq_prof(SYSCTL_HANDLER_ARGS)
1095 error = sysctl_handle_int(oidp, &v, v, req);
1098 if (req->newptr == NULL)
1100 if (v == prof_enabled)
1103 sleepq_prof_reset();
1104 mtx_lock_spin(&sleepq_prof_lock);
1106 mtx_unlock_spin(&sleepq_prof_lock);
1112 reset_sleepq_prof_stats(SYSCTL_HANDLER_ARGS)
1117 error = sysctl_handle_int(oidp, &v, 0, req);
1120 if (req->newptr == NULL)
1124 sleepq_prof_reset();
1130 dump_sleepq_prof_stats(SYSCTL_HANDLER_ARGS)
1132 struct sleepq_prof *sp;
1138 error = sysctl_wire_old_buffer(req, 0);
1141 sb = sbuf_new_for_sysctl(NULL, NULL, SLEEPQ_SBUFSIZE, req);
1142 sbuf_printf(sb, "\nwmesg\tcount\n");
1143 enabled = prof_enabled;
1144 mtx_lock_spin(&sleepq_prof_lock);
1146 mtx_unlock_spin(&sleepq_prof_lock);
1147 for (i = 0; i < SC_TABLESIZE; i++) {
1148 LIST_FOREACH(sp, &sleepq_hash[i], sp_link) {
1149 sbuf_printf(sb, "%s\t%ld\n",
1150 sp->sp_wmesg, sp->sp_count);
1153 mtx_lock_spin(&sleepq_prof_lock);
1154 prof_enabled = enabled;
1155 mtx_unlock_spin(&sleepq_prof_lock);
1157 error = sbuf_finish(sb);
1162 SYSCTL_PROC(_debug_sleepq, OID_AUTO, stats, CTLTYPE_STRING | CTLFLAG_RD,
1163 NULL, 0, dump_sleepq_prof_stats, "A", "Sleepqueue profiling statistics");
1164 SYSCTL_PROC(_debug_sleepq, OID_AUTO, reset, CTLTYPE_INT | CTLFLAG_RW,
1165 NULL, 0, reset_sleepq_prof_stats, "I",
1166 "Reset sleepqueue profiling statistics");
1167 SYSCTL_PROC(_debug_sleepq, OID_AUTO, enable, CTLTYPE_INT | CTLFLAG_RW,
1168 NULL, 0, enable_sleepq_prof, "I", "Enable sleepqueue profiling");
1172 DB_SHOW_COMMAND(sleepq, db_show_sleepqueue)
1174 struct sleepqueue_chain *sc;
1175 struct sleepqueue *sq;
1177 struct lock_object *lock;
1187 * First, see if there is an active sleep queue for the wait channel
1188 * indicated by the address.
1190 wchan = (void *)addr;
1191 sc = SC_LOOKUP(wchan);
1192 LIST_FOREACH(sq, &sc->sc_queues, sq_hash)
1193 if (sq->sq_wchan == wchan)
1197 * Second, see if there is an active sleep queue at the address
1200 for (i = 0; i < SC_TABLESIZE; i++)
1201 LIST_FOREACH(sq, &sleepq_chains[i].sc_queues, sq_hash) {
1202 if (sq == (struct sleepqueue *)addr)
1206 db_printf("Unable to locate a sleep queue via %p\n", (void *)addr);
1209 db_printf("Wait channel: %p\n", sq->sq_wchan);
1210 db_printf("Queue type: %d\n", sq->sq_type);
1214 db_printf("Associated Interlock: %p - (%s) %s\n", lock,
1215 LOCK_CLASS(lock)->lc_name, lock->lo_name);
1218 db_printf("Blocked threads:\n");
1219 for (i = 0; i < NR_SLEEPQS; i++) {
1220 db_printf("\nQueue[%d]:\n", i);
1221 if (TAILQ_EMPTY(&sq->sq_blocked[i]))
1222 db_printf("\tempty\n");
1224 TAILQ_FOREACH(td, &sq->sq_blocked[0],
1226 db_printf("\t%p (tid %d, pid %d, \"%s\")\n", td,
1227 td->td_tid, td->td_proc->p_pid,
1230 db_printf("(expected: %u)\n", sq->sq_blockedcnt[i]);
1234 /* Alias 'show sleepqueue' to 'show sleepq'. */
1235 DB_SHOW_ALIAS(sleepqueue, db_show_sleepqueue);