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 ()
 
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_
 
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 75 of file InputSource.h.

Member Typedef Documentation

Definition at line 94 of file InputSource.h.

Member Enumeration Documentation

Enumerator
IsInvalid 
IsStop 
IsFile 
IsRun 
IsLumi 
IsEvent 
IsRepeat 
IsSynchronize 

Definition at line 77 of file InputSource.h.

Enumerator
Runs 
RunsAndLumis 
RunsLumisAndEvents 

Definition at line 88 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 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  primary_(pset.getParameter<std::string>("@module_label") == std::string("@main_input")),
68  time_(),
69  newRun_(true),
70  newLumi_(true),
71  eventCached_(false),
73  runAuxiliary_(),
76  receiver_(),
78 
79  if(pset.getUntrackedParameter<bool>("writeStatusFile", false)) {
80  std::ostringstream statusfilename;
81  statusfilename << "source_" << getpid();
82  statusFileName_ = statusfilename.str();
83  }
84  if (maxSecondsUntilRampdown_ > 0) {
86  }
87 
88  // Secondary input sources currently do not have a product registry.
89  if(primary_) {
90  assert(desc.productRegistry_ != 0);
91  }
92  std::string const defaultMode("RunsLumisAndEvents");
93  std::string const runMode("Runs");
94  std::string const runLumiMode("RunsAndLumis");
95 
96  // The default value provided as the second argument to the getUntrackedParameter function call
97  // is not used when the ParameterSet has been validated and the parameters are not optional
98  // in the description. As soon as all primary input sources and all modules with a secondary
99  // input sources have defined descriptions, the defaults in the getUntrackedParameterSet function
100  // calls can and should be deleted from the code.
101  std::string processingMode = pset.getUntrackedParameter<std::string>("processingMode", defaultMode);
102  if(processingMode == runMode) {
104  } else if(processingMode == runLumiMode) {
106  } else if(processingMode != defaultMode) {
108  << "InputSource::InputSource()\n"
109  << "The 'processingMode' parameter for sources has an illegal value '" << processingMode << "'\n"
110  << "Legal values are '" << defaultMode << "', '" << runLumiMode << "', or '" << runMode << "'.\n";
111  }
112  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:449
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:450
Timestamp time_
Definition: InputSource.h:444
std::string statusFileName_
Definition: InputSource.h:451
std::shared_ptr< BranchIDListHelper > branchIDListHelper_
Definition: InputSource.h:441
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:253
std::chrono::time_point< std::chrono::steady_clock > processingStart_
Definition: InputSource.h:436
unsigned int numberOfEventsBeforeBigSkip_
Definition: InputSource.h:455
ProcessingMode processingMode_
Definition: InputSource.h:437
int maxSecondsUntilRampdown_
Definition: InputSource.h:435
std::shared_ptr< ActivityRegistry > actReg_
Definition: InputSource.h:429
std::shared_ptr< ProductRegistry > productRegistry_
Definition: InputSource.h:439
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:454
std::string processGUID_
Definition: InputSource.h:443
std::unique_ptr< ProcessHistoryRegistry > processHistoryRegistry_
Definition: InputSource.h:440
bool const primary_
Definition: InputSource.h:442
ModuleDescription const moduleDescription_
Definition: InputSource.h:438
std::string createGlobalIdentifier()
InputSource::~InputSource ( )
virtual

Destructor.

Definition at line 114 of file InputSource.cc.

114 {}
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 256 of file InputSource.h.

References actReg_.

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

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

Definition at line 131 of file InputSource.cc.

References edm::kBaseType().

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

Reimplemented in edm::ProducerSourceBase.

Definition at line 561 of file InputSource.cc.

Referenced by doBeginJob().

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

Reimplemented in edm::ProducerSourceBase, and FRDStreamSource.

Definition at line 549 of file InputSource.cc.

Referenced by doBeginLumi().

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

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

Definition at line 555 of file InputSource.cc.

Referenced by doBeginRun().

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

Accessor for branchIDListHelper.

Definition at line 177 of file InputSource.h.

References branchIDListHelper_.

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

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

close current file

Definition at line 284 of file InputSource.cc.

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

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

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

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

Definition at line 408 of file InputSource.h.

Referenced by closeFile().

408 {}
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 476 of file InputSource.cc.

References remainingEvents_.

