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