1 // layout.h -- lay out output file sections for gold -*- C++ -*-
3 // Copyright (C) 2006-2018 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 hot text sections, prefixed by .text.hot.
428 // The regular text sections.
431 // The startup text sections, prefixed by .text.startup.
434 // The startup text sections, prefixed by .text.startup.
437 // The unlikely text sections, prefixed by .text.unlikely.
440 // The .fini section.
443 // The read-only sections.
446 // The exception frame sections.
449 // The TLS sections come first in the data section.
453 // Local RELRO (read-only after relocation) sections come before
454 // non-local RELRO sections. This data will be fully resolved by
458 // Non-local RELRO sections are grouped together after local RELRO
459 // sections. All RELRO sections must be adjacent so that they can
460 // all be put into a PT_GNU_RELRO segment.
463 // We permit marking exactly one output section as the last RELRO
464 // section. We do this so that the read-only GOT can be adjacent to
468 // Similarly, we permit marking exactly one output section as the
469 // first non-RELRO section.
470 ORDER_NON_RELRO_FIRST
,
472 // The regular data sections come after the RELRO sections.
475 // Large data sections normally go in large data segments.
478 // Group writable notes so that we can have a single PT_NOTE
482 // The small data sections must be at the end of the data sections,
483 // so that they can be adjacent to the small BSS sections.
486 // The BSS sections start here.
488 // The small BSS sections must be at the start of the BSS sections,
489 // so that they can be adjacent to the small data sections.
492 // The regular BSS sections.
495 // The large BSS sections come after the other BSS sections.
502 // This class handles the details of laying out input sections.
507 Layout(int number_of_input_files
, Script_options
*);
511 delete this->relaxation_debug_check_
;
512 delete this->segment_states_
;
515 // For incremental links, record the base file to be modified.
517 set_incremental_base(Incremental_binary
* base
);
521 { return this->incremental_base_
; }
523 // For incremental links, record the initial fixed layout of a section
524 // from the base file, and return a pointer to the Output_section.
525 template<int size
, bool big_endian
>
527 init_fixed_output_section(const char*, elfcpp::Shdr
<size
, big_endian
>&);
529 // Given an input section SHNDX, named NAME, with data in SHDR, from
530 // the object file OBJECT, return the output section where this
531 // input section should go. RELOC_SHNDX is the index of a
532 // relocation section which applies to this section, or 0 if none,
533 // or -1U if more than one. RELOC_TYPE is the type of the
534 // relocation section if there is one. Set *OFFSET to the offset
535 // within the output section.
536 template<int size
, bool big_endian
>
538 layout(Sized_relobj_file
<size
, big_endian
> *object
, unsigned int shndx
,
539 const char* name
, const elfcpp::Shdr
<size
, big_endian
>& shdr
,
540 unsigned int reloc_shndx
, unsigned int reloc_type
, off_t
* offset
);
542 std::map
<Section_id
, unsigned int>*
543 get_section_order_map()
544 { return &this->section_order_map_
; }
546 // Struct to store segment info when mapping some input sections to
547 // unique segments using linker plugins. Mapping an input section to
548 // a unique segment is done by first placing such input sections in
549 // unique output sections and then mapping the output section to a
550 // unique segment. NAME is the name of the output section. FLAGS
551 // and ALIGN are the extra flags and alignment of the segment.
552 struct Unique_segment_info
554 // Identifier for the segment. ELF segments don't have names. This
555 // is used as the name of the output section mapped to the segment.
557 // Additional segment flags.
559 // Segment alignment.
563 // Mapping from input section to segment.
564 typedef std::map
<Const_section_id
, Unique_segment_info
*>
567 // Maps section SECN to SEGMENT s.
569 insert_section_segment_map(Const_section_id secn
, Unique_segment_info
*s
);
571 // Some input sections require special ordering, for compatibility
572 // with GNU ld. Given the name of an input section, return -1 if it
573 // does not require special ordering. Otherwise, return the index
574 // by which it should be ordered compared to other input sections
575 // that require special ordering.
577 special_ordering_of_input_section(const char* name
);
580 is_section_ordering_specified()
581 { return this->section_ordering_specified_
; }
584 set_section_ordering_specified()
585 { this->section_ordering_specified_
= true; }
588 is_unique_segment_for_sections_specified() const
589 { return this->unique_segment_for_sections_specified_
; }
592 set_unique_segment_for_sections_specified()
593 { this->unique_segment_for_sections_specified_
= true; }
595 // For incremental updates, allocate a block of memory from the
596 // free list. Find a block starting at or after MINOFF.
598 allocate(off_t len
, uint64_t align
, off_t minoff
)
599 { return this->free_list_
.allocate(len
, align
, minoff
); }
602 find_section_order_index(const std::string
&);
604 // Read the sequence of input sections from the file specified with
605 // linker option --section-ordering-file.
607 read_layout_from_file();
609 // Layout an input reloc section when doing a relocatable link. The
610 // section is RELOC_SHNDX in OBJECT, with data in SHDR.
611 // DATA_SECTION is the reloc section to which it refers. RR is the
612 // relocatable information.
613 template<int size
, bool big_endian
>
615 layout_reloc(Sized_relobj_file
<size
, big_endian
>* object
,
616 unsigned int reloc_shndx
,
617 const elfcpp::Shdr
<size
, big_endian
>& shdr
,
618 Output_section
* data_section
,
619 Relocatable_relocs
* rr
);
621 // Layout a group section when doing a relocatable link.
622 template<int size
, bool big_endian
>
624 layout_group(Symbol_table
* symtab
,
625 Sized_relobj_file
<size
, big_endian
>* object
,
626 unsigned int group_shndx
,
627 const char* group_section_name
,
628 const char* signature
,
629 const elfcpp::Shdr
<size
, big_endian
>& shdr
,
630 elfcpp::Elf_Word flags
,
631 std::vector
<unsigned int>* shndxes
);
633 // Like layout, only for exception frame sections. OBJECT is an
634 // object file. SYMBOLS is the contents of the symbol table
635 // section, with size SYMBOLS_SIZE. SYMBOL_NAMES is the contents of
636 // the symbol name section, with size SYMBOL_NAMES_SIZE. SHNDX is a
637 // .eh_frame section in OBJECT. SHDR is the section header.
638 // RELOC_SHNDX is the index of a relocation section which applies to
639 // this section, or 0 if none, or -1U if more than one. RELOC_TYPE
640 // is the type of the relocation section if there is one. This
641 // returns the output section, and sets *OFFSET to the offset.
642 template<int size
, bool big_endian
>
644 layout_eh_frame(Sized_relobj_file
<size
, big_endian
>* object
,
645 const unsigned char* symbols
,
647 const unsigned char* symbol_names
,
648 off_t symbol_names_size
,
650 const elfcpp::Shdr
<size
, big_endian
>& shdr
,
651 unsigned int reloc_shndx
, unsigned int reloc_type
,
654 // After processing all input files, we call this to make sure that
655 // the optimized .eh_frame sections have been added to the output
658 finalize_eh_frame_section();
660 // Add .eh_frame information for a PLT. The FDE must start with a
661 // 4-byte PC-relative reference to the start of the PLT, followed by
662 // a 4-byte size of PLT.
664 add_eh_frame_for_plt(Output_data
* plt
, const unsigned char* cie_data
,
665 size_t cie_length
, const unsigned char* fde_data
,
668 // Remove .eh_frame information for a PLT. FDEs using the CIE must
669 // be removed in reverse order to the order they were added.
671 remove_eh_frame_for_plt(Output_data
* plt
, const unsigned char* cie_data
,
672 size_t cie_length
, const unsigned char* fde_data
,
675 // Scan a .debug_info or .debug_types section, and add summary
676 // information to the .gdb_index section.
677 template<int size
, bool big_endian
>
679 add_to_gdb_index(bool is_type_unit
,
680 Sized_relobj
<size
, big_endian
>* object
,
681 const unsigned char* symbols
,
684 unsigned int reloc_shndx
,
685 unsigned int reloc_type
);
687 // Handle a GNU stack note. This is called once per input object
688 // file. SEEN_GNU_STACK is true if the object file has a
689 // .note.GNU-stack section. GNU_STACK_FLAGS is the section flags
690 // from that section if there was one.
692 layout_gnu_stack(bool seen_gnu_stack
, uint64_t gnu_stack_flags
,
695 // Add an Output_section_data to the layout. This is used for
696 // special sections like the GOT section. ORDER is where the
697 // section should wind up in the output segment. IS_RELRO is true
698 // for relro sections.
700 add_output_section_data(const char* name
, elfcpp::Elf_Word type
,
701 elfcpp::Elf_Xword flags
,
702 Output_section_data
*, Output_section_order order
,
705 // Increase the size of the relro segment by this much.
707 increase_relro(unsigned int s
)
708 { this->increase_relro_
+= s
; }
710 // Create dynamic sections if necessary.
712 create_initial_dynamic_sections(Symbol_table
*);
714 // Define __start and __stop symbols for output sections.
716 define_section_symbols(Symbol_table
*);
718 // Create automatic note sections.
722 // Create sections for linker scripts.
724 create_script_sections()
725 { this->script_options_
->create_script_sections(this); }
727 // Define symbols from any linker script.
729 define_script_symbols(Symbol_table
* symtab
)
730 { this->script_options_
->add_symbols_to_table(symtab
); }
732 // Define symbols for group signatures.
734 define_group_signatures(Symbol_table
*);
736 // Return the Stringpool used for symbol names.
739 { return &this->sympool_
; }
741 // Return the Stringpool used for dynamic symbol names and dynamic
745 { return &this->dynpool_
; }
747 // Return the .dynamic output section. This is only valid after the
748 // layout has been finalized.
750 dynamic_section() const
751 { return this->dynamic_section_
; }
753 // Return the symtab_xindex section used to hold large section
754 // indexes for the normal symbol table.
755 Output_symtab_xindex
*
756 symtab_xindex() const
757 { return this->symtab_xindex_
; }
759 // Return the dynsym_xindex section used to hold large section
760 // indexes for the dynamic symbol table.
761 Output_symtab_xindex
*
762 dynsym_xindex() const
763 { return this->dynsym_xindex_
; }
765 // Return whether a section is a .gnu.linkonce section, given the
768 is_linkonce(const char* name
)
769 { return strncmp(name
, ".gnu.linkonce", sizeof(".gnu.linkonce") - 1) == 0; }
771 // Whether we have added an input section.
773 have_added_input_section() const
774 { return this->have_added_input_section_
; }
776 // Return true if a section is a debugging section.
778 is_debug_info_section(const char* name
)
780 // Debugging sections can only be recognized by name.
781 return (strncmp(name
, ".debug", sizeof(".debug") - 1) == 0
782 || strncmp(name
, ".zdebug", sizeof(".zdebug") - 1) == 0
783 || strncmp(name
, ".gnu.linkonce.wi.",
784 sizeof(".gnu.linkonce.wi.") - 1) == 0
785 || strncmp(name
, ".line", sizeof(".line") - 1) == 0
786 || strncmp(name
, ".stab", sizeof(".stab") - 1) == 0
787 || strncmp(name
, ".pdr", sizeof(".pdr") - 1) == 0);
790 // Return true if RELOBJ is an input file whose base name matches
791 // FILE_NAME. The base name must have an extension of ".o", and
792 // must be exactly FILE_NAME.o or FILE_NAME, one character, ".o".
794 match_file_name(const Relobj
* relobj
, const char* file_name
);
796 // Return whether section SHNDX in RELOBJ is a .ctors/.dtors section
797 // with more than one word being mapped to a .init_array/.fini_array
800 is_ctors_in_init_array(Relobj
* relobj
, unsigned int shndx
) const;
802 // Check if a comdat group or .gnu.linkonce section with the given
803 // NAME is selected for the link. If there is already a section,
804 // *KEPT_SECTION is set to point to the signature and the function
805 // returns false. Otherwise, OBJECT, SHNDX,IS_COMDAT, and
806 // IS_GROUP_NAME are recorded for this NAME in the layout object,
807 // *KEPT_SECTION is set to the internal copy and the function return
810 find_or_add_kept_section(const std::string
& name
, Relobj
* object
,
811 unsigned int shndx
, bool is_comdat
,
812 bool is_group_name
, Kept_section
** kept_section
);
814 // Finalize the layout after all the input sections have been added.
816 finalize(const Input_objects
*, Symbol_table
*, Target
*, const Task
*);
818 // Return whether any sections require postprocessing.
820 any_postprocessing_sections() const
821 { return this->any_postprocessing_sections_
; }
823 // Return the size of the output file.
825 output_file_size() const
826 { return this->output_file_size_
; }
828 // Return the TLS segment. This will return NULL if there isn't
832 { return this->tls_segment_
; }
834 // Return the normal symbol table.
836 symtab_section() const
838 gold_assert(this->symtab_section_
!= NULL
);
839 return this->symtab_section_
;
842 // Return the file offset of the normal symbol table.
844 symtab_section_offset() const;
846 // Return the section index of the normal symbol tabl.e
848 symtab_section_shndx() const;
850 // Return the dynamic symbol table.
852 dynsym_section() const
854 gold_assert(this->dynsym_section_
!= NULL
);
855 return this->dynsym_section_
;
858 // Return the dynamic tags.
861 { return this->dynamic_data_
; }
863 // Write out the output sections.
865 write_output_sections(Output_file
* of
) const;
867 // Write out data not associated with an input file or the symbol
870 write_data(const Symbol_table
*, Output_file
*) const;
872 // Write out output sections which can not be written until all the
873 // input sections are complete.
875 write_sections_after_input_sections(Output_file
* of
);
877 // Return an output section named NAME, or NULL if there is none.
879 find_output_section(const char* name
) const;
881 // Return an output segment of type TYPE, with segment flags SET set
882 // and segment flags CLEAR clear. Return NULL if there is none.
884 find_output_segment(elfcpp::PT type
, elfcpp::Elf_Word set
,
885 elfcpp::Elf_Word clear
) const;
887 // Return the number of segments we expect to produce.
889 expected_segment_count() const;
891 // Set a flag to indicate that an object file uses the static TLS model.
894 { this->has_static_tls_
= true; }
896 // Return true if any object file uses the static TLS model.
898 has_static_tls() const
899 { return this->has_static_tls_
; }
901 // Return the options which may be set by a linker script.
904 { return this->script_options_
; }
906 const Script_options
*
907 script_options() const
908 { return this->script_options_
; }
910 // Return the object managing inputs in incremental build. NULL in
911 // non-incremental builds.
913 incremental_inputs() const
914 { return this->incremental_inputs_
; }
916 // For the target-specific code to add dynamic tags which are common
919 add_target_dynamic_tags(bool use_rel
, const Output_data
* plt_got
,
920 const Output_data
* plt_rel
,
921 const Output_data_reloc_generic
* dyn_rel
,
922 bool add_debug
, bool dynrel_includes_plt
);
924 // Add a target-specific dynamic tag with constant value.
926 add_target_specific_dynamic_tag(elfcpp::DT tag
, unsigned int val
);
928 // Compute and write out the build ID if needed.
930 write_build_id(Output_file
*, unsigned char*, size_t) const;
932 // Rewrite output file in binary format.
934 write_binary(Output_file
* in
) const;
936 // Print output sections to the map file.
938 print_to_mapfile(Mapfile
*) const;
940 // Dump statistical information to stderr.
944 // A list of segments.
946 typedef std::vector
<Output_segment
*> Segment_list
;
948 // A list of sections.
950 typedef std::vector
<Output_section
*> Section_list
;
952 // The list of information to write out which is not attached to
953 // either a section or a segment.
954 typedef std::vector
<Output_data
*> Data_list
;
956 // Store the allocated sections into the section list. This is used
957 // by the linker script code.
959 get_allocated_sections(Section_list
*) const;
961 // Store the executable sections into the section list.
963 get_executable_sections(Section_list
*) const;
965 // Make a section for a linker script to hold data.
967 make_output_section_for_script(const char* name
,
968 Script_sections::Section_type section_type
);
970 // Make a segment. This is used by the linker script code.
972 make_output_segment(elfcpp::Elf_Word type
, elfcpp::Elf_Word flags
);
974 // Return the number of segments.
976 segment_count() const
977 { return this->segment_list_
.size(); }
979 // Map from section flags to segment flags.
980 static elfcpp::Elf_Word
981 section_flags_to_segment(elfcpp::Elf_Xword flags
);
983 // Attach sections to segments.
985 attach_sections_to_segments(const Target
*);
987 // For relaxation clean up, we need to know output section data created
988 // from a linker script.
990 new_output_section_data_from_script(Output_section_data
* posd
)
992 if (this->record_output_section_data_from_script_
)
993 this->script_output_section_data_list_
.push_back(posd
);
996 // Return section list.
999 { return this->section_list_
; }
1001 // Returns TRUE iff NAME (an input section from RELOBJ) will
1002 // be mapped to an output section that should be KEPT.
1004 keep_input_section(const Relobj
*, const char*);
1006 // Add a special output object that will be recreated afresh
1007 // if there is another relaxation iteration.
1009 add_relax_output(Output_data
* data
)
1010 { this->relax_output_list_
.push_back(data
); }
1012 // Clear out (and free) everything added by add_relax_output.
1014 reset_relax_output();
1017 Layout(const Layout
&);
1018 Layout
& operator=(const Layout
&);
1020 // Mapping from input section names to output section names.
1021 struct Section_name_mapping
1028 static const Section_name_mapping section_name_mapping
[];
1029 static const int section_name_mapping_count
;
1030 static const Section_name_mapping text_section_name_mapping
[];
1031 static const int text_section_name_mapping_count
;
1033 // Find section name NAME in map and return the mapped name if found
1034 // with the length set in PLEN.
1035 static const char* match_section_name(const Section_name_mapping
* map
,
1036 const int count
, const char* name
,
1039 // During a relocatable link, a list of group sections and
1041 struct Group_signature
1043 // The group section.
1044 Output_section
* section
;
1046 const char* signature
;
1049 : section(NULL
), signature(NULL
)
1052 Group_signature(Output_section
* sectiona
, const char* signaturea
)
1053 : section(sectiona
), signature(signaturea
)
1056 typedef std::vector
<Group_signature
> Group_signatures
;
1058 // Create a note section, filling in the header.
1060 create_note(const char* name
, int note_type
, const char* section_name
,
1061 size_t descsz
, bool allocate
, size_t* trailing_padding
);
1063 // Create a note section for gold version.
1067 // Record whether the stack must be executable, and a user-supplied size.
1069 create_stack_segment();
1071 // Create a build ID note if needed.
1075 // Link .stab and .stabstr sections.
1077 link_stabs_sections();
1079 // Create .gnu_incremental_inputs and .gnu_incremental_strtab sections needed
1080 // for the next run of incremental linking to check what has changed.
1082 create_incremental_info_sections(Symbol_table
*);
1084 // Find the first read-only PT_LOAD segment, creating one if
1087 find_first_load_seg(const Target
*);
1089 // Count the local symbols in the regular symbol table and the dynamic
1090 // symbol table, and build the respective string pools.
1092 count_local_symbols(const Task
*, const Input_objects
*);
1094 // Create the output sections for the symbol table.
1096 create_symtab_sections(const Input_objects
*, Symbol_table
*,
1097 unsigned int, off_t
*, unsigned int);
1099 // Create the .shstrtab section.
1103 // Create the section header table.
1105 create_shdrs(const Output_section
* shstrtab_section
, off_t
*);
1107 // Create the dynamic symbol table.
1109 create_dynamic_symtab(const Input_objects
*, Symbol_table
*,
1110 Output_section
** pdynstr
,
1111 unsigned int* plocal_dynamic_count
,
1112 unsigned int* pforced_local_dynamic_count
,
1113 std::vector
<Symbol
*>* pdynamic_symbols
,
1114 Versions
* versions
);
1116 // Assign offsets to each local portion of the dynamic symbol table.
1118 assign_local_dynsym_offsets(const Input_objects
*);
1120 // Finish the .dynamic section and PT_DYNAMIC segment.
1122 finish_dynamic_section(const Input_objects
*, const Symbol_table
*);
1124 // Set the size of the _DYNAMIC symbol.
1126 set_dynamic_symbol_size(const Symbol_table
*);
1128 // Create the .interp section and PT_INTERP segment.
1130 create_interp(const Target
* target
);
1132 // Create the version sections.
1134 create_version_sections(const Versions
*,
1135 const Symbol_table
*,
1136 unsigned int local_symcount
,
1137 const std::vector
<Symbol
*>& dynamic_symbols
,
1138 const Output_section
* dynstr
);
1140 template<int size
, bool big_endian
>
1142 sized_create_version_sections(const Versions
* versions
,
1143 const Symbol_table
*,
1144 unsigned int local_symcount
,
1145 const std::vector
<Symbol
*>& dynamic_symbols
,
1146 const Output_section
* dynstr
);
1148 // Return whether to include this section in the link.
1149 template<int size
, bool big_endian
>
1151 include_section(Sized_relobj_file
<size
, big_endian
>* object
, const char* name
,
1152 const elfcpp::Shdr
<size
, big_endian
>&);
1154 // Return the output section name to use given an input section
1155 // name. Set *PLEN to the length of the name. *PLEN must be
1156 // initialized to the length of NAME.
1158 output_section_name(const Relobj
*, const char* name
, size_t* plen
);
1160 // Return the number of allocated output sections.
1162 allocated_output_section_count() const;
1164 // Return the output section for NAME, TYPE and FLAGS.
1166 get_output_section(const char* name
, Stringpool::Key name_key
,
1167 elfcpp::Elf_Word type
, elfcpp::Elf_Xword flags
,
1168 Output_section_order order
, bool is_relro
);
1170 // Clear the input section flags that should not be copied to the
1173 get_output_section_flags (elfcpp::Elf_Xword input_section_flags
);
1175 // Choose the output section for NAME in RELOBJ.
1177 choose_output_section(const Relobj
* relobj
, const char* name
,
1178 elfcpp::Elf_Word type
, elfcpp::Elf_Xword flags
,
1179 bool is_input_section
, Output_section_order order
,
1180 bool is_relro
, bool is_reloc
, bool match_input_spec
);
1182 // Create a new Output_section.
1184 make_output_section(const char* name
, elfcpp::Elf_Word type
,
1185 elfcpp::Elf_Xword flags
, Output_section_order order
,
1188 // Attach a section to a segment.
1190 attach_section_to_segment(const Target
*, Output_section
*);
1192 // Get section order.
1193 Output_section_order
1194 default_section_order(Output_section
*, bool is_relro_local
);
1196 // Attach an allocated section to a segment.
1198 attach_allocated_section_to_segment(const Target
*, Output_section
*);
1200 // Make the .eh_frame section.
1202 make_eh_frame_section(const Relobj
*);
1204 // Set the final file offsets of all the segments.
1206 set_segment_offsets(const Target
*, Output_segment
*, unsigned int* pshndx
);
1208 // Set the file offsets of the sections when doing a relocatable
1211 set_relocatable_section_offsets(Output_data
*, unsigned int* pshndx
);
1213 // Set the final file offsets of all the sections not associated
1214 // with a segment. We set section offsets in three passes: the
1215 // first handles all allocated sections, the second sections that
1216 // require postprocessing, and the last the late-bound STRTAB
1217 // sections (probably only shstrtab, which is the one we care about
1218 // because it holds section names).
1219 enum Section_offset_pass
1221 BEFORE_INPUT_SECTIONS_PASS
,
1222 POSTPROCESSING_SECTIONS_PASS
,
1223 STRTAB_AFTER_POSTPROCESSING_SECTIONS_PASS
1226 set_section_offsets(off_t
, Section_offset_pass pass
);
1228 // Set the final section indexes of all the sections not associated
1229 // with a segment. Returns the next unused index.
1231 set_section_indexes(unsigned int pshndx
);
1233 // Set the section addresses when using a script.
1235 set_section_addresses_from_script(Symbol_table
*);
1237 // Find appropriate places or orphan sections in a script.
1239 place_orphan_sections_in_script();
1241 // Return whether SEG1 comes before SEG2 in the output file.
1243 segment_precedes(const Output_segment
* seg1
, const Output_segment
* seg2
);
1245 // Use to save and restore segments during relaxation.
1246 typedef Unordered_map
<const Output_segment
*, const Output_segment
*>
1249 // Save states of current output segments.
1251 save_segments(Segment_states
*);
1253 // Restore output segment states.
1255 restore_segments(const Segment_states
*);
1257 // Clean up after relaxation so that it is possible to lay out the
1258 // sections and segments again.
1260 clean_up_after_relaxation();
1262 // Doing preparation work for relaxation. This is factored out to make
1263 // Layout::finalized a bit smaller and easier to read.
1265 prepare_for_relaxation();
1267 // Main body of the relaxation loop, which lays out the section.
1269 relaxation_loop_body(int, Target
*, Symbol_table
*, Output_segment
**,
1270 Output_segment
*, Output_segment_headers
*,
1271 Output_file_header
*, unsigned int*);
1273 // A mapping used for kept comdats/.gnu.linkonce group signatures.
1274 typedef Unordered_map
<std::string
, Kept_section
> Signatures
;
1276 // Mapping from input section name/type/flags to output section. We
1277 // use canonicalized strings here.
1279 typedef std::pair
<Stringpool::Key
,
1280 std::pair
<elfcpp::Elf_Word
, elfcpp::Elf_Xword
> > Key
;
1285 operator()(const Key
& k
) const;
1288 typedef Unordered_map
<Key
, Output_section
*, Hash_key
> Section_name_map
;
1290 // A comparison class for segments.
1292 class Compare_segments
1295 Compare_segments(Layout
* layout
)
1300 operator()(const Output_segment
* seg1
, const Output_segment
* seg2
)
1301 { return this->layout_
->segment_precedes(seg1
, seg2
); }
1307 typedef std::vector
<Output_section_data
*> Output_section_data_list
;
1309 // Debug checker class.
1310 class Relaxation_debug_check
1313 Relaxation_debug_check()
1317 // Check that sections and special data are in reset states.
1319 check_output_data_for_reset_values(const Layout::Section_list
&,
1320 const Layout::Data_list
& special_outputs
,
1321 const Layout::Data_list
& relax_outputs
);
1323 // Record information of a section list.
1325 read_sections(const Layout::Section_list
&);
1327 // Verify a section list with recorded information.
1329 verify_sections(const Layout::Section_list
&);
1332 // Information we care about a section.
1335 // Output section described by this.
1336 Output_section
* output_section
;
1345 // Section information.
1346 std::vector
<Section_info
> section_infos_
;
1349 // The number of input files, for sizing tables.
1350 int number_of_input_files_
;
1351 // Information set by scripts or by command line options.
1352 Script_options
* script_options_
;
1353 // The output section names.
1354 Stringpool namepool_
;
1355 // The output symbol names.
1356 Stringpool sympool_
;
1357 // The dynamic strings, if needed.
1358 Stringpool dynpool_
;
1359 // The list of group sections and linkonce sections which we have seen.
1360 Signatures signatures_
;
1361 // The mapping from input section name/type/flags to output sections.
1362 Section_name_map section_name_map_
;
1363 // The list of output segments.
1364 Segment_list segment_list_
;
1365 // The list of output sections.
1366 Section_list section_list_
;
1367 // The list of output sections which are not attached to any output
1369 Section_list unattached_section_list_
;
1370 // The list of unattached Output_data objects which require special
1371 // handling because they are not Output_sections.
1372 Data_list special_output_list_
;
1373 // Like special_output_list_, but cleared and recreated on each
1374 // iteration of relaxation.
1375 Data_list relax_output_list_
;
1376 // The section headers.
1377 Output_section_headers
* section_headers_
;
1378 // A pointer to the PT_TLS segment if there is one.
1379 Output_segment
* tls_segment_
;
1380 // A pointer to the PT_GNU_RELRO segment if there is one.
1381 Output_segment
* relro_segment_
;
1382 // A pointer to the PT_INTERP segment if there is one.
1383 Output_segment
* interp_segment_
;
1384 // A backend may increase the size of the PT_GNU_RELRO segment if
1385 // there is one. This is the amount to increase it by.
1386 unsigned int increase_relro_
;
1387 // The SHT_SYMTAB output section.
1388 Output_section
* symtab_section_
;
1389 // The SHT_SYMTAB_SHNDX for the regular symbol table if there is one.
1390 Output_symtab_xindex
* symtab_xindex_
;
1391 // The SHT_DYNSYM output section if there is one.
1392 Output_section
* dynsym_section_
;
1393 // The SHT_SYMTAB_SHNDX for the dynamic symbol table if there is one.
1394 Output_symtab_xindex
* dynsym_xindex_
;
1395 // The SHT_DYNAMIC output section if there is one.
1396 Output_section
* dynamic_section_
;
1397 // The _DYNAMIC symbol if there is one.
1398 Symbol
* dynamic_symbol_
;
1399 // The dynamic data which goes into dynamic_section_.
1400 Output_data_dynamic
* dynamic_data_
;
1401 // The exception frame output section if there is one.
1402 Output_section
* eh_frame_section_
;
1403 // The exception frame data for eh_frame_section_.
1404 Eh_frame
* eh_frame_data_
;
1405 // Whether we have added eh_frame_data_ to the .eh_frame section.
1406 bool added_eh_frame_data_
;
1407 // The exception frame header output section if there is one.
1408 Output_section
* eh_frame_hdr_section_
;
1409 // The data for the .gdb_index section.
1410 Gdb_index
* gdb_index_data_
;
1411 // The space for the build ID checksum if there is one.
1412 Output_section_data
* build_id_note_
;
1413 // The output section containing dwarf abbreviations
1414 Output_reduced_debug_abbrev_section
* debug_abbrev_
;
1415 // The output section containing the dwarf debug info tree
1416 Output_reduced_debug_info_section
* debug_info_
;
1417 // A list of group sections and their signatures.
1418 Group_signatures group_signatures_
;
1419 // The size of the output file.
1420 off_t output_file_size_
;
1421 // Whether we have added an input section to an output section.
1422 bool have_added_input_section_
;
1423 // Whether we have attached the sections to the segments.
1424 bool sections_are_attached_
;
1425 // Whether we have seen an object file marked to require an
1426 // executable stack.
1427 bool input_requires_executable_stack_
;
1428 // Whether we have seen at least one object file with an executable
1430 bool input_with_gnu_stack_note_
;
1431 // Whether we have seen at least one object file without an
1432 // executable stack marker.
1433 bool input_without_gnu_stack_note_
;
1434 // Whether we have seen an object file that uses the static TLS model.
1435 bool has_static_tls_
;
1436 // Whether any sections require postprocessing.
1437 bool any_postprocessing_sections_
;
1438 // Whether we have resized the signatures_ hash table.
1439 bool resized_signatures_
;
1440 // Whether we have created a .stab*str output section.
1441 bool have_stabstr_section_
;
1442 // True if the input sections in the output sections should be sorted
1443 // as specified in a section ordering file.
1444 bool section_ordering_specified_
;
1445 // True if some input sections need to be mapped to a unique segment,
1446 // after being mapped to a unique Output_section.
1447 bool unique_segment_for_sections_specified_
;
1448 // In incremental build, holds information check the inputs and build the
1449 // .gnu_incremental_inputs section.
1450 Incremental_inputs
* incremental_inputs_
;
1451 // Whether we record output section data created in script
1452 bool record_output_section_data_from_script_
;
1453 // List of output data that needs to be removed at relaxation clean up.
1454 Output_section_data_list script_output_section_data_list_
;
1455 // Structure to save segment states before entering the relaxation loop.
1456 Segment_states
* segment_states_
;
1457 // A relaxation debug checker. We only create one when in debugging mode.
1458 Relaxation_debug_check
* relaxation_debug_check_
;
1459 // Plugins specify section_ordering using this map. This is set in
1460 // update_section_order in plugin.cc
1461 std::map
<Section_id
, unsigned int> section_order_map_
;
1462 // This maps an input section to a unique segment. This is done by first
1463 // placing such input sections in unique output sections and then mapping
1464 // the output section to a unique segment. Unique_segment_info stores
1465 // any additional flags and alignment of the new segment.
1466 Section_segment_map section_segment_map_
;
1467 // Hash a pattern to its position in the section ordering file.
1468 Unordered_map
<std::string
, unsigned int> input_section_position_
;
1469 // Vector of glob only patterns in the section_ordering file.
1470 std::vector
<std::string
> input_section_glob_
;
1471 // For incremental links, the base file to be modified.
1472 Incremental_binary
* incremental_base_
;
1473 // For incremental links, a list of free space within the file.
1474 Free_list free_list_
;
1477 // This task handles writing out data in output sections which is not
1478 // part of an input section, or which requires special handling. When
1479 // this is done, it unblocks both output_sections_blocker and
1482 class Write_sections_task
: public Task
1485 Write_sections_task(const Layout
* layout
, Output_file
* of
,
1486 Task_token
* output_sections_blocker
,
1487 Task_token
* input_sections_blocker
,
1488 Task_token
* final_blocker
)
1489 : layout_(layout
), of_(of
),
1490 output_sections_blocker_(output_sections_blocker
),
1491 input_sections_blocker_(input_sections_blocker
),
1492 final_blocker_(final_blocker
)
1495 // The standard Task methods.
1501 locks(Task_locker
*);
1508 { return "Write_sections_task"; }
1511 class Write_sections_locker
;
1513 const Layout
* layout_
;
1515 Task_token
* output_sections_blocker_
;
1516 Task_token
* input_sections_blocker_
;
1517 Task_token
* final_blocker_
;
1520 // This task handles writing out data which is not part of a section
1523 class Write_data_task
: public Task
1526 Write_data_task(const Layout
* layout
, const Symbol_table
* symtab
,
1527 Output_file
* of
, Task_token
* final_blocker
)
1528 : layout_(layout
), symtab_(symtab
), of_(of
), final_blocker_(final_blocker
)
1531 // The standard Task methods.
1537 locks(Task_locker
*);
1544 { return "Write_data_task"; }
1547 const Layout
* layout_
;
1548 const Symbol_table
* symtab_
;
1550 Task_token
* final_blocker_
;
1553 // This task handles writing out the global symbols.
1555 class Write_symbols_task
: public Task
1558 Write_symbols_task(const Layout
* layout
, const Symbol_table
* symtab
,
1559 const Input_objects
* /*input_objects*/,
1560 const Stringpool
* sympool
, const Stringpool
* dynpool
,
1561 Output_file
* of
, Task_token
* final_blocker
)
1562 : layout_(layout
), symtab_(symtab
),
1563 sympool_(sympool
), dynpool_(dynpool
), of_(of
),
1564 final_blocker_(final_blocker
)
1567 // The standard Task methods.
1573 locks(Task_locker
*);
1580 { return "Write_symbols_task"; }
1583 const Layout
* layout_
;
1584 const Symbol_table
* symtab_
;
1585 const Stringpool
* sympool_
;
1586 const Stringpool
* dynpool_
;
1588 Task_token
* final_blocker_
;
1591 // This task handles writing out data in output sections which can't
1592 // be written out until all the input sections have been handled.
1593 // This is for sections whose contents is based on the contents of
1594 // other output sections.
1596 class Write_after_input_sections_task
: public Task
1599 Write_after_input_sections_task(Layout
* layout
, Output_file
* of
,
1600 Task_token
* input_sections_blocker
,
1601 Task_token
* final_blocker
)
1602 : layout_(layout
), of_(of
),
1603 input_sections_blocker_(input_sections_blocker
),
1604 final_blocker_(final_blocker
)
1607 // The standard Task methods.
1613 locks(Task_locker
*);
1620 { return "Write_after_input_sections_task"; }
1625 Task_token
* input_sections_blocker_
;
1626 Task_token
* final_blocker_
;
1629 // This task function handles computation of the build id.
1630 // When using --build-id=tree, it schedules the tasks that
1631 // compute the hashes for each chunk of the file. This task
1632 // cannot run until we have finalized the size of the output
1633 // file, after the completion of Write_after_input_sections_task.
1635 class Build_id_task_runner
: public Task_function_runner
1638 Build_id_task_runner(const General_options
* options
, const Layout
* layout
,
1640 : options_(options
), layout_(layout
), of_(of
)
1643 // Run the operation.
1645 run(Workqueue
*, const Task
*);
1648 const General_options
* options_
;
1649 const Layout
* layout_
;
1653 // This task function handles closing the file.
1655 class Close_task_runner
: public Task_function_runner
1658 Close_task_runner(const General_options
* options
, const Layout
* layout
,
1659 Output_file
* of
, unsigned char* array_of_hashes
,
1660 size_t size_of_hashes
)
1661 : options_(options
), layout_(layout
), of_(of
),
1662 array_of_hashes_(array_of_hashes
), size_of_hashes_(size_of_hashes
)
1665 // Run the operation.
1667 run(Workqueue
*, const Task
*);
1670 const General_options
* options_
;
1671 const Layout
* layout_
;
1673 unsigned char* const array_of_hashes_
;
1674 const size_t size_of_hashes_
;
1677 // A small helper function to align an address.
1680 align_address(uint64_t address
, uint64_t addralign
)
1683 address
= (address
+ addralign
- 1) &~ (addralign
- 1);
1687 } // End namespace gold.
1689 #endif // !defined(GOLD_LAYOUT_H)