[alf] s/serial/cruSequence/g

Author: kostorr

README.md

@@ -20,18 +20,18 @@ DIM_DNS_NODE=thedimdns.cern.ch
 `
 
 ### o2-alf-client
-o2-alf-client is the binary of an ALF client used solely for testing purposes. On top of the DIM Nameserver it expects the hostname of the node hosting the ALF server, the card's serial and the link number as command-line arguments. Different arguments to test different types of services are available.
+o2-alf-client is the binary of an ALF client used solely for testing purposes. On top of the DIM Nameserver it expects the hostname of the node hosting the ALF server, the CRU's sequence number and the link number as command-line arguments. Different arguments to test different types of services are available.
 
 `
-o2-alf-client --dim-dns-node thedimdns.cern.ch --alf-id thealfserver --serial 0 --link 4
+o2-alf-client --dim-dns-node thedimdns.cern.ch --alf-id thealfserver --cru-sequence 0 --link 4
 `
 
 ## Services
 
-Service names are identified by the server's hostname, the card's serial number and the link, as follows:
+Service names are identified by the server's hostname, the card's sequence number (as reported during ALF's startup) and the link, as follows:
 
 `
-ALF_[hostname]/SERIAL_[serial_number]/LINK_[link]/[service_name]
+ALF_[hostname]/CRU_[cru_sequence_number]/LINK_[link]/[service_name]
 `
 
 ### DIM RPC services

apps/Alf.cxx

@@ -87,7 +87,7 @@ class Alf : public AliceO2::Common::Program
     AlfServer alfServer = AlfServer();
 
     std::vector<roc::CardDescriptor> cardsFound = roc::findCards();
-    int fakeSerial = 0;
+    int cruSequence = -1;
     for (auto const& card : cardsFound) {
       std::vector<AlfLink> links;
 
@@ -105,14 +105,12 @@ class Alf : public AliceO2::Common::Program
           }
         }
 
-        //auto serialMaybe = card.serialNumber.get();
-        //int serial = serialMaybe ? serialMaybe : fakeSerial++;
-        int serial = fakeSerial++;
+        cruSequence++;
 
-        getLogger() << "Card #" << serial << " : " << card.pciAddress << endm;
+        getLogger() << "CRU #" << cruSequence << " : " << card.pciAddress << endm;
         bar2 = roc::ChannelFactory().getBar(card.pciAddress, 2);
         for (int linkId = 0; linkId < CRU_NUM_LINKS; linkId++) {
-          links.push_back({ alfId, serial, linkId, bar2 });
+          links.push_back({ alfId, cruSequence, linkId, bar2 });
         }
 
       } else {
@@ -121,7 +119,7 @@ class Alf : public AliceO2::Common::Program
 
       if (isVerbose()) {
         for (auto const& link : links) {
-          getLogger() << link.alfId << " " << link.serial << " " << link.linkId << endm;
+          getLogger() << link.alfId << " " << link.cruSequence << " " << link.linkId << endm;
         }
       }
 

apps/AlfClient.cxx

@@ -53,9 +53,9 @@ class AlfClient : public AliceO2::Common::Program
     options.add_options()("dim-dns-node",
                           po::value<std::string>(&mOptions.dimDnsNode)->default_value(""),
                           "The DIM DNS node to connect to if the env var is not set");
-    options.add_options()("serial",
-                          po::value<int>(&mOptions.serial),
-                          "CRU serial number");
+    options.add_options()("cru-sequence",
+                          po::value<int>(&mOptions.cruSequence),
+                          "CRU sequence number");
     options.add_options()("link",
                           po::value<int>(&mOptions.link),
                           "Link number");
@@ -106,9 +106,9 @@ class AlfClient : public AliceO2::Common::Program
     std::string alfId = mOptions.alfId;
     boost::to_upper(alfId);
 
-    getLogger() << "Starting the DIM Client using ALF ID=" << alfId << ", serial=" << mOptions.serial << " and link=" << mOptions.link << endm;
+    getLogger() << "Starting the DIM Client using ALF ID=" << alfId << ", cru #=" << mOptions.cruSequence << " and link=" << mOptions.link << endm;
 
-    AlfLink link = AlfLink{ alfId, mOptions.serial, mOptions.link, nullptr };
+    AlfLink link = AlfLink{ alfId, mOptions.cruSequence, mOptions.link, nullptr };
 
     ServiceNames names(link);
     Alf::RegisterReadRpc registerReadRpc(names.registerRead());
@@ -188,7 +188,7 @@ class AlfClient : public AliceO2::Common::Program
  private:
   struct OptionsStruct {
     std::string dimDnsNode = "";
-    int serial = -1;
+    int cruSequence = -1;
     int link = -1;
     std::string alfId = "";
     bool ic = false;

src/AlfServer.cxx

@@ -299,7 +299,7 @@ void AlfServer::makeRpcServers(std::vector<AlfLink> links)
     ServiceNames names(link);
 
     // Start the RPC Servers
-    auto& servers = mRpcServers[link.serial][link.linkId];
+    auto& servers = mRpcServers[link.cruSequence][link.linkId];
     std::shared_ptr<roc::BarInterface> bar2 = link.bar2;
 
     if (link.linkId == 0) { // Register Read / Write services are per card; register them as soon as possible

src/AlfServer.h

@@ -55,7 +55,7 @@ class AlfServer
   static std::vector<std::pair<Swt::SwtData, Swt::Operation>> parseStringToSwtPairs(std::vector<std::string> stringPairs);
   static std::vector<std::pair<Ic::IcData, Ic::Operation>> parseStringToIcPairs(std::vector<std::string> stringPairs);
 
-  /// serial -> link -> vector of RPC servers
+  /// cruSequence -> link -> vector of RPC servers
   std::map<int, std::map<int, std::vector<std::unique_ptr<StringRpcServer>>>> mRpcServers;
 };
 

src/Common.h

@@ -33,7 +33,7 @@ static constexpr auto CHANNEL_BUSY_TIMEOUT = std::chrono::milliseconds(10);
 
 struct AlfLink {
   std::string alfId;
-  int serial;
+  int cruSequence;
   int linkId;
   std::shared_ptr<roc::BarInterface> bar2;
 };

src/DimServices/ServiceNames.cxx

@@ -43,12 +43,12 @@ DEFLINKSERVICENAME(icGbtI2cWrite, "IC_GBT_I2C_WRITE")
 
 std::string ServiceNames::formatLink(std::string name) const
 {
-  return ((boost::format("ALF_%1%/SERIAL_%2%/LINK_%3%/%4%") % mAlfId % mSerial % mLink % name)).str();
+  return ((boost::format("ALF_%1%/CRU_%2%/LINK_%3%/%4%") % mAlfId % mCruSequence % mLink % name)).str();
 }
 
 std::string ServiceNames::format(std::string name) const
 {
-  return ((boost::format("ALF_%1%/SERIAL_%2%/%3%") % mAlfId % mSerial % name)).str();
+  return ((boost::format("ALF_%1%/CRU_%2%/%3%") % mAlfId % mCruSequence % name)).str();
 }
 
 } // namespace Alf

src/DimServices/ServiceNames.h

@@ -29,7 +29,7 @@ class ServiceNames
 {
  public:
   ServiceNames(AlfLink link)
-    : mAlfId(link.alfId), mSerial(link.serial), mLink(link.linkId)
+    : mAlfId(link.alfId), mCruSequence(link.cruSequence), mLink(link.linkId)
   {
   }
 
@@ -44,7 +44,7 @@ class ServiceNames
   std::string formatLink(std::string name) const;
   std::string format(std::string name) const;
   std::string mAlfId;
-  const int mSerial;
+  const int mCruSequence;
   const int mLink;
 };
 

src/Ic/Ic.cxx

@@ -166,7 +166,7 @@ std::string Ic::writeSequence(std::vector<std::pair<IcData, Operation>> ops)
     } catch (const SwtException& e) {
       // If an IC error occurs, we stop executing the sequence of commands and return the results as far as we got them, plus
       // the error message.
-      std::string meaningfulMessage = (boost::format("ic_regs::IC_SEQUENCE address=0x%08x data=0x%08x serial=%d link=%d, error='%s'") % icData.address % icData.data % mLink.serial % mLink.linkId % e.what()).str();
+      std::string meaningfulMessage = (boost::format("ic_regs::IC_SEQUENCE address=0x%08x data=0x%08x cruSequence=%d link=%d, error='%s'") % icData.address % icData.data % mLink.cruSequence % mLink.linkId % e.what()).str();
       getErrorLogger() << meaningfulMessage << endm;
       resultBuffer << meaningfulMessage;
       BOOST_THROW_EXCEPTION(IcException() << ErrorInfo::Message(resultBuffer.str()));

src/Sca/Sca.cxx

@@ -244,7 +244,7 @@ std::string Sca::writeSequence(const std::vector<CommandData>& commands)
     } catch (const ScaException& e) {
       // If an SCA error occurs, we stop executing the sequence of commands and return the results as far as we got
       // them, plus the error message.
-      std::string meaningfulMessage = (boost::format("SCA_SEQUENCE cmd=0x%08x data=0x%08x serial=%d link=%d error='%s'") % commandData.command % commandData.data % mLink.serial % mLink.linkId % e.what()).str();
+      std::string meaningfulMessage = (boost::format("SCA_SEQUENCE cmd=0x%08x data=0x%08x cruSequence=%d link=%d error='%s'") % commandData.command % commandData.data % mLink.cruSequence % mLink.linkId % e.what()).str();
       getErrorLogger() << meaningfulMessage << endm;
       resultBuffer << meaningfulMessage;
       BOOST_THROW_EXCEPTION(ScaException() << ErrorInfo::Message(resultBuffer.str()));