2 * Copyright (c) 2005-2006, Joseph Koshy
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifndef _SYS_PMCLOG_H_
30 #define _SYS_PMCLOG_H_
37 PMCLOG_TYPE_DROPNOTIFY,
38 PMCLOG_TYPE_INITIALIZE,
39 PMCLOG_TYPE_MAPPINGCHANGE, /* unused in v1 */
41 PMCLOG_TYPE_PMCALLOCATE,
42 PMCLOG_TYPE_PMCATTACH,
43 PMCLOG_TYPE_PMCDETACH,
53 * The MAP_{IN,OUT} event types obsolete the MAPPING_CHANGE
54 * event type of the older (V1) ABI.
61 * A log entry descriptor comprises of a 32 bit header and a 64 bit
62 * time stamp followed by as many 32 bit words are required to record
65 * Header field format:
68 * +------------+------------+-----------------------------------+
69 * | MAGIC | TYPE | LENGTH |
70 * +------------+------------+-----------------------------------+
72 * MAGIC is the constant PMCLOG_HEADER_MAGIC.
73 * TYPE contains a value of type enum pmclog_type.
74 * LENGTH contains the length of the event record, in bytes.
77 #define PMCLOG_ENTRY_HEADER \
84 * The following structures are used to describe the size of each kind
85 * of log entry to sizeof(). To keep the compiler from adding
86 * padding, the fields of each structure are aligned to their natural
87 * boundaries, and the structures are marked as 'packed'.
89 * The actual reading and writing of the log file is always in terms
90 * of 4 byte quantities.
93 struct pmclog_closelog {
97 struct pmclog_dropnotify {
101 struct pmclog_initialize {
103 uint32_t pl_version; /* driver version */
104 uint32_t pl_cpu; /* enum pmc_cputype */
107 struct pmclog_map_in {
110 uintfptr_t pl_start; /* 8 byte aligned */
111 char pl_pathname[PATH_MAX];
114 struct pmclog_map_out {
117 uintfptr_t pl_start; /* 8 byte aligned */
121 struct pmclog_pcsample {
124 uintfptr_t pl_pc; /* 8 byte aligned */
126 uint32_t pl_usermode;
129 struct pmclog_pmcallocate {
136 struct pmclog_pmcattach {
140 char pl_pathname[PATH_MAX];
143 struct pmclog_pmcdetach {
149 struct pmclog_proccsw {
152 uint64_t pl_value; /* keep 8 byte aligned */
156 struct pmclog_procexec {
159 uintfptr_t pl_start; /* keep 8 byte aligned */
161 char pl_pathname[PATH_MAX];
164 struct pmclog_procexit {
167 uint64_t pl_value; /* keep 8 byte aligned */
171 struct pmclog_procfork {
177 struct pmclog_sysexit {
182 struct pmclog_userdata {
184 uint32_t pl_userdata;
187 union pmclog_entry { /* only used to size scratch areas */
188 struct pmclog_closelog pl_cl;
189 struct pmclog_dropnotify pl_dn;
190 struct pmclog_initialize pl_i;
191 struct pmclog_map_in pl_mi;
192 struct pmclog_map_out pl_mo;
193 struct pmclog_pcsample pl_s;
194 struct pmclog_pmcallocate pl_a;
195 struct pmclog_pmcattach pl_t;
196 struct pmclog_pmcdetach pl_d;
197 struct pmclog_proccsw pl_c;
198 struct pmclog_procexec pl_x;
199 struct pmclog_procexit pl_e;
200 struct pmclog_procfork pl_f;
201 struct pmclog_sysexit pl_se;
202 struct pmclog_userdata pl_u;
205 #define PMCLOG_HEADER_MAGIC 0xEEU
207 #define PMCLOG_HEADER_TO_LENGTH(H) \
209 #define PMCLOG_HEADER_TO_TYPE(H) \
210 (((H) & 0x00FF0000) >> 16)
211 #define PMCLOG_HEADER_TO_MAGIC(H) \
212 (((H) & 0xFF000000) >> 24)
213 #define PMCLOG_HEADER_CHECK_MAGIC(H) \
214 (PMCLOG_HEADER_TO_MAGIC(H) == PMCLOG_HEADER_MAGIC)
221 int pmclog_configure_log(struct pmc_owner *_po, int _logfd);
222 int pmclog_deconfigure_log(struct pmc_owner *_po);
223 int pmclog_flush(struct pmc_owner *_po);
224 void pmclog_initialize(void);
225 void pmclog_process_closelog(struct pmc_owner *po);
226 void pmclog_process_dropnotify(struct pmc_owner *po);
227 void pmclog_process_map_in(struct pmc_owner *po, pid_t pid,
228 uintfptr_t start, const char *path);
229 void pmclog_process_map_out(struct pmc_owner *po, pid_t pid,
230 uintfptr_t start, uintfptr_t end);
231 void pmclog_process_pcsample(struct pmc *_pm, struct pmc_sample *_ps);
232 void pmclog_process_pmcallocate(struct pmc *_pm);
233 void pmclog_process_pmcattach(struct pmc *_pm, pid_t _pid, char *_path);
234 void pmclog_process_pmcdetach(struct pmc *_pm, pid_t _pid);
235 void pmclog_process_proccsw(struct pmc *_pm, struct pmc_process *_pp,
237 void pmclog_process_procexec(struct pmc_owner *_po, pmc_id_t _pmid, pid_t _pid,
238 uintfptr_t _startaddr, char *_path);
239 void pmclog_process_procexit(struct pmc *_pm, struct pmc_process *_pp);
240 void pmclog_process_procfork(struct pmc_owner *_po, pid_t _oldpid, pid_t _newpid);
241 void pmclog_process_sysexit(struct pmc_owner *_po, pid_t _pid);
242 int pmclog_process_userlog(struct pmc_owner *_po,
243 struct pmc_op_writelog *_wl);
244 void pmclog_shutdown(void);
247 #endif /* _SYS_PMCLOG_H_ */