#include <DQMStreamerReader.h>

Inheritance diagram for dqmservices::DQMStreamerReader:

Classes
struct	OpenFile

Public Member Functions
	DQMStreamerReader (edm::ParameterSet const &pset, edm::InputSourceDescription const &desc)

bool	newHeader ()

	~DQMStreamerReader () override

Public Member Functions inherited from edm::streamer::StreamerInputSource
void	deserializeAndMergeWithRegistry (InitMsgView const &initView, bool subsequent=false)

void	deserializeEvent (EventMsgView const &eventView)

void	deserializeEventMetaData (EventMsgView const &eventView)

std::unique_ptr< SendJobHeader >	deserializeRegistry (InitMsgView const &initView)

uint32_t	eventMetaDataChecksum (EventMsgView const &eventView) const

bool	isBufferLZMA (unsigned char const *inputBuffer, unsigned int inputSize)

bool	isBufferZSTD (unsigned char const *inputBuffer, unsigned int inputSize)

uint32_t	presentEventMetaDataChecksum () const

	StreamerInputSource (ParameterSet const &pset, InputSourceDescription const &desc)

void	updateEventMetaData ()

	~StreamerInputSource () override

Public Member Functions inherited from edm::RawInputSource
	RawInputSource (ParameterSet const &pset, InputSourceDescription const &desc)

	~RawInputSource () override

Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...

std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...

std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()

void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...

void	doBeginJob ()
	Called by framework at beginning of job. More...

virtual void	doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
	Called by framework at beginning of lumi block. More...

virtual void	doBeginRun (RunPrincipal &rp, ProcessContext const *)
	Called by framework at beginning of run. More...

void	doEndJob ()
	Called by framework at end of job. More...

void	fillProcessBlockHelper ()
	Fill the ProcessBlockHelper with info for the current file. More...

ProcessingController::ForwardState	forwardState () const

bool	goToEvent (EventID const &eventID)

	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...

	InputSource (InputSource const &)=delete

void	issueReports (EventID const &eventID, StreamID streamID)
	issue an event report More...

LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number. More...

std::shared_ptr< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache. More...

int	maxEvents () const

int	maxLuminosityBlocks () const

ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...

ItemTypeInfo	nextItemType ()
	Advances the source to the next item. More...

bool	nextProcessBlock (ProcessBlockPrincipal &)
	Next process block, return false if there is none, sets the processName in the principal. More...

InputSource &	operator= (InputSource const &)=delete

std::shared_ptr< ProcessBlockHelper const >	processBlockHelper () const
	Accessors for processBlockHelper. More...

std::shared_ptr< ProcessBlockHelper > &	processBlockHelper ()

ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...

std::string const &	processGUID () const
	Accessor for global process identifier. More...

ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...

ProcessHistoryRegistry &	processHistoryRegistry ()

ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...

std::shared_ptr< ProductRegistry const >	productRegistry () const
	Accessors for product registry. More...

bool	randomAccess () const

void	readAndMergeLumi (LuminosityBlockPrincipal &lbp)
	Read next luminosity block (same as a prior lumi) More...

void	readAndMergeRun (RunPrincipal &rp)
	Read next run (same as a prior run) More...

void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...

bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...

std::shared_ptr< FileBlock >	readFile ()
	Read next file. More...

void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...

std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...

void	readProcessBlock (ProcessBlockPrincipal &)
	Read next process block. More...

void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...

std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...

ProcessHistoryID const &	reducedProcessHistoryID () const

virtual void	registerProducts ()
	Register any produced products. More...

int	remainingEvents () const

int	remainingLuminosityBlocks () const

void	repeat ()
	Reset the remaining number of events/lumis to the maximum number. More...

std::pair< SharedResourcesAcquirer , std::recursive_mutex >	resourceSharedWithDelayedReader ()
	Returns nullptr if no resource shared between the Source and a DelayedReader. More...

ProcessingController::ReverseState	reverseState () const

void	rewind ()
	Begin again at the first event. More...

RunNumber_t	run () const
	Accessor for current run number. More...

std::shared_ptr< RunAuxiliary >	runAuxiliary () const
	Called by the framework to merge or insert run in principal cache. More...

void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID. More...

void	setRunNumber (RunNumber_t r)
	Set the run number. More...

void	skipEvents (int offset)

void	switchTo (std::shared_ptr< ProductRegistry > iOther)
	switch to a different ProductRegistry. More...

std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...

std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()

Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...

virtual	~InputSource () noexcept(false)
	Destructor. More...

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::streamer::StreamerInputSource
static void	fillDescription (ParameterSetDescription &description)

