usr.sbin/pmccontrol/pmccontrol.c

   1 /*-
   2  * Copyright (c) 2003,2004 Joseph Koshy
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  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
  24  * SUCH DAMAGE.
  25  *
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include <sys/param.h>
  32 #include <sys/queue.h>
  33 #include <sys/cpuset.h>
  34 #include <sys/sysctl.h>
  35
  36 #include <assert.h>
  37 #include <err.h>
  38 #include <errno.h>
  39 #include <fcntl.h>
  40 #include <limits.h>
  41 #include <pmc.h>
  42 #include <stdarg.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46 #include <sysexits.h>
  47 #include <unistd.h>
  48
  49 /* Compile time defaults */
  50
  51 #define PMCC_PRINT_USAGE        0
  52 #define PMCC_PRINT_EVENTS       1
  53 #define PMCC_LIST_STATE         2
  54 #define PMCC_ENABLE_DISABLE     3
  55 #define PMCC_SHOW_STATISTICS    4
  56
  57 #define PMCC_CPU_ALL            -1
  58 #define PMCC_CPU_WILDCARD       '*'
  59
  60 #define PMCC_PMC_ALL            -1
  61 #define PMCC_PMC_WILDCARD       '*'
  62
  63 #define PMCC_OP_IGNORE          0
  64 #define PMCC_OP_DISABLE         1
  65 #define PMCC_OP_ENABLE          2
  66
  67 #define PMCC_PROGRAM_NAME       "pmccontrol"
  68
  69 static STAILQ_HEAD(pmcc_op_list, pmcc_op) head = STAILQ_HEAD_INITIALIZER(head);
  70
  71 struct pmcc_op {
  72         char    op_cpu;
  73         char    op_pmc;
  74         char    op_op;
  75         STAILQ_ENTRY(pmcc_op) op_next;
  76 };
  77
  78 /* Function Prototypes */
  79 #if     DEBUG
  80 static void     pmcc_init_debug(void);
  81 #endif
  82
  83 static int      pmcc_do_list_state(void);
  84 static int      pmcc_do_enable_disable(struct pmcc_op_list *);
  85 static int      pmcc_do_list_events(void);
  86
  87 /* Globals */
  88
  89 static char usage_message[] =
  90         "Usage:\n"
  91         "       " PMCC_PROGRAM_NAME " -L\n"
  92         "       " PMCC_PROGRAM_NAME " -l\n"
  93         "       " PMCC_PROGRAM_NAME " -s\n"
  94         "       " PMCC_PROGRAM_NAME " [-e pmc | -d pmc | -c cpu] ...";
  95
  96 #if DEBUG
  97 static FILE *debug_stream = NULL;
  98 #endif
  99
 100 #if DEBUG
 101 #define DEBUG_MSG(...)                                                  \
 102         (void) fprintf(debug_stream, "[pmccontrol] " __VA_ARGS__);
 103 #else
 104 #define DEBUG_MSG(m)            /*  */
 105 #endif /* !DEBUG */
 106
 107 #if DEBUG
 108 /* log debug messages to a separate file */
 109 static void
 110 pmcc_init_debug(void)
 111 {
 112         char *fn;
 113
 114         fn = getenv("PMCCONTROL_DEBUG");
 115         if (fn != NULL)
 116         {
 117                 debug_stream = fopen(fn, "w");
 118                 if (debug_stream == NULL)
 119                         debug_stream = stderr;
 120         } else
 121                 debug_stream = stderr;
 122 }
 123 #endif
 124
 125 static int
 126 pmcc_do_enable_disable(struct pmcc_op_list *op_list)
 127 {
 128         int c, error, i, j, ncpu, npmc, t;
 129         struct pmcc_op *np;
 130         unsigned char *map;
 131         unsigned char op;
 132         int cpu, pmc;
 133
 134         if ((ncpu = pmc_ncpu()) < 0)
 135                 err(EX_OSERR, "Unable to determine the number of cpus");
 136
 137         /* Determine the maximum number of PMCs in any CPU. */
 138         npmc = 0;
 139         for (c = 0; c < ncpu; c++) {
 140                 if ((t = pmc_npmc(c)) < 0)
 141                         err(EX_OSERR,
 142                             "Unable to determine the number of PMCs in CPU %d",
 143                             c);
 144                 npmc = t > npmc ? t : npmc;
 145         }
 146
 147         if (npmc == 0)
 148                 errx(EX_CONFIG, "No PMCs found");
 149
 150         if ((map = malloc(npmc * ncpu)) == NULL)
 151                 err(EX_SOFTWARE, "Out of memory");
 152
 153         (void) memset(map, PMCC_OP_IGNORE, npmc*ncpu);
 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
 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
 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         if (pmc_cpuinfo(&ci) != 0)
 294                 err(EX_OSERR, "Unable to determine CPU information");
 295
 296         eventnamelist = NULL;
 297
 298         for (i = 0; i < ci->pm_nclass; i++) {
 299                 c = ci->pm_classes[i].pm_class;
 300
 301                 printf("%s\n", pmc_name_of_class(c));
 302                 if (pmc_event_names_of_class(c, &eventnamelist, &nevents) < 0)
 303                         err(EX_OSERR,
 304 "ERROR: Cannot find information for event class \"%s\"",
 305                             pmc_name_of_class(c));
 306
 307                 for (j = 0; j < nevents; j++)
 308                         printf("\t%s\n", eventnamelist[j]);
 309
 310                 free(eventnamelist);
 311         }
 312         return 0;
 313 }
 314
 315 static int
 316 pmcc_show_statistics(void)
 317 {
 318
 319         struct pmc_driverstats gms;
 320
 321         if (pmc_get_driver_stats(&gms) < 0)
 322                 err(EX_OSERR, "ERROR: cannot retrieve driver statistics");
 323
 324         /*
 325          * Print statistics.
 326          */
 327
 328 #define PRINT(N,V)      (void) printf("%-40s %d\n", (N), gms.pm_##V)
 329         PRINT("interrupts processed:", intr_processed);
 330         PRINT("non-PMC interrupts:", intr_ignored);
 331         PRINT("sampling stalls due to space shortages:", intr_bufferfull);
 332         PRINT("system calls:", syscalls);
 333         PRINT("system calls with errors:", syscall_errors);
 334         PRINT("buffer requests:", buffer_requests);
 335         PRINT("buffer requests failed:", buffer_requests_failed);
 336         PRINT("sampling log sweeps:", log_sweeps);
 337
 338         return 0;
 339 }
 340
 341 /*
 342  * Main
 343  */
 344
 345 int
 346 main(int argc, char **argv)
 347 {
 348         int error, command, currentcpu, option, pmc;
 349         char *dummy;
 350         struct pmcc_op *p;
 351
 352 #if DEBUG
 353         pmcc_init_debug();
 354 #endif
 355
 356         /* parse args */
 357
 358         currentcpu = PMCC_CPU_ALL;
 359         command    = PMCC_PRINT_USAGE;
 360         error      = 0;
 361
 362         STAILQ_INIT(&head);
 363
 364         while ((option = getopt(argc, argv, ":c:d:e:lLs")) != -1)
 365                 switch (option) {
 366                 case 'L':
 367                         if (command != PMCC_PRINT_USAGE) {
 368                                 error = 1;
 369                                 break;
 370                         }
 371                         command = PMCC_PRINT_EVENTS;
 372                         break;
 373
 374                 case 'c':
 375                         if (command != PMCC_PRINT_USAGE &&
 376                             command != PMCC_ENABLE_DISABLE) {
 377                                 error = 1;
 378                                 break;
 379                         }
 380                         command = PMCC_ENABLE_DISABLE;
 381
 382                         if (*optarg == PMCC_CPU_WILDCARD)
 383                                 currentcpu = PMCC_CPU_ALL;
 384                         else {
 385                                 currentcpu = strtoul(optarg, &dummy, 0);
 386                                 if (*dummy != '\0' || currentcpu < 0)
 387                                         errx(EX_DATAERR,
 388                                             "\"%s\" is not a valid CPU id",
 389                                             optarg);
 390                         }
 391                         break;
 392
 393                 case 'd':
 394                 case 'e':
 395                         if (command != PMCC_PRINT_USAGE &&
 396                             command != PMCC_ENABLE_DISABLE) {
 397                                 error = 1;
 398                                 break;
 399                         }
 400                         command = PMCC_ENABLE_DISABLE;
 401
 402                         if (*optarg == PMCC_PMC_WILDCARD)
 403                                 pmc = PMCC_PMC_ALL;
 404                         else {
 405                                 pmc = strtoul(optarg, &dummy, 0);
 406                                 if (*dummy != '\0' || pmc < 0)
 407                                         errx(EX_DATAERR,
 408                                             "\"%s\" is not a valid PMC id",
 409                                             optarg);
 410                         }
 411
 412                         if ((p = malloc(sizeof(*p))) == NULL)
 413                                 err(EX_SOFTWARE, "Out of memory");
 414
 415                         p->op_cpu = currentcpu;
 416                         p->op_pmc = pmc;
 417                         p->op_op  = option == 'd' ? PMCC_OP_DISABLE :
 418                             PMCC_OP_ENABLE;
 419
 420                         STAILQ_INSERT_TAIL(&head, p, op_next);
 421                         break;
 422
 423                 case 'l':
 424                         if (command != PMCC_PRINT_USAGE) {
 425                                 error = 1;
 426                                 break;
 427                         }
 428                         command = PMCC_LIST_STATE;
 429                         break;
 430
 431                 case 's':
 432                         if (command != PMCC_PRINT_USAGE) {
 433                                 error = 1;
 434                                 break;
 435                         }
 436                         command = PMCC_SHOW_STATISTICS;
 437                         break;
 438
 439                 case ':':
 440                         errx(EX_USAGE,
 441                             "Missing argument to option '-%c'", optopt);
 442                         break;
 443
 444                 case '?':
 445                         warnx("Unrecognized option \"-%c\"", optopt);
 446                         errx(EX_USAGE, "%s", usage_message);
 447                         break;
 448
 449                 default:
 450                         error = 1;
 451                         break;
 452
 453                 }
 454
 455         if (command == PMCC_PRINT_USAGE)
 456                 (void) errx(EX_USAGE, "%s", usage_message);
 457
 458         if (error)
 459                 exit(EX_USAGE);
 460
 461         if (pmc_init() < 0)
 462                 err(EX_UNAVAILABLE,
 463                     "Initialization of the pmc(3) library failed");
 464
 465         switch (command) {
 466         case PMCC_LIST_STATE:
 467                 error = pmcc_do_list_state();
 468                 break;
 469         case PMCC_PRINT_EVENTS:
 470                 error = pmcc_do_list_events();
 471                 break;
 472         case PMCC_SHOW_STATISTICS:
 473                 error = pmcc_show_statistics();
 474                 break;
 475         case PMCC_ENABLE_DISABLE:
 476                 if (STAILQ_EMPTY(&head))
 477                         errx(EX_USAGE,
 478                             "No PMCs specified to enable or disable");
 479                 error = pmcc_do_enable_disable(&head);
 480                 break;
 481         default:
 482                 assert(0);
 483
 484         }
 485
 486         if (error != 0)
 487                 err(EX_OSERR, "Command failed");
 488         exit(0);
 489 }