DataModeScoutingRun3 Class Reference

#include <DAQSourceModelsScoutingRun3.h>

Inheritance diagram for DataModeScoutingRun3:

Public Member Functions
bool	checksumValid () override
bool	dataBlockCompleted () const override
bool	dataBlockInitialized () const override
uint64_t	dataBlockSize () const override
	DataModeScoutingRun3 (DAQSource *daqSource)
int	dataVersion () const override
std::pair< bool, std::vector< std::string > >	defineAdditionalFiles (std::string const &primaryName, bool fileListMode) const override
void	detectVersion (unsigned char *fileBuf, uint32_t fileHeaderOffset) override
void	fillSDSRawDataCollection (SDSRawDataCollection &rawData, char *buff, size_t len)
bool	fitToBuffer () const override
std::string	getChecksumError () const override
uint32_t	headerSize () const override
bool	isRealData () const override
std::vector< std::shared_ptr< const edm::DaqProvenanceHelper > > &	makeDaqProvenanceHelpers () override
void	makeDataBlockView (unsigned char *addr, size_t maxSize, std::vector< uint64_t > const &fileSizes, size_t fileHeaderSize) override
void	makeDirectoryEntries (std::vector< std::string > const &baseDirs, std::vector< int > const &numSources, std::string const &runDir) override
bool	nextEventView () override
void	readEvent (edm::EventPrincipal &eventPrincipal) override
bool	requireHeader () const override
uint32_t	run () const override
void	setDataBlockInitialized (bool val) override
void	setTCDSSearchRange (uint16_t MINTCDSuTCAFEDID, uint16_t MAXTCDSuTCAFEDID) override
bool	versionCheck () const override
	~DataModeScoutingRun3 () override
Public Member Functions inherited from DataMode
	DataMode (DAQSource *daqSource)
virtual bool	isMultiDir ()
void	setTesting (bool testing)
virtual	~DataMode ()=default

Private Member Functions
bool	makeEvents ()

Private Attributes
bool	blockCompleted_ = true
std::vector< int >	buNumSources_
std::vector< std::filesystem::path >	buPaths_
std::vector< bool >	completedBlocks_
unsigned int	currOrbit_ = 0xFFFFFFFF
std::vector< std::shared_ptr< const edm::DaqProvenanceHelper > >	daqProvenanceHelpers_
unsigned char *	dataBlockAddr_ = nullptr
std::vector< unsigned char * >	dataBlockAddrs_
bool	dataBlockInitialized_ = false
size_t	dataBlockMax_ = 0
std::vector< unsigned char * >	dataBlockMaxAddrs_
uint16_t	detectedFRDversion_ = 0
bool	eventCached_ = false
std::vector< std::unique_ptr< FRDEventMsgView > >	events_
size_t	fileHeaderSize_ = 0
size_t	headerSize_ = 0
short	numFiles_ = 0
std::vector< std::pair< int, int > >	sourceValidOrbitPair_

Additional Inherited Members
Protected Attributes inherited from DataMode
DAQSource *	daqSource_
bool	testing_ = false

Detailed Description

Definition at line 20 of file DAQSourceModelsScoutingRun3.h.

Constructor & Destructor Documentation

DataModeScoutingRun3()

DataModeScoutingRun3::DataModeScoutingRun3 ( DAQSource *  daqSource )

inline

Definition at line 22 of file DAQSourceModelsScoutingRun3.h.

: DataMode(daqSource) {}

~DataModeScoutingRun3()

DataModeScoutingRun3::~DataModeScoutingRun3 ( )

inlineoverride

Definition at line 23 of file DAQSourceModelsScoutingRun3.h.

{};

Member Function Documentation

checksumValid()

bool DataModeScoutingRun3::checksumValid ( )

overridevirtual

Implements DataMode.

Definition at line 182 of file DAQSourceModelsScoutingRun3.cc.

{ return true; }