static void	mergeIntoRegistry (SendJobHeader const &header, ProductRegistry &, bool subsequent)

static unsigned int	uncompressBuffer (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize)

static unsigned int	uncompressBufferLZMA (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize, bool hasHeader=true)

static unsigned int	uncompressBufferZSTD (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize, bool hasHeader=true)

Static Public Member Functions inherited from edm::RawInputSource
static void	fillDescription (ParameterSetDescription &description)

Static Public Member Functions inherited from edm::InputSource
static const std::string &	baseType ()

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
Next	checkNext () override

void	genuineCloseFile () override

void	genuineReadFile () override

void	skip (int toSkip) override

Protected Member Functions inherited from edm::streamer::StreamerInputSource
void	resetAfterEndRun ()

Protected Member Functions inherited from edm::RawInputSource
void	makeEvent (EventPrincipal &eventPrincipal, EventAuxiliary const &eventAuxiliary)

void	setInputFileTransitionsEachEvent ()

Protected Member Functions inherited from edm::InputSource
virtual void	beginJob ()
	Begin protected makes it easier to do template programming. More...

void	decreaseRemainingEventsBy (int iSkipped)

bool	eventCached () const

bool	newLumi () const

bool	newRun () const

ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()

ProductRegistry &	productRegistryUpdate ()

void	reset () const

void	resetEventCached ()

void	resetLuminosityBlockAuxiliary (bool isNewLumi=true) const

void	resetNewLumi ()

void	resetNewRun ()

void	resetRunAuxiliary (bool isNewRun=true) const

void	setEventCached ()
	Called by the framework to merge or ached() const {return eventCached_;}. More...

void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)

void	setNewLumi ()

void	setNewRun ()

void	setRunAuxiliary (RunAuxiliary *rp)

void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...

ItemTypeInfo	state () const

Private Member Functions
bool	acceptEvent (const edm::streamer::EventMsgView *)

void	closeFileImp_ (const std::string &reason)

edm::streamer::EventMsgView const *	getEventMsg ()

edm::streamer::InitMsgView const *	getHeaderMsg ()

void	openFileImp_ (const DQMFileIterator::LumiEntry &entry)

bool	openNextFileImp_ ()

edm::streamer::EventMsgView const *	prepareNextEvent ()

bool	prepareNextFile ()

void	reset_ () override

bool	setAcceptAllEvt ()

bool	setMatchTriggerSel (std::vector< std::string > const &tnames)

void	setupMetaData (edm::streamer::InitMsgView const &msg, bool subsequent)

Private Attributes
bool	acceptAllEvt_ = false

bool	artificialFileBoundary_ = false

std::shared_ptr< edm::EventSkipperByID >	eventSkipperByID_

struct dqmservices::DQMStreamerReader::OpenFile	file_

DQMFileIterator	fiterator_

bool const	flagDeleteDatFiles_

bool const	flagEndOfRunKills_

bool const	flagSkipFirstLumis_

std::vector< std::string > const	hltSel_

bool	isFirstFile_ = true

bool	matchTriggerSel_ = false

unsigned int const	minEventsPerLs_

unsigned int	processedEventPerLs_ = 0

std::shared_ptr< TriggerSelector >	triggerSelector_

bool const	unitTest_

Additional Inherited Members
Public Types inherited from edm::RawInputSource
enum	Next { Next::kEvent, Next::kFile, Next::kStop }

Public Types inherited from edm::InputSource
enum	ItemPosition : char { ItemPosition::Invalid, ItemPosition::LastItemToBeMerged, ItemPosition::NotLastItemToBeMerged }

enum	ItemType : char { ItemType::IsInvalid, ItemType::IsStop, ItemType::IsFile, ItemType::IsRun, ItemType::IsLumi, ItemType::IsEvent, ItemType::IsRepeat, ItemType::IsSynchronize }

enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	postEventReadFromSourceSignal_

signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	preEventReadFromSourceSignal_

Static Protected Member Functions inherited from edm::streamer::StreamerInputSource
static void	buildClassCache (SendDescs const &descs)

static void	declareStreamers (SendDescs const &descs)

Detailed Description

Definition at line 17 of file DQMStreamerReader.h.

Constructor & Destructor Documentation

◆ DQMStreamerReader()

dqmservices::DQMStreamerReader::DQMStreamerReader	(	edm::ParameterSet const &	pset,
		edm::InputSourceDescription const &	desc
	)

Definition at line 23 of file DQMStreamerReader.cc.

