DCCDataParser.cc

Go to the documentation of this file.

#include "DCCDataParser.h"

/*----------------------------------------------*/
/* DCCTBDataParser::DCCTBDataParser                 */
/* class constructor                            */
/*----------------------------------------------*/
DCCTBDataParser::DCCTBDataParser(const std::vector<uint32_t> &parserParameters, bool parseInternalData, bool debug)
    : buffer_(nullptr), parseInternalData_(parseInternalData), debug_(debug), parameters(parserParameters) {
  mapper_ = new DCCTBDataMapper(this);  //build a new data mapper
  resetErrorCounters();                 //restart error counters
  computeBlockSizes();                  //calculate block sizes
}

/*----------------------------------------------*/
/* DCCTBDataParser::resetErrorCounters            */
/* resets error counters                        */
/*----------------------------------------------*/
void DCCTBDataParser::resetErrorCounters() {
  //set error counters to 0
  errors_["DCC::BOE"] = 0;           //begin of event (header B[60-63])
  errors_["DCC::EOE"] = 0;           //end of event (trailer B[60-63])
  errors_["DCC::EVENT LENGTH"] = 0;  //event length (trailer B[32-55])
}

/*----------------------------------------------*/
/* DCCTBDataParser::computeBlockSizes             */
/* calculate the size of TCC and SR blocks      */
/*----------------------------------------------*/
void DCCTBDataParser::computeBlockSizes() {
  uint32_t nTT = numbTTs();                  //gets the number of the trigger towers (default:68)
  uint32_t tSamples = numbTriggerSamples();  //gets the number of trigger time samples (default: 1)
  uint32_t nSr = numbSRF();                  //gests the number of SR flags (default:68)

  uint32_t tf(0), srf(0);

  if ((nTT * tSamples) < 4 || (nTT * tSamples) % 4)
    tf = 1;  //test is there is no TTC primitives or if it's a multiple of 4?
  else
    tf = 0;

  if (srf < 16 || srf % 16)
    srf = 1;  //??? by default srf=0 why do we make this test ?????
  else
    srf = 0;

  //TTC block size: header (8 bytes) + 17 words with 4 trigger primitives (17*8bytes)
  tccBlockSize_ = 8 + ((nTT * tSamples) / 4) * 8 + tf * 8;

  //SR block size: header (8 bytes) + 4 words with 16 SR flags + 1 word with 4 SR flags (5*8bytes)
  srpBlockSize_ = 8 + (nSr / 16) * 8 + srf * 8;
}

/*------------------------------------------------*/
/* DCCTBDataParser::parseFile                       */
/* reada data from file and parse it              */
/*------------------------------------------------*/
void DCCTBDataParser::parseFile(std::string fileName, bool singleEvent) {
  std::ifstream inputFile;  //open file as input
  inputFile.open(fileName.c_str());

  resetErrorCounters();  //reset error counters

  //for debug purposes
  //std::cout << "Now in DCCTBDataParser::parseFile " << std::endl;

  //if file opened correctly read data to a buffer and parse it
  //else throw an exception
  if (!inputFile.fail()) {
    std::string myWord;                   //word read from line
    std::vector<std::string> dataVector;  //data vector

    //until the end of file read each line as a string and add it to the data vector
    while (inputFile >> myWord) {
      dataVector.push_back(myWord);
    }

    bufferSize_ = (dataVector.size()) * 4;  //buffer size in bytes (note:each char is an hex number)

    uint32_t *myData = new uint32_t[dataVector.size()];  //allocate memory for a new data buffer
    uint32_t *const myDataBeginning = myData;            //pointer that stays at the beginning of the allocated memory

    //fill buffer data with data from file lines
    for (uint32_t i = 1; i <= dataVector.size(); i++, myData++) {
      sscanf((dataVector[i - 1]).c_str(), "%x", myData);

      //for debug purposes
      //std::cout << std::endl << "Data position: " << dec << i << " val = " << getHexString(*myData);
    }

    inputFile.close();  //close file

    parseBuffer(myData, bufferSize_, singleEvent);  //parse data from the newly filled myData
    delete[] myDataBeginning;
  } else {
    std::string errorMessage = std::string(" Error::Unable to open file :") + fileName;
    throw ECALTBParserException(errorMessage);
  }
}

