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