1 //===-- llvm/CodeGen/SDNodeDbgValue.h - SelectionDAG dbg_value --*- 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 declares the SDDbgValue class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_CODEGEN_SELECTIONDAG_SDNODEDBGVALUE_H
15 #define LLVM_LIB_CODEGEN_SELECTIONDAG_SDNODEDBGVALUE_H
16 
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/IR/DebugLoc.h"
19 #include "llvm/Support/DataTypes.h"
20 
21 namespace llvm {
22 
23 class MDNode;
24 class SDNode;
25 class Value;
26 
27 /// SDDbgValue - Holds the information from a dbg_value node through SDISel.
28 /// We do not use SDValue here to avoid including its header.
29 
30 class SDDbgValue {
31 public:
32   enum DbgValueKind {
33     SDNODE = 0,             // value is the result of an expression
34     CONST = 1,              // value is a constant
35     FRAMEIX = 2             // value is contents of a stack location
36   };
37 private:
38   enum DbgValueKind kind;
39   union {
40     struct {
41       SDNode *Node;         // valid for expressions
42       unsigned ResNo;       // valid for expressions
43     } s;
44     const Value *Const;     // valid for constants
45     unsigned FrameIx;       // valid for stack objects
46   } u;
47   MDNode *Var;
48   MDNode *Expr;
49   bool IsIndirect;
50   uint64_t Offset;
51   DebugLoc DL;
52   unsigned Order;
53   bool Invalid;
54 public:
55   // Constructor for non-constants.
SDDbgValue(MDNode * Var,MDNode * Expr,SDNode * N,unsigned R,bool indir,uint64_t off,DebugLoc dl,unsigned O)56   SDDbgValue(MDNode *Var, MDNode *Expr, SDNode *N, unsigned R, bool indir,
57              uint64_t off, DebugLoc dl, unsigned O)
58       : Var(Var), Expr(Expr), IsIndirect(indir), Offset(off), DL(dl), Order(O),
59         Invalid(false) {
60     kind = SDNODE;
61     u.s.Node = N;
62     u.s.ResNo = R;
63   }
64 
65   // Constructor for constants.
SDDbgValue(MDNode * Var,MDNode * Expr,const Value * C,uint64_t off,DebugLoc dl,unsigned O)66   SDDbgValue(MDNode *Var, MDNode *Expr, const Value *C, uint64_t off,
67              DebugLoc dl, unsigned O)
68       : Var(Var), Expr(Expr), IsIndirect(false), Offset(off), DL(dl), Order(O),
69         Invalid(false) {
70     kind = CONST;
71     u.Const = C;
72   }
73 
74   // Constructor for frame indices.
SDDbgValue(MDNode * Var,MDNode * Expr,unsigned FI,uint64_t off,DebugLoc dl,unsigned O)75   SDDbgValue(MDNode *Var, MDNode *Expr, unsigned FI, uint64_t off, DebugLoc dl,
76              unsigned O)
77       : Var(Var), Expr(Expr), IsIndirect(false), Offset(off), DL(dl), Order(O),
78         Invalid(false) {
79     kind = FRAMEIX;
80     u.FrameIx = FI;
81   }
82 
83   // Returns the kind.
getKind()84   DbgValueKind getKind() const { return kind; }
85 
86   // Returns the MDNode pointer for the variable.
getVariable()87   MDNode *getVariable() const { return Var; }
88 
89   // Returns the MDNode pointer for the expression.
getExpression()90   MDNode *getExpression() const { return Expr; }
91 
92   // Returns the SDNode* for a register ref
getSDNode()93   SDNode *getSDNode() const { assert (kind==SDNODE); return u.s.Node; }
94 
95   // Returns the ResNo for a register ref
getResNo()96   unsigned getResNo() const { assert (kind==SDNODE); return u.s.ResNo; }
97 
98   // Returns the Value* for a constant
getConst()99   const Value *getConst() const { assert (kind==CONST); return u.Const; }
100 
101   // Returns the FrameIx for a stack object
getFrameIx()102   unsigned getFrameIx() const { assert (kind==FRAMEIX); return u.FrameIx; }
103 
104   // Returns whether this is an indirect value.
isIndirect()105   bool isIndirect() const { return IsIndirect; }
106 
107   // Returns the offset.
getOffset()108   uint64_t getOffset() const { return Offset; }
109 
110   // Returns the DebugLoc.
getDebugLoc()111   DebugLoc getDebugLoc() const { return DL; }
112 
113   // Returns the SDNodeOrder.  This is the order of the preceding node in the
114   // input.
getOrder()115   unsigned getOrder() const { return Order; }
116 
117   // setIsInvalidated / isInvalidated - Setter / getter of the "Invalidated"
118   // property. A SDDbgValue is invalid if the SDNode that produces the value is
119   // deleted.
setIsInvalidated()120   void setIsInvalidated() { Invalid = true; }
isInvalidated()121   bool isInvalidated() const { return Invalid; }
122 };
123 
124 } // end llvm namespace
125 
126 #endif
127