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