References reset_(), and setAcceptAllEvt().

       : StreamerInputSource(pset, desc),
         fiterator_(pset),
         minEventsPerLs_(pset.getUntrackedParameter<int>("minEventsPerLumi")),
         flagSkipFirstLumis_(pset.getUntrackedParameter<bool>("skipFirstLumis")),
         flagEndOfRunKills_(pset.getUntrackedParameter<bool>("endOfRunKills")),
         flagDeleteDatFiles_(pset.getUntrackedParameter<bool>("deleteDatFiles")),
         hltSel_(pset.getUntrackedParameter<std::vector<std::string>>("SelectEvents")),
         unitTest_(pset.getUntrackedParameter<bool>("unitTest", false)) {
     setAcceptAllEvt();
     reset_();
   }

◆ ~DQMStreamerReader()

dqmservices::DQMStreamerReader::~DQMStreamerReader ( )

override

Definition at line 36 of file DQMStreamerReader.cc.

                                         {
     // Sometimes(?) the destructor called after service registry was already destructed
     // and closeFile_ throws away no ServiceRegistry found exception...
     //
     // Normally, this file should be closed before this destructor is called.
     //closeFileImp_("destructor");
   }

Member Function Documentation

◆ acceptEvent()

bool dqmservices::DQMStreamerReader::acceptEvent ( const edm::streamer::EventMsgView * evtmsg )

private

Check the trigger path to accept event

Definition at line 411 of file DQMStreamerReader.cc.

References acceptAllEvt_, edm::streamer::EventMsgView::hltCount(), edm::streamer::EventMsgView::hltTriggerBits(), matchTriggerSel_, and triggerSelector_.

Referenced by prepareNextEvent().

                                                                 {
     if (acceptAllEvt_)
       return true;
     if (!matchTriggerSel_)
       return false;
 
     std::vector<unsigned char> hltTriggerBits_;
     int hltTriggerCount_ = evtmsg->hltCount();
     if (hltTriggerCount_ > 0) {
       hltTriggerBits_.resize(1 + (hltTriggerCount_ - 1) / 4);
     }
     evtmsg->hltTriggerBits(&hltTriggerBits_[0]);
 
     return (triggerSelector_->wantAll() || triggerSelector_->acceptEvent(&hltTriggerBits_[0], evtmsg->hltCount()));
   }

◆ checkNext()

edm::RawInputSource::Next dqmservices::DQMStreamerReader::checkNext ( )

overrideprotectedvirtual

This is the actual code for checking the new event and/or deserializing it.

Implements edm::RawInputSource.

Definition at line 344 of file DQMStreamerReader.cc.

References artificialFileBoundary_, closeFileImp_(), edm::streamer::StreamerInputSource::deserializeEvent(), MillePedeFileConverter_cfg::e, file_, fiterator_, edm::RawInputSource::kEvent, edm::RawInputSource::kFile, edm::RawInputSource::kStop, dqmservices::DQMFileIterator::logFileAction(), or, prepareNextEvent(), processedEventPerLs_, dqmservices::DQMStreamerReader::OpenFile::streamFile_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                      {
     try {
       EventMsgView const* eview = prepareNextEvent();
       if (eview == nullptr) {
         if (artificialFileBoundary_ or (file_.streamFile_ and file_.streamFile_->newHeader())) {
           return Next::kFile;
         }
         return Next::kStop;
       }
 
       deserializeEvent(*eview);
     } catch (const cms::Exception& e) {
       // try to recover from corrupted files/events
       fiterator_.logFileAction(std::string("Can't deserialize event or registry data: ") + e.what());
       closeFileImp_("data file corrupted");
 
       // this is not optimal, but hopefully we won't catch this many times in a row
       return checkNext();
     }
 
     processedEventPerLs_ += 1;
 
     return Next::kEvent;
   }

◆ closeFileImp_()

void dqmservices::DQMStreamerReader::closeFileImp_ ( const std::string & reason )

private

Definition at line 134 of file DQMStreamerReader.cc.

References file_, fiterator_, dqmservices::DQMFileIterator::logLumiState(), dqmservices::DQMStreamerReader::OpenFile::lumi_, dqmservices::DQMStreamerReader::OpenFile::open(), PixelMapPlotter::reason, and dqmservices::DQMStreamerReader::OpenFile::streamFile_.

Referenced by checkNext(), openNextFileImp_(), prepareNextEvent(), prepareNextFile(), and skip().

                                                                {
     if (file_.open()) {
       file_.streamFile_->closeStreamerFile();
       file_.streamFile_ = nullptr;
 
       fiterator_.logLumiState(file_.lumi_, "close: " + reason);
     }
   }

◆ fillDescriptions()

