1 //===-- llvm/CodeGen/DebugLocEntry.h - Entry in debug_loc list -*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H
11 #define LLVM_LIB_CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H
13 #include "DebugLocStream.h"
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/IR/Constants.h"
16 #include "llvm/IR/DebugInfo.h"
17 #include "llvm/MC/MCSymbol.h"
18 #include "llvm/MC/MachineLocation.h"
23 /// \brief This struct describes location entries emitted in the .debug_loc
26 /// Begin and end symbols for the address range that this location is valid.
27 const MCSymbol *Begin;
31 /// \brief A single location or constant.
33 Value(const DIExpression *Expr, int64_t i)
34 : Expression(Expr), EntryKind(E_Integer) {
37 Value(const DIExpression *Expr, const ConstantFP *CFP)
38 : Expression(Expr), EntryKind(E_ConstantFP) {
41 Value(const DIExpression *Expr, const ConstantInt *CIP)
42 : Expression(Expr), EntryKind(E_ConstantInt) {
45 Value(const DIExpression *Expr, MachineLocation Loc)
46 : Expression(Expr), EntryKind(E_Location), Loc(Loc) {
47 assert(cast<DIExpression>(Expr)->isValid());
50 /// Any complex address location expression for this Value.
51 const DIExpression *Expression;
53 /// Type of entry that this represents.
54 enum EntryType { E_Location, E_Integer, E_ConstantFP, E_ConstantInt };
55 enum EntryType EntryKind;
57 /// Either a constant,
60 const ConstantFP *CFP;
61 const ConstantInt *CIP;
64 // Or a location in the machine frame.
67 bool isLocation() const { return EntryKind == E_Location; }
68 bool isInt() const { return EntryKind == E_Integer; }
69 bool isConstantFP() const { return EntryKind == E_ConstantFP; }
70 bool isConstantInt() const { return EntryKind == E_ConstantInt; }
71 int64_t getInt() const { return Constant.Int; }
72 const ConstantFP *getConstantFP() const { return Constant.CFP; }
73 const ConstantInt *getConstantInt() const { return Constant.CIP; }
74 MachineLocation getLoc() const { return Loc; }
75 bool isBitPiece() const { return getExpression()->isBitPiece(); }
76 const DIExpression *getExpression() const { return Expression; }
77 friend bool operator==(const Value &, const Value &);
78 friend bool operator<(const Value &, const Value &);
82 /// A nonempty list of locations/constants belonging to this entry,
84 SmallVector<Value, 1> Values;
87 DebugLocEntry(const MCSymbol *B, const MCSymbol *E, Value Val)
89 Values.push_back(std::move(Val));
92 /// \brief If this and Next are describing different pieces of the same
93 /// variable, merge them by appending Next's values to the current
95 /// Return true if the merge was successful.
96 bool MergeValues(const DebugLocEntry &Next);
98 /// \brief Attempt to merge this DebugLocEntry with Next and return
99 /// true if the merge was successful. Entries can be merged if they
100 /// share the same Loc/Constant and if Next immediately follows this
102 bool MergeRanges(const DebugLocEntry &Next) {
103 // If this and Next are describing the same variable, merge them.
104 if ((End == Next.Begin && Values == Next.Values)) {
111 const MCSymbol *getBeginSym() const { return Begin; }
112 const MCSymbol *getEndSym() const { return End; }
113 ArrayRef<Value> getValues() const { return Values; }
114 void addValues(ArrayRef<DebugLocEntry::Value> Vals) {
115 Values.append(Vals.begin(), Vals.end());
117 assert(std::all_of(Values.begin(), Values.end(), [](DebugLocEntry::Value V){
118 return V.isBitPiece();
119 }) && "value must be a piece");
122 // \brief Sort the pieces by offset.
123 // Remove any duplicate entries by dropping all but the first.
124 void sortUniqueValues() {
125 std::sort(Values.begin(), Values.end());
128 Values.begin(), Values.end(), [](const Value &A, const Value &B) {
129 return A.getExpression() == B.getExpression();
134 /// \brief Lower this entry into a DWARF expression.
135 void finalize(const AsmPrinter &AP, DebugLocStream::ListBuilder &List,
136 const DIBasicType *BT);
139 /// \brief Compare two Values for equality.
140 inline bool operator==(const DebugLocEntry::Value &A,
141 const DebugLocEntry::Value &B) {
142 if (A.EntryKind != B.EntryKind)
145 if (A.Expression != B.Expression)
148 switch (A.EntryKind) {
149 case DebugLocEntry::Value::E_Location:
150 return A.Loc == B.Loc;
151 case DebugLocEntry::Value::E_Integer:
152 return A.Constant.Int == B.Constant.Int;
153 case DebugLocEntry::Value::E_ConstantFP:
154 return A.Constant.CFP == B.Constant.CFP;
155 case DebugLocEntry::Value::E_ConstantInt:
156 return A.Constant.CIP == B.Constant.CIP;
158 llvm_unreachable("unhandled EntryKind");
161 /// \brief Compare two pieces based on their offset.
162 inline bool operator<(const DebugLocEntry::Value &A,
163 const DebugLocEntry::Value &B) {
164 return A.getExpression()->getBitPieceOffset() <
165 B.getExpression()->getBitPieceOffset();