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>
35 #include <TDataType.h>
38 #include "AliRawEventHeaderBase.h"
40 #include <Riostream.h>
44 ClassImp(AliRawEventHeaderBase)
46 //______________________________________________________________________________
47 AliRawEventHeaderBase::AliRawEventHeaderBase():
53 fExtendedAllocSize(0),
61 // Default constructor
64 //______________________________________________________________________________
65 void *AliRawEventHeaderBase::HeaderBegin() const
67 // Returns the pointer to the first data member
68 // beyond the base class data members
70 if (fHeaderBegin) return fHeaderBegin;
72 TList *datalist = IsA()->GetListOfDataMembers();
74 TDataMember *member = (TDataMember *)next();
76 if(strstr(member->GetTypeName(),"TClass"))
77 member = (TDataMember *)next();
79 void *ptr = (void *)((char *)this+member->GetOffset());
80 const_cast<AliRawEventHeaderBase*>(this)->fHeaderBegin = ptr;
85 //______________________________________________________________________________
86 Int_t AliRawEventHeaderBase::HeaderSize() const
88 // Returns the size of the data members list
89 // beyond the base class data members
91 if (fHeaderSize) return fHeaderSize;
95 TList *datalist = IsA()->GetListOfDataMembers();
98 while ((member=(TDataMember *)next()) != 0x0) {
99 if (strstr(member->GetTypeName(),"TClass")) continue;
100 UInt_t unitsize = member->GetUnitSize();
101 UInt_t ndim = member->GetArrayDim();
105 for(UInt_t i=0;i<ndim;i++) size += member->GetMaxIndex(i)*unitsize;
108 const_cast<AliRawEventHeaderBase*>(this)->fHeaderSize = size;
113 //______________________________________________________________________________
114 UInt_t AliRawEventHeaderBase::SwapWord(UInt_t x) const
116 // Swap the endianess of the integer value 'x'
118 return (((x & 0x000000ffU) << 24) | ((x & 0x0000ff00U) << 8) |
119 ((x & 0x00ff0000U) >> 8) | ((x & 0xff000000U) >> 24));
122 void AliRawEventHeaderBase::Swap()
124 // Swap base header data.
125 // Update the fIsSwapped flag which
126 // is then use to copy in an appropriate way
127 // the rest of the header data from the raw data stream
131 fSize = SwapWord(fSize);
132 fMagic = SwapWord(fMagic);
133 fHeadSize = SwapWord(fHeadSize);
134 fVersion = SwapWord(fVersion);
138 //______________________________________________________________________________
139 const char *AliRawEventHeaderBase::GetTypeName() const
141 // Get event type as a string.
142 // Will fail in case data header
143 // does not contain eventType field
144 UInt_t eventType = Get("Type");
146 return GetTypeName(eventType);
149 //______________________________________________________________________________
150 const char *AliRawEventHeaderBase::GetTypeName(UInt_t eventType)
152 // Get event type as a string.
153 // Static method that could be used
154 // from everywhere inside aliroot
158 return "START_OF_RUN";
163 case kStartOfRunFiles:
164 return "START_OF_RUN_FILES";
167 return "END_OF_RUN_FILES";
170 return "START_OF_BURST";
173 return "END_OF_BURST";
176 return "PHYSICS_EVENT";
178 case kCalibrationEvent:
179 return "CALIBRATION_EVENT";
182 return "EVENT_FORMAT_ERROR";
185 return "START_OF_DATA";
188 return "END_OF_DATA";
190 case kSystemSoftwareTriggerEvent:
191 return "SYSTEM_SOFTWARE_TRIGGER_EVENT";
193 case kDetectorSoftwareTriggerEvent:
194 return "DETECTOR_SOFTWARE_TRIGGER_EVENT";
197 return "UNKNOWN EVENT TYPE NUMBER";
202 //______________________________________________________________________________
203 AliRawEventHeaderBase* AliRawEventHeaderBase::Create(char*& data)
205 // Static method to create AliRawEventHeaderVX object
206 // The actual header class version is taken from the
209 // First create AlirawEVentHeaderBase class object
210 AliRawEventHeaderBase header;
212 // Copy the first common part of the raw data header
213 memcpy(header.HeaderBaseBegin(), data, header.HeaderBaseSize());
215 // Swap header data if needed
216 if (header.IsSwapped())
219 // Is header valid...
220 if (!header.IsValid()) {
221 AliFatalClass("Invalid header format!");
222 // try recovery... how?
226 if (header.GetEventSize() < (UInt_t)header.HeaderBaseSize()) {
227 AliFatalClass("Invalid header base size!");
228 // try recovery... how?
232 // Now check the DATE version and create the corresponding header
234 UInt_t version = header.GetVersion();
235 UInt_t majorversion = (version>>16)&0x0000ffff;
236 UInt_t minorversion = version&0x0000ffff;
238 classname.Form("AliRawEventHeaderV%d_%d",majorversion,minorversion);
240 TClass *tcl = TClass::GetClass(classname.Data());
242 AliFatalClass(Form("Unknown header version (%s)!",classname.Data()));
246 // header.Dump(); tcl->Dump();
248 AliRawEventHeaderBase *hdr = (AliRawEventHeaderBase *)tcl->New();
250 AliFatalClass(Form("Can not create object of class %s",classname.Data()));
254 // Copy the base header data members and initialize other data members
255 memcpy(hdr->HeaderBaseBegin(),header.HeaderBaseBegin(), header.HeaderBaseSize());
256 memset(hdr->HeaderBegin(),0, hdr->HeaderSize());
257 hdr->fIsSwapped = header.fIsSwapped;
260 if (hdr->GetEventSize() < ((UInt_t)hdr->HeaderBaseSize() + (UInt_t)hdr->HeaderSize())) {
261 AliFatalClass(Form("Invalid header size (%d < %d +%d)!",
262 hdr->GetEventSize(),hdr->HeaderBaseSize(),hdr->HeaderSize()));
263 // try recovery... how?
267 // Check for the presence of header extension and its size
268 Int_t extsize = (Int_t)hdr->GetHeadSize() - (hdr->HeaderBaseSize() + hdr->HeaderSize());
270 AliFatalClass(Form("Invalid header size (%d < %d +%d)!",
271 hdr->GetHeadSize(),hdr->HeaderBaseSize(),hdr->HeaderSize()));
272 // try recovery... how?
277 hdr->AllocateExtendedData(extsize);
284 void AliRawEventHeaderBase::SwapData(const void* inbuf, const void* outbuf, UInt_t size) {
285 // The method swaps the contents of the
286 // raw-data event header
287 UInt_t intCount = size/sizeof(UInt_t);
289 UInt_t* buf = (UInt_t*) inbuf; // temporary integers buffer
290 for (UInt_t i=0; i<intCount; i++, buf++) {
291 UInt_t value = SwapWord(*buf);
292 memcpy((UInt_t*)outbuf+i, &value, sizeof(UInt_t));
296 //______________________________________________________________________________
297 Int_t AliRawEventHeaderBase::ReadHeader(char*& data)
299 // Read header info from DATE data stream.
300 // Returns bytes read
302 Long_t start = (Long_t)data;
303 // Swap header data if needed
304 if (DataIsSwapped()) {
305 SwapData(data, HeaderBaseBegin(), HeaderBaseSize());
306 data += HeaderBaseSize();
307 SwapData(data, HeaderBegin(), HeaderSize());
308 data += HeaderSize();
311 memcpy(HeaderBaseBegin(), data, HeaderBaseSize());
312 data += HeaderBaseSize();
313 memcpy(HeaderBegin(), data, HeaderSize());
314 data += HeaderSize();
316 data += ReadExtendedData(data);
318 return (Int_t)((Long_t)data - start);
321 //______________________________________________________________________________
322 void AliRawEventHeaderBase::AllocateExtendedData(Int_t extsize)
324 // Allocate the space for the header
326 if (fExtendedData) delete [] fExtendedData;
328 fExtendedDataSize = fExtendedAllocSize = extsize;
329 fExtendedData = new char[fExtendedAllocSize];
330 memset(fExtendedData,0,fExtendedAllocSize);
333 //______________________________________________________________________________
334 Int_t AliRawEventHeaderBase::ReadExtendedData(char*& data)
336 // Read extended header data
337 // Reallocates memory if the present
338 // buffer is insufficient
339 Int_t extsize = (Int_t)GetHeadSize() - (HeaderBaseSize() + HeaderSize());
342 fExtendedDataSize = 0;
347 AliFatal(Form("Invalid header size (%d < %d +%d)!",
348 GetHeadSize(),HeaderBaseSize(),HeaderSize()));
349 // try recovery... how?
353 fExtendedDataSize = extsize;
354 if (fExtendedDataSize > fExtendedAllocSize)
355 AllocateExtendedData(fExtendedDataSize);
358 SwapData(data, fExtendedData, fExtendedDataSize);
360 memcpy(fExtendedData, data, fExtendedDataSize);
362 return fExtendedDataSize;
365 //______________________________________________________________________________
366 UInt_t AliRawEventHeaderBase::Get(const char *datamember) const
368 // The method to get a data member from the header object
369 // Except for the data members of the base class, all the
370 // other header data should be retrieved ONLY by this method
371 // The name of the data member should be supplied without "f"
375 strncat(buf,datamember,sizeof(buf)-2);
377 TDataMember *member = IsA()->GetDataMember(buf);
379 AliFatal(Form("No data member %s is found! Check the raw data version!",buf));
383 if (member->GetArrayDim() != 0) {
384 AliFatal(Form("Member %s is an array! Use the GetP() method!",buf));
388 TDataType * dataType = member->GetDataType();
389 if (!dataType || dataType->GetType() != kUInt_t) {
390 AliFatal(Form("Member %s is not of type UInt_t!",buf));
394 const void *pointer = (char *)this+member->GetOffset();
396 return *((UInt_t *)pointer);
399 //______________________________________________________________________________
400 const UInt_t* AliRawEventHeaderBase::GetP(const char *datamember) const
402 // The method to get a data member from the header object
403 // Except for the data members of the base class, all the
404 // other header data should be retrieved ONLY by this method
405 // The name of the data member should be supplied without "f"
409 strncat(buf,datamember,sizeof(buf)-2);
411 TDataMember *member = IsA()->GetDataMember(buf);
413 AliFatal(Form("No data member %s is found! Check the raw data version!",buf));
417 // if (member->GetArrayDim() == 0) {
418 // AliFatal(Form("Member %s is not an array! Use the Get() method!",buf));
422 TDataType * dataType = member->GetDataType();
423 if (!dataType || dataType->GetType() != kUInt_t) {
424 AliFatal(Form("Member %s is not of type UInt_t*!",buf));
428 const void *pointer = (char *)this+member->GetOffset();
430 return (const UInt_t*)pointer;
433 //_____________________________________________________________________________
434 void AliRawEventHeaderBase::Print( const Option_t* opt ) const
436 // Dumps the event or sub-event
439 cout << opt << " Event size: " << GetEventSize() << endl;
440 cout << opt << " Event header size: " << GetHeadSize() << endl;
441 cout << opt << " Event header version: " << GetMajorVersion() << "." << GetMinorVersion() << endl;
442 cout << opt << " Event type: " << Get("Type") << "( " << GetTypeName() << " )" << endl;
443 cout << opt << " Run Number: " << Get("RunNb") << endl;
444 const UInt_t *id = GetP("Id");
445 cout << opt << " Period: " << (((id)[0]>>4)&0x0fffffff) << " Orbit: " << ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff)) << " Bunch-crossing: " << ((id)[1]&0x00000fff) << endl;
446 cout << opt << " Trigger pattern: " << GetP("TriggerPattern")[0] << "-" << GetP("TriggerPattern")[1] << endl;
447 cout << opt << " Detector pattern: " << Get("DetectorPattern") << endl;
448 cout << opt << " Type attribute: " << GetP("TypeAttribute")[0] << "-" << GetP("TypeAttribute")[1] << "-" << GetP("TypeAttribute")[2] << endl;
449 cout << opt << " GDC: " << Get("GdcId") << " LDC: " << Get("LdcId") << endl;
452 //_____________________________________________________________________________
453 void AliRawEventHeaderBase::AddEqIndex(Int_t index)
455 // Adds an equipment by changing properly
456 // the first and last equipment indexes
457 if (fFirstEqIndex < 0) fFirstEqIndex = index;
458 if (index > fLastEqIndex) fLastEqIndex = index;
461 //_____________________________________________________________________________
462 void AliRawEventHeaderBase::Reset()
464 fFirstEqIndex = fLastEqIndex = -1;