1. Proper (?) handling of the branches in AliRawReaderChain. 2. New virtual GotoEvent...
[u/mrichter/AliRoot.git] / RAW / AliRawReader.cxx
index ab714cb..fc7cb3e 100644 (file)
  * provided "as is" without express or implied warranty.                  *
  **************************************************************************/
 
+/* $Id$ */
+
 ///////////////////////////////////////////////////////////////////////////////
-//
-// This is the base class for reading raw data and providing
-// information about digits
-//
-// The derived classes, which operate on concrete raw data formats,
-// should implement
-// - ReadHeader to read the next (data/equipment) header
-// - ReadNextData to read the next raw data block (=1 DDL)
-// - ReadNext to read a given number of bytes
-// - several getters like GetType
-//
-// Sequential access to the raw data is provided by the methods
-// ReadHeader, ReadNextData, ReadNextInt, ReadNextShort, ReadNextChar
-//
-// If only data from a specific detector (and a given range of DDL numbers)
-// should be read, this can be achieved by the Select method.
-// Several getter provide information about the current event and the
-// current type of raw data.
-//
+///
+/// This is the base class for reading raw data.
+///
+/// The derived classes, which operate on concrete raw data formats,
+/// should implement
+/// - ReadHeader to read the next (data/equipment) header
+/// - ReadNextData to read the next raw data block (=1 DDL)
+/// - ReadNext to read a given number of bytes
+/// - several getters like GetType
+///
+/// Sequential access to the raw data is provided by the methods
+/// ReadHeader, ReadNextData, ReadNextInt, ReadNextShort, ReadNextChar
+///
+/// If only data from a specific detector (and a given range of DDL numbers)
+/// should be read, this can be achieved by the Select method.
+/// Several getters provide information about the current event and the
+/// current type of raw data.
+///
 ///////////////////////////////////////////////////////////////////////////////
 
-#include "AliRawReader.h"
+#include <TClass.h>
+#include <TPluginManager.h>
+#include <TROOT.h>
 
+#include <Riostream.h>
+#include "AliRawReader.h"
+#include "AliRawReaderFile.h"
+#include "AliRawReaderDate.h"
+#include "AliRawReaderRoot.h"
+#include "AliRawReaderChain.h"
+#include "AliDAQ.h"
+#include "AliLog.h"
 
 ClassImp(AliRawReader)
 
 
 AliRawReader::AliRawReader() :
+  fEquipmentIdsIn(NULL),
+  fEquipmentIdsOut(NULL),
+  fRequireHeader(kTRUE),
   fHeader(NULL),
   fCount(0),
   fSelectEquipmentType(-1),
   fSelectMinEquipmentId(-1),
   fSelectMaxEquipmentId(-1),
   fSkipInvalid(kFALSE),
-  fErrorCode(0)
+  fSelectEventType(-1),
+  fSelectTriggerMask(0),
+  fErrorCode(0),
+  fEventNumber(-1),
+  fErrorLogs("AliRawDataErrorLog",100),
+  fHeaderSwapped(NULL)
 {
 // default constructor: initialize data members
+// Allocate the swapped header in case of Mac
+#ifndef R__BYTESWAP
+  fHeaderSwapped=new AliRawDataHeader();
+#endif
+}
 
+Bool_t AliRawReader::LoadEquipmentIdsMap(const char *fileName)
+{
+  // Open the mapping file
+  // and load the mapping data
+  ifstream input(fileName);
+  if (input.is_open()) {
+    Warning("AliRawReader","Equipment ID mapping file is found !");
+    const Int_t kMaxDDL = 256;
+    fEquipmentIdsIn = new TArrayI(kMaxDDL);
+    fEquipmentIdsOut = new TArrayI(kMaxDDL);
+    Int_t equipIn, equipOut;
+    Int_t nIds = 0;
+    while (input >> equipIn >> equipOut) {
+      if (nIds >= kMaxDDL) {
+       Error("AliRawReader","Too many equipment Id mappings found ! Truncating the list !");
+       break;
+      }
+      fEquipmentIdsIn->AddAt(equipIn,nIds); 
+      fEquipmentIdsOut->AddAt(equipOut,nIds);
+      nIds++;
+    }
+    fEquipmentIdsIn->Set(nIds);
+    fEquipmentIdsOut->Set(nIds);
+    input.close();
+    return kTRUE;
+  }
+  else {
+    Error("AliRawReader","equipment id map file is not found ! Skipping the mapping !");
+    return kFALSE;
+  }
 }
 
 AliRawReader::AliRawReader(const AliRawReader& rawReader) :
   TObject(rawReader),
