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/SmallPtrSet.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/StringMap.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/MC/MCAssembler.h"
20 #include "llvm/MC/MCAsmLayout.h"
21 #include "llvm/MC/MCContext.h"
22 #include "llvm/MC/MCELFSymbolFlags.h"
23 #include "llvm/MC/MCExpr.h"
24 #include "llvm/MC/MCObjectWriter.h"
25 #include "llvm/MC/MCSectionELF.h"
26 #include "llvm/MC/MCSymbol.h"
27 #include "llvm/MC/MCValue.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/ELF.h"
31 #include "llvm/Target/TargetAsmBackend.h"
33 #include "../Target/X86/X86FixupKinds.h"
38 static unsigned GetType(const MCSymbolData &SD) {
39 uint32_t Type = (SD.getFlags() & (0xf << ELF_STT_Shift)) >> ELF_STT_Shift;
40 assert(Type == ELF::STT_NOTYPE || Type == ELF::STT_OBJECT ||
41 Type == ELF::STT_FUNC || Type == ELF::STT_SECTION ||
42 Type == ELF::STT_FILE || Type == ELF::STT_COMMON ||
43 Type == ELF::STT_TLS);
47 static unsigned GetBinding(const MCSymbolData &SD) {
48 uint32_t Binding = (SD.getFlags() & (0xf << ELF_STB_Shift)) >> ELF_STB_Shift;
49 assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
50 Binding == ELF::STB_WEAK);
54 static void SetBinding(MCSymbolData &SD, unsigned Binding) {
55 assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
56 Binding == ELF::STB_WEAK);
57 uint32_t OtherFlags = SD.getFlags() & ~(0xf << ELF_STB_Shift);
58 SD.setFlags(OtherFlags | (Binding << ELF_STB_Shift));
61 static unsigned GetVisibility(MCSymbolData &SD) {
63 (SD.getFlags() & (0xf << ELF_STV_Shift)) >> ELF_STV_Shift;
64 assert(Visibility == ELF::STV_DEFAULT || Visibility == ELF::STV_INTERNAL ||
65 Visibility == ELF::STV_HIDDEN || Visibility == ELF::STV_PROTECTED);
69 static bool isFixupKindX86PCRel(unsigned Kind) {
73 case X86::reloc_pcrel_1byte:
74 case X86::reloc_pcrel_4byte:
75 case X86::reloc_riprel_4byte:
76 case X86::reloc_riprel_4byte_movq_load:
81 static bool RelocNeedsGOT(unsigned Type) {
85 case ELF::R_X86_64_GOT32:
86 case ELF::R_X86_64_PLT32:
87 case ELF::R_X86_64_GOTPCREL:
94 class ELFObjectWriterImpl {
95 /*static bool isFixupKindX86RIPRel(unsigned Kind) {
96 return Kind == X86::reloc_riprel_4byte ||
97 Kind == X86::reloc_riprel_4byte_movq_load;
101 /// ELFSymbolData - Helper struct for containing some precomputed information
103 struct ELFSymbolData {
104 MCSymbolData *SymbolData;
105 uint64_t StringIndex;
106 uint32_t SectionIndex;
108 // Support lexicographic sorting.
109 bool operator<(const ELFSymbolData &RHS) const {
110 if (GetType(*SymbolData) == ELF::STT_FILE)
112 if (GetType(*RHS.SymbolData) == ELF::STT_FILE)
114 return SymbolData->getSymbol().getName() <
115 RHS.SymbolData->getSymbol().getName();
119 /// @name Relocation Data
122 struct ELFRelocationEntry {
123 // Make these big enough for both 32-bit and 64-bit
127 const MCSymbol *Symbol;
130 // Support lexicographic sorting.
131 bool operator<(const ELFRelocationEntry &RE) const {
132 return RE.r_offset < r_offset;
136 SmallPtrSet<const MCSymbol *, 16> UsedInReloc;
138 llvm::DenseMap<const MCSectionData*,
139 std::vector<ELFRelocationEntry> > Relocations;
140 DenseMap<const MCSection*, uint64_t> SectionStringTableIndex;
143 /// @name Symbol Table Data
146 SmallString<256> StringTable;
147 std::vector<ELFSymbolData> LocalSymbolData;
148 std::vector<ELFSymbolData> ExternalSymbolData;
149 std::vector<ELFSymbolData> UndefinedSymbolData;
153 int NumRegularSections;
157 ELFObjectWriter *Writer;
161 unsigned Is64Bit : 1;
163 bool HasRelocationAddend;
165 Triple::OSType OSType;
169 // This holds the symbol table index of the last local symbol.
170 unsigned LastLocalSymbolIndex;
171 // This holds the .strtab section index.
172 unsigned StringTableIndex;
174 unsigned ShstrtabIndex;
177 ELFObjectWriterImpl(ELFObjectWriter *_Writer, bool _Is64Bit,
178 uint16_t _EMachine, bool _HasRelAddend,
179 Triple::OSType _OSType)
180 : NeedsGOT(false), Writer(_Writer), OS(Writer->getStream()),
181 Is64Bit(_Is64Bit), HasRelocationAddend(_HasRelAddend),
182 OSType(_OSType), EMachine(_EMachine) {
185 void Write8(uint8_t Value) { Writer->Write8(Value); }
186 void Write16(uint16_t Value) { Writer->Write16(Value); }
187 void Write32(uint32_t Value) { Writer->Write32(Value); }
188 //void Write64(uint64_t Value) { Writer->Write64(Value); }
189 void WriteZeros(unsigned N) { Writer->WriteZeros(N); }
190 //void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
191 // Writer->WriteBytes(Str, ZeroFillSize);
194 void WriteWord(uint64_t W) {
201 void String8(char *buf, uint8_t Value) {
205 void StringLE16(char *buf, uint16_t Value) {
206 buf[0] = char(Value >> 0);
207 buf[1] = char(Value >> 8);
210 void StringLE32(char *buf, uint32_t Value) {
211 StringLE16(buf, uint16_t(Value >> 0));
212 StringLE16(buf + 2, uint16_t(Value >> 16));
215 void StringLE64(char *buf, uint64_t Value) {
216 StringLE32(buf, uint32_t(Value >> 0));
217 StringLE32(buf + 4, uint32_t(Value >> 32));
220 void StringBE16(char *buf ,uint16_t Value) {
221 buf[0] = char(Value >> 8);
222 buf[1] = char(Value >> 0);
225 void StringBE32(char *buf, uint32_t Value) {
226 StringBE16(buf, uint16_t(Value >> 16));
227 StringBE16(buf + 2, uint16_t(Value >> 0));
230 void StringBE64(char *buf, uint64_t Value) {
231 StringBE32(buf, uint32_t(Value >> 32));
232 StringBE32(buf + 4, uint32_t(Value >> 0));
235 void String16(char *buf, uint16_t Value) {
236 if (Writer->isLittleEndian())
237 StringLE16(buf, Value);
239 StringBE16(buf, Value);
242 void String32(char *buf, uint32_t Value) {
243 if (Writer->isLittleEndian())
244 StringLE32(buf, Value);
246 StringBE32(buf, Value);
249 void String64(char *buf, uint64_t Value) {
250 if (Writer->isLittleEndian())
251 StringLE64(buf, Value);
253 StringBE64(buf, Value);
256 void WriteHeader(uint64_t SectionDataSize, unsigned NumberOfSections);
258 void WriteSymbolEntry(MCDataFragment *F, uint64_t name, uint8_t info,
259 uint64_t value, uint64_t size,
260 uint8_t other, uint16_t shndx);
262 void WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
263 const MCAsmLayout &Layout);
265 void WriteSymbolTable(MCDataFragment *F, const MCAssembler &Asm,
266 const MCAsmLayout &Layout,
267 unsigned NumRegularSections);
269 void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
270 const MCFragment *Fragment, const MCFixup &Fixup,
271 MCValue Target, uint64_t &FixedValue);
273 uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
276 /// ComputeSymbolTable - Compute the symbol table data
278 /// \param StringTable [out] - The string table data.
279 /// \param StringIndexMap [out] - Map from symbol names to offsets in the
281 void ComputeSymbolTable(MCAssembler &Asm);
283 void WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
284 const MCSectionData &SD);
286 void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout) {
287 for (MCAssembler::const_iterator it = Asm.begin(),
288 ie = Asm.end(); it != ie; ++it) {
289 WriteRelocation(Asm, Layout, *it);
293 void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout);
295 void ExecutePostLayoutBinding(MCAssembler &Asm) {
298 void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
299 uint64_t Address, uint64_t Offset,
300 uint64_t Size, uint32_t Link, uint32_t Info,
301 uint64_t Alignment, uint64_t EntrySize);
303 void WriteRelocationsFragment(const MCAssembler &Asm, MCDataFragment *F,
304 const MCSectionData *SD);
306 bool IsFixupFullyResolved(const MCAssembler &Asm,
307 const MCValue Target,
309 const MCFragment *DF) const;
311 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout);
316 // Emit the ELF header.
317 void ELFObjectWriterImpl::WriteHeader(uint64_t SectionDataSize,
318 unsigned NumberOfSections) {
324 // emitWord method behaves differently for ELF32 and ELF64, writing
325 // 4 bytes in the former and 8 in the latter.
327 Write8(0x7f); // e_ident[EI_MAG0]
328 Write8('E'); // e_ident[EI_MAG1]
329 Write8('L'); // e_ident[EI_MAG2]
330 Write8('F'); // e_ident[EI_MAG3]
332 Write8(Is64Bit ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
335 Write8(Writer->isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
337 Write8(ELF::EV_CURRENT); // e_ident[EI_VERSION]
340 case Triple::FreeBSD: Write8(ELF::ELFOSABI_FREEBSD); break;
341 case Triple::Linux: Write8(ELF::ELFOSABI_LINUX); break;
342 default: Write8(ELF::ELFOSABI_NONE); break;
344 Write8(0); // e_ident[EI_ABIVERSION]
346 WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
348 Write16(ELF::ET_REL); // e_type
350 Write16(EMachine); // e_machine = target
352 Write32(ELF::EV_CURRENT); // e_version
353 WriteWord(0); // e_entry, no entry point in .o file
354 WriteWord(0); // e_phoff, no program header for .o
355 WriteWord(SectionDataSize + (Is64Bit ? sizeof(ELF::Elf64_Ehdr) :
356 sizeof(ELF::Elf32_Ehdr))); // e_shoff = sec hdr table off in bytes
358 // FIXME: Make this configurable.
359 Write32(0); // e_flags = whatever the target wants
361 // e_ehsize = ELF header size
362 Write16(Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
364 Write16(0); // e_phentsize = prog header entry size
365 Write16(0); // e_phnum = # prog header entries = 0
367 // e_shentsize = Section header entry size
368 Write16(Is64Bit ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
370 // e_shnum = # of section header ents
371 Write16(NumberOfSections);
373 // e_shstrndx = Section # of '.shstrtab'
374 Write16(ShstrtabIndex);
377 void ELFObjectWriterImpl::WriteSymbolEntry(MCDataFragment *F, uint64_t name,
378 uint8_t info, uint64_t value,
379 uint64_t size, uint8_t other,
385 F->getContents() += StringRef(buf, 4); // st_name
388 F->getContents() += StringRef(buf, 1); // st_info
391 F->getContents() += StringRef(buf, 1); // st_other
393 String16(buf, shndx);
394 F->getContents() += StringRef(buf, 2); // st_shndx
396 String64(buf, value);
397 F->getContents() += StringRef(buf, 8); // st_value
400 F->getContents() += StringRef(buf, 8); // st_size
405 F->getContents() += StringRef(buf, 4); // st_name
407 String32(buf, value);
408 F->getContents() += StringRef(buf, 4); // st_value
411 F->getContents() += StringRef(buf, 4); // st_size
414 F->getContents() += StringRef(buf, 1); // st_info
417 F->getContents() += StringRef(buf, 1); // st_other
419 String16(buf, shndx);
420 F->getContents() += StringRef(buf, 2); // st_shndx
424 static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout) {
425 if (Data.isCommon() && Data.isExternal())
426 return Data.getCommonAlignment();
428 const MCSymbol &Symbol = Data.getSymbol();
429 if (!Symbol.isInSection())
432 if (!Data.isCommon() && !(Data.getFlags() & ELF_STB_Weak))
433 if (MCFragment *FF = Data.getFragment())
434 return Layout.getSymbolAddress(&Data) -
435 Layout.getSectionAddress(FF->getParent());
440 static const MCSymbol &AliasedSymbol(const MCSymbol &Symbol) {
441 const MCSymbol *S = &Symbol;
442 while (S->isVariable()) {
443 const MCExpr *Value = S->getVariableValue();
444 if (Value->getKind() != MCExpr::SymbolRef)
446 const MCSymbolRefExpr *Ref = static_cast<const MCSymbolRefExpr*>(Value);
447 S = &Ref->getSymbol();
452 void ELFObjectWriterImpl::WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
453 const MCAsmLayout &Layout) {
454 MCSymbolData &OrigData = *MSD.SymbolData;
456 Layout.getAssembler().getSymbolData(AliasedSymbol(OrigData.getSymbol()));
458 uint8_t Binding = GetBinding(OrigData);
459 uint8_t Visibility = GetVisibility(OrigData);
460 uint8_t Type = GetType(Data);
462 uint8_t Info = (Binding << ELF_STB_Shift) | (Type << ELF_STT_Shift);
463 uint8_t Other = Visibility;
465 uint64_t Value = SymbolValue(Data, Layout);
469 assert(!(Data.isCommon() && !Data.isExternal()));
471 ESize = Data.getSize();
472 if (Data.getSize()) {
474 if (ESize->getKind() == MCExpr::Binary) {
475 const MCBinaryExpr *BE = static_cast<const MCBinaryExpr *>(ESize);
477 if (BE->EvaluateAsRelocatable(Res, &Layout)) {
478 assert(!Res.getSymA() || !Res.getSymA()->getSymbol().isDefined());
479 assert(!Res.getSymB() || !Res.getSymB()->getSymbol().isDefined());
480 Size = Res.getConstant();
482 } else if (ESize->getKind() == MCExpr::Constant) {
483 Size = static_cast<const MCConstantExpr *>(ESize)->getValue();
485 assert(0 && "Unsupported size expression");
489 // Write out the symbol table entry
490 WriteSymbolEntry(F, MSD.StringIndex, Info, Value,
491 Size, Other, MSD.SectionIndex);
494 void ELFObjectWriterImpl::WriteSymbolTable(MCDataFragment *F,
495 const MCAssembler &Asm,
496 const MCAsmLayout &Layout,
497 unsigned NumRegularSections) {
498 // The string table must be emitted first because we need the index
499 // into the string table for all the symbol names.
500 assert(StringTable.size() && "Missing string table");
502 // FIXME: Make sure the start of the symbol table is aligned.
504 // The first entry is the undefined symbol entry.
505 unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
506 F->getContents().append(EntrySize, '\x00');
508 // Write the symbol table entries.
509 LastLocalSymbolIndex = LocalSymbolData.size() + 1;
510 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
511 ELFSymbolData &MSD = LocalSymbolData[i];
512 WriteSymbol(F, MSD, Layout);
515 // Write out a symbol table entry for each regular section.
517 for (MCAssembler::const_iterator it = Asm.begin();
518 Index <= NumRegularSections; ++it, ++Index) {
519 const MCSectionELF &Section =
520 static_cast<const MCSectionELF&>(it->getSection());
521 // Leave out relocations so we don't have indexes within
522 // the relocations messed up
523 if (Section.getType() == ELF::SHT_RELA || Section.getType() == ELF::SHT_REL)
525 WriteSymbolEntry(F, 0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT, Index);
526 LastLocalSymbolIndex++;
529 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
530 ELFSymbolData &MSD = ExternalSymbolData[i];
531 MCSymbolData &Data = *MSD.SymbolData;
532 assert(((Data.getFlags() & ELF_STB_Global) ||
533 (Data.getFlags() & ELF_STB_Weak)) &&
534 "External symbol requires STB_GLOBAL or STB_WEAK flag");
535 WriteSymbol(F, MSD, Layout);
536 if (GetBinding(Data) == ELF::STB_LOCAL)
537 LastLocalSymbolIndex++;
540 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
541 ELFSymbolData &MSD = UndefinedSymbolData[i];
542 MCSymbolData &Data = *MSD.SymbolData;
543 WriteSymbol(F, MSD, Layout);
544 if (GetBinding(Data) == ELF::STB_LOCAL)
545 LastLocalSymbolIndex++;
549 static bool ShouldRelocOnSymbol(const MCSymbolData &SD,
550 const MCValue &Target,
551 const MCFragment &F) {
552 const MCSymbol &Symbol = SD.getSymbol();
553 if (Symbol.isUndefined())
556 const MCSectionELF &Section =
557 static_cast<const MCSectionELF&>(Symbol.getSection());
562 MCSymbolRefExpr::VariantKind Kind = Target.getSymA()->getKind();
563 const MCSectionELF &Sec2 =
564 static_cast<const MCSectionELF&>(F.getParent()->getSection());
566 if (Section.getKind().isBSS())
569 if (&Sec2 != &Section &&
570 (Kind == MCSymbolRefExpr::VK_PLT ||
571 Kind == MCSymbolRefExpr::VK_GOTPCREL ||
572 Kind == MCSymbolRefExpr::VK_GOTOFF))
575 if (Section.getFlags() & MCSectionELF::SHF_MERGE)
576 return Target.getConstant() != 0;
581 // FIXME: this is currently X86/X86_64 only
582 void ELFObjectWriterImpl::RecordRelocation(const MCAssembler &Asm,
583 const MCAsmLayout &Layout,
584 const MCFragment *Fragment,
585 const MCFixup &Fixup,
587 uint64_t &FixedValue) {
590 int64_t Value = Target.getConstant();
591 const MCSymbol *Symbol = 0;
593 bool IsPCRel = isFixupKindX86PCRel(Fixup.getKind());
594 if (!Target.isAbsolute()) {
595 Symbol = &AliasedSymbol(Target.getSymA()->getSymbol());
596 MCSymbolData &SD = Asm.getSymbolData(*Symbol);
597 MCFragment *F = SD.getFragment();
599 if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
600 const MCSymbol &SymbolB = RefB->getSymbol();
601 MCSymbolData &SDB = Asm.getSymbolData(SymbolB);
603 MCSectionData *Sec = Fragment->getParent();
605 // Offset of the symbol in the section
606 int64_t a = Layout.getSymbolAddress(&SDB) - Layout.getSectionAddress(Sec);
608 // Ofeset of the relocation in the section
609 int64_t b = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
613 // Check that this case has already been fully resolved before we get
615 if (Symbol->isDefined() && !SD.isExternal() &&
617 &Fragment->getParent()->getSection() == &Symbol->getSection()) {
618 llvm_unreachable("We don't need a relocation in this case.");
622 bool RelocOnSymbol = ShouldRelocOnSymbol(SD, Target, *Fragment);
623 if (!RelocOnSymbol) {
624 Index = F->getParent()->getOrdinal();
626 MCSectionData *FSD = F->getParent();
627 // Offset of the symbol in the section
628 Value += Layout.getSymbolAddress(&SD) - Layout.getSectionAddress(FSD);
630 UsedInReloc.insert(Symbol);
634 // Compensate for the addend on i386.
641 // determine the type of the relocation
643 MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
649 llvm_unreachable("Unimplemented");
650 case MCSymbolRefExpr::VK_None:
651 Type = ELF::R_X86_64_PC32;
653 case MCSymbolRefExpr::VK_PLT:
654 Type = ELF::R_X86_64_PLT32;
656 case llvm::MCSymbolRefExpr::VK_GOTPCREL:
657 Type = ELF::R_X86_64_GOTPCREL;
661 switch ((unsigned)Fixup.getKind()) {
662 default: llvm_unreachable("invalid fixup kind!");
663 case FK_Data_8: Type = ELF::R_X86_64_64; break;
664 case X86::reloc_signed_4byte:
665 case X86::reloc_pcrel_4byte:
666 assert(isInt<32>(Target.getConstant()));
669 llvm_unreachable("Unimplemented");
670 case MCSymbolRefExpr::VK_None:
671 Type = ELF::R_X86_64_32S;
673 case MCSymbolRefExpr::VK_GOT:
674 Type = ELF::R_X86_64_GOT32;
676 case MCSymbolRefExpr::VK_GOTPCREL:
677 Type = ELF::R_X86_64_GOTPCREL;
682 Type = ELF::R_X86_64_32;
684 case FK_Data_2: Type = ELF::R_X86_64_16; break;
685 case X86::reloc_pcrel_1byte:
686 case FK_Data_1: Type = ELF::R_X86_64_8; break;
693 llvm_unreachable("Unimplemented");
694 case MCSymbolRefExpr::VK_None:
695 Type = ELF::R_386_PC32;
697 case MCSymbolRefExpr::VK_PLT:
698 Type = ELF::R_386_PLT32;
702 switch ((unsigned)Fixup.getKind()) {
703 default: llvm_unreachable("invalid fixup kind!");
705 case X86::reloc_global_offset_table:
706 Type = ELF::R_386_GOTPC;
709 // FIXME: Should we avoid selecting reloc_signed_4byte in 32 bit mode
711 case X86::reloc_signed_4byte:
712 case X86::reloc_pcrel_4byte:
716 llvm_unreachable("Unimplemented");
717 case MCSymbolRefExpr::VK_None:
718 Type = ELF::R_386_32;
720 case MCSymbolRefExpr::VK_GOT:
721 Type = ELF::R_386_GOT32;
723 case MCSymbolRefExpr::VK_GOTOFF:
724 Type = ELF::R_386_GOTOFF;
728 case FK_Data_2: Type = ELF::R_386_16; break;
729 case X86::reloc_pcrel_1byte:
730 case FK_Data_1: Type = ELF::R_386_8; break;
735 if (RelocNeedsGOT(Type))
738 ELFRelocationEntry ERE;
744 ERE.r_offset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
746 if (HasRelocationAddend)
747 ERE.r_addend = Addend;
749 ERE.r_addend = 0; // Silence compiler warning.
751 Relocations[Fragment->getParent()].push_back(ERE);
755 ELFObjectWriterImpl::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
757 MCSymbolData &SD = Asm.getSymbolData(*S);
760 if (!SD.isExternal() && !S->isUndefined())
761 return SD.getIndex() + /* empty symbol */ 1;
763 // External or undefined symbol.
764 return SD.getIndex() + NumRegularSections + /* empty symbol */ 1;
767 static bool isInSymtab(const MCAssembler &Asm, const MCSymbolData &Data,
772 const MCSymbol &Symbol = Data.getSymbol();
774 const MCSymbol &A = AliasedSymbol(Symbol);
775 if (&A != &Symbol && A.isUndefined())
778 if (!Asm.isSymbolLinkerVisible(Symbol) && !Symbol.isUndefined())
781 if (Symbol.isTemporary())
787 static bool isLocal(const MCSymbolData &Data) {
788 if (Data.isExternal())
791 const MCSymbol &Symbol = Data.getSymbol();
792 if (Symbol.isUndefined() && !Symbol.isVariable())
798 void ELFObjectWriterImpl::ComputeSymbolTable(MCAssembler &Asm) {
799 // FIXME: Is this the correct place to do this?
801 llvm::StringRef Name = "_GLOBAL_OFFSET_TABLE_";
802 MCSymbol *Sym = Asm.getContext().GetOrCreateSymbol(Name);
803 MCSymbolData &Data = Asm.getOrCreateSymbolData(*Sym);
804 Data.setExternal(true);
807 // Build section lookup table.
808 NumRegularSections = Asm.size();
809 DenseMap<const MCSection*, uint32_t> SectionIndexMap;
811 for (MCAssembler::iterator it = Asm.begin(),
812 ie = Asm.end(); it != ie; ++it, ++Index)
813 SectionIndexMap[&it->getSection()] = Index;
815 // Index 0 is always the empty string.
816 StringMap<uint64_t> StringIndexMap;
817 StringTable += '\x00';
819 // Add the data for the symbols.
820 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
821 ie = Asm.symbol_end(); it != ie; ++it) {
822 const MCSymbol &Symbol = it->getSymbol();
824 if (!isInSymtab(Asm, *it, UsedInReloc.count(&Symbol)))
829 bool Local = isLocal(*it);
831 if (it->isCommon()) {
833 MSD.SectionIndex = ELF::SHN_COMMON;
834 } else if (Symbol.isAbsolute()) {
835 MSD.SectionIndex = ELF::SHN_ABS;
836 } else if (Symbol.isVariable()) {
837 const MCSymbol &RefSymbol = AliasedSymbol(Symbol);
838 if (RefSymbol.isDefined()) {
839 MSD.SectionIndex = SectionIndexMap.lookup(&RefSymbol.getSection());
840 assert(MSD.SectionIndex && "Invalid section index!");
842 } else if (Symbol.isUndefined()) {
844 MSD.SectionIndex = ELF::SHN_UNDEF;
845 // FIXME: Undefined symbols are global, but this is the first place we
846 // are able to set it.
847 if (GetBinding(*it) == ELF::STB_LOCAL)
848 SetBinding(*it, ELF::STB_GLOBAL);
850 MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
851 assert(MSD.SectionIndex && "Invalid section index!");
854 uint64_t &Entry = StringIndexMap[Symbol.getName()];
856 Entry = StringTable.size();
857 StringTable += Symbol.getName();
858 StringTable += '\x00';
860 MSD.StringIndex = Entry;
861 if (MSD.SectionIndex == ELF::SHN_UNDEF)
862 UndefinedSymbolData.push_back(MSD);
864 LocalSymbolData.push_back(MSD);
866 ExternalSymbolData.push_back(MSD);
869 // Symbols are required to be in lexicographic order.
870 array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
871 array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
872 array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
874 // Set the symbol indices. Local symbols must come before all other
875 // symbols with non-local bindings.
877 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
878 LocalSymbolData[i].SymbolData->setIndex(Index++);
879 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
880 ExternalSymbolData[i].SymbolData->setIndex(Index++);
881 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
882 UndefinedSymbolData[i].SymbolData->setIndex(Index++);
885 void ELFObjectWriterImpl::WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
886 const MCSectionData &SD) {
887 if (!Relocations[&SD].empty()) {
888 MCContext &Ctx = Asm.getContext();
889 const MCSection *RelaSection;
890 const MCSectionELF &Section =
891 static_cast<const MCSectionELF&>(SD.getSection());
893 const StringRef SectionName = Section.getSectionName();
894 std::string RelaSectionName = HasRelocationAddend ? ".rela" : ".rel";
895 RelaSectionName += SectionName;
898 if (HasRelocationAddend)
899 EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
901 EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
903 RelaSection = Ctx.getELFSection(RelaSectionName, HasRelocationAddend ?
904 ELF::SHT_RELA : ELF::SHT_REL, 0,
905 SectionKind::getReadOnly(),
908 MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
909 RelaSD.setAlignment(Is64Bit ? 8 : 4);
911 MCDataFragment *F = new MCDataFragment(&RelaSD);
913 WriteRelocationsFragment(Asm, F, &SD);
915 Asm.AddSectionToTheEnd(*Writer, RelaSD, Layout);
919 void ELFObjectWriterImpl::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
920 uint64_t Flags, uint64_t Address,
921 uint64_t Offset, uint64_t Size,
922 uint32_t Link, uint32_t Info,
924 uint64_t EntrySize) {
925 Write32(Name); // sh_name: index into string table
926 Write32(Type); // sh_type
927 WriteWord(Flags); // sh_flags
928 WriteWord(Address); // sh_addr
929 WriteWord(Offset); // sh_offset
930 WriteWord(Size); // sh_size
931 Write32(Link); // sh_link
932 Write32(Info); // sh_info
933 WriteWord(Alignment); // sh_addralign
934 WriteWord(EntrySize); // sh_entsize
937 void ELFObjectWriterImpl::WriteRelocationsFragment(const MCAssembler &Asm,
939 const MCSectionData *SD) {
940 std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
941 // sort by the r_offset just like gnu as does
942 array_pod_sort(Relocs.begin(), Relocs.end());
944 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
945 ELFRelocationEntry entry = Relocs[e - i - 1];
948 entry.Index = getSymbolIndexInSymbolTable(Asm, entry.Symbol);
950 entry.Index += LocalSymbolData.size() + 1;
954 String64(buf, entry.r_offset);
955 F->getContents() += StringRef(buf, 8);
957 struct ELF::Elf64_Rela ERE64;
958 ERE64.setSymbolAndType(entry.Index, entry.Type);
959 String64(buf, ERE64.r_info);
960 F->getContents() += StringRef(buf, 8);
962 if (HasRelocationAddend) {
963 String64(buf, entry.r_addend);
964 F->getContents() += StringRef(buf, 8);
969 String32(buf, entry.r_offset);
970 F->getContents() += StringRef(buf, 4);
972 struct ELF::Elf32_Rela ERE32;
973 ERE32.setSymbolAndType(entry.Index, entry.Type);
974 String32(buf, ERE32.r_info);
975 F->getContents() += StringRef(buf, 4);
977 if (HasRelocationAddend) {
978 String32(buf, entry.r_addend);
979 F->getContents() += StringRef(buf, 4);
985 void ELFObjectWriterImpl::CreateMetadataSections(MCAssembler &Asm,
986 MCAsmLayout &Layout) {
987 MCContext &Ctx = Asm.getContext();
990 const MCSection *SymtabSection;
991 unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
993 unsigned NumRegularSections = Asm.size();
995 // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
996 const MCSection *ShstrtabSection;
997 ShstrtabSection = Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
998 SectionKind::getReadOnly(), false);
999 MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
1000 ShstrtabSD.setAlignment(1);
1001 ShstrtabIndex = Asm.size();
1003 SymtabSection = Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1004 SectionKind::getReadOnly(),
1006 MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
1007 SymtabSD.setAlignment(Is64Bit ? 8 : 4);
1009 const MCSection *StrtabSection;
1010 StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
1011 SectionKind::getReadOnly(), false);
1012 MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
1013 StrtabSD.setAlignment(1);
1014 StringTableIndex = Asm.size();
1016 WriteRelocations(Asm, Layout);
1019 F = new MCDataFragment(&SymtabSD);
1020 WriteSymbolTable(F, Asm, Layout, NumRegularSections);
1021 Asm.AddSectionToTheEnd(*Writer, SymtabSD, Layout);
1023 F = new MCDataFragment(&StrtabSD);
1024 F->getContents().append(StringTable.begin(), StringTable.end());
1025 Asm.AddSectionToTheEnd(*Writer, StrtabSD, Layout);
1027 F = new MCDataFragment(&ShstrtabSD);
1029 // Section header string table.
1031 // The first entry of a string table holds a null character so skip
1034 F->getContents() += '\x00';
1036 for (MCAssembler::const_iterator it = Asm.begin(),
1037 ie = Asm.end(); it != ie; ++it) {
1038 const MCSectionELF &Section =
1039 static_cast<const MCSectionELF&>(it->getSection());
1040 // FIXME: We could merge suffixes like in .text and .rela.text.
1042 // Remember the index into the string table so we can write it
1043 // into the sh_name field of the section header table.
1044 SectionStringTableIndex[&it->getSection()] = Index;
1046 Index += Section.getSectionName().size() + 1;
1047 F->getContents() += Section.getSectionName();
1048 F->getContents() += '\x00';
1051 Asm.AddSectionToTheEnd(*Writer, ShstrtabSD, Layout);
1054 bool ELFObjectWriterImpl::IsFixupFullyResolved(const MCAssembler &Asm,
1055 const MCValue Target,
1057 const MCFragment *DF) const {
1058 // If this is a PCrel relocation, find the section this fixup value is
1060 const MCSection *BaseSection = 0;
1062 BaseSection = &DF->getParent()->getSection();
1063 assert(BaseSection);
1066 const MCSection *SectionA = 0;
1067 const MCSymbol *SymbolA = 0;
1068 if (const MCSymbolRefExpr *A = Target.getSymA()) {
1069 SymbolA = &A->getSymbol();
1070 SectionA = &SymbolA->getSection();
1073 const MCSection *SectionB = 0;
1074 if (const MCSymbolRefExpr *B = Target.getSymB()) {
1075 SectionB = &B->getSymbol().getSection();
1079 return SectionA == SectionB;
1081 const MCSymbolData &DataA = Asm.getSymbolData(*SymbolA);
1082 if (DataA.isExternal())
1085 return !SectionB && BaseSection == SectionA;
1088 void ELFObjectWriterImpl::WriteObject(MCAssembler &Asm,
1089 const MCAsmLayout &Layout) {
1090 // Compute symbol table information.
1091 ComputeSymbolTable(Asm);
1093 CreateMetadataSections(const_cast<MCAssembler&>(Asm),
1094 const_cast<MCAsmLayout&>(Layout));
1096 // Add 1 for the null section.
1097 unsigned NumSections = Asm.size() + 1;
1098 uint64_t NaturalAlignment = Is64Bit ? 8 : 4;
1099 uint64_t HeaderSize = Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr);
1100 uint64_t FileOff = HeaderSize;
1102 for (MCAssembler::const_iterator it = Asm.begin(),
1103 ie = Asm.end(); it != ie; ++it) {
1104 const MCSectionData &SD = *it;
1106 FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1108 // Get the size of the section in the output file (including padding).
1109 uint64_t Size = Layout.getSectionFileSize(&SD);
1114 FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
1116 // Write out the ELF header ...
1117 WriteHeader(FileOff - HeaderSize, NumSections);
1119 FileOff = HeaderSize;
1121 // ... then all of the sections ...
1122 DenseMap<const MCSection*, uint64_t> SectionOffsetMap;
1124 DenseMap<const MCSection*, uint32_t> SectionIndexMap;
1127 for (MCAssembler::const_iterator it = Asm.begin(),
1128 ie = Asm.end(); it != ie; ++it) {
1129 const MCSectionData &SD = *it;
1131 uint64_t Padding = OffsetToAlignment(FileOff, SD.getAlignment());
1132 WriteZeros(Padding);
1135 // Remember the offset into the file for this section.
1136 SectionOffsetMap[&it->getSection()] = FileOff;
1137 SectionIndexMap[&it->getSection()] = Index++;
1139 FileOff += Layout.getSectionFileSize(&SD);
1141 Asm.WriteSectionData(it, Layout, Writer);
1144 uint64_t Padding = OffsetToAlignment(FileOff, NaturalAlignment);
1145 WriteZeros(Padding);
1148 // ... and then the section header table.
1149 // Should we align the section header table?
1151 // Null section first.
1152 WriteSecHdrEntry(0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
1154 for (MCAssembler::const_iterator it = Asm.begin(),
1155 ie = Asm.end(); it != ie; ++it) {
1156 const MCSectionData &SD = *it;
1157 const MCSectionELF &Section =
1158 static_cast<const MCSectionELF&>(SD.getSection());
1160 uint64_t sh_link = 0;
1161 uint64_t sh_info = 0;
1163 switch(Section.getType()) {
1164 case ELF::SHT_DYNAMIC:
1165 sh_link = SectionStringTableIndex[&it->getSection()];
1170 case ELF::SHT_RELA: {
1171 const MCSection *SymtabSection;
1172 const MCSection *InfoSection;
1174 SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1175 SectionKind::getReadOnly(),
1177 sh_link = SectionIndexMap[SymtabSection];
1179 // Remove ".rel" and ".rela" prefixes.
1180 unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1181 StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1183 InfoSection = Asm.getContext().getELFSection(SectionName,
1184 ELF::SHT_PROGBITS, 0,
1185 SectionKind::getReadOnly(),
1187 sh_info = SectionIndexMap[InfoSection];
1191 case ELF::SHT_SYMTAB:
1192 case ELF::SHT_DYNSYM:
1193 sh_link = StringTableIndex;
1194 sh_info = LastLocalSymbolIndex;
1197 case ELF::SHT_PROGBITS:
1198 case ELF::SHT_STRTAB:
1199 case ELF::SHT_NOBITS:
1201 case ELF::SHT_ARM_ATTRIBUTES:
1206 assert(0 && "FIXME: sh_type value not supported!");
1210 WriteSecHdrEntry(SectionStringTableIndex[&it->getSection()],
1211 Section.getType(), Section.getFlags(),
1213 SectionOffsetMap.lookup(&SD.getSection()),
1214 Layout.getSectionSize(&SD), sh_link,
1215 sh_info, SD.getAlignment(),
1216 Section.getEntrySize());
1220 ELFObjectWriter::ELFObjectWriter(raw_ostream &OS,
1222 Triple::OSType OSType,
1224 bool IsLittleEndian,
1225 bool HasRelocationAddend)
1226 : MCObjectWriter(OS, IsLittleEndian)
1228 Impl = new ELFObjectWriterImpl(this, Is64Bit, EMachine,
1229 HasRelocationAddend, OSType);
1232 ELFObjectWriter::~ELFObjectWriter() {
1233 delete (ELFObjectWriterImpl*) Impl;
1236 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm) {
1237 ((ELFObjectWriterImpl*) Impl)->ExecutePostLayoutBinding(Asm);
1240 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
1241 const MCAsmLayout &Layout,
1242 const MCFragment *Fragment,
1243 const MCFixup &Fixup, MCValue Target,
1244 uint64_t &FixedValue) {
1245 ((ELFObjectWriterImpl*) Impl)->RecordRelocation(Asm, Layout, Fragment, Fixup,
1246 Target, FixedValue);
1249 bool ELFObjectWriter::IsFixupFullyResolved(const MCAssembler &Asm,
1250 const MCValue Target,
1252 const MCFragment *DF) const {
1253 return ((ELFObjectWriterImpl*) Impl)->IsFixupFullyResolved(Asm, Target,
1257 void ELFObjectWriter::WriteObject(MCAssembler &Asm,
1258 const MCAsmLayout &Layout) {
1259 ((ELFObjectWriterImpl*) Impl)->WriteObject(Asm, Layout);