Make these DebugLocEntry::Value comparison operators friend functions
[opencl/llvm.git] / lib / CodeGen / AsmPrinter / DebugLocEntry.h
1 //===-- llvm/CodeGen/DebugLocEntry.h - Entry in debug_loc list -*- 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 //===----------------------------------------------------------------------===//
10 #ifndef CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H__
11 #define CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H__
12 #include "llvm/IR/Constants.h"
13 #include "llvm/IR/DebugInfo.h"
14 #include "llvm/MC/MachineLocation.h"
15 #include "llvm/MC/MCSymbol.h"
17 namespace llvm {
18 class MDNode;
19 /// \brief This struct describes location entries emitted in the .debug_loc
20 /// section.
21 class DebugLocEntry {
22   // Begin and end symbols for the address range that this location is valid.
23   const MCSymbol *Begin;
24   const MCSymbol *End;
26 public:
27   /// A single location or constant.
28   struct Value {
29     Value(const MDNode *Var, int64_t i)
30       : Variable(Var), EntryKind(E_Integer) {
31       Constant.Int = i;
32     }
33     Value(const MDNode *Var, const ConstantFP *CFP)
34       : Variable(Var), EntryKind(E_ConstantFP) {
35       Constant.CFP = CFP;
36     }
37     Value(const MDNode *Var, const ConstantInt *CIP)
38       : Variable(Var), EntryKind(E_ConstantInt) {
39       Constant.CIP = CIP;
40     }
41     Value(const MDNode *Var, MachineLocation Loc)
42       : Variable(Var), EntryKind(E_Location), Loc(Loc) {
43     }
45     // The variable to which this location entry corresponds.
46     const MDNode *Variable;
48     // Type of entry that this represents.
49     enum EntryType { E_Location, E_Integer, E_ConstantFP, E_ConstantInt };
50     enum EntryType EntryKind;
52     // Either a constant,
53     union {
54       int64_t Int;
55       const ConstantFP *CFP;
56       const ConstantInt *CIP;
57     } Constant;
59     // Or a location in the machine frame.
60     MachineLocation Loc;
62     bool isLocation() const { return EntryKind == E_Location; }
63     bool isInt() const { return EntryKind == E_Integer; }
64     bool isConstantFP() const { return EntryKind == E_ConstantFP; }
65     bool isConstantInt() const { return EntryKind == E_ConstantInt; }
66     int64_t getInt() const { return Constant.Int; }
67     const ConstantFP *getConstantFP() const { return Constant.CFP; }
68     const ConstantInt *getConstantInt() const { return Constant.CIP; }
69     MachineLocation getLoc() const { return Loc; }
70     const MDNode *getVariable() const { return Variable; }
71     friend bool operator==(const Value &, const Value &);
72     friend bool operator<(const Value &, const Value &);
73   };
75 private:
76   /// A nonempty list of locations/constants belonging to this entry,
77   /// sorted by offset.
78   SmallVector<Value, 1> Values;
80 public:
81   DebugLocEntry(const MCSymbol *B, const MCSymbol *E, Value Val)
82       : Begin(B), End(E) {
83     Values.push_back(std::move(Val));
84   }
86   /// \brief If this and Next are describing different pieces of the same
87   // variable, merge them by appending Next's values to the current
88   // list of values.
89   // Return true if the merge was successful.
90   bool MergeValues(const DebugLocEntry &Next) {
91     if (Begin == Next.Begin && Values.size() > 0 && Next.Values.size() > 0) {
92       DIVariable Var(Values[0].Variable);
93       DIVariable NextVar(Next.Values[0].Variable);
94       if (Var.getName() == NextVar.getName() &&
95           Var.isVariablePiece() && NextVar.isVariablePiece()) {
96         addValues(Next.Values);
97         End = Next.End;
98         return true;
99       }
100     }
101     return false;
102   }
104   /// \brief Attempt to merge this DebugLocEntry with Next and return
105   /// true if the merge was successful. Entries can be merged if they
106   /// share the same Loc/Constant and if Next immediately follows this
107   /// Entry.
108   bool MergeRanges(const DebugLocEntry &Next) {
109     // If this and Next are describing the same variable, merge them.
110     if ((End == Next.Begin && Values == Next.Values)) {
111       End = Next.End;
112       return true;
113     }
114     return false;
115   }
117   const MCSymbol *getBeginSym() const { return Begin; }
118   const MCSymbol *getEndSym() const { return End; }
119   const ArrayRef<Value> getValues() const { return Values; }
120   void addValues(ArrayRef<DebugLocEntry::Value> Vals) {
121     Values.append(Vals.begin(), Vals.end());
122     sortUniqueValues();
123     assert(std::all_of(Values.begin(), Values.end(), [](DebugLocEntry::Value V){
124           return DIVariable(V.Variable).isVariablePiece();
125         }) && "value must be a piece");
126   }
128   // Sort the pieces by offset.
129   // Remove any duplicate entries by dropping all but the first.
130   void sortUniqueValues() {
131     std::sort(Values.begin(), Values.end());
132     Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
133   }
134 };
136 /// Compare two Values for equality.
137 inline bool operator==(const DebugLocEntry::Value &A,
138                        const DebugLocEntry::Value &B) {
139   if (A.EntryKind != B.EntryKind)
140     return false;
142   if (A.getVariable() != B.getVariable())
143     return false;
145   switch (A.EntryKind) {
146   case DebugLocEntry::Value::E_Location:
147     return A.Loc == B.Loc;
148   case DebugLocEntry::Value::E_Integer:
149     return A.Constant.Int == B.Constant.Int;
150   case DebugLocEntry::Value::E_ConstantFP:
151     return A.Constant.CFP == B.Constant.CFP;
152   case DebugLocEntry::Value::E_ConstantInt:
153     return A.Constant.CIP == B.Constant.CIP;
154   }
155   llvm_unreachable("unhandled EntryKind");
158 /// Compare two pieces based on their offset.
159 inline bool operator<(const DebugLocEntry::Value &A,
160                       const DebugLocEntry::Value &B) {
161   DIVariable Var(A.getVariable());
162   DIVariable OtherVar(B.getVariable());
163   return Var.getPieceOffset() < OtherVar.getPieceOffset();
168 #endif