include/llvm/MC/MCObjectStreamer.h

   1 //===- MCObjectStreamer.h - MCStreamer Object File 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_MCOBJECTSTREAMER_H
  11 #define LLVM_MC_MCOBJECTSTREAMER_H
  12
  13 #include "llvm/MC/MCAssembler.h"
  14 #include "llvm/MC/MCStreamer.h"
  15
  16 namespace llvm {
  17 class MCAssembler;
  18 class MCCodeEmitter;
  19 class MCSectionData;
  20 class MCSubtargetInfo;
  21 class MCExpr;
  22 class MCFragment;
  23 class MCDataFragment;
  24 class MCAsmBackend;
  25 class raw_ostream;
  26
  27 /// \brief Streaming object file generation interface.
  28 ///
  29 /// This class provides an implementation of the MCStreamer interface which is
  30 /// suitable for use with the assembler backend. Specific object file formats
  31 /// are expected to subclass this interface to implement directives specific
  32 /// to that file format or custom semantics expected by the object writer
  33 /// implementation.
  34 class MCObjectStreamer : public MCStreamer {
  35   MCAssembler *Assembler;
  36   MCSectionData *CurSectionData;
  37   MCSectionData::iterator CurInsertionPoint;
  38
  39   virtual void EmitInstToData(const MCInst &Inst, const MCSubtargetInfo&) = 0;
  40   void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) override;
  41   void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) override;
  42
  43 protected:
  44   MCObjectStreamer(MCContext &Context, MCAsmBackend &TAB, raw_ostream &_OS,
  45                    MCCodeEmitter *_Emitter);
  46   MCObjectStreamer(MCContext &Context, MCAsmBackend &TAB, raw_ostream &_OS,
  47                    MCCodeEmitter *_Emitter, MCAssembler *_Assembler);
  48   ~MCObjectStreamer();
  49
  50 public:
  51   /// state management
  52   void reset() override;
  53
  54   /// Object streamers require the integrated assembler.
  55   bool isIntegratedAssemblerRequired() const override { return true; }
  56
  57 protected:
  58   MCSectionData *getCurrentSectionData() const {
  59     return CurSectionData;
  60   }
  61
  62   MCFragment *getCurrentFragment() const;
  63
  64   void insert(MCFragment *F) const {
  65     CurSectionData->getFragmentList().insert(CurInsertionPoint, F);
  66     F->setParent(CurSectionData);
  67   }
  68
  69   /// Get a data fragment to write into, creating a new one if the current
  70   /// fragment is not a data fragment.
  71   MCDataFragment *getOrCreateDataFragment() const;
  72
  73   const MCExpr *AddValueSymbols(const MCExpr *Value);
  74
  75 public:
  76   MCAssembler &getAssembler() { return *Assembler; }
  77
  78   /// @name MCStreamer Interface
  79   /// @{
  80
  81   void EmitLabel(MCSymbol *Symbol) override;
  82   void EmitDebugLabel(MCSymbol *Symbol) override;
  83   void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
  84   void EmitValueImpl(const MCExpr *Value, unsigned Size) override;
  85   void EmitULEB128Value(const MCExpr *Value) override;
  86   void EmitSLEB128Value(const MCExpr *Value) override;
  87   void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
  88   void ChangeSection(const MCSection *Section,
  89                      const MCExpr *Subsection) override;
  90   void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo& STI) override;
  91
  92   /// \brief Emit an instruction to a special fragment, because this instruction
  93   /// can change its size during relaxation.
  94   virtual void EmitInstToFragment(const MCInst &Inst, const MCSubtargetInfo &);
  95
  96   void EmitBundleAlignMode(unsigned AlignPow2) override;
  97   void EmitBundleLock(bool AlignToEnd) override;
  98   void EmitBundleUnlock() override;
  99   void EmitBytes(StringRef Data) override;
 100   void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 101                             unsigned ValueSize = 1,
 102                             unsigned MaxBytesToEmit = 0) override;
 103   void EmitCodeAlignment(unsigned ByteAlignment,
 104                          unsigned MaxBytesToEmit = 0) override;
 105   bool EmitValueToOffset(const MCExpr *Offset, unsigned char Value) override;
 106   void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 107                              unsigned Column, unsigned Flags,
 108                              unsigned Isa, unsigned Discriminator,
 109                              StringRef FileName) override;
 110   void EmitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel,
 111                                 const MCSymbol *Label,
 112                                 unsigned PointerSize) override;
 113   void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
 114                                  const MCSymbol *Label) override;
 115   void EmitGPRel32Value(const MCExpr *Value) override;
 116   void EmitGPRel64Value(const MCExpr *Value) override;
 117   void EmitFill(uint64_t NumBytes, uint8_t FillValue) override;
 118   void EmitZeros(uint64_t NumBytes) override;
 119   void FinishImpl() override;
 120 };
 121
 122 } // end namespace llvm
 123
 124 #endif