]>
Commit | Line | Data |
---|---|---|
cd4fb1b2 SM |
1 | /* DWARF 2 debugging format support for GDB. |
2 | ||
213516ef | 3 | Copyright (C) 1994-2023 Free Software Foundation, Inc. |
cd4fb1b2 SM |
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 | ||
39856def | 23 | #include <queue> |
e4a62c65 | 24 | #include <unordered_map> |
cd53fa40 | 25 | #include "dwarf2/comp-unit-head.h" |
698379cc | 26 | #include "dwarf2/cooked-index.h" |
63538d8e | 27 | #include "dwarf2/file-and-dir.h" |
82ca8957 | 28 | #include "dwarf2/index-cache.h" |
20386fa3 | 29 | #include "dwarf2/mapped-index.h" |
2c86cff9 | 30 | #include "dwarf2/section.h" |
d09ee622 | 31 | #include "dwarf2/cu.h" |
cd4fb1b2 | 32 | #include "filename-seen-cache.h" |
bf31fd38 | 33 | #include "gdbsupport/gdb_obstack.h" |
268a13a5 | 34 | #include "gdbsupport/hash_enum.h" |
041d9819 | 35 | #include "gdbsupport/function-view.h" |
ac3972d8 | 36 | #include "gdbsupport/packed.h" |
cd4fb1b2 | 37 | |
3c3bb058 AB |
38 | /* Hold 'maintenance (set|show) dwarf' commands. */ |
39 | extern struct cmd_list_element *set_dwarf_cmdlist; | |
40 | extern struct cmd_list_element *show_dwarf_cmdlist; | |
41 | ||
cd4fb1b2 SM |
42 | struct tu_stats |
43 | { | |
44 | int nr_uniq_abbrev_tables; | |
45 | int nr_symtabs; | |
46 | int nr_symtab_sharers; | |
47 | int nr_stmt_less_type_units; | |
48 | int nr_all_type_units_reallocs; | |
91eea9cc | 49 | int nr_tus; |
cd4fb1b2 SM |
50 | }; |
51 | ||
7188ed02 | 52 | struct dwarf2_cu; |
cd4fb1b2 | 53 | struct dwarf2_debug_sections; |
4631503b | 54 | struct dwarf2_per_bfd; |
39856def | 55 | struct dwarf2_per_cu_data; |
cd4fb1b2 SM |
56 | struct mapped_index; |
57 | struct mapped_debug_names; | |
ff4c9fec | 58 | struct signatured_type; |
8adb8487 | 59 | struct type_unit_group; |
cd4fb1b2 | 60 | |
39856def TT |
61 | /* One item on the queue of compilation units to read in full symbols |
62 | for. */ | |
63 | struct dwarf2_queue_item | |
64 | { | |
120ce1b5 SM |
65 | dwarf2_queue_item (dwarf2_per_cu_data *cu, dwarf2_per_objfile *per_objfile, |
66 | enum language lang) | |
39856def | 67 | : per_cu (cu), |
120ce1b5 | 68 | per_objfile (per_objfile), |
39856def TT |
69 | pretend_language (lang) |
70 | { | |
71 | } | |
72 | ||
73 | ~dwarf2_queue_item (); | |
74 | ||
75 | DISABLE_COPY_AND_ASSIGN (dwarf2_queue_item); | |
76 | ||
120ce1b5 SM |
77 | dwarf2_per_cu_data *per_cu; |
78 | dwarf2_per_objfile *per_objfile; | |
39856def TT |
79 | enum language pretend_language; |
80 | }; | |
81 | ||
473ab964 TT |
82 | /* A deleter for dwarf2_per_cu_data that knows to downcast to |
83 | signatured_type as appropriate. This approach lets us avoid a | |
84 | virtual destructor, which saves a bit of space. */ | |
85 | ||
86 | struct dwarf2_per_cu_data_deleter | |
87 | { | |
88 | void operator() (dwarf2_per_cu_data *data); | |
89 | }; | |
90 | ||
91 | /* A specialization of unique_ptr for dwarf2_per_cu_data and | |
92 | subclasses. */ | |
93 | typedef std::unique_ptr<dwarf2_per_cu_data, dwarf2_per_cu_data_deleter> | |
94 | dwarf2_per_cu_data_up; | |
95 | ||
4631503b SM |
96 | /* Persistent data held for a compilation unit, even when not |
97 | processing it. We put a pointer to this structure in the | |
98 | psymtab. */ | |
99 | ||
100 | struct dwarf2_per_cu_data | |
101 | { | |
102 | dwarf2_per_cu_data () | |
12afdeec | 103 | : is_debug_types (false), |
4631503b SM |
104 | is_dwz (false), |
105 | reading_dwo_directly (false), | |
106 | tu_read (false), | |
107 | m_header_read_in (false), | |
8dddb06c TT |
108 | mark (false), |
109 | files_read (false), | |
12afdeec | 110 | queued (false), |
2e57de7c | 111 | scanned (false) |
4631503b SM |
112 | { |
113 | } | |
114 | ||
115 | /* The start offset and length of this compilation unit. | |
116 | NOTE: Unlike comp_unit_head.length, this length includes | |
117 | initial_length_size. | |
118 | If the DIE refers to a DWO file, this is always of the original die, | |
119 | not the DWO file. */ | |
120 | sect_offset sect_off {}; | |
4631503b | 121 | |
33fd0a33 | 122 | private: |
53a7a7e1 TV |
123 | unsigned int m_length = 0; |
124 | ||
4631503b | 125 | /* DWARF standard version this data has been read from (such as 4 or 5). */ |
33fd0a33 | 126 | unsigned char m_dwarf_version = 0; |
4631503b | 127 | |
33fd0a33 | 128 | public: |
4631503b SM |
129 | /* Non-zero if this CU is from .debug_types. |
130 | Struct dwarf2_per_cu_data is contained in struct signatured_type iff | |
131 | this is non-zero. */ | |
132 | unsigned int is_debug_types : 1; | |
133 | ||
134 | /* Non-zero if this CU is from the .dwz file. */ | |
135 | unsigned int is_dwz : 1; | |
136 | ||
137 | /* Non-zero if reading a TU directly from a DWO file, bypassing the stub. | |
138 | This flag is only valid if is_debug_types is true. | |
139 | We can't read a CU directly from a DWO file: There are required | |
140 | attributes in the stub. */ | |
141 | unsigned int reading_dwo_directly : 1; | |
142 | ||
143 | /* Non-zero if the TU has been read. | |
144 | This is used to assist the "Stay in DWO Optimization" for Fission: | |
145 | When reading a DWO, it's faster to read TUs from the DWO instead of | |
146 | fetching them from random other DWOs (due to comdat folding). | |
147 | If the TU has already been read, the optimization is unnecessary | |
148 | (and unwise - we don't want to change where gdb thinks the TU lives | |
149 | "midflight"). | |
150 | This flag is only valid if is_debug_types is true. */ | |
151 | unsigned int tu_read : 1; | |
152 | ||
153 | /* True if HEADER has been read in. | |
154 | ||
155 | Don't access this field directly. It should be private, but we can't make | |
156 | it private at the moment. */ | |
157 | mutable bool m_header_read_in : 1; | |
158 | ||
8dddb06c TT |
159 | /* A temporary mark bit used when iterating over all CUs in |
160 | expand_symtabs_matching. */ | |
161 | unsigned int mark : 1; | |
162 | ||
163 | /* True if we've tried to read the file table. There will be no | |
164 | point in trying to read it again next time. */ | |
165 | bool files_read : 1; | |
166 | ||
ac3972d8 TV |
167 | /* Wrap the following in struct packed instead of bitfields to avoid |
168 | data races when the bitfields end up on the same memory location | |
169 | (per C++ memory model). */ | |
170 | ||
171 | /* If addresses have been read for this CU (usually from | |
172 | .debug_aranges), then this flag is set. */ | |
173 | packed<bool, 1> addresses_seen = false; | |
174 | ||
12afdeec TV |
175 | /* Flag indicating this compilation unit will be read in before |
176 | any of the current compilation units are processed. */ | |
177 | packed<bool, 1> queued; | |
178 | ||
2c474c46 | 179 | private: |
4631503b | 180 | /* The unit type of this CU. */ |
b35bd7d5 | 181 | std::atomic<packed<dwarf_unit_type, 1>> m_unit_type {(dwarf_unit_type)0}; |
4631503b SM |
182 | |
183 | /* The language of this CU. */ | |
14dd1080 | 184 | std::atomic<packed<language, LANGUAGE_BYTES>> m_lang {language_unknown}; |
4631503b | 185 | |
2c474c46 | 186 | public: |
2e57de7c TT |
187 | /* True if this CU has been scanned by the indexer; false if |
188 | not. */ | |
46114cb7 | 189 | std::atomic<bool> scanned; |
2e57de7c | 190 | |
4631503b SM |
191 | /* Our index in the unshared "symtabs" vector. */ |
192 | unsigned index = 0; | |
193 | ||
194 | /* The section this CU/TU lives in. | |
195 | If the DIE refers to a DWO file, this is always the original die, | |
196 | not the DWO file. */ | |
197 | struct dwarf2_section_info *section = nullptr; | |
198 | ||
199 | /* Backlink to the owner of this. */ | |
200 | dwarf2_per_bfd *per_bfd = nullptr; | |
201 | ||
202 | /* DWARF header of this CU. Note that dwarf2_cu reads its own version of the | |
203 | header, which may differ from this one, since it may pass rcuh_kind::TYPE | |
204 | to read_comp_unit_head, whereas for dwarf2_per_cu_data we always pass | |
205 | rcuh_kind::COMPILE. | |
206 | ||
207 | Don't access this field directly, use the get_header method instead. It | |
208 | should be private, but we can't make it private at the moment. */ | |
4d78ce77 | 209 | mutable comp_unit_head m_header; |
4631503b | 210 | |
63538d8e TT |
211 | /* The file and directory for this CU. This is cached so that we |
212 | don't need to re-examine the DWO in some situations. This may be | |
213 | nullptr, depending on the CU; for example a partial unit won't | |
214 | have one. */ | |
215 | std::unique_ptr<file_and_directory> fnd; | |
216 | ||
8dddb06c TT |
217 | /* The file table. This can be NULL if there was no file table |
218 | or it's currently not read in. | |
219 | NOTE: This points into dwarf2_per_objfile->per_bfd->quick_file_names_table. */ | |
220 | struct quick_file_names *file_names = nullptr; | |
4631503b SM |
221 | |
222 | /* The CUs we import using DW_TAG_imported_unit. This is filled in | |
223 | while reading psymtabs, used to compute the psymtab dependencies, | |
224 | and then cleared. Then it is filled in again while reading full | |
225 | symbols, and only deleted when the objfile is destroyed. | |
226 | ||
227 | This is also used to work around a difference between the way gold | |
228 | generates .gdb_index version <=7 and the way gdb does. Arguably this | |
229 | is a gold bug. For symbols coming from TUs, gold records in the index | |
230 | the CU that includes the TU instead of the TU itself. This breaks | |
231 | dw2_lookup_symbol: It assumes that if the index says symbol X lives | |
232 | in CU/TU Y, then one need only expand Y and a subsequent lookup in Y | |
233 | will find X. Alas TUs live in their own symtab, so after expanding CU Y | |
234 | we need to look in TU Z to find X. Fortunately, this is akin to | |
235 | DW_TAG_imported_unit, so we just use the same mechanism: For | |
236 | .gdb_index version <=7 this also records the TUs that the CU referred | |
237 | to. Concurrently with this change gdb was modified to emit version 8 | |
238 | indices so we only pay a price for gold generated indices. | |
239 | http://sourceware.org/bugzilla/show_bug.cgi?id=15021. | |
240 | ||
241 | This currently needs to be a public member due to how | |
242 | dwarf2_per_cu_data is allocated and used. Ideally in future things | |
243 | could be refactored to make this private. Until then please try to | |
244 | avoid direct access to this member, and instead use the helper | |
245 | functions above. */ | |
246 | std::vector <dwarf2_per_cu_data *> *imported_symtabs = nullptr; | |
247 | ||
248 | /* Return true of IMPORTED_SYMTABS is empty or not yet allocated. */ | |
249 | bool imported_symtabs_empty () const | |
250 | { | |
251 | return (imported_symtabs == nullptr || imported_symtabs->empty ()); | |
252 | } | |
253 | ||
254 | /* Push P to the back of IMPORTED_SYMTABS, allocated IMPORTED_SYMTABS | |
255 | first if required. */ | |
256 | void imported_symtabs_push (dwarf2_per_cu_data *p) | |
257 | { | |
258 | if (imported_symtabs == nullptr) | |
259 | imported_symtabs = new std::vector <dwarf2_per_cu_data *>; | |
260 | imported_symtabs->push_back (p); | |
261 | } | |
262 | ||
263 | /* Return the size of IMPORTED_SYMTABS if it is allocated, otherwise | |
264 | return 0. */ | |
265 | size_t imported_symtabs_size () const | |
266 | { | |
267 | if (imported_symtabs == nullptr) | |
268 | return 0; | |
269 | return imported_symtabs->size (); | |
270 | } | |
271 | ||
272 | /* Delete IMPORTED_SYMTABS and set the pointer back to nullptr. */ | |
273 | void imported_symtabs_free () | |
274 | { | |
275 | delete imported_symtabs; | |
276 | imported_symtabs = nullptr; | |
277 | } | |
278 | ||
279 | /* Get the header of this per_cu, reading it if necessary. */ | |
280 | const comp_unit_head *get_header () const; | |
281 | ||
282 | /* Return the address size given in the compilation unit header for | |
283 | this CU. */ | |
284 | int addr_size () const; | |
285 | ||
286 | /* Return the offset size given in the compilation unit header for | |
287 | this CU. */ | |
288 | int offset_size () const; | |
289 | ||
290 | /* Return the DW_FORM_ref_addr size given in the compilation unit | |
291 | header for this CU. */ | |
292 | int ref_addr_size () const; | |
293 | ||
53a7a7e1 TV |
294 | /* Return length of this CU. */ |
295 | unsigned int length () const | |
296 | { | |
297 | /* Make sure it's set already. */ | |
298 | gdb_assert (m_length != 0); | |
299 | return m_length; | |
300 | } | |
301 | ||
302 | void set_length (unsigned int length, bool strict_p = true) | |
303 | { | |
304 | if (m_length == 0) | |
305 | /* Set if not set already. */ | |
306 | m_length = length; | |
307 | else if (strict_p) | |
308 | /* If already set, verify that it's the same value. */ | |
309 | gdb_assert (m_length == length); | |
310 | } | |
311 | ||
4631503b SM |
312 | /* Return DWARF version number of this CU. */ |
313 | short version () const | |
314 | { | |
33fd0a33 TV |
315 | /* Make sure it's set already. */ |
316 | gdb_assert (m_dwarf_version != 0); | |
317 | return m_dwarf_version; | |
318 | } | |
319 | ||
320 | void set_version (short version) | |
321 | { | |
322 | if (m_dwarf_version == 0) | |
323 | /* Set if not set already. */ | |
324 | m_dwarf_version = version; | |
325 | else | |
326 | /* If already set, verify that it's the same value. */ | |
327 | gdb_assert (m_dwarf_version == version); | |
4631503b SM |
328 | } |
329 | ||
8728fb33 | 330 | dwarf_unit_type unit_type (bool strict_p = true) const |
2c474c46 | 331 | { |
b35bd7d5 | 332 | dwarf_unit_type ut = m_unit_type.load (); |
8728fb33 | 333 | if (strict_p) |
b35bd7d5 TV |
334 | gdb_assert (ut != 0); |
335 | return ut; | |
2c474c46 TV |
336 | } |
337 | ||
338 | void set_unit_type (dwarf_unit_type unit_type) | |
339 | { | |
b35bd7d5 TV |
340 | /* Set if not set already. */ |
341 | packed<dwarf_unit_type, 1> nope = (dwarf_unit_type)0; | |
342 | if (m_unit_type.compare_exchange_strong (nope, unit_type)) | |
343 | return; | |
344 | ||
345 | /* If already set, verify that it's the same value. */ | |
346 | nope = unit_type; | |
347 | if (m_unit_type.compare_exchange_strong (nope, unit_type)) | |
348 | return; | |
349 | gdb_assert_not_reached (); | |
2c474c46 TV |
350 | } |
351 | ||
8728fb33 | 352 | enum language lang (bool strict_p = true) const |
2c474c46 | 353 | { |
14dd1080 | 354 | enum language l = m_lang.load (); |
8728fb33 | 355 | if (strict_p) |
14dd1080 TV |
356 | gdb_assert (l != language_unknown); |
357 | return l; | |
2c474c46 TV |
358 | } |
359 | ||
360 | void set_lang (enum language lang) | |
361 | { | |
52c0a455 TV |
362 | if (unit_type () == DW_UT_partial) |
363 | return; | |
14dd1080 TV |
364 | /* Set if not set already. */ |
365 | packed<language, LANGUAGE_BYTES> nope = language_unknown; | |
366 | if (m_lang.compare_exchange_strong (nope, lang)) | |
367 | return; | |
368 | /* If already set, verify that it's the same value. */ | |
369 | nope = lang; | |
370 | if (m_lang.compare_exchange_strong (nope, lang)) | |
371 | return; | |
372 | gdb_assert_not_reached (); | |
2c474c46 TV |
373 | } |
374 | ||
1fd5fd58 TT |
375 | /* Free any cached file names. */ |
376 | void free_cached_file_names (); | |
4631503b SM |
377 | }; |
378 | ||
379 | /* Entry in the signatured_types hash table. */ | |
380 | ||
381 | struct signatured_type : public dwarf2_per_cu_data | |
382 | { | |
9ea36493 SM |
383 | signatured_type (ULONGEST signature) |
384 | : signature (signature) | |
385 | {} | |
386 | ||
4631503b | 387 | /* The type's signature. */ |
9ea36493 | 388 | ULONGEST signature; |
4631503b SM |
389 | |
390 | /* Offset in the TU of the type's DIE, as read from the TU header. | |
391 | If this TU is a DWO stub and the definition lives in a DWO file | |
392 | (specified by DW_AT_GNU_dwo_name), this value is unusable. */ | |
393 | cu_offset type_offset_in_tu {}; | |
394 | ||
395 | /* Offset in the section of the type's DIE. | |
396 | If the definition lives in a DWO file, this is the offset in the | |
397 | .debug_types.dwo section. | |
398 | The value is zero until the actual value is known. | |
399 | Zero is otherwise not a valid section offset. */ | |
400 | sect_offset type_offset_in_section {}; | |
401 | ||
402 | /* Type units are grouped by their DW_AT_stmt_list entry so that they | |
403 | can share them. This points to the containing symtab. */ | |
404 | struct type_unit_group *type_unit_group = nullptr; | |
405 | ||
406 | /* Containing DWO unit. | |
407 | This field is valid iff per_cu.reading_dwo_directly. */ | |
408 | struct dwo_unit *dwo_unit = nullptr; | |
409 | }; | |
410 | ||
46c6bcf6 SM |
411 | using signatured_type_up = std::unique_ptr<signatured_type>; |
412 | ||
5989a64e SM |
413 | /* Some DWARF data can be shared across objfiles who share the same BFD, |
414 | this data is stored in this object. | |
cd4fb1b2 | 415 | |
5989a64e SM |
416 | Two dwarf2_per_objfile objects representing objfiles sharing the same BFD |
417 | will point to the same instance of dwarf2_per_bfd, unless the BFD requires | |
418 | relocation. */ | |
419 | ||
420 | struct dwarf2_per_bfd | |
cd4fb1b2 | 421 | { |
5989a64e | 422 | /* Construct a dwarf2_per_bfd for OBFD. NAMES points to the |
cd4fb1b2 | 423 | dwarf2 section names, or is NULL if the standard ELF names are |
4b610737 TT |
424 | used. CAN_COPY is true for formats where symbol |
425 | interposition is possible and so symbol values must follow copy | |
426 | relocation rules. */ | |
5989a64e | 427 | dwarf2_per_bfd (bfd *obfd, const dwarf2_debug_sections *names, bool can_copy); |
cd4fb1b2 | 428 | |
5989a64e | 429 | ~dwarf2_per_bfd (); |
cd4fb1b2 | 430 | |
5989a64e | 431 | DISABLE_COPY_AND_ASSIGN (dwarf2_per_bfd); |
cd4fb1b2 | 432 | |
91eea9cc TT |
433 | /* Return the CU given its index. */ |
434 | dwarf2_per_cu_data *get_cu (int index) const | |
435 | { | |
93547a56 | 436 | return this->all_units[index].get (); |
91eea9cc | 437 | } |
ff4c9fec | 438 | |
d3473f0c TT |
439 | /* A convenience function to allocate a dwarf2_per_cu_data. The |
440 | returned object has its "index" field set properly. The object | |
5989a64e | 441 | is allocated on the dwarf2_per_bfd obstack. */ |
473ab964 | 442 | dwarf2_per_cu_data_up allocate_per_cu (); |
d3473f0c TT |
443 | |
444 | /* A convenience function to allocate a signatured_type. The | |
445 | returned object has its "index" field set properly. The object | |
5989a64e | 446 | is allocated on the dwarf2_per_bfd obstack. */ |
9ea36493 | 447 | signatured_type_up allocate_signatured_type (ULONGEST signature); |
d3473f0c | 448 | |
c748b24c TT |
449 | /* Map all the DWARF section data needed when scanning |
450 | .debug_info. */ | |
451 | void map_info_sections (struct objfile *objfile); | |
452 | ||
cd4fb1b2 SM |
453 | private: |
454 | /* This function is mapped across the sections and remembers the | |
455 | offset and size of each of the debugging sections we are | |
456 | interested in. */ | |
457 | void locate_sections (bfd *abfd, asection *sectp, | |
458 | const dwarf2_debug_sections &names); | |
459 | ||
460 | public: | |
c3699833 SM |
461 | /* The corresponding BFD. */ |
462 | bfd *obfd; | |
463 | ||
6209cde4 TT |
464 | /* Objects that can be shared across objfiles may be stored in this |
465 | obstack, while objects that are objfile-specific are stored on | |
466 | the objfile obstack. */ | |
45940949 TT |
467 | auto_obstack obstack; |
468 | ||
cd4fb1b2 SM |
469 | dwarf2_section_info info {}; |
470 | dwarf2_section_info abbrev {}; | |
471 | dwarf2_section_info line {}; | |
472 | dwarf2_section_info loc {}; | |
473 | dwarf2_section_info loclists {}; | |
474 | dwarf2_section_info macinfo {}; | |
475 | dwarf2_section_info macro {}; | |
476 | dwarf2_section_info str {}; | |
18a8505e | 477 | dwarf2_section_info str_offsets {}; |
cd4fb1b2 SM |
478 | dwarf2_section_info line_str {}; |
479 | dwarf2_section_info ranges {}; | |
480 | dwarf2_section_info rnglists {}; | |
481 | dwarf2_section_info addr {}; | |
482 | dwarf2_section_info frame {}; | |
483 | dwarf2_section_info eh_frame {}; | |
484 | dwarf2_section_info gdb_index {}; | |
485 | dwarf2_section_info debug_names {}; | |
486 | dwarf2_section_info debug_aranges {}; | |
487 | ||
fd5866f6 | 488 | std::vector<dwarf2_section_info> types; |
cd4fb1b2 | 489 | |
cd4fb1b2 SM |
490 | /* Table of all the compilation units. This is used to locate |
491 | the target compilation unit of a particular reference. */ | |
93547a56 | 492 | std::vector<dwarf2_per_cu_data_up> all_units; |
cd4fb1b2 | 493 | |
aaf3f3f3 TV |
494 | /* The all_units vector contains both CUs and TUs. Provide views on the |
495 | vector that are limited to either the CU part or the TU part. */ | |
496 | gdb::array_view<dwarf2_per_cu_data_up> all_comp_units; | |
497 | gdb::array_view<dwarf2_per_cu_data_up> all_type_units; | |
498 | ||
cd4fb1b2 SM |
499 | /* Table of struct type_unit_group objects. |
500 | The hash key is the DW_AT_stmt_list value. */ | |
eaa5fa8b | 501 | htab_up type_unit_groups; |
cd4fb1b2 SM |
502 | |
503 | /* A table mapping .debug_types signatures to its signatured_type entry. | |
504 | This is NULL if the .debug_types section hasn't been read in yet. */ | |
b0b6a987 | 505 | htab_up signatured_types; |
cd4fb1b2 SM |
506 | |
507 | /* Type unit statistics, to see how well the scaling improvements | |
508 | are doing. */ | |
509 | struct tu_stats tu_stats {}; | |
510 | ||
cd4fb1b2 SM |
511 | /* A table mapping DW_AT_dwo_name values to struct dwo_file objects. |
512 | This is NULL if the table hasn't been allocated yet. */ | |
51ac9db5 | 513 | htab_up dwo_files; |
cd4fb1b2 SM |
514 | |
515 | /* True if we've checked for whether there is a DWP file. */ | |
516 | bool dwp_checked = false; | |
517 | ||
518 | /* The DWP file if there is one, or NULL. */ | |
400174b1 | 519 | std::unique_ptr<struct dwp_file> dwp_file; |
cd4fb1b2 SM |
520 | |
521 | /* The shared '.dwz' file, if one exists. This is used when the | |
522 | original data was compressed using 'dwz -m'. */ | |
7ff8cb8c | 523 | std::unique_ptr<struct dwz_file> dwz_file; |
cd4fb1b2 | 524 | |
4b610737 TT |
525 | /* Whether copy relocations are supported by this object format. */ |
526 | bool can_copy; | |
527 | ||
cd4fb1b2 SM |
528 | /* A flag indicating whether this objfile has a section loaded at a |
529 | VMA of 0. */ | |
530 | bool has_section_at_zero = false; | |
531 | ||
a827b8ec TT |
532 | /* The mapped index, or NULL in the readnow case. */ |
533 | std::unique_ptr<dwarf_scanner_base> index_table; | |
698379cc | 534 | |
cd4fb1b2 SM |
535 | /* When using index_table, this keeps track of all quick_file_names entries. |
536 | TUs typically share line table entries with a CU, so we maintain a | |
537 | separate table of all line table entries to support the sharing. | |
538 | Note that while there can be way more TUs than CUs, we've already | |
539 | sorted all the TUs into "type unit groups", grouped by their | |
540 | DW_AT_stmt_list value. Therefore the only sharing done here is with a | |
541 | CU and its associated TU group if there is one. */ | |
5895093f | 542 | htab_up quick_file_names_table; |
cd4fb1b2 | 543 | |
cd4fb1b2 | 544 | /* The CUs we recently read. */ |
c5d0225d | 545 | std::vector<dwarf2_per_cu_data *> just_read_cus; |
cd4fb1b2 | 546 | |
87d6a7aa SM |
547 | /* If we loaded the index from an external file, this contains the |
548 | resources associated to the open file, memory mapping, etc. */ | |
549 | std::unique_ptr<index_cache_resource> index_cache_res; | |
e4a62c65 TV |
550 | |
551 | /* Mapping from abstract origin DIE to concrete DIEs that reference it as | |
552 | DW_AT_abstract_origin. */ | |
fad03f6e TT |
553 | std::unordered_map<sect_offset, std::vector<sect_offset>, |
554 | gdb::hash_enum<sect_offset>> | |
e4a62c65 | 555 | abstract_to_concrete; |
39856def | 556 | |
efd7398e TT |
557 | /* The address map that is used by the DWARF index code. */ |
558 | struct addrmap *index_addrmap = nullptr; | |
cd4fb1b2 SM |
559 | }; |
560 | ||
6acd95be SM |
561 | /* An iterator for all_units that is based on index. This |
562 | approach makes it possible to iterate over all_units safely, | |
563 | when some caller in the loop may add new units. */ | |
564 | ||
565 | class all_units_iterator | |
566 | { | |
567 | public: | |
568 | ||
569 | all_units_iterator (dwarf2_per_bfd *per_bfd, bool start) | |
570 | : m_per_bfd (per_bfd), | |
571 | m_index (start ? 0 : per_bfd->all_units.size ()) | |
572 | { | |
573 | } | |
574 | ||
575 | all_units_iterator &operator++ () | |
576 | { | |
577 | ++m_index; | |
578 | return *this; | |
579 | } | |
580 | ||
581 | dwarf2_per_cu_data *operator* () const | |
582 | { | |
583 | return m_per_bfd->get_cu (m_index); | |
584 | } | |
585 | ||
586 | bool operator== (const all_units_iterator &other) const | |
587 | { | |
588 | return m_index == other.m_index; | |
589 | } | |
590 | ||
591 | ||
592 | bool operator!= (const all_units_iterator &other) const | |
593 | { | |
594 | return m_index != other.m_index; | |
595 | } | |
596 | ||
597 | private: | |
598 | ||
599 | dwarf2_per_bfd *m_per_bfd; | |
600 | size_t m_index; | |
601 | }; | |
602 | ||
603 | /* A range adapter for the all_units_iterator. */ | |
604 | class all_units_range | |
605 | { | |
606 | public: | |
607 | ||
608 | all_units_range (dwarf2_per_bfd *per_bfd) | |
609 | : m_per_bfd (per_bfd) | |
610 | { | |
611 | } | |
612 | ||
613 | all_units_iterator begin () | |
614 | { | |
615 | return all_units_iterator (m_per_bfd, true); | |
616 | } | |
617 | ||
618 | all_units_iterator end () | |
619 | { | |
620 | return all_units_iterator (m_per_bfd, false); | |
621 | } | |
622 | ||
623 | private: | |
624 | ||
625 | dwarf2_per_bfd *m_per_bfd; | |
626 | }; | |
627 | ||
8adb8487 TT |
628 | /* This is the per-objfile data associated with a type_unit_group. */ |
629 | ||
630 | struct type_unit_group_unshareable | |
631 | { | |
632 | /* The compunit symtab. | |
633 | Type units in a group needn't all be defined in the same source file, | |
634 | so we create an essentially anonymous symtab as the compunit symtab. */ | |
635 | struct compunit_symtab *compunit_symtab = nullptr; | |
636 | ||
637 | /* The number of symtabs from the line header. | |
638 | The value here must match line_header.num_file_names. */ | |
639 | unsigned int num_symtabs = 0; | |
640 | ||
641 | /* The symbol tables for this TU (obtained from the files listed in | |
642 | DW_AT_stmt_list). | |
643 | WARNING: The order of entries here must match the order of entries | |
644 | in the line header. After the first TU using this type_unit_group, the | |
645 | line header for the subsequent TUs is recreated from this. This is done | |
646 | because we need to use the same symtabs for each TU using the same | |
647 | DW_AT_stmt_list value. Also note that symtabs may be repeated here, | |
648 | there's no guarantee the line header doesn't have duplicate entries. */ | |
649 | struct symtab **symtabs = nullptr; | |
650 | }; | |
651 | ||
5989a64e SM |
652 | /* Collection of data recorded per objfile. |
653 | This hangs off of dwarf2_objfile_data_key. | |
654 | ||
655 | Some DWARF data cannot (currently) be shared across objfiles. Such | |
656 | data is stored in this object. */ | |
657 | ||
658 | struct dwarf2_per_objfile | |
659 | { | |
660 | dwarf2_per_objfile (struct objfile *objfile, dwarf2_per_bfd *per_bfd) | |
661 | : objfile (objfile), per_bfd (per_bfd) | |
662 | {} | |
663 | ||
7188ed02 SM |
664 | ~dwarf2_per_objfile (); |
665 | ||
5989a64e SM |
666 | /* Return pointer to string at .debug_line_str offset as read from BUF. |
667 | BUF is assumed to be in a compilation unit described by CU_HEADER. | |
668 | Return *BYTES_READ_PTR count of bytes read from BUF. */ | |
669 | const char *read_line_string (const gdb_byte *buf, | |
670 | const struct comp_unit_head *cu_header, | |
671 | unsigned int *bytes_read_ptr); | |
672 | ||
bab31d14 TV |
673 | /* Return pointer to string at .debug_line_str offset as read from BUF. |
674 | The offset_size is OFFSET_SIZE. */ | |
675 | const char *read_line_string (const gdb_byte *buf, | |
676 | unsigned int offset_size); | |
677 | ||
af758d11 SM |
678 | /* Return true if the symtab corresponding to PER_CU has been set, |
679 | false otherwise. */ | |
680 | bool symtab_set_p (const dwarf2_per_cu_data *per_cu) const; | |
681 | ||
682 | /* Return the compunit_symtab associated to PER_CU, if it has been created. */ | |
683 | compunit_symtab *get_symtab (const dwarf2_per_cu_data *per_cu) const; | |
684 | ||
685 | /* Set the compunit_symtab associated to PER_CU. */ | |
686 | void set_symtab (const dwarf2_per_cu_data *per_cu, compunit_symtab *symtab); | |
687 | ||
e286671b TT |
688 | /* Get the type_unit_group_unshareable corresponding to TU_GROUP. If one |
689 | does not exist, create it. */ | |
8adb8487 TT |
690 | type_unit_group_unshareable *get_type_unit_group_unshareable |
691 | (type_unit_group *tu_group); | |
692 | ||
e286671b TT |
693 | struct type *get_type_for_signatured_type (signatured_type *sig_type) const; |
694 | ||
695 | void set_type_for_signatured_type (signatured_type *sig_type, | |
696 | struct type *type); | |
697 | ||
7188ed02 SM |
698 | /* Get the dwarf2_cu matching PER_CU for this objfile. */ |
699 | dwarf2_cu *get_cu (dwarf2_per_cu_data *per_cu); | |
700 | ||
701 | /* Set the dwarf2_cu matching PER_CU for this objfile. */ | |
d09ee622 | 702 | void set_cu (dwarf2_per_cu_data *per_cu, std::unique_ptr<dwarf2_cu> cu); |
7188ed02 SM |
703 | |
704 | /* Remove/free the dwarf2_cu matching PER_CU for this objfile. */ | |
705 | void remove_cu (dwarf2_per_cu_data *per_cu); | |
706 | ||
707 | /* Free all cached compilation units. */ | |
708 | void remove_all_cus (); | |
709 | ||
710 | /* Increase the age counter on each CU compilation unit and free | |
711 | any that are too old. */ | |
712 | void age_comp_units (); | |
713 | ||
1e73d09f TT |
714 | /* Apply any needed adjustments to ADDR, returning an adjusted but |
715 | still unrelocated address. */ | |
716 | unrelocated_addr adjust (unrelocated_addr addr); | |
717 | ||
718 | /* Apply any needed adjustments to ADDR and then relocate the | |
719 | address according to the objfile's section offsets, returning a | |
720 | relocated address. */ | |
721 | CORE_ADDR relocate (unrelocated_addr addr); | |
722 | ||
5989a64e SM |
723 | /* Back link. */ |
724 | struct objfile *objfile; | |
725 | ||
726 | /* Pointer to the data that is (possibly) shared between this objfile and | |
727 | other objfiles backed by the same BFD. */ | |
728 | struct dwarf2_per_bfd *per_bfd; | |
af758d11 | 729 | |
ae090bdb SM |
730 | /* Table mapping type DIEs to their struct type *. |
731 | This is nullptr if not allocated yet. | |
732 | The mapping is done via (CU/TU + DIE offset) -> type. */ | |
733 | htab_up die_type_hash; | |
734 | ||
39b16f87 SM |
735 | /* Table containing line_header indexed by offset and offset_in_dwz. */ |
736 | htab_up line_header_hash; | |
737 | ||
8457e5ec TV |
738 | /* The CU containing the m_builder in scope. */ |
739 | dwarf2_cu *sym_cu = nullptr; | |
740 | ||
5ca5b31d TT |
741 | /* CUs that are queued to be read. */ |
742 | gdb::optional<std::queue<dwarf2_queue_item>> queue; | |
743 | ||
af758d11 SM |
744 | private: |
745 | /* Hold the corresponding compunit_symtab for each CU or TU. This | |
746 | is indexed by dwarf2_per_cu_data::index. A NULL value means | |
747 | that the CU/TU has not been expanded yet. */ | |
748 | std::vector<compunit_symtab *> m_symtabs; | |
8adb8487 TT |
749 | |
750 | /* Map from a type unit group to the corresponding unshared | |
751 | structure. */ | |
752 | typedef std::unique_ptr<type_unit_group_unshareable> | |
753 | type_unit_group_unshareable_up; | |
754 | ||
755 | std::unordered_map<type_unit_group *, type_unit_group_unshareable_up> | |
756 | m_type_units; | |
e286671b TT |
757 | |
758 | /* Map from signatured types to the corresponding struct type. */ | |
759 | std::unordered_map<signatured_type *, struct type *> m_type_map; | |
7188ed02 SM |
760 | |
761 | /* Map from the objfile-independent dwarf2_per_cu_data instances to the | |
762 | corresponding objfile-dependent dwarf2_cu instances. */ | |
d09ee622 TT |
763 | std::unordered_map<dwarf2_per_cu_data *, |
764 | std::unique_ptr<dwarf2_cu>> m_dwarf2_cus; | |
5989a64e SM |
765 | }; |
766 | ||
cd4fb1b2 SM |
767 | /* Get the dwarf2_per_objfile associated to OBJFILE. */ |
768 | ||
769 | dwarf2_per_objfile *get_dwarf2_per_objfile (struct objfile *objfile); | |
770 | ||
8cb5117c SM |
771 | /* Return the type of the DIE at DIE_OFFSET in the CU named by |
772 | PER_CU. */ | |
773 | ||
774 | struct type *dwarf2_get_die_type (cu_offset die_offset, | |
aa66c379 SM |
775 | dwarf2_per_cu_data *per_cu, |
776 | dwarf2_per_objfile *per_objfile); | |
8cb5117c | 777 | |
450a1bfc SM |
778 | /* Given an index in .debug_addr, fetch the value. |
779 | NOTE: This can be called during dwarf expression evaluation, | |
780 | long after the debug information has been read, and thus per_cu->cu | |
781 | may no longer exist. */ | |
782 | ||
1e73d09f TT |
783 | unrelocated_addr dwarf2_read_addr_index (dwarf2_per_cu_data *per_cu, |
784 | dwarf2_per_objfile *per_objfile, | |
785 | unsigned int addr_index); | |
450a1bfc | 786 | |
d4c9a4f8 SM |
787 | /* Return DWARF block referenced by DW_AT_location of DIE at SECT_OFF at PER_CU. |
788 | Returned value is intended for DW_OP_call*. Returned | |
789 | dwarf2_locexpr_baton->data has lifetime of | |
790 | PER_CU->DWARF2_PER_OBJFILE->OBJFILE. */ | |
791 | ||
792 | struct dwarf2_locexpr_baton dwarf2_fetch_die_loc_sect_off | |
793 | (sect_offset sect_off, dwarf2_per_cu_data *per_cu, | |
14095eb3 | 794 | dwarf2_per_objfile *per_objfile, |
041d9819 SM |
795 | gdb::function_view<CORE_ADDR ()> get_frame_pc, |
796 | bool resolve_abstract_p = false); | |
d4c9a4f8 SM |
797 | |
798 | /* Like dwarf2_fetch_die_loc_sect_off, but take a CU | |
799 | offset. */ | |
800 | ||
801 | struct dwarf2_locexpr_baton dwarf2_fetch_die_loc_cu_off | |
802 | (cu_offset offset_in_cu, dwarf2_per_cu_data *per_cu, | |
14095eb3 | 803 | dwarf2_per_objfile *per_objfile, |
041d9819 | 804 | gdb::function_view<CORE_ADDR ()> get_frame_pc); |
d4c9a4f8 SM |
805 | |
806 | /* If the DIE at SECT_OFF in PER_CU has a DW_AT_const_value, return a | |
807 | pointer to the constant bytes and set LEN to the length of the | |
808 | data. If memory is needed, allocate it on OBSTACK. If the DIE | |
809 | does not have a DW_AT_const_value, return NULL. */ | |
810 | ||
811 | extern const gdb_byte *dwarf2_fetch_constant_bytes | |
14095eb3 SM |
812 | (sect_offset sect_off, dwarf2_per_cu_data *per_cu, |
813 | dwarf2_per_objfile *per_objfile, obstack *obstack, | |
d4c9a4f8 SM |
814 | LONGEST *len); |
815 | ||
816 | /* Return the type of the die at SECT_OFF in PER_CU. Return NULL if no | |
386de171 TT |
817 | valid type for this die is found. If VAR_NAME is non-null, and if |
818 | the DIE in question is a variable declaration (definitions are | |
819 | excluded), then *VAR_NAME is set to the variable's name. */ | |
d4c9a4f8 SM |
820 | |
821 | struct type *dwarf2_fetch_die_type_sect_off | |
14095eb3 | 822 | (sect_offset sect_off, dwarf2_per_cu_data *per_cu, |
386de171 TT |
823 | dwarf2_per_objfile *per_objfile, |
824 | const char **var_name = nullptr); | |
d4c9a4f8 | 825 | |
8fdd972c TT |
826 | /* When non-zero, dump line number entries as they are read in. */ |
827 | extern unsigned int dwarf_line_debug; | |
828 | ||
18038e63 TT |
829 | /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */ |
830 | enum dwarf2_section_enum { | |
831 | DWARF2_DEBUG_FRAME, | |
832 | DWARF2_EH_FRAME | |
833 | }; | |
834 | ||
835 | extern void dwarf2_get_section_info (struct objfile *, | |
287de656 | 836 | enum dwarf2_section_enum, |
18038e63 TT |
837 | asection **, const gdb_byte **, |
838 | bfd_size_type *); | |
839 | ||
e7e7469e BL |
840 | /* Return true if the producer of the inferior is clang. */ |
841 | extern bool producer_is_clang (struct dwarf2_cu *cu); | |
842 | ||
6acd95be SM |
843 | /* Interface for DWARF indexing methods. */ |
844 | ||
845 | struct dwarf2_base_index_functions : public quick_symbol_functions | |
846 | { | |
847 | bool has_symbols (struct objfile *objfile) override; | |
848 | ||
849 | bool has_unexpanded_symtabs (struct objfile *objfile) override; | |
850 | ||
851 | struct symtab *find_last_source_symtab (struct objfile *objfile) override; | |
852 | ||
853 | void forget_cached_source_info (struct objfile *objfile) override; | |
854 | ||
855 | enum language lookup_global_symbol_language (struct objfile *objfile, | |
856 | const char *name, | |
857 | domain_enum domain, | |
858 | bool *symbol_found_p) override | |
859 | { | |
860 | *symbol_found_p = false; | |
861 | return language_unknown; | |
862 | } | |
863 | ||
864 | void print_stats (struct objfile *objfile, bool print_bcache) override; | |
865 | ||
866 | void expand_all_symtabs (struct objfile *objfile) override; | |
867 | ||
868 | /* A helper function that finds the per-cu object from an "adjusted" | |
869 | PC -- a PC with the base text offset removed. */ | |
870 | virtual dwarf2_per_cu_data *find_per_cu (dwarf2_per_bfd *per_bfd, | |
871 | CORE_ADDR adjusted_pc); | |
872 | ||
873 | struct compunit_symtab *find_pc_sect_compunit_symtab | |
874 | (struct objfile *objfile, struct bound_minimal_symbol msymbol, | |
875 | CORE_ADDR pc, struct obj_section *section, int warn_if_readin) | |
876 | override final; | |
877 | ||
878 | struct compunit_symtab *find_compunit_symtab_by_address | |
879 | (struct objfile *objfile, CORE_ADDR address) override | |
880 | { | |
881 | return nullptr; | |
882 | } | |
883 | ||
884 | void map_symbol_filenames (struct objfile *objfile, | |
885 | gdb::function_view<symbol_filename_ftype> fun, | |
886 | bool need_fullname) override; | |
887 | }; | |
888 | ||
889 | /* If FILE_MATCHER is NULL or if PER_CU has | |
890 | dwarf2_per_cu_quick_data::MARK set (see | |
891 | dw_expand_symtabs_matching_file_matcher), expand the CU and call | |
892 | EXPANSION_NOTIFY on it. */ | |
893 | ||
894 | extern bool dw2_expand_symtabs_matching_one | |
895 | (dwarf2_per_cu_data *per_cu, | |
896 | dwarf2_per_objfile *per_objfile, | |
897 | gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher, | |
898 | gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify); | |
899 | ||
900 | /* Helper for dw2_expand_symtabs_matching that works with a | |
901 | mapped_index_base instead of the containing objfile. This is split | |
902 | to a separate function in order to be able to unit test the | |
903 | name_components matching using a mock mapped_index_base. For each | |
904 | symbol name that matches, calls MATCH_CALLBACK, passing it the | |
905 | symbol's index in the mapped_index_base symbol table. */ | |
906 | ||
907 | extern bool dw2_expand_symtabs_matching_symbol | |
908 | (mapped_index_base &index, | |
909 | const lookup_name_info &lookup_name_in, | |
910 | gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher, | |
911 | gdb::function_view<bool (offset_type)> match_callback, | |
912 | dwarf2_per_objfile *per_objfile); | |
913 | ||
914 | /* If FILE_MATCHER is non-NULL, set all the | |
915 | dwarf2_per_cu_quick_data::MARK of the current DWARF2_PER_OBJFILE | |
916 | that match FILE_MATCHER. */ | |
917 | ||
918 | extern void dw_expand_symtabs_matching_file_matcher | |
919 | (dwarf2_per_objfile *per_objfile, | |
920 | gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher); | |
921 | ||
922 | /* Return pointer to string at .debug_str offset STR_OFFSET. */ | |
923 | ||
924 | extern const char *read_indirect_string_at_offset | |
925 | (dwarf2_per_objfile *per_objfile, LONGEST str_offset); | |
926 | ||
927 | /* Allocate a hash table for signatured types. */ | |
928 | ||
929 | extern htab_up allocate_signatured_type_table (); | |
930 | ||
931 | /* Return a new dwarf2_per_cu_data allocated on the per-bfd | |
932 | obstack, and constructed with the specified field values. */ | |
933 | ||
934 | extern dwarf2_per_cu_data_up create_cu_from_index_list | |
935 | (dwarf2_per_bfd *per_bfd, struct dwarf2_section_info *section, | |
936 | int is_dwz, sect_offset sect_off, ULONGEST length); | |
937 | ||
938 | /* Initialize the views on all_units. */ | |
939 | ||
940 | extern void finalize_all_units (dwarf2_per_bfd *per_bfd); | |
941 | ||
942 | /* Create a quick_file_names hash table. */ | |
943 | ||
944 | extern htab_up create_quick_file_names_table (unsigned int nr_initial_entries); | |
945 | ||
946 | /* Read the address map data from DWARF-5 .debug_aranges, and use it | |
947 | to populate given addrmap. Returns true on success, false on | |
948 | failure. */ | |
949 | ||
950 | extern bool read_addrmap_from_aranges (dwarf2_per_objfile *per_objfile, | |
951 | dwarf2_section_info *section, | |
952 | addrmap *mutable_map); | |
953 | ||
cd4fb1b2 | 954 | #endif /* DWARF2READ_H */ |