l1t::demo::BoardDataWriter Class Reference

#include <BoardDataWriter.h>

Public Types
typedef std::map< LinkId, std::pair< ChannelSpec, std::vector< size_t > > >	ChannelMap_t

Public Member Functions
void	addEvent (const EventData &data)
	BoardDataWriter (FileFormat, const std::string &filePath, const std::string &fileExt, const size_t framesPerBX, const size_t tmux, const size_t maxFramesPerFile, const ChannelMap_t &)
	BoardDataWriter (FileFormat, const std::string &filePath, const std::string &fileExt, const size_t framesPerBX, const size_t tmux, const size_t maxFramesPerFile, const std::map< LinkId, std::vector< size_t >> &, const std::map< std::string, ChannelSpec > &)
void	flush ()
void	setBoardDataFileID (const std::string &)

Private Member Functions
void	resetBoardData ()

Static Private Member Functions
static ChannelMap_t	mergeMaps (const std::map< LinkId, std::vector< size_t >> &, const std::map< std::string, ChannelSpec > &)

Private Attributes
BoardData	boardData_
std::string	boardDataFileID_
size_t	boardTMUX_
ChannelMap_t	channelMap_
size_t	eventIndex_
FileFormat	fileFormat_
std::vector< std::string >	fileNames_
std::function< std::string(const size_t)>	filePathGen_
size_t	framesPerBX_
size_t	maxEventsPerFile_
size_t	maxFramesPerFile_
size_t	pendingEvents_

Detailed Description

Definition at line 20 of file BoardDataWriter.h.

Member Typedef Documentation

ChannelMap_t

typedef std::map<LinkId, std::pair<ChannelSpec, std::vector<size_t> > > l1t::demo::BoardDataWriter::ChannelMap_t

Definition at line 23 of file BoardDataWriter.h.

Constructor & Destructor Documentation

BoardDataWriter() [1/2]

l1t::demo::BoardDataWriter::BoardDataWriter	(	FileFormat	format,
		const std::string &	filePath,
		const std::string &	fileExt,
		const size_t	framesPerBX,
		const size_t	tmux,
		const size_t	maxFramesPerFile,
		const ChannelMap_t &	channelSpecs
	)

Definition at line 10 of file BoardDataWriter.cc.

References mps_fire::i, castor_dqm_sourceclient_file_cfg::path, and to_string().

      : fileFormat_(format),
        boardDataFileID_("CMSSW"),
        filePathGen_([=](const size_t i) { return path + "_" + std::to_string(i) + "." + fileExt; }),
        framesPerBX_(framesPerBX),
        boardTMUX_(tmux),
        maxFramesPerFile_(maxFramesPerFile),
        maxEventsPerFile_(maxFramesPerFile_),
        eventIndex_(0),
        pendingEvents_(0),
        channelMap_(channelSpecs) {
    if (channelMap_.empty())
      throw std::runtime_error("BoardDataWriter channel map cannnot be empty");
    if (fileExt != "txt" && fileExt != "txt.gz" && fileExt != "txt.xz")
      throw std::runtime_error("BoardDataWriter fileExt must be one of txt, txt.gz, txt.xz");

    for (const auto& [id, value] : channelMap_) {
      const auto& [spec, indices] = value;
      for (const auto i : indices)
        boardData_.add(i);

      if ((spec.tmux % boardTMUX_) != 0)
        throw std::runtime_error("BoardDataWriter, link [" + id.interface + ", " + std::to_string(id.channel) +
                                 "]: Specified TMUX period, " + std::to_string(spec.tmux) +
                                 ", is not a multiple of the board TMUX, " + std::to_string(boardTMUX_));

      const size_t tmuxRatio(spec.tmux / boardTMUX_);
      if (indices.size() != tmuxRatio)
        throw std::runtime_error("BoardDataWriter, link [" + id.interface + ", " + std::to_string(id.channel) +
                                 "]: Number of channel indices specified, " + std::to_string(indices.size()) +
                                 ", does not match link:board TMUX ratio, " + std::to_string(tmuxRatio));

      maxEventsPerFile_ = std::min(maxEventsPerFile_,
                                   ((maxFramesPerFile_ - spec.offset) / (framesPerBX_ * boardTMUX_)) - (tmuxRatio - 1));
    }

    resetBoardData();
  }

BoardDataWriter() [2/2]

