RawHeader_v2.h

/**************************************************************************
 * 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.                  *
 **************************************************************************/
 
#ifndef RAWHEADER_V2_H
#define RAWHEADER_V2_H
 
#include <stdio.h>
#include <string.h>
#include <rawdata/switch_basf2_standalone.h>
 
 
//#define HEADER_SIZE 16
 
namespace Belle2 {

 
  //  class RawHeader_v2 : public TObject {
  class RawHeader_v2 {
  public:
    RawHeader_v2();

    explicit RawHeader_v2(int*);

    ~RawHeader_v2();

    int* GetBuffer() { return m_buffer; }

    void SetBuffer(int* bufin) { m_buffer = bufin; }

    void CheckSetBuffer();

    void CheckGetBuffer();

    void SetNwords(int nwords);

    void SetEveNo(unsigned int eve_no);

    void SetNodeID(unsigned int node_id);

    void SetDataType(int data_type);

    void SetTruncMask(int trunc_mask);
 
    //    void SetB2LFEEHdrPart(unsigned int word1, unsigned int word2);   //! set contents of header
    //     void SetFTSW2Words(int* ftsw_buf);

    void SetFTSW2Words(unsigned int word1, unsigned int word2);

    void SetExpRunNumber(int* exprun_buf);

    void SetOffset1stFINESSE(int offset_1st_FINESSE);    
 
    void SetOffset2ndFINESSE(int offset_2nd_FINESSE);    
 
    void SetOffset3rdFINESSE(int offset_3rd_FINESSE);    
 
    void SetOffset4thFINESSE(int offset_4th_FINESSE);    
 
    //    void SetMagicWordEntireHeader(); //! set magic words;

    //    int AddNodeInfo(int node_id);
 
    int GetNwords();  
 
    int GetHdrNwords();  
 
    unsigned int GetExpRunSubrun(); 
 
    int GetExpNo();  
 
    int GetRunNo();    
 
    int GetSubRunNo();    
 
    unsigned int GetEveNo();  
 
    unsigned int GetNodeID();  
 
    int GetDataType();  
 
    int GetTruncMask();  

    unsigned int GetErrorBitFlag();

    void AddErrorBitFlag(unsigned int error_bit_flag);

    int GetPacketCRCError();

    int GetEventCRCError();

    int GetOffset1stFINESSE();

    int GetOffset2ndFINESSE();

    int GetOffset3rdFINESSE();

    int GetOffset4thFINESSE();
 
    //    int GetNumNodes();  //! get contents of header
 
    //    int GetNodeInfo(int node_no, int* node_id);    //! get contents of header

    unsigned int GetTTCtimeTRGType();

    int GetTTCtime();

    int GetTRGType();

    unsigned int GetTTUtime();

    void GetTTTimeVal(struct  timeval* tv);

    //    unsigned int GetMagicWordEntireHeader();

    void CheckHeader(int* buf);
 
    /*
      Experimental(10bit) #, Run#(14bit), restat# bit mask(8bit)
    */
    enum {
      MAGIC_WORD = 0x7F7F0000,
      MAGIC_MASK = 0xFFFF0000,
      MAGIC_SHIFT = 16,
      FORMAT_VERSION__MASK = 0x0000FF00,
      FORMAT_VERSION_SHIFT = 8
    };
 
    enum {
      EXP_MASK = 0xFFC00000,
      EXP_SHIFT = 22,
      RUNNO_MASK = 0x003FFF00,
      RUNNO_SHIFT = 8,
      SUBRUNNO_MASK = 0x000000FF
    };
 
    enum {
      RAWHEADER_NWORDS = 12
    };
 
    enum {
      HDR_NWORDS_MASK = 0x000000FF
    };
 
