#include <DQMProtobufReader.h>

Inheritance diagram for dqmservices::DQMProtobufReader:

Public Types
typedef dqm::legacy::DQMStore	DQMStore

typedef dqm::legacy::MonitorElement	MonitorElement

Public Types inherited from edm::InputSource
enum	ItemType { IsInvalid, IsStop, IsFile, IsRun, IsLumi, IsEvent, IsRepeat, IsSynchronize }

enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex >>

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Member Functions
	DQMProtobufReader (edm::ParameterSet const &, edm::InputSourceDescription const &)

	~DQMProtobufReader () override

Public Member Functions inherited from edm::PuttableSourceBase
bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginRuns () const final

	PuttableSourceBase (ParameterSet const &, InputSourceDescription const &)

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

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...

void	doEndJob ()
	Called by framework at end of job. 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...

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

InputSource &	operator= (InputSource const &)=delete

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...

std::shared_ptr< ProductRegistry > &	productRegistry ()

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::unique_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	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

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)

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...

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

	~ProducerBase () noexcept(false) override

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

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
void	beginLuminosityBlock (edm::LuminosityBlock &lb) override

edm::InputSource::ItemType	getNextItemType () override

void	logFileAction (char const msg, char const fileName) const

bool	prepareNextFile ()

void	readEvent_ (edm::EventPrincipal &) override

void	readLuminosityBlock_ (edm::LuminosityBlockPrincipal &lbCache) override

std::shared_ptr< edm::LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary_ () override

void	readRun_ (edm::RunPrincipal &rpCache) override

std::shared_ptr< edm::RunAuxiliary >	readRunAuxiliary_ () override

Private Attributes
DQMFileIterator::LumiEntry	currentLumi_

DQMFileIterator	fiterator_

bool	flagDeleteDatFiles_

bool	flagEndOfRunKills_

bool	flagLoadFiles_

bool	flagSkipFirstLumis_

InputSource::ItemType	nextItemType

std::unique_ptr< double >	streamReader_

Additional Inherited Members
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::PuttableSourceBase
void	beginJob () override
	Begin protected makes it easier to do template programming. More...

Protected Member Functions inherited from edm::InputSource
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...

virtual void	skip (int offset)

ItemType	state () const

Protected Member Functions inherited from edm::ProducerBase
ProducesCollector	producesCollector ()

Detailed Description

Definition at line 19 of file DQMProtobufReader.h.

Member Typedef Documentation

typedef dqm::legacy::DQMStore dqmservices::DQMProtobufReader::DQMStore

Definition at line 22 of file DQMProtobufReader.h.

typedef dqm::legacy::MonitorElement dqmservices::DQMProtobufReader::MonitorElement

Definition at line 21 of file DQMProtobufReader.h.

Constructor & Destructor Documentation

DQMProtobufReader::DQMProtobufReader	(	edm::ParameterSet const &	pset,
		edm::InputSourceDescription const &	desc
	)

explicit

Definition at line 11 of file DQMProtobufReader.cc.

References flagDeleteDatFiles_, flagEndOfRunKills_, flagLoadFiles_, flagSkipFirstLumis_, and edm::ParameterSet::getUntrackedParameter().

     : PuttableSourceBase(pset, desc), fiterator_(pset) {
   flagSkipFirstLumis_ = pset.getUntrackedParameter<bool>("skipFirstLumis");
   flagEndOfRunKills_ = pset.getUntrackedParameter<bool>("endOfRunKills");
   flagDeleteDatFiles_ = pset.getUntrackedParameter<bool>("deleteDatFiles");
   flagLoadFiles_ = pset.getUntrackedParameter<bool>("loadFiles");
 
   produces<std::string, edm::Transition::BeginLuminosityBlock>("sourceDataPath");
   produces<std::string, edm::Transition::BeginLuminosityBlock>("sourceJsonPath");
 }

DQMProtobufReader::~DQMProtobufReader ( )

override

Definition at line 22 of file DQMProtobufReader.cc.

22 {}

Member Function Documentation

