CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
edm::InputSource Class Referenceabstract

#include <InputSource.h>

Inheritance diagram for edm::InputSource:
edm::ProductRegistryHelper DQMRootSource dqmservices::DQMProtobufReader edm::EDInputSource edm::ProducerSourceBase edm::RawInputSource edm::VectorInputSource cond::EmptyIOVSource edm::EmptySource edm::ProducerSourceFromFiles LmfSource edm::RawInputSourceFromFiles edm::StreamerInputSource FedRawDataInputSource

Classes

class  EventSourceSentry
 
class  FileCloseSentry
 
class  FileOpenSentry
 
class  LumiSourceSentry
 
class  RunSourceSentry
 
class  SourceSentry
 

Public Types

enum  ItemType {
  IsInvalid, IsStop, IsFile, IsRun,
  IsLumi, IsEvent, IsRepeat, IsSynchronize
}
 
enum  ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
 
typedef
ProductRegistryHelper::TypeLabelList 
TypeLabelList
 

Public Member Functions

std::shared_ptr< ActivityRegistryactReg () const
 Accessor for Activity Registry. More...
 
std::shared_ptr
< BranchIDListHelper
branchIDListHelper () const
 Accessor for branchIDListHelper. More...
 
void closeFile (FileBlock *, bool cleaningUpAfterException)
 close current file More...
 
void doBeginJob ()
 Called by framework at beginning of job. More...
 
void doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
 Called by framework at beginning of lumi block. More...
 
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 doEndLumi (LuminosityBlockPrincipal &lbp, bool cleaningUpAfterException, ProcessContext const *)
 Called by framework at end of lumi block. More...
 
void doEndRun (RunPrincipal &rp, bool cleaningUpAfterException, ProcessContext const *)
 Called by framework at end of run. More...
 
void doPostForkReacquireResources (std::shared_ptr< multicore::MessageReceiverForSource >)
 
void doPreForkReleaseResources ()
 Called by the framework before forking the process. 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)
 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...
 
InputSourceoperator= (InputSource const &)=delete
 
bool primary () const
 Accessor for primary input source flag. More...
 
ProcessConfiguration const & processConfiguration () const
 Accessor for Process Configuration. More...
 
std::string const & processGUID () const
 Accessor for global process identifier. More...
 
ProcessHistoryRegistry const & processHistoryRegistry () const
 Const accessor for process history registry. More...
 
ProcessHistoryRegistryprocessHistoryRegistryForUpdate ()
 Non-const accessor for process history registry. More...
 
ProcessingMode processingMode () const
 RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
 
std::shared_ptr
< ProductRegistry const > 
productRegistry () const
 Accessor 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::unique_ptr< FileBlockreadFile ()
 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< RunAuxiliaryreadRunAuxiliary ()
 Read next run Auxiliary. More...
 
ProcessHistoryID const & reducedProcessHistoryID () const
 
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...
 
SharedResourcesAcquirerresourceSharedWithDelayedReader () const
 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< RunAuxiliaryrunAuxiliary () 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)
 
bool skipForForking ()
 
std::shared_ptr
< ThinnedAssociationsHelper
thinnedAssociationsHelper () const
 Accessor for thinnedAssociationsHelper. More...
 
Timestamp const & timestamp () const
 Accessor for the current time, as seen by the input source. More...
 
virtual ~InputSource ()
 Destructor. More...
 

Static Public Member Functions

static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc)
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 

Protected Member Functions

void decreaseRemainingEventsBy (int iSkipped)
 
bool eventCached () const
 
std::shared_ptr
< LuminosityBlockPrincipal >
const 
luminosityBlockPrincipal () const
 
bool newLumi () const
 
bool newRun () const
 
ProcessHistoryRegistryprocessHistoryRegistryUpdate () const
 
ProductRegistryproductRegistryUpdate () const
 
void reset () const
 
void resetEventCached ()
 
void resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
 
void resetNewLumi ()
 
void resetNewRun ()
 
void resetRunAuxiliary (bool isNewRun=true) const
 
std::shared_ptr< RunPrincipal >
const 
runPrincipal () 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
 

Private Member Functions

virtual void beginJob ()
 
virtual void beginLuminosityBlock (LuminosityBlock &)
 
virtual void beginRun (Run &)
 
virtual void closeFile_ ()
 
virtual void endJob ()
 
virtual void endLuminosityBlock (LuminosityBlock &)
 
virtual void endRun (Run &)
 
bool eventLimitReached () const
 
virtual
ProcessingController::ForwardState 
forwardState_ () const
 
virtual ItemType getNextItemType ()=0
 
virtual bool goToEvent_ (EventID const &eventID)
 
bool limitReached () const
 
bool lumiLimitReached () const
 
ItemType nextItemType_ ()
 
virtual void postForkReacquireResources (std::shared_ptr< multicore::MessageReceiverForSource >)
 
virtual void preForkReleaseResources ()
 
virtual bool randomAccess_ () const
 
virtual void readEvent_ (EventPrincipal &eventPrincipal)=0
 
virtual std::unique_ptr
< FileBlock
readFile_ ()
 
virtual bool readIt (EventID const &id, EventPrincipal &eventPrincipal, StreamContext &streamContext)
 
virtual void readLuminosityBlock_ (LuminosityBlockPrincipal &lumiPrincipal)
 
virtual std::shared_ptr
< LuminosityBlockAuxiliary
readLuminosityBlockAuxiliary_ ()=0
 
virtual void readRun_ (RunPrincipal &runPrincipal)
 
virtual std::shared_ptr
< RunAuxiliary
readRunAuxiliary_ ()=0
 
virtual SharedResourcesAcquirerresourceSharedWithDelayedReader_ () const
 
virtual
ProcessingController::ReverseState 
reverseState_ () const
 
virtual void rewind_ ()
 
virtual void setLumi (LuminosityBlockNumber_t lb)
 
virtual void setRun (RunNumber_t r)
 
- Private Member Functions inherited from edm::ProductRegistryHelper
template<class ProductType >
TypeLabelItem const & produces ()
 declare what type of product will make and with which optional label More...
 
template<class ProductType >
TypeLabelItem const & produces (std::string const &instanceName)
 
template<typename ProductType , BranchType B>
TypeLabelItem const & produces ()
 
template<typename ProductType , BranchType B>
TypeLabelItem const & produces (std::string const &instanceName)
 
TypeLabelItem const & produces (const TypeID &id, std::string const &instanceName=std::string())
 
template<BranchType B>
TypeLabelItem const & produces (const TypeID &id, std::string const &instanceName=std::string())
 
 ProductRegistryHelper ()
 
TypeLabelListtypeLabelList ()
 used by the fwk to register the list of products of this module More...
 
 ~ProductRegistryHelper ()
 

Private Attributes

std::shared_ptr< ActivityRegistryactReg_
 
std::shared_ptr
< BranchIDListHelper
branchIDListHelper_
 
bool eventCached_
 
std::shared_ptr
< LuminosityBlockAuxiliary
lumiAuxiliary_
 
int maxEvents_
 
int maxLumis_
 
int maxSecondsUntilRampdown_
 
ModuleDescription const moduleDescription_
 
bool newLumi_
 
bool newRun_
 
unsigned int numberOfEventsBeforeBigSkip_
 
bool const primary_
 
std::string processGUID_
 
std::unique_ptr
< ProcessHistoryRegistry
processHistoryRegistry_
 
ProcessingMode processingMode_
 
std::chrono::time_point
< std::chrono::steady_clock > 
processingStart_
 
std::shared_ptr< ProductRegistryproductRegistry_
 
int readCount_
 
std::shared_ptr
< edm::multicore::MessageReceiverForSource
receiver_
 
int remainingEvents_
 
int remainingLumis_
 
std::shared_ptr< RunAuxiliaryrunAuxiliary_
 
ItemType state_
 
std::string statusFileName_
 
std::shared_ptr
< ThinnedAssociationsHelper
thinnedAssociationsHelper_
 
Timestamp time_
 

Additional Inherited Members

- Private Types inherited from edm::ProductRegistryHelper
typedef std::list< TypeLabelItemTypeLabelList
 
