#include <EvFOutputModule.h>

Inheritance diagram for evf::EvFOutputModule:

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

	~EvFOutputModule () override

Public Member Functions inherited from edm::one::OutputModule< T >
SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

	OutputModule (edm::ParameterSet const &iPSet)

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

Public Member Functions inherited from edm::one::OutputModuleBase
BranchIDLists const *	branchIDLists ()

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

SelectedProductsForBranchType const &	keptProducts () const

int	maxEvents () const

const ModuleDescription &	moduleDescription () const

OutputModuleBase &	operator= (OutputModuleBase const &)=delete

	OutputModuleBase (OutputModuleBase const &)=delete

	OutputModuleBase (ParameterSet const &pset)

std::string const &	processName () const

int	remainingEvents () const

bool	selected (BranchDescription const &desc) const

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

SharedResourcesAcquirer &	sharedResourcesAcquirer ()

SubProcessParentageHelper const *	subProcessParentageHelper () const

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~OutputModuleBase () 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 &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

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::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase &	operator= (EDConsumerBase &&)=default

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

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

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::one::OutputModuleBase
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	beginRun (edm::RunForOutput const &run) override

void	endRun (edm::RunForOutput const &) override

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

std::shared_ptr< EvFOutputEventWriter >	globalBeginLuminosityBlock (edm::LuminosityBlockForOutput const &iLB) const override

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

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

void	writeLuminosityBlock (edm::LuminosityBlockForOutput const &) override

void	writeRun (edm::RunForOutput const &) override

Private Attributes
evf::FastMonitoringService *	fms_

std::unique_ptr< evf::EvFOutputJSONWriter >	jsonWriter_

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::one::OutputModuleBase
typedef OutputModuleBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::one::OutputModuleBase
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
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

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

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

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<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

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

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...

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

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

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

Detailed Description

Definition at line 73 of file EvFOutputModule.h.

Constructor & Destructor Documentation

◆ EvFOutputModule()

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

explicit

Definition at line 107 of file EvFOutputModule.cc.

       : edm::one::OutputModuleBase(ps),
         EvFOutputModuleType(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("EvFOutputModule") << "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("EvFOutputModule")
           << "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->());
   }

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

◆ ~EvFOutputModule()

evf::EvFOutputModule::~EvFOutputModule ( )

override

Definition at line 137 of file EvFOutputModule.cc.

137 {}

Member Function Documentation

◆ beginRun()

void evf::EvFOutputModule::beginRun ( edm::RunForOutput const & run )

overrideprivate

Definition at line 148 of file EvFOutputModule.cc.

                                                            {
     //create run Cache holding JSON file writer and variables
     jsonWriter_ = std::make_unique<EvFOutputJSONWriter>(ps_, &keptProducts()[edm::InEvent], streamLabel_);
  
     //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("EvFOutputModule") << "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 =
         jsonWriter_->streamerCommon_.serializeRegistry(*jsonWriter_->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
     unsigned char* outBuf = new 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, toRead, 1, src);
       cms::Adler32((const char*)outBuf, toRead, adlera, adlerb);
       readInput += toRead;
     }
     fclose(src);
  
     //clear serialization buffers
     jsonWriter_->streamerCommon_.getSerializerBuffer()->clearHeaderBuffer();
  
     //free output buffer needed only for the file write
     delete[] outBuf;
     outBuf = nullptr;
  
     uint32_t adler32c = (adlerb << 16) | adlera;
     if (adler32c != preamble_adler32) {
       throw cms::Exception("EvFOutputModule") << "Checksum mismatch of ini file -: " << openIniFileName
                                               << " expected:" << preamble_adler32 << " obtained:" << adler32c;
     } else {
       LogDebug("EvFOutputModule") << "Ini file checksum -: " << streamLabel_ << " " << adler32c;
       std::filesystem::rename(openIniFileName, edm::Service<evf::EvFDaqDirector>()->getInitFilePath(streamLabel_));
     }
   }

References cms::Adler32(), StreamerOutputFile::adler32(), edm::one::OutputModuleBase::branchIDLists(), StreamerOutputFile::close(), edm::one::OutputModuleBase::description(), Exception, edm::InEvent, edm::Hash< I >::isValid(), jsonWriter_, edm::one::OutputModuleBase::keptProducts(), LogDebug, edm::ModuleDescription::mainParameterSetID(), edm::one::OutputModuleBase::moduleDescription(), edm::ModuleDescription::moduleLabel(), SimL1EmulatorRepack_CalouGT_cff::processName, ps_, psetToken_, writedatasetfile::run, TrackRefitter_38T_cff::src, hgcalPlots::stat, streamLabel_, AlCaHLTBitMon_QueryRunRegistry::string, edm::one::OutputModuleBase::thinnedAssociationsHelper(), and StreamerOutputFile::write().

◆ endRun()

