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