Automatic date update in version.in
[binutils-gdb.git] / libctf / ctf-impl.h
index 3f4cfac71528a2bd44b7ee759f6fec800b432811..80c47239e262775fc374b294652541c7aa9c255c 100644 (file)
@@ -1,5 +1,5 @@
 /* Implementation header.
-   Copyright (C) 2019-2020 Free Software Foundation, Inc.
+   Copyright (C) 2019-2021 Free Software Foundation, Inc.
 
    This file is part of libctf.
 
 #include <sys/types.h>
 #include <stdlib.h>
 #include <stdarg.h>
+#include <stddef.h>
 #include <stdio.h>
 #include <stdint.h>
+#include <string.h>
 #include <limits.h>
 #include <ctype.h>
 #include <elf.h>
@@ -43,6 +45,15 @@ extern "C"
 {
 #endif
 
+/* Tuning.  */
+
+/* The proportion of symtypetab entries which must be pads before we consider it
+   worthwhile to emit a symtypetab section as an index.  Indexes cost time to
+   look up, but save space all told.  Do not set to 1, since this will cause
+   indexes to be eschewed completely, even in child dicts, at considerable space
+   cost.  */
+#define CTF_INDEX_PAD_THRESHOLD .75
+
 /* Compiler attributes.  */
 
 #if defined (__GNUC__)
@@ -61,6 +72,7 @@ extern "C"
 #define _libctf_unlikely_(x) __builtin_expect ((x), 0)
 #define _libctf_unused_ __attribute__ ((__unused__))
 #define _libctf_malloc_ __attribute__((__malloc__))
+#define _libctf_nonnull_(params) __attribute__((__nonnull__ params))
 
 #else
 
@@ -68,6 +80,7 @@ extern "C"
 #define _libctf_unlikely_(x) (x)
 #define _libctf_unused_
 #define _libctf_malloc_
+#define _libctf_nonnull_(params)
 #define __extension__
 
 #endif
@@ -167,28 +180,13 @@ typedef struct ctf_decl
   int cd_enomem;                    /* Nonzero if OOM during printing.  */
 } ctf_decl_t;
 
-typedef struct ctf_dmdef
-{
-  ctf_list_t dmd_list;         /* List forward/back pointers.  */
-  char *dmd_name;              /* Name of this member.  */
-  ctf_id_t dmd_type;           /* Type of this member (for sou).  */
-  unsigned long dmd_offset;    /* Offset of this member in bits (for sou).  */
-  int dmd_value;               /* Value of this member (for enum).  */
-} ctf_dmdef_t;
-
 typedef struct ctf_dtdef
 {
   ctf_list_t dtd_list;         /* List forward/back pointers.  */
   ctf_id_t dtd_type;           /* Type identifier for this definition.  */
   ctf_type_t dtd_data;         /* Type node, including name.  */
-  union
-  {
-    ctf_list_t dtu_members;    /* struct, union, or enum */
-    ctf_arinfo_t dtu_arr;      /* array */
-    ctf_encoding_t dtu_enc;    /* integer or float */
-    uint32_t *dtu_argv;                /* function */
-    ctf_slice_t dtu_slice;     /* slice */
-  } dtd_u;
+  size_t dtd_vlen_alloc;       /* Total vlen space allocated.  */
+  unsigned char *dtd_vlen;     /* Variable-length data for this type.  */
 } ctf_dtdef_t;
 
 typedef struct ctf_dvdef
@@ -232,6 +230,14 @@ typedef struct ctf_str_atom_ref
   uint32_t *caf_ref;           /* A single ref to this string.  */
 } ctf_str_atom_ref_t;
 
+/* A single linker-provided symbol, during symbol addition, possibly before we
+   have been given external strtab refs.  */
+typedef struct ctf_in_flight_dynsym
+{
+  ctf_list_t cid_list;         /* List forward/back pointers.  */
+  ctf_link_sym_t cid_sym;      /* The linker-known symbol.  */
+} ctf_in_flight_dynsym_t;
+
 /* The structure used as the key in a ctf_link_type_mapping.  The value is a
    type index, not a type ID.  */
 
@@ -328,6 +334,11 @@ typedef struct ctf_dedup
   /* A set (a hash) of hash values of conflicting types.  */
   ctf_dynset_t *cd_conflicting_types;
 
