RawCOPPERFormat Class Reference

The Raw COPPER class This class stores data received by COPPER via belle2linkt Data from all detectors except PXD are stored in this class. More...

#include <RawCOPPERFormat.h>

Inheritance diagram for RawCOPPERFormat:

Public Types
enum	{   POS_NWORDS = 0 ,   POS_NODE_ID = 6 }
enum	{   POS_FTSW_ID_OLD = 5 ,   TEMP_POS_NWORDS_HEADER = 1 ,   OLD_FTSW_NWORDS_HEADER = 6 }

Public Member Functions
virtual	~RawCOPPERFormat ()
	Constructor using existing pointer to raw data buffer.
virtual int	GetDetectorNwords (int n, int finesse_num)=0
	set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )
virtual int	Get1stDetectorNwords (int n)=0
	get Detector buffer length of slot A
virtual int	Get2ndDetectorNwords (int n)=0
	get Detector buffer length of slot B
virtual int	Get3rdDetectorNwords (int n)=0
	get Detector buffer length of slot C
virtual int	Get4thDetectorNwords (int n)=0
	get Detector buffer length of slot D
virtual int *	GetDetectorBuffer (int n, int finesse_num)
	get Detector buffer
virtual int *	Get1stDetectorBuffer (int n)=0
	get Detector buffer of slot A
virtual int *	Get2ndDetectorBuffer (int n)=0
	get Detector Buffer of slot B
virtual int *	Get3rdDetectorBuffer (int n)=0
	get Detector Buffer of slot C
virtual int *	Get4thDetectorBuffer (int n)=0
	get Detector Buffer of slot D
virtual int *	GetRawHdrBufPtr (int n)
	get buffer pointer of rawcopper header(Currently same as GetBufferPos)
virtual int *	GetRawTrlBufPtr (int n)=0
	get buffer pointer of rawcopper trailer
virtual int *	GetFINESSEBuffer (int n, int finesse_num)
	get FINESSE buffer pointer
virtual int *	Get1stFINESSEBuffer (int n)
	get FINESSE buffer pointer for slot A
virtual int *	Get2ndFINESSEBuffer (int n)
	get FINESSE buffer pointer for slot B
virtual int *	Get3rdFINESSEBuffer (int n)
	get FINESSE buffer pointer for slot C
virtual int *	Get4thFINESSEBuffer (int n)
	get FINESSE buffer pointer for slot D
virtual int	GetExpNo (int n)=0
	get Experimental # from header
virtual unsigned int	GetExpRunSubrun (int n)=0
	get Experimental # from header
virtual int	GetRunNo (int n)=0
	Exp# (10bit) run# (14bit) restart # (8bit)
virtual int	GetSubRunNo (int n)=0
	get run # (14bit)
virtual unsigned int	GetEveNo (int n)=0
	get subrun #(8bit)
virtual int	GetDataType (int n)=0
	get contents of header
virtual int	GetTruncMask (int n)=0
	get contents of header
virtual unsigned int	GetErrorBitFlag (int n)=0
	get contents of header
virtual void	AddErrorBitFlag (int n, unsigned int error_bit_flag)=0
	Add Detected Error bitflag.
virtual int	GetPacketCRCError (int n)
	check CRC packet Error
virtual int	GetEventCRCError (int n)
	check CRC event Error
virtual int	GetEventCRC16Value (int n, int finesse_num)
	Get Event CRC16 value.
virtual unsigned int	GetNodeID (int n)=0
	get node-ID from data
virtual unsigned int	GetCOPPERCounter (int n)=0
	get COPPER counter(not event number)
virtual int	GetNumFINESSEBlock (int n)=0
	get # of FINNESEs which contains data
virtual int	GetOffsetFINESSE (int n, int finesse)
	get # of offset words
virtual int	GetOffset1stFINESSE (int n)=0
	get # of offset words for FINESSE slot A buffer position
virtual int	GetOffset2ndFINESSE (int n)
	get # of offset words for FINESSE slot B buffer position
virtual int	GetOffset3rdFINESSE (int n)
	get # of offset words for FINESSE slot C buffer position
virtual int	GetOffset4thFINESSE (int n)
	get # of offset words for FINESSE slot D buffer position
virtual int	GetFINESSENwords (int n, int finesse)=0
	get data size of FINESSE buffer
virtual int	Get1stFINESSENwords (int n)=0
	get data size of FINESSE slot A buffer
virtual int	Get2ndFINESSENwords (int n)=0
	get data size of FINESSE slot B buffer
