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