blob: ab98ddce8621b0a0af13fc0ad3830a97e236eeb9 [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"
Michael J. Spencer84487f12015-07-24 21:03:07 +000011#include "Chunks.h"
Rui Ueyamacb8474ed2015-08-05 23:51:50 +000012#include "Config.h"
Rafael Espindola192e1fa2015-08-06 15:08:23 +000013#include "Error.h"
Michael J. Spencer67bc8d62015-08-27 23:15:56 +000014#include "Symbols.h"
Rui Ueyamaafff74e22015-08-05 23:24:46 +000015#include "SymbolTable.h"
Rafael Espindola6b83b902015-08-12 00:00:24 +000016
Rui Ueyamae44524d2015-07-28 00:17:25 +000017#include "llvm/ADT/DenseMap.h"
Rafael Espindola871765c2015-08-28 02:46:41 +000018#include "llvm/ADT/STLExtras.h"
Rafael Espindolaee1364f2015-09-01 21:47:21 +000019#include "llvm/MC/StringTableBuilder.h"
Rui Ueyamaafff74e22015-08-05 23:24:46 +000020#include "llvm/Support/FileOutputBuffer.h"
Michael J. Spencer67bc8d62015-08-27 23:15:56 +000021#include "llvm/Support/raw_ostream.h"
Michael J. Spencer84487f12015-07-24 21:03:07 +000022
23using namespace llvm;
24using namespace llvm::ELF;
25using namespace llvm::object;
26
27using namespace lld;
28using namespace lld::elf2;
29
30static const int PageSize = 4096;
31
Rui Ueyamaafff74e22015-08-05 23:24:46 +000032namespace {
Rafael Espindola52a0f1e2015-08-11 23:22:24 +000033// OutputSection represents a section in an output file. It's a
34// container of chunks. OutputSection and Chunk are 1:N relationship.
35// Chunks cannot belong to more than one OutputSections. The writer
36// creates multiple OutputSections and assign them unique,
37// non-overlapping file offsets and VAs.
Rafael Espindolaebd21082015-08-13 22:14:37 +000038template <bool Is64Bits> class OutputSectionBase {
Rafael Espindola52a0f1e2015-08-11 23:22:24 +000039public:
Rafael Espindolaa175eb62015-08-13 18:37:23 +000040 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
41 typedef
42 typename std::conditional<Is64Bits, Elf64_Shdr, Elf32_Shdr>::type HeaderT;
Rafael Espindola02183402015-08-11 23:34:29 +000043
Rafael Espindolaebd21082015-08-13 22:14:37 +000044 OutputSectionBase(StringRef Name, uint32_t sh_type, uintX_t sh_flags)
Rafael Espindola375a5082015-08-13 17:32:30 +000045 : Name(Name) {
Rafael Espindolaa175eb62015-08-13 18:37:23 +000046 memset(&Header, 0, sizeof(HeaderT));
Rafael Espindola375a5082015-08-13 17:32:30 +000047 Header.sh_type = sh_type;
48 Header.sh_flags = sh_flags;
Rafael Espindola372889a2015-08-12 23:25:42 +000049 }
Rafael Espindola184d94e2015-08-13 18:25:47 +000050 void setVA(uintX_t VA) { Header.sh_addr = VA; }
Rafael Espindolaf3837072015-08-25 15:53:17 +000051 uintX_t getVA() { return Header.sh_addr; }
Rafael Espindola184d94e2015-08-13 18:25:47 +000052 void setFileOffset(uintX_t Off) { Header.sh_offset = Off; }
Rafael Espindolaa175eb62015-08-13 18:37:23 +000053 template <endianness E>
54 void writeHeaderTo(typename ELFFile<ELFType<E, Is64Bits>>::Elf_Shdr *SHdr);
Rafael Espindola6b83b902015-08-12 00:00:24 +000055 StringRef getName() { return Name; }
56 void setNameOffset(uintX_t Offset) { Header.sh_name = Offset; }
Rafael Espindola52a0f1e2015-08-11 23:22:24 +000057
Rafael Espindola832b93f2015-08-24 20:06:32 +000058 unsigned getSectionIndex() const { return SectionIndex; }
59 void setSectionIndex(unsigned I) { SectionIndex = I; }
60
Rafael Espindola52a0f1e2015-08-11 23:22:24 +000061 // Returns the size of the section in the output file.
Rafael Espindola02183402015-08-11 23:34:29 +000062 uintX_t getSize() { return Header.sh_size; }
Rafael Espindola05185742015-08-31 22:07:18 +000063 void setSize(uintX_t Val) { Header.sh_size = Val; }
Rafael Espindolaabad6182015-08-13 15:23:46 +000064 uintX_t getFlags() { return Header.sh_flags; }
Rui Ueyama8050d322015-08-14 05:17:30 +000065 uintX_t getFileOff() { return Header.sh_offset; }
Michael J. Spencerbaae5382015-09-05 00:25:33 +000066 uintX_t getAlign() {
67 // The ELF spec states that a value of 0 means the section has no alignment
68 // constraits.
69 return std::max<uintX_t>(Header.sh_addralign, 1);
70 }
Rafael Espindola058f3432015-08-31 20:23:57 +000071 uint32_t getType() { return Header.sh_type; }
Rafael Espindolaabad6182015-08-13 15:23:46 +000072
Rafael Espindolaebd21082015-08-13 22:14:37 +000073 virtual void finalize() {}
74 virtual void writeTo(uint8_t *Buf) = 0;
75
76protected:
Rafael Espindola52a0f1e2015-08-11 23:22:24 +000077 StringRef Name;
Rafael Espindolaa175eb62015-08-13 18:37:23 +000078 HeaderT Header;
Rafael Espindola832b93f2015-08-24 20:06:32 +000079 unsigned SectionIndex;
Rafael Espindolaebd21082015-08-13 22:14:37 +000080 ~OutputSectionBase() = default;
81};
Rafael Espindola832b93f2015-08-24 20:06:32 +000082}
Rafael Espindolaebd21082015-08-13 22:14:37 +000083
Rafael Espindola83b0dc62015-08-13 22:21:37 +000084template <class ELFT>
Rafael Espindola832b93f2015-08-24 20:06:32 +000085class lld::elf2::OutputSection final
86 : public OutputSectionBase<ELFT::Is64Bits> {
Rafael Espindolaebd21082015-08-13 22:14:37 +000087public:
Rafael Espindola83b0dc62015-08-13 22:21:37 +000088 typedef typename OutputSectionBase<ELFT::Is64Bits>::uintX_t uintX_t;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +000089 typedef typename ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
90 typedef typename ELFFile<ELFT>::Elf_Rela Elf_Rela;
Rafael Espindolaebd21082015-08-13 22:14:37 +000091 OutputSection(StringRef Name, uint32_t sh_type, uintX_t sh_flags)
Rafael Espindola83b0dc62015-08-13 22:21:37 +000092 : OutputSectionBase<ELFT::Is64Bits>(Name, sh_type, sh_flags) {}
Rafael Espindolaebd21082015-08-13 22:14:37 +000093
Rafael Espindola83b0dc62015-08-13 22:21:37 +000094 void addChunk(SectionChunk<ELFT> *C);
Rafael Espindolaebd21082015-08-13 22:14:37 +000095 void writeTo(uint8_t *Buf) override;
96
97private:
Rafael Espindola83b0dc62015-08-13 22:21:37 +000098 std::vector<SectionChunk<ELFT> *> Chunks;
Rafael Espindola52a0f1e2015-08-11 23:22:24 +000099};
100
Rafael Espindola832b93f2015-08-24 20:06:32 +0000101namespace {
Rafael Espindolaebd21082015-08-13 22:14:37 +0000102template <bool Is64Bits>
103class StringTableSection final : public OutputSectionBase<Is64Bits> {
Rafael Espindolaebd21082015-08-13 22:14:37 +0000104public:
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000105 llvm::StringTableBuilder StrTabBuilder;
106
Rafael Espindolaebd21082015-08-13 22:14:37 +0000107 typedef typename OutputSectionBase<Is64Bits>::uintX_t uintX_t;
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000108 StringTableSection() : OutputSectionBase<Is64Bits>(".strtab", SHT_STRTAB, 0) {
Rafael Espindolaebd21082015-08-13 22:14:37 +0000109 this->Header.sh_addralign = 1;
110 }
111
112 void add(StringRef S) { StrTabBuilder.add(S); }
Rui Ueyama8050d322015-08-14 05:17:30 +0000113 size_t getFileOff(StringRef S) { return StrTabBuilder.getOffset(S); }
Rafael Espindolaebd21082015-08-13 22:14:37 +0000114 void writeTo(uint8_t *Buf) override;
115
116 void finalize() override {
117 StrTabBuilder.finalize(StringTableBuilder::ELF);
118 this->Header.sh_size = StrTabBuilder.data().size();
119 }
120};
121
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000122template <class ELFT>
123class SymbolTableSection final : public OutputSectionBase<ELFT::Is64Bits> {
124public:
Rafael Espindola62b81b82015-08-14 13:07:05 +0000125 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
Rafael Espindolaf3837072015-08-25 15:53:17 +0000126 typedef typename OutputSectionBase<ELFT::Is64Bits>::uintX_t uintX_t;
Rafael Espindola57b25922015-09-08 19:23:30 +0000127 SymbolTableSection(SymbolTable &Table,
128 StringTableSection<ELFT::Is64Bits> &StrTabSec)
Rafael Espindola62b81b82015-08-14 13:07:05 +0000129 : OutputSectionBase<ELFT::Is64Bits>(".symtab", SHT_SYMTAB, 0),
Rafael Espindola57b25922015-09-08 19:23:30 +0000130 Table(Table), Builder(StrTabSec.StrTabBuilder), StrTabSec(StrTabSec) {
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000131 typedef OutputSectionBase<ELFT::Is64Bits> Base;
132 typename Base::HeaderT &Header = this->Header;
133
134 // For now the only local symbol is going to be the one at index 0
135 Header.sh_info = 1;
136
Rafael Espindola62b81b82015-08-14 13:07:05 +0000137 Header.sh_entsize = sizeof(Elf_Sym);
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000138 Header.sh_addralign = ELFT::Is64Bits ? 8 : 4;
139 }
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000140
141 void finalize() override {
142 this->Header.sh_size = (NumVisible + 1) * sizeof(Elf_Sym);
Rafael Espindola57b25922015-09-08 19:23:30 +0000143 this->Header.sh_link = StrTabSec.getSectionIndex();
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000144 }
145
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000146 void writeTo(uint8_t *Buf) override;
Rafael Espindola62b81b82015-08-14 13:07:05 +0000147
Rafael Espindolae6f52102015-08-24 14:48:18 +0000148 const SymbolTable &getSymTable() { return Table; }
149
Rafael Espindola8b09d682015-08-31 22:33:21 +0000150 OutputSection<ELFT> *BSSSec = nullptr;
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000151 unsigned NumVisible = 0;
Rafael Espindola8b09d682015-08-31 22:33:21 +0000152
Rafael Espindola62b81b82015-08-14 13:07:05 +0000153private:
154 SymbolTable &Table;
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000155 llvm::StringTableBuilder &Builder;
Rafael Espindola57b25922015-09-08 19:23:30 +0000156 const StringTableSection<ELFT::Is64Bits> &StrTabSec;
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000157};
158
Rafael Espindola740fafe2015-09-08 19:43:27 +0000159template <bool Is64Bits>
160class DynamicSection final : public OutputSectionBase<Is64Bits> {
161public:
162 DynamicSection(const StringTableSection<Is64Bits> &StrTabSec)
163 : OutputSectionBase<Is64Bits>(".dynamic", SHT_DYNAMIC,
164 SHF_ALLOC | SHF_WRITE),
165 StrTabSec(StrTabSec) {
166 typedef OutputSectionBase<Is64Bits> Base;
167 typename Base::HeaderT &Header = this->Header;
168 Header.sh_addralign = Is64Bits ? 8 : 4;
169 Header.sh_entsize = Is64Bits ? 16 : 8;
170 }
171
172 void finalize() override {
173 this->Header.sh_link = StrTabSec.getSectionIndex();
174 }
175
176 void writeTo(uint8_t *Buf) override {}
177
178private:
179 const StringTableSection<Is64Bits> &StrTabSec;
180};
181
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000182// The writer writes a SymbolTable result to a file.
183template <class ELFT> class Writer {
184public:
185 typedef typename llvm::object::ELFFile<ELFT>::uintX_t uintX_t;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000186 typedef typename llvm::object::ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
Rafael Espindola05185742015-08-31 22:07:18 +0000187 typedef typename llvm::object::ELFFile<ELFT>::Elf_Sym Elf_Sym;
Rafael Espindola740fafe2015-09-08 19:43:27 +0000188 Writer(SymbolTable *T) : SymTable(*T, StringTable), DynamicSec(StringTable) {}
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000189 void run();
190
191private:
192 void createSections();
193 void assignAddresses();
194 void openFile(StringRef OutputPath);
195 void writeHeader();
196 void writeSections();
197
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000198 std::unique_ptr<llvm::FileOutputBuffer> Buffer;
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000199 llvm::SpecificBumpPtrAllocator<OutputSection<ELFT>> CAlloc;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000200 std::vector<OutputSectionBase<ELFT::Is64Bits> *> OutputSections;
Rafael Espindola5f553872015-09-08 17:39:39 +0000201 unsigned getNumSections() const { return OutputSections.size() + 1; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000202
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000203 uintX_t FileSize;
204 uintX_t SizeOfHeaders;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000205 uintX_t SectionHeaderOff;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000206
Rafael Espindolaebd21082015-08-13 22:14:37 +0000207 StringTableSection<ELFT::Is64Bits> StringTable;
208
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000209 SymbolTableSection<ELFT> SymTable;
Rafael Espindola740fafe2015-09-08 19:43:27 +0000210
211 DynamicSection<ELFT::Is64Bits> DynamicSec;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000212};
213} // anonymous namespace
214
215namespace lld {
216namespace elf2 {
217
Rafael Espindola2ffdd4d2015-08-04 14:29:01 +0000218template <class ELFT>
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000219void writeResult(SymbolTable *Symtab) { Writer<ELFT>(Symtab).run(); }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000220
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000221template void writeResult<ELF32LE>(SymbolTable *);
222template void writeResult<ELF32BE>(SymbolTable *);
223template void writeResult<ELF64LE>(SymbolTable *);
224template void writeResult<ELF64BE>(SymbolTable *);
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000225
226} // namespace elf2
227} // namespace lld
Michael J. Spencer84487f12015-07-24 21:03:07 +0000228
229// The main function of the writer.
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000230template <class ELFT> void Writer<ELFT>::run() {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000231 createSections();
232 assignAddresses();
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000233 openFile(Config->OutputFile);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000234 writeHeader();
235 writeSections();
236 error(Buffer->commit());
237}
238
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000239template <class ELFT>
240void OutputSection<ELFT>::addChunk(SectionChunk<ELFT> *C) {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000241 Chunks.push_back(C);
Rafael Espindola832b93f2015-08-24 20:06:32 +0000242 C->setOutputSection(this);
Rafael Espindola0160a282015-08-13 20:13:39 +0000243 uint32_t Align = C->getAlign();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000244 if (Align > this->Header.sh_addralign)
245 this->Header.sh_addralign = Align;
Rafael Espindola0160a282015-08-13 20:13:39 +0000246
Rafael Espindolaebd21082015-08-13 22:14:37 +0000247 uintX_t Off = this->Header.sh_size;
Rafael Espindola0160a282015-08-13 20:13:39 +0000248 Off = RoundUpToAlignment(Off, Align);
Rafael Espindola674b5d52015-08-13 15:54:36 +0000249 C->setOutputSectionOff(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000250 Off += C->getSize();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000251 this->Header.sh_size = Off;
252}
253
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000254template <class ELFT>
255static typename llvm::object::ELFFile<ELFT>::uintX_t
256getSymVA(DefinedRegular<ELFT> *DR) {
257 const SectionChunk<ELFT> *SC = &DR->Section;
258 OutputSection<ELFT> *OS = SC->getOutputSection();
259 return OS->getVA() + SC->getOutputSectionOff() + DR->Sym.st_value;
260}
261
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000262template <class ELFT> void OutputSection<ELFT>::writeTo(uint8_t *Buf) {
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000263 for (SectionChunk<ELFT> *C : Chunks) {
Rafael Espindolaebd21082015-08-13 22:14:37 +0000264 C->writeTo(Buf);
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000265 ObjectFile<ELFT> *File = C->getFile();
266 ELFFile<ELFT> *EObj = File->getObj();
267 uint8_t *Base = Buf + C->getOutputSectionOff();
268
269 // Iterate over all relocation sections that apply to this section.
270 for (const Elf_Shdr *RelSec : C->RelocSections) {
271 // Only support RELA for now.
272 if (RelSec->sh_type != SHT_RELA)
273 continue;
274 for (const Elf_Rela &RI : EObj->relas(RelSec)) {
275 uint32_t SymIndex = RI.getSymbol(EObj->isMips64EL());
276 SymbolBody *Body = File->getSymbolBody(SymIndex);
277 if (!Body)
278 continue;
Rafael Espindola30e17972015-08-30 23:17:30 +0000279 // Skip unsupported for now.
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000280 if (!isa<DefinedRegular<ELFT>>(Body))
Rafael Espindola30e17972015-08-30 23:17:30 +0000281 continue;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000282 uintX_t Offset = RI.r_offset;
283 uint32_t Type = RI.getType(EObj->isMips64EL());
284 uintX_t P = this->getVA() + C->getOutputSectionOff();
285 uintX_t SymVA = getSymVA<ELFT>(cast<DefinedRegular<ELFT>>(Body));
Davide Italiano94f183a2015-08-29 13:15:42 +0000286 uint8_t *Location = Base + Offset;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000287 switch (Type) {
288 case llvm::ELF::R_X86_64_PC32:
Davide Italiano94f183a2015-08-29 13:15:42 +0000289 support::endian::write32le(Location,
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000290 SymVA + (RI.r_addend - (P + Offset)));
291 break;
Davide Italiano94f183a2015-08-29 13:15:42 +0000292 case llvm::ELF::R_X86_64_32:
293 support::endian::write32le(Location, SymVA + RI.r_addend);
294 break;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000295 default:
296 llvm::errs() << Twine("unrecognized reloc ") + Twine(Type) << '\n';
297 break;
298 }
299 }
300 }
301 }
Rafael Espindolaebd21082015-08-13 22:14:37 +0000302}
303
304template <bool Is64Bits>
305void StringTableSection<Is64Bits>::writeTo(uint8_t *Buf) {
306 StringRef Data = StrTabBuilder.data();
307 memcpy(Buf, Data.data(), Data.size());
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000308}
309
Rafael Espindola871765c2015-08-28 02:46:41 +0000310template <class ELFT>
311static int compareSym(const typename ELFFile<ELFT>::Elf_Sym *A,
312 const typename ELFFile<ELFT>::Elf_Sym *B) {
313 uint32_t AN = A->st_name;
314 uint32_t BN = B->st_name;
315 assert(AN != BN);
316 return AN - BN;
317}
318
Rafael Espindola18173d42015-09-08 15:50:05 +0000319static bool includeInSymtab(const SymbolBody &B) {
320 if (B.isLazy())
321 return false;
322 if (!B.isUsedInRegularObj())
323 return false;
324 uint8_t V = B.getMostConstrainingVisibility();
325 if (V != STV_DEFAULT && V != STV_PROTECTED)
326 return false;
327 return true;
328}
329
Rafael Espindola62b81b82015-08-14 13:07:05 +0000330template <class ELFT> void SymbolTableSection<ELFT>::writeTo(uint8_t *Buf) {
Rafael Espindola871765c2015-08-28 02:46:41 +0000331 uint8_t *BufStart = Buf;
332
Rafael Espindola62b81b82015-08-14 13:07:05 +0000333 Buf += sizeof(Elf_Sym);
Rafael Espindola62b81b82015-08-14 13:07:05 +0000334 for (auto &P : Table.getSymbols()) {
335 StringRef Name = P.first;
Rafael Espindola383c3232015-08-14 13:52:36 +0000336 Symbol *Sym = P.second;
Rafael Espindola7f377752015-09-01 20:30:52 +0000337 SymbolBody *Body = Sym->Body;
Rafael Espindola18173d42015-09-08 15:50:05 +0000338 if (!includeInSymtab(*Body))
Michael J. Spencer1b348a62015-09-04 22:28:10 +0000339 continue;
Rafael Espindola7f377752015-09-01 20:30:52 +0000340 const Elf_Sym &InputSym = cast<ELFSymbolBody<ELFT>>(Body)->Sym;
Rafael Espindola383c3232015-08-14 13:52:36 +0000341
342 auto *ESym = reinterpret_cast<Elf_Sym *>(Buf);
343 ESym->st_name = Builder.getOffset(Name);
Rafael Espindola832b93f2015-08-24 20:06:32 +0000344
345 const SectionChunk<ELFT> *Section = nullptr;
Rafael Espindola8b09d682015-08-31 22:33:21 +0000346 OutputSection<ELFT> *Out = nullptr;
Rafael Espindola832b93f2015-08-24 20:06:32 +0000347
Rafael Espindolac44d17a2015-08-14 15:10:49 +0000348 switch (Body->kind()) {
Rafael Espindola7f377752015-09-01 20:30:52 +0000349 case SymbolBody::DefinedRegularKind:
350 Section = &cast<DefinedRegular<ELFT>>(Body)->Section;
Rafael Espindola383c3232015-08-14 13:52:36 +0000351 break;
Rafael Espindola8b09d682015-08-31 22:33:21 +0000352 case SymbolBody::DefinedCommonKind:
Rafael Espindola8b09d682015-08-31 22:33:21 +0000353 Out = BSSSec;
354 break;
Rafael Espindola3a63f3f2015-08-28 20:19:34 +0000355 case SymbolBody::UndefinedKind:
Rafael Espindola4f624b92015-09-08 14:32:29 +0000356 if (!Body->isWeak())
357 error(Twine("undefined symbol: ") + Name);
Rafael Espindola0e0c1902015-08-27 12:40:06 +0000358 case SymbolBody::DefinedAbsoluteKind:
Rafael Espindola18173d42015-09-08 15:50:05 +0000359 case SymbolBody::SharedKind:
Rafael Espindola383c3232015-08-14 13:52:36 +0000360 break;
Michael J. Spencer1b348a62015-09-04 22:28:10 +0000361 case SymbolBody::LazyKind:
362 llvm_unreachable("Lazy symbol got to output symbol table!");
Rafael Espindola383c3232015-08-14 13:52:36 +0000363 }
Rafael Espindolaf3837072015-08-25 15:53:17 +0000364
Davide Italianoad6c81c2015-09-04 19:42:14 +0000365 ESym->setBindingAndType(InputSym.getBinding(), InputSym.getType());
Rafael Espindola7f377752015-09-01 20:30:52 +0000366 ESym->st_size = InputSym.st_size;
Davide Italianoad6c81c2015-09-04 19:42:14 +0000367 ESym->setVisibility(Body->getMostConstrainingVisibility());
Rafael Espindola7f377752015-09-01 20:30:52 +0000368 if (InputSym.isAbsolute()) {
369 ESym->st_shndx = SHN_ABS;
370 ESym->st_value = InputSym.st_value;
Rafael Espindolaf3837072015-08-25 15:53:17 +0000371 }
Rafael Espindola383c3232015-08-14 13:52:36 +0000372
Rafael Espindola8b09d682015-08-31 22:33:21 +0000373 if (Section)
374 Out = Section->getOutputSection();
375
376 if (Out) {
Rafael Espindola832b93f2015-08-24 20:06:32 +0000377 ESym->st_shndx = Out->getSectionIndex();
Rafael Espindolaf3837072015-08-25 15:53:17 +0000378 uintX_t VA = Out->getVA();
Rafael Espindola8b09d682015-08-31 22:33:21 +0000379 if (Section)
380 VA += Section->getOutputSectionOff();
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000381 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
382 VA += C->OffsetInBSS;
383 else
Rafael Espindola7f377752015-09-01 20:30:52 +0000384 VA += InputSym.st_value;
Rafael Espindolaf3837072015-08-25 15:53:17 +0000385 ESym->st_value = VA;
Rafael Espindola832b93f2015-08-24 20:06:32 +0000386 }
387
Rafael Espindola62b81b82015-08-14 13:07:05 +0000388 Buf += sizeof(Elf_Sym);
389 }
Rafael Espindola871765c2015-08-28 02:46:41 +0000390
391 // The order the global symbols are in is not defined. We can use an arbitrary
392 // order, but it has to be reproducible. That is true even when cross linking.
393 // The default hashing of StringRef produces different results on 32 and 64
394 // bit systems so we sort by st_name. That is arbitrary but deterministic.
395 // FIXME: Experiment with passing in a custom hashing instead.
396 auto *Syms = reinterpret_cast<Elf_Sym *>(BufStart);
397 ++Syms;
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000398 array_pod_sort(Syms, Syms + NumVisible, compareSym<ELFT>);
Rafael Espindola62b81b82015-08-14 13:07:05 +0000399}
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000400
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000401template <bool Is64Bits>
402template <endianness E>
Rafael Espindolaebd21082015-08-13 22:14:37 +0000403void OutputSectionBase<Is64Bits>::writeHeaderTo(
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000404 typename ELFFile<ELFType<E, Is64Bits>>::Elf_Shdr *SHdr) {
405 SHdr->sh_name = Header.sh_name;
406 SHdr->sh_type = Header.sh_type;
407 SHdr->sh_flags = Header.sh_flags;
408 SHdr->sh_addr = Header.sh_addr;
409 SHdr->sh_offset = Header.sh_offset;
410 SHdr->sh_size = Header.sh_size;
411 SHdr->sh_link = Header.sh_link;
412 SHdr->sh_info = Header.sh_info;
413 SHdr->sh_addralign = Header.sh_addralign;
414 SHdr->sh_entsize = Header.sh_entsize;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000415}
416
Rafael Espindolaa7471792015-08-13 17:04:50 +0000417namespace {
418template <bool Is64Bits> struct SectionKey {
419 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
420 StringRef Name;
421 uint32_t sh_type;
422 uintX_t sh_flags;
423};
424}
425namespace llvm {
426template <bool Is64Bits> struct DenseMapInfo<SectionKey<Is64Bits>> {
427 static SectionKey<Is64Bits> getEmptyKey() {
428 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getEmptyKey(), 0, 0};
429 }
430 static SectionKey<Is64Bits> getTombstoneKey() {
431 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getTombstoneKey(), 0,
432 0};
433 }
434 static unsigned getHashValue(const SectionKey<Is64Bits> &Val) {
435 return hash_combine(Val.Name, Val.sh_type, Val.sh_flags);
436 }
437 static bool isEqual(const SectionKey<Is64Bits> &LHS,
438 const SectionKey<Is64Bits> &RHS) {
439 return DenseMapInfo<StringRef>::isEqual(LHS.Name, RHS.Name) &&
440 LHS.sh_type == RHS.sh_type && LHS.sh_flags == RHS.sh_flags;
441 }
442};
443}
444
Rafael Espindolab56cb942015-09-01 00:16:38 +0000445template <class ELFT>
446static bool cmpAlign(const DefinedCommon<ELFT> *A,
447 const DefinedCommon<ELFT> *B) {
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000448 return A->MaxAlignment > B->MaxAlignment;
Rafael Espindolab56cb942015-09-01 00:16:38 +0000449}
450
Rafael Espindolab01b5742015-09-08 18:08:57 +0000451template <bool Is64Bits>
452static bool compSec(OutputSectionBase<Is64Bits> *A,
453 OutputSectionBase<Is64Bits> *B) {
454 // Place SHF_ALLOC sections first.
455 return (A->getFlags() & SHF_ALLOC) && !(B->getFlags() & SHF_ALLOC);
456}
457
Michael J. Spencer84487f12015-07-24 21:03:07 +0000458// Create output section objects and add them to OutputSections.
459template <class ELFT> void Writer<ELFT>::createSections() {
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000460 SmallDenseMap<SectionKey<ELFT::Is64Bits>, OutputSection<ELFT> *> Map;
Rafael Espindola05185742015-08-31 22:07:18 +0000461 auto getSection = [&](StringRef Name, uint32_t sh_type,
462 uintX_t sh_flags) -> OutputSection<ELFT> * {
463 SectionKey<ELFT::Is64Bits> Key{Name, sh_type, sh_flags};
464 OutputSection<ELFT> *&Sec = Map[Key];
465 if (!Sec) {
466 Sec = new (CAlloc.Allocate())
467 OutputSection<ELFT>(Key.Name, Key.sh_type, Key.sh_flags);
Rafael Espindolab01b5742015-09-08 18:08:57 +0000468 OutputSections.push_back(Sec);
Rafael Espindola05185742015-08-31 22:07:18 +0000469 }
470 return Sec;
471 };
472
Rafael Espindolae6f52102015-08-24 14:48:18 +0000473 const SymbolTable &Symtab = SymTable.getSymTable();
Rafael Espindola222edc62015-09-03 18:56:20 +0000474 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
Rafael Espindolae7a00e32015-08-05 13:55:34 +0000475 auto &File = cast<ObjectFile<ELFT>>(*FileB);
476 for (SectionChunk<ELFT> *C : File.getChunks()) {
Rafael Espindola832b93f2015-08-24 20:06:32 +0000477 if (!C)
478 continue;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000479 const Elf_Shdr *H = C->getSectionHdr();
Rafael Espindola05185742015-08-31 22:07:18 +0000480 OutputSection<ELFT> *Sec =
481 getSection(C->getSectionName(), H->sh_type, H->sh_flags);
Rafael Espindola29e8d342015-08-13 17:35:13 +0000482 Sec->addChunk(C);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000483 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000484 }
Rafael Espindola05185742015-08-31 22:07:18 +0000485
Rafael Espindola8b09d682015-08-31 22:33:21 +0000486 SymTable.BSSSec = getSection(".bss", SHT_NOBITS, SHF_ALLOC | SHF_WRITE);
487 OutputSection<ELFT> *BSSSec = SymTable.BSSSec;
Rafael Espindola05185742015-08-31 22:07:18 +0000488 // FIXME: Try to avoid the extra walk over all global symbols.
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000489 unsigned &NumVisible = SymTable.NumVisible;
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000490 llvm::StringTableBuilder &Builder = StringTable.StrTabBuilder;
Rafael Espindolab56cb942015-09-01 00:16:38 +0000491 std::vector<DefinedCommon<ELFT> *> CommonSymbols;
Rafael Espindola05185742015-08-31 22:07:18 +0000492 for (auto &P : Symtab.getSymbols()) {
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000493 StringRef Name = P.first;
Rafael Espindola05185742015-08-31 22:07:18 +0000494 SymbolBody *Body = P.second->Body;
Rafael Espindolab56cb942015-09-01 00:16:38 +0000495 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
496 CommonSymbols.push_back(C);
Rafael Espindola18173d42015-09-08 15:50:05 +0000497 if (!includeInSymtab(*Body))
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000498 continue;
499 NumVisible++;
500 Builder.add(Name);
Rafael Espindolab56cb942015-09-01 00:16:38 +0000501 }
502
503 // Sort the common symbols by alignment as an heuristic to pack them better.
504 std::stable_sort(CommonSymbols.begin(), CommonSymbols.end(), cmpAlign<ELFT>);
505 uintX_t Off = BSSSec->getSize();
506 for (DefinedCommon<ELFT> *C : CommonSymbols) {
Rafael Espindola05185742015-08-31 22:07:18 +0000507 const Elf_Sym &Sym = C->Sym;
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000508 uintX_t Align = C->MaxAlignment;
Rafael Espindola05185742015-08-31 22:07:18 +0000509 Off = RoundUpToAlignment(Off, Align);
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000510 C->OffsetInBSS = Off;
Rafael Espindola05185742015-08-31 22:07:18 +0000511 Off += Sym.st_size;
512 }
Rafael Espindolab56cb942015-09-01 00:16:38 +0000513
Rafael Espindola05185742015-08-31 22:07:18 +0000514 BSSSec->setSize(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000515
Rafael Espindolab01b5742015-09-08 18:08:57 +0000516 OutputSections.push_back(&SymTable);
517 OutputSections.push_back(&StringTable);
518
Rafael Espindola740fafe2015-09-08 19:43:27 +0000519 const std::vector<std::unique_ptr<SharedFileBase>> &SharedFiles =
520 Symtab.getSharedFiles();
521 if (!SharedFiles.empty())
522 OutputSections.push_back(&DynamicSec);
523
Rafael Espindolab01b5742015-09-08 18:08:57 +0000524 std::stable_sort(OutputSections.begin(), OutputSections.end(),
525 compSec<ELFT::Is64Bits>);
526 for (unsigned I = 0, N = OutputSections.size(); I < N; ++I)
527 OutputSections[I]->setSectionIndex(I + 1);
Rafael Espindolaabad6182015-08-13 15:23:46 +0000528}
529
Michael J. Spencer84487f12015-07-24 21:03:07 +0000530// Visits all sections to assign incremental, non-overlapping RVAs and
531// file offsets.
532template <class ELFT> void Writer<ELFT>::assignAddresses() {
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000533 SizeOfHeaders = RoundUpToAlignment(sizeof(Elf_Ehdr_Impl<ELFT>), PageSize);
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000534 uintX_t VA = 0x1000; // The first page is kept unmapped.
535 uintX_t FileOff = SizeOfHeaders;
Rafael Espindolaabad6182015-08-13 15:23:46 +0000536
Rafael Espindolaebd21082015-08-13 22:14:37 +0000537 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
538 StringTable.add(Sec->getName());
539 Sec->finalize();
540
Rafael Espindola2db634d2015-08-13 20:24:18 +0000541 uintX_t Align = Sec->getAlign();
542 uintX_t Size = Sec->getSize();
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000543 if (Sec->getFlags() & SHF_ALLOC) {
544 Sec->setVA(VA);
Rafael Espindola2db634d2015-08-13 20:24:18 +0000545 VA += RoundUpToAlignment(Size, Align);
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000546 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000547 Sec->setFileOffset(FileOff);
Rafael Espindola058f3432015-08-31 20:23:57 +0000548 if (Sec->getType() != SHT_NOBITS)
549 FileOff += RoundUpToAlignment(Size, Align);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000550 }
Rafael Espindola6b83b902015-08-12 00:00:24 +0000551
Rafael Espindola91009b32015-08-12 01:45:28 +0000552 FileOff += OffsetToAlignment(FileOff, ELFT::Is64Bits ? 8 : 4);
553
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000554 // Add space for section headers.
555 SectionHeaderOff = FileOff;
Rafael Espindola5f553872015-09-08 17:39:39 +0000556 FileOff += getNumSections() * sizeof(Elf_Shdr_Impl<ELFT>);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000557 FileSize = SizeOfHeaders + RoundUpToAlignment(FileOff - SizeOfHeaders, 8);
558}
559
560template <class ELFT> void Writer<ELFT>::writeHeader() {
561 uint8_t *Buf = Buffer->getBufferStart();
562 auto *EHdr = reinterpret_cast<Elf_Ehdr_Impl<ELFT> *>(Buf);
563 EHdr->e_ident[EI_MAG0] = 0x7F;
564 EHdr->e_ident[EI_MAG1] = 0x45;
565 EHdr->e_ident[EI_MAG2] = 0x4C;
566 EHdr->e_ident[EI_MAG3] = 0x46;
Rafael Espindola4b7c2fc2015-08-05 15:08:40 +0000567 EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
568 EHdr->e_ident[EI_DATA] = ELFT::TargetEndianness == llvm::support::little
569 ? ELFDATA2LSB
570 : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000571 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Rafael Espindola87ee8dc2015-08-05 11:55:52 +0000572 EHdr->e_ident[EI_OSABI] = ELFOSABI_NONE;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000573
574 EHdr->e_type = ET_EXEC;
Rafael Espindolae6f52102015-08-24 14:48:18 +0000575 const SymbolTable &Symtab = SymTable.getSymTable();
Rafael Espindolaf98d6d82015-09-03 20:03:54 +0000576 auto &FirstObj = cast<ObjectFile<ELFT>>(*Symtab.getFirstELF());
577 EHdr->e_machine = FirstObj.getEMachine();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000578 EHdr->e_version = EV_CURRENT;
Rafael Espindolab9fe03d2015-09-08 21:32:44 +0000579 EHdr->e_entry = 0x401000;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000580 EHdr->e_phoff = sizeof(Elf_Ehdr_Impl<ELFT>);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000581 EHdr->e_shoff = SectionHeaderOff;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000582 EHdr->e_ehsize = sizeof(Elf_Ehdr_Impl<ELFT>);
583 EHdr->e_phentsize = sizeof(Elf_Phdr_Impl<ELFT>);
584 EHdr->e_phnum = 1;
585 EHdr->e_shentsize = sizeof(Elf_Shdr_Impl<ELFT>);
Rafael Espindola5f553872015-09-08 17:39:39 +0000586 EHdr->e_shnum = getNumSections();
Rafael Espindola57b25922015-09-08 19:23:30 +0000587 EHdr->e_shstrndx = StringTable.getSectionIndex();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000588
589 auto PHdrs = reinterpret_cast<Elf_Phdr_Impl<ELFT> *>(Buf + EHdr->e_phoff);
590 PHdrs->p_type = PT_LOAD;
591 PHdrs->p_flags = PF_R | PF_X;
592 PHdrs->p_offset = 0x0000;
593 PHdrs->p_vaddr = 0x400000;
594 PHdrs->p_paddr = PHdrs->p_vaddr;
595 PHdrs->p_filesz = FileSize;
596 PHdrs->p_memsz = FileSize;
597 PHdrs->p_align = 0x4000;
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000598
599 auto SHdrs = reinterpret_cast<Elf_Shdr_Impl<ELFT> *>(Buf + EHdr->e_shoff);
600 // First entry is null.
601 ++SHdrs;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000602 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rui Ueyama8050d322015-08-14 05:17:30 +0000603 Sec->setNameOffset(StringTable.getFileOff(Sec->getName()));
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000604 Sec->template writeHeaderTo<ELFT::TargetEndianness>(SHdrs++);
Rafael Espindola6b83b902015-08-12 00:00:24 +0000605 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000606}
607
608template <class ELFT> void Writer<ELFT>::openFile(StringRef Path) {
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +0000609 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
610 FileOutputBuffer::create(Path, FileSize, FileOutputBuffer::F_executable);
611 error(BufferOrErr, Twine("failed to open ") + Path);
612 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000613}
614
615// Write section contents to a mmap'ed file.
616template <class ELFT> void Writer<ELFT>::writeSections() {
617 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000618 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections)
Rui Ueyama8050d322015-08-14 05:17:30 +0000619 Sec->writeTo(Buf + Sec->getFileOff());
Michael J. Spencer84487f12015-07-24 21:03:07 +0000620}