virtual int	Get3rdFINESSENwords (int n)=0
	get data size of FINESSE slot C buffer
virtual int	Get4thFINESSENwords (int n)=0
	get data size of FINESSE slot D buffer
virtual int *	GetExpRunSubrunBuf (int n)=0
	get b2l block from "FEE b2link header"
virtual unsigned int	GetB2LFEE32bitEventNumber (int n)=0
	get b2l block from "FEE b2link header"
virtual unsigned int	GetMagicDriverHeader (int n)=0
	get magic word of COPPER driver header
virtual unsigned int	GetMagicFPGAHeader (int n)=0
	get magic word of COPPER FPGA header
virtual unsigned int	GetMagicFPGATrailer (int n)=0
	get magic word of COPPER FPGA trailer
virtual unsigned int	GetMagicDriverTrailer (int n)=0
	get magic word of COPPER driver trailer
virtual unsigned int	GetTrailerChksum (int n)=0
	Get checksum in RawTrailer.
virtual bool	CheckCOPPERMagic (int n)=0
	Check if COPPER Magic words are correct.
virtual unsigned int	GetTTCtimeTRGType (int n)=0
	Check if COPPER Magic words are correct.
virtual unsigned int	GetTTUtime (int n)=0
	Check if COPPER Magic words are correct.
virtual unsigned int	FillTopBlockRawHeader (unsigned int m_node_id, unsigned int prev_eve32, unsigned int prev_exprunsubrun_no, unsigned int *cur_exprunsubrun_no)=0
	should be called by DeSerializerCOPPER.cc and fill contents in RawHeader
virtual unsigned int	GetDriverChkSum (int n)=0
	read COPPER driver's checksum value
virtual unsigned int	CalcDriverChkSum (int n)=0
	calc COPPER driver's checksum value
virtual void	CheckData (int n, unsigned int prev_evenum, unsigned int *cur_evenum, unsigned int prev_copper_ctr, unsigned int *cur_copper_ctr, unsigned int prev_exprunsubrun_no, unsigned int *cur_exprunsubrun_no)=0
	check data contents
virtual void	CheckUtimeCtimeTRGType (int n)=0
	check data contents
virtual int	GetTTCtime (int n)=0
	Get ctime.
virtual int	GetTRGType (int n)=0
	Get trgtype.
virtual void	GetTTTimeVal (int n, struct timeval *tv)=0
	Get timeval.
virtual unsigned int	CalcXORChecksum (int *buf, int nwords)
	calc XOR checksum
virtual int *	PackDetectorBuf (int *packed_buf_nwords, int *detector_buf_1st, int nwords_1st, int *detector_buf_2nd, int nwords_2nd, int *detector_buf_3rd, int nwords_3rd, int *detector_buf_4th, int nwords_4th, RawCOPPERPackerInfo rawcprpacker_info)=0
	Pack data (format ver. = -1 -> Select the latest format version)
virtual int *	PackDetectorBuf (int *packed_buf_nwords, int *const(&detector_buf_ch)[MAX_PCIE40_CH], int const(&nwords_ch)[MAX_PCIE40_CH], RawCOPPERPackerInfo rawcpr_info)
	Pack data for PCIe40 data-format.
virtual int	GetMaxNumOfCh (int n)=0
	Get the max number of channels in a readout board.
virtual void	CompareHeaderValue (int n, const unsigned int(&input_val)[MAX_PCIE40_CH], std::vector< std::vector< unsigned int > > &result)
	Compare value from different channels and make a statistics table.
virtual void	GetNodeName (int n, char *node_name, int bufsize)
	Get hostname of a node from the RawCOPPER header.
virtual void	GetNodeName (char *node_name, unsigned int node_id, int bufsize)
	Get hostname of a node from an argument.
virtual bool	CheckOnlineRemovedDataBit (int n, int finesse_num)
	Check if COPPER Magic words are correct.
virtual void	SetBuffer (int *bufin, int nwords, int delete_flag, int num_events, int num_nodes)
	set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )
virtual int	TotalBufNwords ()
	Get total length of m_buffer.
virtual int	GetBufferPos (int n)
	get position of data block in word
virtual int *	GetBuffer (int n)
	get nth buffer pointer
virtual int *	GetWholeBuffer ()
	get pointer to buffer(m_buffer)
virtual int	GetNumEntries ()
	get # of data blocks = (# of nodes)*(# of events)
virtual int	GetNumNodes ()
	get # of data sources(e.g. # of COPPER boards) in m_buffer
