gold/target.h

   1 // target.h -- target support for gold   -*- C++ -*-
   2
   3 // Copyright (C) 2006-2015 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 // The abstract class Target is the interface for target specific
  24 // support.  It defines abstract methods which each target must
  25 // implement.  Typically there will be one target per processor, but
  26 // in some cases it may be necessary to have subclasses.
  27
  28 // For speed and consistency we want to use inline functions to handle
  29 // relocation processing.  So besides implementations of the abstract
  30 // methods, each target is expected to define a template
  31 // specialization of the relocation functions.
  32
  33 #ifndef GOLD_TARGET_H
  34 #define GOLD_TARGET_H
  35
  36 #include "elfcpp.h"
  37 #include "options.h"
  38 #include "parameters.h"
  39 #include "stringpool.h"
  40 #include "debug.h"
  41
  42 namespace gold
  43 {
  44
  45 class Object;
  46 class Relobj;
  47 template<int size, bool big_endian>
  48 class Sized_relobj;
  49 template<int size, bool big_endian>
  50 class Sized_relobj_file;
  51 class Relocatable_relocs;
  52 template<int size, bool big_endian>
  53 struct Relocate_info;
  54 class Reloc_symbol_changes;
  55 class Symbol;
  56 template<int size>
  57 class Sized_symbol;
  58 class Symbol_table;
  59 class Output_data;
  60 class Output_data_got_base;
  61 class Output_section;
  62 class Input_objects;
  63 class Task;
  64 struct Symbol_location;
  65 class Versions;
  66
  67 // The abstract class for target specific handling.
  68
  69 class Target
  70 {
  71  public:
  72   virtual ~Target()
  73   { }
  74
  75   // Return the bit size that this target implements.  This should
  76   // return 32 or 64.
  77   int
  78   get_size() const
  79   { return this->pti_->size; }
  80
  81   // Return whether this target is big-endian.
  82   bool
  83   is_big_endian() const
  84   { return this->pti_->is_big_endian; }
  85
  86   // Machine code to store in e_machine field of ELF header.
  87   elfcpp::EM
  88   machine_code() const
  89   { return this->pti_->machine_code; }
  90
  91   // Processor specific flags to store in e_flags field of ELF header.
  92   elfcpp::Elf_Word
  93   processor_specific_flags() const
  94   { return this->processor_specific_flags_; }
  95
  96   // Whether processor specific flags are set at least once.
  97   bool
  98   are_processor_specific_flags_set() const
  99   { return this->are_processor_specific_flags_set_; }
 100
 101   // Whether this target has a specific make_symbol function.
 102   bool
 103   has_make_symbol() const
 104   { return this->pti_->has_make_symbol; }
 105
 106   // Whether this target has a specific resolve function.
 107   bool
 108   has_resolve() const
 109   { return this->pti_->has_resolve; }
 110
 111   // Whether this target has a specific code fill function.
 112   bool
 113   has_code_fill() const
 114   { return this->pti_->has_code_fill; }
 115
 116   // Return the default name of the dynamic linker.
 117   const char*
 118   dynamic_linker() const
 119   { return this->pti_->dynamic_linker; }
 120
 121   // Return the default address to use for the text segment.
 122   uint64_t
 123   default_text_segment_address() const
 124   { return this->pti_->default_text_segment_address; }
 125
 126   // Return the ABI specified page size.
 127   uint64_t
 128   abi_pagesize() const
 129   {
 130     if (parameters->options().max_page_size() > 0)
 131       return parameters->options().max_page_size();
 132     else
 133       return this->pti_->abi_pagesize;
 134   }
 135
 136   // Return the common page size used on actual systems.
 137   uint64_t
 138   common_pagesize() const
 139   {
 140     if (parameters->options().common_page_size() > 0)
 141       return std::min(parameters->options().common_page_size(),
 142                       this->abi_pagesize());
 143     else
 144       return std::min(this->pti_->common_pagesize,
 145                       this->abi_pagesize());
 146   }
 147
 148   // Return whether PF_X segments must contain nothing but the contents of
 149   // SHF_EXECINSTR sections (no non-executable data, no headers).
 150   bool
 151   isolate_execinstr() const
 152   { return this->pti_->isolate_execinstr; }
 153
 154   uint64_t
 155   rosegment_gap() const
 156   { return this->pti_->rosegment_gap; }
 157
 158   // If we see some object files with .note.GNU-stack sections, and
 159   // some objects files without them, this returns whether we should
 160   // consider the object files without them to imply that the stack
 161   // should be executable.
 162   bool
 163   is_default_stack_executable() const
 164   { return this->pti_->is_default_stack_executable; }
 165
 166   // Return a character which may appear as a prefix for a wrap
 167   // symbol.  If this character appears, we strip it when checking for
 168   // wrapping and add it back when forming the final symbol name.
 169   // This should be '\0' if not special prefix is required, which is
 170   // the normal case.
 171   char
 172   wrap_char() const
 173   { return this->pti_->wrap_char; }
 174
 175   // Return the special section index which indicates a small common
 176   // symbol.  This will return SHN_UNDEF if there are no small common
 177   // symbols.
 178   elfcpp::Elf_Half
 179   small_common_shndx() const
 180   { return this->pti_->small_common_shndx; }
 181
 182   // Return values to add to the section flags for the section holding
 183   // small common symbols.
 184   elfcpp::Elf_Xword
 185   small_common_section_flags() const
 186   {
 187     gold_assert(this->pti_->small_common_shndx != elfcpp::SHN_UNDEF);
 188     return this->pti_->small_common_section_flags;
 189   }
 190
 191   // Return the special section index which indicates a large common
 192   // symbol.  This will return SHN_UNDEF if there are no large common
 193   // symbols.
 194   elfcpp::Elf_Half
 195   large_common_shndx() const
 196   { return this->pti_->large_common_shndx; }
 197
 198   // Return values to add to the section flags for the section holding
 199   // large common symbols.
 200   elfcpp::Elf_Xword
 201   large_common_section_flags() const
 202   {
 203     gold_assert(this->pti_->large_common_shndx != elfcpp::SHN_UNDEF);
 204     return this->pti_->large_common_section_flags;
 205   }
 206
 207   // This hook is called when an output section is created.
 208   void
 209   new_output_section(Output_section* os) const
 210   { this->do_new_output_section(os); }
 211
 212   // This is called to tell the target to complete any sections it is
 213   // handling.  After this all sections must have their final size.
 214   void
 215   finalize_sections(Layout* layout, const Input_objects* input_objects,
 216                     Symbol_table* symtab)
 217   { return this->do_finalize_sections(layout, input_objects, symtab); }
 218
 219   // Return the value to use for a global symbol which needs a special
 220   // value in the dynamic symbol table.  This will only be called if
 221   // the backend first calls symbol->set_needs_dynsym_value().
 222   uint64_t
 223   dynsym_value(const Symbol* sym) const
 224   { return this->do_dynsym_value(sym); }
 225
 226   // Return a string to use to fill out a code section.  This is
 227   // basically one or more NOPS which must fill out the specified
 228   // length in bytes.
 229   std::string
 230   code_fill(section_size_type length) const
 231   { return this->do_code_fill(length); }
 232
 233   // Return whether SYM is known to be defined by the ABI.  This is
 234   // used to avoid inappropriate warnings about undefined symbols.
 235   bool
 236   is_defined_by_abi(const Symbol* sym) const
 237   { return this->do_is_defined_by_abi(sym); }
 238
 239   // Adjust the output file header before it is written out.  VIEW
 240   // points to the header in external form.  LEN is the length.
 241   void
 242   adjust_elf_header(unsigned char* view, int len)
 243   { return this->do_adjust_elf_header(view, len); }
 244
 245   // Return address and size to plug into eh_frame FDEs associated with a PLT.
 246   void
 247   plt_fde_location(const Output_data* plt, unsigned char* oview,
 248                    uint64_t* address, off_t* len) const
 249   { return this->do_plt_fde_location(plt, oview, address, len); }
 250
 251   // Return whether NAME is a local label name.  This is used to implement the
 252   // --discard-locals options.
 253   bool
 254   is_local_label_name(const char* name) const
 255   { return this->do_is_local_label_name(name); }
 256
 257   // Get the symbol index to use for a target specific reloc.
 258   unsigned int
 259   reloc_symbol_index(void* arg, unsigned int type) const
 260   { return this->do_reloc_symbol_index(arg, type); }
 261
 262   // Get the addend to use for a target specific reloc.
 263   uint64_t
 264   reloc_addend(void* arg, unsigned int type, uint64_t addend) const
 265   { return this->do_reloc_addend(arg, type, addend); }
 266
 267   // Return the PLT address to use for a global symbol.
 268   uint64_t
 269   plt_address_for_global(const Symbol* sym) const
 270   { return this->do_plt_address_for_global(sym); }
 271
 272   // Return the PLT address to use for a local symbol.
 273   uint64_t
 274   plt_address_for_local(const Relobj* object, unsigned int symndx) const
 275   { return this->do_plt_address_for_local(object, symndx); }
 276
 277   // Return the offset to use for the GOT_INDX'th got entry which is
 278   // for a local tls symbol specified by OBJECT, SYMNDX.
 279   int64_t
 280   tls_offset_for_local(const Relobj* object,
 281                        unsigned int symndx,
 282                        unsigned int got_indx) const
 283   { return do_tls_offset_for_local(object, symndx, got_indx); }
 284
 285   // Return the offset to use for the GOT_INDX'th got entry which is
 286   // for global tls symbol GSYM.
 287   int64_t
 288   tls_offset_for_global(Symbol* gsym, unsigned int got_indx) const
 289   { return do_tls_offset_for_global(gsym, got_indx); }
 290
 291   // For targets that use function descriptors, if LOC is the location
 292   // of a function, modify it to point at the function entry location.
 293   void
 294   function_location(Symbol_location* loc) const
 295   { return do_function_location(loc); }
 296
 297   // Return whether this target can use relocation types to determine
 298   // if a function's address is taken.
 299   bool
 300   can_check_for_function_pointers() const
 301   { return this->do_can_check_for_function_pointers(); }
 302
 303   // Return whether a relocation to a merged section can be processed
 304   // to retrieve the contents.
 305   bool
 306   can_icf_inline_merge_sections () const
 307   { return this->pti_->can_icf_inline_merge_sections; }
 308
 309   // Whether a section called SECTION_NAME may have function pointers to
 310   // sections not eligible for safe ICF folding.
 311   virtual bool
 312   section_may_have_icf_unsafe_pointers(const char* section_name) const
 313   { return this->do_section_may_have_icf_unsafe_pointers(section_name); }
 314
 315   // Return the base to use for the PC value in an FDE when it is
 316   // encoded using DW_EH_PE_datarel.  This does not appear to be
 317   // documented anywhere, but it is target specific.  Any use of
 318   // DW_EH_PE_datarel in gcc requires defining a special macro
 319   // (ASM_MAYBE_OUTPUT_ENCODED_ADDR_RTX) to output the value.
 320   uint64_t
 321   ehframe_datarel_base() const
 322   { return this->do_ehframe_datarel_base(); }
 323
 324   // Return true if a reference to SYM from a reloc of type R_TYPE
 325   // means that the current function may call an object compiled
 326   // without -fsplit-stack.  SYM is known to be defined in an object
 327   // compiled without -fsplit-stack.
 328   bool
 329   is_call_to_non_split(const Symbol* sym, unsigned int r_type) const
 330   { return this->do_is_call_to_non_split(sym, r_type); }
 331
 332   // A function starts at OFFSET in section SHNDX in OBJECT.  That
 333   // function was compiled with -fsplit-stack, but it refers to a
 334   // function which was compiled without -fsplit-stack.  VIEW is a
 335   // modifiable view of the section; VIEW_SIZE is the size of the
 336   // view.  The target has to adjust the function so that it allocates
 337   // enough stack.
 338   void
 339   calls_non_split(Relobj* object, unsigned int shndx,
 340                   section_offset_type fnoffset, section_size_type fnsize,
 341                   unsigned char* view, section_size_type view_size,
 342                   std::string* from, std::string* to) const
 343   {
 344     this->do_calls_non_split(object, shndx, fnoffset, fnsize, view, view_size,
 345                              from, to);
 346   }
 347
 348   // Make an ELF object.
 349   template<int size, bool big_endian>
 350   Object*
 351   make_elf_object(const std::string& name, Input_file* input_file,
 352                   off_t offset, const elfcpp::Ehdr<size, big_endian>& ehdr)
 353   { return this->do_make_elf_object(name, input_file, offset, ehdr); }
 354
 355   // Make an output section.
 356   Output_section*
 357   make_output_section(const char* name, elfcpp::Elf_Word type,
 358                       elfcpp::Elf_Xword flags)
 359   { return this->do_make_output_section(name, type, flags); }
 360
 361   // Return true if target wants to perform relaxation.
 362   bool
 363   may_relax() const
 364   {
 365     // Run the dummy relaxation pass twice if relaxation debugging is enabled.
 366     if (is_debugging_enabled(DEBUG_RELAXATION))
 367       return true;
 368
 369      return this->do_may_relax();
 370   }
 371
 372   // Perform a relaxation pass.  Return true if layout may be changed.
 373   bool
 374   relax(int pass, const Input_objects* input_objects, Symbol_table* symtab,
 375         Layout* layout, const Task* task)
 376   {
 377     // Run the dummy relaxation pass twice if relaxation debugging is enabled.
 378     if (is_debugging_enabled(DEBUG_RELAXATION))
 379       return pass < 2;
 380
 381     return this->do_relax(pass, input_objects, symtab, layout, task);
 382   }
 383
 384   // Return the target-specific name of attributes section.  This is
 385   // NULL if a target does not use attributes section or if it uses
 386   // the default section name ".gnu.attributes".
 387   const char*
 388   attributes_section() const
 389   { return this->pti_->attributes_section; }
 390
 391   // Return the vendor name of vendor attributes.
 392   const char*
 393   attributes_vendor() const
 394   { return this->pti_->attributes_vendor; }
 395
 396   // Whether a section called NAME is an attribute section.
 397   bool
 398   is_attributes_section(const char* name) const
 399   {
 400     return ((this->pti_->attributes_section != NULL
 401              && strcmp(name, this->pti_->attributes_section) == 0)
 402             || strcmp(name, ".gnu.attributes") == 0);
 403   }
 404
 405   // Return a bit mask of argument types for attribute with TAG.
 406   int
 407   attribute_arg_type(int tag) const
 408   { return this->do_attribute_arg_type(tag); }
 409
 410   // Return the attribute tag of the position NUM in the list of fixed
 411   // attributes.  Normally there is no reordering and
 412   // attributes_order(NUM) == NUM.
 413   int
 414   attributes_order(int num) const
 415   { return this->do_attributes_order(num); }
 416
 417   // When a target is selected as the default target, we call this method,
 418   // which may be used for expensive, target-specific initialization.
 419   void
 420   select_as_default_target()
 421   { this->do_select_as_default_target(); }
 422
 423   // Return the value to store in the EI_OSABI field in the ELF
 424   // header.
 425   elfcpp::ELFOSABI
 426   osabi() const
 427   { return this->osabi_; }
 428
 429   // Set the value to store in the EI_OSABI field in the ELF header.
 430   void
 431   set_osabi(elfcpp::ELFOSABI osabi)
 432   { this->osabi_ = osabi; }
 433
 434   // Define target-specific standard symbols.
 435   void
 436   define_standard_symbols(Symbol_table* symtab, Layout* layout)
 437   { this->do_define_standard_symbols(symtab, layout); }
 438
 439   // Return the output section name to use given an input section
 440   // name, or NULL if no target specific name mapping is required.
 441   // Set *PLEN to the length of the name if returning non-NULL.
 442   const char*
 443   output_section_name(const Relobj* relobj,
 444                       const char* name,
 445                       size_t* plen) const
 446   { return this->do_output_section_name(relobj, name, plen); }
 447
 448   // Add any special sections for this symbol to the gc work list.
 449   void
 450   gc_mark_symbol(Symbol_table* symtab, Symbol* sym) const
 451   { this->do_gc_mark_symbol(symtab, sym); }
 452
 453   // Return the name of the entry point symbol.
 454   const char*
 455   entry_symbol_name() const
 456   { return this->pti_->entry_symbol_name; }
 457
 458   // Return the size in bits of SHT_HASH entry.
 459   int
 460   hash_entry_size() const
 461   { return this->pti_->hash_entry_size; }
 462
 463   // Whether the target has a custom set_dynsym_indexes method.
 464   bool
 465   has_custom_set_dynsym_indexes() const
 466   { return this->do_has_custom_set_dynsym_indexes(); }
 467
 468   // Custom set_dynsym_indexes method for a target.
 469   unsigned int
 470   set_dynsym_indexes(std::vector<Symbol*>* dyn_symbols, unsigned int index,
 471                      std::vector<Symbol*>* syms, Stringpool* dynpool,
 472                      Versions* versions, Symbol_table* symtab) const
 473   {
 474     return this->do_set_dynsym_indexes(dyn_symbols, index, syms, dynpool,
 475                                        versions, symtab);
 476   }
 477
 478   // Get the custom dynamic tag value.
 479   unsigned int
 480   dynamic_tag_custom_value(elfcpp::DT tag) const
 481   { return this->do_dynamic_tag_custom_value(tag); }
 482
 483   // Adjust the value written to the dynamic symbol table.
 484   void
 485   adjust_dyn_symbol(const Symbol* sym, unsigned char* view) const
 486   { this->do_adjust_dyn_symbol(sym, view); }
 487
 488   // Return whether to include the section in the link.
 489   bool
 490   should_include_section(elfcpp::Elf_Word sh_type) const
 491   { return this->do_should_include_section(sh_type); }
 492
 493  protected:
 494   // This struct holds the constant information for a child class.  We
 495   // use a struct to avoid the overhead of virtual function calls for
 496   // simple information.
 497   struct Target_info
 498   {
 499     // Address size (32 or 64).
 500     int size;
 501     // Whether the target is big endian.
 502     bool is_big_endian;
 503     // The code to store in the e_machine field of the ELF header.
 504     elfcpp::EM machine_code;
 505     // Whether this target has a specific make_symbol function.
 506     bool has_make_symbol;
 507     // Whether this target has a specific resolve function.
 508     bool has_resolve;
 509     // Whether this target has a specific code fill function.
 510     bool has_code_fill;
 511     // Whether an object file with no .note.GNU-stack sections implies
 512     // that the stack should be executable.
 513     bool is_default_stack_executable;
 514     // Whether a relocation to a merged section can be processed to
 515     // retrieve the contents.
 516     bool can_icf_inline_merge_sections;
 517     // Prefix character to strip when checking for wrapping.
 518     char wrap_char;
 519     // The default dynamic linker name.
 520     const char* dynamic_linker;
 521     // The default text segment address.
 522     uint64_t default_text_segment_address;
 523     // The ABI specified page size.
 524     uint64_t abi_pagesize;
 525     // The common page size used by actual implementations.
 526     uint64_t common_pagesize;
 527     // Whether PF_X segments must contain nothing but the contents of
 528     // SHF_EXECINSTR sections (no non-executable data, no headers).
 529     bool isolate_execinstr;
 530     // If nonzero, distance from the text segment to the read-only segment.
 531     uint64_t rosegment_gap;
 532     // The special section index for small common symbols; SHN_UNDEF
 533     // if none.
 534     elfcpp::Elf_Half small_common_shndx;
 535     // The special section index for large common symbols; SHN_UNDEF
 536     // if none.
 537     elfcpp::Elf_Half large_common_shndx;
 538     // Section flags for small common section.
 539     elfcpp::Elf_Xword small_common_section_flags;
 540     // Section flags for large common section.
 541     elfcpp::Elf_Xword large_common_section_flags;
 542     // Name of attributes section if it is not ".gnu.attributes".
 543     const char* attributes_section;
 544     // Vendor name of vendor attributes.
 545     const char* attributes_vendor;
 546     // Name of the main entry point to the program.
 547     const char* entry_symbol_name;
 548     // Size (in bits) of SHT_HASH entry. Always equal to 32, except for
 549     // 64-bit S/390.
 550     const int hash_entry_size;
 551   };
 552
 553   Target(const Target_info* pti)
 554     : pti_(pti), processor_specific_flags_(0),
 555       are_processor_specific_flags_set_(false), osabi_(elfcpp::ELFOSABI_NONE)
 556   { }
 557
 558   // Virtual function which may be implemented by the child class.
 559   virtual void
 560   do_new_output_section(Output_section*) const
 561   { }
 562
 563   // Virtual function which may be implemented by the child class.
 564   virtual void
 565   do_finalize_sections(Layout*, const Input_objects*, Symbol_table*)
 566   { }
 567
 568   // Virtual function which may be implemented by the child class.
 569   virtual uint64_t
 570   do_dynsym_value(const Symbol*) const
 571   { gold_unreachable(); }
 572
 573   // Virtual function which must be implemented by the child class if
 574   // needed.
 575   virtual std::string
 576   do_code_fill(section_size_type) const
 577   { gold_unreachable(); }
 578
 579   // Virtual function which may be implemented by the child class.
 580   virtual bool
 581   do_is_defined_by_abi(const Symbol*) const
 582   { return false; }
 583
 584   // Adjust the output file header before it is written out.  VIEW
 585   // points to the header in external form.  LEN is the length, and
 586   // will be one of the values of elfcpp::Elf_sizes<size>::ehdr_size.
 587   // By default, we set the EI_OSABI field if requested (in
 588   // Sized_target).
 589   virtual void
 590   do_adjust_elf_header(unsigned char*, int) = 0;
 591
 592   // Return address and size to plug into eh_frame FDEs associated with a PLT.
 593   virtual void
 594   do_plt_fde_location(const Output_data* plt, unsigned char* oview,
 595                       uint64_t* address, off_t* len) const;
 596
 597   // Virtual function which may be overridden by the child class.
 598   virtual bool
 599   do_is_local_label_name(const char*) const;
 600
 601   // Virtual function that must be overridden by a target which uses
 602   // target specific relocations.
 603   virtual unsigned int
 604   do_reloc_symbol_index(void*, unsigned int) const
 605   { gold_unreachable(); }
 606
 607   // Virtual function that must be overridden by a target which uses
 608   // target specific relocations.
 609   virtual uint64_t
 610   do_reloc_addend(void*, unsigned int, uint64_t) const
 611   { gold_unreachable(); }
 612
 613   // Virtual functions that must be overridden by a target that uses
 614   // STT_GNU_IFUNC symbols.
 615   virtual uint64_t
 616   do_plt_address_for_global(const Symbol*) const
 617   { gold_unreachable(); }
 618
 619   virtual uint64_t
 620   do_plt_address_for_local(const Relobj*, unsigned int) const
 621   { gold_unreachable(); }
 622
 623   virtual int64_t
 624   do_tls_offset_for_local(const Relobj*, unsigned int, unsigned int) const
 625   { gold_unreachable(); }
 626
 627   virtual int64_t
 628   do_tls_offset_for_global(Symbol*, unsigned int) const
 629   { gold_unreachable(); }
 630
 631   virtual void
 632   do_function_location(Symbol_location*) const = 0;
 633
 634   // Virtual function which may be overriden by the child class.
 635   virtual bool
 636   do_can_check_for_function_pointers() const
 637   { return false; }
 638
 639   // Virtual function which may be overridden by the child class.  We
 640   // recognize some default sections for which we don't care whether
 641   // they have function pointers.
 642   virtual bool
 643   do_section_may_have_icf_unsafe_pointers(const char* section_name) const
 644   {
 645     // We recognize sections for normal vtables, construction vtables and
 646     // EH frames.
 647     return (!is_prefix_of(".rodata._ZTV", section_name)
 648             && !is_prefix_of(".data.rel.ro._ZTV", section_name)
 649             && !is_prefix_of(".rodata._ZTC", section_name)
 650             && !is_prefix_of(".data.rel.ro._ZTC", section_name)
 651             && !is_prefix_of(".eh_frame", section_name));
 652   }
 653
 654   virtual uint64_t
 655   do_ehframe_datarel_base() const
 656   { gold_unreachable(); }
 657
 658   // Virtual function which may be overridden by the child class.  The
 659   // default implementation is that any function not defined by the
 660   // ABI is a call to a non-split function.
 661   virtual bool
 662   do_is_call_to_non_split(const Symbol* sym, unsigned int) const;
 663
 664   // Virtual function which may be overridden by the child class.
 665   virtual void
 666   do_calls_non_split(Relobj* object, unsigned int, section_offset_type,
 667                      section_size_type, unsigned char*, section_size_type,
 668                      std::string*, std::string*) const;
 669
 670   // make_elf_object hooks.  There are four versions of these for
 671   // different address sizes and endianness.
 672
 673   // Set processor specific flags.
 674   void
 675   set_processor_specific_flags(elfcpp::Elf_Word flags)
 676   {
 677     this->processor_specific_flags_ = flags;
 678     this->are_processor_specific_flags_set_ = true;
 679   }
 680
 681 #ifdef HAVE_TARGET_32_LITTLE
 682   // Virtual functions which may be overridden by the child class.
 683   virtual Object*
 684   do_make_elf_object(const std::string&, Input_file*, off_t,
 685                      const elfcpp::Ehdr<32, false>&);
 686 #endif
 687
 688 #ifdef HAVE_TARGET_32_BIG
 689   // Virtual functions which may be overridden by the child class.
 690   virtual Object*
 691   do_make_elf_object(const std::string&, Input_file*, off_t,
 692                      const elfcpp::Ehdr<32, true>&);
 693 #endif
 694
 695 #ifdef HAVE_TARGET_64_LITTLE
 696   // Virtual functions which may be overridden by the child class.
 697   virtual Object*
 698   do_make_elf_object(const std::string&, Input_file*, off_t,
 699                      const elfcpp::Ehdr<64, false>& ehdr);
 700 #endif
 701
 702 #ifdef HAVE_TARGET_64_BIG
 703   // Virtual functions which may be overridden by the child class.
 704   virtual Object*
 705   do_make_elf_object(const std::string& name, Input_file* input_file,
 706                      off_t offset, const elfcpp::Ehdr<64, true>& ehdr);
 707 #endif
 708
 709   // Virtual functions which may be overridden by the child class.
 710   virtual Output_section*
 711   do_make_output_section(const char* name, elfcpp::Elf_Word type,
 712                          elfcpp::Elf_Xword flags);
 713
 714   // Virtual function which may be overridden by the child class.
 715   virtual bool
 716   do_may_relax() const
 717   { return parameters->options().relax(); }
 718
 719   // Virtual function which may be overridden by the child class.
 720   virtual bool
 721   do_relax(int, const Input_objects*, Symbol_table*, Layout*, const Task*)
 722   { return false; }
 723
 724   // A function for targets to call.  Return whether BYTES/LEN matches
 725   // VIEW/VIEW_SIZE at OFFSET.
 726   bool
 727   match_view(const unsigned char* view, section_size_type view_size,
 728              section_offset_type offset, const char* bytes, size_t len) const;
 729
 730   // Set the contents of a VIEW/VIEW_SIZE to nops starting at OFFSET
 731   // for LEN bytes.
 732   void
 733   set_view_to_nop(unsigned char* view, section_size_type view_size,
 734                   section_offset_type offset, size_t len) const;
 735
 736   // This must be overridden by the child class if it has target-specific
 737   // attributes subsection in the attribute section.
 738   virtual int
 739   do_attribute_arg_type(int) const
 740   { gold_unreachable(); }
 741
 742   // This may be overridden by the child class.
 743   virtual int
 744   do_attributes_order(int num) const
 745   { return num; }
 746
 747   // This may be overridden by the child class.
 748   virtual void
 749   do_select_as_default_target()
 750   { }
 751
 752   // This may be overridden by the child class.
 753   virtual void
 754   do_define_standard_symbols(Symbol_table*, Layout*)
 755   { }
 756
 757   // This may be overridden by the child class.
 758   virtual const char*
 759   do_output_section_name(const Relobj*, const char*, size_t*) const
 760   { return NULL; }
 761
 762   // This may be overridden by the child class.
 763   virtual void
 764   do_gc_mark_symbol(Symbol_table*, Symbol*) const
 765   { }
 766
 767   // This may be overridden by the child class.
 768   virtual bool
 769   do_has_custom_set_dynsym_indexes() const
 770   { return false; }
 771
 772   // This may be overridden by the child class.
 773   virtual unsigned int
 774   do_set_dynsym_indexes(std::vector<Symbol*>*, unsigned int,
 775                         std::vector<Symbol*>*, Stringpool*, Versions*,
 776                         Symbol_table*) const
 777   { gold_unreachable(); }
 778
 779   // This may be overridden by the child class.
 780   virtual unsigned int
 781   do_dynamic_tag_custom_value(elfcpp::DT) const
 782   { gold_unreachable(); }
 783
 784   // This may be overridden by the child class.
 785   virtual void
 786   do_adjust_dyn_symbol(const Symbol*, unsigned char*) const
 787   { }
 788
 789   // This may be overridden by the child class.
 790   virtual bool
 791   do_should_include_section(elfcpp::Elf_Word) const
 792   { return true; }
 793
 794  private:
 795   // The implementations of the four do_make_elf_object virtual functions are
 796   // almost identical except for their sizes and endianness.  We use a template.
 797   // for their implementations.
 798   template<int size, bool big_endian>
 799   inline Object*
 800   do_make_elf_object_implementation(const std::string&, Input_file*, off_t,
 801                                     const elfcpp::Ehdr<size, big_endian>&);
 802
 803   Target(const Target&);
 804   Target& operator=(const Target&);
 805
 806   // The target information.
 807   const Target_info* pti_;
 808   // Processor-specific flags.
 809   elfcpp::Elf_Word processor_specific_flags_;
 810   // Whether the processor-specific flags are set at least once.
 811   bool are_processor_specific_flags_set_;
 812   // If not ELFOSABI_NONE, the value to put in the EI_OSABI field of
 813   // the ELF header.  This is handled at this level because it is
 814   // OS-specific rather than processor-specific.
 815   elfcpp::ELFOSABI osabi_;
 816 };
 817
 818 // The abstract class for a specific size and endianness of target.
 819 // Each actual target implementation class should derive from an
 820 // instantiation of Sized_target.
 821
 822 template<int size, bool big_endian>
 823 class Sized_target : public Target
 824 {
 825  public:
 826   // Make a new symbol table entry for the target.  This should be
 827   // overridden by a target which needs additional information in the
 828   // symbol table.  This will only be called if has_make_symbol()
 829   // returns true.
 830   virtual Sized_symbol<size>*
 831   make_symbol() const
 832   { gold_unreachable(); }
 833
 834   // Resolve a symbol for the target.  This should be overridden by a
 835   // target which needs to take special action.  TO is the
 836   // pre-existing symbol.  SYM is the new symbol, seen in OBJECT.
 837   // VERSION is the version of SYM.  This will only be called if
 838   // has_resolve() returns true.
 839   virtual void
 840   resolve(Symbol*, const elfcpp::Sym<size, big_endian>&, Object*,
 841           const char*)
 842   { gold_unreachable(); }
 843
 844   // Process the relocs for a section, and record information of the
 845   // mapping from source to destination sections. This mapping is later
 846   // used to determine unreferenced garbage sections. This procedure is
 847   // only called during garbage collection.
 848   virtual void
 849   gc_process_relocs(Symbol_table* symtab,
 850                     Layout* layout,
 851                     Sized_relobj_file<size, big_endian>* object,
 852                     unsigned int data_shndx,
 853                     unsigned int sh_type,
 854                     const unsigned char* prelocs,
 855                     size_t reloc_count,
 856                     Output_section* output_section,
 857                     bool needs_special_offset_handling,
 858                     size_t local_symbol_count,
 859                     const unsigned char* plocal_symbols) = 0;
 860
 861   // Scan the relocs for a section, and record any information
 862   // required for the symbol.  SYMTAB is the symbol table.  OBJECT is
 863   // the object in which the section appears.  DATA_SHNDX is the
 864   // section index that these relocs apply to.  SH_TYPE is the type of
 865   // the relocation section, SHT_REL or SHT_RELA.  PRELOCS points to
 866   // the relocation data.  RELOC_COUNT is the number of relocs.
 867   // LOCAL_SYMBOL_COUNT is the number of local symbols.
 868   // OUTPUT_SECTION is the output section.
 869   // NEEDS_SPECIAL_OFFSET_HANDLING is true if offsets to the output
 870   // sections are not mapped as usual.  PLOCAL_SYMBOLS points to the
 871   // local symbol data from OBJECT.  GLOBAL_SYMBOLS is the array of
 872   // pointers to the global symbol table from OBJECT.
 873   virtual void
 874   scan_relocs(Symbol_table* symtab,
 875               Layout* layout,
 876               Sized_relobj_file<size, big_endian>* object,
 877               unsigned int data_shndx,
 878               unsigned int sh_type,
 879               const unsigned char* prelocs,
 880               size_t reloc_count,
 881               Output_section* output_section,
 882               bool needs_special_offset_handling,
 883               size_t local_symbol_count,
 884               const unsigned char* plocal_symbols) = 0;
 885
 886   // Relocate section data.  SH_TYPE is the type of the relocation
 887   // section, SHT_REL or SHT_RELA.  PRELOCS points to the relocation
 888   // information.  RELOC_COUNT is the number of relocs.
 889   // OUTPUT_SECTION is the output section.
 890   // NEEDS_SPECIAL_OFFSET_HANDLING is true if offsets must be mapped
 891   // to correspond to the output section.  VIEW is a view into the
 892   // output file holding the section contents, VIEW_ADDRESS is the
 893   // virtual address of the view, and VIEW_SIZE is the size of the
 894   // view.  If NEEDS_SPECIAL_OFFSET_HANDLING is true, the VIEW_xx
 895   // parameters refer to the complete output section data, not just
 896   // the input section data.
 897   virtual void
 898   relocate_section(const Relocate_info<size, big_endian>*,
 899                    unsigned int sh_type,
 900                    const unsigned char* prelocs,
 901                    size_t reloc_count,
 902                    Output_section* output_section,
 903                    bool needs_special_offset_handling,
 904                    unsigned char* view,
 905                    typename elfcpp::Elf_types<size>::Elf_Addr view_address,
 906                    section_size_type view_size,
 907                    const Reloc_symbol_changes*) = 0;
 908
 909   // Scan the relocs during a relocatable link.  The parameters are
 910   // like scan_relocs, with an additional Relocatable_relocs
 911   // parameter, used to record the disposition of the relocs.
 912   virtual void
 913   scan_relocatable_relocs(Symbol_table* symtab,
 914                           Layout* layout,
 915                           Sized_relobj_file<size, big_endian>* object,
 916                           unsigned int data_shndx,
 917                           unsigned int sh_type,
 918                           const unsigned char* prelocs,
 919                           size_t reloc_count,
 920                           Output_section* output_section,
 921                           bool needs_special_offset_handling,
 922                           size_t local_symbol_count,
 923                           const unsigned char* plocal_symbols,
 924                           Relocatable_relocs*) = 0;
 925
 926   // Emit relocations for a section during a relocatable link, and for
 927   // --emit-relocs.  The parameters are like relocate_section, with
 928   // additional parameters for the view of the output reloc section.
 929   virtual void
 930   relocate_relocs(const Relocate_info<size, big_endian>*,
 931                   unsigned int sh_type,
 932                   const unsigned char* prelocs,
 933                   size_t reloc_count,
 934                   Output_section* output_section,
 935                   typename elfcpp::Elf_types<size>::Elf_Off
 936                     offset_in_output_section,
 937                   const Relocatable_relocs*,
 938                   unsigned char* view,
 939                   typename elfcpp::Elf_types<size>::Elf_Addr view_address,
 940                   section_size_type view_size,
 941                   unsigned char* reloc_view,
 942                   section_size_type reloc_view_size) = 0;
 943
 944   // Perform target-specific processing in a relocatable link.  This is
 945   // only used if we use the relocation strategy RELOC_SPECIAL.
 946   // RELINFO points to a Relocation_info structure. SH_TYPE is the relocation
 947   // section type. PRELOC_IN points to the original relocation.  RELNUM is
 948   // the index number of the relocation in the relocation section.
 949   // OUTPUT_SECTION is the output section to which the relocation is applied.
 950   // OFFSET_IN_OUTPUT_SECTION is the offset of the relocation input section
 951   // within the output section.  VIEW points to the output view of the
 952   // output section.  VIEW_ADDRESS is output address of the view.  VIEW_SIZE
 953   // is the size of the output view and PRELOC_OUT points to the new
 954   // relocation in the output object.
 955   //
 956   // A target only needs to override this if the generic code in
 957   // target-reloc.h cannot handle some relocation types.
 958
 959   virtual void
 960   relocate_special_relocatable(const Relocate_info<size, big_endian>*
 961                                 /*relinfo */,
 962                                unsigned int /* sh_type */,
 963                                const unsigned char* /* preloc_in */,
 964                                size_t /* relnum */,
 965                                Output_section* /* output_section */,
 966                                typename elfcpp::Elf_types<size>::Elf_Off
 967                                  /* offset_in_output_section */,
 968                                unsigned char* /* view */,
 969                                typename elfcpp::Elf_types<size>::Elf_Addr
 970                                  /* view_address */,
 971                                section_size_type /* view_size */,
 972                                unsigned char* /* preloc_out*/)
 973   { gold_unreachable(); }
 974
 975   // Return the number of entries in the GOT.  This is only used for
 976   // laying out the incremental link info sections.  A target needs
 977   // to implement this to support incremental linking.
 978
 979   virtual unsigned int
 980   got_entry_count() const
 981   { gold_unreachable(); }
 982
 983   // Return the number of entries in the PLT.  This is only used for
 984   // laying out the incremental link info sections.  A target needs
 985   // to implement this to support incremental linking.
 986
 987   virtual unsigned int
 988   plt_entry_count() const
 989   { gold_unreachable(); }
 990
 991   // Return the offset of the first non-reserved PLT entry.  This is
 992   // only used for laying out the incremental link info sections.
 993   // A target needs to implement this to support incremental linking.
 994
 995   virtual unsigned int
 996   first_plt_entry_offset() const
 997   { gold_unreachable(); }
 998
 999   // Return the size of each PLT entry.  This is only used for
1000   // laying out the incremental link info sections.  A target needs
1001   // to implement this to support incremental linking.
1002
1003   virtual unsigned int
1004   plt_entry_size() const
1005   { gold_unreachable(); }
1006
1007   // Return the size of each GOT entry.  This is only used for
1008   // laying out the incremental link info sections.  A target needs
1009   // to implement this if its GOT size is different.
1010
1011   virtual unsigned int
1012   got_entry_size() const
1013   { return size / 8; }
1014
1015   // Create the GOT and PLT sections for an incremental update.
1016   // A target needs to implement this to support incremental linking.
1017
1018   virtual Output_data_got_base*
1019   init_got_plt_for_update(Symbol_table*,
1020                           Layout*,
1021                           unsigned int /* got_count */,
1022                           unsigned int /* plt_count */)
1023   { gold_unreachable(); }
1024
1025   // Reserve a GOT entry for a local symbol, and regenerate any
1026   // necessary dynamic relocations.
1027   virtual void
1028   reserve_local_got_entry(unsigned int /* got_index */,
1029                           Sized_relobj<size, big_endian>* /* obj */,
1030                           unsigned int /* r_sym */,
1031                           unsigned int /* got_type */)
1032   { gold_unreachable(); }
1033
1034   // Reserve a GOT entry for a global symbol, and regenerate any
1035   // necessary dynamic relocations.
1036   virtual void
1037   reserve_global_got_entry(unsigned int /* got_index */, Symbol* /* gsym */,
1038                            unsigned int /* got_type */)
1039   { gold_unreachable(); }
1040
1041   // Register an existing PLT entry for a global symbol.
1042   // A target needs to implement this to support incremental linking.
1043
1044   virtual void
1045   register_global_plt_entry(Symbol_table*, Layout*,
1046                             unsigned int /* plt_index */,
1047                             Symbol*)
1048   { gold_unreachable(); }
1049
1050   // Force a COPY relocation for a given symbol.
1051   // A target needs to implement this to support incremental linking.
1052
1053   virtual void
1054   emit_copy_reloc(Symbol_table*, Symbol*, Output_section*, off_t)
1055   { gold_unreachable(); }
1056
1057   // Apply an incremental relocation.
1058
1059   virtual void
1060   apply_relocation(const Relocate_info<size, big_endian>* /* relinfo */,
1061                    typename elfcpp::Elf_types<size>::Elf_Addr /* r_offset */,
1062                    unsigned int /* r_type */,
1063                    typename elfcpp::Elf_types<size>::Elf_Swxword /* r_addend */,
1064                    const Symbol* /* gsym */,
1065                    unsigned char* /* view */,
1066                    typename elfcpp::Elf_types<size>::Elf_Addr /* address */,
1067                    section_size_type /* view_size */)
1068   { gold_unreachable(); }
1069
1070   // Handle target specific gc actions when adding a gc reference from
1071   // SRC_OBJ, SRC_SHNDX to a location specified by DST_OBJ, DST_SHNDX
1072   // and DST_OFF.
1073   void
1074   gc_add_reference(Symbol_table* symtab,
1075                    Relobj* src_obj,
1076                    unsigned int src_shndx,
1077                    Relobj* dst_obj,
1078                    unsigned int dst_shndx,
1079                    typename elfcpp::Elf_types<size>::Elf_Addr dst_off) const
1080   {
1081     this->do_gc_add_reference(symtab, src_obj, src_shndx,
1082                               dst_obj, dst_shndx, dst_off);
1083   }
1084
1085  protected:
1086   Sized_target(const Target::Target_info* pti)
1087     : Target(pti)
1088   {
1089     gold_assert(pti->size == size);
1090     gold_assert(pti->is_big_endian ? big_endian : !big_endian);
1091   }
1092
1093   // Set the EI_OSABI field if requested.
1094   virtual void
1095   do_adjust_elf_header(unsigned char*, int);
1096
1097   // Handle target specific gc actions when adding a gc reference.
1098   virtual void
1099   do_gc_add_reference(Symbol_table*, Relobj*, unsigned int,
1100                       Relobj*, unsigned int,
1101                       typename elfcpp::Elf_types<size>::Elf_Addr) const
1102   { }
1103
1104   virtual void
1105   do_function_location(Symbol_location*) const
1106   { }
1107 };
1108
1109 } // End namespace gold.
1110
1111 #endif // !defined(GOLD_TARGET_H)