lib/CodeGen/ELFWriter.cpp

   1 //===-- ELFWriter.cpp - Target-independent ELF Writer code ----------------===//
   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 the target-independent ELF writer.  This file writes out
  11 // the ELF file in the following order:
  12 //
  13 //  #1. ELF Header
  14 //  #2. '.text' section
  15 //  #3. '.data' section
  16 //  #4. '.bss' section  (conceptual position in file)
  17 //  ...
  18 //  #X. '.shstrtab' section
  19 //  #Y. Section Table
  20 //
  21 // The entries in the section table are laid out as:
  22 //  #0. Null entry [required]
  23 //  #1. ".text" entry - the program code
  24 //  #2. ".data" entry - global variables with initializers.     [ if needed ]
  25 //  #3. ".bss" entry  - global variables without initializers.  [ if needed ]
  26 //  ...
  27 //  #N. ".shstrtab" entry - String table for the section names.
  28 //
  29 //===----------------------------------------------------------------------===//
  30
  31 #define DEBUG_TYPE "elfwriter"
  32
  33 #include "ELF.h"
  34 #include "ELFWriter.h"
  35 #include "ELFCodeEmitter.h"
  36 #include "llvm/Constants.h"
  37 #include "llvm/Module.h"
  38 #include "llvm/PassManager.h"
  39 #include "llvm/DerivedTypes.h"
  40 #include "llvm/CodeGen/BinaryObject.h"
  41 #include "llvm/CodeGen/FileWriters.h"
  42 #include "llvm/CodeGen/MachineCodeEmitter.h"
  43 #include "llvm/CodeGen/ObjectCodeEmitter.h"
  44 #include "llvm/CodeGen/MachineCodeEmitter.h"
  45 #include "llvm/CodeGen/MachineConstantPool.h"
  46 #include "llvm/Target/TargetAsmInfo.h"
  47 #include "llvm/Target/TargetData.h"
  48 #include "llvm/Target/TargetELFWriterInfo.h"
  49 #include "llvm/Target/TargetMachine.h"
  50 #include "llvm/Support/Mangler.h"
  51 #include "llvm/Support/Streams.h"
  52 #include "llvm/Support/raw_ostream.h"
  53 #include "llvm/Support/Debug.h"
  54 #include "llvm/Support/ErrorHandling.h"
  55
  56 using namespace llvm;
  57
  58 char ELFWriter::ID = 0;
  59
  60 /// AddELFWriter - Add the ELF writer to the function pass manager
  61 ObjectCodeEmitter *llvm::AddELFWriter(PassManagerBase &PM,
  62                                       raw_ostream &O,
  63                                       TargetMachine &TM) {
  64   ELFWriter *EW = new ELFWriter(O, TM);
  65   PM.add(EW);
  66   return EW->getObjectCodeEmitter();
  67 }
  68
  69 //===----------------------------------------------------------------------===//
  70 //                          ELFWriter Implementation
  71 //===----------------------------------------------------------------------===//
  72
  73 ELFWriter::ELFWriter(raw_ostream &o, TargetMachine &tm)
  74   : MachineFunctionPass(&ID), O(o), TM(tm),
  75     is64Bit(TM.getTargetData()->getPointerSizeInBits() == 64),
  76     isLittleEndian(TM.getTargetData()->isLittleEndian()),
  77     ElfHdr(isLittleEndian, is64Bit) {
  78
  79   TAI = TM.getTargetAsmInfo();
  80   TEW = TM.getELFWriterInfo();
  81
  82   // Create the object code emitter object for this target.
  83   ElfCE = new ELFCodeEmitter(*this);
  84
  85   // Inital number of sections
  86   NumSections = 0;
  87 }
  88
  89 ELFWriter::~ELFWriter() {
  90   delete ElfCE;
  91 }
  92
  93 // doInitialization - Emit the file header and all of the global variables for
  94 // the module to the ELF file.
  95 bool ELFWriter::doInitialization(Module &M) {
  96   Mang = new Mangler(M);
  97
  98   // ELF Header
  99   // ----------
 100   // Fields e_shnum e_shstrndx are only known after all section have
 101   // been emitted. They locations in the ouput buffer are recorded so
 102   // to be patched up later.
 103   //
 104   // Note
 105   // ----
 106   // emitWord method behaves differently for ELF32 and ELF64, writing
 107   // 4 bytes in the former and 8 in the last for *_off and *_addr elf types
 108
 109   ElfHdr.emitByte(0x7f); // e_ident[EI_MAG0]
 110   ElfHdr.emitByte('E');  // e_ident[EI_MAG1]
 111   ElfHdr.emitByte('L');  // e_ident[EI_MAG2]
 112   ElfHdr.emitByte('F');  // e_ident[EI_MAG3]
 113
 114   ElfHdr.emitByte(TEW->getEIClass()); // e_ident[EI_CLASS]
 115   ElfHdr.emitByte(TEW->getEIData());  // e_ident[EI_DATA]
 116   ElfHdr.emitByte(EV_CURRENT);        // e_ident[EI_VERSION]
 117   ElfHdr.emitAlignment(16);           // e_ident[EI_NIDENT-EI_PAD]
 118
 119   ElfHdr.emitWord16(ET_REL);             // e_type
 120   ElfHdr.emitWord16(TEW->getEMachine()); // e_machine = target
 121   ElfHdr.emitWord32(EV_CURRENT);         // e_version
 122   ElfHdr.emitWord(0);                    // e_entry, no entry point in .o file
 123   ElfHdr.emitWord(0);                    // e_phoff, no program header for .o
 124   ELFHdr_e_shoff_Offset = ElfHdr.size();
 125   ElfHdr.emitWord(0);                    // e_shoff = sec hdr table off in bytes
 126   ElfHdr.emitWord32(TEW->getEFlags());   // e_flags = whatever the target wants
 127   ElfHdr.emitWord16(TEW->getHdrSize());  // e_ehsize = ELF header size
 128   ElfHdr.emitWord16(0);                  // e_phentsize = prog header entry size
 129   ElfHdr.emitWord16(0);                  // e_phnum = # prog header entries = 0
 130
 131   // e_shentsize = Section header entry size
 132   ElfHdr.emitWord16(TEW->getSHdrSize());
 133
 134   // e_shnum     = # of section header ents
 135   ELFHdr_e_shnum_Offset = ElfHdr.size();
 136   ElfHdr.emitWord16(0); // Placeholder
 137
 138   // e_shstrndx  = Section # of '.shstrtab'
 139   ELFHdr_e_shstrndx_Offset = ElfHdr.size();
 140   ElfHdr.emitWord16(0); // Placeholder
 141
 142   // Add the null section, which is required to be first in the file.
 143   getNullSection();
 144
 145   return false;
 146 }
 147
 148 // getGlobalELFVisibility - Returns the ELF specific visibility type
 149 unsigned ELFWriter::getGlobalELFVisibility(const GlobalValue *GV) {
 150   switch (GV->getVisibility()) {
 151   default:
 152     llvm_unreachable("unknown visibility type");
 153   case GlobalValue::DefaultVisibility:
 154     return ELFSym::STV_DEFAULT;
 155   case GlobalValue::HiddenVisibility:
 156     return ELFSym::STV_HIDDEN;
 157   case GlobalValue::ProtectedVisibility:
 158     return ELFSym::STV_PROTECTED;
 159   }
 160   return 0;
 161 }
 162
 163 // getGlobalELFBinding - Returns the ELF specific binding type
 164 unsigned ELFWriter::getGlobalELFBinding(const GlobalValue *GV) {
 165   if (GV->hasInternalLinkage())
 166     return ELFSym::STB_LOCAL;
 167
 168   if (GV->hasWeakLinkage())
 169     return ELFSym::STB_WEAK;
 170
 171   return ELFSym::STB_GLOBAL;
 172 }
 173
 174 // getGlobalELFType - Returns the ELF specific type for a global
 175 unsigned ELFWriter::getGlobalELFType(const GlobalValue *GV) {
 176   if (GV->isDeclaration())
 177     return ELFSym::STT_NOTYPE;
 178
 179   if (isa<Function>(GV))
 180     return ELFSym::STT_FUNC;
 181
 182   return ELFSym::STT_OBJECT;
 183 }
 184
 185 // getElfSectionFlags - Get the ELF Section Header flags based
 186 // on the flags defined in ELFTargetAsmInfo.
 187 unsigned ELFWriter::getElfSectionFlags(unsigned Flags) {
 188   unsigned ElfSectionFlags = ELFSection::SHF_ALLOC;
 189
 190   if (Flags & SectionFlags::Code)
 191     ElfSectionFlags |= ELFSection::SHF_EXECINSTR;
 192   if (Flags & SectionFlags::Writeable)
 193     ElfSectionFlags |= ELFSection::SHF_WRITE;
 194   if (Flags & SectionFlags::Mergeable)
 195     ElfSectionFlags |= ELFSection::SHF_MERGE;
 196   if (Flags & SectionFlags::TLS)
 197     ElfSectionFlags |= ELFSection::SHF_TLS;
 198   if (Flags & SectionFlags::Strings)
 199     ElfSectionFlags |= ELFSection::SHF_STRINGS;
 200
 201   return ElfSectionFlags;
 202 }
 203
 204 // isELFUndefSym - the symbol has no section and must be placed in
 205 // the symbol table with a reference to the null section.
 206 static bool isELFUndefSym(const GlobalValue *GV) {
 207   return GV->isDeclaration();
 208 }
 209
 210 // isELFBssSym - for an undef or null value, the symbol must go to a bss
 211 // section if it's not weak for linker, otherwise it's a common sym.
 212 static bool isELFBssSym(const GlobalValue *GV) {
 213   return (!GV->isDeclaration() &&
 214           (GV->isNullValue() || isa<UndefValue>(GV)) &&
 215           !GV->isWeakForLinker());
 216 }
 217
 218 // isELFCommonSym - for an undef or null value, the symbol must go to a
 219 // common section if it's weak for linker, otherwise bss.
 220 static bool isELFCommonSym(const GlobalValue *GV) {
 221   return (!GV->isDeclaration() &&
 222           (GV->isNullValue() || isa<UndefValue>(GV))
 223            && GV->isWeakForLinker());
 224 }
 225
 226 // isELFDataSym - if the symbol is an initialized but no null constant
 227 // it must go to some kind of data section gathered from TAI
 228 static bool isELFDataSym(const GlobalValue *GV) {
 229   return (!GV->isDeclaration() &&
 230           !(GV->isNullValue() || isa<UndefValue>(GV)));
 231 }
 232
 233 // EmitGlobal - Choose the right section for global and emit it
 234 void ELFWriter::EmitGlobal(const GlobalValue *GV) {
 235
 236   // Handle ELF Bind, Visibility and Type for the current symbol
 237   unsigned SymBind = getGlobalELFBinding(GV);
 238   ELFSym GblSym(GV);
 239   GblSym.setBind(SymBind);
 240   GblSym.setVisibility(getGlobalELFVisibility(GV));
 241   GblSym.setType(getGlobalELFType(GV));
 242
 243   if (isELFUndefSym(GV)) {
 244     GblSym.SectionIdx = ELFSection::SHN_UNDEF;
 245   } else {
 246     assert(isa<GlobalVariable>(GV) && "GV not a global variable!");
 247     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV);
 248
 249     // Get ELF section from TAI
 250     const Section *S = TAI->SectionForGlobal(GV);
 251     unsigned SectionFlags = getElfSectionFlags(S->getFlags());
 252
 253     // The symbol align should update the section alignment if needed
 254     const TargetData *TD = TM.getTargetData();
 255     unsigned Align = TD->getPreferredAlignment(GVar);
 256     unsigned Size = TD->getTypeAllocSize(GVar->getInitializer()->getType());
 257     GblSym.Size = Size;
 258
 259     if (isELFCommonSym(GV)) {
 260       GblSym.SectionIdx = ELFSection::SHN_COMMON;
 261       getSection(S->getName(), ELFSection::SHT_NOBITS, SectionFlags, 1);
 262
 263       // A new linkonce section is created for each global in the
 264       // common section, the default alignment is 1 and the symbol
 265       // value contains its alignment.
 266       GblSym.Value = Align;
 267
 268     } else if (isELFBssSym(GV)) {
 269       ELFSection &ES =
 270         getSection(S->getName(), ELFSection::SHT_NOBITS, SectionFlags);
 271       GblSym.SectionIdx = ES.SectionIdx;
 272
 273       // Update the size with alignment and the next object can
 274       // start in the right offset in the section
 275       if (Align) ES.Size = (ES.Size + Align-1) & ~(Align-1);
 276       ES.Align = std::max(ES.Align, Align);
 277
 278       // GblSym.Value should contain the virtual offset inside the section.
 279       // Virtual because the BSS space is not allocated on ELF objects
 280       GblSym.Value = ES.Size;
 281       ES.Size += Size;
 282
 283     } else if (isELFDataSym(GV)) {
 284       ELFSection &ES =
 285         getSection(S->getName(), ELFSection::SHT_PROGBITS, SectionFlags);
 286       GblSym.SectionIdx = ES.SectionIdx;
 287
 288       // GblSym.Value should contain the symbol offset inside the section,
 289       // and all symbols should start on their required alignment boundary
 290       ES.Align = std::max(ES.Align, Align);
 291       GblSym.Value = (ES.size() + (Align-1)) & (-Align);
 292       ES.emitAlignment(ES.Align);
 293
 294       // Emit the global to the data section 'ES'
 295       EmitGlobalConstant(GVar->getInitializer(), ES);
 296     }
 297   }
 298
 299   // Local symbols should come first on the symbol table.
 300   if (!GV->hasPrivateLinkage()) {
 301     if (SymBind == ELFSym::STB_LOCAL)
 302       SymbolList.push_front(GblSym);
 303     else
 304       SymbolList.push_back(GblSym);
 305   }
 306 }
 307
 308 void ELFWriter::EmitGlobalConstantStruct(const ConstantStruct *CVS,
 309                                          ELFSection &GblS) {
 310
 311   // Print the fields in successive locations. Pad to align if needed!
 312   const TargetData *TD = TM.getTargetData();
 313   unsigned Size = TD->getTypeAllocSize(CVS->getType());
 314   const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
 315   uint64_t sizeSoFar = 0;
 316   for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
 317     const Constant* field = CVS->getOperand(i);
 318
 319     // Check if padding is needed and insert one or more 0s.
 320     uint64_t fieldSize = TD->getTypeAllocSize(field->getType());
 321     uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
 322                         - cvsLayout->getElementOffset(i)) - fieldSize;
 323     sizeSoFar += fieldSize + padSize;
 324
 325     // Now print the actual field value.
 326     EmitGlobalConstant(field, GblS);
 327
 328     // Insert padding - this may include padding to increase the size of the
 329     // current field up to the ABI size (if the struct is not packed) as well
 330     // as padding to ensure that the next field starts at the right offset.
 331     for (unsigned p=0; p < padSize; p++)
 332       GblS.emitByte(0);
 333   }
 334   assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
 335          "Layout of constant struct may be incorrect!");
 336 }
 337
 338 void ELFWriter::EmitGlobalConstant(const Constant *CV, ELFSection &GblS) {
 339   const TargetData *TD = TM.getTargetData();
 340   unsigned Size = TD->getTypeAllocSize(CV->getType());
 341
 342   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
 343     if (CVA->isString()) {
 344       std::string GblStr = CVA->getAsString();
 345       GblStr.resize(GblStr.size()-1);
 346       GblS.emitString(GblStr);
 347     } else { // Not a string.  Print the values in successive locations
 348       for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
 349         EmitGlobalConstant(CVA->getOperand(i), GblS);
 350     }
 351     return;
 352   } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
 353     EmitGlobalConstantStruct(CVS, GblS);
 354     return;
 355   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 356     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
 357     if (CFP->getType() == Type::DoubleTy)
 358       GblS.emitWord64(Val);
 359     else if (CFP->getType() == Type::FloatTy)
 360       GblS.emitWord32(Val);
 361     else if (CFP->getType() == Type::X86_FP80Ty) {
 362       llvm_unreachable("X86_FP80Ty global emission not implemented");
 363     } else if (CFP->getType() == Type::PPC_FP128Ty)
 364       llvm_unreachable("PPC_FP128Ty global emission not implemented");
 365     return;
 366   } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
 367     if (Size == 4)
 368       GblS.emitWord32(CI->getZExtValue());
 369     else if (Size == 8)
 370       GblS.emitWord64(CI->getZExtValue());
 371     else
 372       llvm_unreachable("LargeInt global emission not implemented");
 373     return;
 374   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
 375     const VectorType *PTy = CP->getType();
 376     for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
 377       EmitGlobalConstant(CP->getOperand(I), GblS);
 378     return;
 379   }
 380   llvm_unreachable("unknown global constant");
 381 }
 382
 383
 384 bool ELFWriter::runOnMachineFunction(MachineFunction &MF) {
 385   // Nothing to do here, this is all done through the ElfCE object above.
 386   return false;
 387 }
 388
 389 /// doFinalization - Now that the module has been completely processed, emit
 390 /// the ELF file to 'O'.
 391 bool ELFWriter::doFinalization(Module &M) {
 392   // Emit .data section placeholder
 393   getDataSection();
 394
 395   // Emit .bss section placeholder
 396   getBSSSection();
 397
 398   // Build and emit data, bss and "common" sections.
 399   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 400        I != E; ++I) {
 401     EmitGlobal(I);
 402     GblSymLookup[I] = 0;
 403   }
 404
 405   // Emit all pending globals
 406   // TODO: this should be done only for referenced symbols
 407   for (SetVector<GlobalValue*>::const_iterator I = PendingGlobals.begin(),
 408        E = PendingGlobals.end(); I != E; ++I) {
 409
 410     // No need to emit the symbol again
 411     if (GblSymLookup.find(*I) != GblSymLookup.end())
 412       continue;
 413
 414     EmitGlobal(*I);
 415     GblSymLookup[*I] = 0;
 416   }
 417
 418   // Emit non-executable stack note
 419   if (TAI->getNonexecutableStackDirective())
 420     getNonExecStackSection();
 421
 422   // Emit a symbol for each section created until now
 423   for (std::map<std::string, ELFSection*>::iterator I = SectionLookup.begin(),
 424        E = SectionLookup.end(); I != E; ++I) {
 425     ELFSection *ES = I->second;
 426
 427     // Skip null section
 428     if (ES->SectionIdx == 0) continue;
 429
 430     ELFSym SectionSym(0);
 431     SectionSym.SectionIdx = ES->SectionIdx;
 432     SectionSym.Size = 0;
 433     SectionSym.setBind(ELFSym::STB_LOCAL);
 434     SectionSym.setType(ELFSym::STT_SECTION);
 435     SectionSym.setVisibility(ELFSym::STV_DEFAULT);
 436
 437     // Local symbols go in the list front
 438     SymbolList.push_front(SectionSym);
 439   }
 440
 441   // Emit string table
 442   EmitStringTable();
 443
 444   // Emit the symbol table now, if non-empty.
 445   EmitSymbolTable();
 446
 447   // Emit the relocation sections.
 448   EmitRelocations();
 449
 450   // Emit the sections string table.
 451   EmitSectionTableStringTable();
 452
 453   // Dump the sections and section table to the .o file.
 454   OutputSectionsAndSectionTable();
 455
 456   // We are done with the abstract symbols.
 457   SectionList.clear();
 458   NumSections = 0;
 459
 460   // Release the name mangler object.
 461   delete Mang; Mang = 0;
 462   return false;
 463 }
 464
 465 /// EmitRelocations - Emit relocations
 466 void ELFWriter::EmitRelocations() {
 467
 468   // Create Relocation sections for each section which needs it.
 469   for (std::list<ELFSection>::iterator I = SectionList.begin(),
 470        E = SectionList.end(); I != E; ++I) {
 471
 472     // This section does not have relocations
 473     if (!I->hasRelocations()) continue;
 474
 475     // Get the relocation section for section 'I'
 476     bool HasRelA = TEW->hasRelocationAddend();
 477     ELFSection &RelSec = getRelocSection(I->getName(), HasRelA,
 478                                          TEW->getPrefELFAlignment());
 479
 480     // 'Link' - Section hdr idx of the associated symbol table
 481     // 'Info' - Section hdr idx of the section to which the relocation applies
 482     ELFSection &SymTab = getSymbolTableSection();
 483     RelSec.Link = SymTab.SectionIdx;
 484     RelSec.Info = I->SectionIdx;
 485     RelSec.EntSize = TEW->getRelocationEntrySize();
 486
 487     // Get the relocations from Section
 488     std::vector<MachineRelocation> Relos = I->getRelocations();
 489     for (std::vector<MachineRelocation>::iterator MRI = Relos.begin(),
 490          MRE = Relos.end(); MRI != MRE; ++MRI) {
 491       MachineRelocation &MR = *MRI;
 492
 493       // Offset from the start of the section containing the symbol
 494       unsigned Offset = MR.getMachineCodeOffset();
 495
 496       // Symbol index in the symbol table
 497       unsigned SymIdx = 0;
 498
 499       // Target specific ELF relocation type
 500       unsigned RelType = TEW->getRelocationType(MR.getRelocationType());
 501
 502       // Constant addend used to compute the value to be stored
 503       // into the relocatable field
 504       int64_t Addend = 0;
 505
 506       // There are several machine relocations types, and each one of
 507       // them needs a different approach to retrieve the symbol table index.
 508       if (MR.isGlobalValue()) {
 509         const GlobalValue *G = MR.getGlobalValue();
 510         SymIdx = GblSymLookup[G];
 511         Addend = TEW->getAddendForRelTy(RelType);
 512       } else {
 513         unsigned SectionIdx = MR.getConstantVal();
 514         // TODO: use a map for this.
 515         for (std::list<ELFSym>::iterator I = SymbolList.begin(),
 516              E = SymbolList.end(); I != E; ++I)
 517           if ((SectionIdx == I->SectionIdx) &&
 518               (I->getType() == ELFSym::STT_SECTION)) {
 519             SymIdx = I->SymTabIdx;
 520             break;
 521           }
 522         Addend = (uint64_t)MR.getResultPointer();
 523       }
 524
 525       // Get the relocation entry and emit to the relocation section
 526       ELFRelocation Rel(Offset, SymIdx, RelType, HasRelA, Addend);
 527       EmitRelocation(RelSec, Rel, HasRelA);
 528     }
 529   }
 530 }
 531
 532 /// EmitRelocation - Write relocation 'Rel' to the relocation section 'Rel'
 533 void ELFWriter::EmitRelocation(BinaryObject &RelSec, ELFRelocation &Rel,
 534                                bool HasRelA) {
 535   RelSec.emitWord(Rel.getOffset());
 536   RelSec.emitWord(Rel.getInfo(is64Bit));
 537   if (HasRelA)
 538     RelSec.emitWord(Rel.getAddend());
 539 }
 540
 541 /// EmitSymbol - Write symbol 'Sym' to the symbol table 'SymbolTable'
 542 void ELFWriter::EmitSymbol(BinaryObject &SymbolTable, ELFSym &Sym) {
 543   if (is64Bit) {
 544     SymbolTable.emitWord32(Sym.NameIdx);
 545     SymbolTable.emitByte(Sym.Info);
 546     SymbolTable.emitByte(Sym.Other);
 547     SymbolTable.emitWord16(Sym.SectionIdx);
 548     SymbolTable.emitWord64(Sym.Value);
 549     SymbolTable.emitWord64(Sym.Size);
 550   } else {
 551     SymbolTable.emitWord32(Sym.NameIdx);
 552     SymbolTable.emitWord32(Sym.Value);
 553     SymbolTable.emitWord32(Sym.Size);
 554     SymbolTable.emitByte(Sym.Info);
 555     SymbolTable.emitByte(Sym.Other);
 556     SymbolTable.emitWord16(Sym.SectionIdx);
 557   }
 558 }
 559
 560 /// EmitSectionHeader - Write section 'Section' header in 'SHdrTab'
 561 /// Section Header Table
 562 void ELFWriter::EmitSectionHeader(BinaryObject &SHdrTab,
 563                                   const ELFSection &SHdr) {
 564   SHdrTab.emitWord32(SHdr.NameIdx);
 565   SHdrTab.emitWord32(SHdr.Type);
 566   if (is64Bit) {
 567     SHdrTab.emitWord64(SHdr.Flags);
 568     SHdrTab.emitWord(SHdr.Addr);
 569     SHdrTab.emitWord(SHdr.Offset);
 570     SHdrTab.emitWord64(SHdr.Size);
 571     SHdrTab.emitWord32(SHdr.Link);
 572     SHdrTab.emitWord32(SHdr.Info);
 573     SHdrTab.emitWord64(SHdr.Align);
 574     SHdrTab.emitWord64(SHdr.EntSize);
 575   } else {
 576     SHdrTab.emitWord32(SHdr.Flags);
 577     SHdrTab.emitWord(SHdr.Addr);
 578     SHdrTab.emitWord(SHdr.Offset);
 579     SHdrTab.emitWord32(SHdr.Size);
 580     SHdrTab.emitWord32(SHdr.Link);
 581     SHdrTab.emitWord32(SHdr.Info);
 582     SHdrTab.emitWord32(SHdr.Align);
 583     SHdrTab.emitWord32(SHdr.EntSize);
 584   }
 585 }
 586
 587 /// EmitStringTable - If the current symbol table is non-empty, emit the string
 588 /// table for it
 589 void ELFWriter::EmitStringTable() {
 590   if (!SymbolList.size()) return;  // Empty symbol table.
 591   ELFSection &StrTab = getStringTableSection();
 592
 593   // Set the zero'th symbol to a null byte, as required.
 594   StrTab.emitByte(0);
 595
 596   // Walk on the symbol list and write symbol names into the
 597   // string table.
 598   unsigned Index = 1;
 599   for (std::list<ELFSym>::iterator I = SymbolList.begin(),
 600        E = SymbolList.end(); I != E; ++I) {
 601
 602     // Use the name mangler to uniquify the LLVM symbol.
 603     std::string Name;
 604     if (I->GV) Name.append(Mang->getValueName(I->GV));
 605
 606     if (Name.empty()) {
 607       I->NameIdx = 0;
 608     } else {
 609       I->NameIdx = Index;
 610       StrTab.emitString(Name);
 611
 612       // Keep track of the number of bytes emitted to this section.
 613       Index += Name.size()+1;
 614     }
 615   }
 616   assert(Index == StrTab.size());
 617   StrTab.Size = Index;
 618 }
 619
 620 /// EmitSymbolTable - Emit the symbol table itself.
 621 void ELFWriter::EmitSymbolTable() {
 622   if (!SymbolList.size()) return;  // Empty symbol table.
 623
 624   unsigned FirstNonLocalSymbol = 1;
 625   // Now that we have emitted the string table and know the offset into the
 626   // string table of each symbol, emit the symbol table itself.
 627   ELFSection &SymTab = getSymbolTableSection();
 628   SymTab.Align = TEW->getPrefELFAlignment();
 629
 630   // Section Index of .strtab.
 631   SymTab.Link = getStringTableSection().SectionIdx;
 632
 633   // Size of each symtab entry.
 634   SymTab.EntSize = TEW->getSymTabEntrySize();
 635
 636   // The first entry in the symtab is the null symbol
 637   ELFSym NullSym = ELFSym(0);
 638   EmitSymbol(SymTab, NullSym);
 639
 640   // Emit all the symbols to the symbol table. Skip the null
 641   // symbol, cause it's emitted already
 642   unsigned Index = 1;
 643   for (std::list<ELFSym>::iterator I = SymbolList.begin(),
 644        E = SymbolList.end(); I != E; ++I, ++Index) {
 645     // Keep track of the first non-local symbol
 646     if (I->getBind() == ELFSym::STB_LOCAL)
 647       FirstNonLocalSymbol++;
 648
 649     // Emit symbol to the symbol table
 650     EmitSymbol(SymTab, *I);
 651
 652     // Record the symbol table index for each global value
 653     if (I->GV)
 654       GblSymLookup[I->GV] = Index;
 655
 656     // Keep track on the symbol index into the symbol table
 657     I->SymTabIdx = Index;
 658   }
 659
 660   SymTab.Info = FirstNonLocalSymbol;
 661   SymTab.Size = SymTab.size();
 662 }
 663
 664 /// EmitSectionTableStringTable - This method adds and emits a section for the
 665 /// ELF Section Table string table: the string table that holds all of the
 666 /// section names.
 667 void ELFWriter::EmitSectionTableStringTable() {
 668   // First step: add the section for the string table to the list of sections:
 669   ELFSection &SHStrTab = getSectionHeaderStringTableSection();
 670
 671   // Now that we know which section number is the .shstrtab section, update the
 672   // e_shstrndx entry in the ELF header.
 673   ElfHdr.fixWord16(SHStrTab.SectionIdx, ELFHdr_e_shstrndx_Offset);
 674
 675   // Set the NameIdx of each section in the string table and emit the bytes for
 676   // the string table.
 677   unsigned Index = 0;
 678
 679   for (std::list<ELFSection>::iterator I = SectionList.begin(),
 680          E = SectionList.end(); I != E; ++I) {
 681     // Set the index into the table.  Note if we have lots of entries with
 682     // common suffixes, we could memoize them here if we cared.
 683     I->NameIdx = Index;
 684     SHStrTab.emitString(I->getName());
 685
 686     // Keep track of the number of bytes emitted to this section.
 687     Index += I->getName().size()+1;
 688   }
 689
 690   // Set the size of .shstrtab now that we know what it is.
 691   assert(Index == SHStrTab.size());
 692   SHStrTab.Size = Index;
 693 }
 694
 695 /// OutputSectionsAndSectionTable - Now that we have constructed the file header
 696 /// and all of the sections, emit these to the ostream destination and emit the
 697 /// SectionTable.
 698 void ELFWriter::OutputSectionsAndSectionTable() {
 699   // Pass #1: Compute the file offset for each section.
 700   size_t FileOff = ElfHdr.size();   // File header first.
 701
 702   // Adjust alignment of all section if needed.
 703   for (std::list<ELFSection>::iterator I = SectionList.begin(),
 704          E = SectionList.end(); I != E; ++I) {
 705
 706     // Section idx 0 has 0 offset
 707     if (!I->SectionIdx)
 708       continue;
 709
 710     if (!I->size()) {
 711       I->Offset = FileOff;
 712       continue;
 713     }
 714
 715     // Update Section size
 716     if (!I->Size)
 717       I->Size = I->size();
 718
 719     // Align FileOff to whatever the alignment restrictions of the section are.
 720     if (I->Align)
 721       FileOff = (FileOff+I->Align-1) & ~(I->Align-1);
 722
 723     I->Offset = FileOff;
 724     FileOff += I->Size;
 725   }
 726
 727   // Align Section Header.
 728   unsigned TableAlign = TEW->getPrefELFAlignment();
 729   FileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 730
 731   // Now that we know where all of the sections will be emitted, set the e_shnum
 732   // entry in the ELF header.
 733   ElfHdr.fixWord16(NumSections, ELFHdr_e_shnum_Offset);
 734
 735   // Now that we know the offset in the file of the section table, update the
 736   // e_shoff address in the ELF header.
 737   ElfHdr.fixWord(FileOff, ELFHdr_e_shoff_Offset);
 738
 739   // Now that we know all of the data in the file header, emit it and all of the
 740   // sections!
 741   O.write((char *)&ElfHdr.getData()[0], ElfHdr.size());
 742   FileOff = ElfHdr.size();
 743
 744   // Section Header Table blob
 745   BinaryObject SHdrTable(isLittleEndian, is64Bit);
 746
 747   // Emit all of sections to the file and build the section header table.
 748   while (!SectionList.empty()) {
 749     ELFSection &S = *SectionList.begin();
 750     DOUT << "SectionIdx: " << S.SectionIdx << ", Name: " << S.getName()
 751          << ", Size: " << S.Size << ", Offset: " << S.Offset
 752          << ", SectionData Size: " << S.size() << "\n";
 753
 754     // Align FileOff to whatever the alignment restrictions of the section are.
 755     if (S.size()) {
 756       if (S.Align)  {
 757         for (size_t NewFileOff = (FileOff+S.Align-1) & ~(S.Align-1);
 758              FileOff != NewFileOff; ++FileOff)
 759           O << (char)0xAB;
 760       }
 761       O.write((char *)&S.getData()[0], S.Size);
 762       FileOff += S.Size;
 763     }
 764
 765     EmitSectionHeader(SHdrTable, S);
 766     SectionList.pop_front();
 767   }
 768
 769   // Align output for the section table.
 770   for (size_t NewFileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 771        FileOff != NewFileOff; ++FileOff)
 772     O << (char)0xAB;
 773
 774   // Emit the section table itself.
 775   O.write((char *)&SHdrTable.getData()[0], SHdrTable.size());
 776 }