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