annotate lld/ELF/Symbols.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 //===- Symbols.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 // This file defines various types of Symbols.
anatofuz
parents:
diff changeset
10 //
anatofuz
parents:
diff changeset
11 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
12
anatofuz
parents:
diff changeset
13 #ifndef LLD_ELF_SYMBOLS_H
anatofuz
parents:
diff changeset
14 #define LLD_ELF_SYMBOLS_H
anatofuz
parents:
diff changeset
15
anatofuz
parents:
diff changeset
16 #include "InputFiles.h"
anatofuz
parents:
diff changeset
17 #include "InputSection.h"
anatofuz
parents:
diff changeset
18 #include "lld/Common/LLVM.h"
anatofuz
parents:
diff changeset
19 #include "lld/Common/Strings.h"
anatofuz
parents:
diff changeset
20 #include "llvm/Object/Archive.h"
anatofuz
parents:
diff changeset
21 #include "llvm/Object/ELF.h"
anatofuz
parents:
diff changeset
22
anatofuz
parents:
diff changeset
23 namespace lld {
anatofuz
parents:
diff changeset
24 std::string toString(const elf::Symbol &);
anatofuz
parents:
diff changeset
25
anatofuz
parents:
diff changeset
26 // There are two different ways to convert an Archive::Symbol to a string:
anatofuz
parents:
diff changeset
27 // One for Microsoft name mangling and one for Itanium name mangling.
anatofuz
parents:
diff changeset
28 // Call the functions toCOFFString and toELFString, not just toString.
anatofuz
parents:
diff changeset
29 std::string toELFString(const llvm::object::Archive::Symbol &);
anatofuz
parents:
diff changeset
30
anatofuz
parents:
diff changeset
31 namespace elf {
anatofuz
parents:
diff changeset
32 class CommonSymbol;
anatofuz
parents:
diff changeset
33 class Defined;
anatofuz
parents:
diff changeset
34 class InputFile;
anatofuz
parents:
diff changeset
35 class LazyArchive;
anatofuz
parents:
diff changeset
36 class LazyObject;
anatofuz
parents:
diff changeset
37 class SharedSymbol;
anatofuz
parents:
diff changeset
38 class Symbol;
anatofuz
parents:
diff changeset
39 class Undefined;
anatofuz
parents:
diff changeset
40
anatofuz
parents:
diff changeset
41 // This is a StringRef-like container that doesn't run strlen().
anatofuz
parents:
diff changeset
42 //
anatofuz
parents:
diff changeset
43 // ELF string tables contain a lot of null-terminated strings. Most of them
anatofuz
parents:
diff changeset
44 // are not necessary for the linker because they are names of local symbols,
anatofuz
parents:
diff changeset
45 // and the linker doesn't use local symbol names for name resolution. So, we
anatofuz
parents:
diff changeset
46 // use this class to represents strings read from string tables.
anatofuz
parents:
diff changeset
47 struct StringRefZ {
anatofuz
parents:
diff changeset
48 StringRefZ(const char *s) : data(s), size(-1) {}
anatofuz
parents:
diff changeset
49 StringRefZ(StringRef s) : data(s.data()), size(s.size()) {}
anatofuz
parents:
diff changeset
50
anatofuz
parents:
diff changeset
51 const char *data;
anatofuz
parents:
diff changeset
52 const uint32_t size;
anatofuz
parents:
diff changeset
53 };
anatofuz
parents:
diff changeset
54
anatofuz
parents:
diff changeset
55 // The base class for real symbol classes.
anatofuz
parents:
diff changeset
56 class Symbol {
anatofuz
parents:
diff changeset
57 public:
anatofuz
parents:
diff changeset
58 enum Kind {
anatofuz
parents:
diff changeset
59 PlaceholderKind,
anatofuz
parents:
diff changeset
60 DefinedKind,
anatofuz
parents:
diff changeset
61 CommonKind,
anatofuz
parents:
diff changeset
62 SharedKind,
anatofuz
parents:
diff changeset
63 UndefinedKind,
anatofuz
parents:
diff changeset
64 LazyArchiveKind,
anatofuz
parents:
diff changeset
65 LazyObjectKind,
anatofuz
parents:
diff changeset
66 };
anatofuz
parents:
diff changeset
67
anatofuz
parents:
diff changeset
68 Kind kind() const { return static_cast<Kind>(symbolKind); }
anatofuz
parents:
diff changeset
69
anatofuz
parents:
diff changeset
70 // The file from which this symbol was created.
anatofuz
parents:
diff changeset
71 InputFile *file;
anatofuz
parents:
diff changeset
72
anatofuz
parents:
diff changeset
73 protected:
anatofuz
parents:
diff changeset
74 const char *nameData;
anatofuz
parents:
diff changeset
75 mutable uint32_t nameSize;
anatofuz
parents:
diff changeset
76
anatofuz
parents:
diff changeset
77 public:
anatofuz
parents:
diff changeset
78 uint32_t dynsymIndex = 0;
anatofuz
parents:
diff changeset
79 uint32_t gotIndex = -1;
anatofuz
parents:
diff changeset
80 uint32_t pltIndex = -1;
anatofuz
parents:
diff changeset
81
anatofuz
parents:
diff changeset
82 uint32_t globalDynIndex = -1;
anatofuz
parents:
diff changeset
83
anatofuz
parents:
diff changeset
84 // This field is a index to the symbol's version definition.
anatofuz
parents:
diff changeset
85 uint32_t verdefIndex = -1;
anatofuz
parents:
diff changeset
86
anatofuz
parents:
diff changeset
87 // Version definition index.
anatofuz
parents:
diff changeset
88 uint16_t versionId;
anatofuz
parents:
diff changeset
89
anatofuz
parents:
diff changeset
90 // Symbol binding. This is not overwritten by replace() to track
anatofuz
parents:
diff changeset
91 // changes during resolution. In particular:
anatofuz
parents:
diff changeset
92 // - An undefined weak is still weak when it resolves to a shared library.
anatofuz
parents:
diff changeset
93 // - An undefined weak will not fetch archive members, but we have to
anatofuz
parents:
diff changeset
94 // remember it is weak.
anatofuz
parents:
diff changeset
95 uint8_t binding;
anatofuz
parents:
diff changeset
96
anatofuz
parents:
diff changeset
97 // The following fields have the same meaning as the ELF symbol attributes.
anatofuz
parents:
diff changeset
98 uint8_t type; // symbol type
anatofuz
parents:
diff changeset
99 uint8_t stOther; // st_other field value
anatofuz
parents:
diff changeset
100
anatofuz
parents:
diff changeset
101 uint8_t symbolKind;
anatofuz
parents:
diff changeset
102
anatofuz
parents:
diff changeset
103 // Symbol visibility. This is the computed minimum visibility of all
anatofuz
parents:
diff changeset
104 // observed non-DSO symbols.
anatofuz
parents:
diff changeset
105 uint8_t visibility : 2;
anatofuz
parents:
diff changeset
106
anatofuz
parents:
diff changeset
107 // True if the symbol was used for linking and thus need to be added to the
anatofuz
parents:
diff changeset
108 // output file's symbol table. This is true for all symbols except for
anatofuz
parents:
diff changeset
109 // unreferenced DSO symbols, lazy (archive) symbols, and bitcode symbols that
anatofuz
parents:
diff changeset
110 // are unreferenced except by other bitcode objects.
anatofuz
parents:
diff changeset
111 uint8_t isUsedInRegularObj : 1;
anatofuz
parents:
diff changeset
112
anatofuz
parents:
diff changeset
113 // Used by a Defined symbol with protected or default visibility, to record
anatofuz
parents:
diff changeset
114 // whether it is required to be exported into .dynsym. This is set when any of
anatofuz
parents:
diff changeset
115 // the following conditions hold:
anatofuz
parents:
diff changeset
116 //
anatofuz
parents:
diff changeset
117 // - If there is an interposable symbol from a DSO.
anatofuz
parents:
diff changeset
118 // - If -shared or --export-dynamic is specified, any symbol in an object
anatofuz
parents:
diff changeset
119 // file/bitcode sets this property, unless suppressed by LTO
anatofuz
parents:
diff changeset
120 // canBeOmittedFromSymbolTable().
anatofuz
parents:
diff changeset
121 uint8_t exportDynamic : 1;
anatofuz
parents:
diff changeset
122
anatofuz
parents:
diff changeset
123 // True if the symbol is in the --dynamic-list file. A Defined symbol with
anatofuz
parents:
diff changeset
124 // protected or default visibility with this property is required to be
anatofuz
parents:
diff changeset
125 // exported into .dynsym.
anatofuz
parents:
diff changeset
126 uint8_t inDynamicList : 1;
anatofuz
parents:
diff changeset
127
anatofuz
parents:
diff changeset
128 // False if LTO shouldn't inline whatever this symbol points to. If a symbol
anatofuz
parents:
diff changeset
129 // is overwritten after LTO, LTO shouldn't inline the symbol because it
anatofuz
parents:
diff changeset
130 // doesn't know the final contents of the symbol.
anatofuz
parents:
diff changeset
131 uint8_t canInline : 1;
anatofuz
parents:
diff changeset
132
anatofuz
parents:
diff changeset
133 // Used by Undefined and SharedSymbol to track if there has been at least one
anatofuz
parents:
diff changeset
134 // undefined reference to the symbol. The binding may change to STB_WEAK if
anatofuz
parents:
diff changeset
135 // the first undefined reference from a non-shared object is weak.
anatofuz
parents:
diff changeset
136 uint8_t referenced : 1;
anatofuz
parents:
diff changeset
137
anatofuz
parents:
diff changeset
138 // True if this symbol is specified by --trace-symbol option.
anatofuz
parents:
diff changeset
139 uint8_t traced : 1;
anatofuz
parents:
diff changeset
140
anatofuz
parents:
diff changeset
141 inline void replace(const Symbol &newSym);
anatofuz
parents:
diff changeset
142
anatofuz
parents:
diff changeset
143 bool includeInDynsym() const;
anatofuz
parents:
diff changeset
144 uint8_t computeBinding() const;
anatofuz
parents:
diff changeset
145 bool isWeak() const { return binding == llvm::ELF::STB_WEAK; }
anatofuz
parents:
diff changeset
146
anatofuz
parents:
diff changeset
147 bool isUndefined() const { return symbolKind == UndefinedKind; }
anatofuz
parents:
diff changeset
148 bool isCommon() const { return symbolKind == CommonKind; }
anatofuz
parents:
diff changeset
149 bool isDefined() const { return symbolKind == DefinedKind; }
anatofuz
parents:
diff changeset
150 bool isShared() const { return symbolKind == SharedKind; }
anatofuz
parents:
diff changeset
151 bool isPlaceholder() const { return symbolKind == PlaceholderKind; }
anatofuz
parents:
diff changeset
152
anatofuz
parents:
diff changeset
153 bool isLocal() const { return binding == llvm::ELF::STB_LOCAL; }
anatofuz
parents:
diff changeset
154
anatofuz
parents:
diff changeset
155 bool isLazy() const {
anatofuz
parents:
diff changeset
156 return symbolKind == LazyArchiveKind || symbolKind == LazyObjectKind;
anatofuz
parents:
diff changeset
157 }
anatofuz
parents:
diff changeset
158
anatofuz
parents:
diff changeset
159 // True if this is an undefined weak symbol. This only works once
anatofuz
parents:
diff changeset
160 // all input files have been added.
anatofuz
parents:
diff changeset
161 bool isUndefWeak() const {
anatofuz
parents:
diff changeset
162 // See comment on lazy symbols for details.
anatofuz
parents:
diff changeset
163 return isWeak() && (isUndefined() || isLazy());
anatofuz
parents:
diff changeset
164 }
anatofuz
parents:
diff changeset
165
anatofuz
parents:
diff changeset
166 StringRef getName() const {
anatofuz
parents:
diff changeset
167 if (nameSize == (uint32_t)-1)
anatofuz
parents:
diff changeset
168 nameSize = strlen(nameData);
anatofuz
parents:
diff changeset
169 return {nameData, nameSize};
anatofuz
parents:
diff changeset
170 }
anatofuz
parents:
diff changeset
171
anatofuz
parents:
diff changeset
172 void setName(StringRef s) {
anatofuz
parents:
diff changeset
173 nameData = s.data();
anatofuz
parents:
diff changeset
174 nameSize = s.size();
anatofuz
parents:
diff changeset
175 }
anatofuz
parents:
diff changeset
176
anatofuz
parents:
diff changeset
177 void parseSymbolVersion();
anatofuz
parents:
diff changeset
178
anatofuz
parents:
diff changeset
179 bool isInGot() const { return gotIndex != -1U; }
anatofuz
parents:
diff changeset
180 bool isInPlt() const { return pltIndex != -1U; }
anatofuz
parents:
diff changeset
181
anatofuz
parents:
diff changeset
182 uint64_t getVA(int64_t addend = 0) const;
anatofuz
parents:
diff changeset
183
anatofuz
parents:
diff changeset
184 uint64_t getGotOffset() const;
anatofuz
parents:
diff changeset
185 uint64_t getGotVA() const;
anatofuz
parents:
diff changeset
186 uint64_t getGotPltOffset() const;
anatofuz
parents:
diff changeset
187 uint64_t getGotPltVA() const;
anatofuz
parents:
diff changeset
188 uint64_t getPltVA() const;
anatofuz
parents:
diff changeset
189 uint64_t getSize() const;
anatofuz
parents:
diff changeset
190 OutputSection *getOutputSection() const;
anatofuz
parents:
diff changeset
191
anatofuz
parents:
diff changeset
192 // The following two functions are used for symbol resolution.
anatofuz
parents:
diff changeset
193 //
anatofuz
parents:
diff changeset
194 // You are expected to call mergeProperties for all symbols in input
anatofuz
parents:
diff changeset
195 // files so that attributes that are attached to names rather than
anatofuz
parents:
diff changeset
196 // indivisual symbol (such as visibility) are merged together.
anatofuz
parents:
diff changeset
197 //
anatofuz
parents:
diff changeset
198 // Every time you read a new symbol from an input, you are supposed
anatofuz
parents:
diff changeset
199 // to call resolve() with the new symbol. That function replaces
anatofuz
parents:
diff changeset
200 // "this" object as a result of name resolution if the new symbol is
anatofuz
parents:
diff changeset
201 // more appropriate to be included in the output.
anatofuz
parents:
diff changeset
202 //
anatofuz
parents:
diff changeset
203 // For example, if "this" is an undefined symbol and a new symbol is
anatofuz
parents:
diff changeset
204 // a defined symbol, "this" is replaced with the new symbol.
anatofuz
parents:
diff changeset
205 void mergeProperties(const Symbol &other);
anatofuz
parents:
diff changeset
206 void resolve(const Symbol &other);
anatofuz
parents:
diff changeset
207
anatofuz
parents:
diff changeset
208 // If this is a lazy symbol, fetch an input file and add the symbol
anatofuz
parents:
diff changeset
209 // in the file to the symbol table. Calling this function on
anatofuz
parents:
diff changeset
210 // non-lazy object causes a runtime error.
anatofuz
parents:
diff changeset
211 void fetch() const;
anatofuz
parents:
diff changeset
212
anatofuz
parents:
diff changeset
213 private:
anatofuz
parents:
diff changeset
214 static bool isExportDynamic(Kind k, uint8_t visibility) {
anatofuz
parents:
diff changeset
215 if (k == SharedKind)
anatofuz
parents:
diff changeset
216 return visibility == llvm::ELF::STV_DEFAULT;
anatofuz
parents:
diff changeset
217 return config->shared || config->exportDynamic;
anatofuz
parents:
diff changeset
218 }
anatofuz
parents:
diff changeset
219
anatofuz
parents:
diff changeset
220 void resolveUndefined(const Undefined &other);
anatofuz
parents:
diff changeset
221 void resolveCommon(const CommonSymbol &other);
anatofuz
parents:
diff changeset
222 void resolveDefined(const Defined &other);
anatofuz
parents:
diff changeset
223 template <class LazyT> void resolveLazy(const LazyT &other);
anatofuz
parents:
diff changeset
224 void resolveShared(const SharedSymbol &other);
anatofuz
parents:
diff changeset
225
anatofuz
parents:
diff changeset
226 int compare(const Symbol *other) const;
anatofuz
parents:
diff changeset
227
anatofuz
parents:
diff changeset
228 inline size_t getSymbolSize() const;
anatofuz
parents:
diff changeset
229
anatofuz
parents:
diff changeset
230 protected:
anatofuz
parents:
diff changeset
231 Symbol(Kind k, InputFile *file, StringRefZ name, uint8_t binding,
anatofuz
parents:
diff changeset
232 uint8_t stOther, uint8_t type)
anatofuz
parents:
diff changeset
233 : file(file), nameData(name.data), nameSize(name.size), binding(binding),
anatofuz
parents:
diff changeset
234 type(type), stOther(stOther), symbolKind(k), visibility(stOther & 3),
anatofuz
parents:
diff changeset
235 isUsedInRegularObj(!file || file->kind() == InputFile::ObjKind),
anatofuz
parents:
diff changeset
236 exportDynamic(isExportDynamic(k, visibility)), inDynamicList(false),
anatofuz
parents:
diff changeset
237 canInline(false), referenced(false), traced(false), needsPltAddr(false),
anatofuz
parents:
diff changeset
238 isInIplt(false), gotInIgot(false), isPreemptible(false),
anatofuz
parents:
diff changeset
239 used(!config->gcSections), needsTocRestore(false),
anatofuz
parents:
diff changeset
240 scriptDefined(false) {}
anatofuz
parents:
diff changeset
241
anatofuz
parents:
diff changeset
242 public:
anatofuz
parents:
diff changeset
243 // True the symbol should point to its PLT entry.
anatofuz
parents:
diff changeset
244 // For SharedSymbol only.
anatofuz
parents:
diff changeset
245 uint8_t needsPltAddr : 1;
anatofuz
parents:
diff changeset
246
anatofuz
parents:
diff changeset
247 // True if this symbol is in the Iplt sub-section of the Plt and the Igot
anatofuz
parents:
diff changeset
248 // sub-section of the .got.plt or .got.
anatofuz
parents:
diff changeset
249 uint8_t isInIplt : 1;
anatofuz
parents:
diff changeset
250
anatofuz
parents:
diff changeset
251 // True if this symbol needs a GOT entry and its GOT entry is actually in
anatofuz
parents:
diff changeset
252 // Igot. This will be true only for certain non-preemptible ifuncs.
anatofuz
parents:
diff changeset
253 uint8_t gotInIgot : 1;
anatofuz
parents:
diff changeset
254
anatofuz
parents:
diff changeset
255 // True if this symbol is preemptible at load time.
anatofuz
parents:
diff changeset
256 uint8_t isPreemptible : 1;
anatofuz
parents:
diff changeset
257
anatofuz
parents:
diff changeset
258 // True if an undefined or shared symbol is used from a live section.
anatofuz
parents:
diff changeset
259 uint8_t used : 1;
anatofuz
parents:
diff changeset
260
anatofuz
parents:
diff changeset
261 // True if a call to this symbol needs to be followed by a restore of the
anatofuz
parents:
diff changeset
262 // PPC64 toc pointer.
anatofuz
parents:
diff changeset
263 uint8_t needsTocRestore : 1;
anatofuz
parents:
diff changeset
264
anatofuz
parents:
diff changeset
265 // True if this symbol is defined by a linker script.
anatofuz
parents:
diff changeset
266 uint8_t scriptDefined : 1;
anatofuz
parents:
diff changeset
267
anatofuz
parents:
diff changeset
268 // The partition whose dynamic symbol table contains this symbol's definition.
anatofuz
parents:
diff changeset
269 uint8_t partition = 1;
anatofuz
parents:
diff changeset
270
anatofuz
parents:
diff changeset
271 bool isSection() const { return type == llvm::ELF::STT_SECTION; }
anatofuz
parents:
diff changeset
272 bool isTls() const { return type == llvm::ELF::STT_TLS; }
anatofuz
parents:
diff changeset
273 bool isFunc() const { return type == llvm::ELF::STT_FUNC; }
anatofuz
parents:
diff changeset
274 bool isGnuIFunc() const { return type == llvm::ELF::STT_GNU_IFUNC; }
anatofuz
parents:
diff changeset
275 bool isObject() const { return type == llvm::ELF::STT_OBJECT; }
anatofuz
parents:
diff changeset
276 bool isFile() const { return type == llvm::ELF::STT_FILE; }
anatofuz
parents:
diff changeset
277 };
anatofuz
parents:
diff changeset
278
anatofuz
parents:
diff changeset
279 // Represents a symbol that is defined in the current output file.
anatofuz
parents:
diff changeset
280 class Defined : public Symbol {
anatofuz
parents:
diff changeset
281 public:
anatofuz
parents:
diff changeset
282 Defined(InputFile *file, StringRefZ name, uint8_t binding, uint8_t stOther,
anatofuz
parents:
diff changeset
283 uint8_t type, uint64_t value, uint64_t size, SectionBase *section)
anatofuz
parents:
diff changeset
284 : Symbol(DefinedKind, file, name, binding, stOther, type), value(value),
anatofuz
parents:
diff changeset
285 size(size), section(section) {}
anatofuz
parents:
diff changeset
286
anatofuz
parents:
diff changeset
287 static bool classof(const Symbol *s) { return s->isDefined(); }
anatofuz
parents:
diff changeset
288
anatofuz
parents:
diff changeset
289 uint64_t value;
anatofuz
parents:
diff changeset
290 uint64_t size;
anatofuz
parents:
diff changeset
291 SectionBase *section;
anatofuz
parents:
diff changeset
292 };
anatofuz
parents:
diff changeset
293
anatofuz
parents:
diff changeset
294 // Represents a common symbol.
anatofuz
parents:
diff changeset
295 //
anatofuz
parents:
diff changeset
296 // On Unix, it is traditionally allowed to write variable definitions
anatofuz
parents:
diff changeset
297 // without initialization expressions (such as "int foo;") to header
anatofuz
parents:
diff changeset
298 // files. Such definition is called "tentative definition".
anatofuz
parents:
diff changeset
299 //
anatofuz
parents:
diff changeset
300 // Using tentative definition is usually considered a bad practice
anatofuz
parents:
diff changeset
301 // because you should write only declarations (such as "extern int
anatofuz
parents:
diff changeset
302 // foo;") to header files. Nevertheless, the linker and the compiler
anatofuz
parents:
diff changeset
303 // have to do something to support bad code by allowing duplicate
anatofuz
parents:
diff changeset
304 // definitions for this particular case.
anatofuz
parents:
diff changeset
305 //
anatofuz
parents:
diff changeset
306 // Common symbols represent variable definitions without initializations.
anatofuz
parents:
diff changeset
307 // The compiler creates common symbols when it sees variable definitions
anatofuz
parents:
diff changeset
308 // without initialization (you can suppress this behavior and let the
anatofuz
parents:
diff changeset
309 // compiler create a regular defined symbol by -fno-common).
anatofuz
parents:
diff changeset
310 //
anatofuz
parents:
diff changeset
311 // The linker allows common symbols to be replaced by regular defined
anatofuz
parents:
diff changeset
312 // symbols. If there are remaining common symbols after name resolution is
anatofuz
parents:
diff changeset
313 // complete, they are converted to regular defined symbols in a .bss
anatofuz
parents:
diff changeset
314 // section. (Therefore, the later passes don't see any CommonSymbols.)
anatofuz
parents:
diff changeset
315 class CommonSymbol : public Symbol {
anatofuz
parents:
diff changeset
316 public:
anatofuz
parents:
diff changeset
317 CommonSymbol(InputFile *file, StringRefZ name, uint8_t binding,
anatofuz
parents:
diff changeset
318 uint8_t stOther, uint8_t type, uint64_t alignment, uint64_t size)
anatofuz
parents:
diff changeset
319 : Symbol(CommonKind, file, name, binding, stOther, type),
anatofuz
parents:
diff changeset
320 alignment(alignment), size(size) {}
anatofuz
parents:
diff changeset
321
anatofuz
parents:
diff changeset
322 static bool classof(const Symbol *s) { return s->isCommon(); }
anatofuz
parents:
diff changeset
323
anatofuz
parents:
diff changeset
324 uint32_t alignment;
anatofuz
parents:
diff changeset
325 uint64_t size;
anatofuz
parents:
diff changeset
326 };
anatofuz
parents:
diff changeset
327
anatofuz
parents:
diff changeset
328 class Undefined : public Symbol {
anatofuz
parents:
diff changeset
329 public:
anatofuz
parents:
diff changeset
330 Undefined(InputFile *file, StringRefZ name, uint8_t binding, uint8_t stOther,
anatofuz
parents:
diff changeset
331 uint8_t type, uint32_t discardedSecIdx = 0)
anatofuz
parents:
diff changeset
332 : Symbol(UndefinedKind, file, name, binding, stOther, type),
anatofuz
parents:
diff changeset
333 discardedSecIdx(discardedSecIdx) {}
anatofuz
parents:
diff changeset
334
anatofuz
parents:
diff changeset
335 static bool classof(const Symbol *s) { return s->kind() == UndefinedKind; }
anatofuz
parents:
diff changeset
336
anatofuz
parents:
diff changeset
337 // The section index if in a discarded section, 0 otherwise.
anatofuz
parents:
diff changeset
338 uint32_t discardedSecIdx;
anatofuz
parents:
diff changeset
339 };
anatofuz
parents:
diff changeset
340
anatofuz
parents:
diff changeset
341 class SharedSymbol : public Symbol {
anatofuz
parents:
diff changeset
342 public:
anatofuz
parents:
diff changeset
343 static bool classof(const Symbol *s) { return s->kind() == SharedKind; }
anatofuz
parents:
diff changeset
344
anatofuz
parents:
diff changeset
345 SharedSymbol(InputFile &file, StringRef name, uint8_t binding,
anatofuz
parents:
diff changeset
346 uint8_t stOther, uint8_t type, uint64_t value, uint64_t size,
anatofuz
parents:
diff changeset
347 uint32_t alignment, uint32_t verdefIndex)
anatofuz
parents:
diff changeset
348 : Symbol(SharedKind, &file, name, binding, stOther, type), value(value),
anatofuz
parents:
diff changeset
349 size(size), alignment(alignment) {
anatofuz
parents:
diff changeset
350 this->verdefIndex = verdefIndex;
anatofuz
parents:
diff changeset
351 // GNU ifunc is a mechanism to allow user-supplied functions to
anatofuz
parents:
diff changeset
352 // resolve PLT slot values at load-time. This is contrary to the
anatofuz
parents:
diff changeset
353 // regular symbol resolution scheme in which symbols are resolved just
anatofuz
parents:
diff changeset
354 // by name. Using this hook, you can program how symbols are solved
anatofuz
parents:
diff changeset
355 // for you program. For example, you can make "memcpy" to be resolved
anatofuz
parents:
diff changeset
356 // to a SSE-enabled version of memcpy only when a machine running the
anatofuz
parents:
diff changeset
357 // program supports the SSE instruction set.
anatofuz
parents:
diff changeset
358 //
anatofuz
parents:
diff changeset
359 // Naturally, such symbols should always be called through their PLT
anatofuz
parents:
diff changeset
360 // slots. What GNU ifunc symbols point to are resolver functions, and
anatofuz
parents:
diff changeset
361 // calling them directly doesn't make sense (unless you are writing a
anatofuz
parents:
diff changeset
362 // loader).
anatofuz
parents:
diff changeset
363 //
anatofuz
parents:
diff changeset
364 // For DSO symbols, we always call them through PLT slots anyway.
anatofuz
parents:
diff changeset
365 // So there's no difference between GNU ifunc and regular function
anatofuz
parents:
diff changeset
366 // symbols if they are in DSOs. So we can handle GNU_IFUNC as FUNC.
anatofuz
parents:
diff changeset
367 if (this->type == llvm::ELF::STT_GNU_IFUNC)
anatofuz
parents:
diff changeset
368 this->type = llvm::ELF::STT_FUNC;
anatofuz
parents:
diff changeset
369 }
anatofuz
parents:
diff changeset
370
anatofuz
parents:
diff changeset
371 SharedFile &getFile() const { return *cast<SharedFile>(file); }
anatofuz
parents:
diff changeset
372
anatofuz
parents:
diff changeset
373 uint64_t value; // st_value
anatofuz
parents:
diff changeset
374 uint64_t size; // st_size
anatofuz
parents:
diff changeset
375 uint32_t alignment;
anatofuz
parents:
diff changeset
376 };
anatofuz
parents:
diff changeset
377
anatofuz
parents:
diff changeset
378 // LazyArchive and LazyObject represent a symbols that is not yet in the link,
anatofuz
parents:
diff changeset
379 // but we know where to find it if needed. If the resolver finds both Undefined
anatofuz
parents:
diff changeset
380 // and Lazy for the same name, it will ask the Lazy to load a file.
anatofuz
parents:
diff changeset
381 //
anatofuz
parents:
diff changeset
382 // A special complication is the handling of weak undefined symbols. They should
anatofuz
parents:
diff changeset
383 // not load a file, but we have to remember we have seen both the weak undefined
anatofuz
parents:
diff changeset
384 // and the lazy. We represent that with a lazy symbol with a weak binding. This
anatofuz
parents:
diff changeset
385 // means that code looking for undefined symbols normally also has to take lazy
anatofuz
parents:
diff changeset
386 // symbols into consideration.
anatofuz
parents:
diff changeset
387
anatofuz
parents:
diff changeset
388 // This class represents a symbol defined in an archive file. It is
anatofuz
parents:
diff changeset
389 // created from an archive file header, and it knows how to load an
anatofuz
parents:
diff changeset
390 // object file from an archive to replace itself with a defined
anatofuz
parents:
diff changeset
391 // symbol.
anatofuz
parents:
diff changeset
392 class LazyArchive : public Symbol {
anatofuz
parents:
diff changeset
393 public:
anatofuz
parents:
diff changeset
394 LazyArchive(InputFile &file, const llvm::object::Archive::Symbol s)
anatofuz
parents:
diff changeset
395 : Symbol(LazyArchiveKind, &file, s.getName(), llvm::ELF::STB_GLOBAL,
anatofuz
parents:
diff changeset
396 llvm::ELF::STV_DEFAULT, llvm::ELF::STT_NOTYPE),
anatofuz
parents:
diff changeset
397 sym(s) {}
anatofuz
parents:
diff changeset
398
anatofuz
parents:
diff changeset
399 static bool classof(const Symbol *s) { return s->kind() == LazyArchiveKind; }
anatofuz
parents:
diff changeset
400
anatofuz
parents:
diff changeset
401 MemoryBufferRef getMemberBuffer();
anatofuz
parents:
diff changeset
402
anatofuz
parents:
diff changeset
403 const llvm::object::Archive::Symbol sym;
anatofuz
parents:
diff changeset
404 };
anatofuz
parents:
diff changeset
405
anatofuz
parents:
diff changeset
406 // LazyObject symbols represents symbols in object files between
anatofuz
parents:
diff changeset
407 // --start-lib and --end-lib options.
anatofuz
parents:
diff changeset
408 class LazyObject : public Symbol {
anatofuz
parents:
diff changeset
409 public:
anatofuz
parents:
diff changeset
410 LazyObject(InputFile &file, StringRef name)
anatofuz
parents:
diff changeset
411 : Symbol(LazyObjectKind, &file, name, llvm::ELF::STB_GLOBAL,
anatofuz
parents:
diff changeset
412 llvm::ELF::STV_DEFAULT, llvm::ELF::STT_NOTYPE) {}
anatofuz
parents:
diff changeset
413
anatofuz
parents:
diff changeset
414 static bool classof(const Symbol *s) { return s->kind() == LazyObjectKind; }
anatofuz
parents:
diff changeset
415 };
anatofuz
parents:
diff changeset
416
anatofuz
parents:
diff changeset
417 // Some linker-generated symbols need to be created as
anatofuz
parents:
diff changeset
418 // Defined symbols.
anatofuz
parents:
diff changeset
419 struct ElfSym {
anatofuz
parents:
diff changeset
420 // __bss_start
anatofuz
parents:
diff changeset
421 static Defined *bss;
anatofuz
parents:
diff changeset
422
anatofuz
parents:
diff changeset
423 // etext and _etext
anatofuz
parents:
diff changeset
424 static Defined *etext1;
anatofuz
parents:
diff changeset
425 static Defined *etext2;
anatofuz
parents:
diff changeset
426
anatofuz
parents:
diff changeset
427 // edata and _edata
anatofuz
parents:
diff changeset
428 static Defined *edata1;
anatofuz
parents:
diff changeset
429 static Defined *edata2;
anatofuz
parents:
diff changeset
430
anatofuz
parents:
diff changeset
431 // end and _end
anatofuz
parents:
diff changeset
432 static Defined *end1;
anatofuz
parents:
diff changeset
433 static Defined *end2;
anatofuz
parents:
diff changeset
434
anatofuz
parents:
diff changeset
435 // The _GLOBAL_OFFSET_TABLE_ symbol is defined by target convention to
anatofuz
parents:
diff changeset
436 // be at some offset from the base of the .got section, usually 0 or
anatofuz
parents:
diff changeset
437 // the end of the .got.
anatofuz
parents:
diff changeset
438 static Defined *globalOffsetTable;
anatofuz
parents:
diff changeset
439
anatofuz
parents:
diff changeset
440 // _gp, _gp_disp and __gnu_local_gp symbols. Only for MIPS.
anatofuz
parents:
diff changeset
441 static Defined *mipsGp;
anatofuz
parents:
diff changeset
442 static Defined *mipsGpDisp;
anatofuz
parents:
diff changeset
443 static Defined *mipsLocalGp;
anatofuz
parents:
diff changeset
444
anatofuz
parents:
diff changeset
445 // __rel{,a}_iplt_{start,end} symbols.
anatofuz
parents:
diff changeset
446 static Defined *relaIpltStart;
anatofuz
parents:
diff changeset
447 static Defined *relaIpltEnd;
anatofuz
parents:
diff changeset
448
anatofuz
parents:
diff changeset
449 // __global_pointer$ for RISC-V.
anatofuz
parents:
diff changeset
450 static Defined *riscvGlobalPointer;
anatofuz
parents:
diff changeset
451
anatofuz
parents:
diff changeset
452 // _TLS_MODULE_BASE_ on targets that support TLSDESC.
anatofuz
parents:
diff changeset
453 static Defined *tlsModuleBase;
anatofuz
parents:
diff changeset
454 };
anatofuz
parents:
diff changeset
455
anatofuz
parents:
diff changeset
456 // A buffer class that is large enough to hold any Symbol-derived
anatofuz
parents:
diff changeset
457 // object. We allocate memory using this class and instantiate a symbol
anatofuz
parents:
diff changeset
458 // using the placement new.
anatofuz
parents:
diff changeset
459 union SymbolUnion {
anatofuz
parents:
diff changeset
460 alignas(Defined) char a[sizeof(Defined)];
anatofuz
parents:
diff changeset
461 alignas(CommonSymbol) char b[sizeof(CommonSymbol)];
anatofuz
parents:
diff changeset
462 alignas(Undefined) char c[sizeof(Undefined)];
anatofuz
parents:
diff changeset
463 alignas(SharedSymbol) char d[sizeof(SharedSymbol)];
anatofuz
parents:
diff changeset
464 alignas(LazyArchive) char e[sizeof(LazyArchive)];
anatofuz
parents:
diff changeset
465 alignas(LazyObject) char f[sizeof(LazyObject)];
anatofuz
parents:
diff changeset
466 };
anatofuz
parents:
diff changeset
467
anatofuz
parents:
diff changeset
468 // It is important to keep the size of SymbolUnion small for performance and
anatofuz
parents:
diff changeset
469 // memory usage reasons. 80 bytes is a soft limit based on the size of Defined
anatofuz
parents:
diff changeset
470 // on a 64-bit system.
anatofuz
parents:
diff changeset
471 static_assert(sizeof(SymbolUnion) <= 80, "SymbolUnion too large");
anatofuz
parents:
diff changeset
472
anatofuz
parents:
diff changeset
473 template <typename T> struct AssertSymbol {
anatofuz
parents:
diff changeset
474 static_assert(std::is_trivially_destructible<T>(),
anatofuz
parents:
diff changeset
475 "Symbol types must be trivially destructible");
anatofuz
parents:
diff changeset
476 static_assert(sizeof(T) <= sizeof(SymbolUnion), "SymbolUnion too small");
anatofuz
parents:
diff changeset
477 static_assert(alignof(T) <= alignof(SymbolUnion),
anatofuz
parents:
diff changeset
478 "SymbolUnion not aligned enough");
anatofuz
parents:
diff changeset
479 };
anatofuz
parents:
diff changeset
480
anatofuz
parents:
diff changeset
481 static inline void assertSymbols() {
anatofuz
parents:
diff changeset
482 AssertSymbol<Defined>();
anatofuz
parents:
diff changeset
483 AssertSymbol<CommonSymbol>();
anatofuz
parents:
diff changeset
484 AssertSymbol<Undefined>();
anatofuz
parents:
diff changeset
485 AssertSymbol<SharedSymbol>();
anatofuz
parents:
diff changeset
486 AssertSymbol<LazyArchive>();
anatofuz
parents:
diff changeset
487 AssertSymbol<LazyObject>();
anatofuz
parents:
diff changeset
488 }
anatofuz
parents:
diff changeset
489
anatofuz
parents:
diff changeset
490 void printTraceSymbol(const Symbol *sym);
anatofuz
parents:
diff changeset
491
anatofuz
parents:
diff changeset
492 size_t Symbol::getSymbolSize() const {
anatofuz
parents:
diff changeset
493 switch (kind()) {
anatofuz
parents:
diff changeset
494 case CommonKind:
anatofuz
parents:
diff changeset
495 return sizeof(CommonSymbol);
anatofuz
parents:
diff changeset
496 case DefinedKind:
anatofuz
parents:
diff changeset
497 return sizeof(Defined);
anatofuz
parents:
diff changeset
498 case LazyArchiveKind:
anatofuz
parents:
diff changeset
499 return sizeof(LazyArchive);
anatofuz
parents:
diff changeset
500 case LazyObjectKind:
anatofuz
parents:
diff changeset
501 return sizeof(LazyObject);
anatofuz
parents:
diff changeset
502 case SharedKind:
anatofuz
parents:
diff changeset
503 return sizeof(SharedSymbol);
anatofuz
parents:
diff changeset
504 case UndefinedKind:
anatofuz
parents:
diff changeset
505 return sizeof(Undefined);
anatofuz
parents:
diff changeset
506 case PlaceholderKind:
anatofuz
parents:
diff changeset
507 return sizeof(Symbol);
anatofuz
parents:
diff changeset
508 }
anatofuz
parents:
diff changeset
509 llvm_unreachable("unknown symbol kind");
anatofuz
parents:
diff changeset
510 }
anatofuz
parents:
diff changeset
511
anatofuz
parents:
diff changeset
512 // replace() replaces "this" object with a given symbol by memcpy'ing
anatofuz
parents:
diff changeset
513 // it over to "this". This function is called as a result of name
anatofuz
parents:
diff changeset
514 // resolution, e.g. to replace an undefind symbol with a defined symbol.
anatofuz
parents:
diff changeset
515 void Symbol::replace(const Symbol &newSym) {
anatofuz
parents:
diff changeset
516 using llvm::ELF::STT_TLS;
anatofuz
parents:
diff changeset
517
anatofuz
parents:
diff changeset
518 // Symbols representing thread-local variables must be referenced by
anatofuz
parents:
diff changeset
519 // TLS-aware relocations, and non-TLS symbols must be reference by
anatofuz
parents:
diff changeset
520 // non-TLS relocations, so there's a clear distinction between TLS
anatofuz
parents:
diff changeset
521 // and non-TLS symbols. It is an error if the same symbol is defined
anatofuz
parents:
diff changeset
522 // as a TLS symbol in one file and as a non-TLS symbol in other file.
anatofuz
parents:
diff changeset
523 if (symbolKind != PlaceholderKind && !isLazy() && !newSym.isLazy() &&
anatofuz
parents:
diff changeset
524 (type == STT_TLS) != (newSym.type == STT_TLS))
anatofuz
parents:
diff changeset
525 error("TLS attribute mismatch: " + toString(*this) + "\n>>> defined in " +
anatofuz
parents:
diff changeset
526 toString(newSym.file) + "\n>>> defined in " + toString(file));
anatofuz
parents:
diff changeset
527
anatofuz
parents:
diff changeset
528 Symbol old = *this;
anatofuz
parents:
diff changeset
529 memcpy(this, &newSym, newSym.getSymbolSize());
anatofuz
parents:
diff changeset
530
anatofuz
parents:
diff changeset
531 // old may be a placeholder. The referenced fields must be initialized in
anatofuz
parents:
diff changeset
532 // SymbolTable::insert.
anatofuz
parents:
diff changeset
533 versionId = old.versionId;
anatofuz
parents:
diff changeset
534 visibility = old.visibility;
anatofuz
parents:
diff changeset
535 isUsedInRegularObj = old.isUsedInRegularObj;
anatofuz
parents:
diff changeset
536 exportDynamic = old.exportDynamic;
anatofuz
parents:
diff changeset
537 inDynamicList = old.inDynamicList;
anatofuz
parents:
diff changeset
538 canInline = old.canInline;
anatofuz
parents:
diff changeset
539 referenced = old.referenced;
anatofuz
parents:
diff changeset
540 traced = old.traced;
anatofuz
parents:
diff changeset
541 isPreemptible = old.isPreemptible;
anatofuz
parents:
diff changeset
542 scriptDefined = old.scriptDefined;
anatofuz
parents:
diff changeset
543 partition = old.partition;
anatofuz
parents:
diff changeset
544
anatofuz
parents:
diff changeset
545 // Symbol length is computed lazily. If we already know a symbol length,
anatofuz
parents:
diff changeset
546 // propagate it.
anatofuz
parents:
diff changeset
547 if (nameData == old.nameData && nameSize == 0 && old.nameSize != 0)
anatofuz
parents:
diff changeset
548 nameSize = old.nameSize;
anatofuz
parents:
diff changeset
549
anatofuz
parents:
diff changeset
550 // Print out a log message if --trace-symbol was specified.
anatofuz
parents:
diff changeset
551 // This is for debugging.
anatofuz
parents:
diff changeset
552 if (traced)
anatofuz
parents:
diff changeset
553 printTraceSymbol(this);
anatofuz
parents:
diff changeset
554 }
anatofuz
parents:
diff changeset
555
anatofuz
parents:
diff changeset
556 void maybeWarnUnorderableSymbol(const Symbol *sym);
anatofuz
parents:
diff changeset
557 bool computeIsPreemptible(const Symbol &sym);
anatofuz
parents:
diff changeset
558
anatofuz
parents:
diff changeset
559 } // namespace elf
anatofuz
parents:
diff changeset
560 } // namespace lld
anatofuz
parents:
diff changeset
561
anatofuz
parents:
diff changeset
562 #endif