xref: /freebsd/contrib/llvm-project/lld/ELF/SymbolTable.h (revision 18054d0220cfc8df9c9568c437bd6fbb59d53c3c)
1 //===- SymbolTable.h --------------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLD_ELF_SYMBOL_TABLE_H
10 #define LLD_ELF_SYMBOL_TABLE_H
11 
12 #include "InputFiles.h"
13 #include "Symbols.h"
14 #include "lld/Common/Strings.h"
15 #include "llvm/ADT/CachedHashString.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/STLExtras.h"
18 
19 namespace lld {
20 namespace elf {
21 
22 // SymbolTable is a bucket of all known symbols, including defined,
23 // undefined, or lazy symbols (the last one is symbols in archive
24 // files whose archive members are not yet loaded).
25 //
26 // We put all symbols of all files to a SymbolTable, and the
27 // SymbolTable selects the "best" symbols if there are name
28 // conflicts. For example, obviously, a defined symbol is better than
29 // an undefined symbol. Or, if there's a conflict between a lazy and a
30 // undefined, it'll read an archive member to read a real definition
31 // to replace the lazy symbol. The logic is implemented in the
32 // add*() functions, which are called by input files as they are parsed. There
33 // is one add* function per symbol type.
34 class SymbolTable {
35 public:
36   ArrayRef<Symbol *> symbols() const { return symVector; }
37 
38   void wrap(Symbol *sym, Symbol *real, Symbol *wrap);
39 
40   Symbol *insert(StringRef name);
41 
42   Symbol *addSymbol(const Symbol &newSym);
43 
44   void scanVersionScript();
45 
46   Symbol *find(StringRef name);
47 
48   void handleDynamicList();
49 
50   // Set of .so files to not link the same shared object file more than once.
51   llvm::DenseMap<llvm::CachedHashStringRef, SharedFile *> soNames;
52 
53   // Comdat groups define "link once" sections. If two comdat groups have the
54   // same name, only one of them is linked, and the other is ignored. This map
55   // is used to uniquify them.
56   llvm::DenseMap<llvm::CachedHashStringRef, const InputFile *> comdatGroups;
57 
58 private:
59   SmallVector<Symbol *, 0> findByVersion(SymbolVersion ver);
60   SmallVector<Symbol *, 0> findAllByVersion(SymbolVersion ver,
61                                             bool includeNonDefault);
62 
63   llvm::StringMap<SmallVector<Symbol *, 0>> &getDemangledSyms();
64   bool assignExactVersion(SymbolVersion ver, uint16_t versionId,
65                           StringRef versionName, bool includeNonDefault);
66   void assignWildcardVersion(SymbolVersion ver, uint16_t versionId,
67                              bool includeNonDefault);
68 
69   // The order the global symbols are in is not defined. We can use an arbitrary
70   // order, but it has to be reproducible. That is true even when cross linking.
71   // The default hashing of StringRef produces different results on 32 and 64
72   // bit systems so we use a map to a vector. That is arbitrary, deterministic
73   // but a bit inefficient.
74   // FIXME: Experiment with passing in a custom hashing or sorting the symbols
75   // once symbol resolution is finished.
76   llvm::DenseMap<llvm::CachedHashStringRef, int> symMap;
77   SmallVector<Symbol *, 0> symVector;
78 
79   // A map from demangled symbol names to their symbol objects.
80   // This mapping is 1:N because two symbols with different versions
81   // can have the same name. We use this map to handle "extern C++ {}"
82   // directive in version scripts.
83   llvm::Optional<llvm::StringMap<SmallVector<Symbol *, 0>>> demangledSyms;
84 };
85 
86 extern std::unique_ptr<SymbolTable> symtab;
87 
88 } // namespace elf
89 } // namespace lld
90 
91 #endif
92