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 the base class for reading raw data.
22 /// The derived classes, which operate on concrete raw data formats,
24 /// - ReadHeader to read the next (data/equipment) header
25 /// - ReadNextData to read the next raw data block (=1 DDL)
26 /// - ReadNext to read a given number of bytes
27 /// - several getters like GetType
29 /// Sequential access to the raw data is provided by the methods
30 /// ReadHeader, ReadNextData, ReadNextInt, ReadNextShort, ReadNextChar
32 /// If only data from a specific detector (and a given range of DDL numbers)
33 /// should be read, this can be achieved by the Select method.
34 /// Several getters provide information about the current event and the
35 /// current type of raw data.
37 ///////////////////////////////////////////////////////////////////////////////
40 #include <TPluginManager.h>
42 #include <TInterpreter.h>
45 #include <Riostream.h>
46 #include "AliRawReader.h"
47 #include "AliRawReaderFile.h"
48 #include "AliRawReaderDate.h"
49 #include "AliRawReaderRoot.h"
50 #include "AliRawReaderChain.h"
54 ClassImp(AliRawReader)
57 AliRawReader::AliRawReader() :
58 fEquipmentIdsIn(NULL),
59 fEquipmentIdsOut(NULL),
60 fRequireHeader(kTRUE),
63 fSelectEquipmentType(-1),
64 fSelectMinEquipmentId(-1),
65 fSelectMaxEquipmentId(-1),
68 fSelectTriggerMask(0),
72 fErrorLogs("AliRawDataErrorLog",100),
76 // default constructor: initialize data members
77 // Allocate the swapped header in case of Mac
79 fHeaderSwapped=new AliRawDataHeader();
83 Bool_t AliRawReader::LoadEquipmentIdsMap(const char *fileName)
85 // Open the mapping file
86 // and load the mapping data
87 ifstream input(fileName);
88 if (input.is_open()) {
89 Warning("AliRawReader","Equipment ID mapping file is found !");
90 const Int_t kMaxDDL = 256;
91 fEquipmentIdsIn = new TArrayI(kMaxDDL);
92 fEquipmentIdsOut = new TArrayI(kMaxDDL);
93 Int_t equipIn, equipOut;
95 while (input >> equipIn >> equipOut) {
96 if (nIds >= kMaxDDL) {
97 Error("AliRawReader","Too many equipment Id mappings found ! Truncating the list !");
100 fEquipmentIdsIn->AddAt(equipIn,nIds);
101 fEquipmentIdsOut->AddAt(equipOut,nIds);
104 fEquipmentIdsIn->Set(nIds);
105 fEquipmentIdsOut->Set(nIds);
110 Error("AliRawReader","equipment id map file is not found ! Skipping the mapping !");
115 AliRawReader::AliRawReader(const AliRawReader& rawReader) :
117 fEquipmentIdsIn(rawReader.fEquipmentIdsIn),
118 fEquipmentIdsOut(rawReader.fEquipmentIdsOut),
119 fRequireHeader(rawReader.fRequireHeader),
120 fHeader(rawReader.fHeader),
121 fCount(rawReader.fCount),
122 fSelectEquipmentType(rawReader.fSelectEquipmentType),
123 fSelectMinEquipmentId(rawReader.fSelectMinEquipmentId),
124 fSelectMaxEquipmentId(rawReader.fSelectMaxEquipmentId),
125 fSkipInvalid(rawReader.fSkipInvalid),
126 fSelectEventType(rawReader.fSelectEventType),
127 fSelectTriggerMask(rawReader.fSelectTriggerMask),
128 fSelectTriggerExpr(rawReader.fSelectTriggerExpr),
131 fErrorLogs("AliRawDataErrorLog",100),
132 fHeaderSwapped(NULL),
133 fIsValid(rawReader.fIsValid)
136 // Allocate the swapped header in case of Mac
138 fHeaderSwapped=new AliRawDataHeader(*rawReader.fHeaderSwapped);
142 AliRawReader& AliRawReader::operator = (const AliRawReader& rawReader)
144 // assignment operator
145 fEquipmentIdsIn = rawReader.fEquipmentIdsIn;
146 fEquipmentIdsOut = rawReader.fEquipmentIdsOut;
148 fHeader = rawReader.fHeader;
149 fCount = rawReader.fCount;
151 fSelectEquipmentType = rawReader.fSelectEquipmentType;
152 fSelectMinEquipmentId = rawReader.fSelectMinEquipmentId;
153 fSelectMaxEquipmentId = rawReader.fSelectMaxEquipmentId;
154 fSkipInvalid = rawReader.fSkipInvalid;
155 fSelectEventType = rawReader.fSelectEventType;
156 fSelectTriggerMask = rawReader.fSelectTriggerMask;
157 fSelectTriggerExpr = rawReader.fSelectTriggerExpr;
159 fErrorCode = rawReader.fErrorCode;
161 fEventNumber = rawReader.fEventNumber;
162 fErrorLogs = *((TClonesArray*)rawReader.fErrorLogs.Clone());
164 fIsValid = rawReader.fIsValid;
169 AliRawReader::~AliRawReader()
172 // delete the mapping arrays if
174 if (fEquipmentIdsIn) delete fEquipmentIdsIn;
175 if (fEquipmentIdsOut) delete fEquipmentIdsOut;
177 if (fHeaderSwapped) delete fHeaderSwapped;
180 AliRawReader* AliRawReader::Create(const char *uri)
182 // RawReader's factory
183 // It instantiate corresponding raw-reader implementation class object
184 // depending on the URI provided
185 // Normal URIs point to files, while the URI starting with
186 // 'mem://:' or 'mem://<filename>' will create
187 // AliRawReaderDateOnline object which is supposed to be used
188 // in the online reconstruction
190 TString strURI = uri;
192 if (strURI.IsNull()) {
193 AliWarningClass("No raw-reader created");
197 TObjArray *fields = strURI.Tokenize("?");
198 TString &fileURI = ((TObjString*)fields->At(0))->String();
200 AliRawReader *rawReader = NULL;
201 if (fileURI.BeginsWith("mem://") || fileURI.BeginsWith("^")) {
202 if (fileURI.BeginsWith("mem://")) fileURI.ReplaceAll("mem://","");
203 AliInfoClass(Form("Creating raw-reader in order to read events in shared memory (option=%s)",fileURI.Data()));
205 TPluginManager* pluginManager = gROOT->GetPluginManager();
206 TString rawReaderName = "AliRawReaderDateOnline";
207 TPluginHandler* pluginHandler = pluginManager->FindHandler("AliRawReader", "online");
208 // if not, add a plugin for it
209 if (!pluginHandler) {
210 pluginManager->AddHandler("AliRawReader", "online",
211 "AliRawReaderDateOnline", "RAWDatarecOnline", "AliRawReaderDateOnline(const char*)");
212 pluginHandler = pluginManager->FindHandler("AliRawReader", "online");
214 if (pluginHandler && (pluginHandler->LoadPlugin() == 0)) {
215 rawReader = (AliRawReader*)pluginHandler->ExecPlugin(1,fileURI.Data());
222 else if (fileURI.BeginsWith("amore://")) {
223 // A special raw-data URL used in case
224 // the raw-data reading is steered from
225 // ouside, i.e. from AMORE
226 fileURI.ReplaceAll("amore://","");
227 AliInfoClass("Creating raw-reader in order to read events sent by AMORE");
228 rawReader = new AliRawReaderDate((void *)NULL);
230 else if (fileURI.BeginsWith("collection://")) {
231 fileURI.ReplaceAll("collection://","");
232 AliInfoClass(Form("Creating raw-reader in order to read raw-data files collection defined in %s",fileURI.Data()));
233 rawReader = new AliRawReaderChain(fileURI);
235 else if (fileURI.BeginsWith("raw://run")) {
236 fileURI.ReplaceAll("raw://run","");
237 if (fileURI.IsDigit()) {
238 rawReader = new AliRawReaderChain(fileURI.Atoi());
241 AliErrorClass(Form("Invalid syntax: %s",fileURI.Data()));
247 AliInfoClass(Form("Creating raw-reader in order to read raw-data file: %s",fileURI.Data()));
248 TString filename(gSystem->ExpandPathName(fileURI.Data()));
249 if (filename.EndsWith("/")) {
250 rawReader = new AliRawReaderFile(filename);
251 } else if (filename.EndsWith(".root")) {
252 rawReader = new AliRawReaderRoot(filename);
254 rawReader = new AliRawReaderDate(filename);
258 if (!rawReader->IsRawReaderValid()) {
259 AliErrorClass(Form("Raw-reader is invalid - check the input URI (%s)",fileURI.Data()));
266 // Now apply event selection criteria (if specified)
267 if (fields->GetEntries() > 1) {
268 Int_t eventType = -1;
269 ULong64_t triggerMask = 0;
271 for(Int_t i = 1; i < fields->GetEntries(); i++) {
272 if (!fields->At(i)) continue;
273 TString &option = ((TObjString*)fields->At(i))->String();
274 if (option.BeginsWith("EventType=",TString::kIgnoreCase)) {
275 option.ReplaceAll("EventType=","");
276 eventType = option.Atoi();
279 if (option.BeginsWith("Trigger=",TString::kIgnoreCase)) {
280 option.ReplaceAll("Trigger=","");
281 if (option.IsDigit()) {
282 triggerMask = option.Atoll();
285 triggerExpr = option.Data();
289 AliWarningClass(Form("Ignoring invalid event selection option: %s",option.Data()));
291 AliInfoClass(Form("Event selection criteria specified: eventype=%d trigger mask=%llx trigger expression=%s",
292 eventType,triggerMask,triggerExpr.Data()));
293 rawReader->SelectEvents(eventType,triggerMask,triggerExpr.Data());
302 Int_t AliRawReader::GetMappedEquipmentId() const
304 if (!fEquipmentIdsIn || !fEquipmentIdsOut) {
305 Error("AliRawReader","equipment Ids mapping is not initialized !");
306 return GetEquipmentId();
308 Int_t equipmentId = GetEquipmentId();
309 for(Int_t iId = 0; iId < fEquipmentIdsIn->GetSize(); iId++) {
310 if (equipmentId == fEquipmentIdsIn->At(iId)) {
311 equipmentId = fEquipmentIdsOut->At(iId);
318 Int_t AliRawReader::GetDetectorID() const
320 // Get the detector ID
321 // The list of detector IDs
322 // can be found in AliDAQ.h
324 if (fEquipmentIdsIn && fEquipmentIdsIn)
325 equipmentId = GetMappedEquipmentId();
327 equipmentId = GetEquipmentId();
329 if (equipmentId >= 0) {
331 return AliDAQ::DetectorIDFromDdlID(equipmentId,ddlIndex);
337 Int_t AliRawReader::GetDDLID() const
339 // Get the DDL ID (within one sub-detector)
340 // The list of detector IDs
341 // can be found in AliDAQ.h
343 if (fEquipmentIdsIn && fEquipmentIdsIn)
344 equipmentId = GetMappedEquipmentId();
346 equipmentId = GetEquipmentId();
348 if (equipmentId >= 0) {
350 AliDAQ::DetectorIDFromDdlID(equipmentId,ddlIndex);
357 void AliRawReader::Select(const char *detectorName, Int_t minDDLID, Int_t maxDDLID)
359 // read only data of the detector with the given name and in the given
360 // range of DDLs (minDDLID <= DDLID <= maxDDLID).
361 // no selection is applied if a value < 0 is used.
362 Int_t detectorID = AliDAQ::DetectorID(detectorName);
364 Select(detectorID,minDDLID,maxDDLID);
367 void AliRawReader::Select(Int_t detectorID, Int_t minDDLID, Int_t maxDDLID)
369 // read only data of the detector with the given ID and in the given
370 // range of DDLs (minDDLID <= DDLID <= maxDDLID).
371 // no selection is applied if a value < 0 is used.
373 fSelectEquipmentType = -1;
376 fSelectMinEquipmentId = AliDAQ::DdlIDOffset(detectorID);
378 fSelectMinEquipmentId = AliDAQ::DdlID(detectorID,minDDLID);
381 fSelectMaxEquipmentId = AliDAQ::DdlID(detectorID,AliDAQ::NumberOfDdls(detectorID)-1);
383 fSelectMaxEquipmentId = AliDAQ::DdlID(detectorID,maxDDLID);
386 void AliRawReader::SelectEquipment(Int_t equipmentType,
387 Int_t minEquipmentId, Int_t maxEquipmentId)
389 // read only data of the equipment with the given type and in the given
390 // range of IDs (minEquipmentId <= EquipmentId <= maxEquipmentId).
391 // no selection is applied if a value < 0 is used.
393 fSelectEquipmentType = equipmentType;
394 fSelectMinEquipmentId = minEquipmentId;
395 fSelectMaxEquipmentId = maxEquipmentId;
398 void AliRawReader::SelectEvents(Int_t type, ULong64_t triggerMask,
399 const char *triggerExpr)
401 // read only events with the given type and optionally
403 // no selection is applied if value = 0 is used.
404 // Trigger selection can be done via string (triggerExpr)
405 // which defines the trigger logic to be used. It works only
406 // after LoadTriggerClass() method is called for all involved
409 fSelectEventType = type;
410 fSelectTriggerMask = triggerMask;
411 if (triggerExpr) fSelectTriggerExpr = triggerExpr;
414 void AliRawReader::LoadTriggerClass(const char* name, Int_t index)
416 // Loads the list of trigger classes defined.
417 // Used in conjunction with IsEventSelected in the
418 // case when the trigger selection is given by
419 // fSelectedTriggerExpr
421 if (fSelectTriggerExpr.IsNull()) return;
423 fSelectTriggerExpr.ReplaceAll(name,Form("[%d]",index));
426 Bool_t AliRawReader::IsSelected() const
428 // apply the selection (if any)
430 if (fSkipInvalid && !IsValid()) return kFALSE;
432 if (fSelectEquipmentType >= 0)
433 if (GetEquipmentType() != fSelectEquipmentType) return kFALSE;
436 if (fEquipmentIdsIn && fEquipmentIdsIn)
437 equipmentId = GetMappedEquipmentId();
439 equipmentId = GetEquipmentId();
441 if ((fSelectMinEquipmentId >= 0) &&
442 (equipmentId < fSelectMinEquipmentId))
444 if ((fSelectMaxEquipmentId >= 0) &&
445 (equipmentId > fSelectMaxEquipmentId))
451 Bool_t AliRawReader::IsEventSelected() const
453 // apply the event selection (if any)
455 // First check the event type
456 if (fSelectEventType >= 0) {
457 if (GetType() != (UInt_t) fSelectEventType) return kFALSE;
460 // Then check the trigger pattern and compared it
461 // to the required trigger mask
462 if (fSelectTriggerMask != 0) {
463 if ((GetClassMask() & fSelectTriggerMask) != fSelectTriggerMask) return kFALSE;
466 if (!fSelectTriggerExpr.IsNull()) {
467 TString expr(fSelectTriggerExpr);
468 ULong64_t mask = GetClassMask();
469 for(Int_t itrigger = 0; itrigger < 50; itrigger++) {
470 if (mask & (1 << itrigger)) {
471 expr.ReplaceAll(Form("[%d]",itrigger),"1");
474 expr.ReplaceAll(Form("[%d]",itrigger),"0");
478 if ((gROOT->ProcessLineFast(expr.Data(),&error) == 0) &&
479 (error == TInterpreter::kNoError)) {
487 UInt_t AliRawReader::SwapWord(UInt_t x) const
489 // Swap the endianess of the integer value 'x'
491 return (((x & 0x000000ffU) << 24) | ((x & 0x0000ff00U) << 8) |
492 ((x & 0x00ff0000U) >> 8) | ((x & 0xff000000U) >> 24));
495 UShort_t AliRawReader::SwapShort(UShort_t x) const
497 // Swap the endianess of the short value 'x'
499 return (((x & 0x00ffU) << 8) | ((x & 0xff00U) >> 8)) ;
502 Bool_t AliRawReader::ReadNextInt(UInt_t& data)
504 // reads the next 4 bytes at the current position
505 // returns kFALSE if the data could not be read
507 while (fCount == 0) {
508 if (!ReadHeader()) return kFALSE;
510 if (fCount < (Int_t) sizeof(data)) {
512 "too few data left (%d bytes) to read an UInt_t!", fCount);
515 if (!ReadNext((UChar_t*) &data, sizeof(data))) {
516 Error("ReadNextInt", "could not read data!");
525 Bool_t AliRawReader::ReadNextShort(UShort_t& data)
527 // reads the next 2 bytes at the current position
528 // returns kFALSE if the data could not be read
530 while (fCount == 0) {
531 if (!ReadHeader()) return kFALSE;
533 if (fCount < (Int_t) sizeof(data)) {
534 Error("ReadNextShort",
535 "too few data left (%d bytes) to read an UShort_t!", fCount);
538 if (!ReadNext((UChar_t*) &data, sizeof(data))) {
539 Error("ReadNextShort", "could not read data!");
543 data=SwapShort(data);
548 Bool_t AliRawReader::ReadNextChar(UChar_t& data)
550 // reads the next 1 byte at the current stream position
551 // returns kFALSE if the data could not be read
553 while (fCount == 0) {
554 if (!ReadHeader()) return kFALSE;
556 if (!ReadNext((UChar_t*) &data, sizeof(data))) {
557 Error("ReadNextChar", "could not read data!");
563 Bool_t AliRawReader::GotoEvent(Int_t event)
565 // Random access to certain
566 // event index. Could be very slow
567 // for some non-root raw-readers.
568 // So it should be reimplemented there.
569 if (event < fEventNumber) RewindEvents();
571 while (fEventNumber < event) {
572 if (!NextEvent()) return kFALSE;
578 Int_t AliRawReader::CheckData() const
580 // check the consistency of the data
581 // derived classes should overwrite the default method which returns 0 (no err)
587 void AliRawReader::DumpData(Int_t limit)
589 // print the raw data
590 // if limit is not negative, only the first and last "limit" lines of raw data
595 Error("DumpData", "no header");
599 " type = %d run = %d ", GetType(), GetRunNumber());
601 printf("event = %8.8x %8.8x\n", GetEventId()[1], GetEventId()[0]);
603 printf("event = -------- --------\n");
605 if (GetTriggerPattern()) {
606 printf(" trigger = %8.8x %8.8x ",
607 GetTriggerPattern()[1], GetTriggerPattern()[0]);
609 printf(" trigger = -------- -------- ");
611 if (GetDetectorPattern()) {
612 printf("detector = %8.8x\n", GetDetectorPattern()[0]);
614 printf("detector = --------\n");
616 if (GetAttributes()) {
617 printf(" attributes = %8.8x %8.8x %8.8x ",
618 GetAttributes()[2], GetAttributes()[1], GetAttributes()[0]);
620 printf(" attributes = -------- -------- -------- ");
622 printf("GDC = %d\n", GetGDCId());
626 printf("-------------------------------------------------------------------------------\n");
627 printf("LDC = %d\n", GetLDCId());
629 printf("equipment:\n"
630 " size = %d type = %d id = %d\n",
631 GetEquipmentSize(), GetEquipmentType(), GetEquipmentId());
632 if (GetEquipmentAttributes()) {
633 printf(" attributes = %8.8x %8.8x %8.8x ", GetEquipmentAttributes()[2],
634 GetEquipmentAttributes()[1], GetEquipmentAttributes()[0]);
636 printf(" attributes = -------- -------- -------- ");
638 printf("element size = %d\n", GetEquipmentElementSize());
640 printf("data header:\n"
641 " size = %d version = %d valid = %d compression = %d\n",
642 GetDataSize(), GetVersion(), IsValid(), IsCompressed());
645 if (limit == 0) continue;
647 Int_t size = GetDataSize();
649 for (Int_t i = 0; i < 70; i++) line[i] = ' ';
655 for (Int_t n = 0; n < size; n++) {
656 if (!ReadNextChar(byte)) {
657 Error("DumpData", "couldn't read byte number %d\n", n);
661 printf("%8.8x %s\n", n-pos, line);
662 for (Int_t i = 0; i < 70; i++) line[i] = ' ';
665 if ((limit > 0) && (n/max == limit)) {
666 Int_t nContinue = ((size-1)/max+1-limit) * max;
668 printf(" [skipping %d bytes]\n", nContinue-n);
674 Int_t offset = pos/4;
675 if ((byte > 0x20) && (byte < 0x7f)) {
676 line[pos+offset] = byte;
678 line[pos+offset] = '.';
681 sprintf(hex, "%2.2x", byte);
682 line[max+max/4+3+2*pos+offset] = hex[0];
683 line[max+max/4+4+2*pos+offset] = hex[1];
687 if (pos > 0) printf("%8.8x %s\n", size-pos, line);
690 } while (ReadHeader());
693 void AliRawReader::AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
697 // Add a raw data error message to the list
698 // of raw-data decoding errors
699 if (fEventNumber < 0) {
702 Int_t ddlId = GetEquipmentId();
704 AliError("No ddl raw data have been read so far! Impossible to add a raw data error log!");
708 Int_t prevEventNumber = -1;
709 Int_t prevDdlId = -1;
710 Int_t prevErrorCode = -1;
711 AliRawDataErrorLog *prevLog = (AliRawDataErrorLog *)fErrorLogs.Last();
713 prevEventNumber = prevLog->GetEventNumber();
714 prevDdlId = prevLog->GetDdlID();
715 prevErrorCode = prevLog->GetErrorCode();
718 if ((prevEventNumber != fEventNumber) ||
719 (prevDdlId != ddlId) ||
720 (prevErrorCode != code)) {
721 new (fErrorLogs[fErrorLogs.GetEntriesFast()])
722 AliRawDataErrorLog(fEventNumber,
729 if (prevLog) prevLog->AddCount();
733 Bool_t AliRawReader::GotoEventWithID(Int_t event,
738 // Go to certain event number by
739 // checking the event ID.
740 // Useful in case event-selection
741 // is applied and the 'event' is
743 if (!GotoEvent(event)) return kFALSE;
745 while (GetBCID() != period ||
746 GetOrbitID() != orbitID ||
747 GetPeriod() != bcID) {
748 if (!NextEvent()) return kFALSE;