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 -f spec\t pass \"spec\" to as plugin option\n"
 510             "\t -g\t\t produce gprof(1) compatible profiles\n"
 511             "\t -k dir\t\t set the path to the kernel\n"
 512             "\t -l secs\t set duration time\n"
 513             "\t -m file\t print sampled PCs to \"file\"\n"
 514             "\t -n rate\t set sampling rate\n"
 515             "\t -o file\t send print output to \"file\"\n"
 516             "\t -p spec\t allocate a process-private counting PMC\n"
 517             "\t -q\t\t suppress verbosity\n"
 518             "\t -r fsroot\t specify FS root directory\n"
 519             "\t -s spec\t allocate a system-wide counting PMC\n"
 520             "\t -t process-spec attach to running processes matching "
 521                 "\"process-spec\"\n"
 522             "\t -v\t\t increase verbosity\n"
 523             "\t -w secs\t set printing time interval\n"
 524             "\t -z depth\t limit callchain display depth"
 525         );
 526 }
 527
 528 /*
 529  * At exit handler for top mode
 530  */
 531
 532 void
 533 pmcstat_topexit(void)
 534 {
 535         if (!args.pa_toptty)
 536                 return;
 537
 538         /*
 539          * Shutdown ncurses.
 540          */
 541         clrtoeol();
 542         refresh();
 543         endwin();
 544 }
 545
 546 /*
 547  * Main
 548  */
 549
 550 int
 551 main(int argc, char **argv)
 552 {
 553         cpuset_t cpumask, rootmask;
 554         double interval;
 555         double duration;
 556         int option, npmc;
 557         int c, check_driver_stats, current_sampling_count;
 558         int do_callchain, do_descendants, do_logproccsw, do_logprocexit;
 559         int do_print, do_read;
 560         size_t len;
 561         int graphdepth;
 562         int pipefd[2], rfd;
 563         int use_cumulative_counts;
 564         short cf, cb;
 565         char *end, *tmp;
 566         const char *errmsg, *graphfilename;
 567         enum pmcstat_state runstate;
 568         struct pmc_driverstats ds_start, ds_end;
 569         struct pmcstat_ev *ev;
 570         struct sigaction sa;
 571         struct kevent kev;
 572         struct winsize ws;
 573         struct stat sb;
 574         char buffer[PATH_MAX];
 575
 576         check_driver_stats      = 0;
 577         current_sampling_count  = DEFAULT_SAMPLE_COUNT;
 578         do_callchain            = 1;
 579         do_descendants          = 0;
 580         do_logproccsw           = 0;
 581         do_logprocexit          = 0;
 582         use_cumulative_counts   = 0;
 583         graphfilename           = "-";
 584         args.pa_required        = 0;
 585         args.pa_flags           = 0;
 586         args.pa_verbosity       = 1;
 587         args.pa_logfd           = -1;
 588         args.pa_fsroot          = "";
 589         args.pa_samplesdir      = ".";
 590         args.pa_printfile       = stderr;
 591         args.pa_graphdepth      = DEFAULT_CALLGRAPH_DEPTH;
 592         args.pa_graphfile       = NULL;
 593         args.pa_interval        = DEFAULT_WAIT_INTERVAL;
 594         args.pa_mapfilename     = NULL;
 595         args.pa_inputpath       = NULL;
 596         args.pa_outputpath      = NULL;
 597         args.pa_pplugin         = PMCSTAT_PL_NONE;
 598         args.pa_plugin          = PMCSTAT_PL_NONE;
 599         args.pa_ctdumpinstr     = 1;
 600         args.pa_topmode         = PMCSTAT_TOP_DELTA;
 601         args.pa_toptty          = 0;
 602         args.pa_topcolor        = 0;
 603         args.pa_mergepmc        = 0;
 604         args.pa_duration        = 0.0;
 605         STAILQ_INIT(&args.pa_events);
 606         SLIST_INIT(&args.pa_targets);
 607         bzero(&ds_start, sizeof(ds_start));
 608         bzero(&ds_end, sizeof(ds_end));
 609         ev = NULL;
 610         CPU_ZERO(&cpumask);
 611
 612         /* Default to using the running system kernel. */
 613         len = 0;
 614         if (sysctlbyname("kern.bootfile", NULL, &len, NULL, 0) == -1)
 615                 err(EX_OSERR, "ERROR: Cannot determine path of running kernel");
 616         args.pa_kernel = malloc(len + 1);
 617         if (sysctlbyname("kern.bootfile", args.pa_kernel, &len, NULL, 0) == -1)
 618                 err(EX_OSERR, "ERROR: Cannot determine path of running kernel");
 619
 620         /*
 621          * The initial CPU mask specifies the root mask of this process
 622          * which is usually all CPUs in the system.
 623          */
 624         if (cpuset_getaffinity(CPU_LEVEL_ROOT, CPU_WHICH_PID, -1,
 625             sizeof(rootmask), &rootmask) == -1)
 626                 err(EX_OSERR, "ERROR: Cannot determine the root set of CPUs");
 627         CPU_COPY(&rootmask, &cpumask);
 628
 629         while ((option = getopt(argc, argv,
 630             "CD:EF:G:M:NO:P:R:S:TWa:c:df:gk:l:m:n:o:p:qr:s:t:vw:z:")) != -1)
 631                 switch (option) {
 632                 case 'a':       /* Annotate + callgraph */
 633                         args.pa_flags |= FLAG_DO_ANNOTATE;
 634                         args.pa_plugin = PMCSTAT_PL_ANNOTATE_CG;
 635                         graphfilename  = optarg;
 636                         break;
 637
 638                 case 'C':       /* cumulative values */
 639                         use_cumulative_counts = !use_cumulative_counts;
 640                         args.pa_required |= FLAG_HAS_COUNTING_PMCS;
 641                         break;
 642
 643                 case 'c':       /* CPU */
 644                         if (optarg[0] == '*' && optarg[1] == '\0')
 645                                 CPU_COPY(&rootmask, &cpumask);
 646                         else
 647                                 pmcstat_get_cpumask(optarg, &cpumask);
 648
 649                         args.pa_flags    |= FLAGS_HAS_CPUMASK;
 650                         args.pa_required |= FLAG_HAS_SYSTEM_PMCS;
 651                         break;
 652
 653                 case 'D':
 654                         if (stat(optarg, &sb) < 0)
 655                                 err(EX_OSERR, "ERROR: Cannot stat \"%s\"",
 656                                     optarg);
 657                         if (!S_ISDIR(sb.st_mode))
 658                                 errx(EX_USAGE,
 659                                     "ERROR: \"%s\" is not a directory.",
 660                                     optarg);
 661                         args.pa_samplesdir = optarg;
 662                         args.pa_flags     |= FLAG_HAS_SAMPLESDIR;
 663                         args.pa_required  |= FLAG_DO_GPROF;
 664                         break;
 665
 666                 case 'd':       /* toggle descendents */
 667                         do_descendants = !do_descendants;
 668                         args.pa_required |= FLAG_HAS_PROCESS_PMCS;
 669                         break;
 670
 671                 case 'F':       /* produce a system-wide calltree */
 672                         args.pa_flags |= FLAG_DO_CALLGRAPHS;
 673                         args.pa_plugin = PMCSTAT_PL_CALLTREE;
 674                         graphfilename = optarg;
 675                         break;
 676
 677                 case 'f':       /* plugins options */
 678                         if (args.pa_plugin == PMCSTAT_PL_NONE)
 679                                 err(EX_USAGE, "ERROR: Need -g/-G/-m/-T.");
 680                         pmcstat_pluginconfigure_log(optarg);
 681                         break;
 682
 683                 case 'G':       /* produce a system-wide callgraph */
 684                         args.pa_flags |= FLAG_DO_CALLGRAPHS;
 685                         args.pa_plugin = PMCSTAT_PL_CALLGRAPH;
 686                         graphfilename = optarg;
 687                         break;
 688
 689                 case 'g':       /* produce gprof compatible profiles */
 690                         args.pa_flags |= FLAG_DO_GPROF;
 691                         args.pa_pplugin = PMCSTAT_PL_CALLGRAPH;
 692                         args.pa_plugin  = PMCSTAT_PL_GPROF;
 693                         break;
 694
 695                 case 'k':       /* pathname to the kernel */
 696                         free(args.pa_kernel);
 697                         args.pa_kernel = strdup(optarg);
 698                         args.pa_required |= FLAG_DO_ANALYSIS;
 699                         args.pa_flags    |= FLAG_HAS_KERNELPATH;
 700                         break;
 701
 702                 case 'l':       /* time duration in seconds */
 703                         duration = strtod(optarg, &end);
 704                         if (*end != '\0' || duration <= 0)
 705                                 errx(EX_USAGE, "ERROR: Illegal duration time "
 706                                     "value \"%s\".", optarg);
 707                         args.pa_flags |= FLAG_HAS_DURATION;
 708                         args.pa_duration = duration;
 709                         break;
 710
 711                 case 'm':
 712                         args.pa_flags |= FLAG_DO_ANNOTATE;
 713                         args.pa_plugin = PMCSTAT_PL_ANNOTATE;
 714                         graphfilename  = optarg;
 715                         break;
 716
 717                 case 'E':       /* log process exit */
 718                         do_logprocexit = !do_logprocexit;
 719                         args.pa_required |= (FLAG_HAS_PROCESS_PMCS |
 720                             FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE);
 721                         break;
 722
 723                 case 'M':       /* mapfile */
 724                         args.pa_mapfilename = optarg;
 725                         break;
 726
 727                 case 'N':
 728                         do_callchain = !do_callchain;
 729                         args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
 730                         break;
 731
 732                 case 'p':       /* process virtual counting PMC */
 733                 case 's':       /* system-wide counting PMC */
 734                 case 'P':       /* process virtual sampling PMC */
 735                 case 'S':       /* system-wide sampling PMC */
 736                         if ((ev = malloc(sizeof(*ev))) == NULL)
 737                                 errx(EX_SOFTWARE, "ERROR: Out of memory.");
 738
 739                         switch (option) {
 740                         case 'p': ev->ev_mode = PMC_MODE_TC; break;
 741                         case 's': ev->ev_mode = PMC_MODE_SC; break;
 742                         case 'P': ev->ev_mode = PMC_MODE_TS; break;
 743                         case 'S': ev->ev_mode = PMC_MODE_SS; break;
 744                         }
 745
 746                         if (option == 'P' || option == 'p') {
 747                                 args.pa_flags |= FLAG_HAS_PROCESS_PMCS;
 748                                 args.pa_required |= (FLAG_HAS_COMMANDLINE |
 749                                     FLAG_HAS_TARGET);
 750                         }
 751
 752                         if (option == 'P' || option == 'S') {
 753                                 args.pa_flags |= FLAG_HAS_SAMPLING_PMCS;
 754                                 args.pa_required |= (FLAG_HAS_PIPE |
 755                                     FLAG_HAS_OUTPUT_LOGFILE);
 756                         }
 757
 758                         if (option == 'p' || option == 's')
 759                                 args.pa_flags |= FLAG_HAS_COUNTING_PMCS;
 760
 761                         if (option == 's' || option == 'S')
 762                                 args.pa_flags |= FLAG_HAS_SYSTEM_PMCS;
 763
 764                         ev->ev_spec  = strdup(optarg);
 765
 766                         if (option == 'S' || option == 'P')
 767                                 ev->ev_count = current_sampling_count;
 768                         else
 769                                 ev->ev_count = -1;
 770
 771                         if (option == 'S' || option == 's')
 772                                 ev->ev_cpu = CPU_FFS(&cpumask) - 1;
 773                         else
 774                                 ev->ev_cpu = PMC_CPU_ANY;
 775
 776                         ev->ev_flags = 0;
 777                         if (do_callchain)
 778                                 ev->ev_flags |= PMC_F_CALLCHAIN;
 779                         if (do_descendants)
 780                                 ev->ev_flags |= PMC_F_DESCENDANTS;
 781                         if (do_logprocexit)
 782                                 ev->ev_flags |= PMC_F_LOG_PROCEXIT;
 783                         if (do_logproccsw)
 784                                 ev->ev_flags |= PMC_F_LOG_PROCCSW;
 785
 786                         ev->ev_cumulative  = use_cumulative_counts;
 787
 788                         ev->ev_saved = 0LL;
 789                         ev->ev_pmcid = PMC_ID_INVALID;
 790
 791                         /* extract event name */
 792                         c = strcspn(optarg, ", \t");
 793                         ev->ev_name = malloc(c + 1);
 794                         (void) strncpy(ev->ev_name, optarg, c);
 795                         *(ev->ev_name + c) = '\0';
 796
 797                         STAILQ_INSERT_TAIL(&args.pa_events, ev, ev_next);
 798
 799                         if (option == 's' || option == 'S') {
 800                                 CPU_CLR(ev->ev_cpu, &cpumask);
 801                                 pmcstat_clone_event_descriptor(ev, &cpumask);
 802                                 CPU_SET(ev->ev_cpu, &cpumask);
 803                         }
 804
 805                         break;
 806
 807                 case 'n':       /* sampling count */
 808                         current_sampling_count = strtol(optarg, &end, 0);
 809                         if (*end != '\0' || current_sampling_count <= 0)
 810                                 errx(EX_USAGE,
 811                                     "ERROR: Illegal count value \"%s\".",
 812                                     optarg);
 813                         args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
 814                         break;
 815
 816                 case 'o':       /* outputfile */
 817                         if (args.pa_printfile != NULL &&
 818                             args.pa_printfile != stdout &&
 819                             args.pa_printfile != stderr)
 820                                 (void) fclose(args.pa_printfile);
 821                         if ((args.pa_printfile = fopen(optarg, "w")) == NULL)
 822                                 errx(EX_OSERR,
 823                                     "ERROR: cannot open \"%s\" for writing.",
 824                                     optarg);
 825                         args.pa_flags |= FLAG_DO_PRINT;
 826                         break;
 827
 828                 case 'O':       /* sampling output */
 829                         if (args.pa_outputpath)
 830                                 errx(EX_USAGE,
 831 "ERROR: option -O may only be specified once.");
 832                         args.pa_outputpath = optarg;
 833                         args.pa_flags |= FLAG_HAS_OUTPUT_LOGFILE;
 834                         break;
 835
 836                 case 'q':       /* quiet mode */
 837                         args.pa_verbosity = 0;
 838                         break;
 839
 840                 case 'r':       /* root FS path */
 841                         args.pa_fsroot = optarg;
 842                         break;
 843
 844                 case 'R':       /* read an existing log file */
 845                         if (args.pa_inputpath != NULL)
 846                                 errx(EX_USAGE,
 847 "ERROR: option -R may only be specified once.");
 848                         args.pa_inputpath = optarg;
 849                         if (args.pa_printfile == stderr)
 850                                 args.pa_printfile = stdout;
 851                         args.pa_flags |= FLAG_READ_LOGFILE;
 852                         break;
 853
 854                 case 't':       /* target pid or process name */
 855                         pmcstat_find_targets(optarg);
 856
 857                         args.pa_flags |= FLAG_HAS_TARGET;
 858                         args.pa_required |= FLAG_HAS_PROCESS_PMCS;
 859                         break;
 860
 861                 case 'T':       /* top mode */
 862                         args.pa_flags |= FLAG_DO_TOP;
 863                         args.pa_plugin = PMCSTAT_PL_CALLGRAPH;
 864                         args.pa_ctdumpinstr = 0;
 865                         args.pa_mergepmc = 1;
 866                         if (args.pa_printfile == stderr)
 867                                 args.pa_printfile = stdout;
 868                         break;
 869
 870                 case 'v':       /* verbose */
 871                         args.pa_verbosity++;
 872                         break;
 873
 874                 case 'w':       /* wait interval */
 875                         interval = strtod(optarg, &end);
 876                         if (*end != '\0' || interval <= 0)
 877                                 errx(EX_USAGE,
 878 "ERROR: Illegal wait interval value \"%s\".",
 879                                     optarg);
 880                         args.pa_flags |= FLAG_HAS_WAIT_INTERVAL;
 881                         args.pa_interval = interval;
 882                         break;
 883
 884                 case 'W':       /* toggle LOG_CSW */
 885                         do_logproccsw = !do_logproccsw;
 886                         args.pa_required |= (FLAG_HAS_PROCESS_PMCS |
 887                             FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE);
 888                         break;
 889
 890                 case 'z':
 891                         graphdepth = strtod(optarg, &end);
 892                         if (*end != '\0' || graphdepth <= 0)
 893                                 errx(EX_USAGE,
 894                                     "ERROR: Illegal callchain depth \"%s\".",
 895                                     optarg);
 896                         args.pa_graphdepth = graphdepth;
 897                         args.pa_required |= FLAG_DO_CALLGRAPHS;
 898                         break;
 899
 900                 case '?':
 901                 default:
 902                         pmcstat_show_usage();
 903                         break;
 904
 905                 }
 906
 907         args.pa_argc = (argc -= optind);
 908         args.pa_argv = (argv += optind);
 909
 910         /* If we read from logfile and no specified CPU mask use
 911          * the maximum CPU count.
 912          */
 913         if ((args.pa_flags & FLAG_READ_LOGFILE) &&
 914             (args.pa_flags & FLAGS_HAS_CPUMASK) == 0)
 915                 CPU_FILL(&cpumask);
 916
 917         args.pa_cpumask = cpumask; /* For selecting CPUs using -R. */
 918
 919         if (argc)       /* command line present */
 920                 args.pa_flags |= FLAG_HAS_COMMANDLINE;
 921
 922         if (args.pa_flags & (FLAG_DO_GPROF | FLAG_DO_CALLGRAPHS |
 923             FLAG_DO_ANNOTATE | FLAG_DO_TOP))
 924                 args.pa_flags |= FLAG_DO_ANALYSIS;
 925
 926         /*
 927          * Check invocation syntax.
 928          */
 929
 930         /* disallow -O and -R together */
 931         if (args.pa_outputpath && args.pa_inputpath)
 932                 errx(EX_USAGE,
 933                     "ERROR: options -O and -R are mutually exclusive.");
 934
 935         /* disallow -T and -l together */
 936         if ((args.pa_flags & FLAG_HAS_DURATION) &&
 937             (args.pa_flags & FLAG_DO_TOP))
 938                 errx(EX_USAGE, "ERROR: options -T and -l are mutually "
 939                     "exclusive.");
 940
 941         /* -a and -m require -R */
 942         if (args.pa_flags & FLAG_DO_ANNOTATE && args.pa_inputpath == NULL)
 943                 errx(EX_USAGE, "ERROR: option %s requires an input file",
 944                     args.pa_plugin == PMCSTAT_PL_ANNOTATE ? "-m" : "-a");
 945
 946         /* -m option is not allowed combined with -g or -G. */
 947         if (args.pa_flags & FLAG_DO_ANNOTATE &&
 948             args.pa_flags & (FLAG_DO_GPROF | FLAG_DO_CALLGRAPHS))
 949                 errx(EX_USAGE,
 950                     "ERROR: option -m and -g | -G are mutually exclusive");
 951
 952         if (args.pa_flags & FLAG_READ_LOGFILE) {
 953                 errmsg = NULL;
 954                 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
 955                         errmsg = "a command line specification";
 956                 else if (args.pa_flags & FLAG_HAS_TARGET)
 957                         errmsg = "option -t";
 958                 else if (!STAILQ_EMPTY(&args.pa_events))
 959                         errmsg = "a PMC event specification";
 960                 if (errmsg)
 961                         errx(EX_USAGE,
 962                             "ERROR: option -R may not be used with %s.",
 963                             errmsg);
 964         } else if (STAILQ_EMPTY(&args.pa_events))
 965                 /* All other uses require a PMC spec. */
 966                 pmcstat_show_usage();
 967
 968         /* check for -t pid without a process PMC spec */
 969         if ((args.pa_required & FLAG_HAS_TARGET) &&
 970             (args.pa_flags & FLAG_HAS_PROCESS_PMCS) == 0)
 971                 errx(EX_USAGE,
 972 "ERROR: option -t requires a process mode PMC to be specified."
 973                     );
 974
 975         /* check for process-mode options without a command or -t pid */
 976         if ((args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
 977             (args.pa_flags & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) == 0)
 978                 errx(EX_USAGE,
 979 "ERROR: options -d, -E, -p, -P, and -W require a command line or target process."
 980                     );
 981
 982         /* check for -p | -P without a target process of some sort */
 983         if ((args.pa_required & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) &&
 984             (args.pa_flags & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) == 0)
 985                 errx(EX_USAGE,
 986 "ERROR: options -P and -p require a target process or a command line."
 987                     );
 988
 989         /* check for process-mode options without a process-mode PMC */
 990         if ((args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
 991             (args.pa_flags & FLAG_HAS_PROCESS_PMCS) == 0)
 992                 errx(EX_USAGE,
 993 "ERROR: options -d, -E, and -W require a process mode PMC to be specified."
 994                     );
 995
 996         /* check for -c cpu with no system mode PMCs or logfile. */
 997         if ((args.pa_required & FLAG_HAS_SYSTEM_PMCS) &&
 998             (args.pa_flags & FLAG_HAS_SYSTEM_PMCS) == 0 &&
 999             (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1000                 errx(EX_USAGE,
1001 "ERROR: option -c requires at least one system mode PMC to be specified."
1002                     );
1003
1004         /* check for counting mode options without a counting PMC */
1005         if ((args.pa_required & FLAG_HAS_COUNTING_PMCS) &&
1006             (args.pa_flags & FLAG_HAS_COUNTING_PMCS) == 0)
1007                 errx(EX_USAGE,
1008 "ERROR: options -C, -W and -o require at least one counting mode PMC to be specified."
1009                     );
1010
1011         /* check for sampling mode options without a sampling PMC spec */
1012         if ((args.pa_required & FLAG_HAS_SAMPLING_PMCS) &&
1013             (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) == 0)
1014                 errx(EX_USAGE,
1015 "ERROR: options -N, -n and -O require at least one sampling mode PMC to be specified."
1016                     );
1017
1018         /* check if -g/-G/-m/-T are being used correctly */
1019         if ((args.pa_flags & FLAG_DO_ANALYSIS) &&
1020             !(args.pa_flags & (FLAG_HAS_SAMPLING_PMCS|FLAG_READ_LOGFILE)))
1021                 errx(EX_USAGE,
1022 "ERROR: options -g/-G/-m/-T require sampling PMCs or -R to be specified."
1023                     );
1024
1025         /* check if -O was spuriously specified */
1026         if ((args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE) &&
1027             (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0)
1028                 errx(EX_USAGE,
1029 "ERROR: option -O is used only with options -E, -P, -S and -W."
1030                     );
1031
1032         /* -k kernel path require -g/-G/-m/-T or -R */
1033         if ((args.pa_flags & FLAG_HAS_KERNELPATH) &&
1034             (args.pa_flags & FLAG_DO_ANALYSIS) == 0 &&
1035             (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1036             errx(EX_USAGE, "ERROR: option -k is only used with -g/-R/-m/-T.");
1037
1038         /* -D only applies to gprof output mode (-g) */
1039         if ((args.pa_flags & FLAG_HAS_SAMPLESDIR) &&
1040             (args.pa_flags & FLAG_DO_GPROF) == 0)
1041             errx(EX_USAGE, "ERROR: option -D is only used with -g.");
1042
1043         /* -M mapfile requires -g or -R */
1044         if (args.pa_mapfilename != NULL &&
1045             (args.pa_flags & FLAG_DO_GPROF) == 0 &&
1046             (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1047             errx(EX_USAGE, "ERROR: option -M is only used with -g/-R.");
1048
1049         /*
1050          * Disallow textual output of sampling PMCs if counting PMCs
1051          * have also been asked for, mostly because the combined output
1052          * is difficult to make sense of.
1053          */
1054         if ((args.pa_flags & FLAG_HAS_COUNTING_PMCS) &&
1055             (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) &&
1056             ((args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE) == 0))
1057                 errx(EX_USAGE,
1058 "ERROR: option -O is required if counting and sampling PMCs are specified together."
1059                     );
1060
1061         /*
1062          * Check if 'kerneldir' refers to a file rather than a
1063          * directory.  If so, use `dirname path` to determine the
1064          * kernel directory.
1065          */
1066         (void) snprintf(buffer, sizeof(buffer), "%s%s", args.pa_fsroot,
1067             args.pa_kernel);
1068         if (stat(buffer, &sb) < 0)
1069                 err(EX_OSERR, "ERROR: Cannot locate kernel \"%s\"",
1070                     buffer);
1071         if (!S_ISREG(sb.st_mode) && !S_ISDIR(sb.st_mode))
1072                 errx(EX_USAGE, "ERROR: \"%s\": Unsupported file type.",
1073                     buffer);
1074         if (!S_ISDIR(sb.st_mode)) {
1075                 tmp = args.pa_kernel;
1076                 args.pa_kernel = strdup(dirname(args.pa_kernel));
1077                 free(tmp);
1078                 (void) snprintf(buffer, sizeof(buffer), "%s%s",
1079                     args.pa_fsroot, args.pa_kernel);
1080                 if (stat(buffer, &sb) < 0)
1081                         err(EX_OSERR, "ERROR: Cannot stat \"%s\"",
1082                             buffer);
1083                 if (!S_ISDIR(sb.st_mode))
1084                         errx(EX_USAGE,
1085                             "ERROR: \"%s\" is not a directory.",
1086                             buffer);
1087         }
1088
1089         /*
1090          * If we have a callgraph be created, select the outputfile.
1091          */
1092         if (args.pa_flags & FLAG_DO_CALLGRAPHS) {
1093                 if (strcmp(graphfilename, "-") == 0)
1094                     args.pa_graphfile = args.pa_printfile;
1095                 else {
1096                         args.pa_graphfile = fopen(graphfilename, "w");
1097                         if (args.pa_graphfile == NULL)
1098                                 err(EX_OSERR,
1099                                     "ERROR: cannot open \"%s\" for writing",
1100                                     graphfilename);
1101                 }
1102         }
1103         if (args.pa_flags & FLAG_DO_ANNOTATE) {
1104                 args.pa_graphfile = fopen(graphfilename, "w");
1105                 if (args.pa_graphfile == NULL)
1106                         err(EX_OSERR, "ERROR: cannot open \"%s\" for writing",
1107                             graphfilename);
1108         }
1109
1110         /* if we've been asked to process a log file, skip init */
1111         if ((args.pa_flags & FLAG_READ_LOGFILE) == 0) {
1112                 if (pmc_init() < 0)
1113                         err(EX_UNAVAILABLE,
1114                             "ERROR: Initialization of the pmc(3) library failed"
1115                             );
1116
1117                 if ((npmc = pmc_npmc(0)) < 0) /* assume all CPUs are identical */
1118                         err(EX_OSERR,
1119 "ERROR: Cannot determine the number of PMCs on CPU %d",
1120                             0);
1121         }
1122
1123         /* Allocate a kqueue */
1124         if ((pmcstat_kq = kqueue()) < 0)
1125                 err(EX_OSERR, "ERROR: Cannot allocate kqueue");
1126
1127         /* Setup the logfile as the source. */
1128         if (args.pa_flags & FLAG_READ_LOGFILE) {
1129                 /*
1130                  * Print the log in textual form if we haven't been
1131                  * asked to generate profiling information.
1132                  */
1133                 if ((args.pa_flags & FLAG_DO_ANALYSIS) == 0)
1134                         args.pa_flags |= FLAG_DO_PRINT;
1135
1136                 pmcstat_initialize_logging();
1137                 rfd = pmcstat_open_log(args.pa_inputpath,
1138                     PMCSTAT_OPEN_FOR_READ);
1139                 if ((args.pa_logparser = pmclog_open(rfd)) == NULL)
1140                         err(EX_OSERR, "ERROR: Cannot create parser");
1141                 if (fcntl(rfd, F_SETFL, O_NONBLOCK) < 0)
1142                         err(EX_OSERR, "ERROR: fcntl(2) failed");
1143                 EV_SET(&kev, rfd, EVFILT_READ, EV_ADD,
1144                     0, 0, NULL);
1145                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1146                         err(EX_OSERR, "ERROR: Cannot register kevent");
1147         }
1148         /*
1149          * Configure the specified log file or setup a default log
1150          * consumer via a pipe.
1151          */
1152         if (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) {
1153                 if (args.pa_outputpath)
1154                         args.pa_logfd = pmcstat_open_log(args.pa_outputpath,
1155                             PMCSTAT_OPEN_FOR_WRITE);
1156                 else {
1157                         /*
1158                          * process the log on the fly by reading it in
1159                          * through a pipe.
1160                          */
1161                         if (pipe(pipefd) < 0)
1162                                 err(EX_OSERR, "ERROR: pipe(2) failed");
1163
1164                         if (fcntl(pipefd[READPIPEFD], F_SETFL, O_NONBLOCK) < 0)
1165                                 err(EX_OSERR, "ERROR: fcntl(2) failed");
1166
1167                         EV_SET(&kev, pipefd[READPIPEFD], EVFILT_READ, EV_ADD,
1168                             0, 0, NULL);
1169
1170                         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1171                                 err(EX_OSERR, "ERROR: Cannot register kevent");
1172
1173                         args.pa_logfd = pipefd[WRITEPIPEFD];
1174
1175                         args.pa_flags |= FLAG_HAS_PIPE;
1176                         if ((args.pa_flags & FLAG_DO_TOP) == 0)
1177                                 args.pa_flags |= FLAG_DO_PRINT;
1178                         args.pa_logparser = pmclog_open(pipefd[READPIPEFD]);
1179                 }
1180
1181                 if (pmc_configure_logfile(args.pa_logfd) < 0)
1182                         err(EX_OSERR, "ERROR: Cannot configure log file");
1183         }
1184
1185         /* remember to check for driver errors if we are sampling or logging */
1186         check_driver_stats = (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) ||
1187             (args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE);
1188
1189         /*
1190         if (args.pa_flags & FLAG_READ_LOGFILE) {
1191          * Allocate PMCs.
1192          */
1193
1194         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
1195                 if (pmc_allocate(ev->ev_spec, ev->ev_mode,
1196                     ev->ev_flags, ev->ev_cpu, &ev->ev_pmcid) < 0)
1197                         err(EX_OSERR,
1198 "ERROR: Cannot allocate %s-mode pmc with specification \"%s\"",
1199                             PMC_IS_SYSTEM_MODE(ev->ev_mode) ?
1200                             "system" : "process", ev->ev_spec);
1201
1202                 if (PMC_IS_SAMPLING_MODE(ev->ev_mode) &&
1203                     pmc_set(ev->ev_pmcid, ev->ev_count) < 0)
1204                         err(EX_OSERR,
1205                             "ERROR: Cannot set sampling count for PMC \"%s\"",
1206                             ev->ev_name);
1207         }
1208
1209         /* compute printout widths */
1210         STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
1211                 int counter_width;
1212                 int display_width;
1213                 int header_width;
1214
1215                 (void) pmc_width(ev->ev_pmcid, &counter_width);
1216                 header_width = strlen(ev->ev_name) + 2; /* prefix '%c/' */
1217                 display_width = (int) floor(counter_width / 3.32193) + 1;
1218
1219                 if (PMC_IS_SYSTEM_MODE(ev->ev_mode))
1220                         header_width += 3; /* 2 digit CPU number + '/' */
1221
1222                 if (header_width > display_width) {
1223                         ev->ev_fieldskip = 0;
1224                         ev->ev_fieldwidth = header_width;
1225                 } else {
1226                         ev->ev_fieldskip = display_width -
1227                             header_width;
1228                         ev->ev_fieldwidth = display_width;
1229                 }
1230         }
1231
1232         /*
1233          * If our output is being set to a terminal, register a handler
1234          * for window size changes.
1235          */
1236
1237         if (isatty(fileno(args.pa_printfile))) {
1238
1239                 if (ioctl(fileno(args.pa_printfile), TIOCGWINSZ, &ws) < 0)
1240                         err(EX_OSERR, "ERROR: Cannot determine window size");
1241
1242                 pmcstat_displayheight = ws.ws_row - 1;
1243                 pmcstat_displaywidth  = ws.ws_col - 1;
1244
1245                 EV_SET(&kev, SIGWINCH, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1246
1247                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1248                         err(EX_OSERR,
1249                             "ERROR: Cannot register kevent for SIGWINCH");
1250
1251                 args.pa_toptty = 1;
1252         }
1253
1254         /*
1255          * Listen to key input in top mode.
1256          */
1257         if (args.pa_flags & FLAG_DO_TOP) {
1258                 EV_SET(&kev, fileno(stdin), EVFILT_READ, EV_ADD, 0, 0, NULL);
1259                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1260                         err(EX_OSERR, "ERROR: Cannot register kevent");
1261         }
1262
1263         EV_SET(&kev, SIGINT, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1264         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1265                 err(EX_OSERR, "ERROR: Cannot register kevent for SIGINT");
1266
1267         EV_SET(&kev, SIGIO, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1268         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1269                 err(EX_OSERR, "ERROR: Cannot register kevent for SIGIO");
1270
1271         /*
1272          * An exec() failure of a forked child is signalled by the
1273          * child sending the parent a SIGCHLD.  We don't register an
1274          * actual signal handler for SIGCHLD, but instead use our
1275          * kqueue to pick up the signal.
1276          */
1277         EV_SET(&kev, SIGCHLD, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1278         if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1279                 err(EX_OSERR, "ERROR: Cannot register kevent for SIGCHLD");
1280
1281         /*
1282          * Setup a timer if we have counting mode PMCs needing to be printed or
1283          * top mode plugin is active.
1284          */
1285         if (((args.pa_flags & FLAG_HAS_COUNTING_PMCS) &&
1286              (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0) ||
1287             (args.pa_flags & FLAG_DO_TOP)) {
1288                 EV_SET(&kev, 0, EVFILT_TIMER, EV_ADD, 0,
1289                     args.pa_interval * 1000, NULL);
1290
1291                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1292                         err(EX_OSERR,
1293                             "ERROR: Cannot register kevent for timer");
1294         }
1295
1296         /*
1297          * Setup a duration timer if we have sampling mode PMCs and
1298          * a duration time is set
1299          */
1300         if ((args.pa_flags & FLAG_HAS_SAMPLING_PMCS) &&
1301             (args.pa_flags & FLAG_HAS_DURATION)) {
1302                 EV_SET(&kev, 0, EVFILT_TIMER, EV_ADD, 0,
1303                     args.pa_duration * 1000, NULL);
1304
1305                 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1306                         err(EX_OSERR, "ERROR: Cannot register kevent for "
1307                             "time duration");
1308         }
1309
1310         /* attach PMCs to the target process, starting it if specified */
1311         if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1312                 pmcstat_create_process();
1313
1314         if (check_driver_stats && pmc_get_driver_stats(&ds_start) < 0)
1315                 err(EX_OSERR, "ERROR: Cannot retrieve driver statistics");
1316
1317         /* Attach process pmcs to the target process. */
1318         if (args.pa_flags & (FLAG_HAS_TARGET | FLAG_HAS_COMMANDLINE)) {
1319                 if (SLIST_EMPTY(&args.pa_targets))
1320                         errx(EX_DATAERR,
1321                             "ERROR: No matching target processes.");
1322                 if (args.pa_flags & FLAG_HAS_PROCESS_PMCS)
1323                         pmcstat_attach_pmcs();
1324
1325                 if (pmcstat_kvm) {
1326                         kvm_close(pmcstat_kvm);
1327                         pmcstat_kvm = NULL;
1328                 }
1329         }
1330
1331         /* start the pmcs */
1332         pmcstat_start_pmcs();
1333
1334         /* start the (commandline) process if needed */
1335         if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1336                 pmcstat_start_process();
1337
1338         /* initialize logging */
1339         pmcstat_initialize_logging();
1340
1341         /* Handle SIGINT using the kqueue loop */
1342         sa.sa_handler = SIG_IGN;
1343         sa.sa_flags   = 0;
1344         (void) sigemptyset(&sa.sa_mask);
1345
1346         if (sigaction(SIGINT, &sa, NULL) < 0)
1347                 err(EX_OSERR, "ERROR: Cannot install signal handler");
1348
1349         /*
1350          * Setup the top mode display.
1351          */
1352         if (args.pa_flags & FLAG_DO_TOP) {
1353                 args.pa_flags &= ~FLAG_DO_PRINT;
1354
1355                 if (args.pa_toptty) {
1356                         /*
1357                          * Init ncurses.
1358                          */
1359                         initscr();
1360                         if(has_colors() == TRUE) {
1361                                 args.pa_topcolor = 1;
1362                                 start_color();
1363                                 use_default_colors();
1364                                 pair_content(0, &cf, &cb);
1365                                 init_pair(1, COLOR_RED, cb);
1366                                 init_pair(2, COLOR_YELLOW, cb);
1367                                 init_pair(3, COLOR_GREEN, cb);
1368                         }
1369                         cbreak();
1370                         noecho();
1371                         nonl();
1372                         nodelay(stdscr, 1);
1373                         intrflush(stdscr, FALSE);
1374                         keypad(stdscr, TRUE);
1375                         clear();
1376                         /* Get terminal width / height with ncurses. */
1377                         getmaxyx(stdscr,
1378                             pmcstat_displayheight, pmcstat_displaywidth);
1379                         pmcstat_displayheight--; pmcstat_displaywidth--;
1380                         atexit(pmcstat_topexit);
1381                 }
1382         }
1383
1384         /*
1385          * loop till either the target process (if any) exits, or we
1386          * are killed by a SIGINT or we reached the time duration.
1387          */
1388         runstate = PMCSTAT_RUNNING;
1389         do_print = do_read = 0;
1390         do {
1391                 if ((c = kevent(pmcstat_kq, NULL, 0, &kev, 1, NULL)) <= 0) {
1392                         if (errno != EINTR)
1393                                 err(EX_OSERR, "ERROR: kevent failed");
1394                         else
1395                                 continue;
1396                 }
1397
1398                 if (kev.flags & EV_ERROR)
1399                         errc(EX_OSERR, kev.data, "ERROR: kevent failed");
1400
1401                 switch (kev.filter) {
1402                 case EVFILT_PROC:  /* target has exited */
1403                         runstate = pmcstat_close_log();
1404                         do_print = 1;
1405                         break;
1406
1407                 case EVFILT_READ:  /* log file data is present */
1408                         if (kev.ident == (unsigned)fileno(stdin) &&
1409                             (args.pa_flags & FLAG_DO_TOP)) {
1410                                 if (pmcstat_keypress_log())
1411                                         runstate = pmcstat_close_log();
1412                         } else {
1413                                 do_read = 0;
1414                                 runstate = pmcstat_process_log();
1415                         }
1416                         break;
1417
1418                 case EVFILT_SIGNAL:
1419                         if (kev.ident == SIGCHLD) {
1420                                 /*
1421                                  * The child process sends us a
1422                                  * SIGCHLD if its exec() failed.  We
1423                                  * wait for it to exit and then exit
1424                                  * ourselves.
1425                                  */
1426                                 (void) wait(&c);
1427                                 runstate = PMCSTAT_FINISHED;
1428                         } else if (kev.ident == SIGIO) {
1429                                 /*
1430                                  * We get a SIGIO if a PMC loses all
1431                                  * of its targets, or if logfile
1432                                  * writes encounter an error.
1433                                  */
1434                                 runstate = pmcstat_close_log();
1435                                 do_print = 1; /* print PMCs at exit */
1436                         } else if (kev.ident == SIGINT) {
1437                                 /* Kill the child process if we started it */
1438                                 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1439                                         pmcstat_kill_process();
1440                                 runstate = pmcstat_close_log();
1441                         } else if (kev.ident == SIGWINCH) {
1442                                 if (ioctl(fileno(args.pa_printfile),
1443                                         TIOCGWINSZ, &ws) < 0)
1444                                     err(EX_OSERR,
1445                                         "ERROR: Cannot determine window size");
1446                                 pmcstat_displayheight = ws.ws_row - 1;
1447                                 pmcstat_displaywidth  = ws.ws_col - 1;
1448                         } else
1449                                 assert(0);
1450
1451                         break;
1452
1453                 case EVFILT_TIMER:
1454                         /* time duration reached, exit */
1455                         if (args.pa_flags & FLAG_HAS_DURATION) {
1456                                 runstate = PMCSTAT_FINISHED;
1457                                 break;
1458                         }
1459                         /* print out counting PMCs */
1460                         if ((args.pa_flags & FLAG_DO_TOP) &&
1461                              pmc_flush_logfile() == 0)
1462                                 do_read = 1;
1463                         do_print = 1;
1464                         break;
1465
1466                 }
1467
1468                 if (do_print && !do_read) {
1469                         if ((args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0) {
1470                                 pmcstat_print_pmcs();
1471                                 if (runstate == PMCSTAT_FINISHED &&
1472                                     /* final newline */
1473                                     (args.pa_flags & FLAG_DO_PRINT) == 0)
1474                                         (void) fprintf(args.pa_printfile, "\n");
1475                         }
1476                         if (args.pa_flags & FLAG_DO_TOP)
1477                                 pmcstat_display_log();
1478                         do_print = 0;
1479                 }
1480
1481         } while (runstate != PMCSTAT_FINISHED);
1482
1483         if ((args.pa_flags & FLAG_DO_TOP) && args.pa_toptty) {
1484                 pmcstat_topexit();
1485                 args.pa_toptty = 0;
1486         }
1487
1488         /* flush any pending log entries */
1489         if (args.pa_flags & (FLAG_HAS_OUTPUT_LOGFILE | FLAG_HAS_PIPE))
1490                 pmc_close_logfile();
1491
1492         pmcstat_cleanup();
1493
1494         free(args.pa_kernel);
1495
1496         /* check if the driver lost any samples or events */
1497         if (check_driver_stats) {
1498                 if (pmc_get_driver_stats(&ds_end) < 0)
1499                         err(EX_OSERR,
1500                             "ERROR: Cannot retrieve driver statistics");
1501                 if (ds_start.pm_intr_bufferfull != ds_end.pm_intr_bufferfull &&
1502                     args.pa_verbosity > 0)
1503                         warnx("WARNING: some samples were dropped.\n"
1504 "Please consider tuning the \"kern.hwpmc.nsamples\" tunable."
1505                             );
1506                 if (ds_start.pm_buffer_requests_failed !=
1507                     ds_end.pm_buffer_requests_failed &&
1508                     args.pa_verbosity > 0)
1509                         warnx("WARNING: some events were discarded.\n"
1510 "Please consider tuning the \"kern.hwpmc.nbuffers\" tunable."
1511                             );
1512         }
1513
1514         exit(EX_OK);
1515 }