annotate lld/wasm/SymbolTable.h @ 150:1d019706d866

LLVM10
author anatofuz
date Thu, 13 Feb 2020 15:10:13 +0900
parents
children 0572611fdcc8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===- SymbolTable.h --------------------------------------------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #ifndef LLD_WASM_SYMBOL_TABLE_H
anatofuz
parents:
diff changeset
10 #define LLD_WASM_SYMBOL_TABLE_H
anatofuz
parents:
diff changeset
11
anatofuz
parents:
diff changeset
12 #include "InputFiles.h"
anatofuz
parents:
diff changeset
13 #include "LTO.h"
anatofuz
parents:
diff changeset
14 #include "Symbols.h"
anatofuz
parents:
diff changeset
15 #include "lld/Common/LLVM.h"
anatofuz
parents:
diff changeset
16 #include "llvm/ADT/CachedHashString.h"
anatofuz
parents:
diff changeset
17 #include "llvm/ADT/DenseSet.h"
anatofuz
parents:
diff changeset
18
anatofuz
parents:
diff changeset
19 namespace lld {
anatofuz
parents:
diff changeset
20 namespace wasm {
anatofuz
parents:
diff changeset
21
anatofuz
parents:
diff changeset
22 class InputSegment;
anatofuz
parents:
diff changeset
23
anatofuz
parents:
diff changeset
24 // SymbolTable is a bucket of all known symbols, including defined,
anatofuz
parents:
diff changeset
25 // undefined, or lazy symbols (the last one is symbols in archive
anatofuz
parents:
diff changeset
26 // files whose archive members are not yet loaded).
anatofuz
parents:
diff changeset
27 //
anatofuz
parents:
diff changeset
28 // We put all symbols of all files to a SymbolTable, and the
anatofuz
parents:
diff changeset
29 // SymbolTable selects the "best" symbols if there are name
anatofuz
parents:
diff changeset
30 // conflicts. For example, obviously, a defined symbol is better than
anatofuz
parents:
diff changeset
31 // an undefined symbol. Or, if there's a conflict between a lazy and a
anatofuz
parents:
diff changeset
32 // undefined, it'll read an archive member to read a real definition
anatofuz
parents:
diff changeset
33 // to replace the lazy symbol. The logic is implemented in the
anatofuz
parents:
diff changeset
34 // add*() functions, which are called by input files as they are parsed.
anatofuz
parents:
diff changeset
35 // There is one add* function per symbol type.
anatofuz
parents:
diff changeset
36 class SymbolTable {
anatofuz
parents:
diff changeset
37 public:
anatofuz
parents:
diff changeset
38 void wrap(Symbol *sym, Symbol *real, Symbol *wrap);
anatofuz
parents:
diff changeset
39
anatofuz
parents:
diff changeset
40 void addFile(InputFile *file);
anatofuz
parents:
diff changeset
41
anatofuz
parents:
diff changeset
42 void addCombinedLTOObject();
anatofuz
parents:
diff changeset
43
anatofuz
parents:
diff changeset
44 ArrayRef<Symbol *> getSymbols() const { return symVector; }
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 Symbol *find(StringRef name);
anatofuz
parents:
diff changeset
47
anatofuz
parents:
diff changeset
48 void replace(StringRef name, Symbol* sym);
anatofuz
parents:
diff changeset
49
anatofuz
parents:
diff changeset
50 void trace(StringRef name);
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 Symbol *addDefinedFunction(StringRef name, uint32_t flags, InputFile *file,
anatofuz
parents:
diff changeset
53 InputFunction *function);
anatofuz
parents:
diff changeset
54 Symbol *addDefinedData(StringRef name, uint32_t flags, InputFile *file,
anatofuz
parents:
diff changeset
55 InputSegment *segment, uint32_t address,
anatofuz
parents:
diff changeset
56 uint32_t size);
anatofuz
parents:
diff changeset
57 Symbol *addDefinedGlobal(StringRef name, uint32_t flags, InputFile *file,
anatofuz
parents:
diff changeset
58 InputGlobal *g);
anatofuz
parents:
diff changeset
59 Symbol *addDefinedEvent(StringRef name, uint32_t flags, InputFile *file,
anatofuz
parents:
diff changeset
60 InputEvent *e);
anatofuz
parents:
diff changeset
61
anatofuz
parents:
diff changeset
62 Symbol *addUndefinedFunction(StringRef name, StringRef importName,
anatofuz
parents:
diff changeset
63 StringRef importModule, uint32_t flags,
anatofuz
parents:
diff changeset
64 InputFile *file, const WasmSignature *signature,
anatofuz
parents:
diff changeset
65 bool isCalledDirectly);
anatofuz
parents:
diff changeset
66 Symbol *addUndefinedData(StringRef name, uint32_t flags, InputFile *file);
anatofuz
parents:
diff changeset
67 Symbol *addUndefinedGlobal(StringRef name, StringRef importName,
anatofuz
parents:
diff changeset
68 StringRef importModule, uint32_t flags,
anatofuz
parents:
diff changeset
69 InputFile *file, const WasmGlobalType *type);
anatofuz
parents:
diff changeset
70
anatofuz
parents:
diff changeset
71 void addLazy(ArchiveFile *f, const llvm::object::Archive::Symbol *sym);
anatofuz
parents:
diff changeset
72
anatofuz
parents:
diff changeset
73 bool addComdat(StringRef name);
anatofuz
parents:
diff changeset
74
anatofuz
parents:
diff changeset
75 DefinedData *addSyntheticDataSymbol(StringRef name, uint32_t flags);
anatofuz
parents:
diff changeset
76 DefinedGlobal *addSyntheticGlobal(StringRef name, uint32_t flags,
anatofuz
parents:
diff changeset
77 InputGlobal *global);
anatofuz
parents:
diff changeset
78 DefinedFunction *addSyntheticFunction(StringRef name, uint32_t flags,
anatofuz
parents:
diff changeset
79 InputFunction *function);
anatofuz
parents:
diff changeset
80 DefinedData *addOptionalDataSymbol(StringRef name, uint32_t value = 0);
anatofuz
parents:
diff changeset
81
anatofuz
parents:
diff changeset
82 void handleSymbolVariants();
anatofuz
parents:
diff changeset
83 void handleWeakUndefines();
anatofuz
parents:
diff changeset
84
anatofuz
parents:
diff changeset
85 std::vector<ObjFile *> objectFiles;
anatofuz
parents:
diff changeset
86 std::vector<SharedFile *> sharedFiles;
anatofuz
parents:
diff changeset
87 std::vector<BitcodeFile *> bitcodeFiles;
anatofuz
parents:
diff changeset
88 std::vector<InputFunction *> syntheticFunctions;
anatofuz
parents:
diff changeset
89 std::vector<InputGlobal *> syntheticGlobals;
anatofuz
parents:
diff changeset
90
anatofuz
parents:
diff changeset
91 private:
anatofuz
parents:
diff changeset
92 std::pair<Symbol *, bool> insert(StringRef name, const InputFile *file);
anatofuz
parents:
diff changeset
93 std::pair<Symbol *, bool> insertName(StringRef name);
anatofuz
parents:
diff changeset
94
anatofuz
parents:
diff changeset
95 bool getFunctionVariant(Symbol* sym, const WasmSignature *sig,
anatofuz
parents:
diff changeset
96 const InputFile *file, Symbol **out);
anatofuz
parents:
diff changeset
97 InputFunction *replaceWithUnreachable(Symbol *sym, const WasmSignature &sig,
anatofuz
parents:
diff changeset
98 StringRef debugName);
anatofuz
parents:
diff changeset
99
anatofuz
parents:
diff changeset
100 // Maps symbol names to index into the symVector. -1 means that symbols
anatofuz
parents:
diff changeset
101 // is to not yet in the vector but it should have tracing enabled if it is
anatofuz
parents:
diff changeset
102 // ever added.
anatofuz
parents:
diff changeset
103 llvm::DenseMap<llvm::CachedHashStringRef, int> symMap;
anatofuz
parents:
diff changeset
104 std::vector<Symbol *> symVector;
anatofuz
parents:
diff changeset
105
anatofuz
parents:
diff changeset
106 // For certain symbols types, e.g. function symbols, we allow for muliple
anatofuz
parents:
diff changeset
107 // variants of the same symbol with different signatures.
anatofuz
parents:
diff changeset
108 llvm::DenseMap<llvm::CachedHashStringRef, std::vector<Symbol *>> symVariants;
anatofuz
parents:
diff changeset
109
anatofuz
parents:
diff changeset
110 // Comdat groups define "link once" sections. If two comdat groups have the
anatofuz
parents:
diff changeset
111 // same name, only one of them is linked, and the other is ignored. This set
anatofuz
parents:
diff changeset
112 // is used to uniquify them.
anatofuz
parents:
diff changeset
113 llvm::DenseSet<llvm::CachedHashStringRef> comdatGroups;
anatofuz
parents:
diff changeset
114
anatofuz
parents:
diff changeset
115 // For LTO.
anatofuz
parents:
diff changeset
116 std::unique_ptr<BitcodeCompiler> lto;
anatofuz
parents:
diff changeset
117 };
anatofuz
parents:
diff changeset
118
anatofuz
parents:
diff changeset
119 extern SymbolTable *symtab;
anatofuz
parents:
diff changeset
120
anatofuz
parents:
diff changeset
121 } // namespace wasm
anatofuz
parents:
diff changeset
122 } // namespace lld
anatofuz
parents:
diff changeset
123
anatofuz
parents:
diff changeset
124 #endif