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/ELFObjectWriter.h"
  15 #include "llvm/ADT/STLExtras.h"
  16 #include "llvm/ADT/StringMap.h"
  17 #include "llvm/ADT/Twine.h"
  18 #include "llvm/MC/MCAssembler.h"
  19 #include "llvm/MC/MCAsmLayout.h"
  20 #include "llvm/MC/MCContext.h"
  21 #include "llvm/MC/MCELFSymbolFlags.h"
  22 #include "llvm/MC/MCExpr.h"
  23 #include "llvm/MC/MCObjectWriter.h"
  24 #include "llvm/MC/MCSectionELF.h"
  25 #include "llvm/MC/MCSymbol.h"
  26 #include "llvm/MC/MCValue.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Support/ELF.h"
  30 #include "llvm/Target/TargetAsmBackend.h"
  31
  32 #include "../Target/X86/X86FixupKinds.h"
  33
  34 #include <vector>
  35 using namespace llvm;
  36
  37 static unsigned GetType(const MCSymbolData &SD) {
  38   uint32_t Type = (SD.getFlags() & (0xf << ELF_STT_Shift)) >> ELF_STT_Shift;
  39   assert(Type == ELF::STT_NOTYPE || Type == ELF::STT_OBJECT ||
  40          Type == ELF::STT_FUNC || Type == ELF::STT_SECTION ||
  41          Type == ELF::STT_FILE || Type == ELF::STT_COMMON ||
  42          Type == ELF::STT_TLS);
  43   return Type;
  44 }
  45
  46 static unsigned GetBinding(const MCSymbolData &SD) {
  47   uint32_t Binding = (SD.getFlags() & (0xf << ELF_STB_Shift)) >> ELF_STB_Shift;
  48   assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
  49          Binding == ELF::STB_WEAK);
  50   return Binding;
  51 }
  52
  53 static void SetBinding(MCSymbolData &SD, unsigned Binding) {
  54   assert(Binding == ELF::STB_LOCAL || Binding == ELF::STB_GLOBAL ||
  55          Binding == ELF::STB_WEAK);
  56   uint32_t OtherFlags = SD.getFlags() & ~(0xf << ELF_STB_Shift);
  57   SD.setFlags(OtherFlags | (Binding << ELF_STB_Shift));
  58 }
  59
  60 namespace {
  61
  62   class ELFObjectWriterImpl {
  63     static bool isFixupKindX86PCRel(unsigned Kind) {
  64       switch (Kind) {
  65       default:
  66         return false;
  67       case X86::reloc_pcrel_1byte:
  68       case X86::reloc_pcrel_4byte:
  69       case X86::reloc_riprel_4byte:
  70       case X86::reloc_riprel_4byte_movq_load:
  71         return true;
  72       }
  73     }
  74
  75     /*static bool isFixupKindX86RIPRel(unsigned Kind) {
  76       return Kind == X86::reloc_riprel_4byte ||
  77         Kind == X86::reloc_riprel_4byte_movq_load;
  78     }*/
  79
  80
  81     /// ELFSymbolData - Helper struct for containing some precomputed information
  82     /// on symbols.
  83     struct ELFSymbolData {
  84       MCSymbolData *SymbolData;
  85       uint64_t StringIndex;
  86       uint32_t SectionIndex;
  87
  88       // Support lexicographic sorting.
  89       bool operator<(const ELFSymbolData &RHS) const {
  90         if (GetType(*SymbolData) == ELF::STT_FILE)
  91           return true;
  92         if (GetType(*RHS.SymbolData) == ELF::STT_FILE)
  93           return false;
  94         return SymbolData->getSymbol().getName() <
  95                RHS.SymbolData->getSymbol().getName();
  96       }
  97     };
  98
  99     /// @name Relocation Data
 100     /// @{
 101
 102     struct ELFRelocationEntry {
 103       // Make these big enough for both 32-bit and 64-bit
 104       uint64_t r_offset;
 105       uint64_t r_info;
 106       uint64_t r_addend;
 107
 108       // Support lexicographic sorting.
 109       bool operator<(const ELFRelocationEntry &RE) const {
 110         return RE.r_offset < r_offset;
 111       }
 112     };
 113
 114     llvm::DenseMap<const MCSectionData*,
 115                    std::vector<ELFRelocationEntry> > Relocations;
 116     DenseMap<const MCSection*, uint64_t> SectionStringTableIndex;
 117
 118     /// @}
 119     /// @name Symbol Table Data
 120     /// @{
 121
 122     SmallString<256> StringTable;
 123     std::vector<ELFSymbolData> LocalSymbolData;
 124     std::vector<ELFSymbolData> ExternalSymbolData;
 125     std::vector<ELFSymbolData> UndefinedSymbolData;
 126
 127     /// @}
 128
 129     ELFObjectWriter *Writer;
 130
 131     raw_ostream &OS;
 132
 133     unsigned Is64Bit : 1;
 134
 135     bool HasRelocationAddend;
 136
 137     Triple::OSType OSType;
 138
 139     // This holds the symbol table index of the last local symbol.
 140     unsigned LastLocalSymbolIndex;
 141     // This holds the .strtab section index.
 142     unsigned StringTableIndex;
 143
 144     unsigned ShstrtabIndex;
 145
 146   public:
 147     ELFObjectWriterImpl(ELFObjectWriter *_Writer, bool _Is64Bit,
 148                         bool _HasRelAddend, Triple::OSType _OSType)
 149       : Writer(_Writer), OS(Writer->getStream()),
 150         Is64Bit(_Is64Bit), HasRelocationAddend(_HasRelAddend),
 151         OSType(_OSType) {
 152     }
 153
 154     void Write8(uint8_t Value) { Writer->Write8(Value); }
 155     void Write16(uint16_t Value) { Writer->Write16(Value); }
 156     void Write32(uint32_t Value) { Writer->Write32(Value); }
 157     //void Write64(uint64_t Value) { Writer->Write64(Value); }
 158     void WriteZeros(unsigned N) { Writer->WriteZeros(N); }
 159     //void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
 160     //  Writer->WriteBytes(Str, ZeroFillSize);
 161     //}
 162
 163     void WriteWord(uint64_t W) {
 164       if (Is64Bit)
 165         Writer->Write64(W);
 166       else
 167         Writer->Write32(W);
 168     }
 169
 170     void String8(char *buf, uint8_t Value) {
 171       buf[0] = Value;
 172     }
 173
 174     void StringLE16(char *buf, uint16_t Value) {
 175       buf[0] = char(Value >> 0);
 176       buf[1] = char(Value >> 8);
 177     }
 178
 179     void StringLE32(char *buf, uint32_t Value) {
 180       StringLE16(buf, uint16_t(Value >> 0));
 181       StringLE16(buf + 2, uint16_t(Value >> 16));
 182     }
 183
 184     void StringLE64(char *buf, uint64_t Value) {
 185       StringLE32(buf, uint32_t(Value >> 0));
 186       StringLE32(buf + 4, uint32_t(Value >> 32));
 187     }
 188
 189     void StringBE16(char *buf ,uint16_t Value) {
 190       buf[0] = char(Value >> 8);
 191       buf[1] = char(Value >> 0);
 192     }
 193
 194     void StringBE32(char *buf, uint32_t Value) {
 195       StringBE16(buf, uint16_t(Value >> 16));
 196       StringBE16(buf + 2, uint16_t(Value >> 0));
 197     }
 198
 199     void StringBE64(char *buf, uint64_t Value) {
 200       StringBE32(buf, uint32_t(Value >> 32));
 201       StringBE32(buf + 4, uint32_t(Value >> 0));
 202     }
 203
 204     void String16(char *buf, uint16_t Value) {
 205       if (Writer->isLittleEndian())
 206         StringLE16(buf, Value);
 207       else
 208         StringBE16(buf, Value);
 209     }
 210
 211     void String32(char *buf, uint32_t Value) {
 212       if (Writer->isLittleEndian())
 213         StringLE32(buf, Value);
 214       else
 215         StringBE32(buf, Value);
 216     }
 217
 218     void String64(char *buf, uint64_t Value) {
 219       if (Writer->isLittleEndian())
 220         StringLE64(buf, Value);
 221       else
 222         StringBE64(buf, Value);
 223     }
 224
 225     void WriteHeader(uint64_t SectionDataSize, unsigned NumberOfSections);
 226
 227     void WriteSymbolEntry(MCDataFragment *F, uint64_t name, uint8_t info,
 228                           uint64_t value, uint64_t size,
 229                           uint8_t other, uint16_t shndx);
 230
 231     void WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
 232                      const MCAsmLayout &Layout);
 233
 234     void WriteSymbolTable(MCDataFragment *F, const MCAssembler &Asm,
 235                           const MCAsmLayout &Layout,
 236                           unsigned NumRegularSections);
 237
 238     void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
 239                           const MCFragment *Fragment, const MCFixup &Fixup,
 240                           MCValue Target, uint64_t &FixedValue);
 241
 242     uint64_t getSymbolIndexInSymbolTable(const MCAssembler &Asm,
 243                                          const MCSymbol *S);
 244
 245     /// ComputeSymbolTable - Compute the symbol table data
 246     ///
 247     /// \param StringTable [out] - The string table data.
 248     /// \param StringIndexMap [out] - Map from symbol names to offsets in the
 249     /// string table.
 250     void ComputeSymbolTable(MCAssembler &Asm);
 251
 252     void WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
 253                          const MCSectionData &SD);
 254
 255     void WriteRelocations(MCAssembler &Asm, MCAsmLayout &Layout) {
 256       for (MCAssembler::const_iterator it = Asm.begin(),
 257              ie = Asm.end(); it != ie; ++it) {
 258         WriteRelocation(Asm, Layout, *it);
 259       }
 260     }
 261
 262     void CreateMetadataSections(MCAssembler &Asm, MCAsmLayout &Layout);
 263
 264     void ExecutePostLayoutBinding(MCAssembler &Asm) {
 265       // Compute symbol table information.
 266       ComputeSymbolTable(Asm);
 267     }
 268
 269     void WriteSecHdrEntry(uint32_t Name, uint32_t Type, uint64_t Flags,
 270                           uint64_t Address, uint64_t Offset,
 271                           uint64_t Size, uint32_t Link, uint32_t Info,
 272                           uint64_t Alignment, uint64_t EntrySize);
 273
 274     void WriteRelocationsFragment(const MCAssembler &Asm, MCDataFragment *F,
 275                                   const MCSectionData *SD);
 276
 277     bool IsFixupFullyResolved(const MCAssembler &Asm,
 278                               const MCValue Target,
 279                               bool IsPCRel,
 280                               const MCFragment *DF) const;
 281
 282     void WriteObject(const MCAssembler &Asm, const MCAsmLayout &Layout);
 283   };
 284
 285 }
 286
 287 // Emit the ELF header.
 288 void ELFObjectWriterImpl::WriteHeader(uint64_t SectionDataSize,
 289                                       unsigned NumberOfSections) {
 290   // ELF Header
 291   // ----------
 292   //
 293   // Note
 294   // ----
 295   // emitWord method behaves differently for ELF32 and ELF64, writing
 296   // 4 bytes in the former and 8 in the latter.
 297
 298   Write8(0x7f); // e_ident[EI_MAG0]
 299   Write8('E');  // e_ident[EI_MAG1]
 300   Write8('L');  // e_ident[EI_MAG2]
 301   Write8('F');  // e_ident[EI_MAG3]
 302
 303   Write8(Is64Bit ? ELF::ELFCLASS64 : ELF::ELFCLASS32); // e_ident[EI_CLASS]
 304
 305   // e_ident[EI_DATA]
 306   Write8(Writer->isLittleEndian() ? ELF::ELFDATA2LSB : ELF::ELFDATA2MSB);
 307
 308   Write8(ELF::EV_CURRENT);        // e_ident[EI_VERSION]
 309   // e_ident[EI_OSABI]
 310   switch (OSType) {
 311     case Triple::FreeBSD:  Write8(ELF::ELFOSABI_FREEBSD); break;
 312     case Triple::Linux:    Write8(ELF::ELFOSABI_LINUX); break;
 313     default:               Write8(ELF::ELFOSABI_NONE); break;
 314   }
 315   Write8(0);                  // e_ident[EI_ABIVERSION]
 316
 317   WriteZeros(ELF::EI_NIDENT - ELF::EI_PAD);
 318
 319   Write16(ELF::ET_REL);             // e_type
 320
 321   // FIXME: Make this configurable
 322   Write16(Is64Bit ? ELF::EM_X86_64 : ELF::EM_386); // e_machine = target
 323
 324   Write32(ELF::EV_CURRENT);         // e_version
 325   WriteWord(0);                    // e_entry, no entry point in .o file
 326   WriteWord(0);                    // e_phoff, no program header for .o
 327   WriteWord(SectionDataSize + (Is64Bit ? sizeof(ELF::Elf64_Ehdr) :
 328             sizeof(ELF::Elf32_Ehdr)));  // e_shoff = sec hdr table off in bytes
 329
 330   // FIXME: Make this configurable.
 331   Write32(0);   // e_flags = whatever the target wants
 332
 333   // e_ehsize = ELF header size
 334   Write16(Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr));
 335
 336   Write16(0);                  // e_phentsize = prog header entry size
 337   Write16(0);                  // e_phnum = # prog header entries = 0
 338
 339   // e_shentsize = Section header entry size
 340   Write16(Is64Bit ? sizeof(ELF::Elf64_Shdr) : sizeof(ELF::Elf32_Shdr));
 341
 342   // e_shnum     = # of section header ents
 343   Write16(NumberOfSections);
 344
 345   // e_shstrndx  = Section # of '.shstrtab'
 346   Write16(ShstrtabIndex);
 347 }
 348
 349 void ELFObjectWriterImpl::WriteSymbolEntry(MCDataFragment *F, uint64_t name,
 350                                            uint8_t info, uint64_t value,
 351                                            uint64_t size, uint8_t other,
 352                                            uint16_t shndx) {
 353   if (Is64Bit) {
 354     char buf[8];
 355
 356     String32(buf, name);
 357     F->getContents() += StringRef(buf, 4); // st_name
 358
 359     String8(buf, info);
 360     F->getContents() += StringRef(buf, 1);  // st_info
 361
 362     String8(buf, other);
 363     F->getContents() += StringRef(buf, 1); // st_other
 364
 365     String16(buf, shndx);
 366     F->getContents() += StringRef(buf, 2); // st_shndx
 367
 368     String64(buf, value);
 369     F->getContents() += StringRef(buf, 8); // st_value
 370
 371     String64(buf, size);
 372     F->getContents() += StringRef(buf, 8);  // st_size
 373   } else {
 374     char buf[4];
 375
 376     String32(buf, name);
 377     F->getContents() += StringRef(buf, 4);  // st_name
 378
 379     String32(buf, value);
 380     F->getContents() += StringRef(buf, 4); // st_value
 381
 382     String32(buf, size);
 383     F->getContents() += StringRef(buf, 4);  // st_size
 384
 385     String8(buf, info);
 386     F->getContents() += StringRef(buf, 1);  // st_info
 387
 388     String8(buf, other);
 389     F->getContents() += StringRef(buf, 1); // st_other
 390
 391     String16(buf, shndx);
 392     F->getContents() += StringRef(buf, 2); // st_shndx
 393   }
 394 }
 395
 396 static uint64_t SymbolValue(MCSymbolData &Data, const MCAsmLayout &Layout) {
 397   if (Data.isCommon() && Data.isExternal())
 398     return Data.getCommonAlignment();
 399
 400   const MCSymbol &Symbol = Data.getSymbol();
 401   if (!Symbol.isInSection())
 402     return 0;
 403
 404   if (!Data.isCommon() && !(Data.getFlags() & ELF_STB_Weak))
 405     if (MCFragment *FF = Data.getFragment())
 406       return Layout.getSymbolAddress(&Data) -
 407              Layout.getSectionAddress(FF->getParent());
 408
 409   return 0;
 410 }
 411
 412 void ELFObjectWriterImpl::WriteSymbol(MCDataFragment *F, ELFSymbolData &MSD,
 413                                       const MCAsmLayout &Layout) {
 414   MCSymbolData &Data = *MSD.SymbolData;
 415   uint8_t Info = (Data.getFlags() & 0xff);
 416   uint8_t Other = ((Data.getFlags() & 0xf00) >> ELF_STV_Shift);
 417   uint64_t Value = SymbolValue(Data, Layout);
 418   uint64_t Size = 0;
 419   const MCExpr *ESize;
 420
 421   assert(!(Data.isCommon() && !Data.isExternal()));
 422
 423   ESize = Data.getSize();
 424   if (Data.getSize()) {
 425     MCValue Res;
 426     if (ESize->getKind() == MCExpr::Binary) {
 427       const MCBinaryExpr *BE = static_cast<const MCBinaryExpr *>(ESize);
 428
 429       if (BE->EvaluateAsRelocatable(Res, &Layout)) {
 430         MCSymbolData &A =
 431           Layout.getAssembler().getSymbolData(Res.getSymA()->getSymbol());
 432         MCSymbolData &B =
 433           Layout.getAssembler().getSymbolData(Res.getSymB()->getSymbol());
 434
 435         Size = Layout.getSymbolAddress(&A) - Layout.getSymbolAddress(&B);
 436       }
 437     } else if (ESize->getKind() == MCExpr::Constant) {
 438       Size = static_cast<const MCConstantExpr *>(ESize)->getValue();
 439     } else {
 440       assert(0 && "Unsupported size expression");
 441     }
 442   }
 443
 444   // Write out the symbol table entry
 445   WriteSymbolEntry(F, MSD.StringIndex, Info, Value,
 446                    Size, Other, MSD.SectionIndex);
 447 }
 448
 449 void ELFObjectWriterImpl::WriteSymbolTable(MCDataFragment *F,
 450                                            const MCAssembler &Asm,
 451                                            const MCAsmLayout &Layout,
 452                                            unsigned NumRegularSections) {
 453   // The string table must be emitted first because we need the index
 454   // into the string table for all the symbol names.
 455   assert(StringTable.size() && "Missing string table");
 456
 457   // FIXME: Make sure the start of the symbol table is aligned.
 458
 459   // The first entry is the undefined symbol entry.
 460   unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
 461   F->getContents().append(EntrySize, '\x00');
 462
 463   // Write the symbol table entries.
 464   LastLocalSymbolIndex = LocalSymbolData.size() + 1;
 465   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i) {
 466     ELFSymbolData &MSD = LocalSymbolData[i];
 467     WriteSymbol(F, MSD, Layout);
 468   }
 469
 470   // Write out a symbol table entry for each regular section.
 471   unsigned Index = 1;
 472   for (MCAssembler::const_iterator it = Asm.begin();
 473        Index <= NumRegularSections; ++it, ++Index) {
 474     const MCSectionELF &Section =
 475       static_cast<const MCSectionELF&>(it->getSection());
 476     // Leave out relocations so we don't have indexes within
 477     // the relocations messed up
 478     if (Section.getType() == ELF::SHT_RELA || Section.getType() == ELF::SHT_REL)
 479       continue;
 480     WriteSymbolEntry(F, 0, ELF::STT_SECTION, 0, 0, ELF::STV_DEFAULT, Index);
 481     LastLocalSymbolIndex++;
 482   }
 483
 484   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i) {
 485     ELFSymbolData &MSD = ExternalSymbolData[i];
 486     MCSymbolData &Data = *MSD.SymbolData;
 487     assert((Data.getFlags() & ELF_STB_Global) &&
 488            "External symbol requires STB_GLOBAL flag");
 489     WriteSymbol(F, MSD, Layout);
 490     if (GetBinding(Data) == ELF::STB_LOCAL)
 491       LastLocalSymbolIndex++;
 492   }
 493
 494   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i) {
 495     ELFSymbolData &MSD = UndefinedSymbolData[i];
 496     MCSymbolData &Data = *MSD.SymbolData;
 497     WriteSymbol(F, MSD, Layout);
 498     if (GetBinding(Data) == ELF::STB_LOCAL)
 499       LastLocalSymbolIndex++;
 500   }
 501 }
 502
 503 static bool ShouldRelocOnSymbol(const MCSymbolData &SD,
 504                                 const MCValue &Target) {
 505   const MCSymbol &Symbol = SD.getSymbol();
 506   if (Symbol.isUndefined())
 507     return true;
 508
 509   const MCSectionELF &Section =
 510     static_cast<const MCSectionELF&>(Symbol.getSection());
 511
 512   if (Section.getFlags() & MCSectionELF::SHF_MERGE)
 513     return Target.getConstant() != 0;
 514
 515   if (SD.isExternal())
 516     return true;
 517
 518   return false;
 519 }
 520
 521 // FIXME: this is currently X86/X86_64 only
 522 void ELFObjectWriterImpl::RecordRelocation(const MCAssembler &Asm,
 523                                            const MCAsmLayout &Layout,
 524                                            const MCFragment *Fragment,
 525                                            const MCFixup &Fixup,
 526                                            MCValue Target,
 527                                            uint64_t &FixedValue) {
 528   int64_t Addend = 0;
 529   unsigned Index = 0;
 530   int64_t Value = Target.getConstant();
 531
 532   bool IsPCRel = isFixupKindX86PCRel(Fixup.getKind());
 533   if (!Target.isAbsolute()) {
 534     const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
 535     MCSymbolData &SD = Asm.getSymbolData(*Symbol);
 536     MCFragment *F = SD.getFragment();
 537
 538     if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
 539       const MCSymbol &SymbolB = RefB->getSymbol();
 540       MCSymbolData &SDB = Asm.getSymbolData(SymbolB);
 541       IsPCRel = true;
 542       MCSectionData *Sec = Fragment->getParent();
 543
 544       // Offset of the symbol in the section
 545       int64_t a = Layout.getSymbolAddress(&SDB) - Layout.getSectionAddress(Sec);
 546
 547       // Ofeset of the relocation in the section
 548       int64_t b = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 549       Value += b - a;
 550     }
 551
 552     // Check that this case has already been fully resolved before we get
 553     // here.
 554     if (Symbol->isDefined() && !SD.isExternal() &&
 555         IsPCRel &&
 556         &Fragment->getParent()->getSection() == &Symbol->getSection()) {
 557       llvm_unreachable("We don't need a relocation in this case.");
 558       return;
 559     }
 560
 561     bool RelocOnSymbol = ShouldRelocOnSymbol(SD, Target);
 562     if (!RelocOnSymbol) {
 563       Index = F->getParent()->getOrdinal() + LocalSymbolData.size() + 1;
 564
 565       MCSectionData *FSD = F->getParent();
 566       // Offset of the symbol in the section
 567       Value += Layout.getSymbolAddress(&SD) - Layout.getSectionAddress(FSD);
 568     } else
 569       Index = getSymbolIndexInSymbolTable(Asm, Symbol);
 570     Addend = Value;
 571     // Compensate for the addend on i386.
 572     if (Is64Bit)
 573       Value = 0;
 574   }
 575
 576   FixedValue = Value;
 577
 578   // determine the type of the relocation
 579   unsigned Type;
 580   if (Is64Bit) {
 581     if (IsPCRel) {
 582       Type = ELF::R_X86_64_PC32;
 583     } else {
 584       switch ((unsigned)Fixup.getKind()) {
 585       default: llvm_unreachable("invalid fixup kind!");
 586       case FK_Data_8: Type = ELF::R_X86_64_64; break;
 587       case X86::reloc_signed_4byte:
 588       case X86::reloc_pcrel_4byte:
 589         assert(isInt<32>(Target.getConstant()));
 590         Type = ELF::R_X86_64_32S;
 591         break;
 592       case FK_Data_4:
 593         Type = ELF::R_X86_64_32;
 594         break;
 595       case FK_Data_2: Type = ELF::R_X86_64_16; break;
 596       case X86::reloc_pcrel_1byte:
 597       case FK_Data_1: Type = ELF::R_X86_64_8; break;
 598       }
 599     }
 600   } else {
 601     if (IsPCRel) {
 602       Type = ELF::R_386_PC32;
 603     } else {
 604       switch ((unsigned)Fixup.getKind()) {
 605       default: llvm_unreachable("invalid fixup kind!");
 606
 607       // FIXME: Should we avoid selecting reloc_signed_4byte in 32 bit mode
 608       // instead?
 609       case X86::reloc_signed_4byte:
 610       case X86::reloc_pcrel_4byte:
 611       case FK_Data_4: Type = ELF::R_386_32; break;
 612       case FK_Data_2: Type = ELF::R_386_16; break;
 613       case X86::reloc_pcrel_1byte:
 614       case FK_Data_1: Type = ELF::R_386_8; break;
 615       }
 616     }
 617   }
 618
 619   ELFRelocationEntry ERE;
 620
 621   if (Is64Bit) {
 622     struct ELF::Elf64_Rela ERE64;
 623     ERE64.setSymbolAndType(Index, Type);
 624     ERE.r_info = ERE64.r_info;
 625   } else {
 626     struct ELF::Elf32_Rela ERE32;
 627     ERE32.setSymbolAndType(Index, Type);
 628     ERE.r_info = ERE32.r_info;
 629   }
 630
 631   ERE.r_offset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 632
 633   if (HasRelocationAddend)
 634     ERE.r_addend = Addend;
 635   else
 636     ERE.r_addend = 0; // Silence compiler warning.
 637
 638   Relocations[Fragment->getParent()].push_back(ERE);
 639 }
 640
 641 uint64_t
 642 ELFObjectWriterImpl::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
 643                                                  const MCSymbol *S) {
 644   MCSymbolData &SD = Asm.getSymbolData(*S);
 645
 646   // Local symbol.
 647   if (!SD.isExternal() && !S->isUndefined())
 648     return SD.getIndex() + /* empty symbol */ 1;
 649
 650   // External or undefined symbol.
 651   return SD.getIndex() + Asm.size() + /* empty symbol */ 1;
 652 }
 653
 654 void ELFObjectWriterImpl::ComputeSymbolTable(MCAssembler &Asm) {
 655   // Build section lookup table.
 656   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
 657   unsigned Index = 1;
 658   for (MCAssembler::iterator it = Asm.begin(),
 659          ie = Asm.end(); it != ie; ++it, ++Index)
 660     SectionIndexMap[&it->getSection()] = Index;
 661
 662   // Index 0 is always the empty string.
 663   StringMap<uint64_t> StringIndexMap;
 664   StringTable += '\x00';
 665
 666   // Add the data for local symbols.
 667   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
 668          ie = Asm.symbol_end(); it != ie; ++it) {
 669     const MCSymbol &Symbol = it->getSymbol();
 670
 671     // Ignore non-linker visible symbols.
 672     if (!Asm.isSymbolLinkerVisible(Symbol))
 673       continue;
 674
 675     if (it->isExternal() || Symbol.isUndefined())
 676       continue;
 677
 678     uint64_t &Entry = StringIndexMap[Symbol.getName()];
 679     if (!Entry) {
 680       Entry = StringTable.size();
 681       StringTable += Symbol.getName();
 682       StringTable += '\x00';
 683     }
 684
 685     ELFSymbolData MSD;
 686     MSD.SymbolData = it;
 687     MSD.StringIndex = Entry;
 688
 689     if (Symbol.isAbsolute()) {
 690       MSD.SectionIndex = ELF::SHN_ABS;
 691       LocalSymbolData.push_back(MSD);
 692     } else {
 693       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
 694       assert(MSD.SectionIndex && "Invalid section index!");
 695       LocalSymbolData.push_back(MSD);
 696     }
 697   }
 698
 699   // Now add non-local symbols.
 700   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
 701          ie = Asm.symbol_end(); it != ie; ++it) {
 702     const MCSymbol &Symbol = it->getSymbol();
 703
 704     // Ignore non-linker visible symbols.
 705     if (!Asm.isSymbolLinkerVisible(Symbol) && !Symbol.isUndefined())
 706       continue;
 707
 708     if (!it->isExternal() && !Symbol.isUndefined())
 709       continue;
 710
 711     if (Symbol.isVariable())
 712       continue;
 713
 714     uint64_t &Entry = StringIndexMap[Symbol.getName()];
 715     if (!Entry) {
 716       Entry = StringTable.size();
 717       StringTable += Symbol.getName();
 718       StringTable += '\x00';
 719     }
 720
 721     ELFSymbolData MSD;
 722     MSD.SymbolData = it;
 723     MSD.StringIndex = Entry;
 724
 725     if (it->isCommon()) {
 726       MSD.SectionIndex = ELF::SHN_COMMON;
 727       ExternalSymbolData.push_back(MSD);
 728     } else if (Symbol.isUndefined()) {
 729       MSD.SectionIndex = ELF::SHN_UNDEF;
 730       // FIXME: Undefined symbols are global, but this is the first place we
 731       // are able to set it.
 732       if (GetBinding(*it) == ELF::STB_LOCAL)
 733         SetBinding(*it, ELF::STB_GLOBAL);
 734       UndefinedSymbolData.push_back(MSD);
 735     } else if (Symbol.isAbsolute()) {
 736       MSD.SectionIndex = ELF::SHN_ABS;
 737       ExternalSymbolData.push_back(MSD);
 738     } else {
 739       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
 740       assert(MSD.SectionIndex && "Invalid section index!");
 741       ExternalSymbolData.push_back(MSD);
 742     }
 743   }
 744
 745   // Symbols are required to be in lexicographic order.
 746   array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
 747   array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
 748   array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
 749
 750   // Set the symbol indices. Local symbols must come before all other
 751   // symbols with non-local bindings.
 752   Index = 0;
 753   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
 754     LocalSymbolData[i].SymbolData->setIndex(Index++);
 755   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
 756     ExternalSymbolData[i].SymbolData->setIndex(Index++);
 757   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
 758     UndefinedSymbolData[i].SymbolData->setIndex(Index++);
 759 }
 760
 761 void ELFObjectWriterImpl::WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
 762                                           const MCSectionData &SD) {
 763   if (!Relocations[&SD].empty()) {
 764     MCContext &Ctx = Asm.getContext();
 765     const MCSection *RelaSection;
 766     const MCSectionELF &Section =
 767       static_cast<const MCSectionELF&>(SD.getSection());
 768
 769     const StringRef SectionName = Section.getSectionName();
 770     std::string RelaSectionName = HasRelocationAddend ? ".rela" : ".rel";
 771     RelaSectionName += SectionName;
 772
 773     unsigned EntrySize;
 774     if (HasRelocationAddend)
 775       EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
 776     else
 777       EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
 778
 779     RelaSection = Ctx.getELFSection(RelaSectionName, HasRelocationAddend ?
 780                                     ELF::SHT_RELA : ELF::SHT_REL, 0,
 781                                     SectionKind::getReadOnly(),
 782                                     false, EntrySize);
 783
 784     MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
 785     RelaSD.setAlignment(Is64Bit ? 8 : 4);
 786
 787     MCDataFragment *F = new MCDataFragment(&RelaSD);
 788
 789     WriteRelocationsFragment(Asm, F, &SD);
 790
 791     Asm.AddSectionToTheEnd(*Writer, RelaSD, Layout);
 792   }
 793 }
 794
 795 void ELFObjectWriterImpl::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
 796                                            uint64_t Flags, uint64_t Address,
 797                                            uint64_t Offset, uint64_t Size,
 798                                            uint32_t Link, uint32_t Info,
 799                                            uint64_t Alignment,
 800                                            uint64_t EntrySize) {
 801   Write32(Name);        // sh_name: index into string table
 802   Write32(Type);        // sh_type
 803   WriteWord(Flags);     // sh_flags
 804   WriteWord(Address);   // sh_addr
 805   WriteWord(Offset);    // sh_offset
 806   WriteWord(Size);      // sh_size
 807   Write32(Link);        // sh_link
 808   Write32(Info);        // sh_info
 809   WriteWord(Alignment); // sh_addralign
 810   WriteWord(EntrySize); // sh_entsize
 811 }
 812
 813 void ELFObjectWriterImpl::WriteRelocationsFragment(const MCAssembler &Asm,
 814                                                    MCDataFragment *F,
 815                                                    const MCSectionData *SD) {
 816   std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
 817   // sort by the r_offset just like gnu as does
 818   array_pod_sort(Relocs.begin(), Relocs.end());
 819
 820   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
 821     ELFRelocationEntry entry = Relocs[e - i - 1];
 822
 823     if (Is64Bit) {
 824       char buf[8];
 825
 826       String64(buf, entry.r_offset);
 827       F->getContents() += StringRef(buf, 8);
 828
 829       String64(buf, entry.r_info);
 830       F->getContents() += StringRef(buf, 8);
 831
 832       if (HasRelocationAddend) {
 833         String64(buf, entry.r_addend);
 834         F->getContents() += StringRef(buf, 8);
 835       }
 836     } else {
 837       char buf[4];
 838
 839       String32(buf, entry.r_offset);
 840       F->getContents() += StringRef(buf, 4);
 841
 842       String32(buf, entry.r_info);
 843       F->getContents() += StringRef(buf, 4);
 844
 845       if (HasRelocationAddend) {
 846         String32(buf, entry.r_addend);
 847         F->getContents() += StringRef(buf, 4);
 848       }
 849     }
 850   }
 851 }
 852
 853 void ELFObjectWriterImpl::CreateMetadataSections(MCAssembler &Asm,
 854                                                  MCAsmLayout &Layout) {
 855   MCContext &Ctx = Asm.getContext();
 856   MCDataFragment *F;
 857
 858   const MCSection *SymtabSection;
 859   unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
 860
 861   unsigned NumRegularSections = Asm.size();
 862
 863   // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
 864   const MCSection *ShstrtabSection;
 865   ShstrtabSection = Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
 866                                       SectionKind::getReadOnly(), false);
 867   MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
 868   ShstrtabSD.setAlignment(1);
 869   ShstrtabIndex = Asm.size();
 870
 871   SymtabSection = Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
 872                                     SectionKind::getReadOnly(),
 873                                     false, EntrySize);
 874   MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
 875   SymtabSD.setAlignment(Is64Bit ? 8 : 4);
 876
 877   const MCSection *StrtabSection;
 878   StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
 879                                     SectionKind::getReadOnly(), false);
 880   MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
 881   StrtabSD.setAlignment(1);
 882   StringTableIndex = Asm.size();
 883
 884   WriteRelocations(Asm, Layout);
 885
 886   // Symbol table
 887   F = new MCDataFragment(&SymtabSD);
 888   WriteSymbolTable(F, Asm, Layout, NumRegularSections);
 889   Asm.AddSectionToTheEnd(*Writer, SymtabSD, Layout);
 890
 891   F = new MCDataFragment(&StrtabSD);
 892   F->getContents().append(StringTable.begin(), StringTable.end());
 893   Asm.AddSectionToTheEnd(*Writer, StrtabSD, Layout);
 894
 895   F = new MCDataFragment(&ShstrtabSD);
 896
 897   // Section header string table.
 898   //
 899   // The first entry of a string table holds a null character so skip
 900   // section 0.
 901   uint64_t Index = 1;
 902   F->getContents() += '\x00';
 903
 904   for (MCAssembler::const_iterator it = Asm.begin(),
 905          ie = Asm.end(); it != ie; ++it) {
 906     const MCSectionELF &Section =
 907       static_cast<const MCSectionELF&>(it->getSection());
 908     // FIXME: We could merge suffixes like in .text and .rela.text.
 909
 910     // Remember the index into the string table so we can write it
 911     // into the sh_name field of the section header table.
 912     SectionStringTableIndex[&it->getSection()] = Index;
 913
 914     Index += Section.getSectionName().size() + 1;
 915     F->getContents() += Section.getSectionName();
 916     F->getContents() += '\x00';
 917   }
 918
 919   Asm.AddSectionToTheEnd(*Writer, ShstrtabSD, Layout);
 920 }
 921
 922 bool ELFObjectWriterImpl::IsFixupFullyResolved(const MCAssembler &Asm,
 923                                                const MCValue Target,
 924                                                bool IsPCRel,
 925                                                const MCFragment *DF) const {
 926   // If this is a PCrel relocation, find the section this fixup value is
 927   // relative to.
 928   const MCSection *BaseSection = 0;
 929   if (IsPCRel) {
 930     BaseSection = &DF->getParent()->getSection();
 931     assert(BaseSection);
 932   }
 933
 934   const MCSection *SectionA = 0;
 935   const MCSymbol *SymbolA = 0;
 936   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 937     SymbolA = &A->getSymbol();
 938     SectionA = &SymbolA->getSection();
 939   }
 940
 941   const MCSection *SectionB = 0;
 942   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 943     SectionB = &B->getSymbol().getSection();
 944   }
 945
 946   if (!BaseSection)
 947     return SectionA == SectionB;
 948
 949   const MCSymbolData &DataA = Asm.getSymbolData(*SymbolA);
 950   if (DataA.isExternal())
 951     return false;
 952
 953   return !SectionB && BaseSection == SectionA;
 954 }
 955
 956 void ELFObjectWriterImpl::WriteObject(const MCAssembler &Asm,
 957                                       const MCAsmLayout &Layout) {
 958   CreateMetadataSections(const_cast<MCAssembler&>(Asm),
 959                          const_cast<MCAsmLayout&>(Layout));
 960
 961   // Add 1 for the null section.
 962   unsigned NumSections = Asm.size() + 1;
 963   uint64_t NaturalAlignment = Is64Bit ? 8 : 4;
 964   uint64_t HeaderSize = Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr);
 965   uint64_t FileOff = HeaderSize;
 966
 967   for (MCAssembler::const_iterator it = Asm.begin(),
 968          ie = Asm.end(); it != ie; ++it) {
 969     const MCSectionData &SD = *it;
 970
 971     FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
 972
 973     // Get the size of the section in the output file (including padding).
 974     uint64_t Size = Layout.getSectionFileSize(&SD);
 975
 976     FileOff += Size;
 977   }
 978
 979   FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
 980
 981   // Write out the ELF header ...
 982   WriteHeader(FileOff - HeaderSize, NumSections);
 983
 984   FileOff = HeaderSize;
 985
 986   // ... then all of the sections ...
 987   DenseMap<const MCSection*, uint64_t> SectionOffsetMap;
 988
 989   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
 990
 991   unsigned Index = 1;
 992   for (MCAssembler::const_iterator it = Asm.begin(),
 993          ie = Asm.end(); it != ie; ++it) {
 994     const MCSectionData &SD = *it;
 995
 996     uint64_t Padding = OffsetToAlignment(FileOff, SD.getAlignment());
 997     WriteZeros(Padding);
 998     FileOff += Padding;
 999
1000     // Remember the offset into the file for this section.
1001     SectionOffsetMap[&it->getSection()] = FileOff;
1002     SectionIndexMap[&it->getSection()] = Index++;
1003
1004     FileOff += Layout.getSectionFileSize(&SD);
1005
1006     Asm.WriteSectionData(it, Layout, Writer);
1007   }
1008
1009   uint64_t Padding = OffsetToAlignment(FileOff, NaturalAlignment);
1010   WriteZeros(Padding);
1011   FileOff += Padding;
1012
1013   // ... and then the section header table.
1014   // Should we align the section header table?
1015   //
1016   // Null section first.
1017   WriteSecHdrEntry(0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
1018
1019   for (MCAssembler::const_iterator it = Asm.begin(),
1020          ie = Asm.end(); it != ie; ++it) {
1021     const MCSectionData &SD = *it;
1022     const MCSectionELF &Section =
1023       static_cast<const MCSectionELF&>(SD.getSection());
1024
1025     uint64_t sh_link = 0;
1026     uint64_t sh_info = 0;
1027
1028     switch(Section.getType()) {
1029     case ELF::SHT_DYNAMIC:
1030       sh_link = SectionStringTableIndex[&it->getSection()];
1031       sh_info = 0;
1032       break;
1033
1034     case ELF::SHT_REL:
1035     case ELF::SHT_RELA: {
1036       const MCSection *SymtabSection;
1037       const MCSection *InfoSection;
1038
1039       SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1040                                                      SectionKind::getReadOnly(),
1041                                                      false);
1042       sh_link = SectionIndexMap[SymtabSection];
1043
1044       // Remove ".rel" and ".rela" prefixes.
1045       unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1046       StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1047
1048       InfoSection = Asm.getContext().getELFSection(SectionName,
1049                                                    ELF::SHT_PROGBITS, 0,
1050                                                    SectionKind::getReadOnly(),
1051                                                    false);
1052       sh_info = SectionIndexMap[InfoSection];
1053       break;
1054     }
1055
1056     case ELF::SHT_SYMTAB:
1057     case ELF::SHT_DYNSYM:
1058       sh_link = StringTableIndex;
1059       sh_info = LastLocalSymbolIndex;
1060       break;
1061
1062     case ELF::SHT_PROGBITS:
1063     case ELF::SHT_STRTAB:
1064     case ELF::SHT_NOBITS:
1065     case ELF::SHT_NULL:
1066       // Nothing to do.
1067       break;
1068
1069     case ELF::SHT_HASH:
1070     case ELF::SHT_GROUP:
1071     case ELF::SHT_SYMTAB_SHNDX:
1072     default:
1073       assert(0 && "FIXME: sh_type value not supported!");
1074       break;
1075     }
1076
1077     WriteSecHdrEntry(SectionStringTableIndex[&it->getSection()],
1078                      Section.getType(), Section.getFlags(),
1079                      0,
1080                      SectionOffsetMap.lookup(&SD.getSection()),
1081                      Layout.getSectionSize(&SD), sh_link,
1082                      sh_info, SD.getAlignment(),
1083                      Section.getEntrySize());
1084   }
1085 }
1086
1087 ELFObjectWriter::ELFObjectWriter(raw_ostream &OS,
1088                                  bool Is64Bit,
1089                                  Triple::OSType OSType,
1090                                  bool IsLittleEndian,
1091                                  bool HasRelocationAddend)
1092   : MCObjectWriter(OS, IsLittleEndian)
1093 {
1094   Impl = new ELFObjectWriterImpl(this, Is64Bit, HasRelocationAddend, OSType);
1095 }
1096
1097 ELFObjectWriter::~ELFObjectWriter() {
1098   delete (ELFObjectWriterImpl*) Impl;
1099 }
1100
1101 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm) {
1102   ((ELFObjectWriterImpl*) Impl)->ExecutePostLayoutBinding(Asm);
1103 }
1104
1105 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
1106                                        const MCAsmLayout &Layout,
1107                                        const MCFragment *Fragment,
1108                                        const MCFixup &Fixup, MCValue Target,
1109                                        uint64_t &FixedValue) {
1110   ((ELFObjectWriterImpl*) Impl)->RecordRelocation(Asm, Layout, Fragment, Fixup,
1111                                                   Target, FixedValue);
1112 }
1113
1114 bool ELFObjectWriter::IsFixupFullyResolved(const MCAssembler &Asm,
1115                                            const MCValue Target,
1116                                            bool IsPCRel,
1117                                            const MCFragment *DF) const {
1118   return ((ELFObjectWriterImpl*) Impl)->IsFixupFullyResolved(Asm, Target,
1119                                                              IsPCRel, DF);
1120 }
1121
1122 void ELFObjectWriter::WriteObject(const MCAssembler &Asm,
1123                                   const MCAsmLayout &Layout) {
1124   ((ELFObjectWriterImpl*) Impl)->WriteObject(Asm, Layout);
1125 }