kernel: Fix a -Wundef warning.
[dragonfly.git] / usr.sbin / kernbb / kernbb.8
blob7276ae7fa0d02afdc47cddfe198f8a27a034df8d
1 .\" Copyright (c) 1983, 1991, 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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/usr.sbin/kernbb/kernbb.8,v 1.9.2.5 2001/08/16 15:56:01 ru Exp $
29 .\" $DragonFly: src/usr.sbin/kernbb/kernbb.8,v 1.3 2008/09/02 11:50:46 matthias Exp $
30 .\"
31 .Dd September 2, 2008
32 .Dt KERNBB 8
33 .Os
34 .Sh NAME
35 .Nm kernbb
36 .Nd generate a dump of the kernels basic-block profile buffers
37 .Sh SYNOPSIS
38 .Nm
39 .Sh DESCRIPTION
40 .Nm Kernbb
41 is a tool used to dump the basic-block profiling buffers of the running
42 kernel.
43 .Pp
44 At least one source file in the running kernel must have been compiled
45 with the
46 .Fl a
47 option.
48 .Pp
49 The output format is
50 .Tn ASCII ,
51 consisting of one line per record with the
52 following fields: filename, linenumber, procedure, address, count
53 of executions, length of the basic-block in bytes and the product of
54 the previous two fields.
55 .Sh FILES
56 .Bl -tag -width /dev/kmemx -compact
57 .It Pa /boot/kernel
58 the default system
59 .It Pa /dev/kmem
60 the default memory
61 .El
62 .Sh SEE ALSO
63 .Xr cc 1
64 .Sh AUTHORS
65 The
66 .Nm
67 command was written by
68 .An Poul-Henning Kamp ,
69 along with the kernel-support.