xref: /freebsd/usr.sbin/pmccontrol/pmccontrol.8 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1.\" Copyright (c) 2003 Joseph Koshy.  All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" This software is provided by Joseph Koshy ``as is'' and
13.\" any express or implied warranties, including, but not limited to, the
14.\" implied warranties of merchantability and fitness for a particular purpose
15.\" are disclaimed.  in no event shall Joseph Koshy be liable
16.\" for any direct, indirect, incidental, special, exemplary, or consequential
17.\" damages (including, but not limited to, procurement of substitute goods
18.\" or services; loss of use, data, or profits; or business interruption)
19.\" however caused and on any theory of liability, whether in contract, strict
20.\" liability, or tort (including negligence or otherwise) arising in any way
21.\" out of the use of this software, even if advised of the possibility of
22.\" such damage.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd December 15, 2003
27.Os
28.Dt PMCCONTROL 8
29.Sh NAME
30.Nm pmccontrol
31.Nd "control hardware performance monitoring counters"
32.Sh SYNOPSIS
33.Nm
34.Oo Fl c Ar cpu | Fl d Ar pmc | Fl e Ar pmc Oc ...
35.Nm
36.Fl l
37.Nm
38.Fl L
39.Nm
40.Fl s
41.Sh DESCRIPTION
42The
43.Nm
44utility controls the operation of the system's hardware performance
45monitoring counters.
46.Sh OPTIONS
47The
48.Nm
49utility processes options in command line order, so later options modify
50the effect of earlier ones.
51The following options are available:
52.Bl -tag -width indent
53.It Fl c Ar cpu
54Subsequent enable and disable options affect the CPU
55denoted by
56.Ar cpu .
57The argument
58.Ar cpu
59is either a number denoting a CPU number in the system, or the string
60.Dq Li * ,
61denoting all CPUs in the system.
62.It Fl d Ar pmc
63Disable PMC number
64.Ar pmc
65on the CPU specified by
66.Fl c ,
67preventing it from being used till subsequently re-enabled.
68The argument
69.Ar pmc
70is either a number denoting a specified PMC, or the string
71.Dq Li *
72denoting all the PMCs on the specified CPU.
73.Pp
74Only idle PMCs may be disabled.
75.\" XXX this probably needs to be fixed.
76.It Fl e Ar pmc
77Enable PMC number
78.Ar pmc ,
79on the CPU specified by
80.Fl c ,
81allowing it to be used in the future.
82The argument
83.Ar pmc
84is either a number denoting a specified PMC, or the string
85.Dq Li *
86denoting all the PMCs on the specified CPU.
87If PMC
88.Ar pmc
89is already enabled, this option has no effect.
90.It Fl l
91List available hardware performance counters and their current
92disposition.
93.It Fl L
94List available hardware performance counter classes and their
95supported event names.
96.It Fl s
97Print driver statistics maintained by
98.Xr hwpmc 4 .
99.El
100.Sh EXAMPLES
101To disable all PMCs on all CPUs, use the command:
102.Dl "pmccontrol -d*"
103.Pp
104To enable all PMCs on all CPUs, use:
105.Dl "pmccontrol -e*"
106.Pp
107To disable PMCs 0 and 1 on CPU 2, use:
108.Dl "pmccontrol -c2 -d0 -d1"
109.Pp
110To disable PMC 0 of CPU 0 only, and enable all other PMCS on all other
111CPUs, use:
112.Dl "pmccontrol -c* -e* -c0 -d0"
113.Sh DIAGNOSTICS
114.Ex -std
115.Sh SEE ALSO
116.Xr pmc 3 ,
117.Xr pmclog 3 ,
118.Xr hwpmc 4 ,
119.Xr pmcstat 8 ,
120.Xr sysctl 8
121.Sh HISTORY
122The
123.Nm
124utility first appeared in
125.Fx 6.0 .
126.Sh AUTHORS
127.An Joseph Koshy Aq jkoshy@FreeBSD.org
128