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