+  /* A hash mapping fp *'s of inputs to their input_nums.  Used only by
+     functions outside the core ctf_dedup / ctf_dedup_emit machinery which do
+     not take an inputs array.  */
+  ctf_dynhash_t *cd_input_nums;
+
   /* Maps type hashes to ctf_id_t's in this dictionary.  Populated only at
      emission time, in the dictionary where emission is taking place.  */
   ctf_dynhash_t *cd_output_emission_hashes;
@@ -348,11 +359,12 @@ typedef struct ctf_dedup
    ctf_dict_t typedef appears in <ctf-api.h> and declares a forward tag.
    (A ctf_file_t typedef also appears there, for historical reasons.)
 
-   NOTE: ctf_serialize() requires that everything inside of ctf_dict either be
-   an immediate value, a pointer to dynamically allocated data *outside* of the
-   ctf_dict itself, or a pointer to statically allocated data.  If you add a
-   pointer to ctf_dict that points to something within the ctf_dict itself, you
-   must make corresponding changes to ctf_serialize().  */
+   NOTE: ctf_serialize requires that everything inside of ctf_dict either be an
+   immediate value, a pointer to dynamically allocated data *outside* of the
+   ctf_dict itself, a pointer to statically allocated data, or specially handled
+   in ctf_serialize.  If you add a pointer to ctf_dict that points to something
+   within the ctf_dict itself, you must make corresponding changes to
+   ctf_serialize.  */
 
 struct ctf_dict
 {
@@ -362,6 +374,9 @@ struct ctf_dict
   ctf_sect_t ctf_data;             /* CTF data from object file.  */
   ctf_sect_t ctf_symtab;           /* Symbol table from object file.  */
   ctf_sect_t ctf_strtab;           /* String table from object file.  */
+  int ctf_symsect_little_endian;    /* Endianness of the ctf_symtab.  */
+  ctf_dynhash_t *ctf_symhash;       /* (partial) hash, symsect name -> idx. */
+  size_t ctf_symhash_latest;       /* Amount of symsect scanned so far.  */
   ctf_dynhash_t *ctf_prov_strtab;   /* Maps provisional-strtab offsets
                                       to names.  */
   ctf_dynhash_t *ctf_syn_ext_strtab; /* Maps ext-strtab offsets to names.  */
@@ -373,18 +388,39 @@ struct ctf_dict
   ctf_names_t ctf_names;           /* Hash table of remaining type names.  */
   ctf_lookup_t ctf_lookups[5];     /* Pointers to nametabs for name lookup.  */
   ctf_strs_t ctf_str[2];           /* Array of string table base and bounds.  */
-  ctf_dynhash_t *ctf_str_atoms;          /* Hash table of ctf_str_atoms_t.  */
+  ctf_dynhash_t *ctf_str_atoms;            /* Hash table of ctf_str_atoms_t.  */
+  ctf_dynset_t *ctf_str_pending_ref; /* Locations awaiting ref addition.  */
   uint64_t ctf_str_num_refs;     /* Number of refs to cts_str_atoms.  */
   uint32_t ctf_str_prov_offset;          /* Latest provisional offset assigned so far.  */
   unsigned char *ctf_base;       /* CTF file pointer.  */
   unsigned char *ctf_dynbase;    /* Freeable CTF file pointer. */
   unsigned char *ctf_buf;        /* Uncompressed CTF data buffer.  */
   size_t ctf_size;               /* Size of CTF header + uncompressed data.  */
-  uint32_t *ctf_sxlate;                  /* Translation table for symtab entries.  */
+  uint32_t *ctf_sxlate;                  /* Translation table for unindexed symtypetab
+                                    entries.  */
   unsigned long ctf_nsyms;       /* Number of entries in symtab xlate table.  */
   uint32_t *ctf_txlate;                  /* Translation table for type IDs.  */
   uint32_t *ctf_ptrtab;                  /* Translation table for pointer-to lookups.  */
   size_t ctf_ptrtab_len;         /* Num types storable in ptrtab currently.  */
+  uint32_t *ctf_pptrtab;         /* Parent types pointed to by child dicts.  */
+  size_t ctf_pptrtab_len;        /* Num types storable in pptrtab currently.  */
+  uint32_t ctf_pptrtab_typemax;          /* Max child type when pptrtab last updated.  */
+  uint32_t *ctf_funcidx_names;   /* Name of each function symbol in symtypetab
+                                    (if indexed).  */
+  uint32_t *ctf_objtidx_names;   /* Likewise, for object symbols.  */
+  size_t ctf_nfuncidx;           /* Number of funcidx entries.  */
+  uint32_t *ctf_funcidx_sxlate;          /* Offsets into funcinfo for a given funcidx.  */
+  uint32_t *ctf_objtidx_sxlate;          /* Likewise, for ctf_objtidx.  */
+  size_t ctf_nobjtidx;           /* Number of objtidx entries.  */
+  ctf_dynhash_t *ctf_objthash;   /* name -> type ID.  */
+  ctf_dynhash_t *ctf_funchash;   /* name -> CTF_K_FUNCTION type ID.  */
+
+  /* The next three are linker-derived state found in ctf_link targets only.  */
+
+  ctf_dynhash_t *ctf_dynsyms;    /* Symbol info from ctf_link_shuffle_syms.  */
+  ctf_link_sym_t **ctf_dynsymidx;  /* Indexes ctf_dynsyms by symidx.  */
+  uint32_t ctf_dynsymmax;        /* Maximum ctf_dynsym index.  */
+  ctf_list_t ctf_in_flight_dynsyms; /* Dynsyms during accumulation.  */
   struct ctf_varent *ctf_vars;   /* Sorted variable->type mapping.  */
   unsigned long ctf_nvars;       /* Number of variables in ctf_vars.  */
   unsigned long ctf_typemax;     /* Maximum valid type ID number.  */
@@ -413,9 +449,8 @@ struct ctf_dict
   ctf_dynhash_t *ctf_link_inputs; /* Inputs to this link.  */
   ctf_dynhash_t *ctf_link_outputs; /* Additional outputs from this link.  */
 
-  /* Map input types to output types: populated in each output dict.
-     Key is a ctf_link_type_key_t: value is a type ID.  Used by
-     nondeduplicating links and ad-hoc ctf_add_type calls only.  */
+  /* Map input types to output types for ctf_add_type.  Key is a
+     ctf_link_type_key_t: value is a type ID.  */
   ctf_dynhash_t *ctf_link_type_mapping;
 
   /* Map input CU names to output CTF dict names: populated in the top-level
@@ -429,7 +464,8 @@ struct ctf_dict
      individual value members are shared with ctf_link_in_cu_mapping.  */
   ctf_dynhash_t *ctf_link_out_cu_mapping;
 
-  /* CTF linker flags.  */
+  /* CTF linker flags.  Set on the parent output dict (the one passed to
+     ctf_link).  Only respected when LCTF_LINKING set in ctf_flags.  */
   int ctf_link_flags;
 
   /* Allow the caller to change the name of link archive members.  */
@@ -466,12 +502,17 @@ struct ctf_archive_internal
   int ctfi_unmap_on_close;
   ctf_dict_t *ctfi_dict;
   struct ctf_archive *ctfi_archive;
+  ctf_dynhash_t *ctfi_dicts;     /* Dicts we have opened and cached.  */
+  ctf_dict_t *ctfi_crossdict_cache; /* Cross-dict caching.  */
+  ctf_dict_t **ctfi_symdicts;    /* Array of index -> ctf_dict_t *.  */
+  ctf_dynhash_t *ctfi_symnamedicts; /* Hash of name -> ctf_dict_t *.  */
   ctf_sect_t ctfi_symsect;
+  int ctfi_symsect_little_endian; /* -1 for unknown / do not set.  */
   ctf_sect_t ctfi_strsect;
   int ctfi_free_symsect;
   int ctfi_free_strsect;
   void *ctfi_data;
-  bfd *ctfi_abfd;                  /* Optional source of section data.  */
+  bfd *ctfi_abfd;                /* Optional source of section data.  */
   void (*ctfi_bfd_close) (struct ctf_archive_internal *);
 };
 
