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 November 11, 2017
  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 .Nm SX_SYSINIT_FLAGS
  54 .Nd kernel shared/exclusive lock
  55 .Sh SYNOPSIS
  56 .In sys/param.h
  57 .In sys/lock.h
  58 .In sys/sx.h
  59 .Ft void
  60 .Fn sx_init "struct sx *sx" "const char *description"
  61 .Ft void
  62 .Fn sx_init_flags "struct sx *sx" "const char *description" "int opts"
  63 .Ft void
  64 .Fn sx_destroy "struct sx *sx"
  65 .Ft void
  66 .Fn sx_slock "struct sx *sx"
  67 .Ft void
  68 .Fn sx_xlock "struct sx *sx"
  69 .Ft int
  70 .Fn sx_slock_sig "struct sx *sx"
  71 .Ft int
  72 .Fn sx_xlock_sig "struct sx *sx"
  73 .Ft int
  74 .Fn sx_try_slock "struct sx *sx"
  75 .Ft int
  76 .Fn sx_try_xlock "struct sx *sx"
  77 .Ft void
  78 .Fn sx_sunlock "struct sx *sx"
  79 .Ft void
  80 .Fn sx_xunlock "struct sx *sx"
  81 .Ft void
  82 .Fn sx_unlock "struct sx *sx"
  83 .Ft int
  84 .Fn sx_try_upgrade "struct sx *sx"
  85 .Ft void
  86 .Fn sx_downgrade "struct sx *sx"
  87 .Ft int
  88 .Fn sx_sleep "void *chan" "struct sx *sx" "int priority" "const char *wmesg" "int timo"
  89 .Ft "struct thread *"
  90 .Fn sx_xholder "struct sx *sx"
  91 .Ft int
  92 .Fn sx_xlocked "const struct sx *sx"
  93 .Pp
  94 .Cd "options INVARIANTS"
  95 .Cd "options INVARIANT_SUPPORT"
  96 .Ft void
  97 .Fn sx_assert "const struct sx *sx" "int what"
  98 .In sys/kernel.h
  99 .Fn SX_SYSINIT "name" "struct sx *sx" "const char *desc"
 100 .Fn SX_SYSINIT_FLAGS "name" "struct sx *sx" "const char *desc" "int flags"
 101 .Sh DESCRIPTION
 102 Shared/exclusive locks are used to protect data that are read far more often
 103 than they are written.
 104 Shared/exclusive locks do not implement priority propagation like mutexes and
 105 reader/writer locks to prevent priority inversions, so
 106 shared/exclusive locks should be used prudently.
 107 .Pp
 108 Shared/exclusive locks are created with either
 109 .Fn sx_init
 110 or
 111 .Fn sx_init_flags
 112 where
 113 .Fa sx
 114 is a pointer to space for a
 115 .Vt struct sx ,
 116 and
 117 .Fa description
 118 is a pointer to a null-terminated character string that describes the
 119 shared/exclusive lock.
 120 The
 121 .Fa opts
 122 argument to
 123 .Fn sx_init_flags
 124 specifies a set of optional flags to alter the behavior of
 125 .Fa sx .
 126 It contains one or more of the following flags:
 127 .It Dv SX_DUPOK
 128 Witness should not log messages about duplicate locks being acquired.
 129 .It Dv SX_NOWITNESS
 130 Instruct
 131 .Xr witness 4
 132 to ignore this lock.
 133 .It Dv SX_NOPROFILE
 134 Do not profile this lock.
 135 .It Dv SX_RECURSE
 136 Allow threads to recursively acquire exclusive locks for
 137 .Fa sx .
 138 .It Dv SX_QUIET
 139 Do not log any operations for this lock via
 140 .Xr ktr 4 .
 141 .It Dv SX_NEW
 142 If the kernel has been compiled with
 143 .Cd "options INVARIANTS" ,
 144 .Fn sx_init
 145 will assert that the
 146 .Fa sx
 147 has not been initialized multiple times without intervening calls to
 148 .Fn sx_destroy
 149 unless this option is specified.
 150 .El
 151 .Pp
 152 Shared/exclusive locks are destroyed with
 153 .Fn sx_destroy .
 154 The lock
 155 .Fa sx
 156 must not be locked by any thread when it is destroyed.
 157 .Pp
 158 Threads acquire and release a shared lock by calling
 159 .Fn sx_slock ,
 160 .Fn sx_slock_sig
 161 or
 162 .Fn sx_try_slock
 163 and
 164 .Fn sx_sunlock
 165 or
 166 .Fn sx_unlock .
 167 Threads acquire and release an exclusive lock by calling
 168 .Fn sx_xlock ,
 169 .Fn sx_xlock_sig
 170 or
 171 .Fn sx_try_xlock
 172 and
 173 .Fn sx_xunlock
 174 or
 175 .Fn sx_unlock .
 176 A thread can attempt to upgrade a currently held shared lock to an exclusive
 177 lock by calling
 178 .Fn sx_try_upgrade .
 179 A thread that has an exclusive lock can downgrade it to a shared lock by
 180 calling
 181 .Fn sx_downgrade .
 182 .Pp
 183 .Fn sx_try_slock
 184 and
 185 .Fn sx_try_xlock
 186 will return 0 if the shared/exclusive lock cannot be acquired immediately;
 187 otherwise the shared/exclusive lock will be acquired and a non-zero value will
 188 be returned.
 189 .Pp
 190 .Fn sx_try_upgrade
 191 will return 0 if the shared lock cannot be upgraded to an exclusive lock
 192 immediately; otherwise the exclusive lock will be acquired and a non-zero value
 193 will be returned.
 194 .Pp
 195 .Fn sx_slock_sig
 196 and
 197 .Fn sx_xlock_sig
 198 do the same as their normal versions but performing an interruptible sleep.
 199 They return a non-zero value if the sleep has been interrupted by a signal
 200 or an interrupt, otherwise 0.
 201 .Pp
 202 A thread can atomically release a shared/exclusive lock while waiting for an
 203 event by calling
 204 .Fn sx_sleep .
 205 For more details on the parameters to this function,
 206 see
 207 .Xr sleep 9 .
 208 .Pp
 209 When compiled with
 210 .Cd "options INVARIANTS"
 211 and
 212 .Cd "options INVARIANT_SUPPORT" ,
 213 the
 214 .Fn sx_assert
 215 function tests
 216 .Fa sx
 217 for the assertions specified in
 218 .Fa what ,
 219 and panics if they are not met.
 220 One of the following assertions must be specified:
 221 .Bl -tag -width ".Dv SA_UNLOCKED"
 222 .It Dv SA_LOCKED
 223 Assert that the current thread has either a shared or an exclusive lock on the
 224 .Vt sx
 225 lock pointed to by the first argument.
 226 .It Dv SA_SLOCKED
 227 Assert that the current thread has a shared lock on the
 228 .Vt sx
 229 lock pointed to by
 230 the first argument.
 231 .It Dv SA_XLOCKED
 232 Assert that the current thread has an exclusive lock on the
 233 .Vt sx
 234 lock pointed to
 235 by the first argument.
 236 .It Dv SA_UNLOCKED
 237 Assert that the current thread has no lock on the
 238 .Vt sx
 239 lock pointed to
 240 by the first argument.
 241 .El
 242 .Pp
 243 In addition, one of the following optional assertions may be included with
 244 either an
 245 .Dv SA_LOCKED ,
 246 .Dv SA_SLOCKED ,
 247 or
 248 .Dv SA_XLOCKED
 249 assertion:
 250 .Bl -tag -width ".Dv SA_NOTRECURSED"
 251 .It Dv SA_RECURSED
 252 Assert that the current thread has a recursed lock on
 253 .Fa sx .
 254 .It Dv SA_NOTRECURSED
 255 Assert that the current thread does not have a recursed lock on
 256 .Fa sx .
 257 .El
 258 .Pp
 259 .Fn sx_xholder
 260 will return a pointer to the thread which currently holds an exclusive lock on
 261 .Fa sx .
 262 If no thread holds an exclusive lock on
 263 .Fa sx ,
 264 then
 265 .Dv NULL
 266 is returned instead.
 267 .Pp
 268 .Fn sx_xlocked
 269 will return non-zero if the current thread holds the exclusive lock;
 270 otherwise, it will return zero.
 271 .Pp
 272 For ease of programming,
 273 .Fn sx_unlock
 274 is provided as a macro frontend to the respective functions,
 275 .Fn sx_sunlock
 276 and
 277 .Fn sx_xunlock .
 278 Algorithms that are aware of what state the lock is in should use either
 279 of the two specific functions for a minor performance benefit.
 280 .Pp
 281 The
 282 .Fn SX_SYSINIT
 283 macro is used to generate a call to the
 284 .Fn sx_sysinit
 285 routine at system startup in order to initialize a given
 286 .Fa sx
 287 lock.
 288 The parameters are the same as
 289 .Fn sx_init
 290 but with an additional argument,
 291 .Fa name ,
 292 that is used in generating unique variable names for the related
 293 structures associated with the lock and the sysinit routine.
 294 The
 295 .Fn SX_SYSINIT_FLAGS
 296 macro can similarly be used to initialize a given
 297 .Fa sx
 298 lock using
 299 .Fn sx_init_flags .
 300 .Pp
 301 A thread may not hold both a shared lock and an exclusive lock on the same
 302 lock simultaneously;
 303 attempting to do so will result in deadlock.
 304 .Sh CONTEXT
 305 A thread may hold a shared or exclusive lock on an
 306 .Nm
 307 lock while sleeping.
 308 As a result, an
 309 .Nm
 310 lock may not be acquired while holding a mutex.
 311 Otherwise, if one thread slept while holding an
 312 .Nm
 313 lock while another thread blocked on the same
 314 .Nm
 315 lock after acquiring a mutex, then the second thread would effectively
 316 end up sleeping while holding a mutex, which is not allowed.
 317 .Sh SEE ALSO
 318 .Xr lock 9 ,
 319 .Xr locking 9 ,
 320 .Xr mutex 9 ,
 321 .Xr panic 9 ,
 322 .Xr rwlock 9 ,
 323 .Xr sema 9
 324 .Sh BUGS
 325 A kernel without
 326 .Dv WITNESS
 327 cannot assert whether the current thread does or does not hold a shared lock.
 328 .Dv SA_LOCKED
 329 and
 330 .Dv SA_SLOCKED
 331 can only assert that
 332 .Em any
 333 thread holds a shared lock.
 334 They cannot ensure that the current thread holds a shared lock.
 335 Further,
 336 .Dv SA_UNLOCKED
 337 can only assert that the current thread does not hold an exclusive lock.