void dqmservices::DQMStreamerReader::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 443 of file DQMStreamerReader.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, edm::EventSkipperByID::fillDescription(), edm::streamer::StreamerInputSource::fillDescription(), and dqmservices::DQMFileIterator::fillDescription().

                                                                                      {
     edm::ParameterSetDescription desc;
     desc.setComment("Reads events from streamer files.");
 
     desc.addUntracked<std::vector<std::string>>("SelectEvents")->setComment("HLT path to select events");
 
     desc.addUntracked<int>("minEventsPerLumi", 1)
         ->setComment(
             "Minimum number of events to process per lumisection, "
             "before switching to a new input file. If the next file "
             "does not yet exist, "
             "the number of processed events will be bigger.");
 
     desc.addUntracked<bool>("skipFirstLumis", false)
         ->setComment(
             "Skip (and ignore the minEventsPerLumi parameter) for the files "
             "which have been available at the begining of the processing. "
             "If set to true, the reader will open last available file for "
             "processing.");
 
     desc.addUntracked<bool>("deleteDatFiles", false)
         ->setComment(
             "Delete data files after they have been closed, in order to "
             "save disk space.");
 
     desc.addUntracked<bool>("endOfRunKills", false)
         ->setComment(
             "Kill the processing as soon as the end-of-run file appears, even if "
             "there are/will be unprocessed lumisections.");
 
     desc.addUntracked<bool>("unitTest", false)
         ->setComment("Kill the processing if the input data cannot be deserialized");
 
     // desc.addUntracked<unsigned int>("skipEvents", 0U)
     //    ->setComment("Skip the first 'skipEvents' events that otherwise would "
     //                 "have been processed.");
 
     // This next parameter is read in the base class, but its default value
     // depends on the derived class, so it is set here.
     desc.addUntracked<bool>("inputFileTransitionsEachEvent", false);
 
     DQMFileIterator::fillDescription(desc);
     StreamerInputSource::fillDescription(desc);
     edm::EventSkipperByID::fillDescription(desc);
 
     descriptions.add("source", desc);
   }

◆ genuineCloseFile()

void dqmservices::DQMStreamerReader::genuineCloseFile ( )

overrideprotectedvirtual

Reimplemented from edm::RawInputSource.

Definition at line 132 of file DQMStreamerReader.cc.

132 {}

◆ genuineReadFile()

void dqmservices::DQMStreamerReader::genuineReadFile ( )

overrideprotectedvirtual

Reimplemented from edm::RawInputSource.

Definition at line 143 of file DQMStreamerReader.cc.

References artificialFileBoundary_, getHeaderMsg(), RecoTauValidation_cfi::header, isFirstFile_, setupMetaData(), and edm::streamer::StreamerInputSource::updateEventMetaData().

                                           {
     if (isFirstFile_) {
       //The file was already opened in the constructor
       isFirstFile_ = false;
       return;
     }
 
     if (artificialFileBoundary_) {
       updateEventMetaData();
       artificialFileBoundary_ = false;
       return;
     }
     //Get header/init from reader
     InitMsgView const* header = getHeaderMsg();
     setupMetaData(*header, true);
   }

◆ getEventMsg()

EventMsgView const * dqmservices::DQMStreamerReader::getEventMsg ( )

private

Definition at line 203 of file DQMStreamerReader.cc.

References file_, edm::RawInputSource::kFile, edm::RawInputSource::kStop, mps_check::msg, GetRecoTauVFromDQM_MC_cff::next, and dqmservices::DQMStreamerReader::OpenFile::streamFile_.

Referenced by prepareNextEvent(), and setupMetaData().

                                                      {
     auto next = file_.streamFile_->next();
     if (StreamerInputFile::Next::kFile == next) {
       return nullptr;
     }
 
     if (StreamerInputFile::Next::kStop == next) {
       return nullptr;
     }
 
     EventMsgView const* msg = file_.streamFile_->currentRecord();
 
     //  if (msg != nullptr) dumpEventView(msg);
     return msg;
   }

◆ getHeaderMsg()

InitMsgView const * dqmservices::DQMStreamerReader::getHeaderMsg ( )

private

Definition at line 192 of file DQMStreamerReader.cc.

References Exception, file_, edm::errors::FileReadError, RecoTauValidation_cfi::header, edm::streamer::Header::INIT, and dqmservices::DQMStreamerReader::OpenFile::streamFile_.

Referenced by genuineReadFile(), and openFileImp_().

                                                      {
     InitMsgView const* header = file_.streamFile_->startMessage();
 
     if (header->code() != Header::INIT) {  // INIT Msg
       throw edm::Exception(edm::errors::FileReadError, "DQMStreamerReader::readHeader")
           << "received wrong message type: expected INIT, got " << header->code() << "\n";
     }
 
     return header;
   }

