Debug Info: Move the complex expression handling (=the remainder) of
[opencl/llvm.git] / lib / CodeGen / AsmPrinter / DwarfExpression.h
1 //===-- llvm/CodeGen/DwarfExpression.h - Dwarf Compile Unit ---*- 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 // This file contains support for writing dwarf compile unit.
11 //
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFEXPRESSION_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFEXPRESSION_H
17 #include "llvm/Support/DataTypes.h"
18 #include "llvm/IR/DebugInfo.h"
20 namespace llvm {
22 class AsmPrinter;
23 class ByteStreamer;
24 class TargetRegisterInfo;
26 /// Base class containing the logic for constructing DWARF expressions
27 /// independently of whether they are emitted into a DIE or into a .debug_loc
28 /// entry.
29 class DwarfExpression {
30 protected:
31   const AsmPrinter ≈
32   // Various convenience accessors that extract things out of AsmPrinter.
33   const TargetRegisterInfo *getTRI() const;
34   unsigned getDwarfVersion() const;
36 public:
37   DwarfExpression(const AsmPrinter &AP) : AP(AP) {}
38   virtual ~DwarfExpression() {}
40   /// Output a dwarf operand and an optional assembler comment.
41   virtual void EmitOp(uint8_t Op, const char *Comment = nullptr) = 0;
42   /// Emit a raw signed value.
43   virtual void EmitSigned(int Value) = 0;
44   /// Emit a raw unsigned value.
45   virtual void EmitUnsigned(unsigned Value) = 0;
46   /// Return whether the given machine register is the frame register in the
47   /// current function.
48   virtual bool isFrameRegister(unsigned MachineReg) = 0;
50   /// Emit a dwarf register operation.
51   void AddReg(int DwarfReg, const char *Comment = nullptr);
52   /// Emit an (double-)indirect dwarf register operation.
53   void AddRegIndirect(int DwarfReg, int Offset, bool Deref = false);
55   /// Emit a dwarf register operation for describing
56   /// - a small value occupying only part of a register or
57   /// - a register representing only part of a value.
58   void AddOpPiece(unsigned SizeInBits, unsigned OffsetInBits = 0);
59   /// Emit a shift-right dwarf expression.
60   void AddShr(unsigned ShiftBy);
62   /// Emit an indirect dwarf register operation for the given machine register.
63   /// Returns false if no DWARF register exists for MachineReg.
64   bool AddMachineRegIndirect(unsigned MachineReg, int Offset = 0);
66   /// \brief Emit a partial DWARF register operation.
67   /// \param MachineReg        the register
68   /// \param PieceSizeInBits   size and
69   /// \param PieceOffsetInBits offset of the piece in bits, if this is one
70   ///                          piece of an aggregate value.
71   ///
72   /// If size and offset is zero an operation for the entire
73   /// register is emitted: Some targets do not provide a DWARF
74   /// register number for every register.  If this is the case, this
75   /// function will attempt to emit a DWARF register by emitting a
76   /// piece of a super-register or by piecing together multiple
77   /// subregisters that alias the register.
78   void AddMachineRegPiece(unsigned MachineReg, unsigned PieceSizeInBits = 0,
79                           unsigned PieceOffsetInBits = 0);
81   /// Emit a signed constant.
82   void AddSignedConstant(int Value);
83   /// Emit an unsigned constant.
84   void AddUnsignedConstant(unsigned Value);
86   /// Emit an entire DIExpression on top of a machine register location.
87   /// \param PieceOffsetInBits If this is one piece out of a fragmented
88   /// location, this is the offset of the piece inside the entire variable.
89   void AddMachineRegExpression(DIExpression Expr, unsigned MachineReg,
90                                unsigned PieceOffsetInBits = 0);
91   /// Emit a the operations in a DIExpression, starting from element I.
92   /// \param PieceOffsetInBits If this is one piece out of a fragmented
93   /// location, this is the offset of the piece inside the entire variable.
94   void AddExpression(DIExpression Expr, unsigned PieceOffsetInBits = 0,
95                      unsigned I = 0);
96 };
98 /// DwarfExpression implementation for .debug_loc entries.
99 class DebugLocDwarfExpression : public DwarfExpression {
100   ByteStreamer &BS;
102 public:
103   DebugLocDwarfExpression(const AsmPrinter &AP, ByteStreamer &BS)
104       : DwarfExpression(AP), BS(BS) {}
106   void EmitOp(uint8_t Op, const char *Comment = nullptr) override;
107   void EmitSigned(int Value) override;
108   void EmitUnsigned(unsigned Value) override;
109   bool isFrameRegister(unsigned MachineReg) override;
110 };
113 #endif