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