gdb: Extend the comments in c-exp.y
[external/binutils.git] / gold / layout.h
1 // layout.h -- lay out output file sections for gold  -*- C++ -*-
2
3 // Copyright (C) 2006-2018 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 .eh_frame information for a PLT.  FDEs using the CIE must
670   // be removed in reverse order to the order they were added.
671   void
672   remove_eh_frame_for_plt(Output_data* plt, const unsigned char* cie_data,
673                           size_t cie_length, const unsigned char* fde_data,
674                           size_t fde_length);
675
676   // Scan a .debug_info or .debug_types section, and add summary
677   // information to the .gdb_index section.
678   template<int size, bool big_endian>
679   void
680   add_to_gdb_index(bool is_type_unit,
681                    Sized_relobj<size, big_endian>* object,
682                    const unsigned char* symbols,
683                    off_t symbols_size,
684                    unsigned int shndx,
685                    unsigned int reloc_shndx,
686                    unsigned int reloc_type);
687
688   // Handle a GNU stack note.  This is called once per input object
689   // file.  SEEN_GNU_STACK is true if the object file has a
690   // .note.GNU-stack section.  GNU_STACK_FLAGS is the section flags
691   // from that section if there was one.
692   void
693   layout_gnu_stack(bool seen_gnu_stack, uint64_t gnu_stack_flags,
694                    const Object*);
695
696   // Layout a .note.gnu.property section.
697   void
698   layout_gnu_property(unsigned int note_type,
699                       unsigned int pr_type,
700                       size_t pr_datasz,
701                       const unsigned char* pr_data,
702                       const Object* object);
703
704   // Merge per-object properties with program properties.
705   void
706   merge_gnu_properties(const Object* object);
707
708   // Add a target-specific property for the output .note.gnu.property section.
709   void
710   add_gnu_property(unsigned int note_type,
711                    unsigned int pr_type,
712                    size_t pr_datasz,
713                    const unsigned char* pr_data);
714
715   // Add an Output_section_data to the layout.  This is used for
716   // special sections like the GOT section.  ORDER is where the
717   // section should wind up in the output segment.  IS_RELRO is true
718   // for relro sections.
719   Output_section*
720   add_output_section_data(const char* name, elfcpp::Elf_Word type,
721                           elfcpp::Elf_Xword flags,
722                           Output_section_data*, Output_section_order order,
723                           bool is_relro);
724
725   // Increase the size of the relro segment by this much.
726   void
727   increase_relro(unsigned int s)
728   { this->increase_relro_ += s; }
729
730   // Create dynamic sections if necessary.
731   void
732   create_initial_dynamic_sections(Symbol_table*);
733
734   // Define __start and __stop symbols for output sections.
735   void
736   define_section_symbols(Symbol_table*);
737
738   // Create automatic note sections.
739   void
740   create_notes();
741
742   // Create sections for linker scripts.
743   void
744   create_script_sections()
745   { this->script_options_->create_script_sections(this); }
746
747   // Define symbols from any linker script.
748   void
749   define_script_symbols(Symbol_table* symtab)
750   { this->script_options_->add_symbols_to_table(symtab); }
751
752   // Define symbols for group signatures.
753   void
754   define_group_signatures(Symbol_table*);
755
756   // Return the Stringpool used for symbol names.
757   const Stringpool*
758   sympool() const
759   { return &this->sympool_; }
760
761   // Return the Stringpool used for dynamic symbol names and dynamic
762   // tags.
763   const Stringpool*
764   dynpool() const
765   { return &this->dynpool_; }
766
767   // Return the .dynamic output section.  This is only valid after the
768   // layout has been finalized.
769   Output_section*
770   dynamic_section() const
771   { return this->dynamic_section_; }
772
773   // Return the symtab_xindex section used to hold large section
774   // indexes for the normal symbol table.
775   Output_symtab_xindex*
776   symtab_xindex() const
777   { return this->symtab_xindex_; }
778
779   // Return the dynsym_xindex section used to hold large section
780   // indexes for the dynamic symbol table.
781   Output_symtab_xindex*
782   dynsym_xindex() const
783   { return this->dynsym_xindex_; }
784
785   // Return whether a section is a .gnu.linkonce section, given the
786   // section name.
787   static inline bool
788   is_linkonce(const char* name)
789   { return strncmp(name, ".gnu.linkonce", sizeof(".gnu.linkonce") - 1) == 0; }
790
791   // Whether we have added an input section.
792   bool
793   have_added_input_section() const
794   { return this->have_added_input_section_; }
795
796   // Return true if a section is a debugging section.
797   static inline bool
798   is_debug_info_section(const char* name)
799   {
800     // Debugging sections can only be recognized by name.
801     return (strncmp(name, ".debug", sizeof(".debug") - 1) == 0
802             || strncmp(name, ".zdebug", sizeof(".zdebug") - 1) == 0
803             || strncmp(name, ".gnu.linkonce.wi.",
804                        sizeof(".gnu.linkonce.wi.") - 1) == 0
805             || strncmp(name, ".line", sizeof(".line") - 1) == 0
806             || strncmp(name, ".stab", sizeof(".stab") - 1) == 0
807             || strncmp(name, ".pdr", sizeof(".pdr") - 1) == 0);
808   }
809
810   // Return true if RELOBJ is an input file whose base name matches
811   // FILE_NAME.  The base name must have an extension of ".o", and
812   // must be exactly FILE_NAME.o or FILE_NAME, one character, ".o".
813   static bool
814   match_file_name(const Relobj* relobj, const char* file_name);
815
816   // Return whether section SHNDX in RELOBJ is a .ctors/.dtors section
817   // with more than one word being mapped to a .init_array/.fini_array
818   // section.
819   bool
820   is_ctors_in_init_array(Relobj* relobj, unsigned int shndx) const;
821
822   // Check if a comdat group or .gnu.linkonce section with the given
823   // NAME is selected for the link.  If there is already a section,
824   // *KEPT_SECTION is set to point to the signature and the function
825   // returns false.  Otherwise, OBJECT, SHNDX,IS_COMDAT, and
826   // IS_GROUP_NAME are recorded for this NAME in the layout object,
827   // *KEPT_SECTION is set to the internal copy and the function return
828   // false.
829   bool
830   find_or_add_kept_section(const std::string& name, Relobj* object,
831                            unsigned int shndx, bool is_comdat,
832                            bool is_group_name, Kept_section** kept_section);
833
834   // Finalize the layout after all the input sections have been added.
835   off_t
836   finalize(const Input_objects*, Symbol_table*, Target*, const Task*);
837
838   // Return whether any sections require postprocessing.
839   bool
840   any_postprocessing_sections() const
841   { return this->any_postprocessing_sections_; }
842
843   // Return the size of the output file.
844   off_t
845   output_file_size() const
846   { return this->output_file_size_; }
847
848   // Return the TLS segment.  This will return NULL if there isn't
849   // one.
850   Output_segment*
851   tls_segment() const
852   { return this->tls_segment_; }
853
854   // Return the normal symbol table.
855   Output_section*
856   symtab_section() const
857   {
858     gold_assert(this->symtab_section_ != NULL);
859     return this->symtab_section_;
860   }
861
862   // Return the file offset of the normal symbol table.
863   off_t
864   symtab_section_offset() const;
865
866   // Return the section index of the normal symbol tabl.e
867   unsigned int
868   symtab_section_shndx() const;
869
870   // Return the dynamic symbol table.
871   Output_section*
872   dynsym_section() const
873   {
874     gold_assert(this->dynsym_section_ != NULL);
875     return this->dynsym_section_;
876   }
877
878   // Return the dynamic tags.
879   Output_data_dynamic*
880   dynamic_data() const
881   { return this->dynamic_data_; }
882
883   // Write out the output sections.
884   void
885   write_output_sections(Output_file* of) const;
886
887   // Write out data not associated with an input file or the symbol
888   // table.
889   void
890   write_data(const Symbol_table*, Output_file*) const;
891
892   // Write out output sections which can not be written until all the
893   // input sections are complete.
894   void
895   write_sections_after_input_sections(Output_file* of);
896
897   // Return an output section named NAME, or NULL if there is none.
898   Output_section*
899   find_output_section(const char* name) const;
900
901   // Return an output segment of type TYPE, with segment flags SET set
902   // and segment flags CLEAR clear.  Return NULL if there is none.
903   Output_segment*
904   find_output_segment(elfcpp::PT type, elfcpp::Elf_Word set,
905                       elfcpp::Elf_Word clear) const;
906
907   // Return the number of segments we expect to produce.
908   size_t
909   expected_segment_count() const;
910
911   // Set a flag to indicate that an object file uses the static TLS model.
912   void
913   set_has_static_tls()
914   { this->has_static_tls_ = true; }
915
916   // Return true if any object file uses the static TLS model.
917   bool
918   has_static_tls() const
919   { return this->has_static_tls_; }
920
921   // Return the options which may be set by a linker script.
922   Script_options*
923   script_options()
924   { return this->script_options_; }
925
926   const Script_options*
927   script_options() const
928   { return this->script_options_; }
929
930   // Return the object managing inputs in incremental build. NULL in
931   // non-incremental builds.
932   Incremental_inputs*
933   incremental_inputs() const
934   { return this->incremental_inputs_; }
935
936   // For the target-specific code to add dynamic tags which are common
937   // to most targets.
938   void
939   add_target_dynamic_tags(bool use_rel, const Output_data* plt_got,
940                           const Output_data* plt_rel,
941                           const Output_data_reloc_generic* dyn_rel,
942                           bool add_debug, bool dynrel_includes_plt);
943
944   // Add a target-specific dynamic tag with constant value.
945   void
946   add_target_specific_dynamic_tag(elfcpp::DT tag, unsigned int val);
947
948   // Compute and write out the build ID if needed.
949   void
950   write_build_id(Output_file*, unsigned char*, size_t) const;
951
952   // Rewrite output file in binary format.
953   void
954   write_binary(Output_file* in) const;
955
956   // Print output sections to the map file.
957   void
958   print_to_mapfile(Mapfile*) const;
959
960   // Dump statistical information to stderr.
961   void
962   print_stats() const;
963
964   // A list of segments.
965
966   typedef std::vector<Output_segment*> Segment_list;
967
968   // A list of sections.
969
970   typedef std::vector<Output_section*> Section_list;
971
972   // The list of information to write out which is not attached to
973   // either a section or a segment.
974   typedef std::vector<Output_data*> Data_list;
975
976   // Store the allocated sections into the section list.  This is used
977   // by the linker script code.
978   void
979   get_allocated_sections(Section_list*) const;
980
981   // Store the executable sections into the section list.
982   void
983   get_executable_sections(Section_list*) const;
984
985   // Make a section for a linker script to hold data.
986   Output_section*
987   make_output_section_for_script(const char* name,
988                                  Script_sections::Section_type section_type);
989
990   // Make a segment.  This is used by the linker script code.
991   Output_segment*
992   make_output_segment(elfcpp::Elf_Word type, elfcpp::Elf_Word flags);
993
994   // Return the number of segments.
995   size_t
996   segment_count() const
997   { return this->segment_list_.size(); }
998
999   // Map from section flags to segment flags.
1000   static elfcpp::Elf_Word
1001   section_flags_to_segment(elfcpp::Elf_Xword flags);
1002
1003   // Attach sections to segments.
1004   void
1005   attach_sections_to_segments(const Target*);
1006
1007   // For relaxation clean up, we need to know output section data created
1008   // from a linker script.
1009   void
1010   new_output_section_data_from_script(Output_section_data* posd)
1011   {
1012     if (this->record_output_section_data_from_script_)
1013       this->script_output_section_data_list_.push_back(posd);
1014   }
1015
1016   // Return section list.
1017   const Section_list&
1018   section_list() const
1019   { return this->section_list_; }
1020
1021   // Returns TRUE iff NAME (an input section from RELOBJ) will
1022   // be mapped to an output section that should be KEPT.
1023   bool
1024   keep_input_section(const Relobj*, const char*);
1025
1026   // Add a special output object that will be recreated afresh
1027   // if there is another relaxation iteration.
1028   void
1029   add_relax_output(Output_data* data)
1030   { this->relax_output_list_.push_back(data); }
1031
1032   // Clear out (and free) everything added by add_relax_output.
1033   void
1034   reset_relax_output();
1035
1036  private:
1037   Layout(const Layout&);
1038   Layout& operator=(const Layout&);
1039
1040   // Mapping from input section names to output section names.
1041   struct Section_name_mapping
1042   {
1043     const char* from;
1044     int fromlen;
1045     const char* to;
1046     int tolen;
1047   };
1048   static const Section_name_mapping section_name_mapping[];
1049   static const int section_name_mapping_count;
1050   static const Section_name_mapping text_section_name_mapping[];
1051   static const int text_section_name_mapping_count;
1052
1053   // Find section name NAME in map and return the mapped name if found
1054   // with the length set in PLEN.
1055   static const char* match_section_name(const Section_name_mapping* map,
1056                                         const int count, const char* name,
1057                                         size_t* plen);
1058
1059   // During a relocatable link, a list of group sections and
1060   // signatures.
1061   struct Group_signature
1062   {
1063     // The group section.
1064     Output_section* section;
1065     // The signature.
1066     const char* signature;
1067
1068     Group_signature()
1069       : section(NULL), signature(NULL)
1070     { }
1071
1072     Group_signature(Output_section* sectiona, const char* signaturea)
1073       : section(sectiona), signature(signaturea)
1074     { }
1075   };
1076   typedef std::vector<Group_signature> Group_signatures;
1077
1078   // Create a note section, filling in the header.
1079   Output_section*
1080   create_note(const char* name, int note_type, const char* section_name,
1081               size_t descsz, bool allocate, size_t* trailing_padding);
1082
1083   // Create a note section for gnu program properties.
1084   void
1085   create_gnu_properties_note();
1086
1087   // Create a note section for gold version.
1088   void
1089   create_gold_note();
1090
1091   // Record whether the stack must be executable, and a user-supplied size.
1092   void
1093   create_stack_segment();
1094
1095   // Create a build ID note if needed.
1096   void
1097   create_build_id();
1098
1099   // Link .stab and .stabstr sections.
1100   void
1101   link_stabs_sections();
1102
1103   // Create .gnu_incremental_inputs and .gnu_incremental_strtab sections needed
1104   // for the next run of incremental linking to check what has changed.
1105   void
1106   create_incremental_info_sections(Symbol_table*);
1107
1108   // Find the first read-only PT_LOAD segment, creating one if
1109   // necessary.
1110   Output_segment*
1111   find_first_load_seg(const Target*);
1112
1113   // Count the local symbols in the regular symbol table and the dynamic
1114   // symbol table, and build the respective string pools.
1115   void
1116   count_local_symbols(const Task*, const Input_objects*);
1117
1118   // Create the output sections for the symbol table.
1119   void
1120   create_symtab_sections(const Input_objects*, Symbol_table*,
1121                          unsigned int, off_t*, unsigned int);
1122
1123   // Create the .shstrtab section.
1124   Output_section*
1125   create_shstrtab();
1126
1127   // Create the section header table.
1128   void
1129   create_shdrs(const Output_section* shstrtab_section, off_t*);
1130
1131   // Create the dynamic symbol table.
1132   void
1133   create_dynamic_symtab(const Input_objects*, Symbol_table*,
1134                         Output_section** pdynstr,
1135                         unsigned int* plocal_dynamic_count,
1136                         unsigned int* pforced_local_dynamic_count,
1137                         std::vector<Symbol*>* pdynamic_symbols,
1138                         Versions* versions);
1139
1140   // Assign offsets to each local portion of the dynamic symbol table.
1141   void
1142   assign_local_dynsym_offsets(const Input_objects*);
1143
1144   // Finish the .dynamic section and PT_DYNAMIC segment.
1145   void
1146   finish_dynamic_section(const Input_objects*, const Symbol_table*);
1147
1148   // Set the size of the _DYNAMIC symbol.
1149   void
1150   set_dynamic_symbol_size(const Symbol_table*);
1151
1152   // Create the .interp section and PT_INTERP segment.
1153   void
1154   create_interp(const Target* target);
1155
1156   // Create the version sections.
1157   void
1158   create_version_sections(const Versions*,
1159                           const Symbol_table*,
1160                           unsigned int local_symcount,
1161                           const std::vector<Symbol*>& dynamic_symbols,
1162                           const Output_section* dynstr);
1163
1164   template<int size, bool big_endian>
1165   void
1166   sized_create_version_sections(const Versions* versions,
1167                                 const Symbol_table*,
1168                                 unsigned int local_symcount,
1169                                 const std::vector<Symbol*>& dynamic_symbols,
1170                                 const Output_section* dynstr);
1171
1172   // Return whether to include this section in the link.
1173   template<int size, bool big_endian>
1174   bool
1175   include_section(Sized_relobj_file<size, big_endian>* object, const char* name,
1176                   const elfcpp::Shdr<size, big_endian>&);
1177
1178   // Return the output section name to use given an input section
1179   // name.  Set *PLEN to the length of the name.  *PLEN must be
1180   // initialized to the length of NAME.
1181   static const char*
1182   output_section_name(const Relobj*, const char* name, size_t* plen);
1183
1184   // Return the number of allocated output sections.
1185   size_t
1186   allocated_output_section_count() const;
1187
1188   // Return the output section for NAME, TYPE and FLAGS.
1189   Output_section*
1190   get_output_section(const char* name, Stringpool::Key name_key,
1191                      elfcpp::Elf_Word type, elfcpp::Elf_Xword flags,
1192                      Output_section_order order, bool is_relro);
1193
1194   // Clear the input section flags that should not be copied to the
1195   // output section.
1196   elfcpp::Elf_Xword
1197   get_output_section_flags (elfcpp::Elf_Xword input_section_flags);
1198
1199   // Choose the output section for NAME in RELOBJ.
1200   Output_section*
1201   choose_output_section(const Relobj* relobj, const char* name,
1202                         elfcpp::Elf_Word type, elfcpp::Elf_Xword flags,
1203                         bool is_input_section, Output_section_order order,
1204                         bool is_relro, bool is_reloc, bool match_input_spec);
1205
1206   // Create a new Output_section.
1207   Output_section*
1208   make_output_section(const char* name, elfcpp::Elf_Word type,
1209                       elfcpp::Elf_Xword flags, Output_section_order order,
1210                       bool is_relro);
1211
1212   // Attach a section to a segment.
1213   void
1214   attach_section_to_segment(const Target*, Output_section*);
1215
1216   // Get section order.
1217   Output_section_order
1218   default_section_order(Output_section*, bool is_relro_local);
1219
1220   // Attach an allocated section to a segment.
1221   void
1222   attach_allocated_section_to_segment(const Target*, Output_section*);
1223
1224   // Make the .eh_frame section.
1225   Output_section*
1226   make_eh_frame_section(const Relobj*);
1227
1228   // Set the final file offsets of all the segments.
1229   off_t
1230   set_segment_offsets(const Target*, Output_segment*, unsigned int* pshndx);
1231
1232   // Set the file offsets of the sections when doing a relocatable
1233   // link.
1234   off_t
1235   set_relocatable_section_offsets(Output_data*, unsigned int* pshndx);
1236
1237   // Set the final file offsets of all the sections not associated
1238   // with a segment.  We set section offsets in three passes: the
1239   // first handles all allocated sections, the second sections that
1240   // require postprocessing, and the last the late-bound STRTAB
1241   // sections (probably only shstrtab, which is the one we care about
1242   // because it holds section names).
1243   enum Section_offset_pass
1244   {
1245     BEFORE_INPUT_SECTIONS_PASS,
1246     POSTPROCESSING_SECTIONS_PASS,
1247     STRTAB_AFTER_POSTPROCESSING_SECTIONS_PASS
1248   };
1249   off_t
1250   set_section_offsets(off_t, Section_offset_pass pass);
1251
1252   // Set the final section indexes of all the sections not associated
1253   // with a segment.  Returns the next unused index.
1254   unsigned int
1255   set_section_indexes(unsigned int pshndx);
1256
1257   // Set the section addresses when using a script.
1258   Output_segment*
1259   set_section_addresses_from_script(Symbol_table*);
1260
1261   // Find appropriate places or orphan sections in a script.
1262   void
1263   place_orphan_sections_in_script();
1264
1265   // Return whether SEG1 comes before SEG2 in the output file.
1266   bool
1267   segment_precedes(const Output_segment* seg1, const Output_segment* seg2);
1268
1269   // Use to save and restore segments during relaxation.
1270   typedef Unordered_map<const Output_segment*, const Output_segment*>
1271     Segment_states;
1272
1273   // Save states of current output segments.
1274   void
1275   save_segments(Segment_states*);
1276
1277   // Restore output segment states.
1278   void
1279   restore_segments(const Segment_states*);
1280
1281   // Clean up after relaxation so that it is possible to lay out the
1282   // sections and segments again.
1283   void
1284   clean_up_after_relaxation();
1285
1286   // Doing preparation work for relaxation.  This is factored out to make
1287   // Layout::finalized a bit smaller and easier to read.
1288   void
1289   prepare_for_relaxation();
1290
1291   // Main body of the relaxation loop, which lays out the section.
1292   off_t
1293   relaxation_loop_body(int, Target*, Symbol_table*, Output_segment**,
1294                        Output_segment*, Output_segment_headers*,
1295                        Output_file_header*, unsigned int*);
1296
1297   // A mapping used for kept comdats/.gnu.linkonce group signatures.
1298   typedef Unordered_map<std::string, Kept_section> Signatures;
1299
1300   // Mapping from input section name/type/flags to output section.  We
1301   // use canonicalized strings here.
1302
1303   typedef std::pair<Stringpool::Key,
1304                     std::pair<elfcpp::Elf_Word, elfcpp::Elf_Xword> > Key;
1305
1306   struct Hash_key
1307   {
1308     size_t
1309     operator()(const Key& k) const;
1310   };
1311
1312   typedef Unordered_map<Key, Output_section*, Hash_key> Section_name_map;
1313
1314   // A comparison class for segments.
1315
1316   class Compare_segments
1317   {
1318    public:
1319     Compare_segments(Layout* layout)
1320       : layout_(layout)
1321     { }
1322
1323     bool
1324     operator()(const Output_segment* seg1, const Output_segment* seg2)
1325     { return this->layout_->segment_precedes(seg1, seg2); }
1326
1327    private:
1328     Layout* layout_;
1329   };
1330
1331   typedef std::vector<Output_section_data*> Output_section_data_list;
1332
1333   // Debug checker class.
1334   class Relaxation_debug_check
1335   {
1336    public:
1337     Relaxation_debug_check()
1338       : section_infos_()
1339     { }
1340
1341     // Check that sections and special data are in reset states.
1342     void
1343     check_output_data_for_reset_values(const Layout::Section_list&,
1344                                        const Layout::Data_list& special_outputs,
1345                                        const Layout::Data_list& relax_outputs);
1346
1347     // Record information of a section list.
1348     void
1349     read_sections(const Layout::Section_list&);
1350
1351     // Verify a section list with recorded information.
1352     void
1353     verify_sections(const Layout::Section_list&);
1354
1355    private:
1356     // Information we care about a section.
1357     struct Section_info
1358     {
1359       // Output section described by this.
1360       Output_section* output_section;
1361       // Load address.
1362       uint64_t address;
1363       // Data size.
1364       off_t data_size;
1365       // File offset.
1366       off_t offset;
1367     };
1368
1369     // Section information.
1370     std::vector<Section_info> section_infos_;
1371   };
1372
1373   // Program properties from .note.gnu.property sections.
1374   struct Gnu_property
1375   {
1376     size_t pr_datasz;
1377     unsigned char* pr_data;
1378   };
1379   typedef std::map<unsigned int, Gnu_property> Gnu_properties;
1380
1381   // The number of input files, for sizing tables.
1382   int number_of_input_files_;
1383   // Information set by scripts or by command line options.
1384   Script_options* script_options_;
1385   // The output section names.
1386   Stringpool namepool_;
1387   // The output symbol names.
1388   Stringpool sympool_;
1389   // The dynamic strings, if needed.
1390   Stringpool dynpool_;
1391   // The list of group sections and linkonce sections which we have seen.
1392   Signatures signatures_;
1393   // The mapping from input section name/type/flags to output sections.
1394   Section_name_map section_name_map_;
1395   // The list of output segments.
1396   Segment_list segment_list_;
1397   // The list of output sections.
1398   Section_list section_list_;
1399   // The list of output sections which are not attached to any output
1400   // segment.
1401   Section_list unattached_section_list_;
1402   // The list of unattached Output_data objects which require special
1403   // handling because they are not Output_sections.
1404   Data_list special_output_list_;
1405   // Like special_output_list_, but cleared and recreated on each
1406   // iteration of relaxation.
1407   Data_list relax_output_list_;
1408   // The section headers.
1409   Output_section_headers* section_headers_;
1410   // A pointer to the PT_TLS segment if there is one.
1411   Output_segment* tls_segment_;
1412   // A pointer to the PT_GNU_RELRO segment if there is one.
1413   Output_segment* relro_segment_;
1414   // A pointer to the PT_INTERP segment if there is one.
1415   Output_segment* interp_segment_;
1416   // A backend may increase the size of the PT_GNU_RELRO segment if
1417   // there is one.  This is the amount to increase it by.
1418   unsigned int increase_relro_;
1419   // The SHT_SYMTAB output section.
1420   Output_section* symtab_section_;
1421   // The SHT_SYMTAB_SHNDX for the regular symbol table if there is one.
1422   Output_symtab_xindex* symtab_xindex_;
1423   // The SHT_DYNSYM output section if there is one.
1424   Output_section* dynsym_section_;
1425   // The SHT_SYMTAB_SHNDX for the dynamic symbol table if there is one.
1426   Output_symtab_xindex* dynsym_xindex_;
1427   // The SHT_DYNAMIC output section if there is one.
1428   Output_section* dynamic_section_;
1429   // The _DYNAMIC symbol if there is one.
1430   Symbol* dynamic_symbol_;
1431   // The dynamic data which goes into dynamic_section_.
1432   Output_data_dynamic* dynamic_data_;
1433   // The exception frame output section if there is one.
1434   Output_section* eh_frame_section_;
1435   // The exception frame data for eh_frame_section_.
1436   Eh_frame* eh_frame_data_;
1437   // Whether we have added eh_frame_data_ to the .eh_frame section.
1438   bool added_eh_frame_data_;
1439   // The exception frame header output section if there is one.
1440   Output_section* eh_frame_hdr_section_;
1441   // The data for the .gdb_index section.
1442   Gdb_index* gdb_index_data_;
1443   // The space for the build ID checksum if there is one.
1444   Output_section_data* build_id_note_;
1445   // The output section containing dwarf abbreviations
1446   Output_reduced_debug_abbrev_section* debug_abbrev_;
1447   // The output section containing the dwarf debug info tree
1448   Output_reduced_debug_info_section* debug_info_;
1449   // A list of group sections and their signatures.
1450   Group_signatures group_signatures_;
1451   // The size of the output file.
1452   off_t output_file_size_;
1453   // Whether we have added an input section to an output section.
1454   bool have_added_input_section_;
1455   // Whether we have attached the sections to the segments.
1456   bool sections_are_attached_;
1457   // Whether we have seen an object file marked to require an
1458   // executable stack.
1459   bool input_requires_executable_stack_;
1460   // Whether we have seen at least one object file with an executable
1461   // stack marker.
1462   bool input_with_gnu_stack_note_;
1463   // Whether we have seen at least one object file without an
1464   // executable stack marker.
1465   bool input_without_gnu_stack_note_;
1466   // Whether we have seen an object file that uses the static TLS model.
1467   bool has_static_tls_;
1468   // Whether any sections require postprocessing.
1469   bool any_postprocessing_sections_;
1470   // Whether we have resized the signatures_ hash table.
1471   bool resized_signatures_;
1472   // Whether we have created a .stab*str output section.
1473   bool have_stabstr_section_;
1474   // True if the input sections in the output sections should be sorted
1475   // as specified in a section ordering file.
1476   bool section_ordering_specified_;
1477   // True if some input sections need to be mapped to a unique segment,
1478   // after being mapped to a unique Output_section.
1479   bool unique_segment_for_sections_specified_;
1480   // In incremental build, holds information check the inputs and build the
1481   // .gnu_incremental_inputs section.
1482   Incremental_inputs* incremental_inputs_;
1483   // Whether we record output section data created in script
1484   bool record_output_section_data_from_script_;
1485   // List of output data that needs to be removed at relaxation clean up.
1486   Output_section_data_list script_output_section_data_list_;
1487   // Structure to save segment states before entering the relaxation loop.
1488   Segment_states* segment_states_;
1489   // A relaxation debug checker.  We only create one when in debugging mode.
1490   Relaxation_debug_check* relaxation_debug_check_;
1491   // Plugins specify section_ordering using this map.  This is set in
1492   // update_section_order in plugin.cc
1493   std::map<Section_id, unsigned int> section_order_map_;
1494   // This maps an input section to a unique segment. This is done by first
1495   // placing such input sections in unique output sections and then mapping
1496   // the output section to a unique segment.  Unique_segment_info stores
1497   // any additional flags and alignment of the new segment.
1498   Section_segment_map section_segment_map_;
1499   // Hash a pattern to its position in the section ordering file.
1500   Unordered_map<std::string, unsigned int> input_section_position_;
1501   // Vector of glob only patterns in the section_ordering file.
1502   std::vector<std::string> input_section_glob_;
1503   // For incremental links, the base file to be modified.
1504   Incremental_binary* incremental_base_;
1505   // For incremental links, a list of free space within the file.
1506   Free_list free_list_;
1507   // Program properties.
1508   Gnu_properties gnu_properties_;
1509 };
1510
1511 // This task handles writing out data in output sections which is not
1512 // part of an input section, or which requires special handling.  When
1513 // this is done, it unblocks both output_sections_blocker and
1514 // final_blocker.
1515
1516 class Write_sections_task : public Task
1517 {
1518  public:
1519   Write_sections_task(const Layout* layout, Output_file* of,
1520                       Task_token* output_sections_blocker,
1521                       Task_token* input_sections_blocker,
1522                       Task_token* final_blocker)
1523     : layout_(layout), of_(of),
1524       output_sections_blocker_(output_sections_blocker),
1525       input_sections_blocker_(input_sections_blocker),
1526       final_blocker_(final_blocker)
1527   { }
1528
1529   // The standard Task methods.
1530
1531   Task_token*
1532   is_runnable();
1533
1534   void
1535   locks(Task_locker*);
1536
1537   void
1538   run(Workqueue*);
1539
1540   std::string
1541   get_name() const
1542   { return "Write_sections_task"; }
1543
1544  private:
1545   class Write_sections_locker;
1546
1547   const Layout* layout_;
1548   Output_file* of_;
1549   Task_token* output_sections_blocker_;
1550   Task_token* input_sections_blocker_;
1551   Task_token* final_blocker_;
1552 };
1553
1554 // This task handles writing out data which is not part of a section
1555 // or segment.
1556
1557 class Write_data_task : public Task
1558 {
1559  public:
1560   Write_data_task(const Layout* layout, const Symbol_table* symtab,
1561                   Output_file* of, Task_token* final_blocker)
1562     : layout_(layout), symtab_(symtab), of_(of), final_blocker_(final_blocker)
1563   { }
1564
1565   // The standard Task methods.
1566
1567   Task_token*
1568   is_runnable();
1569
1570   void
1571   locks(Task_locker*);
1572
1573   void
1574   run(Workqueue*);
1575
1576   std::string
1577   get_name() const
1578   { return "Write_data_task"; }
1579
1580  private:
1581   const Layout* layout_;
1582   const Symbol_table* symtab_;
1583   Output_file* of_;
1584   Task_token* final_blocker_;
1585 };
1586
1587 // This task handles writing out the global symbols.
1588
1589 class Write_symbols_task : public Task
1590 {
1591  public:
1592   Write_symbols_task(const Layout* layout, const Symbol_table* symtab,
1593                      const Input_objects* /*input_objects*/,
1594                      const Stringpool* sympool, const Stringpool* dynpool,
1595                      Output_file* of, Task_token* final_blocker)
1596     : layout_(layout), symtab_(symtab),
1597       sympool_(sympool), dynpool_(dynpool), of_(of),
1598       final_blocker_(final_blocker)
1599   { }
1600
1601   // The standard Task methods.
1602
1603   Task_token*
1604   is_runnable();
1605
1606   void
1607   locks(Task_locker*);
1608
1609   void
1610   run(Workqueue*);
1611
1612   std::string
1613   get_name() const
1614   { return "Write_symbols_task"; }
1615
1616  private:
1617   const Layout* layout_;
1618   const Symbol_table* symtab_;
1619   const Stringpool* sympool_;
1620   const Stringpool* dynpool_;
1621   Output_file* of_;
1622   Task_token* final_blocker_;
1623 };
1624
1625 // This task handles writing out data in output sections which can't
1626 // be written out until all the input sections have been handled.
1627 // This is for sections whose contents is based on the contents of
1628 // other output sections.
1629
1630 class Write_after_input_sections_task : public Task
1631 {
1632  public:
1633   Write_after_input_sections_task(Layout* layout, Output_file* of,
1634                                   Task_token* input_sections_blocker,
1635                                   Task_token* final_blocker)
1636     : layout_(layout), of_(of),
1637       input_sections_blocker_(input_sections_blocker),
1638       final_blocker_(final_blocker)
1639   { }
1640
1641   // The standard Task methods.
1642
1643   Task_token*
1644   is_runnable();
1645
1646   void
1647   locks(Task_locker*);
1648
1649   void
1650   run(Workqueue*);
1651
1652   std::string
1653   get_name() const
1654   { return "Write_after_input_sections_task"; }
1655
1656  private:
1657   Layout* layout_;
1658   Output_file* of_;
1659   Task_token* input_sections_blocker_;
1660   Task_token* final_blocker_;
1661 };
1662
1663 // This task function handles computation of the build id.
1664 // When using --build-id=tree, it schedules the tasks that
1665 // compute the hashes for each chunk of the file. This task
1666 // cannot run until we have finalized the size of the output
1667 // file, after the completion of Write_after_input_sections_task.
1668
1669 class Build_id_task_runner : public Task_function_runner
1670 {
1671  public:
1672   Build_id_task_runner(const General_options* options, const Layout* layout,
1673                        Output_file* of)
1674     : options_(options), layout_(layout), of_(of)
1675   { }
1676
1677   // Run the operation.
1678   void
1679   run(Workqueue*, const Task*);
1680
1681  private:
1682   const General_options* options_;
1683   const Layout* layout_;
1684   Output_file* of_;
1685 };
1686
1687 // This task function handles closing the file.
1688
1689 class Close_task_runner : public Task_function_runner
1690 {
1691  public:
1692   Close_task_runner(const General_options* options, const Layout* layout,
1693                     Output_file* of, unsigned char* array_of_hashes,
1694                     size_t size_of_hashes)
1695     : options_(options), layout_(layout), of_(of),
1696       array_of_hashes_(array_of_hashes), size_of_hashes_(size_of_hashes)
1697   { }
1698
1699   // Run the operation.
1700   void
1701   run(Workqueue*, const Task*);
1702
1703  private:
1704   const General_options* options_;
1705   const Layout* layout_;
1706   Output_file* of_;
1707   unsigned char* const array_of_hashes_;
1708   const size_t size_of_hashes_;
1709 };
1710
1711 // A small helper function to align an address.
1712
1713 inline uint64_t
1714 align_address(uint64_t address, uint64_t addralign)
1715 {
1716   if (addralign != 0)
1717     address = (address + addralign - 1) &~ (addralign - 1);
1718   return address;
1719 }
1720
1721 } // End namespace gold.
1722
1723 #endif // !defined(GOLD_LAYOUT_H)