PXDReadRawBonnDAQ.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <pxd/modules/pxdUnpacking/PXDReadRawBonnDAQ.h>
#include <framework/dataobjects/EventMetaData.h>
#include <rawdata/dataobjects/RawPXD.h>
 
#include <boost/endian/arithmetic.hpp>
#include <boost/crc.hpp>
 
using namespace std;
using namespace Belle2;
using namespace PXD;
 
using ulittle16_t = boost::endian::little_uint16_t;
using ulittle32_t = boost::endian::little_uint32_t;
using ubig16_t = boost::endian::big_uint16_t;
using ubig32_t = boost::endian::big_uint32_t;
 
using boost::crc_optimal;
typedef crc_optimal<32, 0x04C11DB7, 0, 0, false, false> dhe_crc_32_type;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(PXDReadRawBonnDAQ);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
PXDReadRawBonnDAQModule::PXDReadRawBonnDAQModule() : Module()
{
  fh = 0;
  //Set module properties
  setDescription("Read a BonnDAQ file and stores it as RawPXD in Data Store");
  //setPropertyFlags(c_Input | c_ParallelProcessingCertified); // not parallel processing!
 
  addParam("FileName", m_filename, "file name");
  addParam("SubRunNr", m_subRunNr, "sub-run number", 0u);
  addParam("RunNr", m_runNr, "run number", 0u);
  addParam("ExpNr", m_expNr, "exp number", 0u);
  m_buffer = new int[MAXEVTSIZE];
 
  B2DEBUG(29, "PXDReadRawBonnDAQModule: Constructor done.");
}
 
 
PXDReadRawBonnDAQModule::~PXDReadRawBonnDAQModule()
{
  delete[] m_buffer;
}
 