- Static Private Member Functions inherited from edm::ProductRegistryHelper
static void addToRegistry (TypeLabelList::const_iterator const &iBegin, TypeLabelList::const_iterator const &iEnd, ModuleDescription const &iDesc, ProductRegistry &iReg, bool iIsListener=false)
 

Detailed Description

Definition at line 76 of file InputSource.h.

Member Typedef Documentation

Definition at line 95 of file InputSource.h.

Member Enumeration Documentation

Enumerator
IsInvalid 
IsStop 
IsFile 
IsRun 
IsLumi 
IsEvent 
IsRepeat 
IsSynchronize 

Definition at line 78 of file InputSource.h.

Enumerator
Runs 
RunsAndLumis 
RunsLumisAndEvents 

Definition at line 89 of file InputSource.h.

Constructor & Destructor Documentation

InputSource::InputSource ( ParameterSet const &  pset,
InputSourceDescription const &  desc 
)
explicit

Constructor.

Definition at line 52 of file InputSource.cc.

References assert(), edm::errors::Configuration, edm::hlt::Exception, edm::ParameterSet::getUntrackedParameter(), maxSecondsUntilRampdown_, fileCollector::now, primary_, processingMode(), processingMode_, processingStart_, edm::InputSourceDescription::productRegistry_, Runs, RunsAndLumis, statusFileName_, and AlCaHLTBitMon_QueryRunRegistry::string.

52  :
54  actReg_(desc.actReg_),
55  maxEvents_(desc.maxEvents_),
57  maxLumis_(desc.maxLumis_),
59  readCount_(0),
60  maxSecondsUntilRampdown_(desc.maxSecondsUntilRampdown_),
62  moduleDescription_(desc.moduleDescription_),
63  productRegistry_(createSharedPtrToStatic<ProductRegistry>(desc.productRegistry_)),
64  processHistoryRegistry_(new ProcessHistoryRegistry),
65  branchIDListHelper_(desc.branchIDListHelper_),
66  thinnedAssociationsHelper_(desc.thinnedAssociationsHelper_),
67  primary_(pset.getParameter<std::string>("@module_label") == std::string("@main_input")),
69  time_(),
70  newRun_(true),
71  newLumi_(true),
72  eventCached_(false),
74  runAuxiliary_(),
77  receiver_(),
79 
80  if(pset.getUntrackedParameter<bool>("writeStatusFile", false)) {
81  std::ostringstream statusfilename;
82  statusfilename << "source_" << getpid();
83  statusFileName_ = statusfilename.str();
84  }
85  if (maxSecondsUntilRampdown_ > 0) {
87  }
88 
89  // Secondary input sources currently do not have a product registry.
90  if(primary_) {
91  assert(desc.productRegistry_ != 0);
92  }
93  std::string const defaultMode("RunsLumisAndEvents");
94  std::string const runMode("Runs");
95  std::string const runLumiMode("RunsAndLumis");
96 
97  // The default value provided as the second argument to the getUntrackedParameter function call
98  // is not used when the ParameterSet has been validated and the parameters are not optional
99  // in the description. As soon as all primary input sources and all modules with a secondary
100  // input sources have defined descriptions, the defaults in the getUntrackedParameterSet function
101  // calls can and should be deleted from the code.
102  std::string processingMode = pset.getUntrackedParameter<std::string>("processingMode", defaultMode);
103  if(processingMode == runMode) {
105  } else if(processingMode == runLumiMode) {
107  } else if(processingMode != defaultMode) {
109  << "InputSource::InputSource()\n"
110  << "The 'processingMode' parameter for sources has an illegal value '" << processingMode << "'\n"
111  << "Legal values are '" << defaultMode << "', '" << runLumiMode << "', or '" << runMode << "'.\n";
112  }
113  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:454
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:455
Timestamp time_
Definition: InputSource.h:449
std::string statusFileName_
Definition: InputSource.h:456
assert(m_qm.get())
std::shared_ptr< BranchIDListHelper > branchIDListHelper_
Definition: InputSource.h:445
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:257
std::chrono::time_point< std::chrono::steady_clock > processingStart_
Definition: InputSource.h:440
unsigned int numberOfEventsBeforeBigSkip_
Definition: InputSource.h:460
ProcessingMode processingMode_
Definition: InputSource.h:441
int maxSecondsUntilRampdown_
Definition: InputSource.h:439
std::shared_ptr< ActivityRegistry > actReg_
Definition: InputSource.h:433
std::shared_ptr< ProductRegistry > productRegistry_
Definition: InputSource.h:443
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:459
std::string processGUID_
Definition: InputSource.h:448
std::unique_ptr< ProcessHistoryRegistry > processHistoryRegistry_
Definition: InputSource.h:444
bool const primary_
Definition: InputSource.h:447
ModuleDescription const moduleDescription_
Definition: InputSource.h:442
std::string createGlobalIdentifier()
std::shared_ptr< ThinnedAssociationsHelper > thinnedAssociationsHelper_
Definition: InputSource.h:446
InputSource::~InputSource ( )
virtual

Destructor.

Definition at line 115 of file InputSource.cc.

115 {}
edm::InputSource::InputSource ( InputSource const &  )
delete

Member Function Documentation

std::shared_ptr<ActivityRegistry> edm::InputSource::actReg ( ) const
inline

Accessor for Activity Registry.

Definition at line 260 of file InputSource.h.

References actReg_.

Referenced by edm::InputSource::EventSourceSentry::EventSourceSentry(), edm::InputSource::FileCloseSentry::FileCloseSentry(), and edm::InputSource::FileOpenSentry::FileOpenSentry().

260 {return actReg_;}
std::shared_ptr< ActivityRegistry > actReg_
Definition: InputSource.h:433
std::string const & InputSource::baseType ( )
static

Definition at line 132 of file InputSource.cc.

References edm::kBaseType().

132  {
133  return kBaseType;
134  }
static const std::string kBaseType("EDAnalyzer")
void InputSource::beginJob ( void  )
privatevirtual

Reimplemented in edm::ProducerSourceBase.

Definition at line 562 of file InputSource.cc.

Referenced by doBeginJob().

562 {}
void InputSource::beginLuminosityBlock ( LuminosityBlock )
privatevirtual

Reimplemented in edm::ProducerSourceBase, and FRDStreamSource.

Definition at line 550 of file InputSource.cc.

Referenced by doBeginLumi().

550 {}
void InputSource::beginRun ( Run )
privatevirtual

Reimplemented in MCatNLOSource, edm::ProducerSourceBase, AlpgenSource, LHESource, and FRDStreamSource.

Definition at line 556 of file InputSource.cc.

Referenced by doBeginRun().

556 {}
std::shared_ptr<BranchIDListHelper> edm::InputSource::branchIDListHelper ( ) const
inline

Accessor for branchIDListHelper.

Definition at line 178 of file InputSource.h.

References branchIDListHelper_.

Referenced by edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::RootInputFileSequence::initFile(), and edm::StreamerInputSource::read().

178 {return branchIDListHelper_;}
std::shared_ptr< BranchIDListHelper > branchIDListHelper_
Definition: InputSource.h:445
void InputSource::closeFile ( FileBlock fb,
bool  cleaningUpAfterException 
)

close current file

Definition at line 285 of file InputSource.cc.

References edm::FileBlock::close(), and closeFile_().

Referenced by edm::RawInputSource::preForkReleaseResources(), and Vispa.Main.Application.Application::tabCloseRequest().

285  {
286  if(fb != nullptr) fb->close();
287  callWithTryCatchAndPrint<void>( [this](){ closeFile_(); },
288  "Calling InputSource::closeFile_",
289  cleaningUpAfterException );
290  return;
291  }
virtual void closeFile_()
Definition: InputSource.h:412
virtual void edm::InputSource::closeFile_ ( )
inlineprivatevirtual

Reimplemented in DQMRootSource, edm::PoolSource, and edm::RawInputSource.

Definition at line 412 of file InputSource.h.

Referenced by closeFile().

412 {}
void InputSource::decreaseRemainingEventsBy ( int  iSkipped)
protected

