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     // Check that this case has already been fully resolved before we get
 539     // here.
 540     if (Symbol->isDefined() && !SD.isExternal() &&
 541         IsPCRel &&
 542         &Fragment->getParent()->getSection() == &Symbol->getSection()) {
 543       llvm_unreachable("We don't need a relocation in this case.");
 544       return;
 545     }
 546
 547     bool RelocOnSymbol = ShouldRelocOnSymbol(SD, Target);
 548     if (!RelocOnSymbol) {
 549       Index = F->getParent()->getOrdinal() + LocalSymbolData.size() + 1;
 550
 551       MCSectionData *FSD = F->getParent();
 552       // Offset of the symbol in the section
 553       Value += Layout.getSymbolAddress(&SD) - Layout.getSectionAddress(FSD);
 554     } else
 555       Index = getSymbolIndexInSymbolTable(Asm, Symbol);
 556     Addend = Value;
 557     // Compensate for the addend on i386.
 558     if (Is64Bit)
 559       Value = 0;
 560   }
 561
 562   FixedValue = Value;
 563
 564   // determine the type of the relocation
 565   unsigned Type;
 566   if (Is64Bit) {
 567     if (IsPCRel) {
 568       Type = ELF::R_X86_64_PC32;
 569     } else {
 570       switch ((unsigned)Fixup.getKind()) {
 571       default: llvm_unreachable("invalid fixup kind!");
 572       case FK_Data_8: Type = ELF::R_X86_64_64; break;
 573       case X86::reloc_signed_4byte:
 574       case X86::reloc_pcrel_4byte:
 575         assert(isInt<32>(Target.getConstant()));
 576         Type = ELF::R_X86_64_32S;
 577         break;
 578       case FK_Data_4:
 579         Type = ELF::R_X86_64_32;
 580         break;
 581       case FK_Data_2: Type = ELF::R_X86_64_16; break;
 582       case X86::reloc_pcrel_1byte:
 583       case FK_Data_1: Type = ELF::R_X86_64_8; break;
 584       }
 585     }
 586   } else {
 587     if (IsPCRel) {
 588       Type = ELF::R_386_PC32;
 589     } else {
 590       switch ((unsigned)Fixup.getKind()) {
 591       default: llvm_unreachable("invalid fixup kind!");
 592
 593       // FIXME: Should we avoid selecting reloc_signed_4byte in 32 bit mode
 594       // instead?
 595       case X86::reloc_signed_4byte:
 596       case X86::reloc_pcrel_4byte:
 597       case FK_Data_4: Type = ELF::R_386_32; break;
 598       case FK_Data_2: Type = ELF::R_386_16; break;
 599       case X86::reloc_pcrel_1byte:
 600       case FK_Data_1: Type = ELF::R_386_8; break;
 601       }
 602     }
 603   }
 604
 605   ELFRelocationEntry ERE;
 606
 607   if (Is64Bit) {
 608     struct ELF::Elf64_Rela ERE64;
 609     ERE64.setSymbolAndType(Index, Type);
 610     ERE.r_info = ERE64.r_info;
 611   } else {
 612     struct ELF::Elf32_Rela ERE32;
 613     ERE32.setSymbolAndType(Index, Type);
 614     ERE.r_info = ERE32.r_info;
 615   }
 616
 617   ERE.r_offset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
 618
 619   if (HasRelocationAddend)
 620     ERE.r_addend = Addend;
 621   else
 622     ERE.r_addend = 0; // Silence compiler warning.
 623
 624   Relocations[Fragment->getParent()].push_back(ERE);
 625 }
 626
 627 uint64_t
 628 ELFObjectWriterImpl::getSymbolIndexInSymbolTable(const MCAssembler &Asm,
 629                                                  const MCSymbol *S) {
 630   MCSymbolData &SD = Asm.getSymbolData(*S);
 631
 632   // Local symbol.
 633   if (!SD.isExternal() && !S->isUndefined())
 634     return SD.getIndex() + /* empty symbol */ 1;
 635
 636   // External or undefined symbol.
 637   return SD.getIndex() + Asm.size() + /* empty symbol */ 1;
 638 }
 639
 640 void ELFObjectWriterImpl::ComputeSymbolTable(MCAssembler &Asm) {
 641   // Build section lookup table.
 642   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
 643   unsigned Index = 1;
 644   for (MCAssembler::iterator it = Asm.begin(),
 645          ie = Asm.end(); it != ie; ++it, ++Index)
 646     SectionIndexMap[&it->getSection()] = Index;
 647
 648   // Index 0 is always the empty string.
 649   StringMap<uint64_t> StringIndexMap;
 650   StringTable += '\x00';
 651
 652   // Add the data for local symbols.
 653   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
 654          ie = Asm.symbol_end(); it != ie; ++it) {
 655     const MCSymbol &Symbol = it->getSymbol();
 656
 657     // Ignore non-linker visible symbols.
 658     if (!Asm.isSymbolLinkerVisible(Symbol))
 659       continue;
 660
 661     if (it->isExternal() || Symbol.isUndefined())
 662       continue;
 663
 664     uint64_t &Entry = StringIndexMap[Symbol.getName()];
 665     if (!Entry) {
 666       Entry = StringTable.size();
 667       StringTable += Symbol.getName();
 668       StringTable += '\x00';
 669     }
 670
 671     ELFSymbolData MSD;
 672     MSD.SymbolData = it;
 673     MSD.StringIndex = Entry;
 674
 675     if (Symbol.isAbsolute()) {
 676       MSD.SectionIndex = ELF::SHN_ABS;
 677       LocalSymbolData.push_back(MSD);
 678     } else {
 679       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
 680       assert(MSD.SectionIndex && "Invalid section index!");
 681       LocalSymbolData.push_back(MSD);
 682     }
 683   }
 684
 685   // Now add non-local symbols.
 686   for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
 687          ie = Asm.symbol_end(); it != ie; ++it) {
 688     const MCSymbol &Symbol = it->getSymbol();
 689
 690     // Ignore non-linker visible symbols.
 691     if (!Asm.isSymbolLinkerVisible(Symbol) && !Symbol.isUndefined())
 692       continue;
 693
 694     if (!it->isExternal() && !Symbol.isUndefined())
 695       continue;
 696
 697     if (Symbol.isVariable())
 698       continue;
 699
 700     uint64_t &Entry = StringIndexMap[Symbol.getName()];
 701     if (!Entry) {
 702       Entry = StringTable.size();
 703       StringTable += Symbol.getName();
 704       StringTable += '\x00';
 705     }
 706
 707     ELFSymbolData MSD;
 708     MSD.SymbolData = it;
 709     MSD.StringIndex = Entry;
 710
 711     if (it->isCommon()) {
 712       MSD.SectionIndex = ELF::SHN_COMMON;
 713       ExternalSymbolData.push_back(MSD);
 714     } else if (Symbol.isUndefined()) {
 715       MSD.SectionIndex = ELF::SHN_UNDEF;
 716       // FIXME: Undefined symbols are global, but this is the first place we
 717       // are able to set it.
 718       if (GetBinding(*it) == ELF::STB_LOCAL)
 719         SetBinding(*it, ELF::STB_GLOBAL);
 720       UndefinedSymbolData.push_back(MSD);
 721     } else if (Symbol.isAbsolute()) {
 722       MSD.SectionIndex = ELF::SHN_ABS;
 723       ExternalSymbolData.push_back(MSD);
 724     } else {
 725       MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
 726       assert(MSD.SectionIndex && "Invalid section index!");
 727       ExternalSymbolData.push_back(MSD);
 728     }
 729   }
 730
 731   // Symbols are required to be in lexicographic order.
 732   array_pod_sort(LocalSymbolData.begin(), LocalSymbolData.end());
 733   array_pod_sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
 734   array_pod_sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
 735
 736   // Set the symbol indices. Local symbols must come before all other
 737   // symbols with non-local bindings.
 738   Index = 0;
 739   for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
 740     LocalSymbolData[i].SymbolData->setIndex(Index++);
 741   for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
 742     ExternalSymbolData[i].SymbolData->setIndex(Index++);
 743   for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
 744     UndefinedSymbolData[i].SymbolData->setIndex(Index++);
 745 }
 746
 747 void ELFObjectWriterImpl::WriteRelocation(MCAssembler &Asm, MCAsmLayout &Layout,
 748                                           const MCSectionData &SD) {
 749   if (!Relocations[&SD].empty()) {
 750     MCContext &Ctx = Asm.getContext();
 751     const MCSection *RelaSection;
 752     const MCSectionELF &Section =
 753       static_cast<const MCSectionELF&>(SD.getSection());
 754
 755     const StringRef SectionName = Section.getSectionName();
 756     std::string RelaSectionName = HasRelocationAddend ? ".rela" : ".rel";
 757     RelaSectionName += SectionName;
 758
 759     unsigned EntrySize;
 760     if (HasRelocationAddend)
 761       EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rela) : sizeof(ELF::Elf32_Rela);
 762     else
 763       EntrySize = Is64Bit ? sizeof(ELF::Elf64_Rel) : sizeof(ELF::Elf32_Rel);
 764
 765     RelaSection = Ctx.getELFSection(RelaSectionName, HasRelocationAddend ?
 766                                     ELF::SHT_RELA : ELF::SHT_REL, 0,
 767                                     SectionKind::getReadOnly(),
 768                                     false, EntrySize);
 769
 770     MCSectionData &RelaSD = Asm.getOrCreateSectionData(*RelaSection);
 771     RelaSD.setAlignment(Is64Bit ? 8 : 4);
 772
 773     MCDataFragment *F = new MCDataFragment(&RelaSD);
 774
 775     WriteRelocationsFragment(Asm, F, &SD);
 776
 777     Asm.AddSectionToTheEnd(*Writer, RelaSD, Layout);
 778   }
 779 }
 780
 781 void ELFObjectWriterImpl::WriteSecHdrEntry(uint32_t Name, uint32_t Type,
 782                                            uint64_t Flags, uint64_t Address,
 783                                            uint64_t Offset, uint64_t Size,
 784                                            uint32_t Link, uint32_t Info,
 785                                            uint64_t Alignment,
 786                                            uint64_t EntrySize) {
 787   Write32(Name);        // sh_name: index into string table
 788   Write32(Type);        // sh_type
 789   WriteWord(Flags);     // sh_flags
 790   WriteWord(Address);   // sh_addr
 791   WriteWord(Offset);    // sh_offset
 792   WriteWord(Size);      // sh_size
 793   Write32(Link);        // sh_link
 794   Write32(Info);        // sh_info
 795   WriteWord(Alignment); // sh_addralign
 796   WriteWord(EntrySize); // sh_entsize
 797 }
 798
 799 void ELFObjectWriterImpl::WriteRelocationsFragment(const MCAssembler &Asm,
 800                                                    MCDataFragment *F,
 801                                                    const MCSectionData *SD) {
 802   std::vector<ELFRelocationEntry> &Relocs = Relocations[SD];
 803   // sort by the r_offset just like gnu as does
 804   array_pod_sort(Relocs.begin(), Relocs.end());
 805
 806   for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
 807     ELFRelocationEntry entry = Relocs[e - i - 1];
 808
 809     if (Is64Bit) {
 810       char buf[8];
 811
 812       String64(buf, entry.r_offset);
 813       F->getContents() += StringRef(buf, 8);
 814
 815       String64(buf, entry.r_info);
 816       F->getContents() += StringRef(buf, 8);
 817
 818       if (HasRelocationAddend) {
 819         String64(buf, entry.r_addend);
 820         F->getContents() += StringRef(buf, 8);
 821       }
 822     } else {
 823       char buf[4];
 824
 825       String32(buf, entry.r_offset);
 826       F->getContents() += StringRef(buf, 4);
 827
 828       String32(buf, entry.r_info);
 829       F->getContents() += StringRef(buf, 4);
 830
 831       if (HasRelocationAddend) {
 832         String32(buf, entry.r_addend);
 833         F->getContents() += StringRef(buf, 4);
 834       }
 835     }
 836   }
 837 }
 838
 839 void ELFObjectWriterImpl::CreateMetadataSections(MCAssembler &Asm,
 840                                                  MCAsmLayout &Layout) {
 841   MCContext &Ctx = Asm.getContext();
 842   MCDataFragment *F;
 843
 844   const MCSection *SymtabSection;
 845   unsigned EntrySize = Is64Bit ? ELF::SYMENTRY_SIZE64 : ELF::SYMENTRY_SIZE32;
 846
 847   unsigned NumRegularSections = Asm.size();
 848
 849   // We construct .shstrtab, .symtab and .strtab in this order to match gnu as.
 850   const MCSection *ShstrtabSection;
 851   ShstrtabSection = Ctx.getELFSection(".shstrtab", ELF::SHT_STRTAB, 0,
 852                                       SectionKind::getReadOnly(), false);
 853   MCSectionData &ShstrtabSD = Asm.getOrCreateSectionData(*ShstrtabSection);
 854   ShstrtabSD.setAlignment(1);
 855   ShstrtabIndex = Asm.size();
 856
 857   SymtabSection = Ctx.getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
 858                                     SectionKind::getReadOnly(),
 859                                     false, EntrySize);
 860   MCSectionData &SymtabSD = Asm.getOrCreateSectionData(*SymtabSection);
 861   SymtabSD.setAlignment(Is64Bit ? 8 : 4);
 862
 863   const MCSection *StrtabSection;
 864   StrtabSection = Ctx.getELFSection(".strtab", ELF::SHT_STRTAB, 0,
 865                                     SectionKind::getReadOnly(), false);
 866   MCSectionData &StrtabSD = Asm.getOrCreateSectionData(*StrtabSection);
 867   StrtabSD.setAlignment(1);
 868   StringTableIndex = Asm.size();
 869
 870   WriteRelocations(Asm, Layout);
 871
 872   // Symbol table
 873   F = new MCDataFragment(&SymtabSD);
 874   WriteSymbolTable(F, Asm, Layout, NumRegularSections);
 875   Asm.AddSectionToTheEnd(*Writer, SymtabSD, Layout);
 876
 877   F = new MCDataFragment(&StrtabSD);
 878   F->getContents().append(StringTable.begin(), StringTable.end());
 879   Asm.AddSectionToTheEnd(*Writer, StrtabSD, Layout);
 880
 881   F = new MCDataFragment(&ShstrtabSD);
 882
 883   // Section header string table.
 884   //
 885   // The first entry of a string table holds a null character so skip
 886   // section 0.
 887   uint64_t Index = 1;
 888   F->getContents() += '\x00';
 889
 890   for (MCAssembler::const_iterator it = Asm.begin(),
 891          ie = Asm.end(); it != ie; ++it) {
 892     const MCSectionELF &Section =
 893       static_cast<const MCSectionELF&>(it->getSection());
 894     // FIXME: We could merge suffixes like in .text and .rela.text.
 895
 896     // Remember the index into the string table so we can write it
 897     // into the sh_name field of the section header table.
 898     SectionStringTableIndex[&it->getSection()] = Index;
 899
 900     Index += Section.getSectionName().size() + 1;
 901     F->getContents() += Section.getSectionName();
 902     F->getContents() += '\x00';
 903   }
 904
 905   Asm.AddSectionToTheEnd(*Writer, ShstrtabSD, Layout);
 906 }
 907
 908 bool ELFObjectWriterImpl::IsFixupFullyResolved(const MCAssembler &Asm,
 909                                                const MCValue Target,
 910                                                bool IsPCRel,
 911                                                const MCFragment *DF) const {
 912   // If this is a PCrel relocation, find the section this fixup value is
 913   // relative to.
 914   const MCSection *BaseSection = 0;
 915   if (IsPCRel) {
 916     BaseSection = &DF->getParent()->getSection();
 917     assert(BaseSection);
 918   }
 919
 920   const MCSection *SectionA = 0;
 921   const MCSymbol *SymbolA = 0;
 922   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 923     SymbolA = &A->getSymbol();
 924     SectionA = &SymbolA->getSection();
 925   }
 926
 927   const MCSection *SectionB = 0;
 928   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 929     SectionB = &B->getSymbol().getSection();
 930   }
 931
 932   if (!BaseSection)
 933     return SectionA == SectionB;
 934
 935   const MCSymbolData &DataA = Asm.getSymbolData(*SymbolA);
 936   if (DataA.isExternal())
 937     return false;
 938
 939   return !SectionB && BaseSection == SectionA;
 940 }
 941
 942 void ELFObjectWriterImpl::WriteObject(const MCAssembler &Asm,
 943                                       const MCAsmLayout &Layout) {
 944   CreateMetadataSections(const_cast<MCAssembler&>(Asm),
 945                          const_cast<MCAsmLayout&>(Layout));
 946
 947   // Add 1 for the null section.
 948   unsigned NumSections = Asm.size() + 1;
 949   uint64_t NaturalAlignment = Is64Bit ? 8 : 4;
 950   uint64_t HeaderSize = Is64Bit ? sizeof(ELF::Elf64_Ehdr) : sizeof(ELF::Elf32_Ehdr);
 951   uint64_t FileOff = HeaderSize;
 952
 953   for (MCAssembler::const_iterator it = Asm.begin(),
 954          ie = Asm.end(); it != ie; ++it) {
 955     const MCSectionData &SD = *it;
 956
 957     FileOff = RoundUpToAlignment(FileOff, SD.getAlignment());
 958
 959     // Get the size of the section in the output file (including padding).
 960     uint64_t Size = Layout.getSectionFileSize(&SD);
 961
 962     FileOff += Size;
 963   }
 964
 965   FileOff = RoundUpToAlignment(FileOff, NaturalAlignment);
 966
 967   // Write out the ELF header ...
 968   WriteHeader(FileOff - HeaderSize, NumSections);
 969
 970   FileOff = HeaderSize;
 971
 972   // ... then all of the sections ...
 973   DenseMap<const MCSection*, uint64_t> SectionOffsetMap;
 974
 975   DenseMap<const MCSection*, uint8_t> SectionIndexMap;
 976
 977   unsigned Index = 1;
 978   for (MCAssembler::const_iterator it = Asm.begin(),
 979          ie = Asm.end(); it != ie; ++it) {
 980     const MCSectionData &SD = *it;
 981
 982     uint64_t Padding = OffsetToAlignment(FileOff, SD.getAlignment());
 983     WriteZeros(Padding);
 984     FileOff += Padding;
 985
 986     // Remember the offset into the file for this section.
 987     SectionOffsetMap[&it->getSection()] = FileOff;
 988     SectionIndexMap[&it->getSection()] = Index++;
 989
 990     FileOff += Layout.getSectionFileSize(&SD);
 991
 992     Asm.WriteSectionData(it, Layout, Writer);
 993   }
 994
 995   uint64_t Padding = OffsetToAlignment(FileOff, NaturalAlignment);
 996   WriteZeros(Padding);
 997   FileOff += Padding;
 998
 999   // ... and then the section header table.
1000   // Should we align the section header table?
1001   //
1002   // Null section first.
1003   WriteSecHdrEntry(0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
1004
1005   for (MCAssembler::const_iterator it = Asm.begin(),
1006          ie = Asm.end(); it != ie; ++it) {
1007     const MCSectionData &SD = *it;
1008     const MCSectionELF &Section =
1009       static_cast<const MCSectionELF&>(SD.getSection());
1010
1011     uint64_t sh_link = 0;
1012     uint64_t sh_info = 0;
1013
1014     switch(Section.getType()) {
1015     case ELF::SHT_DYNAMIC:
1016       sh_link = SectionStringTableIndex[&it->getSection()];
1017       sh_info = 0;
1018       break;
1019
1020     case ELF::SHT_REL:
1021     case ELF::SHT_RELA: {
1022       const MCSection *SymtabSection;
1023       const MCSection *InfoSection;
1024
1025       SymtabSection = Asm.getContext().getELFSection(".symtab", ELF::SHT_SYMTAB, 0,
1026                                                      SectionKind::getReadOnly(),
1027                                                      false);
1028       sh_link = SectionIndexMap[SymtabSection];
1029
1030       // Remove ".rel" and ".rela" prefixes.
1031       unsigned SecNameLen = (Section.getType() == ELF::SHT_REL) ? 4 : 5;
1032       StringRef SectionName = Section.getSectionName().substr(SecNameLen);
1033
1034       InfoSection = Asm.getContext().getELFSection(SectionName,
1035                                                    ELF::SHT_PROGBITS, 0,
1036                                                    SectionKind::getReadOnly(),
1037                                                    false);
1038       sh_info = SectionIndexMap[InfoSection];
1039       break;
1040     }
1041
1042     case ELF::SHT_SYMTAB:
1043     case ELF::SHT_DYNSYM:
1044       sh_link = StringTableIndex;
1045       sh_info = LastLocalSymbolIndex;
1046       break;
1047
1048     case ELF::SHT_PROGBITS:
1049     case ELF::SHT_STRTAB:
1050     case ELF::SHT_NOBITS:
1051     case ELF::SHT_NULL:
1052       // Nothing to do.
1053       break;
1054
1055     case ELF::SHT_HASH:
1056     case ELF::SHT_GROUP:
1057     case ELF::SHT_SYMTAB_SHNDX:
1058     default:
1059       assert(0 && "FIXME: sh_type value not supported!");
1060       break;
1061     }
1062
1063     WriteSecHdrEntry(SectionStringTableIndex[&it->getSection()],
1064                      Section.getType(), Section.getFlags(),
1065                      0,
1066                      SectionOffsetMap.lookup(&SD.getSection()),
1067                      Layout.getSectionSize(&SD), sh_link,
1068                      sh_info, SD.getAlignment(),
1069                      Section.getEntrySize());
1070   }
1071 }
1072
1073 ELFObjectWriter::ELFObjectWriter(raw_ostream &OS,
1074                                  bool Is64Bit,
1075                                  Triple::OSType OSType,
1076                                  bool IsLittleEndian,
1077                                  bool HasRelocationAddend)
1078   : MCObjectWriter(OS, IsLittleEndian)
1079 {
1080   Impl = new ELFObjectWriterImpl(this, Is64Bit, HasRelocationAddend, OSType);
1081 }
1082
1083 ELFObjectWriter::~ELFObjectWriter() {
1084   delete (ELFObjectWriterImpl*) Impl;
1085 }
1086
1087 void ELFObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm) {
1088   ((ELFObjectWriterImpl*) Impl)->ExecutePostLayoutBinding(Asm);
1089 }
1090
1091 void ELFObjectWriter::RecordRelocation(const MCAssembler &Asm,
1092                                        const MCAsmLayout &Layout,
1093                                        const MCFragment *Fragment,
1094                                        const MCFixup &Fixup, MCValue Target,
1095                                        uint64_t &FixedValue) {
1096   ((ELFObjectWriterImpl*) Impl)->RecordRelocation(Asm, Layout, Fragment, Fixup,
1097                                                   Target, FixedValue);
1098 }
1099
1100 bool ELFObjectWriter::IsFixupFullyResolved(const MCAssembler &Asm,
1101                                            const MCValue Target,
1102                                            bool IsPCRel,
1103                                            const MCFragment *DF) const {
1104   return ((ELFObjectWriterImpl*) Impl)->IsFixupFullyResolved(Asm, Target,
1105                                                              IsPCRel, DF);
1106 }
1107
1108 void ELFObjectWriter::WriteObject(const MCAssembler &Asm,
1109                                   const MCAsmLayout &Layout) {
1110   ((ELFObjectWriterImpl*) Impl)->WriteObject(Asm, Layout);
1111 }