#include <StreamerFileReader.h>

Inheritance diagram for edm::streamer::StreamerFileReader:

Public Member Functions
	StreamerFileReader (ParameterSet const &pset, InputSourceDescription const &desc)

	~StreamerFileReader () 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 (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 &)

Private Member Functions
Next	checkNext () override

std::shared_ptr< EventSkipperByID const >	eventSkipperByID () const

std::shared_ptr< EventSkipperByID > &	eventSkipperByID ()

void	genuineCloseFile () override

void	genuineReadFile () override

InitMsgView const *	getHeader ()

EventMsgView const *	getNextEvent ()

bool	newHeader ()

void	reset_ () override

void	skip (int toSkip) override

void	updateMetaData (bool subsequent)

Private Attributes
bool	didArtificialFile_ = false

edm::propagate_const< std::shared_ptr< EventSkipperByID > >	eventSkipperByID_

int	initialNumberOfEventsToSkip_

bool	isFirstFile_ = true

int	prefetchMBytes_

std::vector< FileCatalogItem >	streamerNames_

edm::propagate_const< std::unique_ptr< StreamerInputFile > >	streamReader_

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_

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

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 23 of file StreamerFileReader.h.

Constructor & Destructor Documentation

◆ StreamerFileReader()

edm::streamer::StreamerFileReader::StreamerFileReader	(	ParameterSet const &	pset,
		InputSourceDescription const &	desc
	)

Definition at line 16 of file StreamerFileReader.cc.

References getEcalConditions_orcoffint2r_cff::catalog, muonDTDigis_cfi::pset, reset_(), streamerNames_, and AlCaHLTBitMon_QueryRunRegistry::string.

       : StreamerInputSource(pset, desc),
         streamReader_(),
         eventSkipperByID_(EventSkipperByID::create(pset).release()),
         initialNumberOfEventsToSkip_(pset.getUntrackedParameter<unsigned int>("skipEvents")),
         prefetchMBytes_(pset.getUntrackedParameter<unsigned int>("prefetchMBytes")) {
     InputFileCatalog catalog(pset.getUntrackedParameter<std::vector<std::string> >("fileNames"),
                              pset.getUntrackedParameter<std::string>("overrideCatalog"));
     streamerNames_ = catalog.fileCatalogItems();
     reset_();
   }

◆ ~StreamerFileReader()

edm::streamer::StreamerFileReader::~StreamerFileReader ( )

override

Definition at line 28 of file StreamerFileReader.cc.

28 {}

Member Function Documentation

◆ checkNext()

StreamerFileReader::Next edm::streamer::StreamerFileReader::checkNext ( )

overrideprivatevirtual

Implements edm::RawInputSource.

Definition at line 64 of file StreamerFileReader.cc.

References edm::streamer::StreamerInputSource::deserializeEvent(), edm::streamer::StreamerInputSource::deserializeEventMetaData(), didArtificialFile_, edm::streamer::StreamerInputSource::eventMetaDataChecksum(), getNextEvent(), edm::streamer::EventMsgView::isEventMetaData(), edm::RawInputSource::kEvent, edm::RawInputSource::kFile, edm::RawInputSource::kStop, newHeader(), and edm::streamer::StreamerInputSource::presentEventMetaDataChecksum().

                                                        {
     EventMsgView const* eview = getNextEvent();
 
     if (eview == nullptr) {
       if (newHeader()) {
         return Next::kFile;
       }
       return Next::kStop;
     }
     if (eview->isEventMetaData()) {
       if (presentEventMetaDataChecksum() != eventMetaDataChecksum(*eview)) {
         //we lie and say there is a new file since we need to synchronize to update the meta data
         didArtificialFile_ = true;
         deserializeEventMetaData(*eview);
         return Next::kFile;
       } else {
         //skip this meta data
         eview = getNextEvent();
         if (eview == nullptr) {
           if (newHeader()) {
             return Next::kFile;
           }
           return Next::kStop;
         }
       }
     }
     deserializeEvent(*eview);
     return Next::kEvent;
   }

◆ eventSkipperByID() [1/2]

std::shared_ptr<EventSkipperByID const> edm::streamer::StreamerFileReader::eventSkipperByID ( ) const

inlineprivate

Definition at line 42 of file StreamerFileReader.h.

References eventSkipperByID_, and edm::get_underlying_safe().

Referenced by reset_().

                                                                      {
         return get_underlying_safe(eventSkipperByID_);
       }

◆ eventSkipperByID() [2/2]

std::shared_ptr<EventSkipperByID>& edm::streamer::StreamerFileReader::eventSkipperByID ( )

inlineprivate

Definition at line 45 of file StreamerFileReader.h.

