FRDStreamSource Class Reference

#include <FRDStreamSource.h>

Inheritance diagram for FRDStreamSource:

Public Member Functions
	FRDStreamSource (edm::ParameterSet const &pset, edm::InputSourceDescription const &desc)
	~FRDStreamSource () override
Public Member Functions inherited from edm::ProducerSourceFromFiles
InputFileCatalog &	catalog ()
std::vector< std::string >	fileNames (unsigned iCatalog) const
std::vector< std::string > const &	logicalFileNames () const
	ProducerSourceFromFiles (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
	~ProducerSourceFromFiles () override
Public Member Functions inherited from edm::ProducerSourceBase
	ProducerSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
	~ProducerSourceBase () noexcept(false) override
Public Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
EventNumber_t	event () const
unsigned int	eventCreationDelay () const
EventID const &	eventID () const
	IDGeneratorSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
LuminosityBlockNumber_t	luminosityBlock () const
unsigned int	numberEventsInLumi () const
unsigned int	numberEventsInRun () const
unsigned int	numberEventsInThisLumi () const
unsigned int	numberEventsInThisRun () const
TimeValue_t	presentTime () const
RunNumber_t	run () const
unsigned int	timeBetweenEvents () const
	~IDGeneratorSourceBase () noexcept(false) override
Public Member Functions inherited from edm::PuttableSourceBase
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginRuns () const final
	PuttableSourceBase (ParameterSet const &, InputSourceDescription const &)
void	registerProducts () final
	Register any produced products. More...
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...
std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()
std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...
void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...
void	doBeginJob ()
	Called by framework at beginning of job. More...
void	doEndJob ()
	Called by framework at end of job. More...
ProcessingController::ForwardState	forwardState () const
bool	goToEvent (EventID const &eventID)
	InputSource (InputSource const &)=delete
	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...
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< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () 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...
ItemType	nextItemType ()
	Advances the source to the next item. More...
InputSource &	operator= (InputSource const &)=delete
ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...
std::string const &	processGUID () const
	Accessor for global process identifier. More...
ProcessHistoryRegistry &	processHistoryRegistry ()
ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...
ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
std::shared_ptr< ProductRegistry > &	productRegistry ()
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...
bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...
void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...
std::unique_ptr< FileBlock >	readFile ()
	Read next file. More...
void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...
std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...
void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...
std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...
ProcessHistoryID const &	reducedProcessHistoryID () const
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< RunAuxiliary >	runAuxiliary () 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)
std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()
std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...
Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...
virtual	~InputSource () noexcept(false)
	Destructor. More...
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
std::vector< bool > const &	recordProvenanceList () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...
	~ProducerBase () noexcept(false) override

Private Member Functions
bool	openFile (const std::string &fileName)
void	produce (edm::Event &e) override
bool	setRunAndEventInfo (edm::EventID &id, edm::TimeValue_t &theTime, edm::EventAuxiliary::ExperimentType &eType) override

Private Attributes
std::vector< char >	buffer_
uint16_t	detectedFRDversion_ = 0
std::ifstream	fin_
uint16_t	flags_ = 0
std::vector< std::string >::const_iterator	itFileName_
std::unique_ptr< FEDRawDataCollection >	rawData_
const bool	useL1EventID_
const bool	verifyAdler32_
const bool	verifyChecksum_

Additional Inherited Members
Public Types inherited from edm::InputSource
enum	ItemType {   IsInvalid, IsStop, IsFile, IsRun,   IsLumi, IsEvent, IsRepeat, IsSynchronize }
enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Static Public Member Functions inherited from edm::ProducerSourceFromFiles
static void	fillDescription (ParameterSetDescription &desc)
Static Public Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
static void	fillDescription (ParameterSetDescription &desc)
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 &)
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::ProducerSourceFromFiles
void	incrementFileIndex ()
Protected Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
void	doReadEvent (EventPrincipal &eventPrincipal, F &&f)
Protected Member Functions inherited from edm::InputSource
void	decreaseRemainingEventsBy (int iSkipped)
bool	eventCached () const
bool	newLumi () const
bool	newRun () const
ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()
ProductRegistry &	productRegistryUpdate ()
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...
ItemType	state () const
Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
ProducesCollector	producesCollector ()

Detailed Description

Definition at line 20 of file FRDStreamSource.h.

Constructor & Destructor Documentation

FRDStreamSource()

FRDStreamSource::FRDStreamSource	(	edm::ParameterSet const &	pset,
		edm::InputSourceDescription const &	desc
	)