dataBlockCompleted()

bool DataModeScoutingRun3::dataBlockCompleted ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 91 of file DAQSourceModelsScoutingRun3.h.

References blockCompleted_.

{ return blockCompleted_; }

dataBlockInitialized()

bool DataModeScoutingRun3::dataBlockInitialized ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 97 of file DAQSourceModelsScoutingRun3.h.

References dataBlockInitialized_.

{ return dataBlockInitialized_; }

dataBlockSize()

uint64_t DataModeScoutingRun3::dataBlockSize ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 37 of file DAQSourceModelsScoutingRun3.h.

References events_.

                                          {
    // get event size from the first data source (main)
    return events_[0]->size();
  }

dataVersion()

int DataModeScoutingRun3::dataVersion ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 30 of file DAQSourceModelsScoutingRun3.h.

References detectedFRDversion_.

{ return detectedFRDversion_; }

defineAdditionalFiles()

std::pair< bool, std::vector< std::string > > DataModeScoutingRun3::defineAdditionalFiles ( std::string const &  primaryName, bool  fileListMode  ) const

overridevirtual

Implements DataMode.

Definition at line 16 of file DAQSourceModelsScoutingRun3.cc.

References buNumSources_, buPaths_, SiStripCommissioningSource_FromRAW_cfg::fileListMode, reco_skim_cfg_mod::fullpath, mps_fire::i, dqmiolumiharvest::j, castor_dqm_sourceclient_file_cfg::path, and to_string().

                                                                                                               {
  std::vector<std::string> additionalFiles;

  if (fileListMode) {
    // Expected file naming when working in file list mode
    for (int j = 1; j < buNumSources_[0]; j++) {
      additionalFiles.push_back(primaryName + "_" + std::to_string(j));
    }
    return std::make_pair(true, additionalFiles);
  }

  auto fullpath = std::filesystem::path(primaryName);
  auto fullname = fullpath.filename();

  for (size_t i = 0; i < buPaths_.size(); i++) {
    std::filesystem::path newPath = buPaths_[i] / fullname;

    if (i != 0) {
      // secondary files from other ramdisks
      additionalFiles.push_back(newPath.generic_string());
    }

    // add extra sources from the same ramdisk
    for (int j = 1; j < buNumSources_[i]; j++) {
      additionalFiles.push_back(newPath.generic_string() + "_" + std::to_string(j));
    }
  }
  return std::make_pair(true, additionalFiles);
}

detectVersion()

void DataModeScoutingRun3::detectVersion ( unsigned char *  fileBuf, uint32_t  fileHeaderOffset  )

inlineoverridevirtual

Implements DataMode.

Definition at line 31 of file DAQSourceModelsScoutingRun3.h.

References detectedFRDversion_.

                                                                                 {
    detectedFRDversion_ = *((uint16_t*)(fileBuf + fileHeaderOffset));
  }

fillSDSRawDataCollection()

void DataModeScoutingRun3::fillSDSRawDataCollection	(	SDSRawDataCollection &	rawData,
		char *	buff,
		size_t	len
	)

Definition at line 81 of file DAQSourceModelsScoutingRun3.cc.

References FEDRawData::data(), l1tstage2_dqm_sourceclient-live_cfg::rawData, FEDRawData::resize(), and objects.autophobj::sourceId.

Referenced by readEvent().

                                                                                                         {
  size_t pos = 0;

  // get the source ID
  int sourceId = *((uint32_t*)(buff + pos));
  pos += 4;

  // size of the orbit paylod
  size_t orbitSize = len - pos;

  // set the size (=orbit size) in the SRDColletion of the current source.
  // FRD size is expecting 8 bytes words, while scouting is using 4 bytes
  // words. This could be different for some future sources.
  FEDRawData& fedData = rawData.FEDData(sourceId);
  fedData.resize(orbitSize, 4);

  memcpy(fedData.data(), buff + pos, orbitSize);

  return;
}

