gold/layout.h

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