libctf: creation functions
[deliverable/binutils-gdb.git] / include / ctf-api.h
CommitLineData
2e94b056
NA
1/* Public API to libctf.
2 Copyright (C) 2019 Free Software Foundation, Inc.
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
27#include <sys/param.h>
28#include <sys/types.h>
29#include <ctf.h>
47d546f4 30#include <zlib.h>
2e94b056
NA
31
32#ifdef __cplusplus
33extern "C"
34 {
35#endif
36
37/* Clients can open one or more CTF containers and obtain a pointer to an
38 opaque ctf_file_t. Types are identified by an opaque ctf_id_t token.
39 They can also open or create read-only archives of CTF containers in a
40 ctf_archive_t.
41
42 These opaque definitions allow libctf to evolve without breaking clients. */
43
44typedef struct ctf_file ctf_file_t;
45typedef struct ctf_archive_internal ctf_archive_t;
46typedef long ctf_id_t;
47
47d546f4
NA
48/* If the debugger needs to provide the CTF library with a set of raw buffers
49 for use as the CTF data, symbol table, and string table, it can do so by
50 filling in ctf_sect_t structures and passing them to ctf_bufopen().
51
52 The contents of this structure must always be in native endianness (no
53 byteswapping is performed). */
54
55typedef struct ctf_sect
56{
57 const char *cts_name; /* Section name (if any). */
58 unsigned long cts_type; /* Section type (ELF SHT_... value). */
59 unsigned long cts_flags; /* Section flags (ELF SHF_... value). */
60 const void *cts_data; /* Pointer to section data. */
61 size_t cts_size; /* Size of data in bytes. */
62 size_t cts_entsize; /* Size of each section entry (symtab only). */
63 off64_t cts_offset; /* File offset of this section (if any). */
64} ctf_sect_t;
65
66/* Symbolic names for CTF sections. */
67
68typedef enum ctf_sect_names
69 {
70 CTF_SECT_HEADER,
71 CTF_SECT_LABEL,
72 CTF_SECT_OBJT,
73 CTF_SECT_FUNC,
74 CTF_SECT_VAR,
75 CTF_SECT_TYPE,
76 CTF_SECT_STR
77 } ctf_sect_names_t;
78
79/* Encoding information for integers, floating-point values, and certain other
80 intrinsics can be obtained by calling ctf_type_encoding(), below. The flags
81 field will contain values appropriate for the type defined in <ctf.h>. */
82
83typedef struct ctf_encoding
84{
85 uint32_t cte_format; /* Data format (CTF_INT_* or CTF_FP_* flags). */
86 uint32_t cte_offset; /* Offset of value in bits. */
87 uint32_t cte_bits; /* Size of storage in bits. */
88} ctf_encoding_t;
89
90typedef struct ctf_membinfo
91{
92 ctf_id_t ctm_type; /* Type of struct or union member. */
93 unsigned long ctm_offset; /* Offset of member in bits. */
94} ctf_membinfo_t;
95
96typedef struct ctf_arinfo
97{
98 ctf_id_t ctr_contents; /* Type of array contents. */
99 ctf_id_t ctr_index; /* Type of array index. */
100 uint32_t ctr_nelems; /* Number of elements. */
101} ctf_arinfo_t;
102
103typedef struct ctf_funcinfo
104{
105 ctf_id_t ctc_return; /* Function return type. */
106 uint32_t ctc_argc; /* Number of typed arguments to function. */
107 uint32_t ctc_flags; /* Function attributes (see below). */
108} ctf_funcinfo_t;
109
110typedef struct ctf_lblinfo
111{
112 ctf_id_t ctb_type; /* Last type associated with the label. */
113} ctf_lblinfo_t;
114
115typedef struct ctf_snapshot_id
116{
117 unsigned long dtd_id; /* Highest DTD ID at time of snapshot. */
118 unsigned long snapshot_id; /* Snapshot id at time of snapshot. */
119} ctf_snapshot_id_t;
120
121#define CTF_FUNC_VARARG 0x1 /* Function arguments end with varargs. */
122
2e94b056
NA
123/* Functions that return integer status or a ctf_id_t use the following value
124 to indicate failure. ctf_errno() can be used to obtain an error code. */
125#define CTF_ERR (-1L)
126
127#define ECTF_BASE 1000 /* Base value for libctf errnos. */
128
129
130enum
131 {
132 ECTF_FMT = ECTF_BASE, /* File is not in CTF or ELF format. */
133 ECTF_BFDERR, /* BFD error. */
134 ECTF_CTFVERS, /* CTF version is more recent than libctf. */
135 ECTF_BFD_AMBIGUOUS, /* Ambiguous BFD target. */
136 ECTF_SYMTAB, /* Symbol table uses invalid entry size. */
137 ECTF_SYMBAD, /* Symbol table data buffer invalid. */
138 ECTF_STRBAD, /* String table data buffer invalid. */
139 ECTF_CORRUPT, /* File data corruption detected. */
140 ECTF_NOCTFDATA, /* ELF file does not contain CTF data. */
141 ECTF_NOCTFBUF, /* Buffer does not contain CTF data. */
142 ECTF_NOSYMTAB, /* Symbol table data is not available. */
143 ECTF_NOPARENT, /* Parent CTF container is not available. */
144 ECTF_DMODEL, /* Data model mismatch. */
145 ECTF_UNUSED, /* Unused error. */
146 ECTF_ZALLOC, /* Failed to allocate (de)compression buffer. */
147 ECTF_DECOMPRESS, /* Failed to decompress CTF data. */
148 ECTF_STRTAB, /* String table for this string is missing. */
149 ECTF_BADNAME, /* String offset is corrupt w.r.t. strtab. */
150 ECTF_BADID, /* Invalid type ID number. */
151 ECTF_NOTSOU, /* Type is not a struct or union. */
152 ECTF_NOTENUM, /* Type is not an enum. */
153 ECTF_NOTSUE, /* Type is not a struct, union, or enum. */
154 ECTF_NOTINTFP, /* Type is not an integer, float, or enum. */
155 ECTF_NOTARRAY, /* Type is not an array. */
156 ECTF_NOTREF, /* Type does not reference another type. */
157 ECTF_NAMELEN, /* Buffer is too small to hold type name. */
158 ECTF_NOTYPE, /* No type found corresponding to name. */
159 ECTF_SYNTAX, /* Syntax error in type name. */
160 ECTF_NOTFUNC, /* Symtab entry does not refer to a function. */
161 ECTF_NOFUNCDAT, /* No func info available for function. */
162 ECTF_NOTDATA, /* Symtab entry does not refer to a data obj. */
163 ECTF_NOTYPEDAT, /* No type info available for object. */
164 ECTF_NOLABEL, /* No label found corresponding to name. */
165 ECTF_NOLABELDATA, /* File does not contain any labels. */
166 ECTF_NOTSUP, /* Feature not supported. */
167 ECTF_NOENUMNAM, /* Enum element name not found. */
168 ECTF_NOMEMBNAM, /* Member name not found. */
169 ECTF_RDONLY, /* CTF container is read-only. */
170 ECTF_DTFULL, /* CTF type is full (no more members allowed). */
171 ECTF_FULL, /* CTF container is full. */
172 ECTF_DUPLICATE, /* Duplicate member or variable name. */
173 ECTF_CONFLICT, /* Conflicting type definition present. */
174 ECTF_OVERROLLBACK, /* Attempt to roll back past a ctf_update. */
175 ECTF_COMPRESS, /* Failed to compress CTF data. */
176 ECTF_ARCREATE, /* Error creating CTF archive. */
177 ECTF_ARNNAME, /* Name not found in CTF archive. */
178 ECTF_SLICEOVERFLOW, /* Overflow of type bitness or offset in slice. */
179 ECTF_DUMPSECTUNKNOWN, /* Unknown section number in dump. */
180 ECTF_DUMPSECTCHANGED /* Section changed in middle of dump. */
181 };
182
183/* The CTF data model is inferred to be the caller's data model or the data
184 model of the given object, unless ctf_setmodel() is explicitly called. */
185#define CTF_MODEL_ILP32 1 /* Object data model is ILP32. */
186#define CTF_MODEL_LP64 2 /* Object data model is LP64. */
187#ifdef _LP64
188# define CTF_MODEL_NATIVE CTF_MODEL_LP64
189#else
190# define CTF_MODEL_NATIVE CTF_MODEL_ILP32
191#endif
192
193/* Dynamic CTF containers can be created using ctf_create(). The ctf_add_*
194 routines can be used to add new definitions to the dynamic container.
195 New types are labeled as root or non-root to determine whether they are
196 visible at the top-level program scope when subsequently doing a lookup. */
197
198#define CTF_ADD_NONROOT 0 /* Type only visible in nested scope. */
199#define CTF_ADD_ROOT 1 /* Type visible at top-level scope. */
200
47d546f4
NA
201extern ctf_file_t *ctf_simple_open (const char *, size_t, const char *, size_t,
202 size_t, const char *, size_t, int *);
203extern ctf_file_t *ctf_bufopen (const ctf_sect_t *, const ctf_sect_t *,
204 const ctf_sect_t *, int *);
205
479604f4
NA
206extern int ctf_errno (ctf_file_t *);
207extern const char *ctf_errmsg (int);
47d546f4
NA
208extern ctf_id_t ctf_add_array (ctf_file_t *, uint32_t,
209 const ctf_arinfo_t *);
210extern ctf_id_t ctf_add_const (ctf_file_t *, uint32_t, ctf_id_t);
211extern ctf_id_t ctf_add_enum_encoded (ctf_file_t *, uint32_t, const char *,
212 const ctf_encoding_t *);
213extern ctf_id_t ctf_add_enum (ctf_file_t *, uint32_t, const char *);
214extern ctf_id_t ctf_add_float (ctf_file_t *, uint32_t,
215 const char *, const ctf_encoding_t *);
216extern ctf_id_t ctf_add_forward (ctf_file_t *, uint32_t, const char *,
217 uint32_t);
218extern ctf_id_t ctf_add_function (ctf_file_t *, uint32_t,
219 const ctf_funcinfo_t *, const ctf_id_t *);
220extern ctf_id_t ctf_add_integer (ctf_file_t *, uint32_t, const char *,
221 const ctf_encoding_t *);
222extern ctf_id_t ctf_add_slice (ctf_file_t *, uint32_t, ctf_id_t, const ctf_encoding_t *);
223extern ctf_id_t ctf_add_pointer (ctf_file_t *, uint32_t, ctf_id_t);
224extern ctf_id_t ctf_add_type (ctf_file_t *, ctf_file_t *, ctf_id_t);
225extern ctf_id_t ctf_add_typedef (ctf_file_t *, uint32_t, const char *,
226 ctf_id_t);
227extern ctf_id_t ctf_add_restrict (ctf_file_t *, uint32_t, ctf_id_t);
228extern ctf_id_t ctf_add_struct (ctf_file_t *, uint32_t, const char *);
229extern ctf_id_t ctf_add_union (ctf_file_t *, uint32_t, const char *);
230extern ctf_id_t ctf_add_struct_sized (ctf_file_t *, uint32_t, const char *,
231 size_t);
232extern ctf_id_t ctf_add_union_sized (ctf_file_t *, uint32_t, const char *,
233 size_t);
234extern ctf_id_t ctf_add_volatile (ctf_file_t *, uint32_t, ctf_id_t);
235
236extern int ctf_add_enumerator (ctf_file_t *, ctf_id_t, const char *, int);
237extern int ctf_add_member (ctf_file_t *, ctf_id_t, const char *, ctf_id_t);
238extern int ctf_add_member_offset (ctf_file_t *, ctf_id_t, const char *,
239 ctf_id_t, unsigned long);
240extern int ctf_add_member_encoded (ctf_file_t *, ctf_id_t, const char *,
241 ctf_id_t, unsigned long,
242 const ctf_encoding_t);
243
244extern int ctf_add_variable (ctf_file_t *, const char *, ctf_id_t);
245
246extern int ctf_set_array (ctf_file_t *, ctf_id_t, const ctf_arinfo_t *);
247
248extern ctf_file_t *ctf_create (int *);
249extern int ctf_update (ctf_file_t *);
250extern ctf_snapshot_id_t ctf_snapshot (ctf_file_t *);
251extern int ctf_rollback (ctf_file_t *, ctf_snapshot_id_t);
252extern int ctf_discard (ctf_file_t *);
253extern int ctf_write (ctf_file_t *, int);
254extern int ctf_gzwrite (ctf_file_t * fp, gzFile fd);
255extern int ctf_compress_write (ctf_file_t * fp, int fd);
2e94b056 256
60da9d95
NA
257extern void ctf_setdebug (int debug);
258extern int ctf_getdebug (void);
259
2e94b056
NA
260#ifdef __cplusplus
261}
262#endif
263
264#endif /* _CTF_API_H */
This page took 0.032368 seconds and 4 git commands to generate.