share/man/man9/lock.9

   1 .\"
   2 .\" Copyright (C) 2002 Chad David <davidc@acns.ab.ca>. 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 17, 2017
  30 .Dt LOCK 9
  31 .Os
  32 .Sh NAME
  33 .Nm lockinit ,
  34 .Nm lockdestroy ,
  35 .Nm lockmgr ,
  36 .Nm lockmgr_args ,
  37 .Nm lockmgr_args_rw ,
  38 .Nm lockmgr_disown ,
  39 .Nm lockmgr_printinfo ,
  40 .Nm lockmgr_recursed ,
  41 .Nm lockmgr_rw ,
  42 .Nm lockstatus ,
  43 .Nm lockmgr_assert
  44 .Nd "lockmgr family of functions"
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In sys/lock.h
  48 .In sys/lockmgr.h
  49 .Ft void
  50 .Fn lockinit "struct lock *lkp" "int prio" "const char *wmesg" "int timo" "int flags"
  51 .Ft void
  52 .Fn lockdestroy "struct lock *lkp"
  53 .Ft int
  54 .Fn lockmgr "struct lock *lkp" "u_int flags" "struct mtx *ilk"
  55 .Ft int
  56 .Fn lockmgr_args "struct lock *lkp" "u_int flags" "struct mtx *ilk" "const char *wmesg" "int prio" "int timo"
  57 .Ft int
  58 .Fn lockmgr_args_rw "struct lock *lkp" "u_int flags" "struct rwlock *ilk" "const char *wmesg" "int prio" "int timo"
  59 .Ft void
  60 .Fn lockmgr_disown "struct lock *lkp"
  61 .Ft void
  62 .Fn lockmgr_printinfo "const struct lock *lkp"
  63 .Ft int
  64 .Fn lockmgr_recursed "const struct lock *lkp"
  65 .Ft int
  66 .Fn lockmgr_rw "struct lock *lkp" "u_int flags" "struct rwlock *ilk"
  67 .Ft int
  68 .Fn lockstatus "const struct lock *lkp"
  69 .Pp
  70 .Cd "options INVARIANTS"
  71 .Cd "options INVARIANT_SUPPORT"
  72 .Ft void
  73 .Fn lockmgr_assert "const struct lock *lkp" "int what"
  74 .Sh DESCRIPTION
  75 The
  76 .Fn lockinit
  77 function is used to initialize a lock.
  78 It must be called before any operation can be performed on a lock.
  79 Its arguments are:
  80 .Bl -tag -width ".Fa wmesg"
  81 .It Fa lkp
  82 A pointer to the lock to initialize.
  83 .It Fa prio
  84 The priority passed to
  85 .Xr sleep 9 .
  86 .It Fa wmesg
  87 The lock message.
  88 This is used for both debugging output and
  89 .Xr sleep 9 .
  90 .It Fa timo
  91 The timeout value passed to
  92 .Xr sleep 9 .
  93 .It Fa flags
  94 The flags the lock is to be initialized with:
  95 .Bl -tag -width ".Dv LK_CANRECURSE"
  96 .It Dv LK_CANRECURSE
  97 Allow recursive exclusive locks.
  98 .It Dv LK_NOPROFILE
  99 Disable lock profiling for this lock.
 100 .It Dv LK_NOSHARE
 101 Allow exclusive locks only.
 102 .It Dv LK_NOWITNESS
 103 Instruct
 104 .Xr witness 4
 105 to ignore this lock.
 106 .It Dv LK_NODUP
 107 .Xr witness 4
 108 should log messages about duplicate locks being acquired.
 109 .It Dv LK_QUIET
 110 Disable
 111 .Xr ktr 4
 112 logging for this lock.
 113 .It Dv LK_TIMELOCK
 114 Use
 115 .Fa timo
 116 during a sleep; otherwise, 0 is used.
 117 .El
 118 .El
 119 .Pp
 120 The
 121 .Fn lockdestroy
 122 function is used to destroy a lock, and while it is called in a number of
 123 places in the kernel, it currently does nothing.
 124 .Pp
 125 The
 126 .Fn lockmgr
 127 and
 128 .Fn lockmgr_rw
 129 functions handle general locking functionality within the kernel, including
 130 support for shared and exclusive locks, and recursion.
 131 .Fn lockmgr
 132 and
 133 .Fn lockmgr_rw
 134 are also able to upgrade and downgrade locks.
 135 .Pp
 136 Their arguments are:
 137 .Bl -tag -width ".Fa flags"
 138 .It Fa lkp
 139 A pointer to the lock to manipulate.
 140 .It Fa flags
 141 Flags indicating what action is to be taken.
 142 .Bl -tag -width ".Dv LK_NODDLKTREAT"
 143 .It Dv LK_SHARED
 144 Acquire a shared lock.
 145 If an exclusive lock is currently held,
 146 .Dv EDEADLK
 147 will be returned.
 148 .It Dv LK_EXCLUSIVE
 149 Acquire an exclusive lock.
 150 If an exclusive lock is already held, and
 151 .Dv LK_CANRECURSE
 152 is not set, the system will
 153 .Xr panic 9 .
 154 .It Dv LK_DOWNGRADE
 155 Downgrade exclusive lock to a shared lock.
 156 Downgrading a shared lock is not permitted.
 157 If an exclusive lock has been recursed, the system will
 158 .Xr panic 9 .
 159 .It Dv LK_UPGRADE
 160 Upgrade a shared lock to an exclusive lock.
 161 If this call fails, the shared lock is lost, even if the
 162 .Dv LK_NOWAIT
 163 flag is specified.
 164 During the upgrade, the shared lock could
 165 be temporarily dropped.
 166 Attempts to upgrade an exclusive lock will cause a
 167 .Xr panic 9 .
 168 .It Dv LK_TRYUPGRADE
 169 Try to upgrade a shared lock to an exclusive lock.
 170 The failure to upgrade does not result in the dropping
 171 of the shared lock ownership.
 172 .It Dv LK_RELEASE
 173 Release the lock.
 174 Releasing a lock that is not held can cause a
 175 .Xr panic 9 .
 176 .It Dv LK_DRAIN
 177 Wait for all activity on the lock to end, then mark it decommissioned.
 178 This is used before freeing a lock that is part of a piece of memory that is
 179 about to be freed.
 180 (As documented in
 181 .In sys/lockmgr.h . )
 182 .It Dv LK_SLEEPFAIL
 183 Fail if operation has slept.
 184 .It Dv LK_NOWAIT
 185 Do not allow the call to sleep.
 186 This can be used to test the lock.
 187 .It Dv LK_NOWITNESS
 188 Skip the
 189 .Xr witness 4
 190 checks for this instance.
 191 .It Dv LK_CANRECURSE
 192 Allow recursion on an exclusive lock.
 193 For every lock there must be a release.
 194 .It Dv LK_INTERLOCK
 195 Unlock the interlock (which should be locked already).
 196 .It Dv LK_NODDLKTREAT
 197 Normally,
 198 .Fn lockmgr
 199 postpones serving further shared requests for shared-locked lock if there is
 200 exclusive waiter, to avoid exclusive lock starvation.
 201 But, if the thread requesting the shared lock already owns a shared lockmgr
 202 lock, the request is granted even in presence of the parallel exclusive lock
 203 request, which is done to avoid deadlocks with recursive shared acquisition.
 204 .Pp
 205 The
 206 .Dv LK_NODDLKTREAT
 207 flag can only be used by code which requests shared non-recursive lock.
 208 The flag allows exclusive requests to preempt the current shared request
 209 even if the current thread owns shared locks.
 210 This is safe since shared lock is guaranteed to not recurse, and is used
 211 when thread is known to held unrelated shared locks, to not cause
 212 unnecessary starvation.
 213 An example is
 214 .Dv vp
 215 locking in VFS
 216 .Xr lookup 9 ,
 217 when
 218 .Dv dvp
 219 is already locked.
 220 .El
 221 .It Fa ilk
 222 An interlock mutex for controlling group access to the lock.
 223 If
 224 .Dv LK_INTERLOCK
 225 is specified,
 226 .Fn lockmgr
 227 and
 228 .Fn lockmgr_rw
 229 assume
 230 .Fa ilk
 231 is currently owned and not recursed, and will return it unlocked.
 232 See
 233 .Xr mtx_assert 9 .
 234 .El
 235 .Pp
 236 The
 237 .Fn lockmgr_args
 238 and
 239 .Fn lockmgr_args_rw
 240 function work like
 241 .Fn lockmgr
 242 and
 243 .Fn lockmgr_rw
 244 but accepting a
 245 .Fa wmesg ,
 246 .Fa timo
 247 and
 248 .Fa prio
 249 on a per-instance basis.
 250 The specified values will override the default
 251 ones, but this can still be used passing, respectively,
 252 .Dv LK_WMESG_DEFAULT ,
 253 .Dv LK_PRIO_DEFAULT
 254 and
 255 .Dv LK_TIMO_DEFAULT .
 256 .Pp
 257 The
 258 .Fn lockmgr_disown
 259 function switches the owner from the current thread to be
 260 .Dv LK_KERNPROC ,
 261 if the lock is already held.
 262 .Pp
 263 The
 264 .Fn lockmgr_printinfo
 265 function prints debugging information about the lock.
 266 It is used primarily by
 267 .Xr VOP_PRINT 9
 268 functions.
 269 .Pp
 270 The
 271 .Fn lockmgr_recursed
 272 function returns true if the lock is recursed, 0
 273 otherwise.
 274 .Pp
 275 The
 276 .Fn lockstatus
 277 function returns the status of the lock in relation to the current thread.
 278 .Pp
 279 When compiled with
 280 .Cd "options INVARIANTS"
 281 and
 282 .Cd "options INVARIANT_SUPPORT" ,
 283 the
 284 .Fn lockmgr_assert
 285 function tests
 286 .Fa lkp
 287 for the assertions specified in
 288 .Fa what ,
 289 and panics if they are not met.
 290 One of the following assertions must be specified:
 291 .Bl -tag -width ".Dv KA_UNLOCKED"
 292 .It Dv KA_LOCKED
 293 Assert that the current thread has either a shared or an exclusive lock on the
 294 .Vt lkp
 295 lock pointed to by the first argument.
 296 .It Dv KA_SLOCKED
 297 Assert that the current thread has a shared lock on the
 298 .Vt lkp
 299 lock pointed to by the first argument.
 300 .It Dv KA_XLOCKED
 301 Assert that the current thread has an exclusive lock on the
 302 .Vt lkp
 303 lock pointed to by the first argument.
 304 .It Dv KA_UNLOCKED
 305 Assert that the current thread has no lock on the
 306 .Vt lkp
 307 lock pointed to by the first argument.
 308 .El
 309 .Pp
 310 In addition, one of the following optional assertions can be used with
 311 either an
 312 .Dv KA_LOCKED ,
 313 .Dv KA_SLOCKED ,
 314 or
 315 .Dv KA_XLOCKED
 316 assertion:
 317 .Bl -tag -width ".Dv KA_NOTRECURSED"
 318 .It Dv KA_RECURSED
 319 Assert that the current thread has a recursed lock on
 320 .Fa lkp .
 321 .It Dv KA_NOTRECURSED
 322 Assert that the current thread does not have a recursed lock on
 323 .Fa lkp .
 324 .El
 325 .Sh RETURN VALUES
 326 The
 327 .Fn lockmgr
 328 and
 329 .Fn lockmgr_rw
 330 functions return 0 on success and non-zero on failure.
 331 .Pp
 332 The
 333 .Fn lockstatus
 334 function returns:
 335 .Bl -tag -width ".Dv LK_EXCLUSIVE"
 336 .It Dv LK_EXCLUSIVE
 337 An exclusive lock is held by the current thread.
 338 .It Dv LK_EXCLOTHER
 339 An exclusive lock is held by someone other than the current thread.
 340 .It Dv LK_SHARED
 341 A shared lock is held.
 342 .It Li 0
 343 The lock is not held by anyone.
 344 .El
 345 .Sh ERRORS
 346 .Fn lockmgr
 347 and
 348 .Fn lockmgr_rw
 349 fail if:
 350 .Bl -tag -width Er
 351 .It Bq Er EBUSY
 352 .Dv LK_FORCEUPGRADE
 353 was requested and another thread had already requested a lock upgrade.
 354 .It Bq Er EBUSY
 355 .Dv LK_NOWAIT
 356 was set, and a sleep would have been required, or
 357 .Dv LK_TRYUPGRADE
 358 operation was not able to upgrade the lock.
 359 .It Bq Er ENOLCK
 360 .Dv LK_SLEEPFAIL
 361 was set and
 362 .Fn lockmgr
 363 or
 364 .Fn lockmgr_rw
 365 did sleep.
 366 .It Bq Er EINTR
 367 .Dv PCATCH
 368 was set in the lock priority, and a signal was delivered during a sleep.
 369 Note the
 370 .Er ERESTART
 371 error below.
 372 .It Bq Er ERESTART
 373 .Dv PCATCH
 374 was set in the lock priority, a signal was delivered during a sleep,
 375 and the system call is to be restarted.
 376 .It Bq Er EWOULDBLOCK
 377 a non-zero timeout was given, and the timeout expired.
 378 .El
 379 .Sh LOCKS
 380 If
 381 .Dv LK_INTERLOCK
 382 is passed in the
 383 .Fa flags
 384 argument to
 385 .Fn lockmgr
 386 or
 387 .Fn lockmgr_rw ,
 388 the
 389 .Fa ilk
 390 must be held prior to calling
 391 .Fn lockmgr
 392 or
 393 .Fn lockmgr_rw ,
 394 and will be returned unlocked.
 395 .Pp
 396 Upgrade attempts that fail result in the loss of the lock that
 397 is currently held.
 398 Also, it is invalid to upgrade an
 399 exclusive lock, and a
 400 .Xr panic 9
 401 will be the result of trying.
 402 .Sh SEE ALSO
 403 .Xr condvar 9 ,
 404 .Xr locking 9 ,
 405 .Xr mtx_assert 9 ,
 406 .Xr mutex 9 ,
 407 .Xr panic 9 ,
 408 .Xr rwlock 9 ,
 409 .Xr sleep 9 ,
 410 .Xr sx 9 ,
 411 .Xr VOP_PRINT 9
 412 .Sh AUTHORS
 413 This manual page was written by
 414 .An Chad David Aq Mt davidc@acns.ab.ca .