Update verbosity handling (#201)

This PR updates verbosity handling in the compiler.

I have added verbosity settings to the QSSConfig object and enabled
setting it through both environment variables and through the CLI. The
levels I set are similar to traditional c++ compiler levels, (error,
warn, info, debug), with each level including all messages from the
prior level. The default is Warn.

I've also propagated this to the Payload class, and have set it to
suppress the current output there by default.

Ideally I think this info should propagate to the Target system, but
what I've done here is enough to suppress most of our current output
using the Warn level.

Author: mbhealy

include/Config/CLIConfig.h

@@ -1,6 +1,6 @@
 //===- CLIConfig.h - CLI Configuration builder ------------------*- C++ -*-===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // Any modifications or derivative works of this code must retain this
 // copyright notice, and modified files need to carry a notice indicating

include/Config/EnvVarConfig.h

@@ -1,6 +1,6 @@
 //===- EnvVarConfig.h - EnvVar Configuration builder ----------*- C++-*----===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // Any modifications or derivative works of this code must retain this
 // copyright notice, and modified files need to carry a notice indicating
@@ -37,6 +37,7 @@ class EnvVarConfigBuilder : public QSSConfigBuilder {
 private:
   llvm::Error populateConfigurationPath_(QSSConfig &config);
   llvm::Error populateTarget_(QSSConfig &config);
+  llvm::Error populateVerbosity_(QSSConfig &config);
 };
 
 } // namespace qssc::config

include/Config/QSSConfig.h

@@ -1,6 +1,6 @@
 //===- QSSConfig.h - Global QSS config ----------------*- C++ -*-----------===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // Any modifications or derivative works of this code must retain this
 // copyright notice, and modified files need to carry a notice indicating