fitToBuffer()

bool DataModeScoutingRun3::fitToBuffer ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 95 of file DAQSourceModelsScoutingRun3.h.

{ return true; }

getChecksumError()

std::string DataModeScoutingRun3::getChecksumError ( ) const

overridevirtual

Implements DataMode.

Definition at line 184 of file DAQSourceModelsScoutingRun3.cc.

References AlCaHLTBitMon_QueryRunRegistry::string.

{ return std::string(); }

headerSize()

uint32_t DataModeScoutingRun3::headerSize ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 34 of file DAQSourceModelsScoutingRun3.h.

References detectedFRDversion_, and FRDHeaderVersionSize.

{ return FRDHeaderVersionSize[detectedFRDversion_]; }

isRealData()

bool DataModeScoutingRun3::isRealData ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 81 of file DAQSourceModelsScoutingRun3.h.

References cms::cuda::assert(), and events_.

                                   {
    assert(!events_.empty());
    return events_[0]->isRealData();
  }

makeDaqProvenanceHelpers()

std::vector< std::shared_ptr< const edm::DaqProvenanceHelper > > & DataModeScoutingRun3::makeDaqProvenanceHelpers ( )

overridevirtual

Implements DataMode.

Definition at line 102 of file DAQSourceModelsScoutingRun3.cc.

References daqProvenanceHelpers_.

                                                                                                       {
  //set SRD data collection
  daqProvenanceHelpers_.clear();
  daqProvenanceHelpers_.emplace_back(std::make_shared<const edm::DaqProvenanceHelper>(
      edm::TypeID(typeid(SDSRawDataCollection)), "SDSRawDataCollection", "SDSRawDataCollection", "DAQSource"));
  return daqProvenanceHelpers_;
}

makeDataBlockView()

void DataModeScoutingRun3::makeDataBlockView ( unsigned char *  addr, size_t  maxSize, std::vector< uint64_t > const &  fileSizes, size_t  fileHeaderSize  )

inlineoverridevirtual

Implements DataMode.

Definition at line 42 of file DAQSourceModelsScoutingRun3.h.

References generateTowerEtThresholdLUT::addr, cms::cuda::assert(), blockCompleted_, completedBlocks_, dataBlockAddrs_, dataBlockMax_, dataBlockMaxAddrs_, eventCached_, fileHeaderSize_, mps_fire::i, makeEvents(), reco_skim_cfg_mod::maxSize, numFiles_, mps_fire::result, setDataBlockInitialized(), and sourceValidOrbitPair_.

                                                         {
    fileHeaderSize_ = fileHeaderSize;
    numFiles_ = fileSizes.size();

    // initalize vectors keeping tracks of valid orbits and completed blocks
    sourceValidOrbitPair_.clear();
    completedBlocks_.clear();
    for (unsigned int i = 0; i < fileSizes.size(); i++) {
      completedBlocks_.push_back(false);
    }

    //add offset address for each file payload
    dataBlockAddrs_.clear();
    dataBlockAddrs_.push_back(addr);
    dataBlockMaxAddrs_.clear();
    dataBlockMaxAddrs_.push_back(addr + fileSizes[0] - fileHeaderSize);
    auto fileAddr = addr;
    for (unsigned int i = 1; i < fileSizes.size(); i++) {
      fileAddr += fileSizes[i - 1];
      dataBlockAddrs_.push_back(fileAddr);
      dataBlockMaxAddrs_.push_back(fileAddr + fileSizes[i] - fileHeaderSize);
    }

    dataBlockMax_ = maxSize;
    blockCompleted_ = false;
    //set event cached as we set initial address here
    bool result = makeEvents();
    assert(result);
    eventCached_ = true;
    setDataBlockInitialized(true);
  }

makeDirectoryEntries()

