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