ktr.4 - add note about KTR_USCHED_BSD4
[dragonfly.git] / share / man / man4 / ktr.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: src/share/man/man4/ktr.4,v 1.9 2003/09/08 19:57:19 ru Exp $
26 .\"
27 .Dd August 13, 2011
28 .Dt KTR 4
29 .Os
30 .Sh NAME
31 .Nm ktr
32 .Nd kernel tracing facility
33 .Sh SYNOPSIS
34 .Cd options KTR
35 .Cd options KTR_ENTRIES=8192
36 .Cd options KTR_VERBOSE=1
37 .Cd options KTR_ALL
38 .Cd options KTR_CTXSW
39 .Cd options KTR_DMCRYPT
40 .Cd options KTR_ETHERNET
41 .\".Cd options KTR_HAMMER
42 .Cd options KTR_IF_BGE
43 .Cd options KTR_IF_EM
44 .Cd options KTR_IF_EMX
45 .Cd options KTR_IF_START
46 .Cd options KTR_IFQ
47 .Cd options KTR_IPIQ
48 .Cd options KTR_KERNENTRY
49 .Cd options KTR_MEMORY
50 .Cd options KTR_POLLING
51 .Cd options KTR_SERIALIZER
52 .Cd options KTR_SPIN_CONTENTION
53 .\".Cd options KTR_TCP
54 .Cd options KTR_TESTLOG
55 .Cd options KTR_TOKENS
56 .Cd options KTR_TSLEEP
57 .Cd options KTR_USB_MEMORY
58 .Cd options KTR_USCHED_BSD4
59 .Sh DESCRIPTION
60 The
61 .Nm
62 facility allows kernel events to be logged while the kernel executes so that
63 they can be examined later when debugging.
64 The only mandatory option to enable
65 .Nm
66 is
67 .Cd options KTR .
68 .Pp
69 The
70 .Dv KTR_ENTRIES
71 option sets the size of the buffer of events.
72 It must be a power of two.
73 The size of the buffer in the currently running kernel can be found via the
74 read-only sysctl
75 .Va debug.ktr.entries .
76 By default the buffer contains 2048 entries.
77 .Pp
78 For debugging purposes, the following
79 .Nm
80 related kernel options exist:
81 .Bl -tag -width ".Dv KTR_SPIN_CONTENTION"
82 .It Dv KTR_ALL
83 turns on all options
84 .It Dv KTR_CTXSW
85 context switches
86 .It Dv KTR_DMCRYPT
87 read and write strategy paths of
88 .Xr dm 4 Ap s
89 .Pa crypt
90 target
91 .It Dv KTR_ETHERNET
92 cost of
93 .Fn ether_input_pkt
94 and
95 .Fn ether_dispatch
96 .It Dv KTR_IF_BGE
97 .Xr bge 4
98 interrupts and sent/received packets
99 .It Dv KTR_IF_EM
100 .Xr em 4
101 interrupts and sent/received packets
102 .It Dv KTR_IF_EMX
103 .Xr emx 4
104 interrupts and sent/received packets
105 .It Dv KTR_IFQ
106 classic ifq dequeue/enqueue operation
107 .It Dv KTR_IF_START
108 running/avoiding/scheduling ifnet.if_start
109 .It Dv KTR_IPIQ
110 IPI related data (IPI requests, CPU synchronization etc.)
111 .It Dv KTR_KERNENTRY
112 entry of the kernel from userland (faults, syscalls)
113 .It Dv KTR_MEMORY
114 .Xr kmalloc 9
115 and
116 .Xr kfree 9
117 events
118 .It Dv KTR_POLLING
119 .Xr polling 4
120 begins and ends
121 .It Dv KTR_SERIALIZER
122 .Xr serializer 9
123 related events
124 .It Dv KTR_SPIN_CONTENTION
125 .Xr spinlock 9
126 contention
127 .It Dv KTR_TESTLOG
128 IPI performance testing
129 .It Dv KTR_TOKENS
130 LWKT token related events
131 .It Dv KTR_TSLEEP
132 .Xr tsleep 9
133 and
134 .Xr wakeup 9
135 .It Dv KTR_USB_MEMORY
136 USB memory allocation
137 .It Dv KTR_USCHED_BSD4
138 usched_bsd4 scheduling decisions
139 .El
140 .Ss Verbose Mode
141 By default, events are only logged to the internal buffer for examination
142 later, but if the verbose flag is set then they are dumped to the kernel
143 console as well.
144 This flag can also be set from the loader via the
145 .Va debug.ktr.verbose
146 environment variable, or it can be examined and set after booting via the
147 .Va debug.ktr.verbose
148 sysctl.
149 If the flag is set to zero, which is the default, then verbose output is
150 disabled.
151 If the flag is set to one, then the contents of the log message and the CPU
152 number are printed to the kernel console.
153 If the flag is greater than one, then the filename and line number of the
154 event are output to the console in addition to the log message and the CPU
155 number.
156 The
157 .Dv KTR_VERBOSE
158 option enables verbose mode and sets the flag to one.
159 .Ss Examining the Events
160 The KTR buffer can be examined with
161 .Xr ktrdump 8 ,
162 .Xr gdb 1
163 or from within
164 .Xr ddb 4
165 via the
166 .Ic show ktr Op Cm /v
167 command.
168 This command displays the contents of the trace buffer one page at a time.
169 At the
170 .Dq Li --more--
171 prompt, the Enter key displays one more entry and prompts again.
172 The spacebar displays another page of entries.
173 Any other key quits.
174 By default the timestamp, filename, and line number are not displayed with
175 each log entry.
176 If the
177 .Cm /v
178 modifier is specified, then they are displayed in addition to the normal
179 output.
180 Note that the events are displayed in reverse chronological order.
181 That is, the most recent events are displayed first.
182 .Sh SYSCTL VARIABLES
183 .Bl -tag -width ".Va debug.ktr.resynchronize"
184 .It Va debug.ktr.*_enable
185 A 32 bit mask used to control event logging.
186 Each bit corresponds to one or more events depending on the values of the
187 .Fa maskbit
188 parameters that were passed to the
189 .Xr KTR_INFO 9
190 calls which declared the events.
191 .Pp
192 Unless
193 .Dv KTR_ALL
194 is specified in the kernel configuration, the default is to turn on logging
195 for all corresponding events (i.e.\& setting the sysctl to -1).
196 .It Va debug.ktr.*_mask
197 Read only sysctls (one per event) that show the
198 .Va debug.ktr.*_enable
199 values corresponding to the events.
200 .It Va debug.ktr.resynchronize
201 Resynchronize the TSC across all CPUs 10 times per second in an attempt to
202 reduce drift errors.
203 Note that this is very expensive and therefore the default is 0.
204 .El
205 .Sh SEE ALSO
206 .Xr gdb 1 ,
207 .Xr ddb 4 ,
208 .Xr ktrdump 8 ,
209 .Xr ktr 9
210 .Sh HISTORY
211 The KTR kernel tracing facility first appeared in
212 .Bsx 3.0
213 and was imported into
214 .Fx 5.0
215 and
216 .Dx 1.1 .
217 It was completely rewritten by Matthew Dillon in
218 .Dx 1.3 .