xref: /freebsd/usr.sbin/pmc/pmc_util.c (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2003-2008, Joseph Koshy
5  * Copyright (c) 2007 The FreeBSD Foundation
6  * All rights reserved.
7  * Copyright (c) 2018, Matthew Macy
8  *
9  * Portions of this software were developed by A. Joseph Koshy under
10  * sponsorship from the FreeBSD Foundation and Google, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 #include <sys/param.h>
38 #include <sys/cpuset.h>
39 #include <sys/event.h>
40 #include <sys/queue.h>
41 #include <sys/socket.h>
42 #include <sys/stat.h>
43 #include <sys/sysctl.h>
44 #include <sys/time.h>
45 #include <sys/ttycom.h>
46 #include <sys/user.h>
47 #include <sys/wait.h>
48 
49 #include <assert.h>
50 #include <curses.h>
51 #include <err.h>
52 #include <errno.h>
53 #include <fcntl.h>
54 #include <getopt.h>
55 #include <kvm.h>
56 #include <libgen.h>
57 #include <limits.h>
58 #include <locale.h>
59 #include <math.h>
60 #include <pmc.h>
61 #include <pmclog.h>
62 #include <regex.h>
63 #include <signal.h>
64 #include <stdarg.h>
65 #include <stdint.h>
66 #include <stdio.h>
67 #include <stdlib.h>
68 #include <string.h>
69 #include <sysexits.h>
70 #include <unistd.h>
71 
72 #include <libpmcstat.h>
73 #include "cmd_pmc.h"
74 
75 static struct pmcstat_stats pmcstat_stats;	/* statistics */
76 
77 static struct pmc_plugins plugins[] = {
78 	{
79 		.pl_name = "none",
80 	},
81 	{
82 		.pl_name = NULL
83 	}
84 };
85 
86 int
87 pmc_util_get_pid(struct pmcstat_args *args)
88 {
89 	struct pmcstat_target *pt;
90 
91 	assert(args->pa_flags & FLAG_HAS_COMMANDLINE);
92 
93 	/*
94 	 * If a command line was specified, it would be the very first
95 	 * in the list, before any other processes specified by -t.
96 	 */
97 	pt = SLIST_FIRST(&args->pa_targets);
98 	return (pt->pt_pid);
99 }
100 
101 void
102 pmc_util_kill_process(struct pmcstat_args *args)
103 {
104 	struct pmcstat_target *pt;
105 
106 	assert(args->pa_flags & FLAG_HAS_COMMANDLINE);
107 
108 	/*
109 	 * If a command line was specified, it would be the very first
110 	 * in the list, before any other processes specified by -t.
111 	 */
112 	pt = SLIST_FIRST(&args->pa_targets);
113 	assert(pt != NULL);
114 
115 	if (kill(pt->pt_pid, SIGINT) != 0)
116 		err(EX_OSERR, "ERROR: cannot signal child process");
117 }
118 
119 void
120 pmc_util_shutdown_logging(struct pmcstat_args *args)
121 {
122 	pmcstat_shutdown_logging(args, plugins, &pmcstat_stats);
123 }
124 
125 void
126 pmc_util_cleanup(struct pmcstat_args *args)
127 {
128 	struct pmcstat_ev *ev;
129 
130 	/* release allocated PMCs. */
131 	STAILQ_FOREACH(ev, &args->pa_events, ev_next)
132 	    if (ev->ev_pmcid != PMC_ID_INVALID) {
133 		if (pmc_stop(ev->ev_pmcid) < 0)
134 			err(EX_OSERR,
135 			    "ERROR: cannot stop pmc 0x%x \"%s\"",
136 			    ev->ev_pmcid, ev->ev_name);
137 		if (pmc_release(ev->ev_pmcid) < 0)
138 			err(EX_OSERR,
139 			    "ERROR: cannot release pmc 0x%x \"%s\"",
140 			    ev->ev_pmcid, ev->ev_name);
141 	}
142 	/* de-configure the log file if present. */
143 	if (args->pa_flags & (FLAG_HAS_PIPE | FLAG_HAS_OUTPUT_LOGFILE))
144 		(void)pmc_configure_logfile(-1);
145 
146 	if (args->pa_logparser) {
147 		pmclog_close(args->pa_logparser);
148 		args->pa_logparser = NULL;
149 	}
150 	pmc_util_shutdown_logging(args);
151 }
152 
153 void
154 pmc_util_start_pmcs(struct pmcstat_args *args)
155 {
156 	struct pmcstat_ev *ev;
157 
158 	STAILQ_FOREACH(ev, &args->pa_events, ev_next) {
159 
160 		assert(ev->ev_pmcid != PMC_ID_INVALID);
161 
162 		if (pmc_start(ev->ev_pmcid) < 0) {
163 			warn("ERROR: Cannot start pmc 0x%x \"%s\"",
164 			    ev->ev_pmcid, ev->ev_name);
165 			pmc_util_cleanup(args);
166 			exit(EX_OSERR);
167 		}
168 	}
169 }
170