+  fEquipmentIdsIn(rawReader.fEquipmentIdsIn),
+  fEquipmentIdsOut(rawReader.fEquipmentIdsOut),
+  fRequireHeader(rawReader.fRequireHeader),
   fHeader(rawReader.fHeader),
   fCount(rawReader.fCount),
   fSelectEquipmentType(rawReader.fSelectEquipmentType),
   fSelectMinEquipmentId(rawReader.fSelectMinEquipmentId),
   fSelectMaxEquipmentId(rawReader.fSelectMaxEquipmentId),
   fSkipInvalid(rawReader.fSkipInvalid),
-  fErrorCode(0)
+  fSelectEventType(rawReader.fSelectEventType),
+  fSelectTriggerMask(rawReader.fSelectTriggerMask),
+  fErrorCode(0),
+  fEventNumber(-1),
+  fErrorLogs("AliRawDataErrorLog",100),
+  fHeaderSwapped(NULL)
 {
 // copy constructor
-
+// Allocate the swapped header in case of Mac
+#ifndef R__BYTESWAP
+  fHeaderSwapped=new AliRawDataHeader(*rawReader.fHeaderSwapped);
+#endif
 }
 
 AliRawReader& AliRawReader::operator = (const AliRawReader& rawReader)
 {
 // assignment operator
+  fEquipmentIdsIn = rawReader.fEquipmentIdsIn;
+  fEquipmentIdsOut = rawReader.fEquipmentIdsOut;
 
   fHeader = rawReader.fHeader;
   fCount = rawReader.fCount;
@@ -79,12 +146,180 @@ AliRawReader& AliRawReader::operator = (const AliRawReader& rawReader)
   fSelectMinEquipmentId = rawReader.fSelectMinEquipmentId;
   fSelectMaxEquipmentId = rawReader.fSelectMaxEquipmentId;
   fSkipInvalid = rawReader.fSkipInvalid;
+  fSelectEventType = rawReader.fSelectEventType;
+  fSelectTriggerMask = rawReader.fSelectTriggerMask;
 
   fErrorCode = rawReader.fErrorCode;
 
+  fEventNumber = rawReader.fEventNumber;
+  fErrorLogs = *((TClonesArray*)rawReader.fErrorLogs.Clone());
+
   return *this;
 }
 