References eventSkipperByID_, and edm::get_underlying_safe().

45 { return get_underlying_safe(eventSkipperByID_); }

edm::get_underlying_safe

constexpr std::shared_ptr< T > & get_underlying_safe(propagate_const< std::shared_ptr< T >> &iP)

Definition: get_underlying_safe.h:41

edm::streamer::StreamerFileReader::eventSkipperByID_

edm::propagate_const< std::shared_ptr< EventSkipperByID > > eventSkipperByID_

Definition: StreamerFileReader.h:49

◆ fillDescriptions()

void edm::streamer::StreamerFileReader::fillDescriptions ( ConfigurationDescriptions & descriptions )

static

Definition at line 153 of file StreamerFileReader.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, edm::EventSkipperByID::fillDescription(), edm::streamer::StreamerInputSource::fillDescription(), AlCaHLTBitMon_QueryRunRegistry::string, and mitigatedMETSequence_cff::U.

                                                                                    {
     ParameterSetDescription desc;
     desc.setComment("Reads events from streamer files.");
     desc.addUntracked<std::vector<std::string> >("fileNames")->setComment("Names of files to be processed.");
     desc.addUntracked<unsigned int>("skipEvents", 0U)
         ->setComment("Skip the first 'skipEvents' events that otherwise would have been processed.");
     desc.addUntracked<std::string>("overrideCatalog", std::string());
     //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);
     desc.addUntracked<unsigned int>("prefetchMBytes", 0);
     StreamerInputSource::fillDescription(desc);
     EventSkipperByID::fillDescription(desc);
     descriptions.add("source", desc);
   }

◆ genuineCloseFile()

void edm::streamer::StreamerFileReader::genuineCloseFile ( )

overrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 107 of file StreamerFileReader.cc.

References didArtificialFile_, and streamReader_.

                                             {
     if (didArtificialFile_) {
       return;
     }
     if (streamReader_.get() != nullptr)
       streamReader_->closeStreamerFile();
   }

◆ genuineReadFile()

void edm::streamer::StreamerFileReader::genuineReadFile ( )

overrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 115 of file StreamerFileReader.cc.

References didArtificialFile_, isFirstFile_, streamReader_, edm::streamer::StreamerInputSource::updateEventMetaData(), and updateMetaData().

                                            {
     if (isFirstFile_) {
       //The file was already opened in the constructor
       isFirstFile_ = false;
       return;
     }
     if (didArtificialFile_) {
       //update the event meta data
       didArtificialFile_ = false;
       updateEventMetaData();
       return;
     }
     streamReader_->openNextFile();
     // FDEBUG(6) << "A new file has been opened and we must compare Headers here !!" << std::endl;
     // A new file has been opened and we must compare Heraders here !!
     //Get header/init from reader
     updateMetaData(true);
   }

◆ getHeader()

InitMsgView const * edm::streamer::StreamerFileReader::getHeader ( )

private

Definition at line 136 of file StreamerFileReader.cc.

References Exception, edm::errors::FileReadError, RecoTauValidation_cfi::header, edm::streamer::Header::INIT, and streamReader_.

Referenced by updateMetaData().

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

◆ getNextEvent()

EventMsgView const * edm::streamer::StreamerFileReader::getNextEvent ( )

private

Definition at line 146 of file StreamerFileReader.cc.

References edm::streamer::StreamerInputFile::kEvent, and streamReader_.

Referenced by checkNext(), skip(), and updateMetaData().

                                                        {
     if (StreamerInputFile::Next::kEvent != streamReader_->next()) {
       return nullptr;
     }
     return streamReader_->currentRecord();
   }

◆ newHeader()

bool edm::streamer::StreamerFileReader::newHeader ( )

private

Definition at line 134 of file StreamerFileReader.cc.

References streamReader_.

Referenced by checkNext().

134 { return streamReader_->newHeader(); }

edm::streamer::StreamerFileReader::streamReader_

edm::propagate_const< std::unique_ptr< StreamerInputFile > > streamReader_

Definition: StreamerFileReader.h:48

◆ reset_()

void edm::streamer::StreamerFileReader::reset_ ( )

overrideprivatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 30 of file StreamerFileReader.cc.

References eventSkipperByID(), Exception, edm::errors::FileReadError, initialNumberOfEventsToSkip_, isFirstFile_, prefetchMBytes_, skip(), streamerNames_, streamReader_, and updateMetaData().