void PXDReadRawBonnDAQModule::initialize()
{
  // Open file
  fh = new PXDLocalDAQFile(m_filename);
  if (fh) {
    B2INFO("Read BonnDAQ Data from " << m_filename);
  } else {
    B2ERROR("Could not open BonnDAQ Data: " << m_filename);
  }
 
  // Register EvtMetaData
  m_eventMetaDataPtr.registerInDataStore(DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
  // Register RawPXD
  m_rawPXD.registerInDataStore(DataStore::EStoreFlags::c_ErrorIfAlreadyRegistered);
 
  B2DEBUG(29, "PXDReadRawBonnDAQModule: initialized.");
}
 
int PXDReadRawBonnDAQModule::readOneEvent()
{
 
  if (!fh) {
    B2ERROR("BonnDAQ Data file is not open ");
  }
 
  unsigned int triggernr = 0xFFFFFFFF;
 
  struct EvtHeader {
    ulittle16_t size;
    ulittle16_t header;
    unsigned int get_size(void) { return (unsigned int) size + (((unsigned int)(header & 0x000F)) << 16);};
    unsigned int get_size_group(void) { return (unsigned int) size + (((unsigned int)((header & 0x003F) ^ 0x0020)) << 16);};
    unsigned int get_header12(void) { return (header & 0xFFF0);};
    unsigned int get_header10(void) { return (header & 0xFFC0);};
    unsigned int get_header8(void) { return (header & 0xFF00);};
  };
 
  char* data = (char*)m_buffer;
  struct EvtHeader* evt = (struct EvtHeader*)data;
 
  while (1) {
    ulittle32_t* data32 = (ulittle32_t*)data;
    ulittle16_t* data16 = (ulittle16_t*)data;
    // Read 8 bytes header (group)
    int br = fh->read_data(data, 4);
    if (br <= 0) return br;
    unsigned int chunk_size = 0;
    if (evt->get_header8() == 0) {
      B2DEBUG(29, "Group Header $" << std::hex << evt->get_header10() << " Chunk size " << std::dec << evt->get_size());
      chunk_size = evt->get_size_group();
    } else {
      B2DEBUG(29, "Header $" << std::hex << evt->get_header12() << " Chunk size " << std::dec << evt->get_size());
      chunk_size = evt->get_size();
    }
    if (chunk_size <= 1) return 0;
    br = fh->read_data(data + 4, chunk_size * 4 - 4);
    if (br <= 0) return br;
    if (evt->get_header12() == 0xe230) {
      B2DEBUG(29, "File info " << std::hex << evt->get_header12() << " Events " << std::dec << data32[1]);
      continue;
    } else if (evt->get_header12() == 0xe100) {
      B2DEBUG(29, "Info Event " << std::hex << evt->get_header12() << " RunNr $" << std::hex << data32[1]);
      if (m_runNr == 0) m_runNr = data32[1]; // we assume it will not change within one file
      continue;
    } else if (evt->get_header10() == 0x0000) { // war 0x0020
      B2DEBUG(29, "Run Event Group " << std::hex << evt->get_header10() << " Magic $" << std::hex << data32[1]);
      continue;
    } else if (evt->get_header12() == 0xbb00) {
      B2DEBUG(29, "Run Event " << std::hex << evt->get_header12() << " Magic $" << std::hex << data32[1]);
      continue;
    } else if (evt->get_header10() == 0x0080) { // war 0x00A0
      int togo = chunk_size;
      B2DEBUG(29, "Data Event Group " << std::hex << evt->get_header10() << " TriggerNr $" << std::hex << data32[1]);
      triggernr = data32[1];
      togo -= 2;
      data32 += 2;
      data16 += 4;
      while (togo > 2) {
        B2DEBUG(29, "TOGO: " << togo);
        B2DEBUG(29, " ............... " << std::hex << data32[0] << " TriggerNr $" << std::hex << data32[1]);
        if (triggernr != data32[1]) B2ERROR("Trigger Nr does not match!");
        B2DEBUG(29, " ............... " << std::hex << data32[2]);
        togo -= 2;
        data32 += 2;
        data16 += 4;
        if ((data32[0] & 0xFFFF0000) == 0xCAFE0000) {
          int frames = (data32[0] & 0x3FF);
          B2DEBUG(29, "Frames: " << frames);
          int size = 0;
          bool nocrc = (data32[0] & 0x8000) != 0;
 
          if ((data32[0] & 0x4000) == 0) B2FATAL("large data fields not supported");
 
          togo--;
          data32++;
          data16 += 2;
          std::vector <unsigned int> m_onsen_header;

          std::vector <std::vector <unsigned char>> m_onsen_payload;
          int offset = ((frames + 1) & ~1);
 
          ulittle16_t* table16 = data16;
          if (!nocrc) {
            togo--; // jump over TOC CRC
            data32++;
            data16 += 2;
          }
 
          for (int i = 0; i < frames; i++) {
            //B2INFO(".... " << i << ": " << table16[i]); -> do we need this?
            size += table16[i];

            std::vector <unsigned char> m_current_frame;
 
            for (int j = 0; j < (int)table16[i] * 2; j++) {
              unsigned short w = data16[offset++];
              m_current_frame.push_back((unsigned char)(w >> 8));
              m_current_frame.push_back((unsigned char)(w));
            }
 
            if (nocrc) { // recalculate
              dhe_crc_32_type current_crc;
              current_crc.process_bytes(m_current_frame.data(), m_current_frame.size());
              unsigned int w = current_crc.checksum();
              m_current_frame.push_back((unsigned char)(w >> 24));
              m_current_frame.push_back((unsigned char)(w >> 16));
              m_current_frame.push_back((unsigned char)(w >> 8));
              m_current_frame.push_back((unsigned char)(w));
            }
 
            m_onsen_header.push_back(m_current_frame.size());
            m_onsen_payload.push_back(m_current_frame);
          }
          togo -= ((frames + 1) & ~1) / 2 + size;
          data32 += ((frames + 1) & ~1) / 2 + size;
          data16 += ((frames + 1) & ~1) + size * 2;
 
          if (nocrc) {
            togo--;
            data32++;
            data16 += 2;
          }
 
          m_rawPXD.appendNew(m_onsen_header, m_onsen_payload);
        }
      }// while ...
 
      // Update EventMetaData
      B2INFO("Set Meta: Exp " << m_expNr << " Run " << m_runNr << " TrgNr " << triggernr);
      m_eventMetaDataPtr.create();
      m_eventMetaDataPtr->setExperiment(m_expNr);
      m_eventMetaDataPtr->setRun(m_runNr);
      m_eventMetaDataPtr->setEvent(triggernr);
      // we cannot recover time tag here. this would need further decoding from DHH header
      // m_eventMetaDataPtr->setTime((unsigned long long int)((time_tag_hi<<1) +(time_tag_mid &0x8000?1:0))*1000000000+(int)std::round(tt / 0.127216));
 
      return 1;
    } else {
      B2ERROR("Undefine Header $" << std::hex << evt->get_header12());
      continue;
    }
    continue;
 
  }
  return 0;
}
 
void PXDReadRawBonnDAQModule::event()
{
  if (fh == 0) {
    B2ERROR("Unexpected close of dump file.");
    terminate();
    return;
  }
 
  // Get a record from file
  int stat;
  do {
    stat = readOneEvent();
    if (stat <= 0) {
      terminate();
      return;
    };
  } while (stat == 0);
 
  return;
}
 
void PXDReadRawBonnDAQModule::terminate()
{
  if (fh) {
    delete (fh);
    fh = 0;
  }
}