#include <RootEmbeddedFileSequence.h>

Inheritance diagram for edm::RootEmbeddedFileSequence:

Public Member Functions
void	closeFile_ () override

void	endJob ()

RootEmbeddedFileSequence &	operator= (RootEmbeddedFileSequence const &)=delete

bool	readOneEvent (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine , EventID const id, bool recycleFiles)

bool	readOneRandom (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine , EventID const , bool)

bool	readOneRandomWithID (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine , EventID const id, bool)

bool	readOneSequential (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine , EventID const , bool recycleFiles)

bool	readOneSequentialWithID (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine , EventID const id, bool)

void	readOneSpecified (EventPrincipal &cache, size_t &fileNameHash, SecondaryEventIDAndFileInfo const &id)

	RootEmbeddedFileSequence (ParameterSet const &pset, EmbeddedRootSource &input, InputFileCatalog const &catalog)

	RootEmbeddedFileSequence (RootEmbeddedFileSequence const &)=delete

void	skipEntries (unsigned int offset)

	~RootEmbeddedFileSequence () override

Public Member Functions inherited from edm::RootInputFileSequence
bool	containedInCurrentFile (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event) const

std::shared_ptr< BranchIDListHelper const >	fileBranchIDListHelper () const

std::shared_ptr< ProductRegistry const >	fileProductRegistry () const

RootInputFileSequence &	operator= (RootInputFileSequence const &)=delete

void	readEvent (EventPrincipal &cache)

void	readLuminosityBlock_ (LuminosityBlockPrincipal &lumiPrincipal)

std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary_ ()

void	readRun_ (RunPrincipal &runPrincipal)

std::shared_ptr< RunAuxiliary >	readRunAuxiliary_ ()

	RootInputFileSequence (ParameterSet const &pset, InputFileCatalog const &catalog)

	RootInputFileSequence (RootInputFileSequence const &)=delete

bool	skipToItem (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event, size_t fileNameHash=0U, bool currentFileFirst=true)

virtual	~RootInputFileSequence ()

Static Public Member Functions
static void	fillDescription (ParameterSetDescription &desc)

Private Member Functions
void	initFile_ (bool skipBadFiles) override

RootFileSharedPtr	makeRootFile (std::shared_ptr< InputFile > filePtr) override

Private Attributes
bool	enablePrefetching_

bool	enforceGUIDInFileName_

int	eventsRemainingInFile_

bool(RootEmbeddedFileSequence::*	fptr_ )(EventPrincipal &, size_t &, CLHEP::HepRandomEngine , EventID const , bool)

int	initialNumberOfEventsToSkip_

EmbeddedRootSource &	input_

std::vector< ProcessHistoryID >	orderedProcessHistoryIDs_

bool	sameLumiBlock_

bool	sequential_

unsigned int	treeCacheSize_

Additional Inherited Members
Protected Types inherited from edm::RootInputFileSequence
typedef std::shared_ptr< RootFile >	RootFileSharedPtr

Protected Member Functions inherited from edm::RootInputFileSequence
bool	atFirstFile () const

bool	atLastFile () const

std::string const &	fallbackFileName () const

std::vector< FileCatalogItem > const &	fileCatalogItems () const

std::string const &	fileName () const

std::vector< std::shared_ptr< IndexIntoFile > > const &	indexesIntoFiles () const

void	initFile (bool skipBadFiles)

void	initTheFile (bool skipBadFiles, bool deleteIndexIntoFile, InputSource input, char const inputTypeName, InputType inputType)

std::string const &	lfn () const

size_t	lfnHash () const

std::string const &	logicalFileName () const

bool	noFiles () const

bool	noMoreFiles () const

size_t	numberOfFiles () const

std::shared_ptr< RootFile const >	rootFile () const

std::shared_ptr< RootFile > &	rootFile ()

size_t	sequenceNumberOfFile () const

void	setAtFileSequenceNumber (size_t offset)

void	setAtFirstFile ()

void	setAtNextFile ()

void	setAtPreviousFile ()

void	setIndexIntoFile (size_t index)

void	setNoMoreFiles ()

