cddl/contrib/opensolaris/lib/libdtrace/common/dt_impl.h

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