#include <FWCore/Modules/src/MulticoreRunLumiEventChecker.cc>

Inheritance diagram for MulticoreRunLumiEventChecker:

Public Member Functions
	MulticoreRunLumiEventChecker (edm::ParameterSet const &)

	~MulticoreRunLumiEventChecker ()

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

	EDAnalyzer ()

ModuleDescription const &	moduleDescription () const

std::string	workerType () const

virtual	~EDAnalyzer ()

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

	EDConsumerBase ()

ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

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

Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
virtual void	analyze (edm::Event const &, edm::EventSetup const &) override

virtual void	beginJob () override

virtual void	beginLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &es) override

virtual void	beginRun (edm::Run const &run, edm::EventSetup const &es) override

void	check (edm::EventID const &iID, bool isEvent)

virtual void	endJob () override

virtual void	endLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &es) override

virtual void	endRun (edm::Run const &run, edm::EventSetup const &es) override

virtual void	postForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren) override

virtual void	preForkReleaseResources () override

Private Attributes
std::vector< edm::EventID >	ids_

unsigned int	index_

edm::propagate_const < std::shared_ptr < boost::thread > >	listenerThread_

int	messageQueue_

unsigned int	multiProcessSequentialEvents_

bool	mustSearch_

unsigned int	numberOfEventsLeftBeforeSearch_

std::map< edm::EventID, unsigned int >	seenIDs_

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Description: Checks that the events passed to it come in the order specified in its configuration

Implementation: <Notes on="" implementation>="">

Definition at line 52 of file MulticoreRunLumiEventChecker.cc.

Constructor & Destructor Documentation

MulticoreRunLumiEventChecker::MulticoreRunLumiEventChecker ( edm::ParameterSet const & iConfig )

explicit

Definition at line 97 of file MulticoreRunLumiEventChecker.cc.

                                                                                          :
   ids_(iConfig.getUntrackedParameter<std::vector<edm::EventID> >("eventSequence")),
   index_(0),
   multiProcessSequentialEvents_(iConfig.getUntrackedParameter<unsigned int>("multiProcessSequentialEvents")),
   numberOfEventsLeftBeforeSearch_(0),
   mustSearch_(false),
   messageQueue_(-1)
 {
    //now do what ever initialization is needed
 }

MulticoreRunLumiEventChecker::~MulticoreRunLumiEventChecker ( )

Definition at line 109 of file MulticoreRunLumiEventChecker.cc.

                                                             {
    // do anything here that needs to be done at desctruction time
    // (e.g. close files, deallocate resources etc.)
 }

Member Function Documentation

void MulticoreRunLumiEventChecker::analyze	(	edm::Event const &	iEvent,
		edm::EventSetup const &
	)

overrideprivatevirtual

Implements edm::EDAnalyzer.

Definition at line 211 of file MulticoreRunLumiEventChecker.cc.

References check(), and edm::EventBase::id().

                                                                                   {
    check(iEvent.id(), true);
 }

void MulticoreRunLumiEventChecker::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 237 of file MulticoreRunLumiEventChecker.cc.

237 {

238 }

void MulticoreRunLumiEventChecker::beginLuminosityBlock	(	edm::LuminosityBlock const &	lumi,
		edm::EventSetup const &	es
	)

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 225 of file MulticoreRunLumiEventChecker.cc.

References check(), edm::LuminosityBlockBase::id(), edm::LuminosityBlockID::luminosityBlock(), and edm::LuminosityBlockID::run().

                                                                                                        {
    check(edm::EventID(lumi.id().run(), lumi.id().luminosityBlock(), 0), false);   
 }

void MulticoreRunLumiEventChecker::beginRun	(	edm::Run const &	run,
		edm::EventSetup const &	es
	)

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 216 of file MulticoreRunLumiEventChecker.cc.

References check(), edm::RunBase::id(), and edm::RunID::run().

                                                                               {
    check(edm::EventID(run.id().run(), 0, 0), false);   
 }

void MulticoreRunLumiEventChecker::check	(	edm::EventID const &	iID,
		bool	isEvent
	)

private

Definition at line 174 of file MulticoreRunLumiEventChecker.cc.

References Exception, spr::find(), ids_, index_, messageQueue_, multiProcessSequentialEvents_, mustSearch_, numberOfEventsLeftBeforeSearch_, and relativeConstraints::value.

Referenced by analyze(), beginLuminosityBlock(), beginRun(), endLuminosityBlock(), and endRun().

                                                                              {
    if(mustSearch_) { 
       if(0 == numberOfEventsLeftBeforeSearch_) {
          if(iIsEvent) {
             numberOfEventsLeftBeforeSearch_ = multiProcessSequentialEvents_;
          }
          //the event must be after the last event in our list since multicore doesn't go backwards
          //std::vector<edm::EventID>::iterator itFind= std::find_if(ids_.begin() + index_, ids_.end(), CompareWithoutLumi(iEventID));
          std::vector<edm::EventID>::iterator itFind= std::find(ids_.begin() + index_, ids_.end(), iEventID);
          if(itFind == ids_.end()) {
             throw cms::Exception("MissedEvent") << "The event " << iEventID << "is not in the list.\n";
          }
          index_ = itFind-ids_.begin();
       } 
       if(iIsEvent) {
          --numberOfEventsLeftBeforeSearch_;
       }
       MsgToListener sndmsg;
       sndmsg.id = iEventID;
       errno = 0;
       int value = msgsnd(messageQueue_, &sndmsg, MsgToListener::sizeForBuffer(), 0);
       if(value != 0) {
          throw cms::Exception("MessageFailure") << "Failed to send EventID message " << strerror(errno);
       }
    }
    
    if(index_ >= ids_.size()) {
       throw cms::Exception("TooManyEvents") << "Was passes " << ids_.size() << " EventIDs but have processed more events than that\n";
    }
    if(iEventID  != ids_[index_]) {
       throw cms::Exception("WrongEvent") << "Was expecting event " << ids_[index_] << " but was given " << iEventID << "\n";
    }
    ++index_;
 }

