share/man/man9/LOCK_PROFILING.9

   1 .\"-
   2 .\" Copyright (c) 2004 Dag-Erling Coïdan Smørgrav
   3 .\" Copyright (c) 2005 Robert N. M. Watson
   4 .\" Copyright (c) 2006 Kip Macy
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. The name of the author may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd November 11, 2006
  33 .Dt LOCK_PROFILING 9
  34 .Os
  35 .Sh NAME
  36 .Nm LOCK_PROFILING
  37 .Nd kernel lock profiling support
  38 .Sh SYNOPSIS
  39 .Cd "options LOCK_PROFILING"
  40 .Sh DESCRIPTION
  41 The
  42 .Dv LOCK_PROFILING
  43 kernel option adds support for measuring and reporting lock use and
  44 contention statistics.
  45 These statistics are collated by
  46 .Dq acquisition point .
  47 Acquisition points are
  48 distinct places in the kernel source code (identified by source file
  49 name and line number) where a lock is acquired.
  50 .Pp
  51 For each acquisition point, the following statistics are accumulated:
  52 .Bl -bullet
  53 .It
  54 The longest time the lock was ever continuously held after being
  55 acquired at this point.
  56 .It
  57 The total time the lock was held after being acquired at this point.
  58 .It
  59 The total time that threads have spent waiting to acquire the lock.
  60 .It
  61 The total number of non-recursive acquisitions.
  62 .It
  63 The total number of times the lock was already held by another thread
  64 when this point was reached, requiring a spin or a sleep.
  65 .It
  66 The total number of times another thread tried to acquire the lock
  67 while it was held after having been acquired at this point.
  68 .El
  69 .Pp
  70 In addition, the average hold time and average wait time are derived from the total hold time
  71 and total wait time respectively and the number of acquisitions.
  72 .Pp
  73 The
  74 .Dv LOCK_PROFILING
  75 kernel option also adds the following
  76 .Xr sysctl 8
  77 variables to control and monitor the profiling code:
  78 .Bl -tag -width indent
  79 .It Va debug.lock.prof.enable
  80 Enable or disable the lock profiling code.
  81 This defaults to 0 (off).
  82 .It Va debug.lock.prof.reset
  83 Reset the current lock profiling buffers.
  84 .It Va debug.lock.prof.acquisitions
  85 The total number of lock acquisitions recorded.
  86 .It Va debug.lock.prof.records
  87 The total number of acquisition points recorded.
  88 Note that only active acquisition points (i.e., points that have been
  89 reached at least once) are counted.
  90 .It Va debug.lock.prof.maxrecords
  91 The maximum number of acquisition points the profiling code is capable
  92 of monitoring.
  93 Since it would not be possible to call
  94 .Xr malloc 9
  95 from within the lock profiling code, this is a static limit.
  96 The number of records can be changed with the
  97 .Dv LPROF_BUFFERS
  98 kernel option.
  99 .It Va debug.lock.prof.rejected
 100 The number of acquisition points that were ignored after the table
 101 filled up.
 102 .It Va debug.lock.prof.hashsize
 103 The size of the hash table used to map acquisition points to
 104 statistics records.
 105 The hash size can be changed with the
 106 .Dv LPROF_HASH_SIZE
 107 kernel option.
 108 .It Va debug.lock.prof.collisions
 109 The number of hash collisions in the acquisition point hash table.
 110 .It Va debug.lock.prof.stats
 111 The actual profiling statistics in plain text.
 112 The columns are as follows, from left to right:
 113 .Bl -tag -width ".Va cnt_hold"
 114 .It Va max
 115 The longest continuous hold time in microseconds.
 116 .It Va total
 117 The total (accumulated) hold time in microseconds.
 118 .It Va wait_total
 119 The total (accumulated) wait time in microseconds.
 120 .It Va count
 121 The total number of acquisitions.
 122 .It Va avg
 123 The average hold time in microseconds, derived from the total hold time
 124 and the number of acquisitions.
 125 .It Va wait_avg
 126 The average wait time in microseconds, derived from the total wait time
 127 and the number of acquisitions.
 128 .It Va cnt_hold
 129 The number of times the lock was held and another thread attempted to
 130 acquire the lock.
 131 .It Va cnt_lock
 132 The number of times the lock was already held when this point was
 133 reached.
 134 .It Va name
 135 The name of the acquisition point, derived from the source file name
 136 and line number, followed by the name of the lock in parentheses.
 137 .El
 138 .El
 139 .Sh SEE ALSO
 140 .Xr sysctl 8 ,
 141 .Xr mutex 9
 142 .Sh HISTORY
 143 Mutex profiling support appeared in
 144 .Fx 5.0 .
 145 Generalized lock profiling support appeared in
 146 .Fx 5.0 .
 147 .Sh AUTHORS
 148 .An -nosplit
 149 The
 150 .Nm MUTEX_PROFILING
 151 code was written by
 152 .An Eivind Eklund Aq eivind@FreeBSD.org ,
 153 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org
 154 and
 155 .An Robert Watson Aq rwatson@FreeBSD.org .
 156 The
 157 .Nm LOCK_PROFILING
 158 code was written by
 159 .An Kip Macy Aq kmacy@FreeBSD.org .
 160 This manual page was written by
 161 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
 162 .Sh NOTES
 163 The
 164 .Dv LOCK_PROFILING
 165 option increases the size of
 166 .Vt "struct lock_object" ,
 167 so a kernel built with that option will not work with modules built
 168 without it.
 169 .Pp
 170 The
 171 .Dv LOCK_PROFILING
 172 option also prevents inlining of the mutex code, which can result in a
 173 fairly severe performance penalty. This is, however, not always the case.
 174 .Dv LOCK_PROFILING
 175 can introduce a substantial performance overhead that is easily
 176 monitorable using other profiling tools, so combining profiling tools
 177 with
 178 .Dv LOCK_PROFILING
 179 is not recommended.
 180 .Pp
 181 Measurements are made and stored in nanoseconds using
 182 .Xr nanotime 9 ,
 183 (on architectures without a synchronized TSC) but are presented in microseconds.
 184 This should still be sufficient for the locks one would be most
 185 interested in profiling (those that are held long and/or acquired
 186 often).
 187 .Pp
 188 .Dv LOCK_PROFILING
 189 should generally not be used in combination with other debugging options, as
 190 the results may be strongly affected by interactions between the features.
 191 In particular,
 192 .Dv LOCK_PROFILING
 193 will report higher than normal
 194 .Xr uma 9
 195 lock contention when run with
 196 .Dv INVARIANTS
 197 due to extra locking that occurs when
 198 .Dv INVARIANTS
 199 is present; likewise, using it in combination with
 200 .Dv WITNESS
 201 will lead to much higher lock hold times and contention in profiling output.