Home | History | Annotate | Download | only in common
      1 /*
      2  * CDDL HEADER START
      3  *
      4  * The contents of this file are subject to the terms of the
      5  * Common Development and Distribution License (the "License").
      6  * You may not use this file except in compliance with the License.
      7  *
      8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9  * or http://www.opensolaris.org/os/licensing.
     10  * See the License for the specific language governing permissions
     11  * and limitations under the License.
     12  *
     13  * When distributing Covered Code, include this CDDL HEADER in each
     14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15  * If applicable, add the following below this CDDL HEADER, with the
     16  * fields enclosed by brackets "[]" replaced with your own identifying
     17  * information: Portions Copyright [yyyy] [name of copyright owner]
     18  *
     19  * CDDL HEADER END
     20  */
     21 
     22 /*
     23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     24  * Use is subject to license terms.
     25  */
     26 
     27 #ifndef	_DT_IMPL_H
     28 #define	_DT_IMPL_H
     29 
     30 #include <sys/param.h>
     31 #include <sys/objfs.h>
     32 #include <setjmp.h>
     33 #include <libctf.h>
     34 #include <dtrace.h>
     35 #include <gelf.h>
     36 
     37 #ifdef	__cplusplus
     38 extern "C" {
     39 #endif
     40 
     41 #include <dt_parser.h>
     42 #include <dt_regset.h>
     43 #include <dt_inttab.h>
     44 #include <dt_strtab.h>
     45 #include <dt_ident.h>
     46 #include <dt_list.h>
     47 #include <dt_decl.h>
     48 #include <dt_as.h>
     49 #include <dt_proc.h>
     50 #include <dt_dof.h>
     51 #include <dt_pcb.h>
     52 
     53 struct dt_module;		/* see below */
     54 struct dt_pfdict;		/* see <dt_printf.h> */
     55 struct dt_arg;			/* see below */
     56 struct dt_provider;		/* see <dt_provider.h> */
     57 struct dt_xlator;		/* see <dt_xlator.h> */
     58 
     59 typedef struct dt_intrinsic {
     60 	const char *din_name;	/* string name of the intrinsic type */
     61 	ctf_encoding_t din_data; /* integer or floating-point CTF encoding */
     62 	uint_t din_kind;	/* CTF type kind to instantiate */
     63 } dt_intrinsic_t;
     64 
     65 typedef struct dt_typedef {
     66 	const char *dty_src;	/* string name of typedef source type */
     67 	const char *dty_dst;	/* string name of typedef destination type */
     68 } dt_typedef_t;
     69 
     70 typedef struct dt_intdesc {
     71 	const char *did_name;	/* string name of the integer type */
     72 	ctf_file_t *did_ctfp;	/* CTF container for this type reference */
     73 	ctf_id_t did_type;	/* CTF type reference for this type */
     74 	uintmax_t did_limit;	/* maximum positive value held by type */
     75 } dt_intdesc_t;
     76 
     77 typedef struct dt_modops {
     78 	uint_t (*do_syminit)(struct dt_module *);
     79 	void (*do_symsort)(struct dt_module *);
     80 	GElf_Sym *(*do_symname)(struct dt_module *,
     81 	    const char *, GElf_Sym *, uint_t *);
     82 	GElf_Sym *(*do_symaddr)(struct dt_module *,
     83 	    GElf_Addr, GElf_Sym *, uint_t *);
     84 } dt_modops_t;
     85 
     86 typedef struct dt_arg {
     87 	int da_ndx;		/* index of this argument */
     88 	int da_mapping;		/* mapping of argument indices to arguments */
     89 	ctf_id_t da_type;	/* type of argument */
     90 	ctf_file_t *da_ctfp;	/* CTF container for type */
     91 	dt_ident_t *da_xlator;	/* translator, if any */
     92 	struct dt_arg *da_next;	/* next argument */
     93 } dt_arg_t;
     94 
     95 typedef struct dt_sym {
     96 	uint_t ds_symid;	/* id of corresponding symbol */
     97 	uint_t ds_next;		/* index of next element in hash chain */
     98 } dt_sym_t;
     99 
    100 typedef struct dt_module {
    101 	dt_list_t dm_list;	/* list forward/back pointers */
    102 	char dm_name[DTRACE_MODNAMELEN]; /* string name of module */
    103 	char dm_file[MAXPATHLEN]; /* file path of module (if any) */
    104 	struct dt_module *dm_next; /* pointer to next module in hash chain */
    105 	const dt_modops_t *dm_ops; /* pointer to data model's ops vector */
    106 	Elf *dm_elf;		/* libelf handle for module object */
    107 	objfs_info_t dm_info;	/* object filesystem private info */
    108 	ctf_sect_t dm_symtab;	/* symbol table for module */
    109 	ctf_sect_t dm_strtab;	/* string table for module */
    110 	ctf_sect_t dm_ctdata;	/* CTF data for module */
    111 	ctf_file_t *dm_ctfp;	/* CTF container handle */
    112 	uint_t *dm_symbuckets;	/* symbol table hash buckets (chain indices) */
    113 	dt_sym_t *dm_symchains;	/* symbol table hash chains buffer */
    114 	void *dm_asmap;		/* symbol pointers sorted by value */
    115 	uint_t dm_symfree;	/* index of next free hash element */
    116 	uint_t dm_nsymbuckets;	/* number of elements in bucket array */
    117 	uint_t dm_nsymelems;	/* number of elements in hash table */
    118 	uint_t dm_asrsv;	/* actual reserved size of dm_asmap */
    119 	uint_t dm_aslen;	/* number of entries in dm_asmap */
    120 	uint_t dm_flags;	/* module flags (see below) */
    121 	int dm_modid;		/* modinfo(1M) module identifier */
    122 	GElf_Addr dm_text_va;	/* virtual address of text section */
    123 	GElf_Xword dm_text_size; /* size in bytes of text section */
    124 	GElf_Addr dm_data_va;	/* virtual address of data section */
    125 	GElf_Xword dm_data_size; /* size in bytes of data section */
    126 	GElf_Addr dm_bss_va;	/* virtual address of BSS */
    127 	GElf_Xword dm_bss_size;	/* size in bytes of BSS */
    128 	dt_idhash_t *dm_extern;	/* external symbol definitions */
    129 } dt_module_t;
    130 
    131 #define	DT_DM_LOADED	0x1	/* module symbol and type data is loaded */
    132 #define	DT_DM_KERNEL	0x2	/* module is associated with a kernel object */
    133 #define	DT_DM_PRIMARY	0x4	/* module is a krtld primary kernel object */
    134 
    135 typedef struct dt_provmod {
    136 	char *dp_name;				/* name of provider module */
    137 	struct dt_provmod *dp_next;		/* next module */
    138 } dt_provmod_t;
    139 
    140 typedef struct dt_ahashent {
    141 	struct dt_ahashent *dtahe_prev;		/* prev on hash chain */
    142 	struct dt_ahashent *dtahe_next;		/* next on hash chain */
    143 	struct dt_ahashent *dtahe_prevall;	/* prev on list of all */
    144 	struct dt_ahashent *dtahe_nextall;	/* next on list of all */
    145 	uint64_t dtahe_hashval;			/* hash value */
    146 	size_t dtahe_size;			/* size of data */
    147 	dtrace_aggdata_t dtahe_data;		/* data */
    148 	void (*dtahe_aggregate)(int64_t *, int64_t *, size_t); /* function */
    149 } dt_ahashent_t;
    150 
    151 typedef struct dt_ahash {
    152 	dt_ahashent_t	**dtah_hash;		/* hash table */
    153 	dt_ahashent_t	*dtah_all;		/* list of all elements */
    154 	size_t		dtah_size;		/* size of hash table */
    155 } dt_ahash_t;
    156 
    157 typedef struct dt_aggregate {
    158 	dtrace_bufdesc_t dtat_buf; 	/* buf aggregation snapshot */
    159 	int dtat_flags;			/* aggregate flags */
    160 	processorid_t dtat_ncpus;	/* number of CPUs in aggregate */
    161 	processorid_t *dtat_cpus;	/* CPUs in aggregate */
    162 	processorid_t dtat_ncpu;	/* size of dtat_cpus array */
    163 	processorid_t dtat_maxcpu;	/* maximum number of CPUs */
    164 	dt_ahash_t dtat_hash;		/* aggregate hash table */
    165 } dt_aggregate_t;
    166 
    167 typedef struct dt_print_aggdata {
    168 	dtrace_hdl_t *dtpa_dtp;		/* pointer to libdtrace handle */
    169 	dtrace_aggvarid_t dtpa_id;	/* aggregation variable of interest */
    170 	FILE *dtpa_fp;			/* file pointer */
    171 	int dtpa_allunprint;		/* print only unprinted aggregations */
    172 } dt_print_aggdata_t;
    173 
    174 typedef struct dt_dirpath {
    175 	dt_list_t dir_list;		/* linked-list forward/back pointers */
    176 	char *dir_path;			/* directory pathname */
    177 } dt_dirpath_t;
    178 
    179 typedef struct dt_lib_depend {
    180 	dt_list_t dtld_deplist;		/* linked-list forward/back pointers */
    181 	char *dtld_library;		/* library name */
    182 	char *dtld_libpath;		/* library pathname */
    183 	uint_t dtld_finish;		/* completion time in tsort for lib */
    184 	uint_t dtld_start;		/* starting time in tsort for lib */
    185 	uint_t dtld_loaded;		/* boolean: is this library loaded */
    186 	dt_list_t dtld_dependencies;	/* linked-list of lib dependencies */
    187 	dt_list_t dtld_dependents;	/* linked-list of lib dependents */
    188 } dt_lib_depend_t;
    189 
    190 typedef uint32_t dt_version_t;		/* encoded version (see below) */
    191 
    192 struct dtrace_hdl {
    193 	const dtrace_vector_t *dt_vector; /* library vector, if vectored open */
    194 	void *dt_varg;	/* vector argument, if vectored open */
    195 	dtrace_conf_t dt_conf;	/* DTrace driver configuration profile */
    196 	char dt_errmsg[BUFSIZ];	/* buffer for formatted syntax error msgs */
    197 	const char *dt_errtag;	/* tag used with last call to dt_set_errmsg() */
    198 	dt_pcb_t *dt_pcb;	/* pointer to current parsing control block */
    199 	ulong_t dt_gen;		/* compiler generation number */
    200 	dt_list_t dt_programs;	/* linked list of dtrace_prog_t's */
    201 	dt_list_t dt_xlators;	/* linked list of dt_xlator_t's */
    202 	struct dt_xlator **dt_xlatormap; /* dt_xlator_t's indexed by dx_id */
    203 	id_t dt_xlatorid;	/* next dt_xlator_t id to assign */
    204 	dt_ident_t *dt_externs;	/* linked list of external symbol identifiers */
    205 	dt_idhash_t *dt_macros;	/* hash table of macro variable identifiers */
    206 	dt_idhash_t *dt_aggs;	/* hash table of aggregation identifiers */
    207 	dt_idhash_t *dt_globals; /* hash table of global identifiers */
    208 	dt_idhash_t *dt_tls;	/* hash table of thread-local identifiers */
    209 	dt_list_t dt_modlist;	/* linked list of dt_module_t's */
    210 	dt_module_t **dt_mods;	/* hash table of dt_module_t's */
    211 	uint_t dt_modbuckets;	/* number of module hash buckets */
    212 	uint_t dt_nmods;	/* number of modules in hash and list */
    213 	dt_provmod_t *dt_provmod; /* linked list of provider modules */
    214 	dt_module_t *dt_exec;	/* pointer to executable module */
    215 	dt_module_t *dt_rtld;	/* pointer to run-time linker module */
    216 	dt_module_t *dt_cdefs;	/* pointer to C dynamic type module */
    217 	dt_module_t *dt_ddefs;	/* pointer to D dynamic type module */
    218 	dt_list_t dt_provlist;	/* linked list of dt_provider_t's */
    219 	struct dt_provider **dt_provs; /* hash table of dt_provider_t's */
    220 	uint_t dt_provbuckets;	/* number of provider hash buckets */
    221 	uint_t dt_nprovs;	/* number of providers in hash and list */
    222 	dt_proc_hash_t *dt_procs; /* hash table of grabbed process handles */
    223 	dt_intdesc_t dt_ints[6]; /* cached integer type descriptions */
    224 	ctf_id_t dt_type_func;	/* cached CTF identifier for function type */
    225 	ctf_id_t dt_type_fptr;	/* cached CTF identifier for function pointer */
    226 	ctf_id_t dt_type_str;	/* cached CTF identifier for string type */
    227 	ctf_id_t dt_type_dyn;	/* cached CTF identifier for <DYN> type */
    228 	ctf_id_t dt_type_stack;	/* cached CTF identifier for stack type */
    229 	ctf_id_t dt_type_symaddr; /* cached CTF identifier for _symaddr type */
    230 	ctf_id_t dt_type_usymaddr; /* cached CTF ident. for _usymaddr type */
    231 	size_t dt_maxprobe;	/* max enabled probe ID */
    232 	dtrace_eprobedesc_t **dt_edesc; /* enabled probe descriptions */
    233 	dtrace_probedesc_t **dt_pdesc; /* probe descriptions for enabled prbs */
    234 	size_t dt_maxagg;	/* max aggregation ID */
    235 	dtrace_aggdesc_t **dt_aggdesc; /* aggregation descriptions */
    236 	int dt_maxformat;	/* max format ID */
    237 	void **dt_formats;	/* pointer to format array */
    238 	dt_aggregate_t dt_aggregate; /* aggregate */
    239 	dtrace_bufdesc_t dt_buf; /* staging buffer */
    240 	struct dt_pfdict *dt_pfdict; /* dictionary of printf conversions */
    241 	dt_version_t dt_vmax;	/* optional ceiling on program API binding */
    242 	dtrace_attribute_t dt_amin; /* optional floor on program attributes */
    243 	char *dt_cpp_path;	/* pathname of cpp(1) to invoke if needed */
    244 	char **dt_cpp_argv;	/* argument vector for exec'ing cpp(1) */
    245 	int dt_cpp_argc;	/* count of initialized cpp(1) arguments */
    246 	int dt_cpp_args;	/* size of dt_cpp_argv[] array */
    247 	char *dt_ld_path;	/* pathname of ld(1) to invoke if needed */
    248 	dt_list_t dt_lib_path;	/* linked-list forming library search path */
    249 	uint_t dt_lazyload;	/* boolean:  set via -xlazyload */
    250 	uint_t dt_droptags;	/* boolean:  set via -xdroptags */
    251 	uint_t dt_active;	/* boolean:  set once tracing is active */
    252 	uint_t dt_stopped;	/* boolean:  set once tracing is stopped */
    253 	processorid_t dt_beganon; /* CPU that executed BEGIN probe (if any) */
    254 	processorid_t dt_endedon; /* CPU that executed END probe (if any) */
    255 	uint_t dt_oflags;	/* dtrace open-time options (see dtrace.h) */
    256 	uint_t dt_cflags;	/* dtrace compile-time options (see dtrace.h) */
    257 	uint_t dt_dflags;	/* dtrace link-time options (see dtrace.h) */
    258 	uint_t dt_prcmode;	/* dtrace process create mode (see dt_proc.h) */
    259 	uint_t dt_linkmode;	/* dtrace symbol linking mode (see below) */
    260 	uint_t dt_linktype;	/* dtrace link output file type (see below) */
    261 	uint_t dt_xlatemode;	/* dtrace translator linking mode (see below) */
    262 	uint_t dt_stdcmode;	/* dtrace stdc compatibility mode (see below) */
    263 	uint_t dt_treedump;	/* dtrace tree debug bitmap (see below) */
    264 	uint64_t dt_options[DTRACEOPT_MAX]; /* dtrace run-time options */
    265 	int dt_version;		/* library version requested by client */
    266 	int dt_ctferr;		/* error resulting from last CTF failure */
    267 	int dt_errno;		/* error resulting from last failed operation */
    268 	int dt_fd;		/* file descriptor for dtrace pseudo-device */
    269 	int dt_ftfd;		/* file descriptor for fasttrap pseudo-device */
    270 	int dt_fterr;		/* saved errno from failed open of dt_ftfd */
    271 	int dt_cdefs_fd;	/* file descriptor for C CTF debugging cache */
    272 	int dt_ddefs_fd;	/* file descriptor for D CTF debugging cache */
    273 	int dt_stdout_fd;	/* file descriptor for saved stdout */
    274 	dtrace_handle_err_f *dt_errhdlr; /* error handler, if any */
    275 	void *dt_errarg;	/* error handler argument */
    276 	dtrace_prog_t *dt_errprog; /* error handler program, if any */
    277 	dtrace_handle_drop_f *dt_drophdlr; /* drop handler, if any */
    278 	void *dt_droparg;	/* drop handler argument */
    279 	dtrace_handle_proc_f *dt_prochdlr; /* proc handler, if any */
    280 	void *dt_procarg;	/* proc handler argument */
    281 	dtrace_handle_setopt_f *dt_setopthdlr; /* setopt handler, if any */
    282 	void *dt_setoptarg;	/* setopt handler argument */
    283 	dtrace_status_t dt_status[2]; /* status cache */
    284 	int dt_statusgen;	/* current status generation */
    285 	hrtime_t dt_laststatus;	/* last status */
    286 	hrtime_t dt_lastswitch;	/* last switch of buffer data */
    287 	hrtime_t dt_lastagg;	/* last snapshot of aggregation data */
    288 	char *dt_sprintf_buf;	/* buffer for dtrace_sprintf() */
    289 	int dt_sprintf_buflen;	/* length of dtrace_sprintf() buffer */
    290 	const char *dt_filetag;	/* default filetag for dt_set_errmsg() */
    291 	char *dt_buffered_buf;	/* buffer for buffered output */
    292 	size_t dt_buffered_offs; /* current offset into buffered buffer */
    293 	size_t dt_buffered_size; /* size of buffered buffer */
    294 	dtrace_handle_buffered_f *dt_bufhdlr; /* buffered handler, if any */
    295 	void *dt_bufarg;	/* buffered handler argument */
    296 	dt_dof_t dt_dof;	/* DOF generation buffers (see dt_dof.c) */
    297 	struct utsname dt_uts;	/* uname(2) information for system */
    298 	dt_list_t dt_lib_dep;	/* scratch linked-list of lib dependencies */
    299 	dt_list_t dt_lib_dep_sorted;	/* dependency sorted library list */
    300 };
    301 
    302 /*
    303  * Values for the user arg of the ECB.
    304  */
    305 #define	DT_ECB_DEFAULT		0
    306 #define	DT_ECB_ERROR		1
    307 
    308 /*
    309  * Values for the dt_linkmode property, which is used by the assembler when
    310  * processing external symbol references.  User can set using -xlink=<mode>.
    311  */
    312 #define	DT_LINK_KERNEL	0	/* kernel syms static, user syms dynamic */
    313 #define	DT_LINK_PRIMARY	1	/* primary kernel syms static, others dynamic */
    314 #define	DT_LINK_DYNAMIC	2	/* all symbols dynamic */
    315 #define	DT_LINK_STATIC	3	/* all symbols static */
    316 
    317 /*
    318  * Values for the dt_linktype property, which is used by dtrace_program_link()
    319  * to determine the type of output file that is desired by the client.
    320  */
    321 #define	DT_LTYP_ELF	0	/* produce ELF containing DOF */
    322 #define	DT_LTYP_DOF	1	/* produce stand-alone DOF */
    323 
    324 /*
    325  * Values for the dt_xlatemode property, which is used to determine whether
    326  * references to dynamic translators are permitted.  Set using -xlate=<mode>.
    327  */
    328 #define	DT_XL_STATIC	0	/* require xlators to be statically defined */
    329 #define	DT_XL_DYNAMIC	1	/* produce references to dynamic translators */
    330 
    331 /*
    332  * Values for the dt_stdcmode property, which is used by the compiler when
    333  * running cpp to determine the presence and setting of the __STDC__ macro.
    334  */
    335 #define	DT_STDC_XA	0	/* ISO C + K&R C compat w/o ISO: __STDC__=0 */
    336 #define	DT_STDC_XC	1	/* Strict ISO C: __STDC__=1 */
    337 #define	DT_STDC_XS	2	/* K&R C: __STDC__ not defined */
    338 #define	DT_STDC_XT	3	/* ISO C + K&R C compat with ISO: __STDC__=0 */
    339 
    340 /*
    341  * Macro to test whether a given pass bit is set in the dt_treedump bit-vector.
    342  * If the bit for pass 'p' is set, the D compiler displays the parse tree for
    343  * the program by printing it to stderr at the end of compiler pass 'p'.
    344  */
    345 #define	DT_TREEDUMP_PASS(dtp, p)	((dtp)->dt_treedump & (1 << ((p) - 1)))
    346 
    347 /*
    348  * Macros for accessing the cached CTF container and type ID for the common
    349  * types "int", "string", and <DYN>, which we need to use frequently in the D
    350  * compiler.  The DT_INT_* macro relies upon "int" being at index 0 in the
    351  * _dtrace_ints_* tables in dt_open.c; the others are also set up there.
    352  */
    353 #define	DT_INT_CTFP(dtp)	((dtp)->dt_ints[0].did_ctfp)
    354 #define	DT_INT_TYPE(dtp)	((dtp)->dt_ints[0].did_type)
    355 
    356 #define	DT_FUNC_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    357 #define	DT_FUNC_TYPE(dtp)	((dtp)->dt_type_func)
    358 
    359 #define	DT_FPTR_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    360 #define	DT_FPTR_TYPE(dtp)	((dtp)->dt_type_fptr)
    361 
    362 #define	DT_STR_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    363 #define	DT_STR_TYPE(dtp)	((dtp)->dt_type_str)
    364 
    365 #define	DT_DYN_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    366 #define	DT_DYN_TYPE(dtp)	((dtp)->dt_type_dyn)
    367 
    368 #define	DT_STACK_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    369 #define	DT_STACK_TYPE(dtp)	((dtp)->dt_type_stack)
    370 
    371 #define	DT_SYMADDR_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    372 #define	DT_SYMADDR_TYPE(dtp)	((dtp)->dt_type_symaddr)
    373 
    374 #define	DT_USYMADDR_CTFP(dtp)	((dtp)->dt_ddefs->dm_ctfp)
    375 #define	DT_USYMADDR_TYPE(dtp)	((dtp)->dt_type_usymaddr)
    376 
    377 /*
    378  * Actions and subroutines are both DT_NODE_FUNC nodes; to avoid confusing
    379  * an action for a subroutine (or vice versa), we assure that the DT_ACT_*
    380  * constants and the DIF_SUBR_* constants occupy non-overlapping ranges by
    381  * starting the DT_ACT_* constants at DIF_SUBR_MAX + 1.
    382  */
    383 #define	DT_ACT_BASE		DIF_SUBR_MAX + 1
    384 #define	DT_ACT(n)		(DT_ACT_BASE + (n))
    385 
    386 #define	DT_ACT_PRINTF		DT_ACT(0)	/* printf() action */
    387 #define	DT_ACT_TRACE		DT_ACT(1)	/* trace() action */
    388 #define	DT_ACT_TRACEMEM		DT_ACT(2)	/* tracemem() action */
    389 #define	DT_ACT_STACK		DT_ACT(3)	/* stack() action */
    390 #define	DT_ACT_STOP		DT_ACT(4)	/* stop() action */
    391 #define	DT_ACT_BREAKPOINT	DT_ACT(5)	/* breakpoint() action */
    392 #define	DT_ACT_PANIC		DT_ACT(6)	/* panic() action */
    393 #define	DT_ACT_SPECULATE	DT_ACT(7)	/* speculate() action */
    394 #define	DT_ACT_COMMIT		DT_ACT(8)	/* commit() action */
    395 #define	DT_ACT_DISCARD		DT_ACT(9)	/* discard() action */
    396 #define	DT_ACT_CHILL		DT_ACT(10)	/* chill() action */
    397 #define	DT_ACT_EXIT		DT_ACT(11)	/* exit() action */
    398 #define	DT_ACT_USTACK		DT_ACT(12)	/* ustack() action */
    399 #define	DT_ACT_PRINTA		DT_ACT(13)	/* printa() action */
    400 #define	DT_ACT_RAISE		DT_ACT(14)	/* raise() action */
    401 #define	DT_ACT_CLEAR		DT_ACT(15)	/* clear() action */
    402 #define	DT_ACT_NORMALIZE	DT_ACT(16)	/* normalize() action */
    403 #define	DT_ACT_DENORMALIZE	DT_ACT(17)	/* denormalize() action */
    404 #define	DT_ACT_TRUNC		DT_ACT(18)	/* trunc() action */
    405 #define	DT_ACT_SYSTEM		DT_ACT(19)	/* system() action */
    406 #define	DT_ACT_JSTACK		DT_ACT(20)	/* jstack() action */
    407 #define	DT_ACT_FTRUNCATE	DT_ACT(21)	/* ftruncate() action */
    408 #define	DT_ACT_FREOPEN		DT_ACT(22)	/* freopen() action */
    409 #define	DT_ACT_SYM		DT_ACT(23)	/* sym()/func() actions */
    410 #define	DT_ACT_MOD		DT_ACT(24)	/* mod() action */
    411 #define	DT_ACT_USYM		DT_ACT(25)	/* usym()/ufunc() actions */
    412 #define	DT_ACT_UMOD		DT_ACT(26)	/* umod() action */
    413 #define	DT_ACT_UADDR		DT_ACT(27)	/* uaddr() action */
    414 #define	DT_ACT_SETOPT		DT_ACT(28)	/* setopt() action */
    415 
    416 /*
    417  * Sentinel to tell freopen() to restore the saved stdout.  This must not
    418  * be ever valid for opening for write access via freopen(3C), which of
    419  * course, "." never is.
    420  */
    421 #define	DT_FREOPEN_RESTORE	"."
    422 
    423 #define	EDT_BASE	1000	/* base value for libdtrace errnos */
    424 
    425 enum {
    426 	EDT_VERSION = EDT_BASE,	/* client is requesting unsupported version */
    427 	EDT_VERSINVAL,		/* version string is invalid or overflows */
    428 	EDT_VERSUNDEF,		/* requested API version is not defined */
    429 	EDT_VERSREDUCED,	/* requested API version has been reduced */
    430 	EDT_CTF,		/* libctf called failed (dt_ctferr has more) */
    431 	EDT_COMPILER,		/* error in D program compilation */
    432 	EDT_NOREG,		/* register allocation failure */
    433 	EDT_NOTUPREG,		/* tuple register allocation failure */
    434 	EDT_NOMEM,		/* memory allocation failure */
    435 	EDT_INT2BIG,		/* integer limit exceeded */
    436 	EDT_STR2BIG,		/* string limit exceeded */
    437 	EDT_NOMOD,		/* unknown module name */
    438 	EDT_NOPROV,		/* unknown provider name */
    439 	EDT_NOPROBE,		/* unknown probe name */
    440 	EDT_NOSYM,		/* unknown symbol name */
    441 	EDT_NOSYMADDR,		/* no symbol corresponds to address */
    442 	EDT_NOTYPE,		/* unknown type name */
    443 	EDT_NOVAR,		/* unknown variable name */
    444 	EDT_NOAGG,		/* unknown aggregation name */
    445 	EDT_BADSCOPE,		/* improper use of type name scoping operator */
    446 	EDT_BADSPEC,		/* overspecified probe description */
    447 	EDT_BADSPCV,		/* bad macro variable in probe description */
    448 	EDT_BADID,		/* invalid probe identifier */
    449 	EDT_NOTLOADED,		/* module is not currently loaded */
    450 	EDT_NOCTF,		/* module does not contain any CTF data */
    451 	EDT_DATAMODEL,		/* module and program data models don't match */
    452 	EDT_DIFVERS,		/* library has newer DIF version than driver */
    453 	EDT_BADAGG,		/* unrecognized aggregating action */
    454 	EDT_FIO,		/* file i/o error */
    455 	EDT_DIFINVAL,		/* invalid DIF program */
    456 	EDT_DIFSIZE,		/* invalid DIF size */
    457 	EDT_DIFFAULT,		/* failed to copyin DIF program */
    458 	EDT_BADPROBE,		/* bad probe description */
    459 	EDT_BADPGLOB,		/* bad probe description globbing pattern */
    460 	EDT_NOSCOPE,		/* declaration scope stack underflow */
    461 	EDT_NODECL,		/* declaration stack underflow */
    462 	EDT_DMISMATCH,		/* record list does not match statement */
    463 	EDT_DOFFSET,		/* record data offset error */
    464 	EDT_DALIGN,		/* record data alignment error */
    465 	EDT_BADOPTNAME,		/* invalid dtrace_setopt option name */
    466 	EDT_BADOPTVAL,		/* invalid dtrace_setopt option value */
    467 	EDT_BADOPTCTX,		/* invalid dtrace_setopt option context */
    468 	EDT_CPPFORK,		/* failed to fork preprocessor */
    469 	EDT_CPPEXEC,		/* failed to exec preprocessor */
    470 	EDT_CPPENT,		/* preprocessor not found */
    471 	EDT_CPPERR,		/* unknown preprocessor error */
    472 	EDT_SYMOFLOW,		/* external symbol table overflow */
    473 	EDT_ACTIVE,		/* operation illegal when tracing is active */
    474 	EDT_DESTRUCTIVE,	/* destructive actions not allowed */
    475 	EDT_NOANON,		/* no anonymous tracing state */
    476 	EDT_ISANON,		/* can't claim anon state and enable probes */
    477 	EDT_ENDTOOBIG,		/* END enablings exceed size of prncpl buffer */
    478 	EDT_NOCONV,		/* failed to load type for printf conversion */
    479 	EDT_BADCONV,		/* incomplete printf conversion */
    480 	EDT_BADERROR,		/* invalid library ERROR action */
    481 	EDT_ERRABORT,		/* abort due to error */
    482 	EDT_DROPABORT,		/* abort due to drop */
    483 	EDT_DIRABORT,		/* abort explicitly directed */
    484 	EDT_BADRVAL,		/* invalid return value from callback */
    485 	EDT_BADNORMAL,		/* invalid normalization */
    486 	EDT_BUFTOOSMALL,	/* enabling exceeds size of buffer */
    487 	EDT_BADTRUNC,		/* invalid truncation */
    488 	EDT_BUSY,		/* device busy (active kernel debugger) */
    489 	EDT_ACCESS,		/* insufficient privileges to use DTrace */
    490 	EDT_NOENT,		/* dtrace device not available */
    491 	EDT_BRICKED,		/* abort due to systemic unresponsiveness */
    492 	EDT_HARDWIRE,		/* failed to load hard-wired definitions */
    493 	EDT_ELFVERSION,		/* libelf is out-of-date w.r.t libdtrace */
    494 	EDT_NOBUFFERED,		/* attempt to buffer output without handler */
    495 	EDT_UNSTABLE,		/* description matched unstable set of probes */
    496 	EDT_BADSETOPT,		/* invalid setopt library action */
    497 	EDT_BADSTACKPC,		/* invalid stack program counter size */
    498 	EDT_BADAGGVAR,		/* invalid aggregation variable identifier */
    499 	EDT_OVERSION,		/* client is requesting deprecated version */
    500 	EDT_ENABLING_ERR	/* failed to enable probe */
    501 };
    502 
    503 /*
    504  * Interfaces for parsing and comparing DTrace attribute tuples, which describe
    505  * stability and architectural binding information.  The dtrace_attribute_t
    506  * structure and associated constant definitions are found in <sys/dtrace.h>.
    507  */
    508 extern dtrace_attribute_t dt_attr_min(dtrace_attribute_t, dtrace_attribute_t);
    509 extern dtrace_attribute_t dt_attr_max(dtrace_attribute_t, dtrace_attribute_t);
    510 extern char *dt_attr_str(dtrace_attribute_t, char *, size_t);
    511 extern int dt_attr_cmp(dtrace_attribute_t, dtrace_attribute_t);
    512 
    513 /*
    514  * Interfaces for parsing and handling DTrace version strings.  Version binding
    515  * is a feature of the D compiler that is handled completely independently of
    516  * the DTrace kernel infrastructure, so the definitions are here in libdtrace.
    517  * Version strings are compiled into an encoded uint32_t which can be compared
    518  * using C comparison operators.  Version definitions are found in dt_open.c.
    519  */
    520 #define	DT_VERSION_STRMAX	16	/* enough for "255.4095.4095\0" */
    521 #define	DT_VERSION_MAJMAX	0xFF	/* maximum major version number */
    522 #define	DT_VERSION_MINMAX	0xFFF	/* maximum minor version number */
    523 #define	DT_VERSION_MICMAX	0xFFF	/* maximum micro version number */
    524 
    525 #define	DT_VERSION_NUMBER(M, m, u) \
    526 	((((M) & 0xFF) << 24) | (((m) & 0xFFF) << 12) | ((u) & 0xFFF))
    527 
    528 #define	DT_VERSION_MAJOR(v)	(((v) & 0xFF000000) >> 24)
    529 #define	DT_VERSION_MINOR(v)	(((v) & 0x00FFF000) >> 12)
    530 #define	DT_VERSION_MICRO(v)	((v) & 0x00000FFF)
    531 
    532 extern char *dt_version_num2str(dt_version_t, char *, size_t);
    533 extern int dt_version_str2num(const char *, dt_version_t *);
    534 extern int dt_version_defined(dt_version_t);
    535 
    536 /*
    537  * Miscellaneous internal libdtrace interfaces.  The definitions below are for
    538  * libdtrace routines that do not yet merit their own separate header file.
    539  */
    540 extern char *dt_cpp_add_arg(dtrace_hdl_t *, const char *);
    541 extern char *dt_cpp_pop_arg(dtrace_hdl_t *);
    542 
    543 extern int dt_set_errno(dtrace_hdl_t *, int);
    544 extern void dt_set_errmsg(dtrace_hdl_t *, const char *, const char *,
    545     const char *, int, const char *, va_list);
    546 
    547 extern int dt_ioctl(dtrace_hdl_t *, int, void *);
    548 extern int dt_status(dtrace_hdl_t *, processorid_t);
    549 extern long dt_sysconf(dtrace_hdl_t *, int);
    550 extern ssize_t dt_write(dtrace_hdl_t *, int, const void *, size_t);
    551 extern int dt_printf(dtrace_hdl_t *, FILE *, const char *, ...);
    552 
    553 extern void *dt_zalloc(dtrace_hdl_t *, size_t);
    554 extern void *dt_alloc(dtrace_hdl_t *, size_t);
    555 extern void dt_free(dtrace_hdl_t *, void *);
    556 extern void dt_difo_free(dtrace_hdl_t *, dtrace_difo_t *);
    557 
    558 extern int dt_gmatch(const char *, const char *);
    559 extern char *dt_basename(char *);
    560 
    561 extern ulong_t dt_popc(ulong_t);
    562 extern ulong_t dt_popcb(const ulong_t *, ulong_t);
    563 
    564 extern int dt_buffered_enable(dtrace_hdl_t *);
    565 extern int dt_buffered_flush(dtrace_hdl_t *, dtrace_probedata_t *,
    566     const dtrace_recdesc_t *, const dtrace_aggdata_t *, uint32_t flags);
    567 extern void dt_buffered_disable(dtrace_hdl_t *);
    568 extern void dt_buffered_destroy(dtrace_hdl_t *);
    569 
    570 extern int dt_rw_read_held(pthread_rwlock_t *);
    571 extern int dt_rw_write_held(pthread_rwlock_t *);
    572 extern int dt_mutex_held(pthread_mutex_t *);
    573 
    574 extern uint64_t dt_stddev(uint64_t *, uint64_t);
    575 
    576 #define	DT_RW_READ_HELD(x)	dt_rw_read_held(x)
    577 #define	DT_RW_WRITE_HELD(x)	dt_rw_write_held(x)
    578 #define	DT_RW_LOCK_HELD(x)	(DT_RW_READ_HELD(x) || DT_RW_WRITE_HELD(x))
    579 #define	DT_MUTEX_HELD(x)	dt_mutex_held(x)
    580 
    581 extern int dt_options_load(dtrace_hdl_t *);
    582 
    583 extern void dt_dprintf(const char *, ...);
    584 
    585 extern void dt_setcontext(dtrace_hdl_t *, dtrace_probedesc_t *);
    586 extern void dt_endcontext(dtrace_hdl_t *);
    587 
    588 extern void dt_pragma(dt_node_t *);
    589 extern int dt_reduce(dtrace_hdl_t *, dt_version_t);
    590 extern void dt_cg(dt_pcb_t *, dt_node_t *);
    591 extern dtrace_difo_t *dt_as(dt_pcb_t *);
    592 extern void dt_dis(const dtrace_difo_t *, FILE *);
    593 
    594 extern int dt_aggregate_go(dtrace_hdl_t *);
    595 extern int dt_aggregate_init(dtrace_hdl_t *);
    596 extern void dt_aggregate_destroy(dtrace_hdl_t *);
    597 
    598 extern int dt_epid_lookup(dtrace_hdl_t *, dtrace_epid_t,
    599     dtrace_eprobedesc_t **, dtrace_probedesc_t **);
    600 extern void dt_epid_destroy(dtrace_hdl_t *);
    601 extern int dt_aggid_lookup(dtrace_hdl_t *, dtrace_aggid_t, dtrace_aggdesc_t **);
    602 extern void dt_aggid_destroy(dtrace_hdl_t *);
    603 
    604 extern void *dt_format_lookup(dtrace_hdl_t *, int);
    605 extern void dt_format_destroy(dtrace_hdl_t *);
    606 
    607 extern int dt_print_quantize(dtrace_hdl_t *, FILE *,
    608     const void *, size_t, uint64_t);
    609 extern int dt_print_lquantize(dtrace_hdl_t *, FILE *,
    610     const void *, size_t, uint64_t);
    611 extern int dt_print_agg(const dtrace_aggdata_t *, void *);
    612 
    613 extern int dt_handle(dtrace_hdl_t *, dtrace_probedata_t *);
    614 extern int dt_handle_liberr(dtrace_hdl_t *,
    615     const dtrace_probedata_t *, const char *);
    616 extern int dt_handle_cpudrop(dtrace_hdl_t *, processorid_t,
    617     dtrace_dropkind_t, uint64_t);
    618 extern int dt_handle_status(dtrace_hdl_t *,
    619     dtrace_status_t *, dtrace_status_t *);
    620 extern int dt_handle_setopt(dtrace_hdl_t *, dtrace_setoptdata_t *);
    621 
    622 extern int dt_lib_depend_add(dtrace_hdl_t *, dt_list_t *, const char *);
    623 extern dt_lib_depend_t *dt_lib_depend_lookup(dt_list_t *, const char *);
    624 
    625 extern dt_pcb_t *yypcb;		/* pointer to current parser control block */
    626 extern char yyintprefix;	/* int token prefix for macros (+/-) */
    627 extern char yyintsuffix[4];	/* int token suffix ([uUlL]*) */
    628 extern int yyintdecimal;	/* int token is decimal (1) or octal/hex (0) */
    629 extern char yytext[];		/* lex input buffer */
    630 extern int yylineno;		/* lex line number */
    631 extern int yydebug;		/* lex debugging */
    632 extern dt_node_t *yypragma;	/* lex token list for control lines */
    633 
    634 extern const dtrace_attribute_t _dtrace_maxattr; /* maximum attributes */
    635 extern const dtrace_attribute_t _dtrace_defattr; /* default attributes */
    636 extern const dtrace_attribute_t _dtrace_symattr; /* symbol ref attributes */
    637 extern const dtrace_attribute_t _dtrace_typattr; /* type ref attributes */
    638 extern const dtrace_attribute_t _dtrace_prvattr; /* provider attributes */
    639 extern const dtrace_pattr_t _dtrace_prvdesc;	 /* provider attribute bundle */
    640 
    641 extern const dt_version_t _dtrace_versions[];	 /* array of valid versions */
    642 extern const char *const _dtrace_version;	 /* current version string */
    643 
    644 extern int _dtrace_strbuckets;		/* number of hash buckets for strings */
    645 extern int _dtrace_intbuckets;		/* number of hash buckets for ints */
    646 extern uint_t _dtrace_stkindent;	/* default indent for stack/ustack */
    647 extern uint_t _dtrace_pidbuckets;	/* number of hash buckets for pids */
    648 extern uint_t _dtrace_pidlrulim;	/* number of proc handles to cache */
    649 extern int _dtrace_debug;		/* debugging messages enabled */
    650 extern size_t _dtrace_bufsize;		/* default dt_buf_create() size */
    651 extern int _dtrace_argmax;		/* default maximum probe arguments */
    652 
    653 extern const char *_dtrace_libdir;	/* default library directory */
    654 extern const char *_dtrace_moddir;	/* default kernel module directory */
    655 
    656 #ifdef	__cplusplus
    657 }
    658 #endif
    659 
    660 #endif	/* _DT_IMPL_H */
    661