void DataModeScoutingRun3::makeDirectoryEntries ( std::vector< std::string > const &  baseDirs, std::vector< int > const &  numSources, std::string const &  runDir  )

overridevirtual

Implements DataMode.

Definition at line 3 of file DAQSourceModelsScoutingRun3.cc.

References ALCARECODTCalibSynchDQM_cff::baseDir, buNumSources_, buPaths_, and castor_dqm_sourceclient_file_cfg::path.

                                                                         {
  std::filesystem::path runDirP(runDir);
  for (auto& baseDir : baseDirs) {
    std::filesystem::path baseDirP(baseDir);
    buPaths_.emplace_back(baseDirP / runDirP);
  }

  // store the number of sources in each BU
  buNumSources_ = numSources;
}

makeEvents()

bool DataModeScoutingRun3::makeEvents ( )

private

Definition at line 124 of file DAQSourceModelsScoutingRun3.cc.

References cms::cuda::assert(), blockCompleted_, completedBlocks_, currOrbit_, dataBlockAddrs_, dataBlockMaxAddrs_, edmPickEvents::event, events_, mps_fire::i, numFiles_, and sourceValidOrbitPair_.

Referenced by makeDataBlockView(), and nextEventView().

                                      {
  // clear events and reset current orbit
  events_.clear();
  sourceValidOrbitPair_.clear();
  currOrbit_ = 0xFFFFFFFF;  // max uint
  assert(!blockCompleted_);

  // create current "events" (= orbits) list from each data source,
  // check if one dataBlock terminated earlier than others.
  for (int i = 0; i < numFiles_; i++) {
    if (dataBlockAddrs_[i] >= dataBlockMaxAddrs_[i]) {
      completedBlocks_[i] = true;
      continue;
    }

    // event contains data, add it to the events list
    events_.emplace_back(std::make_unique<FRDEventMsgView>(dataBlockAddrs_[i]));
    if (dataBlockAddrs_[i] + events_.back()->size() > dataBlockMaxAddrs_[i])
      throw cms::Exception("DAQSource::getNextEvent")
          << " event id:" << events_.back()->event() << " lumi:" << events_.back()->lumi()
          << " run:" << events_.back()->run() << " of size:" << events_.back()->size()
          << " bytes does not fit into the buffer or has corrupted header";

    // find the minimum orbit for the current event between all files
    if ((events_.back()->event() < currOrbit_) && (!completedBlocks_[i])) {
      currOrbit_ = events_.back()->event();
    }
  }

  // mark valid orbits from each data source
  // e.g. find when orbit is missing from one source
  bool allBlocksCompleted = true;
  int evt_idx = 0;
  for (int i = 0; i < numFiles_; i++) {
    if (completedBlocks_[i]) {
      continue;
    }

    if (events_[evt_idx]->event() != currOrbit_) {
      // current source (=i-th source) doesn't contain the expected orbit.
      // skip it, and move to the next orbit
    } else {
      // add a pair <current surce index, event index>
      // evt_idx can be different from variable i, as some data blocks can be
      // completed before others
      sourceValidOrbitPair_.emplace_back(std::make_pair(i, evt_idx));
      allBlocksCompleted = false;
    }

    evt_idx++;
  }

  if (allBlocksCompleted) {
    blockCompleted_ = true;
  }
  return !allBlocksCompleted;
}

nextEventView()

bool DataModeScoutingRun3::nextEventView ( )

overridevirtual

Implements DataMode.

Definition at line 110 of file DAQSourceModelsScoutingRun3.cc.

References blockCompleted_, dataBlockAddrs_, eventCached_, events_, makeEvents(), and sourceValidOrbitPair_.

                                         {
  blockCompleted_ = false;
  if (eventCached_)
    return true;

  // move the data block address only for the sources processed
  // un the previous event by adding the last event size
  for (const auto& pair : sourceValidOrbitPair_) {
    dataBlockAddrs_[pair.first] += events_[pair.second]->size();
  }

  return makeEvents();
}

