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)
137 int c, error, i, j, ncpu, npmc, t;
142 if ((ncpu = pmc_ncpu()) < 0)
143 err(EX_OSERR, "Unable to determine the number of cpus");
145 /* determine the maximum number of PMCs in any CPU */
147 for (c = 0; c < ncpu; c++) {
148 if ((t = pmc_npmc(c)) < 0)
149 err(EX_OSERR, "Unable to determine the number of PMCs in "
151 npmc = t > npmc ? t : npmc;
155 errx(EX_CONFIG, "No PMCs found");
157 if ((map = malloc(npmc * ncpu)) == NULL)
158 err(EX_SOFTWARE, "Out of memory");
160 (void) memset(map, PMCC_OP_IGNORE, npmc*ncpu);
163 STAILQ_FOREACH(np, op_list, op_next) {
170 errx(EX_DATAERR, "CPU id too large: \"%d\"", cpu);
173 errx(EX_DATAERR, "PMC id too large: \"%d\"", pmc);
175 #define MARKMAP(M,C,P,V) do { \
176 *((M) + (C)*npmc + (P)) = (V); \
179 #define SET_PMCS(C,P,V) do { \
180 if ((P) == PMCC_PMC_ALL) { \
181 for (j = 0; j < npmc; j++) \
182 MARKMAP(map, (C), j, (V)); \
184 MARKMAP(map, (C), (P), (V)); \
187 #define MAP(M,C,P) (*((M) + (C)*npmc + (P)))
189 if (cpu == PMCC_CPU_ALL)
190 for (i = 0; i < ncpu; i++)
191 SET_PMCS(i, pmc, op);
193 SET_PMCS(cpu, pmc, op);
197 for (i = 0; i < ncpu; i++)
198 for (j = 0; j < npmc; j++) {
205 if (b == PMCC_OP_ENABLE)
206 error = pmc_enable(i, j);
207 else if (b == PMCC_OP_DISABLE)
208 error = pmc_disable(i, j);
211 err(EX_OSERR, "%s of PMC %d on CPU %d failed",
212 b == PMCC_OP_ENABLE ? "Enable" :
220 pmcc_do_list_state(void)
223 int c, cpu, n, npmc, ncpu;
224 unsigned int logical_cpus_mask;
226 struct pmc_pmcinfo *pi;
227 const struct pmc_cpuinfo *pc;
229 if (pmc_cpuinfo(&pc) != 0)
230 err(EX_OSERR, "Unable to determine CPU information");
232 dummy = sizeof(logical_cpus_mask);
233 if (sysctlbyname("machdep.logical_cpus_mask", &logical_cpus_mask,
234 &dummy, NULL, 0) < 0)
235 logical_cpus_mask = 0;
239 for (c = cpu = 0; cpu < ncpu; cpu++) {
240 #if defined(__i386__) || defined(__amd64__)
241 if (pc->pm_cputype == PMC_CPU_INTEL_PIV &&
242 (logical_cpus_mask & (1 << cpu)))
243 continue; /* skip P4-style 'logical' cpus */
245 if (pmc_pmcinfo(cpu, &pi) < 0)
246 err(EX_OSERR, "Unable to get PMC status for CPU %d",
249 printf("#CPU %d:\n", c++);
250 npmc = pmc_npmc(cpu);
251 printf("#N NAME CLASS STATE ROW-DISP\n");
253 for (n = 0; n < npmc; n++) {
254 pd = &pi->pm_pmcs[n];
256 printf(" %-2d %-16s %-6s %-8s %-10s",
259 pmc_name_of_class(pd->pm_class),
260 pd->pm_enabled ? "ENABLED" : "DISABLED",
261 pmc_name_of_disposition(pd->pm_rowdisp));
263 if (pd->pm_ownerpid != -1) {
264 printf(" (pid %d)", pd->pm_ownerpid);
266 pmc_name_of_event(pd->pm_event));
267 if (PMC_IS_SAMPLING_MODE(pd->pm_mode))
268 printf(" (reload count %jd)",
279 pmcc_do_list_events(void)
282 unsigned int i, j, nevents;
283 const char **eventnamelist;
284 const struct pmc_cpuinfo *ci;
286 if (pmc_cpuinfo(&ci) != 0)
287 err(EX_OSERR, "Unable to determine CPU information");
289 eventnamelist = NULL;
291 for (i = 0; i < ci->pm_nclass; i++) {
292 c = ci->pm_classes[i].pm_class;
294 printf("%s\n", pmc_name_of_class(c));
295 if (pmc_event_names_of_class(c, &eventnamelist, &nevents) < 0)
296 err(EX_OSERR, "ERROR: Cannot find information for "
297 "event class \"%s\"", pmc_name_of_class(c));
299 for (j = 0; j < nevents; j++)
300 printf("\t%s\n", eventnamelist[j]);
308 pmcc_show_statistics(void)
311 struct pmc_driverstats gms;
313 if (pmc_get_driver_stats(&gms) < 0)
314 err(EX_OSERR, "ERROR: cannot retrieve driver statistics");
320 #define PRINT(N,V) (void) printf("%-40s %d\n", (N), gms.pm_##V)
321 PRINT("interrupts processed:", intr_processed);
322 PRINT("non-PMC interrupts:", intr_ignored);
323 PRINT("sampling stalls due to space shortages:", intr_bufferfull);
324 PRINT("system calls:", syscalls);
325 PRINT("system calls with errors:", syscall_errors);
326 PRINT("buffer requests:", buffer_requests);
327 PRINT("buffer requests failed:", buffer_requests_failed);
328 PRINT("sampling log sweeps:", log_sweeps);
338 main(int argc, char **argv)
340 int error, command, currentcpu, option, pmc;
350 currentcpu = PMCC_CPU_ALL;
351 command = PMCC_PRINT_USAGE;
356 while ((option = getopt(argc, argv, ":c:d:e:lLs")) != -1)
359 if (command != PMCC_PRINT_USAGE) {
363 command = PMCC_PRINT_EVENTS;
367 if (command != PMCC_PRINT_USAGE &&
368 command != PMCC_ENABLE_DISABLE) {
372 command = PMCC_ENABLE_DISABLE;
374 if (*optarg == PMCC_CPU_WILDCARD)
375 currentcpu = PMCC_CPU_ALL;
377 currentcpu = strtoul(optarg, &dummy, 0);
378 if (*dummy != '\0' || currentcpu < 0)
380 "\"%s\" is not a valid CPU id",
387 if (command != PMCC_PRINT_USAGE &&
388 command != PMCC_ENABLE_DISABLE) {
392 command = PMCC_ENABLE_DISABLE;
394 if (*optarg == PMCC_PMC_WILDCARD)
397 pmc = strtoul(optarg, &dummy, 0);
398 if (*dummy != '\0' || pmc < 0)
400 "\"%s\" is not a valid PMC id",
404 if ((p = malloc(sizeof(*p))) == NULL)
405 err(EX_SOFTWARE, "Out of memory");
407 p->op_cpu = currentcpu;
409 p->op_op = option == 'd' ? PMCC_OP_DISABLE :
412 STAILQ_INSERT_TAIL(&head, p, op_next);
416 if (command != PMCC_PRINT_USAGE) {
420 command = PMCC_LIST_STATE;
424 if (command != PMCC_PRINT_USAGE) {
428 command = PMCC_SHOW_STATISTICS;
433 "Missing argument to option '-%c'", optopt);
437 warnx("Unrecognized option \"-%c\"", optopt);
438 errx(EX_USAGE, usage_message);
447 if (command == PMCC_PRINT_USAGE)
448 (void) errx(EX_USAGE, usage_message);
455 "Initialization of the pmc(3) library failed");
458 case PMCC_LIST_STATE:
459 error = pmcc_do_list_state();
461 case PMCC_PRINT_EVENTS:
462 error = pmcc_do_list_events();
464 case PMCC_SHOW_STATISTICS:
465 error = pmcc_show_statistics();
467 case PMCC_ENABLE_DISABLE:
468 if (STAILQ_EMPTY(&head))
469 errx(EX_USAGE, "No PMCs specified to enable or disable");
470 error = pmcc_do_enable_disable(&head);
478 err(EX_OSERR, "Command failed");