Annotation of src/usr.bin/ktrace/ktrace.1, Revision 1.20
1.20 ! jmc 1: .\" $OpenBSD: ktrace.1,v 1.19 2007/05/31 19:20:11 jmc Exp $
1.9 aaron 2: .\"
1.1 deraadt 3: .\" Copyright (c) 1990, 1993
4: .\" The Regents of the University of California. All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
1.12 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 15: .\" may be used to endorse or promote products derived from this software
16: .\" without specific prior written permission.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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: .\" from: @(#)ktrace.1 8.1 (Berkeley) 6/6/93
31: .\"
1.20 ! jmc 32: .Dd $Mdocdate: May 31 2007 $
1.1 deraadt 33: .Dt KTRACE 1
1.7 aaron 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm ktrace
37: .Nd enable kernel process tracing
38: .Sh SYNOPSIS
39: .Nm ktrace
40: .Op Fl aCcdi
41: .Op Fl f Ar trfile
1.14 jmc 42: .Op Fl g Ar pgid
1.1 deraadt 43: .Op Fl p Ar pid
44: .Op Fl t Ar trstr
45: .Nm ktrace
46: .Op Fl adi
47: .Op Fl f Ar trfile
48: .Op Fl t Ar trstr
1.6 aaron 49: .Ar command
1.1 deraadt 50: .Sh DESCRIPTION
1.6 aaron 51: .Nm ktrace
1.1 deraadt 52: enables kernel trace logging for the specified processes.
1.8 aaron 53: By default, kernel trace data is logged to the file
54: .Pa ktrace.out ,
55: unless overridden by the
56: .Fl f
57: option.
1.20 ! jmc 58: The kernel operations traced are system calls, namei translations,
! 59: signal processing, I/O and emulation changes.
1.1 deraadt 60: .Pp
61: Once tracing is enabled on a process, trace data will be logged until
62: either the process exits or the trace point is cleared.
63: A traced process can generate enormous amounts of log data quickly;
1.8 aaron 64: it is strongly suggested that users memorize how to disable tracing before
1.1 deraadt 65: attempting to trace a process.
66: The following command is sufficient to disable tracing on all user owned
67: processes, and, if executed by root, all processes:
68: .Pp
1.14 jmc 69: .Dl $ ktrace -C
1.1 deraadt 70: .Pp
1.6 aaron 71: The trace file is not human-readable; use
1.1 deraadt 72: .Xr kdump 1
73: to decode it.
74: .Pp
75: The options are as follows:
1.14 jmc 76: .Bl -tag -width "-t trstr"
1.1 deraadt 77: .It Fl a
1.5 deraadt 78: Append to the trace file instead of recreating it.
1.1 deraadt 79: .It Fl C
80: Disable tracing on all user owned processes, and, if executed by root, all
81: processes in the system.
82: .It Fl c
1.20 ! jmc 83: Clear the trace points associated with the trace file or any specified
! 84: processes.
1.1 deraadt 85: .It Fl d
86: Descendants; perform the operation for all current children of the
87: designated processes.
1.17 jmc 88: .It Fl f Ar trfile
1.1 deraadt 89: Log trace records to
1.18 jmc 90: .Ar trfile
1.1 deraadt 91: instead of
92: .Pa ktrace.out .
1.7 aaron 93: .It Fl g Ar pgid
1.1 deraadt 94: Enable (disable) tracing on all processes in the process group (only one
95: .Fl g
96: flag is permitted).
97: .It Fl i
98: Inherit; pass the trace flags to all future children of the designated
99: processes.
1.7 aaron 100: .It Fl p Ar pid
1.6 aaron 101: Enable (disable) tracing on the indicated process ID (only one
1.1 deraadt 102: .Fl p
103: flag is permitted).
1.7 aaron 104: .It Fl t Ar trstr
1.1 deraadt 105: The string argument represents the kernel trace points, one per letter.
1.11 deraadt 106: The default flags are
1.13 jmc 107: .Cm c ,
108: .Cm e ,
109: .Cm i ,
110: .Cm n ,
1.11 deraadt 111: and
1.13 jmc 112: .Cm s .
1.1 deraadt 113: The following table equates the letters with the tracepoints:
114: .Pp
1.14 jmc 115: .Bl -tag -width flag -offset indent -compact
1.1 deraadt 116: .It Cm c
117: trace system calls
118: .It Cm e
119: trace emulation changes
120: .It Cm i
1.14 jmc 121: trace I/O
1.11 deraadt 122: .It Cm n
123: trace namei translations
1.1 deraadt 124: .It Cm s
125: trace signal processing
1.13 jmc 126: .It Cm w
1.11 deraadt 127: trace context switch points
1.20 ! jmc 128: .It Cm +
! 129: trace the default points
1.1 deraadt 130: .El
131: .It Ar command
132: Execute
133: .Ar command
134: with the specified trace flags.
135: .El
136: .Pp
137: The
138: .Fl p ,
139: .Fl g ,
140: and
141: .Ar command
142: options are mutually exclusive.
1.13 jmc 143: .Sh FILES
144: .Bl -tag -width ktrace.out -compact
145: .It Pa ktrace.out
146: default ktrace dump file
147: .El
1.1 deraadt 148: .Sh EXAMPLES
1.16 jmc 149: Trace all kernel operations of process ID 34:
1.1 deraadt 150: .Dl $ ktrace -p 34
1.16 jmc 151: .Pp
152: Trace all kernel operations of processes in process group 15 and
153: pass the trace flags to all current and future children:
1.1 deraadt 154: .Dl $ ktrace -idg 15
155: .Pp
1.16 jmc 156: Disable all tracing of process 65:
1.1 deraadt 157: .Dl $ ktrace -cp 65
158: .Pp
1.16 jmc 159: Disable tracing signals on process 70 and all current children:
1.1 deraadt 160: .Dl $ ktrace -t s -cdp 70
161: .Pp
1.16 jmc 162: Enable tracing of I/O on process 67:
1.1 deraadt 163: .Dl $ ktrace -ti -p 67
164: .Pp
1.16 jmc 165: Run the command
166: .Xr w 1 ,
167: tracing only system calls:
1.1 deraadt 168: .Dl $ ktrace -tc w
169: .Pp
1.16 jmc 170: Disable all tracing to the file "tracedata":
1.1 deraadt 171: .Dl $ ktrace -c -f tracedata
172: .Pp
1.16 jmc 173: Disable tracing of all processes owned by the user:
1.1 deraadt 174: .Dl $ ktrace -C
175: .Sh SEE ALSO
1.15 grunk 176: .Xr kdump 1 ,
177: .Xr ktrace 2
1.1 deraadt 178: .Sh HISTORY
179: The
180: .Nm ktrace
1.6 aaron 181: command appeared in
1.1 deraadt 182: .Bx 4.4 .
![[BACK]](/icons/back.gif){kind=icon}
Return to ktrace.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ktrace