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