usr.sbin/pmcstat/pmcstat.c

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