2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2007, Joseph Koshy
5 * Copyright (c) 2007 The FreeBSD Foundation
8 * Portions of this software were developed by A. Joseph Koshy under
9 * sponsorship from the FreeBSD Foundation and Google, Inc.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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
35 #ifndef _SYS_PMCLOG_H_
36 #define _SYS_PMCLOG_H_
43 PMCLOG_TYPE_DROPNOTIFY,
44 PMCLOG_TYPE_INITIALIZE,
45 PMCLOG_TYPE_MAPPINGCHANGE, /* unused in v1 */
47 PMCLOG_TYPE_PMCALLOCATE,
48 PMCLOG_TYPE_PMCATTACH,
49 PMCLOG_TYPE_PMCDETACH,
59 * The MAP_{IN,OUT} event types obsolete the MAPPING_CHANGE
60 * event type. The CALLCHAIN event type obsoletes the
61 * PCSAMPLE event type.
65 PMCLOG_TYPE_CALLCHAIN,
69 * New variant of PMCLOG_TYPE_PMCALLOCATE for dynamic event.
71 PMCLOG_TYPE_PMCALLOCATEDYN
75 * A log entry descriptor comprises of a 32 bit header and a 64 bit
76 * time stamp followed by as many 32 bit words are required to record
79 * Header field format:
82 * +------------+------------+-----------------------------------+
83 * | MAGIC | TYPE | LENGTH |
84 * +------------+------------+-----------------------------------+
86 * MAGIC is the constant PMCLOG_HEADER_MAGIC.
87 * TYPE contains a value of type enum pmclog_type.
88 * LENGTH contains the length of the event record, in bytes.
91 #define PMCLOG_ENTRY_HEADER \
98 * The following structures are used to describe the size of each kind
99 * of log entry to sizeof(). To keep the compiler from adding
100 * padding, the fields of each structure are aligned to their natural
101 * boundaries, and the structures are marked as 'packed'.
103 * The actual reading and writing of the log file is always in terms
104 * of 4 byte quantities.
107 struct pmclog_callchain {
111 uint32_t pl_cpuflags;
113 uintptr_t pl_pc[PMC_CALLCHAIN_DEPTH_MAX];
116 #define PMC_CALLCHAIN_CPUFLAGS_TO_CPU(CF) (((CF) >> 16) & 0xFFFF)
117 #define PMC_CALLCHAIN_CPUFLAGS_TO_USERMODE(CF) ((CF) & PMC_CC_F_USERSPACE)
118 #define PMC_CALLCHAIN_TO_CPUFLAGS(CPU,FLAGS) \
119 (((CPU) << 16) | ((FLAGS) & 0xFFFF))
121 struct pmclog_closelog {
125 struct pmclog_dropnotify {
129 struct pmclog_initialize {
131 uint32_t pl_version; /* driver version */
132 uint32_t pl_cpu; /* enum pmc_cputype */
135 struct pmclog_map_in {
138 uintfptr_t pl_start; /* 8 byte aligned */
139 char pl_pathname[PATH_MAX];
142 struct pmclog_map_out {
145 uintfptr_t pl_start; /* 8 byte aligned */
149 struct pmclog_pcsample {
152 uintfptr_t pl_pc; /* 8 byte aligned */
154 uint32_t pl_usermode;
157 struct pmclog_pmcallocate {
164 struct pmclog_pmcattach {
168 char pl_pathname[PATH_MAX];
171 struct pmclog_pmcdetach {
177 struct pmclog_proccsw {
180 uint64_t pl_value; /* keep 8 byte aligned */
184 struct pmclog_procexec {
187 uintfptr_t pl_start; /* keep 8 byte aligned */
189 char pl_pathname[PATH_MAX];
192 struct pmclog_procexit {
195 uint64_t pl_value; /* keep 8 byte aligned */
199 struct pmclog_procfork {
205 struct pmclog_sysexit {
210 struct pmclog_userdata {
212 uint32_t pl_userdata;
215 struct pmclog_pmcallocatedyn {
220 char pl_evname[PMC_NAME_MAX];
223 union pmclog_entry { /* only used to size scratch areas */
224 struct pmclog_callchain pl_cc;
225 struct pmclog_closelog pl_cl;
226 struct pmclog_dropnotify pl_dn;
227 struct pmclog_initialize pl_i;
228 struct pmclog_map_in pl_mi;
229 struct pmclog_map_out pl_mo;
230 struct pmclog_pcsample pl_s;
231 struct pmclog_pmcallocate pl_a;
232 struct pmclog_pmcallocatedyn pl_ad;
233 struct pmclog_pmcattach pl_t;
234 struct pmclog_pmcdetach pl_d;
235 struct pmclog_proccsw pl_c;
236 struct pmclog_procexec pl_x;
237 struct pmclog_procexit pl_e;
238 struct pmclog_procfork pl_f;
239 struct pmclog_sysexit pl_se;
240 struct pmclog_userdata pl_u;
243 #define PMCLOG_HEADER_MAGIC 0xEEU
245 #define PMCLOG_HEADER_TO_LENGTH(H) \
247 #define PMCLOG_HEADER_TO_TYPE(H) \
248 (((H) & 0x00FF0000) >> 16)
249 #define PMCLOG_HEADER_TO_MAGIC(H) \
250 (((H) & 0xFF000000) >> 24)
251 #define PMCLOG_HEADER_CHECK_MAGIC(H) \
252 (PMCLOG_HEADER_TO_MAGIC(H) == PMCLOG_HEADER_MAGIC)
259 int pmclog_configure_log(struct pmc_mdep *_md, struct pmc_owner *_po,
261 int pmclog_deconfigure_log(struct pmc_owner *_po);
262 int pmclog_flush(struct pmc_owner *_po);
263 int pmclog_close(struct pmc_owner *_po);
264 void pmclog_initialize(void);
265 int pmclog_proc_create(struct thread *td, void **handlep);
266 void pmclog_proc_ignite(void *handle, struct pmc_owner *po);
267 void pmclog_process_callchain(struct pmc *_pm, struct pmc_sample *_ps);
268 void pmclog_process_closelog(struct pmc_owner *po);
269 void pmclog_process_dropnotify(struct pmc_owner *po);
270 void pmclog_process_map_in(struct pmc_owner *po, pid_t pid,
271 uintfptr_t start, const char *path);
272 void pmclog_process_map_out(struct pmc_owner *po, pid_t pid,
273 uintfptr_t start, uintfptr_t end);
274 void pmclog_process_pmcallocate(struct pmc *_pm);
275 void pmclog_process_pmcattach(struct pmc *_pm, pid_t _pid, char *_path);
276 void pmclog_process_pmcdetach(struct pmc *_pm, pid_t _pid);
277 void pmclog_process_proccsw(struct pmc *_pm, struct pmc_process *_pp,
279 void pmclog_process_procexec(struct pmc_owner *_po, pmc_id_t _pmid, pid_t _pid,
280 uintfptr_t _startaddr, char *_path);
281 void pmclog_process_procexit(struct pmc *_pm, struct pmc_process *_pp);
282 void pmclog_process_procfork(struct pmc_owner *_po, pid_t _oldpid, pid_t _newpid);
283 void pmclog_process_sysexit(struct pmc_owner *_po, pid_t _pid);
284 int pmclog_process_userlog(struct pmc_owner *_po,
285 struct pmc_op_writelog *_wl);
286 void pmclog_shutdown(void);
289 #endif /* _SYS_PMCLOG_H_ */