    /* Data Format : Fixed length part*/
    enum {
      POS_NWORDS = 0,
      POS_VERSION_HDRNWORDS = 1,
      POS_EXP_RUN_NO = 2,
      POS_EVE_NO = 3,
      POS_TTCTIME_TRGTYPE = 4,
      POS_TTUTIME = 5,
      POS_NODE_ID = 6,
      POS_TRUNC_MASK_DATATYPE = 7,
      POS_OFFSET_1ST_FINESSE = 8,
      POS_OFFSET_2ND_FINESSE = 9,
      POS_OFFSET_3RD_FINESSE = 10,
      POS_OFFSET_4TH_FINESSE = 11,
    };
 
 
    /* Data Format : Node info */
    /*     enum { */
    /*       NUM_MAX_NODES = 4   /\* (NUM_MAX_NODES + 1) slots are available in m_buffer. */
    /*          (NUM_MAX_NODES +1 )th slot is filled with -1, when the number of total nodes */
    /*          exceeds NUM_MAX_NODES *\/ */
    /*     }; */
 
    /*     /\* Data Format : Magic word *\/ */
    /*     enum { */
    /*       MAGIC_WORD_TERM_HEADER = 0x7fff0005 */
    /*     }; */
 
 
 
    /* To extract ctime */
    enum {
      TTCTIME_MASK = 0x7FFFFFF0,
      TTCTIME_SHIFT = 4,
      TRGTYPE_MASK = 0xF
    };
 
    /* Error bit in POS_TRUNC_MASK_DATATYPE */
    /* Changed from the position of error bit to actual error value ( 0 -> 0x1, 1 -> 0x2 ) */
    enum {
      B2LINK_PACKET_CRC_ERROR = 0x1,
      B2LINK_EVENT_CRC_ERROR = 0x2
    };
 
  private:
    int* m_buffer; 

    // ver.2 Do not record m_buffer pointer. (Dec.19, 2014)
    //    ClassDef(RawHeader_v2, 1);
  };
 
 
  inline void RawHeader_v2::CheckSetBuffer()
  {
    if (m_buffer == NULL) {
      B2FATAL("m_buffer is NULL. Exiting...");
    }
  }
 
  inline void RawHeader_v2::CheckGetBuffer()
  {
    if (m_buffer == NULL) {
      B2FATAL("m_buffer is NULL. Data is corrupted or header info has not yet filled. Exiting...");
//  } else if (m_buffer[ POS_TERM_HEADER ] != MAGIC_WORD_TERM_HEADER) {
//    B2FATAL("magic word is invalid(0x"<< std::hex() << m_buffer[ POS_TERM_HEADER ] <<"). Data is corrupted or header info has not yet filled. Exiting...");
    }
  }
 
 
  inline void RawHeader_v2::SetNwords(int nwords)
  {
    CheckSetBuffer();
    m_buffer[ POS_NWORDS ] = nwords;
 
  }
 
  inline void RawHeader_v2::SetEveNo(unsigned int eve_no)
  {
    CheckSetBuffer();
    m_buffer[ POS_EVE_NO ] = eve_no;
  }
 
  inline void RawHeader_v2::SetNodeID(unsigned int node_id)
  {
    CheckSetBuffer();
    m_buffer[ POS_NODE_ID ] = (int)node_id;
  }
 
  inline void RawHeader_v2::SetDataType(int data_type)
  {
    CheckSetBuffer();
    m_buffer[ POS_TRUNC_MASK_DATATYPE ] =
      (data_type & 0x7FFFFFFF) | (m_buffer[ POS_TRUNC_MASK_DATATYPE ] & 0x80000000);
  }
 
  inline void RawHeader_v2::SetTruncMask(int trunc_mask)
  {
    CheckSetBuffer();
    /* cppcheck-suppress shiftTooManyBitsSigned */
    m_buffer[ POS_TRUNC_MASK_DATATYPE ] = (trunc_mask << 31) | (m_buffer[ POS_TRUNC_MASK_DATATYPE ] & 0x7FFFFFFF);
  }
 
