Perform all tests in callfuncs.exp with and without C function prototypes
[binutils-gdb.git] / gold / dwp.cc
blob5401e0c6ee3e04a1c165a55abb367e75dcaa3017
1 // dwp.cc -- DWARF packaging utility
3 // Copyright (C) 2012-2014 Free Software Foundation, Inc.
4 // Written by Cary Coutant <ccoutant@google.com>.
6 // This file is part of dwp, the DWARF packaging utility.
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.
23 #include "dwp.h"
25 #include <cstdarg>
26 #include <cstddef>
27 #include <cstdio>
28 #include <cstdlib>
29 #include <cstring>
30 #include <cerrno>
32 #include <vector>
33 #include <algorithm>
35 #include "getopt.h"
36 #include "libiberty.h"
37 #include "../bfd/bfdver.h"
39 #include "elfcpp.h"
40 #include "elfcpp_file.h"
41 #include "dwarf.h"
42 #include "dirsearch.h"
43 #include "fileread.h"
44 #include "object.h"
45 #include "compressed_output.h"
46 #include "stringpool.h"
47 #include "dwarf_reader.h"
49 static void
50 usage(FILE* fd, int) ATTRIBUTE_NORETURN;
52 static void
53 print_version() ATTRIBUTE_NORETURN;
55 namespace gold {
57 class Dwp_output_file;
59 template <int size, bool big_endian>
60 class Sized_relobj_dwo;
62 // List of .dwo files to process.
63 struct Dwo_file_entry
65 Dwo_file_entry(uint64_t id, std::string name)
66 : dwo_id(id), dwo_name(name)
67 { }
68 uint64_t dwo_id;
69 std::string dwo_name;
71 typedef std::vector<Dwo_file_entry> File_list;
73 // Type to hold the offset and length of an input section
74 // within an output section.
76 struct Section_bounds
78 section_offset_type offset;
79 section_size_type size;
81 Section_bounds()
82 : offset(0), size(0)
83 { }
85 Section_bounds(section_offset_type o, section_size_type s)
86 : offset(o), size(s)
87 { }
90 // A set of sections for a compilation unit or type unit.
92 struct Unit_set
94 uint64_t signature;
95 Section_bounds sections[elfcpp::DW_SECT_MAX + 1];
97 Unit_set()
98 : signature(0), sections()
99 { }
102 // An input file.
103 // This class may represent a .dwo file, a .dwp file
104 // produced by an earlier run, or an executable file whose
105 // debug section identifies a set of .dwo files to read.
107 class Dwo_file
109 public:
110 Dwo_file(const char* name)
111 : name_(name), obj_(NULL), input_file_(NULL), is_compressed_(),
112 sect_offsets_(), str_offset_map_()
115 ~Dwo_file();
117 // Read the input executable file and extract the list of .dwo files
118 // that it references.
119 void
120 read_executable(File_list* files);
122 // Read the input file and send its contents to OUTPUT_FILE.
123 void
124 read(Dwp_output_file* output_file);
126 // Verify a .dwp file given a list of .dwo files referenced by the
127 // corresponding executable file. Returns true if no problems
128 // were found.
129 bool
130 verify(const File_list& files);
132 private:
133 // Types for mapping input string offsets to output string offsets.
134 typedef std::pair<section_offset_type, section_offset_type>
135 Str_offset_map_entry;
136 typedef std::vector<Str_offset_map_entry> Str_offset_map;
138 // A less-than comparison routine for Str_offset_map.
139 struct Offset_compare
141 bool
142 operator()(const Str_offset_map_entry& i1,
143 const Str_offset_map_entry& i2) const
144 { return i1.first < i2.first; }
147 // Create a Sized_relobj_dwo of the given size and endianness,
148 // and record the target info. P is a pointer to the ELF header
149 // in memory.
150 Relobj*
151 make_object(Dwp_output_file* output_file);
153 template <int size, bool big_endian>
154 Relobj*
155 sized_make_object(const unsigned char* p, Input_file* input_file,
156 Dwp_output_file* output_file);
158 // Return the number of sections in the input object file.
159 unsigned int
160 shnum() const
161 { return this->obj_->shnum(); }
163 // Return section type.
164 unsigned int
165 section_type(unsigned int shndx)
166 { return this->obj_->section_type(shndx); }
168 // Get the name of a section.
169 std::string
170 section_name(unsigned int shndx)
171 { return this->obj_->section_name(shndx); }
173 // Return a view of the contents of a section, decompressed if necessary.
174 // Set *PLEN to the size. Set *IS_NEW to true if the contents need to be
175 // deleted by the caller.
176 const unsigned char*
177 section_contents(unsigned int shndx, section_size_type* plen, bool* is_new)
178 { return this->obj_->decompressed_section_contents(shndx, plen, is_new); }
180 // Read the .debug_cu_index or .debug_tu_index section of a .dwp file,
181 // and process the CU or TU sets.
182 void
183 read_unit_index(unsigned int, unsigned int *, Dwp_output_file*,
184 bool is_tu_index);
186 template <bool big_endian>
187 void
188 sized_read_unit_index(unsigned int, unsigned int *, Dwp_output_file*,
189 bool is_tu_index);
191 // Verify the .debug_cu_index section of a .dwp file, comparing it
192 // against the list of .dwo files referenced by the corresponding
193 // executable file.
194 bool
195 verify_dwo_list(unsigned int, const File_list& files);
197 template <bool big_endian>
198 bool
199 sized_verify_dwo_list(unsigned int, const File_list& files);
201 // Merge the input string table section into the output file.
202 void
203 add_strings(Dwp_output_file*, unsigned int);
205 // Copy a section from the input file to the output file.
206 Section_bounds
207 copy_section(Dwp_output_file* output_file, unsigned int shndx,
208 elfcpp::DW_SECT section_id);
210 // Remap the string offsets in the .debug_str_offsets.dwo section.
211 const unsigned char*
212 remap_str_offsets(const unsigned char* contents, section_size_type len);
214 template <bool big_endian>
215 const unsigned char*
216 sized_remap_str_offsets(const unsigned char* contents, section_size_type len);
218 // Remap a single string offsets from an offset in the input string table
219 // to an offset in the output string table.
220 unsigned int
221 remap_str_offset(section_offset_type val);
223 // Add a set of .debug_info.dwo or .debug_types.dwo and related sections
224 // to OUTPUT_FILE.
225 void
226 add_unit_set(Dwp_output_file* output_file, unsigned int *debug_shndx,
227 bool is_debug_types);
229 // The filename.
230 const char* name_;
231 // The ELF file, represented as a gold Relobj instance.
232 Relobj* obj_;
233 // The Input_file object.
234 Input_file* input_file_;
235 // Flags indicating which sections are compressed.
236 std::vector<bool> is_compressed_;
237 // Map input section index onto output section offset and size.
238 std::vector<Section_bounds> sect_offsets_;
239 // Map input string offsets to output string offsets.
240 Str_offset_map str_offset_map_;
243 // An ELF input file.
244 // We derive from Sized_relobj so that we can use interfaces
245 // in libgold to access the file.
247 template <int size, bool big_endian>
248 class Sized_relobj_dwo : public Sized_relobj<size, big_endian>
250 public:
251 typedef typename elfcpp::Elf_types<size>::Elf_Addr Address;
252 typedef typename Sized_relobj<size, big_endian>::Symbols Symbols;
254 Sized_relobj_dwo(const char* name, Input_file* input_file,
255 const elfcpp::Ehdr<size, big_endian>& ehdr)
256 : Sized_relobj<size, big_endian>(name, input_file),
257 elf_file_(this, ehdr)
260 ~Sized_relobj_dwo()
263 // Setup the section information.
264 void
265 setup();
267 protected:
268 // Return section type.
269 unsigned int
270 do_section_type(unsigned int shndx)
271 { return this->elf_file_.section_type(shndx); }
273 // Get the name of a section.
274 std::string
275 do_section_name(unsigned int shndx) const
276 { return this->elf_file_.section_name(shndx); }
278 // Get the size of a section.
279 uint64_t
280 do_section_size(unsigned int shndx)
281 { return this->elf_file_.section_size(shndx); }
283 // Return a view of the contents of a section.
284 const unsigned char*
285 do_section_contents(unsigned int, section_size_type*, bool);
287 // Return a view of the uncompressed contents of a section. Set *PLEN
288 // to the size. Set *IS_NEW to true if the contents need to be deleted
289 // by the caller.
290 const unsigned char*
291 do_decompressed_section_contents(unsigned int shndx,
292 section_size_type* plen,
293 bool* is_new);
295 // The following virtual functions are abstract in the base classes,
296 // but are not used here.
298 // Read the symbols.
299 void
300 do_read_symbols(Read_symbols_data*)
301 { gold_unreachable(); }
303 // Lay out the input sections.
304 void
305 do_layout(Symbol_table*, Layout*, Read_symbols_data*)
306 { gold_unreachable(); }
308 // Layout sections whose layout was deferred while waiting for
309 // input files from a plugin.
310 void
311 do_layout_deferred_sections(Layout*)
312 { gold_unreachable(); }
314 // Add the symbols to the symbol table.
315 void
316 do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*)
317 { gold_unreachable(); }
319 Archive::Should_include
320 do_should_include_member(Symbol_table*, Layout*, Read_symbols_data*,
321 std::string*)
322 { gold_unreachable(); }
324 // Iterate over global symbols, calling a visitor class V for each.
325 void
326 do_for_all_global_symbols(Read_symbols_data*,
327 Library_base::Symbol_visitor_base*)
328 { gold_unreachable(); }
330 // Return section flags.
331 uint64_t
332 do_section_flags(unsigned int)
333 { gold_unreachable(); }
335 // Return section entsize.
336 uint64_t
337 do_section_entsize(unsigned int)
338 { gold_unreachable(); }
340 // Return section address.
341 uint64_t
342 do_section_address(unsigned int)
343 { gold_unreachable(); }
345 // Return the section link field.
346 unsigned int
347 do_section_link(unsigned int)
348 { gold_unreachable(); }
350 // Return the section link field.
351 unsigned int
352 do_section_info(unsigned int)
353 { gold_unreachable(); }
355 // Return the section alignment.
356 uint64_t
357 do_section_addralign(unsigned int)
358 { gold_unreachable(); }
360 // Return the Xindex structure to use.
361 Xindex*
362 do_initialize_xindex()
363 { gold_unreachable(); }
365 // Get symbol counts.
366 void
367 do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const
368 { gold_unreachable(); }
370 // Get global symbols.
371 const Symbols*
372 do_get_global_symbols() const
373 { return NULL; }
375 // Return the value of a local symbol.
376 uint64_t
377 do_local_symbol_value(unsigned int, uint64_t) const
378 { gold_unreachable(); }
380 unsigned int
381 do_local_plt_offset(unsigned int) const
382 { gold_unreachable(); }
384 // Return whether local symbol SYMNDX is a TLS symbol.
385 bool
386 do_local_is_tls(unsigned int) const
387 { gold_unreachable(); }
389 // Return the number of local symbols.
390 unsigned int
391 do_local_symbol_count() const
392 { gold_unreachable(); }
394 // Return the number of local symbols in the output symbol table.
395 unsigned int
396 do_output_local_symbol_count() const
397 { gold_unreachable(); }
399 // Return the file offset for local symbols in the output symbol table.
400 off_t
401 do_local_symbol_offset() const
402 { gold_unreachable(); }
404 // Read the relocs.
405 void
406 do_read_relocs(Read_relocs_data*)
407 { gold_unreachable(); }
409 // Process the relocs to find list of referenced sections. Used only
410 // during garbage collection.
411 void
412 do_gc_process_relocs(Symbol_table*, Layout*, Read_relocs_data*)
413 { gold_unreachable(); }
415 // Scan the relocs and adjust the symbol table.
416 void
417 do_scan_relocs(Symbol_table*, Layout*, Read_relocs_data*)
418 { gold_unreachable(); }
420 // Count the local symbols.
421 void
422 do_count_local_symbols(Stringpool_template<char>*,
423 Stringpool_template<char>*)
424 { gold_unreachable(); }
426 // Finalize the local symbols.
427 unsigned int
428 do_finalize_local_symbols(unsigned int, off_t, Symbol_table*)
429 { gold_unreachable(); }
431 // Set the offset where local dynamic symbol information will be stored.
432 unsigned int
433 do_set_local_dynsym_indexes(unsigned int)
434 { gold_unreachable(); }
436 // Set the offset where local dynamic symbol information will be stored.
437 unsigned int
438 do_set_local_dynsym_offset(off_t)
439 { gold_unreachable(); }
441 // Relocate the input sections and write out the local symbols.
442 void
443 do_relocate(const Symbol_table*, const Layout*, Output_file*)
444 { gold_unreachable(); }
446 private:
447 // General access to the ELF file.
448 elfcpp::Elf_file<size, big_endian, Object> elf_file_;
451 // The output file.
452 // This class is responsible for collecting the debug index information
453 // and writing the .dwp file in ELF format.
455 class Dwp_output_file
457 public:
458 Dwp_output_file(const char* name)
459 : name_(name), machine_(0), size_(0), big_endian_(false), osabi_(0),
460 abiversion_(0), fd_(NULL), next_file_offset_(0), shnum_(1), sections_(),
461 section_id_map_(), shoff_(0), shstrndx_(0), have_strings_(false),
462 stringpool_(), shstrtab_(), cu_index_(), tu_index_(), last_type_sig_(0),
463 last_tu_slot_(0)
465 this->section_id_map_.resize(elfcpp::DW_SECT_MAX + 1);
466 this->stringpool_.set_no_zero_null();
469 // Record the target info from an input file.
470 void
471 record_target_info(const char* name, int machine, int size, bool big_endian,
472 int osabi, int abiversion);
474 // Add a string to the debug strings section.
475 section_offset_type
476 add_string(const char* str, size_t len);
478 // Add a section to the output file, and return the new section offset.
479 section_offset_type
480 add_contribution(elfcpp::DW_SECT section_id, const unsigned char* contents,
481 section_size_type len, int align);
483 // Add a set of .debug_info and related sections to the output file.
484 void
485 add_cu_set(Unit_set* cu_set);
487 // Lookup a type signature and return TRUE if we have already seen it.
488 bool
489 lookup_tu(uint64_t type_sig);
491 // Add a set of .debug_types and related sections to the output file.
492 void
493 add_tu_set(Unit_set* tu_set);
495 // Finalize the file, write the string tables and index sections,
496 // and close the file.
497 void
498 finalize();
500 private:
501 // Contributions to output sections.
502 struct Contribution
504 section_offset_type output_offset;
505 section_size_type size;
506 const unsigned char* contents;
509 // Sections in the output file.
510 struct Section
512 const char* name;
513 off_t offset;
514 section_size_type size;
515 int align;
516 std::vector<Contribution> contributions;
518 Section(const char* n, int a)
519 : name(n), offset(0), size(0), align(a), contributions()
523 // The index sections defined by the DWARF Package File Format spec.
524 class Dwp_index
526 public:
527 // Vector for the section table.
528 typedef std::vector<const Unit_set*> Section_table;
530 Dwp_index()
531 : capacity_(0), used_(0), hash_table_(NULL), section_table_(),
532 section_mask_(0)
535 ~Dwp_index()
538 // Find a slot in the hash table for SIGNATURE. Return TRUE
539 // if the entry already exists.
540 bool
541 find_or_add(uint64_t signature, unsigned int* slotp);
543 // Enter a CU or TU set at the given SLOT in the hash table.
544 void
545 enter_set(unsigned int slot, const Unit_set* set);
547 // Return the contents of the given SLOT in the hash table of signatures.
548 uint64_t
549 hash_table(unsigned int slot) const
550 { return this->hash_table_[slot]; }
552 // Return the contents of the given SLOT in the parallel table of
553 // shndx pool indexes.
554 uint32_t
555 index_table(unsigned int slot) const
556 { return this->index_table_[slot]; }
558 // Return the total number of slots in the hash table.
559 unsigned int
560 hash_table_total_slots() const
561 { return this->capacity_; }
563 // Return the number of used slots in the hash table.
564 unsigned int
565 hash_table_used_slots() const
566 { return this->used_; }
568 // Return an iterator into the shndx pool.
569 Section_table::const_iterator
570 section_table() const
571 { return this->section_table_.begin(); }
573 Section_table::const_iterator
574 section_table_end() const
575 { return this->section_table_.end(); }
577 // Return the number of rows in the section table.
578 unsigned int
579 section_table_rows() const
580 { return this->section_table_.size(); }
582 // Return the mask indicating which columns will be used
583 // in the section table.
585 section_table_cols() const
586 { return this->section_mask_; }
588 private:
589 // Initialize the hash table.
590 void
591 initialize();
593 // Grow the hash table when we reach 2/3 capacity.
594 void
595 grow();
597 // The number of slots in the table, a power of 2 such that
598 // capacity > 3 * size / 2.
599 unsigned int capacity_;
600 // The current number of used slots in the hash table.
601 unsigned int used_;
602 // The storage for the hash table of signatures.
603 uint64_t* hash_table_;
604 // The storage for the parallel table of shndx pool indexes.
605 uint32_t* index_table_;
606 // The table of section offsets and sizes.
607 Section_table section_table_;
608 // Bit mask to indicate which debug sections are present in the file.
609 int section_mask_;
610 }; // End class Dwp_output_file::Dwp_index.
612 // Add a new output section and return the section index.
613 unsigned int
614 add_output_section(const char* section_name, int align);
616 // Write a new section to the output file.
617 void
618 write_new_section(const char* section_name, const unsigned char* contents,
619 section_size_type len, int align);
621 // Write the ELF header.
622 void
623 write_ehdr();
625 template<unsigned int size, bool big_endian>
626 void
627 sized_write_ehdr();
629 // Write a section header.
630 void
631 write_shdr(const char* name, unsigned int type, unsigned int flags,
632 uint64_t addr, off_t offset, section_size_type sect_size,
633 unsigned int link, unsigned int info,
634 unsigned int align, unsigned int ent_size);
636 template<unsigned int size, bool big_endian>
637 void
638 sized_write_shdr(const char* name, unsigned int type, unsigned int flags,
639 uint64_t addr, off_t offset, section_size_type sect_size,
640 unsigned int link, unsigned int info,
641 unsigned int align, unsigned int ent_size);
643 // Write the contributions to an output section.
644 void
645 write_contributions(const Section& sect);
647 // Write a CU or TU index section.
648 template<bool big_endian>
649 void
650 write_index(const char* sect_name, const Dwp_index& index);
652 // The output filename.
653 const char* name_;
654 // ELF header parameters.
655 int machine_;
656 int size_;
657 int big_endian_;
658 int osabi_;
659 int abiversion_;
660 // The output file descriptor.
661 FILE* fd_;
662 // Next available file offset.
663 off_t next_file_offset_;
664 // The number of sections.
665 unsigned int shnum_;
666 // Section table. The first entry is shndx 1.
667 std::vector<Section> sections_;
668 // Section id map. This maps a DW_SECT enum to an shndx.
669 std::vector<unsigned int> section_id_map_;
670 // File offset of the section header table.
671 off_t shoff_;
672 // Section index of the section string table.
673 unsigned int shstrndx_;
674 // TRUE if we have added any strings to the string pool.
675 bool have_strings_;
676 // String pool for the output .debug_str.dwo section.
677 Stringpool stringpool_;
678 // String pool for the .shstrtab section.
679 Stringpool shstrtab_;
680 // The compilation unit index.
681 Dwp_index cu_index_;
682 // The type unit index.
683 Dwp_index tu_index_;
684 // Cache of the last type signature looked up.
685 uint64_t last_type_sig_;
686 // Cache of the slot index for the last type signature.
687 unsigned int last_tu_slot_;
690 // A specialization of Dwarf_info_reader, for reading dwo_names from
691 // DWARF CUs.
693 class Dwo_name_info_reader : public Dwarf_info_reader
695 public:
696 Dwo_name_info_reader(Relobj* object, unsigned int shndx)
697 : Dwarf_info_reader(false, object, NULL, 0, shndx, 0, 0),
698 files_(NULL)
701 ~Dwo_name_info_reader()
704 // Get the dwo_names from the DWARF compilation unit DIEs.
705 void
706 get_dwo_names(File_list* files)
708 this->files_ = files;
709 this->parse();
712 protected:
713 // Visit a compilation unit.
714 virtual void
715 visit_compilation_unit(off_t cu_offset, off_t cu_length, Dwarf_die*);
717 private:
718 // The list of files to populate.
719 File_list* files_;
722 // A specialization of Dwarf_info_reader, for reading DWARF CUs and TUs
723 // and adding them to the output file.
725 class Unit_reader : public Dwarf_info_reader
727 public:
728 Unit_reader(bool is_type_unit, Relobj* object, unsigned int shndx)
729 : Dwarf_info_reader(is_type_unit, object, NULL, 0, shndx, 0, 0),
730 output_file_(NULL), sections_(NULL)
733 ~Unit_reader()
736 // Read the CUs or TUs and add them to the output file.
737 void
738 add_units(Dwp_output_file*, unsigned int debug_abbrev, Section_bounds*);
740 protected:
741 // Visit a compilation unit.
742 virtual void
743 visit_compilation_unit(off_t cu_offset, off_t cu_length, Dwarf_die*);
745 // Visit a type unit.
746 virtual void
747 visit_type_unit(off_t tu_offset, off_t tu_length, off_t type_offset,
748 uint64_t signature, Dwarf_die*);
750 private:
751 Dwp_output_file* output_file_;
752 Section_bounds* sections_;
755 // Return the name of a DWARF .dwo section.
757 static const char*
758 get_dwarf_section_name(elfcpp::DW_SECT section_id)
760 static const char* dwarf_section_names[] = {
761 NULL, // unused
762 ".debug_info.dwo", // DW_SECT_INFO = 1
763 ".debug_types.dwo", // DW_SECT_TYPES = 2
764 ".debug_abbrev.dwo", // DW_SECT_ABBREV = 3
765 ".debug_line.dwo", // DW_SECT_LINE = 4
766 ".debug_loc.dwo", // DW_SECT_LOC = 5
767 ".debug_str_offsets.dwo", // DW_SECT_STR_OFFSETS = 6
768 ".debug_macinfo.dwo", // DW_SECT_MACINFO = 7
769 ".debug_macro.dwo", // DW_SECT_MACRO = 8
772 gold_assert(section_id > 0 && section_id <= elfcpp::DW_SECT_MAX);
773 return dwarf_section_names[section_id];
776 // Class Sized_relobj_dwo.
778 // Setup the section information.
780 template <int size, bool big_endian>
781 void
782 Sized_relobj_dwo<size, big_endian>::setup()
784 const unsigned int shnum = this->elf_file_.shnum();
785 this->set_shnum(shnum);
786 this->section_offsets().resize(shnum);
789 // Return a view of the contents of a section.
791 template <int size, bool big_endian>
792 const unsigned char*
793 Sized_relobj_dwo<size, big_endian>::do_section_contents(
794 unsigned int shndx,
795 section_size_type* plen,
796 bool cache)
798 Object::Location loc(this->elf_file_.section_contents(shndx));
799 *plen = convert_to_section_size_type(loc.data_size);
800 if (*plen == 0)
802 static const unsigned char empty[1] = { '\0' };
803 return empty;
805 return this->get_view(loc.file_offset, *plen, true, cache);
808 // Return a view of the uncompressed contents of a section. Set *PLEN
809 // to the size. Set *IS_NEW to true if the contents need to be deleted
810 // by the caller.
812 template <int size, bool big_endian>
813 const unsigned char*
814 Sized_relobj_dwo<size, big_endian>::do_decompressed_section_contents(
815 unsigned int shndx,
816 section_size_type* plen,
817 bool* is_new)
819 section_size_type buffer_size;
820 const unsigned char* buffer = this->do_section_contents(shndx, &buffer_size,
821 false);
823 std::string sect_name = this->do_section_name(shndx);
824 if (!is_prefix_of(".zdebug_", sect_name.c_str()))
826 *plen = buffer_size;
827 *is_new = false;
828 return buffer;
831 section_size_type uncompressed_size = get_uncompressed_size(buffer,
832 buffer_size);
833 unsigned char* uncompressed_data = new unsigned char[uncompressed_size];
834 if (!decompress_input_section(buffer,
835 buffer_size,
836 uncompressed_data,
837 uncompressed_size))
838 this->error(_("could not decompress section %s"),
839 this->section_name(shndx).c_str());
840 *plen = uncompressed_size;
841 *is_new = true;
842 return uncompressed_data;
845 // Class Dwo_file.
847 Dwo_file::~Dwo_file()
849 if (this->obj_ != NULL)
850 delete this->obj_;
851 if (this->input_file_ != NULL)
852 delete this->input_file_;
855 // Read the input executable file and extract the list of .dwo files
856 // that it references.
858 void
859 Dwo_file::read_executable(File_list* files)
861 this->obj_ = this->make_object(NULL);
863 unsigned int shnum = this->shnum();
864 this->is_compressed_.resize(shnum);
865 this->sect_offsets_.resize(shnum);
867 unsigned int debug_info = 0;
868 unsigned int debug_abbrev = 0;
870 // Scan the section table and collect the debug sections we need.
871 // (Section index 0 is a dummy section; skip it.)
872 for (unsigned int i = 1; i < shnum; i++)
874 if (this->section_type(i) != elfcpp::SHT_PROGBITS)
875 continue;
876 std::string sect_name = this->section_name(i);
877 const char* suffix = sect_name.c_str();
878 if (is_prefix_of(".debug_", suffix))
879 suffix += 7;
880 else if (is_prefix_of(".zdebug_", suffix))
882 this->is_compressed_[i] = true;
883 suffix += 8;
885 else
886 continue;
887 if (strcmp(suffix, "info") == 0)
888 debug_info = i;
889 else if (strcmp(suffix, "abbrev") == 0)
890 debug_abbrev = i;
893 if (debug_info > 0)
895 Dwo_name_info_reader dwarf_reader(this->obj_, debug_info);
896 dwarf_reader.set_abbrev_shndx(debug_abbrev);
897 dwarf_reader.get_dwo_names(files);
901 // Read the input file and send its contents to OUTPUT_FILE.
903 void
904 Dwo_file::read(Dwp_output_file* output_file)
906 this->obj_ = this->make_object(output_file);
908 unsigned int shnum = this->shnum();
909 this->is_compressed_.resize(shnum);
910 this->sect_offsets_.resize(shnum);
912 typedef std::vector<unsigned int> Types_list;
913 Types_list debug_types;
914 unsigned int debug_shndx[elfcpp::DW_SECT_MAX + 1];
915 for (unsigned int i = 0; i <= elfcpp::DW_SECT_MAX; i++)
916 debug_shndx[i] = 0;
917 unsigned int debug_str = 0;
918 unsigned int debug_cu_index = 0;
919 unsigned int debug_tu_index = 0;
921 // Scan the section table and collect debug sections.
922 // (Section index 0 is a dummy section; skip it.)
923 for (unsigned int i = 1; i < shnum; i++)
925 if (this->section_type(i) != elfcpp::SHT_PROGBITS)
926 continue;
927 std::string sect_name = this->section_name(i);
928 const char* suffix = sect_name.c_str();
929 if (is_prefix_of(".debug_", suffix))
930 suffix += 7;
931 else if (is_prefix_of(".zdebug_", suffix))
933 this->is_compressed_[i] = true;
934 suffix += 8;
936 else
937 continue;
938 if (strcmp(suffix, "info.dwo") == 0)
939 debug_shndx[elfcpp::DW_SECT_INFO] = i;
940 else if (strcmp(suffix, "types.dwo") == 0)
941 debug_types.push_back(i);
942 else if (strcmp(suffix, "abbrev.dwo") == 0)
943 debug_shndx[elfcpp::DW_SECT_ABBREV] = i;
944 else if (strcmp(suffix, "line.dwo") == 0)
945 debug_shndx[elfcpp::DW_SECT_LINE] = i;
946 else if (strcmp(suffix, "loc.dwo") == 0)
947 debug_shndx[elfcpp::DW_SECT_LOC] = i;
948 else if (strcmp(suffix, "str.dwo") == 0)
949 debug_str = i;
950 else if (strcmp(suffix, "str_offsets.dwo") == 0)
951 debug_shndx[elfcpp::DW_SECT_STR_OFFSETS] = i;
952 else if (strcmp(suffix, "macinfo.dwo") == 0)
953 debug_shndx[elfcpp::DW_SECT_MACINFO] = i;
954 else if (strcmp(suffix, "macro.dwo") == 0)
955 debug_shndx[elfcpp::DW_SECT_MACRO] = i;
956 else if (strcmp(suffix, "cu_index") == 0)
957 debug_cu_index = i;
958 else if (strcmp(suffix, "tu_index") == 0)
959 debug_tu_index = i;
962 // Merge the input string table into the output string table.
963 this->add_strings(output_file, debug_str);
965 // If we found any .dwp index sections, read those and add the section
966 // sets to the output file.
967 if (debug_cu_index > 0 || debug_tu_index > 0)
969 if (debug_cu_index > 0)
970 this->read_unit_index(debug_cu_index, debug_shndx, output_file, false);
971 if (debug_tu_index > 0)
973 if (debug_types.size() > 1)
974 gold_fatal(_("%s: .dwp file must have no more than one "
975 ".debug_types.dwo section"), this->name_);
976 if (debug_types.size() == 1)
977 debug_shndx[elfcpp::DW_SECT_TYPES] = debug_types[0];
978 else
979 debug_shndx[elfcpp::DW_SECT_TYPES] = 0;
980 this->read_unit_index(debug_tu_index, debug_shndx, output_file, true);
982 return;
985 // If we found no index sections, this is a .dwo file.
986 if (debug_shndx[elfcpp::DW_SECT_INFO] > 0)
987 this->add_unit_set(output_file, debug_shndx, false);
989 debug_shndx[elfcpp::DW_SECT_INFO] = 0;
990 for (Types_list::const_iterator tp = debug_types.begin();
991 tp != debug_types.end();
992 ++tp)
994 debug_shndx[elfcpp::DW_SECT_TYPES] = *tp;
995 this->add_unit_set(output_file, debug_shndx, true);
999 // Verify a .dwp file given a list of .dwo files referenced by the
1000 // corresponding executable file. Returns true if no problems
1001 // were found.
1003 bool
1004 Dwo_file::verify(const File_list& files)
1006 this->obj_ = this->make_object(NULL);
1008 unsigned int shnum = this->shnum();
1009 this->is_compressed_.resize(shnum);
1010 this->sect_offsets_.resize(shnum);
1012 unsigned int debug_cu_index = 0;
1014 // Scan the section table and collect debug sections.
1015 // (Section index 0 is a dummy section; skip it.)
1016 for (unsigned int i = 1; i < shnum; i++)
1018 if (this->section_type(i) != elfcpp::SHT_PROGBITS)
1019 continue;
1020 std::string sect_name = this->section_name(i);
1021 const char* suffix = sect_name.c_str();
1022 if (is_prefix_of(".debug_", suffix))
1023 suffix += 7;
1024 else if (is_prefix_of(".zdebug_", suffix))
1026 this->is_compressed_[i] = true;
1027 suffix += 8;
1029 else
1030 continue;
1031 if (strcmp(suffix, "cu_index") == 0)
1032 debug_cu_index = i;
1035 if (debug_cu_index == 0)
1036 gold_fatal(_("%s: no .debug_cu_index section found"), this->name_);
1038 return this->verify_dwo_list(debug_cu_index, files);
1041 // Create a Sized_relobj_dwo of the given size and endianness,
1042 // and record the target info.
1044 Relobj*
1045 Dwo_file::make_object(Dwp_output_file* output_file)
1047 // Open the input file.
1048 Input_file* input_file = new Input_file(this->name_);
1049 this->input_file_ = input_file;
1050 Dirsearch dirpath;
1051 int index;
1052 if (!input_file->open(dirpath, NULL, &index))
1053 gold_fatal(_("%s: can't open"), this->name_);
1055 // Check that it's an ELF file.
1056 off_t filesize = input_file->file().filesize();
1057 int hdrsize = elfcpp::Elf_recognizer::max_header_size;
1058 if (filesize < hdrsize)
1059 hdrsize = filesize;
1060 const unsigned char* elf_header =
1061 input_file->file().get_view(0, 0, hdrsize, true, false);
1062 if (!elfcpp::Elf_recognizer::is_elf_file(elf_header, hdrsize))
1063 gold_fatal(_("%s: not an ELF object file"), this->name_);
1065 // Get the size, endianness, machine, etc. info from the header,
1066 // make an appropriately-sized Relobj, and pass the target info
1067 // to the output object.
1068 int size;
1069 bool big_endian;
1070 std::string error;
1071 if (!elfcpp::Elf_recognizer::is_valid_header(elf_header, hdrsize, &size,
1072 &big_endian, &error))
1073 gold_fatal(_("%s: %s"), this->name_, error.c_str());
1075 if (size == 32)
1077 if (big_endian)
1078 #ifdef HAVE_TARGET_32_BIG
1079 return this->sized_make_object<32, true>(elf_header, input_file,
1080 output_file);
1081 #else
1082 gold_unreachable();
1083 #endif
1084 else
1085 #ifdef HAVE_TARGET_32_LITTLE
1086 return this->sized_make_object<32, false>(elf_header, input_file,
1087 output_file);
1088 #else
1089 gold_unreachable();
1090 #endif
1092 else if (size == 64)
1094 if (big_endian)
1095 #ifdef HAVE_TARGET_64_BIG
1096 return this->sized_make_object<64, true>(elf_header, input_file,
1097 output_file);
1098 #else
1099 gold_unreachable();
1100 #endif
1101 else
1102 #ifdef HAVE_TARGET_64_LITTLE
1103 return this->sized_make_object<64, false>(elf_header, input_file,
1104 output_file);
1105 #else
1106 gold_unreachable();
1107 #endif
1109 else
1110 gold_unreachable();
1113 // Function template to create a Sized_relobj_dwo and record the target info.
1114 // P is a pointer to the ELF header in memory.
1116 template <int size, bool big_endian>
1117 Relobj*
1118 Dwo_file::sized_make_object(const unsigned char* p, Input_file* input_file,
1119 Dwp_output_file* output_file)
1121 elfcpp::Ehdr<size, big_endian> ehdr(p);
1122 Sized_relobj_dwo<size, big_endian>* obj =
1123 new Sized_relobj_dwo<size, big_endian>(this->name_, input_file, ehdr);
1124 obj->setup();
1125 if (output_file != NULL)
1126 output_file->record_target_info(
1127 this->name_, ehdr.get_e_machine(), size, big_endian,
1128 ehdr.get_e_ident()[elfcpp::EI_OSABI],
1129 ehdr.get_e_ident()[elfcpp::EI_ABIVERSION]);
1130 return obj;
1133 // Read the .debug_cu_index or .debug_tu_index section of a .dwp file,
1134 // and process the CU or TU sets.
1136 void
1137 Dwo_file::read_unit_index(unsigned int shndx, unsigned int *debug_shndx,
1138 Dwp_output_file* output_file, bool is_tu_index)
1140 if (this->obj_->is_big_endian())
1141 this->sized_read_unit_index<true>(shndx, debug_shndx, output_file,
1142 is_tu_index);
1143 else
1144 this->sized_read_unit_index<false>(shndx, debug_shndx, output_file,
1145 is_tu_index);
1148 template <bool big_endian>
1149 void
1150 Dwo_file::sized_read_unit_index(unsigned int shndx,
1151 unsigned int *debug_shndx,
1152 Dwp_output_file* output_file,
1153 bool is_tu_index)
1155 elfcpp::DW_SECT info_sect = (is_tu_index
1156 ? elfcpp::DW_SECT_TYPES
1157 : elfcpp::DW_SECT_INFO);
1158 unsigned int info_shndx = debug_shndx[info_sect];
1160 gold_assert(shndx > 0);
1162 section_size_type index_len;
1163 bool index_is_new;
1164 const unsigned char* contents =
1165 this->section_contents(shndx, &index_len, &index_is_new);
1167 unsigned int version =
1168 elfcpp::Swap_unaligned<32, big_endian>::readval(contents);
1170 // We don't support version 1 anymore because it was experimental
1171 // and because in normal use, dwp is not expected to read .dwp files
1172 // produced by an earlier version of the tool.
1173 if (version != 2)
1174 gold_fatal(_("%s: section %s has unsupported version number %d"),
1175 this->name_, this->section_name(shndx).c_str(), version);
1177 unsigned int ncols =
1178 elfcpp::Swap_unaligned<32, big_endian>::readval(contents
1179 + sizeof(uint32_t));
1180 unsigned int nused =
1181 elfcpp::Swap_unaligned<32, big_endian>::readval(contents
1182 + 2 * sizeof(uint32_t));
1183 if (ncols == 0 || nused == 0)
1184 return;
1186 gold_assert(info_shndx > 0);
1188 unsigned int nslots =
1189 elfcpp::Swap_unaligned<32, big_endian>::readval(contents
1190 + 3 * sizeof(uint32_t));
1192 const unsigned char* phash = contents + 4 * sizeof(uint32_t);
1193 const unsigned char* pindex = phash + nslots * sizeof(uint64_t);
1194 const unsigned char* pcolhdrs = pindex + nslots * sizeof(uint32_t);
1195 const unsigned char* poffsets = pcolhdrs + ncols * sizeof(uint32_t);
1196 const unsigned char* psizes = poffsets + nused * ncols * sizeof(uint32_t);
1197 const unsigned char* pend = psizes + nused * ncols * sizeof(uint32_t);
1199 if (pend > contents + index_len)
1200 gold_fatal(_("%s: section %s is corrupt"), this->name_,
1201 this->section_name(shndx).c_str());
1203 // Copy the related sections and track the section offsets and sizes.
1204 Section_bounds sections[elfcpp::DW_SECT_MAX + 1];
1205 for (int i = elfcpp::DW_SECT_ABBREV; i <= elfcpp::DW_SECT_MAX; ++i)
1207 if (debug_shndx[i] > 0)
1208 sections[i] = this->copy_section(output_file, debug_shndx[i],
1209 static_cast<elfcpp::DW_SECT>(i));
1212 // Get the contents of the .debug_info.dwo or .debug_types.dwo section.
1213 section_size_type info_len;
1214 bool info_is_new;
1215 const unsigned char* info_contents =
1216 this->section_contents(info_shndx, &info_len, &info_is_new);
1218 // Loop over the slots of the hash table.
1219 for (unsigned int i = 0; i < nslots; ++i)
1221 uint64_t signature =
1222 elfcpp::Swap_unaligned<64, big_endian>::readval(phash);
1223 unsigned int index =
1224 elfcpp::Swap_unaligned<32, big_endian>::readval(pindex);
1225 if (index != 0 && (!is_tu_index || !output_file->lookup_tu(signature)))
1227 Unit_set* unit_set = new Unit_set();
1228 unit_set->signature = signature;
1229 const unsigned char* pch = pcolhdrs;
1230 const unsigned char* porow =
1231 poffsets + (index - 1) * ncols * sizeof(uint32_t);
1232 const unsigned char* psrow =
1233 psizes + (index - 1) * ncols * sizeof(uint32_t);
1235 // Adjust the offset of each contribution within the input section
1236 // by the offset of the input section within the output section.
1237 for (unsigned int j = 0; j <= ncols; j++)
1239 unsigned int dw_sect =
1240 elfcpp::Swap_unaligned<64, big_endian>::readval(pch);
1241 unsigned int offset =
1242 elfcpp::Swap_unaligned<64, big_endian>::readval(porow);
1243 unsigned int size =
1244 elfcpp::Swap_unaligned<64, big_endian>::readval(psrow);
1245 unit_set->sections[dw_sect].offset = (sections[dw_sect].offset
1246 + offset);
1247 unit_set->sections[dw_sect].size = size;
1248 pch += sizeof(uint32_t);
1249 porow += sizeof(uint32_t);
1250 psrow += sizeof(uint32_t);
1253 const unsigned char* unit_start =
1254 info_contents + unit_set->sections[info_sect].offset;
1255 section_size_type unit_length = unit_set->sections[info_sect].size;
1257 // Dwp_output_file::add_contribution writes the .debug_info.dwo
1258 // section directly to the output file, so we only need to
1259 // duplicate contributions for .debug_types.dwo section.
1260 if (is_tu_index)
1262 unsigned char *copy = new unsigned char[unit_length];
1263 memcpy(copy, unit_start, unit_length);
1264 unit_start = copy;
1266 section_offset_type off =
1267 output_file->add_contribution(info_sect, unit_start,
1268 unit_length, 1);
1269 unit_set->sections[info_sect].offset = off;
1270 if (is_tu_index)
1271 output_file->add_tu_set(unit_set);
1272 else
1273 output_file->add_cu_set(unit_set);
1275 phash += sizeof(uint64_t);
1276 pindex += sizeof(uint32_t);
1279 if (index_is_new)
1280 delete[] contents;
1281 if (info_is_new)
1282 delete[] info_contents;
1285 // Verify the .debug_cu_index section of a .dwp file, comparing it
1286 // against the list of .dwo files referenced by the corresponding
1287 // executable file.
1289 bool
1290 Dwo_file::verify_dwo_list(unsigned int shndx, const File_list& files)
1292 if (this->obj_->is_big_endian())
1293 return this->sized_verify_dwo_list<true>(shndx, files);
1294 else
1295 return this->sized_verify_dwo_list<false>(shndx, files);
1298 template <bool big_endian>
1299 bool
1300 Dwo_file::sized_verify_dwo_list(unsigned int shndx, const File_list& files)
1302 gold_assert(shndx > 0);
1304 section_size_type index_len;
1305 bool index_is_new;
1306 const unsigned char* contents =
1307 this->section_contents(shndx, &index_len, &index_is_new);
1309 unsigned int version =
1310 elfcpp::Swap_unaligned<32, big_endian>::readval(contents);
1312 // We don't support version 1 anymore because it was experimental
1313 // and because in normal use, dwp is not expected to read .dwp files
1314 // produced by an earlier version of the tool.
1315 if (version != 2)
1316 gold_fatal(_("%s: section %s has unsupported version number %d"),
1317 this->name_, this->section_name(shndx).c_str(), version);
1319 unsigned int ncols =
1320 elfcpp::Swap_unaligned<32, big_endian>::readval(contents
1321 + sizeof(uint32_t));
1322 unsigned int nused =
1323 elfcpp::Swap_unaligned<32, big_endian>::readval(contents
1324 + 2 * sizeof(uint32_t));
1325 if (ncols == 0 || nused == 0)
1326 return true;
1328 unsigned int nslots =
1329 elfcpp::Swap_unaligned<32, big_endian>::readval(contents
1330 + 3 * sizeof(uint32_t));
1332 const unsigned char* phash = contents + 4 * sizeof(uint32_t);
1333 const unsigned char* pindex = phash + nslots * sizeof(uint64_t);
1334 const unsigned char* pcolhdrs = pindex + nslots * sizeof(uint32_t);
1335 const unsigned char* poffsets = pcolhdrs + ncols * sizeof(uint32_t);
1336 const unsigned char* psizes = poffsets + nused * ncols * sizeof(uint32_t);
1337 const unsigned char* pend = psizes + nused * ncols * sizeof(uint32_t);
1339 if (pend > contents + index_len)
1340 gold_fatal(_("%s: section %s is corrupt"), this->name_,
1341 this->section_name(shndx).c_str());
1343 int nmissing = 0;
1344 for (File_list::const_iterator f = files.begin(); f != files.end(); ++f)
1346 uint64_t dwo_id = f->dwo_id;
1347 unsigned int slot = static_cast<unsigned int>(dwo_id) & (nslots - 1);
1348 const unsigned char* ph = phash + slot * sizeof(uint64_t);
1349 const unsigned char* pi = pindex + slot * sizeof(uint32_t);
1350 uint64_t probe = elfcpp::Swap_unaligned<64, big_endian>::readval(ph);
1351 uint32_t row_index = elfcpp::Swap_unaligned<32, big_endian>::readval(pi);
1352 if (row_index != 0 && probe != dwo_id)
1354 unsigned int h2 = ((static_cast<unsigned int>(dwo_id >> 32)
1355 & (nslots - 1)) | 1);
1358 slot = (slot + h2) & (nslots - 1);
1359 ph = phash + slot * sizeof(uint64_t);
1360 pi = pindex + slot * sizeof(uint32_t);
1361 probe = elfcpp::Swap_unaligned<64, big_endian>::readval(ph);
1362 row_index = elfcpp::Swap_unaligned<32, big_endian>::readval(pi);
1363 } while (row_index != 0 && probe != dwo_id);
1365 if (row_index == 0)
1367 printf(_("missing .dwo file: %016llx %s\n"),
1368 static_cast<long long>(dwo_id), f->dwo_name.c_str());
1369 ++nmissing;
1373 gold_info(_("Found %d missing .dwo files"), nmissing);
1375 if (index_is_new)
1376 delete[] contents;
1378 return nmissing == 0;
1381 // Merge the input string table section into the output file.
1383 void
1384 Dwo_file::add_strings(Dwp_output_file* output_file, unsigned int debug_str)
1386 section_size_type len;
1387 bool is_new;
1388 const unsigned char* pdata = this->section_contents(debug_str, &len, &is_new);
1389 const char* p = reinterpret_cast<const char*>(pdata);
1390 const char* pend = p + len;
1392 // Check that the last string is null terminated.
1393 if (pend[-1] != '\0')
1394 gold_fatal(_("%s: last entry in string section '%s' "
1395 "is not null terminated"),
1396 this->name_,
1397 this->section_name(debug_str).c_str());
1399 // Count the number of strings in the section, and size the map.
1400 size_t count = 0;
1401 for (const char* pt = p; pt < pend; pt += strlen(pt) + 1)
1402 ++count;
1403 this->str_offset_map_.reserve(count + 1);
1405 // Add the strings to the output string table, and record the new offsets
1406 // in the map.
1407 section_offset_type i = 0;
1408 section_offset_type new_offset;
1409 while (p < pend)
1411 size_t len = strlen(p);
1412 new_offset = output_file->add_string(p, len);
1413 this->str_offset_map_.push_back(std::make_pair(i, new_offset));
1414 p += len + 1;
1415 i += len + 1;
1417 new_offset = 0;
1418 this->str_offset_map_.push_back(std::make_pair(i, new_offset));
1419 if (is_new)
1420 delete[] pdata;
1423 // Copy a section from the input file to the output file.
1424 // Return the offset and length of this input section's contribution
1425 // in the output section. If copying .debug_str_offsets.dwo, remap
1426 // the string offsets for the output string table.
1428 Section_bounds
1429 Dwo_file::copy_section(Dwp_output_file* output_file, unsigned int shndx,
1430 elfcpp::DW_SECT section_id)
1432 // Some sections may be referenced from more than one set.
1433 // Don't copy a section more than once.
1434 if (this->sect_offsets_[shndx].size > 0)
1435 return this->sect_offsets_[shndx];
1437 // Get the section contents. Upon return, if IS_NEW is true, the memory
1438 // has been allocated via new; if false, the memory is part of the mapped
1439 // input file, and we will need to duplicate it so that it will persist
1440 // after we close the input file.
1441 section_size_type len;
1442 bool is_new;
1443 const unsigned char* contents = this->section_contents(shndx, &len, &is_new);
1445 if (section_id == elfcpp::DW_SECT_STR_OFFSETS)
1447 const unsigned char* remapped = this->remap_str_offsets(contents, len);
1448 if (is_new)
1449 delete[] contents;
1450 contents = remapped;
1452 else if (!is_new)
1454 unsigned char* copy = new unsigned char[len];
1455 memcpy(copy, contents, len);
1456 contents = copy;
1459 // Add the contents of the input section to the output section.
1460 // The output file takes ownership of the memory pointed to by CONTENTS.
1461 section_offset_type off = output_file->add_contribution(section_id, contents,
1462 len, 1);
1464 // Store the output section bounds.
1465 Section_bounds bounds(off, len);
1466 this->sect_offsets_[shndx] = bounds;
1468 return bounds;
1471 // Remap the
1472 const unsigned char*
1473 Dwo_file::remap_str_offsets(const unsigned char* contents,
1474 section_size_type len)
1476 if ((len & 3) != 0)
1477 gold_fatal(_("%s: .debug_str_offsets.dwo section size not a multiple of 4"),
1478 this->name_);
1480 if (this->obj_->is_big_endian())
1481 return this->sized_remap_str_offsets<true>(contents, len);
1482 else
1483 return this->sized_remap_str_offsets<false>(contents, len);
1486 template <bool big_endian>
1487 const unsigned char*
1488 Dwo_file::sized_remap_str_offsets(const unsigned char* contents,
1489 section_size_type len)
1491 unsigned char* remapped = new unsigned char[len];
1492 const unsigned char* p = contents;
1493 unsigned char* q = remapped;
1494 while (len > 0)
1496 unsigned int val = elfcpp::Swap_unaligned<32, big_endian>::readval(p);
1497 val = this->remap_str_offset(val);
1498 elfcpp::Swap_unaligned<32, big_endian>::writeval(q, val);
1499 len -= 4;
1500 p += 4;
1501 q += 4;
1503 return remapped;
1506 unsigned int
1507 Dwo_file::remap_str_offset(section_offset_type val)
1509 Str_offset_map_entry entry;
1510 entry.first = val;
1512 Str_offset_map::const_iterator p =
1513 std::lower_bound(this->str_offset_map_.begin(),
1514 this->str_offset_map_.end(),
1515 entry, Offset_compare());
1517 if (p == this->str_offset_map_.end() || p->first > val)
1519 if (p == this->str_offset_map_.begin())
1520 return 0;
1521 --p;
1522 gold_assert(p->first <= val);
1525 return p->second + (val - p->first);
1528 // Add a set of .debug_info.dwo or .debug_types.dwo and related sections
1529 // to OUTPUT_FILE.
1531 void
1532 Dwo_file::add_unit_set(Dwp_output_file* output_file, unsigned int *debug_shndx,
1533 bool is_debug_types)
1535 unsigned int shndx = (is_debug_types
1536 ? debug_shndx[elfcpp::DW_SECT_TYPES]
1537 : debug_shndx[elfcpp::DW_SECT_INFO]);
1539 gold_assert(shndx != 0);
1541 if (debug_shndx[elfcpp::DW_SECT_ABBREV] == 0)
1542 gold_fatal(_("%s: no .debug_abbrev.dwo section found"), this->name_);
1544 // Copy the related sections and track the section offsets and sizes.
1545 Section_bounds sections[elfcpp::DW_SECT_MAX + 1];
1546 for (int i = elfcpp::DW_SECT_ABBREV; i <= elfcpp::DW_SECT_MAX; ++i)
1548 if (debug_shndx[i] > 0)
1549 sections[i] = this->copy_section(output_file, debug_shndx[i],
1550 static_cast<elfcpp::DW_SECT>(i));
1553 // Parse the .debug_info or .debug_types section and add each compilation
1554 // or type unit to the output file, along with the contributions to the
1555 // related sections.
1556 Unit_reader reader(is_debug_types, this->obj_, shndx);
1557 reader.add_units(output_file, debug_shndx[elfcpp::DW_SECT_ABBREV], sections);
1560 // Class Dwp_output_file.
1562 // Record the target info from an input file. On first call, we
1563 // set the ELF header values for the output file. On subsequent
1564 // calls, we just verify that the values match.
1566 void
1567 Dwp_output_file::record_target_info(const char*, int machine,
1568 int size, bool big_endian,
1569 int osabi, int abiversion)
1571 // TODO: Check the values on subsequent calls.
1572 if (this->size_ > 0)
1573 return;
1575 this->machine_ = machine;
1576 this->size_ = size;
1577 this->big_endian_ = big_endian;
1578 this->osabi_ = osabi;
1579 this->abiversion_ = abiversion;
1581 if (size == 32)
1582 this->next_file_offset_ = elfcpp::Elf_sizes<32>::ehdr_size;
1583 else if (size == 64)
1584 this->next_file_offset_ = elfcpp::Elf_sizes<64>::ehdr_size;
1585 else
1586 gold_unreachable();
1588 this->fd_ = ::fopen(this->name_, "wb");
1589 if (this->fd_ == NULL)
1590 gold_fatal(_("%s: %s"), this->name_, strerror(errno));
1592 // Write zeroes for the ELF header initially. We'll write
1593 // the actual header during finalize().
1594 static const char buf[elfcpp::Elf_sizes<64>::ehdr_size] = { 0 };
1595 if (::fwrite(buf, 1, this->next_file_offset_, this->fd_)
1596 < (size_t) this->next_file_offset_)
1597 gold_fatal(_("%s: %s"), this->name_, strerror(errno));
1600 // Add a string to the debug strings section.
1602 section_offset_type
1603 Dwp_output_file::add_string(const char* str, size_t len)
1605 Stringpool::Key key;
1606 this->stringpool_.add_with_length(str, len, true, &key);
1607 this->have_strings_ = true;
1608 // We aren't supposed to call get_offset() until after
1609 // calling set_string_offsets(), but the offsets will
1610 // not change unless optimizing the string pool.
1611 return this->stringpool_.get_offset_from_key(key);
1614 // Align the file offset to the given boundary.
1616 static inline off_t
1617 align_offset(off_t off, int align)
1619 return (off + align - 1) & ~(align - 1);
1622 // Add a new output section and return the section index.
1624 unsigned int
1625 Dwp_output_file::add_output_section(const char* section_name, int align)
1627 Section sect(section_name, align);
1628 this->sections_.push_back(sect);
1629 return this->shnum_++;
1632 // Add a contribution to a section in the output file, and return the offset
1633 // of the contribution within the output section. The .debug_info.dwo section
1634 // is expected to be the largest one, so we will write the contents of this
1635 // section directly to the output file as we receive contributions, allowing
1636 // us to free that memory as soon as possible. We will save the remaining
1637 // contributions until we finalize the layout of the output file.
1639 section_offset_type
1640 Dwp_output_file::add_contribution(elfcpp::DW_SECT section_id,
1641 const unsigned char* contents,
1642 section_size_type len,
1643 int align)
1645 const char* section_name = get_dwarf_section_name(section_id);
1646 gold_assert(static_cast<size_t>(section_id) < this->section_id_map_.size());
1647 unsigned int shndx = this->section_id_map_[section_id];
1649 // Create the section if necessary.
1650 if (shndx == 0)
1652 section_name = this->shstrtab_.add_with_length(section_name,
1653 strlen(section_name),
1654 false, NULL);
1655 shndx = this->add_output_section(section_name, align);
1656 this->section_id_map_[section_id] = shndx;
1659 Section& section = this->sections_[shndx - 1];
1661 section_offset_type section_offset;
1663 if (section_id == elfcpp::DW_SECT_INFO)
1665 // Write the .debug_info.dwo section directly.
1666 // We do not need to free the memory in this case.
1667 off_t file_offset = this->next_file_offset_;
1668 gold_assert(this->size_ > 0 && file_offset > 0);
1670 file_offset = align_offset(file_offset, align);
1671 if (section.offset == 0)
1672 section.offset = file_offset;
1674 if (align > section.align)
1676 // Since we've already committed to the layout for this
1677 // section, an unexpected large alignment boundary may
1678 // be impossible to honor.
1679 if (align_offset(section.offset, align) != section.offset)
1680 gold_fatal(_("%s: alignment (%d) for section '%s' "
1681 "cannot be honored"),
1682 this->name_, align, section_name);
1683 section.align = align;
1686 section_offset = file_offset - section.offset;
1687 section.size = file_offset + len - section.offset;
1689 ::fseek(this->fd_, file_offset, SEEK_SET);
1690 if (::fwrite(contents, 1, len, this->fd_) < len)
1691 gold_fatal(_("%s: error writing section '%s'"), this->name_,
1692 section_name);
1693 this->next_file_offset_ = file_offset + len;
1695 else
1697 // Collect the contributions and keep track of the total size.
1698 if (align > section.align)
1699 section.align = align;
1700 section_offset = align_offset(section.size, align);
1701 section.size = section_offset + len;
1702 Contribution contrib = { section_offset, len, contents };
1703 section.contributions.push_back(contrib);
1706 return section_offset;
1709 // Add a set of .debug_info and related sections to the output file.
1711 void
1712 Dwp_output_file::add_cu_set(Unit_set* cu_set)
1714 uint64_t dwo_id = cu_set->signature;
1715 unsigned int slot;
1716 if (!this->cu_index_.find_or_add(dwo_id, &slot))
1717 this->cu_index_.enter_set(slot, cu_set);
1718 else
1719 gold_warning(_("%s: duplicate entry for CU (dwo_id 0x%llx)"),
1720 this->name_, (unsigned long long)dwo_id);
1723 // Lookup a type signature and return TRUE if we have already seen it.
1724 bool
1725 Dwp_output_file::lookup_tu(uint64_t type_sig)
1727 this->last_type_sig_ = type_sig;
1728 return this->tu_index_.find_or_add(type_sig, &this->last_tu_slot_);
1731 // Add a set of .debug_types and related sections to the output file.
1733 void
1734 Dwp_output_file::add_tu_set(Unit_set* tu_set)
1736 uint64_t type_sig = tu_set->signature;
1737 unsigned int slot;
1738 if (type_sig == this->last_type_sig_)
1739 slot = this->last_tu_slot_;
1740 else
1741 this->tu_index_.find_or_add(type_sig, &slot);
1742 this->tu_index_.enter_set(slot, tu_set);
1745 // Find a slot in the hash table for SIGNATURE. Return TRUE
1746 // if the entry already exists.
1748 bool
1749 Dwp_output_file::Dwp_index::find_or_add(uint64_t signature,
1750 unsigned int* slotp)
1752 if (this->capacity_ == 0)
1753 this->initialize();
1754 unsigned int slot =
1755 static_cast<unsigned int>(signature) & (this->capacity_ - 1);
1756 unsigned int secondary_hash;
1757 uint64_t probe = this->hash_table_[slot];
1758 uint32_t row_index = this->index_table_[slot];
1759 if (row_index != 0 && probe != signature)
1761 secondary_hash = (static_cast<unsigned int>(signature >> 32)
1762 & (this->capacity_ - 1)) | 1;
1765 slot = (slot + secondary_hash) & (this->capacity_ - 1);
1766 probe = this->hash_table_[slot];
1767 row_index = this->index_table_[slot];
1768 } while (row_index != 0 && probe != signature);
1770 *slotp = slot;
1771 return (row_index != 0);
1774 // Enter a CU or TU set at the given SLOT in the hash table.
1776 void
1777 Dwp_output_file::Dwp_index::enter_set(unsigned int slot,
1778 const Unit_set* set)
1780 gold_assert(slot < this->capacity_);
1782 // Add a row to the offsets and sizes tables.
1783 this->section_table_.push_back(set);
1784 uint32_t row_index = this->section_table_rows();
1786 // Mark the sections used in this set.
1787 for (unsigned int i = 1; i <= elfcpp::DW_SECT_MAX; i++)
1788 if (set->sections[i].size > 0)
1789 this->section_mask_ |= 1 << i;
1791 // Enter the signature and pool index into the hash table.
1792 gold_assert(this->hash_table_[slot] == 0);
1793 this->hash_table_[slot] = set->signature;
1794 this->index_table_[slot] = row_index;
1795 ++this->used_;
1797 // Grow the hash table when we exceed 2/3 capacity.
1798 if (this->used_ * 3 > this->capacity_ * 2)
1799 this->grow();
1802 // Initialize the hash table.
1804 void
1805 Dwp_output_file::Dwp_index::initialize()
1807 this->capacity_ = 16;
1808 this->hash_table_ = new uint64_t[this->capacity_];
1809 memset(this->hash_table_, 0, this->capacity_ * sizeof(uint64_t));
1810 this->index_table_ = new uint32_t[this->capacity_];
1811 memset(this->index_table_, 0, this->capacity_ * sizeof(uint32_t));
1814 // Grow the hash table when we reach 2/3 capacity.
1816 void
1817 Dwp_output_file::Dwp_index::grow()
1819 unsigned int old_capacity = this->capacity_;
1820 uint64_t* old_hash_table = this->hash_table_;
1821 uint32_t* old_index_table = this->index_table_;
1822 unsigned int old_used = this->used_;
1824 this->capacity_ = old_capacity * 2;
1825 this->hash_table_ = new uint64_t[this->capacity_];
1826 memset(this->hash_table_, 0, this->capacity_ * sizeof(uint64_t));
1827 this->index_table_ = new uint32_t[this->capacity_];
1828 memset(this->index_table_, 0, this->capacity_ * sizeof(uint32_t));
1829 this->used_ = 0;
1831 for (unsigned int i = 0; i < old_capacity; ++i)
1833 uint64_t signature = old_hash_table[i];
1834 uint32_t row_index = old_index_table[i];
1835 if (row_index != 0)
1837 unsigned int slot;
1838 bool found = this->find_or_add(signature, &slot);
1839 gold_assert(!found);
1840 this->hash_table_[slot] = signature;
1841 this->index_table_[slot] = row_index;
1842 ++this->used_;
1845 gold_assert(this->used_ == old_used);
1847 delete[] old_hash_table;
1848 delete[] old_index_table;
1851 // Finalize the file, write the string tables and index sections,
1852 // and close the file.
1854 void
1855 Dwp_output_file::finalize()
1857 unsigned char* buf;
1859 // Write the accumulated output sections.
1860 for (unsigned int i = 0; i < this->sections_.size(); i++)
1862 Section& sect = this->sections_[i];
1863 // If the offset has already been assigned, the section has been written.
1864 if (sect.offset > 0 || sect.size == 0)
1865 continue;
1866 off_t file_offset = this->next_file_offset_;
1867 file_offset = align_offset(file_offset, sect.align);
1868 sect.offset = file_offset;
1869 this->write_contributions(sect);
1870 this->next_file_offset_ = file_offset + sect.size;
1873 // Write the debug string table.
1874 if (this->have_strings_)
1876 this->stringpool_.set_string_offsets();
1877 section_size_type len = this->stringpool_.get_strtab_size();
1878 buf = new unsigned char[len];
1879 this->stringpool_.write_to_buffer(buf, len);
1880 this->write_new_section(".debug_str.dwo", buf, len, 1);
1881 delete[] buf;
1884 // Write the CU and TU indexes.
1885 if (this->big_endian_)
1887 this->write_index<true>(".debug_cu_index", this->cu_index_);
1888 this->write_index<true>(".debug_tu_index", this->tu_index_);
1890 else
1892 this->write_index<false>(".debug_cu_index", this->cu_index_);
1893 this->write_index<false>(".debug_tu_index", this->tu_index_);
1896 off_t file_offset = this->next_file_offset_;
1898 // Write the section string table.
1899 this->shstrndx_ = this->shnum_++;
1900 const char* shstrtab_name =
1901 this->shstrtab_.add_with_length(".shstrtab", sizeof(".shstrtab") - 1,
1902 false, NULL);
1903 this->shstrtab_.set_string_offsets();
1904 section_size_type shstrtab_len = this->shstrtab_.get_strtab_size();
1905 buf = new unsigned char[shstrtab_len];
1906 this->shstrtab_.write_to_buffer(buf, shstrtab_len);
1907 off_t shstrtab_off = file_offset;
1908 ::fseek(this->fd_, file_offset, 0);
1909 if (::fwrite(buf, 1, shstrtab_len, this->fd_) < shstrtab_len)
1910 gold_fatal(_("%s: error writing section '.shstrtab'"), this->name_);
1911 delete[] buf;
1912 file_offset += shstrtab_len;
1914 // Write the section header table. The first entry is a NULL entry.
1915 // This is followed by the debug sections, and finally we write the
1916 // .shstrtab section header.
1917 file_offset = align_offset(file_offset, this->size_ == 32 ? 4 : 8);
1918 this->shoff_ = file_offset;
1919 ::fseek(this->fd_, file_offset, 0);
1920 section_size_type sh0_size = 0;
1921 unsigned int sh0_link = 0;
1922 if (this->shnum_ >= elfcpp::SHN_LORESERVE)
1923 sh0_size = this->shnum_;
1924 if (this->shstrndx_ >= elfcpp::SHN_LORESERVE)
1925 sh0_link = this->shstrndx_;
1926 this->write_shdr(NULL, 0, 0, 0, 0, sh0_size, sh0_link, 0, 0, 0);
1927 for (unsigned int i = 0; i < this->sections_.size(); ++i)
1929 Section& sect = this->sections_[i];
1930 this->write_shdr(sect.name, elfcpp::SHT_PROGBITS, 0, 0, sect.offset,
1931 sect.size, 0, 0, sect.align, 0);
1933 this->write_shdr(shstrtab_name, elfcpp::SHT_STRTAB, 0, 0,
1934 shstrtab_off, shstrtab_len, 0, 0, 1, 0);
1936 // Write the ELF header.
1937 this->write_ehdr();
1939 // Close the file.
1940 if (this->fd_ != NULL)
1942 if (::fclose(this->fd_) != 0)
1943 gold_fatal(_("%s: %s"), this->name_, strerror(errno));
1945 this->fd_ = NULL;
1948 // Write the contributions to an output section.
1950 void
1951 Dwp_output_file::write_contributions(const Section& sect)
1953 for (unsigned int i = 0; i < sect.contributions.size(); ++i)
1955 const Contribution& c = sect.contributions[i];
1956 ::fseek(this->fd_, sect.offset + c.output_offset, SEEK_SET);
1957 if (::fwrite(c.contents, 1, c.size, this->fd_) < c.size)
1958 gold_fatal(_("%s: error writing section '%s'"), this->name_, sect.name);
1959 delete[] c.contents;
1963 // Write a new section to the output file.
1965 void
1966 Dwp_output_file::write_new_section(const char* section_name,
1967 const unsigned char* contents,
1968 section_size_type len, int align)
1970 section_name = this->shstrtab_.add_with_length(section_name,
1971 strlen(section_name),
1972 false, NULL);
1973 unsigned int shndx = this->add_output_section(section_name, align);
1974 Section& section = this->sections_[shndx - 1];
1975 off_t file_offset = this->next_file_offset_;
1976 file_offset = align_offset(file_offset, align);
1977 section.offset = file_offset;
1978 section.size = len;
1979 ::fseek(this->fd_, file_offset, SEEK_SET);
1980 if (::fwrite(contents, 1, len, this->fd_) < len)
1981 gold_fatal(_("%s: error writing section '%s'"), this->name_, section_name);
1982 this->next_file_offset_ = file_offset + len;
1985 // Write a CU or TU index section.
1987 template<bool big_endian>
1988 void
1989 Dwp_output_file::write_index(const char* sect_name, const Dwp_index& index)
1991 const unsigned int nslots = index.hash_table_total_slots();
1992 const unsigned int nused = index.hash_table_used_slots();
1993 const unsigned int nrows = index.section_table_rows();
1995 int column_mask = index.section_table_cols();
1996 unsigned int ncols = 0;
1997 for (unsigned int c = 1; c <= elfcpp::DW_SECT_MAX; ++c)
1998 if (column_mask & (1 << c))
1999 ncols++;
2000 const unsigned int ntable = (nrows * 2 + 1) * ncols;
2002 const section_size_type index_size = (4 * sizeof(uint32_t)
2003 + nslots * sizeof(uint64_t)
2004 + nslots * sizeof(uint32_t)
2005 + ntable * sizeof(uint32_t));
2007 // Allocate a buffer for the section contents.
2008 unsigned char* buf = new unsigned char[index_size];
2009 unsigned char* p = buf;
2011 // Write the section header: version number, padding,
2012 // number of used slots and total number of slots.
2013 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, 2);
2014 p += sizeof(uint32_t);
2015 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, ncols);
2016 p += sizeof(uint32_t);
2017 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, nused);
2018 p += sizeof(uint32_t);
2019 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, nslots);
2020 p += sizeof(uint32_t);
2022 // Write the hash table.
2023 for (unsigned int i = 0; i < nslots; ++i)
2025 elfcpp::Swap_unaligned<64, big_endian>::writeval(p, index.hash_table(i));
2026 p += sizeof(uint64_t);
2029 // Write the parallel index table.
2030 for (unsigned int i = 0; i < nslots; ++i)
2032 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, index.index_table(i));
2033 p += sizeof(uint32_t);
2036 // Write the first row of the table of section offsets.
2037 for (unsigned int c = 1; c <= elfcpp::DW_SECT_MAX; ++c)
2039 if (column_mask & (1 << c))
2041 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, c);
2042 p += sizeof(uint32_t);
2046 // Write the table of section offsets.
2047 Dwp_index::Section_table::const_iterator tbl = index.section_table();
2048 for (unsigned int r = 0; r < nrows; ++r)
2050 gold_assert(tbl != index.section_table_end());
2051 const Section_bounds* sects = (*tbl)->sections;
2052 for (unsigned int c = 1; c <= elfcpp::DW_SECT_MAX; ++c)
2054 if (column_mask & (1 << c))
2056 section_offset_type offset = sects[c].offset;
2057 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, offset);
2058 p += sizeof(uint32_t);
2060 else
2061 gold_assert(sects[c].size == 0);
2063 ++tbl;
2066 // Write the table of section sizes.
2067 tbl = index.section_table();
2068 for (unsigned int r = 0; r < nrows; ++r)
2070 gold_assert(tbl != index.section_table_end());
2071 const Section_bounds* sects = (*tbl)->sections;
2072 for (unsigned int c = 1; c <= elfcpp::DW_SECT_MAX; ++c)
2074 if (column_mask & (1 << c))
2076 section_size_type size = sects[c].size;
2077 elfcpp::Swap_unaligned<32, big_endian>::writeval(p, size);
2078 p += sizeof(uint32_t);
2080 else
2081 gold_assert(sects[c].size == 0);
2083 ++tbl;
2086 gold_assert(p == buf + index_size);
2088 this->write_new_section(sect_name, buf, index_size, sizeof(uint64_t));
2090 delete[] buf;
2093 // Write the ELF header.
2095 void
2096 Dwp_output_file::write_ehdr()
2098 if (this->size_ == 32)
2100 if (this->big_endian_)
2101 return this->sized_write_ehdr<32, true>();
2102 else
2103 return this->sized_write_ehdr<32, false>();
2105 else if (this->size_ == 64)
2107 if (this->big_endian_)
2108 return this->sized_write_ehdr<64, true>();
2109 else
2110 return this->sized_write_ehdr<64, false>();
2112 else
2113 gold_unreachable();
2116 template<unsigned int size, bool big_endian>
2117 void
2118 Dwp_output_file::sized_write_ehdr()
2120 const unsigned int ehdr_size = elfcpp::Elf_sizes<size>::ehdr_size;
2121 unsigned char buf[ehdr_size];
2122 elfcpp::Ehdr_write<size, big_endian> ehdr(buf);
2124 unsigned char e_ident[elfcpp::EI_NIDENT];
2125 memset(e_ident, 0, elfcpp::EI_NIDENT);
2126 e_ident[elfcpp::EI_MAG0] = elfcpp::ELFMAG0;
2127 e_ident[elfcpp::EI_MAG1] = elfcpp::ELFMAG1;
2128 e_ident[elfcpp::EI_MAG2] = elfcpp::ELFMAG2;
2129 e_ident[elfcpp::EI_MAG3] = elfcpp::ELFMAG3;
2130 if (size == 32)
2131 e_ident[elfcpp::EI_CLASS] = elfcpp::ELFCLASS32;
2132 else if (size == 64)
2133 e_ident[elfcpp::EI_CLASS] = elfcpp::ELFCLASS64;
2134 else
2135 gold_unreachable();
2136 e_ident[elfcpp::EI_DATA] = (big_endian
2137 ? elfcpp::ELFDATA2MSB
2138 : elfcpp::ELFDATA2LSB);
2139 e_ident[elfcpp::EI_VERSION] = elfcpp::EV_CURRENT;
2140 ehdr.put_e_ident(e_ident);
2142 ehdr.put_e_type(elfcpp::ET_REL);
2143 ehdr.put_e_machine(this->machine_);
2144 ehdr.put_e_version(elfcpp::EV_CURRENT);
2145 ehdr.put_e_entry(0);
2146 ehdr.put_e_phoff(0);
2147 ehdr.put_e_shoff(this->shoff_);
2148 ehdr.put_e_flags(0);
2149 ehdr.put_e_ehsize(elfcpp::Elf_sizes<size>::ehdr_size);
2150 ehdr.put_e_phentsize(0);
2151 ehdr.put_e_phnum(0);
2152 ehdr.put_e_shentsize(elfcpp::Elf_sizes<size>::shdr_size);
2153 ehdr.put_e_shnum(this->shnum_ < elfcpp::SHN_LORESERVE ? this->shnum_ : 0);
2154 ehdr.put_e_shstrndx(this->shstrndx_ < elfcpp::SHN_LORESERVE
2155 ? this->shstrndx_
2156 : static_cast<unsigned int>(elfcpp::SHN_XINDEX));
2158 ::fseek(this->fd_, 0, 0);
2159 if (::fwrite(buf, 1, ehdr_size, this->fd_) < ehdr_size)
2160 gold_fatal(_("%s: error writing ELF header"), this->name_);
2163 // Write a section header.
2165 void
2166 Dwp_output_file::write_shdr(const char* name, unsigned int type,
2167 unsigned int flags, uint64_t addr, off_t offset,
2168 section_size_type sect_size, unsigned int link,
2169 unsigned int info, unsigned int align,
2170 unsigned int ent_size)
2172 if (this->size_ == 32)
2174 if (this->big_endian_)
2175 return this->sized_write_shdr<32, true>(name, type, flags, addr,
2176 offset, sect_size, link, info,
2177 align, ent_size);
2178 else
2179 return this->sized_write_shdr<32, false>(name, type, flags, addr,
2180 offset, sect_size, link, info,
2181 align, ent_size);
2183 else if (this->size_ == 64)
2185 if (this->big_endian_)
2186 return this->sized_write_shdr<64, true>(name, type, flags, addr,
2187 offset, sect_size, link, info,
2188 align, ent_size);
2189 else
2190 return this->sized_write_shdr<64, false>(name, type, flags, addr,
2191 offset, sect_size, link, info,
2192 align, ent_size);
2194 else
2195 gold_unreachable();
2198 template<unsigned int size, bool big_endian>
2199 void
2200 Dwp_output_file::sized_write_shdr(const char* name, unsigned int type,
2201 unsigned int flags, uint64_t addr,
2202 off_t offset, section_size_type sect_size,
2203 unsigned int link, unsigned int info,
2204 unsigned int align, unsigned int ent_size)
2206 const unsigned int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
2207 unsigned char buf[shdr_size];
2208 elfcpp::Shdr_write<size, big_endian> shdr(buf);
2210 shdr.put_sh_name(name == NULL ? 0 : this->shstrtab_.get_offset(name));
2211 shdr.put_sh_type(type);
2212 shdr.put_sh_flags(flags);
2213 shdr.put_sh_addr(addr);
2214 shdr.put_sh_offset(offset);
2215 shdr.put_sh_size(sect_size);
2216 shdr.put_sh_link(link);
2217 shdr.put_sh_info(info);
2218 shdr.put_sh_addralign(align);
2219 shdr.put_sh_entsize(ent_size);
2220 if (::fwrite(buf, 1, shdr_size, this->fd_) < shdr_size)
2221 gold_fatal(_("%s: error writing section header table"), this->name_);
2224 // Class Dwo_name_info_reader.
2226 // Visit a compilation unit.
2228 void
2229 Dwo_name_info_reader::visit_compilation_unit(off_t, off_t, Dwarf_die* die)
2231 const char* dwo_name = die->string_attribute(elfcpp::DW_AT_GNU_dwo_name);
2232 if (dwo_name != NULL)
2234 uint64_t dwo_id = die->uint_attribute(elfcpp::DW_AT_GNU_dwo_id);
2235 this->files_->push_back(Dwo_file_entry(dwo_id, dwo_name));
2239 // Class Unit_reader.
2241 // Read the CUs or TUs and add them to the output file.
2243 void
2244 Unit_reader::add_units(Dwp_output_file* output_file,
2245 unsigned int debug_abbrev,
2246 Section_bounds* sections)
2248 this->output_file_ = output_file;
2249 this->sections_ = sections;
2250 this->set_abbrev_shndx(debug_abbrev);
2251 this->parse();
2254 // Visit a compilation unit.
2256 void
2257 Unit_reader::visit_compilation_unit(off_t, off_t cu_length, Dwarf_die* die)
2259 if (cu_length == 0)
2260 return;
2262 Unit_set* unit_set = new Unit_set();
2263 unit_set->signature = die->uint_attribute(elfcpp::DW_AT_GNU_dwo_id);
2264 for (unsigned int i = elfcpp::DW_SECT_ABBREV; i <= elfcpp::DW_SECT_MAX; ++i)
2265 unit_set->sections[i] = this->sections_[i];
2267 // Dwp_output_file::add_contribution writes the .debug_info.dwo section
2268 // directly to the output file, so we do not need to duplicate the
2269 // section contents, and add_contribution does not need to free the memory.
2270 section_offset_type off =
2271 this->output_file_->add_contribution(elfcpp::DW_SECT_INFO,
2272 this->buffer_at_offset(0),
2273 cu_length, 1);
2274 Section_bounds bounds(off, cu_length);
2275 unit_set->sections[elfcpp::DW_SECT_INFO] = bounds;
2276 this->output_file_->add_cu_set(unit_set);
2279 // Visit a type unit.
2281 void
2282 Unit_reader::visit_type_unit(off_t, off_t tu_length, off_t,
2283 uint64_t signature, Dwarf_die*)
2285 if (tu_length == 0)
2286 return;
2287 if (this->output_file_->lookup_tu(signature))
2288 return;
2290 Unit_set* unit_set = new Unit_set();
2291 unit_set->signature = signature;
2292 for (unsigned int i = elfcpp::DW_SECT_ABBREV; i <= elfcpp::DW_SECT_MAX; ++i)
2293 unit_set->sections[i] = this->sections_[i];
2295 unsigned char* contents = new unsigned char[tu_length];
2296 memcpy(contents, this->buffer_at_offset(0), tu_length);
2297 section_offset_type off =
2298 this->output_file_->add_contribution(elfcpp::DW_SECT_TYPES, contents,
2299 tu_length, 1);
2300 Section_bounds bounds(off, tu_length);
2301 unit_set->sections[elfcpp::DW_SECT_TYPES] = bounds;
2302 this->output_file_->add_tu_set(unit_set);
2305 }; // End namespace gold
2307 using namespace gold;
2309 // Options.
2311 enum Dwp_options {
2312 VERIFY_ONLY = 0x101,
2315 struct option dwp_options[] =
2317 { "exec", required_argument, NULL, 'e' },
2318 { "help", no_argument, NULL, 'h' },
2319 { "output", required_argument, NULL, 'o' },
2320 { "verbose", no_argument, NULL, 'v' },
2321 { "verify-only", no_argument, NULL, VERIFY_ONLY },
2322 { "version", no_argument, NULL, 'V' },
2323 { NULL, 0, NULL, 0 }
2326 // Print usage message and exit.
2328 static void
2329 usage(FILE* fd, int exit_status)
2331 fprintf(fd, _("Usage: %s [options] [file...]\n"), program_name);
2332 fprintf(fd, _(" -h, --help Print this help message\n"));
2333 fprintf(fd, _(" -e EXE, --exec EXE Get list of dwo files from EXE"
2334 " (defaults output to EXE.dwp)\n"));
2335 fprintf(fd, _(" -o FILE, --output FILE Set output dwp file name\n"));
2336 fprintf(fd, _(" -v, --verbose Verbose output\n"));
2337 fprintf(fd, _(" --verify-only Verify output file against"
2338 " exec file\n"));
2339 fprintf(fd, _(" -V, --version Print version number\n"));
2341 // REPORT_BUGS_TO is defined in bfd/bfdver.h.
2342 const char* report = REPORT_BUGS_TO;
2343 if (*report != '\0')
2344 fprintf(fd, _("\nReport bugs to %s\n"), report);
2345 exit(exit_status);
2348 // Report version information.
2350 static void
2351 print_version()
2353 // This output is intended to follow the GNU standards.
2354 printf("GNU dwp %s\n", BFD_VERSION_STRING);
2355 printf(_("Copyright (C) 2014 Free Software Foundation, Inc.\n"));
2356 printf(_("\
2357 This program is free software; you may redistribute it under the terms of\n\
2358 the GNU General Public License version 3 or (at your option) any later version.\n\
2359 This program has absolutely no warranty.\n"));
2360 exit(EXIT_SUCCESS);
2363 // Main program.
2366 main(int argc, char** argv)
2368 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
2369 setlocale(LC_MESSAGES, "");
2370 #endif
2371 #if defined (HAVE_SETLOCALE)
2372 setlocale(LC_CTYPE, "");
2373 #endif
2374 bindtextdomain(PACKAGE, LOCALEDIR);
2375 textdomain(PACKAGE);
2377 program_name = argv[0];
2379 // Initialize the global parameters, to let random code get to the
2380 // errors object.
2381 Errors errors(program_name);
2382 set_parameters_errors(&errors);
2384 // Initialize gold's global options. We don't use these in
2385 // this program, but they need to be initialized so that
2386 // functions we call from libgold work properly.
2387 General_options options;
2388 set_parameters_options(&options);
2390 // In libiberty; expands @filename to the args in "filename".
2391 expandargv(&argc, &argv);
2393 // Collect file names and options.
2394 File_list files;
2395 std::string output_filename;
2396 const char* exe_filename = NULL;
2397 bool verbose = false;
2398 bool verify_only = false;
2399 int c;
2400 while ((c = getopt_long(argc, argv, "e:ho:vV", dwp_options, NULL)) != -1)
2402 switch (c)
2404 case 'h':
2405 usage(stdout, EXIT_SUCCESS);
2406 case 'e':
2407 exe_filename = optarg;
2408 break;
2409 case 'o':
2410 output_filename.assign(optarg);
2411 break;
2412 case 'v':
2413 verbose = true;
2414 break;
2415 case VERIFY_ONLY:
2416 verify_only = true;
2417 break;
2418 case 'V':
2419 print_version();
2420 case '?':
2421 default:
2422 usage(stderr, EXIT_FAILURE);
2426 if (output_filename.empty())
2428 if (exe_filename == NULL)
2429 gold_fatal(_("no output file specified"));
2430 output_filename.assign(exe_filename);
2431 output_filename.append(".dwp");
2434 // Get list of .dwo files from the executable.
2435 if (exe_filename != NULL)
2437 Dwo_file exe_file(exe_filename);
2438 exe_file.read_executable(&files);
2441 // Add any additional files listed on command line.
2442 for (int i = optind; i < argc; ++i)
2443 files.push_back(Dwo_file_entry(0, argv[i]));
2445 if (exe_filename == NULL && files.empty())
2446 gold_fatal(_("no input files and no executable specified"));
2448 if (verify_only)
2450 // Get list of DWO files in the DWP file and compare with
2451 // references found in the EXE file.
2452 Dwo_file dwp_file(output_filename.c_str());
2453 bool ok = dwp_file.verify(files);
2454 return ok ? EXIT_SUCCESS : EXIT_FAILURE;
2457 // Process each file, adding its contents to the output file.
2458 Dwp_output_file output_file(output_filename.c_str());
2459 for (File_list::const_iterator f = files.begin(); f != files.end(); ++f)
2461 if (verbose)
2462 fprintf(stderr, "%s\n", f->dwo_name.c_str());
2463 Dwo_file dwo_file(f->dwo_name.c_str());
2464 dwo_file.read(&output_file);
2466 output_file.finalize();
2468 return EXIT_SUCCESS;