void evf::EvFOutputModule::endRun ( edm::RunForOutput const & )

inlineoverrideprivate

Definition at line 86 of file EvFOutputModule.h.

86 {}

◆ fillDescriptions()

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

static

Definition at line 139 of file EvFOutputModule.cc.

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

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, edm::StreamerOutputModuleCommon::fillDescription(), and edm::one::OutputModuleBase::fillDescription().

◆ getTriggerResults()

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

private

Definition at line 213 of file EvFOutputModule.cc.

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

References MillePedeFileConverter_cfg::e, mps_fire::result, and unpackBuffers-CaloStage2::token.

Referenced by write().

◆ globalBeginLuminosityBlock()

std::shared_ptr< EvFOutputEventWriter > evf::EvFOutputModule::globalBeginLuminosityBlock ( edm::LuminosityBlockForOutput const & iLB ) const

overrideprivate

Definition at line 220 of file EvFOutputModule.cc.

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

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

◆ globalEndLuminosityBlock()

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

overrideprivate

Definition at line 238 of file EvFOutputModule.cc.

                                                                                        {
     auto lumiWriter = luminosityBlockCache(iLB.index());
     //close dat file
     lumiWriter->close();
  
     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("EvFOutputModule") << "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());
   }

References fms_, evf::FastMonitoringService::getEventsProcessedForLumi(), edm::LuminosityBlockForOutput::index(), jsonWriter_, edm::LuminosityBlockForOutput::luminosityBlock(), castor_dqm_sourceclient_file_cfg::path, MatrixUtil::remove(), hgcalPlots::stat, streamLabel_, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ write()

void evf::EvFOutputModule::write ( edm::EventForOutput const & e )

overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 227 of file EvFOutputModule.cc.

                                                         {
     edm::Handle<edm::TriggerResults> const& triggerResults = getTriggerResults(trToken_, e);
  
     //auto lumiWriter = const_cast<EvFOutputEventWriter*>(luminosityBlockCache(e.getLuminosityBlock().index() ));
     auto lumiWriter = luminosityBlockCache(e.getLuminosityBlock().index());
     std::unique_ptr<EventMsgBuilder> msg = jsonWriter_->streamerCommon_.serializeEvent(
         *jsonWriter_->streamerCommon_.getSerializerBuffer(), e, triggerResults, selectorConfig());
     lumiWriter->incAccepted();
     lumiWriter->doOutputEvent(*msg);  //msg is written and discarded at this point
   }

References MillePedeFileConverter_cfg::e, getTriggerResults(), jsonWriter_, mps_check::msg, edm::one::OutputModuleBase::selectorConfig(), triggerResults, and trToken_.

Referenced by pkg.AbstractPkg::generate().

◆ writeLuminosityBlock()

void evf::EvFOutputModule::writeLuminosityBlock ( edm::LuminosityBlockForOutput const & )

inlineoverrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 84 of file EvFOutputModule.h.

84 {}

◆ writeRun()

void evf::EvFOutputModule::writeRun ( edm::RunForOutput const & )

inlineoverrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 85 of file EvFOutputModule.h.

85 {}

Member Data Documentation

◆ fms_

evf::FastMonitoringService* evf::EvFOutputModule::fms_

private

Definition at line 99 of file EvFOutputModule.h.

Referenced by EvFOutputModule(), and globalEndLuminosityBlock().

◆ jsonWriter_

std::unique_ptr<evf::EvFOutputJSONWriter> evf::EvFOutputModule::jsonWriter_

private

Definition at line 101 of file EvFOutputModule.h.

Referenced by beginRun(), globalEndLuminosityBlock(), and write().

◆ ps_

edm::ParameterSet const& evf::EvFOutputModule::ps_

private

Definition at line 94 of file EvFOutputModule.h.

Referenced by beginRun().

◆ psetToken_

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

private

Definition at line 97 of file EvFOutputModule.h.

Referenced by beginRun().

◆ streamLabel_

std::string evf::EvFOutputModule::streamLabel_

private

Definition at line 95 of file EvFOutputModule.h.

Referenced by beginRun(), EvFOutputModule(), globalBeginLuminosityBlock(), and globalEndLuminosityBlock().

◆ trToken_

edm::EDGetTokenT<edm::TriggerResults> evf::EvFOutputModule::trToken_

private

Definition at line 96 of file EvFOutputModule.h.

Referenced by write().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EvFOutputModule()

◆ ~EvFOutputModule()

Member Function Documentation

◆ beginRun()

◆ endRun()

◆ fillDescriptions()

◆ getTriggerResults()

◆ globalBeginLuminosityBlock()

◆ globalEndLuminosityBlock()

◆ write()

◆ writeLuminosityBlock()

◆ writeRun()

Member Data Documentation

◆ fms_

◆ jsonWriter_

◆ ps_

◆ psetToken_

◆ streamLabel_

◆ trToken_