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