readEvent()

void DataModeScoutingRun3::readEvent ( edm::EventPrincipal &  eventPrincipal )

overridevirtual

Implements DataMode.

Definition at line 47 of file DAQSourceModelsScoutingRun3.cc.

References cms::cuda::assert(), printConversionInfo::aux, DAQSource::currentLumiSection(), currOrbit_, daqProvenanceHelpers_, DataMode::daqSource_, eventCached_, DAQSource::eventRunNumber(), events_, fillSDSRawDataCollection(), DAQSource::makeEventWrapper(), eostools::move(), edm::EventAuxiliary::PhysicsTrigger, edm::InputSource::processGUID(), DAQSource::processHistoryID(), edm::EventPrincipal::put(), l1tstage2_dqm_sourceclient-live_cfg::rawData, sourceValidOrbitPair_, and hcalRecHitTable_cff::time.

                                                                      {
  assert(!events_.empty());

  edm::TimeValue_t time;
  timeval stv;
  gettimeofday(&stv, nullptr);
  time = stv.tv_sec;
  time = (time << 32) + stv.tv_usec;
  edm::Timestamp tstamp(time);

  // set provenance helpers
  uint32_t hdrEventID = currOrbit_;
  edm::EventID eventID = edm::EventID(daqSource_->eventRunNumber(), daqSource_->currentLumiSection(), hdrEventID);
  edm::EventAuxiliary aux(
      eventID, daqSource_->processGUID(), tstamp, events_[0]->isRealData(), edm::EventAuxiliary::PhysicsTrigger);

  aux.setProcessHistoryID(daqSource_->processHistoryID());
  daqSource_->makeEventWrapper(eventPrincipal, aux);

  // create scouting raw data collection
  std::unique_ptr<SDSRawDataCollection> rawData(new SDSRawDataCollection);

  // Fill the ScoutingRawDataCollection with valid orbit data from the multiple sources
  for (const auto& pair : sourceValidOrbitPair_) {
    fillSDSRawDataCollection(*rawData, (char*)events_[pair.second]->payload(), events_[pair.second]->eventSize());
  }

  std::unique_ptr<edm::WrapperBase> edp(new edm::Wrapper<SDSRawDataCollection>(std::move(rawData)));
  eventPrincipal.put(
      daqProvenanceHelpers_[0]->branchDescription(), std::move(edp), daqProvenanceHelpers_[0]->dummyProvenance());

  eventCached_ = false;
}

requireHeader()

bool DataModeScoutingRun3::requireHeader ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 93 of file DAQSourceModelsScoutingRun3.h.

{ return true; }

run()

uint32_t DataModeScoutingRun3::run ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 86 of file DAQSourceModelsScoutingRun3.h.

References cms::cuda::assert(), and events_.

Referenced by Types.EventID::cppID(), and Types.LuminosityBlockID::cppID().

                                {
    assert(!events_.empty());
    return events_[0]->run();
  }

setDataBlockInitialized()

void DataModeScoutingRun3::setDataBlockInitialized ( bool  val )

inlineoverridevirtual

Implements DataMode.

Definition at line 99 of file DAQSourceModelsScoutingRun3.h.

References dataBlockInitialized_, and heppy_batch::val.

Referenced by makeDataBlockView().

{ dataBlockInitialized_ = val; };

setTCDSSearchRange()

void DataModeScoutingRun3::setTCDSSearchRange ( uint16_t  MINTCDSuTCAFEDID, uint16_t  MAXTCDSuTCAFEDID  )

inlineoverridevirtual

Implements DataMode.

Definition at line 101 of file DAQSourceModelsScoutingRun3.h.

{ return; }

versionCheck()

bool DataModeScoutingRun3::versionCheck ( ) const

inlineoverridevirtual

Implements DataMode.

Definition at line 35 of file DAQSourceModelsScoutingRun3.h.

