Commit | Line | Data |
---|---|---|
2e94b056 | 1 | /* Public API to libctf. |
b3adc24a | 2 | Copyright (C) 2019-2020 Free Software Foundation, Inc. |
2e94b056 NA |
3 | |
4 | This file is part of libctf. | |
5 | ||
6 | libctf is free software; you can redistribute it and/or modify it under | |
7 | the terms of the GNU General Public License as published by the Free | |
8 | Software Foundation; either version 3, or (at your option) any later | |
9 | version. | |
10 | ||
11 | This program is distributed in the hope that it will be useful, but | |
12 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
14 | See the GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with this program; see the file COPYING. If not see | |
18 | <http://www.gnu.org/licenses/>. */ | |
19 | ||
20 | /* This header file defines the interfaces available from the CTF debugger | |
21 | library, libctf. This API can be used by a debugger to operate on data in | |
22 | the Compact ANSI-C Type Format (CTF). */ | |
23 | ||
24 | #ifndef _CTF_API_H | |
25 | #define _CTF_API_H | |
26 | ||
2e94b056 NA |
27 | #include <sys/types.h> |
28 | #include <ctf.h> | |
47d546f4 | 29 | #include <zlib.h> |
2e94b056 NA |
30 | |
31 | #ifdef __cplusplus | |
32 | extern "C" | |
b64751cf | 33 | { |
2e94b056 NA |
34 | #endif |
35 | ||
36 | /* Clients can open one or more CTF containers and obtain a pointer to an | |
37 | opaque ctf_file_t. Types are identified by an opaque ctf_id_t token. | |
38 | They can also open or create read-only archives of CTF containers in a | |
39 | ctf_archive_t. | |
40 | ||
41 | These opaque definitions allow libctf to evolve without breaking clients. */ | |
42 | ||
43 | typedef struct ctf_file ctf_file_t; | |
44 | typedef struct ctf_archive_internal ctf_archive_t; | |
a0486bac | 45 | typedef unsigned long ctf_id_t; |
2e94b056 | 46 | |
143dce84 NA |
47 | /* This opaque definition allows libctf to accept BFD data structures without |
48 | importing all the BFD noise into users' namespaces. */ | |
49 | ||
50 | struct bfd; | |
51 | ||
47d546f4 NA |
52 | /* If the debugger needs to provide the CTF library with a set of raw buffers |
53 | for use as the CTF data, symbol table, and string table, it can do so by | |
54 | filling in ctf_sect_t structures and passing them to ctf_bufopen(). | |
55 | ||
56 | The contents of this structure must always be in native endianness (no | |
57 | byteswapping is performed). */ | |
58 | ||
59 | typedef struct ctf_sect | |
60 | { | |
61 | const char *cts_name; /* Section name (if any). */ | |
47d546f4 NA |
62 | const void *cts_data; /* Pointer to section data. */ |
63 | size_t cts_size; /* Size of data in bytes. */ | |
64 | size_t cts_entsize; /* Size of each section entry (symtab only). */ | |
47d546f4 NA |
65 | } ctf_sect_t; |
66 | ||
72c83edd NA |
67 | /* A minimal symbol extracted from a linker's internal symbol table |
68 | representation. */ | |
69 | ||
70 | typedef struct ctf_link_sym | |
71 | { | |
72 | /* The st_name will not be accessed outside the call to | |
73 | ctf_link_shuffle_syms(). */ | |
74 | ||
75 | const char *st_name; | |
76 | uint32_t st_shndx; | |
77 | uint32_t st_type; | |
78 | uint32_t st_value; | |
79 | } ctf_link_sym_t; | |
80 | ||
5f54462c | 81 | /* Flags applying to this specific link. */ |
72c83edd | 82 | |
b64751cf | 83 | /* Share all types that are not in conflict. The default. */ |
72c83edd NA |
84 | #define CTF_LINK_SHARE_UNCONFLICTED 0x0 |
85 | ||
86 | /* Share only types that are used by multiple inputs. Not implemented yet. */ | |
87 | #define CTF_LINK_SHARE_DUPLICATED 0x1 | |
88 | ||
5f54462c NA |
89 | /* Create empty outputs for all registered CU mappings even if no types are |
90 | emitted into them. */ | |
91 | #define CTF_LINK_EMPTY_CU_MAPPINGS 0x4 | |
92 | ||
47d546f4 NA |
93 | /* Symbolic names for CTF sections. */ |
94 | ||
95 | typedef enum ctf_sect_names | |
96 | { | |
97 | CTF_SECT_HEADER, | |
98 | CTF_SECT_LABEL, | |
99 | CTF_SECT_OBJT, | |
100 | CTF_SECT_FUNC, | |
101 | CTF_SECT_VAR, | |
102 | CTF_SECT_TYPE, | |
103 | CTF_SECT_STR | |
104 | } ctf_sect_names_t; | |
105 | ||
106 | /* Encoding information for integers, floating-point values, and certain other | |
107 | intrinsics can be obtained by calling ctf_type_encoding(), below. The flags | |
108 | field will contain values appropriate for the type defined in <ctf.h>. */ | |
109 | ||
110 | typedef struct ctf_encoding | |
111 | { | |
112 | uint32_t cte_format; /* Data format (CTF_INT_* or CTF_FP_* flags). */ | |
113 | uint32_t cte_offset; /* Offset of value in bits. */ | |
114 | uint32_t cte_bits; /* Size of storage in bits. */ | |
115 | } ctf_encoding_t; | |
116 | ||
117 | typedef struct ctf_membinfo | |
118 | { | |
119 | ctf_id_t ctm_type; /* Type of struct or union member. */ | |
120 | unsigned long ctm_offset; /* Offset of member in bits. */ | |
121 | } ctf_membinfo_t; | |
122 | ||
123 | typedef struct ctf_arinfo | |
124 | { | |
125 | ctf_id_t ctr_contents; /* Type of array contents. */ | |
126 | ctf_id_t ctr_index; /* Type of array index. */ | |
127 | uint32_t ctr_nelems; /* Number of elements. */ | |
128 | } ctf_arinfo_t; | |
129 | ||
130 | typedef struct ctf_funcinfo | |
131 | { | |
132 | ctf_id_t ctc_return; /* Function return type. */ | |
133 | uint32_t ctc_argc; /* Number of typed arguments to function. */ | |
134 | uint32_t ctc_flags; /* Function attributes (see below). */ | |
135 | } ctf_funcinfo_t; | |
136 | ||
137 | typedef struct ctf_lblinfo | |
138 | { | |
139 | ctf_id_t ctb_type; /* Last type associated with the label. */ | |
140 | } ctf_lblinfo_t; | |
141 | ||
142 | typedef struct ctf_snapshot_id | |
143 | { | |
144 | unsigned long dtd_id; /* Highest DTD ID at time of snapshot. */ | |
145 | unsigned long snapshot_id; /* Snapshot id at time of snapshot. */ | |
146 | } ctf_snapshot_id_t; | |
147 | ||
148 | #define CTF_FUNC_VARARG 0x1 /* Function arguments end with varargs. */ | |
149 | ||
a0486bac JM |
150 | /* Functions that return a ctf_id_t use the following value to indicate failure. |
151 | ctf_errno() can be used to obtain an error code. Functions that return | |
152 | a straight integral -1 also use ctf_errno(). */ | |
153 | #define CTF_ERR ((ctf_id_t) -1L) | |
2e94b056 NA |
154 | |
155 | #define ECTF_BASE 1000 /* Base value for libctf errnos. */ | |
156 | ||
157 | ||
158 | enum | |
159 | { | |
7eea9d3b NA |
160 | ECTF_FMT = ECTF_BASE, /* File is not in CTF or ELF format. */ |
161 | ECTF_BFDERR, /* BFD error. */ | |
162 | ECTF_CTFVERS, /* CTF dict version is too new for libctf. */ | |
163 | ECTF_BFD_AMBIGUOUS, /* Ambiguous BFD target. */ | |
164 | ECTF_SYMTAB, /* Symbol table uses invalid entry size. */ | |
165 | ECTF_SYMBAD, /* Symbol table data buffer is not valid. */ | |
166 | ECTF_STRBAD, /* String table data buffer is not valid. */ | |
167 | ECTF_CORRUPT, /* File data structure corruption detected. */ | |
168 | ECTF_NOCTFDATA, /* File does not contain CTF data. */ | |
169 | ECTF_NOCTFBUF, /* Buffer does not contain CTF data. */ | |
170 | ECTF_NOSYMTAB, /* Symbol table information is not available. */ | |
171 | ECTF_NOPARENT, /* The parent CTF dictionary is unavailable. */ | |
172 | ECTF_DMODEL, /* Data model mismatch. */ | |
173 | ECTF_LINKADDEDLATE, /* File added to link too late. */ | |
174 | ECTF_ZALLOC, /* Failed to allocate (de)compression buffer. */ | |
175 | ECTF_DECOMPRESS, /* Failed to decompress CTF data. */ | |
176 | ECTF_STRTAB, /* External string table is not available. */ | |
177 | ECTF_BADNAME, /* String name offset is corrupt. */ | |
178 | ECTF_BADID, /* Invalid type identifier. */ | |
179 | ECTF_NOTSOU, /* Type is not a struct or union. */ | |
180 | ECTF_NOTENUM, /* Type is not an enum. */ | |
181 | ECTF_NOTSUE, /* Type is not a struct, union, or enum. */ | |
182 | ECTF_NOTINTFP, /* Type is not an integer, float, or enum. */ | |
183 | ECTF_NOTARRAY, /* Type is not an array. */ | |
184 | ECTF_NOTREF, /* Type does not reference another type. */ | |
185 | ECTF_NAMELEN, /* Buffer is too small to hold type name. */ | |
186 | ECTF_NOTYPE, /* No type found corresponding to name. */ | |
187 | ECTF_SYNTAX, /* Syntax error in type name. */ | |
188 | ECTF_NOTFUNC, /* Symbol table entry or type is not a function. */ | |
189 | ECTF_NOFUNCDAT, /* No function information available for function. */ | |
190 | ECTF_NOTDATA, /* Symbol table entry does not refer to a data object. */ | |
191 | ECTF_NOTYPEDAT, /* No type information available for symbol. */ | |
192 | ECTF_NOLABEL, /* No label found corresponding to name. */ | |
193 | ECTF_NOLABELDATA, /* File does not contain any labels. */ | |
194 | ECTF_NOTSUP, /* Feature not supported. */ | |
195 | ECTF_NOENUMNAM, /* Enum element name not found. */ | |
196 | ECTF_NOMEMBNAM, /* Member name not found. */ | |
197 | ECTF_RDONLY, /* CTF container is read-only. */ | |
198 | ECTF_DTFULL, /* CTF type is full (no more members allowed). */ | |
199 | ECTF_FULL, /* CTF container is full. */ | |
200 | ECTF_DUPLICATE, /* Duplicate member or variable name. */ | |
201 | ECTF_CONFLICT, /* Conflicting type is already defined. */ | |
202 | ECTF_OVERROLLBACK, /* Attempt to roll back past a ctf_update. */ | |
203 | ECTF_COMPRESS, /* Failed to compress CTF data. */ | |
204 | ECTF_ARCREATE, /* Error creating CTF archive. */ | |
205 | ECTF_ARNNAME, /* Name not found in CTF archive. */ | |
206 | ECTF_SLICEOVERFLOW, /* Overflow of type bitness or offset in slice. */ | |
207 | ECTF_DUMPSECTUNKNOWN, /* Unknown section number in dump. */ | |
208 | ECTF_DUMPSECTCHANGED, /* Section changed in middle of dump. */ | |
209 | ECTF_NOTYET, /* Feature not yet implemented. */ | |
8b37e7b6 | 210 | ECTF_INTERNAL, /* Internal error: assertion failure. */ |
688d28f6 NA |
211 | ECTF_NONREPRESENTABLE, /* Type not representable in CTF. */ |
212 | ECTF_NEXT_END, /* End of iteration. */ | |
213 | ECTF_NEXT_WRONGFUN, /* Wrong iteration function called. */ | |
ec388c16 | 214 | ECTF_NEXT_WRONGFP, /* Iteration entity changed in mid-iterate. */ |
8d2229ad NA |
215 | ECTF_FLAGS, /* CTF header contains flags unknown to libctf. */ |
216 | ECTF_NEEDSBFD /* This feature needs a libctf with BFD support. */ | |
2e94b056 NA |
217 | }; |
218 | ||
8d2229ad | 219 | #define ECTF_NERR (ECTF_NEEDSBFD - ECTF_BASE + 1) /* Count of CTF errors. */ |
7eea9d3b | 220 | |
2e94b056 NA |
221 | /* The CTF data model is inferred to be the caller's data model or the data |
222 | model of the given object, unless ctf_setmodel() is explicitly called. */ | |
223 | #define CTF_MODEL_ILP32 1 /* Object data model is ILP32. */ | |
224 | #define CTF_MODEL_LP64 2 /* Object data model is LP64. */ | |
225 | #ifdef _LP64 | |
226 | # define CTF_MODEL_NATIVE CTF_MODEL_LP64 | |
227 | #else | |
228 | # define CTF_MODEL_NATIVE CTF_MODEL_ILP32 | |
229 | #endif | |
230 | ||
231 | /* Dynamic CTF containers can be created using ctf_create(). The ctf_add_* | |
232 | routines can be used to add new definitions to the dynamic container. | |
233 | New types are labeled as root or non-root to determine whether they are | |
234 | visible at the top-level program scope when subsequently doing a lookup. */ | |
235 | ||
236 | #define CTF_ADD_NONROOT 0 /* Type only visible in nested scope. */ | |
237 | #define CTF_ADD_ROOT 1 /* Type visible at top-level scope. */ | |
238 | ||
688d28f6 NA |
239 | /* These typedefs are used to define the signature for callback functions that |
240 | can be used with the iteration and visit functions below. There is also a | |
241 | family of iteration functions that do not require callbacks. */ | |
9402cc59 | 242 | |
316afdb1 NA |
243 | typedef int ctf_visit_f (const char *name, ctf_id_t type, unsigned long offset, |
244 | int depth, void *arg); | |
245 | typedef int ctf_member_f (const char *name, ctf_id_t membtype, | |
246 | unsigned long offset, void *arg); | |
247 | typedef int ctf_enum_f (const char *name, int val, void *arg); | |
248 | typedef int ctf_variable_f (const char *name, ctf_id_t type, void *arg); | |
249 | typedef int ctf_type_f (ctf_id_t type, void *arg); | |
0ac62312 | 250 | typedef int ctf_type_all_f (ctf_id_t type, int flag, void *arg); |
6dbf2b73 NA |
251 | typedef int ctf_label_f (const char *name, const ctf_lblinfo_t *info, |
252 | void *arg); | |
9402cc59 NA |
253 | typedef int ctf_archive_member_f (ctf_file_t *fp, const char *name, void *arg); |
254 | typedef int ctf_archive_raw_member_f (const char *name, const void *content, | |
255 | size_t len, void *arg); | |
a30b3e18 NA |
256 | typedef char *ctf_dump_decorate_f (ctf_sect_names_t sect, |
257 | char *line, void *arg); | |
258 | ||
259 | typedef struct ctf_dump_state ctf_dump_state_t; | |
9402cc59 | 260 | |
688d28f6 NA |
261 | /* Iteration state for the _next() functions, and allocators/copiers/freers for |
262 | it. (None of these are needed for the simple case of iterating to the end: | |
263 | the _next() function allocate and free the iterators for you.) */ | |
264 | ||
265 | typedef struct ctf_next ctf_next_t; | |
266 | extern ctf_next_t *ctf_next_create (void); | |
267 | extern void ctf_next_destroy (ctf_next_t *); | |
268 | extern ctf_next_t *ctf_next_copy (ctf_next_t *); | |
269 | ||
143dce84 NA |
270 | /* Opening. These mostly return an abstraction over both CTF files and CTF |
271 | archives: so they can be used to open both. CTF files will appear to be an | |
272 | archive with one member named '.ctf'. The low-level functions | |
273 | ctf_simple_open() and ctf_bufopen() return ctf_file_t's directly, and cannot | |
274 | be used on CTF archives. */ | |
275 | ||
276 | extern ctf_archive_t *ctf_bfdopen (struct bfd *, int *); | |
277 | extern ctf_archive_t *ctf_bfdopen_ctfsect (struct bfd *, const ctf_sect_t *, | |
278 | int *); | |
279 | extern ctf_archive_t *ctf_fdopen (int fd, const char *filename, | |
280 | const char *target, int *errp); | |
281 | extern ctf_archive_t *ctf_open (const char *filename, | |
282 | const char *target, int *errp); | |
283 | extern void ctf_close (ctf_archive_t *); | |
72f33921 | 284 | extern ctf_sect_t ctf_getdatasect (const ctf_file_t *); |
9402cc59 | 285 | extern ctf_archive_t *ctf_get_arc (const ctf_file_t *); |
143dce84 | 286 | extern ctf_archive_t *ctf_arc_open (const char *, int *); |
2f6ecaed NA |
287 | extern ctf_archive_t *ctf_arc_bufopen (const ctf_sect_t *, |
288 | const ctf_sect_t *, | |
289 | const ctf_sect_t *, | |
290 | int *); | |
9402cc59 NA |
291 | extern void ctf_arc_close (ctf_archive_t *); |
292 | extern ctf_file_t *ctf_arc_open_by_name (const ctf_archive_t *, | |
293 | const char *, int *); | |
294 | extern ctf_file_t *ctf_arc_open_by_name_sections (const ctf_archive_t *, | |
295 | const ctf_sect_t *, | |
296 | const ctf_sect_t *, | |
297 | const char *, int *); | |
9c23dfa5 | 298 | extern size_t ctf_archive_count (const ctf_archive_t *); |
9402cc59 NA |
299 | |
300 | /* The next functions return or close real CTF files, or write out CTF archives, | |
301 | not opaque containers around either. */ | |
302 | ||
47d546f4 NA |
303 | extern ctf_file_t *ctf_simple_open (const char *, size_t, const char *, size_t, |
304 | size_t, const char *, size_t, int *); | |
305 | extern ctf_file_t *ctf_bufopen (const ctf_sect_t *, const ctf_sect_t *, | |
306 | const ctf_sect_t *, int *); | |
2399827b | 307 | extern void ctf_ref (ctf_file_t *); |
72f33921 NA |
308 | extern void ctf_file_close (ctf_file_t *); |
309 | ||
9402cc59 NA |
310 | extern int ctf_arc_write (const char *, ctf_file_t **, size_t, |
311 | const char **, size_t); | |
5537f9b9 NA |
312 | extern int ctf_arc_write_fd (int, ctf_file_t **, size_t, const char **, |
313 | size_t); | |
9402cc59 | 314 | |
fd55eae8 | 315 | extern const char *ctf_cuname (ctf_file_t *); |
de07e349 | 316 | extern int ctf_cuname_set (ctf_file_t *, const char *); |
72f33921 NA |
317 | extern ctf_file_t *ctf_parent_file (ctf_file_t *); |
318 | extern const char *ctf_parent_name (ctf_file_t *); | |
de07e349 | 319 | extern int ctf_parent_name_set (ctf_file_t *, const char *); |
316afdb1 NA |
320 | extern int ctf_type_isparent (ctf_file_t *, ctf_id_t); |
321 | extern int ctf_type_ischild (ctf_file_t *, ctf_id_t); | |
72f33921 NA |
322 | |
323 | extern int ctf_import (ctf_file_t *, ctf_file_t *); | |
324 | extern int ctf_setmodel (ctf_file_t *, int); | |
325 | extern int ctf_getmodel (ctf_file_t *); | |
326 | ||
327 | extern void ctf_setspecific (ctf_file_t *, void *); | |
328 | extern void *ctf_getspecific (ctf_file_t *); | |
47d546f4 | 329 | |
479604f4 NA |
330 | extern int ctf_errno (ctf_file_t *); |
331 | extern const char *ctf_errmsg (int); | |
6c33b742 | 332 | extern int ctf_version (int); |
316afdb1 | 333 | |
b437bfe0 NA |
334 | extern int ctf_func_info (ctf_file_t *, unsigned long, ctf_funcinfo_t *); |
335 | extern int ctf_func_args (ctf_file_t *, unsigned long, uint32_t, ctf_id_t *); | |
12a0b67d NA |
336 | extern int ctf_func_type_info (ctf_file_t *, ctf_id_t, ctf_funcinfo_t *); |
337 | extern int ctf_func_type_args (ctf_file_t *, ctf_id_t, uint32_t, ctf_id_t *); | |
b437bfe0 NA |
338 | |
339 | extern ctf_id_t ctf_lookup_by_name (ctf_file_t *, const char *); | |
340 | extern ctf_id_t ctf_lookup_by_symbol (ctf_file_t *, unsigned long); | |
341 | extern ctf_id_t ctf_lookup_variable (ctf_file_t *, const char *); | |
342 | ||
316afdb1 NA |
343 | extern ctf_id_t ctf_type_resolve (ctf_file_t *, ctf_id_t); |
344 | extern char *ctf_type_aname (ctf_file_t *, ctf_id_t); | |
12a0b67d | 345 | extern char *ctf_type_aname_raw (ctf_file_t *, ctf_id_t); |
316afdb1 NA |
346 | extern ssize_t ctf_type_lname (ctf_file_t *, ctf_id_t, char *, size_t); |
347 | extern char *ctf_type_name (ctf_file_t *, ctf_id_t, char *, size_t); | |
01d93174 | 348 | extern const char *ctf_type_name_raw (ctf_file_t *, ctf_id_t); |
316afdb1 NA |
349 | extern ssize_t ctf_type_size (ctf_file_t *, ctf_id_t); |
350 | extern ssize_t ctf_type_align (ctf_file_t *, ctf_id_t); | |
351 | extern int ctf_type_kind (ctf_file_t *, ctf_id_t); | |
9b15cbb7 | 352 | extern int ctf_type_kind_forwarded (ctf_file_t *, ctf_id_t); |
316afdb1 NA |
353 | extern ctf_id_t ctf_type_reference (ctf_file_t *, ctf_id_t); |
354 | extern ctf_id_t ctf_type_pointer (ctf_file_t *, ctf_id_t); | |
355 | extern int ctf_type_encoding (ctf_file_t *, ctf_id_t, ctf_encoding_t *); | |
356 | extern int ctf_type_visit (ctf_file_t *, ctf_id_t, ctf_visit_f *, void *); | |
357 | extern int ctf_type_cmp (ctf_file_t *, ctf_id_t, ctf_file_t *, ctf_id_t); | |
358 | extern int ctf_type_compat (ctf_file_t *, ctf_id_t, ctf_file_t *, ctf_id_t); | |
359 | ||
360 | extern int ctf_member_info (ctf_file_t *, ctf_id_t, const char *, | |
361 | ctf_membinfo_t *); | |
362 | extern int ctf_array_info (ctf_file_t *, ctf_id_t, ctf_arinfo_t *); | |
363 | ||
364 | extern const char *ctf_enum_name (ctf_file_t *, ctf_id_t, int); | |
365 | extern int ctf_enum_value (ctf_file_t *, ctf_id_t, const char *, int *); | |
366 | ||
6dbf2b73 NA |
367 | extern void ctf_label_set (ctf_file_t *, const char *); |
368 | extern const char *ctf_label_get (ctf_file_t *); | |
369 | ||
370 | extern const char *ctf_label_topmost (ctf_file_t *); | |
371 | extern int ctf_label_info (ctf_file_t *, const char *, ctf_lblinfo_t *); | |
372 | ||
e0325e2c | 373 | extern int ctf_member_count (ctf_file_t *, ctf_id_t); |
316afdb1 | 374 | extern int ctf_member_iter (ctf_file_t *, ctf_id_t, ctf_member_f *, void *); |
688d28f6 NA |
375 | extern ssize_t ctf_member_next (ctf_file_t *, ctf_id_t, ctf_next_t **, |
376 | const char **name, ctf_id_t *membtype); | |
316afdb1 | 377 | extern int ctf_enum_iter (ctf_file_t *, ctf_id_t, ctf_enum_f *, void *); |
688d28f6 NA |
378 | extern const char *ctf_enum_next (ctf_file_t *, ctf_id_t, ctf_next_t **, |
379 | int *); | |
316afdb1 | 380 | extern int ctf_type_iter (ctf_file_t *, ctf_type_f *, void *); |
0ac62312 | 381 | extern int ctf_type_iter_all (ctf_file_t *, ctf_type_all_f *, void *); |
688d28f6 NA |
382 | extern ctf_id_t ctf_type_next (ctf_file_t *, ctf_next_t **, |
383 | int *flag, int want_hidden); | |
6dbf2b73 | 384 | extern int ctf_label_iter (ctf_file_t *, ctf_label_f *, void *); |
688d28f6 | 385 | extern int ctf_label_next (ctf_file_t *, ctf_next_t **, const char **); /* TBD */ |
316afdb1 | 386 | extern int ctf_variable_iter (ctf_file_t *, ctf_variable_f *, void *); |
688d28f6 NA |
387 | extern ctf_id_t ctf_variable_next (ctf_file_t *, ctf_next_t **, |
388 | const char **); | |
9402cc59 NA |
389 | extern int ctf_archive_iter (const ctf_archive_t *, ctf_archive_member_f *, |
390 | void *); | |
688d28f6 NA |
391 | extern ctf_file_t *ctf_archive_next (const ctf_archive_t *, ctf_next_t **, |
392 | const char **, int skip_parent, int *errp); | |
393 | ||
9402cc59 NA |
394 | /* This function alone does not currently operate on CTF files masquerading |
395 | as archives, and returns -EINVAL: the raw data is no longer available. It is | |
396 | expected to be used only by archiving tools, in any case, which have no need | |
397 | to deal with non-archives at all. */ | |
398 | extern int ctf_archive_raw_iter (const ctf_archive_t *, | |
399 | ctf_archive_raw_member_f *, void *); | |
a30b3e18 NA |
400 | extern char *ctf_dump (ctf_file_t *, ctf_dump_state_t **state, |
401 | ctf_sect_names_t sect, ctf_dump_decorate_f *, | |
402 | void *arg); | |
316afdb1 | 403 | |
8b37e7b6 NA |
404 | /* Error-warning reporting: an 'iterator' that returns errors and warnings from |
405 | the error/warning list, in order of emission. Errors and warnings are popped | |
406 | after return: the caller must free the returned error-text pointer. */ | |
407 | extern char *ctf_errwarning_next (ctf_file_t *, ctf_next_t **, | |
408 | int *is_warning); | |
409 | ||
47d546f4 NA |
410 | extern ctf_id_t ctf_add_array (ctf_file_t *, uint32_t, |
411 | const ctf_arinfo_t *); | |
412 | extern ctf_id_t ctf_add_const (ctf_file_t *, uint32_t, ctf_id_t); | |
413 | extern ctf_id_t ctf_add_enum_encoded (ctf_file_t *, uint32_t, const char *, | |
414 | const ctf_encoding_t *); | |
415 | extern ctf_id_t ctf_add_enum (ctf_file_t *, uint32_t, const char *); | |
416 | extern ctf_id_t ctf_add_float (ctf_file_t *, uint32_t, | |
417 | const char *, const ctf_encoding_t *); | |
418 | extern ctf_id_t ctf_add_forward (ctf_file_t *, uint32_t, const char *, | |
419 | uint32_t); | |
420 | extern ctf_id_t ctf_add_function (ctf_file_t *, uint32_t, | |
421 | const ctf_funcinfo_t *, const ctf_id_t *); | |
422 | extern ctf_id_t ctf_add_integer (ctf_file_t *, uint32_t, const char *, | |
423 | const ctf_encoding_t *); | |
424 | extern ctf_id_t ctf_add_slice (ctf_file_t *, uint32_t, ctf_id_t, const ctf_encoding_t *); | |
425 | extern ctf_id_t ctf_add_pointer (ctf_file_t *, uint32_t, ctf_id_t); | |
426 | extern ctf_id_t ctf_add_type (ctf_file_t *, ctf_file_t *, ctf_id_t); | |
427 | extern ctf_id_t ctf_add_typedef (ctf_file_t *, uint32_t, const char *, | |
428 | ctf_id_t); | |
429 | extern ctf_id_t ctf_add_restrict (ctf_file_t *, uint32_t, ctf_id_t); | |
430 | extern ctf_id_t ctf_add_struct (ctf_file_t *, uint32_t, const char *); | |
431 | extern ctf_id_t ctf_add_union (ctf_file_t *, uint32_t, const char *); | |
432 | extern ctf_id_t ctf_add_struct_sized (ctf_file_t *, uint32_t, const char *, | |
433 | size_t); | |
434 | extern ctf_id_t ctf_add_union_sized (ctf_file_t *, uint32_t, const char *, | |
435 | size_t); | |
436 | extern ctf_id_t ctf_add_volatile (ctf_file_t *, uint32_t, ctf_id_t); | |
437 | ||
438 | extern int ctf_add_enumerator (ctf_file_t *, ctf_id_t, const char *, int); | |
439 | extern int ctf_add_member (ctf_file_t *, ctf_id_t, const char *, ctf_id_t); | |
440 | extern int ctf_add_member_offset (ctf_file_t *, ctf_id_t, const char *, | |
441 | ctf_id_t, unsigned long); | |
442 | extern int ctf_add_member_encoded (ctf_file_t *, ctf_id_t, const char *, | |
443 | ctf_id_t, unsigned long, | |
444 | const ctf_encoding_t); | |
445 | ||
446 | extern int ctf_add_variable (ctf_file_t *, const char *, ctf_id_t); | |
447 | ||
448 | extern int ctf_set_array (ctf_file_t *, ctf_id_t, const ctf_arinfo_t *); | |
449 | ||
450 | extern ctf_file_t *ctf_create (int *); | |
451 | extern int ctf_update (ctf_file_t *); | |
452 | extern ctf_snapshot_id_t ctf_snapshot (ctf_file_t *); | |
453 | extern int ctf_rollback (ctf_file_t *, ctf_snapshot_id_t); | |
454 | extern int ctf_discard (ctf_file_t *); | |
455 | extern int ctf_write (ctf_file_t *, int); | |
5537f9b9 | 456 | extern int ctf_gzwrite (ctf_file_t *fp, gzFile fd); |
47d546f4 | 457 | extern int ctf_compress_write (ctf_file_t * fp, int fd); |
5537f9b9 | 458 | extern unsigned char *ctf_write_mem (ctf_file_t *, size_t *, size_t threshold); |
2e94b056 | 459 | |
72c83edd | 460 | extern int ctf_link_add_ctf (ctf_file_t *, ctf_archive_t *, const char *); |
6dd2819f NA |
461 | /* The variable filter should return nonzero if a variable should not |
462 | appear in the output. */ | |
463 | typedef int ctf_link_variable_filter_f (ctf_file_t *, const char *, ctf_id_t, | |
464 | void *); | |
465 | extern int ctf_link_set_variable_filter (ctf_file_t *, | |
466 | ctf_link_variable_filter_f *, void *); | |
8d2229ad | 467 | extern int ctf_link (ctf_file_t *, int flags); |
72c83edd NA |
468 | typedef const char *ctf_link_strtab_string_f (uint32_t *offset, void *arg); |
469 | extern int ctf_link_add_strtab (ctf_file_t *, ctf_link_strtab_string_f *, | |
470 | void *); | |
471 | typedef ctf_link_sym_t *ctf_link_iter_symbol_f (ctf_link_sym_t *dest, | |
472 | void *arg); | |
473 | extern int ctf_link_shuffle_syms (ctf_file_t *, ctf_link_iter_symbol_f *, | |
474 | void *); | |
475 | extern unsigned char *ctf_link_write (ctf_file_t *, size_t *size, | |
476 | size_t threshold); | |
477 | ||
49ea9b45 | 478 | /* Specialist linker functions. These functions are not used by ld, but can be |
b64751cf | 479 | used by other programs making use of the linker machinery for other purposes |
49ea9b45 NA |
480 | to customize its output. */ |
481 | extern int ctf_link_add_cu_mapping (ctf_file_t *, const char *from, | |
482 | const char *to); | |
483 | typedef char *ctf_link_memb_name_changer_f (ctf_file_t *, | |
484 | const char *, void *); | |
485 | extern void ctf_link_set_memb_name_changer | |
486 | (ctf_file_t *, ctf_link_memb_name_changer_f *, void *); | |
487 | ||
60da9d95 NA |
488 | extern void ctf_setdebug (int debug); |
489 | extern int ctf_getdebug (void); | |
490 | ||
2e94b056 NA |
491 | #ifdef __cplusplus |
492 | } | |
493 | #endif | |
494 | ||
495 | #endif /* _CTF_API_H */ |