RAW/AliRawReaderRoot.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   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  **************************************************************************/
  15
  16 /* $Id$ */
  17
  18 ///////////////////////////////////////////////////////////////////////////////
  19 ///
  20 /// This is a class for reading raw data from a root file.
  21 ///
  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
  24 /// AliRawEvent.
  25 ///
  26 /// The file name and the event number are arguments of the constructor
  27 /// of AliRawReaderRoot.
  28 ///
  29 ///////////////////////////////////////////////////////////////////////////////
  30
  31 #include <TFile.h>
  32 #include <TTree.h>
  33 #include "AliRawReaderRoot.h"
  34 #include "AliRawEvent.h"
  35 #include "AliRawEventHeaderBase.h"
  36 #include "AliRawEquipment.h"
  37 #include "AliRawEquipmentHeader.h"
  38 #include "AliRawData.h"
  39
  40
  41 ClassImp(AliRawReaderRoot)
  42
  43
  44 AliRawReaderRoot::AliRawReaderRoot(const char* fileName, Int_t eventNumber) :
  45   fFile(NULL),
  46   fBranch(NULL),
  47   fEventIndex(eventNumber),
  48   fEvent(NULL),
  49   fSubEventIndex(0),
  50   fSubEvent(NULL),
  51   fEquipmentIndex(0),
  52   fEquipment(NULL),
  53   fRawData(NULL),
  54   fPosition(NULL),
  55   fEnd(NULL)
  56 {
  57 // create an object to read digits from the given input file for the
  58 // event with the given number
  59
  60   TDirectory* dir = gDirectory;
  61   fFile = TFile::Open(fileName);
  62   dir->cd();
  63   if (!fFile || !fFile->IsOpen()) {
  64     Error("AliRawReaderRoot", "could not open file %s", fileName);
  65     return;
  66   }
  67   TTree* tree = (TTree*) fFile->Get("RAW");
  68   if (!tree) {
  69     Error("AliRawReaderRoot", "no raw data tree found");
  70     return;
  71   }
  72   fBranch = tree->GetBranch("rawevent");
  73   if (!fBranch) {
  74     Error("AliRawReaderRoot", "no raw data branch found");
  75     return;
  76   }
  77
  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);
  83       return;
  84     }
  85   }
  86 }
  87
  88 AliRawReaderRoot::AliRawReaderRoot(AliRawEvent* event) :
  89   fFile(NULL),
  90   fBranch(NULL),
  91   fEventIndex(-1),
  92   fEvent(event),
  93   fSubEventIndex(0),
  94   fSubEvent(NULL),
  95   fEquipmentIndex(0),
  96   fEquipment(NULL),
  97   fRawData(NULL),
  98   fPosition(NULL),
  99   fEnd(NULL)
 100 {
 101 // create an object to read digits from the given raw event
 102
 103 }
 104
 105 AliRawReaderRoot::AliRawReaderRoot(const AliRawReaderRoot& rawReader) :
 106   AliRawReader(rawReader),
 107   fFile(NULL),
 108   fBranch(NULL),
 109   fEventIndex(rawReader.fEventIndex),
 110   fEvent(NULL),
 111   fSubEventIndex(rawReader.fSubEventIndex),
 112   fSubEvent(NULL),
 113   fEquipmentIndex(rawReader.fEquipmentIndex),
 114   fEquipment(NULL),
 115   fRawData(NULL),
 116   fPosition(NULL),
 117   fEnd(NULL)
 118 {
 119 // copy constructor
 120
 121   if (rawReader.fFile) {
 122     TDirectory* dir = gDirectory;
 123     fFile = TFile::Open(rawReader.fFile->GetName());
 124     dir->cd();
 125     if (!fFile || !fFile->IsOpen()) {
 126       Error("AliRawReaderRoot", "could not open file %s",
 127             rawReader.fFile->GetName());
 128       return;
 129     }
 130     TTree* tree = (TTree*) fFile->Get("RAW");
 131     if (!tree) {
 132       Error("AliRawReaderRoot", "no raw data tree found");
 133       return;
 134     }
 135     fBranch = tree->GetBranch("rawevent");
 136     if (!fBranch) {
 137       Error("AliRawReaderRoot", "no raw data branch found");
 138       return;
 139     }
 140
 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",
 146               fEventIndex);
 147         return;
 148       }
 149     }
 150   } else {
 151     fEvent = rawReader.fEvent;
 152   }
 153
 154   if (fSubEventIndex > 0) {
 155     fSubEvent = fEvent->GetSubEvent(fSubEventIndex-1);
 156     fEquipment = fSubEvent->GetEquipment(fEquipmentIndex);
 157     fRawData = fEquipment->GetRawData();
 158       fCount = 0;
 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();
 165   }
 166 }
 167
 168 AliRawReaderRoot& AliRawReaderRoot::operator = (const AliRawReaderRoot&
 169                                                 rawReader)
 170 {
 171 // assignment operator
 172
 173   this->~AliRawReaderRoot();
 174   new(this) AliRawReaderRoot(rawReader);
 175   return *this;
 176 }
 177
 178 AliRawReaderRoot::~AliRawReaderRoot()
 179 {
 180 // delete objects and close root file
 181
 182   if (fFile) {
 183     if (fEvent) delete fEvent;
 184     fFile->Close();
 185     delete fFile;
 186   }
 187 }
 188
 189 const AliRawEventHeaderBase* AliRawReaderRoot::GetEventHeader() const
 190 {
 191   // Get the even header
 192   // Return NULL in case of failure
 193   if (!fEvent) return NULL;
 194   return fEvent->GetHeader();
 195 }
 196
 197 UInt_t AliRawReaderRoot::GetType() const
 198 {
 199 // get the type from the event header
 200
 201   if (!fEvent) return 0;
 202   return fEvent->GetHeader()->Get("Type");
 203 }
 204
 205 UInt_t AliRawReaderRoot::GetRunNumber() const
 206 {
 207 // get the run number from the event header
 208
 209   if (!fEvent) return 0;
 210   return fEvent->GetHeader()->Get("RunNb");
 211 }
 212
 213 const UInt_t* AliRawReaderRoot::GetEventId() const
 214 {
 215 // get the event id from the event header
 216
 217   if (!fEvent) return NULL;
 218   return fEvent->GetHeader()->GetP("Id");
 219 }
 220
 221 const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
 222 {
 223 // get the trigger pattern from the event header
 224
 225   if (!fEvent) return NULL;
 226   return fEvent->GetHeader()->GetP("TriggerPattern");
 227 }
 228
 229 const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
 230 {
 231 // get the detector pattern from the event header
 232
 233   if (!fEvent) return NULL;
 234   return fEvent->GetHeader()->GetP("DetectorPattern");
 235 }
 236
 237 const UInt_t* AliRawReaderRoot::GetAttributes() const
 238 {
 239 // get the type attributes from the event header
 240
 241   if (!fEvent) return NULL;
 242   return fEvent->GetHeader()->GetP("TypeAttribute");
 243 }
 244
 245 const UInt_t* AliRawReaderRoot::GetSubEventAttributes() const
 246 {
 247 // get the type attributes from the sub event header
 248
 249   if (!fSubEvent) return NULL;
 250   return fSubEvent->GetHeader()->GetP("TypeAttribute");
 251 }
 252
 253 UInt_t AliRawReaderRoot::GetLDCId() const
 254 {
 255 // get the LDC Id from the event header
 256
 257   if (!fEvent || !fSubEvent) return 0;
 258   return fSubEvent->GetHeader()->Get("LdcId");
 259 }
 260
 261 UInt_t AliRawReaderRoot::GetGDCId() const
 262 {
 263 // get the GDC Id from the event header
 264
 265   if (!fEvent) return 0;
 266   return fEvent->GetHeader()->Get("GdcId");
 267 }
 268
 269 UInt_t AliRawReaderRoot::GetTimestamp() const
 270 {
 271   if (!fEvent) return 0;
 272   return fEvent->GetHeader()->Get("Timestamp");
 273 }
 274
 275 Int_t AliRawReaderRoot::GetEquipmentSize() const
 276 {
 277 // get the size of the equipment
 278
 279   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
 280   return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
 281 }
 282
 283 Int_t AliRawReaderRoot::GetEquipmentType() const
 284 {
 285 // get the type from the equipment header
 286
 287   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
 288   return fEquipment->GetEquipmentHeader()->GetEquipmentType();
 289 }
 290
 291 Int_t AliRawReaderRoot::GetEquipmentId() const
 292 {
 293 // get the ID from the equipment header
 294
 295   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
 296   return fEquipment->GetEquipmentHeader()->GetId();
 297 }
 298
 299 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
 300 {
 301 // get the attributes from the equipment header
 302
 303   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
 304   return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
 305 }
 306
 307 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
 308 {
 309 // get the basic element size from the equipment header
 310
 311   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
 312   return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
 313 }
 314
 315 Int_t AliRawReaderRoot::GetEquipmentHeaderSize() const
 316 {
 317 // get the size of the equipment header (28 bytes by default)
 318
 319   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
 320   return fEquipment->GetEquipmentHeader()->HeaderSize();
 321 }
 322
 323
 324 Bool_t AliRawReaderRoot::ReadHeader()
 325 {
 326 // read a data header at the current position
 327 // returns kFALSE if the data header could not be read
 328
 329   fErrorCode = 0;
 330   if (!fEvent) return kFALSE;
 331
 332   do {
 333     // skip payload (if event was not selected)
 334     if (fCount > 0) fPosition += fCount;
 335
 336     // get the first or the next equipment if at the end of an equipment
 337     if (!fEquipment || (fPosition >= fEnd)) {
 338
 339       // get the first or the next sub event if at the end of a sub event
 340       if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
 341
 342         // check for end of event data
 343         if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
 344         fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
 345
 346         // check the magic word of the sub event
 347         if (!fSubEvent->GetHeader()->IsValid()) {
 348           Error("ReadHeader", "wrong magic number in sub event!");
 349           fSubEvent->GetHeader()->Dump();
 350           fErrorCode = kErrMagic;
 351           return kFALSE;
 352         }
 353
 354         fEquipmentIndex = 0;
 355         fEquipment = NULL;
 356         fRawData = NULL;
 357       }
 358
 359       // get the next equipment and raw data
 360       fCount = 0;
 361       fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
 362       if (!fEquipment) continue;
 363       if (!IsSelected()) {
 364         fPosition = fEnd;
 365         continue;
 366       }
 367       fRawData = fEquipment->GetRawData();
 368       if (!fRawData) {
 369         fPosition = fEnd;
 370         continue;
 371       }
 372       fPosition = (UChar_t*) fRawData->GetBuffer();
 373       fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
 374     }
 375
 376     // continue with the next equipment if no data left in the payload
 377     if (fPosition >= fEnd) continue;
 378
 379     if (fRequireHeader) {
 380       // check that there are enough bytes left for the data header
 381       if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
 382         Error("ReadHeader", "could not read data header!");
 383         Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
 384         fEquipment->GetEquipmentHeader()->Dump();
 385         fCount = 0;
 386         fPosition = fEnd;
 387         fErrorCode = kErrNoDataHeader;
 388         continue;
 389       }
 390
 391       // "read" the data header
 392       fHeader = (AliRawDataHeader*) fPosition;
 393       if ((fPosition + fHeader->fSize) != fEnd) {
 394         Warning("ReadHeader",
 395                 "Equipment %d : raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
 396                 fEquipment->GetEquipmentHeader()->GetId(),fHeader->fSize, fEnd - fPosition);
 397         fHeader->fSize = fEnd - fPosition;
 398       }
 399       fPosition += sizeof(AliRawDataHeader);
 400     }
 401
 402     if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
 403       fCount = fHeader->fSize - sizeof(AliRawDataHeader);
 404
 405       // check consistency of data size in the header and in the sub event
 406       if (fPosition + fCount > fEnd) {
 407         Error("ReadHeader", "size in data header exceeds event size!");
 408         Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
 409         fEquipment->GetEquipmentHeader()->Dump();
 410         fCount = 0;
 411         fPosition = fEnd;
 412         fErrorCode = kErrSize;
 413         continue;
 414       }
 415
 416     } else {
 417       fCount = fEnd - fPosition;
 418     }
 419
 420   } while (!IsSelected());
 421
 422   return kTRUE;
 423 }
 424
 425 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
 426 {
 427 // reads the next payload at the current position
 428 // returns kFALSE if the data could not be read
 429
 430   fErrorCode = 0;
 431   while (fCount == 0) {
 432     if (!ReadHeader()) return kFALSE;
 433   }
 434   data = fPosition;
 435   fPosition += fCount;
 436   fCount = 0;
 437   return kTRUE;
 438 }
 439
 440 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
 441 {
 442 // reads the next block of data at the current position
 443 // returns kFALSE if the data could not be read
 444
 445   fErrorCode = 0;
 446   if (fPosition + size > fEnd) {
 447     Error("ReadNext", "could not read data!");
 448     fErrorCode = kErrOutOfBounds;
 449     return kFALSE;
 450   }
 451   memcpy(data, fPosition, size);
 452   fPosition += size;
 453   fCount -= size;
 454   return kTRUE;
 455 }
 456
 457
 458 Bool_t AliRawReaderRoot::Reset()
 459 {
 460 // reset the current position to the beginning of the event
 461
 462   fSubEventIndex = 0;
 463   fSubEvent = NULL;
 464   fEquipmentIndex = 0;
 465   fEquipment = NULL;
 466   fRawData = NULL;
 467   fHeader = NULL;
 468
 469   fCount = 0;
 470   fPosition = fEnd = NULL;
 471   return kTRUE;
 472 }
 473
 474
 475 Bool_t AliRawReaderRoot::NextEvent()
 476 {
 477 // go to the next event in the root file
 478
 479   if (!fBranch) return kFALSE;
 480
 481   do {
 482     delete fEvent;
 483     fEvent = new AliRawEvent;
 484     fBranch->SetAddress(&fEvent);
 485     if (fBranch->GetEntry(fEventIndex+1) <= 0)
 486       return kFALSE;
 487     fEventIndex++;
 488   } while (!IsEventSelected());
 489   fEventNumber++;
 490   return Reset();
 491 }
 492
 493 Bool_t AliRawReaderRoot::RewindEvents()
 494 {
 495 // go back to the beginning of the root file
 496
 497   if (!fBranch) return kFALSE;
 498
 499   fEventIndex = -1;
 500   delete fEvent;
 501   fEvent = new AliRawEvent;
 502   fBranch->SetAddress(&fEvent);
 503   fEventNumber = -1;
 504   return Reset();
 505 }
 506
 507
 508 Int_t AliRawReaderRoot::CheckData() const
 509 {
 510 // check the consistency of the data
 511
 512   if (!fEvent) return 0;
 513
 514   AliRawEvent* subEvent = NULL;
 515   Int_t subEventIndex = 0;
 516   AliRawEquipment* equipment = NULL;
 517   Int_t equipmentIndex = 0;
 518   UChar_t* position = 0;
 519   UChar_t* end = 0;
 520   Int_t result = 0;
 521
 522   while (kTRUE) {
 523     // get the first or the next sub event if at the end of an equipment
 524     if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
 525
 526       // check for end of event data
 527       if (subEventIndex >= fEvent->GetNSubEvents()) return result;
 528       subEvent = fEvent->GetSubEvent(subEventIndex++);
 529
 530       // check the magic word of the sub event
 531       if (!fSubEvent->GetHeader()->IsValid()) {
 532         result |= kErrMagic;
 533         return result;
 534       }
 535
 536       equipmentIndex = 0;
 537     }
 538
 539     // get the next equipment and raw data
 540     equipment = subEvent->GetEquipment(equipmentIndex++);
 541     if (!equipment) continue;
 542     AliRawData* rawData = equipment->GetRawData();
 543     if (!rawData) continue;
 544     position = (UChar_t*) rawData->GetBuffer();
 545     end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
 546
 547     // continue with the next sub event if no data left in the payload
 548     if (position >= end) continue;
 549
 550     if (fRequireHeader) {
 551     // check that there are enough bytes left for the data header
 552       if (position + sizeof(AliRawDataHeader) > end) {
 553         result |= kErrNoDataHeader;
 554         continue;
 555       }
 556
 557       // check consistency of data size in the header and in the equipment
 558       AliRawDataHeader* header = (AliRawDataHeader*) position;
 559       if ((position + header->fSize) != end) {
 560         Warning("ReadHeader",
 561                 "Equipment %d : raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
 562                 equipment->GetEquipmentHeader()->GetId(),header->fSize, end - position);
 563         header->fSize = end - position;
 564         result |= kErrSize;
 565       }
 566     }
 567     position = end;
 568   };
 569
 570   return result;
 571 }