References detectedFRDversion_, and FRDHeaderMaxVersion.

{ return detectedFRDversion_ <= FRDHeaderMaxVersion; }

Member Data Documentation

blockCompleted_

bool DataModeScoutingRun3::blockCompleted_ = true

private

Definition at line 123 of file DAQSourceModelsScoutingRun3.h.

Referenced by dataBlockCompleted(), makeDataBlockView(), makeEvents(), and nextEventView().

buNumSources_

std::vector<int> DataModeScoutingRun3::buNumSources_

private

Definition at line 126 of file DAQSourceModelsScoutingRun3.h.

Referenced by defineAdditionalFiles(), and makeDirectoryEntries().

buPaths_

std::vector<std::filesystem::path> DataModeScoutingRun3::buPaths_

private

Definition at line 125 of file DAQSourceModelsScoutingRun3.h.

Referenced by defineAdditionalFiles(), and makeDirectoryEntries().

completedBlocks_

std::vector<bool> DataModeScoutingRun3::completedBlocks_

private

Definition at line 132 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView(), and makeEvents().

currOrbit_

unsigned int DataModeScoutingRun3::currOrbit_ = 0xFFFFFFFF

private

Definition at line 130 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeEvents(), and readEvent().

daqProvenanceHelpers_

std::vector<std::shared_ptr<const edm::DaqProvenanceHelper> > DataModeScoutingRun3::daqProvenanceHelpers_

private

Definition at line 112 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDaqProvenanceHelpers(), and readEvent().

dataBlockAddr_

unsigned char* DataModeScoutingRun3::dataBlockAddr_ = nullptr

private

Definition at line 117 of file DAQSourceModelsScoutingRun3.h.

dataBlockAddrs_

std::vector<unsigned char*> DataModeScoutingRun3::dataBlockAddrs_

private

Definition at line 118 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView(), makeEvents(), and nextEventView().

dataBlockInitialized_

bool DataModeScoutingRun3::dataBlockInitialized_ = false

private

Definition at line 122 of file DAQSourceModelsScoutingRun3.h.

Referenced by dataBlockInitialized(), and setDataBlockInitialized().

dataBlockMax_

size_t DataModeScoutingRun3::dataBlockMax_ = 0

private

Definition at line 120 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView().

dataBlockMaxAddrs_

std::vector<unsigned char*> DataModeScoutingRun3::dataBlockMaxAddrs_

private

Definition at line 119 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView(), and makeEvents().

detectedFRDversion_

uint16_t DataModeScoutingRun3::detectedFRDversion_ = 0

private

Definition at line 113 of file DAQSourceModelsScoutingRun3.h.

Referenced by dataVersion(), detectVersion(), headerSize(), and versionCheck().

eventCached_

bool DataModeScoutingRun3::eventCached_ = false

private

Definition at line 124 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView(), nextEventView(), and readEvent().

events_

std::vector<std::unique_ptr<FRDEventMsgView> > DataModeScoutingRun3::events_

private

Definition at line 116 of file DAQSourceModelsScoutingRun3.h.

Referenced by dataBlockSize(), isRealData(), makeEvents(), nextEventView(), readEvent(), and run().

fileHeaderSize_

size_t DataModeScoutingRun3::fileHeaderSize_ = 0

private

Definition at line 114 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView().

headerSize_

size_t DataModeScoutingRun3::headerSize_ = 0

private

Definition at line 115 of file DAQSourceModelsScoutingRun3.h.

numFiles_

short DataModeScoutingRun3::numFiles_ = 0

private

Definition at line 121 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView(), and makeEvents().

sourceValidOrbitPair_

std::vector<std::pair<int, int> > DataModeScoutingRun3::sourceValidOrbitPair_

private

Definition at line 129 of file DAQSourceModelsScoutingRun3.h.

Referenced by makeDataBlockView(), makeEvents(), nextEventView(), and readEvent().