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