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 = new ELFSym(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   if (!GV->hasPrivateLinkage())
 300     SymbolList.push_back(GblSym);
 301 }
 302
 303 void ELFWriter::EmitGlobalConstantStruct(const ConstantStruct *CVS,
 304                                          ELFSection &GblS) {
 305
 306   // Print the fields in successive locations. Pad to align if needed!
 307   const TargetData *TD = TM.getTargetData();
 308   unsigned Size = TD->getTypeAllocSize(CVS->getType());
 309   const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
 310   uint64_t sizeSoFar = 0;
 311   for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
 312     const Constant* field = CVS->getOperand(i);
 313
 314     // Check if padding is needed and insert one or more 0s.
 315     uint64_t fieldSize = TD->getTypeAllocSize(field->getType());
 316     uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
 317                         - cvsLayout->getElementOffset(i)) - fieldSize;
 318     sizeSoFar += fieldSize + padSize;
 319
 320     // Now print the actual field value.
 321     EmitGlobalConstant(field, GblS);
 322
 323     // Insert padding - this may include padding to increase the size of the
 324     // current field up to the ABI size (if the struct is not packed) as well
 325     // as padding to ensure that the next field starts at the right offset.
 326     for (unsigned p=0; p < padSize; p++)
 327       GblS.emitByte(0);
 328   }
 329   assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
 330          "Layout of constant struct may be incorrect!");
 331 }
 332
 333 void ELFWriter::EmitGlobalConstant(const Constant *CV, ELFSection &GblS) {
 334   const TargetData *TD = TM.getTargetData();
 335   unsigned Size = TD->getTypeAllocSize(CV->getType());
 336
 337   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
 338     if (CVA->isString()) {
 339       std::string GblStr = CVA->getAsString();
 340       GblStr.resize(GblStr.size()-1);
 341       GblS.emitString(GblStr);
 342     } else { // Not a string.  Print the values in successive locations
 343       for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
 344         EmitGlobalConstant(CVA->getOperand(i), GblS);
 345     }
 346     return;
 347   } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
 348     EmitGlobalConstantStruct(CVS, GblS);
 349     return;
 350   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 351     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
 352     if (CFP->getType() == Type::DoubleTy)
 353       GblS.emitWord64(Val);
 354     else if (CFP->getType() == Type::FloatTy)
 355       GblS.emitWord32(Val);
 356     else if (CFP->getType() == Type::X86_FP80Ty) {
 357       llvm_unreachable("X86_FP80Ty global emission not implemented");
 358     } else if (CFP->getType() == Type::PPC_FP128Ty)
 359       llvm_unreachable("PPC_FP128Ty global emission not implemented");
 360     return;
 361   } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
 362     if (Size == 4)
 363       GblS.emitWord32(CI->getZExtValue());
 364     else if (Size == 8)
 365       GblS.emitWord64(CI->getZExtValue());
 366     else
 367       llvm_unreachable("LargeInt global emission not implemented");
 368     return;
 369   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
 370     const VectorType *PTy = CP->getType();
 371     for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
 372       EmitGlobalConstant(CP->getOperand(I), GblS);
 373     return;
 374   }
 375   llvm_unreachable("unknown global constant");
 376 }
 377
 378
 379 bool ELFWriter::runOnMachineFunction(MachineFunction &MF) {
 380   // Nothing to do here, this is all done through the ElfCE object above.
 381   return false;
 382 }
 383
 384 /// doFinalization - Now that the module has been completely processed, emit
 385 /// the ELF file to 'O'.
 386 bool ELFWriter::doFinalization(Module &M) {
 387   // Emit .data section placeholder
 388   getDataSection();
 389
 390   // Emit .bss section placeholder
 391   getBSSSection();
 392
 393   // Build and emit data, bss and "common" sections.
 394   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 395        I != E; ++I) {
 396     EmitGlobal(I);
 397     GblSymLookup[I] = 0;
 398   }
 399
 400   // Emit all pending globals
 401   // TODO: this should be done only for referenced symbols
 402   for (SetVector<GlobalValue*>::const_iterator I = PendingGlobals.begin(),
 403        E = PendingGlobals.end(); I != E; ++I) {
 404
 405     // No need to emit the symbol again
 406     if (GblSymLookup.find(*I) != GblSymLookup.end())
 407       continue;
 408
 409     EmitGlobal(*I);
 410     GblSymLookup[*I] = 0;
 411   }
 412
 413   // Emit non-executable stack note
 414   if (TAI->getNonexecutableStackDirective())
 415     getNonExecStackSection();
 416
 417   // Emit a symbol for each section created until now, skip null section
 418   for (unsigned i = 1, e = SectionList.size(); i < e; ++i) {
 419     ELFSection &ES = *SectionList[i];
 420     ELFSym *SectionSym = new ELFSym(0);
 421     SectionSym->SectionIdx = ES.SectionIdx;
 422     SectionSym->Size = 0;
 423     SectionSym->setBind(ELFSym::STB_LOCAL);
 424     SectionSym->setType(ELFSym::STT_SECTION);
 425     SectionSym->setVisibility(ELFSym::STV_DEFAULT);
 426     SymbolList.push_back(SectionSym);
 427     ES.Sym = SymbolList.back();
 428   }
 429
 430   // Emit string table
 431   EmitStringTable();
 432
 433   // Emit the symbol table now, if non-empty.
 434   EmitSymbolTable();
 435
 436   // Emit the relocation sections.
 437   EmitRelocations();
 438
 439   // Emit the sections string table.
 440   EmitSectionTableStringTable();
 441
 442   // Dump the sections and section table to the .o file.
 443   OutputSectionsAndSectionTable();
 444
 445   // We are done with the abstract symbols.
 446   SymbolList.clear();
 447   SectionList.clear();
 448   NumSections = 0;
 449
 450   // Release the name mangler object.
 451   delete Mang; Mang = 0;
 452   return false;
 453 }
 454
 455 /// EmitRelocations - Emit relocations
 456 void ELFWriter::EmitRelocations() {
 457
 458   // Create Relocation sections for each section which needs it.
 459   for (ELFSectionIter I=SectionList.begin(), E=SectionList.end(); I != E; ++I) {
 460     ELFSection &S = *(*I);
 461
 462     // This section does not have relocations
 463     if (!S.hasRelocations()) continue;
 464
 465     // Get the relocation section for section 'S'
 466     bool HasRelA = TEW->hasRelocationAddend();
 467     ELFSection &RelSec = getRelocSection(S.getName(), HasRelA,
 468                                          TEW->getPrefELFAlignment());
 469
 470     // 'Link' - Section hdr idx of the associated symbol table
 471     // 'Info' - Section hdr idx of the section to which the relocation applies
 472     ELFSection &SymTab = getSymbolTableSection();
 473     RelSec.Link = SymTab.SectionIdx;
 474     RelSec.Info = S.SectionIdx;
 475     RelSec.EntSize = TEW->getRelocationEntrySize();
 476
 477     // Get the relocations from Section
 478     std::vector<MachineRelocation> Relos = S.getRelocations();
 479     for (std::vector<MachineRelocation>::iterator MRI = Relos.begin(),
 480          MRE = Relos.end(); MRI != MRE; ++MRI) {
 481       MachineRelocation &MR = *MRI;
 482
 483       // Offset from the start of the section containing the symbol
 484       unsigned Offset = MR.getMachineCodeOffset();
 485
 486       // Symbol index in the symbol table
 487       unsigned SymIdx = 0;
 488
 489       // Target specific ELF relocation type
 490       unsigned RelType = TEW->getRelocationType(MR.getRelocationType());
 491
 492       // Constant addend used to compute the value to be stored
 493       // into the relocatable field
 494       int64_t Addend = 0;
 495
 496       // There are several machine relocations types, and each one of
 497       // them needs a different approach to retrieve the symbol table index.
 498       if (MR.isGlobalValue()) {
 499         const GlobalValue *G = MR.getGlobalValue();
 500         SymIdx = GblSymLookup[G];
 501         Addend = TEW->getAddendForRelTy(RelType);
 502       } else {
 503         // Get the symbol index for the section symbol referenced
 504         // by the relocation
 505         unsigned SectionIdx = MR.getConstantVal();
 506         SymIdx = SectionList[SectionIdx]->Sym->SymTabIdx;
 507         Addend = (uint64_t)MR.getResultPointer();
 508       }
 509
 510       // Get the relocation entry and emit to the relocation section
 511       ELFRelocation Rel(Offset, SymIdx, RelType, HasRelA, Addend);
 512       EmitRelocation(RelSec, Rel, HasRelA);
 513     }
 514   }
 515 }
 516
 517 /// EmitRelocation - Write relocation 'Rel' to the relocation section 'Rel'
 518 void ELFWriter::EmitRelocation(BinaryObject &RelSec, ELFRelocation &Rel,
 519                                bool HasRelA) {
 520   RelSec.emitWord(Rel.getOffset());
 521   RelSec.emitWord(Rel.getInfo(is64Bit));
 522   if (HasRelA)
 523     RelSec.emitWord(Rel.getAddend());
 524 }
 525
 526 /// EmitSymbol - Write symbol 'Sym' to the symbol table 'SymbolTable'
 527 void ELFWriter::EmitSymbol(BinaryObject &SymbolTable, ELFSym &Sym) {
 528   if (is64Bit) {
 529     SymbolTable.emitWord32(Sym.NameIdx);
 530     SymbolTable.emitByte(Sym.Info);
 531     SymbolTable.emitByte(Sym.Other);
 532     SymbolTable.emitWord16(Sym.SectionIdx);
 533     SymbolTable.emitWord64(Sym.Value);
 534     SymbolTable.emitWord64(Sym.Size);
 535   } else {
 536     SymbolTable.emitWord32(Sym.NameIdx);
 537     SymbolTable.emitWord32(Sym.Value);
 538     SymbolTable.emitWord32(Sym.Size);
 539     SymbolTable.emitByte(Sym.Info);
 540     SymbolTable.emitByte(Sym.Other);
 541     SymbolTable.emitWord16(Sym.SectionIdx);
 542   }
 543 }
 544
 545 /// EmitSectionHeader - Write section 'Section' header in 'SHdrTab'
 546 /// Section Header Table
 547 void ELFWriter::EmitSectionHeader(BinaryObject &SHdrTab,
 548                                   const ELFSection &SHdr) {
 549   SHdrTab.emitWord32(SHdr.NameIdx);
 550   SHdrTab.emitWord32(SHdr.Type);
 551   if (is64Bit) {
 552     SHdrTab.emitWord64(SHdr.Flags);
 553     SHdrTab.emitWord(SHdr.Addr);
 554     SHdrTab.emitWord(SHdr.Offset);
 555     SHdrTab.emitWord64(SHdr.Size);
 556     SHdrTab.emitWord32(SHdr.Link);
 557     SHdrTab.emitWord32(SHdr.Info);
 558     SHdrTab.emitWord64(SHdr.Align);
 559     SHdrTab.emitWord64(SHdr.EntSize);
 560   } else {
 561     SHdrTab.emitWord32(SHdr.Flags);
 562     SHdrTab.emitWord(SHdr.Addr);
 563     SHdrTab.emitWord(SHdr.Offset);
 564     SHdrTab.emitWord32(SHdr.Size);
 565     SHdrTab.emitWord32(SHdr.Link);
 566     SHdrTab.emitWord32(SHdr.Info);
 567     SHdrTab.emitWord32(SHdr.Align);
 568     SHdrTab.emitWord32(SHdr.EntSize);
 569   }
 570 }
 571
 572 /// EmitStringTable - If the current symbol table is non-empty, emit the string
 573 /// table for it
 574 void ELFWriter::EmitStringTable() {
 575   if (!SymbolList.size()) return;  // Empty symbol table.
 576   ELFSection &StrTab = getStringTableSection();
 577
 578   // Set the zero'th symbol to a null byte, as required.
 579   StrTab.emitByte(0);
 580
 581   // Walk on the symbol list and write symbol names into the
 582   // string table.
 583   unsigned Index = 1;
 584   for (ELFSymIter I=SymbolList.begin(), E=SymbolList.end(); I != E; ++I) {
 585     ELFSym &Sym = *(*I);
 586
 587     // Use the name mangler to uniquify the LLVM symbol.
 588     std::string Name;
 589     if (Sym.GV) Name.append(Mang->getMangledName(Sym.GV));
 590
 591     if (Name.empty()) {
 592       Sym.NameIdx = 0;
 593     } else {
 594       Sym.NameIdx = Index;
 595       StrTab.emitString(Name);
 596
 597       // Keep track of the number of bytes emitted to this section.
 598       Index += Name.size()+1;
 599     }
 600   }
 601   assert(Index == StrTab.size());
 602   StrTab.Size = Index;
 603 }
 604
 605 // SortSymbols - On the symbol table local symbols must come before
 606 // all other symbols with non-local bindings. The return value is
 607 // the position of the first non local symbol.
 608 unsigned ELFWriter::SortSymbols() {
 609   unsigned FirstNonLocalSymbol;
 610   std::vector<ELFSym*> LocalSyms, OtherSyms;
 611
 612   for (ELFSymIter I=SymbolList.begin(), E=SymbolList.end(); I != E; ++I) {
 613     if ((*I)->isLocalBind())
 614       LocalSyms.push_back(*I);
 615     else
 616       OtherSyms.push_back(*I);
 617   }
 618   SymbolList.clear();
 619   FirstNonLocalSymbol = LocalSyms.size();
 620
 621   for (unsigned i = 0; i < FirstNonLocalSymbol; ++i)
 622     SymbolList.push_back(LocalSyms[i]);
 623
 624   for (ELFSymIter I=OtherSyms.begin(), E=OtherSyms.end(); I != E; ++I)
 625     SymbolList.push_back(*I);
 626
 627   LocalSyms.clear();
 628   OtherSyms.clear();
 629
 630   return FirstNonLocalSymbol;
 631 }
 632
 633 /// EmitSymbolTable - Emit the symbol table itself.
 634 void ELFWriter::EmitSymbolTable() {
 635   if (!SymbolList.size()) return;  // Empty symbol table.
 636
 637   // Now that we have emitted the string table and know the offset into the
 638   // string table of each symbol, emit the symbol table itself.
 639   ELFSection &SymTab = getSymbolTableSection();
 640   SymTab.Align = TEW->getPrefELFAlignment();
 641
 642   // Section Index of .strtab.
 643   SymTab.Link = getStringTableSection().SectionIdx;
 644
 645   // Size of each symtab entry.
 646   SymTab.EntSize = TEW->getSymTabEntrySize();
 647
 648   // The first entry in the symtab is the null symbol
 649   SymbolList.insert(SymbolList.begin(), new ELFSym(0));
 650
 651   // Reorder the symbol table with local symbols first!
 652   unsigned FirstNonLocalSymbol = SortSymbols();
 653
 654   // Emit all the symbols to the symbol table.
 655   for (unsigned i = 0, e = SymbolList.size(); i < e; ++i) {
 656     ELFSym &Sym = *SymbolList[i];
 657
 658     // Emit symbol to the symbol table
 659     EmitSymbol(SymTab, Sym);
 660
 661     // Record the symbol table index for each global value
 662     if (Sym.GV) GblSymLookup[Sym.GV] = i;
 663
 664     // Keep track on the symbol index into the symbol table
 665     Sym.SymTabIdx = i;
 666   }
 667
 668   // One greater than the symbol table index of the last local symbol
 669   SymTab.Info = FirstNonLocalSymbol;
 670   SymTab.Size = SymTab.size();
 671 }
 672
 673 /// EmitSectionTableStringTable - This method adds and emits a section for the
 674 /// ELF Section Table string table: the string table that holds all of the
 675 /// section names.
 676 void ELFWriter::EmitSectionTableStringTable() {
 677   // First step: add the section for the string table to the list of sections:
 678   ELFSection &SHStrTab = getSectionHeaderStringTableSection();
 679
 680   // Now that we know which section number is the .shstrtab section, update the
 681   // e_shstrndx entry in the ELF header.
 682   ElfHdr.fixWord16(SHStrTab.SectionIdx, ELFHdr_e_shstrndx_Offset);
 683
 684   // Set the NameIdx of each section in the string table and emit the bytes for
 685   // the string table.
 686   unsigned Index = 0;
 687
 688   for (ELFSectionIter I=SectionList.begin(), E=SectionList.end(); I != E; ++I) {
 689     ELFSection &S = *(*I);
 690     // Set the index into the table.  Note if we have lots of entries with
 691     // common suffixes, we could memoize them here if we cared.
 692     S.NameIdx = Index;
 693     SHStrTab.emitString(S.getName());
 694
 695     // Keep track of the number of bytes emitted to this section.
 696     Index += S.getName().size()+1;
 697   }
 698
 699   // Set the size of .shstrtab now that we know what it is.
 700   assert(Index == SHStrTab.size());
 701   SHStrTab.Size = Index;
 702 }
 703
 704 /// OutputSectionsAndSectionTable - Now that we have constructed the file header
 705 /// and all of the sections, emit these to the ostream destination and emit the
 706 /// SectionTable.
 707 void ELFWriter::OutputSectionsAndSectionTable() {
 708   // Pass #1: Compute the file offset for each section.
 709   size_t FileOff = ElfHdr.size();   // File header first.
 710
 711   // Adjust alignment of all section if needed, skip the null section.
 712   for (unsigned i=1, e=SectionList.size(); i < e; ++i) {
 713     ELFSection &ES = *SectionList[i];
 714     if (!ES.size()) {
 715       ES.Offset = FileOff;
 716       continue;
 717     }
 718
 719     // Update Section size
 720     if (!ES.Size)
 721       ES.Size = ES.size();
 722
 723     // Align FileOff to whatever the alignment restrictions of the section are.
 724     if (ES.Align)
 725       FileOff = (FileOff+ES.Align-1) & ~(ES.Align-1);
 726
 727     ES.Offset = FileOff;
 728     FileOff += ES.Size;
 729   }
 730
 731   // Align Section Header.
 732   unsigned TableAlign = TEW->getPrefELFAlignment();
 733   FileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 734
 735   // Now that we know where all of the sections will be emitted, set the e_shnum
 736   // entry in the ELF header.
 737   ElfHdr.fixWord16(NumSections, ELFHdr_e_shnum_Offset);
 738
 739   // Now that we know the offset in the file of the section table, update the
 740   // e_shoff address in the ELF header.
 741   ElfHdr.fixWord(FileOff, ELFHdr_e_shoff_Offset);
 742
 743   // Now that we know all of the data in the file header, emit it and all of the
 744   // sections!
 745   O.write((char *)&ElfHdr.getData()[0], ElfHdr.size());
 746   FileOff = ElfHdr.size();
 747
 748   // Section Header Table blob
 749   BinaryObject SHdrTable(isLittleEndian, is64Bit);
 750
 751   // Emit all of sections to the file and build the section header table.
 752   for (ELFSectionIter I=SectionList.begin(), E=SectionList.end(); I != E; ++I) {
 753     ELFSection &S = *(*I);
 754     DOUT << "SectionIdx: " << S.SectionIdx << ", Name: " << S.getName()
 755          << ", Size: " << S.Size << ", Offset: " << S.Offset
 756          << ", SectionData Size: " << S.size() << "\n";
 757
 758     // Align FileOff to whatever the alignment restrictions of the section are.
 759     if (S.size()) {
 760       if (S.Align)  {
 761         for (size_t NewFileOff = (FileOff+S.Align-1) & ~(S.Align-1);
 762              FileOff != NewFileOff; ++FileOff)
 763           O << (char)0xAB;
 764       }
 765       O.write((char *)&S.getData()[0], S.Size);
 766       FileOff += S.Size;
 767     }
 768
 769     EmitSectionHeader(SHdrTable, S);
 770   }
 771
 772   // Align output for the section table.
 773   for (size_t NewFileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 774        FileOff != NewFileOff; ++FileOff)
 775     O << (char)0xAB;
 776
 777   // Emit the section table itself.
 778   O.write((char *)&SHdrTable.getData()[0], SHdrTable.size());
 779 }