Implement a new command line option, -debug, which is meant to unify all of

the random debugging macros scattered throughout llvm.

The new DEBUG(x) macro should be used instead of special purpose debug macros.

llvm-svn: 2709

5 files changed, 51 insertions, 0 deletions

diff --git a/llvm/include/Support/Statistic.h b/llvm/include/Support/Statistic.h
index 5c464865ed1..453af34fe01 100644
--- a/llvm/include/Support/Statistic.h
+++ b/llvm/include/Support/Statistic.h
@@ -19,6 +19,27 @@
 
 #include <iosfwd>
 
+// DebugFlag - This boolean is set to true if the '-debug' command line option
+// is specified.  This should probably not be referenced directly, instead, use
+// the DEBUG macro below.
+//
+extern bool DebugFlag;
+
+// DEBUG macro - This macro should be used by passes to emit debug information.
+// In the '-debug' option is specified on the commandline, and if this is a
+// debug build, then the code specified as the option to the macro will be
+// executed.  Otherwise it will not be.  Example:
+//
+// DEBUG(cerr << "Bitset contains: " << Bitset << "\n");
+//
+#ifdef NDEBUG
+#define DEBUG(X)
+#else
+#define DEBUG(X) \
+  do { if (DebugFlag) { X; } } while (0)
+#endif
+
+
 // StatisticBase - Nontemplated base class for Statistic<> class...
 class StatisticBase {
   const char *Name;
diff --git a/llvm/include/Support/StatisticReporter.h b/llvm/include/Support/StatisticReporter.h
index 5c464865ed1..453af34fe01 100644
--- a/llvm/include/Support/StatisticReporter.h
+++ b/llvm/include/Support/StatisticReporter.h
@@ -19,6 +19,27 @@
 
 #include <iosfwd>
 
+// DebugFlag - This boolean is set to true if the '-debug' command line option
+// is specified.  This should probably not be referenced directly, instead, use
+// the DEBUG macro below.
+//
+extern bool DebugFlag;
+
+// DEBUG macro - This macro should be used by passes to emit debug information.
+// In the '-debug' option is specified on the commandline, and if this is a
+// debug build, then the code specified as the option to the macro will be
+// executed.  Otherwise it will not be.  Example:
+//
+// DEBUG(cerr << "Bitset contains: " << Bitset << "\n");
+//
+#ifdef NDEBUG
+#define DEBUG(X)
+#else
+#define DEBUG(X) \
+  do { if (DebugFlag) { X; } } while (0)
+#endif
+
+
 // StatisticBase - Nontemplated base class for Statistic<> class...
 class StatisticBase {
   const char *Name;
diff --git a/llvm/lib/Support/Statistic.cpp b/llvm/lib/Support/Statistic.cpp
index 79b19503b72..249955beeb8 100644
--- a/llvm/lib/Support/Statistic.cpp
+++ b/llvm/lib/Support/Statistic.cpp
@@ -18,7 +18,10 @@
 #include "Support/CommandLine.h"
 #include <iostream>
 
+bool DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
+
 static cl::Flag Enabled("stats", "Enable statistics output from program");
+static cl::Flag Debug(DebugFlag, "debug", "Enable debug output", cl::Hidden);
 
 // Print information when destroyed, iff command line option is specified
 void StatisticBase::destroy() const {
diff --git a/llvm/support/lib/Support/Statistic.cpp b/llvm/support/lib/Support/Statistic.cpp
index 79b19503b72..249955beeb8 100644
--- a/llvm/support/lib/Support/Statistic.cpp
+++ b/llvm/support/lib/Support/Statistic.cpp
@@ -18,7 +18,10 @@
 #include "Support/CommandLine.h"
 #include <iostream>
 
+bool DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
+
 static cl::Flag Enabled("stats", "Enable statistics output from program");
+static cl::Flag Debug(DebugFlag, "debug", "Enable debug output", cl::Hidden);
 
 // Print information when destroyed, iff command line option is specified
 void StatisticBase::destroy() const {
diff --git a/llvm/support/lib/Support/StatisticReporter.cpp b/llvm/support/lib/Support/StatisticReporter.cpp
index 79b19503b72..249955beeb8 100644
--- a/llvm/support/lib/Support/StatisticReporter.cpp
+++ b/llvm/support/lib/Support/StatisticReporter.cpp
@@ -18,7 +18,10 @@
 #include "Support/CommandLine.h"
 #include <iostream>
 
+bool DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
+
 static cl::Flag Enabled("stats", "Enable statistics output from program");
+static cl::Flag Debug(DebugFlag, "debug", "Enable debug output", cl::Hidden);
 
 // Print information when destroyed, iff command line option is specified
 void StatisticBase::destroy() const {