Called by inheriting classes when running multicore when the receiver has told them to skip some events.

Definition at line 477 of file InputSource.cc.

References remainingEvents_.

Referenced by rewind(), and skipForForking().

477  {
478  if(-1 == remainingEvents_) {
479  return;
480  }
481  if(iSkipped < remainingEvents_) {
482  remainingEvents_ -= iSkipped;
483  } else {
484  remainingEvents_ = 0;
485  }
486  }
void InputSource::doBeginJob ( )

Called by framework at beginning of job.

Definition at line 249 of file InputSource.cc.

References beginJob().

249  {
250  this->beginJob();
251  }
virtual void beginJob()
Definition: InputSource.cc:562
void InputSource::doBeginLumi ( LuminosityBlockPrincipal lbp,
ProcessContext const *   
)

Called by framework at beginning of lumi block.

Definition at line 505 of file InputSource.cc.

References beginLuminosityBlock(), edm::LuminosityBlock::commit_(), and moduleDescription().

505  {
506  LuminosityBlock lb(lbp, moduleDescription(), nullptr);
507  callWithTryCatchAndPrint<void>( [this,&lb](){ beginLuminosityBlock(lb); }, "Calling InputSource::beginLuminosityBlock" );
508  lb.commit_();
509  }
virtual void beginLuminosityBlock(LuminosityBlock &)
Definition: InputSource.cc:550
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:209
void InputSource::doBeginRun ( RunPrincipal rp,
ProcessContext const *   
)

Called by framework at beginning of run.

Definition at line 489 of file InputSource.cc.

References beginRun(), edm::Run::commit_(), moduleDescription(), and run().

489  {
490  Run run(rp, moduleDescription(), nullptr);
491  callWithTryCatchAndPrint<void>( [this,&run](){ beginRun(run); }, "Calling InputSource::beginRun" );
492  run.commit_();
493  }
RunNumber_t run() const
Accessor for current run number.
Definition: InputSource.cc:600
virtual void beginRun(Run &)
Definition: InputSource.cc:556
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:209
void InputSource::doEndJob ( )

Called by framework at end of job.

Definition at line 254 of file InputSource.cc.

References endJob().

Referenced by edm::EventProcessor::endJob().

254  {
255  endJob();
256  }
virtual void endJob()
Definition: InputSource.cc:565
void InputSource::doEndLumi ( LuminosityBlockPrincipal lbp,
bool  cleaningUpAfterException,
ProcessContext const *   
)

Called by framework at end of lumi block.

Definition at line 512 of file InputSource.cc.

References edm::LuminosityBlock::commit_(), endLuminosityBlock(), moduleDescription(), edm::LuminosityBlockPrincipal::setComplete(), edm::LuminosityBlockPrincipal::setEndTime(), and time_.

512  {
513  lbp.setEndTime(time_);
514  lbp.setComplete();
515  LuminosityBlock lb(lbp, moduleDescription(), nullptr);
516  callWithTryCatchAndPrint<void>( [this,&lb](){ endLuminosityBlock(lb); }, "Calling InputSource::endLuminosityBlock", cleaningUpAfterException );
517  lb.commit_();
518  }
Timestamp time_
Definition: InputSource.h:449
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:209
virtual void endLuminosityBlock(LuminosityBlock &)
Definition: InputSource.cc:553
void InputSource::doEndRun ( RunPrincipal rp,
bool  cleaningUpAfterException,
ProcessContext const *   
)

Called by framework at end of run.

Definition at line 496 of file InputSource.cc.

References edm::Run::commit_(), endRun(), moduleDescription(), run(), edm::RunPrincipal::setComplete(), edm::RunPrincipal::setEndTime(), and time_.

496  {
497  rp.setEndTime(time_);
498  rp.setComplete();
499  Run run(rp, moduleDescription(), nullptr);
500  callWithTryCatchAndPrint<void>( [this,&run](){ endRun(run); }, "Calling InputSource::endRun", cleaningUpAfterException );
501  run.commit_();
502  }
virtual void endRun(Run &)
Definition: InputSource.cc:559
Timestamp time_
Definition: InputSource.h:449
RunNumber_t run() const
Accessor for current run number.
Definition: InputSource.cc:600
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:209
void InputSource::doPostForkReacquireResources ( std::shared_ptr< multicore::MessageReceiverForSource iReceiver)

Definition at line 526 of file InputSource.cc.

References postForkReacquireResources().

526  {
527  callWithTryCatchAndPrint<void>( [this, &iReceiver](){ postForkReacquireResources(iReceiver); },
528  "Calling InputSource::postForkReacquireResources" );
529  }
virtual void postForkReacquireResources(std::shared_ptr< multicore::MessageReceiverForSource >)
Definition: InputSource.cc:571
void InputSource::doPreForkReleaseResources ( )

Called by the framework before forking the process.

Definition at line 521 of file InputSource.cc.

References preForkReleaseResources().

521  {
522  callWithTryCatchAndPrint<void>( [this](){ preForkReleaseResources(); }, "Calling InputSource::preForkReleaseResources" );
523  }
virtual void preForkReleaseResources()
Definition: InputSource.cc:568
void InputSource::endJob ( void  )
privatevirtual

Reimplemented in MCatNLOSource, edm::PoolSource, and LHESource.

Definition at line 565 of file InputSource.cc.

Referenced by doEndJob().

565 {}
void InputSource::endLuminosityBlock ( LuminosityBlock )
privatevirtual

Reimplemented in edm::ProducerSourceBase, and FRDStreamSource.

Definition at line 553 of file InputSource.cc.

Referenced by doEndLumi().

553 {}
void InputSource::endRun ( Run )
privatevirtual

Reimplemented in edm::ProducerSourceBase, LHESource, and FRDStreamSource.

Definition at line 559 of file InputSource.cc.

Referenced by doEndRun().

559 {}
bool edm::InputSource::eventCached ( ) const
inlineprotected
bool edm::InputSource::eventLimitReached ( ) const
inlineprivate

Definition at line 393 of file InputSource.h.

References remainingEvents_.

Referenced by limitReached(), nextItemType(), readEvent(), and skipForForking().

393 {return remainingEvents_ == 0;}
void InputSource::fillDescription ( ParameterSetDescription desc)
static

Definition at line 137 of file InputSource.cc.

