CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
edmtest::SourceWithWaits Class Reference
Inheritance diagram for edmtest::SourceWithWaits:
edm::InputSource

Public Member Functions

 SourceWithWaits (edm::ParameterSet const &, edm::InputSourceDescription const &)
 
 ~SourceWithWaits () override
 
- Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistryactReg () const
 Accessor for Activity Registry. More...
 
std::shared_ptr< BranchIDListHelper const > branchIDListHelper () const
 Accessors for branchIDListHelper. More...
 
std::shared_ptr< BranchIDListHelper > & branchIDListHelper ()
 
void closeFile (FileBlock *, bool cleaningUpAfterException)
 close current file More...
 
void doBeginJob ()
 Called by framework at beginning of job. More...
 
virtual void doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
 Called by framework at beginning of lumi block. More...
 
virtual void doBeginRun (RunPrincipal &rp, ProcessContext const *)
 Called by framework at beginning of run. More...
 
void doEndJob ()
 Called by framework at end of job. More...
 
void fillProcessBlockHelper ()
 Fill the ProcessBlockHelper with info for the current file. More...
 
ProcessingController::ForwardState forwardState () const
 
bool goToEvent (EventID const &eventID)
 
 InputSource (ParameterSet const &, InputSourceDescription const &)
 Constructor. More...
 
 InputSource (InputSource const &)=delete
 
void issueReports (EventID const &eventID, StreamID streamID)
 issue an event report More...
 
LuminosityBlockNumber_t luminosityBlock () const
 Accessor for current luminosity block number. More...
 
std::shared_ptr< LuminosityBlockAuxiliaryluminosityBlockAuxiliary () const
 Called by the framework to merge or insert lumi in principal cache. More...
 
int maxEvents () const
 
int maxLuminosityBlocks () const
 
ModuleDescription const & moduleDescription () const
 Accessor for 'module' description. More...
 
ItemTypeInfo nextItemType ()
 Advances the source to the next item. More...
 
bool nextProcessBlock (ProcessBlockPrincipal &)
 Next process block, return false if there is none, sets the processName in the principal. More...
 
InputSourceoperator= (InputSource const &)=delete
 
std::shared_ptr< ProcessBlockHelper const > processBlockHelper () const
 Accessors for processBlockHelper. More...
 
std::shared_ptr< ProcessBlockHelper > & processBlockHelper ()
 
ProcessConfiguration const & processConfiguration () const
 Accessor for Process Configuration. More...
 
std::string const & processGUID () const
 Accessor for global process identifier. More...
 
ProcessHistoryRegistry const & processHistoryRegistry () const
 Accessors for process history registry. More...
 
ProcessHistoryRegistryprocessHistoryRegistry ()
 
ProcessingMode processingMode () const
 RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
 
std::shared_ptr< ProductRegistry const > productRegistry () const
 Accessors for product registry. More...
 
bool randomAccess () const
 
void readAndMergeLumi (LuminosityBlockPrincipal &lbp)
 Read next luminosity block (same as a prior lumi) More...
 
void readAndMergeRun (RunPrincipal &rp)
 Read next run (same as a prior run) More...
 
void readEvent (EventPrincipal &ep, StreamContext &)
 Read next event. More...
 
bool readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
 Read a specific event. More...
 
std::shared_ptr< FileBlockreadFile ()
 Read next file. More...
 
void readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
 Read next luminosity block (new lumi) More...
 
std::shared_ptr< LuminosityBlockAuxiliaryreadLuminosityBlockAuxiliary ()
 Read next luminosity block Auxilary. More...
 
void readProcessBlock (ProcessBlockPrincipal &)
 Read next process block. More...
 
void readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
 Read next run (new run) More...
 
std::shared_ptr< RunAuxiliaryreadRunAuxiliary ()
 Read next run Auxiliary. More...
 
ProcessHistoryID const & reducedProcessHistoryID () const
 
virtual void registerProducts ()
 Register any produced products. More...
 
int remainingEvents () const
 
int remainingLuminosityBlocks () const
 
void repeat ()
 Reset the remaining number of events/lumis to the maximum number. More...
 
std::pair< SharedResourcesAcquirer *, std::recursive_mutex * > resourceSharedWithDelayedReader ()
 Returns nullptr if no resource shared between the Source and a DelayedReader. More...
 
ProcessingController::ReverseState reverseState () const
 
void rewind ()
 Begin again at the first event. More...
 