bool	skipToItemInNewFile (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event)

bool	skipToItemInNewFile (RunNumber_t run, LuminosityBlockNumber_t lumi, EventNumber_t event, size_t fileNameHash)

bool	usedFallback () const

Detailed Description

Definition at line 32 of file RootEmbeddedFileSequence.h.

Constructor & Destructor Documentation

edm::RootEmbeddedFileSequence::RootEmbeddedFileSequence	(	ParameterSet const &	pset,
		EmbeddedRootSource &	input,
		InputFileCatalog const &	catalog
	)

explicit

Definition at line 26 of file RootEmbeddedFileSequence.cc.

References edm::RootInputFileSequence::atFirstFile(), edm::errors::Configuration, KineDebug3::count(), SurveyInfoScenario_cff::distribution, enablePrefetching_, Exception, f, fptr_, edm::RootInputFileSequence::initFile(), initialNumberOfEventsToSkip_, input_, edm::IndexIntoFile::invalidEntry, edm::Service< T >::isAvailable(), edm::RootInputFileSequence::noFiles(), edm::RootInputFileSequence::numberOfFiles(), PFRecoTauDiscriminationByIsolation_cfi::offset, edm::VectorInputSource::productRegistryUpdate(), readOneRandom(), readOneRandomWithID(), readOneSequential(), readOneSequentialWithID(), edm::RootInputFileSequence::rootFile(), sameLumiBlock_, SurveyInfoScenario_cff::seed, sequential_, edm::RootInputFileSequence::setAtFileSequenceNumber(), edm::RootInputFileSequence::setAtFirstFile(), edm::EmbeddedRootSource::skipBadFiles(), skipEntries(), treeCacheSize_, mitigatedMETSequence_cff::U, and edm::ProductRegistry::updateFromInput().

                                                  :
     RootInputFileSequence(pset, catalog),
     input_(input),
     orderedProcessHistoryIDs_(),
     sequential_(pset.getUntrackedParameter<bool>("sequential", false)),
     sameLumiBlock_(pset.getUntrackedParameter<bool>("sameLumiBlock", false)),
     fptr_(nullptr),
     eventsRemainingInFile_(0),
     // The default value provided as the second argument to the getUntrackedParameter function call
     // is not used when the ParameterSet has been validated and the parameters are not optional
     // in the description.  This is currently true when PoolSource is the primary input source.
     // The modules that use PoolSource as a SecSource have not defined their fillDescriptions function
     // yet, so the ParameterSet does not get validated yet.  As soon as all the modules with a SecSource
     // have defined descriptions, the defaults in the getUntrackedParameterSet function calls can
     // and should be deleted from the code.
     initialNumberOfEventsToSkip_(pset.getUntrackedParameter<unsigned int>("skipEvents", 0U)),
     treeCacheSize_(pset.getUntrackedParameter<unsigned int>("cacheSize", roottree::defaultCacheSize)),
     enablePrefetching_(false),
     enforceGUIDInFileName_(pset.getUntrackedParameter<bool>("enforceGUIDInFileName", false)) {
 
     if(noFiles()) {
       throw Exception(errors::Configuration) << "RootEmbeddedFileSequence no input files specified for secondary input source.\n";
     }
     //
     // The SiteLocalConfig controls the TTreeCache size and the prefetching settings.
     Service<SiteLocalConfig> pSLC;
     if(pSLC.isAvailable()) {
       if(treeCacheSize_ != 0U && pSLC->sourceTTreeCacheSize()) {
         treeCacheSize_ = *(pSLC->sourceTTreeCacheSize());
       }
       enablePrefetching_ = pSLC->enablePrefetching();
     }
 
     // Set the pointer to the function that reads an event.
     if(sameLumiBlock_) {
       if(sequential_) {
         fptr_ = &RootEmbeddedFileSequence::readOneSequentialWithID;
       } else {
         fptr_ = &RootEmbeddedFileSequence::readOneRandomWithID;
       }
     } else {
       if(sequential_) {
         fptr_ = &RootEmbeddedFileSequence::readOneSequential;
       } else {
         fptr_ = &RootEmbeddedFileSequence::readOneRandom;
       }
     }
 
     // For the secondary input source we do not stage in.
     if(sequential_) {
       // We open the first file
       if(!atFirstFile()) {
         setAtFirstFile();
         initFile(false);
       }
       assert(rootFile());
       rootFile()->setAtEventEntry(IndexIntoFile::invalidEntry);
       if(!sameLumiBlock_) {
         skipEntries(initialNumberOfEventsToSkip_);
       }
     } else {
       // We randomly choose the first file to open.
       // We cannot use the random number service yet.
       std::ifstream f("/dev/urandom");
       unsigned int seed;
       f.read(reinterpret_cast<char*>(&seed), sizeof(seed)); 
       std::default_random_engine dre(seed);
       size_t count = numberOfFiles();
       std::uniform_int_distribution<int> distribution(0, count - 1);
       while(!rootFile() && count != 0) {
         --count;
         int offset = distribution(dre);
         setAtFileSequenceNumber(offset);
         initFile(input_.skipBadFiles());
       }
     }
     if(rootFile()) {
       input_.productRegistryUpdate().updateFromInput(rootFile()->productRegistry()->productList());
     }
   }

