lib/CodeGen/ELFWriter.h

   1 //===-- ELFWriter.h - Target-independent ELF writer support -----*- C++ -*-===//
   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 defines the ELFWriter class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef ELFWRITER_H
  15 #define ELFWRITER_H
  16
  17 #include "llvm/ADT/SetVector.h"
  18 #include "llvm/CodeGen/MachineFunctionPass.h"
  19 #include <list>
  20 #include <map>
  21
  22 namespace llvm {
  23   class BinaryObject;
  24   class Constant;
  25   class ConstantStruct;
  26   class ELFCodeEmitter;
  27   class ELFRelocation;
  28   class ELFSection;
  29   class ELFSym;
  30   class GlobalVariable;
  31   class Mangler;
  32   class MachineCodeEmitter;
  33   class ObjectCodeEmitter;
  34   class TargetAsmInfo;
  35   class TargetELFWriterInfo;
  36   class raw_ostream;
  37
  38   /// ELFWriter - This class implements the common target-independent code for
  39   /// writing ELF files.  Targets should derive a class from this to
  40   /// parameterize the output format.
  41   ///
  42   class ELFWriter : public MachineFunctionPass {
  43     friend class ELFCodeEmitter;
  44   public:
  45     static char ID;
  46
  47     /// Return the ELFCodeEmitter as an instance of ObjectCodeEmitter
  48     ObjectCodeEmitter *getObjectCodeEmitter() {
  49       return reinterpret_cast<ObjectCodeEmitter*>(ElfCE);
  50     }
  51
  52     ELFWriter(raw_ostream &O, TargetMachine &TM);
  53     ~ELFWriter();
  54
  55   protected:
  56     /// Output stream to send the resultant object file to.
  57     raw_ostream &O;
  58
  59     /// Target machine description.
  60     TargetMachine &TM;
  61
  62     /// Target Elf Writer description.
  63     const TargetELFWriterInfo *TEW;
  64
  65     /// Mang - The object used to perform name mangling for this module.
  66     Mangler *Mang;
  67
  68     /// MCE - The MachineCodeEmitter object that we are exposing to emit machine
  69     /// code for functions to the .o file.
  70     ELFCodeEmitter *ElfCE;
  71
  72     /// TAI - Target Asm Info, provide information about section names for
  73     /// globals and other target specific stuff.
  74     const TargetAsmInfo *TAI;
  75
  76     //===------------------------------------------------------------------===//
  77     // Properties inferred automatically from the target machine.
  78     //===------------------------------------------------------------------===//
  79
  80     /// is64Bit/isLittleEndian - This information is inferred from the target
  81     /// machine directly, indicating whether to emit a 32- or 64-bit ELF file.
  82     bool is64Bit, isLittleEndian;
  83
  84     /// doInitialization - Emit the file header and all of the global variables
  85     /// for the module to the ELF file.
  86     bool doInitialization(Module &M);
  87     bool runOnMachineFunction(MachineFunction &MF);
  88
  89     /// doFinalization - Now that the module has been completely processed, emit
  90     /// the ELF file to 'O'.
  91     bool doFinalization(Module &M);
  92
  93   private:
  94     /// Blob containing the Elf header
  95     BinaryObject ElfHdr;
  96
  97     /// SectionList - This is the list of sections that we have emitted to the
  98     /// file.  Once the file has been completely built, the section header table
  99     /// is constructed from this info.
 100     std::list<ELFSection> SectionList;
 101     unsigned NumSections;   // Always = SectionList.size()
 102
 103     /// SectionLookup - This is a mapping from section name to section number in
 104     /// the SectionList.
 105     std::map<std::string, ELFSection*> SectionLookup;
 106
 107     /// GblSymLookup - This is a mapping from global value to a symbol index
 108     /// in the symbol table. This is useful since relocations symbol references
 109     /// must be quickly mapped to a symbol table index
 110     std::map<const GlobalValue*, uint32_t> GblSymLookup;
 111
 112     /// SymbolList - This is the list of symbols emitted to the symbol table
 113     /// Local symbols go to the front and Globals to the back.
 114     std::list<ELFSym> SymbolList;
 115
 116     /// PendingGlobals - List of externally defined symbols that we have been
 117     /// asked to emit, but have not seen a reference to.  When a reference
 118     /// is seen, the symbol will move from this list to the SymbolList.
 119     SetVector<GlobalValue*> PendingGlobals;
 120
 121     // Remove tab from section name prefix. This is necessary becase TAI
 122     // sometimes return a section name prefixed with a "\t" char. This is
 123     // a little bit dirty. FIXME: find a better approach, maybe add more
 124     // methods to TAI to get the clean name?
 125     void fixNameForSection(std::string &Name) {
 126       size_t Pos = Name.find("\t");
 127       if (Pos != std::string::npos)
 128         Name.erase(Pos, 1);
 129
 130       Pos = Name.find(".section ");
 131       if (Pos != std::string::npos)
 132         Name.erase(Pos, 9);
 133
 134       Pos = Name.find("\n");
 135       if (Pos != std::string::npos)
 136         Name.erase(Pos, 1);
 137     }
 138
 139     /// getSection - Return the section with the specified name, creating a new
 140     /// section if one does not already exist.
 141     ELFSection &getSection(const std::string &Name, unsigned Type,
 142                            unsigned Flags = 0, unsigned Align = 0) {
 143       std::string SectionName(Name);
 144       fixNameForSection(SectionName);
 145
 146       ELFSection *&SN = SectionLookup[SectionName];
 147       if (SN) return *SN;
 148
 149       SectionList.push_back(ELFSection(SectionName, isLittleEndian, is64Bit));
 150       SN = &SectionList.back();
 151       SN->SectionIdx = NumSections++;
 152       SN->Type = Type;
 153       SN->Flags = Flags;
 154       SN->Link = ELFSection::SHN_UNDEF;
 155       SN->Align = Align;
 156       return *SN;
 157     }
 158
 159     /// TODO: support mangled names here to emit the right .text section
 160     /// for c++ object files.
 161     ELFSection &getTextSection() {
 162       return getSection(".text", ELFSection::SHT_PROGBITS,
 163                         ELFSection::SHF_EXECINSTR | ELFSection::SHF_ALLOC);
 164     }
 165
 166     /// Get jump table section on the section name returned by TAI
 167     ELFSection &getJumpTableSection(std::string SName, unsigned Align) {
 168       return getSection(SName, ELFSection::SHT_PROGBITS,
 169                         ELFSection::SHF_ALLOC, Align);
 170     }
 171
 172     /// Get a constant pool section based on the section name returned by TAI
 173     ELFSection &getConstantPoolSection(std::string SName, unsigned Align) {
 174       return getSection(SName, ELFSection::SHT_PROGBITS,
 175                         ELFSection::SHF_MERGE | ELFSection::SHF_ALLOC, Align);
 176     }
 177
 178     /// Return the relocation section of section 'S'. 'RelA' is true
 179     /// if the relocation section contains entries with addends.
 180     ELFSection &getRelocSection(std::string SName, bool RelA, unsigned Align) {
 181       std::string RelSName(".rel");
 182       unsigned SHdrTy = RelA ? ELFSection::SHT_RELA : ELFSection::SHT_REL;
 183
 184       if (RelA) RelSName.append("a");
 185       RelSName.append(SName);
 186
 187       return getSection(RelSName, SHdrTy, 0, Align);
 188     }
 189
 190     ELFSection &getNonExecStackSection() {
 191       return getSection(".note.GNU-stack", ELFSection::SHT_PROGBITS, 0, 1);
 192     }
 193
 194     ELFSection &getSymbolTableSection() {
 195       return getSection(".symtab", ELFSection::SHT_SYMTAB, 0);
 196     }
 197
 198     ELFSection &getStringTableSection() {
 199       return getSection(".strtab", ELFSection::SHT_STRTAB, 0, 1);
 200     }
 201
 202     ELFSection &getSectionHeaderStringTableSection() {
 203       return getSection(".shstrtab", ELFSection::SHT_STRTAB, 0, 1);
 204     }
 205
 206     ELFSection &getDataSection() {
 207       return getSection(".data", ELFSection::SHT_PROGBITS,
 208                         ELFSection::SHF_WRITE | ELFSection::SHF_ALLOC, 4);
 209     }
 210
 211     ELFSection &getBSSSection() {
 212       return getSection(".bss", ELFSection::SHT_NOBITS,
 213                         ELFSection::SHF_WRITE | ELFSection::SHF_ALLOC, 4);
 214     }
 215
 216     ELFSection &getNullSection() {
 217       return getSection("", ELFSection::SHT_NULL, 0);
 218     }
 219
 220     // Helpers for obtaining ELF specific info.
 221     unsigned getGlobalELFLinkage(const GlobalValue *GV);
 222     unsigned getGlobalELFVisibility(const GlobalValue *GV);
 223     unsigned getElfSectionFlags(unsigned Flags);
 224
 225     // As we complete the ELF file, we need to update fields in the ELF header
 226     // (e.g. the location of the section table).  These members keep track of
 227     // the offset in ELFHeader of these various pieces to update and other
 228     // locations in the file.
 229     unsigned ELFHdr_e_shoff_Offset;     // e_shoff    in ELF header.
 230     unsigned ELFHdr_e_shstrndx_Offset;  // e_shstrndx in ELF header.
 231     unsigned ELFHdr_e_shnum_Offset;     // e_shnum    in ELF header.
 232
 233   private:
 234     void EmitFunctionDeclaration(const Function *F);
 235     void EmitGlobalVar(const GlobalVariable *GV);
 236     void EmitGlobalConstant(const Constant *C, ELFSection &GblS);
 237     void EmitGlobalConstantStruct(const ConstantStruct *CVS,
 238                                   ELFSection &GblS);
 239     ELFSection &getGlobalSymELFSection(const GlobalVariable *GV, ELFSym &Sym);
 240     void EmitRelocations();
 241     void EmitRelocation(BinaryObject &RelSec, ELFRelocation &Rel, bool HasRelA);
 242     void EmitSectionHeader(BinaryObject &SHdrTab, const ELFSection &SHdr);
 243     void EmitSectionTableStringTable();
 244     void EmitSymbol(BinaryObject &SymbolTable, ELFSym &Sym);
 245     void EmitSymbolTable();
 246     void EmitStringTable();
 247     void OutputSectionsAndSectionTable();
 248   };
 249 }
 250
 251 #endif