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