RunNumber_t run () const
 Accessor for current run number. More...
 
std::shared_ptr< 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)
 
void switchTo (std::shared_ptr< ProductRegistry > iOther)
 switch to a different ProductRegistry. More...
 
std::shared_ptr< ThinnedAssociationsHelper const > thinnedAssociationsHelper () const
 Accessors for thinnedAssociationsHelper. More...
 
std::shared_ptr< ThinnedAssociationsHelper > & thinnedAssociationsHelper ()
 
Timestamp const & timestamp () const
 Accessor for the current time, as seen by the input source. More...
 
virtual ~InputSource () noexcept(false)
 Destructor. More...
 

Static Public Member Functions

static void fillDescriptions (edm::ConfigurationDescriptions &)
 
- Static Public Member Functions inherited from edm::InputSource
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc)
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 

Private Member Functions

edm::InputSource::ItemTypeInfo getNextItemType () override
 
void readEvent_ (edm::EventPrincipal &) override
 
std::shared_ptr< edm::LuminosityBlockAuxiliaryreadLuminosityBlockAuxiliary_ () override
 
std::shared_ptr< edm::RunAuxiliaryreadRunAuxiliary_ () override
 

Private Attributes

edm::EventNumber_t currentEvent_ = 0
 
unsigned int currentFile_ = 0
 
edm::LuminosityBlockNumber_t currentLumi_ = 0
 
edm::RunNumber_t currentRun_ = 0
 
bool declareAllLast_
 
bool declareLast_
 
unsigned int eventInCurrentLumi_ = 0
 
std::vector< unsigned int > eventsPerLumi_
 
bool lastEventOfLumi_ = false
 
unsigned int lumiInCurrentRun_ = 0
 
unsigned int lumisPerRun_
 
unsigned int multipleEntriesForLumi_
 
unsigned int multipleEntriesForRun_
 
bool noEventsInLumi_ = false
 
double sleepAfterStartOfRun_
 
bool startedNewRun_ = false
 
double timePerLumi_
 

Additional Inherited Members

- Public Types inherited from edm::InputSource
enum  ItemPosition : char { ItemPosition::Invalid, ItemPosition::LastItemToBeMerged, ItemPosition::NotLastItemToBeMerged }
 
enum  ItemType : char {
  ItemType::IsInvalid, ItemType::IsStop, ItemType::IsFile, ItemType::IsRun,
  ItemType::IsLumi, ItemType::IsEvent, ItemType::IsRepeat, ItemType::IsSynchronize
}
 
enum  ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
 
- Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)> postEventReadFromSourceSignal_
 
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)> preEventReadFromSourceSignal_
 
- Protected Member Functions inherited from edm::InputSource
virtual void beginJob ()
 Begin protected makes it easier to do template programming. More...
 
void decreaseRemainingEventsBy (int iSkipped)
 
bool eventCached () const
 
bool newLumi () const
 
bool newRun () const
 
ProcessHistoryRegistryprocessHistoryRegistryForUpdate ()
 
ProductRegistryproductRegistryUpdate ()
 
void reset () const
 
void resetEventCached ()
 
void resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
 
void resetNewLumi ()
 
void resetNewRun ()
 
void resetRunAuxiliary (bool isNewRun=true) const
 
void setEventCached ()
 Called by the framework to merge or ached() const {return eventCached_;}. More...
 
void setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
 
void setNewLumi ()
 
void setNewRun ()
 
void setRunAuxiliary (RunAuxiliary *rp)
 
void setTimestamp (Timestamp const &theTime)
 To set the current time, as seen by the input source. More...
 
virtual void skip (int offset)
 
ItemTypeInfo state () const
 

Detailed Description

Definition at line 59 of file SourceWithWaits.cc.

Constructor & Destructor Documentation

◆ SourceWithWaits()

edmtest::SourceWithWaits::SourceWithWaits ( edm::ParameterSet const &  pset,
edm::InputSourceDescription const &  desc 
)
explicit

Definition at line 91 of file SourceWithWaits.cc.

