include/ctf-api.h

   1 /* Public API to libctf.
   2    Copyright (C) 2019-2020 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/types.h>
  28 #include <ctf.h>
  29 #include <zlib.h>
  30
  31 #ifdef  __cplusplus
  32 extern "C"
  33 {
  34 #endif
  35
  36 /* Clients can open one or more CTF containers and obtain a pointer to an
  37    opaque ctf_dict_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_dict ctf_dict_t;
  44 typedef struct ctf_archive_internal ctf_archive_t;
  45 typedef unsigned long ctf_id_t;
  46
  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
  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).  */
  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).  */
  65 } ctf_sect_t;
  66
  67 /* A minimal symbol extracted from a linker's internal symbol table
  68    representation.  The symbol name can be given either via st_name or via a
  69    strtab offset in st_nameidx, which corresponds to one of the string offsets
  70    communicated via the ctf_link_add_strtab callback.  */
  71
  72 typedef struct ctf_link_sym
  73 {
  74   /* The st_name and st_nameidx will not be accessed outside the call to
  75      ctf_link_shuffle_syms().  If you set st_nameidx to offset zero, make sure
  76      to set st_nameidx_set as well.  */
  77
  78   const char *st_name;
  79   size_t st_nameidx;
  80   int st_nameidx_set;
  81   uint32_t st_symidx;
  82   uint32_t st_shndx;
  83   uint32_t st_type;
  84   uint32_t st_value;
  85 } ctf_link_sym_t;
  86
  87 /* Flags applying to this specific link.  */
  88
  89 /* Share all types that are not in conflict.  The default.  */
  90 #define CTF_LINK_SHARE_UNCONFLICTED 0x0
  91
  92 /* Share only types that are used by multiple inputs.  */
  93 #define CTF_LINK_SHARE_DUPLICATED 0x1
  94
  95 /* Do a nondeduplicating link.  */
  96 #define CTF_LINK_NONDEDUP 0x2
  97
  98 /* Create empty outputs for all registered CU mappings even if no types are
  99    emitted into them.  */
 100 #define CTF_LINK_EMPTY_CU_MAPPINGS 0x4
 101
 102 /* Omit the content of the variables section.  */
 103 #define CTF_LINK_OMIT_VARIABLES_SECTION 0x8
 104
 105 /* Symbolic names for CTF sections.  */
 106
 107 typedef enum ctf_sect_names
 108   {
 109    CTF_SECT_HEADER,
 110    CTF_SECT_LABEL,
 111    CTF_SECT_OBJT,
 112    CTF_SECT_OBJTIDX = CTF_SECT_OBJT,
 113    CTF_SECT_FUNC,
 114    CTF_SECT_FUNCIDX = CTF_SECT_FUNC,
 115    CTF_SECT_VAR,
 116    CTF_SECT_TYPE,
 117    CTF_SECT_STR
 118   } ctf_sect_names_t;
 119
 120 /* Encoding information for integers, floating-point values, and certain other
 121    intrinsics can be obtained by calling ctf_type_encoding(), below.  The flags
 122    field will contain values appropriate for the type defined in <ctf.h>.  */
 123
 124 typedef struct ctf_encoding
 125 {
 126   uint32_t cte_format;           /* Data format (CTF_INT_* or CTF_FP_* flags).  */
 127   uint32_t cte_offset;           /* Offset of value in bits.  */
 128   uint32_t cte_bits;             /* Size of storage in bits.  */
 129 } ctf_encoding_t;
 130
 131 typedef struct ctf_membinfo
 132 {
 133   ctf_id_t ctm_type;            /* Type of struct or union member.  */
 134   unsigned long ctm_offset;     /* Offset of member in bits.  */
 135 } ctf_membinfo_t;
 136
 137 typedef struct ctf_arinfo
 138 {
 139   ctf_id_t ctr_contents;        /* Type of array contents.  */
 140   ctf_id_t ctr_index;           /* Type of array index.  */
 141   uint32_t ctr_nelems;          /* Number of elements.  */
 142 } ctf_arinfo_t;
 143
 144 typedef struct ctf_funcinfo
 145 {
 146   ctf_id_t ctc_return;          /* Function return type.  */
 147   uint32_t ctc_argc;            /* Number of typed arguments to function.  */
 148   uint32_t ctc_flags;           /* Function attributes (see below).  */
 149 } ctf_funcinfo_t;
 150
 151 typedef struct ctf_lblinfo
 152 {
 153   ctf_id_t ctb_type;            /* Last type associated with the label.  */
 154 } ctf_lblinfo_t;
 155
 156 typedef struct ctf_snapshot_id
 157 {
 158   unsigned long dtd_id;         /* Highest DTD ID at time of snapshot.  */
 159   unsigned long snapshot_id;    /* Snapshot id at time of snapshot.  */
 160 } ctf_snapshot_id_t;
 161
 162 #define CTF_FUNC_VARARG 0x1     /* Function arguments end with varargs.  */
 163
 164 /* Functions that return a ctf_id_t use the following value to indicate failure.
 165    ctf_errno() can be used to obtain an error code.  Functions that return
 166    a straight integral -1 also use ctf_errno().  */
 167 #define CTF_ERR ((ctf_id_t) -1L)
 168
 169 /* This macro holds information about all the available ctf errors.
 170    It is used to form both an enum holding all the error constants,
 171    and also the error strings themselves.  To use, define _CTF_FIRST
 172    and _CTF_ITEM to expand as you like, then mention the macro name.
 173    See the enum after this for an example.  */
 174 #define _CTF_ERRORS \
 175   _CTF_FIRST (ECTF_FMT, "File is not in CTF or ELF format.")    \
 176   _CTF_ITEM (ECTF_BFDERR, "BFD error.")                         \
 177   _CTF_ITEM (ECTF_CTFVERS, "CTF dict version is too new for libctf.") \
 178   _CTF_ITEM (ECTF_BFD_AMBIGUOUS, "Ambiguous BFD target.")       \
 179   _CTF_ITEM (ECTF_SYMTAB, "Symbol table uses invalid entry size.") \
 180   _CTF_ITEM (ECTF_SYMBAD, "Symbol table data buffer is not valid.") \
 181   _CTF_ITEM (ECTF_STRBAD, "String table data buffer is not valid.") \
 182   _CTF_ITEM (ECTF_CORRUPT, "File data structure corruption detected.") \
 183   _CTF_ITEM (ECTF_NOCTFDATA, "File does not contain CTF data.") \
 184   _CTF_ITEM (ECTF_NOCTFBUF, "Buffer does not contain CTF data.") \
 185   _CTF_ITEM (ECTF_NOSYMTAB, "Symbol table information is not available.") \
 186   _CTF_ITEM (ECTF_NOPARENT, "The parent CTF dictionary is unavailable.") \
 187   _CTF_ITEM (ECTF_DMODEL, "Data model mismatch.") \
 188   _CTF_ITEM (ECTF_LINKADDEDLATE, "File added to link too late.") \
 189   _CTF_ITEM (ECTF_ZALLOC, "Failed to allocate (de)compression buffer.") \
 190   _CTF_ITEM (ECTF_DECOMPRESS, "Failed to decompress CTF data.") \
 191   _CTF_ITEM (ECTF_STRTAB, "External string table is not available.") \
 192   _CTF_ITEM (ECTF_BADNAME, "String name offset is corrupt.") \
 193   _CTF_ITEM (ECTF_BADID, "Invalid type identifier.") \
 194   _CTF_ITEM (ECTF_NOTSOU, "Type is not a struct or union.") \
 195   _CTF_ITEM (ECTF_NOTENUM, "Type is not an enum.") \
 196   _CTF_ITEM (ECTF_NOTSUE, "Type is not a struct, union, or enum.") \
 197   _CTF_ITEM (ECTF_NOTINTFP, "Type is not an integer, float, or enum.") \
 198   _CTF_ITEM (ECTF_NOTARRAY, "Type is not an array.") \
 199   _CTF_ITEM (ECTF_NOTREF, "Type does not reference another type.") \
 200   _CTF_ITEM (ECTF_NAMELEN, "Buffer is too small to hold type name.") \
 201   _CTF_ITEM (ECTF_NOTYPE, "No type found corresponding to name.") \
 202   _CTF_ITEM (ECTF_SYNTAX, "Syntax error in type name.") \
 203   _CTF_ITEM (ECTF_NOTFUNC, "Symbol table entry or type is not a function.") \
 204   _CTF_ITEM (ECTF_NOFUNCDAT, "No function information available for function.") \
 205   _CTF_ITEM (ECTF_NOTDATA, "Symbol table entry does not refer to a data object.") \
 206   _CTF_ITEM (ECTF_NOTYPEDAT, "No type information available for symbol.") \
 207   _CTF_ITEM (ECTF_NOLABEL, "No label found corresponding to name.") \
 208   _CTF_ITEM (ECTF_NOLABELDATA, "File does not contain any labels.") \
 209   _CTF_ITEM (ECTF_NOTSUP, "Feature not supported.") \
 210   _CTF_ITEM (ECTF_NOENUMNAM, "Enum element name not found.") \
 211   _CTF_ITEM (ECTF_NOMEMBNAM, "Member name not found.") \
 212   _CTF_ITEM (ECTF_RDONLY, "CTF container is read-only.") \
 213   _CTF_ITEM (ECTF_DTFULL, "CTF type is full (no more members allowed).") \
 214   _CTF_ITEM (ECTF_FULL, "CTF container is full.") \
 215   _CTF_ITEM (ECTF_DUPLICATE, "Duplicate member or variable name.") \
 216   _CTF_ITEM (ECTF_CONFLICT, "Conflicting type is already defined.") \
 217   _CTF_ITEM (ECTF_OVERROLLBACK, "Attempt to roll back past a ctf_update.") \
 218   _CTF_ITEM (ECTF_COMPRESS, "Failed to compress CTF data.") \
 219   _CTF_ITEM (ECTF_ARCREATE, "Error creating CTF archive.") \
 220   _CTF_ITEM (ECTF_ARNNAME, "Name not found in CTF archive.") \
 221   _CTF_ITEM (ECTF_SLICEOVERFLOW, "Overflow of type bitness or offset in slice.") \
 222   _CTF_ITEM (ECTF_DUMPSECTUNKNOWN, "Unknown section number in dump.") \
 223   _CTF_ITEM (ECTF_DUMPSECTCHANGED, "Section changed in middle of dump.") \
 224   _CTF_ITEM (ECTF_NOTYET, "Feature not yet implemented.") \
 225   _CTF_ITEM (ECTF_INTERNAL, "Internal error: assertion failure.") \
 226   _CTF_ITEM (ECTF_NONREPRESENTABLE, "Type not representable in CTF.") \
 227   _CTF_ITEM (ECTF_NEXT_END, "End of iteration.") \
 228   _CTF_ITEM (ECTF_NEXT_WRONGFUN, "Wrong iteration function called.") \
 229   _CTF_ITEM (ECTF_NEXT_WRONGFP, "Iteration entity changed in mid-iterate.") \
 230   _CTF_ITEM (ECTF_FLAGS, "CTF header contains flags unknown to libctf.") \
 231   _CTF_ITEM (ECTF_NEEDSBFD, "This feature needs a libctf with BFD support.")
 232
 233 #define ECTF_BASE       1000    /* Base value for libctf errnos.  */
 234
 235 enum
 236   {
 237 #define _CTF_FIRST(NAME, STR) NAME = ECTF_BASE
 238 #define _CTF_ITEM(NAME, STR) , NAME
 239 _CTF_ERRORS
 240 #undef _CTF_ITEM
 241 #undef _CTF_FIRST
 242   };
 243
 244 #define ECTF_NERR (ECTF_NEEDSBFD - ECTF_BASE + 1) /* Count of CTF errors.  */
 245
 246 /* The CTF data model is inferred to be the caller's data model or the data
 247    model of the given object, unless ctf_setmodel() is explicitly called.  */
 248 #define CTF_MODEL_ILP32 1       /* Object data model is ILP32.  */
 249 #define CTF_MODEL_LP64  2       /* Object data model is LP64.  */
 250 #ifdef _LP64
 251 # define CTF_MODEL_NATIVE CTF_MODEL_LP64
 252 #else
 253 # define CTF_MODEL_NATIVE CTF_MODEL_ILP32
 254 #endif
 255
 256 /* Dynamic CTF containers can be created using ctf_create().  The ctf_add_*
 257    routines can be used to add new definitions to the dynamic container.
 258    New types are labeled as root or non-root to determine whether they are
 259    visible at the top-level program scope when subsequently doing a lookup.  */
 260
 261 #define CTF_ADD_NONROOT 0       /* Type only visible in nested scope.  */
 262 #define CTF_ADD_ROOT    1       /* Type visible at top-level scope.  */
 263
 264 /* These typedefs are used to define the signature for callback functions that
 265    can be used with the iteration and visit functions below.  There is also a
 266    family of iteration functions that do not require callbacks.  */
 267
 268 typedef int ctf_visit_f (const char *name, ctf_id_t type, unsigned long offset,
 269                          int depth, void *arg);
 270 typedef int ctf_member_f (const char *name, ctf_id_t membtype,
 271                           unsigned long offset, void *arg);
 272 typedef int ctf_enum_f (const char *name, int val, void *arg);
 273 typedef int ctf_variable_f (const char *name, ctf_id_t type, void *arg);
 274 typedef int ctf_type_f (ctf_id_t type, void *arg);
 275 typedef int ctf_type_all_f (ctf_id_t type, int flag, void *arg);
 276 typedef int ctf_label_f (const char *name, const ctf_lblinfo_t *info,
 277                          void *arg);
 278 typedef int ctf_archive_member_f (ctf_dict_t *fp, const char *name, void *arg);
 279 typedef int ctf_archive_raw_member_f (const char *name, const void *content,
 280                                       size_t len, void *arg);
 281 typedef char *ctf_dump_decorate_f (ctf_sect_names_t sect,
 282                                    char *line, void *arg);
 283
 284 typedef struct ctf_dump_state ctf_dump_state_t;
 285
 286 /* Iteration state for the _next() functions, and allocators/copiers/freers for
 287    it.  (None of these are needed for the simple case of iterating to the end:
 288    the _next() function allocate and free the iterators for you.)  */
 289
 290 typedef struct ctf_next ctf_next_t;
 291 extern ctf_next_t *ctf_next_create (void);
 292 extern void ctf_next_destroy (ctf_next_t *);
 293 extern ctf_next_t *ctf_next_copy (ctf_next_t *);
 294
 295 /* Opening.  These mostly return an abstraction over both CTF files and CTF
 296    archives: so they can be used to open both.  CTF files will appear to be an
 297    archive with one member named '.ctf'.  The low-level functions
 298    ctf_simple_open() and ctf_bufopen() return ctf_dict_t's directly, and cannot
 299    be used on CTF archives.  */
 300
 301 extern ctf_archive_t *ctf_bfdopen (struct bfd *, int *);
 302 extern ctf_archive_t *ctf_bfdopen_ctfsect (struct bfd *, const ctf_sect_t *,
 303                                            int *);
 304 extern ctf_archive_t *ctf_fdopen (int fd, const char *filename,
 305                                   const char *target, int *errp);
 306 extern ctf_archive_t *ctf_open (const char *filename,
 307                                 const char *target, int *errp);
 308 extern void ctf_close (ctf_archive_t *);
 309 extern ctf_sect_t ctf_getdatasect (const ctf_dict_t *);
 310 extern ctf_sect_t ctf_getsymsect (const ctf_dict_t *);
 311 extern ctf_sect_t ctf_getstrsect (const ctf_dict_t *);
 312 extern ctf_archive_t *ctf_get_arc (const ctf_dict_t *);
 313 extern ctf_archive_t *ctf_arc_open (const char *, int *);
 314 extern ctf_archive_t *ctf_arc_bufopen (const ctf_sect_t *,
 315                                        const ctf_sect_t *,
 316                                        const ctf_sect_t *,
 317                                        int *);
 318 extern void ctf_arc_close (ctf_archive_t *);
 319 extern ctf_dict_t *ctf_arc_lookup_symbol (ctf_archive_t *,
 320                                           unsigned long symidx,
 321                                           ctf_id_t *, int *errp);
 322 extern void ctf_arc_flush_caches (ctf_archive_t *);
 323 extern ctf_dict_t *ctf_dict_open (const ctf_archive_t *,
 324                                   const char *, int *);
 325 extern ctf_dict_t *ctf_dict_open_sections (const ctf_archive_t *,
 326                                            const ctf_sect_t *,
 327                                            const ctf_sect_t *,
 328                                            const char *, int *);
 329 extern size_t ctf_archive_count (const ctf_archive_t *);
 330
 331 /* The next functions return or close real CTF files, or write out CTF archives,
 332    not opaque containers around either.  */
 333
 334 extern ctf_dict_t *ctf_simple_open (const char *, size_t, const char *, size_t,
 335                                    size_t, const char *, size_t, int *);
 336 extern ctf_dict_t *ctf_bufopen (const ctf_sect_t *, const ctf_sect_t *,
 337                                 const ctf_sect_t *, int *);
 338 extern void ctf_ref (ctf_dict_t *);
 339 extern void ctf_dict_close (ctf_dict_t *);
 340
 341 extern int ctf_arc_write (const char *, ctf_dict_t **, size_t,
 342                           const char **, size_t);
 343 extern int ctf_arc_write_fd (int, ctf_dict_t **, size_t, const char **,
 344                              size_t);
 345
 346 extern const char *ctf_cuname (ctf_dict_t *);
 347 extern int ctf_cuname_set (ctf_dict_t *, const char *);
 348 extern ctf_dict_t *ctf_parent_dict (ctf_dict_t *);
 349 extern const char *ctf_parent_name (ctf_dict_t *);
 350 extern int ctf_parent_name_set (ctf_dict_t *, const char *);
 351 extern int ctf_type_isparent (ctf_dict_t *, ctf_id_t);
 352 extern int ctf_type_ischild (ctf_dict_t *, ctf_id_t);
 353
 354 extern int ctf_import (ctf_dict_t *, ctf_dict_t *);
 355 extern int ctf_setmodel (ctf_dict_t *, int);
 356 extern int ctf_getmodel (ctf_dict_t *);
 357
 358 extern void ctf_setspecific (ctf_dict_t *, void *);
 359 extern void *ctf_getspecific (ctf_dict_t *);
 360
 361 extern int ctf_errno (ctf_dict_t *);
 362 extern const char *ctf_errmsg (int);
 363 extern int ctf_version (int);
 364
 365 extern int ctf_func_info (ctf_dict_t *, unsigned long, ctf_funcinfo_t *);
 366 extern int ctf_func_args (ctf_dict_t *, unsigned long, uint32_t, ctf_id_t *);
 367 extern int ctf_func_type_info (ctf_dict_t *, ctf_id_t, ctf_funcinfo_t *);
 368 extern int ctf_func_type_args (ctf_dict_t *, ctf_id_t, uint32_t, ctf_id_t *);
 369
 370 extern ctf_id_t ctf_lookup_by_name (ctf_dict_t *, const char *);
 371 extern ctf_id_t ctf_lookup_by_symbol (ctf_dict_t *, unsigned long);
 372 extern ctf_id_t ctf_symbol_next (ctf_dict_t *, ctf_next_t **,
 373                                  const char **name, int functions);
 374 extern ctf_id_t ctf_lookup_variable (ctf_dict_t *, const char *);
 375
 376 extern ctf_id_t ctf_type_resolve (ctf_dict_t *, ctf_id_t);
 377 extern char *ctf_type_aname (ctf_dict_t *, ctf_id_t);
 378 extern char *ctf_type_aname_raw (ctf_dict_t *, ctf_id_t);
 379 extern ssize_t ctf_type_lname (ctf_dict_t *, ctf_id_t, char *, size_t);
 380 extern char *ctf_type_name (ctf_dict_t *, ctf_id_t, char *, size_t);
 381 extern const char *ctf_type_name_raw (ctf_dict_t *, ctf_id_t);
 382 extern ssize_t ctf_type_size (ctf_dict_t *, ctf_id_t);
 383 extern ssize_t ctf_type_align (ctf_dict_t *, ctf_id_t);
 384 extern int ctf_type_kind (ctf_dict_t *, ctf_id_t);
 385 extern int ctf_type_kind_forwarded (ctf_dict_t *, ctf_id_t);
 386 extern ctf_id_t ctf_type_reference (ctf_dict_t *, ctf_id_t);
 387 extern ctf_id_t ctf_type_pointer (ctf_dict_t *, ctf_id_t);
 388 extern int ctf_type_encoding (ctf_dict_t *, ctf_id_t, ctf_encoding_t *);
 389 extern int ctf_type_visit (ctf_dict_t *, ctf_id_t, ctf_visit_f *, void *);
 390 extern int ctf_type_cmp (ctf_dict_t *, ctf_id_t, ctf_dict_t *, ctf_id_t);
 391 extern int ctf_type_compat (ctf_dict_t *, ctf_id_t, ctf_dict_t *, ctf_id_t);
 392
 393 extern int ctf_member_info (ctf_dict_t *, ctf_id_t, const char *,
 394                             ctf_membinfo_t *);
 395 extern int ctf_array_info (ctf_dict_t *, ctf_id_t, ctf_arinfo_t *);
 396
 397 extern const char *ctf_enum_name (ctf_dict_t *, ctf_id_t, int);
 398 extern int ctf_enum_value (ctf_dict_t *, ctf_id_t, const char *, int *);
 399
 400 extern void ctf_label_set (ctf_dict_t *, const char *);
 401 extern const char *ctf_label_get (ctf_dict_t *);
 402
 403 extern const char *ctf_label_topmost (ctf_dict_t *);
 404 extern int ctf_label_info (ctf_dict_t *, const char *, ctf_lblinfo_t *);
 405
 406 extern int ctf_member_count (ctf_dict_t *, ctf_id_t);
 407 extern int ctf_member_iter (ctf_dict_t *, ctf_id_t, ctf_member_f *, void *);
 408 extern ssize_t ctf_member_next (ctf_dict_t *, ctf_id_t, ctf_next_t **,
 409                                 const char **name, ctf_id_t *membtype);
 410 extern int ctf_enum_iter (ctf_dict_t *, ctf_id_t, ctf_enum_f *, void *);
 411 extern const char *ctf_enum_next (ctf_dict_t *, ctf_id_t, ctf_next_t **,
 412                                   int *);
 413 extern int ctf_type_iter (ctf_dict_t *, ctf_type_f *, void *);
 414 extern int ctf_type_iter_all (ctf_dict_t *, ctf_type_all_f *, void *);
 415 extern ctf_id_t ctf_type_next (ctf_dict_t *, ctf_next_t **,
 416                                int *flag, int want_hidden);
 417 extern int ctf_label_iter (ctf_dict_t *, ctf_label_f *, void *);
 418 extern int ctf_label_next (ctf_dict_t *, ctf_next_t **, const char **); /* TBD */
 419 extern int ctf_variable_iter (ctf_dict_t *, ctf_variable_f *, void *);
 420 extern ctf_id_t ctf_variable_next (ctf_dict_t *, ctf_next_t **,
 421                                    const char **);
 422 extern int ctf_archive_iter (const ctf_archive_t *, ctf_archive_member_f *,
 423                              void *);
 424 extern ctf_dict_t *ctf_archive_next (const ctf_archive_t *, ctf_next_t **,
 425                                      const char **, int skip_parent, int *errp);
 426
 427 /* This function alone does not currently operate on CTF files masquerading
 428    as archives, and returns -EINVAL: the raw data is no longer available.  It is
 429    expected to be used only by archiving tools, in any case, which have no need
 430    to deal with non-archives at all.  */
 431 extern int ctf_archive_raw_iter (const ctf_archive_t *,
 432                                  ctf_archive_raw_member_f *, void *);
 433 extern char *ctf_dump (ctf_dict_t *, ctf_dump_state_t **state,
 434                        ctf_sect_names_t sect, ctf_dump_decorate_f *,
 435                        void *arg);
 436
 437 /* Error-warning reporting: an 'iterator' that returns errors and warnings from
 438    the error/warning list, in order of emission.  Errors and warnings are popped
 439    after return: the caller must free the returned error-text pointer.  */
 440 extern char *ctf_errwarning_next (ctf_dict_t *, ctf_next_t **,
 441                                   int *is_warning, int *errp);
 442
 443 extern ctf_id_t ctf_add_array (ctf_dict_t *, uint32_t,
 444                                const ctf_arinfo_t *);
 445 extern ctf_id_t ctf_add_const (ctf_dict_t *, uint32_t, ctf_id_t);
 446 extern ctf_id_t ctf_add_enum_encoded (ctf_dict_t *, uint32_t, const char *,
 447                                       const ctf_encoding_t *);
 448 extern ctf_id_t ctf_add_enum (ctf_dict_t *, uint32_t, const char *);
 449 extern ctf_id_t ctf_add_float (ctf_dict_t *, uint32_t,
 450                                const char *, const ctf_encoding_t *);
 451 extern ctf_id_t ctf_add_forward (ctf_dict_t *, uint32_t, const char *,
 452                                  uint32_t);
 453 extern ctf_id_t ctf_add_function (ctf_dict_t *, uint32_t,
 454                                   const ctf_funcinfo_t *, const ctf_id_t *);
 455 extern ctf_id_t ctf_add_integer (ctf_dict_t *, uint32_t, const char *,
 456                                  const ctf_encoding_t *);
 457 extern ctf_id_t ctf_add_slice (ctf_dict_t *, uint32_t, ctf_id_t, const ctf_encoding_t *);
 458 extern ctf_id_t ctf_add_pointer (ctf_dict_t *, uint32_t, ctf_id_t);
 459 extern ctf_id_t ctf_add_type (ctf_dict_t *, ctf_dict_t *, ctf_id_t);
 460 extern ctf_id_t ctf_add_typedef (ctf_dict_t *, uint32_t, const char *,
 461                                  ctf_id_t);
 462 extern ctf_id_t ctf_add_restrict (ctf_dict_t *, uint32_t, ctf_id_t);
 463 extern ctf_id_t ctf_add_struct (ctf_dict_t *, uint32_t, const char *);
 464 extern ctf_id_t ctf_add_union (ctf_dict_t *, uint32_t, const char *);
 465 extern ctf_id_t ctf_add_struct_sized (ctf_dict_t *, uint32_t, const char *,
 466                                       size_t);
 467 extern ctf_id_t ctf_add_union_sized (ctf_dict_t *, uint32_t, const char *,
 468                                      size_t);
 469 extern ctf_id_t ctf_add_volatile (ctf_dict_t *, uint32_t, ctf_id_t);
 470
 471 extern int ctf_add_enumerator (ctf_dict_t *, ctf_id_t, const char *, int);
 472 extern int ctf_add_member (ctf_dict_t *, ctf_id_t, const char *, ctf_id_t);
 473 extern int ctf_add_member_offset (ctf_dict_t *, ctf_id_t, const char *,
 474                                   ctf_id_t, unsigned long);
 475 extern int ctf_add_member_encoded (ctf_dict_t *, ctf_id_t, const char *,
 476                                    ctf_id_t, unsigned long,
 477                                    const ctf_encoding_t);
 478
 479 extern int ctf_add_variable (ctf_dict_t *, const char *, ctf_id_t);
 480
 481 extern int ctf_add_objt_sym (ctf_dict_t *, const char *, ctf_id_t);
 482 extern int ctf_add_func_sym (ctf_dict_t *, const char *, ctf_id_t);
 483
 484 extern int ctf_set_array (ctf_dict_t *, ctf_id_t, const ctf_arinfo_t *);
 485
 486 extern ctf_dict_t *ctf_create (int *);
 487 extern int ctf_update (ctf_dict_t *);
 488 extern ctf_snapshot_id_t ctf_snapshot (ctf_dict_t *);
 489 extern int ctf_rollback (ctf_dict_t *, ctf_snapshot_id_t);
 490 extern int ctf_discard (ctf_dict_t *);
 491 extern int ctf_write (ctf_dict_t *, int);
 492 extern int ctf_gzwrite (ctf_dict_t *fp, gzFile fd);
 493 extern int ctf_compress_write (ctf_dict_t * fp, int fd);
 494 extern unsigned char *ctf_write_mem (ctf_dict_t *, size_t *, size_t threshold);
 495
 496 extern int ctf_link_add_ctf (ctf_dict_t *, ctf_archive_t *, const char *);
 497 /* The variable filter should return nonzero if a variable should not
 498    appear in the output.  */
 499 typedef int ctf_link_variable_filter_f (ctf_dict_t *, const char *, ctf_id_t,
 500                                         void *);
 501 extern int ctf_link_set_variable_filter (ctf_dict_t *,
 502                                          ctf_link_variable_filter_f *, void *);
 503 extern int ctf_link (ctf_dict_t *, int flags);
 504 typedef const char *ctf_link_strtab_string_f (uint32_t *offset, void *arg);
 505 extern int ctf_link_add_strtab (ctf_dict_t *, ctf_link_strtab_string_f *,
 506                                 void *);
 507 extern int ctf_link_add_linker_symbol (ctf_dict_t *, ctf_link_sym_t *);
 508 extern int ctf_link_shuffle_syms (ctf_dict_t *);
 509 extern unsigned char *ctf_link_write (ctf_dict_t *, size_t *size,
 510                                       size_t threshold);
 511
 512 /* Specialist linker functions.  These functions are not used by ld, but can be
 513    used by other programs making use of the linker machinery for other purposes
 514    to customize its output.  */
 515 extern int ctf_link_add_cu_mapping (ctf_dict_t *, const char *from,
 516                                     const char *to);
 517 typedef char *ctf_link_memb_name_changer_f (ctf_dict_t *,
 518                                             const char *, void *);
 519 extern void ctf_link_set_memb_name_changer
 520   (ctf_dict_t *, ctf_link_memb_name_changer_f *, void *);
 521
 522 extern void ctf_setdebug (int debug);
 523 extern int ctf_getdebug (void);
 524
 525 /* Deprecated aliases for existing functions and types.  */
 526
 527 struct ctf_file;
 528 typedef struct ctf_dict ctf_file_t;
 529 extern void ctf_file_close (ctf_file_t *);
 530 extern ctf_dict_t *ctf_parent_file (ctf_dict_t *);
 531 extern ctf_dict_t *ctf_arc_open_by_name (const ctf_archive_t *,
 532                                          const char *, int *);
 533 extern ctf_dict_t *ctf_arc_open_by_name_sections (const ctf_archive_t *,
 534                                                   const ctf_sect_t *,
 535                                                   const ctf_sect_t *,
 536                                                   const char *, int *);
 537
 538 #ifdef  __cplusplus
 539 }
 540 #endif
 541
 542 #endif                          /* _CTF_API_H */