@@ -490,21 +531,26 @@ struct ctf_next
   ctf_id_t ctn_type;
   ssize_t ctn_size;
   ssize_t ctn_increment;
+  const ctf_type_t *ctn_tp;
   uint32_t ctn_n;
+
+  /* Some iterators contain other iterators, in addition to their other
+     state.  */
+  ctf_next_t *ctn_next;
+
   /* We can save space on this side of things by noting that a dictionary is
      either dynamic or not, as a whole, and a given iterator can only iterate
      over one kind of thing at once: so we can overlap the DTD and non-DTD
      members, and the structure, variable and enum members, etc.  */
   union
   {
-    const ctf_member_t *ctn_mp;
-    const ctf_lmember_t *ctn_lmp;
-    const ctf_dmdef_t *ctn_dmd;
+    unsigned char *ctn_vlen;
     const ctf_enum_t *ctn_en;
     const ctf_dvdef_t *ctn_dvd;
     ctf_next_hkv_t *ctn_sorted_hkv;
     void **ctn_hash_slot;
   } u;
+
   /* This union is of various sorts of dict we can iterate over:
      currently dictionaries and archives, dynhashes, and dynsets.  */
   union
@@ -542,9 +588,10 @@ struct ctf_next
 #define LCTF_VBYTES(fp, kind, size, vlen) \
   ((fp)->ctf_dictops->ctfo_get_vbytes(fp, kind, size, vlen))
 