93  timePerLumi_(pset.getUntrackedParameter<double>("timePerLumi")),
94  sleepAfterStartOfRun_(pset.getUntrackedParameter<double>("sleepAfterStartOfRun")),
95  eventsPerLumi_(pset.getUntrackedParameter<std::vector<unsigned int>>("eventsPerLumi")),
96  lumisPerRun_(pset.getUntrackedParameter<unsigned int>("lumisPerRun")),
97  multipleEntriesForRun_(pset.getUntrackedParameter<unsigned int>("multipleEntriesForRun")),
98  multipleEntriesForLumi_(pset.getUntrackedParameter<unsigned int>("multipleEntriesForLumi")),
99  declareLast_(pset.getUntrackedParameter<bool>("declareLast")),
100  declareAllLast_(pset.getUntrackedParameter<bool>("declareAllLast")) {}
unsigned int multipleEntriesForLumi_
unsigned int multipleEntriesForRun_
std::vector< unsigned int > eventsPerLumi_

◆ ~SourceWithWaits()

edmtest::SourceWithWaits::~SourceWithWaits ( )
override

Definition at line 102 of file SourceWithWaits.cc.

102 {}

Member Function Documentation

◆ fillDescriptions()

void edmtest::SourceWithWaits::fillDescriptions ( edm::ConfigurationDescriptions descriptions)
static

Definition at line 104 of file SourceWithWaits.cc.

References edm::ConfigurationDescriptions::add(), and submitPVResolutionJobs::desc.

104  {
106  desc.addUntracked<double>("timePerLumi");
107  desc.addUntracked<double>("sleepAfterStartOfRun");
108  desc.addUntracked<std::vector<unsigned int>>("eventsPerLumi");
109  desc.addUntracked<unsigned int>("lumisPerRun");
110  desc.addUntracked<unsigned int>("multipleEntriesForRun", 0);
111  desc.addUntracked<unsigned int>("multipleEntriesForLumi", 0);
112  desc.addUntracked<bool>("declareLast", false);
113  desc.addUntracked<bool>("declareAllLast", false);
114  descriptions.add("source", desc);
115  }
void add(std::string const &label, ParameterSetDescription const &psetDescription)

◆ getNextItemType()

edm::InputSource::ItemTypeInfo edmtest::SourceWithWaits::getNextItemType ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 117 of file SourceWithWaits.cc.

References cms::cuda::assert(), ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), currentEvent_, currentFile_, currentLumi_, currentRun_, declareAllLast_, declareLast_, eventInCurrentLumi_, eventsPerLumi_, edm::InputSource::IsEvent, edm::InputSource::IsFile, edm::InputSource::IsLumi, edm::InputSource::IsRun, edm::InputSource::IsStop, lastEventOfLumi_, edm::InputSource::LastItemToBeMerged, lumiInCurrentRun_, lumisPerRun_, multipleEntriesForLumi_, multipleEntriesForRun_, noEventsInLumi_, edm::InputSource::NotLastItemToBeMerged, position, sleepAfterStartOfRun_, startedNewRun_, and timePerLumi_.

