annotate lld/wasm/SymbolTable.h @ 223:5f17cb93ff66 llvm-original

LLVM13 (2021/7/18)
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Sun, 18 Jul 2021 22:43:00 +0900
parents 79ff65ed7e25
children c4bab56944e8
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"
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
18 #include "llvm/ADT/Optional.h"
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
19 #include "llvm/BinaryFormat/WasmTraits.h"
150
anatofuz
parents:
diff changeset
20
anatofuz
parents:
diff changeset
21 namespace lld {
anatofuz
parents:
diff changeset
22 namespace wasm {
anatofuz
parents:
diff changeset
23
anatofuz
parents:
diff changeset
24 class InputSegment;
anatofuz
parents:
diff changeset
25
anatofuz
parents:
diff changeset
26 // SymbolTable is a bucket of all known symbols, including defined,
anatofuz
parents:
diff changeset
27 // undefined, or lazy symbols (the last one is symbols in archive
anatofuz
parents:
diff changeset
28 // files whose archive members are not yet loaded).
anatofuz
parents:
diff changeset
29 //
anatofuz
parents:
diff changeset
30 // We put all symbols of all files to a SymbolTable, and the
anatofuz
parents:
diff changeset
31 // SymbolTable selects the "best" symbols if there are name
anatofuz
parents:
diff changeset
32 // conflicts. For example, obviously, a defined symbol is better than
anatofuz
parents:
diff changeset
33 // an undefined symbol. Or, if there's a conflict between a lazy and a
anatofuz
parents:
diff changeset
34 // undefined, it'll read an archive member to read a real definition
anatofuz
parents:
diff changeset
35 // to replace the lazy symbol. The logic is implemented in the
anatofuz
parents:
diff changeset
36 // add*() functions, which are called by input files as they are parsed.
anatofuz
parents:
diff changeset
37 // There is one add* function per symbol type.
anatofuz
parents:
diff changeset
38 class SymbolTable {
anatofuz
parents:
diff changeset
39 public:
anatofuz
parents:
diff changeset
40 void wrap(Symbol *sym, Symbol *real, Symbol *wrap);
anatofuz
parents:
diff changeset
41
anatofuz
parents:
diff changeset
42 void addFile(InputFile *file);
anatofuz
parents:
diff changeset
43
anatofuz
parents:
diff changeset
44 void addCombinedLTOObject();
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 ArrayRef<Symbol *> getSymbols() const { return symVector; }
anatofuz
parents:
diff changeset
47
anatofuz
parents:
diff changeset
48 Symbol *find(StringRef name);
anatofuz
parents:
diff changeset
49
anatofuz
parents:
diff changeset
50 void replace(StringRef name, Symbol* sym);
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 void trace(StringRef name);
anatofuz
parents:
diff changeset
53
anatofuz
parents:
diff changeset
54 Symbol *addDefinedFunction(StringRef name, uint32_t flags, InputFile *file,
anatofuz
parents:
diff changeset
55 InputFunction *function);
anatofuz
parents:
diff changeset
56 Symbol *addDefinedData(StringRef name, uint32_t flags, InputFile *file,
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
57 InputChunk *segment, uint64_t address, uint64_t size);
150
anatofuz
parents:
diff changeset
58 Symbol *addDefinedGlobal(StringRef name, uint32_t flags, InputFile *file,
anatofuz
parents:
diff changeset
59 InputGlobal *g);
223
5f17cb93ff66 LLVM13 (2021/7/18)
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 221
diff changeset
60 Symbol *addDefinedTag(StringRef name, uint32_t flags, InputFile *file,
5f17cb93ff66 LLVM13 (2021/7/18)
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 221
diff changeset
61 InputTag *t);
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
62 Symbol *addDefinedTable(StringRef name, uint32_t flags, InputFile *file,
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
63 InputTable *t);
150
anatofuz
parents:
diff changeset
64
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
65 Symbol *addUndefinedFunction(StringRef name,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
66 llvm::Optional<StringRef> importName,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
67 llvm::Optional<StringRef> importModule,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
68 uint32_t flags, InputFile *file,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
69 const WasmSignature *signature,
150
anatofuz
parents:
diff changeset
70 bool isCalledDirectly);
anatofuz
parents:
diff changeset
71 Symbol *addUndefinedData(StringRef name, uint32_t flags, InputFile *file);
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
72 Symbol *addUndefinedGlobal(StringRef name,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
73 llvm::Optional<StringRef> importName,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
74 llvm::Optional<StringRef> importModule,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
75 uint32_t flags, InputFile *file,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
76 const WasmGlobalType *type);
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
77 Symbol *addUndefinedTable(StringRef name,
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
78 llvm::Optional<StringRef> importName,
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
79 llvm::Optional<StringRef> importModule,
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
80 uint32_t flags, InputFile *file,
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
81 const WasmTableType *type);
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
82
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
83 TableSymbol *resolveIndirectFunctionTable(bool required);
150
anatofuz
parents:
diff changeset
84
anatofuz
parents:
diff changeset
85 void addLazy(ArchiveFile *f, const llvm::object::Archive::Symbol *sym);
anatofuz
parents:
diff changeset
86
anatofuz
parents:
diff changeset
87 bool addComdat(StringRef name);
anatofuz
parents:
diff changeset
88
anatofuz
parents:
diff changeset
89 DefinedData *addSyntheticDataSymbol(StringRef name, uint32_t flags);
anatofuz
parents:
diff changeset
90 DefinedGlobal *addSyntheticGlobal(StringRef name, uint32_t flags,
anatofuz
parents:
diff changeset
91 InputGlobal *global);
anatofuz
parents:
diff changeset
92 DefinedFunction *addSyntheticFunction(StringRef name, uint32_t flags,
anatofuz
parents:
diff changeset
93 InputFunction *function);
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
94 DefinedData *addOptionalDataSymbol(StringRef name, uint64_t value = 0);
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
95 DefinedGlobal *addOptionalGlobalSymbol(StringRef name, InputGlobal *global);
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
96 DefinedTable *addSyntheticTable(StringRef name, uint32_t flags,
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
97 InputTable *global);
150
anatofuz
parents:
diff changeset
98
anatofuz
parents:
diff changeset
99 void handleSymbolVariants();
anatofuz
parents:
diff changeset
100 void handleWeakUndefines();
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
101 DefinedFunction *createUndefinedStub(const WasmSignature &sig);
150
anatofuz
parents:
diff changeset
102
anatofuz
parents:
diff changeset
103 std::vector<ObjFile *> objectFiles;
anatofuz
parents:
diff changeset
104 std::vector<SharedFile *> sharedFiles;
anatofuz
parents:
diff changeset
105 std::vector<BitcodeFile *> bitcodeFiles;
anatofuz
parents:
diff changeset
106 std::vector<InputFunction *> syntheticFunctions;
anatofuz
parents:
diff changeset
107 std::vector<InputGlobal *> syntheticGlobals;
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
108 std::vector<InputTable *> syntheticTables;
150
anatofuz
parents:
diff changeset
109
anatofuz
parents:
diff changeset
110 private:
anatofuz
parents:
diff changeset
111 std::pair<Symbol *, bool> insert(StringRef name, const InputFile *file);
anatofuz
parents:
diff changeset
112 std::pair<Symbol *, bool> insertName(StringRef name);
anatofuz
parents:
diff changeset
113
anatofuz
parents:
diff changeset
114 bool getFunctionVariant(Symbol* sym, const WasmSignature *sig,
anatofuz
parents:
diff changeset
115 const InputFile *file, Symbol **out);
anatofuz
parents:
diff changeset
116 InputFunction *replaceWithUnreachable(Symbol *sym, const WasmSignature &sig,
anatofuz
parents:
diff changeset
117 StringRef debugName);
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
118 void replaceWithUndefined(Symbol *sym);
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
119
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
120 TableSymbol *createDefinedIndirectFunctionTable(StringRef name);
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
121 TableSymbol *createUndefinedIndirectFunctionTable(StringRef name);
150
anatofuz
parents:
diff changeset
122
anatofuz
parents:
diff changeset
123 // Maps symbol names to index into the symVector. -1 means that symbols
anatofuz
parents:
diff changeset
124 // is to not yet in the vector but it should have tracing enabled if it is
anatofuz
parents:
diff changeset
125 // ever added.
anatofuz
parents:
diff changeset
126 llvm::DenseMap<llvm::CachedHashStringRef, int> symMap;
anatofuz
parents:
diff changeset
127 std::vector<Symbol *> symVector;
anatofuz
parents:
diff changeset
128
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
129 // For certain symbols types, e.g. function symbols, we allow for multiple
150
anatofuz
parents:
diff changeset
130 // variants of the same symbol with different signatures.
anatofuz
parents:
diff changeset
131 llvm::DenseMap<llvm::CachedHashStringRef, std::vector<Symbol *>> symVariants;
221
79ff65ed7e25 LLVM12 Original
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
132 llvm::DenseMap<WasmSignature, DefinedFunction *> stubFunctions;
150
anatofuz
parents:
diff changeset
133
anatofuz
parents:
diff changeset
134 // Comdat groups define "link once" sections. If two comdat groups have the
anatofuz
parents:
diff changeset
135 // same name, only one of them is linked, and the other is ignored. This set
anatofuz
parents:
diff changeset
136 // is used to uniquify them.
anatofuz
parents:
diff changeset
137 llvm::DenseSet<llvm::CachedHashStringRef> comdatGroups;
anatofuz
parents:
diff changeset
138
anatofuz
parents:
diff changeset
139 // For LTO.
anatofuz
parents:
diff changeset
140 std::unique_ptr<BitcodeCompiler> lto;
anatofuz
parents:
diff changeset
141 };
anatofuz
parents:
diff changeset
142
anatofuz
parents:
diff changeset
143 extern SymbolTable *symtab;
anatofuz
parents:
diff changeset
144
anatofuz
parents:
diff changeset
145 } // namespace wasm
anatofuz
parents:
diff changeset
146 } // namespace lld
anatofuz
parents:
diff changeset
147
anatofuz
parents:
diff changeset
148 #endif