void DQMProtobufReader::beginLuminosityBlock ( edm::LuminosityBlock & lb )

overrideprivatevirtual

Reimplemented from edm::PuttableSourceBase.

Definition at line 101 of file DQMProtobufReader.cc.

References currentLumi_, fiterator_, flagLoadFiles_, dqmservices::DQMFileIterator::LumiEntry::get_data_path(), dqmservices::DQMFileIterator::LumiEntry::get_json_path(), dqm::dqmstoreimpl::DQMStore::getAllContents(), dqm::dqmstoreimpl::DQMStore::load(), dqmservices::DQMFileIterator::logFileAction(), dqmservices::DQMFileIterator::logLumiState(), eostools::move(), castor_dqm_sourceclient_file_cfg::path, edm::LuminosityBlock::put(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                    {
   edm::Service<DQMStore> store;
 
   // clear the old lumi histograms
   std::vector<MonitorElement*> allMEs = store->getAllContents("");
   for (auto const& ME : allMEs) {
     // We do not want to reset Run Products here!
     if (ME->getLumiFlag()) {
       ME->Reset();
     }
   }
 
   // load the new file
   std::string path = currentLumi_.get_data_path();
   std::string jspath = currentLumi_.get_json_path();
 
   std::unique_ptr<std::string> path_product(new std::string(path));
   std::unique_ptr<std::string> json_product(new std::string(jspath));
 
   lb.put(std::move(path_product), "sourceDataPath");
   lb.put(std::move(json_product), "sourceJsonPath");
 
   if (flagLoadFiles_) {
     if (!boost::filesystem::exists(path)) {
       fiterator_.logFileAction("Data file is missing ", path);
       fiterator_.logLumiState(currentLumi_, "error: data file missing");
       return;
     }
 
     fiterator_.logFileAction("Initiating request to open file ", path);
     fiterator_.logFileAction("Successfully opened file ", path);
     store->load(path);
     fiterator_.logFileAction("Closed file ", path);
     fiterator_.logLumiState(currentLumi_, "close: ok");
   } else {
     fiterator_.logFileAction("Not loading the data file at source level ", path);
     fiterator_.logLumiState(currentLumi_, "close: not loading");
   }
 }

void DQMProtobufReader::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 143 of file DQMProtobufReader.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), DEFINE_FWK_INPUT_SOURCE, DQMProtobufReader_cff::DQMProtobufReader, edm::IDGeneratorSourceBase< PuttableSourceBase >::fillDescription(), dqmservices::DQMFileIterator::fillDescription(), and edm::ParameterSetDescription::setComment().

                                                                                    {
   edm::ParameterSetDescription desc;
 
   desc.setComment(
       "Creates runs and lumis and fills the dqmstore from protocol buffer "
       "files.");
   edm::ProducerSourceBase::fillDescription(desc);
 
   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>("loadFiles", true)
       ->setComment(
           "Tells the source load the data files. If set to false, source will create skeleton lumi transitions.");
 
   DQMFileIterator::fillDescription(desc);
   descriptions.add("source", desc);
 }

edm::InputSource::ItemType DQMProtobufReader::getNextItemType ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 24 of file DQMProtobufReader.cc.

References dqmservices::DQMFileIterator::delay(), fiterator_, flagEndOfRunKills_, svgfig::load(), dqmservices::DQMFileIterator::logFileAction(), dqmservices::DQMFileIterator::lumiReady(), edm::shutdown_flag, dqmservices::DQMFileIterator::state(), and dqmservices::DQMFileIterator::update_state().

                                                           {
   typedef DQMFileIterator::State State;
   typedef DQMFileIterator::LumiEntry LumiEntry;
 
   // fiterator_.logFileAction("getNextItemType");
 
   for (;;) {
     fiterator_.update_state();
 
     if (edm::shutdown_flag.load()) {
       fiterator_.logFileAction("Shutdown flag was set, shutting down.");
       return InputSource::IsStop;
     }
 
     // check for end of run file and force quit
     if (flagEndOfRunKills_ && (fiterator_.state() != State::OPEN)) {
       return InputSource::IsStop;
     }
 
     // check for end of run and quit if everything has been processed.
     // this is the clean exit
     if ((!fiterator_.lumiReady()) && (fiterator_.state() == State::EOR)) {
       return InputSource::IsStop;
     }
 
     // skip to the next file if we have no files openned yet
     if (fiterator_.lumiReady()) {
       return InputSource::IsLumi;
     }
 
     fiterator_.delay();
     // BUG: for an unknown reason it fails after a certain time if we use
     // IsSynchronize state
     //
     // comment out in order to block at this level
     // return InputSource::IsSynchronize;
   }
 
   // this is unreachable
 }

