1 //===- InputSection.cpp ---------------------------------------------------===//
2 //
3 // 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
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "InputSection.h"
10 #include "Config.h"
11 #include "InputFiles.h"
12 #include "OutputSections.h"
13 #include "Relocations.h"
14 #include "SymbolTable.h"
15 #include "Symbols.h"
16 #include "SyntheticSections.h"
17 #include "Target.h"
18 #include "lld/Common/CommonLinkerContext.h"
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/Compression.h"
21 #include "llvm/Support/Endian.h"
22 #include "llvm/Support/xxhash.h"
23 #include <algorithm>
24 #include <mutex>
25 #include <vector>
26 
27 using namespace llvm;
28 using namespace llvm::ELF;
29 using namespace llvm::object;
30 using namespace llvm::support;
31 using namespace llvm::support::endian;
32 using namespace llvm::sys;
33 using namespace lld;
34 using namespace lld::elf;
35 
36 SmallVector<InputSectionBase *, 0> elf::inputSections;
37 DenseSet<std::pair<const Symbol *, uint64_t>> elf::ppc64noTocRelax;
38 
39 // Returns a string to construct an error message.
40 std::string lld::toString(const InputSectionBase *sec) {
41   return (toString(sec->file) + ":(" + sec->name + ")").str();
42 }
43 
44 template <class ELFT>
45 static ArrayRef<uint8_t> getSectionContents(ObjFile<ELFT> &file,
46                                             const typename ELFT::Shdr &hdr) {
47   if (hdr.sh_type == SHT_NOBITS)
48     return makeArrayRef<uint8_t>(nullptr, hdr.sh_size);
49   return check(file.getObj().getSectionContents(hdr));
50 }
51 
52 InputSectionBase::InputSectionBase(InputFile *file, uint64_t flags,
53                                    uint32_t type, uint64_t entsize,
54                                    uint32_t link, uint32_t info,
55                                    uint32_t alignment, ArrayRef<uint8_t> data,
56                                    StringRef name, Kind sectionKind)
57     : SectionBase(sectionKind, name, flags, entsize, alignment, type, info,
58                   link),
59       file(file), rawData(data) {
60   // In order to reduce memory allocation, we assume that mergeable
61   // sections are smaller than 4 GiB, which is not an unreasonable
62   // assumption as of 2017.
63   if (sectionKind == SectionBase::Merge && rawData.size() > UINT32_MAX)
64     error(toString(this) + ": section too large");
65 
66   // The ELF spec states that a value of 0 means the section has
67   // no alignment constraints.
68   uint32_t v = std::max<uint32_t>(alignment, 1);
69   if (!isPowerOf2_64(v))
70     fatal(toString(this) + ": sh_addralign is not a power of 2");
71   this->alignment = v;
72 
73   // In ELF, each section can be compressed by zlib, and if compressed,
74   // section name may be mangled by appending "z" (e.g. ".zdebug_info").
75   // If that's the case, demangle section name so that we can handle a
76   // section as if it weren't compressed.
77   if ((flags & SHF_COMPRESSED) || name.startswith(".zdebug")) {
78     if (!zlib::isAvailable())
79       error(toString(file) + ": contains a compressed section, " +
80             "but zlib is not available");
81     invokeELFT(parseCompressedHeader);
82   }
83 }
84 
85 // Drop SHF_GROUP bit unless we are producing a re-linkable object file.
86 // SHF_GROUP is a marker that a section belongs to some comdat group.
87 // That flag doesn't make sense in an executable.
88 static uint64_t getFlags(uint64_t flags) {
89   flags &= ~(uint64_t)SHF_INFO_LINK;
90   if (!config->relocatable)
91     flags &= ~(uint64_t)SHF_GROUP;
92   return flags;
93 }
94 
95 template <class ELFT>
96 InputSectionBase::InputSectionBase(ObjFile<ELFT> &file,
97                                    const typename ELFT::Shdr &hdr,
98                                    StringRef name, Kind sectionKind)
99     : InputSectionBase(&file, getFlags(hdr.sh_flags), hdr.sh_type,
100                        hdr.sh_entsize, hdr.sh_link, hdr.sh_info,
101                        hdr.sh_addralign, getSectionContents(file, hdr), name,
102                        sectionKind) {
103   // We reject object files having insanely large alignments even though
104   // they are allowed by the spec. I think 4GB is a reasonable limitation.
105   // We might want to relax this in the future.
106   if (hdr.sh_addralign > UINT32_MAX)
107     fatal(toString(&file) + ": section sh_addralign is too large");
108 }
109 
110 size_t InputSectionBase::getSize() const {
111   if (auto *s = dyn_cast<SyntheticSection>(this))
112     return s->getSize();
113   if (uncompressedSize >= 0)
114     return uncompressedSize;
115   return rawData.size() - bytesDropped;
116 }
117 
118 void InputSectionBase::uncompress() const {
119   size_t size = uncompressedSize;
120   char *uncompressedBuf;
121   {
122     static std::mutex mu;
123     std::lock_guard<std::mutex> lock(mu);
124     uncompressedBuf = bAlloc().Allocate<char>(size);
125   }
126 
127   if (Error e = zlib::uncompress(toStringRef(rawData), uncompressedBuf, size))
128     fatal(toString(this) +
129           ": uncompress failed: " + llvm::toString(std::move(e)));
130   rawData = makeArrayRef((uint8_t *)uncompressedBuf, size);
131   uncompressedSize = -1;
132 }
133 
134 template <class ELFT> RelsOrRelas<ELFT> InputSectionBase::relsOrRelas() const {
135   if (relSecIdx == 0)
136     return {};
137   RelsOrRelas<ELFT> ret;
138   typename ELFT::Shdr shdr =
139       cast<ELFFileBase>(file)->getELFShdrs<ELFT>()[relSecIdx];
140   if (shdr.sh_type == SHT_REL) {
141     ret.rels = makeArrayRef(reinterpret_cast<const typename ELFT::Rel *>(
142                                 file->mb.getBufferStart() + shdr.sh_offset),
143                             shdr.sh_size / sizeof(typename ELFT::Rel));
144   } else {
145     assert(shdr.sh_type == SHT_RELA);
146     ret.relas = makeArrayRef(reinterpret_cast<const typename ELFT::Rela *>(
147                                  file->mb.getBufferStart() + shdr.sh_offset),
148                              shdr.sh_size / sizeof(typename ELFT::Rela));
149   }
150   return ret;
151 }
152 
153 uint64_t SectionBase::getOffset(uint64_t offset) const {
154   switch (kind()) {
155   case Output: {
156     auto *os = cast<OutputSection>(this);
157     // For output sections we treat offset -1 as the end of the section.
158     return offset == uint64_t(-1) ? os->size : offset;
159   }
160   case Regular:
161   case Synthetic:
162     return cast<InputSection>(this)->outSecOff + offset;
163   case EHFrame:
164     // The file crtbeginT.o has relocations pointing to the start of an empty
165     // .eh_frame that is known to be the first in the link. It does that to
166     // identify the start of the output .eh_frame.
167     return offset;
168   case Merge:
169     const MergeInputSection *ms = cast<MergeInputSection>(this);
170     if (InputSection *isec = ms->getParent())
171       return isec->outSecOff + ms->getParentOffset(offset);
172     return ms->getParentOffset(offset);
173   }
174   llvm_unreachable("invalid section kind");
175 }
176 
177 uint64_t SectionBase::getVA(uint64_t offset) const {
178   const OutputSection *out = getOutputSection();
179   return (out ? out->addr : 0) + getOffset(offset);
180 }
181 
182 OutputSection *SectionBase::getOutputSection() {
183   InputSection *sec;
184   if (auto *isec = dyn_cast<InputSection>(this))
185     sec = isec;
186   else if (auto *ms = dyn_cast<MergeInputSection>(this))
187     sec = ms->getParent();
188   else if (auto *eh = dyn_cast<EhInputSection>(this))
189     sec = eh->getParent();
190   else
191     return cast<OutputSection>(this);
192   return sec ? sec->getParent() : nullptr;
193 }
194 
195 // When a section is compressed, `rawData` consists with a header followed
196 // by zlib-compressed data. This function parses a header to initialize
197 // `uncompressedSize` member and remove the header from `rawData`.
198 template <typename ELFT> void InputSectionBase::parseCompressedHeader() {
199   // Old-style header
200   if (!(flags & SHF_COMPRESSED)) {
201     assert(name.startswith(".zdebug"));
202     if (!toStringRef(rawData).startswith("ZLIB")) {
203       error(toString(this) + ": corrupted compressed section header");
204       return;
205     }
206     rawData = rawData.slice(4);
207 
208     if (rawData.size() < 8) {
209       error(toString(this) + ": corrupted compressed section header");
210       return;
211     }
212 
213     uncompressedSize = read64be(rawData.data());
214     rawData = rawData.slice(8);
215 
216     // Restore the original section name.
217     // (e.g. ".zdebug_info" -> ".debug_info")
218     name = saver().save("." + name.substr(2));
219     return;
220   }
221 
222   flags &= ~(uint64_t)SHF_COMPRESSED;
223 
224   // New-style header
225   if (rawData.size() < sizeof(typename ELFT::Chdr)) {
226     error(toString(this) + ": corrupted compressed section");
227     return;
228   }
229 
230   auto *hdr = reinterpret_cast<const typename ELFT::Chdr *>(rawData.data());
231   if (hdr->ch_type != ELFCOMPRESS_ZLIB) {
232     error(toString(this) + ": unsupported compression type");
233     return;
234   }
235 
236   uncompressedSize = hdr->ch_size;
237   alignment = std::max<uint32_t>(hdr->ch_addralign, 1);
238   rawData = rawData.slice(sizeof(*hdr));
239 }
240 
241 InputSection *InputSectionBase::getLinkOrderDep() const {
242   assert(flags & SHF_LINK_ORDER);
243   if (!link)
244     return nullptr;
245   return cast<InputSection>(file->getSections()[link]);
246 }
247 
248 // Find a function symbol that encloses a given location.
249 Defined *InputSectionBase::getEnclosingFunction(uint64_t offset) {
250   for (Symbol *b : file->getSymbols())
251     if (Defined *d = dyn_cast<Defined>(b))
252       if (d->section == this && d->type == STT_FUNC && d->value <= offset &&
253           offset < d->value + d->size)
254         return d;
255   return nullptr;
256 }
257 
258 // Returns an object file location string. Used to construct an error message.
259 std::string InputSectionBase::getLocation(uint64_t offset) {
260   std::string secAndOffset =
261       (name + "+0x" + Twine::utohexstr(offset) + ")").str();
262 
263   // We don't have file for synthetic sections.
264   if (file == nullptr)
265     return (config->outputFile + ":(" + secAndOffset).str();
266 
267   std::string filename = toString(file);
268   if (Defined *d = getEnclosingFunction(offset))
269     return filename + ":(function " + toString(*d) + ": " + secAndOffset;
270 
271   return filename + ":(" + secAndOffset;
272 }
273 
274 // This function is intended to be used for constructing an error message.
275 // The returned message looks like this:
276 //
277 //   foo.c:42 (/home/alice/possibly/very/long/path/foo.c:42)
278 //
279 //  Returns an empty string if there's no way to get line info.
280 std::string InputSectionBase::getSrcMsg(const Symbol &sym, uint64_t offset) {
281   return file->getSrcMsg(sym, *this, offset);
282 }
283 
284 // Returns a filename string along with an optional section name. This
285 // function is intended to be used for constructing an error
286 // message. The returned message looks like this:
287 //
288 //   path/to/foo.o:(function bar)
289 //
290 // or
291 //
292 //   path/to/foo.o:(function bar) in archive path/to/bar.a
293 std::string InputSectionBase::getObjMsg(uint64_t off) {
294   std::string filename = std::string(file->getName());
295 
296   std::string archive;
297   if (!file->archiveName.empty())
298     archive = (" in archive " + file->archiveName).str();
299 
300   // Find a symbol that encloses a given location.
301   for (Symbol *b : file->getSymbols())
302     if (auto *d = dyn_cast<Defined>(b))
303       if (d->section == this && d->value <= off && off < d->value + d->size)
304         return filename + ":(" + toString(*d) + ")" + archive;
305 
306   // If there's no symbol, print out the offset in the section.
307   return (filename + ":(" + name + "+0x" + utohexstr(off) + ")" + archive)
308       .str();
309 }
310 
311 InputSection InputSection::discarded(nullptr, 0, 0, 0, ArrayRef<uint8_t>(), "");
312 
313 InputSection::InputSection(InputFile *f, uint64_t flags, uint32_t type,
314                            uint32_t alignment, ArrayRef<uint8_t> data,
315                            StringRef name, Kind k)
316     : InputSectionBase(f, flags, type,
317                        /*Entsize*/ 0, /*Link*/ 0, /*Info*/ 0, alignment, data,
318                        name, k) {}
319 
320 template <class ELFT>
321 InputSection::InputSection(ObjFile<ELFT> &f, const typename ELFT::Shdr &header,
322                            StringRef name)
323     : InputSectionBase(f, header, name, InputSectionBase::Regular) {}
324 
325 OutputSection *InputSection::getParent() const {
326   return cast_or_null<OutputSection>(parent);
327 }
328 
329 // Copy SHT_GROUP section contents. Used only for the -r option.
330 template <class ELFT> void InputSection::copyShtGroup(uint8_t *buf) {
331   // ELFT::Word is the 32-bit integral type in the target endianness.
332   using u32 = typename ELFT::Word;
333   ArrayRef<u32> from = getDataAs<u32>();
334   auto *to = reinterpret_cast<u32 *>(buf);
335 
336   // The first entry is not a section number but a flag.
337   *to++ = from[0];
338 
339   // Adjust section numbers because section numbers in an input object files are
340   // different in the output. We also need to handle combined or discarded
341   // members.
342   ArrayRef<InputSectionBase *> sections = file->getSections();
343   DenseSet<uint32_t> seen;
344   for (uint32_t idx : from.slice(1)) {
345     OutputSection *osec = sections[idx]->getOutputSection();
346     if (osec && seen.insert(osec->sectionIndex).second)
347       *to++ = osec->sectionIndex;
348   }
349 }
350 
351 InputSectionBase *InputSection::getRelocatedSection() const {
352   if (!file || (type != SHT_RELA && type != SHT_REL))
353     return nullptr;
354   ArrayRef<InputSectionBase *> sections = file->getSections();
355   return sections[info];
356 }
357 
358 // This is used for -r and --emit-relocs. We can't use memcpy to copy
359 // relocations because we need to update symbol table offset and section index
360 // for each relocation. So we copy relocations one by one.
361 template <class ELFT, class RelTy>
362 void InputSection::copyRelocations(uint8_t *buf, ArrayRef<RelTy> rels) {
363   const TargetInfo &target = *elf::target;
364   InputSectionBase *sec = getRelocatedSection();
365   (void)sec->data(); // uncompress if needed
366 
367   for (const RelTy &rel : rels) {
368     RelType type = rel.getType(config->isMips64EL);
369     const ObjFile<ELFT> *file = getFile<ELFT>();
370     Symbol &sym = file->getRelocTargetSym(rel);
371 
372     auto *p = reinterpret_cast<typename ELFT::Rela *>(buf);
373     buf += sizeof(RelTy);
374 
375     if (RelTy::IsRela)
376       p->r_addend = getAddend<ELFT>(rel);
377 
378     // Output section VA is zero for -r, so r_offset is an offset within the
379     // section, but for --emit-relocs it is a virtual address.
380     p->r_offset = sec->getVA(rel.r_offset);
381     p->setSymbolAndType(in.symTab->getSymbolIndex(&sym), type,
382                         config->isMips64EL);
383 
384     if (sym.type == STT_SECTION) {
385       // We combine multiple section symbols into only one per
386       // section. This means we have to update the addend. That is
387       // trivial for Elf_Rela, but for Elf_Rel we have to write to the
388       // section data. We do that by adding to the Relocation vector.
389 
390       // .eh_frame is horribly special and can reference discarded sections. To
391       // avoid having to parse and recreate .eh_frame, we just replace any
392       // relocation in it pointing to discarded sections with R_*_NONE, which
393       // hopefully creates a frame that is ignored at runtime. Also, don't warn
394       // on .gcc_except_table and debug sections.
395       //
396       // See the comment in maybeReportUndefined for PPC32 .got2 and PPC64 .toc
397       auto *d = dyn_cast<Defined>(&sym);
398       if (!d) {
399         if (!isDebugSection(*sec) && sec->name != ".eh_frame" &&
400             sec->name != ".gcc_except_table" && sec->name != ".got2" &&
401             sec->name != ".toc") {
402           uint32_t secIdx = cast<Undefined>(sym).discardedSecIdx;
403           Elf_Shdr_Impl<ELFT> sec = file->template getELFShdrs<ELFT>()[secIdx];
404           warn("relocation refers to a discarded section: " +
405                CHECK(file->getObj().getSectionName(sec), file) +
406                "\n>>> referenced by " + getObjMsg(p->r_offset));
407         }
408         p->setSymbolAndType(0, 0, false);
409         continue;
410       }
411       SectionBase *section = d->section;
412       if (!section->isLive()) {
413         p->setSymbolAndType(0, 0, false);
414         continue;
415       }
416 
417       int64_t addend = getAddend<ELFT>(rel);
418       const uint8_t *bufLoc = sec->rawData.begin() + rel.r_offset;
419       if (!RelTy::IsRela)
420         addend = target.getImplicitAddend(bufLoc, type);
421 
422       if (config->emachine == EM_MIPS &&
423           target.getRelExpr(type, sym, bufLoc) == R_MIPS_GOTREL) {
424         // Some MIPS relocations depend on "gp" value. By default,
425         // this value has 0x7ff0 offset from a .got section. But
426         // relocatable files produced by a compiler or a linker
427         // might redefine this default value and we must use it
428         // for a calculation of the relocation result. When we
429         // generate EXE or DSO it's trivial. Generating a relocatable
430         // output is more difficult case because the linker does
431         // not calculate relocations in this mode and loses
432         // individual "gp" values used by each input object file.
433         // As a workaround we add the "gp" value to the relocation
434         // addend and save it back to the file.
435         addend += sec->getFile<ELFT>()->mipsGp0;
436       }
437 
438       if (RelTy::IsRela)
439         p->r_addend = sym.getVA(addend) - section->getOutputSection()->addr;
440       else if (config->relocatable && type != target.noneRel)
441         sec->relocations.push_back({R_ABS, type, rel.r_offset, addend, &sym});
442     } else if (config->emachine == EM_PPC && type == R_PPC_PLTREL24 &&
443                p->r_addend >= 0x8000 && sec->file->ppc32Got2) {
444       // Similar to R_MIPS_GPREL{16,32}. If the addend of R_PPC_PLTREL24
445       // indicates that r30 is relative to the input section .got2
446       // (r_addend>=0x8000), after linking, r30 should be relative to the output
447       // section .got2 . To compensate for the shift, adjust r_addend by
448       // ppc32Got->outSecOff.
449       p->r_addend += sec->file->ppc32Got2->outSecOff;
450     }
451   }
452 }
453 
454 // The ARM and AArch64 ABI handle pc-relative relocations to undefined weak
455 // references specially. The general rule is that the value of the symbol in
456 // this context is the address of the place P. A further special case is that
457 // branch relocations to an undefined weak reference resolve to the next
458 // instruction.
459 static uint32_t getARMUndefinedRelativeWeakVA(RelType type, uint32_t a,
460                                               uint32_t p) {
461   switch (type) {
462   // Unresolved branch relocations to weak references resolve to next
463   // instruction, this will be either 2 or 4 bytes on from P.
464   case R_ARM_THM_JUMP8:
465   case R_ARM_THM_JUMP11:
466     return p + 2 + a;
467   case R_ARM_CALL:
468   case R_ARM_JUMP24:
469   case R_ARM_PC24:
470   case R_ARM_PLT32:
471   case R_ARM_PREL31:
472   case R_ARM_THM_JUMP19:
473   case R_ARM_THM_JUMP24:
474     return p + 4 + a;
475   case R_ARM_THM_CALL:
476     // We don't want an interworking BLX to ARM
477     return p + 5 + a;
478   // Unresolved non branch pc-relative relocations
479   // R_ARM_TARGET2 which can be resolved relatively is not present as it never
480   // targets a weak-reference.
481   case R_ARM_MOVW_PREL_NC:
482   case R_ARM_MOVT_PREL:
483   case R_ARM_REL32:
484   case R_ARM_THM_ALU_PREL_11_0:
485   case R_ARM_THM_MOVW_PREL_NC:
486   case R_ARM_THM_MOVT_PREL:
487   case R_ARM_THM_PC12:
488     return p + a;
489   // p + a is unrepresentable as negative immediates can't be encoded.
490   case R_ARM_THM_PC8:
491     return p;
492   }
493   llvm_unreachable("ARM pc-relative relocation expected\n");
494 }
495 
496 // The comment above getARMUndefinedRelativeWeakVA applies to this function.
497 static uint64_t getAArch64UndefinedRelativeWeakVA(uint64_t type, uint64_t p) {
498   switch (type) {
499   // Unresolved branch relocations to weak references resolve to next
500   // instruction, this is 4 bytes on from P.
501   case R_AARCH64_CALL26:
502   case R_AARCH64_CONDBR19:
503   case R_AARCH64_JUMP26:
504   case R_AARCH64_TSTBR14:
505     return p + 4;
506   // Unresolved non branch pc-relative relocations
507   case R_AARCH64_PREL16:
508   case R_AARCH64_PREL32:
509   case R_AARCH64_PREL64:
510   case R_AARCH64_ADR_PREL_LO21:
511   case R_AARCH64_LD_PREL_LO19:
512   case R_AARCH64_PLT32:
513     return p;
514   }
515   llvm_unreachable("AArch64 pc-relative relocation expected\n");
516 }
517 
518 static uint64_t getRISCVUndefinedRelativeWeakVA(uint64_t type, uint64_t p) {
519   switch (type) {
520   case R_RISCV_BRANCH:
521   case R_RISCV_JAL:
522   case R_RISCV_CALL:
523   case R_RISCV_CALL_PLT:
524   case R_RISCV_RVC_BRANCH:
525   case R_RISCV_RVC_JUMP:
526     return p;
527   default:
528     return 0;
529   }
530 }
531 
532 // ARM SBREL relocations are of the form S + A - B where B is the static base
533 // The ARM ABI defines base to be "addressing origin of the output segment
534 // defining the symbol S". We defined the "addressing origin"/static base to be
535 // the base of the PT_LOAD segment containing the Sym.
536 // The procedure call standard only defines a Read Write Position Independent
537 // RWPI variant so in practice we should expect the static base to be the base
538 // of the RW segment.
539 static uint64_t getARMStaticBase(const Symbol &sym) {
540   OutputSection *os = sym.getOutputSection();
541   if (!os || !os->ptLoad || !os->ptLoad->firstSec)
542     fatal("SBREL relocation to " + sym.getName() + " without static base");
543   return os->ptLoad->firstSec->addr;
544 }
545 
546 // For R_RISCV_PC_INDIRECT (R_RISCV_PCREL_LO12_{I,S}), the symbol actually
547 // points the corresponding R_RISCV_PCREL_HI20 relocation, and the target VA
548 // is calculated using PCREL_HI20's symbol.
549 //
550 // This function returns the R_RISCV_PCREL_HI20 relocation from
551 // R_RISCV_PCREL_LO12's symbol and addend.
552 static Relocation *getRISCVPCRelHi20(const Symbol *sym, uint64_t addend) {
553   const Defined *d = cast<Defined>(sym);
554   if (!d->section) {
555     error("R_RISCV_PCREL_LO12 relocation points to an absolute symbol: " +
556           sym->getName());
557     return nullptr;
558   }
559   InputSection *isec = cast<InputSection>(d->section);
560 
561   if (addend != 0)
562     warn("non-zero addend in R_RISCV_PCREL_LO12 relocation to " +
563          isec->getObjMsg(d->value) + " is ignored");
564 
565   // Relocations are sorted by offset, so we can use std::equal_range to do
566   // binary search.
567   Relocation r;
568   r.offset = d->value;
569   auto range =
570       std::equal_range(isec->relocations.begin(), isec->relocations.end(), r,
571                        [](const Relocation &lhs, const Relocation &rhs) {
572                          return lhs.offset < rhs.offset;
573                        });
574 
575   for (auto it = range.first; it != range.second; ++it)
576     if (it->type == R_RISCV_PCREL_HI20 || it->type == R_RISCV_GOT_HI20 ||
577         it->type == R_RISCV_TLS_GD_HI20 || it->type == R_RISCV_TLS_GOT_HI20)
578       return &*it;
579 
580   error("R_RISCV_PCREL_LO12 relocation points to " + isec->getObjMsg(d->value) +
581         " without an associated R_RISCV_PCREL_HI20 relocation");
582   return nullptr;
583 }
584 
585 // A TLS symbol's virtual address is relative to the TLS segment. Add a
586 // target-specific adjustment to produce a thread-pointer-relative offset.
587 static int64_t getTlsTpOffset(const Symbol &s) {
588   // On targets that support TLSDESC, _TLS_MODULE_BASE_@tpoff = 0.
589   if (&s == ElfSym::tlsModuleBase)
590     return 0;
591 
592   // There are 2 TLS layouts. Among targets we support, x86 uses TLS Variant 2
593   // while most others use Variant 1. At run time TP will be aligned to p_align.
594 
595   // Variant 1. TP will be followed by an optional gap (which is the size of 2
596   // pointers on ARM/AArch64, 0 on other targets), followed by alignment
597   // padding, then the static TLS blocks. The alignment padding is added so that
598   // (TP + gap + padding) is congruent to p_vaddr modulo p_align.
599   //
600   // Variant 2. Static TLS blocks, followed by alignment padding are placed
601   // before TP. The alignment padding is added so that (TP - padding -
602   // p_memsz) is congruent to p_vaddr modulo p_align.
603   PhdrEntry *tls = Out::tlsPhdr;
604   switch (config->emachine) {
605     // Variant 1.
606   case EM_ARM:
607   case EM_AARCH64:
608     return s.getVA(0) + config->wordsize * 2 +
609            ((tls->p_vaddr - config->wordsize * 2) & (tls->p_align - 1));
610   case EM_MIPS:
611   case EM_PPC:
612   case EM_PPC64:
613     // Adjusted Variant 1. TP is placed with a displacement of 0x7000, which is
614     // to allow a signed 16-bit offset to reach 0x1000 of TCB/thread-library
615     // data and 0xf000 of the program's TLS segment.
616     return s.getVA(0) + (tls->p_vaddr & (tls->p_align - 1)) - 0x7000;
617   case EM_RISCV:
618     return s.getVA(0) + (tls->p_vaddr & (tls->p_align - 1));
619 
620     // Variant 2.
621   case EM_HEXAGON:
622   case EM_SPARCV9:
623   case EM_386:
624   case EM_X86_64:
625     return s.getVA(0) - tls->p_memsz -
626            ((-tls->p_vaddr - tls->p_memsz) & (tls->p_align - 1));
627   default:
628     llvm_unreachable("unhandled Config->EMachine");
629   }
630 }
631 
632 uint64_t InputSectionBase::getRelocTargetVA(const InputFile *file, RelType type,
633                                             int64_t a, uint64_t p,
634                                             const Symbol &sym, RelExpr expr) {
635   switch (expr) {
636   case R_ABS:
637   case R_DTPREL:
638   case R_RELAX_TLS_LD_TO_LE_ABS:
639   case R_RELAX_GOT_PC_NOPIC:
640   case R_RISCV_ADD:
641     return sym.getVA(a);
642   case R_ADDEND:
643     return a;
644   case R_ARM_SBREL:
645     return sym.getVA(a) - getARMStaticBase(sym);
646   case R_GOT:
647   case R_RELAX_TLS_GD_TO_IE_ABS:
648     return sym.getGotVA() + a;
649   case R_GOTONLY_PC:
650     return in.got->getVA() + a - p;
651   case R_GOTPLTONLY_PC:
652     return in.gotPlt->getVA() + a - p;
653   case R_GOTREL:
654   case R_PPC64_RELAX_TOC:
655     return sym.getVA(a) - in.got->getVA();
656   case R_GOTPLTREL:
657     return sym.getVA(a) - in.gotPlt->getVA();
658   case R_GOTPLT:
659   case R_RELAX_TLS_GD_TO_IE_GOTPLT:
660     return sym.getGotVA() + a - in.gotPlt->getVA();
661   case R_TLSLD_GOT_OFF:
662   case R_GOT_OFF:
663   case R_RELAX_TLS_GD_TO_IE_GOT_OFF:
664     return sym.getGotOffset() + a;
665   case R_AARCH64_GOT_PAGE_PC:
666   case R_AARCH64_RELAX_TLS_GD_TO_IE_PAGE_PC:
667     return getAArch64Page(sym.getGotVA() + a) - getAArch64Page(p);
668   case R_AARCH64_GOT_PAGE:
669     return sym.getGotVA() + a - getAArch64Page(in.got->getVA());
670   case R_GOT_PC:
671   case R_RELAX_TLS_GD_TO_IE:
672     return sym.getGotVA() + a - p;
673   case R_MIPS_GOTREL:
674     return sym.getVA(a) - in.mipsGot->getGp(file);
675   case R_MIPS_GOT_GP:
676     return in.mipsGot->getGp(file) + a;
677   case R_MIPS_GOT_GP_PC: {
678     // R_MIPS_LO16 expression has R_MIPS_GOT_GP_PC type iif the target
679     // is _gp_disp symbol. In that case we should use the following
680     // formula for calculation "AHL + GP - P + 4". For details see p. 4-19 at
681     // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
682     // microMIPS variants of these relocations use slightly different
683     // expressions: AHL + GP - P + 3 for %lo() and AHL + GP - P - 1 for %hi()
684     // to correctly handle less-significant bit of the microMIPS symbol.
685     uint64_t v = in.mipsGot->getGp(file) + a - p;
686     if (type == R_MIPS_LO16 || type == R_MICROMIPS_LO16)
687       v += 4;
688     if (type == R_MICROMIPS_LO16 || type == R_MICROMIPS_HI16)
689       v -= 1;
690     return v;
691   }
692   case R_MIPS_GOT_LOCAL_PAGE:
693     // If relocation against MIPS local symbol requires GOT entry, this entry
694     // should be initialized by 'page address'. This address is high 16-bits
695     // of sum the symbol's value and the addend.
696     return in.mipsGot->getVA() + in.mipsGot->getPageEntryOffset(file, sym, a) -
697            in.mipsGot->getGp(file);
698   case R_MIPS_GOT_OFF:
699   case R_MIPS_GOT_OFF32:
700     // In case of MIPS if a GOT relocation has non-zero addend this addend
701     // should be applied to the GOT entry content not to the GOT entry offset.
702     // That is why we use separate expression type.
703     return in.mipsGot->getVA() + in.mipsGot->getSymEntryOffset(file, sym, a) -
704            in.mipsGot->getGp(file);
705   case R_MIPS_TLSGD:
706     return in.mipsGot->getVA() + in.mipsGot->getGlobalDynOffset(file, sym) -
707            in.mipsGot->getGp(file);
708   case R_MIPS_TLSLD:
709     return in.mipsGot->getVA() + in.mipsGot->getTlsIndexOffset(file) -
710            in.mipsGot->getGp(file);
711   case R_AARCH64_PAGE_PC: {
712     uint64_t val = sym.isUndefWeak() ? p + a : sym.getVA(a);
713     return getAArch64Page(val) - getAArch64Page(p);
714   }
715   case R_RISCV_PC_INDIRECT: {
716     if (const Relocation *hiRel = getRISCVPCRelHi20(&sym, a))
717       return getRelocTargetVA(file, hiRel->type, hiRel->addend, sym.getVA(),
718                               *hiRel->sym, hiRel->expr);
719     return 0;
720   }
721   case R_PC:
722   case R_ARM_PCA: {
723     uint64_t dest;
724     if (expr == R_ARM_PCA)
725       // Some PC relative ARM (Thumb) relocations align down the place.
726       p = p & 0xfffffffc;
727     if (sym.isUndefWeak()) {
728       // On ARM and AArch64 a branch to an undefined weak resolves to the next
729       // instruction, otherwise the place. On RISCV, resolve an undefined weak
730       // to the same instruction to cause an infinite loop (making the user
731       // aware of the issue) while ensuring no overflow.
732       if (config->emachine == EM_ARM)
733         dest = getARMUndefinedRelativeWeakVA(type, a, p);
734       else if (config->emachine == EM_AARCH64)
735         dest = getAArch64UndefinedRelativeWeakVA(type, p) + a;
736       else if (config->emachine == EM_PPC)
737         dest = p;
738       else if (config->emachine == EM_RISCV)
739         dest = getRISCVUndefinedRelativeWeakVA(type, p) + a;
740       else
741         dest = sym.getVA(a);
742     } else {
743       dest = sym.getVA(a);
744     }
745     return dest - p;
746   }
747   case R_PLT:
748     return sym.getPltVA() + a;
749   case R_PLT_PC:
750   case R_PPC64_CALL_PLT:
751     return sym.getPltVA() + a - p;
752   case R_PLT_GOTPLT:
753     return sym.getPltVA() + a - in.gotPlt->getVA();
754   case R_PPC32_PLTREL:
755     // R_PPC_PLTREL24 uses the addend (usually 0 or 0x8000) to indicate r30
756     // stores _GLOBAL_OFFSET_TABLE_ or .got2+0x8000. The addend is ignored for
757     // target VA computation.
758     return sym.getPltVA() - p;
759   case R_PPC64_CALL: {
760     uint64_t symVA = sym.getVA(a);
761     // If we have an undefined weak symbol, we might get here with a symbol
762     // address of zero. That could overflow, but the code must be unreachable,
763     // so don't bother doing anything at all.
764     if (!symVA)
765       return 0;
766 
767     // PPC64 V2 ABI describes two entry points to a function. The global entry
768     // point is used for calls where the caller and callee (may) have different
769     // TOC base pointers and r2 needs to be modified to hold the TOC base for
770     // the callee. For local calls the caller and callee share the same
771     // TOC base and so the TOC pointer initialization code should be skipped by
772     // branching to the local entry point.
773     return symVA - p + getPPC64GlobalEntryToLocalEntryOffset(sym.stOther);
774   }
775   case R_PPC64_TOCBASE:
776     return getPPC64TocBase() + a;
777   case R_RELAX_GOT_PC:
778   case R_PPC64_RELAX_GOT_PC:
779     return sym.getVA(a) - p;
780   case R_RELAX_TLS_GD_TO_LE:
781   case R_RELAX_TLS_IE_TO_LE:
782   case R_RELAX_TLS_LD_TO_LE:
783   case R_TPREL:
784     // It is not very clear what to return if the symbol is undefined. With
785     // --noinhibit-exec, even a non-weak undefined reference may reach here.
786     // Just return A, which matches R_ABS, and the behavior of some dynamic
787     // loaders.
788     if (sym.isUndefined())
789       return a;
790     return getTlsTpOffset(sym) + a;
791   case R_RELAX_TLS_GD_TO_LE_NEG:
792   case R_TPREL_NEG:
793     if (sym.isUndefined())
794       return a;
795     return -getTlsTpOffset(sym) + a;
796   case R_SIZE:
797     return sym.getSize() + a;
798   case R_TLSDESC:
799     return in.got->getTlsDescAddr(sym) + a;
800   case R_TLSDESC_PC:
801     return in.got->getTlsDescAddr(sym) + a - p;
802   case R_TLSDESC_GOTPLT:
803     return in.got->getTlsDescAddr(sym) + a - in.gotPlt->getVA();
804   case R_AARCH64_TLSDESC_PAGE:
805     return getAArch64Page(in.got->getTlsDescAddr(sym) + a) - getAArch64Page(p);
806   case R_TLSGD_GOT:
807     return in.got->getGlobalDynOffset(sym) + a;
808   case R_TLSGD_GOTPLT:
809     return in.got->getGlobalDynAddr(sym) + a - in.gotPlt->getVA();
810   case R_TLSGD_PC:
811     return in.got->getGlobalDynAddr(sym) + a - p;
812   case R_TLSLD_GOTPLT:
813     return in.got->getVA() + in.got->getTlsIndexOff() + a - in.gotPlt->getVA();
814   case R_TLSLD_GOT:
815     return in.got->getTlsIndexOff() + a;
816   case R_TLSLD_PC:
817     return in.got->getTlsIndexVA() + a - p;
818   default:
819     llvm_unreachable("invalid expression");
820   }
821 }
822 
823 // This function applies relocations to sections without SHF_ALLOC bit.
824 // Such sections are never mapped to memory at runtime. Debug sections are
825 // an example. Relocations in non-alloc sections are much easier to
826 // handle than in allocated sections because it will never need complex
827 // treatment such as GOT or PLT (because at runtime no one refers them).
828 // So, we handle relocations for non-alloc sections directly in this
829 // function as a performance optimization.
830 template <class ELFT, class RelTy>
831 void InputSection::relocateNonAlloc(uint8_t *buf, ArrayRef<RelTy> rels) {
832   const unsigned bits = sizeof(typename ELFT::uint) * 8;
833   const TargetInfo &target = *elf::target;
834   const bool isDebug = isDebugSection(*this);
835   const bool isDebugLocOrRanges =
836       isDebug && (name == ".debug_loc" || name == ".debug_ranges");
837   const bool isDebugLine = isDebug && name == ".debug_line";
838   Optional<uint64_t> tombstone;
839   for (const auto &patAndValue : llvm::reverse(config->deadRelocInNonAlloc))
840     if (patAndValue.first.match(this->name)) {
841       tombstone = patAndValue.second;
842       break;
843     }
844 
845   for (const RelTy &rel : rels) {
846     RelType type = rel.getType(config->isMips64EL);
847 
848     // GCC 8.0 or earlier have a bug that they emit R_386_GOTPC relocations
849     // against _GLOBAL_OFFSET_TABLE_ for .debug_info. The bug has been fixed
850     // in 2017 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=82630), but we
851     // need to keep this bug-compatible code for a while.
852     if (config->emachine == EM_386 && type == R_386_GOTPC)
853       continue;
854 
855     uint64_t offset = rel.r_offset;
856     uint8_t *bufLoc = buf + offset;
857     int64_t addend = getAddend<ELFT>(rel);
858     if (!RelTy::IsRela)
859       addend += target.getImplicitAddend(bufLoc, type);
860 
861     Symbol &sym = getFile<ELFT>()->getRelocTargetSym(rel);
862     RelExpr expr = target.getRelExpr(type, sym, bufLoc);
863     if (expr == R_NONE)
864       continue;
865 
866     if (tombstone ||
867         (isDebug && (type == target.symbolicRel || expr == R_DTPREL))) {
868       // Resolve relocations in .debug_* referencing (discarded symbols or ICF
869       // folded section symbols) to a tombstone value. Resolving to addend is
870       // unsatisfactory because the result address range may collide with a
871       // valid range of low address, or leave multiple CUs claiming ownership of
872       // the same range of code, which may confuse consumers.
873       //
874       // To address the problems, we use -1 as a tombstone value for most
875       // .debug_* sections. We have to ignore the addend because we don't want
876       // to resolve an address attribute (which may have a non-zero addend) to
877       // -1+addend (wrap around to a low address).
878       //
879       // R_DTPREL type relocations represent an offset into the dynamic thread
880       // vector. The computed value is st_value plus a non-negative offset.
881       // Negative values are invalid, so -1 can be used as the tombstone value.
882       //
883       // If the referenced symbol is discarded (made Undefined), or the
884       // section defining the referenced symbol is garbage collected,
885       // sym.getOutputSection() is nullptr. `ds->folded` catches the ICF folded
886       // case. However, resolving a relocation in .debug_line to -1 would stop
887       // debugger users from setting breakpoints on the folded-in function, so
888       // exclude .debug_line.
889       //
890       // For pre-DWARF-v5 .debug_loc and .debug_ranges, -1 is a reserved value
891       // (base address selection entry), use 1 (which is used by GNU ld for
892       // .debug_ranges).
893       //
894       // TODO To reduce disruption, we use 0 instead of -1 as the tombstone
895       // value. Enable -1 in a future release.
896       auto *ds = dyn_cast<Defined>(&sym);
897       if (!sym.getOutputSection() || (ds && ds->folded && !isDebugLine)) {
898         // If -z dead-reloc-in-nonalloc= is specified, respect it.
899         const uint64_t value = tombstone ? SignExtend64<bits>(*tombstone)
900                                          : (isDebugLocOrRanges ? 1 : 0);
901         target.relocateNoSym(bufLoc, type, value);
902         continue;
903       }
904     }
905 
906     // For a relocatable link, only tombstone values are applied.
907     if (config->relocatable)
908       continue;
909 
910     if (expr == R_SIZE) {
911       target.relocateNoSym(bufLoc, type,
912                            SignExtend64<bits>(sym.getSize() + addend));
913       continue;
914     }
915 
916     // R_ABS/R_DTPREL and some other relocations can be used from non-SHF_ALLOC
917     // sections.
918     if (expr == R_ABS || expr == R_DTPREL || expr == R_GOTPLTREL ||
919         expr == R_RISCV_ADD) {
920       target.relocateNoSym(bufLoc, type, SignExtend64<bits>(sym.getVA(addend)));
921       continue;
922     }
923 
924     std::string msg = getLocation(offset) + ": has non-ABS relocation " +
925                       toString(type) + " against symbol '" + toString(sym) +
926                       "'";
927     if (expr != R_PC && expr != R_ARM_PCA) {
928       error(msg);
929       return;
930     }
931 
932     // If the control reaches here, we found a PC-relative relocation in a
933     // non-ALLOC section. Since non-ALLOC section is not loaded into memory
934     // at runtime, the notion of PC-relative doesn't make sense here. So,
935     // this is a usage error. However, GNU linkers historically accept such
936     // relocations without any errors and relocate them as if they were at
937     // address 0. For bug-compatibilty, we accept them with warnings. We
938     // know Steel Bank Common Lisp as of 2018 have this bug.
939     warn(msg);
940     target.relocateNoSym(
941         bufLoc, type,
942         SignExtend64<bits>(sym.getVA(addend - offset - outSecOff)));
943   }
944 }
945 
946 // This is used when '-r' is given.
947 // For REL targets, InputSection::copyRelocations() may store artificial
948 // relocations aimed to update addends. They are handled in relocateAlloc()
949 // for allocatable sections, and this function does the same for
950 // non-allocatable sections, such as sections with debug information.
951 static void relocateNonAllocForRelocatable(InputSection *sec, uint8_t *buf) {
952   const unsigned bits = config->is64 ? 64 : 32;
953 
954   for (const Relocation &rel : sec->relocations) {
955     // InputSection::copyRelocations() adds only R_ABS relocations.
956     assert(rel.expr == R_ABS);
957     uint8_t *bufLoc = buf + rel.offset;
958     uint64_t targetVA = SignExtend64(rel.sym->getVA(rel.addend), bits);
959     target->relocate(bufLoc, rel, targetVA);
960   }
961 }
962 
963 template <class ELFT>
964 void InputSectionBase::relocate(uint8_t *buf, uint8_t *bufEnd) {
965   if ((flags & SHF_EXECINSTR) && LLVM_UNLIKELY(getFile<ELFT>()->splitStack))
966     adjustSplitStackFunctionPrologues<ELFT>(buf, bufEnd);
967 
968   if (flags & SHF_ALLOC) {
969     relocateAlloc(buf, bufEnd);
970     return;
971   }
972 
973   auto *sec = cast<InputSection>(this);
974   if (config->relocatable)
975     relocateNonAllocForRelocatable(sec, buf);
976   // For a relocatable link, also call relocateNonAlloc() to rewrite applicable
977   // locations with tombstone values.
978   const RelsOrRelas<ELFT> rels = sec->template relsOrRelas<ELFT>();
979   if (rels.areRelocsRel())
980     sec->relocateNonAlloc<ELFT>(buf, rels.rels);
981   else
982     sec->relocateNonAlloc<ELFT>(buf, rels.relas);
983 }
984 
985 void InputSectionBase::relocateAlloc(uint8_t *buf, uint8_t *bufEnd) {
986   assert(flags & SHF_ALLOC);
987   const unsigned bits = config->wordsize * 8;
988   const TargetInfo &target = *elf::target;
989   uint64_t lastPPCRelaxedRelocOff = UINT64_C(-1);
990   AArch64Relaxer aarch64relaxer(relocations);
991   for (size_t i = 0, size = relocations.size(); i != size; ++i) {
992     const Relocation &rel = relocations[i];
993     if (rel.expr == R_NONE)
994       continue;
995     uint64_t offset = rel.offset;
996     uint8_t *bufLoc = buf + offset;
997 
998     uint64_t secAddr = getOutputSection()->addr;
999     if (auto *sec = dyn_cast<InputSection>(this))
1000       secAddr += sec->outSecOff;
1001     const uint64_t addrLoc = secAddr + offset;
1002     const uint64_t targetVA =
1003         SignExtend64(getRelocTargetVA(file, rel.type, rel.addend, addrLoc,
1004                                       *rel.sym, rel.expr),
1005                      bits);
1006     switch (rel.expr) {
1007     case R_RELAX_GOT_PC:
1008     case R_RELAX_GOT_PC_NOPIC:
1009       target.relaxGot(bufLoc, rel, targetVA);
1010       break;
1011     case R_AARCH64_GOT_PAGE_PC:
1012       if (i + 1 < size && aarch64relaxer.tryRelaxAdrpLdr(
1013                               rel, relocations[i + 1], secAddr, buf)) {
1014         ++i;
1015         continue;
1016       }
1017       target.relocate(bufLoc, rel, targetVA);
1018       break;
1019     case R_AARCH64_PAGE_PC:
1020       if (i + 1 < size && aarch64relaxer.tryRelaxAdrpAdd(
1021                               rel, relocations[i + 1], secAddr, buf)) {
1022         ++i;
1023         continue;
1024       }
1025       target.relocate(bufLoc, rel, targetVA);
1026       break;
1027     case R_PPC64_RELAX_GOT_PC: {
1028       // The R_PPC64_PCREL_OPT relocation must appear immediately after
1029       // R_PPC64_GOT_PCREL34 in the relocations table at the same offset.
1030       // We can only relax R_PPC64_PCREL_OPT if we have also relaxed
1031       // the associated R_PPC64_GOT_PCREL34 since only the latter has an
1032       // associated symbol. So save the offset when relaxing R_PPC64_GOT_PCREL34
1033       // and only relax the other if the saved offset matches.
1034       if (rel.type == R_PPC64_GOT_PCREL34)
1035         lastPPCRelaxedRelocOff = offset;
1036       if (rel.type == R_PPC64_PCREL_OPT && offset != lastPPCRelaxedRelocOff)
1037         break;
1038       target.relaxGot(bufLoc, rel, targetVA);
1039       break;
1040     }
1041     case R_PPC64_RELAX_TOC:
1042       // rel.sym refers to the STT_SECTION symbol associated to the .toc input
1043       // section. If an R_PPC64_TOC16_LO (.toc + addend) references the TOC
1044       // entry, there may be R_PPC64_TOC16_HA not paired with
1045       // R_PPC64_TOC16_LO_DS. Don't relax. This loses some relaxation
1046       // opportunities but is safe.
1047       if (ppc64noTocRelax.count({rel.sym, rel.addend}) ||
1048           !tryRelaxPPC64TocIndirection(rel, bufLoc))
1049         target.relocate(bufLoc, rel, targetVA);
1050       break;
1051     case R_RELAX_TLS_IE_TO_LE:
1052       target.relaxTlsIeToLe(bufLoc, rel, targetVA);
1053       break;
1054     case R_RELAX_TLS_LD_TO_LE:
1055     case R_RELAX_TLS_LD_TO_LE_ABS:
1056       target.relaxTlsLdToLe(bufLoc, rel, targetVA);
1057       break;
1058     case R_RELAX_TLS_GD_TO_LE:
1059     case R_RELAX_TLS_GD_TO_LE_NEG:
1060       target.relaxTlsGdToLe(bufLoc, rel, targetVA);
1061       break;
1062     case R_AARCH64_RELAX_TLS_GD_TO_IE_PAGE_PC:
1063     case R_RELAX_TLS_GD_TO_IE:
1064     case R_RELAX_TLS_GD_TO_IE_ABS:
1065     case R_RELAX_TLS_GD_TO_IE_GOT_OFF:
1066     case R_RELAX_TLS_GD_TO_IE_GOTPLT:
1067       target.relaxTlsGdToIe(bufLoc, rel, targetVA);
1068       break;
1069     case R_PPC64_CALL:
1070       // If this is a call to __tls_get_addr, it may be part of a TLS
1071       // sequence that has been relaxed and turned into a nop. In this
1072       // case, we don't want to handle it as a call.
1073       if (read32(bufLoc) == 0x60000000) // nop
1074         break;
1075 
1076       // Patch a nop (0x60000000) to a ld.
1077       if (rel.sym->needsTocRestore) {
1078         // gcc/gfortran 5.4, 6.3 and earlier versions do not add nop for
1079         // recursive calls even if the function is preemptible. This is not
1080         // wrong in the common case where the function is not preempted at
1081         // runtime. Just ignore.
1082         if ((bufLoc + 8 > bufEnd || read32(bufLoc + 4) != 0x60000000) &&
1083             rel.sym->file != file) {
1084           // Use substr(6) to remove the "__plt_" prefix.
1085           errorOrWarn(getErrorLocation(bufLoc) + "call to " +
1086                       lld::toString(*rel.sym).substr(6) +
1087                       " lacks nop, can't restore toc");
1088           break;
1089         }
1090         write32(bufLoc + 4, 0xe8410018); // ld %r2, 24(%r1)
1091       }
1092       target.relocate(bufLoc, rel, targetVA);
1093       break;
1094     default:
1095       target.relocate(bufLoc, rel, targetVA);
1096       break;
1097     }
1098   }
1099 
1100   // Apply jumpInstrMods.  jumpInstrMods are created when the opcode of
1101   // a jmp insn must be modified to shrink the jmp insn or to flip the jmp
1102   // insn.  This is primarily used to relax and optimize jumps created with
1103   // basic block sections.
1104   if (jumpInstrMod) {
1105     target.applyJumpInstrMod(buf + jumpInstrMod->offset, jumpInstrMod->original,
1106                              jumpInstrMod->size);
1107   }
1108 }
1109 
1110 // For each function-defining prologue, find any calls to __morestack,
1111 // and replace them with calls to __morestack_non_split.
1112 static void switchMorestackCallsToMorestackNonSplit(
1113     DenseSet<Defined *> &prologues,
1114     SmallVector<Relocation *, 0> &morestackCalls) {
1115 
1116   // If the target adjusted a function's prologue, all calls to
1117   // __morestack inside that function should be switched to
1118   // __morestack_non_split.
1119   Symbol *moreStackNonSplit = symtab->find("__morestack_non_split");
1120   if (!moreStackNonSplit) {
1121     error("mixing split-stack objects requires a definition of "
1122           "__morestack_non_split");
1123     return;
1124   }
1125 
1126   // Sort both collections to compare addresses efficiently.
1127   llvm::sort(morestackCalls, [](const Relocation *l, const Relocation *r) {
1128     return l->offset < r->offset;
1129   });
1130   std::vector<Defined *> functions(prologues.begin(), prologues.end());
1131   llvm::sort(functions, [](const Defined *l, const Defined *r) {
1132     return l->value < r->value;
1133   });
1134 
1135   auto it = morestackCalls.begin();
1136   for (Defined *f : functions) {
1137     // Find the first call to __morestack within the function.
1138     while (it != morestackCalls.end() && (*it)->offset < f->value)
1139       ++it;
1140     // Adjust all calls inside the function.
1141     while (it != morestackCalls.end() && (*it)->offset < f->value + f->size) {
1142       (*it)->sym = moreStackNonSplit;
1143       ++it;
1144     }
1145   }
1146 }
1147 
1148 static bool enclosingPrologueAttempted(uint64_t offset,
1149                                        const DenseSet<Defined *> &prologues) {
1150   for (Defined *f : prologues)
1151     if (f->value <= offset && offset < f->value + f->size)
1152       return true;
1153   return false;
1154 }
1155 
1156 // If a function compiled for split stack calls a function not
1157 // compiled for split stack, then the caller needs its prologue
1158 // adjusted to ensure that the called function will have enough stack
1159 // available. Find those functions, and adjust their prologues.
1160 template <class ELFT>
1161 void InputSectionBase::adjustSplitStackFunctionPrologues(uint8_t *buf,
1162                                                          uint8_t *end) {
1163   DenseSet<Defined *> prologues;
1164   SmallVector<Relocation *, 0> morestackCalls;
1165 
1166   for (Relocation &rel : relocations) {
1167     // Ignore calls into the split-stack api.
1168     if (rel.sym->getName().startswith("__morestack")) {
1169       if (rel.sym->getName().equals("__morestack"))
1170         morestackCalls.push_back(&rel);
1171       continue;
1172     }
1173 
1174     // A relocation to non-function isn't relevant. Sometimes
1175     // __morestack is not marked as a function, so this check comes
1176     // after the name check.
1177     if (rel.sym->type != STT_FUNC)
1178       continue;
1179 
1180     // If the callee's-file was compiled with split stack, nothing to do.  In
1181     // this context, a "Defined" symbol is one "defined by the binary currently
1182     // being produced". So an "undefined" symbol might be provided by a shared
1183     // library. It is not possible to tell how such symbols were compiled, so be
1184     // conservative.
1185     if (Defined *d = dyn_cast<Defined>(rel.sym))
1186       if (InputSection *isec = cast_or_null<InputSection>(d->section))
1187         if (!isec || !isec->getFile<ELFT>() || isec->getFile<ELFT>()->splitStack)
1188           continue;
1189 
1190     if (enclosingPrologueAttempted(rel.offset, prologues))
1191       continue;
1192 
1193     if (Defined *f = getEnclosingFunction(rel.offset)) {
1194       prologues.insert(f);
1195       if (target->adjustPrologueForCrossSplitStack(buf + f->value, end,
1196                                                    f->stOther))
1197         continue;
1198       if (!getFile<ELFT>()->someNoSplitStack)
1199         error(lld::toString(this) + ": " + f->getName() +
1200               " (with -fsplit-stack) calls " + rel.sym->getName() +
1201               " (without -fsplit-stack), but couldn't adjust its prologue");
1202     }
1203   }
1204 
1205   if (target->needsMoreStackNonSplit)
1206     switchMorestackCallsToMorestackNonSplit(prologues, morestackCalls);
1207 }
1208 
1209 template <class ELFT> void InputSection::writeTo(uint8_t *buf) {
1210   if (LLVM_UNLIKELY(type == SHT_NOBITS))
1211     return;
1212   // If -r or --emit-relocs is given, then an InputSection
1213   // may be a relocation section.
1214   if (LLVM_UNLIKELY(type == SHT_RELA)) {
1215     copyRelocations<ELFT>(buf, getDataAs<typename ELFT::Rela>());
1216     return;
1217   }
1218   if (LLVM_UNLIKELY(type == SHT_REL)) {
1219     copyRelocations<ELFT>(buf, getDataAs<typename ELFT::Rel>());
1220     return;
1221   }
1222 
1223   // If -r is given, we may have a SHT_GROUP section.
1224   if (LLVM_UNLIKELY(type == SHT_GROUP)) {
1225     copyShtGroup<ELFT>(buf);
1226     return;
1227   }
1228 
1229   // If this is a compressed section, uncompress section contents directly
1230   // to the buffer.
1231   if (uncompressedSize >= 0) {
1232     size_t size = uncompressedSize;
1233     if (Error e = zlib::uncompress(toStringRef(rawData), (char *)buf, size))
1234       fatal(toString(this) +
1235             ": uncompress failed: " + llvm::toString(std::move(e)));
1236     uint8_t *bufEnd = buf + size;
1237     relocate<ELFT>(buf, bufEnd);
1238     return;
1239   }
1240 
1241   // Copy section contents from source object file to output file
1242   // and then apply relocations.
1243   memcpy(buf, rawData.data(), rawData.size());
1244   relocate<ELFT>(buf, buf + rawData.size());
1245 }
1246 
1247 void InputSection::replace(InputSection *other) {
1248   alignment = std::max(alignment, other->alignment);
1249 
1250   // When a section is replaced with another section that was allocated to
1251   // another partition, the replacement section (and its associated sections)
1252   // need to be placed in the main partition so that both partitions will be
1253   // able to access it.
1254   if (partition != other->partition) {
1255     partition = 1;
1256     for (InputSection *isec : dependentSections)
1257       isec->partition = 1;
1258   }
1259 
1260   other->repl = repl;
1261   other->markDead();
1262 }
1263 
1264 template <class ELFT>
1265 EhInputSection::EhInputSection(ObjFile<ELFT> &f,
1266                                const typename ELFT::Shdr &header,
1267                                StringRef name)
1268     : InputSectionBase(f, header, name, InputSectionBase::EHFrame) {}
1269 
1270 SyntheticSection *EhInputSection::getParent() const {
1271   return cast_or_null<SyntheticSection>(parent);
1272 }
1273 
1274 // Returns the index of the first relocation that points to a region between
1275 // Begin and Begin+Size.
1276 template <class IntTy, class RelTy>
1277 static unsigned getReloc(IntTy begin, IntTy size, const ArrayRef<RelTy> &rels,
1278                          unsigned &relocI) {
1279   // Start search from RelocI for fast access. That works because the
1280   // relocations are sorted in .eh_frame.
1281   for (unsigned n = rels.size(); relocI < n; ++relocI) {
1282     const RelTy &rel = rels[relocI];
1283     if (rel.r_offset < begin)
1284       continue;
1285 
1286     if (rel.r_offset < begin + size)
1287       return relocI;
1288     return -1;
1289   }
1290   return -1;
1291 }
1292 
1293 // .eh_frame is a sequence of CIE or FDE records.
1294 // This function splits an input section into records and returns them.
1295 template <class ELFT> void EhInputSection::split() {
1296   const RelsOrRelas<ELFT> rels = relsOrRelas<ELFT>();
1297   // getReloc expects the relocations to be sorted by r_offset. See the comment
1298   // in scanRelocs.
1299   if (rels.areRelocsRel()) {
1300     SmallVector<typename ELFT::Rel, 0> storage;
1301     split<ELFT>(sortRels(rels.rels, storage));
1302   } else {
1303     SmallVector<typename ELFT::Rela, 0> storage;
1304     split<ELFT>(sortRels(rels.relas, storage));
1305   }
1306 }
1307 
1308 template <class ELFT, class RelTy>
1309 void EhInputSection::split(ArrayRef<RelTy> rels) {
1310   ArrayRef<uint8_t> d = rawData;
1311   const char *msg = nullptr;
1312   unsigned relI = 0;
1313   while (!d.empty()) {
1314     if (d.size() < 4) {
1315       msg = "CIE/FDE too small";
1316       break;
1317     }
1318     uint64_t size = endian::read32<ELFT::TargetEndianness>(d.data());
1319     // If it is 0xFFFFFFFF, the next 8 bytes contain the size instead,
1320     // but we do not support that format yet.
1321     if (size == UINT32_MAX) {
1322       msg = "CIE/FDE too large";
1323       break;
1324     }
1325     size += 4;
1326     if (size > d.size()) {
1327       msg = "CIE/FDE ends past the end of the section";
1328       break;
1329     }
1330 
1331     uint64_t off = d.data() - rawData.data();
1332     pieces.emplace_back(off, this, size, getReloc(off, size, rels, relI));
1333     d = d.slice(size);
1334   }
1335   if (msg)
1336     errorOrWarn("corrupted .eh_frame: " + Twine(msg) + "\n>>> defined in " +
1337                 getObjMsg(d.data() - rawData.data()));
1338 }
1339 
1340 static size_t findNull(StringRef s, size_t entSize) {
1341   for (unsigned i = 0, n = s.size(); i != n; i += entSize) {
1342     const char *b = s.begin() + i;
1343     if (std::all_of(b, b + entSize, [](char c) { return c == 0; }))
1344       return i;
1345   }
1346   llvm_unreachable("");
1347 }
1348 
1349 SyntheticSection *MergeInputSection::getParent() const {
1350   return cast_or_null<SyntheticSection>(parent);
1351 }
1352 
1353 // Split SHF_STRINGS section. Such section is a sequence of
1354 // null-terminated strings.
1355 void MergeInputSection::splitStrings(StringRef s, size_t entSize) {
1356   const bool live = !(flags & SHF_ALLOC) || !config->gcSections;
1357   const char *p = s.data(), *end = s.data() + s.size();
1358   if (!std::all_of(end - entSize, end, [](char c) { return c == 0; }))
1359     fatal(toString(this) + ": string is not null terminated");
1360   if (entSize == 1) {
1361     // Optimize the common case.
1362     do {
1363       size_t size = strlen(p) + 1;
1364       pieces.emplace_back(p - s.begin(), xxHash64(StringRef(p, size)), live);
1365       p += size;
1366     } while (p != end);
1367   } else {
1368     do {
1369       size_t size = findNull(StringRef(p, end - p), entSize) + entSize;
1370       pieces.emplace_back(p - s.begin(), xxHash64(StringRef(p, size)), live);
1371       p += size;
1372     } while (p != end);
1373   }
1374 }
1375 
1376 // Split non-SHF_STRINGS section. Such section is a sequence of
1377 // fixed size records.
1378 void MergeInputSection::splitNonStrings(ArrayRef<uint8_t> data,
1379                                         size_t entSize) {
1380   size_t size = data.size();
1381   assert((size % entSize) == 0);
1382   const bool live = !(flags & SHF_ALLOC) || !config->gcSections;
1383 
1384   pieces.resize_for_overwrite(size / entSize);
1385   for (size_t i = 0, j = 0; i != size; i += entSize, j++)
1386     pieces[j] = {i, (uint32_t)xxHash64(data.slice(i, entSize)), live};
1387 }
1388 
1389 template <class ELFT>
1390 MergeInputSection::MergeInputSection(ObjFile<ELFT> &f,
1391                                      const typename ELFT::Shdr &header,
1392                                      StringRef name)
1393     : InputSectionBase(f, header, name, InputSectionBase::Merge) {}
1394 
1395 MergeInputSection::MergeInputSection(uint64_t flags, uint32_t type,
1396                                      uint64_t entsize, ArrayRef<uint8_t> data,
1397                                      StringRef name)
1398     : InputSectionBase(nullptr, flags, type, entsize, /*Link*/ 0, /*Info*/ 0,
1399                        /*Alignment*/ entsize, data, name, SectionBase::Merge) {}
1400 
1401 // This function is called after we obtain a complete list of input sections
1402 // that need to be linked. This is responsible to split section contents
1403 // into small chunks for further processing.
1404 //
1405 // Note that this function is called from parallelForEach. This must be
1406 // thread-safe (i.e. no memory allocation from the pools).
1407 void MergeInputSection::splitIntoPieces() {
1408   assert(pieces.empty());
1409 
1410   if (flags & SHF_STRINGS)
1411     splitStrings(toStringRef(data()), entsize);
1412   else
1413     splitNonStrings(data(), entsize);
1414 }
1415 
1416 SectionPiece *MergeInputSection::getSectionPiece(uint64_t offset) {
1417   if (this->rawData.size() <= offset)
1418     fatal(toString(this) + ": offset is outside the section");
1419 
1420   // If Offset is not at beginning of a section piece, it is not in the map.
1421   // In that case we need to  do a binary search of the original section piece vector.
1422   auto it = partition_point(
1423       pieces, [=](SectionPiece p) { return p.inputOff <= offset; });
1424   return &it[-1];
1425 }
1426 
1427 // Returns the offset in an output section for a given input offset.
1428 // Because contents of a mergeable section is not contiguous in output,
1429 // it is not just an addition to a base output offset.
1430 uint64_t MergeInputSection::getParentOffset(uint64_t offset) const {
1431   // If Offset is not at beginning of a section piece, it is not in the map.
1432   // In that case we need to search from the original section piece vector.
1433   const SectionPiece &piece = *getSectionPiece(offset);
1434   uint64_t addend = offset - piece.inputOff;
1435   return piece.outputOff + addend;
1436 }
1437 
1438 template InputSection::InputSection(ObjFile<ELF32LE> &, const ELF32LE::Shdr &,
1439                                     StringRef);
1440 template InputSection::InputSection(ObjFile<ELF32BE> &, const ELF32BE::Shdr &,
1441                                     StringRef);
1442 template InputSection::InputSection(ObjFile<ELF64LE> &, const ELF64LE::Shdr &,
1443                                     StringRef);
1444 template InputSection::InputSection(ObjFile<ELF64BE> &, const ELF64BE::Shdr &,
1445                                     StringRef);
1446 
1447 template void InputSection::writeTo<ELF32LE>(uint8_t *);
1448 template void InputSection::writeTo<ELF32BE>(uint8_t *);
1449 template void InputSection::writeTo<ELF64LE>(uint8_t *);
1450 template void InputSection::writeTo<ELF64BE>(uint8_t *);
1451 
1452 template RelsOrRelas<ELF32LE> InputSectionBase::relsOrRelas<ELF32LE>() const;
1453 template RelsOrRelas<ELF32BE> InputSectionBase::relsOrRelas<ELF32BE>() const;
1454 template RelsOrRelas<ELF64LE> InputSectionBase::relsOrRelas<ELF64LE>() const;
1455 template RelsOrRelas<ELF64BE> InputSectionBase::relsOrRelas<ELF64BE>() const;
1456 
1457 template MergeInputSection::MergeInputSection(ObjFile<ELF32LE> &,
1458                                               const ELF32LE::Shdr &, StringRef);
1459 template MergeInputSection::MergeInputSection(ObjFile<ELF32BE> &,
1460                                               const ELF32BE::Shdr &, StringRef);
1461 template MergeInputSection::MergeInputSection(ObjFile<ELF64LE> &,
1462                                               const ELF64LE::Shdr &, StringRef);
1463 template MergeInputSection::MergeInputSection(ObjFile<ELF64BE> &,
1464                                               const ELF64BE::Shdr &, StringRef);
1465 
1466 template EhInputSection::EhInputSection(ObjFile<ELF32LE> &,
1467                                         const ELF32LE::Shdr &, StringRef);
1468 template EhInputSection::EhInputSection(ObjFile<ELF32BE> &,
1469                                         const ELF32BE::Shdr &, StringRef);
1470 template EhInputSection::EhInputSection(ObjFile<ELF64LE> &,
1471                                         const ELF64LE::Shdr &, StringRef);
1472 template EhInputSection::EhInputSection(ObjFile<ELF64BE> &,
1473                                         const ELF64BE::Shdr &, StringRef);
1474 
1475 template void EhInputSection::split<ELF32LE>();
1476 template void EhInputSection::split<ELF32BE>();
1477 template void EhInputSection::split<ELF64LE>();
1478 template void EhInputSection::split<ELF64BE>();
1479