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