void dqmservices::DQMProtobufReader::logFileAction	(	char const *	msg,
		char const *	fileName
	)		const

private

bool dqmservices::DQMProtobufReader::prepareNextFile ( )

private

void DQMProtobufReader::readEvent_ ( edm::EventPrincipal & )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 141 of file DQMProtobufReader.cc.

141 {};

void DQMProtobufReader::readLuminosityBlock_ ( edm::LuminosityBlockPrincipal & lbCache )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 93 of file DQMProtobufReader.cc.

References edm::LuminosityBlockPrincipal::fillLuminosityBlockPrincipal(), edm::LuminosityBlockPrincipal::id(), edm::LuminosityBlockID::luminosityBlock(), edm::InputSource::processHistoryRegistryForUpdate(), edm::JobReport::reportInputLumiSection(), and edm::LuminosityBlockID::run().

                                                                                  {
   // fiterator_.logFileAction("readLuminosityBlock_");
 
   edm::Service<edm::JobReport> jr;
   jr->reportInputLumiSection(lbCache.id().run(), lbCache.id().luminosityBlock());
   lbCache.fillLuminosityBlockPrincipal(processHistoryRegistryForUpdate());
 }

std::shared_ptr< edm::LuminosityBlockAuxiliary > DQMProtobufReader::readLuminosityBlockAuxiliary_ ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 83 of file DQMProtobufReader.cc.

References printConversionInfo::aux, currentLumi_, dqmservices::DQMFileIterator::LumiEntry::file_ls, fiterator_, dqmservices::DQMFileIterator::open(), and dqmservices::DQMFileIterator::runNumber().

                                                                                             {
   // fiterator_.logFileAction("readLuminosityBlockAuxiliary_");
 
   currentLumi_ = fiterator_.open();
   edm::LuminosityBlockAuxiliary* aux = new edm::LuminosityBlockAuxiliary(
       fiterator_.runNumber(), currentLumi_.file_ls, edm::Timestamp(), edm::Timestamp());
 
   return std::shared_ptr<edm::LuminosityBlockAuxiliary>(aux);
 }

void DQMProtobufReader::readRun_ ( edm::RunPrincipal & rpCache )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 72 of file DQMProtobufReader.cc.

References edm::RunPrincipal::fillRunPrincipal(), dqm::dqmstoreimpl::DQMStore::getAllContents(), and edm::InputSource::processHistoryRegistryForUpdate().

                                                          {
   // fiterator_.logFileAction("readRun_");
   rpCache.fillRunPrincipal(processHistoryRegistryForUpdate());
 
   edm::Service<DQMStore> store;
   std::vector<MonitorElement*> allMEs = store->getAllContents("");
   for (auto const& ME : allMEs) {
     ME->Reset();
   }
 }

std::shared_ptr< edm::RunAuxiliary > DQMProtobufReader::readRunAuxiliary_ ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 65 of file DQMProtobufReader.cc.

References printConversionInfo::aux, fiterator_, and dqmservices::DQMFileIterator::runNumber().

                                                                     {
   // fiterator_.logFileAction("readRunAuxiliary_");
 
   edm::RunAuxiliary* aux = new edm::RunAuxiliary(fiterator_.runNumber(), edm::Timestamp(), edm::Timestamp());
   return std::shared_ptr<edm::RunAuxiliary>(aux);
 }