]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - TRD/AliTRDrawStream.h
Be sure to load mapping when needed
[u/mrichter/AliRoot.git] / TRD / AliTRDrawStream.h
index 20cdcd3424cc9b6e208a41f838b37974de6fdcb2..0719ffd48e9e8c23f0854ea1b8e65e1bd64a4fb0 100644 (file)
@@ -3,7 +3,7 @@
 
 //-----------------------------------
 //
-// decoding of TRD raw data stream 
+// decoding of TRD raw data stream
 // and translation into digits
 //
 //----------------------------------
 #define ALITRDRAWSTREAM_H
 
 #include "TObject.h"
+#include "TClonesArray.h"
+#include "TTree.h"
 
-#include "AliTRDrawStreamBase.h"
-//#include "AliRawReader.h"
+#include "AliLog.h"
 
 class TObjArray;
 class TString;
-class TTree;
+class TBranch;
 
 class AliRawReader;
 class AliTRDdigitsManager;
 class AliTRDdigitsParam;
 class AliTRDarrayADC;
 class AliTRDSignalIndex;
+class AliTRDtrackletContainer;
 
-class AliTRDrawStream : public AliTRDrawStreamBase
+class AliTRDrawStream : public TObject
 {
  public:
   AliTRDrawStream(AliRawReader *rawReader = 0x0);
   ~AliTRDrawStream();
 
+  enum { kDDLOffset = 0x400,                                  // Offset for DDL numbers
+         kDDLMax    = 0x411 };                                // Max DDL number for TRD SM
+
   Bool_t SetReader(AliRawReader *rawReader) { fRawReader = rawReader; return kTRUE; }
   void SetDigitsManager(AliTRDdigitsManager *digMgr) { fDigitsManager = digMgr; }
+  void SetTrackletArray(TClonesArray *ar) { fTracklets = ar; }
+  void SetTrackArray(TClonesArray *ar) { fTracks = ar; }
+  void SetMarkerArray(TClonesArray *ar) { fMarkers = ar; }
+
+  TClonesArray* GetTrackletArray() const { return fTracklets; }
+  TClonesArray* GetTrackArray() const { return fTracks; }
+  TClonesArray* GetMarkerArray() const { return fMarkers; }
+
+  AliTRDdigitsManager* GetDigitsManager() const { return fDigitsManager; }
+  TTree *GetTrackletTree() const { return fTrackletTree; }
 
   Bool_t ReadEvent(TTree *trackletTree = 0x0);
 
   Bool_t NextDDL();
-  Int_t NextChamber(AliTRDdigitsManager *digMgr, 
-                   UInt_t ** /* trackletContainer */, UShort_t ** /* errorContainer */);
+  Int_t NextChamber(AliTRDdigitsManager *digMgr);
+  Int_t NextChamber(AliTRDdigitsManager *digMgr,
+                     UInt_t ** /* trackletContainer */, UShort_t ** /* errorContainer */) { AliError("Deprecated, use NextChamber(AliTRDdigitsManger*) instead!"); return NextChamber(digMgr); }
+
+  Bool_t ConnectTracklets(TTree *trklTree);
 
-  // legacy code, to be removed
-  Bool_t SetRawVersion(Int_t) { return kTRUE; }
-  void SetSharedPadReadout(Bool_t) {}
-  void SetNoErrorWarning() {}
+  void StoreErrorsInTree()   { fStoreError = &AliTRDrawStream::StoreErrorTree; }
+  void StoreErrorsInArray()  { fStoreError = &AliTRDrawStream::StoreErrorArray; }
+  void EnableErrorStorage()  { fStoreError = &AliTRDrawStream::StoreErrorTree; }
+  void DisableErrorStorage() { fStoreError = &AliTRDrawStream::ForgetError; }
 
   // error handling
-  enum ErrorCode_t { 
-    kUnknown = 0, 
-    kLinkMonitor, 
-    kPtrgCntMismatch, 
+  enum ErrorCode_t {
+    kUnknown = 0,
+    kLinkMonitor,
+    kPtrgCntMismatch,
     kNonTrdEq,
     kStackHeaderInvalid,
     kInvalidDetector,
@@ -66,15 +84,109 @@ class AliTRDrawStream : public AliTRDrawStreamBase
     kAdcDataAbort,
     kAdcChannelsMiss,
     kMissMcmHeaders,
+    kMissTpData,
     kLastErrorCode
-  }; 
+  };
+
+  enum ErrorBehav_t {
+    kTolerate = 0,
+    kAbort = 1,
+    kDiscardMCM = 2,
+    kDiscardHC = 4
+  };
+
+  enum MarkerCode_t {
+    kHCactive = 1,
+    kSecactive = 2
+  };
 
   TTree* GetErrorTree() const { return fErrors; }
   static const char* GetErrorMessage(ErrorCode_t errCode);
+  static void SetErrorDebugLevel(ErrorCode_t error, Int_t level) { fgErrorDebugLevel[error] = level; }
+  static void SetErrorBehaviour(ErrorCode_t error, ErrorBehav_t behav) { fgErrorBehav[error] = behav; }
+
+  class AliTRDrawStreamError : public TObject {
+  public:
+    AliTRDrawStreamError(Int_t error = 0, Int_t sector = -1, Int_t stack = -1, Int_t link = -1, Int_t rob = -1, Int_t mcm = -1);
+    virtual ~AliTRDrawStreamError() {}
+    Int_t fError;                               // error code
+    Int_t fSector;                             // sector
+    Int_t fStack;                              // stack
+    Int_t fLink;                               // link
+    Int_t fRob;                                        // ROB no
+    Int_t fMcm;                                        // MCM no
+    ClassDef(AliTRDrawStreamError, 1);
+  };
+
+  // event statistics
+  class AliTRDrawStats : public TObject {
+  public:
+    AliTRDrawStats() : TObject(), fBytesRead(0) {}
+    void ClearStats();
+
+    class AliTRDrawStatsSector : public TObject {
+    public:
+      AliTRDrawStatsSector() : TObject(), fBytes(0), fBytesRead(0), fNTracklets(0), fNMCMs(0), fNChannels(0) {}
+      void ClearStats();
+
+      class AliTRDrawStatsHC : public TObject {
+      public:
+        AliTRDrawStatsHC() : TObject(), fBytes(0), fBytesRead(0), fNTracklets(0), fNMCMs(0), fNChannels(0) {}
+       void ClearStats();
+
+       Int_t fBytes;             // number of bytes (not necessarily read)
+       Int_t fBytesRead;         // number of bytes read
+       Int_t fNTracklets;        // number of tracklets
+       Int_t fNMCMs;             // number of MCMs (from MCM headers)
+       Int_t fNChannels;         // number of channels
+       ClassDef(AliTRDrawStatsHC, 1);
+      };
+
+      Int_t fBytes;                 // number of bytes (not necessarily read)
+      Int_t fBytesRead;                     // number of bytes read
+      Int_t fNTracklets;            // number of tracklets
+      Int_t fNMCMs;                 // number of MCMs (from MCM headers)
+      Int_t fNChannels;                     // number of channels
+      AliTRDrawStatsHC fStatsHC[60]; //[60] HC-wise statistics
+      ClassDef(AliTRDrawStatsSector, 1);
+    };
+
+    AliTRDrawStatsSector fStatsSector[18]; //[18] sector-wise statistics
+    Int_t fBytesRead;                     // number of bytes read
+    ClassDef(AliTRDrawStats, 1);
+  };
+
+  AliTRDrawStats* GetStats() { return &fStats; }
+  Int_t GetEventSize(Int_t sector)  const { return fStats.fStatsSector[sector].fBytes; }
+  Int_t GetNTracklets(Int_t sector) const { return fStats.fStatsSector[sector].fNTracklets; }
+  Int_t GetNMCMs(Int_t sector)      const { return fStats.fStatsSector[sector].fNMCMs; }
+  Int_t GetNChannels(Int_t sector)  const { return fStats.fStatsSector[sector].fNChannels; }
+
+  ULong64_t GetTrkFlags(Int_t sector, Int_t stack) const { return fCurrTrkFlags[sector*fgkNstacks + stack]; }
+  UInt_t GetTriggerFlags(Int_t sector) const { return fCurrTrgFlags[sector]; }
+
+  // raw data dumping
+  void SetDumpMCM(Int_t det, Int_t rob, Int_t mcm, Bool_t dump = kTRUE);
+
+  Bool_t IsDumping() const { return (fNDumpMCMs > 0); }
+  Bool_t DumpingMCM(Int_t det, Int_t rob, Int_t mcm) const;
+
+  TString DumpRaw(TString title, UInt_t *start, Int_t length, UInt_t endmarker = 0xffffffff);
+  TString DumpMcmHeader(TString title, UInt_t word);
+  TString DumpAdcMask(TString title, UInt_t word);
+
+  // temporary: allow to change expected readout order
+  static void SetMCMReadoutPos(Int_t mcm, Int_t pos) { if (mcm > -1 && mcm < 16) fgMcmOrder[mcm] = pos; }
+  static void SetROBReadoutPos(Int_t robpair, Int_t pos) { if (robpair > -1 && robpair < 4) fgMcmOrder[robpair] = pos; }
 
  protected:
+  Int_t ReadGTUHeaders(UInt_t *buffer);
   Int_t ReadSmHeader();
-  Int_t ReadStackIndexHeader(Int_t stack);
+  Int_t ReadTrackingHeader(Int_t stack);
+  Int_t ReadTriggerHeaders();
+  Int_t ReadStackHeader(Int_t stack);
+  Int_t DecodeGTUtracks();
+  Int_t ReadGTUTrailer();
 
   Int_t ReadLinkData();
   Int_t ReadTracklets();
@@ -83,6 +195,8 @@ class AliTRDrawStream : public AliTRDrawStreamBase
   Int_t ReadZSData();
   Int_t ReadNonZSData();
 
+  Int_t SeekNextLink();
+
   // MCM header decoding
   Int_t ROB(UInt_t mcmhdr) const { return 0x7 & mcmhdr >> 28; }
   Int_t MCM(UInt_t mcmhdr) const { return 0xf & mcmhdr >> 24; }
@@ -93,52 +207,63 @@ class AliTRDrawStream : public AliTRDrawStreamBase
   Int_t Check(UInt_t mcmhdr) const { return 0xf & mcmhdr; }
   Int_t CouldBeMCMhdr(UInt_t mcmhdr) const { return ((0xf & mcmhdr) == 0xc); }
 
-  Int_t GetMCMReadoutPos(Int_t mcm) const { return (mcm > -1 && mcm < 16) ? fgkMcmOrder[mcm] : -1; }
-  Int_t GetROBReadoutPos(Int_t rob) const { return (rob > -1 && rob < 4) ? fgkRobOrder[rob] : -1; }
+  Int_t GetMCMReadoutPos(Int_t mcm) const { return (mcm > -1 && mcm < 16) ? fgMcmOrder[mcm] : -1; }
+  Int_t GetROBReadoutPos(Int_t rob) const { return (rob > -1 && rob < 4) ? fgRobOrder[rob] : -1; }
 
   // ADC mask decoding
   Int_t GetActiveChannels(UInt_t adcmask) const { return 0x1fffff & adcmask >> 4; }
-  Int_t GetNActiveChannelsFromMask(UInt_t adcmask) const; // { Int_t nch = 0; for (Int_t i = 0; i < 21; i++) if ((GetActiveChannels(adcmask) & 1 << i)) nch++; return nch; }
+  inline Int_t GetNActiveChannelsFromMask(UInt_t adcmask) const; // { Int_t nch = 0; for (Int_t i = 0; i < 21; i++) if ((GetActiveChannels(adcmask) & 1 << i)) nch++; return nch; }
   Int_t GetNActiveChannels(UInt_t adcmask) const { return (0x1f & ~(adcmask >> 25)); }
   Int_t CouldBeADCmask(UInt_t adcmask) const { return ((0xf & adcmask) == 0xc && (0x3 & adcmask >> 30) == 0x1); }
-      
-  // error message generation
-  TString EquipmentError(ErrorCode_t err = kUnknown, TString msg = ""); 
-  TString StackError    (ErrorCode_t err = kUnknown, TString msg = "");     
-  TString LinkError     (ErrorCode_t err = kUnknown, TString msg = ""); 
-  TString ROBError      (ErrorCode_t err = kUnknown, TString msg = ""); 
-  TString MCMError      (ErrorCode_t err = kUnknown, TString msg = ""); 
 
-  static char* fgErrorMessages[kLastErrorCode]; // error messages corresponding to the error codes
+  // error message generation
+  void EquipmentError(ErrorCode_t err = kUnknown, const char *const msg = "", ...);
+  void StackError    (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
+  void LinkError     (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
+  void ROBError      (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
+  void MCMError      (ErrorCode_t err = kUnknown, const char *const msg = "", ...);
+  void StoreErrorTree() { fErrors->Fill(); }
+  void StoreErrorArray() { new ((*fMarkers)[fMarkers->GetEntriesFast()]) AliTRDrawStreamError(fLastError); }
+  void ForgetError() { return; }
+  void (AliTRDrawStream::*fStoreError)();       //! function pointer to method used for storing the error
+
+  static const char* fgkErrorMessages[kLastErrorCode];     // error messages corresponding to the error codes
+  static       Int_t fgErrorDebugLevel[kLastErrorCode];   // error debug level
+  static       ErrorBehav_t fgErrorBehav[kLastErrorCode]; // bevhaviour in case of error of given type
 
   // I/O
-  AliRawReader *fRawReader;                     // pointer to the raw reader to take the data from 
+  AliRawReader *fRawReader;                     // pointer to the raw reader to take the data from
   AliTRDdigitsManager *fDigitsManager;          // pointer to the digitsManager to fill the data
   AliTRDdigitsParam   *fDigitsParam;            // pointer to the parameters belonging to the digits
 
   TTree *fErrors;                               // tree containing the occured error codes
-  struct { Int_t fSector; Int_t fStack; Int_t fLink; Int_t fError; Int_t fRob; Int_t fMcm; } 
-  fLastError;                                   // last error which occured
+  AliTRDrawStreamError fLastError;              // last error which occured
+  UInt_t fErrorFlags;                           // error flags used to steer subsequent reading
+  char   fErrorBuffer[100];                     // buffer for error message
+
+  AliTRDrawStats fStats;            // event statistics, clearing must be done by the user
 
   UInt_t *fPayloadStart;                        // pointer to start of data payload
   UInt_t *fPayloadCurr;                         // pointer to current reading position in the payload
-  Int_t   fPayloadSize;                         // size of the payload
+  Int_t   fPayloadSize;                         // size of the payload (in UInt_t words)
 
   static const Int_t fgkNlinks;                 // number of links to read
+  static const Int_t fgkNsectors;               // number of sectors
   static const Int_t fgkNstacks;                // number of stacks to read
-  static const UInt_t fgkDataEndmarker;         // data endmarker 
+  static const Int_t fgkNtriggers;              // number of triggers in data stream
+  static const UInt_t fgkDataEndmarker;         // data endmarker
   static const UInt_t fgkTrackletEndmarker;     // tracklet endmarker
-  static const Int_t fgkMcmOrder [];            // expected readout order of the MCMs
-  static const Int_t fgkRobOrder [];            // expected readout order of the ROBs
+  static       Int_t fgMcmOrder [];             // expected readout order of the MCMs
+  static       Int_t fgRobOrder [];             // expected readout order of the ROBs
 
   // persistent information
   Int_t  fNtimebins;                            // number of timebins
-  Int_t  fLastEvId;                             // Event ID of last event 
+  Int_t  fLastEvId;                             // Event ID of last event
 
   // information valid at current reader position
   // all the variables fCurr... refer to the value at the current
   // reading position
-  Int_t fCurrSlot;                              // current slot 
+  Int_t fCurrSlot;                              // current slot
   Int_t fCurrLink;                             // current link
   Int_t fCurrRobPos;                           // current ROB number
   Int_t fCurrMcmPos;                           // current MCM number
@@ -146,21 +271,39 @@ class AliTRDrawStream : public AliTRDrawStreamBase
   // DDL header
   UInt_t fCurrEquipmentId;                     // current Equipment ID
 
-  // SMU index header
-  UInt_t fCurrSmuIndexHeaderSize;              // current size of the SMU index header
-  UInt_t fCurrSmuIndexHeaderVersion;           // current version of the SMU index header
+  // SM header
+  UInt_t fCurrSmHeaderSize;                     // current size of the SM header
+  UInt_t fCurrSmHeaderVersion;                  // current version of the SM header
+  UInt_t fCurrTrailerReadout;                  // current presence of trailer (after the payload)
+  UInt_t fCurrTrgHeaderAvail;                  // current trigger information availability
+  UInt_t fCurrTrgHeaderReadout;                 // current readout mode for the trigger headers
+  UInt_t fCurrTrkHeaderAvail;                  // current tracking information availability
+  UInt_t fCurrEvType;                          // current event type
+  UInt_t fCurrTriggerEnable;                    // current trigger enable
+  UInt_t fCurrTriggerFired;                     // current trigger fired
   UInt_t fCurrTrackEnable;                     // current value of track enable
   UInt_t fCurrTrackletEnable;                  // current value of tracklet enable
   UInt_t fCurrStackMask;                       // current mask of active stacks
 
-  // Stack index header
+  // Tracking header
+  UInt_t *fCurrTrkHeaderIndexWord;              // current tracking header index word
+  UInt_t *fCurrTrkHeaderSize;                   // current tracking header index word
+  ULong64_t *fCurrTrkFlags;                     // current tracking done flags
+
+  // Trigger header
+  UInt_t *fCurrTrgHeaderIndexWord;              // current tracking header index word
+  UInt_t *fCurrTrgHeaderSize;                   // current tracking header index word
+  UInt_t *fCurrTrgFlags;                       // current trigger flags of all sectors
+
+  // Stack header
   UInt_t *fCurrStackIndexWord;                 // current stack index words
   UInt_t *fCurrStackHeaderSize;                        // current stack index sizes
   UInt_t *fCurrStackHeaderVersion;             // current stack header versions
   UInt_t *fCurrLinkMask;                       // current link masks
   UInt_t *fCurrCleanCheckout;                  // current clean checkout flags
   UInt_t *fCurrBoardId;                                // current board IDs
-  UInt_t *fCurrHwRev;                          // current hardware revision
+  UInt_t  fCurrHwRev;                          // current hardware revision
+  UInt_t *fCurrHwRevTMU;                       // current hardware revision
   UInt_t *fCurrLinkMonitorFlags;               // current link monitor flags
   UInt_t *fCurrLinkDataTypeFlags;              // current link data flags
   UInt_t *fCurrLinkDebugFlags;                 // current link debug flags
@@ -181,6 +324,10 @@ class AliTRDrawStream : public AliTRDrawStreamBase
   Int_t fCurrPtrgCnt;                          // current pretrigger count
   Int_t fCurrPtrgPhase;                                // current pretrigger phase
 
+  // settings for dumping
+  Int_t fDumpMCM[100];                         // MCMs to dump
+  Int_t fNDumpMCMs;                             // number of MCMs to dump
+
   // tracklet information
   TClonesArray *fTrackletArray;                        // pointer to array for tracklet storage
 
@@ -188,6 +335,9 @@ class AliTRDrawStream : public AliTRDrawStreamBase
   AliTRDarrayADC *fAdcArray;                   // pointer to ADC array
   AliTRDSignalIndex *fSignalIndex;             // pointer to the signal index
   TTree *fTrackletTree;                        // pointer to the tree for tracklet storage
+  TClonesArray *fTracklets;                    // pointer to array of tracklets
+  TClonesArray *fTracks;                       // pointer to array of GTU tracks
+  TClonesArray *fMarkers;                      // pointer to array of markers (data present, errors, ...)
 
   AliTRDrawStream(const AliTRDrawStream&);           // not implemented
   AliTRDrawStream& operator=(const AliTRDrawStream&); // not implemented
@@ -195,4 +345,14 @@ class AliTRDrawStream : public AliTRDrawStreamBase
   ClassDef(AliTRDrawStream, 0);
 };
 
+Int_t AliTRDrawStream::GetNActiveChannelsFromMask(UInt_t adcmask) const
+{
+  // return number of active bits in the ADC mask
+
+  adcmask = GetActiveChannels(adcmask);
+  adcmask = adcmask - ((adcmask >> 1) & 0x55555555);
+  adcmask = (adcmask & 0x33333333) + ((adcmask >> 2) & 0x33333333);
+  return (((adcmask + (adcmask >> 4)) & 0xF0F0F0F) * 0x1010101) >> 24;
+}
+
 #endif