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