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