merge from gcc
[external/binutils.git] / gold / symtab.h
1 // symtab.h -- the gold symbol table   -*- C++ -*-
2
3 // Copyright 2006, 2007, 2008, 2009 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 // Symbol_table
24 //   The symbol table.
25
26 #include <string>
27 #include <utility>
28 #include <vector>
29
30 #include "gc.h"
31 #include "icf.h"
32 #include "elfcpp.h"
33 #include "parameters.h"
34 #include "stringpool.h"
35 #include "object.h"
36
37 #ifndef GOLD_SYMTAB_H
38 #define GOLD_SYMTAB_H
39
40 namespace gold
41 {
42
43 class Mapfile;
44 class Object;
45 class Relobj;
46 template<int size, bool big_endian>
47 class Sized_relobj;
48 template<int size, bool big_endian>
49 class Sized_pluginobj;
50 class Dynobj;
51 template<int size, bool big_endian>
52 class Sized_dynobj;
53 class Versions;
54 class Version_script_info;
55 class Input_objects;
56 class Output_data;
57 class Output_section;
58 class Output_segment;
59 class Output_file;
60 class Output_symtab_xindex;
61 class Garbage_collection;
62 class Icf;
63
64 // The base class of an entry in the symbol table.  The symbol table
65 // can have a lot of entries, so we don't want this class to big.
66 // Size dependent fields can be found in the template class
67 // Sized_symbol.  Targets may support their own derived classes.
68
69 class Symbol
70 {
71  public:
72   // Because we want the class to be small, we don't use any virtual
73   // functions.  But because symbols can be defined in different
74   // places, we need to classify them.  This enum is the different
75   // sources of symbols we support.
76   enum Source
77   {
78     // Symbol defined in a relocatable or dynamic input file--this is
79     // the most common case.
80     FROM_OBJECT,
81     // Symbol defined in an Output_data, a special section created by
82     // the target.
83     IN_OUTPUT_DATA,
84     // Symbol defined in an Output_segment, with no associated
85     // section.
86     IN_OUTPUT_SEGMENT,
87     // Symbol value is constant.
88     IS_CONSTANT,
89     // Symbol is undefined.
90     IS_UNDEFINED
91   };
92
93   // When the source is IN_OUTPUT_SEGMENT, we need to describe what
94   // the offset means.
95   enum Segment_offset_base
96   {
97     // From the start of the segment.
98     SEGMENT_START,
99     // From the end of the segment.
100     SEGMENT_END,
101     // From the filesz of the segment--i.e., after the loaded bytes
102     // but before the bytes which are allocated but zeroed.
103     SEGMENT_BSS
104   };
105
106   // Return the symbol name.
107   const char*
108   name() const
109   { return this->name_; }
110
111   // Return the (ANSI) demangled version of the name, if
112   // parameters.demangle() is true.  Otherwise, return the name.  This
113   // is intended to be used only for logging errors, so it's not
114   // super-efficient.
115   std::string
116   demangled_name() const;
117
118   // Return the symbol version.  This will return NULL for an
119   // unversioned symbol.
120   const char*
121   version() const
122   { return this->version_; }
123
124   // Return whether this version is the default for this symbol name
125   // (eg, "foo@@V2" is a default version; "foo@V1" is not).  Only
126   // meaningful for versioned symbols.
127   bool
128   is_default() const
129   {
130     gold_assert(this->version_ != NULL);
131     return this->is_def_;
132   }
133
134   // Set that this version is the default for this symbol name.
135   void
136   set_is_default()
137   { this->is_def_ = true; }
138
139   // Return the symbol source.
140   Source
141   source() const
142   { return this->source_; }
143
144   // Return the object with which this symbol is associated.
145   Object*
146   object() const
147   {
148     gold_assert(this->source_ == FROM_OBJECT);
149     return this->u_.from_object.object;
150   }
151
152   // Return the index of the section in the input relocatable or
153   // dynamic object file.
154   unsigned int
155   shndx(bool* is_ordinary) const
156   {
157     gold_assert(this->source_ == FROM_OBJECT);
158     *is_ordinary = this->is_ordinary_shndx_;
159     return this->u_.from_object.shndx;
160   }
161
162   // Return the output data section with which this symbol is
163   // associated, if the symbol was specially defined with respect to
164   // an output data section.
165   Output_data*
166   output_data() const
167   {
168     gold_assert(this->source_ == IN_OUTPUT_DATA);
169     return this->u_.in_output_data.output_data;
170   }
171
172   // If this symbol was defined with respect to an output data
173   // section, return whether the value is an offset from end.
174   bool
175   offset_is_from_end() const
176   {
177     gold_assert(this->source_ == IN_OUTPUT_DATA);
178     return this->u_.in_output_data.offset_is_from_end;
179   }
180
181   // Return the output segment with which this symbol is associated,
182   // if the symbol was specially defined with respect to an output
183   // segment.
184   Output_segment*
185   output_segment() const
186   {
187     gold_assert(this->source_ == IN_OUTPUT_SEGMENT);
188     return this->u_.in_output_segment.output_segment;
189   }
190
191   // If this symbol was defined with respect to an output segment,
192   // return the offset base.
193   Segment_offset_base
194   offset_base() const
195   {
196     gold_assert(this->source_ == IN_OUTPUT_SEGMENT);
197     return this->u_.in_output_segment.offset_base;
198   }
199
200   // Return the symbol binding.
201   elfcpp::STB
202   binding() const
203   { return this->binding_; }
204
205   // Return the symbol type.
206   elfcpp::STT
207   type() const
208   { return this->type_; }
209
210   // Return the symbol visibility.
211   elfcpp::STV
212   visibility() const
213   { return this->visibility_; }
214
215   // Set the visibility.
216   void
217   set_visibility(elfcpp::STV visibility)
218   { this->visibility_ = visibility; }
219
220   // Override symbol visibility.
221   void
222   override_visibility(elfcpp::STV);
223
224   // Return the non-visibility part of the st_other field.
225   unsigned char
226   nonvis() const
227   { return this->nonvis_; }
228
229   // Return whether this symbol is a forwarder.  This will never be
230   // true of a symbol found in the hash table, but may be true of
231   // symbol pointers attached to object files.
232   bool
233   is_forwarder() const
234   { return this->is_forwarder_; }
235
236   // Mark this symbol as a forwarder.
237   void
238   set_forwarder()
239   { this->is_forwarder_ = true; }
240
241   // Return whether this symbol has an alias in the weak aliases table
242   // in Symbol_table.
243   bool
244   has_alias() const
245   { return this->has_alias_; }
246
247   // Mark this symbol as having an alias.
248   void
249   set_has_alias()
250   { this->has_alias_ = true; }
251
252   // Return whether this symbol needs an entry in the dynamic symbol
253   // table.
254   bool
255   needs_dynsym_entry() const
256   {
257     return (this->needs_dynsym_entry_
258             || (this->in_reg() && this->in_dyn()));
259   }
260
261   // Mark this symbol as needing an entry in the dynamic symbol table.
262   void
263   set_needs_dynsym_entry()
264   { this->needs_dynsym_entry_ = true; }
265
266   // Return whether this symbol should be added to the dynamic symbol
267   // table.
268   bool
269   should_add_dynsym_entry() const;
270
271   // Return whether this symbol has been seen in a regular object.
272   bool
273   in_reg() const
274   { return this->in_reg_; }
275
276   // Mark this symbol as having been seen in a regular object.
277   void
278   set_in_reg()
279   { this->in_reg_ = true; }
280
281   // Return whether this symbol has been seen in a dynamic object.
282   bool
283   in_dyn() const
284   { return this->in_dyn_; }
285
286   // Mark this symbol as having been seen in a dynamic object.
287   void
288   set_in_dyn()
289   { this->in_dyn_ = true; }
290
291   // Return whether this symbol has been seen in a real ELF object.
292   // (IN_REG will return TRUE if the symbol has been seen in either
293   // a real ELF object or an object claimed by a plugin.)
294   bool
295   in_real_elf() const
296   { return this->in_real_elf_; }
297
298   // Mark this symbol as having been seen in a real ELF object.
299   void
300   set_in_real_elf()
301   { this->in_real_elf_ = true; }
302
303   // Return the index of this symbol in the output file symbol table.
304   // A value of -1U means that this symbol is not going into the
305   // output file.  This starts out as zero, and is set to a non-zero
306   // value by Symbol_table::finalize.  It is an error to ask for the
307   // symbol table index before it has been set.
308   unsigned int
309   symtab_index() const
310   {
311     gold_assert(this->symtab_index_ != 0);
312     return this->symtab_index_;
313   }
314
315   // Set the index of the symbol in the output file symbol table.
316   void
317   set_symtab_index(unsigned int index)
318   {
319     gold_assert(index != 0);
320     this->symtab_index_ = index;
321   }
322
323   // Return whether this symbol already has an index in the output
324   // file symbol table.
325   bool
326   has_symtab_index() const
327   { return this->symtab_index_ != 0; }
328
329   // Return the index of this symbol in the dynamic symbol table.  A
330   // value of -1U means that this symbol is not going into the dynamic
331   // symbol table.  This starts out as zero, and is set to a non-zero
332   // during Layout::finalize.  It is an error to ask for the dynamic
333   // symbol table index before it has been set.
334   unsigned int
335   dynsym_index() const
336   {
337     gold_assert(this->dynsym_index_ != 0);
338     return this->dynsym_index_;
339   }
340
341   // Set the index of the symbol in the dynamic symbol table.
342   void
343   set_dynsym_index(unsigned int index)
344   {
345     gold_assert(index != 0);
346     this->dynsym_index_ = index;
347   }
348
349   // Return whether this symbol already has an index in the dynamic
350   // symbol table.
351   bool
352   has_dynsym_index() const
353   { return this->dynsym_index_ != 0; }
354
355   // Return whether this symbol has an entry in the GOT section.
356   // For a TLS symbol, this GOT entry will hold its tp-relative offset.
357   bool
358   has_got_offset(unsigned int got_type) const
359   { return this->got_offsets_.get_offset(got_type) != -1U; }
360
361   // Return the offset into the GOT section of this symbol.
362   unsigned int
363   got_offset(unsigned int got_type) const
364   {
365     unsigned int got_offset = this->got_offsets_.get_offset(got_type);
366     gold_assert(got_offset != -1U);
367     return got_offset;
368   }
369
370   // Set the GOT offset of this symbol.
371   void
372   set_got_offset(unsigned int got_type, unsigned int got_offset)
373   { this->got_offsets_.set_offset(got_type, got_offset); }
374
375   // Return whether this symbol has an entry in the PLT section.
376   bool
377   has_plt_offset() const
378   { return this->has_plt_offset_; }
379
380   // Return the offset into the PLT section of this symbol.
381   unsigned int
382   plt_offset() const
383   {
384     gold_assert(this->has_plt_offset());
385     return this->plt_offset_;
386   }
387
388   // Set the PLT offset of this symbol.
389   void
390   set_plt_offset(unsigned int plt_offset)
391   {
392     this->has_plt_offset_ = true;
393     this->plt_offset_ = plt_offset;
394   }
395
396   // Return whether this dynamic symbol needs a special value in the
397   // dynamic symbol table.
398   bool
399   needs_dynsym_value() const
400   { return this->needs_dynsym_value_; }
401
402   // Set that this dynamic symbol needs a special value in the dynamic
403   // symbol table.
404   void
405   set_needs_dynsym_value()
406   {
407     gold_assert(this->object()->is_dynamic());
408     this->needs_dynsym_value_ = true;
409   }
410
411   // Return true if the final value of this symbol is known at link
412   // time.
413   bool
414   final_value_is_known() const;
415
416   // Return true if SHNDX represents a common symbol.  This depends on
417   // the target.
418   static bool
419   is_common_shndx(unsigned int shndx);
420
421   // Return whether this is a defined symbol (not undefined or
422   // common).
423   bool
424   is_defined() const
425   {
426     bool is_ordinary;
427     if (this->source_ != FROM_OBJECT)
428       return this->source_ != IS_UNDEFINED;
429     unsigned int shndx = this->shndx(&is_ordinary);
430     return (is_ordinary
431             ? shndx != elfcpp::SHN_UNDEF
432             : !Symbol::is_common_shndx(shndx));
433   }
434
435   // Return true if this symbol is from a dynamic object.
436   bool
437   is_from_dynobj() const
438   {
439     return this->source_ == FROM_OBJECT && this->object()->is_dynamic();
440   }
441
442   // Return whether this is an undefined symbol.
443   bool
444   is_undefined() const
445   {
446     bool is_ordinary;
447     return ((this->source_ == FROM_OBJECT
448              && this->shndx(&is_ordinary) == elfcpp::SHN_UNDEF
449              && is_ordinary)
450             || this->source_ == IS_UNDEFINED);
451   }
452
453   // Return whether this is a weak undefined symbol.
454   bool
455   is_weak_undefined() const
456   { return this->is_undefined() && this->binding() == elfcpp::STB_WEAK; }
457
458   // Return whether this is an absolute symbol.
459   bool
460   is_absolute() const
461   {
462     bool is_ordinary;
463     return ((this->source_ == FROM_OBJECT
464              && this->shndx(&is_ordinary) == elfcpp::SHN_ABS
465              && !is_ordinary)
466             || this->source_ == IS_CONSTANT);
467   }
468
469   // Return whether this is a common symbol.
470   bool
471   is_common() const
472   {
473     if (this->type_ == elfcpp::STT_COMMON)
474       return true;
475     if (this->source_ != FROM_OBJECT)
476       return false;
477     bool is_ordinary;
478     unsigned int shndx = this->shndx(&is_ordinary);
479     return !is_ordinary && Symbol::is_common_shndx(shndx);
480   }
481
482   // Return whether this symbol can be seen outside this object.
483   bool
484   is_externally_visible() const
485   {
486     return (this->visibility_ == elfcpp::STV_DEFAULT
487             || this->visibility_ == elfcpp::STV_PROTECTED);
488   }
489
490   // Return true if this symbol can be preempted by a definition in
491   // another link unit.
492   bool
493   is_preemptible() const
494   {
495     // It doesn't make sense to ask whether a symbol defined in
496     // another object is preemptible.
497     gold_assert(!this->is_from_dynobj());
498
499     // It doesn't make sense to ask whether an undefined symbol
500     // is preemptible.
501     gold_assert(!this->is_undefined());
502
503     // If a symbol does not have default visibility, it can not be
504     // seen outside this link unit and therefore is not preemptible.
505     if (this->visibility_ != elfcpp::STV_DEFAULT)
506       return false;
507
508     // If this symbol has been forced to be a local symbol by a
509     // version script, then it is not visible outside this link unit
510     // and is not preemptible.
511     if (this->is_forced_local_)
512       return false;
513
514     // If we are not producing a shared library, then nothing is
515     // preemptible.
516     if (!parameters->options().shared())
517       return false;
518
519     // If the user used -Bsymbolic, then nothing is preemptible.
520     if (parameters->options().Bsymbolic())
521       return false;
522
523     // If the user used -Bsymbolic-functions, then functions are not
524     // preemptible.  We explicitly check for not being STT_OBJECT,
525     // rather than for being STT_FUNC, because that is what the GNU
526     // linker does.
527     if (this->type() != elfcpp::STT_OBJECT
528         && parameters->options().Bsymbolic_functions())
529       return false;
530
531     // Otherwise the symbol is preemptible.
532     return true;
533   }
534
535   // Return true if this symbol is a function that needs a PLT entry.
536   // If the symbol is defined in a dynamic object or if it is subject
537   // to pre-emption, we need to make a PLT entry. If we're doing a
538   // static link, we don't create PLT entries.
539   bool
540   needs_plt_entry() const
541   {
542     // An undefined symbol from an executable does not need a PLT entry.
543     if (this->is_undefined() && !parameters->options().shared())
544       return false;
545
546     return (!parameters->doing_static_link()
547             && this->type() == elfcpp::STT_FUNC
548             && (this->is_from_dynobj()
549                 || this->is_undefined()
550                 || this->is_preemptible()));
551   }
552
553   // When determining whether a reference to a symbol needs a dynamic
554   // relocation, we need to know several things about the reference.
555   // These flags may be or'ed together.
556   enum Reference_flags
557   {
558     // Reference to the symbol's absolute address.
559     ABSOLUTE_REF = 1,
560     // A non-PIC reference.
561     NON_PIC_REF = 2,
562     // A function call.
563     FUNCTION_CALL = 4
564   };
565
566   // Given a direct absolute or pc-relative static relocation against
567   // the global symbol, this function returns whether a dynamic relocation
568   // is needed.
569
570   bool
571   needs_dynamic_reloc(int flags) const
572   {
573     // No dynamic relocations in a static link!
574     if (parameters->doing_static_link())
575       return false;
576
577     // A reference to an undefined symbol from an executable should be
578     // statically resolved to 0, and does not need a dynamic relocation.
579     // This matches gnu ld behavior.
580     if (this->is_undefined() && !parameters->options().shared())
581       return false;
582
583     // A reference to an absolute symbol does not need a dynamic relocation.
584     if (this->is_absolute())
585       return false;
586
587     // An absolute reference within a position-independent output file
588     // will need a dynamic relocation.
589     if ((flags & ABSOLUTE_REF)
590         && parameters->options().output_is_position_independent())
591       return true;
592
593     // A function call that can branch to a local PLT entry does not need
594     // a dynamic relocation.  A non-pic pc-relative function call in a
595     // shared library cannot use a PLT entry.
596     if ((flags & FUNCTION_CALL)
597         && this->has_plt_offset()
598         && !((flags & NON_PIC_REF) && parameters->options().shared()))
599       return false;
600
601     // A reference to any PLT entry in a non-position-independent executable
602     // does not need a dynamic relocation.
603     if (!parameters->options().output_is_position_independent()
604         && this->has_plt_offset())
605       return false;
606
607     // A reference to a symbol defined in a dynamic object or to a
608     // symbol that is preemptible will need a dynamic relocation.
609     if (this->is_from_dynobj()
610         || this->is_undefined()
611         || this->is_preemptible())
612       return true;
613
614     // For all other cases, return FALSE.
615     return false;
616   }
617
618   // Whether we should use the PLT offset associated with a symbol for
619   // a relocation.  IS_NON_PIC_REFERENCE is true if this is a non-PIC
620   // reloc--the same set of relocs for which we would pass NON_PIC_REF
621   // to the needs_dynamic_reloc function.
622
623   bool
624   use_plt_offset(bool is_non_pic_reference) const
625   {
626     // If the symbol doesn't have a PLT offset, then naturally we
627     // don't want to use it.
628     if (!this->has_plt_offset())
629       return false;
630
631     // If we are going to generate a dynamic relocation, then we will
632     // wind up using that, so no need to use the PLT entry.
633     if (this->needs_dynamic_reloc(FUNCTION_CALL
634                                   | (is_non_pic_reference
635                                      ? NON_PIC_REF
636                                      : 0)))
637       return false;
638
639     // If the symbol is from a dynamic object, we need to use the PLT
640     // entry.
641     if (this->is_from_dynobj())
642       return true;
643
644     // If we are generating a shared object, and this symbol is
645     // undefined or preemptible, we need to use the PLT entry.
646     if (parameters->options().shared()
647         && (this->is_undefined() || this->is_preemptible()))
648       return true;
649
650     // If this is a weak undefined symbol, we need to use the PLT
651     // entry; the symbol may be defined by a library loaded at
652     // runtime.
653     if (this->is_weak_undefined())
654       return true;
655
656     // Otherwise we can use the regular definition.
657     return false;
658   }
659
660   // Given a direct absolute static relocation against
661   // the global symbol, where a dynamic relocation is needed, this
662   // function returns whether a relative dynamic relocation can be used.
663   // The caller must determine separately whether the static relocation
664   // is compatible with a relative relocation.
665
666   bool
667   can_use_relative_reloc(bool is_function_call) const
668   {
669     // A function call that can branch to a local PLT entry can
670     // use a RELATIVE relocation.
671     if (is_function_call && this->has_plt_offset())
672       return true;
673
674     // A reference to a symbol defined in a dynamic object or to a
675     // symbol that is preemptible can not use a RELATIVE relocaiton.
676     if (this->is_from_dynobj()
677         || this->is_undefined()
678         || this->is_preemptible())
679       return false;
680
681     // For all other cases, return TRUE.
682     return true;
683   }
684
685   // Return the output section where this symbol is defined.  Return
686   // NULL if the symbol has an absolute value.
687   Output_section*
688   output_section() const;
689
690   // Set the symbol's output section.  This is used for symbols
691   // defined in scripts.  This should only be called after the symbol
692   // table has been finalized.
693   void
694   set_output_section(Output_section*);
695
696   // Return whether there should be a warning for references to this
697   // symbol.
698   bool
699   has_warning() const
700   { return this->has_warning_; }
701
702   // Mark this symbol as having a warning.
703   void
704   set_has_warning()
705   { this->has_warning_ = true; }
706
707   // Return whether this symbol is defined by a COPY reloc from a
708   // dynamic object.
709   bool
710   is_copied_from_dynobj() const
711   { return this->is_copied_from_dynobj_; }
712
713   // Mark this symbol as defined by a COPY reloc.
714   void
715   set_is_copied_from_dynobj()
716   { this->is_copied_from_dynobj_ = true; }
717
718   // Return whether this symbol is forced to visibility STB_LOCAL
719   // by a "local:" entry in a version script.
720   bool
721   is_forced_local() const
722   { return this->is_forced_local_; }
723
724   // Mark this symbol as forced to STB_LOCAL visibility.
725   void
726   set_is_forced_local()
727   { this->is_forced_local_ = true; }
728
729  protected:
730   // Instances of this class should always be created at a specific
731   // size.
732   Symbol()
733   { memset(this, 0, sizeof *this); }
734
735   // Initialize the general fields.
736   void
737   init_fields(const char* name, const char* version,
738               elfcpp::STT type, elfcpp::STB binding,
739               elfcpp::STV visibility, unsigned char nonvis);
740
741   // Initialize fields from an ELF symbol in OBJECT.  ST_SHNDX is the
742   // section index, IS_ORDINARY is whether it is a normal section
743   // index rather than a special code.
744   template<int size, bool big_endian>
745   void
746   init_base_object(const char *name, const char* version, Object* object,
747                    const elfcpp::Sym<size, big_endian>&, unsigned int st_shndx,
748                    bool is_ordinary);
749
750   // Initialize fields for an Output_data.
751   void
752   init_base_output_data(const char* name, const char* version, Output_data*,
753                         elfcpp::STT, elfcpp::STB, elfcpp::STV,
754                         unsigned char nonvis, bool offset_is_from_end);
755
756   // Initialize fields for an Output_segment.
757   void
758   init_base_output_segment(const char* name, const char* version,
759                            Output_segment* os, elfcpp::STT type,
760                            elfcpp::STB binding, elfcpp::STV visibility,
761                            unsigned char nonvis,
762                            Segment_offset_base offset_base);
763
764   // Initialize fields for a constant.
765   void
766   init_base_constant(const char* name, const char* version, elfcpp::STT type,
767                      elfcpp::STB binding, elfcpp::STV visibility,
768                      unsigned char nonvis);
769
770   // Initialize fields for an undefined symbol.
771   void
772   init_base_undefined(const char* name, const char* version, elfcpp::STT type,
773                       elfcpp::STB binding, elfcpp::STV visibility,
774                       unsigned char nonvis);
775
776   // Override existing symbol.
777   template<int size, bool big_endian>
778   void
779   override_base(const elfcpp::Sym<size, big_endian>&, unsigned int st_shndx,
780                 bool is_ordinary, Object* object, const char* version);
781
782   // Override existing symbol with a special symbol.
783   void
784   override_base_with_special(const Symbol* from);
785
786   // Override symbol version.
787   void
788   override_version(const char* version);
789
790   // Allocate a common symbol by giving it a location in the output
791   // file.
792   void
793   allocate_base_common(Output_data*);
794
795  private:
796   Symbol(const Symbol&);
797   Symbol& operator=(const Symbol&);
798
799   // Symbol name (expected to point into a Stringpool).
800   const char* name_;
801   // Symbol version (expected to point into a Stringpool).  This may
802   // be NULL.
803   const char* version_;
804
805   union
806   {
807     // This struct is used if SOURCE_ == FROM_OBJECT.
808     struct
809     {
810       // Object in which symbol is defined, or in which it was first
811       // seen.
812       Object* object;
813       // Section number in object_ in which symbol is defined.
814       unsigned int shndx;
815     } from_object;
816
817     // This struct is used if SOURCE_ == IN_OUTPUT_DATA.
818     struct
819     {
820       // Output_data in which symbol is defined.  Before
821       // Layout::finalize the symbol's value is an offset within the
822       // Output_data.
823       Output_data* output_data;
824       // True if the offset is from the end, false if the offset is
825       // from the beginning.
826       bool offset_is_from_end;
827     } in_output_data;
828
829     // This struct is used if SOURCE_ == IN_OUTPUT_SEGMENT.
830     struct
831     {
832       // Output_segment in which the symbol is defined.  Before
833       // Layout::finalize the symbol's value is an offset.
834       Output_segment* output_segment;
835       // The base to use for the offset before Layout::finalize.
836       Segment_offset_base offset_base;
837     } in_output_segment;
838   } u_;
839
840   // The index of this symbol in the output file.  If the symbol is
841   // not going into the output file, this value is -1U.  This field
842   // starts as always holding zero.  It is set to a non-zero value by
843   // Symbol_table::finalize.
844   unsigned int symtab_index_;
845
846   // The index of this symbol in the dynamic symbol table.  If the
847   // symbol is not going into the dynamic symbol table, this value is
848   // -1U.  This field starts as always holding zero.  It is set to a
849   // non-zero value during Layout::finalize.
850   unsigned int dynsym_index_;
851
852   // If this symbol has an entry in the GOT section (has_got_offset_
853   // is true), this holds the offset from the start of the GOT section.
854   // A symbol may have more than one GOT offset (e.g., when mixing
855   // modules compiled with two different TLS models), but will usually
856   // have at most one.
857   Got_offset_list got_offsets_;
858
859   // If this symbol has an entry in the PLT section (has_plt_offset_
860   // is true), then this is the offset from the start of the PLT
861   // section.
862   unsigned int plt_offset_;
863
864   // Symbol type (bits 0 to 3).
865   elfcpp::STT type_ : 4;
866   // Symbol binding (bits 4 to 7).
867   elfcpp::STB binding_ : 4;
868   // Symbol visibility (bits 8 to 9).
869   elfcpp::STV visibility_ : 2;
870   // Rest of symbol st_other field (bits 10 to 15).
871   unsigned int nonvis_ : 6;
872   // The type of symbol (bits 16 to 18).
873   Source source_ : 3;
874   // True if this symbol always requires special target-specific
875   // handling (bit 19).
876   bool is_target_special_ : 1;
877   // True if this is the default version of the symbol (bit 20).
878   bool is_def_ : 1;
879   // True if this symbol really forwards to another symbol.  This is
880   // used when we discover after the fact that two different entries
881   // in the hash table really refer to the same symbol.  This will
882   // never be set for a symbol found in the hash table, but may be set
883   // for a symbol found in the list of symbols attached to an Object.
884   // It forwards to the symbol found in the forwarders_ map of
885   // Symbol_table (bit 21).
886   bool is_forwarder_ : 1;
887   // True if the symbol has an alias in the weak_aliases table in
888   // Symbol_table (bit 22).
889   bool has_alias_ : 1;
890   // True if this symbol needs to be in the dynamic symbol table (bit
891   // 23).
892   bool needs_dynsym_entry_ : 1;
893   // True if we've seen this symbol in a regular object (bit 24).
894   bool in_reg_ : 1;
895   // True if we've seen this symbol in a dynamic object (bit 25).
896   bool in_dyn_ : 1;
897   // True if the symbol has an entry in the PLT section (bit 26).
898   bool has_plt_offset_ : 1;
899   // True if this is a dynamic symbol which needs a special value in
900   // the dynamic symbol table (bit 27).
901   bool needs_dynsym_value_ : 1;
902   // True if there is a warning for this symbol (bit 28).
903   bool has_warning_ : 1;
904   // True if we are using a COPY reloc for this symbol, so that the
905   // real definition lives in a dynamic object (bit 29).
906   bool is_copied_from_dynobj_ : 1;
907   // True if this symbol was forced to local visibility by a version
908   // script (bit 30).
909   bool is_forced_local_ : 1;
910   // True if the field u_.from_object.shndx is an ordinary section
911   // index, not one of the special codes from SHN_LORESERVE to
912   // SHN_HIRESERVE (bit 31).
913   bool is_ordinary_shndx_ : 1;
914   // True if we've seen this symbol in a real ELF object.
915   bool in_real_elf_ : 1;
916 };
917
918 // The parts of a symbol which are size specific.  Using a template
919 // derived class like this helps us use less space on a 32-bit system.
920
921 template<int size>
922 class Sized_symbol : public Symbol
923 {
924  public:
925   typedef typename elfcpp::Elf_types<size>::Elf_Addr Value_type;
926   typedef typename elfcpp::Elf_types<size>::Elf_WXword Size_type;
927
928   Sized_symbol()
929   { }
930
931   // Initialize fields from an ELF symbol in OBJECT.  ST_SHNDX is the
932   // section index, IS_ORDINARY is whether it is a normal section
933   // index rather than a special code.
934   template<bool big_endian>
935   void
936   init_object(const char *name, const char* version, Object* object,
937               const elfcpp::Sym<size, big_endian>&, unsigned int st_shndx,
938               bool is_ordinary);
939
940   // Initialize fields for an Output_data.
941   void
942   init_output_data(const char* name, const char* version, Output_data*,
943                    Value_type value, Size_type symsize, elfcpp::STT,
944                    elfcpp::STB, elfcpp::STV, unsigned char nonvis,
945                    bool offset_is_from_end);
946
947   // Initialize fields for an Output_segment.
948   void
949   init_output_segment(const char* name, const char* version, Output_segment*,
950                       Value_type value, Size_type symsize, elfcpp::STT,
951                       elfcpp::STB, elfcpp::STV, unsigned char nonvis,
952                       Segment_offset_base offset_base);
953
954   // Initialize fields for a constant.
955   void
956   init_constant(const char* name, const char* version, Value_type value,
957                 Size_type symsize, elfcpp::STT, elfcpp::STB, elfcpp::STV,
958                 unsigned char nonvis);
959
960   // Initialize fields for an undefined symbol.
961   void
962   init_undefined(const char* name, const char* version, elfcpp::STT,
963                  elfcpp::STB, elfcpp::STV, unsigned char nonvis);
964
965   // Override existing symbol.
966   template<bool big_endian>
967   void
968   override(const elfcpp::Sym<size, big_endian>&, unsigned int st_shndx,
969            bool is_ordinary, Object* object, const char* version);
970
971   // Override existing symbol with a special symbol.
972   void
973   override_with_special(const Sized_symbol<size>*);
974
975   // Return the symbol's value.
976   Value_type
977   value() const
978   { return this->value_; }
979
980   // Return the symbol's size (we can't call this 'size' because that
981   // is a template parameter).
982   Size_type
983   symsize() const
984   { return this->symsize_; }
985
986   // Set the symbol size.  This is used when resolving common symbols.
987   void
988   set_symsize(Size_type symsize)
989   { this->symsize_ = symsize; }
990
991   // Set the symbol value.  This is called when we store the final
992   // values of the symbols into the symbol table.
993   void
994   set_value(Value_type value)
995   { this->value_ = value; }
996
997   // Allocate a common symbol by giving it a location in the output
998   // file.
999   void
1000   allocate_common(Output_data*, Value_type value);
1001
1002  private:
1003   Sized_symbol(const Sized_symbol&);
1004   Sized_symbol& operator=(const Sized_symbol&);
1005
1006   // Symbol value.  Before Layout::finalize this is the offset in the
1007   // input section.  This is set to the final value during
1008   // Layout::finalize.
1009   Value_type value_;
1010   // Symbol size.
1011   Size_type symsize_;
1012 };
1013
1014 // A struct describing a symbol defined by the linker, where the value
1015 // of the symbol is defined based on an output section.  This is used
1016 // for symbols defined by the linker, like "_init_array_start".
1017
1018 struct Define_symbol_in_section
1019 {
1020   // The symbol name.
1021   const char* name;
1022   // The name of the output section with which this symbol should be
1023   // associated.  If there is no output section with that name, the
1024   // symbol will be defined as zero.
1025   const char* output_section;
1026   // The offset of the symbol within the output section.  This is an
1027   // offset from the start of the output section, unless start_at_end
1028   // is true, in which case this is an offset from the end of the
1029   // output section.
1030   uint64_t value;
1031   // The size of the symbol.
1032   uint64_t size;
1033   // The symbol type.
1034   elfcpp::STT type;
1035   // The symbol binding.
1036   elfcpp::STB binding;
1037   // The symbol visibility.
1038   elfcpp::STV visibility;
1039   // The rest of the st_other field.
1040   unsigned char nonvis;
1041   // If true, the value field is an offset from the end of the output
1042   // section.
1043   bool offset_is_from_end;
1044   // If true, this symbol is defined only if we see a reference to it.
1045   bool only_if_ref;
1046 };
1047
1048 // A struct describing a symbol defined by the linker, where the value
1049 // of the symbol is defined based on a segment.  This is used for
1050 // symbols defined by the linker, like "_end".  We describe the
1051 // segment with which the symbol should be associated by its
1052 // characteristics.  If no segment meets these characteristics, the
1053 // symbol will be defined as zero.  If there is more than one segment
1054 // which meets these characteristics, we will use the first one.
1055
1056 struct Define_symbol_in_segment
1057 {
1058   // The symbol name.
1059   const char* name;
1060   // The segment type where the symbol should be defined, typically
1061   // PT_LOAD.
1062   elfcpp::PT segment_type;
1063   // Bitmask of segment flags which must be set.
1064   elfcpp::PF segment_flags_set;
1065   // Bitmask of segment flags which must be clear.
1066   elfcpp::PF segment_flags_clear;
1067   // The offset of the symbol within the segment.  The offset is
1068   // calculated from the position set by offset_base.
1069   uint64_t value;
1070   // The size of the symbol.
1071   uint64_t size;
1072   // The symbol type.
1073   elfcpp::STT type;
1074   // The symbol binding.
1075   elfcpp::STB binding;
1076   // The symbol visibility.
1077   elfcpp::STV visibility;
1078   // The rest of the st_other field.
1079   unsigned char nonvis;
1080   // The base from which we compute the offset.
1081   Symbol::Segment_offset_base offset_base;
1082   // If true, this symbol is defined only if we see a reference to it.
1083   bool only_if_ref;
1084 };
1085
1086 // This class manages warnings.  Warnings are a GNU extension.  When
1087 // we see a section named .gnu.warning.SYM in an object file, and if
1088 // we wind using the definition of SYM from that object file, then we
1089 // will issue a warning for any relocation against SYM from a
1090 // different object file.  The text of the warning is the contents of
1091 // the section.  This is not precisely the definition used by the old
1092 // GNU linker; the old GNU linker treated an occurrence of
1093 // .gnu.warning.SYM as defining a warning symbol.  A warning symbol
1094 // would trigger a warning on any reference.  However, it was
1095 // inconsistent in that a warning in a dynamic object only triggered
1096 // if there was no definition in a regular object.  This linker is
1097 // different in that we only issue a warning if we use the symbol
1098 // definition from the same object file as the warning section.
1099
1100 class Warnings
1101 {
1102  public:
1103   Warnings()
1104     : warnings_()
1105   { }
1106
1107   // Add a warning for symbol NAME in object OBJ.  WARNING is the text
1108   // of the warning.
1109   void
1110   add_warning(Symbol_table* symtab, const char* name, Object* obj,
1111               const std::string& warning);
1112
1113   // For each symbol for which we should give a warning, make a note
1114   // on the symbol.
1115   void
1116   note_warnings(Symbol_table* symtab);
1117
1118   // Issue a warning for a reference to SYM at RELINFO's location.
1119   template<int size, bool big_endian>
1120   void
1121   issue_warning(const Symbol* sym, const Relocate_info<size, big_endian>*,
1122                 size_t relnum, off_t reloffset) const;
1123
1124  private:
1125   Warnings(const Warnings&);
1126   Warnings& operator=(const Warnings&);
1127
1128   // What we need to know to get the warning text.
1129   struct Warning_location
1130   {
1131     // The object the warning is in.
1132     Object* object;
1133     // The warning text.
1134     std::string text;
1135
1136     Warning_location()
1137       : object(NULL), text()
1138     { }
1139
1140     void
1141     set(Object* o, const std::string& t)
1142     {
1143       this->object = o;
1144       this->text = t;
1145     }
1146   };
1147
1148   // A mapping from warning symbol names (canonicalized in
1149   // Symbol_table's namepool_ field) to warning information.
1150   typedef Unordered_map<const char*, Warning_location> Warning_table;
1151
1152   Warning_table warnings_;
1153 };
1154
1155 // The main linker symbol table.
1156
1157 class Symbol_table
1158 {
1159  public:
1160   // COUNT is an estimate of how many symbosl will be inserted in the
1161   // symbol table.  It's ok to put 0 if you don't know; a correct
1162   // guess will just save some CPU by reducing hashtable resizes.
1163   Symbol_table(unsigned int count, const Version_script_info& version_script);
1164
1165   ~Symbol_table();
1166
1167   void
1168   set_icf(Icf* icf)
1169   { this->icf_ = icf;}
1170
1171   Icf*
1172   icf() const
1173   { return this->icf_; }
1174  
1175   // Returns true if ICF determined that this is a duplicate section. 
1176   bool
1177   is_section_folded(Object* obj, unsigned int shndx) const;
1178
1179   void
1180   set_gc(Garbage_collection* gc)
1181   { this->gc_ = gc; }
1182
1183   Garbage_collection*
1184   gc() const
1185   { return this->gc_; }
1186
1187   // During garbage collection, this keeps undefined symbols.
1188   void
1189   gc_mark_undef_symbols(); 
1190
1191   // During garbage collection, this ensures externally visible symbols
1192   // are not treated as garbage while building shared objects.
1193   void
1194   gc_mark_symbol_for_shlib(Symbol* sym);
1195
1196   // During garbage collection, this keeps sections that correspond to 
1197   // symbols seen in dynamic objects.
1198   inline void
1199   gc_mark_dyn_syms(Symbol* sym);
1200
1201   // Add COUNT external symbols from the relocatable object RELOBJ to
1202   // the symbol table.  SYMS is the symbols, SYMNDX_OFFSET is the
1203   // offset in the symbol table of the first symbol, SYM_NAMES is
1204   // their names, SYM_NAME_SIZE is the size of SYM_NAMES.  This sets
1205   // SYMPOINTERS to point to the symbols in the symbol table.  It sets
1206   // *DEFINED to the number of defined symbols.
1207   template<int size, bool big_endian>
1208   void
1209   add_from_relobj(Sized_relobj<size, big_endian>* relobj,
1210                   const unsigned char* syms, size_t count,
1211                   size_t symndx_offset, const char* sym_names,
1212                   size_t sym_name_size,
1213                   typename Sized_relobj<size, big_endian>::Symbols*,
1214                   size_t* defined);
1215
1216   // Add one external symbol from the plugin object OBJ to the symbol table.
1217   // Returns a pointer to the resolved symbol in the symbol table.
1218   template<int size, bool big_endian>
1219   Symbol*
1220   add_from_pluginobj(Sized_pluginobj<size, big_endian>* obj,
1221                      const char* name, const char* ver,
1222                      elfcpp::Sym<size, big_endian>* sym);
1223
1224   // Add COUNT dynamic symbols from the dynamic object DYNOBJ to the
1225   // symbol table.  SYMS is the symbols.  SYM_NAMES is their names.
1226   // SYM_NAME_SIZE is the size of SYM_NAMES.  The other parameters are
1227   // symbol version data.
1228   template<int size, bool big_endian>
1229   void
1230   add_from_dynobj(Sized_dynobj<size, big_endian>* dynobj,
1231                   const unsigned char* syms, size_t count,
1232                   const char* sym_names, size_t sym_name_size,
1233                   const unsigned char* versym, size_t versym_size,
1234                   const std::vector<const char*>*,
1235                   typename Sized_relobj<size, big_endian>::Symbols*,
1236                   size_t* defined);
1237
1238   // Define a special symbol based on an Output_data.  It is a
1239   // multiple definition error if this symbol is already defined.
1240   Symbol*
1241   define_in_output_data(const char* name, const char* version,
1242                         Output_data*, uint64_t value, uint64_t symsize,
1243                         elfcpp::STT type, elfcpp::STB binding,
1244                         elfcpp::STV visibility, unsigned char nonvis,
1245                         bool offset_is_from_end, bool only_if_ref);
1246
1247   // Define a special symbol based on an Output_segment.  It is a
1248   // multiple definition error if this symbol is already defined.
1249   Symbol*
1250   define_in_output_segment(const char* name, const char* version,
1251                            Output_segment*, uint64_t value, uint64_t symsize,
1252                            elfcpp::STT type, elfcpp::STB binding,
1253                            elfcpp::STV visibility, unsigned char nonvis,
1254                            Symbol::Segment_offset_base, bool only_if_ref);
1255
1256   // Define a special symbol with a constant value.  It is a multiple
1257   // definition error if this symbol is already defined.
1258   Symbol*
1259   define_as_constant(const char* name, const char* version,
1260                      uint64_t value, uint64_t symsize, elfcpp::STT type,
1261                      elfcpp::STB binding, elfcpp::STV visibility,
1262                      unsigned char nonvis, bool only_if_ref,
1263                      bool force_override);
1264
1265   // Define a set of symbols in output sections.  If ONLY_IF_REF is
1266   // true, only define them if they are referenced.
1267   void
1268   define_symbols(const Layout*, int count, const Define_symbol_in_section*,
1269                  bool only_if_ref);
1270
1271   // Define a set of symbols in output segments.  If ONLY_IF_REF is
1272   // true, only defined them if they are referenced.
1273   void
1274   define_symbols(const Layout*, int count, const Define_symbol_in_segment*,
1275                  bool only_if_ref);
1276
1277   // Define SYM using a COPY reloc.  POSD is the Output_data where the
1278   // symbol should be defined--typically a .dyn.bss section.  VALUE is
1279   // the offset within POSD.
1280   template<int size>
1281   void
1282   define_with_copy_reloc(Sized_symbol<size>* sym, Output_data* posd,
1283                          typename elfcpp::Elf_types<size>::Elf_Addr);
1284
1285   // Look up a symbol.
1286   Symbol*
1287   lookup(const char*, const char* version = NULL) const;
1288
1289   // Return the real symbol associated with the forwarder symbol FROM.
1290   Symbol*
1291   resolve_forwards(const Symbol* from) const;
1292
1293   // Return the sized version of a symbol in this table.
1294   template<int size>
1295   Sized_symbol<size>*
1296   get_sized_symbol(Symbol*) const;
1297
1298   template<int size>
1299   const Sized_symbol<size>*
1300   get_sized_symbol(const Symbol*) const;
1301
1302   // Return the count of undefined symbols seen.
1303   int
1304   saw_undefined() const
1305   { return this->saw_undefined_; }
1306
1307   // Allocate the common symbols
1308   void
1309   allocate_commons(Layout*, Mapfile*);
1310
1311   // Add a warning for symbol NAME in object OBJ.  WARNING is the text
1312   // of the warning.
1313   void
1314   add_warning(const char* name, Object* obj, const std::string& warning)
1315   { this->warnings_.add_warning(this, name, obj, warning); }
1316
1317   // Canonicalize a symbol name for use in the hash table.
1318   const char*
1319   canonicalize_name(const char* name)
1320   { return this->namepool_.add(name, true, NULL); }
1321
1322   // Possibly issue a warning for a reference to SYM at LOCATION which
1323   // is in OBJ.
1324   template<int size, bool big_endian>
1325   void
1326   issue_warning(const Symbol* sym,
1327                 const Relocate_info<size, big_endian>* relinfo,
1328                 size_t relnum, off_t reloffset) const
1329   { this->warnings_.issue_warning(sym, relinfo, relnum, reloffset); }
1330
1331   // Check candidate_odr_violations_ to find symbols with the same name
1332   // but apparently different definitions (different source-file/line-no).
1333   void
1334   detect_odr_violations(const Task*, const char* output_file_name) const;
1335
1336   // Add any undefined symbols named on the command line to the symbol
1337   // table.
1338   void
1339   add_undefined_symbols_from_command_line();
1340
1341   // SYM is defined using a COPY reloc.  Return the dynamic object
1342   // where the original definition was found.
1343   Dynobj*
1344   get_copy_source(const Symbol* sym) const;
1345
1346   // Set the dynamic symbol indexes.  INDEX is the index of the first
1347   // global dynamic symbol.  Pointers to the symbols are stored into
1348   // the vector.  The names are stored into the Stringpool.  This
1349   // returns an updated dynamic symbol index.
1350   unsigned int
1351   set_dynsym_indexes(unsigned int index, std::vector<Symbol*>*,
1352                      Stringpool*, Versions*);
1353
1354   // Finalize the symbol table after we have set the final addresses
1355   // of all the input sections.  This sets the final symbol indexes,
1356   // values and adds the names to *POOL.  *PLOCAL_SYMCOUNT is the
1357   // index of the first global symbol.  OFF is the file offset of the
1358   // global symbol table, DYNOFF is the offset of the globals in the
1359   // dynamic symbol table, DYN_GLOBAL_INDEX is the index of the first
1360   // global dynamic symbol, and DYNCOUNT is the number of global
1361   // dynamic symbols.  This records the parameters, and returns the
1362   // new file offset.  It updates *PLOCAL_SYMCOUNT if it created any
1363   // local symbols.
1364   off_t
1365   finalize(off_t off, off_t dynoff, size_t dyn_global_index, size_t dyncount,
1366            Stringpool* pool, unsigned int *plocal_symcount);
1367
1368   // Write out the global symbols.
1369   void
1370   write_globals(const Stringpool*, const Stringpool*,
1371                 Output_symtab_xindex*, Output_symtab_xindex*,
1372                 Output_file*) const;
1373
1374   // Write out a section symbol.  Return the updated offset.
1375   void
1376   write_section_symbol(const Output_section*, Output_symtab_xindex*,
1377                        Output_file*, off_t) const;
1378
1379   // Dump statistical information to stderr.
1380   void
1381   print_stats() const;
1382
1383   // Return the version script information.
1384   const Version_script_info&
1385   version_script() const
1386   { return version_script_; }
1387
1388  private:
1389   Symbol_table(const Symbol_table&);
1390   Symbol_table& operator=(const Symbol_table&);
1391
1392   // The type of the list of common symbols.
1393   typedef std::vector<Symbol*> Commons_type;
1394
1395   // The type of the symbol hash table.
1396
1397   typedef std::pair<Stringpool::Key, Stringpool::Key> Symbol_table_key;
1398
1399   struct Symbol_table_hash
1400   {
1401     size_t
1402     operator()(const Symbol_table_key&) const;
1403   };
1404
1405   struct Symbol_table_eq
1406   {
1407     bool
1408     operator()(const Symbol_table_key&, const Symbol_table_key&) const;
1409   };
1410
1411   typedef Unordered_map<Symbol_table_key, Symbol*, Symbol_table_hash,
1412                         Symbol_table_eq> Symbol_table_type;
1413
1414   // Make FROM a forwarder symbol to TO.
1415   void
1416   make_forwarder(Symbol* from, Symbol* to);
1417
1418   // Add a symbol.
1419   template<int size, bool big_endian>
1420   Sized_symbol<size>*
1421   add_from_object(Object*, const char *name, Stringpool::Key name_key,
1422                   const char *version, Stringpool::Key version_key,
1423                   bool def, const elfcpp::Sym<size, big_endian>& sym,
1424                   unsigned int st_shndx, bool is_ordinary,
1425                   unsigned int orig_st_shndx);
1426
1427   // Define a default symbol.
1428   template<int size, bool big_endian>
1429   void
1430   define_default_version(Sized_symbol<size>*, bool,
1431                          Symbol_table_type::iterator);
1432
1433   // Resolve symbols.
1434   template<int size, bool big_endian>
1435   void
1436   resolve(Sized_symbol<size>* to,
1437           const elfcpp::Sym<size, big_endian>& sym,
1438           unsigned int st_shndx, bool is_ordinary,
1439           unsigned int orig_st_shndx,
1440           Object*, const char* version);
1441
1442   template<int size, bool big_endian>
1443   void
1444   resolve(Sized_symbol<size>* to, const Sized_symbol<size>* from);
1445
1446   // Record that a symbol is forced to be local by a version script or
1447   // by visibility.
1448   void
1449   force_local(Symbol*);
1450
1451   // Adjust NAME and *NAME_KEY for wrapping.
1452   const char*
1453   wrap_symbol(Object* object, const char*, Stringpool::Key* name_key);
1454
1455   // Whether we should override a symbol, based on flags in
1456   // resolve.cc.
1457   static bool
1458   should_override(const Symbol*, unsigned int, Object*, bool*);
1459
1460   // Override a symbol.
1461   template<int size, bool big_endian>
1462   void
1463   override(Sized_symbol<size>* tosym,
1464            const elfcpp::Sym<size, big_endian>& fromsym,
1465            unsigned int st_shndx, bool is_ordinary,
1466            Object* object, const char* version);
1467
1468   // Whether we should override a symbol with a special symbol which
1469   // is automatically defined by the linker.
1470   static bool
1471   should_override_with_special(const Symbol*);
1472
1473   // Override a symbol with a special symbol.
1474   template<int size>
1475   void
1476   override_with_special(Sized_symbol<size>* tosym,
1477                         const Sized_symbol<size>* fromsym);
1478
1479   // Record all weak alias sets for a dynamic object.
1480   template<int size>
1481   void
1482   record_weak_aliases(std::vector<Sized_symbol<size>*>*);
1483
1484   // Define a special symbol.
1485   template<int size, bool big_endian>
1486   Sized_symbol<size>*
1487   define_special_symbol(const char** pname, const char** pversion,
1488                         bool only_if_ref, Sized_symbol<size>** poldsym,
1489                         bool* resolve_oldsym);
1490
1491   // Define a symbol in an Output_data, sized version.
1492   template<int size>
1493   Sized_symbol<size>*
1494   do_define_in_output_data(const char* name, const char* version, Output_data*,
1495                            typename elfcpp::Elf_types<size>::Elf_Addr value,
1496                            typename elfcpp::Elf_types<size>::Elf_WXword ssize,
1497                            elfcpp::STT type, elfcpp::STB binding,
1498                            elfcpp::STV visibility, unsigned char nonvis,
1499                            bool offset_is_from_end, bool only_if_ref);
1500
1501   // Define a symbol in an Output_segment, sized version.
1502   template<int size>
1503   Sized_symbol<size>*
1504   do_define_in_output_segment(
1505     const char* name, const char* version, Output_segment* os,
1506     typename elfcpp::Elf_types<size>::Elf_Addr value,
1507     typename elfcpp::Elf_types<size>::Elf_WXword ssize,
1508     elfcpp::STT type, elfcpp::STB binding,
1509     elfcpp::STV visibility, unsigned char nonvis,
1510     Symbol::Segment_offset_base offset_base, bool only_if_ref);
1511
1512   // Define a symbol as a constant, sized version.
1513   template<int size>
1514   Sized_symbol<size>*
1515   do_define_as_constant(
1516     const char* name, const char* version,
1517     typename elfcpp::Elf_types<size>::Elf_Addr value,
1518     typename elfcpp::Elf_types<size>::Elf_WXword ssize,
1519     elfcpp::STT type, elfcpp::STB binding,
1520     elfcpp::STV visibility, unsigned char nonvis,
1521     bool only_if_ref, bool force_override);
1522
1523   // Add any undefined symbols named on the command line to the symbol
1524   // table, sized version.
1525   template<int size>
1526   void
1527   do_add_undefined_symbols_from_command_line();
1528
1529   // Types of common symbols.
1530
1531   enum Commons_section_type
1532   {
1533     COMMONS_NORMAL,
1534     COMMONS_TLS,
1535     COMMONS_SMALL,
1536     COMMONS_LARGE
1537   };
1538
1539   // Allocate the common symbols, sized version.
1540   template<int size>
1541   void
1542   do_allocate_commons(Layout*, Mapfile*);
1543
1544   // Allocate the common symbols from one list.
1545   template<int size>
1546   void
1547   do_allocate_commons_list(Layout*, Commons_section_type, Commons_type*,
1548                            Mapfile*);
1549
1550   // Implement detect_odr_violations.
1551   template<int size, bool big_endian>
1552   void
1553   sized_detect_odr_violations() const;
1554
1555   // Finalize symbols specialized for size.
1556   template<int size>
1557   off_t
1558   sized_finalize(off_t, Stringpool*, unsigned int*);
1559
1560   // Finalize a symbol.  Return whether it should be added to the
1561   // symbol table.
1562   template<int size>
1563   bool
1564   sized_finalize_symbol(Symbol*);
1565
1566   // Add a symbol the final symtab by setting its index.
1567   template<int size>
1568   void
1569   add_to_final_symtab(Symbol*, Stringpool*, unsigned int* pindex, off_t* poff);
1570
1571   // Write globals specialized for size and endianness.
1572   template<int size, bool big_endian>
1573   void
1574   sized_write_globals(const Stringpool*, const Stringpool*,
1575                       Output_symtab_xindex*, Output_symtab_xindex*,
1576                       Output_file*) const;
1577
1578   // Write out a symbol to P.
1579   template<int size, bool big_endian>
1580   void
1581   sized_write_symbol(Sized_symbol<size>*,
1582                      typename elfcpp::Elf_types<size>::Elf_Addr value,
1583                      unsigned int shndx,
1584                      const Stringpool*, unsigned char* p) const;
1585
1586   // Possibly warn about an undefined symbol from a dynamic object.
1587   void
1588   warn_about_undefined_dynobj_symbol(Symbol*) const;
1589
1590   // Write out a section symbol, specialized for size and endianness.
1591   template<int size, bool big_endian>
1592   void
1593   sized_write_section_symbol(const Output_section*, Output_symtab_xindex*,
1594                              Output_file*, off_t) const;
1595
1596   // The type of the list of symbols which have been forced local.
1597   typedef std::vector<Symbol*> Forced_locals;
1598
1599   // A map from symbols with COPY relocs to the dynamic objects where
1600   // they are defined.
1601   typedef Unordered_map<const Symbol*, Dynobj*> Copied_symbol_dynobjs;
1602
1603   // A map from symbol name (as a pointer into the namepool) to all
1604   // the locations the symbols is (weakly) defined (and certain other
1605   // conditions are met).  This map will be used later to detect
1606   // possible One Definition Rule (ODR) violations.
1607   struct Symbol_location
1608   {
1609     Object* object;         // Object where the symbol is defined.
1610     unsigned int shndx;     // Section-in-object where the symbol is defined.
1611     off_t offset;           // Offset-in-section where the symbol is defined.
1612     bool operator==(const Symbol_location& that) const
1613     {
1614       return (this->object == that.object
1615               && this->shndx == that.shndx
1616               && this->offset == that.offset);
1617     }
1618   };
1619
1620   struct Symbol_location_hash
1621   {
1622     size_t operator()(const Symbol_location& loc) const
1623     { return reinterpret_cast<uintptr_t>(loc.object) ^ loc.offset ^ loc.shndx; }
1624   };
1625
1626   typedef Unordered_map<const char*,
1627                         Unordered_set<Symbol_location, Symbol_location_hash> >
1628   Odr_map;
1629
1630   // We increment this every time we see a new undefined symbol, for
1631   // use in archive groups.
1632   int saw_undefined_;
1633   // The index of the first global symbol in the output file.
1634   unsigned int first_global_index_;
1635   // The file offset within the output symtab section where we should
1636   // write the table.
1637   off_t offset_;
1638   // The number of global symbols we want to write out.
1639   unsigned int output_count_;
1640   // The file offset of the global dynamic symbols, or 0 if none.
1641   off_t dynamic_offset_;
1642   // The index of the first global dynamic symbol.
1643   unsigned int first_dynamic_global_index_;
1644   // The number of global dynamic symbols, or 0 if none.
1645   unsigned int dynamic_count_;
1646   // The symbol hash table.
1647   Symbol_table_type table_;
1648   // A pool of symbol names.  This is used for all global symbols.
1649   // Entries in the hash table point into this pool.
1650   Stringpool namepool_;
1651   // Forwarding symbols.
1652   Unordered_map<const Symbol*, Symbol*> forwarders_;
1653   // Weak aliases.  A symbol in this list points to the next alias.
1654   // The aliases point to each other in a circular list.
1655   Unordered_map<Symbol*, Symbol*> weak_aliases_;
1656   // We don't expect there to be very many common symbols, so we keep
1657   // a list of them.  When we find a common symbol we add it to this
1658   // list.  It is possible that by the time we process the list the
1659   // symbol is no longer a common symbol.  It may also have become a
1660   // forwarder.
1661   Commons_type commons_;
1662   // This is like the commons_ field, except that it holds TLS common
1663   // symbols.
1664   Commons_type tls_commons_;
1665   // This is for small common symbols.
1666   Commons_type small_commons_;
1667   // This is for large common symbols.
1668   Commons_type large_commons_;
1669   // A list of symbols which have been forced to be local.  We don't
1670   // expect there to be very many of them, so we keep a list of them
1671   // rather than walking the whole table to find them.
1672   Forced_locals forced_locals_;
1673   // Manage symbol warnings.
1674   Warnings warnings_;
1675   // Manage potential One Definition Rule (ODR) violations.
1676   Odr_map candidate_odr_violations_;
1677
1678   // When we emit a COPY reloc for a symbol, we define it in an
1679   // Output_data.  When it's time to emit version information for it,
1680   // we need to know the dynamic object in which we found the original
1681   // definition.  This maps symbols with COPY relocs to the dynamic
1682   // object where they were defined.
1683   Copied_symbol_dynobjs copied_symbol_dynobjs_;
1684   // Information parsed from the version script, if any.
1685   const Version_script_info& version_script_;
1686   Garbage_collection* gc_;
1687   Icf* icf_;
1688 };
1689
1690 // We inline get_sized_symbol for efficiency.
1691
1692 template<int size>
1693 Sized_symbol<size>*
1694 Symbol_table::get_sized_symbol(Symbol* sym) const
1695 {
1696   gold_assert(size == parameters->target().get_size());
1697   return static_cast<Sized_symbol<size>*>(sym);
1698 }
1699
1700 template<int size>
1701 const Sized_symbol<size>*
1702 Symbol_table::get_sized_symbol(const Symbol* sym) const
1703 {
1704   gold_assert(size == parameters->target().get_size());
1705   return static_cast<const Sized_symbol<size>*>(sym);
1706 }
1707
1708 } // End namespace gold.
1709
1710 #endif // !defined(GOLD_SYMTAB_H)