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