d9be4b52e3e920ebe8370adee6556e182c7dd3f5
[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_file 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_file.
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       first_dyn_reloc_(0),
934       dyn_reloc_count_(0)
935   { }
936
937   // During garbage collection, the Read_symbols_data pass for 
938   // each object is stored as layout needs to be done after 
939   // reloc processing.
940   Symbols_data* 
941   get_symbols_data()
942   { return this->sd_; }
943
944   // Decides which section names have to be included in the worklist
945   // as roots.
946   bool
947   is_section_name_included(const char* name);
948  
949   void
950   copy_symbols_data(Symbols_data* gc_sd, Read_symbols_data* sd,
951                     unsigned int section_header_size);
952
953   void
954   set_symbols_data(Symbols_data* sd)
955   { this->sd_ = sd; }
956
957   // During garbage collection, the Read_relocs pass for all objects 
958   // is done before scanning the relocs.  In that case, this->rd_ is
959   // used to store the information from Read_relocs for each object.
960   // This data is also used to compute the list of relevant sections.
961   Read_relocs_data*
962   get_relocs_data()
963   { return this->rd_; }
964
965   void
966   set_relocs_data(Read_relocs_data* rd)
967   { this->rd_ = rd; }
968
969   virtual bool
970   is_output_section_offset_invalid(unsigned int shndx) const = 0;
971
972   // Read the relocs.
973   void
974   read_relocs(Read_relocs_data* rd)
975   { return this->do_read_relocs(rd); }
976
977   // Process the relocs, during garbage collection only.
978   void
979   gc_process_relocs(Symbol_table* symtab, Layout* layout, Read_relocs_data* rd)
980   { return this->do_gc_process_relocs(symtab, layout, rd); }
981
982   // Scan the relocs and adjust the symbol table.
983   void
984   scan_relocs(Symbol_table* symtab, Layout* layout, Read_relocs_data* rd)
985   { return this->do_scan_relocs(symtab, layout, rd); }
986
987   // The number of local symbols in the input symbol table.
988   virtual unsigned int
989   local_symbol_count() const
990   { return this->do_local_symbol_count(); }
991
992   // The number of local symbols in the output symbol table.
993   virtual unsigned int
994   output_local_symbol_count() const
995   { return this->do_output_local_symbol_count(); }
996
997   // The file offset for local symbols in the output symbol table.
998   virtual off_t
999   local_symbol_offset() const
1000   { return this->do_local_symbol_offset(); }
1001
1002   // Initial local symbol processing: count the number of local symbols
1003   // in the output symbol table and dynamic symbol table; add local symbol
1004   // names to *POOL and *DYNPOOL.
1005   void
1006   count_local_symbols(Stringpool_template<char>* pool,
1007                       Stringpool_template<char>* dynpool)
1008   { return this->do_count_local_symbols(pool, dynpool); }
1009
1010   // Set the values of the local symbols, set the output symbol table
1011   // indexes for the local variables, and set the offset where local
1012   // symbol information will be stored. Returns the new local symbol index.
1013   unsigned int
1014   finalize_local_symbols(unsigned int index, off_t off, Symbol_table* symtab)
1015   { return this->do_finalize_local_symbols(index, off, symtab); }
1016
1017   // Set the output dynamic symbol table indexes for the local variables.
1018   unsigned int
1019   set_local_dynsym_indexes(unsigned int index)
1020   { return this->do_set_local_dynsym_indexes(index); }
1021
1022   // Set the offset where local dynamic symbol information will be stored.
1023   unsigned int
1024   set_local_dynsym_offset(off_t off)
1025   { return this->do_set_local_dynsym_offset(off); }
1026
1027   // Record a dynamic relocation against an input section from this object.
1028   void
1029   add_dyn_reloc(unsigned int index)
1030   {
1031     if (this->dyn_reloc_count_ == 0)
1032       this->first_dyn_reloc_ = index;
1033     ++this->dyn_reloc_count_;
1034   }
1035
1036   // Return the index of the first dynamic relocation.
1037   unsigned int
1038   first_dyn_reloc() const
1039   { return this->first_dyn_reloc_; }
1040
1041   // Return the count of dynamic relocations.
1042   unsigned int
1043   dyn_reloc_count() const
1044   { return this->dyn_reloc_count_; }
1045
1046   // Relocate the input sections and write out the local symbols.
1047   void
1048   relocate(const Symbol_table* symtab, const Layout* layout, Output_file* of)
1049   { return this->do_relocate(symtab, layout, of); }
1050
1051   // Return whether an input section is being included in the link.
1052   bool
1053   is_section_included(unsigned int shndx) const
1054   {
1055     gold_assert(shndx < this->output_sections_.size());
1056     return this->output_sections_[shndx] != NULL;
1057   }
1058
1059   // The the output section of the input section with index SHNDX.
1060   // This is only used currently to remove a section from the link in
1061   // relaxation.
1062   void
1063   set_output_section(unsigned int shndx, Output_section* os)
1064   {
1065     gold_assert(shndx < this->output_sections_.size());
1066     this->output_sections_[shndx] = os;
1067   }
1068   
1069   // Set the offset of an input section within its output section.
1070   void
1071   set_section_offset(unsigned int shndx, uint64_t off)
1072   { this->do_set_section_offset(shndx, off); }
1073
1074   // Return true if we need to wait for output sections to be written
1075   // before we can apply relocations.  This is true if the object has
1076   // any relocations for sections which require special handling, such
1077   // as the exception frame section.
1078   bool
1079   relocs_must_follow_section_writes() const
1080   { return this->relocs_must_follow_section_writes_; }
1081
1082   // Return the object merge map.
1083   Object_merge_map*
1084   merge_map() const
1085   { return this->object_merge_map_; }
1086
1087   // Set the object merge map.
1088   void
1089   set_merge_map(Object_merge_map* object_merge_map)
1090   {
1091     gold_assert(this->object_merge_map_ == NULL);
1092     this->object_merge_map_ = object_merge_map;
1093   }
1094
1095   // Record the relocatable reloc info for an input reloc section.
1096   void
1097   set_relocatable_relocs(unsigned int reloc_shndx, Relocatable_relocs* rr)
1098   {
1099     gold_assert(reloc_shndx < this->shnum());
1100     (*this->map_to_relocatable_relocs_)[reloc_shndx] = rr;
1101   }
1102
1103   // Get the relocatable reloc info for an input reloc section.
1104   Relocatable_relocs*
1105   relocatable_relocs(unsigned int reloc_shndx)
1106   {
1107     gold_assert(reloc_shndx < this->shnum());
1108     return (*this->map_to_relocatable_relocs_)[reloc_shndx];
1109   }
1110
1111   // Layout sections whose layout was deferred while waiting for
1112   // input files from a plugin.
1113   void
1114   layout_deferred_sections(Layout* layout)
1115   { this->do_layout_deferred_sections(layout); }
1116
1117   // Return the index of the first incremental relocation for symbol SYMNDX.
1118   virtual unsigned int
1119   do_get_incremental_reloc_base(unsigned int symndx) const
1120   { return this->reloc_bases_[symndx]; }
1121
1122   // Return the number of incremental relocations for symbol SYMNDX.
1123   virtual unsigned int
1124   do_get_incremental_reloc_count(unsigned int symndx) const
1125   { return this->reloc_counts_[symndx]; }
1126
1127  protected:
1128   // The output section to be used for each input section, indexed by
1129   // the input section number.  The output section is NULL if the
1130   // input section is to be discarded.
1131   typedef std::vector<Output_section*> Output_sections;
1132
1133   // Read the relocs--implemented by child class.
1134   virtual void
1135   do_read_relocs(Read_relocs_data*) = 0;
1136
1137   // Process the relocs--implemented by child class.
1138   virtual void
1139   do_gc_process_relocs(Symbol_table*, Layout*, Read_relocs_data*) = 0;
1140
1141   // Scan the relocs--implemented by child class.
1142   virtual void
1143   do_scan_relocs(Symbol_table*, Layout*, Read_relocs_data*) = 0;
1144
1145   // Return the number of local symbols--implemented by child class.
1146   virtual unsigned int
1147   do_local_symbol_count() const = 0;
1148
1149   // Return the number of output local symbols--implemented by child class.
1150   virtual unsigned int
1151   do_output_local_symbol_count() const = 0;
1152
1153   // Return the file offset for local symbols--implemented by child class.
1154   virtual off_t
1155   do_local_symbol_offset() const = 0;
1156
1157   // Count local symbols--implemented by child class.
1158   virtual void
1159   do_count_local_symbols(Stringpool_template<char>*,
1160                          Stringpool_template<char>*) = 0;
1161
1162   // Finalize the local symbols.  Set the output symbol table indexes
1163   // for the local variables, and set the offset where local symbol
1164   // information will be stored.
1165   virtual unsigned int
1166   do_finalize_local_symbols(unsigned int, off_t, Symbol_table*) = 0;
1167
1168   // Set the output dynamic symbol table indexes for the local variables.
1169   virtual unsigned int
1170   do_set_local_dynsym_indexes(unsigned int) = 0;
1171
1172   // Set the offset where local dynamic symbol information will be stored.
1173   virtual unsigned int
1174   do_set_local_dynsym_offset(off_t) = 0;
1175
1176   // Relocate the input sections and write out the local
1177   // symbols--implemented by child class.
1178   virtual void
1179   do_relocate(const Symbol_table* symtab, const Layout*, Output_file* of) = 0;
1180
1181   // Set the offset of a section--implemented by child class.
1182   virtual void
1183   do_set_section_offset(unsigned int shndx, uint64_t off) = 0;
1184
1185   // Layout sections whose layout was deferred while waiting for
1186   // input files from a plugin--implemented by child class.
1187   virtual void
1188   do_layout_deferred_sections(Layout*) = 0;
1189
1190   // Given a section index, return the corresponding Output_section.
1191   // The return value will be NULL if the section is not included in
1192   // the link.
1193   Output_section*
1194   do_output_section(unsigned int shndx) const
1195   {
1196     gold_assert(shndx < this->output_sections_.size());
1197     return this->output_sections_[shndx];
1198   }
1199
1200   // Return the vector mapping input sections to output sections.
1201   Output_sections&
1202   output_sections()
1203   { return this->output_sections_; }
1204
1205   const Output_sections&
1206   output_sections() const
1207   { return this->output_sections_; }
1208
1209   // Set the size of the relocatable relocs array.
1210   void
1211   size_relocatable_relocs()
1212   {
1213     this->map_to_relocatable_relocs_ =
1214       new std::vector<Relocatable_relocs*>(this->shnum());
1215   }
1216
1217   // Record that we must wait for the output sections to be written
1218   // before applying relocations.
1219   void
1220   set_relocs_must_follow_section_writes()
1221   { this->relocs_must_follow_section_writes_ = true; }
1222
1223   // Allocate the array for counting incremental relocations.
1224   void
1225   allocate_incremental_reloc_counts()
1226   {
1227     unsigned int nsyms = this->do_get_global_symbols()->size();
1228     this->reloc_counts_ = new unsigned int[nsyms];
1229     gold_assert(this->reloc_counts_ != NULL);
1230     memset(this->reloc_counts_, 0, nsyms * sizeof(unsigned int));
1231   }
1232
1233   // Record a relocation in this object referencing global symbol SYMNDX.
1234   // Used for tracking incremental link information.
1235   void
1236   count_incremental_reloc(unsigned int symndx)
1237   {
1238     unsigned int nsyms = this->do_get_global_symbols()->size();
1239     gold_assert(symndx < nsyms);
1240     gold_assert(this->reloc_counts_ != NULL);
1241     ++this->reloc_counts_[symndx];
1242   }
1243
1244   // Finalize the incremental relocation information.
1245   void
1246   finalize_incremental_relocs(Layout* layout, bool clear_counts);
1247
1248   // Return the index of the next relocation to be written for global symbol
1249   // SYMNDX.  Only valid after finalize_incremental_relocs() has been called.
1250   unsigned int
1251   next_incremental_reloc_index(unsigned int symndx)
1252   {
1253     unsigned int nsyms = this->do_get_global_symbols()->size();
1254
1255     gold_assert(this->reloc_counts_ != NULL);
1256     gold_assert(this->reloc_bases_ != NULL);
1257     gold_assert(symndx < nsyms);
1258
1259     unsigned int counter = this->reloc_counts_[symndx]++;
1260     return this->reloc_bases_[symndx] + counter;
1261   }
1262
1263  private:
1264   // Mapping from input sections to output section.
1265   Output_sections output_sections_;
1266   // Mapping from input section index to the information recorded for
1267   // the relocations.  This is only used for a relocatable link.
1268   std::vector<Relocatable_relocs*>* map_to_relocatable_relocs_;
1269   // Mappings for merge sections.  This is managed by the code in the
1270   // Merge_map class.
1271   Object_merge_map* object_merge_map_;
1272   // Whether we need to wait for output sections to be written before
1273   // we can apply relocations.
1274   bool relocs_must_follow_section_writes_;
1275   // Used to store the relocs data computed by the Read_relocs pass. 
1276   // Used during garbage collection of unused sections.
1277   Read_relocs_data* rd_;
1278   // Used to store the symbols data computed by the Read_symbols pass.
1279   // Again used during garbage collection when laying out referenced
1280   // sections.
1281   gold::Symbols_data* sd_;
1282   // Per-symbol counts of relocations, for incremental links.
1283   unsigned int* reloc_counts_;
1284   // Per-symbol base indexes of relocations, for incremental links.
1285   unsigned int* reloc_bases_;
1286   // Index of the first dynamic relocation for this object.
1287   unsigned int first_dyn_reloc_;
1288   // Count of dynamic relocations for this object.
1289   unsigned int dyn_reloc_count_;
1290 };
1291
1292 // This class is used to handle relocations against a section symbol
1293 // in an SHF_MERGE section.  For such a symbol, we need to know the
1294 // addend of the relocation before we can determine the final value.
1295 // The addend gives us the location in the input section, and we can
1296 // determine how it is mapped to the output section.  For a
1297 // non-section symbol, we apply the addend to the final value of the
1298 // symbol; that is done in finalize_local_symbols, and does not use
1299 // this class.
1300
1301 template<int size>
1302 class Merged_symbol_value
1303 {
1304  public:
1305   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value;
1306
1307   // We use a hash table to map offsets in the input section to output
1308   // addresses.
1309   typedef Unordered_map<section_offset_type, Value> Output_addresses;
1310
1311   Merged_symbol_value(Value input_value, Value output_start_address)
1312     : input_value_(input_value), output_start_address_(output_start_address),
1313       output_addresses_()
1314   { }
1315
1316   // Initialize the hash table.
1317   void
1318   initialize_input_to_output_map(const Relobj*, unsigned int input_shndx);
1319
1320   // Release the hash table to save space.
1321   void
1322   free_input_to_output_map()
1323   { this->output_addresses_.clear(); }
1324
1325   // Get the output value corresponding to an addend.  The object and
1326   // input section index are passed in because the caller will have
1327   // them; otherwise we could store them here.
1328   Value
1329   value(const Relobj* object, unsigned int input_shndx, Value addend) const
1330   {
1331     // This is a relocation against a section symbol.  ADDEND is the
1332     // offset in the section.  The result should be the start of some
1333     // merge area.  If the object file wants something else, it should
1334     // use a regular symbol rather than a section symbol.
1335     // Unfortunately, PR 6658 shows a case in which the object file
1336     // refers to the section symbol, but uses a negative ADDEND to
1337     // compensate for a PC relative reloc.  We can't handle the
1338     // general case.  However, we can handle the special case of a
1339     // negative addend, by assuming that it refers to the start of the
1340     // section.  Of course, that means that we have to guess when
1341     // ADDEND is negative.  It is normal to see a 32-bit value here
1342     // even when the template parameter size is 64, as 64-bit object
1343     // file formats have 32-bit relocations.  We know this is a merge
1344     // section, so we know it has to fit into memory.  So we assume
1345     // that we won't see a value larger than a large 32-bit unsigned
1346     // value.  This will break objects with very very large merge
1347     // sections; they probably break in other ways anyhow.
1348     Value input_offset = this->input_value_;
1349     if (addend < 0xffffff00)
1350       {
1351         input_offset += addend;
1352         addend = 0;
1353       }
1354     typename Output_addresses::const_iterator p =
1355       this->output_addresses_.find(input_offset);
1356     if (p != this->output_addresses_.end())
1357       return p->second + addend;
1358
1359     return (this->value_from_output_section(object, input_shndx, input_offset)
1360             + addend);
1361   }
1362
1363  private:
1364   // Get the output value for an input offset if we couldn't find it
1365   // in the hash table.
1366   Value
1367   value_from_output_section(const Relobj*, unsigned int input_shndx,
1368                             Value input_offset) const;
1369
1370   // The value of the section symbol in the input file.  This is
1371   // normally zero, but could in principle be something else.
1372   Value input_value_;
1373   // The start address of this merged section in the output file.
1374   Value output_start_address_;
1375   // A hash table which maps offsets in the input section to output
1376   // addresses.  This only maps specific offsets, not all offsets.
1377   Output_addresses output_addresses_;
1378 };
1379
1380 // This POD class is holds the value of a symbol.  This is used for
1381 // local symbols, and for all symbols during relocation processing.
1382 // For special sections, such as SHF_MERGE sections, this calls a
1383 // function to get the final symbol value.
1384
1385 template<int size>
1386 class Symbol_value
1387 {
1388  public:
1389   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value;
1390
1391   Symbol_value()
1392     : output_symtab_index_(0), output_dynsym_index_(-1U), input_shndx_(0),
1393       is_ordinary_shndx_(false), is_section_symbol_(false),
1394       is_tls_symbol_(false), is_ifunc_symbol_(false), has_output_value_(true)
1395   { this->u_.value = 0; }
1396
1397   ~Symbol_value()
1398   {
1399     if (!this->has_output_value_)
1400       delete this->u_.merged_symbol_value;
1401   }
1402
1403   // Get the value of this symbol.  OBJECT is the object in which this
1404   // symbol is defined, and ADDEND is an addend to add to the value.
1405   template<bool big_endian>
1406   Value
1407   value(const Sized_relobj_file<size, big_endian>* object, Value addend) const
1408   {
1409     if (this->has_output_value_)
1410       return this->u_.value + addend;
1411     else
1412       {
1413         gold_assert(this->is_ordinary_shndx_);
1414         return this->u_.merged_symbol_value->value(object, this->input_shndx_,
1415                                                    addend);
1416       }
1417   }
1418
1419   // Set the value of this symbol in the output symbol table.
1420   void
1421   set_output_value(Value value)
1422   { this->u_.value = value; }
1423
1424   // For a section symbol in a merged section, we need more
1425   // information.
1426   void
1427   set_merged_symbol_value(Merged_symbol_value<size>* msv)
1428   {
1429     gold_assert(this->is_section_symbol_);
1430     this->has_output_value_ = false;
1431     this->u_.merged_symbol_value = msv;
1432   }
1433
1434   // Initialize the input to output map for a section symbol in a
1435   // merged section.  We also initialize the value of a non-section
1436   // symbol in a merged section.
1437   void
1438   initialize_input_to_output_map(const Relobj* object)
1439   {
1440     if (!this->has_output_value_)
1441       {
1442         gold_assert(this->is_section_symbol_ && this->is_ordinary_shndx_);
1443         Merged_symbol_value<size>* msv = this->u_.merged_symbol_value;
1444         msv->initialize_input_to_output_map(object, this->input_shndx_);
1445       }
1446   }
1447
1448   // Free the input to output map for a section symbol in a merged
1449   // section.
1450   void
1451   free_input_to_output_map()
1452   {
1453     if (!this->has_output_value_)
1454       this->u_.merged_symbol_value->free_input_to_output_map();
1455   }
1456
1457   // Set the value of the symbol from the input file.  This is only
1458   // called by count_local_symbols, to communicate the value to
1459   // finalize_local_symbols.
1460   void
1461   set_input_value(Value value)
1462   { this->u_.value = value; }
1463
1464   // Return the input value.  This is only called by
1465   // finalize_local_symbols and (in special cases) relocate_section.
1466   Value
1467   input_value() const
1468   { return this->u_.value; }
1469
1470   // Return whether we have set the index in the output symbol table
1471   // yet.
1472   bool
1473   is_output_symtab_index_set() const
1474   {
1475     return (this->output_symtab_index_ != 0
1476             && this->output_symtab_index_ != -2U);
1477   }
1478
1479   // Return whether this symbol may be discarded from the normal
1480   // symbol table.
1481   bool
1482   may_be_discarded_from_output_symtab() const
1483   {
1484     gold_assert(!this->is_output_symtab_index_set());
1485     return this->output_symtab_index_ != -2U;
1486   }
1487
1488   // Return whether this symbol has an entry in the output symbol
1489   // table.
1490   bool
1491   has_output_symtab_entry() const
1492   {
1493     gold_assert(this->is_output_symtab_index_set());
1494     return this->output_symtab_index_ != -1U;
1495   }
1496
1497   // Return the index in the output symbol table.
1498   unsigned int
1499   output_symtab_index() const
1500   {
1501     gold_assert(this->is_output_symtab_index_set()
1502                 && this->output_symtab_index_ != -1U);
1503     return this->output_symtab_index_;
1504   }
1505
1506   // Set the index in the output symbol table.
1507   void
1508   set_output_symtab_index(unsigned int i)
1509   {
1510     gold_assert(!this->is_output_symtab_index_set());
1511     gold_assert(i != 0 && i != -1U && i != -2U);
1512     this->output_symtab_index_ = i;
1513   }
1514
1515   // Record that this symbol should not go into the output symbol
1516   // table.
1517   void
1518   set_no_output_symtab_entry()
1519   {
1520     gold_assert(this->output_symtab_index_ == 0);
1521     this->output_symtab_index_ = -1U;
1522   }
1523
1524   // Record that this symbol must go into the output symbol table,
1525   // because it there is a relocation that uses it.
1526   void
1527   set_must_have_output_symtab_entry()
1528   {
1529     gold_assert(!this->is_output_symtab_index_set());
1530     this->output_symtab_index_ = -2U;
1531   }
1532
1533   // Set the index in the output dynamic symbol table.
1534   void
1535   set_needs_output_dynsym_entry()
1536   {
1537     gold_assert(!this->is_section_symbol());
1538     this->output_dynsym_index_ = 0;
1539   }
1540
1541   // Return whether this symbol should go into the dynamic symbol
1542   // table.
1543   bool
1544   needs_output_dynsym_entry() const
1545   {
1546     return this->output_dynsym_index_ != -1U;
1547   }
1548
1549   // Return whether this symbol has an entry in the dynamic symbol
1550   // table.
1551   bool
1552   has_output_dynsym_entry() const
1553   {
1554     gold_assert(this->output_dynsym_index_ != 0);
1555     return this->output_dynsym_index_ != -1U;
1556   }
1557
1558   // Record that this symbol should go into the dynamic symbol table.
1559   void
1560   set_output_dynsym_index(unsigned int i)
1561   {
1562     gold_assert(this->output_dynsym_index_ == 0);
1563     gold_assert(i != 0 && i != -1U);
1564     this->output_dynsym_index_ = i;
1565   }
1566
1567   // Return the index in the output dynamic symbol table.
1568   unsigned int
1569   output_dynsym_index() const
1570   {
1571     gold_assert(this->output_dynsym_index_ != 0
1572                 && this->output_dynsym_index_ != -1U);
1573     return this->output_dynsym_index_;
1574   }
1575
1576   // Set the index of the input section in the input file.
1577   void
1578   set_input_shndx(unsigned int i, bool is_ordinary)
1579   {
1580     this->input_shndx_ = i;
1581     // input_shndx_ field is a bitfield, so make sure that the value
1582     // fits.
1583     gold_assert(this->input_shndx_ == i);
1584     this->is_ordinary_shndx_ = is_ordinary;
1585   }
1586
1587   // Return the index of the input section in the input file.
1588   unsigned int
1589   input_shndx(bool* is_ordinary) const
1590   {
1591     *is_ordinary = this->is_ordinary_shndx_;
1592     return this->input_shndx_;
1593   }
1594
1595   // Whether this is a section symbol.
1596   bool
1597   is_section_symbol() const
1598   { return this->is_section_symbol_; }
1599
1600   // Record that this is a section symbol.
1601   void
1602   set_is_section_symbol()
1603   {
1604     gold_assert(!this->needs_output_dynsym_entry());
1605     this->is_section_symbol_ = true;
1606   }
1607
1608   // Record that this is a TLS symbol.
1609   void
1610   set_is_tls_symbol()
1611   { this->is_tls_symbol_ = true; }
1612
1613   // Return true if this is a TLS symbol.
1614   bool
1615   is_tls_symbol() const
1616   { return this->is_tls_symbol_; }
1617
1618   // Record that this is an IFUNC symbol.
1619   void
1620   set_is_ifunc_symbol()
1621   { this->is_ifunc_symbol_ = true; }
1622
1623   // Return true if this is an IFUNC symbol.
1624   bool
1625   is_ifunc_symbol() const
1626   { return this->is_ifunc_symbol_; }
1627
1628   // Return true if this has output value.
1629   bool
1630   has_output_value() const
1631   { return this->has_output_value_; }
1632
1633  private:
1634   // The index of this local symbol in the output symbol table.  This
1635   // will be 0 if no value has been assigned yet, and the symbol may
1636   // be omitted.  This will be -1U if the symbol should not go into
1637   // the symbol table.  This will be -2U if the symbol must go into
1638   // the symbol table, but no index has been assigned yet.
1639   unsigned int output_symtab_index_;
1640   // The index of this local symbol in the dynamic symbol table.  This
1641   // will be -1U if the symbol should not go into the symbol table.
1642   unsigned int output_dynsym_index_;
1643   // The section index in the input file in which this symbol is
1644   // defined.
1645   unsigned int input_shndx_ : 27;
1646   // Whether the section index is an ordinary index, not a special
1647   // value.
1648   bool is_ordinary_shndx_ : 1;
1649   // Whether this is a STT_SECTION symbol.
1650   bool is_section_symbol_ : 1;
1651   // Whether this is a STT_TLS symbol.
1652   bool is_tls_symbol_ : 1;
1653   // Whether this is a STT_GNU_IFUNC symbol.
1654   bool is_ifunc_symbol_ : 1;
1655   // Whether this symbol has a value for the output file.  This is
1656   // normally set to true during Layout::finalize, by
1657   // finalize_local_symbols.  It will be false for a section symbol in
1658   // a merge section, as for such symbols we can not determine the
1659   // value to use in a relocation until we see the addend.
1660   bool has_output_value_ : 1;
1661   union
1662   {
1663     // This is used if has_output_value_ is true.  Between
1664     // count_local_symbols and finalize_local_symbols, this is the
1665     // value in the input file.  After finalize_local_symbols, it is
1666     // the value in the output file.
1667     Value value;
1668     // This is used if has_output_value_ is false.  It points to the
1669     // information we need to get the value for a merge section.
1670     Merged_symbol_value<size>* merged_symbol_value;
1671   } u_;
1672 };
1673
1674 // This type is used to modify relocations for -fsplit-stack.  It is
1675 // indexed by relocation index, and means that the relocation at that
1676 // index should use the symbol from the vector, rather than the one
1677 // indicated by the relocation.
1678
1679 class Reloc_symbol_changes
1680 {
1681  public:
1682   Reloc_symbol_changes(size_t count)
1683     : vec_(count, NULL)
1684   { }
1685
1686   void
1687   set(size_t i, Symbol* sym)
1688   { this->vec_[i] = sym; }
1689
1690   const Symbol*
1691   operator[](size_t i) const
1692   { return this->vec_[i]; }
1693
1694  private:
1695   std::vector<Symbol*> vec_;
1696 };
1697
1698 // Type for mapping section index to uncompressed size.
1699
1700 typedef std::map<unsigned int, section_size_type> Compressed_section_map;
1701
1702 // Abstract base class for a regular object file, either a real object file
1703 // or an incremental (unchanged) object.  This is size and endian specific.
1704
1705 template<int size, bool big_endian>
1706 class Sized_relobj : public Relobj
1707 {
1708  public:
1709   typedef typename elfcpp::Elf_types<size>::Elf_Addr Address;
1710   typedef Relobj::Symbols Symbols;
1711
1712   static const Address invalid_address = static_cast<Address>(0) - 1;
1713
1714   Sized_relobj(const std::string& name, Input_file* input_file)
1715     : Relobj(name, input_file), local_got_offsets_(), section_offsets_()
1716   { }
1717
1718   Sized_relobj(const std::string& name, Input_file* input_file,
1719                     off_t offset)
1720     : Relobj(name, input_file, offset), local_got_offsets_(), section_offsets_()
1721   { }
1722
1723   ~Sized_relobj()
1724   { }
1725
1726   // If this is a regular object, return a pointer to the Sized_relobj_file
1727   // object.  Otherwise, return NULL.
1728   virtual Sized_relobj_file<size, big_endian>*
1729   sized_relobj()
1730   { return NULL; }
1731
1732   const virtual Sized_relobj_file<size, big_endian>*
1733   sized_relobj() const
1734   { return NULL; }
1735
1736   // Checks if the offset of input section SHNDX within its output
1737   // section is invalid.
1738   bool
1739   is_output_section_offset_invalid(unsigned int shndx) const
1740   { return this->get_output_section_offset(shndx) == invalid_address; }
1741
1742   // Get the offset of input section SHNDX within its output section.
1743   // This is -1 if the input section requires a special mapping, such
1744   // as a merge section.  The output section can be found in the
1745   // output_sections_ field of the parent class Relobj.
1746   Address
1747   get_output_section_offset(unsigned int shndx) const
1748   {
1749     gold_assert(shndx < this->section_offsets_.size());
1750     return this->section_offsets_[shndx];
1751   }
1752
1753   // Return whether the local symbol SYMNDX has a GOT offset.
1754   // For TLS symbols, the GOT entry will hold its tp-relative offset.
1755   bool
1756   local_has_got_offset(unsigned int symndx, unsigned int got_type) const
1757   {
1758     Local_got_offsets::const_iterator p =
1759         this->local_got_offsets_.find(symndx);
1760     return (p != this->local_got_offsets_.end()
1761             && p->second->get_offset(got_type) != -1U);
1762   }
1763
1764   // Return the GOT offset of the local symbol SYMNDX.
1765   unsigned int
1766   local_got_offset(unsigned int symndx, unsigned int got_type) const
1767   {
1768     Local_got_offsets::const_iterator p =
1769         this->local_got_offsets_.find(symndx);
1770     gold_assert(p != this->local_got_offsets_.end());
1771     unsigned int off = p->second->get_offset(got_type);
1772     gold_assert(off != -1U);
1773     return off;
1774   }
1775
1776   // Set the GOT offset of the local symbol SYMNDX to GOT_OFFSET.
1777   void
1778   set_local_got_offset(unsigned int symndx, unsigned int got_type,
1779                        unsigned int got_offset)
1780   {
1781     Local_got_offsets::const_iterator p =
1782         this->local_got_offsets_.find(symndx);
1783     if (p != this->local_got_offsets_.end())
1784       p->second->set_offset(got_type, got_offset);
1785     else
1786       {
1787         Got_offset_list* g = new Got_offset_list(got_type, got_offset);
1788         std::pair<Local_got_offsets::iterator, bool> ins =
1789             this->local_got_offsets_.insert(std::make_pair(symndx, g));
1790         gold_assert(ins.second);
1791       }
1792   }
1793
1794   // Iterate over local symbols, calling a visitor class V for each GOT offset
1795   // associated with a local symbol.
1796   void
1797   do_for_all_local_got_entries(Got_offset_list::Visitor* v) const;
1798
1799  protected:
1800   typedef Relobj::Output_sections Output_sections;
1801
1802   // Clear the local symbol information.
1803   void
1804   clear_got_offsets()
1805   { this->local_got_offsets_.clear(); }
1806
1807   // Return the vector of section offsets.
1808   std::vector<Address>&
1809   section_offsets()
1810   { return this->section_offsets_; }
1811
1812   // Get the offset of a section.
1813   uint64_t
1814   do_output_section_offset(unsigned int shndx) const
1815   {
1816     Address off = this->get_output_section_offset(shndx);
1817     if (off == invalid_address)
1818       return -1ULL;
1819     return off;
1820   }
1821
1822   // Set the offset of a section.
1823   void
1824   do_set_section_offset(unsigned int shndx, uint64_t off)
1825   {
1826     gold_assert(shndx < this->section_offsets_.size());
1827     this->section_offsets_[shndx] =
1828       (off == static_cast<uint64_t>(-1)
1829        ? invalid_address
1830        : convert_types<Address, uint64_t>(off));
1831   }
1832
1833  private:
1834   // The GOT offsets of local symbols. This map also stores GOT offsets
1835   // for tp-relative offsets for TLS symbols.
1836   typedef Unordered_map<unsigned int, Got_offset_list*> Local_got_offsets;
1837
1838   // GOT offsets for local non-TLS symbols, and tp-relative offsets
1839   // for TLS symbols, indexed by symbol number.
1840   Local_got_offsets local_got_offsets_;
1841   // For each input section, the offset of the input section in its
1842   // output section.  This is INVALID_ADDRESS if the input section requires a
1843   // special mapping.
1844   std::vector<Address> section_offsets_;
1845 };
1846
1847 // A regular object file.  This is size and endian specific.
1848
1849 template<int size, bool big_endian>
1850 class Sized_relobj_file : public Sized_relobj<size, big_endian>
1851 {
1852  public:
1853   typedef typename elfcpp::Elf_types<size>::Elf_Addr Address;
1854   typedef typename Sized_relobj<size, big_endian>::Symbols Symbols;
1855   typedef std::vector<Symbol_value<size> > Local_values;
1856
1857   static const Address invalid_address = static_cast<Address>(0) - 1;
1858
1859   enum Compute_final_local_value_status
1860   {
1861     // No error.
1862     CFLV_OK,
1863     // An error occurred.
1864     CFLV_ERROR,
1865     // The local symbol has no output section.
1866     CFLV_DISCARDED
1867   };
1868
1869   Sized_relobj_file(const std::string& name,
1870                     Input_file* input_file,
1871                     off_t offset,
1872                     const typename elfcpp::Ehdr<size, big_endian>&);
1873
1874   ~Sized_relobj_file();
1875
1876   // Set up the object file based on TARGET.
1877   void
1878   setup()
1879   { this->do_setup(); }
1880
1881   // Return a pointer to the Sized_relobj_file object.
1882   Sized_relobj_file<size, big_endian>*
1883   sized_relobj()
1884   { return this; }
1885
1886   const Sized_relobj_file<size, big_endian>*
1887   sized_relobj() const
1888   { return this; }
1889
1890   // Return the number of symbols.  This is only valid after
1891   // Object::add_symbols has been called.
1892   unsigned int
1893   symbol_count() const
1894   { return this->local_symbol_count_ + this->symbols_.size(); }
1895
1896   // If SYM is the index of a global symbol in the object file's
1897   // symbol table, return the Symbol object.  Otherwise, return NULL.
1898   Symbol*
1899   global_symbol(unsigned int sym) const
1900   {
1901     if (sym >= this->local_symbol_count_)
1902       {
1903         gold_assert(sym - this->local_symbol_count_ < this->symbols_.size());
1904         return this->symbols_[sym - this->local_symbol_count_];
1905       }
1906     return NULL;
1907   }
1908
1909   // Return the section index of symbol SYM.  Set *VALUE to its value
1910   // in the object file.  Set *IS_ORDINARY if this is an ordinary
1911   // section index, not a special code between SHN_LORESERVE and
1912   // SHN_HIRESERVE.  Note that for a symbol which is not defined in
1913   // this object file, this will set *VALUE to 0 and return SHN_UNDEF;
1914   // it will not return the final value of the symbol in the link.
1915   unsigned int
1916   symbol_section_and_value(unsigned int sym, Address* value, bool* is_ordinary);
1917
1918   // Return a pointer to the Symbol_value structure which holds the
1919   // value of a local symbol.
1920   const Symbol_value<size>*
1921   local_symbol(unsigned int sym) const
1922   {
1923     gold_assert(sym < this->local_values_.size());
1924     return &this->local_values_[sym];
1925   }
1926
1927   // Return the index of local symbol SYM in the ordinary symbol
1928   // table.  A value of -1U means that the symbol is not being output.
1929   unsigned int
1930   symtab_index(unsigned int sym) const
1931   {
1932     gold_assert(sym < this->local_values_.size());
1933     return this->local_values_[sym].output_symtab_index();
1934   }
1935
1936   // Return the index of local symbol SYM in the dynamic symbol
1937   // table.  A value of -1U means that the symbol is not being output.
1938   unsigned int
1939   dynsym_index(unsigned int sym) const
1940   {
1941     gold_assert(sym < this->local_values_.size());
1942     return this->local_values_[sym].output_dynsym_index();
1943   }
1944
1945   // Return the input section index of local symbol SYM.
1946   unsigned int
1947   local_symbol_input_shndx(unsigned int sym, bool* is_ordinary) const
1948   {
1949     gold_assert(sym < this->local_values_.size());
1950     return this->local_values_[sym].input_shndx(is_ordinary);
1951   }
1952
1953   // Record that local symbol SYM must be in the output symbol table.
1954   void
1955   set_must_have_output_symtab_entry(unsigned int sym)
1956   {
1957     gold_assert(sym < this->local_values_.size());
1958     this->local_values_[sym].set_must_have_output_symtab_entry();
1959   }
1960
1961   // Record that local symbol SYM needs a dynamic symbol entry.
1962   void
1963   set_needs_output_dynsym_entry(unsigned int sym)
1964   {
1965     gold_assert(sym < this->local_values_.size());
1966     this->local_values_[sym].set_needs_output_dynsym_entry();
1967   }
1968
1969   // Return whether the local symbol SYMNDX has a PLT offset.
1970   bool
1971   local_has_plt_offset(unsigned int symndx) const;
1972
1973   // Return the PLT offset for a local symbol.  It is an error to call
1974   // this if it doesn't have one.
1975   unsigned int
1976   local_plt_offset(unsigned int symndx) const;
1977
1978   // Set the PLT offset of the local symbol SYMNDX.
1979   void
1980   set_local_plt_offset(unsigned int symndx, unsigned int plt_offset);
1981
1982   // Return the name of the symbol that spans the given offset in the
1983   // specified section in this object.  This is used only for error
1984   // messages and is not particularly efficient.
1985   bool
1986   get_symbol_location_info(unsigned int shndx, off_t offset,
1987                            Symbol_location_info* info);
1988
1989   // Look for a kept section corresponding to the given discarded section,
1990   // and return its output address.  This is used only for relocations in
1991   // debugging sections.
1992   Address
1993   map_to_kept_section(unsigned int shndx, bool* found) const;
1994
1995   // Compute final local symbol value.  R_SYM is the local symbol index.
1996   // LV_IN points to a local symbol value containing the input value.
1997   // LV_OUT points to a local symbol value storing the final output value,
1998   // which must not be a merged symbol value since before calling this
1999   // method to avoid memory leak.  SYMTAB points to a symbol table.
2000   //
2001   // The method returns a status code at return.  If the return status is
2002   // CFLV_OK, *LV_OUT contains the final value.  If the return status is
2003   // CFLV_ERROR, *LV_OUT is 0.  If the return status is CFLV_DISCARDED,
2004   // *LV_OUT is not modified.
2005   Compute_final_local_value_status
2006   compute_final_local_value(unsigned int r_sym,
2007                             const Symbol_value<size>* lv_in,
2008                             Symbol_value<size>* lv_out,
2009                             const Symbol_table* symtab);
2010
2011  protected:
2012   typedef typename Sized_relobj<size, big_endian>::Output_sections
2013       Output_sections;
2014
2015   // Set up.
2016   virtual void
2017   do_setup();
2018
2019   // Read the symbols.
2020   void
2021   do_read_symbols(Read_symbols_data*);
2022
2023   // Return the number of local symbols.
2024   unsigned int
2025   do_local_symbol_count() const
2026   { return this->local_symbol_count_; }
2027
2028   // Return the number of local symbols in the output symbol table.
2029   unsigned int
2030   do_output_local_symbol_count() const
2031   { return this->output_local_symbol_count_; }
2032
2033   // Return the number of local symbols in the output symbol table.
2034   off_t
2035   do_local_symbol_offset() const
2036   { return this->local_symbol_offset_; }
2037
2038   // Lay out the input sections.
2039   void
2040   do_layout(Symbol_table*, Layout*, Read_symbols_data*);
2041
2042   // Layout sections whose layout was deferred while waiting for
2043   // input files from a plugin.
2044   void
2045   do_layout_deferred_sections(Layout*);
2046
2047   // Add the symbols to the symbol table.
2048   void
2049   do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*);
2050
2051   Archive::Should_include
2052   do_should_include_member(Symbol_table* symtab, Layout*, Read_symbols_data*,
2053                            std::string* why);
2054
2055   // Iterate over global symbols, calling a visitor class V for each.
2056   void
2057   do_for_all_global_symbols(Read_symbols_data* sd,
2058                             Library_base::Symbol_visitor_base* v);
2059
2060   // Read the relocs.
2061   void
2062   do_read_relocs(Read_relocs_data*);
2063
2064   // Process the relocs to find list of referenced sections. Used only
2065   // during garbage collection.
2066   void
2067   do_gc_process_relocs(Symbol_table*, Layout*, Read_relocs_data*);
2068
2069   // Scan the relocs and adjust the symbol table.
2070   void
2071   do_scan_relocs(Symbol_table*, Layout*, Read_relocs_data*);
2072
2073   // Count the local symbols.
2074   void
2075   do_count_local_symbols(Stringpool_template<char>*,
2076                             Stringpool_template<char>*);
2077
2078   // Finalize the local symbols.
2079   unsigned int
2080   do_finalize_local_symbols(unsigned int, off_t, Symbol_table*);
2081
2082   // Set the offset where local dynamic symbol information will be stored.
2083   unsigned int
2084   do_set_local_dynsym_indexes(unsigned int);
2085
2086   // Set the offset where local dynamic symbol information will be stored.
2087   unsigned int
2088   do_set_local_dynsym_offset(off_t);
2089
2090   // Relocate the input sections and write out the local symbols.
2091   void
2092   do_relocate(const Symbol_table* symtab, const Layout*, Output_file* of);
2093
2094   // Get the size of a section.
2095   uint64_t
2096   do_section_size(unsigned int shndx)
2097   { return this->elf_file_.section_size(shndx); }
2098
2099   // Get the name of a section.
2100   std::string
2101   do_section_name(unsigned int shndx)
2102   { return this->elf_file_.section_name(shndx); }
2103
2104   // Return the location of the contents of a section.
2105   Object::Location
2106   do_section_contents(unsigned int shndx)
2107   { return this->elf_file_.section_contents(shndx); }
2108
2109   // Return section flags.
2110   uint64_t
2111   do_section_flags(unsigned int shndx);
2112
2113   // Return section entsize.
2114   uint64_t
2115   do_section_entsize(unsigned int shndx);
2116
2117   // Return section address.
2118   uint64_t
2119   do_section_address(unsigned int shndx)
2120   { return this->elf_file_.section_addr(shndx); }
2121
2122   // Return section type.
2123   unsigned int
2124   do_section_type(unsigned int shndx)
2125   { return this->elf_file_.section_type(shndx); }
2126
2127   // Return the section link field.
2128   unsigned int
2129   do_section_link(unsigned int shndx)
2130   { return this->elf_file_.section_link(shndx); }
2131
2132   // Return the section info field.
2133   unsigned int
2134   do_section_info(unsigned int shndx)
2135   { return this->elf_file_.section_info(shndx); }
2136
2137   // Return the section alignment.
2138   uint64_t
2139   do_section_addralign(unsigned int shndx)
2140   { return this->elf_file_.section_addralign(shndx); }
2141
2142   // Return the Xindex structure to use.
2143   Xindex*
2144   do_initialize_xindex();
2145
2146   // Get symbol counts.
2147   void
2148   do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
2149
2150   // Get the global symbols.
2151   const Symbols*
2152   do_get_global_symbols() const
2153   { return &this->symbols_; }
2154
2155   // Adjust a section index if necessary.
2156   unsigned int
2157   adjust_shndx(unsigned int shndx)
2158   {
2159     if (shndx >= elfcpp::SHN_LORESERVE)
2160       shndx += this->elf_file_.large_shndx_offset();
2161     return shndx;
2162   }
2163
2164   // Initialize input to output maps for section symbols in merged
2165   // sections.
2166   void
2167   initialize_input_to_output_maps();
2168
2169   // Free the input to output maps for section symbols in merged
2170   // sections.
2171   void
2172   free_input_to_output_maps();
2173
2174   // Return symbol table section index.
2175   unsigned int
2176   symtab_shndx() const
2177   { return this->symtab_shndx_; }
2178
2179   // Allow a child class to access the ELF file.
2180   elfcpp::Elf_file<size, big_endian, Object>*
2181   elf_file()
2182   { return &this->elf_file_; }
2183   
2184   // Allow a child class to access the local values.
2185   Local_values*
2186   local_values()
2187   { return &this->local_values_; }
2188
2189   // Views and sizes when relocating.
2190   struct View_size
2191   {
2192     unsigned char* view;
2193     typename elfcpp::Elf_types<size>::Elf_Addr address;
2194     off_t offset;
2195     section_size_type view_size;
2196     bool is_input_output_view;
2197     bool is_postprocessing_view;
2198   };
2199
2200   typedef std::vector<View_size> Views;
2201
2202   // This may be overriden by a child class.
2203   virtual void
2204   do_relocate_sections(const Symbol_table* symtab, const Layout* layout,
2205                        const unsigned char* pshdrs, Output_file* of,
2206                        Views* pviews);
2207
2208   // Allow a child to set output local symbol count.
2209   void
2210   set_output_local_symbol_count(unsigned int value)
2211   { this->output_local_symbol_count_ = value; }
2212
2213   // Return TRUE if the section is a compressed debug section, and set
2214   // *UNCOMPRESSED_SIZE to the size of the uncompressed data.
2215   bool
2216   do_section_is_compressed(unsigned int shndx,
2217                            section_size_type* uncompressed_size) const
2218   {
2219     if (this->compressed_sections_ == NULL)
2220       return false;
2221     Compressed_section_map::const_iterator p =
2222         this->compressed_sections_->find(shndx);
2223     if (p != this->compressed_sections_->end())
2224       {
2225         if (uncompressed_size != NULL)
2226           *uncompressed_size = p->second;
2227         return true;
2228       }
2229     return false;
2230   }
2231
2232  private:
2233   // For convenience.
2234   typedef Sized_relobj_file<size, big_endian> This;
2235   static const int ehdr_size = elfcpp::Elf_sizes<size>::ehdr_size;
2236   static const int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
2237   static const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
2238   typedef elfcpp::Shdr<size, big_endian> Shdr;
2239
2240   // To keep track of discarded comdat sections, we need to map a member
2241   // section index to the object and section index of the corresponding
2242   // kept section.
2243   struct Kept_comdat_section
2244   {
2245     Kept_comdat_section(Relobj* a_object, unsigned int a_shndx)
2246       : object(a_object), shndx(a_shndx)
2247     { }
2248     Relobj* object;
2249     unsigned int shndx;
2250   };
2251   typedef std::map<unsigned int, Kept_comdat_section>
2252       Kept_comdat_section_table;
2253
2254   // Find the SHT_SYMTAB section, given the section headers.
2255   void
2256   find_symtab(const unsigned char* pshdrs);
2257
2258   // Return whether SHDR has the right flags for a GNU style exception
2259   // frame section.
2260   bool
2261   check_eh_frame_flags(const elfcpp::Shdr<size, big_endian>* shdr) const;
2262
2263   // Return whether there is a section named .eh_frame which might be
2264   // a GNU style exception frame section.
2265   bool
2266   find_eh_frame(const unsigned char* pshdrs, const char* names,
2267                 section_size_type names_size) const;
2268
2269   // Whether to include a section group in the link.
2270   bool
2271   include_section_group(Symbol_table*, Layout*, unsigned int, const char*,
2272                         const unsigned char*, const char*, section_size_type,
2273                         std::vector<bool>*);
2274
2275   // Whether to include a linkonce section in the link.
2276   bool
2277   include_linkonce_section(Layout*, unsigned int, const char*,
2278                            const elfcpp::Shdr<size, big_endian>&);
2279
2280   // Layout an input section.
2281   void
2282   layout_section(Layout* layout, unsigned int shndx, const char* name,
2283                  typename This::Shdr& shdr, unsigned int reloc_shndx,
2284                  unsigned int reloc_type);
2285
2286   // Write section data to the output file.  Record the views and
2287   // sizes in VIEWS for use when relocating.
2288   void
2289   write_sections(const unsigned char* pshdrs, Output_file*, Views*);
2290
2291   // Relocate the sections in the output file.
2292   void
2293   relocate_sections(const Symbol_table* symtab, const Layout* layout,
2294                     const unsigned char* pshdrs, Output_file* of,
2295                     Views* pviews)
2296   { this->do_relocate_sections(symtab, layout, pshdrs, of, pviews); }
2297
2298   // Scan the input relocations for --emit-relocs.
2299   void
2300   emit_relocs_scan(Symbol_table*, Layout*, const unsigned char* plocal_syms,
2301                    const Read_relocs_data::Relocs_list::iterator&);
2302
2303   // Scan the input relocations for --emit-relocs, templatized on the
2304   // type of the relocation section.
2305   template<int sh_type>
2306   void
2307   emit_relocs_scan_reltype(Symbol_table*, Layout*,
2308                            const unsigned char* plocal_syms,
2309                            const Read_relocs_data::Relocs_list::iterator&,
2310                            Relocatable_relocs*);
2311
2312   // Emit the relocs for --emit-relocs.
2313   void
2314   emit_relocs(const Relocate_info<size, big_endian>*, unsigned int,
2315               unsigned int sh_type, const unsigned char* prelocs,
2316               size_t reloc_count, Output_section*, Address output_offset,
2317               unsigned char* view, Address address,
2318               section_size_type view_size,
2319               unsigned char* reloc_view, section_size_type reloc_view_size);
2320
2321   // Emit the relocs for --emit-relocs, templatized on the type of the
2322   // relocation section.
2323   template<int sh_type>
2324   void
2325   emit_relocs_reltype(const Relocate_info<size, big_endian>*, unsigned int,
2326                       const unsigned char* prelocs, size_t reloc_count,
2327                       Output_section*, Address output_offset,
2328                       unsigned char* view, Address address,
2329                       section_size_type view_size,
2330                       unsigned char* reloc_view,
2331                       section_size_type reloc_view_size);
2332
2333   // Scan the input relocations for --incremental.
2334   void
2335   incremental_relocs_scan(const Read_relocs_data::Relocs_list::iterator&);
2336
2337   // Scan the input relocations for --incremental, templatized on the
2338   // type of the relocation section.
2339   template<int sh_type>
2340   void
2341   incremental_relocs_scan_reltype(
2342       const Read_relocs_data::Relocs_list::iterator&);
2343
2344   void
2345   incremental_relocs_write(const Relocate_info<size, big_endian>*,
2346                            unsigned int sh_type,
2347                            const unsigned char* prelocs,
2348                            size_t reloc_count,
2349                            Output_section*,
2350                            Address output_offset,
2351                            Output_file*);
2352
2353   template<int sh_type>
2354   void
2355   incremental_relocs_write_reltype(const Relocate_info<size, big_endian>*,
2356                                    const unsigned char* prelocs,
2357                                    size_t reloc_count,
2358                                    Output_section*,
2359                                    Address output_offset,
2360                                    Output_file*);
2361
2362   // A type shared by split_stack_adjust_reltype and find_functions.
2363   typedef std::map<section_offset_type, section_size_type> Function_offsets;
2364
2365   // Check for -fsplit-stack routines calling non-split-stack routines.
2366   void
2367   split_stack_adjust(const Symbol_table*, const unsigned char* pshdrs,
2368                      unsigned int sh_type, unsigned int shndx,
2369                      const unsigned char* prelocs, size_t reloc_count,
2370                      unsigned char* view, section_size_type view_size,
2371                      Reloc_symbol_changes** reloc_map);
2372
2373   template<int sh_type>
2374   void
2375   split_stack_adjust_reltype(const Symbol_table*, const unsigned char* pshdrs,
2376                              unsigned int shndx, const unsigned char* prelocs,
2377                              size_t reloc_count, unsigned char* view,
2378                              section_size_type view_size,
2379                              Reloc_symbol_changes** reloc_map);
2380
2381   // Find all functions in a section.
2382   void
2383   find_functions(const unsigned char* pshdrs, unsigned int shndx,
2384                  Function_offsets*);
2385
2386   // Write out the local symbols.
2387   void
2388   write_local_symbols(Output_file*,
2389                       const Stringpool_template<char>*,
2390                       const Stringpool_template<char>*,
2391                       Output_symtab_xindex*,
2392                       Output_symtab_xindex*,
2393                       off_t);
2394
2395   // Record a mapping from discarded section SHNDX to the corresponding
2396   // kept section.
2397   void
2398   set_kept_comdat_section(unsigned int shndx, Relobj* kept_object,
2399                           unsigned int kept_shndx)
2400   {
2401     Kept_comdat_section kept(kept_object, kept_shndx);
2402     this->kept_comdat_sections_.insert(std::make_pair(shndx, kept));
2403   }
2404
2405   // Find the kept section corresponding to the discarded section
2406   // SHNDX.  Return true if found.
2407   bool
2408   get_kept_comdat_section(unsigned int shndx, Relobj** kept_object,
2409                           unsigned int* kept_shndx) const
2410   {
2411     typename Kept_comdat_section_table::const_iterator p =
2412       this->kept_comdat_sections_.find(shndx);
2413     if (p == this->kept_comdat_sections_.end())
2414       return false;
2415     *kept_object = p->second.object;
2416     *kept_shndx = p->second.shndx;
2417     return true;
2418   }
2419
2420   // Compute final local symbol value.  R_SYM is the local symbol index.
2421   // LV_IN points to a local symbol value containing the input value.
2422   // LV_OUT points to a local symbol value storing the final output value,
2423   // which must not be a merged symbol value since before calling this
2424   // method to avoid memory leak.  RELOCATABLE indicates whether we are
2425   // linking a relocatable output.  OUT_SECTIONS is an array of output
2426   // sections.  OUT_OFFSETS is an array of offsets of the sections.  SYMTAB
2427   // points to a symbol table.
2428   //
2429   // The method returns a status code at return.  If the return status is
2430   // CFLV_OK, *LV_OUT contains the final value.  If the return status is
2431   // CFLV_ERROR, *LV_OUT is 0.  If the return status is CFLV_DISCARDED,
2432   // *LV_OUT is not modified.
2433   inline Compute_final_local_value_status
2434   compute_final_local_value_internal(unsigned int r_sym,
2435                                      const Symbol_value<size>* lv_in,
2436                                      Symbol_value<size>* lv_out,
2437                                      bool relocatable,
2438                                      const Output_sections& out_sections,
2439                                      const std::vector<Address>& out_offsets,
2440                                      const Symbol_table* symtab);
2441
2442   // The PLT offsets of local symbols.
2443   typedef Unordered_map<unsigned int, unsigned int> Local_plt_offsets;
2444
2445   // Saved information for sections whose layout was deferred.
2446   struct Deferred_layout
2447   {
2448     static const int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
2449     Deferred_layout(unsigned int shndx, const char* name,
2450                     const unsigned char* pshdr,
2451                     unsigned int reloc_shndx, unsigned int reloc_type)
2452       : shndx_(shndx), name_(name), reloc_shndx_(reloc_shndx),
2453         reloc_type_(reloc_type)
2454     {
2455       memcpy(this->shdr_data_, pshdr, shdr_size);
2456     }
2457     unsigned int shndx_;
2458     std::string name_;
2459     unsigned int reloc_shndx_;
2460     unsigned int reloc_type_;
2461     unsigned char shdr_data_[shdr_size];
2462   };
2463
2464   // General access to the ELF file.
2465   elfcpp::Elf_file<size, big_endian, Object> elf_file_;
2466   // Index of SHT_SYMTAB section.
2467   unsigned int symtab_shndx_;
2468   // The number of local symbols.
2469   unsigned int local_symbol_count_;
2470   // The number of local symbols which go into the output file.
2471   unsigned int output_local_symbol_count_;
2472   // The number of local symbols which go into the output file's dynamic
2473   // symbol table.
2474   unsigned int output_local_dynsym_count_;
2475   // The entries in the symbol table for the external symbols.
2476   Symbols symbols_;
2477   // Number of symbols defined in object file itself.
2478   size_t defined_count_;
2479   // File offset for local symbols (relative to start of symbol table).
2480   off_t local_symbol_offset_;
2481   // File offset for local dynamic symbols (absolute).
2482   off_t local_dynsym_offset_;
2483   // Values of local symbols.
2484   Local_values local_values_;
2485   // PLT offsets for local symbols.
2486   Local_plt_offsets local_plt_offsets_;
2487   // Table mapping discarded comdat sections to corresponding kept sections.
2488   Kept_comdat_section_table kept_comdat_sections_;
2489   // Whether this object has a GNU style .eh_frame section.
2490   bool has_eh_frame_;
2491   // If this object has a GNU style .eh_frame section that is discarded in
2492   // output, record the index here.  Otherwise it is -1U.
2493   unsigned int discarded_eh_frame_shndx_;
2494   // The list of sections whose layout was deferred.
2495   std::vector<Deferred_layout> deferred_layout_;
2496   // The list of relocation sections whose layout was deferred.
2497   std::vector<Deferred_layout> deferred_layout_relocs_;
2498   // For compressed debug sections, map section index to uncompressed size.
2499   Compressed_section_map* compressed_sections_;
2500 };
2501
2502 // A class to manage the list of all objects.
2503
2504 class Input_objects
2505 {
2506  public:
2507   Input_objects()
2508     : relobj_list_(), dynobj_list_(), sonames_(), cref_(NULL)
2509   { }
2510
2511   // The type of the list of input relocateable objects.
2512   typedef std::vector<Relobj*> Relobj_list;
2513   typedef Relobj_list::const_iterator Relobj_iterator;
2514
2515   // The type of the list of input dynamic objects.
2516   typedef std::vector<Dynobj*> Dynobj_list;
2517   typedef Dynobj_list::const_iterator Dynobj_iterator;
2518
2519   // Add an object to the list.  Return true if all is well, or false
2520   // if this object should be ignored.
2521   bool
2522   add_object(Object*);
2523
2524   // Start processing an archive.
2525   void
2526   archive_start(Archive*);
2527
2528   // Stop processing an archive.
2529   void
2530   archive_stop(Archive*);
2531
2532   // For each dynamic object, check whether we've seen all of its
2533   // explicit dependencies.
2534   void
2535   check_dynamic_dependencies() const;
2536
2537   // Return whether an object was found in the system library
2538   // directory.
2539   bool
2540   found_in_system_library_directory(const Object*) const;
2541
2542   // Print symbol counts.
2543   void
2544   print_symbol_counts(const Symbol_table*) const;
2545
2546   // Print a cross reference table.
2547   void
2548   print_cref(const Symbol_table*, FILE*) const;
2549
2550   // Iterate over all regular objects.
2551
2552   Relobj_iterator
2553   relobj_begin() const
2554   { return this->relobj_list_.begin(); }
2555
2556   Relobj_iterator
2557   relobj_end() const
2558   { return this->relobj_list_.end(); }
2559
2560   // Iterate over all dynamic objects.
2561
2562   Dynobj_iterator
2563   dynobj_begin() const
2564   { return this->dynobj_list_.begin(); }
2565
2566   Dynobj_iterator
2567   dynobj_end() const
2568   { return this->dynobj_list_.end(); }
2569
2570   // Return whether we have seen any dynamic objects.
2571   bool
2572   any_dynamic() const
2573   { return !this->dynobj_list_.empty(); }
2574
2575   // Return the number of non dynamic objects.
2576   int
2577   number_of_relobjs() const
2578   { return this->relobj_list_.size(); }
2579
2580   // Return the number of input objects.
2581   int
2582   number_of_input_objects() const
2583   { return this->relobj_list_.size() + this->dynobj_list_.size(); }
2584
2585  private:
2586   Input_objects(const Input_objects&);
2587   Input_objects& operator=(const Input_objects&);
2588
2589   // The list of ordinary objects included in the link.
2590   Relobj_list relobj_list_;
2591   // The list of dynamic objects included in the link.
2592   Dynobj_list dynobj_list_;
2593   // SONAMEs that we have seen.
2594   Unordered_set<std::string> sonames_;
2595   // Manage cross-references if requested.
2596   Cref* cref_;
2597 };
2598
2599 // Some of the information we pass to the relocation routines.  We
2600 // group this together to avoid passing a dozen different arguments.
2601
2602 template<int size, bool big_endian>
2603 struct Relocate_info
2604 {
2605   // Symbol table.
2606   const Symbol_table* symtab;
2607   // Layout.
2608   const Layout* layout;
2609   // Object being relocated.
2610   Sized_relobj_file<size, big_endian>* object;
2611   // Section index of relocation section.
2612   unsigned int reloc_shndx;
2613   // Section header of relocation section.
2614   const unsigned char* reloc_shdr;
2615   // Section index of section being relocated.
2616   unsigned int data_shndx;
2617   // Section header of data section.
2618   const unsigned char* data_shdr;
2619
2620   // Return a string showing the location of a relocation.  This is
2621   // only used for error messages.
2622   std::string
2623   location(size_t relnum, off_t reloffset) const;
2624 };
2625
2626 // This is used to represent a section in an object and is used as the
2627 // key type for various section maps.
2628 typedef std::pair<Object*, unsigned int> Section_id;
2629
2630 // This is similar to Section_id but is used when the section
2631 // pointers are const.
2632 typedef std::pair<const Object*, unsigned int> Const_section_id;
2633
2634 // The hash value is based on the address of an object in memory during
2635 // linking.  It is okay to use this for looking up sections but never use
2636 // this in an unordered container that we want to traverse in a repeatable
2637 // manner.
2638
2639 struct Section_id_hash
2640 {
2641   size_t operator()(const Section_id& loc) const
2642   { return reinterpret_cast<uintptr_t>(loc.first) ^ loc.second; }
2643 };
2644
2645 struct Const_section_id_hash
2646 {
2647   size_t operator()(const Const_section_id& loc) const
2648   { return reinterpret_cast<uintptr_t>(loc.first) ^ loc.second; }
2649 };
2650
2651 // Return whether INPUT_FILE contains an ELF object start at file
2652 // offset OFFSET.  This sets *START to point to a view of the start of
2653 // the file.  It sets *READ_SIZE to the number of bytes in the view.
2654
2655 extern bool
2656 is_elf_object(Input_file* input_file, off_t offset,
2657               const unsigned char** start, int* read_size);
2658
2659 // Return an Object appropriate for the input file.  P is BYTES long,
2660 // and holds the ELF header.  If PUNCONFIGURED is not NULL, then if
2661 // this sees an object the linker is not configured to support, it
2662 // sets *PUNCONFIGURED to true and returns NULL without giving an
2663 // error message.
2664
2665 extern Object*
2666 make_elf_object(const std::string& name, Input_file*,
2667                 off_t offset, const unsigned char* p,
2668                 section_offset_type bytes, bool* punconfigured);
2669
2670 } // end namespace gold
2671
2672 #endif // !defined(GOLD_OBJECT_H)