117  {
118  constexpr unsigned int secondsToMicroseconds = 1000000;
119 
120  if (startedNewRun_) {
121  usleep(secondsToMicroseconds * sleepAfterStartOfRun_);
122  startedNewRun_ = false;
123  }
124 
126  usleep(secondsToMicroseconds * timePerLumi_ / (eventsPerLumi_[currentLumi_ - 1] + 1));
127  lastEventOfLumi_ = false;
128  noEventsInLumi_ = false;
129  }
130 
131  // First three cases are for the initial file, run, and lumi transitions
132  // Note that there will always be at exactly one file and at least
133  // one run from this test source.
134  if (currentFile_ == 0u) {
135  ++currentFile_;
136  return ItemType::IsFile;
137  }
138  // First Run
139  else if (currentRun_ == 0u) {
140  ++currentRun_;
142  startedNewRun_ = true;
143  auto const position =
145  return ItemTypeInfo(ItemType::IsRun, position);
146  } else {
147  // declareAllLast_ with multipleEntriesForRun_ or multipleEntriesForLumi_ is an intentional bug, used to test
148  // if the Framework detects the potential InputSource bug and throws an exception.
150  return ItemTypeInfo(ItemType::IsRun, position);
151  }
152  }
153  // If configured, a second Entry for the same run number and reduced ProcessHistoryID
154  else if (currentRun_ == multipleEntriesForRun_) {
156  startedNewRun_ = true;
157  auto const position =
159  return ItemTypeInfo(ItemType::IsRun, position);
160  }
161  // First lumi
162  else if (currentLumi_ == 0u && lumisPerRun_ != 0) {
163  ++currentLumi_;
165  // The job will stop when we hit the end of the eventsPerLumi vector
166  // unless maxEvents stopped it earlier.
167  if ((currentLumi_ - 1) >= eventsPerLumi_.size()) {
168  return ItemType::IsStop;
169  }
171  if (eventsPerLumi_[currentLumi_ - 1] == 0) {
172  noEventsInLumi_ = true;
173  }
174  auto const position =
176  return ItemTypeInfo(ItemType::IsLumi, position);
177  } else {
178  // declareAllLast_ with multipleEntriesForRun_ or multipleEntriesForLumi_ is an intentional bug, used to test
179  // if the Framework detects the potential InputSource bug and throws an exception.
181  return ItemTypeInfo(ItemType::IsLumi, position);
182  }
183  }
184  // If configured, a second Entry for the same lumi number in the same run
185  else if (currentLumi_ == multipleEntriesForLumi_ && lumisPerRun_ != 0) {
187  if (eventsPerLumi_[currentLumi_ - 1] == 0) {
188  noEventsInLumi_ = true;
189  }
190  auto const position =
192  return ItemTypeInfo(ItemType::IsLumi, position);
193  }
194  // Handle events in the current lumi
196  // note the argument to usleep is microseconds, timePerLumi_ is in seconds
197  usleep(secondsToMicroseconds * timePerLumi_ / (eventsPerLumi_[currentLumi_ - 1] + 1));
199  ++currentEvent_;
201  lastEventOfLumi_ = true;
202  }
203  return ItemType::IsEvent;
204  }
205  // Next lumi
206  else if (lumiInCurrentRun_ < lumisPerRun_) {
207  ++currentLumi_;
209  // The job will stop when we hit the end of the eventsPerLumi vector
210  // unless maxEvents stopped it earlier.
211  if ((currentLumi_ - 1) >= eventsPerLumi_.size()) {
212  return ItemType::IsStop;
213  }
216  if (eventsPerLumi_[currentLumi_ - 1] == 0) {
217  noEventsInLumi_ = true;
218  }
219  auto const position =
221  return ItemTypeInfo(ItemType::IsLumi, position);
222  } else {
223  // declareAllLast_ with multipleEntriesForRun_ or multipleEntriesForLumi_ is an intentional bug, used to test
224  // if the Framework detects the potential InputSource bug and throws an exception.
226  return ItemTypeInfo(ItemType::IsLumi, position);
227  }
228  }
229  // Next run
230  else {
231  // The job will stop when we hit the end of the eventsPerLumi vector
232  // unless maxEvents stopped it earlier. Don't start the run if
233  // it will end with no lumis in it.
234  if (currentLumi_ >= eventsPerLumi_.size()) {
235  return ItemType::IsStop;
236  }
237  ++currentRun_;
238  // Avoid infinite job if lumisPerRun_ is 0
239  if (currentRun_ > 100) {
240  return ItemType::IsStop;
241  }
242  lumiInCurrentRun_ = 0;
244  startedNewRun_ = true;
245  auto const position =
247  return ItemTypeInfo(ItemType::IsRun, position);
248  } else {
249  // declareAllLast_ with multipleEntriesForRun_ or multipleEntriesForLumi_ is an intentional bug, used to test
250  // if the Framework detects the potential InputSource bug and throws an exception.
252  return ItemTypeInfo(ItemType::IsRun, position);
253  }
254  }
255  // Should be impossible to get here
256  assert(false);
257  // return something so it will compile
258  return ItemType::IsStop;
259  }
unsigned int multipleEntriesForLumi_
unsigned int eventInCurrentLumi_
unsigned int multipleEntriesForRun_
assert(be >=bs)
std::vector< unsigned int > eventsPerLumi_
edm::RunNumber_t currentRun_
edm::LuminosityBlockNumber_t currentLumi_
edm::EventNumber_t currentEvent_
static int position[264][3]
Definition: ReadPGInfo.cc:289

◆ readEvent_()

void edmtest::SourceWithWaits::readEvent_ ( edm::EventPrincipal eventPrincipal)
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 272 of file SourceWithWaits.cc.

References printConversionInfo::aux, currentEvent_, currentLumi_, currentRun_, edm::EventPrincipal::fillEventPrincipal(), edm::ProcessHistoryRegistry::getMapped(), edm::InputSource::processGUID(), and edm::InputSource::processHistoryRegistry().

