1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2005-2007 Joseph Koshy 5 * Copyright (c) 2007 The FreeBSD Foundation 6 * All rights reserved. 7 * 8 * Portions of this software were developed by A. Joseph Koshy under 9 * sponsorship from the FreeBSD Foundation and Google, Inc. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 19 * 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 30 * SUCH DAMAGE. 31 * 32 * $FreeBSD$ 33 */ 34 35 #ifndef _PMCLOG_H_ 36 #define _PMCLOG_H_ 37 38 #include <sys/cdefs.h> 39 #include <sys/pmclog.h> 40 41 enum pmclog_state { 42 PMCLOG_OK, 43 PMCLOG_EOF, 44 PMCLOG_REQUIRE_DATA, 45 PMCLOG_ERROR 46 }; 47 48 struct pmclog_ev_callchain { 49 uint32_t pl_pid; 50 uint32_t pl_tid; 51 uint32_t pl_pmcid; 52 uint32_t pl_cpuflags; 53 uint32_t pl_cpuflags2; 54 uint32_t pl_npc; 55 uintfptr_t pl_pc[PMC_CALLCHAIN_DEPTH_MAX]; 56 }; 57 58 struct pmclog_ev_dropnotify { 59 }; 60 61 struct pmclog_ev_closelog { 62 }; 63 64 struct pmclog_ev_initialize { 65 uint32_t pl_version; 66 uint32_t pl_arch; 67 char pl_cpuid[PATH_MAX]; 68 }; 69 70 struct pmclog_ev_map_in { 71 pid_t pl_pid; 72 uintfptr_t pl_start; 73 char pl_pathname[PATH_MAX]; 74 }; 75 76 struct pmclog_ev_map_out { 77 pid_t pl_pid; 78 uintfptr_t pl_start; 79 uintfptr_t pl_end; 80 }; 81 82 struct pmclog_ev_pcsample { 83 uintfptr_t pl_pc; 84 pid_t pl_pid; 85 pid_t pl_tid; 86 pmc_id_t pl_pmcid; 87 uint32_t pl_flags; 88 uint32_t pl_usermode; 89 }; 90 91 struct pmclog_ev_pmcallocate { 92 const char * pl_evname; 93 uint64_t pl_rate; 94 uint32_t pl_event; 95 uint32_t pl_flags; 96 pmc_id_t pl_pmcid; 97 }; 98 99 struct pmclog_ev_pmcallocatedyn { 100 char pl_evname[PMC_NAME_MAX]; 101 uint32_t pl_event; 102 uint32_t pl_flags; 103 pmc_id_t pl_pmcid; 104 }; 105 106 struct pmclog_ev_pmcattach { 107 pmc_id_t pl_pmcid; 108 pid_t pl_pid; 109 char pl_pathname[PATH_MAX]; 110 }; 111 112 struct pmclog_ev_pmcdetach { 113 pmc_id_t pl_pmcid; 114 pid_t pl_pid; 115 }; 116 117 struct pmclog_ev_proccsw { 118 pid_t pl_pid; 119 pid_t pl_tid; 120 pmc_id_t pl_pmcid; 121 pmc_value_t pl_value; 122 }; 123 124 struct pmclog_ev_proccreate { 125 pid_t pl_pid; 126 uint32_t pl_flags; 127 char pl_pcomm[MAXCOMLEN+1]; 128 }; 129 130 struct pmclog_ev_procexec { 131 pid_t pl_pid; 132 pmc_id_t pl_pmcid; 133 uintfptr_t pl_entryaddr; 134 char pl_pathname[PATH_MAX]; 135 }; 136 137 struct pmclog_ev_procexit { 138 uint32_t pl_pid; 139 pmc_id_t pl_pmcid; 140 pmc_value_t pl_value; 141 }; 142 143 struct pmclog_ev_procfork { 144 pid_t pl_oldpid; 145 pid_t pl_newpid; 146 }; 147 148 struct pmclog_ev_sysexit { 149 pid_t pl_pid; 150 }; 151 152 struct pmclog_ev_threadcreate { 153 pid_t pl_tid; 154 pid_t pl_pid; 155 uint32_t pl_flags; 156 char pl_tdname[MAXCOMLEN+1]; 157 }; 158 159 struct pmclog_ev_threadexit { 160 pid_t pl_tid; 161 }; 162 163 struct pmclog_ev_userdata { 164 uint32_t pl_userdata; 165 }; 166 167 struct pmclog_ev { 168 enum pmclog_state pl_state; /* state after 'get_event()' */ 169 off_t pl_offset; /* byte offset in stream */ 170 size_t pl_count; /* count of records so far */ 171 struct timespec pl_ts; /* log entry timestamp */ 172 enum pmclog_type pl_type; /* type of log entry */ 173 void *pl_data; 174 int pl_len; 175 union { /* log entry data */ 176 struct pmclog_ev_callchain pl_cc; 177 struct pmclog_ev_closelog pl_cl; 178 struct pmclog_ev_dropnotify pl_dn; 179 struct pmclog_ev_initialize pl_i; 180 struct pmclog_ev_map_in pl_mi; 181 struct pmclog_ev_map_out pl_mo; 182 struct pmclog_ev_pmcallocate pl_a; 183 struct pmclog_ev_pmcallocatedyn pl_ad; 184 struct pmclog_ev_pmcattach pl_t; 185 struct pmclog_ev_pmcdetach pl_d; 186 struct pmclog_ev_proccsw pl_c; 187 struct pmclog_ev_proccreate pl_pc; 188 struct pmclog_ev_procexec pl_x; 189 struct pmclog_ev_procexit pl_e; 190 struct pmclog_ev_procfork pl_f; 191 struct pmclog_ev_sysexit pl_se; 192 struct pmclog_ev_threadcreate pl_tc; 193 struct pmclog_ev_threadexit pl_te; 194 struct pmclog_ev_userdata pl_u; 195 } pl_u; 196 }; 197 198 enum pmclog_parser_state { 199 PL_STATE_NEW_RECORD, /* in-between records */ 200 PL_STATE_EXPECTING_HEADER, /* header being read */ 201 PL_STATE_PARTIAL_RECORD, /* header present but not the record */ 202 PL_STATE_ERROR /* parsing error encountered */ 203 }; 204 205 struct pmclog_parse_state { 206 enum pmclog_parser_state ps_state; 207 enum pmc_cputype ps_arch; /* log file architecture */ 208 uint32_t ps_version; /* hwpmc version */ 209 int ps_initialized; /* whether initialized */ 210 int ps_count; /* count of records processed */ 211 off_t ps_offset; /* stream byte offset */ 212 union pmclog_entry ps_saved; /* saved partial log entry */ 213 int ps_svcount; /* #bytes saved */ 214 int ps_fd; /* active fd or -1 */ 215 char *ps_buffer; /* scratch buffer if fd != -1 */ 216 char *ps_data; /* current parse pointer */ 217 char *ps_cpuid; /* log cpuid */ 218 size_t ps_len; /* length of buffered data */ 219 }; 220 221 #define PMCLOG_FD_NONE (-1) 222 223 __BEGIN_DECLS 224 void *pmclog_open(int _fd); 225 int pmclog_feed(void *_cookie, char *_data, int _len); 226 int pmclog_read(void *_cookie, struct pmclog_ev *_ev); 227 void pmclog_close(void *_cookie); 228 __END_DECLS 229 230 #endif 231 232