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