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