edm::RootEmbeddedFileSequence::~RootEmbeddedFileSequence ( )

override

Definition at line 110 of file RootEmbeddedFileSequence.cc.

110 {

111 }

edm::RootEmbeddedFileSequence::RootEmbeddedFileSequence ( RootEmbeddedFileSequence const & )

delete

Member Function Documentation

void edm::RootEmbeddedFileSequence::closeFile_ ( )

overridevirtual

Implements edm::RootInputFileSequence.

Definition at line 118 of file RootEmbeddedFileSequence.cc.

References edm::RootInputFileSequence::rootFile().

Referenced by endJob().

                                             {
     // delete the RootFile object.
     if(rootFile()) {
       rootFile().reset();
     }
   }

void edm::RootEmbeddedFileSequence::endJob ( void )

Definition at line 114 of file RootEmbeddedFileSequence.cc.

References closeFile_().

                                    {
     closeFile_();
   }

void edm::RootEmbeddedFileSequence::fillDescription ( ParameterSetDescription & desc )

static

Definition at line 330 of file RootEmbeddedFileSequence.cc.

References edm::ParameterSetDescription::addUntracked(), edm::roottree::defaultCacheSize, and mitigatedMETSequence_cff::U.

Referenced by edm::EmbeddedRootSource::fillDescriptions().

                                                                           {
     desc.addUntracked<bool>("sequential", false)
         ->setComment("True: loopEvents() reads events sequentially from beginning of first file.\n"
                      "False: loopEvents() first reads events beginning at random event. New files also chosen randomly");
     desc.addUntracked<bool>("sameLumiBlock", false)
         ->setComment("True: loopEvents() reads events only in same lumi as the specified event.\n"
                      "False: loopEvents() reads events regardless of lumi.");
     desc.addUntracked<unsigned int>("skipEvents", 0U)
         ->setComment("Skip the first 'skipEvents' events. Used only if 'sequential' is True and 'sameLumiBlock' is False");
     desc.addUntracked<unsigned int>("cacheSize", roottree::defaultCacheSize)
         ->setComment("Size of ROOT TTree prefetch cache.  Affects performance.");
     desc.addUntracked<bool>("enforceGUIDInFileName", false)
         ->setComment(
             "True:  file name part is required to be equal to the GUID of the file\n"
             "False: file name can be anything");
   }

void edm::RootEmbeddedFileSequence::initFile_ ( bool skipBadFiles )

overrideprivatevirtual

Implements edm::RootInputFileSequence.

Definition at line 125 of file RootEmbeddedFileSequence.cc.

References edm::RootInputFileSequence::initTheFile(), and edm::SecondarySource.

                                                             {
     initTheFile(skipBadFiles, false, nullptr, "mixingFiles", InputType::SecondarySource);
   }

RootEmbeddedFileSequence::RootFileSharedPtr edm::RootEmbeddedFileSequence::makeRootFile ( std::shared_ptr< InputFile > filePtr )

