1 // gdb-index.cc -- generate .gdb_index section for fast debug lookup
3 // Copyright 2012 Free Software Foundation, Inc.
4 // Written by Cary Coutant <ccoutant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
25 #include "gdb-index.h"
26 #include "dwarf_reader.h"
35 const int gdb_index_version = 5;
37 // Sizes of various records in the .gdb_index section.
38 const int gdb_index_offset_size = 4;
39 const int gdb_index_hdr_size = 6 * gdb_index_offset_size;
40 const int gdb_index_cu_size = 16;
41 const int gdb_index_tu_size = 24;
42 const int gdb_index_addr_size = 16 + gdb_index_offset_size;
43 const int gdb_index_sym_size = 2 * gdb_index_offset_size;
45 // This class manages the hashed symbol table for the .gdb_index section.
46 // It is essentially equivalent to the hashtab implementation in libiberty,
47 // but is copied into gdb sources and here for compatibility because its
48 // data structure is exposed on disk.
55 : size_(0), capacity_(0), hashtab_(NULL)
60 for (size_t i = 0; i < this->capacity_; ++i)
61 if (this->hashtab_[i] != NULL)
62 delete this->hashtab_[i];
63 delete[] this->hashtab_;
70 // Resize the hash table if necessary.
71 if (4 * this->size_ / 3 >= this->capacity_)
74 T** slot = this->find_slot(symbol);
84 // Return the current size.
87 { return this->size_; }
89 // Return the current capacity.
92 { return this->capacity_; }
94 // Return the contents of slot N.
97 { return this->hashtab_[n]; }
100 // Find a symbol in the hash table, or return an empty slot if
101 // the symbol is not in the table.
105 unsigned int index = symbol->hash() & (this->capacity_ - 1);
106 unsigned int step = ((symbol->hash() * 17) & (this->capacity_ - 1)) | 1;
110 if (this->hashtab_[index] == NULL
111 || this->hashtab_[index]->equal(symbol))
112 return &this->hashtab_[index];
113 index = (index + step) & (this->capacity_ - 1);
117 // Expand the hash table.
121 if (this->capacity_ == 0)
123 // Allocate the hash table for the first time.
124 this->capacity_ = Gdb_hashtab::initial_size;
125 this->hashtab_ = new T*[this->capacity_];
126 memset(this->hashtab_, 0, this->capacity_ * sizeof(T*));
130 // Expand and rehash.
131 unsigned int old_cap = this->capacity_;
132 T** old_hashtab = this->hashtab_;
133 this->capacity_ *= 2;
134 this->hashtab_ = new T*[this->capacity_];
135 memset(this->hashtab_, 0, this->capacity_ * sizeof(T*));
136 for (size_t i = 0; i < old_cap; ++i)
138 if (old_hashtab[i] != NULL)
140 T** slot = this->find_slot(old_hashtab[i]);
141 *slot = old_hashtab[i];
144 delete[] old_hashtab;
148 // Initial size of the hash table; must be a power of 2.
149 static const int initial_size = 1024;
155 // The hash function for strings in the mapped index. This is copied
156 // directly from gdb/dwarf2read.c.
159 mapped_index_string_hash(const unsigned char* str)
164 while ((c = *str++) != 0)
166 if (gdb_index_version >= 5)
168 r = r * 67 + c - 113;
174 // A specialization of Dwarf_info_reader, for building the .gdb_index.
176 class Gdb_index_info_reader : public Dwarf_info_reader
179 Gdb_index_info_reader(bool is_type_unit,
181 const unsigned char* symbols,
184 unsigned int reloc_shndx,
185 unsigned int reloc_type,
186 Gdb_index* gdb_index)
187 : Dwarf_info_reader(is_type_unit, object, symbols, symbols_size, shndx,
188 reloc_shndx, reloc_type),
189 gdb_index_(gdb_index), cu_index_(0), cu_language_(0)
192 ~Gdb_index_info_reader()
193 { this->clear_declarations(); }
195 // Print usage statistics.
200 // Visit a compilation unit.
202 visit_compilation_unit(off_t cu_offset, off_t cu_length, Dwarf_die*);
204 // Visit a type unit.
206 visit_type_unit(off_t tu_offset, off_t tu_length, off_t type_offset,
207 uint64_t signature, Dwarf_die*);
210 // A map for recording DIEs we've seen that may be referred to be
211 // later DIEs (via DW_AT_specification or DW_AT_abstract_origin).
212 // The map is indexed by a DIE offset within the compile unit.
213 // PARENT_OFFSET_ is the offset of the DIE that represents the
214 // outer context, and NAME_ is a pointer to a component of the
215 // fully-qualified name.
216 // Normally, the names we point to are in a string table, so we don't
217 // have to manage them, but when we have a fully-qualified name
218 // computed, we put it in the table, and set PARENT_OFFSET_ to -1
219 // indicate a string that we are managing.
220 struct Declaration_pair
222 Declaration_pair(off_t parent_offset, const char* name)
223 : parent_offset_(parent_offset), name_(name)
226 off_t parent_offset_;
229 typedef Unordered_map<off_t, Declaration_pair> Declaration_map;
231 // Visit a top-level DIE.
233 visit_top_die(Dwarf_die* die);
235 // Visit the children of a DIE.
237 visit_children(Dwarf_die* die, Dwarf_die* context);
241 visit_die(Dwarf_die* die, Dwarf_die* context);
243 // Visit the children of a DIE.
245 visit_children_for_decls(Dwarf_die* die);
249 visit_die_for_decls(Dwarf_die* die, Dwarf_die* context);
251 // Guess a fully-qualified name for a class type, based on member function
254 guess_full_class_name(Dwarf_die* die);
256 // Add a declaration DIE to the table of declarations.
258 add_declaration(Dwarf_die* die, Dwarf_die* context);
260 // Add a declaration whose fully-qualified name is already known.
262 add_declaration_with_full_name(Dwarf_die* die, const char* full_name);
264 // Return the context for a DIE whose parent is at DIE_OFFSET.
266 get_context(off_t die_offset);
268 // Construct a fully-qualified name for DIE.
270 get_qualified_name(Dwarf_die* die, Dwarf_die* context);
272 // Record the address ranges for a compilation unit.
274 record_cu_ranges(Dwarf_die* die);
276 // Read the .debug_pubnames and .debug_pubtypes tables.
278 read_pubnames_and_pubtypes(Dwarf_die* die);
280 // Clear the declarations map.
282 clear_declarations();
284 // The Gdb_index section.
285 Gdb_index* gdb_index_;
286 // The current CU index (negative for a TU).
288 // The language of the current CU or TU.
289 unsigned int cu_language_;
290 // Map from DIE offset to (parent offset, name) pair,
291 // for DW_AT_specification.
292 Declaration_map declarations_;
295 // Total number of DWARF compilation units processed.
296 static unsigned int dwarf_cu_count;
297 // Number of DWARF compilation units with pubnames/pubtypes.
298 static unsigned int dwarf_cu_nopubnames_count;
299 // Total number of DWARF type units processed.
300 static unsigned int dwarf_tu_count;
301 // Number of DWARF type units with pubnames/pubtypes.
302 static unsigned int dwarf_tu_nopubnames_count;
305 // Total number of DWARF compilation units processed.
306 unsigned int Gdb_index_info_reader::dwarf_cu_count = 0;
307 // Number of DWARF compilation units without pubnames/pubtypes.
308 unsigned int Gdb_index_info_reader::dwarf_cu_nopubnames_count = 0;
309 // Total number of DWARF type units processed.
310 unsigned int Gdb_index_info_reader::dwarf_tu_count = 0;
311 // Number of DWARF type units without pubnames/pubtypes.
312 unsigned int Gdb_index_info_reader::dwarf_tu_nopubnames_count = 0;
314 // Process a compilation unit and parse its child DIE.
317 Gdb_index_info_reader::visit_compilation_unit(off_t cu_offset, off_t cu_length,
320 ++Gdb_index_info_reader::dwarf_cu_count;
321 this->cu_index_ = this->gdb_index_->add_comp_unit(cu_offset, cu_length);
322 this->visit_top_die(root_die);
325 // Process a type unit and parse its child DIE.
328 Gdb_index_info_reader::visit_type_unit(off_t tu_offset, off_t,
329 off_t type_offset, uint64_t signature,
332 ++Gdb_index_info_reader::dwarf_tu_count;
333 // Use a negative index to flag this as a TU instead of a CU.
334 this->cu_index_ = -1 - this->gdb_index_->add_type_unit(tu_offset, type_offset,
336 this->visit_top_die(root_die);
339 // Process a top-level DIE.
340 // For compile_unit DIEs, record the address ranges. For all
341 // interesting tags, add qualified names to the symbol table
342 // and process interesting children. We may need to process
343 // certain children just for saving declarations that might be
344 // referenced by later DIEs with a DW_AT_specification attribute.
347 Gdb_index_info_reader::visit_top_die(Dwarf_die* die)
349 this->clear_declarations();
353 case elfcpp::DW_TAG_compile_unit:
354 case elfcpp::DW_TAG_type_unit:
355 this->cu_language_ = die->int_attribute(elfcpp::DW_AT_language);
356 // Check for languages that require specialized knowledge to
357 // construct fully-qualified names, that we don't yet support.
358 if (this->cu_language_ == elfcpp::DW_LANG_Ada83
359 || this->cu_language_ == elfcpp::DW_LANG_Fortran77
360 || this->cu_language_ == elfcpp::DW_LANG_Fortran90
361 || this->cu_language_ == elfcpp::DW_LANG_Java
362 || this->cu_language_ == elfcpp::DW_LANG_Ada95
363 || this->cu_language_ == elfcpp::DW_LANG_Fortran95)
365 gold_warning(_("%s: --gdb-index currently supports "
366 "only C and C++ languages"),
367 this->object()->name().c_str());
370 if (die->tag() == elfcpp::DW_TAG_compile_unit)
371 this->record_cu_ranges(die);
372 // If there is a pubnames and/or pubtypes section for this
373 // compilation unit, use those; otherwise, parse the DWARF
374 // info to extract the names.
375 if (!this->read_pubnames_and_pubtypes(die))
377 if (die->tag() == elfcpp::DW_TAG_compile_unit)
378 ++Gdb_index_info_reader::dwarf_cu_nopubnames_count;
380 ++Gdb_index_info_reader::dwarf_tu_nopubnames_count;
381 this->visit_children(die, NULL);
385 // The top level DIE should be one of the above.
386 gold_warning(_("%s: top level DIE is not DW_TAG_compile_unit "
387 "or DW_TAG_type_unit"),
388 this->object()->name().c_str());
394 // Visit the children of PARENT, looking for symbols to add to the index.
395 // CONTEXT points to the DIE to use for constructing the qualified name --
396 // NULL if PARENT is the top-level DIE; otherwise it is the same as PARENT.
399 Gdb_index_info_reader::visit_children(Dwarf_die* parent, Dwarf_die* context)
401 off_t next_offset = 0;
402 for (off_t die_offset = parent->child_offset();
404 die_offset = next_offset)
406 Dwarf_die die(this, die_offset, parent);
409 this->visit_die(&die, context);
410 next_offset = die.sibling_offset();
414 // Visit a child DIE, looking for symbols to add to the index.
415 // CONTEXT is the parent DIE, used for constructing the qualified name;
416 // it is NULL if the parent DIE is the top-level DIE.
419 Gdb_index_info_reader::visit_die(Dwarf_die* die, Dwarf_die* context)
423 case elfcpp::DW_TAG_subprogram:
424 case elfcpp::DW_TAG_constant:
425 case elfcpp::DW_TAG_variable:
426 case elfcpp::DW_TAG_enumerator:
427 case elfcpp::DW_TAG_base_type:
428 if (die->is_declaration())
429 this->add_declaration(die, context);
432 // If the DIE is not a declaration, add it to the index.
433 std::string full_name = this->get_qualified_name(die, context);
434 if (!full_name.empty())
435 this->gdb_index_->add_symbol(this->cu_index_, full_name.c_str());
438 case elfcpp::DW_TAG_typedef:
439 case elfcpp::DW_TAG_union_type:
440 case elfcpp::DW_TAG_class_type:
441 case elfcpp::DW_TAG_interface_type:
442 case elfcpp::DW_TAG_structure_type:
443 case elfcpp::DW_TAG_enumeration_type:
444 case elfcpp::DW_TAG_subrange_type:
445 case elfcpp::DW_TAG_namespace:
447 std::string full_name;
449 // For classes at the top level, we need to look for a
450 // member function with a linkage name in order to get
451 // the properly-canonicalized name.
453 && (die->tag() == elfcpp::DW_TAG_class_type
454 || die->tag() == elfcpp::DW_TAG_structure_type
455 || die->tag() == elfcpp::DW_TAG_union_type))
456 full_name.assign(this->guess_full_class_name(die));
458 // Because we will visit the children, we need to add this DIE
459 // to the declarations table.
460 if (full_name.empty())
461 this->add_declaration(die, context);
463 this->add_declaration_with_full_name(die, full_name.c_str());
465 // If the DIE is not a declaration, add it to the index.
466 // Gdb stores a namespace in the index even when it is
468 if (die->tag() == elfcpp::DW_TAG_namespace
469 || !die->is_declaration())
471 if (full_name.empty())
472 full_name = this->get_qualified_name(die, context);
473 if (!full_name.empty())
474 this->gdb_index_->add_symbol(this->cu_index_,
478 // We're interested in the children only for namespaces and
479 // enumeration types. For enumeration types, we do not include
480 // the enumeration tag as part of the full name. For other tags,
481 // visit the children only to collect declarations.
482 if (die->tag() == elfcpp::DW_TAG_namespace
483 || die->tag() == elfcpp::DW_TAG_enumeration_type)
484 this->visit_children(die, die);
486 this->visit_children_for_decls(die);
494 // Visit the children of PARENT, looking only for declarations that
495 // may be referenced by later specification DIEs.
498 Gdb_index_info_reader::visit_children_for_decls(Dwarf_die* parent)
500 off_t next_offset = 0;
501 for (off_t die_offset = parent->child_offset();
503 die_offset = next_offset)
505 Dwarf_die die(this, die_offset, parent);
508 this->visit_die_for_decls(&die, parent);
509 next_offset = die.sibling_offset();
513 // Visit a child DIE, looking only for declarations that
514 // may be referenced by later specification DIEs.
517 Gdb_index_info_reader::visit_die_for_decls(Dwarf_die* die, Dwarf_die* context)
521 case elfcpp::DW_TAG_subprogram:
522 case elfcpp::DW_TAG_constant:
523 case elfcpp::DW_TAG_variable:
524 case elfcpp::DW_TAG_enumerator:
525 case elfcpp::DW_TAG_base_type:
527 if (die->is_declaration())
528 this->add_declaration(die, context);
531 case elfcpp::DW_TAG_typedef:
532 case elfcpp::DW_TAG_union_type:
533 case elfcpp::DW_TAG_class_type:
534 case elfcpp::DW_TAG_interface_type:
535 case elfcpp::DW_TAG_structure_type:
536 case elfcpp::DW_TAG_enumeration_type:
537 case elfcpp::DW_TAG_subrange_type:
538 case elfcpp::DW_TAG_namespace:
540 if (die->is_declaration())
541 this->add_declaration(die, context);
542 this->visit_children_for_decls(die);
550 // Extract the class name from the linkage name of a member function.
551 // This code is adapted from ../gdb/cp-support.c.
553 #define d_left(dc) (dc)->u.s_binary.left
554 #define d_right(dc) (dc)->u.s_binary.right
557 class_name_from_linkage_name(const char* linkage_name)
560 struct demangle_component* tree =
561 cplus_demangle_v3_components(linkage_name, DMGL_NO_OPTS, &storage);
567 // First strip off any qualifiers, if we have a function or
572 case DEMANGLE_COMPONENT_CONST:
573 case DEMANGLE_COMPONENT_RESTRICT:
574 case DEMANGLE_COMPONENT_VOLATILE:
575 case DEMANGLE_COMPONENT_CONST_THIS:
576 case DEMANGLE_COMPONENT_RESTRICT_THIS:
577 case DEMANGLE_COMPONENT_VOLATILE_THIS:
578 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
586 // If what we have now is a function, discard the argument list.
587 if (tree->type == DEMANGLE_COMPONENT_TYPED_NAME)
590 // If what we have now is a template, strip off the template
591 // arguments. The left subtree may be a qualified name.
592 if (tree->type == DEMANGLE_COMPONENT_TEMPLATE)
595 // What we have now should be a name, possibly qualified.
596 // Additional qualifiers could live in the left subtree or the right
597 // subtree. Find the last piece.
599 struct demangle_component* prev_comp = NULL;
600 struct demangle_component* cur_comp = tree;
602 switch (cur_comp->type)
604 case DEMANGLE_COMPONENT_QUAL_NAME:
605 case DEMANGLE_COMPONENT_LOCAL_NAME:
606 prev_comp = cur_comp;
607 cur_comp = d_right(cur_comp);
609 case DEMANGLE_COMPONENT_TEMPLATE:
610 case DEMANGLE_COMPONENT_NAME:
611 case DEMANGLE_COMPONENT_CTOR:
612 case DEMANGLE_COMPONENT_DTOR:
613 case DEMANGLE_COMPONENT_OPERATOR:
614 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
624 if (cur_comp != NULL && prev_comp != NULL)
626 // We want to discard the rightmost child of PREV_COMP.
627 *prev_comp = *d_left(prev_comp);
628 size_t allocated_size;
629 ret = cplus_demangle_print(DMGL_NO_OPTS, tree, 30, &allocated_size);
636 // Guess a fully-qualified name for a class type, based on member function
637 // linkage names. This is needed for class/struct/union types at the
638 // top level, because GCC does not always properly embed them within
639 // the namespace. As in gdb, we look for a member function with a linkage
640 // name and extract the qualified name from the demangled name.
643 Gdb_index_info_reader::guess_full_class_name(Dwarf_die* die)
645 std::string full_name;
646 off_t next_offset = 0;
648 // This routine scans ahead in the DIE structure, possibly advancing
649 // the relocation tracker beyond the current DIE. We need to checkpoint
650 // the tracker and reset it when we're done.
651 uint64_t checkpoint = this->get_reloc_checkpoint();
653 for (off_t child_offset = die->child_offset();
655 child_offset = next_offset)
657 Dwarf_die child(this, child_offset, die);
658 if (child.tag() == 0)
660 if (child.tag() == elfcpp::DW_TAG_subprogram)
662 const char* linkage_name = child.linkage_name();
663 if (linkage_name != NULL)
665 char* guess = class_name_from_linkage_name(linkage_name);
668 full_name.assign(guess);
674 next_offset = child.sibling_offset();
677 this->reset_relocs(checkpoint);
681 // Add a declaration DIE to the table of declarations.
684 Gdb_index_info_reader::add_declaration(Dwarf_die* die, Dwarf_die* context)
686 const char* name = die->name();
688 off_t parent_offset = context != NULL ? context->offset() : 0;
690 // If this DIE has a DW_AT_specification or DW_AT_abstract_origin
691 // attribute, use the parent and name from the earlier declaration.
692 off_t spec = die->specification();
694 spec = die->abstract_origin();
697 Declaration_map::iterator it = this->declarations_.find(spec);
698 if (it != this->declarations_.end())
700 parent_offset = it->second.parent_offset_;
701 name = it->second.name_;
707 if (die->tag() == elfcpp::DW_TAG_namespace)
708 name = "(anonymous namespace)";
709 else if (die->tag() == elfcpp::DW_TAG_union_type)
710 name = "(anonymous union)";
715 Declaration_pair decl(parent_offset, name);
716 this->declarations_.insert(std::make_pair(die->offset(), decl));
719 // Add a declaration whose fully-qualified name is already known.
720 // In the case where we had to get the canonical name by demangling
721 // a linkage name, this ensures we use that name instead of the one
722 // provided in DW_AT_name.
725 Gdb_index_info_reader::add_declaration_with_full_name(
727 const char* full_name)
729 // We need to copy the name.
730 int len = strlen(full_name);
731 char* copy = new char[len + 1];
732 memcpy(copy, full_name, len + 1);
734 // Flag that we now manage the memory this points to.
735 Declaration_pair decl(-1, copy);
736 this->declarations_.insert(std::make_pair(die->offset(), decl));
739 // Return the context for a DIE whose parent is at DIE_OFFSET.
742 Gdb_index_info_reader::get_context(off_t die_offset)
745 Declaration_map::iterator it = this->declarations_.find(die_offset);
746 if (it != this->declarations_.end())
748 off_t parent_offset = it->second.parent_offset_;
749 if (parent_offset > 0)
751 context = get_context(parent_offset);
752 context.append("::");
754 if (it->second.name_ != NULL)
755 context.append(it->second.name_);
760 // Construct the fully-qualified name for DIE.
763 Gdb_index_info_reader::get_qualified_name(Dwarf_die* die, Dwarf_die* context)
765 std::string full_name;
766 const char* name = die->name();
768 off_t parent_offset = context != NULL ? context->offset() : 0;
770 // If this DIE has a DW_AT_specification or DW_AT_abstract_origin
771 // attribute, use the parent and name from the earlier declaration.
772 off_t spec = die->specification();
774 spec = die->abstract_origin();
777 Declaration_map::iterator it = this->declarations_.find(spec);
778 if (it != this->declarations_.end())
780 parent_offset = it->second.parent_offset_;
781 name = it->second.name_;
785 if (name == NULL && die->tag() == elfcpp::DW_TAG_namespace)
786 name = "(anonymous namespace)";
787 else if (name == NULL)
790 // If this is an enumerator constant, skip the immediate parent,
791 // which is the enumeration tag.
792 if (die->tag() == elfcpp::DW_TAG_enumerator)
794 Declaration_map::iterator it = this->declarations_.find(parent_offset);
795 if (it != this->declarations_.end())
796 parent_offset = it->second.parent_offset_;
799 if (parent_offset > 0)
801 full_name.assign(this->get_context(parent_offset));
802 full_name.append("::");
804 full_name.append(name);
809 // Record the address ranges for a compilation unit.
812 Gdb_index_info_reader::record_cu_ranges(Dwarf_die* die)
817 off_t ranges_offset = die->ref_attribute(elfcpp::DW_AT_ranges, &shndx);
818 if (ranges_offset != -1)
820 Dwarf_range_list* ranges = this->read_range_list(shndx, ranges_offset);
822 this->gdb_index_->add_address_range_list(this->object(),
823 this->cu_index_, ranges);
827 off_t low_pc = die->address_attribute(elfcpp::DW_AT_low_pc, &shndx);
828 off_t high_pc = die->address_attribute(elfcpp::DW_AT_high_pc, &shndx2);
831 high_pc = die->uint_attribute(elfcpp::DW_AT_high_pc);
835 if ((low_pc != 0 || high_pc != 0) && low_pc != -1)
839 gold_warning(_("%s: DWARF info may be corrupt; low_pc and high_pc "
840 "are in different sections"),
841 this->object()->name().c_str());
844 if (shndx == 0 || this->object()->is_section_included(shndx))
846 Dwarf_range_list* ranges = new Dwarf_range_list();
847 ranges->add(shndx, low_pc, high_pc);
848 this->gdb_index_->add_address_range_list(this->object(),
849 this->cu_index_, ranges);
854 // Read the .debug_pubnames and .debug_pubtypes tables for the CU or TU.
855 // Returns TRUE if either a pubnames or pubtypes section was found.
858 Gdb_index_info_reader::read_pubnames_and_pubtypes(Dwarf_die* die)
862 // If we find a DW_AT_GNU_pubnames attribute, read the pubnames table.
863 unsigned int pubnames_shndx;
864 off_t pubnames_offset = die->ref_attribute(elfcpp::DW_AT_GNU_pubnames,
866 if (pubnames_offset != -1)
868 if (this->gdb_index_->pubnames_read(this->object(), pubnames_shndx,
873 Dwarf_pubnames_table pubnames(this, false);
874 if (!pubnames.read_section(this->object(), pubnames_shndx))
876 if (!pubnames.read_header(pubnames_offset))
880 const char* name = pubnames.next_name();
883 this->gdb_index_->add_symbol(this->cu_index_, name);
889 // If we find a DW_AT_GNU_pubtypes attribute, read the pubtypes table.
890 unsigned int pubtypes_shndx;
891 off_t pubtypes_offset = die->ref_attribute(elfcpp::DW_AT_GNU_pubtypes,
893 if (pubtypes_offset != -1)
895 if (this->gdb_index_->pubtypes_read(this->object(),
896 pubtypes_shndx, pubtypes_offset))
900 Dwarf_pubnames_table pubtypes(this, true);
901 if (!pubtypes.read_section(this->object(), pubtypes_shndx))
903 if (!pubtypes.read_header(pubtypes_offset))
907 const char* name = pubtypes.next_name();
910 this->gdb_index_->add_symbol(this->cu_index_, name);
919 // Clear the declarations map.
921 Gdb_index_info_reader::clear_declarations()
923 // Free strings in memory we manage.
924 for (Declaration_map::iterator it = this->declarations_.begin();
925 it != this->declarations_.end();
928 if (it->second.parent_offset_ == -1)
929 delete[] it->second.name_;
932 this->declarations_.clear();
935 // Print usage statistics.
937 Gdb_index_info_reader::print_stats()
939 fprintf(stderr, _("%s: DWARF CUs: %u\n"),
940 program_name, Gdb_index_info_reader::dwarf_cu_count);
941 fprintf(stderr, _("%s: DWARF CUs without pubnames/pubtypes: %u\n"),
942 program_name, Gdb_index_info_reader::dwarf_cu_nopubnames_count);
943 fprintf(stderr, _("%s: DWARF TUs: %u\n"),
944 program_name, Gdb_index_info_reader::dwarf_tu_count);
945 fprintf(stderr, _("%s: DWARF TUs without pubnames/pubtypes: %u\n"),
946 program_name, Gdb_index_info_reader::dwarf_tu_nopubnames_count);
951 // Construct the .gdb_index section.
953 Gdb_index::Gdb_index(Output_section* gdb_index_section)
954 : Output_section_data(4),
955 gdb_index_section_(gdb_index_section),
960 cu_vector_offsets_(NULL),
966 stringpool_offset_(0),
967 pubnames_object_(NULL),
970 pubtypes_object_(NULL),
974 this->gdb_symtab_ = new Gdb_hashtab<Gdb_symbol>();
977 Gdb_index::~Gdb_index()
979 // Free the memory used by the symbol table.
980 delete this->gdb_symtab_;
981 // Free the memory used by the CU vectors.
982 for (unsigned int i = 0; i < this->cu_vector_list_.size(); ++i)
983 delete this->cu_vector_list_[i];
986 // Scan a .debug_info or .debug_types input section.
989 Gdb_index::scan_debug_info(bool is_type_unit,
991 const unsigned char* symbols,
994 unsigned int reloc_shndx,
995 unsigned int reloc_type)
997 Gdb_index_info_reader dwinfo(is_type_unit, object,
998 symbols, symbols_size,
1007 Gdb_index::add_symbol(int cu_index, const char* sym_name)
1009 unsigned int hash = mapped_index_string_hash(
1010 reinterpret_cast<const unsigned char*>(sym_name));
1011 Gdb_symbol* sym = new Gdb_symbol();
1012 this->stringpool_.add(sym_name, true, &sym->name_key);
1013 sym->hashval = hash;
1014 sym->cu_vector_index = 0;
1016 Gdb_symbol* found = this->gdb_symtab_->add(sym);
1019 // New symbol -- allocate a new CU index vector.
1020 found->cu_vector_index = this->cu_vector_list_.size();
1021 this->cu_vector_list_.push_back(new Cu_vector());
1025 // Found an existing symbol -- append to the existing
1030 // Add the CU index to the vector list for this symbol,
1031 // if it's not already on the list. We only need to
1032 // check the last added entry.
1033 Cu_vector* cu_vec = this->cu_vector_list_[found->cu_vector_index];
1034 if (cu_vec->size() == 0 || cu_vec->back() != cu_index)
1035 cu_vec->push_back(cu_index);
1038 // Return TRUE if we have already processed the pubnames set at
1039 // OFFSET in section SHNDX
1042 Gdb_index::pubnames_read(const Relobj* object, unsigned int shndx, off_t offset)
1044 bool ret = (this->pubnames_object_ == object
1045 && this->pubnames_shndx_ == shndx
1046 && this->pubnames_offset_ == offset);
1047 this->pubnames_object_ = object;
1048 this->pubnames_shndx_ = shndx;
1049 this->pubnames_offset_ = offset;
1053 // Return TRUE if we have already processed the pubtypes set at
1054 // OFFSET in section SHNDX
1057 Gdb_index::pubtypes_read(const Relobj* object, unsigned int shndx, off_t offset)
1059 bool ret = (this->pubtypes_object_ == object
1060 && this->pubtypes_shndx_ == shndx
1061 && this->pubtypes_offset_ == offset);
1062 this->pubtypes_object_ = object;
1063 this->pubtypes_shndx_ = shndx;
1064 this->pubtypes_offset_ = offset;
1068 // Set the size of the .gdb_index section.
1071 Gdb_index::set_final_data_size()
1073 // Finalize the string pool.
1074 this->stringpool_.set_string_offsets();
1076 // Compute the total size of the CU vectors.
1077 // For each CU vector, include one entry for the count at the
1078 // beginning of the vector.
1079 unsigned int cu_vector_count = this->cu_vector_list_.size();
1080 unsigned int cu_vector_size = 0;
1081 this->cu_vector_offsets_ = new off_t[cu_vector_count];
1082 for (unsigned int i = 0; i < cu_vector_count; ++i)
1084 Cu_vector* cu_vec = this->cu_vector_list_[i];
1085 cu_vector_offsets_[i] = cu_vector_size;
1086 cu_vector_size += gdb_index_offset_size * (cu_vec->size() + 1);
1089 // Assign relative offsets to each portion of the index,
1090 // and find the total size of the section.
1091 section_size_type data_size = gdb_index_hdr_size;
1092 data_size += this->comp_units_.size() * gdb_index_cu_size;
1093 this->tu_offset_ = data_size;
1094 data_size += this->type_units_.size() * gdb_index_tu_size;
1095 this->addr_offset_ = data_size;
1096 for (unsigned int i = 0; i < this->ranges_.size(); ++i)
1097 data_size += this->ranges_[i].ranges->size() * gdb_index_addr_size;
1098 this->symtab_offset_ = data_size;
1099 data_size += this->gdb_symtab_->capacity() * gdb_index_sym_size;
1100 this->cu_pool_offset_ = data_size;
1101 data_size += cu_vector_size;
1102 this->stringpool_offset_ = data_size;
1103 data_size += this->stringpool_.get_strtab_size();
1105 this->set_data_size(data_size);
1108 // Write the data to the file.
1111 Gdb_index::do_write(Output_file* of)
1113 const off_t off = this->offset();
1114 const off_t oview_size = this->data_size();
1115 unsigned char* const oview = of->get_output_view(off, oview_size);
1116 unsigned char* pov = oview;
1118 // Write the file header.
1119 // (1) Version number.
1120 elfcpp::Swap<32, false>::writeval(pov, gdb_index_version);
1122 // (2) Offset of the CU list.
1123 elfcpp::Swap<32, false>::writeval(pov, gdb_index_hdr_size);
1125 // (3) Offset of the types CU list.
1126 elfcpp::Swap<32, false>::writeval(pov, this->tu_offset_);
1128 // (4) Offset of the address area.
1129 elfcpp::Swap<32, false>::writeval(pov, this->addr_offset_);
1131 // (5) Offset of the symbol table.
1132 elfcpp::Swap<32, false>::writeval(pov, this->symtab_offset_);
1134 // (6) Offset of the constant pool.
1135 elfcpp::Swap<32, false>::writeval(pov, this->cu_pool_offset_);
1138 gold_assert(pov - oview == gdb_index_hdr_size);
1140 // Write the CU list.
1141 unsigned int comp_units_count = this->comp_units_.size();
1142 for (unsigned int i = 0; i < comp_units_count; ++i)
1144 const Comp_unit& cu = this->comp_units_[i];
1145 elfcpp::Swap<64, false>::writeval(pov, cu.cu_offset);
1146 elfcpp::Swap<64, false>::writeval(pov + 8, cu.cu_length);
1150 gold_assert(pov - oview == this->tu_offset_);
1152 // Write the types CU list.
1153 for (unsigned int i = 0; i < this->type_units_.size(); ++i)
1155 const Type_unit& tu = this->type_units_[i];
1156 elfcpp::Swap<64, false>::writeval(pov, tu.tu_offset);
1157 elfcpp::Swap<64, false>::writeval(pov + 8, tu.type_offset);
1158 elfcpp::Swap<64, false>::writeval(pov + 16, tu.type_signature);
1162 gold_assert(pov - oview == this->addr_offset_);
1164 // Write the address area.
1165 for (unsigned int i = 0; i < this->ranges_.size(); ++i)
1167 int cu_index = this->ranges_[i].cu_index;
1168 // Translate negative indexes, which refer to a TU, to a
1169 // logical index into a concatenated CU/TU list.
1171 cu_index = comp_units_count + (-1 - cu_index);
1172 Relobj* object = this->ranges_[i].object;
1173 const Dwarf_range_list& ranges = *this->ranges_[i].ranges;
1174 for (unsigned int j = 0; j < ranges.size(); ++j)
1176 const Dwarf_range_list::Range& range = ranges[j];
1178 if (range.shndx > 0)
1180 const Output_section* os = object->output_section(range.shndx);
1181 base = (os->address()
1182 + object->output_section_offset(range.shndx));
1184 elfcpp::Swap_aligned32<64, false>::writeval(pov, base + range.start);
1185 elfcpp::Swap_aligned32<64, false>::writeval(pov + 8,
1187 elfcpp::Swap<32, false>::writeval(pov + 16, cu_index);
1192 gold_assert(pov - oview == this->symtab_offset_);
1194 // Write the symbol table.
1195 for (unsigned int i = 0; i < this->gdb_symtab_->capacity(); ++i)
1197 const Gdb_symbol* sym = (*this->gdb_symtab_)[i];
1198 section_offset_type name_offset = 0;
1199 unsigned int cu_vector_offset = 0;
1202 name_offset = (this->stringpool_.get_offset_from_key(sym->name_key)
1203 + this->stringpool_offset_ - this->cu_pool_offset_);
1204 cu_vector_offset = this->cu_vector_offsets_[sym->cu_vector_index];
1206 elfcpp::Swap<32, false>::writeval(pov, name_offset);
1207 elfcpp::Swap<32, false>::writeval(pov + 4, cu_vector_offset);
1211 gold_assert(pov - oview == this->cu_pool_offset_);
1213 // Write the CU vectors into the constant pool.
1214 for (unsigned int i = 0; i < this->cu_vector_list_.size(); ++i)
1216 Cu_vector* cu_vec = this->cu_vector_list_[i];
1217 elfcpp::Swap<32, false>::writeval(pov, cu_vec->size());
1219 for (unsigned int j = 0; j < cu_vec->size(); ++j)
1221 int cu_index = (*cu_vec)[j];
1223 cu_index = comp_units_count + (-1 - cu_index);
1224 elfcpp::Swap<32, false>::writeval(pov, cu_index);
1229 gold_assert(pov - oview == this->stringpool_offset_);
1231 // Write the strings into the constant pool.
1232 this->stringpool_.write_to_buffer(pov, oview_size - this->stringpool_offset_);
1234 of->write_output_view(off, oview_size, oview);
1237 // Print usage statistics.
1239 Gdb_index::print_stats()
1241 if (parameters->options().gdb_index())
1242 Gdb_index_info_reader::print_stats();
1245 } // End namespace gold.