blob: 0688a5bf28b5ab7e9df2cdaf38b08e82b544983e [file] [log] [blame]
Michael J. Spencer84487f12015-07-24 21:03:07 +00001//===- 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
Michael J. Spencerf8325412015-09-04 22:48:30 +000010#include "Writer.h"
Rui Ueyamacb8474ed2015-08-05 23:51:50 +000011#include "Config.h"
Rafael Espindola5805c4f2015-09-21 21:38:08 +000012#include "OutputSections.h"
Rui Ueyamaafff74e22015-08-05 23:24:46 +000013#include "SymbolTable.h"
Rafael Espindola01205f72015-09-22 18:19:46 +000014#include "Target.h"
Rafael Espindola6b83b902015-08-12 00:00:24 +000015
Rui Ueyamaafff74e22015-08-05 23:24:46 +000016#include "llvm/Support/FileOutputBuffer.h"
Michael J. Spencer84487f12015-07-24 21:03:07 +000017
18using namespace llvm;
19using namespace llvm::ELF;
20using namespace llvm::object;
21
22using namespace lld;
23using namespace lld::elf2;
24
Rui Ueyamaafff74e22015-08-05 23:24:46 +000025namespace {
Rafael Espindola740fafe2015-09-08 19:43:27 +000026
Rui Ueyama04dae552015-10-02 21:23:17 +000027static uint32_t toPHDRFlags(uint64_t Flags) {
Michael J. Spencer2f008242015-09-17 19:58:07 +000028 uint32_t Ret = PF_R;
29 if (Flags & SHF_WRITE)
30 Ret |= PF_W;
Michael J. Spencer2f008242015-09-17 19:58:07 +000031 if (Flags & SHF_EXECINSTR)
32 Ret |= PF_X;
Michael J. Spencer2f008242015-09-17 19:58:07 +000033 return Ret;
34}
35
Rui Ueyama5713b8d2015-10-02 22:17:07 +000036template <class ELFT> struct ProgramHeader {
37 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
38 typedef typename ELFFile<ELFT>::Elf_Phdr Elf_Phdr;
Michael J. Spencer2f008242015-09-17 19:58:07 +000039
Rui Ueyama04dae552015-10-02 21:23:17 +000040 ProgramHeader(uintX_t Type, uintX_t Flags, uintX_t FileOff, uintX_t VA) {
Rui Ueyama5713b8d2015-10-02 22:17:07 +000041 std::memset(&Header, 0, sizeof(Elf_Phdr));
Rui Ueyama0fb1ee02015-10-02 21:13:19 +000042 Header.p_type = Type;
43 Header.p_flags = Flags;
Hal Finkele3c26262015-10-08 22:23:54 +000044 Header.p_align = Target->getPageSize();
Rui Ueyama04dae552015-10-02 21:23:17 +000045 Header.p_offset = FileOff;
46 Header.p_vaddr = VA;
47 Header.p_paddr = VA;
Michael J. Spencer2f008242015-09-17 19:58:07 +000048 }
49
Rui Ueyama15ef5e12015-10-07 19:18:16 +000050 void setValuesFromSection(OutputSectionBase<ELFT::Is64Bits> *Sec) {
51 Header.p_flags = toPHDRFlags(Sec->getFlags());
52 Header.p_offset = Sec->getFileOff();
53 Header.p_vaddr = Sec->getVA();
Michael J. Spencer2f008242015-09-17 19:58:07 +000054 Header.p_paddr = Header.p_vaddr;
Rui Ueyama15ef5e12015-10-07 19:18:16 +000055 Header.p_filesz = Sec->getSize();
Michael J. Spencer2f008242015-09-17 19:58:07 +000056 Header.p_memsz = Header.p_filesz;
Rui Ueyama15ef5e12015-10-07 19:18:16 +000057 Header.p_align = Sec->getAlign();
Michael J. Spencer2f008242015-09-17 19:58:07 +000058 }
59
Rui Ueyama5713b8d2015-10-02 22:17:07 +000060 Elf_Phdr Header;
Michael J. Spencer2f008242015-09-17 19:58:07 +000061 bool Closed = false;
62};
63
Rui Ueyamaafff74e22015-08-05 23:24:46 +000064// The writer writes a SymbolTable result to a file.
65template <class ELFT> class Writer {
66public:
Rafael Espindola18608a02015-09-08 21:57:31 +000067 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
68 typedef typename ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
69 typedef typename ELFFile<ELFT>::Elf_Ehdr Elf_Ehdr;
70 typedef typename ELFFile<ELFT>::Elf_Phdr Elf_Phdr;
71 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
Davide Italiano6d328d32015-09-16 20:45:57 +000072 typedef typename ELFFile<ELFT>::Elf_Sym_Range Elf_Sym_Range;
Rafael Espindola19e38892015-09-16 15:54:15 +000073 typedef typename ELFFile<ELFT>::Elf_Rela Elf_Rela;
Rui Ueyama0d0bcf72015-10-07 21:25:39 +000074 Writer(SymbolTable &S) : Symtab(S) {}
Rui Ueyamaafff74e22015-08-05 23:24:46 +000075 void run();
76
77private:
Rui Ueyama5a9640b2015-10-08 23:49:30 +000078 void copyLocalSymbols();
Rui Ueyamaafff74e22015-08-05 23:24:46 +000079 void createSections();
Rafael Espindola67a5da62015-09-17 14:02:10 +000080 template <bool isRela>
Rafael Espindola53d5cea2015-09-21 17:47:00 +000081 void scanRelocs(const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +000082 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels);
Rafael Espindola53d5cea2015-09-21 17:47:00 +000083 void scanRelocs(const InputSection<ELFT> &C);
Rui Ueyamaafff74e22015-08-05 23:24:46 +000084 void assignAddresses();
85 void openFile(StringRef OutputPath);
86 void writeHeader();
87 void writeSections();
Rafael Espindola70107762015-09-11 18:49:42 +000088 bool needsInterpSection() const {
Rui Ueyama0d0bcf72015-10-07 21:25:39 +000089 return !Symtab.getSharedFiles().empty() && !Config->DynamicLinker.empty();
Rafael Espindola70107762015-09-11 18:49:42 +000090 }
Michael J. Spencerf32446f2015-10-06 20:39:09 +000091 bool isOutputDynamic() const {
Rui Ueyama0d0bcf72015-10-07 21:25:39 +000092 return !Symtab.getSharedFiles().empty() || Config->Shared;
Rafael Espindola4340aad2015-09-11 22:42:45 +000093 }
Michael J. Spencerf32446f2015-10-06 20:39:09 +000094 bool needsDynamicSections() const { return isOutputDynamic(); }
Rui Ueyama00851fd2015-10-08 22:43:55 +000095 uintX_t getVAStart() const { return Config->Shared ? 0 : Target->getVAStart(); }
Rui Ueyamaafff74e22015-08-05 23:24:46 +000096
Rui Ueyamaafff74e22015-08-05 23:24:46 +000097 std::unique_ptr<llvm::FileOutputBuffer> Buffer;
Michael J. Spencer2f008242015-09-17 19:58:07 +000098
Rafael Espindola83b0dc62015-08-13 22:21:37 +000099 llvm::SpecificBumpPtrAllocator<OutputSection<ELFT>> CAlloc;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000100 std::vector<OutputSectionBase<ELFT::Is64Bits> *> OutputSections;
Rafael Espindola5f553872015-09-08 17:39:39 +0000101 unsigned getNumSections() const { return OutputSections.size() + 1; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000102
Michael J. Spencer2f008242015-09-17 19:58:07 +0000103 llvm::BumpPtrAllocator PAlloc;
Rui Ueyama0d0bcf72015-10-07 21:25:39 +0000104 SymbolTable &Symtab;
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000105 std::vector<ProgramHeader<ELFT> *> PHDRs;
106 ProgramHeader<ELFT> FileHeaderPHDR{PT_LOAD, PF_R, 0, 0};
107 ProgramHeader<ELFT> InterpPHDR{PT_INTERP, 0, 0, 0};
108 ProgramHeader<ELFT> DynamicPHDR{PT_DYNAMIC, 0, 0, 0};
Michael J. Spencer2f008242015-09-17 19:58:07 +0000109
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000110 uintX_t FileSize;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000111 uintX_t ProgramHeaderOff;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000112 uintX_t SectionHeaderOff;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000113};
114} // anonymous namespace
115
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000116template <class ELFT> static void doWriteResult(SymbolTable *Symtab) {
117 // Initialize output sections that are handled by Writer specially.
118 // Don't reorder because the order of initialization matters.
119 InterpSection<ELFT::Is64Bits> Interp;
120 Out<ELFT>::Interp = &Interp;
121 StringTableSection<ELFT::Is64Bits> StrTab(false);
122 Out<ELFT>::StrTab = &StrTab;
123 StringTableSection<ELFT::Is64Bits> DynStrTab(true);
124 Out<ELFT>::DynStrTab = &DynStrTab;
125 OutputSection<ELFT> Bss(".bss", SHT_NOBITS, SHF_ALLOC | SHF_WRITE);
126 Out<ELFT>::Bss = &Bss;
127 GotSection<ELFT> Got;
128 Out<ELFT>::Got = &Got;
129 PltSection<ELFT> Plt;
130 Out<ELFT>::Plt = &Plt;
131 SymbolTableSection<ELFT> SymTab(*Symtab, *Out<ELFT>::StrTab);
132 Out<ELFT>::SymTab = &SymTab;
133 SymbolTableSection<ELFT> DynSymTab(*Symtab, *Out<ELFT>::DynStrTab);
134 Out<ELFT>::DynSymTab = &DynSymTab;
135 HashTableSection<ELFT> HashTab;
136 Out<ELFT>::HashTab = &HashTab;
Rafael Espindolad5409192015-10-09 14:25:49 +0000137 RelocationSection<ELFT> RelaDyn(Symtab->shouldUseRela());
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000138 Out<ELFT>::RelaDyn = &RelaDyn;
139 DynamicSection<ELFT> Dynamic(*Symtab);
140 Out<ELFT>::Dynamic = &Dynamic;
141
Rui Ueyama0d0bcf72015-10-07 21:25:39 +0000142 Writer<ELFT>(*Symtab).run();
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000143}
144
Rui Ueyama75230392015-10-07 18:29:51 +0000145void lld::elf2::writeResult(SymbolTable *Symtab) {
146 switch (Symtab->getFirstELF()->getELFKind()) {
147 case ELF32LEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000148 doWriteResult<object::ELF32LE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000149 return;
150 case ELF32BEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000151 doWriteResult<object::ELF32BE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000152 return;
153 case ELF64LEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000154 doWriteResult<object::ELF64LE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000155 return;
156 case ELF64BEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000157 doWriteResult<object::ELF64BE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000158 return;
159 default:
160 llvm_unreachable("Invalid kind");
161 }
162}
Michael J. Spencer84487f12015-07-24 21:03:07 +0000163
164// The main function of the writer.
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000165template <class ELFT> void Writer<ELFT>::run() {
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000166 if (!Config->DiscardAll)
167 copyLocalSymbols();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000168 createSections();
169 assignAddresses();
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000170 openFile(Config->OutputFile);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000171 writeHeader();
172 writeSections();
173 error(Buffer->commit());
174}
175
Rafael Espindolaa7471792015-08-13 17:04:50 +0000176namespace {
177template <bool Is64Bits> struct SectionKey {
178 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
179 StringRef Name;
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000180 uint32_t Type;
181 uintX_t Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000182};
183}
184namespace llvm {
185template <bool Is64Bits> struct DenseMapInfo<SectionKey<Is64Bits>> {
186 static SectionKey<Is64Bits> getEmptyKey() {
187 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getEmptyKey(), 0, 0};
188 }
189 static SectionKey<Is64Bits> getTombstoneKey() {
190 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getTombstoneKey(), 0,
191 0};
192 }
193 static unsigned getHashValue(const SectionKey<Is64Bits> &Val) {
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000194 return hash_combine(Val.Name, Val.Type, Val.Flags);
Rafael Espindolaa7471792015-08-13 17:04:50 +0000195 }
196 static bool isEqual(const SectionKey<Is64Bits> &LHS,
197 const SectionKey<Is64Bits> &RHS) {
198 return DenseMapInfo<StringRef>::isEqual(LHS.Name, RHS.Name) &&
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000199 LHS.Type == RHS.Type && LHS.Flags == RHS.Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000200 }
201};
202}
203
Rafael Espindola19e38892015-09-16 15:54:15 +0000204// The reason we have to do this early scan is as follows
205// * To mmap the output file, we need to know the size
206// * For that, we need to know how many dynamic relocs we will have.
207// It might be possible to avoid this by outputting the file with write:
208// * Write the allocated output sections, computing addresses.
209// * Apply relocations, recording which ones require a dynamic reloc.
210// * Write the dynamic relocations.
211// * Write the rest of the file.
212template <class ELFT>
Rafael Espindola67a5da62015-09-17 14:02:10 +0000213template <bool isRela>
214void Writer<ELFT>::scanRelocs(
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000215 const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +0000216 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels) {
217 typedef Elf_Rel_Impl<ELFT, isRela> RelType;
218 const ObjectFile<ELFT> &File = *C.getFile();
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000219 bool IsMips64EL = File.getObj().isMips64EL();
Rafael Espindola67a5da62015-09-17 14:02:10 +0000220 for (const RelType &RI : Rels) {
221 uint32_t SymIndex = RI.getSymbol(IsMips64EL);
Rafael Espindola5c2310c2015-09-18 14:40:19 +0000222 SymbolBody *Body = File.getSymbolBody(SymIndex);
Rafael Espindolaeb792732015-09-21 15:11:29 +0000223 uint32_t Type = RI.getType(IsMips64EL);
Rafael Espindolaae244002015-10-05 19:30:12 +0000224 if (Body) {
225 if (Target->relocNeedsPlt(Type, *Body)) {
226 if (Body->isInPlt())
227 continue;
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000228 Out<ELFT>::Plt->addEntry(Body);
Rafael Espindolaae244002015-10-05 19:30:12 +0000229 }
230 if (Target->relocNeedsGot(Type, *Body)) {
231 if (Body->isInGot())
232 continue;
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000233 Out<ELFT>::Got->addEntry(Body);
Rafael Espindolaae244002015-10-05 19:30:12 +0000234 }
Rafael Espindolaeb792732015-09-21 15:11:29 +0000235 }
Rafael Espindolad5409192015-10-09 14:25:49 +0000236 if (canBePreempted(Body)) {
Rafael Espindolaa6627382015-10-06 23:56:53 +0000237 Body->setUsedInDynamicReloc();
Rafael Espindolad5409192015-10-09 14:25:49 +0000238 Out<ELFT>::RelaDyn->addReloc({C, RI});
239 } else if (Config->Shared && !Target->isRelRelative(Type)) {
240 Out<ELFT>::RelaDyn->addReloc({C, RI});
Rafael Espindolaa6627382015-10-06 23:56:53 +0000241 }
Rafael Espindola67a5da62015-09-17 14:02:10 +0000242 }
243}
244
245template <class ELFT>
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000246void Writer<ELFT>::scanRelocs(const InputSection<ELFT> &C) {
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000247 ObjectFile<ELFT> *File = C.getFile();
248 ELFFile<ELFT> &EObj = File->getObj();
Rafael Espindola19e38892015-09-16 15:54:15 +0000249
250 if (!(C.getSectionHdr()->sh_flags & SHF_ALLOC))
251 return;
252
253 for (const Elf_Shdr *RelSec : C.RelocSections) {
Rafael Espindola67a5da62015-09-17 14:02:10 +0000254 if (RelSec->sh_type == SHT_RELA)
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000255 scanRelocs(C, EObj.relas(RelSec));
Rafael Espindola67a5da62015-09-17 14:02:10 +0000256 else
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000257 scanRelocs(C, EObj.rels(RelSec));
Rafael Espindola19e38892015-09-16 15:54:15 +0000258 }
259}
260
Rafael Espindola6173f842015-09-23 14:37:01 +0000261template <class ELFT>
Rui Ueyama44f5d912015-10-01 14:46:54 +0000262static void reportUndefined(const SymbolTable &S, const SymbolBody &Sym) {
Rafael Espindola6173f842015-09-23 14:37:01 +0000263 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
264 typedef typename ELFFile<ELFT>::Elf_Sym_Range Elf_Sym_Range;
265
George Rimar57e40de2015-10-01 20:14:45 +0000266 if (Config->Shared && !Config->NoUndefined)
George Rimaree058282015-10-01 17:24:24 +0000267 return;
268
Rafael Espindola6173f842015-09-23 14:37:01 +0000269 const Elf_Sym &SymE = cast<ELFSymbolBody<ELFT>>(Sym).Sym;
270 ELFFileBase *SymFile = nullptr;
271
272 for (const std::unique_ptr<ObjectFileBase> &F : S.getObjectFiles()) {
273 const auto &File = cast<ObjectFile<ELFT>>(*F);
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000274 Elf_Sym_Range Syms = File.getObj().symbols(File.getSymbolTable());
Rafael Espindola6173f842015-09-23 14:37:01 +0000275 if (&SymE > Syms.begin() && &SymE < Syms.end())
276 SymFile = F.get();
277 }
Rafael Espindola551dfd82015-09-25 19:24:57 +0000278
279 std::string Message = "undefined symbol: " + Sym.getName().str();
Rafael Espindola6173f842015-09-23 14:37:01 +0000280 if (SymFile)
Rafael Espindola551dfd82015-09-25 19:24:57 +0000281 Message += " in " + SymFile->getName().str();
282 if (Config->NoInhibitExec)
283 warning(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000284 else
Rafael Espindola551dfd82015-09-25 19:24:57 +0000285 error(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000286}
287
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000288// Local symbols are not in the linker's symbol table. This function scans
289// each object file's symbol table to copy local symbols to the output.
290template <class ELFT> void Writer<ELFT>::copyLocalSymbols() {
291 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
292 auto &File = cast<ObjectFile<ELFT>>(*FileB);
293 for (const Elf_Sym &Sym : File.getLocalSymbols()) {
294 ErrorOr<StringRef> SymNameOrErr = Sym.getName(File.getStringTable());
295 error(SymNameOrErr);
296 StringRef SymName = *SymNameOrErr;
297 if (shouldKeepInSymtab<ELFT>(SymName, Sym))
298 Out<ELFT>::SymTab->addSymbol(SymName, true);
299 }
300 }
301}
302
303// Output section ordering is determined by this function.
304template <class ELFT>
305static bool compareOutputSections(OutputSectionBase<ELFT::Is64Bits> *A,
306 OutputSectionBase<ELFT::Is64Bits> *B) {
307 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
308
309 uintX_t AFlags = A->getFlags();
310 uintX_t BFlags = B->getFlags();
311
312 // Allocatable sections go first to reduce the total PT_LOAD size and
313 // so debug info doesn't change addresses in actual code.
314 bool AIsAlloc = AFlags & SHF_ALLOC;
315 bool BIsAlloc = BFlags & SHF_ALLOC;
316 if (AIsAlloc != BIsAlloc)
317 return AIsAlloc;
318
319 // We don't have any special requirements for the relative order of
320 // two non allocatable sections.
321 if (!AIsAlloc)
322 return false;
323
324 // We want the read only sections first so that they go in the PT_LOAD
325 // covering the program headers at the start of the file.
326 bool AIsWritable = AFlags & SHF_WRITE;
327 bool BIsWritable = BFlags & SHF_WRITE;
328 if (AIsWritable != BIsWritable)
329 return BIsWritable;
330
331 // For a corresponding reason, put non exec sections first (the program
332 // header PT_LOAD is not executable).
333 bool AIsExec = AFlags & SHF_EXECINSTR;
334 bool BIsExec = BFlags & SHF_EXECINSTR;
335 if (AIsExec != BIsExec)
336 return BIsExec;
337
338 // If we got here we know that both A and B and in the same PT_LOAD.
339 // The last requirement we have is to put nobits section last. The
340 // reason is that the only thing the dynamic linker will see about
341 // them is a p_memsz that is larger than p_filesz. Seeing that it
342 // zeros the end of the PT_LOAD, so that has to correspond to the
343 // nobits sections.
344 return A->getType() != SHT_NOBITS && B->getType() == SHT_NOBITS;
345}
346
347// Until this function is called, common symbols do not belong to any section.
348// This function adds them to end of BSS section.
349template <class ELFT>
350static void addCommonSymbols(std::vector<DefinedCommon<ELFT> *> &Syms) {
351 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
352 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
353
354 // Sort the common symbols by alignment as an heuristic to pack them better.
355 std::stable_sort(
356 Syms.begin(), Syms.end(),
357 [](const DefinedCommon<ELFT> *A, const DefinedCommon<ELFT> *B) {
358 return A->MaxAlignment > B->MaxAlignment;
359 });
360
361 uintX_t Off = Out<ELFT>::Bss->getSize();
362 for (DefinedCommon<ELFT> *C : Syms) {
363 const Elf_Sym &Sym = C->Sym;
364 uintX_t Align = C->MaxAlignment;
365 Off = RoundUpToAlignment(Off, Align);
366 C->OffsetInBSS = Off;
367 Off += Sym.st_size;
368 }
369
370 Out<ELFT>::Bss->setSize(Off);
371}
372
Michael J. Spencer84487f12015-07-24 21:03:07 +0000373// Create output section objects and add them to OutputSections.
374template <class ELFT> void Writer<ELFT>::createSections() {
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000375 SmallDenseMap<SectionKey<ELFT::Is64Bits>, OutputSection<ELFT> *> Map;
Rafael Espindolac2d21192015-09-23 18:25:05 +0000376
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000377 OutputSections.push_back(Out<ELFT>::Bss);
378 Map[{Out<ELFT>::Bss->getName(), Out<ELFT>::Bss->getType(),
379 Out<ELFT>::Bss->getFlags()}] = Out<ELFT>::Bss;
Rafael Espindolac2d21192015-09-23 18:25:05 +0000380
Rafael Espindolac05ad3d2015-10-07 02:51:44 +0000381 // Declare linker generated symbols.
382 // This must be done before the relocation scan to make sure we can correctly
383 // decide if a dynamic relocation is needed or not.
384 // FIXME: Make this more declarative.
385 for (StringRef Name :
386 {"__preinit_array_start", "__preinit_array_end", "__init_array_start",
387 "__init_array_end", "__fini_array_start", "__fini_array_end"})
388 Symtab.addIgnoredSym<ELFT>(Name);
389
390 // __tls_get_addr is defined by the dynamic linker for dynamic ELFs. For
391 // static linking the linker is required to optimize away any references to
392 // __tls_get_addr, so it's not defined anywhere. Create a hidden definition
393 // to avoid the undefined symbol error.
394 if (!isOutputDynamic())
395 Symtab.addIgnoredSym<ELFT>("__tls_get_addr");
396
Rafael Espindola19e38892015-09-16 15:54:15 +0000397 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
398 auto &File = cast<ObjectFile<ELFT>>(*FileB);
Rafael Espindola71675852015-09-22 00:16:19 +0000399 for (InputSection<ELFT> *C : File.getSections()) {
Rafael Espindola19e38892015-09-16 15:54:15 +0000400 if (!C)
401 continue;
402 const Elf_Shdr *H = C->getSectionHdr();
Rafael Espindolad13d9602015-09-25 15:08:44 +0000403 SectionKey<ELFT::Is64Bits> Key{C->getSectionName(), H->sh_type,
404 H->sh_flags};
405 OutputSection<ELFT> *&Sec = Map[Key];
406 if (!Sec) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000407 Sec = new (CAlloc.Allocate())
408 OutputSection<ELFT>(Key.Name, Key.Type, Key.Flags);
Rafael Espindolad13d9602015-09-25 15:08:44 +0000409 OutputSections.push_back(Sec);
410 }
Rafael Espindola71675852015-09-22 00:16:19 +0000411 Sec->addSection(C);
Rafael Espindola19e38892015-09-16 15:54:15 +0000412 scanRelocs(*C);
413 }
414 }
415
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000416 Out<ELFT>::Dynamic->PreInitArraySec =
Rafael Espindola77572242015-10-02 19:37:55 +0000417 Map.lookup({".preinit_array", SHT_PREINIT_ARRAY, SHF_WRITE | SHF_ALLOC});
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000418 Out<ELFT>::Dynamic->InitArraySec =
Rafael Espindola77572242015-10-02 19:37:55 +0000419 Map.lookup({".init_array", SHT_INIT_ARRAY, SHF_WRITE | SHF_ALLOC});
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000420 Out<ELFT>::Dynamic->FiniArraySec =
Rafael Espindola77572242015-10-02 19:37:55 +0000421 Map.lookup({".fini_array", SHT_FINI_ARRAY, SHF_WRITE | SHF_ALLOC});
422
Rui Ueyama0d0bcf72015-10-07 21:25:39 +0000423 auto AddStartEnd = [&](StringRef Start, StringRef End,
424 OutputSection<ELFT> *OS) {
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000425 if (OS) {
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000426 Symtab.addSyntheticSym<ELFT>(Start, *OS, 0);
427 Symtab.addSyntheticSym<ELFT>(End, *OS, OS->getSize());
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000428 }
429 };
430
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000431 AddStartEnd("__preinit_array_start", "__preinit_array_end",
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000432 Out<ELFT>::Dynamic->PreInitArraySec);
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000433 AddStartEnd("__init_array_start", "__init_array_end",
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000434 Out<ELFT>::Dynamic->InitArraySec);
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000435 AddStartEnd("__fini_array_start", "__fini_array_end",
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000436 Out<ELFT>::Dynamic->FiniArraySec);
Rafael Espindola0e604f92015-09-25 18:56:53 +0000437
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000438 // FIXME: Try to avoid the extra walk over all global symbols.
439 std::vector<DefinedCommon<ELFT> *> CommonSymbols;
440 for (auto &P : Symtab.getSymbols()) {
441 StringRef Name = P.first;
442 SymbolBody *Body = P.second->Body;
Denis Protivensky22220d52015-10-05 09:43:57 +0000443 if (auto *U = dyn_cast<Undefined<ELFT>>(Body)) {
444 if (!U->isWeak() && !U->canKeepUndefined())
445 reportUndefined<ELFT>(Symtab, *Body);
446 }
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000447
448 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
449 CommonSymbols.push_back(C);
Rafael Espindola4f674ed2015-10-05 15:24:04 +0000450 if (!includeInSymtab<ELFT>(*Body))
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000451 continue;
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000452 Out<ELFT>::SymTab->addSymbol(Name);
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000453
454 if (needsDynamicSections() && includeInDynamicSymtab(*Body))
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000455 Out<ELFT>::HashTab->addSymbol(Body);
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000456 }
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000457 addCommonSymbols(CommonSymbols);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000458
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000459 OutputSections.push_back(Out<ELFT>::SymTab);
Rafael Espindola4340aad2015-09-11 22:42:45 +0000460 if (needsDynamicSections()) {
Rafael Espindola70107762015-09-11 18:49:42 +0000461 if (needsInterpSection())
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000462 OutputSections.push_back(Out<ELFT>::Interp);
463 OutputSections.push_back(Out<ELFT>::DynSymTab);
464 OutputSections.push_back(Out<ELFT>::HashTab);
465 OutputSections.push_back(Out<ELFT>::Dynamic);
466 OutputSections.push_back(Out<ELFT>::DynStrTab);
467 if (Out<ELFT>::RelaDyn->hasRelocs())
468 OutputSections.push_back(Out<ELFT>::RelaDyn);
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000469 }
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000470 if (!Out<ELFT>::Got->empty())
471 OutputSections.push_back(Out<ELFT>::Got);
472 if (!Out<ELFT>::Plt->empty())
473 OutputSections.push_back(Out<ELFT>::Plt);
Rafael Espindola740fafe2015-09-08 19:43:27 +0000474
Rui Ueyama5a9640b2015-10-08 23:49:30 +0000475 std::stable_sort(OutputSections.begin(), OutputSections.end(),
476 compareOutputSections<ELFT>);
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000477
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000478 // Always put StrTabSec last so that no section names are added to it after
479 // it's finalized.
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000480 OutputSections.push_back(Out<ELFT>::StrTab);
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000481
Rafael Espindolab01b5742015-09-08 18:08:57 +0000482 for (unsigned I = 0, N = OutputSections.size(); I < N; ++I)
483 OutputSections[I]->setSectionIndex(I + 1);
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000484
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000485 // Fill the DynStrTab early.
486 Out<ELFT>::Dynamic->finalize();
Rafael Espindolaabad6182015-08-13 15:23:46 +0000487}
488
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000489template <class ELFT>
Rui Ueyama04dae552015-10-02 21:23:17 +0000490static bool needsPHDR(OutputSectionBase<ELFT::Is64Bits> *Sec) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000491 return Sec->getFlags() & SHF_ALLOC;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000492}
493
Michael J. Spencer84487f12015-07-24 21:03:07 +0000494// Visits all sections to assign incremental, non-overlapping RVAs and
495// file offsets.
496template <class ELFT> void Writer<ELFT>::assignAddresses() {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000497 assert(!OutputSections.empty() && "No output sections to layout!");
Rafael Espindola4340aad2015-09-11 22:42:45 +0000498 uintX_t VA = getVAStart();
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000499 uintX_t FileOff = 0;
Rafael Espindola60252d82015-09-09 22:53:55 +0000500
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000501 FileOff += sizeof(Elf_Ehdr);
502 VA += sizeof(Elf_Ehdr);
Rafael Espindolaabad6182015-08-13 15:23:46 +0000503
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000504 // Reserve space for PHDRs.
505 ProgramHeaderOff = FileOff;
Hal Finkele3c26262015-10-08 22:23:54 +0000506 FileOff = RoundUpToAlignment(FileOff, Target->getPageSize());
507 VA = RoundUpToAlignment(VA, Target->getPageSize());
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000508
Rafael Espindola70107762015-09-11 18:49:42 +0000509 if (needsInterpSection())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000510 PHDRs.push_back(&InterpPHDR);
Rafael Espindola70107762015-09-11 18:49:42 +0000511
Michael J. Spencer2f008242015-09-17 19:58:07 +0000512 // Create a PHDR for the file header.
513 PHDRs.push_back(&FileHeaderPHDR);
514 FileHeaderPHDR.Header.p_vaddr = getVAStart();
515 FileHeaderPHDR.Header.p_paddr = getVAStart();
Hal Finkele3c26262015-10-08 22:23:54 +0000516 FileHeaderPHDR.Header.p_align = Target->getPageSize();
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000517
Rafael Espindolaebd21082015-08-13 22:14:37 +0000518 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000519 Out<ELFT>::StrTab->add(Sec->getName());
Rafael Espindolaebd21082015-08-13 22:14:37 +0000520 Sec->finalize();
521
Michael J. Spencer2f008242015-09-17 19:58:07 +0000522 if (Sec->getSize()) {
Rui Ueyama04dae552015-10-02 21:23:17 +0000523 uintX_t Flags = toPHDRFlags(Sec->getFlags());
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000524 ProgramHeader<ELFT> *Last = PHDRs.back();
Rui Ueyama04dae552015-10-02 21:23:17 +0000525 if (Last->Header.p_flags != Flags || !needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000526 // Flags changed. End current PHDR and potentially create a new one.
Rui Ueyama04dae552015-10-02 21:23:17 +0000527 if (!Last->Closed) {
528 Last->Header.p_filesz = FileOff - Last->Header.p_offset;
529 Last->Header.p_memsz = VA - Last->Header.p_vaddr;
530 Last->Closed = true;
Michael J. Spencer2f008242015-09-17 19:58:07 +0000531 }
532
Rui Ueyama04dae552015-10-02 21:23:17 +0000533 if (needsPHDR<ELFT>(Sec)) {
Hal Finkele3c26262015-10-08 22:23:54 +0000534 VA = RoundUpToAlignment(VA, Target->getPageSize());
535 FileOff = RoundUpToAlignment(FileOff, Target->getPageSize());
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000536 PHDRs.push_back(new (PAlloc)
537 ProgramHeader<ELFT>(PT_LOAD, Flags, FileOff, VA));
Michael J. Spencer2f008242015-09-17 19:58:07 +0000538 }
539 }
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000540 }
541
Rafael Espindola2db634d2015-08-13 20:24:18 +0000542 uintX_t Align = Sec->getAlign();
543 uintX_t Size = Sec->getSize();
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000544 if (Sec->getFlags() & SHF_ALLOC) {
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000545 VA = RoundUpToAlignment(VA, Align);
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000546 Sec->setVA(VA);
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000547 VA += Size;
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000548 }
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000549 FileOff = RoundUpToAlignment(FileOff, Align);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000550 Sec->setFileOffset(FileOff);
Rafael Espindola058f3432015-08-31 20:23:57 +0000551 if (Sec->getType() != SHT_NOBITS)
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000552 FileOff += Size;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000553 }
Rafael Espindola6b83b902015-08-12 00:00:24 +0000554
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000555 // Add a PHDR for the dynamic table.
Rafael Espindola4340aad2015-09-11 22:42:45 +0000556 if (needsDynamicSections())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000557 PHDRs.push_back(&DynamicPHDR);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000558
Rafael Espindola91009b32015-08-12 01:45:28 +0000559 FileOff += OffsetToAlignment(FileOff, ELFT::Is64Bits ? 8 : 4);
560
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000561 // Add space for section headers.
562 SectionHeaderOff = FileOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000563 FileOff += getNumSections() * sizeof(Elf_Shdr);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000564 FileSize = FileOff;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000565}
566
567template <class ELFT> void Writer<ELFT>::writeHeader() {
568 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindola18608a02015-09-08 21:57:31 +0000569 auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000570 EHdr->e_ident[EI_MAG0] = 0x7F;
571 EHdr->e_ident[EI_MAG1] = 0x45;
572 EHdr->e_ident[EI_MAG2] = 0x4C;
573 EHdr->e_ident[EI_MAG3] = 0x46;
Rafael Espindola4b7c2fc2015-08-05 15:08:40 +0000574 EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
575 EHdr->e_ident[EI_DATA] = ELFT::TargetEndianness == llvm::support::little
576 ? ELFDATA2LSB
577 : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000578 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Davide Italianoaa7c5332015-09-25 01:59:13 +0000579
Davide Italianoaa7c5332015-09-25 01:59:13 +0000580 auto &FirstObj = cast<ObjectFile<ELFT>>(*Symtab.getFirstELF());
581 EHdr->e_ident[EI_OSABI] = FirstObj.getOSABI();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000582
Rafael Espindolae438e072015-09-08 22:55:28 +0000583 // FIXME: Generalize the segment construction similar to how we create
584 // output sections.
Rafael Espindolae438e072015-09-08 22:55:28 +0000585
Rafael Espindola4340aad2015-09-11 22:42:45 +0000586 EHdr->e_type = Config->Shared ? ET_DYN : ET_EXEC;
Rafael Espindolaf98d6d82015-09-03 20:03:54 +0000587 EHdr->e_machine = FirstObj.getEMachine();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000588 EHdr->e_version = EV_CURRENT;
Rafael Espindola4340aad2015-09-11 22:42:45 +0000589 SymbolBody *Entry = Symtab.getEntrySym();
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000590 EHdr->e_entry = Entry ? getSymVA<ELFT>(cast<ELFSymbolBody<ELFT>>(*Entry)) : 0;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000591 EHdr->e_phoff = ProgramHeaderOff;
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000592 EHdr->e_shoff = SectionHeaderOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000593 EHdr->e_ehsize = sizeof(Elf_Ehdr);
594 EHdr->e_phentsize = sizeof(Elf_Phdr);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000595 EHdr->e_phnum = PHDRs.size();
Rafael Espindola18608a02015-09-08 21:57:31 +0000596 EHdr->e_shentsize = sizeof(Elf_Shdr);
Rafael Espindola5f553872015-09-08 17:39:39 +0000597 EHdr->e_shnum = getNumSections();
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000598 EHdr->e_shstrndx = Out<ELFT>::StrTab->getSectionIndex();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000599
Michael J. Spencer2f008242015-09-17 19:58:07 +0000600 // If nothing was merged into the file header PT_LOAD, set the size correctly.
Hal Finkele3c26262015-10-08 22:23:54 +0000601 if (FileHeaderPHDR.Header.p_filesz == Target->getPageSize()) {
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000602 uint64_t Size = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * PHDRs.size();
603 FileHeaderPHDR.Header.p_filesz = Size;
604 FileHeaderPHDR.Header.p_memsz = Size;
605 }
Michael J. Spencer2f008242015-09-17 19:58:07 +0000606
607 if (needsInterpSection())
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000608 InterpPHDR.setValuesFromSection(Out<ELFT>::Interp);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000609 if (needsDynamicSections())
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000610 DynamicPHDR.setValuesFromSection(Out<ELFT>::Dynamic);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000611
Rafael Espindola18608a02015-09-08 21:57:31 +0000612 auto PHdrs = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000613 for (ProgramHeader<ELFT> *PHDR : PHDRs)
614 *PHdrs++ = PHDR->Header;
Rafael Espindolae438e072015-09-08 22:55:28 +0000615
Rafael Espindola18608a02015-09-08 21:57:31 +0000616 auto SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000617 // First entry is null.
618 ++SHdrs;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000619 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000620 Sec->setNameOffset(Out<ELFT>::StrTab->getFileOff(Sec->getName()));
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000621 Sec->template writeHeaderTo<ELFT::TargetEndianness>(SHdrs++);
Rafael Espindola6b83b902015-08-12 00:00:24 +0000622 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000623}
624
625template <class ELFT> void Writer<ELFT>::openFile(StringRef Path) {
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +0000626 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
627 FileOutputBuffer::create(Path, FileSize, FileOutputBuffer::F_executable);
628 error(BufferOrErr, Twine("failed to open ") + Path);
629 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000630}
631
632// Write section contents to a mmap'ed file.
633template <class ELFT> void Writer<ELFT>::writeSections() {
634 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000635 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections)
Rui Ueyama8050d322015-08-14 05:17:30 +0000636 Sec->writeTo(Buf + Sec->getFileOff());
Michael J. Spencer84487f12015-07-24 21:03:07 +0000637}