1 /* DWARF 2 debugging format support for GDB.
3 Copyright (C) 1994-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
24 #include <unordered_map>
25 #include "dwarf2/index-cache.h"
26 #include "dwarf2/section.h"
27 #include "filename-seen-cache.h"
28 #include "gdb_obstack.h"
29 #include "gdbsupport/hash_enum.h"
32 /* Hold 'maintenance (set|show) dwarf' commands. */
33 extern struct cmd_list_element
*set_dwarf_cmdlist
;
34 extern struct cmd_list_element
*show_dwarf_cmdlist
;
38 int nr_uniq_abbrev_tables
;
40 int nr_symtab_sharers
;
41 int nr_stmt_less_type_units
;
42 int nr_all_type_units_reallocs
;
45 struct dwarf2_debug_sections
;
46 struct dwarf2_per_cu_data
;
48 struct mapped_debug_names
;
49 struct signatured_type
;
51 /* One item on the queue of compilation units to read in full symbols
53 struct dwarf2_queue_item
55 dwarf2_queue_item (dwarf2_per_cu_data
*cu
, enum language lang
)
57 pretend_language (lang
)
61 ~dwarf2_queue_item ();
63 DISABLE_COPY_AND_ASSIGN (dwarf2_queue_item
);
65 struct dwarf2_per_cu_data
*per_cu
;
66 enum language pretend_language
;
69 /* Some DWARF data can be shared across objfiles who share the same BFD,
70 this data is stored in this object.
72 Two dwarf2_per_objfile objects representing objfiles sharing the same BFD
73 will point to the same instance of dwarf2_per_bfd, unless the BFD requires
78 /* Construct a dwarf2_per_bfd for OBFD. NAMES points to the
79 dwarf2 section names, or is NULL if the standard ELF names are
80 used. CAN_COPY is true for formats where symbol
81 interposition is possible and so symbol values must follow copy
83 dwarf2_per_bfd (bfd
*obfd
, const dwarf2_debug_sections
*names
, bool can_copy
);
87 DISABLE_COPY_AND_ASSIGN (dwarf2_per_bfd
);
89 /* Return the CU/TU given its index.
91 This is intended for loops like:
93 for (i = 0; i < (dwarf2_per_bfd->n_comp_units
94 + dwarf2_per_bfd->n_type_units); ++i)
96 dwarf2_per_cu_data *per_cu = dwarf2_per_bfd->get_cutu (i);
101 dwarf2_per_cu_data
*get_cutu (int index
);
103 /* Return the CU given its index.
104 This differs from get_cutu in that it's for when you know INDEX refers to a
106 dwarf2_per_cu_data
*get_cu (int index
);
108 /* Return the TU given its index.
109 This differs from get_cutu in that it's for when you know INDEX refers to a
111 signatured_type
*get_tu (int index
);
113 /* Free all cached compilation units. */
114 void free_cached_comp_units ();
116 /* A convenience function to allocate a dwarf2_per_cu_data. The
117 returned object has its "index" field set properly. The object
118 is allocated on the dwarf2_per_bfd obstack. */
119 dwarf2_per_cu_data
*allocate_per_cu ();
121 /* A convenience function to allocate a signatured_type. The
122 returned object has its "index" field set properly. The object
123 is allocated on the dwarf2_per_bfd obstack. */
124 signatured_type
*allocate_signatured_type ();
126 /* Return the number of partial symtabs allocated with allocate_per_cu
127 and allocate_signatured_type so far. */
128 int num_psymtabs () const
129 { return m_num_psymtabs
; }
132 /* This function is mapped across the sections and remembers the
133 offset and size of each of the debugging sections we are
135 void locate_sections (bfd
*abfd
, asection
*sectp
,
136 const dwarf2_debug_sections
&names
);
139 /* The corresponding BFD. */
142 /* Objects that can be shared across objfiles are stored in this
143 obstack or on the psymtab obstack, while objects that are
144 objfile-specific are stored on the objfile obstack. */
145 auto_obstack obstack
;
147 dwarf2_section_info info
{};
148 dwarf2_section_info abbrev
{};
149 dwarf2_section_info line
{};
150 dwarf2_section_info loc
{};
151 dwarf2_section_info loclists
{};
152 dwarf2_section_info macinfo
{};
153 dwarf2_section_info macro
{};
154 dwarf2_section_info str
{};
155 dwarf2_section_info str_offsets
{};
156 dwarf2_section_info line_str
{};
157 dwarf2_section_info ranges
{};
158 dwarf2_section_info rnglists
{};
159 dwarf2_section_info addr
{};
160 dwarf2_section_info frame
{};
161 dwarf2_section_info eh_frame
{};
162 dwarf2_section_info gdb_index
{};
163 dwarf2_section_info debug_names
{};
164 dwarf2_section_info debug_aranges
{};
166 std::vector
<dwarf2_section_info
> types
;
168 /* Table of all the compilation units. This is used to locate
169 the target compilation unit of a particular reference. */
170 std::vector
<dwarf2_per_cu_data
*> all_comp_units
;
172 /* The .debug_types-related CUs (TUs). */
173 std::vector
<signatured_type
*> all_type_units
;
175 /* Table of struct type_unit_group objects.
176 The hash key is the DW_AT_stmt_list value. */
177 htab_up type_unit_groups
;
179 /* A table mapping .debug_types signatures to its signatured_type entry.
180 This is NULL if the .debug_types section hasn't been read in yet. */
181 htab_up signatured_types
;
183 /* Type unit statistics, to see how well the scaling improvements
185 struct tu_stats tu_stats
{};
187 /* A chain of compilation units that are currently read in, so that
188 they can be freed later. */
189 dwarf2_per_cu_data
*read_in_chain
= NULL
;
191 /* A table mapping DW_AT_dwo_name values to struct dwo_file objects.
192 This is NULL if the table hasn't been allocated yet. */
195 /* True if we've checked for whether there is a DWP file. */
196 bool dwp_checked
= false;
198 /* The DWP file if there is one, or NULL. */
199 std::unique_ptr
<struct dwp_file
> dwp_file
;
201 /* The shared '.dwz' file, if one exists. This is used when the
202 original data was compressed using 'dwz -m'. */
203 std::unique_ptr
<struct dwz_file
> dwz_file
;
205 /* Whether copy relocations are supported by this object format. */
208 /* A flag indicating whether this objfile has a section loaded at a
210 bool has_section_at_zero
= false;
212 /* True if we are using the mapped index,
213 or we are faking it for OBJF_READNOW's sake. */
214 bool using_index
= false;
216 /* The mapped index, or NULL if .gdb_index is missing or not being used. */
217 std::unique_ptr
<mapped_index
> index_table
;
219 /* The mapped index, or NULL if .debug_names is missing or not being used. */
220 std::unique_ptr
<mapped_debug_names
> debug_names_table
;
222 /* When using index_table, this keeps track of all quick_file_names entries.
223 TUs typically share line table entries with a CU, so we maintain a
224 separate table of all line table entries to support the sharing.
225 Note that while there can be way more TUs than CUs, we've already
226 sorted all the TUs into "type unit groups", grouped by their
227 DW_AT_stmt_list value. Therefore the only sharing done here is with a
228 CU and its associated TU group if there is one. */
229 htab_up quick_file_names_table
;
231 /* Set during partial symbol reading, to prevent queueing of full
233 bool reading_partial_symbols
= false;
235 /* The CUs we recently read. */
236 std::vector
<dwarf2_per_cu_data
*> just_read_cus
;
238 /* Table containing line_header indexed by offset and offset_in_dwz. */
239 htab_up line_header_hash
;
241 /* Table containing all filenames. This is an optional because the
242 table is lazily constructed on first access. */
243 gdb::optional
<filename_seen_cache
> filenames_cache
;
245 /* If we loaded the index from an external file, this contains the
246 resources associated to the open file, memory mapping, etc. */
247 std::unique_ptr
<index_cache_resource
> index_cache_res
;
249 /* Mapping from abstract origin DIE to concrete DIEs that reference it as
250 DW_AT_abstract_origin. */
251 std::unordered_map
<sect_offset
, std::vector
<sect_offset
>,
252 gdb::hash_enum
<sect_offset
>>
253 abstract_to_concrete
;
255 /* CUs that are queued to be read. */
256 std::queue
<dwarf2_queue_item
> queue
;
260 /* The total number of per_cu and signatured_type objects that have
261 been created so far for this reader. */
262 size_t m_num_psymtabs
= 0;
265 /* Collection of data recorded per objfile.
266 This hangs off of dwarf2_objfile_data_key.
268 Some DWARF data cannot (currently) be shared across objfiles. Such
269 data is stored in this object. */
271 struct dwarf2_per_objfile
273 dwarf2_per_objfile (struct objfile
*objfile
, dwarf2_per_bfd
*per_bfd
)
274 : objfile (objfile
), per_bfd (per_bfd
)
277 /* Return pointer to string at .debug_line_str offset as read from BUF.
278 BUF is assumed to be in a compilation unit described by CU_HEADER.
279 Return *BYTES_READ_PTR count of bytes read from BUF. */
280 const char *read_line_string (const gdb_byte
*buf
,
281 const struct comp_unit_head
*cu_header
,
282 unsigned int *bytes_read_ptr
);
284 /* Resize the M_SYMTABS vector to the needed size (the number of partial
285 symtabs allocated by the per-bfd). */
286 void resize_symtabs ()
288 /* The symtabs vector should only grow, not shrink. */
289 gdb_assert (per_bfd
->num_psymtabs () >= m_symtabs
.size ());
291 m_symtabs
.resize (per_bfd
->num_psymtabs ());
294 /* Return true if the symtab corresponding to PER_CU has been set,
296 bool symtab_set_p (const dwarf2_per_cu_data
*per_cu
) const;
298 /* Return the compunit_symtab associated to PER_CU, if it has been created. */
299 compunit_symtab
*get_symtab (const dwarf2_per_cu_data
*per_cu
) const;
301 /* Set the compunit_symtab associated to PER_CU. */
302 void set_symtab (const dwarf2_per_cu_data
*per_cu
, compunit_symtab
*symtab
);
304 /* Find an integer type SIZE_IN_BYTES bytes in size and return it.
305 UNSIGNED_P controls if the integer is unsigned or not. */
306 struct type
*int_type (int size_in_bytes
, bool unsigned_p
) const;
309 struct objfile
*objfile
;
311 /* Pointer to the data that is (possibly) shared between this objfile and
312 other objfiles backed by the same BFD. */
313 struct dwarf2_per_bfd
*per_bfd
;
315 /* Table mapping type DIEs to their struct type *.
316 This is nullptr if not allocated yet.
317 The mapping is done via (CU/TU + DIE offset) -> type. */
318 htab_up die_type_hash
;
321 /* Hold the corresponding compunit_symtab for each CU or TU. This
322 is indexed by dwarf2_per_cu_data::index. A NULL value means
323 that the CU/TU has not been expanded yet. */
324 std::vector
<compunit_symtab
*> m_symtabs
;
327 /* Get the dwarf2_per_objfile associated to OBJFILE. */
329 dwarf2_per_objfile
*get_dwarf2_per_objfile (struct objfile
*objfile
);
331 /* A partial symtab specialized for DWARF. */
332 struct dwarf2_psymtab
: public partial_symtab
334 dwarf2_psymtab (const char *filename
, struct objfile
*objfile
,
335 dwarf2_per_cu_data
*per_cu
)
336 : partial_symtab (filename
, objfile
, 0),
341 void read_symtab (struct objfile
*) override
;
342 void expand_psymtab (struct objfile
*) override
;
343 bool readin_p (struct objfile
*) const override
;
344 compunit_symtab
*get_compunit_symtab (struct objfile
*) const override
;
346 struct dwarf2_per_cu_data
*per_cu_data
;
349 /* Persistent data held for a compilation unit, even when not
350 processing it. We put a pointer to this structure in the
353 struct dwarf2_per_cu_data
355 /* The start offset and length of this compilation unit.
356 NOTE: Unlike comp_unit_head.length, this length includes
358 If the DIE refers to a DWO file, this is always of the original die,
360 sect_offset sect_off
;
363 /* DWARF standard version this data has been read from (such as 4 or 5). */
366 /* Flag indicating this compilation unit will be read in before
367 any of the current compilation units are processed. */
368 unsigned int queued
: 1;
370 /* This flag will be set when reading partial DIEs if we need to load
371 absolutely all DIEs for this compilation unit, instead of just the ones
372 we think are interesting. It gets set if we look for a DIE in the
373 hash table and don't find it. */
374 unsigned int load_all_dies
: 1;
376 /* Non-zero if this CU is from .debug_types.
377 Struct dwarf2_per_cu_data is contained in struct signatured_type iff
379 unsigned int is_debug_types
: 1;
381 /* Non-zero if this CU is from the .dwz file. */
382 unsigned int is_dwz
: 1;
384 /* Non-zero if reading a TU directly from a DWO file, bypassing the stub.
385 This flag is only valid if is_debug_types is true.
386 We can't read a CU directly from a DWO file: There are required
387 attributes in the stub. */
388 unsigned int reading_dwo_directly
: 1;
390 /* Non-zero if the TU has been read.
391 This is used to assist the "Stay in DWO Optimization" for Fission:
392 When reading a DWO, it's faster to read TUs from the DWO instead of
393 fetching them from random other DWOs (due to comdat folding).
394 If the TU has already been read, the optimization is unnecessary
395 (and unwise - we don't want to change where gdb thinks the TU lives
397 This flag is only valid if is_debug_types is true. */
398 unsigned int tu_read
: 1;
400 /* Our index in the unshared "symtabs" vector. */
403 /* The section this CU/TU lives in.
404 If the DIE refers to a DWO file, this is always the original die,
406 struct dwarf2_section_info
*section
;
408 /* Set to non-NULL iff this CU is currently loaded. When it gets freed out
409 of the CU cache it gets reset to NULL again. This is left as NULL for
410 dummy CUs (a CU header, but nothing else). */
411 struct dwarf2_cu
*cu
;
413 /* The unit type of this CU. */
414 enum dwarf_unit_type unit_type
;
416 /* The language of this CU. */
419 /* The corresponding dwarf2_per_objfile. */
420 struct dwarf2_per_objfile
*dwarf2_per_objfile
;
422 /* Backlink to the owner of this. */
423 dwarf2_per_bfd
*per_bfd
;
425 /* When dwarf2_per_bfd::using_index is true, the 'quick' field
426 is active. Otherwise, the 'psymtab' field is active. */
429 /* The partial symbol table associated with this compilation unit,
430 or NULL for unread partial units. */
431 dwarf2_psymtab
*psymtab
;
433 /* Data needed by the "quick" functions. */
434 struct dwarf2_per_cu_quick_data
*quick
;
437 /* The CUs we import using DW_TAG_imported_unit. This is filled in
438 while reading psymtabs, used to compute the psymtab dependencies,
439 and then cleared. Then it is filled in again while reading full
440 symbols, and only deleted when the objfile is destroyed.
442 This is also used to work around a difference between the way gold
443 generates .gdb_index version <=7 and the way gdb does. Arguably this
444 is a gold bug. For symbols coming from TUs, gold records in the index
445 the CU that includes the TU instead of the TU itself. This breaks
446 dw2_lookup_symbol: It assumes that if the index says symbol X lives
447 in CU/TU Y, then one need only expand Y and a subsequent lookup in Y
448 will find X. Alas TUs live in their own symtab, so after expanding CU Y
449 we need to look in TU Z to find X. Fortunately, this is akin to
450 DW_TAG_imported_unit, so we just use the same mechanism: For
451 .gdb_index version <=7 this also records the TUs that the CU referred
452 to. Concurrently with this change gdb was modified to emit version 8
453 indices so we only pay a price for gold generated indices.
454 http://sourceware.org/bugzilla/show_bug.cgi?id=15021.
456 This currently needs to be a public member due to how
457 dwarf2_per_cu_data is allocated and used. Ideally in future things
458 could be refactored to make this private. Until then please try to
459 avoid direct access to this member, and instead use the helper
461 std::vector
<dwarf2_per_cu_data
*> *imported_symtabs
;
463 /* Return true of IMPORTED_SYMTABS is empty or not yet allocated. */
464 bool imported_symtabs_empty () const
466 return (imported_symtabs
== nullptr || imported_symtabs
->empty ());
469 /* Push P to the back of IMPORTED_SYMTABS, allocated IMPORTED_SYMTABS
470 first if required. */
471 void imported_symtabs_push (dwarf2_per_cu_data
*p
)
473 if (imported_symtabs
== nullptr)
474 imported_symtabs
= new std::vector
<dwarf2_per_cu_data
*>;
475 imported_symtabs
->push_back (p
);
478 /* Return the size of IMPORTED_SYMTABS if it is allocated, otherwise
480 size_t imported_symtabs_size () const
482 if (imported_symtabs
== nullptr)
484 return imported_symtabs
->size ();
487 /* Delete IMPORTED_SYMTABS and set the pointer back to nullptr. */
488 void imported_symtabs_free ()
490 delete imported_symtabs
;
491 imported_symtabs
= nullptr;
494 /* Return the OBJFILE associated with this compilation unit. If
495 this compilation unit came from a separate debuginfo file, then
496 the master objfile is returned. */
497 struct objfile
*objfile () const;
499 /* Return the address size given in the compilation unit header for
501 int addr_size () const;
503 /* Return the offset size given in the compilation unit header for
505 int offset_size () const;
507 /* Return the DW_FORM_ref_addr size given in the compilation unit
508 header for this CU. */
509 int ref_addr_size () const;
511 /* Return the text offset of the CU. The returned offset comes from
512 this CU's objfile. If this objfile came from a separate
513 debuginfo file, then the offset may be different from the
514 corresponding offset in the parent objfile. */
515 CORE_ADDR
text_offset () const;
517 /* Return DWARF version number of this CU. */
518 short version () const
520 return dwarf_version
;
523 /* A type unit group has a per_cu object that is recognized by
524 having no section. */
525 bool type_unit_group_p () const
527 return section
== nullptr;
531 /* Entry in the signatured_types hash table. */
533 struct signatured_type
535 /* The "per_cu" object of this type.
536 This struct is used iff per_cu.is_debug_types.
537 N.B.: This is the first member so that it's easy to convert pointers
539 struct dwarf2_per_cu_data per_cu
;
541 /* The type's signature. */
544 /* Offset in the TU of the type's DIE, as read from the TU header.
545 If this TU is a DWO stub and the definition lives in a DWO file
546 (specified by DW_AT_GNU_dwo_name), this value is unusable. */
547 cu_offset type_offset_in_tu
;
549 /* Offset in the section of the type's DIE.
550 If the definition lives in a DWO file, this is the offset in the
551 .debug_types.dwo section.
552 The value is zero until the actual value is known.
553 Zero is otherwise not a valid section offset. */
554 sect_offset type_offset_in_section
;
556 /* Type units are grouped by their DW_AT_stmt_list entry so that they
557 can share them. This points to the containing symtab. */
558 struct type_unit_group
*type_unit_group
;
561 The first time we encounter this type we fully read it in and install it
562 in the symbol tables. Subsequent times we only need the type. */
565 /* Containing DWO unit.
566 This field is valid iff per_cu.reading_dwo_directly. */
567 struct dwo_unit
*dwo_unit
;
570 /* Open the separate '.dwz' debug file, if needed. Return NULL if
571 there is no .gnu_debugaltlink section in the file. Error if there
572 is such a section but the file cannot be found. */
574 extern dwz_file
*dwarf2_get_dwz_file (dwarf2_per_bfd
*per_bfd
);
576 /* Return the type of the DIE at DIE_OFFSET in the CU named by
579 struct type
*dwarf2_get_die_type (cu_offset die_offset
,
580 struct dwarf2_per_cu_data
*per_cu
);
582 /* Given an index in .debug_addr, fetch the value.
583 NOTE: This can be called during dwarf expression evaluation,
584 long after the debug information has been read, and thus per_cu->cu
585 may no longer exist. */
587 CORE_ADDR
dwarf2_read_addr_index (dwarf2_per_cu_data
*per_cu
,
588 unsigned int addr_index
);
590 /* Return DWARF block referenced by DW_AT_location of DIE at SECT_OFF at PER_CU.
591 Returned value is intended for DW_OP_call*. Returned
592 dwarf2_locexpr_baton->data has lifetime of
593 PER_CU->DWARF2_PER_OBJFILE->OBJFILE. */
595 struct dwarf2_locexpr_baton dwarf2_fetch_die_loc_sect_off
596 (sect_offset sect_off
, dwarf2_per_cu_data
*per_cu
,
597 CORE_ADDR (*get_frame_pc
) (void *baton
),
598 void *baton
, bool resolve_abstract_p
= false);
600 /* Like dwarf2_fetch_die_loc_sect_off, but take a CU
603 struct dwarf2_locexpr_baton dwarf2_fetch_die_loc_cu_off
604 (cu_offset offset_in_cu
, dwarf2_per_cu_data
*per_cu
,
605 CORE_ADDR (*get_frame_pc
) (void *baton
),
608 /* If the DIE at SECT_OFF in PER_CU has a DW_AT_const_value, return a
609 pointer to the constant bytes and set LEN to the length of the
610 data. If memory is needed, allocate it on OBSTACK. If the DIE
611 does not have a DW_AT_const_value, return NULL. */
613 extern const gdb_byte
*dwarf2_fetch_constant_bytes
614 (sect_offset sect_off
, dwarf2_per_cu_data
*per_cu
, obstack
*obstack
,
617 /* Return the type of the die at SECT_OFF in PER_CU. Return NULL if no
618 valid type for this die is found. */
620 struct type
*dwarf2_fetch_die_type_sect_off
621 (sect_offset sect_off
, dwarf2_per_cu_data
*per_cu
);
623 /* When non-zero, dump line number entries as they are read in. */
624 extern unsigned int dwarf_line_debug
;
626 #endif /* DWARF2READ_H */