include/llvm/MC/MCObjectWriter.h

   1 //===-- llvm/MC/MCObjectWriter.h - Object File Writer Interface -*- 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 #ifndef LLVM_MC_MCOBJECTWRITER_H
  11 #define LLVM_MC_MCOBJECTWRITER_H
  12
  13 #include "llvm/ADT/SmallVector.h"
  14 #include "llvm/Support/Compiler.h"
  15 #include "llvm/Support/DataTypes.h"
  16 #include "llvm/Support/raw_ostream.h"
  17 #include <cassert>
  18
  19 namespace llvm {
  20 class MCAsmLayout;
  21 class MCAssembler;
  22 class MCFixup;
  23 class MCFragment;
  24 class MCSymbolData;
  25 class MCSymbolRefExpr;
  26 class MCValue;
  27
  28 /// MCObjectWriter - Defines the object file and target independent interfaces
  29 /// used by the assembler backend to write native file format object files.
  30 ///
  31 /// The object writer contains a few callbacks used by the assembler to allow
  32 /// the object writer to modify the assembler data structures at appropriate
  33 /// points. Once assembly is complete, the object writer is given the
  34 /// MCAssembler instance, which contains all the symbol and section data which
  35 /// should be emitted as part of WriteObject().
  36 ///
  37 /// The object writer also contains a number of helper methods for writing
  38 /// binary data to the output stream.
  39 class MCObjectWriter {
  40   MCObjectWriter(const MCObjectWriter &) = delete;
  41   void operator=(const MCObjectWriter &) = delete;
  42
  43 protected:
  44   raw_ostream &OS;
  45
  46   unsigned IsLittleEndian : 1;
  47
  48 protected: // Can only create subclasses.
  49   MCObjectWriter(raw_ostream &_OS, bool _IsLittleEndian)
  50     : OS(_OS), IsLittleEndian(_IsLittleEndian) {}
  51
  52 public:
  53   virtual ~MCObjectWriter();
  54
  55   /// lifetime management
  56   virtual void reset() { }
  57
  58   bool isLittleEndian() const { return IsLittleEndian; }
  59
  60   raw_ostream &getStream() { return OS; }
  61
  62   /// @name High-Level API
  63   /// @{
  64
  65   /// \brief Perform any late binding of symbols (for example, to assign symbol
  66   /// indices for use when generating relocations).
  67   ///
  68   /// This routine is called by the assembler after layout and relaxation is
  69   /// complete.
  70   virtual void ExecutePostLayoutBinding(MCAssembler &Asm,
  71                                         const MCAsmLayout &Layout) = 0;
  72
  73   /// \brief Record a relocation entry.
  74   ///
  75   /// This routine is called by the assembler after layout and relaxation, and
  76   /// post layout binding. The implementation is responsible for storing
  77   /// information about the relocation so that it can be emitted during
  78   /// WriteObject().
  79   virtual void RecordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
  80                                 const MCFragment *Fragment,
  81                                 const MCFixup &Fixup, MCValue Target,
  82                                 bool &IsPCRel, uint64_t &FixedValue) = 0;
  83
  84   /// \brief Check whether the difference (A - B) between two symbol
  85   /// references is fully resolved.
  86   ///
  87   /// Clients are not required to answer precisely and may conservatively return
  88   /// false, even when a difference is fully resolved.
  89   bool
  90   IsSymbolRefDifferenceFullyResolved(const MCAssembler &Asm,
  91                                      const MCSymbolRefExpr *A,
  92                                      const MCSymbolRefExpr *B,
  93                                      bool InSet) const;
  94
  95   virtual bool
  96   IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
  97                                          const MCSymbolData &DataA,
  98                                          const MCFragment &FB,
  99                                          bool InSet,
 100                                          bool IsPCRel) const;
 101
 102   /// \brief Write the object file.
 103   ///
 104   /// This routine is called by the assembler after layout and relaxation is
 105   /// complete, fixups have been evaluated and applied, and relocations
 106   /// generated.
 107   virtual void WriteObject(MCAssembler &Asm,
 108                            const MCAsmLayout &Layout) = 0;
 109
 110   /// @}
 111   /// @name Binary Output
 112   /// @{
 113
 114   void Write8(uint8_t Value) {
 115     OS << char(Value);
 116   }
 117
 118   void WriteLE16(uint16_t Value) {
 119     Write8(uint8_t(Value >> 0));
 120     Write8(uint8_t(Value >> 8));
 121   }
 122
 123   void WriteLE32(uint32_t Value) {
 124     WriteLE16(uint16_t(Value >> 0));
 125     WriteLE16(uint16_t(Value >> 16));
 126   }
 127
 128   void WriteLE64(uint64_t Value) {
 129     WriteLE32(uint32_t(Value >> 0));
 130     WriteLE32(uint32_t(Value >> 32));
 131   }
 132
 133   void WriteBE16(uint16_t Value) {
 134     Write8(uint8_t(Value >> 8));
 135     Write8(uint8_t(Value >> 0));
 136   }
 137
 138   void WriteBE32(uint32_t Value) {
 139     WriteBE16(uint16_t(Value >> 16));
 140     WriteBE16(uint16_t(Value >> 0));
 141   }
 142
 143   void WriteBE64(uint64_t Value) {
 144     WriteBE32(uint32_t(Value >> 32));
 145     WriteBE32(uint32_t(Value >> 0));
 146   }
 147
 148   void Write16(uint16_t Value) {
 149     if (IsLittleEndian)
 150       WriteLE16(Value);
 151     else
 152       WriteBE16(Value);
 153   }
 154
 155   void Write32(uint32_t Value) {
 156     if (IsLittleEndian)
 157       WriteLE32(Value);
 158     else
 159       WriteBE32(Value);
 160   }
 161
 162   void Write64(uint64_t Value) {
 163     if (IsLittleEndian)
 164       WriteLE64(Value);
 165     else
 166       WriteBE64(Value);
 167   }
 168
 169   void WriteZeros(unsigned N) {
 170     const char Zeros[16] = { 0 };
 171
 172     for (unsigned i = 0, e = N / 16; i != e; ++i)
 173       OS << StringRef(Zeros, 16);
 174
 175     OS << StringRef(Zeros, N % 16);
 176   }
 177
 178   void WriteBytes(const SmallVectorImpl<char> &ByteVec, unsigned ZeroFillSize = 0) {
 179     WriteBytes(StringRef(ByteVec.data(), ByteVec.size()), ZeroFillSize);
 180   }
 181
 182   void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
 183     // TODO: this version may need to go away once all fragment contents are
 184     // converted to SmallVector<char, N>
 185     assert((ZeroFillSize == 0 || Str.size () <= ZeroFillSize) &&
 186       "data size greater than fill size, unexpected large write will occur");
 187     OS << Str;
 188     if (ZeroFillSize)
 189       WriteZeros(ZeroFillSize - Str.size());
 190   }
 191
 192   /// @}
 193
 194 };
 195
 196 } // End llvm namespace
 197
 198 #endif