virtual int	GetNumEvents ()
	get # of events in m_buffer
virtual int	GetPreAllocFlag ()
	get malloc_flag
virtual int	GetBlockNwords (int n)
	get size of a data block
virtual int	CheckFTSWID (int n)
	get FTSW ID to check whether this data block is FTSW data or not
virtual int	CheckTLUID (int n)
	get FTSW ID to check whether this data block is FTSW data or not
virtual void	CopyBlock (int n, int *buf_to)
	Copy one datablock to buffer.
virtual void	PrintData (int *buf, int nwords)
	print data

Protected Attributes
int	m_nwords
	number of words of buffer
int	m_num_nodes
	number of nodes in this object
int	m_num_events
	number of events in this object
int *	m_buffer
	Buffer.
int	m_use_prealloc_buf
	not recorded

Detailed Description

The Raw COPPER class This class stores data received by COPPER via belle2linkt Data from all detectors except PXD are stored in this class.

Definition at line 54 of file RawCOPPERFormat.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Definition at line 75 of file RawDataBlockFormat.h.

         {
      POS_NWORDS = 0,
      POS_NODE_ID = 6
    };

anonymous enum

anonymous enum

inherited

Definition at line 80 of file RawDataBlockFormat.h.

         {
      // Tentatively needed to distinguish new and old FTSW format, which will be changed in Nov. 2013
      POS_FTSW_ID_OLD = 5,
      TEMP_POS_NWORDS_HEADER = 1,
      OLD_FTSW_NWORDS_HEADER = 6
    };

Constructor & Destructor Documentation

RawCOPPERFormat()

RawCOPPERFormat

(

)

Definition at line 16 of file RawCOPPERFormat.cc.

{
//   m_nwords = 0;
//   m_num_nodes = 0;
//   m_num_events = 0;
//   m_buffer = NULL;
}

~RawCOPPERFormat()

virtual ~RawCOPPERFormat ( )

inlinevirtual

Constructor using existing pointer to raw data buffer.

Destructor

Definition at line 62 of file RawCOPPERFormat.h.

{}

Member Function Documentation

AddErrorBitFlag()

virtual void AddErrorBitFlag ( int  n, unsigned int  error_bit_flag  )

pure virtual

Add Detected Error bitflag.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

CalcDriverChkSum()

virtual unsigned int CalcDriverChkSum ( int  n )

pure virtual

calc COPPER driver's checksum value

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

CalcXORChecksum()

unsigned int CalcXORChecksum ( int *  buf, int  nwords  )

virtual

calc XOR checksum

Definition at line 24 of file RawCOPPERFormat.cc.

{
  unsigned int checksum = 0;
  for (int i = 0; i < nwords; i++) {
    checksum = checksum ^ buf[ i ];
  }
  return checksum;
}

CheckCOPPERMagic()

virtual bool CheckCOPPERMagic ( int  n )

pure virtual

Check if COPPER Magic words are correct.

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

CheckData()

virtual void CheckData ( int  n, unsigned int  prev_evenum, unsigned int *  cur_evenum, unsigned int  prev_copper_ctr, unsigned int *  cur_copper_ctr, unsigned int  prev_exprunsubrun_no, unsigned int *  cur_exprunsubrun_no  )

pure virtual

check data contents

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

CheckFTSWID()

int CheckFTSWID ( int  n )

virtualinherited

get FTSW ID to check whether this data block is FTSW data or not

Definition at line 73 of file RawDataBlockFormat.cc.

{
  int pos = POS_NODE_ID;
  if (m_buffer[ GetBufferPos(n) + TEMP_POS_NWORDS_HEADER ] == OLD_FTSW_NWORDS_HEADER) {
    pos =  POS_FTSW_ID_OLD;
  }
 
  if ((m_buffer[ GetBufferPos(n) + pos ] & 0xffffff00) == 0x54544400) {     // "TTD" + format version ( 0x20=DESY, 0x31=2018/7/11)
    return 1;
  } else {
    return 0;
  }
}

CheckOnlineRemovedDataBit()

bool CheckOnlineRemovedDataBit ( int  n, int  finesse_num  )

virtual

Check if COPPER Magic words are correct.

Reimplemented in PostRawCOPPERFormat_latest, and PreRawCOPPERFormat_latest.

Definition at line 217 of file RawCOPPERFormat.cc.

