usr.bin/pmc/pmc.1

   1 .\"     $NetBSD: pmc.1,v 1.6 2002/09/30 11:09:08 grant Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Zembu Labs, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Author: Jason R. Thorpe <thorpej@zembu.com>
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by Zembu Labs, Inc.
  19 .\" 4. Neither the name of Zembu Labs nor the names of its employees may
  20 .\"    be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS
  24 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR-
  25 .\" RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS-
  26 .\" CLAIMED.  IN NO EVENT SHALL ZEMBU LABS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  28 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  32 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .Dd October 24, 2000
  35 .Dt PMC 1
  36 .Os
  37 .Sh NAME
  38 .Nm pmc
  39 .Nd performance-monitoring counter interface for command execution
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Fl h
  43 .Nm
  44 .Fl C
  45 .Nm
  46 .Fl c
  47 .Ar event
  48 .Ar command
  49 .Oo
  50 .Ar options
  51 .Ar ...
  52 .Oc
  53 .Sh DESCRIPTION
  54 .Nm
  55 is a means of using a processor's performance-monitoring counter (PMC)
  56 facility to measure various aspects of a program's execution.
  57 It is
  58 meant to be used in a fashion similar to
  59 .Xr time 1 .
  60 .Pp
  61 The arguments are as follows:
  62 .Bl -tag -width indent
  63 .It Fl h
  64 Display a list of performance counter events available on
  65 the system.
  66 .It Fl C
  67 Cancel any performance counters that are currently running.
  68 .It Fl c Ar event
  69 Count the event specified by
  70 .Ar event
  71 while running the command.
  72 .El
  73 .Sh DIAGNOSTICS
  74 .Bl -diag
  75 .It PMC support is not compiled into the kernel
  76 Performance-monitoring counter support has not been compiled into the
  77 kernel.
  78 It may be included using the
  79 .Em PERFCTRS
  80 option.
  81 See
  82 .Xr options 4
  83 for details.
  84 .It PMC counters are not supported by CPU
  85 Performance-monitoring counters are not available for the CPU.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr time 1 ,
  89 .Xr options 4
  90 .Sh HISTORY
  91 The
  92 .Nm
  93 command first appeared in
  94 .Nx 1.6 .
  95 .Sh AUTHORS
  96 The
  97 .Nm
  98 command was written by
  99 .An Frank van der Linden Aq fvdl@wasabisystems.com .
 100 The kernel support for reading performance counters on the i386
 101 architecture was written by
 102 .An Jason R. Thorpe Aq thorpej@zembu.com .
 103 .Sh BUGS
 104 The
 105 .Nm
 106 command currently only supports performance-monitoring counters
 107 on the i386 architecture.