17c478bdstevel@tonic-gate/*
27c478bdstevel@tonic-gate * CDDL HEADER START
37c478bdstevel@tonic-gate *
47c478bdstevel@tonic-gate * The contents of this file are subject to the terms of the
5ad4023cdp * Common Development and Distribution License (the "License").
6ad4023cdp * You may not use this file except in compliance with the License.
77c478bdstevel@tonic-gate *
87c478bdstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bdstevel@tonic-gate * or http://www.opensolaris.org/os/licensing.
107c478bdstevel@tonic-gate * See the License for the specific language governing permissions
117c478bdstevel@tonic-gate * and limitations under the License.
127c478bdstevel@tonic-gate *
137c478bdstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each
147c478bdstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bdstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the
167c478bdstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying
177c478bdstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bdstevel@tonic-gate *
197c478bdstevel@tonic-gate * CDDL HEADER END
207c478bdstevel@tonic-gate */
21ac44896ahl
227c478bdstevel@tonic-gate/*
23b9e93c1Jonathan Haslam * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
247c478bdstevel@tonic-gate * Use is subject to license terms.
257c478bdstevel@tonic-gate */
267c478bdstevel@tonic-gate
272b6389eBryan Cantrill/*
28ab61854John Levon * Copyright 2018 Joyent, Inc.
29a386cc1Robert Mustacchi * Copyright (c) 2013 by Delphix. All rights reserved.
302b6389eBryan Cantrill */
312b6389eBryan Cantrill
327c478bdstevel@tonic-gate#ifndef _SYS_DTRACE_H
337c478bdstevel@tonic-gate#define	_SYS_DTRACE_H
347c478bdstevel@tonic-gate
357c478bdstevel@tonic-gate#ifdef	__cplusplus
367c478bdstevel@tonic-gateextern "C" {
377c478bdstevel@tonic-gate#endif
387c478bdstevel@tonic-gate
397c478bdstevel@tonic-gate/*
407c478bdstevel@tonic-gate * DTrace Dynamic Tracing Software: Kernel Interfaces
417c478bdstevel@tonic-gate *
427c478bdstevel@tonic-gate * Note: The contents of this file are private to the implementation of the
437c478bdstevel@tonic-gate * Solaris system and DTrace subsystem and are subject to change at any time
447c478bdstevel@tonic-gate * without notice.  Applications and drivers using these interfaces will fail
457c478bdstevel@tonic-gate * to run on future releases.  These interfaces should not be used for any
467c478bdstevel@tonic-gate * purpose except those expressly outlined in dtrace(7D) and libdtrace(3LIB).
477c478bdstevel@tonic-gate * Please refer to the "Solaris Dynamic Tracing Guide" for more information.
487c478bdstevel@tonic-gate */
497c478bdstevel@tonic-gate
507c478bdstevel@tonic-gate#ifndef _ASM
517c478bdstevel@tonic-gate
527c478bdstevel@tonic-gate#include <sys/types.h>
537c478bdstevel@tonic-gate#include <sys/modctl.h>
547c478bdstevel@tonic-gate#include <sys/processor.h>
557c478bdstevel@tonic-gate#include <sys/systm.h>
567c478bdstevel@tonic-gate#include <sys/ctf_api.h>
577c478bdstevel@tonic-gate#include <sys/cyclic.h>
587c478bdstevel@tonic-gate#include <sys/int_limits.h>
597c478bdstevel@tonic-gate
607c478bdstevel@tonic-gate/*
617c478bdstevel@tonic-gate * DTrace Universal Constants and Typedefs
627c478bdstevel@tonic-gate */
637c478bdstevel@tonic-gate#define	DTRACE_CPUALL		-1	/* all CPUs */
647c478bdstevel@tonic-gate#define	DTRACE_IDNONE		0	/* invalid probe identifier */
657c478bdstevel@tonic-gate#define	DTRACE_EPIDNONE		0	/* invalid enabled probe identifier */
667c478bdstevel@tonic-gate#define	DTRACE_AGGIDNONE	0	/* invalid aggregation identifier */
6730ef842bmc#define	DTRACE_AGGVARIDNONE	0	/* invalid aggregation variable ID */
687c478bdstevel@tonic-gate#define	DTRACE_CACHEIDNONE	0	/* invalid predicate cache */
697c478bdstevel@tonic-gate#define	DTRACE_PROVNONE		0	/* invalid provider identifier */
707c478bdstevel@tonic-gate#define	DTRACE_METAPROVNONE	0	/* invalid meta-provider identifier */
717c478bdstevel@tonic-gate#define	DTRACE_ARGNONE		-1	/* invalid argument index */
727c478bdstevel@tonic-gate
737c478bdstevel@tonic-gate#define	DTRACE_PROVNAMELEN	64
747c478bdstevel@tonic-gate#define	DTRACE_MODNAMELEN	64
757c478bdstevel@tonic-gate#define	DTRACE_FUNCNAMELEN	128
767c478bdstevel@tonic-gate#define	DTRACE_NAMELEN		64
777c478bdstevel@tonic-gate#define	DTRACE_FULLNAMELEN	(DTRACE_PROVNAMELEN + DTRACE_MODNAMELEN + \
787c478bdstevel@tonic-gate				DTRACE_FUNCNAMELEN + DTRACE_NAMELEN + 4)
797c478bdstevel@tonic-gate#define	DTRACE_ARGTYPELEN	128
807c478bdstevel@tonic-gate
817c478bdstevel@tonic-gatetypedef uint32_t dtrace_id_t;		/* probe identifier */
827c478bdstevel@tonic-gatetypedef uint32_t dtrace_epid_t;		/* enabled probe identifier */
837c478bdstevel@tonic-gatetypedef uint32_t dtrace_aggid_t;	/* aggregation identifier */
8430ef842bmctypedef int64_t dtrace_aggvarid_t;	/* aggregation variable identifier */
857c478bdstevel@tonic-gatetypedef uint16_t dtrace_actkind_t;	/* action kind */
867c478bdstevel@tonic-gatetypedef int64_t dtrace_optval_t;	/* option value */
877c478bdstevel@tonic-gatetypedef uint32_t dtrace_cacheid_t;	/* predicate cache identifier */
887c478bdstevel@tonic-gate
897c478bdstevel@tonic-gatetypedef enum dtrace_probespec {
907c478bdstevel@tonic-gate	DTRACE_PROBESPEC_NONE = -1,
917c478bdstevel@tonic-gate	DTRACE_PROBESPEC_PROVIDER = 0,
927c478bdstevel@tonic-gate	DTRACE_PROBESPEC_MOD,
937c478bdstevel@tonic-gate	DTRACE_PROBESPEC_FUNC,
947c478bdstevel@tonic-gate	DTRACE_PROBESPEC_NAME
957c478bdstevel@tonic-gate} dtrace_probespec_t;
967c478bdstevel@tonic-gate
977c478bdstevel@tonic-gate/*
987c478bdstevel@tonic-gate * DTrace Intermediate Format (DIF)
997c478bdstevel@tonic-gate *
1007c478bdstevel@tonic-gate * The following definitions describe the DTrace Intermediate Format (DIF), a
1017c478bdstevel@tonic-gate * a RISC-like instruction set and program encoding used to represent
1027c478bdstevel@tonic-gate * predicates and actions that can be bound to DTrace probes.  The constants
1037c478bdstevel@tonic-gate * below defining the number of available registers are suggested minimums; the
1047c478bdstevel@tonic-gate * compiler should use DTRACEIOC_CONF to dynamically obtain the number of
1057c478bdstevel@tonic-gate * registers provided by the current DTrace implementation.
1067c478bdstevel@tonic-gate */
1077c478bdstevel@tonic-gate#define	DIF_VERSION_1	1		/* DIF version 1: Solaris 10 Beta */
1087c478bdstevel@tonic-gate#define	DIF_VERSION_2	2		/* DIF version 2: Solaris 10 FCS */
1097c478bdstevel@tonic-gate#define	DIF_VERSION	DIF_VERSION_2	/* latest DIF instruction set version */
1107c478bdstevel@tonic-gate#define	DIF_DIR_NREGS	8		/* number of DIF integer registers */
1117c478bdstevel@tonic-gate#define	DIF_DTR_NREGS	8		/* number of DIF tuple registers */
1127c478bdstevel@tonic-gate
1137c478bdstevel@tonic-gate#define	DIF_OP_OR	1		/* or	r1, r2, rd */
1147c478bdstevel@tonic-gate#define	DIF_OP_XOR	2		/* xor	r1, r2, rd */
1157c478bdstevel@tonic-gate#define	DIF_OP_AND	3		/* and	r1, r2, rd */
1167c478bdstevel@tonic-gate#define	DIF_OP_SLL	4		/* sll	r1, r2, rd */
1177c478bdstevel@tonic-gate#define	DIF_OP_SRL	5		/* srl	r1, r2, rd */
1187c478bdstevel@tonic-gate#define	DIF_OP_SUB	6		/* sub	r1, r2, rd */
1197c478bdstevel@tonic-gate#define	DIF_OP_ADD	7		/* add	r1, r2, rd */
1207c478bdstevel@tonic-gate#define	DIF_OP_MUL	8		/* mul	r1, r2, rd */
1217c478bdstevel@tonic-gate#define	DIF_OP_SDIV	9		/* sdiv	r1, r2, rd */
1227c478bdstevel@tonic-gate#define	DIF_OP_UDIV	10		/* udiv r1, r2, rd */
1237c478bdstevel@tonic-gate#define	DIF_OP_SREM	11		/* srem r1, r2, rd */
1247c478bdstevel@tonic-gate#define	DIF_OP_UREM	12		/* urem r1, r2, rd */
1257c478bdstevel@tonic-gate#define	DIF_OP_NOT	13		/* not	r1, rd */
1267c478bdstevel@tonic-gate#define	DIF_OP_MOV	14		/* mov	r1, rd */
1277c478bdstevel@tonic-gate#define	DIF_OP_CMP	15		/* cmp	r1, r2 */
1287c478bdstevel@tonic-gate#define	DIF_OP_TST	16		/* tst  r1 */
1297c478bdstevel@tonic-gate#define	DIF_OP_BA	17		/* ba	label */
1307c478bdstevel@tonic-gate#define	DIF_OP_BE	18		/* be	label */
1317c478bdstevel@tonic-gate#define	DIF_OP_BNE	19		/* bne	label */
1327c478bdstevel@tonic-gate#define	DIF_OP_BG	20		/* bg	label */
1337c478bdstevel@tonic-gate#define	DIF_OP_BGU	21		/* bgu	label */
1347c478bdstevel@tonic-gate#define	DIF_OP_BGE	22		/* bge	label */
1357c478bdstevel@tonic-gate#define	DIF_OP_BGEU	23		/* bgeu	label */
1367c478bdstevel@tonic-gate#define	DIF_OP_BL	24		/* bl	label */
1377c478bdstevel@tonic-gate#define	DIF_OP_BLU	25		/* blu	label */
1387c478bdstevel@tonic-gate#define	DIF_OP_BLE	26		/* ble	label */
1397c478bdstevel@tonic-gate#define	DIF_OP_BLEU	27		/* bleu	label */
1407c478bdstevel@tonic-gate#define	DIF_OP_LDSB	28		/* ldsb	[r1], rd */
1417c478bdstevel@tonic-gate#define	DIF_OP_LDSH	29		/* ldsh	[r1], rd */
1427c478bdstevel@tonic-gate#define	DIF_OP_LDSW	30		/* ldsw [r1], rd */
1437c478bdstevel@tonic-gate#define	DIF_OP_LDUB	31		/* ldub	[r1], rd */
1447c478bdstevel@tonic-gate#define	DIF_OP_LDUH	32		/* lduh	[r1], rd */
1457c478bdstevel@tonic-gate#define	DIF_OP_LDUW	33		/* lduw	[r1], rd */
1467c478bdstevel@tonic-gate#define	DIF_OP_LDX	34		/* ldx	[r1], rd */
1477c478bdstevel@tonic-gate#define	DIF_OP_RET	35		/* ret	rd */
1487c478bdstevel@tonic-gate#define	DIF_OP_NOP	36		/* nop */
1497c478bdstevel@tonic-gate#define	DIF_OP_SETX	37		/* setx	intindex, rd */
1507c478bdstevel@tonic-gate#define	DIF_OP_SETS	38		/* sets strindex, rd */
1517c478bdstevel@tonic-gate#define	DIF_OP_SCMP	39		/* scmp	r1, r2 */
1527c478bdstevel@tonic-gate#define	DIF_OP_LDGA	40		/* ldga	var, ri, rd */
1537c478bdstevel@tonic-gate#define	DIF_OP_LDGS	41		/* ldgs var, rd */
1547c478bdstevel@tonic-gate#define	DIF_OP_STGS	42		/* stgs var, rs */
1557c478bdstevel@tonic-gate#define	DIF_OP_LDTA	43		/* ldta var, ri, rd */
1567c478bdstevel@tonic-gate#define	DIF_OP_LDTS	44		/* ldts var, rd */
1577c478bdstevel@tonic-gate#define	DIF_OP_STTS	45		/* stts var, rs */
1587c478bdstevel@tonic-gate#define	DIF_OP_SRA	46		/* sra	r1, r2, rd */
1597c478bdstevel@tonic-gate#define	DIF_OP_CALL	47		/* call	subr, rd */
1607c478bdstevel@tonic-gate#define	DIF_OP_PUSHTR	48		/* pushtr type, rs, rr */
1617c478bdstevel@tonic-gate#define	DIF_OP_PUSHTV	49		/* pushtv type, rs, rv */
1627c478bdstevel@tonic-gate#define	DIF_OP_POPTS	50		/* popts */
1637c478bdstevel@tonic-gate#define	DIF_OP_FLUSHTS	51		/* flushts */
1647c478bdstevel@tonic-gate#define	DIF_OP_LDGAA	52		/* ldgaa var, rd */
1657c478bdstevel@tonic-gate#define	DIF_OP_LDTAA	53		/* ldtaa var, rd */
1667c478bdstevel@tonic-gate#define	DIF_OP_STGAA	54		/* stgaa var, rs */
1677c478bdstevel@tonic-gate#define	DIF_OP_STTAA	55		/* sttaa var, rs */
1687c478bdstevel@tonic-gate#define	DIF_OP_LDLS	56		/* ldls	var, rd */
1697c478bdstevel@tonic-gate#define	DIF_OP_STLS	57		/* stls	var, rs */
1707c478bdstevel@tonic-gate#define	DIF_OP_ALLOCS	58		/* allocs r1, rd */
1717c478bdstevel@tonic-gate#define	DIF_OP_COPYS	59		/* copys  r1, r2, rd */
1727c478bdstevel@tonic-gate#define	DIF_OP_STB	60		/* stb	r1, [rd] */
1737c478bdstevel@tonic-gate#define	DIF_OP_STH	61		/* sth	r1, [rd] */
1747c478bdstevel@tonic-gate#define	DIF_OP_STW	62		/* stw	r1, [rd] */
1757c478bdstevel@tonic-gate#define	DIF_OP_STX	63		/* stx	r1, [rd] */
1767c478bdstevel@tonic-gate#define	DIF_OP_ULDSB	64		/* uldsb [r1], rd */
1777c478bdstevel@tonic-gate#define	DIF_OP_ULDSH	65		/* uldsh [r1], rd */
1787c478bdstevel@tonic-gate#define	DIF_OP_ULDSW	66		/* uldsw [r1], rd */
1797c478bdstevel@tonic-gate#define	DIF_OP_ULDUB	67		/* uldub [r1], rd */
1807c478bdstevel@tonic-gate#define	DIF_OP_ULDUH	68		/* ulduh [r1], rd */
1817c478bdstevel@tonic-gate#define	DIF_OP_ULDUW	69		/* ulduw [r1], rd */
1827c478bdstevel@tonic-gate#define	DIF_OP_ULDX	70		/* uldx  [r1], rd */
1837c478bdstevel@tonic-gate#define	DIF_OP_RLDSB	71		/* rldsb [r1], rd */
1847c478bdstevel@tonic-gate#define	DIF_OP_RLDSH	72		/* rldsh [r1], rd */
1857c478bdstevel@tonic-gate#define	DIF_OP_RLDSW	73		/* rldsw [r1], rd */
1867c478bdstevel@tonic-gate#define	DIF_OP_RLDUB	74		/* rldub [r1], rd */
1877c478bdstevel@tonic-gate#define	DIF_OP_RLDUH	75		/* rlduh [r1], rd */
1887c478bdstevel@tonic-gate#define	DIF_OP_RLDUW	76		/* rlduw [r1], rd */
1897c478bdstevel@tonic-gate#define	DIF_OP_RLDX	77		/* rldx  [r1], rd */
1901a7c1b7mws#define	DIF_OP_XLATE	78		/* xlate xlrindex, rd */
1911a7c1b7mws#define	DIF_OP_XLARG	79		/* xlarg xlrindex, rd */
19256a2071Patrick Mooney#define	DIF_OP_STGA	80		/* stga var, ri, rd */
1937c478bdstevel@tonic-gate
1947c478bdstevel@tonic-gate#define	DIF_INTOFF_MAX		0xffff	/* highest integer table offset */
1957c478bdstevel@tonic-gate#define	DIF_STROFF_MAX		0xffff	/* highest string table offset */
1967c478bdstevel@tonic-gate#define	DIF_REGISTER_MAX	0xff	/* highest register number */
1977c478bdstevel@tonic-gate#define	DIF_VARIABLE_MAX	0xffff	/* highest variable identifier */
1987c478bdstevel@tonic-gate#define	DIF_SUBROUTINE_MAX	0xffff	/* highest subroutine code */
1997c478bdstevel@tonic-gate
2007c478bdstevel@tonic-gate#define	DIF_VAR_ARRAY_MIN	0x0000	/* lowest numbered array variable */
2017c478bdstevel@tonic-gate#define	DIF_VAR_ARRAY_UBASE	0x0080	/* lowest user-defined array */
2027c478bdstevel@tonic-gate#define	DIF_VAR_ARRAY_MAX	0x00ff	/* highest numbered array variable */
2037c478bdstevel@tonic-gate
2047c478bdstevel@tonic-gate#define	DIF_VAR_OTHER_MIN	0x0100	/* lowest numbered scalar or assc */
2057c478bdstevel@tonic-gate#define	DIF_VAR_OTHER_UBASE	0x0500	/* lowest user-defined scalar or assc */
2067c478bdstevel@tonic-gate#define	DIF_VAR_OTHER_MAX	0xffff	/* highest numbered scalar or assc */
2077c478bdstevel@tonic-gate
2087c478bdstevel@tonic-gate#define	DIF_VAR_ARGS		0x0000	/* arguments array */
2097c478bdstevel@tonic-gate#define	DIF_VAR_REGS		0x0001	/* registers array */
2107c478bdstevel@tonic-gate#define	DIF_VAR_UREGS		0x0002	/* user registers array */
2117aa76ffBryan Cantrill#define	DIF_VAR_VMREGS		0x0003	/* virtual machine registers array */
2127c478bdstevel@tonic-gate#define	DIF_VAR_CURTHREAD	0x0100	/* thread pointer */
2137c478bdstevel@tonic-gate#define	DIF_VAR_TIMESTAMP	0x0101	/* timestamp */
2147c478bdstevel@tonic-gate#define	DIF_VAR_VTIMESTAMP	0x0102	/* virtual timestamp */
2157c478bdstevel@tonic-gate#define	DIF_VAR_IPL		0x0103	/* interrupt priority level */
2167c478bdstevel@tonic-gate#define	DIF_VAR_EPID		0x0104	/* enabled probe ID */
2177c478bdstevel@tonic-gate#define	DIF_VAR_ID		0x0105	/* probe ID */
2187c478bdstevel@tonic-gate#define	DIF_VAR_ARG0		0x0106	/* first argument */
2197c478bdstevel@tonic-gate#define	DIF_VAR_ARG1		0x0107	/* second argument */
2207c478bdstevel@tonic-gate#define	DIF_VAR_ARG2		0x0108	/* third argument */
2217c478bdstevel@tonic-gate#define	DIF_VAR_ARG3		0x0109	/* fourth argument */
2227c478bdstevel@tonic-gate#define	DIF_VAR_ARG4		0x010a	/* fifth argument */
2237c478bdstevel@tonic-gate#define	DIF_VAR_ARG5		0x010b	/* sixth argument */
2247c478bdstevel@tonic-gate#define	DIF_VAR_ARG6		0x010c	/* seventh argument */
2257c478bdstevel@tonic-gate#define	DIF_VAR_ARG7		0x010d	/* eighth argument */
2267c478bdstevel@tonic-gate#define	DIF_VAR_ARG8		0x010e	/* ninth argument */
2277c478bdstevel@tonic-gate#define	DIF_VAR_ARG9		0x010f	/* tenth argument */
2287c478bdstevel@tonic-gate#define	DIF_VAR_STACKDEPTH	0x0110	/* stack depth */
2297c478bdstevel@tonic-gate#define	DIF_VAR_CALLER		0x0111	/* caller */
2307c478bdstevel@tonic-gate#define	DIF_VAR_PROBEPROV	0x0112	/* probe provider */
2317c478bdstevel@tonic-gate#define	DIF_VAR_PROBEMOD	0x0113	/* probe module */
2327c478bdstevel@tonic-gate#define	DIF_VAR_PROBEFUNC	0x0114	/* probe function */
2337c478bdstevel@tonic-gate#define	DIF_VAR_PROBENAME	0x0115	/* probe name */
2347c478bdstevel@tonic-gate#define	DIF_VAR_PID		0x0116	/* process ID */
2357c478bdstevel@tonic-gate#define	DIF_VAR_TID		0x0117	/* (per-process) thread ID */
2367c478bdstevel@tonic-gate#define	DIF_VAR_EXECNAME	0x0118	/* name of executable */
2377c478bdstevel@tonic-gate#define	DIF_VAR_ZONENAME	0x0119	/* zone name associated with process */
2387c478bdstevel@tonic-gate#define	DIF_VAR_WALLTIMESTAMP	0x011a	/* wall-clock timestamp */
2390b38a8bahl#define	DIF_VAR_USTACKDEPTH	0x011b	/* user-land stack depth */
240a1b5e53bmc#define	DIF_VAR_UCALLER		0x011c	/* user-level caller */
2415518d15dp#define	DIF_VAR_PPID		0x011d	/* parent process ID */
2425518d15dp#define	DIF_VAR_UID		0x011e	/* process user ID */
2435518d15dp#define	DIF_VAR_GID		0x011f	/* process group ID */
2445518d15dp#define	DIF_VAR_ERRNO		0x0120	/* thread errno */
245ab61854John Levon#define	DIF_VAR_THREADNAME	0x0121	/* thread name */
2467c478bdstevel@tonic-gate
2477c478bdstevel@tonic-gate#define	DIF_SUBR_RAND			0
2487c478bdstevel@tonic-gate#define	DIF_SUBR_MUTEX_OWNED		1
2497c478bdstevel@tonic-gate#define	DIF_SUBR_MUTEX_OWNER		2
2507c478bdstevel@tonic-gate#define	DIF_SUBR_MUTEX_TYPE_ADAPTIVE	3
2517c478bdstevel@tonic-gate#define	DIF_SUBR_MUTEX_TYPE_SPIN	4
2527c478bdstevel@tonic-gate#define	DIF_SUBR_RW_READ_HELD		5
2537c478bdstevel@tonic-gate#define	DIF_SUBR_RW_WRITE_HELD		6
2547c478bdstevel@tonic-gate#define	DIF_SUBR_RW_ISWRITER		7
2557c478bdstevel@tonic-gate#define	DIF_SUBR_COPYIN			8
2567c478bdstevel@tonic-gate#define	DIF_SUBR_COPYINSTR		9
2577c478bdstevel@tonic-gate#define	DIF_SUBR_SPECULATION		10
2587c478bdstevel@tonic-gate#define	DIF_SUBR_PROGENYOF		11
2597c478bdstevel@tonic-gate#define	DIF_SUBR_STRLEN			12
2607c478bdstevel@tonic-gate#define	DIF_SUBR_COPYOUT		13
2617c478bdstevel@tonic-gate#define	DIF_SUBR_COPYOUTSTR		14
2627c478bdstevel@tonic-gate#define	DIF_SUBR_ALLOCA			15
2637c478bdstevel@tonic-gate#define	DIF_SUBR_BCOPY			16
2647c478bdstevel@tonic-gate#define	DIF_SUBR_COPYINTO		17
2657c478bdstevel@tonic-gate#define	DIF_SUBR_MSGDSIZE		18
2667c478bdstevel@tonic-gate#define	DIF_SUBR_MSGSIZE		19
2677c478bdstevel@tonic-gate#define	DIF_SUBR_GETMAJOR		20
2687c478bdstevel@tonic-gate#define	DIF_SUBR_GETMINOR		21
2697c478bdstevel@tonic-gate#define	DIF_SUBR_DDI_PATHNAME		22
2707c478bdstevel@tonic-gate#define	DIF_SUBR_STRJOIN		23
2717c478bdstevel@tonic-gate#define	DIF_SUBR_LLTOSTR		24
2727c478bdstevel@tonic-gate#define	DIF_SUBR_BASENAME		25
2737c478bdstevel@tonic-gate#define	DIF_SUBR_DIRNAME		26
2747c478bdstevel@tonic-gate#define	DIF_SUBR_CLEANPATH		27
2757c478bdstevel@tonic-gate#define	DIF_SUBR_STRCHR			28
2767c478bdstevel@tonic-gate#define	DIF_SUBR_STRRCHR		29
2777c478bdstevel@tonic-gate#define	DIF_SUBR_STRSTR			30
2787c478bdstevel@tonic-gate#define	DIF_SUBR_STRTOK			31
2797c478bdstevel@tonic-gate#define	DIF_SUBR_SUBSTR			32
2807c478bdstevel@tonic-gate#define	DIF_SUBR_INDEX			33
2817c478bdstevel@tonic-gate#define	DIF_SUBR_RINDEX			34
2822b6e762ahl#define	DIF_SUBR_HTONS			35
2832b6e762ahl#define	DIF_SUBR_HTONL			36
2842b6e762ahl#define	DIF_SUBR_HTONLL			37
2852b6e762ahl#define	DIF_SUBR_NTOHS			38
2862b6e762ahl#define	DIF_SUBR_NTOHL			39
2872b6e762ahl#define	DIF_SUBR_NTOHLL			40
2884edabffbrendan#define	DIF_SUBR_INET_NTOP		41
2894edabffbrendan#define	DIF_SUBR_INET_NTOA		42
2904edabffbrendan#define	DIF_SUBR_INET_NTOA6		43
29114c0b03Bryan Cantrill#define	DIF_SUBR_TOUPPER		44
29214c0b03Bryan Cantrill#define	DIF_SUBR_TOLOWER		45
293b0f673cBryan Cantrill#define	DIF_SUBR_GETF			46
294f497f9fJoshua M. Clulow#define	DIF_SUBR_JSON			47
295f497f9fJoshua M. Clulow#define	DIF_SUBR_STRTOLL		48
2967c478bdstevel@tonic-gate
297f497f9fJoshua M. Clulow#define	DIF_SUBR_MAX			48	/* max subroutine value */
2987c478bdstevel@tonic-gate
2997c478bdstevel@tonic-gatetypedef uint32_t dif_instr_t;
3007c478bdstevel@tonic-gate
3017c478bdstevel@tonic-gate#define	DIF_INSTR_OP(i)			(((i) >> 24) & 0xff)
3027c478bdstevel@tonic-gate#define	DIF_INSTR_R1(i)			(((i) >> 16) & 0xff)
3037c478bdstevel@tonic-gate#define	DIF_INSTR_R2(i)			(((i) >>  8) & 0xff)
3047c478bdstevel@tonic-gate#define	DIF_INSTR_RD(i)			((i) & 0xff)
3057c478bdstevel@tonic-gate#define	DIF_INSTR_RS(i)			((i) & 0xff)
3067c478bdstevel@tonic-gate#define	DIF_INSTR_LABEL(i)		((i) & 0xffffff)
3077c478bdstevel@tonic-gate#define	DIF_INSTR_VAR(i)		(((i) >>  8) & 0xffff)
3087c478bdstevel@tonic-gate#define	DIF_INSTR_INTEGER(i)		(((i) >>  8) & 0xffff)
3097c478bdstevel@tonic-gate#define	DIF_INSTR_STRING(i)		(((i) >>  8) & 0xffff)
3107c478bdstevel@tonic-gate#define	DIF_INSTR_SUBR(i)		(((i) >>  8) & 0xffff)
3117c478bdstevel@tonic-gate#define	DIF_INSTR_TYPE(i)		(((i) >> 16) & 0xff)
3121a7c1b7mws#define	DIF_INSTR_XLREF(i)		(((i) >>  8) & 0xffff)
3137c478bdstevel@tonic-gate
3147c478bdstevel@tonic-gate#define	DIF_INSTR_FMT(op, r1, r2, d) \
3157c478bdstevel@tonic-gate	(((op) << 24) | ((r1) << 16) | ((r2) << 8) | (d))
3167c478bdstevel@tonic-gate
3177c478bdstevel@tonic-gate#define	DIF_INSTR_NOT(r1, d)		(DIF_INSTR_FMT(DIF_OP_NOT, r1, 0, d))
3187c478bdstevel@tonic-gate#define	DIF_INSTR_MOV(r1, d)		(DIF_INSTR_FMT(DIF_OP_MOV, r1, 0, d))
3197c478bdstevel@tonic-gate#define	DIF_INSTR_CMP(op, r1, r2)	(DIF_INSTR_FMT(op, r1, r2, 0))
3207c478bdstevel@tonic-gate#define	DIF_INSTR_TST(r1)		(DIF_INSTR_FMT(DIF_OP_TST, r1, 0, 0))
3217c478bdstevel@tonic-gate#define	DIF_INSTR_BRANCH(op, label)	(((op) << 24) | (label))
3227c478bdstevel@tonic-gate#define	DIF_INSTR_LOAD(op, r1, d)	(DIF_INSTR_FMT(op, r1, 0, d))
3237c478bdstevel@tonic-gate#define	DIF_INSTR_STORE(op, r1, d)	(DIF_INSTR_FMT(op, r1, 0, d))
3247c478bdstevel@tonic-gate#define	DIF_INSTR_SETX(i, d)		((DIF_OP_SETX << 24) | ((i) << 8) | (d))
3257c478bdstevel@tonic-gate#define	DIF_INSTR_SETS(s, d)		((DIF_OP_SETS << 24) | ((s) << 8) | (d))
3267c478bdstevel@tonic-gate#define	DIF_INSTR_RET(d)		(DIF_INSTR_FMT(DIF_OP_RET, 0, 0, d))
3277c478bdstevel@tonic-gate#define	DIF_INSTR_NOP			(DIF_OP_NOP << 24)
3287c478bdstevel@tonic-gate#define	DIF_INSTR_LDA(op, v, r, d)	(DIF_INSTR_FMT(op, v, r, d))
3297c478bdstevel@tonic-gate#define	DIF_INSTR_LDV(op, v, d)		(((op) << 24) | ((v) << 8) | (d))
3307c478bdstevel@tonic-gate#define	DIF_INSTR_STV(op, v, rs)	(((op) << 24) | ((v) << 8) | (rs))
3317c478bdstevel@tonic-gate#define	DIF_INSTR_CALL(s, d)		((DIF_OP_CALL << 24) | ((s) << 8) | (d))
3327c478bdstevel@tonic-gate#define	DIF_INSTR_PUSHTS(op, t, r2, rs)	(DIF_INSTR_FMT(op, t, r2, rs))
3337c478bdstevel@tonic-gate#define	DIF_INSTR_POPTS			(DIF_OP_POPTS << 24)
3347c478bdstevel@tonic-gate#define	DIF_INSTR_FLUSHTS		(DIF_OP_FLUSHTS << 24)
3357c478bdstevel@tonic-gate#define	DIF_INSTR_ALLOCS(r1, d)		(DIF_INSTR_FMT(DIF_OP_ALLOCS, r1, 0, d))
3367c478bdstevel@tonic-gate#define	DIF_INSTR_COPYS(r1, r2, d)	(DIF_INSTR_FMT(DIF_OP_COPYS, r1, r2, d))
3371a7c1b7mws#define	DIF_INSTR_XLATE(op, r, d)	(((op) << 24) | ((r) << 8) | (d))
3387c478bdstevel@tonic-gate
3397c478bdstevel@tonic-gate#define	DIF_REG_R0	0		/* %r0 is always set to zero */
3407c478bdstevel@tonic-gate
3417c478bdstevel@tonic-gate/*
3427c478bdstevel@tonic-gate * A DTrace Intermediate Format Type (DIF Type) is used to represent the types
3437c478bdstevel@tonic-gate * of variables, function and associative array arguments, and the return type
3447c478bdstevel@tonic-gate * for each DIF object (shown below).  It contains a description of the type,
3457c478bdstevel@tonic-gate * its size in bytes, and a module identifier.
3467c478bdstevel@tonic-gate */
3477c478bdstevel@tonic-gatetypedef struct dtrace_diftype {
3487c478bdstevel@tonic-gate	uint8_t dtdt_kind;		/* type kind (see below) */
3497c478bdstevel@tonic-gate	uint8_t dtdt_ckind;		/* type kind in CTF */
3507c478bdstevel@tonic-gate	uint8_t dtdt_flags;		/* type flags (see below) */
3517c478bdstevel@tonic-gate	uint8_t dtdt_pad;		/* reserved for future use */
3527c478bdstevel@tonic-gate	uint32_t dtdt_size;		/* type size in bytes (unless string) */
3537c478bdstevel@tonic-gate} dtrace_diftype_t;
3547c478bdstevel@tonic-gate
3557c478bdstevel@tonic-gate#define	DIF_TYPE_CTF		0	/* type is a CTF type */
3567c478bdstevel@tonic-gate#define	DIF_TYPE_STRING		1	/* type is a D string */
3577c478bdstevel@tonic-gate
3587c478bdstevel@tonic-gate#define	DIF_TF_BYREF		0x1	/* type is passed by reference */
359a386cc1Robert Mustacchi#define	DIF_TF_BYUREF		0x2	/* user type is passed by reference */
3607c478bdstevel@tonic-gate
3617c478bdstevel@tonic-gate/*
3627c478bdstevel@tonic-gate * A DTrace Intermediate Format variable record is used to describe each of the
3637c478bdstevel@tonic-gate * variables referenced by a given DIF object.  It contains an integer variable
3647c478bdstevel@tonic-gate * identifier along with variable scope and properties, as shown below.  The
3657c478bdstevel@tonic-gate * size of this structure must be sizeof (int) aligned.
3667c478bdstevel@tonic-gate */
3677c478bdstevel@tonic-gatetypedef struct dtrace_difv {
3687c478bdstevel@tonic-gate	uint32_t dtdv_name;		/* variable name index in dtdo_strtab */
3697c478bdstevel@tonic-gate	uint32_t dtdv_id;		/* variable reference identifier */
3707c478bdstevel@tonic-gate	uint8_t dtdv_kind;		/* variable kind (see below) */
3717c478bdstevel@tonic-gate	uint8_t dtdv_scope;		/* variable scope (see below) */
3727c478bdstevel@tonic-gate	uint16_t dtdv_flags;		/* variable flags (see below) */
3737c478bdstevel@tonic-gate	dtrace_diftype_t dtdv_type;	/* variable type (see above) */
3747c478bdstevel@tonic-gate} dtrace_difv_t;
3757c478bdstevel@tonic-gate
3767c478bdstevel@tonic-gate#define	DIFV_KIND_ARRAY		0	/* variable is an array of quantities */
3777c478bdstevel@tonic-gate#define	DIFV_KIND_SCALAR	1	/* variable is a scalar quantity */
3787c478bdstevel@tonic-gate
3797c478bdstevel@tonic-gate#define	DIFV_SCOPE_GLOBAL	0	/* variable has global scope */
3807c478bdstevel@tonic-gate#define	DIFV_SCOPE_THREAD	1	/* variable has thread scope */
3817c478bdstevel@tonic-gate#define	DIFV_SCOPE_LOCAL	2	/* variable has local scope */
3827c478bdstevel@tonic-gate
3837c478bdstevel@tonic-gate#define	DIFV_F_REF		0x1	/* variable is referenced by DIFO */
3847c478bdstevel@tonic-gate#define	DIFV_F_MOD		0x2	/* variable is written by DIFO */
3857c478bdstevel@tonic-gate
3867c478bdstevel@tonic-gate/*
3877c478bdstevel@tonic-gate * DTrace Actions
3887c478bdstevel@tonic-gate *
3897c478bdstevel@tonic-gate * The upper byte determines the class of the action; the low bytes determines
3907c478bdstevel@tonic-gate * the specific action within that class.  The classes of actions are as
3917c478bdstevel@tonic-gate * follows:
3927c478bdstevel@tonic-gate *
3937c478bdstevel@tonic-gate *   [ no class ]                  <= May record process- or kernel-related data
3947c478bdstevel@tonic-gate *   DTRACEACT_PROC                <= Only records process-related data
3957c478bdstevel@tonic-gate *   DTRACEACT_PROC_DESTRUCTIVE    <= Potentially destructive to processes
3967c478bdstevel@tonic-gate *   DTRACEACT_KERNEL              <= Only records kernel-related data
3977c478bdstevel@tonic-gate *   DTRACEACT_KERNEL_DESTRUCTIVE  <= Potentially destructive to the kernel
3987c478bdstevel@tonic-gate *   DTRACEACT_SPECULATIVE         <= Speculation-related action
3997c478bdstevel@tonic-gate *   DTRACEACT_AGGREGATION         <= Aggregating action
4007c478bdstevel@tonic-gate */
4017c478bdstevel@tonic-gate#define	DTRACEACT_NONE			0	/* no action */
4027c478bdstevel@tonic-gate#define	DTRACEACT_DIFEXPR		1	/* action is DIF expression */
4037c478bdstevel@tonic-gate#define	DTRACEACT_EXIT			2	/* exit() action */
4047c478bdstevel@tonic-gate#define	DTRACEACT_PRINTF		3	/* printf() action */
4057c478bdstevel@tonic-gate#define	DTRACEACT_PRINTA		4	/* printa() action */
4067c478bdstevel@tonic-gate#define	DTRACEACT_LIBACT		5	/* library-controlled action */
4071ea5f93Bryan Cantrill#define	DTRACEACT_TRACEMEM		6	/* tracemem() action */
4081ea5f93Bryan Cantrill#define	DTRACEACT_TRACEMEM_DYNSIZE	7	/* dynamic tracemem() size */
4097c478bdstevel@tonic-gate
4107c478bdstevel@tonic-gate#define	DTRACEACT_PROC			0x0100
4117c478bdstevel@tonic-gate#define	DTRACEACT_USTACK		(DTRACEACT_PROC + 1)
4127c478bdstevel@tonic-gate#define	DTRACEACT_JSTACK		(DTRACEACT_PROC + 2)
413a1b5e53bmc#define	DTRACEACT_USYM			(DTRACEACT_PROC + 3)
414a1b5e53bmc#define	DTRACEACT_UMOD			(DTRACEACT_PROC + 4)
415a1b5e53bmc#define	DTRACEACT_UADDR			(DTRACEACT_PROC + 5)
4167c478bdstevel@tonic-gate
4177c478bdstevel@tonic-gate#define	DTRACEACT_PROC_DESTRUCTIVE	0x0200
4187c478bdstevel@tonic-gate#define	DTRACEACT_STOP			(DTRACEACT_PROC_DESTRUCTIVE + 1)
4197c478bdstevel@tonic-gate#define	DTRACEACT_RAISE			(DTRACEACT_PROC_DESTRUCTIVE + 2)
4207c478bdstevel@tonic-gate#define	DTRACEACT_SYSTEM		(DTRACEACT_PROC_DESTRUCTIVE + 3)
4217c478bdstevel@tonic-gate#define	DTRACEACT_FREOPEN		(DTRACEACT_PROC_DESTRUCTIVE + 4)
4227c478bdstevel@tonic-gate
4237c478bdstevel@tonic-gate#define	DTRACEACT_PROC_CONTROL		0x0300
4247c478bdstevel@tonic-gate
4257c478bdstevel@tonic-gate#define	DTRACEACT_KERNEL		0x0400
4267c478bdstevel@tonic-gate#define	DTRACEACT_STACK			(DTRACEACT_KERNEL + 1)
427a1b5e53bmc#define	DTRACEACT_SYM			(DTRACEACT_KERNEL + 2)
428a1b5e53bmc#define	DTRACEACT_MOD			(DTRACEACT_KERNEL + 3)
4297c478bdstevel@tonic-gate
4307c478bdstevel@tonic-gate#define	DTRACEACT_KERNEL_DESTRUCTIVE	0x0500
4317c478bdstevel@tonic-gate#define	DTRACEACT_BREAKPOINT		(DTRACEACT_KERNEL_DESTRUCTIVE + 1)
4327c478bdstevel@tonic-gate#define	DTRACEACT_PANIC			(DTRACEACT_KERNEL_DESTRUCTIVE + 2)
4337c478bdstevel@tonic-gate#define	DTRACEACT_CHILL			(DTRACEACT_KERNEL_DESTRUCTIVE + 3)
4347c478bdstevel@tonic-gate
4357c478bdstevel@tonic-gate#define	DTRACEACT_SPECULATIVE		0x0600
4367c478bdstevel@tonic-gate#define	DTRACEACT_SPECULATE		(DTRACEACT_SPECULATIVE + 1)
4377c478bdstevel@tonic-gate#define	DTRACEACT_COMMIT		(DTRACEACT_SPECULATIVE + 2)
4387c478bdstevel@tonic-gate#define	DTRACEACT_DISCARD		(DTRACEACT_SPECULATIVE + 3)
4397c478bdstevel@tonic-gate
4407c478bdstevel@tonic-gate#define	DTRACEACT_CLASS(x)		((x) & 0xff00)
4417c478bdstevel@tonic-gate
4427c478bdstevel@tonic-gate#define	DTRACEACT_ISDESTRUCTIVE(x)	\
4437c478bdstevel@tonic-gate	(DTRACEACT_CLASS(x) == DTRACEACT_PROC_DESTRUCTIVE || \
4447c478bdstevel@tonic-gate	DTRACEACT_CLASS(x) == DTRACEACT_KERNEL_DESTRUCTIVE)
4457c478bdstevel@tonic-gate
4467c478bdstevel@tonic-gate#define	DTRACEACT_ISSPECULATIVE(x)	\
4477c478bdstevel@tonic-gate	(DTRACEACT_CLASS(x) == DTRACEACT_SPECULATIVE)
4487c478bdstevel@tonic-gate
4497c478bdstevel@tonic-gate#define	DTRACEACT_ISPRINTFLIKE(x)	\
4507c478bdstevel@tonic-gate	((x) == DTRACEACT_PRINTF || (x) == DTRACEACT_PRINTA || \
4517c478bdstevel@tonic-gate	(x) == DTRACEACT_SYSTEM || (x) == DTRACEACT_FREOPEN)
4527c478bdstevel@tonic-gate
4537c478bdstevel@tonic-gate/*
4547c478bdstevel@tonic-gate * DTrace Aggregating Actions
4557c478bdstevel@tonic-gate *
4567c478bdstevel@tonic-gate * These are functions f(x) for which the following is true:
4577c478bdstevel@tonic-gate *
4587c478bdstevel@tonic-gate *    f(f(x_0) U f(x_1) U ... U f(x_n)) = f(x_0 U x_1 U ... U x_n)
4597c478bdstevel@tonic-gate *
4607c478bdstevel@tonic-gate * where x_n is a set of arbitrary data.  Aggregating actions are in their own
4617c478bdstevel@tonic-gate * DTrace action class, DTTRACEACT_AGGREGATION.  The macros provided here allow
4627c478bdstevel@tonic-gate * for easier processing of the aggregation argument and data payload for a few
4637c478bdstevel@tonic-gate * aggregating actions (notably:  quantize(), lquantize(), and ustack()).
4647c478bdstevel@tonic-gate */
4657c478bdstevel@tonic-gate#define	DTRACEACT_AGGREGATION		0x0700
4667c478bdstevel@tonic-gate#define	DTRACEAGG_COUNT			(DTRACEACT_AGGREGATION + 1)
4677c478bdstevel@tonic-gate#define	DTRACEAGG_MIN			(DTRACEACT_AGGREGATION + 2)
4687c478bdstevel@tonic-gate#define	DTRACEAGG_MAX			(DTRACEACT_AGGREGATION + 3)
4697c478bdstevel@tonic-gate#define	DTRACEAGG_AVG			(DTRACEACT_AGGREGATION + 4)
4707c478bdstevel@tonic-gate#define	DTRACEAGG_SUM			(DTRACEACT_AGGREGATION + 5)
4717c478bdstevel@tonic-gate#define	DTRACEAGG_STDDEV		(DTRACEACT_AGGREGATION + 6)
4727c478bdstevel@tonic-gate#define	DTRACEAGG_QUANTIZE		(DTRACEACT_AGGREGATION + 7)
4737c478bdstevel@tonic-gate#define	DTRACEAGG_LQUANTIZE		(DTRACEACT_AGGREGATION + 8)
4742b6389eBryan Cantrill#define	DTRACEAGG_LLQUANTIZE		(DTRACEACT_AGGREGATION + 9)
4757c478bdstevel@tonic-gate
4767c478bdstevel@tonic-gate#define	DTRACEACT_ISAGG(x)		\
4777c478bdstevel@tonic-gate	(DTRACEACT_CLASS(x) == DTRACEACT_AGGREGATION)
4787c478bdstevel@tonic-gate
4797c478bdstevel@tonic-gate#define	DTRACE_QUANTIZE_NBUCKETS	\
4807c478bdstevel@tonic-gate	(((sizeof (uint64_t) * NBBY) - 1) * 2 + 1)
4817c478bdstevel@tonic-gate
4827c478bdstevel@tonic-gate#define	DTRACE_QUANTIZE_ZEROBUCKET	((sizeof (uint64_t) * NBBY) - 1)
4837c478bdstevel@tonic-gate
4847c478bdstevel@tonic-gate#define	DTRACE_QUANTIZE_BUCKETVAL(buck)					\
4857c478bdstevel@tonic-gate	(int64_t)((buck) < DTRACE_QUANTIZE_ZEROBUCKET ?			\
4867c478bdstevel@tonic-gate	-(1LL << (DTRACE_QUANTIZE_ZEROBUCKET - 1 - (buck))) :		\
4877c478bdstevel@tonic-gate	(buck) == DTRACE_QUANTIZE_ZEROBUCKET ? 0 :			\
4887c478bdstevel@tonic-gate	1LL << ((buck) - DTRACE_QUANTIZE_ZEROBUCKET - 1))
4897c478bdstevel@tonic-gate
4907c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_STEPSHIFT		48
4917c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_STEPMASK		((uint64_t)UINT16_MAX << 48)
4927c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_LEVELSHIFT		32
4937c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_LEVELMASK		((uint64_t)UINT16_MAX << 32)
4947c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_BASESHIFT		0
4957c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_BASEMASK		UINT32_MAX
4967c478bdstevel@tonic-gate
4977c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_STEP(x)		\
4987c478bdstevel@tonic-gate	(uint16_t)(((x) & DTRACE_LQUANTIZE_STEPMASK) >> \
4997c478bdstevel@tonic-gate	DTRACE_LQUANTIZE_STEPSHIFT)
5007c478bdstevel@tonic-gate
5017c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_LEVELS(x)		\
5027c478bdstevel@tonic-gate	(uint16_t)(((x) & DTRACE_LQUANTIZE_LEVELMASK) >> \
5037c478bdstevel@tonic-gate	DTRACE_LQUANTIZE_LEVELSHIFT)
5047c478bdstevel@tonic-gate
5057c478bdstevel@tonic-gate#define	DTRACE_LQUANTIZE_BASE(x)		\
5067c478bdstevel@tonic-gate	(int32_t)(((x) & DTRACE_LQUANTIZE_BASEMASK) >> \
5077c478bdstevel@tonic-gate	DTRACE_LQUANTIZE_BASESHIFT)
5087c478bdstevel@tonic-gate
5092b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_FACTORSHIFT		48
5102b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_FACTORMASK		((uint64_t)UINT16_MAX << 48)
5112b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_LOWSHIFT		32
5122b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_LOWMASK		((uint64_t)UINT16_MAX << 32)
5132b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_HIGHSHIFT		16
5142b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_HIGHMASK		((uint64_t)UINT16_MAX << 16)
5152b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_NSTEPSHIFT		0
5162b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_NSTEPMASK		UINT16_MAX
5172b6389eBryan Cantrill
5182b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_FACTOR(x)		\
5192b6389eBryan Cantrill	(uint16_t)(((x) & DTRACE_LLQUANTIZE_FACTORMASK) >> \
5202b6389eBryan Cantrill	DTRACE_LLQUANTIZE_FACTORSHIFT)
5212b6389eBryan Cantrill
5222b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_LOW(x)		\
5232b6389eBryan Cantrill	(uint16_t)(((x) & DTRACE_LLQUANTIZE_LOWMASK) >> \
5242b6389eBryan Cantrill	DTRACE_LLQUANTIZE_LOWSHIFT)
5252b6389eBryan Cantrill
5262b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_HIGH(x)		\
5272b6389eBryan Cantrill	(uint16_t)(((x) & DTRACE_LLQUANTIZE_HIGHMASK) >> \
5282b6389eBryan Cantrill	DTRACE_LLQUANTIZE_HIGHSHIFT)
5292b6389eBryan Cantrill
5302b6389eBryan Cantrill#define	DTRACE_LLQUANTIZE_NSTEP(x)		\
5312b6389eBryan Cantrill	(uint16_t)(((x) & DTRACE_LLQUANTIZE_NSTEPMASK) >> \
5322b6389eBryan Cantrill	DTRACE_LLQUANTIZE_NSTEPSHIFT)
5332b6389eBryan Cantrill
5347c478bdstevel@tonic-gate#define	DTRACE_USTACK_NFRAMES(x)	(uint32_t)((x) & UINT32_MAX)
5357c478bdstevel@tonic-gate#define	DTRACE_USTACK_STRSIZE(x)	(uint32_t)((x) >> 32)
5367c478bdstevel@tonic-gate#define	DTRACE_USTACK_ARG(x, y)		\
5377c478bdstevel@tonic-gate	((((uint64_t)(y)) << 32) | ((x) & UINT32_MAX))
5387c478bdstevel@tonic-gate
5397c478bdstevel@tonic-gate#ifndef _LP64
5407c478bdstevel@tonic-gate#ifndef _LITTLE_ENDIAN
5417c478bdstevel@tonic-gate#define	DTRACE_PTR(type, name)	uint32_t name##pad; type *name
5427c478bdstevel@tonic-gate#else
5437c478bdstevel@tonic-gate#define	DTRACE_PTR(type, name)	type *name; uint32_t name##pad
5447c478bdstevel@tonic-gate#endif
5457c478bdstevel@tonic-gate#else
5467c478bdstevel@tonic-gate#define	DTRACE_PTR(type, name)	type *name
5477c478bdstevel@tonic-gate#endif
5487c478bdstevel@tonic-gate
5497c478bdstevel@tonic-gate/*
5507c478bdstevel@tonic-gate * DTrace Object Format (DOF)
5517c478bdstevel@tonic-gate *
5527c478bdstevel@tonic-gate * DTrace programs can be persistently encoded in the DOF format so that they
5537c478bdstevel@tonic-gate * may be embedded in other programs (for example, in an ELF file) or in the
5547c478bdstevel@tonic-gate * dtrace driver configuration file for use in anonymous tracing.  The DOF
5557c478bdstevel@tonic-gate * format is versioned and extensible so that it can be revised and so that
5567c478bdstevel@tonic-gate * internal data structures can be modified or extended compatibly.  All DOF
5577c478bdstevel@tonic-gate * structures use fixed-size types, so the 32-bit and 64-bit representations
5587c478bdstevel@tonic-gate * are identical and consumers can use either data model transparently.
5597c478bdstevel@tonic-gate *
5607c478bdstevel@tonic-gate * The file layout is structured as follows:
5617c478bdstevel@tonic-gate *
5627c478bdstevel@tonic-gate * +---------------+-------------------+----- ... ----+---- ... ------+
5637c478bdstevel@tonic-gate * |   dof_hdr_t   |  dof_sec_t[ ... ] |   loadable   | non-loadable  |
5647c478bdstevel@tonic-gate * | (file header) | (section headers) | section data | section data  |
5657c478bdstevel@tonic-gate * +---------------+-------------------+----- ... ----+---- ... ------+
5667c478bdstevel@tonic-gate * |<------------ dof_hdr.dofh_loadsz --------------->|               |
5677c478bdstevel@tonic-gate * |<------------ dof_hdr.dofh_filesz ------------------------------->|
5687c478bdstevel@tonic-gate *
5697c478bdstevel@tonic-gate * The file header stores meta-data including a magic number, data model for
5707c478bdstevel@tonic-gate * the instrumentation, data encoding, and properties of the DIF code within.
5717c478bdstevel@tonic-gate * The header describes its own size and the size of the section headers.  By
5727c478bdstevel@tonic-gate * convention, an array of section headers follows the file header, and then
5737c478bdstevel@tonic-gate * the data for all loadable sections and unloadable sections.  This permits
5747c478bdstevel@tonic-gate * consumer code to easily download the headers and all loadable data into the
5757c478bdstevel@tonic-gate * DTrace driver in one contiguous chunk, omitting other extraneous sections.
5767c478bdstevel@tonic-gate *
5777c478bdstevel@tonic-gate * The section headers describe the size, offset, alignment, and section type
5787c478bdstevel@tonic-gate * for each section.  Sections are described using a set of #defines that tell
5797c478bdstevel@tonic-gate * the consumer what kind of data is expected.  Sections can contain links to
5807c478bdstevel@tonic-gate * other sections by storing a dof_secidx_t, an index into the section header
5817c478bdstevel@tonic-gate * array, inside of the section data structures.  The section header includes
5827c478bdstevel@tonic-gate * an entry size so that sections with data arrays can grow their structures.
5837c478bdstevel@tonic-gate *
5847c478bdstevel@tonic-gate * The DOF data itself can contain many snippets of DIF (i.e. >1 DIFOs), which
5857c478bdstevel@tonic-gate * are represented themselves as a collection of related DOF sections.  This
5867c478bdstevel@tonic-gate * permits us to change the set of sections associated with a DIFO over time,
5877c478bdstevel@tonic-gate * and also permits us to encode DIFOs that contain different sets of sections.
5887c478bdstevel@tonic-gate * When a DOF section wants to refer to a DIFO, it stores the dof_secidx_t of a
5897c478bdstevel@tonic-gate * section of type DOF_SECT_DIFOHDR.  This section's data is then an array of
5907c478bdstevel@tonic-gate * dof_secidx_t's which in turn denote the sections associated with this DIFO.
5917c478bdstevel@tonic-gate *
5927c478bdstevel@tonic-gate * This loose coupling of the file structure (header and sections) to the
5937c478bdstevel@tonic-gate * structure of the DTrace program itself (ECB descriptions, action
5947c478bdstevel@tonic-gate * descriptions, and DIFOs) permits activities such as relocation processing
5957c478bdstevel@tonic-gate * to occur in a single pass without having to understand D program structure.
5967c478bdstevel@tonic-gate *
5977c478bdstevel@tonic-gate * Finally, strings are always stored in ELF-style string tables along with a
5987c478bdstevel@tonic-gate * string table section index and string table offset.  Therefore strings in
5997c478bdstevel@tonic-gate * DOF are always arbitrary-length and not bound to the current implementation.
6007c478bdstevel@tonic-gate */
6017c478bdstevel@tonic-gate
6027c478bdstevel@tonic-gate#define	DOF_ID_SIZE	16	/* total size of dofh_ident[] in bytes */
6037c478bdstevel@tonic-gate
6047c478bdstevel@tonic-gatetypedef struct dof_hdr {
6057c478bdstevel@tonic-gate	uint8_t dofh_ident[DOF_ID_SIZE]; /* identification bytes (see below) */
6067c478bdstevel@tonic-gate	uint32_t dofh_flags;		/* file attribute flags (if any) */
6077c478bdstevel@tonic-gate	uint32_t dofh_hdrsize;		/* size of file header in bytes */
6087c478bdstevel@tonic-gate	uint32_t dofh_secsize;		/* size of section header in bytes */
6097c478bdstevel@tonic-gate	uint32_t dofh_secnum;		/* number of section headers */
6107c478bdstevel@tonic-gate	uint64_t dofh_secoff;		/* file offset of section headers */
6117c478bdstevel@tonic-gate	uint64_t dofh_loadsz;		/* file size of loadable portion */
6127c478bdstevel@tonic-gate	uint64_t dofh_filesz;		/* file size of entire DOF file */
6137c478bdstevel@tonic-gate	uint64_t dofh_pad;		/* reserved for future use */
6147c478bdstevel@tonic-gate} dof_hdr_t;
6157c478bdstevel@tonic-gate
6167c478bdstevel@tonic-gate#define	DOF_ID_MAG0	0	/* first byte of magic number */
6177c478bdstevel@tonic-gate#define	DOF_ID_MAG1	1	/* second byte of magic number */
6187c478bdstevel@tonic-gate#define	DOF_ID_MAG2	2	/* third byte of magic number */
6197c478bdstevel@tonic-gate#define	DOF_ID_MAG3	3	/* fourth byte of magic number */
6207c478bdstevel@tonic-gate#define	DOF_ID_MODEL	4	/* DOF data model (see below) */
6217c478bdstevel@tonic-gate#define	DOF_ID_ENCODING	5	/* DOF data encoding (see below) */
6227c478bdstevel@tonic-gate#define	DOF_ID_VERSION	6	/* DOF file format major version (see below) */
6237c478bdstevel@tonic-gate#define	DOF_ID_DIFVERS	7	/* DIF instruction set version */
6247c478bdstevel@tonic-gate#define	DOF_ID_DIFIREG	8	/* DIF integer registers used by compiler */
6257c478bdstevel@tonic-gate#define	DOF_ID_DIFTREG	9	/* DIF tuple registers used by compiler */
6267c478bdstevel@tonic-gate#define	DOF_ID_PAD	10	/* start of padding bytes (all zeroes) */
6277c478bdstevel@tonic-gate
6287c478bdstevel@tonic-gate#define	DOF_MAG_MAG0	0x7F	/* DOF_ID_MAG[0-3] */
6297c478bdstevel@tonic-gate#define	DOF_MAG_MAG1	'D'
6307c478bdstevel@tonic-gate#define	DOF_MAG_MAG2	'O'
6317c478bdstevel@tonic-gate#define	DOF_MAG_MAG3	'F'
6327c478bdstevel@tonic-gate
6337c478bdstevel@tonic-gate#define	DOF_MAG_STRING	"\177DOF"
6347c478bdstevel@tonic-gate#define	DOF_MAG_STRLEN	4
6357c478bdstevel@tonic-gate
6367c478bdstevel@tonic-gate#define	DOF_MODEL_NONE	0	/* DOF_ID_MODEL */
6377c478bdstevel@tonic-gate#define	DOF_MODEL_ILP32	1
6387c478bdstevel@tonic-gate#define	DOF_MODEL_LP64	2
6397c478bdstevel@tonic-gate
6407c478bdstevel@tonic-gate#ifdef _LP64
6417c478bdstevel@tonic-gate#define	DOF_MODEL_NATIVE	DOF_MODEL_LP64
6427c478bdstevel@tonic-gate#else
6437c478bdstevel@tonic-gate#define	DOF_MODEL_NATIVE	DOF_MODEL_ILP32
6447c478bdstevel@tonic-gate#endif
6457c478bdstevel@tonic-gate
6467c478bdstevel@tonic-gate#define	DOF_ENCODE_NONE	0	/* DOF_ID_ENCODING */
6477c478bdstevel@tonic-gate#define	DOF_ENCODE_LSB	1
6487c478bdstevel@tonic-gate#define	DOF_ENCODE_MSB	2
6497c478bdstevel@tonic-gate
6507c478bdstevel@tonic-gate#ifdef _BIG_ENDIAN
6517c478bdstevel@tonic-gate#define	DOF_ENCODE_NATIVE	DOF_ENCODE_MSB
6527c478bdstevel@tonic-gate#else
6537c478bdstevel@tonic-gate#define	DOF_ENCODE_NATIVE	DOF_ENCODE_LSB
6547c478bdstevel@tonic-gate#endif
6557c478bdstevel@tonic-gate
656ac44896ahl#define	DOF_VERSION_1	1	/* DOF version 1: Solaris 10 FCS */
657ac44896ahl#define	DOF_VERSION_2	2	/* DOF version 2: Solaris Express 6/06 */
658ac44896ahl#define	DOF_VERSION	DOF_VERSION_2	/* Latest DOF version */
6597c478bdstevel@tonic-gate
6607c478bdstevel@tonic-gate#define	DOF_FL_VALID	0	/* mask of all valid dofh_flags bits */
6617c478bdstevel@tonic-gate
6627c478bdstevel@tonic-gatetypedef uint32_t dof_secidx_t;	/* section header table index type */
6637c478bdstevel@tonic-gatetypedef uint32_t dof_stridx_t;	/* string table index type */
6647c478bdstevel@tonic-gate
6657c478bdstevel@tonic-gate#define	DOF_SECIDX_NONE	(-1U)	/* null value for section indices */
6667c478bdstevel@tonic-gate#define	DOF_STRIDX_NONE	(-1U)	/* null value for string indices */
6677c478bdstevel@tonic-gate
6687c478bdstevel@tonic-gatetypedef struct dof_sec {
6697c478bdstevel@tonic-gate	uint32_t dofs_type;	/* section type (see below) */
6707c478bdstevel@tonic-gate	uint32_t dofs_align;	/* section data memory alignment */
6717c478bdstevel@tonic-gate	uint32_t dofs_flags;	/* section flags (if any) */
6727c478bdstevel@tonic-gate	uint32_t dofs_entsize;	/* size of section entry (if table) */
6737c478bdstevel@tonic-gate	uint64_t dofs_offset;	/* offset of section data within file */
6747c478bdstevel@tonic-gate	uint64_t dofs_size;	/* size of section data in bytes */
6757c478bdstevel@tonic-gate} dof_sec_t;
6767c478bdstevel@tonic-gate
6777c478bdstevel@tonic-gate#define	DOF_SECT_NONE		0	/* null section */
6787c478bdstevel@tonic-gate#define	DOF_SECT_COMMENTS	1	/* compiler comments */
6797c478bdstevel@tonic-gate#define	DOF_SECT_SOURCE		2	/* D program source code */
6807c478bdstevel@tonic-gate#define	DOF_SECT_ECBDESC	3	/* dof_ecbdesc_t */
6817c478bdstevel@tonic-gate#define	DOF_SECT_PROBEDESC	4	/* dof_probedesc_t */
6827c478bdstevel@tonic-gate#define	DOF_SECT_ACTDESC	5	/* dof_actdesc_t array */
6837c478bdstevel@tonic-gate#define	DOF_SECT_DIFOHDR	6	/* dof_difohdr_t (variable length) */
6847c478bdstevel@tonic-gate#define	DOF_SECT_DIF		7	/* uint32_t array of byte code */
6857c478bdstevel@tonic-gate#define	DOF_SECT_STRTAB		8	/* string table */
6867c478bdstevel@tonic-gate#define	DOF_SECT_VARTAB		9	/* dtrace_difv_t array */
6877c478bdstevel@tonic-gate#define	DOF_SECT_RELTAB		10	/* dof_relodesc_t array */
6887c478bdstevel@tonic-gate#define	DOF_SECT_TYPTAB		11	/* dtrace_diftype_t array */
6897c478bdstevel@tonic-gate#define	DOF_SECT_URELHDR	12	/* dof_relohdr_t (user relocations) */
6907c478bdstevel@tonic-gate#define	DOF_SECT_KRELHDR	13	/* dof_relohdr_t (kernel relocations) */
6917c478bdstevel@tonic-gate#define	DOF_SECT_OPTDESC	14	/* dof_optdesc_t array */
6927c478bdstevel@tonic-gate#define	DOF_SECT_PROVIDER	15	/* dof_provider_t */
6937c478bdstevel@tonic-gate#define	DOF_SECT_PROBES		16	/* dof_probe_t array */
6947c478bdstevel@tonic-gate#define	DOF_SECT_PRARGS		17	/* uint8_t array (probe arg mappings) */
6957c478bdstevel@tonic-gate#define	DOF_SECT_PROFFS		18	/* uint32_t array (probe arg offsets) */
6967c478bdstevel@tonic-gate#define	DOF_SECT_INTTAB		19	/* uint64_t array */
6977c478bdstevel@tonic-gate#define	DOF_SECT_UTSNAME	20	/* struct utsname */
6981a7c1b7mws#define	DOF_SECT_XLTAB		21	/* dof_xlref_t array */
6991a7c1b7mws#define	DOF_SECT_XLMEMBERS	22	/* dof_xlmember_t array */
7001a7c1b7mws#define	DOF_SECT_XLIMPORT	23	/* dof_xlator_t */
7011a7c1b7mws#define	DOF_SECT_XLEXPORT	24	/* dof_xlator_t */
7021a7c1b7mws#define	DOF_SECT_PREXPORT	25	/* dof_secidx_t array (exported objs) */
703ac44896ahl#define	DOF_SECT_PRENOFFS	26	/* uint32_t array (enabled offsets) */
7047c478bdstevel@tonic-gate
7057c478bdstevel@tonic-gate#define	DOF_SECF_LOAD		1	/* section should be loaded */
7067c478bdstevel@tonic-gate
7078cb7497Jonathan Haslam#define	DOF_SEC_ISLOADABLE(x)						\
7088cb7497Jonathan Haslam	(((x) == DOF_SECT_ECBDESC) || ((x) == DOF_SECT_PROBEDESC) ||	\
7098cb7497Jonathan Haslam	((x) == DOF_SECT_ACTDESC) || ((x) == DOF_SECT_DIFOHDR) ||	\
7108cb7497Jonathan Haslam	((x) == DOF_SECT_DIF) || ((x) == DOF_SECT_STRTAB) ||		\
7118cb7497Jonathan Haslam	((x) == DOF_SECT_VARTAB) || ((x) == DOF_SECT_RELTAB) ||		\
7128cb7497Jonathan Haslam	((x) == DOF_SECT_TYPTAB) || ((x) == DOF_SECT_URELHDR) ||	\
7138cb7497Jonathan Haslam	((x) == DOF_SECT_KRELHDR) || ((x) == DOF_SECT_OPTDESC) ||	\
7148cb7497Jonathan Haslam	((x) == DOF_SECT_PROVIDER) || ((x) == DOF_SECT_PROBES) ||	\
7158cb7497Jonathan Haslam	((x) == DOF_SECT_PRARGS) || ((x) == DOF_SECT_PROFFS) ||		\
7168cb7497Jonathan Haslam	((x) == DOF_SECT_INTTAB) || ((x) == DOF_SECT_XLTAB) ||		\
7178cb7497Jonathan Haslam	((x) == DOF_SECT_XLMEMBERS) || ((x) == DOF_SECT_XLIMPORT) ||	\
7188cb7497Jonathan Haslam	((x) == DOF_SECT_XLIMPORT) || ((x) == DOF_SECT_XLEXPORT) ||	\
7198cb7497Jonathan Haslam	((x) == DOF_SECT_PREXPORT) || ((x) == DOF_SECT_PRENOFFS))
7208cb7497Jonathan Haslam
7217c478bdstevel@tonic-gatetypedef struct dof_ecbdesc {
7227c478bdstevel@tonic-gate	dof_secidx_t dofe_probes;	/* link to DOF_SECT_PROBEDESC */
7237c478bdstevel@tonic-gate	dof_secidx_t dofe_pred;		/* link to DOF_SECT_DIFOHDR */
7247c478bdstevel@tonic-gate	dof_secidx_t dofe_actions;	/* link to DOF_SECT_ACTDESC */
7257c478bdstevel@tonic-gate	uint32_t dofe_pad;		/* reserved for future use */
7267c478bdstevel@tonic-gate	uint64_t dofe_uarg;		/* user-supplied library argument */
7277c478bdstevel@tonic-gate} dof_ecbdesc_t;
7287c478bdstevel@tonic-gate
7297c478bdstevel@tonic-gatetypedef struct dof_probedesc {
7307c478bdstevel@tonic-gate	dof_secidx_t dofp_strtab;	/* link to DOF_SECT_STRTAB section */
7317c478bdstevel@tonic-gate	dof_stridx_t dofp_provider;	/* provider string */
7327c478bdstevel@tonic-gate	dof_stridx_t dofp_mod;		/* module string */
7337c478bdstevel@tonic-gate	dof_stridx_t dofp_func;		/* function string */
7347c478bdstevel@tonic-gate	dof_stridx_t dofp_name;		/* name string */
7357c478bdstevel@tonic-gate	uint32_t dofp_id;		/* probe identifier (or zero) */
7367c478bdstevel@tonic-gate} dof_probedesc_t;
7377c478bdstevel@tonic-gate
7387c478bdstevel@tonic-gatetypedef struct dof_actdesc {
7397c478bdstevel@tonic-gate	dof_secidx_t dofa_difo;		/* link to DOF_SECT_DIFOHDR */
7407c478bdstevel@tonic-gate	dof_secidx_t dofa_strtab;	/* link to DOF_SECT_STRTAB section */
7417c478bdstevel@tonic-gate	uint32_t dofa_kind;		/* action kind (DTRACEACT_* constant) */
7427c478bdstevel@tonic-gate	uint32_t dofa_ntuple;		/* number of subsequent tuple actions */
7437c478bdstevel@tonic-gate	uint64_t dofa_arg;		/* kind-specific argument */
7447c478bdstevel@tonic-gate	uint64_t dofa_uarg;		/* user-supplied argument */
7457c478bdstevel@tonic-gate} dof_actdesc_t;
7467c478bdstevel@tonic-gate
7477c478bdstevel@tonic-gatetypedef struct dof_difohdr {
7487c478bdstevel@tonic-gate	dtrace_diftype_t dofd_rtype;	/* return type for this fragment */
7497c478bdstevel@tonic-gate	dof_secidx_t dofd_links[1];	/* variable length array of indices */
7507c478bdstevel@tonic-gate} dof_difohdr_t;
7517c478bdstevel@tonic-gate
7527c478bdstevel@tonic-gatetypedef struct dof_relohdr {
7537c478bdstevel@tonic-gate	dof_secidx_t dofr_strtab;	/* link to DOF_SECT_STRTAB for names */
7547c478bdstevel@tonic-gate	dof_secidx_t dofr_relsec;	/* link to DOF_SECT_RELTAB for relos */
7557c478bdstevel@tonic-gate	dof_secidx_t dofr_tgtsec;	/* link to section we are relocating */
7567c478bdstevel@tonic-gate} dof_relohdr_t;
7577c478bdstevel@tonic-gate
7587c478bdstevel@tonic-gatetypedef struct dof_relodesc {
7597c478bdstevel@tonic-gate	dof_stridx_t dofr_name;		/* string name of relocation symbol */
7607c478bdstevel@tonic-gate	uint32_t dofr_type;		/* relo type (DOF_RELO_* constant) */
7617c478bdstevel@tonic-gate	uint64_t dofr_offset;		/* byte offset for relocation */
7627c478bdstevel@tonic-gate	uint64_t dofr_data;		/* additional type-specific data */
7637c478bdstevel@tonic-gate} dof_relodesc_t;
7647c478bdstevel@tonic-gate
7657c478bdstevel@tonic-gate#define	DOF_RELO_NONE	0		/* empty relocation entry */
7667c478bdstevel@tonic-gate#define	DOF_RELO_SETX	1		/* relocate setx value */
7677c478bdstevel@tonic-gate
7687c478bdstevel@tonic-gatetypedef struct dof_optdesc {
7697c478bdstevel@tonic-gate	uint32_t dofo_option;		/* option identifier */
7707c478bdstevel@tonic-gate	dof_secidx_t dofo_strtab;	/* string table, if string option */
7717c478bdstevel@tonic-gate	uint64_t dofo_value;		/* option value or string index */
7727c478bdstevel@tonic-gate} dof_optdesc_t;
7737c478bdstevel@tonic-gate
7747c478bdstevel@tonic-gatetypedef uint32_t dof_attr_t;		/* encoded stability attributes */
7757c478bdstevel@tonic-gate
7767c478bdstevel@tonic-gate#define	DOF_ATTR(n, d, c)	(((n) << 24) | ((d) << 16) | ((c) << 8))
7777c478bdstevel@tonic-gate#define	DOF_ATTR_NAME(a)	(((a) >> 24) & 0xff)
7787c478bdstevel@tonic-gate#define	DOF_ATTR_DATA(a)	(((a) >> 16) & 0xff)
7797c478bdstevel@tonic-gate#define	DOF_ATTR_CLASS(a)	(((a) >>  8) & 0xff)
7807c478bdstevel@tonic-gate
7817c478bdstevel@tonic-gatetypedef struct dof_provider {
7827c478bdstevel@tonic-gate	dof_secidx_t dofpv_strtab;	/* link to DOF_SECT_STRTAB section */
7837c478bdstevel@tonic-gate	dof_secidx_t dofpv_probes;	/* link to DOF_SECT_PROBES section */
7847c478bdstevel@tonic-gate	dof_secidx_t dofpv_prargs;	/* link to DOF_SECT_PRARGS section */
7857c478bdstevel@tonic-gate	dof_secidx_t dofpv_proffs;	/* link to DOF_SECT_PROFFS section */
7867c478bdstevel@tonic-gate	dof_stridx_t dofpv_name;	/* provider name string */
7877c478bdstevel@tonic-gate	dof_attr_t dofpv_provattr;	/* provider attributes */
7887c478bdstevel@tonic-gate	dof_attr_t dofpv_modattr;	/* module attributes */
7897c478bdstevel@tonic-gate	dof_attr_t dofpv_funcattr;	/* function attributes */
7907c478bdstevel@tonic-gate	dof_attr_t dofpv_nameattr;	/* name attributes */
7917c478bdstevel@tonic-gate	dof_attr_t dofpv_argsattr;	/* args attributes */
792ac44896ahl	dof_secidx_t dofpv_prenoffs;	/* link to DOF_SECT_PRENOFFS section */
7937c478bdstevel@tonic-gate} dof_provider_t;
7947c478bdstevel@tonic-gate
7957c478bdstevel@tonic-gatetypedef struct dof_probe {
7967c478bdstevel@tonic-gate	uint64_t dofpr_addr;		/* probe base address or offset */
7977c478bdstevel@tonic-gate	dof_stridx_t dofpr_func;	/* probe function string */
7987c478bdstevel@tonic-gate	dof_stridx_t dofpr_name;	/* probe name string */
7997c478bdstevel@tonic-gate	dof_stridx_t dofpr_nargv;	/* native argument type strings */
8007c478bdstevel@tonic-gate	dof_stridx_t dofpr_xargv;	/* translated argument type strings */
8017c478bdstevel@tonic-gate	uint32_t dofpr_argidx;		/* index of first argument mapping */
8027c478bdstevel@tonic-gate	uint32_t dofpr_offidx;		/* index of first offset entry */
8037c478bdstevel@tonic-gate	uint8_t dofpr_nargc;		/* native argument count */
8047c478bdstevel@tonic-gate	uint8_t dofpr_xargc;		/* translated argument count */
8057c478bdstevel@tonic-gate	uint16_t dofpr_noffs;		/* number of offset entries for probe */
806ac44896ahl	uint32_t dofpr_enoffidx;	/* index of first is-enabled offset */
807ac44896ahl	uint16_t dofpr_nenoffs;		/* number of is-enabled offsets */
808ac44896ahl	uint16_t dofpr_pad1;		/* reserved for future use */
809ac44896ahl	uint32_t dofpr_pad2;		/* reserved for future use */
8107c478bdstevel@tonic-gate} dof_probe_t;
8117c478bdstevel@tonic-gate
8121a7c1b7mwstypedef struct dof_xlator {
8131a7c1b7mws	dof_secidx_t dofxl_members;	/* link to DOF_SECT_XLMEMBERS section */
8141a7c1b7mws	dof_secidx_t dofxl_strtab;	/* link to DOF_SECT_STRTAB section */
8151a7c1b7mws	dof_stridx_t dofxl_argv;	/* input parameter type strings */
8161a7c1b7mws	uint32_t dofxl_argc;		/* input parameter list length */
8171a7c1b7mws	dof_stridx_t dofxl_type;	/* output type string name */
8181a7c1b7mws	dof_attr_t dofxl_attr;		/* output stability attributes */
8191a7c1b7mws} dof_xlator_t;
8201a7c1b7mws
8211a7c1b7mwstypedef struct dof_xlmember {
8221a7c1b7mws	dof_secidx_t dofxm_difo;	/* member link to DOF_SECT_DIFOHDR */
8231a7c1b7mws	dof_stridx_t dofxm_name;	/* member name */
8241a7c1b7mws	dtrace_diftype_t dofxm_type;	/* member type */
8251a7c1b7mws} dof_xlmember_t;
8261a7c1b7mws
8271a7c1b7mwstypedef struct dof_xlref {
8281a7c1b7mws	dof_secidx_t dofxr_xlator;	/* link to DOF_SECT_XLATORS section */
8291a7c1b7mws	uint32_t dofxr_member;		/* index of referenced dof_xlmember */
8301a7c1b7mws	uint32_t dofxr_argn;		/* index of argument for DIF_OP_XLARG */
8311a7c1b7mws} dof_xlref_t;
8321a7c1b7mws
8337c478bdstevel@tonic-gate/*
8347c478bdstevel@tonic-gate * DTrace Intermediate Format Object (DIFO)
8357c478bdstevel@tonic-gate *
8367c478bdstevel@tonic-gate * A DIFO is used to store the compiled DIF for a D expression, its return
8377c478bdstevel@tonic-gate * type, and its string and variable tables.  The string table is a single
8387c478bdstevel@tonic-gate * buffer of character data into which sets instructions and variable
8397c478bdstevel@tonic-gate * references can reference strings using a byte offset.  The variable table
8407c478bdstevel@tonic-gate * is an array of dtrace_difv_t structures that describe the name and type of
8417c478bdstevel@tonic-gate * each variable and the id used in the DIF code.  This structure is described
8427c478bdstevel@tonic-gate * above in the DIF section of this header file.  The DIFO is used at both
8437c478bdstevel@tonic-gate * user-level (in the library) and in the kernel, but the structure is never
8447c478bdstevel@tonic-gate * passed between the two: the DOF structures form the only interface.  As a
8457c478bdstevel@tonic-gate * result, the definition can change depending on the presence of _KERNEL.
8467c478bdstevel@tonic-gate */
8477c478bdstevel@tonic-gatetypedef struct dtrace_difo {
8487c478bdstevel@tonic-gate	dif_instr_t *dtdo_buf;		/* instruction buffer */
8497c478bdstevel@tonic-gate	uint64_t *dtdo_inttab;		/* integer table (optional) */
8507c478bdstevel@tonic-gate	char *dtdo_strtab;		/* string table (optional) */
8517c478bdstevel@tonic-gate	dtrace_difv_t *dtdo_vartab;	/* variable table (optional) */
8527c478bdstevel@tonic-gate	uint_t dtdo_len;		/* length of instruction buffer */
8537c478bdstevel@tonic-gate	uint_t dtdo_intlen;		/* length of integer table */
8547c478bdstevel@tonic-gate	uint_t dtdo_strlen;		/* length of string table */
8557c478bdstevel@tonic-gate	uint_t dtdo_varlen;		/* length of variable table */
8567c478bdstevel@tonic-gate	dtrace_diftype_t dtdo_rtype;	/* return type */
8577c478bdstevel@tonic-gate	uint_t dtdo_refcnt;		/* owner reference count */
8587c478bdstevel@tonic-gate	uint_t dtdo_destructive;	/* invokes destructive subroutines */
8597c478bdstevel@tonic-gate#ifndef _KERNEL
8607c478bdstevel@tonic-gate	dof_relodesc_t *dtdo_kreltab;	/* kernel relocations */
8617c478bdstevel@tonic-gate	dof_relodesc_t *dtdo_ureltab;	/* user relocations */
8621a7c1b7mws	struct dt_node **dtdo_xlmtab;	/* translator references */
8631a7c1b7mws	uint_t dtdo_krelen;		/* length of krelo table */
8641a7c1b7mws	uint_t dtdo_urelen;		/* length of urelo table */
8651a7c1b7mws	uint_t dtdo_xlmlen;		/* length of translator table */
8667c478bdstevel@tonic-gate#endif
8677c478bdstevel@tonic-gate} dtrace_difo_t;
8687c478bdstevel@tonic-gate
8697c478bdstevel@tonic-gate/*
8707c478bdstevel@tonic-gate * DTrace Enabling Description Structures
8717c478bdstevel@tonic-gate *
8727c478bdstevel@tonic-gate * When DTrace is tracking the description of a DTrace enabling entity (probe,
8737c478bdstevel@tonic-gate * predicate, action, ECB, record, etc.), it does so in a description
8747c478bdstevel@tonic-gate * structure.  These structures all end in "desc", and are used at both
8757c478bdstevel@tonic-gate * user-level and in the kernel -- but (with the exception of
8767c478bdstevel@tonic-gate * dtrace_probedesc_t) they are never passed between them.  Typically,
8777c478bdstevel@tonic-gate * user-level will use the description structures when assembling an enabling.
8787c478bdstevel@tonic-gate * It will then distill those description structures into a DOF object (see
8797c478bdstevel@tonic-gate * above), and send it into the kernel.  The kernel will again use the
8807c478bdstevel@tonic-gate * description structures to create a description of the enabling as it reads
8817c478bdstevel@tonic-gate * the DOF.  When the description is complete, the enabling will be actually
8827c478bdstevel@tonic-gate * created -- turning it into the structures that represent the enabling
8837c478bdstevel@tonic-gate * instead of merely describing it.  Not surprisingly, the description
8847c478bdstevel@tonic-gate * structures bear a strong resemblance to the DOF structures that act as their
8857c478bdstevel@tonic-gate * conduit.
8867c478bdstevel@tonic-gate */
8877c478bdstevel@tonic-gatestruct dtrace_predicate;
8887c478bdstevel@tonic-gate
8897c478bdstevel@tonic-gatetypedef struct dtrace_probedesc {
8907c478bdstevel@tonic-gate	dtrace_id_t dtpd_id;			/* probe identifier */
8917c478bdstevel@tonic-gate	char dtpd_provider[DTRACE_PROVNAMELEN]; /* probe provider name */
8927c478bdstevel@tonic-gate	char dtpd_mod[DTRACE_MODNAMELEN];	/* probe module name */
8937c478bdstevel@tonic-gate	char dtpd_func[DTRACE_FUNCNAMELEN];	/* probe function name */
8947c478bdstevel@tonic-gate	char dtpd_name[DTRACE_NAMELEN];		/* probe name */
8957c478bdstevel@tonic-gate} dtrace_probedesc_t;
8967c478bdstevel@tonic-gate
8977c478bdstevel@tonic-gatetypedef struct dtrace_repldesc {
8987c478bdstevel@tonic-gate	dtrace_probedesc_t dtrpd_match;		/* probe descr. to match */
8997c478bdstevel@tonic-gate	dtrace_probedesc_t dtrpd_create;	/* probe descr. to create */
9007c478bdstevel@tonic-gate} dtrace_repldesc_t;
9017c478bdstevel@tonic-gate
9027c478bdstevel@tonic-gatetypedef struct dtrace_preddesc {
9037c478bdstevel@tonic-gate	dtrace_difo_t *dtpdd_difo;		/* pointer to DIF object */
9047c478bdstevel@tonic-gate	struct dtrace_predicate *dtpdd_predicate; /* pointer to predicate */
9057c478bdstevel@tonic-gate} dtrace_preddesc_t;
9067c478bdstevel@tonic-gate
9077c478bdstevel@tonic-gatetypedef struct dtrace_actdesc {
9087c478bdstevel@tonic-gate	dtrace_difo_t *dtad_difo;		/* pointer to DIF object */
9097c478bdstevel@tonic-gate	struct dtrace_actdesc *dtad_next;	/* next action */
9107c478bdstevel@tonic-gate	dtrace_actkind_t dtad_kind;		/* kind of action */
9117c478bdstevel@tonic-gate	uint32_t dtad_ntuple;			/* number in tuple */
9127c478bdstevel@tonic-gate	uint64_t dtad_arg;			/* action argument */
9137c478bdstevel@tonic-gate	uint64_t dtad_uarg;			/* user argument */
9147c478bdstevel@tonic-gate	int dtad_refcnt;			/* reference count */
9157c478bdstevel@tonic-gate} dtrace_actdesc_t;
9167c478bdstevel@tonic-gate
9177c478bdstevel@tonic-gatetypedef struct dtrace_ecbdesc {
9187c478bdstevel@tonic-gate	dtrace_actdesc_t *dted_action;		/* action description(s) */
9197c478bdstevel@tonic-gate	dtrace_preddesc_t dted_pred;		/* predicate description */
9207c478bdstevel@tonic-gate	dtrace_probedesc_t dted_probe;		/* probe description */
9217c478bdstevel@tonic-gate	uint64_t dted_uarg;			/* library argument */
9227c478bdstevel@tonic-gate	int dted_refcnt;			/* reference count */
9237c478bdstevel@tonic-gate} dtrace_ecbdesc_t;
9247c478bdstevel@tonic-gate
9257c478bdstevel@tonic-gate/*
9267c478bdstevel@tonic-gate * DTrace Metadata Description Structures
9277c478bdstevel@tonic-gate *
9287c478bdstevel@tonic-gate * DTrace separates the trace data stream from the metadata stream.  The only
929e5803b7Adam H. Leventhal * metadata tokens placed in the data stream are the dtrace_rechdr_t (EPID +
930e5803b7Adam H. Leventhal * timestamp) or (in the case of aggregations) aggregation identifiers.  To
931e5803b7Adam H. Leventhal * determine the structure of the data, DTrace consumers pass the token to the
932e5803b7Adam H. Leventhal * kernel, and receive in return a corresponding description of the enabled
9337c478bdstevel@tonic-gate * probe (via the dtrace_eprobedesc structure) or the aggregation (via the
9347c478bdstevel@tonic-gate * dtrace_aggdesc structure).  Both of these structures are expressed in terms
9357c478bdstevel@tonic-gate * of record descriptions (via the dtrace_recdesc structure) that describe the
9367c478bdstevel@tonic-gate * exact structure of the data.  Some record descriptions may also contain a
9377c478bdstevel@tonic-gate * format identifier; this additional bit of metadata can be retrieved from the
9387c478bdstevel@tonic-gate * kernel, for which a format description is returned via the dtrace_fmtdesc
9397c478bdstevel@tonic-gate * structure.  Note that all four of these structures must be bitness-neutral
9407c478bdstevel@tonic-gate * to allow for a 32-bit DTrace consumer on a 64-bit kernel.
9417c478bdstevel@tonic-gate */
9427c478bdstevel@tonic-gatetypedef struct dtrace_recdesc {
9437c478bdstevel@tonic-gate	dtrace_actkind_t dtrd_action;		/* kind of action */
9447c478bdstevel@tonic-gate	uint32_t dtrd_size;			/* size of record */
9457c478bdstevel@tonic-gate	uint32_t dtrd_offset;			/* offset in ECB's data */
9467c478bdstevel@tonic-gate	uint16_t dtrd_alignment;		/* required alignment */
9477c478bdstevel@tonic-gate	uint16_t dtrd_format;			/* format, if any */
9487c478bdstevel@tonic-gate	uint64_t dtrd_arg;			/* action argument */
9497c478bdstevel@tonic-gate	uint64_t dtrd_uarg;			/* user argument */
9507c478bdstevel@tonic-gate} dtrace_recdesc_t;
9517c478bdstevel@tonic-gate
9527c478bdstevel@tonic-gatetypedef struct dtrace_eprobedesc {
9537c478bdstevel@tonic-gate	dtrace_epid_t dtepd_epid;		/* enabled probe ID */
9547c478bdstevel@tonic-gate	dtrace_id_t dtepd_probeid;		/* probe ID */
9557c478bdstevel@tonic-gate	uint64_t dtepd_uarg;			/* library argument */
9567c478bdstevel@tonic-gate	uint32_t dtepd_size;			/* total size */
9577c478bdstevel@tonic-gate	int dtepd_nrecs;			/* number of records */
9587c478bdstevel@tonic-gate	dtrace_recdesc_t dtepd_rec[1];		/* records themselves */
9597c478bdstevel@tonic-gate} dtrace_eprobedesc_t;
9607c478bdstevel@tonic-gate
9617c478bdstevel@tonic-gatetypedef struct dtrace_aggdesc {
9627c478bdstevel@tonic-gate	DTRACE_PTR(char, dtagd_name);		/* not filled in by kernel */
96330ef842bmc	dtrace_aggvarid_t dtagd_varid;		/* not filled in by kernel */
9647c478bdstevel@tonic-gate	int dtagd_flags;			/* not filled in by kernel */
9657c478bdstevel@tonic-gate	dtrace_aggid_t dtagd_id;		/* aggregation ID */
9667c478bdstevel@tonic-gate	dtrace_epid_t dtagd_epid;		/* enabled probe ID */
9677c478bdstevel@tonic-gate	uint32_t dtagd_size;			/* size in bytes */
9687c478bdstevel@tonic-gate	int dtagd_nrecs;			/* number of records */
9697c478bdstevel@tonic-gate	uint32_t dtagd_pad;			/* explicit padding */
9707c478bdstevel@tonic-gate	dtrace_recdesc_t dtagd_rec[1];		/* record descriptions */
9717c478bdstevel@tonic-gate} dtrace_aggdesc_t;
9727c478bdstevel@tonic-gate
9737c478bdstevel@tonic-gatetypedef struct dtrace_fmtdesc {
9747c478bdstevel@tonic-gate	DTRACE_PTR(char, dtfd_string);		/* format string */
9757c478bdstevel@tonic-gate	int dtfd_length;			/* length of format string */
9767c478bdstevel@tonic-gate	uint16_t dtfd_format;			/* format identifier */
9777c478bdstevel@tonic-gate} dtrace_fmtdesc_t;
9787c478bdstevel@tonic-gate
9797c478bdstevel@tonic-gate#define	DTRACE_SIZEOF_EPROBEDESC(desc)				\
9807c478bdstevel@tonic-gate	(sizeof (dtrace_eprobedesc_t) + ((desc)->dtepd_nrecs ?	\
9817c478bdstevel@tonic-gate	(((desc)->dtepd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0))
9827c478bdstevel@tonic-gate
9837c478bdstevel@tonic-gate#define	DTRACE_SIZEOF_AGGDESC(desc)				\
9847c478bdstevel@tonic-gate	(sizeof (dtrace_aggdesc_t) + ((desc)->dtagd_nrecs ?	\
9857c478bdstevel@tonic-gate	(((desc)->dtagd_nrecs - 1) * sizeof (dtrace_recdesc_t)) : 0))
9867c478bdstevel@tonic-gate
9877c478bdstevel@tonic-gate/*
9887c478bdstevel@tonic-gate * DTrace Option Interface
9897c478bdstevel@tonic-gate *
9907c478bdstevel@tonic-gate * Run-time DTrace options are set and retrieved via DOF_SECT_OPTDESC sections
9917c478bdstevel@tonic-gate * in a DOF image.  The dof_optdesc structure contains an option identifier and
9927c478bdstevel@tonic-gate * an option value.  The valid option identifiers are found below; the mapping
9937c478bdstevel@tonic-gate * between option identifiers and option identifying strings is maintained at
9947c478bdstevel@tonic-gate * user-level.  Note that the value of DTRACEOPT_UNSET is such that all of the
9957c478bdstevel@tonic-gate * following are potentially valid option values:  all positive integers, zero
9967c478bdstevel@tonic-gate * and negative one.  Some options (notably "bufpolicy" and "bufresize") take
9977c478bdstevel@tonic-gate * predefined tokens as their values; these are defined with
9987c478bdstevel@tonic-gate * DTRACEOPT_{option}_{token}.
9997c478bdstevel@tonic-gate */
10007c478bdstevel@tonic-gate#define	DTRACEOPT_BUFSIZE	0	/* buffer size */
10017c478bdstevel@tonic-gate#define	DTRACEOPT_BUFPOLICY	1	/* buffer policy */
10027c478bdstevel@tonic-gate#define	DTRACEOPT_DYNVARSIZE	2	/* dynamic variable size */
10037c478bdstevel@tonic-gate#define	DTRACEOPT_AGGSIZE	3	/* aggregation size */
10047c478bdstevel@tonic-gate#define	DTRACEOPT_SPECSIZE	4	/* speculation size */
10057c478bdstevel@tonic-gate#define	DTRACEOPT_NSPEC		5	/* number of speculations */
10067c478bdstevel@tonic-gate#define	DTRACEOPT_STRSIZE	6	/* string size */
10077c478bdstevel@tonic-gate#define	DTRACEOPT_CLEANRATE	7	/* dynvar cleaning rate */
10087c478bdstevel@tonic-gate#define	DTRACEOPT_CPU		8	/* CPU to trace */
10097c478bdstevel@tonic-gate#define	DTRACEOPT_BUFRESIZE	9	/* buffer resizing policy */
10107c478bdstevel@tonic-gate#define	DTRACEOPT_GRABANON	10	/* grab anonymous state, if any */
10117c478bdstevel@tonic-gate#define	DTRACEOPT_FLOWINDENT	11	/* indent function entry/return */
10127c478bdstevel@tonic-gate#define	DTRACEOPT_QUIET		12	/* only output explicitly traced data */
10137c478bdstevel@tonic-gate#define	DTRACEOPT_STACKFRAMES	13	/* number of stack frames */
10147c478bdstevel@tonic-gate#define	DTRACEOPT_USTACKFRAMES	14	/* number of user stack frames */
10157c478bdstevel@tonic-gate#define	DTRACEOPT_AGGRATE	15	/* aggregation snapshot rate */
10167c478bdstevel@tonic-gate#define	DTRACEOPT_SWITCHRATE	16	/* buffer switching rate */
10177c478bdstevel@tonic-gate#define	DTRACEOPT_STATUSRATE	17	/* status rate */
10187c478bdstevel@tonic-gate#define	DTRACEOPT_DESTRUCTIVE	18	/* destructive actions allowed */
10197c478bdstevel@tonic-gate#define	DTRACEOPT_STACKINDENT	19	/* output indent for stack traces */
10207c478bdstevel@tonic-gate#define	DTRACEOPT_RAWBYTES	20	/* always print bytes in raw form */
10217c478bdstevel@tonic-gate#define	DTRACEOPT_JSTACKFRAMES	21	/* number of jstack() frames */
10227c478bdstevel@tonic-gate#define	DTRACEOPT_JSTACKSTRSIZE	22	/* size of jstack() string table */
102330ef842bmc#define	DTRACEOPT_AGGSORTKEY	23	/* sort aggregations by key */
102430ef842bmc#define	DTRACEOPT_AGGSORTREV	24	/* reverse-sort aggregations */
102530ef842bmc#define	DTRACEOPT_AGGSORTPOS	25	/* agg. position to sort on */
102630ef842bmc#define	DTRACEOPT_AGGSORTKEYPOS	26	/* agg. key position to sort on */
1027e5803b7Adam H. Leventhal#define	DTRACEOPT_TEMPORAL	27	/* temporally ordered output */
102833093f5Bryan Cantrill#define	DTRACEOPT_AGGHIST	28	/* histogram aggregation output */
102933093f5Bryan Cantrill#define	DTRACEOPT_AGGPACK	29	/* packed aggregation output */
103033093f5Bryan Cantrill#define	DTRACEOPT_AGGZOOM	30	/* zoomed aggregation scaling */
103133093f5Bryan Cantrill#define	DTRACEOPT_ZONE		31	/* zone in which to enable probes */
103233093f5Bryan Cantrill#define	DTRACEOPT_MAX		32	/* number of options */
10337c478bdstevel@tonic-gate
10347c478bdstevel@tonic-gate#define	DTRACEOPT_UNSET		(dtrace_optval_t)-2	/* unset option */
10357c478bdstevel@tonic-gate
10367c478bdstevel@tonic-gate#define	DTRACEOPT_BUFPOLICY_RING	0	/* ring buffer */
10377c478bdstevel@tonic-gate#define	DTRACEOPT_BUFPOLICY_FILL	1	/* fill buffer, then stop */
10387c478bdstevel@tonic-gate#define	DTRACEOPT_BUFPOLICY_SWITCH	2	/* switch buffers */
10397c478bdstevel@tonic-gate
10407c478bdstevel@tonic-gate#define	DTRACEOPT_BUFRESIZE_AUTO	0	/* automatic resizing */
10417c478bdstevel@tonic-gate#define	DTRACEOPT_BUFRESIZE_MANUAL	1	/* manual resizing */
10427c478bdstevel@tonic-gate
10437c478bdstevel@tonic-gate/*
10447c478bdstevel@tonic-gate * DTrace Buffer Interface
10457c478bdstevel@tonic-gate *
10467c478bdstevel@tonic-gate * In order to get a snapshot of the principal or aggregation buffer,
10477c478bdstevel@tonic-gate * user-level passes a buffer description to the kernel with the dtrace_bufdesc
10487c478bdstevel@tonic-gate * structure.  This describes which CPU user-level is interested in, and
10497c478bdstevel@tonic-gate * where user-level wishes the kernel to snapshot the buffer to (the
10507c478bdstevel@tonic-gate * dtbd_data field).  The kernel uses the same structure to pass back some
10517c478bdstevel@tonic-gate * information regarding the buffer:  the size of data actually copied out, the
1052e5803b7Adam H. Leventhal * number of drops, the number of errors, the offset of the oldest record,
1053e5803b7Adam H. Leventhal * and the time of the snapshot.
1054e5803b7Adam H. Leventhal *
10557c478bdstevel@tonic-gate * If the buffer policy is a "switch" policy, taking a snapshot of the
10567c478bdstevel@tonic-gate * principal buffer has the additional effect of switching the active and
10577c478bdstevel@tonic-gate * inactive buffers.  Taking a snapshot of the aggregation buffer _always_ has
10587c478bdstevel@tonic-gate * the additional effect of switching the active and inactive buffers.
10597c478bdstevel@tonic-gate */
10607c478bdstevel@tonic-gatetypedef struct dtrace_bufdesc {
10617c478bdstevel@tonic-gate	uint64_t dtbd_size;			/* size of buffer */
10627c478bdstevel@tonic-gate	uint32_t dtbd_cpu;			/* CPU or DTRACE_CPUALL */
10637c478bdstevel@tonic-gate	uint32_t dtbd_errors;			/* number of errors */
10647c478bdstevel@tonic-gate	uint64_t dtbd_drops;			/* number of drops */
10657c478bdstevel@tonic-gate	DTRACE_PTR(char, dtbd_data);		/* data */
10667c478bdstevel@tonic-gate	uint64_t dtbd_oldest;			/* offset of oldest record */
1067e5803b7Adam H. Leventhal	uint64_t dtbd_timestamp;		/* hrtime of snapshot */
10687c478bdstevel@tonic-gate} dtrace_bufdesc_t;
10697c478bdstevel@tonic-gate
10707c478bdstevel@tonic-gate/*
1071e5803b7Adam H. Leventhal * Each record in the buffer (dtbd_data) begins with a header that includes
1072e5803b7Adam H. Leventhal * the epid and a timestamp.  The timestamp is split into two 4-byte parts
1073e5803b7Adam H. Leventhal * so that we do not require 8-byte alignment.
1074e5803b7Adam H. Leventhal */
1075e5803b7Adam H. Leventhaltypedef struct dtrace_rechdr {
1076e5803b7Adam H. Leventhal	dtrace_epid_t dtrh_epid;		/* enabled probe id */
1077e5803b7Adam H. Leventhal	uint32_t dtrh_timestamp_hi;		/* high bits of hrtime_t */
1078e5803b7Adam H. Leventhal	uint32_t dtrh_timestamp_lo;		/* low bits of hrtime_t */
1079e5803b7Adam H. Leventhal} dtrace_rechdr_t;
1080e5803b7Adam H. Leventhal
1081e5803b7Adam H. Leventhal#define	DTRACE_RECORD_LOAD_TIMESTAMP(dtrh)			\
1082e5803b7Adam H. Leventhal	((dtrh)->dtrh_timestamp_lo +				\
1083e5803b7Adam H. Leventhal	((uint64_t)(dtrh)->dtrh_timestamp_hi << 32))
1084e5803b7Adam H. Leventhal
1085e5803b7Adam H. Leventhal#define	DTRACE_RECORD_STORE_TIMESTAMP(dtrh, hrtime) {		\
1086e5803b7Adam H. Leventhal	(dtrh)->dtrh_timestamp_lo = (uint32_t)hrtime;		\
1087e5803b7Adam H. Leventhal	(dtrh)->dtrh_timestamp_hi = hrtime >> 32;		\
1088e5803b7Adam H. Leventhal}
1089e5803b7Adam H. Leventhal
1090e5803b7Adam H. Leventhal/*
10917c478bdstevel@tonic-gate * DTrace Status
10927c478bdstevel@tonic-gate *
10937c478bdstevel@tonic-gate * The status of DTrace is relayed via the dtrace_status structure.  This
10947c478bdstevel@tonic-gate * structure contains members to count drops other than the capacity drops
10957c478bdstevel@tonic-gate * available via the buffer interface (see above).  This consists of dynamic
10967c478bdstevel@tonic-gate * drops (including capacity dynamic drops, rinsing drops and dirty drops), and
10977c478bdstevel@tonic-gate * speculative drops (including capacity speculative drops, drops due to busy
10987c478bdstevel@tonic-gate * speculative buffers and drops due to unavailable speculative buffers).
10997c478bdstevel@tonic-gate * Additionally, the status structure contains a field to indicate the number
11007c478bdstevel@tonic-gate * of "fill"-policy buffers have been filled and a boolean field to indicate
11017c478bdstevel@tonic-gate * that exit() has been called.  If the dtst_exiting field is non-zero, no
11027c478bdstevel@tonic-gate * further data will be generated until tracing is stopped (at which time any
11037c478bdstevel@tonic-gate * enablings of the END action will be processed); if user-level sees that
11047c478bdstevel@tonic-gate * this field is non-zero, tracing should be stopped as soon as possible.
11057c478bdstevel@tonic-gate */
11067c478bdstevel@tonic-gatetypedef struct dtrace_status {
11077c478bdstevel@tonic-gate	uint64_t dtst_dyndrops;			/* dynamic drops */
11087c478bdstevel@tonic-gate	uint64_t dtst_dyndrops_rinsing;		/* dyn drops due to rinsing */
11097c478bdstevel@tonic-gate	uint64_t dtst_dyndrops_dirty;		/* dyn drops due to dirty */
11107c478bdstevel@tonic-gate	uint64_t dtst_specdrops;		/* speculative drops */
11117c478bdstevel@tonic-gate	uint64_t dtst_specdrops_busy;		/* spec drops due to busy */
11127c478bdstevel@tonic-gate	uint64_t dtst_specdrops_unavail;	/* spec drops due to unavail */
11137c478bdstevel@tonic-gate	uint64_t dtst_errors;			/* total errors */
11147c478bdstevel@tonic-gate	uint64_t dtst_filled;			/* number of filled bufs */
1115a1b5e53bmc	uint64_t dtst_stkstroverflows;		/* stack string tab overflows */
1116a1b5e53bmc	uint64_t dtst_dblerrors;		/* errors in ERROR probes */
11177c478bdstevel@tonic-gate	char dtst_killed;			/* non-zero if killed */
11187c478bdstevel@tonic-gate	char dtst_exiting;			/* non-zero if exit() called */
11197c478bdstevel@tonic-gate	char dtst_pad[6];			/* pad out to 64-bit align */
11207c478bdstevel@tonic-gate} dtrace_status_t;
11217c478bdstevel@tonic-gate
11227c478bdstevel@tonic-gate/*
11237c478bdstevel@tonic-gate * DTrace Configuration
11247c478bdstevel@tonic-gate *
11257c478bdstevel@tonic-gate * User-level may need to understand some elements of the kernel DTrace
11267c478bdstevel@tonic-gate * configuration in order to generate correct DIF.  This information is
11277c478bdstevel@tonic-gate * conveyed via the dtrace_conf structure.
11287c478bdstevel@tonic-gate */
11297c478bdstevel@tonic-gatetypedef struct dtrace_conf {
11307c478bdstevel@tonic-gate	uint_t dtc_difversion;			/* supported DIF version */
11317c478bdstevel@tonic-gate	uint_t dtc_difintregs;			/* # of DIF integer registers */
11327c478bdstevel@tonic-gate	uint_t dtc_diftupregs;			/* # of DIF tuple registers */
11337c478bdstevel@tonic-gate	uint_t dtc_ctfmodel;			/* CTF data model */
11347c478bdstevel@tonic-gate	uint_t dtc_pad[8];			/* reserved for future use */
11357c478bdstevel@tonic-gate} dtrace_conf_t;
11367c478bdstevel@tonic-gate
11377c478bdstevel@tonic-gate/*
11387c478bdstevel@tonic-gate * DTrace Faults
11397c478bdstevel@tonic-gate *
11407c478bdstevel@tonic-gate * The constants below DTRACEFLT_LIBRARY indicate probe processing faults;
11417c478bdstevel@tonic-gate * constants at or above DTRACEFLT_LIBRARY indicate faults in probe
11427c478bdstevel@tonic-gate * postprocessing at user-level.  Probe processing faults induce an ERROR
11437c478bdstevel@tonic-gate * probe and are replicated in unistd.d to allow users' ERROR probes to decode
11447c478bdstevel@tonic-gate * the error condition using thse symbolic labels.
11457c478bdstevel@tonic-gate */
11467c478bdstevel@tonic-gate#define	DTRACEFLT_UNKNOWN		0	/* Unknown fault */
11477c478bdstevel@tonic-gate#define	DTRACEFLT_BADADDR		1	/* Bad address */
11487c478bdstevel@tonic-gate#define	DTRACEFLT_BADALIGN		2	/* Bad alignment */
11497c478bdstevel@tonic-gate#define	DTRACEFLT_ILLOP			3	/* Illegal operation */
11507c478bdstevel@tonic-gate#define	DTRACEFLT_DIVZERO		4	/* Divide-by-zero */
11517c478bdstevel@tonic-gate#define	DTRACEFLT_NOSCRATCH		5	/* Out of scratch space */
11527c478bdstevel@tonic-gate#define	DTRACEFLT_KPRIV			6	/* Illegal kernel access */
11537c478bdstevel@tonic-gate#define	DTRACEFLT_UPRIV			7	/* Illegal user access */
11547c478bdstevel@tonic-gate#define	DTRACEFLT_TUPOFLOW		8	/* Tuple stack overflow */
1155b8fac8ejhaslam#define	DTRACEFLT_BADSTACK		9	/* Bad stack */
11567c478bdstevel@tonic-gate
11577c478bdstevel@tonic-gate#define	DTRACEFLT_LIBRARY		1000	/* Library-level fault */
11587c478bdstevel@tonic-gate
11597c478bdstevel@tonic-gate/*
11607c478bdstevel@tonic-gate * DTrace Argument Types
11617c478bdstevel@tonic-gate *
11627c478bdstevel@tonic-gate * Because it would waste both space and time, argument types do not reside
11637c478bdstevel@tonic-gate * with the probe.  In order to determine argument types for args[X]
11647c478bdstevel@tonic-gate * variables, the D compiler queries for argument types on a probe-by-probe
11657c478bdstevel@tonic-gate * basis.  (This optimizes for the common case that arguments are either not
11667c478bdstevel@tonic-gate * used or used in an untyped fashion.)  Typed arguments are specified with a
11677c478bdstevel@tonic-gate * string of the type name in the dtragd_native member of the argument
11687c478bdstevel@tonic-gate * description structure.  Typed arguments may be further translated to types
11697c478bdstevel@tonic-gate * of greater stability; the provider indicates such a translated argument by
11707c478bdstevel@tonic-gate * filling in the dtargd_xlate member with the string of the translated type.
11717c478bdstevel@tonic-gate * Finally, the provider may indicate which argument value a given argument
11727c478bdstevel@tonic-gate * maps to by setting the dtargd_mapping member -- allowing a single argument
11737c478bdstevel@tonic-gate * to map to multiple args[X] variables.
11747c478bdstevel@tonic-gate */
11757c478bdstevel@tonic-gatetypedef struct dtrace_argdesc {
11767c478bdstevel@tonic-gate	dtrace_id_t dtargd_id;			/* probe identifier */
11777c478bdstevel@tonic-gate	int dtargd_ndx;				/* arg number (-1 iff none) */
11787c478bdstevel@tonic-gate	int dtargd_mapping;			/* value mapping */
11797c478bdstevel@tonic-gate	char dtargd_native[DTRACE_ARGTYPELEN];	/* native type name */
11807c478bdstevel@tonic-gate	char dtargd_xlate[DTRACE_ARGTYPELEN];	/* translated type name */
11817c478bdstevel@tonic-gate} dtrace_argdesc_t;
11827c478bdstevel@tonic-gate
11837c478bdstevel@tonic-gate/*
11847c478bdstevel@tonic-gate * DTrace Stability Attributes
11857c478bdstevel@tonic-gate *
11867c478bdstevel@tonic-gate * Each DTrace provider advertises the name and data stability of each of its
11877c478bdstevel@tonic-gate * probe description components, as well as its architectural dependencies.
11887c478bdstevel@tonic-gate * The D compiler can query the provider attributes (dtrace_pattr_t below) in
11897c478bdstevel@tonic-gate * order to compute the properties of an input program and report them.
11907c478bdstevel@tonic-gate */
11917c478bdstevel@tonic-gatetypedef uint8_t dtrace_stability_t;	/* stability code (see attributes(5)) */
11927c478bdstevel@tonic-gatetypedef uint8_t dtrace_class_t;		/* architectural dependency class */
11937c478bdstevel@tonic-gate
11947c478bdstevel@tonic-gate#define	DTRACE_STABILITY_INTERNAL	0	/* private to DTrace itself */
11957c478bdstevel@tonic-gate#define	DTRACE_STABILITY_PRIVATE	1	/* private to Sun (see docs) */
11967c478bdstevel@tonic-gate#define	DTRACE_STABILITY_OBSOLETE	2	/* scheduled for removal */
11977c478bdstevel@tonic-gate#define	DTRACE_STABILITY_EXTERNAL	3	/* not controlled by Sun */
11987c478bdstevel@tonic-gate#define	DTRACE_STABILITY_UNSTABLE	4	/* new or rapidly changing */
11997c478bdstevel@tonic-gate#define	DTRACE_STABILITY_EVOLVING	5	/* less rapidly changing */
12007c478bdstevel@tonic-gate#define	DTRACE_STABILITY_STABLE		6	/* mature interface from Sun */
12017c478bdstevel@tonic-gate#define	DTRACE_STABILITY_STANDARD	7	/* industry standard */
12027c478bdstevel@tonic-gate#define	DTRACE_STABILITY_MAX		7	/* maximum valid stability */
12037c478bdstevel@tonic-gate
12047c478bdstevel@tonic-gate#define	DTRACE_CLASS_UNKNOWN	0	/* unknown architectural dependency */
12057c478bdstevel@tonic-gate#define	DTRACE_CLASS_CPU	1	/* CPU-module-specific */
12067c478bdstevel@tonic-gate#define	DTRACE_CLASS_PLATFORM	2	/* platform-specific (uname -i) */
12077c478bdstevel@tonic-gate#define	DTRACE_CLASS_GROUP	3	/* hardware-group-specific (uname -m) */
12087c478bdstevel@tonic-gate#define	DTRACE_CLASS_ISA	4	/* ISA-specific (uname -p) */
12097c478bdstevel@tonic-gate#define	DTRACE_CLASS_COMMON	5	/* common to all systems */
12107c478bdstevel@tonic-gate#define	DTRACE_CLASS_MAX	5	/* maximum valid class */
12117c478bdstevel@tonic-gate
12127c478bdstevel@tonic-gate#define	DTRACE_PRIV_NONE	0x0000
12137c478bdstevel@tonic-gate#define	DTRACE_PRIV_KERNEL	0x0001
12147c478bdstevel@tonic-gate#define	DTRACE_PRIV_USER	0x0002
12157c478bdstevel@tonic-gate#define	DTRACE_PRIV_PROC	0x0004
12167c478bdstevel@tonic-gate#define	DTRACE_PRIV_OWNER	0x0008
1217ad4023cdp#define	DTRACE_PRIV_ZONEOWNER	0x0010
12187c478bdstevel@tonic-gate
12197c478bdstevel@tonic-gate#define	DTRACE_PRIV_ALL	\
12207c478bdstevel@tonic-gate	(DTRACE_PRIV_KERNEL | DTRACE_PRIV_USER | \
1221ad4023cdp	DTRACE_PRIV_PROC | DTRACE_PRIV_OWNER | DTRACE_PRIV_ZONEOWNER)
12227c478bdstevel@tonic-gate
12237c478bdstevel@tonic-gatetypedef struct dtrace_ppriv {
12247c478bdstevel@tonic-gate	uint32_t dtpp_flags;			/* privilege flags */
12257c478bdstevel@tonic-gate	uid_t dtpp_uid;				/* user ID */
1226ad4023cdp	zoneid_t dtpp_zoneid;			/* zone ID */
12277c478bdstevel@tonic-gate} dtrace_ppriv_t;
12287c478bdstevel@tonic-gate
12297c478bdstevel@tonic-gatetypedef struct dtrace_attribute {
12307c478bdstevel@tonic-gate	dtrace_stability_t dtat_name;		/* entity name stability */
12317c478bdstevel@tonic-gate	dtrace_stability_t dtat_data;		/* entity data stability */
12327c478bdstevel@tonic-gate	dtrace_class_t dtat_class;		/* entity data dependency */
12337c478bdstevel@tonic-gate} dtrace_attribute_t;
12347c478bdstevel@tonic-gate
12357c478bdstevel@tonic-gatetypedef struct dtrace_pattr {
12367c478bdstevel@tonic-gate	dtrace_attribute_t dtpa_provider;	/* provider attributes */
12377c478bdstevel@tonic-gate	dtrace_attribute_t dtpa_mod;		/* module attributes */
12387c478bdstevel@tonic-gate	dtrace_attribute_t dtpa_func;		/* function attributes */
12397c478bdstevel@tonic-gate	dtrace_attribute_t dtpa_name;		/* name attributes */
12407c478bdstevel@tonic-gate	dtrace_attribute_t dtpa_args;		/* args[] attributes */
12417c478bdstevel@tonic-gate} dtrace_pattr_t;
12427c478bdstevel@tonic-gate
12437c478bdstevel@tonic-gatetypedef struct dtrace_providerdesc {
12447c478bdstevel@tonic-gate	char dtvd_name[DTRACE_PROVNAMELEN];	/* provider name */
12457c478bdstevel@tonic-gate	dtrace_pattr_t dtvd_attr;		/* stability attributes */
12467c478bdstevel@tonic-gate	dtrace_ppriv_t dtvd_priv;		/* privileges required */
12477c478bdstevel@tonic-gate} dtrace_providerdesc_t;
12487c478bdstevel@tonic-gate
12497c478bdstevel@tonic-gate/*
12507c478bdstevel@tonic-gate * DTrace Pseudodevice Interface
12517c478bdstevel@tonic-gate *
12527c478bdstevel@tonic-gate * DTrace is controlled through ioctl(2)'s to the in-kernel dtrace:dtrace
12537c478bdstevel@tonic-gate * pseudodevice driver.  These ioctls comprise the user-kernel interface to
12547c478bdstevel@tonic-gate * DTrace.
12557c478bdstevel@tonic-gate */
12567c478bdstevel@tonic-gate#define	DTRACEIOC		(('d' << 24) | ('t' << 16) | ('r' << 8))
12577c478bdstevel@tonic-gate#define	DTRACEIOC_PROVIDER	(DTRACEIOC | 1)		/* provider query */
12587c478bdstevel@tonic-gate#define	DTRACEIOC_PROBES	(DTRACEIOC | 2)		/* probe query */
12597c478bdstevel@tonic-gate#define	DTRACEIOC_BUFSNAP	(DTRACEIOC | 4)		/* snapshot buffer */
12607c478bdstevel@tonic-gate#define	DTRACEIOC_PROBEMATCH	(DTRACEIOC | 5)		/* match probes */
12617c478bdstevel@tonic-gate#define	DTRACEIOC_ENABLE	(DTRACEIOC | 6)		/* enable probes */
12627c478bdstevel@tonic-gate#define	DTRACEIOC_AGGSNAP	(DTRACEIOC | 7)		/* snapshot agg. */
12637c478bdstevel@tonic-gate#define	DTRACEIOC_EPROBE	(DTRACEIOC | 8)		/* get eprobe desc. */
12647c478bdstevel@tonic-gate#define	DTRACEIOC_PROBEARG	(DTRACEIOC | 9)		/* get probe arg */
12657c478bdstevel@tonic-gate#define	DTRACEIOC_CONF		(DTRACEIOC | 10)	/* get config. */
12667c478bdstevel@tonic-gate#define	DTRACEIOC_STATUS	(DTRACEIOC | 11)	/* get status */
12677c478bdstevel@tonic-gate#define	DTRACEIOC_GO		(DTRACEIOC | 12)	/* start tracing */
12687c478bdstevel@tonic-gate#define	DTRACEIOC_STOP		(DTRACEIOC | 13)	/* stop tracing */
12697c478bdstevel@tonic-gate#define	DTRACEIOC_AGGDESC	(DTRACEIOC | 15)	/* get agg. desc. */
12707c478bdstevel@tonic-gate#define	DTRACEIOC_FORMAT	(DTRACEIOC | 16)	/* get format str */
12717c478bdstevel@tonic-gate#define	DTRACEIOC_DOFGET	(DTRACEIOC | 17)	/* get DOF */
12727c478bdstevel@tonic-gate#define	DTRACEIOC_REPLICATE	(DTRACEIOC | 18)	/* replicate enab */
12737c478bdstevel@tonic-gate
12747c478bdstevel@tonic-gate/*
12757c478bdstevel@tonic-gate * DTrace Helpers
12767c478bdstevel@tonic-gate *
12777c478bdstevel@tonic-gate * In general, DTrace establishes probes in processes and takes actions on
12787c478bdstevel@tonic-gate * processes without knowing their specific user-level structures.  Instead of
12797c478bdstevel@tonic-gate * existing in the framework, process-specific knowledge is contained by the
12807c478bdstevel@tonic-gate * enabling D program -- which can apply process-specific knowledge by making
12817c478bdstevel@tonic-gate * appropriate use of DTrace primitives like copyin() and copyinstr() to
12827c478bdstevel@tonic-gate * operate on user-level data.  However, there may exist some specific probes
12837c478bdstevel@tonic-gate * of particular semantic relevance that the application developer may wish to
12847c478bdstevel@tonic-gate * explicitly export.  For example, an application may wish to export a probe
12857c478bdstevel@tonic-gate * at the point that it begins and ends certain well-defined transactions.  In
12867c478bdstevel@tonic-gate * addition to providing probes, programs may wish to offer assistance for
12877c478bdstevel@tonic-gate * certain actions.  For example, in highly dynamic environments (e.g., Java),
12887c478bdstevel@tonic-gate * it may be difficult to obtain a stack trace in terms of meaningful symbol
12897c478bdstevel@tonic-gate * names (the translation from instruction addresses to corresponding symbol
12907c478bdstevel@tonic-gate * names may only be possible in situ); these environments may wish to define
12917c478bdstevel@tonic-gate * a series of actions to be applied in situ to obtain a meaningful stack
12927c478bdstevel@tonic-gate * trace.
12937c478bdstevel@tonic-gate *
12947c478bdstevel@tonic-gate * These two mechanisms -- user-level statically defined tracing and assisting
12957c478bdstevel@tonic-gate * DTrace actions -- are provided via DTrace _helpers_.  Helpers are specified
12967c478bdstevel@tonic-gate * via DOF, but unlike enabling DOF, helper DOF may contain definitions of
12977c478bdstevel@tonic-gate * providers, probes and their arguments.  If a helper wishes to provide
12987c478bdstevel@tonic-gate * action assistance, probe descriptions and corresponding DIF actions may be
12997c478bdstevel@tonic-gate * specified in the helper DOF.  For such helper actions, however, the probe
13007c478bdstevel@tonic-gate * description describes the specific helper:  all DTrace helpers have the
13017c478bdstevel@tonic-gate * provider name "dtrace" and the module name "helper", and the name of the
13027c478bdstevel@tonic-gate * helper is contained in the function name (for example, the ustack() helper
13037c478bdstevel@tonic-gate * is named "ustack").  Any helper-specific name may be contained in the name
13047c478bdstevel@tonic-gate * (for example, if a helper were to have a constructor, it might be named
13057c478bdstevel@tonic-gate * "dtrace:helper:<helper>:init").  Helper actions are only called when the
13067c478bdstevel@tonic-gate * action that they are helping is taken.  Helper actions may only return DIF
13077c478bdstevel@tonic-gate * expressions, and may only call the following subroutines:
13087c478bdstevel@tonic-gate *
13097c478bdstevel@tonic-gate *    alloca()      <= Allocates memory out of the consumer's scratch space
13107c478bdstevel@tonic-gate *    bcopy()       <= Copies memory to scratch space
13117c478bdstevel@tonic-gate *    copyin()      <= Copies memory from user-level into consumer's scratch
13127c478bdstevel@tonic-gate *    copyinto()    <= Copies memory into a specific location in scratch
13137c478bdstevel@tonic-gate *    copyinstr()   <= Copies a string into a specific location in scratch
13147c478bdstevel@tonic-gate *
13157c478bdstevel@tonic-gate * Helper actions may only access the following built-in variables:
13167c478bdstevel@tonic-gate *
13177c478bdstevel@tonic-gate *    curthread     <= Current kthread_t pointer
13187c478bdstevel@tonic-gate *    tid           <= Current thread identifier
13197c478bdstevel@tonic-gate *    pid           <= Current process identifier
13205518d15dp *    ppid          <= Parent process identifier
13215518d15dp *    uid           <= Current user ID
13225518d15dp *    gid           <= Current group ID
13237c478bdstevel@tonic-gate *    execname      <= Current executable name
13245518d15dp *    zonename      <= Current zone name
13257c478bdstevel@tonic-gate *
13267c478bdstevel@tonic-gate * Helper actions may not manipulate or allocate dynamic variables, but they
13277c478bdstevel@tonic-gate * may have clause-local and statically-allocated global variables.  The
13287c478bdstevel@tonic-gate * helper action variable state is specific to the helper action -- variables
13297c478bdstevel@tonic-gate * used by the helper action may not be accessed outside of the helper
13307c478bdstevel@tonic-gate * action, and the helper action may not access variables that like outside
13317c478bdstevel@tonic-gate * of it.  Helper actions may not load from kernel memory at-large; they are
13327c478bdstevel@tonic-gate * restricting to loading current user state (via copyin() and variants) and
13337c478bdstevel@tonic-gate * scratch space.  As with probe enablings, helper actions are executed in
13347c478bdstevel@tonic-gate * program order.  The result of the helper action is the result of the last
13357c478bdstevel@tonic-gate * executing helper expression.
13367c478bdstevel@tonic-gate *
13377c478bdstevel@tonic-gate * Helpers -- composed of either providers/probes or probes/actions (or both)
13387c478bdstevel@tonic-gate * -- are added by opening the "helper" minor node, and issuing an ioctl(2)
13397c478bdstevel@tonic-gate * (DTRACEHIOC_ADDDOF) that specifies the dof_helper_t structure. This
13407c478bdstevel@tonic-gate * encapsulates the name and base address of the user-level library or
13417c478bdstevel@tonic-gate * executable publishing the helpers and probes as well as the DOF that
13427c478bdstevel@tonic-gate * contains the definitions of those helpers and probes.
13437c478bdstevel@tonic-gate *
13447c478bdstevel@tonic-gate * The DTRACEHIOC_ADD and DTRACEHIOC_REMOVE are left in place for legacy
13457c478bdstevel@tonic-gate * helpers and should no longer be used.  No other ioctls are valid on the
13467c478bdstevel@tonic-gate * helper minor node.
13477c478bdstevel@tonic-gate */
13487c478bdstevel@tonic-gate#define	DTRACEHIOC		(('d' << 24) | ('t' << 16) | ('h' << 8))
13497c478bdstevel@tonic-gate#define	DTRACEHIOC_ADD		(DTRACEHIOC | 1)	/* add helper */
13507c478bdstevel@tonic-gate#define	DTRACEHIOC_REMOVE	(DTRACEHIOC | 2)	/* remove helper */
13517c478bdstevel@tonic-gate#define	DTRACEHIOC_ADDDOF	(DTRACEHIOC | 3)	/* add helper DOF */
13527c478bdstevel@tonic-gate
13537c478bdstevel@tonic-gatetypedef struct dof_helper {
13547c478bdstevel@tonic-gate	char dofhp_mod[DTRACE_MODNAMELEN];	/* executable or library name */
13557c478bdstevel@tonic-gate	uint64_t dofhp_addr;			/* base address of object */
13567c478bdstevel@tonic-gate	uint64_t dofhp_dof;			/* address of helper DOF */
13577c478bdstevel@tonic-gate} dof_helper_t;
13587c478bdstevel@tonic-gate
13597c478bdstevel@tonic-gate#define	DTRACEMNR_DTRACE	"dtrace"	/* node for DTrace ops */
13607c478bdstevel@tonic-gate#define	DTRACEMNR_HELPER	"helper"	/* node for helpers */
13617c478bdstevel@tonic-gate#define	DTRACEMNRN_DTRACE	0		/* minor for DTrace ops */
13627c478bdstevel@tonic-gate#define	DTRACEMNRN_HELPER	1		/* minor for helpers */
13637c478bdstevel@tonic-gate#define	DTRACEMNRN_CLONE	2		/* first clone minor */
13647c478bdstevel@tonic-gate
13657c478bdstevel@tonic-gate#ifdef _KERNEL
13667c478bdstevel@tonic-gate
13677c478bdstevel@tonic-gate/*
13687c478bdstevel@tonic-gate * DTrace Provider API
13697c478bdstevel@tonic-gate *
13707c478bdstevel@tonic-gate * The following functions are implemented by the DTrace framework and are
13717c478bdstevel@tonic-gate * used to implement separate in-kernel DTrace providers.  Common functions
13727c478bdstevel@tonic-gate * are provided in uts/common/os/dtrace.c.  ISA-dependent subroutines are
13737c478bdstevel@tonic-gate * defined in uts/<isa>/dtrace/dtrace_asm.s or uts/<isa>/dtrace/dtrace_isa.c.
13747c478bdstevel@tonic-gate *
13757c478bdstevel@tonic-gate * The provider API has two halves:  the API that the providers consume from
13767c478bdstevel@tonic-gate * DTrace, and the API that providers make available to DTrace.
13777c478bdstevel@tonic-gate *
13787c478bdstevel@tonic-gate * 1 Framework-to-Provider API
13797c478bdstevel@tonic-gate *
13807c478bdstevel@tonic-gate * 1.1  Overview
13817c478bdstevel@tonic-gate *
13827c478bdstevel@tonic-gate * The Framework-to-Provider API is represented by the dtrace_pops structure
13837c478bdstevel@tonic-gate * that the provider passes to the framework when registering itself.  This
13847c478bdstevel@tonic-gate * structure consists of the following members:
13857c478bdstevel@tonic-gate *
13867c478bdstevel@tonic-gate *   dtps_provide()          <-- Provide all probes, all modules
13877c478bdstevel@tonic-gate *   dtps_provide_module()   <-- Provide all probes in specified module
13887c478bdstevel@tonic-gate *   dtps_enable()           <-- Enable specified probe
13897c478bdstevel@tonic-gate *   dtps_disable()          <-- Disable specified probe
13907c478bdstevel@tonic-gate *   dtps_suspend()          <-- Suspend specified probe
13917c478bdstevel@tonic-gate *   dtps_resume()           <-- Resume specified probe
13927c478bdstevel@tonic-gate *   dtps_getargdesc()       <-- Get the argument description for args[X]
13937c478bdstevel@tonic-gate *   dtps_getargval()        <-- Get the value for an argX or args[X] variable
13947d5c9b5Bryan Cantrill *   dtps_mode()             <-- Return the mode of the fired probe
13957c478bdstevel@tonic-gate *   dtps_destroy()          <-- Destroy all state associated with this probe
13967c478bdstevel@tonic-gate *
13977c478bdstevel@tonic-gate * 1.2  void dtps_provide(void *arg, const dtrace_probedesc_t *spec)
13987c478bdstevel@tonic-gate *
13997c478bdstevel@tonic-gate * 1.2.1  Overview
14007c478bdstevel@tonic-gate *
14017c478bdstevel@tonic-gate *   Called to indicate that the provider should provide all probes.  If the
14027c478bdstevel@tonic-gate *   specified description is non-NULL, dtps_provide() is being called because
14037c478bdstevel@tonic-gate *   no probe matched a specified probe -- if the provider has the ability to
14047c478bdstevel@tonic-gate *   create custom probes, it may wish to create a probe that matches the
14057c478bdstevel@tonic-gate *   specified description.
14067c478bdstevel@tonic-gate *
14077c478bdstevel@tonic-gate * 1.2.2  Arguments and notes
14087c478bdstevel@tonic-gate *
14097c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
14107c478bdstevel@tonic-gate *   second argument is a pointer to a probe description that the provider may
14117c478bdstevel@tonic-gate *   wish to consider when creating custom probes.  The provider is expected to
14127c478bdstevel@tonic-gate *   call back into the DTrace framework via dtrace_probe_create() to create
14137c478bdstevel@tonic-gate *   any necessary probes.  dtps_provide() may be called even if the provider
14147c478bdstevel@tonic-gate *   has made available all probes; the provider should check the return value
14157c478bdstevel@tonic-gate *   of dtrace_probe_create() to handle this case.  Note that the provider need
14167c478bdstevel@tonic-gate *   not implement both dtps_provide() and dtps_provide_module(); see
14177c478bdstevel@tonic-gate *   "Arguments and Notes" for dtrace_register(), below.
14187c478bdstevel@tonic-gate *
14197c478bdstevel@tonic-gate * 1.2.3  Return value
14207c478bdstevel@tonic-gate *
14217c478bdstevel@tonic-gate *   None.
14227c478bdstevel@tonic-gate *
14237c478bdstevel@tonic-gate * 1.2.4  Caller's context
14247c478bdstevel@tonic-gate *
14257c478bdstevel@tonic-gate *   dtps_provide() is typically called from open() or ioctl() context, but may
14267c478bdstevel@tonic-gate *   be called from other contexts as well.  The DTrace framework is locked in
14277c478bdstevel@tonic-gate *   such a way that providers may not register or unregister.  This means that
14287c478bdstevel@tonic-gate *   the provider may not call any DTrace API that affects its registration with
14297c478bdstevel@tonic-gate *   the framework, including dtrace_register(), dtrace_unregister(),
14307c478bdstevel@tonic-gate *   dtrace_invalidate(), and dtrace_condense().  However, the context is such
14317c478bdstevel@tonic-gate *   that the provider may (and indeed, is expected to) call probe-related
14327c478bdstevel@tonic-gate *   DTrace routines, including dtrace_probe_create(), dtrace_probe_lookup(),
14337c478bdstevel@tonic-gate *   and dtrace_probe_arg().
14347c478bdstevel@tonic-gate *
14357c478bdstevel@tonic-gate * 1.3  void dtps_provide_module(void *arg, struct modctl *mp)
14367c478bdstevel@tonic-gate *
14377c478bdstevel@tonic-gate * 1.3.1  Overview
14387c478bdstevel@tonic-gate *
14397c478bdstevel@tonic-gate *   Called to indicate that the provider should provide all probes in the
14407c478bdstevel@tonic-gate *   specified module.
14417c478bdstevel@tonic-gate *
14427c478bdstevel@tonic-gate * 1.3.2  Arguments and notes
14437c478bdstevel@tonic-gate *
14447c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
14457c478bdstevel@tonic-gate *   second argument is a pointer to a modctl structure that indicates the
14467c478bdstevel@tonic-gate *   module for which probes should be created.
14477c478bdstevel@tonic-gate *
14487c478bdstevel@tonic-gate * 1.3.3  Return value
14497c478bdstevel@tonic-gate *
14507c478bdstevel@tonic-gate *   None.
14517c478bdstevel@tonic-gate *
14527c478bdstevel@tonic-gate * 1.3.4  Caller's context
14537c478bdstevel@tonic-gate *
14547c478bdstevel@tonic-gate *   dtps_provide_module() may be called from open() or ioctl() context, but
14557c478bdstevel@tonic-gate *   may also be called from a module loading context.  mod_lock is held, and
14567c478bdstevel@tonic-gate *   the DTrace framework is locked in such a way that providers may not
14577c478bdstevel@tonic-gate *   register or unregister.  This means that the provider may not call any
14587c478bdstevel@tonic-gate *   DTrace API that affects its registration with the framework, including
14597c478bdstevel@tonic-gate *   dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and
14607c478bdstevel@tonic-gate *   dtrace_condense().  However, the context is such that the provider may (and
14617c478bdstevel@tonic-gate *   indeed, is expected to) call probe-related DTrace routines, including
14627c478bdstevel@tonic-gate *   dtrace_probe_create(), dtrace_probe_lookup(), and dtrace_probe_arg().  Note
14637c478bdstevel@tonic-gate *   that the provider need not implement both dtps_provide() and
14647c478bdstevel@tonic-gate *   dtps_provide_module(); see "Arguments and Notes" for dtrace_register(),
14657c478bdstevel@tonic-gate *   below.
14667c478bdstevel@tonic-gate *
1467b9e93c1Jonathan Haslam * 1.4  int dtps_enable(void *arg, dtrace_id_t id, void *parg)
14687c478bdstevel@tonic-gate *
14697c478bdstevel@tonic-gate * 1.4.1  Overview
14707c478bdstevel@tonic-gate *
14717c478bdstevel@tonic-gate *   Called to enable the specified probe.
14727c478bdstevel@tonic-gate *
14737c478bdstevel@tonic-gate * 1.4.2  Arguments and notes
14747c478bdstevel@tonic-gate *
14757c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
14767c478bdstevel@tonic-gate *   second argument is the identifier of the probe to be enabled.  The third
14777c478bdstevel@tonic-gate *   argument is the probe argument as passed to dtrace_probe_create().
14787c478bdstevel@tonic-gate *   dtps_enable() will be called when a probe transitions from not being
14797c478bdstevel@tonic-gate *   enabled at all to having one or more ECB.  The number of ECBs associated
14807c478bdstevel@tonic-gate *   with the probe may change without subsequent calls into the provider.
14817c478bdstevel@tonic-gate *   When the number of ECBs drops to zero, the provider will be explicitly
14827c478bdstevel@tonic-gate *   told to disable the probe via dtps_disable().  dtrace_probe() should never
14837c478bdstevel@tonic-gate *   be called for a probe identifier that hasn't been explicitly enabled via
14847c478bdstevel@tonic-gate *   dtps_enable().
14857c478bdstevel@tonic-gate *
14867c478bdstevel@tonic-gate * 1.4.3  Return value
14877c478bdstevel@tonic-gate *
1488b9e93c1Jonathan Haslam *   On success, dtps_enable() should return 0. On failure, -1 should be
1489b9e93c1Jonathan Haslam *   returned.
14907c478bdstevel@tonic-gate *
14917c478bdstevel@tonic-gate * 1.4.4  Caller's context
14927c478bdstevel@tonic-gate *
14937c478bdstevel@tonic-gate *   The DTrace framework is locked in such a way that it may not be called
14947c478bdstevel@tonic-gate *   back into at all.  cpu_lock is held.  mod_lock is not held and may not
14957c478bdstevel@tonic-gate *   be acquired.
14967c478bdstevel@tonic-gate *
14977c478bdstevel@tonic-gate * 1.5  void dtps_disable(void *arg, dtrace_id_t id, void *parg)
14987c478bdstevel@tonic-gate *
14997c478bdstevel@tonic-gate * 1.5.1  Overview
15007c478bdstevel@tonic-gate *
15017c478bdstevel@tonic-gate *   Called to disable the specified probe.
15027c478bdstevel@tonic-gate *
15037c478bdstevel@tonic-gate * 1.5.2  Arguments and notes
15047c478bdstevel@tonic-gate *
15057c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
15067c478bdstevel@tonic-gate *   second argument is the identifier of the probe to be disabled.  The third
15077c478bdstevel@tonic-gate *   argument is the probe argument as passed to dtrace_probe_create().
15087c478bdstevel@tonic-gate *   dtps_disable() will be called when a probe transitions from being enabled
15097c478bdstevel@tonic-gate *   to having zero ECBs.  dtrace_probe() should never be called for a probe
15107c478bdstevel@tonic-gate *   identifier that has been explicitly enabled via dtps_disable().
15117c478bdstevel@tonic-gate *
15127c478bdstevel@tonic-gate * 1.5.3  Return value
15137c478bdstevel@tonic-gate *
15147c478bdstevel@tonic-gate *   None.
15157c478bdstevel@tonic-gate *
15167c478bdstevel@tonic-gate * 1.5.4  Caller's context
15177c478bdstevel@tonic-gate *
15187c478bdstevel@tonic-gate *   The DTrace framework is locked in such a way that it may not be called
15197c478bdstevel@tonic-gate *   back into at all.  cpu_lock is held.  mod_lock is not held and may not
15207c478bdstevel@tonic-gate *   be acquired.
15217c478bdstevel@tonic-gate *
15227c478bdstevel@tonic-gate * 1.6  void dtps_suspend(void *arg, dtrace_id_t id, void *parg)
15237c478bdstevel@tonic-gate *
15247c478bdstevel@tonic-gate * 1.6.1  Overview
15257c478bdstevel@tonic-gate *
15267c478bdstevel@tonic-gate *   Called to suspend the specified enabled probe.  This entry point is for
15277c478bdstevel@tonic-gate *   providers that may need to suspend some or all of their probes when CPUs
15287c478bdstevel@tonic-gate *   are being powered on or when the boot monitor is being entered for a
15297c478bdstevel@tonic-gate *   prolonged period of time.
15307c478bdstevel@tonic-gate *
15317c478bdstevel@tonic-gate * 1.6.2  Arguments and notes
15327c478bdstevel@tonic-gate *
15337c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
15347c478bdstevel@tonic-gate *   second argument is the identifier of the probe to be suspended.  The
15357c478bdstevel@tonic-gate *   third argument is the probe argument as passed to dtrace_probe_create().
15367c478bdstevel@tonic-gate *   dtps_suspend will only be called on an enabled probe.  Providers that
15377c478bdstevel@tonic-gate *   provide a dtps_suspend entry point will want to take roughly the action
15387c478bdstevel@tonic-gate *   that it takes for dtps_disable.
15397c478bdstevel@tonic-gate *
15407c478bdstevel@tonic-gate * 1.6.3  Return value
15417c478bdstevel@tonic-gate *
15427c478bdstevel@tonic-gate *   None.
15437c478bdstevel@tonic-gate *
15447c478bdstevel@tonic-gate * 1.6.4  Caller's context
15457c478bdstevel@tonic-gate *
15467c478bdstevel@tonic-gate *   Interrupts are disabled.  The DTrace framework is in a state such that the
15477c478bdstevel@tonic-gate *   specified probe cannot be disabled or destroyed for the duration of
15487c478bdstevel@tonic-gate *   dtps_suspend().  As interrupts are disabled, the provider is afforded
15497c478bdstevel@tonic-gate *   little latitude; the provider is expected to do no more than a store to
15507c478bdstevel@tonic-gate *   memory.
15517c478bdstevel@tonic-gate *
15527c478bdstevel@tonic-gate * 1.7  void dtps_resume(void *arg, dtrace_id_t id, void *parg)
15537c478bdstevel@tonic-gate *
15547c478bdstevel@tonic-gate * 1.7.1  Overview
15557c478bdstevel@tonic-gate *
15567c478bdstevel@tonic-gate *   Called to resume the specified enabled probe.  This entry point is for
15577c478bdstevel@tonic-gate *   providers that may need to resume some or all of their probes after the
15587c478bdstevel@tonic-gate *   completion of an event that induced a call to dtps_suspend().
15597c478bdstevel@tonic-gate *
15607c478bdstevel@tonic-gate * 1.7.2  Arguments and notes
15617c478bdstevel@tonic-gate *
15627c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
15637c478bdstevel@tonic-gate *   second argument is the identifier of the probe to be resumed.  The
15647c478bdstevel@tonic-gate *   third argument is the probe argument as passed to dtrace_probe_create().
15657c478bdstevel@tonic-gate *   dtps_resume will only be called on an enabled probe.  Providers that
15667c478bdstevel@tonic-gate *   provide a dtps_resume entry point will want to take roughly the action
15677c478bdstevel@tonic-gate *   that it takes for dtps_enable.
15687c478bdstevel@tonic-gate *
15697c478bdstevel@tonic-gate * 1.7.3  Return value
15707c478bdstevel@tonic-gate *
15717c478bdstevel@tonic-gate *   None.
15727c478bdstevel@tonic-gate *
15737c478bdstevel@tonic-gate * 1.7.4  Caller's context
15747c478bdstevel@tonic-gate *
15757c478bdstevel@tonic-gate *   Interrupts are disabled.  The DTrace framework is in a state such that the
15767c478bdstevel@tonic-gate *   specified probe cannot be disabled or destroyed for the duration of
15777c478bdstevel@tonic-gate *   dtps_resume().  As interrupts are disabled, the provider is afforded
15787c478bdstevel@tonic-gate *   little latitude; the provider is expected to do no more than a store to
15797c478bdstevel@tonic-gate *   memory.
15807c478bdstevel@tonic-gate *
15817c478bdstevel@tonic-gate * 1.8  void dtps_getargdesc(void *arg, dtrace_id_t id, void *parg,
15827c478bdstevel@tonic-gate *           dtrace_argdesc_t *desc)
15837c478bdstevel@tonic-gate *
15847c478bdstevel@tonic-gate * 1.8.1  Overview
15857c478bdstevel@tonic-gate *
15867c478bdstevel@tonic-gate *   Called to retrieve the argument description for an args[X] variable.
15877c478bdstevel@tonic-gate *
15887c478bdstevel@tonic-gate * 1.8.2  Arguments and notes
15897c478bdstevel@tonic-gate *
15907c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register(). The
15917c478bdstevel@tonic-gate *   second argument is the identifier of the current probe. The third
15927c478bdstevel@tonic-gate *   argument is the probe argument as passed to dtrace_probe_create(). The
15937c478bdstevel@tonic-gate *   fourth argument is a pointer to the argument description.  This
15947c478bdstevel@tonic-gate *   description is both an input and output parameter:  it contains the
15957c478bdstevel@tonic-gate *   index of the desired argument in the dtargd_ndx field, and expects
15967c478bdstevel@tonic-gate *   the other fields to be filled in upon return.  If there is no argument
15977c478bdstevel@tonic-gate *   corresponding to the specified index, the dtargd_ndx field should be set
15987c478bdstevel@tonic-gate *   to DTRACE_ARGNONE.
15997c478bdstevel@tonic-gate *
16007c478bdstevel@tonic-gate * 1.8.3  Return value
16017c478bdstevel@tonic-gate *
16027c478bdstevel@tonic-gate *   None.  The dtargd_ndx, dtargd_native, dtargd_xlate and dtargd_mapping
16037c478bdstevel@tonic-gate *   members of the dtrace_argdesc_t structure are all output values.
16047c478bdstevel@tonic-gate *
16057c478bdstevel@tonic-gate * 1.8.4  Caller's context
16067c478bdstevel@tonic-gate *
16077c478bdstevel@tonic-gate *   dtps_getargdesc() is called from ioctl() context. mod_lock is held, and
16087c478bdstevel@tonic-gate *   the DTrace framework is locked in such a way that providers may not
16097c478bdstevel@tonic-gate *   register or unregister.  This means that the provider may not call any
16107c478bdstevel@tonic-gate *   DTrace API that affects its registration with the framework, including
16117c478bdstevel@tonic-gate *   dtrace_register(), dtrace_unregister(), dtrace_invalidate(), and
16127c478bdstevel@tonic-gate *   dtrace_condense().
16137c478bdstevel@tonic-gate *
16147c478bdstevel@tonic-gate * 1.9  uint64_t dtps_getargval(void *arg, dtrace_id_t id, void *parg,
16157c478bdstevel@tonic-gate *               int argno, int aframes)
16167c478bdstevel@tonic-gate *
16177c478bdstevel@tonic-gate * 1.9.1  Overview
16187c478bdstevel@tonic-gate *
16197c478bdstevel@tonic-gate *   Called to retrieve a value for an argX or args[X] variable.
16207c478bdstevel@tonic-gate *
16217c478bdstevel@tonic-gate * 1.9.2  Arguments and notes
16227c478bdstevel@tonic-gate *
16237c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register(). The
16247c478bdstevel@tonic-gate *   second argument is the identifier of the current probe. The third
16257c478bdstevel@tonic-gate *   argument is the probe argument as passed to dtrace_probe_create(). The
16267c478bdstevel@tonic-gate *   fourth argument is the number of the argument (the X in the example in
16277c478bdstevel@tonic-gate *   1.9.1). The fifth argument is the number of stack frames that were used
16287c478bdstevel@tonic-gate *   to get from the actual place in the code that fired the probe to
16297c478bdstevel@tonic-gate *   dtrace_probe() itself, the so-called artificial frames. This argument may
16307c478bdstevel@tonic-gate *   be used to descend an appropriate number of frames to find the correct
16317c478bdstevel@tonic-gate *   values. If this entry point is left NULL, the dtrace_getarg() built-in
16327c478bdstevel@tonic-gate *   function is used.
16337c478bdstevel@tonic-gate *
16347c478bdstevel@tonic-gate * 1.9.3  Return value
16357c478bdstevel@tonic-gate *
16367c478bdstevel@tonic-gate *   The value of the argument.
16377c478bdstevel@tonic-gate *
16387c478bdstevel@tonic-gate * 1.9.4  Caller's context
16397c478bdstevel@tonic-gate *
16407c478bdstevel@tonic-gate *   This is called from within dtrace_probe() meaning that interrupts
16417c478bdstevel@tonic-gate *   are disabled. No locks should be taken within this entry point.
16427c478bdstevel@tonic-gate *
16437d5c9b5Bryan Cantrill * 1.10  int dtps_mode(void *arg, dtrace_id_t id, void *parg)
16447c478bdstevel@tonic-gate *
16457c478bdstevel@tonic-gate * 1.10.1  Overview
16467c478bdstevel@tonic-gate *
16477d5c9b5Bryan Cantrill *   Called to determine the mode of a fired probe.
16487c478bdstevel@tonic-gate *
16497c478bdstevel@tonic-gate * 1.10.2  Arguments and notes
16507c478bdstevel@tonic-gate *
16517c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register(). The
16527d5c9b5Bryan Cantrill *   second argument is the identifier of the current probe.  The third
16537c478bdstevel@tonic-gate *   argument is the probe argument as passed to dtrace_probe_create().  This
16547c478bdstevel@tonic-gate *   entry point must not be left NULL for providers whose probes allow for
16557d5c9b5Bryan Cantrill *   mixed mode tracing, that is to say those unanchored probes that can fire
16567d5c9b5Bryan Cantrill *   during kernel- or user-mode execution.
16577c478bdstevel@tonic-gate *
16587c478bdstevel@tonic-gate * 1.10.3  Return value
16597c478bdstevel@tonic-gate *
16607d5c9b5Bryan Cantrill *   A bitwise OR that encapsulates both the mode (either DTRACE_MODE_KERNEL
16617d5c9b5Bryan Cantrill *   or DTRACE_MODE_USER) and the policy when the privilege of the enabling
1662b0f673cBryan Cantrill *   is insufficient for that mode (a combination of DTRACE_MODE_NOPRIV_DROP,
1663b0f673cBryan Cantrill *   DTRACE_MODE_NOPRIV_RESTRICT, and DTRACE_MODE_LIMITEDPRIV_RESTRICT).  If
1664b0f673cBryan Cantrill *   DTRACE_MODE_NOPRIV_DROP bit is set, insufficient privilege will result
1665b0f673cBryan Cantrill *   in the probe firing being silently ignored for the enabling; if the
1666b0f673cBryan Cantrill *   DTRACE_NODE_NOPRIV_RESTRICT bit is set, insufficient privilege will not
1667b0f673cBryan Cantrill *   prevent probe processing for the enabling, but restrictions will be in
1668b0f673cBryan Cantrill *   place that induce a UPRIV fault upon attempt to examine probe arguments
1669b0f673cBryan Cantrill *   or current process state.  If the DTRACE_MODE_LIMITEDPRIV_RESTRICT bit
1670b0f673cBryan Cantrill *   is set, similar restrictions will be placed upon operation if the
1671b0f673cBryan Cantrill *   privilege is sufficient to process the enabling, but does not otherwise
1672b0f673cBryan Cantrill *   entitle the enabling to all zones.  The DTRACE_MODE_NOPRIV_DROP and
1673b0f673cBryan Cantrill *   DTRACE_MODE_NOPRIV_RESTRICT are mutually exclusive (and one of these
1674b0f673cBryan Cantrill *   two policies must be specified), but either may be combined (or not)
1675b0f673cBryan Cantrill *   with DTRACE_MODE_LIMITEDPRIV_RESTRICT.
16767c478bdstevel@tonic-gate *
16777c478bdstevel@tonic-gate * 1.10.4  Caller's context
16787c478bdstevel@tonic-gate *
16797c478bdstevel@tonic-gate *   This is called from within dtrace_probe() meaning that interrupts
16807c478bdstevel@tonic-gate *   are disabled. No locks should be taken within this entry point.
16817c478bdstevel@tonic-gate *
16827c478bdstevel@tonic-gate * 1.11 void dtps_destroy(void *arg, dtrace_id_t id, void *parg)
16837c478bdstevel@tonic-gate *
16847c478bdstevel@tonic-gate * 1.11.1 Overview
16857c478bdstevel@tonic-gate *
16867c478bdstevel@tonic-gate *   Called to destroy the specified probe.
16877c478bdstevel@tonic-gate *
16887c478bdstevel@tonic-gate * 1.11.2 Arguments and notes
16897c478bdstevel@tonic-gate *
16907c478bdstevel@tonic-gate *   The first argument is the cookie as passed to dtrace_register().  The
16917c478bdstevel@tonic-gate *   second argument is the identifier of the probe to be destroyed.  The third
16927c478bdstevel@tonic-gate *   argument is the probe argument as passed to dtrace_probe_create().  The
16937c478bdstevel@tonic-gate *   provider should free all state associated with the probe.  The framework
16947c478bdstevel@tonic-gate *   guarantees that dtps_destroy() is only called for probes that have either
16957c478bdstevel@tonic-gate *   been disabled via dtps_disable() or were never enabled via dtps_enable().
16967c478bdstevel@tonic-gate *   Once dtps_disable() has been called for a probe, no further call will be
16977c478bdstevel@tonic-gate *   made specifying the probe.
16987c478bdstevel@tonic-gate *
16997c478bdstevel@tonic-gate * 1.11.3 Return value
17007c478bdstevel@tonic-gate *
17017c478bdstevel@tonic-gate *   None.
17027c478bdstevel@tonic-gate *
17037c478bdstevel@tonic-gate * 1.11.4 Caller's context
17047c478bdstevel@tonic-gate *
17057c478bdstevel@tonic-gate *   The DTrace framework is locked in such a way that it may not be called
17067c478bdstevel@tonic-gate *   back into at all.  mod_lock is held.  cpu_lock is not held, and may not be
17077c478bdstevel@tonic-gate *   acquired.
17087c478bdstevel@tonic-gate *
17097c478bdstevel@tonic-gate *
17107c478bdstevel@tonic-gate * 2 Provider-to-Framework API
17117c478bdstevel@tonic-gate *
17127c478bdstevel@tonic-gate * 2.1  Overview
17137c478bdstevel@tonic-gate *
17147c478bdstevel@tonic-gate * The Provider-to-Framework API provides the mechanism for the provider to
17157c478bdstevel@tonic-gate * register itself with the DTrace framework, to create probes, to lookup
17167c478bdstevel@tonic-gate * probes and (most importantly) to fire probes.  The Provider-to-Framework
17177c478bdstevel@tonic-gate * consists of:
17187c478bdstevel@tonic-gate *
17197c478bdstevel@tonic-gate *   dtrace_register()       <-- Register a provider with the DTrace framework
17207c478bdstevel@tonic-gate *   dtrace_unregister()     <-- Remove a provider's DTrace registration
17217c478bdstevel@tonic-gate *   dtrace_invalidate()     <-- Invalidate the specified provider
17227c478bdstevel@tonic-gate *   dtrace_condense()       <-- Remove a provider's unenabled probes
17237c478bdstevel@tonic-gate *   dtrace_attached()       <-- Indicates whether or not DTrace has attached
17247c478bdstevel@tonic-gate *   dtrace_probe_create()   <-- Create a DTrace probe
17257c478bdstevel@tonic-gate *   dtrace_probe_lookup()   <-- Lookup a DTrace probe based on its name
17267c478bdstevel@tonic-gate *   dtrace_probe_arg()      <-- Return the probe argument for a specific probe
17277c478bdstevel@tonic-gate *   dtrace_probe()          <-- Fire the specified probe
17287c478bdstevel@tonic-gate *
17297c478bdstevel@tonic-gate * 2.2  int dtrace_register(const char *name, const dtrace_pattr_t *pap,
1730ad4023cdp *          uint32_t priv, cred_t *cr, const dtrace_pops_t *pops, void *arg,
17317c478bdstevel@tonic-gate *          dtrace_provider_id_t *idp)
17327c478bdstevel@tonic-gate *
17337c478bdstevel@tonic-gate * 2.2.1  Overview
17347c478bdstevel@tonic-gate *
17357c478bdstevel@tonic-gate *   dtrace_register() registers the calling provider with the DTrace
17367c478bdstevel@tonic-gate *   framework.  It should generally be called by DTrace providers in their
17377c478bdstevel@tonic-gate *   attach(9E) entry point.
17387c478bdstevel@tonic-gate *
17397c478bdstevel@tonic-gate * 2.2.2  Arguments and Notes
17407c478bdstevel@tonic-gate *
17417c478bdstevel@tonic-gate *   The first argument is the name of the provider.  The second argument is a
17427c478bdstevel@tonic-gate *   pointer to the stability attributes for the provider.  The third argument
17437c478bdstevel@tonic-gate *   is the privilege flags for the provider, and must be some combination of:
17447c478bdstevel@tonic-gate *
17457c478bdstevel@tonic-gate *     DTRACE_PRIV_NONE     <= All users may enable probes from this provider
17467c478bdstevel@tonic-gate *
17477c478bdstevel@tonic-gate *     DTRACE_PRIV_PROC     <= Any user with privilege of PRIV_DTRACE_PROC may
17487c478bdstevel@tonic-gate *                             enable probes from this provider
17497c478bdstevel@tonic-gate *
17507c478bdstevel@tonic-gate *     DTRACE_PRIV_USER     <= Any user with privilege of PRIV_DTRACE_USER may
17517c478bdstevel@tonic-gate *                             enable probes from this provider
17527c478bdstevel@tonic-gate *
17537c478bdstevel@tonic-gate *     DTRACE_PRIV_KERNEL   <= Any user with privilege of PRIV_DTRACE_KERNEL
17547c478bdstevel@tonic-gate *                             may enable probes from this provider
17557c478bdstevel@tonic-gate *
17567c478bdstevel@tonic-gate *     DTRACE_PRIV_OWNER    <= This flag places an additional constraint on
17577c478bdstevel@tonic-gate *                             the privilege requirements above. These probes
17587c478bdstevel@tonic-gate *                             require either (a) a user ID matching the user
1759ad4023cdp *                             ID of the cred passed in the fourth argument
1760ad4023cdp *                             or (b) the PRIV_PROC_OWNER privilege.
1761ad4023cdp *
1762ad4023cdp *     DTRACE_PRIV_ZONEOWNER<= This flag places an additional constraint on
1763ad4023cdp *                             the privilege requirements above. These probes
1764ad4023cdp *                             require either (a) a zone ID matching the zone
1765ad4023cdp *                             ID of the cred passed in the fourth argument
1766ad4023cdp *                             or (b) the PRIV_PROC_ZONE privilege.
17677c478bdstevel@tonic-gate *
17687c478bdstevel@tonic-gate *   Note that these flags designate the _visibility_ of the probes, not
17697c478bdstevel@tonic-gate *   the conditions under which they may or may not fire.
17707c478bdstevel@tonic-gate *
1771ad4023cdp *   The fourth argument is the credential that is associated with the
1772ad4023cdp *   provider.  This argument should be NULL if the privilege flags don't
1773ad4023cdp *   include DTRACE_PRIV_OWNER or DTRACE_PRIV_ZONEOWNER.  If non-NULL, the
1774ad4023cdp *   framework stashes the uid and zoneid represented by this credential
1775ad4023cdp *   for use at probe-time, in implicit predicates.  These limit visibility
1776ad4023cdp *   of the probes to users and/or zones which have sufficient privilege to
1777ad4023cdp *   access them.
17787c478bdstevel@tonic-gate *
17797c478bdstevel@tonic-gate *   The fifth argument is a DTrace provider operations vector, which provides
17807c478bdstevel@tonic-gate *   the implementation for the Framework-to-Provider API.  (See Section 1,
17817c478bdstevel@tonic-gate *   above.)  This must be non-NULL, and each member must be non-NULL.  The
17827c478bdstevel@tonic-gate *   exceptions to this are (1) the dtps_provide() and dtps_provide_module()
17837c478bdstevel@tonic-gate *   members (if the provider so desires, _one_ of these members may be left
17847c478bdstevel@tonic-gate *   NULL -- denoting that the provider only implements the other) and (2)
17857c478bdstevel@tonic-gate *   the dtps_suspend() and dtps_resume() members, which must either both be
17867c478bdstevel@tonic-gate *   NULL or both be non-NULL.
17877c478bdstevel@tonic-gate *
17887c478bdstevel@tonic-gate *   The sixth argument is a cookie to be specified as the first argument for
17897c478bdstevel@tonic-gate *   each function in the Framework-to-Provider API.  This argument may have
17907c478bdstevel@tonic-gate *   any value.
17917c478bdstevel@tonic-gate *
17927c478bdstevel@tonic-gate *   The final argument is a pointer to dtrace_provider_id_t.  If
17937c478bdstevel@tonic-gate *   dtrace_register() successfully completes, the provider identifier will be
17947c478bdstevel@tonic-gate *   stored in the memory pointed to be this argument.  This argument must be
17957c478bdstevel@tonic-gate *   non-NULL.
17967c478bdstevel@tonic-gate *
17977c478bdstevel@tonic-gate * 2.2.3  Return value
17987c478bdstevel@tonic-gate *
17997c478bdstevel@tonic-gate *   On success, dtrace_register() returns 0 and stores the new provider's
18007c478bdstevel@tonic-gate *   identifier into the memory pointed to by the idp argument.  On failure,
18017c478bdstevel@tonic-gate *   dtrace_register() returns an errno:
18027c478bdstevel@tonic-gate *
18037c478bdstevel@tonic-gate *     EINVAL   The arguments passed to dtrace_register() were somehow invalid.
18047c478bdstevel@tonic-gate *              This may because a parameter that must be non-NULL was NULL,
18057c478bdstevel@tonic-gate *              because the name was invalid (either empty or an illegal
18067c478bdstevel@tonic-gate *              provider name) or because the attributes were invalid.
18077c478bdstevel@tonic-gate *
18087c478bdstevel@tonic-gate *   No other failure code is returned.
18097c478bdstevel@tonic-gate *
18107c478bdstevel@tonic-gate * 2.2.4  Caller's context
18117c478bdstevel@tonic-gate *
18127c478bdstevel@tonic-gate *   dtrace_register() may induce calls to dtrace_provide(); the provider must
18137c478bdstevel@tonic-gate *   hold no locks across dtrace_register() that may also be acquired by
18147c478bdstevel@tonic-gate *   dtrace_provide().  cpu_lock and mod_lock must not be held.
18157c478bdstevel@tonic-gate *
18167c478bdstevel@tonic-gate * 2.3  int dtrace_unregister(dtrace_provider_t id)
18177c478bdstevel@tonic-gate *
18187c478bdstevel@tonic-gate * 2.3.1  Overview
18197c478bdstevel@tonic-gate *
18207c478bdstevel@tonic-gate *   Unregisters the specified provider from the DTrace framework.  It should
18217c478bdstevel@tonic-gate *   generally be called by DTrace providers in their detach(9E) entry point.
18227c478bdstevel@tonic-gate *
18237c478bdstevel@tonic-gate * 2.3.2  Arguments and Notes
18247c478bdstevel@tonic-gate *
18257c478bdstevel@tonic-gate *   The only argument is the provider identifier, as returned from a
18267c478bdstevel@tonic-gate *   successful call to dtrace_register().  As a result of calling
18277c478bdstevel@tonic-gate *   dtrace_unregister(), the DTrace framework will call back into the provider
18287c478bdstevel@tonic-gate *   via the dtps_destroy() entry point.  Once dtrace_unregister() successfully
18297c478bdstevel@tonic-gate *   completes, however, the DTrace framework will no longer make calls through
18307c478bdstevel@tonic-gate *   the Framework-to-Provider API.
18317c478bdstevel@tonic-gate *
18327c478bdstevel@tonic-gate * 2.3.3  Return value
18337c478bdstevel@tonic-gate *
18347c478bdstevel@tonic-gate *   On success, dtrace_unregister returns 0.  On failure, dtrace_unregister()
18357c478bdstevel@tonic-gate *   returns an errno:
18367c478bdstevel@tonic-gate *
18377c478bdstevel@tonic-gate *     EBUSY    There are currently processes that have the DTrace pseudodevice
18387c478bdstevel@tonic-gate *              open, or there exists an anonymous enabling that hasn't yet
18397c478bdstevel@tonic-gate *              been claimed.
18407c478bdstevel@tonic-gate *
18417c478bdstevel@tonic-gate *   No other failure code is returned.
18427c478bdstevel@tonic-gate *
18437c478bdstevel@tonic-gate * 2.3.4  Caller's context
18447c478bdstevel@tonic-gate *
18457c478bdstevel@tonic-gate *   Because a call to dtrace_unregister() may induce calls through the
18467c478bdstevel@tonic-gate *   Framework-to-Provider API, the caller may not hold any lock across
18477c478bdstevel@tonic-gate *   dtrace_register() that is also acquired in any of the Framework-to-
18487c478bdstevel@tonic-gate *   Provider API functions.  Additionally, mod_lock may not be held.
18497c478bdstevel@tonic-gate *
18507c478bdstevel@tonic-gate * 2.4  void dtrace_invalidate(dtrace_provider_id_t id)
18517c478bdstevel@tonic-gate *
18527c478bdstevel@tonic-gate * 2.4.1  Overview
18537c478bdstevel@tonic-gate *
18547c478bdstevel@tonic-gate *   Invalidates the specified provider.  All subsequent probe lookups for the
18557c478bdstevel@tonic-gate *   specified provider will fail, but its probes will not be removed.
18567c478bdstevel@tonic-gate *
18577c478bdstevel@tonic-gate * 2.4.2  Arguments and note
18587c478bdstevel@tonic-gate *
18597c478bdstevel@tonic-gate *   The only argument is the provider identifier, as returned from a
18607c478bdstevel@tonic-gate *   successful call to dtrace_register().  In general, a provider's probes
18617c478bdstevel@tonic-gate *   always remain valid; dtrace_invalidate() is a mechanism for invalidating
18627c478bdstevel@tonic-gate *   an entire provider, regardless of whether or not probes are enabled or
18637c478bdstevel@tonic-gate *   not.  Note that dtrace_invalidate() will _not_ prevent already enabled
18647c478bdstevel@tonic-gate *   probes from firing -- it will merely prevent any new enablings of the
18657c478bdstevel@tonic-gate *   provider's probes.
18667c478bdstevel@tonic-gate *
18677c478bdstevel@tonic-gate * 2.5 int dtrace_condense(dtrace_provider_id_t id)
18687c478bdstevel@tonic-gate *
18697c478bdstevel@tonic-gate * 2.5.1  Overview
18707c478bdstevel@tonic-gate *
18717c478bdstevel@tonic-gate *   Removes all the unenabled probes for the given provider. This function is
18727c478bdstevel@tonic-gate *   not unlike dtrace_unregister(), except that it doesn't remove the
18737c478bdstevel@tonic-gate *   provider just as many of its associated probes as it can.
18747c478bdstevel@tonic-gate *
18757c478bdstevel@tonic-gate * 2.5.2  Arguments and Notes
18767c478bdstevel@tonic-gate *
18777c478bdstevel@tonic-gate *   As with dtrace_unregister(), the sole argument is the provider identifier
18787c478bdstevel@tonic-gate *   as returned from a successful call to dtrace_register().  As a result of
18797c478bdstevel@tonic-gate *   calling dtrace_condense(), the DTrace framework will call back into the
18807c478bdstevel@tonic-gate *   given provider's dtps_destroy() entry point for each of the provider's
18817c478bdstevel@tonic-gate *   unenabled probes.
18827c478bdstevel@tonic-gate *
18837c478bdstevel@tonic-gate * 2.5.3  Return value
18847c478bdstevel@tonic-gate *
18857c478bdstevel@tonic-gate *   Currently, dtrace_condense() always returns 0.  However, consumers of this
18867c478bdstevel@tonic-gate *   function should check the return value as appropriate; its behavior may
18877c478bdstevel@tonic-gate *   change in the future.
18887c478bdstevel@tonic-gate *
18897c478bdstevel@tonic-gate * 2.5.4  Caller's context
18907c478bdstevel@tonic-gate *
18917c478bdstevel@tonic-gate *   As with dtrace_unregister(), the caller may not hold any lock across
18927c478bdstevel@tonic-gate *   dtrace_condense() that is also acquired in the provider's entry points.
18937c478bdstevel@tonic-gate *   Also, mod_lock may not be held.
18947c478bdstevel@tonic-gate *
18957c478bdstevel@tonic-gate * 2.6 int dtrace_attached()
18967c478bdstevel@tonic-gate *
18977c478bdstevel@tonic-gate * 2.6.1  Overview
18987c478bdstevel@tonic-gate *
18997c478bdstevel@tonic-gate *   Indicates whether or not DTrace has attached.
19007c478bdstevel@tonic-gate *
19017c478bdstevel@tonic-gate * 2.6.2  Arguments and Notes
19027c478bdstevel@tonic-gate *
19037c478bdstevel@tonic-gate *   For most providers, DTrace makes initial contact beyond registration.
19047c478bdstevel@tonic-gate *   That is, once a provider has registered with DTrace, it waits to hear
19057c478bdstevel@tonic-gate *   from DTrace to create probes.  However, some providers may wish to
19067c478bdstevel@tonic-gate *   proactively create probes without first being told by DTrace to do so.
19077c478bdstevel@tonic-gate *   If providers wish to do this, they must first call dtrace_attached() to
19087c478bdstevel@tonic-gate *   determine if DTrace itself has attached.  If dtrace_attached() returns 0,
19097c478bdstevel@tonic-gate *   the provider must not make any other Provider-to-Framework API call.
19107c478bdstevel@tonic-gate *
19117c478bdstevel@tonic-gate * 2.6.3  Return value
19127c478bdstevel@tonic-gate *
19137c478bdstevel@tonic-gate *   dtrace_attached() returns 1 if DTrace has attached, 0 otherwise.
19147c478bdstevel@tonic-gate *
19157c478bdstevel@tonic-gate * 2.7  int dtrace_probe_create(dtrace_provider_t id, const char *mod,
19167c478bdstevel@tonic-gate *	    const char *func, const char *name, int aframes, void *arg)
19177c478bdstevel@tonic-gate *
19187c478bdstevel@tonic-gate * 2.7.1  Overview
19197c478bdstevel@tonic-gate *
19207c478bdstevel@tonic-gate *   Creates a probe with specified module name, function name, and name.
19217c478bdstevel@tonic-gate *
19227c478bdstevel@tonic-gate * 2.7.2  Arguments and Notes
19237c478bdstevel@tonic-gate *
19247c478bdstevel@tonic-gate *   The first argument is the provider identifier, as returned from a
19257c478bdstevel@tonic-gate *   successful call to dtrace_register().  The second, third, and fourth
19267c478bdstevel@tonic-gate *   arguments are the module name, function name, and probe name,
19277c478bdstevel@tonic-gate *   respectively.  Of these, module name and function name may both be NULL
19287c478bdstevel@tonic-gate *   (in which case the probe is considered to be unanchored), or they may both
19297c478bdstevel@tonic-gate *   be non-NULL.  The name must be non-NULL, and must point to a non-empty
19307c478bdstevel@tonic-gate *   string.
19317c478bdstevel@tonic-gate *
19327c478bdstevel@tonic-gate *   The fifth argument is the number of artificial stack frames that will be
19337c478bdstevel@tonic-gate *   found on the stack when dtrace_probe() is called for the new probe.  These
19347c478bdstevel@tonic-gate *   artificial frames will be automatically be pruned should the stack() or
19357c478bdstevel@tonic-gate *   stackdepth() functions be called as part of one of the probe's ECBs.  If
19367c478bdstevel@tonic-gate *   the parameter doesn't add an artificial frame, this parameter should be
19377c478bdstevel@tonic-gate *   zero.
19387c478bdstevel@tonic-gate *
19397c478bdstevel@tonic-gate *   The final argument is a probe argument that will be passed back to the
19407c478bdstevel@tonic-gate *   provider when a probe-specific operation is called.  (e.g., via
19417c478bdstevel@tonic-gate *   dtps_enable(), dtps_disable(), etc.)
19427c478bdstevel@tonic-gate *
19437c478bdstevel@tonic-gate *   Note that it is up to the provider to be sure that the probe that it
19447c478bdstevel@tonic-gate *   creates does not already exist -- if the provider is unsure of the probe's
19457c478bdstevel@tonic-gate *   existence, it should assure its absence with dtrace_probe_lookup() before
19467c478bdstevel@tonic-gate *   calling dtrace_probe_create().
19477c478bdstevel@tonic-gate *
19487c478bdstevel@tonic-gate * 2.7.3  Return value
19497c478bdstevel@tonic-gate *
19507c478bdstevel@tonic-gate *   dtrace_probe_create() always succeeds, and always returns the identifier
19517c478bdstevel@tonic-gate *   of the newly-created probe.
19527c478bdstevel@tonic-gate *
19537c478bdstevel@tonic-gate * 2.7.4  Caller's context
19547c478bdstevel@tonic-gate *
19557c478bdstevel@tonic-gate *   While dtrace_probe_create() is generally expected to be called from
19567c478bdstevel@tonic-gate *   dtps_provide() and/or dtps_provide_module(), it may be called from other
19577c478bdstevel@tonic-gate *   non-DTrace contexts.  Neither cpu_lock nor mod_lock may be held.
19587c478bdstevel@tonic-gate *
19597c478bdstevel@tonic-gate * 2.8  dtrace_id_t dtrace_probe_lookup(dtrace_provider_t id, const char *mod,
19607c478bdstevel@tonic-gate *	    const char *func, const char *name)
19617c478bdstevel@tonic-gate *
19627c478bdstevel@tonic-gate * 2.8.1  Overview
19637c478bdstevel@tonic-gate *
19647c478bdstevel@tonic-gate *   Looks up a probe based on provdider and one or more of module name,
19657c478bdstevel@tonic-gate *   function name and probe name.
19667c478bdstevel@tonic-gate *
19677c478bdstevel@tonic-gate * 2.8.2  Arguments and Notes
19687c478bdstevel@tonic-gate *
19697c478bdstevel@tonic-gate *   The first argument is the provider identifier, as returned from a
19707c478bdstevel@tonic-gate *   successful call to dtrace_register().  The second, third, and fourth
19717c478bdstevel@tonic-gate *   arguments are the module name, function name, and probe name,
19727c478bdstevel@tonic-gate *   respectively.  Any of these may be NULL; dtrace_probe_lookup() will return
19737c478bdstevel@tonic-gate *   the identifier of the first probe that is provided by the specified
19747c478bdstevel@tonic-gate *   provider and matches all of the non-NULL matching criteria.
19757c478bdstevel@tonic-gate *   dtrace_probe_lookup() is generally used by a provider to be check the
19767c478bdstevel@tonic-gate *   existence of a probe before creating it with dtrace_probe_create().
19777c478bdstevel@tonic-gate *