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