LLVM  8.0.0svn
DebugCounter.cpp
Go to the documentation of this file.
3 #include "llvm/Support/Format.h"
5 #include "llvm/Support/Options.h"
6 
7 using namespace llvm;
8 
9 namespace {
10 // This class overrides the default list implementation of printing so we
11 // can pretty print the list of debug counter options. This type of
12 // dynamic option is pretty rare (basically this and pass lists).
13 class DebugCounterList : public cl::list<std::string, DebugCounter> {
14 private:
16 
17 public:
18  template <class... Mods>
19  explicit DebugCounterList(Mods &&... Ms) : Base(std::forward<Mods>(Ms)...) {}
20 
21 private:
22  void printOptionInfo(size_t GlobalWidth) const override {
23  // This is a variant of from generic_parser_base::printOptionInfo. Sadly,
24  // it's not easy to make it more usable. We could get it to print these as
25  // options if we were a cl::opt and registered them, but lists don't have
26  // options, nor does the parser for std::string. The other mechanisms for
27  // options are global and would pollute the global namespace with our
28  // counters. Rather than go that route, we have just overridden the
29  // printing, which only a few things call anyway.
30  outs() << " -" << ArgStr;
31  // All of the other options in CommandLine.cpp use ArgStr.size() + 6 for
32  // width, so we do the same.
33  Option::printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
34  const auto &CounterInstance = DebugCounter::instance();
35  for (auto Name : CounterInstance) {
36  const auto Info =
37  CounterInstance.getCounterInfo(CounterInstance.getCounterId(Name));
38  size_t NumSpaces = GlobalWidth - Info.first.size() - 8;
39  outs() << " =" << Info.first;
40  outs().indent(NumSpaces) << " - " << Info.second << '\n';
41  }
42  }
43 };
44 } // namespace
45 
46 // Create our command line option.
47 static DebugCounterList DebugCounterOption(
48  "debug-counter", cl::Hidden,
49  cl::desc("Comma separated list of debug counter skip and count"),
51 
53  "print-debug-counter", cl::Hidden, cl::init(false), cl::Optional,
54  cl::desc("Print out debug counter info after all counters accumulated"));
55 
57 
58 // Print information when destroyed, iff command line option is specified.
60  if (isCountingEnabled() && PrintDebugCounter)
61  print(dbgs());
62 }
63 
65 
66 // This is called by the command line parser when it sees a value for the
67 // debug-counter option defined above.
68 void DebugCounter::push_back(const std::string &Val) {
69  if (Val.empty())
70  return;
71  // The strings should come in as counter=value
72  auto CounterPair = StringRef(Val).split('=');
73  if (CounterPair.second.empty()) {
74  errs() << "DebugCounter Error: " << Val << " does not have an = in it\n";
75  return;
76  }
77  // Now we have counter=value.
78  // First, process value.
79  int64_t CounterVal;
80  if (CounterPair.second.getAsInteger(0, CounterVal)) {
81  errs() << "DebugCounter Error: " << CounterPair.second
82  << " is not a number\n";
83  return;
84  }
85  // Now we need to see if this is the skip or the count, remove the suffix, and
86  // add it to the counter values.
87  if (CounterPair.first.endswith("-skip")) {
88  auto CounterName = CounterPair.first.drop_back(5);
89  unsigned CounterID = getCounterId(CounterName);
90  if (!CounterID) {
91  errs() << "DebugCounter Error: " << CounterName
92  << " is not a registered counter\n";
93  return;
94  }
95  enableAllCounters();
96 
97  CounterInfo &Counter = Counters[CounterID];
98  Counter.Skip = CounterVal;
99  Counter.IsSet = true;
100  } else if (CounterPair.first.endswith("-count")) {
101  auto CounterName = CounterPair.first.drop_back(6);
102  unsigned CounterID = getCounterId(CounterName);
103  if (!CounterID) {
104  errs() << "DebugCounter Error: " << CounterName
105  << " is not a registered counter\n";
106  return;
107  }
108  enableAllCounters();
109 
110  CounterInfo &Counter = Counters[CounterID];
111  Counter.StopAfter = CounterVal;
112  Counter.IsSet = true;
113  } else {
114  errs() << "DebugCounter Error: " << CounterPair.first
115  << " does not end with -skip or -count\n";
116  }
117 }
118 
120  SmallVector<StringRef, 16> CounterNames(RegisteredCounters.begin(),
121  RegisteredCounters.end());
122  sort(CounterNames.begin(), CounterNames.end());
123 
124  auto &Us = instance();
125  OS << "Counters and values:\n";
126  for (auto &CounterName : CounterNames) {
127  unsigned CounterID = getCounterId(CounterName);
128  OS << left_justify(RegisteredCounters[CounterID], 32) << ": {"
129  << Us.Counters[CounterID].Count << "," << Us.Counters[CounterID].Skip
130  << "," << Us.Counters[CounterID].StopAfter << "}\n";
131  }
132 }
133 
135  print(dbgs());
136 }
FormattedString left_justify(StringRef Str, unsigned Width)
left_justify - append spaces after string so total output is Width characters.
Definition: Format.h:145
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVM_DUMP_METHOD void dump() const
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
raw_ostream & indent(unsigned NumSpaces)
indent - Insert &#39;NumSpaces&#39; spaces.
static DebugCounter & instance()
Returns a reference to the singleton instance.
static cl::opt< bool > PrintDebugCounter("print-debug-counter", cl::Hidden, cl::init(false), cl::Optional, cl::desc("Print out debug counter info after all counters accumulated"))
amdgpu Simplify well known AMD library false Value Value const Twine & Name
Definition: BitVector.h:938
static ManagedStatic< DebugCounter > DC
#define LLVM_DUMP_METHOD
Definition: Compiler.h:74
This file provides an implementation of debug counters.
raw_ostream & outs()
This returns a reference to a raw_ostream for standard output.
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:419
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
void sort(IteratorTy Start, IteratorTy End)
Definition: STLExtras.h:978
static DebugCounterList DebugCounterOption("debug-counter", cl::Hidden, cl::desc("Comma separated list of debug counter skip and count"), cl::CommaSeparated, cl::ZeroOrMore, cl::location(DebugCounter::instance()))
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:847
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:727
This file declares helper objects for defining debug options that can be configured via the command l...
void print(raw_ostream &OS) const
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:133
void push_back(const std::string &)
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
ManagedStatic - This transparently changes the behavior of global statics to be lazily constructed on...
Definition: ManagedStatic.h:61
LocationClass< Ty > location(Ty &L)
Definition: CommandLine.h:435