blob: e25089d99d52d1e637c565f3d40c3a0f171c2714 [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()),
88 PltSec(GotSec), HashSec(DynSymSec),
89 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
151namespace lld {
152namespace elf2 {
153
Rafael Espindola2ffdd4d2015-08-04 14:29:01 +0000154template <class ELFT>
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000155void writeResult(SymbolTable *Symtab) { Writer<ELFT>(Symtab).run(); }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000156
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000157template void writeResult<ELF32LE>(SymbolTable *);
158template void writeResult<ELF32BE>(SymbolTable *);
159template void writeResult<ELF64LE>(SymbolTable *);
160template void writeResult<ELF64BE>(SymbolTable *);
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000161
162} // namespace elf2
163} // namespace lld
Michael J. Spencer84487f12015-07-24 21:03:07 +0000164
165// The main function of the writer.
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000166template <class ELFT> void Writer<ELFT>::run() {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000167 createSections();
168 assignAddresses();
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000169 openFile(Config->OutputFile);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000170 writeHeader();
171 writeSections();
172 error(Buffer->commit());
173}
174
Rafael Espindolaa7471792015-08-13 17:04:50 +0000175namespace {
176template <bool Is64Bits> struct SectionKey {
177 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
178 StringRef Name;
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000179 uint32_t Type;
180 uintX_t Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000181};
182}
183namespace llvm {
184template <bool Is64Bits> struct DenseMapInfo<SectionKey<Is64Bits>> {
185 static SectionKey<Is64Bits> getEmptyKey() {
186 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getEmptyKey(), 0, 0};
187 }
188 static SectionKey<Is64Bits> getTombstoneKey() {
189 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getTombstoneKey(), 0,
190 0};
191 }
192 static unsigned getHashValue(const SectionKey<Is64Bits> &Val) {
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000193 return hash_combine(Val.Name, Val.Type, Val.Flags);
Rafael Espindolaa7471792015-08-13 17:04:50 +0000194 }
195 static bool isEqual(const SectionKey<Is64Bits> &LHS,
196 const SectionKey<Is64Bits> &RHS) {
197 return DenseMapInfo<StringRef>::isEqual(LHS.Name, RHS.Name) &&
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000198 LHS.Type == RHS.Type && LHS.Flags == RHS.Flags;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000199 }
200};
201}
202
Rafael Espindola19e38892015-09-16 15:54:15 +0000203// The reason we have to do this early scan is as follows
204// * To mmap the output file, we need to know the size
205// * For that, we need to know how many dynamic relocs we will have.
206// It might be possible to avoid this by outputting the file with write:
207// * Write the allocated output sections, computing addresses.
208// * Apply relocations, recording which ones require a dynamic reloc.
209// * Write the dynamic relocations.
210// * Write the rest of the file.
211template <class ELFT>
Rafael Espindola67a5da62015-09-17 14:02:10 +0000212template <bool isRela>
213void Writer<ELFT>::scanRelocs(
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000214 const InputSection<ELFT> &C,
Rafael Espindola67a5da62015-09-17 14:02:10 +0000215 iterator_range<const Elf_Rel_Impl<ELFT, isRela> *> Rels) {
216 typedef Elf_Rel_Impl<ELFT, isRela> RelType;
217 const ObjectFile<ELFT> &File = *C.getFile();
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000218 bool IsMips64EL = File.getObj().isMips64EL();
Rafael Espindola67a5da62015-09-17 14:02:10 +0000219 for (const RelType &RI : Rels) {
220 uint32_t SymIndex = RI.getSymbol(IsMips64EL);
Rafael Espindola5c2310c2015-09-18 14:40:19 +0000221 SymbolBody *Body = File.getSymbolBody(SymIndex);
Rafael Espindolaeb792732015-09-21 15:11:29 +0000222 uint32_t Type = RI.getType(IsMips64EL);
Rafael Espindolaae244002015-10-05 19:30:12 +0000223 if (Body) {
224 if (Target->relocNeedsPlt(Type, *Body)) {
225 if (Body->isInPlt())
226 continue;
227 PltSec.addEntry(Body);
228 }
229 if (Target->relocNeedsGot(Type, *Body)) {
230 if (Body->isInGot())
231 continue;
232 GotSec.addEntry(Body);
233 Body->setUsedInDynamicReloc();
234 RelaDynSec.addReloc({C, RI});
Rafael Espindolaeb792732015-09-21 15:11:29 +0000235 continue;
Rafael Espindolaae244002015-10-05 19:30:12 +0000236 }
237 if (Body->isShared()) {
238 Body->setUsedInDynamicReloc();
239 RelaDynSec.addReloc({C, RI});
240 continue;
241 }
Rafael Espindolaeb792732015-09-21 15:11:29 +0000242 }
Rafael Espindolaae244002015-10-05 19:30:12 +0000243 if (Config->Shared && !Target->isRelRelative(Type))
244 RelaDynSec.addReloc({C, RI});
Rafael Espindola67a5da62015-09-17 14:02:10 +0000245 }
246}
247
248template <class ELFT>
Rafael Espindola53d5cea2015-09-21 17:47:00 +0000249void Writer<ELFT>::scanRelocs(const InputSection<ELFT> &C) {
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000250 ObjectFile<ELFT> *File = C.getFile();
251 ELFFile<ELFT> &EObj = File->getObj();
Rafael Espindola19e38892015-09-16 15:54:15 +0000252
253 if (!(C.getSectionHdr()->sh_flags & SHF_ALLOC))
254 return;
255
256 for (const Elf_Shdr *RelSec : C.RelocSections) {
Rafael Espindola67a5da62015-09-17 14:02:10 +0000257 if (RelSec->sh_type == SHT_RELA)
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000258 scanRelocs(C, EObj.relas(RelSec));
Rafael Espindola67a5da62015-09-17 14:02:10 +0000259 else
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000260 scanRelocs(C, EObj.rels(RelSec));
Rafael Espindola19e38892015-09-16 15:54:15 +0000261 }
262}
263
Rafael Espindola6173f842015-09-23 14:37:01 +0000264template <class ELFT>
Rui Ueyama44f5d912015-10-01 14:46:54 +0000265static void reportUndefined(const SymbolTable &S, const SymbolBody &Sym) {
Rafael Espindola6173f842015-09-23 14:37:01 +0000266 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
267 typedef typename ELFFile<ELFT>::Elf_Sym_Range Elf_Sym_Range;
268
George Rimar57e40de2015-10-01 20:14:45 +0000269 if (Config->Shared && !Config->NoUndefined)
George Rimaree058282015-10-01 17:24:24 +0000270 return;
271
Rafael Espindola6173f842015-09-23 14:37:01 +0000272 const Elf_Sym &SymE = cast<ELFSymbolBody<ELFT>>(Sym).Sym;
273 ELFFileBase *SymFile = nullptr;
274
275 for (const std::unique_ptr<ObjectFileBase> &F : S.getObjectFiles()) {
276 const auto &File = cast<ObjectFile<ELFT>>(*F);
Rafael Espindolae1901cc2015-09-24 15:11:50 +0000277 Elf_Sym_Range Syms = File.getObj().symbols(File.getSymbolTable());
Rafael Espindola6173f842015-09-23 14:37:01 +0000278 if (&SymE > Syms.begin() && &SymE < Syms.end())
279 SymFile = F.get();
280 }
Rafael Espindola551dfd82015-09-25 19:24:57 +0000281
282 std::string Message = "undefined symbol: " + Sym.getName().str();
Rafael Espindola6173f842015-09-23 14:37:01 +0000283 if (SymFile)
Rafael Espindola551dfd82015-09-25 19:24:57 +0000284 Message += " in " + SymFile->getName().str();
285 if (Config->NoInhibitExec)
286 warning(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000287 else
Rafael Espindola551dfd82015-09-25 19:24:57 +0000288 error(Message);
Rafael Espindola6173f842015-09-23 14:37:01 +0000289}
290
Michael J. Spencer84487f12015-07-24 21:03:07 +0000291// Create output section objects and add them to OutputSections.
292template <class ELFT> void Writer<ELFT>::createSections() {
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000293 SmallDenseMap<SectionKey<ELFT::Is64Bits>, OutputSection<ELFT> *> Map;
Rafael Espindolac2d21192015-09-23 18:25:05 +0000294
295 OutputSections.push_back(&BssSec);
296 Map[{BssSec.getName(), BssSec.getType(), BssSec.getFlags()}] = &BssSec;
297
Rafael Espindola0e604f92015-09-25 18:56:53 +0000298 SymbolTable &Symtab = SymTabSec.getSymTable();
Rafael Espindola19e38892015-09-16 15:54:15 +0000299 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
300 auto &File = cast<ObjectFile<ELFT>>(*FileB);
Davide Italiano6d328d32015-09-16 20:45:57 +0000301 if (!Config->DiscardAll) {
302 Elf_Sym_Range Syms = File.getLocalSymbols();
303 for (const Elf_Sym &Sym : Syms) {
304 ErrorOr<StringRef> SymName = Sym.getName(File.getStringTable());
Rafael Espindolad1cf4212015-10-05 16:25:43 +0000305 if (SymName && shouldKeepInSymtab<ELFT>(*SymName, Sym))
Davide Italiano6d328d32015-09-16 20:45:57 +0000306 SymTabSec.addSymbol(*SymName, true);
307 }
308 }
Rafael Espindola71675852015-09-22 00:16:19 +0000309 for (InputSection<ELFT> *C : File.getSections()) {
Rafael Espindola19e38892015-09-16 15:54:15 +0000310 if (!C)
311 continue;
312 const Elf_Shdr *H = C->getSectionHdr();
Rafael Espindolad13d9602015-09-25 15:08:44 +0000313 SectionKey<ELFT::Is64Bits> Key{C->getSectionName(), H->sh_type,
314 H->sh_flags};
315 OutputSection<ELFT> *&Sec = Map[Key];
316 if (!Sec) {
317 Sec = new (CAlloc.Allocate()) OutputSection<ELFT>(
Rui Ueyama0fb1ee02015-10-02 21:13:19 +0000318 PltSec, GotSec, BssSec, Key.Name, Key.Type, Key.Flags);
Rafael Espindolad13d9602015-09-25 15:08:44 +0000319 OutputSections.push_back(Sec);
320 }
Rafael Espindola71675852015-09-22 00:16:19 +0000321 Sec->addSection(C);
Rafael Espindola19e38892015-09-16 15:54:15 +0000322 scanRelocs(*C);
323 }
324 }
325
Rafael Espindola77572242015-10-02 19:37:55 +0000326 DynamicSec.PreInitArraySec =
327 Map.lookup({".preinit_array", SHT_PREINIT_ARRAY, SHF_WRITE | SHF_ALLOC});
328 DynamicSec.InitArraySec =
329 Map.lookup({".init_array", SHT_INIT_ARRAY, SHF_WRITE | SHF_ALLOC});
330 DynamicSec.FiniArraySec =
331 Map.lookup({".fini_array", SHT_FINI_ARRAY, SHF_WRITE | SHF_ALLOC});
332
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000333 auto AddStartEnd = [&Symtab](StringRef Start, StringRef End,
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000334 OutputSection<ELFT> *OS) {
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000335 if (OS) {
Michael J. Spencer6e78d162015-10-06 02:13:54 +0000336 Symtab.addSyntheticSym<ELFT>(Start, *OS, 0);
337 Symtab.addSyntheticSym<ELFT>(End, *OS, OS->getSize());
338 } else {
339 Symtab.addIgnoredSym<ELFT>(Start);
340 Symtab.addIgnoredSym<ELFT>(End);
Michael J. Spencer95538ca2015-10-06 01:16:17 +0000341 }
342 };
343
Michael J. Spencerfcacad22015-10-06 19:57:05 +0000344 AddStartEnd("__preinit_array_start", "__preinit_array_end",
345 DynamicSec.PreInitArraySec);
346 AddStartEnd("__init_array_start", "__init_array_end",
347 DynamicSec.InitArraySec);
348 AddStartEnd("__fini_array_start", "__fini_array_end",
349 DynamicSec.FiniArraySec);
Rafael Espindola0e604f92015-09-25 18:56:53 +0000350
Michael J. Spencerf32446f2015-10-06 20:39:09 +0000351 // __tls_get_addr is defined by the dynamic linker for dynamic ELFs. For
352 // static linking the linker is required to optimize away any references to
353 // __tls_get_addr, so it's not defined anywhere. Create a hidden definition
354 // to avoid the undefined symbol error.
355 if (!isOutputDynamic())
356 Symtab.addIgnoredSym<ELFT>("__tls_get_addr");
357
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000358 // FIXME: Try to avoid the extra walk over all global symbols.
359 std::vector<DefinedCommon<ELFT> *> CommonSymbols;
360 for (auto &P : Symtab.getSymbols()) {
361 StringRef Name = P.first;
362 SymbolBody *Body = P.second->Body;
Denis Protivensky22220d52015-10-05 09:43:57 +0000363 if (auto *U = dyn_cast<Undefined<ELFT>>(Body)) {
364 if (!U->isWeak() && !U->canKeepUndefined())
365 reportUndefined<ELFT>(Symtab, *Body);
366 }
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000367
368 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
369 CommonSymbols.push_back(C);
Rafael Espindola4f674ed2015-10-05 15:24:04 +0000370 if (!includeInSymtab<ELFT>(*Body))
Rafael Espindola05a3dd22015-09-22 23:38:23 +0000371 continue;
372 SymTabSec.addSymbol(Name);
373
374 if (needsDynamicSections() && includeInDynamicSymtab(*Body))
375 HashSec.addSymbol(Body);
376 }
377
Rafael Espindolab56cb942015-09-01 00:16:38 +0000378 // Sort the common symbols by alignment as an heuristic to pack them better.
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000379 std::stable_sort(
380 CommonSymbols.begin(), CommonSymbols.end(),
381 [](const DefinedCommon<ELFT> *A, const DefinedCommon<ELFT> *B) {
382 return A->MaxAlignment > B->MaxAlignment;
383 });
384
Rafael Espindolac2d21192015-09-23 18:25:05 +0000385 uintX_t Off = BssSec.getSize();
Rafael Espindolab56cb942015-09-01 00:16:38 +0000386 for (DefinedCommon<ELFT> *C : CommonSymbols) {
Rafael Espindola05185742015-08-31 22:07:18 +0000387 const Elf_Sym &Sym = C->Sym;
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000388 uintX_t Align = C->MaxAlignment;
Rafael Espindola05185742015-08-31 22:07:18 +0000389 Off = RoundUpToAlignment(Off, Align);
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000390 C->OffsetInBSS = Off;
Rafael Espindola05185742015-08-31 22:07:18 +0000391 Off += Sym.st_size;
392 }
Rafael Espindolab56cb942015-09-01 00:16:38 +0000393
Rafael Espindolac2d21192015-09-23 18:25:05 +0000394 BssSec.setSize(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000395
Rafael Espindolafb815282015-09-11 00:30:13 +0000396 OutputSections.push_back(&SymTabSec);
Rafael Espindolab01b5742015-09-08 18:08:57 +0000397
Rafael Espindola4340aad2015-09-11 22:42:45 +0000398 if (needsDynamicSections()) {
Rafael Espindola70107762015-09-11 18:49:42 +0000399 if (needsInterpSection())
400 OutputSections.push_back(&InterpSec);
Rafael Espindolafb815282015-09-11 00:30:13 +0000401 OutputSections.push_back(&DynSymSec);
Rafael Espindola601771e2015-09-14 20:20:34 +0000402 OutputSections.push_back(&HashSec);
Rafael Espindola740fafe2015-09-08 19:43:27 +0000403 OutputSections.push_back(&DynamicSec);
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000404 OutputSections.push_back(&DynStrSec);
Denis Protivensky18add762015-09-17 09:54:29 +0000405 if (RelaDynSec.hasRelocs())
Rafael Espindola19e38892015-09-16 15:54:15 +0000406 OutputSections.push_back(&RelaDynSec);
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000407 }
Rafael Espindolacdfecff2015-09-23 20:08:25 +0000408 if (!GotSec.empty())
409 OutputSections.push_back(&GotSec);
410 if (!PltSec.empty())
411 OutputSections.push_back(&PltSec);
Rafael Espindola740fafe2015-09-08 19:43:27 +0000412
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000413 std::stable_sort(
414 OutputSections.begin(), OutputSections.end(),
415 [](OutputSectionBase<ELFT::Is64Bits> *A,
416 OutputSectionBase<ELFT::Is64Bits> *B) {
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000417 uintX_t AFlags = A->getFlags();
418 uintX_t BFlags = B->getFlags();
419
420 // Allocatable sections go first to reduce the total PT_LOAD size and
421 // so debug info doesn't change addresses in actual code.
422 bool AIsAlloc = AFlags & SHF_ALLOC;
423 bool BIsAlloc = BFlags & SHF_ALLOC;
424 if (AIsAlloc != BIsAlloc)
425 return AIsAlloc;
426
427 // We don't have any special requirements for the relative order of
428 // two non allocatable sections.
429 if (!AIsAlloc)
430 return false;
431
432 // We want the read only sections first so that they go in the PT_LOAD
433 // covering the program headers at the start of the file.
434 bool AIsWritable = AFlags & SHF_WRITE;
435 bool BIsWritable = BFlags & SHF_WRITE;
436 if (AIsWritable != BIsWritable)
437 return BIsWritable;
438
439 // For a corresponding reason, put non exec sections first (the program
440 // header PT_LOAD is not executable).
441 bool AIsExec = AFlags & SHF_EXECINSTR;
442 bool BIsExec = BFlags & SHF_EXECINSTR;
443 if (AIsExec != BIsExec)
444 return BIsExec;
445
446 // If we got here we know that both A and B and in the same PT_LOAD.
447 // The last requirement we have is to put nobits section last. The
448 // reason is that the only thing the dynamic linker will see about
449 // them is a p_memsz that is larger than p_filesz. Seeing that it
450 // zeros the end of the PT_LOAD, so that has to correspond to the
451 // nobits sections.
452 return A->getType() != SHT_NOBITS && B->getType() == SHT_NOBITS;
Rui Ueyama3f4ec662015-09-25 03:48:25 +0000453 });
454
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000455 // Always put StrTabSec last so that no section names are added to it after
456 // it's finalized.
457 OutputSections.push_back(&StrTabSec);
458
Rafael Espindolab01b5742015-09-08 18:08:57 +0000459 for (unsigned I = 0, N = OutputSections.size(); I < N; ++I)
460 OutputSections[I]->setSectionIndex(I + 1);
Michael J. Spencer52bf0eb2015-10-01 21:15:02 +0000461
462 // Fill the DynStrSec early.
463 DynamicSec.finalize();
Rafael Espindolaabad6182015-08-13 15:23:46 +0000464}
465
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000466template <class ELFT>
Rui Ueyama04dae552015-10-02 21:23:17 +0000467static bool needsPHDR(OutputSectionBase<ELFT::Is64Bits> *Sec) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000468 return Sec->getFlags() & SHF_ALLOC;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000469}
470
Michael J. Spencer84487f12015-07-24 21:03:07 +0000471// Visits all sections to assign incremental, non-overlapping RVAs and
472// file offsets.
473template <class ELFT> void Writer<ELFT>::assignAddresses() {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000474 assert(!OutputSections.empty() && "No output sections to layout!");
Rafael Espindola4340aad2015-09-11 22:42:45 +0000475 uintX_t VA = getVAStart();
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000476 uintX_t FileOff = 0;
Rafael Espindola60252d82015-09-09 22:53:55 +0000477
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000478 FileOff += sizeof(Elf_Ehdr);
479 VA += sizeof(Elf_Ehdr);
Rafael Espindolaabad6182015-08-13 15:23:46 +0000480
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000481 // Reserve space for PHDRs.
482 ProgramHeaderOff = FileOff;
483 FileOff = RoundUpToAlignment(FileOff, PageSize);
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000484 VA = RoundUpToAlignment(VA, PageSize);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000485
Rafael Espindola70107762015-09-11 18:49:42 +0000486 if (needsInterpSection())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000487 PHDRs.push_back(&InterpPHDR);
Rafael Espindola70107762015-09-11 18:49:42 +0000488
Michael J. Spencer2f008242015-09-17 19:58:07 +0000489 // Create a PHDR for the file header.
490 PHDRs.push_back(&FileHeaderPHDR);
491 FileHeaderPHDR.Header.p_vaddr = getVAStart();
492 FileHeaderPHDR.Header.p_paddr = getVAStart();
493 FileHeaderPHDR.Header.p_align = PageSize;
Rafael Espindola0a2e2112015-09-10 15:41:34 +0000494
Rafael Espindolaebd21082015-08-13 22:14:37 +0000495 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000496 StrTabSec.add(Sec->getName());
Rafael Espindolaebd21082015-08-13 22:14:37 +0000497 Sec->finalize();
498
Michael J. Spencer2f008242015-09-17 19:58:07 +0000499 if (Sec->getSize()) {
Rui Ueyama04dae552015-10-02 21:23:17 +0000500 uintX_t Flags = toPHDRFlags(Sec->getFlags());
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000501 ProgramHeader<ELFT> *Last = PHDRs.back();
Rui Ueyama04dae552015-10-02 21:23:17 +0000502 if (Last->Header.p_flags != Flags || !needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000503 // Flags changed. End current PHDR and potentially create a new one.
Rui Ueyama04dae552015-10-02 21:23:17 +0000504 if (!Last->Closed) {
505 Last->Header.p_filesz = FileOff - Last->Header.p_offset;
506 Last->Header.p_memsz = VA - Last->Header.p_vaddr;
507 Last->Closed = true;
Michael J. Spencer2f008242015-09-17 19:58:07 +0000508 }
509
Rui Ueyama04dae552015-10-02 21:23:17 +0000510 if (needsPHDR<ELFT>(Sec)) {
Michael J. Spencer2f008242015-09-17 19:58:07 +0000511 VA = RoundUpToAlignment(VA, PageSize);
512 FileOff = RoundUpToAlignment(FileOff, PageSize);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000513 PHDRs.push_back(new (PAlloc)
514 ProgramHeader<ELFT>(PT_LOAD, Flags, FileOff, VA));
Michael J. Spencer2f008242015-09-17 19:58:07 +0000515 }
516 }
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000517 }
518
Rafael Espindola2db634d2015-08-13 20:24:18 +0000519 uintX_t Align = Sec->getAlign();
520 uintX_t Size = Sec->getSize();
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000521 if (Sec->getFlags() & SHF_ALLOC) {
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000522 VA = RoundUpToAlignment(VA, Align);
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000523 Sec->setVA(VA);
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000524 VA += Size;
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000525 }
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000526 FileOff = RoundUpToAlignment(FileOff, Align);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000527 Sec->setFileOffset(FileOff);
Rafael Espindola058f3432015-08-31 20:23:57 +0000528 if (Sec->getType() != SHT_NOBITS)
Rafael Espindolabfcdfb32015-09-14 19:00:35 +0000529 FileOff += Size;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000530 }
Rafael Espindola6b83b902015-08-12 00:00:24 +0000531
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000532 // Add a PHDR for the dynamic table.
Rafael Espindola4340aad2015-09-11 22:42:45 +0000533 if (needsDynamicSections())
Michael J. Spencer2f008242015-09-17 19:58:07 +0000534 PHDRs.push_back(&DynamicPHDR);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000535
Rafael Espindola91009b32015-08-12 01:45:28 +0000536 FileOff += OffsetToAlignment(FileOff, ELFT::Is64Bits ? 8 : 4);
537
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000538 // Add space for section headers.
539 SectionHeaderOff = FileOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000540 FileOff += getNumSections() * sizeof(Elf_Shdr);
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000541 FileSize = FileOff;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000542}
543
544template <class ELFT> void Writer<ELFT>::writeHeader() {
545 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindola18608a02015-09-08 21:57:31 +0000546 auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000547 EHdr->e_ident[EI_MAG0] = 0x7F;
548 EHdr->e_ident[EI_MAG1] = 0x45;
549 EHdr->e_ident[EI_MAG2] = 0x4C;
550 EHdr->e_ident[EI_MAG3] = 0x46;
Rafael Espindola4b7c2fc2015-08-05 15:08:40 +0000551 EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
552 EHdr->e_ident[EI_DATA] = ELFT::TargetEndianness == llvm::support::little
553 ? ELFDATA2LSB
554 : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000555 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Davide Italianoaa7c5332015-09-25 01:59:13 +0000556
557 const SymbolTable &Symtab = SymTabSec.getSymTable();
558 auto &FirstObj = cast<ObjectFile<ELFT>>(*Symtab.getFirstELF());
559 EHdr->e_ident[EI_OSABI] = FirstObj.getOSABI();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000560
Rafael Espindolae438e072015-09-08 22:55:28 +0000561 // FIXME: Generalize the segment construction similar to how we create
562 // output sections.
Rafael Espindolae438e072015-09-08 22:55:28 +0000563
Rafael Espindola4340aad2015-09-11 22:42:45 +0000564 EHdr->e_type = Config->Shared ? ET_DYN : ET_EXEC;
Rafael Espindolaf98d6d82015-09-03 20:03:54 +0000565 EHdr->e_machine = FirstObj.getEMachine();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000566 EHdr->e_version = EV_CURRENT;
Rafael Espindola4340aad2015-09-11 22:42:45 +0000567 SymbolBody *Entry = Symtab.getEntrySym();
Rafael Espindolacd076f02015-09-25 18:19:03 +0000568 EHdr->e_entry =
569 Entry ? getSymVA(cast<ELFSymbolBody<ELFT>>(*Entry), BssSec) : 0;
Michael J. Spencer1d299a82015-09-09 20:48:09 +0000570 EHdr->e_phoff = ProgramHeaderOff;
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000571 EHdr->e_shoff = SectionHeaderOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000572 EHdr->e_ehsize = sizeof(Elf_Ehdr);
573 EHdr->e_phentsize = sizeof(Elf_Phdr);
Michael J. Spencer2f008242015-09-17 19:58:07 +0000574 EHdr->e_phnum = PHDRs.size();
Rafael Espindola18608a02015-09-08 21:57:31 +0000575 EHdr->e_shentsize = sizeof(Elf_Shdr);
Rafael Espindola5f553872015-09-08 17:39:39 +0000576 EHdr->e_shnum = getNumSections();
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000577 EHdr->e_shstrndx = StrTabSec.getSectionIndex();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000578
Michael J. Spencer2f008242015-09-17 19:58:07 +0000579 // If nothing was merged into the file header PT_LOAD, set the size correctly.
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000580 if (FileHeaderPHDR.Header.p_filesz == PageSize) {
581 uint64_t Size = sizeof(Elf_Ehdr) + sizeof(Elf_Phdr) * PHDRs.size();
582 FileHeaderPHDR.Header.p_filesz = Size;
583 FileHeaderPHDR.Header.p_memsz = Size;
584 }
Michael J. Spencer2f008242015-09-17 19:58:07 +0000585
586 if (needsInterpSection())
587 InterpPHDR.setValuesFromSection(InterpSec);
588 if (needsDynamicSections())
589 DynamicPHDR.setValuesFromSection(DynamicSec);
590
Rafael Espindola18608a02015-09-08 21:57:31 +0000591 auto PHdrs = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
Rui Ueyama5713b8d2015-10-02 22:17:07 +0000592 for (ProgramHeader<ELFT> *PHDR : PHDRs)
593 *PHdrs++ = PHDR->Header;
Rafael Espindolae438e072015-09-08 22:55:28 +0000594
Rafael Espindola18608a02015-09-08 21:57:31 +0000595 auto SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000596 // First entry is null.
597 ++SHdrs;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000598 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rafael Espindola3f4228f2015-09-09 15:33:08 +0000599 Sec->setNameOffset(StrTabSec.getFileOff(Sec->getName()));
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000600 Sec->template writeHeaderTo<ELFT::TargetEndianness>(SHdrs++);
Rafael Espindola6b83b902015-08-12 00:00:24 +0000601 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000602}
603
604template <class ELFT> void Writer<ELFT>::openFile(StringRef Path) {
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +0000605 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
606 FileOutputBuffer::create(Path, FileSize, FileOutputBuffer::F_executable);
607 error(BufferOrErr, Twine("failed to open ") + Path);
608 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000609}
610
611// Write section contents to a mmap'ed file.
612template <class ELFT> void Writer<ELFT>::writeSections() {
613 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000614 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections)
Rui Ueyama8050d322015-08-14 05:17:30 +0000615 Sec->writeTo(Buf + Sec->getFileOff());
Michael J. Spencer84487f12015-07-24 21:03:07 +0000616}