Utilities/interface/DAQSourceModels.h

0001 #ifndef EventFilter_Utilities_DAQSourceModels_h
0002 #define EventFilter_Utilities_DAQSourceModels_h
0003
0004 /*
0005  * Base class defining modular interface for DAQSource data models
0006  * See doc/README-DTH.md for interface description
0007  */
0008
0009 #include <condition_variable>
0010 #include <cstdio>
0011 #include <filesystem>
0012 #include <memory>
0013 #include <mutex>
0014 #include <thread>
0015
0016 #include "tbb/concurrent_queue.h"
0017 #include "tbb/concurrent_vector.h"
0018
0019 #include "DataFormats/Provenance/interface/ProcessHistoryID.h"
0020 #include "DataFormats/Provenance/interface/Timestamp.h"
0021 #include "EventFilter/Utilities/interface/EvFDaqDirector.h"
0022 #include "FWCore/Sources/interface/RawInputSource.h"
0023 #include "FWCore/Framework/interface/EventPrincipal.h"
0024 #include "FWCore/Sources/interface/DaqProvenanceHelper.h"
0025 #include "FWCore/ServiceRegistry/interface/Service.h"
0026 #include "IOPool/Streamer/interface/FRDEventMessage.h"
0027
0028 #include "DataFormats/FEDRawData/interface/FEDNumbering.h"
0029 #include "DataFormats/Provenance/interface/LuminosityBlockAuxiliary.h"
0030
0031 //import InputChunk
0032 #include "EventFilter/Utilities/interface/SourceRawFile.h"
0033
0034 class RawInputFile;
0035 class UnpackedRawEventWrapper;
0036 class DAQSource;
0037
0038 //evf?
0039 class DataMode {
0040 public:
0041   DataMode(DAQSource* daqSource) : daqSource_(daqSource) {}
0042   virtual ~DataMode() = default;
0043   virtual std::vector<std::shared_ptr<const edm::DaqProvenanceHelper>>& makeDaqProvenanceHelpers() = 0;
0044   virtual void readEvent(edm::EventPrincipal& eventPrincipal) = 0;
0045   virtual int dataVersion() const = 0;
0046   virtual void detectVersion(unsigned char* fileBuf, uint32_t fileHeaderOffset) = 0;
0047   virtual uint32_t headerSize() const = 0;
0048   virtual bool versionCheck() const = 0;
0049   virtual uint64_t dataBlockSize() const = 0;
0050   virtual void makeDataBlockView(unsigned char* addr, RawInputFile* rawFile) = 0;
0051   virtual bool nextEventView(RawInputFile*) = 0;
0052   virtual bool blockChecksumValid() = 0;
0053   virtual bool checksumValid() = 0;
0054   virtual std::string getChecksumError() const = 0;
0055   virtual uint32_t run() const = 0;
0056   virtual bool dataBlockCompleted() const = 0;
0057   virtual bool requireHeader() const = 0;
0058   virtual bool fitToBuffer() const = 0;
0059   virtual void unpackFile(RawInputFile* file) = 0;
0060
0061   virtual bool dataBlockInitialized() const = 0;
0062   virtual void setDataBlockInitialized(bool) = 0;
0063
0064   virtual void setTCDSSearchRange(uint16_t, uint16_t) = 0;
0065   virtual std::pair<bool, std::vector<std::string>> defineAdditionalFiles(std::string const& primaryName,
0066                                                                           bool fileListMode) const = 0;
0067
0068   virtual bool isMultiDir() const { return false; }
0069   virtual void makeDirectoryEntries(std::vector<std::string> const& baseDirs,
0070                                     std::vector<int> const& numSources,
0071                                     std::vector<int> const& sourceIDs,
0072                                     std::string const& sourceIdentifier,
0073                                     std::string const& runDir) = 0;
0074   void setTesting(bool testing) { testing_ = testing; }
0075
0076   bool errorDetected() { return errorDetected_; }
0077
0078   //pre-parse file to count events
0079   virtual bool hasEventCounterCallback() const { return false; }
0080   virtual int eventCounterCallback(std::string const& name, int& fd, int64_t& fsize, uint32_t sLS, bool& found) const {
0081     return -1;
0082   }
0083
0084 protected:
0085   DAQSource* daqSource_;
0086   bool testing_ = false;
0087   bool errorDetected_ = false;
0088 };
0089
0090 #endif  // EventFilter_Utilities_DAQSourceModels_h