blob: 496be33dd182c06ec856941c128be683ca0c0443 [file] [log] [blame]
Michael J. Spencer84487f12015-07-24 21:03:071//===- Symbols.cpp --------------------------------------------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:563// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Michael J. Spencer84487f12015-07-24 21:03:076//
7//===----------------------------------------------------------------------===//
8
9#include "Symbols.h"
Michael J. Spencercdae0a42015-07-28 22:58:2510#include "InputFiles.h"
Rui Ueyamab5a69702016-02-01 21:00:3511#include "InputSection.h"
12#include "OutputSections.h"
Rui Ueyamae8a61022016-11-05 23:05:4713#include "SyntheticSections.h"
Rui Ueyamab5a69702016-02-01 21:00:3514#include "Target.h"
Rafael Espindola17cb7c02016-12-19 17:01:0115#include "Writer.h"
Bob Haarmanb8a59c82017-10-25 22:28:3816#include "lld/Common/ErrorHandler.h"
Rui Ueyama53fe4692017-11-28 02:15:2617#include "lld/Common/Strings.h"
Michael J. Spencer1b348a62015-09-04 22:28:1018#include "llvm/ADT/STLExtras.h"
Fangrui Song23257882020-04-05 04:31:3619#include "llvm/Support/FileSystem.h"
Eugene Leviantc958d8d2016-10-12 08:19:3020#include "llvm/Support/Path.h"
Rui Ueyamac72ba3a2016-11-23 04:57:2521#include <cstring>
Michael J. Spencer1b348a62015-09-04 22:28:1022
23using namespace llvm;
Michael J. Spencer84487f12015-07-24 21:03:0724using namespace llvm::object;
Rafael Espindola78471f02015-09-01 23:12:5225using namespace llvm::ELF;
Fangrui Song07837b82020-05-15 05:18:5826using namespace lld;
27using namespace lld::elf;
Michael J. Spencer84487f12015-07-24 21:03:0728
Fangrui Songbd8cfe62019-10-07 08:31:1829// Returns a symbol for an error message.
30static std::string demangle(StringRef symName) {
31 if (elf::config->demangle)
32 return demangleItanium(symName);
Benjamin Krameradcd0262020-01-28 19:23:4633 return std::string(symName);
Fangrui Songbd8cfe62019-10-07 08:31:1834}
Michael J. Spencer84487f12015-07-24 21:03:0735
Fangrui Song07837b82020-05-15 05:18:5836std::string lld::toString(const elf::Symbol &sym) {
Fangrui Songf2036a12020-03-28 22:48:3837 StringRef name = sym.getName();
38 std::string ret = demangle(name);
39
Fangrui Song941e9332020-12-01 16:54:0140 const char *suffix = sym.getVersionSuffix();
41 if (*suffix == '@')
42 ret += suffix;
Fangrui Songf2036a12020-03-28 22:48:3843 return ret;
44}
45
Fangrui Song07837b82020-05-15 05:18:5846std::string lld::toELFString(const Archive::Symbol &b) {
Fangrui Songbd8cfe62019-10-07 08:31:1847 return demangle(b.getName());
48}
49
Rui Ueyama3837f422019-07-10 05:00:3750Defined *ElfSym::bss;
51Defined *ElfSym::etext1;
52Defined *ElfSym::etext2;
53Defined *ElfSym::edata1;
54Defined *ElfSym::edata2;
55Defined *ElfSym::end1;
56Defined *ElfSym::end2;
57Defined *ElfSym::globalOffsetTable;
58Defined *ElfSym::mipsGp;
59Defined *ElfSym::mipsGpDisp;
60Defined *ElfSym::mipsLocalGp;
61Defined *ElfSym::relaIpltStart;
62Defined *ElfSym::relaIpltEnd;
63Defined *ElfSym::riscvGlobalPointer;
64Defined *ElfSym::tlsModuleBase;
Fangrui Songce3c5da2020-10-22 22:26:5265DenseMap<const Symbol *, std::pair<const InputFile *, const InputFile *>>
66 elf::backwardReferences;
Rui Ueyama80474a22017-02-28 19:29:5567
Rui Ueyama3837f422019-07-10 05:00:3768static uint64_t getSymVA(const Symbol &sym, int64_t &addend) {
69 switch (sym.kind()) {
Peter Collingbournee9a9e0a2017-11-06 04:35:3170 case Symbol::DefinedKind: {
Rui Ueyama3837f422019-07-10 05:00:3771 auto &d = cast<Defined>(sym);
72 SectionBase *isec = d.section;
Rui Ueyamab5a69702016-02-01 21:00:3573
74 // This is an absolute symbol.
Rui Ueyama3837f422019-07-10 05:00:3775 if (!isec)
76 return d.value;
Rui Ueyamab5a69702016-02-01 21:00:3577
Rui Ueyama3837f422019-07-10 05:00:3778 assert(isec != &InputSection::discarded);
79 isec = isec->repl;
Rafael Espindolaf4d6e8c2018-04-19 17:26:5080
Rui Ueyama3837f422019-07-10 05:00:3781 uint64_t offset = d.value;
Sean Silvaa9ba4502017-02-28 08:32:5682
83 // An object in an SHF_MERGE section might be referenced via a
84 // section symbol (as a hack for reducing the number of local
85 // symbols).
Sean Silvad4e60622017-03-01 04:44:0486 // Depending on the addend, the reference via a section symbol
87 // refers to a different object in the merge section.
88 // Since the objects in the merge section are not necessarily
89 // contiguous in the output, the addend can thus affect the final
90 // VA in a non-linear way.
91 // To make this work, we incorporate the addend into the section
92 // offset (and zero out the addend for later processing) so that
93 // we find the right object in the section.
Rui Ueyama3837f422019-07-10 05:00:3794 if (d.isSection()) {
95 offset += addend;
96 addend = 0;
Rafael Espindola1f5b70f2016-03-11 14:21:3797 }
Sean Silvaa9ba4502017-02-28 08:32:5698
Sean Silva6ab39262017-02-28 09:01:5899 // In the typical case, this is actually very simple and boils
100 // down to adding together 3 numbers:
101 // 1. The address of the output section.
102 // 2. The offset of the input section within the output section.
103 // 3. The offset within the input section (this addition happens
104 // inside InputSection::getOffset).
105 //
106 // If you understand the data structures involved with this next
107 // line (and how they get built), then you have a pretty good
108 // understanding of the linker.
Rui Ueyama3837f422019-07-10 05:00:37109 uint64_t va = isec->getVA(offset);
Sean Silva6ab39262017-02-28 09:01:58110
Simon Atanasyanfae2a5092019-02-19 10:36:58111 // MIPS relocatable files can mix regular and microMIPS code.
112 // Linker needs to distinguish such code. To do so microMIPS
113 // symbols has the `STO_MIPS_MICROMIPS` flag in the `st_other`
Fangrui Songdeb58192020-01-23 05:39:16114 // field. Unfortunately, the `MIPS::relocate()` method has
Simon Atanasyanfae2a5092019-02-19 10:36:58115 // a symbol value only. To pass type of the symbol (regular/microMIPS)
116 // to that routine as well as other places where we write
117 // a symbol value as-is (.dynamic section, `Elf_Ehdr::e_entry`
118 // field etc) do the same trick as compiler uses to mark microMIPS
119 // for CPU - set the less-significant bit.
Rui Ueyama3837f422019-07-10 05:00:37120 if (config->emachine == EM_MIPS && isMicroMips() &&
121 ((sym.stOther & STO_MIPS_MICROMIPS) || sym.needsPltAddr))
122 va |= 1;
Simon Atanasyanfae2a5092019-02-19 10:36:58123
Rui Ueyama3837f422019-07-10 05:00:37124 if (d.isTls() && !config->relocatable) {
Ryan Prichard1c33d142018-09-18 00:24:48125 // Use the address of the TLS segment's first section rather than the
126 // segment's address, because segment addresses aren't initialized until
127 // after sections are finalized. (e.g. Measuring the size of .rela.dyn
128 // for Android relocation packing requires knowing TLS symbol addresses
129 // during section finalization.)
Rui Ueyama3837f422019-07-10 05:00:37130 if (!Out::tlsPhdr || !Out::tlsPhdr->firstSec)
131 fatal(toString(d.file) +
Peter Collingbourne3e2abde2017-07-14 00:22:46132 " has an STT_TLS symbol but doesn't have an SHF_TLS section");
Rui Ueyama3837f422019-07-10 05:00:37133 return va - Out::tlsPhdr->firstSec->addr;
George Rimar6a3b1542016-10-04 08:52:51134 }
Rui Ueyama3837f422019-07-10 05:00:37135 return va;
Rui Ueyamab5a69702016-02-01 21:00:35136 }
Rafael Espindolaab0cce52018-04-26 17:58:58137 case Symbol::SharedKind:
Rui Ueyamaf52496e2017-11-03 21:21:47138 case Symbol::UndefinedKind:
Rui Ueyamab5a69702016-02-01 21:00:35139 return 0;
Rui Ueyamaf52496e2017-11-03 21:21:47140 case Symbol::LazyArchiveKind:
141 case Symbol::LazyObjectKind:
Rui Ueyama3837f422019-07-10 05:00:37142 assert(sym.isUsedInRegularObj && "lazy symbol reached writer");
Chih-Hung Hsieh73e04842018-09-11 23:00:36143 return 0;
Rui Ueyama5c073a92019-05-16 03:29:03144 case Symbol::CommonKind:
145 llvm_unreachable("common symbol reached writer");
Rui Ueyamaf3fad552018-10-12 18:29:18146 case Symbol::PlaceholderKind:
147 llvm_unreachable("placeholder symbol reached writer");
Rui Ueyamab5a69702016-02-01 21:00:35148 }
George Rimar777f9632016-03-12 08:31:34149 llvm_unreachable("invalid symbol kind");
Rui Ueyamab5a69702016-02-01 21:00:35150}
151
Rui Ueyama3837f422019-07-10 05:00:37152uint64_t Symbol::getVA(int64_t addend) const {
153 uint64_t outVA = getSymVA(*this, addend);
154 return outVA + addend;
Rafael Espindola87d9f102016-03-11 12:19:05155}
156
Peter Collingbourne8331f612019-02-13 21:49:55157uint64_t Symbol::getGotVA() const {
Rui Ueyama3837f422019-07-10 05:00:37158 if (gotInIgot)
159 return in.igotPlt->getVA() + getGotPltOffset();
160 return in.got->getVA() + getGotOffset();
Peter Collingbourne8331f612019-02-13 21:49:55161}
Rafael Espindola74031ba2016-04-07 15:20:56162
Harald van Dijkd6241342021-05-16 23:13:00163uint64_t Symbol::getGotOffset() const {
164 return gotIndex * target->gotEntrySize;
165}
Rui Ueyamab5a69702016-02-01 21:00:35166
Rui Ueyamaf52496e2017-11-03 21:21:47167uint64_t Symbol::getGotPltVA() const {
Rui Ueyama3837f422019-07-10 05:00:37168 if (isInIplt)
169 return in.igotPlt->getVA() + getGotPltOffset();
170 return in.gotPlt->getVA() + getGotPltOffset();
Rafael Espindola74031ba2016-04-07 15:20:56171}
172
Rui Ueyamaf52496e2017-11-03 21:21:47173uint64_t Symbol::getGotPltOffset() const {
Rui Ueyama3837f422019-07-10 05:00:37174 if (isInIplt)
Harald van Dijkd6241342021-05-16 23:13:00175 return pltIndex * target->gotEntrySize;
176 return (pltIndex + target->gotPltHeaderEntriesNum) * target->gotEntrySize;
Rui Ueyamab5a69702016-02-01 21:00:35177}
178
Rui Ueyamaf52496e2017-11-03 21:21:47179uint64_t Symbol::getPltVA() const {
Fangrui Song891a8652019-12-14 22:17:35180 uint64_t outVA = isInIplt
181 ? in.iplt->getVA() + pltIndex * target->ipltEntrySize
182 : in.plt->getVA() + in.plt->headerSize +
183 pltIndex * target->pltEntrySize;
184
Simon Atanasyanfae2a5092019-02-19 10:36:58185 // While linking microMIPS code PLT code are always microMIPS
186 // code. Set the less-significant bit to track that fact.
187 // See detailed comment in the `getSymVA` function.
Rui Ueyama3837f422019-07-10 05:00:37188 if (config->emachine == EM_MIPS && isMicroMips())
189 outVA |= 1;
190 return outVA;
Rafael Espindolaab0cce52018-04-26 17:58:58191}
192
Rui Ueyamaf52496e2017-11-03 21:21:47193uint64_t Symbol::getSize() const {
Rui Ueyama3837f422019-07-10 05:00:37194 if (const auto *dr = dyn_cast<Defined>(this))
195 return dr->size;
196 return cast<SharedSymbol>(this)->size;
Rui Ueyama512c61d2016-02-03 00:12:24197}
198
Rui Ueyamaf52496e2017-11-03 21:21:47199OutputSection *Symbol::getOutputSection() const {
Rui Ueyama3837f422019-07-10 05:00:37200 if (auto *s = dyn_cast<Defined>(this)) {
201 if (auto *sec = s->section)
202 return sec->repl->getOutputSection();
Rui Ueyama968db482017-02-28 04:02:42203 return nullptr;
204 }
Rui Ueyama968db482017-02-28 04:02:42205 return nullptr;
206}
207
Rui Ueyama35fa6c52016-11-23 05:48:40208// If a symbol name contains '@', the characters after that is
209// a symbol version name. This function parses that.
Rui Ueyamaf52496e2017-11-03 21:21:47210void Symbol::parseSymbolVersion() {
Rui Ueyama3837f422019-07-10 05:00:37211 StringRef s = getName();
212 size_t pos = s.find('@');
213 if (pos == 0 || pos == StringRef::npos)
Rui Ueyama35fa6c52016-11-23 05:48:40214 return;
Rui Ueyama3837f422019-07-10 05:00:37215 StringRef verstr = s.substr(pos + 1);
216 if (verstr.empty())
Rui Ueyama35fa6c52016-11-23 05:48:40217 return;
218
219 // Truncate the symbol name so that it doesn't include the version string.
Rui Ueyama3837f422019-07-10 05:00:37220 nameSize = pos;
Rui Ueyama35fa6c52016-11-23 05:48:40221
Rafael Espindola1d6d1b42017-01-17 16:08:06222 // If this is not in this DSO, it is not a definition.
Peter Collingbourneb472aa02017-11-06 04:39:07223 if (!isDefined())
Rafael Espindola2756e042017-01-06 22:30:35224 return;
225
Rui Ueyama35fa6c52016-11-23 05:48:40226 // '@@' in a symbol name means the default version.
227 // It is usually the most recent one.
Rui Ueyama3837f422019-07-10 05:00:37228 bool isDefault = (verstr[0] == '@');
229 if (isDefault)
230 verstr = verstr.substr(1);
Rui Ueyama35fa6c52016-11-23 05:48:40231
Fangrui Songe28a70d2019-08-05 14:31:39232 for (const VersionDefinition &ver : namedVersionDefs()) {
Rui Ueyama3837f422019-07-10 05:00:37233 if (ver.name != verstr)
Rui Ueyama35fa6c52016-11-23 05:48:40234 continue;
235
Rui Ueyama3837f422019-07-10 05:00:37236 if (isDefault)
237 versionId = ver.id;
Rui Ueyama35fa6c52016-11-23 05:48:40238 else
Rui Ueyama3837f422019-07-10 05:00:37239 versionId = ver.id | VERSYM_HIDDEN;
Rui Ueyama35fa6c52016-11-23 05:48:40240 return;
241 }
242
243 // It is an error if the specified version is not defined.
George Rimar4d2f97622017-07-04 13:19:13244 // Usually version script is not provided when linking executable,
245 // but we may still want to override a versioned symbol from DSO,
Peter Smith796fb992018-05-14 10:13:56246 // so we do not report error in this case. We also do not error
247 // if the symbol has a local version as it won't be in the dynamic
248 // symbol table.
Rui Ueyama3837f422019-07-10 05:00:37249 if (config->shared && versionId != VER_NDX_LOCAL)
250 error(toString(file) + ": symbol " + s + " has undefined version " +
251 verstr);
Rui Ueyama35fa6c52016-11-23 05:48:40252}
253
Rui Ueyama7f7d2b22019-05-23 09:58:08254void Symbol::fetch() const {
Rui Ueyama3837f422019-07-10 05:00:37255 if (auto *sym = dyn_cast<LazyArchive>(this)) {
256 cast<ArchiveFile>(sym->file)->fetch(sym->sym);
Rui Ueyama7f7d2b22019-05-23 09:58:08257 return;
258 }
259
Rui Ueyama3837f422019-07-10 05:00:37260 if (auto *sym = dyn_cast<LazyObject>(this)) {
261 dyn_cast<LazyObjFile>(sym->file)->fetch();
Rui Ueyama7f7d2b22019-05-23 09:58:08262 return;
263 }
264
265 llvm_unreachable("Symbol::fetch() is called on a non-lazy symbol");
Rui Ueyama7d476192019-05-16 02:14:00266}
Rui Ueyamaf8baa662016-04-07 19:24:51267
Peter Collingbourne98930112018-08-08 23:48:12268MemoryBufferRef LazyArchive::getMemberBuffer() {
Nico Weber9c0716f2019-07-23 19:00:01269 Archive::Child c =
270 CHECK(sym.getMember(),
271 "could not get the member for symbol " + toELFString(sym));
Peter Collingbourne98930112018-08-08 23:48:12272
Rui Ueyama3837f422019-07-10 05:00:37273 return CHECK(c.getMemoryBufferRef(),
Peter Collingbourne98930112018-08-08 23:48:12274 "could not get the buffer for the member defining symbol " +
Nico Weber9c0716f2019-07-23 19:00:01275 toELFString(sym));
Peter Collingbourne98930112018-08-08 23:48:12276}
277
Rui Ueyamaf52496e2017-11-03 21:21:47278uint8_t Symbol::computeBinding() const {
Rui Ueyama3837f422019-07-10 05:00:37279 if (config->relocatable)
280 return binding;
Fangrui Songcfdd4582019-08-11 17:03:00281 if ((visibility != STV_DEFAULT && visibility != STV_PROTECTED) ||
Nathan Lanza2f651662021-03-16 08:33:50282 (versionId == VER_NDX_LOCAL && !isLazy()))
Rafael Espindolab7e2ee22017-01-10 17:08:13283 return STB_LOCAL;
Rui Ueyama3837f422019-07-10 05:00:37284 if (!config->gnuUnique && binding == STB_GNU_UNIQUE)
Rafael Espindolab7e2ee22017-01-10 17:08:13285 return STB_GLOBAL;
Rui Ueyama3837f422019-07-10 05:00:37286 return binding;
Rafael Espindolab7e2ee22017-01-10 17:08:13287}
288
Rui Ueyamaf52496e2017-11-03 21:21:47289bool Symbol::includeInDynsym() const {
Rui Ueyama3837f422019-07-10 05:00:37290 if (!config->hasDynSymTab)
Rafael Espindolae05e2f82017-09-15 18:05:02291 return false;
Rafael Espindolab7e2ee22017-01-10 17:08:13292 if (computeBinding() == STB_LOCAL)
Rafael Espindolaae605c12016-04-21 20:35:25293 return false;
Fangrui Song375371c2020-01-09 23:53:52294 if (!isDefined() && !isCommon())
Fangrui Song0fbf28f2020-01-23 19:52:03295 // This should unconditionally return true, unfortunately glibc -static-pie
296 // expects undefined weak symbols not to exist in .dynsym, e.g.
297 // __pthread_mutex_lock reference in _dl_add_to_namespace_list,
298 // __pthread_initialize_minimal reference in csu/libc-start.c.
299 return !(config->noDynamicLinker && isUndefWeak());
Rui Ueyamae63ae7f2019-06-25 06:58:07300
Fangrui Song375371c2020-01-09 23:53:52301 return exportDynamic || inDynamicList;
Rafael Espindolaae605c12016-04-21 20:35:25302}
Rui Ueyama69c778c2016-07-17 17:50:09303
304// Print out a log message for --trace-symbol.
Fangrui Song07837b82020-05-15 05:18:58305void elf::printTraceSymbol(const Symbol *sym) {
Rui Ueyama3837f422019-07-10 05:00:37306 std::string s;
307 if (sym->isUndefined())
308 s = ": reference to ";
309 else if (sym->isLazy())
310 s = ": lazy definition of ";
311 else if (sym->isShared())
312 s = ": shared definition of ";
313 else if (sym->isCommon())
314 s = ": common definition of ";
Rui Ueyama69c778c2016-07-17 17:50:09315 else
Rui Ueyama3837f422019-07-10 05:00:37316 s = ": definition of ";
Rui Ueyamae6e206d2017-02-21 23:22:56317
Rui Ueyama3837f422019-07-10 05:00:37318 message(toString(sym->file) + s + sym->getName());
Rui Ueyama69c778c2016-07-17 17:50:09319}
320
Fangrui Song07837b82020-05-15 05:18:58321void elf::maybeWarnUnorderableSymbol(const Symbol *sym) {
Rui Ueyama3837f422019-07-10 05:00:37322 if (!config->warnSymbolOrdering)
Michael J. Spencerb8427252018-04-17 23:30:05323 return;
Rui Ueyamab774c3c2018-04-26 01:38:29324
Fangrui Song11ca54f2018-10-10 22:48:57325 // If UnresolvedPolicy::Ignore is used, no "undefined symbol" error/warning
326 // is emitted. It makes sense to not warn on undefined symbols.
327 //
328 // Note, ld.bfd --symbol-ordering-file= does not warn on undefined symbols,
329 // but we don't have to be compatible here.
Rui Ueyama3837f422019-07-10 05:00:37330 if (sym->isUndefined() &&
331 config->unresolvedSymbols == UnresolvedPolicy::Ignore)
Fangrui Song11ca54f2018-10-10 22:48:57332 return;
333
Rui Ueyama3837f422019-07-10 05:00:37334 const InputFile *file = sym->file;
335 auto *d = dyn_cast<Defined>(sym);
Rui Ueyamab774c3c2018-04-26 01:38:29336
Rui Ueyama3837f422019-07-10 05:00:37337 auto report = [&](StringRef s) { warn(toString(file) + s + sym->getName()); };
Rui Ueyamab774c3c2018-04-26 01:38:29338
Rui Ueyama3837f422019-07-10 05:00:37339 if (sym->isUndefined())
340 report(": unable to order undefined symbol: ");
341 else if (sym->isShared())
342 report(": unable to order shared symbol: ");
343 else if (d && !d->section)
344 report(": unable to order absolute symbol: ");
345 else if (d && isa<OutputSection>(d->section))
346 report(": unable to order synthetic symbol: ");
347 else if (d && !d->section->repl->isLive())
348 report(": unable to order discarded symbol: ");
Michael J. Spencerb8427252018-04-17 23:30:05349}
350
Fangrui Songcd0ab242019-11-30 05:58:36351// Returns true if a symbol can be replaced at load-time by a symbol
352// with the same name defined in other ELF executable or DSO.
Fangrui Song07837b82020-05-15 05:18:58353bool elf::computeIsPreemptible(const Symbol &sym) {
Fangrui Songcd0ab242019-11-30 05:58:36354 assert(!sym.isLocal());
355
356 // Only symbols with default visibility that appear in dynsym can be
357 // preempted. Symbols with protected visibility cannot be preempted.
358 if (!sym.includeInDynsym() || sym.visibility != STV_DEFAULT)
359 return false;
360
361 // At this point copy relocations have not been created yet, so any
362 // symbol that is not defined locally is preemptible.
363 if (!sym.isDefined())
364 return true;
365
366 if (!config->shared)
367 return false;
368
Fangrui Song751f18e2020-06-01 18:27:53369 // If -Bsymbolic or --dynamic-list is specified, or -Bsymbolic-functions is
370 // specified and the symbol is STT_FUNC, the symbol is preemptible iff it is
Fangrui Songb06426d2021-07-29 21:46:53371 // in the dynamic list. -Bsymbolic-non-weak-functions is a non-weak subset of
372 // -Bsymbolic-functions.
373 if (config->symbolic ||
374 (config->bsymbolic == BsymbolicKind::Functions && sym.isFunc()) ||
375 (config->bsymbolic == BsymbolicKind::NonWeakFunctions && sym.isFunc() &&
376 sym.binding != STB_WEAK))
Fangrui Songcd0ab242019-11-30 05:58:36377 return sym.inDynamicList;
Fangrui Songcd0ab242019-11-30 05:58:36378 return true;
379}
380
Fangrui Song07837b82020-05-15 05:18:58381void elf::reportBackrefs() {
Fangrui Song03c825c2020-04-06 05:27:46382 for (auto &it : backwardReferences) {
383 const Symbol &sym = *it.first;
Fangrui Song3ba334222020-11-08 04:17:41384 std::string to = toString(it.second.second);
385 // Some libraries have known problems and can cause noise. Filter them out
386 // with --warn-backrefs-exclude=. to may look like *.o or *.a(*.o).
387 bool exclude = false;
388 for (const llvm::GlobPattern &pat : config->warnBackrefsExclude)
389 if (pat.match(to)) {
390 exclude = true;
391 break;
392 }
393 if (!exclude)
394 warn("backward reference detected: " + sym.getName() + " in " +
395 toString(it.second.first) + " refers to " + to);
Fangrui Song03c825c2020-04-06 05:27:46396 }
397}
398
Rui Ueyama3837f422019-07-10 05:00:37399static uint8_t getMinVisibility(uint8_t va, uint8_t vb) {
400 if (va == STV_DEFAULT)
401 return vb;
402 if (vb == STV_DEFAULT)
403 return va;
404 return std::min(va, vb);
Rui Ueyama7f7d2b22019-05-23 09:58:08405}
406
407// Merge symbol properties.
408//
409// When we have many symbols of the same name, we choose one of them,
410// and that's the result of symbol resolution. However, symbols that
411// were not chosen still affect some symbol properties.
Rui Ueyama3837f422019-07-10 05:00:37412void Symbol::mergeProperties(const Symbol &other) {
413 if (other.exportDynamic)
414 exportDynamic = true;
415 if (other.isUsedInRegularObj)
416 isUsedInRegularObj = true;
Rui Ueyama7f7d2b22019-05-23 09:58:08417
418 // DSO symbols do not affect visibility in the output.
Rui Ueyama3837f422019-07-10 05:00:37419 if (!other.isShared())
420 visibility = getMinVisibility(visibility, other.visibility);
Rui Ueyama7f7d2b22019-05-23 09:58:08421}
422
Rui Ueyama3837f422019-07-10 05:00:37423void Symbol::resolve(const Symbol &other) {
424 mergeProperties(other);
Rui Ueyama7f7d2b22019-05-23 09:58:08425
426 if (isPlaceholder()) {
Rui Ueyama3837f422019-07-10 05:00:37427 replace(other);
Rui Ueyama7f7d2b22019-05-23 09:58:08428 return;
429 }
430
Rui Ueyama3837f422019-07-10 05:00:37431 switch (other.kind()) {
Rui Ueyama7f7d2b22019-05-23 09:58:08432 case Symbol::UndefinedKind:
Rui Ueyama3837f422019-07-10 05:00:37433 resolveUndefined(cast<Undefined>(other));
Rui Ueyama7f7d2b22019-05-23 09:58:08434 break;
435 case Symbol::CommonKind:
Rui Ueyama3837f422019-07-10 05:00:37436 resolveCommon(cast<CommonSymbol>(other));
Rui Ueyama7f7d2b22019-05-23 09:58:08437 break;
438 case Symbol::DefinedKind:
Rui Ueyama3837f422019-07-10 05:00:37439 resolveDefined(cast<Defined>(other));
Rui Ueyama7f7d2b22019-05-23 09:58:08440 break;
441 case Symbol::LazyArchiveKind:
Rui Ueyama3837f422019-07-10 05:00:37442 resolveLazy(cast<LazyArchive>(other));
Rui Ueyama7f7d2b22019-05-23 09:58:08443 break;
444 case Symbol::LazyObjectKind:
Rui Ueyama3837f422019-07-10 05:00:37445 resolveLazy(cast<LazyObject>(other));
Rui Ueyama7f7d2b22019-05-23 09:58:08446 break;
447 case Symbol::SharedKind:
Rui Ueyama3837f422019-07-10 05:00:37448 resolveShared(cast<SharedSymbol>(other));
Rui Ueyama7f7d2b22019-05-23 09:58:08449 break;
450 case Symbol::PlaceholderKind:
451 llvm_unreachable("bad symbol kind");
452 }
453}
454
Rui Ueyama3837f422019-07-10 05:00:37455void Symbol::resolveUndefined(const Undefined &other) {
Rui Ueyama7f7d2b22019-05-23 09:58:08456 // An undefined symbol with non default visibility must be satisfied
457 // in the same DSO.
458 //
459 // If this is a non-weak defined symbol in a discarded section, override the
460 // existing undefined symbol for better error message later.
Rui Ueyama3837f422019-07-10 05:00:37461 if ((isShared() && other.visibility != STV_DEFAULT) ||
462 (isUndefined() && other.binding != STB_WEAK && other.discardedSecIdx)) {
463 replace(other);
Rui Ueyama7f7d2b22019-05-23 09:58:08464 return;
465 }
466
Rui Ueyama3837f422019-07-10 05:00:37467 if (traced)
468 printTraceSymbol(&other);
Sam Clegg7991b682019-05-24 13:29:17469
Fangrui Songf3475412019-07-04 10:38:04470 if (isLazy()) {
Rui Ueyama7f7d2b22019-05-23 09:58:08471 // An undefined weak will not fetch archive members. See comment on Lazy in
472 // Symbols.h for the details.
Rui Ueyama3837f422019-07-10 05:00:37473 if (other.binding == STB_WEAK) {
474 binding = STB_WEAK;
475 type = other.type;
Rui Ueyama7f7d2b22019-05-23 09:58:08476 return;
477 }
478
479 // Do extra check for --warn-backrefs.
480 //
481 // --warn-backrefs is an option to prevent an undefined reference from
482 // fetching an archive member written earlier in the command line. It can be
483 // used to keep compatibility with GNU linkers to some degree.
484 // I'll explain the feature and why you may find it useful in this comment.
485 //
486 // lld's symbol resolution semantics is more relaxed than traditional Unix
487 // linkers. For example,
488 //
489 // ld.lld foo.a bar.o
490 //
491 // succeeds even if bar.o contains an undefined symbol that has to be
492 // resolved by some object file in foo.a. Traditional Unix linkers don't
493 // allow this kind of backward reference, as they visit each file only once
494 // from left to right in the command line while resolving all undefined
495 // symbols at the moment of visiting.
496 //
497 // In the above case, since there's no undefined symbol when a linker visits
498 // foo.a, no files are pulled out from foo.a, and because the linker forgets
499 // about foo.a after visiting, it can't resolve undefined symbols in bar.o
500 // that could have been resolved otherwise.
501 //
502 // That lld accepts more relaxed form means that (besides it'd make more
503 // sense) you can accidentally write a command line or a build file that
504 // works only with lld, even if you have a plan to distribute it to wider
505 // users who may be using GNU linkers. With --warn-backrefs, you can detect
506 // a library order that doesn't work with other Unix linkers.
507 //
508 // The option is also useful to detect cyclic dependencies between static
509 // archives. Again, lld accepts
510 //
511 // ld.lld foo.a bar.a
512 //
513 // even if foo.a and bar.a depend on each other. With --warn-backrefs, it is
514 // handled as an error.
515 //
516 // Here is how the option works. We assign a group ID to each file. A file
517 // with a smaller group ID can pull out object files from an archive file
518 // with an equal or greater group ID. Otherwise, it is a reverse dependency
519 // and an error.
520 //
521 // A file outside --{start,end}-group gets a fresh ID when instantiated. All
522 // files within the same --{start,end}-group get the same group ID. E.g.
523 //
524 // ld.lld A B --start-group C D --end-group E
525 //
526 // A forms group 0. B form group 1. C and D (including their member object
527 // files) form group 2. E forms group 3. I think that you can see how this
528 // group assignment rule simulates the traditional linker's semantics.
Rui Ueyama3837f422019-07-10 05:00:37529 bool backref = config->warnBackrefs && other.file &&
530 file->groupId < other.file->groupId;
Rui Ueyama7f7d2b22019-05-23 09:58:08531 fetch();
532
533 // We don't report backward references to weak symbols as they can be
534 // overridden later.
Fangrui Song03c825c2020-04-06 05:27:46535 //
536 // A traditional linker does not error for -ldef1 -lref -ldef2 (linking
537 // sandwich), where def2 may or may not be the same as def1. We don't want
538 // to warn for this case, so dismiss the warning if we see a subsequent lazy
Fangrui Songce3c5da2020-10-22 22:26:52539 // definition. this->file needs to be saved because in the case of LTO it
540 // may be reset to nullptr or be replaced with a file named lto.tmp.
Rui Ueyama3837f422019-07-10 05:00:37541 if (backref && !isWeak())
Fangrui Songce3c5da2020-10-22 22:26:52542 backwardReferences.try_emplace(this, std::make_pair(other.file, file));
Fangrui Songf3475412019-07-04 10:38:04543 return;
544 }
545
546 // Undefined symbols in a SharedFile do not change the binding.
Rui Ueyama3837f422019-07-10 05:00:37547 if (dyn_cast_or_null<SharedFile>(other.file))
Fangrui Songf3475412019-07-04 10:38:04548 return;
549
Fangrui Songe49c4172019-08-06 14:03:45550 if (isUndefined() || isShared()) {
551 // The binding will be weak if there is at least one reference and all are
552 // weak. The binding has one opportunity to change to weak: if the first
553 // reference is weak.
554 if (other.binding != STB_WEAK || !referenced)
Rui Ueyama3837f422019-07-10 05:00:37555 binding = other.binding;
Rui Ueyama7f7d2b22019-05-23 09:58:08556 }
557}
558
559// Using .symver foo,foo@@VER unfortunately creates two symbols: foo and
560// foo@@VER. We want to effectively ignore foo, so give precedence to
561// foo@@VER.
562// FIXME: If users can transition to using
563// .symver foo,foo@@@VER
564// we can delete this hack.
Rui Ueyama3837f422019-07-10 05:00:37565static int compareVersion(StringRef a, StringRef b) {
566 bool x = a.contains("@@");
567 bool y = b.contains("@@");
568 if (!x && y)
Rui Ueyama7f7d2b22019-05-23 09:58:08569 return 1;
Rui Ueyama3837f422019-07-10 05:00:37570 if (x && !y)
Rui Ueyama7f7d2b22019-05-23 09:58:08571 return -1;
572 return 0;
573}
574
575// Compare two symbols. Return 1 if the new symbol should win, -1 if
576// the new symbol should lose, or 0 if there is a conflict.
Rui Ueyama3837f422019-07-10 05:00:37577int Symbol::compare(const Symbol *other) const {
578 assert(other->isDefined() || other->isCommon());
Rui Ueyama7f7d2b22019-05-23 09:58:08579
580 if (!isDefined() && !isCommon())
581 return 1;
582
Rui Ueyama3837f422019-07-10 05:00:37583 if (int cmp = compareVersion(getName(), other->getName()))
584 return cmp;
Rui Ueyama7f7d2b22019-05-23 09:58:08585
Rui Ueyama3837f422019-07-10 05:00:37586 if (other->isWeak())
Rui Ueyama7f7d2b22019-05-23 09:58:08587 return -1;
588
589 if (isWeak())
590 return 1;
591
Rui Ueyama3837f422019-07-10 05:00:37592 if (isCommon() && other->isCommon()) {
593 if (config->warnCommon)
Rui Ueyama7f7d2b22019-05-23 09:58:08594 warn("multiple common of " + getName());
595 return 0;
596 }
597
598 if (isCommon()) {
Rui Ueyama3837f422019-07-10 05:00:37599 if (config->warnCommon)
Rui Ueyama7f7d2b22019-05-23 09:58:08600 warn("common " + getName() + " is overridden");
601 return 1;
602 }
603
Rui Ueyama3837f422019-07-10 05:00:37604 if (other->isCommon()) {
605 if (config->warnCommon)
Rui Ueyama7f7d2b22019-05-23 09:58:08606 warn("common " + getName() + " is overridden");
607 return -1;
608 }
609
Rui Ueyama3837f422019-07-10 05:00:37610 auto *oldSym = cast<Defined>(this);
611 auto *newSym = cast<Defined>(other);
Rui Ueyama7f7d2b22019-05-23 09:58:08612
Fangrui Songd6c44822019-07-26 16:29:15613 if (dyn_cast_or_null<BitcodeFile>(other->file))
Rui Ueyama7f7d2b22019-05-23 09:58:08614 return 0;
615
Rui Ueyama3837f422019-07-10 05:00:37616 if (!oldSym->section && !newSym->section && oldSym->value == newSym->value &&
617 newSym->binding == STB_GLOBAL)
Rui Ueyama7f7d2b22019-05-23 09:58:08618 return -1;
619
620 return 0;
621}
622
Rui Ueyama3837f422019-07-10 05:00:37623static void reportDuplicate(Symbol *sym, InputFile *newFile,
624 InputSectionBase *errSec, uint64_t errOffset) {
625 if (config->allowMultipleDefinition)
Rui Ueyama7f7d2b22019-05-23 09:58:08626 return;
627
Rui Ueyama3837f422019-07-10 05:00:37628 Defined *d = cast<Defined>(sym);
629 if (!d->section || !errSec) {
630 error("duplicate symbol: " + toString(*sym) + "\n>>> defined in " +
631 toString(sym->file) + "\n>>> defined in " + toString(newFile));
Rui Ueyama7f7d2b22019-05-23 09:58:08632 return;
633 }
634
635 // Construct and print an error message in the form of:
636 //
637 // ld.lld: error: duplicate symbol: foo
638 // >>> defined at bar.c:30
639 // >>> bar.o (/home/alice/src/bar.o)
640 // >>> defined at baz.c:563
641 // >>> baz.o in archive libbaz.a
Rui Ueyama3837f422019-07-10 05:00:37642 auto *sec1 = cast<InputSectionBase>(d->section);
643 std::string src1 = sec1->getSrcMsg(*sym, d->value);
644 std::string obj1 = sec1->getObjMsg(d->value);
645 std::string src2 = errSec->getSrcMsg(*sym, errOffset);
646 std::string obj2 = errSec->getObjMsg(errOffset);
Rui Ueyama7f7d2b22019-05-23 09:58:08647
Rui Ueyama3837f422019-07-10 05:00:37648 std::string msg = "duplicate symbol: " + toString(*sym) + "\n>>> defined at ";
649 if (!src1.empty())
650 msg += src1 + "\n>>> ";
651 msg += obj1 + "\n>>> defined at ";
652 if (!src2.empty())
653 msg += src2 + "\n>>> ";
654 msg += obj2;
655 error(msg);
Rui Ueyama7f7d2b22019-05-23 09:58:08656}
657
Rui Ueyama3837f422019-07-10 05:00:37658void Symbol::resolveCommon(const CommonSymbol &other) {
659 int cmp = compare(&other);
660 if (cmp < 0)
Rui Ueyama7f7d2b22019-05-23 09:58:08661 return;
662
Rui Ueyama3837f422019-07-10 05:00:37663 if (cmp > 0) {
Fangrui Song69d10d22019-12-07 05:18:31664 if (auto *s = dyn_cast<SharedSymbol>(this)) {
665 // Increase st_size if the shared symbol has a larger st_size. The shared
666 // symbol may be created from common symbols. The fact that some object
667 // files were linked into a shared object first should not change the
668 // regular rule that picks the largest st_size.
669 uint64_t size = s->size;
670 replace(other);
671 if (size > cast<CommonSymbol>(this)->size)
672 cast<CommonSymbol>(this)->size = size;
673 } else {
674 replace(other);
675 }
Rui Ueyama7f7d2b22019-05-23 09:58:08676 return;
677 }
678
Rui Ueyama3837f422019-07-10 05:00:37679 CommonSymbol *oldSym = cast<CommonSymbol>(this);
Rui Ueyama7f7d2b22019-05-23 09:58:08680
Rui Ueyama3837f422019-07-10 05:00:37681 oldSym->alignment = std::max(oldSym->alignment, other.alignment);
682 if (oldSym->size < other.size) {
683 oldSym->file = other.file;
684 oldSym->size = other.size;
Rui Ueyama7f7d2b22019-05-23 09:58:08685 }
686}
687
Rui Ueyama3837f422019-07-10 05:00:37688void Symbol::resolveDefined(const Defined &other) {
689 int cmp = compare(&other);
690 if (cmp > 0)
691 replace(other);
692 else if (cmp == 0)
693 reportDuplicate(this, other.file,
694 dyn_cast_or_null<InputSectionBase>(other.section),
695 other.value);
Rui Ueyama7f7d2b22019-05-23 09:58:08696}
697
Sean Fertile8f91f382020-12-07 14:28:17698template <class LazyT>
699static void replaceCommon(Symbol &oldSym, const LazyT &newSym) {
700 backwardReferences.erase(&oldSym);
701 oldSym.replace(newSym);
702 newSym.fetch();
703}
704
Rui Ueyama3837f422019-07-10 05:00:37705template <class LazyT> void Symbol::resolveLazy(const LazyT &other) {
Sean Fertile8f91f382020-12-07 14:28:17706 // For common objects, we want to look for global or weak definitions that
Nico Weber279c5dc2021-02-17 20:29:39707 // should be fetched as the canonical definition instead.
Sean Fertile8f91f382020-12-07 14:28:17708 if (isCommon() && elf::config->fortranCommon) {
709 if (auto *laSym = dyn_cast<LazyArchive>(&other)) {
710 ArchiveFile *archive = cast<ArchiveFile>(laSym->file);
711 const Archive::Symbol &archiveSym = laSym->sym;
712 if (archive->shouldFetchForCommon(archiveSym)) {
713 replaceCommon(*this, other);
714 return;
715 }
716 } else if (auto *loSym = dyn_cast<LazyObject>(&other)) {
717 LazyObjFile *obj = cast<LazyObjFile>(loSym->file);
718 if (obj->shouldFetchForCommon(loSym->getName())) {
719 replaceCommon(*this, other);
720 return;
721 }
722 }
723 }
724
Fangrui Song03c825c2020-04-06 05:27:46725 if (!isUndefined()) {
726 // See the comment in resolveUndefined().
727 if (isDefined())
728 backwardReferences.erase(this);
Rui Ueyama7f7d2b22019-05-23 09:58:08729 return;
Fangrui Song03c825c2020-04-06 05:27:46730 }
Rui Ueyama7f7d2b22019-05-23 09:58:08731
732 // An undefined weak will not fetch archive members. See comment on Lazy in
733 // Symbols.h for the details.
734 if (isWeak()) {
Rui Ueyama3837f422019-07-10 05:00:37735 uint8_t ty = type;
736 replace(other);
737 type = ty;
738 binding = STB_WEAK;
Rui Ueyama7f7d2b22019-05-23 09:58:08739 return;
740 }
741
Rui Ueyama3837f422019-07-10 05:00:37742 other.fetch();
Rui Ueyama7f7d2b22019-05-23 09:58:08743}
744
Rui Ueyama3837f422019-07-10 05:00:37745void Symbol::resolveShared(const SharedSymbol &other) {
Fangrui Song69d10d22019-12-07 05:18:31746 if (isCommon()) {
747 // See the comment in resolveCommon() above.
748 if (other.size > cast<CommonSymbol>(this)->size)
749 cast<CommonSymbol>(this)->size = other.size;
750 return;
751 }
Rui Ueyama3837f422019-07-10 05:00:37752 if (visibility == STV_DEFAULT && (isUndefined() || isLazy())) {
Rui Ueyama7f7d2b22019-05-23 09:58:08753 // An undefined symbol with non default visibility must be satisfied
754 // in the same DSO.
Rui Ueyama3837f422019-07-10 05:00:37755 uint8_t bind = binding;
756 replace(other);
757 binding = bind;
Fangrui Song64676492020-05-18 17:15:59758 } else if (traced)
759 printTraceSymbol(&other);
Rui Ueyama7f7d2b22019-05-23 09:58:08760}