RPCUnpackingModule.cc

Go to the documentation of this file.

#include "RPCUnpackingModule.h"
#include "CondFormats/RPCObjects/interface/RPCReadOutMapping.h"
#include "EventFilter/RPCRawToDigi/interface/RPCRecordFormatter.h"
#include "DataFormats/FEDRawData/interface/FEDRawData.h"
#include "DataFormats/FEDRawData/interface/FEDNumbering.h"
#include "DataFormats/FEDRawData/interface/FEDRawDataCollection.h"
#include "DataFormats/FEDRawData/interface/FEDHeader.h"
#include "DataFormats/FEDRawData/interface/FEDTrailer.h"
#include "DataFormats/RPCDigi/interface/RPCDigiCollection.h"
#include "DataFormats/RPCDigi/interface/RPCRawDataCounts.h"
#include "DataFormats/Common/interface/Handle.h"
#include "FWCore/Framework/interface/Event.h"
//#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/Framework/interface/ESTransientHandle.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Framework/interface/ESWatcher.h"

#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"

#include "DataFormats/RPCDigi/interface/DataRecord.h"
#include "DataFormats/RPCDigi/interface/ReadoutError.h"
#include "DataFormats/RPCDigi/interface/RPCRawSynchro.h"
#include "EventFilter/RPCRawToDigi/interface/EventRecords.h"
#include "EventFilter/RPCRawToDigi/interface/DebugDigisPrintout.h"

#include <sstream>
#include <bitset>

using namespace edm;
using namespace std;
using namespace rpcrawtodigi;

typedef uint64_t Word64;

RPCUnpackingModule::RPCUnpackingModule(const edm::ParameterSet& pset)
    : dataLabel_(pset.getParameter<edm::InputTag>("InputLabel")),
      doSynchro_(pset.getParameter<bool>("doSynchro")),
      eventCounter_(0),
      theReadoutMappingToken(esConsumes<edm::Transition::BeginRun>()),
      theCabling(nullptr) {
  produces<RPCDigiCollection>();
  produces<RPCRawDataCounts>();
  if (doSynchro_)
    produces<RPCRawSynchro::ProdItem>();
  fedToken_ = consumes<FEDRawDataCollection>(dataLabel_);
}

RPCUnpackingModule::~RPCUnpackingModule() { delete theCabling; }

void RPCUnpackingModule::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  desc.add<edm::InputTag>("InputLabel", edm::InputTag("rawDataCollector"));
  desc.add<bool>("doSynchro", true);
  descriptions.add("rpcUnpackingModule", desc);
}

void RPCUnpackingModule::beginRun(const edm::Run& run, const edm::EventSetup& es) {
  if (theRecordWatcher.check(es)) {
    LogTrace("") << "record has CHANGED!!, (re)initialise readout map!";
    delete theCabling;
    ESTransientHandle<RPCEMap> readoutMapping = es.getTransientHandle(theReadoutMappingToken);
    theCabling = readoutMapping->convert();
    theReadoutMappingSearch.init(theCabling);
    LogTrace("") << " READOUT MAP VERSION: " << theCabling->version() << endl;
  }
}

