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/Object/StringTableBuilder.h"
32 #include "llvm/Support/Compression.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/Endian.h"
35 #include "llvm/Support/ELF.h"
36 #include "llvm/Support/ErrorHandling.h"
41 #define DEBUG_TYPE "reloc-info"
44 class FragmentWriter {
48 FragmentWriter(bool IsLittleEndian);
49 template <typename T> void write(MCDataFragment &F, T Val);
52 typedef DenseMap<const MCSectionELF *, uint32_t> SectionIndexMapTy;
54 class SymbolTableWriter {
56 FragmentWriter &FWriter;
58 SectionIndexMapTy &SectionIndexMap;
60 // The symbol .symtab fragment we are writting to.
61 MCDataFragment *SymtabF;
63 // .symtab_shndx fragment we are writting to.
64 MCDataFragment *ShndxF;
66 // The numbel of symbols written so far.
69 void createSymtabShndx();
71 template <typename T> void write(MCDataFragment &F, T Value);
74 SymbolTableWriter(MCAssembler &Asm, FragmentWriter &FWriter, bool Is64Bit,
75 SectionIndexMapTy &SectionIndexMap,
76 MCDataFragment *SymtabF);
78 void writeSymbol(uint32_t name, uint8_t info, uint64_t value, uint64_t size,
79 uint8_t other, uint32_t shndx, bool Reserved);
82 struct ELFRelocationEntry {
83 uint64_t Offset; // Where is the relocation.
84 bool UseSymbol; // Relocate with a symbol, not the section.
86 const MCSymbol *Symbol; // The symbol to relocate with.
87 const MCSectionData *Section; // The section to relocate with.
89 unsigned Type; // The type of the relocation.
90 uint64_t Addend; // The addend to use.
92 ELFRelocationEntry(uint64_t Offset, const MCSymbol *Symbol, unsigned Type,
94 : Offset(Offset), UseSymbol(true), Symbol(Symbol), Type(Type),
97 ELFRelocationEntry(uint64_t Offset, const MCSectionData *Section,
98 unsigned Type, uint64_t Addend)
99 : Offset(Offset), UseSymbol(false), Section(Section), Type(Type),
103 class ELFObjectWriter : public MCObjectWriter {
104 FragmentWriter FWriter;
108 static bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind);
109 static bool RelocNeedsGOT(MCSymbolRefExpr::VariantKind Variant);
110 static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout);
111 static bool isInSymtab(const MCAsmLayout &Layout, const MCSymbolData &Data,
112 bool Used, bool Renamed);
113 static bool isLocal(const MCSymbolData &Data, bool isUsedInReloc);
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;
138 // Support lexicographic sorting.
139 bool operator<(const ELFSymbolData &RHS) const {
140 return Name < RHS.Name;
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 StringTableBuilder ShStrTabBuilder;
156 /// @name Symbol Table Data
159 StringTableBuilder StrTabBuilder;
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 MCAssembler &Asm,
220 const MCSymbolRefExpr *RefA,
221 const MCSymbolData *SD, uint64_t C,
222 unsigned Type) const;
224 void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
225 const MCFragment *Fragment, const MCFixup &Fixup,
226 MCValue Target, bool &IsPCRel,
227 uint64_t &FixedValue) override;
229 uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
232 // Map from a group section to the signature symbol
233 typedef DenseMap<const MCSectionELF*, const MCSymbol*> GroupMapTy;
234 // Map from a signature symbol to the group section
235 typedef DenseMap<const MCSymbol*, const MCSectionELF*> RevGroupMapTy;
236 // Map from a section to the section with the relocations
237 typedef DenseMap<const MCSectionELF*, const MCSectionELF*> RelMapTy;
238 // Map from a section to its offset
239 typedef DenseMap<const MCSectionELF*, uint64_t> SectionOffsetMapTy;
241 /// Compute the symbol table data
243 /// \param Asm - The assembler.
244 /// \param SectionIndexMap - Maps a section to its index.
245 /// \param RevGroupMap - Maps a signature symbol to the group section.
246 /// \param NumRegularSections - Number of non-relocation sections.
247 void computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
248 const SectionIndexMapTy &SectionIndexMap,
249 RevGroupMapTy RevGroupMap,
250 unsigned NumRegularSections);
252 void ComputeIndexMap(MCAssembler &Asm,
253 SectionIndexMapTy &SectionIndexMap,
254 const RelMapTy &RelMap);
256 void CreateRelocationSections(MCAssembler &Asm, MCAsmLayout &Layout,
259 void CompressDebugSections(MCAssembler &Asm, MCAsmLayout &Layout);
261 void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout,
262 const RelMapTy &RelMap);
264 void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout,
265 SectionIndexMapTy &SectionIndexMap,
266 const RelMapTy &RelMap);
268 // Create the sections that show up in the symbol table. Currently
269 // those are the .note.GNU-stack section and the group sections.
270 void CreateIndexedSections(MCAssembler &Asm, MCAsmLayout &Layout,
271 GroupMapTy &GroupMap,
272 RevGroupMapTy &RevGroupMap,
273 SectionIndexMapTy &SectionIndexMap,
274 const RelMapTy &RelMap);
276 void ExecutePostLayoutBinding(MCAssembler &Asm,
277 const MCAsmLayout &Layout) override;
279 void WriteSectionHeader(MCAssembler &Asm, const GroupMapTy &GroupMap,
280 const MCAsmLayout &Layout,
281 const SectionIndexMapTy &SectionIndexMap,
282 const SectionOffsetMapTy &SectionOffsetMap);
284 void ComputeSectionOrder(MCAssembler &Asm,
285 std::vector<const MCSectionELF*> &Sections);
287 void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
288 uint64_t Address, uint64_t Offset,
289 uint64_t Size, uint32_t Link, uint32_t Info,
290 uint64_t Alignment, uint64_t EntrySize);
292 void WriteRelocationsFragment(const MCAssembler &Asm,
294 const MCSectionData *SD);
297 IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
298 const MCSymbolData &DataA,
299 const MCFragment &FB,
301 bool IsPCRel) const override;
303 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
304 void WriteSection(MCAssembler &Asm,
305 const SectionIndexMapTy &SectionIndexMap,
306 uint32_t GroupSymbolIndex,
307 uint64_t Offset, uint64_t Size, uint64_t Alignment,
308 const MCSectionELF &Section);
312 FragmentWriter::FragmentWriter(bool IsLittleEndian)
313 : IsLittleEndian(IsLittleEndian) {}
315 template <typename T> void FragmentWriter::write(MCDataFragment &F, T Val) {
317 Val = support::endian::byte_swap<T, support::little>(Val);
319 Val = support::endian::byte_swap<T, support::big>(Val);
320 const char *Start = (const char *)&Val;
321 F.getContents().append(Start, Start + sizeof(T));
324 void SymbolTableWriter::createSymtabShndx() {
328 MCContext &Ctx = Asm.getContext();
329 const MCSectionELF *SymtabShndxSection =
330 Ctx.getELFSection(".symtab_shndxr", ELF::SHT_SYMTAB_SHNDX, 0,
331 SectionKind::getReadOnly(), 4, "");
332 MCSectionData *SymtabShndxSD =
333 &Asm.getOrCreateSectionData(*SymtabShndxSection);
334 SymtabShndxSD->setAlignment(4);
335 ShndxF = new MCDataFragment(SymtabShndxSD);
336 unsigned Index = SectionIndexMap.size() + 1;
337 SectionIndexMap[SymtabShndxSection] = Index;
339 for (unsigned I = 0; I < NumWritten; ++I)
340 write(*ShndxF, uint32_t(0));
343 template <typename T>
344 void SymbolTableWriter::write(MCDataFragment &F, T Value) {
345 FWriter.write(F, Value);
348 SymbolTableWriter::SymbolTableWriter(MCAssembler &Asm, FragmentWriter &FWriter,
350 SectionIndexMapTy &SectionIndexMap,
351 MCDataFragment *SymtabF)
352 : Asm(Asm), FWriter(FWriter), Is64Bit(Is64Bit),
353 SectionIndexMap(SectionIndexMap), SymtabF(SymtabF), ShndxF(nullptr),
356 void SymbolTableWriter::writeSymbol(uint32_t name, uint8_t info, uint64_t value,
357 uint64_t size, uint8_t other,
358 uint32_t shndx, bool Reserved) {
359 bool LargeIndex = shndx >= ELF::SHN_LORESERVE && !Reserved;
366 write(*ShndxF, shndx);
368 write(*ShndxF, uint32_t(0));
371 uint16_t Index = LargeIndex ? uint16_t(ELF::SHN_XINDEX) : shndx;
373 raw_svector_ostream OS(SymtabF->getContents());
376 write(*SymtabF, name); // st_name
377 write(*SymtabF, info); // st_info
378 write(*SymtabF, other); // st_other
379 write(*SymtabF, Index); // st_shndx
380 write(*SymtabF, value); // st_value
381 write(*SymtabF, size); // st_size
383 write(*SymtabF, name); // st_name
384 write(*SymtabF, uint32_t(value)); // st_value
385 write(*SymtabF, uint32_t(size)); // st_size
386 write(*SymtabF, info); // st_info
387 write(*SymtabF, other); // st_other
388 write(*SymtabF, Index); // st_shndx
394 bool ELFObjectWriter::isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind) {
395 const MCFixupKindInfo &FKI =
396 Asm.getBackend().getFixupKindInfo((MCFixupKind) Kind);
398 return FKI.Flags & MCFixupKindInfo::FKF_IsPCRel;
401 bool ELFObjectWriter::RelocNeedsGOT(MCSymbolRefExpr::VariantKind Variant) {
405 case MCSymbolRefExpr::VK_GOT:
406 case MCSymbolRefExpr::VK_PLT:
407 case MCSymbolRefExpr::VK_GOTPCREL:
408 case MCSymbolRefExpr::VK_GOTOFF:
409 case MCSymbolRefExpr::VK_TPOFF:
410 case MCSymbolRefExpr::VK_TLSGD:
411 case MCSymbolRefExpr::VK_GOTTPOFF:
412 case MCSymbolRefExpr::VK_INDNTPOFF:
413 case MCSymbolRefExpr::VK_NTPOFF:
414 case MCSymbolRefExpr::VK_GOTNTPOFF:
415 case MCSymbolRefExpr::VK_TLSLDM:
416 case MCSymbolRefExpr::VK_DTPOFF:
417 case MCSymbolRefExpr::VK_TLSLD:
422 ELFObjectWriter::~ELFObjectWriter()
425 // Emit the ELF header.
426 void ELFObjectWriter::WriteHeader(const MCAssembler &Asm,
427 uint64_t SectionDataSize,
428 unsigned NumberOfSections) {
434 // emitWord method behaves differently for ELF32 and ELF64, writing
435 // 4 bytes in the former and 8 in the latter.
437 Write8(0x7f); // e_ident[EI_MAG0]
438 Write8('E'); // e_ident[EI_MAG1]
439 Write8('L'); // e_ident[EI_MAG2]
440 Write8('F'); // e_ident[EI_MAG3]
442 Write8(is64Bit() ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
445 Write8(isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
447 Write8(ELF::EV_CURRENT); // e_ident[EI_VERSION]
449 Write8(TargetObjectWriter->getOSABI());
450 Write8(0); // e_ident[EI_ABIVERSION]
452 WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
454 Write16(ELF::ET_REL); // e_type
456 Write16(TargetObjectWriter->getEMachine()); // e_machine = target
458 Write32(ELF::EV_CURRENT); // e_version
459 WriteWord(0); // e_entry, no entry point in .o file
460 WriteWord(0); // e_phoff, no program header for .o
461 WriteWord(SectionDataSize + (is64Bit() ? sizeof(ELF::Elf64_Ehdr) :
462 sizeof(ELF::Elf32_Ehdr))); // e_shoff = sec hdr table off in bytes
464 // e_flags = whatever the target wants
465 Write32(Asm.getELFHeaderEFlags());
467 // e_ehsize = ELF header size
468 Write16(is64Bit() ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
470 Write16(0); // e_phentsize = prog header entry size
471 Write16(0); // e_phnum = # prog header entries = 0
473 // e_shentsize = Section header entry size
474 Write16(is64Bit() ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
476 // e_shnum = # of section header ents
477 if (NumberOfSections >= ELF::SHN_LORESERVE)
478 Write16(ELF::SHN_UNDEF);
480 Write16(NumberOfSections);
482 // e_shstrndx = Section # of '.shstrtab'
483 if (ShstrtabIndex >= ELF::SHN_LORESERVE)
484 Write16(ELF::SHN_XINDEX);
486 Write16(ShstrtabIndex);
489 uint64_t ELFObjectWriter::SymbolValue(MCSymbolData &Data,
490 const MCAsmLayout &Layout) {
491 if (Data.isCommon() && Data.isExternal())
492 return Data.getCommonAlignment();
495 if (!Layout.getSymbolOffset(&Data, Res))
498 if (Layout.getAssembler().isThumbFunc(&Data.getSymbol()))
504 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm,
505 const MCAsmLayout &Layout) {
506 // The presence of symbol versions causes undefined symbols and
507 // versions declared with @@@ to be renamed.
509 for (MCSymbolData &OriginalData : Asm.symbols()) {
510 const MCSymbol &Alias = OriginalData.getSymbol();
513 if (!Alias.isVariable())
515 auto *Ref = dyn_cast<MCSymbolRefExpr>(Alias.getVariableValue());
518 const MCSymbol &Symbol = Ref->getSymbol();
519 MCSymbolData &SD = Asm.getSymbolData(Symbol);
521 StringRef AliasName = Alias.getName();
522 size_t Pos = AliasName.find('@');
523 if (Pos == StringRef::npos)
526 // Aliases defined with .symvar copy the binding from the symbol they alias.
527 // This is the first place we are able to copy this information.
528 OriginalData.setExternal(SD.isExternal());
529 MCELF::SetBinding(OriginalData, MCELF::GetBinding(SD));
531 StringRef Rest = AliasName.substr(Pos);
532 if (!Symbol.isUndefined() && !Rest.startswith("@@@"))
535 // FIXME: produce a better error message.
536 if (Symbol.isUndefined() && Rest.startswith("@@") &&
537 !Rest.startswith("@@@"))
538 report_fatal_error("A @@ version cannot be undefined");
540 Renames.insert(std::make_pair(&Symbol, &Alias));
544 static uint8_t mergeTypeForSet(uint8_t origType, uint8_t newType) {
545 uint8_t Type = newType;
547 // Propagation rules:
548 // IFUNC > FUNC > OBJECT > NOTYPE
549 // TLS_OBJECT > OBJECT > NOTYPE
551 // dont let the new type degrade the old type
555 case ELF::STT_GNU_IFUNC:
556 if (Type == ELF::STT_FUNC || Type == ELF::STT_OBJECT ||
557 Type == ELF::STT_NOTYPE || Type == ELF::STT_TLS)
558 Type = ELF::STT_GNU_IFUNC;
561 if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
562 Type == ELF::STT_TLS)
563 Type = ELF::STT_FUNC;
565 case ELF::STT_OBJECT:
566 if (Type == ELF::STT_NOTYPE)
567 Type = ELF::STT_OBJECT;
570 if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
571 Type == ELF::STT_GNU_IFUNC || Type == ELF::STT_FUNC)
579 void ELFObjectWriter::WriteSymbol(SymbolTableWriter &Writer, ELFSymbolData &MSD,
580 const MCAsmLayout &Layout) {
581 MCSymbolData &OrigData = *MSD.SymbolData;
582 assert((!OrigData.getFragment() ||
583 (&OrigData.getFragment()->getParent()->getSection() ==
584 &OrigData.getSymbol().getSection())) &&
585 "The symbol's section doesn't match the fragment's symbol");
586 const MCSymbol *Base = Layout.getBaseSymbol(OrigData.getSymbol());
588 // This has to be in sync with when computeSymbolTable uses SHN_ABS or
590 bool IsReserved = !Base || OrigData.isCommon();
592 // Binding and Type share the same byte as upper and lower nibbles
593 uint8_t Binding = MCELF::GetBinding(OrigData);
594 uint8_t Type = MCELF::GetType(OrigData);
595 MCSymbolData *BaseSD = nullptr;
597 BaseSD = &Layout.getAssembler().getSymbolData(*Base);
598 Type = mergeTypeForSet(Type, MCELF::GetType(*BaseSD));
600 uint8_t Info = (Binding << ELF_STB_Shift) | (Type << ELF_STT_Shift);
602 // Other and Visibility share the same byte with Visibility using the lower
604 uint8_t Visibility = MCELF::GetVisibility(OrigData);
605 uint8_t Other = MCELF::getOther(OrigData) << (ELF_STO_Shift - ELF_STV_Shift);
608 uint64_t Value = SymbolValue(OrigData, Layout);
611 const MCExpr *ESize = OrigData.getSize();
613 ESize = BaseSD->getSize();
617 if (!ESize->EvaluateAsAbsolute(Res, Layout))
618 report_fatal_error("Size expression must be absolute.");
622 // Write out the symbol table entry
623 Writer.writeSymbol(MSD.StringIndex, Info, Value, Size, Other,
624 MSD.SectionIndex, IsReserved);
627 void ELFObjectWriter::WriteSymbolTable(MCDataFragment *SymtabF,
629 const MCAsmLayout &Layout,
630 SectionIndexMapTy &SectionIndexMap) {
631 // The string table must be emitted first because we need the index
632 // into the string table for all the symbol names.
634 // FIXME: Make sure the start of the symbol table is aligned.
636 SymbolTableWriter Writer(Asm, FWriter, is64Bit(), SectionIndexMap, SymtabF);
638 // The first entry is the undefined symbol entry.
639 Writer.writeSymbol(0, 0, 0, 0, 0, 0, false);
641 for (unsigned i = 0, e = FileSymbolData.size(); i != e; ++i) {
642 Writer.writeSymbol(FileSymbolData[i], ELF::STT_FILE | ELF::STB_LOCAL, 0, 0,
643 ELF::STV_DEFAULT, ELF::SHN_ABS, true);
646 // Write the symbol table entries.
647 LastLocalSymbolIndex = FileSymbolData.size() + LocalSymbolData.size() + 1;
649 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
650 ELFSymbolData &MSD = LocalSymbolData[i];
651 WriteSymbol(Writer, MSD, Layout);
654 // Write out a symbol table entry for each regular section.
655 for (MCAssembler::const_iterator i = Asm.begin(), e = Asm.end(); i != e;
657 const MCSectionELF &Section =
658 static_cast<const MCSectionELF&>(i->getSection());
659 if (Section.getType() == ELF::SHT_RELA ||
660 Section.getType() == ELF::SHT_REL ||
661 Section.getType() == ELF::SHT_STRTAB ||
662 Section.getType() == ELF::SHT_SYMTAB ||
663 Section.getType() == ELF::SHT_SYMTAB_SHNDX)
665 Writer.writeSymbol(0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT,
666 SectionIndexMap.lookup(&Section), false);
667 LastLocalSymbolIndex++;
670 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
671 ELFSymbolData &MSD = ExternalSymbolData[i];
672 MCSymbolData &Data = *MSD.SymbolData;
673 assert(((Data.getFlags() & ELF_STB_Global) ||
674 (Data.getFlags() & ELF_STB_Weak)) &&
675 "External symbol requires STB_GLOBAL or STB_WEAK flag");
676 WriteSymbol(Writer, MSD, Layout);
677 if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
678 LastLocalSymbolIndex++;
681 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
682 ELFSymbolData &MSD = UndefinedSymbolData[i];
683 MCSymbolData &Data = *MSD.SymbolData;
684 WriteSymbol(Writer, MSD, Layout);
685 if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
686 LastLocalSymbolIndex++;
690 // It is always valid to create a relocation with a symbol. It is preferable
691 // to use a relocation with a section if that is possible. Using the section
692 // allows us to omit some local symbols from the symbol table.
693 bool ELFObjectWriter::shouldRelocateWithSymbol(const MCAssembler &Asm,
694 const MCSymbolRefExpr *RefA,
695 const MCSymbolData *SD,
697 unsigned Type) const {
698 // A PCRel relocation to an absolute value has no symbol (or section). We
699 // represent that with a relocation to a null section.
703 MCSymbolRefExpr::VariantKind Kind = RefA->getKind();
707 // The .odp creation emits a relocation against the symbol ".TOC." which
708 // create a R_PPC64_TOC relocation. However the relocation symbol name
709 // in final object creation should be NULL, since the symbol does not
710 // really exist, it is just the reference to TOC base for the current
711 // object file. Since the symbol is undefined, returning false results
712 // in a relocation with a null section which is the desired result.
713 case MCSymbolRefExpr::VK_PPC_TOCBASE:
716 // These VariantKind cause the relocation to refer to something other than
717 // the symbol itself, like a linker generated table. Since the address of
718 // symbol is not relevant, we cannot replace the symbol with the
719 // section and patch the difference in the addend.
720 case MCSymbolRefExpr::VK_GOT:
721 case MCSymbolRefExpr::VK_PLT:
722 case MCSymbolRefExpr::VK_GOTPCREL:
723 case MCSymbolRefExpr::VK_Mips_GOT:
724 case MCSymbolRefExpr::VK_PPC_GOT_LO:
725 case MCSymbolRefExpr::VK_PPC_GOT_HI:
726 case MCSymbolRefExpr::VK_PPC_GOT_HA:
730 // An undefined symbol is not in any section, so the relocation has to point
731 // to the symbol itself.
732 const MCSymbol &Sym = SD->getSymbol();
733 if (Sym.isUndefined())
736 unsigned Binding = MCELF::GetBinding(*SD);
739 llvm_unreachable("Invalid Binding");
743 // If the symbol is weak, it might be overridden by a symbol in another
744 // file. The relocation has to point to the symbol so that the linker
747 case ELF::STB_GLOBAL:
748 // Global ELF symbols can be preempted by the dynamic linker. The relocation
749 // has to point to the symbol for a reason analogous to the STB_WEAK case.
753 // If a relocation points to a mergeable section, we have to be careful.
754 // If the offset is zero, a relocation with the section will encode the
755 // same information. With a non-zero offset, the situation is different.
756 // For example, a relocation can point 42 bytes past the end of a string.
757 // If we change such a relocation to use the section, the linker would think
758 // that it pointed to another string and subtracting 42 at runtime will
759 // produce the wrong value.
760 auto &Sec = cast<MCSectionELF>(Sym.getSection());
761 unsigned Flags = Sec.getFlags();
762 if (Flags & ELF::SHF_MERGE) {
766 // It looks like gold has a bug (http://sourceware.org/PR16794) and can
767 // only handle section relocations to mergeable sections if using RELA.
768 if (!hasRelocationAddend())
772 // Most TLS relocations use a got, so they need the symbol. Even those that
773 // are just an offset (@tpoff), require a symbol in some linkers (gold,
775 if (Flags & ELF::SHF_TLS)
778 // If the symbol is a thumb function the final relocation must set the lowest
779 // bit. With a symbol that is done by just having the symbol have that bit
780 // set, so we would lose the bit if we relocated with the section.
781 // FIXME: We could use the section but add the bit to the relocation value.
782 if (Asm.isThumbFunc(&Sym))
785 if (TargetObjectWriter->needsRelocateWithSymbol(Type))
790 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
791 const MCAsmLayout &Layout,
792 const MCFragment *Fragment,
793 const MCFixup &Fixup,
796 uint64_t &FixedValue) {
797 const MCSectionData *FixupSection = Fragment->getParent();
798 uint64_t C = Target.getConstant();
799 uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
801 if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
802 assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
803 "Should not have constructed this");
805 // Let A, B and C being the components of Target and R be the location of
806 // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
807 // If it is pcrel, we want to compute (A - B + C - R).
809 // In general, ELF has no relocations for -B. It can only represent (A + C)
810 // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
811 // replace B to implement it: (A - R - K + C)
813 Asm.getContext().FatalError(
815 "No relocation available to represent this relative expression");
817 const MCSymbol &SymB = RefB->getSymbol();
819 if (SymB.isUndefined())
820 Asm.getContext().FatalError(
822 Twine("symbol '") + SymB.getName() +
823 "' can not be undefined in a subtraction expression");
825 assert(!SymB.isAbsolute() && "Should have been folded");
826 const MCSection &SecB = SymB.getSection();
827 if (&SecB != &FixupSection->getSection())
828 Asm.getContext().FatalError(
829 Fixup.getLoc(), "Cannot represent a difference across sections");
831 const MCSymbolData &SymBD = Asm.getSymbolData(SymB);
832 uint64_t SymBOffset = Layout.getSymbolOffset(&SymBD);
833 uint64_t K = SymBOffset - FixupOffset;
838 // We either rejected the fixup or folded B into C at this point.
839 const MCSymbolRefExpr *RefA = Target.getSymA();
840 const MCSymbol *SymA = RefA ? &RefA->getSymbol() : nullptr;
841 const MCSymbolData *SymAD = SymA ? &Asm.getSymbolData(*SymA) : nullptr;
843 unsigned Type = GetRelocType(Target, Fixup, IsPCRel);
844 bool RelocateWithSymbol = shouldRelocateWithSymbol(Asm, RefA, SymAD, C, Type);
845 if (!RelocateWithSymbol && SymA && !SymA->isUndefined())
846 C += Layout.getSymbolOffset(SymAD);
849 if (hasRelocationAddend()) {
856 // FIXME: What is this!?!?
857 MCSymbolRefExpr::VariantKind Modifier =
858 RefA ? RefA->getKind() : MCSymbolRefExpr::VK_None;
859 if (RelocNeedsGOT(Modifier))
862 if (!RelocateWithSymbol) {
863 const MCSection *SecA =
864 (SymA && !SymA->isUndefined()) ? &SymA->getSection() : nullptr;
865 const MCSectionData *SecAD = SecA ? &Asm.getSectionData(*SecA) : nullptr;
866 ELFRelocationEntry Rec(FixupOffset, SecAD, Type, Addend);
867 Relocations[FixupSection].push_back(Rec);
872 if (const MCSymbol *R = Renames.lookup(SymA))
875 if (RefA->getKind() == MCSymbolRefExpr::VK_WEAKREF)
876 WeakrefUsedInReloc.insert(SymA);
878 UsedInReloc.insert(SymA);
880 ELFRelocationEntry Rec(FixupOffset, SymA, Type, Addend);
881 Relocations[FixupSection].push_back(Rec);
887 ELFObjectWriter::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
889 const MCSymbolData &SD = Asm.getSymbolData(*S);
890 return SD.getIndex();
893 bool ELFObjectWriter::isInSymtab(const MCAsmLayout &Layout,
894 const MCSymbolData &Data, bool Used,
896 const MCSymbol &Symbol = Data.getSymbol();
897 if (Symbol.isVariable()) {
898 const MCExpr *Expr = Symbol.getVariableValue();
899 if (const MCSymbolRefExpr *Ref = dyn_cast<MCSymbolRefExpr>(Expr)) {
900 if (Ref->getKind() == MCSymbolRefExpr::VK_WEAKREF)
911 if (Symbol.getName() == "_GLOBAL_OFFSET_TABLE_")
914 if (Symbol.isVariable()) {
915 const MCSymbol *Base = Layout.getBaseSymbol(Symbol);
916 if (Base && Base->isUndefined())
920 bool IsGlobal = MCELF::GetBinding(Data) == ELF::STB_GLOBAL;
921 if (!Symbol.isVariable() && Symbol.isUndefined() && !IsGlobal)
924 if (Symbol.isTemporary())
930 bool ELFObjectWriter::isLocal(const MCSymbolData &Data, bool isUsedInReloc) {
931 if (Data.isExternal())
934 const MCSymbol &Symbol = Data.getSymbol();
935 if (Symbol.isDefined())
944 void ELFObjectWriter::ComputeIndexMap(MCAssembler &Asm,
945 SectionIndexMapTy &SectionIndexMap,
946 const RelMapTy &RelMap) {
948 for (MCAssembler::iterator it = Asm.begin(),
949 ie = Asm.end(); it != ie; ++it) {
950 const MCSectionELF &Section =
951 static_cast<const MCSectionELF &>(it->getSection());
952 if (Section.getType() != ELF::SHT_GROUP)
954 SectionIndexMap[&Section] = Index++;
957 for (MCAssembler::iterator it = Asm.begin(),
958 ie = Asm.end(); it != ie; ++it) {
959 const MCSectionELF &Section =
960 static_cast<const MCSectionELF &>(it->getSection());
961 if (Section.getType() == ELF::SHT_GROUP ||
962 Section.getType() == ELF::SHT_REL ||
963 Section.getType() == ELF::SHT_RELA)
965 SectionIndexMap[&Section] = Index++;
966 const MCSectionELF *RelSection = RelMap.lookup(&Section);
968 SectionIndexMap[RelSection] = Index++;
973 ELFObjectWriter::computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
974 const SectionIndexMapTy &SectionIndexMap,
975 RevGroupMapTy RevGroupMap,
976 unsigned NumRegularSections) {
977 // FIXME: Is this the correct place to do this?
978 // FIXME: Why is an undefined reference to _GLOBAL_OFFSET_TABLE_ needed?
980 StringRef Name = "_GLOBAL_OFFSET_TABLE_";
981 MCSymbol *Sym = Asm.getContext().GetOrCreateSymbol(Name);
982 MCSymbolData &Data = Asm.getOrCreateSymbolData(*Sym);
983 Data.setExternal(true);
984 MCELF::SetBinding(Data, ELF::STB_GLOBAL);
987 // Add the data for the symbols.
988 for (MCSymbolData &SD : Asm.symbols()) {
989 const MCSymbol &Symbol = SD.getSymbol();
991 bool Used = UsedInReloc.count(&Symbol);
992 bool WeakrefUsed = WeakrefUsedInReloc.count(&Symbol);
993 bool isSignature = RevGroupMap.count(&Symbol);
995 if (!isInSymtab(Layout, SD,
996 Used || WeakrefUsed || isSignature,
997 Renames.count(&Symbol)))
1001 MSD.SymbolData = &SD;
1002 const MCSymbol *BaseSymbol = Layout.getBaseSymbol(Symbol);
1004 // Undefined symbols are global, but this is the first place we
1005 // are able to set it.
1006 bool Local = isLocal(SD, Used);
1007 if (!Local && MCELF::GetBinding(SD) == ELF::STB_LOCAL) {
1009 MCSymbolData &BaseData = Asm.getSymbolData(*BaseSymbol);
1010 MCELF::SetBinding(SD, ELF::STB_GLOBAL);
1011 MCELF::SetBinding(BaseData, ELF::STB_GLOBAL);
1015 MSD.SectionIndex = ELF::SHN_ABS;
1016 } else if (SD.isCommon()) {
1018 MSD.SectionIndex = ELF::SHN_COMMON;
1019 } else if (BaseSymbol->isUndefined()) {
1020 if (isSignature && !Used)
1021 MSD.SectionIndex = SectionIndexMap.lookup(RevGroupMap[&Symbol]);
1023 MSD.SectionIndex = ELF::SHN_UNDEF;
1024 if (!Used && WeakrefUsed)
1025 MCELF::SetBinding(SD, ELF::STB_WEAK);
1027 const MCSectionELF &Section =
1028 static_cast<const MCSectionELF&>(BaseSymbol->getSection());
1029 MSD.SectionIndex = SectionIndexMap.lookup(&Section);
1030 assert(MSD.SectionIndex && "Invalid section index!");
1033 // The @@@ in symbol version is replaced with @ in undefined symbols and
1034 // @@ in defined ones.
1035 StringRef Name = Symbol.getName();
1036 SmallString<32> Buf;
1037 size_t Pos = Name.find("@@@");
1038 if (Pos != StringRef::npos) {
1039 Buf += Name.substr(0, Pos);
1040 unsigned Skip = MSD.SectionIndex == ELF::SHN_UNDEF ? 2 : 1;
1041 Buf += Name.substr(Pos + Skip);
1044 MSD.Name = StrTabBuilder.add(Name);
1046 if (MSD.SectionIndex == ELF::SHN_UNDEF)
1047 UndefinedSymbolData.push_back(MSD);
1049 LocalSymbolData.push_back(MSD);
1051 ExternalSymbolData.push_back(MSD);
1054 for (auto i = Asm.file_names_begin(), e = Asm.file_names_end(); i != e; ++i)
1055 StrTabBuilder.add(*i);
1057 StrTabBuilder.finalize();
1059 for (auto i = Asm.file_names_begin(), e = Asm.file_names_end(); i != e; ++i)
1060 FileSymbolData.push_back(StrTabBuilder.getOffset(*i));
1062 for (ELFSymbolData& MSD : LocalSymbolData)
1063 MSD.StringIndex = StrTabBuilder.getOffset(MSD.Name);
1064 for (ELFSymbolData& MSD : ExternalSymbolData)
1065 MSD.StringIndex = StrTabBuilder.getOffset(MSD.Name);
1066 for (ELFSymbolData& MSD : UndefinedSymbolData)
1067 MSD.StringIndex = StrTabBuilder.getOffset(MSD.Name);
1069 // Symbols are required to be in lexicographic order.
1070 array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
1071 array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
1072 array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
1074 // Set the symbol indices. Local symbols must come before all other
1075 // symbols with non-local bindings.
1076 unsigned Index = FileSymbolData.size() + 1;
1077 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1078 LocalSymbolData[i].SymbolData->setIndex(Index++);
1080 Index += NumRegularSections;
1082 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1083 ExternalSymbolData[i].SymbolData->setIndex(Index++);
1084 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1085 UndefinedSymbolData[i].SymbolData->setIndex(Index++);
1088 void ELFObjectWriter::CreateRelocationSections(MCAssembler &Asm,
1089 MCAsmLayout &Layout,
1091 for (MCAssembler::const_iterator it = Asm.begin(),
1092 ie = Asm.end(); it != ie; ++it) {
1093 const MCSectionData &SD = *it;
1094 if (Relocations[&SD].empty())
1097 MCContext &Ctx = Asm.getContext();
1098 const MCSectionELF &Section =
1099 static_cast<const MCSectionELF&>(SD.getSection());
1101 const StringRef SectionName = Section.getSectionName();
1102 std::string RelaSectionName = hasRelocationAddend() ? ".rela" : ".rel";
1103 RelaSectionName += SectionName;
1106 if (hasRelocationAddend())
1107 EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
1109 EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
1112 StringRef Group = "";
1113 if (Section.getFlags() & ELF::SHF_GROUP) {
1114 Flags = ELF::SHF_GROUP;
1115 Group = Section.getGroup()->getName();
1118 const MCSectionELF *RelaSection =
1119 Ctx.getELFSection(RelaSectionName, hasRelocationAddend() ?
1120 ELF::SHT_RELA : ELF::SHT_REL, Flags,
1121 SectionKind::getReadOnly(),
1123 RelMap[&Section] = RelaSection;
1124 Asm.getOrCreateSectionData(*RelaSection);
1128 static SmallVector<char, 128>
1129 getUncompressedData(MCAsmLayout &Layout,
1130 MCSectionData::FragmentListType &Fragments) {
1131 SmallVector<char, 128> UncompressedData;
1132 for (const MCFragment &F : Fragments) {
1133 const SmallVectorImpl<char> *Contents;
1134 switch (F.getKind()) {
1135 case MCFragment::FT_Data:
1136 Contents = &cast<MCDataFragment>(F).getContents();
1138 case MCFragment::FT_Dwarf:
1139 Contents = &cast<MCDwarfLineAddrFragment>(F).getContents();
1141 case MCFragment::FT_DwarfFrame:
1142 Contents = &cast<MCDwarfCallFrameFragment>(F).getContents();
1146 "Not expecting any other fragment types in a debug_* section");
1148 UncompressedData.append(Contents->begin(), Contents->end());
1150 return UncompressedData;
1153 // Include the debug info compression header:
1154 // "ZLIB" followed by 8 bytes representing the uncompressed size of the section,
1155 // useful for consumers to preallocate a buffer to decompress into.
1157 prependCompressionHeader(uint64_t Size,
1158 SmallVectorImpl<char> &CompressedContents) {
1159 static const StringRef Magic = "ZLIB";
1160 if (Size <= Magic.size() + sizeof(Size) + CompressedContents.size())
1162 if (sys::IsLittleEndianHost)
1163 Size = sys::SwapByteOrder(Size);
1164 CompressedContents.insert(CompressedContents.begin(),
1165 Magic.size() + sizeof(Size), 0);
1166 std::copy(Magic.begin(), Magic.end(), CompressedContents.begin());
1167 std::copy(reinterpret_cast<char *>(&Size),
1168 reinterpret_cast<char *>(&Size + 1),
1169 CompressedContents.begin() + Magic.size());
1173 // Return a single fragment containing the compressed contents of the whole
1174 // section. Null if the section was not compressed for any reason.
1175 static std::unique_ptr<MCDataFragment>
1176 getCompressedFragment(MCAsmLayout &Layout,
1177 MCSectionData::FragmentListType &Fragments) {
1178 std::unique_ptr<MCDataFragment> CompressedFragment(new MCDataFragment());
1180 // Gather the uncompressed data from all the fragments, recording the
1181 // alignment fragment, if seen, and any fixups.
1182 SmallVector<char, 128> UncompressedData =
1183 getUncompressedData(Layout, Fragments);
1185 SmallVectorImpl<char> &CompressedContents = CompressedFragment->getContents();
1187 zlib::Status Success = zlib::compress(
1188 StringRef(UncompressedData.data(), UncompressedData.size()),
1189 CompressedContents);
1190 if (Success != zlib::StatusOK)
1193 if (!prependCompressionHeader(UncompressedData.size(), CompressedContents))
1196 return CompressedFragment;
1199 typedef DenseMap<const MCSectionData *, std::vector<MCSymbolData *>>
1202 static void UpdateSymbols(const MCAsmLayout &Layout,
1203 const std::vector<MCSymbolData *> &Symbols,
1204 MCFragment &NewFragment) {
1205 for (MCSymbolData *Sym : Symbols) {
1206 Sym->setOffset(Sym->getOffset() +
1207 Layout.getFragmentOffset(Sym->getFragment()));
1208 Sym->setFragment(&NewFragment);
1212 static void CompressDebugSection(MCAssembler &Asm, MCAsmLayout &Layout,
1213 const DefiningSymbolMap &DefiningSymbols,
1214 const MCSectionELF &Section,
1215 MCSectionData &SD) {
1216 StringRef SectionName = Section.getSectionName();
1217 MCSectionData::FragmentListType &Fragments = SD.getFragmentList();
1219 std::unique_ptr<MCDataFragment> CompressedFragment =
1220 getCompressedFragment(Layout, Fragments);
1222 // Leave the section as-is if the fragments could not be compressed.
1223 if (!CompressedFragment)
1226 // Update the fragment+offsets of any symbols referring to fragments in this
1227 // section to refer to the new fragment.
1228 auto I = DefiningSymbols.find(&SD);
1229 if (I != DefiningSymbols.end())
1230 UpdateSymbols(Layout, I->second, *CompressedFragment);
1232 // Invalidate the layout for the whole section since it will have new and
1233 // different fragments now.
1234 Layout.invalidateFragmentsFrom(&Fragments.front());
1237 // Complete the initialization of the new fragment
1238 CompressedFragment->setParent(&SD);
1239 CompressedFragment->setLayoutOrder(0);
1240 Fragments.push_back(CompressedFragment.release());
1242 // Rename from .debug_* to .zdebug_*
1243 Asm.getContext().renameELFSection(&Section,
1244 (".z" + SectionName.drop_front(1)).str());
1247 void ELFObjectWriter::CompressDebugSections(MCAssembler &Asm,
1248 MCAsmLayout &Layout) {
1249 if (!Asm.getContext().getAsmInfo()->compressDebugSections())
1252 DefiningSymbolMap DefiningSymbols;
1254 for (MCSymbolData &SD : Asm.symbols())
1255 if (MCFragment *F = SD.getFragment())
1256 DefiningSymbols[F->getParent()].push_back(&SD);
1258 for (MCSectionData &SD : Asm) {
1259 const MCSectionELF &Section =
1260 static_cast<const MCSectionELF &>(SD.getSection());
1261 StringRef SectionName = Section.getSectionName();
1263 // Compressing debug_frame requires handling alignment fragments which is
1264 // more work (possibly generalizing MCAssembler.cpp:writeFragment to allow
1265 // for writing to arbitrary buffers) for little benefit.
1266 if (!SectionName.startswith(".debug_") || SectionName == ".debug_frame")
1269 CompressDebugSection(Asm, Layout, DefiningSymbols, Section, SD);
1273 void ELFObjectWriter::WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout,
1274 const RelMapTy &RelMap) {
1275 for (MCAssembler::const_iterator it = Asm.begin(),
1276 ie = Asm.end(); it != ie; ++it) {
1277 const MCSectionData &SD = *it;
1278 const MCSectionELF &Section =
1279 static_cast<const MCSectionELF&>(SD.getSection());
1281 const MCSectionELF *RelaSection = RelMap.lookup(&Section);
1284 MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
1285 RelaSD.setAlignment(is64Bit() ? 8 : 4);
1287 MCDataFragment *F = new MCDataFragment(&RelaSD);
1288 WriteRelocationsFragment(Asm, F, &*it);
1292 void ELFObjectWriter::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
1293 uint64_t Flags, uint64_t Address,
1294 uint64_t Offset, uint64_t Size,
1295 uint32_t Link, uint32_t Info,
1297 uint64_t EntrySize) {
1298 Write32(Name); // sh_name: index into string table
1299 Write32(Type); // sh_type
1300 WriteWord(Flags); // sh_flags
1301 WriteWord(Address); // sh_addr
1302 WriteWord(Offset); // sh_offset
1303 WriteWord(Size); // sh_size
1304 Write32(Link); // sh_link
1305 Write32(Info); // sh_info
1306 WriteWord(Alignment); // sh_addralign
1307 WriteWord(EntrySize); // sh_entsize
1310 // ELF doesn't require relocations to be in any order. We sort by the r_offset,
1311 // just to match gnu as for easier comparison. The use type is an arbitrary way
1312 // of making the sort deterministic.
1313 static int cmpRel(const ELFRelocationEntry *AP, const ELFRelocationEntry *BP) {
1314 const ELFRelocationEntry &A = *AP;
1315 const ELFRelocationEntry &B = *BP;
1316 if (A.Offset != B.Offset)
1317 return B.Offset - A.Offset;
1318 if (B.Type != A.Type)
1319 return A.Type - B.Type;
1320 llvm_unreachable("ELFRelocs might be unstable!");
1323 static void sortRelocs(const MCAssembler &Asm,
1324 std::vector<ELFRelocationEntry> &Relocs) {
1325 array_pod_sort(Relocs.begin(), Relocs.end(), cmpRel);
1328 void ELFObjectWriter::WriteRelocationsFragment(const MCAssembler &Asm,
1330 const MCSectionData *SD) {
1331 std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
1333 sortRelocs(Asm, Relocs);
1335 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1336 const ELFRelocationEntry &Entry = Relocs[e - i - 1];
1339 if (Entry.UseSymbol) {
1340 Index = getSymbolIndexInSymbolTable(Asm, Entry.Symbol);
1342 const MCSectionData *Sec = Entry.Section;
1344 Index = Sec->getOrdinal() + FileSymbolData.size() +
1345 LocalSymbolData.size() + 1;
1351 write(*F, Entry.Offset);
1352 if (TargetObjectWriter->isN64()) {
1353 write(*F, uint32_t(Index));
1355 write(*F, TargetObjectWriter->getRSsym(Entry.Type));
1356 write(*F, TargetObjectWriter->getRType3(Entry.Type));
1357 write(*F, TargetObjectWriter->getRType2(Entry.Type));
1358 write(*F, TargetObjectWriter->getRType(Entry.Type));
1360 struct ELF::Elf64_Rela ERE64;
1361 ERE64.setSymbolAndType(Index, Entry.Type);
1362 write(*F, ERE64.r_info);
1364 if (hasRelocationAddend())
1365 write(*F, Entry.Addend);
1367 write(*F, uint32_t(Entry.Offset));
1369 struct ELF::Elf32_Rela ERE32;
1370 ERE32.setSymbolAndType(Index, Entry.Type);
1371 write(*F, ERE32.r_info);
1373 if (hasRelocationAddend())
1374 write(*F, uint32_t(Entry.Addend));
1379 void ELFObjectWriter::CreateMetadataSections(MCAssembler &Asm,
1380 MCAsmLayout &Layout,
1381 SectionIndexMapTy &SectionIndexMap,
1382 const RelMapTy &RelMap) {
1383 MCContext &Ctx = Asm.getContext();
1386 unsigned EntrySize = is64Bit() ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
1388 // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
1389 const MCSectionELF *ShstrtabSection =
1390 Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
1391 SectionKind::getReadOnly());
1392 MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
1393 ShstrtabSD.setAlignment(1);
1395 const MCSectionELF *SymtabSection =
1396 Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1397 SectionKind::getReadOnly(),
1399 MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
1400 SymtabSD.setAlignment(is64Bit() ? 8 : 4);
1402 const MCSectionELF *StrtabSection;
1403 StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
1404 SectionKind::getReadOnly());
1405 MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
1406 StrtabSD.setAlignment(1);
1408 ComputeIndexMap(Asm, SectionIndexMap, RelMap);
1410 ShstrtabIndex = SectionIndexMap.lookup(ShstrtabSection);
1411 SymbolTableIndex = SectionIndexMap.lookup(SymtabSection);
1412 StringTableIndex = SectionIndexMap.lookup(StrtabSection);
1415 F = new MCDataFragment(&SymtabSD);
1416 WriteSymbolTable(F, Asm, Layout, SectionIndexMap);
1418 F = new MCDataFragment(&StrtabSD);
1419 F->getContents().append(StrTabBuilder.data().begin(),
1420 StrTabBuilder.data().end());
1422 F = new MCDataFragment(&ShstrtabSD);
1424 // Section header string table.
1425 for (auto it = Asm.begin(), ie = Asm.end(); it != ie; ++it) {
1426 const MCSectionELF &Section =
1427 static_cast<const MCSectionELF&>(it->getSection());
1428 ShStrTabBuilder.add(Section.getSectionName());
1430 ShStrTabBuilder.finalize();
1431 F->getContents().append(ShStrTabBuilder.data().begin(),
1432 ShStrTabBuilder.data().end());
1435 void ELFObjectWriter::CreateIndexedSections(MCAssembler &Asm,
1436 MCAsmLayout &Layout,
1437 GroupMapTy &GroupMap,
1438 RevGroupMapTy &RevGroupMap,
1439 SectionIndexMapTy &SectionIndexMap,
1440 const RelMapTy &RelMap) {
1441 // Create the .note.GNU-stack section if needed.
1442 MCContext &Ctx = Asm.getContext();
1443 if (Asm.getNoExecStack()) {
1444 const MCSectionELF *GnuStackSection =
1445 Ctx.getELFSection(".note.GNU-stack", ELF::SHT_PROGBITS, 0,
1446 SectionKind::getReadOnly());
1447 Asm.getOrCreateSectionData(*GnuStackSection);
1451 for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1453 const MCSectionELF &Section =
1454 static_cast<const MCSectionELF&>(it->getSection());
1455 if (!(Section.getFlags() & ELF::SHF_GROUP))
1458 const MCSymbol *SignatureSymbol = Section.getGroup();
1459 Asm.getOrCreateSymbolData(*SignatureSymbol);
1460 const MCSectionELF *&Group = RevGroupMap[SignatureSymbol];
1462 Group = Ctx.CreateELFGroupSection();
1463 MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1464 Data.setAlignment(4);
1465 MCDataFragment *F = new MCDataFragment(&Data);
1466 write(*F, uint32_t(ELF::GRP_COMDAT));
1468 GroupMap[Group] = SignatureSymbol;
1471 ComputeIndexMap(Asm, SectionIndexMap, RelMap);
1473 // Add sections to the groups
1474 for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1476 const MCSectionELF &Section =
1477 static_cast<const MCSectionELF&>(it->getSection());
1478 if (!(Section.getFlags() & ELF::SHF_GROUP))
1480 const MCSectionELF *Group = RevGroupMap[Section.getGroup()];
1481 MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1482 // FIXME: we could use the previous fragment
1483 MCDataFragment *F = new MCDataFragment(&Data);
1484 uint32_t Index = SectionIndexMap.lookup(&Section);
1489 void ELFObjectWriter::WriteSection(MCAssembler &Asm,
1490 const SectionIndexMapTy &SectionIndexMap,
1491 uint32_t GroupSymbolIndex,
1492 uint64_t Offset, uint64_t Size,
1494 const MCSectionELF &Section) {
1495 uint64_t sh_link = 0;
1496 uint64_t sh_info = 0;
1498 switch(Section.getType()) {
1499 case ELF::SHT_DYNAMIC:
1500 sh_link = ShStrTabBuilder.getOffset(Section.getSectionName());
1505 case ELF::SHT_RELA: {
1506 const MCSectionELF *SymtabSection;
1507 const MCSectionELF *InfoSection;
1508 SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB,
1510 SectionKind::getReadOnly());
1511 sh_link = SectionIndexMap.lookup(SymtabSection);
1512 assert(sh_link && ".symtab not found");
1514 // Remove ".rel" and ".rela" prefixes.
1515 unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1516 StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1517 StringRef GroupName =
1518 Section.getGroup() ? Section.getGroup()->getName() : "";
1520 InfoSection = Asm.getContext().getELFSection(SectionName, ELF::SHT_PROGBITS,
1521 0, SectionKind::getReadOnly(),
1523 sh_info = SectionIndexMap.lookup(InfoSection);
1527 case ELF::SHT_SYMTAB:
1528 case ELF::SHT_DYNSYM:
1529 sh_link = StringTableIndex;
1530 sh_info = LastLocalSymbolIndex;
1533 case ELF::SHT_SYMTAB_SHNDX:
1534 sh_link = SymbolTableIndex;
1537 case ELF::SHT_PROGBITS:
1538 case ELF::SHT_STRTAB:
1539 case ELF::SHT_NOBITS:
1542 case ELF::SHT_ARM_ATTRIBUTES:
1543 case ELF::SHT_INIT_ARRAY:
1544 case ELF::SHT_FINI_ARRAY:
1545 case ELF::SHT_PREINIT_ARRAY:
1546 case ELF::SHT_X86_64_UNWIND:
1547 case ELF::SHT_MIPS_REGINFO:
1548 case ELF::SHT_MIPS_OPTIONS:
1552 case ELF::SHT_GROUP:
1553 sh_link = SymbolTableIndex;
1554 sh_info = GroupSymbolIndex;
1558 assert(0 && "FIXME: sh_type value not supported!");
1562 if (TargetObjectWriter->getEMachine() == ELF::EM_ARM &&
1563 Section.getType() == ELF::SHT_ARM_EXIDX) {
1564 StringRef SecName(Section.getSectionName());
1565 if (SecName == ".ARM.exidx") {
1566 sh_link = SectionIndexMap.lookup(
1567 Asm.getContext().getELFSection(".text",
1569 ELF::SHF_EXECINSTR | ELF::SHF_ALLOC,
1570 SectionKind::getText()));
1571 } else if (SecName.startswith(".ARM.exidx")) {
1572 StringRef GroupName =
1573 Section.getGroup() ? Section.getGroup()->getName() : "";
1574 sh_link = SectionIndexMap.lookup(Asm.getContext().getELFSection(
1575 SecName.substr(sizeof(".ARM.exidx") - 1), ELF::SHT_PROGBITS,
1576 ELF::SHF_EXECINSTR | ELF::SHF_ALLOC, SectionKind::getText(), 0,
1581 WriteSecHdrEntry(ShStrTabBuilder.getOffset(Section.getSectionName()),
1583 Section.getFlags(), 0, Offset, Size, sh_link, sh_info,
1584 Alignment, Section.getEntrySize());
1587 bool ELFObjectWriter::IsELFMetaDataSection(const MCSectionData &SD) {
1588 return SD.getOrdinal() == ~UINT32_C(0) &&
1589 !SD.getSection().isVirtualSection();
1592 uint64_t ELFObjectWriter::DataSectionSize(const MCSectionData &SD) {
1594 for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1596 const MCFragment &F = *i;
1597 assert(F.getKind() == MCFragment::FT_Data);
1598 Ret += cast<MCDataFragment>(F).getContents().size();
1603 uint64_t ELFObjectWriter::GetSectionFileSize(const MCAsmLayout &Layout,
1604 const MCSectionData &SD) {
1605 if (IsELFMetaDataSection(SD))
1606 return DataSectionSize(SD);
1607 return Layout.getSectionFileSize(&SD);
1610 uint64_t ELFObjectWriter::GetSectionAddressSize(const MCAsmLayout &Layout,
1611 const MCSectionData &SD) {
1612 if (IsELFMetaDataSection(SD))
1613 return DataSectionSize(SD);
1614 return Layout.getSectionAddressSize(&SD);
1617 void ELFObjectWriter::WriteDataSectionData(MCAssembler &Asm,
1618 const MCAsmLayout &Layout,
1619 const MCSectionELF &Section) {
1620 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1622 uint64_t Padding = OffsetToAlignment(OS.tell(), SD.getAlignment());
1623 WriteZeros(Padding);
1625 if (IsELFMetaDataSection(SD)) {
1626 for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1628 const MCFragment &F = *i;
1629 assert(F.getKind() == MCFragment::FT_Data);
1630 WriteBytes(cast<MCDataFragment>(F).getContents());
1633 Asm.writeSectionData(&SD, Layout);
1637 void ELFObjectWriter::WriteSectionHeader(MCAssembler &Asm,
1638 const GroupMapTy &GroupMap,
1639 const MCAsmLayout &Layout,
1640 const SectionIndexMapTy &SectionIndexMap,
1641 const SectionOffsetMapTy &SectionOffsetMap) {
1642 const unsigned NumSections = Asm.size() + 1;
1644 std::vector<const MCSectionELF*> Sections;
1645 Sections.resize(NumSections - 1);
1647 for (SectionIndexMapTy::const_iterator i=
1648 SectionIndexMap.begin(), e = SectionIndexMap.end(); i != e; ++i) {
1649 const std::pair<const MCSectionELF*, uint32_t> &p = *i;
1650 Sections[p.second - 1] = p.first;
1653 // Null section first.
1654 uint64_t FirstSectionSize =
1655 NumSections >= ELF::SHN_LORESERVE ? NumSections : 0;
1656 uint32_t FirstSectionLink =
1657 ShstrtabIndex >= ELF::SHN_LORESERVE ? ShstrtabIndex : 0;
1658 WriteSecHdrEntry(0, 0, 0, 0, 0, FirstSectionSize, FirstSectionLink, 0, 0, 0);
1660 for (unsigned i = 0; i < NumSections - 1; ++i) {
1661 const MCSectionELF &Section = *Sections[i];
1662 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1663 uint32_t GroupSymbolIndex;
1664 if (Section.getType() != ELF::SHT_GROUP)
1665 GroupSymbolIndex = 0;
1667 GroupSymbolIndex = getSymbolIndexInSymbolTable(Asm,
1668 GroupMap.lookup(&Section));
1670 uint64_t Size = GetSectionAddressSize(Layout, SD);
1672 WriteSection(Asm, SectionIndexMap, GroupSymbolIndex,
1673 SectionOffsetMap.lookup(&Section), Size,
1674 SD.getAlignment(), Section);
1678 void ELFObjectWriter::ComputeSectionOrder(MCAssembler &Asm,
1679 std::vector<const MCSectionELF*> &Sections) {
1680 for (MCAssembler::iterator it = Asm.begin(),
1681 ie = Asm.end(); it != ie; ++it) {
1682 const MCSectionELF &Section =
1683 static_cast<const MCSectionELF &>(it->getSection());
1684 if (Section.getType() == ELF::SHT_GROUP)
1685 Sections.push_back(&Section);
1688 for (MCAssembler::iterator it = Asm.begin(),
1689 ie = Asm.end(); it != ie; ++it) {
1690 const MCSectionELF &Section =
1691 static_cast<const MCSectionELF &>(it->getSection());
1692 if (Section.getType() != ELF::SHT_GROUP &&
1693 Section.getType() != ELF::SHT_REL &&
1694 Section.getType() != ELF::SHT_RELA)
1695 Sections.push_back(&Section);
1698 for (MCAssembler::iterator it = Asm.begin(),
1699 ie = Asm.end(); it != ie; ++it) {
1700 const MCSectionELF &Section =
1701 static_cast<const MCSectionELF &>(it->getSection());
1702 if (Section.getType() == ELF::SHT_REL ||
1703 Section.getType() == ELF::SHT_RELA)
1704 Sections.push_back(&Section);
1708 void ELFObjectWriter::WriteObject(MCAssembler &Asm,
1709 const MCAsmLayout &Layout) {
1710 GroupMapTy GroupMap;
1711 RevGroupMapTy RevGroupMap;
1712 SectionIndexMapTy SectionIndexMap;
1714 unsigned NumUserSections = Asm.size();
1716 CompressDebugSections(Asm, const_cast<MCAsmLayout &>(Layout));
1718 DenseMap<const MCSectionELF*, const MCSectionELF*> RelMap;
1719 CreateRelocationSections(Asm, const_cast<MCAsmLayout&>(Layout), RelMap);
1721 const unsigned NumUserAndRelocSections = Asm.size();
1722 CreateIndexedSections(Asm, const_cast<MCAsmLayout&>(Layout), GroupMap,
1723 RevGroupMap, SectionIndexMap, RelMap);
1724 const unsigned AllSections = Asm.size();
1725 const unsigned NumIndexedSections = AllSections - NumUserAndRelocSections;
1727 unsigned NumRegularSections = NumUserSections + NumIndexedSections;
1729 // Compute symbol table information.
1730 computeSymbolTable(Asm, Layout, SectionIndexMap, RevGroupMap,
1731 NumRegularSections);
1733 WriteRelocations(Asm, const_cast<MCAsmLayout&>(Layout), RelMap);
1735 CreateMetadataSections(const_cast<MCAssembler&>(Asm),
1736 const_cast<MCAsmLayout&>(Layout),
1740 uint64_t NaturalAlignment = is64Bit() ? 8 : 4;
1741 uint64_t HeaderSize = is64Bit() ? sizeof(ELF::Elf64_Ehdr) :
1742 sizeof(ELF::Elf32_Ehdr);
1743 uint64_t FileOff = HeaderSize;
1745 std::vector<const MCSectionELF*> Sections;
1746 ComputeSectionOrder(Asm, Sections);
1747 unsigned NumSections = Sections.size();
1748 SectionOffsetMapTy SectionOffsetMap;
1749 for (unsigned i = 0; i < NumRegularSections + 1; ++i) {
1750 const MCSectionELF &Section = *Sections[i];
1751 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1753 FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1755 // Remember the offset into the file for this section.
1756 SectionOffsetMap[&Section] = FileOff;
1758 // Get the size of the section in the output file (including padding).
1759 FileOff += GetSectionFileSize(Layout, SD);
1762 FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
1764 const unsigned SectionHeaderOffset = FileOff - HeaderSize;
1766 uint64_t SectionHeaderEntrySize = is64Bit() ?
1767 sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr);
1768 FileOff += (NumSections + 1) * SectionHeaderEntrySize;
1770 for (unsigned i = NumRegularSections + 1; i < NumSections; ++i) {
1771 const MCSectionELF &Section = *Sections[i];
1772 const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1774 FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1776 // Remember the offset into the file for this section.
1777 SectionOffsetMap[&Section] = FileOff;
1779 // Get the size of the section in the output file (including padding).
1780 FileOff += GetSectionFileSize(Layout, SD);
1783 // Write out the ELF header ...
1784 WriteHeader(Asm, SectionHeaderOffset, NumSections + 1);
1786 // ... then the regular sections ...
1787 // + because of .shstrtab
1788 for (unsigned i = 0; i < NumRegularSections + 1; ++i)
1789 WriteDataSectionData(Asm, Layout, *Sections[i]);
1791 uint64_t Padding = OffsetToAlignment(OS.tell(), NaturalAlignment);
1792 WriteZeros(Padding);
1794 // ... then the section header table ...
1795 WriteSectionHeader(Asm, GroupMap, Layout, SectionIndexMap,
1798 // ... and then the remaining sections ...
1799 for (unsigned i = NumRegularSections + 1; i < NumSections; ++i)
1800 WriteDataSectionData(Asm, Layout, *Sections[i]);
1804 ELFObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
1805 const MCSymbolData &DataA,
1806 const MCFragment &FB,
1808 bool IsPCRel) const {
1809 if (DataA.getFlags() & ELF_STB_Weak || MCELF::GetType(DataA) == ELF::STT_GNU_IFUNC)
1811 return MCObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
1812 Asm, DataA, FB,InSet, IsPCRel);
1815 MCObjectWriter *llvm::createELFObjectWriter(MCELFObjectTargetWriter *MOTW,
1817 bool IsLittleEndian) {
1818 return new ELFObjectWriter(MOTW, OS, IsLittleEndian);