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