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