void MulticoreRunLumiEventChecker::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 242 of file MulticoreRunLumiEventChecker.cc.

References Exception, ids_, index_, listenerThread_, messageQueue_, mustSearch_, seenIDs_, and relativeConstraints::value.

                                      {
    if(mustSearch_) {
       MsgToListener sndmsg;
       sndmsg.id = edm::EventID();
       errno = 0;
       int value = msgsnd(messageQueue_,&sndmsg, MsgToListener::sizeForBuffer(),0);
       if(value != 0) {
         throw cms::Exception("MessageFailure")<<"Failed to send finished message "<<strerror(errno)<<"\n";
       }
    } else {
      if(index_ != ids_.size()) {
          throw cms::Exception("WrongNumberOfEvents")<<"Saw "<<index_<<" events but was supposed to see "<<ids_.size()<<"\n";
      }
    }
    
    if(listenerThread_) {
       listenerThread_->join();
       msgctl(messageQueue_, IPC_RMID, 0);
       
       std::set<edm::EventID> uniqueIDs(ids_.begin(), ids_.end());
       if(seenIDs_.size() != uniqueIDs.size()) {
          throw cms::Exception("WrongNumberOfEvents") << "Saw " << seenIDs_.size() << " events but was supposed to see " << ids_.size() << "\n";
       }
       
       std::set<edm::EventID> duplicates;
       for(std::map<edm::EventID, unsigned int>::iterator it = seenIDs_.begin(), itEnd = seenIDs_.end();
           it != itEnd;
           ++it) {
          if(it->second > 1 && it->first.event() != 0) {
             duplicates.insert(it->first);
          }
       }
       if(duplicates.size() != 0) {
          throw cms::Exception("DuplicateEvents") << "saw " << duplicates.size() << " events\n";
       }
    }
 }

void MulticoreRunLumiEventChecker::endLuminosityBlock	(	edm::LuminosityBlock const &	lumi,
		edm::EventSetup const &	es
	)

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 230 of file MulticoreRunLumiEventChecker.cc.

References check(), edm::LuminosityBlockBase::id(), edm::LuminosityBlockID::luminosityBlock(), and edm::LuminosityBlockID::run().

                                                                                                      {
    check(edm::EventID(lumi.id().run(), lumi.id().luminosityBlock(), 0), false);   
 }

void MulticoreRunLumiEventChecker::endRun	(	edm::Run const &	run,
		edm::EventSetup const &	es
	)

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 220 of file MulticoreRunLumiEventChecker.cc.

References check(), edm::RunBase::id(), and edm::RunID::run().

                                                                             {
    check(edm::EventID(run.id().run(), 0, 0), false);   
 }

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

static

Definition at line 282 of file MulticoreRunLumiEventChecker.cc.

References edm::ConfigurationDescriptions::add(), and edm::ParameterSetDescription::addUntracked().

                                                                                          {
   edm::ParameterSetDescription desc;
   desc.addUntracked<std::vector<edm::EventID> >("eventSequence");
   desc.addUntracked<unsigned int>("multiProcessSequentialEvents", 0U);
   descriptions.add("eventIDChecker", desc);
 }

void MulticoreRunLumiEventChecker::postForkReacquireResources	(	unsigned int	iChildIndex,
		unsigned int	iNumberOfChildren
	)

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 299 of file MulticoreRunLumiEventChecker.cc.

References edm::disableAllSigs(), listenerThread_, messageQueue_, mustSearch_, edm::reenableSigs(), and seenIDs_.

                                                                                                                  {
    mustSearch_ = true;
    
    if(0 == iChildIndex) {
       //NOTE: must temporarily disable signals so the new thread never tries to process a signal
       sigset_t oldset;
       edm::disableAllSigs(&oldset);
       
       Listener listener(&seenIDs_, messageQueue_, iNumberOfChildren);
       listenerThread_ = std::make_shared<boost::thread>(listener) ;
       edm::reenableSigs(&oldset);
    }
 }

void MulticoreRunLumiEventChecker::preForkReleaseResources ( )

overrideprivatevirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 290 of file MulticoreRunLumiEventChecker.cc.

References Exception, and messageQueue_.

                                                       {
   //This queue is used to communicate between children
   messageQueue_ = msgget(IPC_PRIVATE, IPC_CREAT|0660);
   if(-1 == messageQueue_) {
     throw cms::Exception("FailedToCreateQueue")<<" call to 'msgget' failed to create a message queue. errno: "<<errno<<" "<<strerror(errno);
   }
 }