1 //===- lib/MC/ELFObjectWriter.cpp - ELF File Writer -------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements ELF object file writer information.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/MC/ELFObjectWriter.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/ADT/StringMap.h"
17 #include "llvm/ADT/Twine.h"
18 #include "llvm/MC/MCAssembler.h"
19 #include "llvm/MC/MCAsmLayout.h"
20 #include "llvm/MC/MCContext.h"
21 #include "llvm/MC/MCELFSymbolFlags.h"
22 #include "llvm/MC/MCExpr.h"
23 #include "llvm/MC/MCObjectWriter.h"
24 #include "llvm/MC/MCSectionELF.h"
25 #include "llvm/MC/MCSymbol.h"
26 #include "llvm/MC/MCValue.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/ELF.h"
30 #include "llvm/Target/TargetAsmBackend.h"
32 #include "../Target/X86/X86FixupKinds.h"
37 static unsigned GetType(const MCSymbolData &SD) {
38 uint32_t Type = (SD.getFlags() & (0xf << ELF_STT_Shift)) >> ELF_STT_Shift;
39 assert(Type == ELF::STT_NOTYPE || Type == ELF::STT_OBJECT ||
40 Type == ELF::STT_FUNC || Type == ELF::STT_SECTION ||
41 Type == ELF::STT_FILE || Type == ELF::STT_COMMON ||
42 Type == ELF::STT_TLS);
46 static unsigned GetBinding(const MCSymbolData &SD) {
47 uint32_t Binding = (SD.getFlags() & (0xf << ELF_STB_Shift)) >> ELF_STB_Shift;
48 assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
49 Binding == ELF::STB_WEAK);
53 static void SetBinding(MCSymbolData &SD, unsigned Binding) {
54 assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
55 Binding == ELF::STB_WEAK);
56 uint32_t OtherFlags = SD.getFlags() & ~(0xf << ELF_STB_Shift);
57 SD.setFlags(OtherFlags | (Binding << ELF_STB_Shift));
60 static bool isFixupKindX86PCRel(unsigned Kind) {
64 case X86::reloc_pcrel_1byte:
65 case X86::reloc_pcrel_4byte:
66 case X86::reloc_riprel_4byte:
67 case X86::reloc_riprel_4byte_movq_load:
74 class ELFObjectWriterImpl {
75 /*static bool isFixupKindX86RIPRel(unsigned Kind) {
76 return Kind == X86::reloc_riprel_4byte ||
77 Kind == X86::reloc_riprel_4byte_movq_load;
81 /// ELFSymbolData - Helper struct for containing some precomputed information
83 struct ELFSymbolData {
84 MCSymbolData *SymbolData;
86 uint32_t SectionIndex;
88 // Support lexicographic sorting.
89 bool operator<(const ELFSymbolData &RHS) const {
90 if (GetType(*SymbolData) == ELF::STT_FILE)
92 if (GetType(*RHS.SymbolData) == ELF::STT_FILE)
94 return SymbolData->getSymbol().getName() <
95 RHS.SymbolData->getSymbol().getName();
99 /// @name Relocation Data
102 struct ELFRelocationEntry {
103 // Make these big enough for both 32-bit and 64-bit
108 // Support lexicographic sorting.
109 bool operator<(const ELFRelocationEntry &RE) const {
110 return RE.r_offset < r_offset;
114 llvm::DenseMap<const MCSectionData*,
115 std::vector<ELFRelocationEntry> > Relocations;
116 DenseMap<const MCSection*, uint64_t> SectionStringTableIndex;
119 /// @name Symbol Table Data
122 SmallString<256> StringTable;
123 std::vector<ELFSymbolData> LocalSymbolData;
124 std::vector<ELFSymbolData> ExternalSymbolData;
125 std::vector<ELFSymbolData> UndefinedSymbolData;
129 ELFObjectWriter *Writer;
133 unsigned Is64Bit : 1;
135 bool HasRelocationAddend;
137 Triple::OSType OSType;
139 // This holds the symbol table index of the last local symbol.
140 unsigned LastLocalSymbolIndex;
141 // This holds the .strtab section index.
142 unsigned StringTableIndex;
144 unsigned ShstrtabIndex;
147 ELFObjectWriterImpl(ELFObjectWriter *_Writer, bool _Is64Bit,
148 bool _HasRelAddend, Triple::OSType _OSType)
149 : Writer(_Writer), OS(Writer->getStream()),
150 Is64Bit(_Is64Bit), HasRelocationAddend(_HasRelAddend),
154 void Write8(uint8_t Value) { Writer->Write8(Value); }
155 void Write16(uint16_t Value) { Writer->Write16(Value); }
156 void Write32(uint32_t Value) { Writer->Write32(Value); }
157 //void Write64(uint64_t Value) { Writer->Write64(Value); }
158 void WriteZeros(unsigned N) { Writer->WriteZeros(N); }
159 //void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
160 // Writer->WriteBytes(Str, ZeroFillSize);
163 void WriteWord(uint64_t W) {
170 void String8(char *buf, uint8_t Value) {
174 void StringLE16(char *buf, uint16_t Value) {
175 buf[0] = char(Value >> 0);
176 buf[1] = char(Value >> 8);
179 void StringLE32(char *buf, uint32_t Value) {
180 StringLE16(buf, uint16_t(Value >> 0));
181 StringLE16(buf + 2, uint16_t(Value >> 16));
184 void StringLE64(char *buf, uint64_t Value) {
185 StringLE32(buf, uint32_t(Value >> 0));
186 StringLE32(buf + 4, uint32_t(Value >> 32));
189 void StringBE16(char *buf ,uint16_t Value) {
190 buf[0] = char(Value >> 8);
191 buf[1] = char(Value >> 0);
194 void StringBE32(char *buf, uint32_t Value) {
195 StringBE16(buf, uint16_t(Value >> 16));
196 StringBE16(buf + 2, uint16_t(Value >> 0));
199 void StringBE64(char *buf, uint64_t Value) {
200 StringBE32(buf, uint32_t(Value >> 32));
201 StringBE32(buf + 4, uint32_t(Value >> 0));
204 void String16(char *buf, uint16_t Value) {
205 if (Writer->isLittleEndian())
206 StringLE16(buf, Value);
208 StringBE16(buf, Value);
211 void String32(char *buf, uint32_t Value) {
212 if (Writer->isLittleEndian())
213 StringLE32(buf, Value);
215 StringBE32(buf, Value);
218 void String64(char *buf, uint64_t Value) {
219 if (Writer->isLittleEndian())
220 StringLE64(buf, Value);
222 StringBE64(buf, Value);
225 void WriteHeader(uint64_t SectionDataSize, unsigned NumberOfSections);
227 void WriteSymbolEntry(MCDataFragment *F, uint64_t name, uint8_t info,
228 uint64_t value, uint64_t size,
229 uint8_t other, uint16_t shndx);
231 void WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
232 const MCAsmLayout &Layout);
234 void WriteSymbolTable(MCDataFragment *F, const MCAssembler &Asm,
235 const MCAsmLayout &Layout,
236 unsigned NumRegularSections);
238 void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
239 const MCFragment *Fragment, const MCFixup &Fixup,
240 MCValue Target, uint64_t &FixedValue);
242 uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
245 /// ComputeSymbolTable - Compute the symbol table data
247 /// \param StringTable [out] - The string table data.
248 /// \param StringIndexMap [out] - Map from symbol names to offsets in the
250 void ComputeSymbolTable(MCAssembler &Asm);
252 void WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
253 const MCSectionData &SD);
255 void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout) {
256 for (MCAssembler::const_iterator it = Asm.begin(),
257 ie = Asm.end(); it != ie; ++it) {
258 WriteRelocation(Asm, Layout, *it);
262 void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout);
264 void ExecutePostLayoutBinding(MCAssembler &Asm) {
265 // Compute symbol table information.
266 ComputeSymbolTable(Asm);
269 void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
270 uint64_t Address, uint64_t Offset,
271 uint64_t Size, uint32_t Link, uint32_t Info,
272 uint64_t Alignment, uint64_t EntrySize);
274 void WriteRelocationsFragment(const MCAssembler &Asm, MCDataFragment *F,
275 const MCSectionData *SD);
277 bool IsFixupFullyResolved(const MCAssembler &Asm,
278 const MCValue Target,
280 const MCFragment *DF) const;
282 void WriteObject(const MCAssembler &Asm, const MCAsmLayout &Layout);
287 // Emit the ELF header.
288 void ELFObjectWriterImpl::WriteHeader(uint64_t SectionDataSize,
289 unsigned NumberOfSections) {
295 // emitWord method behaves differently for ELF32 and ELF64, writing
296 // 4 bytes in the former and 8 in the latter.
298 Write8(0x7f); // e_ident[EI_MAG0]
299 Write8('E'); // e_ident[EI_MAG1]
300 Write8('L'); // e_ident[EI_MAG2]
301 Write8('F'); // e_ident[EI_MAG3]
303 Write8(Is64Bit ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
306 Write8(Writer->isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
308 Write8(ELF::EV_CURRENT); // e_ident[EI_VERSION]
311 case Triple::FreeBSD: Write8(ELF::ELFOSABI_FREEBSD); break;
312 case Triple::Linux: Write8(ELF::ELFOSABI_LINUX); break;
313 default: Write8(ELF::ELFOSABI_NONE); break;
315 Write8(0); // e_ident[EI_ABIVERSION]
317 WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
319 Write16(ELF::ET_REL); // e_type
321 // FIXME: Make this configurable
322 Write16(Is64Bit ? ELF::EM_X86_64 : ELF::EM_386); // e_machine = target
324 Write32(ELF::EV_CURRENT); // e_version
325 WriteWord(0); // e_entry, no entry point in .o file
326 WriteWord(0); // e_phoff, no program header for .o
327 WriteWord(SectionDataSize + (Is64Bit ? sizeof(ELF::Elf64_Ehdr) :
328 sizeof(ELF::Elf32_Ehdr))); // e_shoff = sec hdr table off in bytes
330 // FIXME: Make this configurable.
331 Write32(0); // e_flags = whatever the target wants
333 // e_ehsize = ELF header size
334 Write16(Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
336 Write16(0); // e_phentsize = prog header entry size
337 Write16(0); // e_phnum = # prog header entries = 0
339 // e_shentsize = Section header entry size
340 Write16(Is64Bit ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
342 // e_shnum = # of section header ents
343 Write16(NumberOfSections);
345 // e_shstrndx = Section # of '.shstrtab'
346 Write16(ShstrtabIndex);
349 void ELFObjectWriterImpl::WriteSymbolEntry(MCDataFragment *F, uint64_t name,
350 uint8_t info, uint64_t value,
351 uint64_t size, uint8_t other,
357 F->getContents() += StringRef(buf, 4); // st_name
360 F->getContents() += StringRef(buf, 1); // st_info
363 F->getContents() += StringRef(buf, 1); // st_other
365 String16(buf, shndx);
366 F->getContents() += StringRef(buf, 2); // st_shndx
368 String64(buf, value);
369 F->getContents() += StringRef(buf, 8); // st_value
372 F->getContents() += StringRef(buf, 8); // st_size
377 F->getContents() += StringRef(buf, 4); // st_name
379 String32(buf, value);
380 F->getContents() += StringRef(buf, 4); // st_value
383 F->getContents() += StringRef(buf, 4); // st_size
386 F->getContents() += StringRef(buf, 1); // st_info
389 F->getContents() += StringRef(buf, 1); // st_other
391 String16(buf, shndx);
392 F->getContents() += StringRef(buf, 2); // st_shndx
396 static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout) {
397 if (Data.isCommon() && Data.isExternal())
398 return Data.getCommonAlignment();
400 const MCSymbol &Symbol = Data.getSymbol();
401 if (!Symbol.isInSection())
404 if (!Data.isCommon() && !(Data.getFlags() & ELF_STB_Weak))
405 if (MCFragment *FF = Data.getFragment())
406 return Layout.getSymbolAddress(&Data) -
407 Layout.getSectionAddress(FF->getParent());
412 void ELFObjectWriterImpl::WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
413 const MCAsmLayout &Layout) {
414 MCSymbolData &Data = *MSD.SymbolData;
415 uint8_t Info = (Data.getFlags() & 0xff);
416 uint8_t Other = ((Data.getFlags() & 0xf00) >> ELF_STV_Shift);
417 uint64_t Value = SymbolValue(Data, Layout);
421 assert(!(Data.isCommon() && !Data.isExternal()));
423 ESize = Data.getSize();
424 if (Data.getSize()) {
426 if (ESize->getKind() == MCExpr::Binary) {
427 const MCBinaryExpr *BE = static_cast<const MCBinaryExpr *>(ESize);
429 if (BE->EvaluateAsRelocatable(Res, &Layout)) {
431 Layout.getAssembler().getSymbolData(Res.getSymA()->getSymbol());
433 Layout.getAssembler().getSymbolData(Res.getSymB()->getSymbol());
435 Size = Layout.getSymbolAddress(&A) - Layout.getSymbolAddress(&B);
437 } else if (ESize->getKind() == MCExpr::Constant) {
438 Size = static_cast<const MCConstantExpr *>(ESize)->getValue();
440 assert(0 && "Unsupported size expression");
444 // Write out the symbol table entry
445 WriteSymbolEntry(F, MSD.StringIndex, Info, Value,
446 Size, Other, MSD.SectionIndex);
449 void ELFObjectWriterImpl::WriteSymbolTable(MCDataFragment *F,
450 const MCAssembler &Asm,
451 const MCAsmLayout &Layout,
452 unsigned NumRegularSections) {
453 // The string table must be emitted first because we need the index
454 // into the string table for all the symbol names.
455 assert(StringTable.size() && "Missing string table");
457 // FIXME: Make sure the start of the symbol table is aligned.
459 // The first entry is the undefined symbol entry.
460 unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
461 F->getContents().append(EntrySize, '\x00');
463 // Write the symbol table entries.
464 LastLocalSymbolIndex = LocalSymbolData.size() + 1;
465 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
466 ELFSymbolData &MSD = LocalSymbolData[i];
467 WriteSymbol(F, MSD, Layout);
470 // Write out a symbol table entry for each regular section.
472 for (MCAssembler::const_iterator it = Asm.begin();
473 Index <= NumRegularSections; ++it, ++Index) {
474 const MCSectionELF &Section =
475 static_cast<const MCSectionELF&>(it->getSection());
476 // Leave out relocations so we don't have indexes within
477 // the relocations messed up
478 if (Section.getType() == ELF::SHT_RELA || Section.getType() == ELF::SHT_REL)
480 WriteSymbolEntry(F, 0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT, Index);
481 LastLocalSymbolIndex++;
484 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
485 ELFSymbolData &MSD = ExternalSymbolData[i];
486 MCSymbolData &Data = *MSD.SymbolData;
487 assert((Data.getFlags() & ELF_STB_Global) &&
488 "External symbol requires STB_GLOBAL flag");
489 WriteSymbol(F, MSD, Layout);
490 if (GetBinding(Data) == ELF::STB_LOCAL)
491 LastLocalSymbolIndex++;
494 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
495 ELFSymbolData &MSD = UndefinedSymbolData[i];
496 MCSymbolData &Data = *MSD.SymbolData;
497 WriteSymbol(F, MSD, Layout);
498 if (GetBinding(Data) == ELF::STB_LOCAL)
499 LastLocalSymbolIndex++;
503 static bool ShouldRelocOnSymbol(const MCSymbolData &SD,
504 const MCValue &Target) {
505 const MCSymbol &Symbol = SD.getSymbol();
506 if (Symbol.isUndefined())
509 const MCSectionELF &Section =
510 static_cast<const MCSectionELF&>(Symbol.getSection());
512 if (Section.getFlags() & MCSectionELF::SHF_MERGE)
513 return Target.getConstant() != 0;
521 // FIXME: this is currently X86/X86_64 only
522 void ELFObjectWriterImpl::RecordRelocation(const MCAssembler &Asm,
523 const MCAsmLayout &Layout,
524 const MCFragment *Fragment,
525 const MCFixup &Fixup,
527 uint64_t &FixedValue) {
530 int64_t Value = Target.getConstant();
532 bool IsPCRel = isFixupKindX86PCRel(Fixup.getKind());
533 if (!Target.isAbsolute()) {
534 const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
535 MCSymbolData &SD = Asm.getSymbolData(*Symbol);
536 MCFragment *F = SD.getFragment();
538 if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
539 const MCSymbol &SymbolB = RefB->getSymbol();
540 MCSymbolData &SDB = Asm.getSymbolData(SymbolB);
542 MCSectionData *Sec = Fragment->getParent();
544 // Offset of the symbol in the section
545 int64_t a = Layout.getSymbolAddress(&SDB) - Layout.getSectionAddress(Sec);
547 // Ofeset of the relocation in the section
548 int64_t b = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
552 // Check that this case has already been fully resolved before we get
554 if (Symbol->isDefined() && !SD.isExternal() &&
556 &Fragment->getParent()->getSection() == &Symbol->getSection()) {
557 llvm_unreachable("We don't need a relocation in this case.");
561 bool RelocOnSymbol = ShouldRelocOnSymbol(SD, Target);
562 if (!RelocOnSymbol) {
563 Index = F->getParent()->getOrdinal() + LocalSymbolData.size() + 1;
565 MCSectionData *FSD = F->getParent();
566 // Offset of the symbol in the section
567 Value += Layout.getSymbolAddress(&SD) - Layout.getSectionAddress(FSD);
569 Index = getSymbolIndexInSymbolTable(Asm, Symbol);
571 // Compensate for the addend on i386.
578 // determine the type of the relocation
580 MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
585 case MCSymbolRefExpr::VK_None:
586 Type = ELF::R_X86_64_PC32;
588 case MCSymbolRefExpr::VK_PLT:
589 Type = ELF::R_X86_64_PLT32;
592 llvm_unreachable("Unimplemented");
595 switch ((unsigned)Fixup.getKind()) {
596 default: llvm_unreachable("invalid fixup kind!");
597 case FK_Data_8: Type = ELF::R_X86_64_64; break;
598 case X86::reloc_signed_4byte:
599 case X86::reloc_pcrel_4byte:
600 assert(isInt<32>(Target.getConstant()));
602 case MCSymbolRefExpr::VK_None:
603 Type = ELF::R_X86_64_32S;
605 case MCSymbolRefExpr::VK_GOT:
606 Type = ELF::R_X86_64_GOT32;
609 llvm_unreachable("Unimplemented");
613 Type = ELF::R_X86_64_32;
615 case FK_Data_2: Type = ELF::R_X86_64_16; break;
616 case X86::reloc_pcrel_1byte:
617 case FK_Data_1: Type = ELF::R_X86_64_8; break;
622 Type = ELF::R_386_PC32;
624 switch ((unsigned)Fixup.getKind()) {
625 default: llvm_unreachable("invalid fixup kind!");
627 // FIXME: Should we avoid selecting reloc_signed_4byte in 32 bit mode
629 case X86::reloc_signed_4byte:
630 case X86::reloc_pcrel_4byte:
631 case FK_Data_4: Type = ELF::R_386_32; break;
632 case FK_Data_2: Type = ELF::R_386_16; break;
633 case X86::reloc_pcrel_1byte:
634 case FK_Data_1: Type = ELF::R_386_8; break;
639 ELFRelocationEntry ERE;
642 struct ELF::Elf64_Rela ERE64;
643 ERE64.setSymbolAndType(Index, Type);
644 ERE.r_info = ERE64.r_info;
646 struct ELF::Elf32_Rela ERE32;
647 ERE32.setSymbolAndType(Index, Type);
648 ERE.r_info = ERE32.r_info;
651 ERE.r_offset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
653 if (HasRelocationAddend)
654 ERE.r_addend = Addend;
656 ERE.r_addend = 0; // Silence compiler warning.
658 Relocations[Fragment->getParent()].push_back(ERE);
662 ELFObjectWriterImpl::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
664 MCSymbolData &SD = Asm.getSymbolData(*S);
667 if (!SD.isExternal() && !S->isUndefined())
668 return SD.getIndex() + /* empty symbol */ 1;
670 // External or undefined symbol.
671 return SD.getIndex() + Asm.size() + /* empty symbol */ 1;
674 void ELFObjectWriterImpl::ComputeSymbolTable(MCAssembler &Asm) {
675 // Build section lookup table.
676 DenseMap<const MCSection*, uint8_t> SectionIndexMap;
678 for (MCAssembler::iterator it = Asm.begin(),
679 ie = Asm.end(); it != ie; ++it, ++Index)
680 SectionIndexMap[&it->getSection()] = Index;
682 // Index 0 is always the empty string.
683 StringMap<uint64_t> StringIndexMap;
684 StringTable += '\x00';
686 // Add the data for local symbols.
687 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
688 ie = Asm.symbol_end(); it != ie; ++it) {
689 const MCSymbol &Symbol = it->getSymbol();
691 // Ignore non-linker visible symbols.
692 if (!Asm.isSymbolLinkerVisible(Symbol))
695 if (it->isExternal() || Symbol.isUndefined())
698 uint64_t &Entry = StringIndexMap[Symbol.getName()];
700 Entry = StringTable.size();
701 StringTable += Symbol.getName();
702 StringTable += '\x00';
707 MSD.StringIndex = Entry;
709 if (Symbol.isAbsolute()) {
710 MSD.SectionIndex = ELF::SHN_ABS;
711 LocalSymbolData.push_back(MSD);
713 MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
714 assert(MSD.SectionIndex && "Invalid section index!");
715 LocalSymbolData.push_back(MSD);
719 // Now add non-local symbols.
720 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
721 ie = Asm.symbol_end(); it != ie; ++it) {
722 const MCSymbol &Symbol = it->getSymbol();
724 // Ignore non-linker visible symbols.
725 if (!Asm.isSymbolLinkerVisible(Symbol) && !Symbol.isUndefined())
728 if (!it->isExternal() && !Symbol.isUndefined())
731 if (Symbol.isVariable())
734 uint64_t &Entry = StringIndexMap[Symbol.getName()];
736 Entry = StringTable.size();
737 StringTable += Symbol.getName();
738 StringTable += '\x00';
743 MSD.StringIndex = Entry;
745 if (it->isCommon()) {
746 MSD.SectionIndex = ELF::SHN_COMMON;
747 ExternalSymbolData.push_back(MSD);
748 } else if (Symbol.isUndefined()) {
749 MSD.SectionIndex = ELF::SHN_UNDEF;
750 // FIXME: Undefined symbols are global, but this is the first place we
751 // are able to set it.
752 if (GetBinding(*it) == ELF::STB_LOCAL)
753 SetBinding(*it, ELF::STB_GLOBAL);
754 UndefinedSymbolData.push_back(MSD);
755 } else if (Symbol.isAbsolute()) {
756 MSD.SectionIndex = ELF::SHN_ABS;
757 ExternalSymbolData.push_back(MSD);
759 MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
760 assert(MSD.SectionIndex && "Invalid section index!");
761 ExternalSymbolData.push_back(MSD);
765 // Symbols are required to be in lexicographic order.
766 array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
767 array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
768 array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
770 // Set the symbol indices. Local symbols must come before all other
771 // symbols with non-local bindings.
773 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
774 LocalSymbolData[i].SymbolData->setIndex(Index++);
775 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
776 ExternalSymbolData[i].SymbolData->setIndex(Index++);
777 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
778 UndefinedSymbolData[i].SymbolData->setIndex(Index++);
781 void ELFObjectWriterImpl::WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
782 const MCSectionData &SD) {
783 if (!Relocations[&SD].empty()) {
784 MCContext &Ctx = Asm.getContext();
785 const MCSection *RelaSection;
786 const MCSectionELF &Section =
787 static_cast<const MCSectionELF&>(SD.getSection());
789 const StringRef SectionName = Section.getSectionName();
790 std::string RelaSectionName = HasRelocationAddend ? ".rela" : ".rel";
791 RelaSectionName += SectionName;
794 if (HasRelocationAddend)
795 EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
797 EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
799 RelaSection = Ctx.getELFSection(RelaSectionName, HasRelocationAddend ?
800 ELF::SHT_RELA : ELF::SHT_REL, 0,
801 SectionKind::getReadOnly(),
804 MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
805 RelaSD.setAlignment(Is64Bit ? 8 : 4);
807 MCDataFragment *F = new MCDataFragment(&RelaSD);
809 WriteRelocationsFragment(Asm, F, &SD);
811 Asm.AddSectionToTheEnd(*Writer, RelaSD, Layout);
815 void ELFObjectWriterImpl::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
816 uint64_t Flags, uint64_t Address,
817 uint64_t Offset, uint64_t Size,
818 uint32_t Link, uint32_t Info,
820 uint64_t EntrySize) {
821 Write32(Name); // sh_name: index into string table
822 Write32(Type); // sh_type
823 WriteWord(Flags); // sh_flags
824 WriteWord(Address); // sh_addr
825 WriteWord(Offset); // sh_offset
826 WriteWord(Size); // sh_size
827 Write32(Link); // sh_link
828 Write32(Info); // sh_info
829 WriteWord(Alignment); // sh_addralign
830 WriteWord(EntrySize); // sh_entsize
833 void ELFObjectWriterImpl::WriteRelocationsFragment(const MCAssembler &Asm,
835 const MCSectionData *SD) {
836 std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
837 // sort by the r_offset just like gnu as does
838 array_pod_sort(Relocs.begin(), Relocs.end());
840 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
841 ELFRelocationEntry entry = Relocs[e - i - 1];
846 String64(buf, entry.r_offset);
847 F->getContents() += StringRef(buf, 8);
849 String64(buf, entry.r_info);
850 F->getContents() += StringRef(buf, 8);
852 if (HasRelocationAddend) {
853 String64(buf, entry.r_addend);
854 F->getContents() += StringRef(buf, 8);
859 String32(buf, entry.r_offset);
860 F->getContents() += StringRef(buf, 4);
862 String32(buf, entry.r_info);
863 F->getContents() += StringRef(buf, 4);
865 if (HasRelocationAddend) {
866 String32(buf, entry.r_addend);
867 F->getContents() += StringRef(buf, 4);
873 void ELFObjectWriterImpl::CreateMetadataSections(MCAssembler &Asm,
874 MCAsmLayout &Layout) {
875 MCContext &Ctx = Asm.getContext();
878 const MCSection *SymtabSection;
879 unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
881 unsigned NumRegularSections = Asm.size();
883 // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
884 const MCSection *ShstrtabSection;
885 ShstrtabSection = Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
886 SectionKind::getReadOnly(), false);
887 MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
888 ShstrtabSD.setAlignment(1);
889 ShstrtabIndex = Asm.size();
891 SymtabSection = Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
892 SectionKind::getReadOnly(),
894 MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
895 SymtabSD.setAlignment(Is64Bit ? 8 : 4);
897 const MCSection *StrtabSection;
898 StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
899 SectionKind::getReadOnly(), false);
900 MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
901 StrtabSD.setAlignment(1);
902 StringTableIndex = Asm.size();
904 WriteRelocations(Asm, Layout);
907 F = new MCDataFragment(&SymtabSD);
908 WriteSymbolTable(F, Asm, Layout, NumRegularSections);
909 Asm.AddSectionToTheEnd(*Writer, SymtabSD, Layout);
911 F = new MCDataFragment(&StrtabSD);
912 F->getContents().append(StringTable.begin(), StringTable.end());
913 Asm.AddSectionToTheEnd(*Writer, StrtabSD, Layout);
915 F = new MCDataFragment(&ShstrtabSD);
917 // Section header string table.
919 // The first entry of a string table holds a null character so skip
922 F->getContents() += '\x00';
924 for (MCAssembler::const_iterator it = Asm.begin(),
925 ie = Asm.end(); it != ie; ++it) {
926 const MCSectionELF &Section =
927 static_cast<const MCSectionELF&>(it->getSection());
928 // FIXME: We could merge suffixes like in .text and .rela.text.
930 // Remember the index into the string table so we can write it
931 // into the sh_name field of the section header table.
932 SectionStringTableIndex[&it->getSection()] = Index;
934 Index += Section.getSectionName().size() + 1;
935 F->getContents() += Section.getSectionName();
936 F->getContents() += '\x00';
939 Asm.AddSectionToTheEnd(*Writer, ShstrtabSD, Layout);
942 bool ELFObjectWriterImpl::IsFixupFullyResolved(const MCAssembler &Asm,
943 const MCValue Target,
945 const MCFragment *DF) const {
946 // If this is a PCrel relocation, find the section this fixup value is
948 const MCSection *BaseSection = 0;
950 BaseSection = &DF->getParent()->getSection();
954 const MCSection *SectionA = 0;
955 const MCSymbol *SymbolA = 0;
956 if (const MCSymbolRefExpr *A = Target.getSymA()) {
957 SymbolA = &A->getSymbol();
958 SectionA = &SymbolA->getSection();
961 const MCSection *SectionB = 0;
962 if (const MCSymbolRefExpr *B = Target.getSymB()) {
963 SectionB = &B->getSymbol().getSection();
967 return SectionA == SectionB;
969 const MCSymbolData &DataA = Asm.getSymbolData(*SymbolA);
970 if (DataA.isExternal())
973 return !SectionB && BaseSection == SectionA;
976 void ELFObjectWriterImpl::WriteObject(const MCAssembler &Asm,
977 const MCAsmLayout &Layout) {
978 CreateMetadataSections(const_cast<MCAssembler&>(Asm),
979 const_cast<MCAsmLayout&>(Layout));
981 // Add 1 for the null section.
982 unsigned NumSections = Asm.size() + 1;
983 uint64_t NaturalAlignment = Is64Bit ? 8 : 4;
984 uint64_t HeaderSize = Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr);
985 uint64_t FileOff = HeaderSize;
987 for (MCAssembler::const_iterator it = Asm.begin(),
988 ie = Asm.end(); it != ie; ++it) {
989 const MCSectionData &SD = *it;
991 FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
993 // Get the size of the section in the output file (including padding).
994 uint64_t Size = Layout.getSectionFileSize(&SD);
999 FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
1001 // Write out the ELF header ...
1002 WriteHeader(FileOff - HeaderSize, NumSections);
1004 FileOff = HeaderSize;
1006 // ... then all of the sections ...
1007 DenseMap<const MCSection*, uint64_t> SectionOffsetMap;
1009 DenseMap<const MCSection*, uint8_t> SectionIndexMap;
1012 for (MCAssembler::const_iterator it = Asm.begin(),
1013 ie = Asm.end(); it != ie; ++it) {
1014 const MCSectionData &SD = *it;
1016 uint64_t Padding = OffsetToAlignment(FileOff, SD.getAlignment());
1017 WriteZeros(Padding);
1020 // Remember the offset into the file for this section.
1021 SectionOffsetMap[&it->getSection()] = FileOff;
1022 SectionIndexMap[&it->getSection()] = Index++;
1024 FileOff += Layout.getSectionFileSize(&SD);
1026 Asm.WriteSectionData(it, Layout, Writer);
1029 uint64_t Padding = OffsetToAlignment(FileOff, NaturalAlignment);
1030 WriteZeros(Padding);
1033 // ... and then the section header table.
1034 // Should we align the section header table?
1036 // Null section first.
1037 WriteSecHdrEntry(0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
1039 for (MCAssembler::const_iterator it = Asm.begin(),
1040 ie = Asm.end(); it != ie; ++it) {
1041 const MCSectionData &SD = *it;
1042 const MCSectionELF &Section =
1043 static_cast<const MCSectionELF&>(SD.getSection());
1045 uint64_t sh_link = 0;
1046 uint64_t sh_info = 0;
1048 switch(Section.getType()) {
1049 case ELF::SHT_DYNAMIC:
1050 sh_link = SectionStringTableIndex[&it->getSection()];
1055 case ELF::SHT_RELA: {
1056 const MCSection *SymtabSection;
1057 const MCSection *InfoSection;
1059 SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1060 SectionKind::getReadOnly(),
1062 sh_link = SectionIndexMap[SymtabSection];
1064 // Remove ".rel" and ".rela" prefixes.
1065 unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1066 StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1068 InfoSection = Asm.getContext().getELFSection(SectionName,
1069 ELF::SHT_PROGBITS, 0,
1070 SectionKind::getReadOnly(),
1072 sh_info = SectionIndexMap[InfoSection];
1076 case ELF::SHT_SYMTAB:
1077 case ELF::SHT_DYNSYM:
1078 sh_link = StringTableIndex;
1079 sh_info = LastLocalSymbolIndex;
1082 case ELF::SHT_PROGBITS:
1083 case ELF::SHT_STRTAB:
1084 case ELF::SHT_NOBITS:
1090 case ELF::SHT_GROUP:
1091 case ELF::SHT_SYMTAB_SHNDX:
1093 assert(0 && "FIXME: sh_type value not supported!");
1097 WriteSecHdrEntry(SectionStringTableIndex[&it->getSection()],
1098 Section.getType(), Section.getFlags(),
1100 SectionOffsetMap.lookup(&SD.getSection()),
1101 Layout.getSectionSize(&SD), sh_link,
1102 sh_info, SD.getAlignment(),
1103 Section.getEntrySize());
1107 ELFObjectWriter::ELFObjectWriter(raw_ostream &OS,
1109 Triple::OSType OSType,
1110 bool IsLittleEndian,
1111 bool HasRelocationAddend)
1112 : MCObjectWriter(OS, IsLittleEndian)
1114 Impl = new ELFObjectWriterImpl(this, Is64Bit, HasRelocationAddend, OSType);
1117 ELFObjectWriter::~ELFObjectWriter() {
1118 delete (ELFObjectWriterImpl*) Impl;
1121 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm) {
1122 ((ELFObjectWriterImpl*) Impl)->ExecutePostLayoutBinding(Asm);
1125 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
1126 const MCAsmLayout &Layout,
1127 const MCFragment *Fragment,
1128 const MCFixup &Fixup, MCValue Target,
1129 uint64_t &FixedValue) {
1130 ((ELFObjectWriterImpl*) Impl)->RecordRelocation(Asm, Layout, Fragment, Fixup,
1131 Target, FixedValue);
1134 bool ELFObjectWriter::IsFixupFullyResolved(const MCAssembler &Asm,
1135 const MCValue Target,
1137 const MCFragment *DF) const {
1138 return ((ELFObjectWriterImpl*) Impl)->IsFixupFullyResolved(Asm, Target,
1142 void ELFObjectWriter::WriteObject(const MCAssembler &Asm,
1143 const MCAsmLayout &Layout) {
1144 ((ELFObjectWriterImpl*) Impl)->WriteObject(Asm, Layout);