◆ newHeader()

bool dqmservices::DQMStreamerReader::newHeader ( )

◆ openFileImp_()

void dqmservices::DQMStreamerReader::openFileImp_ ( const DQMFileIterator::LumiEntry & entry )

private

Definition at line 96 of file DQMStreamerReader.cc.

References acceptAllEvt_, mps_splice::entry, file_, flagDeleteDatFiles_, getHeaderMsg(), RecoTauValidation_cfi::header, hltSel_, isFirstFile_, dqmservices::DQMStreamerReader::OpenFile::lumi_, EnsembleCalibrationLA_cfg::path, processedEventPerLs_, setMatchTriggerSel(), setupMetaData(), dqmservices::DQMStreamerReader::OpenFile::streamFile_, AlCaHLTBitMon_QueryRunRegistry::string, and triggerSelector_.

Referenced by openNextFileImp_().

                                                                             {
     processedEventPerLs_ = 0;
 
     std::string path = entry.get_data_path();
 
     file_.lumi_ = entry;
     file_.streamFile_ = std::make_unique<StreamerInputFile>(path);
 
     InitMsgView const* header = getHeaderMsg();
     if (isFirstFile_) {
       setupMetaData(*header, false);
     }
 
     // dump the list of HLT trigger name from the header
     //  dumpInitHeader(header);
 
     // if specific trigger selection is requested, check if the requested triggers match with trigger paths in the header file
     if (!acceptAllEvt_) {
       std::vector<std::string> tnames;
       header->hltTriggerNames(tnames);
 
       triggerSelector_.reset(new TriggerSelector(hltSel_, tnames));
 
       // check if any trigger path name requested matches with trigger name in the header file
       setMatchTriggerSel(tnames);
     }
 
     // our initialization
     processedEventPerLs_ = 0;
 
     if (flagDeleteDatFiles_) {
       // unlink the file
       unlink(path.c_str());
     }
   }

◆ openNextFileImp_()

bool dqmservices::DQMStreamerReader::openNextFileImp_ ( )

private

Definition at line 160 of file DQMStreamerReader.cc.

References closeFileImp_(), MillePedeFileConverter_cfg::e, Exception, edm::errors::FileReadError, fiterator_, dqmservices::DQMFileIterator::LumiEntry::get_data_path(), dqmservices::DQMFileIterator::logFileAction(), dqmservices::DQMFileIterator::logLumiState(), dqmservices::DQMFileIterator::open(), openFileImp_(), AlCaHLTBitMon_ParallelJobs::p, AlCaHLTBitMon_QueryRunRegistry::string, and unitTest_.

Referenced by prepareNextFile().

                                            {
     closeFileImp_("skipping to another file");
 
     DQMFileIterator::LumiEntry currentLumi = fiterator_.open();
     std::string p = currentLumi.get_data_path();
 
     if (std::filesystem::exists(p)) {
       try {
         openFileImp_(currentLumi);
         return true;
       } catch (const cms::Exception& e) {
         if (unitTest_) {
           throw edm::Exception(edm::errors::FileReadError, "DQMStreamerReader::openNextFileInp")
               << std::string("Can't deserialize registry data (in open file): ") + e.what()
               << "\n error: data file corrupted";
         }
 
         fiterator_.logFileAction(std::string("Can't deserialize registry data (in open file): ") + e.what(), p);
         fiterator_.logLumiState(currentLumi, "error: data file corrupted");
 
         closeFileImp_("data file corrupted");
         return false;
       }
     } else {
       /* dat file missing */
       fiterator_.logFileAction("Data file (specified in json) is missing:", p);
       fiterator_.logLumiState(currentLumi, "error: data file missing");
 
       return false;
     }
   }

◆ prepareNextEvent()

EventMsgView const * dqmservices::DQMStreamerReader::prepareNextEvent ( )

private

Waits and reads the event header. If end-of-run nullptr is returned.

Definition at line 286 of file DQMStreamerReader.cc.

References acceptEvent(), artificialFileBoundary_, cms::cuda::assert(), closeFileImp_(), dqmservices::DQMFileIterator::delay(), edm::streamer::StreamerInputSource::deserializeEventMetaData(), edm::streamer::StreamerInputSource::eventMetaDataChecksum(), file_, fiterator_, getEventMsg(), edm::streamer::EventMsgView::isEventMetaData(), GetRecoTauVFromDQM_MC_cff::next, dqmservices::DQMStreamerReader::OpenFile::open(), or, prepareNextFile(), and edm::streamer::StreamerInputSource::presentEventMetaDataChecksum().

