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