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