/*----------------------------------------------------------*/
/* DCCTBDataParser::parseBuffer                               */
/* parse data from a buffer                                 */
/*----------------------------------------------------------*/
void DCCTBDataParser::parseBuffer(const uint32_t *buffer, uint32_t bufferSize, bool singleEvent) {
  resetErrorCounters();  //reset error counters

  buffer_ = buffer;  //set class buffer

  //clear stored data
  processedEvent_ = 0;
  events_.clear();
  std::vector<DCCTBEventBlock *>::iterator it;
  for (it = dccEvents_.begin(); it != dccEvents_.end(); it++) {
    delete *it;
  }
  dccEvents_.clear();
  eventErrors_ = "";

  //for debug purposes
  //std::cout << std::endl << "Now in DCCTBDataParser::parseBuffer" << std::endl;
  //std::cout << std::endl << "Buffer Size:" << dec << bufferSize << std::endl;

  //check if we have a coherent buffer size
  if (bufferSize % 8) {
    std::string fatalError;
    fatalError += "\n ======================================================================";
    fatalError += "\n Fatal error at event = " + getDecString(events_.size() + 1);
    fatalError += "\n Buffer Size of = " + getDecString(bufferSize) + "[bytes] is not divisible by 8 ... ";
    fatalError += "\n ======================================================================";
    throw ECALTBParserException(fatalError);
  }
  if (bufferSize < EMPTYEVENTSIZE) {
    std::string fatalError;
    fatalError += "\n ======================================================================";
    fatalError += "\n Fatal error at event = " + getDecString(events_.size() + 1);
    fatalError += "\n Buffer Size of = " + getDecString(bufferSize) + "[bytes] is less than an empty event ... ";
    fatalError += "\n ======================================================================";
    throw ECALTBParserException(fatalError);
  }

  const uint32_t *myPointer = buffer_;

  //  uint32_t processedBytes(0), wordIndex(0), lastEvIndex(0),eventSize(0), eventLength(0), errorMask(0);
  uint32_t processedBytes(0), wordIndex(0), eventLength(0), errorMask(0);

  //parse until there are no more events
  while (processedBytes + EMPTYEVENTSIZE <= bufferSize) {
    //for debug purposes
    //std::cout << "-> processedBytes.  =   " << dec << processedBytes << std::endl;
    //std::cout << " -> Processed Event index =   " << dec << processedEvent_ << std::endl;
    //std::cout << "-> First ev.word    = 0x" << hex << (*myPointer) << std::endl;
    //std::cout << "-> word index       =   " << dec << wordIndex << std::endl;

    //check if Event Length is coherent /////////////////////////////////////////
    uint32_t bytesToEnd = bufferSize - processedBytes;
    std::pair<uint32_t, uint32_t> eventD = checkEventLength(myPointer, bytesToEnd, singleEvent);
    eventLength = eventD.second;
    errorMask = eventD.first;

    //for debug purposes
    //std::cout <<" -> EventSizeBytes        =   " << dec << eventLength*8 << std::endl;

    //for debug purposes debug
    //std::cout<<std::endl;
    //std::cout<<" out... Bytes To End.... =   "<<dec<<bytesToEnd<<std::endl;
    //std::cout<<" out... Processed Event  =   "<<dec<<processedEvent_<<std::endl;
    //std::cout<<" out... Event Length     =   "<<dec<<eventLength<<std::endl;
    //std::cout<<" out... LastWord         = 0x"<<hex<<*(myPointer+eventLength*2-1)<<std::endl;

    if (parseInternalData_) {
      //build a new event block from buffer
      DCCTBEventBlock *myBlock =
          new DCCTBEventBlock(this, myPointer, eventLength * 8, eventLength * 2 - 1, wordIndex, 0);

      //add event to dccEvents vector
      dccEvents_.push_back(myBlock);
    }

    //build the event pointer with error mask and add it to the events vector
    std::pair<const uint32_t *, uint32_t> eventPointer(myPointer, eventLength);
    std::pair<uint32_t, std::pair<const uint32_t *, uint32_t> > eventPointerWithErrorMask(errorMask, eventPointer);
    events_.push_back(eventPointerWithErrorMask);

    //update processed buffer size
    processedEvent_++;
    processedBytes += eventLength * 8;
    //std::cout << std::endl << "Processed Bytes = " << dec << processedBytes << std::endl;

    //go to next event
    myPointer += eventLength * 2;
    wordIndex += eventLength * 2;
  }
}

