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