usr.sbin/kernbb/kernbb.8

   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 .\" 4. 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$
  29 .\"
  30 .Dd May 22, 1995
  31 .Dt KERNBB 8
  32 .Os
  33 .Sh NAME
  34 .Nm kernbb
  35 .Nd generate a dump of the kernels basic-block profile buffers
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility is used to extract the basic-block profiling buffers of the running
  42 kernel into the files needed for the
  43 .Xr gcov 1
  44 tool.
  45 .Pp
  46 At least one source file in the running kernel must have been compiled
  47 with the
  48 .Fl Fl test-coverage
  49 and
  50 .Fl Fl profile-arcs
  51 options.
  52 .Pp
  53 The output is stored in the filenames compiled into the kernel by
  54 .Xr gcc 1 .
  55 If the absolute pathname cannot be written to, the directory part
  56 of the filename is discarded and the file stored in the current
  57 directory under its basename.
  58 .Pp
  59 The output files are named
  60 .Pa *.da ,
  61 and the
  62 .Xr gcov 1
  63 program will extract the counts and merge them with the source
  64 file to show actual execution counts.
  65 .Sh FILES
  66 .Bl -tag -width /boot/kernel/kernel -compact
  67 .It Pa /boot/kernel/kernel
  68 the default system
  69 .It Pa /dev/kmem
  70 the default memory
  71 .El
  72 .Sh SEE ALSO
  73 .Xr cc 1 ,
  74 .Xr gcov 1
  75 .Sh AUTHORS
  76 The
  77 .Nm
  78 utility was written by
  79 .An Poul-Henning Kamp ,
  80 along with the kernel-support.
  81 .Sh BUGS
  82 There are far too much magic and internal knowledge from GCC in this.