/*---------------------------------------------*/
/* DCCTBDataParser::checkEventLength             */
/* check if event length is consistent with    */
/* the words written in buffer                 */
/* returns a 3 bit error mask codified as:     */
/*   bit 1 - BOE error                         */
/*   bit 2 - EVENT LENGTH error                */
/*   bit 3 - EOE Error                         */
/* and the event length                        */
/*---------------------------------------------*/
std::pair<uint32_t, uint32_t> DCCTBDataParser::checkEventLength(const uint32_t *pointerToEvent,
                                                                uint32_t bytesToEnd,
                                                                bool singleEvent) {
  std::pair<uint32_t, uint32_t> result;  //returns error mask and event length
  uint32_t errorMask(0);                 //error mask to return

  //check begin of event (BOE bits field)
  //(Note: we have to add one to read the 2nd 32 bit word where BOE is written)
  const uint32_t *boePointer = pointerToEvent + 1;
  if ((((*boePointer) >> BOEBEGIN) & BOEMASK) != BOE) {
    (errors_["DCC::BOE"])++;
    errorMask = 1;
  }

  //get Event Length from buffer (Note: we have to add two to read the 3rd 32 bit word where EVENT LENGTH is written)
  const uint32_t *myPointer = pointerToEvent + 2;
  uint32_t eventLength = (*myPointer) & EVENTLENGTHMASK;

  // std::cout << " Event Length(from decoding) = " << dec << eventLength << "... bytes to end... " << bytesToEnd << ", event numb : " << processedEvent_ << std::endl;

  bool eoeError = false;

  //check if event is empty but but EVENT LENGTH is not corresponding to it
  if (singleEvent && eventLength != bytesToEnd / 8) {
    eventLength = bytesToEnd / 8;
    (errors_["DCC::EVENT LENGTH"])++;
    errorMask = errorMask | (1 << 1);
  }
  //check if event length mismatches the number of words written as data
  else if (eventLength == 0 || eventLength > (bytesToEnd / 8) || eventLength < (EMPTYEVENTSIZE / 8)) {
    // How to handle bad event length in multiple event buffers
    // First approach : Send an exception
    // Second aproach : Try to find the EOE (To be done? If yes check dataDecoder tBeam implementation)
    std::string fatalError;

    fatalError += "\n ======================================================================";
    fatalError += "\n Fatal error at event = " + getDecString(events_.size() + 1);
    fatalError += "\n Decoded event length = " + getDecString(eventLength);
    fatalError += "\n bytes to buffer end  = " + getDecString(bytesToEnd);
    fatalError += "\n Unable to procead the data decoding ...";

    if (eventLength > (bytesToEnd / 8)) {
      fatalError += " (eventLength > (bytesToEnd / 8)";
    } else {
      fatalError += "\n event length not big enough heaven to build an empty event ( 4x8 bytes)";
    }

    fatalError += "\n ======================================================================";

    throw ECALTBParserException(fatalError);
  }

  //check end of event (EOE bits field)
  //(Note: event length is multiplied by 2 because its written as 32 bit words and not 64 bit words)
  const uint32_t *endOfEventPointer = pointerToEvent + eventLength * 2 - 1;
  if ((((*endOfEventPointer) >> EOEBEGIN & EOEMASK) != EOEMASK) && !eoeError) {
    (errors_["DCC::EOE"])++;
    errorMask = errorMask | (1 << 2);
  }

  //build result to return
  result.first = errorMask;
  result.second = eventLength;

  return result;
}

/*----------------------------------------------*/
/* DCCTBDataParser::index                         */
/* build an index string                        */
/*----------------------------------------------*/
std::string DCCTBDataParser::index(uint32_t position) {
  char indexBuffer[20];
  long unsigned int pos = position;
  snprintf(
      indexBuffer, sizeof(indexBuffer), "W[%08lu]", pos);  //build an index string for display purposes, p.e.  W[15]

  return std::string(indexBuffer);
}

/*-----------------------------------------------*/
/* DCCTBDataParser::getDecString                   */
/* print decimal data to a string                */
/*-----------------------------------------------*/
std::string DCCTBDataParser::getDecString(uint32_t dat) {
  char buffer[15];
  long unsigned int data = dat;
  snprintf(buffer, sizeof(buffer), "%lu", data);

  return std::string(buffer);
}

/*-------------------------------------------------*/
/* DCCTBDataParser::getHexString                     */
/* print data in hexadecimal base to a string      */
/*-------------------------------------------------*/
std::string DCCTBDataParser::getHexString(uint32_t data) {
  char buffer[15];
  snprintf(buffer, sizeof(buffer), "0x%08x", (uint16_t)(data));

  return std::string(buffer);
}

/*------------------------------------------------*/
/* DCCTBDataParser::getIndexedData                  */
/* build a string with index and data             */
/*------------------------------------------------*/
std::string DCCTBDataParser::getIndexedData(uint32_t position, uint32_t *pointer) {
  std::string ret;

  //char indexBuffer[20];
  //char dataBuffer[20];
  //sprintf(indexBuffer,"W[%08u] = ",position);
  //sprintf(dataBuffer,"0x%08x",*pointer);
  //ret = std::string(indexBuffer)+std::string(dataBuffer);

  ret = index(position) + getHexString(*pointer);

  return ret;
}

/*-------------------------------------------------*/
/* DCCTBDataParser::~DCCTBDataParser                   */
/* destructor                                      */
/*-------------------------------------------------*/
DCCTBDataParser::~DCCTBDataParser() {
  // delete DCCTBEvents if any...
  std::vector<DCCTBEventBlock *>::iterator it;
  for (it = dccEvents_.begin(); it != dccEvents_.end(); it++) {
    delete *it;
  }
  dccEvents_.clear();

  delete mapper_;
}