include/llvm/CodeGen/ELFWriter.h

//===-- ELFWriter.h - Target-independent ELF writer support -----*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file defines the ELFWriter class.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CODEGEN_ELFWRITER_H
#define LLVM_CODEGEN_ELFWRITER_H

#include "llvm/CodeGen/MachineFunctionPass.h"

namespace llvm {
  class GlobalVariable;

  /// ELFWriter - This class implements the common target-independent code for
  /// writing ELF files.  Targets should derive a class from this to
  /// parameterize the output format.
  ///
  class ELFWriter : public MachineFunctionPass {
  protected:
    ELFWriter(std::ostream &O, TargetMachine &TM);

    /// Output stream to send the resultant object file to.
    ///
    std::ostream &O;

    /// Target machine description.
    ///
    TargetMachine &TM;

    //===------------------------------------------------------------------===//
    // Properties to be set by the derived class ctor, used to configure the
    // ELFWriter.

    // e_machine - This field is the target specific value to emit as the
    // e_machine member of the ELF header.
    unsigned short e_machine;

    // e_flags - The machine flags for the target.  This defaults to zero.
    unsigned e_flags;

    //===------------------------------------------------------------------===//
    // Properties inferred automatically from the target machine.
    //

    /// is64Bit/isLittleEndian - This information is inferred from the target
    /// machine directly, indicating whether to emit a 32- or 64-bit ELF file.
    bool is64Bit, isLittleEndian;

    /// doInitialization - Emit the file header and all of the global variables
    /// for the module to the ELF file.
    bool doInitialization(Module &M);

    bool runOnMachineFunction(MachineFunction &MF);


    /// doFinalization - Now that the module has been completely processed, emit
    /// the ELF file to 'O'.
    bool doFinalization(Module &M);

  private:
    // The buffer we are accumulating the file into.  Note that this should be
    // changed into something much more efficient later (and the bytecode writer
    // as well!).
    std::vector<unsigned char> OutputBuffer;

    /// ELFSection - This struct contains information about each section that is
    /// emitted to the OutputBuffer.  This is eventually turned into the section
    /// header table at the end of the file.
    struct ELFSection {
      std::string Name;       // Name of the section.
      unsigned NameIdx;       // Index in .shstrtab of name, once emitted.
      unsigned Type;
      unsigned Flags;
      uint64_t Addr;
      unsigned Offset;
      unsigned Size;
      unsigned Link;
      unsigned Info;
      unsigned Align;
      unsigned EntSize;

      enum { SHT_NULL = 0, SHT_PROGBITS = 1, SHT_SYMTAB = 2, SHT_STRTAB = 3,
             SHT_RELA = 4, SHT_HASH = 5, SHT_DYNAMIC = 6, SHT_NOTE = 7,
             SHT_NOBITS = 8, SHT_REL = 9, SHT_SHLIB = 10, SHT_DYNSYM = 11 };
      enum { SHN_UNDEF = 0, SHN_ABS = 0xFFF1, SHN_COMMON = 0xFFF2 };
      enum { SHF_WRITE = 1, SHF_ALLOC = 2, SHF_EXECINSTR = 4 };

      ELFSection(const char *name = "", unsigned offset = 0)
        : Name(name), Type(0), Flags(0), Addr(0), Offset(offset), Size(0),
          Link(0), Info(0), Align(0), EntSize(0) {
      }
    };

    /// SectionList - This is the list of sections that we have emitted to the
    /// file.  Once the file has been completely built, the section header table
    /// is constructed from this info.
    std::vector<ELFSection> SectionList;

    /// ELFSym - This struct contains information about each symbol that is
    /// added to logical symbol table for the module.  This is eventually
    /// turned into a real symbol table in the file.
    struct ELFSym {
      GlobalValue *GV;        // The global value this corresponds to.
      //std::string Name;       // Name of the symbol.
      unsigned NameIdx;       // Index in .strtab of name, once emitted.
      uint64_t Value;
      unsigned Size;
      unsigned char Info;
      unsigned char Other;
      unsigned short SectionIdx;

