Allow target to add custom dynamic table entries.
[platform/upstream/binutils.git] / gold / target.h
1 // target.h -- target support for gold   -*- C++ -*-
2
3 // Copyright (C) 2006-2014 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   // Whether the target has a custom set_dynsym_indexes method.
459   bool
460   has_custom_set_dynsym_indexes() const
461   { return this->do_has_custom_set_dynsym_indexes(); }
462
463   // Custom set_dynsym_indexes method for a target.
464   unsigned int
465   set_dynsym_indexes(std::vector<Symbol*>* dyn_symbols, unsigned int index,
466                      std::vector<Symbol*>* syms, Stringpool* dynpool,
467                      Versions* versions, Symbol_table* symtab) const
468   {
469     return this->do_set_dynsym_indexes(dyn_symbols, index, syms, dynpool,
470                                        versions, symtab);
471   }
472
473   // Get the custom dynamic tag value.
474   unsigned int
475   dynamic_tag_custom_value(elfcpp::DT tag) const
476   { return this->do_dynamic_tag_custom_value(tag); }
477
478  protected:
479   // This struct holds the constant information for a child class.  We
480   // use a struct to avoid the overhead of virtual function calls for
481   // simple information.
482   struct Target_info
483   {
484     // Address size (32 or 64).
485     int size;
486     // Whether the target is big endian.
487     bool is_big_endian;
488     // The code to store in the e_machine field of the ELF header.
489     elfcpp::EM machine_code;
490     // Whether this target has a specific make_symbol function.
491     bool has_make_symbol;
492     // Whether this target has a specific resolve function.
493     bool has_resolve;
494     // Whether this target has a specific code fill function.
495     bool has_code_fill;
496     // Whether an object file with no .note.GNU-stack sections implies
497     // that the stack should be executable.
498     bool is_default_stack_executable;
499     // Whether a relocation to a merged section can be processed to
500     // retrieve the contents.
501     bool can_icf_inline_merge_sections;
502     // Prefix character to strip when checking for wrapping.
503     char wrap_char;
504     // The default dynamic linker name.
505     const char* dynamic_linker;
506     // The default text segment address.
507     uint64_t default_text_segment_address;
508     // The ABI specified page size.
509     uint64_t abi_pagesize;
510     // The common page size used by actual implementations.
511     uint64_t common_pagesize;
512     // Whether PF_X segments must contain nothing but the contents of
513     // SHF_EXECINSTR sections (no non-executable data, no headers).
514     bool isolate_execinstr;
515     // If nonzero, distance from the text segment to the read-only segment.
516     uint64_t rosegment_gap;
517     // The special section index for small common symbols; SHN_UNDEF
518     // if none.
519     elfcpp::Elf_Half small_common_shndx;
520     // The special section index for large common symbols; SHN_UNDEF
521     // if none.
522     elfcpp::Elf_Half large_common_shndx;
523     // Section flags for small common section.
524     elfcpp::Elf_Xword small_common_section_flags;
525     // Section flags for large common section.
526     elfcpp::Elf_Xword large_common_section_flags;
527     // Name of attributes section if it is not ".gnu.attributes".
528     const char* attributes_section;
529     // Vendor name of vendor attributes.
530     const char* attributes_vendor;
531     // Name of the main entry point to the program.
532     const char* entry_symbol_name;
533   };
534
535   Target(const Target_info* pti)
536     : pti_(pti), processor_specific_flags_(0),
537       are_processor_specific_flags_set_(false), osabi_(elfcpp::ELFOSABI_NONE)
538   { }
539
540   // Virtual function which may be implemented by the child class.
541   virtual void
542   do_new_output_section(Output_section*) const
543   { }
544
545   // Virtual function which may be implemented by the child class.
546   virtual void
547   do_finalize_sections(Layout*, const Input_objects*, Symbol_table*)
548   { }
549
550   // Virtual function which may be implemented by the child class.
551   virtual uint64_t
552   do_dynsym_value(const Symbol*) const
553   { gold_unreachable(); }
554
555   // Virtual function which must be implemented by the child class if
556   // needed.
557   virtual std::string
558   do_code_fill(section_size_type) const
559   { gold_unreachable(); }
560
561   // Virtual function which may be implemented by the child class.
562   virtual bool
563   do_is_defined_by_abi(const Symbol*) const
564   { return false; }
565
566   // Adjust the output file header before it is written out.  VIEW
567   // points to the header in external form.  LEN is the length, and
568   // will be one of the values of elfcpp::Elf_sizes<size>::ehdr_size.
569   // By default, we set the EI_OSABI field if requested (in
570   // Sized_target).
571   virtual void
572   do_adjust_elf_header(unsigned char*, int) = 0;
573
574   // Return address and size to plug into eh_frame FDEs associated with a PLT.
575   virtual void
576   do_plt_fde_location(const Output_data* plt, unsigned char* oview,
577                       uint64_t* address, off_t* len) const;
578
579   // Virtual function which may be overridden by the child class.
580   virtual bool
581   do_is_local_label_name(const char*) const;
582
583   // Virtual function that must be overridden by a target which uses
584   // target specific relocations.
585   virtual unsigned int
586   do_reloc_symbol_index(void*, unsigned int) const
587   { gold_unreachable(); }
588
589   // Virtual function that must be overridden by a target which uses
590   // target specific relocations.
591   virtual uint64_t
592   do_reloc_addend(void*, unsigned int, uint64_t) const
593   { gold_unreachable(); }
594
595   // Virtual functions that must be overridden by a target that uses
596   // STT_GNU_IFUNC symbols.
597   virtual uint64_t
598   do_plt_address_for_global(const Symbol*) const
599   { gold_unreachable(); }
600
601   virtual uint64_t
602   do_plt_address_for_local(const Relobj*, unsigned int) const
603   { gold_unreachable(); }
604
605   virtual int64_t
606   do_tls_offset_for_local(const Relobj*, unsigned int, unsigned int) const
607   { gold_unreachable(); }
608
609   virtual int64_t
610   do_tls_offset_for_global(Symbol*, unsigned int) const
611   { gold_unreachable(); }
612
613   virtual void
614   do_function_location(Symbol_location*) const = 0;
615
616   // Virtual function which may be overriden by the child class.
617   virtual bool
618   do_can_check_for_function_pointers() const
619   { return false; }
620
621   // Virtual function which may be overridden by the child class.  We
622   // recognize some default sections for which we don't care whether
623   // they have function pointers.
624   virtual bool
625   do_section_may_have_icf_unsafe_pointers(const char* section_name) const
626   {
627     // We recognize sections for normal vtables, construction vtables and
628     // EH frames.
629     return (!is_prefix_of(".rodata._ZTV", section_name)
630             && !is_prefix_of(".data.rel.ro._ZTV", section_name)
631             && !is_prefix_of(".rodata._ZTC", section_name)
632             && !is_prefix_of(".data.rel.ro._ZTC", section_name)
633             && !is_prefix_of(".eh_frame", section_name));
634   }
635
636   virtual uint64_t
637   do_ehframe_datarel_base() const
638   { gold_unreachable(); }
639
640   // Virtual function which may be overridden by the child class.  The
641   // default implementation is that any function not defined by the
642   // ABI is a call to a non-split function.
643   virtual bool
644   do_is_call_to_non_split(const Symbol* sym, unsigned int) const;
645
646   // Virtual function which may be overridden by the child class.
647   virtual void
648   do_calls_non_split(Relobj* object, unsigned int, section_offset_type,
649                      section_size_type, unsigned char*, section_size_type,
650                      std::string*, std::string*) const;
651
652   // make_elf_object hooks.  There are four versions of these for
653   // different address sizes and endianness.
654
655   // Set processor specific flags.
656   void
657   set_processor_specific_flags(elfcpp::Elf_Word flags)
658   {
659     this->processor_specific_flags_ = flags;
660     this->are_processor_specific_flags_set_ = true;
661   }
662
663 #ifdef HAVE_TARGET_32_LITTLE
664   // Virtual functions which may be overridden by the child class.
665   virtual Object*
666   do_make_elf_object(const std::string&, Input_file*, off_t,
667                      const elfcpp::Ehdr<32, false>&);
668 #endif
669
670 #ifdef HAVE_TARGET_32_BIG
671   // Virtual functions which may be overridden by the child class.
672   virtual Object*
673   do_make_elf_object(const std::string&, Input_file*, off_t,
674                      const elfcpp::Ehdr<32, true>&);
675 #endif
676
677 #ifdef HAVE_TARGET_64_LITTLE
678   // Virtual functions which may be overridden by the child class.
679   virtual Object*
680   do_make_elf_object(const std::string&, Input_file*, off_t,
681                      const elfcpp::Ehdr<64, false>& ehdr);
682 #endif
683
684 #ifdef HAVE_TARGET_64_BIG
685   // Virtual functions which may be overridden by the child class.
686   virtual Object*
687   do_make_elf_object(const std::string& name, Input_file* input_file,
688                      off_t offset, const elfcpp::Ehdr<64, true>& ehdr);
689 #endif
690
691   // Virtual functions which may be overridden by the child class.
692   virtual Output_section*
693   do_make_output_section(const char* name, elfcpp::Elf_Word type,
694                          elfcpp::Elf_Xword flags);
695
696   // Virtual function which may be overridden by the child class.
697   virtual bool
698   do_may_relax() const
699   { return parameters->options().relax(); }
700
701   // Virtual function which may be overridden by the child class.
702   virtual bool
703   do_relax(int, const Input_objects*, Symbol_table*, Layout*, const Task*)
704   { return false; }
705
706   // A function for targets to call.  Return whether BYTES/LEN matches
707   // VIEW/VIEW_SIZE at OFFSET.
708   bool
709   match_view(const unsigned char* view, section_size_type view_size,
710              section_offset_type offset, const char* bytes, size_t len) const;
711
712   // Set the contents of a VIEW/VIEW_SIZE to nops starting at OFFSET
713   // for LEN bytes.
714   void
715   set_view_to_nop(unsigned char* view, section_size_type view_size,
716                   section_offset_type offset, size_t len) const;
717
718   // This must be overridden by the child class if it has target-specific
719   // attributes subsection in the attribute section.
720   virtual int
721   do_attribute_arg_type(int) const
722   { gold_unreachable(); }
723
724   // This may be overridden by the child class.
725   virtual int
726   do_attributes_order(int num) const
727   { return num; }
728
729   // This may be overridden by the child class.
730   virtual void
731   do_select_as_default_target()
732   { }
733
734   // This may be overridden by the child class.
735   virtual void
736   do_define_standard_symbols(Symbol_table*, Layout*)
737   { }
738
739   // This may be overridden by the child class.
740   virtual const char*
741   do_output_section_name(const Relobj*, const char*, size_t*) const
742   { return NULL; }
743
744   // This may be overridden by the child class.
745   virtual void
746   do_gc_mark_symbol(Symbol_table*, Symbol*) const
747   { }
748
749   // This may be overridden by the child class.
750   virtual bool
751   do_has_custom_set_dynsym_indexes() const
752   { return false; }
753
754   // This may be overridden by the child class.
755   virtual unsigned int
756   do_set_dynsym_indexes(std::vector<Symbol*>*, unsigned int,
757                         std::vector<Symbol*>*, Stringpool*, Versions*,
758                         Symbol_table*) const
759   { gold_unreachable(); }
760
761   // This may be overridden by the child class.
762   virtual unsigned int
763   do_dynamic_tag_custom_value(elfcpp::DT) const
764   { gold_unreachable(); }
765
766  private:
767   // The implementations of the four do_make_elf_object virtual functions are
768   // almost identical except for their sizes and endianness.  We use a template.
769   // for their implementations.
770   template<int size, bool big_endian>
771   inline Object*
772   do_make_elf_object_implementation(const std::string&, Input_file*, off_t,
773                                     const elfcpp::Ehdr<size, big_endian>&);
774
775   Target(const Target&);
776   Target& operator=(const Target&);
777
778   // The target information.
779   const Target_info* pti_;
780   // Processor-specific flags.
781   elfcpp::Elf_Word processor_specific_flags_;
782   // Whether the processor-specific flags are set at least once.
783   bool are_processor_specific_flags_set_;
784   // If not ELFOSABI_NONE, the value to put in the EI_OSABI field of
785   // the ELF header.  This is handled at this level because it is
786   // OS-specific rather than processor-specific.
787   elfcpp::ELFOSABI osabi_;
788 };
789
790 // The abstract class for a specific size and endianness of target.
791 // Each actual target implementation class should derive from an
792 // instantiation of Sized_target.
793
794 template<int size, bool big_endian>
795 class Sized_target : public Target
796 {
797  public:
798   // Make a new symbol table entry for the target.  This should be
799   // overridden by a target which needs additional information in the
800   // symbol table.  This will only be called if has_make_symbol()
801   // returns true.
802   virtual Sized_symbol<size>*
803   make_symbol() const
804   { gold_unreachable(); }
805
806   // Resolve a symbol for the target.  This should be overridden by a
807   // target which needs to take special action.  TO is the
808   // pre-existing symbol.  SYM is the new symbol, seen in OBJECT.
809   // VERSION is the version of SYM.  This will only be called if
810   // has_resolve() returns true.
811   virtual void
812   resolve(Symbol*, const elfcpp::Sym<size, big_endian>&, Object*,
813           const char*)
814   { gold_unreachable(); }
815
816   // Process the relocs for a section, and record information of the
817   // mapping from source to destination sections. This mapping is later
818   // used to determine unreferenced garbage sections. This procedure is
819   // only called during garbage collection.
820   virtual void
821   gc_process_relocs(Symbol_table* symtab,
822                     Layout* layout,
823                     Sized_relobj_file<size, big_endian>* object,
824                     unsigned int data_shndx,
825                     unsigned int sh_type,
826                     const unsigned char* prelocs,
827                     size_t reloc_count,
828                     Output_section* output_section,
829                     bool needs_special_offset_handling,
830                     size_t local_symbol_count,
831                     const unsigned char* plocal_symbols) = 0;
832
833   // Scan the relocs for a section, and record any information
834   // required for the symbol.  SYMTAB is the symbol table.  OBJECT is
835   // the object in which the section appears.  DATA_SHNDX is the
836   // section index that these relocs apply to.  SH_TYPE is the type of
837   // the relocation section, SHT_REL or SHT_RELA.  PRELOCS points to
838   // the relocation data.  RELOC_COUNT is the number of relocs.
839   // LOCAL_SYMBOL_COUNT is the number of local symbols.
840   // OUTPUT_SECTION is the output section.
841   // NEEDS_SPECIAL_OFFSET_HANDLING is true if offsets to the output
842   // sections are not mapped as usual.  PLOCAL_SYMBOLS points to the
843   // local symbol data from OBJECT.  GLOBAL_SYMBOLS is the array of
844   // pointers to the global symbol table from OBJECT.
845   virtual void
846   scan_relocs(Symbol_table* symtab,
847               Layout* layout,
848               Sized_relobj_file<size, big_endian>* object,
849               unsigned int data_shndx,
850               unsigned int sh_type,
851               const unsigned char* prelocs,
852               size_t reloc_count,
853               Output_section* output_section,
854               bool needs_special_offset_handling,
855               size_t local_symbol_count,
856               const unsigned char* plocal_symbols) = 0;
857
858   // Relocate section data.  SH_TYPE is the type of the relocation
859   // section, SHT_REL or SHT_RELA.  PRELOCS points to the relocation
860   // information.  RELOC_COUNT is the number of relocs.
861   // OUTPUT_SECTION is the output section.
862   // NEEDS_SPECIAL_OFFSET_HANDLING is true if offsets must be mapped
863   // to correspond to the output section.  VIEW is a view into the
864   // output file holding the section contents, VIEW_ADDRESS is the
865   // virtual address of the view, and VIEW_SIZE is the size of the
866   // view.  If NEEDS_SPECIAL_OFFSET_HANDLING is true, the VIEW_xx
867   // parameters refer to the complete output section data, not just
868   // the input section data.
869   virtual void
870   relocate_section(const Relocate_info<size, big_endian>*,
871                    unsigned int sh_type,
872                    const unsigned char* prelocs,
873                    size_t reloc_count,
874                    Output_section* output_section,
875                    bool needs_special_offset_handling,
876                    unsigned char* view,
877                    typename elfcpp::Elf_types<size>::Elf_Addr view_address,
878                    section_size_type view_size,
879                    const Reloc_symbol_changes*) = 0;
880
881   // Scan the relocs during a relocatable link.  The parameters are
882   // like scan_relocs, with an additional Relocatable_relocs
883   // parameter, used to record the disposition of the relocs.
884   virtual void
885   scan_relocatable_relocs(Symbol_table* symtab,
886                           Layout* layout,
887                           Sized_relobj_file<size, big_endian>* object,
888                           unsigned int data_shndx,
889                           unsigned int sh_type,
890                           const unsigned char* prelocs,
891                           size_t reloc_count,
892                           Output_section* output_section,
893                           bool needs_special_offset_handling,
894                           size_t local_symbol_count,
895                           const unsigned char* plocal_symbols,
896                           Relocatable_relocs*) = 0;
897
898   // Emit relocations for a section during a relocatable link, and for
899   // --emit-relocs.  The parameters are like relocate_section, with
900   // additional parameters for the view of the output reloc section.
901   virtual void
902   relocate_relocs(const Relocate_info<size, big_endian>*,
903                   unsigned int sh_type,
904                   const unsigned char* prelocs,
905                   size_t reloc_count,
906                   Output_section* output_section,
907                   typename elfcpp::Elf_types<size>::Elf_Off
908                     offset_in_output_section,
909                   const Relocatable_relocs*,
910                   unsigned char* view,
911                   typename elfcpp::Elf_types<size>::Elf_Addr view_address,
912                   section_size_type view_size,
913                   unsigned char* reloc_view,
914                   section_size_type reloc_view_size) = 0;
915
916   // Perform target-specific processing in a relocatable link.  This is
917   // only used if we use the relocation strategy RELOC_SPECIAL.
918   // RELINFO points to a Relocation_info structure. SH_TYPE is the relocation
919   // section type. PRELOC_IN points to the original relocation.  RELNUM is
920   // the index number of the relocation in the relocation section.
921   // OUTPUT_SECTION is the output section to which the relocation is applied.
922   // OFFSET_IN_OUTPUT_SECTION is the offset of the relocation input section
923   // within the output section.  VIEW points to the output view of the
924   // output section.  VIEW_ADDRESS is output address of the view.  VIEW_SIZE
925   // is the size of the output view and PRELOC_OUT points to the new
926   // relocation in the output object.
927   //
928   // A target only needs to override this if the generic code in
929   // target-reloc.h cannot handle some relocation types.
930
931   virtual void
932   relocate_special_relocatable(const Relocate_info<size, big_endian>*
933                                 /*relinfo */,
934                                unsigned int /* sh_type */,
935                                const unsigned char* /* preloc_in */,
936                                size_t /* relnum */,
937                                Output_section* /* output_section */,
938                                typename elfcpp::Elf_types<size>::Elf_Off
939                                  /* offset_in_output_section */,
940                                unsigned char* /* view */,
941                                typename elfcpp::Elf_types<size>::Elf_Addr
942                                  /* view_address */,
943                                section_size_type /* view_size */,
944                                unsigned char* /* preloc_out*/)
945   { gold_unreachable(); }
946
947   // Return the number of entries in the GOT.  This is only used for
948   // laying out the incremental link info sections.  A target needs
949   // to implement this to support incremental linking.
950
951   virtual unsigned int
952   got_entry_count() const
953   { gold_unreachable(); }
954
955   // Return the number of entries in the PLT.  This is only used for
956   // laying out the incremental link info sections.  A target needs
957   // to implement this to support incremental linking.
958
959   virtual unsigned int
960   plt_entry_count() const
961   { gold_unreachable(); }
962
963   // Return the offset of the first non-reserved PLT entry.  This is
964   // only used for laying out the incremental link info sections.
965   // A target needs to implement this to support incremental linking.
966
967   virtual unsigned int
968   first_plt_entry_offset() const
969   { gold_unreachable(); }
970
971   // Return the size of each PLT entry.  This is only used for
972   // laying out the incremental link info sections.  A target needs
973   // to implement this to support incremental linking.
974
975   virtual unsigned int
976   plt_entry_size() const
977   { gold_unreachable(); }
978
979   // Create the GOT and PLT sections for an incremental update.
980   // A target needs to implement this to support incremental linking.
981
982   virtual Output_data_got_base*
983   init_got_plt_for_update(Symbol_table*,
984                           Layout*,
985                           unsigned int /* got_count */,
986                           unsigned int /* plt_count */)
987   { gold_unreachable(); }
988
989   // Reserve a GOT entry for a local symbol, and regenerate any
990   // necessary dynamic relocations.
991   virtual void
992   reserve_local_got_entry(unsigned int /* got_index */,
993                           Sized_relobj<size, big_endian>* /* obj */,
994                           unsigned int /* r_sym */,
995                           unsigned int /* got_type */)
996   { gold_unreachable(); }
997
998   // Reserve a GOT entry for a global symbol, and regenerate any
999   // necessary dynamic relocations.
1000   virtual void
1001   reserve_global_got_entry(unsigned int /* got_index */, Symbol* /* gsym */,
1002                            unsigned int /* got_type */)
1003   { gold_unreachable(); }
1004
1005   // Register an existing PLT entry for a global symbol.
1006   // A target needs to implement this to support incremental linking.
1007
1008   virtual void
1009   register_global_plt_entry(Symbol_table*, Layout*,
1010                             unsigned int /* plt_index */,
1011                             Symbol*)
1012   { gold_unreachable(); }
1013
1014   // Force a COPY relocation for a given symbol.
1015   // A target needs to implement this to support incremental linking.
1016
1017   virtual void
1018   emit_copy_reloc(Symbol_table*, Symbol*, Output_section*, off_t)
1019   { gold_unreachable(); }
1020
1021   // Apply an incremental relocation.
1022
1023   virtual void
1024   apply_relocation(const Relocate_info<size, big_endian>* /* relinfo */,
1025                    typename elfcpp::Elf_types<size>::Elf_Addr /* r_offset */,
1026                    unsigned int /* r_type */,
1027                    typename elfcpp::Elf_types<size>::Elf_Swxword /* r_addend */,
1028                    const Symbol* /* gsym */,
1029                    unsigned char* /* view */,
1030                    typename elfcpp::Elf_types<size>::Elf_Addr /* address */,
1031                    section_size_type /* view_size */)
1032   { gold_unreachable(); }
1033
1034   // Handle target specific gc actions when adding a gc reference from
1035   // SRC_OBJ, SRC_SHNDX to a location specified by DST_OBJ, DST_SHNDX
1036   // and DST_OFF.
1037   void
1038   gc_add_reference(Symbol_table* symtab,
1039                    Object* src_obj,
1040                    unsigned int src_shndx,
1041                    Object* dst_obj,
1042                    unsigned int dst_shndx,
1043                    typename elfcpp::Elf_types<size>::Elf_Addr dst_off) const
1044   {
1045     this->do_gc_add_reference(symtab, src_obj, src_shndx,
1046                               dst_obj, dst_shndx, dst_off);
1047   }
1048
1049  protected:
1050   Sized_target(const Target::Target_info* pti)
1051     : Target(pti)
1052   {
1053     gold_assert(pti->size == size);
1054     gold_assert(pti->is_big_endian ? big_endian : !big_endian);
1055   }
1056
1057   // Set the EI_OSABI field if requested.
1058   virtual void
1059   do_adjust_elf_header(unsigned char*, int);
1060
1061   // Handle target specific gc actions when adding a gc reference.
1062   virtual void
1063   do_gc_add_reference(Symbol_table*, Object*, unsigned int,
1064                       Object*, unsigned int,
1065                       typename elfcpp::Elf_types<size>::Elf_Addr) const
1066   { }
1067
1068   virtual void
1069   do_function_location(Symbol_location*) const
1070   { }
1071 };
1072
1073 } // End namespace gold.
1074
1075 #endif // !defined(GOLD_TARGET_H)