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