Definition at line 19 of file FRDStreamSource.cc.

    : ProducerSourceFromFiles(pset, desc, true),
      verifyAdler32_(pset.getUntrackedParameter<bool>("verifyAdler32", true)),
      verifyChecksum_(pset.getUntrackedParameter<bool>("verifyChecksum", true)),
      useL1EventID_(pset.getUntrackedParameter<bool>("useL1EventID", false)) {
  itFileName_ = fileNames(0).begin();
  openFile(*itFileName_);
  produces<FEDRawDataCollection>();
}

References edm::FromFiles::fileNames(), itFileName_, and openFile().

~FRDStreamSource()

FRDStreamSource::~FRDStreamSource ( )

inlineoverride

Definition at line 24 of file FRDStreamSource.h.

{};

Member Function Documentation

openFile()

bool FRDStreamSource::openFile ( const std::string &  fileName )

private

Definition at line 175 of file FRDStreamSource.cc.

                                                        {
  std::cout << " open file.. " << fileName << std::endl;
  fin_.close();
  fin_.clear();
  size_t pos = fileName.find(':');
  if (pos != std::string::npos) {
    std::string prefix = fileName.substr(0, pos);
    if (prefix != "file")
      return false;
    pos++;
  } else
    pos = 0;
 
  fin_.open(fileName.substr(pos).c_str(), std::ios::in | std::ios::binary);
  return fin_.is_open();
}

References gather_cfg::cout, MillePedeFileConverter_cfg::fileName, fin_, recoMuon::in, ZMuMuAnalysisNtupler_cff::prefix, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by FRDStreamSource(), and setRunAndEventInfo().

produce()

void FRDStreamSource::produce ( edm::Event &  e )

overrideprivatevirtual

Implements edm::ProducerSourceBase.

Definition at line 173 of file FRDStreamSource.cc.

{ e.put(std::move(rawData_)); }

References MillePedeFileConverter_cfg::e, eostools::move(), and rawData_.

setRunAndEventInfo()

bool FRDStreamSource::setRunAndEventInfo ( edm::EventID &  id, edm::TimeValue_t &  theTime, edm::EventAuxiliary::ExperimentType &  eType  )

overrideprivatevirtual

Implements edm::IDGeneratorSourceBase< PuttableSourceBase >.

