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 = 0;
 513       Data = 0;
 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 (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
 534          ie = Asm.symbol_end(); it != ie; ++it) {
 535     const MCSymbol &Alias = it->getSymbol();
 536     const MCSymbol &Symbol = Alias.AliasedSymbol();
 537     MCSymbolData &SD = Asm.getSymbolData(Symbol);
 538
 539     // Not an alias.
 540     if (&Symbol == &Alias)
 541       continue;
 542
 543     StringRef AliasName = Alias.getName();
 544     size_t Pos = AliasName.find('@');
 545     if (Pos == StringRef::npos)
 546       continue;
 547
 548     // Aliases defined with .symvar copy the binding from the symbol they alias.
 549     // This is the first place we are able to copy this information.
 550     it->setExternal(SD.isExternal());
 551     MCELF::SetBinding(*it, MCELF::GetBinding(SD));
 552
 553     StringRef Rest = AliasName.substr(Pos);
 554     if (!Symbol.isUndefined() && !Rest.startswith("@@@"))
 555       continue;
 556
 557     // FIXME: produce a better error message.
 558     if (Symbol.isUndefined() && Rest.startswith("@@") &&
 559         !Rest.startswith("@@@"))
 560       report_fatal_error("A @@ version cannot be undefined");
 561
 562     Renames.insert(std::make_pair(&Symbol, &Alias));
 563   }
 564 }
 565
 566 static uint8_t mergeTypeForSet(uint8_t origType, uint8_t newType) {
 567   uint8_t Type = newType;
 568
 569   // Propagation rules:
 570   // IFUNC > FUNC > OBJECT > NOTYPE
 571   // TLS_OBJECT > OBJECT > NOTYPE
 572   //
 573   // dont let the new type degrade the old type
 574   switch (origType) {
 575   default:
 576     break;
 577   case ELF::STT_GNU_IFUNC:
 578     if (Type == ELF::STT_FUNC || Type == ELF::STT_OBJECT ||
 579         Type == ELF::STT_NOTYPE || Type == ELF::STT_TLS)
 580       Type = ELF::STT_GNU_IFUNC;
 581     break;
 582   case ELF::STT_FUNC:
 583     if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
 584         Type == ELF::STT_TLS)
 585       Type = ELF::STT_FUNC;
 586     break;
 587   case ELF::STT_OBJECT:
 588     if (Type == ELF::STT_NOTYPE)
 589       Type = ELF::STT_OBJECT;
 590     break;
 591   case ELF::STT_TLS:
 592     if (Type == ELF::STT_OBJECT || Type == ELF::STT_NOTYPE ||
 593         Type == ELF::STT_GNU_IFUNC || Type == ELF::STT_FUNC)
 594       Type = ELF::STT_TLS;
 595     break;
 596   }
 597
 598   return Type;
 599 }
 600
 601 static const MCSymbol *getBaseSymbol(const MCAsmLayout &Layout,
 602                                      const MCSymbol &Symbol) {
 603   if (!Symbol.isVariable())
 604     return &Symbol;
 605
 606   const MCExpr *Expr = Symbol.getVariableValue();
 607   MCValue Value;
 608   if (!Expr->EvaluateAsRelocatable(Value, &Layout))
 609     llvm_unreachable("Invalid Expression");
 610   assert(!Value.getSymB());
 611   const MCSymbolRefExpr *A = Value.getSymA();
 612   if (!A)
 613     return nullptr;
 614   return getBaseSymbol(Layout, A->getSymbol());
 615 }
 616
 617 void ELFObjectWriter::WriteSymbol(SymbolTableWriter &Writer, ELFSymbolData &MSD,
 618                                   const MCAsmLayout &Layout) {
 619   MCSymbolData &OrigData = *MSD.SymbolData;
 620   const MCSymbol *Base = getBaseSymbol(Layout, OrigData.getSymbol());
 621
 622   // This has to be in sync with when computeSymbolTable uses SHN_ABS or
 623   // SHN_COMMON.
 624   bool IsReserved = !Base || OrigData.isCommon();
 625
 626   // Binding and Type share the same byte as upper and lower nibbles
 627   uint8_t Binding = MCELF::GetBinding(OrigData);
 628   uint8_t Type = MCELF::GetType(OrigData);
 629   MCSymbolData *BaseSD = nullptr;
 630   if (Base) {
 631     BaseSD = &Layout.getAssembler().getSymbolData(*Base);
 632     Type = mergeTypeForSet(Type, MCELF::GetType(*BaseSD));
 633   }
 634   if (OrigData.getFlags() & ELF_Other_ThumbFunc)
 635     Type = ELF::STT_FUNC;
 636   uint8_t Info = (Binding << ELF_STB_Shift) | (Type << ELF_STT_Shift);
 637
 638   // Other and Visibility share the same byte with Visibility using the lower
 639   // 2 bits
 640   uint8_t Visibility = MCELF::GetVisibility(OrigData);
 641   uint8_t Other = MCELF::getOther(OrigData) << (ELF_STO_Shift - ELF_STV_Shift);
 642   Other |= Visibility;
 643
 644   uint64_t Value = SymbolValue(OrigData, Layout);
 645   if (OrigData.getFlags() & ELF_Other_ThumbFunc)
 646     Value |= 1;
 647   uint64_t Size = 0;
 648
 649   const MCExpr *ESize = OrigData.getSize();
 650   if (!ESize && Base)
 651     ESize = BaseSD->getSize();
 652
 653   if (ESize) {
 654     int64_t Res;
 655     if (!ESize->EvaluateAsAbsolute(Res, Layout))
 656       report_fatal_error("Size expression must be absolute.");
 657     Size = Res;
 658   }
 659
 660   // Write out the symbol table entry
 661   Writer.writeSymbol(MSD.StringIndex, Info, Value, Size, Other,
 662                      MSD.SectionIndex, IsReserved);
 663 }
 664
 665 void ELFObjectWriter::WriteSymbolTable(MCDataFragment *SymtabF,
 666                                        MCAssembler &Asm,
 667                                        const MCAsmLayout &Layout,
 668                                        SectionIndexMapTy &SectionIndexMap) {
 669   // The string table must be emitted first because we need the index
 670   // into the string table for all the symbol names.
 671   assert(StringTable.size() && "Missing string table");
 672
 673   // FIXME: Make sure the start of the symbol table is aligned.
 674
 675   SymbolTableWriter Writer(Asm, FWriter, is64Bit(), SectionIndexMap, SymtabF);
 676
 677   // The first entry is the undefined symbol entry.
 678   Writer.writeSymbol(0, 0, 0, 0, 0, 0, false);
 679
 680   for (unsigned i = 0, e = FileSymbolData.size(); i != e; ++i) {
 681     Writer.writeSymbol(FileSymbolData[i], ELF::STT_FILE | ELF::STB_LOCAL, 0, 0,
 682                        ELF::STV_DEFAULT, ELF::SHN_ABS, true);
 683   }
 684
 685   // Write the symbol table entries.
 686   LastLocalSymbolIndex = FileSymbolData.size() + LocalSymbolData.size() + 1;
 687
 688   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
 689     ELFSymbolData &MSD = LocalSymbolData[i];
 690     WriteSymbol(Writer, MSD, Layout);
 691   }
 692
 693   // Write out a symbol table entry for each regular section.
 694   for (MCAssembler::const_iterator i = Asm.begin(), e = Asm.end(); i != e;
 695        ++i) {
 696     const MCSectionELF &Section =
 697       static_cast<const MCSectionELF&>(i->getSection());
 698     if (Section.getType() == ELF::SHT_RELA ||
 699         Section.getType() == ELF::SHT_REL ||
 700         Section.getType() == ELF::SHT_STRTAB ||
 701         Section.getType() == ELF::SHT_SYMTAB ||
 702         Section.getType() == ELF::SHT_SYMTAB_SHNDX)
 703       continue;
 704     Writer.writeSymbol(0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT,
 705                        SectionIndexMap.lookup(&Section), false);
 706     LastLocalSymbolIndex++;
 707   }
 708
 709   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
 710     ELFSymbolData &MSD = ExternalSymbolData[i];
 711     MCSymbolData &Data = *MSD.SymbolData;
 712     assert(((Data.getFlags() & ELF_STB_Global) ||
 713             (Data.getFlags() & ELF_STB_Weak)) &&
 714            "External symbol requires STB_GLOBAL or STB_WEAK flag");
 715     WriteSymbol(Writer, MSD, Layout);
 716     if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
 717       LastLocalSymbolIndex++;
 718   }
 719
 720   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
 721     ELFSymbolData &MSD = UndefinedSymbolData[i];
 722     MCSymbolData &Data = *MSD.SymbolData;
 723     WriteSymbol(Writer, MSD, Layout);
 724     if (MCELF::GetBinding(Data) == ELF::STB_LOCAL)
 725       LastLocalSymbolIndex++;
 726   }
 727 }
 728
 729 // It is always valid to create a relocation with a symbol. It is preferable
 730 // to use a relocation with a section if that is possible. Using the section
 731 // allows us to omit some local symbols from the symbol table.
 732 bool ELFObjectWriter::shouldRelocateWithSymbol(const MCSymbolRefExpr *RefA,
 733                                                const MCSymbolData *SD,
 734                                                uint64_t C,
 735                                                unsigned Type) const {
 736   // A PCRel relocation to an absolute value has no symbol (or section). We
 737   // represent that with a relocation to a null section.
 738   if (!RefA)
 739     return false;
 740
 741   MCSymbolRefExpr::VariantKind Kind = RefA->getKind();
 742   switch (Kind) {
 743   default:
 744     break;
 745   // The .odp creation emits a relocation against the symbol ".TOC." which
 746   // create a R_PPC64_TOC relocation. However the relocation symbol name
 747   // in final object creation should be NULL, since the symbol does not
 748   // really exist, it is just the reference to TOC base for the current
 749   // object file. Since the symbol is undefined, returning false results
 750   // in a relocation with a null section which is the desired result.
 751   case MCSymbolRefExpr::VK_PPC_TOCBASE:
 752     return false;
 753
 754   // These VariantKind cause the relocation to refer to something other than
 755   // the symbol itself, like a linker generated table. Since the address of
 756   // symbol is not relevant, we cannot replace the symbol with the
 757   // section and patch the difference in the addend.
 758   case MCSymbolRefExpr::VK_GOT:
 759   case MCSymbolRefExpr::VK_PLT:
 760   case MCSymbolRefExpr::VK_GOTPCREL:
 761   case MCSymbolRefExpr::VK_Mips_GOT:
 762   case MCSymbolRefExpr::VK_PPC_GOT_LO:
 763   case MCSymbolRefExpr::VK_PPC_GOT_HI:
 764   case MCSymbolRefExpr::VK_PPC_GOT_HA:
 765     return true;
 766   }
 767
 768   // An undefined symbol is not in any section, so the relocation has to point
 769   // to the symbol itself.
 770   const MCSymbol &Sym = SD->getSymbol();
 771   if (Sym.isUndefined())
 772     return true;
 773
 774   unsigned Binding = MCELF::GetBinding(*SD);
 775   switch(Binding) {
 776   default:
 777     llvm_unreachable("Invalid Binding");
 778   case ELF::STB_LOCAL:
 779     break;
 780   case ELF::STB_WEAK:
 781     // If the symbol is weak, it might be overridden by a symbol in another
 782     // file. The relocation has to point to the symbol so that the linker
 783     // can update it.
 784     return true;
 785   case ELF::STB_GLOBAL:
 786     // Global ELF symbols can be preempted by the dynamic linker. The relocation
 787     // has to point to the symbol for a reason analogous to the STB_WEAK case.
 788     return true;
 789   }
 790
 791   // If a relocation points to a mergeable section, we have to be careful.
 792   // If the offset is zero, a relocation with the section will encode the
 793   // same information. With a non-zero offset, the situation is different.
 794   // For example, a relocation can point 42 bytes past the end of a string.
 795   // If we change such a relocation to use the section, the linker would think
 796   // that it pointed to another string and subtracting 42 at runtime will
 797   // produce the wrong value.
 798   auto &Sec = cast<MCSectionELF>(Sym.getSection());
 799   unsigned Flags = Sec.getFlags();
 800   if (Flags & ELF::SHF_MERGE) {
 801     if (C != 0)
 802       return true;
 803
 804     // It looks like gold has a bug (http://sourceware.org/PR16794) and can
 805     // only handle section relocations to mergeable sections if using RELA.
 806     if (!hasRelocationAddend())
 807       return true;
 808   }
 809
 810   // Most TLS relocations use a got, so they need the symbol. Even those that
 811   // are just an offset (@tpoff), require a symbol in some linkers (gold,
 812   // but not bfd ld).
 813   if (Flags & ELF::SHF_TLS)
 814     return true;
 815
 816   // If the symbol is a thumb function the final relocation must set the lowest
 817   // bit. With a symbol that is done by just having the symbol have that bit
 818   // set, so we would lose the bit if we relocated with the section.
 819   // FIXME: We could use the section but add the bit to the relocation value.
 820   if (SD->getFlags() & ELF_Other_ThumbFunc)
 821     return true;
 822
 823   if (TargetObjectWriter->needsRelocateWithSymbol(Type))
 824     return true;
 825   return false;
 826 }
 827
 828 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
 829                                        const MCAsmLayout &Layout,
 830                                        const MCFragment *Fragment,
 831                                        const MCFixup &Fixup,
 832                                        MCValue Target,
 833                                        bool &IsPCRel,
 834                                        uint64_t &FixedValue) {
 835   const MCSectionData *FixupSection = Fragment->getParent();
 836   uint64_t C = Target.getConstant();
 837   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 838
 839   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
 840     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
 841            "Should not have constructed this");
 842
 843     // Let A, B and C being the components of Target and R be the location of
 844     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
 845     // If it is pcrel, we want to compute (A - B + C - R).
 846
 847     // In general, ELF has no relocations for -B. It can only represent (A + C)
 848     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
 849     // replace B to implement it: (A - R - K + C)
 850     if (IsPCRel)
 851       Asm.getContext().FatalError(
 852           Fixup.getLoc(),
 853           "No relocation available to represent this relative expression");
 854
 855     const MCSymbol &SymB = RefB->getSymbol();
 856
 857     if (SymB.isUndefined())
 858       Asm.getContext().FatalError(
 859           Fixup.getLoc(),
 860           Twine("symbol '") + SymB.getName() +
 861               "' can not be undefined in a subtraction expression");
 862
 863     assert(!SymB.isAbsolute() && "Should have been folded");
 864     const MCSection &SecB = SymB.getSection();
 865     if (&SecB != &FixupSection->getSection())
 866       Asm.getContext().FatalError(
 867           Fixup.getLoc(), "Cannot represent a difference across sections");
 868
 869     const MCSymbolData &SymBD = Asm.getSymbolData(SymB);
 870     uint64_t SymBOffset = Layout.getSymbolOffset(&SymBD);
 871     uint64_t K = SymBOffset - FixupOffset;
 872     IsPCRel = true;
 873     C -= K;
 874   }
 875
 876   // We either rejected the fixup or folded B into C at this point.
 877   const MCSymbolRefExpr *RefA = Target.getSymA();
 878   const MCSymbol *SymA = RefA ? &RefA->getSymbol() : nullptr;
 879   const MCSymbolData *SymAD = SymA ? &Asm.getSymbolData(*SymA) : nullptr;
 880
 881   unsigned Type = GetRelocType(Target, Fixup, IsPCRel);
 882   bool RelocateWithSymbol = shouldRelocateWithSymbol(RefA, SymAD, C, Type);
 883   if (!RelocateWithSymbol && SymA && !SymA->isUndefined())
 884     C += Layout.getSymbolOffset(SymAD);
 885
 886   uint64_t Addend = 0;
 887   if (hasRelocationAddend()) {
 888     Addend = C;
 889     C = 0;
 890   }
 891
 892   FixedValue = C;
 893
 894   // FIXME: What is this!?!?
 895   MCSymbolRefExpr::VariantKind Modifier =
 896       RefA ? RefA->getKind() : MCSymbolRefExpr::VK_None;
 897   if (RelocNeedsGOT(Modifier))
 898     NeedsGOT = true;
 899
 900   if (!RelocateWithSymbol) {
 901     const MCSection *SecA =
 902         (SymA && !SymA->isUndefined()) ? &SymA->getSection() : nullptr;
 903     const MCSectionData *SecAD = SecA ? &Asm.getSectionData(*SecA) : nullptr;
 904     ELFRelocationEntry Rec(FixupOffset, SecAD, Type, Addend);
 905     Relocations[FixupSection].push_back(Rec);
 906     return;
 907   }
 908
 909   if (SymA) {
 910     if (const MCSymbol *R = Renames.lookup(SymA))
 911       SymA = R;
 912
 913     if (RefA->getKind() == MCSymbolRefExpr::VK_WEAKREF)
 914       WeakrefUsedInReloc.insert(SymA);
 915     else
 916       UsedInReloc.insert(SymA);
 917   }
 918   ELFRelocationEntry Rec(FixupOffset, SymA, Type, Addend);
 919   Relocations[FixupSection].push_back(Rec);
 920   return;
 921 }
 922
 923
 924 uint64_t
 925 ELFObjectWriter::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
 926                                              const MCSymbol *S) {
 927   MCSymbolData &SD = Asm.getSymbolData(*S);
 928   return SD.getIndex();
 929 }
 930
 931 bool ELFObjectWriter::isInSymtab(const MCAssembler &Asm,
 932                                  const MCSymbolData &Data,
 933                                  bool Used, bool Renamed) {
 934   const MCSymbol &Symbol = Data.getSymbol();
 935   if (Symbol.isVariable()) {
 936     const MCExpr *Expr = Symbol.getVariableValue();
 937     if (const MCSymbolRefExpr *Ref = dyn_cast<MCSymbolRefExpr>(Expr)) {
 938       if (Ref->getKind() == MCSymbolRefExpr::VK_WEAKREF)
 939         return false;
 940     }
 941   }
 942
 943   if (Used)
 944     return true;
 945
 946   if (Renamed)
 947     return false;
 948
 949   if (Symbol.getName() == "_GLOBAL_OFFSET_TABLE_")
 950     return true;
 951
 952   const MCSymbol &A = Symbol.AliasedSymbol();
 953   if (Symbol.isVariable() && !A.isVariable() && A.isUndefined())
 954     return false;
 955
 956   bool IsGlobal = MCELF::GetBinding(Data) == ELF::STB_GLOBAL;
 957   if (!Symbol.isVariable() && Symbol.isUndefined() && !IsGlobal)
 958     return false;
 959
 960   if (Symbol.isTemporary())
 961     return false;
 962
 963   return true;
 964 }
 965
 966 bool ELFObjectWriter::isLocal(const MCSymbolData &Data, bool isSignature,
 967                               bool isUsedInReloc) {
 968   if (Data.isExternal())
 969     return false;
 970
 971   const MCSymbol &Symbol = Data.getSymbol();
 972   const MCSymbol &RefSymbol = Symbol.AliasedSymbol();
 973
 974   if (RefSymbol.isUndefined() && !RefSymbol.isVariable()) {
 975     if (isSignature && !isUsedInReloc)
 976       return true;
 977
 978     return false;
 979   }
 980
 981   return true;
 982 }
 983
 984 void ELFObjectWriter::ComputeIndexMap(MCAssembler &Asm,
 985                                       SectionIndexMapTy &SectionIndexMap,
 986                                       const RelMapTy &RelMap) {
 987   unsigned Index = 1;
 988   for (MCAssembler::iterator it = Asm.begin(),
 989          ie = Asm.end(); it != ie; ++it) {
 990     const MCSectionELF &Section =
 991       static_cast<const MCSectionELF &>(it->getSection());
 992     if (Section.getType() != ELF::SHT_GROUP)
 993       continue;
 994     SectionIndexMap[&Section] = Index++;
 995   }
 996
 997   for (MCAssembler::iterator it = Asm.begin(),
 998          ie = Asm.end(); it != ie; ++it) {
 999     const MCSectionELF &Section =
1000       static_cast<const MCSectionELF &>(it->getSection());
1001     if (Section.getType() == ELF::SHT_GROUP ||
1002         Section.getType() == ELF::SHT_REL ||
1003         Section.getType() == ELF::SHT_RELA)
1004       continue;
1005     SectionIndexMap[&Section] = Index++;
1006     const MCSectionELF *RelSection = RelMap.lookup(&Section);
1007     if (RelSection)
1008       SectionIndexMap[RelSection] = Index++;
1009   }
1010 }
1011
1012 void
1013 ELFObjectWriter::computeSymbolTable(MCAssembler &Asm, const MCAsmLayout &Layout,
1014                                     const SectionIndexMapTy &SectionIndexMap,
1015                                     RevGroupMapTy RevGroupMap,
1016                                     unsigned NumRegularSections) {
1017   // FIXME: Is this the correct place to do this?
1018   // FIXME: Why is an undefined reference to _GLOBAL_OFFSET_TABLE_ needed?
1019   if (NeedsGOT) {
1020     StringRef Name = "_GLOBAL_OFFSET_TABLE_";
1021     MCSymbol *Sym = Asm.getContext().GetOrCreateSymbol(Name);
1022     MCSymbolData &Data = Asm.getOrCreateSymbolData(*Sym);
1023     Data.setExternal(true);
1024     MCELF::SetBinding(Data, ELF::STB_GLOBAL);
1025   }
1026
1027   // Index 0 is always the empty string.
1028   StringMap<uint64_t> StringIndexMap;
1029   StringTable += '\x00';
1030
1031   // FIXME: We could optimize suffixes in strtab in the same way we
1032   // optimize them in shstrtab.
1033
1034   for (MCAssembler::const_file_name_iterator it = Asm.file_names_begin(),
1035                                             ie = Asm.file_names_end();
1036                                             it != ie;
1037                                             ++it) {
1038     StringRef Name = *it;
1039     uint64_t &Entry = StringIndexMap[Name];
1040     if (!Entry) {
1041       Entry = StringTable.size();
1042       StringTable += Name;
1043       StringTable += '\x00';
1044     }
1045     FileSymbolData.push_back(Entry);
1046   }
1047
1048   // Add the data for the symbols.
1049   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
1050          ie = Asm.symbol_end(); it != ie; ++it) {
1051     const MCSymbol &Symbol = it->getSymbol();
1052
1053     bool Used = UsedInReloc.count(&Symbol);
1054     bool WeakrefUsed = WeakrefUsedInReloc.count(&Symbol);
1055     bool isSignature = RevGroupMap.count(&Symbol);
1056
1057     if (!isInSymtab(Asm, *it,
1058                     Used || WeakrefUsed || isSignature,
1059                     Renames.count(&Symbol)))
1060       continue;
1061
1062     ELFSymbolData MSD;
1063     MSD.SymbolData = it;
1064     const MCSymbol *BaseSymbol = getBaseSymbol(Layout, Symbol);
1065
1066     // Undefined symbols are global, but this is the first place we
1067     // are able to set it.
1068     bool Local = isLocal(*it, isSignature, Used);
1069     if (!Local && MCELF::GetBinding(*it) == ELF::STB_LOCAL) {
1070       assert(BaseSymbol);
1071       MCSymbolData &SD = Asm.getSymbolData(*BaseSymbol);
1072       MCELF::SetBinding(*it, ELF::STB_GLOBAL);
1073       MCELF::SetBinding(SD, ELF::STB_GLOBAL);
1074     }
1075
1076     if (!BaseSymbol) {
1077       MSD.SectionIndex = ELF::SHN_ABS;
1078     } else if (it->isCommon()) {
1079       assert(!Local);
1080       MSD.SectionIndex = ELF::SHN_COMMON;
1081     } else if (BaseSymbol->isUndefined()) {
1082       if (isSignature && !Used)
1083         MSD.SectionIndex = SectionIndexMap.lookup(RevGroupMap[&Symbol]);
1084       else
1085         MSD.SectionIndex = ELF::SHN_UNDEF;
1086       if (!Used && WeakrefUsed)
1087         MCELF::SetBinding(*it, ELF::STB_WEAK);
1088     } else {
1089       const MCSectionELF &Section =
1090         static_cast<const MCSectionELF&>(BaseSymbol->getSection());
1091       MSD.SectionIndex = SectionIndexMap.lookup(&Section);
1092       assert(MSD.SectionIndex && "Invalid section index!");
1093     }
1094
1095     // The @@@ in symbol version is replaced with @ in undefined symbols and
1096     // @@ in defined ones.
1097     StringRef Name = Symbol.getName();
1098     SmallString<32> Buf;
1099
1100     size_t Pos = Name.find("@@@");
1101     if (Pos != StringRef::npos) {
1102       Buf += Name.substr(0, Pos);
1103       unsigned Skip = MSD.SectionIndex == ELF::SHN_UNDEF ? 2 : 1;
1104       Buf += Name.substr(Pos + Skip);
1105       Name = Buf;
1106     }
1107
1108     uint64_t &Entry = StringIndexMap[Name];
1109     if (!Entry) {
1110       Entry = StringTable.size();
1111       StringTable += Name;
1112       StringTable += '\x00';
1113     }
1114     MSD.StringIndex = Entry;
1115     if (MSD.SectionIndex == ELF::SHN_UNDEF)
1116       UndefinedSymbolData.push_back(MSD);
1117     else if (Local)
1118       LocalSymbolData.push_back(MSD);
1119     else
1120       ExternalSymbolData.push_back(MSD);
1121   }
1122
1123   // Symbols are required to be in lexicographic order.
1124   array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
1125   array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
1126   array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
1127
1128   // Set the symbol indices. Local symbols must come before all other
1129   // symbols with non-local bindings.
1130   unsigned Index = FileSymbolData.size() + 1;
1131   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1132     LocalSymbolData[i].SymbolData->setIndex(Index++);
1133
1134   Index += NumRegularSections;
1135
1136   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1137     ExternalSymbolData[i].SymbolData->setIndex(Index++);
1138   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1139     UndefinedSymbolData[i].SymbolData->setIndex(Index++);
1140 }
1141
1142 void ELFObjectWriter::CreateRelocationSections(MCAssembler &Asm,
1143                                                MCAsmLayout &Layout,
1144                                                RelMapTy &RelMap) {
1145   for (MCAssembler::const_iterator it = Asm.begin(),
1146          ie = Asm.end(); it != ie; ++it) {
1147     const MCSectionData &SD = *it;
1148     if (Relocations[&SD].empty())
1149       continue;
1150
1151     MCContext &Ctx = Asm.getContext();
1152     const MCSectionELF &Section =
1153       static_cast<const MCSectionELF&>(SD.getSection());
1154
1155     const StringRef SectionName = Section.getSectionName();
1156     std::string RelaSectionName = hasRelocationAddend() ? ".rela" : ".rel";
1157     RelaSectionName += SectionName;
1158
1159     unsigned EntrySize;
1160     if (hasRelocationAddend())
1161       EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
1162     else
1163       EntrySize = is64Bit() ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
1164
1165     unsigned Flags = 0;
1166     StringRef Group = "";
1167     if (Section.getFlags() & ELF::SHF_GROUP) {
1168       Flags = ELF::SHF_GROUP;
1169       Group = Section.getGroup()->getName();
1170     }
1171
1172     const MCSectionELF *RelaSection =
1173       Ctx.getELFSection(RelaSectionName, hasRelocationAddend() ?
1174                         ELF::SHT_RELA : ELF::SHT_REL, Flags,
1175                         SectionKind::getReadOnly(),
1176                         EntrySize, Group);
1177     RelMap[&Section] = RelaSection;
1178     Asm.getOrCreateSectionData(*RelaSection);
1179   }
1180 }
1181
1182 static SmallVector<char, 128> getUncompressedData(MCAsmLayout &Layout, 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 prependCompressionHeader(uint64_t Size, SmallVectorImpl<char> &CompressedContents) {
1209   static const StringRef Magic = "ZLIB";
1210   if (sys::IsLittleEndianHost)
1211     Size = sys::SwapByteOrder(Size);
1212   CompressedContents.insert(CompressedContents.begin(),
1213                             Magic.size() + sizeof(Size), 0);
1214   std::copy(Magic.begin(), Magic.end(), CompressedContents.begin());
1215   std::copy(reinterpret_cast<char *>(&Size),
1216             reinterpret_cast<char *>(&Size + 1),
1217             CompressedContents.begin() + Magic.size());
1218 }
1219
1220 // Return a single fragment containing the compressed contents of the whole
1221 // section. Null if the section was not compressed for any reason.
1222 static std::unique_ptr<MCDataFragment> getCompressedFragment(MCAsmLayout &Layout, MCSectionData::FragmentListType &Fragments) {
1223   std::unique_ptr<MCDataFragment> CompressedFragment(new MCDataFragment());
1224
1225   // Gather the uncompressed data from all the fragments, recording the
1226   // alignment fragment, if seen, and any fixups.
1227   SmallVector<char, 128> UncompressedData =
1228       getUncompressedData(Layout, Fragments);
1229
1230   SmallVectorImpl<char> &CompressedContents = CompressedFragment->getContents();
1231
1232   zlib::Status Success = zlib::compress(
1233       StringRef(UncompressedData.data(), UncompressedData.size()),
1234       CompressedContents);
1235   if (Success != zlib::StatusOK)
1236     return nullptr;
1237
1238   prependCompressionHeader(UncompressedData.size(), CompressedContents);
1239
1240   return CompressedFragment;
1241 }
1242
1243 static void CompressDebugSection(MCAssembler &Asm, MCAsmLayout &Layout,
1244                                  const MCSectionELF &Section,
1245                                  MCSectionData &SD) {
1246   StringRef SectionName = Section.getSectionName();
1247   MCSectionData::FragmentListType &Fragments = SD.getFragmentList();
1248
1249   std::unique_ptr<MCDataFragment> CompressedFragment =
1250       getCompressedFragment(Layout, Fragments);
1251
1252   // Leave the section as-is if the fragments could not be compressed.
1253   if (!CompressedFragment)
1254     return;
1255
1256   // Invalidate the layout for the whole section since it will have new and
1257   // different fragments now.
1258   Layout.invalidateFragmentsFrom(&Fragments.front());
1259   Fragments.clear();
1260
1261   // Complete the initialization of the new fragment
1262   CompressedFragment->setParent(&SD);
1263   CompressedFragment->setLayoutOrder(0);
1264   Fragments.push_back(CompressedFragment.release());
1265
1266   // Rename from .debug_* to .zdebug_*
1267   Asm.getContext().renameELFSection(&Section,
1268                                     (".z" + SectionName.drop_front(1)).str());
1269 }
1270
1271 void ELFObjectWriter::CompressDebugSections(MCAssembler &Asm,
1272                                             MCAsmLayout &Layout) {
1273   if (!Asm.getContext().getAsmInfo()->compressDebugSections())
1274     return;
1275
1276   for (MCSectionData &SD : Asm) {
1277     const MCSectionELF &Section = static_cast<const MCSectionELF&>(SD.getSection());
1278     StringRef SectionName = Section.getSectionName();
1279
1280     // Compressing debug_frame requires handling alignment fragments which is
1281     // more work (possibly generalizing MCAssembler.cpp:writeFragment to allow
1282     // for writing to arbitrary buffers) for little benefit.
1283     if (!SectionName.startswith(".debug_") || SectionName == ".debug_frame")
1284       continue;
1285
1286     CompressDebugSection(Asm, Layout, Section, SD);
1287   }
1288 }
1289
1290 void ELFObjectWriter::WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout,
1291                                        const RelMapTy &RelMap) {
1292   for (MCAssembler::const_iterator it = Asm.begin(),
1293          ie = Asm.end(); it != ie; ++it) {
1294     const MCSectionData &SD = *it;
1295     const MCSectionELF &Section =
1296       static_cast<const MCSectionELF&>(SD.getSection());
1297
1298     const MCSectionELF *RelaSection = RelMap.lookup(&Section);
1299     if (!RelaSection)
1300       continue;
1301     MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
1302     RelaSD.setAlignment(is64Bit() ? 8 : 4);
1303
1304     MCDataFragment *F = new MCDataFragment(&RelaSD);
1305     WriteRelocationsFragment(Asm, F, &*it);
1306   }
1307 }
1308
1309 void ELFObjectWriter::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
1310                                        uint64_t Flags, uint64_t Address,
1311                                        uint64_t Offset, uint64_t Size,
1312                                        uint32_t Link, uint32_t Info,
1313                                        uint64_t Alignment,
1314                                        uint64_t EntrySize) {
1315   Write32(Name);        // sh_name: index into string table
1316   Write32(Type);        // sh_type
1317   WriteWord(Flags);     // sh_flags
1318   WriteWord(Address);   // sh_addr
1319   WriteWord(Offset);    // sh_offset
1320   WriteWord(Size);      // sh_size
1321   Write32(Link);        // sh_link
1322   Write32(Info);        // sh_info
1323   WriteWord(Alignment); // sh_addralign
1324   WriteWord(EntrySize); // sh_entsize
1325 }
1326
1327 // ELF doesn't require relocations to be in any order. We sort by the r_offset,
1328 // just to match gnu as for easier comparison. The use type is an arbitrary way
1329 // of making the sort deterministic.
1330 static int cmpRel(const ELFRelocationEntry *AP, const ELFRelocationEntry *BP) {
1331   const ELFRelocationEntry &A = *AP;
1332   const ELFRelocationEntry &B = *BP;
1333   if (A.Offset != B.Offset)
1334     return B.Offset - A.Offset;
1335   if (B.Type != A.Type)
1336     return A.Type - B.Type;
1337   llvm_unreachable("ELFRelocs might be unstable!");
1338 }
1339
1340 static void sortRelocs(const MCAssembler &Asm,
1341                        std::vector<ELFRelocationEntry> &Relocs) {
1342   array_pod_sort(Relocs.begin(), Relocs.end(), cmpRel);
1343 }
1344
1345 void ELFObjectWriter::WriteRelocationsFragment(const MCAssembler &Asm,
1346                                                MCDataFragment *F,
1347                                                const MCSectionData *SD) {
1348   std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
1349
1350   sortRelocs(Asm, Relocs);
1351
1352   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1353     const ELFRelocationEntry &Entry = Relocs[e - i - 1];
1354
1355     unsigned Index;
1356     if (Entry.UseSymbol) {
1357       Index = getSymbolIndexInSymbolTable(Asm, Entry.Symbol);
1358     } else {
1359       const MCSectionData *Sec = Entry.Section;
1360       if (Sec)
1361         Index = Sec->getOrdinal() + FileSymbolData.size() +
1362                 LocalSymbolData.size() + 1;
1363       else
1364         Index = 0;
1365     }
1366
1367     if (is64Bit()) {
1368       write(*F, Entry.Offset);
1369       if (TargetObjectWriter->isN64()) {
1370         write(*F, uint32_t(Index));
1371
1372         write(*F, TargetObjectWriter->getRSsym(Entry.Type));
1373         write(*F, TargetObjectWriter->getRType3(Entry.Type));
1374         write(*F, TargetObjectWriter->getRType2(Entry.Type));
1375         write(*F, TargetObjectWriter->getRType(Entry.Type));
1376       } else {
1377         struct ELF::Elf64_Rela ERE64;
1378         ERE64.setSymbolAndType(Index, Entry.Type);
1379         write(*F, ERE64.r_info);
1380       }
1381       if (hasRelocationAddend())
1382         write(*F, Entry.Addend);
1383     } else {
1384       write(*F, uint32_t(Entry.Offset));
1385
1386       struct ELF::Elf32_Rela ERE32;
1387       ERE32.setSymbolAndType(Index, Entry.Type);
1388       write(*F, ERE32.r_info);
1389
1390       if (hasRelocationAddend())
1391         write(*F, uint32_t(Entry.Addend));
1392     }
1393   }
1394 }
1395
1396 static int compareBySuffix(const MCSectionELF *const *a,
1397                            const MCSectionELF *const *b) {
1398   const StringRef &NameA = (*a)->getSectionName();
1399   const StringRef &NameB = (*b)->getSectionName();
1400   const unsigned sizeA = NameA.size();
1401   const unsigned sizeB = NameB.size();
1402   const unsigned len = std::min(sizeA, sizeB);
1403   for (unsigned int i = 0; i < len; ++i) {
1404     char ca = NameA[sizeA - i - 1];
1405     char cb = NameB[sizeB - i - 1];
1406     if (ca != cb)
1407       return cb - ca;
1408   }
1409
1410   return sizeB - sizeA;
1411 }
1412
1413 void ELFObjectWriter::CreateMetadataSections(MCAssembler &Asm,
1414                                              MCAsmLayout &Layout,
1415                                              SectionIndexMapTy &SectionIndexMap,
1416                                              const RelMapTy &RelMap) {
1417   MCContext &Ctx = Asm.getContext();
1418   MCDataFragment *F;
1419
1420   unsigned EntrySize = is64Bit() ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
1421
1422   // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
1423   const MCSectionELF *ShstrtabSection =
1424     Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
1425                       SectionKind::getReadOnly());
1426   MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
1427   ShstrtabSD.setAlignment(1);
1428
1429   const MCSectionELF *SymtabSection =
1430     Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1431                       SectionKind::getReadOnly(),
1432                       EntrySize, "");
1433   MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
1434   SymtabSD.setAlignment(is64Bit() ? 8 : 4);
1435
1436   const MCSectionELF *StrtabSection;
1437   StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
1438                                     SectionKind::getReadOnly());
1439   MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
1440   StrtabSD.setAlignment(1);
1441
1442   ComputeIndexMap(Asm, SectionIndexMap, RelMap);
1443
1444   ShstrtabIndex = SectionIndexMap.lookup(ShstrtabSection);
1445   SymbolTableIndex = SectionIndexMap.lookup(SymtabSection);
1446   StringTableIndex = SectionIndexMap.lookup(StrtabSection);
1447
1448   // Symbol table
1449   F = new MCDataFragment(&SymtabSD);
1450   WriteSymbolTable(F, Asm, Layout, SectionIndexMap);
1451
1452   F = new MCDataFragment(&StrtabSD);
1453   F->getContents().append(StringTable.begin(), StringTable.end());
1454
1455   F = new MCDataFragment(&ShstrtabSD);
1456
1457   std::vector<const MCSectionELF*> Sections;
1458   for (MCAssembler::const_iterator it = Asm.begin(),
1459          ie = Asm.end(); it != ie; ++it) {
1460     const MCSectionELF &Section =
1461       static_cast<const MCSectionELF&>(it->getSection());
1462     Sections.push_back(&Section);
1463   }
1464   array_pod_sort(Sections.begin(), Sections.end(), compareBySuffix);
1465
1466   // Section header string table.
1467   //
1468   // The first entry of a string table holds a null character so skip
1469   // section 0.
1470   uint64_t Index = 1;
1471   F->getContents().push_back('\x00');
1472
1473   for (unsigned int I = 0, E = Sections.size(); I != E; ++I) {
1474     const MCSectionELF &Section = *Sections[I];
1475
1476     StringRef Name = Section.getSectionName();
1477     if (I != 0) {
1478       StringRef PreviousName = Sections[I - 1]->getSectionName();
1479       if (PreviousName.endswith(Name)) {
1480         SectionStringTableIndex[&Section] = Index - Name.size() - 1;
1481         continue;
1482       }
1483     }
1484     // Remember the index into the string table so we can write it
1485     // into the sh_name field of the section header table.
1486     SectionStringTableIndex[&Section] = Index;
1487
1488     Index += Name.size() + 1;
1489     F->getContents().append(Name.begin(), Name.end());
1490     F->getContents().push_back('\x00');
1491   }
1492 }
1493
1494 void ELFObjectWriter::CreateIndexedSections(MCAssembler &Asm,
1495                                             MCAsmLayout &Layout,
1496                                             GroupMapTy &GroupMap,
1497                                             RevGroupMapTy &RevGroupMap,
1498                                             SectionIndexMapTy &SectionIndexMap,
1499                                             const RelMapTy &RelMap) {
1500   // Create the .note.GNU-stack section if needed.
1501   MCContext &Ctx = Asm.getContext();
1502   if (Asm.getNoExecStack()) {
1503     const MCSectionELF *GnuStackSection =
1504       Ctx.getELFSection(".note.GNU-stack", ELF::SHT_PROGBITS, 0,
1505                         SectionKind::getReadOnly());
1506     Asm.getOrCreateSectionData(*GnuStackSection);
1507   }
1508
1509   // Build the groups
1510   for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1511        it != ie; ++it) {
1512     const MCSectionELF &Section =
1513       static_cast<const MCSectionELF&>(it->getSection());
1514     if (!(Section.getFlags() & ELF::SHF_GROUP))
1515       continue;
1516
1517     const MCSymbol *SignatureSymbol = Section.getGroup();
1518     Asm.getOrCreateSymbolData(*SignatureSymbol);
1519     const MCSectionELF *&Group = RevGroupMap[SignatureSymbol];
1520     if (!Group) {
1521       Group = Ctx.CreateELFGroupSection();
1522       MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1523       Data.setAlignment(4);
1524       MCDataFragment *F = new MCDataFragment(&Data);
1525       write(*F, uint32_t(ELF::GRP_COMDAT));
1526     }
1527     GroupMap[Group] = SignatureSymbol;
1528   }
1529
1530   ComputeIndexMap(Asm, SectionIndexMap, RelMap);
1531
1532   // Add sections to the groups
1533   for (MCAssembler::const_iterator it = Asm.begin(), ie = Asm.end();
1534        it != ie; ++it) {
1535     const MCSectionELF &Section =
1536       static_cast<const MCSectionELF&>(it->getSection());
1537     if (!(Section.getFlags() & ELF::SHF_GROUP))
1538       continue;
1539     const MCSectionELF *Group = RevGroupMap[Section.getGroup()];
1540     MCSectionData &Data = Asm.getOrCreateSectionData(*Group);
1541     // FIXME: we could use the previous fragment
1542     MCDataFragment *F = new MCDataFragment(&Data);
1543     uint32_t Index = SectionIndexMap.lookup(&Section);
1544     write(*F, Index);
1545   }
1546 }
1547
1548 void ELFObjectWriter::WriteSection(MCAssembler &Asm,
1549                                    const SectionIndexMapTy &SectionIndexMap,
1550                                    uint32_t GroupSymbolIndex,
1551                                    uint64_t Offset, uint64_t Size,
1552                                    uint64_t Alignment,
1553                                    const MCSectionELF &Section) {
1554   uint64_t sh_link = 0;
1555   uint64_t sh_info = 0;
1556
1557   switch(Section.getType()) {
1558   case ELF::SHT_DYNAMIC:
1559     sh_link = SectionStringTableIndex[&Section];
1560     sh_info = 0;
1561     break;
1562
1563   case ELF::SHT_REL:
1564   case ELF::SHT_RELA: {
1565     const MCSectionELF *SymtabSection;
1566     const MCSectionELF *InfoSection;
1567     SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB,
1568                                                    0,
1569                                                    SectionKind::getReadOnly());
1570     sh_link = SectionIndexMap.lookup(SymtabSection);
1571     assert(sh_link && ".symtab not found");
1572
1573     // Remove ".rel" and ".rela" prefixes.
1574     unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1575     StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1576     StringRef GroupName =
1577         Section.getGroup() ? Section.getGroup()->getName() : "";
1578
1579     InfoSection = Asm.getContext().getELFSection(SectionName, ELF::SHT_PROGBITS,
1580                                                  0, SectionKind::getReadOnly(),
1581                                                  0, GroupName);
1582     sh_info = SectionIndexMap.lookup(InfoSection);
1583     break;
1584   }
1585
1586   case ELF::SHT_SYMTAB:
1587   case ELF::SHT_DYNSYM:
1588     sh_link = StringTableIndex;
1589     sh_info = LastLocalSymbolIndex;
1590     break;
1591
1592   case ELF::SHT_SYMTAB_SHNDX:
1593     sh_link = SymbolTableIndex;
1594     break;
1595
1596   case ELF::SHT_PROGBITS:
1597   case ELF::SHT_STRTAB:
1598   case ELF::SHT_NOBITS:
1599   case ELF::SHT_NOTE:
1600   case ELF::SHT_NULL:
1601   case ELF::SHT_ARM_ATTRIBUTES:
1602   case ELF::SHT_INIT_ARRAY:
1603   case ELF::SHT_FINI_ARRAY:
1604   case ELF::SHT_PREINIT_ARRAY:
1605   case ELF::SHT_X86_64_UNWIND:
1606   case ELF::SHT_MIPS_REGINFO:
1607   case ELF::SHT_MIPS_OPTIONS:
1608     // Nothing to do.
1609     break;
1610
1611   case ELF::SHT_GROUP:
1612     sh_link = SymbolTableIndex;
1613     sh_info = GroupSymbolIndex;
1614     break;
1615
1616   default:
1617     assert(0 && "FIXME: sh_type value not supported!");
1618     break;
1619   }
1620
1621   if (TargetObjectWriter->getEMachine() == ELF::EM_ARM &&
1622       Section.getType() == ELF::SHT_ARM_EXIDX) {
1623     StringRef SecName(Section.getSectionName());
1624     if (SecName == ".ARM.exidx") {
1625       sh_link = SectionIndexMap.lookup(
1626         Asm.getContext().getELFSection(".text",
1627                                        ELF::SHT_PROGBITS,
1628                                        ELF::SHF_EXECINSTR | ELF::SHF_ALLOC,
1629                                        SectionKind::getText()));
1630     } else if (SecName.startswith(".ARM.exidx")) {
1631       StringRef GroupName =
1632           Section.getGroup() ? Section.getGroup()->getName() : "";
1633       sh_link = SectionIndexMap.lookup(Asm.getContext().getELFSection(
1634           SecName.substr(sizeof(".ARM.exidx") - 1), ELF::SHT_PROGBITS,
1635           ELF::SHF_EXECINSTR | ELF::SHF_ALLOC, SectionKind::getText(), 0,
1636           GroupName));
1637     }
1638   }
1639
1640   WriteSecHdrEntry(SectionStringTableIndex[&Section], Section.getType(),
1641                    Section.getFlags(), 0, Offset, Size, sh_link, sh_info,
1642                    Alignment, Section.getEntrySize());
1643 }
1644
1645 bool ELFObjectWriter::IsELFMetaDataSection(const MCSectionData &SD) {
1646   return SD.getOrdinal() == ~UINT32_C(0) &&
1647     !SD.getSection().isVirtualSection();
1648 }
1649
1650 uint64_t ELFObjectWriter::DataSectionSize(const MCSectionData &SD) {
1651   uint64_t Ret = 0;
1652   for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1653        ++i) {
1654     const MCFragment &F = *i;
1655     assert(F.getKind() == MCFragment::FT_Data);
1656     Ret += cast<MCDataFragment>(F).getContents().size();
1657   }
1658   return Ret;
1659 }
1660
1661 uint64_t ELFObjectWriter::GetSectionFileSize(const MCAsmLayout &Layout,
1662                                              const MCSectionData &SD) {
1663   if (IsELFMetaDataSection(SD))
1664     return DataSectionSize(SD);
1665   return Layout.getSectionFileSize(&SD);
1666 }
1667
1668 uint64_t ELFObjectWriter::GetSectionAddressSize(const MCAsmLayout &Layout,
1669                                                 const MCSectionData &SD) {
1670   if (IsELFMetaDataSection(SD))
1671     return DataSectionSize(SD);
1672   return Layout.getSectionAddressSize(&SD);
1673 }
1674
1675 void ELFObjectWriter::WriteDataSectionData(MCAssembler &Asm,
1676                                            const MCAsmLayout &Layout,
1677                                            const MCSectionELF &Section) {
1678   const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1679
1680   uint64_t Padding = OffsetToAlignment(OS.tell(), SD.getAlignment());
1681   WriteZeros(Padding);
1682
1683   if (IsELFMetaDataSection(SD)) {
1684     for (MCSectionData::const_iterator i = SD.begin(), e = SD.end(); i != e;
1685          ++i) {
1686       const MCFragment &F = *i;
1687       assert(F.getKind() == MCFragment::FT_Data);
1688       WriteBytes(cast<MCDataFragment>(F).getContents());
1689     }
1690   } else {
1691     Asm.writeSectionData(&SD, Layout);
1692   }
1693 }
1694
1695 void ELFObjectWriter::WriteSectionHeader(MCAssembler &Asm,
1696                                          const GroupMapTy &GroupMap,
1697                                          const MCAsmLayout &Layout,
1698                                       const SectionIndexMapTy &SectionIndexMap,
1699                                    const SectionOffsetMapTy &SectionOffsetMap) {
1700   const unsigned NumSections = Asm.size() + 1;
1701
1702   std::vector<const MCSectionELF*> Sections;
1703   Sections.resize(NumSections - 1);
1704
1705   for (SectionIndexMapTy::const_iterator i=
1706          SectionIndexMap.begin(), e = SectionIndexMap.end(); i != e; ++i) {
1707     const std::pair<const MCSectionELF*, uint32_t> &p = *i;
1708     Sections[p.second - 1] = p.first;
1709   }
1710
1711   // Null section first.
1712   uint64_t FirstSectionSize =
1713     NumSections >= ELF::SHN_LORESERVE ? NumSections : 0;
1714   uint32_t FirstSectionLink =
1715     ShstrtabIndex >= ELF::SHN_LORESERVE ? ShstrtabIndex : 0;
1716   WriteSecHdrEntry(0, 0, 0, 0, 0, FirstSectionSize, FirstSectionLink, 0, 0, 0);
1717
1718   for (unsigned i = 0; i < NumSections - 1; ++i) {
1719     const MCSectionELF &Section = *Sections[i];
1720     const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1721     uint32_t GroupSymbolIndex;
1722     if (Section.getType() != ELF::SHT_GROUP)
1723       GroupSymbolIndex = 0;
1724     else
1725       GroupSymbolIndex = getSymbolIndexInSymbolTable(Asm,
1726                                                      GroupMap.lookup(&Section));
1727
1728     uint64_t Size = GetSectionAddressSize(Layout, SD);
1729
1730     WriteSection(Asm, SectionIndexMap, GroupSymbolIndex,
1731                  SectionOffsetMap.lookup(&Section), Size,
1732                  SD.getAlignment(), Section);
1733   }
1734 }
1735
1736 void ELFObjectWriter::ComputeSectionOrder(MCAssembler &Asm,
1737                                   std::vector<const MCSectionELF*> &Sections) {
1738   for (MCAssembler::iterator it = Asm.begin(),
1739          ie = Asm.end(); it != ie; ++it) {
1740     const MCSectionELF &Section =
1741       static_cast<const MCSectionELF &>(it->getSection());
1742     if (Section.getType() == ELF::SHT_GROUP)
1743       Sections.push_back(&Section);
1744   }
1745
1746   for (MCAssembler::iterator it = Asm.begin(),
1747          ie = Asm.end(); it != ie; ++it) {
1748     const MCSectionELF &Section =
1749       static_cast<const MCSectionELF &>(it->getSection());
1750     if (Section.getType() != ELF::SHT_GROUP &&
1751         Section.getType() != ELF::SHT_REL &&
1752         Section.getType() != ELF::SHT_RELA)
1753       Sections.push_back(&Section);
1754   }
1755
1756   for (MCAssembler::iterator it = Asm.begin(),
1757          ie = Asm.end(); it != ie; ++it) {
1758     const MCSectionELF &Section =
1759       static_cast<const MCSectionELF &>(it->getSection());
1760     if (Section.getType() == ELF::SHT_REL ||
1761         Section.getType() == ELF::SHT_RELA)
1762       Sections.push_back(&Section);
1763   }
1764 }
1765
1766 void ELFObjectWriter::WriteObject(MCAssembler &Asm,
1767                                   const MCAsmLayout &Layout) {
1768   GroupMapTy GroupMap;
1769   RevGroupMapTy RevGroupMap;
1770   SectionIndexMapTy SectionIndexMap;
1771
1772   unsigned NumUserSections = Asm.size();
1773
1774   CompressDebugSections(Asm, const_cast<MCAsmLayout&>(Layout));
1775
1776   DenseMap<const MCSectionELF*, const MCSectionELF*> RelMap;
1777   CreateRelocationSections(Asm, const_cast<MCAsmLayout&>(Layout), RelMap);
1778
1779   const unsigned NumUserAndRelocSections = Asm.size();
1780   CreateIndexedSections(Asm, const_cast<MCAsmLayout&>(Layout), GroupMap,
1781                         RevGroupMap, SectionIndexMap, RelMap);
1782   const unsigned AllSections = Asm.size();
1783   const unsigned NumIndexedSections = AllSections - NumUserAndRelocSections;
1784
1785   unsigned NumRegularSections = NumUserSections + NumIndexedSections;
1786
1787   // Compute symbol table information.
1788   computeSymbolTable(Asm, Layout, SectionIndexMap, RevGroupMap,
1789                      NumRegularSections);
1790
1791   WriteRelocations(Asm, const_cast<MCAsmLayout&>(Layout), RelMap);
1792
1793   CreateMetadataSections(const_cast<MCAssembler&>(Asm),
1794                          const_cast<MCAsmLayout&>(Layout),
1795                          SectionIndexMap,
1796                          RelMap);
1797
1798   uint64_t NaturalAlignment = is64Bit() ? 8 : 4;
1799   uint64_t HeaderSize = is64Bit() ? sizeof(ELF::Elf64_Ehdr) :
1800                                     sizeof(ELF::Elf32_Ehdr);
1801   uint64_t FileOff = HeaderSize;
1802
1803   std::vector<const MCSectionELF*> Sections;
1804   ComputeSectionOrder(Asm, Sections);
1805   unsigned NumSections = Sections.size();
1806   SectionOffsetMapTy SectionOffsetMap;
1807   for (unsigned i = 0; i < NumRegularSections + 1; ++i) {
1808     const MCSectionELF &Section = *Sections[i];
1809     const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1810
1811     FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1812
1813     // Remember the offset into the file for this section.
1814     SectionOffsetMap[&Section] = FileOff;
1815
1816     // Get the size of the section in the output file (including padding).
1817     FileOff += GetSectionFileSize(Layout, SD);
1818   }
1819
1820   FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
1821
1822   const unsigned SectionHeaderOffset = FileOff - HeaderSize;
1823
1824   uint64_t SectionHeaderEntrySize = is64Bit() ?
1825     sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr);
1826   FileOff += (NumSections + 1) * SectionHeaderEntrySize;
1827
1828   for (unsigned i = NumRegularSections + 1; i < NumSections; ++i) {
1829     const MCSectionELF &Section = *Sections[i];
1830     const MCSectionData &SD = Asm.getOrCreateSectionData(Section);
1831
1832     FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
1833
1834     // Remember the offset into the file for this section.
1835     SectionOffsetMap[&Section] = FileOff;
1836
1837     // Get the size of the section in the output file (including padding).
1838     FileOff += GetSectionFileSize(Layout, SD);
1839   }
1840
1841   // Write out the ELF header ...
1842   WriteHeader(Asm, SectionHeaderOffset, NumSections + 1);
1843
1844   // ... then the regular sections ...
1845   // + because of .shstrtab
1846   for (unsigned i = 0; i < NumRegularSections + 1; ++i)
1847     WriteDataSectionData(Asm, Layout, *Sections[i]);
1848
1849   uint64_t Padding = OffsetToAlignment(OS.tell(), NaturalAlignment);
1850   WriteZeros(Padding);
1851
1852   // ... then the section header table ...
1853   WriteSectionHeader(Asm, GroupMap, Layout, SectionIndexMap,
1854                      SectionOffsetMap);
1855
1856   // ... and then the remaining sections ...
1857   for (unsigned i = NumRegularSections + 1; i < NumSections; ++i)
1858     WriteDataSectionData(Asm, Layout, *Sections[i]);
1859 }
1860
1861 bool
1862 ELFObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
1863                                                       const MCSymbolData &DataA,
1864                                                       const MCFragment &FB,
1865                                                       bool InSet,
1866                                                       bool IsPCRel) const {
1867   if (DataA.getFlags() & ELF_STB_Weak || MCELF::GetType(DataA) == ELF::STT_GNU_IFUNC)
1868     return false;
1869   return MCObjectWriter::IsSymbolRefDifferenceFullyResolvedImpl(
1870                                                  Asm, DataA, FB,InSet, IsPCRel);
1871 }
1872
1873 MCObjectWriter *llvm::createELFObjectWriter(MCELFObjectTargetWriter *MOTW,
1874                                             raw_ostream &OS,
1875                                             bool IsLittleEndian) {
1876   return new ELFObjectWriter(MOTW, OS, IsLittleEndian);
1877 }