Add roc-metrics tool

Author: kostorr

CMakeLists.txt

@@ -56,8 +56,9 @@ ENDIF ()
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -pedantic -Wextra -fPIC")
 
 # Populate the Cru/Constants.h file with the register addresses contained in CRU/cru_table.py
-execute_process(COMMAND python ${CMAKE_BASE_DIR}/src/Cru/cru_constants_populate.py
-  STATUS status)
+execute_process(COMMAND python ${CMAKE_CURRENT_SOURCE_DIR}/src/Cru/cru_constants_populate.py
+  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/src/Cru
+  RESULT_VARIABLE status)
 IF(NOT "${status}" EQUAL "0")
   MESSAGE(WARNING "Couldn't update CRU Register Addresses")
 ENDIF()
@@ -162,6 +163,7 @@ if(ALICEO2_READOUTCARD_PDA_ENABLED)
   build_util_exec(roc-flash CommandLineUtilities/ProgramFlash.cxx)
   build_util_exec(roc-flash-read CommandLineUtilities/ProgramFlashRead.cxx)
   build_util_exec(roc-list-cards CommandLineUtilities/ProgramListCards.cxx)
+  build_util_exec(roc-metrics CommandLineUtilities/ProgramMetrics.cxx)
   #build_util_exec(roc-sanity-check CommandLineUtilities/ProgramSanityCheck.cxx)
 
   if(DIM_FOUND)

include/ReadoutCard/BarInterface.h

@@ -47,6 +47,16 @@ class BarInterface: public virtual RegisterReadWriteInterface
     virtual boost::optional<std::string> getFirmwareInfo() = 0;
 
     virtual boost::optional<std::string> getCardId() = 0;
+    
+    virtual int32_t getDroppedPackets() = 0;
+    
+    virtual uint32_t getCTPClock() = 0;
+    
+    virtual uint32_t getLocalClock() = 0;
+    
+    virtual int32_t getLinks() = 0;
+
+    virtual int32_t getLinksPerWrapper(uint32_t wrapper) = 0;
 
 };
 

src/BarInterfaceBase.h

@@ -38,6 +38,12 @@ class BarInterfaceBase: public BarInterface
       return mPdaBar->getSize();
     }
 
+    /// Default implementation for optional function
+    virtual boost::optional<int32_t> getSerial() override
+    {
+      return {};
+    }
+
     /// Default implementation for optional function
     virtual boost::optional<float> getTemperature() override
     {
@@ -56,6 +62,37 @@ class BarInterfaceBase: public BarInterface
       return {};
     }
 
+    /// Default implementation for optional function
+    virtual int32_t getDroppedPackets() override
+    {
+      return 0;
+    }
+ 
+    /// Default implementation for optional function
+    virtual uint32_t getCTPClock() override
+    {
+      return 0;
+    }
+    
+    /// Default implementation for optional function
+    virtual uint32_t getLocalClock() override
+    {
+      return 0;
+    }
+    
+    /// Default implementation for optional function
+    virtual int32_t getLinksPerWrapper(uint32_t wrapper) override
+    {
+      return 0;
+    }
+    /// Default implementation for optional function
+    virtual int32_t getLinks() override
+    {
+      return 0;
+    }
+
+
+
 
   protected:
     /// BAR index
@@ -73,10 +110,10 @@ class BarInterfaceBase: public BarInterface
   private:
     /// Inheriting classes must implement this to check whether a given read is safe.
     /// If it is not safe, it should throw an UnsafeReadAccess exception
-    virtual void checkReadSafe(int index) = 0;
+    //virtual void checkReadSafe(int index) = 0;
     /// Inheriting classes must implement this to check whether a given write is safe.
     /// If it is not safe, it should throw an UnsafeWriteAccess exception
-    virtual void checkWriteSafe(int index, uint32_t value) = 0;
+    //virtual void checkWriteSafe(int index, uint32_t value) = 0;
 };
 
 } // namespace roc

src/CommandLineUtilities/ProgramMetrics.cxx

