Inheritance diagram for evf::GlobalEvFOutputModule:

Public Member Functions
	GlobalEvFOutputModule (edm::ParameterSet const &ps)

	~GlobalEvFOutputModule () override

Public Member Functions inherited from edm::global::OutputModule< T >
const OutputModule &	operator= (const OutputModule &)=delete

	OutputModule (edm::ParameterSet const &iPSet)

	OutputModule (const OutputModule &)=delete

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

bool	wantsStreamLuminosityBlocks () const final

bool	wantsStreamRuns () const final

Public Member Functions inherited from edm::global::OutputModuleBase
OutputModuleBase &	operator= (OutputModuleBase const &)=delete

	OutputModuleBase (ParameterSet const &pset)

	OutputModuleBase (OutputModuleBase const &)=delete

bool	wantsGlobalLuminosityBlocks () const

bool	wantsGlobalRuns () const

Public Member Functions inherited from edm::core::OutputModuleCore
BranchIDLists const *	branchIDLists () const

std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const

SelectedProductsForBranchType const &	keptProducts () const

int	maxEvents () const

const ModuleDescription &	moduleDescription () const

OutputModuleCore &	operator= (OutputModuleCore const &)=delete

	OutputModuleCore (ParameterSet const &pset)

	OutputModuleCore (OutputModuleCore const &)=delete

OutputProcessBlockHelper const &	outputProcessBlockHelper () const

std::string const &	processName () const

int	remainingEvents () const

bool	selected (BranchDescription const &desc) const

void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &)

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

	~OutputModuleCore () override

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

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

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

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

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

std::vector < ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const > const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

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

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

static void	fillDescription (ParameterSetDescription &desc, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
void	acquire (edm::StreamID, edm::EventForOutput const &, edm::WaitingTaskWithArenaHolder) const final

std::unique_ptr < edm::StreamerOutputModuleCommon >	beginStream (edm::StreamID) const final

Trig	getTriggerResults (edm::EDGetTokenT< edm::TriggerResults > const &token, edm::EventForOutput const &e) const

std::shared_ptr < GlobalEvFOutputEventWriter >	globalBeginLuminosityBlock (edm::LuminosityBlockForOutput const &iLB) const final

std::shared_ptr < GlobalEvFOutputJSONDef >	globalBeginRun (edm::RunForOutput const &run) const final

void	globalEndLuminosityBlock (edm::LuminosityBlockForOutput const &iLB) const final

void	globalEndRun (edm::RunForOutput const &) const final

void	write (edm::EventForOutput const &e) final

void	writeLuminosityBlock (edm::LuminosityBlockForOutput const &) final

void	writeRun (edm::RunForOutput const &) final

Private Attributes
evf::FastMonitoringService *	fms_

edm::ParameterSet const &	ps_

edm::EDGetTokenT < edm::SendJobHeader::ParameterSetMap >	psetToken_

std::string	streamLabel_

edm::EDGetTokenT < edm::TriggerResults >	trToken_

Additional Inherited Members
Public Types inherited from edm::global::OutputModuleBase
typedef OutputModuleBase	ModuleType

Public Types inherited from edm::core::OutputModuleCore
typedef OutputModuleCore	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::global::OutputModuleBase
void	doAcquire (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const , WaitingTaskWithArenaHolder &)

void	doBeginJob ()

void	doBeginStream (StreamID id)

void	doEndStream (StreamID id)

bool	doEvent (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate (PreallocationConfiguration const &)

void	preActionBeforeRunEventAsync (WaitingTaskHolder iTask, ModuleCallingContext const &iModuleCallingContext, Principal const &iPrincipal) const

Protected Member Functions inherited from edm::core::OutputModuleCore
void	configure (OutputModuleDescription const &desc)

ModuleDescription const &	description () const

void	doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

void	doBeginJob_ ()

bool	doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

void	doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

bool	doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)

void	doEndJob ()

bool	doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

void	doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

bool	doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)

bool	doEvent_ (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate_ (PreallocationConfiguration const &)

std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()

virtual void	preallocLumis (unsigned int)

ParameterSetID	selectorConfig () const

void	setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int >>> const &outputModulePathPositions, bool anyProductProduced)

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

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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)

void	resetItemsToGetFrom (BranchType iType)

Protected Attributes inherited from edm::core::OutputModuleCore
std::atomic< int >	remainingEvents_

Detailed Description