+AliRawReader::~AliRawReader()
+{
+  // destructor
+  // delete the mapping arrays if
+  // initialized
+  if (fEquipmentIdsIn) delete fEquipmentIdsIn;
+  if (fEquipmentIdsOut) delete fEquipmentIdsOut;
+  fErrorLogs.Delete();
+  if (fHeaderSwapped) delete fHeaderSwapped;
+}
+
+AliRawReader* AliRawReader::Create(const char *uri)
+{
+  // RawReader's factory
+  // It instantiate corresponding raw-reader implementation class object
+  // depending on the URI provided
+  // Normal URIs point to files, while the URI starting with
+  // 'mem://:' or 'mem://<filename>' will create
+  // AliRawReaderDateOnline object which is supposed to be used
+  // in the online reconstruction
+
+  TString strURI = uri;
+
+  if (strURI.IsNull()) {
+    AliWarningClass("No raw-reader created");
+    return NULL;
+  }
+
+  TObjArray *fields = strURI.Tokenize("?");
+  TString &fileURI = ((TObjString*)fields->At(0))->String();
+
+  AliRawReader *rawReader = NULL;
+  if (fileURI.BeginsWith("mem://")) {
+    fileURI.ReplaceAll("mem://","");
+    AliInfoClass(Form("Creating raw-reader in order to read events in shared memory (option=%s)",fileURI.Data()));
+
+    TPluginManager* pluginManager = gROOT->GetPluginManager();
+    TString rawReaderName = "AliRawReaderDateOnline";
+    TPluginHandler* pluginHandler = pluginManager->FindHandler("AliRawReader", "online");
+    // if not, add a plugin for it
+    if (!pluginHandler) {
+      pluginManager->AddHandler("AliRawReader", "online", 
+                               "AliRawReaderDateOnline", "RAWDatarecOnline", "AliRawReaderDateOnline(const char*)");
+      pluginHandler = pluginManager->FindHandler("AliRawReader", "online");
+    }
+    if (pluginHandler && (pluginHandler->LoadPlugin() == 0)) {
+      rawReader = (AliRawReader*)pluginHandler->ExecPlugin(1,fileURI.Data());
+    }
+    else {
+      delete fields;
+      return NULL;
+    }
+  }
+  else if (fileURI.BeginsWith("collection://")) {
+    fileURI.ReplaceAll("collection://","");
+    AliInfoClass(Form("Creating raw-reader in order to read raw-data files collection defined in %s",fileURI.Data()));
+    rawReader = new AliRawReaderChain(fileURI);
+  }
+  else {
+    AliInfoClass(Form("Creating raw-reader in order to read raw-data file: %s",fileURI.Data()));
+    if (fileURI.EndsWith("/")) {
+      rawReader = new AliRawReaderFile(fileURI);
+    } else if (fileURI.EndsWith(".root")) {
+      rawReader = new AliRawReaderRoot(fileURI);
+    } else {
+      rawReader = new AliRawReaderDate(fileURI);
+    }
+  }
+
+  // Now apply event selection criteria (if specified)
+  if (fields->GetEntries() > 1) {
+    Int_t eventType = -1;
+    ULong64_t triggerMask = 0;
+    for(Int_t i = 1; i < fields->GetEntries(); i++) {
+      if (!fields->At(i)) continue;
+      TString &option = ((TObjString*)fields->At(i))->String();
+      if (option.BeginsWith("EventType=",TString::kIgnoreCase)) {
+       option.ReplaceAll("EventType=","");
+       eventType = option.Atoi();
+       continue;
+      }
+      if (option.BeginsWith("Trigger=",TString::kIgnoreCase)) {
+       option.ReplaceAll("Trigger=","");
+       triggerMask = option.Atoll();
+       continue;
+      }
+      AliWarningClass(Form("Ignoring invalid event selection option: %s",option.Data()));
+    }
+    AliInfoClass(Form("Event selection criteria specified:   eventype=%d   trigger mask=%llx",
+                eventType,triggerMask));
+    rawReader->SelectEvents(eventType,triggerMask);
+  }
+
+  fields->Delete();
+  delete fields;
+
+  return rawReader;
+}
+
+Int_t AliRawReader::GetMappedEquipmentId() const
+{
+  if (!fEquipmentIdsIn || !fEquipmentIdsOut) {
+    Error("AliRawReader","equipment Ids mapping is not initialized !");
+    return GetEquipmentId();
+  }
+  Int_t equipmentId = GetEquipmentId();
+  for(Int_t iId = 0; iId < fEquipmentIdsIn->GetSize(); iId++) {
+    if (equipmentId == fEquipmentIdsIn->At(iId)) {
+      equipmentId = fEquipmentIdsOut->At(iId);
+      break;
+    }
+  }
+  return equipmentId;
+}
+
+Int_t AliRawReader::GetDetectorID() const
+{
+  // Get the detector ID
+  // The list of detector IDs
+  // can be found in AliDAQ.h
+  Int_t equipmentId;
+  if (fEquipmentIdsIn && fEquipmentIdsIn)
+    equipmentId = GetMappedEquipmentId();
+  else
+    equipmentId = GetEquipmentId();
+
+  if (equipmentId >= 0) {
+    Int_t ddlIndex;
+    return AliDAQ::DetectorIDFromDdlID(equipmentId,ddlIndex);
+  }
+  else
+    return -1;
+}
+
+Int_t AliRawReader::GetDDLID() const
+{
+  // Get the DDL ID (within one sub-detector)
+  // The list of detector IDs
+  // can be found in AliDAQ.h
+  Int_t equipmentId;
+  if (fEquipmentIdsIn && fEquipmentIdsIn)
+    equipmentId = GetMappedEquipmentId();
+  else
+    equipmentId = GetEquipmentId();
+
+  if (equipmentId >= 0) {
+    Int_t ddlIndex;
+    AliDAQ::DetectorIDFromDdlID(equipmentId,ddlIndex);
+    return ddlIndex;
+  }
+  else
+    return -1;
+}
+
+void AliRawReader::Select(const char *detectorName, Int_t minDDLID, Int_t maxDDLID)
+{
+// read only data of the detector with the given name and in the given
+// range of DDLs (minDDLID <= DDLID <= maxDDLID).
+// no selection is applied if a value < 0 is used.
+  Int_t detectorID = AliDAQ::DetectorID(detectorName);
+  if(detectorID >= 0)
+    Select(detectorID,minDDLID,maxDDLID);
+}
 
 void AliRawReader::Select(Int_t detectorID, Int_t minDDLID, Int_t maxDDLID)
 {
@@ -92,11 +327,17 @@ void AliRawReader::Select(Int_t detectorID, Int_t minDDLID, Int_t maxDDLID)
 // range of DDLs (minDDLID <= DDLID <= maxDDLID).
 // no selection is applied if a value < 0 is used.
 
-  fSelectEquipmentType = 0;
-  if (minDDLID < 0) minDDLID = 0;
-  fSelectMinEquipmentId = (detectorID << 8) + minDDLID;
-  if (maxDDLID < 0) maxDDLID = 0xFF;
-  fSelectMaxEquipmentId = (detectorID << 8) + maxDDLID;
+  fSelectEquipmentType = -1;
+
+  if (minDDLID < 0)
+    fSelectMinEquipmentId = AliDAQ::DdlIDOffset(detectorID);
+  else
+    fSelectMinEquipmentId = AliDAQ::DdlID(detectorID,minDDLID);
+
+  if (maxDDLID < 0)
+    fSelectMaxEquipmentId = AliDAQ::DdlID(detectorID,AliDAQ::NumberOfDdls(detectorID)-1);
+  else
+    fSelectMaxEquipmentId = AliDAQ::DdlID(detectorID,maxDDLID);
 }
 
 void AliRawReader::SelectEquipment(Int_t equipmentType, 
@@ -111,25 +352,73 @@ void AliRawReader::SelectEquipment(Int_t equipmentType,
   fSelectMaxEquipmentId = maxEquipmentId;
 }
 
+void AliRawReader::SelectEvents(Int_t type, ULong64_t triggerMask)
+{
+// read only events with the given type and optionally
+// trigger mask.
+// no selection is applied if a value < 0 is used.
+
+  fSelectEventType = type;
+  fSelectTriggerMask = triggerMask;
+}
+
 Bool_t AliRawReader::IsSelected() const
 {
 // apply the selection (if any)
 
   if (fSkipInvalid && !IsValid()) return kFALSE;
 
-  if (fSelectEquipmentType >= 0) {
+  if (fSelectEquipmentType >= 0)
     if (GetEquipmentType() != fSelectEquipmentType) return kFALSE;
-    if ((fSelectMinEquipmentId >= 0) && 
-       (GetEquipmentId() < fSelectMinEquipmentId))
-      return kFALSE;
-    if ((fSelectMaxEquipmentId >= 0) && 
-       (GetEquipmentId() > fSelectMaxEquipmentId))
-      return kFALSE;
+
+  Int_t equipmentId;
+  if (fEquipmentIdsIn && fEquipmentIdsIn)
+    equipmentId = GetMappedEquipmentId();
+  else
+    equipmentId = GetEquipmentId();
+
+  if ((fSelectMinEquipmentId >= 0) && 
+      (equipmentId < fSelectMinEquipmentId))
+    return kFALSE;
+  if ((fSelectMaxEquipmentId >= 0) && 
+      (equipmentId > fSelectMaxEquipmentId))
+    return kFALSE;
+
+  return kTRUE;
+}
+
+Bool_t AliRawReader::IsEventSelected() const
+{
+  // apply the event selection (if any)
+
+  // First check the event type
+  if (fSelectEventType >= 0) {
+    if (GetType() != (UInt_t) fSelectEventType) return kFALSE;
+  }
+
+  // Then check the trigger pattern and compared it
+  // to the required trigger mask
+  if (fSelectTriggerMask != 0) {
+    if ((GetClassMask() & fSelectTriggerMask) != fSelectTriggerMask) return kFALSE;
   }
 
   return kTRUE;
 }
 
+UInt_t AliRawReader::SwapWord(UInt_t x) const
+{
+   // Swap the endianess of the integer value 'x'
+
+   return (((x & 0x000000ffU) << 24) | ((x & 0x0000ff00U) <<  8) |
+           ((x & 0x00ff0000U) >>  8) | ((x & 0xff000000U) >> 24));
+}
+
+UShort_t AliRawReader::SwapShort(UShort_t x) const
+{
+   // Swap the endianess of the short value 'x'
+
+   return (((x & 0x00ffU) <<  8) | ((x & 0xff00U) >>  8)) ;
+}
 
 Bool_t AliRawReader::ReadNextInt(UInt_t& data)
 {
@@ -148,6 +437,9 @@ Bool_t AliRawReader::ReadNextInt(UInt_t& data)
     Error("ReadNextInt", "could not read data!");
     return kFALSE;
   }
+#ifndef R__BYTESWAP
+  data=SwapWord(data);
+#endif
   return kTRUE;
 }
 
@@ -168,6 +460,9 @@ Bool_t AliRawReader::ReadNextShort(UShort_t& data)
     Error("ReadNextShort", "could not read data!");
     return kFALSE;
   }
