contrib/llvm/include/llvm/Support/DebugCounter.h

   1 //===- llvm/Support/DebugCounter.h - Debug counter support ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 /// \file
  10 /// This file provides an implementation of debug counters.  Debug
  11 /// counters are a tool that let you narrow down a miscompilation to a specific
  12 /// thing happening.
  13 ///
  14 /// To give a use case: Imagine you have a file, very large, and you
  15 /// are trying to understand the minimal transformation that breaks it. Bugpoint
  16 /// and bisection is often helpful here in narrowing it down to a specific pass,
  17 /// but it's still a very large file, and a very complicated pass to try to
  18 /// debug.  That is where debug counting steps in.  You can instrument the pass
  19 /// with a debug counter before it does a certain thing, and depending on the
  20 /// counts, it will either execute that thing or not.  The debug counter itself
  21 /// consists of a skip and a count.  Skip is the number of times shouldExecute
  22 /// needs to be called before it returns true.  Count is the number of times to
  23 /// return true once Skip is 0.  So a skip=47, count=2 ,would skip the first 47
  24 /// executions by returning false from shouldExecute, then execute twice, and
  25 /// then return false again.
  26 /// Note that a counter set to a negative number will always execute.
  27 /// For a concrete example, during predicateinfo creation, the renaming pass
  28 /// replaces each use with a renamed use.
  29 ////
  30 /// If I use DEBUG_COUNTER to create a counter called "predicateinfo", and
  31 /// variable name RenameCounter, and then instrument this renaming with a debug
  32 /// counter, like so:
  33 ///
  34 /// if (!DebugCounter::shouldExecute(RenameCounter)
  35 /// <continue or return or whatever not executing looks like>
  36 ///
  37 /// Now I can, from the command line, make it rename or not rename certain uses
  38 /// by setting the skip and count.
  39 /// So for example
  40 /// bin/opt -debug-counter=predicateinfo-skip=47,predicateinfo-count=1
  41 /// will skip renaming the first 47 uses, then rename one, then skip the rest.
  42 //===----------------------------------------------------------------------===//
  43
  44 #ifndef LLVM_SUPPORT_DEBUGCOUNTER_H
  45 #define LLVM_SUPPORT_DEBUGCOUNTER_H
  46
  47 #include "llvm/ADT/DenseMap.h"
  48 #include "llvm/ADT/UniqueVector.h"
  49 #include "llvm/Support/CommandLine.h"
  50 #include "llvm/Support/Debug.h"
  51 #include "llvm/Support/raw_ostream.h"
  52 #include <string>
  53
  54 namespace llvm {
  55
  56 class DebugCounter {
  57 public:
  58   /// Returns a reference to the singleton instance.
  59   static DebugCounter &instance();
  60
  61   // Used by the command line option parser to push a new value it parsed.
  62   void push_back(const std::string &);
  63
  64   // Register a counter with the specified name.
  65   //
  66   // FIXME: Currently, counter registration is required to happen before command
  67   // line option parsing. The main reason to register counters is to produce a
  68   // nice list of them on the command line, but i'm not sure this is worth it.
  69   static unsigned registerCounter(StringRef Name, StringRef Desc) {
  70     return instance().addCounter(Name, Desc);
  71   }
  72   inline static bool shouldExecute(unsigned CounterName) {
  73 // Compile to nothing when debugging is off
  74 #ifdef NDEBUG
  75     return true;
  76 #else
  77     auto &Us = instance();
  78     auto Result = Us.Counters.find(CounterName);
  79     if (Result != Us.Counters.end()) {
  80       auto &CounterInfo = Result->second;
  81       ++CounterInfo.Count;
  82
  83       // We only execute while the Skip is not smaller than Count,
  84       // and the StopAfter + Skip is larger than Count.
  85       // Negative counters always execute.
  86       if (CounterInfo.Skip < 0)
  87         return true;
  88       if (CounterInfo.Skip >= CounterInfo.Count)
  89         return false;
  90       if (CounterInfo.StopAfter < 0)
  91         return true;
  92       return CounterInfo.StopAfter + CounterInfo.Skip >= CounterInfo.Count;
  93     }
  94     // Didn't find the counter, should we warn?
  95     return true;
  96 #endif // NDEBUG
  97   }
  98
  99   // Return true if a given counter had values set (either programatically or on
 100   // the command line).  This will return true even if those values are
 101   // currently in a state where the counter will always execute.
 102   static bool isCounterSet(unsigned ID) {
 103     return instance().Counters[ID].IsSet;
 104   }
 105
 106   // Return the Count for a counter. This only works for set counters.
 107   static int64_t getCounterValue(unsigned ID) {
 108     auto &Us = instance();
 109     auto Result = Us.Counters.find(ID);
 110     assert(Result != Us.Counters.end() && "Asking about a non-set counter");
 111     return Result->second.Count;
 112   }
 113
 114   // Set a registered counter to a given Count value.
 115   static void setCounterValue(unsigned ID, int64_t Count) {
 116     auto &Us = instance();
 117     Us.Counters[ID].Count = Count;
 118   }
 119
 120   // Dump or print the current counter set into llvm::dbgs().
 121   LLVM_DUMP_METHOD void dump() const;
 122
 123   void print(raw_ostream &OS) const;
 124
 125   // Get the counter ID for a given named counter, or return 0 if none is found.
 126   unsigned getCounterId(const std::string &Name) const {
 127     return RegisteredCounters.idFor(Name);
 128   }
 129
 130   // Return the number of registered counters.
 131   unsigned int getNumCounters() const { return RegisteredCounters.size(); }
 132
 133   // Return the name and description of the counter with the given ID.
 134   std::pair<std::string, std::string> getCounterInfo(unsigned ID) const {
 135     return std::make_pair(RegisteredCounters[ID], Counters.lookup(ID).Desc);
 136   }
 137
 138   // Iterate through the registered counters
 139   typedef UniqueVector<std::string> CounterVector;
 140   CounterVector::const_iterator begin() const {
 141     return RegisteredCounters.begin();
 142   }
 143   CounterVector::const_iterator end() const { return RegisteredCounters.end(); }
 144
 145 private:
 146   unsigned addCounter(const std::string &Name, const std::string &Desc) {
 147     unsigned Result = RegisteredCounters.insert(Name);
 148     Counters[Result] = {};
 149     Counters[Result].Desc = Desc;
 150     return Result;
 151   }
 152   // Struct to store counter info.
 153   struct CounterInfo {
 154     int64_t Count = 0;
 155     int64_t Skip = 0;
 156     int64_t StopAfter = -1;
 157     bool IsSet = false;
 158     std::string Desc;
 159   };
 160   DenseMap<unsigned, CounterInfo> Counters;
 161   CounterVector RegisteredCounters;
 162 };
 163
 164 #define DEBUG_COUNTER(VARNAME, COUNTERNAME, DESC)                              \
 165   static const unsigned VARNAME =                                              \
 166       DebugCounter::registerCounter(COUNTERNAME, DESC)
 167
 168 } // namespace llvm
 169 #endif