libctf/ctf-impl.h

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