@@ -0,0 +1,100 @@
+/// \file ProgramMetrics.cxx
+/// \brief Tool that returns current information about RoCs.
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#include <iostream>
+#include "Cru/Constants.h"
+#include "ReadoutCard/ChannelFactory.h"
+#include "CommandLineUtilities/Options.h"
+#include "CommandLineUtilities/Program.h"
+#include "RocPciDevice.h"
+#include <boost/format.hpp>
+#include <boost/optional/optional_io.hpp>
+
+using namespace AliceO2::roc::CommandLineUtilities;
+using namespace AliceO2::roc;
+using namespace AliceO2::InfoLogger;
+namespace po = boost::program_options;
+
+class ProgramMetrics: public Program
+{
+  public:
+
+  virtual Description getDescription()
+  {
+    return {"Metrics", "Return current RoC parameters", 
+      "roc-metrics\n"
+      "roc-metrics --pci-address 42:00.0\n"};
+  }
+
+  virtual void addOptions(boost::program_options::options_description& options)
+  {
+    options.add_options()
+      ("pci-address",
+       po::value<std::string>(&mOptions.pciAddress)->default_value("-1"),
+       "Card's PCI Address");
+  }
+
+  virtual void run(const boost::program_options::variables_map& map) 
+  {
+
+    std::vector<CardDescriptor> cardsFound;
+    if (mOptions.pciAddress != "-1")
+      cardsFound = AliceO2::roc::RocPciDevice::findSystemDevices(mOptions.pciAddress);
+    else
+      cardsFound = AliceO2::roc::RocPciDevice::findSystemDevices();
+      
+
+    std::ostringstream table;
+
+    auto formatHeader = "  %-3s %-6s %-10s %-10s %-19s %-20s %-19s %-8s %-17s %-17s\n";
+    auto formatRow = "  %-3s %-6s %-10s %-10s %-19s %-20s %-19s %-8s %-17s %-17s\n";
+    auto header = (boost::format(formatHeader)
+        % "#" % "Type" % "PCI Addr" % "Temp (C)" % "#Dropped Packets" % "CTP Clock (MHz)" % "Local Clock (MHz)"
+        % "#links" % "#Wrapper 0 links" % "#Wrapper 1 links").str();
+    auto lineFat = std::string(header.length(), '=') + '\n';
+    auto lineThin = std::string(header.length(), '-') + '\n';
+
+    table << lineFat << header << lineThin;
+
+    int i = 0;
+    for (const auto& card : cardsFound) {
+      Parameters params = Parameters::makeParameters(card.pciAddress, 2);
+      auto bar2 = ChannelFactory().getBar(params);
+
+      float temperature = bar2->getTemperature().value_or(0);
+      int32_t dropped = bar2->getDroppedPackets();
+      float ctp_clock = bar2->getCTPClock()/1e6;
+      float local_clock = bar2->getLocalClock()/1e6;
+      int32_t links = bar2->getLinks();
+      uint32_t links0 = bar2->getLinksPerWrapper(0);
+      uint32_t links1 = bar2->getLinksPerWrapper(1);
+
+      auto format = boost::format(formatRow) % i % CardType::toString(card.cardType) % card.pciAddress.toString()
+        % temperature % dropped % ctp_clock % local_clock % links % links0 % links1;
+
+      table << format;
+      i++;
+    }
+
+    table << lineFat;
+    std::cout << table.str();
+  }
+  
+  struct OptionsStruct 
+  {
+    std::string pciAddress = "-1";
+  }mOptions;
+
+  private:
+};
+
+int main(int argc, char** argv)
+{
+  if (argc > 2){
+    std::cout << "Too many arguments" << std::endl;
+    return -1;
+  }
+  return ProgramMetrics().execute(argc, argv);
+}

src/Crorc/CrorcBar.cxx

@@ -18,25 +18,11 @@ CrorcBar::~CrorcBar()
 {
 }
 
-void CrorcBar::checkReadSafe(int)
-{
-}
-
-void CrorcBar::checkWriteSafe(int, uint32_t)
-{
-}
-
 boost::optional<int32_t> CrorcBar::getSerial()
 {
   return Crorc::getSerial(*(mPdaBar.get()));
 }
 
-
-boost::optional<float> CrorcBar::getTemperature()
-{
-   return {};
-}
-
 boost::optional<std::string> CrorcBar::getFirmwareInfo()
 {
   uint32_t version = mPdaBar->readRegister(Rorc::RFID);
@@ -59,12 +45,5 @@ boost::optional<std::string> CrorcBar::getFirmwareInfo()
   return stream.str();
 }
 
-boost::optional<std::string> CrorcBar::getCardId()
-{
-   return {};
-}
-
-
-
 } // namespace roc
 } // namespace AliceO2

src/Crorc/CrorcBar.h

@@ -20,18 +20,16 @@ class CrorcBar final : public BarInterfaceBase
   public:
     CrorcBar(const Parameters& parameters);
     virtual ~CrorcBar();
