xref: /freebsd/usr.sbin/pmc/cmd_pmc_list.c (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2018, Matthew Macy
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  */
28 
29 #include <sys/param.h>
30 #include <sys/cpuset.h>
31 #include <sys/event.h>
32 #include <sys/queue.h>
33 #include <sys/socket.h>
34 #include <sys/stat.h>
35 #include <sys/sysctl.h>
36 #include <sys/time.h>
37 #include <sys/ttycom.h>
38 #include <sys/user.h>
39 #include <sys/wait.h>
40 
41 #include <assert.h>
42 #include <curses.h>
43 #include <err.h>
44 #include <errno.h>
45 #include <fcntl.h>
46 #include <getopt.h>
47 #include <kvm.h>
48 #include <libgen.h>
49 #include <limits.h>
50 #include <locale.h>
51 #include <math.h>
52 #include <pmc.h>
53 #include <pmclog.h>
54 #include <regex.h>
55 #include <signal.h>
56 #include <stdarg.h>
57 #include <stdint.h>
58 #include <stdio.h>
59 #include <stdlib.h>
60 #include <string.h>
61 #include <sysexits.h>
62 #include <unistd.h>
63 
64 #include <libpmcstat.h>
65 #include "cmd_pmc.h"
66 
67 
68 static struct option longopts[] = {
69 	{"long-desc", no_argument, NULL, 'U'},
70 	{"desc", no_argument, NULL, 'u'},
71 	{"full", no_argument, NULL, 'f'},
72 	{NULL, 0, NULL, 0}
73 };
74 
75 static void __dead2
76 usage(void)
77 {
78 	errx(EX_USAGE,
79 	    "\t list events\n"
80 	    "\t -u, desc -- short description of event\n"
81 	    "\t -U, long-desc -- long description of event\n"
82 	    "\t -f, full -- full event details\n"
83 	    );
84 }
85 
86 int
87 cmd_pmc_list_events(int argc, char **argv)
88 {
89 	int do_long_descr, do_descr, do_full;
90 	int option;
91 
92 	do_long_descr = do_descr = do_full = 0;
93 	while ((option = getopt_long(argc, argv, "Uuf", longopts, NULL)) != -1) {
94 		switch (option) {
95 		case 'U':
96 			do_long_descr = 1;
97 			break;
98 		case 'u':
99 			do_descr = 1;
100 			break;
101 		case 'f':
102 			do_full = 1;
103 			break;
104 		case '?':
105 		default:
106 			usage();
107 		}
108 	}
109 	argc -= optind;
110 	argv += optind;
111 	if ((do_long_descr | do_descr | do_full) && argc == 0) {
112 		warnx("event or event substring required when option provided\n");
113 		usage();
114 	}
115 	if (do_full)
116 		pmc_pmu_print_counter_full(argc ? argv[0] : NULL);
117 	else if (do_long_descr)
118 		pmc_pmu_print_counter_desc_long(argv[0]);
119 	else if (do_descr)
120 		pmc_pmu_print_counter_desc(argv[0]);
121 	else
122 		pmc_pmu_print_counters(argv[0]);
123 
124 	return (0);
125 }
126