Upload Tizen:Base source
[external/binutils.git] / gold / object.h
1 // object.h -- support for an object file for linking in gold  -*- C++ -*-
2
3 // Copyright 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
5
6 // This file is part of gold.
7
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
12
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
22
23 #ifndef GOLD_OBJECT_H
24 #define GOLD_OBJECT_H
25
26 #include <string>
27 #include <vector>
28
29 #include "elfcpp.h"
30 #include "elfcpp_file.h"
31 #include "fileread.h"
32 #include "target.h"
33 #include "archive.h"
34
35 namespace gold
36 {
37
38 class General_options;
39 class Task;
40 class Cref;
41 class Layout;
42 class Output_data;
43 class Output_section;
44 class Output_file;
45 class Output_symtab_xindex;
46 class Pluginobj;
47 class Dynobj;
48 class Object_merge_map;
49 class Relocatable_relocs;
50 class Symbols_data;
51
52 template<typename Stringpool_char>
53 class Stringpool_template;
54
55 // Data to pass from read_symbols() to add_symbols().
56
57 struct Read_symbols_data
58 {
59   Read_symbols_data()
60     : section_headers(NULL), section_names(NULL), symbols(NULL),
61       symbol_names(NULL), versym(NULL), verdef(NULL), verneed(NULL)
62   { }
63
64   ~Read_symbols_data();
65
66   // Section headers.
67   File_view* section_headers;
68   // Section names.
69   File_view* section_names;
70   // Size of section name data in bytes.
71   section_size_type section_names_size;
72   // Symbol data.
73   File_view* symbols;
74   // Size of symbol data in bytes.
75   section_size_type symbols_size;
76   // Offset of external symbols within symbol data.  This structure
77   // sometimes contains only external symbols, in which case this will
78   // be zero.  Sometimes it contains all symbols.
79   section_offset_type external_symbols_offset;
80   // Symbol names.
81   File_view* symbol_names;
82   // Size of symbol name data in bytes.
83   section_size_type symbol_names_size;
84
85   // Version information.  This is only used on dynamic objects.
86   // Version symbol data (from SHT_GNU_versym section).
87   File_view* versym;
88   section_size_type versym_size;
89   // Version definition data (from SHT_GNU_verdef section).
90   File_view* verdef;
91   section_size_type verdef_size;
92   unsigned int verdef_info;
93   // Needed version data  (from SHT_GNU_verneed section).
94   File_view* verneed;
95   section_size_type verneed_size;
96   unsigned int verneed_info;
97 };
98
99 // Information used to print error messages.
100
101 struct Symbol_location_info
102 {
103   std::string source_file;
104   std::string enclosing_symbol_name;
105   int line_number;
106 };
107
108 // Data about a single relocation section.  This is read in
109 // read_relocs and processed in scan_relocs.
110
111 struct Section_relocs
112 {
113   Section_relocs()
114     : contents(NULL)
115   { }
116
117   ~Section_relocs()
118   { delete this->contents; }
119
120   // Index of reloc section.
121   unsigned int reloc_shndx;
122   // Index of section that relocs apply to.
123   unsigned int data_shndx;
124   // Contents of reloc section.
125   File_view* contents;
126   // Reloc section type.
127   unsigned int sh_type;
128   // Number of reloc entries.
129   size_t reloc_count;
130   // Output section.
131   Output_section* output_section;
132   // Whether this section has special handling for offsets.
133   bool needs_special_offset_handling;
134   // Whether the data section is allocated (has the SHF_ALLOC flag set).
135   bool is_data_section_allocated;
136 };
137
138 // Relocations in an object file.  This is read in read_relocs and
139 // processed in scan_relocs.
140
141 struct Read_relocs_data
142 {
143   Read_relocs_data()
144     : local_symbols(NULL)
145   { }
146
147   ~Read_relocs_data()
148   { delete this->local_symbols; }
149
150   typedef std::vector<Section_relocs> Relocs_list;
151   // The relocations.
152   Relocs_list relocs;
153   // The local symbols.
154   File_view* local_symbols;
155 };
156
157 // The Xindex class manages section indexes for objects with more than
158 // 0xff00 sections.
159
160 class Xindex
161 {
162  public:
163   Xindex(int large_shndx_offset)
164     : large_shndx_offset_(large_shndx_offset), symtab_xindex_()
165   { }
166
167   // Initialize the symtab_xindex_ array, given the object and the
168   // section index of the symbol table to use.
169   template<int size, bool big_endian>
170   void
171   initialize_symtab_xindex(Object*, unsigned int symtab_shndx);
172
173   // Read in the symtab_xindex_ array, given its section index.
174   // PSHDRS may optionally point to the section headers.
175   template<int size, bool big_endian>
176   void
177   read_symtab_xindex(Object*, unsigned int xindex_shndx,
178                      const unsigned char* pshdrs);
179
180   // Symbol SYMNDX in OBJECT has a section of SHN_XINDEX; return the
181   // real section index.
182   unsigned int
183   sym_xindex_to_shndx(Object* object, unsigned int symndx);
184
185  private:
186   // The type of the array giving the real section index for symbols
187   // whose st_shndx field holds SHN_XINDEX.
188   typedef std::vector<unsigned int> Symtab_xindex;
189
190   // Adjust a section index if necessary.  This should only be called
191   // for ordinary section indexes.
192   unsigned int
193   adjust_shndx(unsigned int shndx)
194   {
195     if (shndx >= elfcpp::SHN_LORESERVE)
196       shndx += this->large_shndx_offset_;
197     return shndx;
198   }
199
200   // Adjust to apply to large section indexes.
201   int large_shndx_offset_;
202   // The data from the SHT_SYMTAB_SHNDX section.
203   Symtab_xindex symtab_xindex_;
204 };
205
206 // A GOT offset list.  A symbol may have more than one GOT offset
207 // (e.g., when mixing modules compiled with two different TLS models),
208 // but will usually have at most one.  GOT_TYPE identifies the type of
209 // GOT entry; its values are specific to each target.
210
211 class Got_offset_list
212 {
213  public:
214   Got_offset_list()
215     : got_type_(-1U), got_offset_(0), got_next_(NULL)
216   { }
217
218   Got_offset_list(unsigned int got_type, unsigned int got_offset)
219     : got_type_(got_type), got_offset_(got_offset), got_next_(NULL)
220   { }
221
222   ~Got_offset_list()
223   {
224     if (this->got_next_ != NULL)
225       {
226         delete this->got_next_;
227         this->got_next_ = NULL;
228       }
229   }
230
231   // Initialize the fields to their default values.
232   void
233   init()
234   {
235     this->got_type_ = -1U;
236     this->got_offset_ = 0;
237     this->got_next_ = NULL;
238   }
239
240   // Set the offset for the GOT entry of type GOT_TYPE.
241   void
242   set_offset(unsigned int got_type, unsigned int got_offset)
243   {
244     if (this->got_type_ == -1U)
245       {
246         this->got_type_ = got_type;
247         this->got_offset_ = got_offset;
248       }
249     else
250       {
251         for (Got_offset_list* g = this; g != NULL; g = g->got_next_)
252           {
253             if (g->got_type_ == got_type)
254               {
255                 g->got_offset_ = got_offset;
256                 return;
257               }
258           }
259         Got_offset_list* g = new Got_offset_list(got_type, got_offset);
260         g->got_next_ = this->got_next_;
261         this->got_next_ = g;
262       }
263   }
264
265   // Return the offset for a GOT entry of type GOT_TYPE.
266   unsigned int
267   get_offset(unsigned int got_type) const
268   {
269     for (const Got_offset_list* g = this; g != NULL; g = g->got_next_)
270       {
271         if (g->got_type_ == got_type)
272           return g->got_offset_;
273       }
274     return -1U;
275   }
276
277   // Return a pointer to the list, or NULL if the list is empty.
278   const Got_offset_list*
279   get_list() const
280   {
281     if (this->got_type_ == -1U)
282       return NULL;
283     return this;
284   }
285
286   // Abstract visitor class for iterating over GOT offsets.
287   class Visitor
288   {
289    public:
290     Visitor()
291     { }
292
293     virtual
294     ~Visitor()
295     { }
296
297     virtual void
298     visit(unsigned int, unsigned int) = 0;
299   };
300
301   // Loop over all GOT offset entries, calling a visitor class V for each.
302   void
303   for_all_got_offsets(Visitor* v) const
304   {
305     if (this->got_type_ == -1U)
306       return;
307     for (const Got_offset_list* g = this; g != NULL; g = g->got_next_)
308       v->visit(g->got_type_, g->got_offset_);
309   }
310
311  private:
312   unsigned int got_type_;
313   unsigned int got_offset_;
314   Got_offset_list* got_next_;
315 };
316
317 // Object is an abstract base class which represents either a 32-bit
318 // or a 64-bit input object.  This can be a regular object file
319 // (ET_REL) or a shared object (ET_DYN).
320
321 class Object
322 {
323  public:
324   typedef std::vector<Symbol*> Symbols;
325
326   // NAME is the name of the object as we would report it to the user
327   // (e.g., libfoo.a(bar.o) if this is in an archive.  INPUT_FILE is
328   // used to read the file.  OFFSET is the offset within the input
329   // file--0 for a .o or .so file, something else for a .a file.
330   Object(const std::string& name, Input_file* input_file, bool is_dynamic,
331          off_t offset = 0)
332     : name_(name), input_file_(input_file), offset_(offset), shnum_(-1U),
333       is_dynamic_(is_dynamic), is_needed_(false), uses_split_stack_(false),
334       has_no_split_stack_(false), no_export_(false),
335       is_in_system_directory_(false), xindex_(NULL)
336   {
337     if (input_file != NULL)
338       {
339         input_file->file().add_object();
340         this->is_in_system_directory_ = input_file->is_in_system_directory();
341       }
342   }
343
344   virtual ~Object()
345   {
346     if (this->input_file_ != NULL)
347       this->input_file_->file().remove_object();
348   }
349
350   // Return the name of the object as we would report it to the tuser.
351   const std::string&
352   name() const
353   { return this->name_; }
354
355   // Get the offset into the file.
356   off_t
357   offset() const
358   { return this->offset_; }
359
360   // Return whether this is a dynamic object.
361   bool
362   is_dynamic() const
363   { return this->is_dynamic_; }
364
365   // Return whether this object is needed--true if it is a dynamic
366   // object which defines some symbol referenced by a regular object.
367   // We keep the flag here rather than in Dynobj for convenience when
368   // setting it.
369   bool
370   is_needed() const
371   { return this->is_needed_; }
372
373   // Record that this object is needed.
374   void
375   set_is_needed()
376   { this->is_needed_ = true; }
377
378   // Return whether this object was compiled with -fsplit-stack.
379   bool
380   uses_split_stack() const
381   { return this->uses_split_stack_; }
382
383   // Return whether this object contains any functions compiled with
384   // the no_split_stack attribute.
385   bool
386   has_no_split_stack() const
387   { return this->has_no_split_stack_; }
388
389   // Returns NULL for Objects that are not plugin objects.  This method
390   // is overridden in the Pluginobj class.
391   Pluginobj*
392   pluginobj()
393   { return this->do_pluginobj(); }
394
395   // Get the file.  We pass on const-ness.
396   Input_file*
397   input_file()
398   {
399     gold_assert(this->input_file_ != NULL);
400     return this->input_file_;
401   }
402
403   const Input_file*
404   input_file() const
405   {
406     gold_assert(this->input_file_ != NULL);
407     return this->input_file_;
408   }
409
410   // Lock the underlying file.
411   void
412   lock(const Task* t)
413   {
414     if (this->input_file_ != NULL)
415       this->input_file_->file().lock(t);
416   }
417
418   // Unlock the underlying file.
419   void
420   unlock(const Task* t)
421   {
422     if (this->input_file_ != NULL)
423       this->input_file()->file().unlock(t);
424   }
425
426   // Return whether the underlying file is locked.
427   bool
428   is_locked() const
429   { return this->input_file_ != NULL && this->input_file_->file().is_locked(); }
430
431   // Return the token, so that the task can be queued.
432   Task_token*
433   token()
434   {
435     if (this->input_file_ == NULL)
436       return NULL;
437     return this->input_file()->file().token();
438   }
439
440   // Release the underlying file.
441   void
442   release()
443   {
444     if (this->input_file_ != NULL)
445       this->input_file()->file().release();
446   }
447
448   // Return whether we should just read symbols from this file.
449   bool
450   just_symbols() const
451   { return this->input_file()->just_symbols(); }
452
453   // Return whether this is an incremental object.
454   bool
455   is_incremental() const
456   { return this->do_is_incremental(); }
457
458   // Return the last modified time of the file.
459   Timespec
460   get_mtime()
461   { return this->do_get_mtime(); }
462
463   // Get the number of sections.
464   unsigned int
465   shnum() const
466   { return this->shnum_; }
467
468   // Return a view of the contents of a section.  Set *PLEN to the
469   // size.  CACHE is a hint as in File_read::get_view.
470   const unsigned char*
471   section_contents(unsigned int shndx, section_size_type* plen, bool cache);
472
473   // Adjust a symbol's section index as needed.  SYMNDX is the index
474   // of the symbol and SHNDX is the symbol's section from
475   // get_st_shndx.  This returns the section index.  It sets
476   // *IS_ORDINARY to indicate whether this is a normal section index,
477   // rather than a special code between SHN_LORESERVE and
478   // SHN_HIRESERVE.
479   unsigned int
480   adjust_sym_shndx(unsigned int symndx, unsigned int shndx, bool* is_ordinary)
481   {
482     if (shndx < elfcpp::SHN_LORESERVE)
483       *is_ordinary = true;
484     else if (shndx == elfcpp::SHN_XINDEX)
485       {
486         if (this->xindex_ == NULL)
487           this->xindex_ = this->do_initialize_xindex();
488         shndx = this->xindex_->sym_xindex_to_shndx(this, symndx);
489         *is_ordinary = true;
490       }
491     else
492       *is_ordinary = false;
493     return shndx;
494   }
495
496   // Return the size of a section given a section index.
497   uint64_t
498   section_size(unsigned int shndx)
499   { return this->do_section_size(shndx); }
500
501   // Return the name of a section given a section index.
502   std::string
503   section_name(unsigned int shndx)
504   { return this->do_section_name(shndx); }
505
506   // Return the section flags given a section index.
507   uint64_t
508   section_flags(unsigned int shndx)
509   { return this->do_section_flags(shndx); }
510
511   // Return the section entsize given a section index.
512   uint64_t
513   section_entsize(unsigned int shndx)
514   { return this->do_section_entsize(shndx); }
515
516   // Return the section address given a section index.
517   uint64_t
518   section_address(unsigned int shndx)
519   { return this->do_section_address(shndx); }
520
521   // Return the section type given a section index.
522   unsigned int
523   section_type(unsigned int shndx)
524   { return this->do_section_type(shndx); }
525
526   // Return the section link field given a section index.
527   unsigned int
528   section_link(unsigned int shndx)
529   { return this->do_section_link(shndx); }
530
531   // Return the section info field given a section index.
532   unsigned int
533   section_info(unsigned int shndx)
534   { return this->do_section_info(shndx); }
535
536   // Return the required section alignment given a section index.
537   uint64_t
538   section_addralign(unsigned int shndx)
539   { return this->do_section_addralign(shndx); }
540
541   // Return the output section given a section index.
542   Output_section*
543   output_section(unsigned int shndx) const
544   { return this->do_output_section(shndx); }
545
546   // Given a section index, return the offset in the Output_section.
547   // The return value will be -1U if the section is specially mapped,
548   // such as a merge section.
549   uint64_t
550   output_section_offset(unsigned int shndx) const
551   { return this->do_output_section_offset(shndx); }
552
553   // Read the symbol information.
554   void
555   read_symbols(Read_symbols_data* sd)
556   { return this->do_read_symbols(sd); }
557
558   // Pass sections which should be included in the link to the Layout
559   // object, and record where the sections go in the output file.
560   void
561   layout(Symbol_table* symtab, Layout* layout, Read_symbols_data* sd)
562   { this->do_layout(symtab, layout, sd); }
563
564   // Add symbol information to the global symbol table.
565   void
566   add_symbols(Symbol_table* symtab, Read_symbols_data* sd, Layout *layout)
567   { this->do_add_symbols(symtab, sd, layout); }
568
569   // Add symbol information to the global symbol table.
570   Archive::Should_include
571   should_include_member(Symbol_table* symtab, Layout* layout,
572                         Read_symbols_data* sd, std::string* why)
573   { return this->do_should_include_member(symtab, layout, sd, why); }
574
575   // Iterate over global symbols, calling a visitor class V for each.
576   void
577   for_all_global_symbols(Read_symbols_data* sd,
578                          Library_base::Symbol_visitor_base* v)
579   { return this->do_for_all_global_symbols(sd, v); }
580
581   // Iterate over local symbols, calling a visitor class V for each GOT offset
582   // associated with a local symbol.
583   void
584   for_all_local_got_entries(Got_offset_list::Visitor* v) const
585   { this->do_for_all_local_got_entries(v); }
586
587   // Functions and types for the elfcpp::Elf_file interface.  This
588   // permit us to use Object as the File template parameter for
589   // elfcpp::Elf_file.
590
591   // The View class is returned by view.  It must support a single
592   // method, data().  This is trivial, because get_view does what we
593   // need.
594   class View
595   {
596    public:
597     View(const unsigned char* p)
598       : p_(p)
599     { }
600
601     const unsigned char*
602     data() const
603     { return this->p_; }
604
605    private:
606     const unsigned char* p_;
607   };
608
609   // Return a View.
610   View
611   view(off_t file_offset, section_size_type data_size)
612   { return View(this->get_view(file_offset, data_size, true, true)); }
613
614   // Report an error.
615   void
616   error(const char* format, ...) const ATTRIBUTE_PRINTF_2;
617
618   // A location in the file.
619   struct Location
620   {
621     off_t file_offset;
622     off_t data_size;
623
624     Location(off_t fo, section_size_type ds)
625       : file_offset(fo), data_size(ds)
626     { }
627   };
628
629   // Get a View given a Location.
630   View view(Location loc)
631   { return View(this->get_view(loc.file_offset, loc.data_size, true, true)); }
632
633   // Get a view into the underlying file.
634   const unsigned char*
635   get_view(off_t start, section_size_type size, bool aligned, bool cache)
636   {
637     return this->input_file()->file().get_view(this->offset_, start, size,
638                                                aligned, cache);
639   }
640
641   // Get a lasting view into the underlying file.
642   File_view*
643   get_lasting_view(off_t start, section_size_type size, bool aligned,
644                    bool cache)
645   {
646     return this->input_file()->file().get_lasting_view(this->offset_, start,
647                                                        size, aligned, cache);
648   }
649
650   // Read data from the underlying file.
651   void
652   read(off_t start, section_size_type size, void* p)
653   { this->input_file()->file().read(start + this->offset_, size, p); }
654
655   // Read multiple data from the underlying file.
656   void
657   read_multiple(const File_read::Read_multiple& rm)
658   { this->input_file()->file().read_multiple(this->offset_, rm); }
659
660   // Stop caching views in the underlying file.
661   void
662   clear_view_cache_marks()
663   {
664     if (this->input_file_ != NULL)
665       this->input_file_->file().clear_view_cache_marks();
666   }
667
668   // Get the number of global symbols defined by this object, and the
669   // number of the symbols whose final definition came from this
670   // object.
671   void
672   get_global_symbol_counts(const Symbol_table* symtab, size_t* defined,
673                            size_t* used) const
674   { this->do_get_global_symbol_counts(symtab, defined, used); }
675
676   // Get the symbols defined in this object.
677   const Symbols*
678   get_global_symbols() const
679   { return this->do_get_global_symbols(); }
680
681   // Set flag that this object was found in a system directory.
682   void
683   set_is_in_system_directory()
684   { this->is_in_system_directory_ = true; }
685
686   // Return whether this object was found in a system directory.
687   bool
688   is_in_system_directory() const
689   { return this->is_in_system_directory_; }
690
691   // Return whether we found this object by searching a directory.
692   bool
693   searched_for() const
694   { return this->input_file()->will_search_for(); }
695
696   bool
697   no_export() const
698   { return this->no_export_; }
699
700   void
701   set_no_export(bool value)
702   { this->no_export_ = value; }
703
704   // Return TRUE if the section is a compressed debug section, and set
705   // *UNCOMPRESSED_SIZE to the size of the uncompressed data.
706   bool
707   section_is_compressed(unsigned int shndx,
708                         section_size_type* uncompressed_size) const
709   { return this->do_section_is_compressed(shndx, uncompressed_size); }
710
711   // Return the index of the first incremental relocation for symbol SYMNDX.
712   unsigned int
713   get_incremental_reloc_base(unsigned int symndx) const
714   { return this->do_get_incremental_reloc_base(symndx); }
715
716   // Return the number of incremental relocations for symbol SYMNDX.
717   unsigned int
718   get_incremental_reloc_count(unsigned int symndx) const
719   { return this->do_get_incremental_reloc_count(symndx); }
720
721  protected:
722   // Returns NULL for Objects that are not plugin objects.  This method
723   // is overridden in the Pluginobj class.
724   virtual Pluginobj*
725   do_pluginobj()
726   { return NULL; }
727
728   // Return TRUE if this is an incremental (unchanged) input file.
729   // We return FALSE by default; the incremental object classes
730   // override this method.
731   virtual bool
732   do_is_incremental() const
733   { return false; }
734
735   // Return the last modified time of the file.  This method may be
736   // overridden for subclasses that don't use an actual file (e.g.,
737   // Incremental objects).
738   virtual Timespec
739   do_get_mtime()
740   { return this->input_file()->file().get_mtime(); }
741
742   // Read the symbols--implemented by child class.
743   virtual void
744   do_read_symbols(Read_symbols_data*) = 0;
745
746   // Lay out sections--implemented by child class.
747   virtual void
748   do_layout(Symbol_table*, Layout*, Read_symbols_data*) = 0;
749
750   // Add symbol information to the global symbol table--implemented by
751   // child class.
752   virtual void
753   do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*) = 0;
754
755   virtual Archive::Should_include
756   do_should_include_member(Symbol_table* symtab, Layout*, Read_symbols_data*,
757                            std::string* why) = 0;
758
759   // Iterate over global symbols, calling a visitor class V for each.
760   virtual void
761   do_for_all_global_symbols(Read_symbols_data* sd,
762                             Library_base::Symbol_visitor_base* v) = 0;
763
764   // Iterate over local symbols, calling a visitor class V for each GOT offset
765   // associated with a local symbol.
766   virtual void
767   do_for_all_local_got_entries(Got_offset_list::Visitor* v) const = 0;
768
769   // Return the location of the contents of a section.  Implemented by
770   // child class.
771   virtual Location
772   do_section_contents(unsigned int shndx) = 0;
773
774   // Get the size of a section--implemented by child class.
775   virtual uint64_t
776   do_section_size(unsigned int shndx) = 0;
777
778   // Get the name of a section--implemented by child class.
779   virtual std::string
780   do_section_name(unsigned int shndx) = 0;
781
782   // Get section flags--implemented by child class.
783   virtual uint64_t
784   do_section_flags(unsigned int shndx) = 0;
785
786   // Get section entsize--implemented by child class.
787   virtual uint64_t
788   do_section_entsize(unsigned int shndx) = 0;
789
790   // Get section address--implemented by child class.
791   virtual uint64_t
792   do_section_address(unsigned int shndx) = 0;
793
794   // Get section type--implemented by child class.
795   virtual unsigned int
796   do_section_type(unsigned int shndx) = 0;
797
798   // Get section link field--implemented by child class.
799   virtual unsigned int
800   do_section_link(unsigned int shndx) = 0;
801
802   // Get section info field--implemented by child class.
803   virtual unsigned int
804   do_section_info(unsigned int shndx) = 0;
805
806   // Get section alignment--implemented by child class.
807   virtual uint64_t
808   do_section_addralign(unsigned int shndx) = 0;
809
810   // Return the output section given a section index--implemented
811   // by child class.
812   virtual Output_section*
813   do_output_section(unsigned int) const
814   { gold_unreachable(); }
815
816   // Get the offset of a section--implemented by child class.
817   virtual uint64_t
818   do_output_section_offset(unsigned int) const
819   { gold_unreachable(); }
820
821   // Return the Xindex structure to use.
822   virtual Xindex*
823   do_initialize_xindex() = 0;
824
825   // Implement get_global_symbol_counts--implemented by child class.
826   virtual void
827   do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const = 0;
828
829   virtual const Symbols*
830   do_get_global_symbols() const = 0;
831
832   // Set the number of sections.
833   void
834   set_shnum(int shnum)
835   { this->shnum_ = shnum; }
836
837   // Functions used by both Sized_relobj and Sized_dynobj.
838
839   // Read the section data into a Read_symbols_data object.
840   template<int size, bool big_endian>
841   void
842   read_section_data(elfcpp::Elf_file<size, big_endian, Object>*,
843                     Read_symbols_data*);
844
845   // Let the child class initialize the xindex object directly.
846   void
847   set_xindex(Xindex* xindex)
848   {
849     gold_assert(this->xindex_ == NULL);
850     this->xindex_ = xindex;
851   }
852
853   // If NAME is the name of a special .gnu.warning section, arrange
854   // for the warning to be issued.  SHNDX is the section index.
855   // Return whether it is a warning section.
856   bool
857   handle_gnu_warning_section(const char* name, unsigned int shndx,
858                              Symbol_table*);
859
860   // If NAME is the name of the special section which indicates that
861   // this object was compiled with -fsplit-stack, mark it accordingly,
862   // and return true.  Otherwise return false.
863   bool
864   handle_split_stack_section(const char* name);
865
866   // Return TRUE if the section is a compressed debug section, and set
867   // *UNCOMPRESSED_SIZE to the size of the uncompressed data.
868   virtual bool
869   do_section_is_compressed(unsigned int, section_size_type*) const
870   { return false; }
871
872   // Return the index of the first incremental relocation for symbol SYMNDX--
873   // implemented by child class.
874   virtual unsigned int
875   do_get_incremental_reloc_base(unsigned int) const
876   { gold_unreachable(); }
877
878   // Return the number of incremental relocations for symbol SYMNDX--
879   // implemented by child class.
880   virtual unsigned int
881   do_get_incremental_reloc_count(unsigned int) const
882   { gold_unreachable(); }
883
884  private:
885   // This class may not be copied.
886   Object(const Object&);
887   Object& operator=(const Object&);
888
889   // Name of object as printed to user.
890   std::string name_;
891   // For reading the file.
892   Input_file* input_file_;
893   // Offset within the file--0 for an object file, non-0 for an
894   // archive.
895   off_t offset_;
896   // Number of input sections.
897   unsigned int shnum_;
898   // Whether this is a dynamic object.
899   bool is_dynamic_ : 1;
900   // Whether this object is needed.  This is only set for dynamic
901   // objects, and means that the object defined a symbol which was
902   // used by a reference from a regular object.
903   bool is_needed_ : 1;
904   // Whether this object was compiled with -fsplit-stack.
905   bool uses_split_stack_ : 1;
906   // Whether this object contains any functions compiled with the
907   // no_split_stack attribute.
908   bool has_no_split_stack_ : 1;
909   // True if exclude this object from automatic symbol export.
910   // This is used only for archive objects.
911   bool no_export_ : 1;
912   // True if the object was found in a system directory.
913   bool is_in_system_directory_ : 1;
914   // Many sections for objects with more than SHN_LORESERVE sections.
915   Xindex* xindex_;
916 };
917
918 // A regular object (ET_REL).  This is an abstract base class itself.
919 // The implementation is the template class Sized_relobj.
920
921 class Relobj : public Object
922 {
923  public:
924   Relobj(const std::string& name, Input_file* input_file, off_t offset = 0)
925     : Object(name, input_file, false, offset),
926       output_sections_(),
927       map_to_relocatable_relocs_(NULL),
928       object_merge_map_(NULL),
929       relocs_must_follow_section_writes_(false),
930       sd_(NULL),
931       reloc_counts_(NULL),
932       reloc_bases_(NULL)
933   { }
934
935   // During garbage collection, the Read_symbols_data pass for 
936   // each object is stored as layout needs to be done after 
937   // reloc processing.
938   Symbols_data* 
939   get_symbols_data()
940   { return this->sd_; }
941
942   // Decides which section names have to be included in the worklist
943   // as roots.
944   bool
945   is_section_name_included(const char* name);
946  
947   void
948   copy_symbols_data(Symbols_data* gc_sd, Read_symbols_data* sd,
949                     unsigned int section_header_size);
950
951   void
952   set_symbols_data(Symbols_data* sd)
953   { this->sd_ = sd; }
954
955   // During garbage collection, the Read_relocs pass for all objects 
956   // is done before scanning the relocs.  In that case, this->rd_ is
957   // used to store the information from Read_relocs for each object.
958   // This data is also used to compute the list of relevant sections.
959   Read_relocs_data*
960   get_relocs_data()
961   { return this->rd_; }
962
963   void
964   set_relocs_data(Read_relocs_data* rd)
965   { this->rd_ = rd; }
966
967   virtual bool
968   is_output_section_offset_invalid(unsigned int shndx) const = 0;
969
970   // Read the relocs.
971   void
972   read_relocs(Read_relocs_data* rd)
973   { return this->do_read_relocs(rd); }
974
975   // Process the relocs, during garbage collection only.
976   void
977   gc_process_relocs(Symbol_table* symtab, Layout* layout, Read_relocs_data* rd)
978   { return this->do_gc_process_relocs(symtab, layout, rd); }
979
980   // Scan the relocs and adjust the symbol table.
981   void
982   scan_relocs(Symbol_table* symtab, Layout* layout, Read_relocs_data* rd)
983   { return this->do_scan_relocs(symtab, layout, rd); }
984
985   // The number of local symbols in the input symbol table.
986   virtual unsigned int
987   local_symbol_count() const
988   { return this->do_local_symbol_count(); }
989
990   // Initial local symbol processing: count the number of local symbols
991   // in the output symbol table and dynamic symbol table; add local symbol
992   // names to *POOL and *DYNPOOL.
993   void
994   count_local_symbols(Stringpool_template<char>* pool,
995                       Stringpool_template<char>* dynpool)
996   { return this->do_count_local_symbols(pool, dynpool); }
997
998   // Set the values of the local symbols, set the output symbol table
999   // indexes for the local variables, and set the offset where local
1000   // symbol information will be stored. Returns the new local symbol index.
1001   unsigned int
1002   finalize_local_symbols(unsigned int index, off_t off, Symbol_table* symtab)
1003   { return this->do_finalize_local_symbols(index, off, symtab); }
1004
1005   // Set the output dynamic symbol table indexes for the local variables.
1006   unsigned int
1007   set_local_dynsym_indexes(unsigned int index)
1008   { return this->do_set_local_dynsym_indexes(index); }
1009
1010   // Set the offset where local dynamic symbol information will be stored.
1011   unsigned int
1012   set_local_dynsym_offset(off_t off)
1013   { return this->do_set_local_dynsym_offset(off); }
1014
1015   // Relocate the input sections and write out the local symbols.
1016   void
1017   relocate(const Symbol_table* symtab, const Layout* layout, Output_file* of)
1018   { return this->do_relocate(symtab, layout, of); }
1019
1020   // Return whether an input section is being included in the link.
1021   bool
1022   is_section_included(unsigned int shndx) const
1023   {
1024     gold_assert(shndx < this->output_sections_.size());
1025     return this->output_sections_[shndx] != NULL;
1026   }
1027
1028   // The the output section of the input section with index SHNDX.
1029   // This is only used currently to remove a section from the link in
1030   // relaxation.
1031   void
1032   set_output_section(unsigned int shndx, Output_section* os)
1033   {
1034     gold_assert(shndx < this->output_sections_.size());
1035     this->output_sections_[shndx] = os;
1036   }
1037   
1038   // Set the offset of an input section within its output section.
1039   void
1040   set_section_offset(unsigned int shndx, uint64_t off)
1041   { this->do_set_section_offset(shndx, off); }
1042
1043   // Return true if we need to wait for output sections to be written
1044   // before we can apply relocations.  This is true if the object has
1045   // any relocations for sections which require special handling, such
1046   // as the exception frame section.
1047   bool
1048   relocs_must_follow_section_writes() const
1049   { return this->relocs_must_follow_section_writes_; }
1050
1051   // Return the object merge map.
1052   Object_merge_map*
1053   merge_map() const
1054   { return this->object_merge_map_; }
1055
1056   // Set the object merge map.
1057   void
1058   set_merge_map(Object_merge_map* object_merge_map)
1059   {
1060     gold_assert(this->object_merge_map_ == NULL);
1061     this->object_merge_map_ = object_merge_map;
1062   }
1063
1064   // Record the relocatable reloc info for an input reloc section.
1065   void
1066   set_relocatable_relocs(unsigned int reloc_shndx, Relocatable_relocs* rr)
1067   {
1068     gold_assert(reloc_shndx < this->shnum());
1069     (*this->map_to_relocatable_relocs_)[reloc_shndx] = rr;
1070   }
1071
1072   // Get the relocatable reloc info for an input reloc section.
1073   Relocatable_relocs*
1074   relocatable_relocs(unsigned int reloc_shndx)
1075   {
1076     gold_assert(reloc_shndx < this->shnum());
1077     return (*this->map_to_relocatable_relocs_)[reloc_shndx];
1078   }
1079
1080   // Layout sections whose layout was deferred while waiting for
1081   // input files from a plugin.
1082   void
1083   layout_deferred_sections(Layout* layout)
1084   { this->do_layout_deferred_sections(layout); }
1085
1086   // Return the index of the first incremental relocation for symbol SYMNDX.
1087   virtual unsigned int
1088   do_get_incremental_reloc_base(unsigned int symndx) const
1089   { return this->reloc_bases_[symndx]; }
1090
1091   // Return the number of incremental relocations for symbol SYMNDX.
1092   virtual unsigned int
1093   do_get_incremental_reloc_count(unsigned int symndx) const
1094   { return this->reloc_counts_[symndx]; }
1095
1096  protected:
1097   // The output section to be used for each input section, indexed by
1098   // the input section number.  The output section is NULL if the
1099   // input section is to be discarded.
1100   typedef std::vector<Output_section*> Output_sections;
1101
1102   // Read the relocs--implemented by child class.
1103   virtual void
1104   do_read_relocs(Read_relocs_data*) = 0;
1105
1106   // Process the relocs--implemented by child class.
1107   virtual void
1108   do_gc_process_relocs(Symbol_table*, Layout*, Read_relocs_data*) = 0;
1109
1110   // Scan the relocs--implemented by child class.
1111   virtual void
1112   do_scan_relocs(Symbol_table*, Layout*, Read_relocs_data*) = 0;
1113
1114   // Return the number of local symbols--implemented by child class.
1115   virtual unsigned int
1116   do_local_symbol_count() const = 0;
1117
1118   // Count local symbols--implemented by child class.
1119   virtual void
1120   do_count_local_symbols(Stringpool_template<char>*,
1121                          Stringpool_template<char>*) = 0;
1122
1123   // Finalize the local symbols.  Set the output symbol table indexes
1124   // for the local variables, and set the offset where local symbol
1125   // information will be stored.
1126   virtual unsigned int
1127   do_finalize_local_symbols(unsigned int, off_t, Symbol_table*) = 0;
1128
1129   // Set the output dynamic symbol table indexes for the local variables.
1130   virtual unsigned int
1131   do_set_local_dynsym_indexes(unsigned int) = 0;
1132
1133   // Set the offset where local dynamic symbol information will be stored.
1134   virtual unsigned int
1135   do_set_local_dynsym_offset(off_t) = 0;
1136
1137   // Relocate the input sections and write out the local
1138   // symbols--implemented by child class.
1139   virtual void
1140   do_relocate(const Symbol_table* symtab, const Layout*, Output_file* of) = 0;
1141
1142   // Set the offset of a section--implemented by child class.
1143   virtual void
1144   do_set_section_offset(unsigned int shndx, uint64_t off) = 0;
1145
1146   // Layout sections whose layout was deferred while waiting for
1147   // input files from a plugin--implemented by child class.
1148   virtual void
1149   do_layout_deferred_sections(Layout*) = 0;
1150
1151   // Given a section index, return the corresponding Output_section.
1152   // The return value will be NULL if the section is not included in
1153   // the link.
1154   Output_section*
1155   do_output_section(unsigned int shndx) const
1156   {
1157     gold_assert(shndx < this->output_sections_.size());
1158     return this->output_sections_[shndx];
1159   }
1160
1161   // Return the vector mapping input sections to output sections.
1162   Output_sections&
1163   output_sections()
1164   { return this->output_sections_; }
1165
1166   const Output_sections&
1167   output_sections() const
1168   { return this->output_sections_; }
1169
1170   // Set the size of the relocatable relocs array.
1171   void
1172   size_relocatable_relocs()
1173   {
1174     this->map_to_relocatable_relocs_ =
1175       new std::vector<Relocatable_relocs*>(this->shnum());
1176   }
1177
1178   // Record that we must wait for the output sections to be written
1179   // before applying relocations.
1180   void
1181   set_relocs_must_follow_section_writes()
1182   { this->relocs_must_follow_section_writes_ = true; }
1183
1184   // Allocate the array for counting incremental relocations.
1185   void
1186   allocate_incremental_reloc_counts()
1187   {
1188     unsigned int nsyms = this->do_get_global_symbols()->size();
1189     this->reloc_counts_ = new unsigned int[nsyms];
1190     gold_assert(this->reloc_counts_ != NULL);
1191     memset(this->reloc_counts_, 0, nsyms * sizeof(unsigned int));
1192   }
1193
1194   // Record a relocation in this object referencing global symbol SYMNDX.
1195   // Used for tracking incremental link information.
1196   void
1197   count_incremental_reloc(unsigned int symndx)
1198   {
1199     unsigned int nsyms = this->do_get_global_symbols()->size();
1200     gold_assert(symndx < nsyms);
1201     gold_assert(this->reloc_counts_ != NULL);
1202     ++this->reloc_counts_[symndx];
1203   }
1204
1205   // Finalize the incremental relocation information.
1206   void
1207   finalize_incremental_relocs(Layout* layout, bool clear_counts);
1208
1209   // Return the index of the next relocation to be written for global symbol
1210   // SYMNDX.  Only valid after finalize_incremental_relocs() has been called.
1211   unsigned int
1212   next_incremental_reloc_index(unsigned int symndx)
1213   {
1214     unsigned int nsyms = this->do_get_global_symbols()->size();
1215
1216     gold_assert(this->reloc_counts_ != NULL);
1217     gold_assert(this->reloc_bases_ != NULL);
1218     gold_assert(symndx < nsyms);
1219
1220     unsigned int counter = this->reloc_counts_[symndx]++;
1221     return this->reloc_bases_[symndx] + counter;
1222   }
1223
1224  private:
1225   // Mapping from input sections to output section.
1226   Output_sections output_sections_;
1227   // Mapping from input section index to the information recorded for
1228   // the relocations.  This is only used for a relocatable link.
1229   std::vector<Relocatable_relocs*>* map_to_relocatable_relocs_;
1230   // Mappings for merge sections.  This is managed by the code in the
1231   // Merge_map class.
1232   Object_merge_map* object_merge_map_;
1233   // Whether we need to wait for output sections to be written before
1234   // we can apply relocations.
1235   bool relocs_must_follow_section_writes_;
1236   // Used to store the relocs data computed by the Read_relocs pass. 
1237   // Used during garbage collection of unused sections.
1238   Read_relocs_data* rd_;
1239   // Used to store the symbols data computed by the Read_symbols pass.
1240   // Again used during garbage collection when laying out referenced
1241   // sections.
1242   gold::Symbols_data* sd_;
1243   // Per-symbol counts of relocations, for incremental links.
1244   unsigned int* reloc_counts_;
1245   // Per-symbol base indexes of relocations, for incremental links.
1246   unsigned int* reloc_bases_;
1247 };
1248
1249 // This class is used to handle relocations against a section symbol
1250 // in an SHF_MERGE section.  For such a symbol, we need to know the
1251 // addend of the relocation before we can determine the final value.
1252 // The addend gives us the location in the input section, and we can
1253 // determine how it is mapped to the output section.  For a
1254 // non-section symbol, we apply the addend to the final value of the
1255 // symbol; that is done in finalize_local_symbols, and does not use
1256 // this class.
1257
1258 template<int size>
1259 class Merged_symbol_value
1260 {
1261  public:
1262   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value;
1263
1264   // We use a hash table to map offsets in the input section to output
1265   // addresses.
1266   typedef Unordered_map<section_offset_type, Value> Output_addresses;
1267
1268   Merged_symbol_value(Value input_value, Value output_start_address)
1269     : input_value_(input_value), output_start_address_(output_start_address),
1270       output_addresses_()
1271   { }
1272
1273   // Initialize the hash table.
1274   void
1275   initialize_input_to_output_map(const Relobj*, unsigned int input_shndx);
1276
1277   // Release the hash table to save space.
1278   void
1279   free_input_to_output_map()
1280   { this->output_addresses_.clear(); }
1281
1282   // Get the output value corresponding to an addend.  The object and
1283   // input section index are passed in because the caller will have
1284   // them; otherwise we could store them here.
1285   Value
1286   value(const Relobj* object, unsigned int input_shndx, Value addend) const
1287   {
1288     // This is a relocation against a section symbol.  ADDEND is the
1289     // offset in the section.  The result should be the start of some
1290     // merge area.  If the object file wants something else, it should
1291     // use a regular symbol rather than a section symbol.
1292     // Unfortunately, PR 6658 shows a case in which the object file
1293     // refers to the section symbol, but uses a negative ADDEND to
1294     // compensate for a PC relative reloc.  We can't handle the
1295     // general case.  However, we can handle the special case of a
1296     // negative addend, by assuming that it refers to the start of the
1297     // section.  Of course, that means that we have to guess when
1298     // ADDEND is negative.  It is normal to see a 32-bit value here
1299     // even when the template parameter size is 64, as 64-bit object
1300     // file formats have 32-bit relocations.  We know this is a merge
1301     // section, so we know it has to fit into memory.  So we assume
1302     // that we won't see a value larger than a large 32-bit unsigned
1303     // value.  This will break objects with very very large merge
1304     // sections; they probably break in other ways anyhow.
1305     Value input_offset = this->input_value_;
1306     if (addend < 0xffffff00)
1307       {
1308         input_offset += addend;
1309         addend = 0;
1310       }
1311     typename Output_addresses::const_iterator p =
1312       this->output_addresses_.find(input_offset);
1313     if (p != this->output_addresses_.end())
1314       return p->second + addend;
1315
1316     return (this->value_from_output_section(object, input_shndx, input_offset)
1317             + addend);
1318   }
1319
1320  private:
1321   // Get the output value for an input offset if we couldn't find it
1322   // in the hash table.
1323   Value
1324   value_from_output_section(const Relobj*, unsigned int input_shndx,
1325                             Value input_offset) const;
1326
1327   // The value of the section symbol in the input file.  This is
1328   // normally zero, but could in principle be something else.
1329   Value input_value_;
1330   // The start address of this merged section in the output file.
1331   Value output_start_address_;
1332   // A hash table which maps offsets in the input section to output
1333   // addresses.  This only maps specific offsets, not all offsets.
1334   Output_addresses output_addresses_;
1335 };
1336
1337 // This POD class is holds the value of a symbol.  This is used for
1338 // local symbols, and for all symbols during relocation processing.
1339 // For special sections, such as SHF_MERGE sections, this calls a
1340 // function to get the final symbol value.
1341
1342 template<int size>
1343 class Symbol_value
1344 {
1345  public:
1346   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value;
1347
1348   Symbol_value()
1349     : output_symtab_index_(0), output_dynsym_index_(-1U), input_shndx_(0),
1350       is_ordinary_shndx_(false), is_section_symbol_(false),
1351       is_tls_symbol_(false), is_ifunc_symbol_(false), has_output_value_(true)
1352   { this->u_.value = 0; }
1353
1354   ~Symbol_value()
1355   {
1356     if (!this->has_output_value_)
1357       delete this->u_.merged_symbol_value;
1358   }
1359
1360   // Get the value of this symbol.  OBJECT is the object in which this
1361   // symbol is defined, and ADDEND is an addend to add to the value.
1362   template<bool big_endian>
1363   Value
1364   value(const Sized_relobj<size, big_endian>* object, Value addend) const
1365   {
1366     if (this->has_output_value_)
1367       return this->u_.value + addend;
1368     else
1369       {
1370         gold_assert(this->is_ordinary_shndx_);
1371         return this->u_.merged_symbol_value->value(object, this->input_shndx_,
1372                                                    addend);
1373       }
1374   }
1375
1376   // Set the value of this symbol in the output symbol table.
1377   void
1378   set_output_value(Value value)
1379   { this->u_.value = value; }
1380
1381   // For a section symbol in a merged section, we need more
1382   // information.
1383   void
1384   set_merged_symbol_value(Merged_symbol_value<size>* msv)
1385   {
1386     gold_assert(this->is_section_symbol_);
1387     this->has_output_value_ = false;
1388     this->u_.merged_symbol_value = msv;
1389   }
1390
1391   // Initialize the input to output map for a section symbol in a
1392   // merged section.  We also initialize the value of a non-section
1393   // symbol in a merged section.
1394   void
1395   initialize_input_to_output_map(const Relobj* object)
1396   {
1397     if (!this->has_output_value_)
1398       {
1399         gold_assert(this->is_section_symbol_ && this->is_ordinary_shndx_);
1400         Merged_symbol_value<size>* msv = this->u_.merged_symbol_value;
1401         msv->initialize_input_to_output_map(object, this->input_shndx_);
1402       }
1403   }
1404
1405   // Free the input to output map for a section symbol in a merged
1406   // section.
1407   void
1408   free_input_to_output_map()
1409   {
1410     if (!this->has_output_value_)
1411       this->u_.merged_symbol_value->free_input_to_output_map();
1412   }
1413
1414   // Set the value of the symbol from the input file.  This is only
1415   // called by count_local_symbols, to communicate the value to
1416   // finalize_local_symbols.
1417   void
1418   set_input_value(Value value)
1419   { this->u_.value = value; }
1420
1421   // Return the input value.  This is only called by
1422   // finalize_local_symbols and (in special cases) relocate_section.
1423   Value
1424   input_value() const
1425   { return this->u_.value; }
1426
1427   // Return whether we have set the index in the output symbol table
1428   // yet.
1429   bool
1430   is_output_symtab_index_set() const
1431   {
1432     return (this->output_symtab_index_ != 0
1433             && this->output_symtab_index_ != -2U);
1434   }
1435
1436   // Return whether this symbol may be discarded from the normal
1437   // symbol table.
1438   bool
1439   may_be_discarded_from_output_symtab() const
1440   {
1441     gold_assert(!this->is_output_symtab_index_set());
1442     return this->output_symtab_index_ != -2U;
1443   }
1444
1445   // Return whether this symbol has an entry in the output symbol
1446   // table.
1447   bool
1448   has_output_symtab_entry() const
1449   {
1450     gold_assert(this->is_output_symtab_index_set());
1451     return this->output_symtab_index_ != -1U;
1452   }
1453
1454   // Return the index in the output symbol table.
1455   unsigned int
1456   output_symtab_index() const
1457   {
1458     gold_assert(this->is_output_symtab_index_set()
1459                 && this->output_symtab_index_ != -1U);
1460     return this->output_symtab_index_;
1461   }
1462
1463   // Set the index in the output symbol table.
1464   void
1465   set_output_symtab_index(unsigned int i)
1466   {
1467     gold_assert(!this->is_output_symtab_index_set());
1468     gold_assert(i != 0 && i != -1U && i != -2U);
1469     this->output_symtab_index_ = i;
1470   }
1471
1472   // Record that this symbol should not go into the output symbol
1473   // table.
1474   void
1475   set_no_output_symtab_entry()
1476   {
1477     gold_assert(this->output_symtab_index_ == 0);
1478     this->output_symtab_index_ = -1U;
1479   }
1480
1481   // Record that this symbol must go into the output symbol table,
1482   // because it there is a relocation that uses it.
1483   void
1484   set_must_have_output_symtab_entry()
1485   {
1486     gold_assert(!this->is_output_symtab_index_set());
1487     this->output_symtab_index_ = -2U;
1488   }
1489
1490   // Set the index in the output dynamic symbol table.
1491   void
1492   set_needs_output_dynsym_entry()
1493   {
1494     gold_assert(!this->is_section_symbol());
1495     this->output_dynsym_index_ = 0;
1496   }
1497
1498   // Return whether this symbol should go into the dynamic symbol
1499   // table.
1500   bool
1501   needs_output_dynsym_entry() const
1502   {
1503     return this->output_dynsym_index_ != -1U;
1504   }
1505
1506   // Return whether this symbol has an entry in the dynamic symbol
1507   // table.
1508   bool
1509   has_output_dynsym_entry() const
1510   {
1511     gold_assert(this->output_dynsym_index_ != 0);
1512     return this->output_dynsym_index_ != -1U;
1513   }
1514
1515   // Record that this symbol should go into the dynamic symbol table.
1516   void
1517   set_output_dynsym_index(unsigned int i)
1518   {
1519     gold_assert(this->output_dynsym_index_ == 0);
1520     gold_assert(i != 0 && i != -1U);
1521     this->output_dynsym_index_ = i;
1522   }
1523
1524   // Return the index in the output dynamic symbol table.
1525   unsigned int
1526   output_dynsym_index() const
1527   {
1528     gold_assert(this->output_dynsym_index_ != 0
1529                 && this->output_dynsym_index_ != -1U);
1530     return this->output_dynsym_index_;
1531   }
1532
1533   // Set the index of the input section in the input file.
1534   void
1535   set_input_shndx(unsigned int i, bool is_ordinary)
1536   {
1537     this->input_shndx_ = i;
1538     // input_shndx_ field is a bitfield, so make sure that the value
1539     // fits.
1540     gold_assert(this->input_shndx_ == i);
1541     this->is_ordinary_shndx_ = is_ordinary;
1542   }
1543
1544   // Return the index of the input section in the input file.
1545   unsigned int
1546   input_shndx(bool* is_ordinary) const
1547   {
1548     *is_ordinary = this->is_ordinary_shndx_;
1549     return this->input_shndx_;
1550   }
1551
1552   // Whether this is a section symbol.
1553   bool
1554   is_section_symbol() const
1555   { return this->is_section_symbol_; }
1556
1557   // Record that this is a section symbol.
1558   void
1559   set_is_section_symbol()
1560   {
1561     gold_assert(!this->needs_output_dynsym_entry());
1562     this->is_section_symbol_ = true;
1563   }
1564
1565   // Record that this is a TLS symbol.
1566   void
1567   set_is_tls_symbol()
1568   { this->is_tls_symbol_ = true; }
1569
1570   // Return true if this is a TLS symbol.
1571   bool
1572   is_tls_symbol() const
1573   { return this->is_tls_symbol_; }
1574
1575   // Record that this is an IFUNC symbol.
1576   void
1577   set_is_ifunc_symbol()
1578   { this->is_ifunc_symbol_ = true; }
1579
1580   // Return true if this is an IFUNC symbol.
1581   bool
1582   is_ifunc_symbol() const
1583   { return this->is_ifunc_symbol_; }
1584
1585   // Return true if this has output value.
1586   bool
1587   has_output_value() const
1588   { return this->has_output_value_; }
1589
1590  private:
1591   // The index of this local symbol in the output symbol table.  This
1592   // will be 0 if no value has been assigned yet, and the symbol may
1593   // be omitted.  This will be -1U if the symbol should not go into
1594   // the symbol table.  This will be -2U if the symbol must go into
1595   // the symbol table, but no index has been assigned yet.
1596   unsigned int output_symtab_index_;
1597   // The index of this local symbol in the dynamic symbol table.  This
1598   // will be -1U if the symbol should not go into the symbol table.
1599   unsigned int output_dynsym_index_;
1600   // The section index in the input file in which this symbol is
1601   // defined.
1602   unsigned int input_shndx_ : 27;
1603   // Whether the section index is an ordinary index, not a special
1604   // value.
1605   bool is_ordinary_shndx_ : 1;
1606   // Whether this is a STT_SECTION symbol.
1607   bool is_section_symbol_ : 1;
1608   // Whether this is a STT_TLS symbol.
1609   bool is_tls_symbol_ : 1;
1610   // Whether this is a STT_GNU_IFUNC symbol.
1611   bool is_ifunc_symbol_ : 1;
1612   // Whether this symbol has a value for the output file.  This is
1613   // normally set to true during Layout::finalize, by
1614   // finalize_local_symbols.  It will be false for a section symbol in
1615   // a merge section, as for such symbols we can not determine the
1616   // value to use in a relocation until we see the addend.
1617   bool has_output_value_ : 1;
1618   union
1619   {
1620     // This is used if has_output_value_ is true.  Between
1621     // count_local_symbols and finalize_local_symbols, this is the
1622     // value in the input file.  After finalize_local_symbols, it is
1623     // the value in the output file.
1624     Value value;
1625     // This is used if has_output_value_ is false.  It points to the
1626     // information we need to get the value for a merge section.
1627     Merged_symbol_value<size>* merged_symbol_value;
1628   } u_;
1629 };
1630
1631 // This type is used to modify relocations for -fsplit-stack.  It is
1632 // indexed by relocation index, and means that the relocation at that
1633 // index should use the symbol from the vector, rather than the one
1634 // indicated by the relocation.
1635
1636 class Reloc_symbol_changes
1637 {
1638  public:
1639   Reloc_symbol_changes(size_t count)
1640     : vec_(count, NULL)
1641   { }
1642
1643   void
1644   set(size_t i, Symbol* sym)
1645   { this->vec_[i] = sym; }
1646
1647   const Symbol*
1648   operator[](size_t i) const
1649   { return this->vec_[i]; }
1650
1651  private:
1652   std::vector<Symbol*> vec_;
1653 };
1654
1655 // Type for mapping section index to uncompressed size.
1656
1657 typedef std::map<unsigned int, section_size_type> Compressed_section_map;
1658
1659 // Abstract base class for a regular object file, either a real object file
1660 // or an incremental (unchanged) object.  This is size and endian specific.
1661
1662 template<int size, bool big_endian>
1663 class Sized_relobj_base : public Relobj
1664 {
1665  public:
1666   typedef Relobj::Symbols Symbols;
1667
1668   Sized_relobj_base(const std::string& name, Input_file* input_file)
1669     : Relobj(name, input_file)
1670   { }
1671
1672   Sized_relobj_base(const std::string& name, Input_file* input_file,
1673                     off_t offset)
1674     : Relobj(name, input_file, offset)
1675   { }
1676
1677   ~Sized_relobj_base()
1678   { }
1679
1680  protected:
1681   typedef Relobj::Output_sections Output_sections;
1682
1683  private:
1684 };
1685
1686 // A regular object file.  This is size and endian specific.
1687
1688 template<int size, bool big_endian>
1689 class Sized_relobj : public Sized_relobj_base<size, big_endian>
1690 {
1691  public:
1692   typedef typename elfcpp::Elf_types<size>::Elf_Addr Address;
1693   typedef typename Sized_relobj_base<size, big_endian>::Symbols Symbols;
1694   typedef std::vector<Symbol_value<size> > Local_values;
1695
1696   static const Address invalid_address = static_cast<Address>(0) - 1;
1697
1698   enum Compute_final_local_value_status
1699   {
1700     // No error.
1701     CFLV_OK,
1702     // An error occurred.
1703     CFLV_ERROR,
1704     // The local symbol has no output section.
1705     CFLV_DISCARDED
1706   };
1707
1708   Sized_relobj(const std::string& name, Input_file* input_file, off_t offset,
1709                const typename elfcpp::Ehdr<size, big_endian>&);
1710
1711   ~Sized_relobj();
1712
1713   // Checks if the offset of input section SHNDX within its output
1714   // section is invalid. 
1715   bool
1716   is_output_section_offset_invalid(unsigned int shndx) const
1717   { return this->get_output_section_offset(shndx) == invalid_address; }
1718
1719   // Set up the object file based on TARGET.
1720   void
1721   setup()
1722   { this->do_setup(); }
1723
1724   // Return the number of symbols.  This is only valid after
1725   // Object::add_symbols has been called.
1726   unsigned int
1727   symbol_count() const
1728   { return this->local_symbol_count_ + this->symbols_.size(); }
1729
1730   // If SYM is the index of a global symbol in the object file's
1731   // symbol table, return the Symbol object.  Otherwise, return NULL.
1732   Symbol*
1733   global_symbol(unsigned int sym) const
1734   {
1735     if (sym >= this->local_symbol_count_)
1736       {
1737         gold_assert(sym - this->local_symbol_count_ < this->symbols_.size());
1738         return this->symbols_[sym - this->local_symbol_count_];
1739       }
1740     return NULL;
1741   }
1742
1743   // Return the section index of symbol SYM.  Set *VALUE to its value
1744   // in the object file.  Set *IS_ORDINARY if this is an ordinary
1745   // section index, not a special code between SHN_LORESERVE and
1746   // SHN_HIRESERVE.  Note that for a symbol which is not defined in
1747   // this object file, this will set *VALUE to 0 and return SHN_UNDEF;
1748   // it will not return the final value of the symbol in the link.
1749   unsigned int
1750   symbol_section_and_value(unsigned int sym, Address* value, bool* is_ordinary);
1751
1752   // Return a pointer to the Symbol_value structure which holds the
1753   // value of a local symbol.
1754   const Symbol_value<size>*
1755   local_symbol(unsigned int sym) const
1756   {
1757     gold_assert(sym < this->local_values_.size());
1758     return &this->local_values_[sym];
1759   }
1760
1761   // Return the index of local symbol SYM in the ordinary symbol
1762   // table.  A value of -1U means that the symbol is not being output.
1763   unsigned int
1764   symtab_index(unsigned int sym) const
1765   {
1766     gold_assert(sym < this->local_values_.size());
1767     return this->local_values_[sym].output_symtab_index();
1768   }
1769
1770   // Return the index of local symbol SYM in the dynamic symbol
1771   // table.  A value of -1U means that the symbol is not being output.
1772   unsigned int
1773   dynsym_index(unsigned int sym) const
1774   {
1775     gold_assert(sym < this->local_values_.size());
1776     return this->local_values_[sym].output_dynsym_index();
1777   }
1778
1779   // Return the input section index of local symbol SYM.
1780   unsigned int
1781   local_symbol_input_shndx(unsigned int sym, bool* is_ordinary) const
1782   {
1783     gold_assert(sym < this->local_values_.size());
1784     return this->local_values_[sym].input_shndx(is_ordinary);
1785   }
1786
1787   // Record that local symbol SYM must be in the output symbol table.
1788   void
1789   set_must_have_output_symtab_entry(unsigned int sym)
1790   {
1791     gold_assert(sym < this->local_values_.size());
1792     this->local_values_[sym].set_must_have_output_symtab_entry();
1793   }
1794
1795   // Record that local symbol SYM needs a dynamic symbol entry.
1796   void
1797   set_needs_output_dynsym_entry(unsigned int sym)
1798   {
1799     gold_assert(sym < this->local_values_.size());
1800     this->local_values_[sym].set_needs_output_dynsym_entry();
1801   }
1802
1803   // Return whether the local symbol SYMNDX has a GOT offset.
1804   // For TLS symbols, the GOT entry will hold its tp-relative offset.
1805   bool
1806   local_has_got_offset(unsigned int symndx, unsigned int got_type) const
1807   {
1808     Local_got_offsets::const_iterator p =
1809         this->local_got_offsets_.find(symndx);
1810     return (p != this->local_got_offsets_.end()
1811             && p->second->get_offset(got_type) != -1U);
1812   }
1813
1814   // Return the GOT offset of the local symbol SYMNDX.
1815   unsigned int
1816   local_got_offset(unsigned int symndx, unsigned int got_type) const
1817   {
1818     Local_got_offsets::const_iterator p =
1819         this->local_got_offsets_.find(symndx);
1820     gold_assert(p != this->local_got_offsets_.end());
1821     unsigned int off = p->second->get_offset(got_type);
1822     gold_assert(off != -1U);
1823     return off;
1824   }
1825
1826   // Set the GOT offset of the local symbol SYMNDX to GOT_OFFSET.
1827   void
1828   set_local_got_offset(unsigned int symndx, unsigned int got_type,
1829                        unsigned int got_offset)
1830   {
1831     Local_got_offsets::const_iterator p =
1832         this->local_got_offsets_.find(symndx);
1833     if (p != this->local_got_offsets_.end())
1834       p->second->set_offset(got_type, got_offset);
1835     else
1836       {
1837         Got_offset_list* g = new Got_offset_list(got_type, got_offset);
1838         std::pair<Local_got_offsets::iterator, bool> ins =
1839             this->local_got_offsets_.insert(std::make_pair(symndx, g));
1840         gold_assert(ins.second);
1841       }
1842   }
1843
1844   // Return whether the local symbol SYMNDX has a PLT offset.
1845   bool
1846   local_has_plt_offset(unsigned int symndx) const;
1847
1848   // Return the PLT offset for a local symbol.  It is an error to call
1849   // this if it doesn't have one.
1850   unsigned int
1851   local_plt_offset(unsigned int symndx) const;
1852
1853   // Set the PLT offset of the local symbol SYMNDX.
1854   void
1855   set_local_plt_offset(unsigned int symndx, unsigned int plt_offset);
1856
1857   // Get the offset of input section SHNDX within its output section.
1858   // This is -1 if the input section requires a special mapping, such
1859   // as a merge section.  The output section can be found in the
1860   // output_sections_ field of the parent class Relobj.
1861   Address
1862   get_output_section_offset(unsigned int shndx) const
1863   {
1864     gold_assert(shndx < this->section_offsets_.size());
1865     return this->section_offsets_[shndx];
1866   }
1867
1868   // Return the name of the symbol that spans the given offset in the
1869   // specified section in this object.  This is used only for error
1870   // messages and is not particularly efficient.
1871   bool
1872   get_symbol_location_info(unsigned int shndx, off_t offset,
1873                            Symbol_location_info* info);
1874
1875   // Look for a kept section corresponding to the given discarded section,
1876   // and return its output address.  This is used only for relocations in
1877   // debugging sections.
1878   Address
1879   map_to_kept_section(unsigned int shndx, bool* found) const;
1880
1881   // Compute final local symbol value.  R_SYM is the local symbol index.
1882   // LV_IN points to a local symbol value containing the input value.
1883   // LV_OUT points to a local symbol value storing the final output value,
1884   // which must not be a merged symbol value since before calling this
1885   // method to avoid memory leak.  SYMTAB points to a symbol table.
1886   //
1887   // The method returns a status code at return.  If the return status is
1888   // CFLV_OK, *LV_OUT contains the final value.  If the return status is
1889   // CFLV_ERROR, *LV_OUT is 0.  If the return status is CFLV_DISCARDED,
1890   // *LV_OUT is not modified.
1891   Compute_final_local_value_status
1892   compute_final_local_value(unsigned int r_sym,
1893                             const Symbol_value<size>* lv_in,
1894                             Symbol_value<size>* lv_out,
1895                             const Symbol_table* symtab);
1896
1897  protected:
1898   typedef typename Sized_relobj_base<size, big_endian>::Output_sections
1899       Output_sections;
1900
1901   // Set up.
1902   virtual void
1903   do_setup();
1904
1905   // Read the symbols.
1906   void
1907   do_read_symbols(Read_symbols_data*);
1908
1909   // Return the number of local symbols.
1910   unsigned int
1911   do_local_symbol_count() const
1912   { return this->local_symbol_count_; }
1913
1914   // Lay out the input sections.
1915   void
1916   do_layout(Symbol_table*, Layout*, Read_symbols_data*);
1917
1918   // Layout sections whose layout was deferred while waiting for
1919   // input files from a plugin.
1920   void
1921   do_layout_deferred_sections(Layout*);
1922
1923   // Add the symbols to the symbol table.
1924   void
1925   do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*);
1926
1927   Archive::Should_include
1928   do_should_include_member(Symbol_table* symtab, Layout*, Read_symbols_data*,
1929                            std::string* why);
1930
1931   // Iterate over global symbols, calling a visitor class V for each.
1932   void
1933   do_for_all_global_symbols(Read_symbols_data* sd,
1934                             Library_base::Symbol_visitor_base* v);
1935
1936   // Iterate over local symbols, calling a visitor class V for each GOT offset
1937   // associated with a local symbol.
1938   void
1939   do_for_all_local_got_entries(Got_offset_list::Visitor* v) const;
1940
1941   // Read the relocs.
1942   void
1943   do_read_relocs(Read_relocs_data*);
1944
1945   // Process the relocs to find list of referenced sections. Used only
1946   // during garbage collection.
1947   void
1948   do_gc_process_relocs(Symbol_table*, Layout*, Read_relocs_data*);
1949
1950   // Scan the relocs and adjust the symbol table.
1951   void
1952   do_scan_relocs(Symbol_table*, Layout*, Read_relocs_data*);
1953
1954   // Count the local symbols.
1955   void
1956   do_count_local_symbols(Stringpool_template<char>*,
1957                             Stringpool_template<char>*);
1958
1959   // Finalize the local symbols.
1960   unsigned int
1961   do_finalize_local_symbols(unsigned int, off_t, Symbol_table*);
1962
1963   // Set the offset where local dynamic symbol information will be stored.
1964   unsigned int
1965   do_set_local_dynsym_indexes(unsigned int);
1966
1967   // Set the offset where local dynamic symbol information will be stored.
1968   unsigned int
1969   do_set_local_dynsym_offset(off_t);
1970
1971   // Relocate the input sections and write out the local symbols.
1972   void
1973   do_relocate(const Symbol_table* symtab, const Layout*, Output_file* of);
1974
1975   // Get the size of a section.
1976   uint64_t
1977   do_section_size(unsigned int shndx)
1978   { return this->elf_file_.section_size(shndx); }
1979
1980   // Get the name of a section.
1981   std::string
1982   do_section_name(unsigned int shndx)
1983   { return this->elf_file_.section_name(shndx); }
1984
1985   // Return the location of the contents of a section.
1986   Object::Location
1987   do_section_contents(unsigned int shndx)
1988   { return this->elf_file_.section_contents(shndx); }
1989
1990   // Return section flags.
1991   uint64_t
1992   do_section_flags(unsigned int shndx);
1993
1994   // Return section entsize.
1995   uint64_t
1996   do_section_entsize(unsigned int shndx);
1997
1998   // Return section address.
1999   uint64_t
2000   do_section_address(unsigned int shndx)
2001   { return this->elf_file_.section_addr(shndx); }
2002
2003   // Return section type.
2004   unsigned int
2005   do_section_type(unsigned int shndx)
2006   { return this->elf_file_.section_type(shndx); }
2007
2008   // Return the section link field.
2009   unsigned int
2010   do_section_link(unsigned int shndx)
2011   { return this->elf_file_.section_link(shndx); }
2012
2013   // Return the section info field.
2014   unsigned int
2015   do_section_info(unsigned int shndx)
2016   { return this->elf_file_.section_info(shndx); }
2017
2018   // Return the section alignment.
2019   uint64_t
2020   do_section_addralign(unsigned int shndx)
2021   { return this->elf_file_.section_addralign(shndx); }
2022
2023   // Return the Xindex structure to use.
2024   Xindex*
2025   do_initialize_xindex();
2026
2027   // Get symbol counts.
2028   void
2029   do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
2030
2031   // Get the global symbols.
2032   const Symbols*
2033   do_get_global_symbols() const
2034   { return &this->symbols_; }
2035
2036   // Get the offset of a section.
2037   uint64_t
2038   do_output_section_offset(unsigned int shndx) const
2039   {
2040     Address off = this->get_output_section_offset(shndx);
2041     if (off == invalid_address)
2042       return -1ULL;
2043     return off;
2044   }
2045
2046   // Set the offset of a section.
2047   void
2048   do_set_section_offset(unsigned int shndx, uint64_t off)
2049   {
2050     gold_assert(shndx < this->section_offsets_.size());
2051     this->section_offsets_[shndx] =
2052       (off == static_cast<uint64_t>(-1)
2053        ? invalid_address
2054        : convert_types<Address, uint64_t>(off));
2055   }
2056
2057   // Adjust a section index if necessary.
2058   unsigned int
2059   adjust_shndx(unsigned int shndx)
2060   {
2061     if (shndx >= elfcpp::SHN_LORESERVE)
2062       shndx += this->elf_file_.large_shndx_offset();
2063     return shndx;
2064   }
2065
2066   // Initialize input to output maps for section symbols in merged
2067   // sections.
2068   void
2069   initialize_input_to_output_maps();
2070
2071   // Free the input to output maps for section symbols in merged
2072   // sections.
2073   void
2074   free_input_to_output_maps();
2075
2076   // Return symbol table section index.
2077   unsigned int
2078   symtab_shndx() const
2079   { return this->symtab_shndx_; }
2080
2081   // Allow a child class to access the ELF file.
2082   elfcpp::Elf_file<size, big_endian, Object>*
2083   elf_file()
2084   { return &this->elf_file_; }
2085   
2086   // Allow a child class to access the local values.
2087   Local_values*
2088   local_values()
2089   { return &this->local_values_; }
2090
2091   // Views and sizes when relocating.
2092   struct View_size
2093   {
2094     unsigned char* view;
2095     typename elfcpp::Elf_types<size>::Elf_Addr address;
2096     off_t offset;
2097     section_size_type view_size;
2098     bool is_input_output_view;
2099     bool is_postprocessing_view;
2100   };
2101
2102   typedef std::vector<View_size> Views;
2103
2104   // This may be overriden by a child class.
2105   virtual void
2106   do_relocate_sections(const Symbol_table* symtab, const Layout* layout,
2107                        const unsigned char* pshdrs, Output_file* of,
2108                        Views* pviews);
2109
2110   // Allow a child to set output local symbol count.
2111   void
2112   set_output_local_symbol_count(unsigned int value)
2113   { this->output_local_symbol_count_ = value; }
2114
2115   // Return TRUE if the section is a compressed debug section, and set
2116   // *UNCOMPRESSED_SIZE to the size of the uncompressed data.
2117   bool
2118   do_section_is_compressed(unsigned int shndx,
2119                            section_size_type* uncompressed_size) const
2120   {
2121     if (this->compressed_sections_ == NULL)
2122       return false;
2123     Compressed_section_map::const_iterator p =
2124         this->compressed_sections_->find(shndx);
2125     if (p != this->compressed_sections_->end())
2126       {
2127         if (uncompressed_size != NULL)
2128           *uncompressed_size = p->second;
2129         return true;
2130       }
2131     return false;
2132   }
2133
2134  private:
2135   // For convenience.
2136   typedef Sized_relobj<size, big_endian> This;
2137   static const int ehdr_size = elfcpp::Elf_sizes<size>::ehdr_size;
2138   static const int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
2139   static const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
2140   typedef elfcpp::Shdr<size, big_endian> Shdr;
2141
2142   // To keep track of discarded comdat sections, we need to map a member
2143   // section index to the object and section index of the corresponding
2144   // kept section.
2145   struct Kept_comdat_section
2146   {
2147     Kept_comdat_section(Relobj* a_object, unsigned int a_shndx)
2148       : object(a_object), shndx(a_shndx)
2149     { }
2150     Relobj* object;
2151     unsigned int shndx;
2152   };
2153   typedef std::map<unsigned int, Kept_comdat_section>
2154       Kept_comdat_section_table;
2155
2156   // Find the SHT_SYMTAB section, given the section headers.
2157   void
2158   find_symtab(const unsigned char* pshdrs);
2159
2160   // Return whether SHDR has the right flags for a GNU style exception
2161   // frame section.
2162   bool
2163   check_eh_frame_flags(const elfcpp::Shdr<size, big_endian>* shdr) const;
2164
2165   // Return whether there is a section named .eh_frame which might be
2166   // a GNU style exception frame section.
2167   bool
2168   find_eh_frame(const unsigned char* pshdrs, const char* names,
2169                 section_size_type names_size) const;
2170
2171   // Whether to include a section group in the link.
2172   bool
2173   include_section_group(Symbol_table*, Layout*, unsigned int, const char*,
2174                         const unsigned char*, const char*, section_size_type,
2175                         std::vector<bool>*);
2176
2177   // Whether to include a linkonce section in the link.
2178   bool
2179   include_linkonce_section(Layout*, unsigned int, const char*,
2180                            const elfcpp::Shdr<size, big_endian>&);
2181
2182   // Layout an input section.
2183   void
2184   layout_section(Layout* layout, unsigned int shndx, const char* name,
2185                  typename This::Shdr& shdr, unsigned int reloc_shndx,
2186                  unsigned int reloc_type);
2187
2188   // Write section data to the output file.  Record the views and
2189   // sizes in VIEWS for use when relocating.
2190   void
2191   write_sections(const unsigned char* pshdrs, Output_file*, Views*);
2192
2193   // Relocate the sections in the output file.
2194   void
2195   relocate_sections(const Symbol_table* symtab, const Layout* layout,
2196                     const unsigned char* pshdrs, Output_file* of,
2197                     Views* pviews)
2198   { this->do_relocate_sections(symtab, layout, pshdrs, of, pviews); }
2199
2200   // Scan the input relocations for --emit-relocs.
2201   void
2202   emit_relocs_scan(Symbol_table*, Layout*, const unsigned char* plocal_syms,
2203                    const Read_relocs_data::Relocs_list::iterator&);
2204
2205   // Scan the input relocations for --emit-relocs, templatized on the
2206   // type of the relocation section.
2207   template<int sh_type>
2208   void
2209   emit_relocs_scan_reltype(Symbol_table*, Layout*,
2210                            const unsigned char* plocal_syms,
2211                            const Read_relocs_data::Relocs_list::iterator&,
2212                            Relocatable_relocs*);
2213
2214   // Emit the relocs for --emit-relocs.
2215   void
2216   emit_relocs(const Relocate_info<size, big_endian>*, unsigned int,
2217               unsigned int sh_type, const unsigned char* prelocs,
2218               size_t reloc_count, Output_section*, Address output_offset,
2219               unsigned char* view, Address address,
2220               section_size_type view_size,
2221               unsigned char* reloc_view, section_size_type reloc_view_size);
2222
2223   // Emit the relocs for --emit-relocs, templatized on the type of the
2224   // relocation section.
2225   template<int sh_type>
2226   void
2227   emit_relocs_reltype(const Relocate_info<size, big_endian>*, unsigned int,
2228                       const unsigned char* prelocs, size_t reloc_count,
2229                       Output_section*, Address output_offset,
2230                       unsigned char* view, Address address,
2231                       section_size_type view_size,
2232                       unsigned char* reloc_view,
2233                       section_size_type reloc_view_size);
2234
2235   // Scan the input relocations for --incremental.
2236   void
2237   incremental_relocs_scan(const Read_relocs_data::Relocs_list::iterator&);
2238
2239   // Scan the input relocations for --incremental, templatized on the
2240   // type of the relocation section.
2241   template<int sh_type>
2242   void
2243   incremental_relocs_scan_reltype(
2244       const Read_relocs_data::Relocs_list::iterator&);
2245
2246   void
2247   incremental_relocs_write(const Relocate_info<size, big_endian>*,
2248                            unsigned int sh_type,
2249                            const unsigned char* prelocs,
2250                            size_t reloc_count,
2251                            Output_section*,
2252                            Address output_offset,
2253                            Output_file*);
2254
2255   template<int sh_type>
2256   void
2257   incremental_relocs_write_reltype(const Relocate_info<size, big_endian>*,
2258                                    const unsigned char* prelocs,
2259                                    size_t reloc_count,
2260                                    Output_section*,
2261                                    Address output_offset,
2262                                    Output_file*);
2263
2264   // A type shared by split_stack_adjust_reltype and find_functions.
2265   typedef std::map<section_offset_type, section_size_type> Function_offsets;
2266
2267   // Check for -fsplit-stack routines calling non-split-stack routines.
2268   void
2269   split_stack_adjust(const Symbol_table*, const unsigned char* pshdrs,
2270                      unsigned int sh_type, unsigned int shndx,
2271                      const unsigned char* prelocs, size_t reloc_count,
2272                      unsigned char* view, section_size_type view_size,
2273                      Reloc_symbol_changes** reloc_map);
2274
2275   template<int sh_type>
2276   void
2277   split_stack_adjust_reltype(const Symbol_table*, const unsigned char* pshdrs,
2278                              unsigned int shndx, const unsigned char* prelocs,
2279                              size_t reloc_count, unsigned char* view,
2280                              section_size_type view_size,
2281                              Reloc_symbol_changes** reloc_map);
2282
2283   // Find all functions in a section.
2284   void
2285   find_functions(const unsigned char* pshdrs, unsigned int shndx,
2286                  Function_offsets*);
2287
2288   // Write out the local symbols.
2289   void
2290   write_local_symbols(Output_file*,
2291                       const Stringpool_template<char>*,
2292                       const Stringpool_template<char>*,
2293                       Output_symtab_xindex*,
2294                       Output_symtab_xindex*,
2295                       off_t);
2296
2297   // Record a mapping from discarded section SHNDX to the corresponding
2298   // kept section.
2299   void
2300   set_kept_comdat_section(unsigned int shndx, Relobj* kept_object,
2301                           unsigned int kept_shndx)
2302   {
2303     Kept_comdat_section kept(kept_object, kept_shndx);
2304     this->kept_comdat_sections_.insert(std::make_pair(shndx, kept));
2305   }
2306
2307   // Find the kept section corresponding to the discarded section
2308   // SHNDX.  Return true if found.
2309   bool
2310   get_kept_comdat_section(unsigned int shndx, Relobj** kept_object,
2311                           unsigned int* kept_shndx) const
2312   {
2313     typename Kept_comdat_section_table::const_iterator p =
2314       this->kept_comdat_sections_.find(shndx);
2315     if (p == this->kept_comdat_sections_.end())
2316       return false;
2317     *kept_object = p->second.object;
2318     *kept_shndx = p->second.shndx;
2319     return true;
2320   }
2321
2322   // Compute final local symbol value.  R_SYM is the local symbol index.
2323   // LV_IN points to a local symbol value containing the input value.
2324   // LV_OUT points to a local symbol value storing the final output value,
2325   // which must not be a merged symbol value since before calling this
2326   // method to avoid memory leak.  RELOCATABLE indicates whether we are
2327   // linking a relocatable output.  OUT_SECTIONS is an array of output
2328   // sections.  OUT_OFFSETS is an array of offsets of the sections.  SYMTAB
2329   // points to a symbol table.
2330   //
2331   // The method returns a status code at return.  If the return status is
2332   // CFLV_OK, *LV_OUT contains the final value.  If the return status is
2333   // CFLV_ERROR, *LV_OUT is 0.  If the return status is CFLV_DISCARDED,
2334   // *LV_OUT is not modified.
2335   inline Compute_final_local_value_status
2336   compute_final_local_value_internal(unsigned int r_sym,
2337                                      const Symbol_value<size>* lv_in,
2338                                      Symbol_value<size>* lv_out,
2339                                      bool relocatable,
2340                                      const Output_sections& out_sections,
2341                                      const std::vector<Address>& out_offsets,
2342                                      const Symbol_table* symtab);
2343
2344   // The GOT offsets of local symbols. This map also stores GOT offsets
2345   // for tp-relative offsets for TLS symbols.
2346   typedef Unordered_map<unsigned int, Got_offset_list*> Local_got_offsets;
2347
2348   // The PLT offsets of local symbols.
2349   typedef Unordered_map<unsigned int, unsigned int> Local_plt_offsets;
2350
2351   // Saved information for sections whose layout was deferred.
2352   struct Deferred_layout
2353   {
2354     static const int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
2355     Deferred_layout(unsigned int shndx, const char* name,
2356                     const unsigned char* pshdr,
2357                     unsigned int reloc_shndx, unsigned int reloc_type)
2358       : shndx_(shndx), name_(name), reloc_shndx_(reloc_shndx),
2359         reloc_type_(reloc_type)
2360     {
2361       memcpy(this->shdr_data_, pshdr, shdr_size);
2362     }
2363     unsigned int shndx_;
2364     std::string name_;
2365     unsigned int reloc_shndx_;
2366     unsigned int reloc_type_;
2367     unsigned char shdr_data_[shdr_size];
2368   };
2369
2370   // General access to the ELF file.
2371   elfcpp::Elf_file<size, big_endian, Object> elf_file_;
2372   // Index of SHT_SYMTAB section.
2373   unsigned int symtab_shndx_;
2374   // The number of local symbols.
2375   unsigned int local_symbol_count_;
2376   // The number of local symbols which go into the output file.
2377   unsigned int output_local_symbol_count_;
2378   // The number of local symbols which go into the output file's dynamic
2379   // symbol table.
2380   unsigned int output_local_dynsym_count_;
2381   // The entries in the symbol table for the external symbols.
2382   Symbols symbols_;
2383   // Number of symbols defined in object file itself.
2384   size_t defined_count_;
2385   // File offset for local symbols (relative to start of symbol table).
2386   off_t local_symbol_offset_;
2387   // File offset for local dynamic symbols (absolute).
2388   off_t local_dynsym_offset_;
2389   // Values of local symbols.
2390   Local_values local_values_;
2391   // GOT offsets for local non-TLS symbols, and tp-relative offsets
2392   // for TLS symbols, indexed by symbol number.
2393   Local_got_offsets local_got_offsets_;
2394   // PLT offsets for local symbols.
2395   Local_plt_offsets local_plt_offsets_;
2396   // For each input section, the offset of the input section in its
2397   // output section.  This is INVALID_ADDRESS if the input section requires a
2398   // special mapping.
2399   std::vector<Address> section_offsets_;
2400   // Table mapping discarded comdat sections to corresponding kept sections.
2401   Kept_comdat_section_table kept_comdat_sections_;
2402   // Whether this object has a GNU style .eh_frame section.
2403   bool has_eh_frame_;
2404   // If this object has a GNU style .eh_frame section that is discarded in
2405   // output, record the index here.  Otherwise it is -1U.
2406   unsigned int discarded_eh_frame_shndx_;
2407   // The list of sections whose layout was deferred.
2408   std::vector<Deferred_layout> deferred_layout_;
2409   // The list of relocation sections whose layout was deferred.
2410   std::vector<Deferred_layout> deferred_layout_relocs_;
2411   // For compressed debug sections, map section index to uncompressed size.
2412   Compressed_section_map* compressed_sections_;
2413 };
2414
2415 // A class to manage the list of all objects.
2416
2417 class Input_objects
2418 {
2419  public:
2420   Input_objects()
2421     : relobj_list_(), dynobj_list_(), sonames_(), cref_(NULL)
2422   { }
2423
2424   // The type of the list of input relocateable objects.
2425   typedef std::vector<Relobj*> Relobj_list;
2426   typedef Relobj_list::const_iterator Relobj_iterator;
2427
2428   // The type of the list of input dynamic objects.
2429   typedef std::vector<Dynobj*> Dynobj_list;
2430   typedef Dynobj_list::const_iterator Dynobj_iterator;
2431
2432   // Add an object to the list.  Return true if all is well, or false
2433   // if this object should be ignored.
2434   bool
2435   add_object(Object*);
2436
2437   // Start processing an archive.
2438   void
2439   archive_start(Archive*);
2440
2441   // Stop processing an archive.
2442   void
2443   archive_stop(Archive*);
2444
2445   // For each dynamic object, check whether we've seen all of its
2446   // explicit dependencies.
2447   void
2448   check_dynamic_dependencies() const;
2449
2450   // Return whether an object was found in the system library
2451   // directory.
2452   bool
2453   found_in_system_library_directory(const Object*) const;
2454
2455   // Print symbol counts.
2456   void
2457   print_symbol_counts(const Symbol_table*) const;
2458
2459   // Print a cross reference table.
2460   void
2461   print_cref(const Symbol_table*, FILE*) const;
2462
2463   // Iterate over all regular objects.
2464
2465   Relobj_iterator
2466   relobj_begin() const
2467   { return this->relobj_list_.begin(); }
2468
2469   Relobj_iterator
2470   relobj_end() const
2471   { return this->relobj_list_.end(); }
2472
2473   // Iterate over all dynamic objects.
2474
2475   Dynobj_iterator
2476   dynobj_begin() const
2477   { return this->dynobj_list_.begin(); }
2478
2479   Dynobj_iterator
2480   dynobj_end() const
2481   { return this->dynobj_list_.end(); }
2482
2483   // Return whether we have seen any dynamic objects.
2484   bool
2485   any_dynamic() const
2486   { return !this->dynobj_list_.empty(); }
2487
2488   // Return the number of non dynamic objects.
2489   int
2490   number_of_relobjs() const
2491   { return this->relobj_list_.size(); }
2492
2493   // Return the number of input objects.
2494   int
2495   number_of_input_objects() const
2496   { return this->relobj_list_.size() + this->dynobj_list_.size(); }
2497
2498  private:
2499   Input_objects(const Input_objects&);
2500   Input_objects& operator=(const Input_objects&);
2501
2502   // The list of ordinary objects included in the link.
2503   Relobj_list relobj_list_;
2504   // The list of dynamic objects included in the link.
2505   Dynobj_list dynobj_list_;
2506   // SONAMEs that we have seen.
2507   Unordered_set<std::string> sonames_;
2508   // Manage cross-references if requested.
2509   Cref* cref_;
2510 };
2511
2512 // Some of the information we pass to the relocation routines.  We
2513 // group this together to avoid passing a dozen different arguments.
2514
2515 template<int size, bool big_endian>
2516 struct Relocate_info
2517 {
2518   // Symbol table.
2519   const Symbol_table* symtab;
2520   // Layout.
2521   const Layout* layout;
2522   // Object being relocated.
2523   Sized_relobj<size, big_endian>* object;
2524   // Section index of relocation section.
2525   unsigned int reloc_shndx;
2526   // Section header of relocation section.
2527   const unsigned char* reloc_shdr;
2528   // Section index of section being relocated.
2529   unsigned int data_shndx;
2530   // Section header of data section.
2531   const unsigned char* data_shdr;
2532
2533   // Return a string showing the location of a relocation.  This is
2534   // only used for error messages.
2535   std::string
2536   location(size_t relnum, off_t reloffset) const;
2537 };
2538
2539 // This is used to represent a section in an object and is used as the
2540 // key type for various section maps.
2541 typedef std::pair<Object*, unsigned int> Section_id;
2542
2543 // This is similar to Section_id but is used when the section
2544 // pointers are const.
2545 typedef std::pair<const Object*, unsigned int> Const_section_id;
2546
2547 // The hash value is based on the address of an object in memory during
2548 // linking.  It is okay to use this for looking up sections but never use
2549 // this in an unordered container that we want to traverse in a repeatable
2550 // manner.
2551
2552 struct Section_id_hash
2553 {
2554   size_t operator()(const Section_id& loc) const
2555   { return reinterpret_cast<uintptr_t>(loc.first) ^ loc.second; }
2556 };
2557
2558 struct Const_section_id_hash
2559 {
2560   size_t operator()(const Const_section_id& loc) const
2561   { return reinterpret_cast<uintptr_t>(loc.first) ^ loc.second; }
2562 };
2563
2564 // Return whether INPUT_FILE contains an ELF object start at file
2565 // offset OFFSET.  This sets *START to point to a view of the start of
2566 // the file.  It sets *READ_SIZE to the number of bytes in the view.
2567
2568 extern bool
2569 is_elf_object(Input_file* input_file, off_t offset,
2570               const unsigned char** start, int* read_size);
2571
2572 // Return an Object appropriate for the input file.  P is BYTES long,
2573 // and holds the ELF header.  If PUNCONFIGURED is not NULL, then if
2574 // this sees an object the linker is not configured to support, it
2575 // sets *PUNCONFIGURED to true and returns NULL without giving an
2576 // error message.
2577
2578 extern Object*
2579 make_elf_object(const std::string& name, Input_file*,
2580                 off_t offset, const unsigned char* p,
2581                 section_offset_type bytes, bool* punconfigured);
2582
2583 } // end namespace gold
2584
2585 #endif // !defined(GOLD_OBJECT_H)