Merge pull request #396 from sy-c/master

v0.40.0

Author: sy-c

doc/releaseNotes.md

@@ -12,3 +12,8 @@ This file describes the main feature changes for released versions of ReadoutCar
 
 ## v0.39.1 - 16/11/2022
 - Fixed CRORC start-stop-start: fifo ready counters reset, emptying last page if unused, flush order on stop, release of unused pages in internal fifo.
+
+## v0.40.0 - 08/12/2022
+- log messages level updated: moved all Ops messages to Devel. The calling layer is in charge to reporting high level operation messages.
+- superpage metadata: added link id.
+- added verbosity protection for "Empty counter of Superpage FIFO" warnings

include/ReadoutCard/Logger.h

@@ -30,6 +30,7 @@ constexpr auto endm = AliceO2::InfoLogger::InfoLogger::endm;
 
 typedef AliceO2::InfoLogger::InfoLoggerContext ILContext;
 typedef AliceO2::InfoLogger::InfoLogger::InfoLoggerMessageOption ILMessageOption;
+typedef AliceO2::InfoLogger::InfoLogger::AutoMuteToken ILAutoMuteToken;
 
 class Logger
 {

include/ReadoutCard/Superpage.h

@@ -103,12 +103,23 @@ struct Superpage {
     mUserData = userData;
   }
 
+  /// Set the link id
+  void setLink(int id = -1) {
+    mLink = id;
+  }
+
+  /// Get the link id
+  int getLink() {
+    return mLink;
+  }
+
  private:
   size_t mOffset = 0;        ///< Offset from the start of the DMA buffer to the start of the superpage
   size_t mSize = 0;          ///< Size of the superpage in bytes
   void* mUserData = nullptr; ///< Pointer that users can use for whatever, e.g. to associate data with the superpage
   size_t mReceived = 0;      ///< Size of the received data in bytes
   bool mReady = false;       ///< Indicates this superpage is ready
+  int mLink = -1;            ///< The link producing the data
 };
 
 } // namespace roc

src/BarInterfaceBase.h

@@ -129,7 +129,7 @@ class BarInterfaceBase : public BarInterface
   std::shared_ptr<Pda::PdaBar> mPdaBar;
 
   /// Convenience function for InfoLogger
-  void log(const std::string& logMessage, ILMessageOption = LogInfoOps);
+  void log(const std::string& logMessage, ILMessageOption = LogInfoDevel);
 
  private:
   /// Inheriting classes must implement this to check whether a given read is safe.

src/CommandLineUtilities/ProgramCleanup.cxx

@@ -82,7 +82,7 @@ class ProgramCleanup : public Program
       return {};
     };
 
-    Logger::get() << "`roc-cleanup` execution initiated by " << getUsername() << LogDebugOps_(4700) << endm;
+    Logger::get() << "`roc-cleanup` execution initiated by " << getUsername() << LogDebugDevel_(4700) << endm;
 
     // Take and hold DMA locks during cleanup
     std::vector<std::unique_ptr<Interprocess::Lock>> dmaLocks;
@@ -127,7 +127,7 @@ class ProgramCleanup : public Program
       sysCheckRet("modprobe uio_pci_dma");
     }
 
-    Logger::get() << "`roc-cleanup` execution finished" << LogDebugOps_(4710) << endm;
+    Logger::get() << "`roc-cleanup` execution finished" << LogDebugDevel_(4710) << endm;
     return;
   }
 

src/CommandLineUtilities/ProgramConfig.cxx

@@ -395,7 +395,7 @@ class ProgramConfig : public Program
         std::stringstream ss;
         ss << report;
         while (std::getline(ss, line)) {
-          theLog << LogInfoSupport_(4805) << line << InfoLogger::endm;
+          theLog << LogInfoDevel_(4805) << line << InfoLogger::endm;
         }
       } else {
         FILE* fp = fopen(fileName.c_str(), fileMode);
@@ -419,10 +419,10 @@ class ProgramConfig : public Program
 
     // Configure all cards found - Normally used during boot
     if (mOptions.configAll) {
-      Logger::get() << "Running RoC Configuration for all cards" << LogInfoOps_(4600) << endm;
+      Logger::get() << "Running RoC Configuration for all cards" << LogInfoDevel_(4600) << endm;
       std::vector<CardDescriptor> cardsFound;
       if (mOptions.configUri == "") {
-        Logger::get() << "A configuration URI is necessary with the startup-config flag set" << LogErrorOps_(4600) << endm;
+        Logger::get() << "A configuration URI is necessary with the startup-config flag set" << LogErrorDevel_(4600) << endm;
         return;
       }
 
@@ -436,9 +436,9 @@ class ProgramConfig : public Program
             CardConfigurator(card.pciAddress, mOptions.configUri, mOptions.forceConfig);
             reportStatus(card.pciAddress);
           } catch (const std::runtime_error& e) {
-            Logger::get() << e.what() << LogErrorOps_(4600) << endm;
+            Logger::get() << e.what() << LogErrorDevel_(4600) << endm;
           } catch (const Exception& e) {
-            Logger::get() << boost::diagnostic_information(e) << LogErrorOps_(4600) << endm;
+            Logger::get() << boost::diagnostic_information(e) << LogErrorDevel_(4600) << endm;
           }
         }
       }
