1 /**************************************************************************
2 * Copyright(c) 1998-2003, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
18 // Author: Cvetan Cheshkov 10/10/2005
20 //////////////////////////////////////////////////////////////////////////
22 // AliRawEventHeaderBase //
23 // This a new versioning scheme for raw data root-ification and reading //
24 // For details look at offline weekly meeting 20/10/2005 //
26 //////////////////////////////////////////////////////////////////////////
32 #include <TDataMember.h>
34 #include <TMethodCall.h>
37 #include "AliRawEventHeaderBase.h"
39 #include <Riostream.h>
43 ClassImp(AliRawEventHeaderBase)
45 //______________________________________________________________________________
46 AliRawEventHeaderBase::AliRawEventHeaderBase():
52 fExtendedAllocSize(0),
60 // Default constructor
63 //______________________________________________________________________________
64 void *AliRawEventHeaderBase::HeaderBegin() const
66 // Returns the pointer to the first data member
67 // beyond the base class data members
69 if (fHeaderBegin) return fHeaderBegin;
71 TList *datalist = IsA()->GetListOfDataMembers();
73 TDataMember *member = (TDataMember *)next();
75 if(!strcmp(member->GetTypeName(),"TClass"))
76 member = (TDataMember *)next();
78 void *ptr = (void *)((char *)this+member->GetOffset());
79 const_cast<AliRawEventHeaderBase*>(this)->fHeaderBegin = ptr;
84 //______________________________________________________________________________
85 Int_t AliRawEventHeaderBase::HeaderSize() const
87 // Returns the size of the data members list
88 // beyond the base class data members
90 if (fHeaderSize) return fHeaderSize;
94 TList *datalist = IsA()->GetListOfDataMembers();
97 while ((member=(TDataMember *)next()) != 0x0) {
98 if (!strcmp(member->GetTypeName(),"TClass")) continue;
99 UInt_t unitsize = member->GetUnitSize();
100 UInt_t ndim = member->GetArrayDim();
104 for(UInt_t i=0;i<ndim;i++) size += member->GetMaxIndex(i)*unitsize;
107 const_cast<AliRawEventHeaderBase*>(this)->fHeaderSize = size;
112 //______________________________________________________________________________
113 UInt_t AliRawEventHeaderBase::SwapWord(UInt_t x) const
115 // Swap the endianess of the integer value 'x'
117 return (((x & 0x000000ffU) << 24) | ((x & 0x0000ff00U) << 8) |
118 ((x & 0x00ff0000U) >> 8) | ((x & 0xff000000U) >> 24));
121 void AliRawEventHeaderBase::Swap()
123 // Swap base header data.
124 // Update the fIsSwapped flag which
125 // is then use to copy in an appropriate way
126 // the rest of the header data from the raw data stream
130 fSize = SwapWord(fSize);
131 fMagic = SwapWord(fMagic);
132 fHeadSize = SwapWord(fHeadSize);
133 fVersion = SwapWord(fVersion);
137 //______________________________________________________________________________
138 const char *AliRawEventHeaderBase::GetTypeName() const
140 // Get event type as a string.
141 // Will fail in case data header
142 // does not contain eventType field
143 UInt_t eventType = Get("Type");
145 return GetTypeName(eventType);
148 //______________________________________________________________________________
149 const char *AliRawEventHeaderBase::GetTypeName(UInt_t eventType)
151 // Get event type as a string.
152 // Static method that could be used
153 // from everywhere inside aliroot
157 return "START_OF_RUN";
162 case kStartOfRunFiles:
163 return "START_OF_RUN_FILES";
166 return "END_OF_RUN_FILES";
169 return "START_OF_BURST";
172 return "END_OF_BURST";
175 return "PHYSICS_EVENT";
177 case kCalibrationEvent:
178 return "CALIBRATION_EVENT";
181 return "EVENT_FORMAT_ERROR";
184 return "START_OF_DATA";
187 return "END_OF_DATA";
189 case kSystemSoftwareTriggerEvent:
190 return "SYSTEM_SOFTWARE_TRIGGER_EVENT";
192 case kDetectorSoftwareTriggerEvent:
193 return "DETECTOR_SOFTWARE_TRIGGER_EVENT";
196 return "UNKNOWN EVENT TYPE NUMBER";
201 //______________________________________________________________________________
202 AliRawEventHeaderBase* AliRawEventHeaderBase::Create(char*& data)
204 // Static method to create AliRawEventHeaderVX object
205 // The actual header class version is taken from the
208 // First create AlirawEVentHeaderBase class object
209 AliRawEventHeaderBase header;
211 // Copy the first common part of the raw data header
212 memcpy(header.HeaderBaseBegin(), data, header.HeaderBaseSize());
214 // Swap header data if needed
215 if (header.IsSwapped())
218 // Is header valid...
219 if (!header.IsValid()) {
220 AliFatalClass("Invalid header format!");
221 // try recovery... how?
225 if (header.GetEventSize() < (UInt_t)header.HeaderBaseSize()) {
226 AliFatalClass("Invalid header base size!");
227 // try recovery... how?
231 // Now check the DATE version and create the corresponding header
233 UInt_t version = header.GetVersion();
234 UInt_t majorversion = (version>>16)&0x0000ffff;
235 UInt_t minorversion = version&0x0000ffff;
237 classname.Form("AliRawEventHeaderV%d_%d",majorversion,minorversion);
239 TClass *tcl = TClass::GetClass(classname.Data());
241 AliFatalClass(Form("Unknown header version (%s)!",classname.Data()));
245 // header.Dump(); tcl->Dump();
247 AliRawEventHeaderBase *hdr = (AliRawEventHeaderBase *)tcl->New();
249 AliFatalClass(Form("Can not create object of class %s",classname.Data()));
253 // Copy the base header data members and initialize other data members
254 memcpy(hdr->HeaderBaseBegin(),header.HeaderBaseBegin(), header.HeaderBaseSize());
255 memset(hdr->HeaderBegin(),0, hdr->HeaderSize());
256 hdr->fIsSwapped = header.fIsSwapped;
259 if (hdr->GetEventSize() < ((UInt_t)hdr->HeaderBaseSize() + (UInt_t)hdr->HeaderSize())) {
260 AliFatalClass(Form("Invalid header size (%d < %d +%d)!",
261 hdr->GetEventSize(),hdr->HeaderBaseSize(),hdr->HeaderSize()));
262 // try recovery... how?
266 // Check for the presence of header extension and its size
267 Int_t extsize = (Int_t)hdr->GetHeadSize() - (hdr->HeaderBaseSize() + hdr->HeaderSize());
269 AliFatalClass(Form("Invalid header size (%d < %d +%d)!",
270 hdr->GetHeadSize(),hdr->HeaderBaseSize(),hdr->HeaderSize()));
271 // try recovery... how?
276 hdr->AllocateExtendedData(extsize);
283 void AliRawEventHeaderBase::SwapData(const void* inbuf, const void* outbuf, UInt_t size) {
284 // The method swaps the contents of the
285 // raw-data event header
286 UInt_t intCount = size/sizeof(UInt_t);
288 UInt_t* buf = (UInt_t*) inbuf; // temporary integers buffer
289 for (UInt_t i=0; i<intCount; i++, buf++) {
290 UInt_t value = SwapWord(*buf);
291 memcpy((UInt_t*)outbuf+i, &value, sizeof(UInt_t));
295 //______________________________________________________________________________
296 Int_t AliRawEventHeaderBase::ReadHeader(char*& data)
298 // Read header info from DATE data stream.
299 // Returns bytes read
301 Long_t start = (Long_t)data;
302 // Swap header data if needed
303 if (DataIsSwapped()) {
304 SwapData(data, HeaderBaseBegin(), HeaderBaseSize());
305 data += HeaderBaseSize();
306 SwapData(data, HeaderBegin(), HeaderSize());
307 data += HeaderSize();
310 memcpy(HeaderBaseBegin(), data, HeaderBaseSize());
311 data += HeaderBaseSize();
312 memcpy(HeaderBegin(), data, HeaderSize());
313 data += HeaderSize();
315 data += ReadExtendedData(data);
317 return (Int_t)((Long_t)data - start);
320 //______________________________________________________________________________
321 void AliRawEventHeaderBase::AllocateExtendedData(Int_t extsize)
323 // Allocate the space for the header
325 if (fExtendedData) delete [] fExtendedData;
327 fExtendedDataSize = fExtendedAllocSize = extsize;
328 fExtendedData = new char[fExtendedAllocSize];
329 memset(fExtendedData,0,fExtendedAllocSize);
332 //______________________________________________________________________________
333 Int_t AliRawEventHeaderBase::ReadExtendedData(char*& data)
335 // Read extended header data
336 // Reallocates memory if the present
337 // buffer is insufficient
338 Int_t extsize = (Int_t)GetHeadSize() - (HeaderBaseSize() + HeaderSize());
341 fExtendedDataSize = 0;
346 AliFatal(Form("Invalid header size (%d < %d +%d)!",
347 GetHeadSize(),HeaderBaseSize(),HeaderSize()));
348 // try recovery... how?
352 fExtendedDataSize = extsize;
353 if (fExtendedDataSize > fExtendedAllocSize)
354 AllocateExtendedData(fExtendedDataSize);
357 SwapData(data, fExtendedData, fExtendedDataSize);
359 memcpy(fExtendedData, data, fExtendedDataSize);
361 return fExtendedDataSize;
364 //______________________________________________________________________________
365 UInt_t AliRawEventHeaderBase::Get(const char *datamember) const
367 // The method to get a data member from the header object
368 // Except for the data members of the base class, all the
369 // other header data should be retrieved ONLY by this method
370 // The name of the data member should be supplied without "f"
374 strncat(buf,datamember,sizeof(buf)-2);
376 TDataMember *member = IsA()->GetDataMember(buf);
378 AliFatal(Form("No data member %s is found! Check the raw data version!",buf));
382 if (member->GetArrayDim() != 0) {
383 AliFatal(Form("Member %s is an array! Use the GetP() method!",buf));
387 if (strcmp(member->GetTypeName(),"UInt_t") != 0) {
388 AliFatal(Form("Member %s is not of type UInt_t!",buf));
392 const void *pointer = (char *)this+member->GetOffset();
394 return *((UInt_t *)pointer);
397 //______________________________________________________________________________
398 const UInt_t* AliRawEventHeaderBase::GetP(const char *datamember) const
400 // The method to get a data member from the header object
401 // Except for the data members of the base class, all the
402 // other header data should be retrieved ONLY by this method
403 // The name of the data member should be supplied without "f"
407 strncat(buf,datamember,sizeof(buf)-2);
409 TDataMember *member = IsA()->GetDataMember(buf);
411 AliFatal(Form("No data member %s is found! Check the raw data version!",buf));
415 // if (member->GetArrayDim() == 0) {
416 // AliFatal(Form("Member %s is not an array! Use the Get() method!",buf));
420 if (strcmp(member->GetTypeName(),"UInt_t") != 0) {
421 AliFatal(Form("Member %s is not of type UInt_t*!",buf));
425 const void *pointer = (char *)this+member->GetOffset();
427 return (const UInt_t*)pointer;
430 //_____________________________________________________________________________
431 void AliRawEventHeaderBase::Print( const Option_t* opt ) const
433 // Dumps the event or sub-event
436 cout << opt << " Event size: " << GetEventSize() << endl;
437 cout << opt << " Event header size: " << GetHeadSize() << endl;
438 cout << opt << " Event header version: " << GetMajorVersion() << "." << GetMinorVersion() << endl;
439 cout << opt << " Event type: " << Get("Type") << "( " << GetTypeName() << " )" << endl;
440 cout << opt << " Run Number: " << Get("RunNb") << endl;
441 const UInt_t *id = GetP("Id");
442 cout << opt << " Period: " << (((id)[0]>>4)&0x0fffffff) << " Orbit: " << ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff)) << " Bunch-crossing: " << ((id)[1]&0x00000fff) << endl;
443 cout << opt << " Trigger pattern: " << GetP("TriggerPattern")[0] << "-" << GetP("TriggerPattern")[1] << endl;
444 cout << opt << " Detector pattern: " << Get("DetectorPattern") << endl;
445 cout << opt << " Type attribute: " << GetP("TypeAttribute")[0] << "-" << GetP("TypeAttribute")[1] << "-" << GetP("TypeAttribute")[2] << endl;
446 cout << opt << " GDC: " << Get("GdcId") << " LDC: " << Get("LdcId") << endl;
449 //_____________________________________________________________________________
450 void AliRawEventHeaderBase::AddEqIndex(Int_t index)
452 // Adds an equipment by changing properly
453 // the first and last equipment indexes
454 if (fFirstEqIndex < 0) fFirstEqIndex = index;
455 if (index > fLastEqIndex) fLastEqIndex = index;
458 //_____________________________________________________________________________
459 void AliRawEventHeaderBase::Reset()
461 fFirstEqIndex = fLastEqIndex = -1;
464 //______________________________________________________________________________
465 void AliRawEventHeaderBase::Streamer(TBuffer &R__b)
467 // Stream an object of class AliRawEventHeaderBase.
469 if (R__b.IsReading()) {
471 Version_t R__v = R__b.ReadVersion(&R__s, &R__c);
473 R__b.ReadClassBuffer(AliRawEventHeaderBase::Class(),this,R__v,R__s,R__c);
476 TObject::Streamer(R__b);
481 R__b >> fExtendedDataSize;
482 delete [] fExtendedData;
483 fExtendedData = new char[fExtendedDataSize];
484 R__b.ReadFastArray(fExtendedData,fExtendedDataSize);
486 R__b.CheckByteCount(R__s, R__c, AliRawEventHeaderBase::IsA());
488 R__b.WriteClassBuffer(AliRawEventHeaderBase::Class(),this);