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