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