1 .\" Copyright (c) 2001 John H. Baldwin <jhb@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
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.8 2006/05/26 19:39:40 swildner Exp $
39 .Nd kernel tracing facility
43 .Vt "extern int ktr_cpumask" ;
44 .Vt "extern int ktr_entries" ;
45 .Vt "extern int ktr_extend" ;
46 .Vt "extern int ktr_mask" ;
47 .Vt "extern int ktr_verbose" ;
48 .Vt "extern struct ktr_entry ktr_buf[]" ;
50 .Fn CTR0 "u_int mask" "char *format"
52 .Fn CTR1 "u_int mask" "char *format" "arg1"
54 .Fn CTR2 "u_int mask" "char *format" "arg1" "arg2"
56 .Fn CTR3 "u_int mask" "char *format" "arg1" "arg2" "arg3"
58 .Fn CTR4 "u_int mask" "char *format" "arg1" "arg2" "arg3" "arg4"
60 .Fn CTR5 "u_int mask" "char *format" "arg1" "arg2" "arg3" "arg4" "arg5"
62 .Fn CTR6 "u_int mask" "char *format" "arg1" "arg2" "arg3" "arg4" "arg5" "arg6"
64 KTR provides a circular buffer of events that can be logged in a
68 These events can then be dumped with
74 Events are created and logged in the kernel via the
77 The first parameter is a mask of event types
81 The event will be logged only if any of the event types specified in
83 are enabled in the global event mask stored in
89 style format string used to build the text of the event log message.
92 string are zero to five arguments referenced by
94 Note that the different macros differ only in the number of arguments each
95 one takes, as indicated by its name.
96 Each event is logged with a timestamp in addition to the log message.
100 variable contains the number of entries in the
103 These variables are mostly useful for post-mortem crash dump tools to locate
104 the base of the circular trace buffer and its length.
108 variable contains the run time mask of events to log.
110 The CPU event mask is stored in the
116 variable stores the verbose flag that controls whether events are logged to
117 the console in addition to the event buffer.
119 This example demonstrates the use of tracepoints at the
122 .Bd -literal -compact
128 * Pick a new current process and record its start time.
131 CTR3(KTR_PROC, "mi_switch: old proc %p (pid %d, %s)", p, p->p_pid,
136 CTR3(KTR_PROC, "mi_switch: new proc %p (pid %d, %s)", p, p->p_pid,
144 The KTR kernel tracing facility first appeared in
146 and was imported into