xref: /freebsd/usr.sbin/boottrace/boottrace.8 (revision 4d846d260e2b9a3d4d0a701462568268cbfe7a5b)
1*4d846d26SWarner Losh.\" SPDX-License-Identifier: BSD-2-Clause
213ec1e31SMitchell Horne.\"
313ec1e31SMitchell Horne.\" Copyright (c) 2022 NetApp, Inc.
413ec1e31SMitchell Horne.\"
513ec1e31SMitchell Horne.\" Redistribution and use in source and binary forms, with or without
613ec1e31SMitchell Horne.\" modification, are permitted provided that the following conditions
713ec1e31SMitchell Horne.\" are met:
813ec1e31SMitchell Horne.\" 1. Redistributions of source code must retain the above copyright
913ec1e31SMitchell Horne.\"    notice, this list of conditions and the following disclaimer.
1013ec1e31SMitchell Horne.\" 2. Redistributions in binary form must reproduce the above copyright
1113ec1e31SMitchell Horne.\"    notice, this list of conditions and the following disclaimer in the
1213ec1e31SMitchell Horne.\"    documentation and/or other materials provided with the distribution.
1313ec1e31SMitchell Horne.\"
1413ec1e31SMitchell Horne.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1513ec1e31SMitchell Horne.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1613ec1e31SMitchell Horne.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1713ec1e31SMitchell Horne.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1813ec1e31SMitchell Horne.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1913ec1e31SMitchell Horne.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2013ec1e31SMitchell Horne.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2113ec1e31SMitchell Horne.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2213ec1e31SMitchell Horne.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2313ec1e31SMitchell Horne.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2413ec1e31SMitchell Horne.\" SUCH DAMAGE.
2513ec1e31SMitchell Horne.\"
2613ec1e31SMitchell Horne.Dd February 18, 2022
2713ec1e31SMitchell Horne.Dt BOOTTRACE 8
2813ec1e31SMitchell Horne.Os
2913ec1e31SMitchell Horne.Sh NAME
3013ec1e31SMitchell Horne.Nm boottrace
3113ec1e31SMitchell Horne.Nd trace command execution with
3213ec1e31SMitchell Horne.Xr boottrace 4
3313ec1e31SMitchell Horne.Sh SYNOPSIS
3413ec1e31SMitchell Horne.Nm
3513ec1e31SMitchell Horne.Ar utility Op Ar argument ...
3613ec1e31SMitchell Horne.Sh DESCRIPTION
3713ec1e31SMitchell HorneThe
3813ec1e31SMitchell Horne.Nm
3913ec1e31SMitchell Horneutility
4013ec1e31SMitchell Horneexecutes the specified
4113ec1e31SMitchell Horne.Ar utility ,
4213ec1e31SMitchell Hornecreating two
4313ec1e31SMitchell Horne.Xr boottrace 4
4413ec1e31SMitchell Hornetrace entries before and after its execution.
4513ec1e31SMitchell Horne.Sh ENVIRONMENT
4613ec1e31SMitchell HorneThe
4713ec1e31SMitchell Horne.Ev PATH
4813ec1e31SMitchell Horneenvironment variable is used to locate the requested
4913ec1e31SMitchell Horne.Ar utility
5013ec1e31SMitchell Horneif the name contains no
5113ec1e31SMitchell Horne.Ql /
5213ec1e31SMitchell Hornecharacters.
5313ec1e31SMitchell Horne.Sh EXIT STATUS
5413ec1e31SMitchell HorneIf
5513ec1e31SMitchell Horne.Ar utility
5613ec1e31SMitchell Hornewas executed successfully, its exit status is returned.
5713ec1e31SMitchell Horne.Pp
5813ec1e31SMitchell HorneIf
5913ec1e31SMitchell Horne.Ar utility
6013ec1e31SMitchell Hornewas found but could not be executed, an exit status of 126 is returned.
6113ec1e31SMitchell HorneIf
6213ec1e31SMitchell Horne.Ar utility
6313ec1e31SMitchell Hornecould not be found, an exit status of 127 is returned.
6413ec1e31SMitchell Horne.Sh EXAMPLES
6513ec1e31SMitchell HorneExecute the
6613ec1e31SMitchell Horne.Xr dumpon 8
6713ec1e31SMitchell Horneutility, logging the trace entries:
6813ec1e31SMitchell Horne.Bd -literal -offset indent
6913ec1e31SMitchell Horne$ boottrace dumpon -z /dev/gpt/swap0
7013ec1e31SMitchell Horne.Ed
7113ec1e31SMitchell Horne.Pp
7213ec1e31SMitchell HorneThis will appear in the output of the
7313ec1e31SMitchell Horne.Va kern.boottrace.log
7413ec1e31SMitchell Horne.Xr sysctl 8
7513ec1e31SMitchell Hornenode:
7613ec1e31SMitchell Horne.Bd -literal
7713ec1e31SMitchell HorneCPU      msecs    delta process     event                PID CPUtime IBlks OBlks
7813ec1e31SMitchell Horne  0   63918567        0 kernel      sysinit 0x2100001      0    0.00     0     0
7913ec1e31SMitchell Horne[...]
8013ec1e31SMitchell Horne  0   64076940   120605 boottrace   dumpon start        1602    0.00     0     0
8113ec1e31SMitchell Horne  0   64076942        2 boottrace   dumpon done         1602    0.00     0     0
8213ec1e31SMitchell Horne.Ed
8313ec1e31SMitchell Horne.Sh SEE ALSO
8413ec1e31SMitchell Horne.Xr boottrace 4 ,
8513ec1e31SMitchell Horne.Xr rc.subr 8
86