Merge branch 'master' of ssh://crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / usr.bin / pctrack / pctrack.8
blob37dcfb639ee6c0530967679fd524f28f8b3fdbc2
1 .\"
2 .\" Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to The DragonFly Project
5 .\" by Matthew Dillon <dillon@backplane.com>
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in
15 .\"    the documentation and/or other materials provided with the
16 .\"    distribution.
17 .\" 3. Neither the name of The DragonFly Project nor the names of its
18 .\"    contributors may be used to endorse or promote products derived
19 .\"    from this software without specific, prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\" $DragonFly: src/usr.bin/pctrack/pctrack.8,v 1.4 2006/07/22 18:49:25 swildner Exp $
35 .\"
36 .Dd June 8, 2006
37 .Dt PCTRACK 8
38 .Os
39 .Sh NAME
40 .Nm pctrack
41 .Nd print kernel system/interrupt PC sampling history
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl fnsi
45 .Op Fl c Ar cpu
46 .Op Fl N Ar execfile
47 .Op Fl M Ar corefile
48 .Op Ar interval
49 .Sh DESCRIPTION
50 Kernels compiled with
51 .Dv DEBUG_PCTRACK
52 record the program counter (PC) of
53 the code interrupted by the statistics clock interrupt.
54 This information can be dumped with the
55 .Nm
56 utility
57 .Pp
58 The following options are available:
59 .Bl -tag -width ".Fl N Ar execfile"
60 .It Fl c Ar cpu
61 Specify which CPU to dump.  If not specified, all CPUs will be dumped.
62 .It Fl f
63 If a single CPU and either
64 .Fl i
66 .Fl s
67 is specified, this option will use the repeat interval to detect changes
68 and dump them as they occur.
69 .It Fl i
70 Dump the interrupt tracking buffer.
71 .It Fl s
72 Dump the kernel tracking buffer.
73 If neither
74 .Fl i
76 .Fl s
77 is specified, both tracking buffers will be dumped.
78 .It Fl n
79 .Nm
80 normally tries to translate the PC into symbols.  This option forces hex
81 values to be displayed instead.
82 .It Fl N Ar execfile
83 The kernel image to resolve symbols from.
84 The default is the value returned via
85 .Xr getbootfile 3 .
86 .It Fl M Ar corefile
87 The core file or memory image to read from.
88 The default is
89 .Pa /dev/mem .
90 .El
91 .\".Sh OPERATIONAL NOTES
92 .Sh HISTORY
93 The
94 .Nm
95 utility first appeared in
96 .Dx 1.5 .
97 .Sh AUTHORS
98 .An -nosplit
99 The
101 utility was originally implemented by
102 .An Matthew Dillon
104 .Dx .