@@ -451,7 +451,7 @@ class ProgramConfig : public Program
       try {
         FirmwareChecker().checkFirmwareCompatibility(cardId);
       } catch (const Exception& e) {
-        Logger::get() << boost::diagnostic_information(e) << LogErrorOps_(4600) << endm;
+        Logger::get() << boost::diagnostic_information(e) << LogErrorDevel_(4600) << endm;
         throw;
       }
     }
@@ -523,35 +523,35 @@ class ProgramConfig : public Program
         return;
       }
 
-      Logger::get() << "Configuring card " << cardId << " with command line arguments" << LogDebugOps_(4600) << endm;
+      Logger::get() << "Configuring card " << cardId << " with command line arguments" << LogDebugDevel_(4600) << endm;
       if (mOptions.forceConfig) {
-        Logger::get() << "`--force` enabled" << LogDebugOps_(4600) << endm;
+        Logger::get() << "`--force` enabled" << LogDebugDevel_(4600) << endm;
       }
 
       try {
         CardConfigurator(params, mOptions.forceConfig);
         reportStatus(cardId);
       } catch (const std::runtime_error& e) {
-        Logger::get() << e.what() << LogErrorOps_(4600) << endm;
+        Logger::get() << e.what() << LogErrorDevel_(4600) << endm;
         throw;
       } catch (const Exception& e) {
-        Logger::get() << e.what() << LogErrorOps_(4600) << endm;
+        Logger::get() << e.what() << LogErrorDevel_(4600) << endm;
         throw;
       }
     } else {
-      Logger::get() << "Configuring card " << cardId << " with config uri: " << mOptions.configUri << LogDebugOps_(4600) << endm;
+      Logger::get() << "Configuring card " << cardId << " with config uri: " << mOptions.configUri << LogDebugDevel_(4600) << endm;
       if (mOptions.forceConfig) {
-        Logger::get() << "`--force` enabled" << LogDebugOps_(4600) << endm;
+        Logger::get() << "`--force` enabled" << LogDebugDevel_(4600) << endm;
       }
 
       try {
         CardConfigurator(cardId, mOptions.configUri, mOptions.forceConfig);
         reportStatus(cardId);
       } catch (const std::runtime_error& e) {
-        Logger::get() << e.what() << LogErrorOps_(4600) << endm;
+        Logger::get() << e.what() << LogErrorDevel_(4600) << endm;
         throw;
       } catch (const Exception& e) {
-        Logger::get() << e.what() << LogErrorOps_(4600) << endm;
+        Logger::get() << e.what() << LogErrorDevel_(4600) << endm;
         throw;
       }
     }

src/CommandLineUtilities/ProgramCtpEmulator.cxx

@@ -84,10 +84,10 @@ class ProgramCtpEmulator : public Program
 
     CardType::type cardType = bar2->getCardType();
     if (cardType == CardType::type::Crorc) {
-      Logger::get() << "CRORC not supported" << LogErrorOps_(4803) << endm;
+      Logger::get() << "CRORC not supported" << LogErrorDevel_(4803) << endm;
       return;
     } else if (cardType != CardType::type::Cru) {
-      Logger::get() << "Invalid card type" << LogErrorOps_(4804) << endm;
+      Logger::get() << "Invalid card type" << LogErrorDevel_(4804) << endm;
       return;
     }
 

src/CommandLineUtilities/ProgramLoopback.cxx

@@ -99,7 +99,7 @@ class ProgramLoopback : public Program
     auto cardType = card.cardType;
 
     if (cardType == CardType::type::Crorc) {
-      Logger::get() << "CRORC not supported" << LogErrorOps << endm;
+      Logger::get() << "CRORC not supported" << LogErrorDevel << endm;
     } else if (cardType == CardType::type::Cru) {
       if (mOptions.expertView) {
         formatHeader = "  %-9s %-10s %-19s %-16s %-12s %-21s %-17s\n";

src/Crorc/CrorcBar.cxx

@@ -106,7 +106,7 @@ int CrorcBar::getEndpointNumber()
 
 void CrorcBar::configure(bool /*force*/)
 {
-  log("Configuring...", LogInfoOps_(4650));
+  log("Configuring...", LogInfoDevel_(4650));
 
   // enable laser
   log("Enabling the laser", LogInfoDevel_(4651));
@@ -127,7 +127,7 @@ void CrorcBar::configure(bool /*force*/)
   log("Configuring Time Frame detection", LogInfoDevel_(4655));
   setTimeFrameDetectionEnabled(mTimeFrameDetectionEnabled);
 
-  log("CRORC configuration done", LogInfoOps_(4656));
+  log("CRORC configuration done", LogInfoDevel_(4656));
 }
 
 Crorc::ReportInfo CrorcBar::report(bool forConfig)

src/Crorc/CrorcDmaChannel.cxx

@@ -133,7 +133,7 @@ void CrorcDmaChannel::deviceStartDma()
   // needed to wait a bit FEE
   std::this_thread::sleep_for(100ms);
 
-  log("DMA started", LogInfoOps_(4303));
+  log("DMA started", LogInfoDevel_(4303));
 }
 
 void CrorcDmaChannel::deviceStopDma()