[alf] Disable debug logging by default

AliceO2Group · Dec 1, 2021 · a8ebf15 · a8ebf15
1 parent bd66b65
commit a8ebf15
Show file tree

Hide file tree

Showing 12 changed files with 86 additions and 27 deletions.
diff --git a/apps/Alf.cxx b/apps/Alf.cxx
@@ -65,7 +65,7 @@ class Alf : public AliceO2::Common::Program
 
   virtual void run(const po::variables_map&) override
   {
-    //verbose = isVerbose();
+    kDebugLogging = isVerbose();
 
     Logger::setFacility("ALF");
     Logger::get() << "ALF server starting..." << LogInfoOps << endm;

diff --git a/apps/AlfClient.cxx b/apps/AlfClient.cxx
@@ -101,6 +101,8 @@ class AlfClient : public AliceO2::Common::Program
 
   virtual void run(const po::variables_map&) override
   {
+    kDebugLogging = isVerbose();
+
     Logger::enableInfoLogger(false);
     Logger::setFacility("ALF/Client");
     if (mOptions.alfId == "") {

diff --git a/apps/AlfLibClient.cxx b/apps/AlfLibClient.cxx
@@ -65,6 +65,8 @@ class AlfLibClient : public AliceO2::Common::Program
 
   virtual void run(const po::variables_map&) override
   {
+    kDebugLogging = isVerbose();
+
     Logger::enableInfoLogger(false);
     Logger::setFacility("ALF/LibClient");
     if (mOptions.sca) {

diff --git a/src/AlfClient.h b/src/AlfClient.h
@@ -52,7 +52,9 @@ class RegisterReadRpc : DimRpcInfoWrapper
       toConvert = stripPrefix(getString());
       converted = Util::stringToHex(toConvert);
     } catch (const AlfException& e) {
-      Logger::get() << "RegisterReadRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "RegisterReadRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errHex;
     }
 
@@ -74,7 +76,9 @@ class RegisterWriteRpc : DimRpcInfoWrapper
     try {
       getString();
     } catch (const AlfException& e) {
-      Logger::get() << "RegisterWriteRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "RegisterWriteRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
     }
   }
 };
@@ -93,7 +97,9 @@ class PatternPlayerRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "PatternPlayerRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "PatternPlayerRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;
@@ -127,7 +133,9 @@ class ScaSequenceRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "ScaSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "ScaSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;
@@ -165,7 +173,9 @@ class RegisterSequenceRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "RegisterSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "RegisterSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;
@@ -203,7 +213,9 @@ class SwtSequenceRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "SwtSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "SwtSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;
@@ -241,7 +253,9 @@ class IcSequenceRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "IcSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "IcSequence: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;
@@ -278,7 +292,9 @@ class IcGbtI2cWriteRpc : DimRpcInfoWrapper
     try {
       getString();
     } catch (const AlfException& e) {
-      Logger::get() << "IcGbtI2cWriteRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "IcGbtI2cWriteRpc: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
     }
   }
 };
@@ -298,7 +314,9 @@ class LlaSessionStartRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "LlaSessionStart: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "LlaSessionStart: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;
@@ -331,7 +349,9 @@ class LlaSessionStopRpc : DimRpcInfoWrapper
     try {
       ret = getString();
     } catch (const AlfException& e) {
-      Logger::get() << "LlaSessionStop: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << "LlaSessionStop: " << boost::diagnostic_information(e, true) << LogErrorDevel << endm;
+      }
       return errString;
     }
     return ret;

diff --git a/src/DimServices/DimServices.cxx b/src/DimServices/DimServices.cxx
@@ -94,7 +94,9 @@ void StringRpcServer::rpcHandler()
     auto returnValue = mCallback(std::string(getString()));
     setDataString(makeSuccessString(returnValue), *this);
   } catch (const std::exception& e) {
-    Logger::get() << mServiceName << ": " << e.what() << LogErrorDevel << endm;
+    if (kDebugLogging) {
+      Logger::get() << mServiceName << ": " << e.what() << LogErrorDevel << endm;
+    }
     setDataString(makeFailureString(e.what()), *this);
   }
 }

diff --git a/src/DimServices/DimServices.h b/src/DimServices/DimServices.h
@@ -102,7 +102,7 @@ class DimRpcInfoWrapper
   std::string getString()
   {
     auto str = std::string(mRpcInfo->getString());
-    if (isFailure(str)) {
+    if (isFailure(str) && kDebugLogging) {
       Logger::get() << "ALF server failure: " << str << LogErrorDevel << endm;
     }
     return str;

diff --git a/src/Ic.cxx b/src/Ic.cxx
@@ -48,7 +48,9 @@ namespace alf
 Ic::Ic(AlfLink link, std::shared_ptr<lla::Session> llaSession)
   : ScBase(link, llaSession)
 {
-  Logger::setFacility("ALF/IC");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/IC");
+  }
 
   // Set CFG to 0x3 by default
   barWrite(sc_regs::IC_WR_CFG.index, 0x3);
@@ -57,7 +59,9 @@ Ic::Ic(AlfLink link, std::shared_ptr<lla::Session> llaSession)
 Ic::Ic(const roc::Parameters::CardIdType& cardId, int linkId)
   : ScBase(cardId, linkId)
 {
-  Logger::setFacility("ALF/IC");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/IC");
+  }
 
   // Set CFG to 0x3 by default
   barWrite(sc_regs::IC_WR_CFG.index, 0x3);
@@ -66,7 +70,9 @@ Ic::Ic(const roc::Parameters::CardIdType& cardId, int linkId)
 Ic::Ic(std::string cardId, int linkId)
   : ScBase(cardId, linkId)
 {
-  Logger::setFacility("ALF/IC");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/IC");
+  }
 
   // Set CFG to 0x3 by default
   barWrite(sc_regs::IC_WR_CFG.index, 0x3);
@@ -204,7 +210,9 @@ std::string Ic::writeSequence(std::vector<std::pair<Operation, Data>> ops, bool
     } else if (operation == Operation::Error) {
       std::string errMessage = boost::get<std::string>(data);
       resultBuffer << errMessage;
-      Logger::get() << errMessage << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << errMessage << LogErrorDevel << endm;
+      }
       BOOST_THROW_EXCEPTION(IcException() << ErrorInfo::Message(resultBuffer.str()));
     }
   }