Referenced by checkNext(), and skip().

                                                           {
     EventMsgView const* eview = nullptr;
     typedef DQMFileIterator::State State;
 
     // wait for the next event
     for (;;) {
       // edm::LogAbsolute("DQMStreamerReader")
       //     << "State loop.";
       bool next = prepareNextFile();
       if (!next)
         return nullptr;
 
       // sleep
       if (!file_.open()) {
         // the reader does not exist
         fiterator_.delay();
       } else {
         // our reader exists, try to read out an event
         eview = getEventMsg();
 
         if (eview == nullptr) {
           // read unsuccessful
           // this means end of file, so close the file
           closeFileImp_("eof");
         } else {
           //NOTE: at this point need to see if meta data checksum changed. If it did
           // we need to issue a 'new File' transition
           if (eview->isEventMetaData()) {
             auto lastEventMetaData = presentEventMetaDataChecksum();
             if (eventMetaDataChecksum(*eview) != lastEventMetaData) {
               deserializeEventMetaData(*eview);
               artificialFileBoundary_ = true;
               return nullptr;
             } else {
               //skipping
               eview = getEventMsg();
               assert((eview == nullptr) or (not eview->isEventMetaData()));
               if (eview == nullptr) {
                 closeFileImp_("eof");
                 continue;
               }
             }
           }
 
           if (!acceptEvent(eview)) {
             continue;
           } else {
             return eview;
           }
         }
       }
     }
     return eview;
   }

◆ prepareNextFile()

bool dqmservices::DQMStreamerReader::prepareNextFile ( )

private

Prepare (open) the next file for reading. It is used by prepareNextEvent and in the constructor.

Does not block/wait.

Return false if this is end of run and/or no more file are available. However, return of "true" does not imply the file has been openned, but we need to wait until some future file becomes available.

Definition at line 229 of file DQMStreamerReader.cc.

References closeFileImp_(), file_, fiterator_, flagEndOfRunKills_, svgfig::load(), dqmservices::DQMFileIterator::logFileAction(), dqmservices::DQMFileIterator::lumiReady(), minEventsPerLs_, dqmservices::DQMStreamerReader::OpenFile::open(), openNextFileImp_(), processedEventPerLs_, edm::shutdown_flag, dqmservices::DQMFileIterator::state(), and dqmservices::DQMFileIterator::update_state().

Referenced by prepareNextEvent(), and reset_().

                                           {
     typedef DQMFileIterator::State State;
 
     for (;;) {
       fiterator_.update_state();
 
       if (edm::shutdown_flag.load()) {
         fiterator_.logFileAction("Shutdown flag was set, shutting down.");
 
         closeFileImp_("shutdown flag is set");
         return false;
       }
 
       // check for end of run file and force quit
       if (flagEndOfRunKills_ && (fiterator_.state() != State::OPEN)) {
         closeFileImp_("forced end-of-run");
         return false;
       }
 
       // check for end of run and quit if everything has been processed.
       // this clean exit
       if ((!file_.open()) && (!fiterator_.lumiReady()) && (fiterator_.state() == State::EOR)) {
         return false;
       }
 
       // if this is end of run and no more files to process
       // close it
       if ((processedEventPerLs_ >= minEventsPerLs_) && (!fiterator_.lumiReady()) &&
           (fiterator_.state() == State::EOR)) {
         closeFileImp_("graceful end-of-run");
         return false;
       }
 
       // skip to the next file if we have no files openned yet
       if (!file_.open()) {
         if (fiterator_.lumiReady()) {
           openNextFileImp_();
           // we might need to open once more (if .dat is missing)
           continue;
         }
       }
 
       // or if there is a next file and enough eventshas been processed.
       if (fiterator_.lumiReady() && (processedEventPerLs_ >= minEventsPerLs_)) {
         openNextFileImp_();
         // we might need to open once more (if .dat is missing)
         continue;
       }
 
       return true;
     }
   }

◆ reset_()

void dqmservices::DQMStreamerReader::reset_ ( )

overrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 44 of file DQMStreamerReader.cc.

References dqmservices::DQMFileIterator::advanceToLumi(), dqmservices::DQMFileIterator::delay(), file_, fiterator_, flagSkipFirstLumis_, MainPageGenerator::l, dqmservices::DQMFileIterator::lastLumiFound(), dqmservices::DQMFileIterator::logFileAction(), GetRecoTauVFromDQM_MC_cff::next, dqmservices::DQMStreamerReader::OpenFile::open(), prepareNextFile(), and dqmservices::DQMFileIterator::update_state().