References edm::ParameterSetDescription::addUntracked(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::RawInputSource::fillDescription(), edm::EDInputSource::fillDescription(), and edm::ProducerSourceBase::fillDescription().

137  {
138  std::string defaultString("RunsLumisAndEvents");
139  desc.addUntracked<std::string>("processingMode", defaultString)->setComment(
140  "'RunsLumisAndEvents': process runs, lumis, and events.\n"
141  "'RunsAndLumis': process runs and lumis (not events).\n"
142  "'Runs': process runs (not lumis or events).");
143  desc.addUntracked<bool>("writeStatusFile", false)->setComment("Write a status file. Intended for use by workflow management.");
144  }
void InputSource::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 118 of file InputSource.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

118  {
120  desc.setUnknown();
121  descriptions.addDefault(desc);
122  }
ProcessingController::ForwardState InputSource::forwardState ( ) const

Definition at line 538 of file InputSource.cc.

References forwardState_().

538  {
539  return callWithTryCatchAndPrint<ProcessingController::ForwardState>( [this](){ return forwardState_(); },
540  "Calling InputSource::forwardState_" );
541  }
virtual ProcessingController::ForwardState forwardState_() const
Definition: InputSource.cc:584
ProcessingController::ForwardState InputSource::forwardState_ ( ) const
privatevirtual
virtual ItemType edm::InputSource::getNextItemType ( )
privatepure virtual
bool InputSource::goToEvent ( EventID const &  eventID)

Definition at line 390 of file InputSource.cc.

References goToEvent_().

390  {
391  return callWithTryCatchAndPrint<bool>( [this,&eventID](){ return goToEvent_(eventID); }, "Calling InputSource::goToEvent_" );
392  }
virtual bool goToEvent_(EventID const &eventID)
Definition: InputSource.cc:460
bool InputSource::goToEvent_ ( EventID const &  eventID)
privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 460 of file InputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by goToEvent().

460  {
462  << "InputSource::goToEvent_()\n"
463  << "Random access is not implemented for this type of Input Source\n"
464  << "Contact a Framework Developer\n";
465  return true;
466  }
void InputSource::issueReports ( EventID const &  eventID)

issue an event report

Definition at line 410 of file InputSource.cc.

References edm::EventID::event(), edm::isInfoEnabled(), edm::EventID::luminosityBlock(), readCount_, edm::EventID::run(), statusFileName_, and createPayload::suffix.

Referenced by readEvent().

410  {
411  if(isInfoEnabled()) {
412  LogVerbatim("FwkReport") << "Begin processing the " << readCount_
413  << suffix(readCount_) << " record. Run " << eventID.run()
414  << ", Event " << eventID.event()
415  << ", LumiSection " << eventID.luminosityBlock()
416  << " at " << std::setprecision(3) << TimeOfDay();
417  }
418  if(!statusFileName_.empty()) {
419  std::ofstream statusFile(statusFileName_.c_str());
420  statusFile << eventID << " time: " << std::setprecision(3) << TimeOfDay() << '\n';
421  statusFile.close();
422  }
423 
424  // At some point we may want to initiate checkpointing here
425  }
std::string statusFileName_
Definition: InputSource.h:456
bool isInfoEnabled()
bool edm::InputSource::limitReached ( ) const
inlineprivate

Definition at line 402 of file InputSource.h.

References eventLimitReached(), and lumiLimitReached().

Referenced by readEvent(), and readFile().

402 {return eventLimitReached() || lumiLimitReached();}
bool lumiLimitReached() const
Definition: InputSource.h:394
bool eventLimitReached() const
Definition: InputSource.h:393
bool edm::InputSource::lumiLimitReached ( ) const
inlineprivate

Definition at line 394 of file InputSource.h.

References prof2calltree::count, end, maxSecondsUntilRampdown_, fileCollector::now, processingStart_, and remainingLumis_.

Referenced by limitReached(), and nextItemType().

394  {
395  if (remainingLumis_ == 0) {return true;}
396  if (maxSecondsUntilRampdown_ <= 0) {return false;}
398  auto elapsed = end - processingStart_;
399  if (std::chrono::duration_cast<std::chrono::seconds>(elapsed).count() > maxSecondsUntilRampdown_) {return true;}
400  return false;
401  }
std::chrono::time_point< std::chrono::steady_clock > processingStart_
Definition: InputSource.h:440
int maxSecondsUntilRampdown_
Definition: InputSource.h:439
#define end
Definition: vmac.h:37
LuminosityBlockNumber_t InputSource::luminosityBlock ( ) const

Accessor for current luminosity block number.

Definition at line 606 of file InputSource.cc.

References assert(), and luminosityBlockAuxiliary().

Referenced by Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), edm::StreamerInputSource::deserializeEvent(), FedRawDataInputSource::maybeOpenNewLumiSection(), and edm::PoolSource::readIt().

606  {
608  return luminosityBlockAuxiliary()->luminosityBlock();
609  }
assert(m_qm.get())
std::shared_ptr< LuminosityBlockAuxiliary > luminosityBlockAuxiliary() const
Called by the framework to merge or insert lumi in principal cache.
Definition: InputSource.h:266
std::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::luminosityBlockAuxiliary ( ) const
inline

Called by the framework to merge or insert lumi in principal cache.

Definition at line 266 of file InputSource.h.

References lumiAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::RawInputSource::getNextItemType(), luminosityBlock(), FedRawDataInputSource::maybeOpenNewLumiSection(), LHESource::readLuminosityBlock_(), and edm::RawInputSource::readLuminosityBlockAuxiliary_().

266 {return lumiAuxiliary_;}
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:455
std::shared_ptr<LuminosityBlockPrincipal> const edm::InputSource::luminosityBlockPrincipal ( ) const
protected
int edm::InputSource::maxEvents ( ) const
inline

Accessor for maximum number of events to be read. -1 is used for unlimited.

Definition at line 194 of file InputSource.h.

References maxEvents_.

194 {return maxEvents_;}
int edm::InputSource::maxLuminosityBlocks ( ) const
inline

Accessor for maximum number of lumis to be read. -1 is used for unlimited.

Definition at line 202 of file InputSource.h.

References maxLumis_.

202 {return maxLumis_;}
ModuleDescription const& edm::InputSource::moduleDescription ( ) const
inline

Accessor for 'module' description.

Definition at line 209 of file InputSource.h.

References moduleDescription_.

Referenced by doBeginLumi(), doBeginRun(), doEndLumi(), doEndRun(), processConfiguration(), edm::ProducerSourceBase::readEvent_(), and registerProducts().

209 {return moduleDescription_;}
ModuleDescription const moduleDescription_
Definition: InputSource.h:442
bool edm::InputSource::newLumi ( ) const
inlineprotected
bool edm::InputSource::newRun ( ) const
inlineprotected
InputSource::ItemType InputSource::nextItemType ( )

Advances the source to the next item.

Definition at line 190 of file InputSource.cc.

References assert(), eventLimitReached(), IsEvent, IsFile, IsInvalid, IsLumi, IsRun, IsStop, IsSynchronize, lumiAuxiliary_, lumiLimitReached(), nextItemType_(), edmStreamStallGrapher::oldState, processingMode(), readLuminosityBlockAuxiliary(), readRunAuxiliary(), runAuxiliary_, Runs, RunsLumisAndEvents, and state_.

