root/usr/src/lib/libdtrace/common/dt_impl.h
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
 * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
 * Copyright 2022 Oxide Computer Company
 */

#ifndef _DT_IMPL_H
#define _DT_IMPL_H

#include <sys/param.h>
#include <sys/objfs.h>
#include <setjmp.h>
#include <libctf.h>
#include <dtrace.h>
#include <gelf.h>
#include <synch.h>

#ifdef  __cplusplus
extern "C" {
#endif

#include <dt_parser.h>
#include <dt_regset.h>
#include <dt_inttab.h>
#include <dt_strtab.h>
#include <dt_ident.h>
#include <dt_list.h>
#include <dt_decl.h>
#include <dt_as.h>
#include <dt_proc.h>
#include <dt_dof.h>
#include <dt_pcb.h>
#include <dt_pq.h>

struct dt_module;               /* see below */
struct dt_pfdict;               /* see <dt_printf.h> */
struct dt_arg;                  /* see below */
struct dt_provider;             /* see <dt_provider.h> */
struct dt_xlator;               /* see <dt_xlator.h> */

typedef struct dt_intrinsic {
        const char *din_name;   /* string name of the intrinsic type */
        ctf_encoding_t din_data; /* integer or floating-point CTF encoding */
        uint_t din_kind;        /* CTF type kind to instantiate */
} dt_intrinsic_t;

typedef struct dt_typedef {
        const char *dty_src;    /* string name of typedef source type */
        const char *dty_dst;    /* string name of typedef destination type */
} dt_typedef_t;

typedef struct dt_intdesc {
        const char *did_name;   /* string name of the integer type */
        ctf_file_t *did_ctfp;   /* CTF container for this type reference */
        ctf_id_t did_type;      /* CTF type reference for this type */
        uintmax_t did_limit;    /* maximum positive value held by type */
} dt_intdesc_t;

typedef struct dt_modops {
        uint_t (*do_syminit)(struct dt_module *);
        void (*do_symsort)(struct dt_module *);
        GElf_Sym *(*do_symname)(struct dt_module *,
            const char *, GElf_Sym *, uint_t *);
        GElf_Sym *(*do_symaddr)(struct dt_module *,
            GElf_Addr, GElf_Sym *, uint_t *);
} dt_modops_t;

typedef struct dt_arg {
        int da_ndx;             /* index of this argument */
        int da_mapping;         /* mapping of argument indices to arguments */
        ctf_id_t da_type;       /* type of argument */
        ctf_file_t *da_ctfp;    /* CTF container for type */
        dt_ident_t *da_xlator;  /* translator, if any */
        struct dt_arg *da_next; /* next argument */
} dt_arg_t;

typedef struct dt_sym {
        uint_t ds_symid;        /* id of corresponding symbol */
        uint_t ds_next;         /* index of next element in hash chain */
} dt_sym_t;

typedef struct dt_module {
        dt_list_t dm_list;      /* list forward/back pointers */
        char dm_name[DTRACE_MODNAMELEN]; /* string name of module */
        char dm_file[MAXPATHLEN]; /* file path of module (if any) */
        struct dt_module *dm_next; /* pointer to next module in hash chain */
        const dt_modops_t *dm_ops; /* pointer to data model's ops vector */
        Elf *dm_elf;            /* libelf handle for module object */
        objfs_info_t dm_info;   /* object filesystem private info */
        ctf_sect_t dm_symtab;   /* symbol table for module */
        ctf_sect_t dm_strtab;   /* string table for module */
        ctf_sect_t dm_ctdata;   /* CTF data for module */
        ctf_file_t *dm_ctfp;    /* CTF container handle */
        uint_t *dm_symbuckets;  /* symbol table hash buckets (chain indices) */
        dt_sym_t *dm_symchains; /* symbol table hash chains buffer */
        void *dm_asmap;         /* symbol pointers sorted by value */
        uint_t dm_symfree;      /* index of next free hash element */
        uint_t dm_nsymbuckets;  /* number of elements in bucket array */
        uint_t dm_nsymelems;    /* number of elements in hash table */
        uint_t dm_asrsv;        /* actual reserved size of dm_asmap */
        uint_t dm_aslen;        /* number of entries in dm_asmap */
        uint_t dm_flags;        /* module flags (see below) */
        int dm_modid;           /* modinfo(8) module identifier */
        GElf_Addr dm_text_va;   /* virtual address of text section */
        GElf_Xword dm_text_size; /* size in bytes of text section */
        GElf_Addr dm_data_va;   /* virtual address of data section */
        GElf_Xword dm_data_size; /* size in bytes of data section */
        GElf_Addr dm_bss_va;    /* virtual address of BSS */
        GElf_Xword dm_bss_size; /* size in bytes of BSS */
        dt_idhash_t *dm_extern; /* external symbol definitions */
        pid_t dm_pid;           /* pid for this module */
        uint_t dm_nctflibs;     /* number of ctf children libraries */
        ctf_file_t **dm_libctfp; /* process library ctf pointers */
        char **dm_libctfn;      /* names of process ctf containers */
} dt_module_t;

#define DT_DM_LOADED    0x1     /* module symbol and type data is loaded */
#define DT_DM_KERNEL    0x2     /* module is associated with a kernel object */
#define DT_DM_PRIMARY   0x4     /* module is a krtld primary kernel object */

typedef struct dt_provmod {
        char *dp_name;                          /* name of provider module */
        struct dt_provmod *dp_next;             /* next module */
} dt_provmod_t;

typedef struct dt_ahashent {
        struct dt_ahashent *dtahe_prev;         /* prev on hash chain */
        struct dt_ahashent *dtahe_next;         /* next on hash chain */
        struct dt_ahashent *dtahe_prevall;      /* prev on list of all */
        struct dt_ahashent *dtahe_nextall;      /* next on list of all */
        uint64_t dtahe_hashval;                 /* hash value */
        size_t dtahe_size;                      /* size of data */
        dtrace_aggdata_t dtahe_data;            /* data */
        void (*dtahe_aggregate)(int64_t *, int64_t *, size_t); /* function */
} dt_ahashent_t;

typedef struct dt_ahash {
        dt_ahashent_t   **dtah_hash;            /* hash table */
        dt_ahashent_t   *dtah_all;              /* list of all elements */
        size_t          dtah_size;              /* size of hash table */
} dt_ahash_t;

typedef struct dt_aggregate {
        dtrace_bufdesc_t dtat_buf;      /* buf aggregation snapshot */
        int dtat_flags;                 /* aggregate flags */
        processorid_t dtat_ncpus;       /* number of CPUs in aggregate */
        processorid_t *dtat_cpus;       /* CPUs in aggregate */
        processorid_t dtat_ncpu;        /* size of dtat_cpus array */
        processorid_t dtat_maxcpu;      /* maximum number of CPUs */
        dt_ahash_t dtat_hash;           /* aggregate hash table */
} dt_aggregate_t;

typedef struct dt_print_aggdata {
        dtrace_hdl_t *dtpa_dtp;         /* pointer to libdtrace handle */
        dtrace_aggvarid_t dtpa_id;      /* aggregation variable of interest */
        FILE *dtpa_fp;                  /* file pointer */
        int dtpa_allunprint;            /* print only unprinted aggregations */
        int dtpa_agghist;               /* print aggregation as histogram */
        int dtpa_agghisthdr;            /* aggregation histogram hdr printed */
        int dtpa_aggpack;               /* pack quantized aggregations */
} dt_print_aggdata_t;

typedef struct dt_dirpath {
        dt_list_t dir_list;             /* linked-list forward/back pointers */
        char *dir_path;                 /* directory pathname */
} dt_dirpath_t;

typedef struct dt_lib_depend {
        dt_list_t dtld_deplist;         /* linked-list forward/back pointers */
        char *dtld_library;             /* library name */
        char *dtld_libpath;             /* library pathname */
        uint_t dtld_finish;             /* completion time in tsort for lib */
        uint_t dtld_start;              /* starting time in tsort for lib */
        uint_t dtld_loaded;             /* boolean: is this library loaded */
        dt_list_t dtld_dependencies;    /* linked-list of lib dependencies */
        dt_list_t dtld_dependents;      /* linked-list of lib dependents */
} dt_lib_depend_t;

typedef uint32_t dt_version_t;          /* encoded version (see below) */

struct dtrace_hdl {
        const dtrace_vector_t *dt_vector; /* library vector, if vectored open */
        void *dt_varg;  /* vector argument, if vectored open */
        dtrace_conf_t dt_conf;  /* DTrace driver configuration profile */
        char dt_errmsg[BUFSIZ]; /* buffer for formatted syntax error msgs */
        const char *dt_errtag;  /* tag used with last call to dt_set_errmsg() */
        dt_pcb_t *dt_pcb;       /* pointer to current parsing control block */
        ulong_t dt_gen;         /* compiler generation number */
        dt_list_t dt_programs;  /* linked list of dtrace_prog_t's */
        dt_list_t dt_xlators;   /* linked list of dt_xlator_t's */
        struct dt_xlator **dt_xlatormap; /* dt_xlator_t's indexed by dx_id */
        id_t dt_xlatorid;       /* next dt_xlator_t id to assign */
        dt_ident_t *dt_externs; /* linked list of external symbol identifiers */
        dt_idhash_t *dt_macros; /* hash table of macro variable identifiers */
        dt_idhash_t *dt_aggs;   /* hash table of aggregation identifiers */
        dt_idhash_t *dt_globals; /* hash table of global identifiers */
        dt_idhash_t *dt_tls;    /* hash table of thread-local identifiers */
        dt_list_t dt_modlist;   /* linked list of dt_module_t's */
        dt_module_t **dt_mods;  /* hash table of dt_module_t's */
        uint_t dt_modbuckets;   /* number of module hash buckets */
        uint_t dt_nmods;        /* number of modules in hash and list */
        dt_provmod_t *dt_provmod; /* linked list of provider modules */
        dt_module_t *dt_exec;   /* pointer to executable module */
        dt_module_t *dt_rtld;   /* pointer to run-time linker module */
        dt_module_t *dt_cdefs;  /* pointer to C dynamic type module */
        dt_module_t *dt_ddefs;  /* pointer to D dynamic type module */
        dt_list_t dt_provlist;  /* linked list of dt_provider_t's */
        struct dt_provider **dt_provs; /* hash table of dt_provider_t's */
        uint_t dt_provbuckets;  /* number of provider hash buckets */
        uint_t dt_nprovs;       /* number of providers in hash and list */
        dt_proc_hash_t *dt_procs; /* hash table of grabbed process handles */
        char **dt_proc_env;     /* additional environment variables */
        dt_intdesc_t dt_ints[6]; /* cached integer type descriptions */
        ctf_id_t dt_type_func;  /* cached CTF identifier for function type */
        ctf_id_t dt_type_fptr;  /* cached CTF identifier for function pointer */
        ctf_id_t dt_type_str;   /* cached CTF identifier for string type */
        ctf_id_t dt_type_dyn;   /* cached CTF identifier for <DYN> type */
        ctf_id_t dt_type_stack; /* cached CTF identifier for stack type */
        ctf_id_t dt_type_symaddr; /* cached CTF identifier for _symaddr type */
        ctf_id_t dt_type_usymaddr; /* cached CTF ident. for _usymaddr type */
        size_t dt_maxprobe;     /* max enabled probe ID */
        dtrace_eprobedesc_t **dt_edesc; /* enabled probe descriptions */
        dtrace_probedesc_t **dt_pdesc; /* probe descriptions for enabled prbs */
        size_t dt_maxagg;       /* max aggregation ID */
        dtrace_aggdesc_t **dt_aggdesc; /* aggregation descriptions */
        int dt_maxformat;       /* max format ID */
        void **dt_formats;      /* pointer to format array */
        int dt_maxstrdata;      /* max strdata ID */
        char **dt_strdata;      /* pointer to strdata array */
        dt_aggregate_t dt_aggregate; /* aggregate */
        dt_pq_t *dt_bufq;       /* CPU-specific data queue */
        struct dt_pfdict *dt_pfdict; /* dictionary of printf conversions */
        dt_version_t dt_vmax;   /* optional ceiling on program API binding */
        dtrace_attribute_t dt_amin; /* optional floor on program attributes */
        char *dt_cpp_path;      /* pathname of cpp(1) to invoke if needed */
        char **dt_cpp_argv;     /* argument vector for exec'ing cpp(1) */
        int dt_cpp_argc;        /* count of initialized cpp(1) arguments */
        int dt_cpp_args;        /* size of dt_cpp_argv[] array */
        char *dt_ld_path;       /* pathname of ld(1) to invoke if needed */
        dt_list_t dt_lib_path;  /* linked-list forming library search path */
        uint_t dt_lazyload;     /* boolean:  set via -xlazyload */
        uint_t dt_droptags;     /* boolean:  set via -xdroptags */
        uint_t dt_active;       /* boolean:  set once tracing is active */
        uint_t dt_stopped;      /* boolean:  set once tracing is stopped */
        processorid_t dt_beganon; /* CPU that executed BEGIN probe (if any) */
        processorid_t dt_endedon; /* CPU that executed END probe (if any) */
        uint_t dt_oflags;       /* dtrace open-time options (see dtrace.h) */
        uint_t dt_cflags;       /* dtrace compile-time options (see dtrace.h) */
        uint_t dt_dflags;       /* dtrace link-time options (see dtrace.h) */
        uint_t dt_prcmode;      /* dtrace process create mode (see dt_proc.h) */
        uint_t dt_linkmode;     /* dtrace symbol linking mode (see below) */
        uint_t dt_linktype;     /* dtrace link output file type (see below) */
        uint_t dt_xlatemode;    /* dtrace translator linking mode (see below) */
        uint_t dt_stdcmode;     /* dtrace stdc compatibility mode (see below) */
        uint_t dt_encoding;     /* dtrace output encoding (see below) */
        uint_t dt_treedump;     /* dtrace tree debug bitmap (see below) */
        uint64_t dt_options[DTRACEOPT_MAX]; /* dtrace run-time options */
        int dt_version;         /* library version requested by client */
        int dt_ctferr;          /* error resulting from last CTF failure */
        int dt_errno;           /* error resulting from last failed operation */
        int dt_fd;              /* file descriptor for dtrace pseudo-device */
        int dt_ftfd;            /* file descriptor for fasttrap pseudo-device */
        int dt_fterr;           /* saved errno from failed open of dt_ftfd */
        int dt_cdefs_fd;        /* file descriptor for C CTF debugging cache */
        int dt_ddefs_fd;        /* file descriptor for D CTF debugging cache */
        int dt_stdout_fd;       /* file descriptor for saved stdout */
        dtrace_handle_err_f *dt_errhdlr; /* error handler, if any */
        void *dt_errarg;        /* error handler argument */
        dtrace_prog_t *dt_errprog; /* error handler program, if any */
        dtrace_handle_drop_f *dt_drophdlr; /* drop handler, if any */
        void *dt_droparg;       /* drop handler argument */
        dtrace_handle_proc_f *dt_prochdlr; /* proc handler, if any */
        void *dt_procarg;       /* proc handler argument */
        dtrace_handle_setopt_f *dt_setopthdlr; /* setopt handler, if any */
        void *dt_setoptarg;     /* setopt handler argument */
        dtrace_status_t dt_status[2]; /* status cache */
        int dt_statusgen;       /* current status generation */
        hrtime_t dt_laststatus; /* last status */
        hrtime_t dt_lastswitch; /* last switch of buffer data */
        hrtime_t dt_lastagg;    /* last snapshot of aggregation data */
        char *dt_sprintf_buf;   /* buffer for dtrace_sprintf() */
        int dt_sprintf_buflen;  /* length of dtrace_sprintf() buffer */
        const char *dt_filetag; /* default filetag for dt_set_errmsg() */
        char *dt_buffered_buf;  /* buffer for buffered output */
        size_t dt_buffered_offs; /* current offset into buffered buffer */
        size_t dt_buffered_size; /* size of buffered buffer */
        dtrace_handle_buffered_f *dt_bufhdlr; /* buffered handler, if any */
        void *dt_bufarg;        /* buffered handler argument */
        dt_dof_t dt_dof;        /* DOF generation buffers (see dt_dof.c) */
        struct utsname dt_uts;  /* uname(2) information for system */
        dt_list_t dt_lib_dep;   /* scratch linked-list of lib dependencies */
        dt_list_t dt_lib_dep_sorted;    /* dependency sorted library list */
        dtrace_flowkind_t dt_flow;      /* flow kind */
        const char *dt_prefix;  /* recommended flow prefix */
        int dt_indent;          /* recommended flow indent */
        dtrace_epid_t dt_last_epid;     /* most recently consumed EPID */
        uint64_t dt_last_timestamp;     /* most recently consumed timestamp */
        boolean_t dt_has_sugar; /* syntactic sugar used? */
};

/*
 * Values for the user arg of the ECB.
 */
#define DT_ECB_DEFAULT          0
#define DT_ECB_ERROR            1

/*
 * Values for the dt_linkmode property, which is used by the assembler when
 * processing external symbol references.  User can set using -xlink=<mode>.
 */
#define DT_LINK_KERNEL  0       /* kernel syms static, user syms dynamic */
#define DT_LINK_PRIMARY 1       /* primary kernel syms static, others dynamic */
#define DT_LINK_DYNAMIC 2       /* all symbols dynamic */
#define DT_LINK_STATIC  3       /* all symbols static */

/*
 * Values for the dt_linktype property, which is used by dtrace_program_link()
 * to determine the type of output file that is desired by the client.
 */
#define DT_LTYP_ELF     0       /* produce ELF containing DOF */
#define DT_LTYP_DOF     1       /* produce stand-alone DOF */

/*
 * Values for the dt_xlatemode property, which is used to determine whether
 * references to dynamic translators are permitted.  Set using -xlate=<mode>.
 */
#define DT_XL_STATIC    0       /* require xlators to be statically defined */
#define DT_XL_DYNAMIC   1       /* produce references to dynamic translators */

/*
 * Values for the dt_stdcmode property, which is used by the compiler when
 * running cpp to determine the presence and setting of the __STDC__ macro.
 */
#define DT_STDC_XA      0       /* ISO C + K&R C compat w/o ISO: __STDC__=0 */
#define DT_STDC_XC      1       /* Strict ISO C: __STDC__=1 */
#define DT_STDC_XS      2       /* K&R C: __STDC__ not defined */
#define DT_STDC_XT      3       /* ISO C + K&R C compat with ISO: __STDC__=0 */

/*
 * Values for the dt_encoding property, which is used to force a particular
 * character encoding (overriding default behavior and/or automatic detection).
 */
#define DT_ENCODING_UNSET       0
#define DT_ENCODING_ASCII       1
#define DT_ENCODING_UTF8        2

/*
 * Macro to test whether a given pass bit is set in the dt_treedump bit-vector.
 * If the bit for pass 'p' is set, the D compiler displays the parse tree for
 * the program by printing it to stderr at the end of compiler pass 'p'.
 */
#define DT_TREEDUMP_PASS(dtp, p)        ((dtp)->dt_treedump & (1 << ((p) - 1)))

/*
 * Macros for accessing the cached CTF container and type ID for the common
 * types "int", "string", and <DYN>, which we need to use frequently in the D
 * compiler.  The DT_INT_* macro relies upon "int" being at index 0 in the
 * _dtrace_ints_* tables in dt_open.c; the others are also set up there.
 */
#define DT_INT_CTFP(dtp)        ((dtp)->dt_ints[0].did_ctfp)
#define DT_INT_TYPE(dtp)        ((dtp)->dt_ints[0].did_type)

#define DT_FUNC_CTFP(dtp)       ((dtp)->dt_ddefs->dm_ctfp)
#define DT_FUNC_TYPE(dtp)       ((dtp)->dt_type_func)

#define DT_FPTR_CTFP(dtp)       ((dtp)->dt_ddefs->dm_ctfp)
#define DT_FPTR_TYPE(dtp)       ((dtp)->dt_type_fptr)

#define DT_STR_CTFP(dtp)        ((dtp)->dt_ddefs->dm_ctfp)
#define DT_STR_TYPE(dtp)        ((dtp)->dt_type_str)

#define DT_DYN_CTFP(dtp)        ((dtp)->dt_ddefs->dm_ctfp)
#define DT_DYN_TYPE(dtp)        ((dtp)->dt_type_dyn)

#define DT_STACK_CTFP(dtp)      ((dtp)->dt_ddefs->dm_ctfp)
#define DT_STACK_TYPE(dtp)      ((dtp)->dt_type_stack)

#define DT_SYMADDR_CTFP(dtp)    ((dtp)->dt_ddefs->dm_ctfp)
#define DT_SYMADDR_TYPE(dtp)    ((dtp)->dt_type_symaddr)

#define DT_USYMADDR_CTFP(dtp)   ((dtp)->dt_ddefs->dm_ctfp)
#define DT_USYMADDR_TYPE(dtp)   ((dtp)->dt_type_usymaddr)

/*
 * Actions and subroutines are both DT_NODE_FUNC nodes; to avoid confusing
 * an action for a subroutine (or vice versa), we assure that the DT_ACT_*
 * constants and the DIF_SUBR_* constants occupy non-overlapping ranges by
 * starting the DT_ACT_* constants at DIF_SUBR_MAX + 1.
 */
#define DT_ACT_BASE             DIF_SUBR_MAX + 1
#define DT_ACT(n)               (DT_ACT_BASE + (n))

#define DT_ACT_PRINTF           DT_ACT(0)       /* printf() action */
#define DT_ACT_TRACE            DT_ACT(1)       /* trace() action */
#define DT_ACT_TRACEMEM         DT_ACT(2)       /* tracemem() action */
#define DT_ACT_STACK            DT_ACT(3)       /* stack() action */
#define DT_ACT_STOP             DT_ACT(4)       /* stop() action */
#define DT_ACT_BREAKPOINT       DT_ACT(5)       /* breakpoint() action */
#define DT_ACT_PANIC            DT_ACT(6)       /* panic() action */
#define DT_ACT_SPECULATE        DT_ACT(7)       /* speculate() action */
#define DT_ACT_COMMIT           DT_ACT(8)       /* commit() action */
#define DT_ACT_DISCARD          DT_ACT(9)       /* discard() action */
#define DT_ACT_CHILL            DT_ACT(10)      /* chill() action */
#define DT_ACT_EXIT             DT_ACT(11)      /* exit() action */
#define DT_ACT_USTACK           DT_ACT(12)      /* ustack() action */
#define DT_ACT_PRINTA           DT_ACT(13)      /* printa() action */
#define DT_ACT_RAISE            DT_ACT(14)      /* raise() action */
#define DT_ACT_CLEAR            DT_ACT(15)      /* clear() action */
#define DT_ACT_NORMALIZE        DT_ACT(16)      /* normalize() action */
#define DT_ACT_DENORMALIZE      DT_ACT(17)      /* denormalize() action */
#define DT_ACT_TRUNC            DT_ACT(18)      /* trunc() action */
#define DT_ACT_SYSTEM           DT_ACT(19)      /* system() action */
#define DT_ACT_JSTACK           DT_ACT(20)      /* jstack() action */
#define DT_ACT_FTRUNCATE        DT_ACT(21)      /* ftruncate() action */
#define DT_ACT_FREOPEN          DT_ACT(22)      /* freopen() action */
#define DT_ACT_SYM              DT_ACT(23)      /* sym()/func() actions */
#define DT_ACT_MOD              DT_ACT(24)      /* mod() action */
#define DT_ACT_USYM             DT_ACT(25)      /* usym()/ufunc() actions */
#define DT_ACT_UMOD             DT_ACT(26)      /* umod() action */
#define DT_ACT_UADDR            DT_ACT(27)      /* uaddr() action */
#define DT_ACT_SETOPT           DT_ACT(28)      /* setopt() action */
#define DT_ACT_PRINT            DT_ACT(29)      /* print() action */

/*
 * Sentinel to tell freopen() to restore the saved stdout.  This must not
 * be ever valid for opening for write access via freopen(3C), which of
 * course, "." never is.
 */
#define DT_FREOPEN_RESTORE      "."

#define EDT_BASE        1000    /* base value for libdtrace errnos */

enum {
        EDT_VERSION = EDT_BASE, /* client is requesting unsupported version */
        EDT_VERSINVAL,          /* version string is invalid or overflows */
        EDT_VERSUNDEF,          /* requested API version is not defined */
        EDT_VERSREDUCED,        /* requested API version has been reduced */
        EDT_CTF,                /* libctf called failed (dt_ctferr has more) */
        EDT_COMPILER,           /* error in D program compilation */
        EDT_NOTUPREG,           /* tuple register allocation failure */
        EDT_NOMEM,              /* memory allocation failure */
        EDT_INT2BIG,            /* integer limit exceeded */
        EDT_STR2BIG,            /* string limit exceeded */
        EDT_NOMOD,              /* unknown module name */
        EDT_NOPROV,             /* unknown provider name */
        EDT_NOPROBE,            /* unknown probe name */
        EDT_NOSYM,              /* unknown symbol name */
        EDT_NOSYMADDR,          /* no symbol corresponds to address */
        EDT_NOTYPE,             /* unknown type name */
        EDT_NOVAR,              /* unknown variable name */
        EDT_NOAGG,              /* unknown aggregation name */
        EDT_BADSCOPE,           /* improper use of type name scoping operator */
        EDT_BADSPEC,            /* overspecified probe description */
        EDT_BADSPCV,            /* bad macro variable in probe description */
        EDT_BADID,              /* invalid probe identifier */
        EDT_NOTLOADED,          /* module is not currently loaded */
        EDT_NOCTF,              /* module does not contain any CTF data */
        EDT_DATAMODEL,          /* module and program data models don't match */
        EDT_DIFVERS,            /* library has newer DIF version than driver */
        EDT_BADAGG,             /* unrecognized aggregating action */
        EDT_FIO,                /* file i/o error */
        EDT_DIFINVAL,           /* invalid DIF program */
        EDT_DIFSIZE,            /* invalid DIF size */
        EDT_DIFFAULT,           /* failed to copyin DIF program */
        EDT_BADPROBE,           /* bad probe description */
        EDT_BADPGLOB,           /* bad probe description globbing pattern */
        EDT_NOSCOPE,            /* declaration scope stack underflow */
        EDT_NODECL,             /* declaration stack underflow */
        EDT_DMISMATCH,          /* record list does not match statement */
        EDT_DOFFSET,            /* record data offset error */
        EDT_DALIGN,             /* record data alignment error */
        EDT_BADOPTNAME,         /* invalid dtrace_setopt option name */
        EDT_BADOPTVAL,          /* invalid dtrace_setopt option value */
        EDT_BADOPTCTX,          /* invalid dtrace_setopt option context */
        EDT_CPPFORK,            /* failed to fork preprocessor */
        EDT_CPPEXEC,            /* failed to exec preprocessor */
        EDT_CPPENT,             /* preprocessor not found */
        EDT_CPPERR,             /* unknown preprocessor error */
        EDT_SYMOFLOW,           /* external symbol table overflow */
        EDT_ACTIVE,             /* operation illegal when tracing is active */
        EDT_DESTRUCTIVE,        /* destructive actions not allowed */
        EDT_NOANON,             /* no anonymous tracing state */
        EDT_ISANON,             /* can't claim anon state and enable probes */
        EDT_ENDTOOBIG,          /* END enablings exceed size of prncpl buffer */
        EDT_NOCONV,             /* failed to load type for printf conversion */
        EDT_BADCONV,            /* incomplete printf conversion */
        EDT_BADERROR,           /* invalid library ERROR action */
        EDT_ERRABORT,           /* abort due to error */
        EDT_DROPABORT,          /* abort due to drop */
        EDT_DIRABORT,           /* abort explicitly directed */
        EDT_BADRVAL,            /* invalid return value from callback */
        EDT_BADNORMAL,          /* invalid normalization */
        EDT_BUFTOOSMALL,        /* enabling exceeds size of buffer */
        EDT_BADTRUNC,           /* invalid truncation */
        EDT_BUSY,               /* device busy (active kernel debugger) */
        EDT_ACCESS,             /* insufficient privileges to use DTrace */
        EDT_NOENT,              /* dtrace device not available */
        EDT_BRICKED,            /* abort due to systemic unresponsiveness */
        EDT_HARDWIRE,           /* failed to load hard-wired definitions */
        EDT_ELFVERSION,         /* libelf is out-of-date w.r.t libdtrace */
        EDT_NOBUFFERED,         /* attempt to buffer output without handler */
        EDT_UNSTABLE,           /* description matched unstable set of probes */
        EDT_BADSETOPT,          /* invalid setopt library action */
        EDT_BADSTACKPC,         /* invalid stack program counter size */
        EDT_BADAGGVAR,          /* invalid aggregation variable identifier */
        EDT_OVERSION,           /* client is requesting deprecated version */
        EDT_ENABLING_ERR,       /* failed to enable probe */
        EDT_NOPROBES,           /* no probes sites for declared provider */
        EDT_CANTLOAD            /* failed to load a module */
};

/*
 * Interfaces for parsing and comparing DTrace attribute tuples, which describe
 * stability and architectural binding information.  The dtrace_attribute_t
 * structure and associated constant definitions are found in <sys/dtrace.h>.
 */
extern dtrace_attribute_t dt_attr_min(dtrace_attribute_t, dtrace_attribute_t);
extern dtrace_attribute_t dt_attr_max(dtrace_attribute_t, dtrace_attribute_t);
extern char *dt_attr_str(dtrace_attribute_t, char *, size_t);
extern int dt_attr_cmp(dtrace_attribute_t, dtrace_attribute_t);

/*
 * Interfaces for parsing and handling DTrace version strings.  Version binding
 * is a feature of the D compiler that is handled completely independently of
 * the DTrace kernel infrastructure, so the definitions are here in libdtrace.
 * Version strings are compiled into an encoded uint32_t which can be compared
 * using C comparison operators.  Version definitions are found in dt_open.c.
 */
#define DT_VERSION_STRMAX       16      /* enough for "255.4095.4095\0" */
#define DT_VERSION_MAJMAX       0xFF    /* maximum major version number */
#define DT_VERSION_MINMAX       0xFFF   /* maximum minor version number */
#define DT_VERSION_MICMAX       0xFFF   /* maximum micro version number */

#define DT_VERSION_NUMBER(M, m, u) \
        ((((M) & 0xFF) << 24) | (((m) & 0xFFF) << 12) | ((u) & 0xFFF))

#define DT_VERSION_MAJOR(v)     (((v) & 0xFF000000) >> 24)
#define DT_VERSION_MINOR(v)     (((v) & 0x00FFF000) >> 12)
#define DT_VERSION_MICRO(v)     ((v) & 0x00000FFF)

extern char *dt_version_num2str(dt_version_t, char *, size_t);
extern int dt_version_str2num(const char *, dt_version_t *);
extern int dt_version_defined(dt_version_t);

/*
 * Miscellaneous internal libdtrace interfaces.  The definitions below are for
 * libdtrace routines that do not yet merit their own separate header file.
 */
extern char *dt_cpp_add_arg(dtrace_hdl_t *, const char *);
extern char *dt_cpp_pop_arg(dtrace_hdl_t *);

extern int dt_set_errno(dtrace_hdl_t *, int);
extern void dt_set_errmsg(dtrace_hdl_t *, const char *, const char *,
    const char *, int, const char *, va_list);

extern int dt_ioctl(dtrace_hdl_t *, int, void *);
extern int dt_status(dtrace_hdl_t *, processorid_t);
extern long dt_sysconf(dtrace_hdl_t *, int);
extern ssize_t dt_write(dtrace_hdl_t *, int, const void *, size_t);
extern int dt_printf(dtrace_hdl_t *, FILE *, const char *, ...);

extern void *dt_zalloc(dtrace_hdl_t *, size_t);
extern void *dt_alloc(dtrace_hdl_t *, size_t);
extern void dt_free(dtrace_hdl_t *, void *);
extern void dt_difo_free(dtrace_hdl_t *, dtrace_difo_t *);

extern int dt_gmatch(const char *, const char *);
extern char *dt_basename(char *);

extern ulong_t dt_popc(ulong_t);
extern ulong_t dt_popcb(const ulong_t *, ulong_t);

extern int dt_buffered_enable(dtrace_hdl_t *);
extern int dt_buffered_flush(dtrace_hdl_t *, dtrace_probedata_t *,
    const dtrace_recdesc_t *, const dtrace_aggdata_t *, uint32_t flags);
extern void dt_buffered_disable(dtrace_hdl_t *);
extern void dt_buffered_destroy(dtrace_hdl_t *);

extern uint64_t dt_stddev(uint64_t *, uint64_t);

extern int dt_options_load(dtrace_hdl_t *);

extern void dt_dprintf(const char *, ...);

extern void dt_setcontext(dtrace_hdl_t *, dtrace_probedesc_t *);
extern void dt_endcontext(dtrace_hdl_t *);

extern void dt_pragma(dt_node_t *);
extern int dt_reduce(dtrace_hdl_t *, dt_version_t);
extern void dt_cg(dt_pcb_t *, dt_node_t *);
extern dtrace_difo_t *dt_as(dt_pcb_t *);
extern void dt_dis(const dtrace_difo_t *, FILE *);

extern int dt_aggregate_go(dtrace_hdl_t *);
extern int dt_aggregate_init(dtrace_hdl_t *);
extern void dt_aggregate_destroy(dtrace_hdl_t *);

extern int dt_epid_lookup(dtrace_hdl_t *, dtrace_epid_t,
    dtrace_eprobedesc_t **, dtrace_probedesc_t **);
extern void dt_epid_destroy(dtrace_hdl_t *);
extern int dt_aggid_lookup(dtrace_hdl_t *, dtrace_aggid_t, dtrace_aggdesc_t **);
extern void dt_aggid_destroy(dtrace_hdl_t *);

extern void *dt_format_lookup(dtrace_hdl_t *, int);
extern void dt_format_destroy(dtrace_hdl_t *);

extern const char *dt_strdata_lookup(dtrace_hdl_t *, int);
extern void dt_strdata_destroy(dtrace_hdl_t *);

extern int dt_print_quantize(dtrace_hdl_t *, FILE *,
    const void *, size_t, uint64_t);
extern int dt_print_lquantize(dtrace_hdl_t *, FILE *,
    const void *, size_t, uint64_t);
extern int dt_print_llquantize(dtrace_hdl_t *, FILE *,
    const void *, size_t, uint64_t);
extern int dt_print_agg(const dtrace_aggdata_t *, void *);

extern int dt_handle(dtrace_hdl_t *, dtrace_probedata_t *);
extern int dt_handle_liberr(dtrace_hdl_t *,
    const dtrace_probedata_t *, const char *);
extern int dt_handle_cpudrop(dtrace_hdl_t *, processorid_t,
    dtrace_dropkind_t, uint64_t);
extern int dt_handle_status(dtrace_hdl_t *,
    dtrace_status_t *, dtrace_status_t *);
extern int dt_handle_setopt(dtrace_hdl_t *, dtrace_setoptdata_t *);

extern int dt_lib_depend_add(dtrace_hdl_t *, dt_list_t *, const char *);
extern dt_lib_depend_t *dt_lib_depend_lookup(dt_list_t *, const char *);

extern boolean_t dt_is_bitfield(const ctf_encoding_t *, ulong_t);

extern dt_pcb_t *yypcb;         /* pointer to current parser control block */
extern char yyintprefix;        /* int token prefix for macros (+/-) */
extern char yyintsuffix[4];     /* int token suffix ([uUlL]*) */
extern int yyintdecimal;        /* int token is decimal (1) or octal/hex (0) */
extern char yytext[];           /* lex input buffer */
extern int yylineno;            /* lex line number */
extern int yydebug;             /* lex debugging */
extern dt_node_t *yypragma;     /* lex token list for control lines */

extern const dtrace_attribute_t _dtrace_maxattr; /* maximum attributes */
extern const dtrace_attribute_t _dtrace_defattr; /* default attributes */
extern const dtrace_attribute_t _dtrace_symattr; /* symbol ref attributes */
extern const dtrace_attribute_t _dtrace_typattr; /* type ref attributes */
extern const dtrace_attribute_t _dtrace_prvattr; /* provider attributes */
extern const dtrace_pattr_t _dtrace_prvdesc;     /* provider attribute bundle */

extern const dt_version_t _dtrace_versions[];    /* array of valid versions */
extern const char *const _dtrace_version;        /* current version string */

extern int _dtrace_strbuckets;          /* number of hash buckets for strings */
extern int _dtrace_intbuckets;          /* number of hash buckets for ints */
extern uint_t _dtrace_stkindent;        /* default indent for stack/ustack */
extern uint_t _dtrace_pidbuckets;       /* number of hash buckets for pids */
extern uint_t _dtrace_pidlrulim;        /* number of proc handles to cache */
extern int _dtrace_debug;               /* debugging messages enabled */
extern size_t _dtrace_bufsize;          /* default dt_buf_create() size */
extern int _dtrace_argmax;              /* default maximum probe arguments */

extern const char *_dtrace_libdir;      /* default library directory */
extern const char *_dtrace_moddir;      /* default kernel module directory */

#ifdef  __cplusplus
}
#endif

#endif  /* _DT_IMPL_H */