lib/CodeGen/ELFWriter.cpp

   1 //===-- ELFWriter.cpp - Target-independent ELF Writer code ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner and is distributed under the
   6 // University of Illinois Open Source 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 // NOTE: This code should eventually be extended to support 64-bit ELF (this
  30 // won't be hard), but we haven't done so yet!
  31 //
  32 //===----------------------------------------------------------------------===//
  33
  34 #include "llvm/CodeGen/ELFWriter.h"
  35 #include "llvm/Module.h"
  36 #include "llvm/CodeGen/MachineCodeEmitter.h"
  37 #include "llvm/CodeGen/MachineConstantPool.h"
  38 #include "llvm/Target/TargetMachine.h"
  39 #include "llvm/Support/Mangler.h"
  40 using namespace llvm;
  41
  42 //===----------------------------------------------------------------------===//
  43 //                       ELFCodeEmitter Implementation
  44 //===----------------------------------------------------------------------===//
  45
  46 namespace llvm {
  47   /// ELFCodeEmitter - This class is used by the ELFWriter to emit the code for
  48   /// functions to the ELF file.
  49   class ELFCodeEmitter : public MachineCodeEmitter {
  50     ELFWriter &EW;
  51     ELFWriter::ELFSection *ES;  // Section to write to.
  52     std::vector<unsigned char> *OutBuffer;
  53     size_t FnStart;
  54   public:
  55     ELFCodeEmitter(ELFWriter &ew) : EW(ew), OutBuffer(0) {}
  56
  57     void startFunction(MachineFunction &F);
  58     void finishFunction(MachineFunction &F);
  59
  60     void emitConstantPool(MachineConstantPool *MCP) {
  61       if (MCP->isEmpty()) return;
  62       assert(0 && "unimp");
  63     }
  64     virtual void emitByte(unsigned char B) {
  65       OutBuffer->push_back(B);
  66     }
  67     virtual void emitWordAt(unsigned W, unsigned *Ptr) {
  68       assert(0 && "ni");
  69     }
  70     virtual void emitWord(unsigned W) {
  71       assert(0 && "ni");
  72     }
  73     virtual uint64_t getCurrentPCValue() {
  74       return OutBuffer->size();
  75     }
  76     virtual uint64_t getCurrentPCOffset() {
  77       return OutBuffer->size()-FnStart;
  78     }
  79     void addRelocation(const MachineRelocation &MR) {
  80       assert(0 && "relo not handled yet!");
  81     }
  82     virtual uint64_t getConstantPoolEntryAddress(unsigned Index) {
  83       assert(0 && "CP not implementated yet!");
  84       return 0;
  85     }
  86
  87     virtual unsigned char* allocateGlobal(unsigned size, unsigned alignment) {
  88       assert(0 && "Globals not implemented yet!");
  89       return 0;
  90     }
  91
  92     /// JIT SPECIFIC FUNCTIONS - DO NOT IMPLEMENT THESE HERE!
  93     void startFunctionStub(unsigned StubSize) {
  94       assert(0 && "JIT specific function called!");
  95       abort();
  96     }
  97     void *finishFunctionStub(const Function *F) {
  98       assert(0 && "JIT specific function called!");
  99       abort();
 100       return 0;
 101     }
 102   };
 103 }
 104
 105 /// startFunction - This callback is invoked when a new machine function is
 106 /// about to be emitted.
 107 void ELFCodeEmitter::startFunction(MachineFunction &F) {
 108   // Align the output buffer to the appropriate alignment.
 109   unsigned Align = 16;   // FIXME: GENERICIZE!!
 110   // Get the ELF Section that this function belongs in.
 111   ES = &EW.getSection(".text", ELFWriter::ELFSection::SHT_PROGBITS,
 112                       ELFWriter::ELFSection::SHF_EXECINSTR |
 113                       ELFWriter::ELFSection::SHF_ALLOC);
 114   OutBuffer = &ES->SectionData;
 115
 116   // Upgrade the section alignment if required.
 117   if (ES->Align < Align) ES->Align = Align;
 118
 119   // Add padding zeros to the end of the buffer to make sure that the
 120   // function will start on the correct byte alignment within the section.
 121   size_t SectionOff = OutBuffer->size();
 122   ELFWriter::align(*OutBuffer, Align);
 123
 124   FnStart = OutBuffer->size();
 125 }
 126
 127 /// finishFunction - This callback is invoked after the function is completely
 128 /// finished.
 129 void ELFCodeEmitter::finishFunction(MachineFunction &F) {
 130   // We now know the size of the function, add a symbol to represent it.
 131   ELFWriter::ELFSym FnSym(F.getFunction());
 132
 133   // Figure out the binding (linkage) of the symbol.
 134   switch (F.getFunction()->getLinkage()) {
 135   default:
 136     // appending linkage is illegal for functions.
 137     assert(0 && "Unknown linkage type!");
 138   case GlobalValue::ExternalLinkage:
 139     FnSym.SetBind(ELFWriter::ELFSym::STB_GLOBAL);
 140     break;
 141   case GlobalValue::LinkOnceLinkage:
 142   case GlobalValue::WeakLinkage:
 143     FnSym.SetBind(ELFWriter::ELFSym::STB_WEAK);
 144     break;
 145   case GlobalValue::InternalLinkage:
 146     FnSym.SetBind(ELFWriter::ELFSym::STB_LOCAL);
 147     break;
 148   }
 149
 150   ES->Size = OutBuffer->size();
 151
 152   FnSym.SetType(ELFWriter::ELFSym::STT_FUNC);
 153   FnSym.SectionIdx = ES->SectionIdx;
 154     FnSym.Value = FnStart;   // Value = Offset from start of Section.
 155   FnSym.Size = OutBuffer->size()-FnStart;
 156
 157   // Finally, add it to the symtab.
 158   EW.SymbolTable.push_back(FnSym);
 159 }
 160
 161 //===----------------------------------------------------------------------===//
 162 //                          ELFWriter Implementation
 163 //===----------------------------------------------------------------------===//
 164
 165 ELFWriter::ELFWriter(std::ostream &o, TargetMachine &tm) : O(o), TM(tm) {
 166   e_machine = 0;  // e_machine defaults to 'No Machine'
 167   e_flags = 0;    // e_flags defaults to 0, no flags.
 168
 169   is64Bit = TM.getTargetData().getPointerSizeInBits() == 64;
 170   isLittleEndian = TM.getTargetData().isLittleEndian();
 171
 172   // Create the machine code emitter object for this target.
 173   MCE = new ELFCodeEmitter(*this);
 174   NumSections = 0;
 175 }
 176
 177 ELFWriter::~ELFWriter() {
 178   delete MCE;
 179 }
 180
 181 // doInitialization - Emit the file header and all of the global variables for
 182 // the module to the ELF file.
 183 bool ELFWriter::doInitialization(Module &M) {
 184   Mang = new Mangler(M);
 185
 186   // Local alias to shortenify coming code.
 187   std::vector<unsigned char> &FH = FileHeader;
 188
 189   outbyte(FH, 0x7F);                     // EI_MAG0
 190   outbyte(FH, 'E');                      // EI_MAG1
 191   outbyte(FH, 'L');                      // EI_MAG2
 192   outbyte(FH, 'F');                      // EI_MAG3
 193   outbyte(FH, is64Bit ? 2 : 1);          // EI_CLASS
 194   outbyte(FH, isLittleEndian ? 1 : 2);   // EI_DATA
 195   outbyte(FH, 1);                        // EI_VERSION
 196   FH.resize(16);                         // EI_PAD up to 16 bytes.
 197
 198   // This should change for shared objects.
 199   outhalf(FH, 1);                 // e_type = ET_REL
 200   outhalf(FH, e_machine);         // e_machine = whatever the target wants
 201   outword(FH, 1);                 // e_version = 1
 202   outaddr(FH, 0);                 // e_entry = 0 -> no entry point in .o file
 203   outaddr(FH, 0);                 // e_phoff = 0 -> no program header for .o
 204
 205   ELFHeader_e_shoff_Offset = FH.size();
 206   outaddr(FH, 0);                 // e_shoff
 207   outword(FH, e_flags);           // e_flags = whatever the target wants
 208
 209   outhalf(FH, is64Bit ? 64 : 52); // e_ehsize = ELF header size
 210   outhalf(FH, 0);                 // e_phentsize = prog header entry size
 211   outhalf(FH, 0);                 // e_phnum     = # prog header entries = 0
 212   outhalf(FH, is64Bit ? 64 : 40); // e_shentsize = sect hdr entry size
 213
 214
 215   ELFHeader_e_shnum_Offset = FH.size();
 216   outhalf(FH, 0);                 // e_shnum     = # of section header ents
 217   ELFHeader_e_shstrndx_Offset = FH.size();
 218   outhalf(FH, 0);                 // e_shstrndx  = Section # of '.shstrtab'
 219
 220   // Add the null section, which is required to be first in the file.
 221   getSection("", 0, 0);
 222
 223   // Start up the symbol table.  The first entry in the symtab is the null
 224   // entry.
 225   SymbolTable.push_back(ELFSym(0));
 226
 227   return false;
 228 }
 229
 230 void ELFWriter::EmitGlobal(GlobalVariable *GV) {
 231   // If this is an external global, emit it now.  TODO: Note that it would be
 232   // better to ignore the symbol here and only add it to the symbol table if
 233   // referenced.
 234   if (!GV->hasInitializer()) {
 235     ELFSym ExternalSym(GV);
 236     ExternalSym.SetBind(ELFSym::STB_GLOBAL);
 237     ExternalSym.SetType(ELFSym::STT_NOTYPE);
 238     ExternalSym.SectionIdx = ELFSection::SHN_UNDEF;
 239     SymbolTable.push_back(ExternalSym);
 240     return;
 241   }
 242
 243   const Type *GVType = (const Type*)GV->getType();
 244   unsigned Align = TM.getTargetData().getTypeAlignment(GVType);
 245   unsigned Size  = TM.getTargetData().getTypeSize(GVType);
 246
 247   // If this global has a zero initializer, it is part of the .bss or common
 248   // section.
 249   if (GV->getInitializer()->isNullValue()) {
 250     // If this global is part of the common block, add it now.  Variables are
 251     // part of the common block if they are zero initialized and allowed to be
 252     // merged with other symbols.
 253     if (GV->hasLinkOnceLinkage() || GV->hasWeakLinkage()) {
 254       ELFSym CommonSym(GV);
 255       // Value for common symbols is the alignment required.
 256       CommonSym.Value = Align;
 257       CommonSym.Size  = Size;
 258       CommonSym.SetBind(ELFSym::STB_GLOBAL);
 259       CommonSym.SetType(ELFSym::STT_OBJECT);
 260       // TODO SOMEDAY: add ELF visibility.
 261       CommonSym.SectionIdx = ELFSection::SHN_COMMON;
 262       SymbolTable.push_back(CommonSym);
 263       return;
 264     }
 265
 266     // Otherwise, this symbol is part of the .bss section.  Emit it now.
 267
 268     // Handle alignment.  Ensure section is aligned at least as much as required
 269     // by this symbol.
 270     ELFSection &BSSSection = getBSSSection();
 271     BSSSection.Align = std::max(BSSSection.Align, Align);
 272
 273     // Within the section, emit enough virtual padding to get us to an alignment
 274     // boundary.
 275     if (Align)
 276       BSSSection.Size = (BSSSection.Size + Align - 1) & ~(Align-1);
 277
 278     ELFSym BSSSym(GV);
 279     BSSSym.Value = BSSSection.Size;
 280     BSSSym.Size = Size;
 281     BSSSym.SetType(ELFSym::STT_OBJECT);
 282
 283     switch (GV->getLinkage()) {
 284     default:  // weak/linkonce handled above
 285       assert(0 && "Unexpected linkage type!");
 286     case GlobalValue::AppendingLinkage:  // FIXME: This should be improved!
 287     case GlobalValue::ExternalLinkage:
 288       BSSSym.SetBind(ELFSym::STB_GLOBAL);
 289       break;
 290     case GlobalValue::InternalLinkage:
 291       BSSSym.SetBind(ELFSym::STB_LOCAL);
 292       break;
 293     }
 294
 295     // Set the idx of the .bss section
 296     BSSSym.SectionIdx = BSSSection.SectionIdx;
 297     SymbolTable.push_back(BSSSym);
 298
 299     // Reserve space in the .bss section for this symbol.
 300     BSSSection.Size += Size;
 301     return;
 302   }
 303
 304   // FIXME: handle .rodata
 305   //assert(!GV->isConstant() && "unimp");
 306
 307   // FIXME: handle .data
 308   //assert(0 && "unimp");
 309 }
 310
 311
 312 bool ELFWriter::runOnMachineFunction(MachineFunction &MF) {
 313   // Nothing to do here, this is all done through the MCE object above.
 314   return false;
 315 }
 316
 317 /// doFinalization - Now that the module has been completely processed, emit
 318 /// the ELF file to 'O'.
 319 bool ELFWriter::doFinalization(Module &M) {
 320   // Okay, the ELF header and .text sections have been completed, build the
 321   // .data, .bss, and "common" sections next.
 322   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
 323        I != E; ++I)
 324     EmitGlobal(I);
 325
 326   // Emit the symbol table now, if non-empty.
 327   EmitSymbolTable();
 328
 329   // FIXME: Emit the relocations now.
 330
 331   // Emit the string table for the sections in the ELF file we have.
 332   EmitSectionTableStringTable();
 333
 334   // Emit the sections to the .o file, and emit the section table for the file.
 335   OutputSectionsAndSectionTable();
 336
 337   // We are done with the abstract symbols.
 338   SectionList.clear();
 339   NumSections = 0;
 340
 341   // Release the name mangler object.
 342   delete Mang; Mang = 0;
 343   return false;
 344 }
 345
 346 /// EmitSymbolTable - If the current symbol table is non-empty, emit the string
 347 /// table for it and then the symbol table itself.
 348 void ELFWriter::EmitSymbolTable() {
 349   if (SymbolTable.size() == 1) return;  // Only the null entry.
 350
 351   // FIXME: compact all local symbols to the start of the symtab.
 352   unsigned FirstNonLocalSymbol = 1;
 353
 354   ELFSection &StrTab = getSection(".strtab", ELFSection::SHT_STRTAB, 0);
 355   StrTab.Align = 1;
 356
 357   DataBuffer &StrTabBuf = StrTab.SectionData;
 358
 359   // Set the zero'th symbol to a null byte, as required.
 360   outbyte(StrTabBuf, 0);
 361   SymbolTable[0].NameIdx = 0;
 362   unsigned Index = 1;
 363   for (unsigned i = 1, e = SymbolTable.size(); i != e; ++i) {
 364     // Use the name mangler to uniquify the LLVM symbol.
 365     std::string Name = Mang->getValueName(SymbolTable[i].GV);
 366
 367     if (Name.empty()) {
 368       SymbolTable[i].NameIdx = 0;
 369     } else {
 370       SymbolTable[i].NameIdx = Index;
 371
 372       // Add the name to the output buffer, including the null terminator.
 373       StrTabBuf.insert(StrTabBuf.end(), Name.begin(), Name.end());
 374
 375       // Add a null terminator.
 376       StrTabBuf.push_back(0);
 377
 378       // Keep track of the number of bytes emitted to this section.
 379       Index += Name.size()+1;
 380     }
 381   }
 382   assert(Index == StrTabBuf.size());
 383   StrTab.Size = Index;
 384
 385   // Now that we have emitted the string table and know the offset into the
 386   // string table of each symbol, emit the symbol table itself.
 387   ELFSection &SymTab = getSection(".symtab", ELFSection::SHT_SYMTAB, 0);
 388   SymTab.Align = is64Bit ? 8 : 4;
 389   SymTab.Link = SymTab.SectionIdx;     // Section Index of .strtab.
 390   SymTab.Info = FirstNonLocalSymbol;   // First non-STB_LOCAL symbol.
 391   SymTab.EntSize = 16; // Size of each symtab entry. FIXME: wrong for ELF64
 392   DataBuffer &SymTabBuf = SymTab.SectionData;
 393
 394   if (!is64Bit) {   // 32-bit and 64-bit formats are shuffled a bit.
 395     for (unsigned i = 0, e = SymbolTable.size(); i != e; ++i) {
 396       ELFSym &Sym = SymbolTable[i];
 397       outword(SymTabBuf, Sym.NameIdx);
 398       outaddr32(SymTabBuf, Sym.Value);
 399       outword(SymTabBuf, Sym.Size);
 400       outbyte(SymTabBuf, Sym.Info);
 401       outbyte(SymTabBuf, Sym.Other);
 402       outhalf(SymTabBuf, Sym.SectionIdx);
 403     }
 404   } else {
 405     for (unsigned i = 0, e = SymbolTable.size(); i != e; ++i) {
 406       ELFSym &Sym = SymbolTable[i];
 407       outword(SymTabBuf, Sym.NameIdx);
 408       outbyte(SymTabBuf, Sym.Info);
 409       outbyte(SymTabBuf, Sym.Other);
 410       outhalf(SymTabBuf, Sym.SectionIdx);
 411       outaddr64(SymTabBuf, Sym.Value);
 412       outxword(SymTabBuf, Sym.Size);
 413     }
 414   }
 415
 416   SymTab.Size = SymTabBuf.size();
 417 }
 418
 419 /// EmitSectionTableStringTable - This method adds and emits a section for the
 420 /// ELF Section Table string table: the string table that holds all of the
 421 /// section names.
 422 void ELFWriter::EmitSectionTableStringTable() {
 423   // First step: add the section for the string table to the list of sections:
 424   ELFSection &SHStrTab = getSection(".shstrtab", ELFSection::SHT_STRTAB, 0);
 425
 426   // Now that we know which section number is the .shstrtab section, update the
 427   // e_shstrndx entry in the ELF header.
 428   fixhalf(FileHeader, SHStrTab.SectionIdx, ELFHeader_e_shstrndx_Offset);
 429
 430   // Set the NameIdx of each section in the string table and emit the bytes for
 431   // the string table.
 432   unsigned Index = 0;
 433   DataBuffer &Buf = SHStrTab.SectionData;
 434
 435   for (std::list<ELFSection>::iterator I = SectionList.begin(),
 436          E = SectionList.end(); I != E; ++I) {
 437     // Set the index into the table.  Note if we have lots of entries with
 438     // common suffixes, we could memoize them here if we cared.
 439     I->NameIdx = Index;
 440
 441     // Add the name to the output buffer, including the null terminator.
 442     Buf.insert(Buf.end(), I->Name.begin(), I->Name.end());
 443
 444     // Add a null terminator.
 445     Buf.push_back(0);
 446
 447     // Keep track of the number of bytes emitted to this section.
 448     Index += I->Name.size()+1;
 449   }
 450
 451   // Set the size of .shstrtab now that we know what it is.
 452   assert(Index == Buf.size());
 453   SHStrTab.Size = Index;
 454 }
 455
 456 /// OutputSectionsAndSectionTable - Now that we have constructed the file header
 457 /// and all of the sections, emit these to the ostream destination and emit the
 458 /// SectionTable.
 459 void ELFWriter::OutputSectionsAndSectionTable() {
 460   // Pass #1: Compute the file offset for each section.
 461   size_t FileOff = FileHeader.size();   // File header first.
 462
 463   // Emit all of the section data in order.
 464   for (std::list<ELFSection>::iterator I = SectionList.begin(),
 465          E = SectionList.end(); I != E; ++I) {
 466     // Align FileOff to whatever the alignment restrictions of the section are.
 467     if (I->Align)
 468       FileOff = (FileOff+I->Align-1) & ~(I->Align-1);
 469     I->Offset = FileOff;
 470     FileOff += I->SectionData.size();
 471   }
 472
 473   // Align Section Header.
 474   unsigned TableAlign = is64Bit ? 8 : 4;
 475   FileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 476
 477   // Now that we know where all of the sections will be emitted, set the e_shnum
 478   // entry in the ELF header.
 479   fixhalf(FileHeader, NumSections, ELFHeader_e_shnum_Offset);
 480
 481   // Now that we know the offset in the file of the section table, update the
 482   // e_shoff address in the ELF header.
 483   fixaddr(FileHeader, FileOff, ELFHeader_e_shoff_Offset);
 484
 485   // Now that we know all of the data in the file header, emit it and all of the
 486   // sections!
 487   O.write((char*)&FileHeader[0], FileHeader.size());
 488   FileOff = FileHeader.size();
 489   DataBuffer().swap(FileHeader);
 490
 491   DataBuffer Table;
 492
 493   // Emit all of the section data and build the section table itself.
 494   while (!SectionList.empty()) {
 495     const ELFSection &S = *SectionList.begin();
 496
 497     // Align FileOff to whatever the alignment restrictions of the section are.
 498     if (S.Align)
 499       for (size_t NewFileOff = (FileOff+S.Align-1) & ~(S.Align-1);
 500            FileOff != NewFileOff; ++FileOff)
 501         O.put((char)0xAB);
 502     O.write((char*)&S.SectionData[0], S.SectionData.size());
 503     FileOff += S.SectionData.size();
 504
 505     outword(Table, S.NameIdx);  // sh_name - Symbol table name idx
 506     outword(Table, S.Type);     // sh_type - Section contents & semantics
 507     outword(Table, S.Flags);    // sh_flags - Section flags.
 508     outaddr(Table, S.Addr);     // sh_addr - The mem addr this section is in.
 509     outaddr(Table, S.Offset);   // sh_offset - Offset from the file start.
 510     outword(Table, S.Size);     // sh_size - The section size.
 511     outword(Table, S.Link);     // sh_link - Section header table index link.
 512     outword(Table, S.Info);     // sh_info - Auxillary information.
 513     outword(Table, S.Align);    // sh_addralign - Alignment of section.
 514     outword(Table, S.EntSize);  // sh_entsize - Size of entries in the section.
 515
 516     SectionList.pop_front();
 517   }
 518
 519   // Align output for the section table.
 520   for (size_t NewFileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
 521        FileOff != NewFileOff; ++FileOff)
 522     O.put((char)0xAB);
 523
 524   // Emit the section table itself.
 525   O.write((char*)&Table[0], Table.size());
 526 }