17c478bd9Sstevel@tonic-gate /* 27c478bd9Sstevel@tonic-gate * CDDL HEADER START 37c478bd9Sstevel@tonic-gate * 47c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5ad4023c4Sdp * Common Development and Distribution License (the "License"). 6ad4023c4Sdp * You may not use this file except in compliance with the License. 77c478bd9Sstevel@tonic-gate * 87c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 97c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 107c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 117c478bd9Sstevel@tonic-gate * and limitations under the License. 127c478bd9Sstevel@tonic-gate * 137c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 147c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 157c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 167c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 177c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 187c478bd9Sstevel@tonic-gate * 197c478bd9Sstevel@tonic-gate * CDDL HEADER END 207c478bd9Sstevel@tonic-gate */ 21ac448965Sahl 227c478bd9Sstevel@tonic-gate /* 23b9e93c10SJonathan Haslam * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 247c478bd9Sstevel@tonic-gate * Use is subject to license terms. 257c478bd9Sstevel@tonic-gate */ 267c478bd9Sstevel@tonic-gate 277c478bd9Sstevel@tonic-gate #ifndef _SYS_DTRACE_H 287c478bd9Sstevel@tonic-gate #define _SYS_DTRACE_H 297c478bd9Sstevel@tonic-gate 307c478bd9Sstevel@tonic-gate #ifdef __cplusplus 317c478bd9Sstevel@tonic-gate extern "C" { 327c478bd9Sstevel@tonic-gate #endif 337c478bd9Sstevel@tonic-gate 347c478bd9Sstevel@tonic-gate /* 357c478bd9Sstevel@tonic-gate * DTrace Dynamic Tracing Software: Kernel Interfaces 367c478bd9Sstevel@tonic-gate * 377c478bd9Sstevel@tonic-gate * Note: The contents of this file are private to the implementation of the 387c478bd9Sstevel@tonic-gate * Solaris system and DTrace subsystem and are subject to change at any time 397c478bd9Sstevel@tonic-gate * without notice. Applications and drivers using these interfaces will fail 407c478bd9Sstevel@tonic-gate * to run on future releases. These interfaces should not be used for any 417c478bd9Sstevel@tonic-gate * purpose except those expressly outlined in dtrace(7D) and libdtrace(3LIB). 427c478bd9Sstevel@tonic-gate * Please refer to the "Solaris Dynamic Tracing Guide" for more information. 437c478bd9Sstevel@tonic-gate */ 447c478bd9Sstevel@tonic-gate 457c478bd9Sstevel@tonic-gate #ifndef _ASM 467c478bd9Sstevel@tonic-gate 477c478bd9Sstevel@tonic-gate #include <sys/types.h> 487c478bd9Sstevel@tonic-gate #include <sys/modctl.h> 497c478bd9Sstevel@tonic-gate #include <sys/processor.h> 507c478bd9Sstevel@tonic-gate #include <sys/systm.h> 517c478bd9Sstevel@tonic-gate #include <sys/ctf_api.h> 527c478bd9Sstevel@tonic-gate #include <sys/cyclic.h> 537c478bd9Sstevel@tonic-gate #include <sys/int_limits.h> 547c478bd9Sstevel@tonic-gate 557c478bd9Sstevel@tonic-gate /* 567c478bd9Sstevel@tonic-gate * DTrace Universal Constants and Typedefs 577c478bd9Sstevel@tonic-gate */ 587c478bd9Sstevel@tonic-gate #define DTRACE_CPUALL -1 /* all CPUs */ 597c478bd9Sstevel@tonic-gate #define DTRACE_IDNONE 0 /* invalid probe identifier */ 607c478bd9Sstevel@tonic-gate #define DTRACE_EPIDNONE 0 /* invalid enabled probe identifier */ 617c478bd9Sstevel@tonic-gate #define DTRACE_AGGIDNONE 0 /* invalid aggregation identifier */ 6230ef842dSbmc #define DTRACE_AGGVARIDNONE 0 /* invalid aggregation variable ID */ 637c478bd9Sstevel@tonic-gate #define DTRACE_CACHEIDNONE 0 /* invalid predicate cache */ 647c478bd9Sstevel@tonic-gate #define DTRACE_PROVNONE 0 /* invalid provider identifier */ 657c478bd9Sstevel@tonic-gate #define DTRACE_METAPROVNONE 0 /* invalid meta-provider identifier */ 667c478bd9Sstevel@tonic-gate #define DTRACE_ARGNONE -1 /* invalid argument index */ 677c478bd9Sstevel@tonic-gate 687c478bd9Sstevel@tonic-gate #define DTRACE_PROVNAMELEN 64 697c478bd9Sstevel@tonic-gate #define DTRACE_MODNAMELEN 64 707c478bd9Sstevel@tonic-gate #define DTRACE_FUNCNAMELEN 128 717c478bd9Sstevel@tonic-gate #define DTRACE_NAMELEN 64 727c478bd9Sstevel@tonic-gate #define DTRACE_FULLNAMELEN (DTRACE_PROVNAMELEN + DTRACE_MODNAMELEN + \ 737c478bd9Sstevel@tonic-gate DTRACE_FUNCNAMELEN + DTRACE_NAMELEN + 4) 747c478bd9Sstevel@tonic-gate #define DTRACE_ARGTYPELEN 128 757c478bd9Sstevel@tonic-gate 767c478bd9Sstevel@tonic-gate typedef uint32_t dtrace_id_t; /* probe identifier */ 777c478bd9Sstevel@tonic-gate typedef uint32_t dtrace_epid_t; /* enabled probe identifier */ 787c478bd9Sstevel@tonic-gate typedef uint32_t dtrace_aggid_t; /* aggregation identifier */ 7930ef842dSbmc typedef int64_t dtrace_aggvarid_t; /* aggregation variable identifier */ 807c478bd9Sstevel@tonic-gate typedef uint16_t dtrace_actkind_t; /* action kind */ 817c478bd9Sstevel@tonic-gate typedef int64_t dtrace_optval_t; /* option value */ 827c478bd9Sstevel@tonic-gate typedef uint32_t dtrace_cacheid_t; /* predicate cache identifier */ 837c478bd9Sstevel@tonic-gate 847c478bd9Sstevel@tonic-gate typedef enum dtrace_probespec { 857c478bd9Sstevel@tonic-gate DTRACE_PROBESPEC_NONE = -1, 867c478bd9Sstevel@tonic-gate DTRACE_PROBESPEC_PROVIDER = 0, 877c478bd9Sstevel@tonic-gate DTRACE_PROBESPEC_MOD, 887c478bd9Sstevel@tonic-gate DTRACE_PROBESPEC_FUNC, 897c478bd9Sstevel@tonic-gate DTRACE_PROBESPEC_NAME 907c478bd9Sstevel@tonic-gate } dtrace_probespec_t; 917c478bd9Sstevel@tonic-gate 927c478bd9Sstevel@tonic-gate /* 937c478bd9Sstevel@tonic-gate * DTrace Intermediate Format (DIF) 947c478bd9Sstevel@tonic-gate * 957c478bd9Sstevel@tonic-gate * The following definitions describe the DTrace Intermediate Format (DIF), a 967c478bd9Sstevel@tonic-gate * a RISC-like instruction set and program encoding used to represent 977c478bd9Sstevel@tonic-gate * predicates and actions that can be bound to DTrace probes. The constants 987c478bd9Sstevel@tonic-gate * below defining the number of available registers are suggested minimums; the 997c478bd9Sstevel@tonic-gate * compiler should use DTRACEIOC_CONF to dynamically obtain the number of 1007c478bd9Sstevel@tonic-gate * registers provided by the current DTrace implementation. 1017c478bd9Sstevel@tonic-gate */ 1027c478bd9Sstevel@tonic-gate #define DIF_VERSION_1 1 /* DIF version 1: Solaris 10 Beta */ 1037c478bd9Sstevel@tonic-gate #define DIF_VERSION_2 2 /* DIF version 2: Solaris 10 FCS */ 1047c478bd9Sstevel@tonic-gate #define DIF_VERSION DIF_VERSION_2 /* latest DIF instruction set version */ 1057c478bd9Sstevel@tonic-gate #define DIF_DIR_NREGS 8 /* number of DIF integer registers */ 1067c478bd9Sstevel@tonic-gate #define DIF_DTR_NREGS 8 /* number of DIF tuple registers */ 1077c478bd9Sstevel@tonic-gate 1087c478bd9Sstevel@tonic-gate #define DIF_OP_OR 1 /* or r1, r2, rd */ 1097c478bd9Sstevel@tonic-gate #define DIF_OP_XOR 2 /* xor r1, r2, rd */ 1107c478bd9Sstevel@tonic-gate #define DIF_OP_AND 3 /* and r1, r2, rd */ 1117c478bd9Sstevel@tonic-gate #define DIF_OP_SLL 4 /* sll r1, r2, rd */ 1127c478bd9Sstevel@tonic-gate #define DIF_OP_SRL 5 /* srl r1, r2, rd */ 1137c478bd9Sstevel@tonic-gate #define DIF_OP_SUB 6 /* sub r1, r2, rd */ 1147c478bd9Sstevel@tonic-gate #define DIF_OP_ADD 7 /* add r1, r2, rd */ 1157c478bd9Sstevel@tonic-gate #define DIF_OP_MUL 8 /* mul r1, r2, rd */ 1167c478bd9Sstevel@tonic-gate #define DIF_OP_SDIV 9 /* sdiv r1, r2, rd */ 1177c478bd9Sstevel@tonic-gate #define DIF_OP_UDIV 10 /* udiv r1, r2, rd */ 1187c478bd9Sstevel@tonic-gate #define DIF_OP_SREM 11 /* srem r1, r2, rd */ 1197c478bd9Sstevel@tonic-gate #define DIF_OP_UREM 12 /* urem r1, r2, rd */ 1207c478bd9Sstevel@tonic-gate #define DIF_OP_NOT 13 /* not r1, rd */ 1217c478bd9Sstevel@tonic-gate #define DIF_OP_MOV 14 /* mov r1, rd */ 1227c478bd9Sstevel@tonic-gate #define DIF_OP_CMP 15 /* cmp r1, r2 */ 1237c478bd9Sstevel@tonic-gate #define DIF_OP_TST 16 /* tst r1 */ 1247c478bd9Sstevel@tonic-gate #define DIF_OP_BA 17 /* ba label */ 1257c478bd9Sstevel@tonic-gate #define DIF_OP_BE 18 /* be label */ 1267c478bd9Sstevel@tonic-gate #define DIF_OP_BNE 19 /* bne label */ 1277c478bd9Sstevel@tonic-gate #define DIF_OP_BG 20 /* bg label */ 1287c478bd9Sstevel@tonic-gate #define DIF_OP_BGU 21 /* bgu label */ 1297c478bd9Sstevel@tonic-gate #define DIF_OP_BGE 22 /* bge label */ 1307c478bd9Sstevel@tonic-gate #define DIF_OP_BGEU 23 /* bgeu label */ 1317c478bd9Sstevel@tonic-gate #define DIF_OP_BL 24 /* bl label */ 1327c478bd9Sstevel@tonic-gate #define DIF_OP_BLU 25 /* blu label */ 1337c478bd9Sstevel@tonic-gate #define DIF_OP_BLE 26 /* ble label */ 1347c478bd9Sstevel@tonic-gate #define DIF_OP_BLEU 27 /* bleu label */ 1357c478bd9Sstevel@tonic-gate #define DIF_OP_LDSB 28 /* ldsb [r1], rd */ 1367c478bd9Sstevel@tonic-gate #define DIF_OP_LDSH 29 /* ldsh [r1], rd */ 1377c478bd9Sstevel@tonic-gate #define DIF_OP_LDSW 30 /* ldsw [r1], rd */ 1387c478bd9Sstevel@tonic-gate #define DIF_OP_LDUB 31 /* ldub [r1], rd */ 1397c478bd9Sstevel@tonic-gate #define DIF_OP_LDUH 32 /* lduh [r1], rd */ 1407c478bd9Sstevel@tonic-gate #define DIF_OP_LDUW 33 /* lduw [r1], rd */ 1417c478bd9Sstevel@tonic-gate #define DIF_OP_LDX 34 /* ldx [r1], rd */ 1427c478bd9Sstevel@tonic-gate #define DIF_OP_RET 35 /* ret rd */ 1437c478bd9Sstevel@tonic-gate #define DIF_OP_NOP 36 /* nop */ 1447c478bd9Sstevel@tonic-gate #define DIF_OP_SETX 37 /* setx intindex, rd */ 1457c478bd9Sstevel@tonic-gate #define DIF_OP_SETS 38 /* sets strindex, rd */ 1467c478bd9Sstevel@tonic-gate #define DIF_OP_SCMP 39 /* scmp r1, r2 */ 1477c478bd9Sstevel@tonic-gate #define DIF_OP_LDGA 40 /* ldga var, ri, rd */ 1487c478bd9Sstevel@tonic-gate #define DIF_OP_LDGS 41 /* ldgs var, rd */ 1497c478bd9Sstevel@tonic-gate #define DIF_OP_STGS 42 /* stgs var, rs */ 1507c478bd9Sstevel@tonic-gate #define DIF_OP_LDTA 43 /* ldta var, ri, rd */ 1517c478bd9Sstevel@tonic-gate #define DIF_OP_LDTS 44 /* ldts var, rd */ 1527c478bd9Sstevel@tonic-gate #define DIF_OP_STTS 45 /* stts var, rs */ 1537c478bd9Sstevel@tonic-gate #define DIF_OP_SRA 46 /* sra r1, r2, rd */ 1547c478bd9Sstevel@tonic-gate #define DIF_OP_CALL 47 /* call subr, rd */ 1557c478bd9Sstevel@tonic-gate #define DIF_OP_PUSHTR 48 /* pushtr type, rs, rr */ 1567c478bd9Sstevel@tonic-gate #define DIF_OP_PUSHTV 49 /* pushtv type, rs, rv */ 1577c478bd9Sstevel@tonic-gate #define DIF_OP_POPTS 50 /* popts */ 1587c478bd9Sstevel@tonic-gate #define DIF_OP_FLUSHTS 51 /* flushts */ 1597c478bd9Sstevel@tonic-gate #define DIF_OP_LDGAA 52 /* ldgaa var, rd */ 1607c478bd9Sstevel@tonic-gate #define DIF_OP_LDTAA 53 /* ldtaa var, rd */ 1617c478bd9Sstevel@tonic-gate #define DIF_OP_STGAA 54 /* stgaa var, rs */ 1627c478bd9Sstevel@tonic-gate #define DIF_OP_STTAA 55 /* sttaa var, rs */ 1637c478bd9Sstevel@tonic-gate #define DIF_OP_LDLS 56 /* ldls var, rd */ 1647c478bd9Sstevel@tonic-gate #define DIF_OP_STLS 57 /* stls var, rs */ 1657c478bd9Sstevel@tonic-gate #define DIF_OP_ALLOCS 58 /* allocs r1, rd */ 1667c478bd9Sstevel@tonic-gate #define DIF_OP_COPYS 59 /* copys r1, r2, rd */ 1677c478bd9Sstevel@tonic-gate #define DIF_OP_STB 60 /* stb r1, [rd] */ 1687c478bd9Sstevel@tonic-gate #define DIF_OP_STH 61 /* sth r1, [rd] */ 1697c478bd9Sstevel@tonic-gate #define DIF_OP_STW 62 /* stw r1, [rd] */ 1707c478bd9Sstevel@tonic-gate #define DIF_OP_STX 63 /* stx r1, [rd] */ 1717c478bd9Sstevel@tonic-gate #define DIF_OP_ULDSB 64 /* uldsb [r1], rd */ 1727c478bd9Sstevel@tonic-gate #define DIF_OP_ULDSH 65 /* uldsh [r1], rd */ 1737c478bd9Sstevel@tonic-gate #define DIF_OP_ULDSW 66 /* uldsw [r1], rd */ 1747c478bd9Sstevel@tonic-gate #define DIF_OP_ULDUB 67 /* uldub [r1], rd */ 1757c478bd9Sstevel@tonic-gate #define DIF_OP_ULDUH 68 /* ulduh [r1], rd */ 1767c478bd9Sstevel@tonic-gate #define DIF_OP_ULDUW 69 /* ulduw [r1], rd */ 1777c478bd9Sstevel@tonic-gate #define DIF_OP_ULDX 70 /* uldx [r1], rd */ 1787c478bd9Sstevel@tonic-gate #define DIF_OP_RLDSB 71 /* rldsb [r1], rd */ 1797c478bd9Sstevel@tonic-gate #define DIF_OP_RLDSH 72 /* rldsh [r1], rd */ 1807c478bd9Sstevel@tonic-gate #define DIF_OP_RLDSW 73 /* rldsw [r1], rd */ 1817c478bd9Sstevel@tonic-gate #define DIF_OP_RLDUB 74 /* rldub [r1], rd */ 1827c478bd9Sstevel@tonic-gate #define DIF_OP_RLDUH 75 /* rlduh [r1], rd */ 1837c478bd9Sstevel@tonic-gate #define DIF_OP_RLDUW 76 /* rlduw [r1], rd */ 1847c478bd9Sstevel@tonic-gate #define DIF_OP_RLDX 77 /* rldx [r1], rd */ 1851a7c1b72Smws #define DIF_OP_XLATE 78 /* xlate xlrindex, rd */ 1861a7c1b72Smws #define DIF_OP_XLARG 79 /* xlarg xlrindex, rd */ 1877c478bd9Sstevel@tonic-gate 1887c478bd9Sstevel@tonic-gate #define DIF_INTOFF_MAX 0xffff /* highest integer table offset */ 1897c478bd9Sstevel@tonic-gate #define DIF_STROFF_MAX 0xffff /* highest string table offset */ 1907c478bd9Sstevel@tonic-gate #define DIF_REGISTER_MAX 0xff /* highest register number */ 1917c478bd9Sstevel@tonic-gate #define DIF_VARIABLE_MAX 0xffff /* highest variable identifier */ 1927c478bd9Sstevel@tonic-gate #define DIF_SUBROUTINE_MAX 0xffff /* highest subroutine code */ 1937c478bd9Sstevel@tonic-gate 1947c478bd9Sstevel@tonic-gate #define DIF_VAR_ARRAY_MIN 0x0000 /* lowest numbered array variable */ 1957c478bd9Sstevel@tonic-gate #define DIF_VAR_ARRAY_UBASE 0x0080 /* lowest user-defined array */ 1967c478bd9Sstevel@tonic-gate #define DIF_VAR_ARRAY_MAX 0x00ff /* highest numbered array variable */ 1977c478bd9Sstevel@tonic-gate 1987c478bd9Sstevel@tonic-gate #define DIF_VAR_OTHER_MIN 0x0100 /* lowest numbered scalar or assc */ 1997c478bd9Sstevel@tonic-gate #define DIF_VAR_OTHER_UBASE 0x0500 /* lowest user-defined scalar or assc */ 2007c478bd9Sstevel@tonic-gate #define DIF_VAR_OTHER_MAX 0xffff /* highest numbered scalar or assc */ 2017c478bd9Sstevel@tonic-gate 2027c478bd9Sstevel@tonic-gate #define DIF_VAR_ARGS 0x0000 /* arguments array */ 2037c478bd9Sstevel@tonic-gate #define DIF_VAR_REGS 0x0001 /* registers array */ 2047c478bd9Sstevel@tonic-gate #define DIF_VAR_UREGS 0x0002 /* user registers array */ 2057c478bd9Sstevel@tonic-gate #define DIF_VAR_CURTHREAD 0x0100 /* thread pointer */ 2067c478bd9Sstevel@tonic-gate #define DIF_VAR_TIMESTAMP 0x0101 /* timestamp */ 2077c478bd9Sstevel@tonic-gate #define DIF_VAR_VTIMESTAMP 0x0102 /* virtual timestamp */ 2087c478bd9Sstevel@tonic-gate #define DIF_VAR_IPL 0x0103 /* interrupt priority level */ 2097c478bd9Sstevel@tonic-gate #define DIF_VAR_EPID 0x0104 /* enabled probe ID */ 2107c478bd9Sstevel@tonic-gate #define DIF_VAR_ID 0x0105 /* probe ID */ 2117c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG0 0x0106 /* first argument */ 2127c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG1 0x0107 /* second argument */ 2137c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG2 0x0108 /* third argument */ 2147c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG3 0x0109 /* fourth argument */ 2157c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG4 0x010a /* fifth argument */ 2167c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG5 0x010b /* sixth argument */ 2177c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG6 0x010c /* seventh argument */ 2187c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG7 0x010d /* eighth argument */ 2197c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG8 0x010e /* ninth argument */ 2207c478bd9Sstevel@tonic-gate #define DIF_VAR_ARG9 0x010f /* tenth argument */ 2217c478bd9Sstevel@tonic-gate #define DIF_VAR_STACKDEPTH 0x0110 /* stack depth */ 2227c478bd9Sstevel@tonic-gate #define DIF_VAR_CALLER 0x0111 /* caller */ 2237c478bd9Sstevel@tonic-gate #define DIF_VAR_PROBEPROV 0x0112 /* probe provider */ 2247c478bd9Sstevel@tonic-gate #define DIF_VAR_PROBEMOD 0x0113 /* probe module */ 2257c478bd9Sstevel@tonic-gate #define DIF_VAR_PROBEFUNC 0x0114 /* probe function */ 2267c478bd9Sstevel@tonic-gate #define DIF_VAR_PROBENAME 0x0115 /* probe name */ 2277c478bd9Sstevel@tonic-gate #define DIF_VAR_PID 0x0116 /* process ID */ 2287c478bd9Sstevel@tonic-gate #define DIF_VAR_TID 0x0117 /* (per-process) thread ID */ 2297c478bd9Sstevel@tonic-gate #define DIF_VAR_EXECNAME 0x0118 /* name of executable */ 2307c478bd9Sstevel@tonic-gate #define DIF_VAR_ZONENAME 0x0119 /* zone name associated with process */ 2317c478bd9Sstevel@tonic-gate #define DIF_VAR_WALLTIMESTAMP 0x011a /* wall-clock timestamp */ 2320b38a8bdSahl #define DIF_VAR_USTACKDEPTH 0x011b /* user-land stack depth */ 233a1b5e537Sbmc #define DIF_VAR_UCALLER 0x011c /* user-level caller */ 2345518d15bSdp #define DIF_VAR_PPID 0x011d /* parent process ID */ 2355518d15bSdp #define DIF_VAR_UID 0x011e /* process user ID */ 2365518d15bSdp #define DIF_VAR_GID 0x011f /* process group ID */ 2375518d15bSdp #define DIF_VAR_ERRNO 0x0120 /* thread errno */ 2387c478bd9Sstevel@tonic-gate 2397c478bd9Sstevel@tonic-gate #define DIF_SUBR_RAND 0 2407c478bd9Sstevel@tonic-gate #define DIF_SUBR_MUTEX_OWNED 1 2417c478bd9Sstevel@tonic-gate #define DIF_SUBR_MUTEX_OWNER 2 2427c478bd9Sstevel@tonic-gate #define DIF_SUBR_MUTEX_TYPE_ADAPTIVE 3 2437c478bd9Sstevel@tonic-gate #define DIF_SUBR_MUTEX_TYPE_SPIN 4 2447c478bd9Sstevel@tonic-gate #define DIF_SUBR_RW_READ_HELD 5 2457c478bd9Sstevel@tonic-gate #define DIF_SUBR_RW_WRITE_HELD 6 2467c478bd9Sstevel@tonic-gate #define DIF_SUBR_RW_ISWRITER 7 2477c478bd9Sstevel@tonic-gate #define DIF_SUBR_COPYIN 8 2487c478bd9Sstevel@tonic-gate #define DIF_SUBR_COPYINSTR 9 2497c478bd9Sstevel@tonic-gate #define DIF_SUBR_SPECULATION 10 2507c478bd9Sstevel@tonic-gate #define DIF_SUBR_PROGENYOF 11 2517c478bd9Sstevel@tonic-gate #define DIF_SUBR_STRLEN 12 2527c478bd9Sstevel@tonic-gate #define DIF_SUBR_COPYOUT 13 2537c478bd9Sstevel@tonic-gate #define DIF_SUBR_COPYOUTSTR 14 2547c478bd9Sstevel@tonic-gate #define DIF_SUBR_ALLOCA 15 2557c478bd9Sstevel@tonic-gate #define DIF_SUBR_BCOPY 16 2567c478bd9Sstevel@tonic-gate #define DIF_SUBR_COPYINTO 17 2577c478bd9Sstevel@tonic-gate #define DIF_SUBR_MSGDSIZE 18 2587c478bd9Sstevel@tonic-gate #define DIF_SUBR_MSGSIZE 19 2597c478bd9Sstevel@tonic-gate #define DIF_SUBR_GETMAJOR 20 2607c478bd9Sstevel@tonic-gate #define DIF_SUBR_GETMINOR 21 2617c478bd9Sstevel@tonic-gate #define DIF_SUBR_DDI_PATHNAME 22 2627c478bd9Sstevel@tonic-gate #define DIF_SUBR_STRJOIN 23 2637c478bd9Sstevel@tonic-gate #define DIF_SUBR_LLTOSTR 24 2647c478bd9Sstevel@tonic-gate #define DIF_SUBR_BASENAME 25 2657c478bd9Sstevel@tonic-gate #define DIF_SUBR_DIRNAME 26 2667c478bd9Sstevel@tonic-gate #define DIF_SUBR_CLEANPATH 27 2677c478bd9Sstevel@tonic-gate #define DIF_SUBR_STRCHR 28 2687c478bd9Sstevel@tonic-gate #define DIF_SUBR_STRRCHR 29 2697c478bd9Sstevel@tonic-gate #define DIF_SUBR_STRSTR 30 2707c478bd9Sstevel@tonic-gate #define DIF_SUBR_STRTOK 31 2717c478bd9Sstevel@tonic-gate #define DIF_SUBR_SUBSTR 32 2727c478bd9Sstevel@tonic-gate #define DIF_SUBR_INDEX 33 2737c478bd9Sstevel@tonic-gate #define DIF_SUBR_RINDEX 34 2742b6e762cSahl #define DIF_SUBR_HTONS 35 2752b6e762cSahl #define DIF_SUBR_HTONL 36 2762b6e762cSahl #define DIF_SUBR_HTONLL 37 2772b6e762cSahl #define DIF_SUBR_NTOHS 38 2782b6e762cSahl #define DIF_SUBR_NTOHL 39 2792b6e762cSahl #define DIF_SUBR_NTOHLL 40 2804edabff4Sbrendan #define DIF_SUBR_INET_NTOP 41 2814edabff4Sbrendan #define DIF_SUBR_INET_NTOA 42 2824edabff4Sbrendan #define DIF_SUBR_INET_NTOA6 43 2837c478bd9Sstevel@tonic-gate 2844edabff4Sbrendan #define DIF_SUBR_MAX 43 /* max subroutine value */ 2857c478bd9Sstevel@tonic-gate 2867c478bd9Sstevel@tonic-gate typedef uint32_t dif_instr_t; 2877c478bd9Sstevel@tonic-gate 2887c478bd9Sstevel@tonic-gate #define DIF_INSTR_OP(i) (((i) >> 24) & 0xff) 2897c478bd9Sstevel@tonic-gate #define DIF_INSTR_R1(i) (((i) >> 16) & 0xff) 2907c478bd9Sstevel@tonic-gate #define DIF_INSTR_R2(i) (((i) >> 8) & 0xff) 2917c478bd9Sstevel@tonic-gate #define DIF_INSTR_RD(i) ((i) & 0xff) 2927c478bd9Sstevel@tonic-gate #define DIF_INSTR_RS(i) ((i) & 0xff) 2937c478bd9Sstevel@tonic-gate #define DIF_INSTR_LABEL(i) ((i) & 0xffffff) 2947c478bd9Sstevel@tonic-gate #define DIF_INSTR_VAR(i) (((i) >> 8) & 0xffff) 2957c478bd9Sstevel@tonic-gate #define DIF_INSTR_INTEGER(i) (((i) >> 8) & 0xffff) 2967c478bd9Sstevel@tonic-gate #define DIF_INSTR_STRING(i) (((i) >> 8) & 0xffff) 2977c478bd9Sstevel@tonic-gate #define DIF_INSTR_SUBR(i) (((i) >> 8) & 0xffff) 2987c478bd9Sstevel@tonic-gate #define DIF_INSTR_TYPE(i) (((i) >> 16) & 0xff) 2991a7c1b72Smws #define DIF_INSTR_XLREF(i) (((i) >> 8) & 0xffff) 3007c478bd9Sstevel@tonic-gate 3017c478bd9Sstevel@tonic-gate #define DIF_INSTR_FMT(op, r1, r2, d) \ 3027c478bd9Sstevel@tonic-gate (((op) << 24) | ((r1) << 16) | ((r2) << 8) | (d)) 3037c478bd9Sstevel@tonic-gate 3047c478bd9Sstevel@tonic-gate #define DIF_INSTR_NOT(r1, d) (DIF_INSTR_FMT(DIF_OP_NOT, r1, 0, d)) 3057c478bd9Sstevel@tonic-gate #define DIF_INSTR_MOV(r1, d) (DIF_INSTR_FMT(DIF_OP_MOV, r1, 0, d)) 3067c478bd9Sstevel@tonic-gate #define DIF_INSTR_CMP(op, r1, r2) (DIF_INSTR_FMT(op, r1, r2, 0)) 3077c478bd9Sstevel@tonic-gate #define DIF_INSTR_TST(r1) (DIF_INSTR_FMT(DIF_OP_TST, r1, 0, 0)) 3087c478bd9Sstevel@tonic-gate #define DIF_INSTR_BRANCH(op, label) (((op) << 24) | (label)) 3097c478bd9Sstevel@tonic-gate #define DIF_INSTR_LOAD(op, r1, d) (DIF_INSTR_FMT(op, r1, 0, d)) 3107c478bd9Sstevel@tonic-gate #define DIF_INSTR_STORE(op, r1, d) (DIF_INSTR_FMT(op, r1, 0, d)) 3117c478bd9Sstevel@tonic-gate #define DIF_INSTR_SETX(i, d) ((DIF_OP_SETX << 24) | ((i) << 8) | (d)) 3127c478bd9Sstevel@tonic-gate #define DIF_INSTR_SETS(s, d) ((DIF_OP_SETS << 24) | ((s) << 8) | (d)) 3137c478bd9Sstevel@tonic-gate #define DIF_INSTR_RET(d) (DIF_INSTR_FMT(DIF_OP_RET, 0, 0, d)) 3147c478bd9Sstevel@tonic-gate #define DIF_INSTR_NOP (DIF_OP_NOP << 24) 3157c478bd9Sstevel@tonic-gate #define DIF_INSTR_LDA(op, v, r, d) (DIF_INSTR_FMT(op, v, r, d)) 3167c478bd9Sstevel@tonic-gate #define DIF_INSTR_LDV(op, v, d) (((op) << 24) | ((v) << 8) | (d)) 3177c478bd9Sstevel@tonic-gate #define DIF_INSTR_STV(op, v, rs) (((op) << 24) | ((v) << 8) | (rs)) 3187c478bd9Sstevel@tonic-gate #define DIF_INSTR_CALL(s, d) ((DIF_OP_CALL << 24) | ((s) << 8) | (d)) 3197c478bd9Sstevel@tonic-gate #define DIF_INSTR_PUSHTS(op, t, r2, rs) (DIF_INSTR_FMT(op, t, r2, rs)) 3207c478bd9Sstevel@tonic-gate #define DIF_INSTR_POPTS (DIF_OP_POPTS << 24) 3217c478bd9Sstevel@tonic-gate #define DIF_INSTR_FLUSHTS (DIF_OP_FLUSHTS << 24) 3227c478bd9Sstevel@tonic-gate #define DIF_INSTR_ALLOCS(r1, d) (DIF_INSTR_FMT(DIF_OP_ALLOCS, r1, 0, d)) 3237c478bd9Sstevel@tonic-gate #define DIF_INSTR_COPYS(r1, r2, d) (DIF_INSTR_FMT(DIF_OP_COPYS, r1, r2, d)) 3241a7c1b72Smws #define DIF_INSTR_XLATE(op, r, d) (((op) << 24) | ((r) << 8) | (d)) 3257c478bd9Sstevel@tonic-gate 3267c478bd9Sstevel@tonic-gate #define DIF_REG_R0 0 /* %r0 is always set to zero */ 3277c478bd9Sstevel@tonic-gate 3287c478bd9Sstevel@tonic-gate /* 3297c478bd9Sstevel@tonic-gate * A DTrace Intermediate Format Type (DIF Type) is used to represent the types 3307c478bd9Sstevel@tonic-gate * of variables, function and associative array arguments, and the return type 3317c478bd9Sstevel@tonic-gate * for each DIF object (shown below). It contains a description of the type, 3327c478bd9Sstevel@tonic-gate * its size in bytes, and a module identifier. 3337c478bd9Sstevel@tonic-gate */ 3347c478bd9Sstevel@tonic-gate typedef struct dtrace_diftype { 3357c478bd9Sstevel@tonic-gate uint8_t dtdt_kind; /* type kind (see below) */ 3367c478bd9Sstevel@tonic-gate uint8_t dtdt_ckind; /* type kind in CTF */ 3377c478bd9Sstevel@tonic-gate uint8_t dtdt_flags; /* type flags (see below) */ 3387c478bd9Sstevel@tonic-gate uint8_t dtdt_pad; /* reserved for future use */ 3397c478bd9Sstevel@tonic-gate uint32_t dtdt_size; /* type size in bytes (unless string) */ 3407c478bd9Sstevel@tonic-gate } dtrace_diftype_t; 3417c478bd9Sstevel@tonic-gate 3427c478bd9Sstevel@tonic-gate #define DIF_TYPE_CTF 0 /* type is a CTF type */ 3437c478bd9Sstevel@tonic-gate #define DIF_TYPE_STRING 1 /* type is a D string */ 3447c478bd9Sstevel@tonic-gate 3457c478bd9Sstevel@tonic-gate #define DIF_TF_BYREF 0x1 /* type is passed by reference */ 3467c478bd9Sstevel@tonic-gate 3477c478bd9Sstevel@tonic-gate /* 3487c478bd9Sstevel@tonic-gate * A DTrace Intermediate Format variable record is used to describe each of the 3497c478bd9Sstevel@tonic-gate * variables referenced by a given DIF object. It contains an integer variable 3507c478bd9Sstevel@tonic-gate * identifier along with variable scope and properties, as shown below. The 3517c478bd9Sstevel@tonic-gate * size of this structure must be sizeof (int) aligned. 3527c478bd9Sstevel@tonic-gate */ 3537c478bd9Sstevel@tonic-gate typedef struct dtrace_difv { 3547c478bd9Sstevel@tonic-gate uint32_t dtdv_name; /* variable name index in dtdo_strtab */ 3557c478bd9Sstevel@tonic-gate uint32_t dtdv_id; /* variable reference identifier */ 3567c478bd9Sstevel@tonic-gate uint8_t dtdv_kind; /* variable kind (see below) */ 3577c478bd9Sstevel@tonic-gate uint8_t dtdv_scope; /* variable scope (see below) */ 3587c478bd9Sstevel@tonic-gate uint16_t dtdv_flags; /* variable flags (see below) */ 3597c478bd9Sstevel@tonic-gate dtrace_diftype_t dtdv_type; /* variable type (see above) */ 3607c478bd9Sstevel@tonic-gate } dtrace_difv_t; 3617c478bd9Sstevel@tonic-gate 3627c478bd9Sstevel@tonic-gate #define DIFV_KIND_ARRAY 0 /* variable is an array of quantities */ 3637c478bd9Sstevel@tonic-gate #define DIFV_KIND_SCALAR 1 /* variable is a scalar quantity */ 3647c478bd9Sstevel@tonic-gate 3657c478bd9Sstevel@tonic-gate #define DIFV_SCOPE_GLOBAL 0 /* variable has global scope */ 3667c478bd9Sstevel@tonic-gate #define DIFV_SCOPE_THREAD 1 /* variable has thread scope */ 3677c478bd9Sstevel@tonic-gate #define DIFV_SCOPE_LOCAL 2 /* variable has local scope */ 3687c478bd9Sstevel@tonic-gate 3697c478bd9Sstevel@tonic-gate #define DIFV_F_REF 0x1 /* variable is referenced by DIFO */ 3707c478bd9Sstevel@tonic-gate #define DIFV_F_MOD 0x2 /* variable is written by DIFO */ 3717c478bd9Sstevel@tonic-gate 3727c478bd9Sstevel@tonic-gate /* 3737c478bd9Sstevel@tonic-gate * DTrace Actions 3747c478bd9Sstevel@tonic-gate * 3757c478bd9Sstevel@tonic-gate * The upper byte determines the class of the action; the low bytes determines 3767c478bd9Sstevel@tonic-gate * the specific action within that class. The classes of actions are as 3777c478bd9Sstevel@tonic-gate * follows: 3787c478bd9Sstevel@tonic-gate * 3797c478bd9Sstevel@tonic-gate * [ no class ] <= May record process- or kernel-related data 3807c478bd9Sstevel@tonic-gate * DTRACEACT_PROC <= Only records process-related data 3817c478bd9Sstevel@tonic-gate * DTRACEACT_PROC_DESTRUCTIVE <= Potentially destructive to processes 3827c478bd9Sstevel@tonic-gate * DTRACEACT_KERNEL <= Only records kernel-related data 3837c478bd9Sstevel@tonic-gate * DTRACEACT_KERNEL_DESTRUCTIVE <= Potentially destructive to the kernel 3847c478bd9Sstevel@tonic-gate * DTRACEACT_SPECULATIVE <= Speculation-related action 3857c478bd9Sstevel@tonic-gate * DTRACEACT_AGGREGATION <= Aggregating action 3867c478bd9Sstevel@tonic-gate */ 3877c478bd9Sstevel@tonic-gate #define DTRACEACT_NONE 0 /* no action */ 3887c478bd9Sstevel@tonic-gate #define DTRACEACT_DIFEXPR 1 /* action is DIF expression */ 3897c478bd9Sstevel@tonic-gate #define DTRACEACT_EXIT 2 /* exit() action */ 3907c478bd9Sstevel@tonic-gate #define DTRACEACT_PRINTF 3 /* printf() action */ 3917c478bd9Sstevel@tonic-gate #define DTRACEACT_PRINTA 4 /* printa() action */ 3927c478bd9Sstevel@tonic-gate #define DTRACEACT_LIBACT 5 /* library-controlled action */ 3937c478bd9Sstevel@tonic-gate 3947c478bd9Sstevel@tonic-gate #define DTRACEACT_PROC 0x0100 3957c478bd9Sstevel@tonic-gate #define DTRACEACT_USTACK (DTRACEACT_PROC + 1) 3967c478bd9Sstevel@tonic-gate #define DTRACEACT_JSTACK (DTRACEACT_PROC + 2) 397a1b5e537Sbmc #define DTRACEACT_USYM (DTRACEACT_PROC + 3) 398a1b5e537Sbmc #define DTRACEACT_UMOD (DTRACEACT_PROC + 4) 399a1b5e537Sbmc #define DTRACEACT_UADDR (DTRACEACT_PROC + 5) 4007c478bd9Sstevel@tonic-gate 4017c478bd9Sstevel@tonic-gate #define DTRACEACT_PROC_DESTRUCTIVE 0x0200 4027c478bd9Sstevel@tonic-gate #define DTRACEACT_STOP (DTRACEACT_PROC_DESTRUCTIVE + 1) 4037c478bd9Sstevel@tonic-gate #define DTRACEACT_RAISE (DTRACEACT_PROC_DESTRUCTIVE + 2) 4047c478bd9Sstevel@tonic-gate #define DTRACEACT_SYSTEM (DTRACEACT_PROC_DESTRUCTIVE + 3) 4057c478bd9Sstevel@tonic-gate #define DTRACEACT_FREOPEN (DTRACEACT_PROC_DESTRUCTIVE + 4) 4067c478bd9Sstevel@tonic-gate 4077c478bd9Sstevel@tonic-gate #define DTRACEACT_PROC_CONTROL 0x0300 4087c478bd9Sstevel@tonic-gate 4097c478bd9Sstevel@tonic-gate #define DTRACEACT_KERNEL 0x0400 4107c478bd9Sstevel@tonic-gate #define DTRACEACT_STACK (DTRACEACT_KERNEL + 1) 411a1b5e537Sbmc #define DTRACEACT_SYM (DTRACEACT_KERNEL + 2) 412a1b5e537Sbmc #define DTRACEACT_MOD (DTRACEACT_KERNEL + 3) 4137c478bd9Sstevel@tonic-gate 4147c478bd9Sstevel@tonic-gate #define DTRACEACT_KERNEL_DESTRUCTIVE 0x0500 4157c478bd9Sstevel@tonic-gate #define DTRACEACT_BREAKPOINT (DTRACEACT_KERNEL_DESTRUCTIVE + 1) 4167c478bd9Sstevel@tonic-gate #define DTRACEACT_PANIC (DTRACEACT_KERNEL_DESTRUCTIVE + 2) 4177c478bd9Sstevel@tonic-gate #define DTRACEACT_CHILL (DTRACEACT_KERNEL_DESTRUCTIVE + 3) 4187c478bd9Sstevel@tonic-gate 4197c478bd9Sstevel@tonic-gate #define DTRACEACT_SPECULATIVE 0x0600 4207c478bd9Sstevel@tonic-gate #define DTRACEACT_SPECULATE (DTRACEACT_SPECULATIVE + 1) 4217c478bd9Sstevel@tonic-gate #define DTRACEACT_COMMIT (DTRACEACT_SPECULATIVE + 2) 4227c478bd9Sstevel@tonic-gate #define DTRACEACT_DISCARD (DTRACEACT_SPECULATIVE + 3) 4237c478bd9Sstevel@tonic-gate 4247c478bd9Sstevel@tonic-gate #define DTRACEACT_CLASS(x) ((x) & 0xff00) 4257c478bd9Sstevel@tonic-gate 4267c478bd9Sstevel@tonic-gate #define DTRACEACT_ISDESTRUCTIVE(x) \ 4277c478bd9Sstevel@tonic-gate (DTRACEACT_CLASS(x) == DTRACEACT_PROC_DESTRUCTIVE || \ 4287c478bd9Sstevel@tonic-gate DTRACEACT_CLASS(x) == DTRACEACT_KERNEL_DESTRUCTIVE) 4297c478bd9Sstevel@tonic-gate 4307c478bd9Sstevel@tonic-gate #define DTRACEACT_ISSPECULATIVE(x) \ 4317c478bd9Sstevel@tonic-gate (DTRACEACT_CLASS(x) == DTRACEACT_SPECULATIVE) 4327c478bd9Sstevel@tonic-gate 4337c478bd9Sstevel@tonic-gate #define DTRACEACT_ISPRINTFLIKE(x) \ 4347c478bd9Sstevel@tonic-gate ((x) == DTRACEACT_PRINTF || (x) == DTRACEACT_PRINTA || \ 4357c478bd9Sstevel@tonic-gate (x) == DTRACEACT_SYSTEM || (x) == DTRACEACT_FREOPEN) 4367c478bd9Sstevel@tonic-gate 4377c478bd9Sstevel@tonic-gate /* 4387c478bd9Sstevel@tonic-gate * DTrace Aggregating Actions 4397c478bd9Sstevel@tonic-gate * 4407c478bd9Sstevel@tonic-gate * These are functions f(x) for which the following is true: 4417c478bd9Sstevel@tonic-gate * 4427c478bd9Sstevel@tonic-gate * f(f(x_0) U f(x_1) U ... U f(x_n)) = f(x_0 U x_1 U ... U x_n) 4437c478bd9Sstevel@tonic-gate * 4447c478bd9Sstevel@tonic-gate * where x_n is a set of arbitrary data. Aggregating actions are in their own 4457c478bd9Sstevel@tonic-gate * DTrace action class, DTTRACEACT_AGGREGATION. The macros provided here allow 4467c478bd9Sstevel@tonic-gate * for easier processing of the aggregation argument and data payload for a few 4477c478bd9Sstevel@tonic-gate * aggregating actions (notably: quantize(), lquantize(), and ustack()). 4487c478bd9Sstevel@tonic-gate */ 4497c478bd9Sstevel@tonic-gate #define DTRACEACT_AGGREGATION 0x0700 4507c478bd9Sstevel@tonic-gate #define DTRACEAGG_COUNT (DTRACEACT_AGGREGATION + 1) 4517c478bd9Sstevel@tonic-gate #define DTRACEAGG_MIN (DTRACEACT_AGGREGATION + 2) 4527c478bd9Sstevel@tonic-gate #define DTRACEAGG_MAX (DTRACEACT_AGGREGATION + 3) 4537c478bd9Sstevel@tonic-gate #define DTRACEAGG_AVG (DTRACEACT_AGGREGATION + 4) 4547c478bd9Sstevel@tonic-gate #define DTRACEAGG_SUM (DTRACEACT_AGGREGATION + 5) 4557c478bd9Sstevel@tonic-gate #define DTRACEAGG_STDDEV (DTRACEACT_AGGREGATION + 6) 4567c478bd9Sstevel@tonic-gate #define DTRACEAGG_QUANTIZE (DTRACEACT_AGGREGATION + 7) 4577c478bd9Sstevel@tonic-gate #define DTRACEAGG_LQUANTIZE (DTRACEACT_AGGREGATION + 8) 4587c478bd9Sstevel@tonic-gate 4597c478bd9Sstevel@tonic-gate #define DTRACEACT_ISAGG(x) \ 4607c478bd9Sstevel@tonic-gate (DTRACEACT_CLASS(x) == DTRACEACT_AGGREGATION) 4617c478bd9Sstevel@tonic-gate 4627c478bd9Sstevel@tonic-gate #define DTRACE_QUANTIZE_NBUCKETS \ 4637c478bd9Sstevel@tonic-gate (((sizeof (uint64_t) * NBBY) - 1) * 2 + 1) 4647c478bd9Sstevel@tonic-gate 4657c478bd9Sstevel@tonic-gate #define DTRACE_QUANTIZE_ZEROBUCKET ((sizeof (uint64_t) * NBBY) - 1) 4667c478bd9Sstevel@tonic-gate 4677c478bd9Sstevel@tonic-gate #define DTRACE_QUANTIZE_BUCKETVAL(buck) \ 4687c478bd9Sstevel@tonic-gate (int64_t)((buck) < DTRACE_QUANTIZE_ZEROBUCKET ? \ 4697c478bd9Sstevel@tonic-gate -(1LL << (DTRACE_QUANTIZE_ZEROBUCKET - 1 - (buck))) : \ 4707c478bd9Sstevel@tonic-gate (buck) == DTRACE_QUANTIZE_ZEROBUCKET ? 0 : \ 4717c478bd9Sstevel@tonic-gate 1LL << ((buck) - DTRACE_QUANTIZE_ZEROBUCKET - 1)) 4727c478bd9Sstevel@tonic-gate 4737c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_STEPSHIFT 48 4747c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_STEPMASK ((uint64_t)UINT16_MAX << 48) 4757c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_LEVELSHIFT 32 4767c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_LEVELMASK ((uint64_t)UINT16_MAX << 32) 4777c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_BASESHIFT 0 4787c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_BASEMASK UINT32_MAX 4797c478bd9Sstevel@tonic-gate 4807c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_STEP(x) \ 4817c478bd9Sstevel@tonic-gate (uint16_t)(((x) & DTRACE_LQUANTIZE_STEPMASK) >> \ 4827c478bd9Sstevel@tonic-gate DTRACE_LQUANTIZE_STEPSHIFT) 4837c478bd9Sstevel@tonic-gate 4847c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_LEVELS(x) \ 4857c478bd9Sstevel@tonic-gate (uint16_t)(((x) & DTRACE_LQUANTIZE_LEVELMASK) >> \ 4867c478bd9Sstevel@tonic-gate DTRACE_LQUANTIZE_LEVELSHIFT) 4877c478bd9Sstevel@tonic-gate 4887c478bd9Sstevel@tonic-gate #define DTRACE_LQUANTIZE_BASE(x) \ 4897c478bd9Sstevel@tonic-gate (int32_t)(((x) & DTRACE_LQUANTIZE_BASEMASK) >> \ 4907c478bd9Sstevel@tonic-gate DTRACE_LQUANTIZE_BASESHIFT) 4917c478bd9Sstevel@tonic-gate 4927c478bd9Sstevel@tonic-gate #define DTRACE_USTACK_NFRAMES(x) (uint32_t)((x) & UINT32_MAX) 4937c478bd9Sstevel@tonic-gate #define DTRACE_USTACK_STRSIZE(x) (uint32_t)((x) >> 32) 4947c478bd9Sstevel@tonic-gate #define DTRACE_USTACK_ARG(x, y) \ 4957c478bd9Sstevel@tonic-gate ((((uint64_t)(y)) << 32) | ((x) & UINT32_MAX)) 4967c478bd9Sstevel@tonic-gate 4977c478bd9Sstevel@tonic-gate #ifndef _LP64 4987c478bd9Sstevel@tonic-gate #ifndef _LITTLE_ENDIAN 4997c478bd9Sstevel@tonic-gate #define DTRACE_PTR(type, name) uint32_t name##pad; type *name 5007c478bd9Sstevel@tonic-gate #else 5017c478bd9Sstevel@tonic-gate #define DTRACE_PTR(type, name) type *name; uint32_t name##pad 5027c478bd9Sstevel@tonic-gate #endif 5037c478bd9Sstevel@tonic-gate #else 5047c478bd9Sstevel@tonic-gate #define DTRACE_PTR(type, name) type *name 5057c478bd9Sstevel@tonic-gate #endif 5067c478bd9Sstevel@tonic-gate 5077c478bd9Sstevel@tonic-gate /* 5087c478bd9Sstevel@tonic-gate * DTrace Object Format (DOF) 5097c478bd9Sstevel@tonic-gate * 5107c478bd9Sstevel@tonic-gate * DTrace programs can be persistently encoded in the DOF format so that they 5117c478bd9Sstevel@tonic-gate * may be embedded in other programs (for example, in an ELF file) or in the 5127c478bd9Sstevel@tonic-gate * dtrace driver configuration file for use in anonymous tracing. The DOF 5137c478bd9Sstevel@tonic-gate * format is versioned and extensible so that it can be revised and so that 5147c478bd9Sstevel@tonic-gate * internal data structures can be modified or extended compatibly. All DOF 5157c478bd9Sstevel@tonic-gate * structures use fixed-size types, so the 32-bit and 64-bit representations 5167c478bd9Sstevel@tonic-gate * are identical and consumers can use either data model transparently. 5177c478bd9Sstevel@tonic-gate * 5187c478bd9Sstevel@tonic-gate * The file layout is structured as follows: 5197c478bd9Sstevel@tonic-gate * 5207c478bd9Sstevel@tonic-gate * +---------------+-------------------+----- ... ----+---- ... ------+ 5217c478bd9Sstevel@tonic-gate * | dof_hdr_t | dof_sec_t[ ... ] | loadable | non-loadable | 5227c478bd9Sstevel@tonic-gate * | (file header) | (section headers) | section data | section data | 5237c478bd9Sstevel@tonic-gate * +---------------+-------------------+----- ... ----+---- ... ------+ 5247c478bd9Sstevel@tonic-gate * |<------------ dof_hdr.dofh_loadsz --------------->| | 5257c478bd9Sstevel@tonic-gate * |<------------ dof_hdr.dofh_filesz ------------------------------->| 5267c478bd9Sstevel@tonic-gate * 5277c478bd9Sstevel@tonic-gate * The file header stores meta-data including a magic number, data model for 5287c478bd9Sstevel@tonic-gate * the instrumentation, data encoding, and properties of the DIF code within. 5297c478bd9Sstevel@tonic-gate * The header describes its own size and the size of the section headers. By 5307c478bd9Sstevel@tonic-gate * convention, an array of section headers follows the file header, and then 5317c478bd9Sstevel@tonic-gate * the data for all loadable sections and unloadable sections. This permits 5327c478bd9Sstevel@tonic-gate * consumer code to easily download the headers and all loadable data into the 5337c478bd9Sstevel@tonic-gate * DTrace driver in one contiguous chunk, omitting other extraneous sections. 5347c478bd9Sstevel@tonic-gate * 5357c478bd9Sstevel@tonic-gate * The section headers describe the size, offset, alignment, and section type 5367c478bd9Sstevel@tonic-gate * for each section. Sections are described using a set of #defines that tell 5377c478bd9Sstevel@tonic-gate * the consumer what kind of data is expected. Sections can contain links to 5387c478bd9Sstevel@tonic-gate * other sections by storing a dof_secidx_t, an index into the section header 5397c478bd9Sstevel@tonic-gate * array, inside of the section data structures. The section header includes 5407c478bd9Sstevel@tonic-gate * an entry size so that sections with data arrays can grow their structures. 5417c478bd9Sstevel@tonic-gate * 5427c478bd9Sstevel@tonic-gate * The DOF data itself can contain many snippets of DIF (i.e. >1 DIFOs), which 5437c478bd9Sstevel@tonic-gate * are represented themselves as a collection of related DOF sections. This 5447c478bd9Sstevel@tonic-gate * permits us to change the set of sections associated with a DIFO over time, 5457c478bd9Sstevel@tonic-gate * and also permits us to encode DIFOs that contain different sets of sections. 5467c478bd9Sstevel@tonic-gate * When a DOF section wants to refer to a DIFO, it stores the dof_secidx_t of a 5477c478bd9Sstevel@tonic-gate * section of type DOF_SECT_DIFOHDR. This section's data is then an array of 5487c478bd9Sstevel@tonic-gate * dof_secidx_t's which in turn denote the sections associated with this DIFO. 5497c478bd9Sstevel@tonic-gate * 5507c478bd9Sstevel@tonic-gate * This loose coupling of the file structure (header and sections) to the 5517c478bd9Sstevel@tonic-gate * structure of the DTrace program itself (ECB descriptions, action 5527c478bd9Sstevel@tonic-gate * descriptions, and DIFOs) permits activities such as relocation processing 5537c478bd9Sstevel@tonic-gate * to occur in a single pass without having to understand D program structure. 5547c478bd9Sstevel@tonic-gate * 5557c478bd9Sstevel@tonic-gate * Finally, strings are always stored in ELF-style string tables along with a 5567c478bd9Sstevel@tonic-gate * string table section index and string table offset. Therefore strings in 5577c478bd9Sstevel@tonic-gate * DOF are always arbitrary-length and not bound to the current implementation. 5587c478bd9Sstevel@tonic-gate */ 5597c478bd9Sstevel@tonic-gate 5607c478bd9Sstevel@tonic-gate #define DOF_ID_SIZE 16 /* total size of dofh_ident[] in bytes */ 5617c478bd9Sstevel@tonic-gate 5627c478bd9Sstevel@tonic-gate typedef struct dof_hdr { 5637c478bd9Sstevel@tonic-gate uint8_t dofh_ident[DOF_ID_SIZE]; /* identification bytes (see below) */ 5647c478bd9Sstevel@tonic-gate uint32_t dofh_flags; /* file attribute flags (if any) */ 5657c478bd9Sstevel@tonic-gate uint32_t dofh_hdrsize; /* size of file header in bytes */ 5667c478bd9Sstevel@tonic-gate uint32_t dofh_secsize; /* size of section header in bytes */ 5677c478bd9Sstevel@tonic-gate uint32_t dofh_secnum; /* number of section headers */ 5687c478bd9Sstevel@tonic-gate uint64_t dofh_secoff; /* file offset of section headers */ 5697c478bd9Sstevel@tonic-gate uint64_t dofh_loadsz; /* file size of loadable portion */ 5707c478bd9Sstevel@tonic-gate uint64_t dofh_filesz; /* file size of entire DOF file */ 5717c478bd9Sstevel@tonic-gate uint64_t dofh_pad; /* reserved for future use */ 5727c478bd9Sstevel@tonic-gate } dof_hdr_t; 5737c478bd9Sstevel@tonic-gate 5747c478bd9Sstevel@tonic-gate #define DOF_ID_MAG0 0 /* first byte of magic number */ 5757c478bd9Sstevel@tonic-gate #define DOF_ID_MAG1 1 /* second byte of magic number */ 5767c478bd9Sstevel@tonic-gate #define DOF_ID_MAG2 2 /* third byte of magic number */ 5777c478bd9Sstevel@tonic-gate #define DOF_ID_MAG3 3 /* fourth byte of magic number */ 5787c478bd9Sstevel@tonic-gate #define DOF_ID_MODEL 4 /* DOF data model (see below) */ 5797c478bd9Sstevel@tonic-gate #define DOF_ID_ENCODING 5 /* DOF data encoding (see below) */ 5807c478bd9Sstevel@tonic-gate #define DOF_ID_VERSION 6 /* DOF file format major version (see below) */ 5817c478bd9Sstevel@tonic-gate #define DOF_ID_DIFVERS 7 /* DIF instruction set version */ 5827c478bd9Sstevel@tonic-gate #define DOF_ID_DIFIREG 8 /* DIF integer registers used by compiler */ 5837c478bd9Sstevel@tonic-gate #define DOF_ID_DIFTREG 9 /* DIF tuple registers used by compiler */ 5847c478bd9Sstevel@tonic-gate #define DOF_ID_PAD 10 /* start of padding bytes (all zeroes) */ 5857c478bd9Sstevel@tonic-gate 5867c478bd9Sstevel@tonic-gate #define DOF_MAG_MAG0 0x7F /* DOF_ID_MAG[0-3] */ 5877c478bd9Sstevel@tonic-gate #define DOF_MAG_MAG1 'D' 5887c478bd9Sstevel@tonic-gate #define DOF_MAG_MAG2 'O' 5897c478bd9Sstevel@tonic-gate #define DOF_MAG_MAG3 'F' 5907c478bd9Sstevel@tonic-gate 5917c478bd9Sstevel@tonic-gate #define DOF_MAG_STRING "\177DOF" 5927c478bd9Sstevel@tonic-gate #define DOF_MAG_STRLEN 4 5937c478bd9Sstevel@tonic-gate 5947c478bd9Sstevel@tonic-gate #define DOF_MODEL_NONE 0 /* DOF_ID_MODEL */ 5957c478bd9Sstevel@tonic-gate #define DOF_MODEL_ILP32 1 5967c478bd9Sstevel@tonic-gate #define DOF_MODEL_LP64 2 5977c478bd9Sstevel@tonic-gate 5987c478bd9Sstevel@tonic-gate #ifdef _LP64 5997c478bd9Sstevel@tonic-gate #define DOF_MODEL_NATIVE DOF_MODEL_LP64 6007c478bd9Sstevel@tonic-gate #else 6017c478bd9Sstevel@tonic-gate #define DOF_MODEL_NATIVE DOF_MODEL_ILP32 6027c478bd9Sstevel@tonic-gate #endif 6037c478bd9Sstevel@tonic-gate 6047c478bd9Sstevel@tonic-gate #define DOF_ENCODE_NONE 0 /* DOF_ID_ENCODING */ 6057c478bd9Sstevel@tonic-gate #define DOF_ENCODE_LSB 1 6067c478bd9Sstevel@tonic-gate #define DOF_ENCODE_MSB 2 6077c478bd9Sstevel@tonic-gate 6087c478bd9Sstevel@tonic-gate #ifdef _BIG_ENDIAN 6097c478bd9Sstevel@tonic-gate #define DOF_ENCODE_NATIVE DOF_ENCODE_MSB 6107c478bd9Sstevel@tonic-gate #else 6117c478bd9Sstevel@tonic-gate #define DOF_ENCODE_NATIVE DOF_ENCODE_LSB 6127c478bd9Sstevel@tonic-gate #endif 6137c478bd9Sstevel@tonic-gate 614ac448965Sahl #define DOF_VERSION_1 1 /* DOF version 1: Solaris 10 FCS */ 615ac448965Sahl #define DOF_VERSION_2 2 /* DOF version 2: Solaris Express 6/06 */ 616ac448965Sahl #define DOF_VERSION DOF_VERSION_2 /* Latest DOF version */ 6177c478bd9Sstevel@tonic-gate 6187c478bd9Sstevel@tonic-gate #define DOF_FL_VALID 0 /* mask of all valid dofh_flags bits */ 6197c478bd9Sstevel@tonic-gate 6207c478bd9Sstevel@tonic-gate typedef uint32_t dof_secidx_t; /* section header table index type */ 6217c478bd9Sstevel@tonic-gate typedef uint32_t dof_stridx_t; /* string table index type */ 6227c478bd9Sstevel@tonic-gate 6237c478bd9Sstevel@tonic-gate #define DOF_SECIDX_NONE (-1U) /* null value for section indices */ 6247c478bd9Sstevel@tonic-gate #define DOF_STRIDX_NONE (-1U) /* null value for string indices */ 6257c478bd9Sstevel@tonic-gate 6267c478bd9Sstevel@tonic-gate typedef struct dof_sec { 6277c478bd9Sstevel@tonic-gate uint32_t dofs_type; /* section type (see below) */ 6287c478bd9Sstevel@tonic-gate uint32_t dofs_align; /* section data memory alignment */ 6297c478bd9Sstevel@tonic-gate uint32_t dofs_flags; /* section flags (if any) */ 6307c478bd9Sstevel@tonic-gate uint32_t dofs_entsize; /* size of section entry (if table) */ 6317c478bd9Sstevel@tonic-gate uint64_t dofs_offset; /* offset of section data within file */ 6327c478bd9Sstevel@tonic-gate uint64_t dofs_size; /* size of section data in bytes */ 6337c478bd9Sstevel@tonic-gate } dof_sec_t; 6347c478bd9Sstevel@tonic-gate 6357c478bd9Sstevel@tonic-gate #define DOF_SECT_NONE 0 /* null section */ 6367c478bd9Sstevel@tonic-gate #define DOF_SECT_COMMENTS 1 /* compiler comments */ 6377c478bd9Sstevel@tonic-gate #define DOF_SECT_SOURCE 2 /* D program source code */ 6387c478bd9Sstevel@tonic-gate #define DOF_SECT_ECBDESC 3 /* dof_ecbdesc_t */ 6397c478bd9Sstevel@tonic-gate #define DOF_SECT_PROBEDESC 4 /* dof_probedesc_t */ 6407c478bd9Sstevel@tonic-gate #define DOF_SECT_ACTDESC 5 /* dof_actdesc_t array */ 6417c478bd9Sstevel@tonic-gate #define DOF_SECT_DIFOHDR 6 /* dof_difohdr_t (variable length) */ 6427c478bd9Sstevel@tonic-gate #define DOF_SECT_DIF 7 /* uint32_t array of byte code */ 6437c478bd9Sstevel@tonic-gate #define DOF_SECT_STRTAB 8 /* string table */ 6447c478bd9Sstevel@tonic-gate #define DOF_SECT_VARTAB 9 /* dtrace_difv_t array */ 6457c478bd9Sstevel@tonic-gate #define DOF_SECT_RELTAB 10 /* dof_relodesc_t array */ 6467c478bd9Sstevel@tonic-gate #define DOF_SECT_TYPTAB 11 /* dtrace_diftype_t array */ 6477c478bd9Sstevel@tonic-gate #define DOF_SECT_URELHDR 12 /* dof_relohdr_t (user relocations) */ 6487c478bd9Sstevel@tonic-gate #define DOF_SECT_KRELHDR 13 /* dof_relohdr_t (kernel relocations) */ 6497c478bd9Sstevel@tonic-gate #define DOF_SECT_OPTDESC 14 /* dof_optdesc_t array */ 6507c478bd9Sstevel@tonic-gate #define DOF_SECT_PROVIDER 15 /* dof_provider_t */ 6517c478bd9Sstevel@tonic-gate #define DOF_SECT_PROBES 16 /* dof_probe_t array */ 6527c478bd9Sstevel@tonic-gate #define DOF_SECT_PRARGS 17 /* uint8_t array (probe arg mappings) */ 6537c478bd9Sstevel@tonic-gate #define DOF_SECT_PROFFS 18 /* uint32_t array (probe arg offsets) */ 6547c478bd9Sstevel@tonic-gate #define DOF_SECT_INTTAB 19 /* uint64_t array */ 6557c478bd9Sstevel@tonic-gate #define DOF_SECT_UTSNAME 20 /* struct utsname */ 6561a7c1b72Smws #define DOF_SECT_XLTAB 21 /* dof_xlref_t array */ 6571a7c1b72Smws #define DOF_SECT_XLMEMBERS 22 /* dof_xlmember_t array */ 6581a7c1b72Smws #define DOF_SECT_XLIMPORT 23 /* dof_xlator_t */ 6591a7c1b72Smws #define DOF_SECT_XLEXPORT 24 /* dof_xlator_t */ 6601a7c1b72Smws #define DOF_SECT_PREXPORT 25 /* dof_secidx_t array (exported objs) */ 661ac448965Sahl #define DOF_SECT_PRENOFFS 26 /* uint32_t array (enabled offsets) */ 6627c478bd9Sstevel@tonic-gate 6637c478bd9Sstevel@tonic-gate #define DOF_SECF_LOAD 1 /* section should be loaded */ 6647c478bd9Sstevel@tonic-gate 665*8cb74972SJonathan Haslam #define DOF_SEC_ISLOADABLE(x) \ 666*8cb74972SJonathan Haslam (((x) == DOF_SECT_ECBDESC) || ((x) == DOF_SECT_PROBEDESC) || \ 667*8cb74972SJonathan Haslam ((x) == DOF_SECT_ACTDESC) || ((x) == DOF_SECT_DIFOHDR) || \ 668*8cb74972SJonathan Haslam ((x) == DOF_SECT_DIF) || ((x) == DOF_SECT_STRTAB) || \ 669*8cb74972SJonathan Haslam ((x) == DOF_SECT_VARTAB) || ((x) == DOF_SECT_RELTAB) || \ 670*8cb74972SJonathan Haslam ((x) == DOF_SECT_TYPTAB) || ((x) == DOF_SECT_URELHDR) || \ 671*8cb74972SJonathan Haslam ((x) == DOF_SECT_KRELHDR) || ((x) == DOF_SECT_OPTDESC) || \ 672*8cb74972SJonathan Haslam ((x) == DOF_SECT_PROVIDER) || ((x) == DOF_SECT_PROBES) || \ 673*8cb74972SJonathan Haslam ((x) == DOF_SECT_PRARGS) || ((x) == DOF_SECT_PROFFS) || \ 674*8cb74972SJonathan Haslam ((x) == DOF_SECT_INTTAB) || ((x) == DOF_SECT_XLTAB) || \ 675*8cb74972SJonathan Haslam ((x) == DOF_SECT_XLMEMBERS) || ((x) == DOF_SECT_XLIMPORT) || \ 676*8cb74972SJonathan Haslam ((x) == DOF_SECT_XLIMPORT) || ((x) == DOF_SECT_XLEXPORT) || \ 677*8cb74972SJonathan Haslam ((x) == DOF_SECT_PREXPORT) || ((x) == DOF_SECT_PRENOFFS)) 678*8cb74972SJonathan Haslam 6797c478bd9Sstevel@tonic-gate typedef struct dof_ecbdesc { 6807c478bd9Sstevel@tonic-gate dof_secidx_t dofe_probes; /* link to DOF_SECT_PROBEDESC */ 6817c478bd9Sstevel@tonic-gate dof_secidx_t dofe_pred; /* link to DOF_SECT_DIFOHDR */ 6827c478bd9Sstevel@tonic-gate dof_secidx_t dofe_actions; /* link to DOF_SECT_ACTDESC */ 6837c478bd9Sstevel@tonic-gate uint32_t dofe_pad; /* reserved for future use */ 6847c478bd9Sstevel@tonic-gate uint64_t dofe_uarg; /* user-supplied library argument */ 6857c478bd9Sstevel@tonic-gate } dof_ecbdesc_t; 6867c478bd9Sstevel@tonic-gate 6877c478bd9Sstevel@tonic-gate typedef struct dof_probedesc { 6887c478bd9Sstevel@tonic-gate dof_secidx_t dofp_strtab; /* link to DOF_SECT_STRTAB section */ 6897c478bd9Sstevel@tonic-gate dof_stridx_t dofp_provider; /* provider string */ 6907c478bd9Sstevel@tonic-gate dof_stridx_t dofp_mod; /* module string */ 6917c478bd9Sstevel@tonic-gate dof_stridx_t dofp_func; /* function string */ 6927c478bd9Sstevel@tonic-gate dof_stridx_t dofp_name; /* name string */ 6937c478bd9Sstevel@tonic-gate uint32_t dofp_id; /* probe identifier (or zero) */ 6947c478bd9Sstevel@tonic-gate } dof_probedesc_t; 6957c478bd9Sstevel@tonic-gate 6967c478bd9Sstevel@tonic-gate typedef struct dof_actdesc { 6977c478bd9Sstevel@tonic-gate dof_secidx_t dofa_difo; /* link to DOF_SECT_DIFOHDR */ 6987c478bd9Sstevel@tonic-gate dof_secidx_t dofa_strtab; /* link to DOF_SECT_STRTAB section */ 6997c478bd9Sstevel@tonic-gate uint32_t dofa_kind; /* action kind (DTRACEACT_* constant) */ 7007c478bd9Sstevel@tonic-gate uint32_t dofa_ntuple; /* number of subsequent tuple actions */ 7017c478bd9Sstevel@tonic-gate uint64_t dofa_arg; /* kind-specific argument */ 7027c478bd9Sstevel@tonic-gate uint64_t dofa_uarg; /* user-supplied argument */ 7037c478bd9Sstevel@tonic-gate } dof_actdesc_t; 7047c478bd9Sstevel@tonic-gate 7057c478bd9Sstevel@tonic-gate typedef struct dof_difohdr { 7067c478bd9Sstevel@tonic-gate dtrace_diftype_t dofd_rtype; /* return type for this fragment */ 7077c478bd9Sstevel@tonic-gate dof_secidx_t dofd_links[1]; /* variable length array of indices */ 7087c478bd9Sstevel@tonic-gate } dof_difohdr_t; 7097c478bd9Sstevel@tonic-gate 7107c478bd9Sstevel@tonic-gate typedef struct dof_relohdr { 7117c478bd9Sstevel@tonic-gate dof_secidx_t dofr_strtab; /* link to DOF_SECT_STRTAB for names */ 7127c478bd9Sstevel@tonic-gate dof_secidx_t dofr_relsec; /* link to DOF_SECT_RELTAB for relos */ 7137c478bd9Sstevel@tonic-gate dof_secidx_t dofr_tgtsec; /* link to section we are relocating */ 7147c478bd9Sstevel@tonic-gate } dof_relohdr_t; 7157c478bd9Sstevel@tonic-gate 7167c478bd9Sstevel@tonic-gate typedef struct dof_relodesc { 7177c478bd9Sstevel@tonic-gate dof_stridx_t dofr_name; /* string name of relocation symbol */ 7187c478bd9Sstevel@tonic-gate uint32_t dofr_type; /* relo type (DOF_RELO_* constant) */ 7197c478bd9Sstevel@tonic-gate uint64_t dofr_offset; /* byte offset for relocation */ 7207c478bd9Sstevel@tonic-gate uint64_t dofr_data; /* additional type-specific data */ 7217c478bd9Sstevel@tonic-gate } dof_relodesc_t; 7227c478bd9Sstevel@tonic-gate 7237c478bd9Sstevel@tonic-gate #define DOF_RELO_NONE 0 /* empty relocation entry */ 7247c478bd9Sstevel@tonic-gate #define DOF_RELO_SETX 1 /* relocate setx value */ 7257c478bd9Sstevel@tonic-gate 7267c478bd9Sstevel@tonic-gate typedef struct dof_optdesc { 7277c478bd9Sstevel@tonic-gate uint32_t dofo_option; /* option identifier */ 7287c478bd9Sstevel@tonic-gate dof_secidx_t dofo_strtab; /* string table, if string option */ 7297c478bd9Sstevel@tonic-gate uint64_t dofo_value; /* option value or string index */ 7307c478bd9Sstevel@tonic-gate } dof_optdesc_t; 7317c478bd9Sstevel@tonic-gate 7327c478bd9Sstevel@tonic-gate typedef uint32_t dof_attr_t; /* encoded stability attributes */ 7337c478bd9Sstevel@tonic-gate 7347c478bd9Sstevel@tonic-gate #define DOF_ATTR(n, d, c) (((n) << 24) | ((d) << 16) | ((c) << 8)) 7357c478bd9Sstevel@tonic-gate #define DOF_ATTR_NAME(a) (((a) >> 24) & 0xff) 7367c478bd9Sstevel@tonic-gate #define DOF_ATTR_DATA(a) (((a) >> 16) & 0xff) 7377c478bd9Sstevel@tonic-gate #define DOF_ATTR_CLASS(a) (((a) >> 8) & 0xff) 7387c478bd9Sstevel@tonic-gate 7397c478bd9Sstevel@tonic-gate typedef struct dof_provider { 7407c478bd9Sstevel@tonic-gate dof_secidx_t dofpv_strtab; /* link to DOF_SECT_STRTAB section */ 7417c478bd9Sstevel@tonic-gate dof_secidx_t dofpv_probes; /* link to DOF_SECT_PROBES section */ 7427c478bd9Sstevel@tonic-gate dof_secidx_t dofpv_prargs; /* link to DOF_SECT_PRARGS section */ 7437c478bd9Sstevel@tonic-gate dof_secidx_t dofpv_proffs; /* link to DOF_SECT_PROFFS section */ 7447c478bd9Sstevel@tonic-gate dof_stridx_t dofpv_name; /* provider name string */ 7457c478bd9Sstevel@tonic-gate dof_attr_t dofpv_provattr; /* provider attributes */ 7467c478bd9Sstevel@tonic-gate dof_attr_t dofpv_modattr; /* module attributes */ 7477c478bd9Sstevel@tonic-gate dof_attr_t dofpv_funcattr; /* function attributes */ 7487c478bd9Sstevel@tonic-gate dof_attr_t dofpv_nameattr; /* name attributes */ 7497c478bd9Sstevel@tonic-gate dof_attr_t dofpv_argsattr; /* args attributes */ 750ac448965Sahl dof_secidx_t dofpv_prenoffs; /* link to DOF_SECT_PRENOFFS section */ 7517c478bd9Sstevel@tonic-gate } dof_provider_t; 7527c478bd9Sstevel@tonic-gate 7537c478bd9Sstevel@tonic-gate typedef struct dof_probe { 7547c478bd9Sstevel@tonic-gate uint64_t dofpr_addr; /* probe base address or offset */ 7557c478bd9Sstevel@tonic-gate dof_stridx_t dofpr_func; /* probe function string */ 7567c478bd9Sstevel@tonic-gate dof_stridx_t dofpr_name; /* probe name string */ 7577c478bd9Sstevel@tonic-gate dof_stridx_t dofpr_nargv; /* native argument type strings */ 7587c478bd9Sstevel@tonic-gate dof_stridx_t dofpr_xargv; /* translated argument type strings */ 7597c478bd9Sstevel@tonic-gate uint32_t dofpr_argidx; /* index of first argument mapping */ 7607c478bd9Sstevel@tonic-gate uint32_t dofpr_offidx; /* index of first offset entry */ 7617c478bd9Sstevel@tonic-gate uint8_t dofpr_nargc; /* native argument count */ 7627c478bd9Sstevel@tonic-gate uint8_t dofpr_xargc; /* translated argument count */ 7637c478bd9Sstevel@tonic-gate uint16_t dofpr_noffs; /* number of offset entries for probe */ 764ac448965Sahl uint32_t dofpr_enoffidx; /* index of first is-enabled offset */ 765ac448965Sahl uint16_t dofpr_nenoffs; /* number of is-enabled offsets */ 766ac448965Sahl uint16_t dofpr_pad1; /* reserved for future use */ 767ac448965Sahl uint32_t dofpr_pad2; /* reserved for future use */ 7687c478bd9Sstevel@tonic-gate } dof_probe_t; 7697c478bd9Sstevel@tonic-gate 7701a7c1b72Smws typedef struct dof_xlator { 7711a7c1b72Smws dof_secidx_t dofxl_members; /* link to DOF_SECT_XLMEMBERS section */ 7721a7c1b72Smws dof_secidx_t dofxl_strtab; /* link to DOF_SECT_STRTAB section */ 7731a7c1b72Smws dof_stridx_t dofxl_argv; /* input parameter type strings */ 7741a7c1b72Smws uint32_t dofxl_argc; /* input parameter list length */ 7751a7c1b72Smws dof_stridx_t dofxl_type; /* output type string name */ 7761a7c1b72Smws dof_attr_t dofxl_attr; /* output stability attributes */ 7771a7c1b72Smws } dof_xlator_t; 7781a7c1b72Smws 7791a7c1b72Smws typedef struct dof_xlmember { 7801a7c1b72Smws dof_secidx_t dofxm_difo; /* member link to DOF_SECT_DIFOHDR */ 7811a7c1b72Smws dof_stridx_t dofxm_name; /* member name */ 7821a7c1b72Smws dtrace_diftype_t dofxm_type; /* member type */ 7831a7c1b72Smws } dof_xlmember_t; 7841a7c1b72Smws 7851a7c1b72Smws typedef struct dof_xlref { 7861a7c1b72Smws dof_secidx_t dofxr_xlator; /* link to DOF_SECT_XLATORS section */ 7871a7c1b72Smws uint32_t dofxr_member; /* index of referenced dof_xlmember */ 7881a7c1b72Smws uint32_t dofxr_argn; /* index of argument for DIF_OP_XLARG */ 7891a7c1b72Smws } dof_xlref_t; 7901a7c1b72Smws 7917c478bd9Sstevel@tonic-gate /* 7927c478bd9Sstevel@tonic-gate * DTrace Intermediate Format Object (DIFO) 7937c478bd9Sstevel@tonic-gate * 7947c478bd9Sstevel@tonic-gate * A DIFO is used to store the compiled DIF for a D expression, its return 7957c478bd9Sstevel@tonic-gate * type, and its string and variable tables. The string table is a single 7967c478bd9Sstevel@tonic-gate * buffer of character data into which sets instructions and variable 7977c478bd9Sstevel@tonic-gate * references can reference strings using a byte offset. The variable table 7987c478bd9Sstevel@tonic-gate * is an array of dtrace_difv_t structures that describe the name and type of 7997c478bd9Sstevel@tonic-gate * each variable and the id used in the DIF code. This structure is described 8007c478bd9Sstevel@tonic-gate * above in the DIF section of this header file. The DIFO is used at both 8017c478bd9Sstevel@tonic-gate * user-level (in the library) and in the kernel, but the structure is never 8027c478bd9Sstevel@tonic-gate * passed between the two: the DOF structures form the only interface. As a 8037c478bd9Sstevel@tonic-gate * result, the definition can change depending on the presence of _KERNEL. 8047c478bd9Sstevel@tonic-gate */ 8057c478bd9Sstevel@tonic-gate typedef struct dtrace_difo { 8067c478bd9Sstevel@tonic-gate dif_instr_t *dtdo_buf; /* instruction buffer */ 8077c478bd9Sstevel@tonic-gate uint64_t *dtdo_inttab; /* integer table (optional) */ 8087c478bd9Sstevel@tonic-gate char *dtdo_strtab; /* string table (optional) */ 8097c478bd9Sstevel@tonic-gate dtrace_difv_t *dtdo_vartab; /* variable table (optional) */ 8107c478bd9Sstevel@tonic-gate uint_t dtdo_len; /* length of instruction buffer */ 8117c478bd9Sstevel@tonic-gate uint_t dtdo_intlen; /* length of integer table */ 8127c478bd9Sstevel@tonic-gate uint_t dtdo_strlen; /* length of string table */ 8137c478bd9Sstevel@tonic-gate uint_t dtdo_varlen; /* length of variable table */ 8147c478bd9Sstevel@tonic-gate dtrace_diftype_t dtdo_rtype; /* return type */ 8157c478bd9Sstevel@tonic-gate uint_t dtdo_refcnt; /* owner reference count */ 8167c478bd9Sstevel@tonic-gate uint_t dtdo_destructive; /* invokes destructive subroutines */ 8177c478bd9Sstevel@tonic-gate #ifndef _KERNEL 8187c478bd9Sstevel@tonic-gate dof_relodesc_t *dtdo_kreltab; /* kernel relocations */ 8197c478bd9Sstevel@tonic-gate dof_relodesc_t *dtdo_ureltab; /* user relocations */ 8201a7c1b72Smws struct dt_node **dtdo_xlmtab; /* translator references */ 8211a7c1b72Smws uint_t dtdo_krelen; /* length of krelo table */ 8221a7c1b72Smws uint_t dtdo_urelen; /* length of urelo table */ 8231a7c1b72Smws uint_t dtdo_xlmlen; /* length of translator table */ 8247c478bd9Sstevel@tonic-gate #endif 8257c478bd9Sstevel@tonic-gate } dtrace_difo_t; 8267c478bd9Sstevel@tonic-gate 8277c478bd9Sstevel@tonic-gate /* 8287c478bd9Sstevel@tonic-gate * DTrace Enabling Description Structures 8297c478bd9Sstevel@tonic-gate * 8307c478bd9Sstevel@tonic-gate * When DTrace is tracking the description of a DTrace enabling entity (probe, 8317c478bd9Sstevel@tonic-gate * predicate, action, ECB, record, etc.), it does so in a description 8327c478bd9Sstevel@tonic-gate * structure. These structures all end in "desc", and are used at both 8337c478bd9Sstevel@tonic-gate * user-level and in the kernel -- but (with the exception of 8347c478bd9Sstevel@tonic-gate * dtrace_probedesc_t) they are never passed between them. Typically, 8357c478bd9Sstevel@tonic-gate * user-level will use the description structures when assembling an enabling. 8367c478bd9Sstevel@tonic-gate * It will then distill those description structures into a DOF object (see 8377c478bd9Sstevel@tonic-gate * above), and send it into the kernel. The kernel will again use the 8387c478bd9Sstevel@tonic-gate * description structures to create a description of the enabling as it reads 8397c478bd9Sstevel@tonic-gate * the DOF. When the description is complete, the enabling will be actually 8407c478bd9Sstevel@tonic-gate * created -- turning it into the structures that represent the enabling 8417c478bd9Sstevel@tonic-gate * instead of merely describing it. Not surprisingly, the description 8427c478bd9Sstevel@tonic-gate * structures bear a strong resemblance to the DOF structures that act as their 8437c478bd9Sstevel@tonic-gate * conduit. 8447c478bd9Sstevel@tonic-gate */ 8457c478bd9Sstevel@tonic-gate struct dtrace_predicate; 8467c478bd9Sstevel@tonic-gate 8477c478bd9Sstevel@tonic-gate typedef struct dtrace_probedesc { 8487c478bd9Sstevel@tonic-gate dtrace_id_t dtpd_id; /* probe identifier */ 8497c478bd9Sstevel@tonic-gate char dtpd_provider[DTRACE_PROVNAMELEN]; /* probe provider name */ 8507c478bd9Sstevel@tonic-gate char dtpd_mod[DTRACE_MODNAMELEN]; /* probe module name */ 8517c478bd9Sstevel@tonic-gate char dtpd_func[DTRACE_FUNCNAMELEN]; /* probe function name */ 8527c478bd9Sstevel@tonic-gate char dtpd_name[DTRACE_NAMELEN]; /* probe name */ 8537c478bd9Sstevel@tonic-gate } dtrace_probedesc_t; 8547c478bd9Sstevel@tonic-gate 8557c478bd9Sstevel@tonic-gate typedef struct dtrace_repldesc { 8567c478bd9Sstevel@tonic-gate dtrace_probedesc_t dtrpd_match; /* probe descr. to match */ 8577c478bd9Sstevel@tonic-gate dtrace_probedesc_t dtrpd_create; /* probe descr. to create */ 8587c478bd9Sstevel@tonic-gate } dtrace_repldesc_t; 8597c478bd9Sstevel@tonic-gate 8607c478bd9Sstevel@tonic-gate typedef struct dtrace_preddesc { 8617c478bd9Sstevel@tonic-gate dtrace_difo_t *dtpdd_difo; /* pointer to DIF object */ 8627c478bd9Sstevel@tonic-gate struct dtrace_predicate *dtpdd_predicate; /* pointer to predicate */ 8637c478bd9Sstevel@tonic-gate } dtrace_preddesc_t; 8647c478bd9Sstevel@tonic-gate 8657c478bd9Sstevel@tonic-gate typedef struct dtrace_actdesc { 8667c478bd9Sstevel@tonic-gate dtrace_difo_t *dtad_difo; /* pointer to DIF object */ 8677c478bd9Sstevel@tonic-gate struct dtrace_actdesc *dtad_next; /* next action */ 8687c478bd9Sstevel@tonic-gate dtrace_actkind_t dtad_kind; /* kind of action */ 8697c478bd9Sstevel@tonic-gate uint32_t dtad_ntuple; /* number in tuple */ 8707c478bd9Sstevel@tonic-gate uint64_t dtad_arg; /* action argument */ 8717c478bd9Sstevel@tonic-gate uint64_t dtad_uarg; /* user argument */ 8727c478bd9Sstevel@tonic-gate int dtad_refcnt; /* reference count */ 8737c478bd9Sstevel@tonic-gate } dtrace_actdesc_t; 8747c478bd9Sstevel@tonic-gate 8757c478bd9Sstevel@tonic-gate typedef struct dtrace_ecbdesc { 8767c478bd9Sstevel@tonic-gate dtrace_actdesc_t *dted_action; /* action description(s) */ 8777c478bd9Sstevel@tonic-gate dtrace_preddesc_t dted_pred; /* predicate description */ 8787c478bd9Sstevel@tonic-gate dtrace_probedesc_t dted_probe; /* probe description */ 8797c478bd9Sstevel@tonic-gate uint64_t dted_uarg; /* library argument */ 8807c478bd9Sstevel@tonic-gate int dted_refcnt; /* reference count */ 8817c478bd9Sstevel@tonic-gate } dtrace_ecbdesc_t; 8827c478bd9Sstevel@tonic-gate 8837c478bd9Sstevel@tonic-gate /* 8847c478bd9Sstevel@tonic-gate * DTrace Metadata Description Structures 8857c478bd9Sstevel@tonic-gate * 8867c478bd9Sstevel@tonic-gate * DTrace separates the trace data stream from the metadata stream. The only 8877c478bd9Sstevel@tonic-gate * metadata tokens placed in the data stream are enabled probe identifiers 8887c478bd9Sstevel@tonic-gate * (EPIDs) or (in the case of aggregations) aggregation identifiers. In order 8897c478bd9Sstevel@tonic-gate * to determine the structure of the data, DTrace consumers pass the token to 8907c478bd9Sstevel@tonic-gate * the kernel, and receive in return a corresponding description of the enabled 8917c478bd9Sstevel@tonic-gate * probe (via the dtrace_eprobedesc structure) or the aggregation (via the 8927c478bd9Sstevel@tonic-gate * dtrace_aggdesc structure). Both of these structures are expressed in terms 8937c478bd9Sstevel@tonic-gate * of record descriptions (via the dtrace_recdesc structure) that describe the 8947c478bd9Sstevel@tonic-gate * exact structure of the data. Some record descriptions may also contain a 8957c478bd9Sstevel@tonic-gate * format identifier; this additional bit of metadata can be retrieved from the 8967c478bd9Sstevel@tonic-gate * kernel, for which a format description is returned via the dtrace_fmtdesc 8977c478bd9Sstevel@tonic-gate * structure. Note that all four of these structures must be bitness-neutral 8987c478bd9Sstevel@tonic-gate * to allow for a 32-bit DTrace consumer on a 64-bit kernel. 8997c478bd9Sstevel@tonic-gate */ 9007c478bd9Sstevel@tonic-gate typedef struct dtrace_recdesc { 9017c478bd9Sstevel@tonic-gate dtrace_actkind_t dtrd_action; /* kind of action */ 9027c478bd9Sstevel@tonic-gate uint32_t dtrd_size; /* size of record */ 9037c478bd9Sstevel@tonic-gate uint32_t dtrd_offset; /* offset in ECB's data */ 9047c478bd9Sstevel@tonic-gate uint16_t dtrd_alignment; /* required alignment */ 9057c478bd9Sstevel@tonic-gate uint16_t dtrd_format; /* format, if any */ 9067c478bd9Sstevel@tonic-gate uint64_t dtrd_arg; /* action argument */ 9077c478bd9Sstevel@tonic-gate uint64_t dtrd_uarg; /* user argument */ 9087c478bd9Sstevel@tonic-gate } dtrace_recdesc_t; 9097c478bd9Sstevel@tonic-gate 9107c478bd9Sstevel@tonic-gate typedef struct dtrace_eprobedesc { 9117c478bd9Sstevel@tonic-gate dtrace_epid_t dtepd_epid; /* enabled probe ID */ 9127c478bd9Sstevel@tonic-gate dtrace_id_t dtepd_probeid; /* probe ID */ 9137c478bd9Sstevel@tonic-gate uint64_t dtepd_uarg; /* library argument */ 9147c478bd9Sstevel@tonic-gate uint32_t dtepd_size; /* total size */ 9157c478bd9Sstevel@tonic-gate int dtepd_nrecs; /* number of records */ 9167c478bd9Sstevel@tonic-gate dtrace_recdesc_t dtepd_rec[1]; /* records themselves */ 9177c478bd9Sstevel@tonic-gate } dtrace_eprobedesc_t; 9187c478bd9Sstevel@tonic-gate 9197c478bd9Sstevel@tonic-gate typedef struct dtrace_aggdesc { 9207c478bd9Sstevel@tonic-gate DTRACE_PTR(char, dtagd_name); /* not filled in by kernel */ 92130ef842dSbmc dtrace_aggvarid_t dtagd_varid; /* not filled in by kernel */ 9227c478bd9Sstevel@tonic-gate int dtagd_flags; /* not filled in by kernel */ 9237c478bd9Sstevel@tonic-gate dtrace_aggid_t dtagd_id; /* aggregation ID */ 9247c478bd9Sstevel@tonic-gate dtrace_epid_t dtagd_epid; /* enabled probe ID */ 9257c478bd9Sstevel@tonic-gate uint32_t dtagd_size; /* size in bytes */ 9267c478bd9Sstevel@tonic-gate int dtagd_nrecs; /* number of records */ 9277c478bd9Sstevel@tonic-gate uint32_t dtagd_pad; /* explicit padding */ 9287c478bd9Sstevel@tonic-gate dtrace_recdesc_t dtagd_rec[1]; /* record descriptions */ 9297c478bd9Sstevel@tonic-gate } dtrace_aggdesc_t; 9307c478bd9Sstevel@tonic-gate 9317c478bd9Sstevel@tonic-gate typedef struct dtrace_fmtdesc { 9327c478bd9Sstevel@tonic-gate DTRACE_PTR(char, dtfd_string); /* format string */ 9337c478bd9Sstevel@tonic-gate int dtfd_length; /* length of format string */ 9347c478bd9Sstevel@tonic-gate uint16_t dtfd_format; /* format identifier */ 9357c478bd9Sstevel@tonic-gate } dtrace_fmtdesc_t; 9367c478bd9Sstevel@tonic-gate 9377c478bd9Sstevel@tonic-gate #define DTRACE_SIZEOF_EPROBEDESC(desc) \ 9387c478bd9Sstevel@tonic-gate (sizeof (dtrace_eprobedesc_t) + ((desc)->dtepd_nrecs ? \ 9397c478bd9Sstevel@tonic-gate (((desc)->dtepd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0)) 9407c478bd9Sstevel@tonic-gate 9417c478bd9Sstevel@tonic-gate #define DTRACE_SIZEOF_AGGDESC(desc) \ 9427c478bd9Sstevel@tonic-gate (sizeof (dtrace_aggdesc_t) + ((desc)->dtagd_nrecs ? \ 9437c478bd9Sstevel@tonic-gate (((desc)->dtagd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0)) 9447c478bd9Sstevel@tonic-gate 9457c478bd9Sstevel@tonic-gate /* 9467c478bd9Sstevel@tonic-gate * DTrace Option Interface 9477c478bd9Sstevel@tonic-gate * 9487c478bd9Sstevel@tonic-gate * Run-time DTrace options are set and retrieved via DOF_SECT_OPTDESC sections 9497c478bd9Sstevel@tonic-gate * in a DOF image. The dof_optdesc structure contains an option identifier and 9507c478bd9Sstevel@tonic-gate * an option value. The valid option identifiers are found below; the mapping 9517c478bd9Sstevel@tonic-gate * between option identifiers and option identifying strings is maintained at 9527c478bd9Sstevel@tonic-gate * user-level. Note that the value of DTRACEOPT_UNSET is such that all of the 9537c478bd9Sstevel@tonic-gate * following are potentially valid option values: all positive integers, zero 9547c478bd9Sstevel@tonic-gate * and negative one. Some options (notably "bufpolicy" and "bufresize") take 9557c478bd9Sstevel@tonic-gate * predefined tokens as their values; these are defined with 9567c478bd9Sstevel@tonic-gate * DTRACEOPT_{option}_{token}. 9577c478bd9Sstevel@tonic-gate */ 9587c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFSIZE 0 /* buffer size */ 9597c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFPOLICY 1 /* buffer policy */ 9607c478bd9Sstevel@tonic-gate #define DTRACEOPT_DYNVARSIZE 2 /* dynamic variable size */ 9617c478bd9Sstevel@tonic-gate #define DTRACEOPT_AGGSIZE 3 /* aggregation size */ 9627c478bd9Sstevel@tonic-gate #define DTRACEOPT_SPECSIZE 4 /* speculation size */ 9637c478bd9Sstevel@tonic-gate #define DTRACEOPT_NSPEC 5 /* number of speculations */ 9647c478bd9Sstevel@tonic-gate #define DTRACEOPT_STRSIZE 6 /* string size */ 9657c478bd9Sstevel@tonic-gate #define DTRACEOPT_CLEANRATE 7 /* dynvar cleaning rate */ 9667c478bd9Sstevel@tonic-gate #define DTRACEOPT_CPU 8 /* CPU to trace */ 9677c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFRESIZE 9 /* buffer resizing policy */ 9687c478bd9Sstevel@tonic-gate #define DTRACEOPT_GRABANON 10 /* grab anonymous state, if any */ 9697c478bd9Sstevel@tonic-gate #define DTRACEOPT_FLOWINDENT 11 /* indent function entry/return */ 9707c478bd9Sstevel@tonic-gate #define DTRACEOPT_QUIET 12 /* only output explicitly traced data */ 9717c478bd9Sstevel@tonic-gate #define DTRACEOPT_STACKFRAMES 13 /* number of stack frames */ 9727c478bd9Sstevel@tonic-gate #define DTRACEOPT_USTACKFRAMES 14 /* number of user stack frames */ 9737c478bd9Sstevel@tonic-gate #define DTRACEOPT_AGGRATE 15 /* aggregation snapshot rate */ 9747c478bd9Sstevel@tonic-gate #define DTRACEOPT_SWITCHRATE 16 /* buffer switching rate */ 9757c478bd9Sstevel@tonic-gate #define DTRACEOPT_STATUSRATE 17 /* status rate */ 9767c478bd9Sstevel@tonic-gate #define DTRACEOPT_DESTRUCTIVE 18 /* destructive actions allowed */ 9777c478bd9Sstevel@tonic-gate #define DTRACEOPT_STACKINDENT 19 /* output indent for stack traces */ 9787c478bd9Sstevel@tonic-gate #define DTRACEOPT_RAWBYTES 20 /* always print bytes in raw form */ 9797c478bd9Sstevel@tonic-gate #define DTRACEOPT_JSTACKFRAMES 21 /* number of jstack() frames */ 9807c478bd9Sstevel@tonic-gate #define DTRACEOPT_JSTACKSTRSIZE 22 /* size of jstack() string table */ 98130ef842dSbmc #define DTRACEOPT_AGGSORTKEY 23 /* sort aggregations by key */ 98230ef842dSbmc #define DTRACEOPT_AGGSORTREV 24 /* reverse-sort aggregations */ 98330ef842dSbmc #define DTRACEOPT_AGGSORTPOS 25 /* agg. position to sort on */ 98430ef842dSbmc #define DTRACEOPT_AGGSORTKEYPOS 26 /* agg. key position to sort on */ 98530ef842dSbmc #define DTRACEOPT_MAX 27 /* number of options */ 9867c478bd9Sstevel@tonic-gate 9877c478bd9Sstevel@tonic-gate #define DTRACEOPT_UNSET (dtrace_optval_t)-2 /* unset option */ 9887c478bd9Sstevel@tonic-gate 9897c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFPOLICY_RING 0 /* ring buffer */ 9907c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFPOLICY_FILL 1 /* fill buffer, then stop */ 9917c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFPOLICY_SWITCH 2 /* switch buffers */ 9927c478bd9Sstevel@tonic-gate 9937c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFRESIZE_AUTO 0 /* automatic resizing */ 9947c478bd9Sstevel@tonic-gate #define DTRACEOPT_BUFRESIZE_MANUAL 1 /* manual resizing */ 9957c478bd9Sstevel@tonic-gate 9967c478bd9Sstevel@tonic-gate /* 9977c478bd9Sstevel@tonic-gate * DTrace Buffer Interface 9987c478bd9Sstevel@tonic-gate * 9997c478bd9Sstevel@tonic-gate * In order to get a snapshot of the principal or aggregation buffer, 10007c478bd9Sstevel@tonic-gate * user-level passes a buffer description to the kernel with the dtrace_bufdesc 10017c478bd9Sstevel@tonic-gate * structure. This describes which CPU user-level is interested in, and 10027c478bd9Sstevel@tonic-gate * where user-level wishes the kernel to snapshot the buffer to (the 10037c478bd9Sstevel@tonic-gate * dtbd_data field). The kernel uses the same structure to pass back some 10047c478bd9Sstevel@tonic-gate * information regarding the buffer: the size of data actually copied out, the 10057c478bd9Sstevel@tonic-gate * number of drops, the number of errors, and the offset of the oldest record. 10067c478bd9Sstevel@tonic-gate * If the buffer policy is a "switch" policy, taking a snapshot of the 10077c478bd9Sstevel@tonic-gate * principal buffer has the additional effect of switching the active and 10087c478bd9Sstevel@tonic-gate * inactive buffers. Taking a snapshot of the aggregation buffer _always_ has 10097c478bd9Sstevel@tonic-gate * the additional effect of switching the active and inactive buffers. 10107c478bd9Sstevel@tonic-gate */ 10117c478bd9Sstevel@tonic-gate typedef struct dtrace_bufdesc { 10127c478bd9Sstevel@tonic-gate uint64_t dtbd_size; /* size of buffer */ 10137c478bd9Sstevel@tonic-gate uint32_t dtbd_cpu; /* CPU or DTRACE_CPUALL */ 10147c478bd9Sstevel@tonic-gate uint32_t dtbd_errors; /* number of errors */ 10157c478bd9Sstevel@tonic-gate uint64_t dtbd_drops; /* number of drops */ 10167c478bd9Sstevel@tonic-gate DTRACE_PTR(char, dtbd_data); /* data */ 10177c478bd9Sstevel@tonic-gate uint64_t dtbd_oldest; /* offset of oldest record */ 10187c478bd9Sstevel@tonic-gate } dtrace_bufdesc_t; 10197c478bd9Sstevel@tonic-gate 10207c478bd9Sstevel@tonic-gate /* 10217c478bd9Sstevel@tonic-gate * DTrace Status 10227c478bd9Sstevel@tonic-gate * 10237c478bd9Sstevel@tonic-gate * The status of DTrace is relayed via the dtrace_status structure. This 10247c478bd9Sstevel@tonic-gate * structure contains members to count drops other than the capacity drops 10257c478bd9Sstevel@tonic-gate * available via the buffer interface (see above). This consists of dynamic 10267c478bd9Sstevel@tonic-gate * drops (including capacity dynamic drops, rinsing drops and dirty drops), and 10277c478bd9Sstevel@tonic-gate * speculative drops (including capacity speculative drops, drops due to busy 10287c478bd9Sstevel@tonic-gate * speculative buffers and drops due to unavailable speculative buffers). 10297c478bd9Sstevel@tonic-gate * Additionally, the status structure contains a field to indicate the number 10307c478bd9Sstevel@tonic-gate * of "fill"-policy buffers have been filled and a boolean field to indicate 10317c478bd9Sstevel@tonic-gate * that exit() has been called. If the dtst_exiting field is non-zero, no 10327c478bd9Sstevel@tonic-gate * further data will be generated until tracing is stopped (at which time any 10337c478bd9Sstevel@tonic-gate * enablings of the END action will be processed); if user-level sees that 10347c478bd9Sstevel@tonic-gate * this field is non-zero, tracing should be stopped as soon as possible. 10357c478bd9Sstevel@tonic-gate */ 10367c478bd9Sstevel@tonic-gate typedef struct dtrace_status { 10377c478bd9Sstevel@tonic-gate uint64_t dtst_dyndrops; /* dynamic drops */ 10387c478bd9Sstevel@tonic-gate uint64_t dtst_dyndrops_rinsing; /* dyn drops due to rinsing */ 10397c478bd9Sstevel@tonic-gate uint64_t dtst_dyndrops_dirty; /* dyn drops due to dirty */ 10407c478bd9Sstevel@tonic-gate uint64_t dtst_specdrops; /* speculative drops */ 10417c478bd9Sstevel@tonic-gate uint64_t dtst_specdrops_busy; /* spec drops due to busy */ 10427c478bd9Sstevel@tonic-gate uint64_t dtst_specdrops_unavail; /* spec drops due to unavail */ 10437c478bd9Sstevel@tonic-gate uint64_t dtst_errors; /* total errors */ 10447c478bd9Sstevel@tonic-gate uint64_t dtst_filled; /* number of filled bufs */ 1045a1b5e537Sbmc uint64_t dtst_stkstroverflows; /* stack string tab overflows */ 1046a1b5e537Sbmc uint64_t dtst_dblerrors; /* errors in ERROR probes */ 10477c478bd9Sstevel@tonic-gate char dtst_killed; /* non-zero if killed */ 10487c478bd9Sstevel@tonic-gate char dtst_exiting; /* non-zero if exit() called */ 10497c478bd9Sstevel@tonic-gate char dtst_pad[6]; /* pad out to 64-bit align */ 10507c478bd9Sstevel@tonic-gate } dtrace_status_t; 10517c478bd9Sstevel@tonic-gate 10527c478bd9Sstevel@tonic-gate /* 10537c478bd9Sstevel@tonic-gate * DTrace Configuration 10547c478bd9Sstevel@tonic-gate * 10557c478bd9Sstevel@tonic-gate * User-level may need to understand some elements of the kernel DTrace 10567c478bd9Sstevel@tonic-gate * configuration in order to generate correct DIF. This information is 10577c478bd9Sstevel@tonic-gate * conveyed via the dtrace_conf structure. 10587c478bd9Sstevel@tonic-gate */ 10597c478bd9Sstevel@tonic-gate typedef struct dtrace_conf { 10607c478bd9Sstevel@tonic-gate uint_t dtc_difversion; /* supported DIF version */ 10617c478bd9Sstevel@tonic-gate uint_t dtc_difintregs; /* # of DIF integer registers */ 10627c478bd9Sstevel@tonic-gate uint_t dtc_diftupregs; /* # of DIF tuple registers */ 10637c478bd9Sstevel@tonic-gate uint_t dtc_ctfmodel; /* CTF data model */ 10647c478bd9Sstevel@tonic-gate uint_t dtc_pad[8]; /* reserved for future use */ 10657c478bd9Sstevel@tonic-gate } dtrace_conf_t; 10667c478bd9Sstevel@tonic-gate 10677c478bd9Sstevel@tonic-gate /* 10687c478bd9Sstevel@tonic-gate * DTrace Faults 10697c478bd9Sstevel@tonic-gate * 10707c478bd9Sstevel@tonic-gate * The constants below DTRACEFLT_LIBRARY indicate probe processing faults; 10717c478bd9Sstevel@tonic-gate * constants at or above DTRACEFLT_LIBRARY indicate faults in probe 10727c478bd9Sstevel@tonic-gate * postprocessing at user-level. Probe processing faults induce an ERROR 10737c478bd9Sstevel@tonic-gate * probe and are replicated in unistd.d to allow users' ERROR probes to decode 10747c478bd9Sstevel@tonic-gate * the error condition using thse symbolic labels. 10757c478bd9Sstevel@tonic-gate */ 10767c478bd9Sstevel@tonic-gate #define DTRACEFLT_UNKNOWN 0 /* Unknown fault */ 10777c478bd9Sstevel@tonic-gate #define DTRACEFLT_BADADDR 1 /* Bad address */ 10787c478bd9Sstevel@tonic-gate #define DTRACEFLT_BADALIGN 2 /* Bad alignment */ 10797c478bd9Sstevel@tonic-gate #define DTRACEFLT_ILLOP 3 /* Illegal operation */ 10807c478bd9Sstevel@tonic-gate #define DTRACEFLT_DIVZERO 4 /* Divide-by-zero */ 10817c478bd9Sstevel@tonic-gate #define DTRACEFLT_NOSCRATCH 5 /* Out of scratch space */ 10827c478bd9Sstevel@tonic-gate #define DTRACEFLT_KPRIV 6 /* Illegal kernel access */ 10837c478bd9Sstevel@tonic-gate #define DTRACEFLT_UPRIV 7 /* Illegal user access */ 10847c478bd9Sstevel@tonic-gate #define DTRACEFLT_TUPOFLOW 8 /* Tuple stack overflow */ 1085b8fac8e1Sjhaslam #define DTRACEFLT_BADSTACK 9 /* Bad stack */ 10867c478bd9Sstevel@tonic-gate 10877c478bd9Sstevel@tonic-gate #define DTRACEFLT_LIBRARY 1000 /* Library-level fault */ 10887c478bd9Sstevel@tonic-gate 10897c478bd9Sstevel@tonic-gate /* 10907c478bd9Sstevel@tonic-gate * DTrace Argument Types 10917c478bd9Sstevel@tonic-gate * 10927c478bd9Sstevel@tonic-gate * Because it would waste both space and time, argument types do not reside 10937c478bd9Sstevel@tonic-gate * with the probe. In order to determine argument types for args[X] 10947c478bd9Sstevel@tonic-gate * variables, the D compiler queries for argument types on a probe-by-probe 10957c478bd9Sstevel@tonic-gate * basis. (This optimizes for the common case that arguments are either not 10967c478bd9Sstevel@tonic-gate * used or used in an untyped fashion.) Typed arguments are specified with a 10977c478bd9Sstevel@tonic-gate * string of the type name in the dtragd_native member of the argument 10987c478bd9Sstevel@tonic-gate * description structure. Typed arguments may be further translated to types 10997c478bd9Sstevel@tonic-gate * of greater stability; the provider indicates such a translated argument by 11007c478bd9Sstevel@tonic-gate * filling in the dtargd_xlate member with the string of the translated type. 11017c478bd9Sstevel@tonic-gate * Finally, the provider may indicate which argument value a given argument 11027c478bd9Sstevel@tonic-gate * maps to by setting the dtargd_mapping member -- allowing a single argument 11037c478bd9Sstevel@tonic-gate * to map to multiple args[X] variables. 11047c478bd9Sstevel@tonic-gate */ 11057c478bd9Sstevel@tonic-gate typedef struct dtrace_argdesc { 11067c478bd9Sstevel@tonic-gate dtrace_id_t dtargd_id; /* probe identifier */ 11077c478bd9Sstevel@tonic-gate int dtargd_ndx; /* arg number (-1 iff none) */ 11087c478bd9Sstevel@tonic-gate int dtargd_mapping; /* value mapping */ 11097c478bd9Sstevel@tonic-gate char dtargd_native[DTRACE_ARGTYPELEN]; /* native type name */ 11107c478bd9Sstevel@tonic-gate char dtargd_xlate[DTRACE_ARGTYPELEN]; /* translated type name */ 11117c478bd9Sstevel@tonic-gate } dtrace_argdesc_t; 11127c478bd9Sstevel@tonic-gate 11137c478bd9Sstevel@tonic-gate /* 11147c478bd9Sstevel@tonic-gate * DTrace Stability Attributes 11157c478bd9Sstevel@tonic-gate * 11167c478bd9Sstevel@tonic-gate * Each DTrace provider advertises the name and data stability of each of its 11177c478bd9Sstevel@tonic-gate * probe description components, as well as its architectural dependencies. 11187c478bd9Sstevel@tonic-gate * The D compiler can query the provider attributes (dtrace_pattr_t below) in 11197c478bd9Sstevel@tonic-gate * order to compute the properties of an input program and report them. 11207c478bd9Sstevel@tonic-gate */ 11217c478bd9Sstevel@tonic-gate typedef uint8_t dtrace_stability_t; /* stability code (see attributes(5)) */ 11227c478bd9Sstevel@tonic-gate typedef uint8_t dtrace_class_t; /* architectural dependency class */ 11237c478bd9Sstevel@tonic-gate 11247c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_INTERNAL 0 /* private to DTrace itself */ 11257c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_PRIVATE 1 /* private to Sun (see docs) */ 11267c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_OBSOLETE 2 /* scheduled for removal */ 11277c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_EXTERNAL 3 /* not controlled by Sun */ 11287c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_UNSTABLE 4 /* new or rapidly changing */ 11297c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_EVOLVING 5 /* less rapidly changing */ 11307c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_STABLE 6 /* mature interface from Sun */ 11317c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_STANDARD 7 /* industry standard */ 11327c478bd9Sstevel@tonic-gate #define DTRACE_STABILITY_MAX 7 /* maximum valid stability */ 11337c478bd9Sstevel@tonic-gate 11347c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_UNKNOWN 0 /* unknown architectural dependency */ 11357c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_CPU 1 /* CPU-module-specific */ 11367c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_PLATFORM 2 /* platform-specific (uname -i) */ 11377c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_GROUP 3 /* hardware-group-specific (uname -m) */ 11387c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_ISA 4 /* ISA-specific (uname -p) */ 11397c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_COMMON 5 /* common to all systems */ 11407c478bd9Sstevel@tonic-gate #define DTRACE_CLASS_MAX 5 /* maximum valid class */ 11417c478bd9Sstevel@tonic-gate 11427c478bd9Sstevel@tonic-gate #define DTRACE_PRIV_NONE 0x0000 11437c478bd9Sstevel@tonic-gate #define DTRACE_PRIV_KERNEL 0x0001 11447c478bd9Sstevel@tonic-gate #define DTRACE_PRIV_USER 0x0002 11457c478bd9Sstevel@tonic-gate #define DTRACE_PRIV_PROC 0x0004 11467c478bd9Sstevel@tonic-gate #define DTRACE_PRIV_OWNER 0x0008 1147ad4023c4Sdp #define DTRACE_PRIV_ZONEOWNER 0x0010 11487c478bd9Sstevel@tonic-gate 11497c478bd9Sstevel@tonic-gate #define DTRACE_PRIV_ALL \ 11507c478bd9Sstevel@tonic-gate (DTRACE_PRIV_KERNEL | DTRACE_PRIV_USER | \ 1151ad4023c4Sdp DTRACE_PRIV_PROC | DTRACE_PRIV_OWNER | DTRACE_PRIV_ZONEOWNER) 11527c478bd9Sstevel@tonic-gate 11537c478bd9Sstevel@tonic-gate typedef struct dtrace_ppriv { 11547c478bd9Sstevel@tonic-gate uint32_t dtpp_flags; /* privilege flags */ 11557c478bd9Sstevel@tonic-gate uid_t dtpp_uid; /* user ID */ 1156ad4023c4Sdp zoneid_t dtpp_zoneid; /* zone ID */ 11577c478bd9Sstevel@tonic-gate } dtrace_ppriv_t; 11587c478bd9Sstevel@tonic-gate 11597c478bd9Sstevel@tonic-gate typedef struct dtrace_attribute { 11607c478bd9Sstevel@tonic-gate dtrace_stability_t dtat_name; /* entity name stability */ 11617c478bd9Sstevel@tonic-gate dtrace_stability_t dtat_data; /* entity data stability */ 11627c478bd9Sstevel@tonic-gate dtrace_class_t dtat_class; /* entity data dependency */ 11637c478bd9Sstevel@tonic-gate } dtrace_attribute_t; 11647c478bd9Sstevel@tonic-gate 11657c478bd9Sstevel@tonic-gate typedef struct dtrace_pattr { 11667c478bd9Sstevel@tonic-gate dtrace_attribute_t dtpa_provider; /* provider attributes */ 11677c478bd9Sstevel@tonic-gate dtrace_attribute_t dtpa_mod; /* module attributes */ 11687c478bd9Sstevel@tonic-gate dtrace_attribute_t dtpa_func; /* function attributes */ 11697c478bd9Sstevel@tonic-gate dtrace_attribute_t dtpa_name; /* name attributes */ 11707c478bd9Sstevel@tonic-gate dtrace_attribute_t dtpa_args; /* args[] attributes */ 11717c478bd9Sstevel@tonic-gate } dtrace_pattr_t; 11727c478bd9Sstevel@tonic-gate 11737c478bd9Sstevel@tonic-gate typedef struct dtrace_providerdesc { 11747c478bd9Sstevel@tonic-gate char dtvd_name[DTRACE_PROVNAMELEN]; /* provider name */ 11757c478bd9Sstevel@tonic-gate dtrace_pattr_t dtvd_attr; /* stability attributes */ 11767c478bd9Sstevel@tonic-gate dtrace_ppriv_t dtvd_priv; /* privileges required */ 11777c478bd9Sstevel@tonic-gate } dtrace_providerdesc_t; 11787c478bd9Sstevel@tonic-gate 11797c478bd9Sstevel@tonic-gate /* 11807c478bd9Sstevel@tonic-gate * DTrace Pseudodevice Interface 11817c478bd9Sstevel@tonic-gate * 11827c478bd9Sstevel@tonic-gate * DTrace is controlled through ioctl(2)'s to the in-kernel dtrace:dtrace 11837c478bd9Sstevel@tonic-gate * pseudodevice driver. These ioctls comprise the user-kernel interface to 11847c478bd9Sstevel@tonic-gate * DTrace. 11857c478bd9Sstevel@tonic-gate */ 11867c478bd9Sstevel@tonic-gate #define DTRACEIOC (('d' << 24) | ('t' << 16) | ('r' << 8)) 11877c478bd9Sstevel@tonic-gate #define DTRACEIOC_PROVIDER (DTRACEIOC | 1) /* provider query */ 11887c478bd9Sstevel@tonic-gate #define DTRACEIOC_PROBES (DTRACEIOC | 2) /* probe query */ 11897c478bd9Sstevel@tonic-gate #define DTRACEIOC_BUFSNAP (DTRACEIOC | 4) /* snapshot buffer */ 11907c478bd9Sstevel@tonic-gate #define DTRACEIOC_PROBEMATCH (DTRACEIOC | 5) /* match probes */ 11917c478bd9Sstevel@tonic-gate #define DTRACEIOC_ENABLE (DTRACEIOC | 6) /* enable probes */ 11927c478bd9Sstevel@tonic-gate #define DTRACEIOC_AGGSNAP (DTRACEIOC | 7) /* snapshot agg. */ 11937c478bd9Sstevel@tonic-gate #define DTRACEIOC_EPROBE (DTRACEIOC | 8) /* get eprobe desc. */ 11947c478bd9Sstevel@tonic-gate #define DTRACEIOC_PROBEARG (DTRACEIOC | 9) /* get probe arg */ 11957c478bd9Sstevel@tonic-gate #define DTRACEIOC_CONF (DTRACEIOC | 10) /* get config. */ 11967c478bd9Sstevel@tonic-gate #define DTRACEIOC_STATUS (DTRACEIOC | 11) /* get status */ 11977c478bd9Sstevel@tonic-gate #define DTRACEIOC_GO (DTRACEIOC | 12) /* start tracing */ 11987c478bd9Sstevel@tonic-gate #define DTRACEIOC_STOP (DTRACEIOC | 13) /* stop tracing */ 11997c478bd9Sstevel@tonic-gate #define DTRACEIOC_AGGDESC (DTRACEIOC | 15) /* get agg. desc. */ 12007c478bd9Sstevel@tonic-gate #define DTRACEIOC_FORMAT (DTRACEIOC | 16) /* get format str */ 12017c478bd9Sstevel@tonic-gate #define DTRACEIOC_DOFGET (DTRACEIOC | 17) /* get DOF */ 12027c478bd9Sstevel@tonic-gate #define DTRACEIOC_REPLICATE (DTRACEIOC | 18) /* replicate enab */ 12037c478bd9Sstevel@tonic-gate 12047c478bd9Sstevel@tonic-gate /* 12057c478bd9Sstevel@tonic-gate * DTrace Helpers 12067c478bd9Sstevel@tonic-gate * 12077c478bd9Sstevel@tonic-gate * In general, DTrace establishes probes in processes and takes actions on 12087c478bd9Sstevel@tonic-gate * processes without knowing their specific user-level structures. Instead of 12097c478bd9Sstevel@tonic-gate * existing in the framework, process-specific knowledge is contained by the 12107c478bd9Sstevel@tonic-gate * enabling D program -- which can apply process-specific knowledge by making 12117c478bd9Sstevel@tonic-gate * appropriate use of DTrace primitives like copyin() and copyinstr() to 12127c478bd9Sstevel@tonic-gate * operate on user-level data. However, there may exist some specific probes 12137c478bd9Sstevel@tonic-gate * of particular semantic relevance that the application developer may wish to 12147c478bd9Sstevel@tonic-gate * explicitly export. For example, an application may wish to export a probe 12157c478bd9Sstevel@tonic-gate * at the point that it begins and ends certain well-defined transactions. In 12167c478bd9Sstevel@tonic-gate * addition to providing probes, programs may wish to offer assistance for 12177c478bd9Sstevel@tonic-gate * certain actions. For example, in highly dynamic environments (e.g., Java), 12187c478bd9Sstevel@tonic-gate * it may be difficult to obtain a stack trace in terms of meaningful symbol 12197c478bd9Sstevel@tonic-gate * names (the translation from instruction addresses to corresponding symbol 12207c478bd9Sstevel@tonic-gate * names may only be possible in situ); these environments may wish to define 12217c478bd9Sstevel@tonic-gate * a series of actions to be applied in situ to obtain a meaningful stack 12227c478bd9Sstevel@tonic-gate * trace. 12237c478bd9Sstevel@tonic-gate * 12247c478bd9Sstevel@tonic-gate * These two mechanisms -- user-level statically defined tracing and assisting 12257c478bd9Sstevel@tonic-gate * DTrace actions -- are provided via DTrace _helpers_. Helpers are specified 12267c478bd9Sstevel@tonic-gate * via DOF, but unlike enabling DOF, helper DOF may contain definitions of 12277c478bd9Sstevel@tonic-gate * providers, probes and their arguments. If a helper wishes to provide 12287c478bd9Sstevel@tonic-gate * action assistance, probe descriptions and corresponding DIF actions may be 12297c478bd9Sstevel@tonic-gate * specified in the helper DOF. For such helper actions, however, the probe 12307c478bd9Sstevel@tonic-gate * description describes the specific helper: all DTrace helpers have the 12317c478bd9Sstevel@tonic-gate * provider name "dtrace" and the module name "helper", and the name of the 12327c478bd9Sstevel@tonic-gate * helper is contained in the function name (for example, the ustack() helper 12337c478bd9Sstevel@tonic-gate * is named "ustack"). Any helper-specific name may be contained in the name 12347c478bd9Sstevel@tonic-gate * (for example, if a helper were to have a constructor, it might be named 12357c478bd9Sstevel@tonic-gate * "dtrace:helper:<helper>:init"). Helper actions are only called when the 12367c478bd9Sstevel@tonic-gate * action that they are helping is taken. Helper actions may only return DIF 12377c478bd9Sstevel@tonic-gate * expressions, and may only call the following subroutines: 12387c478bd9Sstevel@tonic-gate * 12397c478bd9Sstevel@tonic-gate * alloca() <= Allocates memory out of the consumer's scratch space 12407c478bd9Sstevel@tonic-gate * bcopy() <= Copies memory to scratch space 12417c478bd9Sstevel@tonic-gate * copyin() <= Copies memory from user-level into consumer's scratch 12427c478bd9Sstevel@tonic-gate * copyinto() <= Copies memory into a specific location in scratch 12437c478bd9Sstevel@tonic-gate * copyinstr() <= Copies a string into a specific location in scratch 12447c478bd9Sstevel@tonic-gate * 12457c478bd9Sstevel@tonic-gate * Helper actions may only access the following built-in variables: 12467c478bd9Sstevel@tonic-gate * 12477c478bd9Sstevel@tonic-gate * curthread <= Current kthread_t pointer 12487c478bd9Sstevel@tonic-gate * tid <= Current thread identifier 12497c478bd9Sstevel@tonic-gate * pid <= Current process identifier 12505518d15bSdp * ppid <= Parent process identifier 12515518d15bSdp * uid <= Current user ID 12525518d15bSdp * gid <= Current group ID 12537c478bd9Sstevel@tonic-gate * execname <= Current executable name 12545518d15bSdp * zonename <= Current zone name 12557c478bd9Sstevel@tonic-gate * 12567c478bd9Sstevel@tonic-gate * Helper actions may not manipulate or allocate dynamic variables, but they 12577c478bd9Sstevel@tonic-gate * may have clause-local and statically-allocated global variables. The 12587c478bd9Sstevel@tonic-gate * helper action variable state is specific to the helper action -- variables 12597c478bd9Sstevel@tonic-gate * used by the helper action may not be accessed outside of the helper 12607c478bd9Sstevel@tonic-gate * action, and the helper action may not access variables that like outside 12617c478bd9Sstevel@tonic-gate * of it. Helper actions may not load from kernel memory at-large; they are 12627c478bd9Sstevel@tonic-gate * restricting to loading current user state (via copyin() and variants) and 12637c478bd9Sstevel@tonic-gate * scratch space. As with probe enablings, helper actions are executed in 12647c478bd9Sstevel@tonic-gate * program order. The result of the helper action is the result of the last 12657c478bd9Sstevel@tonic-gate * executing helper expression. 12667c478bd9Sstevel@tonic-gate * 12677c478bd9Sstevel@tonic-gate * Helpers -- composed of either providers/probes or probes/actions (or both) 12687c478bd9Sstevel@tonic-gate * -- are added by opening the "helper" minor node, and issuing an ioctl(2) 12697c478bd9Sstevel@tonic-gate * (DTRACEHIOC_ADDDOF) that specifies the dof_helper_t structure. This 12707c478bd9Sstevel@tonic-gate * encapsulates the name and base address of the user-level library or 12717c478bd9Sstevel@tonic-gate * executable publishing the helpers and probes as well as the DOF that 12727c478bd9Sstevel@tonic-gate * contains the definitions of those helpers and probes. 12737c478bd9Sstevel@tonic-gate * 12747c478bd9Sstevel@tonic-gate * The DTRACEHIOC_ADD and DTRACEHIOC_REMOVE are left in place for legacy 12757c478bd9Sstevel@tonic-gate * helpers and should no longer be used. No other ioctls are valid on the 12767c478bd9Sstevel@tonic-gate * helper minor node. 12777c478bd9Sstevel@tonic-gate */ 12787c478bd9Sstevel@tonic-gate #define DTRACEHIOC (('d' << 24) | ('t' << 16) | ('h' << 8)) 12797c478bd9Sstevel@tonic-gate #define DTRACEHIOC_ADD (DTRACEHIOC | 1) /* add helper */ 12807c478bd9Sstevel@tonic-gate #define DTRACEHIOC_REMOVE (DTRACEHIOC | 2) /* remove helper */ 12817c478bd9Sstevel@tonic-gate #define DTRACEHIOC_ADDDOF (DTRACEHIOC | 3) /* add helper DOF */ 12827c478bd9Sstevel@tonic-gate 12837c478bd9Sstevel@tonic-gate typedef struct dof_helper { 12847c478bd9Sstevel@tonic-gate char dofhp_mod[DTRACE_MODNAMELEN]; /* executable or library name */ 12857c478bd9Sstevel@tonic-gate uint64_t dofhp_addr; /* base address of object */ 12867c478bd9Sstevel@tonic-gate uint64_t dofhp_dof; /* address of helper DOF */ 12877c478bd9Sstevel@tonic-gate } dof_helper_t; 12887c478bd9Sstevel@tonic-gate 12897c478bd9Sstevel@tonic-gate #define DTRACEMNR_DTRACE "dtrace" /* node for DTrace ops */ 12907c478bd9Sstevel@tonic-gate #define DTRACEMNR_HELPER "helper" /* node for helpers */ 12917c478bd9Sstevel@tonic-gate #define DTRACEMNRN_DTRACE 0 /* minor for DTrace ops */ 12927c478bd9Sstevel@tonic-gate #define DTRACEMNRN_HELPER 1 /* minor for helpers */ 12937c478bd9Sstevel@tonic-gate #define DTRACEMNRN_CLONE 2 /* first clone minor */ 12947c478bd9Sstevel@tonic-gate 12957c478bd9Sstevel@tonic-gate #ifdef _KERNEL 12967c478bd9Sstevel@tonic-gate 12977c478bd9Sstevel@tonic-gate /* 12987c478bd9Sstevel@tonic-gate * DTrace Provider API 12997c478bd9Sstevel@tonic-gate * 13007c478bd9Sstevel@tonic-gate * The following functions are implemented by the DTrace framework and are 13017c478bd9Sstevel@tonic-gate * used to implement separate in-kernel DTrace providers. Common functions 13027c478bd9Sstevel@tonic-gate * are provided in uts/common/os/dtrace.c. ISA-dependent subroutines are 13037c478bd9Sstevel@tonic-gate * defined in uts/<isa>/dtrace/dtrace_asm.s or uts/<isa>/dtrace/dtrace_isa.c. 13047c478bd9Sstevel@tonic-gate * 13057c478bd9Sstevel@tonic-gate * The provider API has two halves: the API that the providers consume from 13067c478bd9Sstevel@tonic-gate * DTrace, and the API that providers make available to DTrace. 13077c478bd9Sstevel@tonic-gate * 13087c478bd9Sstevel@tonic-gate * 1 Framework-to-Provider API 13097c478bd9Sstevel@tonic-gate * 13107c478bd9Sstevel@tonic-gate * 1.1 Overview 13117c478bd9Sstevel@tonic-gate * 13127c478bd9Sstevel@tonic-gate * The Framework-to-Provider API is represented by the dtrace_pops structure 13137c478bd9Sstevel@tonic-gate * that the provider passes to the framework when registering itself. This 13147c478bd9Sstevel@tonic-gate * structure consists of the following members: 13157c478bd9Sstevel@tonic-gate * 13167c478bd9Sstevel@tonic-gate * dtps_provide() <-- Provide all probes, all modules 13177c478bd9Sstevel@tonic-gate * dtps_provide_module() <-- Provide all probes in specified module 13187c478bd9Sstevel@tonic-gate * dtps_enable() <-- Enable specified probe 13197c478bd9Sstevel@tonic-gate * dtps_disable() <-- Disable specified probe 13207c478bd9Sstevel@tonic-gate * dtps_suspend() <-- Suspend specified probe 13217c478bd9Sstevel@tonic-gate * dtps_resume() <-- Resume specified probe 13227c478bd9Sstevel@tonic-gate * dtps_getargdesc() <-- Get the argument description for args[X] 13237c478bd9Sstevel@tonic-gate * dtps_getargval() <-- Get the value for an argX or args[X] variable 13247c478bd9Sstevel@tonic-gate * dtps_usermode() <-- Find out if the probe was fired in user mode 13257c478bd9Sstevel@tonic-gate * dtps_destroy() <-- Destroy all state associated with this probe 13267c478bd9Sstevel@tonic-gate * 13277c478bd9Sstevel@tonic-gate * 1.2 void dtps_provide(void *arg, const dtrace_probedesc_t *spec) 13287c478bd9Sstevel@tonic-gate * 13297c478bd9Sstevel@tonic-gate * 1.2.1 Overview 13307c478bd9Sstevel@tonic-gate * 13317c478bd9Sstevel@tonic-gate * Called to indicate that the provider should provide all probes. If the 13327c478bd9Sstevel@tonic-gate * specified description is non-NULL, dtps_provide() is being called because 13337c478bd9Sstevel@tonic-gate * no probe matched a specified probe -- if the provider has the ability to 13347c478bd9Sstevel@tonic-gate * create custom probes, it may wish to create a probe that matches the 13357c478bd9Sstevel@tonic-gate * specified description. 13367c478bd9Sstevel@tonic-gate * 13377c478bd9Sstevel@tonic-gate * 1.2.2 Arguments and notes 13387c478bd9Sstevel@tonic-gate * 13397c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 13407c478bd9Sstevel@tonic-gate * second argument is a pointer to a probe description that the provider may 13417c478bd9Sstevel@tonic-gate * wish to consider when creating custom probes. The provider is expected to 13427c478bd9Sstevel@tonic-gate * call back into the DTrace framework via dtrace_probe_create() to create 13437c478bd9Sstevel@tonic-gate * any necessary probes. dtps_provide() may be called even if the provider 13447c478bd9Sstevel@tonic-gate * has made available all probes; the provider should check the return value 13457c478bd9Sstevel@tonic-gate * of dtrace_probe_create() to handle this case. Note that the provider need 13467c478bd9Sstevel@tonic-gate * not implement both dtps_provide() and dtps_provide_module(); see 13477c478bd9Sstevel@tonic-gate * "Arguments and Notes" for dtrace_register(), below. 13487c478bd9Sstevel@tonic-gate * 13497c478bd9Sstevel@tonic-gate * 1.2.3 Return value 13507c478bd9Sstevel@tonic-gate * 13517c478bd9Sstevel@tonic-gate * None. 13527c478bd9Sstevel@tonic-gate * 13537c478bd9Sstevel@tonic-gate * 1.2.4 Caller's context 13547c478bd9Sstevel@tonic-gate * 13557c478bd9Sstevel@tonic-gate * dtps_provide() is typically called from open() or ioctl() context, but may 13567c478bd9Sstevel@tonic-gate * be called from other contexts as well. The DTrace framework is locked in 13577c478bd9Sstevel@tonic-gate * such a way that providers may not register or unregister. This means that 13587c478bd9Sstevel@tonic-gate * the provider may not call any DTrace API that affects its registration with 13597c478bd9Sstevel@tonic-gate * the framework, including dtrace_register(), dtrace_unregister(), 13607c478bd9Sstevel@tonic-gate * dtrace_invalidate(), and dtrace_condense(). However, the context is such 13617c478bd9Sstevel@tonic-gate * that the provider may (and indeed, is expected to) call probe-related 13627c478bd9Sstevel@tonic-gate * DTrace routines, including dtrace_probe_create(), dtrace_probe_lookup(), 13637c478bd9Sstevel@tonic-gate * and dtrace_probe_arg(). 13647c478bd9Sstevel@tonic-gate * 13657c478bd9Sstevel@tonic-gate * 1.3 void dtps_provide_module(void *arg, struct modctl *mp) 13667c478bd9Sstevel@tonic-gate * 13677c478bd9Sstevel@tonic-gate * 1.3.1 Overview 13687c478bd9Sstevel@tonic-gate * 13697c478bd9Sstevel@tonic-gate * Called to indicate that the provider should provide all probes in the 13707c478bd9Sstevel@tonic-gate * specified module. 13717c478bd9Sstevel@tonic-gate * 13727c478bd9Sstevel@tonic-gate * 1.3.2 Arguments and notes 13737c478bd9Sstevel@tonic-gate * 13747c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 13757c478bd9Sstevel@tonic-gate * second argument is a pointer to a modctl structure that indicates the 13767c478bd9Sstevel@tonic-gate * module for which probes should be created. 13777c478bd9Sstevel@tonic-gate * 13787c478bd9Sstevel@tonic-gate * 1.3.3 Return value 13797c478bd9Sstevel@tonic-gate * 13807c478bd9Sstevel@tonic-gate * None. 13817c478bd9Sstevel@tonic-gate * 13827c478bd9Sstevel@tonic-gate * 1.3.4 Caller's context 13837c478bd9Sstevel@tonic-gate * 13847c478bd9Sstevel@tonic-gate * dtps_provide_module() may be called from open() or ioctl() context, but 13857c478bd9Sstevel@tonic-gate * may also be called from a module loading context. mod_lock is held, and 13867c478bd9Sstevel@tonic-gate * the DTrace framework is locked in such a way that providers may not 13877c478bd9Sstevel@tonic-gate * register or unregister. This means that the provider may not call any 13887c478bd9Sstevel@tonic-gate * DTrace API that affects its registration with the framework, including 13897c478bd9Sstevel@tonic-gate * dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and 13907c478bd9Sstevel@tonic-gate * dtrace_condense(). However, the context is such that the provider may (and 13917c478bd9Sstevel@tonic-gate * indeed, is expected to) call probe-related DTrace routines, including 13927c478bd9Sstevel@tonic-gate * dtrace_probe_create(), dtrace_probe_lookup(), and dtrace_probe_arg(). Note 13937c478bd9Sstevel@tonic-gate * that the provider need not implement both dtps_provide() and 13947c478bd9Sstevel@tonic-gate * dtps_provide_module(); see "Arguments and Notes" for dtrace_register(), 13957c478bd9Sstevel@tonic-gate * below. 13967c478bd9Sstevel@tonic-gate * 1397b9e93c10SJonathan Haslam * 1.4 int dtps_enable(void *arg, dtrace_id_t id, void *parg) 13987c478bd9Sstevel@tonic-gate * 13997c478bd9Sstevel@tonic-gate * 1.4.1 Overview 14007c478bd9Sstevel@tonic-gate * 14017c478bd9Sstevel@tonic-gate * Called to enable the specified probe. 14027c478bd9Sstevel@tonic-gate * 14037c478bd9Sstevel@tonic-gate * 1.4.2 Arguments and notes 14047c478bd9Sstevel@tonic-gate * 14057c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 14067c478bd9Sstevel@tonic-gate * second argument is the identifier of the probe to be enabled. The third 14077c478bd9Sstevel@tonic-gate * argument is the probe argument as passed to dtrace_probe_create(). 14087c478bd9Sstevel@tonic-gate * dtps_enable() will be called when a probe transitions from not being 14097c478bd9Sstevel@tonic-gate * enabled at all to having one or more ECB. The number of ECBs associated 14107c478bd9Sstevel@tonic-gate * with the probe may change without subsequent calls into the provider. 14117c478bd9Sstevel@tonic-gate * When the number of ECBs drops to zero, the provider will be explicitly 14127c478bd9Sstevel@tonic-gate * told to disable the probe via dtps_disable(). dtrace_probe() should never 14137c478bd9Sstevel@tonic-gate * be called for a probe identifier that hasn't been explicitly enabled via 14147c478bd9Sstevel@tonic-gate * dtps_enable(). 14157c478bd9Sstevel@tonic-gate * 14167c478bd9Sstevel@tonic-gate * 1.4.3 Return value 14177c478bd9Sstevel@tonic-gate * 1418b9e93c10SJonathan Haslam * On success, dtps_enable() should return 0. On failure, -1 should be 1419b9e93c10SJonathan Haslam * returned. 14207c478bd9Sstevel@tonic-gate * 14217c478bd9Sstevel@tonic-gate * 1.4.4 Caller's context 14227c478bd9Sstevel@tonic-gate * 14237c478bd9Sstevel@tonic-gate * The DTrace framework is locked in such a way that it may not be called 14247c478bd9Sstevel@tonic-gate * back into at all. cpu_lock is held. mod_lock is not held and may not 14257c478bd9Sstevel@tonic-gate * be acquired. 14267c478bd9Sstevel@tonic-gate * 14277c478bd9Sstevel@tonic-gate * 1.5 void dtps_disable(void *arg, dtrace_id_t id, void *parg) 14287c478bd9Sstevel@tonic-gate * 14297c478bd9Sstevel@tonic-gate * 1.5.1 Overview 14307c478bd9Sstevel@tonic-gate * 14317c478bd9Sstevel@tonic-gate * Called to disable the specified probe. 14327c478bd9Sstevel@tonic-gate * 14337c478bd9Sstevel@tonic-gate * 1.5.2 Arguments and notes 14347c478bd9Sstevel@tonic-gate * 14357c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 14367c478bd9Sstevel@tonic-gate * second argument is the identifier of the probe to be disabled. The third 14377c478bd9Sstevel@tonic-gate * argument is the probe argument as passed to dtrace_probe_create(). 14387c478bd9Sstevel@tonic-gate * dtps_disable() will be called when a probe transitions from being enabled 14397c478bd9Sstevel@tonic-gate * to having zero ECBs. dtrace_probe() should never be called for a probe 14407c478bd9Sstevel@tonic-gate * identifier that has been explicitly enabled via dtps_disable(). 14417c478bd9Sstevel@tonic-gate * 14427c478bd9Sstevel@tonic-gate * 1.5.3 Return value 14437c478bd9Sstevel@tonic-gate * 14447c478bd9Sstevel@tonic-gate * None. 14457c478bd9Sstevel@tonic-gate * 14467c478bd9Sstevel@tonic-gate * 1.5.4 Caller's context 14477c478bd9Sstevel@tonic-gate * 14487c478bd9Sstevel@tonic-gate * The DTrace framework is locked in such a way that it may not be called 14497c478bd9Sstevel@tonic-gate * back into at all. cpu_lock is held. mod_lock is not held and may not 14507c478bd9Sstevel@tonic-gate * be acquired. 14517c478bd9Sstevel@tonic-gate * 14527c478bd9Sstevel@tonic-gate * 1.6 void dtps_suspend(void *arg, dtrace_id_t id, void *parg) 14537c478bd9Sstevel@tonic-gate * 14547c478bd9Sstevel@tonic-gate * 1.6.1 Overview 14557c478bd9Sstevel@tonic-gate * 14567c478bd9Sstevel@tonic-gate * Called to suspend the specified enabled probe. This entry point is for 14577c478bd9Sstevel@tonic-gate * providers that may need to suspend some or all of their probes when CPUs 14587c478bd9Sstevel@tonic-gate * are being powered on or when the boot monitor is being entered for a 14597c478bd9Sstevel@tonic-gate * prolonged period of time. 14607c478bd9Sstevel@tonic-gate * 14617c478bd9Sstevel@tonic-gate * 1.6.2 Arguments and notes 14627c478bd9Sstevel@tonic-gate * 14637c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 14647c478bd9Sstevel@tonic-gate * second argument is the identifier of the probe to be suspended. The 14657c478bd9Sstevel@tonic-gate * third argument is the probe argument as passed to dtrace_probe_create(). 14667c478bd9Sstevel@tonic-gate * dtps_suspend will only be called on an enabled probe. Providers that 14677c478bd9Sstevel@tonic-gate * provide a dtps_suspend entry point will want to take roughly the action 14687c478bd9Sstevel@tonic-gate * that it takes for dtps_disable. 14697c478bd9Sstevel@tonic-gate * 14707c478bd9Sstevel@tonic-gate * 1.6.3 Return value 14717c478bd9Sstevel@tonic-gate * 14727c478bd9Sstevel@tonic-gate * None. 14737c478bd9Sstevel@tonic-gate * 14747c478bd9Sstevel@tonic-gate * 1.6.4 Caller's context 14757c478bd9Sstevel@tonic-gate * 14767c478bd9Sstevel@tonic-gate * Interrupts are disabled. The DTrace framework is in a state such that the 14777c478bd9Sstevel@tonic-gate * specified probe cannot be disabled or destroyed for the duration of 14787c478bd9Sstevel@tonic-gate * dtps_suspend(). As interrupts are disabled, the provider is afforded 14797c478bd9Sstevel@tonic-gate * little latitude; the provider is expected to do no more than a store to 14807c478bd9Sstevel@tonic-gate * memory. 14817c478bd9Sstevel@tonic-gate * 14827c478bd9Sstevel@tonic-gate * 1.7 void dtps_resume(void *arg, dtrace_id_t id, void *parg) 14837c478bd9Sstevel@tonic-gate * 14847c478bd9Sstevel@tonic-gate * 1.7.1 Overview 14857c478bd9Sstevel@tonic-gate * 14867c478bd9Sstevel@tonic-gate * Called to resume the specified enabled probe. This entry point is for 14877c478bd9Sstevel@tonic-gate * providers that may need to resume some or all of their probes after the 14887c478bd9Sstevel@tonic-gate * completion of an event that induced a call to dtps_suspend(). 14897c478bd9Sstevel@tonic-gate * 14907c478bd9Sstevel@tonic-gate * 1.7.2 Arguments and notes 14917c478bd9Sstevel@tonic-gate * 14927c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 14937c478bd9Sstevel@tonic-gate * second argument is the identifier of the probe to be resumed. The 14947c478bd9Sstevel@tonic-gate * third argument is the probe argument as passed to dtrace_probe_create(). 14957c478bd9Sstevel@tonic-gate * dtps_resume will only be called on an enabled probe. Providers that 14967c478bd9Sstevel@tonic-gate * provide a dtps_resume entry point will want to take roughly the action 14977c478bd9Sstevel@tonic-gate * that it takes for dtps_enable. 14987c478bd9Sstevel@tonic-gate * 14997c478bd9Sstevel@tonic-gate * 1.7.3 Return value 15007c478bd9Sstevel@tonic-gate * 15017c478bd9Sstevel@tonic-gate * None. 15027c478bd9Sstevel@tonic-gate * 15037c478bd9Sstevel@tonic-gate * 1.7.4 Caller's context 15047c478bd9Sstevel@tonic-gate * 15057c478bd9Sstevel@tonic-gate * Interrupts are disabled. The DTrace framework is in a state such that the 15067c478bd9Sstevel@tonic-gate * specified probe cannot be disabled or destroyed for the duration of 15077c478bd9Sstevel@tonic-gate * dtps_resume(). As interrupts are disabled, the provider is afforded 15087c478bd9Sstevel@tonic-gate * little latitude; the provider is expected to do no more than a store to 15097c478bd9Sstevel@tonic-gate * memory. 15107c478bd9Sstevel@tonic-gate * 15117c478bd9Sstevel@tonic-gate * 1.8 void dtps_getargdesc(void *arg, dtrace_id_t id, void *parg, 15127c478bd9Sstevel@tonic-gate * dtrace_argdesc_t *desc) 15137c478bd9Sstevel@tonic-gate * 15147c478bd9Sstevel@tonic-gate * 1.8.1 Overview 15157c478bd9Sstevel@tonic-gate * 15167c478bd9Sstevel@tonic-gate * Called to retrieve the argument description for an args[X] variable. 15177c478bd9Sstevel@tonic-gate * 15187c478bd9Sstevel@tonic-gate * 1.8.2 Arguments and notes 15197c478bd9Sstevel@tonic-gate * 15207c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 15217c478bd9Sstevel@tonic-gate * second argument is the identifier of the current probe. The third 15227c478bd9Sstevel@tonic-gate * argument is the probe argument as passed to dtrace_probe_create(). The 15237c478bd9Sstevel@tonic-gate * fourth argument is a pointer to the argument description. This 15247c478bd9Sstevel@tonic-gate * description is both an input and output parameter: it contains the 15257c478bd9Sstevel@tonic-gate * index of the desired argument in the dtargd_ndx field, and expects 15267c478bd9Sstevel@tonic-gate * the other fields to be filled in upon return. If there is no argument 15277c478bd9Sstevel@tonic-gate * corresponding to the specified index, the dtargd_ndx field should be set 15287c478bd9Sstevel@tonic-gate * to DTRACE_ARGNONE. 15297c478bd9Sstevel@tonic-gate * 15307c478bd9Sstevel@tonic-gate * 1.8.3 Return value 15317c478bd9Sstevel@tonic-gate * 15327c478bd9Sstevel@tonic-gate * None. The dtargd_ndx, dtargd_native, dtargd_xlate and dtargd_mapping 15337c478bd9Sstevel@tonic-gate * members of the dtrace_argdesc_t structure are all output values. 15347c478bd9Sstevel@tonic-gate * 15357c478bd9Sstevel@tonic-gate * 1.8.4 Caller's context 15367c478bd9Sstevel@tonic-gate * 15377c478bd9Sstevel@tonic-gate * dtps_getargdesc() is called from ioctl() context. mod_lock is held, and 15387c478bd9Sstevel@tonic-gate * the DTrace framework is locked in such a way that providers may not 15397c478bd9Sstevel@tonic-gate * register or unregister. This means that the provider may not call any 15407c478bd9Sstevel@tonic-gate * DTrace API that affects its registration with the framework, including 15417c478bd9Sstevel@tonic-gate * dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and 15427c478bd9Sstevel@tonic-gate * dtrace_condense(). 15437c478bd9Sstevel@tonic-gate * 15447c478bd9Sstevel@tonic-gate * 1.9 uint64_t dtps_getargval(void *arg, dtrace_id_t id, void *parg, 15457c478bd9Sstevel@tonic-gate * int argno, int aframes) 15467c478bd9Sstevel@tonic-gate * 15477c478bd9Sstevel@tonic-gate * 1.9.1 Overview 15487c478bd9Sstevel@tonic-gate * 15497c478bd9Sstevel@tonic-gate * Called to retrieve a value for an argX or args[X] variable. 15507c478bd9Sstevel@tonic-gate * 15517c478bd9Sstevel@tonic-gate * 1.9.2 Arguments and notes 15527c478bd9Sstevel@tonic-gate * 15537c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 15547c478bd9Sstevel@tonic-gate * second argument is the identifier of the current probe. The third 15557c478bd9Sstevel@tonic-gate * argument is the probe argument as passed to dtrace_probe_create(). The 15567c478bd9Sstevel@tonic-gate * fourth argument is the number of the argument (the X in the example in 15577c478bd9Sstevel@tonic-gate * 1.9.1). The fifth argument is the number of stack frames that were used 15587c478bd9Sstevel@tonic-gate * to get from the actual place in the code that fired the probe to 15597c478bd9Sstevel@tonic-gate * dtrace_probe() itself, the so-called artificial frames. This argument may 15607c478bd9Sstevel@tonic-gate * be used to descend an appropriate number of frames to find the correct 15617c478bd9Sstevel@tonic-gate * values. If this entry point is left NULL, the dtrace_getarg() built-in 15627c478bd9Sstevel@tonic-gate * function is used. 15637c478bd9Sstevel@tonic-gate * 15647c478bd9Sstevel@tonic-gate * 1.9.3 Return value 15657c478bd9Sstevel@tonic-gate * 15667c478bd9Sstevel@tonic-gate * The value of the argument. 15677c478bd9Sstevel@tonic-gate * 15687c478bd9Sstevel@tonic-gate * 1.9.4 Caller's context 15697c478bd9Sstevel@tonic-gate * 15707c478bd9Sstevel@tonic-gate * This is called from within dtrace_probe() meaning that interrupts 15717c478bd9Sstevel@tonic-gate * are disabled. No locks should be taken within this entry point. 15727c478bd9Sstevel@tonic-gate * 15737c478bd9Sstevel@tonic-gate * 1.10 int dtps_usermode(void *arg, dtrace_id_t id, void *parg) 15747c478bd9Sstevel@tonic-gate * 15757c478bd9Sstevel@tonic-gate * 1.10.1 Overview 15767c478bd9Sstevel@tonic-gate * 15777c478bd9Sstevel@tonic-gate * Called to determine if the probe was fired in a user context. 15787c478bd9Sstevel@tonic-gate * 15797c478bd9Sstevel@tonic-gate * 1.10.2 Arguments and notes 15807c478bd9Sstevel@tonic-gate * 15817c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 15827c478bd9Sstevel@tonic-gate * second argument is the identifier of the current probe. The third 15837c478bd9Sstevel@tonic-gate * argument is the probe argument as passed to dtrace_probe_create(). This 15847c478bd9Sstevel@tonic-gate * entry point must not be left NULL for providers whose probes allow for 15857c478bd9Sstevel@tonic-gate * mixed mode tracing, that is to say those probes that can fire during 15867c478bd9Sstevel@tonic-gate * kernel- _or_ user-mode execution 15877c478bd9Sstevel@tonic-gate * 15887c478bd9Sstevel@tonic-gate * 1.10.3 Return value 15897c478bd9Sstevel@tonic-gate * 15907c478bd9Sstevel@tonic-gate * A boolean value. 15917c478bd9Sstevel@tonic-gate * 15927c478bd9Sstevel@tonic-gate * 1.10.4 Caller's context 15937c478bd9Sstevel@tonic-gate * 15947c478bd9Sstevel@tonic-gate * This is called from within dtrace_probe() meaning that interrupts 15957c478bd9Sstevel@tonic-gate * are disabled. No locks should be taken within this entry point. 15967c478bd9Sstevel@tonic-gate * 15977c478bd9Sstevel@tonic-gate * 1.11 void dtps_destroy(void *arg, dtrace_id_t id, void *parg) 15987c478bd9Sstevel@tonic-gate * 15997c478bd9Sstevel@tonic-gate * 1.11.1 Overview 16007c478bd9Sstevel@tonic-gate * 16017c478bd9Sstevel@tonic-gate * Called to destroy the specified probe. 16027c478bd9Sstevel@tonic-gate * 16037c478bd9Sstevel@tonic-gate * 1.11.2 Arguments and notes 16047c478bd9Sstevel@tonic-gate * 16057c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_register(). The 16067c478bd9Sstevel@tonic-gate * second argument is the identifier of the probe to be destroyed. The third 16077c478bd9Sstevel@tonic-gate * argument is the probe argument as passed to dtrace_probe_create(). The 16087c478bd9Sstevel@tonic-gate * provider should free all state associated with the probe. The framework 16097c478bd9Sstevel@tonic-gate * guarantees that dtps_destroy() is only called for probes that have either 16107c478bd9Sstevel@tonic-gate * been disabled via dtps_disable() or were never enabled via dtps_enable(). 16117c478bd9Sstevel@tonic-gate * Once dtps_disable() has been called for a probe, no further call will be 16127c478bd9Sstevel@tonic-gate * made specifying the probe. 16137c478bd9Sstevel@tonic-gate * 16147c478bd9Sstevel@tonic-gate * 1.11.3 Return value 16157c478bd9Sstevel@tonic-gate * 16167c478bd9Sstevel@tonic-gate * None. 16177c478bd9Sstevel@tonic-gate * 16187c478bd9Sstevel@tonic-gate * 1.11.4 Caller's context 16197c478bd9Sstevel@tonic-gate * 16207c478bd9Sstevel@tonic-gate * The DTrace framework is locked in such a way that it may not be called 16217c478bd9Sstevel@tonic-gate * back into at all. mod_lock is held. cpu_lock is not held, and may not be 16227c478bd9Sstevel@tonic-gate * acquired. 16237c478bd9Sstevel@tonic-gate * 16247c478bd9Sstevel@tonic-gate * 16257c478bd9Sstevel@tonic-gate * 2 Provider-to-Framework API 16267c478bd9Sstevel@tonic-gate * 16277c478bd9Sstevel@tonic-gate * 2.1 Overview 16287c478bd9Sstevel@tonic-gate * 16297c478bd9Sstevel@tonic-gate * The Provider-to-Framework API provides the mechanism for the provider to 16307c478bd9Sstevel@tonic-gate * register itself with the DTrace framework, to create probes, to lookup 16317c478bd9Sstevel@tonic-gate * probes and (most importantly) to fire probes. The Provider-to-Framework 16327c478bd9Sstevel@tonic-gate * consists of: 16337c478bd9Sstevel@tonic-gate * 16347c478bd9Sstevel@tonic-gate * dtrace_register() <-- Register a provider with the DTrace framework 16357c478bd9Sstevel@tonic-gate * dtrace_unregister() <-- Remove a provider's DTrace registration 16367c478bd9Sstevel@tonic-gate * dtrace_invalidate() <-- Invalidate the specified provider 16377c478bd9Sstevel@tonic-gate * dtrace_condense() <-- Remove a provider's unenabled probes 16387c478bd9Sstevel@tonic-gate * dtrace_attached() <-- Indicates whether or not DTrace has attached 16397c478bd9Sstevel@tonic-gate * dtrace_probe_create() <-- Create a DTrace probe 16407c478bd9Sstevel@tonic-gate * dtrace_probe_lookup() <-- Lookup a DTrace probe based on its name 16417c478bd9Sstevel@tonic-gate * dtrace_probe_arg() <-- Return the probe argument for a specific probe 16427c478bd9Sstevel@tonic-gate * dtrace_probe() <-- Fire the specified probe 16437c478bd9Sstevel@tonic-gate * 16447c478bd9Sstevel@tonic-gate * 2.2 int dtrace_register(const char *name, const dtrace_pattr_t *pap, 1645ad4023c4Sdp * uint32_t priv, cred_t *cr, const dtrace_pops_t *pops, void *arg, 16467c478bd9Sstevel@tonic-gate * dtrace_provider_id_t *idp) 16477c478bd9Sstevel@tonic-gate * 16487c478bd9Sstevel@tonic-gate * 2.2.1 Overview 16497c478bd9Sstevel@tonic-gate * 16507c478bd9Sstevel@tonic-gate * dtrace_register() registers the calling provider with the DTrace 16517c478bd9Sstevel@tonic-gate * framework. It should generally be called by DTrace providers in their 16527c478bd9Sstevel@tonic-gate * attach(9E) entry point. 16537c478bd9Sstevel@tonic-gate * 16547c478bd9Sstevel@tonic-gate * 2.2.2 Arguments and Notes 16557c478bd9Sstevel@tonic-gate * 16567c478bd9Sstevel@tonic-gate * The first argument is the name of the provider. The second argument is a 16577c478bd9Sstevel@tonic-gate * pointer to the stability attributes for the provider. The third argument 16587c478bd9Sstevel@tonic-gate * is the privilege flags for the provider, and must be some combination of: 16597c478bd9Sstevel@tonic-gate * 16607c478bd9Sstevel@tonic-gate * DTRACE_PRIV_NONE <= All users may enable probes from this provider 16617c478bd9Sstevel@tonic-gate * 16627c478bd9Sstevel@tonic-gate * DTRACE_PRIV_PROC <= Any user with privilege of PRIV_DTRACE_PROC may 16637c478bd9Sstevel@tonic-gate * enable probes from this provider 16647c478bd9Sstevel@tonic-gate * 16657c478bd9Sstevel@tonic-gate * DTRACE_PRIV_USER <= Any user with privilege of PRIV_DTRACE_USER may 16667c478bd9Sstevel@tonic-gate * enable probes from this provider 16677c478bd9Sstevel@tonic-gate * 16687c478bd9Sstevel@tonic-gate * DTRACE_PRIV_KERNEL <= Any user with privilege of PRIV_DTRACE_KERNEL 16697c478bd9Sstevel@tonic-gate * may enable probes from this provider 16707c478bd9Sstevel@tonic-gate * 16717c478bd9Sstevel@tonic-gate * DTRACE_PRIV_OWNER <= This flag places an additional constraint on 16727c478bd9Sstevel@tonic-gate * the privilege requirements above. These probes 16737c478bd9Sstevel@tonic-gate * require either (a) a user ID matching the user 1674ad4023c4Sdp * ID of the cred passed in the fourth argument 1675ad4023c4Sdp * or (b) the PRIV_PROC_OWNER privilege. 1676ad4023c4Sdp * 1677ad4023c4Sdp * DTRACE_PRIV_ZONEOWNER<= This flag places an additional constraint on 1678ad4023c4Sdp * the privilege requirements above. These probes 1679ad4023c4Sdp * require either (a) a zone ID matching the zone 1680ad4023c4Sdp * ID of the cred passed in the fourth argument 1681ad4023c4Sdp * or (b) the PRIV_PROC_ZONE privilege. 16827c478bd9Sstevel@tonic-gate * 16837c478bd9Sstevel@tonic-gate * Note that these flags designate the _visibility_ of the probes, not 16847c478bd9Sstevel@tonic-gate * the conditions under which they may or may not fire. 16857c478bd9Sstevel@tonic-gate * 1686ad4023c4Sdp * The fourth argument is the credential that is associated with the 1687ad4023c4Sdp * provider. This argument should be NULL if the privilege flags don't 1688ad4023c4Sdp * include DTRACE_PRIV_OWNER or DTRACE_PRIV_ZONEOWNER. If non-NULL, the 1689ad4023c4Sdp * framework stashes the uid and zoneid represented by this credential 1690ad4023c4Sdp * for use at probe-time, in implicit predicates. These limit visibility 1691ad4023c4Sdp * of the probes to users and/or zones which have sufficient privilege to 1692ad4023c4Sdp * access them. 16937c478bd9Sstevel@tonic-gate * 16947c478bd9Sstevel@tonic-gate * The fifth argument is a DTrace provider operations vector, which provides 16957c478bd9Sstevel@tonic-gate * the implementation for the Framework-to-Provider API. (See Section 1, 16967c478bd9Sstevel@tonic-gate * above.) This must be non-NULL, and each member must be non-NULL. The 16977c478bd9Sstevel@tonic-gate * exceptions to this are (1) the dtps_provide() and dtps_provide_module() 16987c478bd9Sstevel@tonic-gate * members (if the provider so desires, _one_ of these members may be left 16997c478bd9Sstevel@tonic-gate * NULL -- denoting that the provider only implements the other) and (2) 17007c478bd9Sstevel@tonic-gate * the dtps_suspend() and dtps_resume() members, which must either both be 17017c478bd9Sstevel@tonic-gate * NULL or both be non-NULL. 17027c478bd9Sstevel@tonic-gate * 17037c478bd9Sstevel@tonic-gate * The sixth argument is a cookie to be specified as the first argument for 17047c478bd9Sstevel@tonic-gate * each function in the Framework-to-Provider API. This argument may have 17057c478bd9Sstevel@tonic-gate * any value. 17067c478bd9Sstevel@tonic-gate * 17077c478bd9Sstevel@tonic-gate * The final argument is a pointer to dtrace_provider_id_t. If 17087c478bd9Sstevel@tonic-gate * dtrace_register() successfully completes, the provider identifier will be 17097c478bd9Sstevel@tonic-gate * stored in the memory pointed to be this argument. This argument must be 17107c478bd9Sstevel@tonic-gate * non-NULL. 17117c478bd9Sstevel@tonic-gate * 17127c478bd9Sstevel@tonic-gate * 2.2.3 Return value 17137c478bd9Sstevel@tonic-gate * 17147c478bd9Sstevel@tonic-gate * On success, dtrace_register() returns 0 and stores the new provider's 17157c478bd9Sstevel@tonic-gate * identifier into the memory pointed to by the idp argument. On failure, 17167c478bd9Sstevel@tonic-gate * dtrace_register() returns an errno: 17177c478bd9Sstevel@tonic-gate * 17187c478bd9Sstevel@tonic-gate * EINVAL The arguments passed to dtrace_register() were somehow invalid. 17197c478bd9Sstevel@tonic-gate * This may because a parameter that must be non-NULL was NULL, 17207c478bd9Sstevel@tonic-gate * because the name was invalid (either empty or an illegal 17217c478bd9Sstevel@tonic-gate * provider name) or because the attributes were invalid. 17227c478bd9Sstevel@tonic-gate * 17237c478bd9Sstevel@tonic-gate * No other failure code is returned. 17247c478bd9Sstevel@tonic-gate * 17257c478bd9Sstevel@tonic-gate * 2.2.4 Caller's context 17267c478bd9Sstevel@tonic-gate * 17277c478bd9Sstevel@tonic-gate * dtrace_register() may induce calls to dtrace_provide(); the provider must 17287c478bd9Sstevel@tonic-gate * hold no locks across dtrace_register() that may also be acquired by 17297c478bd9Sstevel@tonic-gate * dtrace_provide(). cpu_lock and mod_lock must not be held. 17307c478bd9Sstevel@tonic-gate * 17317c478bd9Sstevel@tonic-gate * 2.3 int dtrace_unregister(dtrace_provider_t id) 17327c478bd9Sstevel@tonic-gate * 17337c478bd9Sstevel@tonic-gate * 2.3.1 Overview 17347c478bd9Sstevel@tonic-gate * 17357c478bd9Sstevel@tonic-gate * Unregisters the specified provider from the DTrace framework. It should 17367c478bd9Sstevel@tonic-gate * generally be called by DTrace providers in their detach(9E) entry point. 17377c478bd9Sstevel@tonic-gate * 17387c478bd9Sstevel@tonic-gate * 2.3.2 Arguments and Notes 17397c478bd9Sstevel@tonic-gate * 17407c478bd9Sstevel@tonic-gate * The only argument is the provider identifier, as returned from a 17417c478bd9Sstevel@tonic-gate * successful call to dtrace_register(). As a result of calling 17427c478bd9Sstevel@tonic-gate * dtrace_unregister(), the DTrace framework will call back into the provider 17437c478bd9Sstevel@tonic-gate * via the dtps_destroy() entry point. Once dtrace_unregister() successfully 17447c478bd9Sstevel@tonic-gate * completes, however, the DTrace framework will no longer make calls through 17457c478bd9Sstevel@tonic-gate * the Framework-to-Provider API. 17467c478bd9Sstevel@tonic-gate * 17477c478bd9Sstevel@tonic-gate * 2.3.3 Return value 17487c478bd9Sstevel@tonic-gate * 17497c478bd9Sstevel@tonic-gate * On success, dtrace_unregister returns 0. On failure, dtrace_unregister() 17507c478bd9Sstevel@tonic-gate * returns an errno: 17517c478bd9Sstevel@tonic-gate * 17527c478bd9Sstevel@tonic-gate * EBUSY There are currently processes that have the DTrace pseudodevice 17537c478bd9Sstevel@tonic-gate * open, or there exists an anonymous enabling that hasn't yet 17547c478bd9Sstevel@tonic-gate * been claimed. 17557c478bd9Sstevel@tonic-gate * 17567c478bd9Sstevel@tonic-gate * No other failure code is returned. 17577c478bd9Sstevel@tonic-gate * 17587c478bd9Sstevel@tonic-gate * 2.3.4 Caller's context 17597c478bd9Sstevel@tonic-gate * 17607c478bd9Sstevel@tonic-gate * Because a call to dtrace_unregister() may induce calls through the 17617c478bd9Sstevel@tonic-gate * Framework-to-Provider API, the caller may not hold any lock across 17627c478bd9Sstevel@tonic-gate * dtrace_register() that is also acquired in any of the Framework-to- 17637c478bd9Sstevel@tonic-gate * Provider API functions. Additionally, mod_lock may not be held. 17647c478bd9Sstevel@tonic-gate * 17657c478bd9Sstevel@tonic-gate * 2.4 void dtrace_invalidate(dtrace_provider_id_t id) 17667c478bd9Sstevel@tonic-gate * 17677c478bd9Sstevel@tonic-gate * 2.4.1 Overview 17687c478bd9Sstevel@tonic-gate * 17697c478bd9Sstevel@tonic-gate * Invalidates the specified provider. All subsequent probe lookups for the 17707c478bd9Sstevel@tonic-gate * specified provider will fail, but its probes will not be removed. 17717c478bd9Sstevel@tonic-gate * 17727c478bd9Sstevel@tonic-gate * 2.4.2 Arguments and note 17737c478bd9Sstevel@tonic-gate * 17747c478bd9Sstevel@tonic-gate * The only argument is the provider identifier, as returned from a 17757c478bd9Sstevel@tonic-gate * successful call to dtrace_register(). In general, a provider's probes 17767c478bd9Sstevel@tonic-gate * always remain valid; dtrace_invalidate() is a mechanism for invalidating 17777c478bd9Sstevel@tonic-gate * an entire provider, regardless of whether or not probes are enabled or 17787c478bd9Sstevel@tonic-gate * not. Note that dtrace_invalidate() will _not_ prevent already enabled 17797c478bd9Sstevel@tonic-gate * probes from firing -- it will merely prevent any new enablings of the 17807c478bd9Sstevel@tonic-gate * provider's probes. 17817c478bd9Sstevel@tonic-gate * 17827c478bd9Sstevel@tonic-gate * 2.5 int dtrace_condense(dtrace_provider_id_t id) 17837c478bd9Sstevel@tonic-gate * 17847c478bd9Sstevel@tonic-gate * 2.5.1 Overview 17857c478bd9Sstevel@tonic-gate * 17867c478bd9Sstevel@tonic-gate * Removes all the unenabled probes for the given provider. This function is 17877c478bd9Sstevel@tonic-gate * not unlike dtrace_unregister(), except that it doesn't remove the 17887c478bd9Sstevel@tonic-gate * provider just as many of its associated probes as it can. 17897c478bd9Sstevel@tonic-gate * 17907c478bd9Sstevel@tonic-gate * 2.5.2 Arguments and Notes 17917c478bd9Sstevel@tonic-gate * 17927c478bd9Sstevel@tonic-gate * As with dtrace_unregister(), the sole argument is the provider identifier 17937c478bd9Sstevel@tonic-gate * as returned from a successful call to dtrace_register(). As a result of 17947c478bd9Sstevel@tonic-gate * calling dtrace_condense(), the DTrace framework will call back into the 17957c478bd9Sstevel@tonic-gate * given provider's dtps_destroy() entry point for each of the provider's 17967c478bd9Sstevel@tonic-gate * unenabled probes. 17977c478bd9Sstevel@tonic-gate * 17987c478bd9Sstevel@tonic-gate * 2.5.3 Return value 17997c478bd9Sstevel@tonic-gate * 18007c478bd9Sstevel@tonic-gate * Currently, dtrace_condense() always returns 0. However, consumers of this 18017c478bd9Sstevel@tonic-gate * function should check the return value as appropriate; its behavior may 18027c478bd9Sstevel@tonic-gate * change in the future. 18037c478bd9Sstevel@tonic-gate * 18047c478bd9Sstevel@tonic-gate * 2.5.4 Caller's context 18057c478bd9Sstevel@tonic-gate * 18067c478bd9Sstevel@tonic-gate * As with dtrace_unregister(), the caller may not hold any lock across 18077c478bd9Sstevel@tonic-gate * dtrace_condense() that is also acquired in the provider's entry points. 18087c478bd9Sstevel@tonic-gate * Also, mod_lock may not be held. 18097c478bd9Sstevel@tonic-gate * 18107c478bd9Sstevel@tonic-gate * 2.6 int dtrace_attached() 18117c478bd9Sstevel@tonic-gate * 18127c478bd9Sstevel@tonic-gate * 2.6.1 Overview 18137c478bd9Sstevel@tonic-gate * 18147c478bd9Sstevel@tonic-gate * Indicates whether or not DTrace has attached. 18157c478bd9Sstevel@tonic-gate * 18167c478bd9Sstevel@tonic-gate * 2.6.2 Arguments and Notes 18177c478bd9Sstevel@tonic-gate * 18187c478bd9Sstevel@tonic-gate * For most providers, DTrace makes initial contact beyond registration. 18197c478bd9Sstevel@tonic-gate * That is, once a provider has registered with DTrace, it waits to hear 18207c478bd9Sstevel@tonic-gate * from DTrace to create probes. However, some providers may wish to 18217c478bd9Sstevel@tonic-gate * proactively create probes without first being told by DTrace to do so. 18227c478bd9Sstevel@tonic-gate * If providers wish to do this, they must first call dtrace_attached() to 18237c478bd9Sstevel@tonic-gate * determine if DTrace itself has attached. If dtrace_attached() returns 0, 18247c478bd9Sstevel@tonic-gate * the provider must not make any other Provider-to-Framework API call. 18257c478bd9Sstevel@tonic-gate * 18267c478bd9Sstevel@tonic-gate * 2.6.3 Return value 18277c478bd9Sstevel@tonic-gate * 18287c478bd9Sstevel@tonic-gate * dtrace_attached() returns 1 if DTrace has attached, 0 otherwise. 18297c478bd9Sstevel@tonic-gate * 18307c478bd9Sstevel@tonic-gate * 2.7 int dtrace_probe_create(dtrace_provider_t id, const char *mod, 18317c478bd9Sstevel@tonic-gate * const char *func, const char *name, int aframes, void *arg) 18327c478bd9Sstevel@tonic-gate * 18337c478bd9Sstevel@tonic-gate * 2.7.1 Overview 18347c478bd9Sstevel@tonic-gate * 18357c478bd9Sstevel@tonic-gate * Creates a probe with specified module name, function name, and name. 18367c478bd9Sstevel@tonic-gate * 18377c478bd9Sstevel@tonic-gate * 2.7.2 Arguments and Notes 18387c478bd9Sstevel@tonic-gate * 18397c478bd9Sstevel@tonic-gate * The first argument is the provider identifier, as returned from a 18407c478bd9Sstevel@tonic-gate * successful call to dtrace_register(). The second, third, and fourth 18417c478bd9Sstevel@tonic-gate * arguments are the module name, function name, and probe name, 18427c478bd9Sstevel@tonic-gate * respectively. Of these, module name and function name may both be NULL 18437c478bd9Sstevel@tonic-gate * (in which case the probe is considered to be unanchored), or they may both 18447c478bd9Sstevel@tonic-gate * be non-NULL. The name must be non-NULL, and must point to a non-empty 18457c478bd9Sstevel@tonic-gate * string. 18467c478bd9Sstevel@tonic-gate * 18477c478bd9Sstevel@tonic-gate * The fifth argument is the number of artificial stack frames that will be 18487c478bd9Sstevel@tonic-gate * found on the stack when dtrace_probe() is called for the new probe. These 18497c478bd9Sstevel@tonic-gate * artificial frames will be automatically be pruned should the stack() or 18507c478bd9Sstevel@tonic-gate * stackdepth() functions be called as part of one of the probe's ECBs. If 18517c478bd9Sstevel@tonic-gate * the parameter doesn't add an artificial frame, this parameter should be 18527c478bd9Sstevel@tonic-gate * zero. 18537c478bd9Sstevel@tonic-gate * 18547c478bd9Sstevel@tonic-gate * The final argument is a probe argument that will be passed back to the 18557c478bd9Sstevel@tonic-gate * provider when a probe-specific operation is called. (e.g., via 18567c478bd9Sstevel@tonic-gate * dtps_enable(), dtps_disable(), etc.) 18577c478bd9Sstevel@tonic-gate * 18587c478bd9Sstevel@tonic-gate * Note that it is up to the provider to be sure that the probe that it 18597c478bd9Sstevel@tonic-gate * creates does not already exist -- if the provider is unsure of the probe's 18607c478bd9Sstevel@tonic-gate * existence, it should assure its absence with dtrace_probe_lookup() before 18617c478bd9Sstevel@tonic-gate * calling dtrace_probe_create(). 18627c478bd9Sstevel@tonic-gate * 18637c478bd9Sstevel@tonic-gate * 2.7.3 Return value 18647c478bd9Sstevel@tonic-gate * 18657c478bd9Sstevel@tonic-gate * dtrace_probe_create() always succeeds, and always returns the identifier 18667c478bd9Sstevel@tonic-gate * of the newly-created probe. 18677c478bd9Sstevel@tonic-gate * 18687c478bd9Sstevel@tonic-gate * 2.7.4 Caller's context 18697c478bd9Sstevel@tonic-gate * 18707c478bd9Sstevel@tonic-gate * While dtrace_probe_create() is generally expected to be called from 18717c478bd9Sstevel@tonic-gate * dtps_provide() and/or dtps_provide_module(), it may be called from other 18727c478bd9Sstevel@tonic-gate * non-DTrace contexts. Neither cpu_lock nor mod_lock may be held. 18737c478bd9Sstevel@tonic-gate * 18747c478bd9Sstevel@tonic-gate * 2.8 dtrace_id_t dtrace_probe_lookup(dtrace_provider_t id, const char *mod, 18757c478bd9Sstevel@tonic-gate * const char *func, const char *name) 18767c478bd9Sstevel@tonic-gate * 18777c478bd9Sstevel@tonic-gate * 2.8.1 Overview 18787c478bd9Sstevel@tonic-gate * 18797c478bd9Sstevel@tonic-gate * Looks up a probe based on provdider and one or more of module name, 18807c478bd9Sstevel@tonic-gate * function name and probe name. 18817c478bd9Sstevel@tonic-gate * 18827c478bd9Sstevel@tonic-gate * 2.8.2 Arguments and Notes 18837c478bd9Sstevel@tonic-gate * 18847c478bd9Sstevel@tonic-gate * The first argument is the provider identifier, as returned from a 18857c478bd9Sstevel@tonic-gate * successful call to dtrace_register(). The second, third, and fourth 18867c478bd9Sstevel@tonic-gate * arguments are the module name, function name, and probe name, 18877c478bd9Sstevel@tonic-gate * respectively. Any of these may be NULL; dtrace_probe_lookup() will return 18887c478bd9Sstevel@tonic-gate * the identifier of the first probe that is provided by the specified 18897c478bd9Sstevel@tonic-gate * provider and matches all of the non-NULL matching criteria. 18907c478bd9Sstevel@tonic-gate * dtrace_probe_lookup() is generally used by a provider to be check the 18917c478bd9Sstevel@tonic-gate * existence of a probe before creating it with dtrace_probe_create(). 18927c478bd9Sstevel@tonic-gate * 18937c478bd9Sstevel@tonic-gate * 2.8.3 Return value 18947c478bd9Sstevel@tonic-gate * 18957c478bd9Sstevel@tonic-gate * If the probe exists, returns its identifier. If the probe does not exist, 18967c478bd9Sstevel@tonic-gate * return DTRACE_IDNONE. 18977c478bd9Sstevel@tonic-gate * 18987c478bd9Sstevel@tonic-gate * 2.8.4 Caller's context 18997c478bd9Sstevel@tonic-gate * 19007c478bd9Sstevel@tonic-gate * While dtrace_probe_lookup() is generally expected to be called from 19017c478bd9Sstevel@tonic-gate * dtps_provide() and/or dtps_provide_module(), it may also be called from 19027c478bd9Sstevel@tonic-gate * other non-DTrace contexts. Neither cpu_lock nor mod_lock may be held. 19037c478bd9Sstevel@tonic-gate * 19047c478bd9Sstevel@tonic-gate * 2.9 void *dtrace_probe_arg(dtrace_provider_t id, dtrace_id_t probe) 19057c478bd9Sstevel@tonic-gate * 19067c478bd9Sstevel@tonic-gate * 2.9.1 Overview 19077c478bd9Sstevel@tonic-gate * 19087c478bd9Sstevel@tonic-gate * Returns the probe argument associated with the specified probe. 19097c478bd9Sstevel@tonic-gate * 19107c478bd9Sstevel@tonic-gate * 2.9.2 Arguments and Notes 19117c478bd9Sstevel@tonic-gate * 19127c478bd9Sstevel@tonic-gate * The first argument is the provider identifier, as returned from a 19137c478bd9Sstevel@tonic-gate * successful call to dtrace_register(). The second argument is a probe 19147c478bd9Sstevel@tonic-gate * identifier, as returned from dtrace_probe_lookup() or 19157c478bd9Sstevel@tonic-gate * dtrace_probe_create(). This is useful if a probe has multiple 19167c478bd9Sstevel@tonic-gate * provider-specific components to it: the provider can create the probe 19177c478bd9Sstevel@tonic-gate * once with provider-specific state, and then add to the state by looking 19187c478bd9Sstevel@tonic-gate * up the probe based on probe identifier. 19197c478bd9Sstevel@tonic-gate * 19207c478bd9Sstevel@tonic-gate * 2.9.3 Return value 19217c478bd9Sstevel@tonic-gate * 19227c478bd9Sstevel@tonic-gate * Returns the argument associated with the specified probe. If the 19237c478bd9Sstevel@tonic-gate * specified probe does not exist, or if the specified probe is not provided 19247c478bd9Sstevel@tonic-gate * by the specified provider, NULL is returned. 19257c478bd9Sstevel@tonic-gate * 19267c478bd9Sstevel@tonic-gate * 2.9.4 Caller's context 19277c478bd9Sstevel@tonic-gate * 19287c478bd9Sstevel@tonic-gate * While dtrace_probe_arg() is generally expected to be called from 19297c478bd9Sstevel@tonic-gate * dtps_provide() and/or dtps_provide_module(), it may also be called from 19307c478bd9Sstevel@tonic-gate * other non-DTrace contexts. Neither cpu_lock nor mod_lock may be held. 19317c478bd9Sstevel@tonic-gate * 19327c478bd9Sstevel@tonic-gate * 2.10 void dtrace_probe(dtrace_id_t probe, uintptr_t arg0, uintptr_t arg1, 19337c478bd9Sstevel@tonic-gate * uintptr_t arg2, uintptr_t arg3, uintptr_t arg4) 19347c478bd9Sstevel@tonic-gate * 19357c478bd9Sstevel@tonic-gate * 2.10.1 Overview 19367c478bd9Sstevel@tonic-gate * 19377c478bd9Sstevel@tonic-gate * The epicenter of DTrace: fires the specified probes with the specified 19387c478bd9Sstevel@tonic-gate * arguments. 19397c478bd9Sstevel@tonic-gate * 19407c478bd9Sstevel@tonic-gate * 2.10.2 Arguments and Notes 19417c478bd9Sstevel@tonic-gate * 19427c478bd9Sstevel@tonic-gate * The first argument is a probe identifier as returned by 19437c478bd9Sstevel@tonic-gate * dtrace_probe_create() or dtrace_probe_lookup(). The second through sixth 19447c478bd9Sstevel@tonic-gate * arguments are the values to which the D variables "arg0" through "arg4" 19457c478bd9Sstevel@tonic-gate * will be mapped. 19467c478bd9Sstevel@tonic-gate * 19477c478bd9Sstevel@tonic-gate * dtrace_probe() should be called whenever the specified probe has fired -- 19487c478bd9Sstevel@tonic-gate * however the provider defines it. 19497c478bd9Sstevel@tonic-gate * 19507c478bd9Sstevel@tonic-gate * 2.10.3 Return value 19517c478bd9Sstevel@tonic-gate * 19527c478bd9Sstevel@tonic-gate * None. 19537c478bd9Sstevel@tonic-gate * 19547c478bd9Sstevel@tonic-gate * 2.10.4 Caller's context 19557c478bd9Sstevel@tonic-gate * 19567c478bd9Sstevel@tonic-gate * dtrace_probe() may be called in virtually any context: kernel, user, 19577c478bd9Sstevel@tonic-gate * interrupt, high-level interrupt, with arbitrary adaptive locks held, with 19587c478bd9Sstevel@tonic-gate * dispatcher locks held, with interrupts disabled, etc. The only latitude 19597c478bd9Sstevel@tonic-gate * that must be afforded to DTrace is the ability to make calls within 19607c478bd9Sstevel@tonic-gate * itself (and to its in-kernel subroutines) and the ability to access 19617c478bd9Sstevel@tonic-gate * arbitrary (but mapped) memory. On some platforms, this constrains 19627c478bd9Sstevel@tonic-gate * context. For example, on UltraSPARC, dtrace_probe() cannot be called 19637c478bd9Sstevel@tonic-gate * from any context in which TL is greater than zero. dtrace_probe() may 19647c478bd9Sstevel@tonic-gate * also not be called from any routine which may be called by dtrace_probe() 19657c478bd9Sstevel@tonic-gate * -- which includes functions in the DTrace framework and some in-kernel 19667c478bd9Sstevel@tonic-gate * DTrace subroutines. All such functions "dtrace_"; providers that 19677c478bd9Sstevel@tonic-gate * instrument the kernel arbitrarily should be sure to not instrument these 19687c478bd9Sstevel@tonic-gate * routines. 19697c478bd9Sstevel@tonic-gate */ 19707c478bd9Sstevel@tonic-gate typedef struct dtrace_pops { 19717c478bd9Sstevel@tonic-gate void (*dtps_provide)(void *arg, const dtrace_probedesc_t *spec); 19727c478bd9Sstevel@tonic-gate void (*dtps_provide_module)(void *arg, struct modctl *mp); 1973b9e93c10SJonathan Haslam int (*dtps_enable)(void *arg, dtrace_id_t id, void *parg); 19747c478bd9Sstevel@tonic-gate void (*dtps_disable)(void *arg, dtrace_id_t id, void *parg); 19757c478bd9Sstevel@tonic-gate void (*dtps_suspend)(void *arg, dtrace_id_t id, void *parg); 19767c478bd9Sstevel@tonic-gate void (*dtps_resume)(void *arg, dtrace_id_t id, void *parg); 19777c478bd9Sstevel@tonic-gate void (*dtps_getargdesc)(void *arg, dtrace_id_t id, void *parg, 19787c478bd9Sstevel@tonic-gate dtrace_argdesc_t *desc); 19797c478bd9Sstevel@tonic-gate uint64_t (*dtps_getargval)(void *arg, dtrace_id_t id, void *parg, 19807c478bd9Sstevel@tonic-gate int argno, int aframes); 19817c478bd9Sstevel@tonic-gate int (*dtps_usermode)(void *arg, dtrace_id_t id, void *parg); 19827c478bd9Sstevel@tonic-gate void (*dtps_destroy)(void *arg, dtrace_id_t id, void *parg); 19837c478bd9Sstevel@tonic-gate } dtrace_pops_t; 19847c478bd9Sstevel@tonic-gate 19857c478bd9Sstevel@tonic-gate typedef uintptr_t dtrace_provider_id_t; 19867c478bd9Sstevel@tonic-gate 19877c478bd9Sstevel@tonic-gate extern int dtrace_register(const char *, const dtrace_pattr_t *, uint32_t, 1988ad4023c4Sdp cred_t *, const dtrace_pops_t *, void *, dtrace_provider_id_t *); 19897c478bd9Sstevel@tonic-gate extern int dtrace_unregister(dtrace_provider_id_t); 19907c478bd9Sstevel@tonic-gate extern int dtrace_condense(dtrace_provider_id_t); 19917c478bd9Sstevel@tonic-gate extern void dtrace_invalidate(dtrace_provider_id_t); 19927c478bd9Sstevel@tonic-gate extern dtrace_id_t dtrace_probe_lookup(dtrace_provider_id_t, const char *, 19937c478bd9Sstevel@tonic-gate const char *, const char *); 19947c478bd9Sstevel@tonic-gate extern dtrace_id_t dtrace_probe_create(dtrace_provider_id_t, const char *, 19957c478bd9Sstevel@tonic-gate const char *, const char *, int, void *); 19967c478bd9Sstevel@tonic-gate extern void *dtrace_probe_arg(dtrace_provider_id_t, dtrace_id_t); 19977c478bd9Sstevel@tonic-gate extern void dtrace_probe(dtrace_id_t, uintptr_t arg0, uintptr_t arg1, 19987c478bd9Sstevel@tonic-gate uintptr_t arg2, uintptr_t arg3, uintptr_t arg4); 19997c478bd9Sstevel@tonic-gate 20007c478bd9Sstevel@tonic-gate /* 20017c478bd9Sstevel@tonic-gate * DTrace Meta Provider API 20027c478bd9Sstevel@tonic-gate * 20037c478bd9Sstevel@tonic-gate * The following functions are implemented by the DTrace framework and are 20047c478bd9Sstevel@tonic-gate * used to implement meta providers. Meta providers plug into the DTrace 20057c478bd9Sstevel@tonic-gate * framework and are used to instantiate new providers on the fly. At 20067c478bd9Sstevel@tonic-gate * present, there is only one type of meta provider and only one meta 20077c478bd9Sstevel@tonic-gate * provider may be registered with the DTrace framework at a time. The 20087c478bd9Sstevel@tonic-gate * sole meta provider type provides user-land static tracing facilities 20097c478bd9Sstevel@tonic-gate * by taking meta probe descriptions and adding a corresponding provider 20107c478bd9Sstevel@tonic-gate * into the DTrace framework. 20117c478bd9Sstevel@tonic-gate * 20127c478bd9Sstevel@tonic-gate * 1 Framework-to-Provider 20137c478bd9Sstevel@tonic-gate * 20147c478bd9Sstevel@tonic-gate * 1.1 Overview 20157c478bd9Sstevel@tonic-gate * 20167c478bd9Sstevel@tonic-gate * The Framework-to-Provider API is represented by the dtrace_mops structure 20177c478bd9Sstevel@tonic-gate * that the meta provider passes to the framework when registering itself as 20187c478bd9Sstevel@tonic-gate * a meta provider. This structure consists of the following members: 20197c478bd9Sstevel@tonic-gate * 20207c478bd9Sstevel@tonic-gate * dtms_create_probe() <-- Add a new probe to a created provider 20217c478bd9Sstevel@tonic-gate * dtms_provide_pid() <-- Create a new provider for a given process 20227c478bd9Sstevel@tonic-gate * dtms_remove_pid() <-- Remove a previously created provider 20237c478bd9Sstevel@tonic-gate * 20247c478bd9Sstevel@tonic-gate * 1.2 void dtms_create_probe(void *arg, void *parg, 20257c478bd9Sstevel@tonic-gate * dtrace_helper_probedesc_t *probedesc); 20267c478bd9Sstevel@tonic-gate * 20277c478bd9Sstevel@tonic-gate * 1.2.1 Overview 20287c478bd9Sstevel@tonic-gate * 20297c478bd9Sstevel@tonic-gate * Called by the DTrace framework to create a new probe in a provider 20307c478bd9Sstevel@tonic-gate * created by this meta provider. 20317c478bd9Sstevel@tonic-gate * 20327c478bd9Sstevel@tonic-gate * 1.2.2 Arguments and notes 20337c478bd9Sstevel@tonic-gate * 20347c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_meta_register(). 20357c478bd9Sstevel@tonic-gate * The second argument is the provider cookie for the associated provider; 20367c478bd9Sstevel@tonic-gate * this is obtained from the return value of dtms_provide_pid(). The third 20377c478bd9Sstevel@tonic-gate * argument is the helper probe description. 20387c478bd9Sstevel@tonic-gate * 20397c478bd9Sstevel@tonic-gate * 1.2.3 Return value 20407c478bd9Sstevel@tonic-gate * 20417c478bd9Sstevel@tonic-gate * None 20427c478bd9Sstevel@tonic-gate * 20437c478bd9Sstevel@tonic-gate * 1.2.4 Caller's context 20447c478bd9Sstevel@tonic-gate * 20457c478bd9Sstevel@tonic-gate * dtms_create_probe() is called from either ioctl() or module load context. 20467c478bd9Sstevel@tonic-gate * The DTrace framework is locked in such a way that meta providers may not 20477c478bd9Sstevel@tonic-gate * register or unregister. This means that the meta provider cannot call 20487c478bd9Sstevel@tonic-gate * dtrace_meta_register() or dtrace_meta_unregister(). However, the context is 20497c478bd9Sstevel@tonic-gate * such that the provider may (and is expected to) call provider-related 20507c478bd9Sstevel@tonic-gate * DTrace provider APIs including dtrace_probe_create(). 20517c478bd9Sstevel@tonic-gate * 20527c478bd9Sstevel@tonic-gate * 1.3 void *dtms_provide_pid(void *arg, dtrace_meta_provider_t *mprov, 20537c478bd9Sstevel@tonic-gate * pid_t pid) 20547c478bd9Sstevel@tonic-gate * 20557c478bd9Sstevel@tonic-gate * 1.3.1 Overview 20567c478bd9Sstevel@tonic-gate * 20577c478bd9Sstevel@tonic-gate * Called by the DTrace framework to instantiate a new provider given the 20587c478bd9Sstevel@tonic-gate * description of the provider and probes in the mprov argument. The 20597c478bd9Sstevel@tonic-gate * meta provider should call dtrace_register() to insert the new provider 20607c478bd9Sstevel@tonic-gate * into the DTrace framework. 20617c478bd9Sstevel@tonic-gate * 20627c478bd9Sstevel@tonic-gate * 1.3.2 Arguments and notes 20637c478bd9Sstevel@tonic-gate * 20647c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_meta_register(). 20657c478bd9Sstevel@tonic-gate * The second argument is a pointer to a structure describing the new 20667c478bd9Sstevel@tonic-gate * helper provider. The third argument is the process identifier for 20677c478bd9Sstevel@tonic-gate * process associated with this new provider. Note that the name of the 20687c478bd9Sstevel@tonic-gate * provider as passed to dtrace_register() should be the contatenation of 20697c478bd9Sstevel@tonic-gate * the dtmpb_provname member of the mprov argument and the processs 20707c478bd9Sstevel@tonic-gate * identifier as a string. 20717c478bd9Sstevel@tonic-gate * 20727c478bd9Sstevel@tonic-gate * 1.3.3 Return value 20737c478bd9Sstevel@tonic-gate * 20747c478bd9Sstevel@tonic-gate * The cookie for the provider that the meta provider creates. This is 20757c478bd9Sstevel@tonic-gate * the same value that it passed to dtrace_register(). 20767c478bd9Sstevel@tonic-gate * 20777c478bd9Sstevel@tonic-gate * 1.3.4 Caller's context 20787c478bd9Sstevel@tonic-gate * 20797c478bd9Sstevel@tonic-gate * dtms_provide_pid() is called from either ioctl() or module load context. 20807c478bd9Sstevel@tonic-gate * The DTrace framework is locked in such a way that meta providers may not 20817c478bd9Sstevel@tonic-gate * register or unregister. This means that the meta provider cannot call 20827c478bd9Sstevel@tonic-gate * dtrace_meta_register() or dtrace_meta_unregister(). However, the context 20837c478bd9Sstevel@tonic-gate * is such that the provider may -- and is expected to -- call 20847c478bd9Sstevel@tonic-gate * provider-related DTrace provider APIs including dtrace_register(). 20857c478bd9Sstevel@tonic-gate * 20867c478bd9Sstevel@tonic-gate * 1.4 void dtms_remove_pid(void *arg, dtrace_meta_provider_t *mprov, 20877c478bd9Sstevel@tonic-gate * pid_t pid) 20887c478bd9Sstevel@tonic-gate * 20897c478bd9Sstevel@tonic-gate * 1.4.1 Overview 20907c478bd9Sstevel@tonic-gate * 20917c478bd9Sstevel@tonic-gate * Called by the DTrace framework to remove a provider that had previously 20927c478bd9Sstevel@tonic-gate * been instantiated via the dtms_provide_pid() entry point. The meta 20937c478bd9Sstevel@tonic-gate * provider need not remove the provider immediately, but this entry 20947c478bd9Sstevel@tonic-gate * point indicates that the provider should be removed as soon as possible 20957c478bd9Sstevel@tonic-gate * using the dtrace_unregister() API. 20967c478bd9Sstevel@tonic-gate * 20977c478bd9Sstevel@tonic-gate * 1.4.2 Arguments and notes 20987c478bd9Sstevel@tonic-gate * 20997c478bd9Sstevel@tonic-gate * The first argument is the cookie as passed to dtrace_meta_register(). 21007c478bd9Sstevel@tonic-gate * The second argument is a pointer to a structure describing the helper 21017c478bd9Sstevel@tonic-gate * provider. The third argument is the process identifier for process 21027c478bd9Sstevel@tonic-gate * associated with this new provider. 21037c478bd9Sstevel@tonic-gate * 21047c478bd9Sstevel@tonic-gate * 1.4.3 Return value 21057c478bd9Sstevel@tonic-gate * 21067c478bd9Sstevel@tonic-gate * None 21077c478bd9Sstevel@tonic-gate * 21087c478bd9Sstevel@tonic-gate * 1.4.4 Caller's context 21097c478bd9Sstevel@tonic-gate * 21107c478bd9Sstevel@tonic-gate * dtms_remove_pid() is called from either ioctl() or exit() context. 21117c478bd9Sstevel@tonic-gate * The DTrace framework is locked in such a way that meta providers may not 21127c478bd9Sstevel@tonic-gate * register or unregister. This means that the meta provider cannot call 21137c478bd9Sstevel@tonic-gate * dtrace_meta_register() or dtrace_meta_unregister(). However, the context 21147c478bd9Sstevel@tonic-gate * is such that the provider may -- and is expected to -- call 21157c478bd9Sstevel@tonic-gate * provider-related DTrace provider APIs including dtrace_unregister(). 21167c478bd9Sstevel@tonic-gate */ 21177c478bd9Sstevel@tonic-gate typedef struct dtrace_helper_probedesc { 21187c478bd9Sstevel@tonic-gate char *dthpb_mod; /* probe module */ 21197c478bd9Sstevel@tonic-gate char *dthpb_func; /* probe function */ 21207c478bd9Sstevel@tonic-gate char *dthpb_name; /* probe name */ 21217c478bd9Sstevel@tonic-gate uint64_t dthpb_base; /* base address */ 21227c478bd9Sstevel@tonic-gate uint32_t *dthpb_offs; /* offsets array */ 2123ac448965Sahl uint32_t *dthpb_enoffs; /* is-enabled offsets array */ 21247c478bd9Sstevel@tonic-gate uint32_t dthpb_noffs; /* offsets count */ 2125ac448965Sahl uint32_t dthpb_nenoffs; /* is-enabled offsets count */ 21267c478bd9Sstevel@tonic-gate uint8_t *dthpb_args; /* argument mapping array */ 21277c478bd9Sstevel@tonic-gate uint8_t dthpb_xargc; /* translated argument count */ 21287c478bd9Sstevel@tonic-gate uint8_t dthpb_nargc; /* native argument count */ 21297c478bd9Sstevel@tonic-gate char *dthpb_xtypes; /* translated types strings */ 21307c478bd9Sstevel@tonic-gate char *dthpb_ntypes; /* native types strings */ 21317c478bd9Sstevel@tonic-gate } dtrace_helper_probedesc_t; 21327c478bd9Sstevel@tonic-gate 21337c478bd9Sstevel@tonic-gate typedef struct dtrace_helper_provdesc { 21347c478bd9Sstevel@tonic-gate char *dthpv_provname; /* provider name */ 21357c478bd9Sstevel@tonic-gate dtrace_pattr_t dthpv_pattr; /* stability attributes */ 21367c478bd9Sstevel@tonic-gate } dtrace_helper_provdesc_t; 21377c478bd9Sstevel@tonic-gate 21387c478bd9Sstevel@tonic-gate typedef struct dtrace_mops { 21397c478bd9Sstevel@tonic-gate void (*dtms_create_probe)(void *, void *, dtrace_helper_probedesc_t *); 21407c478bd9Sstevel@tonic-gate void *(*dtms_provide_pid)(void *, dtrace_helper_provdesc_t *, pid_t); 21417c478bd9Sstevel@tonic-gate void (*dtms_remove_pid)(void *, dtrace_helper_provdesc_t *, pid_t); 21427c478bd9Sstevel@tonic-gate } dtrace_mops_t; 21437c478bd9Sstevel@tonic-gate 21447c478bd9Sstevel@tonic-gate typedef uintptr_t dtrace_meta_provider_id_t; 21457c478bd9Sstevel@tonic-gate 21467c478bd9Sstevel@tonic-gate extern int dtrace_meta_register(const char *, const dtrace_mops_t *, void *, 21477c478bd9Sstevel@tonic-gate dtrace_meta_provider_id_t *); 21487c478bd9Sstevel@tonic-gate extern int dtrace_meta_unregister(dtrace_meta_provider_id_t); 21497c478bd9Sstevel@tonic-gate 21507c478bd9Sstevel@tonic-gate /* 21517c478bd9Sstevel@tonic-gate * DTrace Kernel Hooks 21527c478bd9Sstevel@tonic-gate * 21537c478bd9Sstevel@tonic-gate * The following functions are implemented by the base kernel and form a set of 21547c478bd9Sstevel@tonic-gate * hooks used by the DTrace framework. DTrace hooks are implemented in either 21557c478bd9Sstevel@tonic-gate * uts/common/os/dtrace_subr.c, an ISA-specific assembly file, or in a 21567c478bd9Sstevel@tonic-gate * uts/<platform>/os/dtrace_subr.c corresponding to each hardware platform. 21577c478bd9Sstevel@tonic-gate */ 21587c478bd9Sstevel@tonic-gate 21597c478bd9Sstevel@tonic-gate typedef enum dtrace_vtime_state { 21607c478bd9Sstevel@tonic-gate DTRACE_VTIME_INACTIVE = 0, /* No DTrace, no TNF */ 21617c478bd9Sstevel@tonic-gate DTRACE_VTIME_ACTIVE, /* DTrace virtual time, no TNF */ 21627c478bd9Sstevel@tonic-gate DTRACE_VTIME_INACTIVE_TNF, /* No DTrace, TNF active */ 21637c478bd9Sstevel@tonic-gate DTRACE_VTIME_ACTIVE_TNF /* DTrace virtual time _and_ TNF */ 21647c478bd9Sstevel@tonic-gate } dtrace_vtime_state_t; 21657c478bd9Sstevel@tonic-gate 21667c478bd9Sstevel@tonic-gate extern dtrace_vtime_state_t dtrace_vtime_active; 21677c478bd9Sstevel@tonic-gate extern void dtrace_vtime_switch(kthread_t *next); 21687c478bd9Sstevel@tonic-gate extern void dtrace_vtime_enable_tnf(void); 21697c478bd9Sstevel@tonic-gate extern void dtrace_vtime_disable_tnf(void); 21707c478bd9Sstevel@tonic-gate extern void dtrace_vtime_enable(void); 21717c478bd9Sstevel@tonic-gate extern void dtrace_vtime_disable(void); 21727c478bd9Sstevel@tonic-gate 21737c478bd9Sstevel@tonic-gate struct regs; 21747c478bd9Sstevel@tonic-gate 21757c478bd9Sstevel@tonic-gate extern int (*dtrace_pid_probe_ptr)(struct regs *); 21767c478bd9Sstevel@tonic-gate extern int (*dtrace_return_probe_ptr)(struct regs *); 21777c478bd9Sstevel@tonic-gate extern void (*dtrace_fasttrap_fork_ptr)(proc_t *, proc_t *); 21787c478bd9Sstevel@tonic-gate extern void (*dtrace_fasttrap_exec_ptr)(proc_t *); 21797c478bd9Sstevel@tonic-gate extern void (*dtrace_fasttrap_exit_ptr)(proc_t *); 21807c478bd9Sstevel@tonic-gate extern void dtrace_fasttrap_fork(proc_t *, proc_t *); 21817c478bd9Sstevel@tonic-gate 21827c478bd9Sstevel@tonic-gate typedef uintptr_t dtrace_icookie_t; 21837c478bd9Sstevel@tonic-gate typedef void (*dtrace_xcall_t)(void *); 21847c478bd9Sstevel@tonic-gate 21857c478bd9Sstevel@tonic-gate extern dtrace_icookie_t dtrace_interrupt_disable(void); 21867c478bd9Sstevel@tonic-gate extern void dtrace_interrupt_enable(dtrace_icookie_t); 21877c478bd9Sstevel@tonic-gate 21887c478bd9Sstevel@tonic-gate extern void dtrace_membar_producer(void); 21897c478bd9Sstevel@tonic-gate extern void dtrace_membar_consumer(void); 21907c478bd9Sstevel@tonic-gate 21917c478bd9Sstevel@tonic-gate extern void (*dtrace_cpu_init)(processorid_t); 21927c478bd9Sstevel@tonic-gate extern void (*dtrace_modload)(struct modctl *); 21937c478bd9Sstevel@tonic-gate extern void (*dtrace_modunload)(struct modctl *); 21947c478bd9Sstevel@tonic-gate extern void (*dtrace_helpers_cleanup)(); 21957c478bd9Sstevel@tonic-gate extern void (*dtrace_helpers_fork)(proc_t *parent, proc_t *child); 21967c478bd9Sstevel@tonic-gate extern void (*dtrace_cpustart_init)(); 21977c478bd9Sstevel@tonic-gate extern void (*dtrace_cpustart_fini)(); 21987c478bd9Sstevel@tonic-gate 21997c478bd9Sstevel@tonic-gate extern void (*dtrace_debugger_init)(); 22007c478bd9Sstevel@tonic-gate extern void (*dtrace_debugger_fini)(); 22017c478bd9Sstevel@tonic-gate extern dtrace_cacheid_t dtrace_predcache_id; 22027c478bd9Sstevel@tonic-gate 22037c478bd9Sstevel@tonic-gate extern hrtime_t dtrace_gethrtime(void); 22047c478bd9Sstevel@tonic-gate extern void dtrace_sync(void); 22057c478bd9Sstevel@tonic-gate extern void dtrace_toxic_ranges(void (*)(uintptr_t, uintptr_t)); 22067c478bd9Sstevel@tonic-gate extern void dtrace_xcall(processorid_t, dtrace_xcall_t, void *); 22077c478bd9Sstevel@tonic-gate extern void dtrace_vpanic(const char *, __va_list); 22087c478bd9Sstevel@tonic-gate extern void dtrace_panic(const char *, ...); 22097c478bd9Sstevel@tonic-gate 22107c478bd9Sstevel@tonic-gate extern int dtrace_safe_defer_signal(void); 22117c478bd9Sstevel@tonic-gate extern void dtrace_safe_synchronous_signal(void); 22127c478bd9Sstevel@tonic-gate 2213ae115bc7Smrj extern int dtrace_mach_aframes(void); 2214ae115bc7Smrj 22157c478bd9Sstevel@tonic-gate #if defined(__i386) || defined(__amd64) 22167c478bd9Sstevel@tonic-gate extern int dtrace_instr_size(uchar_t *instr); 22177c478bd9Sstevel@tonic-gate extern int dtrace_instr_size_isa(uchar_t *, model_t, int *); 22187c478bd9Sstevel@tonic-gate extern void dtrace_invop_add(int (*)(uintptr_t, uintptr_t *, uintptr_t)); 22197c478bd9Sstevel@tonic-gate extern void dtrace_invop_remove(int (*)(uintptr_t, uintptr_t *, uintptr_t)); 22207c478bd9Sstevel@tonic-gate extern void dtrace_invop_callsite(void); 22217c478bd9Sstevel@tonic-gate #endif 22227c478bd9Sstevel@tonic-gate 22237c478bd9Sstevel@tonic-gate #ifdef __sparc 22247c478bd9Sstevel@tonic-gate extern int dtrace_blksuword32(uintptr_t, uint32_t *, int); 22257c478bd9Sstevel@tonic-gate extern void dtrace_getfsr(uint64_t *); 22267c478bd9Sstevel@tonic-gate #endif 22277c478bd9Sstevel@tonic-gate 22287c478bd9Sstevel@tonic-gate #define DTRACE_CPUFLAG_ISSET(flag) \ 22297c478bd9Sstevel@tonic-gate (cpu_core[CPU->cpu_id].cpuc_dtrace_flags & (flag)) 22307c478bd9Sstevel@tonic-gate 22317c478bd9Sstevel@tonic-gate #define DTRACE_CPUFLAG_SET(flag) \ 22327c478bd9Sstevel@tonic-gate (cpu_core[CPU->cpu_id].cpuc_dtrace_flags |= (flag)) 22337c478bd9Sstevel@tonic-gate 22347c478bd9Sstevel@tonic-gate #define DTRACE_CPUFLAG_CLEAR(flag) \ 22357c478bd9Sstevel@tonic-gate (cpu_core[CPU->cpu_id].cpuc_dtrace_flags &= ~(flag)) 22367c478bd9Sstevel@tonic-gate 22377c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 22387c478bd9Sstevel@tonic-gate 22397c478bd9Sstevel@tonic-gate #endif /* _ASM */ 22407c478bd9Sstevel@tonic-gate 22417c478bd9Sstevel@tonic-gate #if defined(__i386) || defined(__amd64) 22427c478bd9Sstevel@tonic-gate 22437c478bd9Sstevel@tonic-gate #define DTRACE_INVOP_PUSHL_EBP 1 22447c478bd9Sstevel@tonic-gate #define DTRACE_INVOP_POPL_EBP 2 22457c478bd9Sstevel@tonic-gate #define DTRACE_INVOP_LEAVE 3 22467c478bd9Sstevel@tonic-gate #define DTRACE_INVOP_NOP 4 22477c478bd9Sstevel@tonic-gate #define DTRACE_INVOP_RET 5 22487c478bd9Sstevel@tonic-gate 22497c478bd9Sstevel@tonic-gate #endif 22507c478bd9Sstevel@tonic-gate 22517c478bd9Sstevel@tonic-gate #ifdef __cplusplus 22527c478bd9Sstevel@tonic-gate } 22537c478bd9Sstevel@tonic-gate #endif 22547c478bd9Sstevel@tonic-gate 22557c478bd9Sstevel@tonic-gate #endif /* _SYS_DTRACE_H */ 2256