1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/*-
* Copyright (c) 2005-2006, Joseph Koshy
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD: src/sys/sys/pmclog.h,v 1.4.8.1 2009/04/15 03:14:26 kensmith Exp $
*/
#ifndef _SYS_PMCLOG_H_
#define _SYS_PMCLOG_H_
#include <sys/pmc.h>
enum pmclog_type {
/* V1 ABI */
PMCLOG_TYPE_CLOSELOG,
PMCLOG_TYPE_DROPNOTIFY,
PMCLOG_TYPE_INITIALIZE,
PMCLOG_TYPE_MAPPINGCHANGE, /* unused in v1 */
PMCLOG_TYPE_PCSAMPLE,
PMCLOG_TYPE_PMCALLOCATE,
PMCLOG_TYPE_PMCATTACH,
PMCLOG_TYPE_PMCDETACH,
PMCLOG_TYPE_PROCCSW,
PMCLOG_TYPE_PROCEXEC,
PMCLOG_TYPE_PROCEXIT,
PMCLOG_TYPE_PROCFORK,
PMCLOG_TYPE_SYSEXIT,
PMCLOG_TYPE_USERDATA,
/*
* V2 ABI
*
* The MAP_{IN,OUT} event types obsolete the MAPPING_CHANGE
* event type of the older (V1) ABI.
*/
PMCLOG_TYPE_MAP_IN,
PMCLOG_TYPE_MAP_OUT
};
/*
* A log entry descriptor comprises of a 32 bit header and a 64 bit
* time stamp followed by as many 32 bit words are required to record
* the event.
*
* Header field format:
*
* 31 24 16 0
* +------------+------------+-----------------------------------+
* | MAGIC | TYPE | LENGTH |
* +------------+------------+-----------------------------------+
*
* MAGIC is the constant PMCLOG_HEADER_MAGIC.
* TYPE contains a value of type enum pmclog_type.
* LENGTH contains the length of the event record, in bytes.
*/
#define PMCLOG_ENTRY_HEADER \
uint32_t pl_header; \
uint32_t pl_ts_sec; \
uint32_t pl_ts_nsec;
/*
* The following structures are used to describe the size of each kind
* of log entry to sizeof(). To keep the compiler from adding
* padding, the fields of each structure are aligned to their natural
* boundaries, and the structures are marked as 'packed'.
*
* The actual reading and writing of the log file is always in terms
* of 4 byte quantities.
*/
struct pmclog_closelog {
PMCLOG_ENTRY_HEADER
};
struct pmclog_dropnotify {
PMCLOG_ENTRY_HEADER
};
struct pmclog_initialize {
PMCLOG_ENTRY_HEADER
uint32_t pl_version; /* driver version */
uint32_t pl_cpu; /* enum pmc_cputype */
} __packed;
struct pmclog_map_in {
PMCLOG_ENTRY_HEADER
uint32_t pl_pid;
uintfptr_t pl_start; /* 8 byte aligned */
char pl_pathname[PATH_MAX];
} __packed;
struct pmclog_map_out {
PMCLOG_ENTRY_HEADER
uint32_t pl_pid;
uintfptr_t pl_start; /* 8 byte aligned */
uintfptr_t pl_end;
} __packed;
struct pmclog_pcsample {
PMCLOG_ENTRY_HEADER
uint32_t pl_pid;
uintfptr_t pl_pc; /* 8 byte aligned */
uint32_t pl_pmcid;
uint32_t pl_usermode;
} __packed;
struct pmclog_pmcallocate {
PMCLOG_ENTRY_HEADER
uint32_t pl_pmcid;
uint32_t pl_event;
uint32_t pl_flags;
} __packed;
struct pmclog_pmcattach {
PMCLOG_ENTRY_HEADER
uint32_t pl_pmcid;
uint32_t pl_pid;
char pl_pathname[PATH_MAX];
} __packed;
struct pmclog_pmcdetach {
PMCLOG_ENTRY_HEADER
uint32_t pl_pmcid;
uint32_t pl_pid;
} __packed;
struct pmclog_proccsw {
PMCLOG_ENTRY_HEADER
uint32_t pl_pmcid;
uint64_t pl_value; /* keep 8 byte aligned */
uint32_t pl_pid;
} __packed;
struct pmclog_procexec {
PMCLOG_ENTRY_HEADER
uint32_t pl_pid;
uintfptr_t pl_start; /* keep 8 byte aligned */
uint32_t pl_pmcid;
char pl_pathname[PATH_MAX];
} __packed;
struct pmclog_procexit {
PMCLOG_ENTRY_HEADER
uint32_t pl_pmcid;
uint64_t pl_value; /* keep 8 byte aligned */
uint32_t pl_pid;
} __packed;
struct pmclog_procfork {
PMCLOG_ENTRY_HEADER
uint32_t pl_oldpid;
uint32_t pl_newpid;
} __packed;
struct pmclog_sysexit {
PMCLOG_ENTRY_HEADER
uint32_t pl_pid;
} __packed;
struct pmclog_userdata {
PMCLOG_ENTRY_HEADER
uint32_t pl_userdata;
} __packed;
union pmclog_entry { /* only used to size scratch areas */
struct pmclog_closelog pl_cl;
struct pmclog_dropnotify pl_dn;
struct pmclog_initialize pl_i;
struct pmclog_map_in pl_mi;
struct pmclog_map_out pl_mo;
struct pmclog_pcsample pl_s;
struct pmclog_pmcallocate pl_a;
struct pmclog_pmcattach pl_t;
struct pmclog_pmcdetach pl_d;
struct pmclog_proccsw pl_c;
struct pmclog_procexec pl_x;
struct pmclog_procexit pl_e;
struct pmclog_procfork pl_f;
struct pmclog_sysexit pl_se;
struct pmclog_userdata pl_u;
};
#define PMCLOG_HEADER_MAGIC 0xEEU
#define PMCLOG_HEADER_TO_LENGTH(H) \
((H) & 0x0000FFFF)
#define PMCLOG_HEADER_TO_TYPE(H) \
(((H) & 0x00FF0000) >> 16)
#define PMCLOG_HEADER_TO_MAGIC(H) \
(((H) & 0xFF000000) >> 24)
#define PMCLOG_HEADER_CHECK_MAGIC(H) \
(PMCLOG_HEADER_TO_MAGIC(H) == PMCLOG_HEADER_MAGIC)
#ifdef _KERNEL
/*
* Prototypes
*/
int pmclog_configure_log(struct pmc_owner *_po, int _logfd);
int pmclog_deconfigure_log(struct pmc_owner *_po);
int pmclog_flush(struct pmc_owner *_po);
void pmclog_initialize(void);
void pmclog_process_closelog(struct pmc_owner *po);
void pmclog_process_dropnotify(struct pmc_owner *po);
void pmclog_process_map_in(struct pmc_owner *po, pid_t pid,
uintfptr_t start, const char *path);
void pmclog_process_map_out(struct pmc_owner *po, pid_t pid,
uintfptr_t start, uintfptr_t end);
void pmclog_process_pcsample(struct pmc *_pm, struct pmc_sample *_ps);
void pmclog_process_pmcallocate(struct pmc *_pm);
void pmclog_process_pmcattach(struct pmc *_pm, pid_t _pid, char *_path);
void pmclog_process_pmcdetach(struct pmc *_pm, pid_t _pid);
void pmclog_process_proccsw(struct pmc *_pm, struct pmc_process *_pp,
pmc_value_t _v);
void pmclog_process_procexec(struct pmc_owner *_po, pmc_id_t _pmid, pid_t _pid,
uintfptr_t _startaddr, char *_path);
void pmclog_process_procexit(struct pmc *_pm, struct pmc_process *_pp);
void pmclog_process_procfork(struct pmc_owner *_po, pid_t _oldpid, pid_t _newpid);
void pmclog_process_sysexit(struct pmc_owner *_po, pid_t _pid);
int pmclog_process_userlog(struct pmc_owner *_po,
struct pmc_op_writelog *_wl);
void pmclog_shutdown(void);
#endif /* _KERNEL */
#endif /* _SYS_PMCLOG_H_ */
|