MCH: implement custom inputs spec for raw decoder (#5350)

The input dataspec might vary from the default "TF:MCH/RAWDATA", for
example when a data sampling device is inserted beteen the raw proxy
and the decoder.

This PR allows to specify the input dataspec as a command-line option,
giving more flexibility to the DPL chain.
The documentation is updated accordingly.

There is also some improvement in the textual output of the digits sink.

Author: aferrero2707

Detectors/MUON/MCH/Raw/Decoder/include/MCHRawDecoder/OrbitInfo.h

@@ -42,6 +42,7 @@ class OrbitInfo
 
   friend bool operator==(const OrbitInfo& o1, const OrbitInfo& o2);
   friend bool operator!=(const OrbitInfo& o1, const OrbitInfo& o2);
+  friend bool operator<(const OrbitInfo& o1, const OrbitInfo& o2);
 
  private:
   uint64_t mOrbitInfo = {0};
@@ -51,6 +52,7 @@ class OrbitInfo
 
 bool operator==(const OrbitInfo& o1, const OrbitInfo& o2);
 bool operator!=(const OrbitInfo& o1, const OrbitInfo& o2);
+bool operator<(const OrbitInfo& o1, const OrbitInfo& o2);
 
 } //namespace mch
 } //namespace o2

Detectors/MUON/MCH/Raw/Decoder/src/OrbitInfo.cxx

@@ -39,4 +39,9 @@ bool operator!=(const OrbitInfo& o1, const OrbitInfo& o2)
   return !(o1 == o2);
 }
 
+bool operator<(const OrbitInfo& o1, const OrbitInfo& o2)
+{
+  return (o1.mOrbitInfo < o2.mOrbitInfo);
+}
+
 } // namespace o2::mch

Detectors/MUON/MCH/Workflow/CMakeLists.txt

@@ -34,6 +34,12 @@ o2_add_executable(
         COMPONENT_NAME mch
         PUBLIC_LINK_LIBRARIES O2::MCHWorkflow)
 
