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
38 #include <sys/cdefs.h>
39 #include <sys/pmclog.h>
48 struct pmclog_ev_callchain {
53 uint32_t pl_cpuflags2;
55 uintfptr_t pl_pc[PMC_CALLCHAIN_DEPTH_MAX];
58 struct pmclog_ev_dropnotify {
61 struct pmclog_ev_closelog {
64 struct pmclog_ev_initialize {
68 struct timespec pl_ts;
69 char pl_cpuid[PATH_MAX];
72 struct pmclog_ev_map_in {
75 char pl_pathname[PATH_MAX];
78 struct pmclog_ev_map_out {
84 struct pmclog_ev_pcsample {
93 struct pmclog_ev_pmcallocate {
94 const char * pl_evname;
101 struct pmclog_ev_pmcallocatedyn {
102 char pl_evname[PMC_NAME_MAX];
108 struct pmclog_ev_pmcattach {
111 char pl_pathname[PATH_MAX];
114 struct pmclog_ev_pmcdetach {
119 struct pmclog_ev_proccsw {
123 pmc_value_t pl_value;
126 struct pmclog_ev_proccreate {
129 char pl_pcomm[MAXCOMLEN+1];
132 struct pmclog_ev_procexec {
135 uintfptr_t pl_entryaddr;
136 char pl_pathname[PATH_MAX];
139 struct pmclog_ev_procexit {
142 pmc_value_t pl_value;
145 struct pmclog_ev_procfork {
150 struct pmclog_ev_sysexit {
154 struct pmclog_ev_threadcreate {
158 char pl_tdname[MAXCOMLEN+1];
161 struct pmclog_ev_threadexit {
165 struct pmclog_ev_userdata {
166 uint32_t pl_userdata;
170 enum pmclog_state pl_state; /* state after 'get_event()' */
171 off_t pl_offset; /* byte offset in stream */
172 size_t pl_count; /* count of records so far */
173 struct timespec pl_ts; /* log entry timestamp */
174 enum pmclog_type pl_type; /* type of log entry */
177 union { /* log entry data */
178 struct pmclog_ev_callchain pl_cc;
179 struct pmclog_ev_closelog pl_cl;
180 struct pmclog_ev_dropnotify pl_dn;
181 struct pmclog_ev_initialize pl_i;
182 struct pmclog_ev_map_in pl_mi;
183 struct pmclog_ev_map_out pl_mo;
184 struct pmclog_ev_pmcallocate pl_a;
185 struct pmclog_ev_pmcallocatedyn pl_ad;
186 struct pmclog_ev_pmcattach pl_t;
187 struct pmclog_ev_pmcdetach pl_d;
188 struct pmclog_ev_proccsw pl_c;
189 struct pmclog_ev_proccreate pl_pc;
190 struct pmclog_ev_procexec pl_x;
191 struct pmclog_ev_procexit pl_e;
192 struct pmclog_ev_procfork pl_f;
193 struct pmclog_ev_sysexit pl_se;
194 struct pmclog_ev_threadcreate pl_tc;
195 struct pmclog_ev_threadexit pl_te;
196 struct pmclog_ev_userdata pl_u;
200 enum pmclog_parser_state {
201 PL_STATE_NEW_RECORD, /* in-between records */
202 PL_STATE_EXPECTING_HEADER, /* header being read */
203 PL_STATE_PARTIAL_RECORD, /* header present but not the record */
204 PL_STATE_ERROR /* parsing error encountered */
207 struct pmclog_parse_state {
208 enum pmclog_parser_state ps_state;
209 enum pmc_cputype ps_arch; /* log file architecture */
210 uint32_t ps_version; /* hwpmc version */
211 int ps_initialized; /* whether initialized */
212 int ps_count; /* count of records processed */
213 off_t ps_offset; /* stream byte offset */
214 union pmclog_entry ps_saved; /* saved partial log entry */
215 int ps_svcount; /* #bytes saved */
216 int ps_fd; /* active fd or -1 */
217 char *ps_buffer; /* scratch buffer if fd != -1 */
218 char *ps_data; /* current parse pointer */
219 char *ps_cpuid; /* log cpuid */
220 size_t ps_len; /* length of buffered data */
223 #define PMCLOG_FD_NONE (-1)
226 void *pmclog_open(int _fd);
227 int pmclog_feed(void *_cookie, char *_data, int _len);
228 int pmclog_read(void *_cookie, struct pmclog_ev *_ev);
229 void pmclog_close(void *_cookie);