eliminate EOL, adding all comments with the OutStreamer.AddComment
[oota-llvm.git] / lib / CodeGen / AsmPrinter / DwarfPrinter.h
1 //===--- lib/CodeGen/DwarfPrinter.h - Dwarf Printer -------------*- 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 // Emit general DWARF directives.
11 // 
12 //===----------------------------------------------------------------------===//
13
14 #ifndef CODEGEN_ASMPRINTER_DWARFPRINTER_H__
15 #define CODEGEN_ASMPRINTER_DWARFPRINTER_H__
16
17 #include "llvm/CodeGen/MachineLocation.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/FormattedStream.h"
20 #include <vector>
21
22 namespace llvm {
23 class AsmPrinter;
24 class MachineFunction;
25 class MachineModuleInfo;
26 class Module;
27 class MCAsmInfo;
28 class TargetData;
29 class TargetRegisterInfo;
30 class GlobalValue;
31 class MCSymbol;
32 class Twine;
33
34 class DwarfPrinter {
35 protected:
36   ~DwarfPrinter() {}
37
38   //===-------------------------------------------------------------==---===//
39   // Core attributes used by the DWARF printer.
40   //
41
42   /// O - Stream to .s file.
43   raw_ostream &O;
44
45   /// Asm - Target of Dwarf emission.
46   AsmPrinter *Asm;
47
48   /// MAI - Target asm information.
49   const MCAsmInfo *MAI;
50
51   /// TD - Target data.
52   const TargetData *TD;
53
54   /// RI - Register Information.
55   const TargetRegisterInfo *RI;
56
57   /// M - Current module.
58   Module *M;
59
60   /// MF - Current machine function.
61   const MachineFunction *MF;
62
63   /// MMI - Collected machine module information.
64   MachineModuleInfo *MMI;
65
66   /// SubprogramCount - The running count of functions being compiled.
67   unsigned SubprogramCount;
68
69   DwarfPrinter(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
70 public:
71   
72   //===------------------------------------------------------------------===//
73   // Accessors.
74   //
75   const AsmPrinter *getAsm() const { return Asm; }
76   MachineModuleInfo *getMMI() const { return MMI; }
77   const MCAsmInfo *getMCAsmInfo() const { return MAI; }
78   const TargetData *getTargetData() const { return TD; }
79
80   /// getDWLabel - Return the MCSymbol corresponding to the assembler temporary
81   /// label with the specified stem and unique ID.
82   MCSymbol *getDWLabel(const char *Name, unsigned ID) const;
83   
84   /// getTempLabel - Return an assembler temporary label with the specified
85   /// name.
86   MCSymbol *getTempLabel(const char *Name) const;
87
88   /// SizeOfEncodedValue - Return the size of the encoding in bytes.
89   unsigned SizeOfEncodedValue(unsigned Encoding) const;
90
91   void PrintRelDirective(unsigned Encoding) const;
92   void PrintRelDirective(bool Force32Bit = false) const;
93
94   /// EmitEncodingByte - Emit a .byte 42 directive that corresponds to an
95   /// encoding.  If verbose assembly output is enabled, we output comments
96   /// describing the encoding.  Desc is a string saying what the encoding is
97   /// specifying (e.g. "LSDA").
98   void EmitEncodingByte(unsigned Val, const char *Desc);
99   
100   /// EmitCFAByte - Emit a .byte 42 directive for a DW_CFA_xxx value.
101   void EmitCFAByte(unsigned Val);
102   
103   
104   /// EmitSLEB128 - emit the specified signed leb128 value.
105   void EmitSLEB128(int Value, const char *Desc) const;
106
107   /// EmitULEB128 - emit the specified unsigned leb128 value.
108   void EmitULEB128(unsigned Value, const char *Desc = 0,
109                    unsigned PadTo = 0) const;
110
111   
112   /// EmitReference - Emit a reference to a label.
113   ///
114   void EmitReference(const MCSymbol *Label, bool IsPCRelative = false,
115                      bool Force32Bit = false) const;
116   
117   void EmitReference(const MCSymbol *Sym, unsigned Encoding) const;
118   void EmitReference(const GlobalValue *GV, unsigned Encoding) const;
119
120   /// EmitDifference - Emit the difference between two labels.
121   void EmitDifference(const MCSymbol *LabelHi, const MCSymbol *LabelLo,
122                       bool IsSmall = false);
123
124   /// EmitSectionOffset - Emit Label-Section or use a special purpose directive
125   /// to emit a section offset if the target has one.
126   void EmitSectionOffset(const MCSymbol *Label, const MCSymbol *Section,
127                          bool IsSmall = false, bool isEH = false);
128   
129   /// EmitFrameMoves - Emit frame instructions to describe the layout of the
130   /// frame.
131   void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
132                       const std::vector<MachineMove> &Moves, bool isEH);
133 };
134
135 } // end llvm namespace
136
137 #endif