xref: /llvm-project-15.0.7/lld/ELF/Writer.cpp (revision 1cb0256a)
1 //===- Writer.cpp ---------------------------------------------------------===//
2 //
3 //                             The LLVM Linker
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "Writer.h"
11 #include "Config.h"
12 #include "LinkerScript.h"
13 #include "MapFile.h"
14 #include "Memory.h"
15 #include "OutputSections.h"
16 #include "Relocations.h"
17 #include "Strings.h"
18 #include "SymbolTable.h"
19 #include "SyntheticSections.h"
20 #include "Target.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/ADT/StringSwitch.h"
23 #include "llvm/Support/FileOutputBuffer.h"
24 #include "llvm/Support/FileSystem.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include <climits>
27 #include <thread>
28 
29 using namespace llvm;
30 using namespace llvm::ELF;
31 using namespace llvm::object;
32 using namespace llvm::support;
33 using namespace llvm::support::endian;
34 
35 using namespace lld;
36 using namespace lld::elf;
37 
38 namespace {
39 // The writer writes a SymbolTable result to a file.
40 template <class ELFT> class Writer {
41 public:
42   typedef typename ELFT::uint uintX_t;
43   typedef typename ELFT::Shdr Elf_Shdr;
44   typedef typename ELFT::Ehdr Elf_Ehdr;
45   typedef typename ELFT::Phdr Elf_Phdr;
46   typedef typename ELFT::Sym Elf_Sym;
47   typedef typename ELFT::SymRange Elf_Sym_Range;
48   typedef typename ELFT::Rela Elf_Rela;
49   void run();
50 
51 private:
52   void createSyntheticSections();
53   void copyLocalSymbols();
54   void addSectionSymbols();
55   void addReservedSymbols();
56   void createSections();
57   void forEachRelSec(std::function<void(InputSectionBase &)> Fn);
58   void sortSections();
59   void finalizeSections();
60   void addPredefinedSections();
61 
62   std::vector<PhdrEntry> createPhdrs();
63   void removeEmptyPTLoad();
64   void addPtArmExid(std::vector<PhdrEntry> &Phdrs);
65   void assignAddresses();
66   void assignFileOffsets();
67   void assignFileOffsetsBinary();
68   void setPhdrs();
69   void fixHeaders();
70   void fixSectionAlignments();
71   void fixPredefinedSymbols();
72   void openFile();
73   void writeHeader();
74   void writeSections();
75   void writeSectionsBinary();
76   void writeBuildId();
77 
78   std::unique_ptr<FileOutputBuffer> Buffer;
79 
80   std::vector<OutputSection *> OutputSections;
81   OutputSectionFactory Factory{OutputSections};
82 
83   void addRelIpltSymbols();
84   void addStartEndSymbols();
85   void addStartStopSymbols(OutputSection *Sec);
86   uintX_t getEntryAddr();
87   OutputSection *findSection(StringRef Name);
88 
89   std::vector<PhdrEntry> Phdrs;
90 
91   uintX_t FileSize;
92   uintX_t SectionHeaderOff;
93   bool AllocateHeader = true;
94 };
95 } // anonymous namespace
96 
97 StringRef elf::getOutputSectionName(StringRef Name) {
98   if (Config->Relocatable)
99     return Name;
100 
101   // If -emit-relocs is given (which is rare), we need to copy
102   // relocation sections to the output. If input section .foo is
103   // output as .bar, we want to rename .rel.foo .rel.bar as well.
104   if (Config->EmitRelocs) {
105     for (StringRef V : {".rel.", ".rela."}) {
106       if (Name.startswith(V)) {
107         StringRef Inner = getOutputSectionName(Name.substr(V.size() - 1));
108         return Saver.save(Twine(V.drop_back()) + Inner);
109       }
110     }
111   }
112 
113   for (StringRef V :
114        {".text.", ".rodata.", ".data.rel.ro.", ".data.", ".bss.",
115         ".init_array.", ".fini_array.", ".ctors.", ".dtors.", ".tbss.",
116         ".gcc_except_table.", ".tdata.", ".ARM.exidx."}) {
117     StringRef Prefix = V.drop_back();
118     if (Name.startswith(V) || Name == Prefix)
119       return Prefix;
120   }
121 
122   // CommonSection is identified as "COMMON" in linker scripts.
123   // By default, it should go to .bss section.
124   if (Name == "COMMON")
125     return ".bss";
126 
127   // ".zdebug_" is a prefix for ZLIB-compressed sections.
128   // Because we decompressed input sections, we want to remove 'z'.
129   if (Name.startswith(".zdebug_"))
130     return Saver.save(Twine(".") + Name.substr(2));
131   return Name;
132 }
133 
134 template <class ELFT> static bool needsInterpSection() {
135   return !Symtab<ELFT>::X->getSharedFiles().empty() &&
136          !Config->DynamicLinker.empty() &&
137          !Script<ELFT>::X->ignoreInterpSection();
138 }
139 
140 template <class ELFT> void elf::writeResult() { Writer<ELFT>().run(); }
141 
142 template <class ELFT> void Writer<ELFT>::removeEmptyPTLoad() {
143   auto I = std::remove_if(Phdrs.begin(), Phdrs.end(), [&](const PhdrEntry &P) {
144     if (P.p_type != PT_LOAD)
145       return false;
146     if (!P.First)
147       return true;
148     uintX_t Size = P.Last->Addr + P.Last->Size - P.First->Addr;
149     return Size == 0;
150   });
151   Phdrs.erase(I, Phdrs.end());
152 }
153 
154 template <class ELFT>
155 static typename ELFT::uint getOutFlags(InputSectionBase *S) {
156   return S->Flags & ~(typename ELFT::uint)(SHF_GROUP | SHF_COMPRESSED);
157 }
158 
159 // This function scans over the input sections and creates mergeable
160 // synthetic sections. It removes MergeInputSections from array and
161 // adds new synthetic ones. Each synthetic section is added to the
162 // location of the first input section it replaces.
163 template <class ELFT> static void combineMergableSections() {
164   typedef typename ELFT::uint uintX_t;
165 
166   std::vector<MergeSyntheticSection<ELFT> *> MergeSections;
167   for (InputSectionBase *&S : InputSections) {
168     MergeInputSection<ELFT> *MS = dyn_cast<MergeInputSection<ELFT>>(S);
169     if (!MS)
170       continue;
171 
172     // We do not want to handle sections that are not alive, so just remove
173     // them instead of trying to merge.
174     if (!MS->Live)
175       continue;
176 
177     StringRef OutsecName = getOutputSectionName(MS->Name);
178     uintX_t Flags = getOutFlags<ELFT>(MS);
179     uintX_t Alignment = std::max<uintX_t>(MS->Alignment, MS->Entsize);
180 
181     auto I =
182         llvm::find_if(MergeSections, [=](MergeSyntheticSection<ELFT> *Sec) {
183           return Sec->Name == OutsecName && Sec->Flags == Flags &&
184                  Sec->Alignment == Alignment;
185         });
186     if (I == MergeSections.end()) {
187       MergeSyntheticSection<ELFT> *Syn = make<MergeSyntheticSection<ELFT>>(
188           OutsecName, MS->Type, Flags, Alignment);
189       MergeSections.push_back(Syn);
190       I = std::prev(MergeSections.end());
191       S = Syn;
192     } else {
193       S = nullptr;
194     }
195     (*I)->addSection(MS);
196   }
197 
198   std::vector<InputSectionBase *> &V = InputSections;
199   V.erase(std::remove(V.begin(), V.end(), nullptr), V.end());
200 }
201 
202 // The main function of the writer.
203 template <class ELFT> void Writer<ELFT>::run() {
204   // Create linker-synthesized sections such as .got or .plt.
205   // Such sections are of type input section.
206   createSyntheticSections();
207   combineMergableSections<ELFT>();
208 
209   // We need to create some reserved symbols such as _end. Create them.
210   if (!Config->Relocatable)
211     addReservedSymbols();
212 
213   // Create output sections.
214   Script<ELFT>::X->OutputSections = &OutputSections;
215   if (ScriptConfig->HasSections) {
216     // If linker script contains SECTIONS commands, let it create sections.
217     Script<ELFT>::X->processCommands(Factory);
218 
219     // Linker scripts may have left some input sections unassigned.
220     // Assign such sections using the default rule.
221     Script<ELFT>::X->addOrphanSections(Factory);
222   } else {
223     // If linker script does not contain SECTIONS commands, create
224     // output sections by default rules. We still need to give the
225     // linker script a chance to run, because it might contain
226     // non-SECTIONS commands such as ASSERT.
227     createSections();
228     Script<ELFT>::X->processCommands(Factory);
229   }
230 
231   if (Config->Discard != DiscardPolicy::All)
232     copyLocalSymbols();
233 
234   if (Config->copyRelocs())
235     addSectionSymbols();
236 
237   // Now that we have a complete set of output sections. This function
238   // completes section contents. For example, we need to add strings
239   // to the string table, and add entries to .got and .plt.
240   // finalizeSections does that.
241   finalizeSections();
242   if (ErrorCount)
243     return;
244 
245   if (Config->Relocatable) {
246     assignFileOffsets();
247   } else {
248     if (ScriptConfig->HasSections) {
249       Script<ELFT>::X->assignAddresses(Phdrs);
250     } else {
251       fixSectionAlignments();
252       assignAddresses();
253     }
254 
255     // Remove empty PT_LOAD to avoid causing the dynamic linker to try to mmap a
256     // 0 sized region. This has to be done late since only after assignAddresses
257     // we know the size of the sections.
258     removeEmptyPTLoad();
259 
260     if (!Config->OFormatBinary)
261       assignFileOffsets();
262     else
263       assignFileOffsetsBinary();
264 
265     setPhdrs();
266     fixPredefinedSymbols();
267   }
268 
269   // It does not make sense try to open the file if we have error already.
270   if (ErrorCount)
271     return;
272   // Write the result down to a file.
273   openFile();
274   if (ErrorCount)
275     return;
276   if (!Config->OFormatBinary) {
277     writeHeader();
278     writeSections();
279   } else {
280     writeSectionsBinary();
281   }
282 
283   // Backfill .note.gnu.build-id section content. This is done at last
284   // because the content is usually a hash value of the entire output file.
285   writeBuildId();
286   if (ErrorCount)
287     return;
288 
289   // Handle -Map option.
290   writeMapFile<ELFT>(OutputSections);
291   if (ErrorCount)
292     return;
293 
294   if (auto EC = Buffer->commit())
295     error("failed to write to the output file: " + EC.message());
296 
297   // Flush the output streams and exit immediately. A full shutdown
298   // is a good test that we are keeping track of all allocated memory,
299   // but actually freeing it is a waste of time in a regular linker run.
300   if (Config->ExitEarly)
301     exitLld(0);
302 }
303 
304 // Initialize Out members.
305 template <class ELFT> void Writer<ELFT>::createSyntheticSections() {
306   // Initialize all pointers with NULL. This is needed because
307   // you can call lld::elf::main more than once as a library.
308   memset(&Out::First, 0, sizeof(Out));
309 
310   auto Add = [](InputSectionBase *Sec) { InputSections.push_back(Sec); };
311 
312   // Create singleton output sections.
313   Out::Bss = make<OutputSection>(".bss", SHT_NOBITS, SHF_ALLOC | SHF_WRITE);
314   Out::BssRelRo =
315       make<OutputSection>(".bss.rel.ro", SHT_NOBITS, SHF_ALLOC | SHF_WRITE);
316   In<ELFT>::DynStrTab = make<StringTableSection<ELFT>>(".dynstr", true);
317   In<ELFT>::Dynamic = make<DynamicSection<ELFT>>();
318   In<ELFT>::RelaDyn = make<RelocationSection<ELFT>>(
319       Config->Rela ? ".rela.dyn" : ".rel.dyn", Config->ZCombreloc);
320   In<ELFT>::ShStrTab = make<StringTableSection<ELFT>>(".shstrtab", false);
321 
322   Out::ElfHeader = make<OutputSection>("", 0, SHF_ALLOC);
323   Out::ElfHeader->Size = sizeof(Elf_Ehdr);
324   Out::ProgramHeaders = make<OutputSection>("", 0, SHF_ALLOC);
325   Out::ProgramHeaders->updateAlignment(sizeof(uintX_t));
326 
327   if (needsInterpSection<ELFT>()) {
328     In<ELFT>::Interp = createInterpSection();
329     Add(In<ELFT>::Interp);
330   } else {
331     In<ELFT>::Interp = nullptr;
332   }
333 
334   if (!Config->Relocatable)
335     Add(createCommentSection<ELFT>());
336 
337   if (Config->Strip != StripPolicy::All) {
338     In<ELFT>::StrTab = make<StringTableSection<ELFT>>(".strtab", false);
339     In<ELFT>::SymTab = make<SymbolTableSection<ELFT>>(*In<ELFT>::StrTab);
340   }
341 
342   if (Config->BuildId != BuildIdKind::None) {
343     In<ELFT>::BuildId = make<BuildIdSection<ELFT>>();
344     Add(In<ELFT>::BuildId);
345   }
346 
347   InputSection *Common = createCommonSection<ELFT>();
348   if (!Common->Data.empty()) {
349     In<ELFT>::Common = Common;
350     Add(Common);
351   }
352 
353   // Add MIPS-specific sections.
354   bool HasDynSymTab =
355       !Symtab<ELFT>::X->getSharedFiles().empty() || Config->pic() ||
356       Config->ExportDynamic;
357   if (Config->EMachine == EM_MIPS) {
358     if (!Config->Shared && HasDynSymTab) {
359       In<ELFT>::MipsRldMap = make<MipsRldMapSection<ELFT>>();
360       Add(In<ELFT>::MipsRldMap);
361     }
362     if (auto *Sec = MipsAbiFlagsSection<ELFT>::create())
363       Add(Sec);
364     if (auto *Sec = MipsOptionsSection<ELFT>::create())
365       Add(Sec);
366     if (auto *Sec = MipsReginfoSection<ELFT>::create())
367       Add(Sec);
368   }
369 
370   if (HasDynSymTab) {
371     In<ELFT>::DynSymTab = make<SymbolTableSection<ELFT>>(*In<ELFT>::DynStrTab);
372     Add(In<ELFT>::DynSymTab);
373 
374     In<ELFT>::VerSym = make<VersionTableSection<ELFT>>();
375     Add(In<ELFT>::VerSym);
376 
377     if (!Config->VersionDefinitions.empty()) {
378       In<ELFT>::VerDef = make<VersionDefinitionSection<ELFT>>();
379       Add(In<ELFT>::VerDef);
380     }
381 
382     In<ELFT>::VerNeed = make<VersionNeedSection<ELFT>>();
383     Add(In<ELFT>::VerNeed);
384 
385     if (Config->GnuHash) {
386       In<ELFT>::GnuHashTab = make<GnuHashTableSection<ELFT>>();
387       Add(In<ELFT>::GnuHashTab);
388     }
389 
390     if (Config->SysvHash) {
391       In<ELFT>::HashTab = make<HashTableSection<ELFT>>();
392       Add(In<ELFT>::HashTab);
393     }
394 
395     Add(In<ELFT>::Dynamic);
396     Add(In<ELFT>::DynStrTab);
397     Add(In<ELFT>::RelaDyn);
398   }
399 
400   // Add .got. MIPS' .got is so different from the other archs,
401   // it has its own class.
402   if (Config->EMachine == EM_MIPS) {
403     In<ELFT>::MipsGot = make<MipsGotSection<ELFT>>();
404     Add(In<ELFT>::MipsGot);
405   } else {
406     In<ELFT>::Got = make<GotSection<ELFT>>();
407     Add(In<ELFT>::Got);
408   }
409 
410   In<ELFT>::GotPlt = make<GotPltSection<ELFT>>();
411   Add(In<ELFT>::GotPlt);
412   In<ELFT>::IgotPlt = make<IgotPltSection<ELFT>>();
413   Add(In<ELFT>::IgotPlt);
414 
415   if (Config->GdbIndex) {
416     In<ELFT>::GdbIndex = make<GdbIndexSection<ELFT>>();
417     Add(In<ELFT>::GdbIndex);
418   }
419 
420   // We always need to add rel[a].plt to output if it has entries.
421   // Even for static linking it can contain R_[*]_IRELATIVE relocations.
422   In<ELFT>::RelaPlt = make<RelocationSection<ELFT>>(
423       Config->Rela ? ".rela.plt" : ".rel.plt", false /*Sort*/);
424   Add(In<ELFT>::RelaPlt);
425 
426   // The RelaIplt immediately follows .rel.plt (.rel.dyn for ARM) to ensure
427   // that the IRelative relocations are processed last by the dynamic loader
428   In<ELFT>::RelaIplt = make<RelocationSection<ELFT>>(
429       (Config->EMachine == EM_ARM) ? ".rel.dyn" : In<ELFT>::RelaPlt->Name,
430       false /*Sort*/);
431   Add(In<ELFT>::RelaIplt);
432 
433   In<ELFT>::Plt = make<PltSection<ELFT>>(Target->PltHeaderSize);
434   Add(In<ELFT>::Plt);
435   In<ELFT>::Iplt = make<PltSection<ELFT>>(0);
436   Add(In<ELFT>::Iplt);
437 
438   if (Config->EhFrameHdr) {
439     In<ELFT>::EhFrameHdr = make<EhFrameHeader<ELFT>>();
440     Add(In<ELFT>::EhFrameHdr);
441   }
442 
443   if (!Config->Relocatable) {
444     In<ELFT>::EhFrame = make<EhFrameSection<ELFT>>();
445     Add(In<ELFT>::EhFrame);
446   }
447 
448   if (In<ELFT>::SymTab)
449     Add(In<ELFT>::SymTab);
450   Add(In<ELFT>::ShStrTab);
451   if (In<ELFT>::StrTab)
452     Add(In<ELFT>::StrTab);
453 }
454 
455 template <class ELFT>
456 static bool shouldKeepInSymtab(InputSectionBase *Sec, StringRef SymName,
457                                const SymbolBody &B) {
458   if (B.isFile() || B.isSection())
459     return false;
460 
461   // If sym references a section in a discarded group, don't keep it.
462   if (Sec == &InputSection::Discarded)
463     return false;
464 
465   if (Config->Discard == DiscardPolicy::None)
466     return true;
467 
468   // In ELF assembly .L symbols are normally discarded by the assembler.
469   // If the assembler fails to do so, the linker discards them if
470   // * --discard-locals is used.
471   // * The symbol is in a SHF_MERGE section, which is normally the reason for
472   //   the assembler keeping the .L symbol.
473   if (!SymName.startswith(".L") && !SymName.empty())
474     return true;
475 
476   if (Config->Discard == DiscardPolicy::Locals)
477     return false;
478 
479   return !Sec || !(Sec->Flags & SHF_MERGE);
480 }
481 
482 template <class ELFT> static bool includeInSymtab(const SymbolBody &B) {
483   if (!B.isLocal() && !B.symbol()->IsUsedInRegularObj)
484     return false;
485 
486   if (auto *D = dyn_cast<DefinedRegular>(&B)) {
487     // Always include absolute symbols.
488     if (!D->Section)
489       return true;
490     // Exclude symbols pointing to garbage-collected sections.
491     if (!D->Section->Live)
492       return false;
493     if (auto *S = dyn_cast<MergeInputSection<ELFT>>(D->Section))
494       if (!S->getSectionPiece(D->Value)->Live)
495         return false;
496   }
497   return true;
498 }
499 
500 // Local symbols are not in the linker's symbol table. This function scans
501 // each object file's symbol table to copy local symbols to the output.
502 template <class ELFT> void Writer<ELFT>::copyLocalSymbols() {
503   if (!In<ELFT>::SymTab)
504     return;
505   for (elf::ObjectFile<ELFT> *F : Symtab<ELFT>::X->getObjectFiles()) {
506     for (SymbolBody *B : F->getLocalSymbols()) {
507       if (!B->IsLocal)
508         fatal(toString(F) +
509               ": broken object: getLocalSymbols returns a non-local symbol");
510       auto *DR = dyn_cast<DefinedRegular>(B);
511 
512       // No reason to keep local undefined symbol in symtab.
513       if (!DR)
514         continue;
515       if (!includeInSymtab<ELFT>(*B))
516         continue;
517 
518       InputSectionBase *Sec = DR->Section;
519       if (!shouldKeepInSymtab<ELFT>(Sec, B->getName(), *B))
520         continue;
521       In<ELFT>::SymTab->addSymbol(B);
522     }
523   }
524 }
525 
526 template <class ELFT> void Writer<ELFT>::addSectionSymbols() {
527   // Create one STT_SECTION symbol for each output section we might
528   // have a relocation with.
529   for (OutputSection *Sec : OutputSections) {
530     if (Sec->Sections.empty())
531       continue;
532 
533     InputSection *IS = Sec->Sections[0];
534     if (isa<SyntheticSection>(IS) || IS->Type == SHT_REL ||
535         IS->Type == SHT_RELA)
536       continue;
537 
538     auto *Sym =
539         make<DefinedRegular>("", /*IsLocal=*/true, /*StOther=*/0, STT_SECTION,
540                              /*Value=*/0, /*Size=*/0, IS, nullptr);
541     In<ELFT>::SymTab->addSymbol(Sym);
542   }
543 }
544 
545 // PPC64 has a number of special SHT_PROGBITS+SHF_ALLOC+SHF_WRITE sections that
546 // we would like to make sure appear is a specific order to maximize their
547 // coverage by a single signed 16-bit offset from the TOC base pointer.
548 // Conversely, the special .tocbss section should be first among all SHT_NOBITS
549 // sections. This will put it next to the loaded special PPC64 sections (and,
550 // thus, within reach of the TOC base pointer).
551 static int getPPC64SectionRank(StringRef SectionName) {
552   return StringSwitch<int>(SectionName)
553       .Case(".tocbss", 0)
554       .Case(".branch_lt", 2)
555       .Case(".toc", 3)
556       .Case(".toc1", 4)
557       .Case(".opd", 5)
558       .Default(1);
559 }
560 
561 // All sections with SHF_MIPS_GPREL flag should be grouped together
562 // because data in these sections is addressable with a gp relative address.
563 static int getMipsSectionRank(const OutputSection *S) {
564   if ((S->Flags & SHF_MIPS_GPREL) == 0)
565     return 0;
566   if (S->Name == ".got")
567     return 1;
568   return 2;
569 }
570 
571 // Today's loaders have a feature to make segments read-only after
572 // processing dynamic relocations to enhance security. PT_GNU_RELRO
573 // is defined for that.
574 //
575 // This function returns true if a section needs to be put into a
576 // PT_GNU_RELRO segment.
577 template <class ELFT> bool elf::isRelroSection(const OutputSection *Sec) {
578   if (!Config->ZRelro)
579     return false;
580 
581   uint64_t Flags = Sec->Flags;
582   if (!(Flags & SHF_ALLOC) || !(Flags & SHF_WRITE))
583     return false;
584   if (Flags & SHF_TLS)
585     return true;
586 
587   uint32_t Type = Sec->Type;
588   if (Type == SHT_INIT_ARRAY || Type == SHT_FINI_ARRAY ||
589       Type == SHT_PREINIT_ARRAY)
590     return true;
591 
592   if (Sec == In<ELFT>::GotPlt->OutSec)
593     return Config->ZNow;
594   if (Sec == In<ELFT>::Dynamic->OutSec)
595     return true;
596   if (In<ELFT>::Got && Sec == In<ELFT>::Got->OutSec)
597     return true;
598   if (Sec == Out::BssRelRo)
599     return true;
600 
601   StringRef S = Sec->Name;
602   return S == ".data.rel.ro" || S == ".ctors" || S == ".dtors" || S == ".jcr" ||
603          S == ".eh_frame" || S == ".openbsd.randomdata";
604 }
605 
606 template <class ELFT>
607 static bool compareSectionsNonScript(const OutputSection *A,
608                                      const OutputSection *B) {
609   // Put .interp first because some loaders want to see that section
610   // on the first page of the executable file when loaded into memory.
611   bool AIsInterp = A->Name == ".interp";
612   bool BIsInterp = B->Name == ".interp";
613   if (AIsInterp != BIsInterp)
614     return AIsInterp;
615 
616   // Allocatable sections go first to reduce the total PT_LOAD size and
617   // so debug info doesn't change addresses in actual code.
618   bool AIsAlloc = A->Flags & SHF_ALLOC;
619   bool BIsAlloc = B->Flags & SHF_ALLOC;
620   if (AIsAlloc != BIsAlloc)
621     return AIsAlloc;
622 
623   // We don't have any special requirements for the relative order of two non
624   // allocatable sections.
625   if (!AIsAlloc)
626     return false;
627 
628   // We want to put section specified by -T option first, so we
629   // can start assigning VA starting from them later.
630   auto AAddrSetI = Config->SectionStartMap.find(A->Name);
631   auto BAddrSetI = Config->SectionStartMap.find(B->Name);
632   bool AHasAddrSet = AAddrSetI != Config->SectionStartMap.end();
633   bool BHasAddrSet = BAddrSetI != Config->SectionStartMap.end();
634   if (AHasAddrSet != BHasAddrSet)
635     return AHasAddrSet;
636   if (AHasAddrSet)
637     return AAddrSetI->second < BAddrSetI->second;
638 
639   // We want the read only sections first so that they go in the PT_LOAD
640   // covering the program headers at the start of the file.
641   bool AIsWritable = A->Flags & SHF_WRITE;
642   bool BIsWritable = B->Flags & SHF_WRITE;
643   if (AIsWritable != BIsWritable)
644     return BIsWritable;
645 
646   if (!Config->SingleRoRx) {
647     // For a corresponding reason, put non exec sections first (the program
648     // header PT_LOAD is not executable).
649     // We only do that if we are not using linker scripts, since with linker
650     // scripts ro and rx sections are in the same PT_LOAD, so their relative
651     // order is not important. The same applies for -no-rosegment.
652     bool AIsExec = A->Flags & SHF_EXECINSTR;
653     bool BIsExec = B->Flags & SHF_EXECINSTR;
654     if (AIsExec != BIsExec)
655       return BIsExec;
656   }
657 
658   // If we got here we know that both A and B are in the same PT_LOAD.
659 
660   bool AIsTls = A->Flags & SHF_TLS;
661   bool BIsTls = B->Flags & SHF_TLS;
662   bool AIsNoBits = A->Type == SHT_NOBITS;
663   bool BIsNoBits = B->Type == SHT_NOBITS;
664 
665   // The first requirement we have is to put (non-TLS) nobits sections last. The
666   // reason is that the only thing the dynamic linker will see about them is a
667   // p_memsz that is larger than p_filesz. Seeing that it zeros the end of the
668   // PT_LOAD, so that has to correspond to the nobits sections.
669   bool AIsNonTlsNoBits = AIsNoBits && !AIsTls;
670   bool BIsNonTlsNoBits = BIsNoBits && !BIsTls;
671   if (AIsNonTlsNoBits != BIsNonTlsNoBits)
672     return BIsNonTlsNoBits;
673 
674   // We place nobits RelRo sections before plain r/w ones, and non-nobits RelRo
675   // sections after r/w ones, so that the RelRo sections are contiguous.
676   bool AIsRelRo = isRelroSection<ELFT>(A);
677   bool BIsRelRo = isRelroSection<ELFT>(B);
678   if (AIsRelRo != BIsRelRo)
679     return AIsNonTlsNoBits ? AIsRelRo : BIsRelRo;
680 
681   // The TLS initialization block needs to be a single contiguous block in a R/W
682   // PT_LOAD, so stick TLS sections directly before the other RelRo R/W
683   // sections. The TLS NOBITS sections are placed here as they don't take up
684   // virtual address space in the PT_LOAD.
685   if (AIsTls != BIsTls)
686     return AIsTls;
687 
688   // Within the TLS initialization block, the non-nobits sections need to appear
689   // first.
690   if (AIsNoBits != BIsNoBits)
691     return BIsNoBits;
692 
693   // Some architectures have additional ordering restrictions for sections
694   // within the same PT_LOAD.
695   if (Config->EMachine == EM_PPC64)
696     return getPPC64SectionRank(A->Name) < getPPC64SectionRank(B->Name);
697   if (Config->EMachine == EM_MIPS)
698     return getMipsSectionRank(A) < getMipsSectionRank(B);
699 
700   return false;
701 }
702 
703 // Output section ordering is determined by this function.
704 template <class ELFT>
705 static bool compareSections(const OutputSection *A, const OutputSection *B) {
706   // For now, put sections mentioned in a linker script first.
707   int AIndex = Script<ELFT>::X->getSectionIndex(A->Name);
708   int BIndex = Script<ELFT>::X->getSectionIndex(B->Name);
709   bool AInScript = AIndex != INT_MAX;
710   bool BInScript = BIndex != INT_MAX;
711   if (AInScript != BInScript)
712     return AInScript;
713   // If both are in the script, use that order.
714   if (AInScript)
715     return AIndex < BIndex;
716 
717   return compareSectionsNonScript<ELFT>(A, B);
718 }
719 
720 // Program header entry
721 PhdrEntry::PhdrEntry(unsigned Type, unsigned Flags) {
722   p_type = Type;
723   p_flags = Flags;
724 }
725 
726 void PhdrEntry::add(OutputSection *Sec) {
727   Last = Sec;
728   if (!First)
729     First = Sec;
730   p_align = std::max(p_align, Sec->Addralign);
731   if (p_type == PT_LOAD)
732     Sec->FirstInPtLoad = First;
733 }
734 
735 template <class ELFT>
736 static DefinedSynthetic *
737 addOptionalSynthetic(StringRef Name, OutputSection *Sec,
738                      typename ELFT::uint Val, uint8_t StOther = STV_HIDDEN) {
739   if (SymbolBody *S = Symtab<ELFT>::X->find(Name))
740     if (!S->isInCurrentDSO())
741       return cast<DefinedSynthetic>(
742           Symtab<ELFT>::X->addSynthetic(Name, Sec, Val, StOther)->body());
743   return nullptr;
744 }
745 
746 template <class ELFT>
747 static Symbol *addRegular(StringRef Name, InputSectionBase *Sec,
748                           typename ELFT::uint Value) {
749   // The linker generated symbols are added as STB_WEAK to allow user defined
750   // ones to override them.
751   return Symtab<ELFT>::X->addRegular(Name, STV_HIDDEN, STT_NOTYPE, Value,
752                                      /*Size=*/0, STB_WEAK, Sec,
753                                      /*File=*/nullptr);
754 }
755 
756 template <class ELFT>
757 static Symbol *addOptionalRegular(StringRef Name, InputSectionBase *IS,
758                                   typename ELFT::uint Value) {
759   SymbolBody *S = Symtab<ELFT>::X->find(Name);
760   if (!S)
761     return nullptr;
762   if (S->isInCurrentDSO())
763     return S->symbol();
764   return addRegular<ELFT>(Name, IS, Value);
765 }
766 
767 // The beginning and the ending of .rel[a].plt section are marked
768 // with __rel[a]_iplt_{start,end} symbols if it is a statically linked
769 // executable. The runtime needs these symbols in order to resolve
770 // all IRELATIVE relocs on startup. For dynamic executables, we don't
771 // need these symbols, since IRELATIVE relocs are resolved through GOT
772 // and PLT. For details, see http://www.airs.com/blog/archives/403.
773 template <class ELFT> void Writer<ELFT>::addRelIpltSymbols() {
774   if (In<ELFT>::DynSymTab)
775     return;
776   StringRef S = Config->Rela ? "__rela_iplt_start" : "__rel_iplt_start";
777   addOptionalRegular<ELFT>(S, In<ELFT>::RelaIplt, 0);
778 
779   S = Config->Rela ? "__rela_iplt_end" : "__rel_iplt_end";
780   addOptionalRegular<ELFT>(S, In<ELFT>::RelaIplt, -1);
781 }
782 
783 // The linker is expected to define some symbols depending on
784 // the linking result. This function defines such symbols.
785 template <class ELFT> void Writer<ELFT>::addReservedSymbols() {
786   if (Config->EMachine == EM_MIPS) {
787     // Define _gp for MIPS. st_value of _gp symbol will be updated by Writer
788     // so that it points to an absolute address which by default is relative
789     // to GOT. Default offset is 0x7ff0.
790     // See "Global Data Symbols" in Chapter 6 in the following document:
791     // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
792     ElfSym::MipsGp = Symtab<ELFT>::X->addAbsolute("_gp", STV_HIDDEN, STB_LOCAL);
793 
794     // On MIPS O32 ABI, _gp_disp is a magic symbol designates offset between
795     // start of function and 'gp' pointer into GOT. To simplify relocation
796     // calculation we assign _gp value to it and calculate corresponding
797     // relocations as relative to this value.
798     if (Symtab<ELFT>::X->find("_gp_disp"))
799       ElfSym::MipsGpDisp =
800           Symtab<ELFT>::X->addAbsolute("_gp_disp", STV_HIDDEN, STB_LOCAL);
801 
802     // The __gnu_local_gp is a magic symbol equal to the current value of 'gp'
803     // pointer. This symbol is used in the code generated by .cpload pseudo-op
804     // in case of using -mno-shared option.
805     // https://sourceware.org/ml/binutils/2004-12/msg00094.html
806     if (Symtab<ELFT>::X->find("__gnu_local_gp"))
807       ElfSym::MipsLocalGp =
808           Symtab<ELFT>::X->addAbsolute("__gnu_local_gp", STV_HIDDEN, STB_LOCAL);
809   }
810 
811   // In the assembly for 32 bit x86 the _GLOBAL_OFFSET_TABLE_ symbol
812   // is magical and is used to produce a R_386_GOTPC relocation.
813   // The R_386_GOTPC relocation value doesn't actually depend on the
814   // symbol value, so it could use an index of STN_UNDEF which, according
815   // to the spec, means the symbol value is 0.
816   // Unfortunately both gas and MC keep the _GLOBAL_OFFSET_TABLE_ symbol in
817   // the object file.
818   // The situation is even stranger on x86_64 where the assembly doesn't
819   // need the magical symbol, but gas still puts _GLOBAL_OFFSET_TABLE_ as
820   // an undefined symbol in the .o files.
821   // Given that the symbol is effectively unused, we just create a dummy
822   // hidden one to avoid the undefined symbol error.
823   Symtab<ELFT>::X->addIgnored("_GLOBAL_OFFSET_TABLE_");
824 
825   // __tls_get_addr is defined by the dynamic linker for dynamic ELFs. For
826   // static linking the linker is required to optimize away any references to
827   // __tls_get_addr, so it's not defined anywhere. Create a hidden definition
828   // to avoid the undefined symbol error. As usual special cases are ARM and
829   // MIPS - the libc for these targets defines __tls_get_addr itself because
830   // there are no TLS optimizations for these targets.
831   if (!In<ELFT>::DynSymTab &&
832       (Config->EMachine != EM_MIPS && Config->EMachine != EM_ARM))
833     Symtab<ELFT>::X->addIgnored("__tls_get_addr");
834 
835   // If linker script do layout we do not need to create any standart symbols.
836   if (ScriptConfig->HasSections)
837     return;
838 
839   // __ehdr_start is the location of ELF file headers.
840   addOptionalSynthetic<ELFT>("__ehdr_start", Out::ElfHeader, 0);
841 
842   auto Define = [](StringRef S, DefinedSynthetic *&Sym1,
843                    DefinedSynthetic *&Sym2) {
844     Sym1 = addOptionalSynthetic<ELFT>(S, nullptr, 0, STV_DEFAULT);
845     assert(S.startswith("_"));
846     S = S.substr(1);
847     Sym2 = addOptionalSynthetic<ELFT>(S, nullptr, 0, STV_DEFAULT);
848   };
849 
850   Define("_end", ElfSym::End, ElfSym::End2);
851   Define("_etext", ElfSym::Etext, ElfSym::Etext2);
852   Define("_edata", ElfSym::Edata, ElfSym::Edata2);
853 }
854 
855 // Sort input sections by section name suffixes for
856 // __attribute__((init_priority(N))).
857 template <class ELFT> static void sortInitFini(OutputSection *S) {
858   if (S)
859     reinterpret_cast<OutputSection *>(S)->sortInitFini();
860 }
861 
862 // Sort input sections by the special rule for .ctors and .dtors.
863 template <class ELFT> static void sortCtorsDtors(OutputSection *S) {
864   if (S)
865     reinterpret_cast<OutputSection *>(S)->sortCtorsDtors();
866 }
867 
868 // Sort input sections using the list provided by --symbol-ordering-file.
869 template <class ELFT>
870 static void sortBySymbolsOrder(ArrayRef<OutputSection *> OutputSections) {
871   if (Config->SymbolOrderingFile.empty())
872     return;
873 
874   // Build a map from symbols to their priorities. Symbols that didn't
875   // appear in the symbol ordering file have the lowest priority 0.
876   // All explicitly mentioned symbols have negative (higher) priorities.
877   DenseMap<StringRef, int> SymbolOrder;
878   int Priority = -Config->SymbolOrderingFile.size();
879   for (StringRef S : Config->SymbolOrderingFile)
880     SymbolOrder.insert({S, Priority++});
881 
882   // Build a map from sections to their priorities.
883   DenseMap<InputSectionBase *, int> SectionOrder;
884   for (elf::ObjectFile<ELFT> *File : Symtab<ELFT>::X->getObjectFiles()) {
885     for (SymbolBody *Body : File->getSymbols()) {
886       auto *D = dyn_cast<DefinedRegular>(Body);
887       if (!D || !D->Section)
888         continue;
889       int &Priority = SectionOrder[D->Section];
890       Priority = std::min(Priority, SymbolOrder.lookup(D->getName()));
891     }
892   }
893 
894   // Sort sections by priority.
895   for (OutputSection *Base : OutputSections)
896     if (auto *Sec = dyn_cast<OutputSection>(Base))
897       Sec->sort([&](InputSectionBase *S) { return SectionOrder.lookup(S); });
898 }
899 
900 template <class ELFT>
901 void Writer<ELFT>::forEachRelSec(std::function<void(InputSectionBase &)> Fn) {
902   for (InputSectionBase *IS : InputSections) {
903     if (!IS->Live)
904       continue;
905     // Scan all relocations. Each relocation goes through a series
906     // of tests to determine if it needs special treatment, such as
907     // creating GOT, PLT, copy relocations, etc.
908     // Note that relocations for non-alloc sections are directly
909     // processed by InputSection::relocateNonAlloc.
910     if (!(IS->Flags & SHF_ALLOC))
911       continue;
912     if (isa<InputSection>(IS) || isa<EhInputSection<ELFT>>(IS))
913       Fn(*IS);
914   }
915 }
916 
917 template <class ELFT> void Writer<ELFT>::createSections() {
918   for (InputSectionBase *IS : InputSections)
919     if (IS)
920       Factory.addInputSec<ELFT>(IS, getOutputSectionName(IS->Name));
921 
922   sortBySymbolsOrder<ELFT>(OutputSections);
923   sortInitFini<ELFT>(findSection(".init_array"));
924   sortInitFini<ELFT>(findSection(".fini_array"));
925   sortCtorsDtors<ELFT>(findSection(".ctors"));
926   sortCtorsDtors<ELFT>(findSection(".dtors"));
927 
928   for (OutputSection *Sec : OutputSections)
929     Sec->assignOffsets<ELFT>();
930 }
931 
932 template <class ELFT>
933 static bool canSharePtLoad(const OutputSection &S1, const OutputSection &S2) {
934   if (!(S1.Flags & SHF_ALLOC) || !(S2.Flags & SHF_ALLOC))
935     return false;
936 
937   bool S1IsWrite = S1.Flags & SHF_WRITE;
938   bool S2IsWrite = S2.Flags & SHF_WRITE;
939   if (S1IsWrite != S2IsWrite)
940     return false;
941 
942   if (!S1IsWrite)
943     return true; // RO and RX share a PT_LOAD with linker scripts.
944   return (S1.Flags & SHF_EXECINSTR) == (S2.Flags & SHF_EXECINSTR);
945 }
946 
947 template <class ELFT> void Writer<ELFT>::sortSections() {
948   // Don't sort if using -r. It is not necessary and we want to preserve the
949   // relative order for SHF_LINK_ORDER sections.
950   if (Config->Relocatable)
951     return;
952   if (!ScriptConfig->HasSections) {
953     std::stable_sort(OutputSections.begin(), OutputSections.end(),
954                      compareSectionsNonScript<ELFT>);
955     return;
956   }
957   Script<ELFT>::X->adjustSectionsBeforeSorting();
958 
959   // The order of the sections in the script is arbitrary and may not agree with
960   // compareSectionsNonScript. This means that we cannot easily define a
961   // strict weak ordering. To see why, consider a comparison of a section in the
962   // script and one not in the script. We have a two simple options:
963   // * Make them equivalent (a is not less than b, and b is not less than a).
964   //   The problem is then that equivalence has to be transitive and we can
965   //   have sections a, b and c with only b in a script and a less than c
966   //   which breaks this property.
967   // * Use compareSectionsNonScript. Given that the script order doesn't have
968   //   to match, we can end up with sections a, b, c, d where b and c are in the
969   //   script and c is compareSectionsNonScript less than b. In which case d
970   //   can be equivalent to c, a to b and d < a. As a concrete example:
971   //   .a (rx) # not in script
972   //   .b (rx) # in script
973   //   .c (ro) # in script
974   //   .d (ro) # not in script
975   //
976   // The way we define an order then is:
977   // *  First put script sections at the start and sort the script and
978   //    non-script sections independently.
979   // *  Move each non-script section to its preferred position. We try
980   //    to put each section in the last position where it it can share
981   //    a PT_LOAD.
982 
983   std::stable_sort(OutputSections.begin(), OutputSections.end(),
984                    compareSections<ELFT>);
985 
986   auto I = OutputSections.begin();
987   auto E = OutputSections.end();
988   auto NonScriptI =
989       std::find_if(OutputSections.begin(), E, [](OutputSection *S) {
990         return Script<ELFT>::X->getSectionIndex(S->Name) == INT_MAX;
991       });
992   while (NonScriptI != E) {
993     auto BestPos = std::max_element(
994         I, NonScriptI, [&](OutputSection *&A, OutputSection *&B) {
995           bool ACanSharePtLoad = canSharePtLoad<ELFT>(**NonScriptI, *A);
996           bool BCanSharePtLoad = canSharePtLoad<ELFT>(**NonScriptI, *B);
997           if (ACanSharePtLoad != BCanSharePtLoad)
998             return BCanSharePtLoad;
999 
1000           bool ACmp = compareSectionsNonScript<ELFT>(*NonScriptI, A);
1001           bool BCmp = compareSectionsNonScript<ELFT>(*NonScriptI, B);
1002           if (ACmp != BCmp)
1003             return BCmp; // FIXME: missing test
1004 
1005           size_t PosA = &A - &OutputSections[0];
1006           size_t PosB = &B - &OutputSections[0];
1007           return ACmp ? PosA > PosB : PosA < PosB;
1008         });
1009 
1010     // max_element only returns NonScriptI if the range is empty. If the range
1011     // is not empty we should consider moving the the element forward one
1012     // position.
1013     if (BestPos != NonScriptI &&
1014         !compareSectionsNonScript<ELFT>(*NonScriptI, *BestPos))
1015       ++BestPos;
1016     std::rotate(BestPos, NonScriptI, NonScriptI + 1);
1017     ++NonScriptI;
1018   }
1019 
1020   Script<ELFT>::X->adjustSectionsAfterSorting();
1021 }
1022 
1023 template <class ELFT>
1024 static void finalizeSynthetic(const std::vector<SyntheticSection *> &Sections) {
1025   for (SyntheticSection *SS : Sections)
1026     if (SS && SS->OutSec && !SS->empty()) {
1027       SS->finalizeContents();
1028       SS->OutSec->template assignOffsets<ELFT>();
1029     }
1030 }
1031 
1032 // We need to add input synthetic sections early in createSyntheticSections()
1033 // to make them visible from linkescript side. But not all sections are always
1034 // required to be in output. For example we don't need dynamic section content
1035 // sometimes. This function filters out such unused sections from output.
1036 template <class ELFT>
1037 static void removeUnusedSyntheticSections(std::vector<OutputSection *> &V) {
1038   // All input synthetic sections that can be empty are placed after
1039   // all regular ones. We iterate over them all and exit at first
1040   // non-synthetic.
1041   for (InputSectionBase *S : llvm::reverse(InputSections)) {
1042     SyntheticSection *SS = dyn_cast<SyntheticSection>(S);
1043     if (!SS)
1044       return;
1045     if (!SS->empty() || !SS->OutSec)
1046       continue;
1047 
1048     OutputSection *OutSec = cast<OutputSection>(SS->OutSec);
1049     OutSec->Sections.erase(
1050         std::find(OutSec->Sections.begin(), OutSec->Sections.end(), SS));
1051     // If there is no other sections in output section, remove it from output.
1052     if (OutSec->Sections.empty())
1053       V.erase(std::find(V.begin(), V.end(), OutSec));
1054   }
1055 }
1056 
1057 // Create output section objects and add them to OutputSections.
1058 template <class ELFT> void Writer<ELFT>::finalizeSections() {
1059   Out::DebugInfo = findSection(".debug_info");
1060   Out::PreinitArray = findSection(".preinit_array");
1061   Out::InitArray = findSection(".init_array");
1062   Out::FiniArray = findSection(".fini_array");
1063 
1064   // The linker needs to define SECNAME_start, SECNAME_end and SECNAME_stop
1065   // symbols for sections, so that the runtime can get the start and end
1066   // addresses of each section by section name. Add such symbols.
1067   if (!Config->Relocatable) {
1068     addStartEndSymbols();
1069     for (OutputSection *Sec : OutputSections)
1070       addStartStopSymbols(Sec);
1071   }
1072 
1073   // Add _DYNAMIC symbol. Unlike GNU gold, our _DYNAMIC symbol has no type.
1074   // It should be okay as no one seems to care about the type.
1075   // Even the author of gold doesn't remember why gold behaves that way.
1076   // https://sourceware.org/ml/binutils/2002-03/msg00360.html
1077   if (In<ELFT>::DynSymTab)
1078     addRegular<ELFT>("_DYNAMIC", In<ELFT>::Dynamic, 0);
1079 
1080   // Define __rel[a]_iplt_{start,end} symbols if needed.
1081   addRelIpltSymbols();
1082 
1083   // This responsible for splitting up .eh_frame section into
1084   // pieces. The relocation scan uses those peaces, so this has to be
1085   // earlier.
1086   finalizeSynthetic<ELFT>({In<ELFT>::EhFrame});
1087 
1088   // Scan relocations. This must be done after every symbol is declared so that
1089   // we can correctly decide if a dynamic relocation is needed.
1090   forEachRelSec(scanRelocations<ELFT>);
1091 
1092   if (In<ELFT>::Plt && !In<ELFT>::Plt->empty())
1093     In<ELFT>::Plt->addSymbols();
1094   if (In<ELFT>::Iplt && !In<ELFT>::Iplt->empty())
1095     In<ELFT>::Iplt->addSymbols();
1096 
1097   // Now that we have defined all possible global symbols including linker-
1098   // synthesized ones. Visit all symbols to give the finishing touches.
1099   for (Symbol *S : Symtab<ELFT>::X->getSymbols()) {
1100     SymbolBody *Body = S->body();
1101 
1102     if (!includeInSymtab<ELFT>(*Body))
1103       continue;
1104     if (In<ELFT>::SymTab)
1105       In<ELFT>::SymTab->addSymbol(Body);
1106 
1107     if (In<ELFT>::DynSymTab && S->includeInDynsym()) {
1108       In<ELFT>::DynSymTab->addSymbol(Body);
1109       if (auto *SS = dyn_cast<SharedSymbol>(Body))
1110         if (cast<SharedFile<ELFT>>(SS->File)->isNeeded())
1111           In<ELFT>::VerNeed->addSymbol(SS);
1112     }
1113   }
1114 
1115   // Do not proceed if there was an undefined symbol.
1116   if (ErrorCount)
1117     return;
1118 
1119   // So far we have added sections from input object files.
1120   // This function adds linker-created Out::* sections.
1121   addPredefinedSections();
1122   removeUnusedSyntheticSections<ELFT>(OutputSections);
1123 
1124   sortSections();
1125 
1126   // This is a bit of a hack. A value of 0 means undef, so we set it
1127   // to 1 t make __ehdr_start defined. The section number is not
1128   // particularly relevant.
1129   Out::ElfHeader->SectionIndex = 1;
1130 
1131   unsigned I = 1;
1132   for (OutputSection *Sec : OutputSections) {
1133     Sec->SectionIndex = I++;
1134     Sec->ShName = In<ELFT>::ShStrTab->addString(Sec->Name);
1135   }
1136 
1137   // Binary and relocatable output does not have PHDRS.
1138   // The headers have to be created before finalize as that can influence the
1139   // image base and the dynamic section on mips includes the image base.
1140   if (!Config->Relocatable && !Config->OFormatBinary) {
1141     Phdrs = Script<ELFT>::X->hasPhdrsCommands() ? Script<ELFT>::X->createPhdrs()
1142                                                 : createPhdrs();
1143     addPtArmExid(Phdrs);
1144     fixHeaders();
1145   }
1146 
1147   // Some architectures use small displacements for jump instructions.
1148   // It is linker's responsibility to create thunks containing long
1149   // jump instructions if jump targets are too far. Create thunks.
1150   if (Target->NeedsThunks)
1151     createThunks<ELFT>(OutputSections);
1152 
1153   // Fill other section headers. The dynamic table is finalized
1154   // at the end because some tags like RELSZ depend on result
1155   // of finalizing other sections.
1156   for (OutputSection *Sec : OutputSections)
1157     Sec->finalize<ELFT>();
1158 
1159   // Dynamic section must be the last one in this list and dynamic
1160   // symbol table section (DynSymTab) must be the first one.
1161   finalizeSynthetic<ELFT>(
1162       {In<ELFT>::DynSymTab, In<ELFT>::GnuHashTab, In<ELFT>::HashTab,
1163        In<ELFT>::SymTab,    In<ELFT>::ShStrTab,   In<ELFT>::StrTab,
1164        In<ELFT>::VerDef,    In<ELFT>::DynStrTab,  In<ELFT>::GdbIndex,
1165        In<ELFT>::Got,       In<ELFT>::MipsGot,    In<ELFT>::IgotPlt,
1166        In<ELFT>::GotPlt,    In<ELFT>::RelaDyn,    In<ELFT>::RelaIplt,
1167        In<ELFT>::RelaPlt,   In<ELFT>::Plt,        In<ELFT>::Iplt,
1168        In<ELFT>::Plt,       In<ELFT>::EhFrameHdr, In<ELFT>::VerSym,
1169        In<ELFT>::VerNeed,   In<ELFT>::Dynamic});
1170 }
1171 
1172 template <class ELFT> void Writer<ELFT>::addPredefinedSections() {
1173   // Add BSS sections.
1174   auto Add = [=](OutputSection *Sec) {
1175     if (!Sec->Sections.empty()) {
1176       Sec->assignOffsets<ELFT>();
1177       OutputSections.push_back(Sec);
1178     }
1179   };
1180   Add(Out::Bss);
1181   Add(Out::BssRelRo);
1182 
1183   // ARM ABI requires .ARM.exidx to be terminated by some piece of data.
1184   // We have the terminater synthetic section class. Add that at the end.
1185   auto *OS = dyn_cast_or_null<OutputSection>(findSection(".ARM.exidx"));
1186   if (OS && !OS->Sections.empty() && !Config->Relocatable)
1187     OS->addSection(make<ARMExidxSentinelSection<ELFT>>());
1188 }
1189 
1190 // The linker is expected to define SECNAME_start and SECNAME_end
1191 // symbols for a few sections. This function defines them.
1192 template <class ELFT> void Writer<ELFT>::addStartEndSymbols() {
1193   auto Define = [&](StringRef Start, StringRef End, OutputSection *OS) {
1194     // These symbols resolve to the image base if the section does not exist.
1195     // A special value -1 indicates end of the section.
1196     addOptionalSynthetic<ELFT>(Start, OS, 0);
1197     addOptionalSynthetic<ELFT>(End, OS, OS ? -1 : 0);
1198   };
1199 
1200   Define("__preinit_array_start", "__preinit_array_end", Out::PreinitArray);
1201   Define("__init_array_start", "__init_array_end", Out::InitArray);
1202   Define("__fini_array_start", "__fini_array_end", Out::FiniArray);
1203 
1204   if (OutputSection *Sec = findSection(".ARM.exidx"))
1205     Define("__exidx_start", "__exidx_end", Sec);
1206 }
1207 
1208 // If a section name is valid as a C identifier (which is rare because of
1209 // the leading '.'), linkers are expected to define __start_<secname> and
1210 // __stop_<secname> symbols. They are at beginning and end of the section,
1211 // respectively. This is not requested by the ELF standard, but GNU ld and
1212 // gold provide the feature, and used by many programs.
1213 template <class ELFT>
1214 void Writer<ELFT>::addStartStopSymbols(OutputSection *Sec) {
1215   StringRef S = Sec->Name;
1216   if (!isValidCIdentifier(S))
1217     return;
1218   addOptionalSynthetic<ELFT>(Saver.save("__start_" + S), Sec, 0, STV_DEFAULT);
1219   addOptionalSynthetic<ELFT>(Saver.save("__stop_" + S), Sec, -1, STV_DEFAULT);
1220 }
1221 
1222 template <class ELFT> OutputSection *Writer<ELFT>::findSection(StringRef Name) {
1223   for (OutputSection *Sec : OutputSections)
1224     if (Sec->Name == Name)
1225       return Sec;
1226   return nullptr;
1227 }
1228 
1229 template <class ELFT> static bool needsPtLoad(OutputSection *Sec) {
1230   if (!(Sec->Flags & SHF_ALLOC))
1231     return false;
1232 
1233   // Don't allocate VA space for TLS NOBITS sections. The PT_TLS PHDR is
1234   // responsible for allocating space for them, not the PT_LOAD that
1235   // contains the TLS initialization image.
1236   if (Sec->Flags & SHF_TLS && Sec->Type == SHT_NOBITS)
1237     return false;
1238   return true;
1239 }
1240 
1241 // Linker scripts are responsible for aligning addresses. Unfortunately, most
1242 // linker scripts are designed for creating two PT_LOADs only, one RX and one
1243 // RW. This means that there is no alignment in the RO to RX transition and we
1244 // cannot create a PT_LOAD there.
1245 template <class ELFT>
1246 static typename ELFT::uint computeFlags(typename ELFT::uint F) {
1247   if (Config->Omagic)
1248     return PF_R | PF_W | PF_X;
1249   if (Config->SingleRoRx && !(F & PF_W))
1250     return F | PF_X;
1251   return F;
1252 }
1253 
1254 // Decide which program headers to create and which sections to include in each
1255 // one.
1256 template <class ELFT> std::vector<PhdrEntry> Writer<ELFT>::createPhdrs() {
1257   std::vector<PhdrEntry> Ret;
1258   auto AddHdr = [&](unsigned Type, unsigned Flags) -> PhdrEntry * {
1259     Ret.emplace_back(Type, Flags);
1260     return &Ret.back();
1261   };
1262 
1263   // The first phdr entry is PT_PHDR which describes the program header itself.
1264   AddHdr(PT_PHDR, PF_R)->add(Out::ProgramHeaders);
1265 
1266   // PT_INTERP must be the second entry if exists.
1267   if (OutputSection *Sec = findSection(".interp"))
1268     AddHdr(PT_INTERP, Sec->getPhdrFlags())->add(Sec);
1269 
1270   // Add the first PT_LOAD segment for regular output sections.
1271   uintX_t Flags = computeFlags<ELFT>(PF_R);
1272   PhdrEntry *Load = AddHdr(PT_LOAD, Flags);
1273   for (OutputSection *Sec : OutputSections) {
1274     if (!(Sec->Flags & SHF_ALLOC))
1275       break;
1276     if (!needsPtLoad<ELFT>(Sec))
1277       continue;
1278 
1279     // Segments are contiguous memory regions that has the same attributes
1280     // (e.g. executable or writable). There is one phdr for each segment.
1281     // Therefore, we need to create a new phdr when the next section has
1282     // different flags or is loaded at a discontiguous address using AT linker
1283     // script command.
1284     uintX_t NewFlags = computeFlags<ELFT>(Sec->getPhdrFlags());
1285     if (Script<ELFT>::X->hasLMA(Sec->Name) || Flags != NewFlags) {
1286       Load = AddHdr(PT_LOAD, NewFlags);
1287       Flags = NewFlags;
1288     }
1289 
1290     Load->add(Sec);
1291   }
1292 
1293   // Add a TLS segment if any.
1294   PhdrEntry TlsHdr(PT_TLS, PF_R);
1295   for (OutputSection *Sec : OutputSections)
1296     if (Sec->Flags & SHF_TLS)
1297       TlsHdr.add(Sec);
1298   if (TlsHdr.First)
1299     Ret.push_back(std::move(TlsHdr));
1300 
1301   // Add an entry for .dynamic.
1302   if (In<ELFT>::DynSymTab)
1303     AddHdr(PT_DYNAMIC, In<ELFT>::Dynamic->OutSec->getPhdrFlags())
1304         ->add(In<ELFT>::Dynamic->OutSec);
1305 
1306   // PT_GNU_RELRO includes all sections that should be marked as
1307   // read-only by dynamic linker after proccessing relocations.
1308   PhdrEntry RelRo(PT_GNU_RELRO, PF_R);
1309   for (OutputSection *Sec : OutputSections)
1310     if (needsPtLoad<ELFT>(Sec) && isRelroSection<ELFT>(Sec))
1311       RelRo.add(Sec);
1312   if (RelRo.First)
1313     Ret.push_back(std::move(RelRo));
1314 
1315   // PT_GNU_EH_FRAME is a special section pointing on .eh_frame_hdr.
1316   if (!In<ELFT>::EhFrame->empty() && In<ELFT>::EhFrameHdr)
1317     AddHdr(PT_GNU_EH_FRAME, In<ELFT>::EhFrameHdr->OutSec->getPhdrFlags())
1318         ->add(In<ELFT>::EhFrameHdr->OutSec);
1319 
1320   // PT_OPENBSD_RANDOMIZE specifies the location and size of a part of the
1321   // memory image of the program that must be filled with random data before any
1322   // code in the object is executed.
1323   if (OutputSection *Sec = findSection(".openbsd.randomdata"))
1324     AddHdr(PT_OPENBSD_RANDOMIZE, Sec->getPhdrFlags())->add(Sec);
1325 
1326   // PT_GNU_STACK is a special section to tell the loader to make the
1327   // pages for the stack non-executable. If you really want an executable
1328   // stack, you can pass -z execstack, but that's not recommended for
1329   // security reasons.
1330   unsigned Perm;
1331   if (Config->ZExecstack)
1332     Perm = PF_R | PF_W | PF_X;
1333   else
1334     Perm = PF_R | PF_W;
1335   AddHdr(PT_GNU_STACK, Perm)->p_memsz = Config->ZStackSize;
1336 
1337   // PT_OPENBSD_WXNEEDED is a OpenBSD-specific header to mark the executable
1338   // is expected to perform W^X violations, such as calling mprotect(2) or
1339   // mmap(2) with PROT_WRITE | PROT_EXEC, which is prohibited by default on
1340   // OpenBSD.
1341   if (Config->ZWxneeded)
1342     AddHdr(PT_OPENBSD_WXNEEDED, PF_X);
1343 
1344   // Create one PT_NOTE per a group of contiguous .note sections.
1345   PhdrEntry *Note = nullptr;
1346   for (OutputSection *Sec : OutputSections) {
1347     if (Sec->Type == SHT_NOTE) {
1348       if (!Note || Script<ELFT>::X->hasLMA(Sec->Name))
1349         Note = AddHdr(PT_NOTE, PF_R);
1350       Note->add(Sec);
1351     } else {
1352       Note = nullptr;
1353     }
1354   }
1355   return Ret;
1356 }
1357 
1358 template <class ELFT>
1359 void Writer<ELFT>::addPtArmExid(std::vector<PhdrEntry> &Phdrs) {
1360   if (Config->EMachine != EM_ARM)
1361     return;
1362   auto I = std::find_if(
1363       OutputSections.begin(), OutputSections.end(),
1364       [](OutputSection *Sec) { return Sec->Type == SHT_ARM_EXIDX; });
1365   if (I == OutputSections.end())
1366     return;
1367 
1368   // PT_ARM_EXIDX is the ARM EHABI equivalent of PT_GNU_EH_FRAME
1369   PhdrEntry ARMExidx(PT_ARM_EXIDX, PF_R);
1370   ARMExidx.add(*I);
1371   Phdrs.push_back(ARMExidx);
1372 }
1373 
1374 // The first section of each PT_LOAD, the first section in PT_GNU_RELRO and the
1375 // first section after PT_GNU_RELRO have to be page aligned so that the dynamic
1376 // linker can set the permissions.
1377 template <class ELFT> void Writer<ELFT>::fixSectionAlignments() {
1378   for (const PhdrEntry &P : Phdrs)
1379     if (P.p_type == PT_LOAD && P.First)
1380       P.First->PageAlign = true;
1381 
1382   for (const PhdrEntry &P : Phdrs) {
1383     if (P.p_type != PT_GNU_RELRO)
1384       continue;
1385     if (P.First)
1386       P.First->PageAlign = true;
1387     // Find the first section after PT_GNU_RELRO. If it is in a PT_LOAD we
1388     // have to align it to a page.
1389     auto End = OutputSections.end();
1390     auto I = std::find(OutputSections.begin(), End, P.Last);
1391     if (I == End || (I + 1) == End)
1392       continue;
1393     OutputSection *Sec = *(I + 1);
1394     if (needsPtLoad<ELFT>(Sec))
1395       Sec->PageAlign = true;
1396   }
1397 }
1398 
1399 template <class ELFT>
1400 bool elf::allocateHeaders(std::vector<PhdrEntry> &Phdrs,
1401                           ArrayRef<OutputSection *> OutputSections,
1402                           uint64_t Min) {
1403   auto FirstPTLoad =
1404       std::find_if(Phdrs.begin(), Phdrs.end(),
1405                    [](const PhdrEntry &E) { return E.p_type == PT_LOAD; });
1406   if (FirstPTLoad == Phdrs.end())
1407     return false;
1408 
1409   uint64_t HeaderSize = getHeaderSize<ELFT>();
1410   if (HeaderSize > Min) {
1411     auto PhdrI =
1412         std::find_if(Phdrs.begin(), Phdrs.end(),
1413                      [](const PhdrEntry &E) { return E.p_type == PT_PHDR; });
1414     if (PhdrI != Phdrs.end())
1415       Phdrs.erase(PhdrI);
1416     return false;
1417   }
1418   Min = alignDown(Min - HeaderSize, Config->MaxPageSize);
1419 
1420   if (!ScriptConfig->HasSections)
1421     Config->ImageBase = Min = std::min(Min, Config->ImageBase);
1422 
1423   Out::ElfHeader->Addr = Min;
1424   Out::ProgramHeaders->Addr = Min + Out::ElfHeader->Size;
1425 
1426   if (Script<ELFT>::X->hasPhdrsCommands())
1427     return true;
1428 
1429   if (FirstPTLoad->First)
1430     for (OutputSection *Sec : OutputSections)
1431       if (Sec->FirstInPtLoad == FirstPTLoad->First)
1432         Sec->FirstInPtLoad = Out::ElfHeader;
1433   FirstPTLoad->First = Out::ElfHeader;
1434   if (!FirstPTLoad->Last)
1435     FirstPTLoad->Last = Out::ProgramHeaders;
1436   return true;
1437 }
1438 
1439 // We should set file offsets and VAs for elf header and program headers
1440 // sections. These are special, we do not include them into output sections
1441 // list, but have them to simplify the code.
1442 template <class ELFT> void Writer<ELFT>::fixHeaders() {
1443   Out::ProgramHeaders->Size = sizeof(Elf_Phdr) * Phdrs.size();
1444   // If the script has SECTIONS, assignAddresses will compute the values.
1445   if (ScriptConfig->HasSections)
1446     return;
1447 
1448   // When -T<section> option is specified, lower the base to make room for those
1449   // sections.
1450   uint64_t Min = -1;
1451   if (!Config->SectionStartMap.empty())
1452     for (const auto &P : Config->SectionStartMap)
1453       Min = std::min(Min, P.second);
1454 
1455   AllocateHeader = allocateHeaders<ELFT>(Phdrs, OutputSections, Min);
1456 }
1457 
1458 // Assign VAs (addresses at run-time) to output sections.
1459 template <class ELFT> void Writer<ELFT>::assignAddresses() {
1460   uintX_t VA = Config->ImageBase;
1461   if (AllocateHeader)
1462     VA += getHeaderSize<ELFT>();
1463   uintX_t ThreadBssOffset = 0;
1464   for (OutputSection *Sec : OutputSections) {
1465     uintX_t Alignment = Sec->Addralign;
1466     if (Sec->PageAlign)
1467       Alignment = std::max<uintX_t>(Alignment, Config->MaxPageSize);
1468 
1469     auto I = Config->SectionStartMap.find(Sec->Name);
1470     if (I != Config->SectionStartMap.end())
1471       VA = I->second;
1472 
1473     // We only assign VAs to allocated sections.
1474     if (needsPtLoad<ELFT>(Sec)) {
1475       VA = alignTo(VA, Alignment);
1476       Sec->Addr = VA;
1477       VA += Sec->Size;
1478     } else if (Sec->Flags & SHF_TLS && Sec->Type == SHT_NOBITS) {
1479       uintX_t TVA = VA + ThreadBssOffset;
1480       TVA = alignTo(TVA, Alignment);
1481       Sec->Addr = TVA;
1482       ThreadBssOffset = TVA - VA + Sec->Size;
1483     }
1484   }
1485 }
1486 
1487 // Adjusts the file alignment for a given output section and returns
1488 // its new file offset. The file offset must be the same with its
1489 // virtual address (modulo the page size) so that the loader can load
1490 // executables without any address adjustment.
1491 template <class ELFT, class uintX_t>
1492 static uintX_t getFileAlignment(uintX_t Off, OutputSection *Sec) {
1493   OutputSection *First = Sec->FirstInPtLoad;
1494   // If the section is not in a PT_LOAD, we just have to align it.
1495   if (!First)
1496     return alignTo(Off, Sec->Addralign);
1497 
1498   // The first section in a PT_LOAD has to have congruent offset and address
1499   // module the page size.
1500   if (Sec == First)
1501     return alignTo(Off, Config->MaxPageSize, Sec->Addr);
1502 
1503   // If two sections share the same PT_LOAD the file offset is calculated
1504   // using this formula: Off2 = Off1 + (VA2 - VA1).
1505   return First->Offset + Sec->Addr - First->Addr;
1506 }
1507 
1508 template <class ELFT, class uintX_t>
1509 static uintX_t setOffset(OutputSection *Sec, uintX_t Off) {
1510   if (Sec->Type == SHT_NOBITS) {
1511     Sec->Offset = Off;
1512     return Off;
1513   }
1514 
1515   Off = getFileAlignment<ELFT>(Off, Sec);
1516   Sec->Offset = Off;
1517   return Off + Sec->Size;
1518 }
1519 
1520 template <class ELFT> void Writer<ELFT>::assignFileOffsetsBinary() {
1521   uintX_t Off = 0;
1522   for (OutputSection *Sec : OutputSections)
1523     if (Sec->Flags & SHF_ALLOC)
1524       Off = setOffset<ELFT>(Sec, Off);
1525   FileSize = alignTo(Off, sizeof(uintX_t));
1526 }
1527 
1528 // Assign file offsets to output sections.
1529 template <class ELFT> void Writer<ELFT>::assignFileOffsets() {
1530   uintX_t Off = 0;
1531   Off = setOffset<ELFT>(Out::ElfHeader, Off);
1532   Off = setOffset<ELFT>(Out::ProgramHeaders, Off);
1533 
1534   for (OutputSection *Sec : OutputSections)
1535     Off = setOffset<ELFT>(Sec, Off);
1536 
1537   SectionHeaderOff = alignTo(Off, sizeof(uintX_t));
1538   FileSize = SectionHeaderOff + (OutputSections.size() + 1) * sizeof(Elf_Shdr);
1539 }
1540 
1541 // Finalize the program headers. We call this function after we assign
1542 // file offsets and VAs to all sections.
1543 template <class ELFT> void Writer<ELFT>::setPhdrs() {
1544   for (PhdrEntry &P : Phdrs) {
1545     OutputSection *First = P.First;
1546     OutputSection *Last = P.Last;
1547     if (First) {
1548       P.p_filesz = Last->Offset - First->Offset;
1549       if (Last->Type != SHT_NOBITS)
1550         P.p_filesz += Last->Size;
1551       P.p_memsz = Last->Addr + Last->Size - First->Addr;
1552       P.p_offset = First->Offset;
1553       P.p_vaddr = First->Addr;
1554       if (!P.HasLMA)
1555         P.p_paddr = First->getLMA();
1556     }
1557     if (P.p_type == PT_LOAD)
1558       P.p_align = Config->MaxPageSize;
1559     else if (P.p_type == PT_GNU_RELRO) {
1560       P.p_align = 1;
1561       // The glibc dynamic loader rounds the size down, so we need to round up
1562       // to protect the last page. This is a no-op on FreeBSD which always
1563       // rounds up.
1564       P.p_memsz = alignTo(P.p_memsz, Target->PageSize);
1565     }
1566 
1567     // The TLS pointer goes after PT_TLS. At least glibc will align it,
1568     // so round up the size to make sure the offsets are correct.
1569     if (P.p_type == PT_TLS) {
1570       Out::TlsPhdr = &P;
1571       if (P.p_memsz)
1572         P.p_memsz = alignTo(P.p_memsz, P.p_align);
1573     }
1574   }
1575 }
1576 
1577 // The entry point address is chosen in the following ways.
1578 //
1579 // 1. the '-e' entry command-line option;
1580 // 2. the ENTRY(symbol) command in a linker control script;
1581 // 3. the value of the symbol start, if present;
1582 // 4. the address of the first byte of the .text section, if present;
1583 // 5. the address 0.
1584 template <class ELFT> typename ELFT::uint Writer<ELFT>::getEntryAddr() {
1585   // Case 1, 2 or 3. As a special case, if the symbol is actually
1586   // a number, we'll use that number as an address.
1587   if (SymbolBody *B = Symtab<ELFT>::X->find(Config->Entry))
1588     return B->getVA<ELFT>();
1589   uint64_t Addr;
1590   if (!Config->Entry.getAsInteger(0, Addr))
1591     return Addr;
1592 
1593   // Case 4
1594   if (OutputSection *Sec = findSection(".text")) {
1595     if (Config->WarnMissingEntry)
1596       warn("cannot find entry symbol " + Config->Entry + "; defaulting to 0x" +
1597            utohexstr(Sec->Addr));
1598     return Sec->Addr;
1599   }
1600 
1601   // Case 5
1602   if (Config->WarnMissingEntry)
1603     warn("cannot find entry symbol " + Config->Entry +
1604          "; not setting start address");
1605   return 0;
1606 }
1607 
1608 template <class ELFT> static uint8_t getELFEncoding() {
1609   if (ELFT::TargetEndianness == llvm::support::little)
1610     return ELFDATA2LSB;
1611   return ELFDATA2MSB;
1612 }
1613 
1614 static uint16_t getELFType() {
1615   if (Config->pic())
1616     return ET_DYN;
1617   if (Config->Relocatable)
1618     return ET_REL;
1619   return ET_EXEC;
1620 }
1621 
1622 // This function is called after we have assigned address and size
1623 // to each section. This function fixes some predefined
1624 // symbol values that depend on section address and size.
1625 template <class ELFT> void Writer<ELFT>::fixPredefinedSymbols() {
1626   auto Set = [](DefinedSynthetic *S1, DefinedSynthetic *S2, OutputSection *Sec,
1627                 uint64_t Value) {
1628     if (S1) {
1629       S1->Section = Sec;
1630       S1->Value = Value;
1631     }
1632     if (S2) {
1633       S2->Section = Sec;
1634       S2->Value = Value;
1635     }
1636   };
1637 
1638   // _etext is the first location after the last read-only loadable segment.
1639   // _edata is the first location after the last read-write loadable segment.
1640   // _end is the first location after the uninitialized data region.
1641   PhdrEntry *Last = nullptr;
1642   PhdrEntry *LastRO = nullptr;
1643   PhdrEntry *LastRW = nullptr;
1644   for (PhdrEntry &P : Phdrs) {
1645     if (P.p_type != PT_LOAD)
1646       continue;
1647     Last = &P;
1648     if (P.p_flags & PF_W)
1649       LastRW = &P;
1650     else
1651       LastRO = &P;
1652   }
1653   if (Last)
1654     Set(ElfSym::End, ElfSym::End2, Last->First, Last->p_memsz);
1655   if (LastRO)
1656     Set(ElfSym::Etext, ElfSym::Etext2, LastRO->First, LastRO->p_filesz);
1657   if (LastRW)
1658     Set(ElfSym::Edata, ElfSym::Edata2, LastRW->First, LastRW->p_filesz);
1659 
1660   // Setup MIPS _gp_disp/__gnu_local_gp symbols which should
1661   // be equal to the _gp symbol's value.
1662   if (Config->EMachine == EM_MIPS) {
1663     if (!ElfSym::MipsGp->Value) {
1664       // Find GP-relative section with the lowest address
1665       // and use this address to calculate default _gp value.
1666       uintX_t Gp = -1;
1667       for (const OutputSection *OS : OutputSections)
1668         if ((OS->Flags & SHF_MIPS_GPREL) && OS->Addr < Gp)
1669           Gp = OS->Addr;
1670       if (Gp != (uintX_t)-1)
1671         ElfSym::MipsGp->Value = Gp + 0x7ff0;
1672     }
1673     if (ElfSym::MipsGpDisp)
1674       ElfSym::MipsGpDisp->Value = ElfSym::MipsGp->Value;
1675     if (ElfSym::MipsLocalGp)
1676       ElfSym::MipsLocalGp->Value = ElfSym::MipsGp->Value;
1677   }
1678 }
1679 
1680 template <class ELFT> void Writer<ELFT>::writeHeader() {
1681   uint8_t *Buf = Buffer->getBufferStart();
1682   memcpy(Buf, "\177ELF", 4);
1683 
1684   // Write the ELF header.
1685   auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
1686   EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
1687   EHdr->e_ident[EI_DATA] = getELFEncoding<ELFT>();
1688   EHdr->e_ident[EI_VERSION] = EV_CURRENT;
1689   EHdr->e_ident[EI_OSABI] = Config->OSABI;
1690   EHdr->e_type = getELFType();
1691   EHdr->e_machine = Config->EMachine;
1692   EHdr->e_version = EV_CURRENT;
1693   EHdr->e_entry = getEntryAddr();
1694   EHdr->e_shoff = SectionHeaderOff;
1695   EHdr->e_ehsize = sizeof(Elf_Ehdr);
1696   EHdr->e_phnum = Phdrs.size();
1697   EHdr->e_shentsize = sizeof(Elf_Shdr);
1698   EHdr->e_shnum = OutputSections.size() + 1;
1699   EHdr->e_shstrndx = In<ELFT>::ShStrTab->OutSec->SectionIndex;
1700 
1701   if (Config->EMachine == EM_ARM)
1702     // We don't currently use any features incompatible with EF_ARM_EABI_VER5,
1703     // but we don't have any firm guarantees of conformance. Linux AArch64
1704     // kernels (as of 2016) require an EABI version to be set.
1705     EHdr->e_flags = EF_ARM_EABI_VER5;
1706   else if (Config->EMachine == EM_MIPS)
1707     EHdr->e_flags = getMipsEFlags<ELFT>();
1708 
1709   if (!Config->Relocatable) {
1710     EHdr->e_phoff = sizeof(Elf_Ehdr);
1711     EHdr->e_phentsize = sizeof(Elf_Phdr);
1712   }
1713 
1714   // Write the program header table.
1715   auto *HBuf = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
1716   for (PhdrEntry &P : Phdrs) {
1717     HBuf->p_type = P.p_type;
1718     HBuf->p_flags = P.p_flags;
1719     HBuf->p_offset = P.p_offset;
1720     HBuf->p_vaddr = P.p_vaddr;
1721     HBuf->p_paddr = P.p_paddr;
1722     HBuf->p_filesz = P.p_filesz;
1723     HBuf->p_memsz = P.p_memsz;
1724     HBuf->p_align = P.p_align;
1725     ++HBuf;
1726   }
1727 
1728   // Write the section header table. Note that the first table entry is null.
1729   auto *SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
1730   for (OutputSection *Sec : OutputSections)
1731     Sec->writeHeaderTo<ELFT>(++SHdrs);
1732 }
1733 
1734 // Removes a given file asynchronously. This is a performance hack,
1735 // so remove this when operating systems are improved.
1736 //
1737 // On Linux (and probably on other Unix-like systems), unlink(2) is a
1738 // noticeably slow system call. As of 2016, unlink takes 250
1739 // milliseconds to remove a 1 GB file on ext4 filesystem on my machine.
1740 //
1741 // To create a new result file, we first remove existing file. So, if
1742 // you repeatedly link a 1 GB program in a regular compile-link-debug
1743 // cycle, every cycle wastes 250 milliseconds only to remove a file.
1744 // Since LLD can link a 1 GB binary in about 5 seconds, that waste
1745 // actually counts.
1746 //
1747 // This function spawns a background thread to call unlink.
1748 // The calling thread returns almost immediately.
1749 static void unlinkAsync(StringRef Path) {
1750   if (!Config->Threads || !sys::fs::exists(Config->OutputFile))
1751     return;
1752 
1753   // First, rename Path to avoid race condition. We cannot remove
1754   // Path from a different thread because we are now going to create
1755   // Path as a new file. If we do that in a different thread, the new
1756   // thread can remove the new file.
1757   SmallString<128> TempPath;
1758   if (sys::fs::createUniqueFile(Path + "tmp%%%%%%%%", TempPath))
1759     return;
1760   if (sys::fs::rename(Path, TempPath)) {
1761     sys::fs::remove(TempPath);
1762     return;
1763   }
1764 
1765   // Remove TempPath in background.
1766   std::thread([=] { ::remove(TempPath.str().str().c_str()); }).detach();
1767 }
1768 
1769 // Open a result file.
1770 template <class ELFT> void Writer<ELFT>::openFile() {
1771   unlinkAsync(Config->OutputFile);
1772   ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
1773       FileOutputBuffer::create(Config->OutputFile, FileSize,
1774                                FileOutputBuffer::F_executable);
1775 
1776   if (auto EC = BufferOrErr.getError())
1777     error("failed to open " + Config->OutputFile + ": " + EC.message());
1778   else
1779     Buffer = std::move(*BufferOrErr);
1780 }
1781 
1782 template <class ELFT> void Writer<ELFT>::writeSectionsBinary() {
1783   uint8_t *Buf = Buffer->getBufferStart();
1784   for (OutputSection *Sec : OutputSections)
1785     if (Sec->Flags & SHF_ALLOC)
1786       Sec->writeTo<ELFT>(Buf + Sec->Offset);
1787 }
1788 
1789 // Write section contents to a mmap'ed file.
1790 template <class ELFT> void Writer<ELFT>::writeSections() {
1791   uint8_t *Buf = Buffer->getBufferStart();
1792 
1793   // PPC64 needs to process relocations in the .opd section
1794   // before processing relocations in code-containing sections.
1795   Out::Opd = findSection(".opd");
1796   if (Out::Opd) {
1797     Out::OpdBuf = Buf + Out::Opd->Offset;
1798     Out::Opd->template writeTo<ELFT>(Buf + Out::Opd->Offset);
1799   }
1800 
1801   OutputSection *EhFrameHdr =
1802       In<ELFT>::EhFrameHdr ? In<ELFT>::EhFrameHdr->OutSec : nullptr;
1803 
1804   // In -r or -emit-relocs mode, write the relocation sections first as in
1805   // ELf_Rel targets we might find out that we need to modify the relocated
1806   // section while doing it.
1807   for (OutputSection *Sec : OutputSections)
1808     if (Sec->Type == SHT_REL || Sec->Type == SHT_RELA)
1809       Sec->writeTo<ELFT>(Buf + Sec->Offset);
1810 
1811   for (OutputSection *Sec : OutputSections)
1812     if (Sec != Out::Opd && Sec != EhFrameHdr && Sec->Type != SHT_REL &&
1813         Sec->Type != SHT_RELA)
1814       Sec->writeTo<ELFT>(Buf + Sec->Offset);
1815 
1816   // The .eh_frame_hdr depends on .eh_frame section contents, therefore
1817   // it should be written after .eh_frame is written.
1818   if (EhFrameHdr)
1819     EhFrameHdr->writeTo<ELFT>(Buf + EhFrameHdr->Offset);
1820 }
1821 
1822 template <class ELFT> void Writer<ELFT>::writeBuildId() {
1823   if (!In<ELFT>::BuildId || !In<ELFT>::BuildId->OutSec)
1824     return;
1825 
1826   // Compute a hash of all sections of the output file.
1827   uint8_t *Start = Buffer->getBufferStart();
1828   uint8_t *End = Start + FileSize;
1829   In<ELFT>::BuildId->writeBuildId({Start, End});
1830 }
1831 
1832 template void elf::writeResult<ELF32LE>();
1833 template void elf::writeResult<ELF32BE>();
1834 template void elf::writeResult<ELF64LE>();
1835 template void elf::writeResult<ELF64BE>();
1836 
1837 template bool elf::allocateHeaders<ELF32LE>(std::vector<PhdrEntry> &,
1838                                             ArrayRef<OutputSection *>,
1839                                             uint64_t);
1840 template bool elf::allocateHeaders<ELF32BE>(std::vector<PhdrEntry> &,
1841                                             ArrayRef<OutputSection *>,
1842                                             uint64_t);
1843 template bool elf::allocateHeaders<ELF64LE>(std::vector<PhdrEntry> &,
1844                                             ArrayRef<OutputSection *>,
1845                                             uint64_t);
1846 template bool elf::allocateHeaders<ELF64BE>(std::vector<PhdrEntry> &,
1847                                             ArrayRef<OutputSection *>,
1848                                             uint64_t);
1849 
1850 template bool elf::isRelroSection<ELF32LE>(const OutputSection *);
1851 template bool elf::isRelroSection<ELF32BE>(const OutputSection *);
1852 template bool elf::isRelroSection<ELF64LE>(const OutputSection *);
1853 template bool elf::isRelroSection<ELF64BE>(const OutputSection *);
1854