#include <FRDOutputModule.h>

Inheritance diagram for FRDOutputModule:

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

	~FRDOutputModule () override

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

SerialTaskQueue *	globalRunsQueue () final

const OutputModule &	operator= (const OutputModule &)=delete

	OutputModule (edm::ParameterSet const &iPSet)

	OutputModule (const OutputModule &)=delete

bool	wantsGlobalLuminosityBlocks () const noexcept final

bool	wantsGlobalRuns () const noexcept final

bool	wantsInputProcessBlocks () const noexcept final

bool	wantsProcessBlocks () const noexcept final

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

	OutputModuleBase (ParameterSet const &pset)

	OutputModuleBase (OutputModuleBase const &)=delete

SharedResourcesAcquirer &	sharedResourcesAcquirer ()

SubProcessParentageHelper const *	subProcessParentageHelper () const

bool	wantsStreamLuminosityBlocks () const noexcept

bool	wantsStreamRuns () const noexcept

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

void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

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

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

std::vector< ESResolverIndex > 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

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

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

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

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices 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
uint32_t	adler32 () const

void	beginLuminosityBlock (edm::LuminosityBlockForOutput const &) override

void	endLuminosityBlock (edm::LuminosityBlockForOutput const &) override

void	finishFileWrite (unsigned int run, int ls)

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

void	writeLuminosityBlock (const edm::LuminosityBlockForOutput &) override

void	writeRun (const edm::RunForOutput &) override

Private Attributes
uint32_t	adlera_

uint32_t	adlerb_

std::string	fileName_

std::string	filePrefix_

bool	fileWritten_ = false

const uint32_t	frdFileVersion_

const uint32_t	frdVersion_

int	outfd_ = -1

uint32_t	perFileEventCount_

uint64_t	perFileSize_

const edm::EDGetTokenT< FEDRawDataCollection >	token_

Additional Inherited Members
Public Types inherited from edm::one::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::one::OutputModuleBase
void	configure (OutputModuleDescription const &desc)

void	doBeginJob ()

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

