Added debug logs configuration

Author: AndreyPavlenko

include/gc/Utils/Error.h

@@ -33,7 +33,7 @@ namespace mlir::gc::err {
 
 template <typename... Args>
 [[nodiscard]] llvm::Error makeLlvmError(GC_ERR_LOC_DECL Args... args) {
-  log::insetLog(GC_ERR_LOC_ARGS std::cerr, "ERROR", args...);
+  log::log(GC_ERR_LOC_ARGS std::cerr, "ERROR", args...);
   std::ostringstream oss;
   log::insertArgs(oss, args...);
   auto msg = oss.str();
@@ -42,7 +42,7 @@ template <typename... Args>
 }
 
 [[noreturn]] static void report(GC_ERR_LOC_DECL llvm::Error err) {
-  log::insetLog(GC_ERR_LOC_ARGS std::cerr, "ERROR", "Unrecoverable error!");
+  log::log(GC_ERR_LOC_ARGS std::cerr, "ERROR", "Unrecoverable error!");
   report_fatal_error(std::move(err));
 }
 

include/gc/Utils/Log.h

@@ -10,6 +10,10 @@
 #define GC_LOG_H
 #include <iostream>
 
+#ifndef NDEBUG
+#include <regex>
+#endif
+
 namespace mlir::gc::log {
 static void insertArgs(std::ostream &stream) { stream << std::endl; }
 
@@ -20,7 +24,7 @@ static void insertArgs(std::ostream &stream, T first, Args... args) {
 }
 
 template <typename... Args>
-static void insetLog(
+static void log(
 #ifndef NDEBUG
     const char *fileName, int lineNum,
 #endif
@@ -36,16 +40,35 @@ static void insetLog(
 #define gcLogD(...)
 #define gcLogE(...) mlir::gc::log::insetLog(std::cerr, "ERROR", __VA_ARGS__)
 #else
-#define _insetLog(stream, pref, ...)                                           \
-  mlir::gc::log::insetLog(__FILE__, __LINE__, stream, pref, __VA_ARGS__)
-#define gcLogD(...) _insetLog(std::cout, "DEBUG", __VA_ARGS__)
-#define gcLogE(...) _insetLog(std::cerr, "ERROR", __VA_ARGS__)
-#endif
-} // namespace mlir::gc::log
 
-#ifdef GC_LOG_NO_DEBUG
-#undef gcLogD
-#define gcLogD(...)
+// The debug logs are enabled by setting the environment variable GC_DEBUG to a
+// regex pattern. The pattern is matched against the file name where the log is
+// called. Examples:
+//   GC_DEBUG=.*  - Enable all debug logs.
+//   GC_DEBUG=/(CPU|GPU)Runtime/  - Enable debug logs in files containing
+//   CPURuntime or GPURuntime in the path.
+static bool isDebugEnabled(const char *fileName) {
+  static std::regex pattern = []() {
+    auto env = std::getenv("GC_DEBUG");
+    return env ? std::regex(env, std::regex::extended)
+               : std::regex("", std::regex::basic);
+  }();
+  // The flag 'basic' is used as a marker for an empty regex.
+  return pattern.flags() != std::regex::basic &&
+         std::regex_search(fileName, pattern);
+}
+
+template <typename... Args>
+static void debug(const char *fileName, int lineNum, Args... args) {
+  if (isDebugEnabled(fileName)) {
+    log(fileName, lineNum, std::cout, "DEBUG", args...);
+  }
+}
+
+#define gcLogD(...) mlir::gc::log::debug(__FILE__, __LINE__, __VA_ARGS__)
+#define gcLogE(...)                                                            \
+  mlir::gc::log::log(__FILE__, __LINE__, std::cerr, "ERROR", __VA_ARGS__)
 #endif
+} // namespace mlir::gc::log
 
 #endif

lib/gc/ExecutionEngine/GPURuntime/ocl/GpuOclRuntime.cpp

@@ -8,8 +8,6 @@
 
 #include <CL/cl_ext.h>
 
-// Comment out the following line to enable debug logging
-// #define GC_LOG_NO_DEBUG
 #include "gc/ExecutionEngine/GPURuntime/GpuOclRuntime.h"
 #include "gc/Transforms/Passes.h"
 #include "gc/Utils/Error.h"
@@ -569,7 +567,7 @@ bool OclRuntime::isUsm(const void *ptr) const {
 #ifndef NDEBUG
 void OclRuntime::debug(const char *file, int line, const char *msg) {
 #ifndef GC_LOG_NO_DEBUG
-  mlir::gc::log::insetLog(file, line, std::cout, "DEBUG", msg);
+  log::debug(file, line, msg);
 #endif
 }
 #endif