1 /**************************************************************************
2 * Copyright(c) 1998-1999, 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 ///////////////////////////////////////////////////////////////////////////////
20 /// This is a class for reading raw data from a root file.
22 /// The root file is expected to contain a tree of name "RAW" with
23 /// a branch of name "rawevent" which contains objects of type
26 /// The file name and the event number are arguments of the constructor
27 /// of AliRawReaderRoot.
29 ///////////////////////////////////////////////////////////////////////////////
33 #include "AliRawReaderRoot.h"
34 #include "AliRawEvent.h"
35 #include "AliRawEventHeaderBase.h"
36 #include "AliRawEquipment.h"
37 #include "AliRawEquipmentHeader.h"
38 #include "AliRawData.h"
41 ClassImp(AliRawReaderRoot)
44 AliRawReaderRoot::AliRawReaderRoot(const char* fileName, Int_t eventNumber) :
47 fEventIndex(eventNumber),
57 // create an object to read digits from the given input file for the
58 // event with the given number
60 TDirectory* dir = gDirectory;
61 fFile = TFile::Open(fileName);
63 if (!fFile || !fFile->IsOpen()) {
64 Error("AliRawReaderRoot", "could not open file %s", fileName);
67 TTree* tree = (TTree*) fFile->Get("RAW");
69 Error("AliRawReaderRoot", "no raw data tree found");
72 fBranch = tree->GetBranch("rawevent");
74 Error("AliRawReaderRoot", "no raw data branch found");
78 fEvent = new AliRawEvent;
79 fBranch->SetAddress(&fEvent);
80 if (fEventIndex >= 0) {
81 if (fBranch->GetEntry(fEventIndex) <= 0) {
82 Error("AliRawReaderRoot", "no event with number %d found", fEventIndex);
88 AliRawReaderRoot::AliRawReaderRoot(AliRawEvent* event) :
101 // create an object to read digits from the given raw event
105 AliRawReaderRoot::AliRawReaderRoot(const AliRawReaderRoot& rawReader) :
106 AliRawReader(rawReader),
109 fEventIndex(rawReader.fEventIndex),
111 fSubEventIndex(rawReader.fSubEventIndex),
113 fEquipmentIndex(rawReader.fEquipmentIndex),
121 if (rawReader.fFile) {
122 TDirectory* dir = gDirectory;
123 fFile = TFile::Open(rawReader.fFile->GetName());
125 if (!fFile || !fFile->IsOpen()) {
126 Error("AliRawReaderRoot", "could not open file %s",
127 rawReader.fFile->GetName());
130 TTree* tree = (TTree*) fFile->Get("RAW");
132 Error("AliRawReaderRoot", "no raw data tree found");
135 fBranch = tree->GetBranch("rawevent");
137 Error("AliRawReaderRoot", "no raw data branch found");
141 fEvent = new AliRawEvent;
142 fBranch->SetAddress(&fEvent);
143 if (fEventIndex >= 0) {
144 if (fBranch->GetEntry(fEventIndex) <= 0) {
145 Error("AliRawReaderRoot", "no event with number %d found",
151 fEvent = rawReader.fEvent;
154 if (fSubEventIndex > 0) {
155 fSubEvent = fEvent->GetSubEvent(fSubEventIndex-1);
156 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex);
157 fRawData = fEquipment->GetRawData();
159 fHeader = (AliRawDataHeader*) ((UChar_t*) fRawData->GetBuffer() +
160 ((UChar_t*) rawReader.fHeader -
161 (UChar_t*) rawReader.fRawData->GetBuffer()));
162 fPosition = (UChar_t*) fRawData->GetBuffer() +
163 (rawReader.fPosition - (UChar_t*) rawReader.fRawData->GetBuffer());
164 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
168 AliRawReaderRoot& AliRawReaderRoot::operator = (const AliRawReaderRoot&
171 // assignment operator
173 this->~AliRawReaderRoot();
174 new(this) AliRawReaderRoot(rawReader);
178 AliRawReaderRoot::~AliRawReaderRoot()
180 // delete objects and close root file
183 if (fEvent) delete fEvent;
189 const AliRawEventHeaderBase* AliRawReaderRoot::GetEventHeader() const
191 // Get the even header
192 // Return NULL in case of failure
193 if (!fEvent) return NULL;
194 return fEvent->GetHeader();
197 UInt_t AliRawReaderRoot::GetType() const
199 // get the type from the event header
201 if (!fEvent) return 0;
202 return fEvent->GetHeader()->Get("Type");
205 UInt_t AliRawReaderRoot::GetRunNumber() const
207 // get the run number from the event header
209 if (!fEvent) return 0;
210 return fEvent->GetHeader()->Get("RunNb");
213 const UInt_t* AliRawReaderRoot::GetEventId() const
215 // get the event id from the event header
217 if (!fEvent) return NULL;
218 return fEvent->GetHeader()->GetP("Id");
221 const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
223 // get the trigger pattern from the event header
225 if (!fEvent) return NULL;
226 return fEvent->GetHeader()->GetP("TriggerPattern");
229 const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
231 // get the detector pattern from the event header
233 if (!fEvent) return NULL;
234 return fEvent->GetHeader()->GetP("DetectorPattern");
237 const UInt_t* AliRawReaderRoot::GetAttributes() const
239 // get the type attributes from the event header
241 if (!fEvent) return NULL;
242 return fEvent->GetHeader()->GetP("TypeAttribute");
245 const UInt_t* AliRawReaderRoot::GetSubEventAttributes() const
247 // get the type attributes from the sub event header
249 if (!fSubEvent) return NULL;
250 return fSubEvent->GetHeader()->GetP("TypeAttribute");
253 UInt_t AliRawReaderRoot::GetLDCId() const
255 // get the LDC Id from the event header
257 if (!fEvent || !fSubEvent) return 0;
258 return fSubEvent->GetHeader()->Get("LdcId");
261 UInt_t AliRawReaderRoot::GetGDCId() const
263 // get the GDC Id from the event header
265 if (!fEvent) return 0;
266 return fEvent->GetHeader()->Get("GdcId");
269 UInt_t AliRawReaderRoot::GetTimestamp() const
271 if (!fEvent) return 0;
272 return fEvent->GetHeader()->Get("Timestamp");
275 Int_t AliRawReaderRoot::GetEquipmentSize() const
277 // get the size of the equipment
279 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
280 return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
283 Int_t AliRawReaderRoot::GetEquipmentType() const
285 // get the type from the equipment header
287 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
288 return fEquipment->GetEquipmentHeader()->GetEquipmentType();
291 Int_t AliRawReaderRoot::GetEquipmentId() const
293 // get the ID from the equipment header
295 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
296 return fEquipment->GetEquipmentHeader()->GetId();
299 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
301 // get the attributes from the equipment header
303 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
304 return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
307 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
309 // get the basic element size from the equipment header
311 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
312 return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
315 Int_t AliRawReaderRoot::GetEquipmentHeaderSize() const
317 // get the size of the equipment header (28 bytes by default)
319 if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
320 return fEquipment->GetEquipmentHeader()->HeaderSize();
323 // _________________________________________________________________________
324 UInt_t AliRawReaderRoot::SwapWord(UInt_t x) const
326 // Swap the endianess of the integer value 'x'
328 return (((x & 0x000000ffU) << 24) | ((x & 0x0000ff00U) << 8) |
329 ((x & 0x00ff0000U) >> 8) | ((x & 0xff000000U) >> 24));
332 void AliRawReaderRoot::SwapData(const void* inbuf, const void* outbuf, UInt_t size) {
333 // The method swaps the contents of the
334 // raw-data event header
335 UInt_t intCount = (size+sizeof(UInt_t)-1)/sizeof(UInt_t);
337 UInt_t* buf = (UInt_t*) inbuf; // temporary integers buffer
338 for (UInt_t i=0; i<intCount; i++, buf++) {
339 UInt_t value = SwapWord(*buf);
341 memcpy((UInt_t*)outbuf+i, &value, size%sizeof(UInt_t));
343 memcpy((UInt_t*)outbuf+i, &value, sizeof(UInt_t));
346 // _________________________________________________________________________
348 Bool_t AliRawReaderRoot::ReadHeader()
350 // read a data header at the current position
351 // returns kFALSE if the data header could not be read
354 if (!fEvent) return kFALSE;
357 // skip payload (if event was not selected)
358 if (fCount > 0) fPosition += fCount;
360 // get the first or the next equipment if at the end of an equipment
361 if (!fEquipment || (fPosition >= fEnd)) {
363 // get the first or the next sub event if at the end of a sub event
364 if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
366 // check for end of event data
367 if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
368 fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
370 // check the magic word of the sub event
371 if (!fSubEvent->GetHeader()->IsValid()) {
372 Error("ReadHeader", "wrong magic number in sub event!");
373 fSubEvent->GetHeader()->Dump();
374 fErrorCode = kErrMagic;
383 // get the next equipment and raw data
385 fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
386 if (!fEquipment) continue;
391 fRawData = fEquipment->GetRawData();
396 fPosition = (UChar_t*) fRawData->GetBuffer();
397 fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
400 // continue with the next equipment if no data left in the payload
401 if (fPosition >= fEnd) continue;
403 if (fRequireHeader) {
404 // check that there are enough bytes left for the data header
405 if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
406 Error("ReadHeader", "could not read data header!");
407 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
408 fEquipment->GetEquipmentHeader()->Dump();
411 fErrorCode = kErrNoDataHeader;
415 // "read" the data header
416 fHeader = (AliRawDataHeader*) fPosition;
418 SwapData((void*) fHeader, (void*) fHeaderSwapped, sizeof(AliRawDataHeader));
419 fHeader=fHeaderSwapped;
421 if ((fPosition + fHeader->fSize) != fEnd) {
422 Warning("ReadHeader",
423 "Equipment %d : raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
424 fEquipment->GetEquipmentHeader()->GetId(),fHeader->fSize, fEnd - fPosition);
425 fHeader->fSize = fEnd - fPosition;
427 fPosition += sizeof(AliRawDataHeader);
430 if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
431 fCount = fHeader->fSize - sizeof(AliRawDataHeader);
433 // check consistency of data size in the header and in the sub event
434 if (fPosition + fCount > fEnd) {
435 Error("ReadHeader", "size in data header exceeds event size!");
436 Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
437 fEquipment->GetEquipmentHeader()->Dump();
440 fErrorCode = kErrSize;
445 fCount = fEnd - fPosition;
448 } while (!IsSelected());
453 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
455 // reads the next payload at the current position
456 // returns kFALSE if the data could not be read
459 while (fCount == 0) {
460 if (!ReadHeader()) return kFALSE;
468 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
470 // reads the next block of data at the current position
471 // returns kFALSE if the data could not be read
474 if (fPosition + size > fEnd) {
475 Error("ReadNext", "could not read data!");
476 fErrorCode = kErrOutOfBounds;
480 // relative position in the raw data buffer
481 UInt_t pos = (UInt_t) (fPosition-(UChar_t*)fRawData->GetBuffer());
483 UInt_t gapL = pos%sizeof(UInt_t);
484 UInt_t gapR = (pos+size)%sizeof(UInt_t);
485 if ( gapR > 0 ) gapR = sizeof(UInt_t) - gapR;
487 if (gapL>0 || gapR>0) printf("AliRawReaderRoot::ReadNext: relative pos in buffer=%d, buffer size=%d, gapLeft=%d, gapRight=%d\n", pos, size, gapL, gapR);
489 UChar_t* firstWord = fPosition - gapL; // pointer to the begin of the 1st word
490 UChar_t* lastWord = fPosition + size + gapR; // pointer to the begin of the 1st word following the buffer and not included
492 // Loop through the all words and write each of them swapped
493 UInt_t bytesRead = 0;
494 while (firstWord < lastWord)
496 UInt_t* value = (UInt_t*) firstWord;
497 UInt_t valueInv = SwapWord( *value );
499 if ( (pos/sizeof(UInt_t)) == ((pos+size)/sizeof(UInt_t)) )
501 // invert only byte(s) within the 1st (and unique) read word
503 memcpy((UInt_t*)(data+bytesRead), &valueInv+gapL, size);
509 // 1st word unaligned
510 bytesRead += sizeof(UInt_t) - gapL;
511 memcpy((UInt_t*)(data+bytesRead), &valueInv+gapL, sizeof(UInt_t)-gapL);
517 // last word unaligned
518 bytesRead += sizeof(UInt_t) - gapR;
519 memcpy((UInt_t*)(data+bytesRead), &valueInv, sizeof(UInt_t)-gapR);
524 bytesRead += sizeof(UInt_t);
525 memcpy((UInt_t*)(data+bytesRead), &valueInv, sizeof(UInt_t));
530 firstWord += sizeof(UInt_t);
533 memcpy(data, fPosition, size);
542 Bool_t AliRawReaderRoot::Reset()
544 // reset the current position to the beginning of the event
554 fPosition = fEnd = NULL;
559 Bool_t AliRawReaderRoot::NextEvent()
561 // go to the next event in the root file
563 if (!fBranch) return kFALSE;
567 fEvent = new AliRawEvent;
568 fBranch->SetAddress(&fEvent);
569 if (fBranch->GetEntry(fEventIndex+1) <= 0)
572 } while (!IsEventSelected());
577 Bool_t AliRawReaderRoot::RewindEvents()
579 // go back to the beginning of the root file
581 if (!fBranch) return kFALSE;
585 fEvent = new AliRawEvent;
586 fBranch->SetAddress(&fEvent);
592 Int_t AliRawReaderRoot::CheckData() const
594 // check the consistency of the data
596 if (!fEvent) return 0;
598 AliRawEvent* subEvent = NULL;
599 Int_t subEventIndex = 0;
600 AliRawEquipment* equipment = NULL;
601 Int_t equipmentIndex = 0;
602 UChar_t* position = 0;
607 // get the first or the next sub event if at the end of an equipment
608 if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
610 // check for end of event data
611 if (subEventIndex >= fEvent->GetNSubEvents()) return result;
612 subEvent = fEvent->GetSubEvent(subEventIndex++);
614 // check the magic word of the sub event
615 if (!fSubEvent->GetHeader()->IsValid()) {
623 // get the next equipment and raw data
624 equipment = subEvent->GetEquipment(equipmentIndex++);
625 if (!equipment) continue;
626 AliRawData* rawData = equipment->GetRawData();
627 if (!rawData) continue;
628 position = (UChar_t*) rawData->GetBuffer();
629 end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
631 // continue with the next sub event if no data left in the payload
632 if (position >= end) continue;
634 if (fRequireHeader) {
635 // check that there are enough bytes left for the data header
636 if (position + sizeof(AliRawDataHeader) > end) {
637 result |= kErrNoDataHeader;
641 // check consistency of data size in the header and in the equipment
642 AliRawDataHeader* header = (AliRawDataHeader*) position;
643 if ((position + header->fSize) != end) {
644 Warning("ReadHeader",
645 "Equipment %d : raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
646 equipment->GetEquipmentHeader()->GetId(),header->fSize, end - position);
647 header->fSize = end - position;