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