Automatic date update in version.in
[external/binutils.git] / gold / layout.h
1 // layout.h -- lay out output file sections for gold  -*- C++ -*-
2
3 // Copyright (C) 2006-2019 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
5
6 // This file is part of gold.
7
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.
12
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.
17
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.
22
23 #ifndef GOLD_LAYOUT_H
24 #define GOLD_LAYOUT_H
25
26 #include <cstring>
27 #include <list>
28 #include <map>
29 #include <string>
30 #include <utility>
31 #include <vector>
32
33 #include "script.h"
34 #include "workqueue.h"
35 #include "object.h"
36 #include "dynobj.h"
37 #include "stringpool.h"
38
39 namespace gold
40 {
41
42 class General_options;
43 class Incremental_inputs;
44 class Incremental_binary;
45 class Input_objects;
46 class Mapfile;
47 class Symbol_table;
48 class Output_section_data;
49 class Output_section;
50 class Output_section_headers;
51 class Output_segment_headers;
52 class Output_file_header;
53 class Output_segment;
54 class Output_data;
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;
60 class Eh_frame;
61 class Gdb_index;
62 class Target;
63 struct Timespec;
64
65 // Return TRUE if SECNAME is the name of a compressed debug section.
66 extern bool
67 is_compressed_debug_section(const char* secname);
68
69 // Return the name of the corresponding uncompressed debug section.
70 extern std::string
71 corresponding_uncompressed_section_name(std::string secname);
72
73 // Maintain a list of free space within a section, segment, or file.
74 // Used for incremental update links.
75
76 class Free_list
77 {
78  public:
79   struct Free_list_node
80   {
81     Free_list_node(off_t start, off_t end)
82       : start_(start), end_(end)
83     { }
84     off_t start_;
85     off_t end_;
86   };
87   typedef std::list<Free_list_node>::const_iterator Const_iterator;
88
89   Free_list()
90     : list_(), last_remove_(list_.begin()), extend_(false), length_(0),
91       min_hole_(0)
92   { }
93
94   // Initialize the free list for a section of length LEN.
95   // If EXTEND is true, free space may be allocated past the end.
96   void
97   init(off_t len, bool extend);
98
99   // Set the minimum hole size that is allowed when allocating
100   // from the free list.
101   void
102   set_min_hole_size(off_t min_hole)
103   { this->min_hole_ = min_hole; }
104
105   // Remove a chunk from the free list.
106   void
107   remove(off_t start, off_t end);
108
109   // Allocate a chunk of space from the free list of length LEN,
110   // with alignment ALIGN, and minimum offset MINOFF.
111   off_t
112   allocate(off_t len, uint64_t align, off_t minoff);
113
114   // Return an iterator for the beginning of the free list.
115   Const_iterator
116   begin() const
117   { return this->list_.begin(); }
118
119   // Return an iterator for the end of the free list.
120   Const_iterator
121   end() const
122   { return this->list_.end(); }
123
124   // Dump the free list (for debugging).
125   void
126   dump();
127
128   // Print usage statistics.
129   static void
130   print_stats();
131
132  private:
133   typedef std::list<Free_list_node>::iterator Iterator;
134
135   // The free list.
136   std::list<Free_list_node> list_;
137
138   // The last node visited during a remove operation.
139   Iterator last_remove_;
140
141   // Whether we can extend past the original length.
142   bool extend_;
143
144   // The total length of the section, segment, or file.
145   off_t length_;
146
147   // The minimum hole size allowed.  When allocating from the free list,
148   // we must not leave a hole smaller than this.
149   off_t min_hole_;
150
151   // Statistics:
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;
164 };
165
166 // This task function handles mapping the input sections to output
167 // sections and laying them out in memory.
168
169 class Layout_task_runner : public Task_function_runner
170 {
171  public:
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
174   // object.
175   Layout_task_runner(const General_options& options,
176                      const Input_objects* input_objects,
177                      Symbol_table* symtab,
178                      Target* target,
179                      Layout* layout,
180                      Mapfile* mapfile)
181     : options_(options), input_objects_(input_objects), symtab_(symtab),
182       target_(target), layout_(layout), mapfile_(mapfile)
183   { }
184
185   // Run the operation.
186   void
187   run(Workqueue*, const Task*);
188
189  private:
190   Layout_task_runner(const Layout_task_runner&);
191   Layout_task_runner& operator=(const Layout_task_runner&);
192
193   const General_options& options_;
194   const Input_objects* input_objects_;
195   Symbol_table* symtab_;
196   Target* target_;
197   Layout* layout_;
198   Mapfile* mapfile_;
199 };
200
201 // This class holds information about the comdat group or
202 // .gnu.linkonce section that will be kept for a given signature.
203
204 class Kept_section
205 {
206  private:
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
214   {
215     // The section index.
216     unsigned int shndx;
217     // The section size.
218     uint64_t size;
219
220     Comdat_section_info(unsigned int a_shndx, uint64_t a_size)
221       : shndx(a_shndx), size(a_size)
222     { }
223   };
224
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;
229
230  public:
231   Kept_section()
232     : object_(NULL), shndx_(0), is_comdat_(false), is_group_name_(false)
233   { this->u_.linkonce_size = 0; }
234
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_)
241   {
242     gold_assert(!k.is_comdat_);
243     this->u_.linkonce_size = 0;
244   }
245
246   ~Kept_section()
247   {
248     if (this->is_comdat_)
249       delete this->u_.group_sections;
250   }
251
252   // The object where this section lives.
253   Relobj*
254   object() const
255   { return this->object_; }
256
257   // Set the object.
258   void
259   set_object(Relobj* object)
260   {
261     gold_assert(this->object_ == NULL);
262     this->object_ = object;
263   }
264
265   // The section index.
266   unsigned int
267   shndx() const
268   { return this->shndx_; }
269
270   // Set the section index.
271   void
272   set_shndx(unsigned int shndx)
273   {
274     gold_assert(this->shndx_ == 0);
275     this->shndx_ = shndx;
276   }
277
278   // Whether this is a comdat group.
279   bool
280   is_comdat() const
281   { return this->is_comdat_; }
282
283   // Set that this is a comdat group.
284   void
285   set_is_comdat()
286   {
287     gold_assert(!this->is_comdat_);
288     this->is_comdat_ = true;
289     this->u_.group_sections = new Comdat_group();
290   }
291
292   // Whether this is associated with the name of a group or section
293   // rather than the symbol name derived from a linkonce section.
294   bool
295   is_group_name() const
296   { return this->is_group_name_; }
297
298   // Note that this represents a comdat group rather than a single
299   // linkonce section.
300   void
301   set_is_group_name()
302   { this->is_group_name_ = true; }
303
304   // Add a section to the group list.
305   void
306   add_comdat_section(const std::string& name, unsigned int shndx,
307                      uint64_t size)
308   {
309     gold_assert(this->is_comdat_);
310     Comdat_section_info sinfo(shndx, size);
311     this->u_.group_sections->insert(std::make_pair(name, sinfo));
312   }
313
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.
316   bool
317   find_comdat_section(const std::string& name, unsigned int* pshndx,
318                       uint64_t* psize) const
319   {
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())
323       return false;
324     *pshndx = p->second.shndx;
325     *psize = p->second.size;
326     return true;
327   }
328
329   // If there is only one section in the group list, return true, and
330   // return the section index and size.
331   bool
332   find_single_comdat_section(unsigned int* pshndx, uint64_t* psize) const
333   {
334     gold_assert(this->is_comdat_);
335     if (this->u_.group_sections->size() != 1)
336       return false;
337     Comdat_group::const_iterator p = this->u_.group_sections->begin();
338     *pshndx = p->second.shndx;
339     *psize = p->second.size;
340     return true;
341   }
342
343   // Return the size of a linkonce section.
344   uint64_t
345   linkonce_size() const
346   {
347     gold_assert(!this->is_comdat_);
348     return this->u_.linkonce_size;
349   }
350
351   // Set the size of a linkonce section.
352   void
353   set_linkonce_size(uint64_t size)
354   {
355     gold_assert(!this->is_comdat_);
356     this->u_.linkonce_size = size;
357   }
358
359  private:
360   // No assignment.
361   Kept_section& operator=(const Kept_section&);
362
363   // The object containing the comdat group or .gnu.linkonce section.
364   Relobj* object_;
365   // Index of the group section for comdats and the section itself for
366   // .gnu.linkonce.
367   unsigned int shndx_;
368   // True if this is for a comdat group rather than a .gnu.linkonce
369   // section.
370   bool is_comdat_;
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.
376   bool is_group_name_;
377   union
378   {
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
381     // section sizes.
382     Comdat_group* group_sections;
383     // If the is_comdat_ field is false, this holds the size of the
384     // single section.
385     uint64_t linkonce_size;
386   } u_;
387 };
388
389 // The ordering for output sections.  This controls how output
390 // sections are ordered within a PT_LOAD output segment.
391
392 enum Output_section_order
393 {
394   // Unspecified.  Used for non-load segments.  Also used for the file
395   // and segment headers.
396   ORDER_INVALID,
397
398   // The PT_INTERP section should come first, so that the dynamic
399   // linker can pick it up quickly.
400   ORDER_INTERP,
401
402   // Loadable read-only note sections come next so that the PT_NOTE
403   // segment is on the first page of the executable.
404   ORDER_RO_NOTE,
405
406   // Put read-only sections used by the dynamic linker early in the
407   // executable to minimize paging.
408   ORDER_DYNAMIC_LINKER,
409
410   // Put reloc sections used by the dynamic linker after other
411   // sections used by the dynamic linker; otherwise, objcopy and strip
412   // get confused.
413   ORDER_DYNAMIC_RELOCS,
414
415   // Put the PLT reloc section after the other dynamic relocs;
416   // otherwise, prelink gets confused.
417   ORDER_DYNAMIC_PLT_RELOCS,
418
419   // The .init section.
420   ORDER_INIT,
421
422   // The PLT.
423   ORDER_PLT,
424
425   // The hot text sections, prefixed by .text.hot.
426   ORDER_TEXT_HOT,
427
428   // The regular text sections.
429   ORDER_TEXT,
430
431   // The startup text sections, prefixed by .text.startup.
432   ORDER_TEXT_STARTUP,
433
434   // The startup text sections, prefixed by .text.startup.
435   ORDER_TEXT_EXIT,
436
437   // The unlikely text sections, prefixed by .text.unlikely.
438   ORDER_TEXT_UNLIKELY,
439
440   // The .fini section.
441   ORDER_FINI,
442
443   // The read-only sections.
444   ORDER_READONLY,
445
446   // The exception frame sections.
447   ORDER_EHFRAME,
448
449   // The TLS sections come first in the data section.
450   ORDER_TLS_DATA,
451   ORDER_TLS_BSS,
452
453   // Local RELRO (read-only after relocation) sections come before
454   // non-local RELRO sections.  This data will be fully resolved by
455   // the prelinker.
456   ORDER_RELRO_LOCAL,
457
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.
461   ORDER_RELRO,
462
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
465   // the writable GOT.
466   ORDER_RELRO_LAST,
467
468   // Similarly, we permit marking exactly one output section as the
469   // first non-RELRO section.
470   ORDER_NON_RELRO_FIRST,
471
472   // The regular data sections come after the RELRO sections.
473   ORDER_DATA,
474
475   // Large data sections normally go in large data segments.
476   ORDER_LARGE_DATA,
477
478   // Group writable notes so that we can have a single PT_NOTE
479   // segment.
480   ORDER_RW_NOTE,
481
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.
484   ORDER_SMALL_DATA,
485
486   // The BSS sections start here.
487
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.
490   ORDER_SMALL_BSS,
491
492   // The regular BSS sections.
493   ORDER_BSS,
494
495   // The large BSS sections come after the other BSS sections.
496   ORDER_LARGE_BSS,
497
498   // Maximum value.
499   ORDER_MAX
500 };
501
502 // This class handles the details of laying out input sections.
503
504 class Layout
505 {
506  public:
507   Layout(int number_of_input_files, Script_options*);
508
509   ~Layout()
510   {
511     delete this->relaxation_debug_check_;
512     delete this->segment_states_;
513   }
514
515   // For incremental links, record the base file to be modified.
516   void
517   set_incremental_base(Incremental_binary* base);
518
519   Incremental_binary*
520   incremental_base()
521   { return this->incremental_base_; }
522
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>
526   Output_section*
527   init_fixed_output_section(const char*, elfcpp::Shdr<size, big_endian>&);
528
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>
537   Output_section*
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 sh_type, unsigned int reloc_shndx,
541          unsigned int reloc_type, off_t* offset);
542
543   std::map<Section_id, unsigned int>*
544   get_section_order_map()
545   { return &this->section_order_map_; }
546
547   // Struct to store segment info when mapping some input sections to
548   // unique segments using linker plugins.  Mapping an input section to
549   // a unique segment is done by first placing such input sections in
550   // unique output sections and then mapping the output section to a
551   // unique segment.  NAME is the name of the output section.  FLAGS
552   // and ALIGN are the extra flags and alignment of the segment.
553   struct Unique_segment_info
554   {
555     // Identifier for the segment.  ELF segments don't have names.  This
556     // is used as the name of the output section mapped to the segment.
557     const char* name;
558     // Additional segment flags.
559     uint64_t flags;
560     // Segment alignment.
561     uint64_t align;
562   };
563
564   // Mapping from input section to segment.
565   typedef std::map<Const_section_id, Unique_segment_info*>
566   Section_segment_map;
567
568   // Maps section SECN to SEGMENT s.
569   void
570   insert_section_segment_map(Const_section_id secn, Unique_segment_info *s);
571
572   // Some input sections require special ordering, for compatibility
573   // with GNU ld.  Given the name of an input section, return -1 if it
574   // does not require special ordering.  Otherwise, return the index
575   // by which it should be ordered compared to other input sections
576   // that require special ordering.
577   static int
578   special_ordering_of_input_section(const char* name);
579
580   bool
581   is_section_ordering_specified()
582   { return this->section_ordering_specified_; }
583
584   void
585   set_section_ordering_specified()
586   { this->section_ordering_specified_ = true; }
587
588   bool
589   is_unique_segment_for_sections_specified() const
590   { return this->unique_segment_for_sections_specified_; }
591
592   void
593   set_unique_segment_for_sections_specified()
594   { this->unique_segment_for_sections_specified_ = true; }
595
596   // For incremental updates, allocate a block of memory from the
597   // free list.  Find a block starting at or after MINOFF.
598   off_t
599   allocate(off_t len, uint64_t align, off_t minoff)
600   { return this->free_list_.allocate(len, align, minoff); }
601
602   unsigned int
603   find_section_order_index(const std::string&);
604
605   // Read the sequence of input sections from the file specified with
606   // linker option --section-ordering-file.
607   void
608   read_layout_from_file();
609
610   // Layout an input reloc section when doing a relocatable link.  The
611   // section is RELOC_SHNDX in OBJECT, with data in SHDR.
612   // DATA_SECTION is the reloc section to which it refers.  RR is the
613   // relocatable information.
614   template<int size, bool big_endian>
615   Output_section*
616   layout_reloc(Sized_relobj_file<size, big_endian>* object,
617                unsigned int reloc_shndx,
618                const elfcpp::Shdr<size, big_endian>& shdr,
619                Output_section* data_section,
620                Relocatable_relocs* rr);
621
622   // Layout a group section when doing a relocatable link.
623   template<int size, bool big_endian>
624   void
625   layout_group(Symbol_table* symtab,
626                Sized_relobj_file<size, big_endian>* object,
627                unsigned int group_shndx,
628                const char* group_section_name,
629                const char* signature,
630                const elfcpp::Shdr<size, big_endian>& shdr,
631                elfcpp::Elf_Word flags,
632                std::vector<unsigned int>* shndxes);
633
634   // Like layout, only for exception frame sections.  OBJECT is an
635   // object file.  SYMBOLS is the contents of the symbol table
636   // section, with size SYMBOLS_SIZE.  SYMBOL_NAMES is the contents of
637   // the symbol name section, with size SYMBOL_NAMES_SIZE.  SHNDX is a
638   // .eh_frame section in OBJECT.  SHDR is the section header.
639   // RELOC_SHNDX is the index of a relocation section which applies to
640   // this section, or 0 if none, or -1U if more than one.  RELOC_TYPE
641   // is the type of the relocation section if there is one.  This
642   // returns the output section, and sets *OFFSET to the offset.
643   template<int size, bool big_endian>
644   Output_section*
645   layout_eh_frame(Sized_relobj_file<size, big_endian>* object,
646                   const unsigned char* symbols,
647                   off_t symbols_size,
648                   const unsigned char* symbol_names,
649                   off_t symbol_names_size,
650                   unsigned int shndx,
651                   const elfcpp::Shdr<size, big_endian>& shdr,
652                   unsigned int reloc_shndx, unsigned int reloc_type,
653                   off_t* offset);
654
655   // After processing all input files, we call this to make sure that
656   // the optimized .eh_frame sections have been added to the output
657   // section.
658   void
659   finalize_eh_frame_section();
660
661   // Add .eh_frame information for a PLT.  The FDE must start with a
662   // 4-byte PC-relative reference to the start of the PLT, followed by
663   // a 4-byte size of PLT.
664   void
665   add_eh_frame_for_plt(Output_data* plt, const unsigned char* cie_data,
666                        size_t cie_length, const unsigned char* fde_data,
667                        size_t fde_length);
668
669   // Remove all post-map .eh_frame information for a PLT.
670   void
671   remove_eh_frame_for_plt(Output_data* plt, const unsigned char* cie_data,
672                           size_t cie_length);
673
674   // Scan a .debug_info or .debug_types section, and add summary
675   // information to the .gdb_index section.
676   template<int size, bool big_endian>
677   void
678   add_to_gdb_index(bool is_type_unit,
679                    Sized_relobj<size, big_endian>* object,
680                    const unsigned char* symbols,
681                    off_t symbols_size,
682                    unsigned int shndx,
683                    unsigned int reloc_shndx,
684                    unsigned int reloc_type);
685
686   // Handle a GNU stack note.  This is called once per input object
687   // file.  SEEN_GNU_STACK is true if the object file has a
688   // .note.GNU-stack section.  GNU_STACK_FLAGS is the section flags
689   // from that section if there was one.
690   void
691   layout_gnu_stack(bool seen_gnu_stack, uint64_t gnu_stack_flags,
692                    const Object*);
693
694   // Layout a .note.gnu.property section.
695   void
696   layout_gnu_property(unsigned int note_type,
697                       unsigned int pr_type,
698                       size_t pr_datasz,
699                       const unsigned char* pr_data,
700                       const Object* object);
701
702   // Merge per-object properties with program properties.
703   void
704   merge_gnu_properties(const Object* object);
705
706   // Add a target-specific property for the output .note.gnu.property section.
707   void
708   add_gnu_property(unsigned int note_type,
709                    unsigned int pr_type,
710                    size_t pr_datasz,
711                    const unsigned char* pr_data);
712
713   // Add an Output_section_data to the layout.  This is used for
714   // special sections like the GOT section.  ORDER is where the
715   // section should wind up in the output segment.  IS_RELRO is true
716   // for relro sections.
717   Output_section*
718   add_output_section_data(const char* name, elfcpp::Elf_Word type,
719                           elfcpp::Elf_Xword flags,
720                           Output_section_data*, Output_section_order order,
721                           bool is_relro);
722
723   // Increase the size of the relro segment by this much.
724   void
725   increase_relro(unsigned int s)
726   { this->increase_relro_ += s; }
727
728   // Create dynamic sections if necessary.
729   void
730   create_initial_dynamic_sections(Symbol_table*);
731
732   // Define __start and __stop symbols for output sections.
733   void
734   define_section_symbols(Symbol_table*);
735
736   // Create automatic note sections.
737   void
738   create_notes();
739
740   // Create sections for linker scripts.
741   void
742   create_script_sections()
743   { this->script_options_->create_script_sections(this); }
744
745   // Define symbols from any linker script.
746   void
747   define_script_symbols(Symbol_table* symtab)
748   { this->script_options_->add_symbols_to_table(symtab); }
749
750   // Define symbols for group signatures.
751   void
752   define_group_signatures(Symbol_table*);
753
754   // Return the Stringpool used for symbol names.
755   const Stringpool*
756   sympool() const
757   { return &this->sympool_; }
758
759   // Return the Stringpool used for dynamic symbol names and dynamic
760   // tags.
761   const Stringpool*
762   dynpool() const
763   { return &this->dynpool_; }
764
765   // Return the .dynamic output section.  This is only valid after the
766   // layout has been finalized.
767   Output_section*
768   dynamic_section() const
769   { return this->dynamic_section_; }
770
771   // Return the symtab_xindex section used to hold large section
772   // indexes for the normal symbol table.
773   Output_symtab_xindex*
774   symtab_xindex() const
775   { return this->symtab_xindex_; }
776
777   // Return the dynsym_xindex section used to hold large section
778   // indexes for the dynamic symbol table.
779   Output_symtab_xindex*
780   dynsym_xindex() const
781   { return this->dynsym_xindex_; }
782
783   // Return whether a section is a .gnu.linkonce section, given the
784   // section name.
785   static inline bool
786   is_linkonce(const char* name)
787   { return strncmp(name, ".gnu.linkonce", sizeof(".gnu.linkonce") - 1) == 0; }
788
789   // Whether we have added an input section.
790   bool
791   have_added_input_section() const
792   { return this->have_added_input_section_; }
793
794   // Return true if a section is a debugging section.
795   static inline bool
796   is_debug_info_section(const char* name)
797   {
798     // Debugging sections can only be recognized by name.
799     return (strncmp(name, ".debug", sizeof(".debug") - 1) == 0
800             || strncmp(name, ".zdebug", sizeof(".zdebug") - 1) == 0
801             || strncmp(name, ".gnu.linkonce.wi.",
802                        sizeof(".gnu.linkonce.wi.") - 1) == 0
803             || strncmp(name, ".line", sizeof(".line") - 1) == 0
804             || strncmp(name, ".stab", sizeof(".stab") - 1) == 0
805             || strncmp(name, ".pdr", sizeof(".pdr") - 1) == 0);
806   }
807
808   // Return true if RELOBJ is an input file whose base name matches
809   // FILE_NAME.  The base name must have an extension of ".o", and
810   // must be exactly FILE_NAME.o or FILE_NAME, one character, ".o".
811   static bool
812   match_file_name(const Relobj* relobj, const char* file_name);
813
814   // Return whether section SHNDX in RELOBJ is a .ctors/.dtors section
815   // with more than one word being mapped to a .init_array/.fini_array
816   // section.
817   bool
818   is_ctors_in_init_array(Relobj* relobj, unsigned int shndx) const;
819
820   // Check if a comdat group or .gnu.linkonce section with the given
821   // NAME is selected for the link.  If there is already a section,
822   // *KEPT_SECTION is set to point to the signature and the function
823   // returns false.  Otherwise, OBJECT, SHNDX,IS_COMDAT, and
824   // IS_GROUP_NAME are recorded for this NAME in the layout object,
825   // *KEPT_SECTION is set to the internal copy and the function return
826   // false.
827   bool
828   find_or_add_kept_section(const std::string& name, Relobj* object,
829                            unsigned int shndx, bool is_comdat,
830                            bool is_group_name, Kept_section** kept_section);
831
832   // Finalize the layout after all the input sections have been added.
833   off_t
834   finalize(const Input_objects*, Symbol_table*, Target*, const Task*);
835
836   // Return whether any sections require postprocessing.
837   bool
838   any_postprocessing_sections() const
839   { return this->any_postprocessing_sections_; }
840
841   // Return the size of the output file.
842   off_t
843   output_file_size() const
844   { return this->output_file_size_; }
845
846   // Return the TLS segment.  This will return NULL if there isn't
847   // one.
848   Output_segment*
849   tls_segment() const
850   { return this->tls_segment_; }
851
852   // Return the normal symbol table.
853   Output_section*
854   symtab_section() const
855   {
856     gold_assert(this->symtab_section_ != NULL);
857     return this->symtab_section_;
858   }
859
860   // Return the file offset of the normal symbol table.
861   off_t
862   symtab_section_offset() const;
863
864   // Return the section index of the normal symbol tabl.e
865   unsigned int
866   symtab_section_shndx() const;
867
868   // Return the dynamic symbol table.
869   Output_section*
870   dynsym_section() const
871   {
872     gold_assert(this->dynsym_section_ != NULL);
873     return this->dynsym_section_;
874   }
875
876   // Return the dynamic tags.
877   Output_data_dynamic*
878   dynamic_data() const
879   { return this->dynamic_data_; }
880
881   // Write out the output sections.
882   void
883   write_output_sections(Output_file* of) const;
884
885   // Write out data not associated with an input file or the symbol
886   // table.
887   void
888   write_data(const Symbol_table*, Output_file*) const;
889
890   // Write out output sections which can not be written until all the
891   // input sections are complete.
892   void
893   write_sections_after_input_sections(Output_file* of);
894
895   // Return an output section named NAME, or NULL if there is none.
896   Output_section*
897   find_output_section(const char* name) const;
898
899   // Return an output segment of type TYPE, with segment flags SET set
900   // and segment flags CLEAR clear.  Return NULL if there is none.
901   Output_segment*
902   find_output_segment(elfcpp::PT type, elfcpp::Elf_Word set,
903                       elfcpp::Elf_Word clear) const;
904
905   // Return the number of segments we expect to produce.
906   size_t
907   expected_segment_count() const;
908
909   // Set a flag to indicate that an object file uses the static TLS model.
910   void
911   set_has_static_tls()
912   { this->has_static_tls_ = true; }
913
914   // Return true if any object file uses the static TLS model.
915   bool
916   has_static_tls() const
917   { return this->has_static_tls_; }
918
919   // Return the options which may be set by a linker script.
920   Script_options*
921   script_options()
922   { return this->script_options_; }
923
924   const Script_options*
925   script_options() const
926   { return this->script_options_; }
927
928   // Return the object managing inputs in incremental build. NULL in
929   // non-incremental builds.
930   Incremental_inputs*
931   incremental_inputs() const
932   { return this->incremental_inputs_; }
933
934   // For the target-specific code to add dynamic tags which are common
935   // to most targets.
936   void
937   add_target_dynamic_tags(bool use_rel, const Output_data* plt_got,
938                           const Output_data* plt_rel,
939                           const Output_data_reloc_generic* dyn_rel,
940                           bool add_debug, bool dynrel_includes_plt);
941
942   // Add a target-specific dynamic tag with constant value.
943   void
944   add_target_specific_dynamic_tag(elfcpp::DT tag, unsigned int val);
945
946   // Compute and write out the build ID if needed.
947   void
948   write_build_id(Output_file*, unsigned char*, size_t) const;
949
950   // Rewrite output file in binary format.
951   void
952   write_binary(Output_file* in) const;
953
954   // Print output sections to the map file.
955   void
956   print_to_mapfile(Mapfile*) const;
957
958   // Dump statistical information to stderr.
959   void
960   print_stats() const;
961
962   // A list of segments.
963
964   typedef std::vector<Output_segment*> Segment_list;
965
966   // A list of sections.
967
968   typedef std::vector<Output_section*> Section_list;
969
970   // The list of information to write out which is not attached to
971   // either a section or a segment.
972   typedef std::vector<Output_data*> Data_list;
973
974   // Store the allocated sections into the section list.  This is used
975   // by the linker script code.
976   void
977   get_allocated_sections(Section_list*) const;
978
979   // Store the executable sections into the section list.
980   void
981   get_executable_sections(Section_list*) const;
982
983   // Make a section for a linker script to hold data.
984   Output_section*
985   make_output_section_for_script(const char* name,
986                                  Script_sections::Section_type section_type);
987
988   // Make a segment.  This is used by the linker script code.
989   Output_segment*
990   make_output_segment(elfcpp::Elf_Word type, elfcpp::Elf_Word flags);
991
992   // Return the number of segments.
993   size_t
994   segment_count() const
995   { return this->segment_list_.size(); }
996
997   // Map from section flags to segment flags.
998   static elfcpp::Elf_Word
999   section_flags_to_segment(elfcpp::Elf_Xword flags);
1000
1001   // Attach sections to segments.
1002   void
1003   attach_sections_to_segments(const Target*);
1004
1005   // For relaxation clean up, we need to know output section data created
1006   // from a linker script.
1007   void
1008   new_output_section_data_from_script(Output_section_data* posd)
1009   {
1010     if (this->record_output_section_data_from_script_)
1011       this->script_output_section_data_list_.push_back(posd);
1012   }
1013
1014   // Return section list.
1015   const Section_list&
1016   section_list() const
1017   { return this->section_list_; }
1018
1019   // Returns TRUE iff NAME (an input section from RELOBJ) will
1020   // be mapped to an output section that should be KEPT.
1021   bool
1022   keep_input_section(const Relobj*, const char*);
1023
1024   // Add a special output object that will be recreated afresh
1025   // if there is another relaxation iteration.
1026   void
1027   add_relax_output(Output_data* data)
1028   { this->relax_output_list_.push_back(data); }
1029
1030   // Clear out (and free) everything added by add_relax_output.
1031   void
1032   reset_relax_output();
1033
1034  private:
1035   Layout(const Layout&);
1036   Layout& operator=(const Layout&);
1037
1038   // Mapping from input section names to output section names.
1039   struct Section_name_mapping
1040   {
1041     const char* from;
1042     int fromlen;
1043     const char* to;
1044     int tolen;
1045   };
1046   static const Section_name_mapping section_name_mapping[];
1047   static const int section_name_mapping_count;
1048   static const Section_name_mapping text_section_name_mapping[];
1049   static const int text_section_name_mapping_count;
1050
1051   // Find section name NAME in map and return the mapped name if found
1052   // with the length set in PLEN.
1053   static const char* match_section_name(const Section_name_mapping* map,
1054                                         const int count, const char* name,
1055                                         size_t* plen);
1056
1057   // During a relocatable link, a list of group sections and
1058   // signatures.
1059   struct Group_signature
1060   {
1061     // The group section.
1062     Output_section* section;
1063     // The signature.
1064     const char* signature;
1065
1066     Group_signature()
1067       : section(NULL), signature(NULL)
1068     { }
1069
1070     Group_signature(Output_section* sectiona, const char* signaturea)
1071       : section(sectiona), signature(signaturea)
1072     { }
1073   };
1074   typedef std::vector<Group_signature> Group_signatures;
1075
1076   // Create a note section, filling in the header.
1077   Output_section*
1078   create_note(const char* name, int note_type, const char* section_name,
1079               size_t descsz, bool allocate, size_t* trailing_padding);
1080
1081   // Create a note section for gnu program properties.
1082   void
1083   create_gnu_properties_note();
1084
1085   // Create a note section for gold version.
1086   void
1087   create_gold_note();
1088
1089   // Record whether the stack must be executable, and a user-supplied size.
1090   void
1091   create_stack_segment();
1092
1093   // Create a build ID note if needed.
1094   void
1095   create_build_id();
1096
1097   // Link .stab and .stabstr sections.
1098   void
1099   link_stabs_sections();
1100
1101   // Create .gnu_incremental_inputs and .gnu_incremental_strtab sections needed
1102   // for the next run of incremental linking to check what has changed.
1103   void
1104   create_incremental_info_sections(Symbol_table*);
1105
1106   // Find the first read-only PT_LOAD segment, creating one if
1107   // necessary.
1108   Output_segment*
1109   find_first_load_seg(const Target*);
1110
1111   // Count the local symbols in the regular symbol table and the dynamic
1112   // symbol table, and build the respective string pools.
1113   void
1114   count_local_symbols(const Task*, const Input_objects*);
1115
1116   // Create the output sections for the symbol table.
1117   void
1118   create_symtab_sections(const Input_objects*, Symbol_table*,
1119                          unsigned int, off_t*, unsigned int);
1120
1121   // Create the .shstrtab section.
1122   Output_section*
1123   create_shstrtab();
1124
1125   // Create the section header table.
1126   void
1127   create_shdrs(const Output_section* shstrtab_section, off_t*);
1128
1129   // Create the dynamic symbol table.
1130   void
1131   create_dynamic_symtab(const Input_objects*, Symbol_table*,
1132                         Output_section** pdynstr,
1133                         unsigned int* plocal_dynamic_count,
1134                         unsigned int* pforced_local_dynamic_count,
1135                         std::vector<Symbol*>* pdynamic_symbols,
1136                         Versions* versions);
1137
1138   // Assign offsets to each local portion of the dynamic symbol table.
1139   void
1140   assign_local_dynsym_offsets(const Input_objects*);
1141
1142   // Finish the .dynamic section and PT_DYNAMIC segment.
1143   void
1144   finish_dynamic_section(const Input_objects*, const Symbol_table*);
1145
1146   // Set the size of the _DYNAMIC symbol.
1147   void
1148   set_dynamic_symbol_size(const Symbol_table*);
1149
1150   // Create the .interp section and PT_INTERP segment.
1151   void
1152   create_interp(const Target* target);
1153
1154   // Create the version sections.
1155   void
1156   create_version_sections(const Versions*,
1157                           const Symbol_table*,
1158                           unsigned int local_symcount,
1159                           const std::vector<Symbol*>& dynamic_symbols,
1160                           const Output_section* dynstr);
1161
1162   template<int size, bool big_endian>
1163   void
1164   sized_create_version_sections(const Versions* versions,
1165                                 const Symbol_table*,
1166                                 unsigned int local_symcount,
1167                                 const std::vector<Symbol*>& dynamic_symbols,
1168                                 const Output_section* dynstr);
1169
1170   // Return whether to include this section in the link.
1171   template<int size, bool big_endian>
1172   bool
1173   include_section(Sized_relobj_file<size, big_endian>* object, const char* name,
1174                   const elfcpp::Shdr<size, big_endian>&);
1175
1176   // Return the output section name to use given an input section
1177   // name.  Set *PLEN to the length of the name.  *PLEN must be
1178   // initialized to the length of NAME.
1179   static const char*
1180   output_section_name(const Relobj*, const char* name, size_t* plen);
1181
1182   // Return the number of allocated output sections.
1183   size_t
1184   allocated_output_section_count() const;
1185
1186   // Return the output section for NAME, TYPE and FLAGS.
1187   Output_section*
1188   get_output_section(const char* name, Stringpool::Key name_key,
1189                      elfcpp::Elf_Word type, elfcpp::Elf_Xword flags,
1190                      Output_section_order order, bool is_relro);
1191
1192   // Clear the input section flags that should not be copied to the
1193   // output section.
1194   elfcpp::Elf_Xword
1195   get_output_section_flags (elfcpp::Elf_Xword input_section_flags);
1196
1197   // Choose the output section for NAME in RELOBJ.
1198   Output_section*
1199   choose_output_section(const Relobj* relobj, const char* name,
1200                         elfcpp::Elf_Word type, elfcpp::Elf_Xword flags,
1201                         bool is_input_section, Output_section_order order,
1202                         bool is_relro, bool is_reloc, bool match_input_spec);
1203
1204   // Create a new Output_section.
1205   Output_section*
1206   make_output_section(const char* name, elfcpp::Elf_Word type,
1207                       elfcpp::Elf_Xword flags, Output_section_order order,
1208                       bool is_relro);
1209
1210   // Attach a section to a segment.
1211   void
1212   attach_section_to_segment(const Target*, Output_section*);
1213
1214   // Get section order.
1215   Output_section_order
1216   default_section_order(Output_section*, bool is_relro_local);
1217
1218   // Attach an allocated section to a segment.
1219   void
1220   attach_allocated_section_to_segment(const Target*, Output_section*);
1221
1222   // Make the .eh_frame section.
1223   Output_section*
1224   make_eh_frame_section(const Relobj*);
1225
1226   // Set the final file offsets of all the segments.
1227   off_t
1228   set_segment_offsets(const Target*, Output_segment*, unsigned int* pshndx);
1229
1230   // Set the file offsets of the sections when doing a relocatable
1231   // link.
1232   off_t
1233   set_relocatable_section_offsets(Output_data*, unsigned int* pshndx);
1234
1235   // Set the final file offsets of all the sections not associated
1236   // with a segment.  We set section offsets in three passes: the
1237   // first handles all allocated sections, the second sections that
1238   // require postprocessing, and the last the late-bound STRTAB
1239   // sections (probably only shstrtab, which is the one we care about
1240   // because it holds section names).
1241   enum Section_offset_pass
1242   {
1243     BEFORE_INPUT_SECTIONS_PASS,
1244     POSTPROCESSING_SECTIONS_PASS,
1245     STRTAB_AFTER_POSTPROCESSING_SECTIONS_PASS
1246   };
1247   off_t
1248   set_section_offsets(off_t, Section_offset_pass pass);
1249
1250   // Set the final section indexes of all the sections not associated
1251   // with a segment.  Returns the next unused index.
1252   unsigned int
1253   set_section_indexes(unsigned int pshndx);
1254
1255   // Set the section addresses when using a script.
1256   Output_segment*
1257   set_section_addresses_from_script(Symbol_table*);
1258
1259   // Find appropriate places or orphan sections in a script.
1260   void
1261   place_orphan_sections_in_script();
1262
1263   // Return whether SEG1 comes before SEG2 in the output file.
1264   bool
1265   segment_precedes(const Output_segment* seg1, const Output_segment* seg2);
1266
1267   // Use to save and restore segments during relaxation.
1268   typedef Unordered_map<const Output_segment*, const Output_segment*>
1269     Segment_states;
1270
1271   // Save states of current output segments.
1272   void
1273   save_segments(Segment_states*);
1274
1275   // Restore output segment states.
1276   void
1277   restore_segments(const Segment_states*);
1278
1279   // Clean up after relaxation so that it is possible to lay out the
1280   // sections and segments again.
1281   void
1282   clean_up_after_relaxation();
1283
1284   // Doing preparation work for relaxation.  This is factored out to make
1285   // Layout::finalized a bit smaller and easier to read.
1286   void
1287   prepare_for_relaxation();
1288
1289   // Main body of the relaxation loop, which lays out the section.
1290   off_t
1291   relaxation_loop_body(int, Target*, Symbol_table*, Output_segment**,
1292                        Output_segment*, Output_segment_headers*,
1293                        Output_file_header*, unsigned int*);
1294
1295   // A mapping used for kept comdats/.gnu.linkonce group signatures.
1296   typedef Unordered_map<std::string, Kept_section> Signatures;
1297
1298   // Mapping from input section name/type/flags to output section.  We
1299   // use canonicalized strings here.
1300
1301   typedef std::pair<Stringpool::Key,
1302                     std::pair<elfcpp::Elf_Word, elfcpp::Elf_Xword> > Key;
1303
1304   struct Hash_key
1305   {
1306     size_t
1307     operator()(const Key& k) const;
1308   };
1309
1310   typedef Unordered_map<Key, Output_section*, Hash_key> Section_name_map;
1311
1312   // A comparison class for segments.
1313
1314   class Compare_segments
1315   {
1316    public:
1317     Compare_segments(Layout* layout)
1318       : layout_(layout)
1319     { }
1320
1321     bool
1322     operator()(const Output_segment* seg1, const Output_segment* seg2)
1323     { return this->layout_->segment_precedes(seg1, seg2); }
1324
1325    private:
1326     Layout* layout_;
1327   };
1328
1329   typedef std::vector<Output_section_data*> Output_section_data_list;
1330
1331   // Debug checker class.
1332   class Relaxation_debug_check
1333   {
1334    public:
1335     Relaxation_debug_check()
1336       : section_infos_()
1337     { }
1338
1339     // Check that sections and special data are in reset states.
1340     void
1341     check_output_data_for_reset_values(const Layout::Section_list&,
1342                                        const Layout::Data_list& special_outputs,
1343                                        const Layout::Data_list& relax_outputs);
1344
1345     // Record information of a section list.
1346     void
1347     read_sections(const Layout::Section_list&);
1348
1349     // Verify a section list with recorded information.
1350     void
1351     verify_sections(const Layout::Section_list&);
1352
1353    private:
1354     // Information we care about a section.
1355     struct Section_info
1356     {
1357       // Output section described by this.
1358       Output_section* output_section;
1359       // Load address.
1360       uint64_t address;
1361       // Data size.
1362       off_t data_size;
1363       // File offset.
1364       off_t offset;
1365     };
1366
1367     // Section information.
1368     std::vector<Section_info> section_infos_;
1369   };
1370
1371   // Program properties from .note.gnu.property sections.
1372   struct Gnu_property
1373   {
1374     size_t pr_datasz;
1375     unsigned char* pr_data;
1376   };
1377   typedef std::map<unsigned int, Gnu_property> Gnu_properties;
1378
1379   // The number of input files, for sizing tables.
1380   int number_of_input_files_;
1381   // Information set by scripts or by command line options.
1382   Script_options* script_options_;
1383   // The output section names.
1384   Stringpool namepool_;
1385   // The output symbol names.
1386   Stringpool sympool_;
1387   // The dynamic strings, if needed.
1388   Stringpool dynpool_;
1389   // The list of group sections and linkonce sections which we have seen.
1390   Signatures signatures_;
1391   // The mapping from input section name/type/flags to output sections.
1392   Section_name_map section_name_map_;
1393   // The list of output segments.
1394   Segment_list segment_list_;
1395   // The list of output sections.
1396   Section_list section_list_;
1397   // The list of output sections which are not attached to any output
1398   // segment.
1399   Section_list unattached_section_list_;
1400   // The list of unattached Output_data objects which require special
1401   // handling because they are not Output_sections.
1402   Data_list special_output_list_;
1403   // Like special_output_list_, but cleared and recreated on each
1404   // iteration of relaxation.
1405   Data_list relax_output_list_;
1406   // The section headers.
1407   Output_section_headers* section_headers_;
1408   // A pointer to the PT_TLS segment if there is one.
1409   Output_segment* tls_segment_;
1410   // A pointer to the PT_GNU_RELRO segment if there is one.
1411   Output_segment* relro_segment_;
1412   // A pointer to the PT_INTERP segment if there is one.
1413   Output_segment* interp_segment_;
1414   // A backend may increase the size of the PT_GNU_RELRO segment if
1415   // there is one.  This is the amount to increase it by.
1416   unsigned int increase_relro_;
1417   // The SHT_SYMTAB output section.
1418   Output_section* symtab_section_;
1419   // The SHT_SYMTAB_SHNDX for the regular symbol table if there is one.
1420   Output_symtab_xindex* symtab_xindex_;
1421   // The SHT_DYNSYM output section if there is one.
1422   Output_section* dynsym_section_;
1423   // The SHT_SYMTAB_SHNDX for the dynamic symbol table if there is one.
1424   Output_symtab_xindex* dynsym_xindex_;
1425   // The SHT_DYNAMIC output section if there is one.
1426   Output_section* dynamic_section_;
1427   // The _DYNAMIC symbol if there is one.
1428   Symbol* dynamic_symbol_;
1429   // The dynamic data which goes into dynamic_section_.
1430   Output_data_dynamic* dynamic_data_;
1431   // The exception frame output section if there is one.
1432   Output_section* eh_frame_section_;
1433   // The exception frame data for eh_frame_section_.
1434   Eh_frame* eh_frame_data_;
1435   // Whether we have added eh_frame_data_ to the .eh_frame section.
1436   bool added_eh_frame_data_;
1437   // The exception frame header output section if there is one.
1438   Output_section* eh_frame_hdr_section_;
1439   // The data for the .gdb_index section.
1440   Gdb_index* gdb_index_data_;
1441   // The space for the build ID checksum if there is one.
1442   Output_section_data* build_id_note_;
1443   // The output section containing dwarf abbreviations
1444   Output_reduced_debug_abbrev_section* debug_abbrev_;
1445   // The output section containing the dwarf debug info tree
1446   Output_reduced_debug_info_section* debug_info_;
1447   // A list of group sections and their signatures.
1448   Group_signatures group_signatures_;
1449   // The size of the output file.
1450   off_t output_file_size_;
1451   // Whether we have added an input section to an output section.
1452   bool have_added_input_section_;
1453   // Whether we have attached the sections to the segments.
1454   bool sections_are_attached_;
1455   // Whether we have seen an object file marked to require an
1456   // executable stack.
1457   bool input_requires_executable_stack_;
1458   // Whether we have seen at least one object file with an executable
1459   // stack marker.
1460   bool input_with_gnu_stack_note_;
1461   // Whether we have seen at least one object file without an
1462   // executable stack marker.
1463   bool input_without_gnu_stack_note_;
1464   // Whether we have seen an object file that uses the static TLS model.
1465   bool has_static_tls_;
1466   // Whether any sections require postprocessing.
1467   bool any_postprocessing_sections_;
1468   // Whether we have resized the signatures_ hash table.
1469   bool resized_signatures_;
1470   // Whether we have created a .stab*str output section.
1471   bool have_stabstr_section_;
1472   // True if the input sections in the output sections should be sorted
1473   // as specified in a section ordering file.
1474   bool section_ordering_specified_;
1475   // True if some input sections need to be mapped to a unique segment,
1476   // after being mapped to a unique Output_section.
1477   bool unique_segment_for_sections_specified_;
1478   // In incremental build, holds information check the inputs and build the
1479   // .gnu_incremental_inputs section.
1480   Incremental_inputs* incremental_inputs_;
1481   // Whether we record output section data created in script
1482   bool record_output_section_data_from_script_;
1483   // List of output data that needs to be removed at relaxation clean up.
1484   Output_section_data_list script_output_section_data_list_;
1485   // Structure to save segment states before entering the relaxation loop.
1486   Segment_states* segment_states_;
1487   // A relaxation debug checker.  We only create one when in debugging mode.
1488   Relaxation_debug_check* relaxation_debug_check_;
1489   // Plugins specify section_ordering using this map.  This is set in
1490   // update_section_order in plugin.cc
1491   std::map<Section_id, unsigned int> section_order_map_;
1492   // This maps an input section to a unique segment. This is done by first
1493   // placing such input sections in unique output sections and then mapping
1494   // the output section to a unique segment.  Unique_segment_info stores
1495   // any additional flags and alignment of the new segment.
1496   Section_segment_map section_segment_map_;
1497   // Hash a pattern to its position in the section ordering file.
1498   Unordered_map<std::string, unsigned int> input_section_position_;
1499   // Vector of glob only patterns in the section_ordering file.
1500   std::vector<std::string> input_section_glob_;
1501   // For incremental links, the base file to be modified.
1502   Incremental_binary* incremental_base_;
1503   // For incremental links, a list of free space within the file.
1504   Free_list free_list_;
1505   // Program properties.
1506   Gnu_properties gnu_properties_;
1507 };
1508
1509 // This task handles writing out data in output sections which is not
1510 // part of an input section, or which requires special handling.  When
1511 // this is done, it unblocks both output_sections_blocker and
1512 // final_blocker.
1513
1514 class Write_sections_task : public Task
1515 {
1516  public:
1517   Write_sections_task(const Layout* layout, Output_file* of,
1518                       Task_token* output_sections_blocker,
1519                       Task_token* input_sections_blocker,
1520                       Task_token* final_blocker)
1521     : layout_(layout), of_(of),
1522       output_sections_blocker_(output_sections_blocker),
1523       input_sections_blocker_(input_sections_blocker),
1524       final_blocker_(final_blocker)
1525   { }
1526
1527   // The standard Task methods.
1528
1529   Task_token*
1530   is_runnable();
1531
1532   void
1533   locks(Task_locker*);
1534
1535   void
1536   run(Workqueue*);
1537
1538   std::string
1539   get_name() const
1540   { return "Write_sections_task"; }
1541
1542  private:
1543   class Write_sections_locker;
1544
1545   const Layout* layout_;
1546   Output_file* of_;
1547   Task_token* output_sections_blocker_;
1548   Task_token* input_sections_blocker_;
1549   Task_token* final_blocker_;
1550 };
1551
1552 // This task handles writing out data which is not part of a section
1553 // or segment.
1554
1555 class Write_data_task : public Task
1556 {
1557  public:
1558   Write_data_task(const Layout* layout, const Symbol_table* symtab,
1559                   Output_file* of, Task_token* final_blocker)
1560     : layout_(layout), symtab_(symtab), of_(of), final_blocker_(final_blocker)
1561   { }
1562
1563   // The standard Task methods.
1564
1565   Task_token*
1566   is_runnable();
1567
1568   void
1569   locks(Task_locker*);
1570
1571   void
1572   run(Workqueue*);
1573
1574   std::string
1575   get_name() const
1576   { return "Write_data_task"; }
1577
1578  private:
1579   const Layout* layout_;
1580   const Symbol_table* symtab_;
1581   Output_file* of_;
1582   Task_token* final_blocker_;
1583 };
1584
1585 // This task handles writing out the global symbols.
1586
1587 class Write_symbols_task : public Task
1588 {
1589  public:
1590   Write_symbols_task(const Layout* layout, const Symbol_table* symtab,
1591                      const Input_objects* /*input_objects*/,
1592                      const Stringpool* sympool, const Stringpool* dynpool,
1593                      Output_file* of, Task_token* final_blocker)
1594     : layout_(layout), symtab_(symtab),
1595       sympool_(sympool), dynpool_(dynpool), of_(of),
1596       final_blocker_(final_blocker)
1597   { }
1598
1599   // The standard Task methods.
1600
1601   Task_token*
1602   is_runnable();
1603
1604   void
1605   locks(Task_locker*);
1606
1607   void
1608   run(Workqueue*);
1609
1610   std::string
1611   get_name() const
1612   { return "Write_symbols_task"; }
1613
1614  private:
1615   const Layout* layout_;
1616   const Symbol_table* symtab_;
1617   const Stringpool* sympool_;
1618   const Stringpool* dynpool_;
1619   Output_file* of_;
1620   Task_token* final_blocker_;
1621 };
1622
1623 // This task handles writing out data in output sections which can't
1624 // be written out until all the input sections have been handled.
1625 // This is for sections whose contents is based on the contents of
1626 // other output sections.
1627
1628 class Write_after_input_sections_task : public Task
1629 {
1630  public:
1631   Write_after_input_sections_task(Layout* layout, Output_file* of,
1632                                   Task_token* input_sections_blocker,
1633                                   Task_token* final_blocker)
1634     : layout_(layout), of_(of),
1635       input_sections_blocker_(input_sections_blocker),
1636       final_blocker_(final_blocker)
1637   { }
1638
1639   // The standard Task methods.
1640
1641   Task_token*
1642   is_runnable();
1643
1644   void
1645   locks(Task_locker*);
1646
1647   void
1648   run(Workqueue*);
1649
1650   std::string
1651   get_name() const
1652   { return "Write_after_input_sections_task"; }
1653
1654  private:
1655   Layout* layout_;
1656   Output_file* of_;
1657   Task_token* input_sections_blocker_;
1658   Task_token* final_blocker_;
1659 };
1660
1661 // This task function handles computation of the build id.
1662 // When using --build-id=tree, it schedules the tasks that
1663 // compute the hashes for each chunk of the file. This task
1664 // cannot run until we have finalized the size of the output
1665 // file, after the completion of Write_after_input_sections_task.
1666
1667 class Build_id_task_runner : public Task_function_runner
1668 {
1669  public:
1670   Build_id_task_runner(const General_options* options, const Layout* layout,
1671                        Output_file* of)
1672     : options_(options), layout_(layout), of_(of)
1673   { }
1674
1675   // Run the operation.
1676   void
1677   run(Workqueue*, const Task*);
1678
1679  private:
1680   const General_options* options_;
1681   const Layout* layout_;
1682   Output_file* of_;
1683 };
1684
1685 // This task function handles closing the file.
1686
1687 class Close_task_runner : public Task_function_runner
1688 {
1689  public:
1690   Close_task_runner(const General_options* options, const Layout* layout,
1691                     Output_file* of, unsigned char* array_of_hashes,
1692                     size_t size_of_hashes)
1693     : options_(options), layout_(layout), of_(of),
1694       array_of_hashes_(array_of_hashes), size_of_hashes_(size_of_hashes)
1695   { }
1696
1697   // Run the operation.
1698   void
1699   run(Workqueue*, const Task*);
1700
1701  private:
1702   const General_options* options_;
1703   const Layout* layout_;
1704   Output_file* of_;
1705   unsigned char* const array_of_hashes_;
1706   const size_t size_of_hashes_;
1707 };
1708
1709 // A small helper function to align an address.
1710
1711 inline uint64_t
1712 align_address(uint64_t address, uint64_t addralign)
1713 {
1714   if (addralign != 0)
1715     address = (address + addralign - 1) &~ (addralign - 1);
1716   return address;
1717 }
1718
1719 } // End namespace gold.
1720
1721 #endif // !defined(GOLD_LAYOUT_H)