190  {
192  if(eventLimitReached()) {
193  // If the maximum event limit has been reached, stop.
194  state_ = IsStop;
195  } else if(lumiLimitReached()) {
196  // If the maximum lumi limit has been reached, stop
197  // when reaching a new file, run, or lumi.
198  if(oldState == IsInvalid || oldState == IsFile || oldState == IsRun || processingMode() != RunsLumisAndEvents) {
199  state_ = IsStop;
200  } else {
201  ItemType newState = nextItemType_();
202  if(newState == IsEvent) {
204  state_ = IsEvent;
205  } else {
206  state_ = IsStop;
207  }
208  }
209  } else {
210  ItemType newState = nextItemType_();
211  if(newState == IsStop) {
212  state_ = IsStop;
213  } else if(newState == IsSynchronize) {
215  } else if(newState == IsFile || oldState == IsInvalid) {
216  state_ = IsFile;
217  } else if(newState == IsRun || oldState == IsFile) {
219  state_ = IsRun;
220  } else if(newState == IsLumi || oldState == IsRun) {
221  assert (processingMode() != Runs);
223  state_ = IsLumi;
224  } else {
226  state_ = IsEvent;
227  }
228  }
229  if(state_ == IsStop) {
230  lumiAuxiliary_.reset();
231  runAuxiliary_.reset();
232  }
233  return state_;
234  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:454
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:455
assert(m_qm.get())
std::shared_ptr< RunAuxiliary > readRunAuxiliary()
Read next run Auxiliary.
Definition: InputSource.cc:243
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:257
bool lumiLimitReached() const
Definition: InputSource.h:394
std::shared_ptr< LuminosityBlockAuxiliary > readLuminosityBlockAuxiliary()
Read next luminosity block Auxilary.
Definition: InputSource.cc:237
bool eventLimitReached() const
Definition: InputSource.h:393
ItemType nextItemType_()
Definition: InputSource.cc:175
InputSource::ItemType InputSource::nextItemType_ ( )
private

Definition at line 175 of file InputSource.cc.

References getNextItemType(), IsEvent, IsLumi, processingMode(), Runs, RunsLumisAndEvents, and skipEvents().

Referenced by nextItemType().

175  {
176  ItemType itemType = callWithTryCatchAndPrint<ItemType>( [this](){ return getNextItemType(); }, "Calling InputSource::getNextItemType" );
177 
178  if(itemType == IsEvent && processingMode() != RunsLumisAndEvents) {
179  skipEvents(1);
180  return nextItemType_();
181  }
182  if(itemType == IsLumi && processingMode() == Runs) {
183  // QQQ skipLuminosityBlock_();
184  return nextItemType_();
185  }
186  return itemType;
187  }
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:257
virtual ItemType getNextItemType()=0
void skipEvents(int offset)
Definition: InputSource.cc:385
ItemType nextItemType_()
Definition: InputSource.cc:175
InputSource& edm::InputSource::operator= ( InputSource const &  )
delete
void InputSource::postForkReacquireResources ( std::shared_ptr< multicore::MessageReceiverForSource iReceiver)
privatevirtual

Definition at line 571 of file InputSource.cc.

References numberOfEventsBeforeBigSkip_, receiver_, and rewind().

Referenced by doPostForkReacquireResources().

571  {
572  receiver_ = iReceiver;
573  receiver_->receive();
574  numberOfEventsBeforeBigSkip_ = receiver_->numberOfConsecutiveIndices();
575  rewind();
576  }
unsigned int numberOfEventsBeforeBigSkip_
Definition: InputSource.h:460
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:459
void rewind()
Begin again at the first event.
Definition: InputSource.cc:395
void InputSource::preForkReleaseResources ( )
privatevirtual

Reimplemented in edm::PoolSource, FedRawDataInputSource, and edm::RawInputSource.

Definition at line 568 of file InputSource.cc.

Referenced by doPreForkReleaseResources().

568 {}
void InputSource::prevalidate ( ConfigurationDescriptions )
static

Definition at line 125 of file InputSource.cc.

125  {
126  }
bool edm::InputSource::primary ( ) const
inline

Accessor for primary input source flag.

Definition at line 215 of file InputSource.h.

References primary_.

215 {return primary_;}
bool const primary_
Definition: InputSource.h:447
ProcessConfiguration const& edm::InputSource::processConfiguration ( ) const
inline

Accessor for Process Configuration.

Definition at line 212 of file InputSource.h.

References moduleDescription(), and edm::ModuleDescription::processConfiguration().

Referenced by edm::RootInputFileSequence::processConfiguration(), edm::PoolSource::readLuminosityBlock_(), and edm::PoolSource::readRun_().

ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:209
ProcessConfiguration const & processConfiguration() const
std::string const& edm::InputSource::processGUID ( ) const
inline

Accessor for global process identifier.

Definition at line 218 of file InputSource.h.

References processGUID_.

Referenced by FedRawDataInputSource::read(), LHESource::readEvent_(), and edm::ProducerSourceBase::readEvent_().

218 {return processGUID_;}
std::string processGUID_
Definition: InputSource.h:448
ProcessHistoryRegistry const& edm::InputSource::processHistoryRegistry ( ) const
inline

Const accessor for process history registry.

Definition at line 172 of file InputSource.h.

References processHistoryRegistry_.

Referenced by edm::RawInputSource::makeEvent(), edm::RootInputFileSequence::processHistoryRegistry(), edm::StreamerInputSource::read(), edm::ProducerSourceBase::readEvent_(), readLuminosityBlock_(), and readRun_().

172 {return *processHistoryRegistry_;}
std::unique_ptr< ProcessHistoryRegistry > processHistoryRegistry_
Definition: InputSource.h:444
ProcessHistoryRegistry& edm::InputSource::processHistoryRegistryForUpdate ( )
inline
ProcessHistoryRegistry& edm::InputSource::processHistoryRegistryUpdate ( ) const
inlineprotected

Definition at line 352 of file InputSource.h.

References processHistoryRegistry_.

Referenced by edm::StreamerInputSource::deserializeEvent(), and DQMRootSource::setupFile().

352 {return *processHistoryRegistry_;}
std::unique_ptr< ProcessHistoryRegistry > processHistoryRegistry_
Definition: InputSource.h:444
ProcessingMode edm::InputSource::processingMode ( ) const
inline
std::shared_ptr<ProductRegistry const> edm::InputSource::productRegistry ( ) const
inline

Accessor for product registry.

Definition at line 169 of file InputSource.h.

References productRegistry_.

Referenced by edm::RootInputFileSequence::productRegistry(), and edm::StreamerInputSource::read().

169 {return productRegistry_;}
std::shared_ptr< ProductRegistry > productRegistry_
Definition: InputSource.h:443
ProductRegistry& edm::InputSource::productRegistryUpdate ( ) const
inlineprotected
bool InputSource::randomAccess ( ) const

Definition at line 532 of file InputSource.cc.

References randomAccess_().

532  {
533  return callWithTryCatchAndPrint<bool>( [this](){ return randomAccess_(); },
534  "Calling InputSource::randomAccess_" );
535  }
virtual bool randomAccess_() const
Definition: InputSource.cc:579
bool InputSource::randomAccess_ ( ) const
privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 579 of file InputSource.cc.

Referenced by randomAccess().

579  {
580  return false;
581  }
void InputSource::readAndMergeLumi ( LuminosityBlockPrincipal lbp)

Read next luminosity block (same as a prior lumi)

Definition at line 323 of file InputSource.cc.

References readLuminosityBlock_(), and remainingLumis_.

323  {
324  LumiSourceSentry sentry(*this);
325  callWithTryCatchAndPrint<void>( [this,&lbp](){ readLuminosityBlock_(lbp); }, "Calling InputSource::readLuminosityBlock_" );
326  if(remainingLumis_ > 0) {
327  --remainingLumis_;
328  }
329  }
virtual void readLuminosityBlock_(LuminosityBlockPrincipal &lumiPrincipal)
Definition: InputSource.cc:340
void InputSource::readAndMergeRun ( RunPrincipal rp)

Read next run (same as a prior run)

Definition at line 308 of file InputSource.cc.

References readRun_().

308  {
309  RunSourceSentry sentry(*this);
310  callWithTryCatchAndPrint<void>( [this,&rp](){ readRun_(rp); }, "Calling InputSource::readRun_" );
311  }
virtual void readRun_(RunPrincipal &runPrincipal)
Definition: InputSource.cc:332
void InputSource::readEvent ( EventPrincipal ep,
StreamContext streamContext 
)

Read next event.

Definition at line 345 of file InputSource.cc.

References assert(), eventLimitReached(), edm::EventPrincipal::id(), IsEvent, issueReports(), numberOfEventsBeforeBigSkip_, readCount_, readEvent_(), receiver_, remainingEvents_, setTimestamp(), state_, and edm::EventPrincipal::time().

345  {
346  assert(state_ == IsEvent);
348  {
349  // block scope, in order to issue the PostSourceEvent signal before calling postRead and issueReports
350  EventSourceSentry sentry(*this, streamContext);
351 
352  callWithTryCatchAndPrint<void>( [this,&ep](){ readEvent_(ep); }, "Calling InputSource::readEvent_" );
353  if(receiver_) {
355  }
356  }
357 
359  ++readCount_;
360  setTimestamp(ep.time());
361  issueReports(ep.id());
362  }
void issueReports(EventID const &eventID)
issue an event report
Definition: InputSource.cc:410
assert(m_qm.get())
void setTimestamp(Timestamp const &theTime)
To set the current time, as seen by the input source.
Definition: InputSource.h:349
virtual void readEvent_(EventPrincipal &eventPrincipal)=0
unsigned int numberOfEventsBeforeBigSkip_
Definition: InputSource.h:460
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:459
bool eventLimitReached() const
Definition: InputSource.h:393
bool InputSource::readEvent ( EventPrincipal ep,
EventID const &  eventID,
StreamContext streamContext 
)

Read a specific event.

Definition at line 365 of file InputSource.cc.

References edm::EventPrincipal::id(), issueReports(), limitReached(), readCount_, readIt(), remainingEvents_, and query::result.

365  {
366  bool result = false;
367 
368  if (not limitReached()) {
369  // the Pre/PostSourceEvent signals should be generated only if the event is actually found.
370  // this should be taken care of by an EventSourceSentry in the implementaion of readIt()
371 
372  //result = callWithTryCatchAndPrint<bool>( [this,&eventID,&ep](){ return readIt(eventID, ep); }, "Calling InputSource::readIt" );
373  result = readIt(eventID, ep, streamContext);
374 
375  if (result) {
377  ++readCount_;
378  issueReports(ep.id());
379  }
380  }
381  return result;
382  }
void issueReports(EventID const &eventID)
issue an event report
Definition: InputSource.cc:410
bool limitReached() const
Definition: InputSource.h:402
tuple result
Definition: query.py:137
virtual bool readIt(EventID const &id, EventPrincipal &eventPrincipal, StreamContext &streamContext)
Definition: InputSource.cc:428
virtual void edm::InputSource::readEvent_ ( EventPrincipal eventPrincipal)
privatepure virtual
std::unique_ptr< FileBlock > InputSource::readFile ( )

Read next file.

Definition at line 277 of file InputSource.cc.

References assert(), IsFile, limitReached(), readFile_(), and state_.

Referenced by Vispa.Plugins.EventBrowser.EventBrowserTabController.EventBrowserTabController::navigate(), Vispa.Main.TabController.TabController::open(), and Vispa.Main.TabController.TabController::refresh().

277  {
278  assert(state_ == IsFile);
279  assert(!limitReached());
280  return callWithTryCatchAndPrint<std::unique_ptr<FileBlock> >( [this](){ return readFile_(); },
281  "Calling InputSource::readFile_" );
282  }
assert(m_qm.get())
bool limitReached() const
Definition: InputSource.h:402
virtual std::unique_ptr< FileBlock > readFile_()
Definition: InputSource.cc:297
std::unique_ptr< FileBlock > InputSource::readFile_ ( )
privatevirtual

Reimplemented in DQMRootSource, edm::StreamerInputSource, and edm::PoolSource.

Definition at line 297 of file InputSource.cc.

Referenced by readFile().

297  {
298  return std::unique_ptr<FileBlock>(new FileBlock);
299  }
bool InputSource::readIt ( EventID const &  id,
EventPrincipal eventPrincipal,
StreamContext streamContext 
)
privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 428 of file InputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by readEvent().

428  {
430  << "InputSource::readIt()\n"
431  << "Random access is not implemented for this type of Input Source\n"
432  << "Contact a Framework Developer\n";
433  }
void InputSource::readLuminosityBlock ( LuminosityBlockPrincipal lumiPrincipal,
HistoryAppender historyAppender 
)

Read next luminosity block (new lumi)

Definition at line 314 of file InputSource.cc.

References readLuminosityBlock_(), and remainingLumis_.

314  {
315  LumiSourceSentry sentry(*this);
316  callWithTryCatchAndPrint<void>( [this,&lumiPrincipal](){ readLuminosityBlock_(lumiPrincipal); }, "Calling InputSource::readLuminosityBlock_" );
317  if(remainingLumis_ > 0) {
318  --remainingLumis_;
319  }
320  }
virtual void readLuminosityBlock_(LuminosityBlockPrincipal &lumiPrincipal)
Definition: InputSource.cc:340
void InputSource::readLuminosityBlock_ ( LuminosityBlockPrincipal lumiPrincipal)
privatevirtual

Reimplemented in DQMRootSource, LHESource, edm::PoolSource, and dqmservices::DQMProtobufReader.

Definition at line 340 of file InputSource.cc.

References edm::LuminosityBlockPrincipal::fillLuminosityBlockPrincipal(), and processHistoryRegistry().

Referenced by readAndMergeLumi(), and readLuminosityBlock().

340  {
341  lumiPrincipal.fillLuminosityBlockPrincipal(processHistoryRegistry());
342  }
ProcessHistoryRegistry const & processHistoryRegistry() const
Const accessor for process history registry.
Definition: InputSource.h:172
std::shared_ptr< LuminosityBlockAuxiliary > InputSource::readLuminosityBlockAuxiliary ( )

Read next luminosity block Auxilary.

Definition at line 237 of file InputSource.cc.

References readLuminosityBlockAuxiliary_().

Referenced by nextItemType().

237  {
238  return callWithTryCatchAndPrint<std::shared_ptr<LuminosityBlockAuxiliary> >( [this](){ return readLuminosityBlockAuxiliary_(); },
239  "Calling InputSource::readLuminosityBlockAuxiliary_" );
240  }
virtual std::shared_ptr< LuminosityBlockAuxiliary > readLuminosityBlockAuxiliary_()=0
virtual std::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::readLuminosityBlockAuxiliary_ ( )
privatepure virtual
void InputSource::readRun ( RunPrincipal runPrincipal,
HistoryAppender historyAppender 
)

Read next run (new run)

Definition at line 302 of file InputSource.cc.

References readRun_(), and runPrincipal().

302  {
303  RunSourceSentry sentry(*this);
304  callWithTryCatchAndPrint<void>( [this,&runPrincipal](){ readRun_(runPrincipal); }, "Calling InputSource::readRun_" );
305  }
std::shared_ptr< RunPrincipal > const runPrincipal() const
virtual void readRun_(RunPrincipal &runPrincipal)
Definition: InputSource.cc:332
void InputSource::readRun_ ( RunPrincipal runPrincipal)
privatevirtual

Reimplemented in DQMRootSource, edm::PoolSource, LHESource, and dqmservices::DQMProtobufReader.

Definition at line 332 of file InputSource.cc.

References edm::RunPrincipal::fillRunPrincipal(), and processHistoryRegistry().

Referenced by readAndMergeRun(), and readRun().

332  {
333  // Note: For the moment, we do not support saving and restoring the state of the
334  // random number generator if random numbers are generated during processing of runs
335  // (e.g. beginRun(), endRun())
336  runPrincipal.fillRunPrincipal(processHistoryRegistry());
337  }
ProcessHistoryRegistry const & processHistoryRegistry() const
Const accessor for process history registry.
Definition: InputSource.h:172
std::shared_ptr< RunPrincipal > const runPrincipal() const
std::shared_ptr< RunAuxiliary > InputSource::readRunAuxiliary ( )

Read next run Auxiliary.

Definition at line 243 of file InputSource.cc.

References readRunAuxiliary_().

Referenced by nextItemType().

243  {
244  return callWithTryCatchAndPrint<std::shared_ptr<RunAuxiliary> >( [this](){ return readRunAuxiliary_(); },
245  "Calling InputSource::readRunAuxiliary_" );
246  }
virtual std::shared_ptr< RunAuxiliary > readRunAuxiliary_()=0
virtual std::shared_ptr<RunAuxiliary> edm::InputSource::readRunAuxiliary_ ( )
privatepure virtual
ProcessHistoryID const & InputSource::reducedProcessHistoryID ( ) const

Accessor for the reduced process history ID of the current run. This is the ID of the input process history which does not include the current process.

Definition at line 594 of file InputSource.cc.

References assert(), processHistoryRegistry_, and runAuxiliary().

594  {
595  assert(runAuxiliary());
596  return processHistoryRegistry_->reducedProcessHistoryID(runAuxiliary()->processHistoryID());
597  }
assert(m_qm.get())
std::shared_ptr< RunAuxiliary > runAuxiliary() const
Called by the framework to merge or insert run in principal cache.
Definition: InputSource.h:263
std::unique_ptr< ProcessHistoryRegistry > processHistoryRegistry_
Definition: InputSource.h:444
void InputSource::registerProducts ( )

Register any produced products.

Definition at line 269 of file InputSource.cc.

References edm::ProductRegistryHelper::addToRegistry(), begin, relativeConstraints::empty, end, moduleDescription(), productRegistryUpdate(), and edm::ProductRegistryHelper::typeLabelList().

269  {
270  if(!typeLabelList().empty()) {
272  }
273  }
TypeLabelList & typeLabelList()
used by the fwk to register the list of products of this module
#define end
Definition: vmac.h:37
ProductRegistry & productRegistryUpdate() const
Definition: InputSource.h:351
#define begin
Definition: vmac.h:30
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:209
static void addToRegistry(TypeLabelList::const_iterator const &iBegin, TypeLabelList::const_iterator const &iEnd, ModuleDescription const &iDesc, ProductRegistry &iReg, bool iIsListener=false)
int edm::InputSource::remainingEvents ( ) const
inline

Accessor for remaining number of events to be read. -1 is used for unlimited.

Definition at line 198 of file InputSource.h.

References remainingEvents_.

Referenced by edm::RootInputFileSequence::remainingEvents(), and skipForForking().

198 {return remainingEvents_;}
int edm::InputSource::remainingLuminosityBlocks ( ) const
inline

Accessor for remaining number of lumis to be read. -1 is used for unlimited.

Definition at line 206 of file InputSource.h.

References remainingLumis_.

Referenced by edm::RootInputFileSequence::remainingLuminosityBlocks(), and skipForForking().

206 {return remainingLumis_;}
void edm::InputSource::repeat ( )
inline

Reset the remaining number of events/lumis to the maximum number.

Definition at line 184 of file InputSource.h.

References maxEvents_, maxLumis_, remainingEvents_, and remainingLumis_.

void edm::InputSource::reset ( void  ) const
inlineprotected

Definition at line 370 of file InputSource.h.

References IsInvalid, resetLuminosityBlockAuxiliary(), resetRunAuxiliary(), and state_.

Referenced by edm::StreamerInputSource::resetAfterEndRun().

370  {
373  state_ = IsInvalid;
374  }
void resetRunAuxiliary(bool isNewRun=true) const
Definition: InputSource.h:362
void resetLuminosityBlockAuxiliary(bool isNewLumi=true) const
Definition: InputSource.h:366
void edm::InputSource::resetEventCached ( )
inlineprotected
void edm::InputSource::resetLuminosityBlockAuxiliary ( bool  isNewLumi = true) const
inlineprotected
void edm::InputSource::resetNewLumi ( )
inlineprotected
void edm::InputSource::resetNewRun ( )
inlineprotected

Definition at line 379 of file InputSource.h.

References newRun_.

Referenced by edm::RawInputSource::readRunAuxiliary_(), and edm::ProducerSourceBase::readRunAuxiliary_().

379 {newRun_ = false;}
void edm::InputSource::resetRunAuxiliary ( bool  isNewRun = true) const
inlineprotected

Definition at line 362 of file InputSource.h.

References newLumi_, newRun_, and runAuxiliary_.

Referenced by edm::RawInputSource::getNextItemType(), LHESource::nextEvent(), reset(), and edm::StreamerInputSource::resetAfterEndRun().

362  {
363  runAuxiliary_.reset();
364  newRun_ = newLumi_ = isNewRun;
365  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:454
SharedResourcesAcquirer * InputSource::resourceSharedWithDelayedReader ( ) const

Returns nullptr if no resource shared between the Source and a DelayedReader.

Definition at line 259 of file InputSource.cc.

References resourceSharedWithDelayedReader_().

259  {
261  }
virtual SharedResourcesAcquirer * resourceSharedWithDelayedReader_() const
Definition: InputSource.cc:264
SharedResourcesAcquirer * InputSource::resourceSharedWithDelayedReader_ ( ) const
privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 264 of file InputSource.cc.

Referenced by resourceSharedWithDelayedReader().

264  {
265  return nullptr;
266  }
ProcessingController::ReverseState InputSource::reverseState ( ) const

Definition at line 544 of file InputSource.cc.

References reverseState_().

544  {
545  return callWithTryCatchAndPrint<ProcessingController::ReverseState>( [this](){ return reverseState_(); },
546  "Calling InputSource::reverseState__" );
547  }
virtual ProcessingController::ReverseState reverseState_() const
Definition: InputSource.cc:589
ProcessingController::ReverseState InputSource::reverseState_ ( ) const
privatevirtual
void InputSource::rewind ( )

Begin again at the first event.

Definition at line 395 of file InputSource.cc.

References decreaseRemainingEventsBy(), IsInvalid, maxEvents_, receiver_, remainingEvents_, resetEventCached(), rewind_(), setNewLumi(), setNewRun(), skip(), and state_.

Referenced by postForkReacquireResources().

395  {
396  state_ = IsInvalid;
398  setNewRun();
399  setNewLumi();
401  callWithTryCatchAndPrint<void>( [this](){ rewind_(); }, "Calling InputSource::rewind_" );
402  if(receiver_) {
403  unsigned int numberToSkip = receiver_->numberToSkip();
404  skip(numberToSkip);
405  decreaseRemainingEventsBy(numberToSkip);
406  }
407  }
void decreaseRemainingEventsBy(int iSkipped)
Definition: InputSource.cc:477
virtual void rewind_()
Definition: InputSource.cc:469
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:459
void resetEventCached()
Definition: InputSource.h:386
virtual void skip(int offset)
Definition: InputSource.cc:452
void InputSource::rewind_ ( )
privatevirtual

Reimplemented in FedRawDataInputSource, edm::ProducerSourceBase, edm::PoolSource, and edm::RawInputSource.

Definition at line 469 of file InputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by rewind().

469  {
471  << "InputSource::rewind()\n"
472  << "Forking and random access are not implemented for this type of Input Source\n"
473  << "Contact a Framework Developer\n";
474  }
RunNumber_t InputSource::run ( void  ) const

Accessor for current run number.

Definition at line 600 of file InputSource.cc.

References assert(), and runAuxiliary().

Referenced by Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), edm::StreamerInputSource::deserializeEvent(), doBeginRun(), doEndRun(), edm::PoolSource::getNextItemType(), FedRawDataInputSource::maybeOpenNewLumiSection(), and edm::PoolSource::readIt().

600  {
601  assert(runAuxiliary());
602  return runAuxiliary()->run();
603  }
assert(m_qm.get())
std::shared_ptr< RunAuxiliary > runAuxiliary() const
Called by the framework to merge or insert run in principal cache.
Definition: InputSource.h:263
std::shared_ptr<RunAuxiliary> edm::InputSource::runAuxiliary ( ) const
inline
std::shared_ptr<RunPrincipal> const edm::InputSource::runPrincipal ( ) const
protected

Referenced by readRun(), and LHESource::readRun_().

void edm::InputSource::setEventCached ( )
inlineprotected

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

Definition at line 385 of file InputSource.h.

References eventCached_.

Referenced by FedRawDataInputSource::checkNextEvent(), edm::StreamerInputSource::deserializeEvent(), and edm::ProducerSourceBase::getNextItemType().

385 {eventCached_ = true;}
void InputSource::setLumi ( LuminosityBlockNumber_t  lb)
privatevirtual

Definition at line 444 of file InputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by setLuminosityBlockNumber_t().

444  {
446  << "InputSource::setLumi()\n"
447  << "Luminosity Block ID cannot be modified for this type of Input Source\n"
448  << "Contact a Framework Developer\n";
449  }
void edm::InputSource::setLuminosityBlockAuxiliary ( LuminosityBlockAuxiliary lbp)
inlineprotected

Definition at line 358 of file InputSource.h.

References lumiAuxiliary_, and newLumi_.

Referenced by edm::StreamerInputSource::deserializeEvent(), and FedRawDataInputSource::maybeOpenNewLumiSection().

358  {
359  lumiAuxiliary_.reset(lbp);
360  newLumi_ = true;
361  }
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:455
void edm::InputSource::setLuminosityBlockNumber_t ( LuminosityBlockNumber_t  lb)
inline

Set the luminosity block ID.

Definition at line 160 of file InputSource.h.

References setLumi().

160 {setLumi(lb);}
virtual void setLumi(LuminosityBlockNumber_t lb)
Definition: InputSource.cc:444
void edm::InputSource::setNewLumi ( )
inlineprotected
void edm::InputSource::setNewRun ( )
inlineprotected
void InputSource::setRun ( RunNumber_t  r)
privatevirtual

Reimplemented in edm::StreamerInputSource.

Definition at line 436 of file InputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by setRunNumber().

436  {
438  << "InputSource::setRun()\n"
439  << "Run number cannot be modified for this type of Input Source\n"
440  << "Contact a Framework Developer\n";
441  }
void edm::InputSource::setRunAuxiliary ( RunAuxiliary rp)
inlineprotected

Definition at line 354 of file InputSource.h.

References newLumi_, newRun_, and runAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), FedRawDataInputSource::FedRawDataInputSource(), and FedRawDataInputSource::postForkReacquireResources().

