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 January 8, 2010
  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_sleepcnt ,
  45 .Nm sleepq_timedwait ,
  46 .Nm sleepq_timedwait_sig ,
  47 .Nm sleepq_type ,
  48 .Nm sleepq_wait ,
  49 .Nm sleepq_wait_sig
  50 .Nd manage the queues of sleeping threads
  51 .Sh SYNOPSIS
  52 .In sys/param.h
  53 .In sys/sleepqueue.h
  54 .Ft void
  55 .Fn init_sleepqueues "void"
  56 .Ft int
  57 .Fn sleepq_abort "struct thread *td"
  58 .Ft void
  59 .Fn sleepq_add "void *wchan" "struct lock_object *lock" "const char *wmesg" "int flags" "int queue"
  60 .Ft struct sleepqueue *
  61 .Fn sleepq_alloc "void"
  62 .Ft int
  63 .Fn sleepq_broadcast "void *wchan" "int flags" "int pri" "int queue"
  64 .Ft int
  65 .Fn sleepq_calc_signal_retval "int sig"
  66 .Ft int
  67 .Fn sleepq_catch_signals "void *wchan"
  68 .Ft void
  69 .Fn sleepq_free "struct sleepqueue *sq"
  70 .Ft struct sleepqueue *
  71 .Fn sleepq_lookup "void *wchan"
  72 .Ft void
  73 .Fn sleepq_lock "void *wchan"
  74 .Ft void
  75 .Fn sleepq_release "void *wchan"
  76 .Ft void
  77 .Fn sleepq_remove "struct thread *td" "void *wchan"
  78 .Ft int
  79 .Fn sleepq_signal "void *wchan" "int flags" "int pri" "int queue"
  80 .Ft void
  81 .Fn sleepq_set_timeout "void *wchan" "int timo"
  82 .Ft u_int
  83 .Fn sleepq_sleepcnt "void *wchan" "int queue"
  84 .Ft int
  85 .Fn sleepq_timedwait "void *wchan"
  86 .Ft int
  87 .Fn sleepq_timedwait_sig "void *wchan" "int signal_caught"
  88 .Ft int
  89 .Fn sleepq_type "void *wchan"
  90 .Ft void
  91 .Fn sleepq_wait "void *wchan"
  92 .Ft int
  93 .Fn sleepq_wait_sig "void *wchan"
  94 .Sh DESCRIPTION
  95 Sleep queues provide a mechanism for suspending execution of a thread until
  96 some condition is met.
  97 Each queue is associated with a specific wait channel when it is active,
  98 and only one queue may be associated with a wait channel at any given point
  99 in time.
 100 The implementation of each wait channel splits its sleepqueue into 2 sub-queues
 101 in order to enable some optimizations on threads' wakeups.
 102 An active queue holds a list of threads that are blocked on the associated
 103 wait channel.
 104 Threads that are not blocked on a wait channel have an associated inactive
 105 sleep queue.
 106 When a thread blocks on a wait channel it donates its inactive sleep queue
 107 to the wait channel.
 108 When a thread is resumed,
 109 the wait channel that it was blocked on gives it an inactive sleep queue for
 110 later use.
 111 .Pp
 112 The
 113 .Fn sleepq_alloc
 114 function allocates an inactive sleep queue and is used to assign a
 115 sleep queue to a thread during thread creation.
 116 The
 117 .Fn sleepq_free
 118 function frees the resources associated with an inactive sleep queue and is
 119 used to free a queue during thread destruction.
 120 .Pp
 121 Active sleep queues are stored in a hash table hashed on the addresses pointed
 122 to by wait channels.
 123 Each bucket in the hash table contains a sleep queue chain.
 124 A sleep queue chain contains a spin mutex and a list of sleep queues that hash
 125 to that specific chain.
 126 Active sleep queues are protected by their chain's spin mutex.
 127 The
 128 .Fn init_sleepqueues
 129 function initializes the hash table of sleep queue chains.
 130 .Pp
 131 The
 132 .Fn sleepq_lock
 133 function locks the sleep queue chain associated with wait channel
 134 .Fa wchan .
 135 .Pp
 136 The
 137 .Fn sleepq_lookup
 138 returns a pointer to the currently active sleep queue for that wait
 139 channel associated with
 140 .Fa wchan
 141 or
 142 .Dv NULL
 143 if there is no active sleep queue associated with
 144 argument
 145 .Fa wchan .
 146 It requires the sleep queue chain associated with
 147 .Fa wchan
 148 to have been locked by a prior call to
 149 .Fn sleepq_lock .
 150 .Pp
 151 The
 152 .Fn sleepq_release
 153 function unlocks the sleep queue chain associated with
 154 .Fn wchan
 155 and is primarily useful when aborting a pending sleep request before one of
 156 the wait functions is called.
 157 .Pp
 158 The
 159 .Fn sleepq_add
 160 function places the current thread on the sleep queue associated with the
 161 wait channel
 162 .Fa wchan .
 163 The sleep queue chain associated with argument
 164 .Fa wchan
 165 must be locked by a prior call to
 166 .Fn sleepq_lock
 167 when this function is called.
 168 If a lock is specified via the
 169 .Fa lock
 170 argument, and if the kernel was compiled with
 171 .Cd "options INVARIANTS" ,
 172 then the sleep queue code will perform extra checks to ensure that
 173 the lock is used by all threads sleeping on
 174 .Fa wchan .
 175 The
 176 .Fa wmesg
 177 parameter should be a short description of
 178 .Fa wchan .
 179 The
 180 .Fa flags
 181 parameter is a bitmask consisting of the type of sleep queue being slept on
 182 and zero or more optional flags.
 183 The
 184 .Fa queue
 185 parameter specifies the sub-queue, in which the contending thread will be
 186 inserted.
 187 .Pp
 188 There are currently three types of sleep queues:
 189 .Pp
 190 .Bl -tag -width ".Dv SLEEPQ_CONDVAR" -compact
 191 .It Dv SLEEPQ_CONDVAR
 192 A sleep queue used to implement condition variables.
 193 .It Dv SLEEPQ_SLEEP
 194 A sleep queue used to implement
 195 .Xr sleep 9 ,
 196 .Xr wakeup 9
 197 and
 198 .Xr wakeup_one 9 .
 199 .It Dv SLEEPQ_PAUSE
 200 A sleep queue used to implement
 201 .Xr pause 9 .
 202 .El
 203 .Pp
 204 There are currently two optional flag:
 205 .Pp
 206 .Bl -tag -width ".Dv SLEEPQ_INTERRUPTIBLE" -compact
 207 .It Dv SLEEPQ_INTERRUPTIBLE
 208 The current thread is entering an interruptible sleep.
 209 .El
 210 .Bl -tag -width ".Dv SLEEPQ_STOP_ON_BDRY" -compact
 211 .It Dv SLEEPQ_STOP_ON_BDRY
 212 When thread is entering an interruptible sleep, do not stop it upon
 213 arrival of stop action, like
 214 .Dv SIGSTOP .
 215 Wake it up instead.
 216 .El
 217 .Pp
 218 A timeout on the sleep may be specified by calling
 219 .Fn sleepq_set_timeout
 220 after
 221 .Fn sleepq_add .
 222 The
 223 .Fa wchan
 224 parameter should be the same value from the preceding call to
 225 .Fn sleepq_add ,
 226 and the sleep queue chain associated with
 227 .Fa wchan
 228 must have been locked by a prior call to
 229 .Fn sleepq_lock .
 230 The
 231 .Fa timo
 232 parameter should specify the timeout value in ticks.
 233 .Pp
 234 The current thread may be marked interruptible by calling
 235 .Fn sleepq_catch_signals
 236 with
 237 .Fa wchan
 238 set to the wait channel.
 239 This function returns a signal number if there are any pending signals for
 240 the current thread and 0 if there is not a pending signal.
 241 The sleep queue chain associated with argument
 242 .Fa wchan
 243 should have been locked by a prior call to
 244 .Fn sleepq_lock .
 245 .Pp
 246 Once the thread is ready to suspend,
 247 one of the wait functions is called to put the current thread to sleep
 248 until it is awakened and to context switch to another thread.
 249 The
 250 .Fn sleepq_wait
 251 function is used for non-interruptible sleeps that do not have a timeout.
 252 The
 253 .Fn sleepq_timedwait
 254 function is used for non-interruptible sleeps that have had a timeout set via
 255 .Fn sleepq_set_timeout .
 256 The
 257 .Fn sleepq_wait_sig
 258 function is used for interruptible sleeps that do not have a timeout.
 259 The
 260 .Fn sleepq_timedwait_sig
 261 function is used for interruptible sleeps that do have a timeout set.
 262 The
 263 .Fa wchan
 264 argument to all of the wait functions is the wait channel being slept
 265 on.
 266 The sleep queue chain associated with argument
 267 .Fa wchan
 268 needs to have been locked with a prior call to
 269 .Fn sleepq_lock .
 270 The
 271 .Fa signal_caught
 272 parameter to
 273 .Fn sleepq_timedwait_sig
 274 specifies if a previous call to
 275 .Fn sleepq_catch_signals
 276 found a pending signal.
 277 .Pp
 278 When the thread is resumed,
 279 the wait functions return a non-zero value if the thread was awakened due to
 280 an interrupt other than a signal or a timeout.
 281 If the sleep timed out, then
 282 .Er EWOULDBLOCK
 283 is returned.
 284 If the sleep was interrupted by something other than a signal,
 285 then some other return value will be returned.
 286 If zero is returned after resuming from an interruptible sleep,
 287 then
 288 .Fn sleepq_calc_signal_retval
 289 should be called to determine if the sleep was interrupted by a signal.
 290 If so,
 291 .Fn sleepq_calc_signal_retval
 292 returns
 293 .Er ERESTART
 294 if the interrupting signal is restartable and
 295 .Er EINTR
 296 otherwise.
 297 If the sleep was not interrupted by a signal,
 298 .Fn sleepq_calc_signal_retval
 299 will return 0.
 300 .Pp
 301 A sleeping thread is normally resumed by the
 302 .Fn sleepq_broadcast
 303 and
 304 .Fn sleepq_signal
 305 functions.
 306 The
 307 .Fn sleepq_signal
 308 function awakens the highest priority thread sleeping on a wait channel while
 309 .Fn sleepq_broadcast
 310 awakens all of the threads sleeping on a wait channel.
 311 The
 312 .Fa wchan
 313 argument specifics which wait channel to awaken.
 314 The
 315 .Fa flags
 316 argument must match the sleep queue type contained in the
 317 .Fa flags
 318 argument passed to
 319 .Fn sleepq_add
 320 by the threads sleeping on the wait channel.
 321 If the
 322 .Fa pri
 323 argument does not equal \-1,
 324 then each thread that is awakened will have its priority raised to
 325 .Fa pri
 326 if it has a lower priority.
 327 The sleep queue chain associated with argument
 328 .Fa wchan
 329 must be locked by a prior call to
 330 .Fn sleepq_lock
 331 before calling any of these functions.
 332 The
 333 .Fa queue
 334 argument specifies the sub-queue, from which threads need to be woken up.
 335 .Pp
 336 A thread in an interruptible sleep can be interrupted by another thread via
 337 the
 338 .Fn sleepq_abort
 339 function.
 340 The
 341 .Fa td
 342 argument specifies the thread to interrupt.
 343 An individual thread can also be awakened from sleeping on a specific wait
 344 channel via the
 345 .Fn sleepq_remove
 346 function.
 347 The
 348 .Fa td
 349 argument specifies the thread to awaken and the
 350 .Fa wchan
 351 argument specifies the wait channel to awaken it from.
 352 If the thread
 353 .Fa td
 354 is not blocked on the wait channel
 355 .Fa wchan
 356 then this function will not do anything,
 357 even if the thread is asleep on a different wait channel.
 358 This function should only be used if one of the other functions above is not
 359 sufficient.
 360 One possible use is waking up a specific thread from a widely shared sleep
 361 channel.
 362 .Pp
 363 The
 364 .Fn sleepq_sleepcnt
 365 function offer a simple way to retrieve the number of threads sleeping for
 366 the specified
 367 .Fa queue ,
 368 given a
 369 .Fa wchan .
 370 .Pp
 371 The
 372 .Fn sleepq_type
 373 function returns the type of
 374 .Fa wchan
 375 associated to a sleepqueue.
 376 .Pp
 377 The
 378 .Fn sleepq_abort ,
 379 .Fn sleepq_broadcast ,
 380 and
 381 .Fn sleepq_signal
 382 functions all return a boolean value.
 383 If the return value is true,
 384 then at least one thread was resumed that is currently swapped out.
 385 The caller is responsible for awakening the scheduler process so that the
 386 resumed thread will be swapped back in.
 387 This is done by calling the
 388 .Fn kick_proc0
 389 function after releasing the sleep queue chain lock via a call to
 390 .Fn sleepq_release .
 391 .Pp
 392 The sleep queue interface is currently used to implement the
 393 .Xr sleep 9
 394 and
 395 .Xr condvar 9
 396 interfaces.
 397 Almost all other code in the kernel should use one of those interfaces rather
 398 than manipulating sleep queues directly.
 399 .Sh SEE ALSO
 400 .Xr condvar 9 ,
 401 .Xr runqueue 9 ,
 402 .Xr scheduler 9 ,
 403 .Xr sleep 9