xref: /llvm-project-15.0.7/lld/ELF/Writer.cpp (revision 8589e10c)
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<ELFT>>(&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<ELFT>>(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->addLocal(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     InputSection *IS = nullptr;
531     if (!Sec->Sections.empty())
532       IS = Sec->Sections[0];
533     if (!IS || isa<SyntheticSection>(IS) || IS->Type == SHT_REL ||
534         IS->Type == SHT_RELA)
535       continue;
536     auto *B = new (BAlloc)
537         DefinedRegular<ELFT>("", /*IsLocal=*/true, /*StOther*/ 0, STT_SECTION,
538                              /*Value*/ 0, /*Size*/ 0, IS, nullptr);
539 
540     In<ELFT>::SymTab->addLocal(B);
541   }
542 }
543 
544 // PPC64 has a number of special SHT_PROGBITS+SHF_ALLOC+SHF_WRITE sections that
545 // we would like to make sure appear is a specific order to maximize their
546 // coverage by a single signed 16-bit offset from the TOC base pointer.
547 // Conversely, the special .tocbss section should be first among all SHT_NOBITS
548 // sections. This will put it next to the loaded special PPC64 sections (and,
549 // thus, within reach of the TOC base pointer).
550 static int getPPC64SectionRank(StringRef SectionName) {
551   return StringSwitch<int>(SectionName)
552       .Case(".tocbss", 0)
553       .Case(".branch_lt", 2)
554       .Case(".toc", 3)
555       .Case(".toc1", 4)
556       .Case(".opd", 5)
557       .Default(1);
558 }
559 
560 // All sections with SHF_MIPS_GPREL flag should be grouped together
561 // because data in these sections is addressable with a gp relative address.
562 static int getMipsSectionRank(const OutputSection *S) {
563   if ((S->Flags & SHF_MIPS_GPREL) == 0)
564     return 0;
565   if (S->Name == ".got")
566     return 1;
567   return 2;
568 }
569 
570 // Today's loaders have a feature to make segments read-only after
571 // processing dynamic relocations to enhance security. PT_GNU_RELRO
572 // is defined for that.
573 //
574 // This function returns true if a section needs to be put into a
575 // PT_GNU_RELRO segment.
576 template <class ELFT> bool elf::isRelroSection(const OutputSection *Sec) {
577   if (!Config->ZRelro)
578     return false;
579 
580   uint64_t Flags = Sec->Flags;
581   if (!(Flags & SHF_ALLOC) || !(Flags & SHF_WRITE))
582     return false;
583   if (Flags & SHF_TLS)
584     return true;
585 
586   uint32_t Type = Sec->Type;
587   if (Type == SHT_INIT_ARRAY || Type == SHT_FINI_ARRAY ||
588       Type == SHT_PREINIT_ARRAY)
589     return true;
590 
591   if (Sec == In<ELFT>::GotPlt->OutSec)
592     return Config->ZNow;
593   if (Sec == In<ELFT>::Dynamic->OutSec)
594     return true;
595   if (In<ELFT>::Got && Sec == In<ELFT>::Got->OutSec)
596     return true;
597   if (Sec == Out::BssRelRo)
598     return true;
599 
600   StringRef S = Sec->Name;
601   return S == ".data.rel.ro" || S == ".ctors" || S == ".dtors" || S == ".jcr" ||
602          S == ".eh_frame" || S == ".openbsd.randomdata";
603 }
604 
605 template <class ELFT>
606 static bool compareSectionsNonScript(const OutputSection *A,
607                                      const OutputSection *B) {
608   // Put .interp first because some loaders want to see that section
609   // on the first page of the executable file when loaded into memory.
610   bool AIsInterp = A->Name == ".interp";
611   bool BIsInterp = B->Name == ".interp";
612   if (AIsInterp != BIsInterp)
613     return AIsInterp;
614 
615   // Allocatable sections go first to reduce the total PT_LOAD size and
616   // so debug info doesn't change addresses in actual code.
617   bool AIsAlloc = A->Flags & SHF_ALLOC;
618   bool BIsAlloc = B->Flags & SHF_ALLOC;
619   if (AIsAlloc != BIsAlloc)
620     return AIsAlloc;
621 
622   // We don't have any special requirements for the relative order of two non
623   // allocatable sections.
624   if (!AIsAlloc)
625     return false;
626 
627   // We want to put section specified by -T option first, so we
628   // can start assigning VA starting from them later.
629   auto AAddrSetI = Config->SectionStartMap.find(A->Name);
630   auto BAddrSetI = Config->SectionStartMap.find(B->Name);
631   bool AHasAddrSet = AAddrSetI != Config->SectionStartMap.end();
632   bool BHasAddrSet = BAddrSetI != Config->SectionStartMap.end();
633   if (AHasAddrSet != BHasAddrSet)
634     return AHasAddrSet;
635   if (AHasAddrSet)
636     return AAddrSetI->second < BAddrSetI->second;
637 
638   // We want the read only sections first so that they go in the PT_LOAD
639   // covering the program headers at the start of the file.
640   bool AIsWritable = A->Flags & SHF_WRITE;
641   bool BIsWritable = B->Flags & SHF_WRITE;
642   if (AIsWritable != BIsWritable)
643     return BIsWritable;
644 
645   if (!Config->SingleRoRx) {
646     // For a corresponding reason, put non exec sections first (the program
647     // header PT_LOAD is not executable).
648     // We only do that if we are not using linker scripts, since with linker
649     // scripts ro and rx sections are in the same PT_LOAD, so their relative
650     // order is not important. The same applies for -no-rosegment.
651     bool AIsExec = A->Flags & SHF_EXECINSTR;
652     bool BIsExec = B->Flags & SHF_EXECINSTR;
653     if (AIsExec != BIsExec)
654       return BIsExec;
655   }
656 
657   // If we got here we know that both A and B are in the same PT_LOAD.
658 
659   bool AIsTls = A->Flags & SHF_TLS;
660   bool BIsTls = B->Flags & SHF_TLS;
661   bool AIsNoBits = A->Type == SHT_NOBITS;
662   bool BIsNoBits = B->Type == SHT_NOBITS;
663 
664   // The first requirement we have is to put (non-TLS) nobits sections last. The
665   // reason is that the only thing the dynamic linker will see about them is a
666   // p_memsz that is larger than p_filesz. Seeing that it zeros the end of the
667   // PT_LOAD, so that has to correspond to the nobits sections.
668   bool AIsNonTlsNoBits = AIsNoBits && !AIsTls;
669   bool BIsNonTlsNoBits = BIsNoBits && !BIsTls;
670   if (AIsNonTlsNoBits != BIsNonTlsNoBits)
671     return BIsNonTlsNoBits;
672 
673   // We place nobits RelRo sections before plain r/w ones, and non-nobits RelRo
674   // sections after r/w ones, so that the RelRo sections are contiguous.
675   bool AIsRelRo = isRelroSection<ELFT>(A);
676   bool BIsRelRo = isRelroSection<ELFT>(B);
677   if (AIsRelRo != BIsRelRo)
678     return AIsNonTlsNoBits ? AIsRelRo : BIsRelRo;
679 
680   // The TLS initialization block needs to be a single contiguous block in a R/W
681   // PT_LOAD, so stick TLS sections directly before the other RelRo R/W
682   // sections. The TLS NOBITS sections are placed here as they don't take up
683   // virtual address space in the PT_LOAD.
684   if (AIsTls != BIsTls)
685     return AIsTls;
686 
687   // Within the TLS initialization block, the non-nobits sections need to appear
688   // first.
689   if (AIsNoBits != BIsNoBits)
690     return BIsNoBits;
691 
692   // Some architectures have additional ordering restrictions for sections
693   // within the same PT_LOAD.
694   if (Config->EMachine == EM_PPC64)
695     return getPPC64SectionRank(A->Name) < getPPC64SectionRank(B->Name);
696   if (Config->EMachine == EM_MIPS)
697     return getMipsSectionRank(A) < getMipsSectionRank(B);
698 
699   return false;
700 }
701 
702 // Output section ordering is determined by this function.
703 template <class ELFT>
704 static bool compareSections(const OutputSection *A, const OutputSection *B) {
705   // For now, put sections mentioned in a linker script first.
706   int AIndex = Script<ELFT>::X->getSectionIndex(A->Name);
707   int BIndex = Script<ELFT>::X->getSectionIndex(B->Name);
708   bool AInScript = AIndex != INT_MAX;
709   bool BInScript = BIndex != INT_MAX;
710   if (AInScript != BInScript)
711     return AInScript;
712   // If both are in the script, use that order.
713   if (AInScript)
714     return AIndex < BIndex;
715 
716   return compareSectionsNonScript<ELFT>(A, B);
717 }
718 
719 // Program header entry
720 PhdrEntry::PhdrEntry(unsigned Type, unsigned Flags) {
721   p_type = Type;
722   p_flags = Flags;
723 }
724 
725 void PhdrEntry::add(OutputSection *Sec) {
726   Last = Sec;
727   if (!First)
728     First = Sec;
729   p_align = std::max(p_align, Sec->Addralign);
730   if (p_type == PT_LOAD)
731     Sec->FirstInPtLoad = First;
732 }
733 
734 template <class ELFT>
735 static DefinedSynthetic *
736 addOptionalSynthetic(StringRef Name, OutputSection *Sec,
737                      typename ELFT::uint Val, uint8_t StOther = STV_HIDDEN) {
738   if (SymbolBody *S = Symtab<ELFT>::X->find(Name))
739     if (!S->isInCurrentDSO())
740       return cast<DefinedSynthetic>(
741           Symtab<ELFT>::X->addSynthetic(Name, Sec, Val, StOther)->body());
742   return nullptr;
743 }
744 
745 template <class ELFT>
746 static Symbol *addRegular(StringRef Name, InputSectionBase *Sec,
747                           typename ELFT::uint Value) {
748   // The linker generated symbols are added as STB_WEAK to allow user defined
749   // ones to override them.
750   return Symtab<ELFT>::X->addRegular(Name, STV_HIDDEN, STT_NOTYPE, Value,
751                                      /*Size=*/0, STB_WEAK, Sec,
752                                      /*File=*/nullptr);
753 }
754 
755 template <class ELFT>
756 static Symbol *addOptionalRegular(StringRef Name, InputSectionBase *IS,
757                                   typename ELFT::uint Value) {
758   SymbolBody *S = Symtab<ELFT>::X->find(Name);
759   if (!S)
760     return nullptr;
761   if (S->isInCurrentDSO())
762     return S->symbol();
763   return addRegular<ELFT>(Name, IS, Value);
764 }
765 
766 // The beginning and the ending of .rel[a].plt section are marked
767 // with __rel[a]_iplt_{start,end} symbols if it is a statically linked
768 // executable. The runtime needs these symbols in order to resolve
769 // all IRELATIVE relocs on startup. For dynamic executables, we don't
770 // need these symbols, since IRELATIVE relocs are resolved through GOT
771 // and PLT. For details, see http://www.airs.com/blog/archives/403.
772 template <class ELFT> void Writer<ELFT>::addRelIpltSymbols() {
773   if (In<ELFT>::DynSymTab)
774     return;
775   StringRef S = Config->Rela ? "__rela_iplt_start" : "__rel_iplt_start";
776   addOptionalRegular<ELFT>(S, In<ELFT>::RelaIplt, 0);
777 
778   S = Config->Rela ? "__rela_iplt_end" : "__rel_iplt_end";
779   addOptionalRegular<ELFT>(S, In<ELFT>::RelaIplt, -1);
780 }
781 
782 // The linker is expected to define some symbols depending on
783 // the linking result. This function defines such symbols.
784 template <class ELFT> void Writer<ELFT>::addReservedSymbols() {
785   if (Config->EMachine == EM_MIPS) {
786     // Define _gp for MIPS. st_value of _gp symbol will be updated by Writer
787     // so that it points to an absolute address which by default is relative
788     // to GOT. Default offset is 0x7ff0.
789     // See "Global Data Symbols" in Chapter 6 in the following document:
790     // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
791     ElfSym<ELFT>::MipsGp =
792         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<ELFT>::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<ELFT>::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   ElfSym<ELFT>::EhdrStart =
841       addOptionalSynthetic<ELFT>("__ehdr_start", Out::ElfHeader, 0);
842 
843   auto Define = [](StringRef S, DefinedSynthetic *&Sym1,
844                    DefinedSynthetic *&Sym2) {
845     Sym1 = addOptionalSynthetic<ELFT>(S, nullptr, 0, STV_DEFAULT);
846     assert(S.startswith("_"));
847     S = S.substr(1);
848     Sym2 = addOptionalSynthetic<ELFT>(S, nullptr, 0, STV_DEFAULT);
849   };
850 
851   Define("_end", ElfSym<ELFT>::End, ElfSym<ELFT>::End2);
852   Define("_etext", ElfSym<ELFT>::Etext, ElfSym<ELFT>::Etext2);
853   Define("_edata", ElfSym<ELFT>::Edata, ElfSym<ELFT>::Edata2);
854 }
855 
856 // Sort input sections by section name suffixes for
857 // __attribute__((init_priority(N))).
858 template <class ELFT> static void sortInitFini(OutputSection *S) {
859   if (S)
860     reinterpret_cast<OutputSection *>(S)->sortInitFini();
861 }
862 
863 // Sort input sections by the special rule for .ctors and .dtors.
864 template <class ELFT> static void sortCtorsDtors(OutputSection *S) {
865   if (S)
866     reinterpret_cast<OutputSection *>(S)->sortCtorsDtors();
867 }
868 
869 // Sort input sections using the list provided by --symbol-ordering-file.
870 template <class ELFT>
871 static void sortBySymbolsOrder(ArrayRef<OutputSection *> OutputSections) {
872   if (Config->SymbolOrderingFile.empty())
873     return;
874 
875   // Build a map from symbols to their priorities. Symbols that didn't
876   // appear in the symbol ordering file have the lowest priority 0.
877   // All explicitly mentioned symbols have negative (higher) priorities.
878   DenseMap<StringRef, int> SymbolOrder;
879   int Priority = -Config->SymbolOrderingFile.size();
880   for (StringRef S : Config->SymbolOrderingFile)
881     SymbolOrder.insert({S, Priority++});
882 
883   // Build a map from sections to their priorities.
884   DenseMap<InputSectionBase *, int> SectionOrder;
885   for (elf::ObjectFile<ELFT> *File : Symtab<ELFT>::X->getObjectFiles()) {
886     for (SymbolBody *Body : File->getSymbols()) {
887       auto *D = dyn_cast<DefinedRegular<ELFT>>(Body);
888       if (!D || !D->Section)
889         continue;
890       int &Priority = SectionOrder[D->Section];
891       Priority = std::min(Priority, SymbolOrder.lookup(D->getName()));
892     }
893   }
894 
895   // Sort sections by priority.
896   for (OutputSection *Base : OutputSections)
897     if (auto *Sec = dyn_cast<OutputSection>(Base))
898       Sec->sort([&](InputSectionBase *S) { return SectionOrder.lookup(S); });
899 }
900 
901 template <class ELFT>
902 void Writer<ELFT>::forEachRelSec(std::function<void(InputSectionBase &)> Fn) {
903   for (InputSectionBase *IS : InputSections) {
904     if (!IS->Live)
905       continue;
906     // Scan all relocations. Each relocation goes through a series
907     // of tests to determine if it needs special treatment, such as
908     // creating GOT, PLT, copy relocations, etc.
909     // Note that relocations for non-alloc sections are directly
910     // processed by InputSection::relocateNonAlloc.
911     if (!(IS->Flags & SHF_ALLOC))
912       continue;
913     if (isa<InputSection>(IS) || isa<EhInputSection<ELFT>>(IS))
914       Fn(*IS);
915   }
916 }
917 
918 template <class ELFT> void Writer<ELFT>::createSections() {
919   for (InputSectionBase *IS : InputSections)
920     if (IS)
921       Factory.addInputSec<ELFT>(IS, getOutputSectionName(IS->Name));
922 
923   sortBySymbolsOrder<ELFT>(OutputSections);
924   sortInitFini<ELFT>(findSection(".init_array"));
925   sortInitFini<ELFT>(findSection(".fini_array"));
926   sortCtorsDtors<ELFT>(findSection(".ctors"));
927   sortCtorsDtors<ELFT>(findSection(".dtors"));
928 
929   for (OutputSection *Sec : OutputSections)
930     Sec->assignOffsets<ELFT>();
931 }
932 
933 template <class ELFT>
934 static bool canSharePtLoad(const OutputSection &S1, const OutputSection &S2) {
935   if (!(S1.Flags & SHF_ALLOC) || !(S2.Flags & SHF_ALLOC))
936     return false;
937 
938   bool S1IsWrite = S1.Flags & SHF_WRITE;
939   bool S2IsWrite = S2.Flags & SHF_WRITE;
940   if (S1IsWrite != S2IsWrite)
941     return false;
942 
943   if (!S1IsWrite)
944     return true; // RO and RX share a PT_LOAD with linker scripts.
945   return (S1.Flags & SHF_EXECINSTR) == (S2.Flags & SHF_EXECINSTR);
946 }
947 
948 template <class ELFT> void Writer<ELFT>::sortSections() {
949   // Don't sort if using -r. It is not necessary and we want to preserve the
950   // relative order for SHF_LINK_ORDER sections.
951   if (Config->Relocatable)
952     return;
953   if (!ScriptConfig->HasSections) {
954     std::stable_sort(OutputSections.begin(), OutputSections.end(),
955                      compareSectionsNonScript<ELFT>);
956     return;
957   }
958   Script<ELFT>::X->adjustSectionsBeforeSorting();
959 
960   // The order of the sections in the script is arbitrary and may not agree with
961   // compareSectionsNonScript. This means that we cannot easily define a
962   // strict weak ordering. To see why, consider a comparison of a section in the
963   // script and one not in the script. We have a two simple options:
964   // * Make them equivalent (a is not less than b, and b is not less than a).
965   //   The problem is then that equivalence has to be transitive and we can
966   //   have sections a, b and c with only b in a script and a less than c
967   //   which breaks this property.
968   // * Use compareSectionsNonScript. Given that the script order doesn't have
969   //   to match, we can end up with sections a, b, c, d where b and c are in the
970   //   script and c is compareSectionsNonScript less than b. In which case d
971   //   can be equivalent to c, a to b and d < a. As a concrete example:
972   //   .a (rx) # not in script
973   //   .b (rx) # in script
974   //   .c (ro) # in script
975   //   .d (ro) # not in script
976   //
977   // The way we define an order then is:
978   // *  First put script sections at the start and sort the script and
979   //    non-script sections independently.
980   // *  Move each non-script section to its preferred position. We try
981   //    to put each section in the last position where it it can share
982   //    a PT_LOAD.
983 
984   std::stable_sort(OutputSections.begin(), OutputSections.end(),
985                    compareSections<ELFT>);
986 
987   auto I = OutputSections.begin();
988   auto E = OutputSections.end();
989   auto NonScriptI =
990       std::find_if(OutputSections.begin(), E, [](OutputSection *S) {
991         return Script<ELFT>::X->getSectionIndex(S->Name) == INT_MAX;
992       });
993   while (NonScriptI != E) {
994     auto BestPos = std::max_element(
995         I, NonScriptI, [&](OutputSection *&A, OutputSection *&B) {
996           bool ACanSharePtLoad = canSharePtLoad<ELFT>(**NonScriptI, *A);
997           bool BCanSharePtLoad = canSharePtLoad<ELFT>(**NonScriptI, *B);
998           if (ACanSharePtLoad != BCanSharePtLoad)
999             return BCanSharePtLoad;
1000 
1001           bool ACmp = compareSectionsNonScript<ELFT>(*NonScriptI, A);
1002           bool BCmp = compareSectionsNonScript<ELFT>(*NonScriptI, B);
1003           if (ACmp != BCmp)
1004             return BCmp; // FIXME: missing test
1005 
1006           size_t PosA = &A - &OutputSections[0];
1007           size_t PosB = &B - &OutputSections[0];
1008           return ACmp ? PosA > PosB : PosA < PosB;
1009         });
1010 
1011     // max_element only returns NonScriptI if the range is empty. If the range
1012     // is not empty we should consider moving the the element forward one
1013     // position.
1014     if (BestPos != NonScriptI &&
1015         !compareSectionsNonScript<ELFT>(*NonScriptI, *BestPos))
1016       ++BestPos;
1017     std::rotate(BestPos, NonScriptI, NonScriptI + 1);
1018     ++NonScriptI;
1019   }
1020 
1021   Script<ELFT>::X->adjustSectionsAfterSorting();
1022 }
1023 
1024 template <class ELFT>
1025 static void finalizeSynthetic(const std::vector<SyntheticSection *> &Sections) {
1026   for (SyntheticSection *SS : Sections)
1027     if (SS && SS->OutSec && !SS->empty()) {
1028       SS->finalizeContents();
1029       SS->OutSec->Size = 0;
1030       SS->OutSec->template assignOffsets<ELFT>();
1031     }
1032 }
1033 
1034 // We need to add input synthetic sections early in createSyntheticSections()
1035 // to make them visible from linkescript side. But not all sections are always
1036 // required to be in output. For example we don't need dynamic section content
1037 // sometimes. This function filters out such unused sections from output.
1038 template <class ELFT>
1039 static void removeUnusedSyntheticSections(std::vector<OutputSection *> &V) {
1040   // All input synthetic sections that can be empty are placed after
1041   // all regular ones. We iterate over them all and exit at first
1042   // non-synthetic.
1043   for (InputSectionBase *S : llvm::reverse(InputSections)) {
1044     SyntheticSection *SS = dyn_cast<SyntheticSection>(S);
1045     if (!SS)
1046       return;
1047     if (!SS->empty() || !SS->OutSec)
1048       continue;
1049 
1050     OutputSection *OutSec = cast<OutputSection>(SS->OutSec);
1051     OutSec->Sections.erase(
1052         std::find(OutSec->Sections.begin(), OutSec->Sections.end(), SS));
1053     // If there is no other sections in output section, remove it from output.
1054     if (OutSec->Sections.empty())
1055       V.erase(std::find(V.begin(), V.end(), OutSec));
1056   }
1057 }
1058 
1059 // Create output section objects and add them to OutputSections.
1060 template <class ELFT> void Writer<ELFT>::finalizeSections() {
1061   Out::DebugInfo = findSection(".debug_info");
1062   Out::PreinitArray = findSection(".preinit_array");
1063   Out::InitArray = findSection(".init_array");
1064   Out::FiniArray = findSection(".fini_array");
1065 
1066   // The linker needs to define SECNAME_start, SECNAME_end and SECNAME_stop
1067   // symbols for sections, so that the runtime can get the start and end
1068   // addresses of each section by section name. Add such symbols.
1069   if (!Config->Relocatable) {
1070     addStartEndSymbols();
1071     for (OutputSection *Sec : OutputSections)
1072       addStartStopSymbols(Sec);
1073   }
1074 
1075   // Add _DYNAMIC symbol. Unlike GNU gold, our _DYNAMIC symbol has no type.
1076   // It should be okay as no one seems to care about the type.
1077   // Even the author of gold doesn't remember why gold behaves that way.
1078   // https://sourceware.org/ml/binutils/2002-03/msg00360.html
1079   if (In<ELFT>::DynSymTab)
1080     addRegular<ELFT>("_DYNAMIC", In<ELFT>::Dynamic, 0);
1081 
1082   // Define __rel[a]_iplt_{start,end} symbols if needed.
1083   addRelIpltSymbols();
1084 
1085   // This responsible for splitting up .eh_frame section into
1086   // pieces. The relocation scan uses those peaces, so this has to be
1087   // earlier.
1088   finalizeSynthetic<ELFT>({In<ELFT>::EhFrame});
1089 
1090   // Scan relocations. This must be done after every symbol is declared so that
1091   // we can correctly decide if a dynamic relocation is needed.
1092   forEachRelSec(scanRelocations<ELFT>);
1093 
1094   if (In<ELFT>::Plt && !In<ELFT>::Plt->empty())
1095     In<ELFT>::Plt->addSymbols();
1096   if (In<ELFT>::Iplt && !In<ELFT>::Iplt->empty())
1097     In<ELFT>::Iplt->addSymbols();
1098 
1099   // Now that we have defined all possible global symbols including linker-
1100   // synthesized ones. Visit all symbols to give the finishing touches.
1101   for (Symbol *S : Symtab<ELFT>::X->getSymbols()) {
1102     SymbolBody *Body = S->body();
1103 
1104     if (!includeInSymtab<ELFT>(*Body))
1105       continue;
1106     if (In<ELFT>::SymTab)
1107       In<ELFT>::SymTab->addGlobal(Body);
1108 
1109     if (In<ELFT>::DynSymTab && S->includeInDynsym()) {
1110       In<ELFT>::DynSymTab->addGlobal(Body);
1111       if (auto *SS = dyn_cast<SharedSymbol>(Body))
1112         if (cast<SharedFile<ELFT>>(SS->File)->isNeeded())
1113           In<ELFT>::VerNeed->addSymbol(SS);
1114     }
1115   }
1116 
1117   // Do not proceed if there was an undefined symbol.
1118   if (ErrorCount)
1119     return;
1120 
1121   // So far we have added sections from input object files.
1122   // This function adds linker-created Out::* sections.
1123   addPredefinedSections();
1124   removeUnusedSyntheticSections<ELFT>(OutputSections);
1125 
1126   sortSections();
1127 
1128   // This is a bit of a hack. A value of 0 means undef, so we set it
1129   // to 1 t make __ehdr_start defined. The section number is not
1130   // particularly relevant.
1131   Out::ElfHeader->SectionIndex = 1;
1132 
1133   unsigned I = 1;
1134   for (OutputSection *Sec : OutputSections) {
1135     Sec->SectionIndex = I++;
1136     Sec->ShName = In<ELFT>::ShStrTab->addString(Sec->Name);
1137   }
1138 
1139   // Binary and relocatable output does not have PHDRS.
1140   // The headers have to be created before finalize as that can influence the
1141   // image base and the dynamic section on mips includes the image base.
1142   if (!Config->Relocatable && !Config->OFormatBinary) {
1143     Phdrs = Script<ELFT>::X->hasPhdrsCommands() ? Script<ELFT>::X->createPhdrs()
1144                                                 : createPhdrs();
1145     addPtArmExid(Phdrs);
1146     fixHeaders();
1147   }
1148 
1149   // Some architectures use small displacements for jump instructions.
1150   // It is linker's responsibility to create thunks containing long
1151   // jump instructions if jump targets are too far. Create thunks.
1152   if (Target->NeedsThunks)
1153     createThunks<ELFT>(OutputSections);
1154 
1155   // Fill other section headers. The dynamic table is finalized
1156   // at the end because some tags like RELSZ depend on result
1157   // of finalizing other sections.
1158   for (OutputSection *Sec : OutputSections)
1159     Sec->finalize<ELFT>();
1160 
1161   // Dynamic section must be the last one in this list and dynamic
1162   // symbol table section (DynSymTab) must be the first one.
1163   finalizeSynthetic<ELFT>(
1164       {In<ELFT>::DynSymTab, In<ELFT>::GnuHashTab, In<ELFT>::HashTab,
1165        In<ELFT>::SymTab,    In<ELFT>::ShStrTab,   In<ELFT>::StrTab,
1166        In<ELFT>::VerDef,    In<ELFT>::DynStrTab,  In<ELFT>::GdbIndex,
1167        In<ELFT>::Got,       In<ELFT>::MipsGot,    In<ELFT>::IgotPlt,
1168        In<ELFT>::GotPlt,    In<ELFT>::RelaDyn,    In<ELFT>::RelaIplt,
1169        In<ELFT>::RelaPlt,   In<ELFT>::Plt,        In<ELFT>::Iplt,
1170        In<ELFT>::Plt,       In<ELFT>::EhFrameHdr, In<ELFT>::VerSym,
1171        In<ELFT>::VerNeed,   In<ELFT>::Dynamic});
1172 }
1173 
1174 template <class ELFT> void Writer<ELFT>::addPredefinedSections() {
1175   // Add BSS sections.
1176   auto Add = [=](OutputSection *Sec) {
1177     if (!Sec->Sections.empty()) {
1178       Sec->assignOffsets<ELFT>();
1179       OutputSections.push_back(Sec);
1180     }
1181   };
1182   Add(Out::Bss);
1183   Add(Out::BssRelRo);
1184 
1185   // ARM ABI requires .ARM.exidx to be terminated by some piece of data.
1186   // We have the terminater synthetic section class. Add that at the end.
1187   auto *OS = dyn_cast_or_null<OutputSection>(findSection(".ARM.exidx"));
1188   if (OS && !OS->Sections.empty() && !Config->Relocatable)
1189     OS->addSection(make<ARMExidxSentinelSection<ELFT>>());
1190 }
1191 
1192 // The linker is expected to define SECNAME_start and SECNAME_end
1193 // symbols for a few sections. This function defines them.
1194 template <class ELFT> void Writer<ELFT>::addStartEndSymbols() {
1195   auto Define = [&](StringRef Start, StringRef End, OutputSection *OS) {
1196     // These symbols resolve to the image base if the section does not exist.
1197     // A special value -1 indicates end of the section.
1198     addOptionalSynthetic<ELFT>(Start, OS, 0);
1199     addOptionalSynthetic<ELFT>(End, OS, OS ? -1 : 0);
1200   };
1201 
1202   Define("__preinit_array_start", "__preinit_array_end", Out::PreinitArray);
1203   Define("__init_array_start", "__init_array_end", Out::InitArray);
1204   Define("__fini_array_start", "__fini_array_end", Out::FiniArray);
1205 
1206   if (OutputSection *Sec = findSection(".ARM.exidx"))
1207     Define("__exidx_start", "__exidx_end", Sec);
1208 }
1209 
1210 // If a section name is valid as a C identifier (which is rare because of
1211 // the leading '.'), linkers are expected to define __start_<secname> and
1212 // __stop_<secname> symbols. They are at beginning and end of the section,
1213 // respectively. This is not requested by the ELF standard, but GNU ld and
1214 // gold provide the feature, and used by many programs.
1215 template <class ELFT>
1216 void Writer<ELFT>::addStartStopSymbols(OutputSection *Sec) {
1217   StringRef S = Sec->Name;
1218   if (!isValidCIdentifier(S))
1219     return;
1220   addOptionalSynthetic<ELFT>(Saver.save("__start_" + S), Sec, 0, STV_DEFAULT);
1221   addOptionalSynthetic<ELFT>(Saver.save("__stop_" + S), Sec, -1, STV_DEFAULT);
1222 }
1223 
1224 template <class ELFT> OutputSection *Writer<ELFT>::findSection(StringRef Name) {
1225   for (OutputSection *Sec : OutputSections)
1226     if (Sec->Name == Name)
1227       return Sec;
1228   return nullptr;
1229 }
1230 
1231 template <class ELFT> static bool needsPtLoad(OutputSection *Sec) {
1232   if (!(Sec->Flags & SHF_ALLOC))
1233     return false;
1234 
1235   // Don't allocate VA space for TLS NOBITS sections. The PT_TLS PHDR is
1236   // responsible for allocating space for them, not the PT_LOAD that
1237   // contains the TLS initialization image.
1238   if (Sec->Flags & SHF_TLS && Sec->Type == SHT_NOBITS)
1239     return false;
1240   return true;
1241 }
1242 
1243 // Linker scripts are responsible for aligning addresses. Unfortunately, most
1244 // linker scripts are designed for creating two PT_LOADs only, one RX and one
1245 // RW. This means that there is no alignment in the RO to RX transition and we
1246 // cannot create a PT_LOAD there.
1247 template <class ELFT>
1248 static typename ELFT::uint computeFlags(typename ELFT::uint F) {
1249   if (Config->Omagic)
1250     return PF_R | PF_W | PF_X;
1251   if (Config->SingleRoRx && !(F & PF_W))
1252     return F | PF_X;
1253   return F;
1254 }
1255 
1256 // Decide which program headers to create and which sections to include in each
1257 // one.
1258 template <class ELFT> std::vector<PhdrEntry> Writer<ELFT>::createPhdrs() {
1259   std::vector<PhdrEntry> Ret;
1260   auto AddHdr = [&](unsigned Type, unsigned Flags) -> PhdrEntry * {
1261     Ret.emplace_back(Type, Flags);
1262     return &Ret.back();
1263   };
1264 
1265   // The first phdr entry is PT_PHDR which describes the program header itself.
1266   AddHdr(PT_PHDR, PF_R)->add(Out::ProgramHeaders);
1267 
1268   // PT_INTERP must be the second entry if exists.
1269   if (OutputSection *Sec = findSection(".interp"))
1270     AddHdr(PT_INTERP, Sec->getPhdrFlags())->add(Sec);
1271 
1272   // Add the first PT_LOAD segment for regular output sections.
1273   uintX_t Flags = computeFlags<ELFT>(PF_R);
1274   PhdrEntry *Load = AddHdr(PT_LOAD, Flags);
1275   for (OutputSection *Sec : OutputSections) {
1276     if (!(Sec->Flags & SHF_ALLOC))
1277       break;
1278     if (!needsPtLoad<ELFT>(Sec))
1279       continue;
1280 
1281     // Segments are contiguous memory regions that has the same attributes
1282     // (e.g. executable or writable). There is one phdr for each segment.
1283     // Therefore, we need to create a new phdr when the next section has
1284     // different flags or is loaded at a discontiguous address using AT linker
1285     // script command.
1286     uintX_t NewFlags = computeFlags<ELFT>(Sec->getPhdrFlags());
1287     if (Script<ELFT>::X->hasLMA(Sec->Name) || Flags != NewFlags) {
1288       Load = AddHdr(PT_LOAD, NewFlags);
1289       Flags = NewFlags;
1290     }
1291 
1292     Load->add(Sec);
1293   }
1294 
1295   // Add a TLS segment if any.
1296   PhdrEntry TlsHdr(PT_TLS, PF_R);
1297   for (OutputSection *Sec : OutputSections)
1298     if (Sec->Flags & SHF_TLS)
1299       TlsHdr.add(Sec);
1300   if (TlsHdr.First)
1301     Ret.push_back(std::move(TlsHdr));
1302 
1303   // Add an entry for .dynamic.
1304   if (In<ELFT>::DynSymTab)
1305     AddHdr(PT_DYNAMIC, In<ELFT>::Dynamic->OutSec->getPhdrFlags())
1306         ->add(In<ELFT>::Dynamic->OutSec);
1307 
1308   // PT_GNU_RELRO includes all sections that should be marked as
1309   // read-only by dynamic linker after proccessing relocations.
1310   PhdrEntry RelRo(PT_GNU_RELRO, PF_R);
1311   for (OutputSection *Sec : OutputSections)
1312     if (needsPtLoad<ELFT>(Sec) && isRelroSection<ELFT>(Sec))
1313       RelRo.add(Sec);
1314   if (RelRo.First)
1315     Ret.push_back(std::move(RelRo));
1316 
1317   // PT_GNU_EH_FRAME is a special section pointing on .eh_frame_hdr.
1318   if (!In<ELFT>::EhFrame->empty() && In<ELFT>::EhFrameHdr)
1319     AddHdr(PT_GNU_EH_FRAME, In<ELFT>::EhFrameHdr->OutSec->getPhdrFlags())
1320         ->add(In<ELFT>::EhFrameHdr->OutSec);
1321 
1322   // PT_OPENBSD_RANDOMIZE specifies the location and size of a part of the
1323   // memory image of the program that must be filled with random data before any
1324   // code in the object is executed.
1325   if (OutputSection *Sec = findSection(".openbsd.randomdata"))
1326     AddHdr(PT_OPENBSD_RANDOMIZE, Sec->getPhdrFlags())->add(Sec);
1327 
1328   // PT_GNU_STACK is a special section to tell the loader to make the
1329   // pages for the stack non-executable. If you really want an executable
1330   // stack, you can pass -z execstack, but that's not recommended for
1331   // security reasons.
1332   unsigned Perm;
1333   if (Config->ZExecstack)
1334     Perm = PF_R | PF_W | PF_X;
1335   else
1336     Perm = PF_R | PF_W;
1337   AddHdr(PT_GNU_STACK, Perm)->p_memsz = Config->ZStackSize;
1338 
1339   // PT_OPENBSD_WXNEEDED is a OpenBSD-specific header to mark the executable
1340   // is expected to perform W^X violations, such as calling mprotect(2) or
1341   // mmap(2) with PROT_WRITE | PROT_EXEC, which is prohibited by default on
1342   // OpenBSD.
1343   if (Config->ZWxneeded)
1344     AddHdr(PT_OPENBSD_WXNEEDED, PF_X);
1345 
1346   // Create one PT_NOTE per a group of contiguous .note sections.
1347   PhdrEntry *Note = nullptr;
1348   for (OutputSection *Sec : OutputSections) {
1349     if (Sec->Type == SHT_NOTE) {
1350       if (!Note || Script<ELFT>::X->hasLMA(Sec->Name))
1351         Note = AddHdr(PT_NOTE, PF_R);
1352       Note->add(Sec);
1353     } else {
1354       Note = nullptr;
1355     }
1356   }
1357   return Ret;
1358 }
1359 
1360 template <class ELFT>
1361 void Writer<ELFT>::addPtArmExid(std::vector<PhdrEntry> &Phdrs) {
1362   if (Config->EMachine != EM_ARM)
1363     return;
1364   auto I = std::find_if(
1365       OutputSections.begin(), OutputSections.end(),
1366       [](OutputSection *Sec) { return Sec->Type == SHT_ARM_EXIDX; });
1367   if (I == OutputSections.end())
1368     return;
1369 
1370   // PT_ARM_EXIDX is the ARM EHABI equivalent of PT_GNU_EH_FRAME
1371   PhdrEntry ARMExidx(PT_ARM_EXIDX, PF_R);
1372   ARMExidx.add(*I);
1373   Phdrs.push_back(ARMExidx);
1374 }
1375 
1376 // The first section of each PT_LOAD, the first section in PT_GNU_RELRO and the
1377 // first section after PT_GNU_RELRO have to be page aligned so that the dynamic
1378 // linker can set the permissions.
1379 template <class ELFT> void Writer<ELFT>::fixSectionAlignments() {
1380   for (const PhdrEntry &P : Phdrs)
1381     if (P.p_type == PT_LOAD && P.First)
1382       P.First->PageAlign = true;
1383 
1384   for (const PhdrEntry &P : Phdrs) {
1385     if (P.p_type != PT_GNU_RELRO)
1386       continue;
1387     if (P.First)
1388       P.First->PageAlign = true;
1389     // Find the first section after PT_GNU_RELRO. If it is in a PT_LOAD we
1390     // have to align it to a page.
1391     auto End = OutputSections.end();
1392     auto I = std::find(OutputSections.begin(), End, P.Last);
1393     if (I == End || (I + 1) == End)
1394       continue;
1395     OutputSection *Sec = *(I + 1);
1396     if (needsPtLoad<ELFT>(Sec))
1397       Sec->PageAlign = true;
1398   }
1399 }
1400 
1401 template <class ELFT>
1402 bool elf::allocateHeaders(std::vector<PhdrEntry> &Phdrs,
1403                           ArrayRef<OutputSection *> OutputSections,
1404                           uint64_t Min) {
1405   auto FirstPTLoad =
1406       std::find_if(Phdrs.begin(), Phdrs.end(),
1407                    [](const PhdrEntry &E) { return E.p_type == PT_LOAD; });
1408   if (FirstPTLoad == Phdrs.end())
1409     return false;
1410 
1411   uint64_t HeaderSize = getHeaderSize<ELFT>();
1412   if (HeaderSize > Min) {
1413     auto PhdrI =
1414         std::find_if(Phdrs.begin(), Phdrs.end(),
1415                      [](const PhdrEntry &E) { return E.p_type == PT_PHDR; });
1416     if (PhdrI != Phdrs.end())
1417       Phdrs.erase(PhdrI);
1418     return false;
1419   }
1420   Min = alignDown(Min - HeaderSize, Config->MaxPageSize);
1421 
1422   if (!ScriptConfig->HasSections)
1423     Config->ImageBase = Min = std::min(Min, Config->ImageBase);
1424 
1425   Out::ElfHeader->Addr = Min;
1426   Out::ProgramHeaders->Addr = Min + Out::ElfHeader->Size;
1427 
1428   if (Script<ELFT>::X->hasPhdrsCommands())
1429     return true;
1430 
1431   if (FirstPTLoad->First)
1432     for (OutputSection *Sec : OutputSections)
1433       if (Sec->FirstInPtLoad == FirstPTLoad->First)
1434         Sec->FirstInPtLoad = Out::ElfHeader;
1435   FirstPTLoad->First = Out::ElfHeader;
1436   if (!FirstPTLoad->Last)
1437     FirstPTLoad->Last = Out::ProgramHeaders;
1438   return true;
1439 }
1440 
1441 // We should set file offsets and VAs for elf header and program headers
1442 // sections. These are special, we do not include them into output sections
1443 // list, but have them to simplify the code.
1444 template <class ELFT> void Writer<ELFT>::fixHeaders() {
1445   Out::ProgramHeaders->Size = sizeof(Elf_Phdr) * Phdrs.size();
1446   // If the script has SECTIONS, assignAddresses will compute the values.
1447   if (ScriptConfig->HasSections)
1448     return;
1449 
1450   // When -T<section> option is specified, lower the base to make room for those
1451   // sections.
1452   uint64_t Min = -1;
1453   if (!Config->SectionStartMap.empty())
1454     for (const auto &P : Config->SectionStartMap)
1455       Min = std::min(Min, P.second);
1456 
1457   AllocateHeader = allocateHeaders<ELFT>(Phdrs, OutputSections, Min);
1458 }
1459 
1460 // Assign VAs (addresses at run-time) to output sections.
1461 template <class ELFT> void Writer<ELFT>::assignAddresses() {
1462   uintX_t VA = Config->ImageBase;
1463   if (AllocateHeader)
1464     VA += getHeaderSize<ELFT>();
1465   uintX_t ThreadBssOffset = 0;
1466   for (OutputSection *Sec : OutputSections) {
1467     uintX_t Alignment = Sec->Addralign;
1468     if (Sec->PageAlign)
1469       Alignment = std::max<uintX_t>(Alignment, Config->MaxPageSize);
1470 
1471     auto I = Config->SectionStartMap.find(Sec->Name);
1472     if (I != Config->SectionStartMap.end())
1473       VA = I->second;
1474 
1475     // We only assign VAs to allocated sections.
1476     if (needsPtLoad<ELFT>(Sec)) {
1477       VA = alignTo(VA, Alignment);
1478       Sec->Addr = VA;
1479       VA += Sec->Size;
1480     } else if (Sec->Flags & SHF_TLS && Sec->Type == SHT_NOBITS) {
1481       uintX_t TVA = VA + ThreadBssOffset;
1482       TVA = alignTo(TVA, Alignment);
1483       Sec->Addr = TVA;
1484       ThreadBssOffset = TVA - VA + Sec->Size;
1485     }
1486   }
1487 }
1488 
1489 // Adjusts the file alignment for a given output section and returns
1490 // its new file offset. The file offset must be the same with its
1491 // virtual address (modulo the page size) so that the loader can load
1492 // executables without any address adjustment.
1493 template <class ELFT, class uintX_t>
1494 static uintX_t getFileAlignment(uintX_t Off, OutputSection *Sec) {
1495   OutputSection *First = Sec->FirstInPtLoad;
1496   // If the section is not in a PT_LOAD, we just have to align it.
1497   if (!First)
1498     return alignTo(Off, Sec->Addralign);
1499 
1500   // The first section in a PT_LOAD has to have congruent offset and address
1501   // module the page size.
1502   if (Sec == First)
1503     return alignTo(Off, Config->MaxPageSize, Sec->Addr);
1504 
1505   // If two sections share the same PT_LOAD the file offset is calculated
1506   // using this formula: Off2 = Off1 + (VA2 - VA1).
1507   return First->Offset + Sec->Addr - First->Addr;
1508 }
1509 
1510 template <class ELFT, class uintX_t>
1511 static uintX_t setOffset(OutputSection *Sec, uintX_t Off) {
1512   if (Sec->Type == SHT_NOBITS) {
1513     Sec->Offset = Off;
1514     return Off;
1515   }
1516 
1517   Off = getFileAlignment<ELFT>(Off, Sec);
1518   Sec->Offset = Off;
1519   return Off + Sec->Size;
1520 }
1521 
1522 template <class ELFT> void Writer<ELFT>::assignFileOffsetsBinary() {
1523   uintX_t Off = 0;
1524   for (OutputSection *Sec : OutputSections)
1525     if (Sec->Flags & SHF_ALLOC)
1526       Off = setOffset<ELFT>(Sec, Off);
1527   FileSize = alignTo(Off, sizeof(uintX_t));
1528 }
1529 
1530 // Assign file offsets to output sections.
1531 template <class ELFT> void Writer<ELFT>::assignFileOffsets() {
1532   uintX_t Off = 0;
1533   Off = setOffset<ELFT>(Out::ElfHeader, Off);
1534   Off = setOffset<ELFT>(Out::ProgramHeaders, Off);
1535 
1536   for (OutputSection *Sec : OutputSections)
1537     Off = setOffset<ELFT>(Sec, Off);
1538 
1539   SectionHeaderOff = alignTo(Off, sizeof(uintX_t));
1540   FileSize = SectionHeaderOff + (OutputSections.size() + 1) * sizeof(Elf_Shdr);
1541 }
1542 
1543 // Finalize the program headers. We call this function after we assign
1544 // file offsets and VAs to all sections.
1545 template <class ELFT> void Writer<ELFT>::setPhdrs() {
1546   for (PhdrEntry &P : Phdrs) {
1547     OutputSection *First = P.First;
1548     OutputSection *Last = P.Last;
1549     if (First) {
1550       P.p_filesz = Last->Offset - First->Offset;
1551       if (Last->Type != SHT_NOBITS)
1552         P.p_filesz += Last->Size;
1553       P.p_memsz = Last->Addr + Last->Size - First->Addr;
1554       P.p_offset = First->Offset;
1555       P.p_vaddr = First->Addr;
1556       if (!P.HasLMA)
1557         P.p_paddr = First->getLMA();
1558     }
1559     if (P.p_type == PT_LOAD)
1560       P.p_align = Config->MaxPageSize;
1561     else if (P.p_type == PT_GNU_RELRO) {
1562       P.p_align = 1;
1563       // The glibc dynamic loader rounds the size down, so we need to round up
1564       // to protect the last page. This is a no-op on FreeBSD which always
1565       // rounds up.
1566       P.p_memsz = alignTo(P.p_memsz, Target->PageSize);
1567     }
1568 
1569     // The TLS pointer goes after PT_TLS. At least glibc will align it,
1570     // so round up the size to make sure the offsets are correct.
1571     if (P.p_type == PT_TLS) {
1572       Out::TlsPhdr = &P;
1573       if (P.p_memsz)
1574         P.p_memsz = alignTo(P.p_memsz, P.p_align);
1575     }
1576   }
1577 }
1578 
1579 // The entry point address is chosen in the following ways.
1580 //
1581 // 1. the '-e' entry command-line option;
1582 // 2. the ENTRY(symbol) command in a linker control script;
1583 // 3. the value of the symbol start, if present;
1584 // 4. the address of the first byte of the .text section, if present;
1585 // 5. the address 0.
1586 template <class ELFT> typename ELFT::uint Writer<ELFT>::getEntryAddr() {
1587   // Case 1, 2 or 3. As a special case, if the symbol is actually
1588   // a number, we'll use that number as an address.
1589   if (SymbolBody *B = Symtab<ELFT>::X->find(Config->Entry))
1590     return B->getVA<ELFT>();
1591   uint64_t Addr;
1592   if (!Config->Entry.getAsInteger(0, Addr))
1593     return Addr;
1594 
1595   // Case 4
1596   if (OutputSection *Sec = findSection(".text")) {
1597     if (Config->WarnMissingEntry)
1598       warn("cannot find entry symbol " + Config->Entry + "; defaulting to 0x" +
1599            utohexstr(Sec->Addr));
1600     return Sec->Addr;
1601   }
1602 
1603   // Case 5
1604   if (Config->WarnMissingEntry)
1605     warn("cannot find entry symbol " + Config->Entry +
1606          "; not setting start address");
1607   return 0;
1608 }
1609 
1610 template <class ELFT> static uint8_t getELFEncoding() {
1611   if (ELFT::TargetEndianness == llvm::support::little)
1612     return ELFDATA2LSB;
1613   return ELFDATA2MSB;
1614 }
1615 
1616 static uint16_t getELFType() {
1617   if (Config->pic())
1618     return ET_DYN;
1619   if (Config->Relocatable)
1620     return ET_REL;
1621   return ET_EXEC;
1622 }
1623 
1624 // This function is called after we have assigned address and size
1625 // to each section. This function fixes some predefined
1626 // symbol values that depend on section address and size.
1627 template <class ELFT> void Writer<ELFT>::fixPredefinedSymbols() {
1628   auto Set = [](DefinedSynthetic *S1, DefinedSynthetic *S2, OutputSection *Sec,
1629                 uint64_t Value) {
1630     if (S1) {
1631       S1->Section = Sec;
1632       S1->Value = Value;
1633     }
1634     if (S2) {
1635       S2->Section = Sec;
1636       S2->Value = Value;
1637     }
1638   };
1639 
1640   // _etext is the first location after the last read-only loadable segment.
1641   // _edata is the first location after the last read-write loadable segment.
1642   // _end is the first location after the uninitialized data region.
1643   PhdrEntry *Last = nullptr;
1644   PhdrEntry *LastRO = nullptr;
1645   PhdrEntry *LastRW = nullptr;
1646   for (PhdrEntry &P : Phdrs) {
1647     if (P.p_type != PT_LOAD)
1648       continue;
1649     Last = &P;
1650     if (P.p_flags & PF_W)
1651       LastRW = &P;
1652     else
1653       LastRO = &P;
1654   }
1655   if (Last)
1656     Set(ElfSym<ELFT>::End, ElfSym<ELFT>::End2, Last->First, Last->p_memsz);
1657   if (LastRO)
1658     Set(ElfSym<ELFT>::Etext, ElfSym<ELFT>::Etext2, LastRO->First,
1659         LastRO->p_filesz);
1660   if (LastRW)
1661     Set(ElfSym<ELFT>::Edata, ElfSym<ELFT>::Edata2, LastRW->First,
1662         LastRW->p_filesz);
1663 
1664   // Setup MIPS _gp_disp/__gnu_local_gp symbols which should
1665   // be equal to the _gp symbol's value.
1666   if (Config->EMachine == EM_MIPS) {
1667     if (!ElfSym<ELFT>::MipsGp->Value) {
1668       // Find GP-relative section with the lowest address
1669       // and use this address to calculate default _gp value.
1670       uintX_t Gp = -1;
1671       for (const OutputSection *OS : OutputSections)
1672         if ((OS->Flags & SHF_MIPS_GPREL) && OS->Addr < Gp)
1673           Gp = OS->Addr;
1674       if (Gp != (uintX_t)-1)
1675         ElfSym<ELFT>::MipsGp->Value = Gp + 0x7ff0;
1676     }
1677     if (ElfSym<ELFT>::MipsGpDisp)
1678       ElfSym<ELFT>::MipsGpDisp->Value = ElfSym<ELFT>::MipsGp->Value;
1679     if (ElfSym<ELFT>::MipsLocalGp)
1680       ElfSym<ELFT>::MipsLocalGp->Value = ElfSym<ELFT>::MipsGp->Value;
1681   }
1682 }
1683 
1684 template <class ELFT> void Writer<ELFT>::writeHeader() {
1685   uint8_t *Buf = Buffer->getBufferStart();
1686   memcpy(Buf, "\177ELF", 4);
1687 
1688   // Write the ELF header.
1689   auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
1690   EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
1691   EHdr->e_ident[EI_DATA] = getELFEncoding<ELFT>();
1692   EHdr->e_ident[EI_VERSION] = EV_CURRENT;
1693   EHdr->e_ident[EI_OSABI] = Config->OSABI;
1694   EHdr->e_type = getELFType();
1695   EHdr->e_machine = Config->EMachine;
1696   EHdr->e_version = EV_CURRENT;
1697   EHdr->e_entry = getEntryAddr();
1698   EHdr->e_shoff = SectionHeaderOff;
1699   EHdr->e_ehsize = sizeof(Elf_Ehdr);
1700   EHdr->e_phnum = Phdrs.size();
1701   EHdr->e_shentsize = sizeof(Elf_Shdr);
1702   EHdr->e_shnum = OutputSections.size() + 1;
1703   EHdr->e_shstrndx = In<ELFT>::ShStrTab->OutSec->SectionIndex;
1704 
1705   if (Config->EMachine == EM_ARM)
1706     // We don't currently use any features incompatible with EF_ARM_EABI_VER5,
1707     // but we don't have any firm guarantees of conformance. Linux AArch64
1708     // kernels (as of 2016) require an EABI version to be set.
1709     EHdr->e_flags = EF_ARM_EABI_VER5;
1710   else if (Config->EMachine == EM_MIPS)
1711     EHdr->e_flags = getMipsEFlags<ELFT>();
1712 
1713   if (!Config->Relocatable) {
1714     EHdr->e_phoff = sizeof(Elf_Ehdr);
1715     EHdr->e_phentsize = sizeof(Elf_Phdr);
1716   }
1717 
1718   // Write the program header table.
1719   auto *HBuf = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
1720   for (PhdrEntry &P : Phdrs) {
1721     HBuf->p_type = P.p_type;
1722     HBuf->p_flags = P.p_flags;
1723     HBuf->p_offset = P.p_offset;
1724     HBuf->p_vaddr = P.p_vaddr;
1725     HBuf->p_paddr = P.p_paddr;
1726     HBuf->p_filesz = P.p_filesz;
1727     HBuf->p_memsz = P.p_memsz;
1728     HBuf->p_align = P.p_align;
1729     ++HBuf;
1730   }
1731 
1732   // Write the section header table. Note that the first table entry is null.
1733   auto *SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
1734   for (OutputSection *Sec : OutputSections)
1735     Sec->writeHeaderTo<ELFT>(++SHdrs);
1736 }
1737 
1738 // Removes a given file asynchronously. This is a performance hack,
1739 // so remove this when operating systems are improved.
1740 //
1741 // On Linux (and probably on other Unix-like systems), unlink(2) is a
1742 // noticeably slow system call. As of 2016, unlink takes 250
1743 // milliseconds to remove a 1 GB file on ext4 filesystem on my machine.
1744 //
1745 // To create a new result file, we first remove existing file. So, if
1746 // you repeatedly link a 1 GB program in a regular compile-link-debug
1747 // cycle, every cycle wastes 250 milliseconds only to remove a file.
1748 // Since LLD can link a 1 GB binary in about 5 seconds, that waste
1749 // actually counts.
1750 //
1751 // This function spawns a background thread to call unlink.
1752 // The calling thread returns almost immediately.
1753 static void unlinkAsync(StringRef Path) {
1754   if (!Config->Threads || !sys::fs::exists(Config->OutputFile))
1755     return;
1756 
1757   // First, rename Path to avoid race condition. We cannot remove
1758   // Path from a different thread because we are now going to create
1759   // Path as a new file. If we do that in a different thread, the new
1760   // thread can remove the new file.
1761   SmallString<128> TempPath;
1762   if (sys::fs::createUniqueFile(Path + "tmp%%%%%%%%", TempPath))
1763     return;
1764   if (sys::fs::rename(Path, TempPath)) {
1765     sys::fs::remove(TempPath);
1766     return;
1767   }
1768 
1769   // Remove TempPath in background.
1770   std::thread([=] { ::remove(TempPath.str().str().c_str()); }).detach();
1771 }
1772 
1773 // Open a result file.
1774 template <class ELFT> void Writer<ELFT>::openFile() {
1775   unlinkAsync(Config->OutputFile);
1776   ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
1777       FileOutputBuffer::create(Config->OutputFile, FileSize,
1778                                FileOutputBuffer::F_executable);
1779 
1780   if (auto EC = BufferOrErr.getError())
1781     error("failed to open " + Config->OutputFile + ": " + EC.message());
1782   else
1783     Buffer = std::move(*BufferOrErr);
1784 }
1785 
1786 template <class ELFT> void Writer<ELFT>::writeSectionsBinary() {
1787   uint8_t *Buf = Buffer->getBufferStart();
1788   for (OutputSection *Sec : OutputSections)
1789     if (Sec->Flags & SHF_ALLOC)
1790       Sec->writeTo<ELFT>(Buf + Sec->Offset);
1791 }
1792 
1793 // Write section contents to a mmap'ed file.
1794 template <class ELFT> void Writer<ELFT>::writeSections() {
1795   uint8_t *Buf = Buffer->getBufferStart();
1796 
1797   // PPC64 needs to process relocations in the .opd section
1798   // before processing relocations in code-containing sections.
1799   Out::Opd = findSection(".opd");
1800   if (Out::Opd) {
1801     Out::OpdBuf = Buf + Out::Opd->Offset;
1802     Out::Opd->template writeTo<ELFT>(Buf + Out::Opd->Offset);
1803   }
1804 
1805   OutputSection *EhFrameHdr =
1806       In<ELFT>::EhFrameHdr ? In<ELFT>::EhFrameHdr->OutSec : nullptr;
1807 
1808   // In -r or -emit-relocs mode, write the relocation sections first as in
1809   // ELf_Rel targets we might find out that we need to modify the relocated
1810   // section while doing it.
1811   for (OutputSection *Sec : OutputSections)
1812     if (Sec->Type == SHT_REL || Sec->Type == SHT_RELA)
1813       Sec->writeTo<ELFT>(Buf + Sec->Offset);
1814 
1815   for (OutputSection *Sec : OutputSections)
1816     if (Sec != Out::Opd && Sec != EhFrameHdr && Sec->Type != SHT_REL &&
1817         Sec->Type != SHT_RELA)
1818       Sec->writeTo<ELFT>(Buf + Sec->Offset);
1819 
1820   // The .eh_frame_hdr depends on .eh_frame section contents, therefore
1821   // it should be written after .eh_frame is written.
1822   if (EhFrameHdr)
1823     EhFrameHdr->writeTo<ELFT>(Buf + EhFrameHdr->Offset);
1824 }
1825 
1826 template <class ELFT> void Writer<ELFT>::writeBuildId() {
1827   if (!In<ELFT>::BuildId || !In<ELFT>::BuildId->OutSec)
1828     return;
1829 
1830   // Compute a hash of all sections of the output file.
1831   uint8_t *Start = Buffer->getBufferStart();
1832   uint8_t *End = Start + FileSize;
1833   In<ELFT>::BuildId->writeBuildId({Start, End});
1834 }
1835 
1836 template void elf::writeResult<ELF32LE>();
1837 template void elf::writeResult<ELF32BE>();
1838 template void elf::writeResult<ELF64LE>();
1839 template void elf::writeResult<ELF64BE>();
1840 
1841 template bool elf::allocateHeaders<ELF32LE>(std::vector<PhdrEntry> &,
1842                                             ArrayRef<OutputSection *>,
1843                                             uint64_t);
1844 template bool elf::allocateHeaders<ELF32BE>(std::vector<PhdrEntry> &,
1845                                             ArrayRef<OutputSection *>,
1846                                             uint64_t);
1847 template bool elf::allocateHeaders<ELF64LE>(std::vector<PhdrEntry> &,
1848                                             ArrayRef<OutputSection *>,
1849                                             uint64_t);
1850 template bool elf::allocateHeaders<ELF64BE>(std::vector<PhdrEntry> &,
1851                                             ArrayRef<OutputSection *>,
1852                                             uint64_t);
1853 
1854 template bool elf::isRelroSection<ELF32LE>(const OutputSection *);
1855 template bool elf::isRelroSection<ELF32BE>(const OutputSection *);
1856 template bool elf::isRelroSection<ELF64LE>(const OutputSection *);
1857 template bool elf::isRelroSection<ELF64BE>(const OutputSection *);
1858