usr.sbin/pmcstudy/pmcstudy.1

   1 .\" Copyright (c) 2015
   2 .\"             Netflix Inc.
   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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd Dec 2, 2014
  28 .Dt PMC_COUNTER_STUDY 1
  29 .Os
  30 .Sh NAME
  31 .Nm pmc_counter_study
  32 .Nd Perform various study's on a systems overall PMC's.
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 The pmc_counter_study program is designed to run various tests against
  39 your systems performance. There are roughly 20-22 canned tests that
  40 setup specific PMC's and then run various formulas on the output information.
  41 These formulas can be found in Intel documentation "Using Intel Vtune
  42 amplifier xe on NNN Generation Intel Core Processors". The NNN is either
  43 2nd, 3rd or 4th generation i.e. Sandy Bridge, Ivy Bridge and Haswell.
  44 Currently the program only works on these three Intel processor types.
  45 You can see the complete list of formula's by running the program
  46 with the -H option. If you know a formula name you can run it by
  47 typing -e name. If you know a name and want what the formula is you
  48 can run the program with -e name -h and the program will not run but
  49 it will tell you what that name will do (if known). The -T option can
  50 be used to test all PMC's that are known to your system. When running a
  51 test you will want to specify -m N where N is the number of 1 second samples
  52 to collect and analize (it bounds the time the test runs). Finally for
  53 those that have there own ideas on what formulas that you want to run
  54 you can type your own formula in with -E "formula". The formula can
  55 declare directly the PMC's by name or you can use an abbreviation
  56 %NNN. To find out the abbreviations on your system you may run
  57 pmc_counter_study -L and it will tell you each PMC name and the
  58 abbreviation you can use. An example of a formula of your own might
  59 be -E "FP_ASSIST.ANY / INST_RETIRED.ANY_P" <or short hand on Haswell>
  60 -E " %176 / %150". You must have spaces between each entry and
  61 you may use paraenthisis to prioritize the operators. Add (+), Subtract (-1),
  62 Divide (/) and Multiplication (*) is supported. You may also introduce
  63 constant numbers as well. So for example you can do a standard efficency
  64 test like -E "UOPS_RETIRED.RETIRE_SLOTS / (4 * CPU_CLK_UNHALTED.THREAD_P)".
  65