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