l1t::demo::BoardDataWriter::BoardDataWriter	(	FileFormat	format,
		const std::string &	filePath,
		const std::string &	fileExt,
		const size_t	framesPerBX,
		const size_t	tmux,
		const size_t	maxFramesPerFile,
		const std::map< LinkId, std::vector< size_t >> &	channelMap,
		const std::map< std::string, ChannelSpec > &	channelSpecs
	)

Definition at line 55 of file BoardDataWriter.cc.

      : BoardDataWriter(
            format, path, fileExt, framesPerBX, tmux, maxFramesPerFile, mergeMaps(channelMap, channelSpecs)) {}

Member Function Documentation

addEvent()

void l1t::demo::BoardDataWriter::addEvent

(

const EventData &

data

)

Definition at line 68 of file BoardDataWriter.cc.

References l1t::demo::BoardData::at(), boardData_, boardTMUX_, channelMap_, eventIndex_, flush(), framesPerBX_, l1t::demo::EventData::has(), dqmdumpme::indices, info(), l1ctLayer2EG_cff::interface, maxEventsPerFile_, pendingEvents_, and to_string().

Referenced by L1CTJetFileWriter::analyze(), and GTTFileWriter::analyze().

                                                           {
    // Check that data is supplied for each channel
    for (const auto& [id, info] : channelMap_) {
      if (not eventData.has(id))
        throw std::runtime_error("Event data for link [" + id.interface + ", " + std::to_string(id.channel) +
                                 "] is missing.");
    }

    for (const auto& [id, channelData] : eventData) {
      // Check that each channel was declared to constructor
      if (channelMap_.count(id) == 0)
        throw std::runtime_error("Event data for link [" + id.interface + ", " + std::to_string(id.channel) +
                                 "] was given to BoardDataWriter, but its structure was not defined");

      const auto& [spec, indices] = channelMap_.at(id);
      const size_t chanIndex(indices.at(pendingEvents_ % (spec.tmux / boardTMUX_)));

      // Check that that expected amount of data has been provided
      if (channelData.size() > (spec.tmux * framesPerBX_ - spec.interpacketGap))
        throw std::runtime_error("Event data for link [" + id.interface + ", " + std::to_string(id.channel) +
                                 "] (TMUX " + std::to_string(spec.tmux) + ", " + std::to_string(spec.interpacketGap) +
                                 " cycles between packets) is too long (" + std::to_string(channelData.size()) +
                                 " 64-bit words)");

      if (channelData.empty())
        throw std::runtime_error("Event data for link [" + id.interface + ", " + std::to_string(id.channel) +
                                 "] is empty");

      // Copy event data for this channel to board data object
      boardData_.at(chanIndex).insert(boardData_.at(chanIndex).end(), channelData.begin(), channelData.end());

      // Override flags for start & end of event
      BoardData::Channel::iterator it(boardData_.at(chanIndex).end() - 1);
      it->endOfPacket = true;
      it -= (channelData.size() - 1);
      it->startOfPacket = true;

      // Pad link with non-valid frames
      boardData_.at(chanIndex).insert(
          boardData_.at(chanIndex).end(), spec.tmux * framesPerBX_ - channelData.size(), Frame());
    }

    eventIndex_++;
    pendingEvents_++;

    if (pendingEvents_ == maxEventsPerFile_)
      flush();
  }

flush()

void l1t::demo::BoardDataWriter::flush

(

)

Definition at line 117 of file BoardDataWriter.cc.

References boardData_, boardDataFileID_, fileFormat_, fileNames_, dt4ml_dqm_sourceclient-live_cfg::filePath, filePathGen_, maxFramesPerFile_, l1t::demo::BoardData::name(), pendingEvents_, resetBoardData(), AlCaHLTBitMon_QueryRunRegistry::string, l1t::demo::write(), and x.

Referenced by addEvent(), L1CTJetFileWriter::endJob(), and GTTFileWriter::endJob().

                              {
    if (pendingEvents_ == 0)
      return;

    // Pad any channels that aren't full with invalid frames
    for (auto& x : boardData_)
      x.second.resize(maxFramesPerFile_);

    // For each channel: Assert start_of_orbit for first clock cycle that start is asserted
    for (auto& x : boardData_) {
      for (auto& frame : x.second) {
        if (frame.startOfPacket) {
          frame.startOfOrbit = true;
          break;
        }
      }
    }

    // Set ID field for board data files
    boardData_.name(boardDataFileID_);

    // Write board data object to file
    const std::string filePath = filePathGen_(fileNames_.size());
    write(boardData_, filePath, fileFormat_);
    fileNames_.push_back(filePath);

    // Clear board data to be ready for next event
    resetBoardData();
  }

