Merge pull request #47952 from smorovic/151-daqsource-fix

[DAQ] Improved event checks (15_1_X)

Author: cmsbuild

EventFilter/Utilities/interface/DAQSource.h

@@ -1,6 +1,15 @@
 #ifndef EventFilter_Utilities_DAQSource_h
 #define EventFilter_Utilities_DAQSource_h
 
+/*
+ * DAQSource - modular input source supporting multiple
+ * buffering strategies and data formats. Specific formats are included
+ * as models defined as DataMode child class.
+ * Source supports DAQ file protocol using specific input file naming schema
+ * and JSON metadata files.
+ * See doc/READHME-DTH.md for more information, including file naming formats
+ */
+
 #include <condition_variable>
 #include <cstdio>
 #include <filesystem>
@@ -104,6 +113,7 @@ class DAQSource : public edm::RawInputSource {
   // get LS from filename instead of event header
   const bool alwaysStartFromFirstLS_;
   const bool verifyChecksum_;
+  const bool inputConsistencyChecks_;
   const bool useL1EventID_;
   const std::vector<unsigned int> testTCDSFEDRange_;
   std::vector<std::string> listFileNames_;

EventFilter/Utilities/interface/DAQSourceModels.h

@@ -1,6 +1,11 @@
 #ifndef EventFilter_Utilities_DAQSourceModels_h
 #define EventFilter_Utilities_DAQSourceModels_h
 
+/*
+ * Base class defining modular interface for DAQSource data models
+ * See doc/README-DTH.md for interface description
+ */
+
 #include <condition_variable>
 #include <cstdio>
 #include <filesystem>

EventFilter/Utilities/interface/DAQSourceModelsDTH.h

@@ -1,6 +1,17 @@
 #ifndef EventFilter_Utilities_DAQSourceModelsDTH_h
 #define EventFilter_Utilities_DAQSourceModelsDTH_h
 
+/*
+ * DAQ Source module for DTH readout
+ * Used by modular DAQSource to read files containing raw DTH orbit payload.
+ * Orbits are unpacked into individual events which are queued to the framework as FedRawDataCollection object.
+ * If more than one sourceID blocks is included they will all be unpacked, they need to be adjacent in the file
+ * for the same orbit. Exception to this is reading from multiple file sources,
+ * in that case that is only required locally in a file, but orbits need to come in the same order in all files.
+ * See test/RunBUFU.sh and test/testDTH.sh for example how to run with this module
+ * Also see documentation in doc/README=DTH.md
+*/
+
 #include <filesystem>
 #include <queue>
 #include <regex>

EventFilter/Utilities/interface/DAQSourceModelsFRD.h

@@ -1,16 +1,30 @@
 #ifndef EventFilter_Utilities_DAQSourceModelsFRD_h
 #define EventFilter_Utilities_DAQSourceModelsFRD_h
 
+/*
+* DAQSource data model classes for reading Run3 FRD format and unpacking into the FedRawDataCollection
+* FRD: standard readout of input from the event builder
+* FRDPreUNpack: variant unpacking events tns nto FedRawDataCollection class in reader threads
+* FRSStiped: more generic version able to read from multiple source
+* directories (Super-Fragmeng Builder DAQ)
+* */
+
 #include <filesystem>
 #include <queue>
+#include "oneapi/tbb/concurrent_unordered_set.h"
 
 #include "EventFilter/Utilities/interface/DAQSourceModels.h"
 #include "DataFormats/FEDRawData/interface/FEDRawDataCollection.h"
 
 class FEDRawDataCollection;
 
+/*
+ * FRD unpacker equivalent to the FedRawDataInputSource
+ */
+
 class DataModeFRD : public DataMode {
 public:
+  DataModeFRD(DAQSource* daqSource, bool verifyFEDs) : DataMode(daqSource), verifyFEDs_(verifyFEDs) {}
   DataModeFRD(DAQSource* daqSource) : DataMode(daqSource) {}
   ~DataModeFRD() override {}
   std::vector<std::shared_ptr<const edm::DaqProvenanceHelper>>& makeDaqProvenanceHelpers() override;
@@ -82,21 +96,24 @@ class DataModeFRD : public DataMode {
   uint16_t MINTCDSuTCAFEDID_ = FEDNumbering::MINTCDSuTCAFEDID;
   uint16_t MAXTCDSuTCAFEDID_ = FEDNumbering::MAXTCDSuTCAFEDID;
   bool eventCached_ = false;
+  std::unordered_set<unsigned short> fedIdSet_;
+  unsigned int expectedFedsInEvent_ = 0;
+  bool verifyFEDs_ = true;
 };
 
 /*
- * FRD source prebuffering in reader thread
+ * FRD source prebuffering in the reader thread
  */
 
 class DataModeFRDPreUnpack : public DataMode {
 public:
-  DataModeFRDPreUnpack(DAQSource* daqSource) : DataMode(daqSource) {}
+  DataModeFRDPreUnpack(DAQSource* daqSource, bool verifyFEDs) : DataMode(daqSource), verifyFEDs_(verifyFEDs) {}
   ~DataModeFRDPreUnpack() override {};
   std::vector<std::shared_ptr<const edm::DaqProvenanceHelper>>& makeDaqProvenanceHelpers() override;
   void readEvent(edm::EventPrincipal& eventPrincipal) override;
 
   //non-virtual
-  void unpackEvent(edm::streamer::FRDEventMsgView* eview, UnpackedRawEventWrapper* ec);
+  void unpackEvent(edm::streamer::FRDEventMsgView* eview, UnpackedRawEventWrapper* ec, unsigned int ls);
   void unpackFile(RawInputFile*) override;
   edm::Timestamp fillFEDRawDataCollection(edm::streamer::FRDEventMsgView* eview,
                                           FEDRawDataCollection& rawData,
@@ -164,16 +181,19 @@ class DataModeFRDPreUnpack : public DataMode {
   uint16_t MINTCDSuTCAFEDID_ = FEDNumbering::MINTCDSuTCAFEDID;
   uint16_t MAXTCDSuTCAFEDID_ = FEDNumbering::MAXTCDSuTCAFEDID;
   bool eventCached_ = false;
+  oneapi::tbb::concurrent_unordered_set<unsigned short> fedIdSet_;
+  std::atomic<unsigned int> expectedFedsInEvent_ = 0;
+  bool verifyFEDs_ = true;
 };
 
 /* 
- * FRD source reading files from multiple striped destinations
+ * FRD source reading files from multiple striped destinations (Super-Fragment Builder DAQ)
  *
  * */
 
 class DataModeFRDStriped : public DataMode {
 public:
-  DataModeFRDStriped(DAQSource* daqSource) : DataMode(daqSource) {}
+  DataModeFRDStriped(DAQSource* daqSource, bool verifyFEDs) : DataMode(daqSource), verifyFEDs_(verifyFEDs) {}
   ~DataModeFRDStriped() override {}
   std::vector<std::shared_ptr<const edm::DaqProvenanceHelper>>& makeDaqProvenanceHelpers() override;
   void readEvent(edm::EventPrincipal& eventPrincipal) override;
@@ -258,6 +278,9 @@ class DataModeFRDStriped : public DataMode {
   uint16_t MINTCDSuTCAFEDID_ = FEDNumbering::MINTCDSuTCAFEDID;
   uint16_t MAXTCDSuTCAFEDID_ = FEDNumbering::MAXTCDSuTCAFEDID;
   std::vector<std::filesystem::path> buPaths_;
+  std::unordered_set<unsigned short> fedIdSet_;
+  unsigned int expectedFedsInEvent_ = 0;
+  bool verifyFEDs_ = true;
 };
 
 #endif  // EventFilter_Utilities_DAQSourceModelsFRD_h

EventFilter/Utilities/interface/FedRawDataInputSource.h

@@ -185,6 +185,7 @@ class FedRawDataInputSource : public edm::RawInputSource {
 
   std::map<unsigned int, unsigned int> sourceEventsReport_;
   std::mutex monlock_;
+  unsigned int expectedFedsInEvent_ = 0;
 };
 
 #endif  // EventFilter_Utilities_FedRawDataInputSource_h

EventFilter/Utilities/plugins/DaqFakeReader.cc

@@ -41,9 +41,28 @@ DaqFakeReader::DaqFakeReader(const edm::ParameterSet& pset)
       injected_errors_per_million_events(pset.getUntrackedParameter<unsigned int>("injectErrPpm", 0)),
       tcdsFEDID_(pset.getUntrackedParameter<unsigned int>("tcdsFEDID", 1024)),
       modulo_error_events(injected_errors_per_million_events ? 1000000 / injected_errors_per_million_events
-                                                             : 0xffffffff) {
+                                                             : 0xffffffff),
+      subsystems_(pset.getUntrackedParameter<std::vector<std::string>>("subsystems")) {
+  for (auto const& subsystem : subsystems_) {
+    if (subsystem == "TCDS")
+      haveTCDS_ = true;
+    else if (subsystem == "SiPixel")
+      haveSiPixel_ = true;
+    else if (subsystem == "SiStrip")
+      haveSiStrip_ = true;
+    else if (subsystem == "ECAL")
+      haveECAL_ = true;
+    else if (subsystem == "HCAL")
+      haveHCAL_ = true;
+    else if (subsystem == "DT")
+      haveDT_ = true;
+    else if (subsystem == "CSC")
+      haveCSC_ = true;
+    else if (subsystem == "RPC")
+      haveRPC_ = true;
+  }
   // mean = pset.getParameter<float>("mean");
-  if (tcdsFEDID_ < FEDNumbering::MINTCDSuTCAFEDID)
+  if (haveTCDS_ && tcdsFEDID_ < FEDNumbering::MINTCDSuTCAFEDID)
     throw cms::Exception("DaqFakeReader::DaqFakeReader")
         << " TCDS FED ID lower than " << FEDNumbering::MINTCDSuTCAFEDID;
   if (fillRandom_) {
@@ -74,17 +93,25 @@ int DaqFakeReader::fillRawData(Event& e, FEDRawDataCollection*& data) {
     eventNum++;
     // FIXME:
 
-    fillFEDs(FEDNumbering::MINSiPixelFEDID, FEDNumbering::MAXSiPixelFEDID, eID, *data, meansize, width);
-    fillFEDs(FEDNumbering::MINSiStripFEDID, FEDNumbering::MAXSiStripFEDID, eID, *data, meansize, width);
-    fillFEDs(FEDNumbering::MINDTFEDID, FEDNumbering::MAXDTFEDID, eID, *data, meansize, width);
-    fillFEDs(FEDNumbering::MINCSCFEDID, FEDNumbering::MAXCSCFEDID, eID, *data, meansize, width);
-    fillFEDs(FEDNumbering::MINRPCFEDID, FEDNumbering::MAXRPCFEDID, eID, *data, meansize, width);
-    fillFEDs(FEDNumbering::MINECALFEDID, FEDNumbering::MAXECALFEDID, eID, *data, meansize, width);
-    fillFEDs(FEDNumbering::MINHCALFEDID, FEDNumbering::MAXHCALFEDID, eID, *data, meansize, width);
+    if (haveSiPixel_)
+      fillFEDs(FEDNumbering::MINSiPixelFEDID, FEDNumbering::MAXSiPixelFEDID, eID, *data, meansize, width);
+    if (haveSiStrip_)
+      fillFEDs(FEDNumbering::MINSiStripFEDID, FEDNumbering::MAXSiStripFEDID, eID, *data, meansize, width);
+    if (haveECAL_)
+      fillFEDs(FEDNumbering::MINECALFEDID, FEDNumbering::MAXECALFEDID, eID, *data, meansize, width);
+    if (haveHCAL_)
+      fillFEDs(FEDNumbering::MINHCALFEDID, FEDNumbering::MAXHCALFEDID, eID, *data, meansize, width);
+    if (haveDT_)
+      fillFEDs(FEDNumbering::MINDTFEDID, FEDNumbering::MAXDTFEDID, eID, *data, meansize, width);
+    if (haveCSC_)
+      fillFEDs(FEDNumbering::MINCSCFEDID, FEDNumbering::MAXCSCFEDID, eID, *data, meansize, width);
+    if (haveRPC_)
+      fillFEDs(FEDNumbering::MINRPCFEDID, FEDNumbering::MAXRPCFEDID, eID, *data, meansize, width);
 
     timeval now;
     gettimeofday(&now, nullptr);
-    fillTCDSFED(eID, *data, ls, &now);
+    if (haveTCDS_)
+      fillTCDSFED(eID, *data, ls, &now);
   }
   return 1;
 }
@@ -195,5 +222,8 @@ void DaqFakeReader::fillDescriptions(edm::ConfigurationDescriptions& description
   desc.addUntracked<unsigned int>("width", 1024);
   desc.addUntracked<unsigned int>("injectErrPpm", 1024);
   desc.addUntracked<unsigned int>("tcdsFEDID", 1024);
+  desc.addUntracked<std::vector<std::string>>(
+      "subsystems",
+      std::initializer_list<std::string>({"TCDS", "SiPixel", "SiStrip", "ECAL", "HCAL", "DT", "CSC", "RPC"}));
   descriptions.add("DaqFakeReader", desc);
 }

EventFilter/Utilities/plugins/DaqFakeReader.h

@@ -58,6 +58,15 @@ class DaqFakeReader : public edm::one::EDProducer<> {
   unsigned int tcdsFEDID_;
   unsigned int modulo_error_events;
   unsigned int fakeLs_ = 0;
+  std::vector<std::string> subsystems_;
+  bool haveTCDS_ = false;
+  bool haveSiPixel_ = false;
+  bool haveSiStrip_ = false;
+  bool haveECAL_ = false;
+  bool haveHCAL_ = false;
+  bool haveDT_ = false;
+  bool haveCSC_ = false;
+  bool haveRPC_ = false;
 };
 
 #endif

EventFilter/Utilities/src/DAQSource.cc

@@ -43,6 +43,7 @@ DAQSource::DAQSource(edm::ParameterSet const& pset, edm::InputSourceDescription
       maxBufferedFiles_(pset.getUntrackedParameter<unsigned int>("maxBufferedFiles")),
       alwaysStartFromFirstLS_(pset.getUntrackedParameter<bool>("alwaysStartFromFirstLS", false)),
       verifyChecksum_(pset.getUntrackedParameter<bool>("verifyChecksum")),
+      inputConsistencyChecks_(pset.getUntrackedParameter<bool>("inputConsistencyChecks")),
       useL1EventID_(pset.getUntrackedParameter<bool>("useL1EventID")),
       testTCDSFEDRange_(pset.getUntrackedParameter<std::vector<unsigned int>>("testTCDSFEDRange")),
       listFileNames_(pset.getUntrackedParameter<std::vector<std::string>>("fileNames")),
@@ -83,11 +84,11 @@ DAQSource::DAQSource(edm::ParameterSet const& pset, edm::InputSourceDescription
 
   //load mode class based on parameter
   if (dataModeConfig_ == "FRD") {
-    dataMode_ = std::make_shared<DataModeFRD>(this);
+    dataMode_ = std::make_shared<DataModeFRD>(this, inputConsistencyChecks_);
   } else if (dataModeConfig_ == "FRDPreUnpack") {
-    dataMode_ = std::make_shared<DataModeFRDPreUnpack>(this);
+    dataMode_ = std::make_shared<DataModeFRDPreUnpack>(this, inputConsistencyChecks_);
   } else if (dataModeConfig_ == "FRDStriped") {
-    dataMode_ = std::make_shared<DataModeFRDStriped>(this);
+    dataMode_ = std::make_shared<DataModeFRDStriped>(this, inputConsistencyChecks_);
   } else if (dataModeConfig_ == "ScoutingRun3") {
     dataMode_ = std::make_shared<DataModeScoutingRun3>(this);
   } else if (dataModeConfig_ == "DTH") {
@@ -259,6 +260,8 @@ void DAQSource::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
       ->setComment("Force source to start from LS 1 if server provides higher lumisection number");
   desc.addUntracked<bool>("verifyChecksum", true)
       ->setComment("Verify event CRC-32C checksum of FRDv5 and higher or Adler32 with v3 and v4");
+  desc.addUntracked<bool>("inputConsistencyChecks", true)
+      ->setComment("Additional consistency checks such as checking that the FED ID set is the same in all events");
   desc.addUntracked<bool>("useL1EventID", false)
       ->setComment("Use L1 event ID from FED header if true or from TCDS FED if false");
   desc.addUntracked<std::vector<unsigned int>>("testTCDSFEDRange", std::vector<unsigned int>())