  /*   inline void RawHeader_v2::SetB2LFEEHdrPart(unsigned int word1, unsigned int word2) */
  /*   { */
  /*     m_buffer[ POS_HSLB_1 ] = word1; */
  /*     m_buffer[ POS_HSLB_2 ] = word2; */
  /*   } */
 
 
  inline void RawHeader_v2::SetOffset1stFINESSE(int offset_1st_FINESSE)
  {
    CheckSetBuffer();
    m_buffer[ POS_OFFSET_1ST_FINESSE ] = offset_1st_FINESSE;
  }
 
  inline void RawHeader_v2::SetOffset2ndFINESSE(int offset_2nd_FINESSE)
  {
    CheckSetBuffer();
    m_buffer[ POS_OFFSET_2ND_FINESSE ] = offset_2nd_FINESSE;
  }
 
  inline void RawHeader_v2::SetOffset3rdFINESSE(int offset_3rd_FINESSE)
  {
    CheckSetBuffer();
    m_buffer[ POS_OFFSET_3RD_FINESSE ] = offset_3rd_FINESSE;
  }
 
  inline void RawHeader_v2::SetOffset4thFINESSE(int offset_4th_FINESSE)
  {
    CheckSetBuffer();
    m_buffer[ POS_OFFSET_4TH_FINESSE ] = offset_4th_FINESSE;
  }
 
  /*   inline void RawHeader_v2::SetFTSW2Words(int* ftsw_buf) */
  /*   { */
  /*     CheckSetBuffer(); */
  /*     memcpy(&(m_buffer[ POS_HSLB_1 ]), (char*)ftsw_buf, sizeof(int) * 2); */
  /*     return; */
  /*   } */
 
  inline void RawHeader_v2::SetFTSW2Words(unsigned int word1,
                                          unsigned int word2)
  {
    CheckSetBuffer();
    m_buffer[ POS_TTCTIME_TRGTYPE ] = word1;
    m_buffer[ POS_TTUTIME ] = word2;
    return;
  }
 
 
  inline void RawHeader_v2::SetExpRunNumber(int* exprun_buf)
  {
    CheckSetBuffer();
    memcpy(&(m_buffer[ POS_EXP_RUN_NO ]), (char*)exprun_buf, sizeof(int) * 1);
    return;
  }
 
 
//
// Obtain info
//
 
  inline int RawHeader_v2::GetNwords()
  {
    CheckGetBuffer();
    return m_buffer[ POS_NWORDS ];
  }
 
  inline int RawHeader_v2::GetHdrNwords()
  {
 
    //    CheckGetBuffer();
    //    return m_buffer[ POS_HDR_NWORDS ];
    return RAWHEADER_NWORDS;
  }
 
  inline int RawHeader_v2::GetExpNo()
  {
    CheckGetBuffer();
    return (((unsigned int)(m_buffer[ POS_EXP_RUN_NO ]) & EXP_MASK)
            >> EXP_SHIFT);
  }
 
 
  inline int RawHeader_v2::GetRunNo()
  {
    CheckGetBuffer();
    return (((unsigned int)(m_buffer[ POS_EXP_RUN_NO ]) & RUNNO_MASK)
            >> RUNNO_SHIFT);
  }
 
  inline int RawHeader_v2::GetSubRunNo()
  {
    CheckGetBuffer();
    return (m_buffer[ POS_EXP_RUN_NO ] & SUBRUNNO_MASK);
  }
 
  inline unsigned int RawHeader_v2::GetExpRunSubrun()
  {
    CheckGetBuffer();
    return ((unsigned int)(m_buffer[ POS_EXP_RUN_NO ]));
  }
 
 
  inline unsigned int RawHeader_v2::GetEveNo()
  {
    CheckGetBuffer();
    return m_buffer[ POS_EVE_NO ];
  }
 
  inline unsigned int RawHeader_v2::GetNodeID()
  {
    CheckGetBuffer();
    return (unsigned int)m_buffer[ POS_NODE_ID ];
  }
 
