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