svn commit: r280697 - head/usr.sbin/pmcstudy

Randall Stewart rrs at FreeBSD.org
Thu Mar 26 15:40:50 UTC 2015 

Author: rrs
Date: Thu Mar 26 15:40:47 2015
New Revision: 280697
URL: https://svnweb.freebsd.org/changeset/base/280697

Log:
  Update the manual page to be a bit more sane. It still
  may need some work, but at least now it will read properly.
  (gnn you are still on the hook to help out with this
  like you committed).
  
  Sponsored by:	Netflix.

Added:
  head/usr.sbin/pmcstudy/pmcstudy.8   (contents, props changed)
Deleted:
  head/usr.sbin/pmcstudy/pmcstudy.1
Modified:
  head/usr.sbin/pmcstudy/Makefile
  head/usr.sbin/pmcstudy/pmcstudy.c

Modified: head/usr.sbin/pmcstudy/Makefile
==============================================================================
--- head/usr.sbin/pmcstudy/Makefile	Thu Mar 26 15:27:38 2015	(r280696)
+++ head/usr.sbin/pmcstudy/Makefile	Thu Mar 26 15:40:47 2015	(r280697)
@@ -2,6 +2,7 @@
 # $FreeBSD$
 
 PROG=	pmcstudy
+MAN=	pmcstudy.8
 SRCS= pmcstudy.c eval_expr.c
 CFLAGS+= -Wall -Werror
 

Added: head/usr.sbin/pmcstudy/pmcstudy.8
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/usr.sbin/pmcstudy/pmcstudy.8	Thu Mar 26 15:40:47 2015	(r280697)
@@ -0,0 +1,131 @@
+.\" Copyright (c) 2015
+.\"		Netflix Inc.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd Mar 26, 2015
+.Dt PMCSTUDY 1
+.Os
+.Sh NAME
+.Nm pmcstudy
+.Nd Perform various study's on a systems overall PMC's.
+.Sh SYNOPSIS
+.Nm
+.Oo Fl i Ar inputfile | Fl T | Fl v | Fl m Ar max | Fl e exp | Fl Ar E | Fl h | fl H Oc
+.Nm 
+.Fl i Ar inputfile 
+.Nm
+.Fl v 
+.Nm
+.Fl m Ar max
+.Nm
+.Fl e Ar exp-name
+.Nm
+.Fl E Ar your-expr
+.Nm
+.Fl h
+.Nm
+.Fl H
+.Nm
+.Fl T
+.Sh DESCRIPTION
+The
+.Nm
+program is designed to run various tests against your systems
+performance. There are roughly 20-22 canned tests that setup specific
+PMC's and then run various formulas on the output information.
+These formulas can be found in Intel documentation "Using Intel Vtune
+amplifier xe on NNN Generation Intel Core Processors". The NNN is either
+2nd, 3rd or 4th generation i.e. Sandy Bridge, Ivy Bridge and Haswell. 
+Currently the program only works on these three Intel processor types.
+.Sh OPTIONS
+The following options are available:
+.Bl -tag -width indent
+.It Fl i Ar filename
+If this option is supplied, instead of running a
+.Xr pmcstat 8 
+command to collecte the current running information the filename will be read
+in as input instead.
+.It Fl H
+This option will display the complete list of canned formulas that can be run including
+there names which can be input to the
+.Fl e
+option.
+.It Fl e Ar name
+Execute the canned test
+.Ar name
+on the running kernel.
+.It Fl h
+If you add this option to the
+.Fl e
+option the test will not execute but instead give you a small description
+of the test that would run.
+.It Fl T
+This option will execute a test of every PMC to validate that they are working
+on your system. If a PMC does not show up in this test chances
+are the kernel hwpmc driver needs updating with new PMC information.
+.It Fl m Ar num
+This option can restrict the number of one second samples that will
+be collected by your system when running a test (it bounds the
+time the test will run). Without this option the test will run
+for 1024 seconds or until the user types ctrl-c.
+.It Fl v
+The verbose option adds debugging output to the command.
+.It Fl E Ar expression
+This option can be used by those that have there own ideas
+on what formulas that you want to run. The expression given to
+the
+.Fl E
+option is a "formula". The formula can declare directly the PMC's by name
+or you can use an abbreviation %NNN. To find out the abbreviations
+on your system you may run the
+.Fl L
+option.
+An example of a formula of your own might be
+.Fl E
+"FP_ASSIST.ANY / INST_RETIRED.ANY_P" or using the abbreviations on a
+Haswell machine you would type
+.Fl E
+" %176 / %150". You must have spaces between each entry and
+you may use paraenthisis to prioritize the operators. Add (+), Subtract (-),
+Divide (/) and Multiplication (*) are supported. You may also introduce
+constant numbers as well. So for example you can do a standard efficency
+test like
+.FL E
+"UOPS_RETIRED.RETIRE_SLOTS / (4 * CPU_CLK_UNHALTED.THREAD_P)".
+
+.It Fl L
+This option will list all known PMC's and there abbreviation (%NNN).
+.Sh SEE ALSO
+.Xr pmc 3 ,
+.Xr pmclog 3 ,
+.Xr hwpmc 4 ,
+.Xr pmcstat 8 ,
+.Sh HISTORY
+The
+.Nm
+utility first appeared in
+.Fx 11.0.
+.Sh AUTHORS
+.An Randall Stewart Aq Mt rrs at FreeBSD.org

Modified: head/usr.sbin/pmcstudy/pmcstudy.c
==============================================================================
--- head/usr.sbin/pmcstudy/pmcstudy.c	Thu Mar 26 15:27:38 2015	(r280696)
+++ head/usr.sbin/pmcstudy/pmcstudy.c	Thu Mar 26 15:40:47 2015	(r280697)
@@ -2139,7 +2139,11 @@ test_for_a_pmc(const char *pmc, int out_
 					printf(" ");
 				}
 			}
-			printf("%s", &line[j]);
+			if (len) {
+				printf("%s", &line[j]);
+			} else {
+				printf("\n");
+			}
 			goto out;
 		}
 	}

More information about the svn-src-head mailing list