Definition at line 121 of file GlobalEvFOutputModule.cc.

Constructor & Destructor Documentation

evf::GlobalEvFOutputModule::GlobalEvFOutputModule ( edm::ParameterSet const & ps )

explicit

Definition at line 236 of file GlobalEvFOutputModule.cc.

References Exception, fms_, streamLabel_, AlCaHLTBitMon_QueryRunRegistry::string, and to_lower().

       : edm::global::OutputModuleBase(ps),
         GlobalEvFOutputModuleType(ps),
         ps_(ps),
         streamLabel_(ps.getParameter<std::string>("@module_label")),
         trToken_(consumes<edm::TriggerResults>(edm::InputTag("TriggerResults"))),
         psetToken_(consumes<edm::SendJobHeader::ParameterSetMap, edm::InRun>(
             ps.getUntrackedParameter<edm::InputTag>("psetMap"))) {
     //replace hltOutoputA with stream if the HLT menu uses this convention
     std::string testPrefix = "hltOutput";
     if (streamLabel_.find(testPrefix) == 0)
       streamLabel_ = std::string("stream") + streamLabel_.substr(testPrefix.size());
 
     if (streamLabel_.find('_') != std::string::npos) {
       throw cms::Exception("GlobalEvFOutputModule")
           << "Underscore character is reserved can not be used for stream names in "
              "FFF, but was detected in stream name -: "
           << streamLabel_;
     }
 
     std::string streamLabelLow = streamLabel_;
     boost::algorithm::to_lower(streamLabelLow);
     auto streampos = streamLabelLow.rfind("stream");
     if (streampos != 0 && streampos != std::string::npos)
       throw cms::Exception("GlobalEvFOutputModule")
           << "stream (case-insensitive) sequence was found in stream suffix. This is reserved and can not be used for "
              "names in FFF based HLT, but was detected in stream name";
 
     fms_ = (evf::FastMonitoringService*)(edm::Service<evf::MicroStateService>().operator->());
   }

evf::GlobalEvFOutputModule::~GlobalEvFOutputModule ( )

override

Definition at line 267 of file GlobalEvFOutputModule.cc.

267 {}

Member Function Documentation

void evf::GlobalEvFOutputModule::acquire	(	edm::StreamID	id,
		edm::EventForOutput const &	e,
		edm::WaitingTaskWithArenaHolder	iHolder
	)		const

finalprivate

Definition at line 365 of file GlobalEvFOutputModule.cc.

References alignCSCRings::e, edm::EventForOutput::getLuminosityBlock(), getTriggerResults(), edm::LuminosityBlockForOutput::index(), edm::WaitingTaskWithArenaHolder::makeWaitingTaskHolderAndRelease(), eostools::move(), mps_check::msg, edm::core::OutputModuleCore::selectorConfig(), triggerResults, and trToken_.

                                                                                    {
     edm::Handle<edm::TriggerResults> const& triggerResults = getTriggerResults(trToken_, e);
 
     auto streamerCommon = streamCache(id);
     std::unique_ptr<EventMsgBuilder> msg =
         streamerCommon->serializeEvent(*streamerCommon->getSerializerBuffer(), e, triggerResults, selectorConfig());
 
     auto lumiWriter = luminosityBlockCache(e.getLuminosityBlock().index());
     const_cast<evf::GlobalEvFOutputEventWriter*>(lumiWriter)
         ->doOutputEventAsync(std::move(msg), iHolder.makeWaitingTaskHolderAndRelease());
   }

std::unique_ptr< edm::StreamerOutputModuleCommon > evf::GlobalEvFOutputModule::beginStream ( edm::StreamID ) const

finalprivate

Definition at line 278 of file GlobalEvFOutputModule.cc.

References edm::core::OutputModuleCore::description(), edm::InEvent, edm::core::OutputModuleCore::keptProducts(), edm::ModuleDescription::moduleLabel(), and ps_.

                                                                                                    {
     return std::make_unique<edm::StreamerOutputModuleCommon>(
         ps_, &keptProducts()[edm::InEvent], description().moduleLabel());
   }

