blob: 7c842533f2379178f42c2edb63e2ba228ac936bd [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
25static const int PageSize = 4096;
26
Rafael Espindolad67bb262015-09-11 13:20:07 +000027// On freebsd x86_64 the first page cannot be mmaped.
28// On linux that is controled by vm.mmap_min_addr. At least on some x86_64
29// installs that is 65536, so the first 15 pages cannot be used.
30// Given that, the smallest value that can be used in here is 0x10000.
Rafael Espindola0a2e2112015-09-10 15:41:34 +000031// If using 2MB pages, the smallest page aligned address that works is
32// 0x200000, but it looks like every OS uses 4k pages for executables.
33// FIXME: This is architecture and OS dependent.
34static const int VAStart = 0x10000;
35
Rui Ueyamaafff74e22015-08-05 23:24:46 +000036namespace {
Rafael Espindola740fafe2015-09-08 19:43:27 +000037
Rui Ueyama04dae552015-10-02 21:23:17 +000038static uint32_t toPHDRFlags(uint64_t Flags) {
Michael J. Spencer2f008242015-09-17 19:58:07 +000039 uint32_t Ret = PF_R;
40 if (Flags & SHF_WRITE)
41 Ret |= PF_W;
Michael J. Spencer2f008242015-09-17 19:58:07 +000042 if (Flags & SHF_EXECINSTR)
43 Ret |= PF_X;
Michael J. Spencer2f008242015-09-17 19:58:07 +000044 return Ret;
45}
46
Rui Ueyama5713b8d2015-10-02 22:17:07 +000047template <class ELFT> struct ProgramHeader {
48 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
49 typedef typename ELFFile<ELFT>::Elf_Phdr Elf_Phdr;
Michael J. Spencer2f008242015-09-17 19:58:07 +000050
Rui Ueyama04dae552015-10-02 21:23:17 +000051 ProgramHeader(uintX_t Type, uintX_t Flags, uintX_t FileOff, uintX_t VA) {
Rui Ueyama5713b8d2015-10-02 22:17:07 +000052 std::memset(&Header, 0, sizeof(Elf_Phdr));
Rui Ueyama0fb1ee02015-10-02 21:13:19 +000053 Header.p_type = Type;
54 Header.p_flags = Flags;
Michael J. Spencer2f008242015-09-17 19:58:07 +000055 Header.p_align = PageSize;
Rui Ueyama04dae552015-10-02 21:23:17 +000056 Header.p_offset = FileOff;
57 Header.p_vaddr = VA;
58 Header.p_paddr = VA;
Michael J. Spencer2f008242015-09-17 19:58:07 +000059 }
60
Rui Ueyama15ef5e12015-10-07 19:18:16 +000061 void setValuesFromSection(OutputSectionBase<ELFT::Is64Bits> *Sec) {
62 Header.p_flags = toPHDRFlags(Sec->getFlags());
63 Header.p_offset = Sec->getFileOff();
64 Header.p_vaddr = Sec->getVA();
Michael J. Spencer2f008242015-09-17 19:58:07 +000065 Header.p_paddr = Header.p_vaddr;
Rui Ueyama15ef5e12015-10-07 19:18:16 +000066 Header.p_filesz = Sec->getSize();
Michael J. Spencer2f008242015-09-17 19:58:07 +000067 Header.p_memsz = Header.p_filesz;
Rui Ueyama15ef5e12015-10-07 19:18:16 +000068 Header.p_align = Sec->getAlign();
Michael J. Spencer2f008242015-09-17 19:58:07 +000069 }
70
Rui Ueyama5713b8d2015-10-02 22:17:07 +000071 Elf_Phdr Header;
Michael J. Spencer2f008242015-09-17 19:58:07 +000072 bool Closed = false;
73};
74
Rui Ueyamaafff74e22015-08-05 23:24:46 +000075// The writer writes a SymbolTable result to a file.
76template <class ELFT> class Writer {
77public:
Rafael Espindola18608a02015-09-08 21:57:31 +000078 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
79 typedef typename ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
80 typedef typename ELFFile<ELFT>::Elf_Ehdr Elf_Ehdr;
81 typedef typename ELFFile<ELFT>::Elf_Phdr Elf_Phdr;
82 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
Davide Italiano6d328d32015-09-16 20:45:57 +000083 typedef typename ELFFile<ELFT>::Elf_Sym_Range Elf_Sym_Range;
Rafael Espindola19e38892015-09-16 15:54:15 +000084 typedef typename ELFFile<ELFT>::Elf_Rela Elf_Rela;
Rui Ueyamaafff74e22015-08-05 23:24:46 +000085 void run();
86
87private:
88 void createSections();
Rafael Espindola67a5da62015-09-17 14:02:10 +000089 template <bool isRela>
Rafael Espindola53d5cea2015-09-21 17:47:00 +000090 void scanRelocs(const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +000091 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels);
Rafael Espindola53d5cea2015-09-21 17:47:00 +000092 void scanRelocs(const InputSection<ELFT> &C);
Rui Ueyamaafff74e22015-08-05 23:24:46 +000093 void assignAddresses();
94 void openFile(StringRef OutputPath);
95 void writeHeader();
96 void writeSections();
Rafael Espindola70107762015-09-11 18:49:42 +000097 bool needsInterpSection() const {
Rui Ueyama15ef5e12015-10-07 19:18:16 +000098 return !Out<ELFT>::SymTab->getSymTable().getSharedFiles().empty() &&
Rafael Espindola70107762015-09-11 18:49:42 +000099 !Config->DynamicLinker.empty();
100 }
Michael J. Spencerf32446f2015-10-06 20:39:09 +0000101 bool isOutputDynamic() const {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000102 return !Out<ELFT>::SymTab->getSymTable().getSharedFiles().empty() ||
103 Config->Shared;
Rafael Espindola4340aad2015-09-11 22:42:45 +0000104 }
Michael J. Spencerf32446f2015-10-06 20:39:09 +0000105 bool needsDynamicSections() const { return isOutputDynamic(); }
Rafael Espindola4340aad2015-09-11 22:42:45 +0000106 unsigned getVAStart() const { return Config->Shared ? 0 : VAStart; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000107
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000108 std::unique_ptr<llvm::FileOutputBuffer> Buffer;
Michael J. Spencer2f008242015-09-17 19:58:07 +0000109
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000110 llvm::SpecificBumpPtrAllocator<OutputSection<ELFT>> CAlloc;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000111 std::vector<OutputSectionBase<ELFT::Is64Bits> *> OutputSections;
Rafael Espindola5f553872015-09-08 17:39:39 +0000112 unsigned getNumSections() const { return OutputSections.size() + 1; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000113
Michael J. Spencer2f008242015-09-17 19:58:07 +0000114 llvm::BumpPtrAllocator PAlloc;
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000115 std::vector<ProgramHeader<ELFT> *> PHDRs;
116 ProgramHeader<ELFT> FileHeaderPHDR{PT_LOAD, PF_R, 0, 0};
117 ProgramHeader<ELFT> InterpPHDR{PT_INTERP, 0, 0, 0};
118 ProgramHeader<ELFT> DynamicPHDR{PT_DYNAMIC, 0, 0, 0};
Michael J. Spencer2f008242015-09-17 19:58:07 +0000119
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000120 uintX_t FileSize;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000121 uintX_t ProgramHeaderOff;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000122 uintX_t SectionHeaderOff;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000123};
124} // anonymous namespace
125
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000126template <class ELFT> static void doWriteResult(SymbolTable *Symtab) {
127 // Initialize output sections that are handled by Writer specially.
128 // Don't reorder because the order of initialization matters.
129 InterpSection<ELFT::Is64Bits> Interp;
130 Out<ELFT>::Interp = &Interp;
131 StringTableSection<ELFT::Is64Bits> StrTab(false);
132 Out<ELFT>::StrTab = &StrTab;
133 StringTableSection<ELFT::Is64Bits> DynStrTab(true);
134 Out<ELFT>::DynStrTab = &DynStrTab;
135 OutputSection<ELFT> Bss(".bss", SHT_NOBITS, SHF_ALLOC | SHF_WRITE);
136 Out<ELFT>::Bss = &Bss;
137 GotSection<ELFT> Got;
138 Out<ELFT>::Got = &Got;
139 PltSection<ELFT> Plt;
140 Out<ELFT>::Plt = &Plt;
141 SymbolTableSection<ELFT> SymTab(*Symtab, *Out<ELFT>::StrTab);
142 Out<ELFT>::SymTab = &SymTab;
143 SymbolTableSection<ELFT> DynSymTab(*Symtab, *Out<ELFT>::DynStrTab);
144 Out<ELFT>::DynSymTab = &DynSymTab;
145 HashTableSection<ELFT> HashTab;
146 Out<ELFT>::HashTab = &HashTab;
147 RelocationSection<ELFT> RelaDyn(Symtab->shouldUseRela());
148 Out<ELFT>::RelaDyn = &RelaDyn;
149 DynamicSection<ELFT> Dynamic(*Symtab);
150 Out<ELFT>::Dynamic = &Dynamic;
151
152 Writer<ELFT>().run();
153}
154
Rui Ueyama75230392015-10-07 18:29:51 +0000155void lld::elf2::writeResult(SymbolTable *Symtab) {
156 switch (Symtab->getFirstELF()->getELFKind()) {
157 case ELF32LEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000158 doWriteResult<object::ELF32LE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000159 return;
160 case ELF32BEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000161 doWriteResult<object::ELF32BE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000162 return;
163 case ELF64LEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000164 doWriteResult<object::ELF64LE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000165 return;
166 case ELF64BEKind:
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000167 doWriteResult<object::ELF64BE>(Symtab);
Rui Ueyama75230392015-10-07 18:29:51 +0000168 return;
169 default:
170 llvm_unreachable("Invalid kind");
171 }
172}
Michael J. Spencer84487f12015-07-24 21:03:07 +0000173
174// The main function of the writer.
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000175template <class ELFT> void Writer<ELFT>::run() {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000176 createSections();
177 assignAddresses();
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000178 openFile(Config->OutputFile);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000179 writeHeader();
180 writeSections();
181 error(Buffer->commit());
182}
183
Rafael Espindolaa7471792015-08-13 17:04:50 +0000184namespace {
185template <bool Is64Bits> struct SectionKey {
186 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
187 StringRef Name;
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000188 uint32_t Type;
189 uintX_t Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000190};
191}
192namespace llvm {
193template <bool Is64Bits> struct DenseMapInfo<SectionKey<Is64Bits>> {
194 static SectionKey<Is64Bits> getEmptyKey() {
195 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getEmptyKey(), 0, 0};
196 }
197 static SectionKey<Is64Bits> getTombstoneKey() {
198 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getTombstoneKey(), 0,
199 0};
200 }
201 static unsigned getHashValue(const SectionKey<Is64Bits> &Val) {
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000202 return hash_combine(Val.Name, Val.Type, Val.Flags);
Rafael Espindolaa7471792015-08-13 17:04:50 +0000203 }
204 static bool isEqual(const SectionKey<Is64Bits> &LHS,
205 const SectionKey<Is64Bits> &RHS) {
206 return DenseMapInfo<StringRef>::isEqual(LHS.Name, RHS.Name) &&
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000207 LHS.Type == RHS.Type && LHS.Flags == RHS.Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000208 }
209};
210}
211
Rafael Espindola19e38892015-09-16 15:54:15 +0000212// The reason we have to do this early scan is as follows
213// * To mmap the output file, we need to know the size
214// * For that, we need to know how many dynamic relocs we will have.
215// It might be possible to avoid this by outputting the file with write:
216// * Write the allocated output sections, computing addresses.
217// * Apply relocations, recording which ones require a dynamic reloc.
218// * Write the dynamic relocations.
219// * Write the rest of the file.
220template <class ELFT>
Rafael Espindola67a5da62015-09-17 14:02:10 +0000221template <bool isRela>
222void Writer<ELFT>::scanRelocs(
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000223 const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +0000224 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels) {
225 typedef Elf_Rel_Impl<ELFT, isRela> RelType;
226 const ObjectFile<ELFT> &File = *C.getFile();
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000227 bool IsMips64EL = File.getObj().isMips64EL();
Rafael Espindola67a5da62015-09-17 14:02:10 +0000228 for (const RelType &RI : Rels) {
229 uint32_t SymIndex = RI.getSymbol(IsMips64EL);
Rafael Espindola5c2310c2015-09-18 14:40:19 +0000230 SymbolBody *Body = File.getSymbolBody(SymIndex);
Rafael Espindolaeb792732015-09-21 15:11:29 +0000231 uint32_t Type = RI.getType(IsMips64EL);
Rafael Espindolaae244002015-10-05 19:30:12 +0000232 if (Body) {
233 if (Target->relocNeedsPlt(Type, *Body)) {
234 if (Body->isInPlt())
235 continue;
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000236 Out<ELFT>::Plt->addEntry(Body);
Rafael Espindolaae244002015-10-05 19:30:12 +0000237 }
238 if (Target->relocNeedsGot(Type, *Body)) {
239 if (Body->isInGot())
240 continue;
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000241 Out<ELFT>::Got->addEntry(Body);
Rafael Espindolaae244002015-10-05 19:30:12 +0000242 }
Rafael Espindolaeb792732015-09-21 15:11:29 +0000243 }
Rafael Espindolaa6627382015-10-06 23:56:53 +0000244 if (canBePreempted(Body)) {
245 Body->setUsedInDynamicReloc();
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000246 Out<ELFT>::RelaDyn->addReloc({C, RI});
Rafael Espindolaa6627382015-10-06 23:56:53 +0000247 } else if (Config->Shared && !Target->isRelRelative(Type)) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000248 Out<ELFT>::RelaDyn->addReloc({C, RI});
Rafael Espindolaa6627382015-10-06 23:56:53 +0000249 }
Rafael Espindola67a5da62015-09-17 14:02:10 +0000250 }
251}
252
253template <class ELFT>
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000254void Writer<ELFT>::scanRelocs(const InputSection<ELFT> &C) {
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000255 ObjectFile<ELFT> *File = C.getFile();
256 ELFFile<ELFT> &EObj = File->getObj();
Rafael Espindola19e38892015-09-16 15:54:15 +0000257
258 if (!(C.getSectionHdr()->sh_flags & SHF_ALLOC))
259 return;
260
261 for (const Elf_Shdr *RelSec : C.RelocSections) {
Rafael Espindola67a5da62015-09-17 14:02:10 +0000262 if (RelSec->sh_type == SHT_RELA)
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000263 scanRelocs(C, EObj.relas(RelSec));
Rafael Espindola67a5da62015-09-17 14:02:10 +0000264 else
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000265 scanRelocs(C, EObj.rels(RelSec));
Rafael Espindola19e38892015-09-16 15:54:15 +0000266 }
267}
268
Rafael Espindola6173f842015-09-23 14:37:01 +0000269template <class ELFT>
Rui Ueyama44f5d912015-10-01 14:46:54 +0000270static void reportUndefined(const SymbolTable &S, const SymbolBody &Sym) {
Rafael Espindola6173f842015-09-23 14:37:01 +0000271 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
272 typedef typename ELFFile<ELFT>::Elf_Sym_Range Elf_Sym_Range;
273
George Rimar57e40de2015-10-01 20:14:45 +0000274 if (Config->Shared && !Config->NoUndefined)
George Rimaree058282015-10-01 17:24:24 +0000275 return;
276
Rafael Espindola6173f842015-09-23 14:37:01 +0000277 const Elf_Sym &SymE = cast<ELFSymbolBody<ELFT>>(Sym).Sym;
278 ELFFileBase *SymFile = nullptr;
279
280 for (const std::unique_ptr<ObjectFileBase> &F : S.getObjectFiles()) {
281 const auto &File = cast<ObjectFile<ELFT>>(*F);
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000282 Elf_Sym_Range Syms = File.getObj().symbols(File.getSymbolTable());
Rafael Espindola6173f842015-09-23 14:37:01 +0000283 if (&SymE > Syms.begin() && &SymE < Syms.end())
284 SymFile = F.get();
285 }
Rafael Espindola551dfd82015-09-25 19:24:57 +0000286
287 std::string Message = "undefined symbol: " + Sym.getName().str();
Rafael Espindola6173f842015-09-23 14:37:01 +0000288 if (SymFile)
Rafael Espindola551dfd82015-09-25 19:24:57 +0000289 Message += " in " + SymFile->getName().str();
290 if (Config->NoInhibitExec)
291 warning(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000292 else
Rafael Espindola551dfd82015-09-25 19:24:57 +0000293 error(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000294}
295
Michael J. Spencer84487f12015-07-24 21:03:07 +0000296// Create output section objects and add them to OutputSections.
297template <class ELFT> void Writer<ELFT>::createSections() {
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000298 SmallDenseMap<SectionKey<ELFT::Is64Bits>, OutputSection<ELFT> *> Map;
Rafael Espindolac2d21192015-09-23 18:25:05 +0000299
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000300 OutputSections.push_back(Out<ELFT>::Bss);
301 Map[{Out<ELFT>::Bss->getName(), Out<ELFT>::Bss->getType(),
302 Out<ELFT>::Bss->getFlags()}] = Out<ELFT>::Bss;
Rafael Espindolac2d21192015-09-23 18:25:05 +0000303
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000304 SymbolTable &Symtab = Out<ELFT>::SymTab->getSymTable();
Rafael Espindolac05ad3d2015-10-07 02:51:44 +0000305
306 // Declare linker generated symbols.
307 // This must be done before the relocation scan to make sure we can correctly
308 // decide if a dynamic relocation is needed or not.
309 // FIXME: Make this more declarative.
310 for (StringRef Name :
311 {"__preinit_array_start", "__preinit_array_end", "__init_array_start",
312 "__init_array_end", "__fini_array_start", "__fini_array_end"})
313 Symtab.addIgnoredSym<ELFT>(Name);
314
315 // __tls_get_addr is defined by the dynamic linker for dynamic ELFs. For
316 // static linking the linker is required to optimize away any references to
317 // __tls_get_addr, so it's not defined anywhere. Create a hidden definition
318 // to avoid the undefined symbol error.
319 if (!isOutputDynamic())
320 Symtab.addIgnoredSym<ELFT>("__tls_get_addr");
321
Rafael Espindola19e38892015-09-16 15:54:15 +0000322 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
323 auto &File = cast<ObjectFile<ELFT>>(*FileB);
Davide Italiano6d328d32015-09-16 20:45:57 +0000324 if (!Config->DiscardAll) {
325 Elf_Sym_Range Syms = File.getLocalSymbols();
326 for (const Elf_Sym &Sym : Syms) {
327 ErrorOr<StringRef> SymName = Sym.getName(File.getStringTable());
Rafael Espindolad1cf4212015-10-05 16:25:43 +0000328 if (SymName && shouldKeepInSymtab<ELFT>(*SymName, Sym))
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000329 Out<ELFT>::SymTab->addSymbol(*SymName, true);
Davide Italiano6d328d32015-09-16 20:45:57 +0000330 }
331 }
Rafael Espindola71675852015-09-22 00:16:19 +0000332 for (InputSection<ELFT> *C : File.getSections()) {
Rafael Espindola19e38892015-09-16 15:54:15 +0000333 if (!C)
334 continue;
335 const Elf_Shdr *H = C->getSectionHdr();
Rafael Espindolad13d9602015-09-25 15:08:44 +0000336 SectionKey<ELFT::Is64Bits> Key{C->getSectionName(), H->sh_type,
337 H->sh_flags};
338 OutputSection<ELFT> *&Sec = Map[Key];
339 if (!Sec) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000340 Sec = new (CAlloc.Allocate())
341 OutputSection<ELFT>(Key.Name, Key.Type, Key.Flags);
Rafael Espindolad13d9602015-09-25 15:08:44 +0000342 OutputSections.push_back(Sec);
343 }
Rafael Espindola71675852015-09-22 00:16:19 +0000344 Sec->addSection(C);
Rafael Espindola19e38892015-09-16 15:54:15 +0000345 scanRelocs(*C);
346 }
347 }
348
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000349 Out<ELFT>::Dynamic->PreInitArraySec =
Rafael Espindola77572242015-10-02 19:37:55 +0000350 Map.lookup({".preinit_array", SHT_PREINIT_ARRAY, SHF_WRITE | SHF_ALLOC});
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000351 Out<ELFT>::Dynamic->InitArraySec =
Rafael Espindola77572242015-10-02 19:37:55 +0000352 Map.lookup({".init_array", SHT_INIT_ARRAY, SHF_WRITE | SHF_ALLOC});
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000353 Out<ELFT>::Dynamic->FiniArraySec =
Rafael Espindola77572242015-10-02 19:37:55 +0000354 Map.lookup({".fini_array", SHT_FINI_ARRAY, SHF_WRITE | SHF_ALLOC});
355
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000356 auto AddStartEnd = [&Symtab](StringRef Start, StringRef End,
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000357 OutputSection<ELFT> *OS) {
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000358 if (OS) {
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000359 Symtab.addSyntheticSym<ELFT>(Start, *OS, 0);
360 Symtab.addSyntheticSym<ELFT>(End, *OS, OS->getSize());
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000361 }
362 };
363
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000364 AddStartEnd("__preinit_array_start", "__preinit_array_end",
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000365 Out<ELFT>::Dynamic->PreInitArraySec);
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000366 AddStartEnd("__init_array_start", "__init_array_end",
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000367 Out<ELFT>::Dynamic->InitArraySec);
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000368 AddStartEnd("__fini_array_start", "__fini_array_end",
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000369 Out<ELFT>::Dynamic->FiniArraySec);
Rafael Espindola0e604f92015-09-25 18:56:53 +0000370
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000371 // FIXME: Try to avoid the extra walk over all global symbols.
372 std::vector<DefinedCommon<ELFT> *> CommonSymbols;
373 for (auto &P : Symtab.getSymbols()) {
374 StringRef Name = P.first;
375 SymbolBody *Body = P.second->Body;
Denis Protivensky22220d52015-10-05 09:43:57 +0000376 if (auto *U = dyn_cast<Undefined<ELFT>>(Body)) {
377 if (!U->isWeak() && !U->canKeepUndefined())
378 reportUndefined<ELFT>(Symtab, *Body);
379 }
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000380
381 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
382 CommonSymbols.push_back(C);
Rafael Espindola4f674ed2015-10-05 15:24:04 +0000383 if (!includeInSymtab<ELFT>(*Body))
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000384 continue;
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000385 Out<ELFT>::SymTab->addSymbol(Name);
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000386
387 if (needsDynamicSections() && includeInDynamicSymtab(*Body))
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000388 Out<ELFT>::HashTab->addSymbol(Body);
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000389 }
390
Rafael Espindolab56cb942015-09-01 00:16:38 +0000391 // Sort the common symbols by alignment as an heuristic to pack them better.
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000392 std::stable_sort(
393 CommonSymbols.begin(), CommonSymbols.end(),
394 [](const DefinedCommon<ELFT> *A, const DefinedCommon<ELFT> *B) {
395 return A->MaxAlignment > B->MaxAlignment;
396 });
397
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000398 uintX_t Off = Out<ELFT>::Bss->getSize();
Rafael Espindolab56cb942015-09-01 00:16:38 +0000399 for (DefinedCommon<ELFT> *C : CommonSymbols) {
Rafael Espindola05185742015-08-31 22:07:18 +0000400 const Elf_Sym &Sym = C->Sym;
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000401 uintX_t Align = C->MaxAlignment;
Rafael Espindola05185742015-08-31 22:07:18 +0000402 Off = RoundUpToAlignment(Off, Align);
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000403 C->OffsetInBSS = Off;
Rafael Espindola05185742015-08-31 22:07:18 +0000404 Off += Sym.st_size;
405 }
Rafael Espindolab56cb942015-09-01 00:16:38 +0000406
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000407 Out<ELFT>::Bss->setSize(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000408
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000409 OutputSections.push_back(Out<ELFT>::SymTab);
Rafael Espindolab01b5742015-09-08 18:08:57 +0000410
Rafael Espindola4340aad2015-09-11 22:42:45 +0000411 if (needsDynamicSections()) {
Rafael Espindola70107762015-09-11 18:49:42 +0000412 if (needsInterpSection())
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000413 OutputSections.push_back(Out<ELFT>::Interp);
414 OutputSections.push_back(Out<ELFT>::DynSymTab);
415 OutputSections.push_back(Out<ELFT>::HashTab);
416 OutputSections.push_back(Out<ELFT>::Dynamic);
417 OutputSections.push_back(Out<ELFT>::DynStrTab);
418 if (Out<ELFT>::RelaDyn->hasRelocs())
419 OutputSections.push_back(Out<ELFT>::RelaDyn);
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000420 }
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000421 if (!Out<ELFT>::Got->empty())
422 OutputSections.push_back(Out<ELFT>::Got);
423 if (!Out<ELFT>::Plt->empty())
424 OutputSections.push_back(Out<ELFT>::Plt);
Rafael Espindola740fafe2015-09-08 19:43:27 +0000425
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000426 std::stable_sort(
427 OutputSections.begin(), OutputSections.end(),
428 [](OutputSectionBase<ELFT::Is64Bits> *A,
429 OutputSectionBase<ELFT::Is64Bits> *B) {
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000430 uintX_t AFlags = A->getFlags();
431 uintX_t BFlags = B->getFlags();
432
433 // Allocatable sections go first to reduce the total PT_LOAD size and
434 // so debug info doesn't change addresses in actual code.
435 bool AIsAlloc = AFlags & SHF_ALLOC;
436 bool BIsAlloc = BFlags & SHF_ALLOC;
437 if (AIsAlloc != BIsAlloc)
438 return AIsAlloc;
439
440 // We don't have any special requirements for the relative order of
441 // two non allocatable sections.
442 if (!AIsAlloc)
443 return false;
444
445 // We want the read only sections first so that they go in the PT_LOAD
446 // covering the program headers at the start of the file.
447 bool AIsWritable = AFlags & SHF_WRITE;
448 bool BIsWritable = BFlags & SHF_WRITE;
449 if (AIsWritable != BIsWritable)
450 return BIsWritable;
451
452 // For a corresponding reason, put non exec sections first (the program
453 // header PT_LOAD is not executable).
454 bool AIsExec = AFlags & SHF_EXECINSTR;
455 bool BIsExec = BFlags & SHF_EXECINSTR;
456 if (AIsExec != BIsExec)
457 return BIsExec;
458
459 // If we got here we know that both A and B and in the same PT_LOAD.
460 // The last requirement we have is to put nobits section last. The
461 // reason is that the only thing the dynamic linker will see about
462 // them is a p_memsz that is larger than p_filesz. Seeing that it
463 // zeros the end of the PT_LOAD, so that has to correspond to the
464 // nobits sections.
465 return A->getType() != SHT_NOBITS && B->getType() == SHT_NOBITS;
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000466 });
467
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000468 // Always put StrTabSec last so that no section names are added to it after
469 // it's finalized.
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000470 OutputSections.push_back(Out<ELFT>::StrTab);
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000471
Rafael Espindolab01b5742015-09-08 18:08:57 +0000472 for (unsigned I = 0, N = OutputSections.size(); I < N; ++I)
473 OutputSections[I]->setSectionIndex(I + 1);
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000474
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000475 // Fill the DynStrTab early.
476 Out<ELFT>::Dynamic->finalize();
Rafael Espindolaabad6182015-08-13 15:23:46 +0000477}
478
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000479template <class ELFT>
Rui Ueyama04dae552015-10-02 21:23:17 +0000480static bool needsPHDR(OutputSectionBase<ELFT::Is64Bits> *Sec) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000481 return Sec->getFlags() & SHF_ALLOC;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000482}
483
Michael J. Spencer84487f12015-07-24 21:03:07 +0000484// Visits all sections to assign incremental, non-overlapping RVAs and
485// file offsets.
486template <class ELFT> void Writer<ELFT>::assignAddresses() {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000487 assert(!OutputSections.empty() && "No output sections to layout!");
Rafael Espindola4340aad2015-09-11 22:42:45 +0000488 uintX_t VA = getVAStart();
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000489 uintX_t FileOff = 0;
Rafael Espindola60252d82015-09-09 22:53:55 +0000490
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000491 FileOff += sizeof(Elf_Ehdr);
492 VA += sizeof(Elf_Ehdr);
Rafael Espindolaabad6182015-08-13 15:23:46 +0000493
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000494 // Reserve space for PHDRs.
495 ProgramHeaderOff = FileOff;
496 FileOff = RoundUpToAlignment(FileOff, PageSize);
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000497 VA = RoundUpToAlignment(VA, PageSize);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000498
Rafael Espindola70107762015-09-11 18:49:42 +0000499 if (needsInterpSection())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000500 PHDRs.push_back(&InterpPHDR);
Rafael Espindola70107762015-09-11 18:49:42 +0000501
Michael J. Spencer2f008242015-09-17 19:58:07 +0000502 // Create a PHDR for the file header.
503 PHDRs.push_back(&FileHeaderPHDR);
504 FileHeaderPHDR.Header.p_vaddr = getVAStart();
505 FileHeaderPHDR.Header.p_paddr = getVAStart();
506 FileHeaderPHDR.Header.p_align = PageSize;
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000507
Rafael Espindolaebd21082015-08-13 22:14:37 +0000508 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000509 Out<ELFT>::StrTab->add(Sec->getName());
Rafael Espindolaebd21082015-08-13 22:14:37 +0000510 Sec->finalize();
511
Michael J. Spencer2f008242015-09-17 19:58:07 +0000512 if (Sec->getSize()) {
Rui Ueyama04dae552015-10-02 21:23:17 +0000513 uintX_t Flags = toPHDRFlags(Sec->getFlags());
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000514 ProgramHeader<ELFT> *Last = PHDRs.back();
Rui Ueyama04dae552015-10-02 21:23:17 +0000515 if (Last->Header.p_flags != Flags || !needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000516 // Flags changed. End current PHDR and potentially create a new one.
Rui Ueyama04dae552015-10-02 21:23:17 +0000517 if (!Last->Closed) {
518 Last->Header.p_filesz = FileOff - Last->Header.p_offset;
519 Last->Header.p_memsz = VA - Last->Header.p_vaddr;
520 Last->Closed = true;
Michael J. Spencer2f008242015-09-17 19:58:07 +0000521 }
522
Rui Ueyama04dae552015-10-02 21:23:17 +0000523 if (needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000524 VA = RoundUpToAlignment(VA, PageSize);
525 FileOff = RoundUpToAlignment(FileOff, PageSize);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000526 PHDRs.push_back(new (PAlloc)
527 ProgramHeader<ELFT>(PT_LOAD, Flags, FileOff, VA));
Michael J. Spencer2f008242015-09-17 19:58:07 +0000528 }
529 }
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000530 }
531
Rafael Espindola2db634d2015-08-13 20:24:18 +0000532 uintX_t Align = Sec->getAlign();
533 uintX_t Size = Sec->getSize();
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000534 if (Sec->getFlags() & SHF_ALLOC) {
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000535 VA = RoundUpToAlignment(VA, Align);
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000536 Sec->setVA(VA);
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000537 VA += Size;
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000538 }
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000539 FileOff = RoundUpToAlignment(FileOff, Align);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000540 Sec->setFileOffset(FileOff);
Rafael Espindola058f3432015-08-31 20:23:57 +0000541 if (Sec->getType() != SHT_NOBITS)
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000542 FileOff += Size;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000543 }
Rafael Espindola6b83b902015-08-12 00:00:24 +0000544
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000545 // Add a PHDR for the dynamic table.
Rafael Espindola4340aad2015-09-11 22:42:45 +0000546 if (needsDynamicSections())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000547 PHDRs.push_back(&DynamicPHDR);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000548
Rafael Espindola91009b32015-08-12 01:45:28 +0000549 FileOff += OffsetToAlignment(FileOff, ELFT::Is64Bits ? 8 : 4);
550
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000551 // Add space for section headers.
552 SectionHeaderOff = FileOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000553 FileOff += getNumSections() * sizeof(Elf_Shdr);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000554 FileSize = FileOff;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000555}
556
557template <class ELFT> void Writer<ELFT>::writeHeader() {
558 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindola18608a02015-09-08 21:57:31 +0000559 auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000560 EHdr->e_ident[EI_MAG0] = 0x7F;
561 EHdr->e_ident[EI_MAG1] = 0x45;
562 EHdr->e_ident[EI_MAG2] = 0x4C;
563 EHdr->e_ident[EI_MAG3] = 0x46;
Rafael Espindola4b7c2fc2015-08-05 15:08:40 +0000564 EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
565 EHdr->e_ident[EI_DATA] = ELFT::TargetEndianness == llvm::support::little
566 ? ELFDATA2LSB
567 : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000568 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Davide Italianoaa7c5332015-09-25 01:59:13 +0000569
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000570 const SymbolTable &Symtab = Out<ELFT>::SymTab->getSymTable();
Davide Italianoaa7c5332015-09-25 01:59:13 +0000571 auto &FirstObj = cast<ObjectFile<ELFT>>(*Symtab.getFirstELF());
572 EHdr->e_ident[EI_OSABI] = FirstObj.getOSABI();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000573
Rafael Espindolae438e072015-09-08 22:55:28 +0000574 // FIXME: Generalize the segment construction similar to how we create
575 // output sections.
Rafael Espindolae438e072015-09-08 22:55:28 +0000576
Rafael Espindola4340aad2015-09-11 22:42:45 +0000577 EHdr->e_type = Config->Shared ? ET_DYN : ET_EXEC;
Rafael Espindolaf98d6d82015-09-03 20:03:54 +0000578 EHdr->e_machine = FirstObj.getEMachine();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000579 EHdr->e_version = EV_CURRENT;
Rafael Espindola4340aad2015-09-11 22:42:45 +0000580 SymbolBody *Entry = Symtab.getEntrySym();
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000581 EHdr->e_entry = Entry ? getSymVA<ELFT>(cast<ELFSymbolBody<ELFT>>(*Entry)) : 0;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000582 EHdr->e_phoff = ProgramHeaderOff;
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000583 EHdr->e_shoff = SectionHeaderOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000584 EHdr->e_ehsize = sizeof(Elf_Ehdr);
585 EHdr->e_phentsize = sizeof(Elf_Phdr);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000586 EHdr->e_phnum = PHDRs.size();
Rafael Espindola18608a02015-09-08 21:57:31 +0000587 EHdr->e_shentsize = sizeof(Elf_Shdr);
Rafael Espindola5f553872015-09-08 17:39:39 +0000588 EHdr->e_shnum = getNumSections();
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000589 EHdr->e_shstrndx = Out<ELFT>::StrTab->getSectionIndex();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000590
Michael J. Spencer2f008242015-09-17 19:58:07 +0000591 // If nothing was merged into the file header PT_LOAD, set the size correctly.
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000592 if (FileHeaderPHDR.Header.p_filesz == PageSize) {
593 uint64_t Size = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * PHDRs.size();
594 FileHeaderPHDR.Header.p_filesz = Size;
595 FileHeaderPHDR.Header.p_memsz = Size;
596 }
Michael J. Spencer2f008242015-09-17 19:58:07 +0000597
598 if (needsInterpSection())
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000599 InterpPHDR.setValuesFromSection(Out<ELFT>::Interp);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000600 if (needsDynamicSections())
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000601 DynamicPHDR.setValuesFromSection(Out<ELFT>::Dynamic);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000602
Rafael Espindola18608a02015-09-08 21:57:31 +0000603 auto PHdrs = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000604 for (ProgramHeader<ELFT> *PHDR : PHDRs)
605 *PHdrs++ = PHDR->Header;
Rafael Espindolae438e072015-09-08 22:55:28 +0000606
Rafael Espindola18608a02015-09-08 21:57:31 +0000607 auto SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000608 // First entry is null.
609 ++SHdrs;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000610 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rui Ueyama15ef5e12015-10-07 19:18:16 +0000611 Sec->setNameOffset(Out<ELFT>::StrTab->getFileOff(Sec->getName()));
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000612 Sec->template writeHeaderTo<ELFT::TargetEndianness>(SHdrs++);
Rafael Espindola6b83b902015-08-12 00:00:24 +0000613 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000614}
615
616template <class ELFT> void Writer<ELFT>::openFile(StringRef Path) {
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +0000617 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
618 FileOutputBuffer::create(Path, FileSize, FileOutputBuffer::F_executable);
619 error(BufferOrErr, Twine("failed to open ") + Path);
620 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000621}
622
623// Write section contents to a mmap'ed file.
624template <class ELFT> void Writer<ELFT>::writeSections() {
625 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000626 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections)
Rui Ueyama8050d322015-08-14 05:17:30 +0000627 Sec->writeTo(Buf + Sec->getFileOff());
Michael J. Spencer84487f12015-07-24 21:03:07 +0000628}