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 #include "ELF.h"
  33 #include "ELFWriter.h"
  34 #include "ELFCodeEmitter.h"
  35 #include "llvm/Constants.h"
  36 #include "llvm/Module.h"
  37 #include "llvm/PassManager.h"
  38 #include "llvm/DerivedTypes.h"
  39 #include "llvm/CodeGen/BinaryObject.h"
  40 #include "llvm/CodeGen/FileWriters.h"
  41 #include "llvm/CodeGen/MachineCodeEmitter.h"
  42 #include "llvm/CodeGen/ObjectCodeEmitter.h"
  43 #include "llvm/CodeGen/MachineCodeEmitter.h"
  44 #include "llvm/CodeGen/MachineConstantPool.h"
  45 #include "llvm/Target/TargetAsmInfo.h"
  46 #include "llvm/Target/TargetData.h"
  47 #include "llvm/Target/TargetELFWriterInfo.h"
  48 #include "llvm/Target/TargetMachine.h"
  49 #include "llvm/Support/Mangler.h"
  50 #include "llvm/Support/Streams.h"
  51 #include "llvm/Support/raw_ostream.h"
  52 #include "llvm/Support/Debug.h"
  53 #include "llvm/Support/ErrorHandling.h"
  54
  55 using namespace llvm;
  56
  57 char ELFWriter::ID = 0;
  58
  59 /// AddELFWriter - Add the ELF writer to the function pass manager
  60 ObjectCodeEmitter *llvm::AddELFWriter(PassManagerBase &PM,
  61                                       raw_ostream &O,
  62                                       TargetMachine &TM) {
  63   ELFWriter *EW = new ELFWriter(O, TM);
  64   PM.add(EW);
  65   return EW->getObjectCodeEmitter();
  66 }
  67
  68 //===----------------------------------------------------------------------===//
  69 //                          ELFWriter Implementation
  70 //===----------------------------------------------------------------------===//
  71
  72 ELFWriter::ELFWriter(raw_ostream &o, TargetMachine &tm)
  73   : MachineFunctionPass(&ID), O(o), TM(tm),
  74     is64Bit(TM.getTargetData()->getPointerSizeInBits() == 64),
  75     isLittleEndian(TM.getTargetData()->isLittleEndian()),
  76     ElfHdr(isLittleEndian, is64Bit) {
  77
  78   TAI = TM.getTargetAsmInfo();
  79   TEW = TM.getELFWriterInfo();
  80
  81   // Create the object code emitter object for this target.
  82   ElfCE = new ELFCodeEmitter(*this);
  83
  84   // Inital number of sections
  85   NumSections = 0;
  86 }
  87
  88 ELFWriter::~ELFWriter() {
  89   delete ElfCE;
  90 }
  91
  92 // doInitialization - Emit the file header and all of the global variables for
  93 // the module to the ELF file.
  94 bool ELFWriter::doInitialization(Module &M) {
  95   Mang = new Mangler(M);
  96
  97   // ELF Header
  98   // ----------
  99   // Fields e_shnum e_shstrndx are only known after all section have
 100   // been emitted. They locations in the ouput buffer are recorded so
 101   // to be patched up later.
 102   //
 103   // Note
 104   // ----
 105   // emitWord method behaves differently for ELF32 and ELF64, writing
 106   // 4 bytes in the former and 8 in the last for *_off and *_addr elf types
 107
 108   ElfHdr.emitByte(0x7f); // e_ident[EI_MAG0]
 109   ElfHdr.emitByte('E');  // e_ident[EI_MAG1]
 110   ElfHdr.emitByte('L');  // e_ident[EI_MAG2]
 111   ElfHdr.emitByte('F');  // e_ident[EI_MAG3]
 112
 113   ElfHdr.emitByte(TEW->getEIClass()); // e_ident[EI_CLASS]
 114   ElfHdr.emitByte(TEW->getEIData());  // e_ident[EI_DATA]
 115   ElfHdr.emitByte(EV_CURRENT);        // e_ident[EI_VERSION]
 116   ElfHdr.emitAlignment(16);           // e_ident[EI_NIDENT-EI_PAD]
 117
 118   ElfHdr.emitWord16(ET_REL);             // e_type
 119   ElfHdr.emitWord16(TEW->getEMachine()); // e_machine = target
 120   ElfHdr.emitWord32(EV_CURRENT);         // e_version
 121   ElfHdr.emitWord(0);                    // e_entry, no entry point in .o file
 122   ElfHdr.emitWord(0);                    // e_phoff, no program header for .o
 123   ELFHdr_e_shoff_Offset = ElfHdr.size();
 124   ElfHdr.emitWord(0);                    // e_shoff = sec hdr table off in bytes
 125   ElfHdr.emitWord32(TEW->getEFlags());   // e_flags = whatever the target wants
 126   ElfHdr.emitWord16(TEW->getHdrSize());  // e_ehsize = ELF header size
 127   ElfHdr.emitWord16(0);                  // e_phentsize = prog header entry size
 128   ElfHdr.emitWord16(0);                  // e_phnum = # prog header entries = 0
 129
 130   // e_shentsize = Section header entry size
 131   ElfHdr.emitWord16(TEW->getSHdrSize());
 132
 133   // e_shnum     = # of section header ents
 134   ELFHdr_e_shnum_Offset = ElfHdr.size();
 135   ElfHdr.emitWord16(0); // Placeholder
 136
 137   // e_shstrndx  = Section # of '.shstrtab'
 138   ELFHdr_e_shstrndx_Offset = ElfHdr.size();
 139   ElfHdr.emitWord16(0); // Placeholder
 140
 141   // Add the null section, which is required to be first in the file.
 142   getNullSection();
 143
 144   return false;
 145 }
 146
 147 // addGlobalSymbol - Add a global to be processed and to the
 148 // global symbol lookup, use a zero index for non private symbols
 149 // because the table index will be determined later.
 150 void ELFWriter::addGlobalSymbol(const GlobalValue *GV) {
 151   PendingGlobals.insert(GV);
 152 }
 153
 154 // addExternalSymbol - Add the external to be processed and to the
 155 // external symbol lookup, use a zero index because the symbol
 156 // table index will be determined later
 157 void ELFWriter::addExternalSymbol(const char *External) {
 158   PendingExternals.insert(External);
 159   ExtSymLookup[External] = 0;
 160 }
 161
 162 // Get jump table section on the section name returned by TAI
 163 ELFSection &ELFWriter::getJumpTableSection() {
 164   unsigned Align = TM.getTargetData()->getPointerABIAlignment();
 165   return getSection(TAI->getJumpTableDataSection(),
 166                     ELFSection::SHT_PROGBITS,
 167                     ELFSection::SHF_ALLOC, Align);
 168 }
 169
 170 // Get a constant pool section based on the section name returned by TAI
 171 ELFSection &ELFWriter::getConstantPoolSection(MachineConstantPoolEntry &CPE) {
 172   SectionKind Kind;
 173   switch (CPE.getRelocationInfo()) {
 174   default: llvm_unreachable("Unknown section kind");
 175   case 2: Kind = SectionKind::get(SectionKind::ReadOnlyWithRel,false); break;
 176   case 1:
 177     Kind = SectionKind::get(SectionKind::ReadOnlyWithRelLocal,false);
 178     break;
 179   case 0:
 180     switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
 181     case 4:  Kind = SectionKind::get(SectionKind::MergeableConst4,false); break;
 182     case 8:  Kind = SectionKind::get(SectionKind::MergeableConst8,false); break;
 183     case 16: Kind = SectionKind::get(SectionKind::MergeableConst16,false);break;
 184     default: Kind = SectionKind::get(SectionKind::MergeableConst,false); break;
 185     }
 186   }
 187
 188   return getSection(TAI->getSectionForMergeableConstant(Kind)->getName(),
 189                     ELFSection::SHT_PROGBITS,
 190                     ELFSection::SHF_MERGE | ELFSection::SHF_ALLOC,
 191                     CPE.getAlignment());
 192 }
 193
 194 // Return the relocation section of section 'S'. 'RelA' is true
 195 // if the relocation section contains entries with addends.
 196 ELFSection &ELFWriter::getRelocSection(ELFSection &S) {
 197   unsigned SectionHeaderTy = TEW->hasRelocationAddend() ?
 198                               ELFSection::SHT_RELA : ELFSection::SHT_REL;
 199   std::string RelSName(".rel");
 200   if (TEW->hasRelocationAddend())
 201     RelSName.append("a");
 202   RelSName.append(S.getName());
 203
 204   return getSection(RelSName, SectionHeaderTy, 0, TEW->getPrefELFAlignment());
 205 }
 206
 207 // getGlobalELFVisibility - Returns the ELF specific visibility type
 208 unsigned ELFWriter::getGlobalELFVisibility(const GlobalValue *GV) {
 209   switch (GV->getVisibility()) {
 210   default:
 211     llvm_unreachable("unknown visibility type");
 212   case GlobalValue::DefaultVisibility:
 213     return ELFSym::STV_DEFAULT;
 214   case GlobalValue::HiddenVisibility:
 215     return ELFSym::STV_HIDDEN;
 216   case GlobalValue::ProtectedVisibility:
 217     return ELFSym::STV_PROTECTED;
 218   }
 219   return 0;
 220 }
 221
 222 // getGlobalELFBinding - Returns the ELF specific binding type
 223 unsigned ELFWriter::getGlobalELFBinding(const GlobalValue *GV) {
 224   if (GV->hasInternalLinkage())
 225     return ELFSym::STB_LOCAL;
 226
 227   if (GV->hasWeakLinkage())
 228     return ELFSym::STB_WEAK;
 229
 230   return ELFSym::STB_GLOBAL;
 231 }
 232
 233 // getGlobalELFType - Returns the ELF specific type for a global
 234 unsigned ELFWriter::getGlobalELFType(const GlobalValue *GV) {
 235   if (GV->isDeclaration())
 236     return ELFSym::STT_NOTYPE;
 237
 238   if (isa<Function>(GV))
 239     return ELFSym::STT_FUNC;
 240
 241   return ELFSym::STT_OBJECT;
 242 }
 243
 244 // getElfSectionFlags - Get the ELF Section Header flags based
 245 // on the flags defined in ELFTargetAsmInfo.
 246 unsigned ELFWriter::getElfSectionFlags(SectionKind Kind) {
 247   unsigned ElfSectionFlags = ELFSection::SHF_ALLOC;
 248
 249   if (Kind.isText())
 250     ElfSectionFlags |= ELFSection::SHF_EXECINSTR;
 251   if (Kind.isWriteable())
 252     ElfSectionFlags |= ELFSection::SHF_WRITE;
 253   if (Kind.isMergeableConst())
 254     ElfSectionFlags |= ELFSection::SHF_MERGE;
 255   if (Kind.isThreadLocal())
 256     ElfSectionFlags |= ELFSection::SHF_TLS;
 257   if (Kind.isMergeableCString())
 258     ElfSectionFlags |= ELFSection::SHF_STRINGS;
 259
 260   return ElfSectionFlags;
 261 }
 262
 263 // isELFUndefSym - the symbol has no section and must be placed in
 264 // the symbol table with a reference to the null section.
 265 static bool isELFUndefSym(const GlobalValue *GV) {
 266   return GV->isDeclaration();
 267 }
 268
 269 // isELFBssSym - for an undef or null value, the symbol must go to a bss
 270 // section if it's not weak for linker, otherwise it's a common sym.
 271 static bool isELFBssSym(const GlobalVariable *GV) {
 272   const Constant *CV = GV->getInitializer();
 273   return ((CV->isNullValue() || isa<UndefValue>(CV)) && !GV->isWeakForLinker());
 274 }
 275
 276 // isELFCommonSym - for an undef or null value, the symbol must go to a
 277 // common section if it's weak for linker, otherwise bss.
 278 static bool isELFCommonSym(const GlobalVariable *GV) {
 279   const Constant *CV = GV->getInitializer();
 280   return ((CV->isNullValue() || isa<UndefValue>(CV)) && GV->isWeakForLinker());
 281 }
 282
 283 // isELFDataSym - if the symbol is an initialized but no null constant
 284 // it must go to some kind of data section gathered from TAI
 285 static bool isELFDataSym(const Constant *CV) {
 286   return (!(CV->isNullValue() || isa<UndefValue>(CV)));
 287 }
 288
 289 // EmitGlobal - Choose the right section for global and emit it
 290 void ELFWriter::EmitGlobal(const GlobalValue *GV) {
 291
 292   // Check if the referenced symbol is already emitted
 293   if (GblSymLookup.find(GV) != GblSymLookup.end())
 294     return;
 295
 296   // If the global is a function already emited in the text section
 297   // just add it to the global symbol lookup with a zero index to be
 298   // patched up later.
 299   if (isa<Function>(GV) && !GV->isDeclaration()) {
 300     GblSymLookup[GV] = 0;
 301     return;
 302   }
 303
 304   // Handle ELF Bind, Visibility and Type for the current symbol
 305   unsigned SymBind = getGlobalELFBinding(GV);
 306   ELFSym *GblSym = ELFSym::getGV(GV, SymBind, getGlobalELFType(GV),
 307                                  getGlobalELFVisibility(GV));
 308
 309   if (isELFUndefSym(GV)) {
 310     GblSym->SectionIdx = ELFSection::SHN_UNDEF;
 311   } else {
 312     assert(isa<GlobalVariable>(GV) && "GV not a global variable!");
 313     const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV);
 314
 315     // Get ELF section from TAI
 316     const Section *S = TAI->SectionForGlobal(GV);
 317     unsigned SectionFlags = getElfSectionFlags(S->getKind());
 318
 319     // The symbol align should update the section alignment if needed
 320     const TargetData *TD = TM.getTargetData();
 321     unsigned Align = TD->getPreferredAlignment(GVar);
 322     unsigned Size = TD->getTypeAllocSize(GVar->getInitializer()->getType());
 323     GblSym->Size = Size;
 324
 325     if (isELFCommonSym(GVar)) {
 326       GblSym->SectionIdx = ELFSection::SHN_COMMON;
 327       getSection(S->getName(), ELFSection::SHT_NOBITS, SectionFlags, 1);
 328
 329       // A new linkonce section is created for each global in the
 330       // common section, the default alignment is 1 and the symbol
 331       // value contains its alignment.
 332       GblSym->Value = Align;
 333
 334     } else if (isELFBssSym(GVar)) {
 335       ELFSection &ES =
 336         getSection(S->getName(), ELFSection::SHT_NOBITS, SectionFlags);
 337       GblSym->SectionIdx = ES.SectionIdx;
 338
 339       // Update the size with alignment and the next object can
 340       // start in the right offset in the section
 341       if (Align) ES.Size = (ES.Size + Align-1) & ~(Align-1);
 342       ES.Align = std::max(ES.Align, Align);
 343
 344       // GblSym->Value should contain the virtual offset inside the section.
 345       // Virtual because the BSS space is not allocated on ELF objects
 346       GblSym->Value = ES.Size;
 347       ES.Size += Size;
 348
 349     } else if (isELFDataSym(GV)) {
 350       ELFSection &ES =
 351         getSection(S->getName(), ELFSection::SHT_PROGBITS, SectionFlags);
 352       GblSym->SectionIdx = ES.SectionIdx;
 353
 354       // GblSym->Value should contain the symbol offset inside the section,
 355       // and all symbols should start on their required alignment boundary
 356       ES.Align = std::max(ES.Align, Align);
 357       GblSym->Value = (ES.size() + (Align-1)) & (-Align);
 358       ES.emitAlignment(ES.Align);
 359
 360       // Emit the global to the data section 'ES'
 361       EmitGlobalConstant(GVar->getInitializer(), ES);
 362     }
 363   }
 364
 365   if (GV->hasPrivateLinkage()) {
 366     // For a private symbols, keep track of the index inside the
 367     // private list since it will never go to the symbol table and
 368     // won't be patched up later.
 369     PrivateSyms.push_back(GblSym);
 370     GblSymLookup[GV] = PrivateSyms.size()-1;
 371   } else {
 372     // Non private symbol are left with zero indices until they are patched
 373     // up during the symbol table emition (where the indicies are created).
 374     SymbolList.push_back(GblSym);
 375     GblSymLookup[GV] = 0;
 376   }
 377 }
 378
 379 void ELFWriter::EmitGlobalConstantStruct(const ConstantStruct *CVS,
 380                                          ELFSection &GblS) {
 381
 382   // Print the fields in successive locations. Pad to align if needed!
 383   const TargetData *TD = TM.getTargetData();
 384   unsigned Size = TD->getTypeAllocSize(CVS->getType());
 385   const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
 386   uint64_t sizeSoFar = 0;
 387   for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
 388     const Constant* field = CVS->getOperand(i);
 389
 390     // Check if padding is needed and insert one or more 0s.
 391     uint64_t fieldSize = TD->getTypeAllocSize(field->getType());
 392     uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
 393                         - cvsLayout->getElementOffset(i)) - fieldSize;
 394     sizeSoFar += fieldSize + padSize;
 395
 396     // Now print the actual field value.
 397     EmitGlobalConstant(field, GblS);
 398
 399     // Insert padding - this may include padding to increase the size of the
 400     // current field up to the ABI size (if the struct is not packed) as well
 401     // as padding to ensure that the next field starts at the right offset.
 402     for (unsigned p=0; p < padSize; p++)
 403       GblS.emitByte(0);
 404   }
 405   assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
 406          "Layout of constant struct may be incorrect!");
 407 }
 408
 409 void ELFWriter::EmitGlobalConstant(const Constant *CV, ELFSection &GblS) {
 410   const TargetData *TD = TM.getTargetData();
 411   unsigned Size = TD->getTypeAllocSize(CV->getType());
 412
 413   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
 414     if (CVA->isString()) {
 415       std::string GblStr = CVA->getAsString();
 416       GblStr.resize(GblStr.size()-1);
 417       GblS.emitString(GblStr);
 418     } else { // Not a string.  Print the values in successive locations
 419       for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
 420         EmitGlobalConstant(CVA->getOperand(i), GblS);
 421     }
 422     return;
 423   } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
 424     EmitGlobalConstantStruct(CVS, GblS);
 425     return;
 426   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 427     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
 428     if (CFP->getType() == Type::DoubleTy)
 429       GblS.emitWord64(Val);
 430     else if (CFP->getType() == Type::FloatTy)
 431       GblS.emitWord32(Val);
 432     else if (CFP->getType() == Type::X86_FP80Ty) {
 433       llvm_unreachable("X86_FP80Ty global emission not implemented");
 434     } else if (CFP->getType() == Type::PPC_FP128Ty)
 435       llvm_unreachable("PPC_FP128Ty global emission not implemented");
 436     return;
 437   } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
 438     if (Size == 4)
 439       GblS.emitWord32(CI->getZExtValue());
 440     else if (Size == 8)
 441       GblS.emitWord64(CI->getZExtValue());
 442     else
 443       llvm_unreachable("LargeInt global emission not implemented");
 444     return;
 445   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
 446     const VectorType *PTy = CP->getType();
 447     for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
 448       EmitGlobalConstant(CP->getOperand(I), GblS);
 449     return;
 450   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
 451     // This is a constant address for a global variable or function and
 452     // therefore must be referenced using a relocation entry.
 453
 454     // Check if the referenced symbol is already emitted
 455     if (GblSymLookup.find(GV) == GblSymLookup.end())
 456       EmitGlobal(GV);
 457
 458     // Create the relocation entry for the global value
 459     MachineRelocation MR =
 460       MachineRelocation::getGV(GblS.getCurrentPCOffset(),
 461                                TEW->getAbsoluteLabelMachineRelTy(),
 462                                const_cast<GlobalValue*>(GV));
 463
 464     // Fill the data entry with zeros
 465     for (unsigned i=0; i < Size; ++i)
 466       GblS.emitByte(0);
 467
 468     // Add the relocation entry for the current data section
 469     GblS.addRelocation(MR);
 470     return;
 471   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 472     if (CE->getOpcode() == Instruction::BitCast) {
 473       EmitGlobalConstant(CE->getOperand(0), GblS);
 474       return;
 475     }
 476     // See AsmPrinter::EmitConstantValueOnly for other ConstantExpr types
 477     llvm_unreachable("Unsupported ConstantExpr type");
 478   }
 479
 480   llvm_unreachable("Unknown global constant type");
 481 }
 482
 483
 484 bool ELFWriter::runOnMachineFunction(MachineFunction &MF) {
 485   // Nothing to do here, this is all done through the ElfCE object above.
 486   return false;
 487 }
 488
 489 /// doFinalization - Now that the module has been completely processed, emit
 490 /// the ELF file to 'O'.
 491 bool ELFWriter::doFinalization(Module &M) {
 492   // Emit .data section placeholder
 493   getDataSection();
 494
 495   // Emit .bss section placeholder
 496   getBSSSection();
 497
 498   // Build and emit data, bss and "common" sections.
 499   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 500        I != E; ++I)
 501     EmitGlobal(I);
 502
 503   // Emit all pending globals
 504   for (PendingGblsIter I = PendingGlobals.begin(), E = PendingGlobals.end();
 505        I != E; ++I)
 506     EmitGlobal(*I);
 507
 508   // Emit all pending externals
 509   for (PendingExtsIter I = PendingExternals.begin(), E = PendingExternals.end();
 510        I != E; ++I)
 511     SymbolList.push_back(ELFSym::getExtSym(*I));
 512
 513   // Emit non-executable stack note
 514   if (TAI->getNonexecutableStackDirective())
 515     getNonExecStackSection();
 516
 517   // Emit module name
 518   SymbolList.push_back(ELFSym::getFileSym());
 519
 520   // Emit a symbol for each section created until now, skip null section
 521   for (unsigned i = 1, e = SectionList.size(); i < e; ++i) {
 522     ELFSection &ES = *SectionList[i];
 523     ELFSym *SectionSym = ELFSym::getSectionSym();
 524     SectionSym->SectionIdx = ES.SectionIdx;
 525     SymbolList.push_back(SectionSym);
 526     ES.Sym = SymbolList.back();
 527   }
 528
 529   // Emit string table
 530   EmitStringTable(M.getModuleIdentifier());
 531
 532   // Emit the symbol table now, if non-empty.
 533   EmitSymbolTable();
 534
 535   // Emit the relocation sections.
 536   EmitRelocations();
 537
 538   // Emit the sections string table.
 539   EmitSectionTableStringTable();
 540
 541   // Dump the sections and section table to the .o file.
 542   OutputSectionsAndSectionTable();
 543
 544   // We are done with the abstract symbols.
 545   SymbolList.clear();
 546   SectionList.clear();
 547   NumSections = 0;
 548
 549   // Release the name mangler object.
 550   delete Mang; Mang = 0;
 551   return false;
 552 }
 553
 554 // RelocateField - Patch relocatable field with 'Offset' in 'BO'
 555 // using a 'Value' of known 'Size'
 556 void ELFWriter::RelocateField(BinaryObject &BO, uint32_t Offset,
 557                               int64_t Value, unsigned Size) {
 558   if (Size == 32)
 559     BO.fixWord32(Value, Offset);
 560   else if (Size == 64)
 561     BO.fixWord64(Value, Offset);
 562   else
 563     llvm_unreachable("don't know howto patch relocatable field");
 564 }
 565
 566 /// EmitRelocations - Emit relocations
 567 void ELFWriter::EmitRelocations() {
 568
 569   // True if the target uses the relocation entry to hold the addend,
 570   // otherwise the addend is written directly to the relocatable field.
 571   bool HasRelA = TEW->hasRelocationAddend();
 572
 573   // Create Relocation sections for each section which needs it.
 574   for (unsigned i=0, e=SectionList.size(); i != e; ++i) {
 575     ELFSection &S = *SectionList[i];
 576
 577     // This section does not have relocations
 578     if (!S.hasRelocations()) continue;
 579     ELFSection &RelSec = getRelocSection(S);
 580
 581     // 'Link' - Section hdr idx of the associated symbol table
 582     // 'Info' - Section hdr idx of the section to which the relocation applies
 583     ELFSection &SymTab = getSymbolTableSection();
 584     RelSec.Link = SymTab.SectionIdx;
 585     RelSec.Info = S.SectionIdx;
 586     RelSec.EntSize = TEW->getRelocationEntrySize();
 587
 588     // Get the relocations from Section
 589     std::vector<MachineRelocation> Relos = S.getRelocations();
 590     for (std::vector<MachineRelocation>::iterator MRI = Relos.begin(),
 591          MRE = Relos.end(); MRI != MRE; ++MRI) {
 592       MachineRelocation &MR = *MRI;
 593
 594       // Relocatable field offset from the section start
 595       unsigned RelOffset = MR.getMachineCodeOffset();
 596
 597       // Symbol index in the symbol table
 598       unsigned SymIdx = 0;
 599
 600       // Target specific relocation field type and size
 601       unsigned RelType = TEW->getRelocationType(MR.getRelocationType());
 602       unsigned RelTySize = TEW->getRelocationTySize(RelType);
 603       int64_t Addend = 0;
 604
 605       // There are several machine relocations types, and each one of
 606       // them needs a different approach to retrieve the symbol table index.
 607       if (MR.isGlobalValue()) {
 608         const GlobalValue *G = MR.getGlobalValue();
 609         SymIdx = GblSymLookup[G];
 610         if (G->hasPrivateLinkage()) {
 611           // If the target uses a section offset in the relocation:
 612           // SymIdx + Addend = section sym for global + section offset
 613           unsigned SectionIdx = PrivateSyms[SymIdx]->SectionIdx;
 614           Addend = PrivateSyms[SymIdx]->Value;
 615           SymIdx = SectionList[SectionIdx]->getSymbolTableIndex();
 616         } else {
 617           Addend = TEW->getDefaultAddendForRelTy(RelType);
 618         }
 619       } else if (MR.isExternalSymbol()) {
 620         const char *ExtSym = MR.getExternalSymbol();
 621         SymIdx = ExtSymLookup[ExtSym];
 622         Addend = TEW->getDefaultAddendForRelTy(RelType);
 623       } else {
 624         // Get the symbol index for the section symbol
 625         unsigned SectionIdx = MR.getConstantVal();
 626         SymIdx = SectionList[SectionIdx]->getSymbolTableIndex();
 627         Addend = (uint64_t)MR.getResultPointer();
 628
 629         // For pc relative relocations where symbols are defined in the same
 630         // section they are referenced, ignore the relocation entry and patch
 631         // the relocatable field with the symbol offset directly.
 632         if (S.SectionIdx == SectionIdx && TEW->isPCRelativeRel(RelType)) {
 633           int64_t Value = TEW->computeRelocation(Addend, RelOffset, RelType);
 634           RelocateField(S, RelOffset, Value, RelTySize);
 635           continue;
 636         }
 637
 638         // Handle Jump Table Index relocation
 639         if ((SectionIdx == getJumpTableSection().SectionIdx) &&
 640             TEW->hasCustomJumpTableIndexRelTy()) {
 641           RelType = TEW->getJumpTableIndexRelTy();
 642           RelTySize = TEW->getRelocationTySize(RelType);
 643         }
 644       }
 645
 646       // The target without addend on the relocation symbol must be
 647       // patched in the relocation place itself to contain the addend
 648       if (!HasRelA)
 649         RelocateField(S, RelOffset, Addend, RelTySize);
 650
 651       // Get the relocation entry and emit to the relocation section
 652       ELFRelocation Rel(RelOffset, SymIdx, RelType, HasRelA, Addend);
 653       EmitRelocation(RelSec, Rel, HasRelA);
 654     }
 655   }
 656 }
 657
 658 /// EmitRelocation - Write relocation 'Rel' to the relocation section 'Rel'
 659 void ELFWriter::EmitRelocation(BinaryObject &RelSec, ELFRelocation &Rel,
 660                                bool HasRelA) {
 661   RelSec.emitWord(Rel.getOffset());
 662   RelSec.emitWord(Rel.getInfo(is64Bit));
 663   if (HasRelA)
 664     RelSec.emitWord(Rel.getAddend());
 665 }
 666
 667 /// EmitSymbol - Write symbol 'Sym' to the symbol table 'SymbolTable'
 668 void ELFWriter::EmitSymbol(BinaryObject &SymbolTable, ELFSym &Sym) {
 669   if (is64Bit) {
 670     SymbolTable.emitWord32(Sym.NameIdx);
 671     SymbolTable.emitByte(Sym.Info);
 672     SymbolTable.emitByte(Sym.Other);
 673     SymbolTable.emitWord16(Sym.SectionIdx);
 674     SymbolTable.emitWord64(Sym.Value);
 675     SymbolTable.emitWord64(Sym.Size);
 676   } else {
 677     SymbolTable.emitWord32(Sym.NameIdx);
 678     SymbolTable.emitWord32(Sym.Value);
 679     SymbolTable.emitWord32(Sym.Size);
 680     SymbolTable.emitByte(Sym.Info);
 681     SymbolTable.emitByte(Sym.Other);
 682     SymbolTable.emitWord16(Sym.SectionIdx);
 683   }
 684 }
 685
 686 /// EmitSectionHeader - Write section 'Section' header in 'SHdrTab'
 687 /// Section Header Table
 688 void ELFWriter::EmitSectionHeader(BinaryObject &SHdrTab,
 689                                   const ELFSection &SHdr) {
 690   SHdrTab.emitWord32(SHdr.NameIdx);
 691   SHdrTab.emitWord32(SHdr.Type);
 692   if (is64Bit) {
 693     SHdrTab.emitWord64(SHdr.Flags);
 694     SHdrTab.emitWord(SHdr.Addr);
 695     SHdrTab.emitWord(SHdr.Offset);
 696     SHdrTab.emitWord64(SHdr.Size);
 697     SHdrTab.emitWord32(SHdr.Link);
 698     SHdrTab.emitWord32(SHdr.Info);
 699     SHdrTab.emitWord64(SHdr.Align);
 700     SHdrTab.emitWord64(SHdr.EntSize);
 701   } else {
 702     SHdrTab.emitWord32(SHdr.Flags);
 703     SHdrTab.emitWord(SHdr.Addr);
 704     SHdrTab.emitWord(SHdr.Offset);
 705     SHdrTab.emitWord32(SHdr.Size);
 706     SHdrTab.emitWord32(SHdr.Link);
 707     SHdrTab.emitWord32(SHdr.Info);
 708     SHdrTab.emitWord32(SHdr.Align);
 709     SHdrTab.emitWord32(SHdr.EntSize);
 710   }
 711 }
 712
 713 /// EmitStringTable - If the current symbol table is non-empty, emit the string
 714 /// table for it
 715 void ELFWriter::EmitStringTable(const std::string &ModuleName) {
 716   if (!SymbolList.size()) return;  // Empty symbol table.
 717   ELFSection &StrTab = getStringTableSection();
 718
 719   // Set the zero'th symbol to a null byte, as required.
 720   StrTab.emitByte(0);
 721
 722   // Walk on the symbol list and write symbol names into the string table.
 723   unsigned Index = 1;
 724   for (ELFSymIter I=SymbolList.begin(), E=SymbolList.end(); I != E; ++I) {
 725     ELFSym &Sym = *(*I);
 726
 727     std::string Name;
 728     if (Sym.isGlobalValue())
 729       // Use the name mangler to uniquify the LLVM symbol.
 730       Name.append(Mang->getMangledName(Sym.getGlobalValue()));
 731     else if (Sym.isExternalSym())
 732       Name.append(Sym.getExternalSymbol());
 733     else if (Sym.isFileType())
 734       Name.append(ModuleName);
 735
 736     if (Name.empty()) {
 737       Sym.NameIdx = 0;
 738     } else {
 739       Sym.NameIdx = Index;
 740       StrTab.emitString(Name);
 741
 742       // Keep track of the number of bytes emitted to this section.
 743       Index += Name.size()+1;
 744     }
 745   }
 746   assert(Index == StrTab.size());
 747   StrTab.Size = Index;
 748 }
 749
 750 // SortSymbols - On the symbol table local symbols must come before
 751 // all other symbols with non-local bindings. The return value is
 752 // the position of the first non local symbol.
 753 unsigned ELFWriter::SortSymbols() {
 754   unsigned FirstNonLocalSymbol;
 755   std::vector<ELFSym*> LocalSyms, OtherSyms;
 756
 757   for (ELFSymIter I=SymbolList.begin(), E=SymbolList.end(); I != E; ++I) {
 758     if ((*I)->isLocalBind())
 759       LocalSyms.push_back(*I);
 760     else
 761       OtherSyms.push_back(*I);
 762   }
 763   SymbolList.clear();
 764   FirstNonLocalSymbol = LocalSyms.size();
 765
 766   for (unsigned i = 0; i < FirstNonLocalSymbol; ++i)
 767     SymbolList.push_back(LocalSyms[i]);
 768
 769   for (ELFSymIter I=OtherSyms.begin(), E=OtherSyms.end(); I != E; ++I)
 770     SymbolList.push_back(*I);
 771
 772   LocalSyms.clear();
 773   OtherSyms.clear();
 774
 775   return FirstNonLocalSymbol;
 776 }
 777
 778 /// EmitSymbolTable - Emit the symbol table itself.
 779 void ELFWriter::EmitSymbolTable() {
 780   if (!SymbolList.size()) return;  // Empty symbol table.
 781
 782   // Now that we have emitted the string table and know the offset into the
 783   // string table of each symbol, emit the symbol table itself.
 784   ELFSection &SymTab = getSymbolTableSection();
 785   SymTab.Align = TEW->getPrefELFAlignment();
 786
 787   // Section Index of .strtab.
 788   SymTab.Link = getStringTableSection().SectionIdx;
 789
 790   // Size of each symtab entry.
 791   SymTab.EntSize = TEW->getSymTabEntrySize();
 792
 793   // The first entry in the symtab is the null symbol
 794   SymbolList.insert(SymbolList.begin(), new ELFSym());
 795
 796   // Reorder the symbol table with local symbols first!
 797   unsigned FirstNonLocalSymbol = SortSymbols();
 798
 799   // Emit all the symbols to the symbol table.
 800   for (unsigned i = 0, e = SymbolList.size(); i < e; ++i) {
 801     ELFSym &Sym = *SymbolList[i];
 802
 803     // Emit symbol to the symbol table
 804     EmitSymbol(SymTab, Sym);
 805
 806     // Record the symbol table index for each symbol
 807     if (Sym.isGlobalValue())
 808       GblSymLookup[Sym.getGlobalValue()] = i;
 809     else if (Sym.isExternalSym())
 810       ExtSymLookup[Sym.getExternalSymbol()] = i;
 811
 812     // Keep track on the symbol index into the symbol table
 813     Sym.SymTabIdx = i;
 814   }
 815
 816   // One greater than the symbol table index of the last local symbol
 817   SymTab.Info = FirstNonLocalSymbol;
 818   SymTab.Size = SymTab.size();
 819 }
 820
 821 /// EmitSectionTableStringTable - This method adds and emits a section for the
 822 /// ELF Section Table string table: the string table that holds all of the
 823 /// section names.
 824 void ELFWriter::EmitSectionTableStringTable() {
 825   // First step: add the section for the string table to the list of sections:
 826   ELFSection &SHStrTab = getSectionHeaderStringTableSection();
 827
 828   // Now that we know which section number is the .shstrtab section, update the
 829   // e_shstrndx entry in the ELF header.
 830   ElfHdr.fixWord16(SHStrTab.SectionIdx, ELFHdr_e_shstrndx_Offset);
 831
 832   // Set the NameIdx of each section in the string table and emit the bytes for
 833   // the string table.
 834   unsigned Index = 0;
 835
 836   for (ELFSectionIter I=SectionList.begin(), E=SectionList.end(); I != E; ++I) {
 837     ELFSection &S = *(*I);
 838     // Set the index into the table.  Note if we have lots of entries with
 839     // common suffixes, we could memoize them here if we cared.
 840     S.NameIdx = Index;
 841     SHStrTab.emitString(S.getName());
 842
 843     // Keep track of the number of bytes emitted to this section.
 844     Index += S.getName().size()+1;
 845   }
 846
 847   // Set the size of .shstrtab now that we know what it is.
 848   assert(Index == SHStrTab.size());
 849   SHStrTab.Size = Index;
 850 }
 851
 852 /// OutputSectionsAndSectionTable - Now that we have constructed the file header
 853 /// and all of the sections, emit these to the ostream destination and emit the
 854 /// SectionTable.
 855 void ELFWriter::OutputSectionsAndSectionTable() {
 856   // Pass #1: Compute the file offset for each section.
 857   size_t FileOff = ElfHdr.size();   // File header first.
 858
 859   // Adjust alignment of all section if needed, skip the null section.
 860   for (unsigned i=1, e=SectionList.size(); i < e; ++i) {
 861     ELFSection &ES = *SectionList[i];
 862     if (!ES.size()) {
 863       ES.Offset = FileOff;
 864       continue;
 865     }
 866
 867     // Update Section size
 868     if (!ES.Size)
 869       ES.Size = ES.size();
 870
 871     // Align FileOff to whatever the alignment restrictions of the section are.
 872     if (ES.Align)
 873       FileOff = (FileOff+ES.Align-1) & ~(ES.Align-1);
 874
 875     ES.Offset = FileOff;
 876     FileOff += ES.Size;
 877   }
 878
 879   // Align Section Header.
 880   unsigned TableAlign = TEW->getPrefELFAlignment();
 881   FileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 882
 883   // Now that we know where all of the sections will be emitted, set the e_shnum
 884   // entry in the ELF header.
 885   ElfHdr.fixWord16(NumSections, ELFHdr_e_shnum_Offset);
 886
 887   // Now that we know the offset in the file of the section table, update the
 888   // e_shoff address in the ELF header.
 889   ElfHdr.fixWord(FileOff, ELFHdr_e_shoff_Offset);
 890
 891   // Now that we know all of the data in the file header, emit it and all of the
 892   // sections!
 893   O.write((char *)&ElfHdr.getData()[0], ElfHdr.size());
 894   FileOff = ElfHdr.size();
 895
 896   // Section Header Table blob
 897   BinaryObject SHdrTable(isLittleEndian, is64Bit);
 898
 899   // Emit all of sections to the file and build the section header table.
 900   for (ELFSectionIter I=SectionList.begin(), E=SectionList.end(); I != E; ++I) {
 901     ELFSection &S = *(*I);
 902     DOUT << "SectionIdx: " << S.SectionIdx << ", Name: " << S.getName()
 903          << ", Size: " << S.Size << ", Offset: " << S.Offset
 904          << ", SectionData Size: " << S.size() << "\n";
 905
 906     // Align FileOff to whatever the alignment restrictions of the section are.
 907     if (S.size()) {
 908       if (S.Align)  {
 909         for (size_t NewFileOff = (FileOff+S.Align-1) & ~(S.Align-1);
 910              FileOff != NewFileOff; ++FileOff)
 911           O << (char)0xAB;
 912       }
 913       O.write((char *)&S.getData()[0], S.Size);
 914       FileOff += S.Size;
 915     }
 916
 917     EmitSectionHeader(SHdrTable, S);
 918   }
 919
 920   // Align output for the section table.
 921   for (size_t NewFileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 922        FileOff != NewFileOff; ++FileOff)
 923     O << (char)0xAB;
 924
 925   // Emit the section table itself.
 926   O.write((char *)&SHdrTable.getData()[0], SHdrTable.size());
 927 }