gdb/dwarf2read.h

   1 /* DWARF 2 debugging format support for GDB.
   2
   3    Copyright (C) 1994-2019 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef DWARF2READ_H
  21 #define DWARF2READ_H
  22
  23 #include <unordered_map>
  24 #include "dwarf-index-cache.h"
  25 #include "filename-seen-cache.h"
  26 #include "gdb_obstack.h"
  27 #include "common/hash_enum.h"
  28
  29 /* Hold 'maintenance (set|show) dwarf' commands.  */
  30 extern struct cmd_list_element *set_dwarf_cmdlist;
  31 extern struct cmd_list_element *show_dwarf_cmdlist;
  32
  33 typedef struct dwarf2_per_cu_data *dwarf2_per_cu_ptr;
  34 DEF_VEC_P (dwarf2_per_cu_ptr);
  35
  36 /* A descriptor for dwarf sections.
  37
  38    S.ASECTION, SIZE are typically initialized when the objfile is first
  39    scanned.  BUFFER, READIN are filled in later when the section is read.
  40    If the section contained compressed data then SIZE is updated to record
  41    the uncompressed size of the section.
  42
  43    DWP file format V2 introduces a wrinkle that is easiest to handle by
  44    creating the concept of virtual sections contained within a real section.
  45    In DWP V2 the sections of the input DWO files are concatenated together
  46    into one section, but section offsets are kept relative to the original
  47    input section.
  48    If this is a virtual dwp-v2 section, S.CONTAINING_SECTION is a backlink to
  49    the real section this "virtual" section is contained in, and BUFFER,SIZE
  50    describe the virtual section.  */
  51
  52 struct dwarf2_section_info
  53 {
  54   union
  55   {
  56     /* If this is a real section, the bfd section.  */
  57     asection *section;
  58     /* If this is a virtual section, pointer to the containing ("real")
  59        section.  */
  60     struct dwarf2_section_info *containing_section;
  61   } s;
  62   /* Pointer to section data, only valid if readin.  */
  63   const gdb_byte *buffer;
  64   /* The size of the section, real or virtual.  */
  65   bfd_size_type size;
  66   /* If this is a virtual section, the offset in the real section.
  67      Only valid if is_virtual.  */
  68   bfd_size_type virtual_offset;
  69   /* True if we have tried to read this section.  */
  70   char readin;
  71   /* True if this is a virtual section, False otherwise.
  72      This specifies which of s.section and s.containing_section to use.  */
  73   char is_virtual;
  74 };
  75
  76 typedef struct dwarf2_section_info dwarf2_section_info_def;
  77 DEF_VEC_O (dwarf2_section_info_def);
  78
  79 /* Read the contents of the section INFO.
  80    OBJFILE is the main object file, but not necessarily the file where
  81    the section comes from.  E.g., for DWO files the bfd of INFO is the bfd
  82    of the DWO file.
  83    If the section is compressed, uncompress it before returning.  */
  84
  85 void dwarf2_read_section (struct objfile *objfile, dwarf2_section_info *info);
  86
  87 struct tu_stats
  88 {
  89   int nr_uniq_abbrev_tables;
  90   int nr_symtabs;
  91   int nr_symtab_sharers;
  92   int nr_stmt_less_type_units;
  93   int nr_all_type_units_reallocs;
  94 };
  95
  96 struct dwarf2_debug_sections;
  97 struct mapped_index;
  98 struct mapped_debug_names;
  99 struct signatured_type;
 100 struct die_info;
 101 typedef struct die_info *die_info_ptr;
 102
 103 /* Collection of data recorded per objfile.
 104    This hangs off of dwarf2_objfile_data_key.  */
 105
 106 struct dwarf2_per_objfile
 107 {
 108   /* Construct a dwarf2_per_objfile for OBJFILE.  NAMES points to the
 109      dwarf2 section names, or is NULL if the standard ELF names are
 110      used.  */
 111   dwarf2_per_objfile (struct objfile *objfile,
 112                       const dwarf2_debug_sections *names);
 113
 114   ~dwarf2_per_objfile ();
 115
 116   DISABLE_COPY_AND_ASSIGN (dwarf2_per_objfile);
 117
 118   /* Return the CU/TU given its index.
 119
 120      This is intended for loops like:
 121
 122      for (i = 0; i < (dwarf2_per_objfile->n_comp_units
 123                       + dwarf2_per_objfile->n_type_units); ++i)
 124        {
 125          dwarf2_per_cu_data *per_cu = dwarf2_per_objfile->get_cutu (i);
 126
 127          ...;
 128        }
 129   */
 130   dwarf2_per_cu_data *get_cutu (int index);
 131
 132   /* Return the CU given its index.
 133      This differs from get_cutu in that it's for when you know INDEX refers to a
 134      CU.  */
 135   dwarf2_per_cu_data *get_cu (int index);
 136
 137   /* Return the TU given its index.
 138      This differs from get_cutu in that it's for when you know INDEX refers to a
 139      TU.  */
 140   signatured_type *get_tu (int index);
 141
 142   /* Free all cached compilation units.  */
 143   void free_cached_comp_units ();
 144 private:
 145   /* This function is mapped across the sections and remembers the
 146      offset and size of each of the debugging sections we are
 147      interested in.  */
 148   void locate_sections (bfd *abfd, asection *sectp,
 149                         const dwarf2_debug_sections &names);
 150
 151 public:
 152   dwarf2_section_info info {};
 153   dwarf2_section_info abbrev {};
 154   dwarf2_section_info line {};
 155   dwarf2_section_info loc {};
 156   dwarf2_section_info loclists {};
 157   dwarf2_section_info macinfo {};
 158   dwarf2_section_info macro {};
 159   dwarf2_section_info str {};
 160   dwarf2_section_info line_str {};
 161   dwarf2_section_info ranges {};
 162   dwarf2_section_info rnglists {};
 163   dwarf2_section_info addr {};
 164   dwarf2_section_info frame {};
 165   dwarf2_section_info eh_frame {};
 166   dwarf2_section_info gdb_index {};
 167   dwarf2_section_info debug_names {};
 168   dwarf2_section_info debug_aranges {};
 169
 170   VEC (dwarf2_section_info_def) *types = NULL;
 171
 172   /* Back link.  */
 173   struct objfile *objfile = NULL;
 174
 175   /* Table of all the compilation units.  This is used to locate
 176      the target compilation unit of a particular reference.  */
 177   std::vector<dwarf2_per_cu_data *> all_comp_units;
 178
 179   /* The .debug_types-related CUs (TUs).  */
 180   std::vector<signatured_type *> all_type_units;
 181
 182   /* Table of struct type_unit_group objects.
 183      The hash key is the DW_AT_stmt_list value.  */
 184   htab_t type_unit_groups {};
 185
 186   /* A table mapping .debug_types signatures to its signatured_type entry.
 187      This is NULL if the .debug_types section hasn't been read in yet.  */
 188   htab_t signatured_types {};
 189
 190   /* Type unit statistics, to see how well the scaling improvements
 191      are doing.  */
 192   struct tu_stats tu_stats {};
 193
 194   /* A chain of compilation units that are currently read in, so that
 195      they can be freed later.  */
 196   dwarf2_per_cu_data *read_in_chain = NULL;
 197
 198   /* A table mapping DW_AT_dwo_name values to struct dwo_file objects.
 199      This is NULL if the table hasn't been allocated yet.  */
 200   htab_t dwo_files {};
 201
 202   /* True if we've checked for whether there is a DWP file.  */
 203   bool dwp_checked = false;
 204
 205   /* The DWP file if there is one, or NULL.  */
 206   std::unique_ptr<struct dwp_file> dwp_file;
 207
 208   /* The shared '.dwz' file, if one exists.  This is used when the
 209      original data was compressed using 'dwz -m'.  */
 210   std::unique_ptr<struct dwz_file> dwz_file;
 211
 212   /* A flag indicating whether this objfile has a section loaded at a
 213      VMA of 0.  */
 214   bool has_section_at_zero = false;
 215
 216   /* True if we are using the mapped index,
 217      or we are faking it for OBJF_READNOW's sake.  */
 218   bool using_index = false;
 219
 220   /* The mapped index, or NULL if .gdb_index is missing or not being used.  */
 221   std::unique_ptr<mapped_index> index_table;
 222
 223   /* The mapped index, or NULL if .debug_names is missing or not being used.  */
 224   std::unique_ptr<mapped_debug_names> debug_names_table;
 225
 226   /* When using index_table, this keeps track of all quick_file_names entries.
 227      TUs typically share line table entries with a CU, so we maintain a
 228      separate table of all line table entries to support the sharing.
 229      Note that while there can be way more TUs than CUs, we've already
 230      sorted all the TUs into "type unit groups", grouped by their
 231      DW_AT_stmt_list value.  Therefore the only sharing done here is with a
 232      CU and its associated TU group if there is one.  */
 233   htab_t quick_file_names_table {};
 234
 235   /* Set during partial symbol reading, to prevent queueing of full
 236      symbols.  */
 237   bool reading_partial_symbols = false;
 238
 239   /* Table mapping type DIEs to their struct type *.
 240      This is NULL if not allocated yet.
 241      The mapping is done via (CU/TU + DIE offset) -> type.  */
 242   htab_t die_type_hash {};
 243
 244   /* The CUs we recently read.  */
 245   std::vector<dwarf2_per_cu_data *> just_read_cus;
 246
 247   /* Table containing line_header indexed by offset and offset_in_dwz.  */
 248   htab_t line_header_hash {};
 249
 250   /* Table containing all filenames.  This is an optional because the
 251      table is lazily constructed on first access.  */
 252   gdb::optional<filename_seen_cache> filenames_cache;
 253
 254   /* If we loaded the index from an external file, this contains the
 255      resources associated to the open file, memory mapping, etc.  */
 256   std::unique_ptr<index_cache_resource> index_cache_res;
 257
 258   /* Mapping from abstract origin DIE to concrete DIEs that reference it as
 259      DW_AT_abstract_origin.  */
 260   std::unordered_map<sect_offset, std::vector<sect_offset>, \
 261                      gdb::hash_enum<sect_offset>> \
 262     abstract_to_concrete;
 263 };
 264
 265 /* Get the dwarf2_per_objfile associated to OBJFILE.  */
 266
 267 dwarf2_per_objfile *get_dwarf2_per_objfile (struct objfile *objfile);
 268
 269 /* Persistent data held for a compilation unit, even when not
 270    processing it.  We put a pointer to this structure in the
 271    read_symtab_private field of the psymtab.  */
 272
 273 struct dwarf2_per_cu_data
 274 {
 275   /* The start offset and length of this compilation unit.
 276      NOTE: Unlike comp_unit_head.length, this length includes
 277      initial_length_size.
 278      If the DIE refers to a DWO file, this is always of the original die,
 279      not the DWO file.  */
 280   sect_offset sect_off;
 281   unsigned int length;
 282
 283   /* DWARF standard version this data has been read from (such as 4 or 5).  */
 284   short dwarf_version;
 285
 286   /* Flag indicating this compilation unit will be read in before
 287      any of the current compilation units are processed.  */
 288   unsigned int queued : 1;
 289
 290   /* This flag will be set when reading partial DIEs if we need to load
 291      absolutely all DIEs for this compilation unit, instead of just the ones
 292      we think are interesting.  It gets set if we look for a DIE in the
 293      hash table and don't find it.  */
 294   unsigned int load_all_dies : 1;
 295
 296   /* Non-zero if this CU is from .debug_types.
 297      Struct dwarf2_per_cu_data is contained in struct signatured_type iff
 298      this is non-zero.  */
 299   unsigned int is_debug_types : 1;
 300
 301   /* Non-zero if this CU is from the .dwz file.  */
 302   unsigned int is_dwz : 1;
 303
 304   /* Non-zero if reading a TU directly from a DWO file, bypassing the stub.
 305      This flag is only valid if is_debug_types is true.
 306      We can't read a CU directly from a DWO file: There are required
 307      attributes in the stub.  */
 308   unsigned int reading_dwo_directly : 1;
 309
 310   /* Non-zero if the TU has been read.
 311      This is used to assist the "Stay in DWO Optimization" for Fission:
 312      When reading a DWO, it's faster to read TUs from the DWO instead of
 313      fetching them from random other DWOs (due to comdat folding).
 314      If the TU has already been read, the optimization is unnecessary
 315      (and unwise - we don't want to change where gdb thinks the TU lives
 316      "midflight").
 317      This flag is only valid if is_debug_types is true.  */
 318   unsigned int tu_read : 1;
 319
 320   /* The section this CU/TU lives in.
 321      If the DIE refers to a DWO file, this is always the original die,
 322      not the DWO file.  */
 323   struct dwarf2_section_info *section;
 324
 325   /* Set to non-NULL iff this CU is currently loaded.  When it gets freed out
 326      of the CU cache it gets reset to NULL again.  This is left as NULL for
 327      dummy CUs (a CU header, but nothing else).  */
 328   struct dwarf2_cu *cu;
 329
 330   /* The corresponding dwarf2_per_objfile.  */
 331   struct dwarf2_per_objfile *dwarf2_per_objfile;
 332
 333   /* When dwarf2_per_objfile->using_index is true, the 'quick' field
 334      is active.  Otherwise, the 'psymtab' field is active.  */
 335   union
 336   {
 337     /* The partial symbol table associated with this compilation unit,
 338        or NULL for unread partial units.  */
 339     struct partial_symtab *psymtab;
 340
 341     /* Data needed by the "quick" functions.  */
 342     struct dwarf2_per_cu_quick_data *quick;
 343   } v;
 344
 345   /* The CUs we import using DW_TAG_imported_unit.  This is filled in
 346      while reading psymtabs, used to compute the psymtab dependencies,
 347      and then cleared.  Then it is filled in again while reading full
 348      symbols, and only deleted when the objfile is destroyed.
 349
 350      This is also used to work around a difference between the way gold
 351      generates .gdb_index version <=7 and the way gdb does.  Arguably this
 352      is a gold bug.  For symbols coming from TUs, gold records in the index
 353      the CU that includes the TU instead of the TU itself.  This breaks
 354      dw2_lookup_symbol: It assumes that if the index says symbol X lives
 355      in CU/TU Y, then one need only expand Y and a subsequent lookup in Y
 356      will find X.  Alas TUs live in their own symtab, so after expanding CU Y
 357      we need to look in TU Z to find X.  Fortunately, this is akin to
 358      DW_TAG_imported_unit, so we just use the same mechanism: For
 359      .gdb_index version <=7 this also records the TUs that the CU referred
 360      to.  Concurrently with this change gdb was modified to emit version 8
 361      indices so we only pay a price for gold generated indices.
 362      http://sourceware.org/bugzilla/show_bug.cgi?id=15021.  */
 363   VEC (dwarf2_per_cu_ptr) *imported_symtabs;
 364 };
 365
 366 /* Entry in the signatured_types hash table.  */
 367
 368 struct signatured_type
 369 {
 370   /* The "per_cu" object of this type.
 371      This struct is used iff per_cu.is_debug_types.
 372      N.B.: This is the first member so that it's easy to convert pointers
 373      between them.  */
 374   struct dwarf2_per_cu_data per_cu;
 375
 376   /* The type's signature.  */
 377   ULONGEST signature;
 378
 379   /* Offset in the TU of the type's DIE, as read from the TU header.
 380      If this TU is a DWO stub and the definition lives in a DWO file
 381      (specified by DW_AT_GNU_dwo_name), this value is unusable.  */
 382   cu_offset type_offset_in_tu;
 383
 384   /* Offset in the section of the type's DIE.
 385      If the definition lives in a DWO file, this is the offset in the
 386      .debug_types.dwo section.
 387      The value is zero until the actual value is known.
 388      Zero is otherwise not a valid section offset.  */
 389   sect_offset type_offset_in_section;
 390
 391   /* Type units are grouped by their DW_AT_stmt_list entry so that they
 392      can share them.  This points to the containing symtab.  */
 393   struct type_unit_group *type_unit_group;
 394
 395   /* The type.
 396      The first time we encounter this type we fully read it in and install it
 397      in the symbol tables.  Subsequent times we only need the type.  */
 398   struct type *type;
 399
 400   /* Containing DWO unit.
 401      This field is valid iff per_cu.reading_dwo_directly.  */
 402   struct dwo_unit *dwo_unit;
 403 };
 404
 405 typedef struct signatured_type *sig_type_ptr;
 406 DEF_VEC_P (sig_type_ptr);
 407
 408 ULONGEST read_unsigned_leb128 (bfd *, const gdb_byte *, unsigned int *);
 409
 410 /* This represents a '.dwz' file.  */
 411
 412 struct dwz_file
 413 {
 414   dwz_file (gdb_bfd_ref_ptr &&bfd)
 415     : dwz_bfd (std::move (bfd))
 416   {
 417   }
 418
 419   const char *filename () const
 420   {
 421     return bfd_get_filename (this->dwz_bfd);
 422   }
 423
 424   /* A dwz file can only contain a few sections.  */
 425   struct dwarf2_section_info abbrev {};
 426   struct dwarf2_section_info info {};
 427   struct dwarf2_section_info str {};
 428   struct dwarf2_section_info line {};
 429   struct dwarf2_section_info macro {};
 430   struct dwarf2_section_info gdb_index {};
 431   struct dwarf2_section_info debug_names {};
 432
 433   /* The dwz's BFD.  */
 434   gdb_bfd_ref_ptr dwz_bfd;
 435
 436   /* If we loaded the index from an external file, this contains the
 437      resources associated to the open file, memory mapping, etc.  */
 438   std::unique_ptr<index_cache_resource> index_cache_res;
 439 };
 440
 441 /* Open the separate '.dwz' debug file, if needed.  Return NULL if
 442    there is no .gnu_debugaltlink section in the file.  Error if there
 443    is such a section but the file cannot be found.  */
 444
 445 extern struct dwz_file *dwarf2_get_dwz_file
 446     (struct dwarf2_per_objfile *dwarf2_per_objfile);
 447
 448 #endif /* DWARF2READ_H */