1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
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 #include <sys/param.h>
35 #include <sys/cpuset.h>
36 #include <sys/event.h>
37 #include <sys/queue.h>
38 #include <sys/socket.h>
39 #include <sys/stat.h>
40 #include <sys/sysctl.h>
41 #include <sys/time.h>
42 #include <sys/ttycom.h>
43 #include <sys/user.h>
44 #include <sys/wait.h>
45
46 #include <assert.h>
47 #include <curses.h>
48 #include <err.h>
49 #include <errno.h>
50 #include <fcntl.h>
51 #include <kvm.h>
52 #include <libgen.h>
53 #include <limits.h>
54 #include <math.h>
55 #include <pmc.h>
56 #include <pmclog.h>
57 #include <regex.h>
58 #include <signal.h>
59 #include <stdarg.h>
60 #include <stdbool.h>
61 #include <stdint.h>
62 #include <stdio.h>
63 #include <stdlib.h>
64 #include <string.h>
65 #include <sysexits.h>
66 #include <unistd.h>
67
68 #include <libpmcstat.h>
69
70 #include "pmcstat.h"
71
72 /*
73 * A given invocation of pmcstat(8) can manage multiple PMCs of both
74 * the system-wide and per-process variety. Each of these could be in
75 * 'counting mode' or in 'sampling mode'.
76 *
77 * For 'counting mode' PMCs, pmcstat(8) will periodically issue a
78 * pmc_read() at the configured time interval and print out the value
79 * of the requested PMCs.
80 *
81 * For 'sampling mode' PMCs it can log to a file for offline analysis,
82 * or can analyse sampling data "on the fly", either by converting
83 * samples to printed textual form or by creating gprof(1) compatible
84 * profiles, one per program executed. When creating gprof(1)
85 * profiles it can optionally merge entries from multiple processes
86 * for a given executable into a single profile file.
87 *
88 * pmcstat(8) can also execute a command line and attach PMCs to the
89 * resulting child process. The protocol used is as follows:
90 *
91 * - parent creates a socketpair for two way communication and
92 * fork()s.
93 * - subsequently:
94 *
95 * /Parent/ /Child/
96 *
97 * - Wait for child's token.
98 * - Sends token.
99 * - Awaits signal to start.
100 * - Attaches PMCs to the child's pid
101 * and starts them. Sets up
102 * monitoring for the child.
103 * - Signals child to start.
104 * - Receives signal, attempts exec().
105 *
106 * After this point normal processing can happen.
107 */
108
109 /* Globals */
110
111 int pmcstat_displayheight = DEFAULT_DISPLAY_HEIGHT;
112 int pmcstat_displaywidth = DEFAULT_DISPLAY_WIDTH;
113 static int pmcstat_sockpair[NSOCKPAIRFD];
114 static int pmcstat_kq;
115 static kvm_t *pmcstat_kvm;
116 static struct kinfo_proc *pmcstat_plist;
117 struct pmcstat_args args;
118 static bool libpmc_initialized = false;
119
120 static void
pmcstat_get_cpumask(const char * cpuspec,cpuset_t * cpumask)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
pmcstat_cleanup(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
pmcstat_find_targets(const char * spec)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(®, spec, REG_EXTENDED|REG_NOSUB)) != 0) {
206 regerror(rv, ®, 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(®, kp->ki_comm, 1, ®match, 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, ®, errbuf, sizeof(errbuf));
219 errx(EX_SOFTWARE, "ERROR: Regex evalation failed: %s",
220 errbuf);
221 }
222 }
223
224 regfree(®);
225
226 return;
227
228 outofmemory:
229 errx(EX_SOFTWARE, "Out of memory.");
230 /*NOTREACHED*/
231 }
232
233 void
pmcstat_kill_process(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
pmcstat_start_pmcs(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
pmcstat_print_headers(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
pmcstat_print_counters(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
pmcstat_print_pmcs(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
352 void
pmcstat_show_usage(void)353 pmcstat_show_usage(void)
354 {
355 errx(EX_USAGE,
356 "[options] [commandline]\n"
357 "\t Measure process and/or system performance using hardware\n"
358 "\t performance monitoring counters.\n"
359 "\t Options include:\n"
360 "\t -C\t\t (toggle) show cumulative counts\n"
361 "\t -D path\t create profiles in directory \"path\"\n"
362 "\t -E\t\t (toggle) show counts at process exit\n"
363 "\t -F file\t write a system-wide callgraph (Kcachegrind format)"
364 " to \"file\"\n"
365 "\t -G file\t write a system-wide callgraph to \"file\"\n"
366 "\t -I\t\t don't resolve leaf function name, show address instead\n"
367 "\t -L\t\t list all counters available on this host\n"
368 "\t -M file\t print executable/gmon file map to \"file\"\n"
369 "\t -N\t\t (toggle) capture callchains\n"
370 "\t -O file\t send log output to \"file\"\n"
371 "\t -P spec\t allocate a process-private sampling PMC\n"
372 "\t -R file\t read events from \"file\"\n"
373 "\t -S spec\t allocate a system-wide sampling PMC\n"
374 "\t -T\t\t start in top mode\n"
375 "\t -U \t\t merged user kernel stack capture\n"
376 "\t -W\t\t (toggle) show counts per context switch\n"
377 "\t -a file\t print sampled PCs and callgraph to \"file\"\n"
378 "\t -c cpu-list\t set cpus for subsequent system-wide PMCs\n"
379 "\t -d\t\t (toggle) track descendants\n"
380 "\t -e\t\t use wide history counter for gprof(1) output\n"
381 "\t -f spec\t pass \"spec\" to as plugin option\n"
382 "\t -g\t\t produce gprof(1) compatible profiles\n"
383 "\t -i lwp\t\t filter on thread id \"lwp\" in post-processing\n"
384 "\t -l secs\t set duration time\n"
385 "\t -m file\t print sampled PCs to \"file\"\n"
386 "\t -n rate\t set sampling rate\n"
387 "\t -o file\t send print output to \"file\"\n"
388 "\t -p spec\t allocate a process-private counting PMC\n"
389 "\t -q\t\t suppress verbosity\n"
390 "\t -r fsroot\t specify FS root directory\n"
391 "\t -s spec\t allocate a system-wide counting PMC\n"
392 "\t -t process-spec attach to running processes matching "
393 "\"process-spec\"\n"
394 "\t -u spec \t provide short description of counters matching 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
pmcstat_topexit(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 static inline void
libpmc_initialize(int * npmc)420 libpmc_initialize(int *npmc)
421 {
422
423 if (libpmc_initialized)
424 return;
425 if (pmc_init() < 0)
426 err(EX_UNAVAILABLE, "ERROR: Initialization of the pmc(3)"
427 " library failed");
428
429 /* assume all CPUs are identical */
430 if ((*npmc = pmc_npmc(0)) < 0)
431 err(EX_OSERR, "ERROR: Cannot determine the number of PMCs on "
432 "CPU %d", 0);
433 libpmc_initialized = true;
434 }
435 /*
436 * Main
437 */
438
439 int
main(int argc,char ** argv)440 main(int argc, char **argv)
441 {
442 cpuset_t cpumask, dommask, rootmask;
443 double interval;
444 double duration;
445 int option, npmc;
446 int c, check_driver_stats;
447 int do_callchain, do_descendants, do_logproccsw, do_logprocexit;
448 int do_print, do_read, do_listcounters, do_descr, domains;
449 int do_userspace, i;
450 size_t len;
451 int graphdepth;
452 int pipefd[2], rfd;
453 int use_cumulative_counts;
454 short cf, cb;
455 uint64_t current_sampling_count;
456 char *end, *event;
457 const char *errmsg, *graphfilename;
458 enum pmcstat_state runstate;
459 struct pmc_driverstats ds_start, ds_end;
460 struct pmcstat_ev *ev;
461 struct sigaction sa;
462 struct kevent kev;
463 struct winsize ws;
464 struct stat sb;
465 uint32_t caps;
466
467 check_driver_stats = 0;
468 current_sampling_count = 0;
469 do_callchain = 1;
470 do_descr = 0;
471 do_descendants = 0;
472 do_userspace = 0;
473 do_logproccsw = 0;
474 do_logprocexit = 0;
475 do_listcounters = 0;
476 domains = 0;
477 use_cumulative_counts = 0;
478 graphfilename = "-";
479 args.pa_required = 0;
480 args.pa_flags = 0;
481 args.pa_verbosity = 1;
482 args.pa_logfd = -1;
483 args.pa_fsroot = "";
484 args.pa_samplesdir = ".";
485 args.pa_printfile = stderr;
486 args.pa_graphdepth = DEFAULT_CALLGRAPH_DEPTH;
487 args.pa_graphfile = NULL;
488 args.pa_interval = DEFAULT_WAIT_INTERVAL;
489 args.pa_mapfilename = NULL;
490 args.pa_inputpath = NULL;
491 args.pa_outputpath = NULL;
492 args.pa_pplugin = PMCSTAT_PL_NONE;
493 args.pa_plugin = PMCSTAT_PL_NONE;
494 args.pa_ctdumpinstr = 1;
495 args.pa_topmode = PMCSTAT_TOP_DELTA;
496 args.pa_toptty = 0;
497 args.pa_topcolor = 0;
498 args.pa_mergepmc = 0;
499 args.pa_duration = 0.0;
500 STAILQ_INIT(&args.pa_events);
501 SLIST_INIT(&args.pa_targets);
502 bzero(&ds_start, sizeof(ds_start));
503 bzero(&ds_end, sizeof(ds_end));
504 ev = NULL;
505 event = NULL;
506 caps = 0;
507 CPU_ZERO(&cpumask);
508
509 len = sizeof(domains);
510 if (sysctlbyname("vm.ndomains", &domains, &len, NULL, 0) == -1)
511 err(EX_OSERR, "ERROR: Cannot get number of domains");
512
513 /*
514 * The initial CPU mask specifies the root mask of this process
515 * which is usually all CPUs in the system.
516 */
517 if (cpuset_getaffinity(CPU_LEVEL_ROOT, CPU_WHICH_PID, -1,
518 sizeof(rootmask), &rootmask) == -1)
519 err(EX_OSERR, "ERROR: Cannot determine the root set of CPUs");
520 CPU_COPY(&rootmask, &cpumask);
521
522 while ((option = getopt(argc, argv,
523 "ACD:EF:G:ILM:NO:P:R:S:TUWZa:c:def:gi:k:l:m:n:o:p:qr:s:t:u:vw:z:")) != -1)
524 switch (option) {
525 case 'A':
526 args.pa_flags |= FLAG_SKIP_TOP_FN_RES;
527 break;
528
529 case 'a': /* Annotate + callgraph */
530 args.pa_flags |= FLAG_DO_ANNOTATE;
531 args.pa_plugin = PMCSTAT_PL_ANNOTATE_CG;
532 graphfilename = optarg;
533 break;
534
535 case 'C': /* cumulative values */
536 use_cumulative_counts = !use_cumulative_counts;
537 args.pa_required |= FLAG_HAS_COUNTING_PMCS;
538 break;
539
540 case 'c': /* CPU */
541 if (optarg[0] == '*' && optarg[1] == '\0')
542 CPU_COPY(&rootmask, &cpumask);
543 else
544 pmcstat_get_cpumask(optarg, &cpumask);
545
546 args.pa_flags |= FLAGS_HAS_CPUMASK;
547 args.pa_required |= FLAG_HAS_SYSTEM_PMCS;
548 break;
549
550 case 'D':
551 if (stat(optarg, &sb) < 0)
552 err(EX_OSERR, "ERROR: Cannot stat \"%s\"",
553 optarg);
554 if (!S_ISDIR(sb.st_mode))
555 errx(EX_USAGE,
556 "ERROR: \"%s\" is not a directory.",
557 optarg);
558 args.pa_samplesdir = optarg;
559 args.pa_flags |= FLAG_HAS_SAMPLESDIR;
560 args.pa_required |= FLAG_DO_GPROF;
561 break;
562
563 case 'd': /* toggle descendents */
564 do_descendants = !do_descendants;
565 args.pa_required |= FLAG_HAS_PROCESS_PMCS;
566 break;
567
568 case 'E': /* log process exit */
569 do_logprocexit = !do_logprocexit;
570 args.pa_required |= (FLAG_HAS_PROCESS_PMCS |
571 FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE);
572 break;
573
574 case 'e': /* wide gprof metrics */
575 args.pa_flags |= FLAG_DO_WIDE_GPROF_HC;
576 break;
577
578 case 'F': /* produce a system-wide calltree */
579 args.pa_flags |= FLAG_DO_CALLGRAPHS;
580 args.pa_plugin = PMCSTAT_PL_CALLTREE;
581 graphfilename = optarg;
582 break;
583
584 case 'f': /* plugins options */
585 if (args.pa_plugin == PMCSTAT_PL_NONE)
586 err(EX_USAGE, "ERROR: Need -g/-G/-m/-T.");
587 pmcstat_pluginconfigure_log(optarg);
588 break;
589
590 case 'G': /* produce a system-wide callgraph */
591 args.pa_flags |= FLAG_DO_CALLGRAPHS;
592 args.pa_plugin = PMCSTAT_PL_CALLGRAPH;
593 graphfilename = optarg;
594 break;
595
596 case 'g': /* produce gprof compatible profiles */
597 args.pa_flags |= FLAG_DO_GPROF;
598 args.pa_pplugin = PMCSTAT_PL_CALLGRAPH;
599 args.pa_plugin = PMCSTAT_PL_GPROF;
600 break;
601
602 case 'i':
603 args.pa_flags |= FLAG_FILTER_THREAD_ID;
604 args.pa_tid = strtol(optarg, &end, 0);
605 break;
606
607 case 'I':
608 args.pa_flags |= FLAG_SHOW_OFFSET;
609 break;
610
611 case 'k': /* pathname to the kernel */
612 warnx("WARNING: -k is obsolete, has no effect "
613 "and will be removed in FreeBSD 15.");
614 break;
615
616 case 'L':
617 do_listcounters = 1;
618 break;
619
620 case 'l': /* time duration in seconds */
621 duration = strtod(optarg, &end);
622 if (*end != '\0' || duration <= 0)
623 errx(EX_USAGE, "ERROR: Illegal duration time "
624 "value \"%s\".", optarg);
625 args.pa_flags |= FLAG_HAS_DURATION;
626 args.pa_duration = duration;
627 break;
628
629 case 'm':
630 args.pa_flags |= FLAG_DO_ANNOTATE;
631 args.pa_plugin = PMCSTAT_PL_ANNOTATE;
632 graphfilename = optarg;
633 break;
634
635 case 'M': /* mapfile */
636 args.pa_mapfilename = optarg;
637 break;
638
639 case 'N':
640 do_callchain = !do_callchain;
641 args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
642 break;
643
644 case 'p': /* process virtual counting PMC */
645 case 's': /* system-wide counting PMC */
646 case 'P': /* process virtual sampling PMC */
647 case 'S': /* system-wide sampling PMC */
648 caps = 0;
649 if ((ev = malloc(sizeof(*ev))) == NULL)
650 errx(EX_SOFTWARE, "ERROR: Out of memory.");
651
652 switch (option) {
653 case 'p': ev->ev_mode = PMC_MODE_TC; break;
654 case 's': ev->ev_mode = PMC_MODE_SC; break;
655 case 'P': ev->ev_mode = PMC_MODE_TS; break;
656 case 'S': ev->ev_mode = PMC_MODE_SS; break;
657 }
658
659 if (option == 'P' || option == 'p') {
660 args.pa_flags |= FLAG_HAS_PROCESS_PMCS;
661 args.pa_required |= (FLAG_HAS_COMMANDLINE |
662 FLAG_HAS_TARGET);
663 }
664
665 if (option == 'P' || option == 'S') {
666 args.pa_flags |= FLAG_HAS_SAMPLING_PMCS;
667 args.pa_required |= (FLAG_HAS_PIPE |
668 FLAG_HAS_OUTPUT_LOGFILE);
669 }
670
671 if (option == 'p' || option == 's')
672 args.pa_flags |= FLAG_HAS_COUNTING_PMCS;
673
674 if (option == 's' || option == 'S')
675 args.pa_flags |= FLAG_HAS_SYSTEM_PMCS;
676
677 ev->ev_spec = strdup(optarg);
678 if (ev->ev_spec == NULL)
679 errx(EX_SOFTWARE, "ERROR: Out of memory.");
680
681 if (option == 'S' || option == 'P')
682 ev->ev_count = current_sampling_count ? current_sampling_count : pmc_pmu_sample_rate_get(ev->ev_spec);
683 else
684 ev->ev_count = 0;
685
686 if (option == 'S' || option == 's')
687 ev->ev_cpu = CPU_FFS(&cpumask) - 1;
688 else
689 ev->ev_cpu = PMC_CPU_ANY;
690
691 ev->ev_flags = 0;
692 if (do_callchain) {
693 ev->ev_flags |= PMC_F_CALLCHAIN;
694 if (do_userspace)
695 ev->ev_flags |= PMC_F_USERCALLCHAIN;
696 }
697 if (do_descendants)
698 ev->ev_flags |= PMC_F_DESCENDANTS;
699 if (do_logprocexit)
700 ev->ev_flags |= PMC_F_LOG_PROCEXIT;
701 if (do_logproccsw)
702 ev->ev_flags |= PMC_F_LOG_PROCCSW;
703
704 ev->ev_cumulative = use_cumulative_counts;
705
706 ev->ev_saved = 0LL;
707 ev->ev_pmcid = PMC_ID_INVALID;
708
709 /* extract event name */
710 c = strcspn(optarg, ", \t");
711 ev->ev_name = malloc(c + 1);
712 if (ev->ev_name == NULL)
713 errx(EX_SOFTWARE, "ERROR: Out of memory.");
714 (void) strncpy(ev->ev_name, optarg, c);
715 *(ev->ev_name + c) = '\0';
716
717 libpmc_initialize(&npmc);
718
719 if (args.pa_flags & FLAG_HAS_SYSTEM_PMCS) {
720 /*
721 * We need to check the capabilities of the
722 * desired event to determine if it should be
723 * allocated on every CPU, or only a subset of
724 * them. This requires allocating a PMC now.
725 */
726 if (pmc_allocate(ev->ev_spec, ev->ev_mode,
727 ev->ev_flags, ev->ev_cpu, &ev->ev_pmcid,
728 ev->ev_count) < 0)
729 err(EX_OSERR, "ERROR: Cannot allocate "
730 "system-mode pmc with specification"
731 " \"%s\"", ev->ev_spec);
732 if (pmc_capabilities(ev->ev_pmcid, &caps)) {
733 pmc_release(ev->ev_pmcid);
734 err(EX_OSERR, "ERROR: Cannot get pmc "
735 "capabilities");
736 }
737
738 /*
739 * Release the PMC now that we have caps; we
740 * will reallocate shortly.
741 */
742 pmc_release(ev->ev_pmcid);
743 ev->ev_pmcid = PMC_ID_INVALID;
744 }
745
746 STAILQ_INSERT_TAIL(&args.pa_events, ev, ev_next);
747
748 if ((caps & PMC_CAP_SYSWIDE) == PMC_CAP_SYSWIDE)
749 break;
750 if ((caps & PMC_CAP_DOMWIDE) == PMC_CAP_DOMWIDE) {
751 CPU_ZERO(&cpumask);
752 /*
753 * Get number of domains and allocate one
754 * counter in each.
755 * First already allocated.
756 */
757 for (i = 1; i < domains; i++) {
758 CPU_ZERO(&dommask);
759 cpuset_getaffinity(CPU_LEVEL_WHICH,
760 CPU_WHICH_DOMAIN, i, sizeof(dommask),
761 &dommask);
762 CPU_SET(CPU_FFS(&dommask) - 1, &cpumask);
763 }
764 args.pa_flags |= FLAGS_HAS_CPUMASK;
765 }
766 if (option == 's' || option == 'S') {
767 CPU_CLR(ev->ev_cpu, &cpumask);
768 pmcstat_clone_event_descriptor(ev, &cpumask, &args);
769 CPU_SET(ev->ev_cpu, &cpumask);
770 }
771
772 break;
773
774 case 'n': /* sampling count */
775 current_sampling_count = strtol(optarg, &end, 0);
776 if (*end != '\0' || current_sampling_count <= 0)
777 errx(EX_USAGE,
778 "ERROR: Illegal count value \"%s\".",
779 optarg);
780 args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
781 break;
782
783 case 'o': /* outputfile */
784 if (args.pa_printfile != NULL &&
785 args.pa_printfile != stdout &&
786 args.pa_printfile != stderr)
787 (void) fclose(args.pa_printfile);
788 if ((args.pa_printfile = fopen(optarg, "w")) == NULL)
789 errx(EX_OSERR,
790 "ERROR: cannot open \"%s\" for writing.",
791 optarg);
792 args.pa_flags |= FLAG_DO_PRINT;
793 break;
794
795 case 'O': /* sampling output */
796 if (args.pa_outputpath)
797 errx(EX_USAGE,
798 "ERROR: option -O may only be specified once.");
799 args.pa_outputpath = optarg;
800 args.pa_flags |= FLAG_HAS_OUTPUT_LOGFILE;
801 break;
802
803 case 'q': /* quiet mode */
804 args.pa_verbosity = 0;
805 break;
806
807 case 'r': /* root FS path */
808 args.pa_fsroot = optarg;
809 break;
810
811 case 'R': /* read an existing log file */
812 if (args.pa_inputpath != NULL)
813 errx(EX_USAGE,
814 "ERROR: option -R may only be specified once.");
815 args.pa_inputpath = optarg;
816 if (args.pa_printfile == stderr)
817 args.pa_printfile = stdout;
818 args.pa_flags |= FLAG_READ_LOGFILE;
819 break;
820
821 case 't': /* target pid or process name */
822 pmcstat_find_targets(optarg);
823
824 args.pa_flags |= FLAG_HAS_TARGET;
825 args.pa_required |= FLAG_HAS_PROCESS_PMCS;
826 break;
827
828 case 'T': /* top mode */
829 args.pa_flags |= FLAG_DO_TOP;
830 args.pa_plugin = PMCSTAT_PL_CALLGRAPH;
831 args.pa_ctdumpinstr = 0;
832 args.pa_mergepmc = 1;
833 if (args.pa_printfile == stderr)
834 args.pa_printfile = stdout;
835 break;
836
837 case 'u':
838 do_descr = 1;
839 event = optarg;
840 break;
841 case 'U': /* toggle user-space callchain capture */
842 do_userspace = !do_userspace;
843 args.pa_required |= FLAG_HAS_SAMPLING_PMCS;
844 break;
845 case 'v': /* verbose */
846 args.pa_verbosity++;
847 break;
848
849 case 'w': /* wait interval */
850 interval = strtod(optarg, &end);
851 if (*end != '\0' || interval <= 0)
852 errx(EX_USAGE,
853 "ERROR: Illegal wait interval value \"%s\".",
854 optarg);
855 args.pa_flags |= FLAG_HAS_WAIT_INTERVAL;
856 args.pa_interval = interval;
857 break;
858
859 case 'W': /* toggle LOG_CSW */
860 do_logproccsw = !do_logproccsw;
861 args.pa_required |= (FLAG_HAS_PROCESS_PMCS |
862 FLAG_HAS_COUNTING_PMCS | FLAG_HAS_OUTPUT_LOGFILE);
863 break;
864
865 case 'z':
866 graphdepth = strtod(optarg, &end);
867 if (*end != '\0' || graphdepth <= 0)
868 errx(EX_USAGE,
869 "ERROR: Illegal callchain depth \"%s\".",
870 optarg);
871 args.pa_graphdepth = graphdepth;
872 args.pa_required |= FLAG_DO_CALLGRAPHS;
873 break;
874
875 case '?':
876 default:
877 pmcstat_show_usage();
878 break;
879
880 }
881 if ((do_listcounters | do_descr) &&
882 pmc_pmu_enabled() == 0)
883 errx(EX_USAGE, "pmu features not supported on host or hwpmc not loaded");
884 if (do_listcounters) {
885 pmc_pmu_print_counters(NULL);
886 } else if (do_descr) {
887 pmc_pmu_print_counter_desc(event);
888 }
889 if (do_listcounters | do_descr)
890 exit(0);
891
892 args.pa_argc = (argc -= optind);
893 args.pa_argv = (argv += optind);
894
895 /* If we read from logfile and no specified CPU mask use
896 * the maximum CPU count.
897 */
898 if ((args.pa_flags & FLAG_READ_LOGFILE) &&
899 (args.pa_flags & FLAGS_HAS_CPUMASK) == 0)
900 CPU_FILL(&cpumask);
901
902 args.pa_cpumask = cpumask; /* For selecting CPUs using -R. */
903
904 if (argc) /* command line present */
905 args.pa_flags |= FLAG_HAS_COMMANDLINE;
906
907 if (args.pa_flags & (FLAG_DO_GPROF | FLAG_DO_CALLGRAPHS |
908 FLAG_DO_ANNOTATE | FLAG_DO_TOP))
909 args.pa_flags |= FLAG_DO_ANALYSIS;
910
911 /*
912 * Check invocation syntax.
913 */
914
915 /* disallow -O and -R together */
916 if (args.pa_outputpath && args.pa_inputpath)
917 errx(EX_USAGE,
918 "ERROR: options -O and -R are mutually exclusive.");
919
920 /* disallow -T and -l together */
921 if ((args.pa_flags & FLAG_HAS_DURATION) &&
922 (args.pa_flags & FLAG_DO_TOP))
923 errx(EX_USAGE, "ERROR: options -T and -l are mutually "
924 "exclusive.");
925
926 /* -a and -m require -R */
927 if (args.pa_flags & FLAG_DO_ANNOTATE && args.pa_inputpath == NULL)
928 errx(EX_USAGE, "ERROR: option %s requires an input file",
929 args.pa_plugin == PMCSTAT_PL_ANNOTATE ? "-m" : "-a");
930
931 /* -m option is not allowed combined with -g or -G. */
932 if (args.pa_flags & FLAG_DO_ANNOTATE &&
933 args.pa_flags & (FLAG_DO_GPROF | FLAG_DO_CALLGRAPHS))
934 errx(EX_USAGE,
935 "ERROR: option -m and -g | -G are mutually exclusive");
936
937 if (args.pa_flags & FLAG_READ_LOGFILE) {
938 errmsg = NULL;
939 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
940 errmsg = "a command line specification";
941 else if (args.pa_flags & FLAG_HAS_TARGET)
942 errmsg = "option -t";
943 else if (!STAILQ_EMPTY(&args.pa_events))
944 errmsg = "a PMC event specification";
945 if (errmsg)
946 errx(EX_USAGE,
947 "ERROR: option -R may not be used with %s.",
948 errmsg);
949 } else if (STAILQ_EMPTY(&args.pa_events))
950 /* All other uses require a PMC spec. */
951 pmcstat_show_usage();
952
953 /* check for -t pid without a process PMC spec */
954 if ((args.pa_flags & FLAG_HAS_TARGET) &&
955 (args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
956 (args.pa_flags & FLAG_HAS_PROCESS_PMCS) == 0)
957 errx(EX_USAGE,
958 "ERROR: option -t requires a process mode PMC to be specified."
959 );
960
961 /* check for process-mode options without a command or -t pid */
962 if ((args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
963 (args.pa_flags & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) == 0)
964 errx(EX_USAGE,
965 "ERROR: options -d, -E, -p, -P, and -W require a command line or target process."
966 );
967
968 /* check for -p | -P without a target process of some sort */
969 if ((args.pa_required & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) &&
970 (args.pa_flags & (FLAG_HAS_COMMANDLINE | FLAG_HAS_TARGET)) == 0)
971 errx(EX_USAGE,
972 "ERROR: options -P and -p require a target process or a command line."
973 );
974
975 /* check for process-mode options without a process-mode PMC */
976 if ((args.pa_required & FLAG_HAS_PROCESS_PMCS) &&
977 (args.pa_flags & FLAG_HAS_PROCESS_PMCS) == 0)
978 errx(EX_USAGE,
979 "ERROR: options -d, -E, -t, and -W require a process mode PMC to be specified."
980 );
981
982 /* check for -c cpu with no system mode PMCs or logfile. */
983 if ((args.pa_required & FLAG_HAS_SYSTEM_PMCS) &&
984 (args.pa_flags & FLAG_HAS_SYSTEM_PMCS) == 0 &&
985 (args.pa_flags & FLAG_READ_LOGFILE) == 0)
986 errx(EX_USAGE,
987 "ERROR: option -c requires at least one system mode PMC to be specified."
988 );
989
990 /* check for counting mode options without a counting PMC */
991 if ((args.pa_required & FLAG_HAS_COUNTING_PMCS) &&
992 (args.pa_flags & FLAG_HAS_COUNTING_PMCS) == 0)
993 errx(EX_USAGE,
994 "ERROR: options -C, -W and -o require at least one counting mode PMC to be specified."
995 );
996
997 /* check for sampling mode options without a sampling PMC spec */
998 if ((args.pa_required & FLAG_HAS_SAMPLING_PMCS) &&
999 (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) == 0)
1000 errx(EX_USAGE,
1001 "ERROR: options -N, -n and -O require at least one sampling mode PMC to be specified."
1002 );
1003
1004 /* check if -g/-G/-m/-T are being used correctly */
1005 if ((args.pa_flags & FLAG_DO_ANALYSIS) &&
1006 !(args.pa_flags & (FLAG_HAS_SAMPLING_PMCS|FLAG_READ_LOGFILE)))
1007 errx(EX_USAGE,
1008 "ERROR: options -g/-G/-m/-T require sampling PMCs or -R to be specified."
1009 );
1010
1011 /* check if -e was specified without -g */
1012 if ((args.pa_flags & FLAG_DO_WIDE_GPROF_HC) &&
1013 !(args.pa_flags & FLAG_DO_GPROF))
1014 errx(EX_USAGE,
1015 "ERROR: option -e requires gprof mode to be specified."
1016 );
1017
1018 /* check if -O was spuriously specified */
1019 if ((args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE) &&
1020 (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0)
1021 errx(EX_USAGE,
1022 "ERROR: option -O is used only with options -E, -P, -S and -W."
1023 );
1024
1025 /* -D only applies to gprof output mode (-g) */
1026 if ((args.pa_flags & FLAG_HAS_SAMPLESDIR) &&
1027 (args.pa_flags & FLAG_DO_GPROF) == 0)
1028 errx(EX_USAGE, "ERROR: option -D is only used with -g.");
1029
1030 /* -M mapfile requires -g or -R */
1031 if (args.pa_mapfilename != NULL &&
1032 (args.pa_flags & FLAG_DO_GPROF) == 0 &&
1033 (args.pa_flags & FLAG_READ_LOGFILE) == 0)
1034 errx(EX_USAGE, "ERROR: option -M is only used with -g/-R.");
1035
1036 /*
1037 * Disallow textual output of sampling PMCs if counting PMCs
1038 * have also been asked for, mostly because the combined output
1039 * is difficult to make sense of.
1040 */
1041 if ((args.pa_flags & FLAG_HAS_COUNTING_PMCS) &&
1042 (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) &&
1043 ((args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE) == 0))
1044 errx(EX_USAGE,
1045 "ERROR: option -O is required if counting and sampling PMCs are specified together."
1046 );
1047
1048 /*
1049 * If we have a callgraph be created, select the outputfile.
1050 */
1051 if (args.pa_flags & FLAG_DO_CALLGRAPHS) {
1052 if (strcmp(graphfilename, "-") == 0)
1053 args.pa_graphfile = args.pa_printfile;
1054 else {
1055 args.pa_graphfile = fopen(graphfilename, "w");
1056 if (args.pa_graphfile == NULL)
1057 err(EX_OSERR,
1058 "ERROR: cannot open \"%s\" for writing",
1059 graphfilename);
1060 }
1061 }
1062 if (args.pa_flags & FLAG_DO_ANNOTATE) {
1063 args.pa_graphfile = fopen(graphfilename, "w");
1064 if (args.pa_graphfile == NULL)
1065 err(EX_OSERR, "ERROR: cannot open \"%s\" for writing",
1066 graphfilename);
1067 }
1068
1069 /* if we've been asked to process a log file, skip init */
1070 if ((args.pa_flags & FLAG_READ_LOGFILE) == 0)
1071 libpmc_initialize(&npmc);
1072
1073 /* Allocate a kqueue */
1074 if ((pmcstat_kq = kqueue()) < 0)
1075 err(EX_OSERR, "ERROR: Cannot allocate kqueue");
1076
1077 /* Setup the logfile as the source. */
1078 if (args.pa_flags & FLAG_READ_LOGFILE) {
1079 /*
1080 * Print the log in textual form if we haven't been
1081 * asked to generate profiling information.
1082 */
1083 if ((args.pa_flags & FLAG_DO_ANALYSIS) == 0)
1084 args.pa_flags |= FLAG_DO_PRINT;
1085
1086 pmcstat_log_initialize_logging();
1087 rfd = pmcstat_open_log(args.pa_inputpath,
1088 PMCSTAT_OPEN_FOR_READ);
1089 if ((args.pa_logparser = pmclog_open(rfd)) == NULL)
1090 err(EX_OSERR, "ERROR: Cannot create parser");
1091 if (fcntl(rfd, F_SETFL, O_NONBLOCK) < 0)
1092 err(EX_OSERR, "ERROR: fcntl(2) failed");
1093 EV_SET(&kev, rfd, EVFILT_READ, EV_ADD,
1094 0, 0, NULL);
1095 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1096 err(EX_OSERR, "ERROR: Cannot register kevent");
1097 }
1098 /*
1099 * Configure the specified log file or setup a default log
1100 * consumer via a pipe.
1101 */
1102 if (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) {
1103 if (args.pa_outputpath)
1104 args.pa_logfd = pmcstat_open_log(args.pa_outputpath,
1105 PMCSTAT_OPEN_FOR_WRITE);
1106 else {
1107 /*
1108 * process the log on the fly by reading it in
1109 * through a pipe.
1110 */
1111 if (pipe(pipefd) < 0)
1112 err(EX_OSERR, "ERROR: pipe(2) failed");
1113
1114 if (fcntl(pipefd[READPIPEFD], F_SETFL, O_NONBLOCK) < 0)
1115 err(EX_OSERR, "ERROR: fcntl(2) failed");
1116
1117 EV_SET(&kev, pipefd[READPIPEFD], EVFILT_READ, EV_ADD,
1118 0, 0, NULL);
1119
1120 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1121 err(EX_OSERR, "ERROR: Cannot register kevent");
1122
1123 args.pa_logfd = pipefd[WRITEPIPEFD];
1124
1125 args.pa_flags |= FLAG_HAS_PIPE;
1126 if ((args.pa_flags & FLAG_DO_TOP) == 0)
1127 args.pa_flags |= FLAG_DO_PRINT;
1128 args.pa_logparser = pmclog_open(pipefd[READPIPEFD]);
1129 }
1130
1131 if (pmc_configure_logfile(args.pa_logfd) < 0)
1132 err(EX_OSERR, "ERROR: Cannot configure log file");
1133 }
1134
1135 /* remember to check for driver errors if we are sampling or logging */
1136 check_driver_stats = (args.pa_flags & FLAG_HAS_SAMPLING_PMCS) ||
1137 (args.pa_flags & FLAG_HAS_OUTPUT_LOGFILE);
1138
1139 /*
1140 if (args.pa_flags & FLAG_READ_LOGFILE) {
1141 * Allocate PMCs.
1142 */
1143
1144 STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
1145 if (pmc_allocate(ev->ev_spec, ev->ev_mode,
1146 ev->ev_flags, ev->ev_cpu, &ev->ev_pmcid,
1147 ev->ev_count) < 0)
1148 err(EX_OSERR,
1149 "ERROR: Cannot allocate %s-mode pmc with specification \"%s\"",
1150 PMC_IS_SYSTEM_MODE(ev->ev_mode) ?
1151 "system" : "process", ev->ev_spec);
1152
1153 if (PMC_IS_SAMPLING_MODE(ev->ev_mode) &&
1154 pmc_set(ev->ev_pmcid, ev->ev_count) < 0)
1155 err(EX_OSERR,
1156 "ERROR: Cannot set sampling count for PMC \"%s\"",
1157 ev->ev_name);
1158 }
1159
1160 /* compute printout widths */
1161 STAILQ_FOREACH(ev, &args.pa_events, ev_next) {
1162 int counter_width;
1163 int display_width;
1164 int header_width;
1165
1166 (void) pmc_width(ev->ev_pmcid, &counter_width);
1167 header_width = strlen(ev->ev_name) + 2; /* prefix '%c/' */
1168 display_width = (int) floor(counter_width / 3.32193) + 1;
1169
1170 if (PMC_IS_SYSTEM_MODE(ev->ev_mode))
1171 header_width += 3; /* 2 digit CPU number + '/' */
1172
1173 if (header_width > display_width) {
1174 ev->ev_fieldskip = 0;
1175 ev->ev_fieldwidth = header_width;
1176 } else {
1177 ev->ev_fieldskip = display_width -
1178 header_width;
1179 ev->ev_fieldwidth = display_width;
1180 }
1181 }
1182
1183 /*
1184 * If our output is being set to a terminal, register a handler
1185 * for window size changes.
1186 */
1187
1188 if (isatty(fileno(args.pa_printfile))) {
1189
1190 if (ioctl(fileno(args.pa_printfile), TIOCGWINSZ, &ws) < 0)
1191 err(EX_OSERR, "ERROR: Cannot determine window size");
1192
1193 pmcstat_displayheight = ws.ws_row - 1;
1194 pmcstat_displaywidth = ws.ws_col - 1;
1195
1196 EV_SET(&kev, SIGWINCH, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1197
1198 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1199 err(EX_OSERR,
1200 "ERROR: Cannot register kevent for SIGWINCH");
1201
1202 args.pa_toptty = 1;
1203 }
1204
1205 /*
1206 * Listen to key input in top mode.
1207 */
1208 if (args.pa_flags & FLAG_DO_TOP) {
1209 EV_SET(&kev, fileno(stdin), EVFILT_READ, EV_ADD, 0, 0, NULL);
1210 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1211 err(EX_OSERR, "ERROR: Cannot register kevent");
1212 }
1213
1214 EV_SET(&kev, SIGINT, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1215 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1216 err(EX_OSERR, "ERROR: Cannot register kevent for SIGINT");
1217
1218 EV_SET(&kev, SIGIO, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1219 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1220 err(EX_OSERR, "ERROR: Cannot register kevent for SIGIO");
1221
1222 /*
1223 * An exec() failure of a forked child is signalled by the
1224 * child sending the parent a SIGCHLD. We don't register an
1225 * actual signal handler for SIGCHLD, but instead use our
1226 * kqueue to pick up the signal.
1227 */
1228 EV_SET(&kev, SIGCHLD, EVFILT_SIGNAL, EV_ADD, 0, 0, NULL);
1229 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1230 err(EX_OSERR, "ERROR: Cannot register kevent for SIGCHLD");
1231
1232 /*
1233 * Setup a timer if we have counting mode PMCs needing to be printed or
1234 * top mode plugin is active.
1235 */
1236 if (((args.pa_flags & FLAG_HAS_COUNTING_PMCS) &&
1237 (args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0) ||
1238 (args.pa_flags & FLAG_DO_TOP)) {
1239 EV_SET(&kev, 0, EVFILT_TIMER, EV_ADD, 0,
1240 args.pa_interval * 1000, NULL);
1241
1242 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1243 err(EX_OSERR,
1244 "ERROR: Cannot register kevent for timer");
1245 }
1246
1247 /*
1248 * Setup a duration timer if we have sampling mode PMCs and
1249 * a duration time is set
1250 */
1251 if ((args.pa_flags & FLAG_HAS_SAMPLING_PMCS) &&
1252 (args.pa_flags & FLAG_HAS_DURATION)) {
1253 EV_SET(&kev, 0, EVFILT_TIMER, EV_ADD, 0,
1254 args.pa_duration * 1000, NULL);
1255
1256 if (kevent(pmcstat_kq, &kev, 1, NULL, 0, NULL) < 0)
1257 err(EX_OSERR, "ERROR: Cannot register kevent for "
1258 "time duration");
1259 }
1260
1261 /* attach PMCs to the target process, starting it if specified */
1262 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1263 pmcstat_create_process(pmcstat_sockpair, &args, pmcstat_kq);
1264
1265 if (check_driver_stats && pmc_get_driver_stats(&ds_start) < 0)
1266 err(EX_OSERR, "ERROR: Cannot retrieve driver statistics");
1267
1268 /* Attach process pmcs to the target process. */
1269 if (args.pa_flags & (FLAG_HAS_TARGET | FLAG_HAS_COMMANDLINE)) {
1270 if (SLIST_EMPTY(&args.pa_targets))
1271 errx(EX_DATAERR,
1272 "ERROR: No matching target processes.");
1273 if (args.pa_flags & FLAG_HAS_PROCESS_PMCS)
1274 pmcstat_attach_pmcs(&args);
1275
1276 if (pmcstat_kvm) {
1277 kvm_close(pmcstat_kvm);
1278 pmcstat_kvm = NULL;
1279 }
1280 }
1281
1282 /* start the pmcs */
1283 pmcstat_start_pmcs();
1284
1285 /* start the (commandline) process if needed */
1286 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1287 pmcstat_start_process(pmcstat_sockpair);
1288
1289 /* initialize logging */
1290 pmcstat_log_initialize_logging();
1291
1292 /* Handle SIGINT using the kqueue loop */
1293 sa.sa_handler = SIG_IGN;
1294 sa.sa_flags = 0;
1295 (void) sigemptyset(&sa.sa_mask);
1296
1297 if (sigaction(SIGINT, &sa, NULL) < 0)
1298 err(EX_OSERR, "ERROR: Cannot install signal handler");
1299
1300 /*
1301 * Setup the top mode display.
1302 */
1303 if (args.pa_flags & FLAG_DO_TOP) {
1304 args.pa_flags &= ~FLAG_DO_PRINT;
1305
1306 if (args.pa_toptty) {
1307 /*
1308 * Init ncurses.
1309 */
1310 initscr();
1311 if(has_colors() == TRUE) {
1312 args.pa_topcolor = 1;
1313 start_color();
1314 use_default_colors();
1315 pair_content(0, &cf, &cb);
1316 init_pair(1, COLOR_RED, cb);
1317 init_pair(2, COLOR_YELLOW, cb);
1318 init_pair(3, COLOR_GREEN, cb);
1319 }
1320 cbreak();
1321 noecho();
1322 nonl();
1323 nodelay(stdscr, 1);
1324 intrflush(stdscr, FALSE);
1325 keypad(stdscr, TRUE);
1326 clear();
1327 /* Get terminal width / height with ncurses. */
1328 getmaxyx(stdscr,
1329 pmcstat_displayheight, pmcstat_displaywidth);
1330 pmcstat_displayheight--; pmcstat_displaywidth--;
1331 atexit(pmcstat_topexit);
1332 }
1333 }
1334
1335 /*
1336 * loop till either the target process (if any) exits, or we
1337 * are killed by a SIGINT or we reached the time duration.
1338 */
1339 runstate = PMCSTAT_RUNNING;
1340 do_print = do_read = 0;
1341 do {
1342 if ((c = kevent(pmcstat_kq, NULL, 0, &kev, 1, NULL)) <= 0) {
1343 if (errno != EINTR)
1344 err(EX_OSERR, "ERROR: kevent failed");
1345 else
1346 continue;
1347 }
1348
1349 if (kev.flags & EV_ERROR)
1350 errc(EX_OSERR, kev.data, "ERROR: kevent failed");
1351
1352 switch (kev.filter) {
1353 case EVFILT_PROC: /* target has exited */
1354 runstate = pmcstat_close_log(&args);
1355 do_print = 1;
1356 break;
1357
1358 case EVFILT_READ: /* log file data is present */
1359 if (kev.ident == (unsigned)fileno(stdin) &&
1360 (args.pa_flags & FLAG_DO_TOP)) {
1361 if (pmcstat_keypress_log())
1362 runstate = pmcstat_close_log(&args);
1363 } else {
1364 do_read = 0;
1365 runstate = pmcstat_process_log();
1366 }
1367 break;
1368
1369 case EVFILT_SIGNAL:
1370 if (kev.ident == SIGCHLD) {
1371 /*
1372 * The child process sends us a
1373 * SIGCHLD if its exec() failed. We
1374 * wait for it to exit and then exit
1375 * ourselves.
1376 */
1377 (void) wait(&c);
1378 runstate = PMCSTAT_FINISHED;
1379 } else if (kev.ident == SIGIO) {
1380 /*
1381 * We get a SIGIO if a PMC loses all
1382 * of its targets, or if logfile
1383 * writes encounter an error.
1384 */
1385 runstate = pmcstat_close_log(&args);
1386 do_print = 1; /* print PMCs at exit */
1387 } else if (kev.ident == SIGINT) {
1388 /* Kill the child process if we started it */
1389 if (args.pa_flags & FLAG_HAS_COMMANDLINE)
1390 pmcstat_kill_process();
1391 runstate = pmcstat_close_log(&args);
1392 } else if (kev.ident == SIGWINCH) {
1393 if (ioctl(fileno(args.pa_printfile),
1394 TIOCGWINSZ, &ws) < 0)
1395 err(EX_OSERR,
1396 "ERROR: Cannot determine window size");
1397 pmcstat_displayheight = ws.ws_row - 1;
1398 pmcstat_displaywidth = ws.ws_col - 1;
1399 } else
1400 assert(0);
1401
1402 break;
1403
1404 case EVFILT_TIMER:
1405 /* time duration reached, exit */
1406 if (args.pa_flags & FLAG_HAS_DURATION) {
1407 runstate = PMCSTAT_FINISHED;
1408 break;
1409 }
1410 /* print out counting PMCs */
1411 if ((args.pa_flags & FLAG_DO_TOP) &&
1412 (args.pa_flags & FLAG_HAS_PIPE) &&
1413 pmc_flush_logfile() == 0)
1414 do_read = 1;
1415 do_print = 1;
1416 break;
1417
1418 }
1419
1420 if (do_print && !do_read) {
1421 if ((args.pa_required & FLAG_HAS_OUTPUT_LOGFILE) == 0) {
1422 pmcstat_print_pmcs();
1423 if (runstate == PMCSTAT_FINISHED &&
1424 /* final newline */
1425 (args.pa_flags & FLAG_DO_PRINT) == 0)
1426 (void) fprintf(args.pa_printfile, "\n");
1427 }
1428 if (args.pa_flags & FLAG_DO_TOP)
1429 pmcstat_display_log();
1430 do_print = 0;
1431 }
1432
1433 } while (runstate != PMCSTAT_FINISHED);
1434
1435 if ((args.pa_flags & FLAG_DO_TOP) && args.pa_toptty) {
1436 pmcstat_topexit();
1437 args.pa_toptty = 0;
1438 }
1439
1440 /* flush any pending log entries */
1441 if (args.pa_flags & (FLAG_HAS_OUTPUT_LOGFILE | FLAG_HAS_PIPE))
1442 pmc_close_logfile();
1443
1444 pmcstat_cleanup();
1445
1446 /* check if the driver lost any samples or events */
1447 if (check_driver_stats) {
1448 if (pmc_get_driver_stats(&ds_end) < 0)
1449 err(EX_OSERR,
1450 "ERROR: Cannot retrieve driver statistics");
1451 if (ds_start.pm_intr_bufferfull != ds_end.pm_intr_bufferfull &&
1452 args.pa_verbosity > 0)
1453 warnx(
1454 "WARNING: sampling was paused at least %u time%s.\n"
1455 "Please consider tuning the \"kern.hwpmc.nsamples\" tunable.",
1456 ds_end.pm_intr_bufferfull -
1457 ds_start.pm_intr_bufferfull,
1458 ((ds_end.pm_intr_bufferfull -
1459 ds_start.pm_intr_bufferfull) != 1) ? "s" : ""
1460 );
1461 if (ds_start.pm_buffer_requests_failed !=
1462 ds_end.pm_buffer_requests_failed &&
1463 args.pa_verbosity > 0)
1464 warnx(
1465 "WARNING: at least %u event%s were discarded while running.\n"
1466 "Please consider tuning the \"kern.hwpmc.nbuffers_pcpu\" tunable.",
1467 ds_end.pm_buffer_requests_failed -
1468 ds_start.pm_buffer_requests_failed,
1469 ((ds_end.pm_buffer_requests_failed -
1470 ds_start.pm_buffer_requests_failed) != 1) ? "s" : ""
1471 );
1472 }
1473
1474 exit(EX_OK);
1475 }
1476