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 .\" ==========
  66 .It Fl b
  67 Resume the collection of profile data.
  68 .\" ==========
  69 .It Fl h
  70 Stop the collection of profile data.
  71 .\" ==========
  72 .It Fl M
  73 Extract values associated with the name list from the specified core
  74 instead of the default ``/dev/kmem''.
  75 .\" ==========
  76 .It Fl N
  77 Extract the name list from the specified system instead of the
  78 default ``/vmunix''.
  79 .\" ==========
  80 .It Fl p
  81 Dump the contents of the profile buffers into a
  82 .Pa gmon.out
  83 file.
  84 .\" ==========
  85 .It Fl r
  86 Reset all the profile buffers.
  87 If the
  88 .Fl p
  89 flag is also specified, the
  90 .Pa gmon.out
  91 file is generated before the buffers are reset.
  92 .El
  93 .Pp
  94 If neither
  95 .Fl b
  96 nor
  97 .Fl h
  98 is specified, the state of profiling collection remains unchanged.
  99 For example, if the
 100 .Fl p
 101 flag is specified and profile data is being collected,
 102 profiling will be momentarily suspended,
 103 the operating system profile buffers will be dumped,
 104 and profiling will be immediately resumed.
 105 .Sh FILES
 106 .Bl -tag -width /dev/kmemx -compact
 107 .It Pa /vmunix
 108 the default system
 109 .It Pa /dev/kmem
 110 the default memory
 111 .El
 112 .Sh SEE ALSO
 113 .Xr gprof 1 ,
 114 .Xr config 8
 115 .Sh DIAGNOSTICS
 116 Users with only read permission on
 117 .Pa /dev/kmem
 118 cannot change the state
 119 of profiling collection.
 120 If profiling is in progress,
 121 they can get a
 122 .Pa gmon.out
 123 file containing a warning that the data may be inconsistent.
 124 .Sh HISTORY
 125 The
 126 .Nm kgmon
 127 command appeared in
 128 .Bx 4.2 .