share/man/man9/sx.9

   1 .\"
   2 .\" Copyright (C) 2001 Jason Evans <jasone@FreeBSD.org>.  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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd March 13, 2016
  30 .Dt SX 9
  31 .Os
  32 .Sh NAME
  33 .Nm sx ,
  34 .Nm sx_init ,
  35 .Nm sx_init_flags ,
  36 .Nm sx_destroy ,
  37 .Nm sx_slock ,
  38 .Nm sx_xlock ,
  39 .Nm sx_slock_sig ,
  40 .Nm sx_xlock_sig ,
  41 .Nm sx_try_slock ,
  42 .Nm sx_try_xlock ,
  43 .Nm sx_sunlock ,
  44 .Nm sx_xunlock ,
  45 .Nm sx_unlock ,
  46 .Nm sx_try_upgrade ,
  47 .Nm sx_downgrade ,
  48 .Nm sx_sleep ,
  49 .Nm sx_xholder ,
  50 .Nm sx_xlocked ,
  51 .Nm sx_assert ,
  52 .Nm SX_SYSINIT
  53 .Nd kernel shared/exclusive lock
  54 .Sh SYNOPSIS
  55 .In sys/param.h
  56 .In sys/lock.h
  57 .In sys/sx.h
  58 .Ft void
  59 .Fn sx_init "struct sx *sx" "const char *description"
  60 .Ft void
  61 .Fn sx_init_flags "struct sx *sx" "const char *description" "int opts"
  62 .Ft void
  63 .Fn sx_destroy "struct sx *sx"
  64 .Ft void
  65 .Fn sx_slock "struct sx *sx"
  66 .Ft void
  67 .Fn sx_xlock "struct sx *sx"
  68 .Ft int
  69 .Fn sx_slock_sig "struct sx *sx"
  70 .Ft int
  71 .Fn sx_xlock_sig "struct sx *sx"
  72 .Ft int
  73 .Fn sx_try_slock "struct sx *sx"
  74 .Ft int
  75 .Fn sx_try_xlock "struct sx *sx"
  76 .Ft void
  77 .Fn sx_sunlock "struct sx *sx"
  78 .Ft void
  79 .Fn sx_xunlock "struct sx *sx"
  80 .Ft void
  81 .Fn sx_unlock "struct sx *sx"
  82 .Ft int
  83 .Fn sx_try_upgrade "struct sx *sx"
  84 .Ft void
  85 .Fn sx_downgrade "struct sx *sx"
  86 .Ft int
  87 .Fn sx_sleep "void *chan" "struct sx *sx" "int priority" "const char *wmesg" "int timo"
  88 .Ft "struct thread *"
  89 .Fn sx_xholder "struct sx *sx"
  90 .Ft int
  91 .Fn sx_xlocked "struct sx *sx"
  92 .Pp
  93 .Cd "options INVARIANTS"
  94 .Cd "options INVARIANT_SUPPORT"
  95 .Ft void
  96 .Fn sx_assert "struct sx *sx" "int what"
  97 .In sys/kernel.h
  98 .Fn SX_SYSINIT "name" "struct sx *sx" "const char *description"
  99 .Sh DESCRIPTION
 100 Shared/exclusive locks are used to protect data that are read far more often
 101 than they are written.
 102 Shared/exclusive locks do not implement priority propagation like mutexes and
 103 reader/writer locks to prevent priority inversions, so
 104 shared/exclusive locks should be used prudently.
 105 .Pp
 106 Shared/exclusive locks are created with either
 107 .Fn sx_init
 108 or
 109 .Fn sx_init_flags
 110 where
 111 .Fa sx
 112 is a pointer to space for a
 113 .Vt struct sx ,
 114 and
 115 .Fa description
 116 is a pointer to a null-terminated character string that describes the
 117 shared/exclusive lock.
 118 The
 119 .Fa opts
 120 argument to
 121 .Fn sx_init_flags
 122 specifies a set of optional flags to alter the behavior of
 123 .Fa sx .
 124 It contains one or more of the following flags:
 125 .Bl -tag -width SX_NOADAPTIVE
 126 .It Dv SX_NOADAPTIVE
 127 Disable adaptive spinning, rather than sleeping, for lock operations
 128 while an exclusive lock holder is executing on another CPU.
 129 Adaptive spinning is the default unless the kernel is compiled with
 130 .Cd "options NO_ADAPTIVE_SX" .
 131 .It Dv SX_DUPOK
 132 Witness should not log messages about duplicate locks being acquired.
 133 .It Dv SX_NOWITNESS
 134 Instruct
 135 .Xr witness 4
 136 to ignore this lock.
 137 .It Dv SX_NOPROFILE
 138 Do not profile this lock.
 139 .It Dv SX_RECURSE
 140 Allow threads to recursively acquire exclusive locks for
 141 .Fa sx .
 142 .It Dv SX_QUIET
 143 Do not log any operations for this lock via
 144 .Xr ktr 4 .
 145 .El
 146 .Pp
 147 Shared/exclusive locks are destroyed with
 148 .Fn sx_destroy .
 149 The lock
 150 .Fa sx
 151 must not be locked by any thread when it is destroyed.
 152 .Pp
 153 Threads acquire and release a shared lock by calling
 154 .Fn sx_slock ,
 155 .Fn sx_slock_sig
 156 or
 157 .Fn sx_try_slock
 158 and
 159 .Fn sx_sunlock
 160 or
 161 .Fn sx_unlock .
 162 Threads acquire and release an exclusive lock by calling
 163 .Fn sx_xlock ,
 164 .Fn sx_xlock_sig
 165 or
 166 .Fn sx_try_xlock
 167 and
 168 .Fn sx_xunlock
 169 or
 170 .Fn sx_unlock .
 171 A thread can attempt to upgrade a currently held shared lock to an exclusive
 172 lock by calling
 173 .Fn sx_try_upgrade .
 174 A thread that has an exclusive lock can downgrade it to a shared lock by
 175 calling
 176 .Fn sx_downgrade .
 177 .Pp
 178 .Fn sx_try_slock
 179 and
 180 .Fn sx_try_xlock
 181 will return 0 if the shared/exclusive lock cannot be acquired immediately;
 182 otherwise the shared/exclusive lock will be acquired and a non-zero value will
 183 be returned.
 184 .Pp
 185 .Fn sx_try_upgrade
 186 will return 0 if the shared lock cannot be upgraded to an exclusive lock
 187 immediately; otherwise the exclusive lock will be acquired and a non-zero value
 188 will be returned.
 189 .Pp
 190 .Fn sx_slock_sig
 191 and
 192 .Fn sx_xlock_sig
 193 do the same as their normal versions but performing an interruptible sleep.
 194 They return a non-zero value if the sleep has been interrupted by a signal
 195 or an interrupt, otherwise 0.
 196 .Pp
 197 A thread can atomically release a shared/exclusive lock while waiting for an
 198 event by calling
 199 .Fn sx_sleep .
 200 For more details on the parameters to this function,
 201 see
 202 .Xr sleep 9 .
 203 .Pp
 204 When compiled with
 205 .Cd "options INVARIANTS"
 206 and
 207 .Cd "options INVARIANT_SUPPORT" ,
 208 the
 209 .Fn sx_assert
 210 function tests
 211 .Fa sx
 212 for the assertions specified in
 213 .Fa what ,
 214 and panics if they are not met.
 215 One of the following assertions must be specified:
 216 .Bl -tag -width ".Dv SA_UNLOCKED"
 217 .It Dv SA_LOCKED
 218 Assert that the current thread has either a shared or an exclusive lock on the
 219 .Vt sx
 220 lock pointed to by the first argument.
 221 .It Dv SA_SLOCKED
 222 Assert that the current thread has a shared lock on the
 223 .Vt sx
 224 lock pointed to by
 225 the first argument.
 226 .It Dv SA_XLOCKED
 227 Assert that the current thread has an exclusive lock on the
 228 .Vt sx
 229 lock pointed to
 230 by the first argument.
 231 .It Dv SA_UNLOCKED
 232 Assert that the current thread has no lock on the
 233 .Vt sx
 234 lock pointed to
 235 by the first argument.
 236 .El
 237 .Pp
 238 In addition, one of the following optional assertions may be included with
 239 either an
 240 .Dv SA_LOCKED ,
 241 .Dv SA_SLOCKED ,
 242 or
 243 .Dv SA_XLOCKED
 244 assertion:
 245 .Bl -tag -width ".Dv SA_NOTRECURSED"
 246 .It Dv SA_RECURSED
 247 Assert that the current thread has a recursed lock on
 248 .Fa sx .
 249 .It Dv SA_NOTRECURSED
 250 Assert that the current thread does not have a recursed lock on
 251 .Fa sx .
 252 .El
 253 .Pp
 254 .Fn sx_xholder
 255 will return a pointer to the thread which currently holds an exclusive lock on
 256 .Fa sx .
 257 If no thread holds an exclusive lock on
 258 .Fa sx ,
 259 then
 260 .Dv NULL
 261 is returned instead.
 262 .Pp
 263 .Fn sx_xlocked
 264 will return non-zero if the current thread holds the exclusive lock;
 265 otherwise, it will return zero.
 266 .Pp
 267 For ease of programming,
 268 .Fn sx_unlock
 269 is provided as a macro frontend to the respective functions,
 270 .Fn sx_sunlock
 271 and
 272 .Fn sx_xunlock .
 273 Algorithms that are aware of what state the lock is in should use either
 274 of the two specific functions for a minor performance benefit.
 275 .Pp
 276 The
 277 .Fn SX_SYSINIT
 278 macro is used to generate a call to the
 279 .Fn sx_sysinit
 280 routine at system startup in order to initialize a given
 281 .Fa sx
 282 lock.
 283 The parameters are the same as
 284 .Fn sx_init
 285 but with an additional argument,
 286 .Fa name ,
 287 that is used in generating unique variable names for the related
 288 structures associated with the lock and the sysinit routine.
 289 .Pp
 290 A thread may not hold both a shared lock and an exclusive lock on the same
 291 lock simultaneously;
 292 attempting to do so will result in deadlock.
 293 .Sh CONTEXT
 294 A thread may hold a shared or exclusive lock on an
 295 .Nm
 296 lock while sleeping.
 297 As a result, an
 298 .Nm
 299 lock may not be acquired while holding a mutex.
 300 Otherwise, if one thread slept while holding an
 301 .Nm
 302 lock while another thread blocked on the same
 303 .Nm
 304 lock after acquiring a mutex, then the second thread would effectively
 305 end up sleeping while holding a mutex, which is not allowed.
 306 .Sh SEE ALSO
 307 .Xr locking 9 ,
 308 .Xr lock 9 ,
 309 .Xr mutex 9 ,
 310 .Xr panic 9 ,
 311 .Xr rwlock 9 ,
 312 .Xr sema 9
 313 .Sh BUGS
 314 Currently there is no way to assert that a lock is not held.
 315 This is not possible in the
 316 .No non- Ns Dv WITNESS
 317 case for asserting that this thread
 318 does not hold a shared lock.
 319 In the
 320 .No non- Ns Dv WITNESS
 321 case, the
 322 .Dv SA_LOCKED
 323 and
 324 .Dv SA_SLOCKED
 325 assertions merely check that some thread holds a shared lock.
 326 They do not ensure that the current thread holds a shared lock.