Belle II Software  release-05-01-25
RawHeader_latest.h
1 //+
2 // File : RawHeader_latest.h
3 // Description : Module to handle RawHeader_latest attached to raw data from COPPER
4 //
5 // Author : Satoru Yamada, IPNS, KEK
6 // Date : 2 - Aug - 2013
7 //-
8 
9 #ifndef RAWHEADER_LATEST_H
10 #define RAWHEADER_LATEST_H
11 
12 #include <stdio.h>
13 #include <string.h>
14 #include <rawdata/switch_basf2_standalone.h>
15 
16 
17 //#define HEADER_SIZE 16
18 
19 namespace Belle2 {
31  // class RawHeader_latest : public TObject {
33  public:
36 
38  RawHeader_latest(int*);
39 
42 
44  int* GetBuffer() { return m_buffer; }
45 
47  void SetBuffer(int* bufin) { m_buffer = bufin; }
48 
50  void CheckSetBuffer();
51 
53  void CheckGetBuffer();
54 
56  void SetNwords(int nwords);
57 
59  void SetEveNo(unsigned int eve_no);
60 
62  void SetNodeID(unsigned int node_id);
63 
65  void SetDataType(int data_type);
66 
68  void SetTruncMask(int trunc_mask);
69 
70  // void SetB2LFEEHdrPart(unsigned int word1, unsigned int word2); //! set contents of header
71  // void SetFTSW2Words(int* ftsw_buf);
72 
74  void SetFTSW2Words(unsigned int word1, unsigned int word2);
75 
77  void SetExpRunNumber(int* exprun_buf);
78 
80  void SetOffset1stFINESSE(int offset_1st_FINESSE);
81 
82  void SetOffset2ndFINESSE(int offset_2nd_FINESSE);
83 
84  void SetOffset3rdFINESSE(int offset_3rd_FINESSE);
85 
86  void SetOffset4thFINESSE(int offset_4th_FINESSE);
87 
88  // void SetMagicWordEntireHeader(); //! set magic words;
89 
91  // int AddNodeInfo(int node_id);
92 
93  int GetNwords();
94 
95  int GetHdrNwords();
96 
97  unsigned int GetExpRunSubrun();
98 
99  int GetExpNo();
100 
101  int GetRunNo();
102 
103  int GetSubRunNo();
104 
105  unsigned int GetEveNo();
106 
107  unsigned int GetNodeID();
108 
109  int GetDataType();
110 
111  int GetTruncMask();
112 
114  unsigned int GetErrorBitFlag();
115 
117  void AddErrorBitFlag(unsigned int error_bit_flag);
118 
120  int GetPacketCRCError();
121 
123  int GetEventCRCError();
124 
126  int GetOffset1stFINESSE();
127 
129  int GetOffset2ndFINESSE();
130 
132  int GetOffset3rdFINESSE();
133 
135  int GetOffset4thFINESSE();
136 
137  // int GetNumNodes(); //! get contents of header
138 
139  // int GetNodeInfo(int node_no, int* node_id); //! get contents of header
140 
142  unsigned int GetTTCtimeTRGType();
143 
145  int GetTTCtime();
146 
148  int GetTRGType();
149 
151  unsigned int GetTTUtime();
152 
154  void GetTTTimeVal(struct timeval* tv);
155 
157  // unsigned int GetMagicWordEntireHeader();
158 
160  void CheckHeader(int* buf);
161 
162  /*
163  Experimental(10bit) #, Run#(14bit), restat# bit mask(8bit)
164  */
165  enum {
166  MAGIC_WORD = 0x7F7F0000,
167  MAGIC_MASK = 0xFFFF0000,
168  MAGIC_SHIFT = 16,
169  FORMAT_VERSION__MASK = 0x0000FF00,
170  FORMAT_VERSION_SHIFT = 8
171  };
172 
173  enum {
174  EXP_MASK = 0xFFC00000,
175  EXP_SHIFT = 22,
176  RUNNO_MASK = 0x003FFF00,
177  RUNNO_SHIFT = 8,
178  SUBRUNNO_MASK = 0x000000FF
179  };
180 
181  enum {
182  RAWHEADER_NWORDS = 12
183  };
184 
185  enum {
186  HDR_NWORDS_MASK = 0x000000FF
187  };
188 
189  /* Data Format : Fixed length part*/
190  enum {
191  POS_NWORDS = 0,
192  POS_VERSION_HDRNWORDS = 1,
193  POS_EXP_RUN_NO = 2,
194  POS_EVE_NO = 3,
195  POS_TTCTIME_TRGTYPE = 4,
196  POS_TTUTIME = 5,
197  POS_NODE_ID = 6,
198  POS_TRUNC_MASK_DATATYPE = 7,
199  POS_OFFSET_1ST_FINESSE = 8,
200  POS_OFFSET_2ND_FINESSE = 9,
201  POS_OFFSET_3RD_FINESSE = 10,
202  POS_OFFSET_4TH_FINESSE = 11,
203  };
204 
205 
206  /* Data Format : Node info */
207  /* enum { */
208  /* NUM_MAX_NODES = 4 /\* (NUM_MAX_NODES + 1) slots are available in m_buffer. */
209  /* (NUM_MAX_NODES +1 )th slot is filled with -1, when the number of total nodes */
210  /* exceeds NUM_MAX_NODES *\/ */
211  /* }; */
212 
213  /* /\* Data Format : Magic word *\/ */
214  /* enum { */
215  /* MAGIC_WORD_TERM_HEADER = 0x7fff0005 */
216  /* }; */
217 
218 
219 
220  /* To extract ctime */
221  enum {
222  TTCTIME_MASK = 0x7FFFFFF0,
223  TTCTIME_SHIFT = 4,
224  TRGTYPE_MASK = 0xF
225  };
226 
227  /* Error bit in POS_TRUNC_MASK_DATATYPE */
228  /* Changed from the position of error bit to actual error value ( 0 -> 0x1, 1 -> 0x2 ) */
229  enum {
230  B2LINK_PACKET_CRC_ERROR = 0x1,
231  B2LINK_EVENT_CRC_ERROR = 0x2
232  };
233 
234  private:
236  int* m_buffer;
237 
239  // ver.2 Do not record m_buffer pointer. (Dec.19, 2014)
240  // ClassDef(RawHeader_latest, 1);
241  };
242 
243 
245  {
246  if (m_buffer == NULL) {
247  B2FATAL("m_buffer is NULL. Exiting...");
248  }
249  }
250 
252  {
253  if (m_buffer == NULL) {
254  B2FATAL("m_buffer is NULL. Data is corrupted or header info has not yet filled. Exiting...");
255 // } else if (m_buffer[ POS_TERM_HEADER ] != MAGIC_WORD_TERM_HEADER) {
256 // B2FATAL("magic word is invalid(0x"<< std::hex() << m_buffer[ POS_TERM_HEADER ] <<"). Data is corrupted or header info has not yet filled. Exiting...");
257  }
258  }
259 
260 
261  inline void RawHeader_latest::SetNwords(int nwords)
262  {
263  CheckSetBuffer();
264  m_buffer[ POS_NWORDS ] = nwords;
265 
266  }
267 
268  inline void RawHeader_latest::SetEveNo(unsigned int eve_no)
269  {
270  CheckSetBuffer();
271  m_buffer[ POS_EVE_NO ] = eve_no;
272  }
273 
274  inline void RawHeader_latest::SetNodeID(unsigned int node_id)
275  {
276  CheckSetBuffer();
277  m_buffer[ POS_NODE_ID ] = (int)node_id;
278  }
279 
280  inline void RawHeader_latest::SetDataType(int data_type)
281  {
282  CheckSetBuffer();
283  m_buffer[ POS_TRUNC_MASK_DATATYPE ] =
284  (data_type & 0x7FFFFFFF) | (m_buffer[ POS_TRUNC_MASK_DATATYPE ] & 0x80000000);
285  }
286 
287  inline void RawHeader_latest::SetTruncMask(int trunc_mask)
288  {
289  CheckSetBuffer();
290  m_buffer[ POS_TRUNC_MASK_DATATYPE ] = (trunc_mask << 31) | (m_buffer[ POS_TRUNC_MASK_DATATYPE ] & 0x7FFFFFFF);
291  }
292 
293  /* inline void RawHeader_latest::SetB2LFEEHdrPart(unsigned int word1, unsigned int word2) */
294  /* { */
295  /* m_buffer[ POS_HSLB_1 ] = word1; */
296  /* m_buffer[ POS_HSLB_2 ] = word2; */
297  /* } */
298 
299 
300  inline void RawHeader_latest::SetOffset1stFINESSE(int offset_1st_FINESSE)
301  {
302  CheckSetBuffer();
303  m_buffer[ POS_OFFSET_1ST_FINESSE ] = offset_1st_FINESSE;
304  }
305 
306  inline void RawHeader_latest::SetOffset2ndFINESSE(int offset_2nd_FINESSE)
307  {
308  CheckSetBuffer();
309  m_buffer[ POS_OFFSET_2ND_FINESSE ] = offset_2nd_FINESSE;
310  }
311 
312  inline void RawHeader_latest::SetOffset3rdFINESSE(int offset_3rd_FINESSE)
313  {
314  CheckSetBuffer();
315  m_buffer[ POS_OFFSET_3RD_FINESSE ] = offset_3rd_FINESSE;
316  }
317 
318  inline void RawHeader_latest::SetOffset4thFINESSE(int offset_4th_FINESSE)
319  {
320  CheckSetBuffer();
321  m_buffer[ POS_OFFSET_4TH_FINESSE ] = offset_4th_FINESSE;
322  }
323 
324  /* inline void RawHeader_latest::SetFTSW2Words(int* ftsw_buf) */
325  /* { */
326  /* CheckSetBuffer(); */
327  /* memcpy(&(m_buffer[ POS_HSLB_1 ]), (char*)ftsw_buf, sizeof(int) * 2); */
328  /* return; */
329  /* } */
330 
331  inline void RawHeader_latest::SetFTSW2Words(unsigned int word1,
332  unsigned int word2)
333  {
334  CheckSetBuffer();
335  m_buffer[ POS_TTCTIME_TRGTYPE ] = word1;
336  m_buffer[ POS_TTUTIME ] = word2;
337  return;
338  }
339 
340 
341  inline void RawHeader_latest::SetExpRunNumber(int* exprun_buf)
342  {
343  CheckSetBuffer();
344  memcpy(&(m_buffer[ POS_EXP_RUN_NO ]), (char*)exprun_buf, sizeof(int) * 1);
345  return;
346  }
347 
348 
349 //
350 // Obtain info
351 //
352 
354  {
355  CheckGetBuffer();
356  return m_buffer[ POS_NWORDS ];
357  }
358 
360  {
361 
362  // CheckGetBuffer();
363  // return m_buffer[ POS_HDR_NWORDS ];
364  return RAWHEADER_NWORDS;
365  }
366 
368  {
369  CheckGetBuffer();
370  return (((unsigned int)(m_buffer[ POS_EXP_RUN_NO ]) & EXP_MASK)
371  >> EXP_SHIFT);
372  }
373 
374 
376  {
377  CheckGetBuffer();
378  return (((unsigned int)(m_buffer[ POS_EXP_RUN_NO ]) & RUNNO_MASK)
379  >> RUNNO_SHIFT);
380  }
381 
383  {
384  CheckGetBuffer();
385  return (m_buffer[ POS_EXP_RUN_NO ] & SUBRUNNO_MASK);
386  }
387 
388  inline unsigned int RawHeader_latest::GetExpRunSubrun()
389  {
390  CheckGetBuffer();
391  return ((unsigned int)(m_buffer[ POS_EXP_RUN_NO ]));
392  }
393 
394 
395  inline unsigned int RawHeader_latest::GetEveNo()
396  {
397  CheckGetBuffer();
398  return m_buffer[ POS_EVE_NO ];
399  }
400 
401  inline unsigned int RawHeader_latest::GetNodeID()
402  {
403  CheckGetBuffer();
404  return (unsigned int)m_buffer[ POS_NODE_ID ];
405  }
406 
408  {
409  CheckGetBuffer();
410  return (m_buffer[ POS_TRUNC_MASK_DATATYPE ] & 0x7FFFFFFF);
411  }
412 
414  {
415  CheckGetBuffer();
416  return (m_buffer[ POS_TRUNC_MASK_DATATYPE ] >> 23) & 0x1;
417  }
418 
419  inline unsigned int RawHeader_latest::GetErrorBitFlag()
420  {
421  CheckGetBuffer();
422  return (unsigned int)(m_buffer[ POS_TRUNC_MASK_DATATYPE ]);
423  }
424 
425  inline void RawHeader_latest::AddErrorBitFlag(unsigned int error_bit_flag)
426  {
427  CheckGetBuffer();
428  m_buffer[ POS_TRUNC_MASK_DATATYPE ] |= (int)error_bit_flag;
429  return;
430  }
431 
433  {
434  CheckGetBuffer();
435  unsigned int temp_err_flag = GetErrorBitFlag();
436  if ((temp_err_flag & B2LINK_PACKET_CRC_ERROR) == 0) {
437  return 0;
438  }
439  return 1;
440  }
441 
443  {
444  CheckGetBuffer();
445  unsigned int temp_err_flag = GetErrorBitFlag();
446  if ((temp_err_flag & B2LINK_EVENT_CRC_ERROR) == 0) {
447  return 0;
448  }
449  return 1;
450  }
451 
453  {
454  CheckGetBuffer();
455  return m_buffer[ POS_OFFSET_1ST_FINESSE ];
456  }
457 
459  {
460  CheckGetBuffer();
461  return m_buffer[ POS_OFFSET_2ND_FINESSE ];
462  }
463 
465  {
466  CheckGetBuffer();
467  return m_buffer[ POS_OFFSET_3RD_FINESSE ];
468  }
469 
471  {
472  CheckGetBuffer();
473  return m_buffer[ POS_OFFSET_4TH_FINESSE ];
474  }
475 
476  /* inline int RawHeader_latest::GetNumNodes() */
477  /* { */
478  /* CheckGetBuffer(); */
479  /* return m_buffer[ POS_NUM_NODES ]; */
480  /* } */
481 
483  {
484  CheckGetBuffer();
485  return (unsigned int)(m_buffer[ POS_TTCTIME_TRGTYPE ]);
486  }
487 
489  {
490  CheckGetBuffer();
491  return (int)((GetTTCtimeTRGType() & TTCTIME_MASK) >> TTCTIME_SHIFT);
492  }
493 
495  {
496  CheckGetBuffer();
497  return (int)(GetTTCtimeTRGType() & TRGTYPE_MASK);
498  }
499 
500  inline unsigned int RawHeader_latest::GetTTUtime()
501  {
502  CheckGetBuffer();
503  return (unsigned int)(m_buffer[ POS_TTUTIME ]);
504  }
505 
506  inline void RawHeader_latest::GetTTTimeVal(struct timeval* tv)
507  {
508  tv->tv_sec = GetTTUtime();
509  tv->tv_usec = (int)(((double)GetTTCtime()) / 127.216);
510  return ;
511  }
512 
513 
514  /* inline unsigned int RawHeader_latest::GetMagicWordEntireHeader() */
515  /* { */
516  /* CheckGetBuffer(); */
517  /* return m_buffer[ POS_TERM_HEADER ]; */
518  /* } */
519 
520 
521 
522 
523 
525 }
526 
527 #endif
Belle2::RawHeader_latest::GetPacketCRCError
int GetPacketCRCError()
Get Packet CRC error flag.
Definition: RawHeader_latest.h:432
Belle2::RawHeader_latest::GetDataType
int GetDataType()
get contents of header
Definition: RawHeader_latest.h:407
Belle2::RawHeader_latest::GetRunNo
int GetRunNo()
get contents of header
Definition: RawHeader_latest.h:375
Belle2::RawHeader_latest::GetOffset1stFINESSE
int GetOffset1stFINESSE()
get contents of header
Definition: RawHeader_latest.h:452
Belle2::RawHeader_latest::SetOffset1stFINESSE
void SetOffset1stFINESSE(int offset_1st_FINESSE)
set contents of header
Definition: RawHeader_latest.h:300
Belle2::RawHeader_latest::GetExpNo
int GetExpNo()
get a run/exp number combined word
Definition: RawHeader_latest.h:367
Belle2::RawHeader_latest::GetTRGType
int GetTRGType()
get TRGType
Definition: RawHeader_latest.h:494
Belle2::RawHeader_latest::GetTTCtime
int GetTTCtime()
get contents of header
Definition: RawHeader_latest.h:488
Belle2::RawHeader_latest::GetTTTimeVal
void GetTTTimeVal(struct timeval *tv)
get contents of header
Definition: RawHeader_latest.h:506
Belle2::RawHeader_latest::CheckGetBuffer
void CheckGetBuffer()
check if m_buffer exists
Definition: RawHeader_latest.h:251
Belle2::RawHeader_latest::SetNodeID
void SetNodeID(unsigned int node_id)
set contents of header
Definition: RawHeader_latest.h:274
Belle2::RawHeader_latest::GetOffset4thFINESSE
int GetOffset4thFINESSE()
get contents of header
Definition: RawHeader_latest.h:470
Belle2::RawHeader_latest::GetTTCtimeTRGType
unsigned int GetTTCtimeTRGType()
get contents of header
Definition: RawHeader_latest.h:482
Belle2::RawHeader_latest::GetBuffer
int * GetBuffer()
Get header contents.
Definition: RawHeader_latest.h:44
Belle2::RawHeader_latest
The Raw Header class ver.1 ( the latest version since May, 2014 ) This class defines the format of th...
Definition: RawHeader_latest.h:32
Belle2::RawHeader_latest::GetTruncMask
int GetTruncMask()
get contents of header
Definition: RawHeader_latest.h:413
Belle2::RawHeader_latest::GetSubRunNo
int GetSubRunNo()
get run # (14bit)
Definition: RawHeader_latest.h:382
Belle2::RawHeader_latest::GetHdrNwords
int GetHdrNwords()
get contents of header
Definition: RawHeader_latest.h:359
Belle2::RawHeader_latest::SetEveNo
void SetEveNo(unsigned int eve_no)
set contents of header
Definition: RawHeader_latest.h:268
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::RawHeader_latest::GetNwords
int GetNwords()
set contents of header
Definition: RawHeader_latest.h:353
Belle2::RawHeader_latest::GetEveNo
unsigned int GetEveNo()
get restart #(8bit)
Definition: RawHeader_latest.h:395
Belle2::RawHeader_latest::RawHeader_latest
RawHeader_latest()
Default constructor.
Definition: RawHeader_latest.cc:16
Belle2::RawHeader_latest::CheckSetBuffer
void CheckSetBuffer()
initialize header
Definition: RawHeader_latest.h:244
Belle2::RawHeader_latest::GetTTUtime
unsigned int GetTTUtime()
get contents of header
Definition: RawHeader_latest.h:500
Belle2::RawHeader_latest::SetFTSW2Words
void SetFTSW2Words(unsigned int word1, unsigned int word2)
Set values of FTSW info( trigger timing)
Definition: RawHeader_latest.h:331
Belle2::RawHeader_latest::SetDataType
void SetDataType(int data_type)
set contents of header
Definition: RawHeader_latest.h:280
Belle2::RawHeader_latest::~RawHeader_latest
~RawHeader_latest()
Destructor.
Definition: RawHeader_latest.cc:28
Belle2::RawHeader_latest::GetOffset3rdFINESSE
int GetOffset3rdFINESSE()
get contents of header
Definition: RawHeader_latest.h:464
Belle2::RawHeader_latest::m_buffer
int * m_buffer
do not record buffer ( RawCOPPER includes buffer of RawHeader_latest and RawTrailer )
Definition: RawHeader_latest.h:236
Belle2::RawHeader_latest::AddErrorBitFlag
void AddErrorBitFlag(unsigned int error_bit_flag)
Add Detected Error bitflag.
Definition: RawHeader_latest.h:425
Belle2::RawHeader_latest::SetNwords
void SetNwords(int nwords)
set contents of header
Definition: RawHeader_latest.h:261
Belle2::RawHeader_latest::SetBuffer
void SetBuffer(int *bufin)
set buffer
Definition: RawHeader_latest.h:47
Belle2::RawHeader_latest::SetExpRunNumber
void SetExpRunNumber(int *exprun_buf)
Set a word consists of exp #, run # and subrun #.
Definition: RawHeader_latest.h:341
Belle2::RawHeader_latest::SetOffset2ndFINESSE
void SetOffset2ndFINESSE(int offset_2nd_FINESSE)
set contents of header
Definition: RawHeader_latest.h:306
Belle2::RawHeader_latest::GetNodeID
unsigned int GetNodeID()
get contents of header
Definition: RawHeader_latest.h:401
Belle2::RawHeader_latest::CheckHeader
void CheckHeader(int *buf)
Get magic word to check the data corruption.
Definition: RawHeader_latest.cc:61
Belle2::RawHeader_latest::SetOffset4thFINESSE
void SetOffset4thFINESSE(int offset_4th_FINESSE)
set contents of header
Definition: RawHeader_latest.h:318
Belle2::RawHeader_latest::SetTruncMask
void SetTruncMask(int trunc_mask)
set contents of header
Definition: RawHeader_latest.h:287
Belle2::RawHeader_latest::GetOffset2ndFINESSE
int GetOffset2ndFINESSE()
get contents of header
Definition: RawHeader_latest.h:458
Belle2::RawHeader_latest::GetErrorBitFlag
unsigned int GetErrorBitFlag()
get contents of header
Definition: RawHeader_latest.h:419
Belle2::RawHeader_latest::GetExpRunSubrun
unsigned int GetExpRunSubrun()
get contents of header
Definition: RawHeader_latest.h:388
Belle2::RawHeader_latest::SetOffset3rdFINESSE
void SetOffset3rdFINESSE(int offset_3rd_FINESSE)
set contents of header
Definition: RawHeader_latest.h:312
Belle2::RawHeader_latest::GetEventCRCError
int GetEventCRCError()
Get Detected Error bitflag.
Definition: RawHeader_latest.h:442