Changes needed by the online event reconstruction: AliRawReaderDate's NextEvent(...
[u/mrichter/AliRoot.git] / RAW / AliRawReaderDate.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 date file or event.
21 ///
22 /// The AliRawReaderDate is constructed either with a pointer to a
23 /// date event or with a file name and an event number.
24 ///
25 ///////////////////////////////////////////////////////////////////////////////
26
27 #include "AliRawReaderDate.h"
28 #ifdef ALI_DATE
29 #include "event.h"
30 #endif
31
32 ClassImp(AliRawReaderDate)
33
34
35 AliRawReaderDate::AliRawReaderDate(
36 #ifdef ALI_DATE
37                                    void* event
38 #else
39                                    void* /* event */
40 #endif
41                                    ) :
42   fFile(NULL),
43   fEvent(NULL),
44   fSubEvent(NULL),
45   fEquipment(NULL),
46   fPosition(NULL),
47   fEnd(NULL)
48 {
49 // create an object to read digits from the given date event
50
51 #ifdef ALI_DATE
52   fEvent = (eventHeaderStruct*) event;
53 #else
54   Fatal("AliRawReaderDate", "this class was compiled without DATE");
55 #endif
56 }
57
58 AliRawReaderDate::AliRawReaderDate(
59 #ifdef ALI_DATE
60                                    const char* fileName, Int_t eventNumber
61 #else
62                                    const char* /*fileName*/, 
63                                    Int_t /*eventNumber*/
64 #endif
65                                    ) :
66   fFile(NULL),
67   fEvent(NULL),
68   fSubEvent(NULL),
69   fEquipment(NULL),
70   fPosition(NULL),
71   fEnd(NULL)
72 {
73 // create an object to read digits from the given date event
74
75 #ifdef ALI_DATE
76   fFile = fopen(fileName, "rb");
77   if (!fFile) {
78     Error("AliRawReaderDate", "could not open file %s", fileName);
79     return;
80   }
81   if (eventNumber < 0) return;
82
83   eventHeaderStruct header;
84   UInt_t headerSize = sizeof(eventHeaderStruct);
85   while (fread(&header, 1, headerSize, fFile) == headerSize) {
86     if (eventNumber == 0) {
87       UChar_t* buffer = new UChar_t[header.eventSize];
88       fseek(fFile, -(long)headerSize, SEEK_CUR);
89       if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) break;
90       fEvent = (eventHeaderStruct*) buffer;
91       break;
92     }
93     fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
94     eventNumber--;
95   }
96
97 #else
98   Fatal("AliRawReaderDate", "this class was compiled without DATE");
99 #endif
100 }
101
102 AliRawReaderDate::AliRawReaderDate(const AliRawReaderDate& rawReader) :
103   AliRawReader(rawReader),
104   fFile(rawReader.fFile),
105   fEvent(rawReader.fEvent),
106   fSubEvent(rawReader.fSubEvent),
107   fEquipment(rawReader.fEquipment),
108   fPosition(rawReader.fPosition),
109   fEnd(rawReader.fEnd)
110
111 {
112 // copy constructor
113
114   Fatal("AliRawReaderDate", "copy constructor not implemented");
115 }
116
117 AliRawReaderDate& AliRawReaderDate::operator = (const AliRawReaderDate& 
118                                                 /*rawReader*/)
119 {
120 // assignment operator
121
122   Fatal("operator =", "assignment operator not implemented");
123   return *this;
124 }
125
126 AliRawReaderDate::~AliRawReaderDate()
127 {
128 // destructor
129
130 #ifdef ALI_DATE
131   if (fFile) {
132     delete[] fEvent;
133     fclose(fFile);
134   }
135 #endif
136 }
137
138
139 UInt_t AliRawReaderDate::GetType() const
140 {
141 // get the type from the event header
142
143 #ifdef ALI_DATE
144   if (!fEvent) return 0;
145   return fEvent->eventType;
146 #else
147   return 0;
148 #endif
149 }
150
151 UInt_t AliRawReaderDate::GetRunNumber() const
152 {
153 // get the run number from the event header
154
155 #ifdef ALI_DATE
156   if (!fEvent) return 0;
157   return fEvent->eventRunNb;
158 #else
159   return 0;
160 #endif
161 }
162
163 const UInt_t* AliRawReaderDate::GetEventId() const
164 {
165 // get the event id from the event header
166
167 #ifdef ALI_DATE
168   if (!fEvent) return NULL;
169   return fEvent->eventId;
170 #else
171   return NULL;
172 #endif
173 }
174
175 const UInt_t* AliRawReaderDate::GetTriggerPattern() const
176 {
177 // get the trigger pattern from the event header
178
179 #ifdef ALI_DATE
180   if (!fEvent) return NULL;
181   return fEvent->eventTriggerPattern;
182 #else
183   return NULL;
184 #endif
185 }
186
187 const UInt_t* AliRawReaderDate::GetDetectorPattern() const
188 {
189 // get the detector pattern from the event header
190
191 #ifdef ALI_DATE
192   if (!fEvent) return NULL;
193   return fEvent->eventDetectorPattern;
194 #else
195   return NULL;
196 #endif
197 }
198
199 const UInt_t* AliRawReaderDate::GetAttributes() const
200 {
201 // get the type attributes from the event header
202
203 #ifdef ALI_DATE
204   if (!fEvent) return NULL;
205   return fEvent->eventTypeAttribute;
206 #else
207   return NULL;
208 #endif
209 }
210
211 const UInt_t* AliRawReaderDate::GetSubEventAttributes() const
212 {
213 // get the type attributes from the sub event header
214
215 #ifdef ALI_DATE
216   if (!fSubEvent) return NULL;
217   return fSubEvent->eventTypeAttribute;
218 #else
219   return NULL;
220 #endif
221 }
222
223 UInt_t AliRawReaderDate::GetLDCId() const
224 {
225 // get the LDC Id from the event header
226
227 #ifdef ALI_DATE
228   if (!fSubEvent) return 0;
229   return fSubEvent->eventLdcId;
230 #else
231   return 0;
232 #endif
233 }
234
235 UInt_t AliRawReaderDate::GetGDCId() const
236 {
237 // get the GDC Id from the event header
238
239 #ifdef ALI_DATE
240   if (!fEvent) return 0;
241   return fEvent->eventGdcId;
242 #else
243   return 0;
244 #endif
245 }
246
247 UInt_t AliRawReaderDate::GetTimestamp() const
248 {
249 // get the timestamp from the event header
250
251 #ifdef ALI_DATE
252   if (!fEvent) return 0;
253   return fEvent->eventTimestamp;
254 #else
255   return 0;
256 #endif
257 }
258
259 Int_t AliRawReaderDate::GetEquipmentSize() const
260 {
261 // get the size of the equipment (including the header)
262
263 #ifdef ALI_DATE
264   if (!fEquipment) return 0;
265   if (fSubEvent->eventVersion <= 0x00030001) {
266     return fEquipment->equipmentSize + sizeof(equipmentHeaderStruct);
267   } else {
268     return fEquipment->equipmentSize;
269   }
270 #else
271   return 0;
272 #endif
273 }
274
275 Int_t AliRawReaderDate::GetEquipmentType() const
276 {
277 // get the type from the equipment header
278
279 #ifdef ALI_DATE
280   if (!fEquipment) return -1;
281   return fEquipment->equipmentType;
282 #else
283   return 0;
284 #endif
285 }
286
287 Int_t AliRawReaderDate::GetEquipmentId() const
288 {
289 // get the ID from the equipment header
290
291 #ifdef ALI_DATE
292   if (!fEquipment) return -1;
293   return fEquipment->equipmentId;
294 #else
295   return 0;
296 #endif
297 }
298
299 const UInt_t* AliRawReaderDate::GetEquipmentAttributes() const
300 {
301 // get the attributes from the equipment header
302
303 #ifdef ALI_DATE
304   if (!fEquipment) return NULL;
305   return fEquipment->equipmentTypeAttribute;
306 #else
307   return 0;
308 #endif
309 }
310
311 Int_t AliRawReaderDate::GetEquipmentElementSize() const
312 {
313 // get the basic element size from the equipment header
314
315 #ifdef ALI_DATE
316   if (!fEquipment) return 0;
317   return fEquipment->equipmentBasicElementSize;
318 #else
319   return 0;
320 #endif
321 }
322
323 Int_t AliRawReaderDate::GetEquipmentHeaderSize() const
324 {
325   // Get the equipment header size
326   // 28 bytes by default
327 #ifdef ALI_DATE
328   return sizeof(equipmentHeaderStruct);
329 #else
330   return 0;
331 #endif
332 }
333
334 Bool_t AliRawReaderDate::ReadHeader()
335 {
336 // read a data header at the current position
337 // returns kFALSE if the data header could not be read
338
339   fErrorCode = 0;
340
341 #ifdef ALI_DATE
342   fHeader = NULL;
343   if (!fEvent) return kFALSE;
344   // check whether there are sub events
345   if (fEvent->eventSize <= fEvent->eventHeadSize) return kFALSE;
346
347   do {
348     // skip payload (if event was not selected)
349     if (fCount > 0) fPosition += fCount;
350
351     // get the first or the next equipment if at the end of an equipment
352     if (!fEquipment || (fPosition >= fEnd)) {
353       fEquipment = NULL;
354
355       // get the first or the next sub event if at the end of a sub event
356       if (!fSubEvent || 
357           (fPosition >= ((UChar_t*)fSubEvent) + fSubEvent->eventSize)) {
358
359         // check for end of event data
360         if (fPosition >= ((UChar_t*)fEvent)+fEvent->eventSize) return kFALSE;
361         if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute, 
362                                    ATTR_SUPER_EVENT)) {
363           fSubEvent = fEvent;   // no super event
364         } else if (fSubEvent) {
365           fSubEvent = (eventHeaderStruct*) (((UChar_t*)fSubEvent) + 
366                                             fSubEvent->eventSize);
367         } else {
368           fSubEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) + 
369                                             fEvent->eventHeadSize);
370         }
371
372         // check the magic word of the sub event
373         if (fSubEvent->eventMagic != EVENT_MAGIC_NUMBER) {
374           Error("ReadHeader", "wrong magic number in sub event!\n"
375                 " run: %d  event: %d %d  LDC: %d  GDC: %d\n", 
376                 fSubEvent->eventRunNb, 
377                 fSubEvent->eventId[0], fSubEvent->eventId[1],
378                 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
379           fErrorCode = kErrMagic;
380           return kFALSE;
381         }
382
383         // continue if no data in the subevent
384         if (fSubEvent->eventSize == fSubEvent->eventHeadSize) {
385           fPosition = fEnd = ((UChar_t*)fSubEvent) + fSubEvent->eventSize;
386           fCount = 0;
387           continue;
388         }
389
390         fEquipment = (equipmentHeaderStruct*)
391           (((UChar_t*)fSubEvent) + fSubEvent->eventHeadSize);
392
393       } else {
394         fEquipment = (equipmentHeaderStruct*) fEnd;
395       }
396
397       fCount = 0;
398       fPosition = ((UChar_t*)fEquipment) + sizeof(equipmentHeaderStruct);
399       if (fSubEvent->eventVersion <= 0x00030001) {
400         fEnd = fPosition + fEquipment->equipmentSize;
401       } else {
402         fEnd = ((UChar_t*)fEquipment) + fEquipment->equipmentSize;
403       }
404     }
405
406     // continue with the next sub event if no data left in the payload
407     if (fPosition >= fEnd) continue;
408
409     if (fRequireHeader) {
410       // check that there are enough bytes left for the data header
411       if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
412         Error("ReadHeader", "could not read data header data!");
413         Warning("ReadHeader", "skipping %d bytes\n"
414                 " run: %d  event: %d %d  LDC: %d  GDC: %d\n", 
415                 fEnd - fPosition, fSubEvent->eventRunNb, 
416                 fSubEvent->eventId[0], fSubEvent->eventId[1],
417                 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
418         fCount = 0;
419         fPosition = fEnd;
420         fErrorCode = kErrNoDataHeader;
421         continue;
422       }
423
424       // "read" the data header
425       fHeader = (AliRawDataHeader*) fPosition;
426       if ((fPosition + fHeader->fSize) != fEnd) {
427         if (fHeader->fSize != 0xFFFFFFFF)
428           Warning("ReadHeader",
429                   "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
430                   fHeader->fSize, fEnd - fPosition);
431         fHeader->fSize = fEnd - fPosition;
432       }
433       fPosition += sizeof(AliRawDataHeader);
434     }
435
436     if (fHeader && (fHeader->fSize != 0xFFFFFFFF)) {
437       fCount = fHeader->fSize - sizeof(AliRawDataHeader);
438
439       // check consistency of data size in the header and in the sub event
440       if (fPosition + fCount > fEnd) {
441         Error("ReadHeader", "size in data header exceeds event size!");
442         Warning("ReadHeader", "skipping %d bytes\n"
443                 " run: %d  event: %d %d  LDC: %d  GDC: %d\n", 
444                 fEnd - fPosition, fSubEvent->eventRunNb, 
445                 fSubEvent->eventId[0], fSubEvent->eventId[1],
446                 fSubEvent->eventLdcId, fSubEvent->eventGdcId);
447         fCount = 0;
448         fPosition = fEnd;
449         fErrorCode = kErrSize;
450         continue;
451       }
452
453     } else {
454       fCount = fEnd - fPosition;
455     }
456
457   } while (!fEquipment || !IsSelected());
458
459   return kTRUE;
460 #else
461   return kFALSE;
462 #endif
463 }
464
465 Bool_t AliRawReaderDate::ReadNextData(UChar_t*& data)
466 {
467 // reads the next payload at the current position
468 // returns kFALSE if the data could not be read
469
470   fErrorCode = 0;
471   while (fCount == 0) {
472     if (!ReadHeader()) return kFALSE;
473   }
474   data = fPosition;
475   fPosition += fCount;  
476   fCount = 0;
477   return kTRUE;
478 }
479
480 Bool_t AliRawReaderDate::ReadNext(UChar_t* data, Int_t size)
481 {
482 // reads the next block of data at the current position
483 // returns kFALSE if the data could not be read
484
485   fErrorCode = 0;
486   if (fPosition + size > fEnd) {
487     Error("ReadNext", "could not read data!");
488     fErrorCode = kErrOutOfBounds;
489     return kFALSE;
490   }
491   memcpy(data, fPosition, size);
492   fPosition += size;
493   fCount -= size;
494   return kTRUE;
495 }
496
497
498 Bool_t AliRawReaderDate::Reset()
499 {
500 // reset the current position to the beginning of the event
501
502 #ifdef ALI_DATE
503   fSubEvent = NULL;
504   fEquipment = NULL;
505 #endif
506   fCount = 0;
507   fPosition = fEnd = NULL;
508   return kTRUE;
509 }
510
511
512 Bool_t AliRawReaderDate::NextEvent()
513 {
514 // go to the next event in the date file
515
516 #ifdef ALI_DATE
517   if (!fFile) {
518     if (fEventNumber < 0 && fEvent) {
519       fEventNumber++;
520       return kTRUE;
521     }
522     else
523       return kFALSE;
524   }
525
526   Reset();
527   eventHeaderStruct header;
528   UInt_t headerSize = sizeof(eventHeaderStruct);
529   if (fEvent) delete[] fEvent;
530   fEvent = &header;
531
532   while (fread(&header, 1, headerSize, fFile) == headerSize) {
533     if (!IsEventSelected()) {
534       fseek(fFile, header.eventSize-headerSize, SEEK_CUR);
535       continue;
536     }
537     UChar_t* buffer = new UChar_t[header.eventSize];
538     fseek(fFile, -(long)headerSize, SEEK_CUR);
539     if (fread(buffer, 1, header.eventSize, fFile) != header.eventSize) {
540       Error("NextEvent", "could not read event from file");
541       delete[] buffer;
542       break;
543     }
544     fEvent = (eventHeaderStruct*) buffer;
545     fEventNumber++;
546     return kTRUE;
547   };
548
549   fEvent = NULL;
550 #endif
551
552   return kFALSE;
553 }
554
555 Bool_t AliRawReaderDate::RewindEvents()
556 {
557 // go back to the beginning of the date file
558
559   if (fFile)
560     fseek(fFile, 0, SEEK_SET);
561
562   fEventNumber = -1;
563   return Reset();
564 }
565
566
567 Int_t AliRawReaderDate::CheckData() const
568 {
569 // check the consistency of the data
570
571 #ifdef ALI_DATE
572   if (!fEvent) return 0;
573   // check whether there are sub events
574   if (fEvent->eventSize <= fEvent->eventHeadSize) return 0;
575
576   eventHeaderStruct* subEvent = NULL;
577   UChar_t* position = 0;
578   UChar_t* end = 0;
579   Int_t result = 0;
580
581   while (kTRUE) {
582     // get the first or the next sub event if at the end of a sub event
583     if (!subEvent || (position >= end)) {
584
585       // check for end of event data
586       if (position >= ((UChar_t*)fEvent)+fEvent->eventSize) return result;
587       if (!TEST_SYSTEM_ATTRIBUTE(fEvent->eventTypeAttribute, 
588                                  ATTR_SUPER_EVENT)) {
589         subEvent = fEvent;   // no super event
590       } else if (subEvent) {
591         subEvent = (eventHeaderStruct*) (((UChar_t*)subEvent) + 
592                                          subEvent->eventSize);
593       } else {
594         subEvent = (eventHeaderStruct*) (((UChar_t*)fEvent) + 
595                                          fEvent->eventHeadSize);
596       }
597
598       // check the magic word of the sub event
599       if (subEvent->eventMagic != EVENT_MAGIC_NUMBER) {
600         result |= kErrMagic;
601         return result;
602       }
603
604       position = ((UChar_t*)subEvent) + subEvent->eventHeadSize + 
605         sizeof(equipmentHeaderStruct);
606       end = ((UChar_t*)subEvent) + subEvent->eventSize;
607     }
608
609     // continue with the next sub event if no data left in the payload
610     if (position >= end) continue;
611
612     if (fRequireHeader) {
613     // check that there are enough bytes left for the data header
614       if (position + sizeof(AliRawDataHeader) > end) {
615         result |= kErrNoDataHeader;
616         position = end;
617         continue;
618       }
619
620       // check consistency of data size in the data header and in the sub event
621       AliRawDataHeader* header = (AliRawDataHeader*) position;
622       if ((position + header->fSize) != end) {
623         if (header->fSize != 0xFFFFFFFF)
624           Warning("ReadHeader",
625                   "raw data size found in the header is wrong (%d != %d)! Using the equipment size instead !",
626                   header->fSize, end - position);
627         header->fSize = end - position;
628         result |= kErrSize;
629       }
630     }
631     position = end;
632   };
633
634 #endif
635   return 0;
636 }