Referenced by rewind(), and skipForForking().

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

Called by framework at beginning of job.

Definition at line 248 of file InputSource.cc.

References beginJob().

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

Called by framework at beginning of lumi block.

Definition at line 504 of file InputSource.cc.

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

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

Called by framework at beginning of run.

Definition at line 488 of file InputSource.cc.

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

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

Called by framework at end of job.

Definition at line 253 of file InputSource.cc.

References endJob().

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

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

Called by framework at end of lumi block.

Definition at line 511 of file InputSource.cc.

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

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

Called by framework at end of run.

Definition at line 495 of file InputSource.cc.

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

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

Definition at line 525 of file InputSource.cc.

References postForkReacquireResources().

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

Called by the framework before forking the process.

Definition at line 520 of file InputSource.cc.

References preForkReleaseResources().

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

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

Definition at line 564 of file InputSource.cc.

Referenced by doEndJob().

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

Reimplemented in edm::ProducerSourceBase, and FRDStreamSource.

Definition at line 552 of file InputSource.cc.

Referenced by doEndLumi().

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

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

Definition at line 558 of file InputSource.cc.

Referenced by doEndRun().

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

Definition at line 389 of file InputSource.h.

References remainingEvents_.

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

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

Definition at line 136 of file InputSource.cc.

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

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

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

Definition at line 117 of file InputSource.cc.

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

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

Definition at line 537 of file InputSource.cc.

References forwardState_().

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

Definition at line 389 of file InputSource.cc.

References goToEvent_().

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

Reimplemented in edm::PoolSource.

Definition at line 459 of file InputSource.cc.

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

Referenced by goToEvent().

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

issue an event report

Definition at line 409 of file InputSource.cc.

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

Referenced by readEvent().

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

Definition at line 398 of file InputSource.h.

References eventLimitReached(), and lumiLimitReached().

Referenced by readEvent(), and readFile().

398 {return eventLimitReached() || lumiLimitReached();}
bool lumiLimitReached() const
Definition: InputSource.h:390
bool eventLimitReached() const
Definition: InputSource.h:389
bool edm::InputSource::lumiLimitReached ( ) const
inlineprivate

Definition at line 390 of file InputSource.h.

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

Referenced by limitReached(), and nextItemType().

390  {
391  if (remainingLumis_ == 0) {return true;}
392  if (maxSecondsUntilRampdown_ <= 0) {return false;}
394  auto elapsed = end - processingStart_;
395  if (std::chrono::duration_cast<std::chrono::seconds>(elapsed).count() > maxSecondsUntilRampdown_) {return true;}
396  return false;
397  }
std::chrono::time_point< std::chrono::steady_clock > processingStart_
Definition: InputSource.h:436
int maxSecondsUntilRampdown_
Definition: InputSource.h:435
#define end
Definition: vmac.h:37
LuminosityBlockNumber_t InputSource::luminosityBlock ( ) const

Accessor for current luminosity block number.

Definition at line 605 of file InputSource.cc.

References luminosityBlockAuxiliary().

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

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

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

Definition at line 262 of file InputSource.h.

References lumiAuxiliary_.

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

262 {return lumiAuxiliary_;}
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:450
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 190 of file InputSource.h.

References maxEvents_.