      enum { STB_LOCAL = 0, STB_GLOBAL = 1, STB_WEAK = 2 };
      enum { STT_NOTYPE = 0, STT_OBJECT = 1, STT_FUNC = 2, STT_SECTION = 3,
             STT_FILE = 4 };
      ELFSym(GlobalValue *gv) : GV(gv), Value(0), Size(0), Info(0),
                                Other(0), SectionIdx(0) {}

      void SetBind(unsigned X) {
        assert(X == (X & 0xF) && "Bind value out of range!");
        Info = (Info & 0x0F) | (X << 4);
      }
      void SetType(unsigned X) {
        assert(X == (X & 0xF) && "Type value out of range!");
        Info = (Info & 0xF0) | X;
      }
    };

    /// SymbolTable - This is the list of symbols we have emitted to the file.
    /// This actually gets rearranged before emission to OutputBuffer (to put
    /// the local symbols first in the list).
    std::vector<ELFSym> SymbolTable;


    // As we accumulate the ELF file into OutputBuffer, we occasionally need to
    // keep track of locations to update later (e.g. the location of the section
    // table in the ELF header.  These members keep track of the offset in
    // OffsetBuffer of these various pieces to update and other locations in the
    // file.
    unsigned ELFHeader_e_shoff_Offset;     // e_shoff    in ELF header.
    unsigned ELFHeader_e_shstrndx_Offset;  // e_shstrndx in ELF header.
    unsigned ELFHeader_e_shnum_Offset;     // e_shnum    in ELF header.

    // align - Emit padding into the file until the current output position is
    // aligned to the specified power of two boundary.
    void align(unsigned Boundary) {
      assert(Boundary && (Boundary & (Boundary-1)) == 0 &&
             "Must align to 2^k boundary");
      while (OutputBuffer.size() & (Boundary-1))
        outbyte(0xAB);
    }

    void outbyte(unsigned char X) { OutputBuffer.push_back(X); }
    void outhalf(unsigned short X) {
      if (isLittleEndian) {
        OutputBuffer.push_back(X&255);
        OutputBuffer.push_back(X >> 8);
      } else {
        OutputBuffer.push_back(X >> 8);
        OutputBuffer.push_back(X&255);
      }
    }
    void outword(unsigned X) {
      if (isLittleEndian) {
        OutputBuffer.push_back((X >>  0) & 255);
        OutputBuffer.push_back((X >>  8) & 255);
        OutputBuffer.push_back((X >> 16) & 255);
        OutputBuffer.push_back((X >> 24) & 255);
      } else {
        OutputBuffer.push_back((X >> 24) & 255);
        OutputBuffer.push_back((X >> 16) & 255);
        OutputBuffer.push_back((X >>  8) & 255);
        OutputBuffer.push_back((X >>  0) & 255);
      }
    }
    void outaddr(uint64_t X) {
      if (!is64Bit)
        outword((unsigned)X);
      else
        assert(0 && "Emission of 64-bit data not implemented yet!");
    }

    // fix functions - Replace an existing entry at an offset.
    void fixhalf(unsigned short X, unsigned Offset) {
      unsigned char *P = &OutputBuffer[Offset];
      P[0] = (X >> (isLittleEndian ?  0 : 8)) & 255;
      P[1] = (X >> (isLittleEndian ?  8 : 0)) & 255;
    }

    void fixword(unsigned X, unsigned Offset) {
      unsigned char *P = &OutputBuffer[Offset];
      P[0] = (X >> (isLittleEndian ?  0 : 24)) & 255;
      P[1] = (X >> (isLittleEndian ?  8 : 16)) & 255;
      P[2] = (X >> (isLittleEndian ? 16 :  8)) & 255;
      P[3] = (X >> (isLittleEndian ? 24 :  0)) & 255;
    }

    void fixaddr(uint64_t X, unsigned Offset) {
      if (!is64Bit)
        fixword((unsigned)X, Offset);
      else
        assert(0 && "Emission of 64-bit data not implemented yet!");
    }

  private:
    void EmitGlobal(GlobalVariable *GV, ELFSection &DataSection,
                    ELFSection &BSSSection);

    void EmitSymbolTable();

    void EmitSectionTableStringTable();
    void EmitSectionTable();
  };
}

#endif