libctf/ctf-impl.h

   1 /* Implementation header.
   2    Copyright (C) 2019-2021 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 #ifndef _CTF_IMPL_H
  21 #define _CTF_IMPL_H
  22
  23 #include "config.h"
  24 #include <errno.h>
  25 #include <sys/param.h>
  26 #include "ctf-decls.h"
  27 #include <ctf-api.h>
  28 #include "ctf-sha1.h"
  29 #include <sys/types.h>
  30 #include <stdlib.h>
  31 #include <stdarg.h>
  32 #include <stdio.h>
  33 #include <stdint.h>
  34 #include <limits.h>
  35 #include <ctype.h>
  36 #include <elf.h>
  37 #include <bfd.h>
  38 #include "hashtab.h"
  39 #include "ctf-intl.h"
  40
  41 #ifdef  __cplusplus
  42 extern "C"
  43 {
  44 #endif
  45
  46 /* Tuning.  */
  47
  48 /* The proportion of symtypetab entries which must be pads before we consider it
  49    worthwhile to emit a symtypetab section as an index.  Indexes cost time to
  50    look up, but save space all told.  Do not set to 1, since this will cause
  51    indexes to be eschewed completely, even in child dicts, at considerable space
  52    cost.  */
  53 #define CTF_INDEX_PAD_THRESHOLD .75
  54
  55 /* Compiler attributes.  */
  56
  57 #if defined (__GNUC__)
  58
  59 /* GCC.  We assume that all compilers claiming to be GCC support sufficiently
  60    many GCC attributes that the code below works.  If some non-GCC compilers
  61    masquerading as GCC in fact do not implement these attributes, version checks
  62    may be required.  */
  63
  64 /* We use the _libctf_*_ pattern to avoid clashes with any future attribute
  65    macros glibc may introduce, which have names of the pattern
  66    __attribute_blah__.  */
  67
  68 #define _libctf_printflike_(string_index,first_to_check) \
  69     __attribute__ ((__format__ (__printf__, (string_index), (first_to_check))))
  70 #define _libctf_unlikely_(x) __builtin_expect ((x), 0)
  71 #define _libctf_unused_ __attribute__ ((__unused__))
  72 #define _libctf_malloc_ __attribute__((__malloc__))
  73 #define _libctf_nonnull_(params) __attribute__((__nonnull__ params))
  74
  75 #else
  76
  77 #define _libctf_printflike_(string_index,first_to_check)
  78 #define _libctf_unlikely_(x) (x)
  79 #define _libctf_unused_
  80 #define _libctf_malloc_
  81 #define _libctf_nonnull_(params)
  82 #define __extension__
  83
  84 #endif
  85
  86 #if defined (ENABLE_LIBCTF_HASH_DEBUGGING) && !defined (NDEBUG)
  87 #include <assert.h>
  88 #define ctf_assert(fp, expr) (assert (expr), 1)
  89 #else
  90 #define ctf_assert(fp, expr)                                            \
  91   _libctf_unlikely_ (ctf_assert_internal (fp, __FILE__, __LINE__,       \
  92                                           #expr, !!(expr)))
  93 #endif
  94
  95 /* libctf in-memory state.  */
  96
  97 typedef struct ctf_fixed_hash ctf_hash_t; /* Private to ctf-hash.c.  */
  98 typedef struct ctf_dynhash ctf_dynhash_t; /* Private to ctf-hash.c.  */
  99 typedef struct ctf_dynset ctf_dynset_t;   /* Private to ctf-hash.c.  */
 100
 101 typedef struct ctf_strs
 102 {
 103   const char *cts_strs;         /* Base address of string table.  */
 104   size_t cts_len;               /* Size of string table in bytes.  */
 105 } ctf_strs_t;
 106
 107 typedef struct ctf_strs_writable
 108 {
 109   char *cts_strs;               /* Base address of string table.  */
 110   size_t cts_len;               /* Size of string table in bytes.  */
 111 } ctf_strs_writable_t;
 112
 113 typedef struct ctf_dmodel
 114 {
 115   const char *ctd_name;         /* Data model name.  */
 116   int ctd_code;                 /* Data model code.  */
 117   size_t ctd_pointer;           /* Size of void * in bytes.  */
 118   size_t ctd_char;              /* Size of char in bytes.  */
 119   size_t ctd_short;             /* Size of short in bytes.  */
 120   size_t ctd_int;               /* Size of int in bytes.  */
 121   size_t ctd_long;              /* Size of long in bytes.  */
 122 } ctf_dmodel_t;
 123
 124 typedef struct ctf_names
 125 {
 126   ctf_hash_t *ctn_readonly;     /* Hash table when readonly.  */
 127   ctf_dynhash_t *ctn_writable;  /* Hash table when writable.  */
 128 } ctf_names_t;
 129
 130 typedef struct ctf_lookup
 131 {
 132   const char *ctl_prefix;       /* String prefix for this lookup.  */
 133   size_t ctl_len;               /* Length of prefix string in bytes.  */
 134   ctf_names_t *ctl_hash;        /* Pointer to hash table for lookup.  */
 135 } ctf_lookup_t;
 136
 137 typedef struct ctf_dictops
 138 {
 139   uint32_t (*ctfo_get_kind) (uint32_t);
 140   uint32_t (*ctfo_get_root) (uint32_t);
 141   uint32_t (*ctfo_get_vlen) (uint32_t);
 142   ssize_t (*ctfo_get_ctt_size) (const ctf_dict_t *, const ctf_type_t *,
 143                                 ssize_t *, ssize_t *);
 144   ssize_t (*ctfo_get_vbytes) (ctf_dict_t *, unsigned short, ssize_t, size_t);
 145 } ctf_dictops_t;
 146
 147 typedef struct ctf_list
 148 {
 149   struct ctf_list *l_prev;      /* Previous pointer or tail pointer.  */
 150   struct ctf_list *l_next;      /* Next pointer or head pointer.  */
 151 } ctf_list_t;
 152
 153 typedef enum
 154   {
 155    CTF_PREC_BASE,
 156    CTF_PREC_POINTER,
 157    CTF_PREC_ARRAY,
 158    CTF_PREC_FUNCTION,
 159    CTF_PREC_MAX
 160   } ctf_decl_prec_t;
 161
 162 typedef struct ctf_decl_node
 163 {
 164   ctf_list_t cd_list;           /* Linked list pointers.  */
 165   ctf_id_t cd_type;             /* Type identifier.  */
 166   uint32_t cd_kind;             /* Type kind.  */
 167   uint32_t cd_n;                /* Type dimension if array.  */
 168 } ctf_decl_node_t;
 169
 170 typedef struct ctf_decl
 171 {
 172   ctf_list_t cd_nodes[CTF_PREC_MAX]; /* Declaration node stacks.  */
 173   int cd_order[CTF_PREC_MAX];        /* Storage order of decls.  */
 174   ctf_decl_prec_t cd_qualp;          /* Qualifier precision.  */
 175   ctf_decl_prec_t cd_ordp;           /* Ordered precision.  */
 176   char *cd_buf;                      /* Buffer for output.  */
 177   int cd_err;                        /* Saved error value.  */
 178   int cd_enomem;                     /* Nonzero if OOM during printing.  */
 179 } ctf_decl_t;
 180
 181 typedef struct ctf_dmdef
 182 {
 183   ctf_list_t dmd_list;          /* List forward/back pointers.  */
 184   char *dmd_name;               /* Name of this member.  */
 185   ctf_id_t dmd_type;            /* Type of this member (for sou).  */
 186   unsigned long dmd_offset;     /* Offset of this member in bits (for sou).  */
 187   int dmd_value;                /* Value of this member (for enum).  */
 188 } ctf_dmdef_t;
 189
 190 typedef struct ctf_dtdef
 191 {
 192   ctf_list_t dtd_list;          /* List forward/back pointers.  */
 193   ctf_id_t dtd_type;            /* Type identifier for this definition.  */
 194   ctf_type_t dtd_data;          /* Type node, including name.  */
 195   unsigned char *dtd_vlen;      /* Variable-length data for this type.  */
 196   union
 197   {
 198     ctf_list_t dtu_members;     /* struct, union, or enum */
 199   } dtd_u;
 200 } ctf_dtdef_t;
 201
 202 typedef struct ctf_dvdef
 203 {
 204   ctf_list_t dvd_list;          /* List forward/back pointers.  */
 205   char *dvd_name;               /* Name associated with variable.  */
 206   ctf_id_t dvd_type;            /* Type of variable.  */
 207   unsigned long dvd_snapshots;  /* Snapshot count when inserted.  */
 208 } ctf_dvdef_t;
 209
 210 typedef struct ctf_err_warning
 211 {
 212   ctf_list_t cew_list;          /* List forward/back pointers.  */
 213   int cew_is_warning;           /* 1 if warning, 0 if error.  */
 214   char *cew_text;               /* Error/warning text.  */
 215 } ctf_err_warning_t;
 216
 217 /* Atoms associate strings with a list of the CTF items that reference that
 218    string, so that ctf_update() can instantiate all the strings using the
 219    ctf_str_atoms and then reassociate them with the real string later.
 220
 221    Strings can be interned into ctf_str_atom without having refs associated
 222    with them, for values that are returned to callers, etc.  Items are only
 223    removed from this table on ctf_close(), but on every ctf_update(), all the
 224    csa_refs in all entries are purged.  */
 225
 226 typedef struct ctf_str_atom
 227 {
 228   const char *csa_str;          /* Backpointer to string (hash key).  */
 229   ctf_list_t csa_refs;          /* This string's refs.  */
 230   uint32_t csa_offset;          /* Strtab offset, if any.  */
 231   uint32_t csa_external_offset; /* External strtab offset, if any.  */
 232   unsigned long csa_snapshot_id; /* Snapshot ID at time of creation.  */
 233 } ctf_str_atom_t;
 234
 235 /* The refs of a single string in the atoms table.  */
 236
 237 typedef struct ctf_str_atom_ref
 238 {
 239   ctf_list_t caf_list;          /* List forward/back pointers.  */
 240   uint32_t *caf_ref;            /* A single ref to this string.  */
 241 } ctf_str_atom_ref_t;
 242
 243 /* A single linker-provided symbol, during symbol addition, possibly before we
 244    have been given external strtab refs.  */
 245 typedef struct ctf_in_flight_dynsym
 246 {
 247   ctf_list_t cid_list;          /* List forward/back pointers.  */
 248   ctf_link_sym_t cid_sym;       /* The linker-known symbol.  */
 249 } ctf_in_flight_dynsym_t;
 250
 251 /* The structure used as the key in a ctf_link_type_mapping.  The value is a
 252    type index, not a type ID.  */
 253
 254 typedef struct ctf_link_type_key
 255 {
 256   ctf_dict_t *cltk_fp;
 257   ctf_id_t cltk_idx;
 258 } ctf_link_type_key_t;
 259
 260 /* The structure used as the key in a cd_id_to_dict_t on 32-bit platforms.  */
 261 typedef struct ctf_type_id_key
 262 {
 263   int ctii_input_num;
 264   ctf_id_t ctii_type;
 265 } ctf_type_id_key_t;
 266
 267 /* Deduplicator state.
 268
 269    The dedup state below uses three terms consistently. A "hash" is a
 270    ctf_dynhash_t; a "hash value" is the hash value of a type as returned by
 271    ctf_dedup_hash_type; a "global type ID" or "global ID" is a packed-together
 272    reference to a single ctf_dict_t (by array index in an array of inputs) and
 273    ctf_id_t, i.e. a single instance of some hash value in some input.
 274
 275    The deduplication algorithm takes a bunch of inputs and yields a single
 276    shared "output" and possibly many outputs corresponding to individual inputs
 277    that still contain types after sharing of unconflicted types.  Almost all
 278    deduplicator state is stored in the struct ctf_dedup in the output, though a
 279    (very) few things are stored in inputs for simplicity's sake, usually if they
 280    are linking together things within the scope of a single TU.
 281
 282    Flushed at the end of every ctf_dedup run.  */
 283
 284 typedef struct ctf_dedup
 285 {
 286   /* The CTF linker flags in force for this dedup run.  */
 287   int cd_link_flags;
 288
 289   /* On 32-bit platforms only, a hash of global type IDs, in the form of
 290      a ctf_link_type_id_key_t.  */
 291   ctf_dynhash_t *cd_id_to_dict_t;
 292
 293   /* Atoms tables of decorated names: maps undecorated name to decorated name.
 294      (The actual allocations are in the CTF dict for the former and the real
 295      atoms table for the latter).  Uses the same namespaces as ctf_lookups,
 296      below, but has no need for null-termination.  */
 297   ctf_dynhash_t *cd_decorated_names[4];
 298
 299   /* Map type names to a hash from type hash value -> number of times each value
 300      has appeared.  */
 301   ctf_dynhash_t *cd_name_counts;
 302
 303   /* Map global type IDs to type hash values.  Used to determine if types are
 304      already hashed without having to recompute their hash values again, and to
 305      link types together at later stages.  Forwards that are peeked through to
 306      structs and unions are not represented in here, so lookups that might be
 307      such a type (in practice, all lookups) must go via cd_replaced_types first
 308      to take this into account.  Discarded before each rehashing.  */
 309   ctf_dynhash_t *cd_type_hashes;
 310
 311   /* Maps from the names of structs/unions/enums to a a single GID which is the
 312      only appearance of that type in any input: if it appears in more than one
 313      input, a value which is a GID with an input_num of -1 appears.  Used in
 314      share-duplicated link mode link modes to determine whether structs/unions
 315      can be cited from multiple TUs.  Only populated in that link mode.  */
 316   ctf_dynhash_t *cd_struct_origin;
 317
 318   /* Maps type hash values to a set of hash values of the types that cite them:
 319      i.e., pointing backwards up the type graph.  Used for recursive conflict
 320      marking.  Citations from tagged structures, unions, and forwards do not
 321      appear in this graph.  */
 322   ctf_dynhash_t *cd_citers;
 323
 324   /* Maps type hash values to input global type IDs.  The value is a set (a
 325      hash) of global type IDs.  Discarded before each rehashing.  The result of
 326      the ctf_dedup function.  */
 327   ctf_dynhash_t *cd_output_mapping;
 328
 329   /* A map giving the GID of the first appearance of each type for each type
 330      hash value.  */
 331   ctf_dynhash_t *cd_output_first_gid;
 332
 333   /* Used to ensure that we never try to map a single type ID to more than one
 334      hash.  */
 335   ctf_dynhash_t *cd_output_mapping_guard;
 336
 337   /* Maps the global type IDs of structures in input TUs whose members still
 338      need emission to the global type ID of the already-emitted target type
 339      (which has no members yet) in the appropriate target.  Uniquely, the latter
 340      ID represents a *target* ID (i.e. the cd_output_mapping of some specified
 341      input): we encode the shared (parent) dict with an ID of -1.  */
 342   ctf_dynhash_t *cd_emission_struct_members;
 343
 344   /* A set (a hash) of hash values of conflicting types.  */
 345   ctf_dynset_t *cd_conflicting_types;
 346
 347   /* A hash mapping fp *'s of inputs to their input_nums.  Used only by
 348      functions outside the core ctf_dedup / ctf_dedup_emit machinery which do
 349      not take an inputs array.  */
 350   ctf_dynhash_t *cd_input_nums;
 351
 352   /* Maps type hashes to ctf_id_t's in this dictionary.  Populated only at
 353      emission time, in the dictionary where emission is taking place.  */
 354   ctf_dynhash_t *cd_output_emission_hashes;
 355
 356   /* Maps the decorated names of conflicted cross-TU forwards that were forcibly
 357      emitted in this TU to their emitted ctf_id_ts.  Populated only at emission
 358      time, in the dictionary where emission is taking place. */
 359   ctf_dynhash_t *cd_output_emission_conflicted_forwards;
 360
 361   /* Points to the output counterpart of this input dictionary, at emission
 362      time.  */
 363   ctf_dict_t *cd_output;
 364 } ctf_dedup_t;
 365
 366 /* The ctf_dict is the structure used to represent a CTF dictionary to library
 367    clients, who see it only as an opaque pointer.  Modifications can therefore
 368    be made freely to this structure without regard to client versioning.  The
 369    ctf_dict_t typedef appears in <ctf-api.h> and declares a forward tag.
 370    (A ctf_file_t typedef also appears there, for historical reasons.)
 371
 372    NOTE: ctf_serialize requires that everything inside of ctf_dict either be an
 373    immediate value, a pointer to dynamically allocated data *outside* of the
 374    ctf_dict itself, a pointer to statically allocated data, or specially handled
 375    in ctf_serialize.  If you add a pointer to ctf_dict that points to something
 376    within the ctf_dict itself, you must make corresponding changes to
 377    ctf_serialize.  */
 378
 379 struct ctf_dict
 380 {
 381   const ctf_dictops_t *ctf_dictops; /* Version-specific dict operations.  */
 382   struct ctf_header *ctf_header;    /* The header from this CTF dict.  */
 383   unsigned char ctf_openflags;      /* Flags the dict had when opened.  */
 384   ctf_sect_t ctf_data;              /* CTF data from object file.  */
 385   ctf_sect_t ctf_symtab;            /* Symbol table from object file.  */
 386   ctf_sect_t ctf_strtab;            /* String table from object file.  */
 387   int ctf_symsect_little_endian;    /* Endianness of the ctf_symtab.  */
 388   ctf_dynhash_t *ctf_symhash;       /* (partial) hash, symsect name -> idx. */
 389   size_t ctf_symhash_latest;        /* Amount of symsect scanned so far.  */
 390   ctf_dynhash_t *ctf_prov_strtab;   /* Maps provisional-strtab offsets
 391                                        to names.  */
 392   ctf_dynhash_t *ctf_syn_ext_strtab; /* Maps ext-strtab offsets to names.  */
 393   void *ctf_data_mmapped;           /* CTF data we mmapped, to free later.  */
 394   size_t ctf_data_mmapped_len;      /* Length of CTF data we mmapped.  */
 395   ctf_names_t ctf_structs;          /* Hash table of struct types.  */
 396   ctf_names_t ctf_unions;           /* Hash table of union types.  */
 397   ctf_names_t ctf_enums;            /* Hash table of enum types.  */
 398   ctf_names_t ctf_names;            /* Hash table of remaining type names.  */
 399   ctf_lookup_t ctf_lookups[5];      /* Pointers to nametabs for name lookup.  */
 400   ctf_strs_t ctf_str[2];            /* Array of string table base and bounds.  */
 401   ctf_dynhash_t *ctf_str_atoms;   /* Hash table of ctf_str_atoms_t.  */
 402   uint64_t ctf_str_num_refs;      /* Number of refs to cts_str_atoms.  */
 403   uint32_t ctf_str_prov_offset;   /* Latest provisional offset assigned so far.  */
 404   unsigned char *ctf_base;        /* CTF file pointer.  */
 405   unsigned char *ctf_dynbase;     /* Freeable CTF file pointer. */
 406   unsigned char *ctf_buf;         /* Uncompressed CTF data buffer.  */
 407   size_t ctf_size;                /* Size of CTF header + uncompressed data.  */
 408   uint32_t *ctf_sxlate;           /* Translation table for unindexed symtypetab
 409                                      entries.  */
 410   unsigned long ctf_nsyms;        /* Number of entries in symtab xlate table.  */
 411   uint32_t *ctf_txlate;           /* Translation table for type IDs.  */
 412   uint32_t *ctf_ptrtab;           /* Translation table for pointer-to lookups.  */
 413   size_t ctf_ptrtab_len;          /* Num types storable in ptrtab currently.  */
 414   uint32_t *ctf_pptrtab;          /* Parent types pointed to by child dicts.  */
 415   size_t ctf_pptrtab_len;         /* Num types storable in pptrtab currently.  */
 416   uint32_t ctf_pptrtab_typemax;   /* Max child type when pptrtab last updated.  */
 417   uint32_t *ctf_funcidx_names;    /* Name of each function symbol in symtypetab
 418                                      (if indexed).  */
 419   uint32_t *ctf_objtidx_names;    /* Likewise, for object symbols.  */
 420   size_t ctf_nfuncidx;            /* Number of funcidx entries.  */
 421   uint32_t *ctf_funcidx_sxlate;   /* Offsets into funcinfo for a given funcidx.  */
 422   uint32_t *ctf_objtidx_sxlate;   /* Likewise, for ctf_objtidx.  */
 423   size_t ctf_nobjtidx;            /* Number of objtidx entries.  */
 424   ctf_dynhash_t *ctf_objthash;    /* name -> type ID.  */
 425   ctf_dynhash_t *ctf_funchash;    /* name -> CTF_K_FUNCTION type ID.  */
 426
 427   /* The next three are linker-derived state found in ctf_link targets only.  */
 428
 429   ctf_dynhash_t *ctf_dynsyms;     /* Symbol info from ctf_link_shuffle_syms.  */
 430   ctf_link_sym_t **ctf_dynsymidx;  /* Indexes ctf_dynsyms by symidx.  */
 431   uint32_t ctf_dynsymmax;         /* Maximum ctf_dynsym index.  */
 432   ctf_list_t ctf_in_flight_dynsyms; /* Dynsyms during accumulation.  */
 433   struct ctf_varent *ctf_vars;    /* Sorted variable->type mapping.  */
 434   unsigned long ctf_nvars;        /* Number of variables in ctf_vars.  */
 435   unsigned long ctf_typemax;      /* Maximum valid type ID number.  */
 436   const ctf_dmodel_t *ctf_dmodel; /* Data model pointer (see above).  */
 437   const char *ctf_cuname;         /* Compilation unit name (if any).  */
 438   char *ctf_dyncuname;            /* Dynamically allocated name of CU.  */
 439   struct ctf_dict *ctf_parent;    /* Parent CTF dict (if any).  */
 440   int ctf_parent_unreffed;        /* Parent set by ctf_import_unref?  */
 441   const char *ctf_parlabel;       /* Label in parent dict (if any).  */
 442   const char *ctf_parname;        /* Basename of parent (if any).  */
 443   char *ctf_dynparname;           /* Dynamically allocated name of parent.  */
 444   uint32_t ctf_parmax;            /* Highest type ID of a parent type.  */
 445   uint32_t ctf_refcnt;            /* Reference count (for parent links).  */
 446   uint32_t ctf_flags;             /* Libctf flags (see below).  */
 447   int ctf_errno;                  /* Error code for most recent error.  */
 448   int ctf_version;                /* CTF data version.  */
 449   ctf_dynhash_t *ctf_dthash;      /* Hash of dynamic type definitions.  */
 450   ctf_list_t ctf_dtdefs;          /* List of dynamic type definitions.  */
 451   ctf_dynhash_t *ctf_dvhash;      /* Hash of dynamic variable mappings.  */
 452   ctf_list_t ctf_dvdefs;          /* List of dynamic variable definitions.  */
 453   unsigned long ctf_dtoldid;      /* Oldest id that has been committed.  */
 454   unsigned long ctf_snapshots;    /* ctf_snapshot() plus ctf_update() count.  */
 455   unsigned long ctf_snapshot_lu;  /* ctf_snapshot() call count at last update.  */
 456   ctf_archive_t *ctf_archive;     /* Archive this ctf_dict_t came from.  */
 457   ctf_list_t ctf_errs_warnings;   /* CTF errors and warnings.  */
 458   ctf_dynhash_t *ctf_link_inputs; /* Inputs to this link.  */
 459   ctf_dynhash_t *ctf_link_outputs; /* Additional outputs from this link.  */
 460
 461   /* Map input types to output types for ctf_add_type.  Key is a
 462      ctf_link_type_key_t: value is a type ID.  */
 463   ctf_dynhash_t *ctf_link_type_mapping;
 464
 465   /* Map input CU names to output CTF dict names: populated in the top-level
 466      output dict.
 467
 468      Key and value are dynamically-allocated strings.  */
 469   ctf_dynhash_t *ctf_link_in_cu_mapping;
 470
 471   /* Map output CTF dict names to input CU names: populated in the top-level
 472      output dict.  A hash of string to hash (set) of strings.  Key and
 473      individual value members are shared with ctf_link_in_cu_mapping.  */
 474   ctf_dynhash_t *ctf_link_out_cu_mapping;
 475
 476   /* CTF linker flags.  Set on the parent output dict (the one passed to
 477      ctf_link).  Only respected when LCTF_LINKING set in ctf_flags.  */
 478   int ctf_link_flags;
 479
 480   /* Allow the caller to change the name of link archive members.  */
 481   ctf_link_memb_name_changer_f *ctf_link_memb_name_changer;
 482   void *ctf_link_memb_name_changer_arg;         /* Argument for it.  */
 483
 484   /* Allow the caller to filter out variables they don't care about.  */
 485   ctf_link_variable_filter_f *ctf_link_variable_filter;
 486   void *ctf_link_variable_filter_arg;           /* Argument for it. */
 487
 488   ctf_dynhash_t *ctf_add_processing; /* Types ctf_add_type is working on now.  */
 489
 490   /* Atoms table for dedup string storage.  All strings in the ctf_dedup_t are
 491      stored here.  Only the _alloc copy is allocated or freed: the
 492      ctf_dedup_atoms may be pointed to some other CTF dict, to share its atoms.
 493      We keep the atoms table outside the ctf_dedup so that atoms can be
 494      preserved across multiple similar links, such as when doing cu-mapped
 495      links.  */
 496   ctf_dynset_t *ctf_dedup_atoms;
 497   ctf_dynset_t *ctf_dedup_atoms_alloc;
 498
 499   ctf_dedup_t ctf_dedup;          /* Deduplicator state.  */
 500
 501   char *ctf_tmp_typeslice;        /* Storage for slicing up type names.  */
 502   size_t ctf_tmp_typeslicelen;    /* Size of the typeslice.  */
 503   void *ctf_specific;             /* Data for ctf_get/setspecific().  */
 504 };
 505
 506 /* An abstraction over both a ctf_dict_t and a ctf_archive_t.  */
 507
 508 struct ctf_archive_internal
 509 {
 510   int ctfi_is_archive;
 511   int ctfi_unmap_on_close;
 512   ctf_dict_t *ctfi_dict;
 513   struct ctf_archive *ctfi_archive;
 514   ctf_dynhash_t *ctfi_dicts;      /* Dicts we have opened and cached.  */
 515   ctf_dict_t *ctfi_crossdict_cache; /* Cross-dict caching.  */
 516   ctf_dict_t **ctfi_symdicts;     /* Array of index -> ctf_dict_t *.  */
 517   ctf_dynhash_t *ctfi_symnamedicts; /* Hash of name -> ctf_dict_t *.  */
 518   ctf_sect_t ctfi_symsect;
 519   int ctfi_symsect_little_endian; /* -1 for unknown / do not set.  */
 520   ctf_sect_t ctfi_strsect;
 521   int ctfi_free_symsect;
 522   int ctfi_free_strsect;
 523   void *ctfi_data;
 524   bfd *ctfi_abfd;                 /* Optional source of section data.  */
 525   void (*ctfi_bfd_close) (struct ctf_archive_internal *);
 526 };
 527
 528 /* Iterator state for the *_next() functions.  */
 529
 530 /* A single hash key/value pair.  */
 531 typedef struct ctf_next_hkv
 532 {
 533   void *hkv_key;
 534   void *hkv_value;
 535 } ctf_next_hkv_t;
 536
 537 struct ctf_next
 538 {
 539   void (*ctn_iter_fun) (void);
 540   ctf_id_t ctn_type;
 541   ssize_t ctn_size;
 542   ssize_t ctn_increment;
 543   uint32_t ctn_n;
 544
 545   /* Some iterators contain other iterators, in addition to their other
 546      state.  */
 547   ctf_next_t *ctn_next;
 548
 549   /* We can save space on this side of things by noting that a dictionary is
 550      either dynamic or not, as a whole, and a given iterator can only iterate
 551      over one kind of thing at once: so we can overlap the DTD and non-DTD
 552      members, and the structure, variable and enum members, etc.  */
 553   union
 554   {
 555     const ctf_member_t *ctn_mp;
 556     const ctf_lmember_t *ctn_lmp;
 557     const ctf_dmdef_t *ctn_dmd;
 558     const ctf_enum_t *ctn_en;
 559     const ctf_dvdef_t *ctn_dvd;
 560     ctf_next_hkv_t *ctn_sorted_hkv;
 561     void **ctn_hash_slot;
 562   } u;
 563
 564   /* This union is of various sorts of dict we can iterate over:
 565      currently dictionaries and archives, dynhashes, and dynsets.  */
 566   union
 567   {
 568     const ctf_dict_t *ctn_fp;
 569     const ctf_archive_t *ctn_arc;
 570     const ctf_dynhash_t *ctn_h;
 571     const ctf_dynset_t *ctn_s;
 572   } cu;
 573 };
 574
 575 /* Return x rounded up to an alignment boundary.
 576    eg, P2ROUNDUP(0x1234, 0x100) == 0x1300 (0x13*align)
 577    eg, P2ROUNDUP(0x5600, 0x100) == 0x5600 (0x56*align)  */
 578 #define P2ROUNDUP(x, align)             (-(-(x) & -(align)))
 579
 580 /* * If an offs is not aligned already then round it up and align it. */
 581 #define LCTF_ALIGN_OFFS(offs, align) ((offs + (align - 1)) & ~(align - 1))
 582
 583 #define LCTF_TYPE_ISPARENT(fp, id) ((id) <= fp->ctf_parmax)
 584 #define LCTF_TYPE_ISCHILD(fp, id) ((id) > fp->ctf_parmax)
 585 #define LCTF_TYPE_TO_INDEX(fp, id) ((id) & (fp->ctf_parmax))
 586 #define LCTF_INDEX_TO_TYPE(fp, id, child) (child ? ((id) | (fp->ctf_parmax+1)) : \
 587                                            (id))
 588
 589 #define LCTF_INDEX_TO_TYPEPTR(fp, i) \
 590     ((fp->ctf_flags & LCTF_RDWR) ?                                      \
 591      &(ctf_dtd_lookup (fp, LCTF_INDEX_TO_TYPE                           \
 592                        (fp, i, fp->ctf_flags & LCTF_CHILD))->dtd_data) : \
 593      (ctf_type_t *)((uintptr_t)(fp)->ctf_buf + (fp)->ctf_txlate[(i)]))
 594
 595 #define LCTF_INFO_KIND(fp, info)        ((fp)->ctf_dictops->ctfo_get_kind(info))
 596 #define LCTF_INFO_ISROOT(fp, info)      ((fp)->ctf_dictops->ctfo_get_root(info))
 597 #define LCTF_INFO_VLEN(fp, info)        ((fp)->ctf_dictops->ctfo_get_vlen(info))
 598 #define LCTF_VBYTES(fp, kind, size, vlen) \
 599   ((fp)->ctf_dictops->ctfo_get_vbytes(fp, kind, size, vlen))
 600
 601 #define LCTF_CHILD      0x0001  /* CTF dict is a child.  */
 602 #define LCTF_RDWR       0x0002  /* CTF dict is writable.  */
 603 #define LCTF_DIRTY      0x0004  /* CTF dict has been modified.  */
 604 #define LCTF_LINKING    0x0008  /* CTF link is underway: respect ctf_link_flags.  */
 605
 606 extern ctf_names_t *ctf_name_table (ctf_dict_t *, int);
 607 extern const ctf_type_t *ctf_lookup_by_id (ctf_dict_t **, ctf_id_t);
 608 extern ctf_id_t ctf_lookup_by_rawname (ctf_dict_t *, int, const char *);
 609 extern ctf_id_t ctf_lookup_by_rawhash (ctf_dict_t *, ctf_names_t *, const char *);
 610 extern void ctf_set_ctl_hashes (ctf_dict_t *);
 611
 612 extern int ctf_symtab_skippable (ctf_link_sym_t *sym);
 613 extern int ctf_add_funcobjt_sym (ctf_dict_t *, int is_function,
 614                                  const char *, ctf_id_t);
 615
 616 extern ctf_dict_t *ctf_get_dict (ctf_dict_t *fp, ctf_id_t type);
 617
 618 typedef unsigned int (*ctf_hash_fun) (const void *ptr);
 619 extern unsigned int ctf_hash_integer (const void *ptr);
 620 extern unsigned int ctf_hash_string (const void *ptr);
 621 extern unsigned int ctf_hash_type_key (const void *ptr);
 622 extern unsigned int ctf_hash_type_id_key (const void *ptr);
 623
 624 typedef int (*ctf_hash_eq_fun) (const void *, const void *);
 625 extern int ctf_hash_eq_integer (const void *, const void *);
 626 extern int ctf_hash_eq_string (const void *, const void *);
 627 extern int ctf_hash_eq_type_key (const void *, const void *);
 628 extern int ctf_hash_eq_type_id_key (const void *, const void *);
 629
 630 extern int ctf_dynset_eq_string (const void *, const void *);
 631
 632 typedef void (*ctf_hash_free_fun) (void *);
 633
 634 typedef void (*ctf_hash_iter_f) (void *key, void *value, void *arg);
 635 typedef int (*ctf_hash_iter_remove_f) (void *key, void *value, void *arg);
 636 typedef int (*ctf_hash_iter_find_f) (void *key, void *value, void *arg);
 637 typedef int (*ctf_hash_sort_f) (const ctf_next_hkv_t *, const ctf_next_hkv_t *,
 638                                 void *arg);
 639
 640 extern ctf_hash_t *ctf_hash_create (unsigned long, ctf_hash_fun, ctf_hash_eq_fun);
 641 extern int ctf_hash_insert_type (ctf_hash_t *, ctf_dict_t *, uint32_t, uint32_t);
 642 extern int ctf_hash_define_type (ctf_hash_t *, ctf_dict_t *, uint32_t, uint32_t);
 643 extern ctf_id_t ctf_hash_lookup_type (ctf_hash_t *, ctf_dict_t *, const char *);
 644 extern uint32_t ctf_hash_size (const ctf_hash_t *);
 645 extern void ctf_hash_destroy (ctf_hash_t *);
 646
 647 extern ctf_dynhash_t *ctf_dynhash_create (ctf_hash_fun, ctf_hash_eq_fun,
 648                                           ctf_hash_free_fun, ctf_hash_free_fun);
 649 extern int ctf_dynhash_insert (ctf_dynhash_t *, void *, void *);
 650 extern void ctf_dynhash_remove (ctf_dynhash_t *, const void *);
 651 extern size_t ctf_dynhash_elements (ctf_dynhash_t *);
 652 extern void ctf_dynhash_empty (ctf_dynhash_t *);
 653 extern void *ctf_dynhash_lookup (ctf_dynhash_t *, const void *);
 654 extern int ctf_dynhash_lookup_kv (ctf_dynhash_t *, const void *key,
 655                                   const void **orig_key, void **value);
 656 extern void ctf_dynhash_destroy (ctf_dynhash_t *);
 657 extern void ctf_dynhash_iter (ctf_dynhash_t *, ctf_hash_iter_f, void *);
 658 extern void ctf_dynhash_iter_remove (ctf_dynhash_t *, ctf_hash_iter_remove_f,
 659                                      void *);
 660 extern void *ctf_dynhash_iter_find (ctf_dynhash_t *, ctf_hash_iter_find_f,
 661                                     void *);
 662 extern int ctf_dynhash_sort_by_name (const ctf_next_hkv_t *,
 663                                      const ctf_next_hkv_t *,
 664                                      void * _libctf_unused_);
 665 extern int ctf_dynhash_next (ctf_dynhash_t *, ctf_next_t **,
 666                              void **key, void **value);
 667 extern int ctf_dynhash_next_sorted (ctf_dynhash_t *, ctf_next_t **,
 668                                     void **key, void **value, ctf_hash_sort_f,
 669                                     void *);
 670
 671 extern ctf_dynset_t *ctf_dynset_create (htab_hash, htab_eq, ctf_hash_free_fun);
 672 extern int ctf_dynset_insert (ctf_dynset_t *, void *);
 673 extern void ctf_dynset_remove (ctf_dynset_t *, const void *);
 674 extern void ctf_dynset_destroy (ctf_dynset_t *);
 675 extern void *ctf_dynset_lookup (ctf_dynset_t *, const void *);
 676 extern int ctf_dynset_exists (ctf_dynset_t *, const void *key,
 677                               const void **orig_key);
 678 extern int ctf_dynset_next (ctf_dynset_t *, ctf_next_t **, void **key);
 679 extern void *ctf_dynset_lookup_any (ctf_dynset_t *);
 680
 681 extern void ctf_sha1_init (ctf_sha1_t *);
 682 extern void ctf_sha1_add (ctf_sha1_t *, const void *, size_t);
 683 extern char *ctf_sha1_fini (ctf_sha1_t *, char *);
 684
 685 #define ctf_list_prev(elem)     ((void *)(((ctf_list_t *)(elem))->l_prev))
 686 #define ctf_list_next(elem)     ((void *)(((ctf_list_t *)(elem))->l_next))
 687
 688 extern void ctf_list_append (ctf_list_t *, void *);
 689 extern void ctf_list_prepend (ctf_list_t *, void *);
 690 extern void ctf_list_delete (ctf_list_t *, void *);
 691 extern void ctf_list_splice (ctf_list_t *, ctf_list_t *);
 692 extern int ctf_list_empty_p (ctf_list_t *lp);
 693
 694 extern int ctf_dtd_insert (ctf_dict_t *, ctf_dtdef_t *, int flag, int kind);
 695 extern void ctf_dtd_delete (ctf_dict_t *, ctf_dtdef_t *);
 696 extern ctf_dtdef_t *ctf_dtd_lookup (const ctf_dict_t *, ctf_id_t);
 697 extern ctf_dtdef_t *ctf_dynamic_type (const ctf_dict_t *, ctf_id_t);
 698
 699 extern int ctf_dvd_insert (ctf_dict_t *, ctf_dvdef_t *);
 700 extern void ctf_dvd_delete (ctf_dict_t *, ctf_dvdef_t *);
 701 extern ctf_dvdef_t *ctf_dvd_lookup (const ctf_dict_t *, const char *);
 702
 703 extern ctf_id_t ctf_add_encoded (ctf_dict_t *, uint32_t, const char *,
 704                                  const ctf_encoding_t *, uint32_t kind);
 705 extern ctf_id_t ctf_add_reftype (ctf_dict_t *, uint32_t, ctf_id_t,
 706                                  uint32_t kind);
 707
 708 extern int ctf_dedup_atoms_init (ctf_dict_t *);
 709 extern int ctf_dedup (ctf_dict_t *, ctf_dict_t **, uint32_t ninputs,
 710                       uint32_t *parents, int cu_mapped);
 711 extern void ctf_dedup_fini (ctf_dict_t *, ctf_dict_t **, uint32_t);
 712 extern ctf_dict_t **ctf_dedup_emit (ctf_dict_t *, ctf_dict_t **,
 713                                     uint32_t ninputs, uint32_t *parents,
 714                                     uint32_t *noutputs, int cu_mapped);
 715 extern ctf_id_t ctf_dedup_type_mapping (ctf_dict_t *fp, ctf_dict_t *src_fp,
 716                                         ctf_id_t src_type);
 717
 718 extern void ctf_decl_init (ctf_decl_t *);
 719 extern void ctf_decl_fini (ctf_decl_t *);
 720 extern void ctf_decl_push (ctf_decl_t *, ctf_dict_t *, ctf_id_t);
 721
 722 _libctf_printflike_ (2, 3)
 723 extern void ctf_decl_sprintf (ctf_decl_t *, const char *, ...);
 724 extern char *ctf_decl_buf (ctf_decl_t *cd);
 725
 726 extern const char *ctf_strptr (ctf_dict_t *, uint32_t);
 727 extern const char *ctf_strraw (ctf_dict_t *, uint32_t);
 728 extern const char *ctf_strraw_explicit (ctf_dict_t *, uint32_t,
 729                                         ctf_strs_t *);
 730 extern int ctf_str_create_atoms (ctf_dict_t *);
 731 extern void ctf_str_free_atoms (ctf_dict_t *);
 732 extern uint32_t ctf_str_add (ctf_dict_t *, const char *);
 733 extern uint32_t ctf_str_add_ref (ctf_dict_t *, const char *, uint32_t *ref);
 734 extern int ctf_str_add_external (ctf_dict_t *, const char *, uint32_t offset);
 735 extern void ctf_str_remove_ref (ctf_dict_t *, const char *, uint32_t *ref);
 736 extern void ctf_str_rollback (ctf_dict_t *, ctf_snapshot_id_t);
 737 extern void ctf_str_purge_refs (ctf_dict_t *);
 738 extern ctf_strs_writable_t ctf_str_write_strtab (ctf_dict_t *);
 739
 740 extern struct ctf_archive_internal *
 741 ctf_new_archive_internal (int is_archive, int unmap_on_close,
 742                           struct ctf_archive *, ctf_dict_t *,
 743                           const ctf_sect_t *symsect,
 744                           const ctf_sect_t *strsect, int *errp);
 745 extern struct ctf_archive *ctf_arc_open_internal (const char *, int *);
 746 extern void ctf_arc_close_internal (struct ctf_archive *);
 747 extern const ctf_preamble_t *ctf_arc_bufpreamble (const ctf_sect_t *);
 748 extern void *ctf_set_open_errno (int *, int);
 749 extern unsigned long ctf_set_errno (ctf_dict_t *, int);
 750
 751 extern ctf_dict_t *ctf_simple_open_internal (const char *, size_t, const char *,
 752                                              size_t, size_t,
 753                                              const char *, size_t,
 754                                              ctf_dynhash_t *, int, int *);
 755 extern ctf_dict_t *ctf_bufopen_internal (const ctf_sect_t *, const ctf_sect_t *,
 756                                          const ctf_sect_t *, ctf_dynhash_t *,
 757                                          int, int *);
 758 extern int ctf_import_unref (ctf_dict_t *fp, ctf_dict_t *pfp);
 759 extern int ctf_serialize (ctf_dict_t *);
 760
 761 _libctf_malloc_
 762 extern void *ctf_mmap (size_t length, size_t offset, int fd);
 763 extern void ctf_munmap (void *, size_t);
 764 extern ssize_t ctf_pread (int fd, void *buf, ssize_t count, off_t offset);
 765
 766 extern void *ctf_realloc (ctf_dict_t *, void *, size_t);
 767 extern char *ctf_str_append (char *, const char *);
 768 extern char *ctf_str_append_noerr (char *, const char *);
 769
 770 extern ctf_id_t ctf_type_resolve_unsliced (ctf_dict_t *, ctf_id_t);
 771 extern int ctf_type_kind_unsliced (ctf_dict_t *, ctf_id_t);
 772
 773 _libctf_printflike_ (1, 2)
 774 extern void ctf_dprintf (const char *, ...);
 775 extern void libctf_init_debug (void);
 776
 777 _libctf_printflike_ (4, 5)
 778 extern void ctf_err_warn (ctf_dict_t *, int is_warning, int err,
 779                           const char *, ...);
 780 extern void ctf_err_warn_to_open (ctf_dict_t *);
 781 extern void ctf_assert_fail_internal (ctf_dict_t *, const char *,
 782                                       size_t, const char *);
 783 extern const char *ctf_link_input_name (ctf_dict_t *);
 784
 785 extern ctf_link_sym_t *ctf_elf32_to_link_sym (ctf_dict_t *fp, ctf_link_sym_t *dst,
 786                                               const Elf32_Sym *src, uint32_t symidx);
 787 extern ctf_link_sym_t *ctf_elf64_to_link_sym (ctf_dict_t *fp, ctf_link_sym_t *dst,
 788                                               const Elf64_Sym *src, uint32_t symidx);
 789
 790 /* Variables, all underscore-prepended. */
 791
 792 extern const char _CTF_SECTION[];       /* name of CTF ELF section */
 793 extern const char _CTF_NULLSTR[];       /* empty string */
 794
 795 extern int _libctf_version;     /* library client version */
 796 extern int _libctf_debug;       /* debugging messages enabled */
 797
 798 #include "ctf-inlines.h"
 799
 800 #ifdef  __cplusplus
 801 }
 802 #endif
 803
 804 #endif /* _CTF_IMPL_H */