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