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