diff --git a/src/Logger.h b/src/Logger.h
@@ -23,4 +23,6 @@
 typedef AliceO2::roc::Logger Logger;
 constexpr auto endm = AliceO2::roc::endm;
 
+extern bool kDebugLogging;
+
 #endif // O2_ALF_LOGGER_H_
diff --git a/src/ScBase.cxx b/src/ScBase.cxx
@@ -32,6 +32,9 @@
 #include "Logger.h"
 #include "Util.h"
 
+// hijacking this file to define an extern variable for the Logger
+bool kDebugLogging;
+
 namespace sc_regs = AliceO2::roc::Cru::ScRegisters;
 
 namespace o2

diff --git a/src/Sca.cxx b/src/Sca.cxx
@@ -43,19 +43,25 @@ namespace alf
 Sca::Sca(AlfLink link, std::shared_ptr<lla::Session> llaSession)
   : ScBase(link, llaSession)
 {
-  Logger::setFacility("ALF/SCA");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SCA");
+  }
 }
 
 Sca::Sca(const roc::Parameters::CardIdType& cardId, int linkId)
   : ScBase(cardId, linkId)
 {
-  Logger::setFacility("ALF/SCA");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SCA");
+  }
 }
 
 Sca::Sca(std::string cardId, int linkId)
   : ScBase(cardId, linkId)
 {
-  Logger::setFacility("ALF/SCA");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SCA");
+  }
 }
 
 void Sca::svlReset()
@@ -304,7 +310,9 @@ std::string Sca::writeSequence(const std::vector<std::pair<Operation, Data>>& op
       resultBuffer << "svl_connect\n"; // echo
     } else if (operation == Operation::Error) {
       resultBuffer << data; // "[error_msg]"
-      Logger::get() << data << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << data << LogErrorDevel << endm;
+      }
       BOOST_THROW_EXCEPTION(ScaException() << ErrorInfo::Message(resultBuffer.str()));
       break;
     }

diff --git a/src/ScaMftPsu.cxx b/src/ScaMftPsu.cxx
@@ -43,7 +43,9 @@ namespace alf
 ScaMftPsu::ScaMftPsu(AlfLink link, std::shared_ptr<lla::Session> llaSession)
   : mLink(link), mBar2(mLink.bar)
 {
-  Logger::setFacility("ALF/SCA_MFT_PSU");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SCA_MFT_PSU");
+  }
   mLlaSession = std::make_unique<LlaSession>(llaSession);
   mLink.rawLinkId = mLink.serialId.getEndpoint() * kCruNumLinks + mLink.linkId;
 }
@@ -326,7 +328,9 @@ std::string ScaMftPsu::writeSequence(const std::vector<std::pair<Operation, Data
       resultBuffer << "slave\n"; // echo
     } else if (operation == Operation::Error) {
       resultBuffer << data; // "[error_msg]"
-      Logger::get() << data << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << data << LogErrorDevel << endm;
+      }
       BOOST_THROW_EXCEPTION(ScaMftPsuException() << ErrorInfo::Message(resultBuffer.str()));
       break;
     }

diff --git a/src/Swt.cxx b/src/Swt.cxx
@@ -47,19 +47,25 @@ namespace sc_regs = AliceO2::roc::Cru::ScRegisters;
 Swt::Swt(AlfLink link, std::shared_ptr<lla::Session> llaSession)
   : ScBase(link, llaSession)
 {
-  Logger::setFacility("ALF/SWT");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SWT");
+  }
 }
 
 Swt::Swt(const roc::Parameters::CardIdType& cardId, int linkId)
   : ScBase(cardId, linkId)
 {
-  Logger::setFacility("ALF/SWT");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SWT");
+  }
 }
 
 Swt::Swt(std::string cardId, int linkId)
   : ScBase(cardId, linkId)
 {
-  Logger::setFacility("ALF/SWT");
+  if (kDebugLogging) {
+    Logger::setFacility("ALF/SWT");
+  }
 }
 
 std::vector<SwtWord> Swt::read(SwtWord::Size wordSize, TimeOut msTimeOut)
@@ -210,7 +216,9 @@ std::string Swt::writeSequence(std::vector<std::pair<Operation, Data>> sequence,
       resultBuffer << std::dec << data << "\n";
     } else if (operation == Operation::Error) {
       resultBuffer << data;
-      Logger::get() << data << LogErrorDevel << endm;
+      if (kDebugLogging) {
+        Logger::get() << data << LogErrorDevel << endm;
+      }
       BOOST_THROW_EXCEPTION(SwtException() << ErrorInfo::Message(resultBuffer.str()));
       break;
     }