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