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 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, by compiling C strings that specify a D program, or by 91 * manually constructing statements and adding them to an existing program. 92 * The dtrace_program_create() function can be used to create an empty 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_MASK 0x1bff /* mask of all valid flags to dtrace_*compile */ 119 120 extern dtrace_prog_t *dtrace_program_strcompile(dtrace_hdl_t *, 121 const char *, dtrace_probespec_t, uint_t, int, char *const []); 122 123 extern dtrace_prog_t *dtrace_program_fcompile(dtrace_hdl_t *, 124 FILE *, uint_t, int, char *const []); 125 126 extern int dtrace_program_exec(dtrace_hdl_t *, dtrace_prog_t *, 127 dtrace_proginfo_t *); 128 extern void dtrace_program_info(dtrace_hdl_t *, dtrace_prog_t *, 129 dtrace_proginfo_t *); 130 131 #define DTRACE_D_STRIP 0x01 /* strip non-loadable sections from program */ 132 #define DTRACE_D_PROBES 0x02 /* include provider and probe definitions */ 133 #define DTRACE_D_MASK 0x03 /* mask of valid flags to dtrace_dof_create */ 134 135 extern int dtrace_program_link(dtrace_hdl_t *, dtrace_prog_t *, 136 uint_t, const char *, int, char *const []); 137 138 extern void *dtrace_dof_create(dtrace_hdl_t *, dtrace_prog_t *, uint_t); 139 extern void dtrace_dof_destroy(dtrace_hdl_t *, void *); 140 141 extern void *dtrace_getopt_dof(dtrace_hdl_t *); 142 extern void *dtrace_geterr_dof(dtrace_hdl_t *); 143 144 extern dtrace_prog_t *dtrace_program_create(dtrace_hdl_t *); 145 extern void dtrace_program_destroy(dtrace_hdl_t *, dtrace_prog_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_stmtdesc_t *); 171 172 extern dtrace_ecbdesc_t *dtrace_ecbdesc_create(dtrace_hdl_t *, 173 const dtrace_probedesc_t *); 174 extern void dtrace_ecbdesc_hold(dtrace_ecbdesc_t *); 175 extern void dtrace_ecbdesc_release(dtrace_ecbdesc_t *); 176 177 /* 178 * DTrace Data Consumption Interface 179 */ 180 typedef enum { 181 DTRACEFLOW_ENTRY, 182 DTRACEFLOW_RETURN, 183 DTRACEFLOW_NONE 184 } dtrace_flowkind_t; 185 186 #define DTRACE_CONSUME_ERROR -1 /* error while processing */ 187 #define DTRACE_CONSUME_THIS 0 /* consume this probe/record */ 188 #define DTRACE_CONSUME_NEXT 1 /* advance to next probe/rec */ 189 #define DTRACE_CONSUME_ABORT 2 /* abort consumption */ 190 191 typedef struct dtrace_probedata { 192 dtrace_hdl_t *dtpda_handle; /* handle to DTrace library */ 193 dtrace_eprobedesc_t *dtpda_edesc; /* enabled probe description */ 194 dtrace_probedesc_t *dtpda_pdesc; /* probe description */ 195 processorid_t dtpda_cpu; /* CPU for data */ 196 caddr_t dtpda_data; /* pointer to raw data */ 197 dtrace_flowkind_t dtpda_flow; /* flow kind */ 198 const char *dtpda_prefix; /* recommended flow prefix */ 199 int dtpda_indent; /* recommended flow indent */ 200 } dtrace_probedata_t; 201 202 typedef int dtrace_consume_probe_f(const dtrace_probedata_t *, void *); 203 typedef int dtrace_consume_rec_f(const dtrace_probedata_t *, 204 const dtrace_recdesc_t *, void *); 205 206 extern int dtrace_consume(dtrace_hdl_t *, FILE *, 207 dtrace_consume_probe_f *, dtrace_consume_rec_f *, void *); 208 209 #define DTRACE_STATUS_NONE 0 /* no status; not yet time */ 210 #define DTRACE_STATUS_OKAY 1 /* status okay */ 211 #define DTRACE_STATUS_EXITED 2 /* exit() was called; tracing stopped */ 212 #define DTRACE_STATUS_FILLED 3 /* fill buffer filled; tracing stoped */ 213 #define DTRACE_STATUS_STOPPED 4 /* tracing already stopped */ 214 215 extern int dtrace_status(dtrace_hdl_t *); 216 217 /* 218 * DTrace Formatted Output Interfaces 219 * 220 * To format output associated with a given dtrace_stmtdesc, the caller can 221 * invoke one of the following functions, passing the opaque dtsd_fmtdata and a 222 * list of record descriptions. These functions return either -1 to indicate 223 * an error, or a positive integer indicating the number of records consumed. 224 * For anonymous enablings, the consumer can use the dtrd_format member of 225 * the record description to obtain a format description. The dtfd_string 226 * member of the format description may be passed to dtrace_print{fa}_create() 227 * to create the opaque format data. 228 */ 229 extern void *dtrace_printf_create(dtrace_hdl_t *, const char *); 230 extern void *dtrace_printa_create(dtrace_hdl_t *, const char *); 231 extern size_t dtrace_printf_format(dtrace_hdl_t *, void *, char *, size_t); 232 233 extern int dtrace_fprintf(dtrace_hdl_t *, FILE *, void *, 234 const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 235 const void *, size_t); 236 237 extern int dtrace_fprinta(dtrace_hdl_t *, FILE *, void *, 238 const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 239 const void *, size_t); 240 241 extern int dtrace_system(dtrace_hdl_t *, FILE *, void *, 242 const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 243 const void *, size_t); 244 245 extern int dtrace_freopen(dtrace_hdl_t *, FILE *, void *, 246 const dtrace_probedata_t *, const dtrace_recdesc_t *, uint_t, 247 const void *, size_t); 248 249 /* 250 * DTrace Work Interface 251 */ 252 typedef enum { 253 DTRACE_WORKSTATUS_ERROR = -1, 254 DTRACE_WORKSTATUS_OKAY, 255 DTRACE_WORKSTATUS_DONE 256 } dtrace_workstatus_t; 257 258 extern dtrace_workstatus_t dtrace_work(dtrace_hdl_t *, FILE *, 259 dtrace_consume_probe_f *, dtrace_consume_rec_f *, void *); 260 261 /* 262 * DTrace Handler Interface 263 */ 264 #define DTRACE_HANDLE_ABORT -1 /* abort current operation */ 265 #define DTRACE_HANDLE_OK 0 /* handled okay; continue */ 266 267 typedef struct dtrace_errdata { 268 dtrace_hdl_t *dteda_handle; /* handle to DTrace library */ 269 dtrace_eprobedesc_t *dteda_edesc; /* enabled probe inducing err */ 270 dtrace_probedesc_t *dteda_pdesc; /* probe inducing error */ 271 processorid_t dteda_cpu; /* CPU of error */ 272 int dteda_action; /* action inducing error */ 273 int dteda_offset; /* offset in DIFO of error */ 274 int dteda_fault; /* specific fault */ 275 uint64_t dteda_addr; /* address of fault, if any */ 276 const char *dteda_msg; /* preconstructed message */ 277 } dtrace_errdata_t; 278 279 typedef int dtrace_handle_err_f(dtrace_errdata_t *, void *); 280 extern int dtrace_handle_err(dtrace_hdl_t *, dtrace_handle_err_f *, void *); 281 282 typedef enum { 283 DTRACEDROP_PRINCIPAL, /* drop to principal buffer */ 284 DTRACEDROP_AGGREGATION, /* drop to aggregation buffer */ 285 DTRACEDROP_DYNAMIC, /* dynamic drop */ 286 DTRACEDROP_DYNRINSE, /* dyn drop due to rinsing */ 287 DTRACEDROP_DYNDIRTY, /* dyn drop due to dirty */ 288 DTRACEDROP_SPEC, /* speculative drop */ 289 DTRACEDROP_SPECBUSY, /* spec drop due to busy */ 290 DTRACEDROP_SPECUNAVAIL /* spec drop due to unavail */ 291 } dtrace_dropkind_t; 292 293 typedef struct dtrace_dropdata { 294 dtrace_hdl_t *dtdda_handle; /* handle to DTrace library */ 295 processorid_t dtdda_cpu; /* CPU, if any */ 296 dtrace_dropkind_t dtdda_kind; /* kind of drop */ 297 uint64_t dtdda_drops; /* number of drops */ 298 uint64_t dtdda_total; /* total drops */ 299 const char *dtdda_msg; /* preconstructed message */ 300 } dtrace_dropdata_t; 301 302 typedef int dtrace_handle_drop_f(dtrace_dropdata_t *, void *); 303 extern int dtrace_handle_drop(dtrace_hdl_t *, dtrace_handle_drop_f *, void *); 304 305 typedef void dtrace_handle_proc_f(struct ps_prochandle *, void *); 306 extern int dtrace_handle_proc(dtrace_hdl_t *, dtrace_handle_proc_f *, void *); 307 308 typedef struct dtrace_bufdata { 309 dtrace_hdl_t *dtbda_handle; /* handle to DTrace library */ 310 const char *dtbda_buffered; /* buffered output */ 311 dtrace_probedata_t *dtbda_probe; /* probe data */ 312 dtrace_recdesc_t *dtbda_recdesc; /* record description */ 313 dtrace_aggdata_t *dtbda_aggdata; /* aggregation data, if agg. */ 314 } dtrace_bufdata_t; 315 316 typedef int dtrace_handle_buffered_f(dtrace_bufdata_t *, void *); 317 extern int dtrace_handle_buffered(dtrace_hdl_t *, 318 dtrace_handle_buffered_f *, void *); 319 320 /* 321 * DTrace Aggregate Interface 322 */ 323 324 #define DTRACE_A_PERCPU 0x0001 325 #define DTRACE_A_KEEPDELTA 0x0002 326 #define DTRACE_A_ANONYMOUS 0x0004 327 328 #define DTRACE_AGGWALK_ERROR -1 /* error while processing */ 329 #define DTRACE_AGGWALK_NEXT 0 /* proceed to next element */ 330 #define DTRACE_AGGWALK_ABORT 1 /* abort aggregation walk */ 331 #define DTRACE_AGGWALK_CLEAR 2 /* clear this element */ 332 #define DTRACE_AGGWALK_NORMALIZE 3 /* normalize this element */ 333 #define DTRACE_AGGWALK_DENORMALIZE 4 /* denormalize this element */ 334 #define DTRACE_AGGWALK_REMOVE 5 /* remove this element */ 335 336 struct dtrace_aggdata { 337 dtrace_hdl_t *dtada_handle; /* handle to DTrace library */ 338 dtrace_aggdesc_t *dtada_desc; /* aggregation description */ 339 dtrace_eprobedesc_t *dtada_edesc; /* enabled probe description */ 340 dtrace_probedesc_t *dtada_pdesc; /* probe description */ 341 caddr_t dtada_data; /* pointer to raw data */ 342 uint64_t dtada_normal; /* the normal -- 1 for denorm */ 343 size_t dtada_size; /* total size of the data */ 344 caddr_t dtada_delta; /* delta data, if available */ 345 caddr_t *dtada_percpu; /* per CPU data, if avail */ 346 caddr_t *dtada_percpu_delta; /* per CPU delta, if avail */ 347 }; 348 349 typedef int dtrace_aggregate_f(dtrace_aggdata_t *, void *); 350 typedef int dtrace_aggregate_walk_f(dtrace_hdl_t *, 351 dtrace_aggregate_f *, void *); 352 353 extern void dtrace_aggregate_clear(dtrace_hdl_t *); 354 extern int dtrace_aggregate_snap(dtrace_hdl_t *); 355 extern int dtrace_aggregate_print(dtrace_hdl_t *, FILE *, 356 dtrace_aggregate_walk_f *); 357 358 extern int dtrace_aggregate_walk(dtrace_hdl_t *, dtrace_aggregate_f *, void *); 359 360 extern int dtrace_aggregate_walk_keysorted(dtrace_hdl_t *, 361 dtrace_aggregate_f *, void *); 362 363 extern int dtrace_aggregate_walk_valsorted(dtrace_hdl_t *, 364 dtrace_aggregate_f *, void *); 365 366 extern int dtrace_aggregate_walk_keyvarsorted(dtrace_hdl_t *, 367 dtrace_aggregate_f *, void *); 368 369 extern int dtrace_aggregate_walk_valvarsorted(dtrace_hdl_t *, 370 dtrace_aggregate_f *, void *); 371 372 extern int dtrace_aggregate_walk_keyrevsorted(dtrace_hdl_t *, 373 dtrace_aggregate_f *, void *); 374 375 extern int dtrace_aggregate_walk_valrevsorted(dtrace_hdl_t *, 376 dtrace_aggregate_f *, void *); 377 378 extern int dtrace_aggregate_walk_keyvarrevsorted(dtrace_hdl_t *, 379 dtrace_aggregate_f *, void *); 380 381 extern int dtrace_aggregate_walk_valvarrevsorted(dtrace_hdl_t *, 382 dtrace_aggregate_f *, void *); 383 384 #define DTRACE_AGD_PRINTED 0x1 /* aggregation printed in program */ 385 386 /* 387 * DTrace Process Control Interface 388 * 389 * Library clients who wish to have libdtrace create or grab processes for 390 * monitoring of their symbol table changes may use these interfaces to 391 * request that libdtrace obtain control of the process using libproc. 392 */ 393 394 extern struct ps_prochandle *dtrace_proc_create(dtrace_hdl_t *, 395 const char *, char *const *); 396 397 extern struct ps_prochandle *dtrace_proc_grab(dtrace_hdl_t *, pid_t, int); 398 extern void dtrace_proc_release(dtrace_hdl_t *, struct ps_prochandle *); 399 extern void dtrace_proc_continue(dtrace_hdl_t *, struct ps_prochandle *); 400 401 /* 402 * DTrace DIF Object (DIFO) Interface 403 * 404 * Library clients who wish to create their own custom DIF programs can use 405 * the functions below to create a DIFO from a C string containing a D 406 * expression statement. Clients may also create raw DIF on-the-fly without 407 * invoking the D compiler by simply constructing the dtrace_difo_t by hand. 408 */ 409 410 extern dtrace_difo_t *dtrace_difo_create(dtrace_hdl_t *, const char *); 411 extern void dtrace_difo_print(const dtrace_difo_t *, FILE *); 412 extern void dtrace_difo_hold(dtrace_difo_t *); 413 extern void dtrace_difo_release(dtrace_difo_t *); 414 415 /* 416 * DTrace Object, Symbol, and Type Interfaces 417 * 418 * Library clients can use libdtrace to perform symbol and C type information 419 * lookups by symbol name, symbol address, or C type name, or to lookup meta- 420 * information cached for each of the program objects in use by DTrace. The 421 * resulting struct contain pointers to arbitrary-length strings, including 422 * object, symbol, and type names, that are persistent until the next call to 423 * dtrace_update(). Once dtrace_update() is called, any cached values must 424 * be flushed and not used subsequently by the client program. 425 */ 426 427 #define DTRACE_OBJ_EXEC ((const char *)0L) /* primary executable file */ 428 #define DTRACE_OBJ_RTLD ((const char *)1L) /* run-time link-editor */ 429 #define DTRACE_OBJ_CDEFS ((const char *)2L) /* C include definitions */ 430 #define DTRACE_OBJ_DDEFS ((const char *)3L) /* D program definitions */ 431 #define DTRACE_OBJ_EVERY ((const char *)-1L) /* all known objects */ 432 #define DTRACE_OBJ_KMODS ((const char *)-2L) /* all kernel objects */ 433 #define DTRACE_OBJ_UMODS ((const char *)-3L) /* all user objects */ 434 435 typedef struct dtrace_objinfo { 436 const char *dto_name; /* object file scope name */ 437 const char *dto_file; /* object file path (if any) */ 438 int dto_id; /* object file id (if any) */ 439 uint_t dto_flags; /* object flags (see below) */ 440 GElf_Addr dto_text_va; /* address of text section */ 441 GElf_Xword dto_text_size; /* size of text section */ 442 GElf_Addr dto_data_va; /* address of data section */ 443 GElf_Xword dto_data_size; /* size of data section */ 444 GElf_Addr dto_bss_va; /* address of BSS */ 445 GElf_Xword dto_bss_size; /* size of BSS */ 446 } dtrace_objinfo_t; 447 448 #define DTRACE_OBJ_F_KERNEL 0x1 /* object is a kernel module */ 449 #define DTRACE_OBJ_F_PRIMARY 0x2 /* object is a primary module */ 450 451 typedef int dtrace_obj_f(dtrace_hdl_t *, const dtrace_objinfo_t *, void *); 452 453 extern int dtrace_object_iter(dtrace_hdl_t *, dtrace_obj_f *, void *); 454 extern int dtrace_object_info(dtrace_hdl_t *, const char *, dtrace_objinfo_t *); 455 456 typedef struct dtrace_syminfo { 457 const char *dts_object; /* object name */ 458 const char *dts_name; /* symbol name */ 459 ulong_t dts_id; /* symbol id */ 460 } dtrace_syminfo_t; 461 462 extern int dtrace_lookup_by_name(dtrace_hdl_t *, const char *, const char *, 463 GElf_Sym *, dtrace_syminfo_t *); 464 465 extern int dtrace_lookup_by_addr(dtrace_hdl_t *, GElf_Addr addr, 466 GElf_Sym *, dtrace_syminfo_t *); 467 468 typedef struct dtrace_typeinfo { 469 const char *dtt_object; /* object containing type */ 470 ctf_file_t *dtt_ctfp; /* CTF container handle */ 471 ctf_id_t dtt_type; /* CTF type identifier */ 472 } dtrace_typeinfo_t; 473 474 extern int dtrace_lookup_by_type(dtrace_hdl_t *, const char *, const char *, 475 dtrace_typeinfo_t *); 476 477 extern int dtrace_symbol_type(dtrace_hdl_t *, const GElf_Sym *, 478 const dtrace_syminfo_t *, dtrace_typeinfo_t *); 479 480 extern int dtrace_type_strcompile(dtrace_hdl_t *, 481 const char *, dtrace_typeinfo_t *); 482 483 extern int dtrace_type_fcompile(dtrace_hdl_t *, 484 FILE *, dtrace_typeinfo_t *); 485 486 /* 487 * DTrace Probe Interface 488 * 489 * Library clients can use these functions to iterate over the set of available 490 * probe definitions and inquire as to their attributes. The probe iteration 491 * interfaces report probes that are declared as well as those from dtrace(7D). 492 */ 493 typedef struct dtrace_probeinfo { 494 dtrace_attribute_t dtp_attr; /* name attributes */ 495 dtrace_attribute_t dtp_arga; /* arg attributes */ 496 const dtrace_typeinfo_t *dtp_argv; /* arg types */ 497 int dtp_argc; /* arg count */ 498 } dtrace_probeinfo_t; 499 500 typedef int dtrace_probe_f(dtrace_hdl_t *, const dtrace_probedesc_t *, void *); 501 502 extern int dtrace_probe_iter(dtrace_hdl_t *, 503 const dtrace_probedesc_t *pdp, dtrace_probe_f *, void *); 504 505 extern int dtrace_probe_info(dtrace_hdl_t *, 506 const dtrace_probedesc_t *, dtrace_probeinfo_t *); 507 508 /* 509 * DTrace Vector Interface 510 * 511 * The DTrace library normally speaks directly to dtrace(7D). However, 512 * this communication may be vectored elsewhere. Consumers who wish to 513 * perform a vectored open must fill in the vector, and use the dtrace_vopen() 514 * entry point to obtain a library handle. 515 */ 516 struct dtrace_vector { 517 int (*dtv_ioctl)(void *, int, void *); 518 int (*dtv_lookup_by_addr)(void *, GElf_Addr, GElf_Sym *, 519 dtrace_syminfo_t *); 520 int (*dtv_status)(void *, processorid_t); 521 long (*dtv_sysconf)(void *, int); 522 }; 523 524 /* 525 * DTrace Utility Functions 526 * 527 * Library clients can use these functions to convert between string and 528 * integer probe descriptions and the dtrace_probedesc_t representation 529 * and to perform similar conversions on stability attributes. 530 */ 531 extern int dtrace_xstr2desc(dtrace_hdl_t *, dtrace_probespec_t, 532 const char *, int, char *const [], dtrace_probedesc_t *); 533 534 extern int dtrace_str2desc(dtrace_hdl_t *, dtrace_probespec_t, 535 const char *, dtrace_probedesc_t *); 536 537 extern int dtrace_id2desc(dtrace_hdl_t *, dtrace_id_t, dtrace_probedesc_t *); 538 539 #define DTRACE_DESC2STR_MAX 1024 /* min buf size for dtrace_desc2str() */ 540 541 extern char *dtrace_desc2str(const dtrace_probedesc_t *, char *, size_t); 542 543 #define DTRACE_ATTR2STR_MAX 64 /* min buf size for dtrace_attr2str() */ 544 545 extern char *dtrace_attr2str(dtrace_attribute_t, char *, size_t); 546 extern int dtrace_str2attr(const char *, dtrace_attribute_t *); 547 548 extern const char *dtrace_stability_name(dtrace_stability_t); 549 extern const char *dtrace_class_name(dtrace_class_t); 550 551 extern int dtrace_provider_modules(dtrace_hdl_t *, const char **, int); 552 553 extern const char *const _dtrace_version; 554 extern int _dtrace_debug; 555 556 #ifdef __cplusplus 557 } 558 #endif 559 560 #endif /* _DTRACE_H */ 561