Document, cleanup, and clang-format DwarfExpression.h
[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"
19 namespace llvm {
21 class AsmPrinter;
22 class ByteStreamer;
23 class TargetRegisterInfo;
25 /// Base class containing the logic for constructing DWARF expressions
26 /// independently of whether they are emitted into a DIE or into a .debug_loc
27 /// entry.
28 class DwarfExpression {
29 protected:
30   const AsmPrinter ≈
31   // Various convenience accessors that extract things out of AsmPrinter.
32   const TargetRegisterInfo *getTRI() const;
33   unsigned getDwarfVersion() const;
35 public:
36   DwarfExpression(const AsmPrinter &AP) : AP(AP) {}
37   virtual ~DwarfExpression() {}
39   /// Output a dwarf operand and an optional assembler comment.
40   virtual void EmitOp(uint8_t Op, const char *Comment = nullptr) = 0;
41   /// Emit a raw signed value.
42   virtual void EmitSigned(int Value) = 0;
43   /// Emit a raw unsigned value.
44   virtual void EmitUnsigned(unsigned Value) = 0;
45   /// Return whether the given machine register is the frame register in the
46   /// current function.
47   virtual bool isFrameRegister(unsigned MachineReg) = 0;
49   /// Emit a dwarf register operation.
50   void AddReg(int DwarfReg, const char *Comment = nullptr);
51   /// Emit an (double-)indirect dwarf register operation.
52   void AddRegIndirect(int DwarfReg, int Offset, bool Deref = false);
54   /// Emit a dwarf register operation for describing
55   /// - a small value occupying only part of a register or
56   /// - a register representing only part of a value.
57   void AddOpPiece(unsigned SizeInBits, unsigned OffsetInBits = 0);
58   /// Emit a shift-right dwarf expression.
59   void AddShr(unsigned ShiftBy);
61   /// Emit an indirect dwarf register operation for the given machine register.
62   /// Returns false if no DWARF register exists for MachineReg.
63   bool AddMachineRegIndirect(unsigned MachineReg, int Offset = 0);
65   /// \brief Emit a partial DWARF register operation.
66   /// \param MachineReg        the register
67   /// \param PieceSizeInBits   size and
68   /// \param PieceOffsetInBits offset of the piece in bits, if this is one
69   ///                          piece of an aggregate value.
70   ///
71   /// If size and offset is zero an operation for the entire
72   /// register is emitted: Some targets do not provide a DWARF
73   /// register number for every register.  If this is the case, this
74   /// function will attempt to emit a DWARF register by emitting a
75   /// piece of a super-register or by piecing together multiple
76   /// subregisters that alias the register.
77   void AddMachineRegPiece(unsigned MachineReg, unsigned PieceSizeInBits = 0,
78                           unsigned PieceOffsetInBits = 0);
80   /// Emit a signed constant.
81   void AddSignedConstant(int Value);
82   /// Emit an unsigned constant.
83   void AddUnsignedConstant(unsigned Value);
84 };
87 /// DwarfExpression implementation for .debug_loc entries.
88 class DebugLocDwarfExpression : public DwarfExpression {
89   ByteStreamer &BS;
91 public:
92   DebugLocDwarfExpression(const AsmPrinter &AP, ByteStreamer &BS)
93       : DwarfExpression(AP), BS(BS) {}
95   void EmitOp(uint8_t Op, const char *Comment = nullptr) override;
96   void EmitSigned(int Value) override;
97   void EmitUnsigned(unsigned Value) override;
98   bool isFrameRegister(unsigned MachineReg) override;
99 };
102 #endif