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