Print this page
4471 DTrace count() with histogram
4472 DTrace full width distribution histograms
4473 DTrace frequency trails
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/uts/common/sys/dtrace.h
+++ new/usr/src/uts/common/sys/dtrace.h
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21
22 22 /*
23 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
24 24 * Use is subject to license terms.
25 25 */
26 26
27 27 /*
28 28 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
29 29 * Copyright (c) 2013 by Delphix. All rights reserved.
30 30 */
31 31
32 32 #ifndef _SYS_DTRACE_H
33 33 #define _SYS_DTRACE_H
34 34
35 35 #ifdef __cplusplus
36 36 extern "C" {
37 37 #endif
38 38
39 39 /*
40 40 * DTrace Dynamic Tracing Software: Kernel Interfaces
41 41 *
42 42 * Note: The contents of this file are private to the implementation of the
43 43 * Solaris system and DTrace subsystem and are subject to change at any time
44 44 * without notice. Applications and drivers using these interfaces will fail
45 45 * to run on future releases. These interfaces should not be used for any
46 46 * purpose except those expressly outlined in dtrace(7D) and libdtrace(3LIB).
47 47 * Please refer to the "Solaris Dynamic Tracing Guide" for more information.
48 48 */
49 49
50 50 #ifndef _ASM
51 51
52 52 #include <sys/types.h>
53 53 #include <sys/modctl.h>
54 54 #include <sys/processor.h>
55 55 #include <sys/systm.h>
56 56 #include <sys/ctf_api.h>
57 57 #include <sys/cyclic.h>
58 58 #include <sys/int_limits.h>
59 59
60 60 /*
61 61 * DTrace Universal Constants and Typedefs
62 62 */
63 63 #define DTRACE_CPUALL -1 /* all CPUs */
64 64 #define DTRACE_IDNONE 0 /* invalid probe identifier */
65 65 #define DTRACE_EPIDNONE 0 /* invalid enabled probe identifier */
66 66 #define DTRACE_AGGIDNONE 0 /* invalid aggregation identifier */
67 67 #define DTRACE_AGGVARIDNONE 0 /* invalid aggregation variable ID */
68 68 #define DTRACE_CACHEIDNONE 0 /* invalid predicate cache */
69 69 #define DTRACE_PROVNONE 0 /* invalid provider identifier */
70 70 #define DTRACE_METAPROVNONE 0 /* invalid meta-provider identifier */
71 71 #define DTRACE_ARGNONE -1 /* invalid argument index */
72 72
73 73 #define DTRACE_PROVNAMELEN 64
74 74 #define DTRACE_MODNAMELEN 64
75 75 #define DTRACE_FUNCNAMELEN 128
76 76 #define DTRACE_NAMELEN 64
77 77 #define DTRACE_FULLNAMELEN (DTRACE_PROVNAMELEN + DTRACE_MODNAMELEN + \
78 78 DTRACE_FUNCNAMELEN + DTRACE_NAMELEN + 4)
79 79 #define DTRACE_ARGTYPELEN 128
80 80
81 81 typedef uint32_t dtrace_id_t; /* probe identifier */
82 82 typedef uint32_t dtrace_epid_t; /* enabled probe identifier */
83 83 typedef uint32_t dtrace_aggid_t; /* aggregation identifier */
84 84 typedef int64_t dtrace_aggvarid_t; /* aggregation variable identifier */
85 85 typedef uint16_t dtrace_actkind_t; /* action kind */
86 86 typedef int64_t dtrace_optval_t; /* option value */
87 87 typedef uint32_t dtrace_cacheid_t; /* predicate cache identifier */
88 88
89 89 typedef enum dtrace_probespec {
90 90 DTRACE_PROBESPEC_NONE = -1,
91 91 DTRACE_PROBESPEC_PROVIDER = 0,
92 92 DTRACE_PROBESPEC_MOD,
93 93 DTRACE_PROBESPEC_FUNC,
94 94 DTRACE_PROBESPEC_NAME
95 95 } dtrace_probespec_t;
96 96
97 97 /*
98 98 * DTrace Intermediate Format (DIF)
99 99 *
100 100 * The following definitions describe the DTrace Intermediate Format (DIF), a
101 101 * a RISC-like instruction set and program encoding used to represent
102 102 * predicates and actions that can be bound to DTrace probes. The constants
103 103 * below defining the number of available registers are suggested minimums; the
104 104 * compiler should use DTRACEIOC_CONF to dynamically obtain the number of
105 105 * registers provided by the current DTrace implementation.
106 106 */
107 107 #define DIF_VERSION_1 1 /* DIF version 1: Solaris 10 Beta */
108 108 #define DIF_VERSION_2 2 /* DIF version 2: Solaris 10 FCS */
109 109 #define DIF_VERSION DIF_VERSION_2 /* latest DIF instruction set version */
110 110 #define DIF_DIR_NREGS 8 /* number of DIF integer registers */
111 111 #define DIF_DTR_NREGS 8 /* number of DIF tuple registers */
112 112
113 113 #define DIF_OP_OR 1 /* or r1, r2, rd */
114 114 #define DIF_OP_XOR 2 /* xor r1, r2, rd */
115 115 #define DIF_OP_AND 3 /* and r1, r2, rd */
116 116 #define DIF_OP_SLL 4 /* sll r1, r2, rd */
117 117 #define DIF_OP_SRL 5 /* srl r1, r2, rd */
118 118 #define DIF_OP_SUB 6 /* sub r1, r2, rd */
119 119 #define DIF_OP_ADD 7 /* add r1, r2, rd */
120 120 #define DIF_OP_MUL 8 /* mul r1, r2, rd */
121 121 #define DIF_OP_SDIV 9 /* sdiv r1, r2, rd */
122 122 #define DIF_OP_UDIV 10 /* udiv r1, r2, rd */
123 123 #define DIF_OP_SREM 11 /* srem r1, r2, rd */
124 124 #define DIF_OP_UREM 12 /* urem r1, r2, rd */
125 125 #define DIF_OP_NOT 13 /* not r1, rd */
126 126 #define DIF_OP_MOV 14 /* mov r1, rd */
127 127 #define DIF_OP_CMP 15 /* cmp r1, r2 */
128 128 #define DIF_OP_TST 16 /* tst r1 */
129 129 #define DIF_OP_BA 17 /* ba label */
130 130 #define DIF_OP_BE 18 /* be label */
131 131 #define DIF_OP_BNE 19 /* bne label */
132 132 #define DIF_OP_BG 20 /* bg label */
133 133 #define DIF_OP_BGU 21 /* bgu label */
134 134 #define DIF_OP_BGE 22 /* bge label */
135 135 #define DIF_OP_BGEU 23 /* bgeu label */
136 136 #define DIF_OP_BL 24 /* bl label */
137 137 #define DIF_OP_BLU 25 /* blu label */
138 138 #define DIF_OP_BLE 26 /* ble label */
139 139 #define DIF_OP_BLEU 27 /* bleu label */
140 140 #define DIF_OP_LDSB 28 /* ldsb [r1], rd */
141 141 #define DIF_OP_LDSH 29 /* ldsh [r1], rd */
142 142 #define DIF_OP_LDSW 30 /* ldsw [r1], rd */
143 143 #define DIF_OP_LDUB 31 /* ldub [r1], rd */
144 144 #define DIF_OP_LDUH 32 /* lduh [r1], rd */
145 145 #define DIF_OP_LDUW 33 /* lduw [r1], rd */
146 146 #define DIF_OP_LDX 34 /* ldx [r1], rd */
147 147 #define DIF_OP_RET 35 /* ret rd */
148 148 #define DIF_OP_NOP 36 /* nop */
149 149 #define DIF_OP_SETX 37 /* setx intindex, rd */
150 150 #define DIF_OP_SETS 38 /* sets strindex, rd */
151 151 #define DIF_OP_SCMP 39 /* scmp r1, r2 */
152 152 #define DIF_OP_LDGA 40 /* ldga var, ri, rd */
153 153 #define DIF_OP_LDGS 41 /* ldgs var, rd */
154 154 #define DIF_OP_STGS 42 /* stgs var, rs */
155 155 #define DIF_OP_LDTA 43 /* ldta var, ri, rd */
156 156 #define DIF_OP_LDTS 44 /* ldts var, rd */
157 157 #define DIF_OP_STTS 45 /* stts var, rs */
158 158 #define DIF_OP_SRA 46 /* sra r1, r2, rd */
159 159 #define DIF_OP_CALL 47 /* call subr, rd */
160 160 #define DIF_OP_PUSHTR 48 /* pushtr type, rs, rr */
161 161 #define DIF_OP_PUSHTV 49 /* pushtv type, rs, rv */
162 162 #define DIF_OP_POPTS 50 /* popts */
163 163 #define DIF_OP_FLUSHTS 51 /* flushts */
164 164 #define DIF_OP_LDGAA 52 /* ldgaa var, rd */
165 165 #define DIF_OP_LDTAA 53 /* ldtaa var, rd */
166 166 #define DIF_OP_STGAA 54 /* stgaa var, rs */
167 167 #define DIF_OP_STTAA 55 /* sttaa var, rs */
168 168 #define DIF_OP_LDLS 56 /* ldls var, rd */
169 169 #define DIF_OP_STLS 57 /* stls var, rs */
170 170 #define DIF_OP_ALLOCS 58 /* allocs r1, rd */
171 171 #define DIF_OP_COPYS 59 /* copys r1, r2, rd */
172 172 #define DIF_OP_STB 60 /* stb r1, [rd] */
173 173 #define DIF_OP_STH 61 /* sth r1, [rd] */
174 174 #define DIF_OP_STW 62 /* stw r1, [rd] */
175 175 #define DIF_OP_STX 63 /* stx r1, [rd] */
176 176 #define DIF_OP_ULDSB 64 /* uldsb [r1], rd */
177 177 #define DIF_OP_ULDSH 65 /* uldsh [r1], rd */
178 178 #define DIF_OP_ULDSW 66 /* uldsw [r1], rd */
179 179 #define DIF_OP_ULDUB 67 /* uldub [r1], rd */
180 180 #define DIF_OP_ULDUH 68 /* ulduh [r1], rd */
181 181 #define DIF_OP_ULDUW 69 /* ulduw [r1], rd */
182 182 #define DIF_OP_ULDX 70 /* uldx [r1], rd */
183 183 #define DIF_OP_RLDSB 71 /* rldsb [r1], rd */
184 184 #define DIF_OP_RLDSH 72 /* rldsh [r1], rd */
185 185 #define DIF_OP_RLDSW 73 /* rldsw [r1], rd */
186 186 #define DIF_OP_RLDUB 74 /* rldub [r1], rd */
187 187 #define DIF_OP_RLDUH 75 /* rlduh [r1], rd */
188 188 #define DIF_OP_RLDUW 76 /* rlduw [r1], rd */
189 189 #define DIF_OP_RLDX 77 /* rldx [r1], rd */
190 190 #define DIF_OP_XLATE 78 /* xlate xlrindex, rd */
191 191 #define DIF_OP_XLARG 79 /* xlarg xlrindex, rd */
192 192
193 193 #define DIF_INTOFF_MAX 0xffff /* highest integer table offset */
194 194 #define DIF_STROFF_MAX 0xffff /* highest string table offset */
195 195 #define DIF_REGISTER_MAX 0xff /* highest register number */
196 196 #define DIF_VARIABLE_MAX 0xffff /* highest variable identifier */
197 197 #define DIF_SUBROUTINE_MAX 0xffff /* highest subroutine code */
198 198
199 199 #define DIF_VAR_ARRAY_MIN 0x0000 /* lowest numbered array variable */
200 200 #define DIF_VAR_ARRAY_UBASE 0x0080 /* lowest user-defined array */
201 201 #define DIF_VAR_ARRAY_MAX 0x00ff /* highest numbered array variable */
202 202
203 203 #define DIF_VAR_OTHER_MIN 0x0100 /* lowest numbered scalar or assc */
204 204 #define DIF_VAR_OTHER_UBASE 0x0500 /* lowest user-defined scalar or assc */
205 205 #define DIF_VAR_OTHER_MAX 0xffff /* highest numbered scalar or assc */
206 206
207 207 #define DIF_VAR_ARGS 0x0000 /* arguments array */
208 208 #define DIF_VAR_REGS 0x0001 /* registers array */
209 209 #define DIF_VAR_UREGS 0x0002 /* user registers array */
210 210 #define DIF_VAR_VMREGS 0x0003 /* virtual machine registers array */
211 211 #define DIF_VAR_CURTHREAD 0x0100 /* thread pointer */
212 212 #define DIF_VAR_TIMESTAMP 0x0101 /* timestamp */
213 213 #define DIF_VAR_VTIMESTAMP 0x0102 /* virtual timestamp */
214 214 #define DIF_VAR_IPL 0x0103 /* interrupt priority level */
215 215 #define DIF_VAR_EPID 0x0104 /* enabled probe ID */
216 216 #define DIF_VAR_ID 0x0105 /* probe ID */
217 217 #define DIF_VAR_ARG0 0x0106 /* first argument */
218 218 #define DIF_VAR_ARG1 0x0107 /* second argument */
219 219 #define DIF_VAR_ARG2 0x0108 /* third argument */
220 220 #define DIF_VAR_ARG3 0x0109 /* fourth argument */
221 221 #define DIF_VAR_ARG4 0x010a /* fifth argument */
222 222 #define DIF_VAR_ARG5 0x010b /* sixth argument */
223 223 #define DIF_VAR_ARG6 0x010c /* seventh argument */
224 224 #define DIF_VAR_ARG7 0x010d /* eighth argument */
225 225 #define DIF_VAR_ARG8 0x010e /* ninth argument */
226 226 #define DIF_VAR_ARG9 0x010f /* tenth argument */
227 227 #define DIF_VAR_STACKDEPTH 0x0110 /* stack depth */
228 228 #define DIF_VAR_CALLER 0x0111 /* caller */
229 229 #define DIF_VAR_PROBEPROV 0x0112 /* probe provider */
230 230 #define DIF_VAR_PROBEMOD 0x0113 /* probe module */
231 231 #define DIF_VAR_PROBEFUNC 0x0114 /* probe function */
232 232 #define DIF_VAR_PROBENAME 0x0115 /* probe name */
233 233 #define DIF_VAR_PID 0x0116 /* process ID */
234 234 #define DIF_VAR_TID 0x0117 /* (per-process) thread ID */
235 235 #define DIF_VAR_EXECNAME 0x0118 /* name of executable */
236 236 #define DIF_VAR_ZONENAME 0x0119 /* zone name associated with process */
237 237 #define DIF_VAR_WALLTIMESTAMP 0x011a /* wall-clock timestamp */
238 238 #define DIF_VAR_USTACKDEPTH 0x011b /* user-land stack depth */
239 239 #define DIF_VAR_UCALLER 0x011c /* user-level caller */
240 240 #define DIF_VAR_PPID 0x011d /* parent process ID */
241 241 #define DIF_VAR_UID 0x011e /* process user ID */
242 242 #define DIF_VAR_GID 0x011f /* process group ID */
243 243 #define DIF_VAR_ERRNO 0x0120 /* thread errno */
244 244
245 245 #define DIF_SUBR_RAND 0
246 246 #define DIF_SUBR_MUTEX_OWNED 1
247 247 #define DIF_SUBR_MUTEX_OWNER 2
248 248 #define DIF_SUBR_MUTEX_TYPE_ADAPTIVE 3
249 249 #define DIF_SUBR_MUTEX_TYPE_SPIN 4
250 250 #define DIF_SUBR_RW_READ_HELD 5
251 251 #define DIF_SUBR_RW_WRITE_HELD 6
252 252 #define DIF_SUBR_RW_ISWRITER 7
253 253 #define DIF_SUBR_COPYIN 8
254 254 #define DIF_SUBR_COPYINSTR 9
255 255 #define DIF_SUBR_SPECULATION 10
256 256 #define DIF_SUBR_PROGENYOF 11
257 257 #define DIF_SUBR_STRLEN 12
258 258 #define DIF_SUBR_COPYOUT 13
259 259 #define DIF_SUBR_COPYOUTSTR 14
260 260 #define DIF_SUBR_ALLOCA 15
261 261 #define DIF_SUBR_BCOPY 16
262 262 #define DIF_SUBR_COPYINTO 17
263 263 #define DIF_SUBR_MSGDSIZE 18
264 264 #define DIF_SUBR_MSGSIZE 19
265 265 #define DIF_SUBR_GETMAJOR 20
266 266 #define DIF_SUBR_GETMINOR 21
267 267 #define DIF_SUBR_DDI_PATHNAME 22
268 268 #define DIF_SUBR_STRJOIN 23
269 269 #define DIF_SUBR_LLTOSTR 24
270 270 #define DIF_SUBR_BASENAME 25
271 271 #define DIF_SUBR_DIRNAME 26
272 272 #define DIF_SUBR_CLEANPATH 27
273 273 #define DIF_SUBR_STRCHR 28
274 274 #define DIF_SUBR_STRRCHR 29
275 275 #define DIF_SUBR_STRSTR 30
276 276 #define DIF_SUBR_STRTOK 31
277 277 #define DIF_SUBR_SUBSTR 32
278 278 #define DIF_SUBR_INDEX 33
279 279 #define DIF_SUBR_RINDEX 34
280 280 #define DIF_SUBR_HTONS 35
281 281 #define DIF_SUBR_HTONL 36
282 282 #define DIF_SUBR_HTONLL 37
283 283 #define DIF_SUBR_NTOHS 38
284 284 #define DIF_SUBR_NTOHL 39
285 285 #define DIF_SUBR_NTOHLL 40
286 286 #define DIF_SUBR_INET_NTOP 41
287 287 #define DIF_SUBR_INET_NTOA 42
288 288 #define DIF_SUBR_INET_NTOA6 43
289 289 #define DIF_SUBR_TOUPPER 44
290 290 #define DIF_SUBR_TOLOWER 45
291 291 #define DIF_SUBR_GETF 46
292 292 #define DIF_SUBR_JSON 47
293 293 #define DIF_SUBR_STRTOLL 48
294 294
295 295 #define DIF_SUBR_MAX 48 /* max subroutine value */
296 296
297 297 typedef uint32_t dif_instr_t;
298 298
299 299 #define DIF_INSTR_OP(i) (((i) >> 24) & 0xff)
300 300 #define DIF_INSTR_R1(i) (((i) >> 16) & 0xff)
301 301 #define DIF_INSTR_R2(i) (((i) >> 8) & 0xff)
302 302 #define DIF_INSTR_RD(i) ((i) & 0xff)
303 303 #define DIF_INSTR_RS(i) ((i) & 0xff)
304 304 #define DIF_INSTR_LABEL(i) ((i) & 0xffffff)
305 305 #define DIF_INSTR_VAR(i) (((i) >> 8) & 0xffff)
306 306 #define DIF_INSTR_INTEGER(i) (((i) >> 8) & 0xffff)
307 307 #define DIF_INSTR_STRING(i) (((i) >> 8) & 0xffff)
308 308 #define DIF_INSTR_SUBR(i) (((i) >> 8) & 0xffff)
309 309 #define DIF_INSTR_TYPE(i) (((i) >> 16) & 0xff)
310 310 #define DIF_INSTR_XLREF(i) (((i) >> 8) & 0xffff)
311 311
312 312 #define DIF_INSTR_FMT(op, r1, r2, d) \
313 313 (((op) << 24) | ((r1) << 16) | ((r2) << 8) | (d))
314 314
315 315 #define DIF_INSTR_NOT(r1, d) (DIF_INSTR_FMT(DIF_OP_NOT, r1, 0, d))
316 316 #define DIF_INSTR_MOV(r1, d) (DIF_INSTR_FMT(DIF_OP_MOV, r1, 0, d))
317 317 #define DIF_INSTR_CMP(op, r1, r2) (DIF_INSTR_FMT(op, r1, r2, 0))
318 318 #define DIF_INSTR_TST(r1) (DIF_INSTR_FMT(DIF_OP_TST, r1, 0, 0))
319 319 #define DIF_INSTR_BRANCH(op, label) (((op) << 24) | (label))
320 320 #define DIF_INSTR_LOAD(op, r1, d) (DIF_INSTR_FMT(op, r1, 0, d))
321 321 #define DIF_INSTR_STORE(op, r1, d) (DIF_INSTR_FMT(op, r1, 0, d))
322 322 #define DIF_INSTR_SETX(i, d) ((DIF_OP_SETX << 24) | ((i) << 8) | (d))
323 323 #define DIF_INSTR_SETS(s, d) ((DIF_OP_SETS << 24) | ((s) << 8) | (d))
324 324 #define DIF_INSTR_RET(d) (DIF_INSTR_FMT(DIF_OP_RET, 0, 0, d))
325 325 #define DIF_INSTR_NOP (DIF_OP_NOP << 24)
326 326 #define DIF_INSTR_LDA(op, v, r, d) (DIF_INSTR_FMT(op, v, r, d))
327 327 #define DIF_INSTR_LDV(op, v, d) (((op) << 24) | ((v) << 8) | (d))
328 328 #define DIF_INSTR_STV(op, v, rs) (((op) << 24) | ((v) << 8) | (rs))
329 329 #define DIF_INSTR_CALL(s, d) ((DIF_OP_CALL << 24) | ((s) << 8) | (d))
330 330 #define DIF_INSTR_PUSHTS(op, t, r2, rs) (DIF_INSTR_FMT(op, t, r2, rs))
331 331 #define DIF_INSTR_POPTS (DIF_OP_POPTS << 24)
332 332 #define DIF_INSTR_FLUSHTS (DIF_OP_FLUSHTS << 24)
333 333 #define DIF_INSTR_ALLOCS(r1, d) (DIF_INSTR_FMT(DIF_OP_ALLOCS, r1, 0, d))
334 334 #define DIF_INSTR_COPYS(r1, r2, d) (DIF_INSTR_FMT(DIF_OP_COPYS, r1, r2, d))
335 335 #define DIF_INSTR_XLATE(op, r, d) (((op) << 24) | ((r) << 8) | (d))
336 336
337 337 #define DIF_REG_R0 0 /* %r0 is always set to zero */
338 338
339 339 /*
340 340 * A DTrace Intermediate Format Type (DIF Type) is used to represent the types
341 341 * of variables, function and associative array arguments, and the return type
342 342 * for each DIF object (shown below). It contains a description of the type,
343 343 * its size in bytes, and a module identifier.
344 344 */
345 345 typedef struct dtrace_diftype {
346 346 uint8_t dtdt_kind; /* type kind (see below) */
347 347 uint8_t dtdt_ckind; /* type kind in CTF */
348 348 uint8_t dtdt_flags; /* type flags (see below) */
349 349 uint8_t dtdt_pad; /* reserved for future use */
350 350 uint32_t dtdt_size; /* type size in bytes (unless string) */
351 351 } dtrace_diftype_t;
352 352
353 353 #define DIF_TYPE_CTF 0 /* type is a CTF type */
354 354 #define DIF_TYPE_STRING 1 /* type is a D string */
355 355
356 356 #define DIF_TF_BYREF 0x1 /* type is passed by reference */
357 357 #define DIF_TF_BYUREF 0x2 /* user type is passed by reference */
358 358
359 359 /*
360 360 * A DTrace Intermediate Format variable record is used to describe each of the
361 361 * variables referenced by a given DIF object. It contains an integer variable
362 362 * identifier along with variable scope and properties, as shown below. The
363 363 * size of this structure must be sizeof (int) aligned.
364 364 */
365 365 typedef struct dtrace_difv {
366 366 uint32_t dtdv_name; /* variable name index in dtdo_strtab */
367 367 uint32_t dtdv_id; /* variable reference identifier */
368 368 uint8_t dtdv_kind; /* variable kind (see below) */
369 369 uint8_t dtdv_scope; /* variable scope (see below) */
370 370 uint16_t dtdv_flags; /* variable flags (see below) */
371 371 dtrace_diftype_t dtdv_type; /* variable type (see above) */
372 372 } dtrace_difv_t;
373 373
374 374 #define DIFV_KIND_ARRAY 0 /* variable is an array of quantities */
375 375 #define DIFV_KIND_SCALAR 1 /* variable is a scalar quantity */
376 376
377 377 #define DIFV_SCOPE_GLOBAL 0 /* variable has global scope */
378 378 #define DIFV_SCOPE_THREAD 1 /* variable has thread scope */
379 379 #define DIFV_SCOPE_LOCAL 2 /* variable has local scope */
380 380
381 381 #define DIFV_F_REF 0x1 /* variable is referenced by DIFO */
382 382 #define DIFV_F_MOD 0x2 /* variable is written by DIFO */
383 383
384 384 /*
385 385 * DTrace Actions
386 386 *
387 387 * The upper byte determines the class of the action; the low bytes determines
388 388 * the specific action within that class. The classes of actions are as
389 389 * follows:
390 390 *
391 391 * [ no class ] <= May record process- or kernel-related data
392 392 * DTRACEACT_PROC <= Only records process-related data
393 393 * DTRACEACT_PROC_DESTRUCTIVE <= Potentially destructive to processes
394 394 * DTRACEACT_KERNEL <= Only records kernel-related data
395 395 * DTRACEACT_KERNEL_DESTRUCTIVE <= Potentially destructive to the kernel
396 396 * DTRACEACT_SPECULATIVE <= Speculation-related action
397 397 * DTRACEACT_AGGREGATION <= Aggregating action
398 398 */
399 399 #define DTRACEACT_NONE 0 /* no action */
400 400 #define DTRACEACT_DIFEXPR 1 /* action is DIF expression */
401 401 #define DTRACEACT_EXIT 2 /* exit() action */
402 402 #define DTRACEACT_PRINTF 3 /* printf() action */
403 403 #define DTRACEACT_PRINTA 4 /* printa() action */
404 404 #define DTRACEACT_LIBACT 5 /* library-controlled action */
405 405 #define DTRACEACT_TRACEMEM 6 /* tracemem() action */
406 406 #define DTRACEACT_TRACEMEM_DYNSIZE 7 /* dynamic tracemem() size */
407 407
408 408 #define DTRACEACT_PROC 0x0100
409 409 #define DTRACEACT_USTACK (DTRACEACT_PROC + 1)
410 410 #define DTRACEACT_JSTACK (DTRACEACT_PROC + 2)
411 411 #define DTRACEACT_USYM (DTRACEACT_PROC + 3)
412 412 #define DTRACEACT_UMOD (DTRACEACT_PROC + 4)
413 413 #define DTRACEACT_UADDR (DTRACEACT_PROC + 5)
414 414
415 415 #define DTRACEACT_PROC_DESTRUCTIVE 0x0200
416 416 #define DTRACEACT_STOP (DTRACEACT_PROC_DESTRUCTIVE + 1)
417 417 #define DTRACEACT_RAISE (DTRACEACT_PROC_DESTRUCTIVE + 2)
418 418 #define DTRACEACT_SYSTEM (DTRACEACT_PROC_DESTRUCTIVE + 3)
419 419 #define DTRACEACT_FREOPEN (DTRACEACT_PROC_DESTRUCTIVE + 4)
420 420
421 421 #define DTRACEACT_PROC_CONTROL 0x0300
422 422
423 423 #define DTRACEACT_KERNEL 0x0400
424 424 #define DTRACEACT_STACK (DTRACEACT_KERNEL + 1)
425 425 #define DTRACEACT_SYM (DTRACEACT_KERNEL + 2)
426 426 #define DTRACEACT_MOD (DTRACEACT_KERNEL + 3)
427 427
428 428 #define DTRACEACT_KERNEL_DESTRUCTIVE 0x0500
429 429 #define DTRACEACT_BREAKPOINT (DTRACEACT_KERNEL_DESTRUCTIVE + 1)
430 430 #define DTRACEACT_PANIC (DTRACEACT_KERNEL_DESTRUCTIVE + 2)
431 431 #define DTRACEACT_CHILL (DTRACEACT_KERNEL_DESTRUCTIVE + 3)
432 432
433 433 #define DTRACEACT_SPECULATIVE 0x0600
434 434 #define DTRACEACT_SPECULATE (DTRACEACT_SPECULATIVE + 1)
435 435 #define DTRACEACT_COMMIT (DTRACEACT_SPECULATIVE + 2)
436 436 #define DTRACEACT_DISCARD (DTRACEACT_SPECULATIVE + 3)
437 437
438 438 #define DTRACEACT_CLASS(x) ((x) & 0xff00)
439 439
440 440 #define DTRACEACT_ISDESTRUCTIVE(x) \
441 441 (DTRACEACT_CLASS(x) == DTRACEACT_PROC_DESTRUCTIVE || \
442 442 DTRACEACT_CLASS(x) == DTRACEACT_KERNEL_DESTRUCTIVE)
443 443
444 444 #define DTRACEACT_ISSPECULATIVE(x) \
445 445 (DTRACEACT_CLASS(x) == DTRACEACT_SPECULATIVE)
446 446
447 447 #define DTRACEACT_ISPRINTFLIKE(x) \
448 448 ((x) == DTRACEACT_PRINTF || (x) == DTRACEACT_PRINTA || \
449 449 (x) == DTRACEACT_SYSTEM || (x) == DTRACEACT_FREOPEN)
450 450
451 451 /*
452 452 * DTrace Aggregating Actions
453 453 *
454 454 * These are functions f(x) for which the following is true:
455 455 *
456 456 * f(f(x_0) U f(x_1) U ... U f(x_n)) = f(x_0 U x_1 U ... U x_n)
457 457 *
458 458 * where x_n is a set of arbitrary data. Aggregating actions are in their own
459 459 * DTrace action class, DTTRACEACT_AGGREGATION. The macros provided here allow
460 460 * for easier processing of the aggregation argument and data payload for a few
461 461 * aggregating actions (notably: quantize(), lquantize(), and ustack()).
462 462 */
463 463 #define DTRACEACT_AGGREGATION 0x0700
464 464 #define DTRACEAGG_COUNT (DTRACEACT_AGGREGATION + 1)
465 465 #define DTRACEAGG_MIN (DTRACEACT_AGGREGATION + 2)
466 466 #define DTRACEAGG_MAX (DTRACEACT_AGGREGATION + 3)
467 467 #define DTRACEAGG_AVG (DTRACEACT_AGGREGATION + 4)
468 468 #define DTRACEAGG_SUM (DTRACEACT_AGGREGATION + 5)
469 469 #define DTRACEAGG_STDDEV (DTRACEACT_AGGREGATION + 6)
470 470 #define DTRACEAGG_QUANTIZE (DTRACEACT_AGGREGATION + 7)
471 471 #define DTRACEAGG_LQUANTIZE (DTRACEACT_AGGREGATION + 8)
472 472 #define DTRACEAGG_LLQUANTIZE (DTRACEACT_AGGREGATION + 9)
473 473
474 474 #define DTRACEACT_ISAGG(x) \
475 475 (DTRACEACT_CLASS(x) == DTRACEACT_AGGREGATION)
476 476
477 477 #define DTRACE_QUANTIZE_NBUCKETS \
478 478 (((sizeof (uint64_t) * NBBY) - 1) * 2 + 1)
479 479
480 480 #define DTRACE_QUANTIZE_ZEROBUCKET ((sizeof (uint64_t) * NBBY) - 1)
481 481
482 482 #define DTRACE_QUANTIZE_BUCKETVAL(buck) \
483 483 (int64_t)((buck) < DTRACE_QUANTIZE_ZEROBUCKET ? \
484 484 -(1LL << (DTRACE_QUANTIZE_ZEROBUCKET - 1 - (buck))) : \
485 485 (buck) == DTRACE_QUANTIZE_ZEROBUCKET ? 0 : \
486 486 1LL << ((buck) - DTRACE_QUANTIZE_ZEROBUCKET - 1))
487 487
488 488 #define DTRACE_LQUANTIZE_STEPSHIFT 48
489 489 #define DTRACE_LQUANTIZE_STEPMASK ((uint64_t)UINT16_MAX << 48)
490 490 #define DTRACE_LQUANTIZE_LEVELSHIFT 32
491 491 #define DTRACE_LQUANTIZE_LEVELMASK ((uint64_t)UINT16_MAX << 32)
492 492 #define DTRACE_LQUANTIZE_BASESHIFT 0
493 493 #define DTRACE_LQUANTIZE_BASEMASK UINT32_MAX
494 494
495 495 #define DTRACE_LQUANTIZE_STEP(x) \
496 496 (uint16_t)(((x) & DTRACE_LQUANTIZE_STEPMASK) >> \
497 497 DTRACE_LQUANTIZE_STEPSHIFT)
498 498
499 499 #define DTRACE_LQUANTIZE_LEVELS(x) \
500 500 (uint16_t)(((x) & DTRACE_LQUANTIZE_LEVELMASK) >> \
501 501 DTRACE_LQUANTIZE_LEVELSHIFT)
502 502
503 503 #define DTRACE_LQUANTIZE_BASE(x) \
504 504 (int32_t)(((x) & DTRACE_LQUANTIZE_BASEMASK) >> \
505 505 DTRACE_LQUANTIZE_BASESHIFT)
506 506
507 507 #define DTRACE_LLQUANTIZE_FACTORSHIFT 48
508 508 #define DTRACE_LLQUANTIZE_FACTORMASK ((uint64_t)UINT16_MAX << 48)
509 509 #define DTRACE_LLQUANTIZE_LOWSHIFT 32
510 510 #define DTRACE_LLQUANTIZE_LOWMASK ((uint64_t)UINT16_MAX << 32)
511 511 #define DTRACE_LLQUANTIZE_HIGHSHIFT 16
512 512 #define DTRACE_LLQUANTIZE_HIGHMASK ((uint64_t)UINT16_MAX << 16)
513 513 #define DTRACE_LLQUANTIZE_NSTEPSHIFT 0
514 514 #define DTRACE_LLQUANTIZE_NSTEPMASK UINT16_MAX
515 515
516 516 #define DTRACE_LLQUANTIZE_FACTOR(x) \
517 517 (uint16_t)(((x) & DTRACE_LLQUANTIZE_FACTORMASK) >> \
518 518 DTRACE_LLQUANTIZE_FACTORSHIFT)
519 519
520 520 #define DTRACE_LLQUANTIZE_LOW(x) \
521 521 (uint16_t)(((x) & DTRACE_LLQUANTIZE_LOWMASK) >> \
522 522 DTRACE_LLQUANTIZE_LOWSHIFT)
523 523
524 524 #define DTRACE_LLQUANTIZE_HIGH(x) \
525 525 (uint16_t)(((x) & DTRACE_LLQUANTIZE_HIGHMASK) >> \
526 526 DTRACE_LLQUANTIZE_HIGHSHIFT)
527 527
528 528 #define DTRACE_LLQUANTIZE_NSTEP(x) \
529 529 (uint16_t)(((x) & DTRACE_LLQUANTIZE_NSTEPMASK) >> \
530 530 DTRACE_LLQUANTIZE_NSTEPSHIFT)
531 531
532 532 #define DTRACE_USTACK_NFRAMES(x) (uint32_t)((x) & UINT32_MAX)
533 533 #define DTRACE_USTACK_STRSIZE(x) (uint32_t)((x) >> 32)
534 534 #define DTRACE_USTACK_ARG(x, y) \
535 535 ((((uint64_t)(y)) << 32) | ((x) & UINT32_MAX))
536 536
537 537 #ifndef _LP64
538 538 #ifndef _LITTLE_ENDIAN
539 539 #define DTRACE_PTR(type, name) uint32_t name##pad; type *name
540 540 #else
541 541 #define DTRACE_PTR(type, name) type *name; uint32_t name##pad
542 542 #endif
543 543 #else
544 544 #define DTRACE_PTR(type, name) type *name
545 545 #endif
546 546
547 547 /*
548 548 * DTrace Object Format (DOF)
549 549 *
550 550 * DTrace programs can be persistently encoded in the DOF format so that they
551 551 * may be embedded in other programs (for example, in an ELF file) or in the
552 552 * dtrace driver configuration file for use in anonymous tracing. The DOF
553 553 * format is versioned and extensible so that it can be revised and so that
554 554 * internal data structures can be modified or extended compatibly. All DOF
555 555 * structures use fixed-size types, so the 32-bit and 64-bit representations
556 556 * are identical and consumers can use either data model transparently.
557 557 *
558 558 * The file layout is structured as follows:
559 559 *
560 560 * +---------------+-------------------+----- ... ----+---- ... ------+
561 561 * | dof_hdr_t | dof_sec_t[ ... ] | loadable | non-loadable |
562 562 * | (file header) | (section headers) | section data | section data |
563 563 * +---------------+-------------------+----- ... ----+---- ... ------+
564 564 * |<------------ dof_hdr.dofh_loadsz --------------->| |
565 565 * |<------------ dof_hdr.dofh_filesz ------------------------------->|
566 566 *
567 567 * The file header stores meta-data including a magic number, data model for
568 568 * the instrumentation, data encoding, and properties of the DIF code within.
569 569 * The header describes its own size and the size of the section headers. By
570 570 * convention, an array of section headers follows the file header, and then
571 571 * the data for all loadable sections and unloadable sections. This permits
572 572 * consumer code to easily download the headers and all loadable data into the
573 573 * DTrace driver in one contiguous chunk, omitting other extraneous sections.
574 574 *
575 575 * The section headers describe the size, offset, alignment, and section type
576 576 * for each section. Sections are described using a set of #defines that tell
577 577 * the consumer what kind of data is expected. Sections can contain links to
578 578 * other sections by storing a dof_secidx_t, an index into the section header
579 579 * array, inside of the section data structures. The section header includes
580 580 * an entry size so that sections with data arrays can grow their structures.
581 581 *
582 582 * The DOF data itself can contain many snippets of DIF (i.e. >1 DIFOs), which
583 583 * are represented themselves as a collection of related DOF sections. This
584 584 * permits us to change the set of sections associated with a DIFO over time,
585 585 * and also permits us to encode DIFOs that contain different sets of sections.
586 586 * When a DOF section wants to refer to a DIFO, it stores the dof_secidx_t of a
587 587 * section of type DOF_SECT_DIFOHDR. This section's data is then an array of
588 588 * dof_secidx_t's which in turn denote the sections associated with this DIFO.
589 589 *
590 590 * This loose coupling of the file structure (header and sections) to the
591 591 * structure of the DTrace program itself (ECB descriptions, action
592 592 * descriptions, and DIFOs) permits activities such as relocation processing
593 593 * to occur in a single pass without having to understand D program structure.
594 594 *
595 595 * Finally, strings are always stored in ELF-style string tables along with a
596 596 * string table section index and string table offset. Therefore strings in
597 597 * DOF are always arbitrary-length and not bound to the current implementation.
598 598 */
599 599
600 600 #define DOF_ID_SIZE 16 /* total size of dofh_ident[] in bytes */
601 601
602 602 typedef struct dof_hdr {
603 603 uint8_t dofh_ident[DOF_ID_SIZE]; /* identification bytes (see below) */
604 604 uint32_t dofh_flags; /* file attribute flags (if any) */
605 605 uint32_t dofh_hdrsize; /* size of file header in bytes */
606 606 uint32_t dofh_secsize; /* size of section header in bytes */
607 607 uint32_t dofh_secnum; /* number of section headers */
608 608 uint64_t dofh_secoff; /* file offset of section headers */
609 609 uint64_t dofh_loadsz; /* file size of loadable portion */
610 610 uint64_t dofh_filesz; /* file size of entire DOF file */
611 611 uint64_t dofh_pad; /* reserved for future use */
612 612 } dof_hdr_t;
613 613
614 614 #define DOF_ID_MAG0 0 /* first byte of magic number */
615 615 #define DOF_ID_MAG1 1 /* second byte of magic number */
616 616 #define DOF_ID_MAG2 2 /* third byte of magic number */
617 617 #define DOF_ID_MAG3 3 /* fourth byte of magic number */
618 618 #define DOF_ID_MODEL 4 /* DOF data model (see below) */
619 619 #define DOF_ID_ENCODING 5 /* DOF data encoding (see below) */
620 620 #define DOF_ID_VERSION 6 /* DOF file format major version (see below) */
621 621 #define DOF_ID_DIFVERS 7 /* DIF instruction set version */
622 622 #define DOF_ID_DIFIREG 8 /* DIF integer registers used by compiler */
623 623 #define DOF_ID_DIFTREG 9 /* DIF tuple registers used by compiler */
624 624 #define DOF_ID_PAD 10 /* start of padding bytes (all zeroes) */
625 625
626 626 #define DOF_MAG_MAG0 0x7F /* DOF_ID_MAG[0-3] */
627 627 #define DOF_MAG_MAG1 'D'
628 628 #define DOF_MAG_MAG2 'O'
629 629 #define DOF_MAG_MAG3 'F'
630 630
631 631 #define DOF_MAG_STRING "\177DOF"
632 632 #define DOF_MAG_STRLEN 4
633 633
634 634 #define DOF_MODEL_NONE 0 /* DOF_ID_MODEL */
635 635 #define DOF_MODEL_ILP32 1
636 636 #define DOF_MODEL_LP64 2
637 637
638 638 #ifdef _LP64
639 639 #define DOF_MODEL_NATIVE DOF_MODEL_LP64
640 640 #else
641 641 #define DOF_MODEL_NATIVE DOF_MODEL_ILP32
642 642 #endif
643 643
644 644 #define DOF_ENCODE_NONE 0 /* DOF_ID_ENCODING */
645 645 #define DOF_ENCODE_LSB 1
646 646 #define DOF_ENCODE_MSB 2
647 647
648 648 #ifdef _BIG_ENDIAN
649 649 #define DOF_ENCODE_NATIVE DOF_ENCODE_MSB
650 650 #else
651 651 #define DOF_ENCODE_NATIVE DOF_ENCODE_LSB
652 652 #endif
653 653
654 654 #define DOF_VERSION_1 1 /* DOF version 1: Solaris 10 FCS */
655 655 #define DOF_VERSION_2 2 /* DOF version 2: Solaris Express 6/06 */
656 656 #define DOF_VERSION DOF_VERSION_2 /* Latest DOF version */
657 657
658 658 #define DOF_FL_VALID 0 /* mask of all valid dofh_flags bits */
659 659
660 660 typedef uint32_t dof_secidx_t; /* section header table index type */
661 661 typedef uint32_t dof_stridx_t; /* string table index type */
662 662
663 663 #define DOF_SECIDX_NONE (-1U) /* null value for section indices */
664 664 #define DOF_STRIDX_NONE (-1U) /* null value for string indices */
665 665
666 666 typedef struct dof_sec {
667 667 uint32_t dofs_type; /* section type (see below) */
668 668 uint32_t dofs_align; /* section data memory alignment */
669 669 uint32_t dofs_flags; /* section flags (if any) */
670 670 uint32_t dofs_entsize; /* size of section entry (if table) */
671 671 uint64_t dofs_offset; /* offset of section data within file */
672 672 uint64_t dofs_size; /* size of section data in bytes */
673 673 } dof_sec_t;
674 674
675 675 #define DOF_SECT_NONE 0 /* null section */
676 676 #define DOF_SECT_COMMENTS 1 /* compiler comments */
677 677 #define DOF_SECT_SOURCE 2 /* D program source code */
678 678 #define DOF_SECT_ECBDESC 3 /* dof_ecbdesc_t */
679 679 #define DOF_SECT_PROBEDESC 4 /* dof_probedesc_t */
680 680 #define DOF_SECT_ACTDESC 5 /* dof_actdesc_t array */
681 681 #define DOF_SECT_DIFOHDR 6 /* dof_difohdr_t (variable length) */
682 682 #define DOF_SECT_DIF 7 /* uint32_t array of byte code */
683 683 #define DOF_SECT_STRTAB 8 /* string table */
684 684 #define DOF_SECT_VARTAB 9 /* dtrace_difv_t array */
685 685 #define DOF_SECT_RELTAB 10 /* dof_relodesc_t array */
686 686 #define DOF_SECT_TYPTAB 11 /* dtrace_diftype_t array */
687 687 #define DOF_SECT_URELHDR 12 /* dof_relohdr_t (user relocations) */
688 688 #define DOF_SECT_KRELHDR 13 /* dof_relohdr_t (kernel relocations) */
689 689 #define DOF_SECT_OPTDESC 14 /* dof_optdesc_t array */
690 690 #define DOF_SECT_PROVIDER 15 /* dof_provider_t */
691 691 #define DOF_SECT_PROBES 16 /* dof_probe_t array */
692 692 #define DOF_SECT_PRARGS 17 /* uint8_t array (probe arg mappings) */
693 693 #define DOF_SECT_PROFFS 18 /* uint32_t array (probe arg offsets) */
694 694 #define DOF_SECT_INTTAB 19 /* uint64_t array */
695 695 #define DOF_SECT_UTSNAME 20 /* struct utsname */
696 696 #define DOF_SECT_XLTAB 21 /* dof_xlref_t array */
697 697 #define DOF_SECT_XLMEMBERS 22 /* dof_xlmember_t array */
698 698 #define DOF_SECT_XLIMPORT 23 /* dof_xlator_t */
699 699 #define DOF_SECT_XLEXPORT 24 /* dof_xlator_t */
700 700 #define DOF_SECT_PREXPORT 25 /* dof_secidx_t array (exported objs) */
701 701 #define DOF_SECT_PRENOFFS 26 /* uint32_t array (enabled offsets) */
702 702
703 703 #define DOF_SECF_LOAD 1 /* section should be loaded */
704 704
705 705 #define DOF_SEC_ISLOADABLE(x) \
706 706 (((x) == DOF_SECT_ECBDESC) || ((x) == DOF_SECT_PROBEDESC) || \
707 707 ((x) == DOF_SECT_ACTDESC) || ((x) == DOF_SECT_DIFOHDR) || \
708 708 ((x) == DOF_SECT_DIF) || ((x) == DOF_SECT_STRTAB) || \
709 709 ((x) == DOF_SECT_VARTAB) || ((x) == DOF_SECT_RELTAB) || \
710 710 ((x) == DOF_SECT_TYPTAB) || ((x) == DOF_SECT_URELHDR) || \
711 711 ((x) == DOF_SECT_KRELHDR) || ((x) == DOF_SECT_OPTDESC) || \
712 712 ((x) == DOF_SECT_PROVIDER) || ((x) == DOF_SECT_PROBES) || \
713 713 ((x) == DOF_SECT_PRARGS) || ((x) == DOF_SECT_PROFFS) || \
714 714 ((x) == DOF_SECT_INTTAB) || ((x) == DOF_SECT_XLTAB) || \
715 715 ((x) == DOF_SECT_XLMEMBERS) || ((x) == DOF_SECT_XLIMPORT) || \
716 716 ((x) == DOF_SECT_XLIMPORT) || ((x) == DOF_SECT_XLEXPORT) || \
717 717 ((x) == DOF_SECT_PREXPORT) || ((x) == DOF_SECT_PRENOFFS))
718 718
719 719 typedef struct dof_ecbdesc {
720 720 dof_secidx_t dofe_probes; /* link to DOF_SECT_PROBEDESC */
721 721 dof_secidx_t dofe_pred; /* link to DOF_SECT_DIFOHDR */
722 722 dof_secidx_t dofe_actions; /* link to DOF_SECT_ACTDESC */
723 723 uint32_t dofe_pad; /* reserved for future use */
724 724 uint64_t dofe_uarg; /* user-supplied library argument */
725 725 } dof_ecbdesc_t;
726 726
727 727 typedef struct dof_probedesc {
728 728 dof_secidx_t dofp_strtab; /* link to DOF_SECT_STRTAB section */
729 729 dof_stridx_t dofp_provider; /* provider string */
730 730 dof_stridx_t dofp_mod; /* module string */
731 731 dof_stridx_t dofp_func; /* function string */
732 732 dof_stridx_t dofp_name; /* name string */
733 733 uint32_t dofp_id; /* probe identifier (or zero) */
734 734 } dof_probedesc_t;
735 735
736 736 typedef struct dof_actdesc {
737 737 dof_secidx_t dofa_difo; /* link to DOF_SECT_DIFOHDR */
738 738 dof_secidx_t dofa_strtab; /* link to DOF_SECT_STRTAB section */
739 739 uint32_t dofa_kind; /* action kind (DTRACEACT_* constant) */
740 740 uint32_t dofa_ntuple; /* number of subsequent tuple actions */
741 741 uint64_t dofa_arg; /* kind-specific argument */
742 742 uint64_t dofa_uarg; /* user-supplied argument */
743 743 } dof_actdesc_t;
744 744
745 745 typedef struct dof_difohdr {
746 746 dtrace_diftype_t dofd_rtype; /* return type for this fragment */
747 747 dof_secidx_t dofd_links[1]; /* variable length array of indices */
748 748 } dof_difohdr_t;
749 749
750 750 typedef struct dof_relohdr {
751 751 dof_secidx_t dofr_strtab; /* link to DOF_SECT_STRTAB for names */
752 752 dof_secidx_t dofr_relsec; /* link to DOF_SECT_RELTAB for relos */
753 753 dof_secidx_t dofr_tgtsec; /* link to section we are relocating */
754 754 } dof_relohdr_t;
755 755
756 756 typedef struct dof_relodesc {
757 757 dof_stridx_t dofr_name; /* string name of relocation symbol */
758 758 uint32_t dofr_type; /* relo type (DOF_RELO_* constant) */
759 759 uint64_t dofr_offset; /* byte offset for relocation */
760 760 uint64_t dofr_data; /* additional type-specific data */
761 761 } dof_relodesc_t;
762 762
763 763 #define DOF_RELO_NONE 0 /* empty relocation entry */
764 764 #define DOF_RELO_SETX 1 /* relocate setx value */
765 765
766 766 typedef struct dof_optdesc {
767 767 uint32_t dofo_option; /* option identifier */
768 768 dof_secidx_t dofo_strtab; /* string table, if string option */
769 769 uint64_t dofo_value; /* option value or string index */
770 770 } dof_optdesc_t;
771 771
772 772 typedef uint32_t dof_attr_t; /* encoded stability attributes */
773 773
774 774 #define DOF_ATTR(n, d, c) (((n) << 24) | ((d) << 16) | ((c) << 8))
775 775 #define DOF_ATTR_NAME(a) (((a) >> 24) & 0xff)
776 776 #define DOF_ATTR_DATA(a) (((a) >> 16) & 0xff)
777 777 #define DOF_ATTR_CLASS(a) (((a) >> 8) & 0xff)
778 778
779 779 typedef struct dof_provider {
780 780 dof_secidx_t dofpv_strtab; /* link to DOF_SECT_STRTAB section */
781 781 dof_secidx_t dofpv_probes; /* link to DOF_SECT_PROBES section */
782 782 dof_secidx_t dofpv_prargs; /* link to DOF_SECT_PRARGS section */
783 783 dof_secidx_t dofpv_proffs; /* link to DOF_SECT_PROFFS section */
784 784 dof_stridx_t dofpv_name; /* provider name string */
785 785 dof_attr_t dofpv_provattr; /* provider attributes */
786 786 dof_attr_t dofpv_modattr; /* module attributes */
787 787 dof_attr_t dofpv_funcattr; /* function attributes */
788 788 dof_attr_t dofpv_nameattr; /* name attributes */
789 789 dof_attr_t dofpv_argsattr; /* args attributes */
790 790 dof_secidx_t dofpv_prenoffs; /* link to DOF_SECT_PRENOFFS section */
791 791 } dof_provider_t;
792 792
793 793 typedef struct dof_probe {
794 794 uint64_t dofpr_addr; /* probe base address or offset */
795 795 dof_stridx_t dofpr_func; /* probe function string */
796 796 dof_stridx_t dofpr_name; /* probe name string */
797 797 dof_stridx_t dofpr_nargv; /* native argument type strings */
798 798 dof_stridx_t dofpr_xargv; /* translated argument type strings */
799 799 uint32_t dofpr_argidx; /* index of first argument mapping */
800 800 uint32_t dofpr_offidx; /* index of first offset entry */
801 801 uint8_t dofpr_nargc; /* native argument count */
802 802 uint8_t dofpr_xargc; /* translated argument count */
803 803 uint16_t dofpr_noffs; /* number of offset entries for probe */
804 804 uint32_t dofpr_enoffidx; /* index of first is-enabled offset */
805 805 uint16_t dofpr_nenoffs; /* number of is-enabled offsets */
806 806 uint16_t dofpr_pad1; /* reserved for future use */
807 807 uint32_t dofpr_pad2; /* reserved for future use */
808 808 } dof_probe_t;
809 809
810 810 typedef struct dof_xlator {
811 811 dof_secidx_t dofxl_members; /* link to DOF_SECT_XLMEMBERS section */
812 812 dof_secidx_t dofxl_strtab; /* link to DOF_SECT_STRTAB section */
813 813 dof_stridx_t dofxl_argv; /* input parameter type strings */
814 814 uint32_t dofxl_argc; /* input parameter list length */
815 815 dof_stridx_t dofxl_type; /* output type string name */
816 816 dof_attr_t dofxl_attr; /* output stability attributes */
817 817 } dof_xlator_t;
818 818
819 819 typedef struct dof_xlmember {
820 820 dof_secidx_t dofxm_difo; /* member link to DOF_SECT_DIFOHDR */
821 821 dof_stridx_t dofxm_name; /* member name */
822 822 dtrace_diftype_t dofxm_type; /* member type */
823 823 } dof_xlmember_t;
824 824
825 825 typedef struct dof_xlref {
826 826 dof_secidx_t dofxr_xlator; /* link to DOF_SECT_XLATORS section */
827 827 uint32_t dofxr_member; /* index of referenced dof_xlmember */
828 828 uint32_t dofxr_argn; /* index of argument for DIF_OP_XLARG */
829 829 } dof_xlref_t;
830 830
831 831 /*
832 832 * DTrace Intermediate Format Object (DIFO)
833 833 *
834 834 * A DIFO is used to store the compiled DIF for a D expression, its return
835 835 * type, and its string and variable tables. The string table is a single
836 836 * buffer of character data into which sets instructions and variable
837 837 * references can reference strings using a byte offset. The variable table
838 838 * is an array of dtrace_difv_t structures that describe the name and type of
839 839 * each variable and the id used in the DIF code. This structure is described
840 840 * above in the DIF section of this header file. The DIFO is used at both
841 841 * user-level (in the library) and in the kernel, but the structure is never
842 842 * passed between the two: the DOF structures form the only interface. As a
843 843 * result, the definition can change depending on the presence of _KERNEL.
844 844 */
845 845 typedef struct dtrace_difo {
846 846 dif_instr_t *dtdo_buf; /* instruction buffer */
847 847 uint64_t *dtdo_inttab; /* integer table (optional) */
848 848 char *dtdo_strtab; /* string table (optional) */
849 849 dtrace_difv_t *dtdo_vartab; /* variable table (optional) */
850 850 uint_t dtdo_len; /* length of instruction buffer */
851 851 uint_t dtdo_intlen; /* length of integer table */
852 852 uint_t dtdo_strlen; /* length of string table */
853 853 uint_t dtdo_varlen; /* length of variable table */
854 854 dtrace_diftype_t dtdo_rtype; /* return type */
855 855 uint_t dtdo_refcnt; /* owner reference count */
856 856 uint_t dtdo_destructive; /* invokes destructive subroutines */
857 857 #ifndef _KERNEL
858 858 dof_relodesc_t *dtdo_kreltab; /* kernel relocations */
859 859 dof_relodesc_t *dtdo_ureltab; /* user relocations */
860 860 struct dt_node **dtdo_xlmtab; /* translator references */
861 861 uint_t dtdo_krelen; /* length of krelo table */
862 862 uint_t dtdo_urelen; /* length of urelo table */
863 863 uint_t dtdo_xlmlen; /* length of translator table */
864 864 #endif
865 865 } dtrace_difo_t;
866 866
867 867 /*
868 868 * DTrace Enabling Description Structures
869 869 *
870 870 * When DTrace is tracking the description of a DTrace enabling entity (probe,
871 871 * predicate, action, ECB, record, etc.), it does so in a description
872 872 * structure. These structures all end in "desc", and are used at both
873 873 * user-level and in the kernel -- but (with the exception of
874 874 * dtrace_probedesc_t) they are never passed between them. Typically,
875 875 * user-level will use the description structures when assembling an enabling.
876 876 * It will then distill those description structures into a DOF object (see
877 877 * above), and send it into the kernel. The kernel will again use the
878 878 * description structures to create a description of the enabling as it reads
879 879 * the DOF. When the description is complete, the enabling will be actually
880 880 * created -- turning it into the structures that represent the enabling
881 881 * instead of merely describing it. Not surprisingly, the description
882 882 * structures bear a strong resemblance to the DOF structures that act as their
883 883 * conduit.
884 884 */
885 885 struct dtrace_predicate;
886 886
887 887 typedef struct dtrace_probedesc {
888 888 dtrace_id_t dtpd_id; /* probe identifier */
889 889 char dtpd_provider[DTRACE_PROVNAMELEN]; /* probe provider name */
890 890 char dtpd_mod[DTRACE_MODNAMELEN]; /* probe module name */
891 891 char dtpd_func[DTRACE_FUNCNAMELEN]; /* probe function name */
892 892 char dtpd_name[DTRACE_NAMELEN]; /* probe name */
893 893 } dtrace_probedesc_t;
894 894
895 895 typedef struct dtrace_repldesc {
896 896 dtrace_probedesc_t dtrpd_match; /* probe descr. to match */
897 897 dtrace_probedesc_t dtrpd_create; /* probe descr. to create */
898 898 } dtrace_repldesc_t;
899 899
900 900 typedef struct dtrace_preddesc {
901 901 dtrace_difo_t *dtpdd_difo; /* pointer to DIF object */
902 902 struct dtrace_predicate *dtpdd_predicate; /* pointer to predicate */
903 903 } dtrace_preddesc_t;
904 904
905 905 typedef struct dtrace_actdesc {
906 906 dtrace_difo_t *dtad_difo; /* pointer to DIF object */
907 907 struct dtrace_actdesc *dtad_next; /* next action */
908 908 dtrace_actkind_t dtad_kind; /* kind of action */
909 909 uint32_t dtad_ntuple; /* number in tuple */
910 910 uint64_t dtad_arg; /* action argument */
911 911 uint64_t dtad_uarg; /* user argument */
912 912 int dtad_refcnt; /* reference count */
913 913 } dtrace_actdesc_t;
914 914
915 915 typedef struct dtrace_ecbdesc {
916 916 dtrace_actdesc_t *dted_action; /* action description(s) */
917 917 dtrace_preddesc_t dted_pred; /* predicate description */
918 918 dtrace_probedesc_t dted_probe; /* probe description */
919 919 uint64_t dted_uarg; /* library argument */
920 920 int dted_refcnt; /* reference count */
921 921 } dtrace_ecbdesc_t;
922 922
923 923 /*
924 924 * DTrace Metadata Description Structures
925 925 *
926 926 * DTrace separates the trace data stream from the metadata stream. The only
927 927 * metadata tokens placed in the data stream are the dtrace_rechdr_t (EPID +
928 928 * timestamp) or (in the case of aggregations) aggregation identifiers. To
929 929 * determine the structure of the data, DTrace consumers pass the token to the
930 930 * kernel, and receive in return a corresponding description of the enabled
931 931 * probe (via the dtrace_eprobedesc structure) or the aggregation (via the
932 932 * dtrace_aggdesc structure). Both of these structures are expressed in terms
933 933 * of record descriptions (via the dtrace_recdesc structure) that describe the
934 934 * exact structure of the data. Some record descriptions may also contain a
935 935 * format identifier; this additional bit of metadata can be retrieved from the
936 936 * kernel, for which a format description is returned via the dtrace_fmtdesc
937 937 * structure. Note that all four of these structures must be bitness-neutral
938 938 * to allow for a 32-bit DTrace consumer on a 64-bit kernel.
939 939 */
940 940 typedef struct dtrace_recdesc {
941 941 dtrace_actkind_t dtrd_action; /* kind of action */
942 942 uint32_t dtrd_size; /* size of record */
943 943 uint32_t dtrd_offset; /* offset in ECB's data */
944 944 uint16_t dtrd_alignment; /* required alignment */
945 945 uint16_t dtrd_format; /* format, if any */
946 946 uint64_t dtrd_arg; /* action argument */
947 947 uint64_t dtrd_uarg; /* user argument */
948 948 } dtrace_recdesc_t;
949 949
950 950 typedef struct dtrace_eprobedesc {
951 951 dtrace_epid_t dtepd_epid; /* enabled probe ID */
952 952 dtrace_id_t dtepd_probeid; /* probe ID */
953 953 uint64_t dtepd_uarg; /* library argument */
954 954 uint32_t dtepd_size; /* total size */
955 955 int dtepd_nrecs; /* number of records */
956 956 dtrace_recdesc_t dtepd_rec[1]; /* records themselves */
957 957 } dtrace_eprobedesc_t;
958 958
959 959 typedef struct dtrace_aggdesc {
960 960 DTRACE_PTR(char, dtagd_name); /* not filled in by kernel */
961 961 dtrace_aggvarid_t dtagd_varid; /* not filled in by kernel */
962 962 int dtagd_flags; /* not filled in by kernel */
963 963 dtrace_aggid_t dtagd_id; /* aggregation ID */
964 964 dtrace_epid_t dtagd_epid; /* enabled probe ID */
965 965 uint32_t dtagd_size; /* size in bytes */
966 966 int dtagd_nrecs; /* number of records */
967 967 uint32_t dtagd_pad; /* explicit padding */
968 968 dtrace_recdesc_t dtagd_rec[1]; /* record descriptions */
969 969 } dtrace_aggdesc_t;
970 970
971 971 typedef struct dtrace_fmtdesc {
972 972 DTRACE_PTR(char, dtfd_string); /* format string */
973 973 int dtfd_length; /* length of format string */
974 974 uint16_t dtfd_format; /* format identifier */
975 975 } dtrace_fmtdesc_t;
976 976
977 977 #define DTRACE_SIZEOF_EPROBEDESC(desc) \
978 978 (sizeof (dtrace_eprobedesc_t) + ((desc)->dtepd_nrecs ? \
979 979 (((desc)->dtepd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0))
980 980
981 981 #define DTRACE_SIZEOF_AGGDESC(desc) \
982 982 (sizeof (dtrace_aggdesc_t) + ((desc)->dtagd_nrecs ? \
983 983 (((desc)->dtagd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0))
984 984
985 985 /*
986 986 * DTrace Option Interface
987 987 *
988 988 * Run-time DTrace options are set and retrieved via DOF_SECT_OPTDESC sections
989 989 * in a DOF image. The dof_optdesc structure contains an option identifier and
990 990 * an option value. The valid option identifiers are found below; the mapping
991 991 * between option identifiers and option identifying strings is maintained at
992 992 * user-level. Note that the value of DTRACEOPT_UNSET is such that all of the
993 993 * following are potentially valid option values: all positive integers, zero
994 994 * and negative one. Some options (notably "bufpolicy" and "bufresize") take
995 995 * predefined tokens as their values; these are defined with
996 996 * DTRACEOPT_{option}_{token}.
997 997 */
998 998 #define DTRACEOPT_BUFSIZE 0 /* buffer size */
999 999 #define DTRACEOPT_BUFPOLICY 1 /* buffer policy */
1000 1000 #define DTRACEOPT_DYNVARSIZE 2 /* dynamic variable size */
1001 1001 #define DTRACEOPT_AGGSIZE 3 /* aggregation size */
1002 1002 #define DTRACEOPT_SPECSIZE 4 /* speculation size */
1003 1003 #define DTRACEOPT_NSPEC 5 /* number of speculations */
1004 1004 #define DTRACEOPT_STRSIZE 6 /* string size */
1005 1005 #define DTRACEOPT_CLEANRATE 7 /* dynvar cleaning rate */
1006 1006 #define DTRACEOPT_CPU 8 /* CPU to trace */
1007 1007 #define DTRACEOPT_BUFRESIZE 9 /* buffer resizing policy */
1008 1008 #define DTRACEOPT_GRABANON 10 /* grab anonymous state, if any */
1009 1009 #define DTRACEOPT_FLOWINDENT 11 /* indent function entry/return */
1010 1010 #define DTRACEOPT_QUIET 12 /* only output explicitly traced data */
1011 1011 #define DTRACEOPT_STACKFRAMES 13 /* number of stack frames */
1012 1012 #define DTRACEOPT_USTACKFRAMES 14 /* number of user stack frames */
1013 1013 #define DTRACEOPT_AGGRATE 15 /* aggregation snapshot rate */
1014 1014 #define DTRACEOPT_SWITCHRATE 16 /* buffer switching rate */
1015 1015 #define DTRACEOPT_STATUSRATE 17 /* status rate */
|
↓ open down ↓ |
1015 lines elided |
↑ open up ↑ |
1016 1016 #define DTRACEOPT_DESTRUCTIVE 18 /* destructive actions allowed */
1017 1017 #define DTRACEOPT_STACKINDENT 19 /* output indent for stack traces */
1018 1018 #define DTRACEOPT_RAWBYTES 20 /* always print bytes in raw form */
1019 1019 #define DTRACEOPT_JSTACKFRAMES 21 /* number of jstack() frames */
1020 1020 #define DTRACEOPT_JSTACKSTRSIZE 22 /* size of jstack() string table */
1021 1021 #define DTRACEOPT_AGGSORTKEY 23 /* sort aggregations by key */
1022 1022 #define DTRACEOPT_AGGSORTREV 24 /* reverse-sort aggregations */
1023 1023 #define DTRACEOPT_AGGSORTPOS 25 /* agg. position to sort on */
1024 1024 #define DTRACEOPT_AGGSORTKEYPOS 26 /* agg. key position to sort on */
1025 1025 #define DTRACEOPT_TEMPORAL 27 /* temporally ordered output */
1026 -#define DTRACEOPT_MAX 28 /* number of options */
1026 +#define DTRACEOPT_AGGHIST 28 /* histogram aggregation output */
1027 +#define DTRACEOPT_AGGPACK 29 /* packed aggregation output */
1028 +#define DTRACEOPT_AGGZOOM 30 /* zoomed aggregation scaling */
1029 +#define DTRACEOPT_ZONE 31 /* zone in which to enable probes */
1030 +#define DTRACEOPT_MAX 32 /* number of options */
1027 1031
1028 1032 #define DTRACEOPT_UNSET (dtrace_optval_t)-2 /* unset option */
1029 1033
1030 1034 #define DTRACEOPT_BUFPOLICY_RING 0 /* ring buffer */
1031 1035 #define DTRACEOPT_BUFPOLICY_FILL 1 /* fill buffer, then stop */
1032 1036 #define DTRACEOPT_BUFPOLICY_SWITCH 2 /* switch buffers */
1033 1037
1034 1038 #define DTRACEOPT_BUFRESIZE_AUTO 0 /* automatic resizing */
1035 1039 #define DTRACEOPT_BUFRESIZE_MANUAL 1 /* manual resizing */
1036 1040
1037 1041 /*
1038 1042 * DTrace Buffer Interface
1039 1043 *
1040 1044 * In order to get a snapshot of the principal or aggregation buffer,
1041 1045 * user-level passes a buffer description to the kernel with the dtrace_bufdesc
1042 1046 * structure. This describes which CPU user-level is interested in, and
1043 1047 * where user-level wishes the kernel to snapshot the buffer to (the
1044 1048 * dtbd_data field). The kernel uses the same structure to pass back some
1045 1049 * information regarding the buffer: the size of data actually copied out, the
1046 1050 * number of drops, the number of errors, the offset of the oldest record,
1047 1051 * and the time of the snapshot.
1048 1052 *
1049 1053 * If the buffer policy is a "switch" policy, taking a snapshot of the
1050 1054 * principal buffer has the additional effect of switching the active and
1051 1055 * inactive buffers. Taking a snapshot of the aggregation buffer _always_ has
1052 1056 * the additional effect of switching the active and inactive buffers.
1053 1057 */
1054 1058 typedef struct dtrace_bufdesc {
1055 1059 uint64_t dtbd_size; /* size of buffer */
1056 1060 uint32_t dtbd_cpu; /* CPU or DTRACE_CPUALL */
1057 1061 uint32_t dtbd_errors; /* number of errors */
1058 1062 uint64_t dtbd_drops; /* number of drops */
1059 1063 DTRACE_PTR(char, dtbd_data); /* data */
1060 1064 uint64_t dtbd_oldest; /* offset of oldest record */
1061 1065 uint64_t dtbd_timestamp; /* hrtime of snapshot */
1062 1066 } dtrace_bufdesc_t;
1063 1067
1064 1068 /*
1065 1069 * Each record in the buffer (dtbd_data) begins with a header that includes
1066 1070 * the epid and a timestamp. The timestamp is split into two 4-byte parts
1067 1071 * so that we do not require 8-byte alignment.
1068 1072 */
1069 1073 typedef struct dtrace_rechdr {
1070 1074 dtrace_epid_t dtrh_epid; /* enabled probe id */
1071 1075 uint32_t dtrh_timestamp_hi; /* high bits of hrtime_t */
1072 1076 uint32_t dtrh_timestamp_lo; /* low bits of hrtime_t */
1073 1077 } dtrace_rechdr_t;
1074 1078
1075 1079 #define DTRACE_RECORD_LOAD_TIMESTAMP(dtrh) \
1076 1080 ((dtrh)->dtrh_timestamp_lo + \
1077 1081 ((uint64_t)(dtrh)->dtrh_timestamp_hi << 32))
1078 1082
1079 1083 #define DTRACE_RECORD_STORE_TIMESTAMP(dtrh, hrtime) { \
1080 1084 (dtrh)->dtrh_timestamp_lo = (uint32_t)hrtime; \
1081 1085 (dtrh)->dtrh_timestamp_hi = hrtime >> 32; \
1082 1086 }
1083 1087
1084 1088 /*
1085 1089 * DTrace Status
1086 1090 *
1087 1091 * The status of DTrace is relayed via the dtrace_status structure. This
1088 1092 * structure contains members to count drops other than the capacity drops
1089 1093 * available via the buffer interface (see above). This consists of dynamic
1090 1094 * drops (including capacity dynamic drops, rinsing drops and dirty drops), and
1091 1095 * speculative drops (including capacity speculative drops, drops due to busy
1092 1096 * speculative buffers and drops due to unavailable speculative buffers).
1093 1097 * Additionally, the status structure contains a field to indicate the number
1094 1098 * of "fill"-policy buffers have been filled and a boolean field to indicate
1095 1099 * that exit() has been called. If the dtst_exiting field is non-zero, no
1096 1100 * further data will be generated until tracing is stopped (at which time any
1097 1101 * enablings of the END action will be processed); if user-level sees that
1098 1102 * this field is non-zero, tracing should be stopped as soon as possible.
1099 1103 */
1100 1104 typedef struct dtrace_status {
1101 1105 uint64_t dtst_dyndrops; /* dynamic drops */
1102 1106 uint64_t dtst_dyndrops_rinsing; /* dyn drops due to rinsing */
1103 1107 uint64_t dtst_dyndrops_dirty; /* dyn drops due to dirty */
1104 1108 uint64_t dtst_specdrops; /* speculative drops */
1105 1109 uint64_t dtst_specdrops_busy; /* spec drops due to busy */
1106 1110 uint64_t dtst_specdrops_unavail; /* spec drops due to unavail */
1107 1111 uint64_t dtst_errors; /* total errors */
1108 1112 uint64_t dtst_filled; /* number of filled bufs */
1109 1113 uint64_t dtst_stkstroverflows; /* stack string tab overflows */
1110 1114 uint64_t dtst_dblerrors; /* errors in ERROR probes */
1111 1115 char dtst_killed; /* non-zero if killed */
1112 1116 char dtst_exiting; /* non-zero if exit() called */
1113 1117 char dtst_pad[6]; /* pad out to 64-bit align */
1114 1118 } dtrace_status_t;
1115 1119
1116 1120 /*
1117 1121 * DTrace Configuration
1118 1122 *
1119 1123 * User-level may need to understand some elements of the kernel DTrace
1120 1124 * configuration in order to generate correct DIF. This information is
1121 1125 * conveyed via the dtrace_conf structure.
1122 1126 */
1123 1127 typedef struct dtrace_conf {
1124 1128 uint_t dtc_difversion; /* supported DIF version */
1125 1129 uint_t dtc_difintregs; /* # of DIF integer registers */
1126 1130 uint_t dtc_diftupregs; /* # of DIF tuple registers */
1127 1131 uint_t dtc_ctfmodel; /* CTF data model */
1128 1132 uint_t dtc_pad[8]; /* reserved for future use */
1129 1133 } dtrace_conf_t;
1130 1134
1131 1135 /*
1132 1136 * DTrace Faults
1133 1137 *
1134 1138 * The constants below DTRACEFLT_LIBRARY indicate probe processing faults;
1135 1139 * constants at or above DTRACEFLT_LIBRARY indicate faults in probe
1136 1140 * postprocessing at user-level. Probe processing faults induce an ERROR
1137 1141 * probe and are replicated in unistd.d to allow users' ERROR probes to decode
1138 1142 * the error condition using thse symbolic labels.
1139 1143 */
1140 1144 #define DTRACEFLT_UNKNOWN 0 /* Unknown fault */
1141 1145 #define DTRACEFLT_BADADDR 1 /* Bad address */
1142 1146 #define DTRACEFLT_BADALIGN 2 /* Bad alignment */
1143 1147 #define DTRACEFLT_ILLOP 3 /* Illegal operation */
1144 1148 #define DTRACEFLT_DIVZERO 4 /* Divide-by-zero */
1145 1149 #define DTRACEFLT_NOSCRATCH 5 /* Out of scratch space */
1146 1150 #define DTRACEFLT_KPRIV 6 /* Illegal kernel access */
1147 1151 #define DTRACEFLT_UPRIV 7 /* Illegal user access */
1148 1152 #define DTRACEFLT_TUPOFLOW 8 /* Tuple stack overflow */
1149 1153 #define DTRACEFLT_BADSTACK 9 /* Bad stack */
1150 1154
1151 1155 #define DTRACEFLT_LIBRARY 1000 /* Library-level fault */
1152 1156
1153 1157 /*
1154 1158 * DTrace Argument Types
1155 1159 *
1156 1160 * Because it would waste both space and time, argument types do not reside
1157 1161 * with the probe. In order to determine argument types for args[X]
1158 1162 * variables, the D compiler queries for argument types on a probe-by-probe
1159 1163 * basis. (This optimizes for the common case that arguments are either not
1160 1164 * used or used in an untyped fashion.) Typed arguments are specified with a
1161 1165 * string of the type name in the dtragd_native member of the argument
1162 1166 * description structure. Typed arguments may be further translated to types
1163 1167 * of greater stability; the provider indicates such a translated argument by
1164 1168 * filling in the dtargd_xlate member with the string of the translated type.
1165 1169 * Finally, the provider may indicate which argument value a given argument
1166 1170 * maps to by setting the dtargd_mapping member -- allowing a single argument
1167 1171 * to map to multiple args[X] variables.
1168 1172 */
1169 1173 typedef struct dtrace_argdesc {
1170 1174 dtrace_id_t dtargd_id; /* probe identifier */
1171 1175 int dtargd_ndx; /* arg number (-1 iff none) */
1172 1176 int dtargd_mapping; /* value mapping */
1173 1177 char dtargd_native[DTRACE_ARGTYPELEN]; /* native type name */
1174 1178 char dtargd_xlate[DTRACE_ARGTYPELEN]; /* translated type name */
1175 1179 } dtrace_argdesc_t;
1176 1180
1177 1181 /*
1178 1182 * DTrace Stability Attributes
1179 1183 *
1180 1184 * Each DTrace provider advertises the name and data stability of each of its
1181 1185 * probe description components, as well as its architectural dependencies.
1182 1186 * The D compiler can query the provider attributes (dtrace_pattr_t below) in
1183 1187 * order to compute the properties of an input program and report them.
1184 1188 */
1185 1189 typedef uint8_t dtrace_stability_t; /* stability code (see attributes(5)) */
1186 1190 typedef uint8_t dtrace_class_t; /* architectural dependency class */
1187 1191
1188 1192 #define DTRACE_STABILITY_INTERNAL 0 /* private to DTrace itself */
1189 1193 #define DTRACE_STABILITY_PRIVATE 1 /* private to Sun (see docs) */
1190 1194 #define DTRACE_STABILITY_OBSOLETE 2 /* scheduled for removal */
1191 1195 #define DTRACE_STABILITY_EXTERNAL 3 /* not controlled by Sun */
1192 1196 #define DTRACE_STABILITY_UNSTABLE 4 /* new or rapidly changing */
1193 1197 #define DTRACE_STABILITY_EVOLVING 5 /* less rapidly changing */
1194 1198 #define DTRACE_STABILITY_STABLE 6 /* mature interface from Sun */
1195 1199 #define DTRACE_STABILITY_STANDARD 7 /* industry standard */
1196 1200 #define DTRACE_STABILITY_MAX 7 /* maximum valid stability */
1197 1201
1198 1202 #define DTRACE_CLASS_UNKNOWN 0 /* unknown architectural dependency */
1199 1203 #define DTRACE_CLASS_CPU 1 /* CPU-module-specific */
1200 1204 #define DTRACE_CLASS_PLATFORM 2 /* platform-specific (uname -i) */
1201 1205 #define DTRACE_CLASS_GROUP 3 /* hardware-group-specific (uname -m) */
1202 1206 #define DTRACE_CLASS_ISA 4 /* ISA-specific (uname -p) */
1203 1207 #define DTRACE_CLASS_COMMON 5 /* common to all systems */
1204 1208 #define DTRACE_CLASS_MAX 5 /* maximum valid class */
1205 1209
1206 1210 #define DTRACE_PRIV_NONE 0x0000
1207 1211 #define DTRACE_PRIV_KERNEL 0x0001
1208 1212 #define DTRACE_PRIV_USER 0x0002
1209 1213 #define DTRACE_PRIV_PROC 0x0004
1210 1214 #define DTRACE_PRIV_OWNER 0x0008
1211 1215 #define DTRACE_PRIV_ZONEOWNER 0x0010
1212 1216
1213 1217 #define DTRACE_PRIV_ALL \
1214 1218 (DTRACE_PRIV_KERNEL | DTRACE_PRIV_USER | \
1215 1219 DTRACE_PRIV_PROC | DTRACE_PRIV_OWNER | DTRACE_PRIV_ZONEOWNER)
1216 1220
1217 1221 typedef struct dtrace_ppriv {
1218 1222 uint32_t dtpp_flags; /* privilege flags */
1219 1223 uid_t dtpp_uid; /* user ID */
1220 1224 zoneid_t dtpp_zoneid; /* zone ID */
1221 1225 } dtrace_ppriv_t;
1222 1226
1223 1227 typedef struct dtrace_attribute {
1224 1228 dtrace_stability_t dtat_name; /* entity name stability */
1225 1229 dtrace_stability_t dtat_data; /* entity data stability */
1226 1230 dtrace_class_t dtat_class; /* entity data dependency */
1227 1231 } dtrace_attribute_t;
1228 1232
1229 1233 typedef struct dtrace_pattr {
1230 1234 dtrace_attribute_t dtpa_provider; /* provider attributes */
1231 1235 dtrace_attribute_t dtpa_mod; /* module attributes */
1232 1236 dtrace_attribute_t dtpa_func; /* function attributes */
1233 1237 dtrace_attribute_t dtpa_name; /* name attributes */
1234 1238 dtrace_attribute_t dtpa_args; /* args[] attributes */
1235 1239 } dtrace_pattr_t;
1236 1240
1237 1241 typedef struct dtrace_providerdesc {
1238 1242 char dtvd_name[DTRACE_PROVNAMELEN]; /* provider name */
1239 1243 dtrace_pattr_t dtvd_attr; /* stability attributes */
1240 1244 dtrace_ppriv_t dtvd_priv; /* privileges required */
1241 1245 } dtrace_providerdesc_t;
1242 1246
1243 1247 /*
1244 1248 * DTrace Pseudodevice Interface
1245 1249 *
1246 1250 * DTrace is controlled through ioctl(2)'s to the in-kernel dtrace:dtrace
1247 1251 * pseudodevice driver. These ioctls comprise the user-kernel interface to
1248 1252 * DTrace.
1249 1253 */
1250 1254 #define DTRACEIOC (('d' << 24) | ('t' << 16) | ('r' << 8))
1251 1255 #define DTRACEIOC_PROVIDER (DTRACEIOC | 1) /* provider query */
1252 1256 #define DTRACEIOC_PROBES (DTRACEIOC | 2) /* probe query */
1253 1257 #define DTRACEIOC_BUFSNAP (DTRACEIOC | 4) /* snapshot buffer */
1254 1258 #define DTRACEIOC_PROBEMATCH (DTRACEIOC | 5) /* match probes */
1255 1259 #define DTRACEIOC_ENABLE (DTRACEIOC | 6) /* enable probes */
1256 1260 #define DTRACEIOC_AGGSNAP (DTRACEIOC | 7) /* snapshot agg. */
1257 1261 #define DTRACEIOC_EPROBE (DTRACEIOC | 8) /* get eprobe desc. */
1258 1262 #define DTRACEIOC_PROBEARG (DTRACEIOC | 9) /* get probe arg */
1259 1263 #define DTRACEIOC_CONF (DTRACEIOC | 10) /* get config. */
1260 1264 #define DTRACEIOC_STATUS (DTRACEIOC | 11) /* get status */
1261 1265 #define DTRACEIOC_GO (DTRACEIOC | 12) /* start tracing */
1262 1266 #define DTRACEIOC_STOP (DTRACEIOC | 13) /* stop tracing */
1263 1267 #define DTRACEIOC_AGGDESC (DTRACEIOC | 15) /* get agg. desc. */
1264 1268 #define DTRACEIOC_FORMAT (DTRACEIOC | 16) /* get format str */
1265 1269 #define DTRACEIOC_DOFGET (DTRACEIOC | 17) /* get DOF */
1266 1270 #define DTRACEIOC_REPLICATE (DTRACEIOC | 18) /* replicate enab */
1267 1271
1268 1272 /*
1269 1273 * DTrace Helpers
1270 1274 *
1271 1275 * In general, DTrace establishes probes in processes and takes actions on
1272 1276 * processes without knowing their specific user-level structures. Instead of
1273 1277 * existing in the framework, process-specific knowledge is contained by the
1274 1278 * enabling D program -- which can apply process-specific knowledge by making
1275 1279 * appropriate use of DTrace primitives like copyin() and copyinstr() to
1276 1280 * operate on user-level data. However, there may exist some specific probes
1277 1281 * of particular semantic relevance that the application developer may wish to
1278 1282 * explicitly export. For example, an application may wish to export a probe
1279 1283 * at the point that it begins and ends certain well-defined transactions. In
1280 1284 * addition to providing probes, programs may wish to offer assistance for
1281 1285 * certain actions. For example, in highly dynamic environments (e.g., Java),
1282 1286 * it may be difficult to obtain a stack trace in terms of meaningful symbol
1283 1287 * names (the translation from instruction addresses to corresponding symbol
1284 1288 * names may only be possible in situ); these environments may wish to define
1285 1289 * a series of actions to be applied in situ to obtain a meaningful stack
1286 1290 * trace.
1287 1291 *
1288 1292 * These two mechanisms -- user-level statically defined tracing and assisting
1289 1293 * DTrace actions -- are provided via DTrace _helpers_. Helpers are specified
1290 1294 * via DOF, but unlike enabling DOF, helper DOF may contain definitions of
1291 1295 * providers, probes and their arguments. If a helper wishes to provide
1292 1296 * action assistance, probe descriptions and corresponding DIF actions may be
1293 1297 * specified in the helper DOF. For such helper actions, however, the probe
1294 1298 * description describes the specific helper: all DTrace helpers have the
1295 1299 * provider name "dtrace" and the module name "helper", and the name of the
1296 1300 * helper is contained in the function name (for example, the ustack() helper
1297 1301 * is named "ustack"). Any helper-specific name may be contained in the name
1298 1302 * (for example, if a helper were to have a constructor, it might be named
1299 1303 * "dtrace:helper:<helper>:init"). Helper actions are only called when the
1300 1304 * action that they are helping is taken. Helper actions may only return DIF
1301 1305 * expressions, and may only call the following subroutines:
1302 1306 *
1303 1307 * alloca() <= Allocates memory out of the consumer's scratch space
1304 1308 * bcopy() <= Copies memory to scratch space
1305 1309 * copyin() <= Copies memory from user-level into consumer's scratch
1306 1310 * copyinto() <= Copies memory into a specific location in scratch
1307 1311 * copyinstr() <= Copies a string into a specific location in scratch
1308 1312 *
1309 1313 * Helper actions may only access the following built-in variables:
1310 1314 *
1311 1315 * curthread <= Current kthread_t pointer
1312 1316 * tid <= Current thread identifier
1313 1317 * pid <= Current process identifier
1314 1318 * ppid <= Parent process identifier
1315 1319 * uid <= Current user ID
1316 1320 * gid <= Current group ID
1317 1321 * execname <= Current executable name
1318 1322 * zonename <= Current zone name
1319 1323 *
1320 1324 * Helper actions may not manipulate or allocate dynamic variables, but they
1321 1325 * may have clause-local and statically-allocated global variables. The
1322 1326 * helper action variable state is specific to the helper action -- variables
1323 1327 * used by the helper action may not be accessed outside of the helper
1324 1328 * action, and the helper action may not access variables that like outside
1325 1329 * of it. Helper actions may not load from kernel memory at-large; they are
1326 1330 * restricting to loading current user state (via copyin() and variants) and
1327 1331 * scratch space. As with probe enablings, helper actions are executed in
1328 1332 * program order. The result of the helper action is the result of the last
1329 1333 * executing helper expression.
1330 1334 *
1331 1335 * Helpers -- composed of either providers/probes or probes/actions (or both)
1332 1336 * -- are added by opening the "helper" minor node, and issuing an ioctl(2)
1333 1337 * (DTRACEHIOC_ADDDOF) that specifies the dof_helper_t structure. This
1334 1338 * encapsulates the name and base address of the user-level library or
1335 1339 * executable publishing the helpers and probes as well as the DOF that
1336 1340 * contains the definitions of those helpers and probes.
1337 1341 *
1338 1342 * The DTRACEHIOC_ADD and DTRACEHIOC_REMOVE are left in place for legacy
1339 1343 * helpers and should no longer be used. No other ioctls are valid on the
1340 1344 * helper minor node.
1341 1345 */
1342 1346 #define DTRACEHIOC (('d' << 24) | ('t' << 16) | ('h' << 8))
1343 1347 #define DTRACEHIOC_ADD (DTRACEHIOC | 1) /* add helper */
1344 1348 #define DTRACEHIOC_REMOVE (DTRACEHIOC | 2) /* remove helper */
1345 1349 #define DTRACEHIOC_ADDDOF (DTRACEHIOC | 3) /* add helper DOF */
1346 1350
1347 1351 typedef struct dof_helper {
1348 1352 char dofhp_mod[DTRACE_MODNAMELEN]; /* executable or library name */
1349 1353 uint64_t dofhp_addr; /* base address of object */
1350 1354 uint64_t dofhp_dof; /* address of helper DOF */
1351 1355 } dof_helper_t;
1352 1356
1353 1357 #define DTRACEMNR_DTRACE "dtrace" /* node for DTrace ops */
1354 1358 #define DTRACEMNR_HELPER "helper" /* node for helpers */
1355 1359 #define DTRACEMNRN_DTRACE 0 /* minor for DTrace ops */
1356 1360 #define DTRACEMNRN_HELPER 1 /* minor for helpers */
1357 1361 #define DTRACEMNRN_CLONE 2 /* first clone minor */
1358 1362
1359 1363 #ifdef _KERNEL
1360 1364
1361 1365 /*
1362 1366 * DTrace Provider API
1363 1367 *
1364 1368 * The following functions are implemented by the DTrace framework and are
1365 1369 * used to implement separate in-kernel DTrace providers. Common functions
1366 1370 * are provided in uts/common/os/dtrace.c. ISA-dependent subroutines are
1367 1371 * defined in uts/<isa>/dtrace/dtrace_asm.s or uts/<isa>/dtrace/dtrace_isa.c.
1368 1372 *
1369 1373 * The provider API has two halves: the API that the providers consume from
1370 1374 * DTrace, and the API that providers make available to DTrace.
1371 1375 *
1372 1376 * 1 Framework-to-Provider API
1373 1377 *
1374 1378 * 1.1 Overview
1375 1379 *
1376 1380 * The Framework-to-Provider API is represented by the dtrace_pops structure
1377 1381 * that the provider passes to the framework when registering itself. This
1378 1382 * structure consists of the following members:
1379 1383 *
1380 1384 * dtps_provide() <-- Provide all probes, all modules
1381 1385 * dtps_provide_module() <-- Provide all probes in specified module
1382 1386 * dtps_enable() <-- Enable specified probe
1383 1387 * dtps_disable() <-- Disable specified probe
1384 1388 * dtps_suspend() <-- Suspend specified probe
1385 1389 * dtps_resume() <-- Resume specified probe
1386 1390 * dtps_getargdesc() <-- Get the argument description for args[X]
1387 1391 * dtps_getargval() <-- Get the value for an argX or args[X] variable
1388 1392 * dtps_mode() <-- Return the mode of the fired probe
1389 1393 * dtps_destroy() <-- Destroy all state associated with this probe
1390 1394 *
1391 1395 * 1.2 void dtps_provide(void *arg, const dtrace_probedesc_t *spec)
1392 1396 *
1393 1397 * 1.2.1 Overview
1394 1398 *
1395 1399 * Called to indicate that the provider should provide all probes. If the
1396 1400 * specified description is non-NULL, dtps_provide() is being called because
1397 1401 * no probe matched a specified probe -- if the provider has the ability to
1398 1402 * create custom probes, it may wish to create a probe that matches the
1399 1403 * specified description.
1400 1404 *
1401 1405 * 1.2.2 Arguments and notes
1402 1406 *
1403 1407 * The first argument is the cookie as passed to dtrace_register(). The
1404 1408 * second argument is a pointer to a probe description that the provider may
1405 1409 * wish to consider when creating custom probes. The provider is expected to
1406 1410 * call back into the DTrace framework via dtrace_probe_create() to create
1407 1411 * any necessary probes. dtps_provide() may be called even if the provider
1408 1412 * has made available all probes; the provider should check the return value
1409 1413 * of dtrace_probe_create() to handle this case. Note that the provider need
1410 1414 * not implement both dtps_provide() and dtps_provide_module(); see
1411 1415 * "Arguments and Notes" for dtrace_register(), below.
1412 1416 *
1413 1417 * 1.2.3 Return value
1414 1418 *
1415 1419 * None.
1416 1420 *
1417 1421 * 1.2.4 Caller's context
1418 1422 *
1419 1423 * dtps_provide() is typically called from open() or ioctl() context, but may
1420 1424 * be called from other contexts as well. The DTrace framework is locked in
1421 1425 * such a way that providers may not register or unregister. This means that
1422 1426 * the provider may not call any DTrace API that affects its registration with
1423 1427 * the framework, including dtrace_register(), dtrace_unregister(),
1424 1428 * dtrace_invalidate(), and dtrace_condense(). However, the context is such
1425 1429 * that the provider may (and indeed, is expected to) call probe-related
1426 1430 * DTrace routines, including dtrace_probe_create(), dtrace_probe_lookup(),
1427 1431 * and dtrace_probe_arg().
1428 1432 *
1429 1433 * 1.3 void dtps_provide_module(void *arg, struct modctl *mp)
1430 1434 *
1431 1435 * 1.3.1 Overview
1432 1436 *
1433 1437 * Called to indicate that the provider should provide all probes in the
1434 1438 * specified module.
1435 1439 *
1436 1440 * 1.3.2 Arguments and notes
1437 1441 *
1438 1442 * The first argument is the cookie as passed to dtrace_register(). The
1439 1443 * second argument is a pointer to a modctl structure that indicates the
1440 1444 * module for which probes should be created.
1441 1445 *
1442 1446 * 1.3.3 Return value
1443 1447 *
1444 1448 * None.
1445 1449 *
1446 1450 * 1.3.4 Caller's context
1447 1451 *
1448 1452 * dtps_provide_module() may be called from open() or ioctl() context, but
1449 1453 * may also be called from a module loading context. mod_lock is held, and
1450 1454 * the DTrace framework is locked in such a way that providers may not
1451 1455 * register or unregister. This means that the provider may not call any
1452 1456 * DTrace API that affects its registration with the framework, including
1453 1457 * dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and
1454 1458 * dtrace_condense(). However, the context is such that the provider may (and
1455 1459 * indeed, is expected to) call probe-related DTrace routines, including
1456 1460 * dtrace_probe_create(), dtrace_probe_lookup(), and dtrace_probe_arg(). Note
1457 1461 * that the provider need not implement both dtps_provide() and
1458 1462 * dtps_provide_module(); see "Arguments and Notes" for dtrace_register(),
1459 1463 * below.
1460 1464 *
1461 1465 * 1.4 int dtps_enable(void *arg, dtrace_id_t id, void *parg)
1462 1466 *
1463 1467 * 1.4.1 Overview
1464 1468 *
1465 1469 * Called to enable the specified probe.
1466 1470 *
1467 1471 * 1.4.2 Arguments and notes
1468 1472 *
1469 1473 * The first argument is the cookie as passed to dtrace_register(). The
1470 1474 * second argument is the identifier of the probe to be enabled. The third
1471 1475 * argument is the probe argument as passed to dtrace_probe_create().
1472 1476 * dtps_enable() will be called when a probe transitions from not being
1473 1477 * enabled at all to having one or more ECB. The number of ECBs associated
1474 1478 * with the probe may change without subsequent calls into the provider.
1475 1479 * When the number of ECBs drops to zero, the provider will be explicitly
1476 1480 * told to disable the probe via dtps_disable(). dtrace_probe() should never
1477 1481 * be called for a probe identifier that hasn't been explicitly enabled via
1478 1482 * dtps_enable().
1479 1483 *
1480 1484 * 1.4.3 Return value
1481 1485 *
1482 1486 * On success, dtps_enable() should return 0. On failure, -1 should be
1483 1487 * returned.
1484 1488 *
1485 1489 * 1.4.4 Caller's context
1486 1490 *
1487 1491 * The DTrace framework is locked in such a way that it may not be called
1488 1492 * back into at all. cpu_lock is held. mod_lock is not held and may not
1489 1493 * be acquired.
1490 1494 *
1491 1495 * 1.5 void dtps_disable(void *arg, dtrace_id_t id, void *parg)
1492 1496 *
1493 1497 * 1.5.1 Overview
1494 1498 *
1495 1499 * Called to disable the specified probe.
1496 1500 *
1497 1501 * 1.5.2 Arguments and notes
1498 1502 *
1499 1503 * The first argument is the cookie as passed to dtrace_register(). The
1500 1504 * second argument is the identifier of the probe to be disabled. The third
1501 1505 * argument is the probe argument as passed to dtrace_probe_create().
1502 1506 * dtps_disable() will be called when a probe transitions from being enabled
1503 1507 * to having zero ECBs. dtrace_probe() should never be called for a probe
1504 1508 * identifier that has been explicitly enabled via dtps_disable().
1505 1509 *
1506 1510 * 1.5.3 Return value
1507 1511 *
1508 1512 * None.
1509 1513 *
1510 1514 * 1.5.4 Caller's context
1511 1515 *
1512 1516 * The DTrace framework is locked in such a way that it may not be called
1513 1517 * back into at all. cpu_lock is held. mod_lock is not held and may not
1514 1518 * be acquired.
1515 1519 *
1516 1520 * 1.6 void dtps_suspend(void *arg, dtrace_id_t id, void *parg)
1517 1521 *
1518 1522 * 1.6.1 Overview
1519 1523 *
1520 1524 * Called to suspend the specified enabled probe. This entry point is for
1521 1525 * providers that may need to suspend some or all of their probes when CPUs
1522 1526 * are being powered on or when the boot monitor is being entered for a
1523 1527 * prolonged period of time.
1524 1528 *
1525 1529 * 1.6.2 Arguments and notes
1526 1530 *
1527 1531 * The first argument is the cookie as passed to dtrace_register(). The
1528 1532 * second argument is the identifier of the probe to be suspended. The
1529 1533 * third argument is the probe argument as passed to dtrace_probe_create().
1530 1534 * dtps_suspend will only be called on an enabled probe. Providers that
1531 1535 * provide a dtps_suspend entry point will want to take roughly the action
1532 1536 * that it takes for dtps_disable.
1533 1537 *
1534 1538 * 1.6.3 Return value
1535 1539 *
1536 1540 * None.
1537 1541 *
1538 1542 * 1.6.4 Caller's context
1539 1543 *
1540 1544 * Interrupts are disabled. The DTrace framework is in a state such that the
1541 1545 * specified probe cannot be disabled or destroyed for the duration of
1542 1546 * dtps_suspend(). As interrupts are disabled, the provider is afforded
1543 1547 * little latitude; the provider is expected to do no more than a store to
1544 1548 * memory.
1545 1549 *
1546 1550 * 1.7 void dtps_resume(void *arg, dtrace_id_t id, void *parg)
1547 1551 *
1548 1552 * 1.7.1 Overview
1549 1553 *
1550 1554 * Called to resume the specified enabled probe. This entry point is for
1551 1555 * providers that may need to resume some or all of their probes after the
1552 1556 * completion of an event that induced a call to dtps_suspend().
1553 1557 *
1554 1558 * 1.7.2 Arguments and notes
1555 1559 *
1556 1560 * The first argument is the cookie as passed to dtrace_register(). The
1557 1561 * second argument is the identifier of the probe to be resumed. The
1558 1562 * third argument is the probe argument as passed to dtrace_probe_create().
1559 1563 * dtps_resume will only be called on an enabled probe. Providers that
1560 1564 * provide a dtps_resume entry point will want to take roughly the action
1561 1565 * that it takes for dtps_enable.
1562 1566 *
1563 1567 * 1.7.3 Return value
1564 1568 *
1565 1569 * None.
1566 1570 *
1567 1571 * 1.7.4 Caller's context
1568 1572 *
1569 1573 * Interrupts are disabled. The DTrace framework is in a state such that the
1570 1574 * specified probe cannot be disabled or destroyed for the duration of
1571 1575 * dtps_resume(). As interrupts are disabled, the provider is afforded
1572 1576 * little latitude; the provider is expected to do no more than a store to
1573 1577 * memory.
1574 1578 *
1575 1579 * 1.8 void dtps_getargdesc(void *arg, dtrace_id_t id, void *parg,
1576 1580 * dtrace_argdesc_t *desc)
1577 1581 *
1578 1582 * 1.8.1 Overview
1579 1583 *
1580 1584 * Called to retrieve the argument description for an args[X] variable.
1581 1585 *
1582 1586 * 1.8.2 Arguments and notes
1583 1587 *
1584 1588 * The first argument is the cookie as passed to dtrace_register(). The
1585 1589 * second argument is the identifier of the current probe. The third
1586 1590 * argument is the probe argument as passed to dtrace_probe_create(). The
1587 1591 * fourth argument is a pointer to the argument description. This
1588 1592 * description is both an input and output parameter: it contains the
1589 1593 * index of the desired argument in the dtargd_ndx field, and expects
1590 1594 * the other fields to be filled in upon return. If there is no argument
1591 1595 * corresponding to the specified index, the dtargd_ndx field should be set
1592 1596 * to DTRACE_ARGNONE.
1593 1597 *
1594 1598 * 1.8.3 Return value
1595 1599 *
1596 1600 * None. The dtargd_ndx, dtargd_native, dtargd_xlate and dtargd_mapping
1597 1601 * members of the dtrace_argdesc_t structure are all output values.
1598 1602 *
1599 1603 * 1.8.4 Caller's context
1600 1604 *
1601 1605 * dtps_getargdesc() is called from ioctl() context. mod_lock is held, and
1602 1606 * the DTrace framework is locked in such a way that providers may not
1603 1607 * register or unregister. This means that the provider may not call any
1604 1608 * DTrace API that affects its registration with the framework, including
1605 1609 * dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and
1606 1610 * dtrace_condense().
1607 1611 *
1608 1612 * 1.9 uint64_t dtps_getargval(void *arg, dtrace_id_t id, void *parg,
1609 1613 * int argno, int aframes)
1610 1614 *
1611 1615 * 1.9.1 Overview
1612 1616 *
1613 1617 * Called to retrieve a value for an argX or args[X] variable.
1614 1618 *
1615 1619 * 1.9.2 Arguments and notes
1616 1620 *
1617 1621 * The first argument is the cookie as passed to dtrace_register(). The
1618 1622 * second argument is the identifier of the current probe. The third
1619 1623 * argument is the probe argument as passed to dtrace_probe_create(). The
1620 1624 * fourth argument is the number of the argument (the X in the example in
1621 1625 * 1.9.1). The fifth argument is the number of stack frames that were used
1622 1626 * to get from the actual place in the code that fired the probe to
1623 1627 * dtrace_probe() itself, the so-called artificial frames. This argument may
1624 1628 * be used to descend an appropriate number of frames to find the correct
1625 1629 * values. If this entry point is left NULL, the dtrace_getarg() built-in
1626 1630 * function is used.
1627 1631 *
1628 1632 * 1.9.3 Return value
1629 1633 *
1630 1634 * The value of the argument.
1631 1635 *
1632 1636 * 1.9.4 Caller's context
1633 1637 *
1634 1638 * This is called from within dtrace_probe() meaning that interrupts
1635 1639 * are disabled. No locks should be taken within this entry point.
1636 1640 *
1637 1641 * 1.10 int dtps_mode(void *arg, dtrace_id_t id, void *parg)
1638 1642 *
1639 1643 * 1.10.1 Overview
1640 1644 *
1641 1645 * Called to determine the mode of a fired probe.
1642 1646 *
1643 1647 * 1.10.2 Arguments and notes
1644 1648 *
1645 1649 * The first argument is the cookie as passed to dtrace_register(). The
1646 1650 * second argument is the identifier of the current probe. The third
1647 1651 * argument is the probe argument as passed to dtrace_probe_create(). This
1648 1652 * entry point must not be left NULL for providers whose probes allow for
1649 1653 * mixed mode tracing, that is to say those unanchored probes that can fire
1650 1654 * during kernel- or user-mode execution.
1651 1655 *
1652 1656 * 1.10.3 Return value
1653 1657 *
1654 1658 * A bitwise OR that encapsulates both the mode (either DTRACE_MODE_KERNEL
1655 1659 * or DTRACE_MODE_USER) and the policy when the privilege of the enabling
1656 1660 * is insufficient for that mode (a combination of DTRACE_MODE_NOPRIV_DROP,
1657 1661 * DTRACE_MODE_NOPRIV_RESTRICT, and DTRACE_MODE_LIMITEDPRIV_RESTRICT). If
1658 1662 * DTRACE_MODE_NOPRIV_DROP bit is set, insufficient privilege will result
1659 1663 * in the probe firing being silently ignored for the enabling; if the
1660 1664 * DTRACE_NODE_NOPRIV_RESTRICT bit is set, insufficient privilege will not
1661 1665 * prevent probe processing for the enabling, but restrictions will be in
1662 1666 * place that induce a UPRIV fault upon attempt to examine probe arguments
1663 1667 * or current process state. If the DTRACE_MODE_LIMITEDPRIV_RESTRICT bit
1664 1668 * is set, similar restrictions will be placed upon operation if the
1665 1669 * privilege is sufficient to process the enabling, but does not otherwise
1666 1670 * entitle the enabling to all zones. The DTRACE_MODE_NOPRIV_DROP and
1667 1671 * DTRACE_MODE_NOPRIV_RESTRICT are mutually exclusive (and one of these
1668 1672 * two policies must be specified), but either may be combined (or not)
1669 1673 * with DTRACE_MODE_LIMITEDPRIV_RESTRICT.
1670 1674 *
1671 1675 * 1.10.4 Caller's context
1672 1676 *
1673 1677 * This is called from within dtrace_probe() meaning that interrupts
1674 1678 * are disabled. No locks should be taken within this entry point.
1675 1679 *
1676 1680 * 1.11 void dtps_destroy(void *arg, dtrace_id_t id, void *parg)
1677 1681 *
1678 1682 * 1.11.1 Overview
1679 1683 *
1680 1684 * Called to destroy the specified probe.
1681 1685 *
1682 1686 * 1.11.2 Arguments and notes
1683 1687 *
1684 1688 * The first argument is the cookie as passed to dtrace_register(). The
1685 1689 * second argument is the identifier of the probe to be destroyed. The third
1686 1690 * argument is the probe argument as passed to dtrace_probe_create(). The
1687 1691 * provider should free all state associated with the probe. The framework
1688 1692 * guarantees that dtps_destroy() is only called for probes that have either
1689 1693 * been disabled via dtps_disable() or were never enabled via dtps_enable().
1690 1694 * Once dtps_disable() has been called for a probe, no further call will be
1691 1695 * made specifying the probe.
1692 1696 *
1693 1697 * 1.11.3 Return value
1694 1698 *
1695 1699 * None.
1696 1700 *
1697 1701 * 1.11.4 Caller's context
1698 1702 *
1699 1703 * The DTrace framework is locked in such a way that it may not be called
1700 1704 * back into at all. mod_lock is held. cpu_lock is not held, and may not be
1701 1705 * acquired.
1702 1706 *
1703 1707 *
1704 1708 * 2 Provider-to-Framework API
1705 1709 *
1706 1710 * 2.1 Overview
1707 1711 *
1708 1712 * The Provider-to-Framework API provides the mechanism for the provider to
1709 1713 * register itself with the DTrace framework, to create probes, to lookup
1710 1714 * probes and (most importantly) to fire probes. The Provider-to-Framework
1711 1715 * consists of:
1712 1716 *
1713 1717 * dtrace_register() <-- Register a provider with the DTrace framework
1714 1718 * dtrace_unregister() <-- Remove a provider's DTrace registration
1715 1719 * dtrace_invalidate() <-- Invalidate the specified provider
1716 1720 * dtrace_condense() <-- Remove a provider's unenabled probes
1717 1721 * dtrace_attached() <-- Indicates whether or not DTrace has attached
1718 1722 * dtrace_probe_create() <-- Create a DTrace probe
1719 1723 * dtrace_probe_lookup() <-- Lookup a DTrace probe based on its name
1720 1724 * dtrace_probe_arg() <-- Return the probe argument for a specific probe
1721 1725 * dtrace_probe() <-- Fire the specified probe
1722 1726 *
1723 1727 * 2.2 int dtrace_register(const char *name, const dtrace_pattr_t *pap,
1724 1728 * uint32_t priv, cred_t *cr, const dtrace_pops_t *pops, void *arg,
1725 1729 * dtrace_provider_id_t *idp)
1726 1730 *
1727 1731 * 2.2.1 Overview
1728 1732 *
1729 1733 * dtrace_register() registers the calling provider with the DTrace
1730 1734 * framework. It should generally be called by DTrace providers in their
1731 1735 * attach(9E) entry point.
1732 1736 *
1733 1737 * 2.2.2 Arguments and Notes
1734 1738 *
1735 1739 * The first argument is the name of the provider. The second argument is a
1736 1740 * pointer to the stability attributes for the provider. The third argument
1737 1741 * is the privilege flags for the provider, and must be some combination of:
1738 1742 *
1739 1743 * DTRACE_PRIV_NONE <= All users may enable probes from this provider
1740 1744 *
1741 1745 * DTRACE_PRIV_PROC <= Any user with privilege of PRIV_DTRACE_PROC may
1742 1746 * enable probes from this provider
1743 1747 *
1744 1748 * DTRACE_PRIV_USER <= Any user with privilege of PRIV_DTRACE_USER may
1745 1749 * enable probes from this provider
1746 1750 *
1747 1751 * DTRACE_PRIV_KERNEL <= Any user with privilege of PRIV_DTRACE_KERNEL
1748 1752 * may enable probes from this provider
1749 1753 *
1750 1754 * DTRACE_PRIV_OWNER <= This flag places an additional constraint on
1751 1755 * the privilege requirements above. These probes
1752 1756 * require either (a) a user ID matching the user
1753 1757 * ID of the cred passed in the fourth argument
1754 1758 * or (b) the PRIV_PROC_OWNER privilege.
1755 1759 *
1756 1760 * DTRACE_PRIV_ZONEOWNER<= This flag places an additional constraint on
1757 1761 * the privilege requirements above. These probes
1758 1762 * require either (a) a zone ID matching the zone
1759 1763 * ID of the cred passed in the fourth argument
1760 1764 * or (b) the PRIV_PROC_ZONE privilege.
1761 1765 *
1762 1766 * Note that these flags designate the _visibility_ of the probes, not
1763 1767 * the conditions under which they may or may not fire.
1764 1768 *
1765 1769 * The fourth argument is the credential that is associated with the
1766 1770 * provider. This argument should be NULL if the privilege flags don't
1767 1771 * include DTRACE_PRIV_OWNER or DTRACE_PRIV_ZONEOWNER. If non-NULL, the
1768 1772 * framework stashes the uid and zoneid represented by this credential
1769 1773 * for use at probe-time, in implicit predicates. These limit visibility
1770 1774 * of the probes to users and/or zones which have sufficient privilege to
1771 1775 * access them.
1772 1776 *
1773 1777 * The fifth argument is a DTrace provider operations vector, which provides
1774 1778 * the implementation for the Framework-to-Provider API. (See Section 1,
1775 1779 * above.) This must be non-NULL, and each member must be non-NULL. The
1776 1780 * exceptions to this are (1) the dtps_provide() and dtps_provide_module()
1777 1781 * members (if the provider so desires, _one_ of these members may be left
1778 1782 * NULL -- denoting that the provider only implements the other) and (2)
1779 1783 * the dtps_suspend() and dtps_resume() members, which must either both be
1780 1784 * NULL or both be non-NULL.
1781 1785 *
1782 1786 * The sixth argument is a cookie to be specified as the first argument for
1783 1787 * each function in the Framework-to-Provider API. This argument may have
1784 1788 * any value.
1785 1789 *
1786 1790 * The final argument is a pointer to dtrace_provider_id_t. If
1787 1791 * dtrace_register() successfully completes, the provider identifier will be
1788 1792 * stored in the memory pointed to be this argument. This argument must be
1789 1793 * non-NULL.
1790 1794 *
1791 1795 * 2.2.3 Return value
1792 1796 *
1793 1797 * On success, dtrace_register() returns 0 and stores the new provider's
1794 1798 * identifier into the memory pointed to by the idp argument. On failure,
1795 1799 * dtrace_register() returns an errno:
1796 1800 *
1797 1801 * EINVAL The arguments passed to dtrace_register() were somehow invalid.
1798 1802 * This may because a parameter that must be non-NULL was NULL,
1799 1803 * because the name was invalid (either empty or an illegal
1800 1804 * provider name) or because the attributes were invalid.
1801 1805 *
1802 1806 * No other failure code is returned.
1803 1807 *
1804 1808 * 2.2.4 Caller's context
1805 1809 *
1806 1810 * dtrace_register() may induce calls to dtrace_provide(); the provider must
1807 1811 * hold no locks across dtrace_register() that may also be acquired by
1808 1812 * dtrace_provide(). cpu_lock and mod_lock must not be held.
1809 1813 *
1810 1814 * 2.3 int dtrace_unregister(dtrace_provider_t id)
1811 1815 *
1812 1816 * 2.3.1 Overview
1813 1817 *
1814 1818 * Unregisters the specified provider from the DTrace framework. It should
1815 1819 * generally be called by DTrace providers in their detach(9E) entry point.
1816 1820 *
1817 1821 * 2.3.2 Arguments and Notes
1818 1822 *
1819 1823 * The only argument is the provider identifier, as returned from a
1820 1824 * successful call to dtrace_register(). As a result of calling
1821 1825 * dtrace_unregister(), the DTrace framework will call back into the provider
1822 1826 * via the dtps_destroy() entry point. Once dtrace_unregister() successfully
1823 1827 * completes, however, the DTrace framework will no longer make calls through
1824 1828 * the Framework-to-Provider API.
1825 1829 *
1826 1830 * 2.3.3 Return value
1827 1831 *
1828 1832 * On success, dtrace_unregister returns 0. On failure, dtrace_unregister()
1829 1833 * returns an errno:
1830 1834 *
1831 1835 * EBUSY There are currently processes that have the DTrace pseudodevice
1832 1836 * open, or there exists an anonymous enabling that hasn't yet
1833 1837 * been claimed.
1834 1838 *
1835 1839 * No other failure code is returned.
1836 1840 *
1837 1841 * 2.3.4 Caller's context
1838 1842 *
1839 1843 * Because a call to dtrace_unregister() may induce calls through the
1840 1844 * Framework-to-Provider API, the caller may not hold any lock across
1841 1845 * dtrace_register() that is also acquired in any of the Framework-to-
1842 1846 * Provider API functions. Additionally, mod_lock may not be held.
1843 1847 *
1844 1848 * 2.4 void dtrace_invalidate(dtrace_provider_id_t id)
1845 1849 *
1846 1850 * 2.4.1 Overview
1847 1851 *
1848 1852 * Invalidates the specified provider. All subsequent probe lookups for the
1849 1853 * specified provider will fail, but its probes will not be removed.
1850 1854 *
1851 1855 * 2.4.2 Arguments and note
1852 1856 *
1853 1857 * The only argument is the provider identifier, as returned from a
1854 1858 * successful call to dtrace_register(). In general, a provider's probes
1855 1859 * always remain valid; dtrace_invalidate() is a mechanism for invalidating
1856 1860 * an entire provider, regardless of whether or not probes are enabled or
1857 1861 * not. Note that dtrace_invalidate() will _not_ prevent already enabled
1858 1862 * probes from firing -- it will merely prevent any new enablings of the
1859 1863 * provider's probes.
1860 1864 *
1861 1865 * 2.5 int dtrace_condense(dtrace_provider_id_t id)
1862 1866 *
1863 1867 * 2.5.1 Overview
1864 1868 *
1865 1869 * Removes all the unenabled probes for the given provider. This function is
1866 1870 * not unlike dtrace_unregister(), except that it doesn't remove the
1867 1871 * provider just as many of its associated probes as it can.
1868 1872 *
1869 1873 * 2.5.2 Arguments and Notes
1870 1874 *
1871 1875 * As with dtrace_unregister(), the sole argument is the provider identifier
1872 1876 * as returned from a successful call to dtrace_register(). As a result of
1873 1877 * calling dtrace_condense(), the DTrace framework will call back into the
1874 1878 * given provider's dtps_destroy() entry point for each of the provider's
1875 1879 * unenabled probes.
1876 1880 *
1877 1881 * 2.5.3 Return value
1878 1882 *
1879 1883 * Currently, dtrace_condense() always returns 0. However, consumers of this
1880 1884 * function should check the return value as appropriate; its behavior may
1881 1885 * change in the future.
1882 1886 *
1883 1887 * 2.5.4 Caller's context
1884 1888 *
1885 1889 * As with dtrace_unregister(), the caller may not hold any lock across
1886 1890 * dtrace_condense() that is also acquired in the provider's entry points.
1887 1891 * Also, mod_lock may not be held.
1888 1892 *
1889 1893 * 2.6 int dtrace_attached()
1890 1894 *
1891 1895 * 2.6.1 Overview
1892 1896 *
1893 1897 * Indicates whether or not DTrace has attached.
1894 1898 *
1895 1899 * 2.6.2 Arguments and Notes
1896 1900 *
1897 1901 * For most providers, DTrace makes initial contact beyond registration.
1898 1902 * That is, once a provider has registered with DTrace, it waits to hear
1899 1903 * from DTrace to create probes. However, some providers may wish to
1900 1904 * proactively create probes without first being told by DTrace to do so.
1901 1905 * If providers wish to do this, they must first call dtrace_attached() to
1902 1906 * determine if DTrace itself has attached. If dtrace_attached() returns 0,
1903 1907 * the provider must not make any other Provider-to-Framework API call.
1904 1908 *
1905 1909 * 2.6.3 Return value
1906 1910 *
1907 1911 * dtrace_attached() returns 1 if DTrace has attached, 0 otherwise.
1908 1912 *
1909 1913 * 2.7 int dtrace_probe_create(dtrace_provider_t id, const char *mod,
1910 1914 * const char *func, const char *name, int aframes, void *arg)
1911 1915 *
1912 1916 * 2.7.1 Overview
1913 1917 *
1914 1918 * Creates a probe with specified module name, function name, and name.
1915 1919 *
1916 1920 * 2.7.2 Arguments and Notes
1917 1921 *
1918 1922 * The first argument is the provider identifier, as returned from a
1919 1923 * successful call to dtrace_register(). The second, third, and fourth
1920 1924 * arguments are the module name, function name, and probe name,
1921 1925 * respectively. Of these, module name and function name may both be NULL
1922 1926 * (in which case the probe is considered to be unanchored), or they may both
1923 1927 * be non-NULL. The name must be non-NULL, and must point to a non-empty
1924 1928 * string.
1925 1929 *
1926 1930 * The fifth argument is the number of artificial stack frames that will be
1927 1931 * found on the stack when dtrace_probe() is called for the new probe. These
1928 1932 * artificial frames will be automatically be pruned should the stack() or
1929 1933 * stackdepth() functions be called as part of one of the probe's ECBs. If
1930 1934 * the parameter doesn't add an artificial frame, this parameter should be
1931 1935 * zero.
1932 1936 *
1933 1937 * The final argument is a probe argument that will be passed back to the
1934 1938 * provider when a probe-specific operation is called. (e.g., via
1935 1939 * dtps_enable(), dtps_disable(), etc.)
1936 1940 *
1937 1941 * Note that it is up to the provider to be sure that the probe that it
1938 1942 * creates does not already exist -- if the provider is unsure of the probe's
1939 1943 * existence, it should assure its absence with dtrace_probe_lookup() before
1940 1944 * calling dtrace_probe_create().
1941 1945 *
1942 1946 * 2.7.3 Return value
1943 1947 *
1944 1948 * dtrace_probe_create() always succeeds, and always returns the identifier
1945 1949 * of the newly-created probe.
1946 1950 *
1947 1951 * 2.7.4 Caller's context
1948 1952 *
1949 1953 * While dtrace_probe_create() is generally expected to be called from
1950 1954 * dtps_provide() and/or dtps_provide_module(), it may be called from other
1951 1955 * non-DTrace contexts. Neither cpu_lock nor mod_lock may be held.
1952 1956 *
1953 1957 * 2.8 dtrace_id_t dtrace_probe_lookup(dtrace_provider_t id, const char *mod,
1954 1958 * const char *func, const char *name)
1955 1959 *
1956 1960 * 2.8.1 Overview
1957 1961 *
1958 1962 * Looks up a probe based on provdider and one or more of module name,
1959 1963 * function name and probe name.
1960 1964 *
1961 1965 * 2.8.2 Arguments and Notes
1962 1966 *
1963 1967 * The first argument is the provider identifier, as returned from a
1964 1968 * successful call to dtrace_register(). The second, third, and fourth
1965 1969 * arguments are the module name, function name, and probe name,
1966 1970 * respectively. Any of these may be NULL; dtrace_probe_lookup() will return
1967 1971 * the identifier of the first probe that is provided by the specified
1968 1972 * provider and matches all of the non-NULL matching criteria.
1969 1973 * dtrace_probe_lookup() is generally used by a provider to be check the
1970 1974 * existence of a probe before creating it with dtrace_probe_create().
1971 1975 *
1972 1976 * 2.8.3 Return value
1973 1977 *
1974 1978 * If the probe exists, returns its identifier. If the probe does not exist,
1975 1979 * return DTRACE_IDNONE.
1976 1980 *
1977 1981 * 2.8.4 Caller's context
1978 1982 *
1979 1983 * While dtrace_probe_lookup() is generally expected to be called from
1980 1984 * dtps_provide() and/or dtps_provide_module(), it may also be called from
1981 1985 * other non-DTrace contexts. Neither cpu_lock nor mod_lock may be held.
1982 1986 *
1983 1987 * 2.9 void *dtrace_probe_arg(dtrace_provider_t id, dtrace_id_t probe)
1984 1988 *
1985 1989 * 2.9.1 Overview
1986 1990 *
1987 1991 * Returns the probe argument associated with the specified probe.
1988 1992 *
1989 1993 * 2.9.2 Arguments and Notes
1990 1994 *
1991 1995 * The first argument is the provider identifier, as returned from a
1992 1996 * successful call to dtrace_register(). The second argument is a probe
1993 1997 * identifier, as returned from dtrace_probe_lookup() or
1994 1998 * dtrace_probe_create(). This is useful if a probe has multiple
1995 1999 * provider-specific components to it: the provider can create the probe
1996 2000 * once with provider-specific state, and then add to the state by looking
1997 2001 * up the probe based on probe identifier.
1998 2002 *
1999 2003 * 2.9.3 Return value
2000 2004 *
2001 2005 * Returns the argument associated with the specified probe. If the
2002 2006 * specified probe does not exist, or if the specified probe is not provided
2003 2007 * by the specified provider, NULL is returned.
2004 2008 *
2005 2009 * 2.9.4 Caller's context
2006 2010 *
2007 2011 * While dtrace_probe_arg() is generally expected to be called from
2008 2012 * dtps_provide() and/or dtps_provide_module(), it may also be called from
2009 2013 * other non-DTrace contexts. Neither cpu_lock nor mod_lock may be held.
2010 2014 *
2011 2015 * 2.10 void dtrace_probe(dtrace_id_t probe, uintptr_t arg0, uintptr_t arg1,
2012 2016 * uintptr_t arg2, uintptr_t arg3, uintptr_t arg4)
2013 2017 *
2014 2018 * 2.10.1 Overview
2015 2019 *
2016 2020 * The epicenter of DTrace: fires the specified probes with the specified
2017 2021 * arguments.
2018 2022 *
2019 2023 * 2.10.2 Arguments and Notes
2020 2024 *
2021 2025 * The first argument is a probe identifier as returned by
2022 2026 * dtrace_probe_create() or dtrace_probe_lookup(). The second through sixth
2023 2027 * arguments are the values to which the D variables "arg0" through "arg4"
2024 2028 * will be mapped.
2025 2029 *
2026 2030 * dtrace_probe() should be called whenever the specified probe has fired --
2027 2031 * however the provider defines it.
2028 2032 *
2029 2033 * 2.10.3 Return value
2030 2034 *
2031 2035 * None.
2032 2036 *
2033 2037 * 2.10.4 Caller's context
2034 2038 *
2035 2039 * dtrace_probe() may be called in virtually any context: kernel, user,
2036 2040 * interrupt, high-level interrupt, with arbitrary adaptive locks held, with
2037 2041 * dispatcher locks held, with interrupts disabled, etc. The only latitude
2038 2042 * that must be afforded to DTrace is the ability to make calls within
2039 2043 * itself (and to its in-kernel subroutines) and the ability to access
2040 2044 * arbitrary (but mapped) memory. On some platforms, this constrains
2041 2045 * context. For example, on UltraSPARC, dtrace_probe() cannot be called
2042 2046 * from any context in which TL is greater than zero. dtrace_probe() may
2043 2047 * also not be called from any routine which may be called by dtrace_probe()
2044 2048 * -- which includes functions in the DTrace framework and some in-kernel
2045 2049 * DTrace subroutines. All such functions "dtrace_"; providers that
2046 2050 * instrument the kernel arbitrarily should be sure to not instrument these
2047 2051 * routines.
2048 2052 */
2049 2053 typedef struct dtrace_pops {
2050 2054 void (*dtps_provide)(void *arg, const dtrace_probedesc_t *spec);
2051 2055 void (*dtps_provide_module)(void *arg, struct modctl *mp);
2052 2056 int (*dtps_enable)(void *arg, dtrace_id_t id, void *parg);
2053 2057 void (*dtps_disable)(void *arg, dtrace_id_t id, void *parg);
2054 2058 void (*dtps_suspend)(void *arg, dtrace_id_t id, void *parg);
2055 2059 void (*dtps_resume)(void *arg, dtrace_id_t id, void *parg);
2056 2060 void (*dtps_getargdesc)(void *arg, dtrace_id_t id, void *parg,
2057 2061 dtrace_argdesc_t *desc);
2058 2062 uint64_t (*dtps_getargval)(void *arg, dtrace_id_t id, void *parg,
2059 2063 int argno, int aframes);
2060 2064 int (*dtps_mode)(void *arg, dtrace_id_t id, void *parg);
2061 2065 void (*dtps_destroy)(void *arg, dtrace_id_t id, void *parg);
2062 2066 } dtrace_pops_t;
2063 2067
2064 2068 #define DTRACE_MODE_KERNEL 0x01
2065 2069 #define DTRACE_MODE_USER 0x02
2066 2070 #define DTRACE_MODE_NOPRIV_DROP 0x10
2067 2071 #define DTRACE_MODE_NOPRIV_RESTRICT 0x20
2068 2072 #define DTRACE_MODE_LIMITEDPRIV_RESTRICT 0x40
2069 2073
2070 2074 typedef uintptr_t dtrace_provider_id_t;
2071 2075
2072 2076 extern int dtrace_register(const char *, const dtrace_pattr_t *, uint32_t,
2073 2077 cred_t *, const dtrace_pops_t *, void *, dtrace_provider_id_t *);
2074 2078 extern int dtrace_unregister(dtrace_provider_id_t);
2075 2079 extern int dtrace_condense(dtrace_provider_id_t);
2076 2080 extern void dtrace_invalidate(dtrace_provider_id_t);
2077 2081 extern dtrace_id_t dtrace_probe_lookup(dtrace_provider_id_t, const char *,
2078 2082 const char *, const char *);
2079 2083 extern dtrace_id_t dtrace_probe_create(dtrace_provider_id_t, const char *,
2080 2084 const char *, const char *, int, void *);
2081 2085 extern void *dtrace_probe_arg(dtrace_provider_id_t, dtrace_id_t);
2082 2086 extern void dtrace_probe(dtrace_id_t, uintptr_t arg0, uintptr_t arg1,
2083 2087 uintptr_t arg2, uintptr_t arg3, uintptr_t arg4);
2084 2088
2085 2089 /*
2086 2090 * DTrace Meta Provider API
2087 2091 *
2088 2092 * The following functions are implemented by the DTrace framework and are
2089 2093 * used to implement meta providers. Meta providers plug into the DTrace
2090 2094 * framework and are used to instantiate new providers on the fly. At
2091 2095 * present, there is only one type of meta provider and only one meta
2092 2096 * provider may be registered with the DTrace framework at a time. The
2093 2097 * sole meta provider type provides user-land static tracing facilities
2094 2098 * by taking meta probe descriptions and adding a corresponding provider
2095 2099 * into the DTrace framework.
2096 2100 *
2097 2101 * 1 Framework-to-Provider
2098 2102 *
2099 2103 * 1.1 Overview
2100 2104 *
2101 2105 * The Framework-to-Provider API is represented by the dtrace_mops structure
2102 2106 * that the meta provider passes to the framework when registering itself as
2103 2107 * a meta provider. This structure consists of the following members:
2104 2108 *
2105 2109 * dtms_create_probe() <-- Add a new probe to a created provider
2106 2110 * dtms_provide_pid() <-- Create a new provider for a given process
2107 2111 * dtms_remove_pid() <-- Remove a previously created provider
2108 2112 *
2109 2113 * 1.2 void dtms_create_probe(void *arg, void *parg,
2110 2114 * dtrace_helper_probedesc_t *probedesc);
2111 2115 *
2112 2116 * 1.2.1 Overview
2113 2117 *
2114 2118 * Called by the DTrace framework to create a new probe in a provider
2115 2119 * created by this meta provider.
2116 2120 *
2117 2121 * 1.2.2 Arguments and notes
2118 2122 *
2119 2123 * The first argument is the cookie as passed to dtrace_meta_register().
2120 2124 * The second argument is the provider cookie for the associated provider;
2121 2125 * this is obtained from the return value of dtms_provide_pid(). The third
2122 2126 * argument is the helper probe description.
2123 2127 *
2124 2128 * 1.2.3 Return value
2125 2129 *
2126 2130 * None
2127 2131 *
2128 2132 * 1.2.4 Caller's context
2129 2133 *
2130 2134 * dtms_create_probe() is called from either ioctl() or module load context.
2131 2135 * The DTrace framework is locked in such a way that meta providers may not
2132 2136 * register or unregister. This means that the meta provider cannot call
2133 2137 * dtrace_meta_register() or dtrace_meta_unregister(). However, the context is
2134 2138 * such that the provider may (and is expected to) call provider-related
2135 2139 * DTrace provider APIs including dtrace_probe_create().
2136 2140 *
2137 2141 * 1.3 void *dtms_provide_pid(void *arg, dtrace_meta_provider_t *mprov,
2138 2142 * pid_t pid)
2139 2143 *
2140 2144 * 1.3.1 Overview
2141 2145 *
2142 2146 * Called by the DTrace framework to instantiate a new provider given the
2143 2147 * description of the provider and probes in the mprov argument. The
2144 2148 * meta provider should call dtrace_register() to insert the new provider
2145 2149 * into the DTrace framework.
2146 2150 *
2147 2151 * 1.3.2 Arguments and notes
2148 2152 *
2149 2153 * The first argument is the cookie as passed to dtrace_meta_register().
2150 2154 * The second argument is a pointer to a structure describing the new
2151 2155 * helper provider. The third argument is the process identifier for
2152 2156 * process associated with this new provider. Note that the name of the
2153 2157 * provider as passed to dtrace_register() should be the contatenation of
2154 2158 * the dtmpb_provname member of the mprov argument and the processs
2155 2159 * identifier as a string.
2156 2160 *
2157 2161 * 1.3.3 Return value
2158 2162 *
2159 2163 * The cookie for the provider that the meta provider creates. This is
2160 2164 * the same value that it passed to dtrace_register().
2161 2165 *
2162 2166 * 1.3.4 Caller's context
2163 2167 *
2164 2168 * dtms_provide_pid() is called from either ioctl() or module load context.
2165 2169 * The DTrace framework is locked in such a way that meta providers may not
2166 2170 * register or unregister. This means that the meta provider cannot call
2167 2171 * dtrace_meta_register() or dtrace_meta_unregister(). However, the context
2168 2172 * is such that the provider may -- and is expected to -- call
2169 2173 * provider-related DTrace provider APIs including dtrace_register().
2170 2174 *
2171 2175 * 1.4 void dtms_remove_pid(void *arg, dtrace_meta_provider_t *mprov,
2172 2176 * pid_t pid)
2173 2177 *
2174 2178 * 1.4.1 Overview
2175 2179 *
2176 2180 * Called by the DTrace framework to remove a provider that had previously
2177 2181 * been instantiated via the dtms_provide_pid() entry point. The meta
2178 2182 * provider need not remove the provider immediately, but this entry
2179 2183 * point indicates that the provider should be removed as soon as possible
2180 2184 * using the dtrace_unregister() API.
2181 2185 *
2182 2186 * 1.4.2 Arguments and notes
2183 2187 *
2184 2188 * The first argument is the cookie as passed to dtrace_meta_register().
2185 2189 * The second argument is a pointer to a structure describing the helper
2186 2190 * provider. The third argument is the process identifier for process
2187 2191 * associated with this new provider.
2188 2192 *
2189 2193 * 1.4.3 Return value
2190 2194 *
2191 2195 * None
2192 2196 *
2193 2197 * 1.4.4 Caller's context
2194 2198 *
2195 2199 * dtms_remove_pid() is called from either ioctl() or exit() context.
2196 2200 * The DTrace framework is locked in such a way that meta providers may not
2197 2201 * register or unregister. This means that the meta provider cannot call
2198 2202 * dtrace_meta_register() or dtrace_meta_unregister(). However, the context
2199 2203 * is such that the provider may -- and is expected to -- call
2200 2204 * provider-related DTrace provider APIs including dtrace_unregister().
2201 2205 */
2202 2206 typedef struct dtrace_helper_probedesc {
2203 2207 char *dthpb_mod; /* probe module */
2204 2208 char *dthpb_func; /* probe function */
2205 2209 char *dthpb_name; /* probe name */
2206 2210 uint64_t dthpb_base; /* base address */
2207 2211 uint32_t *dthpb_offs; /* offsets array */
2208 2212 uint32_t *dthpb_enoffs; /* is-enabled offsets array */
2209 2213 uint32_t dthpb_noffs; /* offsets count */
2210 2214 uint32_t dthpb_nenoffs; /* is-enabled offsets count */
2211 2215 uint8_t *dthpb_args; /* argument mapping array */
2212 2216 uint8_t dthpb_xargc; /* translated argument count */
2213 2217 uint8_t dthpb_nargc; /* native argument count */
2214 2218 char *dthpb_xtypes; /* translated types strings */
2215 2219 char *dthpb_ntypes; /* native types strings */
2216 2220 } dtrace_helper_probedesc_t;
2217 2221
2218 2222 typedef struct dtrace_helper_provdesc {
2219 2223 char *dthpv_provname; /* provider name */
2220 2224 dtrace_pattr_t dthpv_pattr; /* stability attributes */
2221 2225 } dtrace_helper_provdesc_t;
2222 2226
2223 2227 typedef struct dtrace_mops {
2224 2228 void (*dtms_create_probe)(void *, void *, dtrace_helper_probedesc_t *);
2225 2229 void *(*dtms_provide_pid)(void *, dtrace_helper_provdesc_t *, pid_t);
2226 2230 void (*dtms_remove_pid)(void *, dtrace_helper_provdesc_t *, pid_t);
2227 2231 } dtrace_mops_t;
2228 2232
2229 2233 typedef uintptr_t dtrace_meta_provider_id_t;
2230 2234
2231 2235 extern int dtrace_meta_register(const char *, const dtrace_mops_t *, void *,
2232 2236 dtrace_meta_provider_id_t *);
2233 2237 extern int dtrace_meta_unregister(dtrace_meta_provider_id_t);
2234 2238
2235 2239 /*
2236 2240 * DTrace Kernel Hooks
2237 2241 *
2238 2242 * The following functions are implemented by the base kernel and form a set of
2239 2243 * hooks used by the DTrace framework. DTrace hooks are implemented in either
2240 2244 * uts/common/os/dtrace_subr.c, an ISA-specific assembly file, or in a
2241 2245 * uts/<platform>/os/dtrace_subr.c corresponding to each hardware platform.
2242 2246 */
2243 2247
2244 2248 typedef enum dtrace_vtime_state {
2245 2249 DTRACE_VTIME_INACTIVE = 0, /* No DTrace, no TNF */
2246 2250 DTRACE_VTIME_ACTIVE, /* DTrace virtual time, no TNF */
2247 2251 DTRACE_VTIME_INACTIVE_TNF, /* No DTrace, TNF active */
2248 2252 DTRACE_VTIME_ACTIVE_TNF /* DTrace virtual time _and_ TNF */
2249 2253 } dtrace_vtime_state_t;
2250 2254
2251 2255 extern dtrace_vtime_state_t dtrace_vtime_active;
2252 2256 extern void dtrace_vtime_switch(kthread_t *next);
2253 2257 extern void dtrace_vtime_enable_tnf(void);
2254 2258 extern void dtrace_vtime_disable_tnf(void);
2255 2259 extern void dtrace_vtime_enable(void);
2256 2260 extern void dtrace_vtime_disable(void);
2257 2261
2258 2262 struct regs;
2259 2263
2260 2264 extern int (*dtrace_pid_probe_ptr)(struct regs *);
2261 2265 extern int (*dtrace_return_probe_ptr)(struct regs *);
2262 2266 extern void (*dtrace_fasttrap_fork_ptr)(proc_t *, proc_t *);
2263 2267 extern void (*dtrace_fasttrap_exec_ptr)(proc_t *);
2264 2268 extern void (*dtrace_fasttrap_exit_ptr)(proc_t *);
2265 2269 extern void dtrace_fasttrap_fork(proc_t *, proc_t *);
2266 2270
2267 2271 typedef uintptr_t dtrace_icookie_t;
2268 2272 typedef void (*dtrace_xcall_t)(void *);
2269 2273
2270 2274 extern dtrace_icookie_t dtrace_interrupt_disable(void);
2271 2275 extern void dtrace_interrupt_enable(dtrace_icookie_t);
2272 2276
2273 2277 extern void dtrace_membar_producer(void);
2274 2278 extern void dtrace_membar_consumer(void);
2275 2279
2276 2280 extern void (*dtrace_cpu_init)(processorid_t);
2277 2281 extern void (*dtrace_modload)(struct modctl *);
2278 2282 extern void (*dtrace_modunload)(struct modctl *);
2279 2283 extern void (*dtrace_helpers_cleanup)();
2280 2284 extern void (*dtrace_helpers_fork)(proc_t *parent, proc_t *child);
2281 2285 extern void (*dtrace_cpustart_init)();
2282 2286 extern void (*dtrace_cpustart_fini)();
2283 2287 extern void (*dtrace_closef)();
2284 2288
2285 2289 extern void (*dtrace_debugger_init)();
2286 2290 extern void (*dtrace_debugger_fini)();
2287 2291 extern dtrace_cacheid_t dtrace_predcache_id;
2288 2292
2289 2293 extern hrtime_t dtrace_gethrtime(void);
2290 2294 extern void dtrace_sync(void);
2291 2295 extern void dtrace_toxic_ranges(void (*)(uintptr_t, uintptr_t));
2292 2296 extern void dtrace_xcall(processorid_t, dtrace_xcall_t, void *);
2293 2297 extern void dtrace_vpanic(const char *, __va_list);
2294 2298 extern void dtrace_panic(const char *, ...);
2295 2299
2296 2300 extern int dtrace_safe_defer_signal(void);
2297 2301 extern void dtrace_safe_synchronous_signal(void);
2298 2302
2299 2303 extern int dtrace_mach_aframes(void);
2300 2304
2301 2305 #if defined(__i386) || defined(__amd64)
2302 2306 extern int dtrace_instr_size(uchar_t *instr);
2303 2307 extern int dtrace_instr_size_isa(uchar_t *, model_t, int *);
2304 2308 extern void dtrace_invop_add(int (*)(uintptr_t, uintptr_t *, uintptr_t));
2305 2309 extern void dtrace_invop_remove(int (*)(uintptr_t, uintptr_t *, uintptr_t));
2306 2310 extern void dtrace_invop_callsite(void);
2307 2311 #endif
2308 2312
2309 2313 #ifdef __sparc
2310 2314 extern int dtrace_blksuword32(uintptr_t, uint32_t *, int);
2311 2315 extern void dtrace_getfsr(uint64_t *);
2312 2316 #endif
2313 2317
2314 2318 #define DTRACE_CPUFLAG_ISSET(flag) \
2315 2319 (cpu_core[CPU->cpu_id].cpuc_dtrace_flags & (flag))
2316 2320
2317 2321 #define DTRACE_CPUFLAG_SET(flag) \
2318 2322 (cpu_core[CPU->cpu_id].cpuc_dtrace_flags |= (flag))
2319 2323
2320 2324 #define DTRACE_CPUFLAG_CLEAR(flag) \
2321 2325 (cpu_core[CPU->cpu_id].cpuc_dtrace_flags &= ~(flag))
2322 2326
2323 2327 #endif /* _KERNEL */
2324 2328
2325 2329 #endif /* _ASM */
2326 2330
2327 2331 #if defined(__i386) || defined(__amd64)
2328 2332
2329 2333 #define DTRACE_INVOP_PUSHL_EBP 1
2330 2334 #define DTRACE_INVOP_POPL_EBP 2
2331 2335 #define DTRACE_INVOP_LEAVE 3
2332 2336 #define DTRACE_INVOP_NOP 4
2333 2337 #define DTRACE_INVOP_RET 5
2334 2338
2335 2339 #endif
2336 2340
2337 2341 #ifdef __cplusplus
2338 2342 }
2339 2343 #endif
2340 2344
2341 2345 #endif /* _SYS_DTRACE_H */
|
↓ open down ↓ |
1305 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX