contrib/llvm/lib/MC/ELFObjectWriter.cpp

   1 //===- lib/MC/ELFObjectWriter.cpp - ELF File Writer -----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements ELF object file writer information.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/ADT/ArrayRef.h"
  15 #include "llvm/ADT/DenseMap.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/ADT/SmallString.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/ADT/Twine.h"
  21 #include "llvm/BinaryFormat/ELF.h"
  22 #include "llvm/MC/MCAsmInfo.h"
  23 #include "llvm/MC/MCAsmLayout.h"
  24 #include "llvm/MC/MCAssembler.h"
  25 #include "llvm/MC/MCContext.h"
  26 #include "llvm/MC/MCELFObjectWriter.h"
  27 #include "llvm/MC/MCExpr.h"
  28 #include "llvm/MC/MCFixup.h"
  29 #include "llvm/MC/MCFragment.h"
  30 #include "llvm/MC/MCObjectWriter.h"
  31 #include "llvm/MC/MCSection.h"
  32 #include "llvm/MC/MCSectionELF.h"
  33 #include "llvm/MC/MCSymbol.h"
  34 #include "llvm/MC/MCSymbolELF.h"
  35 #include "llvm/MC/MCValue.h"
  36 #include "llvm/MC/StringTableBuilder.h"
  37 #include "llvm/Support/Allocator.h"
  38 #include "llvm/Support/Casting.h"
  39 #include "llvm/Support/Compression.h"
  40 #include "llvm/Support/Endian.h"
  41 #include "llvm/Support/Error.h"
  42 #include "llvm/Support/ErrorHandling.h"
  43 #include "llvm/Support/Host.h"
  44 #include "llvm/Support/MathExtras.h"
  45 #include "llvm/Support/SMLoc.h"
  46 #include "llvm/Support/StringSaver.h"
  47 #include "llvm/Support/SwapByteOrder.h"
  48 #include "llvm/Support/raw_ostream.h"
  49 #include <algorithm>
  50 #include <cassert>
  51 #include <cstddef>
  52 #include <cstdint>
  53 #include <map>
  54 #include <memory>
  55 #include <string>
  56 #include <utility>
  57 #include <vector>
  58
  59 using namespace llvm;
  60
  61 #undef  DEBUG_TYPE
  62 #define DEBUG_TYPE "reloc-info"
  63
  64 namespace {
  65
  66 using SectionIndexMapTy = DenseMap<const MCSectionELF *, uint32_t>;
  67
  68 class ELFObjectWriter;
  69
  70 class SymbolTableWriter {
  71   ELFObjectWriter &EWriter;
  72   bool Is64Bit;
  73
  74   // indexes we are going to write to .symtab_shndx.
  75   std::vector<uint32_t> ShndxIndexes;
  76
  77   // The numbel of symbols written so far.
  78   unsigned NumWritten;
  79
  80   void createSymtabShndx();
  81
  82   template <typename T> void write(T Value);
  83
  84 public:
  85   SymbolTableWriter(ELFObjectWriter &EWriter, bool Is64Bit);
  86
  87   void writeSymbol(uint32_t name, uint8_t info, uint64_t value, uint64_t size,
  88                    uint8_t other, uint32_t shndx, bool Reserved);
  89
  90   ArrayRef<uint32_t> getShndxIndexes() const { return ShndxIndexes; }
  91 };
  92
  93 class ELFObjectWriter : public MCObjectWriter {
  94   static uint64_t SymbolValue(const MCSymbol &Sym, const MCAsmLayout &Layout);
  95   static bool isInSymtab(const MCAsmLayout &Layout, const MCSymbolELF &Symbol,
  96                          bool Used, bool Renamed);
  97
  98   /// Helper struct for containing some precomputed information on symbols.
  99   struct ELFSymbolData {
 100     const MCSymbolELF *Symbol;
 101     uint32_t SectionIndex;
 102     StringRef Name;
 103
 104     // Support lexicographic sorting.
 105     bool operator<(const ELFSymbolData &RHS) const {
 106       unsigned LHSType = Symbol->getType();
 107       unsigned RHSType = RHS.Symbol->getType();
 108       if (LHSType == ELF::STT_SECTION && RHSType != ELF::STT_SECTION)
 109         return false;
 110       if (LHSType != ELF::STT_SECTION && RHSType == ELF::STT_SECTION)
 111         return true;
 112       if (LHSType == ELF::STT_SECTION && RHSType == ELF::STT_SECTION)
 113         return SectionIndex < RHS.SectionIndex;
 114       return Name < RHS.Name;
 115     }
 116   };
 117
 118   /// The target specific ELF writer instance.
 119   std::unique_ptr<MCELFObjectTargetWriter> TargetObjectWriter;
 120
 121   DenseMap<const MCSymbolELF *, const MCSymbolELF *> Renames;
 122
 123   DenseMap<const MCSectionELF *, std::vector<ELFRelocationEntry>> Relocations;
 124
 125   /// @}
 126   /// @name Symbol Table Data
 127   /// @{
 128
 129   BumpPtrAllocator Alloc;
 130   StringSaver VersionSymSaver{Alloc};
 131   StringTableBuilder StrTabBuilder{StringTableBuilder::ELF};
 132
 133   /// @}
 134
 135   // This holds the symbol table index of the last local symbol.
 136   unsigned LastLocalSymbolIndex;
 137   // This holds the .strtab section index.
 138   unsigned StringTableIndex;
 139   // This holds the .symtab section index.
 140   unsigned SymbolTableIndex;
 141
 142   // Sections in the order they are to be output in the section table.
 143   std::vector<const MCSectionELF *> SectionTable;
 144   unsigned addToSectionTable(const MCSectionELF *Sec);
 145
 146   // TargetObjectWriter wrappers.
 147   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
 148   bool hasRelocationAddend() const {
 149     return TargetObjectWriter->hasRelocationAddend();
 150   }
 151   unsigned getRelocType(MCContext &Ctx, const MCValue &Target,
 152                         const MCFixup &Fixup, bool IsPCRel) const {
 153     return TargetObjectWriter->getRelocType(Ctx, Target, Fixup, IsPCRel);
 154   }
 155
 156   void align(unsigned Alignment);
 157
 158   bool maybeWriteCompression(uint64_t Size,
 159                              SmallVectorImpl<char> &CompressedContents,
 160                              bool ZLibStyle, unsigned Alignment);
 161
 162 public:
 163   ELFObjectWriter(MCELFObjectTargetWriter *MOTW, raw_pwrite_stream &OS,
 164                   bool IsLittleEndian)
 165       : MCObjectWriter(OS, IsLittleEndian), TargetObjectWriter(MOTW) {}
 166
 167   ~ELFObjectWriter() override = default;
 168
 169   void reset() override {
 170     Renames.clear();
 171     Relocations.clear();
 172     StrTabBuilder.clear();
 173     SectionTable.clear();
 174     MCObjectWriter::reset();
 175   }
 176
 177   void WriteWord(uint64_t W) {
 178     if (is64Bit())
 179       write64(W);
 180     else
 181       write32(W);
 182   }
 183
 184   template <typename T> void write(T Val) {
 185     if (IsLittleEndian)
 186       support::endian::Writer<support::little>(getStream()).write(Val);
 187     else
 188       support::endian::Writer<support::big>(getStream()).write(Val);
 189   }
 190
 191   void writeHeader(const MCAssembler &Asm);
 192
 193   void writeSymbol(SymbolTableWriter &Writer, uint32_t StringIndex,
 194                    ELFSymbolData &MSD, const MCAsmLayout &Layout);
 195
 196   // Start and end offset of each section
 197   using SectionOffsetsTy =
 198       std::map<const MCSectionELF *, std::pair<uint64_t, uint64_t>>;
 199
 200   bool shouldRelocateWithSymbol(const MCAssembler &Asm,
 201                                 const MCSymbolRefExpr *RefA,
 202                                 const MCSymbol *Sym, uint64_t C,
 203                                 unsigned Type) const;
 204
 205   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
 206                         const MCFragment *Fragment, const MCFixup &Fixup,
 207                         MCValue Target, bool &IsPCRel,
 208                         uint64_t &FixedValue) override;
 209
 210   // Map from a signature symbol to the group section index
 211   using RevGroupMapTy = DenseMap<const MCSymbol *, unsigned>;
 212
 213   /// Compute the symbol table data
 214   ///
 215   /// \param Asm - The assembler.
 216   /// \param SectionIndexMap - Maps a section to its index.
 217   /// \param RevGroupMap - Maps a signature symbol to the group section.
 218   void computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
 219                           const SectionIndexMapTy &SectionIndexMap,
 220                           const RevGroupMapTy &RevGroupMap,
 221                           SectionOffsetsTy &SectionOffsets);
 222
 223   MCSectionELF *createRelocationSection(MCContext &Ctx,
 224                                         const MCSectionELF &Sec);
 225
 226   const MCSectionELF *createStringTable(MCContext &Ctx);
 227
 228   void executePostLayoutBinding(MCAssembler &Asm,
 229                                 const MCAsmLayout &Layout) override;
 230
 231   void writeSectionHeader(const MCAsmLayout &Layout,
 232                           const SectionIndexMapTy &SectionIndexMap,
 233                           const SectionOffsetsTy &SectionOffsets);
 234
 235   void writeSectionData(const MCAssembler &Asm, MCSection &Sec,
 236                         const MCAsmLayout &Layout);
 237
 238   void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
 239                         uint64_t Address, uint64_t Offset, uint64_t Size,
 240                         uint32_t Link, uint32_t Info, uint64_t Alignment,
 241                         uint64_t EntrySize);
 242
 243   void writeRelocations(const MCAssembler &Asm, const MCSectionELF &Sec);
 244
 245   using MCObjectWriter::isSymbolRefDifferenceFullyResolvedImpl;
 246   bool isSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
 247                                               const MCSymbol &SymA,
 248                                               const MCFragment &FB, bool InSet,
 249                                               bool IsPCRel) const override;
 250
 251   void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
 252   void writeSection(const SectionIndexMapTy &SectionIndexMap,
 253                     uint32_t GroupSymbolIndex, uint64_t Offset, uint64_t Size,
 254                     const MCSectionELF &Section);
 255 };
 256
 257 } // end anonymous namespace
 258
 259 void ELFObjectWriter::align(unsigned Alignment) {
 260   uint64_t Padding = OffsetToAlignment(getStream().tell(), Alignment);
 261   WriteZeros(Padding);
 262 }
 263
 264 unsigned ELFObjectWriter::addToSectionTable(const MCSectionELF *Sec) {
 265   SectionTable.push_back(Sec);
 266   StrTabBuilder.add(Sec->getSectionName());
 267   return SectionTable.size();
 268 }
 269
 270 void SymbolTableWriter::createSymtabShndx() {
 271   if (!ShndxIndexes.empty())
 272     return;
 273
 274   ShndxIndexes.resize(NumWritten);
 275 }
 276
 277 template <typename T> void SymbolTableWriter::write(T Value) {
 278   EWriter.write(Value);
 279 }
 280
 281 SymbolTableWriter::SymbolTableWriter(ELFObjectWriter &EWriter, bool Is64Bit)
 282     : EWriter(EWriter), Is64Bit(Is64Bit), NumWritten(0) {}
 283
 284 void SymbolTableWriter::writeSymbol(uint32_t name, uint8_t info, uint64_t value,
 285                                     uint64_t size, uint8_t other,
 286                                     uint32_t shndx, bool Reserved) {
 287   bool LargeIndex = shndx >= ELF::SHN_LORESERVE && !Reserved;
 288
 289   if (LargeIndex)
 290     createSymtabShndx();
 291
 292   if (!ShndxIndexes.empty()) {
 293     if (LargeIndex)
 294       ShndxIndexes.push_back(shndx);
 295     else
 296       ShndxIndexes.push_back(0);
 297   }
 298
 299   uint16_t Index = LargeIndex ? uint16_t(ELF::SHN_XINDEX) : shndx;
 300
 301   if (Is64Bit) {
 302     write(name);  // st_name
 303     write(info);  // st_info
 304     write(other); // st_other
 305     write(Index); // st_shndx
 306     write(value); // st_value
 307     write(size);  // st_size
 308   } else {
 309     write(name);            // st_name
 310     write(uint32_t(value)); // st_value
 311     write(uint32_t(size));  // st_size
 312     write(info);            // st_info
 313     write(other);           // st_other
 314     write(Index);           // st_shndx
 315   }
 316
 317   ++NumWritten;
 318 }
 319
 320 // Emit the ELF header.
 321 void ELFObjectWriter::writeHeader(const MCAssembler &Asm) {
 322   // ELF Header
 323   // ----------
 324   //
 325   // Note
 326   // ----
 327   // emitWord method behaves differently for ELF32 and ELF64, writing
 328   // 4 bytes in the former and 8 in the latter.
 329
 330   writeBytes(ELF::ElfMagic); // e_ident[EI_MAG0] to e_ident[EI_MAG3]
 331
 332   write8(is64Bit() ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
 333
 334   // e_ident[EI_DATA]
 335   write8(isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
 336
 337   write8(ELF::EV_CURRENT);        // e_ident[EI_VERSION]
 338   // e_ident[EI_OSABI]
 339   write8(TargetObjectWriter->getOSABI());
 340   write8(0);                  // e_ident[EI_ABIVERSION]
 341
 342   WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
 343
 344   write16(ELF::ET_REL);             // e_type
 345
 346   write16(TargetObjectWriter->getEMachine()); // e_machine = target
 347
 348   write32(ELF::EV_CURRENT);         // e_version
 349   WriteWord(0);                    // e_entry, no entry point in .o file
 350   WriteWord(0);                    // e_phoff, no program header for .o
 351   WriteWord(0);                     // e_shoff = sec hdr table off in bytes
 352
 353   // e_flags = whatever the target wants
 354   write32(Asm.getELFHeaderEFlags());
 355
 356   // e_ehsize = ELF header size
 357   write16(is64Bit() ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
 358
 359   write16(0);                  // e_phentsize = prog header entry size
 360   write16(0);                  // e_phnum = # prog header entries = 0
 361
 362   // e_shentsize = Section header entry size
 363   write16(is64Bit() ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
 364
 365   // e_shnum     = # of section header ents
 366   write16(0);
 367
 368   // e_shstrndx  = Section # of '.shstrtab'
 369   assert(StringTableIndex < ELF::SHN_LORESERVE);
 370   write16(StringTableIndex);
 371 }
 372
 373 uint64_t ELFObjectWriter::SymbolValue(const MCSymbol &Sym,
 374                                       const MCAsmLayout &Layout) {
 375   if (Sym.isCommon() && Sym.isExternal())
 376     return Sym.getCommonAlignment();
 377
 378   uint64_t Res;
 379   if (!Layout.getSymbolOffset(Sym, Res))
 380     return 0;
 381
 382   if (Layout.getAssembler().isThumbFunc(&Sym))
 383     Res |= 1;
 384
 385   return Res;
 386 }
 387
 388 void ELFObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
 389                                                const MCAsmLayout &Layout) {
 390   // The presence of symbol versions causes undefined symbols and
 391   // versions declared with @@@ to be renamed.
 392   for (const MCSymbol &A : Asm.symbols()) {
 393     const auto &Alias = cast<MCSymbolELF>(A);
 394     // Not an alias.
 395     if (!Alias.isVariable())
 396       continue;
 397     auto *Ref = dyn_cast<MCSymbolRefExpr>(Alias.getVariableValue());
 398     if (!Ref)
 399       continue;
 400     const auto &Symbol = cast<MCSymbolELF>(Ref->getSymbol());
 401
 402     StringRef AliasName = Alias.getName();
 403     size_t Pos = AliasName.find('@');
 404     if (Pos == StringRef::npos)
 405       continue;
 406
 407     // Aliases defined with .symvar copy the binding from the symbol they alias.
 408     // This is the first place we are able to copy this information.
 409     Alias.setExternal(Symbol.isExternal());
 410     Alias.setBinding(Symbol.getBinding());
 411
 412     StringRef Rest = AliasName.substr(Pos);
 413     if (!Symbol.isUndefined() && !Rest.startswith("@@@"))
 414       continue;
 415
 416     // FIXME: produce a better error message.
 417     if (Symbol.isUndefined() && Rest.startswith("@@") &&
 418         !Rest.startswith("@@@"))
 419       report_fatal_error("A @@ version cannot be undefined");
 420
 421     Renames.insert(std::make_pair(&Symbol, &Alias));
 422   }
 423 }
 424
 425 static uint8_t mergeTypeForSet(uint8_t origType, uint8_t newType) {
 426   uint8_t Type = newType;
 427
 428   // Propagation rules:
 429   // IFUNC > FUNC > OBJECT > NOTYPE
 430   // TLS_OBJECT > OBJECT > NOTYPE
 431   //
 432   // dont let the new type degrade the old type
 433   switch (origType) {
 434   default:
 435     break;
 436   case ELF::STT_GNU_IFUNC:
 437     if (Type == ELF::STT_FUNC || Type == ELF::STT_OBJECT ||
 438         Type == ELF::STT_NOTYPE || Type == ELF::STT_TLS)
 439       Type = ELF::STT_GNU_IFUNC;
 440     break;
 441   case ELF::STT_FUNC:
 442     if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
 443         Type == ELF::STT_TLS)
 444       Type = ELF::STT_FUNC;
 445     break;
 446   case ELF::STT_OBJECT:
 447     if (Type == ELF::STT_NOTYPE)
 448       Type = ELF::STT_OBJECT;
 449     break;
 450   case ELF::STT_TLS:
 451     if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
 452         Type == ELF::STT_GNU_IFUNC || Type == ELF::STT_FUNC)
 453       Type = ELF::STT_TLS;
 454     break;
 455   }
 456
 457   return Type;
 458 }
 459
 460 void ELFObjectWriter::writeSymbol(SymbolTableWriter &Writer,
 461                                   uint32_t StringIndex, ELFSymbolData &MSD,
 462                                   const MCAsmLayout &Layout) {
 463   const auto &Symbol = cast<MCSymbolELF>(*MSD.Symbol);
 464   const MCSymbolELF *Base =
 465       cast_or_null<MCSymbolELF>(Layout.getBaseSymbol(Symbol));
 466
 467   // This has to be in sync with when computeSymbolTable uses SHN_ABS or
 468   // SHN_COMMON.
 469   bool IsReserved = !Base || Symbol.isCommon();
 470
 471   // Binding and Type share the same byte as upper and lower nibbles
 472   uint8_t Binding = Symbol.getBinding();
 473   uint8_t Type = Symbol.getType();
 474   if (Base) {
 475     Type = mergeTypeForSet(Type, Base->getType());
 476   }
 477   uint8_t Info = (Binding << 4) | Type;
 478
 479   // Other and Visibility share the same byte with Visibility using the lower
 480   // 2 bits
 481   uint8_t Visibility = Symbol.getVisibility();
 482   uint8_t Other = Symbol.getOther() | Visibility;
 483
 484   uint64_t Value = SymbolValue(*MSD.Symbol, Layout);
 485   uint64_t Size = 0;
 486
 487   const MCExpr *ESize = MSD.Symbol->getSize();
 488   if (!ESize && Base)
 489     ESize = Base->getSize();
 490
 491   if (ESize) {
 492     int64_t Res;
 493     if (!ESize->evaluateKnownAbsolute(Res, Layout))
 494       report_fatal_error("Size expression must be absolute.");
 495     Size = Res;
 496   }
 497
 498   // Write out the symbol table entry
 499   Writer.writeSymbol(StringIndex, Info, Value, Size, Other, MSD.SectionIndex,
 500                      IsReserved);
 501 }
 502
 503 // It is always valid to create a relocation with a symbol. It is preferable
 504 // to use a relocation with a section if that is possible. Using the section
 505 // allows us to omit some local symbols from the symbol table.
 506 bool ELFObjectWriter::shouldRelocateWithSymbol(const MCAssembler &Asm,
 507                                                const MCSymbolRefExpr *RefA,
 508                                                const MCSymbol *S, uint64_t C,
 509                                                unsigned Type) const {
 510   const auto *Sym = cast_or_null<MCSymbolELF>(S);
 511   // A PCRel relocation to an absolute value has no symbol (or section). We
 512   // represent that with a relocation to a null section.
 513   if (!RefA)
 514     return false;
 515
 516   MCSymbolRefExpr::VariantKind Kind = RefA->getKind();
 517   switch (Kind) {
 518   default:
 519     break;
 520   // The .odp creation emits a relocation against the symbol ".TOC." which
 521   // create a R_PPC64_TOC relocation. However the relocation symbol name
 522   // in final object creation should be NULL, since the symbol does not
 523   // really exist, it is just the reference to TOC base for the current
 524   // object file. Since the symbol is undefined, returning false results
 525   // in a relocation with a null section which is the desired result.
 526   case MCSymbolRefExpr::VK_PPC_TOCBASE:
 527     return false;
 528
 529   // These VariantKind cause the relocation to refer to something other than
 530   // the symbol itself, like a linker generated table. Since the address of
 531   // symbol is not relevant, we cannot replace the symbol with the
 532   // section and patch the difference in the addend.
 533   case MCSymbolRefExpr::VK_GOT:
 534   case MCSymbolRefExpr::VK_PLT:
 535   case MCSymbolRefExpr::VK_GOTPCREL:
 536   case MCSymbolRefExpr::VK_PPC_GOT_LO:
 537   case MCSymbolRefExpr::VK_PPC_GOT_HI:
 538   case MCSymbolRefExpr::VK_PPC_GOT_HA:
 539     return true;
 540   }
 541
 542   // An undefined symbol is not in any section, so the relocation has to point
 543   // to the symbol itself.
 544   assert(Sym && "Expected a symbol");
 545   if (Sym->isUndefined())
 546     return true;
 547
 548   unsigned Binding = Sym->getBinding();
 549   switch(Binding) {
 550   default:
 551     llvm_unreachable("Invalid Binding");
 552   case ELF::STB_LOCAL:
 553     break;
 554   case ELF::STB_WEAK:
 555     // If the symbol is weak, it might be overridden by a symbol in another
 556     // file. The relocation has to point to the symbol so that the linker
 557     // can update it.
 558     return true;
 559   case ELF::STB_GLOBAL:
 560     // Global ELF symbols can be preempted by the dynamic linker. The relocation
 561     // has to point to the symbol for a reason analogous to the STB_WEAK case.
 562     return true;
 563   }
 564
 565   // If a relocation points to a mergeable section, we have to be careful.
 566   // If the offset is zero, a relocation with the section will encode the
 567   // same information. With a non-zero offset, the situation is different.
 568   // For example, a relocation can point 42 bytes past the end of a string.
 569   // If we change such a relocation to use the section, the linker would think
 570   // that it pointed to another string and subtracting 42 at runtime will
 571   // produce the wrong value.
 572   if (Sym->isInSection()) {
 573     auto &Sec = cast<MCSectionELF>(Sym->getSection());
 574     unsigned Flags = Sec.getFlags();
 575     if (Flags & ELF::SHF_MERGE) {
 576       if (C != 0)
 577         return true;
 578
 579       // It looks like gold has a bug (http://sourceware.org/PR16794) and can
 580       // only handle section relocations to mergeable sections if using RELA.
 581       if (!hasRelocationAddend())
 582         return true;
 583     }
 584
 585     // Most TLS relocations use a got, so they need the symbol. Even those that
 586     // are just an offset (@tpoff), require a symbol in gold versions before
 587     // 5efeedf61e4fe720fd3e9a08e6c91c10abb66d42 (2014-09-26) which fixed
 588     // http://sourceware.org/PR16773.
 589     if (Flags & ELF::SHF_TLS)
 590       return true;
 591   }
 592
 593   // If the symbol is a thumb function the final relocation must set the lowest
 594   // bit. With a symbol that is done by just having the symbol have that bit
 595   // set, so we would lose the bit if we relocated with the section.
 596   // FIXME: We could use the section but add the bit to the relocation value.
 597   if (Asm.isThumbFunc(Sym))
 598     return true;
 599
 600   if (TargetObjectWriter->needsRelocateWithSymbol(*Sym, Type))
 601     return true;
 602   return false;
 603 }
 604
 605 // True if the assembler knows nothing about the final value of the symbol.
 606 // This doesn't cover the comdat issues, since in those cases the assembler
 607 // can at least know that all symbols in the section will move together.
 608 static bool isWeak(const MCSymbolELF &Sym) {
 609   if (Sym.getType() == ELF::STT_GNU_IFUNC)
 610     return true;
 611
 612   switch (Sym.getBinding()) {
 613   default:
 614     llvm_unreachable("Unknown binding");
 615   case ELF::STB_LOCAL:
 616     return false;
 617   case ELF::STB_GLOBAL:
 618     return false;
 619   case ELF::STB_WEAK:
 620   case ELF::STB_GNU_UNIQUE:
 621     return true;
 622   }
 623 }
 624
 625 void ELFObjectWriter::recordRelocation(MCAssembler &Asm,
 626                                        const MCAsmLayout &Layout,
 627                                        const MCFragment *Fragment,
 628                                        const MCFixup &Fixup, MCValue Target,
 629                                        bool &IsPCRel, uint64_t &FixedValue) {
 630   const MCSectionELF &FixupSection = cast<MCSectionELF>(*Fragment->getParent());
 631   uint64_t C = Target.getConstant();
 632   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 633   MCContext &Ctx = Asm.getContext();
 634
 635   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
 636     // Let A, B and C being the components of Target and R be the location of
 637     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
 638     // If it is pcrel, we want to compute (A - B + C - R).
 639
 640     // In general, ELF has no relocations for -B. It can only represent (A + C)
 641     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
 642     // replace B to implement it: (A - R - K + C)
 643     if (IsPCRel) {
 644       Ctx.reportError(
 645           Fixup.getLoc(),
 646           "No relocation available to represent this relative expression");
 647       return;
 648     }
 649
 650     const auto &SymB = cast<MCSymbolELF>(RefB->getSymbol());
 651
 652     if (SymB.isUndefined()) {
 653       Ctx.reportError(Fixup.getLoc(),
 654                       Twine("symbol '") + SymB.getName() +
 655                           "' can not be undefined in a subtraction expression");
 656       return;
 657     }
 658
 659     assert(!SymB.isAbsolute() && "Should have been folded");
 660     const MCSection &SecB = SymB.getSection();
 661     if (&SecB != &FixupSection) {
 662       Ctx.reportError(Fixup.getLoc(),
 663                       "Cannot represent a difference across sections");
 664       return;
 665     }
 666
 667     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
 668     uint64_t K = SymBOffset - FixupOffset;
 669     IsPCRel = true;
 670     C -= K;
 671   }
 672
 673   // We either rejected the fixup or folded B into C at this point.
 674   const MCSymbolRefExpr *RefA = Target.getSymA();
 675   const auto *SymA = RefA ? cast<MCSymbolELF>(&RefA->getSymbol()) : nullptr;
 676
 677   bool ViaWeakRef = false;
 678   if (SymA && SymA->isVariable()) {
 679     const MCExpr *Expr = SymA->getVariableValue();
 680     if (const auto *Inner = dyn_cast<MCSymbolRefExpr>(Expr)) {
 681       if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF) {
 682         SymA = cast<MCSymbolELF>(&Inner->getSymbol());
 683         ViaWeakRef = true;
 684       }
 685     }
 686   }
 687
 688   unsigned Type = getRelocType(Ctx, Target, Fixup, IsPCRel);
 689   uint64_t OriginalC = C;
 690   bool RelocateWithSymbol = shouldRelocateWithSymbol(Asm, RefA, SymA, C, Type);
 691   if (!RelocateWithSymbol && SymA && !SymA->isUndefined())
 692     C += Layout.getSymbolOffset(*SymA);
 693
 694   uint64_t Addend = 0;
 695   if (hasRelocationAddend()) {
 696     Addend = C;
 697     C = 0;
 698   }
 699
 700   FixedValue = C;
 701
 702   if (!RelocateWithSymbol) {
 703     const MCSection *SecA =
 704         (SymA && !SymA->isUndefined()) ? &SymA->getSection() : nullptr;
 705     auto *ELFSec = cast_or_null<MCSectionELF>(SecA);
 706     const auto *SectionSymbol =
 707         ELFSec ? cast<MCSymbolELF>(ELFSec->getBeginSymbol()) : nullptr;
 708     if (SectionSymbol)
 709       SectionSymbol->setUsedInReloc();
 710     ELFRelocationEntry Rec(FixupOffset, SectionSymbol, Type, Addend, SymA,
 711                            OriginalC);
 712     Relocations[&FixupSection].push_back(Rec);
 713     return;
 714   }
 715
 716   const auto *RenamedSymA = SymA;
 717   if (SymA) {
 718     if (const MCSymbolELF *R = Renames.lookup(SymA))
 719       RenamedSymA = R;
 720
 721     if (ViaWeakRef)
 722       RenamedSymA->setIsWeakrefUsedInReloc();
 723     else
 724       RenamedSymA->setUsedInReloc();
 725   }
 726   ELFRelocationEntry Rec(FixupOffset, RenamedSymA, Type, Addend, SymA,
 727                          OriginalC);
 728   Relocations[&FixupSection].push_back(Rec);
 729 }
 730
 731 bool ELFObjectWriter::isInSymtab(const MCAsmLayout &Layout,
 732                                  const MCSymbolELF &Symbol, bool Used,
 733                                  bool Renamed) {
 734   if (Symbol.isVariable()) {
 735     const MCExpr *Expr = Symbol.getVariableValue();
 736     if (const MCSymbolRefExpr *Ref = dyn_cast<MCSymbolRefExpr>(Expr)) {
 737       if (Ref->getKind() == MCSymbolRefExpr::VK_WEAKREF)
 738         return false;
 739     }
 740   }
 741
 742   if (Used)
 743     return true;
 744
 745   if (Renamed)
 746     return false;
 747
 748   if (Symbol.isVariable() && Symbol.isUndefined()) {
 749     // FIXME: this is here just to diagnose the case of a var = commmon_sym.
 750     Layout.getBaseSymbol(Symbol);
 751     return false;
 752   }
 753
 754   if (Symbol.isUndefined() && !Symbol.isBindingSet())
 755     return false;
 756
 757   if (Symbol.isTemporary())
 758     return false;
 759
 760   if (Symbol.getType() == ELF::STT_SECTION)
 761     return false;
 762
 763   return true;
 764 }
 765
 766 void ELFObjectWriter::computeSymbolTable(
 767     MCAssembler &Asm, const MCAsmLayout &Layout,
 768     const SectionIndexMapTy &SectionIndexMap, const RevGroupMapTy &RevGroupMap,
 769     SectionOffsetsTy &SectionOffsets) {
 770   MCContext &Ctx = Asm.getContext();
 771   SymbolTableWriter Writer(*this, is64Bit());
 772
 773   // Symbol table
 774   unsigned EntrySize = is64Bit() ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
 775   MCSectionELF *SymtabSection =
 776       Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0, EntrySize, "");
 777   SymtabSection->setAlignment(is64Bit() ? 8 : 4);
 778   SymbolTableIndex = addToSectionTable(SymtabSection);
 779
 780   align(SymtabSection->getAlignment());
 781   uint64_t SecStart = getStream().tell();
 782
 783   // The first entry is the undefined symbol entry.
 784   Writer.writeSymbol(0, 0, 0, 0, 0, 0, false);
 785
 786   std::vector<ELFSymbolData> LocalSymbolData;
 787   std::vector<ELFSymbolData> ExternalSymbolData;
 788
 789   // Add the data for the symbols.
 790   bool HasLargeSectionIndex = false;
 791   for (const MCSymbol &S : Asm.symbols()) {
 792     const auto &Symbol = cast<MCSymbolELF>(S);
 793     bool Used = Symbol.isUsedInReloc();
 794     bool WeakrefUsed = Symbol.isWeakrefUsedInReloc();
 795     bool isSignature = Symbol.isSignature();
 796
 797     if (!isInSymtab(Layout, Symbol, Used || WeakrefUsed || isSignature,
 798                     Renames.count(&Symbol)))
 799       continue;
 800
 801     if (Symbol.isTemporary() && Symbol.isUndefined()) {
 802       Ctx.reportError(SMLoc(), "Undefined temporary symbol");
 803       continue;
 804     }
 805
 806     ELFSymbolData MSD;
 807     MSD.Symbol = cast<MCSymbolELF>(&Symbol);
 808
 809     bool Local = Symbol.getBinding() == ELF::STB_LOCAL;
 810     assert(Local || !Symbol.isTemporary());
 811
 812     if (Symbol.isAbsolute()) {
 813       MSD.SectionIndex = ELF::SHN_ABS;
 814     } else if (Symbol.isCommon()) {
 815       assert(!Local);
 816       MSD.SectionIndex = ELF::SHN_COMMON;
 817     } else if (Symbol.isUndefined()) {
 818       if (isSignature && !Used) {
 819         MSD.SectionIndex = RevGroupMap.lookup(&Symbol);
 820         if (MSD.SectionIndex >= ELF::SHN_LORESERVE)
 821           HasLargeSectionIndex = true;
 822       } else {
 823         MSD.SectionIndex = ELF::SHN_UNDEF;
 824       }
 825     } else {
 826       const MCSectionELF &Section =
 827           static_cast<const MCSectionELF &>(Symbol.getSection());
 828       MSD.SectionIndex = SectionIndexMap.lookup(&Section);
 829       assert(MSD.SectionIndex && "Invalid section index!");
 830       if (MSD.SectionIndex >= ELF::SHN_LORESERVE)
 831         HasLargeSectionIndex = true;
 832     }
 833
 834     // The @@@ in symbol version is replaced with @ in undefined symbols and @@
 835     // in defined ones.
 836     //
 837     // FIXME: All name handling should be done before we get to the writer,
 838     // including dealing with GNU-style version suffixes.  Fixing this isn't
 839     // trivial.
 840     //
 841     // We thus have to be careful to not perform the symbol version replacement
 842     // blindly:
 843     //
 844     // The ELF format is used on Windows by the MCJIT engine.  Thus, on
 845     // Windows, the ELFObjectWriter can encounter symbols mangled using the MS
 846     // Visual Studio C++ name mangling scheme. Symbols mangled using the MSVC
 847     // C++ name mangling can legally have "@@@" as a sub-string. In that case,
 848     // the EFLObjectWriter should not interpret the "@@@" sub-string as
 849     // specifying GNU-style symbol versioning. The ELFObjectWriter therefore
 850     // checks for the MSVC C++ name mangling prefix which is either "?", "@?",
 851     // "__imp_?" or "__imp_@?".
 852     //
 853     // It would have been interesting to perform the MS mangling prefix check
 854     // only when the target triple is of the form *-pc-windows-elf. But, it
 855     // seems that this information is not easily accessible from the
 856     // ELFObjectWriter.
 857     StringRef Name = Symbol.getName();
 858     SmallString<32> Buf;
 859     if (!Name.startswith("?") && !Name.startswith("@?") &&
 860         !Name.startswith("__imp_?") && !Name.startswith("__imp_@?")) {
 861       // This symbol isn't following the MSVC C++ name mangling convention. We
 862       // can thus safely interpret the @@@ in symbol names as specifying symbol
 863       // versioning.
 864       size_t Pos = Name.find("@@@");
 865       if (Pos != StringRef::npos) {
 866         Buf += Name.substr(0, Pos);
 867         unsigned Skip = MSD.SectionIndex == ELF::SHN_UNDEF ? 2 : 1;
 868         Buf += Name.substr(Pos + Skip);
 869         Name = VersionSymSaver.save(Buf.c_str());
 870       }
 871     }
 872
 873     // Sections have their own string table
 874     if (Symbol.getType() != ELF::STT_SECTION) {
 875       MSD.Name = Name;
 876       StrTabBuilder.add(Name);
 877     }
 878
 879     if (Local)
 880       LocalSymbolData.push_back(MSD);
 881     else
 882       ExternalSymbolData.push_back(MSD);
 883   }
 884
 885   // This holds the .symtab_shndx section index.
 886   unsigned SymtabShndxSectionIndex = 0;
 887
 888   if (HasLargeSectionIndex) {
 889     MCSectionELF *SymtabShndxSection =
 890         Ctx.getELFSection(".symtab_shndxr", ELF::SHT_SYMTAB_SHNDX, 0, 4, "");
 891     SymtabShndxSectionIndex = addToSectionTable(SymtabShndxSection);
 892     SymtabShndxSection->setAlignment(4);
 893   }
 894
 895   ArrayRef<std::string> FileNames = Asm.getFileNames();
 896   for (const std::string &Name : FileNames)
 897     StrTabBuilder.add(Name);
 898
 899   StrTabBuilder.finalize();
 900
 901   // File symbols are emitted first and handled separately from normal symbols,
 902   // i.e. a non-STT_FILE symbol with the same name may appear.
 903   for (const std::string &Name : FileNames)
 904     Writer.writeSymbol(StrTabBuilder.getOffset(Name),
 905                        ELF::STT_FILE | ELF::STB_LOCAL, 0, 0, ELF::STV_DEFAULT,
 906                        ELF::SHN_ABS, true);
 907
 908   // Symbols are required to be in lexicographic order.
 909   array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
 910   array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
 911
 912   // Set the symbol indices. Local symbols must come before all other
 913   // symbols with non-local bindings.
 914   unsigned Index = FileNames.size() + 1;
 915
 916   for (ELFSymbolData &MSD : LocalSymbolData) {
 917     unsigned StringIndex = MSD.Symbol->getType() == ELF::STT_SECTION
 918                                ? 0
 919                                : StrTabBuilder.getOffset(MSD.Name);
 920     MSD.Symbol->setIndex(Index++);
 921     writeSymbol(Writer, StringIndex, MSD, Layout);
 922   }
 923
 924   // Write the symbol table entries.
 925   LastLocalSymbolIndex = Index;
 926
 927   for (ELFSymbolData &MSD : ExternalSymbolData) {
 928     unsigned StringIndex = StrTabBuilder.getOffset(MSD.Name);
 929     MSD.Symbol->setIndex(Index++);
 930     writeSymbol(Writer, StringIndex, MSD, Layout);
 931     assert(MSD.Symbol->getBinding() != ELF::STB_LOCAL);
 932   }
 933
 934   uint64_t SecEnd = getStream().tell();
 935   SectionOffsets[SymtabSection] = std::make_pair(SecStart, SecEnd);
 936
 937   ArrayRef<uint32_t> ShndxIndexes = Writer.getShndxIndexes();
 938   if (ShndxIndexes.empty()) {
 939     assert(SymtabShndxSectionIndex == 0);
 940     return;
 941   }
 942   assert(SymtabShndxSectionIndex != 0);
 943
 944   SecStart = getStream().tell();
 945   const MCSectionELF *SymtabShndxSection =
 946       SectionTable[SymtabShndxSectionIndex - 1];
 947   for (uint32_t Index : ShndxIndexes)
 948     write(Index);
 949   SecEnd = getStream().tell();
 950   SectionOffsets[SymtabShndxSection] = std::make_pair(SecStart, SecEnd);
 951 }
 952
 953 MCSectionELF *
 954 ELFObjectWriter::createRelocationSection(MCContext &Ctx,
 955                                          const MCSectionELF &Sec) {
 956   if (Relocations[&Sec].empty())
 957     return nullptr;
 958
 959   const StringRef SectionName = Sec.getSectionName();
 960   std::string RelaSectionName = hasRelocationAddend() ? ".rela" : ".rel";
 961   RelaSectionName += SectionName;
 962
 963   unsigned EntrySize;
 964   if (hasRelocationAddend())
 965     EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
 966   else
 967     EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
 968
 969   unsigned Flags = 0;
 970   if (Sec.getFlags() & ELF::SHF_GROUP)
 971     Flags = ELF::SHF_GROUP;
 972
 973   MCSectionELF *RelaSection = Ctx.createELFRelSection(
 974       RelaSectionName, hasRelocationAddend() ? ELF::SHT_RELA : ELF::SHT_REL,
 975       Flags, EntrySize, Sec.getGroup(), &Sec);
 976   RelaSection->setAlignment(is64Bit() ? 8 : 4);
 977   return RelaSection;
 978 }
 979
 980 // Include the debug info compression header.
 981 bool ELFObjectWriter::maybeWriteCompression(
 982     uint64_t Size, SmallVectorImpl<char> &CompressedContents, bool ZLibStyle,
 983     unsigned Alignment) {
 984   if (ZLibStyle) {
 985     uint64_t HdrSize =
 986         is64Bit() ? sizeof(ELF::Elf32_Chdr) : sizeof(ELF::Elf64_Chdr);
 987     if (Size <= HdrSize + CompressedContents.size())
 988       return false;
 989     // Platform specific header is followed by compressed data.
 990     if (is64Bit()) {
 991       // Write Elf64_Chdr header.
 992       write(static_cast<ELF::Elf64_Word>(ELF::ELFCOMPRESS_ZLIB));
 993       write(static_cast<ELF::Elf64_Word>(0)); // ch_reserved field.
 994       write(static_cast<ELF::Elf64_Xword>(Size));
 995       write(static_cast<ELF::Elf64_Xword>(Alignment));
 996     } else {
 997       // Write Elf32_Chdr header otherwise.
 998       write(static_cast<ELF::Elf32_Word>(ELF::ELFCOMPRESS_ZLIB));
 999       write(static_cast<ELF::Elf32_Word>(Size));
1000       write(static_cast<ELF::Elf32_Word>(Alignment));
1001     }
1002     return true;
1003   }
1004
1005   // "ZLIB" followed by 8 bytes representing the uncompressed size of the section,
1006   // useful for consumers to preallocate a buffer to decompress into.
1007   const StringRef Magic = "ZLIB";
1008   if (Size <= Magic.size() + sizeof(Size) + CompressedContents.size())
1009     return false;
1010   write(ArrayRef<char>(Magic.begin(), Magic.size()));
1011   writeBE64(Size);
1012   return true;
1013 }
1014
1015 void ELFObjectWriter::writeSectionData(const MCAssembler &Asm, MCSection &Sec,
1016                                        const MCAsmLayout &Layout) {
1017   MCSectionELF &Section = static_cast<MCSectionELF &>(Sec);
1018   StringRef SectionName = Section.getSectionName();
1019
1020   auto &MC = Asm.getContext();
1021   const auto &MAI = MC.getAsmInfo();
1022
1023   // Compressing debug_frame requires handling alignment fragments which is
1024   // more work (possibly generalizing MCAssembler.cpp:writeFragment to allow
1025   // for writing to arbitrary buffers) for little benefit.
1026   bool CompressionEnabled =
1027       MAI->compressDebugSections() != DebugCompressionType::None;
1028   if (!CompressionEnabled || !SectionName.startswith(".debug_") ||
1029       SectionName == ".debug_frame") {
1030     Asm.writeSectionData(&Section, Layout);
1031     return;
1032   }
1033
1034   assert((MAI->compressDebugSections() == DebugCompressionType::Z ||
1035           MAI->compressDebugSections() == DebugCompressionType::GNU) &&
1036          "expected zlib or zlib-gnu style compression");
1037
1038   SmallVector<char, 128> UncompressedData;
1039   raw_svector_ostream VecOS(UncompressedData);
1040   raw_pwrite_stream &OldStream = getStream();
1041   setStream(VecOS);
1042   Asm.writeSectionData(&Section, Layout);
1043   setStream(OldStream);
1044
1045   SmallVector<char, 128> CompressedContents;
1046   if (Error E = zlib::compress(
1047           StringRef(UncompressedData.data(), UncompressedData.size()),
1048           CompressedContents)) {
1049     consumeError(std::move(E));
1050     getStream() << UncompressedData;
1051     return;
1052   }
1053
1054   bool ZlibStyle = MAI->compressDebugSections() == DebugCompressionType::Z;
1055   if (!maybeWriteCompression(UncompressedData.size(), CompressedContents,
1056                              ZlibStyle, Sec.getAlignment())) {
1057     getStream() << UncompressedData;
1058     return;
1059   }
1060
1061   if (ZlibStyle)
1062     // Set the compressed flag. That is zlib style.
1063     Section.setFlags(Section.getFlags() | ELF::SHF_COMPRESSED);
1064   else
1065     // Add "z" prefix to section name. This is zlib-gnu style.
1066     MC.renameELFSection(&Section, (".z" + SectionName.drop_front(1)).str());
1067   getStream() << CompressedContents;
1068 }
1069
1070 void ELFObjectWriter::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
1071                                        uint64_t Flags, uint64_t Address,
1072                                        uint64_t Offset, uint64_t Size,
1073                                        uint32_t Link, uint32_t Info,
1074                                        uint64_t Alignment,
1075                                        uint64_t EntrySize) {
1076   write32(Name);        // sh_name: index into string table
1077   write32(Type);        // sh_type
1078   WriteWord(Flags);     // sh_flags
1079   WriteWord(Address);   // sh_addr
1080   WriteWord(Offset);    // sh_offset
1081   WriteWord(Size);      // sh_size
1082   write32(Link);        // sh_link
1083   write32(Info);        // sh_info
1084   WriteWord(Alignment); // sh_addralign
1085   WriteWord(EntrySize); // sh_entsize
1086 }
1087
1088 void ELFObjectWriter::writeRelocations(const MCAssembler &Asm,
1089                                        const MCSectionELF &Sec) {
1090   std::vector<ELFRelocationEntry> &Relocs = Relocations[&Sec];
1091
1092   // We record relocations by pushing to the end of a vector. Reverse the vector
1093   // to get the relocations in the order they were created.
1094   // In most cases that is not important, but it can be for special sections
1095   // (.eh_frame) or specific relocations (TLS optimizations on SystemZ).
1096   std::reverse(Relocs.begin(), Relocs.end());
1097
1098   // Sort the relocation entries. MIPS needs this.
1099   TargetObjectWriter->sortRelocs(Asm, Relocs);
1100
1101   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1102     const ELFRelocationEntry &Entry = Relocs[e - i - 1];
1103     unsigned Index = Entry.Symbol ? Entry.Symbol->getIndex() : 0;
1104
1105     if (is64Bit()) {
1106       write(Entry.Offset);
1107       if (TargetObjectWriter->isN64()) {
1108         write(uint32_t(Index));
1109
1110         write(TargetObjectWriter->getRSsym(Entry.Type));
1111         write(TargetObjectWriter->getRType3(Entry.Type));
1112         write(TargetObjectWriter->getRType2(Entry.Type));
1113         write(TargetObjectWriter->getRType(Entry.Type));
1114       } else {
1115         struct ELF::Elf64_Rela ERE64;
1116         ERE64.setSymbolAndType(Index, Entry.Type);
1117         write(ERE64.r_info);
1118       }
1119       if (hasRelocationAddend())
1120         write(Entry.Addend);
1121     } else {
1122       write(uint32_t(Entry.Offset));
1123
1124       struct ELF::Elf32_Rela ERE32;
1125       ERE32.setSymbolAndType(Index, Entry.Type);
1126       write(ERE32.r_info);
1127
1128       if (hasRelocationAddend())
1129         write(uint32_t(Entry.Addend));
1130     }
1131   }
1132 }
1133
1134 const MCSectionELF *ELFObjectWriter::createStringTable(MCContext &Ctx) {
1135   const MCSectionELF *StrtabSection = SectionTable[StringTableIndex - 1];
1136   StrTabBuilder.write(getStream());
1137   return StrtabSection;
1138 }
1139
1140 void ELFObjectWriter::writeSection(const SectionIndexMapTy &SectionIndexMap,
1141                                    uint32_t GroupSymbolIndex, uint64_t Offset,
1142                                    uint64_t Size, const MCSectionELF &Section) {
1143   uint64_t sh_link = 0;
1144   uint64_t sh_info = 0;
1145
1146   switch(Section.getType()) {
1147   default:
1148     // Nothing to do.
1149     break;
1150
1151   case ELF::SHT_DYNAMIC:
1152     llvm_unreachable("SHT_DYNAMIC in a relocatable object");
1153
1154   case ELF::SHT_REL:
1155   case ELF::SHT_RELA: {
1156     sh_link = SymbolTableIndex;
1157     assert(sh_link && ".symtab not found");
1158     const MCSection *InfoSection = Section.getAssociatedSection();
1159     sh_info = SectionIndexMap.lookup(cast<MCSectionELF>(InfoSection));
1160     break;
1161   }
1162
1163   case ELF::SHT_SYMTAB:
1164   case ELF::SHT_DYNSYM:
1165     sh_link = StringTableIndex;
1166     sh_info = LastLocalSymbolIndex;
1167     break;
1168
1169   case ELF::SHT_SYMTAB_SHNDX:
1170     sh_link = SymbolTableIndex;
1171     break;
1172
1173   case ELF::SHT_GROUP:
1174     sh_link = SymbolTableIndex;
1175     sh_info = GroupSymbolIndex;
1176     break;
1177   }
1178
1179   if (Section.getFlags() & ELF::SHF_LINK_ORDER) {
1180     const MCSymbol *Sym = Section.getAssociatedSymbol();
1181     const MCSectionELF *Sec = cast<MCSectionELF>(&Sym->getSection());
1182     sh_link = SectionIndexMap.lookup(Sec);
1183   }
1184
1185   WriteSecHdrEntry(StrTabBuilder.getOffset(Section.getSectionName()),
1186                    Section.getType(), Section.getFlags(), 0, Offset, Size,
1187                    sh_link, sh_info, Section.getAlignment(),
1188                    Section.getEntrySize());
1189 }
1190
1191 void ELFObjectWriter::writeSectionHeader(
1192     const MCAsmLayout &Layout, const SectionIndexMapTy &SectionIndexMap,
1193     const SectionOffsetsTy &SectionOffsets) {
1194   const unsigned NumSections = SectionTable.size();
1195
1196   // Null section first.
1197   uint64_t FirstSectionSize =
1198       (NumSections + 1) >= ELF::SHN_LORESERVE ? NumSections + 1 : 0;
1199   WriteSecHdrEntry(0, 0, 0, 0, 0, FirstSectionSize, 0, 0, 0, 0);
1200
1201   for (const MCSectionELF *Section : SectionTable) {
1202     uint32_t GroupSymbolIndex;
1203     unsigned Type = Section->getType();
1204     if (Type != ELF::SHT_GROUP)
1205       GroupSymbolIndex = 0;
1206     else
1207       GroupSymbolIndex = Section->getGroup()->getIndex();
1208
1209     const std::pair<uint64_t, uint64_t> &Offsets =
1210         SectionOffsets.find(Section)->second;
1211     uint64_t Size;
1212     if (Type == ELF::SHT_NOBITS)
1213       Size = Layout.getSectionAddressSize(Section);
1214     else
1215       Size = Offsets.second - Offsets.first;
1216
1217     writeSection(SectionIndexMap, GroupSymbolIndex, Offsets.first, Size,
1218                  *Section);
1219   }
1220 }
1221
1222 void ELFObjectWriter::writeObject(MCAssembler &Asm,
1223                                   const MCAsmLayout &Layout) {
1224   MCContext &Ctx = Asm.getContext();
1225   MCSectionELF *StrtabSection =
1226       Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0);
1227   StringTableIndex = addToSectionTable(StrtabSection);
1228
1229   RevGroupMapTy RevGroupMap;
1230   SectionIndexMapTy SectionIndexMap;
1231
1232   std::map<const MCSymbol *, std::vector<const MCSectionELF *>> GroupMembers;
1233
1234   // Write out the ELF header ...
1235   writeHeader(Asm);
1236
1237   // ... then the sections ...
1238   SectionOffsetsTy SectionOffsets;
1239   std::vector<MCSectionELF *> Groups;
1240   std::vector<MCSectionELF *> Relocations;
1241   for (MCSection &Sec : Asm) {
1242     MCSectionELF &Section = static_cast<MCSectionELF &>(Sec);
1243
1244     align(Section.getAlignment());
1245
1246     // Remember the offset into the file for this section.
1247     uint64_t SecStart = getStream().tell();
1248
1249     const MCSymbolELF *SignatureSymbol = Section.getGroup();
1250     writeSectionData(Asm, Section, Layout);
1251
1252     uint64_t SecEnd = getStream().tell();
1253     SectionOffsets[&Section] = std::make_pair(SecStart, SecEnd);
1254
1255     MCSectionELF *RelSection = createRelocationSection(Ctx, Section);
1256
1257     if (SignatureSymbol) {
1258       Asm.registerSymbol(*SignatureSymbol);
1259       unsigned &GroupIdx = RevGroupMap[SignatureSymbol];
1260       if (!GroupIdx) {
1261         MCSectionELF *Group = Ctx.createELFGroupSection(SignatureSymbol);
1262         GroupIdx = addToSectionTable(Group);
1263         Group->setAlignment(4);
1264         Groups.push_back(Group);
1265       }
1266       std::vector<const MCSectionELF *> &Members =
1267           GroupMembers[SignatureSymbol];
1268       Members.push_back(&Section);
1269       if (RelSection)
1270         Members.push_back(RelSection);
1271     }
1272
1273     SectionIndexMap[&Section] = addToSectionTable(&Section);
1274     if (RelSection) {
1275       SectionIndexMap[RelSection] = addToSectionTable(RelSection);
1276       Relocations.push_back(RelSection);
1277     }
1278   }
1279
1280   for (MCSectionELF *Group : Groups) {
1281     align(Group->getAlignment());
1282
1283     // Remember the offset into the file for this section.
1284     uint64_t SecStart = getStream().tell();
1285
1286     const MCSymbol *SignatureSymbol = Group->getGroup();
1287     assert(SignatureSymbol);
1288     write(uint32_t(ELF::GRP_COMDAT));
1289     for (const MCSectionELF *Member : GroupMembers[SignatureSymbol]) {
1290       uint32_t SecIndex = SectionIndexMap.lookup(Member);
1291       write(SecIndex);
1292     }
1293
1294     uint64_t SecEnd = getStream().tell();
1295     SectionOffsets[Group] = std::make_pair(SecStart, SecEnd);
1296   }
1297
1298   // Compute symbol table information.
1299   computeSymbolTable(Asm, Layout, SectionIndexMap, RevGroupMap, SectionOffsets);
1300
1301   for (MCSectionELF *RelSection : Relocations) {
1302     align(RelSection->getAlignment());
1303
1304     // Remember the offset into the file for this section.
1305     uint64_t SecStart = getStream().tell();
1306
1307     writeRelocations(Asm,
1308                      cast<MCSectionELF>(*RelSection->getAssociatedSection()));
1309
1310     uint64_t SecEnd = getStream().tell();
1311     SectionOffsets[RelSection] = std::make_pair(SecStart, SecEnd);
1312   }
1313
1314   {
1315     uint64_t SecStart = getStream().tell();
1316     const MCSectionELF *Sec = createStringTable(Ctx);
1317     uint64_t SecEnd = getStream().tell();
1318     SectionOffsets[Sec] = std::make_pair(SecStart, SecEnd);
1319   }
1320
1321   uint64_t NaturalAlignment = is64Bit() ? 8 : 4;
1322   align(NaturalAlignment);
1323
1324   const uint64_t SectionHeaderOffset = getStream().tell();
1325
1326   // ... then the section header table ...
1327   writeSectionHeader(Layout, SectionIndexMap, SectionOffsets);
1328
1329   uint16_t NumSections = (SectionTable.size() + 1 >= ELF::SHN_LORESERVE)
1330                              ? (uint16_t)ELF::SHN_UNDEF
1331                              : SectionTable.size() + 1;
1332   if (sys::IsLittleEndianHost != IsLittleEndian)
1333     sys::swapByteOrder(NumSections);
1334   unsigned NumSectionsOffset;
1335
1336   if (is64Bit()) {
1337     uint64_t Val = SectionHeaderOffset;
1338     if (sys::IsLittleEndianHost != IsLittleEndian)
1339       sys::swapByteOrder(Val);
1340     getStream().pwrite(reinterpret_cast<char *>(&Val), sizeof(Val),
1341                        offsetof(ELF::Elf64_Ehdr, e_shoff));
1342     NumSectionsOffset = offsetof(ELF::Elf64_Ehdr, e_shnum);
1343   } else {
1344     uint32_t Val = SectionHeaderOffset;
1345     if (sys::IsLittleEndianHost != IsLittleEndian)
1346       sys::swapByteOrder(Val);
1347     getStream().pwrite(reinterpret_cast<char *>(&Val), sizeof(Val),
1348                        offsetof(ELF::Elf32_Ehdr, e_shoff));
1349     NumSectionsOffset = offsetof(ELF::Elf32_Ehdr, e_shnum);
1350   }
1351   getStream().pwrite(reinterpret_cast<char *>(&NumSections),
1352                      sizeof(NumSections), NumSectionsOffset);
1353 }
1354
1355 bool ELFObjectWriter::isSymbolRefDifferenceFullyResolvedImpl(
1356     const MCAssembler &Asm, const MCSymbol &SA, const MCFragment &FB,
1357     bool InSet, bool IsPCRel) const {
1358   const auto &SymA = cast<MCSymbolELF>(SA);
1359   if (IsPCRel) {
1360     assert(!InSet);
1361     if (isWeak(SymA))
1362       return false;
1363   }
1364   return MCObjectWriter::isSymbolRefDifferenceFullyResolvedImpl(Asm, SymA, FB,
1365                                                                 InSet, IsPCRel);
1366 }
1367
1368 MCObjectWriter *llvm::createELFObjectWriter(MCELFObjectTargetWriter *MOTW,
1369                                             raw_pwrite_stream &OS,
1370                                             bool IsLittleEndian) {
1371   return new ELFObjectWriter(MOTW, OS, IsLittleEndian);
1372 }