1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2003,2004 Joseph Koshy
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32
33 #include <sys/param.h>
34 #include <sys/queue.h>
35 #include <sys/cpuset.h>
36 #include <sys/sysctl.h>
37
38 #include <assert.h>
39 #include <err.h>
40 #include <errno.h>
41 #include <fcntl.h>
42 #include <limits.h>
43 #include <pmc.h>
44 #include <stdarg.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <sysexits.h>
49 #include <unistd.h>
50
51 /* Compile time defaults */
52
53 #define PMCC_PRINT_USAGE 0
54 #define PMCC_PRINT_EVENTS 1
55 #define PMCC_LIST_STATE 2
56 #define PMCC_ENABLE_DISABLE 3
57 #define PMCC_SHOW_STATISTICS 4
58
59 #define PMCC_CPU_ALL -1
60 #define PMCC_CPU_WILDCARD '*'
61
62 #define PMCC_PMC_ALL -1
63 #define PMCC_PMC_WILDCARD '*'
64
65 #define PMCC_OP_IGNORE 0
66 #define PMCC_OP_DISABLE 1
67 #define PMCC_OP_ENABLE 2
68
69 #define PMCC_PROGRAM_NAME "pmccontrol"
70
71 static STAILQ_HEAD(pmcc_op_list, pmcc_op) head = STAILQ_HEAD_INITIALIZER(head);
72
73 struct pmcc_op {
74 char op_cpu;
75 char op_pmc;
76 char op_op;
77 STAILQ_ENTRY(pmcc_op) op_next;
78 };
79
80 /* Function Prototypes */
81 #if DEBUG
82 static void pmcc_init_debug(void);
83 #endif
84
85 static int pmcc_do_list_state(void);
86 static int pmcc_do_enable_disable(struct pmcc_op_list *);
87 static int pmcc_do_list_events(void);
88
89 /* Globals */
90
91 static char usage_message[] =
92 "Usage:\n"
93 " " PMCC_PROGRAM_NAME " -L\n"
94 " " PMCC_PROGRAM_NAME " -l\n"
95 " " PMCC_PROGRAM_NAME " -s\n"
96 " " PMCC_PROGRAM_NAME " [-e pmc | -d pmc | -c cpu] ...";
97
98 #if DEBUG
99 static FILE *debug_stream = NULL;
100 #endif
101
102 #if DEBUG
103 #define DEBUG_MSG(...) \
104 (void) fprintf(debug_stream, "[pmccontrol] " __VA_ARGS__);
105 #else
106 #define DEBUG_MSG(m) /* */
107 #endif /* !DEBUG */
108
109 #if DEBUG
110 /* log debug messages to a separate file */
111 static void
pmcc_init_debug(void)112 pmcc_init_debug(void)
113 {
114 char *fn;
115
116 fn = getenv("PMCCONTROL_DEBUG");
117 if (fn != NULL)
118 {
119 debug_stream = fopen(fn, "w");
120 if (debug_stream == NULL)
121 debug_stream = stderr;
122 } else
123 debug_stream = stderr;
124 }
125 #endif
126
127 static int
pmcc_do_enable_disable(struct pmcc_op_list * op_list)128 pmcc_do_enable_disable(struct pmcc_op_list *op_list)
129 {
130 int c, error, i, j, ncpu, npmc, t;
131 struct pmcc_op *np;
132 unsigned char *map;
133 unsigned char op;
134 int cpu, pmc;
135
136 if ((ncpu = pmc_ncpu()) < 0)
137 err(EX_OSERR, "Unable to determine the number of cpus");
138
139 /* Determine the maximum number of PMCs in any CPU. */
140 npmc = 0;
141 for (c = 0; c < ncpu; c++) {
142 if ((t = pmc_npmc(c)) < 0)
143 err(EX_OSERR,
144 "Unable to determine the number of PMCs in CPU %d",
145 c);
146 npmc = MAX(t, npmc);
147 }
148
149 if (npmc == 0)
150 errx(EX_CONFIG, "No PMCs found");
151
152 if ((map = calloc(npmc, ncpu)) == NULL)
153 err(EX_SOFTWARE, "Out of memory");
154
155 error = 0;
156 STAILQ_FOREACH(np, op_list, op_next) {
157
158 cpu = np->op_cpu;
159 pmc = np->op_pmc;
160 op = np->op_op;
161
162 if (cpu >= ncpu)
163 errx(EX_DATAERR, "CPU id too large: \"%d\"", cpu);
164
165 if (pmc >= npmc)
166 errx(EX_DATAERR, "PMC id too large: \"%d\"", pmc);
167
168 #define MARKMAP(M,C,P,V) do { \
169 *((M) + (C)*npmc + (P)) = (V); \
170 } while (0)
171
172 #define SET_PMCS(C,P,V) do { \
173 if ((P) == PMCC_PMC_ALL) { \
174 for (j = 0; j < npmc; j++) \
175 MARKMAP(map, (C), j, (V)); \
176 } else \
177 MARKMAP(map, (C), (P), (V)); \
178 } while (0)
179
180 #define MAP(M,C,P) (*((M) + (C)*npmc + (P)))
181
182 if (cpu == PMCC_CPU_ALL)
183 for (i = 0; i < ncpu; i++) {
184 SET_PMCS(i, pmc, op);
185 }
186 else
187 SET_PMCS(cpu, pmc, op);
188 }
189
190 /* Configure PMCS */
191 for (i = 0; i < ncpu; i++)
192 for (j = 0; j < npmc; j++) {
193 unsigned char b;
194
195 b = MAP(map, i, j);
196
197 error = 0;
198
199 if (b == PMCC_OP_ENABLE)
200 error = pmc_enable(i, j);
201 else if (b == PMCC_OP_DISABLE)
202 error = pmc_disable(i, j);
203
204 if (error < 0)
205 err(EX_OSERR, "%s of PMC %d on CPU %d failed",
206 b == PMCC_OP_ENABLE ? "Enable" : "Disable",
207 j, i);
208 }
209
210 return error;
211 }
212
213 static int
pmcc_do_list_state(void)214 pmcc_do_list_state(void)
215 {
216 cpuset_t logical_cpus_mask;
217 long cpusetsize;
218 size_t setsize;
219 int c, cpu, n, npmc, ncpu;
220 struct pmc_info *pd;
221 struct pmc_pmcinfo *pi;
222 const struct pmc_cpuinfo *pc;
223
224 if (pmc_cpuinfo(&pc) != 0)
225 err(EX_OSERR, "Unable to determine CPU information");
226
227 printf("%d %s CPUs present, with %d PMCs per CPU\n", pc->pm_ncpu,
228 pmc_name_of_cputype(pc->pm_cputype),
229 pc->pm_npmc);
230
231 /* Determine the set of logical CPUs. */
232 cpusetsize = sysconf(_SC_CPUSET_SIZE);
233 if (cpusetsize == -1 || (u_long)cpusetsize > sizeof(cpuset_t))
234 err(EX_OSERR, "Cannot determine which CPUs are logical");
235 CPU_ZERO(&logical_cpus_mask);
236 setsize = (size_t)cpusetsize;
237 if (sysctlbyname("machdep.logical_cpus_mask", &logical_cpus_mask,
238 &setsize, NULL, 0) < 0)
239 CPU_ZERO(&logical_cpus_mask);
240
241 ncpu = pc->pm_ncpu;
242
243 for (c = cpu = 0; cpu < ncpu; cpu++) {
244 #if defined(__i386__) || defined(__amd64__)
245 if (pc->pm_cputype == PMC_CPU_INTEL_PIV &&
246 CPU_ISSET(cpu, &logical_cpus_mask))
247 continue; /* skip P4-style 'logical' cpus */
248 #endif
249 if (pmc_pmcinfo(cpu, &pi) < 0) {
250 if (errno == ENXIO)
251 continue;
252 err(EX_OSERR, "Unable to get PMC status for CPU %d",
253 cpu);
254 }
255
256 printf("#CPU %d:\n", c++);
257 npmc = pmc_npmc(cpu);
258 printf("#N NAME CLASS STATE ROW-DISP\n");
259
260 for (n = 0; n < npmc; n++) {
261 pd = &pi->pm_pmcs[n];
262
263 printf(" %-2d %-16s %-6s %-8s %-10s",
264 n,
265 pd->pm_name,
266 pmc_name_of_class(pd->pm_class),
267 pd->pm_enabled ? "ENABLED" : "DISABLED",
268 pmc_name_of_disposition(pd->pm_rowdisp));
269
270 if (pd->pm_ownerpid != -1) {
271 printf(" (pid %d)", pd->pm_ownerpid);
272 printf(" %-32s",
273 pmc_name_of_event(pd->pm_event));
274 if (PMC_IS_SAMPLING_MODE(pd->pm_mode))
275 printf(" (reload count %jd)",
276 pd->pm_reloadcount);
277 }
278 printf("\n");
279 }
280 free(pi);
281 }
282 return 0;
283 }
284
285 static int
pmcc_do_list_events(void)286 pmcc_do_list_events(void)
287 {
288 enum pmc_class c;
289 unsigned int i, j, nevents;
290 const char **eventnamelist;
291 const struct pmc_cpuinfo *ci;
292
293 /* First, try pmu events. */
294 if (pmc_pmu_enabled()) {
295 pmc_pmu_print_counters(NULL);
296 return (0);
297 }
298
299 /* Otherwise, use the legacy pmc(3) interfaces. */
300 if (pmc_cpuinfo(&ci) != 0)
301 err(EX_OSERR, "Unable to determine CPU information");
302
303 eventnamelist = NULL;
304
305 for (i = 0; i < ci->pm_nclass; i++) {
306 c = ci->pm_classes[i].pm_class;
307
308 printf("%s\n", pmc_name_of_class(c));
309 if (pmc_event_names_of_class(c, &eventnamelist, &nevents) < 0)
310 err(EX_OSERR,
311 "ERROR: Cannot find information for event class \"%s\"",
312 pmc_name_of_class(c));
313
314 for (j = 0; j < nevents; j++)
315 printf("\t%s\n", eventnamelist[j]);
316
317 free(eventnamelist);
318 }
319 return 0;
320 }
321
322 static int
pmcc_show_statistics(void)323 pmcc_show_statistics(void)
324 {
325
326 struct pmc_driverstats gms;
327
328 if (pmc_get_driver_stats(&gms) < 0)
329 err(EX_OSERR, "ERROR: cannot retrieve driver statistics");
330
331 /*
332 * Print statistics.
333 */
334
335 #define PRINT(N,V) (void) printf("%-40s %d\n", (N), gms.pm_##V)
336 PRINT("interrupts processed:", intr_processed);
337 PRINT("non-PMC interrupts:", intr_ignored);
338 PRINT("sampling stalls due to space shortages:", intr_bufferfull);
339 PRINT("system calls:", syscalls);
340 PRINT("system calls with errors:", syscall_errors);
341 PRINT("buffer requests:", buffer_requests);
342 PRINT("buffer requests failed:", buffer_requests_failed);
343 PRINT("sampling log sweeps:", log_sweeps);
344
345 return 0;
346 }
347
348 /*
349 * Main
350 */
351
352 int
main(int argc,char ** argv)353 main(int argc, char **argv)
354 {
355 int error, command, currentcpu, option, pmc;
356 char *dummy;
357 struct pmcc_op *p;
358
359 #if DEBUG
360 pmcc_init_debug();
361 #endif
362
363 /* parse args */
364
365 currentcpu = PMCC_CPU_ALL;
366 command = PMCC_PRINT_USAGE;
367 error = 0;
368
369 STAILQ_INIT(&head);
370
371 while ((option = getopt(argc, argv, ":c:d:e:lLs")) != -1)
372 switch (option) {
373 case 'L':
374 if (command != PMCC_PRINT_USAGE) {
375 error = 1;
376 break;
377 }
378 command = PMCC_PRINT_EVENTS;
379 break;
380
381 case 'c':
382 if (command != PMCC_PRINT_USAGE &&
383 command != PMCC_ENABLE_DISABLE) {
384 error = 1;
385 break;
386 }
387 command = PMCC_ENABLE_DISABLE;
388
389 if (*optarg == PMCC_CPU_WILDCARD)
390 currentcpu = PMCC_CPU_ALL;
391 else {
392 currentcpu = strtoul(optarg, &dummy, 0);
393 if (*dummy != '\0' || currentcpu < 0)
394 errx(EX_DATAERR,
395 "\"%s\" is not a valid CPU id",
396 optarg);
397 }
398 break;
399
400 case 'd':
401 case 'e':
402 if (command != PMCC_PRINT_USAGE &&
403 command != PMCC_ENABLE_DISABLE) {
404 error = 1;
405 break;
406 }
407 command = PMCC_ENABLE_DISABLE;
408
409 if (*optarg == PMCC_PMC_WILDCARD)
410 pmc = PMCC_PMC_ALL;
411 else {
412 pmc = strtoul(optarg, &dummy, 0);
413 if (*dummy != '\0' || pmc < 0)
414 errx(EX_DATAERR,
415 "\"%s\" is not a valid PMC id",
416 optarg);
417 }
418
419 if ((p = malloc(sizeof(*p))) == NULL)
420 err(EX_SOFTWARE, "Out of memory");
421
422 p->op_cpu = currentcpu;
423 p->op_pmc = pmc;
424 p->op_op = option == 'd' ? PMCC_OP_DISABLE :
425 PMCC_OP_ENABLE;
426
427 STAILQ_INSERT_TAIL(&head, p, op_next);
428 break;
429
430 case 'l':
431 if (command != PMCC_PRINT_USAGE) {
432 error = 1;
433 break;
434 }
435 command = PMCC_LIST_STATE;
436 break;
437
438 case 's':
439 if (command != PMCC_PRINT_USAGE) {
440 error = 1;
441 break;
442 }
443 command = PMCC_SHOW_STATISTICS;
444 break;
445
446 case ':':
447 errx(EX_USAGE,
448 "Missing argument to option '-%c'", optopt);
449 break;
450
451 case '?':
452 warnx("Unrecognized option \"-%c\"", optopt);
453 errx(EX_USAGE, "%s", usage_message);
454 break;
455
456 default:
457 error = 1;
458 break;
459
460 }
461
462 if (command == PMCC_PRINT_USAGE)
463 (void) errx(EX_USAGE, "%s", usage_message);
464
465 if (error)
466 exit(EX_USAGE);
467
468 if (pmc_init() < 0)
469 err(EX_UNAVAILABLE,
470 "Initialization of the pmc(3) library failed");
471
472 switch (command) {
473 case PMCC_LIST_STATE:
474 error = pmcc_do_list_state();
475 break;
476 case PMCC_PRINT_EVENTS:
477 error = pmcc_do_list_events();
478 break;
479 case PMCC_SHOW_STATISTICS:
480 error = pmcc_show_statistics();
481 break;
482 case PMCC_ENABLE_DISABLE:
483 if (STAILQ_EMPTY(&head))
484 errx(EX_USAGE,
485 "No PMCs specified to enable or disable");
486 error = pmcc_do_enable_disable(&head);
487 break;
488 default:
489 assert(0);
490
491 }
492
493 if (error != 0)
494 err(EX_OSERR, "Command failed");
495 exit(0);
496 }
497