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