-#define LCTF_CHILD     0x0001  /* CTF dict is a child */
-#define LCTF_RDWR      0x0002  /* CTF dict is writable */
-#define LCTF_DIRTY     0x0004  /* CTF dict has been modified */
+#define LCTF_CHILD     0x0001  /* CTF dict is a child.  */
+#define LCTF_RDWR      0x0002  /* CTF dict is writable.  */
+#define LCTF_DIRTY     0x0004  /* CTF dict has been modified.  */
+#define LCTF_LINKING   0x0008  /* CTF link is underway: respect ctf_link_flags.  */
 
 extern ctf_names_t *ctf_name_table (ctf_dict_t *, int);
 extern const ctf_type_t *ctf_lookup_by_id (ctf_dict_t **, ctf_id_t);
@@ -552,6 +599,10 @@ extern ctf_id_t ctf_lookup_by_rawname (ctf_dict_t *, int, const char *);
 extern ctf_id_t ctf_lookup_by_rawhash (ctf_dict_t *, ctf_names_t *, const char *);
 extern void ctf_set_ctl_hashes (ctf_dict_t *);
 
+extern int ctf_symtab_skippable (ctf_link_sym_t *sym);
+extern int ctf_add_funcobjt_sym (ctf_dict_t *, int is_function,
+                                const char *, ctf_id_t);
+
 extern ctf_dict_t *ctf_get_dict (ctf_dict_t *fp, ctf_id_t type);
 
 typedef unsigned int (*ctf_hash_fun) (const void *ptr);
@@ -566,8 +617,6 @@ extern int ctf_hash_eq_string (const void *, const void *);
 extern int ctf_hash_eq_type_key (const void *, const void *);
 extern int ctf_hash_eq_type_id_key (const void *, const void *);
 
-extern int ctf_dynset_eq_string (const void *, const void *);
-
 typedef void (*ctf_hash_free_fun) (void *);
 
 typedef void (*ctf_hash_iter_f) (void *key, void *value, void *arg);
@@ -598,6 +647,9 @@ extern void ctf_dynhash_iter_remove (ctf_dynhash_t *, ctf_hash_iter_remove_f,
                                     void *);
 extern void *ctf_dynhash_iter_find (ctf_dynhash_t *, ctf_hash_iter_find_f,
                                    void *);