void evf::GlobalEvFOutputModule::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 269 of file GlobalEvFOutputModule.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), submitPVResolutionJobs::desc, edm::StreamerOutputModuleCommon::fillDescription(), and edm::core::OutputModuleCore::fillDescription().

                                                                                          {
     edm::ParameterSetDescription desc;
     edm::StreamerOutputModuleCommon::fillDescription(desc);
     GlobalEvFOutputModuleType::fillDescription(desc);
     desc.addUntracked<edm::InputTag>("psetMap", {"hltPSetMap"})
         ->setComment("Optionally allow the map of ParameterSets to be calculated externally.");
     descriptions.add("globalEvfOutputModule", desc);
   }

Trig evf::GlobalEvFOutputModule::getTriggerResults	(	edm::EDGetTokenT< edm::TriggerResults > const &	token,
		edm::EventForOutput const &	e
	)		const

private

Definition at line 351 of file GlobalEvFOutputModule.cc.

References edm::OccurrenceForOutput::getByToken(), mps_fire::result, and unpackBuffers-CaloStage2::token.

Referenced by acquire().

                                                                                   {
     Trig result;
     e.getByToken<edm::TriggerResults>(token, result);
     return result;
   }

std::shared_ptr< GlobalEvFOutputEventWriter > evf::GlobalEvFOutputModule::globalBeginLuminosityBlock ( edm::LuminosityBlockForOutput const & iLB ) const

finalprivate

Definition at line 358 of file GlobalEvFOutputModule.cc.

References edm::LuminosityBlockForOutput::luminosityBlock(), and streamLabel_.

                                                     {
     auto openDatFilePath = edm::Service<evf::EvFDaqDirector>()->getOpenDatFilePath(iLB.luminosityBlock(), streamLabel_);
 
     return std::make_shared<GlobalEvFOutputEventWriter>(openDatFilePath);
   }

std::shared_ptr< GlobalEvFOutputJSONDef > evf::GlobalEvFOutputModule::globalBeginRun ( edm::RunForOutput const & run ) const

finalprivate

Definition at line 283 of file GlobalEvFOutputModule.cc.

References cms::Adler32(), StreamerOutputFile::adler32(), edm::core::OutputModuleCore::branchIDLists(), StreamerOutputFile::close(), edm::core::OutputModuleCore::description(), Exception, edm::OccurrenceForOutput::getHandle(), edm::InEvent, edm::Hash< I >::isValid(), edm::core::OutputModuleCore::keptProducts(), LogDebug, edm::ModuleDescription::mainParameterSetID(), edm::core::OutputModuleCore::moduleDescription(), edm::ModuleDescription::moduleLabel(), FSQHLTOfflineSource_cfi::processName, ps_, psetToken_, alcazmumu_cfi::src, edm_modernize_messagelogger::stat, streamLabel_, AlCaHLTBitMon_QueryRunRegistry::string, edm::core::OutputModuleCore::thinnedAssociationsHelper(), and StreamerOutputFile::write().

                                                                                                               {
     //create run Cache holding JSON file writer and variables
     auto jsonDef = std::make_unique<GlobalEvFOutputJSONDef>();
 
     edm::StreamerOutputModuleCommon streamerCommon(ps_, &keptProducts()[edm::InEvent], description().moduleLabel());
 
     //output INI file (non-const). This doesn't require globalBeginRun to be finished
     const std::string openIniFileName = edm::Service<evf::EvFDaqDirector>()->getOpenInitFilePath(streamLabel_);
     edm::LogInfo("GlobalEvFOutputModule") << "beginRun init stream -: " << openIniFileName;
 
     StreamerOutputFile stream_writer_preamble(openIniFileName);
     uint32 preamble_adler32 = 1;
     edm::BranchIDLists const* bidlPtr = branchIDLists();
 
     auto psetMapHandle = run.getHandle(psetToken_);
 
     std::unique_ptr<InitMsgBuilder> init_message =
         streamerCommon.serializeRegistry(*streamerCommon.getSerializerBuffer(),
                                          *bidlPtr,
                                          *thinnedAssociationsHelper(),
                                          OutputModule::processName(),
                                          description().moduleLabel(),
                                          moduleDescription().mainParameterSetID(),
                                          psetMapHandle.isValid() ? psetMapHandle.product() : nullptr);
 
     //Let us turn it into a View
     InitMsgView view(init_message->startAddress());
 
     //output header
     stream_writer_preamble.write(view);
     preamble_adler32 = stream_writer_preamble.adler32();
     stream_writer_preamble.close();
 
     struct stat istat;
     stat(openIniFileName.c_str(), &istat);
     //read back file to check integrity of what was written
     off_t readInput = 0;
     uint32_t adlera = 1, adlerb = 0;
     FILE* src = fopen(openIniFileName.c_str(), "r");
 
     //allocate buffer to write INI file
     std::unique_ptr<unsigned char[]> outBuf = std::make_unique<unsigned char[]>(1024 * 1024);
     while (readInput < istat.st_size) {
       size_t toRead = readInput + 1024 * 1024 < istat.st_size ? 1024 * 1024 : istat.st_size - readInput;
       fread(outBuf.get(), toRead, 1, src);
       cms::Adler32(const_cast<const char*>(reinterpret_cast<char*>(outBuf.get())), toRead, adlera, adlerb);
       readInput += toRead;
     }
     fclose(src);
 
     //clear serialization buffers
     streamerCommon.getSerializerBuffer()->clearHeaderBuffer();
 
     //free output buffer needed only for the file write
     outBuf.reset();
 
     uint32_t adler32c = (adlerb << 16) | adlera;
     if (adler32c != preamble_adler32) {
       throw cms::Exception("GlobalEvFOutputModule") << "Checksum mismatch of ini file -: " << openIniFileName
                                                     << " expected:" << preamble_adler32 << " obtained:" << adler32c;
     } else {
       LogDebug("GlobalEvFOutputModule") << "Ini file checksum -: " << streamLabel_ << " " << adler32c;
       std::filesystem::rename(openIniFileName, edm::Service<evf::EvFDaqDirector>()->getInitFilePath(streamLabel_));
     }
 
     return jsonDef;
   }