  inline int RawHeader_v2::GetDataType()
  {
    CheckGetBuffer();
    return (m_buffer[ POS_TRUNC_MASK_DATATYPE ] & 0x7FFFFFFF);
  }
 
  inline int RawHeader_v2::GetTruncMask()
  {
    CheckGetBuffer();
    return (m_buffer[ POS_TRUNC_MASK_DATATYPE ] >> 23) & 0x1;
  }
 
  inline unsigned int RawHeader_v2::GetErrorBitFlag()
  {
    CheckGetBuffer();
    return (unsigned int)(m_buffer[ POS_TRUNC_MASK_DATATYPE ]);
  }
 
  inline void RawHeader_v2::AddErrorBitFlag(unsigned int error_bit_flag)
  {
    CheckGetBuffer();
    m_buffer[ POS_TRUNC_MASK_DATATYPE ] |= (int)error_bit_flag;
    return;
  }
 
  inline int RawHeader_v2::GetPacketCRCError()
  {
    CheckGetBuffer();
    unsigned int temp_err_flag = GetErrorBitFlag();
    if ((temp_err_flag & B2LINK_PACKET_CRC_ERROR) == 0) {
      return 0;
    }
    return 1;
  }
 
  inline int RawHeader_v2::GetEventCRCError()
  {
    CheckGetBuffer();
    unsigned int temp_err_flag = GetErrorBitFlag();
    if ((temp_err_flag & B2LINK_EVENT_CRC_ERROR) == 0) {
      return 0;
    }
    return 1;
  }
 
  inline int RawHeader_v2::GetOffset1stFINESSE()
  {
    CheckGetBuffer();
    return m_buffer[ POS_OFFSET_1ST_FINESSE ];
  }
 
  inline int RawHeader_v2::GetOffset2ndFINESSE()
  {
    CheckGetBuffer();
    return m_buffer[ POS_OFFSET_2ND_FINESSE ];
  }
 
  inline int RawHeader_v2::GetOffset3rdFINESSE()
  {
    CheckGetBuffer();
    return m_buffer[ POS_OFFSET_3RD_FINESSE ];
  }
 
  inline int RawHeader_v2::GetOffset4thFINESSE()
  {
    CheckGetBuffer();
    return m_buffer[ POS_OFFSET_4TH_FINESSE ];
  }
 
  /*   inline int RawHeader_v2::GetNumNodes() */
  /*   { */
  /*     CheckGetBuffer(); */
  /*     return m_buffer[ POS_NUM_NODES ]; */
  /*   } */
 
  inline unsigned int RawHeader_v2::GetTTCtimeTRGType()
  {
    CheckGetBuffer();
    return (unsigned int)(m_buffer[ POS_TTCTIME_TRGTYPE ]);
  }
 
  inline int RawHeader_v2::GetTTCtime()
  {
    CheckGetBuffer();
    return (int)((GetTTCtimeTRGType() & TTCTIME_MASK) >> TTCTIME_SHIFT);
  }
 
  inline int RawHeader_v2::GetTRGType()
  {
    CheckGetBuffer();
    return (int)(GetTTCtimeTRGType() & TRGTYPE_MASK);
  }
 
  inline unsigned int RawHeader_v2::GetTTUtime()
  {
    CheckGetBuffer();
    return (unsigned int)(m_buffer[ POS_TTUTIME ]);
  }
 
  inline void RawHeader_v2::GetTTTimeVal(struct timeval* tv)
  {
    tv->tv_sec = GetTTUtime();
    tv->tv_usec = (int)(((double)GetTTCtime()) / 127.216);
    return ;
  }
 
 
  /*   inline unsigned int RawHeader_v2::GetMagicWordEntireHeader() */
  /*   { */
  /*     CheckGetBuffer(); */
  /*     return m_buffer[ POS_TERM_HEADER ]; */
  /*   } */
 
 
 
 

}
 
#endif