[apple/system_cmds.git] / ktrace.tproj / ktrace.1

.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)ktrace.1	8.1 (Berkeley) 6/6/93
.\"
.Dd June 6, 1993
.Dt KTRACE 1
.Os BSD 4.4
.Sh NAME
.Nm ktrace
.Nd enable kernel process tracing
.Sh SYNOPSIS
.Nm ktrace
.Op Fl aCcdi
.Op Fl f Ar trfile
.Op Fl g Ar pgrp
.Op Fl p Ar pid
.Op Fl t Ar trstr
.Nm ktrace
.Op Fl adi
.Op Fl f Ar trfile
.Op Fl t Ar trstr
command
.Sh DESCRIPTION
.Nm Ktrace
enables kernel trace logging for the specified processes.
Kernel trace data is logged to the file
.Pa ktrace.out .
The kernel operations that are traced include system calls, namei
translations, signal processing, and
.Tn I/O .
.Pp
Once tracing is enabled on a process, trace data will be logged until
either the process exits or the trace point is cleared.
A traced process can generate enormous amounts of log data quickly;
It is strongly suggested that users memorize how to disable tracing before
attempting to trace a process.
The following command is sufficient to disable tracing on all user owned
processes, and, if executed by root, all processes:
.Pp
.Dl \&$ trace -C
.Pp
The trace file is not human readable; use
.Xr kdump 1
to decode it.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl a
Append to the trace file instead of truncating it.
.It Fl C
Disable tracing on all user owned processes, and, if executed by root, all
processes in the system.
.It Fl c
Clear the trace points associated with the specified file or processes.
.It Fl d
Descendants; perform the operation for all current children of the
designated processes.
.It Fl f Ar file 
Log trace records to
.Ar file
instead of
.Pa ktrace.out .
.It Fl g Ar pgid 
Enable (disable) tracing on all processes in the process group (only one
.Fl g
flag is permitted).
.It Fl i
Inherit; pass the trace flags to all future children of the designated
processes.
.It Fl p Ar pid 
Enable (disable) tracing on the indicated process id (only one
.Fl p
flag is permitted).
.It Fl t Ar trstr 
The string argument represents the kernel trace points, one per letter.
The following table equates the letters with the tracepoints:
.Pp
.Bl -tag -width flag -compact
.It Cm c
trace system calls
.It Cm n
trace namei translations
.It Cm i
trace
.Tn I/O
.It Cm s
trace signal processing
.El
.It Ar command
Execute
.Ar command
with the specified trace flags.
.El
.Pp
The
.Fl p ,
.Fl g ,
and
.Ar command
options are mutually exclusive.
.Sh EXAMPLES
# trace all kernel operations of process id 34
.Dl $ ktrace -p 34
.Pp
# trace all kernel operations of processes in process group 15 and
# pass the trace flags to all current and future children
.Dl $ ktrace -idg 15
.Pp
# disable all tracing of process 65
.Dl $ ktrace -cp 65
.Pp
# disable tracing signals on process 70 and all current children
.Dl $ ktrace -t s -cdp 70
.Pp
# enable tracing of
.Tn I/O
on process 67
.Dl $ ktrace -ti -p 67
.Pp
# run the command "w", tracing only system calls
.Dl $ ktrace -tc w
.Pp
# disable all tracing to the file "tracedata"
.Dl $ ktrace -c -f tracedata
.Pp
# disable tracing of all processes owned by the user
.Dl $ ktrace -C
.Sh SEE ALSO
.Xr kdump 1
.Sh HISTORY
The
.Nm ktrace
command appears in
.Bx 4.4 .
Commit	Line	Data
1815bff5 A	1	.\" Copyright (c) 1990, 1993
	2	.\" The Regents of the University of California. 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	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)ktrace.1 8.1 (Berkeley) 6/6/93
	33	.\"
	34	.Dd June 6, 1993
	35	.Dt KTRACE 1
	36	.Os BSD 4.4
	37	.Sh NAME
	38	.Nm ktrace
	39	.Nd enable kernel process tracing
	40	.Sh SYNOPSIS
	41	.Nm ktrace
	42	.Op Fl aCcdi
	43	.Op Fl f Ar trfile
	44	.Op Fl g Ar pgrp
	45	.Op Fl p Ar pid
	46	.Op Fl t Ar trstr
	47	.Nm ktrace
	48	.Op Fl adi
	49	.Op Fl f Ar trfile
	50	.Op Fl t Ar trstr
	51	command
	52	.Sh DESCRIPTION
	53	.Nm Ktrace
	54	enables kernel trace logging for the specified processes.
	55	Kernel trace data is logged to the file
	56	.Pa ktrace.out .
	57	The kernel operations that are traced include system calls, namei
	58	translations, signal processing, and
	59	.Tn I/O .
	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;
	64	It is strongly suggested that users memorize how to disable tracing before
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
69	.Dl \&$ trace -C
70	.Pp
71	The trace file is not human readable; use
72	.Xr kdump 1
73	to decode it.
74	.Pp
75	The options are as follows:
76	.Bl -tag -width indent
77	.It Fl a
78	Append to the trace file instead of truncating it.
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
83	Clear the trace points associated with the specified file or processes.
84	.It Fl d
85	Descendants; perform the operation for all current children of the
86	designated processes.
87	.It Fl f Ar file
88	Log trace records to
89	.Ar file
90	instead of
91	.Pa ktrace.out .
92	.It Fl g Ar pgid
93	Enable (disable) tracing on all processes in the process group (only one
94	.Fl g
95	flag is permitted).
96	.It Fl i
97	Inherit; pass the trace flags to all future children of the designated
98	processes.
99	.It Fl p Ar pid
100	Enable (disable) tracing on the indicated process id (only one
101	.Fl p
102	flag is permitted).
103	.It Fl t Ar trstr
104	The string argument represents the kernel trace points, one per letter.
105	The following table equates the letters with the tracepoints:
106	.Pp
107	.Bl -tag -width flag -compact
108	.It Cm c
109	trace system calls
110	.It Cm n
111	trace namei translations
112	.It Cm i
113	trace
114	.Tn I/O
115	.It Cm s
116	trace signal processing
117	.El
118	.It Ar command
119	Execute
120	.Ar command
121	with the specified trace flags.
122	.El
123	.Pp
124	The
125	.Fl p ,
126	.Fl g ,
127	and
128	.Ar command
129	options are mutually exclusive.
130	.Sh EXAMPLES
131	# trace all kernel operations of process id 34
132	.Dl $ ktrace -p 34
133	.Pp
134	# trace all kernel operations of processes in process group 15 and
135	# pass the trace flags to all current and future children
136	.Dl $ ktrace -idg 15
137	.Pp
138	# disable all tracing of process 65
139	.Dl $ ktrace -cp 65
140	.Pp
141	# disable tracing signals on process 70 and all current children
142	.Dl $ ktrace -t s -cdp 70
143	.Pp
144	# enable tracing of
145	.Tn I/O
146	on process 67
147	.Dl $ ktrace -ti -p 67
148	.Pp
149	# run the command "w", tracing only system calls
150	.Dl $ ktrace -tc w
151	.Pp
152	# disable all tracing to the file "tracedata"
153	.Dl $ ktrace -c -f tracedata
154	.Pp
155	# disable tracing of all processes owned by the user
156	.Dl $ ktrace -C
157	.Sh SEE ALSO
158	.Xr kdump 1
159	.Sh HISTORY
160	The
161	.Nm ktrace
162	command appears in
163	.Bx 4.4 .