void evf::GlobalEvFOutputModule::globalEndLuminosityBlock ( edm::LuminosityBlockForOutput const & iLB ) const

finalprivate

Definition at line 380 of file GlobalEvFOutputModule.cc.

References fms_, evf::FastMonitoringService::getEventsProcessedForLumi(), edm::LuminosityBlockForOutput::getRun(), edm::LuminosityBlockForOutput::index(), edm::RunForOutput::index(), edm::LuminosityBlockForOutput::luminosityBlock(), fed_dqm_sourceclient-live_cfg::path, edm_modernize_messagelogger::stat, streamLabel_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                                    {
     auto lumiWriter = luminosityBlockCache(iLB.index());
     //close dat file
     const_cast<evf::GlobalEvFOutputEventWriter*>(lumiWriter)->close();
 
     //auto jsonWriter = const_cast<GlobalEvFOutputJSONWriter*>(runCache(iLB.getRun().index()));
     auto jsonDef = runCache(iLB.getRun().index());
     GlobalEvFOutputJSONWriter jsonWriter(streamLabel_, jsonDef->outJsonDef_, jsonDef->outJsonDefName_);
 
     jsonWriter.fileAdler32_.value() = lumiWriter->get_adler32();
     jsonWriter.accepted_.value() = lumiWriter->getAccepted();
 
     bool abortFlag = false;
     jsonWriter.processed_.value() = fms_->getEventsProcessedForLumi(iLB.luminosityBlock(), &abortFlag);
     if (abortFlag) {
       edm::LogInfo("GlobalEvFOutputModule") << "Abort flag has been set. Output is suppressed";
       return;
     }
 
     if (jsonWriter.processed_.value() != 0) {
       struct stat istat;
       std::filesystem::path openDatFilePath = lumiWriter->getFilePath();
       stat(openDatFilePath.string().c_str(), &istat);
       jsonWriter.filesize_ = istat.st_size;
       std::filesystem::rename(openDatFilePath.string().c_str(),
                               edm::Service<evf::EvFDaqDirector>()->getDatFilePath(iLB.luminosityBlock(), streamLabel_));
       jsonWriter.filelist_ = openDatFilePath.filename().string();
     } else {
       //remove empty file when no event processing has occurred
       remove(lumiWriter->getFilePath().c_str());
       jsonWriter.filesize_ = 0;
       jsonWriter.filelist_ = "";
       jsonWriter.fileAdler32_.value() = -1;  //no files in signed long
     }
 
     //produce JSON file
     jsonWriter.jsonMonitor_->snap(iLB.luminosityBlock());
     const std::string outputJsonNameStream =
         edm::Service<evf::EvFDaqDirector>()->getOutputJsonFilePath(iLB.luminosityBlock(), streamLabel_);
     jsonWriter.jsonMonitor_->outputFullJSON(outputJsonNameStream, iLB.luminosityBlock());
   }