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