+o2_add_executable(
+        raw-debug-workflow
+        SOURCES src/raw-debug-workflow.cxx
+        COMPONENT_NAME mch
+        PUBLIC_LINK_LIBRARIES O2::MCHWorkflow)
+
 o2_add_executable(
         cru-page-to-digits-workflow
         SOURCES src/cru-page-to-digits-workflow.cxx

Detectors/MUON/MCH/Workflow/README.md

@@ -27,6 +27,14 @@
 
 `o2-mch-raw-to-digits-workflow`
 
+The workflow accepts the following options:
+
+* `--debug`: enable verbose output
+* `--dataspec`: selection string for the input data (default: `"TF:MCH/RAWDATA"`)
+* `--cru-map`: path to custom CRU mapping file
+* `--fec-map`: path to custom FEC mapping file
+* `--ds2manu`: convert channel numbering from Run3 to Run1-2 order
+
 ## Digits to preclusters
 
 `o2-mch-digits-to-preclusters-workflow`

Detectors/MUON/MCH/Workflow/src/DataDecoderSpec.cxx

@@ -59,35 +59,36 @@ using RDH = o2::header::RDHAny;
 class DataDecoderTask
 {
  public:
+  DataDecoderTask(std::string spec) : mInputSpec(spec) {}
+
   //_________________________________________________________________________________________________
   void init(framework::InitContext& ic)
   {
     SampaChannelHandler channelHandler;
     RdhHandler rdhHandler;
 
     auto ds2manu = ic.options().get<bool>("ds2manu");
-    mPrint = ic.options().get<bool>("print");
+    mDebug = ic.options().get<bool>("debug");
     auto mapCRUfile = ic.options().get<std::string>("cru-map");
     auto mapFECfile = ic.options().get<std::string>("fec-map");
 
-    mDecoder = new DataDecoder(channelHandler, rdhHandler, mapCRUfile, mapFECfile, ds2manu, mPrint);
+    mDecoder = new DataDecoder(channelHandler, rdhHandler, mapCRUfile, mapFECfile, ds2manu, mDebug);
   }
 
   //_________________________________________________________________________________________________
-  // the decodeTF() function processes the the messages generated by the (sub)TimeFrame builder
+  // the decodeTF() function processes the messages generated by the (sub)TimeFrame builder
   void decodeTF(framework::ProcessingContext& pc)
   {
     // get the input buffer
     auto& inputs = pc.inputs();
-    DPLRawParser parser(inputs, o2::framework::select("TF:MCH/RAWDATA"));
+    DPLRawParser parser(inputs, o2::framework::select(mInputSpec.c_str()));
 
     for (auto it = parser.begin(), end = parser.end(); it != end; ++it) {
-      auto const* rdh = it.get_if<RDH>();
       auto const* raw = it.raw();
-      size_t payloadSize = it.size();
-      if (payloadSize == 0) {
+      if (!raw) {
         continue;
       }
+      size_t payloadSize = it.size();
 
       gsl::span<const std::byte> buffer(reinterpret_cast<const std::byte*>(raw), sizeof(RDH) + payloadSize);
       mDecoder->decodeBuffer(buffer);
@@ -113,7 +114,7 @@ class DataDecoderTask
     // size of payload
     size_t payloadSize = header->payloadSize;
 
-    if (mPrint) {
+    if (mDebug) {
       std::cout << nFrame << "  payloadSize=" << payloadSize << std::endl;
     }
     nFrame += 1;
@@ -156,7 +157,7 @@ class DataDecoderTask
     auto& digits = mDecoder->getOutputDigits();
     auto& orbits = mDecoder->getOrbits();
 
-    if (mPrint) {
+    if (mDebug) {
       for (auto d : digits) {
         std::cout << " DE# " << d.getDetID() << " PadId " << d.getPadID() << " ADC " << d.getADC() << " time " << d.getTime().sampaTime << std::endl;
       }
@@ -173,19 +174,21 @@ class DataDecoderTask
   }
 
  private:
-  bool mPrint = {false};
-  DataDecoder* mDecoder = {nullptr};
+  std::string mInputSpec;            /// selection string for the input data
+  bool mDebug = {false};             /// flag to enable verbose output
+  DataDecoder* mDecoder = {nullptr}; /// pointer to the data decoder instance
 };
 
 //_________________________________________________________________________________________________
 o2::framework::DataProcessorSpec getDecodingSpec(std::string inputSpec)
 {
+  o2::mch::raw::DataDecoderTask task(inputSpec);
   return DataProcessorSpec{
     "DataDecoder",
     o2::framework::select(inputSpec.c_str()),
     Outputs{OutputSpec{"MCH", "DIGITS", 0, Lifetime::Timeframe}, OutputSpec{"MCH", "ORBITS", 0, Lifetime::Timeframe}},
-    AlgorithmSpec{adaptFromTask<DataDecoderTask>()},
-    Options{{"print", VariantType::Bool, false, {"print digits"}},
+    AlgorithmSpec{adaptFromTask<DataDecoderTask>(std::move(task))},
+    Options{{"debug", VariantType::Bool, false, {"enable verbose output"}},
             {"cru-map", VariantType::String, "", {"custom CRU mapping"}},
             {"fec-map", VariantType::String, "", {"custom FEC mapping"}},
             {"ds2manu", VariantType::Bool, false, {"convert channel numbering from Run3 to Run1-2 order"}}}};

Detectors/MUON/MCH/Workflow/src/digits-sink-workflow.cxx

@@ -84,11 +84,13 @@ class DigitsSinkTask
     // get the input digits
     auto digits = pc.inputs().get<gsl::span<Digit>>("digits");
     auto orbits = pc.inputs().get<gsl::span<OrbitInfo>>("orbits");
+    std::set<OrbitInfo> ordered_orbits(orbits.begin(), orbits.end());
 
     if (mText) {
-      for (auto o : orbits) {
-        mOutputFile << std::endl
-                    << " FEEID " << o.getFeeID() << "  LINK " << (int)o.getLinkID() << "  ORBIT " << o.getOrbit() << std::endl;
+      mOutputFile << std::endl
+                  << "=======================" << std::endl;
+      for (auto o : ordered_orbits) {
+        mOutputFile << " FEEID " << o.getFeeID() << "  LINK " << (int)o.getLinkID() << "  ORBIT " << o.getOrbit() << std::endl;
       }
       mOutputFile << "---------------" << std::endl;
       for (auto d : digits) {

Detectors/MUON/MCH/Workflow/src/raw-debug-workflow.cxx

@@ -0,0 +1,127 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file    raw-parser.cxx
+/// \author  Andrea Ferrero
+///
+/// \brief This is an executable that receives the TimeFrames from the raw proxy and prints the sequence of RDHs.
+///
+/// This is an executable that receives the TimeFrames from the raw proxy and prints the sequence of RDHs.
+/// Useful for debugging the DPL workflows involving input RAW data.
+///
+
+#include <iostream>
+#include "Framework/WorkflowSpec.h"
+#include "Framework/DataSpecUtils.h"
+#include "Framework/CallbackService.h"
+#include "Framework/ControlService.h"
+#include "Framework/Task.h"
+
+#include "Framework/ConfigParamSpec.h"
+#include "Framework/CompletionPolicyHelpers.h"
+
+#include "Headers/RAWDataHeader.h"
+#include "DetectorsRaw/RDHUtils.h"
+#include "DPLUtils/DPLRawParser.h"
+
+using namespace o2::framework;
+
+void customize(std::vector<ConfigParamSpec>& workflowOptions)
+{
+  workflowOptions.push_back(ConfigParamSpec{"dataspec", VariantType::String, "TF:MCH/RAWDATA", {"selection string for the input data"}});
+}
+
+#include "Framework/runDataProcessing.h"
+
+using namespace o2;
+using namespace o2::framework;
+using RDH = o2::header::RDHAny;
+
+namespace o2
+{
+namespace mch
+{
+namespace raw
+{
+
+//=======================
+// Data parser
+class DataParserTask
+{
+ public:
+  DataParserTask(std::string spec) : mInputSpec(spec) {}
+
+  //_________________________________________________________________________________________________
+  void init(framework::InitContext& ic)
+  {
+  }
+
+  void decodeBuffer(gsl::span<const std::byte> page){};
+
+  //_________________________________________________________________________________________________
+  void run(framework::ProcessingContext& pc)
+  {
+    // get the input buffer
+    DPLRawParser parser(pc.inputs(), o2::framework::select(mInputSpec.c_str()));
+
+    int nRDH = 0;
+
+    const std::byte* raw = nullptr;
+    for (auto it = parser.begin(), end = parser.end(); it != end; ++it) {
+      raw = reinterpret_cast<const std::byte*>(it.raw());
+      if (!raw) {
+        continue;
+      }
+
+      auto* rdh = reinterpret_cast<const RDH*>(raw);
+
+      if (nRDH == 0) {
+        std::cout << std::endl
+                  << "---------------" << std::endl;
+        o2::raw::RDHUtils::printRDH(rdh);
+        //std::cout << "......." << std::endl;
+      }
+      nRDH += 1;
+    }
+
+    if (false && raw) {
+      auto* rdh = reinterpret_cast<const RDH*>(raw);
+      o2::raw::RDHUtils::printRDH(rdh);
+    }
+    std::cout << "---------------" << std::endl;
+  }
+
+ private:
+  std::string mInputSpec;
+};
+
+} // namespace raw
+} // namespace mch
+} // end namespace o2
+
+WorkflowSpec defineDataProcessing(const ConfigContext& config)
+{
+  auto inputSpec = config.options().get<std::string>("dataspec");
+
+  WorkflowSpec specs;
+
+  o2::mch::raw::DataParserTask task(inputSpec);
+  DataProcessorSpec parser{
+    "RawParser",
+    o2::framework::select(inputSpec.c_str()),
+    Outputs{},
+    AlgorithmSpec{adaptFromTask<o2::mch::raw::DataParserTask>(std::move(task))},
+    Options{}};
+
+  specs.push_back(parser);
+
+  return specs;
+}

Detectors/MUON/MCH/Workflow/src/raw-to-digits-workflow.cxx

@@ -23,17 +23,30 @@
 #include "Framework/CallbackService.h"
 #include "Framework/ControlService.h"
 #include "Framework/Task.h"
-#include "Framework/runDataProcessing.h"
+
+#include "Framework/ConfigParamSpec.h"
+#include "Framework/CompletionPolicyHelpers.h"
 #include "MCHWorkflow/DataDecoderSpec.h"
 
+using namespace o2::framework;
+
+void customize(std::vector<ConfigParamSpec>& workflowOptions)
+{
+  workflowOptions.push_back(ConfigParamSpec{"dataspec", VariantType::String, "TF:MCH/RAWDATA", {"selection string for the input data"}});
+}
+
+#include "Framework/runDataProcessing.h"
+
 using namespace o2;
 using namespace o2::framework;
 
-WorkflowSpec defineDataProcessing(const ConfigContext&)
+WorkflowSpec defineDataProcessing(const ConfigContext& config)
 {
+  auto inputSpec = config.options().get<std::string>("dataspec");
+
   WorkflowSpec specs;
 
-  DataProcessorSpec producer = o2::mch::raw::getDecodingSpec();
+  DataProcessorSpec producer = o2::mch::raw::getDecodingSpec(inputSpec);
   specs.push_back(producer);
 
   return specs;