Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-09-16 09:13:13

0001 /* Public API to libctf.
0002    Copyright (C) 2019-2024 Free Software Foundation, Inc.
0003 
0004    This file is part of libctf.
0005 
0006    libctf is free software; you can redistribute it and/or modify it under
0007    the terms of the GNU General Public License as published by the Free
0008    Software Foundation; either version 3, or (at your option) any later
0009    version.
0010 
0011    This program is distributed in the hope that it will be useful, but
0012    WITHOUT ANY WARRANTY; without even the implied warranty of
0013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
0014    See the GNU General Public License for more details.
0015 
0016    You should have received a copy of the GNU General Public License
0017    along with this program; see the file COPYING.  If not see
0018    <http://www.gnu.org/licenses/>.  */
0019 
0020 /* This header file defines the interfaces available from the CTF debugger
0021    library, libctf.  This API can be used by a debugger to operate on data in
0022    the Compact ANSI-C Type Format (CTF).  */
0023 
0024 #ifndef _CTF_API_H
0025 #define _CTF_API_H
0026 
0027 #include <sys/types.h>
0028 #include <inttypes.h>
0029 #include <ctf.h>
0030 #include <zlib.h>
0031 
0032 #ifdef  __cplusplus
0033 extern "C"
0034 {
0035 #endif
0036 
0037 /* Clients can open one or more CTF containers and obtain a pointer to an
0038    opaque ctf_dict_t.  Types are identified by an opaque ctf_id_t token.
0039    They can also open or create read-only archives of CTF containers in a
0040    ctf_archive_t.
0041 
0042    These opaque definitions allow libctf to evolve without breaking clients.  */
0043 
0044 typedef struct ctf_dict ctf_dict_t;
0045 typedef struct ctf_archive_internal ctf_archive_t;
0046 typedef unsigned long ctf_id_t;
0047 
0048 /* This opaque definition allows libctf to accept BFD data structures without
0049    importing all the BFD noise into users' namespaces.  */
0050 
0051 struct bfd;
0052 
0053 /* If the debugger needs to provide the CTF library with a set of raw buffers
0054    for use as the CTF data, symbol table, and string table, it can do so by
0055    filling in ctf_sect_t structures and passing them to ctf_bufopen.
0056 
0057    The contents of this structure must always be in native endianness.  At read
0058    time, the symbol table endianness is derived from the BFD target (if BFD is
0059    in use): if a BFD target is not in use, please call ctf_symsect_endianness or
0060    ctf_arc_symsect_endianness.  */
0061 
0062 typedef struct ctf_sect
0063 {
0064   const char *cts_name;       /* Section name (if any).  */
0065   const void *cts_data;       /* Pointer to section data.  */
0066   size_t cts_size;        /* Size of data in bytes.  */
0067   size_t cts_entsize;         /* Size of each section entry (symtab only).  */
0068 } ctf_sect_t;
0069 
0070 /* A minimal symbol extracted from a linker's internal symbol table
0071    representation.  The symbol name can be given either via st_name or via a
0072    strtab offset in st_nameidx, which corresponds to one of the string offsets
0073    communicated via the ctf_link_add_strtab callback.   */
0074 
0075 typedef struct ctf_link_sym
0076 {
0077   /* The st_name and st_nameidx will not be accessed outside the call to
0078      ctf_link_shuffle_syms.  If you set st_nameidx to offset zero, make sure
0079      to set st_nameidx_set as well.  */
0080 
0081   const char *st_name;
0082   size_t st_nameidx;
0083   int st_nameidx_set;
0084   uint32_t st_symidx;
0085   uint32_t st_shndx;
0086   uint32_t st_type;
0087   uint32_t st_value;
0088 } ctf_link_sym_t;
0089 
0090 /* Flags applying to this specific link.  */
0091 
0092 /* Share all types that are not in conflict.  The default.  */
0093 #define CTF_LINK_SHARE_UNCONFLICTED 0x0
0094 
0095 /* Share only types that are used by multiple inputs.  */
0096 #define CTF_LINK_SHARE_DUPLICATED 0x1
0097 
0098 /* Do a nondeduplicating link, or otherwise deduplicate "less hard", trading off
0099    CTF output size for link time.  */
0100 #define CTF_LINK_NONDEDUP 0x2
0101 
0102 /* Create empty outputs for all registered CU mappings even if no types are
0103    emitted into them.  */
0104 #define CTF_LINK_EMPTY_CU_MAPPINGS 0x4
0105 
0106 /* Omit the content of the variables section.  */
0107 #define CTF_LINK_OMIT_VARIABLES_SECTION 0x8
0108 
0109 /* If *unset*, filter out entries corresponding to linker-reported symbols
0110    from the variable section, and filter out all entries with no linker-reported
0111    symbols from the data object and function info sections: if set, do no
0112    filtering and leave all entries in place.  (This is a negative-sense flag
0113    because it is rare to want symbols the linker has not reported as present to
0114    stick around in the symtypetab sections nonetheless: relocatable links are
0115    the only likely case.)  */
0116 #define CTF_LINK_NO_FILTER_REPORTED_SYMS 0x10
0117 
0118 /* Symbolic names for CTF sections.  */
0119 
0120 typedef enum ctf_sect_names
0121   {
0122    CTF_SECT_HEADER,
0123    CTF_SECT_LABEL,
0124    CTF_SECT_OBJT,
0125    CTF_SECT_OBJTIDX = CTF_SECT_OBJT,
0126    CTF_SECT_FUNC,
0127    CTF_SECT_FUNCIDX = CTF_SECT_FUNC,
0128    CTF_SECT_VAR,
0129    CTF_SECT_TYPE,
0130    CTF_SECT_STR
0131   } ctf_sect_names_t;
0132 
0133 /* Encoding information for integers, floating-point values, and certain other
0134    intrinsics can be obtained by calling ctf_type_encoding, below.  The flags
0135    field will contain values appropriate for the type defined in <ctf.h>.  */
0136 
0137 typedef struct ctf_encoding
0138 {
0139   uint32_t cte_format;       /* Data format (CTF_INT_* or CTF_FP_* flags).  */
0140   uint32_t cte_offset;       /* Offset of value in bits.  */
0141   uint32_t cte_bits;         /* Size of storage in bits.  */
0142 } ctf_encoding_t;
0143 
0144 typedef struct ctf_membinfo
0145 {
0146   ctf_id_t ctm_type;        /* Type of struct or union member.  */
0147   unsigned long ctm_offset; /* Offset of member in bits.  */
0148 } ctf_membinfo_t;
0149 
0150 typedef struct ctf_arinfo
0151 {
0152   ctf_id_t ctr_contents;    /* Type of array contents.  */
0153   ctf_id_t ctr_index;       /* Type of array index.  */
0154   uint32_t ctr_nelems;      /* Number of elements.  */
0155 } ctf_arinfo_t;
0156 
0157 typedef struct ctf_funcinfo
0158 {
0159   ctf_id_t ctc_return;      /* Function return type.  */
0160   uint32_t ctc_argc;        /* Number of typed arguments to function.  */
0161   uint32_t ctc_flags;       /* Function attributes (see below).  */
0162 } ctf_funcinfo_t;
0163 
0164 typedef struct ctf_lblinfo
0165 {
0166   ctf_id_t ctb_type;        /* Last type associated with the label.  */
0167 } ctf_lblinfo_t;
0168 
0169 typedef struct ctf_snapshot_id
0170 {
0171   unsigned long dtd_id;     /* Highest DTD ID at time of snapshot.  */
0172   unsigned long snapshot_id;    /* Snapshot id at time of snapshot.  */
0173 } ctf_snapshot_id_t;
0174 
0175 #define CTF_FUNC_VARARG 0x1 /* Function arguments end with varargs.  */
0176 
0177 /* Functions that return a ctf_id_t use the following value to indicate failure.
0178    ctf_errno can be used to obtain an error code.  Functions that return
0179    a straight integral -1 also use ctf_errno.  */
0180 #define CTF_ERR ((ctf_id_t) -1L)
0181 
0182 /* This macro holds information about all the available ctf errors.
0183    It is used to form both an enum holding all the error constants,
0184    and also the error strings themselves.  To use, define _CTF_FIRST
0185    and _CTF_ITEM to expand as you like, then mention the macro name.
0186    See the enum after this for an example.  */
0187 #define _CTF_ERRORS \
0188   _CTF_FIRST (ECTF_FMT, "File is not in CTF or ELF format.")    \
0189   _CTF_ITEM (ECTF_BFDERR, "BFD error.")             \
0190   _CTF_ITEM (ECTF_CTFVERS, "CTF dict version is too new for libctf.") \
0191   _CTF_ITEM (ECTF_BFD_AMBIGUOUS, "Ambiguous BFD target.")   \
0192   _CTF_ITEM (ECTF_SYMTAB, "Symbol table uses invalid entry size.") \
0193   _CTF_ITEM (ECTF_SYMBAD, "Symbol table data buffer is not valid.") \
0194   _CTF_ITEM (ECTF_STRBAD, "String table data buffer is not valid.") \
0195   _CTF_ITEM (ECTF_CORRUPT, "File data structure corruption detected.") \
0196   _CTF_ITEM (ECTF_NOCTFDATA, "File does not contain CTF data.") \
0197   _CTF_ITEM (ECTF_NOCTFBUF, "Buffer does not contain CTF data.") \
0198   _CTF_ITEM (ECTF_NOSYMTAB, "Symbol table information is not available.") \
0199   _CTF_ITEM (ECTF_NOPARENT, "The parent CTF dictionary is needed but unavailable.") \
0200   _CTF_ITEM (ECTF_DMODEL, "Data model mismatch.") \
0201   _CTF_ITEM (ECTF_LINKADDEDLATE, "File added to link too late.") \
0202   _CTF_ITEM (ECTF_ZALLOC, "Failed to allocate (de)compression buffer.") \
0203   _CTF_ITEM (ECTF_DECOMPRESS, "Failed to decompress CTF data.") \
0204   _CTF_ITEM (ECTF_STRTAB, "External string table is not available.") \
0205   _CTF_ITEM (ECTF_BADNAME, "String name offset is corrupt.") \
0206   _CTF_ITEM (ECTF_BADID, "Invalid type identifier.") \
0207   _CTF_ITEM (ECTF_NOTSOU, "Type is not a struct or union.") \
0208   _CTF_ITEM (ECTF_NOTENUM, "Type is not an enum.") \
0209   _CTF_ITEM (ECTF_NOTSUE, "Type is not a struct, union, or enum.") \
0210   _CTF_ITEM (ECTF_NOTINTFP, "Type is not an integer, float, or enum.") \
0211   _CTF_ITEM (ECTF_NOTARRAY, "Type is not an array.") \
0212   _CTF_ITEM (ECTF_NOTREF, "Type does not reference another type.") \
0213   _CTF_ITEM (ECTF_NAMELEN, "Buffer is too small to hold type name.") \
0214   _CTF_ITEM (ECTF_NOTYPE, "No type found corresponding to name.") \
0215   _CTF_ITEM (ECTF_SYNTAX, "Syntax error in type name.") \
0216   _CTF_ITEM (ECTF_NOTFUNC, "Symbol table entry or type is not a function.") \
0217   _CTF_ITEM (ECTF_NOFUNCDAT, "No function information available for function.") \
0218   _CTF_ITEM (ECTF_NOTDATA, "Symbol table entry does not refer to a data object.") \
0219   _CTF_ITEM (ECTF_NOTYPEDAT, "No type information available for symbol.") \
0220   _CTF_ITEM (ECTF_NOLABEL, "No label found corresponding to name.") \
0221   _CTF_ITEM (ECTF_NOLABELDATA, "File does not contain any labels.") \
0222   _CTF_ITEM (ECTF_NOTSUP, "Feature not supported.") \
0223   _CTF_ITEM (ECTF_NOENUMNAM, "Enumerator name not found.") \
0224   _CTF_ITEM (ECTF_NOMEMBNAM, "Member name not found.") \
0225   _CTF_ITEM (ECTF_RDONLY, "CTF container is read-only.") \
0226   _CTF_ITEM (ECTF_DTFULL, "CTF type is full (no more members allowed).") \
0227   _CTF_ITEM (ECTF_FULL, "CTF container is full.") \
0228   _CTF_ITEM (ECTF_DUPLICATE, "Duplicate member, enumerator, or variable name.") \
0229   _CTF_ITEM (ECTF_CONFLICT, "Conflicting type is already defined.") \
0230   _CTF_ITEM (ECTF_OVERROLLBACK, "Attempt to roll back past a ctf_update.") \
0231   _CTF_ITEM (ECTF_COMPRESS, "Failed to compress CTF data.") \
0232   _CTF_ITEM (ECTF_ARCREATE, "Error creating CTF archive.") \
0233   _CTF_ITEM (ECTF_ARNNAME, "Name not found in CTF archive.") \
0234   _CTF_ITEM (ECTF_SLICEOVERFLOW, "Overflow of type bitness or offset in slice.") \
0235   _CTF_ITEM (ECTF_DUMPSECTUNKNOWN, "Unknown section number in dump.") \
0236   _CTF_ITEM (ECTF_DUMPSECTCHANGED, "Section changed in middle of dump.") \
0237   _CTF_ITEM (ECTF_NOTYET, "Feature not yet implemented.") \
0238   _CTF_ITEM (ECTF_INTERNAL, "Internal error: assertion failure.") \
0239   _CTF_ITEM (ECTF_NONREPRESENTABLE, "Type not representable in CTF.") \
0240   _CTF_ITEM (ECTF_NEXT_END, "End of iteration.") \
0241   _CTF_ITEM (ECTF_NEXT_WRONGFUN, "Wrong iteration function called.") \
0242   _CTF_ITEM (ECTF_NEXT_WRONGFP, "Iteration entity changed in mid-iterate.") \
0243   _CTF_ITEM (ECTF_FLAGS, "CTF header contains flags unknown to libctf.") \
0244   _CTF_ITEM (ECTF_NEEDSBFD, "This feature needs a libctf with BFD support.") \
0245   _CTF_ITEM (ECTF_INCOMPLETE, "Type is not a complete type.") \
0246   _CTF_ITEM (ECTF_NONAME, "Type name must not be empty.") \
0247   _CTF_ITEM (ECTF_BADFLAG, "Invalid CTF dict flag specified.")
0248 
0249 #define ECTF_BASE   1000    /* Base value for libctf errnos.  */
0250 
0251 enum
0252   {
0253 #define _CTF_FIRST(NAME, STR) NAME = ECTF_BASE
0254 #define _CTF_ITEM(NAME, STR) , NAME
0255 _CTF_ERRORS
0256 #undef _CTF_ITEM
0257 #undef _CTF_FIRST
0258   };
0259 
0260 #define ECTF_NERR (ECTF_BADFLAG - ECTF_BASE + 1) /* Count of CTF errors.  */
0261 
0262 /* The CTF data model is inferred to be the caller's data model or the data
0263    model of the given object, unless ctf_setmodel is explicitly called.  */
0264 #define CTF_MODEL_ILP32 1   /* Object data model is ILP32.  */
0265 #define CTF_MODEL_LP64  2   /* Object data model is LP64.  */
0266 #ifdef _LP64
0267 # define CTF_MODEL_NATIVE CTF_MODEL_LP64
0268 #else
0269 # define CTF_MODEL_NATIVE CTF_MODEL_ILP32
0270 #endif
0271 
0272 /* Dynamic CTF containers can be created using ctf_create.  The ctf_add_*
0273    routines can be used to add new definitions to the dynamic container.  New
0274    types are labeled as root or non-root to determine whether they are visible
0275    at the top-level program scope when subsequently doing a lookup.
0276    (Identifiers contained within non-root types, like enumeration constants, are
0277    also not visible.)  */
0278 
0279 #define CTF_ADD_NONROOT 0   /* Type only visible in nested scope.  */
0280 #define CTF_ADD_ROOT    1   /* Type visible at top-level scope.  */
0281 
0282 /* Flags for ctf_member_next.  */
0283 
0284 #define CTF_MN_RECURSE 0x1  /* Recurse into unnamed members.  */
0285 
0286 /* Flags for ctf_dict_set_flag.  */
0287 
0288 /* If set, duplicate enumerators in a single dict fail with ECTF_DUPLICATE.  */
0289 
0290 #define CTF_STRICT_NO_DUP_ENUMERATORS   0x1
0291 
0292 /* These typedefs are used to define the signature for callback functions that
0293    can be used with the iteration and visit functions below.  There is also a
0294    family of iteration functions that do not require callbacks.  */
0295 
0296 typedef int ctf_visit_f (const char *name, ctf_id_t type, unsigned long offset,
0297              int depth, void *arg);
0298 typedef int ctf_member_f (const char *name, ctf_id_t membtype,
0299               unsigned long offset, void *arg);
0300 typedef int ctf_enum_f (const char *name, int val, void *arg);
0301 typedef int ctf_variable_f (const char *name, ctf_id_t type, void *arg);
0302 typedef int ctf_type_f (ctf_id_t type, void *arg);
0303 typedef int ctf_type_all_f (ctf_id_t type, int flag, void *arg);
0304 typedef int ctf_label_f (const char *name, const ctf_lblinfo_t *info,
0305              void *arg);
0306 typedef int ctf_archive_member_f (ctf_dict_t *fp, const char *name, void *arg);
0307 typedef int ctf_archive_raw_member_f (const char *name, const void *content,
0308                       size_t len, void *arg);
0309 typedef char *ctf_dump_decorate_f (ctf_sect_names_t sect,
0310                    char *line, void *arg);
0311 
0312 typedef struct ctf_dump_state ctf_dump_state_t;
0313 
0314 /* Iteration state for the _next functions, and allocators/copiers/freers for
0315    it.  (None of these are needed for the simple case of iterating to the end:
0316    the _next functions allocate and free the iterators for you.)
0317 
0318    The _next iterators all work in similar ways: they take things to query (a
0319    dict, a name, a type ID, something like that), then a ctf_next_t iterator
0320    arg which must be the address of a variable whose value is NULL on first
0321    call, and will be set to NULL again once iteration has completed.
0322 
0323    They return something important about the thing being iterated over (often a
0324    type ID or a name); on end of iteration they instead return return CTF_ERR,
0325    -1, or NULL and set the error ECTF_NEXT_END on the dict.  They can often
0326    provide more information too: this is done via pointer parameters (e.g. the
0327    membname and membtype in ctf_member_next()).  These parameters are always
0328    optional and can be set to NULL if not needed.
0329 
0330    Errors other than end-of-iteration will return CTF_ERR/-1/NULL and set the
0331    error to something other than ECTF_NEXT_END, and *not* destroy the iterator:
0332    you should either recover somehow and continue iterating, or call
0333    ctf_next_destroy() on it.  (You can call ctf_next_destroy() on a NULL
0334    iterator, so it's safe to just unconditionally do it after iteration has
0335    completed.)  */
0336 
0337 typedef struct ctf_next ctf_next_t;
0338 extern ctf_next_t *ctf_next_create (void);
0339 extern void ctf_next_destroy (ctf_next_t *);
0340 extern ctf_next_t *ctf_next_copy (ctf_next_t *);
0341 
0342 /* Opening.  These mostly return an abstraction over both CTF files and CTF
0343    archives: so they can be used to open both.  CTF files will appear to be an
0344    archive with one member named '.ctf'.
0345 
0346    All these functions except for ctf_close use BFD and can open anything BFD
0347    can open, hunting down the .ctf section for you, so are not available in the
0348    libctf-nobfd flavour of the library.  If you want to provide the CTF section
0349    yourself, you can do that with ctf_bfdopen_ctfsect.  */
0350 
0351 extern ctf_archive_t *ctf_bfdopen (struct bfd *, int *);
0352 extern ctf_archive_t *ctf_bfdopen_ctfsect (struct bfd *, const ctf_sect_t *,
0353                        int *);
0354 extern ctf_archive_t *ctf_fdopen (int fd, const char *filename,
0355                   const char *target, int *errp);
0356 extern ctf_archive_t *ctf_open (const char *filename,
0357                 const char *target, int *errp);
0358 extern void ctf_close (ctf_archive_t *);
0359 
0360 /* Set or unset dict-wide boolean flags, and get the value of these flags.  */
0361 
0362 extern int ctf_dict_set_flag (ctf_dict_t *, uint64_t flag, int set);
0363 extern int ctf_dict_get_flag (ctf_dict_t *, uint64_t flag);
0364 
0365 /* Return the data, symbol, or string sections used by a given CTF dict.  */
0366 extern ctf_sect_t ctf_getdatasect (const ctf_dict_t *);
0367 extern ctf_sect_t ctf_getsymsect (const ctf_dict_t *);
0368 extern ctf_sect_t ctf_getstrsect (const ctf_dict_t *);
0369 
0370 /* Set the endianness of the symbol section, which may be different from
0371    the endianness of the CTF dict. Done for you by ctf_open and ctf_fdopen,
0372    but direct calls to ctf_bufopen etc with symbol sections provided must
0373    do so explicitly.  */
0374 
0375 extern void ctf_symsect_endianness (ctf_dict_t *, int little_endian);
0376 extern void ctf_arc_symsect_endianness (ctf_archive_t *, int little_endian);
0377 
0378 /* Open CTF archives from files or raw section data, and close them again.
0379    Closing may munmap() the data making up the archive, so should not be
0380    done until all dicts are finished with and closed themselves.
0381 
0382    Almost all functions that open archives will also open raw CTF dicts, which
0383    are treated as if they were archives with only one member.
0384 
0385    Some of these functions take optional raw symtab and strtab section content
0386    in the form of ctf_sect_t structures.  For CTF in ELF files, the more
0387    convenient opening functions above extract these .dynsym and its associated
0388    string table (usually .dynsym) whenever the CTF_F_DYNSTR flag is set in the
0389    CTF preamble (which it almost always will be for linked objects, but not for
0390    .o files).  If you use ctf_arc_bufopen and do not specify symbol/string
0391    tables, the ctf_*_lookuup_symbol functions will fail with ECTF_NOSYMTAB.
0392 
0393    Like many other convenient opening functions, ctf_arc_open needs BFD and is
0394    not available in libctf-nobfd.  */
0395 
0396 extern ctf_archive_t *ctf_arc_open (const char *, int *);
0397 extern ctf_archive_t *ctf_arc_bufopen (const ctf_sect_t *ctfsect,
0398                        const ctf_sect_t *symsect,
0399                        const ctf_sect_t *strsect,
0400                        int *);
0401 extern void ctf_arc_close (ctf_archive_t *);
0402 
0403 /* Get the archive a given dictionary came from (if any).  */
0404 
0405 extern ctf_archive_t *ctf_get_arc (const ctf_dict_t *);
0406 
0407 /* Return the number of members in an archive.  */
0408 
0409 extern size_t ctf_archive_count (const ctf_archive_t *);
0410 
0411 /* Open a dictionary with a given name, given a CTF archive and
0412    optionally symbol and string table sections to accompany it (if the
0413    archive was oriiginally opened from an ELF file via ctf_open*, or
0414    if string or symbol tables were explicitly passed when the archive
0415    was opened, this can be used to override that choice).  The dict
0416    should be closed with ctf_dict_close() when done.
0417 
0418    (The low-level functions ctf_simple_open and ctf_bufopen return
0419    ctf_dict_t's directly, and cannot be used on CTF archives: use these
0420    functions instead.)  */
0421 
0422 extern ctf_dict_t *ctf_dict_open (const ctf_archive_t *,
0423                   const char *, int *);
0424 extern ctf_dict_t *ctf_dict_open_sections (const ctf_archive_t *,
0425                        const ctf_sect_t *symsect,
0426                        const ctf_sect_t *strsect,
0427                        const char *, int *);
0428 
0429 /* Look up symbols' types in archives by index or name, returning the dict
0430    and optionally type ID in which the type is found.  Lookup results are
0431    cached so future lookups are faster.  Needs symbol tables and (for name
0432    lookups) string tables to be known for this CTF archive.  */
0433 
0434 extern ctf_dict_t *ctf_arc_lookup_symbol (ctf_archive_t *,
0435                       unsigned long symidx,
0436                       ctf_id_t *, int *errp);
0437 extern ctf_dict_t *ctf_arc_lookup_symbol_name (ctf_archive_t *,
0438                            const char *name,
0439                            ctf_id_t *, int *errp);
0440 extern void ctf_arc_flush_caches (ctf_archive_t *);
0441 
0442 /* The next functions return or close real CTF files, or write out CTF
0443    archives, not archives or ELF files containing CTF content.  As with
0444    ctf_dict_open_sections, they can be passed symbol and string table
0445    sections.  */
0446 
0447 extern ctf_dict_t *ctf_simple_open (const char *ctfsect, size_t ctfsect_size,
0448                     const char *symsect, size_t symsect_size,
0449                     size_t symsect_entsize,
0450                     const char *strsect, size_t strsect_size,
0451                     int *errp);
0452 extern ctf_dict_t *ctf_bufopen (const ctf_sect_t *ctfsect,
0453                 const ctf_sect_t *symsect,
0454                 const ctf_sect_t *strsect, int *);
0455 extern void ctf_ref (ctf_dict_t *);
0456 extern void ctf_dict_close (ctf_dict_t *);
0457 
0458 /* CTF dicts may be in a parent/child relationship, where the child dicts
0459    contain the name of their originating compilation unit and the name of
0460    their parent.  Dicts opened from CTF archives have this relationship set
0461    up already, but if opening via raw low-level calls, you need to figure
0462    out which dict is the parent and set it on the child via ctf_import(). */
0463 
0464 extern const char *ctf_cuname (ctf_dict_t *);
0465 extern ctf_dict_t *ctf_parent_dict (ctf_dict_t *);
0466 extern const char *ctf_parent_name (ctf_dict_t *);
0467 extern int ctf_type_isparent (ctf_dict_t *, ctf_id_t);
0468 extern int ctf_type_ischild (ctf_dict_t *, ctf_id_t);
0469 extern int ctf_import (ctf_dict_t *, ctf_dict_t *);
0470 
0471 /* Set these names (used when creating dicts).  */
0472 
0473 extern int ctf_cuname_set (ctf_dict_t *, const char *);
0474 extern int ctf_parent_name_set (ctf_dict_t *, const char *);
0475 
0476 /* Set and get the CTF data model (see above).  */
0477 
0478 extern int ctf_setmodel (ctf_dict_t *, int);
0479 extern int ctf_getmodel (ctf_dict_t *);
0480 
0481 /* CTF dicts can carry a single (in-memory-only) non-persistent pointer to
0482    arbitrary data.  No meaning is attached to this data and the dict does
0483    not own it: nothing is done to it when the dict is closed.  */
0484 
0485 extern void ctf_setspecific (ctf_dict_t *, void *);
0486 extern void *ctf_getspecific (ctf_dict_t *);
0487 
0488 /* Error handling.  ctf dicts carry a system errno value or one of the
0489    CTF_ERRORS above, which are returned via ctf_errno.  The return value of
0490    ctf_errno is only meaningful when the immediately preceding CTF function
0491    call returns an error code.
0492 
0493    There are four possible sorts of error return:
0494 
0495     - From opening functions, a return value of NULL and the error returned
0496       via an errp instead of via ctf_errno; all other functions return return
0497       errors via ctf_errno.
0498 
0499     - Functions returning a ctf_id_t are in error if the return value == CTF_ERR
0500     - Functions returning an int are in error if their return value < 0
0501     - Functions returning a pointer are in error if their return value ==
0502       NULL.  */
0503 
0504 extern int ctf_errno (ctf_dict_t *);
0505 extern const char *ctf_errmsg (int);
0506 
0507 /* Return the version of CTF dicts written by writeout functions.  The
0508    argument must currently be zero.  All dicts with versions below the value
0509    returned by this function can be read by the library.  CTF dicts written
0510    by other non-GNU CTF libraries (e.g. that in FreeBSD) are not compatible
0511    and cannot be read by this library.  */
0512 
0513 extern int ctf_version (int);
0514 
0515 /* Given a symbol table index corresponding to a function symbol, return info on
0516    the type of a given function's arguments or return value.  Vararg functions
0517    have a final arg with CTF_FUNC_VARARG on in ctc_flags.  */
0518 
0519 extern int ctf_func_info (ctf_dict_t *, unsigned long, ctf_funcinfo_t *);
0520 extern int ctf_func_args (ctf_dict_t *, unsigned long, uint32_t, ctf_id_t *);
0521 
0522 /* As above, but for CTF_K_FUNCTION types in CTF dicts.  */
0523 
0524 extern int ctf_func_type_info (ctf_dict_t *, ctf_id_t, ctf_funcinfo_t *);
0525 extern int ctf_func_type_args (ctf_dict_t *, ctf_id_t, uint32_t, ctf_id_t *);
0526 
0527 /* Look up function or data symbols by name and return their CTF type ID,
0528   if any.  (For both function symbols and data symbols that are function
0529   pointers, the types are of kind CTF_K_FUNCTION.)  */
0530 
0531 extern ctf_id_t ctf_lookup_by_symbol (ctf_dict_t *, unsigned long);
0532 extern ctf_id_t ctf_lookup_by_symbol_name (ctf_dict_t *, const char *);
0533 
0534 /* Traverse all (function or data) symbols in a dict, one by one, and return the
0535    type of each and (if NAME is non-NULL) optionally its name.  */
0536 
0537 extern ctf_id_t ctf_symbol_next (ctf_dict_t *, ctf_next_t **,
0538                  const char **name, int functions);
0539 
0540 /* Look up a type by name: some simple C type parsing is done, but this is by no
0541    means comprehensive.  Structures, unions and enums need "struct ", "union "
0542    or "enum " on the front, as usual in C.  */
0543 
0544 extern ctf_id_t ctf_lookup_by_name (ctf_dict_t *, const char *);
0545 
0546 /* Look up a variable, which is a name -> type mapping with no specific
0547    relationship to a symbol table.  Before linking, everything with types in the
0548    symbol table will be in the variable table as well; after linking, only those
0549    typed functions and data objects that are not asssigned to symbols by the
0550    linker are left in the variable table here.  */
0551 
0552 extern ctf_id_t ctf_lookup_variable (ctf_dict_t *, const char *);
0553 
0554 /* Look up a single enumerator by enumeration constant name.  Returns the ID of
0555    the enum it is contained within and optionally its value.  Error out with
0556    ECTF_DUPLICATE if multiple exist (which can happen in some older dicts).  See
0557    ctf_lookup_enumerator_next in that case.  Enumeration constants in non-root
0558    types are not returned, but constants in parents are, if not overridden by
0559    an enum in the child.  */
0560 
0561 extern ctf_id_t ctf_lookup_enumerator (ctf_dict_t *, const char *,
0562                        int64_t *enum_value);
0563 
0564 /* Type lookup functions.  */
0565 
0566 /* Strip qualifiers and typedefs off a type, returning the base type.
0567 
0568    Stripping also stops when we hit slices (see ctf_add_slice below), so it is
0569    possible (given a chain looking like const -> slice -> typedef -> int) to
0570    still have a typedef after you're done with this, but in that case it is a
0571    typedef of a type with a *different width* (because this slice has not been
0572    applied to it).
0573 
0574    Most of the time you don't need to call this: the type-querying functions
0575    will do it for you (as noted below).  */
0576 
0577 extern ctf_id_t ctf_type_resolve (ctf_dict_t *, ctf_id_t);
0578 
0579 /* Get the name of a type, including any const/volatile/restrict qualifiers
0580    (cvr-quals), and return it as a new dynamically-allocated string.
0581    (The 'a' stands for 'a'llocated.) */
0582 
0583 extern char *ctf_type_aname (ctf_dict_t *, ctf_id_t);
0584 
0585 /* As above, but with no cvr-quals.  */
0586 
0587 extern char *ctf_type_aname_raw (ctf_dict_t *, ctf_id_t);
0588 
0589 /* A raw name that is owned by the ctf_dict_t and will live as long as it
0590    does.  Do not change the value this function returns!  */
0591 
0592 extern const char *ctf_type_name_raw (ctf_dict_t *, ctf_id_t);
0593 
0594 /* Like ctf_type_aname, but print the string into the passed buffer, truncating
0595    if necessary and setting ECTF_NAMELEN on the errno: return the actual number
0596    of bytes needed (not including the trailing \0).  Consider using
0597    ctf_type_aname instead.  */
0598 
0599 extern ssize_t ctf_type_lname (ctf_dict_t *, ctf_id_t, char *, size_t);
0600 
0601 /* Like ctf_type_lname, but return the string, or NULL if truncated.
0602    Consider using ctf_type_aname instead.  */
0603 
0604 extern char *ctf_type_name (ctf_dict_t *, ctf_id_t, char *, size_t);
0605 
0606 /* Return the size or alignment of a type.  Types with no meaningful size, like
0607    function types, return 0 as their size; incomplete types set ECTF_INCOMPLETE.
0608    The type is resolved for you, so cvr-quals and typedefs can be passsed in.  */
0609 
0610 extern ssize_t ctf_type_size (ctf_dict_t *, ctf_id_t);
0611 extern ssize_t ctf_type_align (ctf_dict_t *, ctf_id_t);
0612 
0613 /* Return the kind of a type (CTF_K_* constant).  Slices are considered to be
0614    the kind they are a slice of.  Forwards to incomplete structs, etc, return
0615    CTF_K_FORWARD (but deduplication resolves most forwards to their concrete
0616    types).  */
0617 
0618 extern int ctf_type_kind (ctf_dict_t *, ctf_id_t);
0619 
0620 /* Return the kind of a type (CTF_K_* constant).  Slices are considered to be
0621    the kind they are a slice of; forwards are considered to be the kind they are
0622    a forward of.  */
0623 
0624 extern int ctf_type_kind_forwarded (ctf_dict_t *, ctf_id_t);
0625 
0626 /* Return the type a pointer, typedef, cvr-qual, or slice refers to, or return
0627    an ECTF_NOTREF error otherwise.  ctf_type_kind pretends that slices are
0628    actually the type they are a slice of: this is usually want you want, but if
0629    you want to find out if a type was actually a slice of some (usually-wider)
0630    base type, you can call ctf_type_reference on it: a non-error return means
0631    it was a slice.  */
0632 
0633 extern ctf_id_t ctf_type_reference (ctf_dict_t *, ctf_id_t);
0634 
0635 /* Return the encoding of a given type.  No attempt is made to resolve the
0636    type first, so passing in typedefs etc will yield an error.  */
0637 
0638 extern int ctf_type_encoding (ctf_dict_t *, ctf_id_t, ctf_encoding_t *);
0639 
0640 /* Given a type, return some other type that is a pointer to this type (if any
0641    exists), or return ECTF_NOTYPE otherwise.  If non exists, try resolving away
0642    typedefs and cvr-quals and check again (so if you call this on foo_t, you
0643    might get back foo *).  No attempt is made to hunt for pointers to qualified
0644    versions of the type passed in.  */
0645 
0646 extern ctf_id_t ctf_type_pointer (ctf_dict_t *, ctf_id_t);
0647 
0648 /* Return 1 if two types are assignment-compatible.  */
0649 
0650 extern int ctf_type_compat (ctf_dict_t *, ctf_id_t, ctf_dict_t *, ctf_id_t);
0651 
0652 /* Recursively visit the members of any type, calling the ctf_visit_f for each.  */
0653 
0654 extern int ctf_type_visit (ctf_dict_t *, ctf_id_t, ctf_visit_f *, void *);
0655 
0656 /* Comparison function that defines an ordering over types.  If the types are in
0657    different dicts, the ordering may vary between different openings of the same
0658    dicts.  */
0659 
0660 extern int ctf_type_cmp (ctf_dict_t *, ctf_id_t, ctf_dict_t *, ctf_id_t);
0661 
0662 /* Get the name of an enumerator given its value, or vice versa.  If many
0663    enumerators have the same value, the first with that value is returned.  */
0664 
0665 extern const char *ctf_enum_name (ctf_dict_t *, ctf_id_t, int);
0666 extern int ctf_enum_value (ctf_dict_t *, ctf_id_t, const char *, int *);
0667 
0668 /* Get the size and member type of an array.  */
0669 
0670 extern int ctf_array_info (ctf_dict_t *, ctf_id_t, ctf_arinfo_t *);
0671 
0672 /* Get info on specific named members of structs or unions, and count the number
0673    of members in a struct, union, or enum.  */
0674 
0675 extern int ctf_member_info (ctf_dict_t *, ctf_id_t, const char *,
0676                 ctf_membinfo_t *);
0677 extern int ctf_member_count (ctf_dict_t *, ctf_id_t);
0678 
0679 /* Iterators.  */
0680 
0681 /* ctf_member_next is a _next-style iterator that can additionally traverse into
0682    the members of unnamed structs nested within this struct as if they were
0683    direct members, if CTF_MN_RECURSE is passed in the flags.  */
0684 
0685 extern int ctf_member_iter (ctf_dict_t *, ctf_id_t, ctf_member_f *, void *);
0686 extern ssize_t ctf_member_next (ctf_dict_t *, ctf_id_t, ctf_next_t **,
0687                 const char **name, ctf_id_t *membtype,
0688                 int flags);
0689 
0690 /* Return all enumeration constants in a given enum type.  */
0691 extern int ctf_enum_iter (ctf_dict_t *, ctf_id_t, ctf_enum_f *, void *);
0692 extern const char *ctf_enum_next (ctf_dict_t *, ctf_id_t, ctf_next_t **,
0693                   int *);
0694 
0695 /* Return all enumeration constants with a given name in a given dict, similar
0696    to ctf_lookup_enumerator above but capable of returning multiple values.
0697    Enumerators in parent dictionaries are not returned: enumerators in non-root
0698    types *are* returned.  This operation internally iterates over all types in
0699    the dict, so is relatively expensive in large dictionaries.
0700 
0701    There is nothing preventing NAME from being changed by the caller in the
0702    middle of iteration: the results might be slightly confusing, but they are
0703    well-defined.  */
0704 
0705 extern ctf_id_t ctf_lookup_enumerator_next (ctf_dict_t *, const char *name,
0706                         ctf_next_t **, int64_t *enum_value);
0707 
0708 /* Likewise, across all dicts in an archive (parent first).  The DICT and ERRP
0709    arguments are not optional: without the forer you can't tell which dict the
0710    returned type is in, and without the latter you can't distinguish real errors
0711    from end-of-iteration.  DICT should be NULL before the first call and is set
0712    to NULL after the last and on error: on successful call it is set to the dict
0713    containing the returned enum, and it is the caller's responsibility to
0714    ctf_dict_close() it.  The caller should otherwise pass it back in unchanged
0715    (do not reassign it during iteration, just as with the ctf_next_t iterator
0716    itself).  */
0717 
0718 extern ctf_id_t ctf_arc_lookup_enumerator_next (ctf_archive_t *, const char *name,
0719                         ctf_next_t **, int64_t *enum_value,
0720                         ctf_dict_t **dict, int *errp);
0721 
0722 /* Iterate over all types in a dict.  ctf_type_iter_all recurses over all types:
0723    ctf_type_iter recurses only over types with user-visible names (for which
0724    CTF_ADD_ROOT was passed).  All such types are returned, even if they are
0725    things like pointers that intrinsically have no name: this is the only effect
0726    of CTF_ADD_ROOT for such types.  ctf_type_next allows you to choose whether
0727    to see non-root types or not with the want_hidden arg: if set, the flag (if
0728    passed) returns the non-root state of each type in turn.  Types in parent
0729    dictionaries are not returned.  */
0730 
0731 extern int ctf_type_iter (ctf_dict_t *, ctf_type_f *, void *);
0732 extern int ctf_type_iter_all (ctf_dict_t *, ctf_type_all_f *, void *);
0733 extern ctf_id_t ctf_type_next (ctf_dict_t *, ctf_next_t **,
0734                    int *flag, int want_hidden);
0735 
0736 extern int ctf_variable_iter (ctf_dict_t *, ctf_variable_f *, void *);
0737 extern ctf_id_t ctf_variable_next (ctf_dict_t *, ctf_next_t **,
0738                    const char **);
0739 
0740 /* ctf_archive_iter and ctf_archive_next open each member dict for you,
0741    automatically importing any parent dict as usual: ctf_archive_iter closes the
0742    dict on return from ctf_archive_member_f, but for ctf_archive_next the caller
0743    must close each dict returned.  If skip_parent is set, the parent dict is
0744    skipped on the basis that it's already been seen in every child dict (but if
0745    no child dicts exist, this will lead to nothing being returned).
0746 
0747    If an open fails, ctf_archive_iter returns -1 early (losing the error), but
0748    ctf_archive_next both passes back the error in the passed errp and allows you
0749    to iterate past errors (until the usual ECTF_NEXT_END is returned).  */
0750 
0751 extern int ctf_archive_iter (const ctf_archive_t *, ctf_archive_member_f *,
0752                  void *);
0753 extern ctf_dict_t *ctf_archive_next (const ctf_archive_t *, ctf_next_t **,
0754                      const char **, int skip_parent, int *errp);
0755 
0756 /* Pass the raw content of each archive member in turn to
0757    ctf_archive_raw_member_f.
0758 
0759    This function alone does not currently operate on CTF files masquerading as
0760    archives, and returns -EINVAL: the raw data is no longer available.  It is
0761    expected to be used only by archiving tools, in any case, which have no need
0762    to deal with non-archives at all.  (There is currently no _next analogue of
0763    this function.)  */
0764 
0765 extern int ctf_archive_raw_iter (const ctf_archive_t *,
0766                  ctf_archive_raw_member_f *, void *);
0767 
0768 /* Dump the contents of a section in a CTF dict.  STATE is an
0769    iterator which should be a pointer to a variable set to NULL.  The decorator
0770    is called with each line in turn and can modify it or allocate and return a
0771    new one.  ctf_dump accumulates all the results and returns a single giant
0772    multiline string.  */
0773 
0774 extern char *ctf_dump (ctf_dict_t *, ctf_dump_state_t **state,
0775                ctf_sect_names_t sect, ctf_dump_decorate_f *,
0776                void *arg);
0777 
0778 /* Error-warning reporting: an 'iterator' that returns errors and warnings from
0779    the error/warning list, in order of emission.  Errors and warnings are popped
0780    after return: the caller must free the returned error-text pointer.  */
0781 extern char *ctf_errwarning_next (ctf_dict_t *, ctf_next_t **,
0782                   int *is_warning, int *errp);
0783 
0784 /* Creation.  */
0785 
0786 /* Create a new, empty dict.  If creation fails, return NULL and put a CTF error
0787    code in the passed-in int (if set).  */
0788 extern ctf_dict_t *ctf_create (int *);
0789 
0790 /* Add specific types to a dict.  You can add new types to any dict, but you can
0791    only add members to types that have been added since this dict was read in
0792    (you cannot read in a dict, look up a type in it, then add members to
0793    it).  All adding functions take a uint32_t CTF_ADD_ROOT / CTF_ADD_NONROOT
0794    flag to indicate whether this type should be visible to name lookups via
0795    ctf_lookup_by_name et al.  */
0796 
0797 extern ctf_id_t ctf_add_array (ctf_dict_t *, uint32_t,
0798                    const ctf_arinfo_t *);
0799 extern ctf_id_t ctf_add_const (ctf_dict_t *, uint32_t, ctf_id_t);
0800 extern ctf_id_t ctf_add_enum_encoded (ctf_dict_t *, uint32_t, const char *,
0801                       const ctf_encoding_t *);
0802 extern ctf_id_t ctf_add_enum (ctf_dict_t *, uint32_t, const char *);
0803 extern ctf_id_t ctf_add_float (ctf_dict_t *, uint32_t,
0804                    const char *, const ctf_encoding_t *);
0805 extern ctf_id_t ctf_add_forward (ctf_dict_t *, uint32_t, const char *,
0806                  uint32_t);
0807 extern ctf_id_t ctf_add_function (ctf_dict_t *, uint32_t,
0808                   const ctf_funcinfo_t *, const ctf_id_t *);
0809 extern ctf_id_t ctf_add_integer (ctf_dict_t *, uint32_t, const char *,
0810                  const ctf_encoding_t *);
0811 
0812 /* Add a "slice", which wraps some integral type and changes its encoding
0813    (useful for bitfields, etc).  In most respects slices are treated the same
0814    kind as the type they wrap: only ctf_type_reference can see the difference,
0815    returning the wrapped type.  */
0816 
0817 extern ctf_id_t ctf_add_slice (ctf_dict_t *, uint32_t, ctf_id_t, const ctf_encoding_t *);
0818 extern ctf_id_t ctf_add_pointer (ctf_dict_t *, uint32_t, ctf_id_t);
0819 extern ctf_id_t ctf_add_type (ctf_dict_t *, ctf_dict_t *, ctf_id_t);
0820 extern ctf_id_t ctf_add_typedef (ctf_dict_t *, uint32_t, const char *,
0821                  ctf_id_t);
0822 extern ctf_id_t ctf_add_restrict (ctf_dict_t *, uint32_t, ctf_id_t);
0823 
0824 /* Struct and union addition.  Straight addition uses possibly-confusing rules
0825    to guess the final size of the struct/union given its members: to explicitly
0826    state the size of the struct or union (to report compiler-generated padding,
0827    etc) use the _sized variants.  */
0828 
0829 extern ctf_id_t ctf_add_struct (ctf_dict_t *, uint32_t, const char *);
0830 extern ctf_id_t ctf_add_union (ctf_dict_t *, uint32_t, const char *);
0831 extern ctf_id_t ctf_add_struct_sized (ctf_dict_t *, uint32_t, const char *,
0832                       size_t);
0833 extern ctf_id_t ctf_add_union_sized (ctf_dict_t *, uint32_t, const char *,
0834                      size_t);
0835 
0836 /* Note that CTF cannot encode a given type.  This usually returns an
0837    ECTF_NONREPRESENTABLE error when queried.  Mostly useful for struct members,
0838    variables, etc, to point to.  */
0839 
0840 extern ctf_id_t ctf_add_unknown (ctf_dict_t *, uint32_t, const char *);
0841 extern ctf_id_t ctf_add_volatile (ctf_dict_t *, uint32_t, ctf_id_t);
0842 
0843 /* Add an enumerator to an enum.  If the enum is non-root, so are all the
0844    constants added to it by ctf_add_enumerator.  */
0845 
0846 extern int ctf_add_enumerator (ctf_dict_t *, ctf_id_t, const char *, int);
0847 
0848 /* Add a member to a struct or union, either at the next available offset (with
0849    suitable padding for the alignment) or at a specific offset, and possibly
0850    with a specific encoding (creating a slice for you).  Offsets need not be
0851    unique, and need not be added in ascending order.  */
0852 
0853 extern int ctf_add_member (ctf_dict_t *, ctf_id_t, const char *, ctf_id_t);
0854 extern int ctf_add_member_offset (ctf_dict_t *, ctf_id_t, const char *,
0855                   ctf_id_t, unsigned long);
0856 extern int ctf_add_member_encoded (ctf_dict_t *, ctf_id_t, const char *,
0857                    ctf_id_t, unsigned long,
0858                    const ctf_encoding_t);
0859 
0860 extern int ctf_add_variable (ctf_dict_t *, const char *, ctf_id_t);
0861 
0862 /* Set the size and member and index types of an array.  */
0863 
0864 extern int ctf_set_array (ctf_dict_t *, ctf_id_t, const ctf_arinfo_t *);
0865 
0866 /* Add a function oor object symbol type with a particular name, without saying
0867    anything about the actual symbol index.  (The linker will then associate them
0868    with actual symbol indexes using the ctf_link functions below.)  */
0869 
0870 extern int ctf_add_objt_sym (ctf_dict_t *, const char *, ctf_id_t);
0871 extern int ctf_add_func_sym (ctf_dict_t *, const char *, ctf_id_t);
0872 
0873 /* Snapshot/rollback.  Call ctf_update to snapshot the state of a dict:
0874   a later call to ctf_discard then deletes all types added since (but not new
0875   members, enumerands etc).  Call ctf_snapshot to return a snapshot ID: pass
0876   one of these IDs to ctf_rollback to discard all types added since the
0877   corresponding call to ctf_snapshot.  */
0878 
0879 extern int ctf_update (ctf_dict_t *);
0880 extern ctf_snapshot_id_t ctf_snapshot (ctf_dict_t *);
0881 extern int ctf_rollback (ctf_dict_t *, ctf_snapshot_id_t);
0882 extern int ctf_discard (ctf_dict_t *);
0883 
0884 /* Dict writeout.
0885 
0886    ctf_write: write out an uncompressed dict to an fd.
0887    ctf_compress_write: write out a compressed dict to an fd (currently always
0888    gzip, but this may change in future).
0889    ctf_write_mem: write out a dict to a buffer and return it and its size,
0890    compressing it if its uncompressed size is over THRESHOLD.  */
0891 
0892 extern int ctf_write (ctf_dict_t *, int);
0893 extern int ctf_compress_write (ctf_dict_t * fp, int fd);
0894 extern unsigned char *ctf_write_mem (ctf_dict_t *, size_t *, size_t threshold);
0895 
0896 /* Create a CTF archive named FILE from CTF_DICTS inputs with NAMES (or write it
0897    to the passed-in fd).  */
0898 
0899 extern int ctf_arc_write (const char *file, ctf_dict_t **ctf_dicts, size_t,
0900               const char **names, size_t);
0901 extern int ctf_arc_write_fd (int, ctf_dict_t **, size_t, const char **,
0902                  size_t);
0903 
0904 /* Linking.  These functions are used by ld to link .ctf sections in input
0905    object files into a single .ctf section which is an archive possibly
0906    containing members containing types whose names collide across multiple
0907    compilation units, but they are usable by other programs as well and are not
0908    private to the linker.  */
0909 
0910 /* Add a CTF archive to the link with a given NAME (usually the name of the
0911    containing object file).  The dict added to is usually a new dict created
0912    with ctf_create which will be filled with types corresponding to the shared
0913    dict in the output (conflicting types in child dicts in the output archive
0914    are stored in internal space inside this dict, but are not easily visible
0915    until after ctf_link_write below).
0916 
0917    The NAME need not be unique (but usually is).  */
0918 
0919 extern int ctf_link_add_ctf (ctf_dict_t *, ctf_archive_t *, const char *name);
0920 
0921 /* Do the deduplicating link, filling the dict with types.  The FLAGS are the
0922    CTF_LINK_* flags above.  */
0923 
0924 extern int ctf_link (ctf_dict_t *, int flags);
0925 
0926 /* Symtab linker handling, called after ctf_link to set up the symbol type
0927    information used by ctf_*_lookup_symbol.  */
0928 
0929 /* Add strings to the link from the ELF string table, repeatedly calling
0930    ADD_STRING to add each string and its corresponding offset in turn.  */
0931 
0932 typedef const char *ctf_link_strtab_string_f (uint32_t *offset, void *arg);
0933 extern int ctf_link_add_strtab (ctf_dict_t *,
0934                 ctf_link_strtab_string_f *add_string, void *);
0935 
0936 /* Note that a given symbol will be public with a given set of properties.
0937    If the symbol has been added with that name via ctf_add_{func,objt}_sym,
0938    this symbol type will end up in the symtypetabs and can be looked up via
0939    ctf_*_lookup_symbol after the dict is read back in.  */
0940 
0941 extern int ctf_link_add_linker_symbol (ctf_dict_t *, ctf_link_sym_t *);
0942 
0943 /* Impose an ordering on symbols, as defined by the strtab and symbol
0944    added by earlier calls to the above two functions.  */
0945 
0946 extern int ctf_link_shuffle_syms (ctf_dict_t *);
0947 
0948 /* Return the serialized form of this ctf_linked dict as a new
0949    dynamically-allocated string, compressed if size over THRESHOLD.
0950 
0951    May be a CTF dict or a CTF archive (this library mostly papers over the
0952    differences so you can open both the same way, treat both as ctf_archive_t
0953    and so on).  */
0954 
0955 extern unsigned char *ctf_link_write (ctf_dict_t *, size_t *size,
0956                       size_t threshold);
0957 
0958 /* Specialist linker functions.  These functions are not used by ld, but can be
0959    used by other programs making use of the linker machinery for other purposes
0960    to customize its output.  Must be called befoore ctf_link. */
0961 
0962 /* Add an entry to rename a given compilation unit to some other name.  This
0963    is only used if conflicting types are found in that compilation unit: they
0964    will instead be placed in the child dict named TO. Many FROMs can map to one
0965    TO: all the types are placed together in that dict, with any whose names
0966    collide as a result being marked as non-root types.  */
0967 
0968 extern int ctf_link_add_cu_mapping (ctf_dict_t *, const char *from,
0969                     const char *to);
0970 
0971 /* Allow CTF archive names to be tweaked at the last minute before writeout.
0972    Unlike cu-mappings, this cannot transform names so that they collide: it's
0973    meant for unusual use cases that use names for archive members that are not
0974    exactly the same as CU names but are modified in some systematic way.  */
0975 typedef char *ctf_link_memb_name_changer_f (ctf_dict_t *,
0976                         const char *, void *);
0977 extern void ctf_link_set_memb_name_changer
0978   (ctf_dict_t *, ctf_link_memb_name_changer_f *, void *);
0979 
0980 /* Filter out unwanted variables, which can be very voluminous, and (unlike
0981    symbols) cause the CTF string table to grow to hold their names.  The
0982    variable filter should return nonzero if a variable should not appear in the
0983    output.  */
0984 typedef int ctf_link_variable_filter_f (ctf_dict_t *, const char *, ctf_id_t,
0985                     void *);
0986 extern int ctf_link_set_variable_filter (ctf_dict_t *,
0987                      ctf_link_variable_filter_f *, void *);
0988 
0989 /* Turn debugging off and on, and get its value.  This is the same as setting
0990    LIBCTF_DEBUG in the environment.  */
0991 extern void ctf_setdebug (int debug);
0992 extern int ctf_getdebug (void);
0993 
0994 /* Deprecated aliases for existing functions and types.  */
0995 
0996 struct ctf_file;
0997 typedef struct ctf_dict ctf_file_t;
0998 extern void ctf_file_close (ctf_file_t *);
0999 extern ctf_dict_t *ctf_parent_file (ctf_dict_t *);
1000 extern ctf_dict_t *ctf_arc_open_by_name (const ctf_archive_t *,
1001                      const char *, int *);
1002 extern ctf_dict_t *ctf_arc_open_by_name_sections (const ctf_archive_t *arc,
1003                           const ctf_sect_t *symsect,
1004                           const ctf_sect_t *strsect,
1005                           const char *name, int *errp);
1006 
1007 /* Deprecated witeout function to write out a gzip-compressed dict.  Unlike all
1008    the other writeout functions, this even compresses the header (it has to,
1009    since it's passed a gzFile), so the caller must also decompress it, since
1010    ctf_open() etc cannot tell it is a CTF dict or how large it is before
1011    decompression.  */
1012 
1013 extern int ctf_gzwrite (ctf_dict_t *fp, gzFile fd);
1014 
1015 /* Deprecated functions with no current use.  */
1016 
1017 extern const char *ctf_label_topmost (ctf_dict_t *);
1018 extern int ctf_label_info (ctf_dict_t *, const char *, ctf_lblinfo_t *);
1019 extern int ctf_label_iter (ctf_dict_t *, ctf_label_f *, void *);
1020 extern int ctf_label_next (ctf_dict_t *, ctf_next_t **, const char **); /* TBD */
1021 
1022 #ifdef  __cplusplus
1023 }
1024 #endif
1025 
1026 #endif              /* _CTF_API_H */