354  {
355  runAuxiliary_.reset(rp);
356  newRun_ = newLumi_ = true;
357  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:454
void edm::InputSource::setRunNumber ( RunNumber_t  r)
inline

Set the run number.

Definition at line 157 of file InputSource.h.

References setRun().

157 {setRun(r);}
virtual void setRun(RunNumber_t r)
Definition: InputSource.cc:436
void edm::InputSource::setTimestamp ( Timestamp const &  theTime)
inlineprotected

To set the current time, as seen by the input source.

Definition at line 349 of file InputSource.h.

References time_.

Referenced by edm::ProducerSourceBase::ProducerSourceBase(), edm::RawInputSource::RawInputSource(), and readEvent().

349 {time_ = theTime;}
Timestamp time_
Definition: InputSource.h:449
void InputSource::skip ( int  offset)
protectedvirtual

Reimplemented in edm::ProducerSourceBase, edm::PoolSource, dqmservices::DQMStreamerReader, and edm::StreamerFileReader.

Definition at line 452 of file InputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by rewind(), and skipEvents().

452  {
454  << "InputSource::skip()\n"
455  << "Forking and random access are not implemented for this type of Input Source\n"
456  << "Contact a Framework Developer\n";
457  }
void InputSource::skipEvents ( int  offset)

Skip the number of events specified. Offset may be negative.

Definition at line 385 of file InputSource.cc.

References hltrates_dqm_sourceclient-live_cfg::offset, and skip().

Referenced by nextItemType_(), and skipForForking().

385  {
386  callWithTryCatchAndPrint<void>( [this,&offset](){ skip(offset); }, "Calling InputSource::skip" );
387  }
virtual void skip(int offset)
Definition: InputSource.cc:452
bool InputSource::skipForForking ( )

Skips the correct number of events if this is a forked process returns false if we are out of events

Definition at line 147 of file InputSource.cc.

References decreaseRemainingEventsBy(), eventLimitReached(), numberOfEventsBeforeBigSkip_, or, receiver_, remainingEvents(), remainingLuminosityBlocks(), and skipEvents().

147  {
148  if(eventLimitReached()) {
149  return false;
150  }
152  receiver_->receive();
153  unsigned long toSkip = receiver_->numberToSkip();
154  if(0 != toSkip) {
155  skipEvents(toSkip);
157  }
158  numberOfEventsBeforeBigSkip_ = receiver_->numberOfConsecutiveIndices();
160  return false;
161  }
162  }
163  return true;
164  }
void decreaseRemainingEventsBy(int iSkipped)
Definition: InputSource.cc:477
The Signals That Services Can Subscribe To This is based on ActivityRegistry and is current per Services can connect to the signals distributed by the ActivityRegistry in order to monitor the activity of the application Each possible callback has some defined which we here list in angle e< void, edm::EventIDconst &, edm::Timestampconst & > We also list in braces which AR_WATCH_USING_METHOD_ is used for those or
Definition: Activities.doc:12
unsigned int numberOfEventsBeforeBigSkip_
Definition: InputSource.h:460
int remainingEvents() const
Definition: InputSource.h:198
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:459
bool eventLimitReached() const
Definition: InputSource.h:393
void skipEvents(int offset)
Definition: InputSource.cc:385
int remainingLuminosityBlocks() const
Definition: InputSource.h:206
ItemType edm::InputSource::state ( ) const
inlineprotected
std::shared_ptr<ThinnedAssociationsHelper> edm::InputSource::thinnedAssociationsHelper ( ) const
inline