@@ -27,6 +27,14 @@
 
 namespace qssc::config {
 
+enum QSSVerbosity {
+  Error = 0,
+  Warn = 1,
+  Info = 2,
+  Debug = 3,
+  _VerbosityCnt = 4
+};
+
 enum class EmitAction { None, AST, ASTPretty, MLIR, WaveMem, QEM, QEQEM };
 
 enum class FileExtension {
@@ -120,6 +128,12 @@ struct QSSConfig : mlir::MlirOptMainConfig {
   }
   EmitAction getEmitAction() const { return emitAction; }
 
+  QSSConfig &setVerbosityLevel(QSSVerbosity level) {
+    verbosityLevel = level;
+    return *this;
+  }
+  QSSVerbosity getVerbosityLevel() const { return verbosityLevel; }
+
   QSSConfig &addTargetPasses(bool flag) {
     addTargetPassesFlag = flag;
     return *this;
@@ -202,6 +216,8 @@ struct QSSConfig : mlir::MlirOptMainConfig {
   InputType inputType = InputType::None;
   /// @brief Output action to take
   EmitAction emitAction = EmitAction::None;
+  /// @brief Verbosity level for logging info
+  QSSVerbosity verbosityLevel = QSSVerbosity::Warn;
   /// @brief Register target passes with the compiler.
   bool addTargetPassesFlag = true;
   /// @brief Should available targets be printed

include/Payload/Payload.h

@@ -1,6 +1,6 @@
 //===- Payload.h ------------------------------------------------*- C++ -*-===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // This code is part of Qiskit.
 //
@@ -21,6 +21,8 @@
 #ifndef PAYLOAD_PAYLOAD_H
 #define PAYLOAD_PAYLOAD_H
 
+#include <Config/QSSConfig.h>
+
 #include <filesystem>
 #include <iostream>
 #include <mutex>
@@ -36,6 +38,7 @@ namespace qssc::payload {
 struct PayloadConfig {
   std::string prefix;
   std::string name;
+  qssc::config::QSSVerbosity verbosity;
 };
 
 // Payload class will wrap the QSS Payload and interface with the qss-compiler
@@ -44,9 +47,11 @@ class Payload {
   using PluginConfiguration = PayloadConfig;
 
 public:
-  Payload() : prefix(""), name("exp") {}
+  Payload()
+      : prefix(""), name("exp"), verbosity(qssc::config::QSSVerbosity::Warn) {}
   explicit Payload(PayloadConfig config)
-      : prefix(std::move(config.prefix) + "/"), name(std::move(config.name)) {
+      : prefix(std::move(config.prefix) + "/"), name(std::move(config.name)),
+        verbosity(config.verbosity) {
     files.clear();
   }
   virtual ~Payload() = default;
@@ -83,6 +88,7 @@ class Payload {
 
   std::string prefix;
   std::string name;
+  qssc::config::QSSVerbosity verbosity;
   std::unordered_map<std::filesystem::path, std::string, PathHash> files;
 }; // class Payload
 

lib/API/api.cpp

@@ -1,6 +1,6 @@
 //===- api.cpp --------------------------------------------------*- C++ -*-===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // This code is part of Qiskit.
 //
@@ -486,8 +486,8 @@ llvm::Error compile_(int argc, char const **argv, std::string *outputString,
       payload = std::move(
           payloadInfo.value()->createPluginInstance(std::nullopt).get());
     } else {
-      const qssc::payload::PayloadConfig payloadConfig{fNamePrefix,
-                                                       fNamePrefix};
+      const qssc::payload::PayloadConfig payloadConfig{
+          fNamePrefix, fNamePrefix, config.getVerbosityLevel()};
       payload = std::move(
           payloadInfo.value()->createPluginInstance(payloadConfig).get());
     }

lib/Config/CLIConfig.cpp

@@ -1,6 +1,6 @@
 //===- CLIConfigBuilder.cpp - QSSConfig from the CLI ------*- C++ -*-------===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // Any modifications or derivative works of this code must retain this
 // copyright notice, and modified files need to carry a notice indicating
@@ -311,6 +311,21 @@ struct QSSConfigCLOptions : public QSSConfig {
     static mlir::PassPipelineCLParser const passPipeline(
         "", "Compiler passes to run", "p");
     setPassPipelineParser(passPipeline);
+
+    static llvm::cl::opt<enum QSSVerbosity, /*ExternalStorage=*/true> const
+        verbosity(
+            "verbosity", llvm::cl::location(verbosityLevel),
+            llvm::cl::init(QSSVerbosity::_VerbosityCnt),
+            llvm::cl::desc("Set verbosity level for output, default is warn"),
+            llvm::cl::values(
+                clEnumValN(QSSVerbosity::Error, "error", "Emit only errors")),
+            llvm::cl::values(
+                clEnumValN(QSSVerbosity::Warn, "warn", "Also emit warnings")),
+            llvm::cl::values(clEnumValN(QSSVerbosity::Info, "info",
+                                        "Also emit informational messages")),
+            llvm::cl::values(clEnumValN(QSSVerbosity::Debug, "debug",
+                                        "Also emit debug messages")),
+            llvm::cl::cat(qssc::config::getQSSOptCLCategory()));
   }
 
   /// Pointer to static dialectPlugins variable in constructor, needed by
@@ -403,6 +418,9 @@ llvm::Error CLIConfigBuilder::populateConfig(QSSConfig &config) {
   if (auto err = clOptionsConfig->computeOutputType())
     return err;
 
+  if (clOptionsConfig->verbosityLevel != QSSVerbosity::_VerbosityCnt)
+    config.verbosityLevel = clOptionsConfig->verbosityLevel;
+
   // qss
   config.inputSource = clOptionsConfig->inputSource;
   config.directInputFlag = clOptionsConfig->directInputFlag;

lib/Config/EnvVarConfig.cpp

@@ -1,6 +1,6 @@
 //===- EnvVarConfigBuilder.cpp - QSSConfig from EnvVars  ----* C++*--------===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // Any modifications or derivative works of this code must retain this
 // copyright notice, and modified files need to carry a notice indicating
@@ -15,9 +15,11 @@
 #include "Config/EnvVarConfig.h"
 #include "Config/QSSConfig.h"
 
+#include "llvm/ADT/StringRef.h"
 #include "llvm/Support/Error.h"
 
 #include <cstdlib>
+#include <cstring>
 
 using namespace qssc::config;
 
@@ -28,6 +30,9 @@ llvm::Error EnvVarConfigBuilder::populateConfig(QSSConfig &config) {
   if (auto err = populateTarget_(config))
     return err;
 
+  if (auto err = populateVerbosity_(config))
+    return err;
+
   return llvm::Error::success();
 }
 
@@ -42,3 +47,24 @@ llvm::Error EnvVarConfigBuilder::populateTarget_(QSSConfig &config) {
     config.targetName = targetStr;
   return llvm::Error::success();
 }
+
+llvm::Error EnvVarConfigBuilder::populateVerbosity_(QSSConfig &config) {
+  if (const char *verbosity = std::getenv("QSSC_VERBOSITY")) {
+    if (strcmp(verbosity, "ERROR") == 0) {
+      config.setVerbosityLevel(QSSVerbosity::Error);
+    } else if (strcmp(verbosity, "WARN") == 0) {
+      config.setVerbosityLevel(QSSVerbosity::Warn);
+    } else if (strcmp(verbosity, "INFO") == 0) {
+      config.setVerbosityLevel(QSSVerbosity::Info);
+    } else if (strcmp(verbosity, "DEBUG") == 0) {
+      config.setVerbosityLevel(QSSVerbosity::Debug);
+    } else {
+      return llvm::createStringError(
+          llvm::inconvertibleErrorCode(),
+          "QSSC_VERBOSITY level unrecognized got (" +
+              llvm::StringRef(verbosity) +
+              "), options are ERROR, WARN, INFO, or DEBUG\n");
+    }
+  }
+  return llvm::Error::success();
+}

lib/Config/QSSConfig.cpp

@@ -29,12 +29,21 @@
 #include "llvm/Support/raw_os_ostream.h"
 #include "llvm/Support/raw_ostream.h"
 
+#include <array>
 #include <ostream>
 #include <string>
 #include <utility>
 
 using namespace qssc::config;
 
+/// Verbosity levels for logging output
+/// Error - Only error messages will be logged
+/// Warn  - Warnings and errors *default
+/// Info  - General information on compilation progress
+/// Debug - Detailed output
+const std::array<const std::string, _VerbosityCnt> verbosityToStr = {
+    "Error", "Warn", "Info", "Debug"};
+
 // For now emit in a pseudo-TOML format.
 void qssc::config::QSSConfig::emit(llvm::raw_ostream &os) const {
   // Compiler configuration
@@ -53,6 +62,8 @@ void qssc::config::QSSConfig::emit(llvm::raw_ostream &os) const {
      << (getTargetConfigPath().has_value() ? getTargetConfigPath().value()
                                            : "None")
      << "\n";
+  os << "verbosity: "
+     << verbosityToStr[static_cast<unsigned int>(getVerbosityLevel())] << "\n";
   os << "addTargetPasses: " << shouldAddTargetPasses() << "\n";
   os << "showTargets: " << shouldShowTargets() << "\n";
   os << "showPayloads: " << shouldShowPayloads() << "\n";

lib/Payload/ZipPayload/ZipPayload.cpp

@@ -1,6 +1,6 @@
 //===- ZipPayload.cpp -------------------------------------------*- C++ -*-===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // This code is part of Qiskit.
 //
@@ -25,6 +25,7 @@
 
 #include "Config.h"
 #include "Payload/PayloadRegistry.h"
+#include <Config/QSSConfig.h>
 
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/raw_os_ostream.h"
@@ -148,7 +149,8 @@ void setFilePermissions(zip_int64_t fileIndex, fs::path &fName,
 } // end anonymous namespace
 
 void ZipPayload::writeZip(llvm::raw_ostream &stream) {
-  llvm::outs() << "Writing zip to stream\n";
+  if (verbosity >= qssc::config::QSSVerbosity::Info)
+    llvm::outs() << "Writing zip to stream\n";
   // first add the manifest
   addManifest();
 
@@ -184,12 +186,14 @@ void ZipPayload::writeZip(llvm::raw_ostream &stream) {
   }
   zip_error_fini(&error);
 
-  llvm::outs() << "Zip buffer created, adding files to archive\n";
+  if (verbosity >= qssc::config::QSSVerbosity::Info)
+    llvm::outs() << "Zip buffer created, adding files to archive\n";
   // archive is now allocated and created, need to fill it with files/data
   std::vector<fs::path> orderedNames = orderedFileNames();
   for (auto &fName : orderedNames) {
-    llvm::outs() << "Adding file " << fName << " to archive buffer ("
-                 << files[fName].size() << " bytes)\n";
+    if (verbosity >= qssc::config::QSSVerbosity::Info)
+      llvm::outs() << "Adding file " << fName << " to archive buffer ("
+                   << files[fName].size() << " bytes)\n";
 
     //===---- Add file ----===//
     // init the error object
@@ -230,6 +234,8 @@ void ZipPayload::writeZip(llvm::raw_ostream &stream) {
   //===---- Reopen for copying ----===//
   zip_int64_t sz;
   char *outbuffer = read_zip_src_to_buffer(new_archive_src, sz);
+  if (verbosity >= qssc::config::QSSVerbosity::Info)
+    llvm::outs() << "Zip buffer is of size " << sz << " bytes\n";
   if (outbuffer) {
     // output the new archive to the stream
     stream.write(outbuffer, sz);

lib/Payload/ZipPayload/ZipUtil.cpp

@@ -1,6 +1,6 @@
 //===- ZipUtil.cpp ----------------------------------------------*- C++ -*-===//
 //
-// (C) Copyright IBM 2023.
+// (C) Copyright IBM 2023, 2024.
 //
 // This code is part of Qiskit.
 //
@@ -36,7 +36,6 @@ char *qssc::payload::read_zip_src_to_buffer(zip_source_t *zip_src,
   zip_source_seek(zip_src, 0, SEEK_END);
   // get the number of bytes
   sz = zip_source_tell(zip_src);
-  llvm::outs() << "Zip buffer is of size " << sz << " bytes\n";
 
   // allocate a new buffer to copy the archive into
   char *outbuffer = (char *)malloc(sz);