190 {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 198 of file InputSource.h.

References maxLumis_.

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

Accessor for 'module' description.

Definition at line 205 of file InputSource.h.

References moduleDescription_.

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

205 {return moduleDescription_;}
ModuleDescription const moduleDescription_
Definition: InputSource.h:438
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 189 of file InputSource.cc.

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

189  {
191  if(eventLimitReached()) {
192  // If the maximum event limit has been reached, stop.
193  state_ = IsStop;
194  } else if(lumiLimitReached()) {
195  // If the maximum lumi limit has been reached, stop
196  // when reaching a new file, run, or lumi.
197  if(oldState == IsInvalid || oldState == IsFile || oldState == IsRun || processingMode() != RunsLumisAndEvents) {
198  state_ = IsStop;
199  } else {
200  ItemType newState = nextItemType_();
201  if(newState == IsEvent) {
202  assert (processingMode() == RunsLumisAndEvents);
203  state_ = IsEvent;
204  } else {
205  state_ = IsStop;
206  }
207  }
208  } else {
209  ItemType newState = nextItemType_();
210  if(newState == IsStop) {
211  state_ = IsStop;
212  } else if(newState == IsSynchronize) {
214  } else if(newState == IsFile || oldState == IsInvalid) {
215  state_ = IsFile;
216  } else if(newState == IsRun || oldState == IsFile) {
218  state_ = IsRun;
219  } else if(newState == IsLumi || oldState == IsRun) {
220  assert (processingMode() != Runs);
222  state_ = IsLumi;
223  } else {
224  assert (processingMode() == RunsLumisAndEvents);
225  state_ = IsEvent;
226  }
227  }
228  if(state_ == IsStop) {
229  lumiAuxiliary_.reset();
230  runAuxiliary_.reset();
231  }
232  return state_;
233  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:449
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:450
std::shared_ptr< RunAuxiliary > readRunAuxiliary()
Read next run Auxiliary.
Definition: InputSource.cc:242
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:253
bool lumiLimitReached() const
Definition: InputSource.h:390
std::shared_ptr< LuminosityBlockAuxiliary > readLuminosityBlockAuxiliary()
Read next luminosity block Auxilary.
Definition: InputSource.cc:236
bool eventLimitReached() const
Definition: InputSource.h:389
ItemType nextItemType_()
Definition: InputSource.cc:174
InputSource::ItemType InputSource::nextItemType_ ( )
private

Definition at line 174 of file InputSource.cc.

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

Referenced by nextItemType().

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

Definition at line 570 of file InputSource.cc.

References numberOfEventsBeforeBigSkip_, receiver_, and rewind().

Referenced by doPostForkReacquireResources().

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

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

Definition at line 567 of file InputSource.cc.

Referenced by doPreForkReleaseResources().

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

Definition at line 124 of file InputSource.cc.

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

Accessor for primary input source flag.

Definition at line 211 of file InputSource.h.

References primary_.

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

Accessor for Process Configuration.

Definition at line 208 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:205
ProcessConfiguration const & processConfiguration() const
std::string const& edm::InputSource::processGUID ( ) const
inline

Accessor for global process identifier.

Definition at line 214 of file InputSource.h.

References processGUID_.

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

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

Const accessor for process history registry.

Definition at line 171 of file InputSource.h.

References processHistoryRegistry_.

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

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

Definition at line 348 of file InputSource.h.

References processHistoryRegistry_.

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

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

Accessor for product registry.

Definition at line 168 of file InputSource.h.

References productRegistry_.

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

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

Definition at line 531 of file InputSource.cc.

References randomAccess_().

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

Reimplemented in edm::PoolSource.

Definition at line 578 of file InputSource.cc.

Referenced by randomAccess().

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

Read next luminosity block (same as a prior lumi)

Definition at line 322 of file InputSource.cc.

References readLuminosityBlock_(), and remainingLumis_.

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

Read next run (same as a prior run)

Definition at line 307 of file InputSource.cc.

References readRun_().

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

Read next event.

Definition at line 344 of file InputSource.cc.

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

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

Read a specific event.

Definition at line 364 of file InputSource.cc.

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

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

Read next file.

Definition at line 276 of file InputSource.cc.

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

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

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

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

Definition at line 296 of file InputSource.cc.

Referenced by readFile().

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

Reimplemented in edm::PoolSource.

Definition at line 427 of file InputSource.cc.

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

Referenced by readEvent().

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

Read next luminosity block (new lumi)

Definition at line 313 of file InputSource.cc.

References readLuminosityBlock_(), and remainingLumis_.

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

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

Definition at line 339 of file InputSource.cc.

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

Referenced by readAndMergeLumi(), and readLuminosityBlock().

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

Read next luminosity block Auxilary.

Definition at line 236 of file InputSource.cc.

References readLuminosityBlockAuxiliary_().

Referenced by nextItemType().

236  {
237  return callWithTryCatchAndPrint<std::shared_ptr<LuminosityBlockAuxiliary> >( [this](){ return readLuminosityBlockAuxiliary_(); },
238  "Calling InputSource::readLuminosityBlockAuxiliary_" );
239  }
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 301 of file InputSource.cc.

References readRun_(), and runPrincipal().

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

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

Definition at line 331 of file InputSource.cc.

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

Referenced by readAndMergeRun(), and readRun().

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

Read next run Auxiliary.

Definition at line 242 of file InputSource.cc.

References readRunAuxiliary_().

Referenced by nextItemType().

242  {
243  return callWithTryCatchAndPrint<std::shared_ptr<RunAuxiliary> >( [this](){ return readRunAuxiliary_(); },
244  "Calling InputSource::readRunAuxiliary_" );
245  }
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 593 of file InputSource.cc.

References processHistoryRegistry_, and runAuxiliary().

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

Register any produced products.

Definition at line 268 of file InputSource.cc.

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

268  {
269  if(!typeLabelList().empty()) {
271  }
272  }
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:347
#define begin
Definition: vmac.h:30
ModuleDescription const & moduleDescription() const
Accessor for &#39;module&#39; description.
Definition: InputSource.h:205
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 194 of file InputSource.h.

References remainingEvents_.

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

194 {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 202 of file InputSource.h.

References remainingLumis_.

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

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

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

Definition at line 180 of file InputSource.h.

References maxEvents_, maxLumis_, remainingEvents_, and remainingLumis_.

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

Definition at line 366 of file InputSource.h.

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

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

366  {
369  state_ = IsInvalid;
370  }
void resetRunAuxiliary(bool isNewRun=true) const
Definition: InputSource.h:358
void resetLuminosityBlockAuxiliary(bool isNewLumi=true) const
Definition: InputSource.h:362
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 375 of file InputSource.h.

References newRun_.

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

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

Definition at line 358 of file InputSource.h.

References newLumi_, newRun_, and runAuxiliary_.

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

358  {
359  runAuxiliary_.reset();
360  newRun_ = newLumi_ = isNewRun;
361  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:449
SharedResourcesAcquirer * InputSource::resourceSharedWithDelayedReader ( ) const

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

Definition at line 258 of file InputSource.cc.

References resourceSharedWithDelayedReader_().

258  {
260  }
virtual SharedResourcesAcquirer * resourceSharedWithDelayedReader_() const
Definition: InputSource.cc:263
SharedResourcesAcquirer * InputSource::resourceSharedWithDelayedReader_ ( ) const
privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 263 of file InputSource.cc.

Referenced by resourceSharedWithDelayedReader().

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

Definition at line 543 of file InputSource.cc.

References reverseState_().

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

Begin again at the first event.

Definition at line 394 of file InputSource.cc.

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

Referenced by postForkReacquireResources().

394  {
395  state_ = IsInvalid;
397  setNewRun();
398  setNewLumi();
400  callWithTryCatchAndPrint<void>( [this](){ rewind_(); }, "Calling InputSource::rewind_" );
401  if(receiver_) {
402  unsigned int numberToSkip = receiver_->numberToSkip();
403  skip(numberToSkip);
404  decreaseRemainingEventsBy(numberToSkip);
405  }
406  }
void decreaseRemainingEventsBy(int iSkipped)
Definition: InputSource.cc:476
virtual void rewind_()
Definition: InputSource.cc:468
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:454
void resetEventCached()
Definition: InputSource.h:382
virtual void skip(int offset)
Definition: InputSource.cc:451
void InputSource::rewind_ ( )
privatevirtual

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

Definition at line 468 of file InputSource.cc.

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

Referenced by rewind().

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

Accessor for current run number.

Definition at line 599 of file InputSource.cc.

References runAuxiliary().

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

599  {
600  assert(runAuxiliary());
601  return runAuxiliary()->run();
602  }
std::shared_ptr< RunAuxiliary > runAuxiliary() const
Called by the framework to merge or insert run in principal cache.
Definition: InputSource.h:259
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 381 of file InputSource.h.

References eventCached_.

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

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

Definition at line 443 of file InputSource.cc.

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

Referenced by setLuminosityBlockNumber_t().

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

Definition at line 354 of file InputSource.h.

References lumiAuxiliary_, and newLumi_.

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

354  {
355  lumiAuxiliary_.reset(lbp);
356  newLumi_ = true;
357  }
std::shared_ptr< LuminosityBlockAuxiliary > lumiAuxiliary_
Definition: InputSource.h:450
void edm::InputSource::setLuminosityBlockNumber_t ( LuminosityBlockNumber_t  lb)
inline

Set the luminosity block ID.

Definition at line 159 of file InputSource.h.

References setLumi().

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

Reimplemented in edm::StreamerInputSource.

Definition at line 435 of file InputSource.cc.

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

Referenced by setRunNumber().

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

Definition at line 350 of file InputSource.h.

References newLumi_, newRun_, and runAuxiliary_.

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

350  {
351  runAuxiliary_.reset(rp);
352  newRun_ = newLumi_ = true;
353  }
std::shared_ptr< RunAuxiliary > runAuxiliary_
Definition: InputSource.h:449
void edm::InputSource::setRunNumber ( RunNumber_t  r)
inline

Set the run number.

Definition at line 156 of file InputSource.h.

References setRun().

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

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

Definition at line 345 of file InputSource.h.

References time_.

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

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

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

Definition at line 451 of file InputSource.cc.

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

Referenced by rewind(), and skipEvents().

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

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

Definition at line 384 of file InputSource.cc.

References evf::evtn::offset(), and skip().

Referenced by nextItemType_(), and skipForForking().

384  {
385  callWithTryCatchAndPrint<void>( [this,&offset](){ skip(offset); }, "Calling InputSource::skip" );
386  }
unsigned int offset(bool)
virtual void skip(int offset)
Definition: InputSource.cc:451
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 146 of file InputSource.cc.

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

146  {
147  if(eventLimitReached()) {
148  return false;
149  }
151  receiver_->receive();
152  unsigned long toSkip = receiver_->numberToSkip();
153  if(0 != toSkip) {
154  skipEvents(toSkip);
156  }
157  numberOfEventsBeforeBigSkip_ = receiver_->numberOfConsecutiveIndices();
159  return false;
160  }
161  }
162  return true;
163  }
void decreaseRemainingEventsBy(int iSkipped)
Definition: InputSource.cc:476
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:455
int remainingEvents() const
Definition: InputSource.h:194
std::shared_ptr< edm::multicore::MessageReceiverForSource > receiver_
Definition: InputSource.h:454
bool eventLimitReached() const
Definition: InputSource.h:389
void skipEvents(int offset)
Definition: InputSource.cc:384
int remainingLuminosityBlocks() const
Definition: InputSource.h:202
ItemType edm::InputSource::state ( ) const
inlineprotected
Timestamp const& edm::InputSource::timestamp ( ) const
inline

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

Definition at line 239 of file InputSource.h.

References time_.

239 {return time_;}
Timestamp time_
Definition: InputSource.h:444

Member Data Documentation

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

Definition at line 429 of file InputSource.h.

Referenced by actReg().

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

Definition at line 441 of file InputSource.h.

Referenced by branchIDListHelper().

bool edm::InputSource::eventCached_
private

Definition at line 447 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 430 of file InputSource.h.

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

int edm::InputSource::maxLumis_
private

Definition at line 432 of file InputSource.h.

Referenced by maxLuminosityBlocks(), and repeat().

int edm::InputSource::maxSecondsUntilRampdown_
private

Definition at line 435 of file InputSource.h.

Referenced by InputSource(), and lumiLimitReached().

ModuleDescription const edm::InputSource::moduleDescription_
private

Definition at line 438 of file InputSource.h.

Referenced by moduleDescription().

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

Definition at line 445 of file InputSource.h.

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

unsigned int edm::InputSource::numberOfEventsBeforeBigSkip_
private

Definition at line 455 of file InputSource.h.

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

bool const edm::InputSource::primary_
private

Definition at line 442 of file InputSource.h.

Referenced by InputSource(), and primary().

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

Definition at line 443 of file InputSource.h.

Referenced by processGUID().

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

Definition at line 437 of file InputSource.h.

Referenced by InputSource(), and processingMode().

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

Definition at line 436 of file InputSource.h.

Referenced by InputSource(), and lumiLimitReached().

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

Definition at line 439 of file InputSource.h.

Referenced by productRegistry(), and productRegistryUpdate().

int edm::InputSource::readCount_
private

Definition at line 434 of file InputSource.h.

Referenced by issueReports(), and readEvent().

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

Definition at line 454 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 449 of file InputSource.h.

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

ItemType edm::InputSource::state_
mutableprivate

Definition at line 448 of file InputSource.h.

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

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

Definition at line 451 of file InputSource.h.

Referenced by InputSource(), and issueReports().

Timestamp edm::InputSource::time_
private

Definition at line 444 of file InputSource.h.

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