overrideprivatevirtual

Implements edm::RootInputFileSequence.

Definition at line 130 of file RootEmbeddedFileSequence.cc.

References edm::EmbeddedRootSource::bypassVersionCheck(), enablePrefetching_, enforceGUIDInFileName_, edm::RootInputFileSequence::fileName(), edm::RootInputFileSequence::indexesIntoFiles(), input_, edm::RootInputFileSequence::logicalFileName(), edm::EmbeddedRootSource::nStreams(), orderedProcessHistoryIDs_, edm::VectorInputSource::processHistoryRegistryForUpdate(), edm::EmbeddedRootSource::productSelectorRules(), edm::EmbeddedRootSource::runHelper(), edm::SecondarySource, edm::RootInputFileSequence::sequenceNumberOfFile(), treeCacheSize_, and edm::EmbeddedRootSource::treeMaxVirtualSize().

                                                                          {
     size_t currentIndexIntoFile = sequenceNumberOfFile();
     return std::make_shared<RootFile>(
           fileName(),
           ProcessConfiguration(),
           logicalFileName(),
           filePtr,
       input_.nStreams(),
           treeCacheSize_,
           input_.treeMaxVirtualSize(),
           input_.runHelper(),
           input_.productSelectorRules(),
           InputType::SecondarySource,
           input_.processHistoryRegistryForUpdate(),
           indexesIntoFiles(),
           currentIndexIntoFile,
           orderedProcessHistoryIDs_,
           input_.bypassVersionCheck(),
           enablePrefetching_,
           enforceGUIDInFileName_);
   }

RootEmbeddedFileSequence& edm::RootEmbeddedFileSequence::operator= ( RootEmbeddedFileSequence const & )

delete

bool edm::RootEmbeddedFileSequence::readOneEvent	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		CLHEP::HepRandomEngine *	engine,
		EventID const *	id,
		bool	recycleFiles
	)

Definition at line 323 of file RootEmbeddedFileSequence.cc.

References helperFunctions::cache(), fptr_, triggerObjects_cff::id, sameLumiBlock_, and sequential_.

                                                                                                                                                         {
     assert(!sameLumiBlock_ || id != nullptr);
     assert(sequential_ || engine != nullptr);
     return (this->*fptr_)(cache, fileNameHash, engine, id, recycleFiles);
   }

bool edm::RootEmbeddedFileSequence::readOneRandom	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		CLHEP::HepRandomEngine *	engine,
		EventID const *	,
		bool
	)

Definition at line 251 of file RootEmbeddedFileSequence.cc.

References eventsRemainingInFile_, Exception, edm::RootInputFileSequence::fileCatalogItems(), edm::RootInputFileSequence::fileName(), runEdmFileComparison::found, edm::RootInputFileSequence::initFile(), edm::RootInputFileSequence::lfnHash(), edm::errors::NotFound, edm::RootInputFileSequence::rootFile(), edm::RootInputFileSequence::sequenceNumberOfFile(), edm::RootInputFileSequence::setAtFileSequenceNumber(), and findQualityFiles::size.

Referenced by RootEmbeddedFileSequence().

                                                                                                                                          {
     assert(rootFile());
     assert(engine);
     unsigned int currentSeqNumber = sequenceNumberOfFile();
     while(eventsRemainingInFile_ == 0) {
 
       unsigned int newSeqNumber = CLHEP::RandFlat::shootInt(engine, fileCatalogItems().size());
       setAtFileSequenceNumber(newSeqNumber);
       if(newSeqNumber != currentSeqNumber) {
         initFile(false);
         currentSeqNumber = newSeqNumber;
       }
       eventsRemainingInFile_ = rootFile()->eventTree().entries();
       if(eventsRemainingInFile_ == 0) {
         throw Exception(errors::NotFound) <<
            "RootEmbeddedFileSequence::readOneRandom(): Secondary Input file " << fileName() << " contains no events.\n";
       }
       rootFile()->setAtEventEntry(CLHEP::RandFlat::shootInt(engine, eventsRemainingInFile_) - 1);
     }
     rootFile()->nextEventEntry();
 
     bool found = rootFile()->readCurrentEvent(cache);
     if(!found) {
       rootFile()->setAtEventEntry(0);
       bool found = rootFile()->readCurrentEvent(cache);
       assert(found);
     }
     fileNameHash = lfnHash();
     --eventsRemainingInFile_;
     return true;
   }

