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