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 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H
  11 #define LLVM_LIB_CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H
  12 #include "llvm/ADT/SmallString.h"
  13 #include "llvm/IR/Constants.h"
  14 #include "llvm/IR/DebugInfo.h"
  15 #include "llvm/MC/MCSymbol.h"
  16 #include "llvm/MC/MachineLocation.h"
  17
  18 namespace llvm {
  19 class AsmPrinter;
  20
  21 /// \brief This struct describes location entries emitted in the .debug_loc
  22 /// section.
  23 class DebugLocEntry {
  24   /// Begin and end symbols for the address range that this location is valid.
  25   const MCSymbol *Begin;
  26   const MCSymbol *End;
  27
  28 public:
  29   /// \brief A single location or constant.
  30   struct Value {
  31     Value(const MDExpression *Expr, int64_t i)
  32         : Expression(Expr), EntryKind(E_Integer) {
  33       Constant.Int = i;
  34     }
  35     Value(const MDExpression *Expr, const ConstantFP *CFP)
  36         : Expression(Expr), EntryKind(E_ConstantFP) {
  37       Constant.CFP = CFP;
  38     }
  39     Value(const MDExpression *Expr, const ConstantInt *CIP)
  40         : Expression(Expr), EntryKind(E_ConstantInt) {
  41       Constant.CIP = CIP;
  42     }
  43     Value(const MDExpression *Expr, MachineLocation Loc)
  44         : Expression(Expr), EntryKind(E_Location), Loc(Loc) {
  45       assert(cast<MDExpression>(Expr)->isValid());
  46     }
  47
  48     /// Any complex address location expression for this Value.
  49     const MDExpression *Expression;
  50
  51     /// Type of entry that this represents.
  52     enum EntryType { E_Location, E_Integer, E_ConstantFP, E_ConstantInt };
  53     enum EntryType EntryKind;
  54
  55     /// Either a constant,
  56     union {
  57       int64_t Int;
  58       const ConstantFP *CFP;
  59       const ConstantInt *CIP;
  60     } Constant;
  61
  62     // Or a location in the machine frame.
  63     MachineLocation Loc;
  64
  65     bool isLocation() const { return EntryKind == E_Location; }
  66     bool isInt() const { return EntryKind == E_Integer; }
  67     bool isConstantFP() const { return EntryKind == E_ConstantFP; }
  68     bool isConstantInt() const { return EntryKind == E_ConstantInt; }
  69     int64_t getInt() const { return Constant.Int; }
  70     const ConstantFP *getConstantFP() const { return Constant.CFP; }
  71     const ConstantInt *getConstantInt() const { return Constant.CIP; }
  72     MachineLocation getLoc() const { return Loc; }
  73     bool isBitPiece() const { return getExpression()->isBitPiece(); }
  74     DIExpression getExpression() const { return Expression; }
  75     friend bool operator==(const Value &, const Value &);
  76     friend bool operator<(const Value &, const Value &);
  77   };
  78
  79 private:
  80   /// A nonempty list of locations/constants belonging to this entry,
  81   /// sorted by offset.
  82   SmallVector<Value, 1> Values;
  83   SmallString<8> DWARFBytes;
  84   SmallVector<std::string, 1> Comments;
  85
  86 public:
  87   DebugLocEntry(const MCSymbol *B, const MCSymbol *E, Value Val)
  88       : Begin(B), End(E) {
  89     Values.push_back(std::move(Val));
  90   }
  91
  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
  94   /// list of values.
  95   /// Return true if the merge was successful.
  96   bool MergeValues(const DebugLocEntry &Next) {
  97     if (Begin == Next.Begin) {
  98       DIExpression Expr = cast_or_null<MDExpression>(Values[0].Expression);
  99       DIExpression NextExpr =
 100           cast_or_null<MDExpression>(Next.Values[0].Expression);
 101       if (Expr->isBitPiece() && NextExpr->isBitPiece()) {
 102         addValues(Next.Values);
 103         End = Next.End;
 104         return true;
 105       }
 106     }
 107     return false;
 108   }
 109
 110   /// \brief Attempt to merge this DebugLocEntry with Next and return
 111   /// true if the merge was successful. Entries can be merged if they
 112   /// share the same Loc/Constant and if Next immediately follows this
 113   /// Entry.
 114   bool MergeRanges(const DebugLocEntry &Next) {
 115     // If this and Next are describing the same variable, merge them.
 116     if ((End == Next.Begin && Values == Next.Values)) {
 117       End = Next.End;
 118       return true;
 119     }
 120     return false;
 121   }
 122
 123   const MCSymbol *getBeginSym() const { return Begin; }
 124   const MCSymbol *getEndSym() const { return End; }
 125   ArrayRef<Value> getValues() const { return Values; }
 126   void addValues(ArrayRef<DebugLocEntry::Value> Vals) {
 127     Values.append(Vals.begin(), Vals.end());
 128     sortUniqueValues();
 129     assert(std::all_of(Values.begin(), Values.end(), [](DebugLocEntry::Value V){
 130           return V.isBitPiece();
 131         }) && "value must be a piece");
 132   }
 133
 134   // \brief Sort the pieces by offset.
 135   // Remove any duplicate entries by dropping all but the first.
 136   void sortUniqueValues() {
 137     std::sort(Values.begin(), Values.end());
 138     Values.erase(
 139         std::unique(
 140             Values.begin(), Values.end(), [](const Value &A, const Value &B) {
 141               return A.getExpression() == B.getExpression();
 142             }),
 143         Values.end());
 144   }
 145
 146   /// \brief Lower this entry into a DWARF expression.
 147   void finalize(const AsmPrinter &AP, const MDBasicType *TypeIdentifierMap);
 148
 149   /// \brief Return the lowered DWARF expression.
 150   StringRef getDWARFBytes() const { return DWARFBytes; }
 151   /// \brief Return the assembler comments for the lowered DWARF expression.
 152   const SmallVectorImpl<std::string> &getComments() const { return Comments; }
 153 };
 154
 155 /// \brief Compare two Values for equality.
 156 inline bool operator==(const DebugLocEntry::Value &A,
 157                        const DebugLocEntry::Value &B) {
 158   if (A.EntryKind != B.EntryKind)
 159     return false;
 160
 161   if (A.Expression != B.Expression)
 162     return false;
 163
 164   switch (A.EntryKind) {
 165   case DebugLocEntry::Value::E_Location:
 166     return A.Loc == B.Loc;
 167   case DebugLocEntry::Value::E_Integer:
 168     return A.Constant.Int == B.Constant.Int;
 169   case DebugLocEntry::Value::E_ConstantFP:
 170     return A.Constant.CFP == B.Constant.CFP;
 171   case DebugLocEntry::Value::E_ConstantInt:
 172     return A.Constant.CIP == B.Constant.CIP;
 173   }
 174   llvm_unreachable("unhandled EntryKind");
 175 }
 176
 177 /// \brief Compare two pieces based on their offset.
 178 inline bool operator<(const DebugLocEntry::Value &A,
 179                       const DebugLocEntry::Value &B) {
 180   return A.getExpression()->getBitPieceOffset() <
 181          B.getExpression()->getBitPieceOffset();
 182 }
 183
 184 }
 185
 186 #endif