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