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