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