2 * Copyright (c) 2003,2004 Joseph Koshy
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/types.h>
32 #include <sys/queue.h>
33 #include <sys/sysctl.h>
48 /* Compile time defaults */
50 #define PMCC_PRINT_USAGE 0
51 #define PMCC_PRINT_EVENTS 1
52 #define PMCC_LIST_STATE 2
53 #define PMCC_ENABLE_DISABLE 3
54 #define PMCC_SHOW_STATISTICS 4
56 #define PMCC_CPU_ALL -1
57 #define PMCC_CPU_WILDCARD '*'
59 #define PMCC_PMC_ALL -1
60 #define PMCC_PMC_WILDCARD '*'
62 #define PMCC_OP_IGNORE 0
63 #define PMCC_OP_DISABLE 1
64 #define PMCC_OP_ENABLE 2
66 #define PMCC_PROGRAM_NAME "pmccontrol"
68 STAILQ_HEAD(pmcc_op_list, pmcc_op) head = STAILQ_HEAD_INITIALIZER(head);
74 STAILQ_ENTRY(pmcc_op) op_next;
77 /* Function Prototypes */
79 static void pmcc_init_debug(void);
82 static int pmcc_do_list_state(void);
83 static int pmcc_do_enable_disable(struct pmcc_op_list *);
84 static int pmcc_do_list_events(void);
88 static char usage_message[] =
90 " " PMCC_PROGRAM_NAME " -L\n"
91 " " PMCC_PROGRAM_NAME " -l\n"
92 " " PMCC_PROGRAM_NAME " -s\n"
93 " " PMCC_PROGRAM_NAME " [-e pmc | -d pmc | -c cpu] ...";
96 FILE *debug_stream = NULL;
100 #define DEBUG_MSG(...) \
101 (void) fprintf(debug_stream, "[pmccontrol] " __VA_ARGS__);
103 #define DEBUG_MSG(m) /* */
106 int pmc_syscall = -1;
108 #define PMC_CALL(cmd, params) \
109 if ((error = syscall(pmc_syscall, PMC_OP_##cmd, (params))) != 0) \
111 DEBUG_MSG("ERROR: syscall [" #cmd "]"); \
116 /* log debug messages to a separate file */
118 pmcc_init_debug(void)
122 fn = getenv("PMCCONTROL_DEBUG");
125 debug_stream = fopen(fn, "w");
126 if (debug_stream == NULL)
127 debug_stream = stderr;
129 debug_stream = stderr;
134 pmcc_do_enable_disable(struct pmcc_op_list *op_list)
136 int c, error, i, j, ncpu, npmc, t;
137 cpumask_t haltedcpus, cpumask;
144 if ((ncpu = pmc_ncpu()) < 0)
145 err(EX_OSERR, "Unable to determine the number of cpus");
147 /* Determine the set of active CPUs. */
148 cpumask = (1 << ncpu) - 1;
150 haltedcpus = (cpumask_t) 0;
151 if (ncpu > 1 && sysctlbyname("machdep.hlt_cpus", &haltedcpus,
152 &dummy, NULL, 0) < 0)
153 err(EX_OSERR, "ERROR: Cannot determine which CPUs are "
155 cpumask &= ~haltedcpus;
157 /* Determine the maximum number of PMCs in any CPU. */
159 for (c = 0; c < ncpu; c++) {
160 if ((t = pmc_npmc(c)) < 0)
161 err(EX_OSERR, "Unable to determine the number of "
162 "PMCs in CPU %d", c);
163 npmc = t > npmc ? t : npmc;
167 errx(EX_CONFIG, "No PMCs found");
169 if ((map = malloc(npmc * ncpu)) == NULL)
170 err(EX_SOFTWARE, "Out of memory");
172 (void) memset(map, PMCC_OP_IGNORE, npmc*ncpu);
175 STAILQ_FOREACH(np, op_list, op_next) {
182 errx(EX_DATAERR, "CPU id too large: \"%d\"", cpu);
185 errx(EX_DATAERR, "PMC id too large: \"%d\"", pmc);
187 #define MARKMAP(M,C,P,V) do { \
188 *((M) + (C)*npmc + (P)) = (V); \
191 #define SET_PMCS(C,P,V) do { \
192 if ((P) == PMCC_PMC_ALL) { \
193 for (j = 0; j < npmc; j++) \
194 MARKMAP(map, (C), j, (V)); \
196 MARKMAP(map, (C), (P), (V)); \
199 #define MAP(M,C,P) (*((M) + (C)*npmc + (P)))
201 if (cpu == PMCC_CPU_ALL)
202 for (i = 0; i < ncpu; i++) {
203 if ((1 << i) & cpumask)
204 SET_PMCS(i, pmc, op);
207 SET_PMCS(cpu, pmc, op);
211 for (i = 0; i < ncpu; i++)
212 for (j = 0; j < npmc; j++) {
219 if (b == PMCC_OP_ENABLE)
220 error = pmc_enable(i, j);
221 else if (b == PMCC_OP_DISABLE)
222 error = pmc_disable(i, j);
225 err(EX_OSERR, "%s of PMC %d on CPU %d failed",
226 b == PMCC_OP_ENABLE ? "Enable" :
234 pmcc_do_list_state(void)
237 int c, cpu, n, npmc, ncpu;
238 unsigned int logical_cpus_mask;
240 struct pmc_pmcinfo *pi;
241 const struct pmc_cpuinfo *pc;
243 if (pmc_cpuinfo(&pc) != 0)
244 err(EX_OSERR, "Unable to determine CPU information");
246 dummy = sizeof(logical_cpus_mask);
247 if (sysctlbyname("machdep.logical_cpus_mask", &logical_cpus_mask,
248 &dummy, NULL, 0) < 0)
249 logical_cpus_mask = 0;
253 for (c = cpu = 0; cpu < ncpu; cpu++) {
254 #if defined(__i386__) || defined(__amd64__)
255 if (pc->pm_cputype == PMC_CPU_INTEL_PIV &&
256 (logical_cpus_mask & (1 << cpu)))
257 continue; /* skip P4-style 'logical' cpus */
259 if (pmc_pmcinfo(cpu, &pi) < 0) {
262 err(EX_OSERR, "Unable to get PMC status for CPU %d",
266 printf("#CPU %d:\n", c++);
267 npmc = pmc_npmc(cpu);
268 printf("#N NAME CLASS STATE ROW-DISP\n");
270 for (n = 0; n < npmc; n++) {
271 pd = &pi->pm_pmcs[n];
273 printf(" %-2d %-16s %-6s %-8s %-10s",
276 pmc_name_of_class(pd->pm_class),
277 pd->pm_enabled ? "ENABLED" : "DISABLED",
278 pmc_name_of_disposition(pd->pm_rowdisp));
280 if (pd->pm_ownerpid != -1) {
281 printf(" (pid %d)", pd->pm_ownerpid);
283 pmc_name_of_event(pd->pm_event));
284 if (PMC_IS_SAMPLING_MODE(pd->pm_mode))
285 printf(" (reload count %jd)",
296 pmcc_do_list_events(void)
299 unsigned int i, j, nevents;
300 const char **eventnamelist;
301 const struct pmc_cpuinfo *ci;
303 if (pmc_cpuinfo(&ci) != 0)
304 err(EX_OSERR, "Unable to determine CPU information");
306 eventnamelist = NULL;
308 for (i = 0; i < ci->pm_nclass; i++) {
309 c = ci->pm_classes[i].pm_class;
311 printf("%s\n", pmc_name_of_class(c));
312 if (pmc_event_names_of_class(c, &eventnamelist, &nevents) < 0)
313 err(EX_OSERR, "ERROR: Cannot find information for "
314 "event class \"%s\"", pmc_name_of_class(c));
316 for (j = 0; j < nevents; j++)
317 printf("\t%s\n", eventnamelist[j]);
325 pmcc_show_statistics(void)
328 struct pmc_driverstats gms;
330 if (pmc_get_driver_stats(&gms) < 0)
331 err(EX_OSERR, "ERROR: cannot retrieve driver statistics");
337 #define PRINT(N,V) (void) printf("%-40s %d\n", (N), gms.pm_##V)
338 PRINT("interrupts processed:", intr_processed);
339 PRINT("non-PMC interrupts:", intr_ignored);
340 PRINT("sampling stalls due to space shortages:", intr_bufferfull);
341 PRINT("system calls:", syscalls);
342 PRINT("system calls with errors:", syscall_errors);
343 PRINT("buffer requests:", buffer_requests);
344 PRINT("buffer requests failed:", buffer_requests_failed);
345 PRINT("sampling log sweeps:", log_sweeps);
355 main(int argc, char **argv)
357 int error, command, currentcpu, option, pmc;
367 currentcpu = PMCC_CPU_ALL;
368 command = PMCC_PRINT_USAGE;
373 while ((option = getopt(argc, argv, ":c:d:e:lLs")) != -1)
376 if (command != PMCC_PRINT_USAGE) {
380 command = PMCC_PRINT_EVENTS;
384 if (command != PMCC_PRINT_USAGE &&
385 command != PMCC_ENABLE_DISABLE) {
389 command = PMCC_ENABLE_DISABLE;
391 if (*optarg == PMCC_CPU_WILDCARD)
392 currentcpu = PMCC_CPU_ALL;
394 currentcpu = strtoul(optarg, &dummy, 0);
395 if (*dummy != '\0' || currentcpu < 0)
397 "\"%s\" is not a valid CPU id",
404 if (command != PMCC_PRINT_USAGE &&
405 command != PMCC_ENABLE_DISABLE) {
409 command = PMCC_ENABLE_DISABLE;
411 if (*optarg == PMCC_PMC_WILDCARD)
414 pmc = strtoul(optarg, &dummy, 0);
415 if (*dummy != '\0' || pmc < 0)
417 "\"%s\" is not a valid PMC id",
421 if ((p = malloc(sizeof(*p))) == NULL)
422 err(EX_SOFTWARE, "Out of memory");
424 p->op_cpu = currentcpu;
426 p->op_op = option == 'd' ? PMCC_OP_DISABLE :
429 STAILQ_INSERT_TAIL(&head, p, op_next);
433 if (command != PMCC_PRINT_USAGE) {
437 command = PMCC_LIST_STATE;
441 if (command != PMCC_PRINT_USAGE) {
445 command = PMCC_SHOW_STATISTICS;
450 "Missing argument to option '-%c'", optopt);
454 warnx("Unrecognized option \"-%c\"", optopt);
455 errx(EX_USAGE, usage_message);
464 if (command == PMCC_PRINT_USAGE)
465 (void) errx(EX_USAGE, usage_message);
472 "Initialization of the pmc(3) library failed");
475 case PMCC_LIST_STATE:
476 error = pmcc_do_list_state();
478 case PMCC_PRINT_EVENTS:
479 error = pmcc_do_list_events();
481 case PMCC_SHOW_STATISTICS:
482 error = pmcc_show_statistics();
484 case PMCC_ENABLE_DISABLE:
485 if (STAILQ_EMPTY(&head))
486 errx(EX_USAGE, "No PMCs specified to enable or disable");
487 error = pmcc_do_enable_disable(&head);
495 err(EX_OSERR, "Command failed");