9fa56267e8e75c392c3f731bbe1423fad9e6353d
[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 .\" $DragonFly: src/share/man/man4/ktr.4,v 1.7 2008/05/01 02:03:28 sephe Exp $
27 .\"
28 .Dd April 30, 2008
29 .Dt KTR 4
30 .Os
31 .Sh NAME
32 .Nm ktr
33 .Nd kernel tracing facility
34 .Sh SYNOPSIS
35 .Cd options KTR
36 .Cd options KTR_ENTRIES=8192
37 .Cd options KTR_VERBOSE=1
38 .Cd options KTR_ALL
39 .Cd options KTR_GIANT_CONTENTION
40 .Cd options KTR_IF_BGE
41 .Cd options KTR_IF_EM
42 .Cd options KTR_IPIQ
43 .Cd options KTR_MEMORY
44 .Cd options KTR_POLLING
45 .Cd options KTR_SERIALIZER
46 .Cd options KTR_SPIN_CONTENTION
47 .\".Cd options KTR_TCP
48 .Cd options KTR_TESTLOG
49 .Cd options KTR_TOKENS
50 .\".Cd options KTR_TSLEEP
51 .Cd options KTR_USB_MEMORY
52 .Sh DESCRIPTION
53 The
54 .Nm
55 facility allows kernel events to be logged while the kernel executes so that
56 they can be examined later when debugging.
57 The only mandatory option to enable
58 .Nm
59 is
60 .Cd options KTR .
61 .Pp
62 The
63 .Dv KTR_ENTRIES
64 option sets the size of the buffer of events.
65 It should be a power of two.
66 The size of the buffer in the currently running kernel can be found via the
67 read-only sysctl
68 .Va debug.ktr.entries .
69 By default the buffer contains 2048 entries.
70 .Pp
71 For debugging purposes, the following
72 .Nm
73 related kernel options exist:
74 .Bl -tag -width ".Dv KTR_GIANT_CONTENTION"
75 .It Dv KTR_ALL
76 turns on all options
77 .It Dv KTR_GIANT_CONTENTION
78 contention of the giant lock
79 .It Dv KTR_IF_BGE
80 .Xr bge 4
81 interrupts and sent/received packets
82 .It Dv KTR_IF_EM
83 .Xr em 4
84 interrupts, polling and sent/received packets
85 .It Dv KTR_IPIQ
86 IPI related data (IPI requests, CPU synchronization etc.)
87 .It Dv KTR_MEMORY
88 .Xr kmalloc 9
89 and
90 .Xr kfree 9
91 events
92 .It Dv KTR_POLLING
93 .Xr polling 4
94 begins and ends
95 .It Dv KTR_SERIALIZER
96 .Xr serializer 9
97 related events
98 .It Dv KTR_SPIN_CONTENTION
99 .Xr spinlock 9
100 contention
101 .It Dv KTR_TESTLOG
102 IPI performance testing
103 .It Dv KTR_TOKENS
104 LWKT token related events
105 .It Dv KTR_USB_MEMORY
106 USB memory allocation
107 .El
108 .Ss Verbose Mode
109 By default, events are only logged to the internal buffer for examination
110 later, but if the verbose flag is set then they are dumped to the kernel
111 console as well.
112 This flag can also be set from the loader via the
113 .Va debug.ktr.verbose
114 environment variable, or it can be examined and set after booting via the
115 .Va debug.ktr.verbose
116 sysctl.
117 If the flag is set to zero, which is the default, then verbose output is
118 disabled.
119 If the flag is set to one, then the contents of the log message and the CPU
120 number are printed to the kernel console.
121 If the flag is greater than one, then the filename and line number of the
122 event are output to the console in addition to the log message and the CPU
123 number.
124 The
125 .Dv KTR_VERBOSE
126 option enables verbose mode and sets the flag to one.
127 .Ss Examining the Events
128 The KTR buffer can be examined with
129 .Xr ktrdump 8 ,
130 .Xr gdb 1
131 or from within
132 .Xr ddb 4
133 via the
134 .Ic show ktr Op Cm /v
135 command.
136 This command displays the contents of the trace buffer one page at a time.
137 At the
138 .Dq Li --more--
139 prompt, the Enter key displays one more entry and prompts again.
140 The spacebar displays another page of entries.
141 Any other key quits.
142 By default the timestamp, filename, and line number are not displayed with
143 each log entry.
144 If the
145 .Cm /v
146 modifier is specified, then they are displayed in addition to the normal
147 output.
148 Note that the events are displayed in reverse chronological order.
149 That is, the most recent events are displayed first.
150 .Sh SEE ALSO
151 .Xr gdb 1 ,
152 .Xr ddb 4 ,
153 .Xr ktrdump 8 ,
154 .Xr ktr 9
155 .Sh HISTORY
156 The KTR kernel tracing facility first appeared in
157 .Bsx 3.0
158 and was imported into
159 .Fx 5.0
160 and
161 .Dx 1.1 .
162 It was completely rewritten by Matthew Dillon in
163 .Dx 1.3 .