void	doPreallocate (PreallocationConfiguration 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 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 ()

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

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 15 of file FRDOutputModule.h.

Constructor & Destructor Documentation

◆ FRDOutputModule()

FRDOutputModule::FRDOutputModule ( edm::ParameterSet const & ps )

explicit

Definition at line 27 of file FRDOutputModule.cc.

     : edm::one::OutputModuleBase::OutputModuleBase(ps),
       edm::one::OutputModule<edm::one::WatchLuminosityBlocks>(ps),
       token_(consumes<FEDRawDataCollection>(ps.getParameter<edm::InputTag>("source"))),
       frdVersion_(ps.getUntrackedParameter<unsigned int>("frdVersion")),
       frdFileVersion_(ps.getUntrackedParameter<unsigned int>("frdFileVersion")),
       filePrefix_(ps.getUntrackedParameter<std::string>("filePrefix")),
       fileName_(ps.getUntrackedParameter<std::string>("fileName")) {}

◆ ~FRDOutputModule()

FRDOutputModule::~FRDOutputModule ( )

override

Definition at line 36 of file FRDOutputModule.cc.

36 {}

Member Function Documentation

◆ adler32()

uint32_t FRDOutputModule::adler32 ( ) const

inlineprivate

Definition at line 33 of file FRDOutputModule.h.

References adlera_, and adlerb_.

33 { return (adlerb_ << 16) | adlera_; }

FRDOutputModule::adlerb_

uint32_t adlerb_

Definition: FRDOutputModule.h:44

FRDOutputModule::adlera_

uint32_t adlera_

Definition: FRDOutputModule.h:43

◆ beginLuminosityBlock()

void FRDOutputModule::beginLuminosityBlock ( edm::LuminosityBlockForOutput const & lumiBlock )

overrideprivate

Definition at line 135 of file FRDOutputModule.cc.

References adlera_, adlerb_, Exception, MillePedeFileConverter_cfg::fileName, fileName_, filePrefix_, fileWritten_, finishFileWrite(), frdFileVersion_, edm::LuminosityBlockForOutput::id(), eostools::ls(), edm::LuminosityBlockID::luminosityBlock(), outfd_, perFileEventCount_, perFileSize_, edm::LuminosityBlockForOutput::run(), contentValuesCheck::ss, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                        {
   int ls = lumiBlock.id().luminosityBlock();
 
   if (outfd_ != -1)
     finishFileWrite(lumiBlock.run(), ls);
 
   if (fileWritten_)
     throw cms::Exception("RawEventFileWriterForBU", "beginLuminosityBlock")
         << "Multiple lumisections not supported in the same FRD file!";
 
   std::string fileName;
   if (fileName_.empty()) {
     std::stringstream ss;
     ss << (filePrefix_.empty() ? "" : filePrefix_ + "_") << "run" << std::setfill('0') << std::setw(6)
        << lumiBlock.run() << "_ls" << std::setfill('0') << std::setw(4) << ls << "_index000000.raw";
     fileName = ss.str();
   } else {
     //use exact filename (will be overwritten by last LS content if input contains multiple lumisections)
     fileName = fileName_;
   }
 
   outfd_ = open(fileName.c_str(), O_WRONLY | O_CREAT, S_IRWXU | S_IRWXG | S_IRWXO);
   ftruncate(outfd_, 0);
 
   if (outfd_ < 0) {  //attention here... it may happen that outfd_ is *not* set (e.g. missing initialize call...)
     throw cms::Exception("RawEventFileWriterForBU", "beginLuminosityBlock")
         << "Error opening FED Raw Data event output file: " << fileName << ": " << strerror(errno) << "\n";
   }
   edm::LogInfo("RawEventFileWriterForBU") << " Opened " << fileName;
 
   perFileEventCount_ = 0;
   perFileSize_ = 0;
 
   adlera_ = 1;
   adlerb_ = 0;
 
   if (frdFileVersion_ == 1) {
     //reserve space for file header
     ftruncate(outfd_, sizeof(FRDFileHeader_v1));
     lseek(outfd_, sizeof(FRDFileHeader_v1), SEEK_SET);
     perFileSize_ = sizeof(FRDFileHeader_v1);
   } else if (frdFileVersion_ == 2) {
     ftruncate(outfd_, sizeof(FRDFileHeader_v2));
     lseek(outfd_, sizeof(FRDFileHeader_v2), SEEK_SET);
     perFileSize_ = sizeof(FRDFileHeader_v2);
   } else
     throw cms::Exception("RawEventFileWriterForBU", "beginLuminosityBlock")
         << "Unsupported FRD version " << frdFileVersion_;
 }

◆ endLuminosityBlock()

void FRDOutputModule::endLuminosityBlock ( edm::LuminosityBlockForOutput const & lumiBlock )

overrideprivate

Definition at line 185 of file FRDOutputModule.cc.

References finishFileWrite(), edm::LuminosityBlockForOutput::id(), edm::LuminosityBlockID::luminosityBlock(), and edm::LuminosityBlockForOutput::run().

                                                                                      {
   finishFileWrite(lumiBlock.run(), lumiBlock.id().luminosityBlock());
 }

◆ fillDescriptions()

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

static

Definition at line 38 of file FRDOutputModule.cc.

References edm::ConfigurationDescriptions::addWithDefaultLabel(), submitPVResolutionJobs::desc, ProducerED_cfi::InputTag, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                  {
   edm::ParameterSetDescription desc;
   desc.add<edm::InputTag>("source", edm::InputTag("rawDataCollector"));
   desc.addUntracked<unsigned int>("frdFileVersion", 1), desc.addUntracked<unsigned int>("frdVersion", 6);
   desc.addUntracked<std::string>("filePrefix", "");
   desc.addUntracked<std::string>("fileName", "");
   descriptions.addWithDefaultLabel(desc);
 }

◆ finishFileWrite()

void FRDOutputModule::finishFileWrite	(	unsigned int	run,
		int	ls
	)

private

Definition at line 189 of file FRDOutputModule.cc.

References fileName_, fileWritten_, frdFileVersion_, eostools::ls(), outfd_, perFileEventCount_, perFileSize_, writedatasetfile::run, and write().

Referenced by beginLuminosityBlock(), and endLuminosityBlock().

                                                               {
   if (outfd_ == -1)
     return;
 
   if (frdFileVersion_ == 1) {
     //rewind
     lseek(outfd_, 0, SEEK_SET);
     FRDFileHeader_v1 frdFileHeader(perFileEventCount_, (uint32_t)ls, perFileSize_);
     ::write(outfd_, (char*)&frdFileHeader, sizeof(FRDFileHeader_v1));
   } else if (frdFileVersion_ == 2) {
     lseek(outfd_, 0, SEEK_SET);
     FRDFileHeader_v2 frdFileHeader(0, perFileEventCount_, (uint32_t)run, (uint32_t)ls, perFileSize_);
     ::write(outfd_, (char*)&frdFileHeader, sizeof(FRDFileHeader_v2));
   }
   close(outfd_);
   outfd_ = -1;
   if (!fileName_.empty())
     fileWritten_ = true;
 
   edm::LogInfo("FRDOutputModule") << "closed RAW input file";
 }

◆ write()

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

overrideprivatevirtual

Implements edm::core::OutputModuleCore.

Definition at line 47 of file FRDOutputModule.cc.

References cms::Adler32(), cms::cuda::assert(), crc32c(), FEDRawData::data(), MillePedeFileConverter_cfg::e, Exception, FEDRawDataCollection::FEDData(), fileName_, HLT_2024v13_cff::flags, edm::streamer::FRDEVENT_MASK_ISGENDATA, edm::streamer::FRDHeaderMaxVersion, edm::streamer::FRDHeaderVersionSize, frdVersion_, heavyIonCSV_trainingSettings::idx, FEDNumbering::lastFEDId(), mps_check::msg, outfd_, perFileEventCount_, perFileSize_, FEDRawData::size(), and token_.

Referenced by finishFileWrite(), and pkg.AbstractPkg::generate().

                                                       {
   // serialize the FEDRawDataCollection into the format that we expect for
   // FRDEventMsgView objects (may be better ways to do this)
   edm::Handle<FEDRawDataCollection> fedBuffers;
   e.getByToken(token_, fedBuffers);
 
   // determine the expected size of the FRDEvent IN BYTES !!!!!
   assert(frdVersion_ <= FRDHeaderMaxVersion);
   int headerSize = FRDHeaderVersionSize[frdVersion_];
   int expectedSize = headerSize;
   int nFeds = frdVersion_ < 3 ? 1024 : FEDNumbering::lastFEDId() + 1;
 
   for (int idx = 0; idx < nFeds; ++idx) {
     FEDRawData singleFED = fedBuffers->FEDData(idx);
     expectedSize += singleFED.size();
   }
 
   // build the FRDEvent into a temporary buffer
   std::unique_ptr<std::vector<unsigned char>> workBuffer(
       std::make_unique<std::vector<unsigned char>>(expectedSize + 256));
   uint32* bufPtr = (uint32*)(workBuffer.get()->data());
   if (frdVersion_ <= 5) {
     *bufPtr++ = (uint32)frdVersion_;  // version number only
   } else {
     uint16 flags = 0;
     if (!e.eventAuxiliary().isRealData())
       flags |= FRDEVENT_MASK_ISGENDATA;
     *(uint16*)bufPtr = (uint16)(frdVersion_ & 0xffff);
     *((uint16*)bufPtr + 1) = flags;
     bufPtr++;
   }
   *bufPtr++ = (uint32)e.id().run();
   *bufPtr++ = (uint32)e.luminosityBlock();
   *bufPtr++ = (uint32)e.id().event();
   if (frdVersion_ == 4)
     *bufPtr++ = 0;  //64-bit event id high part
 
   if (frdVersion_ < 3) {
     uint32 fedsize[1024];
     for (int idx = 0; idx < 1024; ++idx) {
       FEDRawData singleFED = fedBuffers->FEDData(idx);
       fedsize[idx] = singleFED.size();
       //std::cout << "fed size " << singleFED.size()<< std::endl;
     }
     memcpy(bufPtr, fedsize, 1024 * sizeof(uint32));
     bufPtr += 1024;
   } else {
     *bufPtr++ = expectedSize - headerSize;
     *bufPtr++ = 0;
     if (frdVersion_ <= 4)
       *bufPtr++ = 0;
   }
   uint32* payloadPtr = bufPtr;
   for (int idx = 0; idx < nFeds; ++idx) {
     FEDRawData singleFED = fedBuffers->FEDData(idx);
     if (singleFED.size() > 0) {
       memcpy(bufPtr, singleFED.data(), singleFED.size());
       bufPtr += singleFED.size() / 4;
     }
   }
   if (frdVersion_ > 4) {
     //crc32c checksum
     uint32_t crc = 0;
     *(payloadPtr - 1) = crc32c(crc, (const unsigned char*)payloadPtr, expectedSize - headerSize);
   } else if (frdVersion_ >= 3) {
     //adler32 checksum
     uint32 adlera = 1;
     uint32 adlerb = 0;
     cms::Adler32((const char*)payloadPtr, expectedSize - headerSize, adlera, adlerb);
     *(payloadPtr - 1) = (adlerb << 16) | adlera;
   }
 
   // create the FRDEventMsgView and use the template consumer to write it out
   FRDEventMsgView msg(workBuffer.get()->data());
 
   //write
   ssize_t retval = ::write(outfd_, (void*)msg.startAddress(), msg.size());
 
   if ((unsigned)retval != msg.size()) {
     throw cms::Exception("FRDOutputModule", "write")
         << "Error writing FED Raw Data event data to " << fileName_ << ".  Possibly the output disk "
         << "is full?" << std::endl;
   }
 
   perFileEventCount_++;
   perFileSize_ += msg.size();
 }

◆ writeLuminosityBlock()

void FRDOutputModule::writeLuminosityBlock ( const edm::LuminosityBlockForOutput & )

inlineoverrideprivatevirtual

Implements edm::core::OutputModuleCore.

Definition at line 27 of file FRDOutputModule.h.

27 {}

◆ writeRun()

void FRDOutputModule::writeRun ( const edm::RunForOutput & )

inlineoverrideprivatevirtual

Implements edm::core::OutputModuleCore.

Definition at line 26 of file FRDOutputModule.h.

26 {}

Member Data Documentation

◆ adlera_

uint32_t FRDOutputModule::adlera_

private

Definition at line 43 of file FRDOutputModule.h.

Referenced by adler32(), and beginLuminosityBlock().

◆ adlerb_

uint32_t FRDOutputModule::adlerb_

private

Definition at line 44 of file FRDOutputModule.h.

Referenced by adler32(), and beginLuminosityBlock().

◆ fileName_

std::string FRDOutputModule::fileName_

private

Definition at line 40 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock(), finishFileWrite(), and write().

◆ filePrefix_

std::string FRDOutputModule::filePrefix_

private

Definition at line 39 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock().

◆ fileWritten_

bool FRDOutputModule::fileWritten_ = false

private

Definition at line 49 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock(), and finishFileWrite().

◆ frdFileVersion_

const uint32_t FRDOutputModule::frdFileVersion_

private

Definition at line 38 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock(), and finishFileWrite().

◆ frdVersion_

const uint32_t FRDOutputModule::frdVersion_

private

Definition at line 37 of file FRDOutputModule.h.

Referenced by write().

◆ outfd_

int FRDOutputModule::outfd_ = -1

private

Definition at line 42 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock(), finishFileWrite(), and write().

◆ perFileEventCount_

uint32_t FRDOutputModule::perFileEventCount_

private

Definition at line 46 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock(), finishFileWrite(), and write().

◆ perFileSize_

uint64_t FRDOutputModule::perFileSize_

private

Definition at line 47 of file FRDOutputModule.h.

Referenced by beginLuminosityBlock(), finishFileWrite(), and write().

◆ token_

const edm::EDGetTokenT<FEDRawDataCollection> FRDOutputModule::token_

private

Definition at line 35 of file FRDOutputModule.h.

Referenced by write().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FRDOutputModule()

◆ ~FRDOutputModule()

Member Function Documentation

◆ adler32()

◆ beginLuminosityBlock()

◆ endLuminosityBlock()

◆ fillDescriptions()

◆ finishFileWrite()

◆ write()

◆ writeLuminosityBlock()

◆ writeRun()

Member Data Documentation

◆ adlera_

◆ adlerb_

◆ fileName_

◆ filePrefix_

◆ fileWritten_

◆ frdFileVersion_

◆ frdVersion_

◆ outfd_

◆ perFileEventCount_

◆ perFileSize_

◆ token_