annotate lld/wasm/SymbolTable.h @ 266:00f31e85ec16 default tip

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