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