cddl/contrib/opensolaris/lib/libdtrace/common/dtrace.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 2007 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 #ifndef _DTRACE_H
  28 #define _DTRACE_H
  29
  30 #pragma ident   "%Z%%M% %I%     %E% SMI"
  31
  32 #include <sys/dtrace.h>
  33 #include <stdarg.h>
  34 #include <stdio.h>
  35 #include <gelf.h>
  36 #include <libproc.h>
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /*
  43  * DTrace Dynamic Tracing Software: Library Interfaces
  44  *
  45  * Note: The contents of this file are private to the implementation of the
  46  * Solaris system and DTrace subsystem and are subject to change at any time
  47  * without notice.  Applications and drivers using these interfaces will fail
  48  * to run on future releases.  These interfaces should not be used for any
  49  * purpose except those expressly outlined in dtrace(7D) and libdtrace(3LIB).
  50  * Please refer to the "Solaris Dynamic Tracing Guide" for more information.
  51  */
  52
  53 #define DTRACE_VERSION  3               /* library ABI interface version */
  54
  55 struct ps_prochandle;
  56 typedef struct dtrace_hdl dtrace_hdl_t;
  57 typedef struct dtrace_prog dtrace_prog_t;
  58 typedef struct dtrace_vector dtrace_vector_t;
  59 typedef struct dtrace_aggdata dtrace_aggdata_t;
  60
  61 #define DTRACE_O_NODEV          0x01    /* do not open dtrace(7D) device */
  62 #define DTRACE_O_NOSYS          0x02    /* do not load /system/object modules */
  63 #define DTRACE_O_LP64           0x04    /* force D compiler to be LP64 */
  64 #define DTRACE_O_ILP32          0x08    /* force D compiler to be ILP32 */
  65 #define DTRACE_O_MASK           0x0f    /* mask of valid flags to dtrace_open */
  66
  67 extern dtrace_hdl_t *dtrace_open(int, int, int *);
  68 extern dtrace_hdl_t *dtrace_vopen(int, int, int *,
  69     const dtrace_vector_t *, void *);
  70
  71 extern int dtrace_go(dtrace_hdl_t *);
  72 extern int dtrace_stop(dtrace_hdl_t *);
  73 extern void dtrace_sleep(dtrace_hdl_t *);
  74 extern void dtrace_close(dtrace_hdl_t *);
  75
  76 extern int dtrace_errno(dtrace_hdl_t *);
  77 extern const char *dtrace_errmsg(dtrace_hdl_t *, int);
  78 extern const char *dtrace_faultstr(dtrace_hdl_t *, int);
  79 extern const char *dtrace_subrstr(dtrace_hdl_t *, int);
  80
  81 extern int dtrace_setopt(dtrace_hdl_t *, const char *, const char *);
  82 extern int dtrace_getopt(dtrace_hdl_t *, const char *, dtrace_optval_t *);
  83
  84 extern void dtrace_update(dtrace_hdl_t *);
  85 extern int dtrace_ctlfd(dtrace_hdl_t *);
  86
  87 /*
  88  * DTrace Program Interface
  89  *
  90  * DTrace programs can be created by compiling ASCII text files containing
  91  * D programs or by compiling in-memory C strings that specify a D program.
  92  * Once created, callers can examine the list of program statements and
  93  * enable the probes and actions described by these statements.
  94  */
  95
  96 typedef struct dtrace_proginfo {
  97         dtrace_attribute_t dpi_descattr; /* minimum probedesc attributes */
  98         dtrace_attribute_t dpi_stmtattr; /* minimum statement attributes */
  99         uint_t dpi_aggregates;  /* number of aggregates specified in program */
 100         uint_t dpi_recgens;     /* number of record generating probes in prog */
 101         uint_t dpi_matches;     /* number of probes matched by program */
 102         uint_t dpi_speculations; /* number of speculations specified in prog */
 103 } dtrace_proginfo_t;
 104
 105 #define DTRACE_C_DIFV   0x0001  /* DIF verbose mode: show each compiled DIFO */
 106 #define DTRACE_C_EMPTY  0x0002  /* Permit compilation of empty D source files */
 107 #define DTRACE_C_ZDEFS  0x0004  /* Permit probe defs that match zero probes */
 108 #define DTRACE_C_EATTR  0x0008  /* Error if program attributes less than min */
 109 #define DTRACE_C_CPP    0x0010  /* Preprocess input file with cpp(1) utility */
 110 #define DTRACE_C_KNODEF 0x0020  /* Permit unresolved kernel symbols in DIFO */
 111 #define DTRACE_C_UNODEF 0x0040  /* Permit unresolved user symbols in DIFO */
 112 #define DTRACE_C_PSPEC  0x0080  /* Intepret ambiguous specifiers as probes */
 113 #define DTRACE_C_ETAGS  0x0100  /* Prefix error messages with error tags */
 114 #define DTRACE_C_ARGREF 0x0200  /* Do not require all macro args to be used */
 115 #define DTRACE_C_DEFARG 0x0800  /* Use 0/"" as value for unspecified args */
 116 #define DTRACE_C_NOLIBS 0x1000  /* Do not process D system libraries */
 117 #define DTRACE_C_CTL    0x2000  /* Only process control directives */
 118 #define DTRACE_C_MASK   0x3bff  /* mask of all valid flags to dtrace_*compile */
 119
 120 extern dtrace_prog_t *dtrace_program_strcompile(dtrace_hdl_t *,
 121     const char *, dtrace_probespec_t, uint_t, int, char *const []);
 122
 123 extern dtrace_prog_t *dtrace_program_fcompile(dtrace_hdl_t *,
 124     FILE *, uint_t, int, char *const []);
 125
 126 extern int dtrace_program_exec(dtrace_hdl_t *, dtrace_prog_t *,
 127     dtrace_proginfo_t *);
 128 extern void dtrace_program_info(dtrace_hdl_t *, dtrace_prog_t *,
 129     dtrace_proginfo_t *);
 130
 131 #define DTRACE_D_STRIP  0x01    /* strip non-loadable sections from program */
 132 #define DTRACE_D_PROBES 0x02    /* include provider and probe definitions */
 133 #define DTRACE_D_MASK   0x03    /* mask of valid flags to dtrace_dof_create */
 134
 135 extern int dtrace_program_link(dtrace_hdl_t *, dtrace_prog_t *,
 136     uint_t, const char *, int, char *const []);
 137
 138 extern int dtrace_program_header(dtrace_hdl_t *, FILE *, const char *);
 139
 140 extern void *dtrace_dof_create(dtrace_hdl_t *, dtrace_prog_t *, uint_t);
 141 extern void dtrace_dof_destroy(dtrace_hdl_t *, void *);
 142
 143 extern void *dtrace_getopt_dof(dtrace_hdl_t *);
 144 extern void *dtrace_geterr_dof(dtrace_hdl_t *);
 145
 146 typedef struct dtrace_stmtdesc {
 147         dtrace_ecbdesc_t *dtsd_ecbdesc;         /* ECB description */
 148         dtrace_actdesc_t *dtsd_action;          /* action list */
 149         dtrace_actdesc_t *dtsd_action_last;     /* last action in action list */
 150         void *dtsd_aggdata;                     /* aggregation data */
 151         void *dtsd_fmtdata;                     /* type-specific output data */
 152         void (*dtsd_callback)(void);            /* callback function for EPID */
 153         void *dtsd_data;                        /* callback data pointer */
 154         dtrace_attribute_t dtsd_descattr;       /* probedesc attributes */
 155         dtrace_attribute_t dtsd_stmtattr;       /* statement attributes */
 156 } dtrace_stmtdesc_t;
 157
 158 typedef int dtrace_stmt_f(dtrace_hdl_t *, dtrace_prog_t *,
 159     dtrace_stmtdesc_t *, void *);
 160
 161 extern dtrace_stmtdesc_t *dtrace_stmt_create(dtrace_hdl_t *,
 162     dtrace_ecbdesc_t *);
 163 extern dtrace_actdesc_t *dtrace_stmt_action(dtrace_hdl_t *,
 164     dtrace_stmtdesc_t *);
 165 extern int dtrace_stmt_add(dtrace_hdl_t *, dtrace_prog_t *,
 166     dtrace_stmtdesc_t *);
 167 extern int dtrace_stmt_iter(dtrace_hdl_t *, dtrace_prog_t *,
 168     dtrace_stmt_f *, void *);
 169 extern void dtrace_stmt_destroy(dtrace_hdl_t *, dtrace_stmtdesc_t *);
 170
 171 /*
 172  * DTrace Data Consumption Interface
 173  */
 174 typedef enum {
 175         DTRACEFLOW_ENTRY,
 176         DTRACEFLOW_RETURN,
 177         DTRACEFLOW_NONE
 178 } dtrace_flowkind_t;
 179
 180 #define DTRACE_CONSUME_ERROR            -1      /* error while processing */
 181 #define DTRACE_CONSUME_THIS             0       /* consume this probe/record */
 182 #define DTRACE_CONSUME_NEXT             1       /* advance to next probe/rec */
 183 #define DTRACE_CONSUME_ABORT            2       /* abort consumption */
 184
 185 typedef struct dtrace_probedata {
 186         dtrace_hdl_t *dtpda_handle;             /* handle to DTrace library */
 187         dtrace_eprobedesc_t *dtpda_edesc;       /* enabled probe description */
 188         dtrace_probedesc_t *dtpda_pdesc;        /* probe description */
 189         processorid_t dtpda_cpu;                /* CPU for data */
 190         caddr_t dtpda_data;                     /* pointer to raw data */
 191         dtrace_flowkind_t dtpda_flow;           /* flow kind */
 192         const char *dtpda_prefix;               /* recommended flow prefix */
 193         int dtpda_indent;                       /* recommended flow indent */
 194 } dtrace_probedata_t;
 195
 196 typedef int dtrace_consume_probe_f(const dtrace_probedata_t *, void *);
 197 typedef int dtrace_consume_rec_f(const dtrace_probedata_t *,
 198     const dtrace_recdesc_t *, void *);
 199
 200 extern int dtrace_consume(dtrace_hdl_t *, FILE *,
 201     dtrace_consume_probe_f *, dtrace_consume_rec_f *, void *);
 202
 203 #define DTRACE_STATUS_NONE      0       /* no status; not yet time */
 204 #define DTRACE_STATUS_OKAY      1       /* status okay */
 205 #define DTRACE_STATUS_EXITED    2       /* exit() was called; tracing stopped */
 206 #define DTRACE_STATUS_FILLED    3       /* fill buffer filled; tracing stoped */
 207 #define DTRACE_STATUS_STOPPED   4       /* tracing already stopped */
 208
 209 extern int dtrace_status(dtrace_hdl_t *);
 210
 211 /*
 212  * DTrace Formatted Output Interfaces
 213  *
 214  * To format output associated with a given dtrace_stmtdesc, the caller can
 215  * invoke one of the following functions, passing the opaque dtsd_fmtdata and a
 216  * list of record descriptions.  These functions return either -1 to indicate
 217  * an error, or a positive integer indicating the number of records consumed.
 218  * For anonymous enablings, the consumer can use the dtrd_format member of
 219  * the record description to obtain a format description.  The dtfd_string
 220  * member of the format description may be passed to dtrace_print{fa}_create()
 221  * to create the opaque format data.
 222  */
 223 extern void *dtrace_printf_create(dtrace_hdl_t *, const char *);
 224 extern void *dtrace_printa_create(dtrace_hdl_t *, const char *);
 225 extern size_t dtrace_printf_format(dtrace_hdl_t *, void *, char *, size_t);
 226
 227 extern int dtrace_fprintf(dtrace_hdl_t *, FILE *, void *,
 228     const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t,
 229     const void *, size_t);
 230
 231 extern int dtrace_fprinta(dtrace_hdl_t *, FILE *, void *,
 232     const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t,
 233     const void *, size_t);
 234
 235 extern int dtrace_system(dtrace_hdl_t *, FILE *, void *,
 236     const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t,
 237     const void *, size_t);
 238
 239 extern int dtrace_freopen(dtrace_hdl_t *, FILE *, void *,
 240     const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t,
 241     const void *, size_t);
 242
 243 /*
 244  * DTrace Work Interface
 245  */
 246 typedef enum {
 247         DTRACE_WORKSTATUS_ERROR = -1,
 248         DTRACE_WORKSTATUS_OKAY,
 249         DTRACE_WORKSTATUS_DONE
 250 } dtrace_workstatus_t;
 251
 252 extern dtrace_workstatus_t dtrace_work(dtrace_hdl_t *, FILE *,
 253     dtrace_consume_probe_f *, dtrace_consume_rec_f *, void *);
 254
 255 /*
 256  * DTrace Handler Interface
 257  */
 258 #define DTRACE_HANDLE_ABORT             -1      /* abort current operation */
 259 #define DTRACE_HANDLE_OK                0       /* handled okay; continue */
 260
 261 typedef struct dtrace_errdata {
 262         dtrace_hdl_t *dteda_handle;             /* handle to DTrace library */
 263         dtrace_eprobedesc_t *dteda_edesc;       /* enabled probe inducing err */
 264         dtrace_probedesc_t *dteda_pdesc;        /* probe inducing error */
 265         processorid_t dteda_cpu;                /* CPU of error */
 266         int dteda_action;                       /* action inducing error */
 267         int dteda_offset;                       /* offset in DIFO of error */
 268         int dteda_fault;                        /* specific fault */
 269         uint64_t dteda_addr;                    /* address of fault, if any */
 270         const char *dteda_msg;                  /* preconstructed message */
 271 } dtrace_errdata_t;
 272
 273 typedef int dtrace_handle_err_f(const dtrace_errdata_t *, void *);
 274 extern int dtrace_handle_err(dtrace_hdl_t *, dtrace_handle_err_f *, void *);
 275
 276 typedef enum {
 277         DTRACEDROP_PRINCIPAL,                   /* drop to principal buffer */
 278         DTRACEDROP_AGGREGATION,                 /* drop to aggregation buffer */
 279         DTRACEDROP_DYNAMIC,                     /* dynamic drop */
 280         DTRACEDROP_DYNRINSE,                    /* dyn drop due to rinsing */
 281         DTRACEDROP_DYNDIRTY,                    /* dyn drop due to dirty */
 282         DTRACEDROP_SPEC,                        /* speculative drop */
 283         DTRACEDROP_SPECBUSY,                    /* spec drop due to busy */
 284         DTRACEDROP_SPECUNAVAIL,                 /* spec drop due to unavail */
 285         DTRACEDROP_STKSTROVERFLOW,              /* stack string tab overflow */
 286         DTRACEDROP_DBLERROR                     /* error in ERROR probe */
 287 } dtrace_dropkind_t;
 288
 289 typedef struct dtrace_dropdata {
 290         dtrace_hdl_t *dtdda_handle;             /* handle to DTrace library */
 291         processorid_t dtdda_cpu;                /* CPU, if any */
 292         dtrace_dropkind_t dtdda_kind;           /* kind of drop */
 293         uint64_t dtdda_drops;                   /* number of drops */
 294         uint64_t dtdda_total;                   /* total drops */
 295         const char *dtdda_msg;                  /* preconstructed message */
 296 } dtrace_dropdata_t;
 297
 298 typedef int dtrace_handle_drop_f(const dtrace_dropdata_t *, void *);
 299 extern int dtrace_handle_drop(dtrace_hdl_t *, dtrace_handle_drop_f *, void *);
 300
 301 typedef void dtrace_handle_proc_f(struct ps_prochandle *, const char *, void *);
 302 extern int dtrace_handle_proc(dtrace_hdl_t *, dtrace_handle_proc_f *, void *);
 303
 304 #define DTRACE_BUFDATA_AGGKEY           0x0001  /* aggregation key */
 305 #define DTRACE_BUFDATA_AGGVAL           0x0002  /* aggregation value */
 306 #define DTRACE_BUFDATA_AGGFORMAT        0x0004  /* aggregation format data */
 307 #define DTRACE_BUFDATA_AGGLAST          0x0008  /* last for this key/val */
 308
 309 typedef struct dtrace_bufdata {
 310         dtrace_hdl_t *dtbda_handle;             /* handle to DTrace library */
 311         const char *dtbda_buffered;             /* buffered output */
 312         dtrace_probedata_t *dtbda_probe;        /* probe data */
 313         const dtrace_recdesc_t *dtbda_recdesc;  /* record description */
 314         const dtrace_aggdata_t *dtbda_aggdata;  /* aggregation data, if agg. */
 315         uint32_t dtbda_flags;                   /* flags; see above */
 316 } dtrace_bufdata_t;
 317
 318 typedef int dtrace_handle_buffered_f(const dtrace_bufdata_t *, void *);
 319 extern int dtrace_handle_buffered(dtrace_hdl_t *,
 320     dtrace_handle_buffered_f *, void *);
 321
 322 typedef struct dtrace_setoptdata {
 323         dtrace_hdl_t *dtsda_handle;             /* handle to DTrace library */
 324         const dtrace_probedata_t *dtsda_probe;  /* probe data */
 325         const char *dtsda_option;               /* option that was set */
 326         dtrace_optval_t dtsda_oldval;           /* old value */
 327         dtrace_optval_t dtsda_newval;           /* new value */
 328 } dtrace_setoptdata_t;
 329
 330 typedef int dtrace_handle_setopt_f(const dtrace_setoptdata_t *, void *);
 331 extern int dtrace_handle_setopt(dtrace_hdl_t *,
 332     dtrace_handle_setopt_f *, void *);
 333
 334 /*
 335  * DTrace Aggregate Interface
 336  */
 337
 338 #define DTRACE_A_PERCPU         0x0001
 339 #define DTRACE_A_KEEPDELTA      0x0002
 340 #define DTRACE_A_ANONYMOUS      0x0004
 341
 342 #define DTRACE_AGGWALK_ERROR            -1      /* error while processing */
 343 #define DTRACE_AGGWALK_NEXT             0       /* proceed to next element */
 344 #define DTRACE_AGGWALK_ABORT            1       /* abort aggregation walk */
 345 #define DTRACE_AGGWALK_CLEAR            2       /* clear this element */
 346 #define DTRACE_AGGWALK_NORMALIZE        3       /* normalize this element */
 347 #define DTRACE_AGGWALK_DENORMALIZE      4       /* denormalize this element */
 348 #define DTRACE_AGGWALK_REMOVE           5       /* remove this element */
 349
 350 struct dtrace_aggdata {
 351         dtrace_hdl_t *dtada_handle;             /* handle to DTrace library */
 352         dtrace_aggdesc_t *dtada_desc;           /* aggregation description */
 353         dtrace_eprobedesc_t *dtada_edesc;       /* enabled probe description */
 354         dtrace_probedesc_t *dtada_pdesc;        /* probe description */
 355         caddr_t dtada_data;                     /* pointer to raw data */
 356         uint64_t dtada_normal;                  /* the normal -- 1 for denorm */
 357         size_t dtada_size;                      /* total size of the data */
 358         caddr_t dtada_delta;                    /* delta data, if available */
 359         caddr_t *dtada_percpu;                  /* per CPU data, if avail */
 360         caddr_t *dtada_percpu_delta;            /* per CPU delta, if avail */
 361 };
 362
 363 typedef int dtrace_aggregate_f(const dtrace_aggdata_t *, void *);
 364 typedef int dtrace_aggregate_walk_f(dtrace_hdl_t *,
 365     dtrace_aggregate_f *, void *);
 366 typedef int dtrace_aggregate_walk_joined_f(const dtrace_aggdata_t **,
 367     const int, void *);
 368
 369 extern void dtrace_aggregate_clear(dtrace_hdl_t *);
 370 extern int dtrace_aggregate_snap(dtrace_hdl_t *);
 371 extern int dtrace_aggregate_print(dtrace_hdl_t *, FILE *,
 372     dtrace_aggregate_walk_f *);
 373
 374 extern int dtrace_aggregate_walk(dtrace_hdl_t *, dtrace_aggregate_f *, void *);
 375
 376 extern int dtrace_aggregate_walk_joined(dtrace_hdl_t *,
 377     dtrace_aggvarid_t *, int, dtrace_aggregate_walk_joined_f *, void *);
 378
 379 extern int dtrace_aggregate_walk_sorted(dtrace_hdl_t *,
 380     dtrace_aggregate_f *, void *);
 381
 382 extern int dtrace_aggregate_walk_keysorted(dtrace_hdl_t *,
 383     dtrace_aggregate_f *, void *);
 384
 385 extern int dtrace_aggregate_walk_valsorted(dtrace_hdl_t *,
 386     dtrace_aggregate_f *, void *);
 387
 388 extern int dtrace_aggregate_walk_keyvarsorted(dtrace_hdl_t *,
 389     dtrace_aggregate_f *, void *);
 390
 391 extern int dtrace_aggregate_walk_valvarsorted(dtrace_hdl_t *,
 392     dtrace_aggregate_f *, void *);
 393
 394 extern int dtrace_aggregate_walk_keyrevsorted(dtrace_hdl_t *,
 395     dtrace_aggregate_f *, void *);
 396
 397 extern int dtrace_aggregate_walk_valrevsorted(dtrace_hdl_t *,
 398     dtrace_aggregate_f *, void *);
 399
 400 extern int dtrace_aggregate_walk_keyvarrevsorted(dtrace_hdl_t *,
 401     dtrace_aggregate_f *, void *);
 402
 403 extern int dtrace_aggregate_walk_valvarrevsorted(dtrace_hdl_t *,
 404     dtrace_aggregate_f *, void *);
 405
 406 #define DTRACE_AGD_PRINTED      0x1     /* aggregation printed in program */
 407
 408 /*
 409  * DTrace Process Control Interface
 410  *
 411  * Library clients who wish to have libdtrace create or grab processes for
 412  * monitoring of their symbol table changes may use these interfaces to
 413  * request that libdtrace obtain control of the process using libproc.
 414  */
 415
 416 extern struct ps_prochandle *dtrace_proc_create(dtrace_hdl_t *,
 417     const char *, char *const *, proc_child_func *, void *);
 418
 419 extern struct ps_prochandle *dtrace_proc_grab(dtrace_hdl_t *, pid_t, int);
 420 extern void dtrace_proc_release(dtrace_hdl_t *, struct ps_prochandle *);
 421 extern void dtrace_proc_continue(dtrace_hdl_t *, struct ps_prochandle *);
 422
 423 /*
 424  * DTrace Object, Symbol, and Type Interfaces
 425  *
 426  * Library clients can use libdtrace to perform symbol and C type information
 427  * lookups by symbol name, symbol address, or C type name, or to lookup meta-
 428  * information cached for each of the program objects in use by DTrace.  The
 429  * resulting struct contain pointers to arbitrary-length strings, including
 430  * object, symbol, and type names, that are persistent until the next call to
 431  * dtrace_update().  Once dtrace_update() is called, any cached values must
 432  * be flushed and not used subsequently by the client program.
 433  */
 434
 435 #define DTRACE_OBJ_EXEC  ((const char *)0L)     /* primary executable file */
 436 #define DTRACE_OBJ_RTLD  ((const char *)1L)     /* run-time link-editor */
 437 #define DTRACE_OBJ_CDEFS ((const char *)2L)     /* C include definitions */
 438 #define DTRACE_OBJ_DDEFS ((const char *)3L)     /* D program definitions */
 439 #define DTRACE_OBJ_EVERY ((const char *)-1L)    /* all known objects */
 440 #define DTRACE_OBJ_KMODS ((const char *)-2L)    /* all kernel objects */
 441 #define DTRACE_OBJ_UMODS ((const char *)-3L)    /* all user objects */
 442
 443 typedef struct dtrace_objinfo {
 444         const char *dto_name;                   /* object file scope name */
 445         const char *dto_file;                   /* object file path (if any) */
 446         int dto_id;                             /* object file id (if any) */
 447         uint_t dto_flags;                       /* object flags (see below) */
 448         GElf_Addr dto_text_va;                  /* address of text section */
 449         GElf_Xword dto_text_size;               /* size of text section */
 450         GElf_Addr dto_data_va;                  /* address of data section */
 451         GElf_Xword dto_data_size;               /* size of data section */
 452         GElf_Addr dto_bss_va;                   /* address of BSS */
 453         GElf_Xword dto_bss_size;                /* size of BSS */
 454 } dtrace_objinfo_t;
 455
 456 #define DTRACE_OBJ_F_KERNEL     0x1             /* object is a kernel module */
 457 #define DTRACE_OBJ_F_PRIMARY    0x2             /* object is a primary module */
 458
 459 typedef int dtrace_obj_f(dtrace_hdl_t *, const dtrace_objinfo_t *, void *);
 460
 461 extern int dtrace_object_iter(dtrace_hdl_t *, dtrace_obj_f *, void *);
 462 extern int dtrace_object_info(dtrace_hdl_t *, const char *, dtrace_objinfo_t *);
 463
 464 typedef struct dtrace_syminfo {
 465         const char *dts_object;                 /* object name */
 466         const char *dts_name;                   /* symbol name */
 467         ulong_t dts_id;                         /* symbol id */
 468 } dtrace_syminfo_t;
 469
 470 extern int dtrace_lookup_by_name(dtrace_hdl_t *, const char *, const char *,
 471     GElf_Sym *, dtrace_syminfo_t *);
 472
 473 extern int dtrace_lookup_by_addr(dtrace_hdl_t *, GElf_Addr addr,
 474     GElf_Sym *, dtrace_syminfo_t *);
 475
 476 typedef struct dtrace_typeinfo {
 477         const char *dtt_object;                 /* object containing type */
 478         ctf_file_t *dtt_ctfp;                   /* CTF container handle */
 479         ctf_id_t dtt_type;                      /* CTF type identifier */
 480 } dtrace_typeinfo_t;
 481
 482 extern int dtrace_lookup_by_type(dtrace_hdl_t *, const char *, const char *,
 483     dtrace_typeinfo_t *);
 484
 485 extern int dtrace_symbol_type(dtrace_hdl_t *, const GElf_Sym *,
 486     const dtrace_syminfo_t *, dtrace_typeinfo_t *);
 487
 488 extern int dtrace_type_strcompile(dtrace_hdl_t *,
 489     const char *, dtrace_typeinfo_t *);
 490
 491 extern int dtrace_type_fcompile(dtrace_hdl_t *,
 492     FILE *, dtrace_typeinfo_t *);
 493
 494 /*
 495  * DTrace Probe Interface
 496  *
 497  * Library clients can use these functions to iterate over the set of available
 498  * probe definitions and inquire as to their attributes.  The probe iteration
 499  * interfaces report probes that are declared as well as those from dtrace(7D).
 500  */
 501 typedef struct dtrace_probeinfo {
 502         dtrace_attribute_t dtp_attr;            /* name attributes */
 503         dtrace_attribute_t dtp_arga;            /* arg attributes */
 504         const dtrace_typeinfo_t *dtp_argv;      /* arg types */
 505         int dtp_argc;                           /* arg count */
 506 } dtrace_probeinfo_t;
 507
 508 typedef int dtrace_probe_f(dtrace_hdl_t *, const dtrace_probedesc_t *, void *);
 509
 510 extern int dtrace_probe_iter(dtrace_hdl_t *,
 511     const dtrace_probedesc_t *pdp, dtrace_probe_f *, void *);
 512
 513 extern int dtrace_probe_info(dtrace_hdl_t *,
 514     const dtrace_probedesc_t *, dtrace_probeinfo_t *);
 515
 516 /*
 517  * DTrace Vector Interface
 518  *
 519  * The DTrace library normally speaks directly to dtrace(7D).  However,
 520  * this communication may be vectored elsewhere.  Consumers who wish to
 521  * perform a vectored open must fill in the vector, and use the dtrace_vopen()
 522  * entry point to obtain a library handle.
 523  */
 524 struct dtrace_vector {
 525 #if defined(sun)
 526         int (*dtv_ioctl)(void *, int, void *);
 527 #else
 528         int (*dtv_ioctl)(void *, u_long, void *);
 529 #endif
 530         int (*dtv_lookup_by_addr)(void *, GElf_Addr, GElf_Sym *,
 531             dtrace_syminfo_t *);
 532         int (*dtv_status)(void *, processorid_t);
 533         long (*dtv_sysconf)(void *, int);
 534 };
 535
 536 /*
 537  * DTrace Utility Functions
 538  *
 539  * Library clients can use these functions to convert addresses strings, to
 540  * convert between string and integer probe descriptions and the
 541  * dtrace_probedesc_t representation, and to perform similar conversions on
 542  * stability attributes.
 543  */
 544 extern int dtrace_addr2str(dtrace_hdl_t *, uint64_t, char *, int);
 545 extern int dtrace_uaddr2str(dtrace_hdl_t *, pid_t, uint64_t, char *, int);
 546
 547 extern int dtrace_xstr2desc(dtrace_hdl_t *, dtrace_probespec_t,
 548     const char *, int, char *const [], dtrace_probedesc_t *);
 549
 550 extern int dtrace_str2desc(dtrace_hdl_t *, dtrace_probespec_t,
 551     const char *, dtrace_probedesc_t *);
 552
 553 extern int dtrace_id2desc(dtrace_hdl_t *, dtrace_id_t, dtrace_probedesc_t *);
 554
 555 #define DTRACE_DESC2STR_MAX     1024    /* min buf size for dtrace_desc2str() */
 556
 557 extern char *dtrace_desc2str(const dtrace_probedesc_t *, char *, size_t);
 558
 559 #define DTRACE_ATTR2STR_MAX     64      /* min buf size for dtrace_attr2str() */
 560
 561 extern char *dtrace_attr2str(dtrace_attribute_t, char *, size_t);
 562 extern int dtrace_str2attr(const char *, dtrace_attribute_t *);
 563
 564 extern const char *dtrace_stability_name(dtrace_stability_t);
 565 extern const char *dtrace_class_name(dtrace_class_t);
 566
 567 extern int dtrace_provider_modules(dtrace_hdl_t *, const char **, int);
 568
 569 extern const char *const _dtrace_version;
 570 extern int _dtrace_debug;
 571
 572 #ifdef  __cplusplus
 573 }
 574 #endif
 575
 576 #if !defined(sun)
 577 #define _SC_CPUID_MAX           _SC_NPROCESSORS_CONF
 578 #define _SC_NPROCESSORS_MAX     _SC_NPROCESSORS_CONF
 579 #endif
 580
 581 #endif  /* _DTRACE_H */