Accessor for thinnedAssociationsHelper.

Definition at line 181 of file InputSource.h.

References thinnedAssociationsHelper_.

Referenced by edm::StreamerInputSource::deserializeAndMergeWithRegistry(), and edm::RootInputFileSequence::initFile().

std::shared_ptr< ThinnedAssociationsHelper > thinnedAssociationsHelper_
Definition: InputSource.h:446
Timestamp const& edm::InputSource::timestamp ( ) const
inline

Accessor for the current time, as seen by the input source.

Definition at line 243 of file InputSource.h.

References time_.

243 {return time_;}
Timestamp time_
Definition: InputSource.h:449

Member Data Documentation

std::shared_ptr<ActivityRegistry> edm::InputSource::actReg_
private

Definition at line 433 of file InputSource.h.

Referenced by actReg().

std::shared_ptr<BranchIDListHelper> edm::InputSource::branchIDListHelper_
private

Definition at line 445 of file InputSource.h.

Referenced by branchIDListHelper().

bool edm::InputSource::eventCached_
private

Definition at line 452 of file InputSource.h.

Referenced by eventCached(), resetEventCached(), and setEventCached().

std::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::lumiAuxiliary_
mutableprivate
int edm::InputSource::maxEvents_
private

Definition at line 434 of file InputSource.h.

