Coverage Report

Created: 2019-07-24 05:18

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/lib/CodeGen/AsmPrinter/DebugLocEntry.h
Line
Count
Source (jump to first uncovered line)
1
//===-- llvm/CodeGen/DebugLocEntry.h - Entry in debug_loc list -*- C++ -*--===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
9
#ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H
10
#define LLVM_LIB_CODEGEN_ASMPRINTER_DEBUGLOCENTRY_H
11
12
#include "DebugLocStream.h"
13
#include "llvm/Config/llvm-config.h"
14
#include "llvm/IR/Constants.h"
15
#include "llvm/IR/DebugInfo.h"
16
#include "llvm/MC/MCSymbol.h"
17
#include "llvm/MC/MachineLocation.h"
18
#include "llvm/Support/Debug.h"
19
20
namespace llvm {
21
class AsmPrinter;
22
23
/// A single location or constant.
24
class DbgValueLoc {
25
  /// Any complex address location expression for this DbgValueLoc.
26
  const DIExpression *Expression;
27
28
  /// Type of entry that this represents.
29
  enum EntryType { E_Location, E_Integer, E_ConstantFP, E_ConstantInt };
30
  enum EntryType EntryKind;
31
32
  /// Either a constant,
33
  union {
34
    int64_t Int;
35
    const ConstantFP *CFP;
36
    const ConstantInt *CIP;
37
  } Constant;
38
39
  /// Or a location in the machine frame.
40
  MachineLocation Loc;
41
42
public:
43
  DbgValueLoc(const DIExpression *Expr, int64_t i)
44
4.20k
      : Expression(Expr), EntryKind(E_Integer) {
45
4.20k
    Constant.Int = i;
46
4.20k
  }
47
  DbgValueLoc(const DIExpression *Expr, const ConstantFP *CFP)
48
8
      : Expression(Expr), EntryKind(E_ConstantFP) {
49
8
    Constant.CFP = CFP;
50
8
  }
51
  DbgValueLoc(const DIExpression *Expr, const ConstantInt *CIP)
52
1
      : Expression(Expr), EntryKind(E_ConstantInt) {
53
1
    Constant.CIP = CIP;
54
1
  }
55
  DbgValueLoc(const DIExpression *Expr, MachineLocation Loc)
56
1.68k
      : Expression(Expr), EntryKind(E_Location), Loc(Loc) {
57
1.68k
    assert(cast<DIExpression>(Expr)->isValid());
58
1.68k
  }
59
60
771
  bool isLocation() const { return EntryKind == E_Location; }
61
4.75k
  bool isInt() const { return EntryKind == E_Integer; }
62
7
  bool isConstantFP() const { return EntryKind == E_ConstantFP; }
63
1
  bool isConstantInt() const { return EntryKind == E_ConstantInt; }
64
4.10k
  int64_t getInt() const { return Constant.Int; }
65
6
  const ConstantFP *getConstantFP() const { return Constant.CFP; }
66
1
  const ConstantInt *getConstantInt() const { return Constant.CIP; }
67
723
  MachineLocation getLoc() const { return Loc; }
68
667
  bool isFragment() const { return getExpression()->isFragment(); }
69
0
  bool isEntryVal() const { return getExpression()->isEntryValue(); }
70
29.6k
  const DIExpression *getExpression() const { return Expression; }
71
  friend bool operator==(const DbgValueLoc &, const DbgValueLoc &);
72
  friend bool operator<(const DbgValueLoc &, const DbgValueLoc &);
73
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
74
  LLVM_DUMP_METHOD void dump() const {
75
    if (isLocation()) {
76
      llvm::dbgs() << "Loc = { reg=" << Loc.getReg() << " ";
77
      if (Loc.isIndirect())
78
        llvm::dbgs() << "+0";
79
      llvm::dbgs() << "} ";
80
    } else if (isConstantInt())
81
      Constant.CIP->dump();
82
    else if (isConstantFP())
83
      Constant.CFP->dump();
84
    if (Expression)
85
      Expression->dump();
86
  }
87
#endif
88
};
89
90
/// This struct describes location entries emitted in the .debug_loc
91
/// section.
92
class DebugLocEntry {
93
  /// Begin and end symbols for the address range that this location is valid.
94
  const MCSymbol *Begin;
95
  const MCSymbol *End;
96
97
  /// A nonempty list of locations/constants belonging to this entry,
98
  /// sorted by offset.
99
  SmallVector<DbgValueLoc, 1> Values;
100
101
public:
102
  /// Create a location list entry for the range [\p Begin, \p End).
103
  ///
104
  /// \param Vals One or more values describing (parts of) the variable.
105
  DebugLocEntry(const MCSymbol *Begin, const MCSymbol *End,
106
                ArrayRef<DbgValueLoc> Vals)
107
1.31k
      : Begin(Begin), End(End) {
108
1.31k
    addValues(Vals);
109
1.31k
  }
110
111
  /// Attempt to merge this DebugLocEntry with Next and return
112
  /// true if the merge was successful. Entries can be merged if they
113
  /// share the same Loc/Constant and if Next immediately follows this
114
  /// Entry.
115
864
  bool MergeRanges(const DebugLocEntry &Next) {
116
864
    // If this and Next are describing the same variable, merge them.
117
864
    if ((End == Next.Begin && 
Values == Next.Values812
)) {
118
625
      End = Next.End;
119
625
      return true;
120
625
    }
121
239
    return false;
122
239
  }
123
124
0
  const MCSymbol *getBeginSym() const { return Begin; }
125
0
  const MCSymbol *getEndSym() const { return End; }
126
27
  ArrayRef<DbgValueLoc> getValues() const { return Values; }
127
1.31k
  void addValues(ArrayRef<DbgValueLoc> Vals) {
128
1.31k
    Values.append(Vals.begin(), Vals.end());
129
1.31k
    sortUniqueValues();
130
1.31k
    assert((Values.size() == 1 || all_of(Values, [](DbgValueLoc V) {
131
1.31k
              return V.isFragment();
132
1.31k
            })) && "must either have a single value or multiple pieces");
133
1.31k
  }
134
135
  // Sort the pieces by offset.
136
  // Remove any duplicate entries by dropping all but the first.
137
1.31k
  void sortUniqueValues() {
138
1.31k
    llvm::sort(Values);
139
1.31k
    Values.erase(std::unique(Values.begin(), Values.end(),
140
4.05k
                             [](const DbgValueLoc &A, const DbgValueLoc &B) {
141
4.05k
                               return A.getExpression() == B.getExpression();
142
4.05k
                             }),
143
1.31k
                 Values.end());
144
1.31k
  }
145
146
  /// Lower this entry into a DWARF expression.
147
  void finalize(const AsmPrinter &AP,
148
                DebugLocStream::ListBuilder &List,
149
                const DIBasicType *BT,
150
                DwarfCompileUnit &TheCU);
151
};
152
153
/// Compare two DbgValueLocs for equality.
154
inline bool operator==(const DbgValueLoc &A,
155
804
                       const DbgValueLoc &B) {
156
804
  if (A.EntryKind != B.EntryKind)
157
20
    return false;
158
784
159
784
  if (A.Expression != B.Expression)
160
67
    return false;
161
717
162
717
  switch (A.EntryKind) {
163
717
  case DbgValueLoc::E_Location:
164
660
    return A.Loc == B.Loc;
165
717
  case DbgValueLoc::E_Integer:
166
57
    return A.Constant.Int == B.Constant.Int;
167
717
  case DbgValueLoc::E_ConstantFP:
168
0
    return A.Constant.CFP == B.Constant.CFP;
169
717
  case DbgValueLoc::E_ConstantInt:
170
0
    return A.Constant.CIP == B.Constant.CIP;
171
0
  }
172
0
  llvm_unreachable("unhandled EntryKind");
173
0
}
174
175
/// Compare two fragments based on their offset.
176
inline bool operator<(const DbgValueLoc &A,
177
8.06k
                      const DbgValueLoc &B) {
178
8.06k
  return A.getExpression()->getFragmentInfo()->OffsetInBits <
179
8.06k
         B.getExpression()->getFragmentInfo()->OffsetInBits;
180
8.06k
}
181
182
}
183
184
#endif