kgmon.tproj/kgmon.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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)kgmon.8     8.1 (Berkeley) 6/6/93
  33 .\"
  34 .Dd June 6, 1993
  35 .Dt KGMON 8
  36 .Os BSD 4.2
  37 .Sh NAME
  38 .Nm kgmon
  39 .Nd generate a dump of the operating system's profile buffers
  40 .Sh SYNOPSIS
  41 .Nm kgmon
  42 .Op Fl bhpr
  43 .Op Fl M core
  44 .Op Fl N system
  45 .Sh DESCRIPTION
  46 .Nm Kgmon
  47 is a tool used when profiling the operating system.
  48 When no arguments are supplied,
  49 .Nm kgmon
  50 indicates the state of operating system profiling as running,
  51 off, or not configured.
  52 (see
  53 .Xr config 8 )
  54 If the
  55 .Fl p
  56 flag is specified,
  57 .Nm kgmon
  58 extracts profile data from the operating system and produces a
  59 .Pa gmon.out
  60 file suitable for later analysis by
  61 .Xr gprof 1 .
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width Ds
  65 .It Fl b
  66 Resume the collection of profile data.
  67 .It Fl h
  68 Stop the collection of profile data.
  69 .It Fl p
  70 Dump the contents of the profile buffers into a
  71 .Pa gmon.out
  72 file.
  73 .It Fl r
  74 Reset all the profile buffers.
  75 If the
  76 .Fl p
  77 flag is also specified, the
  78 .Pa gmon.out
  79 file is generated before the buffers are reset.
  80 .It Fl M
  81 Extract values associated with the name list from the specified core
  82 instead of the default ``/dev/kmem''.
  83 .It Fl N
  84 Extract the name list from the specified system instead of the
  85 default ``/vmunix''.
  86 .El
  87 .Pp
  88 If neither
  89 .Fl b
  90 nor
  91 .Fl h
  92 is specified, the state of profiling collection remains unchanged.
  93 For example, if the
  94 .Fl p
  95 flag is specified and profile data is being collected,
  96 profiling will be momentarily suspended,
  97 the operating system profile buffers will be dumped,
  98 and profiling will be immediately resumed.
  99 .Sh FILES
 100 .Bl -tag -width /dev/kmemx -compact
 101 .It Pa /vmunix
 102 the default system
 103 .It Pa /dev/kmem
 104 the default memory
 105 .El
 106 .Sh SEE ALSO
 107 .Xr gprof 1 ,
 108 .Xr config 8
 109 .Sh DIAGNOSTICS
 110 Users with only read permission on
 111 .Pa /dev/kmem
 112 cannot change the state
 113 of profiling collection.
 114 They can get a
 115 .Pa gmon.out
 116 file with the warning that the data may be
 117 inconsistent if profiling is in progress.
 118 .Sh HISTORY
 119 The
 120 .Nm
 121 command appeared in
 122 .Bx 4.2 .