void RPCUnpackingModule::produce(Event& ev, const EventSetup& es) {
  bool debug = edm::MessageDrop::instance()->debugEnabled;
  eventCounter_++;
  if (debug)
    LogDebug("RPCUnpacker::produce") << "Beginning To Unpack Event: " << eventCounter_;

  Handle<FEDRawDataCollection> allFEDRawData;
  ev.getByToken(fedToken_, allFEDRawData);

  auto producedRPCDigis = std::make_unique<RPCDigiCollection>();
  auto producedRawDataCounts = std::make_unique<RPCRawDataCounts>();
  std::unique_ptr<RPCRawSynchro::ProdItem> producedRawSynchoCounts;
  if (doSynchro_)
    producedRawSynchoCounts = std::make_unique<RPCRawSynchro::ProdItem>();

  int status = 0;
  for (int fedId = FEDNumbering::MINRPCFEDID; fedId <= FEDNumbering::MAXRPCFEDID; ++fedId) {
    const FEDRawData& rawData = allFEDRawData->FEDData(fedId);
    RPCRecordFormatter interpreter =
        theCabling ? RPCRecordFormatter(fedId, &theReadoutMappingSearch) : RPCRecordFormatter(fedId, nullptr);
    int triggerBX = 0;
    unsigned int nWords = rawData.size() / sizeof(Word64);
    if (nWords == 0)
      continue;

    //
    // check headers
    //
    const Word64* header = reinterpret_cast<const Word64*>(rawData.data());
    header--;
    bool moreHeaders = true;
    while (moreHeaders) {
      header++;
      FEDHeader fedHeader(reinterpret_cast<const unsigned char*>(header));
      if (!fedHeader.check()) {
        producedRawDataCounts->addReadoutError(fedId, ReadoutError(ReadoutError::HeaderCheckFail));
        if (debug)
          LogTrace("") << " ** PROBLEM **, header.check() failed, break";
        break;
      }
      if (fedHeader.sourceID() != fedId) {
        producedRawDataCounts->addReadoutError(fedId, ReadoutError(ReadoutError::InconsitentFedId));
        if (debug)
          LogTrace("") << " ** PROBLEM **, fedHeader.sourceID() != fedId"
                       << "fedId = " << fedId << " sourceID=" << fedHeader.sourceID();
      }
      triggerBX = fedHeader.bxID();
      moreHeaders = fedHeader.moreHeaders();
      if (debug) {
        stringstream str;
        str << "  header: " << *reinterpret_cast<const bitset<64>*>(header) << endl;
        str << "  header triggerType: " << fedHeader.triggerType() << endl;
        str << "  header lvl1ID:      " << fedHeader.lvl1ID() << endl;
        str << "  header bxID:        " << fedHeader.bxID() << endl;
        str << "  header sourceID:    " << fedHeader.sourceID() << endl;
        str << "  header version:     " << fedHeader.version() << endl;
        LogTrace("") << str.str();
      }
    }

    //
    // check trailers
    //
    const Word64* trailer = reinterpret_cast<const Word64*>(rawData.data()) + (nWords - 1);
    trailer++;
    bool moreTrailers = true;
    while (moreTrailers) {
      trailer--;
      FEDTrailer fedTrailer(reinterpret_cast<const unsigned char*>(trailer));
      if (!fedTrailer.check()) {
        producedRawDataCounts->addReadoutError(fedId, ReadoutError(ReadoutError::TrailerCheckFail));
        if (debug)
          LogTrace("") << " ** PROBLEM **, trailer.check() failed, break";
        break;
      }
      if (fedTrailer.fragmentLength() != nWords) {
        producedRawDataCounts->addReadoutError(fedId, ReadoutError(ReadoutError::InconsistentDataSize));
        if (debug)
          LogTrace("") << " ** PROBLEM **, fedTrailer.fragmentLength()!= nWords, break";
        break;
      }
      moreTrailers = fedTrailer.moreTrailers();
      if (debug) {
        ostringstream str;
        str << " trailer: " << *reinterpret_cast<const bitset<64>*>(trailer) << endl;
        str << "  trailer lenght:    " << fedTrailer.fragmentLength() << endl;
        str << "  trailer crc:       " << fedTrailer.crc() << endl;
        str << "  trailer evtStatus: " << fedTrailer.evtStatus() << endl;
        str << "  trailer ttsBits:   " << fedTrailer.ttsBits() << endl;
        LogTrace("") << str.str();
      }
    }

    //
    // data records
    //
    if (debug) {
      ostringstream str;
      for (const Word64* word = header + 1; word != trailer; word++) {
        str << "    data: " << *reinterpret_cast<const bitset<64>*>(word) << endl;
      }
      LogTrace("") << str.str();
    }
    //    if (triggerBX != 51) continue;
    //    if (triggerBX != 2316) continue;
    EventRecords event(triggerBX);
    for (const Word64* word = header + 1; word != trailer; word++) {
      for (int iRecord = 1; iRecord <= 4; iRecord++) {
        const DataRecord::Data* pRecord = reinterpret_cast<const DataRecord::Data*>(word + 1) - iRecord;
        DataRecord record(*pRecord);
        event.add(record);
        if (debug) {
          std::ostringstream str;
          str << "record: " << record.print() << " hex: " << hex << *pRecord << dec;
          str << " type:" << record.type() << DataRecord::print(record);
          if (event.complete()) {
            str << " --> dccId: " << fedId << " rmb: " << event.recordSLD().rmb()
                << " lnk: " << event.recordSLD().tbLinkInputNumber() << " lb: " << event.recordCD().lbInLink()
                << " part: " << event.recordCD().partitionNumber() << " data: " << event.recordCD().partitionData()
                << " eod: " << event.recordCD().eod();
          }
          LogTrace("") << str.str();
        }
        producedRawDataCounts->addDccRecord(fedId, record);
        int statusTMP = 0;
        if (event.complete())
          statusTMP = interpreter.recordUnpack(
              event, producedRPCDigis.get(), producedRawDataCounts.get(), producedRawSynchoCounts.get());
        if (statusTMP != 0)
          status = statusTMP;
      }
    }
  }
  if (status && debug)
    LogTrace("") << " RPCUnpackingModule - There was unpacking PROBLEM in this event" << endl;
  if (debug)
    LogTrace("") << DebugDigisPrintout()(producedRPCDigis.get()) << endl;
  ev.put(std::move(producedRPCDigis));
  ev.put(std::move(producedRawDataCounts));
  if (doSynchro_)
    ev.put(std::move(producedRawSynchoCounts));
}