1
// dynobj.h -- dynamic object support for gold -*- C++ -*-
3
// Copyright 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4
// Written by Ian Lance Taylor <iant@google.com>.
6
// This file is part of gold.
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.
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.
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.
28
#include "stringpool.h"
34
class Version_script_info;
36
// A dynamic object (ET_DYN). This is an abstract base class itself.
37
// The implementations is the template class Sized_dynobj.
39
class Dynobj : public Object
42
// We keep a list of all the DT_NEEDED entries we find.
43
typedef std::vector<std::string> Needed;
45
Dynobj(const std::string& name, Input_file* input_file, off_t offset = 0);
47
// Return the name to use in a DT_NEEDED entry for this object.
50
{ return this->soname_.c_str(); }
52
// Return the list of DT_NEEDED strings.
55
{ return this->needed_; }
57
// Return whether this dynamic object has any DT_NEEDED entries
58
// which were not seen during the link.
60
has_unknown_needed_entries() const
62
gold_assert(this->unknown_needed_ != UNKNOWN_NEEDED_UNSET);
63
return this->unknown_needed_ == UNKNOWN_NEEDED_TRUE;
66
// Set whether this dynamic object has any DT_NEEDED entries which
67
// were not seen during the link.
69
set_has_unknown_needed_entries(bool set)
71
gold_assert(this->unknown_needed_ == UNKNOWN_NEEDED_UNSET);
72
this->unknown_needed_ = set ? UNKNOWN_NEEDED_TRUE : UNKNOWN_NEEDED_FALSE;
75
// Compute the ELF hash code for a string.
77
elf_hash(const char*);
79
// Create a standard ELF hash table, setting *PPHASH and *PHASHLEN.
80
// DYNSYMS is the global dynamic symbols. LOCAL_DYNSYM_COUNT is the
81
// number of local dynamic symbols, which is the index of the first
82
// dynamic gobal symbol.
84
create_elf_hash_table(const std::vector<Symbol*>& dynsyms,
85
unsigned int local_dynsym_count,
86
unsigned char** pphash,
87
unsigned int* phashlen);
89
// Create a GNU hash table, setting *PPHASH and *PHASHLEN. DYNSYMS
90
// is the global dynamic symbols. LOCAL_DYNSYM_COUNT is the number
91
// of local dynamic symbols, which is the index of the first dynamic
94
create_gnu_hash_table(const std::vector<Symbol*>& dynsyms,
95
unsigned int local_dynsym_count,
96
unsigned char** pphash, unsigned int* phashlen);
99
// Return a pointer to this object.
104
// Set the DT_SONAME string.
106
set_soname_string(const char* s)
107
{ this->soname_.assign(s); }
109
// Add an entry to the list of DT_NEEDED strings.
111
add_needed(const char* s)
112
{ this->needed_.push_back(std::string(s)); }
115
// Compute the GNU hash code for a string.
117
gnu_hash(const char*);
119
// Compute the number of hash buckets to use.
121
compute_bucket_count(const std::vector<uint32_t>& hashcodes,
122
bool for_gnu_hash_table);
124
// Sized version of create_elf_hash_table.
125
template<bool big_endian>
127
sized_create_elf_hash_table(const std::vector<uint32_t>& bucket,
128
const std::vector<uint32_t>& chain,
129
unsigned char* phash,
130
unsigned int hashlen);
132
// Sized version of create_gnu_hash_table.
133
template<int size, bool big_endian>
135
sized_create_gnu_hash_table(const std::vector<Symbol*>& hashed_dynsyms,
136
const std::vector<uint32_t>& dynsym_hashvals,
137
unsigned int unhashed_dynsym_count,
138
unsigned char** pphash,
139
unsigned int* phashlen);
141
// Values for the has_unknown_needed_entries_ field.
144
UNKNOWN_NEEDED_UNSET,
149
// The DT_SONAME name, if any.
151
// The list of DT_NEEDED entries.
153
// Whether this dynamic object has any DT_NEEDED entries not seen
155
Unknown_needed unknown_needed_;
158
// A dynamic object, size and endian specific version.
160
template<int size, bool big_endian>
161
class Sized_dynobj : public Dynobj
164
typedef typename Sized_relobj_file<size, big_endian>::Symbols Symbols;
166
Sized_dynobj(const std::string& name, Input_file* input_file, off_t offset,
167
const typename elfcpp::Ehdr<size, big_endian>&);
169
// Set up the object file based on TARGET.
175
do_read_symbols(Read_symbols_data*);
177
// Lay out the input sections.
179
do_layout(Symbol_table*, Layout*, Read_symbols_data*);
181
// Add the symbols to the symbol table.
183
do_add_symbols(Symbol_table*, Read_symbols_data*, Layout*);
185
Archive::Should_include
186
do_should_include_member(Symbol_table* symtab, Layout*, Read_symbols_data*,
189
// Iterate over global symbols, calling a visitor class V for each.
191
do_for_all_global_symbols(Read_symbols_data* sd,
192
Library_base::Symbol_visitor_base* v);
194
// Iterate over local symbols, calling a visitor class V for each GOT offset
195
// associated with a local symbol.
197
do_for_all_local_got_entries(Got_offset_list::Visitor* v) const;
199
// Get the size of a section.
201
do_section_size(unsigned int shndx)
202
{ return this->elf_file_.section_size(shndx); }
204
// Get the name of a section.
206
do_section_name(unsigned int shndx)
207
{ return this->elf_file_.section_name(shndx); }
209
// Return a view of the contents of a section. Set *PLEN to the
212
do_section_contents(unsigned int shndx, section_size_type* plen,
215
Location loc(this->elf_file_.section_contents(shndx));
216
*plen = convert_to_section_size_type(loc.data_size);
219
static const unsigned char empty[1] = { '\0' };
222
return this->get_view(loc.file_offset, *plen, true, cache);
225
// Return section flags.
227
do_section_flags(unsigned int shndx)
228
{ return this->elf_file_.section_flags(shndx); }
230
// Not used for dynobj.
232
do_section_entsize(unsigned int )
233
{ gold_unreachable(); }
235
// Return section address.
237
do_section_address(unsigned int shndx)
238
{ return this->elf_file_.section_addr(shndx); }
240
// Return section type.
242
do_section_type(unsigned int shndx)
243
{ return this->elf_file_.section_type(shndx); }
245
// Return the section link field.
247
do_section_link(unsigned int shndx)
248
{ return this->elf_file_.section_link(shndx); }
250
// Return the section link field.
252
do_section_info(unsigned int shndx)
253
{ return this->elf_file_.section_info(shndx); }
255
// Return the section alignment.
257
do_section_addralign(unsigned int shndx)
258
{ return this->elf_file_.section_addralign(shndx); }
260
// Return the Xindex structure to use.
262
do_initialize_xindex();
264
// Get symbol counts.
266
do_get_global_symbol_counts(const Symbol_table*, size_t*, size_t*) const;
268
// Get the global symbols.
270
do_get_global_symbols() const
271
{ return this->symbols_; }
275
typedef Sized_dynobj<size, big_endian> This;
276
static const int shdr_size = elfcpp::Elf_sizes<size>::shdr_size;
277
static const int sym_size = elfcpp::Elf_sizes<size>::sym_size;
278
static const int dyn_size = elfcpp::Elf_sizes<size>::dyn_size;
279
typedef elfcpp::Shdr<size, big_endian> Shdr;
280
typedef elfcpp::Dyn<size, big_endian> Dyn;
282
// Adjust a section index if necessary.
284
adjust_shndx(unsigned int shndx)
286
if (shndx >= elfcpp::SHN_LORESERVE)
287
shndx += this->elf_file_.large_shndx_offset();
291
// Find the dynamic symbol table and the version sections, given the
294
find_dynsym_sections(const unsigned char* pshdrs,
295
unsigned int* pversym_shndx,
296
unsigned int* pverdef_shndx,
297
unsigned int* pverneed_shndx,
298
unsigned int* pdynamic_shndx);
300
// Read the dynamic symbol section SHNDX.
302
read_dynsym_section(const unsigned char* pshdrs, unsigned int shndx,
303
elfcpp::SHT type, unsigned int link,
304
File_view** view, section_size_type* view_size,
305
unsigned int* view_info);
307
// Read the dynamic tags.
309
read_dynamic(const unsigned char* pshdrs, unsigned int dynamic_shndx,
310
unsigned int strtab_shndx, const unsigned char* strtabu,
313
// Mapping from version number to version name.
314
typedef std::vector<const char*> Version_map;
316
// Create the version map.
318
make_version_map(Read_symbols_data* sd, Version_map*) const;
320
// Add version definitions to the version map.
322
make_verdef_map(Read_symbols_data* sd, Version_map*) const;
324
// Add version references to the version map.
326
make_verneed_map(Read_symbols_data* sd, Version_map*) const;
328
// Add an entry to the version map.
330
set_version_map(Version_map*, unsigned int ndx, const char* name) const;
332
// General access to the ELF file.
333
elfcpp::Elf_file<size, big_endian, Object> elf_file_;
334
// The section index of the dynamic symbol table.
335
unsigned int dynsym_shndx_;
336
// The entries in the symbol table for the symbols. We only keep
337
// this if we need it to print symbol information.
339
// Number of defined symbols.
340
size_t defined_count_;
343
// A base class for Verdef and Verneed_version which just handles the
344
// version index which will be stored in the SHT_GNU_versym section.
357
// Return the version index.
361
gold_assert(this->index_ != -1U);
365
// Set the version index.
367
set_index(unsigned int index)
369
gold_assert(this->index_ == -1U);
370
this->index_ = index;
373
// Clear the weak flag in a version definition.
378
Version_base(const Version_base&);
379
Version_base& operator=(const Version_base&);
381
// The index of the version definition or reference.
385
// This class handles a version being defined in the file we are
388
class Verdef : public Version_base
391
Verdef(const char* name, const std::vector<std::string>& deps,
392
bool is_base, bool is_weak, bool is_info, bool is_symbol_created)
393
: name_(name), deps_(deps), is_base_(is_base), is_weak_(is_weak),
394
is_info_(is_info), is_symbol_created_(is_symbol_created)
397
// Return the version name.
400
{ return this->name_; }
402
// Return the number of dependencies.
404
count_dependencies() const
405
{ return this->deps_.size(); }
407
// Add a dependency to this version. The NAME should be
408
// canonicalized in the dynamic Stringpool.
410
add_dependency(const char* name)
411
{ this->deps_.push_back(name); }
413
// Return whether this definition is weak.
416
{ return this->is_weak_; }
418
// Clear the weak flag.
421
{ this->is_weak_ = false; }
423
// Return whether this definition is informational.
426
{ return this->is_info_; }
428
// Return whether a version symbol has been created for this
431
is_symbol_created() const
432
{ return this->is_symbol_created_; }
434
// Write contents to buffer.
435
template<int size, bool big_endian>
437
write(const Stringpool*, bool is_last, unsigned char*) const;
440
Verdef(const Verdef&);
441
Verdef& operator=(const Verdef&);
443
// The type of the list of version dependencies. Each dependency
444
// should be canonicalized in the dynamic Stringpool.
445
typedef std::vector<std::string> Deps;
447
// The name of this version. This should be canonicalized in the
448
// dynamic Stringpool.
450
// A list of other versions which this version depends upon.
452
// Whether this is the base version.
454
// Whether this version is weak.
456
// Whether this version is informational.
458
// Whether a version symbol has been created.
459
bool is_symbol_created_;
462
// A referened version. This will be associated with a filename by
465
class Verneed_version : public Version_base
468
Verneed_version(const char* version)
472
// Return the version name.
475
{ return this->version_; }
477
// Clear the weak flag. This is invalid for a reference.
480
{ gold_unreachable(); }
483
Verneed_version(const Verneed_version&);
484
Verneed_version& operator=(const Verneed_version&);
486
const char* version_;
489
// Version references in a single dynamic object.
494
Verneed(const char* filename)
495
: filename_(filename), need_versions_()
500
// Return the file name.
503
{ return this->filename_; }
505
// Return the number of versions.
507
count_versions() const
508
{ return this->need_versions_.size(); }
510
// Add a version name. The name should be canonicalized in the
511
// dynamic Stringpool. If the name is already present, this does
514
add_name(const char* name);
516
// Set the version indexes, starting at INDEX. Return the updated
519
finalize(unsigned int index);
521
// Write contents to buffer.
522
template<int size, bool big_endian>
524
write(const Stringpool*, bool is_last, unsigned char*) const;
527
Verneed(const Verneed&);
528
Verneed& operator=(const Verneed&);
530
// The type of the list of version names. Each name should be
531
// canonicalized in the dynamic Stringpool.
532
typedef std::vector<Verneed_version*> Need_versions;
534
// The filename of the dynamic object. This should be
535
// canonicalized in the dynamic Stringpool.
536
const char* filename_;
537
// The list of version names.
538
Need_versions need_versions_;
541
// This class handles version definitions and references which go into
547
Versions(const Version_script_info&, Stringpool*);
551
// SYM is going into the dynamic symbol table and has a version.
552
// Record the appropriate version information.
554
record_version(const Symbol_table* symtab, Stringpool*, const Symbol* sym);
556
// Set the version indexes. DYNSYM_INDEX is the index we should use
557
// for the next dynamic symbol. We add new dynamic symbols to SYMS
558
// and return an updated DYNSYM_INDEX.
560
finalize(Symbol_table* symtab, unsigned int dynsym_index,
561
std::vector<Symbol*>* syms);
563
// Return whether there are any version definitions.
566
{ return !this->defs_.empty(); }
568
// Return whether there are any version references.
571
{ return !this->needs_.empty(); }
573
// Build an allocated buffer holding the contents of the symbol
574
// version section (.gnu.version).
575
template<int size, bool big_endian>
577
symbol_section_contents(const Symbol_table*, const Stringpool*,
578
unsigned int local_symcount,
579
const std::vector<Symbol*>& syms,
580
unsigned char**, unsigned int*) const;
582
// Build an allocated buffer holding the contents of the version
583
// definition section (.gnu.version_d).
584
template<int size, bool big_endian>
586
def_section_contents(const Stringpool*, unsigned char**,
587
unsigned int* psize, unsigned int* pentries) const;
589
// Build an allocated buffer holding the contents of the version
590
// reference section (.gnu.version_r).
591
template<int size, bool big_endian>
593
need_section_contents(const Stringpool*, unsigned char**,
594
unsigned int* psize, unsigned int* pentries) const;
596
const Version_script_info&
597
version_script() const
598
{ return this->version_script_; }
601
Versions(const Versions&);
602
Versions& operator=(const Versions&);
604
// The type of the list of version definitions.
605
typedef std::vector<Verdef*> Defs;
607
// The type of the list of version references.
608
typedef std::vector<Verneed*> Needs;
610
// Handle a symbol SYM defined with version VERSION.
612
add_def(Stringpool*, const Symbol* sym, const char* version,
615
// Add a reference to version NAME in file FILENAME.
617
add_need(Stringpool*, const char* filename, const char* name,
620
// Get the dynamic object to use for SYM.
622
get_dynobj_for_sym(const Symbol_table*, const Symbol* sym) const;
624
// Return the version index to use for SYM.
626
version_index(const Symbol_table*, const Stringpool*,
627
const Symbol* sym) const;
629
// Define the base version of a shared library.
631
define_base_version(Stringpool* dynpool);
633
// We keep a hash table mapping canonicalized name/version pairs to
635
typedef std::pair<Stringpool::Key, Stringpool::Key> Key;
637
struct Version_table_hash
640
operator()(const Key& k) const
641
{ return k.first + k.second; }
644
struct Version_table_eq
647
operator()(const Key& k1, const Key& k2) const
648
{ return k1.first == k2.first && k1.second == k2.second; }
651
typedef Unordered_map<Key, Version_base*, Version_table_hash,
652
Version_table_eq> Version_table;
654
// The version definitions.
656
// The version references.
658
// The mapping from a canonicalized version/filename pair to a
659
// version index. The filename may be NULL.
660
Version_table version_table_;
661
// Whether the version indexes have been set.
663
// Contents of --version-script, if passed, or NULL.
664
const Version_script_info& version_script_;
665
// Whether we need to insert a base version. This is only used for
666
// shared libraries and is cleared when the base version is defined.
667
bool needs_base_version_;
670
} // End namespace gold.
672
#endif // !defined(GOLD_DYNOBJ_H)