share/man/man4/witness.4

   1 .\" Copyright (c) 2001 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 30, 2012
  28 .Dt WITNESS 4
  29 .Os
  30 .Sh NAME
  31 .Nm witness
  32 .Nd lock validation facility
  33 .Sh SYNOPSIS
  34 .Cd options WITNESS
  35 .Cd options WITNESS_COUNT
  36 .Cd options WITNESS_KDB
  37 .Cd options WITNESS_NO_VNODE
  38 .Cd options WITNESS_SKIPSPIN
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 module keeps track of the locks acquired and released by each thread.
  43 It also keeps track of the order in which locks are acquired with respect
  44 to each other.
  45 Each time a lock is acquired,
  46 .Nm
  47 uses these two lists to verify that a lock is not being acquired in the
  48 wrong order.
  49 If a lock order violation is detected, then a message is output to the
  50 kernel console detailing the locks involved and the locations in question.
  51 Witness can also be configured to drop into the kernel debugger when an order
  52 violation occurs.
  53 .Pp
  54 The
  55 .Nm
  56 code also checks various other conditions such as verifying that one
  57 does not recurse on a non-recursive lock,
  58 or attempt an upgrade on a shared lock held by another thread.
  59 If any of these checks fail, then the kernel will panic.
  60 .Pp
  61 The
  62 .Dv WITNESS_COUNT
  63 kernel option controls the maximum number of
  64 .Xr witness 4
  65 entries that are tracked in the kernel.
  66 The maximum number of entries can be queried via the
  67 .Va debug.witness.count
  68 sysctl.
  69 It can also be set from the
  70 .Xr loader 8
  71 via the
  72 .Va debug.witness.count
  73 environment variable.
  74 .Pp
  75 The
  76 .Dv WITNESS_NO_VNODE
  77 kernel option tells
  78 .Xr witness 4
  79 to ignore locking issues between
  80 .Xr vnode 9
  81 objects.
  82 .Pp
  83 The flag that controls whether or not the kernel debugger is entered when a
  84 lock order violation is detected can be set in a variety of ways.
  85 By default, the flag is off, but if the
  86 .Dv WITNESS_KDB
  87 kernel option is
  88 specified, then the flag will default to on.
  89 It can also be set from the
  90 .Xr loader 8
  91 via the
  92 .Va debug.witness.kdb
  93 environment variable or after the kernel has booted via the
  94 .Va debug.witness.kdb
  95 sysctl.
  96 If the flag is set to zero, then the debugger will not be entered.
  97 If the flag is non-zero, then the debugger will be entered.
  98 .Pp
  99 The
 100 .Nm
 101 code can also be configured to skip all checks on spin mutexes.
 102 By default, this flag defaults to off, but it can be turned on by
 103 specifying the
 104 .Dv WITNESS_SKIPSPIN
 105 kernel option.
 106 The flag can also be set via the
 107 .Xr loader 8
 108 environment variable
 109 .Va debug.witness.skipspin .
 110 If the variable is set to a non-zero value, then spin mutexes are skipped.
 111 Once the kernel has booted, the status of this flag can be examined but not
 112 set via the read-only sysctl
 113 .Va debug.witness.skipspin .
 114 .Pp
 115 The sysctl
 116 .Va debug.witness.watch
 117 specifies the level of witness involvement in the system.
 118 A value of 1 specifies that witness is enabled.
 119 A value of 0 specifies that witness is disabled, but that can be enabled
 120 again.  This will maintain a small amount of overhead in the system.
 121 A value of -1 specifies that witness is disabled permanently and
 122 cannot be enabled again.
 123 The sysctl
 124 .Va debug.witness.watch
 125 can be set via
 126 .Xr loader 8 .
 127 .Pp
 128 The
 129 .Nm
 130 code also provides three extra
 131 .Xr ddb 4
 132 commands if both
 133 .Nm
 134 and
 135 .Xr ddb 4
 136 are compiled into the kernel:
 137 .Bl -ohang
 138 .It Ic show locks Op thread
 139 Outputs the list of locks held by a thread to the kernel console
 140 along with the filename and line number at which each lock was last acquired
 141 by the thread.
 142 The optional
 143 .Ar thread
 144 argument may be either a TID,
 145 PID,
 146 or pointer to a thread structure.
 147 If
 148 .Ar thread
 149 is not specified,
 150 then the locks held by the current thread are displayed.
 151 .It Ic show all locks
 152 Outputs the list of locks held by all threads in the system to the
 153 kernel console.
 154 .It Ic show witness
 155 Dump the current order list to the kernel console.
 156 The code first displays the lock order tree for all of the sleep locks.
 157 Then it displays the lock order tree for all of the spin locks.
 158 Finally, it displays a list of locks that have not yet been acquired.
 159 .El
 160 .Sh SEE ALSO
 161 .Xr ddb 4 ,
 162 .Xr loader 8 ,
 163 .Xr sysctl 8 ,
 164 .Xr mutex 9
 165 .Sh HISTORY
 166 The
 167 .Nm
 168 code first appeared in
 169 .Bsx 5.0
 170 and was imported from there into
 171 .Fx 5.0 .