Referenced by maxEvents(), repeat(), and rewind().

int edm::InputSource::maxLumis_
private

Definition at line 436 of file InputSource.h.

Referenced by maxLuminosityBlocks(), and repeat().

int edm::InputSource::maxSecondsUntilRampdown_
private

Definition at line 439 of file InputSource.h.

Referenced by InputSource(), and lumiLimitReached().

ModuleDescription const edm::InputSource::moduleDescription_
private

Definition at line 442 of file InputSource.h.

Referenced by moduleDescription().

bool edm::InputSource::newLumi_
mutableprivate
bool edm::InputSource::newRun_
mutableprivate

Definition at line 450 of file InputSource.h.

Referenced by newRun(), resetNewRun(), resetRunAuxiliary(), setNewRun(), and setRunAuxiliary().

unsigned int edm::InputSource::numberOfEventsBeforeBigSkip_
private

Definition at line 460 of file InputSource.h.

Referenced by postForkReacquireResources(), readEvent(), and skipForForking().

bool const edm::InputSource::primary_
private

Definition at line 447 of file InputSource.h.

Referenced by InputSource(), and primary().

std::string edm::InputSource::processGUID_
private

Definition at line 448 of file InputSource.h.

Referenced by processGUID().

std::unique_ptr<ProcessHistoryRegistry> edm::InputSource::processHistoryRegistry_
private
ProcessingMode edm::InputSource::processingMode_
private

Definition at line 441 of file InputSource.h.

Referenced by InputSource(), and processingMode().

std::chrono::time_point<std::chrono::steady_clock> edm::InputSource::processingStart_
private

Definition at line 440 of file InputSource.h.

Referenced by InputSource(), and lumiLimitReached().

std::shared_ptr<ProductRegistry> edm::InputSource::productRegistry_
private

Definition at line 443 of file InputSource.h.

Referenced by productRegistry(), and productRegistryUpdate().

int edm::InputSource::readCount_
private

Definition at line 438 of file InputSource.h.

Referenced by issueReports(), and readEvent().

std::shared_ptr<edm::multicore::MessageReceiverForSource> edm::InputSource::receiver_
private

Definition at line 459 of file InputSource.h.

Referenced by postForkReacquireResources(), readEvent(), rewind(), and skipForForking().

int edm::InputSource::remainingEvents_
private
int edm::InputSource::remainingLumis_
private
std::shared_ptr<RunAuxiliary> edm::InputSource::runAuxiliary_
mutableprivate

Definition at line 454 of file InputSource.h.

Referenced by nextItemType(), resetRunAuxiliary(), runAuxiliary(), and setRunAuxiliary().

ItemType edm::InputSource::state_
mutableprivate

Definition at line 453 of file InputSource.h.

Referenced by nextItemType(), readEvent(), readFile(), reset(), rewind(), and state().

std::string edm::InputSource::statusFileName_
private

Definition at line 456 of file InputSource.h.

Referenced by InputSource(), and issueReports().

std::shared_ptr<ThinnedAssociationsHelper> edm::InputSource::thinnedAssociationsHelper_
private

Definition at line 446 of file InputSource.h.

Referenced by thinnedAssociationsHelper().

Timestamp edm::InputSource::time_
private

Definition at line 449 of file InputSource.h.

Referenced by doEndLumi(), doEndRun(), setTimestamp(), and timestamp().