Referenced by StreamerFileReader().

                                   {
     if (streamerNames_.size() > 1) {
       streamReader_ = std::make_unique<StreamerInputFile>(streamerNames_, eventSkipperByID(), prefetchMBytes_);
     } else if (streamerNames_.size() == 1) {
       streamReader_ = std::make_unique<StreamerInputFile>(streamerNames_.at(0).fileNames()[0],
                                                           streamerNames_.at(0).logicalFileName(),
                                                           eventSkipperByID(),
                                                           prefetchMBytes_);
     } else {
       throw Exception(errors::FileReadError, "StreamerFileReader::StreamerFileReader")
           << "No fileNames were specified\n";
     }
     isFirstFile_ = true;
     updateMetaData(false);
     if (initialNumberOfEventsToSkip_) {
       skip(initialNumberOfEventsToSkip_);
     }
   }

◆ skip()

void edm::streamer::StreamerFileReader::skip ( int toSkip )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 94 of file StreamerFileReader.cc.

References edm::streamer::EventMsgView::event(), eventSkipperByID_, getNextEvent(), mps_fire::i, edm::streamer::EventMsgView::lumi(), and edm::streamer::EventMsgView::run().

Referenced by reset_().

                                           {
     for (int i = 0; i != toSkip; ++i) {
       EventMsgView const* evMsg = getNextEvent();
       if (evMsg == nullptr) {
         return;
       }
       // If the event would have been skipped anyway, don't count it as a skipped event.
       if (eventSkipperByID_ && eventSkipperByID_->skipIt(evMsg->run(), evMsg->lumi(), evMsg->event())) {
         --i;
       }
     }
   }

◆ updateMetaData()

void edm::streamer::StreamerFileReader::updateMetaData ( bool subsequent )

private

Definition at line 49 of file StreamerFileReader.cc.

References cms::cuda::assert(), edm::streamer::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::streamer::StreamerInputSource::deserializeEventMetaData(), getHeader(), getNextEvent(), RecoTauValidation_cfi::header, and edm::streamer::StreamerInputSource::updateEventMetaData().

Referenced by genuineReadFile(), and reset_().

                                                          {
     InitMsgView const* header = getHeader();
     deserializeAndMergeWithRegistry(*header, subsequent);
     //NOTE: should read first Event to get the meta data and then set 'artificial file'
     auto eview = getNextEvent();
 
     //if no events then file must be empty
     if (eview == nullptr)
       return;
 
     assert(eview->isEventMetaData());
     deserializeEventMetaData(*eview);
     updateEventMetaData();
   }

Member Data Documentation

◆ didArtificialFile_

bool edm::streamer::StreamerFileReader::didArtificialFile_ = false

private

Definition at line 53 of file StreamerFileReader.h.

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

◆ eventSkipperByID_

edm::propagate_const<std::shared_ptr<EventSkipperByID> > edm::streamer::StreamerFileReader::eventSkipperByID_

private

Definition at line 49 of file StreamerFileReader.h.

Referenced by eventSkipperByID(), and skip().

◆ initialNumberOfEventsToSkip_

int edm::streamer::StreamerFileReader::initialNumberOfEventsToSkip_

private

Definition at line 50 of file StreamerFileReader.h.

Referenced by reset_().

◆ isFirstFile_

bool edm::streamer::StreamerFileReader::isFirstFile_ = true

private

Definition at line 52 of file StreamerFileReader.h.

Referenced by genuineReadFile(), and reset_().

◆ prefetchMBytes_

int edm::streamer::StreamerFileReader::prefetchMBytes_

private

Definition at line 51 of file StreamerFileReader.h.

Referenced by reset_().

◆ streamerNames_

std::vector<FileCatalogItem> edm::streamer::StreamerFileReader::streamerNames_

private

Definition at line 47 of file StreamerFileReader.h.

Referenced by reset_(), and StreamerFileReader().

◆ streamReader_

edm::propagate_const<std::unique_ptr<StreamerInputFile> > edm::streamer::StreamerFileReader::streamReader_

private

Definition at line 48 of file StreamerFileReader.h.

Referenced by genuineCloseFile(), genuineReadFile(), getHeader(), getNextEvent(), newHeader(), and reset_().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StreamerFileReader()

◆ ~StreamerFileReader()

Member Function Documentation

◆ checkNext()

◆ eventSkipperByID() [1/2]

◆ eventSkipperByID() [2/2]

◆ fillDescriptions()

◆ genuineCloseFile()

◆ genuineReadFile()

◆ getHeader()

◆ getNextEvent()

◆ newHeader()

◆ reset_()

◆ skip()

◆ updateMetaData()

Member Data Documentation

◆ didArtificialFile_

◆ eventSkipperByID_

◆ initialNumberOfEventsToSkip_

◆ isFirstFile_

◆ prefetchMBytes_

◆ streamerNames_

◆ streamReader_