1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
#include "llvm/Support/DebugCounter.h"
#include "DebugOptions.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/ManagedStatic.h"
using namespace llvm;
namespace llvm {
void DebugCounter::printChunks(raw_ostream &OS,
ArrayRef<IntegerInclusiveInterval> Chunks) {
IntegerInclusiveIntervalUtils::printIntervals(OS, Chunks, ':');
}
} // namespace llvm
namespace {
// This class overrides the default list implementation of printing so we
// can pretty print the list of debug counter options. This type of
// dynamic option is pretty rare (basically this and pass lists).
class DebugCounterList : public cl::list<std::string, DebugCounter> {
private:
using Base = cl::list<std::string, DebugCounter>;
public:
template <class... Mods>
explicit DebugCounterList(Mods &&... Ms) : Base(std::forward<Mods>(Ms)...) {}
private:
void printOptionInfo(size_t GlobalWidth) const override {
// This is a variant of from generic_parser_base::printOptionInfo. Sadly,
// it's not easy to make it more usable. We could get it to print these as
// options if we were a cl::opt and registered them, but lists don't have
// options, nor does the parser for std::string. The other mechanisms for
// options are global and would pollute the global namespace with our
// counters. Rather than go that route, we have just overridden the
// printing, which only a few things call anyway.
outs() << " -" << ArgStr;
// All of the other options in CommandLine.cpp use ArgStr.size() + 6 for
// width, so we do the same.
Option::printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
const auto &CounterInstance = DebugCounter::instance();
for (const auto &Entry : CounterInstance) {
const auto &[Name, Desc] = CounterInstance.getCounterDesc(Entry.second);
size_t NumSpaces = GlobalWidth - Name.size() - 8;
outs() << " =" << Name;
outs().indent(NumSpaces) << " - " << Desc << '\n';
}
}
};
// All global objects associated to the DebugCounter, including the DebugCounter
// itself, are owned by a single global instance of the DebugCounterOwner
// struct. This makes it easier to control the order in which constructors and
// destructors are run.
struct DebugCounterOwner : DebugCounter {
DebugCounterList DebugCounterOption{
"debug-counter", cl::Hidden,
cl::desc("Comma separated list of debug counter skip and count"),
cl::CommaSeparated, cl::location<DebugCounter>(*this)};
cl::opt<bool, true> PrintDebugCounter{
"print-debug-counter",
cl::Hidden,
cl::Optional,
cl::location(this->ShouldPrintCounter),
cl::init(false),
cl::desc("Print out debug counter info after all counters accumulated"),
cl::callback([&](const bool &Value) {
if (Value)
activateAllCounters();
})};
cl::opt<bool, true> PrintDebugCounterQueries{
"print-debug-counter-queries",
cl::Hidden,
cl::Optional,
cl::location(this->ShouldPrintCounterQueries),
cl::init(false),
cl::desc("Print out each query of an enabled debug counter")};
cl::opt<bool, true> BreakOnLastCount{
"debug-counter-break-on-last",
cl::Hidden,
cl::Optional,
cl::location(this->BreakOnLast),
cl::init(false),
cl::desc("Insert a break point on the last enabled count of a "
"chunks list")};
DebugCounterOwner() {
// Our destructor uses the debug stream. By referencing it here, we
// ensure that its destructor runs after our destructor.
(void)dbgs();
}
// Print information when destroyed, iff command line option is specified.
~DebugCounterOwner() {
if (ShouldPrintCounter)
print(dbgs());
}
};
} // anonymous namespace
// Use ManagedStatic instead of function-local static variable to ensure
// the destructor (which accesses counters and streams) runs during
// llvm_shutdown() rather than at some unspecified point.
static ManagedStatic<DebugCounterOwner> Owner;
void llvm::initDebugCounterOptions() { (void)DebugCounter::instance(); }
DebugCounter &DebugCounter::instance() { return *Owner; }
// This is called by the command line parser when it sees a value for the
// debug-counter option defined above.
void DebugCounter::push_back(const std::string &Val) {
if (Val.empty())
return;
// The strings should come in as counter=chunk_list
auto CounterPair = StringRef(Val).split('=');
if (CounterPair.second.empty()) {
errs() << "DebugCounter Error: " << Val << " does not have an = in it\n";
exit(1);
}
StringRef CounterName = CounterPair.first;
CounterInfo *Counter = getCounterInfo(CounterName);
if (!Counter) {
errs() << "DebugCounter Error: " << CounterName
<< " is not a registered counter\n";
return;
}
auto ExpectedChunks =
IntegerInclusiveIntervalUtils::parseIntervals(CounterPair.second, ':');
if (!ExpectedChunks) {
handleAllErrors(ExpectedChunks.takeError(), [&](const StringError &E) {
errs() << "DebugCounter Error: " << E.getMessage() << "\n";
});
exit(1);
}
Counter->Chunks = std::move(*ExpectedChunks);
Counter->Active = Counter->IsSet = true;
}
void DebugCounter::print(raw_ostream &OS) const {
SmallVector<StringRef, 16> CounterNames(Counters.keys());
sort(CounterNames);
OS << "Counters and values:\n";
for (StringRef CounterName : CounterNames) {
const CounterInfo *C = getCounterInfo(CounterName);
OS << left_justify(C->Name, 32) << ": {" << C->Count << ",";
printChunks(OS, C->Chunks);
OS << "}\n";
}
}
bool DebugCounter::handleCounterIncrement(CounterInfo &Info) {
int64_t CurrCount = Info.Count++;
uint64_t CurrIdx = Info.CurrChunkIdx;
if (Info.Chunks.empty())
return true;
if (CurrIdx >= Info.Chunks.size())
return false;
bool Res = Info.Chunks[CurrIdx].contains(CurrCount);
if (BreakOnLast && CurrIdx == (Info.Chunks.size() - 1) &&
CurrCount == Info.Chunks[CurrIdx].getEnd()) {
LLVM_BUILTIN_DEBUGTRAP;
}
if (CurrCount > Info.Chunks[CurrIdx].getEnd()) {
Info.CurrChunkIdx++;
/// Handle consecutive blocks.
if (Info.CurrChunkIdx < Info.Chunks.size() &&
CurrCount == Info.Chunks[Info.CurrChunkIdx].getBegin())
return true;
}
return Res;
}
bool DebugCounter::shouldExecuteImpl(CounterInfo &Counter) {
auto &Us = instance();
bool Res = Us.handleCounterIncrement(Counter);
if (Us.ShouldPrintCounterQueries && Counter.IsSet) {
dbgs() << "DebugCounter " << Counter.Name << "=" << (Counter.Count - 1)
<< (Res ? " execute" : " skip") << "\n";
}
return Res;
}
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
LLVM_DUMP_METHOD void DebugCounter::dump() const {
print(dbgs());
}
#endif
|
