14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * CDDL HEADER START
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The contents of this file are subject to the terms of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Common Development and Distribution License (the "License").
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * You may not use this file except in compliance with the License.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * See the License for the specific language governing permissions
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * and limitations under the License.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * When distributing Covered Code, include this CDDL HEADER in each
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * If applicable, add the following below this CDDL HEADER, with the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * fields enclosed by brackets "[]" replaced with your own identifying
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * information: Portions Copyright [yyyy] [name of copyright owner]
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * CDDL HEADER END
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Use is subject to license terms.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern "C" {
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Dynamic Tracing Software: Kernel Interfaces
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Note: The contents of this file are private to the implementation of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Solaris system and DTrace subsystem and are subject to change at any time
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * without notice. Applications and drivers using these interfaces will fail
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to run on future releases. These interfaces should not be used for any
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * purpose except those expressly outlined in dtrace(7D) and libdtrace(3LIB).
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Please refer to the "Solaris Dynamic Tracing Guide" for more information.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Universal Constants and Typedefs
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_IDNONE 0 /* invalid probe identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_EPIDNONE 0 /* invalid enabled probe identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_AGGIDNONE 0 /* invalid aggregation identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_AGGVARIDNONE 0 /* invalid aggregation variable ID */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CACHEIDNONE 0 /* invalid predicate cache */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_PROVNONE 0 /* invalid provider identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_METAPROVNONE 0 /* invalid meta-provider identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_ARGNONE -1 /* invalid argument index */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_FULLNAMELEN (DTRACE_PROVNAMELEN + DTRACE_MODNAMELEN + \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dtrace_id_t; /* probe identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dtrace_epid_t; /* enabled probe identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dtrace_aggid_t; /* aggregation identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef int64_t dtrace_aggvarid_t; /* aggregation variable identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint16_t dtrace_actkind_t; /* action kind */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dtrace_cacheid_t; /* predicate cache identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Intermediate Format (DIF)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The following definitions describe the DTrace Intermediate Format (DIF), a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * a RISC-like instruction set and program encoding used to represent
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * predicates and actions that can be bound to DTrace probes. The constants
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * below defining the number of available registers are suggested minimums; the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * compiler should use DTRACEIOC_CONF to dynamically obtain the number of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * registers provided by the current DTrace implementation.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VERSION_1 1 /* DIF version 1: Solaris 10 Beta */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VERSION_2 2 /* DIF version 2: Solaris 10 FCS */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VERSION DIF_VERSION_2 /* latest DIF instruction set version */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_DIR_NREGS 8 /* number of DIF integer registers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_DTR_NREGS 8 /* number of DIF tuple registers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INTOFF_MAX 0xffff /* highest integer table offset */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_STROFF_MAX 0xffff /* highest string table offset */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_REGISTER_MAX 0xff /* highest register number */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VARIABLE_MAX 0xffff /* highest variable identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_SUBROUTINE_MAX 0xffff /* highest subroutine code */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_ARRAY_MIN 0x0000 /* lowest numbered array variable */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_ARRAY_UBASE 0x0080 /* lowest user-defined array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_ARRAY_MAX 0x00ff /* highest numbered array variable */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_OTHER_MIN 0x0100 /* lowest numbered scalar or assc */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_OTHER_UBASE 0x0500 /* lowest user-defined scalar or assc */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_OTHER_MAX 0xffff /* highest numbered scalar or assc */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_UREGS 0x0002 /* user registers array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_CURTHREAD 0x0100 /* thread pointer */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_VTIMESTAMP 0x0102 /* virtual timestamp */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_IPL 0x0103 /* interrupt priority level */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_PROBEPROV 0x0112 /* probe provider */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_PROBEFUNC 0x0114 /* probe function */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_TID 0x0117 /* (per-process) thread ID */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_EXECNAME 0x0118 /* name of executable */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_ZONENAME 0x0119 /* zone name associated with process */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_WALLTIMESTAMP 0x011a /* wall-clock timestamp */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_USTACKDEPTH 0x011b /* user-land stack depth */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_VAR_UCALLER 0x011c /* user-level caller */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_NOT(r1, d) (DIF_INSTR_FMT(DIF_OP_NOT, r1, 0, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_MOV(r1, d) (DIF_INSTR_FMT(DIF_OP_MOV, r1, 0, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_CMP(op, r1, r2) (DIF_INSTR_FMT(op, r1, r2, 0))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_TST(r1) (DIF_INSTR_FMT(DIF_OP_TST, r1, 0, 0))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_BRANCH(op, label) (((op) << 24) | (label))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_LOAD(op, r1, d) (DIF_INSTR_FMT(op, r1, 0, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_STORE(op, r1, d) (DIF_INSTR_FMT(op, r1, 0, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_SETX(i, d) ((DIF_OP_SETX << 24) | ((i) << 8) | (d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_SETS(s, d) ((DIF_OP_SETS << 24) | ((s) << 8) | (d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_RET(d) (DIF_INSTR_FMT(DIF_OP_RET, 0, 0, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_LDA(op, v, r, d) (DIF_INSTR_FMT(op, v, r, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_LDV(op, v, d) (((op) << 24) | ((v) << 8) | (d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_STV(op, v, rs) (((op) << 24) | ((v) << 8) | (rs))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_CALL(s, d) ((DIF_OP_CALL << 24) | ((s) << 8) | (d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_PUSHTS(op, t, r2, rs) (DIF_INSTR_FMT(op, t, r2, rs))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_ALLOCS(r1, d) (DIF_INSTR_FMT(DIF_OP_ALLOCS, r1, 0, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_COPYS(r1, r2, d) (DIF_INSTR_FMT(DIF_OP_COPYS, r1, r2, d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_INSTR_XLATE(op, r, d) (((op) << 24) | ((r) << 8) | (d))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_REG_R0 0 /* %r0 is always set to zero */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * A DTrace Intermediate Format Type (DIF Type) is used to represent the types
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of variables, function and associative array arguments, and the return type
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * for each DIF object (shown below). It contains a description of the type,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * its size in bytes, and a module identifier.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dtdt_size; /* type size in bytes (unless string) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIF_TF_BYREF 0x1 /* type is passed by reference */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * A DTrace Intermediate Format variable record is used to describe each of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * variables referenced by a given DIF object. It contains an integer variable
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * identifier along with variable scope and properties, as shown below. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * size of this structure must be sizeof (int) aligned.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dtdv_name; /* variable name index in dtdo_strtab */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dtdv_id; /* variable reference identifier */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint8_t dtdv_scope; /* variable scope (see below) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint16_t dtdv_flags; /* variable flags (see below) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_diftype_t dtdv_type; /* variable type (see above) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_KIND_ARRAY 0 /* variable is an array of quantities */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_KIND_SCALAR 1 /* variable is a scalar quantity */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_SCOPE_GLOBAL 0 /* variable has global scope */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_SCOPE_THREAD 1 /* variable has thread scope */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_SCOPE_LOCAL 2 /* variable has local scope */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_F_REF 0x1 /* variable is referenced by DIFO */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DIFV_F_MOD 0x2 /* variable is written by DIFO */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Actions
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The upper byte determines the class of the action; the low bytes determines
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the specific action within that class. The classes of actions are as
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * [ no class ] <= May record process- or kernel-related data
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEACT_PROC <= Only records process-related data
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEACT_PROC_DESTRUCTIVE <= Potentially destructive to processes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEACT_KERNEL <= Only records kernel-related data
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEACT_KERNEL_DESTRUCTIVE <= Potentially destructive to the kernel
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEACT_SPECULATIVE <= Speculation-related action
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEACT_AGGREGATION <= Aggregating action
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_DIFEXPR 1 /* action is DIF expression */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_LIBACT 5 /* library-controlled action */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_STOP (DTRACEACT_PROC_DESTRUCTIVE + 1)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_RAISE (DTRACEACT_PROC_DESTRUCTIVE + 2)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_SYSTEM (DTRACEACT_PROC_DESTRUCTIVE + 3)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_FREOPEN (DTRACEACT_PROC_DESTRUCTIVE + 4)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_BREAKPOINT (DTRACEACT_KERNEL_DESTRUCTIVE + 1)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_PANIC (DTRACEACT_KERNEL_DESTRUCTIVE + 2)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_CHILL (DTRACEACT_KERNEL_DESTRUCTIVE + 3)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_SPECULATE (DTRACEACT_SPECULATIVE + 1)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_COMMIT (DTRACEACT_SPECULATIVE + 2)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEACT_DISCARD (DTRACEACT_SPECULATIVE + 3)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (DTRACEACT_CLASS(x) == DTRACEACT_PROC_DESTRUCTIVE || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync DTRACEACT_CLASS(x) == DTRACEACT_KERNEL_DESTRUCTIVE)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DTRACEACT_PRINTF || (x) == DTRACEACT_PRINTA || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (x) == DTRACEACT_SYSTEM || (x) == DTRACEACT_FREOPEN)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Aggregating Actions
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * These are functions f(x) for which the following is true:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * f(f(x_0) U f(x_1) U ... U f(x_n)) = f(x_0 U x_1 U ... U x_n)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * where x_n is a set of arbitrary data. Aggregating actions are in their own
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace action class, DTTRACEACT_AGGREGATION. The macros provided here allow
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * for easier processing of the aggregation argument and data payload for a few
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * aggregating actions (notably: quantize(), lquantize(), and ustack()).
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEAGG_STDDEV (DTRACEACT_AGGREGATION + 6)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEAGG_QUANTIZE (DTRACEACT_AGGREGATION + 7)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEAGG_LQUANTIZE (DTRACEACT_AGGREGATION + 8)
49b97135c86693da9b34e628ff4c5d8809768f4bvboxsync#define DTRACE_QUANTIZE_ZEROBUCKET (VBDTCAST(int)(sizeof (uint64_t) * NBBY) - 1)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync -(1LL << (DTRACE_QUANTIZE_ZEROBUCKET - 1 - (buck))) : \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_LQUANTIZE_STEPMASK ((uint64_t)UINT16_MAX << 48)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_LQUANTIZE_LEVELMASK ((uint64_t)UINT16_MAX << 32)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_USTACK_NFRAMES(x) (uint32_t)((x) & UINT32_MAX)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_USTACK_STRSIZE(x) (uint32_t)((x) >> 32)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_PTR(type, name) uint32_t name##pad; type *name
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_PTR(type, name) type *name; uint32_t name##pad
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Object Format (DOF)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace programs can be persistently encoded in the DOF format so that they
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * may be embedded in other programs (for example, in an ELF file) or in the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace driver configuration file for use in anonymous tracing. The DOF
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * format is versioned and extensible so that it can be revised and so that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * internal data structures can be modified or extended compatibly. All DOF
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structures use fixed-size types, so the 32-bit and 64-bit representations
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * are identical and consumers can use either data model transparently.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The file layout is structured as follows:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * +---------------+-------------------+----- ... ----+---- ... ------+
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * | dof_hdr_t | dof_sec_t[ ... ] | loadable | non-loadable |
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * | (file header) | (section headers) | section data | section data |
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * +---------------+-------------------+----- ... ----+---- ... ------+
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * |<------------ dof_hdr.dofh_loadsz --------------->| |
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * |<------------ dof_hdr.dofh_filesz ------------------------------->|
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The file header stores meta-data including a magic number, data model for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the instrumentation, data encoding, and properties of the DIF code within.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The header describes its own size and the size of the section headers. By
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * convention, an array of section headers follows the file header, and then
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the data for all loadable sections and unloadable sections. This permits
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * consumer code to easily download the headers and all loadable data into the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace driver in one contiguous chunk, omitting other extraneous sections.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The section headers describe the size, offset, alignment, and section type
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * for each section. Sections are described using a set of #defines that tell
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the consumer what kind of data is expected. Sections can contain links to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * other sections by storing a dof_secidx_t, an index into the section header
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * array, inside of the section data structures. The section header includes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * an entry size so that sections with data arrays can grow their structures.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DOF data itself can contain many snippets of DIF (i.e. >1 DIFOs), which
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * are represented themselves as a collection of related DOF sections. This
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * permits us to change the set of sections associated with a DIFO over time,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * and also permits us to encode DIFOs that contain different sets of sections.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * When a DOF section wants to refer to a DIFO, it stores the dof_secidx_t of a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * section of type DOF_SECT_DIFOHDR. This section's data is then an array of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dof_secidx_t's which in turn denote the sections associated with this DIFO.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * This loose coupling of the file structure (header and sections) to the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structure of the DTrace program itself (ECB descriptions, action
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * descriptions, and DIFOs) permits activities such as relocation processing
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to occur in a single pass without having to understand D program structure.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Finally, strings are always stored in ELF-style string tables along with a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * string table section index and string table offset. Therefore strings in
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DOF are always arbitrary-length and not bound to the current implementation.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_SIZE 16 /* total size of dofh_ident[] in bytes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint8_t dofh_ident[DOF_ID_SIZE]; /* identification bytes (see below) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofh_flags; /* file attribute flags (if any) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofh_hdrsize; /* size of file header in bytes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofh_secsize; /* size of section header in bytes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofh_secnum; /* number of section headers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofh_secoff; /* file offset of section headers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofh_loadsz; /* file size of loadable portion */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofh_filesz; /* file size of entire DOF file */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_MAG0 0 /* first byte of magic number */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_MAG1 1 /* second byte of magic number */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_MAG2 2 /* third byte of magic number */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_MAG3 3 /* fourth byte of magic number */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_MODEL 4 /* DOF data model (see below) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_ENCODING 5 /* DOF data encoding (see below) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_VERSION 6 /* DOF file format major version (see below) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_DIFVERS 7 /* DIF instruction set version */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_DIFIREG 8 /* DIF integer registers used by compiler */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_DIFTREG 9 /* DIF tuple registers used by compiler */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ID_PAD 10 /* start of padding bytes (all zeroes) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_VERSION_1 1 /* DOF version 1: Solaris 10 FCS */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_VERSION_2 2 /* DOF version 2: Solaris Express 6/06 */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_VERSION DOF_VERSION_2 /* Latest DOF version */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_FL_VALID 0 /* mask of all valid dofh_flags bits */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dof_secidx_t; /* section header table index type */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dof_stridx_t; /* string table index type */
662add0e7ef75c9c2131b38a6b9fe354d2b15266vboxsync#define DOF_SECIDX_NONE (~1U) /* null value for section indices */
662add0e7ef75c9c2131b38a6b9fe354d2b15266vboxsync#define DOF_STRIDX_NONE (~1U) /* null value for string indices */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofs_align; /* section data memory alignment */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofs_entsize; /* size of section entry (if table) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofs_offset; /* offset of section data within file */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofs_size; /* size of section data in bytes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_SOURCE 2 /* D program source code */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_ACTDESC 5 /* dof_actdesc_t array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_DIFOHDR 6 /* dof_difohdr_t (variable length) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_DIF 7 /* uint32_t array of byte code */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_RELTAB 10 /* dof_relodesc_t array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_TYPTAB 11 /* dtrace_diftype_t array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_URELHDR 12 /* dof_relohdr_t (user relocations) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_KRELHDR 13 /* dof_relohdr_t (kernel relocations) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_OPTDESC 14 /* dof_optdesc_t array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_PRARGS 17 /* uint8_t array (probe arg mappings) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_PROFFS 18 /* uint32_t array (probe arg offsets) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_XLMEMBERS 22 /* dof_xlmember_t array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_PREXPORT 25 /* dof_secidx_t array (exported objs) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECT_PRENOFFS 26 /* uint32_t array (enabled offsets) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_SECF_LOAD 1 /* section should be loaded */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (((x) == DOF_SECT_ECBDESC) || ((x) == DOF_SECT_PROBEDESC) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_ACTDESC) || ((x) == DOF_SECT_DIFOHDR) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_DIF) || ((x) == DOF_SECT_STRTAB) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_VARTAB) || ((x) == DOF_SECT_RELTAB) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_TYPTAB) || ((x) == DOF_SECT_URELHDR) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_KRELHDR) || ((x) == DOF_SECT_OPTDESC) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_PROVIDER) || ((x) == DOF_SECT_PROBES) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_PRARGS) || ((x) == DOF_SECT_PROFFS) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_INTTAB) || ((x) == DOF_SECT_XLTAB) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_XLMEMBERS) || ((x) == DOF_SECT_XLIMPORT) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_XLIMPORT) || ((x) == DOF_SECT_XLEXPORT) || \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync ((x) == DOF_SECT_PREXPORT) || ((x) == DOF_SECT_PRENOFFS))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofe_probes; /* link to DOF_SECT_PROBEDESC */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofe_pred; /* link to DOF_SECT_DIFOHDR */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofe_actions; /* link to DOF_SECT_ACTDESC */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofe_uarg; /* user-supplied library argument */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofp_strtab; /* link to DOF_SECT_STRTAB section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofa_difo; /* link to DOF_SECT_DIFOHDR */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofa_strtab; /* link to DOF_SECT_STRTAB section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofa_kind; /* action kind (DTRACEACT_* constant) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofa_ntuple; /* number of subsequent tuple actions */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_diftype_t dofd_rtype; /* return type for this fragment */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofd_links[1]; /* variable length array of indices */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofr_strtab; /* link to DOF_SECT_STRTAB for names */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofr_relsec; /* link to DOF_SECT_RELTAB for relos */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofr_tgtsec; /* link to section we are relocating */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofr_name; /* string name of relocation symbol */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofr_type; /* relo type (DOF_RELO_* constant) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofr_offset; /* byte offset for relocation */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofr_data; /* additional type-specific data */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_RELO_NONE 0 /* empty relocation entry */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofo_strtab; /* string table, if string option */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofo_value; /* option value or string index */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint32_t dof_attr_t; /* encoded stability attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DOF_ATTR(n, d, c) (((n) << 24) | ((d) << 16) | ((c) << 8))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofpv_strtab; /* link to DOF_SECT_STRTAB section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofpv_probes; /* link to DOF_SECT_PROBES section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofpv_prargs; /* link to DOF_SECT_PRARGS section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofpv_proffs; /* link to DOF_SECT_PROFFS section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofpv_name; /* provider name string */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_attr_t dofpv_provattr; /* provider attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_attr_t dofpv_funcattr; /* function attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofpv_prenoffs; /* link to DOF_SECT_PRENOFFS section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dofpr_addr; /* probe base address or offset */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofpr_func; /* probe function string */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofpr_nargv; /* native argument type strings */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofpr_xargv; /* translated argument type strings */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofpr_argidx; /* index of first argument mapping */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofpr_offidx; /* index of first offset entry */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint8_t dofpr_xargc; /* translated argument count */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint16_t dofpr_noffs; /* number of offset entries for probe */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofpr_enoffidx; /* index of first is-enabled offset */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint16_t dofpr_nenoffs; /* number of is-enabled offsets */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofxl_members; /* link to DOF_SECT_XLMEMBERS section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofxl_strtab; /* link to DOF_SECT_STRTAB section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofxl_argv; /* input parameter type strings */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofxl_argc; /* input parameter list length */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_stridx_t dofxl_type; /* output type string name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_attr_t dofxl_attr; /* output stability attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofxm_difo; /* member link to DOF_SECT_DIFOHDR */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_secidx_t dofxr_xlator; /* link to DOF_SECT_XLATORS section */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofxr_member; /* index of referenced dof_xlmember */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dofxr_argn; /* index of argument for DIF_OP_XLARG */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Intermediate Format Object (DIFO)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * A DIFO is used to store the compiled DIF for a D expression, its return
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * type, and its string and variable tables. The string table is a single
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * buffer of character data into which sets instructions and variable
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * references can reference strings using a byte offset. The variable table
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * is an array of dtrace_difv_t structures that describe the name and type of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * each variable and the id used in the DIF code. This structure is described
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * above in the DIF section of this header file. The DIFO is used at both
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * user-level (in the library) and in the kernel, but the structure is never
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * passed between the two: the DOF structures form the only interface. As a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * result, the definition can change depending on the presence of _KERNEL.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t *dtdo_inttab; /* integer table (optional) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_difv_t *dtdo_vartab; /* variable table (optional) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint_t dtdo_len; /* length of instruction buffer */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint_t dtdo_destructive; /* invokes destructive subroutines */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_relodesc_t *dtdo_kreltab; /* kernel relocations */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dof_relodesc_t *dtdo_ureltab; /* user relocations */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync struct dt_node **dtdo_xlmtab; /* translator references */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint_t dtdo_xlmlen; /* length of translator table */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Enabling Description Structures
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * When DTrace is tracking the description of a DTrace enabling entity (probe,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * predicate, action, ECB, record, etc.), it does so in a description
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structure. These structures all end in "desc", and are used at both
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * user-level and in the kernel -- but (with the exception of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probedesc_t) they are never passed between them. Typically,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * user-level will use the description structures when assembling an enabling.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * It will then distill those description structures into a DOF object (see
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * above), and send it into the kernel. The kernel will again use the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * description structures to create a description of the enabling as it reads
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the DOF. When the description is complete, the enabling will be actually
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * created -- turning it into the structures that represent the enabling
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * instead of merely describing it. Not surprisingly, the description
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structures bear a strong resemblance to the DOF structures that act as their
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dtpd_provider[DTRACE_PROVNAMELEN]; /* probe provider name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dtpd_mod[DTRACE_MODNAMELEN]; /* probe module name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dtpd_func[DTRACE_FUNCNAMELEN]; /* probe function name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_probedesc_t dtrpd_match; /* probe descr. to match */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_probedesc_t dtrpd_create; /* probe descr. to create */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_difo_t *dtpdd_difo; /* pointer to DIF object */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync struct dtrace_predicate *dtpdd_predicate; /* pointer to predicate */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_difo_t *dtad_difo; /* pointer to DIF object */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync struct dtrace_actdesc *dtad_next; /* next action */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_actdesc_t *dted_action; /* action description(s) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_preddesc_t dted_pred; /* predicate description */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_probedesc_t dted_probe; /* probe description */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Metadata Description Structures
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace separates the trace data stream from the metadata stream. The only
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * metadata tokens placed in the data stream are enabled probe identifiers
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * (EPIDs) or (in the case of aggregations) aggregation identifiers. In order
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to determine the structure of the data, DTrace consumers pass the token to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the kernel, and receive in return a corresponding description of the enabled
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * probe (via the dtrace_eprobedesc structure) or the aggregation (via the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_aggdesc structure). Both of these structures are expressed in terms
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of record descriptions (via the dtrace_recdesc structure) that describe the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * exact structure of the data. Some record descriptions may also contain a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * format identifier; this additional bit of metadata can be retrieved from the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * kernel, for which a format description is returned via the dtrace_fmtdesc
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structure. Note that all four of these structures must be bitness-neutral
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to allow for a 32-bit DTrace consumer on a 64-bit kernel.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_recdesc_t dtepd_rec[1]; /* records themselves */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync DTRACE_PTR(char, dtagd_name); /* not filled in by kernel */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_aggvarid_t dtagd_varid; /* not filled in by kernel */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_recdesc_t dtagd_rec[1]; /* record descriptions */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (sizeof (dtrace_eprobedesc_t) + ((desc)->dtepd_nrecs ? \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (((desc)->dtepd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (sizeof (dtrace_aggdesc_t) + ((desc)->dtagd_nrecs ? \
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync (((desc)->dtagd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Option Interface
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Run-time DTrace options are set and retrieved via DOF_SECT_OPTDESC sections
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * in a DOF image. The dof_optdesc structure contains an option identifier and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * an option value. The valid option identifiers are found below; the mapping
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * between option identifiers and option identifying strings is maintained at
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * user-level. Note that the value of DTRACEOPT_UNSET is such that all of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * following are potentially valid option values: all positive integers, zero
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * and negative one. Some options (notably "bufpolicy" and "bufresize") take
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * predefined tokens as their values; these are defined with
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACEOPT_{option}_{token}.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_DYNVARSIZE 2 /* dynamic variable size */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_NSPEC 5 /* number of speculations */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_CLEANRATE 7 /* dynvar cleaning rate */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_BUFRESIZE 9 /* buffer resizing policy */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_GRABANON 10 /* grab anonymous state, if any */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_FLOWINDENT 11 /* indent function entry/return */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_QUIET 12 /* only output explicitly traced data */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_STACKFRAMES 13 /* number of stack frames */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_USTACKFRAMES 14 /* number of user stack frames */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_AGGRATE 15 /* aggregation snapshot rate */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_SWITCHRATE 16 /* buffer switching rate */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_DESTRUCTIVE 18 /* destructive actions allowed */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_STACKINDENT 19 /* output indent for stack traces */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_RAWBYTES 20 /* always print bytes in raw form */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_JSTACKFRAMES 21 /* number of jstack() frames */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_JSTACKSTRSIZE 22 /* size of jstack() string table */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_AGGSORTKEY 23 /* sort aggregations by key */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_AGGSORTREV 24 /* reverse-sort aggregations */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_AGGSORTPOS 25 /* agg. position to sort on */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_AGGSORTKEYPOS 26 /* agg. key position to sort on */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_UNSET (dtrace_optval_t)-2 /* unset option */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_BUFPOLICY_RING 0 /* ring buffer */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_BUFPOLICY_FILL 1 /* fill buffer, then stop */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_BUFPOLICY_SWITCH 2 /* switch buffers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_BUFRESIZE_AUTO 0 /* automatic resizing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEOPT_BUFRESIZE_MANUAL 1 /* manual resizing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Buffer Interface
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * In order to get a snapshot of the principal or aggregation buffer,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * user-level passes a buffer description to the kernel with the dtrace_bufdesc
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structure. This describes which CPU user-level is interested in, and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * where user-level wishes the kernel to snapshot the buffer to (the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtbd_data field). The kernel uses the same structure to pass back some
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * information regarding the buffer: the size of data actually copied out, the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * number of drops, the number of errors, and the offset of the oldest record.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * If the buffer policy is a "switch" policy, taking a snapshot of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * principal buffer has the additional effect of switching the active and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * inactive buffers. Taking a snapshot of the aggregation buffer _always_ has
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the additional effect of switching the active and inactive buffers.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtbd_oldest; /* offset of oldest record */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Status
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The status of DTrace is relayed via the dtrace_status structure. This
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structure contains members to count drops other than the capacity drops
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * available via the buffer interface (see above). This consists of dynamic
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * drops (including capacity dynamic drops, rinsing drops and dirty drops), and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * speculative drops (including capacity speculative drops, drops due to busy
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * speculative buffers and drops due to unavailable speculative buffers).
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Additionally, the status structure contains a field to indicate the number
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of "fill"-policy buffers have been filled and a boolean field to indicate
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that exit() has been called. If the dtst_exiting field is non-zero, no
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * further data will be generated until tracing is stopped (at which time any
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * enablings of the END action will be processed); if user-level sees that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * this field is non-zero, tracing should be stopped as soon as possible.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtst_dyndrops_rinsing; /* dyn drops due to rinsing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtst_dyndrops_dirty; /* dyn drops due to dirty */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtst_specdrops_busy; /* spec drops due to busy */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtst_specdrops_unavail; /* spec drops due to unavail */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtst_stkstroverflows; /* stack string tab overflows */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t dtst_dblerrors; /* errors in ERROR probes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Configuration
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * User-level may need to understand some elements of the kernel DTrace
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * configuration in order to generate correct DIF. This information is
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * conveyed via the dtrace_conf structure.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint_t dtc_difintregs; /* # of DIF integer registers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint_t dtc_diftupregs; /* # of DIF tuple registers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Faults
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The constants below DTRACEFLT_LIBRARY indicate probe processing faults;
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * constants at or above DTRACEFLT_LIBRARY indicate faults in probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * postprocessing at user-level. Probe processing faults induce an ERROR
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * probe and are replicated in unistd.d to allow users' ERROR probes to decode
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the error condition using thse symbolic labels.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEFLT_NOSCRATCH 5 /* Out of scratch space */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEFLT_KPRIV 6 /* Illegal kernel access */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEFLT_TUPOFLOW 8 /* Tuple stack overflow */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEFLT_LIBRARY 1000 /* Library-level fault */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Argument Types
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Because it would waste both space and time, argument types do not reside
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * with the probe. In order to determine argument types for args[X]
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * variables, the D compiler queries for argument types on a probe-by-probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * basis. (This optimizes for the common case that arguments are either not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * used or used in an untyped fashion.) Typed arguments are specified with a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * string of the type name in the dtragd_native member of the argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * description structure. Typed arguments may be further translated to types
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of greater stability; the provider indicates such a translated argument by
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * filling in the dtargd_xlate member with the string of the translated type.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Finally, the provider may indicate which argument value a given argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * maps to by setting the dtargd_mapping member -- allowing a single argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to map to multiple args[X] variables.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dtargd_native[DTRACE_ARGTYPELEN]; /* native type name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dtargd_xlate[DTRACE_ARGTYPELEN]; /* translated type name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Stability Attributes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Each DTrace provider advertises the name and data stability of each of its
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * probe description components, as well as its architectural dependencies.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The D compiler can query the provider attributes (dtrace_pattr_t below) in
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * order to compute the properties of an input program and report them.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint8_t dtrace_stability_t; /* stability code (see attributes(5)) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsynctypedef uint8_t dtrace_class_t; /* architectural dependency class */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_INTERNAL 0 /* private to DTrace itself */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_PRIVATE 1 /* private to Sun (see docs) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_OBSOLETE 2 /* scheduled for removal */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_EXTERNAL 3 /* not controlled by Sun */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_UNSTABLE 4 /* new or rapidly changing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_EVOLVING 5 /* less rapidly changing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_STABLE 6 /* mature interface from Sun */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_STANDARD 7 /* industry standard */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_STABILITY_MAX 7 /* maximum valid stability */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_UNKNOWN 0 /* unknown architectural dependency */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_CPU 1 /* CPU-module-specific */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_PLATFORM 2 /* platform-specific (uname -i) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_GROUP 3 /* hardware-group-specific (uname -m) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_ISA 4 /* ISA-specific (uname -p) */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_COMMON 5 /* common to all systems */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACE_CLASS_MAX 5 /* maximum valid class */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync DTRACE_PRIV_PROC | DTRACE_PRIV_OWNER | DTRACE_PRIV_ZONEOWNER)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_stability_t dtat_name; /* entity name stability */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_stability_t dtat_data; /* entity data stability */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_class_t dtat_class; /* entity data dependency */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_attribute_t dtpa_provider; /* provider attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_attribute_t dtpa_mod; /* module attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_attribute_t dtpa_func; /* function attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_attribute_t dtpa_name; /* name attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_attribute_t dtpa_args; /* args[] attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dtvd_name[DTRACE_PROVNAMELEN]; /* provider name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_pattr_t dtvd_attr; /* stability attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_ppriv_t dtvd_priv; /* privileges required */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Pseudodevice Interface
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace is controlled through ioctl(2)'s to the in-kernel dtrace:dtrace
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * pseudodevice driver. These ioctls comprise the user-kernel interface to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC (('d' << 24) | ('t' << 16) | ('r' << 8))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_PROVIDER (DTRACEIOC | 1) /* provider query */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_PROBES (DTRACEIOC | 2) /* probe query */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_BUFSNAP (DTRACEIOC | 4) /* snapshot buffer */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_PROBEMATCH (DTRACEIOC | 5) /* match probes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_ENABLE (DTRACEIOC | 6) /* enable probes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_AGGSNAP (DTRACEIOC | 7) /* snapshot agg. */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_EPROBE (DTRACEIOC | 8) /* get eprobe desc. */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_PROBEARG (DTRACEIOC | 9) /* get probe arg */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_CONF (DTRACEIOC | 10) /* get config. */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_STATUS (DTRACEIOC | 11) /* get status */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_GO (DTRACEIOC | 12) /* start tracing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_STOP (DTRACEIOC | 13) /* stop tracing */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_AGGDESC (DTRACEIOC | 15) /* get agg. desc. */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_FORMAT (DTRACEIOC | 16) /* get format str */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_DOFGET (DTRACEIOC | 17) /* get DOF */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEIOC_REPLICATE (DTRACEIOC | 18) /* replicate enab */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Helpers
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * In general, DTrace establishes probes in processes and takes actions on
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * processes without knowing their specific user-level structures. Instead of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * existing in the framework, process-specific knowledge is contained by the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * enabling D program -- which can apply process-specific knowledge by making
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * appropriate use of DTrace primitives like copyin() and copyinstr() to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * operate on user-level data. However, there may exist some specific probes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of particular semantic relevance that the application developer may wish to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * explicitly export. For example, an application may wish to export a probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * at the point that it begins and ends certain well-defined transactions. In
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * addition to providing probes, programs may wish to offer assistance for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * certain actions. For example, in highly dynamic environments (e.g., Java),
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * it may be difficult to obtain a stack trace in terms of meaningful symbol
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * names (the translation from instruction addresses to corresponding symbol
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * names may only be possible in situ); these environments may wish to define
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * a series of actions to be applied in situ to obtain a meaningful stack
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * These two mechanisms -- user-level statically defined tracing and assisting
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace actions -- are provided via DTrace _helpers_. Helpers are specified
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * via DOF, but unlike enabling DOF, helper DOF may contain definitions of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * providers, probes and their arguments. If a helper wishes to provide
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * action assistance, probe descriptions and corresponding DIF actions may be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified in the helper DOF. For such helper actions, however, the probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * description describes the specific helper: all DTrace helpers have the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider name "dtrace" and the module name "helper", and the name of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * helper is contained in the function name (for example, the ustack() helper
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * is named "ustack"). Any helper-specific name may be contained in the name
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * (for example, if a helper were to have a constructor, it might be named
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * "dtrace:helper:<helper>:init"). Helper actions are only called when the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * action that they are helping is taken. Helper actions may only return DIF
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * expressions, and may only call the following subroutines:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * alloca() <= Allocates memory out of the consumer's scratch space
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * bcopy() <= Copies memory to scratch space
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * copyin() <= Copies memory from user-level into consumer's scratch
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * copyinto() <= Copies memory into a specific location in scratch
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * copyinstr() <= Copies a string into a specific location in scratch
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Helper actions may only access the following built-in variables:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * curthread <= Current kthread_t pointer
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * tid <= Current thread identifier
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * pid <= Current process identifier
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * ppid <= Parent process identifier
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * uid <= Current user ID
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * gid <= Current group ID
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * execname <= Current executable name
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * zonename <= Current zone name
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Helper actions may not manipulate or allocate dynamic variables, but they
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * may have clause-local and statically-allocated global variables. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * helper action variable state is specific to the helper action -- variables
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * used by the helper action may not be accessed outside of the helper
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * action, and the helper action may not access variables that like outside
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of it. Helper actions may not load from kernel memory at-large; they are
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * restricting to loading current user state (via copyin() and variants) and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * scratch space. As with probe enablings, helper actions are executed in
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * program order. The result of the helper action is the result of the last
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * executing helper expression.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Helpers -- composed of either providers/probes or probes/actions (or both)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * -- are added by opening the "helper" minor node, and issuing an ioctl(2)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * (DTRACEHIOC_ADDDOF) that specifies the dof_helper_t structure. This
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * encapsulates the name and base address of the user-level library or
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * executable publishing the helpers and probes as well as the DOF that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * contains the definitions of those helpers and probes.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTRACEHIOC_ADD and DTRACEHIOC_REMOVE are left in place for legacy
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * helpers and should no longer be used. No other ioctls are valid on the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * helper minor node.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEHIOC (('d' << 24) | ('t' << 16) | ('h' << 8))
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEHIOC_ADD (DTRACEHIOC | 1) /* add helper */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEHIOC_REMOVE (DTRACEHIOC | 2) /* remove helper */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEHIOC_ADDDOF (DTRACEHIOC | 3) /* add helper DOF */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync char dofhp_mod[DTRACE_MODNAMELEN]; /* executable or library name */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEMNR_DTRACE "dtrace" /* node for DTrace ops */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEMNR_HELPER "helper" /* node for helpers */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#define DTRACEMNRN_DTRACE 0 /* minor for DTrace ops */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Provider API
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The following functions are implemented by the DTrace framework and are
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * used to implement separate in-kernel DTrace providers. Common functions
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * are provided in uts/common/os/dtrace.c. ISA-dependent subroutines are
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * defined in uts/<isa>/dtrace/dtrace_asm.s or uts/<isa>/dtrace/dtrace_isa.c.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The provider API has two halves: the API that the providers consume from
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace, and the API that providers make available to DTrace.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1 Framework-to-Provider API
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The Framework-to-Provider API is represented by the dtrace_pops structure
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that the provider passes to the framework when registering itself. This
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * structure consists of the following members:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide() <-- Provide all probes, all modules
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide_module() <-- Provide all probes in specified module
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_enable() <-- Enable specified probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_disable() <-- Disable specified probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_suspend() <-- Suspend specified probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_resume() <-- Resume specified probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_getargdesc() <-- Get the argument description for args[X]
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_getargval() <-- Get the value for an argX or args[X] variable
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_usermode() <-- Find out if the probe was fired in user mode
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_destroy() <-- Destroy all state associated with this probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2 void dtps_provide(void *arg, const dtrace_probedesc_t *spec)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to indicate that the provider should provide all probes. If the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified description is non-NULL, dtps_provide() is being called because
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * no probe matched a specified probe -- if the provider has the ability to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * create custom probes, it may wish to create a probe that matches the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified description.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is a pointer to a probe description that the provider may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * wish to consider when creating custom probes. The provider is expected to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * call back into the DTrace framework via dtrace_probe_create() to create
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * any necessary probes. dtps_provide() may be called even if the provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * has made available all probes; the provider should check the return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of dtrace_probe_create() to handle this case. Note that the provider need
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * not implement both dtps_provide() and dtps_provide_module(); see
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * "Arguments and Notes" for dtrace_register(), below.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide() is typically called from open() or ioctl() context, but may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * be called from other contexts as well. The DTrace framework is locked in
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * such a way that providers may not register or unregister. This means that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the provider may not call any DTrace API that affects its registration with
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the framework, including dtrace_register(), dtrace_unregister(),
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_invalidate(), and dtrace_condense(). However, the context is such
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that the provider may (and indeed, is expected to) call probe-related
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace routines, including dtrace_probe_create(), dtrace_probe_lookup(),
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * and dtrace_probe_arg().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3 void dtps_provide_module(void *arg, struct modctl *mp)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to indicate that the provider should provide all probes in the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified module.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is a pointer to a modctl structure that indicates the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * module for which probes should be created.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide_module() may be called from open() or ioctl() context, but
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * may also be called from a module loading context. mod_lock is held, and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the DTrace framework is locked in such a way that providers may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * register or unregister. This means that the provider may not call any
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace API that affects its registration with the framework, including
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_condense(). However, the context is such that the provider may (and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * indeed, is expected to) call probe-related DTrace routines, including
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_create(), dtrace_probe_lookup(), and dtrace_probe_arg(). Note
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that the provider need not implement both dtps_provide() and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide_module(); see "Arguments and Notes" for dtrace_register(),
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4 int dtps_enable(void *arg, dtrace_id_t id, void *parg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to enable the specified probe.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the probe to be enabled. The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the probe argument as passed to dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_enable() will be called when a probe transitions from not being
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * enabled at all to having one or more ECB. The number of ECBs associated
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * with the probe may change without subsequent calls into the provider.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * When the number of ECBs drops to zero, the provider will be explicitly
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * told to disable the probe via dtps_disable(). dtrace_probe() should never
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * be called for a probe identifier that hasn't been explicitly enabled via
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_enable().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * On success, dtps_enable() should return 0. On failure, -1 should be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * returned.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTrace framework is locked in such a way that it may not be called
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * back into at all. cpu_lock is held. mod_lock is not held and may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * be acquired.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.5 void dtps_disable(void *arg, dtrace_id_t id, void *parg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.5.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to disable the specified probe.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.5.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the probe to be disabled. The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the probe argument as passed to dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_disable() will be called when a probe transitions from being enabled
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to having zero ECBs. dtrace_probe() should never be called for a probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * identifier that has been explicitly enabled via dtps_disable().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.5.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.5.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTrace framework is locked in such a way that it may not be called
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * back into at all. cpu_lock is held. mod_lock is not held and may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * be acquired.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.6 void dtps_suspend(void *arg, dtrace_id_t id, void *parg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.6.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to suspend the specified enabled probe. This entry point is for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * providers that may need to suspend some or all of their probes when CPUs
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * are being powered on or when the boot monitor is being entered for a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * prolonged period of time.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.6.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the probe to be suspended. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * third argument is the probe argument as passed to dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_suspend will only be called on an enabled probe. Providers that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provide a dtps_suspend entry point will want to take roughly the action
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that it takes for dtps_disable.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.6.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.6.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Interrupts are disabled. The DTrace framework is in a state such that the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified probe cannot be disabled or destroyed for the duration of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_suspend(). As interrupts are disabled, the provider is afforded
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * little latitude; the provider is expected to do no more than a store to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.7 void dtps_resume(void *arg, dtrace_id_t id, void *parg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.7.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to resume the specified enabled probe. This entry point is for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * providers that may need to resume some or all of their probes after the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * completion of an event that induced a call to dtps_suspend().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.7.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the probe to be resumed. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * third argument is the probe argument as passed to dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_resume will only be called on an enabled probe. Providers that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provide a dtps_resume entry point will want to take roughly the action
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that it takes for dtps_enable.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.7.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.7.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Interrupts are disabled. The DTrace framework is in a state such that the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified probe cannot be disabled or destroyed for the duration of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_resume(). As interrupts are disabled, the provider is afforded
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * little latitude; the provider is expected to do no more than a store to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.8 void dtps_getargdesc(void *arg, dtrace_id_t id, void *parg,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_argdesc_t *desc)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.8.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to retrieve the argument description for an args[X] variable.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.8.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the current probe. The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the probe argument as passed to dtrace_probe_create(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * fourth argument is a pointer to the argument description. This
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * description is both an input and output parameter: it contains the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * index of the desired argument in the dtargd_ndx field, and expects
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the other fields to be filled in upon return. If there is no argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * corresponding to the specified index, the dtargd_ndx field should be set
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to DTRACE_ARGNONE.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.8.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * None. The dtargd_ndx, dtargd_native, dtargd_xlate and dtargd_mapping
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * members of the dtrace_argdesc_t structure are all output values.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.8.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_getargdesc() is called from ioctl() context. mod_lock is held, and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the DTrace framework is locked in such a way that providers may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * register or unregister. This means that the provider may not call any
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace API that affects its registration with the framework, including
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_condense().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.9 uint64_t dtps_getargval(void *arg, dtrace_id_t id, void *parg,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * int argno, int aframes)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.9.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to retrieve a value for an argX or args[X] variable.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.9.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the current probe. The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the probe argument as passed to dtrace_probe_create(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * fourth argument is the number of the argument (the X in the example in
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.9.1). The fifth argument is the number of stack frames that were used
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * to get from the actual place in the code that fired the probe to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe() itself, the so-called artificial frames. This argument may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * be used to descend an appropriate number of frames to find the correct
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * values. If this entry point is left NULL, the dtrace_getarg() built-in
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * function is used.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.9.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The value of the argument.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.9.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * This is called from within dtrace_probe() meaning that interrupts
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * are disabled. No locks should be taken within this entry point.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.10 int dtps_usermode(void *arg, dtrace_id_t id, void *parg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.10.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to determine if the probe was fired in a user context.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.10.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the current probe. The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the probe argument as passed to dtrace_probe_create(). This
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * entry point must not be left NULL for providers whose probes allow for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * mixed mode tracing, that is to say those probes that can fire during
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * kernel- _or_ user-mode execution
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.10.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * A boolean value.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.10.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * This is called from within dtrace_probe() meaning that interrupts
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * are disabled. No locks should be taken within this entry point.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.11 void dtps_destroy(void *arg, dtrace_id_t id, void *parg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.11.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called to destroy the specified probe.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.11.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_register(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * second argument is the identifier of the probe to be destroyed. The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the probe argument as passed to dtrace_probe_create(). The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider should free all state associated with the probe. The framework
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * guarantees that dtps_destroy() is only called for probes that have either
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * been disabled via dtps_disable() or were never enabled via dtps_enable().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Once dtps_disable() has been called for a probe, no further call will be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * made specifying the probe.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.11.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.11.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTrace framework is locked in such a way that it may not be called
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * back into at all. mod_lock is held. cpu_lock is not held, and may not be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * acquired.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2 Provider-to-Framework API
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The Provider-to-Framework API provides the mechanism for the provider to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * register itself with the DTrace framework, to create probes, to lookup
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * probes and (most importantly) to fire probes. The Provider-to-Framework
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * consists of:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register() <-- Register a provider with the DTrace framework
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_unregister() <-- Remove a provider's DTrace registration
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_invalidate() <-- Invalidate the specified provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_condense() <-- Remove a provider's unenabled probes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_attached() <-- Indicates whether or not DTrace has attached
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_create() <-- Create a DTrace probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_lookup() <-- Lookup a DTrace probe based on its name
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_arg() <-- Return the probe argument for a specific probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe() <-- Fire the specified probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.2 int dtrace_register(const char *name, const dtrace_pattr_t *pap,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * uint32_t priv, cred_t *cr, const dtrace_pops_t *pops, void *arg,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_provider_id_t *idp)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.2.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register() registers the calling provider with the DTrace
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * framework. It should generally be called by DTrace providers in their
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * attach(9E) entry point.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.2.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the name of the provider. The second argument is a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * pointer to the stability attributes for the provider. The third argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * is the privilege flags for the provider, and must be some combination of:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACE_PRIV_NONE <= All users may enable probes from this provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACE_PRIV_PROC <= Any user with privilege of PRIV_DTRACE_PROC may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * enable probes from this provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACE_PRIV_USER <= Any user with privilege of PRIV_DTRACE_USER may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * enable probes from this provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACE_PRIV_KERNEL <= Any user with privilege of PRIV_DTRACE_KERNEL
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * may enable probes from this provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACE_PRIV_OWNER <= This flag places an additional constraint on
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the privilege requirements above. These probes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * require either (a) a user ID matching the user
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * ID of the cred passed in the fourth argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * or (b) the PRIV_PROC_OWNER privilege.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTRACE_PRIV_ZONEOWNER<= This flag places an additional constraint on
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the privilege requirements above. These probes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * require either (a) a zone ID matching the zone
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * ID of the cred passed in the fourth argument
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * or (b) the PRIV_PROC_ZONE privilege.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Note that these flags designate the _visibility_ of the probes, not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the conditions under which they may or may not fire.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The fourth argument is the credential that is associated with the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider. This argument should be NULL if the privilege flags don't
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * include DTRACE_PRIV_OWNER or DTRACE_PRIV_ZONEOWNER. If non-NULL, the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * framework stashes the uid and zoneid represented by this credential
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * for use at probe-time, in implicit predicates. These limit visibility
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of the probes to users and/or zones which have sufficient privilege to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * access them.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The fifth argument is a DTrace provider operations vector, which provides
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the implementation for the Framework-to-Provider API. (See Section 1,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * above.) This must be non-NULL, and each member must be non-NULL. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * exceptions to this are (1) the dtps_provide() and dtps_provide_module()
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * members (if the provider so desires, _one_ of these members may be left
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * NULL -- denoting that the provider only implements the other) and (2)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the dtps_suspend() and dtps_resume() members, which must either both be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * NULL or both be non-NULL.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The sixth argument is a cookie to be specified as the first argument for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * each function in the Framework-to-Provider API. This argument may have
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * any value.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The final argument is a pointer to dtrace_provider_id_t. If
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register() successfully completes, the provider identifier will be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * stored in the memory pointed to be this argument. This argument must be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * non-NULL.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.2.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * On success, dtrace_register() returns 0 and stores the new provider's
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * identifier into the memory pointed to by the idp argument. On failure,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register() returns an errno:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * EINVAL The arguments passed to dtrace_register() were somehow invalid.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * This may because a parameter that must be non-NULL was NULL,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * because the name was invalid (either empty or an illegal
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider name) or because the attributes were invalid.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * No other failure code is returned.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.2.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register() may induce calls to dtrace_provide(); the provider must
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * hold no locks across dtrace_register() that may also be acquired by
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_provide(). cpu_lock and mod_lock must not be held.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.3 int dtrace_unregister(dtrace_provider_t id)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.3.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Unregisters the specified provider from the DTrace framework. It should
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * generally be called by DTrace providers in their detach(9E) entry point.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.3.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The only argument is the provider identifier, as returned from a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * successful call to dtrace_register(). As a result of calling
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_unregister(), the DTrace framework will call back into the provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * via the dtps_destroy() entry point. Once dtrace_unregister() successfully
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * completes, however, the DTrace framework will no longer make calls through
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the Framework-to-Provider API.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.3.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * On success, dtrace_unregister returns 0. On failure, dtrace_unregister()
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * returns an errno:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * EBUSY There are currently processes that have the DTrace pseudodevice
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * open, or there exists an anonymous enabling that hasn't yet
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * been claimed.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * No other failure code is returned.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.3.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Because a call to dtrace_unregister() may induce calls through the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Framework-to-Provider API, the caller may not hold any lock across
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_register() that is also acquired in any of the Framework-to-
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Provider API functions. Additionally, mod_lock may not be held.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.4 void dtrace_invalidate(dtrace_provider_id_t id)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.4.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Invalidates the specified provider. All subsequent probe lookups for the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified provider will fail, but its probes will not be removed.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.4.2 Arguments and note
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The only argument is the provider identifier, as returned from a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * successful call to dtrace_register(). In general, a provider's probes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * always remain valid; dtrace_invalidate() is a mechanism for invalidating
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * an entire provider, regardless of whether or not probes are enabled or
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * not. Note that dtrace_invalidate() will _not_ prevent already enabled
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * probes from firing -- it will merely prevent any new enablings of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider's probes.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.5 int dtrace_condense(dtrace_provider_id_t id)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.5.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Removes all the unenabled probes for the given provider. This function is
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * not unlike dtrace_unregister(), except that it doesn't remove the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider just as many of its associated probes as it can.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.5.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * As with dtrace_unregister(), the sole argument is the provider identifier
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * as returned from a successful call to dtrace_register(). As a result of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * calling dtrace_condense(), the DTrace framework will call back into the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * given provider's dtps_destroy() entry point for each of the provider's
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * unenabled probes.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.5.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Currently, dtrace_condense() always returns 0. However, consumers of this
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * function should check the return value as appropriate; its behavior may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * change in the future.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.5.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * As with dtrace_unregister(), the caller may not hold any lock across
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_condense() that is also acquired in the provider's entry points.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Also, mod_lock may not be held.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.6 int dtrace_attached()
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.6.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Indicates whether or not DTrace has attached.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.6.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * For most providers, DTrace makes initial contact beyond registration.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * That is, once a provider has registered with DTrace, it waits to hear
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * from DTrace to create probes. However, some providers may wish to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * proactively create probes without first being told by DTrace to do so.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * If providers wish to do this, they must first call dtrace_attached() to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * determine if DTrace itself has attached. If dtrace_attached() returns 0,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the provider must not make any other Provider-to-Framework API call.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.6.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_attached() returns 1 if DTrace has attached, 0 otherwise.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.7 int dtrace_probe_create(dtrace_provider_t id, const char *mod,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * const char *func, const char *name, int aframes, void *arg)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.7.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Creates a probe with specified module name, function name, and name.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.7.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the provider identifier, as returned from a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * successful call to dtrace_register(). The second, third, and fourth
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * arguments are the module name, function name, and probe name,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * respectively. Of these, module name and function name may both be NULL
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * (in which case the probe is considered to be unanchored), or they may both
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * be non-NULL. The name must be non-NULL, and must point to a non-empty
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The fifth argument is the number of artificial stack frames that will be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * found on the stack when dtrace_probe() is called for the new probe. These
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * artificial frames will be automatically be pruned should the stack() or
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * stackdepth() functions be called as part of one of the probe's ECBs. If
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the parameter doesn't add an artificial frame, this parameter should be
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The final argument is a probe argument that will be passed back to the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider when a probe-specific operation is called. (e.g., via
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_enable(), dtps_disable(), etc.)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Note that it is up to the provider to be sure that the probe that it
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * creates does not already exist -- if the provider is unsure of the probe's
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * existence, it should assure its absence with dtrace_probe_lookup() before
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * calling dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.7.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_create() always succeeds, and always returns the identifier
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * of the newly-created probe.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.7.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * While dtrace_probe_create() is generally expected to be called from
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide() and/or dtps_provide_module(), it may be called from other
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * non-DTrace contexts. Neither cpu_lock nor mod_lock may be held.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.8 dtrace_id_t dtrace_probe_lookup(dtrace_provider_t id, const char *mod,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * const char *func, const char *name)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.8.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Looks up a probe based on provdider and one or more of module name,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * function name and probe name.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.8.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the provider identifier, as returned from a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * successful call to dtrace_register(). The second, third, and fourth
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * arguments are the module name, function name, and probe name,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * respectively. Any of these may be NULL; dtrace_probe_lookup() will return
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the identifier of the first probe that is provided by the specified
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider and matches all of the non-NULL matching criteria.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_lookup() is generally used by a provider to be check the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * existence of a probe before creating it with dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.8.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * If the probe exists, returns its identifier. If the probe does not exist,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * return DTRACE_IDNONE.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.8.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * While dtrace_probe_lookup() is generally expected to be called from
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide() and/or dtps_provide_module(), it may also be called from
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * other non-DTrace contexts. Neither cpu_lock nor mod_lock may be held.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.9 void *dtrace_probe_arg(dtrace_provider_t id, dtrace_id_t probe)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.9.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Returns the probe argument associated with the specified probe.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.9.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the provider identifier, as returned from a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * successful call to dtrace_register(). The second argument is a probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * identifier, as returned from dtrace_probe_lookup() or
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_create(). This is useful if a probe has multiple
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider-specific components to it: the provider can create the probe
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * once with provider-specific state, and then add to the state by looking
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * up the probe based on probe identifier.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.9.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Returns the argument associated with the specified probe. If the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * specified probe does not exist, or if the specified probe is not provided
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * by the specified provider, NULL is returned.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.9.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * While dtrace_probe_arg() is generally expected to be called from
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtps_provide() and/or dtps_provide_module(), it may also be called from
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * other non-DTrace contexts. Neither cpu_lock nor mod_lock may be held.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.10 void dtrace_probe(dtrace_id_t probe, uintptr_t arg0, uintptr_t arg1,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * uintptr_t arg2, uintptr_t arg3, uintptr_t arg4)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.10.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The epicenter of DTrace: fires the specified probes with the specified
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * arguments.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.10.2 Arguments and Notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is a probe identifier as returned by
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe_create() or dtrace_probe_lookup(). The second through sixth
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * arguments are the values to which the D variables "arg0" through "arg4"
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * will be mapped.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe() should be called whenever the specified probe has fired --
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * however the provider defines it.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.10.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2.10.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_probe() may be called in virtually any context: kernel, user,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * interrupt, high-level interrupt, with arbitrary adaptive locks held, with
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dispatcher locks held, with interrupts disabled, etc. The only latitude
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that must be afforded to DTrace is the ability to make calls within
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * itself (and to its in-kernel subroutines) and the ability to access
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * arbitrary (but mapped) memory. On some platforms, this constrains
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * context. For example, on UltraSPARC, dtrace_probe() cannot be called
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * from any context in which TL is greater than zero. dtrace_probe() may
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * also not be called from any routine which may be called by dtrace_probe()
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * -- which includes functions in the DTrace framework and some in-kernel
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace subroutines. All such functions "dtrace_"; providers that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * instrument the kernel arbitrarily should be sure to not instrument these
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * routines.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_provide)(void *arg, const dtrace_probedesc_t *spec);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_provide_module)(void *arg, struct modctl *mp);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync int (*dtps_enable)(void *arg, dtrace_id_t id, void *parg);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_disable)(void *arg, dtrace_id_t id, void *parg);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_suspend)(void *arg, dtrace_id_t id, void *parg);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_resume)(void *arg, dtrace_id_t id, void *parg);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_getargdesc)(void *arg, dtrace_id_t id, void *parg,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint64_t (*dtps_getargval)(void *arg, dtrace_id_t id, void *parg,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync int (*dtps_usermode)(void *arg, dtrace_id_t id, void *parg);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtps_destroy)(void *arg, dtrace_id_t id, void *parg);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_register(const char *, const dtrace_pattr_t *, uint32_t,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync cred_t *, const dtrace_pops_t *, void *, dtrace_provider_id_t *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_invalidate(dtrace_provider_id_t);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern dtrace_id_t dtrace_probe_lookup(dtrace_provider_id_t, const char *,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync const char *, const char *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern dtrace_id_t dtrace_probe_create(dtrace_provider_id_t, const char *,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync const char *, const char *, int, void *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void *dtrace_probe_arg(dtrace_provider_id_t, dtrace_id_t);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_probe(dtrace_id_t, uintptr_t arg0, uintptr_t arg1,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Meta Provider API
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The following functions are implemented by the DTrace framework and are
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * used to implement meta providers. Meta providers plug into the DTrace
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * framework and are used to instantiate new providers on the fly. At
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * present, there is only one type of meta provider and only one meta
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider may be registered with the DTrace framework at a time. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * sole meta provider type provides user-land static tracing facilities
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * by taking meta probe descriptions and adding a corresponding provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * into the DTrace framework.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1 Framework-to-Provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The Framework-to-Provider API is represented by the dtrace_mops structure
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * that the meta provider passes to the framework when registering itself as
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * a meta provider. This structure consists of the following members:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtms_create_probe() <-- Add a new probe to a created provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtms_provide_pid() <-- Create a new provider for a given process
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtms_remove_pid() <-- Remove a previously created provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2 void dtms_create_probe(void *arg, void *parg,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_helper_probedesc_t *probedesc);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called by the DTrace framework to create a new probe in a provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * created by this meta provider.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_meta_register().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The second argument is the provider cookie for the associated provider;
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * this is obtained from the return value of dtms_provide_pid(). The third
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * argument is the helper probe description.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.2.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtms_create_probe() is called from either ioctl() or module load context.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTrace framework is locked in such a way that meta providers may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * register or unregister. This means that the meta provider cannot call
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_meta_register() or dtrace_meta_unregister(). However, the context is
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * such that the provider may (and is expected to) call provider-related
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace provider APIs including dtrace_probe_create().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3 void *dtms_provide_pid(void *arg, dtrace_meta_provider_t *mprov,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * pid_t pid)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called by the DTrace framework to instantiate a new provider given the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * description of the provider and probes in the mprov argument. The
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * meta provider should call dtrace_register() to insert the new provider
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * into the DTrace framework.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_meta_register().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The second argument is a pointer to a structure describing the new
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * helper provider. The third argument is the process identifier for
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * process associated with this new provider. Note that the name of the
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider as passed to dtrace_register() should be the contatenation of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the dtmpb_provname member of the mprov argument and the processs
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * identifier as a string.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The cookie for the provider that the meta provider creates. This is
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * the same value that it passed to dtrace_register().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.3.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtms_provide_pid() is called from either ioctl() or module load context.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTrace framework is locked in such a way that meta providers may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * register or unregister. This means that the meta provider cannot call
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_meta_register() or dtrace_meta_unregister(). However, the context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * is such that the provider may -- and is expected to -- call
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider-related DTrace provider APIs including dtrace_register().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4 void dtms_remove_pid(void *arg, dtrace_meta_provider_t *mprov,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * pid_t pid)
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.1 Overview
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Called by the DTrace framework to remove a provider that had previously
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * been instantiated via the dtms_provide_pid() entry point. The meta
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider need not remove the provider immediately, but this entry
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * point indicates that the provider should be removed as soon as possible
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * using the dtrace_unregister() API.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.2 Arguments and notes
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The first argument is the cookie as passed to dtrace_meta_register().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The second argument is a pointer to a structure describing the helper
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider. The third argument is the process identifier for process
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * associated with this new provider.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.3 Return value
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 1.4.4 Caller's context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtms_remove_pid() is called from either ioctl() or exit() context.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The DTrace framework is locked in such a way that meta providers may not
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * register or unregister. This means that the meta provider cannot call
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * dtrace_meta_register() or dtrace_meta_unregister(). However, the context
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * is such that the provider may -- and is expected to -- call
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * provider-related DTrace provider APIs including dtrace_unregister().
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t *dthpb_enoffs; /* is-enabled offsets array */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint32_t dthpb_nenoffs; /* is-enabled offsets count */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync uint8_t dthpb_xargc; /* translated argument count */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync dtrace_pattr_t dthpv_pattr; /* stability attributes */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtms_create_probe)(void *, void *, dtrace_helper_probedesc_t *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void *(*dtms_provide_pid)(void *, dtrace_helper_provdesc_t *, pid_t);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync void (*dtms_remove_pid)(void *, dtrace_helper_provdesc_t *, pid_t);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_meta_register(const char *, const dtrace_mops_t *, void *,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_meta_unregister(dtrace_meta_provider_id_t);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DTrace Kernel Hooks
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The following functions are implemented by the base kernel and form a set of
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * hooks used by the DTrace framework. DTrace hooks are implemented in either
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * uts/common/os/dtrace_subr.c, an ISA-specific assembly file, or in a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * uts/<platform>/os/dtrace_subr.c corresponding to each hardware platform.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync DTRACE_VTIME_ACTIVE, /* DTrace virtual time, no TNF */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync DTRACE_VTIME_INACTIVE_TNF, /* No DTrace, TNF active */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync DTRACE_VTIME_ACTIVE_TNF /* DTrace virtual time _and_ TNF */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_vtime_enable_tnf(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_vtime_disable_tnf(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_vtime_enable(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_vtime_disable(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int (*dtrace_return_probe_ptr)(struct regs *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void (*dtrace_fasttrap_fork_ptr)(proc_t *, proc_t *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_fasttrap_fork(proc_t *, proc_t *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern dtrace_icookie_t dtrace_interrupt_disable(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_interrupt_enable(dtrace_icookie_t);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_membar_producer(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_membar_consumer(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void (*dtrace_helpers_fork)(proc_t *parent, proc_t *child);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_sync(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_toxic_ranges(void (*)(uintptr_t, uintptr_t));
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_xcall(processorid_t, dtrace_xcall_t, void *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_panic(const char *, ...);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_safe_defer_signal(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_mach_aframes(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_instr_size_isa(uchar_t *, model_t, int *);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_invop_add(int (*)(uintptr_t, uintptr_t *, uintptr_t));
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_invop_remove(int (*)(uintptr_t, uintptr_t *, uintptr_t));
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern void dtrace_invop_callsite(void);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncextern int dtrace_blksuword32(uintptr_t, uint32_t *, int);
5a3672dca0301427a400aec8734acd70e2cf24a4vboxsync (cpu_core[VBDT_GET_CPUID()].cpuc_dtrace_flags & (flag))
5a3672dca0301427a400aec8734acd70e2cf24a4vboxsync (cpu_core[VBDT_GET_CPUID()].cpuc_dtrace_flags |= (flag))
5a3672dca0301427a400aec8734acd70e2cf24a4vboxsync (cpu_core[VBDT_GET_CPUID()].cpuc_dtrace_flags &= ~(flag))
5a3672dca0301427a400aec8734acd70e2cf24a4vboxsync#endif /* _KERNEL || IN_RING0 */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#endif /* _ASM */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync#endif /* _SYS_DTRACE_H */