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_
42 PMCLOG_TYPE_CLOSELOG = 1,
43 PMCLOG_TYPE_DROPNOTIFY = 2,
44 PMCLOG_TYPE_INITIALIZE = 3,
45 PMCLOG_TYPE_MAPPINGCHANGE = 4, /* unused in v1 */
46 PMCLOG_TYPE_PMCALLOCATE = 5,
47 PMCLOG_TYPE_PMCATTACH = 6,
48 PMCLOG_TYPE_PMCDETACH = 7,
49 PMCLOG_TYPE_PROCCSW = 8,
50 PMCLOG_TYPE_PROCEXEC = 9,
51 PMCLOG_TYPE_PROCEXIT = 10,
52 PMCLOG_TYPE_PROCFORK = 11,
53 PMCLOG_TYPE_SYSEXIT = 12,
54 PMCLOG_TYPE_USERDATA = 13,
58 * The MAP_{IN,OUT} event types obsolete the MAPPING_CHANGE
59 * event type. The CALLCHAIN event type obsoletes the
60 * PCSAMPLE event type.
62 PMCLOG_TYPE_MAP_IN = 14,
63 PMCLOG_TYPE_MAP_OUT = 15,
64 PMCLOG_TYPE_CALLCHAIN = 16,
68 * New variant of PMCLOG_TYPE_PMCALLOCATE for dynamic event.
70 PMCLOG_TYPE_PMCALLOCATEDYN = 17,
74 PMCLOG_TYPE_THR_CREATE = 18,
75 PMCLOG_TYPE_THR_EXIT = 19,
76 PMCLOG_TYPE_PROC_CREATE = 20
80 * A log entry descriptor comprises of a 32 bit header and a 64 bit
81 * time stamp followed by as many 32 bit words are required to record
84 * Header field format:
87 * +------------+------------+-----------------------------------+
88 * | MAGIC | TYPE | LENGTH |
89 * +------------+------------+-----------------------------------+
91 * MAGIC is the constant PMCLOG_HEADER_MAGIC.
92 * TYPE contains a value of type enum pmclog_type.
93 * LENGTH contains the length of the event record, in bytes.
96 #define PMCLOG_ENTRY_HEADER \
103 * The following structures are used to describe the size of each kind
104 * of log entry to sizeof(). To keep the compiler from adding
105 * padding, the fields of each structure are aligned to their natural
106 * boundaries, and the structures are marked as 'packed'.
108 * The actual reading and writing of the log file is always in terms
109 * of 4 byte quantities.
112 struct pmclog_callchain {
117 uint32_t pl_cpuflags;
118 uint32_t pl_cpuflags2;
120 uintptr_t pl_pc[PMC_CALLCHAIN_DEPTH_MAX];
123 #define PMC_CALLCHAIN_CPUFLAGS_TO_CPU(CF) (((CF) >> 16) & 0xFFFF)
124 #define PMC_CALLCHAIN_CPUFLAGS_TO_USERMODE(CF) ((CF) & PMC_CC_F_USERSPACE)
125 #define PMC_CALLCHAIN_TO_CPUFLAGS(CPU,FLAGS) \
126 (((CPU) << 16) | ((FLAGS) & 0xFFFF))
128 struct pmclog_closelog {
133 struct pmclog_dropnotify {
138 struct pmclog_initialize {
140 uint32_t pl_version; /* driver version */
141 uint32_t pl_cpu; /* enum pmc_cputype */
143 char pl_cpuid[PMC_CPUID_LEN];
146 struct pmclog_map_in {
149 uintfptr_t pl_start; /* 8 byte aligned */
150 char pl_pathname[PATH_MAX];
153 struct pmclog_map_out {
156 uintfptr_t pl_start; /* 8 byte aligned */
160 struct pmclog_pmcallocate {
168 struct pmclog_pmcattach {
173 char pl_pathname[PATH_MAX];
176 struct pmclog_pmcdetach {
183 struct pmclog_proccsw {
186 uint64_t pl_value; /* keep 8 byte aligned */
191 struct pmclog_proccreate {
196 uint64_t pl_pcomm[MAXCOMLEN+1]; /* keep 8 byte aligned */
199 struct pmclog_procexec {
204 uintfptr_t pl_start; /* keep 8 byte aligned */
205 char pl_pathname[PATH_MAX];
208 struct pmclog_procexit {
213 uint64_t pl_value; /* keep 8 byte aligned */
216 struct pmclog_procfork {
223 struct pmclog_sysexit {
228 struct pmclog_threadcreate {
233 uint64_t pl_tdname[MAXCOMLEN+1]; /* keep 8 byte aligned */
236 struct pmclog_threadexit {
241 struct pmclog_userdata {
243 uint32_t pl_userdata;
246 struct pmclog_pmcallocatedyn {
251 char pl_evname[PMC_NAME_MAX];
254 union pmclog_entry { /* only used to size scratch areas */
255 struct pmclog_callchain pl_cc;
256 struct pmclog_closelog pl_cl;
257 struct pmclog_dropnotify pl_dn;
258 struct pmclog_initialize pl_i;
259 struct pmclog_map_in pl_mi;
260 struct pmclog_map_out pl_mo;
261 struct pmclog_pmcallocate pl_a;
262 struct pmclog_pmcallocatedyn pl_ad;
263 struct pmclog_pmcattach pl_t;
264 struct pmclog_pmcdetach pl_d;
265 struct pmclog_proccsw pl_c;
266 struct pmclog_procexec pl_x;
267 struct pmclog_procexit pl_e;
268 struct pmclog_procfork pl_f;
269 struct pmclog_sysexit pl_se;
270 struct pmclog_userdata pl_u;
273 #define PMCLOG_HEADER_MAGIC 0xEEU
275 #define PMCLOG_HEADER_TO_LENGTH(H) \
277 #define PMCLOG_HEADER_TO_TYPE(H) \
278 (((H) & 0x00FF0000) >> 16)
279 #define PMCLOG_HEADER_TO_MAGIC(H) \
280 (((H) & 0xFF000000) >> 24)
281 #define PMCLOG_HEADER_CHECK_MAGIC(H) \
282 (PMCLOG_HEADER_TO_MAGIC(H) == PMCLOG_HEADER_MAGIC)
289 int pmclog_configure_log(struct pmc_mdep *_md, struct pmc_owner *_po,
291 int pmclog_deconfigure_log(struct pmc_owner *_po);
292 int pmclog_flush(struct pmc_owner *_po, int force);
293 int pmclog_close(struct pmc_owner *_po);
294 void pmclog_initialize(void);
295 int pmclog_proc_create(struct thread *td, void **handlep);
296 void pmclog_proc_ignite(void *handle, struct pmc_owner *po);
297 void pmclog_process_callchain(struct pmc *_pm, struct pmc_sample *_ps);
298 void pmclog_process_closelog(struct pmc_owner *po);
299 void pmclog_process_dropnotify(struct pmc_owner *po);
300 void pmclog_process_map_in(struct pmc_owner *po, pid_t pid,
301 uintfptr_t start, const char *path);
302 void pmclog_process_map_out(struct pmc_owner *po, pid_t pid,
303 uintfptr_t start, uintfptr_t end);
304 void pmclog_process_pmcallocate(struct pmc *_pm);
305 void pmclog_process_pmcattach(struct pmc *_pm, pid_t _pid, char *_path);
306 void pmclog_process_pmcdetach(struct pmc *_pm, pid_t _pid);
307 void pmclog_process_proccsw(struct pmc *_pm, struct pmc_process *_pp,
308 pmc_value_t _v, struct thread *);
309 void pmclog_process_procexec(struct pmc_owner *_po, pmc_id_t _pmid, pid_t _pid,
310 uintfptr_t _startaddr, char *_path);
311 void pmclog_process_procexit(struct pmc *_pm, struct pmc_process *_pp);
312 void pmclog_process_procfork(struct pmc_owner *_po, pid_t _oldpid, pid_t _newpid);
313 void pmclog_process_sysexit(struct pmc_owner *_po, pid_t _pid);
314 void pmclog_process_threadcreate(struct pmc_owner *_po, struct thread *td, int sync);
315 void pmclog_process_threadexit(struct pmc_owner *_po, struct thread *td);
316 void pmclog_process_proccreate(struct pmc_owner *_po, struct proc *p, int sync);
317 int pmclog_process_userlog(struct pmc_owner *_po,
318 struct pmc_op_writelog *_wl);
319 void pmclog_shutdown(void);
322 #endif /* _SYS_PMCLOG_H_ */