usr.sbin/pmcstat/pmcstat.c

   1 /*-
   2  * Copyright (c) 2003-2008, Joseph Koshy
   3  * Copyright (c) 2007 The FreeBSD Foundation
   4  * All rights reserved.
   5  *
   6  * Portions of this software were developed by A. Joseph Koshy under
   7  * sponsorship from the FreeBSD Foundation and Google, Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35 #include <sys/cpuset.h>
  36 #include <sys/event.h>
  37 #include <sys/queue.h>
  38 #include <sys/socket.h>
  39 #include <sys/stat.h>
  40 #include <sys/sysctl.h>
  41 #include <sys/time.h>
  42 #include <sys/ttycom.h>
  43 #include <sys/user.h>
  44 #include <sys/wait.h>
  45
  46 #include <assert.h>
  47 #include <curses.h>
  48 #include <err.h>
  49 #include <errno.h>
  50 #include <fcntl.h>
  51 #include <kvm.h>
  52 #include <libgen.h>
  53 #include <limits.h>
  54 #include <math.h>
  55 #include <pmc.h>
  56 #include <pmclog.h>
  57 #include <regex.h>
  58 #include <signal.h>
  59 #include <stdarg.h>
  60 #include <stdint.h>
  61 #include <stdio.h>
  62 #include <stdlib.h>
  63 #include <string.h>
  64 #include <sysexits.h>
  65 #include <unistd.h>
  66
  67 #include "pmcstat.h"
  68
  69 /*
  70  * A given invocation of pmcstat(8) can manage multiple PMCs of both
  71  * the system-wide and per-process variety.  Each of these could be in
  72  * 'counting mode' or in 'sampling mode'.
  73  *
  74  * For 'counting mode' PMCs, pmcstat(8) will periodically issue a
  75  * pmc_read() at the configured time interval and print out the value
  76  * of the requested PMCs.
  77  *
  78  * For 'sampling mode' PMCs it can log to a file for offline analysis,
  79  * or can analyse sampling data "on the fly", either by converting
  80  * samples to printed textual form or by creating gprof(1) compatible
  81  * profiles, one per program executed.  When creating gprof(1)
  82  * profiles it can optionally merge entries from multiple processes
  83  * for a given executable into a single profile file.
  84  *
  85  * pmcstat(8) can also execute a command line and attach PMCs to the
  86  * resulting child process.  The protocol used is as follows:
  87  *
  88  * - parent creates a socketpair for two way communication and
  89  *   fork()s.
  90  * - subsequently:
  91  *
  92  *   /Parent/                           /Child/
  93  *
  94  *   - Wait for childs token.
  95  *                                      - Sends token.
  96  *                                      - Awaits signal to start.
  97  *  - Attaches PMCs to the child's pid
  98  *    and starts them. Sets up
  99  *    monitoring for the child.
 100  *  - Signals child to start.
 101  *                                      - Receives signal, attempts exec().
 102  *
 103  * After this point normal processing can happen.
 104  */
 105
 106 /* Globals */
 107
 108 int             pmcstat_displayheight = DEFAULT_DISPLAY_HEIGHT;
 109 int             pmcstat_displaywidth  = DEFAULT_DISPLAY_WIDTH;
 110 static int      pmcstat_sockpair[NSOCKPAIRFD];
 111 static int      pmcstat_kq;
 112 static kvm_t    *pmcstat_kvm;
 113 static struct kinfo_proc *pmcstat_plist;
 114 struct pmcstat_args args;
 115
 116 static void
 117 pmcstat_clone_event_descriptor(struct pmcstat_ev *ev, const cpuset_t *cpumask)
 118 {
 119         int cpu;
 120         struct pmcstat_ev *ev_clone;
 121
 122         for (cpu = 0; cpu < CPU_SETSIZE; cpu++) {
 123                 if (!CPU_ISSET(cpu, cpumask))
 124                         continue;
 125
 126                 if ((ev_clone = malloc(sizeof(*ev_clone))) == NULL)
 127                         errx(EX_SOFTWARE, "ERROR: Out of memory");
 128                 (void) memset(ev_clone, 0, sizeof(*ev_clone));
 129
 130                 ev_clone->ev_count = ev->ev_count;
 131                 ev_clone->ev_cpu   = cpu;
 132                 ev_clone->ev_cumulative = ev->ev_cumulative;
 133                 ev_clone->ev_flags = ev->ev_flags;
 134                 ev_clone->ev_mode  = ev->ev_mode;
 135                 ev_clone->ev_name  = strdup(ev->ev_name);
 136                 ev_clone->ev_pmcid = ev->ev_pmcid;
 137                 ev_clone->ev_saved = ev->ev_saved;
 138                 ev_clone->ev_spec  = strdup(ev->ev_spec);
 139
 140                 STAILQ_INSERT_TAIL(&args.pa_events, ev_clone, ev_next);
 141         }
 142 }
 143
 144 static void
 145 pmcstat_get_cpumask(const char *cpuspec, cpuset_t *cpumask)
 146 {
 147         int cpu;
 148         const char *s;
 149         char *end;
 150
 151         CPU_ZERO(cpumask);
 152         s = cpuspec;
 153
 154         do {
 155                 cpu = strtol(s, &end, 0);
 156                 if (cpu < 0 || end == s)
 157                         errx(EX_USAGE,
 158                             "ERROR: Illegal CPU specification \"%s\".",
 159                             cpuspec);
 160                 CPU_SET(cpu, cpumask);
 161                 s = end + strspn(end, ", \t");
 162         } while (*s);
 163         assert(!CPU_EMPTY(cpumask));
 164 }
 165
 166 void
 167 pmcstat_attach_pmcs(void)
 168 {
 169         struct pmcstat_ev *ev;
 170         struct pmcstat_target *pt;
 171         int count;
 172
 173         /* Attach all process PMCs to target processes. */
 174         count = 0;
 175         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
 176                 if (PMC_IS_SYSTEM_MODE(ev->ev_mode))
 177                         continue;
 178                 SLIST_FOREACH(pt, &args.pa_targets, pt_next)
 179                         if (pmc_attach(ev->ev_pmcid, pt->pt_pid) == 0)
 180                                 count++;
 181                         else if (errno != ESRCH)
 182                                 err(EX_OSERR,
 183 "ERROR: cannot attach pmc \"%s\" to process %d",
 184                                     ev->ev_name, (int)pt->pt_pid);
 185         }
 186
 187         if (count == 0)
 188                 errx(EX_DATAERR, "ERROR: No processes were attached to.");
 189 }
 190
 191
 192 void
 193 pmcstat_cleanup(void)
 194 {
 195         struct pmcstat_ev *ev, *tmp;
 196
 197         /* release allocated PMCs. */
 198         STAILQ_FOREACH_SAFE(ev, &args.pa_events, ev_next, tmp)
 199             if (ev->ev_pmcid != PMC_ID_INVALID) {
 200                 if (pmc_stop(ev->ev_pmcid) < 0)
 201                         err(EX_OSERR, "ERROR: cannot stop pmc 0x%x \"%s\"",
 202                             ev->ev_pmcid, ev->ev_name);
 203                 if (pmc_release(ev->ev_pmcid) < 0)
 204                         err(EX_OSERR, "ERROR: cannot release pmc 0x%x \"%s\"",
 205                             ev->ev_pmcid, ev->ev_name);
 206                 free(ev->ev_name);
 207                 free(ev->ev_spec);
 208                 STAILQ_REMOVE(&args.pa_events, ev, pmcstat_ev, ev_next);
 209                 free(ev);
 210             }
 211
 212         /* de-configure the log file if present. */
 213         if (args.pa_flags & (FLAG_HAS_PIPE | FLAG_HAS_OUTPUT_LOGFILE))
 214                 (void) pmc_configure_logfile(-1);
 215
 216         if (args.pa_logparser) {
 217                 pmclog_close(args.pa_logparser);
 218                 args.pa_logparser = NULL;
 219         }
 220
 221         pmcstat_shutdown_logging();
 222 }
 223
 224 void
 225 pmcstat_create_process(void)
 226 {
 227         char token;
 228         pid_t pid;
 229         struct kevent kev;
 230         struct pmcstat_target *pt;
 231
 232         if (socketpair(AF_UNIX, SOCK_STREAM, 0, pmcstat_sockpair) < 0)
 233                 err(EX_OSERR, "ERROR: cannot create socket pair");
 234
 235         switch (pid = fork()) {
 236         case -1:
 237                 err(EX_OSERR, "ERROR: cannot fork");
 238                 /*NOTREACHED*/
 239
 240         case 0:         /* child */
 241                 (void) close(pmcstat_sockpair[PARENTSOCKET]);
 242
 243                 /* Write a token to tell our parent we've started executing. */
 244                 if (write(pmcstat_sockpair[CHILDSOCKET], "+", 1) != 1)
 245                         err(EX_OSERR, "ERROR (child): cannot write token");
 246
 247                 /* Wait for our parent to signal us to start. */
 248                 if (read(pmcstat_sockpair[CHILDSOCKET], &token, 1) < 0)
 249                         err(EX_OSERR, "ERROR (child): cannot read token");
 250                 (void) close(pmcstat_sockpair[CHILDSOCKET]);
 251
 252                 /* exec() the program requested */
 253                 execvp(*args.pa_argv, args.pa_argv);
 254                 /* and if that fails, notify the parent */
 255                 kill(getppid(), SIGCHLD);
 256                 err(EX_OSERR, "ERROR: execvp \"%s\" failed", *args.pa_argv);
 257                 /*NOTREACHED*/
 258
 259         default:        /* parent */
 260                 (void) close(pmcstat_sockpair[CHILDSOCKET]);
 261                 break;
 262         }
 263
 264         /* Ask to be notified via a kevent when the target process exits. */
 265         EV_SET(&kev, pid, EVFILT_PROC, EV_ADD|EV_ONESHOT, NOTE_EXIT, 0,
 266             NULL);
 267         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
 268                 err(EX_OSERR, "ERROR: cannot monitor child process %d", pid);
 269
 270         if ((pt = malloc(sizeof(*pt))) == NULL)
 271                 errx(EX_SOFTWARE, "ERROR: Out of memory.");
 272
 273         pt->pt_pid = pid;
 274         SLIST_INSERT_HEAD(&args.pa_targets, pt, pt_next);
 275
 276         /* Wait for the child to signal that its ready to go. */
 277         if (read(pmcstat_sockpair[PARENTSOCKET], &token, 1) < 0)
 278                 err(EX_OSERR, "ERROR (parent): cannot read token");
 279
 280         return;
 281 }
 282
 283 void
 284 pmcstat_find_targets(const char *spec)
 285 {
 286         int n, nproc, pid, rv;
 287         struct pmcstat_target *pt;
 288         char errbuf[_POSIX2_LINE_MAX], *end;
 289         static struct kinfo_proc *kp;
 290         regex_t reg;
 291         regmatch_t regmatch;
 292
 293         /* First check if we've been given a process id. */
 294         pid = strtol(spec, &end, 0);
 295         if (end != spec && pid >= 0) {
 296                 if ((pt = malloc(sizeof(*pt))) == NULL)
 297                         goto outofmemory;
 298                 pt->pt_pid = pid;
 299                 SLIST_INSERT_HEAD(&args.pa_targets, pt, pt_next);
 300                 return;
 301         }
 302
 303         /* Otherwise treat arg as a regular expression naming processes. */
 304         if (pmcstat_kvm == NULL) {
 305                 if ((pmcstat_kvm = kvm_openfiles(NULL, "/dev/null", NULL, 0,
 306                     errbuf)) == NULL)
 307                         err(EX_OSERR, "ERROR: Cannot open kernel \"%s\"",
 308                             errbuf);
 309                 if ((pmcstat_plist = kvm_getprocs(pmcstat_kvm, KERN_PROC_PROC,
 310                     0, &nproc)) == NULL)
 311                         err(EX_OSERR, "ERROR: Cannot get process list: %s",
 312                             kvm_geterr(pmcstat_kvm));
 313         } else
 314                 nproc = 0;
 315
 316         if ((rv = regcomp(&reg, spec, REG_EXTENDED|REG_NOSUB)) != 0) {
 317                 regerror(rv, &reg, errbuf, sizeof(errbuf));
 318                 err(EX_DATAERR, "ERROR: Failed to compile regex \"%s\": %s",
 319                     spec, errbuf);
 320         }
 321
 322         for (n = 0, kp = pmcstat_plist; n < nproc; n++, kp++) {
 323                 if ((rv = regexec(&reg, kp->ki_comm, 1, &regmatch, 0)) == 0) {
 324                         if ((pt = malloc(sizeof(*pt))) == NULL)
 325                                 goto outofmemory;
 326                         pt->pt_pid = kp->ki_pid;
 327                         SLIST_INSERT_HEAD(&args.pa_targets, pt, pt_next);
 328                 } else if (rv != REG_NOMATCH) {
 329                         regerror(rv, &reg, errbuf, sizeof(errbuf));
 330                         errx(EX_SOFTWARE, "ERROR: Regex evalation failed: %s",
 331                             errbuf);
 332                 }
 333         }
 334
 335         regfree(&reg);
 336
 337         return;
 338
 339  outofmemory:
 340         errx(EX_SOFTWARE, "Out of memory.");
 341         /*NOTREACHED*/
 342 }
 343
 344 void
 345 pmcstat_kill_process(void)
 346 {
 347         struct pmcstat_target *pt;
 348
 349         assert(args.pa_flags & FLAG_HAS_COMMANDLINE);
 350
 351         /*
 352          * If a command line was specified, it would be the very first
 353          * in the list, before any other processes specified by -t.
 354          */
 355         pt = SLIST_FIRST(&args.pa_targets);
 356         assert(pt != NULL);
 357
 358         if (kill(pt->pt_pid, SIGINT) != 0)
 359                 err(EX_OSERR, "ERROR: cannot signal child process");
 360 }
 361
 362 void
 363 pmcstat_start_pmcs(void)
 364 {
 365         struct pmcstat_ev *ev;
 366
 367         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
 368
 369             assert(ev->ev_pmcid != PMC_ID_INVALID);
 370
 371             if (pmc_start(ev->ev_pmcid) < 0) {
 372                 warn("ERROR: Cannot start pmc 0x%x \"%s\"",
 373                     ev->ev_pmcid, ev->ev_name);
 374                 pmcstat_cleanup();
 375                 exit(EX_OSERR);
 376             }
 377         }
 378
 379 }
 380
 381 void
 382 pmcstat_print_headers(void)
 383 {
 384         struct pmcstat_ev *ev;
 385         int c, w;
 386
 387         (void) fprintf(args.pa_printfile, PRINT_HEADER_PREFIX);
 388
 389         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
 390                 if (PMC_IS_SAMPLING_MODE(ev->ev_mode))
 391                         continue;
 392
 393                 c = PMC_IS_SYSTEM_MODE(ev->ev_mode) ? 's' : 'p';
 394
 395                 if (ev->ev_fieldskip != 0)
 396                         (void) fprintf(args.pa_printfile, "%*s",
 397                             ev->ev_fieldskip, "");
 398                 w = ev->ev_fieldwidth - ev->ev_fieldskip - 2;
 399
 400                 if (c == 's')
 401                         (void) fprintf(args.pa_printfile, "s/%02d/%-*s ",
 402                             ev->ev_cpu, w-3, ev->ev_name);
 403                 else
 404                         (void) fprintf(args.pa_printfile, "p/%*s ", w,
 405                             ev->ev_name);
 406         }
 407
 408         (void) fflush(args.pa_printfile);
 409 }
 410
 411 void
 412 pmcstat_print_counters(void)
 413 {
 414         int extra_width;
 415         struct pmcstat_ev *ev;
 416         pmc_value_t value;
 417
 418         extra_width = sizeof(PRINT_HEADER_PREFIX) - 1;
 419
 420         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
 421
 422                 /* skip sampling mode counters */
 423                 if (PMC_IS_SAMPLING_MODE(ev->ev_mode))
 424                         continue;
 425
 426                 if (pmc_read(ev->ev_pmcid, &value) < 0)
 427                         err(EX_OSERR, "ERROR: Cannot read pmc \"%s\"",
 428                             ev->ev_name);
 429
 430                 (void) fprintf(args.pa_printfile, "%*ju ",
 431                     ev->ev_fieldwidth + extra_width,
 432                     (uintmax_t) ev->ev_cumulative ? value :
 433                     (value - ev->ev_saved));
 434
 435                 if (ev->ev_cumulative == 0)
 436                         ev->ev_saved = value;
 437                 extra_width = 0;
 438         }
 439
 440         (void) fflush(args.pa_printfile);
 441 }
 442
 443 /*
 444  * Print output
 445  */
 446
 447 void
 448 pmcstat_print_pmcs(void)
 449 {
 450         static int linecount = 0;
 451
 452         /* check if we need to print a header line */
 453         if (++linecount > pmcstat_displayheight) {
 454                 (void) fprintf(args.pa_printfile, "\n");
 455                 linecount = 1;
 456         }
 457         if (linecount == 1)
 458                 pmcstat_print_headers();
 459         (void) fprintf(args.pa_printfile, "\n");
 460
 461         pmcstat_print_counters();
 462
 463         return;
 464 }
 465
 466 /*
 467  * Do process profiling
 468  *
 469  * If a pid was specified, attach each allocated PMC to the target
 470  * process.  Otherwise, fork a child and attach the PMCs to the child,
 471  * and have the child exec() the target program.
 472  */
 473
 474 void
 475 pmcstat_start_process(void)
 476 {
 477         /* Signal the child to proceed. */
 478         if (write(pmcstat_sockpair[PARENTSOCKET], "!", 1) != 1)
 479                 err(EX_OSERR, "ERROR (parent): write of token failed");
 480
 481         (void) close(pmcstat_sockpair[PARENTSOCKET]);
 482 }
 483
 484 void
 485 pmcstat_show_usage(void)
 486 {
 487         errx(EX_USAGE,
 488             "[options] [commandline]\n"
 489             "\t Measure process and/or system performance using hardware\n"
 490             "\t performance monitoring counters.\n"
 491             "\t Options include:\n"
 492             "\t -C\t\t (toggle) show cumulative counts\n"
 493             "\t -D path\t create profiles in directory \"path\"\n"
 494             "\t -E\t\t (toggle) show counts at process exit\n"
 495             "\t -F file\t write a system-wide callgraph (Kcachegrind format)"
 496                 " to \"file\"\n"
 497             "\t -G file\t write a system-wide callgraph to \"file\"\n"
 498             "\t -M file\t print executable/gmon file map to \"file\"\n"
 499             "\t -N\t\t (toggle) capture callchains\n"
 500             "\t -O file\t send log output to \"file\"\n"
 501             "\t -P spec\t allocate a process-private sampling PMC\n"
 502             "\t -R file\t read events from \"file\"\n"
 503             "\t -S spec\t allocate a system-wide sampling PMC\n"
 504             "\t -T\t\t start in top mode\n"
 505             "\t -W\t\t (toggle) show counts per context switch\n"
 506             "\t -a <file>\t print sampled PCs and callgraph to \"file\"\n"
 507             "\t -c cpu-list\t set cpus for subsequent system-wide PMCs\n"
 508             "\t -d\t\t (toggle) track descendants\n"
 509             "\t -e\t\t use wide history counter for gprof(1) output\n"
 510             "\t -f spec\t pass \"spec\" to as plugin option\n"
 511             "\t -g\t\t produce gprof(1) compatible profiles\n"
 512             "\t -k dir\t\t set the path to the kernel\n"
 513             "\t -l secs\t set duration time\n"
 514             "\t -m file\t print sampled PCs to \"file\"\n"
 515             "\t -n rate\t set sampling rate\n"
 516             "\t -o file\t send print output to \"file\"\n"
 517             "\t -p spec\t allocate a process-private counting PMC\n"
 518             "\t -q\t\t suppress verbosity\n"
 519             "\t -r fsroot\t specify FS root directory\n"
 520             "\t -s spec\t allocate a system-wide counting PMC\n"
 521             "\t -t process-spec attach to running processes matching "
 522                 "\"process-spec\"\n"
 523             "\t -v\t\t increase verbosity\n"
 524             "\t -w secs\t set printing time interval\n"
 525             "\t -z depth\t limit callchain display depth"
 526         );
 527 }
 528
 529 /*
 530  * At exit handler for top mode
 531  */
 532
 533 void
 534 pmcstat_topexit(void)
 535 {
 536         if (!args.pa_toptty)
 537                 return;
 538
 539         /*
 540          * Shutdown ncurses.
 541          */
 542         clrtoeol();
 543         refresh();
 544         endwin();
 545 }
 546
 547 /*
 548  * Main
 549  */
 550
 551 int
 552 main(int argc, char **argv)
 553 {
 554         cpuset_t cpumask, rootmask;
 555         double interval;
 556         double duration;
 557         int option, npmc;
 558         int c, check_driver_stats, current_sampling_count;
 559         int do_callchain, do_descendants, do_logproccsw, do_logprocexit;
 560         int do_print, do_read;
 561         size_t len;
 562         int graphdepth;
 563         int pipefd[2], rfd;
 564         int use_cumulative_counts;
 565         short cf, cb;
 566         char *end, *tmp;
 567         const char *errmsg, *graphfilename;
 568         enum pmcstat_state runstate;
 569         struct pmc_driverstats ds_start, ds_end;
 570         struct pmcstat_ev *ev;
 571         struct sigaction sa;
 572         struct kevent kev;
 573         struct winsize ws;
 574         struct stat sb;
 575         char buffer[PATH_MAX];
 576
 577         check_driver_stats      = 0;
 578         current_sampling_count  = DEFAULT_SAMPLE_COUNT;
 579         do_callchain            = 1;
 580         do_descendants          = 0;
 581         do_logproccsw           = 0;
 582         do_logprocexit          = 0;
 583         use_cumulative_counts   = 0;
 584         graphfilename           = "-";
 585         args.pa_required        = 0;
 586         args.pa_flags           = 0;
 587         args.pa_verbosity       = 1;
 588         args.pa_logfd           = -1;
 589         args.pa_fsroot          = "";
 590         args.pa_samplesdir      = ".";
 591         args.pa_printfile       = stderr;
 592         args.pa_graphdepth      = DEFAULT_CALLGRAPH_DEPTH;
 593         args.pa_graphfile       = NULL;
 594         args.pa_interval        = DEFAULT_WAIT_INTERVAL;
 595         args.pa_mapfilename     = NULL;
 596         args.pa_inputpath       = NULL;
 597         args.pa_outputpath      = NULL;
 598         args.pa_pplugin         = PMCSTAT_PL_NONE;
 599         args.pa_plugin          = PMCSTAT_PL_NONE;
 600         args.pa_ctdumpinstr     = 1;
 601         args.pa_topmode         = PMCSTAT_TOP_DELTA;
 602         args.pa_toptty          = 0;
 603         args.pa_topcolor        = 0;
 604         args.pa_mergepmc        = 0;
 605         args.pa_duration        = 0.0;
 606         STAILQ_INIT(&args.pa_events);
 607         SLIST_INIT(&args.pa_targets);
 608         bzero(&ds_start, sizeof(ds_start));
 609         bzero(&ds_end, sizeof(ds_end));
 610         ev = NULL;
 611         CPU_ZERO(&cpumask);
 612
 613         /* Default to using the running system kernel. */
 614         len = 0;
 615         if (sysctlbyname("kern.bootfile", NULL, &len, NULL, 0) == -1)
 616                 err(EX_OSERR, "ERROR: Cannot determine path of running kernel");
 617         args.pa_kernel = malloc(len + 1);
 618         if (sysctlbyname("kern.bootfile", args.pa_kernel, &len, NULL, 0) == -1)
 619                 err(EX_OSERR, "ERROR: Cannot determine path of running kernel");
 620
 621         /*
 622          * The initial CPU mask specifies the root mask of this process
 623          * which is usually all CPUs in the system.
 624          */
 625         if (cpuset_getaffinity(CPU_LEVEL_ROOT, CPU_WHICH_PID, -1,
 626             sizeof(rootmask), &rootmask) == -1)
 627                 err(EX_OSERR, "ERROR: Cannot determine the root set of CPUs");
 628         CPU_COPY(&rootmask, &cpumask);
 629
 630         while ((option = getopt(argc, argv,
 631             "CD:EF:G:M:NO:P:R:S:TWa:c:def:gk:l:m:n:o:p:qr:s:t:vw:z:")) != -1)
 632                 switch (option) {
 633                 case 'a':       /* Annotate + callgraph */
 634                         args.pa_flags |= FLAG_DO_ANNOTATE;
 635                         args.pa_plugin = PMCSTAT_PL_ANNOTATE_CG;
 636                         graphfilename  = optarg;
 637                         break;
 638
 639                 case 'C':       /* cumulative values */
 640                         use_cumulative_counts = !use_cumulative_counts;
 641                         args.pa_required |= FLAG_HAS_COUNTING_PMCS;
 642                         break;
 643
 644                 case 'c':       /* CPU */
 645                         if (optarg[0] == '*' && optarg[1] == '\0')
 646                                 CPU_COPY(&rootmask, &cpumask);
 647                         else
 648                                 pmcstat_get_cpumask(optarg, &cpumask);
 649
 650                         args.pa_flags    |= FLAGS_HAS_CPUMASK;
 651                         args.pa_required |= FLAG_HAS_SYSTEM_PMCS;
 652                         break;
 653
 654                 case 'D':
 655                         if (stat(optarg, &sb) < 0)
 656                                 err(EX_OSERR, "ERROR: Cannot stat \"%s\"",
 657                                     optarg);
 658                         if (!S_ISDIR(sb.st_mode))
 659                                 errx(EX_USAGE,
 660                                     "ERROR: \"%s\" is not a directory.",
 661                                     optarg);
 662                         args.pa_samplesdir = optarg;
 663                         args.pa_flags     |= FLAG_HAS_SAMPLESDIR;
 664                         args.pa_required  |= FLAG_DO_GPROF;
 665                         break;
 666
 667                 case 'd':       /* toggle descendents */
 668                         do_descendants = !do_descendants;
 669                         args.pa_required |= FLAG_HAS_PROCESS_PMCS;
 670                         break;
 671
 672                 case 'e':       /* wide gprof metrics */
 673                         args.pa_flags |= FLAG_DO_WIDE_GPROF_HC;
 674                         break;
 675
 676                 case 'F':       /* produce a system-wide calltree */
 677                         args.pa_flags |= FLAG_DO_CALLGRAPHS;
 678                         args.pa_plugin = PMCSTAT_PL_CALLTREE;
 679                         graphfilename = optarg;
 680                         break;
 681
 682                 case 'f':       /* plugins options */
 683                         if (args.pa_plugin == PMCSTAT_PL_NONE)
 684                                 err(EX_USAGE, "ERROR: Need -g/-G/-m/-T.");
 685                         pmcstat_pluginconfigure_log(optarg);
 686                         break;
 687
 688                 case 'G':       /* produce a system-wide callgraph */
 689                         args.pa_flags |= FLAG_DO_CALLGRAPHS;
 690                         args.pa_plugin = PMCSTAT_PL_CALLGRAPH;
 691                         graphfilename = optarg;
 692                         break;
 693
 694                 case 'g':       /* produce gprof compatible profiles */
 695                         args.pa_flags |= FLAG_DO_GPROF;
 696                         args.pa_pplugin = PMCSTAT_PL_CALLGRAPH;
 697                         args.pa_plugin  = PMCSTAT_PL_GPROF;
 698                         break;
 699
 700                 case 'k':       /* pathname to the kernel */
 701                         free(args.pa_kernel);
 702                         args.pa_kernel = strdup(optarg);
 703                         args.pa_required |= FLAG_DO_ANALYSIS;
 704                         args.pa_flags    |= FLAG_HAS_KERNELPATH;
 705                         break;
 706
 707                 case 'l':       /* time duration in seconds */
 708                         duration = strtod(optarg, &end);
 709                         if (*end != '\0' || duration <= 0)
 710                                 errx(EX_USAGE, "ERROR: Illegal duration time "
 711                                     "value \"%s\".", optarg);
 712                         args.pa_flags |= FLAG_HAS_DURATION;
 713                         args.pa_duration = duration;
 714                         break;
 715
 716                 case 'm':
 717                         args.pa_flags |= FLAG_DO_ANNOTATE;
 718                         args.pa_plugin = PMCSTAT_PL_ANNOTATE;
 719                         graphfilename  = optarg;
 720                         break;
 721
 722                 case 'E':       /* log process exit */
 723                         do_logprocexit = !do_logprocexit;
 724                         args.pa_required |= (FLAG_HAS_PROCESS_PMCS |
 725                             FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE);
 726                         break;
 727
 728                 case 'M':       /* mapfile */
 729                         args.pa_mapfilename = optarg;
 730                         break;
 731
 732                 case 'N':
 733                         do_callchain = !do_callchain;
 734                         args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
 735                         break;
 736
 737                 case 'p':       /* process virtual counting PMC */
 738                 case 's':       /* system-wide counting PMC */
 739                 case 'P':       /* process virtual sampling PMC */
 740                 case 'S':       /* system-wide sampling PMC */
 741                         if ((ev = malloc(sizeof(*ev))) == NULL)
 742                                 errx(EX_SOFTWARE, "ERROR: Out of memory.");
 743
 744                         switch (option) {
 745                         case 'p': ev->ev_mode = PMC_MODE_TC; break;
 746                         case 's': ev->ev_mode = PMC_MODE_SC; break;
 747                         case 'P': ev->ev_mode = PMC_MODE_TS; break;
 748                         case 'S': ev->ev_mode = PMC_MODE_SS; break;
 749                         }
 750
 751                         if (option == 'P' || option == 'p') {
 752                                 args.pa_flags |= FLAG_HAS_PROCESS_PMCS;
 753                                 args.pa_required |= (FLAG_HAS_COMMANDLINE |
 754                                     FLAG_HAS_TARGET);
 755                         }
 756
 757                         if (option == 'P' || option == 'S') {
 758                                 args.pa_flags |= FLAG_HAS_SAMPLING_PMCS;
 759                                 args.pa_required |= (FLAG_HAS_PIPE |
 760                                     FLAG_HAS_OUTPUT_LOGFILE);
 761                         }
 762
 763                         if (option == 'p' || option == 's')
 764                                 args.pa_flags |= FLAG_HAS_COUNTING_PMCS;
 765
 766                         if (option == 's' || option == 'S')
 767                                 args.pa_flags |= FLAG_HAS_SYSTEM_PMCS;
 768
 769                         ev->ev_spec  = strdup(optarg);
 770
 771                         if (option == 'S' || option == 'P')
 772                                 ev->ev_count = current_sampling_count;
 773                         else
 774                                 ev->ev_count = -1;
 775
 776                         if (option == 'S' || option == 's')
 777                                 ev->ev_cpu = CPU_FFS(&cpumask) - 1;
 778                         else
 779                                 ev->ev_cpu = PMC_CPU_ANY;
 780
 781                         ev->ev_flags = 0;
 782                         if (do_callchain)
 783                                 ev->ev_flags |= PMC_F_CALLCHAIN;
 784                         if (do_descendants)
 785                                 ev->ev_flags |= PMC_F_DESCENDANTS;
 786                         if (do_logprocexit)
 787                                 ev->ev_flags |= PMC_F_LOG_PROCEXIT;
 788                         if (do_logproccsw)
 789                                 ev->ev_flags |= PMC_F_LOG_PROCCSW;
 790
 791                         ev->ev_cumulative  = use_cumulative_counts;
 792
 793                         ev->ev_saved = 0LL;
 794                         ev->ev_pmcid = PMC_ID_INVALID;
 795
 796                         /* extract event name */
 797                         c = strcspn(optarg, ", \t");
 798                         ev->ev_name = malloc(c + 1);
 799                         (void) strncpy(ev->ev_name, optarg, c);
 800                         *(ev->ev_name + c) = '\0';
 801
 802                         STAILQ_INSERT_TAIL(&args.pa_events, ev, ev_next);
 803
 804                         if (option == 's' || option == 'S') {
 805                                 CPU_CLR(ev->ev_cpu, &cpumask);
 806                                 pmcstat_clone_event_descriptor(ev, &cpumask);
 807                                 CPU_SET(ev->ev_cpu, &cpumask);
 808                         }
 809
 810                         break;
 811
 812                 case 'n':       /* sampling count */
 813                         current_sampling_count = strtol(optarg, &end, 0);
 814                         if (*end != '\0' || current_sampling_count <= 0)
 815                                 errx(EX_USAGE,
 816                                     "ERROR: Illegal count value \"%s\".",
 817                                     optarg);
 818                         args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
 819                         break;
 820
 821                 case 'o':       /* outputfile */
 822                         if (args.pa_printfile != NULL &&
 823                             args.pa_printfile != stdout &&
 824                             args.pa_printfile != stderr)
 825                                 (void) fclose(args.pa_printfile);
 826                         if ((args.pa_printfile = fopen(optarg, "w")) == NULL)
 827                                 errx(EX_OSERR,
 828                                     "ERROR: cannot open \"%s\" for writing.",
 829                                     optarg);
 830                         args.pa_flags |= FLAG_DO_PRINT;
 831                         break;
 832
 833                 case 'O':       /* sampling output */
 834                         if (args.pa_outputpath)
 835                                 errx(EX_USAGE,
 836 "ERROR: option -O may only be specified once.");
 837                         args.pa_outputpath = optarg;
 838                         args.pa_flags |= FLAG_HAS_OUTPUT_LOGFILE;
 839                         break;
 840
 841                 case 'q':       /* quiet mode */
 842                         args.pa_verbosity = 0;
 843                         break;
 844
 845                 case 'r':       /* root FS path */
 846                         args.pa_fsroot = optarg;
 847                         break;
 848
 849                 case 'R':       /* read an existing log file */
 850                         if (args.pa_inputpath != NULL)
 851                                 errx(EX_USAGE,
 852 "ERROR: option -R may only be specified once.");
 853                         args.pa_inputpath = optarg;
 854                         if (args.pa_printfile == stderr)
 855                                 args.pa_printfile = stdout;
 856                         args.pa_flags |= FLAG_READ_LOGFILE;
 857                         break;
 858
 859                 case 't':       /* target pid or process name */
 860                         pmcstat_find_targets(optarg);
 861
 862                         args.pa_flags |= FLAG_HAS_TARGET;
 863                         args.pa_required |= FLAG_HAS_PROCESS_PMCS;
 864                         break;
 865
 866                 case 'T':       /* top mode */
 867                         args.pa_flags |= FLAG_DO_TOP;
 868                         args.pa_plugin = PMCSTAT_PL_CALLGRAPH;
 869                         args.pa_ctdumpinstr = 0;
 870                         args.pa_mergepmc = 1;
 871                         if (args.pa_printfile == stderr)
 872                                 args.pa_printfile = stdout;
 873                         break;
 874
 875                 case 'v':       /* verbose */
 876                         args.pa_verbosity++;
 877                         break;
 878
 879                 case 'w':       /* wait interval */
 880                         interval = strtod(optarg, &end);
 881                         if (*end != '\0' || interval <= 0)
 882                                 errx(EX_USAGE,
 883 "ERROR: Illegal wait interval value \"%s\".",
 884                                     optarg);
 885                         args.pa_flags |= FLAG_HAS_WAIT_INTERVAL;
 886                         args.pa_interval = interval;
 887                         break;
 888
 889                 case 'W':       /* toggle LOG_CSW */
 890                         do_logproccsw = !do_logproccsw;
 891                         args.pa_required |= (FLAG_HAS_PROCESS_PMCS |
 892                             FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE);
 893                         break;
 894
 895                 case 'z':
 896                         graphdepth = strtod(optarg, &end);
 897                         if (*end != '\0' || graphdepth <= 0)
 898                                 errx(EX_USAGE,
 899                                     "ERROR: Illegal callchain depth \"%s\".",
 900                                     optarg);
 901                         args.pa_graphdepth = graphdepth;
 902                         args.pa_required |= FLAG_DO_CALLGRAPHS;
 903                         break;
 904
 905                 case '?':
 906                 default:
 907                         pmcstat_show_usage();
 908                         break;
 909
 910                 }
 911
 912         args.pa_argc = (argc -= optind);
 913         args.pa_argv = (argv += optind);
 914
 915         /* If we read from logfile and no specified CPU mask use
 916          * the maximum CPU count.
 917          */
 918         if ((args.pa_flags & FLAG_READ_LOGFILE) &&
 919             (args.pa_flags & FLAGS_HAS_CPUMASK) == 0)
 920                 CPU_FILL(&cpumask);
 921
 922         args.pa_cpumask = cpumask; /* For selecting CPUs using -R. */
 923
 924         if (argc)       /* command line present */
 925                 args.pa_flags |= FLAG_HAS_COMMANDLINE;
 926
 927         if (args.pa_flags & (FLAG_DO_GPROF | FLAG_DO_CALLGRAPHS |
 928             FLAG_DO_ANNOTATE | FLAG_DO_TOP))
 929                 args.pa_flags |= FLAG_DO_ANALYSIS;
 930
 931         /*
 932          * Check invocation syntax.
 933          */
 934
 935         /* disallow -O and -R together */
 936         if (args.pa_outputpath && args.pa_inputpath)
 937                 errx(EX_USAGE,
 938                     "ERROR: options -O and -R are mutually exclusive.");
 939
 940         /* disallow -T and -l together */
 941         if ((args.pa_flags & FLAG_HAS_DURATION) &&
 942             (args.pa_flags & FLAG_DO_TOP))
 943                 errx(EX_USAGE, "ERROR: options -T and -l are mutually "
 944                     "exclusive.");
 945
 946         /* -a and -m require -R */
 947         if (args.pa_flags & FLAG_DO_ANNOTATE && args.pa_inputpath == NULL)
 948                 errx(EX_USAGE, "ERROR: option %s requires an input file",
 949                     args.pa_plugin == PMCSTAT_PL_ANNOTATE ? "-m" : "-a");
 950
 951         /* -m option is not allowed combined with -g or -G. */
 952         if (args.pa_flags & FLAG_DO_ANNOTATE &&
 953             args.pa_flags & (FLAG_DO_GPROF | FLAG_DO_CALLGRAPHS))
 954                 errx(EX_USAGE,
 955                     "ERROR: option -m and -g | -G are mutually exclusive");
 956
 957         if (args.pa_flags & FLAG_READ_LOGFILE) {
 958                 errmsg = NULL;
 959                 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
 960                         errmsg = "a command line specification";
 961                 else if (args.pa_flags & FLAG_HAS_TARGET)
 962                         errmsg = "option -t";
 963                 else if (!STAILQ_EMPTY(&args.pa_events))
 964                         errmsg = "a PMC event specification";
 965                 if (errmsg)
 966                         errx(EX_USAGE,
 967                             "ERROR: option -R may not be used with %s.",
 968                             errmsg);
 969         } else if (STAILQ_EMPTY(&args.pa_events))
 970                 /* All other uses require a PMC spec. */
 971                 pmcstat_show_usage();
 972
 973         /* check for -t pid without a process PMC spec */
 974         if ((args.pa_required & FLAG_HAS_TARGET) &&
 975             (args.pa_flags & FLAG_HAS_PROCESS_PMCS) == 0)
 976                 errx(EX_USAGE,
 977 "ERROR: option -t requires a process mode PMC to be specified."
 978                     );
 979
 980         /* check for process-mode options without a command or -t pid */
 981         if ((args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
 982             (args.pa_flags & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) == 0)
 983                 errx(EX_USAGE,
 984 "ERROR: options -d, -E, -p, -P, and -W require a command line or target process."
 985                     );
 986
 987         /* check for -p | -P without a target process of some sort */
 988         if ((args.pa_required & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) &&
 989             (args.pa_flags & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) == 0)
 990                 errx(EX_USAGE,
 991 "ERROR: options -P and -p require a target process or a command line."
 992                     );
 993
 994         /* check for process-mode options without a process-mode PMC */
 995         if ((args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
 996             (args.pa_flags & FLAG_HAS_PROCESS_PMCS) == 0)
 997                 errx(EX_USAGE,
 998 "ERROR: options -d, -E, and -W require a process mode PMC to be specified."
 999                     );
1000
1001         /* check for -c cpu with no system mode PMCs or logfile. */
1002         if ((args.pa_required & FLAG_HAS_SYSTEM_PMCS) &&
1003             (args.pa_flags & FLAG_HAS_SYSTEM_PMCS) == 0 &&
1004             (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1005                 errx(EX_USAGE,
1006 "ERROR: option -c requires at least one system mode PMC to be specified."
1007                     );
1008
1009         /* check for counting mode options without a counting PMC */
1010         if ((args.pa_required & FLAG_HAS_COUNTING_PMCS) &&
1011             (args.pa_flags & FLAG_HAS_COUNTING_PMCS) == 0)
1012                 errx(EX_USAGE,
1013 "ERROR: options -C, -W and -o require at least one counting mode PMC to be specified."
1014                     );
1015
1016         /* check for sampling mode options without a sampling PMC spec */
1017         if ((args.pa_required & FLAG_HAS_SAMPLING_PMCS) &&
1018             (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) == 0)
1019                 errx(EX_USAGE,
1020 "ERROR: options -N, -n and -O require at least one sampling mode PMC to be specified."
1021                     );
1022
1023         /* check if -g/-G/-m/-T are being used correctly */
1024         if ((args.pa_flags & FLAG_DO_ANALYSIS) &&
1025             !(args.pa_flags & (FLAG_HAS_SAMPLING_PMCS|FLAG_READ_LOGFILE)))
1026                 errx(EX_USAGE,
1027 "ERROR: options -g/-G/-m/-T require sampling PMCs or -R to be specified."
1028                     );
1029
1030         /* check if -e was specified without -g */
1031         if ((args.pa_flags & FLAG_DO_WIDE_GPROF_HC) &&
1032             !(args.pa_flags & FLAG_DO_GPROF))
1033                 errx(EX_USAGE,
1034 "ERROR: option -e requires gprof mode to be specified."
1035                     );
1036
1037         /* check if -O was spuriously specified */
1038         if ((args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE) &&
1039             (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0)
1040                 errx(EX_USAGE,
1041 "ERROR: option -O is used only with options -E, -P, -S and -W."
1042                     );
1043
1044         /* -k kernel path require -g/-G/-m/-T or -R */
1045         if ((args.pa_flags & FLAG_HAS_KERNELPATH) &&
1046             (args.pa_flags & FLAG_DO_ANALYSIS) == 0 &&
1047             (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1048             errx(EX_USAGE, "ERROR: option -k is only used with -g/-R/-m/-T.");
1049
1050         /* -D only applies to gprof output mode (-g) */
1051         if ((args.pa_flags & FLAG_HAS_SAMPLESDIR) &&
1052             (args.pa_flags & FLAG_DO_GPROF) == 0)
1053             errx(EX_USAGE, "ERROR: option -D is only used with -g.");
1054
1055         /* -M mapfile requires -g or -R */
1056         if (args.pa_mapfilename != NULL &&
1057             (args.pa_flags & FLAG_DO_GPROF) == 0 &&
1058             (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1059             errx(EX_USAGE, "ERROR: option -M is only used with -g/-R.");
1060
1061         /*
1062          * Disallow textual output of sampling PMCs if counting PMCs
1063          * have also been asked for, mostly because the combined output
1064          * is difficult to make sense of.
1065          */
1066         if ((args.pa_flags & FLAG_HAS_COUNTING_PMCS) &&
1067             (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) &&
1068             ((args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE) == 0))
1069                 errx(EX_USAGE,
1070 "ERROR: option -O is required if counting and sampling PMCs are specified together."
1071                     );
1072
1073         /*
1074          * Check if 'kerneldir' refers to a file rather than a
1075          * directory.  If so, use `dirname path` to determine the
1076          * kernel directory.
1077          */
1078         (void) snprintf(buffer, sizeof(buffer), "%s%s", args.pa_fsroot,
1079             args.pa_kernel);
1080         if (stat(buffer, &sb) < 0)
1081                 err(EX_OSERR, "ERROR: Cannot locate kernel \"%s\"",
1082                     buffer);
1083         if (!S_ISREG(sb.st_mode) && !S_ISDIR(sb.st_mode))
1084                 errx(EX_USAGE, "ERROR: \"%s\": Unsupported file type.",
1085                     buffer);
1086         if (!S_ISDIR(sb.st_mode)) {
1087                 tmp = args.pa_kernel;
1088                 args.pa_kernel = strdup(dirname(args.pa_kernel));
1089                 free(tmp);
1090                 (void) snprintf(buffer, sizeof(buffer), "%s%s",
1091                     args.pa_fsroot, args.pa_kernel);
1092                 if (stat(buffer, &sb) < 0)
1093                         err(EX_OSERR, "ERROR: Cannot stat \"%s\"",
1094                             buffer);
1095                 if (!S_ISDIR(sb.st_mode))
1096                         errx(EX_USAGE,
1097                             "ERROR: \"%s\" is not a directory.",
1098                             buffer);
1099         }
1100
1101         /*
1102          * If we have a callgraph be created, select the outputfile.
1103          */
1104         if (args.pa_flags & FLAG_DO_CALLGRAPHS) {
1105                 if (strcmp(graphfilename, "-") == 0)
1106                     args.pa_graphfile = args.pa_printfile;
1107                 else {
1108                         args.pa_graphfile = fopen(graphfilename, "w");
1109                         if (args.pa_graphfile == NULL)
1110                                 err(EX_OSERR,
1111                                     "ERROR: cannot open \"%s\" for writing",
1112                                     graphfilename);
1113                 }
1114         }
1115         if (args.pa_flags & FLAG_DO_ANNOTATE) {
1116                 args.pa_graphfile = fopen(graphfilename, "w");
1117                 if (args.pa_graphfile == NULL)
1118                         err(EX_OSERR, "ERROR: cannot open \"%s\" for writing",
1119                             graphfilename);
1120         }
1121
1122         /* if we've been asked to process a log file, skip init */
1123         if ((args.pa_flags & FLAG_READ_LOGFILE) == 0) {
1124                 if (pmc_init() < 0)
1125                         err(EX_UNAVAILABLE,
1126                             "ERROR: Initialization of the pmc(3) library failed"
1127                             );
1128
1129                 if ((npmc = pmc_npmc(0)) < 0) /* assume all CPUs are identical */
1130                         err(EX_OSERR,
1131 "ERROR: Cannot determine the number of PMCs on CPU %d",
1132                             0);
1133         }
1134
1135         /* Allocate a kqueue */
1136         if ((pmcstat_kq = kqueue()) < 0)
1137                 err(EX_OSERR, "ERROR: Cannot allocate kqueue");
1138
1139         /* Setup the logfile as the source. */
1140         if (args.pa_flags & FLAG_READ_LOGFILE) {
1141                 /*
1142                  * Print the log in textual form if we haven't been
1143                  * asked to generate profiling information.
1144                  */
1145                 if ((args.pa_flags & FLAG_DO_ANALYSIS) == 0)
1146                         args.pa_flags |= FLAG_DO_PRINT;
1147
1148                 pmcstat_initialize_logging();
1149                 rfd = pmcstat_open_log(args.pa_inputpath,
1150                     PMCSTAT_OPEN_FOR_READ);
1151                 if ((args.pa_logparser = pmclog_open(rfd)) == NULL)
1152                         err(EX_OSERR, "ERROR: Cannot create parser");
1153                 if (fcntl(rfd, F_SETFL, O_NONBLOCK) < 0)
1154                         err(EX_OSERR, "ERROR: fcntl(2) failed");
1155                 EV_SET(&kev, rfd, EVFILT_READ, EV_ADD,
1156                     0, 0, NULL);
1157                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1158                         err(EX_OSERR, "ERROR: Cannot register kevent");
1159         }
1160         /*
1161          * Configure the specified log file or setup a default log
1162          * consumer via a pipe.
1163          */
1164         if (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) {
1165                 if (args.pa_outputpath)
1166                         args.pa_logfd = pmcstat_open_log(args.pa_outputpath,
1167                             PMCSTAT_OPEN_FOR_WRITE);
1168                 else {
1169                         /*
1170                          * process the log on the fly by reading it in
1171                          * through a pipe.
1172                          */
1173                         if (pipe(pipefd) < 0)
1174                                 err(EX_OSERR, "ERROR: pipe(2) failed");
1175
1176                         if (fcntl(pipefd[READPIPEFD], F_SETFL, O_NONBLOCK) < 0)
1177                                 err(EX_OSERR, "ERROR: fcntl(2) failed");
1178
1179                         EV_SET(&kev, pipefd[READPIPEFD], EVFILT_READ, EV_ADD,
1180                             0, 0, NULL);
1181
1182                         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1183                                 err(EX_OSERR, "ERROR: Cannot register kevent");
1184
1185                         args.pa_logfd = pipefd[WRITEPIPEFD];
1186
1187                         args.pa_flags |= FLAG_HAS_PIPE;
1188                         if ((args.pa_flags & FLAG_DO_TOP) == 0)
1189                                 args.pa_flags |= FLAG_DO_PRINT;
1190                         args.pa_logparser = pmclog_open(pipefd[READPIPEFD]);
1191                 }
1192
1193                 if (pmc_configure_logfile(args.pa_logfd) < 0)
1194                         err(EX_OSERR, "ERROR: Cannot configure log file");
1195         }
1196
1197         /* remember to check for driver errors if we are sampling or logging */
1198         check_driver_stats = (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) ||
1199             (args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE);
1200
1201         /*
1202         if (args.pa_flags & FLAG_READ_LOGFILE) {
1203          * Allocate PMCs.
1204          */
1205
1206         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
1207                 if (pmc_allocate(ev->ev_spec, ev->ev_mode,
1208                     ev->ev_flags, ev->ev_cpu, &ev->ev_pmcid) < 0)
1209                         err(EX_OSERR,
1210 "ERROR: Cannot allocate %s-mode pmc with specification \"%s\"",
1211                             PMC_IS_SYSTEM_MODE(ev->ev_mode) ?
1212                             "system" : "process", ev->ev_spec);
1213
1214                 if (PMC_IS_SAMPLING_MODE(ev->ev_mode) &&
1215                     pmc_set(ev->ev_pmcid, ev->ev_count) < 0)
1216                         err(EX_OSERR,
1217                             "ERROR: Cannot set sampling count for PMC \"%s\"",
1218                             ev->ev_name);
1219         }
1220
1221         /* compute printout widths */
1222         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
1223                 int counter_width;
1224                 int display_width;
1225                 int header_width;
1226
1227                 (void) pmc_width(ev->ev_pmcid, &counter_width);
1228                 header_width = strlen(ev->ev_name) + 2; /* prefix '%c/' */
1229                 display_width = (int) floor(counter_width / 3.32193) + 1;
1230
1231                 if (PMC_IS_SYSTEM_MODE(ev->ev_mode))
1232                         header_width += 3; /* 2 digit CPU number + '/' */
1233
1234                 if (header_width > display_width) {
1235                         ev->ev_fieldskip = 0;
1236                         ev->ev_fieldwidth = header_width;
1237                 } else {
1238                         ev->ev_fieldskip = display_width -
1239                             header_width;
1240                         ev->ev_fieldwidth = display_width;
1241                 }
1242         }
1243
1244         /*
1245          * If our output is being set to a terminal, register a handler
1246          * for window size changes.
1247          */
1248
1249         if (isatty(fileno(args.pa_printfile))) {
1250
1251                 if (ioctl(fileno(args.pa_printfile), TIOCGWINSZ, &ws) < 0)
1252                         err(EX_OSERR, "ERROR: Cannot determine window size");
1253
1254                 pmcstat_displayheight = ws.ws_row - 1;
1255                 pmcstat_displaywidth  = ws.ws_col - 1;
1256
1257                 EV_SET(&kev, SIGWINCH, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1258
1259                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1260                         err(EX_OSERR,
1261                             "ERROR: Cannot register kevent for SIGWINCH");
1262
1263                 args.pa_toptty = 1;
1264         }
1265
1266         /*
1267          * Listen to key input in top mode.
1268          */
1269         if (args.pa_flags & FLAG_DO_TOP) {
1270                 EV_SET(&kev, fileno(stdin), EVFILT_READ, EV_ADD, 0, 0, NULL);
1271                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1272                         err(EX_OSERR, "ERROR: Cannot register kevent");
1273         }
1274
1275         EV_SET(&kev, SIGINT, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1276         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1277                 err(EX_OSERR, "ERROR: Cannot register kevent for SIGINT");
1278
1279         EV_SET(&kev, SIGIO, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1280         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1281                 err(EX_OSERR, "ERROR: Cannot register kevent for SIGIO");
1282
1283         /*
1284          * An exec() failure of a forked child is signalled by the
1285          * child sending the parent a SIGCHLD.  We don't register an
1286          * actual signal handler for SIGCHLD, but instead use our
1287          * kqueue to pick up the signal.
1288          */
1289         EV_SET(&kev, SIGCHLD, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1290         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1291                 err(EX_OSERR, "ERROR: Cannot register kevent for SIGCHLD");
1292
1293         /*
1294          * Setup a timer if we have counting mode PMCs needing to be printed or
1295          * top mode plugin is active.
1296          */
1297         if (((args.pa_flags & FLAG_HAS_COUNTING_PMCS) &&
1298              (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0) ||
1299             (args.pa_flags & FLAG_DO_TOP)) {
1300                 EV_SET(&kev, 0, EVFILT_TIMER, EV_ADD, 0,
1301                     args.pa_interval * 1000, NULL);
1302
1303                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1304                         err(EX_OSERR,
1305                             "ERROR: Cannot register kevent for timer");
1306         }
1307
1308         /*
1309          * Setup a duration timer if we have sampling mode PMCs and
1310          * a duration time is set
1311          */
1312         if ((args.pa_flags & FLAG_HAS_SAMPLING_PMCS) &&
1313             (args.pa_flags & FLAG_HAS_DURATION)) {
1314                 EV_SET(&kev, 0, EVFILT_TIMER, EV_ADD, 0,
1315                     args.pa_duration * 1000, NULL);
1316
1317                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1318                         err(EX_OSERR, "ERROR: Cannot register kevent for "
1319                             "time duration");
1320         }
1321
1322         /* attach PMCs to the target process, starting it if specified */
1323         if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1324                 pmcstat_create_process();
1325
1326         if (check_driver_stats && pmc_get_driver_stats(&ds_start) < 0)
1327                 err(EX_OSERR, "ERROR: Cannot retrieve driver statistics");
1328
1329         /* Attach process pmcs to the target process. */
1330         if (args.pa_flags & (FLAG_HAS_TARGET | FLAG_HAS_COMMANDLINE)) {
1331                 if (SLIST_EMPTY(&args.pa_targets))
1332                         errx(EX_DATAERR,
1333                             "ERROR: No matching target processes.");
1334                 if (args.pa_flags & FLAG_HAS_PROCESS_PMCS)
1335                         pmcstat_attach_pmcs();
1336
1337                 if (pmcstat_kvm) {
1338                         kvm_close(pmcstat_kvm);
1339                         pmcstat_kvm = NULL;
1340                 }
1341         }
1342
1343         /* start the pmcs */
1344         pmcstat_start_pmcs();
1345
1346         /* start the (commandline) process if needed */
1347         if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1348                 pmcstat_start_process();
1349
1350         /* initialize logging */
1351         pmcstat_initialize_logging();
1352
1353         /* Handle SIGINT using the kqueue loop */
1354         sa.sa_handler = SIG_IGN;
1355         sa.sa_flags   = 0;
1356         (void) sigemptyset(&sa.sa_mask);
1357
1358         if (sigaction(SIGINT, &sa, NULL) < 0)
1359                 err(EX_OSERR, "ERROR: Cannot install signal handler");
1360
1361         /*
1362          * Setup the top mode display.
1363          */
1364         if (args.pa_flags & FLAG_DO_TOP) {
1365                 args.pa_flags &= ~FLAG_DO_PRINT;
1366
1367                 if (args.pa_toptty) {
1368                         /*
1369                          * Init ncurses.
1370                          */
1371                         initscr();
1372                         if(has_colors() == TRUE) {
1373                                 args.pa_topcolor = 1;
1374                                 start_color();
1375                                 use_default_colors();
1376                                 pair_content(0, &cf, &cb);
1377                                 init_pair(1, COLOR_RED, cb);
1378                                 init_pair(2, COLOR_YELLOW, cb);
1379                                 init_pair(3, COLOR_GREEN, cb);
1380                         }
1381                         cbreak();
1382                         noecho();
1383                         nonl();
1384                         nodelay(stdscr, 1);
1385                         intrflush(stdscr, FALSE);
1386                         keypad(stdscr, TRUE);
1387                         clear();
1388                         /* Get terminal width / height with ncurses. */
1389                         getmaxyx(stdscr,
1390                             pmcstat_displayheight, pmcstat_displaywidth);
1391                         pmcstat_displayheight--; pmcstat_displaywidth--;
1392                         atexit(pmcstat_topexit);
1393                 }
1394         }
1395
1396         /*
1397          * loop till either the target process (if any) exits, or we
1398          * are killed by a SIGINT or we reached the time duration.
1399          */
1400         runstate = PMCSTAT_RUNNING;
1401         do_print = do_read = 0;
1402         do {
1403                 if ((c = kevent(pmcstat_kq, NULL, 0, &kev, 1, NULL)) <= 0) {
1404                         if (errno != EINTR)
1405                                 err(EX_OSERR, "ERROR: kevent failed");
1406                         else
1407                                 continue;
1408                 }
1409
1410                 if (kev.flags & EV_ERROR)
1411                         errc(EX_OSERR, kev.data, "ERROR: kevent failed");
1412
1413                 switch (kev.filter) {
1414                 case EVFILT_PROC:  /* target has exited */
1415                         runstate = pmcstat_close_log();
1416                         do_print = 1;
1417                         break;
1418
1419                 case EVFILT_READ:  /* log file data is present */
1420                         if (kev.ident == (unsigned)fileno(stdin) &&
1421                             (args.pa_flags & FLAG_DO_TOP)) {
1422                                 if (pmcstat_keypress_log())
1423                                         runstate = pmcstat_close_log();
1424                         } else {
1425                                 do_read = 0;
1426                                 runstate = pmcstat_process_log();
1427                         }
1428                         break;
1429
1430                 case EVFILT_SIGNAL:
1431                         if (kev.ident == SIGCHLD) {
1432                                 /*
1433                                  * The child process sends us a
1434                                  * SIGCHLD if its exec() failed.  We
1435                                  * wait for it to exit and then exit
1436                                  * ourselves.
1437                                  */
1438                                 (void) wait(&c);
1439                                 runstate = PMCSTAT_FINISHED;
1440                         } else if (kev.ident == SIGIO) {
1441                                 /*
1442                                  * We get a SIGIO if a PMC loses all
1443                                  * of its targets, or if logfile
1444                                  * writes encounter an error.
1445                                  */
1446                                 runstate = pmcstat_close_log();
1447                                 do_print = 1; /* print PMCs at exit */
1448                         } else if (kev.ident == SIGINT) {
1449                                 /* Kill the child process if we started it */
1450                                 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1451                                         pmcstat_kill_process();
1452                                 runstate = pmcstat_close_log();
1453                         } else if (kev.ident == SIGWINCH) {
1454                                 if (ioctl(fileno(args.pa_printfile),
1455                                         TIOCGWINSZ, &ws) < 0)
1456                                     err(EX_OSERR,
1457                                         "ERROR: Cannot determine window size");
1458                                 pmcstat_displayheight = ws.ws_row - 1;
1459                                 pmcstat_displaywidth  = ws.ws_col - 1;
1460                         } else
1461                                 assert(0);
1462
1463                         break;
1464
1465                 case EVFILT_TIMER:
1466                         /* time duration reached, exit */
1467                         if (args.pa_flags & FLAG_HAS_DURATION) {
1468                                 runstate = PMCSTAT_FINISHED;
1469                                 break;
1470                         }
1471                         /* print out counting PMCs */
1472                         if ((args.pa_flags & FLAG_DO_TOP) &&
1473                              pmc_flush_logfile() == 0)
1474                                 do_read = 1;
1475                         do_print = 1;
1476                         break;
1477
1478                 }
1479
1480                 if (do_print && !do_read) {
1481                         if ((args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0) {
1482                                 pmcstat_print_pmcs();
1483                                 if (runstate == PMCSTAT_FINISHED &&
1484                                     /* final newline */
1485                                     (args.pa_flags & FLAG_DO_PRINT) == 0)
1486                                         (void) fprintf(args.pa_printfile, "\n");
1487                         }
1488                         if (args.pa_flags & FLAG_DO_TOP)
1489                                 pmcstat_display_log();
1490                         do_print = 0;
1491                 }
1492
1493         } while (runstate != PMCSTAT_FINISHED);
1494
1495         if ((args.pa_flags & FLAG_DO_TOP) && args.pa_toptty) {
1496                 pmcstat_topexit();
1497                 args.pa_toptty = 0;
1498         }
1499
1500         /* flush any pending log entries */
1501         if (args.pa_flags & (FLAG_HAS_OUTPUT_LOGFILE | FLAG_HAS_PIPE))
1502                 pmc_close_logfile();
1503
1504         pmcstat_cleanup();
1505
1506         free(args.pa_kernel);
1507
1508         /* check if the driver lost any samples or events */
1509         if (check_driver_stats) {
1510                 if (pmc_get_driver_stats(&ds_end) < 0)
1511                         err(EX_OSERR,
1512                             "ERROR: Cannot retrieve driver statistics");
1513                 if (ds_start.pm_intr_bufferfull != ds_end.pm_intr_bufferfull &&
1514                     args.pa_verbosity > 0)
1515                         warnx(
1516 "WARNING: sampling was paused at least %u time%s.\n"
1517 "Please consider tuning the \"kern.hwpmc.nsamples\" tunable.",
1518                             ds_end.pm_intr_bufferfull -
1519                             ds_start.pm_intr_bufferfull,
1520                             ((ds_end.pm_intr_bufferfull -
1521                             ds_start.pm_intr_bufferfull) != 1) ? "s" : ""
1522                             );
1523                 if (ds_start.pm_buffer_requests_failed !=
1524                     ds_end.pm_buffer_requests_failed &&
1525                     args.pa_verbosity > 0)
1526                         warnx(
1527 "WARNING: at least %u event%s were discarded while running.\n"
1528 "Please consider tuning the \"kern.hwpmc.nbuffers\" tunable.",
1529                             ds_end.pm_buffer_requests_failed -
1530                             ds_start.pm_buffer_requests_failed,
1531                             ((ds_end.pm_buffer_requests_failed -
1532                             ds_start.pm_buffer_requests_failed) != 1) ? "s" : ""
1533                             );
1534         }
1535
1536         exit(EX_OK);
1537 }