272  {
273  bool isRealData = false;
276  auto history = processHistoryRegistry().getMapped(aux.processHistoryID());
277  eventPrincipal.fillEventPrincipal(aux, history);
278  }
edm::RunNumber_t currentRun_
std::string const & processGUID() const
Accessor for global process identifier.
Definition: InputSource.h:226
ProcessHistoryRegistry const & processHistoryRegistry() const
Accessors for process history registry.
Definition: InputSource.h:168
bool getMapped(ProcessHistoryID const &key, ProcessHistory &value) const
void fillEventPrincipal(EventAuxiliary const &aux, ProcessHistory const *processHistory, DelayedReader *reader=nullptr)
edm::LuminosityBlockNumber_t currentLumi_
edm::EventNumber_t currentEvent_

◆ readLuminosityBlockAuxiliary_()

std::shared_ptr< edm::LuminosityBlockAuxiliary > edmtest::SourceWithWaits::readLuminosityBlockAuxiliary_ ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 266 of file SourceWithWaits.cc.

References currentLumi_, currentRun_, and edm::Timestamp::invalidTimestamp().

266  {
268  return std::make_shared<edm::LuminosityBlockAuxiliary>(
270  }
static Timestamp invalidTimestamp()
Definition: Timestamp.h:75
edm::RunNumber_t currentRun_
edm::LuminosityBlockNumber_t currentLumi_

◆ readRunAuxiliary_()

std::shared_ptr< edm::RunAuxiliary > edmtest::SourceWithWaits::readRunAuxiliary_ ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 261 of file SourceWithWaits.cc.

References currentRun_, and edm::Timestamp::invalidTimestamp().

261  {
263  return std::make_shared<edm::RunAuxiliary>(currentRun_, ts, edm::Timestamp::invalidTimestamp());
264  }
static Timestamp invalidTimestamp()
Definition: Timestamp.h:75
edm::RunNumber_t currentRun_

Member Data Documentation

◆ currentEvent_

edm::EventNumber_t edmtest::SourceWithWaits::currentEvent_ = 0
private

Definition at line 80 of file SourceWithWaits.cc.

Referenced by getNextItemType(), and readEvent_().

◆ currentFile_

unsigned int edmtest::SourceWithWaits::currentFile_ = 0
private

Definition at line 83 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ currentLumi_

edm::LuminosityBlockNumber_t edmtest::SourceWithWaits::currentLumi_ = 0
private

Definition at line 81 of file SourceWithWaits.cc.

Referenced by getNextItemType(), readEvent_(), and readLuminosityBlockAuxiliary_().

◆ currentRun_

edm::RunNumber_t edmtest::SourceWithWaits::currentRun_ = 0
private

◆ declareAllLast_

bool edmtest::SourceWithWaits::declareAllLast_
private

Definition at line 78 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ declareLast_

bool edmtest::SourceWithWaits::declareLast_
private

Definition at line 77 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ eventInCurrentLumi_

unsigned int edmtest::SourceWithWaits::eventInCurrentLumi_ = 0
private

Definition at line 84 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ eventsPerLumi_

std::vector<unsigned int> edmtest::SourceWithWaits::eventsPerLumi_
private

Definition at line 73 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ lastEventOfLumi_

bool edmtest::SourceWithWaits::lastEventOfLumi_ = false
private

Definition at line 87 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ lumiInCurrentRun_

unsigned int edmtest::SourceWithWaits::lumiInCurrentRun_ = 0
private

Definition at line 85 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ lumisPerRun_

unsigned int edmtest::SourceWithWaits::lumisPerRun_
private

Definition at line 74 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ multipleEntriesForLumi_

unsigned int edmtest::SourceWithWaits::multipleEntriesForLumi_
private

Definition at line 76 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ multipleEntriesForRun_

unsigned int edmtest::SourceWithWaits::multipleEntriesForRun_
private

Definition at line 75 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ noEventsInLumi_

bool edmtest::SourceWithWaits::noEventsInLumi_ = false
private

Definition at line 88 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ sleepAfterStartOfRun_

double edmtest::SourceWithWaits::sleepAfterStartOfRun_
private

Definition at line 72 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ startedNewRun_

bool edmtest::SourceWithWaits::startedNewRun_ = false
private

Definition at line 86 of file SourceWithWaits.cc.

Referenced by getNextItemType().

◆ timePerLumi_

double edmtest::SourceWithWaits::timePerLumi_
private

Definition at line 71 of file SourceWithWaits.cc.

Referenced by getNextItemType().