baa5c071e99a4ad7c6c2026c745890edf6400757
[dragonfly.git] / share / man / man9 / ktr.9
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/man9/ktr.9,v 1.8 2005/03/08 01:37:36 hmp Exp $
26 .\" $DragonFly: src/share/man/man9/ktr.9,v 1.11 2008/01/08 17:45:43 swildner Exp $
27 .\"
28 .Dd January 8, 2008
29 .Dt KTR 9
30 .Os
31 .Sh NAME
32 .Nm KTR_INFO_MASTER ,
33 .Nm KTR_INFO ,
34 .Nm KTR_LOG ,
35 .Nm KTR_LOG_PTR
36 .Nd kernel tracing facility
37 .Sh SYNOPSIS
38 .In sys/ktr.h
39 .Vt "extern int ktr_entries" ;
40 .Vt "extern int ktr_verbose" ;
41 .Vt "extern struct ktr_entry *ktr_buf[MAXCPU]" ;
42 .Fn KTR_INFO_MASTER "master"
43 .Fn KTR_INFO "compile" "master" "name" "maskbit" "format" "datasize"
44 .Fn KTR_LOG "info" "arg ..."
45 .Fn KTR_LOG_PTR "info" "ptr"
46 .Sh DESCRIPTION
47 The
48 .Nm ktr
49 facility provides a circular buffer of events that can be logged in a
50 .Xr kprintf 9
51 style fashion.
52 These events can then be dumped with
53 .Xr ddb 4 ,
54 .Xr gdb 1
55 or
56 .Xr ktrdump 8 .
57 .Pp
58 .Fn KTR_INFO_MASTER
59 declares a new master variable
60 .Dv ktr Ns _ Ns Fa master Ns _ Ns Dv enable
61 that is used to turn on and off event logging.
62 .Pp
63 The
64 .Fn KTR_INFO
65 macro registers a new event
66 .Fa name
67 that will be controlled by the
68 .Fa master
69 enable variable.
70 Code for logging this event will be compiled in when
71 .Fa compile
72 is defined.
73 The
74 .Fa format
75 argument is a
76 .Xr kprintf 9
77 style format string used to build the text of the event log message while
78 .Fa datasize
79 specifies the size of the data to be logged, either the total size of the
80 arguments required by the
81 .Fa format
82 string or the size of the data pointer
83 .Fa ptr .
84 For logging a fixed string with
85 .Fn KTR_INFO ,
86 .Fa datasize
87 is 0.
88 The
89 .Fa maskbit
90 is currently unused and can be set to 0.
91 .Pp
92 Kernel events are logged via the
93 .Fn KTR_LOG
94 and
95 .Fn KTR_LOG_PTR
96 macros.
97 The
98 .Fa info
99 parameter is an identifier of the format
100 .Fa master Ns _ Ns Fa name .
101 .Fn KTR_LOG
102 accepts zero or more additional
103 .Fa arg
104 arguments as required by the
105 .Fa format
106 string passed to the associated
107 .Fn KTR_INFO
108 call.
109 The
110 .Fn KTR_LOG_PTR
111 macro behaves similarly but takes a single data pointer
112 .Fa ptr
113 instead.
114 .Pp
115 The
116 .Va ktr_entries
117 variable contains the number of entries in the
118 .Va ktr_buf
119 array.
120 These variables are mostly useful for post-mortem crash dump tools to locate
121 the base of the circular trace buffer and its length.
122 .Pp
123 The
124 .Va ktr_verbose
125 variable stores the verbose flag that controls whether events are logged to
126 the console in addition to the event buffer.
127 .Sh EXAMPLES
128 This example demonstrates a simple usage of the KTR facility:
129 .Pp
130 .Bd -literal -compact
131 #include <sys/ktr.h>
132
133 \&...
134
135 #if !defined(KTR_FOO)
136 #define KTR_FOO         KTR_ALL
137 #endif
138 KTR_INFO_MASTER(foo);
139 KTR_INFO(KTR_FOO, foo, func1, 0, "func1()", 0);
140 KTR_INFO(KTR_FOO, foo, func2, 1, "func2(%d)", sizeof(int));
141
142 \&...
143
144 void
145 func1(void)
146 {
147         KTR_LOG(foo_func1);
148         ...
149 }
150
151 void
152 func2(int arg)
153 {
154         KTR_LOG(foo_func2, arg);
155         ...
156 }
157 .Ed
158 .Sh SEE ALSO
159 .Xr gdb 1 ,
160 .Xr ddb 4 ,
161 .Xr ktr 4 ,
162 .Xr ktrdump 8 ,
163 .Xr kprintf 9
164 .Sh HISTORY
165 The
166 .Nm ktr
167 kernel tracing facility first appeared in
168 .Bsx 3.0
169 and was imported into
170 .Fx 5.0
171 and
172 .Dx 1.1 .
173 It was completely rewritten by Matthew Dillon in
174 .Dx 1.3 .