Add plugin functionality for link-time optimization (LTO).
[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 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
34 namespace gold
35 {
36
37 class General_options;
38 class Task;
39 class Cref;
40 class Archive;
41 class Layout;
42 class Output_section;
43 class Output_file;
44 class Output_symtab_xindex;
45 class Pluginobj;
46 class Dynobj;
47 class Object_merge_map;
48 class Relocatable_relocs;
49
50 template<typename Stringpool_char>
51 class Stringpool_template;
52
53 // Data to pass from read_symbols() to add_symbols().
54
55 struct Read_symbols_data
56 {
57   // Section headers.
58   File_view* section_headers;
59   // Section names.
60   File_view* section_names;
61   // Size of section name data in bytes.
62   section_size_type section_names_size;
63   // Symbol data.
64   File_view* symbols;
65   // Size of symbol data in bytes.
66   section_size_type symbols_size;
67   // Offset of external symbols within symbol data.  This structure
68   // sometimes contains only external symbols, in which case this will
69   // be zero.  Sometimes it contains all symbols.
70   section_offset_type external_symbols_offset;
71   // Symbol names.
72   File_view* symbol_names;
73   // Size of symbol name data in bytes.
74   section_size_type symbol_names_size;
75
76   // Version information.  This is only used on dynamic objects.
77   // Version symbol data (from SHT_GNU_versym section).
78   File_view* versym;
79   section_size_type versym_size;
80   // Version definition data (from SHT_GNU_verdef section).
81   File_view* verdef;
82   section_size_type verdef_size;
83   unsigned int verdef_info;
84   // Needed version data  (from SHT_GNU_verneed section).
85   File_view* verneed;
86   section_size_type verneed_size;
87   unsigned int verneed_info;
88 };
89
90 // Information used to print error messages.
91
92 struct Symbol_location_info
93 {
94   std::string source_file;
95   std::string enclosing_symbol_name;
96   int line_number;
97 };
98
99 // Data about a single relocation section.  This is read in
100 // read_relocs and processed in scan_relocs.
101
102 struct Section_relocs
103 {
104   // Index of reloc section.
105   unsigned int reloc_shndx;
106   // Index of section that relocs apply to.
107   unsigned int data_shndx;
108   // Contents of reloc section.
109   File_view* contents;
110   // Reloc section type.
111   unsigned int sh_type;
112   // Number of reloc entries.
113   size_t reloc_count;
114   // Output section.
115   Output_section* output_section;
116   // Whether this section has special handling for offsets.
117   bool needs_special_offset_handling;
118   // Whether the data section is allocated (has the SHF_ALLOC flag set).
119   bool is_data_section_allocated;
120 };
121
122 // Relocations in an object file.  This is read in read_relocs and
123 // processed in scan_relocs.
124
125 struct Read_relocs_data
126 {
127   typedef std::vector<Section_relocs> Relocs_list;
128   // The relocations.
129   Relocs_list relocs;
130   // The local symbols.
131   File_view* local_symbols;
132 };
133
134 // The Xindex class manages section indexes for objects with more than
135 // 0xff00 sections.
136
137 class Xindex
138 {
139  public:
140   Xindex(int large_shndx_offset)
141     : large_shndx_offset_(large_shndx_offset), symtab_xindex_()
142   { }
143
144   // Initialize the symtab_xindex_ array, given the object and the
145   // section index of the symbol table to use.
146   template<int size, bool big_endian>
147   void
148   initialize_symtab_xindex(Object*, unsigned int symtab_shndx);
149
150   // Read in the symtab_xindex_ array, given its section index.
151   // PSHDRS may optionally point to the section headers.
152   template<int size, bool big_endian>
153   void
154   read_symtab_xindex(Object*, unsigned int xindex_shndx,
155                      const unsigned char* pshdrs);
156
157   // Symbol SYMNDX in OBJECT has a section of SHN_XINDEX; return the
158   // real section index.
159   unsigned int
160   sym_xindex_to_shndx(Object* object, unsigned int symndx);
161
162  private:
163   // The type of the array giving the real section index for symbols
164   // whose st_shndx field holds SHN_XINDEX.
165   typedef std::vector<unsigned int> Symtab_xindex;
166
167   // Adjust a section index if necessary.  This should only be called
168   // for ordinary section indexes.
169   unsigned int
170   adjust_shndx(unsigned int shndx)
171   {
172     if (shndx >= elfcpp::SHN_LORESERVE)
173       shndx += this->large_shndx_offset_;
174     return shndx;
175   }
176
177   // Adjust to apply to large section indexes.
178   int large_shndx_offset_;
179   // The data from the SHT_SYMTAB_SHNDX section.
180   Symtab_xindex symtab_xindex_;
181 };
182
183 // Object is an abstract base class which represents either a 32-bit
184 // or a 64-bit input object.  This can be a regular object file
185 // (ET_REL) or a shared object (ET_DYN).
186
187 class Object
188 {
189  public:
190   // NAME is the name of the object as we would report it to the user
191   // (e.g., libfoo.a(bar.o) if this is in an archive.  INPUT_FILE is
192   // used to read the file.  OFFSET is the offset within the input
193   // file--0 for a .o or .so file, something else for a .a file.
194   Object(const std::string& name, Input_file* input_file, bool is_dynamic,
195          off_t offset = 0)
196     : name_(name), input_file_(input_file), offset_(offset), shnum_(-1U),
197       is_dynamic_(is_dynamic), target_(NULL), xindex_(NULL)
198   { input_file->file().add_object(); }
199
200   virtual ~Object()
201   { this->input_file_->file().remove_object(); }
202
203   // Return the name of the object as we would report it to the tuser.
204   const std::string&
205   name() const
206   { return this->name_; }
207
208   // Get the offset into the file.
209   off_t
210   offset() const
211   { return this->offset_; }
212
213   // Return whether this is a dynamic object.
214   bool
215   is_dynamic() const
216   { return this->is_dynamic_; }
217
218   // Returns NULL for Objects that are not plugin objects.  This method
219   // is overridden in the Pluginobj class.
220   Pluginobj*
221   pluginobj()
222   { return this->do_pluginobj(); }
223
224   // Return the target structure associated with this object.
225   Target*
226   target() const
227   { return this->target_; }
228
229   // Lock the underlying file.
230   void
231   lock(const Task* t)
232   { this->input_file()->file().lock(t); }
233
234   // Unlock the underlying file.
235   void
236   unlock(const Task* t)
237   { this->input_file()->file().unlock(t); }
238
239   // Return whether the underlying file is locked.
240   bool
241   is_locked() const
242   { return this->input_file()->file().is_locked(); }
243
244   // Return the token, so that the task can be queued.
245   Task_token*
246   token()
247   { return this->input_file()->file().token(); }
248
249   // Release the underlying file.
250   void
251   release()
252   { this->input_file_->file().release(); }
253
254   // Return whether we should just read symbols from this file.
255   bool
256   just_symbols() const
257   { return this->input_file()->just_symbols(); }
258
259   // Return the sized target structure associated with this object.
260   // This is like the target method but it returns a pointer of
261   // appropriate checked type.
262   template<int size, bool big_endian>
263   Sized_target<size, big_endian>*
264   sized_target() const;
265
266   // Get the number of sections.
267   unsigned int
268   shnum() const
269   { return this->shnum_; }
270
271   // Return a view of the contents of a section.  Set *PLEN to the
272   // size.  CACHE is a hint as in File_read::get_view.
273   const unsigned char*
274   section_contents(unsigned int shndx, section_size_type* plen, bool cache);
275
276   // Adjust a symbol's section index as needed.  SYMNDX is the index
277   // of the symbol and SHNDX is the symbol's section from
278   // get_st_shndx.  This returns the section index.  It sets
279   // *IS_ORDINARY to indicate whether this is a normal section index,
280   // rather than a special code between SHN_LORESERVE and
281   // SHN_HIRESERVE.
282   unsigned int
283   adjust_sym_shndx(unsigned int symndx, unsigned int shndx, bool* is_ordinary)
284   {
285     if (shndx < elfcpp::SHN_LORESERVE)
286       *is_ordinary = true;
287     else if (shndx == elfcpp::SHN_XINDEX)
288       {
289         if (this->xindex_ == NULL)
290           this->xindex_ = this->do_initialize_xindex();
291         shndx = this->xindex_->sym_xindex_to_shndx(this, symndx);
292         *is_ordinary = true;
293       }
294     else
295       *is_ordinary = false;
296     return shndx;
297   }
298
299   // Return the size of a section given a section index.
300   uint64_t
301   section_size(unsigned int shndx)
302   { return this->do_section_size(shndx); }
303
304   // Return the name of a section given a section index.
305   std::string
306   section_name(unsigned int shndx)
307   { return this->do_section_name(shndx); }
308
309   // Return the section flags given a section index.
310   uint64_t
311   section_flags(unsigned int shndx)
312   { return this->do_section_flags(shndx); }
313
314   // Return the section address given a section index.
315   uint64_t
316   section_address(unsigned int shndx)
317   { return this->do_section_address(shndx); }
318
319   // Return the section type given a section index.
320   unsigned int
321   section_type(unsigned int shndx)
322   { return this->do_section_type(shndx); }
323
324   // Return the section link field given a section index.
325   unsigned int
326   section_link(unsigned int shndx)
327   { return this->do_section_link(shndx); }
328
329   // Return the section info field given a section index.
330   unsigned int
331   section_info(unsigned int shndx)
332   { return this->do_section_info(shndx); }
333
334   // Return the required section alignment given a section index.
335   uint64_t
336   section_addralign(unsigned int shndx)
337   { return this->do_section_addralign(shndx); }
338
339   // Read the symbol information.
340   void
341   read_symbols(Read_symbols_data* sd)
342   { return this->do_read_symbols(sd); }
343
344   // Pass sections which should be included in the link to the Layout
345   // object, and record where the sections go in the output file.
346   void
347   layout(Symbol_table* symtab, Layout* layout, Read_symbols_data* sd)
348   { this->do_layout(symtab, layout, sd); }
349
350   // Add symbol information to the global symbol table.
351   void
352   add_symbols(Symbol_table* symtab, Read_symbols_data* sd)
353   { this->do_add_symbols(symtab, sd); }
354
355   // Functions and types for the elfcpp::Elf_file interface.  This
356   // permit us to use Object as the File template parameter for
357   // elfcpp::Elf_file.
358
359   // The View class is returned by view.  It must support a single
360   // method, data().  This is trivial, because get_view does what we
361   // need.
362   class View
363   {
364    public:
365     View(const unsigned char* p)
366       : p_(p)
367     { }
368
369     const unsigned char*
370     data() const
371     { return this->p_; }
372
373    private:
374     const unsigned char* p_;
375   };
376
377   // Return a View.
378   View
379   view(off_t file_offset, section_size_type data_size)
380   { return View(this->get_view(file_offset, data_size, true, true)); }
381
382   // Report an error.
383   void
384   error(const char* format, ...) const ATTRIBUTE_PRINTF_2;
385
386   // A location in the file.
387   struct Location
388   {
389     off_t file_offset;
390     off_t data_size;
391
392     Location(off_t fo, section_size_type ds)
393       : file_offset(fo), data_size(ds)
394     { }
395   };
396
397   // Get a View given a Location.
398   View view(Location loc)
399   { return View(this->get_view(loc.file_offset, loc.data_size, true, true)); }
400
401   // Get a view into the underlying file.
402   const unsigned char*
403   get_view(off_t start, section_size_type size, bool aligned, bool cache)
404   {
405     return this->input_file()->file().get_view(this->offset_, start, size,
406                                                aligned, cache);
407   }
408
409   // Get a lasting view into the underlying file.
410   File_view*
411   get_lasting_view(off_t start, section_size_type size, bool aligned,
412                    bool cache)
413   {
414     return this->input_file()->file().get_lasting_view(this->offset_, start,
415                                                        size, aligned, cache);
416   }
417
418   // Read data from the underlying file.
419   void
420   read(off_t start, section_size_type size, void* p)
421   { this->input_file()->file().read(start + this->offset_, size, p); }
422
423   // Read multiple data from the underlying file.
424   void
425   read_multiple(const File_read::Read_multiple& rm)
426   { this->input_file()->file().read_multiple(this->offset_, rm); }
427
428   // Stop caching views in the underlying file.
429   void
430   clear_view_cache_marks()
431   { this->input_file()->file().clear_view_cache_marks(); }
432
433   // Get the number of global symbols defined by this object, and the
434   // number of the symbols whose final definition came from this
435   // object.
436   void
437   get_global_symbol_counts(const Symbol_table* symtab, size_t* defined,
438                            size_t* used) const
439   { this->do_get_global_symbol_counts(symtab, defined, used); }
440
441   // Set the target.
442   void
443   set_target(Target* target)
444   { this->target_ = target; }
445
446  protected:
447   // Returns NULL for Objects that are not plugin objects.  This method
448   // is overridden in the Pluginobj class.
449   virtual Pluginobj*
450   do_pluginobj()
451   { return NULL; }
452
453   // Read the symbols--implemented by child class.
454   virtual void
455   do_read_symbols(Read_symbols_data*) = 0;
456
457   // Lay out sections--implemented by child class.
458   virtual void
459   do_layout(Symbol_table*, Layout*, Read_symbols_data*) = 0;
460
461   // Add symbol information to the global symbol table--implemented by
462   // child class.
463   virtual void
464   do_add_symbols(Symbol_table*, Read_symbols_data*) = 0;
465
466   // Return the location of the contents of a section.  Implemented by
467   // child class.
468   virtual Location
469   do_section_contents(unsigned int shndx) = 0;
470
471   // Get the size of a section--implemented by child class.
472   virtual uint64_t
473   do_section_size(unsigned int shndx) = 0;
474
475   // Get the name of a section--implemented by child class.
476   virtual std::string
477   do_section_name(unsigned int shndx) = 0;
478
479   // Get section flags--implemented by child class.
480   virtual uint64_t
481   do_section_flags(unsigned int shndx) = 0;
482
483   // Get section address--implemented by child class.
484   virtual uint64_t
485   do_section_address(unsigned int shndx) = 0;
486
487   // Get section type--implemented by child class.
488   virtual unsigned int
489   do_section_type(unsigned int shndx) = 0;
490
491   // Get section link field--implemented by child class.
492   virtual unsigned int
493   do_section_link(unsigned int shndx) = 0;
494
495   // Get section info field--implemented by child class.
496   virtual unsigned int
497   do_section_info(unsigned int shndx) = 0;
498
499   // Get section alignment--implemented by child class.
500   virtual uint64_t
501   do_section_addralign(unsigned int shndx) = 0;
502
503   // Return the Xindex structure to use.
504   virtual Xindex*
505   do_initialize_xindex() = 0;
506
507   // Implement get_global_symbol_counts--implemented by child class.
508   virtual void
509   do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const = 0;
510
511   // Get the file.  We pass on const-ness.
512   Input_file*
513   input_file()
514   { return this->input_file_; }
515
516   const Input_file*
517   input_file() const
518   { return this->input_file_; }
519
520   // Set the target.
521   void
522   set_target(int machine, int size, bool big_endian, int osabi,
523              int abiversion);
524
525   // Set the number of sections.
526   void
527   set_shnum(int shnum)
528   { this->shnum_ = shnum; }
529
530   // Functions used by both Sized_relobj and Sized_dynobj.
531
532   // Read the section data into a Read_symbols_data object.
533   template<int size, bool big_endian>
534   void
535   read_section_data(elfcpp::Elf_file<size, big_endian, Object>*,
536                     Read_symbols_data*);
537
538   // Let the child class initialize the xindex object directly.
539   void
540   set_xindex(Xindex* xindex)
541   {
542     gold_assert(this->xindex_ == NULL);
543     this->xindex_ = xindex;
544   }
545
546   // If NAME is the name of a special .gnu.warning section, arrange
547   // for the warning to be issued.  SHNDX is the section index.
548   // Return whether it is a warning section.
549   bool
550   handle_gnu_warning_section(const char* name, unsigned int shndx,
551                              Symbol_table*);
552
553  private:
554   // This class may not be copied.
555   Object(const Object&);
556   Object& operator=(const Object&);
557
558   // Name of object as printed to user.
559   std::string name_;
560   // For reading the file.
561   Input_file* input_file_;
562   // Offset within the file--0 for an object file, non-0 for an
563   // archive.
564   off_t offset_;
565   // Number of input sections.
566   unsigned int shnum_;
567   // Whether this is a dynamic object.
568   bool is_dynamic_;
569   // Target functions--may be NULL if the target is not known.
570   Target* target_;
571   // Many sections for objects with more than SHN_LORESERVE sections.
572   Xindex* xindex_;
573 };
574
575 // Implement sized_target inline for efficiency.  This approach breaks
576 // static type checking, but is made safe using asserts.
577
578 template<int size, bool big_endian>
579 inline Sized_target<size, big_endian>*
580 Object::sized_target() const
581 {
582   gold_assert(this->target_->get_size() == size);
583   gold_assert(this->target_->is_big_endian() ? big_endian : !big_endian);
584   return static_cast<Sized_target<size, big_endian>*>(this->target_);
585 }
586
587 // A regular object (ET_REL).  This is an abstract base class itself.
588 // The implementation is the template class Sized_relobj.
589
590 class Relobj : public Object
591 {
592  public:
593   Relobj(const std::string& name, Input_file* input_file, off_t offset = 0)
594     : Object(name, input_file, false, offset),
595       output_sections_(),
596       map_to_relocatable_relocs_(NULL),
597       object_merge_map_(NULL),
598       relocs_must_follow_section_writes_(false)
599   { }
600
601   // Read the relocs.
602   void
603   read_relocs(Read_relocs_data* rd)
604   { return this->do_read_relocs(rd); }
605
606   // Scan the relocs and adjust the symbol table.
607   void
608   scan_relocs(const General_options& options, Symbol_table* symtab,
609               Layout* layout, Read_relocs_data* rd)
610   { return this->do_scan_relocs(options, symtab, layout, rd); }
611
612   // The number of local symbols in the input symbol table.
613   virtual unsigned int
614   local_symbol_count() const
615   { return this->do_local_symbol_count(); }
616
617   // Initial local symbol processing: count the number of local symbols
618   // in the output symbol table and dynamic symbol table; add local symbol
619   // names to *POOL and *DYNPOOL.
620   void
621   count_local_symbols(Stringpool_template<char>* pool,
622                       Stringpool_template<char>* dynpool)
623   { return this->do_count_local_symbols(pool, dynpool); }
624
625   // Set the values of the local symbols, set the output symbol table
626   // indexes for the local variables, and set the offset where local
627   // symbol information will be stored. Returns the new local symbol index.
628   unsigned int
629   finalize_local_symbols(unsigned int index, off_t off)
630   { return this->do_finalize_local_symbols(index, off); }
631
632   // Set the output dynamic symbol table indexes for the local variables.
633   unsigned int
634   set_local_dynsym_indexes(unsigned int index)
635   { return this->do_set_local_dynsym_indexes(index); }
636
637   // Set the offset where local dynamic symbol information will be stored.
638   unsigned int
639   set_local_dynsym_offset(off_t off)
640   { return this->do_set_local_dynsym_offset(off); }
641
642   // Relocate the input sections and write out the local symbols.
643   void
644   relocate(const General_options& options, const Symbol_table* symtab,
645            const Layout* layout, Output_file* of)
646   { return this->do_relocate(options, symtab, layout, of); }
647
648   // Return whether an input section is being included in the link.
649   bool
650   is_section_included(unsigned int shndx) const
651   {
652     gold_assert(shndx < this->output_sections_.size());
653     return this->output_sections_[shndx] != NULL;
654   }
655
656   // Given a section index, return the corresponding Output_section.
657   // The return value will be NULL if the section is not included in
658   // the link.
659   Output_section*
660   output_section(unsigned int shndx) const
661   {
662     gold_assert(shndx < this->output_sections_.size());
663     return this->output_sections_[shndx];
664   }
665
666   // Given a section index, return the offset in the Output_section.
667   // The return value will be -1U if the section is specially mapped,
668   // such as a merge section.
669   uint64_t
670   output_section_offset(unsigned int shndx) const
671   { return this->do_output_section_offset(shndx); }
672
673   // Set the offset of an input section within its output section.
674   virtual void
675   set_section_offset(unsigned int shndx, uint64_t off)
676   { this->do_set_section_offset(shndx, off); }
677
678   // Return true if we need to wait for output sections to be written
679   // before we can apply relocations.  This is true if the object has
680   // any relocations for sections which require special handling, such
681   // as the exception frame section.
682   bool
683   relocs_must_follow_section_writes() const
684   { return this->relocs_must_follow_section_writes_; }
685
686   // Return the object merge map.
687   Object_merge_map*
688   merge_map() const
689   { return this->object_merge_map_; }
690
691   // Set the object merge map.
692   void
693   set_merge_map(Object_merge_map* object_merge_map)
694   {
695     gold_assert(this->object_merge_map_ == NULL);
696     this->object_merge_map_ = object_merge_map;
697   }
698
699   // Record the relocatable reloc info for an input reloc section.
700   void
701   set_relocatable_relocs(unsigned int reloc_shndx, Relocatable_relocs* rr)
702   {
703     gold_assert(reloc_shndx < this->shnum());
704     (*this->map_to_relocatable_relocs_)[reloc_shndx] = rr;
705   }
706
707   // Get the relocatable reloc info for an input reloc section.
708   Relocatable_relocs*
709   relocatable_relocs(unsigned int reloc_shndx)
710   {
711     gold_assert(reloc_shndx < this->shnum());
712     return (*this->map_to_relocatable_relocs_)[reloc_shndx];
713   }
714
715  protected:
716   // The output section to be used for each input section, indexed by
717   // the input section number.  The output section is NULL if the
718   // input section is to be discarded.
719   typedef std::vector<Output_section*> Output_sections;
720
721   // Read the relocs--implemented by child class.
722   virtual void
723   do_read_relocs(Read_relocs_data*) = 0;
724
725   // Scan the relocs--implemented by child class.
726   virtual void
727   do_scan_relocs(const General_options&, Symbol_table*, Layout*,
728                  Read_relocs_data*) = 0;
729
730   // Return the number of local symbols--implemented by child class.
731   virtual unsigned int
732   do_local_symbol_count() const = 0;
733
734   // Count local symbols--implemented by child class.
735   virtual void
736   do_count_local_symbols(Stringpool_template<char>*,
737                          Stringpool_template<char>*) = 0;
738
739   // Finalize the local symbols.  Set the output symbol table indexes
740   // for the local variables, and set the offset where local symbol
741   // information will be stored.
742   virtual unsigned int
743   do_finalize_local_symbols(unsigned int, off_t) = 0;
744
745   // Set the output dynamic symbol table indexes for the local variables.
746   virtual unsigned int
747   do_set_local_dynsym_indexes(unsigned int) = 0;
748
749   // Set the offset where local dynamic symbol information will be stored.
750   virtual unsigned int
751   do_set_local_dynsym_offset(off_t) = 0;
752
753   // Relocate the input sections and write out the local
754   // symbols--implemented by child class.
755   virtual void
756   do_relocate(const General_options& options, const Symbol_table* symtab,
757               const Layout*, Output_file* of) = 0;
758
759   // Get the offset of a section--implemented by child class.
760   virtual uint64_t
761   do_output_section_offset(unsigned int shndx) const = 0;
762
763   // Set the offset of a section--implemented by child class.
764   virtual void
765   do_set_section_offset(unsigned int shndx, uint64_t off) = 0;
766
767   // Return the vector mapping input sections to output sections.
768   Output_sections&
769   output_sections()
770   { return this->output_sections_; }
771
772   const Output_sections&
773   output_sections() const
774   { return this->output_sections_; }
775
776   // Set the size of the relocatable relocs array.
777   void
778   size_relocatable_relocs()
779   {
780     this->map_to_relocatable_relocs_ =
781       new std::vector<Relocatable_relocs*>(this->shnum());
782   }
783
784   // Record that we must wait for the output sections to be written
785   // before applying relocations.
786   void
787   set_relocs_must_follow_section_writes()
788   { this->relocs_must_follow_section_writes_ = true; }
789
790  private:
791   // Mapping from input sections to output section.
792   Output_sections output_sections_;
793   // Mapping from input section index to the information recorded for
794   // the relocations.  This is only used for a relocatable link.
795   std::vector<Relocatable_relocs*>* map_to_relocatable_relocs_;
796   // Mappings for merge sections.  This is managed by the code in the
797   // Merge_map class.
798   Object_merge_map* object_merge_map_;
799   // Whether we need to wait for output sections to be written before
800   // we can apply relocations.
801   bool relocs_must_follow_section_writes_;
802 };
803
804 // This class is used to handle relocations against a section symbol
805 // in an SHF_MERGE section.  For such a symbol, we need to know the
806 // addend of the relocation before we can determine the final value.
807 // The addend gives us the location in the input section, and we can
808 // determine how it is mapped to the output section.  For a
809 // non-section symbol, we apply the addend to the final value of the
810 // symbol; that is done in finalize_local_symbols, and does not use
811 // this class.
812
813 template<int size>
814 class Merged_symbol_value
815 {
816  public:
817   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value;
818
819   // We use a hash table to map offsets in the input section to output
820   // addresses.
821   typedef Unordered_map<section_offset_type, Value> Output_addresses;
822
823   Merged_symbol_value(Value input_value, Value output_start_address)
824     : input_value_(input_value), output_start_address_(output_start_address),
825       output_addresses_()
826   { }
827
828   // Initialize the hash table.
829   void
830   initialize_input_to_output_map(const Relobj*, unsigned int input_shndx);
831
832   // Release the hash table to save space.
833   void
834   free_input_to_output_map()
835   { this->output_addresses_.clear(); }
836
837   // Get the output value corresponding to an addend.  The object and
838   // input section index are passed in because the caller will have
839   // them; otherwise we could store them here.
840   Value
841   value(const Relobj* object, unsigned int input_shndx, Value addend) const
842   {
843     // This is a relocation against a section symbol.  ADDEND is the
844     // offset in the section.  The result should be the start of some
845     // merge area.  If the object file wants something else, it should
846     // use a regular symbol rather than a section symbol.
847     // Unfortunately, PR 6658 shows a case in which the object file
848     // refers to the section symbol, but uses a negative ADDEND to
849     // compensate for a PC relative reloc.  We can't handle the
850     // general case.  However, we can handle the special case of a
851     // negative addend, by assuming that it refers to the start of the
852     // section.  Of course, that means that we have to guess when
853     // ADDEND is negative.  It is normal to see a 32-bit value here
854     // even when the template parameter size is 64, as 64-bit object
855     // file formats have 32-bit relocations.  We know this is a merge
856     // section, so we know it has to fit into memory.  So we assume
857     // that we won't see a value larger than a large 32-bit unsigned
858     // value.  This will break objects with very very large merge
859     // sections; they probably break in other ways anyhow.
860     Value input_offset = this->input_value_;
861     if (addend < 0xffffff00)
862       {
863         input_offset += addend;
864         addend = 0;
865       }
866     typename Output_addresses::const_iterator p =
867       this->output_addresses_.find(input_offset);
868     if (p != this->output_addresses_.end())
869       return p->second + addend;
870
871     return (this->value_from_output_section(object, input_shndx, input_offset)
872             + addend);
873   }
874
875  private:
876   // Get the output value for an input offset if we couldn't find it
877   // in the hash table.
878   Value
879   value_from_output_section(const Relobj*, unsigned int input_shndx,
880                             Value input_offset) const;
881
882   // The value of the section symbol in the input file.  This is
883   // normally zero, but could in principle be something else.
884   Value input_value_;
885   // The start address of this merged section in the output file.
886   Value output_start_address_;
887   // A hash table which maps offsets in the input section to output
888   // addresses.  This only maps specific offsets, not all offsets.
889   Output_addresses output_addresses_;
890 };
891
892 // This POD class is holds the value of a symbol.  This is used for
893 // local symbols, and for all symbols during relocation processing.
894 // For special sections, such as SHF_MERGE sections, this calls a
895 // function to get the final symbol value.
896
897 template<int size>
898 class Symbol_value
899 {
900  public:
901   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value;
902
903   Symbol_value()
904     : output_symtab_index_(0), output_dynsym_index_(-1U), input_shndx_(0),
905       is_ordinary_shndx_(false), is_section_symbol_(false),
906       is_tls_symbol_(false), has_output_value_(true)
907   { this->u_.value = 0; }
908
909   // Get the value of this symbol.  OBJECT is the object in which this
910   // symbol is defined, and ADDEND is an addend to add to the value.
911   template<bool big_endian>
912   Value
913   value(const Sized_relobj<size, big_endian>* object, Value addend) const
914   {
915     if (this->has_output_value_)
916       return this->u_.value + addend;
917     else
918       {
919         gold_assert(this->is_ordinary_shndx_);
920         return this->u_.merged_symbol_value->value(object, this->input_shndx_,
921                                                    addend);
922       }
923   }
924
925   // Set the value of this symbol in the output symbol table.
926   void
927   set_output_value(Value value)
928   { this->u_.value = value; }
929
930   // For a section symbol in a merged section, we need more
931   // information.
932   void
933   set_merged_symbol_value(Merged_symbol_value<size>* msv)
934   {
935     gold_assert(this->is_section_symbol_);
936     this->has_output_value_ = false;
937     this->u_.merged_symbol_value = msv;
938   }
939
940   // Initialize the input to output map for a section symbol in a
941   // merged section.  We also initialize the value of a non-section
942   // symbol in a merged section.
943   void
944   initialize_input_to_output_map(const Relobj* object)
945   {
946     if (!this->has_output_value_)
947       {
948         gold_assert(this->is_section_symbol_ && this->is_ordinary_shndx_);
949         Merged_symbol_value<size>* msv = this->u_.merged_symbol_value;
950         msv->initialize_input_to_output_map(object, this->input_shndx_);
951       }
952   }
953
954   // Free the input to output map for a section symbol in a merged
955   // section.
956   void
957   free_input_to_output_map()
958   {
959     if (!this->has_output_value_)
960       this->u_.merged_symbol_value->free_input_to_output_map();
961   }
962
963   // Set the value of the symbol from the input file.  This is only
964   // called by count_local_symbols, to communicate the value to
965   // finalize_local_symbols.
966   void
967   set_input_value(Value value)
968   { this->u_.value = value; }
969
970   // Return the input value.  This is only called by
971   // finalize_local_symbols and (in special cases) relocate_section.
972   Value
973   input_value() const
974   { return this->u_.value; }
975
976   // Return whether this symbol should go into the output symbol
977   // table.
978   bool
979   needs_output_symtab_entry() const
980   { return this->output_symtab_index_ != -1U; }
981
982   // Return the index in the output symbol table.
983   unsigned int
984   output_symtab_index() const
985   {
986     gold_assert(this->output_symtab_index_ != 0);
987     return this->output_symtab_index_;
988   }
989
990   // Set the index in the output symbol table.
991   void
992   set_output_symtab_index(unsigned int i)
993   {
994     gold_assert(this->output_symtab_index_ == 0);
995     this->output_symtab_index_ = i;
996   }
997
998   // Record that this symbol should not go into the output symbol
999   // table.
1000   void
1001   set_no_output_symtab_entry()
1002   {
1003     gold_assert(this->output_symtab_index_ == 0);
1004     this->output_symtab_index_ = -1U;
1005   }
1006
1007   // Set the index in the output dynamic symbol table.
1008   void
1009   set_needs_output_dynsym_entry()
1010   {
1011     gold_assert(!this->is_section_symbol());
1012     this->output_dynsym_index_ = 0;
1013   }
1014
1015   // Return whether this symbol should go into the output symbol
1016   // table.
1017   bool
1018   needs_output_dynsym_entry() const
1019   {
1020     return this->output_dynsym_index_ != -1U;
1021   }
1022
1023   // Record that this symbol should go into the dynamic symbol table.
1024   void
1025   set_output_dynsym_index(unsigned int i)
1026   {
1027     gold_assert(this->output_dynsym_index_ == 0);
1028     this->output_dynsym_index_ = i;
1029   }
1030
1031   // Return the index in the output dynamic symbol table.
1032   unsigned int
1033   output_dynsym_index() const
1034   {
1035     gold_assert(this->output_dynsym_index_ != 0
1036                 && this->output_dynsym_index_ != -1U);
1037     return this->output_dynsym_index_;
1038   }
1039
1040   // Set the index of the input section in the input file.
1041   void
1042   set_input_shndx(unsigned int i, bool is_ordinary)
1043   {
1044     this->input_shndx_ = i;
1045     // input_shndx_ field is a bitfield, so make sure that the value
1046     // fits.
1047     gold_assert(this->input_shndx_ == i);
1048     this->is_ordinary_shndx_ = is_ordinary;
1049   }
1050
1051   // Return the index of the input section in the input file.
1052   unsigned int
1053   input_shndx(bool* is_ordinary) const
1054   {
1055     *is_ordinary = this->is_ordinary_shndx_;
1056     return this->input_shndx_;
1057   }
1058
1059   // Whether this is a section symbol.
1060   bool
1061   is_section_symbol() const
1062   { return this->is_section_symbol_; }
1063
1064   // Record that this is a section symbol.
1065   void
1066   set_is_section_symbol()
1067   {
1068     gold_assert(!this->needs_output_dynsym_entry());
1069     this->is_section_symbol_ = true;
1070   }
1071
1072   // Record that this is a TLS symbol.
1073   void
1074   set_is_tls_symbol()
1075   { this->is_tls_symbol_ = true; }
1076
1077   // Return TRUE if this is a TLS symbol.
1078   bool
1079   is_tls_symbol() const
1080   { return this->is_tls_symbol_; }
1081
1082  private:
1083   // The index of this local symbol in the output symbol table.  This
1084   // will be -1 if the symbol should not go into the symbol table.
1085   unsigned int output_symtab_index_;
1086   // The index of this local symbol in the dynamic symbol table.  This
1087   // will be -1 if the symbol should not go into the symbol table.
1088   unsigned int output_dynsym_index_;
1089   // The section index in the input file in which this symbol is
1090   // defined.
1091   unsigned int input_shndx_ : 28;
1092   // Whether the section index is an ordinary index, not a special
1093   // value.
1094   bool is_ordinary_shndx_ : 1;
1095   // Whether this is a STT_SECTION symbol.
1096   bool is_section_symbol_ : 1;
1097   // Whether this is a STT_TLS symbol.
1098   bool is_tls_symbol_ : 1;
1099   // Whether this symbol has a value for the output file.  This is
1100   // normally set to true during Layout::finalize, by
1101   // finalize_local_symbols.  It will be false for a section symbol in
1102   // a merge section, as for such symbols we can not determine the
1103   // value to use in a relocation until we see the addend.
1104   bool has_output_value_ : 1;
1105   union
1106   {
1107     // This is used if has_output_value_ is true.  Between
1108     // count_local_symbols and finalize_local_symbols, this is the
1109     // value in the input file.  After finalize_local_symbols, it is
1110     // the value in the output file.
1111     Value value;
1112     // This is used if has_output_value_ is false.  It points to the
1113     // information we need to get the value for a merge section.
1114     Merged_symbol_value<size>* merged_symbol_value;
1115   } u_;
1116 };
1117
1118 // A GOT offset list.  A symbol may have more than one GOT offset
1119 // (e.g., when mixing modules compiled with two different TLS models),
1120 // but will usually have at most one.  GOT_TYPE identifies the type of
1121 // GOT entry; its values are specific to each target.
1122
1123 class Got_offset_list
1124 {
1125  public:
1126   Got_offset_list()
1127     : got_type_(-1U), got_offset_(0), got_next_(NULL)
1128   { }
1129
1130   Got_offset_list(unsigned int got_type, unsigned int got_offset)
1131     : got_type_(got_type), got_offset_(got_offset), got_next_(NULL)
1132   { }
1133
1134   ~Got_offset_list()
1135   { 
1136     if (this->got_next_ != NULL)
1137       {
1138         delete this->got_next_;
1139         this->got_next_ = NULL;
1140       }
1141   }
1142
1143   // Initialize the fields to their default values.
1144   void
1145   init()
1146   {
1147     this->got_type_ = -1U;
1148     this->got_offset_ = 0;
1149     this->got_next_ = NULL;
1150   }
1151
1152   // Set the offset for the GOT entry of type GOT_TYPE.
1153   void
1154   set_offset(unsigned int got_type, unsigned int got_offset)
1155   {
1156     if (this->got_type_ == -1U)
1157       {
1158         this->got_type_ = got_type;
1159         this->got_offset_ = got_offset;
1160       }
1161     else
1162       {
1163         for (Got_offset_list* g = this; g != NULL; g = g->got_next_)
1164           {
1165             if (g->got_type_ == got_type)
1166               {
1167                 g->got_offset_ = got_offset;
1168                 return;
1169               }
1170           }
1171         Got_offset_list* g = new Got_offset_list(got_type, got_offset);
1172         g->got_next_ = this->got_next_;
1173         this->got_next_ = g;
1174       }
1175   }
1176
1177   // Return the offset for a GOT entry of type GOT_TYPE.
1178   unsigned int
1179   get_offset(unsigned int got_type) const
1180   {
1181     for (const Got_offset_list* g = this; g != NULL; g = g->got_next_)
1182       {
1183         if (g->got_type_ == got_type)
1184           return g->got_offset_;
1185       }
1186     return -1U;
1187   }
1188
1189  private:
1190   unsigned int got_type_;
1191   unsigned int got_offset_;
1192   Got_offset_list* got_next_;
1193 };
1194
1195 // A regular object file.  This is size and endian specific.
1196
1197 template<int size, bool big_endian>
1198 class Sized_relobj : public Relobj
1199 {
1200  public:
1201   typedef typename elfcpp::Elf_types<size>::Elf_Addr Address;
1202   typedef std::vector<Symbol*> Symbols;
1203   typedef std::vector<Symbol_value<size> > Local_values;
1204
1205   Sized_relobj(const std::string& name, Input_file* input_file, off_t offset,
1206                const typename elfcpp::Ehdr<size, big_endian>&);
1207
1208   ~Sized_relobj();
1209
1210   // Set up the object file based on the ELF header.
1211   void
1212   setup(const typename elfcpp::Ehdr<size, big_endian>&);
1213
1214   // Return the number of symbols.  This is only valid after
1215   // Object::add_symbols has been called.
1216   unsigned int
1217   symbol_count() const
1218   { return this->local_symbol_count_ + this->symbols_.size(); }
1219
1220   // If SYM is the index of a global symbol in the object file's
1221   // symbol table, return the Symbol object.  Otherwise, return NULL.
1222   Symbol*
1223   global_symbol(unsigned int sym) const
1224   {
1225     if (sym >= this->local_symbol_count_)
1226       {
1227         gold_assert(sym - this->local_symbol_count_ < this->symbols_.size());
1228         return this->symbols_[sym - this->local_symbol_count_];
1229       }
1230     return NULL;
1231   }
1232
1233   // Return the section index of symbol SYM.  Set *VALUE to its value
1234   // in the object file.  Set *IS_ORDINARY if this is an ordinary
1235   // section index, not a special code between SHN_LORESERVE and
1236   // SHN_HIRESERVE.  Note that for a symbol which is not defined in
1237   // this object file, this will set *VALUE to 0 and return SHN_UNDEF;
1238   // it will not return the final value of the symbol in the link.
1239   unsigned int
1240   symbol_section_and_value(unsigned int sym, Address* value, bool* is_ordinary);
1241
1242   // Return a pointer to the Symbol_value structure which holds the
1243   // value of a local symbol.
1244   const Symbol_value<size>*
1245   local_symbol(unsigned int sym) const
1246   {
1247     gold_assert(sym < this->local_values_.size());
1248     return &this->local_values_[sym];
1249   }
1250
1251   // Return the index of local symbol SYM in the ordinary symbol
1252   // table.  A value of -1U means that the symbol is not being output.
1253   unsigned int
1254   symtab_index(unsigned int sym) const
1255   {
1256     gold_assert(sym < this->local_values_.size());
1257     return this->local_values_[sym].output_symtab_index();
1258   }
1259
1260   // Return the index of local symbol SYM in the dynamic symbol
1261   // table.  A value of -1U means that the symbol is not being output.
1262   unsigned int
1263   dynsym_index(unsigned int sym) const
1264   {
1265     gold_assert(sym < this->local_values_.size());
1266     return this->local_values_[sym].output_dynsym_index();
1267   }
1268
1269   // Return the input section index of local symbol SYM.
1270   unsigned int
1271   local_symbol_input_shndx(unsigned int sym, bool* is_ordinary) const
1272   {
1273     gold_assert(sym < this->local_values_.size());
1274     return this->local_values_[sym].input_shndx(is_ordinary);
1275   }
1276
1277   // Return the appropriate Sized_target structure.
1278   Sized_target<size, big_endian>*
1279   sized_target()
1280   { return this->Object::sized_target<size, big_endian>(); }
1281
1282   // Record that local symbol SYM needs a dynamic symbol entry.
1283   void
1284   set_needs_output_dynsym_entry(unsigned int sym)
1285   {
1286     gold_assert(sym < this->local_values_.size());
1287     this->local_values_[sym].set_needs_output_dynsym_entry();
1288   }
1289
1290   // Return whether the local symbol SYMNDX has a GOT offset.
1291   // For TLS symbols, the GOT entry will hold its tp-relative offset.
1292   bool
1293   local_has_got_offset(unsigned int symndx, unsigned int got_type) const
1294   {
1295     Local_got_offsets::const_iterator p =
1296         this->local_got_offsets_.find(symndx);
1297     return (p != this->local_got_offsets_.end()
1298             && p->second->get_offset(got_type) != -1U);
1299   }
1300
1301   // Return the GOT offset of the local symbol SYMNDX.
1302   unsigned int
1303   local_got_offset(unsigned int symndx, unsigned int got_type) const
1304   {
1305     Local_got_offsets::const_iterator p =
1306         this->local_got_offsets_.find(symndx);
1307     gold_assert(p != this->local_got_offsets_.end());
1308     unsigned int off = p->second->get_offset(got_type);
1309     gold_assert(off != -1U);
1310     return off;
1311   }
1312
1313   // Set the GOT offset of the local symbol SYMNDX to GOT_OFFSET.
1314   void
1315   set_local_got_offset(unsigned int symndx, unsigned int got_type,
1316                        unsigned int got_offset)
1317   {
1318     Local_got_offsets::const_iterator p =
1319         this->local_got_offsets_.find(symndx);
1320     if (p != this->local_got_offsets_.end())
1321       p->second->set_offset(got_type, got_offset);
1322     else
1323       {
1324         Got_offset_list* g = new Got_offset_list(got_type, got_offset);
1325         std::pair<Local_got_offsets::iterator, bool> ins =
1326             this->local_got_offsets_.insert(std::make_pair(symndx, g));
1327         gold_assert(ins.second);
1328       }
1329   }
1330
1331   // Get the offset of input section SHNDX within its output section.
1332   // This is -1 if the input section requires a special mapping, such
1333   // as a merge section.  The output section can be found in the
1334   // output_sections_ field of the parent class Relobj.
1335   Address
1336   get_output_section_offset(unsigned int shndx) const
1337   {
1338     gold_assert(shndx < this->section_offsets_.size());
1339     return this->section_offsets_[shndx];
1340   }
1341
1342   // Return the name of the symbol that spans the given offset in the
1343   // specified section in this object.  This is used only for error
1344   // messages and is not particularly efficient.
1345   bool
1346   get_symbol_location_info(unsigned int shndx, off_t offset,
1347                            Symbol_location_info* info);
1348
1349   // Look for a kept section corresponding to the given discarded section,
1350   // and return its output address.  This is used only for relocations in
1351   // debugging sections.
1352   Address
1353   map_to_kept_section(unsigned int shndx, bool* found) const;
1354
1355  protected:
1356   // Read the symbols.
1357   void
1358   do_read_symbols(Read_symbols_data*);
1359
1360   // Return the number of local symbols.
1361   unsigned int
1362   do_local_symbol_count() const
1363   { return this->local_symbol_count_; }
1364
1365   // Lay out the input sections.
1366   void
1367   do_layout(Symbol_table*, Layout*, Read_symbols_data*);
1368
1369   // Add the symbols to the symbol table.
1370   void
1371   do_add_symbols(Symbol_table*, Read_symbols_data*);
1372
1373   // Read the relocs.
1374   void
1375   do_read_relocs(Read_relocs_data*);
1376
1377   // Scan the relocs and adjust the symbol table.
1378   void
1379   do_scan_relocs(const General_options&, Symbol_table*, Layout*,
1380                  Read_relocs_data*);
1381
1382   // Count the local symbols.
1383   void
1384   do_count_local_symbols(Stringpool_template<char>*,
1385                             Stringpool_template<char>*);
1386
1387   // Finalize the local symbols.
1388   unsigned int
1389   do_finalize_local_symbols(unsigned int, off_t);
1390
1391   // Set the offset where local dynamic symbol information will be stored.
1392   unsigned int
1393   do_set_local_dynsym_indexes(unsigned int);
1394
1395   // Set the offset where local dynamic symbol information will be stored.
1396   unsigned int
1397   do_set_local_dynsym_offset(off_t);
1398
1399   // Relocate the input sections and write out the local symbols.
1400   void
1401   do_relocate(const General_options& options, const Symbol_table* symtab,
1402               const Layout*, Output_file* of);
1403
1404   // Get the size of a section.
1405   uint64_t
1406   do_section_size(unsigned int shndx)
1407   { return this->elf_file_.section_size(shndx); }
1408
1409   // Get the name of a section.
1410   std::string
1411   do_section_name(unsigned int shndx)
1412   { return this->elf_file_.section_name(shndx); }
1413
1414   // Return the location of the contents of a section.
1415   Object::Location
1416   do_section_contents(unsigned int shndx)
1417   { return this->elf_file_.section_contents(shndx); }
1418
1419   // Return section flags.
1420   uint64_t
1421   do_section_flags(unsigned int shndx)
1422   { return this->elf_file_.section_flags(shndx); }
1423
1424   // Return section address.
1425   uint64_t
1426   do_section_address(unsigned int shndx)
1427   { return this->elf_file_.section_addr(shndx); }
1428
1429   // Return section type.
1430   unsigned int
1431   do_section_type(unsigned int shndx)
1432   { return this->elf_file_.section_type(shndx); }
1433
1434   // Return the section link field.
1435   unsigned int
1436   do_section_link(unsigned int shndx)
1437   { return this->elf_file_.section_link(shndx); }
1438
1439   // Return the section info field.
1440   unsigned int
1441   do_section_info(unsigned int shndx)
1442   { return this->elf_file_.section_info(shndx); }
1443
1444   // Return the section alignment.
1445   uint64_t
1446   do_section_addralign(unsigned int shndx)
1447   { return this->elf_file_.section_addralign(shndx); }
1448
1449   // Return the Xindex structure to use.
1450   Xindex*
1451   do_initialize_xindex();
1452
1453   // Get symbol counts.
1454   void
1455   do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
1456
1457   // Get the offset of a section.
1458   uint64_t
1459   do_output_section_offset(unsigned int shndx) const
1460   { return this->get_output_section_offset(shndx); }
1461
1462   // Set the offset of a section.
1463   void
1464   do_set_section_offset(unsigned int shndx, uint64_t off)
1465   {
1466     gold_assert(shndx < this->section_offsets_.size());
1467     this->section_offsets_[shndx] = convert_types<Address, uint64_t>(off);
1468   }
1469
1470  private:
1471   // For convenience.
1472   typedef Sized_relobj<size, big_endian> This;
1473   static const int ehdr_size = elfcpp::Elf_sizes<size>::ehdr_size;
1474   static const int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
1475   static const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
1476   typedef elfcpp::Shdr<size, big_endian> Shdr;
1477
1478   // To keep track of discarded comdat sections, we need to map a member
1479   // section index to the object and section index of the corresponding
1480   // kept section.
1481   struct Kept_comdat_section
1482   {
1483     Kept_comdat_section(Sized_relobj<size, big_endian>* object,
1484                         unsigned int shndx)
1485       : object_(object), shndx_(shndx)
1486     { }
1487     Sized_relobj<size, big_endian>* object_;
1488     unsigned int shndx_;
1489   };
1490   typedef std::map<unsigned int, Kept_comdat_section*>
1491       Kept_comdat_section_table;
1492
1493   // Information needed to keep track of kept comdat groups.  This is
1494   // simply a map from the section name to its section index.  This may
1495   // not be a one-to-one mapping, but we ignore that possibility since
1496   // this is used only to attempt to handle stray relocations from
1497   // non-comdat debug sections that refer to comdat loadable sections.
1498   typedef Unordered_map<std::string, unsigned int> Comdat_group;
1499
1500   // A map from group section index to the table of group members.
1501   typedef std::map<unsigned int, Comdat_group*> Comdat_group_table;
1502
1503   // Find a comdat group table given its group section SHNDX.
1504   Comdat_group*
1505   find_comdat_group(unsigned int shndx) const
1506   {
1507     Comdat_group_table::const_iterator p =
1508       this->comdat_groups_.find(shndx);
1509     if (p != this->comdat_groups_.end())
1510       return p->second;
1511     return NULL;
1512   }
1513
1514   // Record a new comdat group whose group section index is SHNDX.
1515   void
1516   add_comdat_group(unsigned int shndx, Comdat_group* group)
1517   { this->comdat_groups_[shndx] = group; }
1518
1519   // Adjust a section index if necessary.
1520   unsigned int
1521   adjust_shndx(unsigned int shndx)
1522   {
1523     if (shndx >= elfcpp::SHN_LORESERVE)
1524       shndx += this->elf_file_.large_shndx_offset();
1525     return shndx;
1526   }
1527
1528   // Find the SHT_SYMTAB section, given the section headers.
1529   void
1530   find_symtab(const unsigned char* pshdrs);
1531
1532   // Return whether SHDR has the right flags for a GNU style exception
1533   // frame section.
1534   bool
1535   check_eh_frame_flags(const elfcpp::Shdr<size, big_endian>* shdr) const;
1536
1537   // Return whether there is a section named .eh_frame which might be
1538   // a GNU style exception frame section.
1539   bool
1540   find_eh_frame(const unsigned char* pshdrs, const char* names,
1541                 section_size_type names_size) const;
1542
1543   // Whether to include a section group in the link.
1544   bool
1545   include_section_group(Symbol_table*, Layout*, unsigned int, const char*,
1546                         const unsigned char*, const char *, section_size_type,
1547                         std::vector<bool>*);
1548
1549   // Whether to include a linkonce section in the link.
1550   bool
1551   include_linkonce_section(Layout*, unsigned int, const char*,
1552                            const elfcpp::Shdr<size, big_endian>&);
1553
1554   // Views and sizes when relocating.
1555   struct View_size
1556   {
1557     unsigned char* view;
1558     typename elfcpp::Elf_types<size>::Elf_Addr address;
1559     off_t offset;
1560     section_size_type view_size;
1561     bool is_input_output_view;
1562     bool is_postprocessing_view;
1563   };
1564
1565   typedef std::vector<View_size> Views;
1566
1567   // Write section data to the output file.  Record the views and
1568   // sizes in VIEWS for use when relocating.
1569   void
1570   write_sections(const unsigned char* pshdrs, Output_file*, Views*);
1571
1572   // Relocate the sections in the output file.
1573   void
1574   relocate_sections(const General_options& options, const Symbol_table*,
1575                     const Layout*, const unsigned char* pshdrs, Views*);
1576
1577   // Scan the input relocations for --emit-relocs.
1578   void
1579   emit_relocs_scan(const General_options&, Symbol_table*, Layout*,
1580                    const unsigned char* plocal_syms,
1581                    const Read_relocs_data::Relocs_list::iterator&);
1582
1583   // Scan the input relocations for --emit-relocs, templatized on the
1584   // type of the relocation section.
1585   template<int sh_type>
1586   void
1587   emit_relocs_scan_reltype(const General_options&, Symbol_table*, Layout*,
1588                            const unsigned char* plocal_syms,
1589                            const Read_relocs_data::Relocs_list::iterator&,
1590                            Relocatable_relocs*);
1591
1592   // Emit the relocs for --emit-relocs.
1593   void
1594   emit_relocs(const Relocate_info<size, big_endian>*, unsigned int,
1595               unsigned int sh_type, const unsigned char* prelocs,
1596               size_t reloc_count, Output_section*, Address output_offset,
1597               unsigned char* view, Address address,
1598               section_size_type view_size,
1599               unsigned char* reloc_view, section_size_type reloc_view_size);
1600
1601   // Emit the relocs for --emit-relocs, templatized on the type of the
1602   // relocation section.
1603   template<int sh_type>
1604   void
1605   emit_relocs_reltype(const Relocate_info<size, big_endian>*, unsigned int,
1606                       const unsigned char* prelocs, size_t reloc_count,
1607                       Output_section*, Address output_offset,
1608                       unsigned char* view, Address address,
1609                       section_size_type view_size,
1610                       unsigned char* reloc_view,
1611                       section_size_type reloc_view_size);
1612
1613   // Initialize input to output maps for section symbols in merged
1614   // sections.
1615   void
1616   initialize_input_to_output_maps();
1617
1618   // Free the input to output maps for section symbols in merged
1619   // sections.
1620   void
1621   free_input_to_output_maps();
1622
1623   // Write out the local symbols.
1624   void
1625   write_local_symbols(Output_file*,
1626                       const Stringpool_template<char>*,
1627                       const Stringpool_template<char>*,
1628                       Output_symtab_xindex*,
1629                       Output_symtab_xindex*);
1630
1631   // Clear the local symbol information.
1632   void
1633   clear_local_symbols()
1634   {
1635     this->local_values_.clear();
1636     this->local_got_offsets_.clear();
1637   }
1638
1639   // Record a mapping from discarded section SHNDX to the corresponding
1640   // kept section.
1641   void
1642   set_kept_comdat_section(unsigned int shndx, Kept_comdat_section* kept)
1643   {
1644     this->kept_comdat_sections_[shndx] = kept;
1645   }
1646
1647   // Find the kept section corresponding to the discarded section SHNDX.
1648   Kept_comdat_section*
1649   get_kept_comdat_section(unsigned int shndx) const
1650   {
1651     typename Kept_comdat_section_table::const_iterator p =
1652       this->kept_comdat_sections_.find(shndx);
1653     if (p == this->kept_comdat_sections_.end())
1654       return NULL;
1655     return p->second;
1656   }
1657
1658   // The GOT offsets of local symbols. This map also stores GOT offsets
1659   // for tp-relative offsets for TLS symbols.
1660   typedef Unordered_map<unsigned int, Got_offset_list*> Local_got_offsets;
1661
1662   // The TLS GOT offsets of local symbols. The map stores the offsets
1663   // for either a single GOT entry that holds the module index of a TLS
1664   // symbol, or a pair of GOT entries containing the module index and
1665   // dtv-relative offset.
1666   struct Tls_got_entry
1667   {
1668     Tls_got_entry(int got_offset, bool have_pair)
1669       : got_offset_(got_offset),
1670         have_pair_(have_pair)
1671     { }
1672     int got_offset_;
1673     bool have_pair_;
1674   };
1675   typedef Unordered_map<unsigned int, Tls_got_entry> Local_tls_got_offsets;
1676
1677   // General access to the ELF file.
1678   elfcpp::Elf_file<size, big_endian, Object> elf_file_;
1679   // Index of SHT_SYMTAB section.
1680   unsigned int symtab_shndx_;
1681   // The number of local symbols.
1682   unsigned int local_symbol_count_;
1683   // The number of local symbols which go into the output file.
1684   unsigned int output_local_symbol_count_;
1685   // The number of local symbols which go into the output file's dynamic
1686   // symbol table.
1687   unsigned int output_local_dynsym_count_;
1688   // The entries in the symbol table for the external symbols.
1689   Symbols symbols_;
1690   // Number of symbols defined in object file itself.
1691   size_t defined_count_;
1692   // File offset for local symbols.
1693   off_t local_symbol_offset_;
1694   // File offset for local dynamic symbols.
1695   off_t local_dynsym_offset_;
1696   // Values of local symbols.
1697   Local_values local_values_;
1698   // GOT offsets for local non-TLS symbols, and tp-relative offsets
1699   // for TLS symbols, indexed by symbol number.
1700   Local_got_offsets local_got_offsets_;
1701   // For each input section, the offset of the input section in its
1702   // output section.  This is -1U if the input section requires a
1703   // special mapping.
1704   std::vector<Address> section_offsets_;
1705   // Table mapping discarded comdat sections to corresponding kept sections.
1706   Kept_comdat_section_table kept_comdat_sections_;
1707   // Table of kept comdat groups.
1708   Comdat_group_table comdat_groups_;
1709   // Whether this object has a GNU style .eh_frame section.
1710   bool has_eh_frame_;
1711 };
1712
1713 // A class to manage the list of all objects.
1714
1715 class Input_objects
1716 {
1717  public:
1718   Input_objects()
1719     : relobj_list_(), dynobj_list_(), sonames_(), system_library_directory_(),
1720       cref_(NULL)
1721   { }
1722
1723   // The type of the list of input relocateable objects.
1724   typedef std::vector<Relobj*> Relobj_list;
1725   typedef Relobj_list::const_iterator Relobj_iterator;
1726
1727   // The type of the list of input dynamic objects.
1728   typedef std::vector<Dynobj*> Dynobj_list;
1729   typedef Dynobj_list::const_iterator Dynobj_iterator;
1730
1731   // Add an object to the list.  Return true if all is well, or false
1732   // if this object should be ignored.
1733   bool
1734   add_object(Object*);
1735
1736   // Start processing an archive.
1737   void
1738   archive_start(Archive*);
1739
1740   // Stop processing an archive.
1741   void
1742   archive_stop(Archive*);
1743
1744   // For each dynamic object, check whether we've seen all of its
1745   // explicit dependencies.
1746   void
1747   check_dynamic_dependencies() const;
1748
1749   // Return whether an object was found in the system library
1750   // directory.
1751   bool
1752   found_in_system_library_directory(const Object*) const;
1753
1754   // Print symbol counts.
1755   void
1756   print_symbol_counts(const Symbol_table*) const;
1757
1758   // Iterate over all regular objects.
1759
1760   Relobj_iterator
1761   relobj_begin() const
1762   { return this->relobj_list_.begin(); }
1763
1764   Relobj_iterator
1765   relobj_end() const
1766   { return this->relobj_list_.end(); }
1767
1768   // Iterate over all dynamic objects.
1769
1770   Dynobj_iterator
1771   dynobj_begin() const
1772   { return this->dynobj_list_.begin(); }
1773
1774   Dynobj_iterator
1775   dynobj_end() const
1776   { return this->dynobj_list_.end(); }
1777
1778   // Return whether we have seen any dynamic objects.
1779   bool
1780   any_dynamic() const
1781   { return !this->dynobj_list_.empty(); }
1782
1783   // Return the number of input objects.
1784   int
1785   number_of_input_objects() const
1786   { return this->relobj_list_.size() + this->dynobj_list_.size(); }
1787
1788  private:
1789   Input_objects(const Input_objects&);
1790   Input_objects& operator=(const Input_objects&);
1791
1792   // The list of ordinary objects included in the link.
1793   Relobj_list relobj_list_;
1794   // The list of dynamic objects included in the link.
1795   Dynobj_list dynobj_list_;
1796   // SONAMEs that we have seen.
1797   Unordered_set<std::string> sonames_;
1798   // The directory in which we find the libc.so.
1799   std::string system_library_directory_;
1800   // Manage cross-references if requested.
1801   Cref* cref_;
1802 };
1803
1804 // Some of the information we pass to the relocation routines.  We
1805 // group this together to avoid passing a dozen different arguments.
1806
1807 template<int size, bool big_endian>
1808 struct Relocate_info
1809 {
1810   // Command line options.
1811   const General_options* options;
1812   // Symbol table.
1813   const Symbol_table* symtab;
1814   // Layout.
1815   const Layout* layout;
1816   // Object being relocated.
1817   Sized_relobj<size, big_endian>* object;
1818   // Section index of relocation section.
1819   unsigned int reloc_shndx;
1820   // Section index of section being relocated.
1821   unsigned int data_shndx;
1822
1823   // Return a string showing the location of a relocation.  This is
1824   // only used for error messages.
1825   std::string
1826   location(size_t relnum, off_t reloffset) const;
1827 };
1828
1829 // Return an Object appropriate for the input file.  P is BYTES long,
1830 // and holds the ELF header.
1831
1832 extern Object*
1833 make_elf_object(const std::string& name, Input_file*,
1834                 off_t offset, const unsigned char* p,
1835                 section_offset_type bytes);
1836
1837 } // end namespace gold
1838
1839 #endif // !defined(GOLD_OBJECT_H)