Definition at line 29 of file FRDStreamSource.cc.

                                                                                 {
  if (fin_.peek() == EOF) {
    if (++itFileName_ == fileNames(0).end()) {
      fin_.close();
      return false;
    }
    if (!openFile(*itFileName_)) {
      throw cms::Exception("FRDStreamSource::setRunAndEventInfo") << "could not open file " << *itFileName_;
    }
  }
  //look for FRD header at beginning of the file and skip it
  if (fin_.tellg() == 0) {
    constexpr size_t buf_sz = sizeof(FRDFileHeader_v1);  //try to read v1 FRD header size
    FRDFileHeader_v1 fileHead;
    fin_.read((char*)&fileHead, buf_sz);
 
    if (fin_.gcount() == 0)
      throw cms::Exception("FRDStreamSource::setRunAndEventInfo")
          << "Unable to read file or empty file" << *itFileName_;
    else if (fin_.gcount() < (ssize_t)buf_sz)
      fin_.seekg(0);
    else {
      uint16_t frd_version = getFRDFileHeaderVersion(fileHead.id_, fileHead.version_);
      if (frd_version >= 1) {
        if (fileHead.headerSize_ < buf_sz)
          throw cms::Exception("FRDStreamSource::setRunAndEventInfo")
              << "Invalid FRD file header (size mismatch) in file " << *itFileName_;
        else if (fileHead.headerSize_ > buf_sz)
          fin_.seekg(fileHead.headerSize_, fin_.beg);
      } else
        fin_.seekg(0, fin_.beg);
    }
  }
 
  if (detectedFRDversion_ == 0) {
    fin_.read((char*)&detectedFRDversion_, sizeof(uint16_t));
    fin_.read((char*)&flags_, sizeof(uint16_t));
    assert(detectedFRDversion_ > 0 && detectedFRDversion_ <= FRDHeaderMaxVersion);
    if (buffer_.size() < FRDHeaderVersionSize[detectedFRDversion_])
      buffer_.resize(FRDHeaderVersionSize[detectedFRDversion_]);
    *((uint32_t*)(&buffer_[0])) = detectedFRDversion_;
    fin_.read(&buffer_[0] + sizeof(uint32_t), FRDHeaderVersionSize[detectedFRDversion_] - sizeof(uint32_t));
    assert(fin_.gcount() == FRDHeaderVersionSize[detectedFRDversion_] - (unsigned int)(sizeof(uint32_t)));
  } else {
    if (buffer_.size() < FRDHeaderVersionSize[detectedFRDversion_])
      buffer_.resize(FRDHeaderVersionSize[detectedFRDversion_]);
    fin_.read(&buffer_[0], FRDHeaderVersionSize[detectedFRDversion_]);
    assert(fin_.gcount() == FRDHeaderVersionSize[detectedFRDversion_]);
  }
 
  std::unique_ptr<FRDEventMsgView> frdEventMsg(new FRDEventMsgView(&buffer_[0]));
  if (useL1EventID_)
    id = edm::EventID(frdEventMsg->run(), frdEventMsg->lumi(), frdEventMsg->event());
 
  const uint32_t totalSize = frdEventMsg->size();
  if (totalSize > buffer_.size()) {
    buffer_.resize(totalSize);
  }
  if (totalSize > FRDHeaderVersionSize[detectedFRDversion_]) {
    fin_.read(&buffer_[0] + FRDHeaderVersionSize[detectedFRDversion_],
              totalSize - FRDHeaderVersionSize[detectedFRDversion_]);
    if (fin_.gcount() != totalSize - FRDHeaderVersionSize[detectedFRDversion_]) {
      throw cms::Exception("FRDStreamSource::setRunAndEventInfo") << "premature end of file " << *itFileName_;
    }
    frdEventMsg.reset(new FRDEventMsgView(&buffer_[0]));
  }
 
  if (verifyChecksum_ && frdEventMsg->version() >= 5) {
    uint32_t crc = 0;
    crc = crc32c(crc, (const unsigned char*)frdEventMsg->payload(), frdEventMsg->eventSize());
    if (crc != frdEventMsg->crc32c()) {
      throw cms::Exception("FRDStreamSource::getNextEvent") << "Found a wrong crc32c checksum: expected 0x" << std::hex
                                                            << frdEventMsg->crc32c() << " but calculated 0x" << crc;
    }
  } else if (verifyAdler32_ && frdEventMsg->version() >= 3) {
    uint32_t adler = adler32(0L, Z_NULL, 0);
    adler = adler32(adler, (Bytef*)frdEventMsg->payload(), frdEventMsg->eventSize());
 
    if (adler != frdEventMsg->adler32()) {
      throw cms::Exception("FRDStreamSource::setRunAndEventInfo")
          << "Found a wrong Adler32 checksum: expected 0x" << std::hex << frdEventMsg->adler32() << " but calculated 0x"
          << adler;
    }
  }
 
  rawData_ = std::make_unique<FEDRawDataCollection>();
 
  uint32_t eventSize = frdEventMsg->eventSize();
  unsigned char* event = (unsigned char*)frdEventMsg->payload();
  bool foundTCDSFED = false;
  bool foundGTPFED = false;
 
  while (eventSize > 0) {
    assert(eventSize >= FEDTrailer::length);
    eventSize -= FEDTrailer::length;
    const FEDTrailer fedTrailer(event + eventSize);
    const uint32_t fedSize = fedTrailer.fragmentLength() << 3;  //trailer length counts in 8 bytes
    assert(eventSize >= fedSize - FEDHeader::length);
    eventSize -= (fedSize - FEDHeader::length);
    const FEDHeader fedHeader(event + eventSize);
    const uint16_t fedId = fedHeader.sourceID();
    if (fedId > FEDNumbering::MAXFEDID) {
      throw cms::Exception("FedRawDataInputSource::fillFEDRawDataCollection") << "Out of range FED ID : " << fedId;
    }
    if (fedId == FEDNumbering::MINTCDSuTCAFEDID) {
      foundTCDSFED = true;
      tcds::Raw_v1 const* tcds = reinterpret_cast<tcds::Raw_v1 const*>(event + eventSize + FEDHeader::length);
      id = edm::EventID(frdEventMsg->run(), tcds->header.lumiSection, tcds->header.eventNumber);
      eType = static_cast<edm::EventAuxiliary::ExperimentType>(fedHeader.triggerType());
      theTime = static_cast<edm::TimeValue_t>(((uint64_t)tcds->bst.gpstimehigh << 32) | tcds->bst.gpstimelow);
    }
 
    if (fedId == FEDNumbering::MINTriggerGTPFEDID && !foundTCDSFED) {
      foundGTPFED = true;
      const bool GTPEvmBoardSense = evf::evtn::evm_board_sense(event + eventSize, fedSize);
      if (!useL1EventID_) {
        if (GTPEvmBoardSense)
          id = edm::EventID(frdEventMsg->run(), frdEventMsg->lumi(), evf::evtn::get(event + eventSize, true));
        else
          id = edm::EventID(frdEventMsg->run(), frdEventMsg->lumi(), evf::evtn::get(event + eventSize, false));
      }
      //evf::evtn::evm_board_setformat(fedSize);
      const uint64_t gpsl = evf::evtn::getgpslow(event + eventSize);
      const uint64_t gpsh = evf::evtn::getgpshigh(event + eventSize);
      theTime = static_cast<edm::TimeValue_t>((gpsh << 32) + gpsl);
    }
 
    //take event ID from GTPE FED
    if (fedId == FEDNumbering::MINTriggerEGTPFEDID && !foundGTPFED && !foundTCDSFED && !useL1EventID_) {
      if (evf::evtn::gtpe_board_sense(event + eventSize)) {
        id = edm::EventID(frdEventMsg->run(), frdEventMsg->lumi(), evf::evtn::gtpe_get(event + eventSize));
      }
    }
    FEDRawData& fedData = rawData_->FEDData(fedId);
    fedData.resize(fedSize);
    memcpy(fedData.data(), event + eventSize, fedSize);
  }
  assert(eventSize == 0);
 
  return true;
}

