share/man/man9/sleepqueue.9

   1 .\" Copyright (c) 2000-2004 John H. Baldwin <jhb@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd December 12, 2009
  27 .Dt SLEEPQUEUE 9
  28 .Os
  29 .Sh NAME
  30 .Nm init_sleepqueues ,
  31 .Nm sleepq_abort ,
  32 .Nm sleepq_add ,
  33 .Nm sleepq_alloc ,
  34 .Nm sleepq_broadcast ,
  35 .Nm sleepq_calc_signal_retval ,
  36 .Nm sleepq_catch_signals ,
  37 .Nm sleepq_free ,
  38 .Nm sleepq_lock ,
  39 .Nm sleepq_lookup ,
  40 .Nm sleepq_release ,
  41 .Nm sleepq_remove ,
  42 .Nm sleepq_signal ,
  43 .Nm sleepq_set_timeout ,
  44 .Nm sleepq_timedwait ,
  45 .Nm sleepq_timedwait_sig ,
  46 .Nm sleepq_wait ,
  47 .Nm sleepq_wait_sig
  48 .Nd manage the queues of sleeping threads
  49 .Sh SYNOPSIS
  50 .In sys/param.h
  51 .In sys/sleepqueue.h
  52 .Ft void
  53 .Fn init_sleepqueues "void"
  54 .Ft int
  55 .Fn sleepq_abort "struct thread *td"
  56 .Ft void
  57 .Fn sleepq_add "void *wchan" "struct lock_object *lock" "const char *wmesg" "int flags" "int queue"
  58 .Ft struct sleepqueue *
  59 .Fn sleepq_alloc "void"
  60 .Ft int
  61 .Fn sleepq_broadcast "void *wchan" "int flags" "int pri" "int queue"
  62 .Ft int
  63 .Fn sleepq_calc_signal_retval "int sig"
  64 .Ft int
  65 .Fn sleepq_catch_signals "void *wchan"
  66 .Ft void
  67 .Fn sleepq_free "struct sleepqueue *sq"
  68 .Ft struct sleepqueue *
  69 .Fn sleepq_lookup "void *wchan"
  70 .Ft void
  71 .Fn sleepq_lock "void *wchan"
  72 .Ft void
  73 .Fn sleepq_release "void *wchan"
  74 .Ft void
  75 .Fn sleepq_remove "struct thread *td" "void *wchan"
  76 .Ft int
  77 .Fn sleepq_signal "void *wchan" "int flags" "int pri" "int queue"
  78 .Ft void
  79 .Fn sleepq_set_timeout "void *wchan" "int timo"
  80 .Ft int
  81 .Fn sleepq_timedwait "void *wchan"
  82 .Ft int
  83 .Fn sleepq_timedwait_sig "void *wchan" "int signal_caught"
  84 .Ft void
  85 .Fn sleepq_wait "void *wchan"
  86 .Ft int
  87 .Fn sleepq_wait_sig "void *wchan"
  88 .Sh DESCRIPTION
  89 Sleep queues provide a mechanism for suspending execution of a thread until
  90 some condition is met.
  91 Each queue is associated with a specific wait channel when it is active,
  92 and only one queue may be associated with a wait channel at any given point
  93 in time.
  94 The implementation of each wait channel splits its sleepqueue into 2 sub-queues
  95 in order to enable some optimizations on threads' wakeups.
  96 An active queue holds a list of threads that are blocked on the associated
  97 wait channel.
  98 Threads that are not blocked on a wait channel have an associated inactive
  99 sleep queue.
 100 When a thread blocks on a wait channel it donates its inactive sleep queue
 101 to the wait channel.
 102 When a thread is resumed,
 103 the wait channel that it was blocked on gives it an inactive sleep queue for
 104 later use.
 105 .Pp
 106 The
 107 .Fn sleepq_alloc
 108 function allocates an inactive sleep queue and is used to assign a
 109 sleep queue to a thread during thread creation.
 110 The
 111 .Fn sleepq_free
 112 function frees the resources associated with an inactive sleep queue and is
 113 used to free a queue during thread destruction.
 114 .Pp
 115 Active sleep queues are stored in a hash table hashed on the addresses pointed
 116 to by wait channels.
 117 Each bucket in the hash table contains a sleep queue chain.
 118 A sleep queue chain contains a spin mutex and a list of sleep queues that hash
 119 to that specific chain.
 120 Active sleep queues are protected by their chain's spin mutex.
 121 The
 122 .Fn init_sleepqueues
 123 function initializes the hash table of sleep queue chains.
 124 .Pp
 125 The
 126 .Fn sleepq_lock
 127 function locks the sleep queue chain associated with wait channel
 128 .Fa wchan .
 129 .Pp
 130 The
 131 .Fn sleepq_lookup
 132 returns a pointer to the currently active sleep queue for that wait
 133 channel associated with
 134 .Fa wchan
 135 or
 136 .Dv NULL
 137 if there is no active sleep queue associated with
 138 argument
 139 .Fa wchan .
 140 It requires the sleep queue chain associated with
 141 .Fa wchan
 142 to have been locked by a prior call to
 143 .Fn sleepq_lock .
 144 .Pp
 145 The
 146 .Fn sleepq_release
 147 function unlocks the sleep queue chain associated with
 148 .Fn wchan
 149 and is primarily useful when aborting a pending sleep request before one of
 150 the wait functions is called.
 151 .Pp
 152 The
 153 .Fn sleepq_add
 154 function places the current thread on the sleep queue associated with the
 155 wait channel
 156 .Fa wchan .
 157 The sleep queue chain associated with argument
 158 .Fa wchan
 159 must be locked by a prior call to
 160 .Fn sleepq_lock
 161 when this function is called.
 162 If a lock is specified via the
 163 .Fa lock
 164 argument, and if the kernel was compiled with
 165 .Cd "options INVARIANTS" ,
 166 then the sleep queue code will perform extra checks to ensure that
 167 the lock is used by all threads sleeping on
 168 .Fa wchan .
 169 The
 170 .Fa wmesg
 171 parameter should be a short description of
 172 .Fa wchan .
 173 The
 174 .Fa flags
 175 parameter is a bitmask consisting of the type of sleep queue being slept on
 176 and zero or more optional flags.
 177 The
 178 .Fa queue
 179 parameter specifies the sub-queue, in which the contending thread will be
 180 inserted.
 181 .Pp
 182 There are currently three types of sleep queues:
 183 .Pp
 184 .Bl -tag -width ".Dv SLEEPQ_CONDVAR" -compact
 185 .It Dv SLEEPQ_CONDVAR
 186 A sleep queue used to implement condition variables.
 187 .It Dv SLEEPQ_SLEEP
 188 A sleep queue used to implement
 189 .Xr sleep 9 ,
 190 .Xr wakeup 9
 191 and
 192 .Xr wakeup_one 9 .
 193 .It Dv SLEEPQ_PAUSE
 194 A sleep queue used to implement
 195 .Xr pause 9 .
 196 .El
 197 .Pp
 198 There are currently two optional flag:
 199 .Pp
 200 .Bl -tag -width ".Dv SLEEPQ_INTERRUPTIBLE" -compact
 201 .It Dv SLEEPQ_INTERRUPTIBLE
 202 The current thread is entering an interruptible sleep.
 203 .El
 204 .Bl -tag -width ".Dv SLEEPQ_STOP_ON_BDRY" -compact
 205 .It Dv SLEEPQ_STOP_ON_BDRY
 206 When thread is entering an interruptible sleep, do not stop it upon
 207 arrival of stop action, like
 208 .Dv SIGSTOP .
 209 Wake it up instead.
 210 .El
 211 .Pp
 212 A timeout on the sleep may be specified by calling
 213 .Fn sleepq_set_timeout
 214 after
 215 .Fn sleepq_add .
 216 The
 217 .Fa wchan
 218 parameter should be the same value from the preceding call to
 219 .Fn sleepq_add ,
 220 and the sleep queue chain associated with
 221 .Fa wchan
 222 must have been locked by a prior call to
 223 .Fn sleepq_lock .
 224 The
 225 .Fa timo
 226 parameter should specify the timeout value in ticks.
 227 .Pp
 228 The current thread may be marked interruptible by calling
 229 .Fn sleepq_catch_signals
 230 with
 231 .Fa wchan
 232 set to the wait channel.
 233 This function returns a signal number if there are any pending signals for
 234 the current thread and 0 if there is not a pending signal.
 235 The sleep queue chain associated with argument
 236 .Fa wchan
 237 should have been locked by a prior call to
 238 .Fn sleepq_lock .
 239 .Pp
 240 Once the thread is ready to suspend,
 241 one of the wait functions is called to put the current thread to sleep
 242 until it is awakened and to context switch to another thread.
 243 The
 244 .Fn sleepq_wait
 245 function is used for non-interruptible sleeps that do not have a timeout.
 246 The
 247 .Fn sleepq_timedwait
 248 function is used for non-interruptible sleeps that have had a timeout set via
 249 .Fn sleepq_set_timeout .
 250 The
 251 .Fn sleepq_wait_sig
 252 function is used for interruptible sleeps that do not have a timeout.
 253 The
 254 .Fn sleepq_timedwait_sig
 255 function is used for interruptible sleeps that do have a timeout set.
 256 The
 257 .Fa wchan
 258 argument to all of the wait functions is the wait channel being slept
 259 on.
 260 The sleep queue chain associated with argument
 261 .Fa wchan
 262 needs to have been locked with a prior call to
 263 .Fn sleepq_lock .
 264 The
 265 .Fa signal_caught
 266 parameter to
 267 .Fn sleepq_timedwait_sig
 268 specifies if a previous call to
 269 .Fn sleepq_catch_signals
 270 found a pending signal.
 271 .Pp
 272 When the thread is resumed,
 273 the wait functions return a non-zero value if the thread was awakened due to
 274 an interrupt other than a signal or a timeout.
 275 If the sleep timed out, then
 276 .Er EWOULDBLOCK
 277 is returned.
 278 If the sleep was interrupted by something other than a signal,
 279 then some other return value will be returned.
 280 If zero is returned after resuming from an interruptible sleep,
 281 then
 282 .Fn sleepq_calc_signal_retval
 283 should be called to determine if the sleep was interrupted by a signal.
 284 If so,
 285 .Fn sleepq_calc_signal_retval
 286 returns
 287 .Er ERESTART
 288 if the interrupting signal is restartable and
 289 .Er EINTR
 290 otherwise.
 291 If the sleep was not interrupted by a signal,
 292 .Fn sleepq_calc_signal_retval
 293 will return 0.
 294 .Pp
 295 A sleeping thread is normally resumed by the
 296 .Fn sleepq_broadcast
 297 and
 298 .Fn sleepq_signal
 299 functions.
 300 The
 301 .Fn sleepq_signal
 302 function awakens the highest priority thread sleeping on a wait channel while
 303 .Fn sleepq_broadcast
 304 awakens all of the threads sleeping on a wait channel.
 305 The
 306 .Fa wchan
 307 argument specifics which wait channel to awaken.
 308 The
 309 .Fa flags
 310 argument must match the sleep queue type contained in the
 311 .Fa flags
 312 argument passed to
 313 .Fn sleepq_add
 314 by the threads sleeping on the wait channel.
 315 If the
 316 .Fa pri
 317 argument does not equal \-1,
 318 then each thread that is awakened will have its priority raised to
 319 .Fa pri
 320 if it has a lower priority.
 321 The sleep queue chain associated with argument
 322 .Fa wchan
 323 must be locked by a prior call to
 324 .Fn sleepq_lock
 325 before calling any of these functions.
 326 The
 327 .Fa queue
 328 argument specifies the sub-queue, from which threads need to be woken up.
 329 .Pp
 330 A thread in an interruptible sleep can be interrupted by another thread via
 331 the
 332 .Fn sleepq_abort
 333 function.
 334 The
 335 .Fa td
 336 argument specifies the thread to interrupt.
 337 An individual thread can also be awakened from sleeping on a specific wait
 338 channel via the
 339 .Fn sleepq_remove
 340 function.
 341 The
 342 .Fa td
 343 argument specifies the thread to awaken and the
 344 .Fa wchan
 345 argument specifies the wait channel to awaken it from.
 346 If the thread
 347 .Fa td
 348 is not blocked on the the wait channel
 349 .Fa wchan
 350 then this function will not do anything,
 351 even if the thread is asleep on a different wait channel.
 352 This function should only be used if one of the other functions above is not
 353 sufficient.
 354 One possible use is waking up a specific thread from a widely shared sleep
 355 channel.
 356 .Pp
 357 The
 358 .Fn sleepq_abort ,
 359 .Fn sleepq_broadcast ,
 360 and
 361 .Fn sleepq_signal
 362 functions all return a boolean value.
 363 If the return value is true,
 364 then at least one thread was resumed that is currently swapped out.
 365 The caller is responsible for awakening the scheduler process so that the
 366 resumed thread will be swapped back in.
 367 This is done by calling the
 368 .Fn kick_proc0
 369 function after releasing the sleep queue chain lock via a call to
 370 .Fn sleepq_release .
 371 .Pp
 372 The sleep queue interface is currently used to implement the
 373 .Xr sleep 9
 374 and
 375 .Xr condvar 9
 376 interfaces.
 377 Almost all other code in the kernel should use one of those interfaces rather
 378 than manipulating sleep queues directly.
 379 .Sh SEE ALSO
 380 .Xr condvar 9 ,
 381 .Xr runqueue 9 ,
 382 .Xr scheduler 9 ,
 383 .Xr sleep 9