{
  char err_buf[500];
  sprintf(err_buf,
          "[FATAL] This function is not supported in the version of RawCOPPER format that you're using. n=%d fin=%d : %s %s %d: Exiting...\n",
          n, finesse_num, __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s\n", err_buf); fflush(stdout);
  B2FATAL(err_buf);
  return -1;
}

CheckTLUID()

int CheckTLUID ( int  n )

virtualinherited

get FTSW ID to check whether this data block is FTSW data or not

Definition at line 88 of file RawDataBlockFormat.cc.

{
  int pos = POS_NODE_ID;
  if (m_buffer[ GetBufferPos(n) + TEMP_POS_NWORDS_HEADER ] == OLD_FTSW_NWORDS_HEADER) {
    pos =  POS_FTSW_ID_OLD;
  }
  if (m_buffer[ GetBufferPos(n) + pos ] == 0x544c5520) { // "TLU "
    return 1;
  } else {
    return 0;
  }
}

CheckUtimeCtimeTRGType()

virtual void CheckUtimeCtimeTRGType ( int  n )

pure virtual

check data contents

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

CompareHeaderValue()

void CompareHeaderValue ( int  n, const unsigned int(&)  input_val[MAX_PCIE40_CH], std::vector< std::vector< unsigned int > > &  result  )

virtual

Compare value from different channels and make a statistics table.

Reimplemented in RawCOPPERFormat_latest.

Definition at line 170 of file RawCOPPERFormat.cc.

{
  char err_buf[500];
  sprintf(err_buf,
          "[FATAL] This function is not supported in the version of  RawCOPPER format that you're using. : %s %s %d: Exiting...\n", __FILE__,
          __PRETTY_FUNCTION__, __LINE__);
  printf("%s\n", err_buf); fflush(stdout);
  B2FATAL(err_buf);
  return;
}

CopyBlock()

void CopyBlock ( int  n, int *  buf_to  )

virtualinherited

Copy one datablock to buffer.

Definition at line 173 of file RawDataBlockFormat.cc.

{
  memcpy(buf_to, GetBuffer(n), GetBlockNwords(n) * sizeof(int));
  return;
}

FillTopBlockRawHeader()

virtual unsigned int FillTopBlockRawHeader ( unsigned int  m_node_id, unsigned int  prev_eve32, unsigned int  prev_exprunsubrun_no, unsigned int *  cur_exprunsubrun_no  )

pure virtual

should be called by DeSerializerCOPPER.cc and fill contents in RawHeader

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

Get1stDetectorBuffer()

virtual int * Get1stDetectorBuffer ( int  n )

pure virtual

get Detector buffer of slot A

Implemented in PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, RawCOPPERFormat_v0, and RawCOPPERFormat_latest.

Get1stDetectorNwords()

virtual int Get1stDetectorNwords ( int  n )

pure virtual

get Detector buffer length of slot A

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get1stFINESSENwords()

virtual int Get1stFINESSENwords ( int  n )

pure virtual

get data size of FINESSE slot A buffer

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get2ndDetectorBuffer()

virtual int * Get2ndDetectorBuffer ( int  n )

pure virtual

get Detector Buffer of slot B

Implemented in PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, RawCOPPERFormat_v0, and RawCOPPERFormat_latest.

Get2ndDetectorNwords()

virtual int Get2ndDetectorNwords ( int  n )

pure virtual

get Detector buffer length of slot B

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get2ndFINESSENwords()

virtual int Get2ndFINESSENwords ( int  n )

pure virtual

get data size of FINESSE slot B buffer

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get3rdDetectorBuffer()

virtual int * Get3rdDetectorBuffer ( int  n )

pure virtual

get Detector Buffer of slot C

Implemented in PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, RawCOPPERFormat_v0, and RawCOPPERFormat_latest.

Get3rdDetectorNwords()

virtual int Get3rdDetectorNwords ( int  n )

pure virtual

get Detector buffer length of slot C

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get3rdFINESSENwords()

virtual int Get3rdFINESSENwords ( int  n )

pure virtual

get data size of FINESSE slot C buffer

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get4thDetectorBuffer()

virtual int * Get4thDetectorBuffer ( int  n )

pure virtual

get Detector Buffer of slot D

Implemented in PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, RawCOPPERFormat_v0, and RawCOPPERFormat_latest.

Get4thDetectorNwords()

virtual int Get4thDetectorNwords ( int  n )

pure virtual

get Detector buffer length of slot D

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

Get4thFINESSENwords()

virtual int Get4thFINESSENwords ( int  n )

pure virtual

get data size of FINESSE slot D buffer

Implemented in RawCOPPERFormat_v0, RawCOPPERFormat_v1, RawCOPPERFormat_v2, and RawCOPPERFormat_latest.

GetB2LFEE32bitEventNumber()

virtual unsigned int GetB2LFEE32bitEventNumber ( int  n )

pure virtual

get b2l block from "FEE b2link header"

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetBlockNwords()

int GetBlockNwords ( int  n )

virtualinherited

get size of a data block

Definition at line 107 of file RawDataBlockFormat.cc.

{
  int size;
  if (n == (m_num_events * m_num_nodes) - 1) {
    size =  m_nwords - GetBufferPos(n);
  } else {
    size = GetBufferPos(n + 1) - GetBufferPos(n);
  }
  return size;
}

GetBuffer()

int * GetBuffer ( int  n )

virtualinherited

get nth buffer pointer

Definition at line 124 of file RawDataBlockFormat.cc.

{
  int pos_nwords = GetBufferPos(n);
  return &(m_buffer[ pos_nwords ]);
}

GetBufferPos()

int GetBufferPos ( int  n )

virtualinherited

get position of data block in word

Definition at line 30 of file RawDataBlockFormat.cc.

{
  if (m_buffer == NULL || m_nwords <= 0) {
    char err_buf[500];
    sprintf(err_buf, "[FATAL] RawPacket buffer(%p) is not available or length(%d) is not set.\n %s %s %d\n",
            m_buffer, m_nwords, __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  if (n >= (m_num_events * m_num_nodes)) {
    char err_buf[500];
    sprintf(err_buf, "[FATAL] Invalid COPPER block No. (%d : max %d ) is specified. Exiting... \n %s %s %d\n",
            n, (m_num_events * m_num_nodes), __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  int pos_nwords = 0;
  for (int i = 1; i <= n ; i++) {
    if (m_buffer[ pos_nwords ] <= 0) {
      char err_buf[500];
      sprintf(err_buf,
              "[FATAL] ERROR_EVENT : length of this data block is strange ( %d words ). Maybe data is corrupted or RawHeader info has not been filled yet. Exiting...",
              m_buffer[ pos_nwords ]);
      printf("%s", err_buf);
      B2FATAL(err_buf);
    } else {
      pos_nwords +=      m_buffer[ pos_nwords ];
    }
    if (pos_nwords >= m_nwords) {
      char err_buf[500];
      sprintf(err_buf, "[FATAL] ERROR_EVENT : value of pos_nwords(%d) is larger than m_nwords(%d). Exiting...\n %s %s %d\n",
              pos_nwords, m_nwords, __FILE__, __PRETTY_FUNCTION__, __LINE__);
      printf("%s", err_buf); fflush(stdout);
      B2FATAL(err_buf); // to reduce multiple error messages
    }
  }
  return pos_nwords;
 
}

GetCOPPERCounter()

virtual unsigned int GetCOPPERCounter ( int  n )

pure virtual

get COPPER counter(not event number)

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetDataType()

virtual int GetDataType ( int  n )

pure virtual

get contents of header

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetDetectorBuffer()

int * GetDetectorBuffer ( int  n, int  finesse_num  )

virtual

get Detector buffer

Reimplemented in PostRawCOPPERFormat_latest, and PreRawCOPPERFormat_latest.

Definition at line 94 of file RawCOPPERFormat.cc.

{
  switch (finesse_num) {
    case 0 :
      return Get1stDetectorBuffer(n);
      break;
    case 1 :
      return Get2ndDetectorBuffer(n);
      break;
    case 2 :
      return Get3rdDetectorBuffer(n);
      break;
    case 3 :
      return Get4thDetectorBuffer(n);
      break;
    default :
      break;
  }
 
  char err_buf[500];
  sprintf(err_buf, "[FATAL] Specifined FINESSE number( = %d ) is invalid. Exiting...\n%s %s %d\n", finesse_num,
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s", err_buf); fflush(stdout);
  B2FATAL(err_buf);
}

GetDetectorNwords()

virtual int GetDetectorNwords ( int  n, int  finesse_num  )

pure virtual

set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )

get Detector buffer length

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetDriverChkSum()

virtual unsigned int GetDriverChkSum ( int  n )

pure virtual

read COPPER driver's checksum value

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetErrorBitFlag()

virtual unsigned int GetErrorBitFlag ( int  n )

pure virtual

get contents of header

Get Detected Error bitflag

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetEveNo()

virtual unsigned int GetEveNo ( int  n )

pure virtual

get subrun #(8bit)

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetEventCRC16Value()

int GetEventCRC16Value ( int  n, int  finesse_num  )

virtual

Get Event CRC16 value.

Reimplemented in PostRawCOPPERFormat_latest, and PostRawCOPPERFormat_v2.

Definition at line 145 of file RawCOPPERFormat.cc.

{
  char err_buf[500];
  sprintf(err_buf,
          "[FATAL] This function is not supported in the version of  RawCOPPER format that you're using. n=%d fin=%d : %s %s %d: Exiting...\n",
          n, finesse_num, __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s\n", err_buf); fflush(stdout);
  B2FATAL(err_buf);
  return -1;
}

GetEventCRCError()

int GetEventCRCError ( int  n )

virtual

check CRC event Error

Reimplemented in RawCOPPERFormat_latest, and RawCOPPERFormat_v2.

Definition at line 134 of file RawCOPPERFormat.cc.

{
  char err_buf[500];
  sprintf(err_buf,
          "[FATAL] This function is not supported in the version of  RawCOPPER format that you're using. n=%d : %s %s %d: Exiting...\n",
          n, __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s\n", err_buf); fflush(stdout);
  B2FATAL(err_buf);
  return -1;
}

GetExpNo()

virtual int GetExpNo ( int  n )

pure virtual

get Experimental # from header

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetExpRunSubrun()

virtual unsigned int GetExpRunSubrun ( int  n )

pure virtual

get Experimental # from header

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetExpRunSubrunBuf()

virtual int * GetExpRunSubrunBuf ( int  n )

pure virtual

get b2l block from "FEE b2link header"

get b2l block from "FEE b2link header"

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetFINESSEBuffer()

int * GetFINESSEBuffer ( int  n, int  finesse_num  )

virtual

get FINESSE buffer pointer

Reimplemented in RawCOPPERFormat_latest.

Definition at line 65 of file RawCOPPERFormat.cc.

{
  switch (finesse_num) {
    case 0 :
      return Get1stFINESSEBuffer(n);
      break;
    case 1 :
      return Get2ndFINESSEBuffer(n);
      break;
    case 2 :
      return Get3rdFINESSEBuffer(n);
      break;
    case 3 :
      return Get4thFINESSEBuffer(n);
      break;
    default :
      break;
  }
 
  char err_buf[500];
  sprintf(err_buf, "[FATAL] Specifined FINESSE number( = %d ) is invalid. Exiting...\n%s %s %d\n", finesse_num,
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s", err_buf); fflush(stdout);
  B2FATAL(err_buf);
}

GetFINESSENwords()

virtual int GetFINESSENwords ( int  n, int  finesse  )

pure virtual

get data size of FINESSE buffer

Implemented in PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, RawCOPPERFormat_v0, and RawCOPPERFormat_latest.

GetMagicDriverHeader()

virtual unsigned int GetMagicDriverHeader ( int  n )

pure virtual

get magic word of COPPER driver header

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetMagicDriverTrailer()

virtual unsigned int GetMagicDriverTrailer ( int  n )

pure virtual

get magic word of COPPER driver trailer

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetMagicFPGAHeader()

virtual unsigned int GetMagicFPGAHeader ( int  n )

pure virtual

get magic word of COPPER FPGA header

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetMagicFPGATrailer()

virtual unsigned int GetMagicFPGATrailer ( int  n )

pure virtual

get magic word of COPPER FPGA trailer

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetMaxNumOfCh()

virtual int GetMaxNumOfCh ( int  n )

pure virtual

Get the max number of channels in a readout board.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetNodeID()

virtual unsigned int GetNodeID ( int  n )

pure virtual

get node-ID from data

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetNodeName() [1/2]

void GetNodeName ( char *  node_name, unsigned int  node_id, int  bufsize  )

virtual

Get hostname of a node from an argument.

Definition at line 200 of file RawCOPPERFormat.cc.

{
  if (node_name == NULL || node_id == 0 || bufsize < 20) {
    char err_buf[500];
    sprintf(err_buf,
            "[FATAL] Null pointer or strange node_id(%.8x)in an argument of this function. Exiting... : \n%s %s %d\n",
            node_id,
            __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf); // to reduce multiple error messages
  } else {
    sprintf(node_name, "cpr%u",
            (10 * (node_id >> 28) + (node_id >> 24)) * 1000 +
            (node_id & COPPERID_MASK));
  }
}

GetNodeName() [2/2]

void GetNodeName ( int  n, char *  node_name, int  bufsize  )

virtual

Get hostname of a node from the RawCOPPER header.

Definition at line 182 of file RawCOPPERFormat.cc.

{
  unsigned int node_id = GetNodeID(n);
  if (node_name == NULL || node_id == 0 || bufsize < 20) {
    char err_buf[500];
    sprintf(err_buf,
            "[FATAL] Null pointer or strange node_id(%.8x)in an argument of this function. Exiting... : \n%s %s %d\n",
            node_id,
            __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf); // to reduce multiple error messages
  } else {
    sprintf(node_name, "cpr%u",
            (10 * (node_id >> 28) + (node_id >> 24)) * 1000 +
            (node_id & COPPERID_MASK));
  }
}

GetNumEntries()

virtual int GetNumEntries ( )

inlinevirtualinherited

get # of data blocks = (# of nodes)*(# of events)

Definition at line 49 of file RawDataBlockFormat.h.

{ return m_num_events * m_num_nodes; }

GetNumEvents()

virtual int GetNumEvents ( )

inlinevirtualinherited

get # of events in m_buffer

Definition at line 55 of file RawDataBlockFormat.h.

{ return m_num_events; }

GetNumFINESSEBlock()

virtual int GetNumFINESSEBlock ( int  n )

pure virtual

get # of FINNESEs which contains data

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetNumNodes()

virtual int GetNumNodes ( )

inlinevirtualinherited

get # of data sources(e.g. # of COPPER boards) in m_buffer

Definition at line 52 of file RawDataBlockFormat.h.

{ return m_num_nodes; }

GetOffset1stFINESSE()

virtual int GetOffset1stFINESSE ( int  n )

pure virtual

get # of offset words for FINESSE slot A buffer position

Implemented in PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, RawCOPPERFormat_v0, and RawCOPPERFormat_latest.

GetOffsetFINESSE()

int GetOffsetFINESSE ( int  n, int  finesse  )

virtual

get # of offset words

Definition at line 36 of file RawCOPPERFormat.cc.

{
  switch (finesse_num) {
    case 0 :
      return GetOffset1stFINESSE(n);
      break;
    case 1 :
      return GetOffset2ndFINESSE(n);
      break;
    case 2 :
      return GetOffset3rdFINESSE(n);
      break;
    case 3 :
      return GetOffset4thFINESSE(n);
      break;
    default :
      break;
  }
 
  char err_buf[500];
  sprintf(err_buf, "[FATAL] Specifined FINESSE number( = %d ) is invalid. Exiting...\n%s %s %d\n", finesse_num,
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s", err_buf); fflush(stdout);
  B2FATAL(err_buf);
}

GetPacketCRCError()

int GetPacketCRCError ( int  n )

virtual

check CRC packet Error

Reimplemented in RawCOPPERFormat_latest, and RawCOPPERFormat_v2.

Definition at line 122 of file RawCOPPERFormat.cc.

{
  char err_buf[500];
  sprintf(err_buf,
          "[FATAL] This function is not supported in the version of  RawCOPPER format that you're using. n=%d : %s %s %d: Exiting...\n",
          n, __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("%s\n", err_buf); fflush(stdout);
  B2FATAL(err_buf);
  return -1;
}

GetPreAllocFlag()

virtual int GetPreAllocFlag ( )

inlinevirtualinherited

get malloc_flag

Definition at line 58 of file RawDataBlockFormat.h.

{ return m_use_prealloc_buf; }

GetRawTrlBufPtr()

virtual int * GetRawTrlBufPtr ( int  n )

pure virtual

get buffer pointer of rawcopper trailer

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetRunNo()

virtual int GetRunNo ( int  n )

pure virtual

Exp# (10bit) run# (14bit) restart # (8bit)

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetSubRunNo()

virtual int GetSubRunNo ( int  n )

pure virtual

get run # (14bit)

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetTrailerChksum()

virtual unsigned int GetTrailerChksum ( int  n )

pure virtual

Get checksum in RawTrailer.

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

GetTRGType()

virtual int GetTRGType ( int  n )

pure virtual

Get trgtype.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetTruncMask()

virtual int GetTruncMask ( int  n )

pure virtual

get contents of header

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetTTCtime()

virtual int GetTTCtime ( int  n )

pure virtual

Get ctime.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetTTCtimeTRGType()

virtual unsigned int GetTTCtimeTRGType ( int  n )

pure virtual

Check if COPPER Magic words are correct.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetTTTimeVal()

virtual void GetTTTimeVal ( int  n, struct timeval *  tv  )

pure virtual

Get timeval.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetTTUtime()

virtual unsigned int GetTTUtime ( int  n )

pure virtual

Check if COPPER Magic words are correct.

Implemented in RawCOPPERFormat_latest, RawCOPPERFormat_v0, RawCOPPERFormat_v1, and RawCOPPERFormat_v2.

GetWholeBuffer()

int * GetWholeBuffer ( )

virtualinherited

get pointer to buffer(m_buffer)

Definition at line 119 of file RawDataBlockFormat.cc.

{
  return m_buffer;
}

PackDetectorBuf() [1/2]

int * PackDetectorBuf ( int *  packed_buf_nwords, int *const(&)  detector_buf_ch[MAX_PCIE40_CH], int const(&)  nwords_ch[MAX_PCIE40_CH], RawCOPPERPackerInfo  rawcpr_info  )

virtual

Pack data for PCIe40 data-format.

Reimplemented in PostRawCOPPERFormat_latest, and PreRawCOPPERFormat_latest.

Definition at line 156 of file RawCOPPERFormat.cc.

{
  char err_buf[500];
  sprintf(err_buf,
          "[FATAL] This function is not supported in the version of  RawCOPPER format that you're using. : %s %s %d: Exiting...\n", __FILE__,
          __PRETTY_FUNCTION__, __LINE__);
  printf("%s\n", err_buf); fflush(stdout);
  B2FATAL(err_buf);
  return NULL;
}

PackDetectorBuf() [2/2]

virtual int * PackDetectorBuf ( int *  packed_buf_nwords, int *  detector_buf_1st, int  nwords_1st, int *  detector_buf_2nd, int  nwords_2nd, int *  detector_buf_3rd, int  nwords_3rd, int *  detector_buf_4th, int  nwords_4th, RawCOPPERPackerInfo  rawcprpacker_info  )

pure virtual

Pack data (format ver. = -1 -> Select the latest format version)

Implemented in PostRawCOPPERFormat_latest, PostRawCOPPERFormat_v1, PostRawCOPPERFormat_v2, PreRawCOPPERFormat_latest, PreRawCOPPERFormat_v1, PreRawCOPPERFormat_v2, and RawCOPPERFormat_v0.

PrintData()

void PrintData ( int *  buf, int  nwords  )

virtualinherited

print data

Definition at line 161 of file RawDataBlockFormat.cc.

{
  printf("[DEBUG] ");
  for (int i = 0; i < nwords; i++) {
    printf("%.8x ", buf[ i ]);
    if (i % 10 == 9) printf("\n[DEBUG] ");
  }
  printf("\n[DEBUG] ");
  printf("\n");
  return;
}

SetBuffer()

void SetBuffer ( int *  bufin, int  nwords, int  delete_flag, int  num_events, int  num_nodes  )

virtualinherited

set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )

Definition at line 131 of file RawDataBlockFormat.cc.

{
 
  if (bufin == NULL) {
    char err_buf[500];
    sprintf(err_buf, "[DEBUG] bufin is NULL. Exting...\n");
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  if (!m_use_prealloc_buf && m_buffer != NULL) delete[] m_buffer;
 
  if (delete_flag == 0) {
    m_use_prealloc_buf = true;
  } else {
    m_use_prealloc_buf = false;
  }
 
  m_nwords = nwords;
  m_buffer = bufin;
 
  m_num_nodes = num_nodes;
  m_num_events = num_events;
 
  return;
 
}

TotalBufNwords()

int TotalBufNwords ( )

virtualinherited

Get total length of m_buffer.

Definition at line 101 of file RawDataBlockFormat.cc.

{
  return m_nwords;
}

Member Data Documentation

m_buffer

int* m_buffer

protectedinherited

Buffer.

Definition at line 98 of file RawDataBlockFormat.h.

m_num_events

int m_num_events

protectedinherited

number of events in this object

Definition at line 95 of file RawDataBlockFormat.h.

m_num_nodes

int m_num_nodes

protectedinherited

number of nodes in this object

Definition at line 92 of file RawDataBlockFormat.h.

m_nwords

int m_nwords

protectedinherited

number of words of buffer

Definition at line 89 of file RawDataBlockFormat.h.

m_use_prealloc_buf

int m_use_prealloc_buf

protectedinherited

not recorded

flag for deleting m_buffer in destructer( 0:delete, 1: not delete) When using pre-allocated buffer, the buffer should be reused and not deleted in the destructer

Definition at line 102 of file RawDataBlockFormat.h.

---

The documentation for this class was generated from the following files:

• rawdata/dataobjects/include/RawCOPPERFormat.h
• rawdata/dataobjects/src/RawCOPPERFormat.cc