Referenced by DQMStreamerReader().

                                  {
     // We have to load at least a single header,
     // so the ProductRegistry gets initialized.
     //
     // This must happen here (inside the constructor),
     // as ProductRegistry gets frozen after we initialize:
     // https://cmssdt.cern.ch/SDT/lxr/source/FWCore/Framework/src/Schedule.cc#441
 
     fiterator_.logFileAction("Waiting for the first lumi in order to initialize.");
 
     fiterator_.update_state();
 
     // Fast-forward to the last open file.
     if (flagSkipFirstLumis_) {
       unsigned int l = fiterator_.lastLumiFound();
       if (l > 1) {
         fiterator_.advanceToLumi(l, "skipped: fast-forward to the latest lumi");
       }
     }
 
     for (;;) {
       bool next = prepareNextFile();
 
       // check for end of run
       if (!next) {
         fiterator_.logFileAction("End of run reached before DQMStreamerReader was initialised.");
         return;
       }
 
       // check if we have a file openned
       if (file_.open()) {
         // we are now initialised
         break;
       }
 
       // wait
       fiterator_.delay();
     }
 
     fiterator_.logFileAction("DQMStreamerReader initialised.");
   }

◆ setAcceptAllEvt()

bool dqmservices::DQMStreamerReader::setAcceptAllEvt ( )

private

If hlt trigger selection is '*', return a boolean variable to accept all events

Definition at line 373 of file DQMStreamerReader.cc.

References acceptAllEvt_, DummyCfis::c, TriggerAnalyzer::hltPath, and hltSel_.

Referenced by DQMStreamerReader().

                                           {
     acceptAllEvt_ = false;
     for (auto hltPath : hltSel_) {
       hltPath.erase(std::remove_if(hltPath.begin(), hltPath.end(), [](unsigned char c) { return std::isspace(c); }),
                     hltPath.end());
       if (hltPath == "*") {
         acceptAllEvt_ = true;
         break;
       }
     }
     return acceptAllEvt_;
   }

◆ setMatchTriggerSel()

bool dqmservices::DQMStreamerReader::setMatchTriggerSel ( std::vector< std::string > const & tnames )

private

Check if hlt selection matches any trigger name taken from the header file

Definition at line 389 of file DQMStreamerReader.cc.

References DummyCfis::c, TriggerAnalyzer::hltPath, hltSel_, oniaPATMuonsWithTrigger_cff::matches, matchTriggerSel_, and edm::regexMatch().

Referenced by openFileImp_().

                                                                                {
     matchTriggerSel_ = false;
     for (auto hltPath : hltSel_) {
       hltPath.erase(std::remove_if(hltPath.begin(), hltPath.end(), [](unsigned char c) { return std::isspace(c); }),
                     hltPath.end());
       auto const matches = edm::regexMatch(tnames, hltPath);
       if (not matches.empty()) {
         matchTriggerSel_ = true;
         break;
       }
     }
 
     if (not matchTriggerSel_) {
       edm::LogWarning("DQMStreamerReader") << "Trigger selection does not match any trigger path!!!";
     }
 
     return matchTriggerSel_;
   }

◆ setupMetaData()

void dqmservices::DQMStreamerReader::setupMetaData	(	edm::streamer::InitMsgView const &	msg,
		bool	subsequent
	)

private

Definition at line 86 of file DQMStreamerReader.cc.

References cms::cuda::assert(), edm::streamer::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::streamer::StreamerInputSource::deserializeEventMetaData(), getEventMsg(), mps_check::msg, and edm::streamer::StreamerInputSource::updateEventMetaData().

Referenced by genuineReadFile(), and openFileImp_().

                                                                                           {
     deserializeAndMergeWithRegistry(msg, subsequent);
     auto event = getEventMsg();
     //file might be empty
     if (not event)
       return;
     assert(event->isEventMetaData());
     deserializeEventMetaData(*event);
     updateEventMetaData();
   }

◆ skip()

void dqmservices::DQMStreamerReader::skip ( int toSkip )

overrideprotectedvirtual

Reimplemented from edm::InputSource.

Definition at line 427 of file DQMStreamerReader.cc.