bool edm::RootEmbeddedFileSequence::readOneRandomWithID	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		CLHEP::HepRandomEngine *	engine,
		EventID const *	id,
		bool	recycleFiles
	)

Definition at line 284 of file RootEmbeddedFileSequence.cc.

References runEdmFileComparison::found, mps_fire::i, edm::RootInputFileSequence::lfnHash(), csvLumiCalc::lumi, edm::RootInputFileSequence::noMoreFiles(), edm::RootInputFileSequence::rootFile(), findQualityFiles::run, and edm::RootInputFileSequence::skipToItem().

Referenced by RootEmbeddedFileSequence().

                                                                                                                                                                 {
     assert(engine);
     assert(idp);
     EventID const& id = *idp;
     if(noMoreFiles() || !rootFile() ||
         rootFile()->indexIntoFileIter().run() != id.run() ||
         rootFile()->indexIntoFileIter().lumi() != id.luminosityBlock()) {
       bool found = skipToItem(id.run(), id.luminosityBlock(), 0);
       if(!found) {
         return false;
       }
       int eventsInLumi = 0;
       assert(rootFile());
       while(rootFile()->setEntryAtNextEventInLumi(id.run(), id.luminosityBlock())) ++eventsInLumi;
       found = skipToItem(id.run(), id.luminosityBlock(), 0);
       assert(found);
       int eventInLumi = CLHEP::RandFlat::shootInt(engine, eventsInLumi);
       for(int i = 0; i < eventInLumi; ++i) {
         bool found = rootFile()->setEntryAtNextEventInLumi(id.run(), id.luminosityBlock());
         assert(found);
       }
     }
     assert(rootFile());
     bool found = rootFile()->setEntryAtNextEventInLumi(id.run(), id.luminosityBlock());
     if(found) {
       found = rootFile()->readCurrentEvent(cache);
     }
     if(!found) {
       bool found = rootFile()->setEntryAtItem(id.run(), id.luminosityBlock(), 0);
       if(!found) {
         return false;
       }
       return readOneRandomWithID(cache, fileNameHash, engine, idp, recycleFiles);
     }
     fileNameHash = lfnHash();
     return true;
   }

bool edm::RootEmbeddedFileSequence::readOneSequential	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		CLHEP::HepRandomEngine *	,
		EventID const *	,
		bool	recycleFiles
	)

Definition at line 169 of file RootEmbeddedFileSequence.cc.

References runEdmFileComparison::found, edm::RootInputFileSequence::initFile(), edm::IndexIntoFile::invalidEntry, edm::RootInputFileSequence::lfnHash(), edm::RootInputFileSequence::noMoreFiles(), edm::RootInputFileSequence::rootFile(), edm::RootInputFileSequence::setAtFirstFile(), and edm::RootInputFileSequence::setAtNextFile().

Referenced by RootEmbeddedFileSequence().

                                                                                                                                                    {
     assert(rootFile());
     rootFile()->nextEventEntry();
     bool found = rootFile()->readCurrentEvent(cache);
     if(!found) {
       setAtNextFile();
       if(noMoreFiles()) {
         if (recycleFiles) {
           setAtFirstFile();
         } else {
           return false;
         }
       }
       initFile(false);
       assert(rootFile());
       rootFile()->setAtEventEntry(IndexIntoFile::invalidEntry);
       return readOneSequential(cache, fileNameHash, nullptr, nullptr, recycleFiles);
     }
     fileNameHash = lfnHash();
     return true;
   }

bool edm::RootEmbeddedFileSequence::readOneSequentialWithID	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		CLHEP::HepRandomEngine *	,
		EventID const *	id,
		bool	recycleFiles
	)

Definition at line 192 of file RootEmbeddedFileSequence.cc.

