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/MCELFObjectWriter.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/ADT/SmallPtrSet.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/MC/MCAsmBackend.h"
20 #include "llvm/MC/MCAsmInfo.h"
21 #include "llvm/MC/MCAsmLayout.h"
22 #include "llvm/MC/MCAssembler.h"
23 #include "llvm/MC/MCContext.h"
24 #include "llvm/MC/MCELF.h"
25 #include "llvm/MC/MCELFSymbolFlags.h"
26 #include "llvm/MC/MCExpr.h"
27 #include "llvm/MC/MCFixupKindInfo.h"
28 #include "llvm/MC/MCObjectWriter.h"
29 #include "llvm/MC/MCSectionELF.h"
30 #include "llvm/MC/MCValue.h"
31 #include "llvm/Support/Compression.h"
32 #include "llvm/Support/Debug.h"
33 #include "llvm/Support/Endian.h"
34 #include "llvm/Support/ELF.h"
35 #include "llvm/Support/ErrorHandling.h"
40 #define DEBUG_TYPE "reloc-info"
43 class FragmentWriter {
47 FragmentWriter(bool IsLittleEndian);
48 template <typename T> void write(MCDataFragment &F, T Val);
51 typedef DenseMap<const MCSectionELF *, uint32_t> SectionIndexMapTy;
53 class SymbolTableWriter {
55 FragmentWriter &FWriter;
57 SectionIndexMapTy &SectionIndexMap;
59 // The symbol .symtab fragment we are writting to.
60 MCDataFragment *SymtabF;
62 // .symtab_shndx fragment we are writting to.
63 MCDataFragment *ShndxF;
65 // The numbel of symbols written so far.
68 void createSymtabShndx();
70 template <typename T> void write(MCDataFragment &F, T Value);
73 SymbolTableWriter(MCAssembler &Asm, FragmentWriter &FWriter, bool Is64Bit,
74 SectionIndexMapTy &SectionIndexMap,
75 MCDataFragment *SymtabF);
77 void writeSymbol(uint32_t name, uint8_t info, uint64_t value, uint64_t size,
78 uint8_t other, uint32_t shndx, bool Reserved);
81 struct ELFRelocationEntry {
82 uint64_t Offset; // Where is the relocation.
83 bool UseSymbol; // Relocate with a symbol, not the section.
85 const MCSymbol *Symbol; // The symbol to relocate with.
86 const MCSectionData *Section; // The section to relocate with.
88 unsigned Type; // The type of the relocation.
89 uint64_t Addend; // The addend to use.
91 ELFRelocationEntry(uint64_t Offset, const MCSymbol *Symbol, unsigned Type,
93 : Offset(Offset), UseSymbol(true), Symbol(Symbol), Type(Type),
96 ELFRelocationEntry(uint64_t Offset, const MCSectionData *Section,
97 unsigned Type, uint64_t Addend)
98 : Offset(Offset), UseSymbol(false), Section(Section), Type(Type),
102 class ELFObjectWriter : public MCObjectWriter {
103 FragmentWriter FWriter;
107 static bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind);
108 static bool RelocNeedsGOT(MCSymbolRefExpr::VariantKind Variant);
109 static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout);
110 static bool isInSymtab(const MCAssembler &Asm, const MCSymbolData &Data,
111 bool Used, bool Renamed);
112 static bool isLocal(const MCSymbolData &Data, bool isSignature,
114 static bool IsELFMetaDataSection(const MCSectionData &SD);
115 static uint64_t DataSectionSize(const MCSectionData &SD);
116 static uint64_t GetSectionFileSize(const MCAsmLayout &Layout,
117 const MCSectionData &SD);
118 static uint64_t GetSectionAddressSize(const MCAsmLayout &Layout,
119 const MCSectionData &SD);
121 void WriteDataSectionData(MCAssembler &Asm,
122 const MCAsmLayout &Layout,
123 const MCSectionELF &Section);
125 /*static bool isFixupKindX86RIPRel(unsigned Kind) {
126 return Kind == X86::reloc_riprel_4byte ||
127 Kind == X86::reloc_riprel_4byte_movq_load;
130 /// ELFSymbolData - Helper struct for containing some precomputed
131 /// information on symbols.
132 struct ELFSymbolData {
133 MCSymbolData *SymbolData;
134 uint64_t StringIndex;
135 uint32_t SectionIndex;
137 // Support lexicographic sorting.
138 bool operator<(const ELFSymbolData &RHS) const {
139 return SymbolData->getSymbol().getName() <
140 RHS.SymbolData->getSymbol().getName();
144 /// The target specific ELF writer instance.
145 std::unique_ptr<MCELFObjectTargetWriter> TargetObjectWriter;
147 SmallPtrSet<const MCSymbol *, 16> UsedInReloc;
148 SmallPtrSet<const MCSymbol *, 16> WeakrefUsedInReloc;
149 DenseMap<const MCSymbol *, const MCSymbol *> Renames;
151 llvm::DenseMap<const MCSectionData *, std::vector<ELFRelocationEntry>>
153 DenseMap<const MCSection*, uint64_t> SectionStringTableIndex;
156 /// @name Symbol Table Data
159 SmallString<256> StringTable;
160 std::vector<uint64_t> FileSymbolData;
161 std::vector<ELFSymbolData> LocalSymbolData;
162 std::vector<ELFSymbolData> ExternalSymbolData;
163 std::vector<ELFSymbolData> UndefinedSymbolData;
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;
173 // This holds the .symtab section index.
174 unsigned SymbolTableIndex;
176 unsigned ShstrtabIndex;
179 // TargetObjectWriter wrappers.
180 bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
181 bool hasRelocationAddend() const {
182 return TargetObjectWriter->hasRelocationAddend();
184 unsigned GetRelocType(const MCValue &Target, const MCFixup &Fixup,
185 bool IsPCRel) const {
186 return TargetObjectWriter->GetRelocType(Target, Fixup, IsPCRel);
190 ELFObjectWriter(MCELFObjectTargetWriter *MOTW, raw_ostream &_OS,
192 : MCObjectWriter(_OS, IsLittleEndian), FWriter(IsLittleEndian),
193 TargetObjectWriter(MOTW), NeedsGOT(false) {}
195 virtual ~ELFObjectWriter();
197 void WriteWord(uint64_t W) {
204 template <typename T> void write(MCDataFragment &F, T Value) {
205 FWriter.write(F, Value);
208 void WriteHeader(const MCAssembler &Asm,
209 uint64_t SectionDataSize,
210 unsigned NumberOfSections);
212 void WriteSymbol(SymbolTableWriter &Writer, ELFSymbolData &MSD,
213 const MCAsmLayout &Layout);
215 void WriteSymbolTable(MCDataFragment *SymtabF, MCAssembler &Asm,
216 const MCAsmLayout &Layout,
217 SectionIndexMapTy &SectionIndexMap);
219 bool shouldRelocateWithSymbol(const MCSymbolRefExpr *RefA,
220 const MCSymbolData *SD, uint64_t C,
221 unsigned Type) const;
223 void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
224 const MCFragment *Fragment, const MCFixup &Fixup,
225 MCValue Target, bool &IsPCRel,
226 uint64_t &FixedValue) override;
228 uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
231 // Map from a group section to the signature symbol
232 typedef DenseMap<const MCSectionELF*, const MCSymbol*> GroupMapTy;
233 // Map from a signature symbol to the group section
234 typedef DenseMap<const MCSymbol*, const MCSectionELF*> RevGroupMapTy;
235 // Map from a section to the section with the relocations
236 typedef DenseMap<const MCSectionELF*, const MCSectionELF*> RelMapTy;
237 // Map from a section to its offset
238 typedef DenseMap<const MCSectionELF*, uint64_t> SectionOffsetMapTy;
240 /// Compute the symbol table data
242 /// \param Asm - The assembler.
243 /// \param SectionIndexMap - Maps a section to its index.
244 /// \param RevGroupMap - Maps a signature symbol to the group section.
245 /// \param NumRegularSections - Number of non-relocation sections.
246 void computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
247 const SectionIndexMapTy &SectionIndexMap,
248 RevGroupMapTy RevGroupMap,
249 unsigned NumRegularSections);
251 void ComputeIndexMap(MCAssembler &Asm,
252 SectionIndexMapTy &SectionIndexMap,
253 const RelMapTy &RelMap);
255 void CreateRelocationSections(MCAssembler &Asm, MCAsmLayout &Layout,
258 void CompressDebugSections(MCAssembler &Asm, MCAsmLayout &Layout);
260 void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout,
261 const RelMapTy &RelMap);
263 void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout,
264 SectionIndexMapTy &SectionIndexMap,
265 const RelMapTy &RelMap);
267 // Create the sections that show up in the symbol table. Currently
268 // those are the .note.GNU-stack section and the group sections.
269 void CreateIndexedSections(MCAssembler &Asm, MCAsmLayout &Layout,
270 GroupMapTy &GroupMap,
271 RevGroupMapTy &RevGroupMap,
272 SectionIndexMapTy &SectionIndexMap,
273 const RelMapTy &RelMap);
275 void ExecutePostLayoutBinding(MCAssembler &Asm,
276 const MCAsmLayout &Layout) override;
278 void WriteSectionHeader(MCAssembler &Asm, const GroupMapTy &GroupMap,
279 const MCAsmLayout &Layout,
280 const SectionIndexMapTy &SectionIndexMap,
281 const SectionOffsetMapTy &SectionOffsetMap);
283 void ComputeSectionOrder(MCAssembler &Asm,
284 std::vector<const MCSectionELF*> &Sections);
286 void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
287 uint64_t Address, uint64_t Offset,
288 uint64_t Size, uint32_t Link, uint32_t Info,
289 uint64_t Alignment, uint64_t EntrySize);
291 void WriteRelocationsFragment(const MCAssembler &Asm,
293 const MCSectionData *SD);
296 IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
297 const MCSymbolData &DataA,
298 const MCFragment &FB,
300 bool IsPCRel) const override;
302 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
303 void WriteSection(MCAssembler &Asm,
304 const SectionIndexMapTy &SectionIndexMap,
305 uint32_t GroupSymbolIndex,
306 uint64_t Offset, uint64_t Size, uint64_t Alignment,
307 const MCSectionELF &Section);
311 FragmentWriter::FragmentWriter(bool IsLittleEndian)
312 : IsLittleEndian(IsLittleEndian) {}
314 template <typename T> void FragmentWriter::write(MCDataFragment &F, T Val) {
316 Val = support::endian::byte_swap<T, support::little>(Val);
318 Val = support::endian::byte_swap<T, support::big>(Val);
319 const char *Start = (const char *)&Val;
320 F.getContents().append(Start, Start + sizeof(T));
323 void SymbolTableWriter::createSymtabShndx() {
327 MCContext &Ctx = Asm.getContext();
328 const MCSectionELF *SymtabShndxSection =
329 Ctx.getELFSection(".symtab_shndxr", ELF::SHT_SYMTAB_SHNDX, 0,
330 SectionKind::getReadOnly(), 4, "");
331 MCSectionData *SymtabShndxSD =
332 &Asm.getOrCreateSectionData(*SymtabShndxSection);
333 SymtabShndxSD->setAlignment(4);
334 ShndxF = new MCDataFragment(SymtabShndxSD);
335 unsigned Index = SectionIndexMap.size() + 1;
336 SectionIndexMap[SymtabShndxSection] = Index;
338 for (unsigned I = 0; I < NumWritten; ++I)
339 write(*ShndxF, uint32_t(0));
342 template <typename T>
343 void SymbolTableWriter::write(MCDataFragment &F, T Value) {
344 FWriter.write(F, Value);
347 SymbolTableWriter::SymbolTableWriter(MCAssembler &Asm, FragmentWriter &FWriter,
349 SectionIndexMapTy &SectionIndexMap,
350 MCDataFragment *SymtabF)
351 : Asm(Asm), FWriter(FWriter), Is64Bit(Is64Bit),
352 SectionIndexMap(SectionIndexMap), SymtabF(SymtabF), ShndxF(nullptr),
355 void SymbolTableWriter::writeSymbol(uint32_t name, uint8_t info, uint64_t value,
356 uint64_t size, uint8_t other,
357 uint32_t shndx, bool Reserved) {
358 bool LargeIndex = shndx >= ELF::SHN_LORESERVE && !Reserved;
365 write(*ShndxF, shndx);
367 write(*ShndxF, uint32_t(0));
370 uint16_t Index = LargeIndex ? uint16_t(ELF::SHN_XINDEX) : shndx;
372 raw_svector_ostream OS(SymtabF->getContents());
375 write(*SymtabF, name); // st_name
376 write(*SymtabF, info); // st_info
377 write(*SymtabF, other); // st_other
378 write(*SymtabF, Index); // st_shndx
379 write(*SymtabF, value); // st_value
380 write(*SymtabF, size); // st_size
382 write(*SymtabF, name); // st_name
383 write(*SymtabF, uint32_t(value)); // st_value
384 write(*SymtabF, uint32_t(size)); // st_size
385 write(*SymtabF, info); // st_info
386 write(*SymtabF, other); // st_other
387 write(*SymtabF, Index); // st_shndx
393 bool ELFObjectWriter::isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind) {
394 const MCFixupKindInfo &FKI =
395 Asm.getBackend().getFixupKindInfo((MCFixupKind) Kind);
397 return FKI.Flags & MCFixupKindInfo::FKF_IsPCRel;
400 bool ELFObjectWriter::RelocNeedsGOT(MCSymbolRefExpr::VariantKind Variant) {
404 case MCSymbolRefExpr::VK_GOT:
405 case MCSymbolRefExpr::VK_PLT:
406 case MCSymbolRefExpr::VK_GOTPCREL:
407 case MCSymbolRefExpr::VK_GOTOFF:
408 case MCSymbolRefExpr::VK_TPOFF:
409 case MCSymbolRefExpr::VK_TLSGD:
410 case MCSymbolRefExpr::VK_GOTTPOFF:
411 case MCSymbolRefExpr::VK_INDNTPOFF:
412 case MCSymbolRefExpr::VK_NTPOFF:
413 case MCSymbolRefExpr::VK_GOTNTPOFF:
414 case MCSymbolRefExpr::VK_TLSLDM:
415 case MCSymbolRefExpr::VK_DTPOFF:
416 case MCSymbolRefExpr::VK_TLSLD:
421 ELFObjectWriter::~ELFObjectWriter()
424 // Emit the ELF header.
425 void ELFObjectWriter::WriteHeader(const MCAssembler &Asm,
426 uint64_t SectionDataSize,
427 unsigned NumberOfSections) {
433 // emitWord method behaves differently for ELF32 and ELF64, writing
434 // 4 bytes in the former and 8 in the latter.
436 Write8(0x7f); // e_ident[EI_MAG0]
437 Write8('E'); // e_ident[EI_MAG1]
438 Write8('L'); // e_ident[EI_MAG2]
439 Write8('F'); // e_ident[EI_MAG3]
441 Write8(is64Bit() ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
444 Write8(isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
446 Write8(ELF::EV_CURRENT); // e_ident[EI_VERSION]
448 Write8(TargetObjectWriter->getOSABI());
449 Write8(0); // e_ident[EI_ABIVERSION]
451 WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
453 Write16(ELF::ET_REL); // e_type
455 Write16(TargetObjectWriter->getEMachine()); // e_machine = target
457 Write32(ELF::EV_CURRENT); // e_version
458 WriteWord(0); // e_entry, no entry point in .o file
459 WriteWord(0); // e_phoff, no program header for .o
460 WriteWord(SectionDataSize + (is64Bit() ? sizeof(ELF::Elf64_Ehdr) :
461 sizeof(ELF::Elf32_Ehdr))); // e_shoff = sec hdr table off in bytes
463 // e_flags = whatever the target wants
464 Write32(Asm.getELFHeaderEFlags());
466 // e_ehsize = ELF header size
467 Write16(is64Bit() ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
469 Write16(0); // e_phentsize = prog header entry size
470 Write16(0); // e_phnum = # prog header entries = 0
472 // e_shentsize = Section header entry size
473 Write16(is64Bit() ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
475 // e_shnum = # of section header ents
476 if (NumberOfSections >= ELF::SHN_LORESERVE)
477 Write16(ELF::SHN_UNDEF);
479 Write16(NumberOfSections);
481 // e_shstrndx = Section # of '.shstrtab'
482 if (ShstrtabIndex >= ELF::SHN_LORESERVE)
483 Write16(ELF::SHN_XINDEX);
485 Write16(ShstrtabIndex);
488 uint64_t ELFObjectWriter::SymbolValue(MCSymbolData &OrigData,
489 const MCAsmLayout &Layout) {
490 MCSymbolData *Data = &OrigData;
491 if (Data->isCommon() && Data->isExternal())
492 return Data->getCommonAlignment();
494 const MCSymbol *Symbol = &Data->getSymbol();
495 bool IsThumbFunc = OrigData.getFlags() & ELF_Other_ThumbFunc;
498 if (Symbol->isVariable()) {
499 const MCExpr *Expr = Symbol->getVariableValue();
501 if (!Expr->EvaluateAsRelocatable(Value, &Layout))
502 llvm_unreachable("Invalid expression");
504 assert(!Value.getSymB());
506 Res = Value.getConstant();
508 if (const MCSymbolRefExpr *A = Value.getSymA()) {
509 Symbol = &A->getSymbol();
510 Data = &Layout.getAssembler().getSymbolData(*Symbol);
520 if (!Symbol || !Symbol->isInSection())
523 Res += Layout.getSymbolOffset(Data);
528 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm,
529 const MCAsmLayout &Layout) {
530 // The presence of symbol versions causes undefined symbols and
531 // versions declared with @@@ to be renamed.
533 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
534 ie = Asm.symbol_end(); it != ie; ++it) {
535 const MCSymbol &Alias = it->getSymbol();
536 const MCSymbol &Symbol = Alias.AliasedSymbol();
537 MCSymbolData &SD = Asm.getSymbolData(Symbol);
540 if (&Symbol == &Alias)
543 StringRef AliasName = Alias.getName();
544 size_t Pos = AliasName.find('@');
545 if (Pos == StringRef::npos)
548 // Aliases defined with .symvar copy the binding from the symbol they alias.
549 // This is the first place we are able to copy this information.
550 it->setExternal(SD.isExternal());
551 MCELF::SetBinding(*it, MCELF::GetBinding(SD));
553 StringRef Rest = AliasName.substr(Pos);
554 if (!Symbol.isUndefined() && !Rest.startswith("@@@"))
557 // FIXME: produce a better error message.
558 if (Symbol.isUndefined() && Rest.startswith("@@") &&
559 !Rest.startswith("@@@"))
560 report_fatal_error("A @@ version cannot be undefined");
562 Renames.insert(std::make_pair(&Symbol, &Alias));
566 static uint8_t mergeTypeForSet(uint8_t origType, uint8_t newType) {
567 uint8_t Type = newType;
569 // Propagation rules:
570 // IFUNC > FUNC > OBJECT > NOTYPE
571 // TLS_OBJECT > OBJECT > NOTYPE
573 // dont let the new type degrade the old type
577 case ELF::STT_GNU_IFUNC:
578 if (Type == ELF::STT_FUNC || Type == ELF::STT_OBJECT ||
579 Type == ELF::STT_NOTYPE || Type == ELF::STT_TLS)
580 Type = ELF::STT_GNU_IFUNC;
583 if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
584 Type == ELF::STT_TLS)
585 Type = ELF::STT_FUNC;
587 case ELF::STT_OBJECT:
588 if (Type == ELF::STT_NOTYPE)
589 Type = ELF::STT_OBJECT;
592 if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
593 Type == ELF::STT_GNU_IFUNC || Type == ELF::STT_FUNC)
601 static const MCSymbol *getBaseSymbol(const MCAsmLayout &Layout,
602 const MCSymbol &Symbol) {
603 if (!Symbol.isVariable())
606 const MCExpr *Expr = Symbol.getVariableValue();
608 if (!Expr->EvaluateAsRelocatable(Value, &Layout))
609 llvm_unreachable("Invalid Expression");
610 assert(!Value.getSymB());
611 const MCSymbolRefExpr *A = Value.getSymA();
614 return getBaseSymbol(Layout, A->getSymbol());
617 void ELFObjectWriter::WriteSymbol(SymbolTableWriter &Writer, ELFSymbolData &MSD,
618 const MCAsmLayout &Layout) {
619 MCSymbolData &OrigData = *MSD.SymbolData;
620 const MCSymbol *Base = getBaseSymbol(Layout, OrigData.getSymbol());
622 // This has to be in sync with when computeSymbolTable uses SHN_ABS or
624 bool IsReserved = !Base || OrigData.isCommon();
626 // Binding and Type share the same byte as upper and lower nibbles
627 uint8_t Binding = MCELF::GetBinding(OrigData);
628 uint8_t Type = MCELF::GetType(OrigData);
629 MCSymbolData *BaseSD = nullptr;
631 BaseSD = &Layout.getAssembler().getSymbolData(*Base);
632 Type = mergeTypeForSet(Type, MCELF::GetType(*BaseSD));
634 if (OrigData.getFlags() & ELF_Other_ThumbFunc)
635 Type = ELF::STT_FUNC;
636 uint8_t Info = (Binding << ELF_STB_Shift) | (Type << ELF_STT_Shift);
638 // Other and Visibility share the same byte with Visibility using the lower
640 uint8_t Visibility = MCELF::GetVisibility(OrigData);
641 uint8_t Other = MCELF::getOther(OrigData) << (ELF_STO_Shift - ELF_STV_Shift);
644 uint64_t Value = SymbolValue(OrigData, Layout);
645 if (OrigData.getFlags() & ELF_Other_ThumbFunc)
649 const MCExpr *ESize = OrigData.getSize();
651 ESize = BaseSD->getSize();
655 if (!ESize->EvaluateAsAbsolute(Res, Layout))
656 report_fatal_error("Size expression must be absolute.");
660 // Write out the symbol table entry
661 Writer.writeSymbol(MSD.StringIndex, Info, Value, Size, Other,
662 MSD.SectionIndex, IsReserved);
665 void ELFObjectWriter::WriteSymbolTable(MCDataFragment *SymtabF,
667 const MCAsmLayout &Layout,
668 SectionIndexMapTy &SectionIndexMap) {
669 // The string table must be emitted first because we need the index
670 // into the string table for all the symbol names.
671 assert(StringTable.size() && "Missing string table");
673 // FIXME: Make sure the start of the symbol table is aligned.
675 SymbolTableWriter Writer(Asm, FWriter, is64Bit(), SectionIndexMap, SymtabF);
677 // The first entry is the undefined symbol entry.
678 Writer.writeSymbol(0, 0, 0, 0, 0, 0, false);
680 for (unsigned i = 0, e = FileSymbolData.size(); i != e; ++i) {
681 Writer.writeSymbol(FileSymbolData[i], ELF::STT_FILE | ELF::STB_LOCAL, 0, 0,
682 ELF::STV_DEFAULT, ELF::SHN_ABS, true);
685 // Write the symbol table entries.
686 LastLocalSymbolIndex = FileSymbolData.size() + LocalSymbolData.size() + 1;
688 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
689 ELFSymbolData &MSD = LocalSymbolData[i];
690 WriteSymbol(Writer, MSD, Layout);
693 // Write out a symbol table entry for each regular section.
694 for (MCAssembler::const_iterator i = Asm.begin(), e = Asm.end(); i != e;
696 const MCSectionELF &Section =
697 static_cast<const MCSectionELF&>(i->getSection());
698 if (Section.getType() == ELF::SHT_RELA ||
699 Section.getType() == ELF::SHT_REL ||
700 Section.getType() == ELF::SHT_STRTAB ||
701 Section.getType() == ELF::SHT_SYMTAB ||
702 Section.getType() == ELF::SHT_SYMTAB_SHNDX)
704 Writer.writeSymbol(0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT,
705 SectionIndexMap.lookup(&Section), false);
706 LastLocalSymbolIndex++;
709 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
710 ELFSymbolData &MSD = ExternalSymbolData[i];
711 MCSymbolData &Data = *MSD.SymbolData;
712 assert(((Data.getFlags() & ELF_STB_Global) ||
713 (Data.getFlags() & ELF_STB_Weak)) &&
714 "External symbol requires STB_GLOBAL or STB_WEAK flag");
715 WriteSymbol(Writer, MSD, Layout);
716 if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
717 LastLocalSymbolIndex++;
720 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
721 ELFSymbolData &MSD = UndefinedSymbolData[i];
722 MCSymbolData &Data = *MSD.SymbolData;
723 WriteSymbol(Writer, MSD, Layout);
724 if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
725 LastLocalSymbolIndex++;
729 // It is always valid to create a relocation with a symbol. It is preferable
730 // to use a relocation with a section if that is possible. Using the section
731 // allows us to omit some local symbols from the symbol table.
732 bool ELFObjectWriter::shouldRelocateWithSymbol(const MCSymbolRefExpr *RefA,
733 const MCSymbolData *SD,
735 unsigned Type) const {
736 // A PCRel relocation to an absolute value has no symbol (or section). We
737 // represent that with a relocation to a null section.
741 MCSymbolRefExpr::VariantKind Kind = RefA->getKind();
745 // The .odp creation emits a relocation against the symbol ".TOC." which
746 // create a R_PPC64_TOC relocation. However the relocation symbol name
747 // in final object creation should be NULL, since the symbol does not
748 // really exist, it is just the reference to TOC base for the current
749 // object file. Since the symbol is undefined, returning false results
750 // in a relocation with a null section which is the desired result.
751 case MCSymbolRefExpr::VK_PPC_TOCBASE:
754 // These VariantKind cause the relocation to refer to something other than
755 // the symbol itself, like a linker generated table. Since the address of
756 // symbol is not relevant, we cannot replace the symbol with the
757 // section and patch the difference in the addend.
758 case MCSymbolRefExpr::VK_GOT:
759 case MCSymbolRefExpr::VK_PLT:
760 case MCSymbolRefExpr::VK_GOTPCREL:
761 case MCSymbolRefExpr::VK_Mips_GOT:
762 case MCSymbolRefExpr::VK_PPC_GOT_LO:
763 case MCSymbolRefExpr::VK_PPC_GOT_HI:
764 case MCSymbolRefExpr::VK_PPC_GOT_HA:
768 // An undefined symbol is not in any section, so the relocation has to point
769 // to the symbol itself.
770 const MCSymbol &Sym = SD->getSymbol();
771 if (Sym.isUndefined())
774 unsigned Binding = MCELF::GetBinding(*SD);
777 llvm_unreachable("Invalid Binding");
781 // If the symbol is weak, it might be overridden by a symbol in another
782 // file. The relocation has to point to the symbol so that the linker
785 case ELF::STB_GLOBAL:
786 // Global ELF symbols can be preempted by the dynamic linker. The relocation
787 // has to point to the symbol for a reason analogous to the STB_WEAK case.
791 // If a relocation points to a mergeable section, we have to be careful.
792 // If the offset is zero, a relocation with the section will encode the
793 // same information. With a non-zero offset, the situation is different.
794 // For example, a relocation can point 42 bytes past the end of a string.
795 // If we change such a relocation to use the section, the linker would think
796 // that it pointed to another string and subtracting 42 at runtime will
797 // produce the wrong value.
798 auto &Sec = cast<MCSectionELF>(Sym.getSection());
799 unsigned Flags = Sec.getFlags();
800 if (Flags & ELF::SHF_MERGE) {
804 // It looks like gold has a bug (http://sourceware.org/PR16794) and can
805 // only handle section relocations to mergeable sections if using RELA.
806 if (!hasRelocationAddend())
810 // Most TLS relocations use a got, so they need the symbol. Even those that
811 // are just an offset (@tpoff), require a symbol in some linkers (gold,
813 if (Flags & ELF::SHF_TLS)
816 // If the symbol is a thumb function the final relocation must set the lowest
817 // bit. With a symbol that is done by just having the symbol have that bit
818 // set, so we would lose the bit if we relocated with the section.
819 // FIXME: We could use the section but add the bit to the relocation value.
820 if (SD->getFlags() & ELF_Other_ThumbFunc)
823 if (TargetObjectWriter->needsRelocateWithSymbol(Type))
828 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
829 const MCAsmLayout &Layout,
830 const MCFragment *Fragment,
831 const MCFixup &Fixup,
834 uint64_t &FixedValue) {
835 const MCSectionData *FixupSection = Fragment->getParent();
836 uint64_t C = Target.getConstant();
837 uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
839 if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
840 assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
841 "Should not have constructed this");
843 // Let A, B and C being the components of Target and R be the location of
844 // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
845 // If it is pcrel, we want to compute (A - B + C - R).
847 // In general, ELF has no relocations for -B. It can only represent (A + C)
848 // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
849 // replace B to implement it: (A - R - K + C)
851 Asm.getContext().FatalError(
853 "No relocation available to represent this relative expression");
855 const MCSymbol &SymB = RefB->getSymbol();
857 if (SymB.isUndefined())
858 Asm.getContext().FatalError(
860 Twine("symbol '") + SymB.getName() +
861 "' can not be undefined in a subtraction expression");
863 assert(!SymB.isAbsolute() && "Should have been folded");
864 const MCSection &SecB = SymB.getSection();
865 if (&SecB != &FixupSection->getSection())
866 Asm.getContext().FatalError(
867 Fixup.getLoc(), "Cannot represent a difference across sections");
869 const MCSymbolData &SymBD = Asm.getSymbolData(SymB);
870 uint64_t SymBOffset = Layout.getSymbolOffset(&SymBD);
871 uint64_t K = SymBOffset - FixupOffset;
876 // We either rejected the fixup or folded B into C at this point.
877 const MCSymbolRefExpr *RefA = Target.getSymA();
878 const MCSymbol *SymA = RefA ? &RefA->getSymbol() : nullptr;
879 const MCSymbolData *SymAD = SymA ? &Asm.getSymbolData(*SymA) : nullptr;
881 unsigned Type = GetRelocType(Target, Fixup, IsPCRel);
882 bool RelocateWithSymbol = shouldRelocateWithSymbol(RefA, SymAD, C, Type);
883 if (!RelocateWithSymbol && SymA && !SymA->isUndefined())
884 C += Layout.getSymbolOffset(SymAD);
887 if (hasRelocationAddend()) {
894 // FIXME: What is this!?!?
895 MCSymbolRefExpr::VariantKind Modifier =
896 RefA ? RefA->getKind() : MCSymbolRefExpr::VK_None;
897 if (RelocNeedsGOT(Modifier))
900 if (!RelocateWithSymbol) {
901 const MCSection *SecA =
902 (SymA && !SymA->isUndefined()) ? &SymA->getSection() : nullptr;
903 const MCSectionData *SecAD = SecA ? &Asm.getSectionData(*SecA) : nullptr;
904 ELFRelocationEntry Rec(FixupOffset, SecAD, Type, Addend);
905 Relocations[FixupSection].push_back(Rec);
910 if (const MCSymbol *R = Renames.lookup(SymA))
913 if (RefA->getKind() == MCSymbolRefExpr::VK_WEAKREF)
914 WeakrefUsedInReloc.insert(SymA);
916 UsedInReloc.insert(SymA);
918 ELFRelocationEntry Rec(FixupOffset, SymA, Type, Addend);
919 Relocations[FixupSection].push_back(Rec);
925 ELFObjectWriter::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
927 MCSymbolData &SD = Asm.getSymbolData(*S);
928 return SD.getIndex();
931 bool ELFObjectWriter::isInSymtab(const MCAssembler &Asm,
932 const MCSymbolData &Data,
933 bool Used, bool Renamed) {
934 const MCSymbol &Symbol = Data.getSymbol();
935 if (Symbol.isVariable()) {
936 const MCExpr *Expr = Symbol.getVariableValue();
937 if (const MCSymbolRefExpr *Ref = dyn_cast<MCSymbolRefExpr>(Expr)) {
938 if (Ref->getKind() == MCSymbolRefExpr::VK_WEAKREF)
949 if (Symbol.getName() == "_GLOBAL_OFFSET_TABLE_")
952 const MCSymbol &A = Symbol.AliasedSymbol();
953 if (Symbol.isVariable() && !A.isVariable() && A.isUndefined())
956 bool IsGlobal = MCELF::GetBinding(Data) == ELF::STB_GLOBAL;
957 if (!Symbol.isVariable() && Symbol.isUndefined() && !IsGlobal)
960 if (Symbol.isTemporary())
966 bool ELFObjectWriter::isLocal(const MCSymbolData &Data, bool isSignature,
967 bool isUsedInReloc) {
968 if (Data.isExternal())
971 const MCSymbol &Symbol = Data.getSymbol();
972 const MCSymbol &RefSymbol = Symbol.AliasedSymbol();
974 if (RefSymbol.isUndefined() && !RefSymbol.isVariable()) {
975 if (isSignature && !isUsedInReloc)
984 void ELFObjectWriter::ComputeIndexMap(MCAssembler &Asm,
985 SectionIndexMapTy &SectionIndexMap,
986 const RelMapTy &RelMap) {
988 for (MCAssembler::iterator it = Asm.begin(),
989 ie = Asm.end(); it != ie; ++it) {
990 const MCSectionELF &Section =
991 static_cast<const MCSectionELF &>(it->getSection());
992 if (Section.getType() != ELF::SHT_GROUP)
994 SectionIndexMap[&Section] = Index++;
997 for (MCAssembler::iterator it = Asm.begin(),
998 ie = Asm.end(); it != ie; ++it) {
999 const MCSectionELF &Section =
1000 static_cast<const MCSectionELF &>(it->getSection());
1001 if (Section.getType() == ELF::SHT_GROUP ||
1002 Section.getType() == ELF::SHT_REL ||
1003 Section.getType() == ELF::SHT_RELA)
1005 SectionIndexMap[&Section] = Index++;
1006 const MCSectionELF *RelSection = RelMap.lookup(&Section);
1008 SectionIndexMap[RelSection] = Index++;
1013 ELFObjectWriter::computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
1014 const SectionIndexMapTy &SectionIndexMap,
1015 RevGroupMapTy RevGroupMap,
1016 unsigned NumRegularSections) {
1017 // FIXME: Is this the correct place to do this?
1018 // FIXME: Why is an undefined reference to _GLOBAL_OFFSET_TABLE_ needed?
1020 StringRef Name = "_GLOBAL_OFFSET_TABLE_";
1021 MCSymbol *Sym = Asm.getContext().GetOrCreateSymbol(Name);
1022 MCSymbolData &Data = Asm.getOrCreateSymbolData(*Sym);
1023 Data.setExternal(true);
1024 MCELF::SetBinding(Data, ELF::STB_GLOBAL);
1027 // Index 0 is always the empty string.
1028 StringMap<uint64_t> StringIndexMap;
1029 StringTable += '\x00';
1031 // FIXME: We could optimize suffixes in strtab in the same way we
1032 // optimize them in shstrtab.
1034 for (MCAssembler::const_file_name_iterator it = Asm.file_names_begin(),
1035 ie = Asm.file_names_end();
1038 StringRef Name = *it;
1039 uint64_t &Entry = StringIndexMap[Name];
1041 Entry = StringTable.size();
1042 StringTable += Name;
1043 StringTable += '\x00';
1045 FileSymbolData.push_back(Entry);
1048 // Add the data for the symbols.
1049 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
1050 ie = Asm.symbol_end(); it != ie; ++it) {
1051 const MCSymbol &Symbol = it->getSymbol();
1053 bool Used = UsedInReloc.count(&Symbol);
1054 bool WeakrefUsed = WeakrefUsedInReloc.count(&Symbol);
1055 bool isSignature = RevGroupMap.count(&Symbol);
1057 if (!isInSymtab(Asm, *it,
1058 Used || WeakrefUsed || isSignature,
1059 Renames.count(&Symbol)))
1063 MSD.SymbolData = it;
1064 const MCSymbol *BaseSymbol = getBaseSymbol(Layout, Symbol);
1066 // Undefined symbols are global, but this is the first place we
1067 // are able to set it.
1068 bool Local = isLocal(*it, isSignature, Used);
1069 if (!Local && MCELF::GetBinding(*it) == ELF::STB_LOCAL) {
1071 MCSymbolData &SD = Asm.getSymbolData(*BaseSymbol);
1072 MCELF::SetBinding(*it, ELF::STB_GLOBAL);
1073 MCELF::SetBinding(SD, ELF::STB_GLOBAL);
1077 MSD.SectionIndex = ELF::SHN_ABS;
1078 } else if (it->isCommon()) {
1080 MSD.SectionIndex = ELF::SHN_COMMON;
1081 } else if (BaseSymbol->isUndefined()) {
1082 if (isSignature && !Used)
1083 MSD.SectionIndex = SectionIndexMap.lookup(RevGroupMap[&Symbol]);
1085 MSD.SectionIndex = ELF::SHN_UNDEF;
1086 if (!Used && WeakrefUsed)
1087 MCELF::SetBinding(*it, ELF::STB_WEAK);
1089 const MCSectionELF &Section =
1090 static_cast<const MCSectionELF&>(BaseSymbol->getSection());
1091 MSD.SectionIndex = SectionIndexMap.lookup(&Section);
1092 assert(MSD.SectionIndex && "Invalid section index!");
1095 // The @@@ in symbol version is replaced with @ in undefined symbols and
1096 // @@ in defined ones.
1097 StringRef Name = Symbol.getName();
1098 SmallString<32> Buf;
1100 size_t Pos = Name.find("@@@");
1101 if (Pos != StringRef::npos) {
1102 Buf += Name.substr(0, Pos);
1103 unsigned Skip = MSD.SectionIndex == ELF::SHN_UNDEF ? 2 : 1;
1104 Buf += Name.substr(Pos + Skip);
1108 uint64_t &Entry = StringIndexMap[Name];
1110 Entry = StringTable.size();
1111 StringTable += Name;
1112 StringTable += '\x00';
1114 MSD.StringIndex = Entry;
1115 if (MSD.SectionIndex == ELF::SHN_UNDEF)
1116 UndefinedSymbolData.push_back(MSD);
1118 LocalSymbolData.push_back(MSD);
1120 ExternalSymbolData.push_back(MSD);
1123 // Symbols are required to be in lexicographic order.
1124 array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
1125 array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
1126 array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
1128 // Set the symbol indices. Local symbols must come before all other
1129 // symbols with non-local bindings.
1130 unsigned Index = FileSymbolData.size() + 1;
1131 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1132 LocalSymbolData[i].SymbolData->setIndex(Index++);
1134 Index += NumRegularSections;
1136 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1137 ExternalSymbolData[i].SymbolData->setIndex(Index++);
1138 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1139 UndefinedSymbolData[i].SymbolData->setIndex(Index++);
1142 void ELFObjectWriter::CreateRelocationSections(MCAssembler &Asm,
1143 MCAsmLayout &Layout,
1145 for (MCAssembler::const_iterator it = Asm.begin(),
1146 ie = Asm.end(); it != ie; ++it) {
1147 const MCSectionData &SD = *it;
1148 if (Relocations[&SD].empty())
1151 MCContext &Ctx = Asm.getContext();
1152 const MCSectionELF &Section =
1153 static_cast<const MCSectionELF&>(SD.getSection());
1155 const StringRef SectionName = Section.getSectionName();
1156 std::string RelaSectionName = hasRelocationAddend() ? ".rela" : ".rel";
1157 RelaSectionName += SectionName;
1160 if (hasRelocationAddend())
1161 EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
1163 EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
1166 StringRef Group = "";
1167 if (Section.getFlags() & ELF::SHF_GROUP) {
1168 Flags = ELF::SHF_GROUP;
1169 Group = Section.getGroup()->getName();
1172 const MCSectionELF *RelaSection =
1173 Ctx.getELFSection(RelaSectionName, hasRelocationAddend() ?
1174 ELF::SHT_RELA : ELF::SHT_REL, Flags,
1175 SectionKind::getReadOnly(),
1177 RelMap[&Section] = RelaSection;
1178 Asm.getOrCreateSectionData(*RelaSection);
1182 static SmallVector<char, 128>
1183 getUncompressedData(MCAsmLayout &Layout,
1184 MCSectionData::FragmentListType &Fragments) {
1185 SmallVector<char, 128> UncompressedData;
1186 for (const MCFragment &F : Fragments) {
1187 const SmallVectorImpl<char> *Contents;
1188 switch (F.getKind()) {
1189 case MCFragment::FT_Data:
1190 Contents = &cast<MCDataFragment>(F).getContents();
1192 case MCFragment::FT_Dwarf:
1193 Contents = &cast<MCDwarfLineAddrFragment>(F).getContents();
1195 case MCFragment::FT_DwarfFrame:
1196 Contents = &cast<MCDwarfCallFrameFragment>(F).getContents();
1200 "Not expecting any other fragment types in a debug_* section");
1202 UncompressedData.append(Contents->begin(), Contents->end());
1204 return UncompressedData;
1207 // Include the debug info compression header:
1208 // "ZLIB" followed by 8 bytes representing the uncompressed size of the section,
1209 // useful for consumers to preallocate a buffer to decompress into.
1211 prependCompressionHeader(uint64_t Size,
1212 SmallVectorImpl<char> &CompressedContents) {
1213 static const StringRef Magic = "ZLIB";
1214 if (sys::IsLittleEndianHost)
1215 Size = sys::SwapByteOrder(Size);
1216 CompressedContents.insert(CompressedContents.begin(),
1217 Magic.size() + sizeof(Size), 0);
1218 std::copy(Magic.begin(), Magic.end(), CompressedContents.begin());
1219 std::copy(reinterpret_cast<char *>(&Size),
1220 reinterpret_cast<char *>(&Size + 1),
1221 CompressedContents.begin() + Magic.size());
1224 // Return a single fragment containing the compressed contents of the whole
1225 // section. Null if the section was not compressed for any reason.
1226 static std::unique_ptr<MCDataFragment>
1227 getCompressedFragment(MCAsmLayout &Layout,
1228 MCSectionData::FragmentListType &Fragments) {
1229 std::unique_ptr<MCDataFragment> CompressedFragment(new MCDataFragment());
1231 // Gather the uncompressed data from all the fragments, recording the
1232 // alignment fragment, if seen, and any fixups.
1233 SmallVector<char, 128> UncompressedData =
1234 getUncompressedData(Layout, Fragments);
1236 SmallVectorImpl<char> &CompressedContents = CompressedFragment->getContents();
1238 zlib::Status Success = zlib::compress(
1239 StringRef(UncompressedData.data(), UncompressedData.size()),
1240 CompressedContents);
1241 if (Success != zlib::StatusOK)
1244 prependCompressionHeader(UncompressedData.size(), CompressedContents);
1246 return CompressedFragment;
1249 static void CompressDebugSection(MCAssembler &Asm, MCAsmLayout &Layout,
1250 const MCSectionELF &Section,
1251 MCSectionData &SD) {
1252 StringRef SectionName = Section.getSectionName();
1253 MCSectionData::FragmentListType &Fragments = SD.getFragmentList();
1255 std::unique_ptr<MCDataFragment> CompressedFragment =
1256 getCompressedFragment(Layout, Fragments);
1258 // Leave the section as-is if the fragments could not be compressed.
1259 if (!CompressedFragment)
1262 // Invalidate the layout for the whole section since it will have new and
1263 // different fragments now.
1264 Layout.invalidateFragmentsFrom(&Fragments.front());
1267 // Complete the initialization of the new fragment
1268 CompressedFragment->setParent(&SD);
1269 CompressedFragment->setLayoutOrder(0);
1270 Fragments.push_back(CompressedFragment.release());
1272 // Rename from .debug_* to .zdebug_*
1273 Asm.getContext().renameELFSection(&Section,
1274 (".z" + SectionName.drop_front(1)).str());
1277 void ELFObjectWriter::CompressDebugSections(MCAssembler &Asm,
1278 MCAsmLayout &Layout) {
1279 if (!Asm.getContext().getAsmInfo()->compressDebugSections())
1282 for (MCSectionData &SD : Asm) {
1283 const MCSectionELF &Section =
1284 static_cast<const MCSectionELF &>(SD.getSection());
1285 StringRef SectionName = Section.getSectionName();
1287 // Compressing debug_frame requires handling alignment fragments which is
1288 // more work (possibly generalizing MCAssembler.cpp:writeFragment to allow
1289 // for writing to arbitrary buffers) for little benefit.
1290 if (!SectionName.startswith(".debug_") || SectionName == ".debug_frame")
1293 CompressDebugSection(Asm, Layout, Section, SD);
1297 void ELFObjectWriter::WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout,
1298 const RelMapTy &RelMap) {
1299 for (MCAssembler::const_iterator it = Asm.begin(),
1300 ie = Asm.end(); it != ie; ++it) {
1301 const MCSectionData &SD = *it;
1302 const MCSectionELF &Section =
1303 static_cast<const MCSectionELF&>(SD.getSection());
1305 const MCSectionELF *RelaSection = RelMap.lookup(&Section);
1308 MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
1309 RelaSD.setAlignment(is64Bit() ? 8 : 4);
1311 MCDataFragment *F = new MCDataFragment(&RelaSD);
1312 WriteRelocationsFragment(Asm, F, &*it);
1316 void ELFObjectWriter::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
1317 uint64_t Flags, uint64_t Address,
1318 uint64_t Offset, uint64_t Size,
1319 uint32_t Link, uint32_t Info,
1321 uint64_t EntrySize) {
1322 Write32(Name); // sh_name: index into string table
1323 Write32(Type); // sh_type
1324 WriteWord(Flags); // sh_flags
1325 WriteWord(Address); // sh_addr
1326 WriteWord(Offset); // sh_offset
1327 WriteWord(Size); // sh_size
1328 Write32(Link); // sh_link
1329 Write32(Info); // sh_info
1330 WriteWord(Alignment); // sh_addralign
1331 WriteWord(EntrySize); // sh_entsize
1334 // ELF doesn't require relocations to be in any order. We sort by the r_offset,
1335 // just to match gnu as for easier comparison. The use type is an arbitrary way
1336 // of making the sort deterministic.
1337 static int cmpRel(const ELFRelocationEntry *AP, const ELFRelocationEntry *BP) {
1338 const ELFRelocationEntry &A = *AP;
1339 const ELFRelocationEntry &B = *BP;
1340 if (A.Offset != B.Offset)
1341 return B.Offset - A.Offset;
1342 if (B.Type != A.Type)
1343 return A.Type - B.Type;
1344 llvm_unreachable("ELFRelocs might be unstable!");
1347 static void sortRelocs(const MCAssembler &Asm,
1348 std::vector<ELFRelocationEntry> &Relocs) {
1349 array_pod_sort(Relocs.begin(), Relocs.end(), cmpRel);
1352 void ELFObjectWriter::WriteRelocationsFragment(const MCAssembler &Asm,
1354 const MCSectionData *SD) {
1355 std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
1357 sortRelocs(Asm, Relocs);
1359 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1360 const ELFRelocationEntry &Entry = Relocs[e - i - 1];
1363 if (Entry.UseSymbol) {
1364 Index = getSymbolIndexInSymbolTable(Asm, Entry.Symbol);
1366 const MCSectionData *Sec = Entry.Section;
1368 Index = Sec->getOrdinal() + FileSymbolData.size() +
1369 LocalSymbolData.size() + 1;
1375 write(*F, Entry.Offset);
1376 if (TargetObjectWriter->isN64()) {
1377 write(*F, uint32_t(Index));
1379 write(*F, TargetObjectWriter->getRSsym(Entry.Type));
1380 write(*F, TargetObjectWriter->getRType3(Entry.Type));
1381 write(*F, TargetObjectWriter->getRType2(Entry.Type));
1382 write(*F, TargetObjectWriter->getRType(Entry.Type));
1384 struct ELF::Elf64_Rela ERE64;
1385 ERE64.setSymbolAndType(Index, Entry.Type);
1386 write(*F, ERE64.r_info);
1388 if (hasRelocationAddend())
1389 write(*F, Entry.Addend);
1391 write(*F, uint32_t(Entry.Offset));
1393 struct ELF::Elf32_Rela ERE32;
1394 ERE32.setSymbolAndType(Index, Entry.Type);
1395 write(*F, ERE32.r_info);
1397 if (hasRelocationAddend())
1398 write(*F, uint32_t(Entry.Addend));
1403 static int compareBySuffix(const MCSectionELF *const *a,
1404 const MCSectionELF *const *b) {
1405 const StringRef &NameA = (*a)->getSectionName();
1406 const StringRef &NameB = (*b)->getSectionName();
1407 const unsigned sizeA = NameA.size();
1408 const unsigned sizeB = NameB.size();
1409 const unsigned len = std::min(sizeA, sizeB);
1410 for (unsigned int i = 0; i < len; ++i) {
1411 char ca = NameA[sizeA - i - 1];
1412 char cb = NameB[sizeB - i - 1];
1417 return sizeB - sizeA;
1420 void ELFObjectWriter::CreateMetadataSections(MCAssembler &Asm,
1421 MCAsmLayout &Layout,
1422 SectionIndexMapTy &SectionIndexMap,
1423 const RelMapTy &RelMap) {
1424 MCContext &Ctx = Asm.getContext();
1427 unsigned EntrySize = is64Bit() ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
1429 // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
1430 const MCSectionELF *ShstrtabSection =
1431 Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
1432 SectionKind::getReadOnly());
1433 MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
1434 ShstrtabSD.setAlignment(1);
1436 const MCSectionELF *SymtabSection =
1437 Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1438 SectionKind::getReadOnly(),
1440 MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
1441 SymtabSD.setAlignment(is64Bit() ? 8 : 4);
1443 const MCSectionELF *StrtabSection;
1444 StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
1445 SectionKind::getReadOnly());
1446 MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
1447 StrtabSD.setAlignment(1);
1449 ComputeIndexMap(Asm, SectionIndexMap, RelMap);
1451 ShstrtabIndex = SectionIndexMap.lookup(ShstrtabSection);
1452 SymbolTableIndex = SectionIndexMap.lookup(SymtabSection);
1453 StringTableIndex = SectionIndexMap.lookup(StrtabSection);
1456 F = new MCDataFragment(&SymtabSD);
1457 WriteSymbolTable(F, Asm, Layout, SectionIndexMap);
1459 F = new MCDataFragment(&StrtabSD);
1460 F->getContents().append(StringTable.begin(), StringTable.end());
1462 F = new MCDataFragment(&ShstrtabSD);
1464 std::vector<const MCSectionELF*> Sections;
1465 for (MCAssembler::const_iterator it = Asm.begin(),
1466 ie = Asm.end(); it != ie; ++it) {
1467 const MCSectionELF &Section =
1468 static_cast<const MCSectionELF&>(it->getSection());
1469 Sections.push_back(&Section);
1471 array_pod_sort(Sections.begin(), Sections.end(), compareBySuffix);
1473 // Section header string table.
1475 // The first entry of a string table holds a null character so skip
1478 F->getContents().push_back('\x00');
1480 for (unsigned int I = 0, E = Sections.size(); I != E; ++I) {
1481 const MCSectionELF &Section = *Sections[I];
1483 StringRef Name = Section.getSectionName();
1485 StringRef PreviousName = Sections[I - 1]->getSectionName();
1486 if (PreviousName.endswith(Name)) {
1487 SectionStringTableIndex[&Section] = Index - Name.size() - 1;
1491 // Remember the index into the string table so we can write it
1492 // into the sh_name field of the section header table.
1493 SectionStringTableIndex[&Section] = Index;
1495 Index += Name.size() + 1;
1496 F->getContents().append(Name.begin(), Name.end());
1497 F->getContents().push_back('\x00');
1501 void ELFObjectWriter::CreateIndexedSections(MCAssembler &Asm,
1502 MCAsmLayout &Layout,
1503 GroupMapTy &GroupMap,
1504 RevGroupMapTy &RevGroupMap,
1505 SectionIndexMapTy &SectionIndexMap,
1506 const RelMapTy &RelMap) {
1507 // Create the .note.GNU-stack section if needed.
1508 MCContext &Ctx = Asm.getContext();
1509 if (Asm.getNoExecStack()) {
1510 const MCSectionELF *GnuStackSection =
1511 Ctx.getELFSection(".note.GNU-stack", ELF::SHT_PROGBITS, 0,
1512 SectionKind::getReadOnly());
1513 Asm.getOrCreateSectionData(*GnuStackSection);
1517 for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1519 const MCSectionELF &Section =
1520 static_cast<const MCSectionELF&>(it->getSection());
1521 if (!(Section.getFlags() & ELF::SHF_GROUP))
1524 const MCSymbol *SignatureSymbol = Section.getGroup();
1525 Asm.getOrCreateSymbolData(*SignatureSymbol);
1526 const MCSectionELF *&Group = RevGroupMap[SignatureSymbol];
1528 Group = Ctx.CreateELFGroupSection();
1529 MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1530 Data.setAlignment(4);
1531 MCDataFragment *F = new MCDataFragment(&Data);
1532 write(*F, uint32_t(ELF::GRP_COMDAT));
1534 GroupMap[Group] = SignatureSymbol;
1537 ComputeIndexMap(Asm, SectionIndexMap, RelMap);
1539 // Add sections to the groups
1540 for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1542 const MCSectionELF &Section =
1543 static_cast<const MCSectionELF&>(it->getSection());
1544 if (!(Section.getFlags() & ELF::SHF_GROUP))
1546 const MCSectionELF *Group = RevGroupMap[Section.getGroup()];
1547 MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1548 // FIXME: we could use the previous fragment
1549 MCDataFragment *F = new MCDataFragment(&Data);
1550 uint32_t Index = SectionIndexMap.lookup(&Section);
1555 void ELFObjectWriter::WriteSection(MCAssembler &Asm,
1556 const SectionIndexMapTy &SectionIndexMap,
1557 uint32_t GroupSymbolIndex,
1558 uint64_t Offset, uint64_t Size,
1560 const MCSectionELF &Section) {
1561 uint64_t sh_link = 0;
1562 uint64_t sh_info = 0;
1564 switch(Section.getType()) {
1565 case ELF::SHT_DYNAMIC:
1566 sh_link = SectionStringTableIndex[&Section];
1571 case ELF::SHT_RELA: {
1572 const MCSectionELF *SymtabSection;
1573 const MCSectionELF *InfoSection;
1574 SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB,
1576 SectionKind::getReadOnly());
1577 sh_link = SectionIndexMap.lookup(SymtabSection);
1578 assert(sh_link && ".symtab not found");
1580 // Remove ".rel" and ".rela" prefixes.
1581 unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1582 StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1583 StringRef GroupName =
1584 Section.getGroup() ? Section.getGroup()->getName() : "";
1586 InfoSection = Asm.getContext().getELFSection(SectionName, ELF::SHT_PROGBITS,
1587 0, SectionKind::getReadOnly(),
1589 sh_info = SectionIndexMap.lookup(InfoSection);
1593 case ELF::SHT_SYMTAB:
1594 case ELF::SHT_DYNSYM:
1595 sh_link = StringTableIndex;
1596 sh_info = LastLocalSymbolIndex;
1599 case ELF::SHT_SYMTAB_SHNDX:
1600 sh_link = SymbolTableIndex;
1603 case ELF::SHT_PROGBITS:
1604 case ELF::SHT_STRTAB:
1605 case ELF::SHT_NOBITS:
1608 case ELF::SHT_ARM_ATTRIBUTES:
1609 case ELF::SHT_INIT_ARRAY:
1610 case ELF::SHT_FINI_ARRAY:
1611 case ELF::SHT_PREINIT_ARRAY:
1612 case ELF::SHT_X86_64_UNWIND:
1613 case ELF::SHT_MIPS_REGINFO:
1614 case ELF::SHT_MIPS_OPTIONS:
1618 case ELF::SHT_GROUP:
1619 sh_link = SymbolTableIndex;
1620 sh_info = GroupSymbolIndex;
1624 assert(0 && "FIXME: sh_type value not supported!");
1628 if (TargetObjectWriter->getEMachine() == ELF::EM_ARM &&
1629 Section.getType() == ELF::SHT_ARM_EXIDX) {
1630 StringRef SecName(Section.getSectionName());
1631 if (SecName == ".ARM.exidx") {
1632 sh_link = SectionIndexMap.lookup(
1633 Asm.getContext().getELFSection(".text",
1635 ELF::SHF_EXECINSTR | ELF::SHF_ALLOC,
1636 SectionKind::getText()));
1637 } else if (SecName.startswith(".ARM.exidx")) {
1638 StringRef GroupName =
1639 Section.getGroup() ? Section.getGroup()->getName() : "";
1640 sh_link = SectionIndexMap.lookup(Asm.getContext().getELFSection(
1641 SecName.substr(sizeof(".ARM.exidx") - 1), ELF::SHT_PROGBITS,
1642 ELF::SHF_EXECINSTR | ELF::SHF_ALLOC, SectionKind::getText(), 0,
1647 WriteSecHdrEntry(SectionStringTableIndex[&Section], Section.getType(),
1648 Section.getFlags(), 0, Offset, Size, sh_link, sh_info,
1649 Alignment, Section.getEntrySize());
1652 bool ELFObjectWriter::IsELFMetaDataSection(const MCSectionData &SD) {
1653 return SD.getOrdinal() == ~UINT32_C(0) &&
1654 !SD.getSection().isVirtualSection();
1657 uint64_t ELFObjectWriter::DataSectionSize(const MCSectionData &SD) {
1659 for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1661 const MCFragment &F = *i;
1662 assert(F.getKind() == MCFragment::FT_Data);
1663 Ret += cast<MCDataFragment>(F).getContents().size();
1668 uint64_t ELFObjectWriter::GetSectionFileSize(const MCAsmLayout &Layout,
1669 const MCSectionData &SD) {
1670 if (IsELFMetaDataSection(SD))
1671 return DataSectionSize(SD);
1672 return Layout.getSectionFileSize(&SD);
1675 uint64_t ELFObjectWriter::GetSectionAddressSize(const MCAsmLayout &Layout,
1676 const MCSectionData &SD) {
1677 if (IsELFMetaDataSection(SD))
1678 return DataSectionSize(SD);
1679 return Layout.getSectionAddressSize(&SD);
1682 void ELFObjectWriter::WriteDataSectionData(MCAssembler &Asm,
1683 const MCAsmLayout &Layout,
1684 const MCSectionELF &Section) {
1685 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1687 uint64_t Padding = OffsetToAlignment(OS.tell(), SD.getAlignment());
1688 WriteZeros(Padding);
1690 if (IsELFMetaDataSection(SD)) {
1691 for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1693 const MCFragment &F = *i;
1694 assert(F.getKind() == MCFragment::FT_Data);
1695 WriteBytes(cast<MCDataFragment>(F).getContents());
1698 Asm.writeSectionData(&SD, Layout);
1702 void ELFObjectWriter::WriteSectionHeader(MCAssembler &Asm,
1703 const GroupMapTy &GroupMap,
1704 const MCAsmLayout &Layout,
1705 const SectionIndexMapTy &SectionIndexMap,
1706 const SectionOffsetMapTy &SectionOffsetMap) {
1707 const unsigned NumSections = Asm.size() + 1;
1709 std::vector<const MCSectionELF*> Sections;
1710 Sections.resize(NumSections - 1);
1712 for (SectionIndexMapTy::const_iterator i=
1713 SectionIndexMap.begin(), e = SectionIndexMap.end(); i != e; ++i) {
1714 const std::pair<const MCSectionELF*, uint32_t> &p = *i;
1715 Sections[p.second - 1] = p.first;
1718 // Null section first.
1719 uint64_t FirstSectionSize =
1720 NumSections >= ELF::SHN_LORESERVE ? NumSections : 0;
1721 uint32_t FirstSectionLink =
1722 ShstrtabIndex >= ELF::SHN_LORESERVE ? ShstrtabIndex : 0;
1723 WriteSecHdrEntry(0, 0, 0, 0, 0, FirstSectionSize, FirstSectionLink, 0, 0, 0);
1725 for (unsigned i = 0; i < NumSections - 1; ++i) {
1726 const MCSectionELF &Section = *Sections[i];
1727 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1728 uint32_t GroupSymbolIndex;
1729 if (Section.getType() != ELF::SHT_GROUP)
1730 GroupSymbolIndex = 0;
1732 GroupSymbolIndex = getSymbolIndexInSymbolTable(Asm,
1733 GroupMap.lookup(&Section));
1735 uint64_t Size = GetSectionAddressSize(Layout, SD);
1737 WriteSection(Asm, SectionIndexMap, GroupSymbolIndex,
1738 SectionOffsetMap.lookup(&Section), Size,
1739 SD.getAlignment(), Section);
1743 void ELFObjectWriter::ComputeSectionOrder(MCAssembler &Asm,
1744 std::vector<const MCSectionELF*> &Sections) {
1745 for (MCAssembler::iterator it = Asm.begin(),
1746 ie = Asm.end(); it != ie; ++it) {
1747 const MCSectionELF &Section =
1748 static_cast<const MCSectionELF &>(it->getSection());
1749 if (Section.getType() == ELF::SHT_GROUP)
1750 Sections.push_back(&Section);
1753 for (MCAssembler::iterator it = Asm.begin(),
1754 ie = Asm.end(); it != ie; ++it) {
1755 const MCSectionELF &Section =
1756 static_cast<const MCSectionELF &>(it->getSection());
1757 if (Section.getType() != ELF::SHT_GROUP &&
1758 Section.getType() != ELF::SHT_REL &&
1759 Section.getType() != ELF::SHT_RELA)
1760 Sections.push_back(&Section);
1763 for (MCAssembler::iterator it = Asm.begin(),
1764 ie = Asm.end(); it != ie; ++it) {
1765 const MCSectionELF &Section =
1766 static_cast<const MCSectionELF &>(it->getSection());
1767 if (Section.getType() == ELF::SHT_REL ||
1768 Section.getType() == ELF::SHT_RELA)
1769 Sections.push_back(&Section);
1773 void ELFObjectWriter::WriteObject(MCAssembler &Asm,
1774 const MCAsmLayout &Layout) {
1775 GroupMapTy GroupMap;
1776 RevGroupMapTy RevGroupMap;
1777 SectionIndexMapTy SectionIndexMap;
1779 unsigned NumUserSections = Asm.size();
1781 CompressDebugSections(Asm, const_cast<MCAsmLayout &>(Layout));
1783 DenseMap<const MCSectionELF*, const MCSectionELF*> RelMap;
1784 CreateRelocationSections(Asm, const_cast<MCAsmLayout&>(Layout), RelMap);
1786 const unsigned NumUserAndRelocSections = Asm.size();
1787 CreateIndexedSections(Asm, const_cast<MCAsmLayout&>(Layout), GroupMap,
1788 RevGroupMap, SectionIndexMap, RelMap);
1789 const unsigned AllSections = Asm.size();
1790 const unsigned NumIndexedSections = AllSections - NumUserAndRelocSections;
1792 unsigned NumRegularSections = NumUserSections + NumIndexedSections;
1794 // Compute symbol table information.
1795 computeSymbolTable(Asm, Layout, SectionIndexMap, RevGroupMap,
1796 NumRegularSections);
1798 WriteRelocations(Asm, const_cast<MCAsmLayout&>(Layout), RelMap);
1800 CreateMetadataSections(const_cast<MCAssembler&>(Asm),
1801 const_cast<MCAsmLayout&>(Layout),
1805 uint64_t NaturalAlignment = is64Bit() ? 8 : 4;
1806 uint64_t HeaderSize = is64Bit() ? sizeof(ELF::Elf64_Ehdr) :
1807 sizeof(ELF::Elf32_Ehdr);
1808 uint64_t FileOff = HeaderSize;
1810 std::vector<const MCSectionELF*> Sections;
1811 ComputeSectionOrder(Asm, Sections);
1812 unsigned NumSections = Sections.size();
1813 SectionOffsetMapTy SectionOffsetMap;
1814 for (unsigned i = 0; i < NumRegularSections + 1; ++i) {
1815 const MCSectionELF &Section = *Sections[i];
1816 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1818 FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1820 // Remember the offset into the file for this section.
1821 SectionOffsetMap[&Section] = FileOff;
1823 // Get the size of the section in the output file (including padding).
1824 FileOff += GetSectionFileSize(Layout, SD);
1827 FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
1829 const unsigned SectionHeaderOffset = FileOff - HeaderSize;
1831 uint64_t SectionHeaderEntrySize = is64Bit() ?
1832 sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr);
1833 FileOff += (NumSections + 1) * SectionHeaderEntrySize;
1835 for (unsigned i = NumRegularSections + 1; i < NumSections; ++i) {
1836 const MCSectionELF &Section = *Sections[i];
1837 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1839 FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1841 // Remember the offset into the file for this section.
1842 SectionOffsetMap[&Section] = FileOff;
1844 // Get the size of the section in the output file (including padding).
1845 FileOff += GetSectionFileSize(Layout, SD);
1848 // Write out the ELF header ...
1849 WriteHeader(Asm, SectionHeaderOffset, NumSections + 1);
1851 // ... then the regular sections ...
1852 // + because of .shstrtab
1853 for (unsigned i = 0; i < NumRegularSections + 1; ++i)
1854 WriteDataSectionData(Asm, Layout, *Sections[i]);
1856 uint64_t Padding = OffsetToAlignment(OS.tell(), NaturalAlignment);
1857 WriteZeros(Padding);
1859 // ... then the section header table ...
1860 WriteSectionHeader(Asm, GroupMap, Layout, SectionIndexMap,
1863 // ... and then the remaining sections ...
1864 for (unsigned i = NumRegularSections + 1; i < NumSections; ++i)
1865 WriteDataSectionData(Asm, Layout, *Sections[i]);
1869 ELFObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
1870 const MCSymbolData &DataA,
1871 const MCFragment &FB,
1873 bool IsPCRel) const {
1874 if (DataA.getFlags() & ELF_STB_Weak || MCELF::GetType(DataA) == ELF::STT_GNU_IFUNC)
1876 return MCObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
1877 Asm, DataA, FB,InSet, IsPCRel);
1880 MCObjectWriter *llvm::createELFObjectWriter(MCELFObjectTargetWriter *MOTW,
1882 bool IsLittleEndian) {
1883 return new ELFObjectWriter(MOTW, OS, IsLittleEndian);