+#ifndef R__BYTESWAP
+  data=SwapShort(data);
+#endif
   return kTRUE;
 }
 
@@ -186,6 +481,11 @@ Bool_t AliRawReader::ReadNextChar(UChar_t& data)
   return kTRUE;
 }
 
+Bool_t  AliRawReader::GotoEvent(Int_t event)
+{
+  Error("GotoEvent","Method not implemented! Nothing done");
+  return kFALSE;
+}
 
 Int_t AliRawReader::CheckData() const
 {
@@ -301,3 +601,43 @@ void AliRawReader::DumpData(Int_t limit)
           
   } while (ReadHeader());
 }
+
+void AliRawReader::AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
+                              Int_t code,
+                              const char *message)
+{
+  // Add a raw data error message to the list
+  // of raw-data decoding errors
+  if (fEventNumber < 0) {
+    return;
+  }
+  Int_t ddlId = GetEquipmentId();
+  if (ddlId < 0) {
+    AliError("No ddl raw data have been read so far! Impossible to add a raw data error log!");
+    return;
+  }
+
+  Int_t prevEventNumber = -1;
+  Int_t prevDdlId = -1;
+  Int_t prevErrorCode = -1;
+  AliRawDataErrorLog *prevLog = (AliRawDataErrorLog *)fErrorLogs.Last();
+  if (prevLog) {
+    prevEventNumber = prevLog->GetEventNumber();
+    prevDdlId       = prevLog->GetDdlID();
+    prevErrorCode   = prevLog->GetErrorCode();
+  }
+
+  if ((prevEventNumber != fEventNumber) ||
+      (prevDdlId != ddlId) ||
+      (prevErrorCode != code)) {
+    new (fErrorLogs[fErrorLogs.GetEntriesFast()])
+      AliRawDataErrorLog(fEventNumber,
+                        ddlId,
+                        level,
+                        code,
+                        message);
+  }
+  else
+    if (prevLog) prevLog->AddCount();
+
+}