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