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