+extern int ctf_dynhash_sort_by_name (const ctf_next_hkv_t *,
+                                    const ctf_next_hkv_t *,
+                                    void * _libctf_unused_);
 extern int ctf_dynhash_next (ctf_dynhash_t *, ctf_next_t **,
                             void **key, void **value);
 extern int ctf_dynhash_next_sorted (ctf_dynhash_t *, ctf_next_t **,
@@ -609,6 +661,7 @@ extern int ctf_dynset_insert (ctf_dynset_t *, void *);
 extern void ctf_dynset_remove (ctf_dynset_t *, const void *);
 extern void ctf_dynset_destroy (ctf_dynset_t *);
 extern void *ctf_dynset_lookup (ctf_dynset_t *, const void *);
+extern size_t ctf_dynset_elements (ctf_dynset_t *);
 extern int ctf_dynset_exists (ctf_dynset_t *, const void *key,
                              const void **orig_key);
 extern int ctf_dynset_next (ctf_dynset_t *, ctf_next_t **, void **key);
@@ -641,11 +694,6 @@ extern ctf_id_t ctf_add_encoded (ctf_dict_t *, uint32_t, const char *,
 extern ctf_id_t ctf_add_reftype (ctf_dict_t *, uint32_t, ctf_id_t,
                                 uint32_t kind);
 
-extern void ctf_add_type_mapping (ctf_dict_t *src_fp, ctf_id_t src_type,
-                                 ctf_dict_t *dst_fp, ctf_id_t dst_type);
-extern ctf_id_t ctf_type_mapping (ctf_dict_t *src_fp, ctf_id_t src_type,
-                                 ctf_dict_t **dst_fp);
-
 extern int ctf_dedup_atoms_init (ctf_dict_t *);
 extern int ctf_dedup (ctf_dict_t *, ctf_dict_t **, uint32_t ninputs,
                      uint32_t *parents, int cu_mapped);
@@ -653,6 +701,8 @@ extern void ctf_dedup_fini (ctf_dict_t *, ctf_dict_t **, uint32_t);
 extern ctf_dict_t **ctf_dedup_emit (ctf_dict_t *, ctf_dict_t **,
                                    uint32_t ninputs, uint32_t *parents,
                                    uint32_t *noutputs, int cu_mapped);
+extern ctf_id_t ctf_dedup_type_mapping (ctf_dict_t *fp, ctf_dict_t *src_fp,
+                                       ctf_id_t src_type);
 
 extern void ctf_decl_init (ctf_decl_t *);
 extern void ctf_decl_fini (ctf_decl_t *);
@@ -670,6 +720,8 @@ extern int ctf_str_create_atoms (ctf_dict_t *);
 extern void ctf_str_free_atoms (ctf_dict_t *);
 extern uint32_t ctf_str_add (ctf_dict_t *, const char *);
 extern uint32_t ctf_str_add_ref (ctf_dict_t *, const char *, uint32_t *ref);
+extern uint32_t ctf_str_add_pending (ctf_dict_t *, const char *, uint32_t *);
+extern int ctf_str_move_pending (ctf_dict_t *, uint32_t *, ptrdiff_t);
 extern int ctf_str_add_external (ctf_dict_t *, const char *, uint32_t offset);
 extern void ctf_str_remove_ref (ctf_dict_t *, const char *, uint32_t *ref);
 extern void ctf_str_rollback (ctf_dict_t *, ctf_snapshot_id_t);
@@ -683,6 +735,7 @@ ctf_new_archive_internal (int is_archive, int unmap_on_close,
                          const ctf_sect_t *strsect, int *errp);
 extern struct ctf_archive *ctf_arc_open_internal (const char *, int *);
 extern void ctf_arc_close_internal (struct ctf_archive *);
+extern const ctf_preamble_t *ctf_arc_bufpreamble (const ctf_sect_t *);
 extern void *ctf_set_open_errno (int *, int);
 extern unsigned long ctf_set_errno (ctf_dict_t *, int);
 
@@ -720,8 +773,10 @@ extern void ctf_assert_fail_internal (ctf_dict_t *, const char *,
                                      size_t, const char *);
 extern const char *ctf_link_input_name (ctf_dict_t *);
 
-extern Elf64_Sym *ctf_sym_to_elf64 (const Elf32_Sym *src, Elf64_Sym *dst);
-extern const char *ctf_lookup_symbol_name (ctf_dict_t *fp, unsigned long symidx);
+extern ctf_link_sym_t *ctf_elf32_to_link_sym (ctf_dict_t *fp, ctf_link_sym_t *dst,
+                                             const Elf32_Sym *src, uint32_t symidx);
+extern ctf_link_sym_t *ctf_elf64_to_link_sym (ctf_dict_t *fp, ctf_link_sym_t *dst,
+                                             const Elf64_Sym *src, uint32_t symidx);
 
 /* Variables, all underscore-prepended. */