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