/* DWARF 2 debugging format support for GDB. Copyright (C) 1994-2021 Free Software Foundation, Inc. This file is part of GDB. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #ifndef DWARF2READ_H #define DWARF2READ_H #include #include #include "dwarf2/comp-unit.h" #include "dwarf2/index-cache.h" #include "dwarf2/section.h" #include "filename-seen-cache.h" #include "gdb_obstack.h" #include "gdbsupport/hash_enum.h" #include "gdbsupport/function-view.h" #include "psympriv.h" /* Hold 'maintenance (set|show) dwarf' commands. */ extern struct cmd_list_element *set_dwarf_cmdlist; extern struct cmd_list_element *show_dwarf_cmdlist; struct tu_stats { int nr_uniq_abbrev_tables; int nr_symtabs; int nr_symtab_sharers; int nr_stmt_less_type_units; int nr_all_type_units_reallocs; }; struct dwarf2_cu; struct dwarf2_debug_sections; struct dwarf2_per_cu_data; struct mapped_index; struct mapped_debug_names; struct signatured_type; struct type_unit_group; /* One item on the queue of compilation units to read in full symbols for. */ struct dwarf2_queue_item { dwarf2_queue_item (dwarf2_per_cu_data *cu, dwarf2_per_objfile *per_objfile, enum language lang) : per_cu (cu), per_objfile (per_objfile), pretend_language (lang) { } ~dwarf2_queue_item (); DISABLE_COPY_AND_ASSIGN (dwarf2_queue_item); dwarf2_per_cu_data *per_cu; dwarf2_per_objfile *per_objfile; enum language pretend_language; }; /* Some DWARF data can be shared across objfiles who share the same BFD, this data is stored in this object. Two dwarf2_per_objfile objects representing objfiles sharing the same BFD will point to the same instance of dwarf2_per_bfd, unless the BFD requires relocation. */ struct dwarf2_per_bfd { /* Construct a dwarf2_per_bfd for OBFD. NAMES points to the dwarf2 section names, or is NULL if the standard ELF names are used. CAN_COPY is true for formats where symbol interposition is possible and so symbol values must follow copy relocation rules. */ dwarf2_per_bfd (bfd *obfd, const dwarf2_debug_sections *names, bool can_copy); ~dwarf2_per_bfd (); DISABLE_COPY_AND_ASSIGN (dwarf2_per_bfd); /* Return the CU/TU given its index. This is intended for loops like: for (i = 0; i < (dwarf2_per_bfd->n_comp_units + dwarf2_per_bfd->n_type_units); ++i) { dwarf2_per_cu_data *per_cu = dwarf2_per_bfd->get_cutu (i); ...; } */ dwarf2_per_cu_data *get_cutu (int index); /* Return the CU given its index. This differs from get_cutu in that it's for when you know INDEX refers to a CU. */ dwarf2_per_cu_data *get_cu (int index); /* Return the TU given its index. This differs from get_cutu in that it's for when you know INDEX refers to a TU. */ signatured_type *get_tu (int index); /* A convenience function to allocate a dwarf2_per_cu_data. The returned object has its "index" field set properly. The object is allocated on the dwarf2_per_bfd obstack. */ dwarf2_per_cu_data *allocate_per_cu (); /* A convenience function to allocate a signatured_type. The returned object has its "index" field set properly. The object is allocated on the dwarf2_per_bfd obstack. */ signatured_type *allocate_signatured_type (); /* Return the number of partial symtabs allocated with allocate_per_cu and allocate_signatured_type so far. */ int num_psymtabs () const { return m_num_psymtabs; } private: /* This function is mapped across the sections and remembers the offset and size of each of the debugging sections we are interested in. */ void locate_sections (bfd *abfd, asection *sectp, const dwarf2_debug_sections &names); public: /* The corresponding BFD. */ bfd *obfd; /* Objects that can be shared across objfiles are stored in this obstack or on the psymtab obstack, while objects that are objfile-specific are stored on the objfile obstack. */ auto_obstack obstack; dwarf2_section_info info {}; dwarf2_section_info abbrev {}; dwarf2_section_info line {}; dwarf2_section_info loc {}; dwarf2_section_info loclists {}; dwarf2_section_info macinfo {}; dwarf2_section_info macro {}; dwarf2_section_info str {}; dwarf2_section_info str_offsets {}; dwarf2_section_info line_str {}; dwarf2_section_info ranges {}; dwarf2_section_info rnglists {}; dwarf2_section_info addr {}; dwarf2_section_info frame {}; dwarf2_section_info eh_frame {}; dwarf2_section_info gdb_index {}; dwarf2_section_info debug_names {}; dwarf2_section_info debug_aranges {}; std::vector types; /* Table of all the compilation units. This is used to locate the target compilation unit of a particular reference. */ std::vector all_comp_units; /* The .debug_types-related CUs (TUs). */ std::vector all_type_units; /* Table of struct type_unit_group objects. The hash key is the DW_AT_stmt_list value. */ htab_up type_unit_groups; /* A table mapping .debug_types signatures to its signatured_type entry. This is NULL if the .debug_types section hasn't been read in yet. */ htab_up signatured_types; /* Type unit statistics, to see how well the scaling improvements are doing. */ struct tu_stats tu_stats {}; /* A table mapping DW_AT_dwo_name values to struct dwo_file objects. This is NULL if the table hasn't been allocated yet. */ htab_up dwo_files; /* True if we've checked for whether there is a DWP file. */ bool dwp_checked = false; /* The DWP file if there is one, or NULL. */ std::unique_ptr dwp_file; /* The shared '.dwz' file, if one exists. This is used when the original data was compressed using 'dwz -m'. */ std::unique_ptr dwz_file; /* Whether copy relocations are supported by this object format. */ bool can_copy; /* A flag indicating whether this objfile has a section loaded at a VMA of 0. */ bool has_section_at_zero = false; /* True if we are using the mapped index, or we are faking it for OBJF_READNOW's sake. */ bool using_index = false; /* The mapped index, or NULL if .gdb_index is missing or not being used. */ std::unique_ptr index_table; /* The mapped index, or NULL if .debug_names is missing or not being used. */ std::unique_ptr debug_names_table; /* When using index_table, this keeps track of all quick_file_names entries. TUs typically share line table entries with a CU, so we maintain a separate table of all line table entries to support the sharing. Note that while there can be way more TUs than CUs, we've already sorted all the TUs into "type unit groups", grouped by their DW_AT_stmt_list value. Therefore the only sharing done here is with a CU and its associated TU group if there is one. */ htab_up quick_file_names_table; /* Set during partial symbol reading, to prevent queueing of full symbols. */ bool reading_partial_symbols = false; /* The CUs we recently read. */ std::vector just_read_cus; /* Table containing all filenames. This is an optional because the table is lazily constructed on first access. */ gdb::optional filenames_cache; /* If we loaded the index from an external file, this contains the resources associated to the open file, memory mapping, etc. */ std::unique_ptr index_cache_res; /* Mapping from abstract origin DIE to concrete DIEs that reference it as DW_AT_abstract_origin. */ std::unordered_map, gdb::hash_enum> abstract_to_concrete; /* CUs that are queued to be read. */ gdb::optional> queue; /* We keep a separate reference to the partial symtabs, in case we are sharing them between objfiles. This is only set after partial symbols have been read the first time. */ std::shared_ptr partial_symtabs; private: /* The total number of per_cu and signatured_type objects that have been created so far for this reader. */ size_t m_num_psymtabs = 0; }; /* This is the per-objfile data associated with a type_unit_group. */ struct type_unit_group_unshareable { /* The compunit symtab. Type units in a group needn't all be defined in the same source file, so we create an essentially anonymous symtab as the compunit symtab. */ struct compunit_symtab *compunit_symtab = nullptr; /* The number of symtabs from the line header. The value here must match line_header.num_file_names. */ unsigned int num_symtabs = 0; /* The symbol tables for this TU (obtained from the files listed in DW_AT_stmt_list). WARNING: The order of entries here must match the order of entries in the line header. After the first TU using this type_unit_group, the line header for the subsequent TUs is recreated from this. This is done because we need to use the same symtabs for each TU using the same DW_AT_stmt_list value. Also note that symtabs may be repeated here, there's no guarantee the line header doesn't have duplicate entries. */ struct symtab **symtabs = nullptr; }; /* Collection of data recorded per objfile. This hangs off of dwarf2_objfile_data_key. Some DWARF data cannot (currently) be shared across objfiles. Such data is stored in this object. */ struct dwarf2_per_objfile { dwarf2_per_objfile (struct objfile *objfile, dwarf2_per_bfd *per_bfd) : objfile (objfile), per_bfd (per_bfd) {} ~dwarf2_per_objfile (); /* Return pointer to string at .debug_line_str offset as read from BUF. BUF is assumed to be in a compilation unit described by CU_HEADER. Return *BYTES_READ_PTR count of bytes read from BUF. */ const char *read_line_string (const gdb_byte *buf, const struct comp_unit_head *cu_header, unsigned int *bytes_read_ptr); /* Resize the M_SYMTABS vector to the needed size (the number of partial symtabs allocated by the per-bfd). */ void resize_symtabs () { /* The symtabs vector should only grow, not shrink. */ gdb_assert (per_bfd->num_psymtabs () >= m_symtabs.size ()); m_symtabs.resize (per_bfd->num_psymtabs ()); } /* Return true if the symtab corresponding to PER_CU has been set, false otherwise. */ bool symtab_set_p (const dwarf2_per_cu_data *per_cu) const; /* Return the compunit_symtab associated to PER_CU, if it has been created. */ compunit_symtab *get_symtab (const dwarf2_per_cu_data *per_cu) const; /* Set the compunit_symtab associated to PER_CU. */ void set_symtab (const dwarf2_per_cu_data *per_cu, compunit_symtab *symtab); /* Get the type_unit_group_unshareable corresponding to TU_GROUP. If one does not exist, create it. */ type_unit_group_unshareable *get_type_unit_group_unshareable (type_unit_group *tu_group); struct type *get_type_for_signatured_type (signatured_type *sig_type) const; void set_type_for_signatured_type (signatured_type *sig_type, struct type *type); /* Find an integer type SIZE_IN_BYTES bytes in size and return it. UNSIGNED_P controls if the integer is unsigned or not. */ struct type *int_type (int size_in_bytes, bool unsigned_p) const; /* Get the dwarf2_cu matching PER_CU for this objfile. */ dwarf2_cu *get_cu (dwarf2_per_cu_data *per_cu); /* Set the dwarf2_cu matching PER_CU for this objfile. */ void set_cu (dwarf2_per_cu_data *per_cu, dwarf2_cu *cu); /* Remove/free the dwarf2_cu matching PER_CU for this objfile. */ void remove_cu (dwarf2_per_cu_data *per_cu); /* Free all cached compilation units. */ void remove_all_cus (); /* Increase the age counter on each CU compilation unit and free any that are too old. */ void age_comp_units (); /* Back link. */ struct objfile *objfile; /* Pointer to the data that is (possibly) shared between this objfile and other objfiles backed by the same BFD. */ struct dwarf2_per_bfd *per_bfd; /* Table mapping type DIEs to their struct type *. This is nullptr if not allocated yet. The mapping is done via (CU/TU + DIE offset) -> type. */ htab_up die_type_hash; /* Table containing line_header indexed by offset and offset_in_dwz. */ htab_up line_header_hash; private: /* Hold the corresponding compunit_symtab for each CU or TU. This is indexed by dwarf2_per_cu_data::index. A NULL value means that the CU/TU has not been expanded yet. */ std::vector m_symtabs; /* Map from a type unit group to the corresponding unshared structure. */ typedef std::unique_ptr type_unit_group_unshareable_up; std::unordered_map m_type_units; /* Map from signatured types to the corresponding struct type. */ std::unordered_map m_type_map; /* Map from the objfile-independent dwarf2_per_cu_data instances to the corresponding objfile-dependent dwarf2_cu instances. */ std::unordered_map m_dwarf2_cus; }; /* Get the dwarf2_per_objfile associated to OBJFILE. */ dwarf2_per_objfile *get_dwarf2_per_objfile (struct objfile *objfile); /* A partial symtab specialized for DWARF. */ struct dwarf2_psymtab : public partial_symtab { dwarf2_psymtab (const char *filename, struct objfile *objfile, dwarf2_per_cu_data *per_cu) : partial_symtab (filename, objfile, 0), per_cu_data (per_cu) { } void read_symtab (struct objfile *) override; void expand_psymtab (struct objfile *) override; bool readin_p (struct objfile *) const override; compunit_symtab *get_compunit_symtab (struct objfile *) const override; struct dwarf2_per_cu_data *per_cu_data; }; /* Persistent data held for a compilation unit, even when not processing it. We put a pointer to this structure in the psymtab. */ struct dwarf2_per_cu_data { /* The start offset and length of this compilation unit. NOTE: Unlike comp_unit_head.length, this length includes initial_length_size. If the DIE refers to a DWO file, this is always of the original die, not the DWO file. */ sect_offset sect_off; unsigned int length; /* DWARF standard version this data has been read from (such as 4 or 5). */ short dwarf_version; /* Flag indicating this compilation unit will be read in before any of the current compilation units are processed. */ unsigned int queued : 1; /* This flag will be set when reading partial DIEs if we need to load absolutely all DIEs for this compilation unit, instead of just the ones we think are interesting. It gets set if we look for a DIE in the hash table and don't find it. */ unsigned int load_all_dies : 1; /* Non-zero if this CU is from .debug_types. Struct dwarf2_per_cu_data is contained in struct signatured_type iff this is non-zero. */ unsigned int is_debug_types : 1; /* Non-zero if this CU is from the .dwz file. */ unsigned int is_dwz : 1; /* Non-zero if reading a TU directly from a DWO file, bypassing the stub. This flag is only valid if is_debug_types is true. We can't read a CU directly from a DWO file: There are required attributes in the stub. */ unsigned int reading_dwo_directly : 1; /* Non-zero if the TU has been read. This is used to assist the "Stay in DWO Optimization" for Fission: When reading a DWO, it's faster to read TUs from the DWO instead of fetching them from random other DWOs (due to comdat folding). If the TU has already been read, the optimization is unnecessary (and unwise - we don't want to change where gdb thinks the TU lives "midflight"). This flag is only valid if is_debug_types is true. */ unsigned int tu_read : 1; /* Our index in the unshared "symtabs" vector. */ unsigned index; /* The section this CU/TU lives in. If the DIE refers to a DWO file, this is always the original die, not the DWO file. */ struct dwarf2_section_info *section; /* The unit type of this CU. */ enum dwarf_unit_type unit_type; /* The language of this CU. */ enum language lang; /* Backlink to the owner of this. */ dwarf2_per_bfd *per_bfd; /* DWARF header of this CU. Note that dwarf2_cu reads its own version of the header, which may differ from this one, since it may pass rcuh_kind::TYPE to read_comp_unit_head, whereas for dwarf2_per_cu_data we always pass rcuh_kind::COMPILE. Don't access this field directly, use the get_header method instead. It should be private, but we can't make it private at the moment. */ mutable comp_unit_head m_header; /* True if HEADER has been read in. Don't access this field directly. It should be private, but we can't make it private at the moment. */ mutable bool m_header_read_in; /* When dwarf2_per_bfd::using_index is true, the 'quick' field is active. Otherwise, the 'psymtab' field is active. */ union { /* The partial symbol table associated with this compilation unit, or NULL for unread partial units. */ dwarf2_psymtab *psymtab; /* Data needed by the "quick" functions. */ struct dwarf2_per_cu_quick_data *quick; } v; /* The CUs we import using DW_TAG_imported_unit. This is filled in while reading psymtabs, used to compute the psymtab dependencies, and then cleared. Then it is filled in again while reading full symbols, and only deleted when the objfile is destroyed. This is also used to work around a difference between the way gold generates .gdb_index version <=7 and the way gdb does. Arguably this is a gold bug. For symbols coming from TUs, gold records in the index the CU that includes the TU instead of the TU itself. This breaks dw2_lookup_symbol: It assumes that if the index says symbol X lives in CU/TU Y, then one need only expand Y and a subsequent lookup in Y will find X. Alas TUs live in their own symtab, so after expanding CU Y we need to look in TU Z to find X. Fortunately, this is akin to DW_TAG_imported_unit, so we just use the same mechanism: For .gdb_index version <=7 this also records the TUs that the CU referred to. Concurrently with this change gdb was modified to emit version 8 indices so we only pay a price for gold generated indices. http://sourceware.org/bugzilla/show_bug.cgi?id=15021. This currently needs to be a public member due to how dwarf2_per_cu_data is allocated and used. Ideally in future things could be refactored to make this private. Until then please try to avoid direct access to this member, and instead use the helper functions above. */ std::vector *imported_symtabs; /* Return true of IMPORTED_SYMTABS is empty or not yet allocated. */ bool imported_symtabs_empty () const { return (imported_symtabs == nullptr || imported_symtabs->empty ()); } /* Push P to the back of IMPORTED_SYMTABS, allocated IMPORTED_SYMTABS first if required. */ void imported_symtabs_push (dwarf2_per_cu_data *p) { if (imported_symtabs == nullptr) imported_symtabs = new std::vector ; imported_symtabs->push_back (p); } /* Return the size of IMPORTED_SYMTABS if it is allocated, otherwise return 0. */ size_t imported_symtabs_size () const { if (imported_symtabs == nullptr) return 0; return imported_symtabs->size (); } /* Delete IMPORTED_SYMTABS and set the pointer back to nullptr. */ void imported_symtabs_free () { delete imported_symtabs; imported_symtabs = nullptr; } /* Get the header of this per_cu, reading it if necessary. */ const comp_unit_head *get_header () const; /* Return the address size given in the compilation unit header for this CU. */ int addr_size () const; /* Return the offset size given in the compilation unit header for this CU. */ int offset_size () const; /* Return the DW_FORM_ref_addr size given in the compilation unit header for this CU. */ int ref_addr_size () const; /* Return DWARF version number of this CU. */ short version () const { return dwarf_version; } /* A type unit group has a per_cu object that is recognized by having no section. */ bool type_unit_group_p () const { return section == nullptr; } }; /* Entry in the signatured_types hash table. */ struct signatured_type { /* The "per_cu" object of this type. This struct is used iff per_cu.is_debug_types. N.B.: This is the first member so that it's easy to convert pointers between them. */ struct dwarf2_per_cu_data per_cu; /* The type's signature. */ ULONGEST signature; /* Offset in the TU of the type's DIE, as read from the TU header. If this TU is a DWO stub and the definition lives in a DWO file (specified by DW_AT_GNU_dwo_name), this value is unusable. */ cu_offset type_offset_in_tu; /* Offset in the section of the type's DIE. If the definition lives in a DWO file, this is the offset in the .debug_types.dwo section. The value is zero until the actual value is known. Zero is otherwise not a valid section offset. */ sect_offset type_offset_in_section; /* Type units are grouped by their DW_AT_stmt_list entry so that they can share them. This points to the containing symtab. */ struct type_unit_group *type_unit_group; /* Containing DWO unit. This field is valid iff per_cu.reading_dwo_directly. */ struct dwo_unit *dwo_unit; }; /* Return the type of the DIE at DIE_OFFSET in the CU named by PER_CU. */ struct type *dwarf2_get_die_type (cu_offset die_offset, dwarf2_per_cu_data *per_cu, dwarf2_per_objfile *per_objfile); /* Given an index in .debug_addr, fetch the value. NOTE: This can be called during dwarf expression evaluation, long after the debug information has been read, and thus per_cu->cu may no longer exist. */ CORE_ADDR dwarf2_read_addr_index (dwarf2_per_cu_data *per_cu, dwarf2_per_objfile *per_objfile, unsigned int addr_index); /* Return DWARF block referenced by DW_AT_location of DIE at SECT_OFF at PER_CU. Returned value is intended for DW_OP_call*. Returned dwarf2_locexpr_baton->data has lifetime of PER_CU->DWARF2_PER_OBJFILE->OBJFILE. */ struct dwarf2_locexpr_baton dwarf2_fetch_die_loc_sect_off (sect_offset sect_off, dwarf2_per_cu_data *per_cu, dwarf2_per_objfile *per_objfile, gdb::function_view get_frame_pc, bool resolve_abstract_p = false); /* Like dwarf2_fetch_die_loc_sect_off, but take a CU offset. */ struct dwarf2_locexpr_baton dwarf2_fetch_die_loc_cu_off (cu_offset offset_in_cu, dwarf2_per_cu_data *per_cu, dwarf2_per_objfile *per_objfile, gdb::function_view get_frame_pc); /* If the DIE at SECT_OFF in PER_CU has a DW_AT_const_value, return a pointer to the constant bytes and set LEN to the length of the data. If memory is needed, allocate it on OBSTACK. If the DIE does not have a DW_AT_const_value, return NULL. */ extern const gdb_byte *dwarf2_fetch_constant_bytes (sect_offset sect_off, dwarf2_per_cu_data *per_cu, dwarf2_per_objfile *per_objfile, obstack *obstack, LONGEST *len); /* Return the type of the die at SECT_OFF in PER_CU. Return NULL if no valid type for this die is found. */ struct type *dwarf2_fetch_die_type_sect_off (sect_offset sect_off, dwarf2_per_cu_data *per_cu, dwarf2_per_objfile *per_objfile); /* When non-zero, dump line number entries as they are read in. */ extern unsigned int dwarf_line_debug; #endif /* DWARF2READ_H */