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/EndianStream.h"
  17 #include "llvm/Support/raw_ostream.h"
  18 #include <cassert>
  19
  20 namespace llvm {
  21 class MCAsmLayout;
  22 class MCAssembler;
  23 class MCFixup;
  24 class MCFragment;
  25 class MCSymbolRefExpr;
  26 class MCValue;
  27
  28 /// Defines the object file and target independent interfaces used by the
  29 /// 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   raw_pwrite_stream *OS;
  44
  45 protected:
  46   unsigned IsLittleEndian : 1;
  47
  48 protected: // Can only create subclasses.
  49   MCObjectWriter(raw_pwrite_stream &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_pwrite_stream &getStream() { return *OS; }
  61   void setStream(raw_pwrite_stream &NewOS) { OS = &NewOS; }
  62
  63   /// \name High-Level API
  64   /// @{
  65
  66   /// Perform any late binding of symbols (for example, to assign symbol
  67   /// indices for use when generating relocations).
  68   ///
  69   /// This routine is called by the assembler after layout and relaxation is
  70   /// complete.
  71   virtual void executePostLayoutBinding(MCAssembler &Asm,
  72                                         const MCAsmLayout &Layout) = 0;
  73
  74   /// Record a relocation entry.
  75   ///
  76   /// This routine is called by the assembler after layout and relaxation, and
  77   /// post layout binding. The implementation is responsible for storing
  78   /// information about the relocation so that it can be emitted during
  79   /// writeObject().
  80   virtual void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
  81                                 const MCFragment *Fragment,
  82                                 const MCFixup &Fixup, MCValue Target,
  83                                 bool &IsPCRel, uint64_t &FixedValue) = 0;
  84
  85   /// Check whether the difference (A - B) between two symbol references is
  86   /// fully resolved.
  87   ///
  88   /// Clients are not required to answer precisely and may conservatively return
  89   /// false, even when a difference is fully resolved.
  90   bool isSymbolRefDifferenceFullyResolved(const MCAssembler &Asm,
  91                                           const MCSymbolRefExpr *A,
  92                                           const MCSymbolRefExpr *B,
  93                                           bool InSet) const;
  94
  95   virtual bool isSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
  96                                                       const MCSymbol &SymA,
  97                                                       const MCFragment &FB,
  98                                                       bool InSet,
  99                                                       bool IsPCRel) const;
 100
 101   /// True if this symbol (which is a variable) is weak. This is not
 102   /// just STB_WEAK, but more generally whether or not we can evaluate
 103   /// past it.
 104   virtual bool isWeak(const MCSymbol &Sym) const;
 105
 106   /// Write the object file.
 107   ///
 108   /// This routine is called by the assembler after layout and relaxation is
 109   /// complete, fixups have been evaluated and applied, and relocations
 110   /// generated.
 111   virtual void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) = 0;
 112
 113   /// @}
 114   /// \name Binary Output
 115   /// @{
 116
 117   void write8(uint8_t Value) { *OS << char(Value); }
 118
 119   void writeLE16(uint16_t Value) {
 120     support::endian::Writer<support::little>(*OS).write(Value);
 121   }
 122
 123   void writeLE32(uint32_t Value) {
 124     support::endian::Writer<support::little>(*OS).write(Value);
 125   }
 126
 127   void writeLE64(uint64_t Value) {
 128     support::endian::Writer<support::little>(*OS).write(Value);
 129   }
 130
 131   void writeBE16(uint16_t Value) {
 132     support::endian::Writer<support::big>(*OS).write(Value);
 133   }
 134
 135   void writeBE32(uint32_t Value) {
 136     support::endian::Writer<support::big>(*OS).write(Value);
 137   }
 138
 139   void writeBE64(uint64_t Value) {
 140     support::endian::Writer<support::big>(*OS).write(Value);
 141   }
 142
 143   void write16(uint16_t Value) {
 144     if (IsLittleEndian)
 145       writeLE16(Value);
 146     else
 147       writeBE16(Value);
 148   }
 149
 150   void write32(uint32_t Value) {
 151     if (IsLittleEndian)
 152       writeLE32(Value);
 153     else
 154       writeBE32(Value);
 155   }
 156
 157   void write64(uint64_t Value) {
 158     if (IsLittleEndian)
 159       writeLE64(Value);
 160     else
 161       writeBE64(Value);
 162   }
 163
 164   void WriteZeros(unsigned N) {
 165     const char Zeros[16] = {0};
 166
 167     for (unsigned i = 0, e = N / 16; i != e; ++i)
 168       *OS << StringRef(Zeros, 16);
 169
 170     *OS << StringRef(Zeros, N % 16);
 171   }
 172
 173   void writeBytes(const SmallVectorImpl<char> &ByteVec,
 174                   unsigned ZeroFillSize = 0) {
 175     writeBytes(StringRef(ByteVec.data(), ByteVec.size()), ZeroFillSize);
 176   }
 177
 178   void writeBytes(StringRef Str, unsigned ZeroFillSize = 0) {
 179     // TODO: this version may need to go away once all fragment contents are
 180     // converted to SmallVector<char, N>
 181     assert(
 182         (ZeroFillSize == 0 || Str.size() <= ZeroFillSize) &&
 183         "data size greater than fill size, unexpected large write will occur");
 184     *OS << Str;
 185     if (ZeroFillSize)
 186       WriteZeros(ZeroFillSize - Str.size());
 187   }
 188
 189   /// @}
 190 };
 191
 192 } // End llvm namespace
 193
 194 #endif