References closeFileImp_(), MillePedeFileConverter_cfg::e, fiterator_, mps_fire::i, dqmservices::DQMFileIterator::logFileAction(), prepareNextEvent(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                          {
     try {
       for (int i = 0; i != toSkip; ++i) {
         EventMsgView const* evMsg = prepareNextEvent();
 
         if (evMsg == nullptr) {
           return;
         }
       }
     } catch (const cms::Exception& e) {
       // try to recover from corrupted files/events
       fiterator_.logFileAction(std::string("Can't deserialize event data: ") + e.what());
       closeFileImp_("data file corrupted");
     }
   }

Member Data Documentation

◆ acceptAllEvt_

bool dqmservices::DQMStreamerReader::acceptAllEvt_ = false

private

Definition at line 62 of file DQMStreamerReader.h.

Referenced by acceptEvent(), openFileImp_(), and setAcceptAllEvt().

◆ artificialFileBoundary_

bool dqmservices::DQMStreamerReader::artificialFileBoundary_ = false

private

Definition at line 70 of file DQMStreamerReader.h.

Referenced by checkNext(), genuineReadFile(), and prepareNextEvent().

◆ eventSkipperByID_

std::shared_ptr<edm::EventSkipperByID> dqmservices::DQMStreamerReader::eventSkipperByID_

private

Definition at line 79 of file DQMStreamerReader.h.

◆ file_

struct dqmservices::DQMStreamerReader::OpenFile dqmservices::DQMStreamerReader::file_

private

Referenced by checkNext(), closeFileImp_(), getEventMsg(), getHeaderMsg(), openFileImp_(), prepareNextEvent(), prepareNextFile(), and reset_().

◆ fiterator_

DQMFileIterator dqmservices::DQMStreamerReader::fiterator_

private

Definition at line 52 of file DQMStreamerReader.h.

Referenced by checkNext(), closeFileImp_(), openNextFileImp_(), prepareNextEvent(), prepareNextFile(), reset_(), and skip().

◆ flagDeleteDatFiles_

bool const dqmservices::DQMStreamerReader::flagDeleteDatFiles_

private

Definition at line 58 of file DQMStreamerReader.h.

Referenced by openFileImp_().

◆ flagEndOfRunKills_

bool const dqmservices::DQMStreamerReader::flagEndOfRunKills_

private

Definition at line 57 of file DQMStreamerReader.h.

Referenced by prepareNextFile().

◆ flagSkipFirstLumis_

bool const dqmservices::DQMStreamerReader::flagSkipFirstLumis_

private

Definition at line 56 of file DQMStreamerReader.h.

Referenced by reset_().

◆ hltSel_

std::vector<std::string> const dqmservices::DQMStreamerReader::hltSel_

private

Definition at line 59 of file DQMStreamerReader.h.

Referenced by openFileImp_(), setAcceptAllEvt(), and setMatchTriggerSel().

◆ isFirstFile_

bool dqmservices::DQMStreamerReader::isFirstFile_ = true

private

Definition at line 48 of file DQMStreamerReader.h.

Referenced by genuineReadFile(), and openFileImp_().

◆ matchTriggerSel_

bool dqmservices::DQMStreamerReader::matchTriggerSel_ = false

private

Definition at line 65 of file DQMStreamerReader.h.

Referenced by acceptEvent(), and setMatchTriggerSel().

◆ minEventsPerLs_

unsigned int const dqmservices::DQMStreamerReader::minEventsPerLs_

private

Definition at line 55 of file DQMStreamerReader.h.

Referenced by prepareNextFile().

◆ processedEventPerLs_

unsigned int dqmservices::DQMStreamerReader::processedEventPerLs_ = 0

private

Definition at line 53 of file DQMStreamerReader.h.

Referenced by checkNext(), openFileImp_(), and prepareNextFile().

◆ triggerSelector_

std::shared_ptr<TriggerSelector> dqmservices::DQMStreamerReader::triggerSelector_

private

Definition at line 80 of file DQMStreamerReader.h.

Referenced by acceptEvent(), and openFileImp_().

◆ unitTest_

bool const dqmservices::DQMStreamerReader::unitTest_

private

Definition at line 60 of file DQMStreamerReader.h.

Referenced by openNextFileImp_().

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DQMStreamerReader()

◆ ~DQMStreamerReader()

Member Function Documentation

◆ acceptEvent()

◆ checkNext()

◆ closeFileImp_()

◆ fillDescriptions()

◆ genuineCloseFile()

◆ genuineReadFile()

◆ getEventMsg()

◆ getHeaderMsg()

◆ newHeader()

◆ openFileImp_()

◆ openNextFileImp_()

◆ prepareNextEvent()

◆ prepareNextFile()

◆ reset_()

◆ setAcceptAllEvt()

◆ setMatchTriggerSel()

◆ setupMetaData()

◆ skip()

Member Data Documentation

◆ acceptAllEvt_

◆ artificialFileBoundary_

◆ eventSkipperByID_

◆ file_

◆ fiterator_

◆ flagDeleteDatFiles_

◆ flagEndOfRunKills_

◆ flagSkipFirstLumis_

◆ hltSel_

◆ isFirstFile_

◆ matchTriggerSel_

◆ minEventsPerLs_

◆ processedEventPerLs_

◆ triggerSelector_

◆ unitTest_