freebsd-skq/usr.sbin/kernbb/kernbb.8

.\" Copyright (c) 1983, 1991, 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.
.\" 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.
.\"
.\" $FreeBSD$
.\"
.Dd May 22, 1995
.Dt KERNBB 8
.Os
.Sh NAME
.Nm kernbb
.Nd generate a dump of the kernels basic-block profile buffers
.Sh SYNOPSIS
.Nm
.Sh DESCRIPTION
The
.Nm
utility is used to extract the basic-block profiling buffers of the running
kernel into the files needed for the
.Xr gcov 1
tool.
.Pp
At least one source file in the running kernel must have been compiled
with the
.Fl Fl test-coverage
and
.Fl Fl profile-arcs
options.
.Pp
The output is stored in the filenames compiled into the kernel by
.Xr gcc 1 .
If the absolute pathname cannot be written to, the directory part
of the filename is discarded and the file stored in the current
directory under its basename.
.Pp
The output files are named
.Pa *.da ,
and the
.Xr gcov 1
program will extract the counts and merge them with the source
file to show actual execution counts.
.Sh FILES
.Bl -tag -width /boot/kernel/kernel -compact
.It Pa /boot/kernel/kernel
the default system
.It Pa /dev/kmem
the default memory
.El
.Sh SEE ALSO
.Xr cc 1 ,
.Xr gcov 1
.Sh AUTHORS
The
.Nm
utility was written by
.An Poul-Henning Kamp ,
along with the kernel-support.
.Sh BUGS
There are far too much magic and internal knowledge from GCC in this.
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.\" Copyright (c) 1983, 1991, 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.`
			`.\" 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.\"`
			`.Dd May 22, 1995`
			`.Dt KERNBB 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:12:08 +00:00			`.Os`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.Sh NAME`
			`.Nm kernbb`
			`.Nd generate a dump of the kernels basic-block profile buffers`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.Sh DESCRIPTION`
The .Nm utility 2002-07-14 14:47:15 +00:00			`The`
			`.Nm`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`utility is used to extract the basic-block profiling buffers of the running`
			`kernel into the files needed for the`
			`.Xr gcov 1`
			`tool.`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.Pp`
			`At least one source file in the running kernel must have been compiled`
			`with the`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Fl Fl test-coverage`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`and`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Fl Fl profile-arcs`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`options.`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.Pp`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`The output is stored in the filenames compiled into the kernel by`
			`.Xr gcc 1 .`
			`If the absolute pathname cannot be written to, the directory part`
			`of the filename is discarded and the file stored in the current`
			`directory under its basename.`
			`.Pp`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`The output files are named`
			`.Pa *.da ,`
			`and the`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`.Xr gcov 1`
			`program will extract the counts and merge them with the source`
			`file to show actual execution counts.`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.Sh FILES`
Replace /kernel with /boot/kernel/kernel. PR: docs/37757 Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-09 11:47:42 +00:00			`.Bl -tag -width /boot/kernel/kernel -compact`
			`.It Pa /boot/kernel/kernel`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`the default system`
			`.It Pa /dev/kmem`
			`the default memory`
			`.El`
			`.Sh SEE ALSO`
mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00			`.Xr cc 1 ,`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`.Xr gcov 1`
Had a moment, wrote a manpage based on kprof's page. 1995-04-28 04:51:08 +00:00			`.Sh AUTHORS`
			`The`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.Nm`
The .Nm utility 2002-07-14 14:47:15 +00:00			`utility was written by`
Use err(3). Put includes in alphabetical order. Use .An macro. 1997-09-22 06:30:04 +00:00			`.An Poul-Henning Kamp ,`
			`along with the kernel-support.`
Update kernbb(8) to deal with GCC's new way of doing things. 2003-01-06 07:46:26 +00:00			`.Sh BUGS`
			`There are far too much magic and internal knowledge from GCC in this.`