blob: 404bf257d2812ac02ae783dab2f6caaa1d61f769 [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 Ueyama5713b8d2015-10-02 22:17:07 +000061 void setValuesFromSection(OutputSectionBase<ELFT::Is64Bits> &Sec) {
Rui Ueyama04dae552015-10-02 21:23:17 +000062 Header.p_flags = toPHDRFlags(Sec.getFlags());
Michael J. Spencer2f008242015-09-17 19:58:07 +000063 Header.p_offset = Sec.getFileOff();
64 Header.p_vaddr = Sec.getVA();
65 Header.p_paddr = Header.p_vaddr;
66 Header.p_filesz = Sec.getSize();
67 Header.p_memsz = Header.p_filesz;
68 Header.p_align = Sec.getAlign();
69 }
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;
Rafael Espindola3f4228f2015-09-09 15:33:08 +000085 Writer(SymbolTable *T)
Rafael Espindolac2d21192015-09-23 18:25:05 +000086 : SymTabSec(*T, StrTabSec, BssSec), DynSymSec(*T, DynStrSec, BssSec),
Rafael Espindola9c3e4d22015-10-05 21:23:08 +000087 RelaDynSec(DynSymSec, GotSec, BssSec, T->shouldUseRela()),
Rafael Espindolaa6627382015-10-06 23:56:53 +000088 GotSec(BssSec), PltSec(GotSec), HashSec(DynSymSec),
Rafael Espindola9c3e4d22015-10-05 21:23:08 +000089 DynamicSec(*T, HashSec, RelaDynSec, BssSec),
Rafael Espindolac2d21192015-09-23 18:25:05 +000090 BssSec(PltSec, GotSec, BssSec, ".bss", SHT_NOBITS,
91 SHF_ALLOC | SHF_WRITE) {}
Rui Ueyamaafff74e22015-08-05 23:24:46 +000092 void run();
93
94private:
95 void createSections();
Rafael Espindola67a5da62015-09-17 14:02:10 +000096 template <bool isRela>
Rafael Espindola53d5cea2015-09-21 17:47:00 +000097 void scanRelocs(const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +000098 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels);
Rafael Espindola53d5cea2015-09-21 17:47:00 +000099 void scanRelocs(const InputSection<ELFT> &C);
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000100 void assignAddresses();
101 void openFile(StringRef OutputPath);
102 void writeHeader();
103 void writeSections();
Rafael Espindola70107762015-09-11 18:49:42 +0000104 bool needsInterpSection() const {
105 return !SymTabSec.getSymTable().getSharedFiles().empty() &&
106 !Config->DynamicLinker.empty();
107 }
Michael J. Spencerf32446f2015-10-06 20:39:09 +0000108 bool isOutputDynamic() const {
Rafael Espindola4340aad2015-09-11 22:42:45 +0000109 return !SymTabSec.getSymTable().getSharedFiles().empty() || Config->Shared;
110 }
Michael J. Spencerf32446f2015-10-06 20:39:09 +0000111 bool needsDynamicSections() const { return isOutputDynamic(); }
Rafael Espindola4340aad2015-09-11 22:42:45 +0000112 unsigned getVAStart() const { return Config->Shared ? 0 : VAStart; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000113
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000114 std::unique_ptr<llvm::FileOutputBuffer> Buffer;
Michael J. Spencer2f008242015-09-17 19:58:07 +0000115
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000116 llvm::SpecificBumpPtrAllocator<OutputSection<ELFT>> CAlloc;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000117 std::vector<OutputSectionBase<ELFT::Is64Bits> *> OutputSections;
Rafael Espindola5f553872015-09-08 17:39:39 +0000118 unsigned getNumSections() const { return OutputSections.size() + 1; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000119
Michael J. Spencer2f008242015-09-17 19:58:07 +0000120 llvm::BumpPtrAllocator PAlloc;
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000121 std::vector<ProgramHeader<ELFT> *> PHDRs;
122 ProgramHeader<ELFT> FileHeaderPHDR{PT_LOAD, PF_R, 0, 0};
123 ProgramHeader<ELFT> InterpPHDR{PT_INTERP, 0, 0, 0};
124 ProgramHeader<ELFT> DynamicPHDR{PT_DYNAMIC, 0, 0, 0};
Michael J. Spencer2f008242015-09-17 19:58:07 +0000125
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000126 uintX_t FileSize;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000127 uintX_t ProgramHeaderOff;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000128 uintX_t SectionHeaderOff;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000129
Rui Ueyama9078f732015-09-14 20:32:41 +0000130 StringTableSection<ELFT::Is64Bits> StrTabSec = { /*dynamic=*/false };
131 StringTableSection<ELFT::Is64Bits> DynStrSec = { /*dynamic=*/true };
Rafael Espindolaebd21082015-08-13 22:14:37 +0000132
Rafael Espindola5805c4f2015-09-21 21:38:08 +0000133 lld::elf2::SymbolTableSection<ELFT> SymTabSec;
134 lld::elf2::SymbolTableSection<ELFT> DynSymSec;
Rafael Espindola740fafe2015-09-08 19:43:27 +0000135
Rafael Espindola19e38892015-09-16 15:54:15 +0000136 RelocationSection<ELFT> RelaDynSec;
137
Rafael Espindola5c2310c2015-09-18 14:40:19 +0000138 GotSection<ELFT> GotSec;
Rafael Espindolaeb792732015-09-21 15:11:29 +0000139 PltSection<ELFT> PltSec;
Rafael Espindola5c2310c2015-09-18 14:40:19 +0000140
Rafael Espindola601771e2015-09-14 20:20:34 +0000141 HashTableSection<ELFT> HashSec;
142
Rafael Espindola80faee82015-09-14 22:08:55 +0000143 DynamicSection<ELFT> DynamicSec;
144
Rafael Espindola70107762015-09-11 18:49:42 +0000145 InterpSection<ELFT::Is64Bits> InterpSec;
146
Rafael Espindolac2d21192015-09-23 18:25:05 +0000147 OutputSection<ELFT> BssSec;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000148};
149} // anonymous namespace
150
Rui Ueyama75230392015-10-07 18:29:51 +0000151void lld::elf2::writeResult(SymbolTable *Symtab) {
152 switch (Symtab->getFirstELF()->getELFKind()) {
153 case ELF32LEKind:
154 Writer<object::ELF32LE>(Symtab).run();
155 return;
156 case ELF32BEKind:
157 Writer<object::ELF32BE>(Symtab).run();
158 return;
159 case ELF64LEKind:
160 Writer<object::ELF64LE>(Symtab).run();
161 return;
162 case ELF64BEKind:
163 Writer<object::ELF64BE>(Symtab).run();
164 return;
165 default:
166 llvm_unreachable("Invalid kind");
167 }
168}
Michael J. Spencer84487f12015-07-24 21:03:07 +0000169
170// The main function of the writer.
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000171template <class ELFT> void Writer<ELFT>::run() {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000172 createSections();
173 assignAddresses();
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000174 openFile(Config->OutputFile);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000175 writeHeader();
176 writeSections();
177 error(Buffer->commit());
178}
179
Rafael Espindolaa7471792015-08-13 17:04:50 +0000180namespace {
181template <bool Is64Bits> struct SectionKey {
182 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
183 StringRef Name;
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000184 uint32_t Type;
185 uintX_t Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000186};
187}
188namespace llvm {
189template <bool Is64Bits> struct DenseMapInfo<SectionKey<Is64Bits>> {
190 static SectionKey<Is64Bits> getEmptyKey() {
191 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getEmptyKey(), 0, 0};
192 }
193 static SectionKey<Is64Bits> getTombstoneKey() {
194 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getTombstoneKey(), 0,
195 0};
196 }
197 static unsigned getHashValue(const SectionKey<Is64Bits> &Val) {
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000198 return hash_combine(Val.Name, Val.Type, Val.Flags);
Rafael Espindolaa7471792015-08-13 17:04:50 +0000199 }
200 static bool isEqual(const SectionKey<Is64Bits> &LHS,
201 const SectionKey<Is64Bits> &RHS) {
202 return DenseMapInfo<StringRef>::isEqual(LHS.Name, RHS.Name) &&
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000203 LHS.Type == RHS.Type && LHS.Flags == RHS.Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000204 }
205};
206}
207
Rafael Espindola19e38892015-09-16 15:54:15 +0000208// The reason we have to do this early scan is as follows
209// * To mmap the output file, we need to know the size
210// * For that, we need to know how many dynamic relocs we will have.
211// It might be possible to avoid this by outputting the file with write:
212// * Write the allocated output sections, computing addresses.
213// * Apply relocations, recording which ones require a dynamic reloc.
214// * Write the dynamic relocations.
215// * Write the rest of the file.
216template <class ELFT>
Rafael Espindola67a5da62015-09-17 14:02:10 +0000217template <bool isRela>
218void Writer<ELFT>::scanRelocs(
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000219 const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +0000220 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels) {
221 typedef Elf_Rel_Impl<ELFT, isRela> RelType;
222 const ObjectFile<ELFT> &File = *C.getFile();
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000223 bool IsMips64EL = File.getObj().isMips64EL();
Rafael Espindola67a5da62015-09-17 14:02:10 +0000224 for (const RelType &RI : Rels) {
225 uint32_t SymIndex = RI.getSymbol(IsMips64EL);
Rafael Espindola5c2310c2015-09-18 14:40:19 +0000226 SymbolBody *Body = File.getSymbolBody(SymIndex);
Rafael Espindolaeb792732015-09-21 15:11:29 +0000227 uint32_t Type = RI.getType(IsMips64EL);
Rafael Espindolaae244002015-10-05 19:30:12 +0000228 if (Body) {
229 if (Target->relocNeedsPlt(Type, *Body)) {
230 if (Body->isInPlt())
231 continue;
232 PltSec.addEntry(Body);
233 }
234 if (Target->relocNeedsGot(Type, *Body)) {
235 if (Body->isInGot())
236 continue;
237 GotSec.addEntry(Body);
Rafael Espindolaae244002015-10-05 19:30:12 +0000238 }
Rafael Espindolaeb792732015-09-21 15:11:29 +0000239 }
Rafael Espindolaa6627382015-10-06 23:56:53 +0000240 if (canBePreempted(Body)) {
241 Body->setUsedInDynamicReloc();
Rafael Espindolaae244002015-10-05 19:30:12 +0000242 RelaDynSec.addReloc({C, RI});
Rafael Espindolaa6627382015-10-06 23:56:53 +0000243 } else if (Config->Shared && !Target->isRelRelative(Type)) {
244 RelaDynSec.addReloc({C, RI});
245 }
Rafael Espindola67a5da62015-09-17 14:02:10 +0000246 }
247}
248
249template <class ELFT>
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000250void Writer<ELFT>::scanRelocs(const InputSection<ELFT> &C) {
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000251 ObjectFile<ELFT> *File = C.getFile();
252 ELFFile<ELFT> &EObj = File->getObj();
Rafael Espindola19e38892015-09-16 15:54:15 +0000253
254 if (!(C.getSectionHdr()->sh_flags & SHF_ALLOC))
255 return;
256
257 for (const Elf_Shdr *RelSec : C.RelocSections) {
Rafael Espindola67a5da62015-09-17 14:02:10 +0000258 if (RelSec->sh_type == SHT_RELA)
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000259 scanRelocs(C, EObj.relas(RelSec));
Rafael Espindola67a5da62015-09-17 14:02:10 +0000260 else
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000261 scanRelocs(C, EObj.rels(RelSec));
Rafael Espindola19e38892015-09-16 15:54:15 +0000262 }
263}
264
Rafael Espindola6173f842015-09-23 14:37:01 +0000265template <class ELFT>
Rui Ueyama44f5d912015-10-01 14:46:54 +0000266static void reportUndefined(const SymbolTable &S, const SymbolBody &Sym) {
Rafael Espindola6173f842015-09-23 14:37:01 +0000267 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
268 typedef typename ELFFile<ELFT>::Elf_Sym_Range Elf_Sym_Range;
269
George Rimar57e40de2015-10-01 20:14:45 +0000270 if (Config->Shared && !Config->NoUndefined)
George Rimaree058282015-10-01 17:24:24 +0000271 return;
272
Rafael Espindola6173f842015-09-23 14:37:01 +0000273 const Elf_Sym &SymE = cast<ELFSymbolBody<ELFT>>(Sym).Sym;
274 ELFFileBase *SymFile = nullptr;
275
276 for (const std::unique_ptr<ObjectFileBase> &F : S.getObjectFiles()) {
277 const auto &File = cast<ObjectFile<ELFT>>(*F);
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000278 Elf_Sym_Range Syms = File.getObj().symbols(File.getSymbolTable());
Rafael Espindola6173f842015-09-23 14:37:01 +0000279 if (&SymE > Syms.begin() && &SymE < Syms.end())
280 SymFile = F.get();
281 }
Rafael Espindola551dfd82015-09-25 19:24:57 +0000282
283 std::string Message = "undefined symbol: " + Sym.getName().str();
Rafael Espindola6173f842015-09-23 14:37:01 +0000284 if (SymFile)
Rafael Espindola551dfd82015-09-25 19:24:57 +0000285 Message += " in " + SymFile->getName().str();
286 if (Config->NoInhibitExec)
287 warning(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000288 else
Rafael Espindola551dfd82015-09-25 19:24:57 +0000289 error(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000290}
291
Michael J. Spencer84487f12015-07-24 21:03:07 +0000292// Create output section objects and add them to OutputSections.
293template <class ELFT> void Writer<ELFT>::createSections() {
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000294 SmallDenseMap<SectionKey<ELFT::Is64Bits>, OutputSection<ELFT> *> Map;
Rafael Espindolac2d21192015-09-23 18:25:05 +0000295
296 OutputSections.push_back(&BssSec);
297 Map[{BssSec.getName(), BssSec.getType(), BssSec.getFlags()}] = &BssSec;
298
Rafael Espindola0e604f92015-09-25 18:56:53 +0000299 SymbolTable &Symtab = SymTabSec.getSymTable();
Rafael Espindolac05ad3d2015-10-07 02:51:44 +0000300
301 // Declare linker generated symbols.
302 // This must be done before the relocation scan to make sure we can correctly
303 // decide if a dynamic relocation is needed or not.
304 // FIXME: Make this more declarative.
305 for (StringRef Name :
306 {"__preinit_array_start", "__preinit_array_end", "__init_array_start",
307 "__init_array_end", "__fini_array_start", "__fini_array_end"})
308 Symtab.addIgnoredSym<ELFT>(Name);
309
310 // __tls_get_addr is defined by the dynamic linker for dynamic ELFs. For
311 // static linking the linker is required to optimize away any references to
312 // __tls_get_addr, so it's not defined anywhere. Create a hidden definition
313 // to avoid the undefined symbol error.
314 if (!isOutputDynamic())
315 Symtab.addIgnoredSym<ELFT>("__tls_get_addr");
316
Rafael Espindola19e38892015-09-16 15:54:15 +0000317 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
318 auto &File = cast<ObjectFile<ELFT>>(*FileB);
Davide Italiano6d328d32015-09-16 20:45:57 +0000319 if (!Config->DiscardAll) {
320 Elf_Sym_Range Syms = File.getLocalSymbols();
321 for (const Elf_Sym &Sym : Syms) {
322 ErrorOr<StringRef> SymName = Sym.getName(File.getStringTable());
Rafael Espindolad1cf4212015-10-05 16:25:43 +0000323 if (SymName && shouldKeepInSymtab<ELFT>(*SymName, Sym))
Davide Italiano6d328d32015-09-16 20:45:57 +0000324 SymTabSec.addSymbol(*SymName, true);
325 }
326 }
Rafael Espindola71675852015-09-22 00:16:19 +0000327 for (InputSection<ELFT> *C : File.getSections()) {
Rafael Espindola19e38892015-09-16 15:54:15 +0000328 if (!C)
329 continue;
330 const Elf_Shdr *H = C->getSectionHdr();
Rafael Espindolad13d9602015-09-25 15:08:44 +0000331 SectionKey<ELFT::Is64Bits> Key{C->getSectionName(), H->sh_type,
332 H->sh_flags};
333 OutputSection<ELFT> *&Sec = Map[Key];
334 if (!Sec) {
335 Sec = new (CAlloc.Allocate()) OutputSection<ELFT>(
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000336 PltSec, GotSec, BssSec, Key.Name, Key.Type, Key.Flags);
Rafael Espindolad13d9602015-09-25 15:08:44 +0000337 OutputSections.push_back(Sec);
338 }
Rafael Espindola71675852015-09-22 00:16:19 +0000339 Sec->addSection(C);
Rafael Espindola19e38892015-09-16 15:54:15 +0000340 scanRelocs(*C);
341 }
342 }
343
Rafael Espindola77572242015-10-02 19:37:55 +0000344 DynamicSec.PreInitArraySec =
345 Map.lookup({".preinit_array", SHT_PREINIT_ARRAY, SHF_WRITE | SHF_ALLOC});
346 DynamicSec.InitArraySec =
347 Map.lookup({".init_array", SHT_INIT_ARRAY, SHF_WRITE | SHF_ALLOC});
348 DynamicSec.FiniArraySec =
349 Map.lookup({".fini_array", SHT_FINI_ARRAY, SHF_WRITE | SHF_ALLOC});
350
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000351 auto AddStartEnd = [&Symtab](StringRef Start, StringRef End,
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000352 OutputSection<ELFT> *OS) {
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000353 if (OS) {
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000354 Symtab.addSyntheticSym<ELFT>(Start, *OS, 0);
355 Symtab.addSyntheticSym<ELFT>(End, *OS, OS->getSize());
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000356 }
357 };
358
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000359 AddStartEnd("__preinit_array_start", "__preinit_array_end",
360 DynamicSec.PreInitArraySec);
361 AddStartEnd("__init_array_start", "__init_array_end",
362 DynamicSec.InitArraySec);
363 AddStartEnd("__fini_array_start", "__fini_array_end",
364 DynamicSec.FiniArraySec);
Rafael Espindola0e604f92015-09-25 18:56:53 +0000365
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000366 // FIXME: Try to avoid the extra walk over all global symbols.
367 std::vector<DefinedCommon<ELFT> *> CommonSymbols;
368 for (auto &P : Symtab.getSymbols()) {
369 StringRef Name = P.first;
370 SymbolBody *Body = P.second->Body;
Denis Protivensky22220d52015-10-05 09:43:57 +0000371 if (auto *U = dyn_cast<Undefined<ELFT>>(Body)) {
372 if (!U->isWeak() && !U->canKeepUndefined())
373 reportUndefined<ELFT>(Symtab, *Body);
374 }
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000375
376 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
377 CommonSymbols.push_back(C);
Rafael Espindola4f674ed2015-10-05 15:24:04 +0000378 if (!includeInSymtab<ELFT>(*Body))
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000379 continue;
380 SymTabSec.addSymbol(Name);
381
382 if (needsDynamicSections() && includeInDynamicSymtab(*Body))
383 HashSec.addSymbol(Body);
384 }
385
Rafael Espindolab56cb942015-09-01 00:16:38 +0000386 // Sort the common symbols by alignment as an heuristic to pack them better.
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000387 std::stable_sort(
388 CommonSymbols.begin(), CommonSymbols.end(),
389 [](const DefinedCommon<ELFT> *A, const DefinedCommon<ELFT> *B) {
390 return A->MaxAlignment > B->MaxAlignment;
391 });
392
Rafael Espindolac2d21192015-09-23 18:25:05 +0000393 uintX_t Off = BssSec.getSize();
Rafael Espindolab56cb942015-09-01 00:16:38 +0000394 for (DefinedCommon<ELFT> *C : CommonSymbols) {
Rafael Espindola05185742015-08-31 22:07:18 +0000395 const Elf_Sym &Sym = C->Sym;
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000396 uintX_t Align = C->MaxAlignment;
Rafael Espindola05185742015-08-31 22:07:18 +0000397 Off = RoundUpToAlignment(Off, Align);
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000398 C->OffsetInBSS = Off;
Rafael Espindola05185742015-08-31 22:07:18 +0000399 Off += Sym.st_size;
400 }
Rafael Espindolab56cb942015-09-01 00:16:38 +0000401
Rafael Espindolac2d21192015-09-23 18:25:05 +0000402 BssSec.setSize(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000403
Rafael Espindolafb815282015-09-11 00:30:13 +0000404 OutputSections.push_back(&SymTabSec);
Rafael Espindolab01b5742015-09-08 18:08:57 +0000405
Rafael Espindola4340aad2015-09-11 22:42:45 +0000406 if (needsDynamicSections()) {
Rafael Espindola70107762015-09-11 18:49:42 +0000407 if (needsInterpSection())
408 OutputSections.push_back(&InterpSec);
Rafael Espindolafb815282015-09-11 00:30:13 +0000409 OutputSections.push_back(&DynSymSec);
Rafael Espindola601771e2015-09-14 20:20:34 +0000410 OutputSections.push_back(&HashSec);
Rafael Espindola740fafe2015-09-08 19:43:27 +0000411 OutputSections.push_back(&DynamicSec);
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000412 OutputSections.push_back(&DynStrSec);
Denis Protivensky18add762015-09-17 09:54:29 +0000413 if (RelaDynSec.hasRelocs())
Rafael Espindola19e38892015-09-16 15:54:15 +0000414 OutputSections.push_back(&RelaDynSec);
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000415 }
Rafael Espindolacdfecff2015-09-23 20:08:25 +0000416 if (!GotSec.empty())
417 OutputSections.push_back(&GotSec);
418 if (!PltSec.empty())
419 OutputSections.push_back(&PltSec);
Rafael Espindola740fafe2015-09-08 19:43:27 +0000420
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000421 std::stable_sort(
422 OutputSections.begin(), OutputSections.end(),
423 [](OutputSectionBase<ELFT::Is64Bits> *A,
424 OutputSectionBase<ELFT::Is64Bits> *B) {
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000425 uintX_t AFlags = A->getFlags();
426 uintX_t BFlags = B->getFlags();
427
428 // Allocatable sections go first to reduce the total PT_LOAD size and
429 // so debug info doesn't change addresses in actual code.
430 bool AIsAlloc = AFlags & SHF_ALLOC;
431 bool BIsAlloc = BFlags & SHF_ALLOC;
432 if (AIsAlloc != BIsAlloc)
433 return AIsAlloc;
434
435 // We don't have any special requirements for the relative order of
436 // two non allocatable sections.
437 if (!AIsAlloc)
438 return false;
439
440 // We want the read only sections first so that they go in the PT_LOAD
441 // covering the program headers at the start of the file.
442 bool AIsWritable = AFlags & SHF_WRITE;
443 bool BIsWritable = BFlags & SHF_WRITE;
444 if (AIsWritable != BIsWritable)
445 return BIsWritable;
446
447 // For a corresponding reason, put non exec sections first (the program
448 // header PT_LOAD is not executable).
449 bool AIsExec = AFlags & SHF_EXECINSTR;
450 bool BIsExec = BFlags & SHF_EXECINSTR;
451 if (AIsExec != BIsExec)
452 return BIsExec;
453
454 // If we got here we know that both A and B and in the same PT_LOAD.
455 // The last requirement we have is to put nobits section last. The
456 // reason is that the only thing the dynamic linker will see about
457 // them is a p_memsz that is larger than p_filesz. Seeing that it
458 // zeros the end of the PT_LOAD, so that has to correspond to the
459 // nobits sections.
460 return A->getType() != SHT_NOBITS && B->getType() == SHT_NOBITS;
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000461 });
462
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000463 // Always put StrTabSec last so that no section names are added to it after
464 // it's finalized.
465 OutputSections.push_back(&StrTabSec);
466
Rafael Espindolab01b5742015-09-08 18:08:57 +0000467 for (unsigned I = 0, N = OutputSections.size(); I < N; ++I)
468 OutputSections[I]->setSectionIndex(I + 1);
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000469
470 // Fill the DynStrSec early.
471 DynamicSec.finalize();
Rafael Espindolaabad6182015-08-13 15:23:46 +0000472}
473
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000474template <class ELFT>
Rui Ueyama04dae552015-10-02 21:23:17 +0000475static bool needsPHDR(OutputSectionBase<ELFT::Is64Bits> *Sec) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000476 return Sec->getFlags() & SHF_ALLOC;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000477}
478
Michael J. Spencer84487f12015-07-24 21:03:07 +0000479// Visits all sections to assign incremental, non-overlapping RVAs and
480// file offsets.
481template <class ELFT> void Writer<ELFT>::assignAddresses() {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000482 assert(!OutputSections.empty() && "No output sections to layout!");
Rafael Espindola4340aad2015-09-11 22:42:45 +0000483 uintX_t VA = getVAStart();
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000484 uintX_t FileOff = 0;
Rafael Espindola60252d82015-09-09 22:53:55 +0000485
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000486 FileOff += sizeof(Elf_Ehdr);
487 VA += sizeof(Elf_Ehdr);
Rafael Espindolaabad6182015-08-13 15:23:46 +0000488
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000489 // Reserve space for PHDRs.
490 ProgramHeaderOff = FileOff;
491 FileOff = RoundUpToAlignment(FileOff, PageSize);
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000492 VA = RoundUpToAlignment(VA, PageSize);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000493
Rafael Espindola70107762015-09-11 18:49:42 +0000494 if (needsInterpSection())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000495 PHDRs.push_back(&InterpPHDR);
Rafael Espindola70107762015-09-11 18:49:42 +0000496
Michael J. Spencer2f008242015-09-17 19:58:07 +0000497 // Create a PHDR for the file header.
498 PHDRs.push_back(&FileHeaderPHDR);
499 FileHeaderPHDR.Header.p_vaddr = getVAStart();
500 FileHeaderPHDR.Header.p_paddr = getVAStart();
501 FileHeaderPHDR.Header.p_align = PageSize;
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000502
Rafael Espindolaebd21082015-08-13 22:14:37 +0000503 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000504 StrTabSec.add(Sec->getName());
Rafael Espindolaebd21082015-08-13 22:14:37 +0000505 Sec->finalize();
506
Michael J. Spencer2f008242015-09-17 19:58:07 +0000507 if (Sec->getSize()) {
Rui Ueyama04dae552015-10-02 21:23:17 +0000508 uintX_t Flags = toPHDRFlags(Sec->getFlags());
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000509 ProgramHeader<ELFT> *Last = PHDRs.back();
Rui Ueyama04dae552015-10-02 21:23:17 +0000510 if (Last->Header.p_flags != Flags || !needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000511 // Flags changed. End current PHDR and potentially create a new one.
Rui Ueyama04dae552015-10-02 21:23:17 +0000512 if (!Last->Closed) {
513 Last->Header.p_filesz = FileOff - Last->Header.p_offset;
514 Last->Header.p_memsz = VA - Last->Header.p_vaddr;
515 Last->Closed = true;
Michael J. Spencer2f008242015-09-17 19:58:07 +0000516 }
517
Rui Ueyama04dae552015-10-02 21:23:17 +0000518 if (needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000519 VA = RoundUpToAlignment(VA, PageSize);
520 FileOff = RoundUpToAlignment(FileOff, PageSize);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000521 PHDRs.push_back(new (PAlloc)
522 ProgramHeader<ELFT>(PT_LOAD, Flags, FileOff, VA));
Michael J. Spencer2f008242015-09-17 19:58:07 +0000523 }
524 }
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000525 }
526
Rafael Espindola2db634d2015-08-13 20:24:18 +0000527 uintX_t Align = Sec->getAlign();
528 uintX_t Size = Sec->getSize();
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000529 if (Sec->getFlags() & SHF_ALLOC) {
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000530 VA = RoundUpToAlignment(VA, Align);
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000531 Sec->setVA(VA);
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000532 VA += Size;
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000533 }
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000534 FileOff = RoundUpToAlignment(FileOff, Align);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000535 Sec->setFileOffset(FileOff);
Rafael Espindola058f3432015-08-31 20:23:57 +0000536 if (Sec->getType() != SHT_NOBITS)
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000537 FileOff += Size;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000538 }
Rafael Espindola6b83b902015-08-12 00:00:24 +0000539
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000540 // Add a PHDR for the dynamic table.
Rafael Espindola4340aad2015-09-11 22:42:45 +0000541 if (needsDynamicSections())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000542 PHDRs.push_back(&DynamicPHDR);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000543
Rafael Espindola91009b32015-08-12 01:45:28 +0000544 FileOff += OffsetToAlignment(FileOff, ELFT::Is64Bits ? 8 : 4);
545
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000546 // Add space for section headers.
547 SectionHeaderOff = FileOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000548 FileOff += getNumSections() * sizeof(Elf_Shdr);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000549 FileSize = FileOff;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000550}
551
552template <class ELFT> void Writer<ELFT>::writeHeader() {
553 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindola18608a02015-09-08 21:57:31 +0000554 auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000555 EHdr->e_ident[EI_MAG0] = 0x7F;
556 EHdr->e_ident[EI_MAG1] = 0x45;
557 EHdr->e_ident[EI_MAG2] = 0x4C;
558 EHdr->e_ident[EI_MAG3] = 0x46;
Rafael Espindola4b7c2fc2015-08-05 15:08:40 +0000559 EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
560 EHdr->e_ident[EI_DATA] = ELFT::TargetEndianness == llvm::support::little
561 ? ELFDATA2LSB
562 : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000563 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Davide Italianoaa7c5332015-09-25 01:59:13 +0000564
565 const SymbolTable &Symtab = SymTabSec.getSymTable();
566 auto &FirstObj = cast<ObjectFile<ELFT>>(*Symtab.getFirstELF());
567 EHdr->e_ident[EI_OSABI] = FirstObj.getOSABI();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000568
Rafael Espindolae438e072015-09-08 22:55:28 +0000569 // FIXME: Generalize the segment construction similar to how we create
570 // output sections.
Rafael Espindolae438e072015-09-08 22:55:28 +0000571
Rafael Espindola4340aad2015-09-11 22:42:45 +0000572 EHdr->e_type = Config->Shared ? ET_DYN : ET_EXEC;
Rafael Espindolaf98d6d82015-09-03 20:03:54 +0000573 EHdr->e_machine = FirstObj.getEMachine();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000574 EHdr->e_version = EV_CURRENT;
Rafael Espindola4340aad2015-09-11 22:42:45 +0000575 SymbolBody *Entry = Symtab.getEntrySym();
Rafael Espindolacd076f02015-09-25 18:19:03 +0000576 EHdr->e_entry =
577 Entry ? getSymVA(cast<ELFSymbolBody<ELFT>>(*Entry), BssSec) : 0;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000578 EHdr->e_phoff = ProgramHeaderOff;
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000579 EHdr->e_shoff = SectionHeaderOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000580 EHdr->e_ehsize = sizeof(Elf_Ehdr);
581 EHdr->e_phentsize = sizeof(Elf_Phdr);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000582 EHdr->e_phnum = PHDRs.size();
Rafael Espindola18608a02015-09-08 21:57:31 +0000583 EHdr->e_shentsize = sizeof(Elf_Shdr);
Rafael Espindola5f553872015-09-08 17:39:39 +0000584 EHdr->e_shnum = getNumSections();
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000585 EHdr->e_shstrndx = StrTabSec.getSectionIndex();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000586
Michael J. Spencer2f008242015-09-17 19:58:07 +0000587 // If nothing was merged into the file header PT_LOAD, set the size correctly.
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000588 if (FileHeaderPHDR.Header.p_filesz == PageSize) {
589 uint64_t Size = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * PHDRs.size();
590 FileHeaderPHDR.Header.p_filesz = Size;
591 FileHeaderPHDR.Header.p_memsz = Size;
592 }
Michael J. Spencer2f008242015-09-17 19:58:07 +0000593
594 if (needsInterpSection())
595 InterpPHDR.setValuesFromSection(InterpSec);
596 if (needsDynamicSections())
597 DynamicPHDR.setValuesFromSection(DynamicSec);
598
Rafael Espindola18608a02015-09-08 21:57:31 +0000599 auto PHdrs = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000600 for (ProgramHeader<ELFT> *PHDR : PHDRs)
601 *PHdrs++ = PHDR->Header;
Rafael Espindolae438e072015-09-08 22:55:28 +0000602
Rafael Espindola18608a02015-09-08 21:57:31 +0000603 auto SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000604 // First entry is null.
605 ++SHdrs;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000606 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000607 Sec->setNameOffset(StrTabSec.getFileOff(Sec->getName()));
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000608 Sec->template writeHeaderTo<ELFT::TargetEndianness>(SHdrs++);
Rafael Espindola6b83b902015-08-12 00:00:24 +0000609 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000610}
611
612template <class ELFT> void Writer<ELFT>::openFile(StringRef Path) {
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +0000613 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
614 FileOutputBuffer::create(Path, FileSize, FileOutputBuffer::F_executable);
615 error(BufferOrErr, Twine("failed to open ") + Path);
616 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000617}
618
619// Write section contents to a mmap'ed file.
620template <class ELFT> void Writer<ELFT>::writeSections() {
621 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000622 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections)
Rui Ueyama8050d322015-08-14 05:17:30 +0000623 Sec->writeTo(Buf + Sec->getFileOff());
Michael J. Spencer84487f12015-07-24 21:03:07 +0000624}