blob: e72f7ef5a47db084727d9acb9091e2d579536680 [file] [log] [blame]
Michael J. Spencer84487f12015-07-24 21:03:07 +00001//===- SymbolTable.cpp ----------------------------------------------------===//
2//
3// The LLVM Linker
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Rui Ueyama34f29242015-10-13 19:51:57 +00009//
10// Symbol table is a bag of all known symbols. We put all symbols of
Rui Ueyamac9559d92016-01-05 20:47:37 +000011// all input files to the symbol table. The symbol table is basically
Rui Ueyama34f29242015-10-13 19:51:57 +000012// a hash table with the logic to resolve symbol name conflicts using
13// the symbol types.
14//
15//===----------------------------------------------------------------------===//
Michael J. Spencer84487f12015-07-24 21:03:07 +000016
17#include "SymbolTable.h"
Rafael Espindola4340aad2015-09-11 22:42:45 +000018#include "Config.h"
Rafael Espindola192e1fa2015-08-06 15:08:23 +000019#include "Error.h"
Davide Italiano8e1131d2016-06-29 02:46:51 +000020#include "LinkerScript.h"
George Rimar7899d482016-07-12 07:44:40 +000021#include "SymbolListFile.h"
Michael J. Spencer84487f12015-07-24 21:03:07 +000022#include "Symbols.h"
Rafael Espindola9f77ef02016-02-12 20:54:57 +000023#include "llvm/Bitcode/ReaderWriter.h"
Rui Ueyamadeb15402016-01-07 17:20:07 +000024#include "llvm/Support/StringSaver.h"
Michael J. Spencer84487f12015-07-24 21:03:07 +000025
26using namespace llvm;
Rafael Espindoladaa92a62015-08-31 01:16:19 +000027using namespace llvm::object;
Rafael Espindola01205f72015-09-22 18:19:46 +000028using namespace llvm::ELF;
Michael J. Spencer84487f12015-07-24 21:03:07 +000029
30using namespace lld;
Rafael Espindolae0df00b2016-02-28 00:25:54 +000031using namespace lld::elf;
Michael J. Spencer84487f12015-07-24 21:03:07 +000032
Rui Ueyamac9559d92016-01-05 20:47:37 +000033// All input object files must be for the same architecture
34// (e.g. it does not make sense to link x86 object files with
35// MIPS object files.) This function checks for that error.
George Rimardbbf60e2016-06-29 09:46:00 +000036template <class ELFT> static bool isCompatible(InputFile *F) {
37 if (!isa<ELFFileBase<ELFT>>(F) && !isa<BitcodeFile>(F))
Rui Ueyama16ba6692016-01-29 19:41:13 +000038 return true;
Rui Ueyama5e64d3f2016-06-29 01:30:50 +000039 if (F->EKind == Config->EKind && F->EMachine == Config->EMachine)
Rui Ueyama16ba6692016-01-29 19:41:13 +000040 return true;
Rui Ueyama25b44c92015-12-16 23:31:22 +000041 StringRef A = F->getName();
42 StringRef B = Config->Emulation;
43 if (B.empty())
44 B = Config->FirstElf->getName();
Rui Ueyama16ba6692016-01-29 19:41:13 +000045 error(A + " is incompatible with " + B);
46 return false;
Rui Ueyama25b44c92015-12-16 23:31:22 +000047}
48
Rui Ueyamac9559d92016-01-05 20:47:37 +000049// Add symbols in File to the symbol table.
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000050template <class ELFT> void SymbolTable<ELFT>::addFile(InputFile *File) {
51 if (!isCompatible<ELFT>(File))
Rui Ueyama16ba6692016-01-29 19:41:13 +000052 return;
Rafael Espindola525914d2015-10-11 03:36:49 +000053
Michael J. Spencera9424f32016-09-09 22:08:04 +000054 // Binary file
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000055 if (auto *F = dyn_cast<BinaryFile>(File)) {
Michael J. Spencera9424f32016-09-09 22:08:04 +000056 addFile(F->createELF<ELFT>());
57 return;
58 }
59
Rui Ueyama89575742015-12-16 22:59:13 +000060 // .a file
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000061 if (auto *F = dyn_cast<ArchiveFile>(File)) {
Peter Collingbourne4f952702016-05-01 04:55:03 +000062 F->parse<ELFT>();
Michael J. Spencer1b348a62015-09-04 22:28:10 +000063 return;
64 }
Rui Ueyama3d451792015-10-12 18:03:21 +000065
George Rimar2a78fce2016-04-13 18:07:57 +000066 // Lazy object file
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000067 if (auto *F = dyn_cast<LazyObjectFile>(File)) {
Peter Collingbourne4f952702016-05-01 04:55:03 +000068 F->parse<ELFT>();
George Rimar2a78fce2016-04-13 18:07:57 +000069 return;
70 }
71
72 if (Config->Trace)
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000073 outs() << getFilename(File) << "\n";
George Rimar2a78fce2016-04-13 18:07:57 +000074
Rui Ueyama89575742015-12-16 22:59:13 +000075 // .so file
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000076 if (auto *F = dyn_cast<SharedFile<ELFT>>(File)) {
Rui Ueyama89575742015-12-16 22:59:13 +000077 // DSOs are uniquified not by filename but by soname.
78 F->parseSoName();
Rui Ueyama131e0ff2016-01-08 22:17:42 +000079 if (!SoNames.insert(F->getSoName()).second)
Rafael Espindola6a3b5de2015-10-01 19:52:48 +000080 return;
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000081 SharedFiles.push_back(F);
Rui Ueyama7c713312016-01-06 01:56:36 +000082 F->parseRest();
Rui Ueyama89575742015-12-16 22:59:13 +000083 return;
Rafael Espindola6a3b5de2015-10-01 19:52:48 +000084 }
Rui Ueyama89575742015-12-16 22:59:13 +000085
Rui Ueyamaf8baa662016-04-07 19:24:51 +000086 // LLVM bitcode file
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000087 if (auto *F = dyn_cast<BitcodeFile>(File)) {
88 BitcodeFiles.push_back(F);
Peter Collingbourne4f952702016-05-01 04:55:03 +000089 F->parse<ELFT>(ComdatGroups);
Rafael Espindola9f77ef02016-02-12 20:54:57 +000090 return;
91 }
92
Rui Ueyamaf8baa662016-04-07 19:24:51 +000093 // Regular object file
Rui Ueyama38dbd3e2016-09-14 00:05:51 +000094 auto *F = cast<ObjectFile<ELFT>>(File);
95 ObjectFiles.push_back(F);
Rui Ueyama52d3b672016-01-06 02:06:33 +000096 F->parse(ComdatGroups);
Michael J. Spencer84487f12015-07-24 21:03:07 +000097}
98
Rui Ueyama42554752016-04-23 00:26:32 +000099// This function is where all the optimizations of link-time
100// optimization happens. When LTO is in use, some input files are
101// not in native object file format but in the LLVM bitcode format.
102// This function compiles bitcode files into a few big native files
103// using LLVM functions and replaces bitcode symbols with the results.
104// Because all bitcode files that consist of a program are passed
105// to the compiler at once, it can do whole-program optimization.
Rafael Espindola9f77ef02016-02-12 20:54:57 +0000106template <class ELFT> void SymbolTable<ELFT>::addCombinedLtoObject() {
107 if (BitcodeFiles.empty())
108 return;
Rui Ueyama25992482016-03-22 20:52:10 +0000109
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000110 // Compile bitcode files and replace bitcode symbols.
Rui Ueyama25992482016-03-22 20:52:10 +0000111 Lto.reset(new BitcodeCompiler);
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000112 for (BitcodeFile *F : BitcodeFiles)
Rui Ueyama25992482016-03-22 20:52:10 +0000113 Lto->add(*F);
Rui Ueyama25992482016-03-22 20:52:10 +0000114
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000115 for (InputFile *File : Lto->compile()) {
116 ObjectFile<ELFT> *Obj = cast<ObjectFile<ELFT>>(File);
Rui Ueyama818bb2f2016-07-16 18:55:47 +0000117 DenseSet<StringRef> DummyGroups;
Davide Italianobc176632016-04-15 22:38:10 +0000118 Obj->parse(DummyGroups);
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000119 ObjectFiles.push_back(Obj);
Rafael Espindola9f77ef02016-02-12 20:54:57 +0000120 }
121}
122
Rafael Espindola0e604f92015-09-25 18:56:53 +0000123template <class ELFT>
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000124DefinedRegular<ELFT> *SymbolTable<ELFT>::addAbsolute(StringRef Name,
125 uint8_t Visibility) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000126 return cast<DefinedRegular<ELFT>>(
127 addRegular(Name, STB_GLOBAL, Visibility)->body());
Rafael Espindola0e604f92015-09-25 18:56:53 +0000128}
129
Rui Ueyamac9559d92016-01-05 20:47:37 +0000130// Add Name as an "ignored" symbol. An ignored symbol is a regular
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000131// linker-synthesized defined symbol, but is only defined if needed.
Simon Atanasyan09dae7c2015-12-16 14:45:09 +0000132template <class ELFT>
Rafael Espindolaccfe3cb2016-04-04 14:04:16 +0000133DefinedRegular<ELFT> *SymbolTable<ELFT>::addIgnored(StringRef Name,
134 uint8_t Visibility) {
135 if (!find(Name))
136 return nullptr;
137 return addAbsolute(Name, Visibility);
Rafael Espindola5d413262015-10-01 21:22:26 +0000138}
139
Rui Ueyama69c778c2016-07-17 17:50:09 +0000140// Set a flag for --trace-symbol so that we can print out a log message
141// if a new symbol with the same name is inserted into the symbol table.
142template <class ELFT> void SymbolTable<ELFT>::trace(StringRef Name) {
Rui Ueyamae3357902016-07-18 01:35:00 +0000143 Symtab.insert({Name, {-1, true}});
Rui Ueyama69c778c2016-07-17 17:50:09 +0000144}
145
Rui Ueyamadeb15402016-01-07 17:20:07 +0000146// Rename SYM as __wrap_SYM. The original symbol is preserved as __real_SYM.
147// Used to implement --wrap.
148template <class ELFT> void SymbolTable<ELFT>::wrap(StringRef Name) {
Rui Ueyama1b70d662016-04-28 00:03:38 +0000149 SymbolBody *B = find(Name);
150 if (!B)
Rui Ueyamadeb15402016-01-07 17:20:07 +0000151 return;
152 StringSaver Saver(Alloc);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000153 Symbol *Sym = B->symbol();
154 Symbol *Real = addUndefined(Saver.save("__real_" + Name));
155 Symbol *Wrap = addUndefined(Saver.save("__wrap_" + Name));
156 // We rename symbols by replacing the old symbol's SymbolBody with the new
157 // symbol's SymbolBody. This causes all SymbolBody pointers referring to the
158 // old symbol to instead refer to the new symbol.
159 memcpy(Real->Body.buffer, Sym->Body.buffer, sizeof(Sym->Body));
160 memcpy(Sym->Body.buffer, Wrap->Body.buffer, sizeof(Wrap->Body));
Rui Ueyamadeb15402016-01-07 17:20:07 +0000161}
162
Peter Collingbournedadcc172016-04-22 18:42:48 +0000163static uint8_t getMinVisibility(uint8_t VA, uint8_t VB) {
164 if (VA == STV_DEFAULT)
165 return VB;
166 if (VB == STV_DEFAULT)
167 return VA;
168 return std::min(VA, VB);
169}
170
Rui Ueyamadace8382016-07-21 13:13:21 +0000171// Parses a symbol in the form of <name>@<version> or <name>@@<version>.
172static std::pair<StringRef, uint16_t> getSymbolVersion(StringRef S) {
173 if (Config->VersionDefinitions.empty())
174 return {S, Config->DefaultSymbolVersion};
175
176 size_t Pos = S.find('@');
177 if (Pos == 0 || Pos == StringRef::npos)
178 return {S, Config->DefaultSymbolVersion};
179
180 StringRef Name = S.substr(0, Pos);
181 StringRef Verstr = S.substr(Pos + 1);
182 if (Verstr.empty())
183 return {S, Config->DefaultSymbolVersion};
184
185 // '@@' in a symbol name means the default version.
186 // It is usually the most recent one.
187 bool IsDefault = (Verstr[0] == '@');
188 if (IsDefault)
189 Verstr = Verstr.substr(1);
190
191 for (VersionDefinition &V : Config->VersionDefinitions) {
192 if (V.Name == Verstr)
193 return {Name, IsDefault ? V.Id : (V.Id | VERSYM_HIDDEN)};
194 }
195
196 // It is an error if the specified version was not defined.
197 error("symbol " + S + " has undefined version " + Verstr);
198 return {S, Config->DefaultSymbolVersion};
199}
200
Rui Ueyamab4de5952016-01-08 22:01:33 +0000201// Find an existing symbol or create and insert a new one.
Peter Collingbourne4f952702016-05-01 04:55:03 +0000202template <class ELFT>
Rui Ueyamadace8382016-07-21 13:13:21 +0000203std::pair<Symbol *, bool> SymbolTable<ELFT>::insert(StringRef &Name) {
George Rimarb0841252016-07-20 14:26:48 +0000204 auto P = Symtab.insert({Name, SymIndex((int)SymVector.size(), false)});
Rui Ueyamae3357902016-07-18 01:35:00 +0000205 SymIndex &V = P.first->second;
Rui Ueyama69c778c2016-07-17 17:50:09 +0000206 bool IsNew = P.second;
207
Rui Ueyamae3357902016-07-18 01:35:00 +0000208 if (V.Idx == -1) {
209 IsNew = true;
George Rimarb0841252016-07-20 14:26:48 +0000210 V = SymIndex((int)SymVector.size(), true);
Rui Ueyamae3357902016-07-18 01:35:00 +0000211 }
212
Rafael Espindola7f0b7272016-04-14 20:42:43 +0000213 Symbol *Sym;
Rui Ueyama69c778c2016-07-17 17:50:09 +0000214 if (IsNew) {
Peter Collingbourne66ac1d62016-04-22 20:21:26 +0000215 Sym = new (Alloc) Symbol;
Peter Collingbourne4f952702016-05-01 04:55:03 +0000216 Sym->Binding = STB_WEAK;
Peter Collingbourne66ac1d62016-04-22 20:21:26 +0000217 Sym->Visibility = STV_DEFAULT;
218 Sym->IsUsedInRegularObj = false;
Davide Italiano35af5b32016-08-30 20:15:03 +0000219 Sym->HasUnnamedAddr = true;
Peter Collingbourne66ac1d62016-04-22 20:21:26 +0000220 Sym->ExportDynamic = false;
Rui Ueyamae3357902016-07-18 01:35:00 +0000221 Sym->Traced = V.Traced;
Rui Ueyamadace8382016-07-21 13:13:21 +0000222 std::tie(Name, Sym->VersionId) = getSymbolVersion(Name);
Rafael Espindola7f0b7272016-04-14 20:42:43 +0000223 SymVector.push_back(Sym);
224 } else {
Rui Ueyamae3357902016-07-18 01:35:00 +0000225 Sym = SymVector[V.Idx];
Rafael Espindola7f0b7272016-04-14 20:42:43 +0000226 }
Rui Ueyama69c778c2016-07-17 17:50:09 +0000227 return {Sym, IsNew};
Peter Collingbourne4f952702016-05-01 04:55:03 +0000228}
Peter Collingbournedadcc172016-04-22 18:42:48 +0000229
Peter Collingbourne4f952702016-05-01 04:55:03 +0000230// Find an existing symbol or create and insert a new one, then apply the given
231// attributes.
232template <class ELFT>
233std::pair<Symbol *, bool>
Rui Ueyamadace8382016-07-21 13:13:21 +0000234SymbolTable<ELFT>::insert(StringRef &Name, uint8_t Type, uint8_t Visibility,
Davide Italiano35af5b32016-08-30 20:15:03 +0000235 bool CanOmitFromDynSym, bool HasUnnamedAddr,
Rafael Espindola05098762016-08-31 13:49:23 +0000236 InputFile *File) {
237 bool IsUsedInRegularObj = !File || File->kind() == InputFile::ObjectKind;
Peter Collingbourne4f952702016-05-01 04:55:03 +0000238 Symbol *S;
239 bool WasInserted;
240 std::tie(S, WasInserted) = insert(Name);
241
Davide Italiano35af5b32016-08-30 20:15:03 +0000242 // Merge in the new unnamed_addr attribute.
243 S->HasUnnamedAddr &= HasUnnamedAddr;
Peter Collingbourne4f952702016-05-01 04:55:03 +0000244 // Merge in the new symbol's visibility.
245 S->Visibility = getMinVisibility(S->Visibility, Visibility);
246 if (!CanOmitFromDynSym && (Config->Shared || Config->ExportDynamic))
247 S->ExportDynamic = true;
248 if (IsUsedInRegularObj)
249 S->IsUsedInRegularObj = true;
Peter Collingbournef3a2b0e2016-05-03 18:03:47 +0000250 if (!WasInserted && S->body()->Type != SymbolBody::UnknownType &&
251 ((Type == STT_TLS) != S->body()->isTls()))
Peter Collingbourne4f952702016-05-01 04:55:03 +0000252 error("TLS attribute mismatch for symbol: " +
253 conflictMsg(S->body(), File));
254
255 return {S, WasInserted};
256}
257
258// Construct a string in the form of "Sym in File1 and File2".
259// Used to construct an error message.
260template <typename ELFT>
261std::string SymbolTable<ELFT>::conflictMsg(SymbolBody *Existing,
262 InputFile *NewFile) {
Rui Ueyamaf4d93382016-07-07 23:04:15 +0000263 std::string Sym = Existing->getName();
264 if (Config->Demangle)
265 Sym = demangle(Sym);
Rui Ueyama434b5612016-07-17 03:11:46 +0000266 return Sym + " in " + getFilename(Existing->File) + " and " +
Rui Ueyamaf4d93382016-07-07 23:04:15 +0000267 getFilename(NewFile);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000268}
269
270template <class ELFT> Symbol *SymbolTable<ELFT>::addUndefined(StringRef Name) {
271 return addUndefined(Name, STB_GLOBAL, STV_DEFAULT, /*Type*/ 0,
Davide Italiano35af5b32016-08-30 20:15:03 +0000272 /*CanOmitFromDynSym*/ false, /*HasUnnamedAddr*/ false,
273 /*File*/ nullptr);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000274}
275
276template <class ELFT>
277Symbol *SymbolTable<ELFT>::addUndefined(StringRef Name, uint8_t Binding,
278 uint8_t StOther, uint8_t Type,
Rafael Espindolacc70da32016-06-15 17:56:10 +0000279 bool CanOmitFromDynSym,
Davide Italiano35af5b32016-08-30 20:15:03 +0000280 bool HasUnnamedAddr, InputFile *File) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000281 Symbol *S;
282 bool WasInserted;
283 std::tie(S, WasInserted) =
Rafael Espindola05098762016-08-31 13:49:23 +0000284 insert(Name, Type, StOther & 3, CanOmitFromDynSym, HasUnnamedAddr, File);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000285 if (WasInserted) {
286 S->Binding = Binding;
Rui Ueyama434b5612016-07-17 03:11:46 +0000287 replaceBody<Undefined>(S, Name, StOther, Type, File);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000288 return S;
289 }
Peter Collingbourneca8c9942016-06-09 18:01:35 +0000290 if (Binding != STB_WEAK) {
291 if (S->body()->isShared() || S->body()->isLazy())
292 S->Binding = Binding;
293 if (auto *SS = dyn_cast<SharedSymbol<ELFT>>(S->body()))
Rui Ueyama434b5612016-07-17 03:11:46 +0000294 SS->file()->IsUsed = true;
Peter Collingbourneca8c9942016-06-09 18:01:35 +0000295 }
Peter Collingbourne4f952702016-05-01 04:55:03 +0000296 if (auto *L = dyn_cast<Lazy>(S->body())) {
297 // An undefined weak will not fetch archive members, but we have to remember
298 // its type. See also comment in addLazyArchive.
299 if (S->isWeak())
300 L->Type = Type;
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000301 else if (InputFile *F = L->fetch())
302 addFile(F);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000303 }
304 return S;
305}
306
307// We have a new defined symbol with the specified binding. Return 1 if the new
308// symbol should win, -1 if the new symbol should lose, or 0 if both symbols are
309// strong defined symbols.
310static int compareDefined(Symbol *S, bool WasInserted, uint8_t Binding) {
311 if (WasInserted)
312 return 1;
313 SymbolBody *Body = S->body();
314 if (Body->isLazy() || Body->isUndefined() || Body->isShared())
315 return 1;
316 if (Binding == STB_WEAK)
317 return -1;
318 if (S->isWeak())
319 return 1;
320 return 0;
321}
322
323// We have a new non-common defined symbol with the specified binding. Return 1
324// if the new symbol should win, -1 if the new symbol should lose, or 0 if there
325// is a conflict. If the new symbol wins, also update the binding.
Eugene Leviant3e6b0272016-07-28 19:24:13 +0000326static int compareDefinedNonCommon(Symbol *S, bool WasInserted,
327 uint8_t Binding) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000328 if (int Cmp = compareDefined(S, WasInserted, Binding)) {
329 if (Cmp > 0)
330 S->Binding = Binding;
331 return Cmp;
332 }
Rafael Espindolae7553e42016-08-31 13:28:33 +0000333 if (isa<DefinedCommon>(S->body())) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000334 // Non-common symbols take precedence over common symbols.
335 if (Config->WarnCommon)
336 warning("common " + S->body()->getName() + " is overridden");
337 return 1;
338 }
339 return 0;
340}
341
342template <class ELFT>
343Symbol *SymbolTable<ELFT>::addCommon(StringRef N, uint64_t Size,
344 uint64_t Alignment, uint8_t Binding,
345 uint8_t StOther, uint8_t Type,
Davide Italiano35af5b32016-08-30 20:15:03 +0000346 bool HasUnnamedAddr, InputFile *File) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000347 Symbol *S;
348 bool WasInserted;
Rafael Espindola05098762016-08-31 13:49:23 +0000349 std::tie(S, WasInserted) = insert(
350 N, Type, StOther & 3, /*CanOmitFromDynSym*/ false, HasUnnamedAddr, File);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000351 int Cmp = compareDefined(S, WasInserted, Binding);
352 if (Cmp > 0) {
353 S->Binding = Binding;
Rafael Espindolae7553e42016-08-31 13:28:33 +0000354 replaceBody<DefinedCommon>(S, N, Size, Alignment, StOther, Type, File);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000355 } else if (Cmp == 0) {
Rafael Espindolae7553e42016-08-31 13:28:33 +0000356 auto *C = dyn_cast<DefinedCommon>(S->body());
Peter Collingbourne4f952702016-05-01 04:55:03 +0000357 if (!C) {
358 // Non-common symbols take precedence over common symbols.
359 if (Config->WarnCommon)
360 warning("common " + S->body()->getName() + " is overridden");
361 return S;
362 }
363
364 if (Config->WarnCommon)
365 warning("multiple common of " + S->body()->getName());
366
Rafael Espindola8db87292016-08-31 13:42:08 +0000367 Alignment = C->Alignment = std::max(C->Alignment, Alignment);
368 if (Size > C->Size)
369 replaceBody<DefinedCommon>(S, N, Size, Alignment, StOther, Type, File);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000370 }
371 return S;
372}
373
374template <class ELFT>
375void SymbolTable<ELFT>::reportDuplicate(SymbolBody *Existing,
376 InputFile *NewFile) {
377 std::string Msg = "duplicate symbol: " + conflictMsg(Existing, NewFile);
378 if (Config->AllowMultipleDefinition)
379 warning(Msg);
380 else
381 error(Msg);
382}
383
384template <typename ELFT>
385Symbol *SymbolTable<ELFT>::addRegular(StringRef Name, const Elf_Sym &Sym,
386 InputSectionBase<ELFT> *Section) {
387 Symbol *S;
388 bool WasInserted;
Rafael Espindola05098762016-08-31 13:49:23 +0000389 std::tie(S, WasInserted) =
390 insert(Name, Sym.getType(), Sym.getVisibility(),
391 /*CanOmitFromDynSym*/ false, /*HasUnnamedAddr*/ false,
392 Section ? Section->getFile() : nullptr);
Rafael Espindolae7553e42016-08-31 13:28:33 +0000393 int Cmp = compareDefinedNonCommon(S, WasInserted, Sym.getBinding());
Peter Collingbourne4f952702016-05-01 04:55:03 +0000394 if (Cmp > 0)
395 replaceBody<DefinedRegular<ELFT>>(S, Name, Sym, Section);
396 else if (Cmp == 0)
397 reportDuplicate(S->body(), Section->getFile());
398 return S;
399}
400
401template <typename ELFT>
402Symbol *SymbolTable<ELFT>::addRegular(StringRef Name, uint8_t Binding,
403 uint8_t StOther) {
404 Symbol *S;
405 bool WasInserted;
406 std::tie(S, WasInserted) =
407 insert(Name, STT_NOTYPE, StOther & 3, /*CanOmitFromDynSym*/ false,
Rafael Espindola05098762016-08-31 13:49:23 +0000408 /*HasUnnamedAddr*/ false, nullptr);
Rafael Espindolae7553e42016-08-31 13:28:33 +0000409 int Cmp = compareDefinedNonCommon(S, WasInserted, Binding);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000410 if (Cmp > 0)
411 replaceBody<DefinedRegular<ELFT>>(S, Name, StOther);
412 else if (Cmp == 0)
413 reportDuplicate(S->body(), nullptr);
414 return S;
415}
416
417template <typename ELFT>
418Symbol *SymbolTable<ELFT>::addSynthetic(StringRef N,
Peter Collingbourne6a422592016-05-03 01:21:08 +0000419 OutputSectionBase<ELFT> *Section,
George Rimare1937bb2016-08-19 15:36:32 +0000420 uintX_t Value, uint8_t StOther) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000421 Symbol *S;
422 bool WasInserted;
George Rimare1937bb2016-08-19 15:36:32 +0000423 std::tie(S, WasInserted) = insert(N, STT_NOTYPE, /*Visibility*/ StOther & 0x3,
424 /*CanOmitFromDynSym*/ false,
Rafael Espindola05098762016-08-31 13:49:23 +0000425 /*HasUnnamedAddr*/ false, nullptr);
Rafael Espindolae7553e42016-08-31 13:28:33 +0000426 int Cmp = compareDefinedNonCommon(S, WasInserted, STB_GLOBAL);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000427 if (Cmp > 0)
428 replaceBody<DefinedSynthetic<ELFT>>(S, N, Value, Section);
429 else if (Cmp == 0)
430 reportDuplicate(S->body(), nullptr);
431 return S;
432}
433
434template <typename ELFT>
435void SymbolTable<ELFT>::addShared(SharedFile<ELFT> *F, StringRef Name,
436 const Elf_Sym &Sym,
437 const typename ELFT::Verdef *Verdef) {
438 // DSO symbols do not affect visibility in the output, so we pass STV_DEFAULT
439 // as the visibility, which will leave the visibility in the symbol table
440 // unchanged.
441 Symbol *S;
442 bool WasInserted;
443 std::tie(S, WasInserted) =
444 insert(Name, Sym.getType(), STV_DEFAULT, /*CanOmitFromDynSym*/ true,
Rafael Espindola05098762016-08-31 13:49:23 +0000445 /*HasUnnamedAddr*/ false, F);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000446 // Make sure we preempt DSO symbols with default visibility.
447 if (Sym.getVisibility() == STV_DEFAULT)
448 S->ExportDynamic = true;
Peter Collingbourneca8c9942016-06-09 18:01:35 +0000449 if (WasInserted || isa<Undefined>(S->body())) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000450 replaceBody<SharedSymbol<ELFT>>(S, F, Name, Sym, Verdef);
Peter Collingbourneca8c9942016-06-09 18:01:35 +0000451 if (!S->isWeak())
452 F->IsUsed = true;
453 }
Peter Collingbourne4f952702016-05-01 04:55:03 +0000454}
455
456template <class ELFT>
Rafael Espindolacceb92a2016-08-30 20:53:26 +0000457Symbol *SymbolTable<ELFT>::addBitcode(StringRef Name, uint8_t Binding,
Peter Collingbourne4f952702016-05-01 04:55:03 +0000458 uint8_t StOther, uint8_t Type,
Davide Italiano35af5b32016-08-30 20:15:03 +0000459 bool CanOmitFromDynSym,
460 bool HasUnnamedAddr, BitcodeFile *F) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000461 Symbol *S;
462 bool WasInserted;
Davide Italiano35af5b32016-08-30 20:15:03 +0000463 std::tie(S, WasInserted) =
Rafael Espindola05098762016-08-31 13:49:23 +0000464 insert(Name, Type, StOther & 3, CanOmitFromDynSym, HasUnnamedAddr, F);
Rafael Espindolae7553e42016-08-31 13:28:33 +0000465 int Cmp = compareDefinedNonCommon(S, WasInserted, Binding);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000466 if (Cmp > 0)
Rafael Espindolaa6c97442016-08-31 12:30:34 +0000467 replaceBody<DefinedRegular<ELFT>>(S, Name, StOther, Type, F);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000468 else if (Cmp == 0)
469 reportDuplicate(S->body(), F);
470 return S;
Michael J. Spencer1b348a62015-09-04 22:28:10 +0000471}
Michael J. Spencer84487f12015-07-24 21:03:07 +0000472
Rui Ueyamaf8432d92015-10-13 16:34:14 +0000473template <class ELFT> SymbolBody *SymbolTable<ELFT>::find(StringRef Name) {
474 auto It = Symtab.find(Name);
475 if (It == Symtab.end())
476 return nullptr;
Rui Ueyamae3357902016-07-18 01:35:00 +0000477 SymIndex V = It->second;
478 if (V.Idx == -1)
479 return nullptr;
480 return SymVector[V.Idx]->body();
Michael J. Spencer1b348a62015-09-04 22:28:10 +0000481}
482
George Rimarc91930a2016-09-02 21:17:20 +0000483// Returns a list of defined symbols that match with a given regex.
Rui Ueyama3d451792015-10-12 18:03:21 +0000484template <class ELFT>
George Rimarc91930a2016-09-02 21:17:20 +0000485std::vector<SymbolBody *> SymbolTable<ELFT>::findAll(const Regex &Re) {
Rui Ueyama48e42512016-06-29 04:47:39 +0000486 std::vector<SymbolBody *> Res;
Rui Ueyamad6328522016-07-18 01:34:57 +0000487 for (Symbol *Sym : SymVector) {
488 SymbolBody *B = Sym->body();
George Rimarc91930a2016-09-02 21:17:20 +0000489 StringRef Name = B->getName();
490 if (!B->isUndefined() && const_cast<Regex &>(Re).match(Name))
Rui Ueyama48e42512016-06-29 04:47:39 +0000491 Res.push_back(B);
492 }
493 return Res;
Davide Italiano8e1131d2016-06-29 02:46:51 +0000494}
495
496template <class ELFT>
Rui Ueyama818bb2f2016-07-16 18:55:47 +0000497void SymbolTable<ELFT>::addLazyArchive(ArchiveFile *F,
498 const object::Archive::Symbol Sym) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000499 Symbol *S;
500 bool WasInserted;
Rui Ueyamadace8382016-07-21 13:13:21 +0000501 StringRef Name = Sym.getName();
502 std::tie(S, WasInserted) = insert(Name);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000503 if (WasInserted) {
Rafael Espindola07543a82016-06-14 21:40:23 +0000504 replaceBody<LazyArchive>(S, *F, Sym, SymbolBody::UnknownType);
Rui Ueyamac5b95122015-12-16 23:23:14 +0000505 return;
506 }
Peter Collingbourne4f952702016-05-01 04:55:03 +0000507 if (!S->body()->isUndefined())
508 return;
Rui Ueyamac5b95122015-12-16 23:23:14 +0000509
Peter Collingbourne4f952702016-05-01 04:55:03 +0000510 // Weak undefined symbols should not fetch members from archives. If we were
511 // to keep old symbol we would not know that an archive member was available
512 // if a strong undefined symbol shows up afterwards in the link. If a strong
513 // undefined symbol never shows up, this lazy symbol will get to the end of
514 // the link and must be treated as the weak undefined one. We already marked
515 // this symbol as used when we added it to the symbol table, but we also need
516 // to preserve its type. FIXME: Move the Type field to Symbol.
517 if (S->isWeak()) {
Rafael Espindola07543a82016-06-14 21:40:23 +0000518 replaceBody<LazyArchive>(S, *F, Sym, S->body()->Type);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000519 return;
520 }
521 MemoryBufferRef MBRef = F->getMember(&Sym);
522 if (!MBRef.getBuffer().empty())
523 addFile(createObjectFile(MBRef, F->getName()));
524}
525
526template <class ELFT>
Rafael Espindola65c65ce2016-06-14 21:56:36 +0000527void SymbolTable<ELFT>::addLazyObject(StringRef Name, LazyObjectFile &Obj) {
Peter Collingbourne4f952702016-05-01 04:55:03 +0000528 Symbol *S;
529 bool WasInserted;
530 std::tie(S, WasInserted) = insert(Name);
531 if (WasInserted) {
Rafael Espindola65c65ce2016-06-14 21:56:36 +0000532 replaceBody<LazyObject>(S, Name, Obj, SymbolBody::UnknownType);
Peter Collingbourne4f952702016-05-01 04:55:03 +0000533 return;
534 }
535 if (!S->body()->isUndefined())
536 return;
537
538 // See comment for addLazyArchive above.
Rafael Espindola65c65ce2016-06-14 21:56:36 +0000539 if (S->isWeak()) {
540 replaceBody<LazyObject>(S, Name, Obj, S->body()->Type);
541 } else {
542 MemoryBufferRef MBRef = Obj.getBuffer();
543 if (!MBRef.getBuffer().empty())
544 addFile(createObjectFile(MBRef));
545 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000546}
Rafael Espindola0e604f92015-09-25 18:56:53 +0000547
Peter Collingbourne892d49802016-04-27 00:05:03 +0000548// Process undefined (-u) flags by loading lazy symbols named by those flags.
Peter Collingbourne4f952702016-05-01 04:55:03 +0000549template <class ELFT> void SymbolTable<ELFT>::scanUndefinedFlags() {
Peter Collingbourne892d49802016-04-27 00:05:03 +0000550 for (StringRef S : Config->Undefined)
Peter Collingbourne4f952702016-05-01 04:55:03 +0000551 if (auto *L = dyn_cast_or_null<Lazy>(find(S)))
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000552 if (InputFile *File = L->fetch())
553 addFile(File);
Peter Collingbourne892d49802016-04-27 00:05:03 +0000554}
555
Rui Ueyama93bfee52015-10-13 18:10:33 +0000556// This function takes care of the case in which shared libraries depend on
557// the user program (not the other way, which is usual). Shared libraries
558// may have undefined symbols, expecting that the user program provides
559// the definitions for them. An example is BSD's __progname symbol.
560// We need to put such symbols to the main program's .dynsym so that
561// shared libraries can find them.
562// Except this, we ignore undefined symbols in DSOs.
563template <class ELFT> void SymbolTable<ELFT>::scanShlibUndefined() {
Rui Ueyama38dbd3e2016-09-14 00:05:51 +0000564 for (SharedFile<ELFT> *File : SharedFiles)
Rui Ueyamaf8432d92015-10-13 16:34:14 +0000565 for (StringRef U : File->getUndefinedSymbols())
566 if (SymbolBody *Sym = find(U))
567 if (Sym->isDefined())
Peter Collingbourne4f952702016-05-01 04:55:03 +0000568 Sym->symbol()->ExportDynamic = true;
Rui Ueyamaf8432d92015-10-13 16:34:14 +0000569}
570
Rui Ueyamadad2b882016-09-02 22:15:08 +0000571// This function processes --export-dynamic-symbol and --dynamic-list.
Adhemerval Zanella9df07202016-04-13 18:51:11 +0000572template <class ELFT> void SymbolTable<ELFT>::scanDynamicList() {
573 for (StringRef S : Config->DynamicList)
574 if (SymbolBody *B = find(S))
Peter Collingbourne4f952702016-05-01 04:55:03 +0000575 B->symbol()->ExportDynamic = true;
Adhemerval Zanella9df07202016-04-13 18:51:11 +0000576}
577
George Rimar50dcece2016-07-16 12:26:39 +0000578static void setVersionId(SymbolBody *Body, StringRef VersionName,
579 StringRef Name, uint16_t Version) {
580 if (!Body || Body->isUndefined()) {
581 if (Config->NoUndefinedVersion)
582 error("version script assignment of " + VersionName + " to symbol " +
583 Name + " failed: symbol not defined");
584 return;
585 }
586
587 Symbol *Sym = Body->symbol();
Rui Ueyama962b2772016-07-16 18:45:25 +0000588 if (Sym->VersionId != Config->DefaultSymbolVersion)
George Rimar50dcece2016-07-16 12:26:39 +0000589 warning("duplicate symbol " + Name + " in version script");
590 Sym->VersionId = Version;
591}
592
Rui Ueyamafbde7102016-09-13 20:41:06 +0000593// Returns a map from demangled symbols to symbol objects.
594// The relationship is 1:N instead of 1:1 because with the symbol
595// versioning, more than one symbol may have the same name.
George Rimar50dcece2016-07-16 12:26:39 +0000596template <class ELFT>
George Rimar31c25ae2016-09-15 12:44:38 +0000597std::map<std::string, std::vector<SymbolBody *>>
598SymbolTable<ELFT>::getDemangledSyms() {
599 std::map<std::string, std::vector<SymbolBody *>> Result;
Rui Ueyamad6328522016-07-18 01:34:57 +0000600 for (Symbol *Sym : SymVector) {
601 SymbolBody *B = Sym->body();
George Rimar31c25ae2016-09-15 12:44:38 +0000602 Result[demangle(B->getName())].push_back(B);
Rui Ueyamad6328522016-07-18 01:34:57 +0000603 }
George Rimar50dcece2016-07-16 12:26:39 +0000604 return Result;
605}
606
607static bool hasExternCpp() {
608 for (VersionDefinition &V : Config->VersionDefinitions)
609 for (SymbolVersion Sym : V.Globals)
610 if (Sym.IsExternCpp)
611 return true;
612 return false;
613}
614
George Rimar31c25ae2016-09-15 12:44:38 +0000615static ArrayRef<SymbolBody *>
616findDemangled(std::map<std::string, std::vector<SymbolBody *>> &D,
617 StringRef Name) {
George Rimarc3ec9d02016-08-30 09:29:37 +0000618 auto I = D.find(Name);
619 if (I != D.end())
620 return I->second;
George Rimar31c25ae2016-09-15 12:44:38 +0000621 return {};
George Rimarc3ec9d02016-08-30 09:29:37 +0000622}
623
George Rimar397cd87a2016-08-30 09:35:03 +0000624static std::vector<SymbolBody *>
George Rimar31c25ae2016-09-15 12:44:38 +0000625findAllDemangled(const std::map<std::string, std::vector<SymbolBody *>> &D,
George Rimarc91930a2016-09-02 21:17:20 +0000626 const Regex &Re) {
George Rimar397cd87a2016-08-30 09:35:03 +0000627 std::vector<SymbolBody *> Res;
628 for (auto &P : D) {
George Rimar31c25ae2016-09-15 12:44:38 +0000629 if (const_cast<Regex &>(Re).match(P.first))
630 for (SymbolBody *Body : P.second)
631 if (!Body->isUndefined())
632 Res.push_back(Body);
George Rimar397cd87a2016-08-30 09:35:03 +0000633 }
634 return Res;
635}
636
Rui Ueyamaea265042016-09-13 20:51:30 +0000637// If there's only one anonymous version definition in a version
638// script file, the script does not actullay define any symbol version,
639// but just specifies symbols visibilities. We assume that the script was
640// in the form of { global: foo; bar; local *; }. So, local is default.
641// In this function, we make specified symbols global.
642template <class ELFT> void SymbolTable<ELFT>::handleAnonymousVersion() {
643 std::vector<StringRef> Patterns;
644 for (SymbolVersion &Sym : Config->VersionScriptGlobals) {
645 if (hasWildcard(Sym.Name)) {
646 Patterns.push_back(Sym.Name);
647 continue;
648 }
649 if (SymbolBody *B = find(Sym.Name))
650 B->symbol()->VersionId = VER_NDX_GLOBAL;
651 }
652 if (Patterns.empty())
653 return;
654 Regex Re = compileGlobPatterns(Patterns);
655 std::vector<SymbolBody *> Syms = findAll(Re);
656 for (SymbolBody *B : Syms)
657 B->symbol()->VersionId = VER_NDX_GLOBAL;
658}
659
Rui Ueyamadad2b882016-09-02 22:15:08 +0000660// This function processes version scripts by updating VersionId
661// member of symbols.
Peter Collingbourne66ac1d62016-04-22 20:21:26 +0000662template <class ELFT> void SymbolTable<ELFT>::scanVersionScript() {
Rui Ueyamaea265042016-09-13 20:51:30 +0000663 // Handle edge cases first.
George Rimard3566302016-06-20 11:55:12 +0000664 if (!Config->VersionScriptGlobals.empty()) {
Rui Ueyamaea265042016-09-13 20:51:30 +0000665 handleAnonymousVersion();
George Rimard3566302016-06-20 11:55:12 +0000666 return;
667 }
668
Rui Ueyamaaf469d42016-07-16 04:09:27 +0000669 if (Config->VersionDefinitions.empty())
George Rimarf73a2582016-07-07 07:45:27 +0000670 return;
671
Rui Ueyamadad2b882016-09-02 22:15:08 +0000672 // Now we have version definitions, so we need to set version ids to symbols.
673 // Each version definition has a glob pattern, and all symbols that match
674 // with the pattern get that version.
675
676 // Users can use "extern C++ {}" directive to match against demangled
677 // C++ symbols. For example, you can write a pattern such as
678 // "llvm::*::foo(int, ?)". Obviously, there's no way to handle this
679 // other than trying to match a regexp against all demangled symbols.
680 // So, if "extern C++" feature is used, we demangle all known symbols.
George Rimar31c25ae2016-09-15 12:44:38 +0000681 std::map<std::string, std::vector<SymbolBody *>> Demangled;
George Rimar50dcece2016-07-16 12:26:39 +0000682 if (hasExternCpp())
683 Demangled = getDemangledSyms();
George Rimardd64bb32016-07-13 08:19:04 +0000684
Rui Ueyamadad2b882016-09-02 22:15:08 +0000685 // First, we assign versions to exact matching symbols,
686 // i.e. version definitions not containing any glob meta-characters.
George Rimar50dcece2016-07-16 12:26:39 +0000687 for (VersionDefinition &V : Config->VersionDefinitions) {
688 for (SymbolVersion Sym : V.Globals) {
George Rimarcd574a52016-09-09 14:35:36 +0000689 if (Sym.HasWildcards)
George Rimardd64bb32016-07-13 08:19:04 +0000690 continue;
George Rimar31c25ae2016-09-15 12:44:38 +0000691
George Rimarc3ec9d02016-08-30 09:29:37 +0000692 StringRef N = Sym.Name;
George Rimar31c25ae2016-09-15 12:44:38 +0000693 if (Sym.IsExternCpp) {
694 for (SymbolBody *B : findDemangled(Demangled, N))
695 setVersionId(B, V.Name, N, V.Id);
696 continue;
697 }
698 setVersionId(find(N), V.Name, N, V.Id);
George Rimar36b2c0a2016-06-28 08:07:26 +0000699 }
George Rimarf73a2582016-07-07 07:45:27 +0000700 }
701
Rui Ueyamadad2b882016-09-02 22:15:08 +0000702 // Next, we assign versions to fuzzy matching symbols,
703 // i.e. version definitions containing glob meta-characters.
704 // Note that because the last match takes precedence over previous matches,
705 // we iterate over the definitions in the reverse order.
Rui Ueyamaaf469d42016-07-16 04:09:27 +0000706 for (size_t I = Config->VersionDefinitions.size() - 1; I != (size_t)-1; --I) {
707 VersionDefinition &V = Config->VersionDefinitions[I];
George Rimar7af64522016-08-30 09:39:36 +0000708 for (SymbolVersion &Sym : V.Globals) {
George Rimarcd574a52016-09-09 14:35:36 +0000709 if (!Sym.HasWildcards)
George Rimar7af64522016-08-30 09:39:36 +0000710 continue;
Rui Ueyamadad2b882016-09-02 22:15:08 +0000711 Regex Re = compileGlobPatterns({Sym.Name});
712 std::vector<SymbolBody *> Syms =
713 Sym.IsExternCpp ? findAllDemangled(Demangled, Re) : findAll(Re);
George Rimar397cd87a2016-08-30 09:35:03 +0000714
Rui Ueyamadad2b882016-09-02 22:15:08 +0000715 // Exact matching takes precendence over fuzzy matching,
716 // so we set a version to a symbol only if no version has been assigned
717 // to the symbol. This behavior is compatible with GNU.
718 for (SymbolBody *B : Syms)
George Rimar7af64522016-08-30 09:39:36 +0000719 if (B->symbol()->VersionId == Config->DefaultSymbolVersion)
720 B->symbol()->VersionId = V.Id;
721 }
George Rimard3566302016-06-20 11:55:12 +0000722 }
Peter Collingbourne66ac1d62016-04-22 20:21:26 +0000723}
724
Rafael Espindolae0df00b2016-02-28 00:25:54 +0000725template class elf::SymbolTable<ELF32LE>;
726template class elf::SymbolTable<ELF32BE>;
727template class elf::SymbolTable<ELF64LE>;
728template class elf::SymbolTable<ELF64BE>;