1 // layout.h -- lay out output file sections for gold -*- C++ -*-
3 // Copyright (C) 2006-2015 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@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.
34 #include "workqueue.h"
37 #include "stringpool.h"
42 class General_options;
43 class Incremental_inputs;
44 class Incremental_binary;
48 class Output_section_data;
50 class Output_section_headers;
51 class Output_segment_headers;
52 class Output_file_header;
55 class Output_data_reloc_generic;
56 class Output_data_dynamic;
57 class Output_symtab_xindex;
58 class Output_reduced_debug_abbrev_section;
59 class Output_reduced_debug_info_section;
65 // Return TRUE if SECNAME is the name of a compressed debug section.
67 is_compressed_debug_section(const char* secname);
69 // Return the name of the corresponding uncompressed debug section.
71 corresponding_uncompressed_section_name(std::string secname);
73 // Maintain a list of free space within a section, segment, or file.
74 // Used for incremental update links.
81 Free_list_node(off_t start, off_t end)
82 : start_(start), end_(end)
87 typedef std::list<Free_list_node>::const_iterator Const_iterator;
90 : list_(), last_remove_(list_.begin()), extend_(false), length_(0),
94 // Initialize the free list for a section of length LEN.
95 // If EXTEND is true, free space may be allocated past the end.
97 init(off_t len, bool extend);
99 // Set the minimum hole size that is allowed when allocating
100 // from the free list.
102 set_min_hole_size(off_t min_hole)
103 { this->min_hole_ = min_hole; }
105 // Remove a chunk from the free list.
107 remove(off_t start, off_t end);
109 // Allocate a chunk of space from the free list of length LEN,
110 // with alignment ALIGN, and minimum offset MINOFF.
112 allocate(off_t len, uint64_t align, off_t minoff);
114 // Return an iterator for the beginning of the free list.
117 { return this->list_.begin(); }
119 // Return an iterator for the end of the free list.
122 { return this->list_.end(); }
124 // Dump the free list (for debugging).
128 // Print usage statistics.
133 typedef std::list<Free_list_node>::iterator Iterator;
136 std::list<Free_list_node> list_;
138 // The last node visited during a remove operation.
139 Iterator last_remove_;
141 // Whether we can extend past the original length.
144 // The total length of the section, segment, or file.
147 // The minimum hole size allowed. When allocating from the free list,
148 // we must not leave a hole smaller than this.
152 // The total number of free lists used.
153 static unsigned int num_lists;
154 // The total number of free list nodes used.
155 static unsigned int num_nodes;
156 // The total number of calls to Free_list::remove.
157 static unsigned int num_removes;
158 // The total number of nodes visited during calls to Free_list::remove.
159 static unsigned int num_remove_visits;
160 // The total number of calls to Free_list::allocate.
161 static unsigned int num_allocates;
162 // The total number of nodes visited during calls to Free_list::allocate.
163 static unsigned int num_allocate_visits;
166 // This task function handles mapping the input sections to output
167 // sections and laying them out in memory.
169 class Layout_task_runner : public Task_function_runner
172 // OPTIONS is the command line options, INPUT_OBJECTS is the list of
173 // input objects, SYMTAB is the symbol table, LAYOUT is the layout
175 Layout_task_runner(const General_options& options,
176 const Input_objects* input_objects,
177 Symbol_table* symtab,
181 : options_(options), input_objects_(input_objects), symtab_(symtab),
182 target_(target), layout_(layout), mapfile_(mapfile)
185 // Run the operation.
187 run(Workqueue*, const Task*);
190 Layout_task_runner(const Layout_task_runner&);
191 Layout_task_runner& operator=(const Layout_task_runner&);
193 const General_options& options_;
194 const Input_objects* input_objects_;
195 Symbol_table* symtab_;
201 // This class holds information about the comdat group or
202 // .gnu.linkonce section that will be kept for a given signature.
207 // For a comdat group, we build a mapping from the name of each
208 // section in the group to the section index and the size in object.
209 // When we discard a group in some other object file, we use this
210 // map to figure out which kept section the discarded section is
211 // associated with. We then use that mapping when processing relocs
212 // against discarded sections.
213 struct Comdat_section_info
215 // The section index.
220 Comdat_section_info(unsigned int a_shndx, uint64_t a_size)
221 : shndx(a_shndx), size(a_size)
225 // Most comdat groups have only one or two sections, so we use a
226 // std::map rather than an Unordered_map to optimize for that case
227 // without paying too heavily for groups with more sections.
228 typedef std::map<std::string, Comdat_section_info> Comdat_group;
232 : object_(NULL), shndx_(0), is_comdat_(false), is_group_name_(false)
233 { this->u_.linkonce_size = 0; }
235 // We need to support copies for the signature map in the Layout
236 // object, but we should never copy an object after it has been
237 // marked as a comdat section.
238 Kept_section(const Kept_section& k)
239 : object_(k.object_), shndx_(k.shndx_), is_comdat_(false),
240 is_group_name_(k.is_group_name_)
242 gold_assert(!k.is_comdat_);
243 this->u_.linkonce_size = 0;
248 if (this->is_comdat_)
249 delete this->u_.group_sections;
252 // The object where this section lives.
255 { return this->object_; }
259 set_object(Relobj* object)
261 gold_assert(this->object_ == NULL);
262 this->object_ = object;
265 // The section index.
268 { return this->shndx_; }
270 // Set the section index.
272 set_shndx(unsigned int shndx)
274 gold_assert(this->shndx_ == 0);
275 this->shndx_ = shndx;
278 // Whether this is a comdat group.
281 { return this->is_comdat_; }
283 // Set that this is a comdat group.
287 gold_assert(!this->is_comdat_);
288 this->is_comdat_ = true;
289 this->u_.group_sections = new Comdat_group();
292 // Whether this is associated with the name of a group or section
293 // rather than the symbol name derived from a linkonce section.
295 is_group_name() const
296 { return this->is_group_name_; }
298 // Note that this represents a comdat group rather than a single
302 { this->is_group_name_ = true; }
304 // Add a section to the group list.
306 add_comdat_section(const std::string& name, unsigned int shndx,
309 gold_assert(this->is_comdat_);
310 Comdat_section_info sinfo(shndx, size);
311 this->u_.group_sections->insert(std::make_pair(name, sinfo));
314 // Look for a section name in the group list, and return whether it
315 // was found. If found, returns the section index and size.
317 find_comdat_section(const std::string& name, unsigned int* pshndx,
318 uint64_t* psize) const
320 gold_assert(this->is_comdat_);
321 Comdat_group::const_iterator p = this->u_.group_sections->find(name);
322 if (p == this->u_.group_sections->end())
324 *pshndx = p->second.shndx;
325 *psize = p->second.size;
329 // If there is only one section in the group list, return true, and
330 // return the section index and size.
332 find_single_comdat_section(unsigned int* pshndx, uint64_t* psize) const
334 gold_assert(this->is_comdat_);
335 if (this->u_.group_sections->size() != 1)
337 Comdat_group::const_iterator p = this->u_.group_sections->begin();
338 *pshndx = p->second.shndx;
339 *psize = p->second.size;
343 // Return the size of a linkonce section.
345 linkonce_size() const
347 gold_assert(!this->is_comdat_);
348 return this->u_.linkonce_size;
351 // Set the size of a linkonce section.
353 set_linkonce_size(uint64_t size)
355 gold_assert(!this->is_comdat_);
356 this->u_.linkonce_size = size;
361 Kept_section& operator=(const Kept_section&);
363 // The object containing the comdat group or .gnu.linkonce section.
365 // Index of the group section for comdats and the section itself for
368 // True if this is for a comdat group rather than a .gnu.linkonce
371 // The Kept_sections are values of a mapping, that maps names to
372 // them. This field is true if this struct is associated with the
373 // name of a comdat or .gnu.linkonce, false if it is associated with
374 // the name of a symbol obtained from the .gnu.linkonce.* name
375 // through some heuristics.
379 // If the is_comdat_ field is true, this holds a map from names of
380 // the sections in the group to section indexes in object_ and to
382 Comdat_group* group_sections;
383 // If the is_comdat_ field is false, this holds the size of the
385 uint64_t linkonce_size;
389 // The ordering for output sections. This controls how output
390 // sections are ordered within a PT_LOAD output segment.
392 enum Output_section_order
394 // Unspecified. Used for non-load segments. Also used for the file
395 // and segment headers.
398 // The PT_INTERP section should come first, so that the dynamic
399 // linker can pick it up quickly.
402 // Loadable read-only note sections come next so that the PT_NOTE
403 // segment is on the first page of the executable.
406 // Put read-only sections used by the dynamic linker early in the
407 // executable to minimize paging.
408 ORDER_DYNAMIC_LINKER,
410 // Put reloc sections used by the dynamic linker after other
411 // sections used by the dynamic linker; otherwise, objcopy and strip
413 ORDER_DYNAMIC_RELOCS,
415 // Put the PLT reloc section after the other dynamic relocs;
416 // otherwise, prelink gets confused.
417 ORDER_DYNAMIC_PLT_RELOCS,
419 // The .init section.
425 // The regular text sections.
428 // The .fini section.
431 // The read-only sections.
434 // The exception frame sections.
437 // The TLS sections come first in the data section.
441 // Local RELRO (read-only after relocation) sections come before
442 // non-local RELRO sections. This data will be fully resolved by
446 // Non-local RELRO sections are grouped together after local RELRO
447 // sections. All RELRO sections must be adjacent so that they can
448 // all be put into a PT_GNU_RELRO segment.
451 // We permit marking exactly one output section as the last RELRO
452 // section. We do this so that the read-only GOT can be adjacent to
456 // Similarly, we permit marking exactly one output section as the
457 // first non-RELRO section.
458 ORDER_NON_RELRO_FIRST,
460 // The regular data sections come after the RELRO sections.
463 // Large data sections normally go in large data segments.
466 // Group writable notes so that we can have a single PT_NOTE
470 // The small data sections must be at the end of the data sections,
471 // so that they can be adjacent to the small BSS sections.
474 // The BSS sections start here.
476 // The small BSS sections must be at the start of the BSS sections,
477 // so that they can be adjacent to the small data sections.
480 // The regular BSS sections.
483 // The large BSS sections come after the other BSS sections.
490 // This class handles the details of laying out input sections.
495 Layout(int number_of_input_files, Script_options*);
499 delete this->relaxation_debug_check_;
500 delete this->segment_states_;
503 // For incremental links, record the base file to be modified.
505 set_incremental_base(Incremental_binary* base);
509 { return this->incremental_base_; }
511 // For incremental links, record the initial fixed layout of a section
512 // from the base file, and return a pointer to the Output_section.
513 template<int size, bool big_endian>
515 init_fixed_output_section(const char*, elfcpp::Shdr<size, big_endian>&);
517 // Given an input section SHNDX, named NAME, with data in SHDR, from
518 // the object file OBJECT, return the output section where this
519 // input section should go. RELOC_SHNDX is the index of a
520 // relocation section which applies to this section, or 0 if none,
521 // or -1U if more than one. RELOC_TYPE is the type of the
522 // relocation section if there is one. Set *OFFSET to the offset
523 // within the output section.
524 template<int size, bool big_endian>
526 layout(Sized_relobj_file<size, big_endian> *object, unsigned int shndx,
527 const char* name, const elfcpp::Shdr<size, big_endian>& shdr,
528 unsigned int reloc_shndx, unsigned int reloc_type, off_t* offset);
530 std::map<Section_id, unsigned int>*
531 get_section_order_map()
532 { return &this->section_order_map_; }
534 // Struct to store segment info when mapping some input sections to
535 // unique segments using linker plugins. Mapping an input section to
536 // a unique segment is done by first placing such input sections in
537 // unique output sections and then mapping the output section to a
538 // unique segment. NAME is the name of the output section. FLAGS
539 // and ALIGN are the extra flags and alignment of the segment.
540 struct Unique_segment_info
542 // Identifier for the segment. ELF segments dont have names. This
543 // is used as the name of the output section mapped to the segment.
545 // Additional segment flags.
547 // Segment alignment.
551 // Mapping from input section to segment.
552 typedef std::map<Const_section_id, Unique_segment_info*>
555 // Maps section SECN to SEGMENT s.
557 insert_section_segment_map(Const_section_id secn, Unique_segment_info *s);
559 // Some input sections require special ordering, for compatibility
560 // with GNU ld. Given the name of an input section, return -1 if it
561 // does not require special ordering. Otherwise, return the index
562 // by which it should be ordered compared to other input sections
563 // that require special ordering.
565 special_ordering_of_input_section(const char* name);
568 is_section_ordering_specified()
569 { return this->section_ordering_specified_; }
572 set_section_ordering_specified()
573 { this->section_ordering_specified_ = true; }
576 is_unique_segment_for_sections_specified() const
577 { return this->unique_segment_for_sections_specified_; }
580 set_unique_segment_for_sections_specified()
581 { this->unique_segment_for_sections_specified_ = true; }
583 // For incremental updates, allocate a block of memory from the
584 // free list. Find a block starting at or after MINOFF.
586 allocate(off_t len, uint64_t align, off_t minoff)
587 { return this->free_list_.allocate(len, align, minoff); }
590 find_section_order_index(const std::string&);
592 // Read the sequence of input sections from the file specified with
593 // linker option --section-ordering-file.
595 read_layout_from_file();
597 // Layout an input reloc section when doing a relocatable link. The
598 // section is RELOC_SHNDX in OBJECT, with data in SHDR.
599 // DATA_SECTION is the reloc section to which it refers. RR is the
600 // relocatable information.
601 template<int size, bool big_endian>
603 layout_reloc(Sized_relobj_file<size, big_endian>* object,
604 unsigned int reloc_shndx,
605 const elfcpp::Shdr<size, big_endian>& shdr,
606 Output_section* data_section,
607 Relocatable_relocs* rr);
609 // Layout a group section when doing a relocatable link.
610 template<int size, bool big_endian>
612 layout_group(Symbol_table* symtab,
613 Sized_relobj_file<size, big_endian>* object,
614 unsigned int group_shndx,
615 const char* group_section_name,
616 const char* signature,
617 const elfcpp::Shdr<size, big_endian>& shdr,
618 elfcpp::Elf_Word flags,
619 std::vector<unsigned int>* shndxes);
621 // Like layout, only for exception frame sections. OBJECT is an
622 // object file. SYMBOLS is the contents of the symbol table
623 // section, with size SYMBOLS_SIZE. SYMBOL_NAMES is the contents of
624 // the symbol name section, with size SYMBOL_NAMES_SIZE. SHNDX is a
625 // .eh_frame section in OBJECT. SHDR is the section header.
626 // RELOC_SHNDX is the index of a relocation section which applies to
627 // this section, or 0 if none, or -1U if more than one. RELOC_TYPE
628 // is the type of the relocation section if there is one. This
629 // returns the output section, and sets *OFFSET to the offset.
630 template<int size, bool big_endian>
632 layout_eh_frame(Sized_relobj_file<size, big_endian>* object,
633 const unsigned char* symbols,
635 const unsigned char* symbol_names,
636 off_t symbol_names_size,
638 const elfcpp::Shdr<size, big_endian>& shdr,
639 unsigned int reloc_shndx, unsigned int reloc_type,
642 // After processing all input files, we call this to make sure that
643 // the optimized .eh_frame sections have been added to the output
646 finalize_eh_frame_section();
648 // Add .eh_frame information for a PLT. The FDE must start with a
649 // 4-byte PC-relative reference to the start of the PLT, followed by
650 // a 4-byte size of PLT.
652 add_eh_frame_for_plt(Output_data* plt, const unsigned char* cie_data,
653 size_t cie_length, const unsigned char* fde_data,
656 // Scan a .debug_info or .debug_types section, and add summary
657 // information to the .gdb_index section.
658 template<int size, bool big_endian>
660 add_to_gdb_index(bool is_type_unit,
661 Sized_relobj<size, big_endian>* object,
662 const unsigned char* symbols,
665 unsigned int reloc_shndx,
666 unsigned int reloc_type);
668 // Handle a GNU stack note. This is called once per input object
669 // file. SEEN_GNU_STACK is true if the object file has a
670 // .note.GNU-stack section. GNU_STACK_FLAGS is the section flags
671 // from that section if there was one.
673 layout_gnu_stack(bool seen_gnu_stack, uint64_t gnu_stack_flags,
676 // Add an Output_section_data to the layout. This is used for
677 // special sections like the GOT section. ORDER is where the
678 // section should wind up in the output segment. IS_RELRO is true
679 // for relro sections.
681 add_output_section_data(const char* name, elfcpp::Elf_Word type,
682 elfcpp::Elf_Xword flags,
683 Output_section_data*, Output_section_order order,
686 // Increase the size of the relro segment by this much.
688 increase_relro(unsigned int s)
689 { this->increase_relro_ += s; }
691 // Create dynamic sections if necessary.
693 create_initial_dynamic_sections(Symbol_table*);
695 // Define __start and __stop symbols for output sections.
697 define_section_symbols(Symbol_table*);
699 // Create automatic note sections.
703 // Create sections for linker scripts.
705 create_script_sections()
706 { this->script_options_->create_script_sections(this); }
708 // Define symbols from any linker script.
710 define_script_symbols(Symbol_table* symtab)
711 { this->script_options_->add_symbols_to_table(symtab); }
713 // Define symbols for group signatures.
715 define_group_signatures(Symbol_table*);
717 // Return the Stringpool used for symbol names.
720 { return &this->sympool_; }
722 // Return the Stringpool used for dynamic symbol names and dynamic
726 { return &this->dynpool_; }
728 // Return the .dynamic output section. This is only valid after the
729 // layout has been finalized.
731 dynamic_section() const
732 { return this->dynamic_section_; }
734 // Return the symtab_xindex section used to hold large section
735 // indexes for the normal symbol table.
736 Output_symtab_xindex*
737 symtab_xindex() const
738 { return this->symtab_xindex_; }
740 // Return the dynsym_xindex section used to hold large section
741 // indexes for the dynamic symbol table.
742 Output_symtab_xindex*
743 dynsym_xindex() const
744 { return this->dynsym_xindex_; }
746 // Return whether a section is a .gnu.linkonce section, given the
749 is_linkonce(const char* name)
750 { return strncmp(name, ".gnu.linkonce", sizeof(".gnu.linkonce") - 1) == 0; }
752 // Whether we have added an input section.
754 have_added_input_section() const
755 { return this->have_added_input_section_; }
757 // Return true if a section is a debugging section.
759 is_debug_info_section(const char* name)
761 // Debugging sections can only be recognized by name.
762 return (strncmp(name, ".debug", sizeof(".debug") - 1) == 0
763 || strncmp(name, ".zdebug", sizeof(".zdebug") - 1) == 0
764 || strncmp(name, ".gnu.linkonce.wi.",
765 sizeof(".gnu.linkonce.wi.") - 1) == 0
766 || strncmp(name, ".line", sizeof(".line") - 1) == 0
767 || strncmp(name, ".stab", sizeof(".stab") - 1) == 0);
770 // Return true if RELOBJ is an input file whose base name matches
771 // FILE_NAME. The base name must have an extension of ".o", and
772 // must be exactly FILE_NAME.o or FILE_NAME, one character, ".o".
774 match_file_name(const Relobj* relobj, const char* file_name);
776 // Return whether section SHNDX in RELOBJ is a .ctors/.dtors section
777 // with more than one word being mapped to a .init_array/.fini_array
780 is_ctors_in_init_array(Relobj* relobj, unsigned int shndx) const;
782 // Check if a comdat group or .gnu.linkonce section with the given
783 // NAME is selected for the link. If there is already a section,
784 // *KEPT_SECTION is set to point to the signature and the function
785 // returns false. Otherwise, OBJECT, SHNDX,IS_COMDAT, and
786 // IS_GROUP_NAME are recorded for this NAME in the layout object,
787 // *KEPT_SECTION is set to the internal copy and the function return
790 find_or_add_kept_section(const std::string& name, Relobj* object,
791 unsigned int shndx, bool is_comdat,
792 bool is_group_name, Kept_section** kept_section);
794 // Finalize the layout after all the input sections have been added.
796 finalize(const Input_objects*, Symbol_table*, Target*, const Task*);
798 // Return whether any sections require postprocessing.
800 any_postprocessing_sections() const
801 { return this->any_postprocessing_sections_; }
803 // Return the size of the output file.
805 output_file_size() const
806 { return this->output_file_size_; }
808 // Return the TLS segment. This will return NULL if there isn't
812 { return this->tls_segment_; }
814 // Return the normal symbol table.
816 symtab_section() const
818 gold_assert(this->symtab_section_ != NULL);
819 return this->symtab_section_;
822 // Return the file offset of the normal symbol table.
824 symtab_section_offset() const;
826 // Return the section index of the normal symbol tabl.e
828 symtab_section_shndx() const;
830 // Return the dynamic symbol table.
832 dynsym_section() const
834 gold_assert(this->dynsym_section_ != NULL);
835 return this->dynsym_section_;
838 // Return the dynamic tags.
841 { return this->dynamic_data_; }
843 // Write out the output sections.
845 write_output_sections(Output_file* of) const;
847 // Write out data not associated with an input file or the symbol
850 write_data(const Symbol_table*, Output_file*) const;
852 // Write out output sections which can not be written until all the
853 // input sections are complete.
855 write_sections_after_input_sections(Output_file* of);
857 // Return an output section named NAME, or NULL if there is none.
859 find_output_section(const char* name) const;
861 // Return an output segment of type TYPE, with segment flags SET set
862 // and segment flags CLEAR clear. Return NULL if there is none.
864 find_output_segment(elfcpp::PT type, elfcpp::Elf_Word set,
865 elfcpp::Elf_Word clear) const;
867 // Return the number of segments we expect to produce.
869 expected_segment_count() const;
871 // Set a flag to indicate that an object file uses the static TLS model.
874 { this->has_static_tls_ = true; }
876 // Return true if any object file uses the static TLS model.
878 has_static_tls() const
879 { return this->has_static_tls_; }
881 // Return the options which may be set by a linker script.
884 { return this->script_options_; }
886 const Script_options*
887 script_options() const
888 { return this->script_options_; }
890 // Return the object managing inputs in incremental build. NULL in
891 // non-incremental builds.
893 incremental_inputs() const
894 { return this->incremental_inputs_; }
896 // For the target-specific code to add dynamic tags which are common
899 add_target_dynamic_tags(bool use_rel, const Output_data* plt_got,
900 const Output_data* plt_rel,
901 const Output_data_reloc_generic* dyn_rel,
902 bool add_debug, bool dynrel_includes_plt);
904 // Compute and write out the build ID if needed.
906 write_build_id(Output_file*, unsigned char*, size_t) const;
908 // Rewrite output file in binary format.
910 write_binary(Output_file* in) const;
912 // Print output sections to the map file.
914 print_to_mapfile(Mapfile*) const;
916 // Dump statistical information to stderr.
920 // A list of segments.
922 typedef std::vector<Output_segment*> Segment_list;
924 // A list of sections.
926 typedef std::vector<Output_section*> Section_list;
928 // The list of information to write out which is not attached to
929 // either a section or a segment.
930 typedef std::vector<Output_data*> Data_list;
932 // Store the allocated sections into the section list. This is used
933 // by the linker script code.
935 get_allocated_sections(Section_list*) const;
937 // Store the executable sections into the section list.
939 get_executable_sections(Section_list*) const;
941 // Make a section for a linker script to hold data.
943 make_output_section_for_script(const char* name,
944 Script_sections::Section_type section_type);
946 // Make a segment. This is used by the linker script code.
948 make_output_segment(elfcpp::Elf_Word type, elfcpp::Elf_Word flags);
950 // Return the number of segments.
952 segment_count() const
953 { return this->segment_list_.size(); }
955 // Map from section flags to segment flags.
956 static elfcpp::Elf_Word
957 section_flags_to_segment(elfcpp::Elf_Xword flags);
959 // Attach sections to segments.
961 attach_sections_to_segments(const Target*);
963 // For relaxation clean up, we need to know output section data created
964 // from a linker script.
966 new_output_section_data_from_script(Output_section_data* posd)
968 if (this->record_output_section_data_from_script_)
969 this->script_output_section_data_list_.push_back(posd);
972 // Return section list.
975 { return this->section_list_; }
977 // Returns TRUE iff NAME (an input section from RELOBJ) will
978 // be mapped to an output section that should be KEPT.
980 keep_input_section(const Relobj*, const char*);
982 // Add a special output object that will be recreated afresh
983 // if there is another relaxation iteration.
985 add_relax_output(Output_data* data)
986 { this->relax_output_list_.push_back(data); }
988 // Clear out (and free) everything added by add_relax_output.
990 reset_relax_output();
993 Layout(const Layout&);
994 Layout& operator=(const Layout&);
996 // Mapping from input section names to output section names.
997 struct Section_name_mapping
1004 static const Section_name_mapping section_name_mapping[];
1005 static const int section_name_mapping_count;
1007 // During a relocatable link, a list of group sections and
1009 struct Group_signature
1011 // The group section.
1012 Output_section* section;
1014 const char* signature;
1017 : section(NULL), signature(NULL)
1020 Group_signature(Output_section* sectiona, const char* signaturea)
1021 : section(sectiona), signature(signaturea)
1024 typedef std::vector<Group_signature> Group_signatures;
1026 // Create a note section, filling in the header.
1028 create_note(const char* name, int note_type, const char* section_name,
1029 size_t descsz, bool allocate, size_t* trailing_padding);
1031 // Create a note section for gold version.
1035 // Record whether the stack must be executable.
1037 create_executable_stack_info();
1039 // Create a build ID note if needed.
1043 // Link .stab and .stabstr sections.
1045 link_stabs_sections();
1047 // Create .gnu_incremental_inputs and .gnu_incremental_strtab sections needed
1048 // for the next run of incremental linking to check what has changed.
1050 create_incremental_info_sections(Symbol_table*);
1052 // Find the first read-only PT_LOAD segment, creating one if
1055 find_first_load_seg(const Target*);
1057 // Count the local symbols in the regular symbol table and the dynamic
1058 // symbol table, and build the respective string pools.
1060 count_local_symbols(const Task*, const Input_objects*);
1062 // Create the output sections for the symbol table.
1064 create_symtab_sections(const Input_objects*, Symbol_table*,
1065 unsigned int, off_t*);
1067 // Create the .shstrtab section.
1071 // Create the section header table.
1073 create_shdrs(const Output_section* shstrtab_section, off_t*);
1075 // Create the dynamic symbol table.
1077 create_dynamic_symtab(const Input_objects*, Symbol_table*,
1078 Output_section** pdynstr,
1079 unsigned int* plocal_dynamic_count,
1080 std::vector<Symbol*>* pdynamic_symbols,
1081 Versions* versions);
1083 // Assign offsets to each local portion of the dynamic symbol table.
1085 assign_local_dynsym_offsets(const Input_objects*);
1087 // Finish the .dynamic section and PT_DYNAMIC segment.
1089 finish_dynamic_section(const Input_objects*, const Symbol_table*);
1091 // Set the size of the _DYNAMIC symbol.
1093 set_dynamic_symbol_size(const Symbol_table*);
1095 // Create the .interp section and PT_INTERP segment.
1097 create_interp(const Target* target);
1099 // Create the version sections.
1101 create_version_sections(const Versions*,
1102 const Symbol_table*,
1103 unsigned int local_symcount,
1104 const std::vector<Symbol*>& dynamic_symbols,
1105 const Output_section* dynstr);
1107 template<int size, bool big_endian>
1109 sized_create_version_sections(const Versions* versions,
1110 const Symbol_table*,
1111 unsigned int local_symcount,
1112 const std::vector<Symbol*>& dynamic_symbols,
1113 const Output_section* dynstr);
1115 // Return whether to include this section in the link.
1116 template<int size, bool big_endian>
1118 include_section(Sized_relobj_file<size, big_endian>* object, const char* name,
1119 const elfcpp::Shdr<size, big_endian>&);
1121 // Return the output section name to use given an input section
1122 // name. Set *PLEN to the length of the name. *PLEN must be
1123 // initialized to the length of NAME.
1125 output_section_name(const Relobj*, const char* name, size_t* plen);
1127 // Return the number of allocated output sections.
1129 allocated_output_section_count() const;
1131 // Return the output section for NAME, TYPE and FLAGS.
1133 get_output_section(const char* name, Stringpool::Key name_key,
1134 elfcpp::Elf_Word type, elfcpp::Elf_Xword flags,
1135 Output_section_order order, bool is_relro);
1137 // Clear the input section flags that should not be copied to the
1140 get_output_section_flags (elfcpp::Elf_Xword input_section_flags);
1142 // Choose the output section for NAME in RELOBJ.
1144 choose_output_section(const Relobj* relobj, const char* name,
1145 elfcpp::Elf_Word type, elfcpp::Elf_Xword flags,
1146 bool is_input_section, Output_section_order order,
1149 // Create a new Output_section.
1151 make_output_section(const char* name, elfcpp::Elf_Word type,
1152 elfcpp::Elf_Xword flags, Output_section_order order,
1155 // Attach a section to a segment.
1157 attach_section_to_segment(const Target*, Output_section*);
1159 // Get section order.
1160 Output_section_order
1161 default_section_order(Output_section*, bool is_relro_local);
1163 // Attach an allocated section to a segment.
1165 attach_allocated_section_to_segment(const Target*, Output_section*);
1167 // Make the .eh_frame section.
1169 make_eh_frame_section(const Relobj*);
1171 // Set the final file offsets of all the segments.
1173 set_segment_offsets(const Target*, Output_segment*, unsigned int* pshndx);
1175 // Set the file offsets of the sections when doing a relocatable
1178 set_relocatable_section_offsets(Output_data*, unsigned int* pshndx);
1180 // Set the final file offsets of all the sections not associated
1181 // with a segment. We set section offsets in three passes: the
1182 // first handles all allocated sections, the second sections that
1183 // require postprocessing, and the last the late-bound STRTAB
1184 // sections (probably only shstrtab, which is the one we care about
1185 // because it holds section names).
1186 enum Section_offset_pass
1188 BEFORE_INPUT_SECTIONS_PASS,
1189 POSTPROCESSING_SECTIONS_PASS,
1190 STRTAB_AFTER_POSTPROCESSING_SECTIONS_PASS
1193 set_section_offsets(off_t, Section_offset_pass pass);
1195 // Set the final section indexes of all the sections not associated
1196 // with a segment. Returns the next unused index.
1198 set_section_indexes(unsigned int pshndx);
1200 // Set the section addresses when using a script.
1202 set_section_addresses_from_script(Symbol_table*);
1204 // Find appropriate places or orphan sections in a script.
1206 place_orphan_sections_in_script();
1208 // Return whether SEG1 comes before SEG2 in the output file.
1210 segment_precedes(const Output_segment* seg1, const Output_segment* seg2);
1212 // Use to save and restore segments during relaxation.
1213 typedef Unordered_map<const Output_segment*, const Output_segment*>
1216 // Save states of current output segments.
1218 save_segments(Segment_states*);
1220 // Restore output segment states.
1222 restore_segments(const Segment_states*);
1224 // Clean up after relaxation so that it is possible to lay out the
1225 // sections and segments again.
1227 clean_up_after_relaxation();
1229 // Doing preparation work for relaxation. This is factored out to make
1230 // Layout::finalized a bit smaller and easier to read.
1232 prepare_for_relaxation();
1234 // Main body of the relaxation loop, which lays out the section.
1236 relaxation_loop_body(int, Target*, Symbol_table*, Output_segment**,
1237 Output_segment*, Output_segment_headers*,
1238 Output_file_header*, unsigned int*);
1240 // A mapping used for kept comdats/.gnu.linkonce group signatures.
1241 typedef Unordered_map<std::string, Kept_section> Signatures;
1243 // Mapping from input section name/type/flags to output section. We
1244 // use canonicalized strings here.
1246 typedef std::pair<Stringpool::Key,
1247 std::pair<elfcpp::Elf_Word, elfcpp::Elf_Xword> > Key;
1252 operator()(const Key& k) const;
1255 typedef Unordered_map<Key, Output_section*, Hash_key> Section_name_map;
1257 // A comparison class for segments.
1259 class Compare_segments
1262 Compare_segments(Layout* layout)
1267 operator()(const Output_segment* seg1, const Output_segment* seg2)
1268 { return this->layout_->segment_precedes(seg1, seg2); }
1274 typedef std::vector<Output_section_data*> Output_section_data_list;
1276 // Debug checker class.
1277 class Relaxation_debug_check
1280 Relaxation_debug_check()
1284 // Check that sections and special data are in reset states.
1286 check_output_data_for_reset_values(const Layout::Section_list&,
1287 const Layout::Data_list& special_outputs,
1288 const Layout::Data_list& relax_outputs);
1290 // Record information of a section list.
1292 read_sections(const Layout::Section_list&);
1294 // Verify a section list with recorded information.
1296 verify_sections(const Layout::Section_list&);
1299 // Information we care about a section.
1302 // Output section described by this.
1303 Output_section* output_section;
1312 // Section information.
1313 std::vector<Section_info> section_infos_;
1316 // The number of input files, for sizing tables.
1317 int number_of_input_files_;
1318 // Information set by scripts or by command line options.
1319 Script_options* script_options_;
1320 // The output section names.
1321 Stringpool namepool_;
1322 // The output symbol names.
1323 Stringpool sympool_;
1324 // The dynamic strings, if needed.
1325 Stringpool dynpool_;
1326 // The list of group sections and linkonce sections which we have seen.
1327 Signatures signatures_;
1328 // The mapping from input section name/type/flags to output sections.
1329 Section_name_map section_name_map_;
1330 // The list of output segments.
1331 Segment_list segment_list_;
1332 // The list of output sections.
1333 Section_list section_list_;
1334 // The list of output sections which are not attached to any output
1336 Section_list unattached_section_list_;
1337 // The list of unattached Output_data objects which require special
1338 // handling because they are not Output_sections.
1339 Data_list special_output_list_;
1340 // Like special_output_list_, but cleared and recreated on each
1341 // iteration of relaxation.
1342 Data_list relax_output_list_;
1343 // The section headers.
1344 Output_section_headers* section_headers_;
1345 // A pointer to the PT_TLS segment if there is one.
1346 Output_segment* tls_segment_;
1347 // A pointer to the PT_GNU_RELRO segment if there is one.
1348 Output_segment* relro_segment_;
1349 // A pointer to the PT_INTERP segment if there is one.
1350 Output_segment* interp_segment_;
1351 // A backend may increase the size of the PT_GNU_RELRO segment if
1352 // there is one. This is the amount to increase it by.
1353 unsigned int increase_relro_;
1354 // The SHT_SYMTAB output section.
1355 Output_section* symtab_section_;
1356 // The SHT_SYMTAB_SHNDX for the regular symbol table if there is one.
1357 Output_symtab_xindex* symtab_xindex_;
1358 // The SHT_DYNSYM output section if there is one.
1359 Output_section* dynsym_section_;
1360 // The SHT_SYMTAB_SHNDX for the dynamic symbol table if there is one.
1361 Output_symtab_xindex* dynsym_xindex_;
1362 // The SHT_DYNAMIC output section if there is one.
1363 Output_section* dynamic_section_;
1364 // The _DYNAMIC symbol if there is one.
1365 Symbol* dynamic_symbol_;
1366 // The dynamic data which goes into dynamic_section_.
1367 Output_data_dynamic* dynamic_data_;
1368 // The exception frame output section if there is one.
1369 Output_section* eh_frame_section_;
1370 // The exception frame data for eh_frame_section_.
1371 Eh_frame* eh_frame_data_;
1372 // Whether we have added eh_frame_data_ to the .eh_frame section.
1373 bool added_eh_frame_data_;
1374 // The exception frame header output section if there is one.
1375 Output_section* eh_frame_hdr_section_;
1376 // The data for the .gdb_index section.
1377 Gdb_index* gdb_index_data_;
1378 // The space for the build ID checksum if there is one.
1379 Output_section_data* build_id_note_;
1380 // The output section containing dwarf abbreviations
1381 Output_reduced_debug_abbrev_section* debug_abbrev_;
1382 // The output section containing the dwarf debug info tree
1383 Output_reduced_debug_info_section* debug_info_;
1384 // A list of group sections and their signatures.
1385 Group_signatures group_signatures_;
1386 // The size of the output file.
1387 off_t output_file_size_;
1388 // Whether we have added an input section to an output section.
1389 bool have_added_input_section_;
1390 // Whether we have attached the sections to the segments.
1391 bool sections_are_attached_;
1392 // Whether we have seen an object file marked to require an
1393 // executable stack.
1394 bool input_requires_executable_stack_;
1395 // Whether we have seen at least one object file with an executable
1397 bool input_with_gnu_stack_note_;
1398 // Whether we have seen at least one object file without an
1399 // executable stack marker.
1400 bool input_without_gnu_stack_note_;
1401 // Whether we have seen an object file that uses the static TLS model.
1402 bool has_static_tls_;
1403 // Whether any sections require postprocessing.
1404 bool any_postprocessing_sections_;
1405 // Whether we have resized the signatures_ hash table.
1406 bool resized_signatures_;
1407 // Whether we have created a .stab*str output section.
1408 bool have_stabstr_section_;
1409 // True if the input sections in the output sections should be sorted
1410 // as specified in a section ordering file.
1411 bool section_ordering_specified_;
1412 // True if some input sections need to be mapped to a unique segment,
1413 // after being mapped to a unique Output_section.
1414 bool unique_segment_for_sections_specified_;
1415 // In incremental build, holds information check the inputs and build the
1416 // .gnu_incremental_inputs section.
1417 Incremental_inputs* incremental_inputs_;
1418 // Whether we record output section data created in script
1419 bool record_output_section_data_from_script_;
1420 // List of output data that needs to be removed at relaxation clean up.
1421 Output_section_data_list script_output_section_data_list_;
1422 // Structure to save segment states before entering the relaxation loop.
1423 Segment_states* segment_states_;
1424 // A relaxation debug checker. We only create one when in debugging mode.
1425 Relaxation_debug_check* relaxation_debug_check_;
1426 // Plugins specify section_ordering using this map. This is set in
1427 // update_section_order in plugin.cc
1428 std::map<Section_id, unsigned int> section_order_map_;
1429 // This maps an input section to a unique segment. This is done by first
1430 // placing such input sections in unique output sections and then mapping
1431 // the output section to a unique segment. Unique_segment_info stores
1432 // any additional flags and alignment of the new segment.
1433 Section_segment_map section_segment_map_;
1434 // Hash a pattern to its position in the section ordering file.
1435 Unordered_map<std::string, unsigned int> input_section_position_;
1436 // Vector of glob only patterns in the section_ordering file.
1437 std::vector<std::string> input_section_glob_;
1438 // For incremental links, the base file to be modified.
1439 Incremental_binary* incremental_base_;
1440 // For incremental links, a list of free space within the file.
1441 Free_list free_list_;
1444 // This task handles writing out data in output sections which is not
1445 // part of an input section, or which requires special handling. When
1446 // this is done, it unblocks both output_sections_blocker and
1449 class Write_sections_task : public Task
1452 Write_sections_task(const Layout* layout, Output_file* of,
1453 Task_token* output_sections_blocker,
1454 Task_token* input_sections_blocker,
1455 Task_token* final_blocker)
1456 : layout_(layout), of_(of),
1457 output_sections_blocker_(output_sections_blocker),
1458 input_sections_blocker_(input_sections_blocker),
1459 final_blocker_(final_blocker)
1462 // The standard Task methods.
1468 locks(Task_locker*);
1475 { return "Write_sections_task"; }
1478 class Write_sections_locker;
1480 const Layout* layout_;
1482 Task_token* output_sections_blocker_;
1483 Task_token* input_sections_blocker_;
1484 Task_token* final_blocker_;
1487 // This task handles writing out data which is not part of a section
1490 class Write_data_task : public Task
1493 Write_data_task(const Layout* layout, const Symbol_table* symtab,
1494 Output_file* of, Task_token* final_blocker)
1495 : layout_(layout), symtab_(symtab), of_(of), final_blocker_(final_blocker)
1498 // The standard Task methods.
1504 locks(Task_locker*);
1511 { return "Write_data_task"; }
1514 const Layout* layout_;
1515 const Symbol_table* symtab_;
1517 Task_token* final_blocker_;
1520 // This task handles writing out the global symbols.
1522 class Write_symbols_task : public Task
1525 Write_symbols_task(const Layout* layout, const Symbol_table* symtab,
1526 const Input_objects* /*input_objects*/,
1527 const Stringpool* sympool, const Stringpool* dynpool,
1528 Output_file* of, Task_token* final_blocker)
1529 : layout_(layout), symtab_(symtab),
1530 sympool_(sympool), dynpool_(dynpool), of_(of),
1531 final_blocker_(final_blocker)
1534 // The standard Task methods.
1540 locks(Task_locker*);
1547 { return "Write_symbols_task"; }
1550 const Layout* layout_;
1551 const Symbol_table* symtab_;
1552 const Stringpool* sympool_;
1553 const Stringpool* dynpool_;
1555 Task_token* final_blocker_;
1558 // This task handles writing out data in output sections which can't
1559 // be written out until all the input sections have been handled.
1560 // This is for sections whose contents is based on the contents of
1561 // other output sections.
1563 class Write_after_input_sections_task : public Task
1566 Write_after_input_sections_task(Layout* layout, Output_file* of,
1567 Task_token* input_sections_blocker,
1568 Task_token* final_blocker)
1569 : layout_(layout), of_(of),
1570 input_sections_blocker_(input_sections_blocker),
1571 final_blocker_(final_blocker)
1574 // The standard Task methods.
1580 locks(Task_locker*);
1587 { return "Write_after_input_sections_task"; }
1592 Task_token* input_sections_blocker_;
1593 Task_token* final_blocker_;
1596 // This task function handles computation of the build id.
1597 // When using --build-id=tree, it schedules the tasks that
1598 // compute the hashes for each chunk of the file. This task
1599 // cannot run until we have finalized the size of the output
1600 // file, after the completion of Write_after_input_sections_task.
1602 class Build_id_task_runner : public Task_function_runner
1605 Build_id_task_runner(const General_options* options, const Layout* layout,
1607 : options_(options), layout_(layout), of_(of)
1610 // Run the operation.
1612 run(Workqueue*, const Task*);
1615 const General_options* options_;
1616 const Layout* layout_;
1620 // This task function handles closing the file.
1622 class Close_task_runner : public Task_function_runner
1625 Close_task_runner(const General_options* options, const Layout* layout,
1626 Output_file* of, unsigned char* array_of_hashes,
1627 size_t size_of_hashes)
1628 : options_(options), layout_(layout), of_(of),
1629 array_of_hashes_(array_of_hashes), size_of_hashes_(size_of_hashes)
1632 // Run the operation.
1634 run(Workqueue*, const Task*);
1637 const General_options* options_;
1638 const Layout* layout_;
1640 unsigned char* const array_of_hashes_;
1641 const size_t size_of_hashes_;
1644 // A small helper function to align an address.
1647 align_address(uint64_t address, uint64_t addralign)
1650 address = (address + addralign - 1) &~ (addralign - 1);
1654 } // End namespace gold.
1656 #endif // !defined(GOLD_LAYOUT_H)