References cms::cuda::assert(), buffer_, crc32c(), FEDRawData::data(), detectedFRDversion_, evf::evtn::evm_board_sense(), Exception, l1tstage2_dqm_sourceclient-live_cfg::fedId, edm::FromFiles::fileNames(), fin_, flags_, FEDTrailer::fragmentLength(), FRDHeaderMaxVersion, FRDHeaderVersionSize, evf::evtn::get(), getFRDFileHeaderVersion(), evf::evtn::getgpshigh(), evf::evtn::getgpslow(), evf::evtn::gtpe_board_sense(), evf::evtn::gtpe_get(), createfilelist::int, itFileName_, dttmaxenums::L, FEDHeader::length, FEDTrailer::length, FEDNumbering::MAXFEDID, FEDNumbering::MINTCDSuTCAFEDID, FEDNumbering::MINTriggerEGTPFEDID, FEDNumbering::MINTriggerGTPFEDID, openFile(), rawData_, FEDRawData::resize(), FEDHeader::sourceID(), FEDHeader::triggerType(), useL1EventID_, verifyAdler32_, and verifyChecksum_.

Member Data Documentation

buffer_

std::vector<char> FRDStreamSource::buffer_

private

Definition at line 40 of file FRDStreamSource.h.

Referenced by setRunAndEventInfo().

detectedFRDversion_

uint16_t FRDStreamSource::detectedFRDversion_ = 0

private

Definition at line 44 of file FRDStreamSource.h.

Referenced by setRunAndEventInfo().

fin_

std::ifstream FRDStreamSource::fin_

private

Definition at line 38 of file FRDStreamSource.h.

Referenced by openFile(), and setRunAndEventInfo().

flags_

uint16_t FRDStreamSource::flags_ = 0

private

Definition at line 45 of file FRDStreamSource.h.

Referenced by setRunAndEventInfo().

itFileName_

std::vector<std::string>::const_iterator FRDStreamSource::itFileName_

private

Definition at line 37 of file FRDStreamSource.h.

Referenced by FRDStreamSource(), and setRunAndEventInfo().

rawData_

std::unique_ptr<FEDRawDataCollection> FRDStreamSource::rawData_

private

Definition at line 39 of file FRDStreamSource.h.

Referenced by produce(), and setRunAndEventInfo().

useL1EventID_

const bool FRDStreamSource::useL1EventID_

private

Definition at line 43 of file FRDStreamSource.h.

Referenced by setRunAndEventInfo().

verifyAdler32_

const bool FRDStreamSource::verifyAdler32_

private

Definition at line 41 of file FRDStreamSource.h.

Referenced by setRunAndEventInfo().

verifyChecksum_

const bool FRDStreamSource::verifyChecksum_

private

Definition at line 42 of file FRDStreamSource.h.

Referenced by setRunAndEventInfo().