blob: 8f0c7f2ac0f9e7c2854576dc2b47e0f56d959ac6 [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:
Rafael Espindola18608a02015-09-08 21:57:31 +0000185 typedef typename ELFFile<ELFT>::uintX_t uintX_t;
186 typedef typename ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
187 typedef typename ELFFile<ELFT>::Elf_Ehdr Elf_Ehdr;
188 typedef typename ELFFile<ELFT>::Elf_Phdr Elf_Phdr;
189 typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
Rafael Espindola740fafe2015-09-08 19:43:27 +0000190 Writer(SymbolTable *T) : SymTable(*T, StringTable), DynamicSec(StringTable) {}
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000191 void run();
192
193private:
194 void createSections();
195 void assignAddresses();
196 void openFile(StringRef OutputPath);
197 void writeHeader();
198 void writeSections();
199
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000200 std::unique_ptr<llvm::FileOutputBuffer> Buffer;
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000201 llvm::SpecificBumpPtrAllocator<OutputSection<ELFT>> CAlloc;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000202 std::vector<OutputSectionBase<ELFT::Is64Bits> *> OutputSections;
Rafael Espindola5f553872015-09-08 17:39:39 +0000203 unsigned getNumSections() const { return OutputSections.size() + 1; }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000204
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000205 uintX_t FileSize;
206 uintX_t SizeOfHeaders;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000207 uintX_t SectionHeaderOff;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000208
Rafael Espindolaebd21082015-08-13 22:14:37 +0000209 StringTableSection<ELFT::Is64Bits> StringTable;
210
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000211 SymbolTableSection<ELFT> SymTable;
Rafael Espindola740fafe2015-09-08 19:43:27 +0000212
213 DynamicSection<ELFT::Is64Bits> DynamicSec;
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000214};
215} // anonymous namespace
216
217namespace lld {
218namespace elf2 {
219
Rafael Espindola2ffdd4d2015-08-04 14:29:01 +0000220template <class ELFT>
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000221void writeResult(SymbolTable *Symtab) { Writer<ELFT>(Symtab).run(); }
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000222
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000223template void writeResult<ELF32LE>(SymbolTable *);
224template void writeResult<ELF32BE>(SymbolTable *);
225template void writeResult<ELF64LE>(SymbolTable *);
226template void writeResult<ELF64BE>(SymbolTable *);
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000227
228} // namespace elf2
229} // namespace lld
Michael J. Spencer84487f12015-07-24 21:03:07 +0000230
231// The main function of the writer.
Rui Ueyamaafff74e22015-08-05 23:24:46 +0000232template <class ELFT> void Writer<ELFT>::run() {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000233 createSections();
234 assignAddresses();
Rui Ueyamacb8474ed2015-08-05 23:51:50 +0000235 openFile(Config->OutputFile);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000236 writeHeader();
237 writeSections();
238 error(Buffer->commit());
239}
240
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000241template <class ELFT>
242void OutputSection<ELFT>::addChunk(SectionChunk<ELFT> *C) {
Michael J. Spencer84487f12015-07-24 21:03:07 +0000243 Chunks.push_back(C);
Rafael Espindola832b93f2015-08-24 20:06:32 +0000244 C->setOutputSection(this);
Rafael Espindola0160a282015-08-13 20:13:39 +0000245 uint32_t Align = C->getAlign();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000246 if (Align > this->Header.sh_addralign)
247 this->Header.sh_addralign = Align;
Rafael Espindola0160a282015-08-13 20:13:39 +0000248
Rafael Espindolaebd21082015-08-13 22:14:37 +0000249 uintX_t Off = this->Header.sh_size;
Rafael Espindola0160a282015-08-13 20:13:39 +0000250 Off = RoundUpToAlignment(Off, Align);
Rafael Espindola674b5d52015-08-13 15:54:36 +0000251 C->setOutputSectionOff(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000252 Off += C->getSize();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000253 this->Header.sh_size = Off;
254}
255
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000256template <class ELFT>
Rafael Espindola18608a02015-09-08 21:57:31 +0000257static typename ELFFile<ELFT>::uintX_t getSymVA(DefinedRegular<ELFT> *DR) {
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000258 const SectionChunk<ELFT> *SC = &DR->Section;
259 OutputSection<ELFT> *OS = SC->getOutputSection();
260 return OS->getVA() + SC->getOutputSectionOff() + DR->Sym.st_value;
261}
262
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000263template <class ELFT> void OutputSection<ELFT>::writeTo(uint8_t *Buf) {
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000264 for (SectionChunk<ELFT> *C : Chunks) {
Rafael Espindolaebd21082015-08-13 22:14:37 +0000265 C->writeTo(Buf);
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000266 ObjectFile<ELFT> *File = C->getFile();
267 ELFFile<ELFT> *EObj = File->getObj();
268 uint8_t *Base = Buf + C->getOutputSectionOff();
269
270 // Iterate over all relocation sections that apply to this section.
271 for (const Elf_Shdr *RelSec : C->RelocSections) {
272 // Only support RELA for now.
273 if (RelSec->sh_type != SHT_RELA)
274 continue;
275 for (const Elf_Rela &RI : EObj->relas(RelSec)) {
276 uint32_t SymIndex = RI.getSymbol(EObj->isMips64EL());
277 SymbolBody *Body = File->getSymbolBody(SymIndex);
278 if (!Body)
279 continue;
Rafael Espindola30e17972015-08-30 23:17:30 +0000280 // Skip unsupported for now.
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000281 if (!isa<DefinedRegular<ELFT>>(Body))
Rafael Espindola30e17972015-08-30 23:17:30 +0000282 continue;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000283 uintX_t Offset = RI.r_offset;
284 uint32_t Type = RI.getType(EObj->isMips64EL());
285 uintX_t P = this->getVA() + C->getOutputSectionOff();
286 uintX_t SymVA = getSymVA<ELFT>(cast<DefinedRegular<ELFT>>(Body));
Davide Italiano94f183a2015-08-29 13:15:42 +0000287 uint8_t *Location = Base + Offset;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000288 switch (Type) {
289 case llvm::ELF::R_X86_64_PC32:
Davide Italiano94f183a2015-08-29 13:15:42 +0000290 support::endian::write32le(Location,
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000291 SymVA + (RI.r_addend - (P + Offset)));
292 break;
Davide Italiano94f183a2015-08-29 13:15:42 +0000293 case llvm::ELF::R_X86_64_32:
294 support::endian::write32le(Location, SymVA + RI.r_addend);
295 break;
Michael J. Spencer67bc8d62015-08-27 23:15:56 +0000296 default:
297 llvm::errs() << Twine("unrecognized reloc ") + Twine(Type) << '\n';
298 break;
299 }
300 }
301 }
302 }
Rafael Espindolaebd21082015-08-13 22:14:37 +0000303}
304
305template <bool Is64Bits>
306void StringTableSection<Is64Bits>::writeTo(uint8_t *Buf) {
307 StringRef Data = StrTabBuilder.data();
308 memcpy(Buf, Data.data(), Data.size());
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000309}
310
Rafael Espindola871765c2015-08-28 02:46:41 +0000311template <class ELFT>
312static int compareSym(const typename ELFFile<ELFT>::Elf_Sym *A,
313 const typename ELFFile<ELFT>::Elf_Sym *B) {
314 uint32_t AN = A->st_name;
315 uint32_t BN = B->st_name;
316 assert(AN != BN);
317 return AN - BN;
318}
319
Rafael Espindola18173d42015-09-08 15:50:05 +0000320static bool includeInSymtab(const SymbolBody &B) {
321 if (B.isLazy())
322 return false;
323 if (!B.isUsedInRegularObj())
324 return false;
325 uint8_t V = B.getMostConstrainingVisibility();
326 if (V != STV_DEFAULT && V != STV_PROTECTED)
327 return false;
328 return true;
329}
330
Rafael Espindola62b81b82015-08-14 13:07:05 +0000331template <class ELFT> void SymbolTableSection<ELFT>::writeTo(uint8_t *Buf) {
Rafael Espindola871765c2015-08-28 02:46:41 +0000332 uint8_t *BufStart = Buf;
333
Rafael Espindola62b81b82015-08-14 13:07:05 +0000334 Buf += sizeof(Elf_Sym);
Rafael Espindola62b81b82015-08-14 13:07:05 +0000335 for (auto &P : Table.getSymbols()) {
336 StringRef Name = P.first;
Rafael Espindola383c3232015-08-14 13:52:36 +0000337 Symbol *Sym = P.second;
Rafael Espindola7f377752015-09-01 20:30:52 +0000338 SymbolBody *Body = Sym->Body;
Rafael Espindola18173d42015-09-08 15:50:05 +0000339 if (!includeInSymtab(*Body))
Michael J. Spencer1b348a62015-09-04 22:28:10 +0000340 continue;
Rafael Espindola7f377752015-09-01 20:30:52 +0000341 const Elf_Sym &InputSym = cast<ELFSymbolBody<ELFT>>(Body)->Sym;
Rafael Espindola383c3232015-08-14 13:52:36 +0000342
343 auto *ESym = reinterpret_cast<Elf_Sym *>(Buf);
344 ESym->st_name = Builder.getOffset(Name);
Rafael Espindola832b93f2015-08-24 20:06:32 +0000345
346 const SectionChunk<ELFT> *Section = nullptr;
Rafael Espindola8b09d682015-08-31 22:33:21 +0000347 OutputSection<ELFT> *Out = nullptr;
Rafael Espindola832b93f2015-08-24 20:06:32 +0000348
Rafael Espindolac44d17a2015-08-14 15:10:49 +0000349 switch (Body->kind()) {
Rafael Espindola7f377752015-09-01 20:30:52 +0000350 case SymbolBody::DefinedRegularKind:
351 Section = &cast<DefinedRegular<ELFT>>(Body)->Section;
Rafael Espindola383c3232015-08-14 13:52:36 +0000352 break;
Rafael Espindola8b09d682015-08-31 22:33:21 +0000353 case SymbolBody::DefinedCommonKind:
Rafael Espindola8b09d682015-08-31 22:33:21 +0000354 Out = BSSSec;
355 break;
Rafael Espindola3a63f3f2015-08-28 20:19:34 +0000356 case SymbolBody::UndefinedKind:
Rafael Espindola4f624b92015-09-08 14:32:29 +0000357 if (!Body->isWeak())
358 error(Twine("undefined symbol: ") + Name);
Rafael Espindola0e0c1902015-08-27 12:40:06 +0000359 case SymbolBody::DefinedAbsoluteKind:
Rafael Espindola18173d42015-09-08 15:50:05 +0000360 case SymbolBody::SharedKind:
Rafael Espindola383c3232015-08-14 13:52:36 +0000361 break;
Michael J. Spencer1b348a62015-09-04 22:28:10 +0000362 case SymbolBody::LazyKind:
363 llvm_unreachable("Lazy symbol got to output symbol table!");
Rafael Espindola383c3232015-08-14 13:52:36 +0000364 }
Rafael Espindolaf3837072015-08-25 15:53:17 +0000365
Davide Italianoad6c81c2015-09-04 19:42:14 +0000366 ESym->setBindingAndType(InputSym.getBinding(), InputSym.getType());
Rafael Espindola7f377752015-09-01 20:30:52 +0000367 ESym->st_size = InputSym.st_size;
Davide Italianoad6c81c2015-09-04 19:42:14 +0000368 ESym->setVisibility(Body->getMostConstrainingVisibility());
Rafael Espindola7f377752015-09-01 20:30:52 +0000369 if (InputSym.isAbsolute()) {
370 ESym->st_shndx = SHN_ABS;
371 ESym->st_value = InputSym.st_value;
Rafael Espindolaf3837072015-08-25 15:53:17 +0000372 }
Rafael Espindola383c3232015-08-14 13:52:36 +0000373
Rafael Espindola8b09d682015-08-31 22:33:21 +0000374 if (Section)
375 Out = Section->getOutputSection();
376
377 if (Out) {
Rafael Espindola832b93f2015-08-24 20:06:32 +0000378 ESym->st_shndx = Out->getSectionIndex();
Rafael Espindolaf3837072015-08-25 15:53:17 +0000379 uintX_t VA = Out->getVA();
Rafael Espindola8b09d682015-08-31 22:33:21 +0000380 if (Section)
381 VA += Section->getOutputSectionOff();
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000382 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
383 VA += C->OffsetInBSS;
384 else
Rafael Espindola7f377752015-09-01 20:30:52 +0000385 VA += InputSym.st_value;
Rafael Espindolaf3837072015-08-25 15:53:17 +0000386 ESym->st_value = VA;
Rafael Espindola832b93f2015-08-24 20:06:32 +0000387 }
388
Rafael Espindola62b81b82015-08-14 13:07:05 +0000389 Buf += sizeof(Elf_Sym);
390 }
Rafael Espindola871765c2015-08-28 02:46:41 +0000391
392 // The order the global symbols are in is not defined. We can use an arbitrary
393 // order, but it has to be reproducible. That is true even when cross linking.
394 // The default hashing of StringRef produces different results on 32 and 64
395 // bit systems so we sort by st_name. That is arbitrary but deterministic.
396 // FIXME: Experiment with passing in a custom hashing instead.
397 auto *Syms = reinterpret_cast<Elf_Sym *>(BufStart);
398 ++Syms;
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000399 array_pod_sort(Syms, Syms + NumVisible, compareSym<ELFT>);
Rafael Espindola62b81b82015-08-14 13:07:05 +0000400}
Rafael Espindolaf763ca32015-08-14 02:42:20 +0000401
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000402template <bool Is64Bits>
403template <endianness E>
Rafael Espindolaebd21082015-08-13 22:14:37 +0000404void OutputSectionBase<Is64Bits>::writeHeaderTo(
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000405 typename ELFFile<ELFType<E, Is64Bits>>::Elf_Shdr *SHdr) {
406 SHdr->sh_name = Header.sh_name;
407 SHdr->sh_type = Header.sh_type;
408 SHdr->sh_flags = Header.sh_flags;
409 SHdr->sh_addr = Header.sh_addr;
410 SHdr->sh_offset = Header.sh_offset;
411 SHdr->sh_size = Header.sh_size;
412 SHdr->sh_link = Header.sh_link;
413 SHdr->sh_info = Header.sh_info;
414 SHdr->sh_addralign = Header.sh_addralign;
415 SHdr->sh_entsize = Header.sh_entsize;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000416}
417
Rafael Espindolaa7471792015-08-13 17:04:50 +0000418namespace {
419template <bool Is64Bits> struct SectionKey {
420 typedef typename std::conditional<Is64Bits, uint64_t, uint32_t>::type uintX_t;
421 StringRef Name;
422 uint32_t sh_type;
423 uintX_t sh_flags;
424};
425}
426namespace llvm {
427template <bool Is64Bits> struct DenseMapInfo<SectionKey<Is64Bits>> {
428 static SectionKey<Is64Bits> getEmptyKey() {
429 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getEmptyKey(), 0, 0};
430 }
431 static SectionKey<Is64Bits> getTombstoneKey() {
432 return SectionKey<Is64Bits>{DenseMapInfo<StringRef>::getTombstoneKey(), 0,
433 0};
434 }
435 static unsigned getHashValue(const SectionKey<Is64Bits> &Val) {
436 return hash_combine(Val.Name, Val.sh_type, Val.sh_flags);
437 }
438 static bool isEqual(const SectionKey<Is64Bits> &LHS,
439 const SectionKey<Is64Bits> &RHS) {
440 return DenseMapInfo<StringRef>::isEqual(LHS.Name, RHS.Name) &&
441 LHS.sh_type == RHS.sh_type && LHS.sh_flags == RHS.sh_flags;
442 }
443};
444}
445
Rafael Espindolab56cb942015-09-01 00:16:38 +0000446template <class ELFT>
447static bool cmpAlign(const DefinedCommon<ELFT> *A,
448 const DefinedCommon<ELFT> *B) {
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000449 return A->MaxAlignment > B->MaxAlignment;
Rafael Espindolab56cb942015-09-01 00:16:38 +0000450}
451
Rafael Espindolab01b5742015-09-08 18:08:57 +0000452template <bool Is64Bits>
453static bool compSec(OutputSectionBase<Is64Bits> *A,
454 OutputSectionBase<Is64Bits> *B) {
455 // Place SHF_ALLOC sections first.
456 return (A->getFlags() & SHF_ALLOC) && !(B->getFlags() & SHF_ALLOC);
457}
458
Michael J. Spencer84487f12015-07-24 21:03:07 +0000459// Create output section objects and add them to OutputSections.
460template <class ELFT> void Writer<ELFT>::createSections() {
Rafael Espindola83b0dc62015-08-13 22:21:37 +0000461 SmallDenseMap<SectionKey<ELFT::Is64Bits>, OutputSection<ELFT> *> Map;
Rafael Espindola05185742015-08-31 22:07:18 +0000462 auto getSection = [&](StringRef Name, uint32_t sh_type,
463 uintX_t sh_flags) -> OutputSection<ELFT> * {
464 SectionKey<ELFT::Is64Bits> Key{Name, sh_type, sh_flags};
465 OutputSection<ELFT> *&Sec = Map[Key];
466 if (!Sec) {
467 Sec = new (CAlloc.Allocate())
468 OutputSection<ELFT>(Key.Name, Key.sh_type, Key.sh_flags);
Rafael Espindolab01b5742015-09-08 18:08:57 +0000469 OutputSections.push_back(Sec);
Rafael Espindola05185742015-08-31 22:07:18 +0000470 }
471 return Sec;
472 };
473
Rafael Espindolae6f52102015-08-24 14:48:18 +0000474 const SymbolTable &Symtab = SymTable.getSymTable();
Rafael Espindola222edc62015-09-03 18:56:20 +0000475 for (const std::unique_ptr<ObjectFileBase> &FileB : Symtab.getObjectFiles()) {
Rafael Espindolae7a00e32015-08-05 13:55:34 +0000476 auto &File = cast<ObjectFile<ELFT>>(*FileB);
477 for (SectionChunk<ELFT> *C : File.getChunks()) {
Rafael Espindola832b93f2015-08-24 20:06:32 +0000478 if (!C)
479 continue;
Rafael Espindolaa7471792015-08-13 17:04:50 +0000480 const Elf_Shdr *H = C->getSectionHdr();
Rafael Espindola05185742015-08-31 22:07:18 +0000481 OutputSection<ELFT> *Sec =
482 getSection(C->getSectionName(), H->sh_type, H->sh_flags);
Rafael Espindola29e8d342015-08-13 17:35:13 +0000483 Sec->addChunk(C);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000484 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000485 }
Rafael Espindola05185742015-08-31 22:07:18 +0000486
Rafael Espindola8b09d682015-08-31 22:33:21 +0000487 SymTable.BSSSec = getSection(".bss", SHT_NOBITS, SHF_ALLOC | SHF_WRITE);
488 OutputSection<ELFT> *BSSSec = SymTable.BSSSec;
Rafael Espindola05185742015-08-31 22:07:18 +0000489 // FIXME: Try to avoid the extra walk over all global symbols.
Rafael Espindola5b3942f2015-09-01 20:36:51 +0000490 unsigned &NumVisible = SymTable.NumVisible;
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000491 llvm::StringTableBuilder &Builder = StringTable.StrTabBuilder;
Rafael Espindolab56cb942015-09-01 00:16:38 +0000492 std::vector<DefinedCommon<ELFT> *> CommonSymbols;
Rafael Espindola05185742015-08-31 22:07:18 +0000493 for (auto &P : Symtab.getSymbols()) {
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000494 StringRef Name = P.first;
Rafael Espindola05185742015-08-31 22:07:18 +0000495 SymbolBody *Body = P.second->Body;
Rafael Espindolab56cb942015-09-01 00:16:38 +0000496 if (auto *C = dyn_cast<DefinedCommon<ELFT>>(Body))
497 CommonSymbols.push_back(C);
Rafael Espindola18173d42015-09-08 15:50:05 +0000498 if (!includeInSymtab(*Body))
Rafael Espindolaee1364f2015-09-01 21:47:21 +0000499 continue;
500 NumVisible++;
501 Builder.add(Name);
Rafael Espindolab56cb942015-09-01 00:16:38 +0000502 }
503
504 // Sort the common symbols by alignment as an heuristic to pack them better.
505 std::stable_sort(CommonSymbols.begin(), CommonSymbols.end(), cmpAlign<ELFT>);
506 uintX_t Off = BSSSec->getSize();
507 for (DefinedCommon<ELFT> *C : CommonSymbols) {
Rafael Espindola05185742015-08-31 22:07:18 +0000508 const Elf_Sym &Sym = C->Sym;
Rafael Espindolaf31f9612015-09-01 01:19:12 +0000509 uintX_t Align = C->MaxAlignment;
Rafael Espindola05185742015-08-31 22:07:18 +0000510 Off = RoundUpToAlignment(Off, Align);
Rafael Espindolace8c9c02015-08-31 22:55:21 +0000511 C->OffsetInBSS = Off;
Rafael Espindola05185742015-08-31 22:07:18 +0000512 Off += Sym.st_size;
513 }
Rafael Espindolab56cb942015-09-01 00:16:38 +0000514
Rafael Espindola05185742015-08-31 22:07:18 +0000515 BSSSec->setSize(Off);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000516
Rafael Espindolab01b5742015-09-08 18:08:57 +0000517 OutputSections.push_back(&SymTable);
518 OutputSections.push_back(&StringTable);
519
Rafael Espindola740fafe2015-09-08 19:43:27 +0000520 const std::vector<std::unique_ptr<SharedFileBase>> &SharedFiles =
521 Symtab.getSharedFiles();
522 if (!SharedFiles.empty())
523 OutputSections.push_back(&DynamicSec);
524
Rafael Espindolab01b5742015-09-08 18:08:57 +0000525 std::stable_sort(OutputSections.begin(), OutputSections.end(),
526 compSec<ELFT::Is64Bits>);
527 for (unsigned I = 0, N = OutputSections.size(); I < N; ++I)
528 OutputSections[I]->setSectionIndex(I + 1);
Rafael Espindolaabad6182015-08-13 15:23:46 +0000529}
530
Michael J. Spencer84487f12015-07-24 21:03:07 +0000531// Visits all sections to assign incremental, non-overlapping RVAs and
532// file offsets.
533template <class ELFT> void Writer<ELFT>::assignAddresses() {
Rafael Espindola18608a02015-09-08 21:57:31 +0000534 SizeOfHeaders = RoundUpToAlignment(sizeof(Elf_Ehdr), PageSize);
Rafael Espindola98f6bd02015-08-11 23:14:13 +0000535 uintX_t VA = 0x1000; // The first page is kept unmapped.
536 uintX_t FileOff = SizeOfHeaders;
Rafael Espindolaabad6182015-08-13 15:23:46 +0000537
Rafael Espindolaebd21082015-08-13 22:14:37 +0000538 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
539 StringTable.add(Sec->getName());
540 Sec->finalize();
541
Rafael Espindola2db634d2015-08-13 20:24:18 +0000542 uintX_t Align = Sec->getAlign();
543 uintX_t Size = Sec->getSize();
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000544 if (Sec->getFlags() & SHF_ALLOC) {
545 Sec->setVA(VA);
Rafael Espindola2db634d2015-08-13 20:24:18 +0000546 VA += RoundUpToAlignment(Size, Align);
Rafael Espindolaef1ac012015-08-13 15:31:17 +0000547 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000548 Sec->setFileOffset(FileOff);
Rafael Espindola058f3432015-08-31 20:23:57 +0000549 if (Sec->getType() != SHT_NOBITS)
550 FileOff += RoundUpToAlignment(Size, Align);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000551 }
Rafael Espindola6b83b902015-08-12 00:00:24 +0000552
Rafael Espindola91009b32015-08-12 01:45:28 +0000553 FileOff += OffsetToAlignment(FileOff, ELFT::Is64Bits ? 8 : 4);
554
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000555 // Add space for section headers.
556 SectionHeaderOff = FileOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000557 FileOff += getNumSections() * sizeof(Elf_Shdr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000558 FileSize = SizeOfHeaders + RoundUpToAlignment(FileOff - SizeOfHeaders, 8);
559}
560
Rafael Espindolae438e072015-09-08 22:55:28 +0000561static uint32_t convertSectionFlagsToSegmentFlags(uint64_t Flags) {
562 uint32_t Ret = PF_R;
563 if (Flags & SHF_WRITE)
564 Ret |= PF_W;
565
566 if (Flags & SHF_EXECINSTR)
567 Ret |= PF_X;
568
569 return Ret;
570}
571
Michael J. Spencer84487f12015-07-24 21:03:07 +0000572template <class ELFT> void Writer<ELFT>::writeHeader() {
573 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindola18608a02015-09-08 21:57:31 +0000574 auto *EHdr = reinterpret_cast<Elf_Ehdr *>(Buf);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000575 EHdr->e_ident[EI_MAG0] = 0x7F;
576 EHdr->e_ident[EI_MAG1] = 0x45;
577 EHdr->e_ident[EI_MAG2] = 0x4C;
578 EHdr->e_ident[EI_MAG3] = 0x46;
Rafael Espindola4b7c2fc2015-08-05 15:08:40 +0000579 EHdr->e_ident[EI_CLASS] = ELFT::Is64Bits ? ELFCLASS64 : ELFCLASS32;
580 EHdr->e_ident[EI_DATA] = ELFT::TargetEndianness == llvm::support::little
581 ? ELFDATA2LSB
582 : ELFDATA2MSB;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000583 EHdr->e_ident[EI_VERSION] = EV_CURRENT;
Rafael Espindola87ee8dc2015-08-05 11:55:52 +0000584 EHdr->e_ident[EI_OSABI] = ELFOSABI_NONE;
Michael J. Spencer84487f12015-07-24 21:03:07 +0000585
Rafael Espindolae438e072015-09-08 22:55:28 +0000586 // FIXME: Generalize the segment construction similar to how we create
587 // output sections.
588 unsigned NumSegments = 1;
Rafael Espindolae6f52102015-08-24 14:48:18 +0000589 const SymbolTable &Symtab = SymTable.getSymTable();
Rafael Espindolae438e072015-09-08 22:55:28 +0000590 const std::vector<std::unique_ptr<SharedFileBase>> &SharedFiles =
591 Symtab.getSharedFiles();
592 bool HasDynamicSegment = !SharedFiles.empty();
593 if (HasDynamicSegment)
594 NumSegments++;
595
596 EHdr->e_type = ET_EXEC;
Rafael Espindolaf98d6d82015-09-03 20:03:54 +0000597 auto &FirstObj = cast<ObjectFile<ELFT>>(*Symtab.getFirstELF());
598 EHdr->e_machine = FirstObj.getEMachine();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000599 EHdr->e_version = EV_CURRENT;
Michael J. Spencerac5f0482015-09-08 22:51:46 +0000600 EHdr->e_entry = getSymVA(cast<DefinedRegular<ELFT>>(Symtab.getEntrySym()));
Rafael Espindola18608a02015-09-08 21:57:31 +0000601 EHdr->e_phoff = sizeof(Elf_Ehdr);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000602 EHdr->e_shoff = SectionHeaderOff;
Rafael Espindola18608a02015-09-08 21:57:31 +0000603 EHdr->e_ehsize = sizeof(Elf_Ehdr);
604 EHdr->e_phentsize = sizeof(Elf_Phdr);
Rafael Espindolae438e072015-09-08 22:55:28 +0000605 EHdr->e_phnum = NumSegments;
Rafael Espindola18608a02015-09-08 21:57:31 +0000606 EHdr->e_shentsize = sizeof(Elf_Shdr);
Rafael Espindola5f553872015-09-08 17:39:39 +0000607 EHdr->e_shnum = getNumSections();
Rafael Espindola57b25922015-09-08 19:23:30 +0000608 EHdr->e_shstrndx = StringTable.getSectionIndex();
Michael J. Spencer84487f12015-07-24 21:03:07 +0000609
Rafael Espindola18608a02015-09-08 21:57:31 +0000610 auto PHdrs = reinterpret_cast<Elf_Phdr *>(Buf + EHdr->e_phoff);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000611 PHdrs->p_type = PT_LOAD;
612 PHdrs->p_flags = PF_R | PF_X;
613 PHdrs->p_offset = 0x0000;
614 PHdrs->p_vaddr = 0x400000;
615 PHdrs->p_paddr = PHdrs->p_vaddr;
616 PHdrs->p_filesz = FileSize;
617 PHdrs->p_memsz = FileSize;
618 PHdrs->p_align = 0x4000;
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000619
Rafael Espindolae438e072015-09-08 22:55:28 +0000620 if (HasDynamicSegment) {
621 PHdrs++;
622 PHdrs->p_type = PT_DYNAMIC;
623 PHdrs->p_flags = convertSectionFlagsToSegmentFlags(DynamicSec.getFlags());
624 PHdrs->p_offset = DynamicSec.getFileOff();
625 PHdrs->p_vaddr = DynamicSec.getVA();
626 PHdrs->p_paddr = PHdrs->p_vaddr;
627 PHdrs->p_filesz = 0;
628 PHdrs->p_memsz = 0;
629 PHdrs->p_align = DynamicSec.getAlign();
630 }
631
Rafael Espindola18608a02015-09-08 21:57:31 +0000632 auto SHdrs = reinterpret_cast<Elf_Shdr *>(Buf + EHdr->e_shoff);
Michael J. Spencer8039dae22015-07-29 00:30:10 +0000633 // First entry is null.
634 ++SHdrs;
Rafael Espindolaebd21082015-08-13 22:14:37 +0000635 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections) {
Rui Ueyama8050d322015-08-14 05:17:30 +0000636 Sec->setNameOffset(StringTable.getFileOff(Sec->getName()));
Rafael Espindolaa175eb62015-08-13 18:37:23 +0000637 Sec->template writeHeaderTo<ELFT::TargetEndianness>(SHdrs++);
Rafael Espindola6b83b902015-08-12 00:00:24 +0000638 }
Michael J. Spencer84487f12015-07-24 21:03:07 +0000639}
640
641template <class ELFT> void Writer<ELFT>::openFile(StringRef Path) {
Rafael Espindolabdc8f2f2015-08-13 00:31:46 +0000642 ErrorOr<std::unique_ptr<FileOutputBuffer>> BufferOrErr =
643 FileOutputBuffer::create(Path, FileSize, FileOutputBuffer::F_executable);
644 error(BufferOrErr, Twine("failed to open ") + Path);
645 Buffer = std::move(*BufferOrErr);
Michael J. Spencer84487f12015-07-24 21:03:07 +0000646}
647
648// Write section contents to a mmap'ed file.
649template <class ELFT> void Writer<ELFT>::writeSections() {
650 uint8_t *Buf = Buffer->getBufferStart();
Rafael Espindolaebd21082015-08-13 22:14:37 +0000651 for (OutputSectionBase<ELFT::Is64Bits> *Sec : OutputSections)
Rui Ueyama8050d322015-08-14 05:17:30 +0000652 Sec->writeTo(Buf + Sec->getFileOff());
Michael J. Spencer84487f12015-07-24 21:03:07 +0000653}