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
  71 from the total hold time
  72 and total wait time respectively and the number of acquisitions.
  73 .Pp
  74 The
  75 .Dv LOCK_PROFILING
  76 kernel option also adds the following
  77 .Xr sysctl 8
  78 variables to control and monitor the profiling code:
  79 .Bl -tag -width indent
  80 .It Va debug.lock.prof.enable
  81 Enable or disable the lock profiling code.
  82 This defaults to 0 (off).
  83 .It Va debug.lock.prof.reset
  84 Reset the current lock profiling buffers.
  85 .It Va debug.lock.prof.acquisitions
  86 The total number of lock acquisitions recorded.
  87 .It Va debug.lock.prof.records
  88 The total number of acquisition points recorded.
  89 Note that only active acquisition points (i.e., points that have been
  90 reached at least once) are counted.
  91 .It Va debug.lock.prof.maxrecords
  92 The maximum number of acquisition points the profiling code is capable
  93 of monitoring.
  94 Since it would not be possible to call
  95 .Xr malloc 9
  96 from within the lock profiling code, this is a static limit.
  97 The number of records can be changed with the
  98 .Dv LPROF_BUFFERS
  99 kernel option.
 100 .It Va debug.lock.prof.rejected
 101 The number of acquisition points that were ignored after the table
 102 filled up.
 103 .It Va debug.lock.prof.hashsize
 104 The size of the hash table used to map acquisition points to
 105 statistics records.
 106 The hash size can be changed with the
 107 .Dv LPROF_HASH_SIZE
 108 kernel option.
 109 .It Va debug.lock.prof.collisions
 110 The number of hash collisions in the acquisition point hash table.
 111 .It Va debug.lock.prof.stats
 112 The actual profiling statistics in plain text.
 113 The columns are as follows, from left to right:
 114 .Bl -tag -width ".Va cnt_hold"
 115 .It Va max
 116 The longest continuous hold time in microseconds.
 117 .It Va total
 118 The total (accumulated) hold time in microseconds.
 119 .It Va wait_total
 120 The total (accumulated) wait time in microseconds.
 121 .It Va count
 122 The total number of acquisitions.
 123 .It Va avg
 124 The average hold time in microseconds, derived from the total hold time
 125 and the number of acquisitions.
 126 .It Va wait_avg
 127 The average wait time in microseconds, derived from the total wait time
 128 and the number of acquisitions.
 129 .It Va cnt_hold
 130 The number of times the lock was held and another thread attempted to
 131 acquire the lock.
 132 .It Va cnt_lock
 133 The number of times the lock was already held when this point was
 134 reached.
 135 .It Va name
 136 The name of the acquisition point, derived from the source file name
 137 and line number, followed by the name of the lock in parentheses.
 138 .El
 139 .El
 140 .Sh SEE ALSO
 141 .Xr sysctl 8 ,
 142 .Xr mutex 9
 143 .Sh HISTORY
 144 Mutex profiling support appeared in
 145 .Fx 5.0 .
 146 Generalized lock profiling support appeared in
 147 .Fx 7.0 .
 148 .Sh AUTHORS
 149 .An -nosplit
 150 The
 151 .Nm MUTEX_PROFILING
 152 code was written by
 153 .An Eivind Eklund Aq eivind@FreeBSD.org ,
 154 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org
 155 and
 156 .An Robert Watson Aq rwatson@FreeBSD.org .
 157 The
 158 .Nm
 159 code was written by
 160 .An Kip Macy Aq kmacy@FreeBSD.org .
 161 This manual page was written by
 162 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
 163 .Sh NOTES
 164 The
 165 .Dv LOCK_PROFILING
 166 option increases the size of
 167 .Vt "struct lock_object" ,
 168 so a kernel built with that option will not work with modules built
 169 without it.
 170 .Pp
 171 The
 172 .Dv LOCK_PROFILING
 173 option also prevents inlining of the mutex code, which can result in a
 174 fairly severe performance penalty.
 175 This is, however, not always the case.
 176 .Dv LOCK_PROFILING
 177 can introduce a substantial performance overhead that is easily
 178 monitorable using other profiling tools, so combining profiling tools
 179 with
 180 .Dv LOCK_PROFILING
 181 is not recommended.
 182 .Pp
 183 Measurements are made and stored in nanoseconds using
 184 .Xr nanotime 9 ,
 185 (on architectures without a synchronized TSC) but are presented in microseconds.
 186 This should still be sufficient for the locks one would be most
 187 interested in profiling (those that are held long and/or acquired
 188 often).
 189 .Pp
 190 .Dv LOCK_PROFILING
 191 should generally not be used in combination with other debugging options, as
 192 the results may be strongly affected by interactions between the features.
 193 In particular,
 194 .Dv LOCK_PROFILING
 195 will report higher than normal
 196 .Xr uma 9
 197 lock contention when run with
 198 .Dv INVARIANTS
 199 due to extra locking that occurs when
 200 .Dv INVARIANTS
 201 is present; likewise, using it in combination with
 202 .Dv WITNESS
 203 will lead to much higher lock hold times and contention in profiling output.