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