1178479Sjb/* 2178479Sjb * CDDL HEADER START 3178479Sjb * 4178479Sjb * The contents of this file are subject to the terms of the 5178479Sjb * Common Development and Distribution License (the "License"). 6178479Sjb * You may not use this file except in compliance with the License. 7178479Sjb * 8178479Sjb * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9178479Sjb * or http://www.opensolaris.org/os/licensing. 10178479Sjb * See the License for the specific language governing permissions 11178479Sjb * and limitations under the License. 12178479Sjb * 13178479Sjb * When distributing Covered Code, include this CDDL HEADER in each 14178479Sjb * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15178479Sjb * If applicable, add the following below this CDDL HEADER, with the 16178479Sjb * fields enclosed by brackets "[]" replaced with your own identifying 17178479Sjb * information: Portions Copyright [yyyy] [name of copyright owner] 18178479Sjb * 19178479Sjb * CDDL HEADER END 20178479Sjb */ 21178479Sjb 22178479Sjb/* 23178479Sjb * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 24178479Sjb * Use is subject to license terms. 25178479Sjb */ 26178479Sjb 27237624Spfg/* 28268578Srpaulo * Copyright (c) 2013 by Delphix. All rights reserved. 29268578Srpaulo * Copyright (c) 2013, Joyent, Inc. All rights reserved. 30237624Spfg */ 31237624Spfg 32178479Sjb#ifndef _DTRACE_H 33178479Sjb#define _DTRACE_H 34178479Sjb 35178479Sjb#include <sys/dtrace.h> 36178479Sjb#include <stdarg.h> 37178479Sjb#include <stdio.h> 38178479Sjb#include <gelf.h> 39184696Srodrigc#include <libproc.h> 40297077Smav#ifndef illumos 41211554Srpaulo#include <rtld_db.h> 42211554Srpaulo#endif 43178479Sjb 44178479Sjb#ifdef __cplusplus 45178479Sjbextern "C" { 46178479Sjb#endif 47178479Sjb 48178479Sjb/* 49178479Sjb * DTrace Dynamic Tracing Software: Library Interfaces 50178479Sjb * 51178479Sjb * Note: The contents of this file are private to the implementation of the 52178479Sjb * Solaris system and DTrace subsystem and are subject to change at any time 53178479Sjb * without notice. Applications and drivers using these interfaces will fail 54178479Sjb * to run on future releases. These interfaces should not be used for any 55178479Sjb * purpose except those expressly outlined in dtrace(7D) and libdtrace(3LIB). 56178479Sjb * Please refer to the "Solaris Dynamic Tracing Guide" for more information. 57178479Sjb */ 58178479Sjb 59178479Sjb#define DTRACE_VERSION 3 /* library ABI interface version */ 60178479Sjb 61178479Sjbstruct ps_prochandle; 62178479Sjbtypedef struct dtrace_hdl dtrace_hdl_t; 63178479Sjbtypedef struct dtrace_prog dtrace_prog_t; 64178479Sjbtypedef struct dtrace_vector dtrace_vector_t; 65178479Sjbtypedef struct dtrace_aggdata dtrace_aggdata_t; 66178479Sjb 67178479Sjb#define DTRACE_O_NODEV 0x01 /* do not open dtrace(7D) device */ 68178479Sjb#define DTRACE_O_NOSYS 0x02 /* do not load /system/object modules */ 69178479Sjb#define DTRACE_O_LP64 0x04 /* force D compiler to be LP64 */ 70178479Sjb#define DTRACE_O_ILP32 0x08 /* force D compiler to be ILP32 */ 71178479Sjb#define DTRACE_O_MASK 0x0f /* mask of valid flags to dtrace_open */ 72178479Sjb 73178479Sjbextern dtrace_hdl_t *dtrace_open(int, int, int *); 74178479Sjbextern dtrace_hdl_t *dtrace_vopen(int, int, int *, 75178479Sjb const dtrace_vector_t *, void *); 76178479Sjb 77178479Sjbextern int dtrace_go(dtrace_hdl_t *); 78178479Sjbextern int dtrace_stop(dtrace_hdl_t *); 79178479Sjbextern void dtrace_sleep(dtrace_hdl_t *); 80178479Sjbextern void dtrace_close(dtrace_hdl_t *); 81178479Sjb 82178479Sjbextern int dtrace_errno(dtrace_hdl_t *); 83178479Sjbextern const char *dtrace_errmsg(dtrace_hdl_t *, int); 84178479Sjbextern const char *dtrace_faultstr(dtrace_hdl_t *, int); 85178479Sjbextern const char *dtrace_subrstr(dtrace_hdl_t *, int); 86178479Sjb 87178479Sjbextern int dtrace_setopt(dtrace_hdl_t *, const char *, const char *); 88178479Sjbextern int dtrace_getopt(dtrace_hdl_t *, const char *, dtrace_optval_t *); 89178479Sjb 90178479Sjbextern void dtrace_update(dtrace_hdl_t *); 91178479Sjbextern int dtrace_ctlfd(dtrace_hdl_t *); 92178479Sjb 93178479Sjb/* 94178479Sjb * DTrace Program Interface 95178479Sjb * 96178479Sjb * DTrace programs can be created by compiling ASCII text files containing 97178479Sjb * D programs or by compiling in-memory C strings that specify a D program. 98178479Sjb * Once created, callers can examine the list of program statements and 99178479Sjb * enable the probes and actions described by these statements. 100178479Sjb */ 101178479Sjb 102178479Sjbtypedef struct dtrace_proginfo { 103178479Sjb dtrace_attribute_t dpi_descattr; /* minimum probedesc attributes */ 104178479Sjb dtrace_attribute_t dpi_stmtattr; /* minimum statement attributes */ 105178479Sjb uint_t dpi_aggregates; /* number of aggregates specified in program */ 106178479Sjb uint_t dpi_recgens; /* number of record generating probes in prog */ 107178479Sjb uint_t dpi_matches; /* number of probes matched by program */ 108178479Sjb uint_t dpi_speculations; /* number of speculations specified in prog */ 109178479Sjb} dtrace_proginfo_t; 110178479Sjb 111178479Sjb#define DTRACE_C_DIFV 0x0001 /* DIF verbose mode: show each compiled DIFO */ 112178479Sjb#define DTRACE_C_EMPTY 0x0002 /* Permit compilation of empty D source files */ 113178479Sjb#define DTRACE_C_ZDEFS 0x0004 /* Permit probe defs that match zero probes */ 114178479Sjb#define DTRACE_C_EATTR 0x0008 /* Error if program attributes less than min */ 115178479Sjb#define DTRACE_C_CPP 0x0010 /* Preprocess input file with cpp(1) utility */ 116178479Sjb#define DTRACE_C_KNODEF 0x0020 /* Permit unresolved kernel symbols in DIFO */ 117178479Sjb#define DTRACE_C_UNODEF 0x0040 /* Permit unresolved user symbols in DIFO */ 118178479Sjb#define DTRACE_C_PSPEC 0x0080 /* Intepret ambiguous specifiers as probes */ 119178479Sjb#define DTRACE_C_ETAGS 0x0100 /* Prefix error messages with error tags */ 120178479Sjb#define DTRACE_C_ARGREF 0x0200 /* Do not require all macro args to be used */ 121178479Sjb#define DTRACE_C_DEFARG 0x0800 /* Use 0/"" as value for unspecified args */ 122178479Sjb#define DTRACE_C_NOLIBS 0x1000 /* Do not process D system libraries */ 123178479Sjb#define DTRACE_C_CTL 0x2000 /* Only process control directives */ 124178479Sjb#define DTRACE_C_MASK 0x3bff /* mask of all valid flags to dtrace_*compile */ 125178479Sjb 126178479Sjbextern dtrace_prog_t *dtrace_program_strcompile(dtrace_hdl_t *, 127178479Sjb const char *, dtrace_probespec_t, uint_t, int, char *const []); 128178479Sjb 129178479Sjbextern dtrace_prog_t *dtrace_program_fcompile(dtrace_hdl_t *, 130178479Sjb FILE *, uint_t, int, char *const []); 131178479Sjb 132178479Sjbextern int dtrace_program_exec(dtrace_hdl_t *, dtrace_prog_t *, 133178479Sjb dtrace_proginfo_t *); 134178479Sjbextern void dtrace_program_info(dtrace_hdl_t *, dtrace_prog_t *, 135178479Sjb dtrace_proginfo_t *); 136178479Sjb 137178479Sjb#define DTRACE_D_STRIP 0x01 /* strip non-loadable sections from program */ 138178479Sjb#define DTRACE_D_PROBES 0x02 /* include provider and probe definitions */ 139178479Sjb#define DTRACE_D_MASK 0x03 /* mask of valid flags to dtrace_dof_create */ 140178479Sjb 141178479Sjbextern int dtrace_program_link(dtrace_hdl_t *, dtrace_prog_t *, 142178479Sjb uint_t, const char *, int, char *const []); 143178479Sjb 144178479Sjbextern int dtrace_program_header(dtrace_hdl_t *, FILE *, const char *); 145178479Sjb 146178479Sjbextern void *dtrace_dof_create(dtrace_hdl_t *, dtrace_prog_t *, uint_t); 147178479Sjbextern void dtrace_dof_destroy(dtrace_hdl_t *, void *); 148178479Sjb 149178479Sjbextern void *dtrace_getopt_dof(dtrace_hdl_t *); 150178479Sjbextern void *dtrace_geterr_dof(dtrace_hdl_t *); 151178479Sjb 152178479Sjbtypedef struct dtrace_stmtdesc { 153178479Sjb dtrace_ecbdesc_t *dtsd_ecbdesc; /* ECB description */ 154178479Sjb dtrace_actdesc_t *dtsd_action; /* action list */ 155178479Sjb dtrace_actdesc_t *dtsd_action_last; /* last action in action list */ 156178479Sjb void *dtsd_aggdata; /* aggregation data */ 157178479Sjb void *dtsd_fmtdata; /* type-specific output data */ 158248708Spfg void *dtsd_strdata; /* type-specific string data */ 159178550Sjb void (*dtsd_callback)(void); /* callback function for EPID */ 160178479Sjb void *dtsd_data; /* callback data pointer */ 161178479Sjb dtrace_attribute_t dtsd_descattr; /* probedesc attributes */ 162178479Sjb dtrace_attribute_t dtsd_stmtattr; /* statement attributes */ 163178479Sjb} dtrace_stmtdesc_t; 164178479Sjb 165178479Sjbtypedef int dtrace_stmt_f(dtrace_hdl_t *, dtrace_prog_t *, 166178479Sjb dtrace_stmtdesc_t *, void *); 167178479Sjb 168178479Sjbextern dtrace_stmtdesc_t *dtrace_stmt_create(dtrace_hdl_t *, 169178479Sjb dtrace_ecbdesc_t *); 170178479Sjbextern dtrace_actdesc_t *dtrace_stmt_action(dtrace_hdl_t *, 171178479Sjb dtrace_stmtdesc_t *); 172178479Sjbextern int dtrace_stmt_add(dtrace_hdl_t *, dtrace_prog_t *, 173178479Sjb dtrace_stmtdesc_t *); 174178479Sjbextern int dtrace_stmt_iter(dtrace_hdl_t *, dtrace_prog_t *, 175178479Sjb dtrace_stmt_f *, void *); 176178479Sjbextern void dtrace_stmt_destroy(dtrace_hdl_t *, dtrace_stmtdesc_t *); 177178479Sjb 178178479Sjb/* 179178479Sjb * DTrace Data Consumption Interface 180178479Sjb */ 181178479Sjbtypedef enum { 182178479Sjb DTRACEFLOW_ENTRY, 183178479Sjb DTRACEFLOW_RETURN, 184178479Sjb DTRACEFLOW_NONE 185178479Sjb} dtrace_flowkind_t; 186178479Sjb 187178479Sjb#define DTRACE_CONSUME_ERROR -1 /* error while processing */ 188178479Sjb#define DTRACE_CONSUME_THIS 0 /* consume this probe/record */ 189178479Sjb#define DTRACE_CONSUME_NEXT 1 /* advance to next probe/rec */ 190178479Sjb#define DTRACE_CONSUME_ABORT 2 /* abort consumption */ 191178479Sjb 192178479Sjbtypedef struct dtrace_probedata { 193178479Sjb dtrace_hdl_t *dtpda_handle; /* handle to DTrace library */ 194178479Sjb dtrace_eprobedesc_t *dtpda_edesc; /* enabled probe description */ 195178479Sjb dtrace_probedesc_t *dtpda_pdesc; /* probe description */ 196178479Sjb processorid_t dtpda_cpu; /* CPU for data */ 197178479Sjb caddr_t dtpda_data; /* pointer to raw data */ 198178479Sjb dtrace_flowkind_t dtpda_flow; /* flow kind */ 199178479Sjb const char *dtpda_prefix; /* recommended flow prefix */ 200178479Sjb int dtpda_indent; /* recommended flow indent */ 201178479Sjb} dtrace_probedata_t; 202178479Sjb 203178479Sjbtypedef int dtrace_consume_probe_f(const dtrace_probedata_t *, void *); 204178479Sjbtypedef int dtrace_consume_rec_f(const dtrace_probedata_t *, 205178479Sjb const dtrace_recdesc_t *, void *); 206178479Sjb 207178479Sjbextern int dtrace_consume(dtrace_hdl_t *, FILE *, 208178479Sjb dtrace_consume_probe_f *, dtrace_consume_rec_f *, void *); 209178479Sjb 210178479Sjb#define DTRACE_STATUS_NONE 0 /* no status; not yet time */ 211178479Sjb#define DTRACE_STATUS_OKAY 1 /* status okay */ 212178479Sjb#define DTRACE_STATUS_EXITED 2 /* exit() was called; tracing stopped */ 213178479Sjb#define DTRACE_STATUS_FILLED 3 /* fill buffer filled; tracing stoped */ 214178479Sjb#define DTRACE_STATUS_STOPPED 4 /* tracing already stopped */ 215178479Sjb 216178479Sjbextern int dtrace_status(dtrace_hdl_t *); 217178479Sjb 218178479Sjb/* 219178479Sjb * DTrace Formatted Output Interfaces 220178479Sjb * 221178479Sjb * To format output associated with a given dtrace_stmtdesc, the caller can 222178479Sjb * invoke one of the following functions, passing the opaque dtsd_fmtdata and a 223178479Sjb * list of record descriptions. These functions return either -1 to indicate 224178479Sjb * an error, or a positive integer indicating the number of records consumed. 225178479Sjb * For anonymous enablings, the consumer can use the dtrd_format member of 226178479Sjb * the record description to obtain a format description. The dtfd_string 227178479Sjb * member of the format description may be passed to dtrace_print{fa}_create() 228178479Sjb * to create the opaque format data. 229178479Sjb */ 230178479Sjbextern void *dtrace_printf_create(dtrace_hdl_t *, const char *); 231178479Sjbextern void *dtrace_printa_create(dtrace_hdl_t *, const char *); 232178479Sjbextern size_t dtrace_printf_format(dtrace_hdl_t *, void *, char *, size_t); 233178479Sjb 234178479Sjbextern int dtrace_fprintf(dtrace_hdl_t *, FILE *, void *, 235178479Sjb const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 236178479Sjb const void *, size_t); 237178479Sjb 238178479Sjbextern int dtrace_fprinta(dtrace_hdl_t *, FILE *, void *, 239178479Sjb const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 240178479Sjb const void *, size_t); 241178479Sjb 242178479Sjbextern int dtrace_system(dtrace_hdl_t *, FILE *, void *, 243178479Sjb const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 244178479Sjb const void *, size_t); 245178479Sjb 246178479Sjbextern int dtrace_freopen(dtrace_hdl_t *, FILE *, void *, 247178479Sjb const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 248178479Sjb const void *, size_t); 249178479Sjb 250178479Sjb/* 251248708Spfg * Type-specific output printing 252248708Spfg * 253248708Spfg * The print() action will associate a string data record that is actually the 254248708Spfg * fully-qualified type name of the data traced by the DIFEXPR action. This is 255248708Spfg * stored in the same 'format' record from the kernel, but we know by virtue of 256248708Spfg * the fact that the action is still DIFEXPR that it is actually a reference to 257248708Spfg * plain string data. 258248708Spfg */ 259248708Spfgextern int dtrace_print(dtrace_hdl_t *, FILE *, const char *, 260248708Spfg caddr_t, size_t); 261248708Spfg 262248708Spfg/* 263178479Sjb * DTrace Work Interface 264178479Sjb */ 265178479Sjbtypedef enum { 266178479Sjb DTRACE_WORKSTATUS_ERROR = -1, 267178479Sjb DTRACE_WORKSTATUS_OKAY, 268178479Sjb DTRACE_WORKSTATUS_DONE 269178479Sjb} dtrace_workstatus_t; 270178479Sjb 271178479Sjbextern dtrace_workstatus_t dtrace_work(dtrace_hdl_t *, FILE *, 272178479Sjb dtrace_consume_probe_f *, dtrace_consume_rec_f *, void *); 273178479Sjb 274178479Sjb/* 275178479Sjb * DTrace Handler Interface 276178479Sjb */ 277178479Sjb#define DTRACE_HANDLE_ABORT -1 /* abort current operation */ 278178479Sjb#define DTRACE_HANDLE_OK 0 /* handled okay; continue */ 279178479Sjb 280178479Sjbtypedef struct dtrace_errdata { 281178479Sjb dtrace_hdl_t *dteda_handle; /* handle to DTrace library */ 282178479Sjb dtrace_eprobedesc_t *dteda_edesc; /* enabled probe inducing err */ 283178479Sjb dtrace_probedesc_t *dteda_pdesc; /* probe inducing error */ 284178479Sjb processorid_t dteda_cpu; /* CPU of error */ 285178479Sjb int dteda_action; /* action inducing error */ 286178479Sjb int dteda_offset; /* offset in DIFO of error */ 287178479Sjb int dteda_fault; /* specific fault */ 288178479Sjb uint64_t dteda_addr; /* address of fault, if any */ 289178479Sjb const char *dteda_msg; /* preconstructed message */ 290178479Sjb} dtrace_errdata_t; 291178479Sjb 292178479Sjbtypedef int dtrace_handle_err_f(const dtrace_errdata_t *, void *); 293178479Sjbextern int dtrace_handle_err(dtrace_hdl_t *, dtrace_handle_err_f *, void *); 294178479Sjb 295178479Sjbtypedef enum { 296178479Sjb DTRACEDROP_PRINCIPAL, /* drop to principal buffer */ 297178479Sjb DTRACEDROP_AGGREGATION, /* drop to aggregation buffer */ 298178479Sjb DTRACEDROP_DYNAMIC, /* dynamic drop */ 299178479Sjb DTRACEDROP_DYNRINSE, /* dyn drop due to rinsing */ 300178479Sjb DTRACEDROP_DYNDIRTY, /* dyn drop due to dirty */ 301178479Sjb DTRACEDROP_SPEC, /* speculative drop */ 302178479Sjb DTRACEDROP_SPECBUSY, /* spec drop due to busy */ 303178479Sjb DTRACEDROP_SPECUNAVAIL, /* spec drop due to unavail */ 304178479Sjb DTRACEDROP_STKSTROVERFLOW, /* stack string tab overflow */ 305178479Sjb DTRACEDROP_DBLERROR /* error in ERROR probe */ 306178479Sjb} dtrace_dropkind_t; 307178479Sjb 308178479Sjbtypedef struct dtrace_dropdata { 309178479Sjb dtrace_hdl_t *dtdda_handle; /* handle to DTrace library */ 310178479Sjb processorid_t dtdda_cpu; /* CPU, if any */ 311178479Sjb dtrace_dropkind_t dtdda_kind; /* kind of drop */ 312178479Sjb uint64_t dtdda_drops; /* number of drops */ 313178479Sjb uint64_t dtdda_total; /* total drops */ 314178479Sjb const char *dtdda_msg; /* preconstructed message */ 315178479Sjb} dtrace_dropdata_t; 316178479Sjb 317178479Sjbtypedef int dtrace_handle_drop_f(const dtrace_dropdata_t *, void *); 318178479Sjbextern int dtrace_handle_drop(dtrace_hdl_t *, dtrace_handle_drop_f *, void *); 319178479Sjb 320178479Sjbtypedef void dtrace_handle_proc_f(struct ps_prochandle *, const char *, void *); 321178479Sjbextern int dtrace_handle_proc(dtrace_hdl_t *, dtrace_handle_proc_f *, void *); 322178479Sjb 323178479Sjb#define DTRACE_BUFDATA_AGGKEY 0x0001 /* aggregation key */ 324178479Sjb#define DTRACE_BUFDATA_AGGVAL 0x0002 /* aggregation value */ 325178479Sjb#define DTRACE_BUFDATA_AGGFORMAT 0x0004 /* aggregation format data */ 326178479Sjb#define DTRACE_BUFDATA_AGGLAST 0x0008 /* last for this key/val */ 327178479Sjb 328178479Sjbtypedef struct dtrace_bufdata { 329178479Sjb dtrace_hdl_t *dtbda_handle; /* handle to DTrace library */ 330178479Sjb const char *dtbda_buffered; /* buffered output */ 331178479Sjb dtrace_probedata_t *dtbda_probe; /* probe data */ 332178479Sjb const dtrace_recdesc_t *dtbda_recdesc; /* record description */ 333178479Sjb const dtrace_aggdata_t *dtbda_aggdata; /* aggregation data, if agg. */ 334178479Sjb uint32_t dtbda_flags; /* flags; see above */ 335178479Sjb} dtrace_bufdata_t; 336178479Sjb 337178479Sjbtypedef int dtrace_handle_buffered_f(const dtrace_bufdata_t *, void *); 338178479Sjbextern int dtrace_handle_buffered(dtrace_hdl_t *, 339178479Sjb dtrace_handle_buffered_f *, void *); 340178479Sjb 341178479Sjbtypedef struct dtrace_setoptdata { 342178479Sjb dtrace_hdl_t *dtsda_handle; /* handle to DTrace library */ 343178479Sjb const dtrace_probedata_t *dtsda_probe; /* probe data */ 344178479Sjb const char *dtsda_option; /* option that was set */ 345178479Sjb dtrace_optval_t dtsda_oldval; /* old value */ 346178479Sjb dtrace_optval_t dtsda_newval; /* new value */ 347178479Sjb} dtrace_setoptdata_t; 348178479Sjb 349178479Sjbtypedef int dtrace_handle_setopt_f(const dtrace_setoptdata_t *, void *); 350178479Sjbextern int dtrace_handle_setopt(dtrace_hdl_t *, 351178479Sjb dtrace_handle_setopt_f *, void *); 352178479Sjb 353178479Sjb/* 354178479Sjb * DTrace Aggregate Interface 355178479Sjb */ 356178479Sjb 357178479Sjb#define DTRACE_A_PERCPU 0x0001 358178479Sjb#define DTRACE_A_KEEPDELTA 0x0002 359178479Sjb#define DTRACE_A_ANONYMOUS 0x0004 360268578Srpaulo#define DTRACE_A_TOTAL 0x0008 361268578Srpaulo#define DTRACE_A_MINMAXBIN 0x0010 362268578Srpaulo#define DTRACE_A_HASNEGATIVES 0x0020 363268578Srpaulo#define DTRACE_A_HASPOSITIVES 0x0040 364178479Sjb 365268578Srpaulo#define DTRACE_AGGZOOM_MAX 0.95 /* height of max bar */ 366268578Srpaulo 367178479Sjb#define DTRACE_AGGWALK_ERROR -1 /* error while processing */ 368178479Sjb#define DTRACE_AGGWALK_NEXT 0 /* proceed to next element */ 369178479Sjb#define DTRACE_AGGWALK_ABORT 1 /* abort aggregation walk */ 370178479Sjb#define DTRACE_AGGWALK_CLEAR 2 /* clear this element */ 371178479Sjb#define DTRACE_AGGWALK_NORMALIZE 3 /* normalize this element */ 372178479Sjb#define DTRACE_AGGWALK_DENORMALIZE 4 /* denormalize this element */ 373178479Sjb#define DTRACE_AGGWALK_REMOVE 5 /* remove this element */ 374178479Sjb 375178479Sjbstruct dtrace_aggdata { 376178479Sjb dtrace_hdl_t *dtada_handle; /* handle to DTrace library */ 377178479Sjb dtrace_aggdesc_t *dtada_desc; /* aggregation description */ 378178479Sjb dtrace_eprobedesc_t *dtada_edesc; /* enabled probe description */ 379178479Sjb dtrace_probedesc_t *dtada_pdesc; /* probe description */ 380178479Sjb caddr_t dtada_data; /* pointer to raw data */ 381178479Sjb uint64_t dtada_normal; /* the normal -- 1 for denorm */ 382178479Sjb size_t dtada_size; /* total size of the data */ 383178479Sjb caddr_t dtada_delta; /* delta data, if available */ 384178479Sjb caddr_t *dtada_percpu; /* per CPU data, if avail */ 385178479Sjb caddr_t *dtada_percpu_delta; /* per CPU delta, if avail */ 386268578Srpaulo int64_t dtada_total; /* per agg total, if avail */ 387268578Srpaulo uint16_t dtada_minbin; /* minimum bin, if avail */ 388268578Srpaulo uint16_t dtada_maxbin; /* maximum bin, if avail */ 389268578Srpaulo uint32_t dtada_flags; /* flags */ 390178479Sjb}; 391178479Sjb 392178479Sjbtypedef int dtrace_aggregate_f(const dtrace_aggdata_t *, void *); 393178479Sjbtypedef int dtrace_aggregate_walk_f(dtrace_hdl_t *, 394178479Sjb dtrace_aggregate_f *, void *); 395178479Sjbtypedef int dtrace_aggregate_walk_joined_f(const dtrace_aggdata_t **, 396178479Sjb const int, void *); 397178479Sjb 398178479Sjbextern void dtrace_aggregate_clear(dtrace_hdl_t *); 399178479Sjbextern int dtrace_aggregate_snap(dtrace_hdl_t *); 400178479Sjbextern int dtrace_aggregate_print(dtrace_hdl_t *, FILE *, 401178479Sjb dtrace_aggregate_walk_f *); 402178479Sjb 403178479Sjbextern int dtrace_aggregate_walk(dtrace_hdl_t *, dtrace_aggregate_f *, void *); 404178479Sjb 405178479Sjbextern int dtrace_aggregate_walk_joined(dtrace_hdl_t *, 406178479Sjb dtrace_aggvarid_t *, int, dtrace_aggregate_walk_joined_f *, void *); 407178479Sjb 408178479Sjbextern int dtrace_aggregate_walk_sorted(dtrace_hdl_t *, 409178479Sjb dtrace_aggregate_f *, void *); 410178479Sjb 411178479Sjbextern int dtrace_aggregate_walk_keysorted(dtrace_hdl_t *, 412178479Sjb dtrace_aggregate_f *, void *); 413178479Sjb 414178479Sjbextern int dtrace_aggregate_walk_valsorted(dtrace_hdl_t *, 415178479Sjb dtrace_aggregate_f *, void *); 416178479Sjb 417178479Sjbextern int dtrace_aggregate_walk_keyvarsorted(dtrace_hdl_t *, 418178479Sjb dtrace_aggregate_f *, void *); 419178479Sjb 420178479Sjbextern int dtrace_aggregate_walk_valvarsorted(dtrace_hdl_t *, 421178479Sjb dtrace_aggregate_f *, void *); 422178479Sjb 423178479Sjbextern int dtrace_aggregate_walk_keyrevsorted(dtrace_hdl_t *, 424178479Sjb dtrace_aggregate_f *, void *); 425178479Sjb 426178479Sjbextern int dtrace_aggregate_walk_valrevsorted(dtrace_hdl_t *, 427178479Sjb dtrace_aggregate_f *, void *); 428178479Sjb 429178479Sjbextern int dtrace_aggregate_walk_keyvarrevsorted(dtrace_hdl_t *, 430178479Sjb dtrace_aggregate_f *, void *); 431178479Sjb 432178479Sjbextern int dtrace_aggregate_walk_valvarrevsorted(dtrace_hdl_t *, 433178479Sjb dtrace_aggregate_f *, void *); 434178479Sjb 435178479Sjb#define DTRACE_AGD_PRINTED 0x1 /* aggregation printed in program */ 436178479Sjb 437178479Sjb/* 438178479Sjb * DTrace Process Control Interface 439178479Sjb * 440178479Sjb * Library clients who wish to have libdtrace create or grab processes for 441178479Sjb * monitoring of their symbol table changes may use these interfaces to 442178479Sjb * request that libdtrace obtain control of the process using libproc. 443178479Sjb */ 444178479Sjb 445178479Sjbextern struct ps_prochandle *dtrace_proc_create(dtrace_hdl_t *, 446184696Srodrigc const char *, char *const *, proc_child_func *, void *); 447178479Sjb 448178479Sjbextern struct ps_prochandle *dtrace_proc_grab(dtrace_hdl_t *, pid_t, int); 449178479Sjbextern void dtrace_proc_release(dtrace_hdl_t *, struct ps_prochandle *); 450178479Sjbextern void dtrace_proc_continue(dtrace_hdl_t *, struct ps_prochandle *); 451178479Sjb 452178479Sjb/* 453178479Sjb * DTrace Object, Symbol, and Type Interfaces 454178479Sjb * 455178479Sjb * Library clients can use libdtrace to perform symbol and C type information 456178479Sjb * lookups by symbol name, symbol address, or C type name, or to lookup meta- 457178479Sjb * information cached for each of the program objects in use by DTrace. The 458178479Sjb * resulting struct contain pointers to arbitrary-length strings, including 459178479Sjb * object, symbol, and type names, that are persistent until the next call to 460178479Sjb * dtrace_update(). Once dtrace_update() is called, any cached values must 461178479Sjb * be flushed and not used subsequently by the client program. 462178479Sjb */ 463178479Sjb 464178479Sjb#define DTRACE_OBJ_EXEC ((const char *)0L) /* primary executable file */ 465178479Sjb#define DTRACE_OBJ_RTLD ((const char *)1L) /* run-time link-editor */ 466178479Sjb#define DTRACE_OBJ_CDEFS ((const char *)2L) /* C include definitions */ 467178479Sjb#define DTRACE_OBJ_DDEFS ((const char *)3L) /* D program definitions */ 468178479Sjb#define DTRACE_OBJ_EVERY ((const char *)-1L) /* all known objects */ 469178479Sjb#define DTRACE_OBJ_KMODS ((const char *)-2L) /* all kernel objects */ 470178479Sjb#define DTRACE_OBJ_UMODS ((const char *)-3L) /* all user objects */ 471178479Sjb 472178479Sjbtypedef struct dtrace_objinfo { 473178479Sjb const char *dto_name; /* object file scope name */ 474178479Sjb const char *dto_file; /* object file path (if any) */ 475178479Sjb int dto_id; /* object file id (if any) */ 476178479Sjb uint_t dto_flags; /* object flags (see below) */ 477178479Sjb GElf_Addr dto_text_va; /* address of text section */ 478178479Sjb GElf_Xword dto_text_size; /* size of text section */ 479178479Sjb GElf_Addr dto_data_va; /* address of data section */ 480178479Sjb GElf_Xword dto_data_size; /* size of data section */ 481178479Sjb GElf_Addr dto_bss_va; /* address of BSS */ 482178479Sjb GElf_Xword dto_bss_size; /* size of BSS */ 483178479Sjb} dtrace_objinfo_t; 484178479Sjb 485178479Sjb#define DTRACE_OBJ_F_KERNEL 0x1 /* object is a kernel module */ 486178479Sjb#define DTRACE_OBJ_F_PRIMARY 0x2 /* object is a primary module */ 487178479Sjb 488178479Sjbtypedef int dtrace_obj_f(dtrace_hdl_t *, const dtrace_objinfo_t *, void *); 489178479Sjb 490178479Sjbextern int dtrace_object_iter(dtrace_hdl_t *, dtrace_obj_f *, void *); 491178479Sjbextern int dtrace_object_info(dtrace_hdl_t *, const char *, dtrace_objinfo_t *); 492178479Sjb 493178479Sjbtypedef struct dtrace_syminfo { 494178479Sjb const char *dts_object; /* object name */ 495178479Sjb const char *dts_name; /* symbol name */ 496178479Sjb ulong_t dts_id; /* symbol id */ 497178479Sjb} dtrace_syminfo_t; 498178479Sjb 499178479Sjbextern int dtrace_lookup_by_name(dtrace_hdl_t *, const char *, const char *, 500178479Sjb GElf_Sym *, dtrace_syminfo_t *); 501178479Sjb 502178479Sjbextern int dtrace_lookup_by_addr(dtrace_hdl_t *, GElf_Addr addr, 503178479Sjb GElf_Sym *, dtrace_syminfo_t *); 504178479Sjb 505178479Sjbtypedef struct dtrace_typeinfo { 506178479Sjb const char *dtt_object; /* object containing type */ 507178479Sjb ctf_file_t *dtt_ctfp; /* CTF container handle */ 508178479Sjb ctf_id_t dtt_type; /* CTF type identifier */ 509268578Srpaulo uint_t dtt_flags; /* Misc. flags */ 510178479Sjb} dtrace_typeinfo_t; 511178479Sjb 512268578Srpaulo#define DTT_FL_USER 0x1 /* user type */ 513268578Srpaulo 514178479Sjbextern int dtrace_lookup_by_type(dtrace_hdl_t *, const char *, const char *, 515178479Sjb dtrace_typeinfo_t *); 516178479Sjb 517178479Sjbextern int dtrace_symbol_type(dtrace_hdl_t *, const GElf_Sym *, 518178479Sjb const dtrace_syminfo_t *, dtrace_typeinfo_t *); 519178479Sjb 520178479Sjbextern int dtrace_type_strcompile(dtrace_hdl_t *, 521178479Sjb const char *, dtrace_typeinfo_t *); 522178479Sjb 523178479Sjbextern int dtrace_type_fcompile(dtrace_hdl_t *, 524178479Sjb FILE *, dtrace_typeinfo_t *); 525178479Sjb 526178479Sjb/* 527178479Sjb * DTrace Probe Interface 528178479Sjb * 529178479Sjb * Library clients can use these functions to iterate over the set of available 530178479Sjb * probe definitions and inquire as to their attributes. The probe iteration 531178479Sjb * interfaces report probes that are declared as well as those from dtrace(7D). 532178479Sjb */ 533178479Sjbtypedef struct dtrace_probeinfo { 534178479Sjb dtrace_attribute_t dtp_attr; /* name attributes */ 535178479Sjb dtrace_attribute_t dtp_arga; /* arg attributes */ 536178479Sjb const dtrace_typeinfo_t *dtp_argv; /* arg types */ 537178479Sjb int dtp_argc; /* arg count */ 538178479Sjb} dtrace_probeinfo_t; 539178479Sjb 540178479Sjbtypedef int dtrace_probe_f(dtrace_hdl_t *, const dtrace_probedesc_t *, void *); 541178479Sjb 542178479Sjbextern int dtrace_probe_iter(dtrace_hdl_t *, 543178479Sjb const dtrace_probedesc_t *pdp, dtrace_probe_f *, void *); 544178479Sjb 545178479Sjbextern int dtrace_probe_info(dtrace_hdl_t *, 546178479Sjb const dtrace_probedesc_t *, dtrace_probeinfo_t *); 547178479Sjb 548178479Sjb/* 549178479Sjb * DTrace Vector Interface 550178479Sjb * 551178479Sjb * The DTrace library normally speaks directly to dtrace(7D). However, 552178479Sjb * this communication may be vectored elsewhere. Consumers who wish to 553178479Sjb * perform a vectored open must fill in the vector, and use the dtrace_vopen() 554178479Sjb * entry point to obtain a library handle. 555178479Sjb */ 556178479Sjbstruct dtrace_vector { 557297077Smav#ifdef illumos 558178479Sjb int (*dtv_ioctl)(void *, int, void *); 559178550Sjb#else 560178550Sjb int (*dtv_ioctl)(void *, u_long, void *); 561178550Sjb#endif 562178479Sjb int (*dtv_lookup_by_addr)(void *, GElf_Addr, GElf_Sym *, 563178479Sjb dtrace_syminfo_t *); 564178479Sjb int (*dtv_status)(void *, processorid_t); 565178479Sjb long (*dtv_sysconf)(void *, int); 566178479Sjb}; 567178479Sjb 568178479Sjb/* 569178479Sjb * DTrace Utility Functions 570178479Sjb * 571178479Sjb * Library clients can use these functions to convert addresses strings, to 572178479Sjb * convert between string and integer probe descriptions and the 573178479Sjb * dtrace_probedesc_t representation, and to perform similar conversions on 574178479Sjb * stability attributes. 575178479Sjb */ 576178479Sjbextern int dtrace_addr2str(dtrace_hdl_t *, uint64_t, char *, int); 577178479Sjbextern int dtrace_uaddr2str(dtrace_hdl_t *, pid_t, uint64_t, char *, int); 578178479Sjb 579178479Sjbextern int dtrace_xstr2desc(dtrace_hdl_t *, dtrace_probespec_t, 580178479Sjb const char *, int, char *const [], dtrace_probedesc_t *); 581178479Sjb 582178479Sjbextern int dtrace_str2desc(dtrace_hdl_t *, dtrace_probespec_t, 583178479Sjb const char *, dtrace_probedesc_t *); 584178479Sjb 585178479Sjbextern int dtrace_id2desc(dtrace_hdl_t *, dtrace_id_t, dtrace_probedesc_t *); 586178479Sjb 587178479Sjb#define DTRACE_DESC2STR_MAX 1024 /* min buf size for dtrace_desc2str() */ 588178479Sjb 589178479Sjbextern char *dtrace_desc2str(const dtrace_probedesc_t *, char *, size_t); 590178479Sjb 591178479Sjb#define DTRACE_ATTR2STR_MAX 64 /* min buf size for dtrace_attr2str() */ 592178479Sjb 593178479Sjbextern char *dtrace_attr2str(dtrace_attribute_t, char *, size_t); 594178479Sjbextern int dtrace_str2attr(const char *, dtrace_attribute_t *); 595178479Sjb 596178479Sjbextern const char *dtrace_stability_name(dtrace_stability_t); 597178479Sjbextern const char *dtrace_class_name(dtrace_class_t); 598178479Sjb 599178479Sjbextern int dtrace_provider_modules(dtrace_hdl_t *, const char **, int); 600178479Sjb 601178479Sjbextern const char *const _dtrace_version; 602178479Sjbextern int _dtrace_debug; 603178479Sjb 604178479Sjb#ifdef __cplusplus 605178479Sjb} 606178479Sjb#endif 607178479Sjb 608297077Smav#ifndef illumos 609178550Sjb#define _SC_CPUID_MAX _SC_NPROCESSORS_CONF 610178550Sjb#define _SC_NPROCESSORS_MAX _SC_NPROCESSORS_CONF 611178550Sjb#endif 612178550Sjb 613178479Sjb#endif /* _DTRACE_H */ 614