#include "llvm/Support/DebugCounter.h" #include "DebugOptions.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/Format.h" using 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 { private: using Base = cl::list; public: template explicit DebugCounterList(Mods &&... Ms) : Base(std::forward(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 &Name : CounterInstance) { const auto Info = CounterInstance.getCounterInfo(CounterInstance.getCounterId(Name)); size_t NumSpaces = GlobalWidth - Info.first.size() - 8; outs() << " =" << Info.first; outs().indent(NumSpaces) << " - " << Info.second << '\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 DC; DebugCounterList DebugCounterOption{ "debug-counter", cl::Hidden, cl::desc("Comma separated list of debug counter skip and count"), cl::CommaSeparated, cl::location(DC)}; cl::opt PrintDebugCounter{ "print-debug-counter", cl::Hidden, cl::init(false), cl::Optional, cl::desc("Print out debug counter info after all counters accumulated")}; 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 (DC.isCountingEnabled() && PrintDebugCounter) DC.print(dbgs()); } }; } // anonymous namespace void llvm::initDebugCounterOptions() { (void)DebugCounter::instance(); } DebugCounter &DebugCounter::instance() { static DebugCounterOwner O; return O.DC; } // 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=value auto CounterPair = StringRef(Val).split('='); if (CounterPair.second.empty()) { errs() << "DebugCounter Error: " << Val << " does not have an = in it\n"; return; } // Now we have counter=value. // First, process value. int64_t CounterVal; if (CounterPair.second.getAsInteger(0, CounterVal)) { errs() << "DebugCounter Error: " << CounterPair.second << " is not a number\n"; return; } // Now we need to see if this is the skip or the count, remove the suffix, and // add it to the counter values. if (CounterPair.first.ends_with("-skip")) { auto CounterName = CounterPair.first.drop_back(5); unsigned CounterID = getCounterId(std::string(CounterName)); if (!CounterID) { errs() << "DebugCounter Error: " << CounterName << " is not a registered counter\n"; return; } enableAllCounters(); CounterInfo &Counter = Counters[CounterID]; Counter.Skip = CounterVal; Counter.IsSet = true; } else if (CounterPair.first.ends_with("-count")) { auto CounterName = CounterPair.first.drop_back(6); unsigned CounterID = getCounterId(std::string(CounterName)); if (!CounterID) { errs() << "DebugCounter Error: " << CounterName << " is not a registered counter\n"; return; } enableAllCounters(); CounterInfo &Counter = Counters[CounterID]; Counter.StopAfter = CounterVal; Counter.IsSet = true; } else { errs() << "DebugCounter Error: " << CounterPair.first << " does not end with -skip or -count\n"; } } void DebugCounter::print(raw_ostream &OS) const { SmallVector CounterNames(RegisteredCounters.begin(), RegisteredCounters.end()); sort(CounterNames); auto &Us = instance(); OS << "Counters and values:\n"; for (auto &CounterName : CounterNames) { unsigned CounterID = getCounterId(std::string(CounterName)); OS << left_justify(RegisteredCounters[CounterID], 32) << ": {" << Us.Counters[CounterID].Count << "," << Us.Counters[CounterID].Skip << "," << Us.Counters[CounterID].StopAfter << "}\n"; } } LLVM_DUMP_METHOD void DebugCounter::dump() const { print(dbgs()); }