freebsd-dev/usr.bin/ktrdump/ktrdump.8

.\"-
.\" Copyright (c) 2002 Chad David
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
.Dd October 22, 2018
.Dt KTRDUMP 8
.Os
.Sh NAME
.Nm ktrdump
.Nd print kernel ktr trace buffer
.Sh SYNOPSIS
.Nm
.Op Fl cflqrtH
.Op Fl i Ar ktrfile
.Op Fl M Ar core
.Op Fl N Ar system
.Op Fl o Ar outfile
.Sh DESCRIPTION
The
.Nm
utility is used to dump the contents of the kernel ktr trace buffer.
.Pp
The following options are available:
.Bl -tag -width ".Fl i Ar ktrfile"
.It Fl c
Print the CPU number that each entry was logged from.
.It Fl l
Poll the kernel ktr trace buffer periodically dumping any new events after
each poll.
.It Fl f
Print the file and line number that each entry was logged from.
.It Fl q
Quiet mode; do not print the column header.
.It Fl r
Print relative timestamps rather than absolute timestamps.
.It Fl t
Print the timestamp for each entry.
.It Fl H
Print the thread ID for each entry.
.It Fl i Ar ktrfile
File containing saved ktr trace events; for more information see the
.Xr ktr 4
manual page.
.It Fl N Ar system
The kernel image to resolve symbols from.
The default is the value returned via
.Xr getbootfile 3 .
.It Fl M Ar core
The core file or memory image to read from.
The default is
.Pa /dev/mem .
.It Fl o Ar outfile
The file to write the output to.
The default is standard output.
.El
.Sh SEE ALSO
.Xr ktr 4 ,
.Xr ktr 9
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 5.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
utility was implemented by
.An Jake Burkholder Aq Mt jake@FreeBSD.org .
.Pp
This manual page was written by
.An Chad David Aq Mt davidc@FreeBSD.org .
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.\"-`
			`.\" Copyright (c) 2002 Chad David`
			`.\" 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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
Add a "live" mode to ktrdump. Support a "live" mode in ktrdump enabled via the -l flag. In this mode, ktrdump polls the kernel's trace buffer periodically (currently hardcoded as a 50 millisecond interval) and dumps any newly added entries. Fancier logic for the timeout (e.g. a command line option or some kind of backoff based on the time since the last entry) can be added later as the need arises. While here, fix some bugs from when this was Capsicum-ized: - Use caph_limit_stream() for the output stream so that isatty() works and the output can be line-buffered (especially useful for live mode). - Use caph_limit_stderr() to permit error messages to be displayed if an error occurs after cap_enter(). Reviewed by: kib, 0mp (manpage) MFC after: 2 months Differential Revision: https://reviews.freebsd.org/D17315 2018-10-22 21:25:28 +00:00			`.Dd October 22, 2018`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.Dt KTRDUMP 8`
			`.Os`
			`.Sh NAME`
			`.Nm ktrdump`
			`.Nd print kernel ktr trace buffer`
			`.Sh SYNOPSIS`
			`.Nm`
Add a "live" mode to ktrdump. Support a "live" mode in ktrdump enabled via the -l flag. In this mode, ktrdump polls the kernel's trace buffer periodically (currently hardcoded as a 50 millisecond interval) and dumps any newly added entries. Fancier logic for the timeout (e.g. a command line option or some kind of backoff based on the time since the last entry) can be added later as the need arises. While here, fix some bugs from when this was Capsicum-ized: - Use caph_limit_stream() for the output stream so that isatty() works and the output can be line-buffered (especially useful for live mode). - Use caph_limit_stderr() to permit error messages to be displayed if an error occurs after cap_enter(). Reviewed by: kib, 0mp (manpage) MFC after: 2 months Differential Revision: https://reviews.freebsd.org/D17315 2018-10-22 21:25:28 +00:00			`.Op Fl cflqrtH`
Document the '-i' option which allows the user to specify a ktr events log file. 2005-03-08 06:58:56 +00:00			`.Op Fl i Ar ktrfile`
Change ktrdump to use the more standard -M/-N flags to specify the path to a crash dump and kernel, respectively. The existing -m/-e flags are still supported for backwards compatiblity but are no longer documented. Requested by: np MFC after: 2 weeks 2015-02-06 19:41:23 +00:00			`.Op Fl M Ar core`
			`.Op Fl N Ar system`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.Op Fl o Ar outfile`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
The .Nm utility 2002-07-14 15:12:00 +00:00			`utility is used to dump the contents of the kernel ktr trace buffer.`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.Pp`
			`The following options are available:`