mergeMaps()

BoardDataWriter::ChannelMap_t l1t::demo::BoardDataWriter::mergeMaps ( const std::map< LinkId, std::vector< size_t >> &  indexMap, const std::map< std::string, ChannelSpec > &  specMap  )

staticprivate

Definition at line 147 of file BoardDataWriter.cc.

References x.

                                                                                                          {
    ChannelMap_t channelMap;
    for (const auto& x : indexMap)
      channelMap[x.first] = {specMap.at(x.first.interface), x.second};
    return channelMap;
  }

resetBoardData()

void l1t::demo::BoardDataWriter::resetBoardData ( )

private

Definition at line 155 of file BoardDataWriter.cc.

References l1t::demo::BoardData::at(), boardData_, boardTMUX_, channelMap_, framesPerBX_, dqmdumpme::indices, pendingEvents_, relativeConstraints::value, and x.

Referenced by flush().

                                       {
    for (auto& x : boardData_)
      x.second.clear();

    for (const auto& [id, value] : channelMap_) {
      const auto& [spec, indices] = value;
      for (size_t tmuxIndex = 0; tmuxIndex < indices.size(); tmuxIndex++)
        boardData_.at(indices.at(tmuxIndex)).resize(tmuxIndex * boardTMUX_ * framesPerBX_ + spec.offset);
    }

    pendingEvents_ = 0;
  }

setBoardDataFileID()

void l1t::demo::BoardDataWriter::setBoardDataFileID

(

const std::string &

aId

)

Definition at line 66 of file BoardDataWriter.cc.

References boardDataFileID_.

{ boardDataFileID_ = aId; }

Member Data Documentation

boardData_

BoardData l1t::demo::BoardDataWriter::boardData_

private

Definition at line 78 of file BoardDataWriter.h.

Referenced by addEvent(), flush(), and resetBoardData().

boardDataFileID_

std::string l1t::demo::BoardDataWriter::boardDataFileID_

private

Definition at line 59 of file BoardDataWriter.h.

Referenced by flush(), and setBoardDataFileID().

boardTMUX_

size_t l1t::demo::BoardDataWriter::boardTMUX_

private

Definition at line 67 of file BoardDataWriter.h.

Referenced by addEvent(), and resetBoardData().

channelMap_

ChannelMap_t l1t::demo::BoardDataWriter::channelMap_

private

Definition at line 81 of file BoardDataWriter.h.

Referenced by addEvent(), and resetBoardData().

eventIndex_

size_t l1t::demo::BoardDataWriter::eventIndex_

private

Definition at line 73 of file BoardDataWriter.h.

Referenced by addEvent().

fileFormat_

FileFormat l1t::demo::BoardDataWriter::fileFormat_

private

Definition at line 56 of file BoardDataWriter.h.

Referenced by flush().

fileNames_

std::vector<std::string> l1t::demo::BoardDataWriter::fileNames_

private

Definition at line 63 of file BoardDataWriter.h.

Referenced by flush().

filePathGen_

std::function<std::string(const size_t)> l1t::demo::BoardDataWriter::filePathGen_

private

Definition at line 61 of file BoardDataWriter.h.

Referenced by flush().

framesPerBX_

size_t l1t::demo::BoardDataWriter::framesPerBX_

private

Definition at line 65 of file BoardDataWriter.h.

Referenced by addEvent(), and resetBoardData().

maxEventsPerFile_

size_t l1t::demo::BoardDataWriter::maxEventsPerFile_

private

Definition at line 71 of file BoardDataWriter.h.

Referenced by addEvent().

maxFramesPerFile_

size_t l1t::demo::BoardDataWriter::maxFramesPerFile_

private

Definition at line 69 of file BoardDataWriter.h.

Referenced by flush().

pendingEvents_

size_t l1t::demo::BoardDataWriter::pendingEvents_

private

Definition at line 76 of file BoardDataWriter.h.

Referenced by addEvent(), flush(), and resetBoardData().