References runEdmFileComparison::found, initialNumberOfEventsToSkip_, edm::RootInputFileSequence::lfnHash(), csvLumiCalc::lumi, edm::RootInputFileSequence::noMoreFiles(), PFRecoTauDiscriminationByIsolation_cfi::offset, edm::RootInputFileSequence::rootFile(), findQualityFiles::run, edm::RootInputFileSequence::skipToItem(), and edm::RootInputFileSequence::skipToItemInNewFile().

Referenced by RootEmbeddedFileSequence().

                                                                                                                                                              {
     assert(idp);
     EventID const& id = *idp;
     int offset = initialNumberOfEventsToSkip_;
     initialNumberOfEventsToSkip_ = 0;
     if(offset > 0) {
       assert(rootFile());
       while(offset > 0) {
         bool found = readOneSequentialWithID(cache, fileNameHash, nullptr, idp, recycleFiles);
         if(!found) {
           return false;
         }
         --offset;
       }
     }
     assert(rootFile());
     if(noMoreFiles() ||
         rootFile()->indexIntoFileIter().run() != id.run() ||
         rootFile()->indexIntoFileIter().lumi() != id.luminosityBlock()) {
       bool found = skipToItem(id.run(), id.luminosityBlock(), 0, 0, false);
       if(!found) {
         return false;
       }
     }
     assert(rootFile());
     bool found = rootFile()->setEntryAtNextEventInLumi(id.run(), id.luminosityBlock());
     if(found) {
       found = rootFile()->readCurrentEvent(cache);
     }
     if(!found) {
       found = skipToItemInNewFile(id.run(), id.luminosityBlock(), 0);
       if(!found) {
         return false;
       }
       return readOneSequentialWithID(cache, fileNameHash, nullptr, idp, recycleFiles);
     }
     fileNameHash = lfnHash();
     return true;
   }

void edm::RootEmbeddedFileSequence::readOneSpecified	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		SecondaryEventIDAndFileInfo const &	id
	)

Definition at line 233 of file RootEmbeddedFileSequence.cc.

References event(), edm::SecondaryEventIDAndFileInfo::eventID(), Exception, edm::SecondaryEventIDAndFileInfo::fileNameHash(), runEdmFileComparison::found, edm::RootInputFileSequence::lfnHash(), edm::errors::NotFound, edm::RootInputFileSequence::rootFile(), findQualityFiles::run, edm::RootInputFileSequence::skipToItem(), and mitigatedMETSequence_cff::U.

                                                                                                                                 {
     EventID const& id = idx.eventID();
     bool found = skipToItem(id.run(), id.luminosityBlock(), id.event(), idx.fileNameHash());
     if(!found) {
        throw Exception(errors::NotFound) <<
          "RootEmbeddedFileSequence::readOneSpecified(): Secondary Input files" <<
          " do not contain specified event:\n" << id << "\n";
     }
     assert(rootFile());
     found = rootFile()->readCurrentEvent(cache);
     assert(found);
     fileNameHash = idx.fileNameHash();
     if(fileNameHash == 0U)  {
       fileNameHash = lfnHash();
     }
   }

void edm::RootEmbeddedFileSequence::skipEntries ( unsigned int offset )

Definition at line 153 of file RootEmbeddedFileSequence.cc.

References edm::RootInputFileSequence::initFile(), edm::IndexIntoFile::invalidEntry, edm::RootInputFileSequence::noMoreFiles(), edm::RootInputFileSequence::rootFile(), edm::RootInputFileSequence::setAtFirstFile(), and edm::RootInputFileSequence::setAtNextFile().

Referenced by RootEmbeddedFileSequence().

                                                            {
     // offset is decremented by the number of events actually skipped.
     bool completed = rootFile()->skipEntries(offset);
     while(!completed) {
       setAtNextFile();
       if(noMoreFiles()) {
         setAtFirstFile();
       }
       initFile(false);
       assert(rootFile());
       rootFile()->setAtEventEntry(IndexIntoFile::invalidEntry);
       completed = rootFile()->skipEntries(offset);
     }
   }