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