xref: /titanic_52/usr/src/lib/libctf/common/libctf.h (revision 7fd791373689a6af05e27efec3b1ab556e02aa23)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2001-2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 /*
27  * Copyright (c) 2015, Joyent, Inc.
28  */
29 
30 /*
31  * This header file defines the interfaces available from the CTF debugger
32  * library, libctf.  This library provides functions that a debugger can
33  * use to operate on data in the Compact ANSI-C Type Format (CTF).  This
34  * is NOT a public interface, although it may eventually become one in
35  * the fullness of time after we gain more experience with the interfaces.
36  *
37  * In the meantime, be aware that any program linked with libctf in this
38  * release of illumos is almost guaranteed to break in the next release.
39  *
40  * In short, do not user this header file or libctf for any purpose.
41  */
42 
43 #ifndef	_LIBCTF_H
44 #define	_LIBCTF_H
45 
46 #include <sys/ctf_api.h>
47 
48 #ifdef	__cplusplus
49 extern "C" {
50 #endif
51 
52 /*
53  * This flag can be used to enable debug messages.
54  */
55 extern int _libctf_debug;
56 
57 typedef enum ctf_diff_flag {
58 	CTF_DIFF_F_IGNORE_INTNAMES = 0x01
59 } ctf_diff_flag_t;
60 
61 typedef struct ctf_diff ctf_diff_t;
62 typedef void (*ctf_diff_type_f)(ctf_file_t *, ctf_id_t, boolean_t, ctf_file_t *,
63     ctf_id_t, void *);
64 typedef void (*ctf_diff_func_f)(ctf_file_t *, ulong_t, boolean_t, ctf_file_t *,
65     ulong_t, void *);
66 typedef void (*ctf_diff_obj_f)(ctf_file_t *, ulong_t, ctf_id_t, boolean_t,
67     ctf_file_t *, ulong_t, ctf_id_t, void *);
68 
69 extern int ctf_diff_init(ctf_file_t *, ctf_file_t *, ctf_diff_t **);
70 extern uint_t ctf_diff_getflags(ctf_diff_t *);
71 extern int ctf_diff_setflags(ctf_diff_t *, uint_t);
72 extern int ctf_diff_types(ctf_diff_t *, ctf_diff_type_f, void *);
73 extern int ctf_diff_functions(ctf_diff_t *, ctf_diff_func_f, void *);
74 extern int ctf_diff_objects(ctf_diff_t *, ctf_diff_obj_f, void *);
75 extern void ctf_diff_fini(ctf_diff_t *);
76 
77 #define	CTF_CONVERT_F_IGNNONC	0x01
78 extern ctf_file_t *ctf_fdconvert(int, const char *, uint_t, uint_t, int *,
79     char *, size_t);
80 
81 typedef struct ctf_merge_handle ctf_merge_t;
82 extern ctf_merge_t *ctf_merge_init(int, int *);
83 extern int ctf_merge_add(ctf_merge_t *, ctf_file_t *);
84 extern int ctf_merge_set_nthreads(ctf_merge_t *, const uint_t);
85 extern int ctf_merge_label(ctf_merge_t *, const char *);
86 extern int ctf_merge_uniquify(ctf_merge_t *, ctf_file_t *, const char *);
87 extern int ctf_merge_merge(ctf_merge_t *, ctf_file_t **);
88 extern int ctf_merge_dedup(ctf_merge_t *, ctf_file_t **);
89 extern void ctf_merge_fini(ctf_merge_t *);
90 
91 #define	CTF_ELFWRITE_F_COMPRESS		0x1
92 extern int ctf_elffdwrite(ctf_file_t *, int, int, int);
93 extern int ctf_elfwrite(ctf_file_t *, const char *, const char *, int);
94 
95 #ifdef	__cplusplus
96 }
97 #endif
98 
99 #endif	/* _LIBCTF_H */
100