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