-    virtual void checkReadSafe(int index) override;
-    virtual void checkWriteSafe(int index, uint32_t value) override;
+    //virtual void checkReadSafe(int index) override;
+    //virtual void checkWriteSafe(int index, uint32_t value) override;
 
     virtual CardType::type getCardType() override
     {
       return CardType::Crorc;
     }
 
     virtual boost::optional<int32_t> getSerial() override;
-    virtual boost::optional<float> getTemperature() override;
     virtual boost::optional<std::string> getFirmwareInfo() override;
-    virtual boost::optional<std::string> getCardId() override;
 };
 
 } // namespace roc

src/Cru/Constants.h

@@ -131,6 +131,27 @@ static constexpr Register FPGA_CHIP_HIGH(0x00010014);
 /// Must be accessed on BAR 2
 static constexpr Register FPGA_CHIP_LOW(0x00010018);
 
+// Register containing the number of dropped packets
+// Must be accessed on BAR 2
+//not yet in cru_tables.py//
+static constexpr Register NUM_DROPPED_PACKETS(0x0060001C);
+
+// Register containing the CTP Clock's value
+// Must be accessed on BAR 2
+static constexpr Register CTP_CLOCK(0x00240000);
+
+// Register containing the Local Clock's value
+// Must be accessed on BAR 2
+static constexpr Register LOCAL_CLOCK(0x00240004);
+
+// Wrapper 0's base address
+// Must be accessed on BAR 2
+static constexpr Register WRAPPER0(0x00400000);
+
+// Wrapper 1's base address
+// Must be accessed on BAR 2
+static constexpr Register WRAPPER1(0x00500000);
+
 } // namespace Cru
 } // namespace Registers
 } // namespace roc

src/Cru/CruBar.cxx

@@ -6,6 +6,7 @@
 
 #include "CruBar.h"
 #include "boost/format.hpp"
+#include "Utilities/Util.h"
 
 namespace AliceO2 {
 namespace roc {
@@ -27,13 +28,13 @@ CruBar::~CruBar()
 {
 }
 
-void CruBar::CruBar::checkReadSafe(int)
+/*void CruBar::CruBar::checkReadSafe(int)
 {
 }
 
 void CruBar::CruBar::checkWriteSafe(int, uint32_t)
 {
-}
+}*/
 
 boost::optional<int32_t> CruBar::getSerial()
 {
@@ -137,6 +138,54 @@ FirmwareFeatures CruBar::getFirmwareFeatures()
   return mFeatures;
 }
 
+/// Get number of dropped packets
+int32_t CruBar::getDroppedPackets()
+{
+  return mPdaBar->readRegister(Cru::Registers::NUM_DROPPED_PACKETS.index);
+}
+
+// Get CTP clock (Hz)
+uint32_t CruBar::getCTPClock()
+{
+  return mPdaBar->readRegister(Cru::Registers::CTP_CLOCK.index);
+}
+
+// Get local clock (Hz)
+uint32_t CruBar::getLocalClock()
+{
+  return mPdaBar->readRegister(Cru::Registers::LOCAL_CLOCK.index);
+}
+
+// Get total # of links per wrapper
+int32_t CruBar::getLinks()
+{
+  int32_t links = 0;
+  uint32_t regread = 0x0;
+  regread = mPdaBar->readRegister((Cru::Registers::WRAPPER0.address + 0x4) / 4);
+  links += Utilities::getBits(regread, 24, 31);
+  regread = mPdaBar->readRegister((Cru::Registers::WRAPPER1.address + 0x4) / 4);
+  links += Utilities::getBits(regread, 24, 31);
+
+  return links;
+
+}
+
+
+// Get # of links per wrapper
+int32_t CruBar::getLinksPerWrapper(uint32_t wrapper)
+{
+  uint32_t regread = 0x0;
+  if (wrapper == 0)
+    regread = mPdaBar->readRegister((Cru::Registers::WRAPPER0.address + 0x4) / 4);
+  else if (wrapper == 1)
+    regread = mPdaBar->readRegister((Cru::Registers::WRAPPER1.address + 0x4) / 4);
+  else
+    return 0;
+
+  return Utilities::getBits(regread, 24, 31);
+
+}
+
 /// Gets the serial number from the card.
 /// Note that not all firmwares have a serial number. You should make sure this firmware feature is enabled before
 /// calling this function, or the card may crash. See parseFirmwareFeatures().