08b00f1c478e216e1044e5a080793fd22b55bec0
[oota-llvm.git] / 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/MCStreamer.h"
14
15 namespace llvm {
16 class MCAssembler;
17 class MCCodeEmitter;
18 class MCSectionData;
19 class MCExpr;
20 class MCFragment;
21 class MCDataFragment;
22 class MCAsmBackend;
23 class raw_ostream;
24
25 /// \brief Streaming object file generation interface.
26 ///
27 /// This class provides an implementation of the MCStreamer interface which is
28 /// suitable for use with the assembler backend. Specific object file formats
29 /// are expected to subclass this interface to implement directives specific
30 /// to that file format or custom semantics expected by the object writer
31 /// implementation.
32 class MCObjectStreamer : public MCStreamer {
33   MCAssembler *Assembler;
34   MCSectionData *CurSectionData;
35
36   virtual void EmitInstToData(const MCInst &Inst) = 0;
37   virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
38   virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame);
39
40 protected:
41   MCObjectStreamer(MCContext &Context, MCAsmBackend &TAB,
42                    raw_ostream &_OS, MCCodeEmitter *_Emitter);
43   MCObjectStreamer(MCContext &Context, MCAsmBackend &TAB,
44                    raw_ostream &_OS, MCCodeEmitter *_Emitter,
45                    MCAssembler *_Assembler);
46   ~MCObjectStreamer();
47
48   MCSectionData *getCurrentSectionData() const {
49     return CurSectionData;
50   }
51
52   MCFragment *getCurrentFragment() const;
53
54   /// Get a data fragment to write into, creating a new one if the current
55   /// fragment is not a data fragment.
56   MCDataFragment *getOrCreateDataFragment() const;
57
58   const MCExpr *AddValueSymbols(const MCExpr *Value);
59
60 public:
61   MCAssembler &getAssembler() { return *Assembler; }
62
63   /// @name MCStreamer Interface
64   /// @{
65
66   virtual void EmitLabel(MCSymbol *Symbol);
67   virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
68                              unsigned AddrSpace);
69   virtual void EmitULEB128Value(const MCExpr *Value);
70   virtual void EmitSLEB128Value(const MCExpr *Value);
71   virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
72   virtual void ChangeSection(const MCSection *Section);
73   virtual void EmitInstruction(const MCInst &Inst);
74   virtual void EmitInstToFragment(const MCInst &Inst);
75   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
76   virtual void EmitValueToAlignment(unsigned ByteAlignment,
77                                     int64_t Value = 0,
78                                     unsigned ValueSize = 1,
79                                     unsigned MaxBytesToEmit = 0);
80   virtual void EmitCodeAlignment(unsigned ByteAlignment,
81                                  unsigned MaxBytesToEmit = 0);
82   virtual bool EmitValueToOffset(const MCExpr *Offset, unsigned char Value);
83   virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
84                                         const MCSymbol *LastLabel,
85                                         const MCSymbol *Label,
86                                         unsigned PointerSize);
87   virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
88                                          const MCSymbol *Label);
89   virtual void EmitGPRel32Value(const MCExpr *Value);
90   virtual void EmitGPRel64Value(const MCExpr *Value);
91   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
92                         unsigned AddrSpace);
93   virtual void FinishImpl();
94
95   /// @}
96 };
97
98 } // end namespace llvm
99
100 #endif