Change ktrdump to use the more standard -M/-N flags to specify the path to a crash dump and kernel, respectively. The existing -m/-e flags are still supported for backwards compatiblity but are no longer documented. Requested by: np MFC after: 2 weeks 2015-02-06 19:41:23 +00:00			`.Bl -tag -width ".Fl i Ar ktrfile"`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.It Fl c`
mdoc(7) police: fixed typo, minor markup nits. 2002-05-30 13:52:18 +00:00			`Print the CPU number that each entry was logged from.`
Add a "live" mode to ktrdump. Support a "live" mode in ktrdump enabled via the -l flag. In this mode, ktrdump polls the kernel's trace buffer periodically (currently hardcoded as a 50 millisecond interval) and dumps any newly added entries. Fancier logic for the timeout (e.g. a command line option or some kind of backoff based on the time since the last entry) can be added later as the need arises. While here, fix some bugs from when this was Capsicum-ized: - Use caph_limit_stream() for the output stream so that isatty() works and the output can be line-buffered (especially useful for live mode). - Use caph_limit_stderr() to permit error messages to be displayed if an error occurs after cap_enter(). Reviewed by: kib, 0mp (manpage) MFC after: 2 months Differential Revision: https://reviews.freebsd.org/D17315 2018-10-22 21:25:28 +00:00			`.It Fl l`
			`Poll the kernel ktr trace buffer periodically dumping any new events after`
			`each poll.`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.It Fl f`
			`Print the file and line number that each entry was logged from.`
Add a quiet mode to ktrdump(1): if the "-q" flag is used, don't print the pretty text header on top of the output. Simplifies feeding the results of tracing into a script for mechanical processing. 2004-05-21 21:24:58 +00:00			`.It Fl q`
mdoc(7) fixes. 2004-07-07 19:57:16 +00:00			`Quiet mode; do not print the column header.`
Add a "-r" flag to ktrdump(1) to print relative timestamps when used with "-t" rather than absolute timestamps. This allows the reader to get a better sense of latency between events, such as time to schedule an interrupt thread from time the interrupt occurred. Assert a copyright on ktrdump.c since I seem to be modifying it more than I thought. 2004-05-22 08:26:10 +00:00			`.It Fl r`
			`Print relative timestamps rather than absolute timestamps.`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.It Fl t`
			`Print the timestamp for each entry.`
Add -H flag to print thread id. 2011-01-26 06:36:14 +00:00			`.It Fl H`
			`Print the thread ID for each entry.`
Document the '-i' option which allows the user to specify a ktr events log file. 2005-03-08 06:58:56 +00:00			`.It Fl i Ar ktrfile`
			`File containing saved ktr trace events; for more information see the`
			`.Xr ktr 4`
			`manual page.`
Change ktrdump to use the more standard -M/-N flags to specify the path to a crash dump and kernel, respectively. The existing -m/-e flags are still supported for backwards compatiblity but are no longer documented. Requested by: np MFC after: 2 weeks 2015-02-06 19:41:23 +00:00			`.It Fl N Ar system`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`The kernel image to resolve symbols from.`
			`The default is the value returned via`
			`.Xr getbootfile 3 .`
Change ktrdump to use the more standard -M/-N flags to specify the path to a crash dump and kernel, respectively. The existing -m/-e flags are still supported for backwards compatiblity but are no longer documented. Requested by: np MFC after: 2 weeks 2015-02-06 19:41:23 +00:00			`.It Fl M Ar core`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`The core file or memory image to read from.`
			`The default is`
			`.Pa /dev/mem .`
			`.It Fl o Ar outfile`
			`The file to write the output to.`
mdoc(7) police: fixed typo, minor markup nits. 2002-05-30 13:52:18 +00:00			`The default is standard output.`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr ktr 4 ,`
			`.Xr ktr 9`
			`.Sh HISTORY`
			`The`
			`.Nm`
The .Nm utility 2002-07-14 15:12:00 +00:00			`utility first appeared in`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.Fx 5.0 .`
			`.Sh AUTHORS`
			`.An -nosplit`
			`The`
			`.Nm`
The .Nm utility 2002-07-14 15:12:00 +00:00			`utility was implemented by`
use .Mt to mark up email addresses consistently (part3) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-23 08:23:05 +00:00			`.An Jake Burkholder Aq Mt jake@FreeBSD.org .`
Add a man page. Submitted by: davidc 2002-04-02 04:26:37 +00:00			`.Pp`
			`This manual page was written by`
use .Mt to mark up email addresses consistently (part3) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-23 08:23:05 +00:00			`.An Chad David Aq Mt davidc@FreeBSD.org .`