42f72f06a586af0dbd0319f6a1dc77ba41a3903e
[u/mrichter/AliRoot.git] / RAW / AliRawReaderFile.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 files.
21 ///
22 /// The files of one event are expected to be in one directory. The name 
23 /// of the directory is "raw" + the event number. Each file contains
24 /// the raw data (with data header) of one DDL. The convention for the
25 /// file names is "DET_#DDL.ddl". "DET" is the name of the detector and
26 /// "#DDL" is the unique equipment ID.
27 ///
28 /// The constructor of AliRawReaderFile takes the event number or the
29 /// directory name as argument.
30 /// 
31 ///////////////////////////////////////////////////////////////////////////////
32
33 #include <cstdlib>
34 #include "AliRawReaderFile.h"
35 #include "AliDAQ.h"
36 #include <TSystem.h>
37 #include <TArrayC.h>
38
39
40 ClassImp(AliRawReaderFile)
41
42
43 AliRawReaderFile::AliRawReaderFile(Int_t eventNumber) :
44   fEventIndex(eventNumber),
45   fDirName("."),
46   fDirectory(NULL),
47   fStream(NULL),
48   fEquipmentId(-1),
49   fBuffer(NULL),
50   fBufferSize(0),
51   fEquipmentSize(0),
52   fDDLIndex(NULL),
53   fDDLCurrent(-1),
54   fType(7),
55   fRunNb(0),
56   fDetectorPattern(0),
57   fTimestamp(0)
58 {
59 // create an object to read digits from the given event
60 // in the current directory
61
62   fDirectory = OpenDirectory();
63   OpenNextFile();
64   fHeader = new AliRawDataHeader;
65
66   fId[0] = fId[1] = 0;
67   fTriggerPattern[0] = fTriggerPattern[1] = 0;
68 }
69
70 AliRawReaderFile::AliRawReaderFile(const char* dirName, Int_t eventNumber) :
71   fEventIndex(eventNumber),
72   fDirName(dirName),
73   fDirectory(NULL),
74   fStream(NULL),
75   fEquipmentId(-1),
76   fBuffer(NULL),
77   fBufferSize(0),
78   fEquipmentSize(0),
79   fDDLIndex(NULL),
80   fDDLCurrent(-1),
81   fType(7),
82   fRunNb(0),
83   fDetectorPattern(0),
84   fTimestamp(0)
85 {
86 // create an object to read digits from the given directory
87
88   fDirectory = OpenDirectory();
89   OpenNextFile();
90   fHeader = new AliRawDataHeader;
91
92   fId[0] = fId[1] = 0;
93   fTriggerPattern[0] = fTriggerPattern[1] = 0;
94 }
95
96 AliRawReaderFile::~AliRawReaderFile()
97 {
98 // close the input file
99
100   if (fDirectory) gSystem->FreeDirectory(fDirectory);
101   if (fStream) {
102 #if defined(__HP_aCC) || defined(__DECCXX)
103     if (fStream->rdbuf()->is_open()) fStream->close();
104 #else
105     if (fStream->is_open()) fStream->close();
106 #endif
107     delete fStream;
108   }
109   if (fHeader) delete fHeader;
110   if (fBuffer) delete[] fBuffer;
111   if (fDDLIndex) delete fDDLIndex; fDDLIndex=NULL;
112 }
113
114 void AliRawReaderFile::RequireHeader(Bool_t required)
115 {
116   // Reading of raw data in case of missing
117   // raw data header is not implemented for
118   // this class
119   if (!required) {
120     Warning("AliRawReaderFile","Reading of raw data without raw data header!");
121     if (fHeader) delete fHeader;
122     fHeader = NULL;
123   }
124   else {
125     if (!fHeader) fHeader = new AliRawDataHeader;
126   }
127
128   AliRawReader::RequireHeader(required);
129 }
130
131 TString AliRawReaderFile::GetDirName() const
132 {
133 // return the current directory name
134
135   TString dirName(fDirName);
136   if (fEventIndex >= 0) {
137     dirName += "/raw";
138     dirName += fEventIndex;
139   }
140   return dirName;
141 }
142
143 void* AliRawReaderFile::OpenDirectory()
144 {
145 // open and return the directory
146
147   TString dirName = GetDirName();
148   void* directory = gSystem->OpenDirectory(dirName);
149   if (!directory) {
150     Error("OpenDirectory", "could not open directory %s", dirName.Data());
151   }
152   return directory;
153 }
154
155 Bool_t AliRawReaderFile::CreateFileIndex()
156 {
157 // scan the files of the directory and create index of all DDL files
158 // returns kFALSE if no DDL files available
159   Bool_t result=kFALSE;
160   fDDLCurrent=-1;
161   if (fDDLIndex) return fDDLIndex->GetSize()>0;
162   if (!fDirectory) return kFALSE;
163   fDDLIndex=new TArrayC(0);
164   if (!fDDLIndex) return kFALSE;
165   TString entry;
166   while (entry = gSystem->GetDirEntry(fDirectory)) {
167     const char* filename=entry.Data();
168     if (!filename || entry.IsNull()) break;
169     if (!entry.EndsWith(".ddl")) continue;
170     result=kTRUE;
171     entry.Remove(0, entry.Last('_')+1);
172     entry.Remove(entry.Length()-4);
173     Int_t equipmentId = atoi(entry.Data());
174     Int_t ddlIndex = -1;
175     fDetectorPattern |= (1 << AliDAQ::DetectorIDFromDdlID(equipmentId,ddlIndex));
176     if (fDDLIndex->GetSize()<=equipmentId) {
177       fDDLIndex->Set(equipmentId+1);
178     }
179     char* array=(char*)fDDLIndex->GetArray();
180     array[equipmentId]=1;
181   }
182
183   return result;
184 }
185
186 Bool_t AliRawReaderFile::OpenNextFile()
187 {
188 // open the next file
189 // returns kFALSE if the current file is the last one
190
191   if (!fDDLIndex && !CreateFileIndex()) return kFALSE;
192   if (fSelectMinEquipmentId>=0 && fSelectMinEquipmentId>fEquipmentId)
193     fDDLCurrent=fSelectMinEquipmentId-1;
194
195   if (fStream) {
196 #if defined(__HP_aCC) || defined(__DECCXX)
197     if (fStream->rdbuf()->is_open()) fStream->close();
198 #else
199     if (fStream->is_open()) fStream->close();
200 #endif
201     delete fStream;
202     fStream = NULL;
203     fEquipmentId = -1;
204     fEquipmentSize = 0;
205   }
206
207   if (!fDirectory) return kFALSE;
208   while (++fDDLCurrent<(fDDLIndex->GetSize()) && 
209          (fDDLCurrent<=fSelectMaxEquipmentId || fSelectMaxEquipmentId<0)) {
210     if (fDDLIndex->At(fDDLCurrent)==0) continue;
211     Int_t dummy=0;
212     TString entry;
213     entry.Form("%s_%d.ddl", AliDAQ::DetectorNameFromDdlID(fDDLCurrent, dummy), fDDLCurrent);
214     char* fileName = gSystem->ConcatFileName(GetDirName(), entry);
215     if (!fileName) continue;
216     // read the timestamp
217     FileStat_t buf;
218     if (gSystem->GetPathInfo(fileName,buf) == 0) {
219       fTimestamp = buf.fMtime;
220     }
221 #ifndef __DECCXX 
222     fStream = new fstream(fileName, ios::binary|ios::in);
223 #else
224     fStream = new fstream(fileName, ios::in);
225 #endif
226     delete [] fileName;
227     break;
228   }
229
230   if (!fStream) return kFALSE;
231   fEquipmentId = fDDLCurrent;
232 #if defined(__HP_aCC) || defined(__DECCXX)
233   return (fStream->rdbuf()->is_open());
234 #else
235   return (fStream->is_open());
236 #endif
237 }
238
239
240 Bool_t AliRawReaderFile::ReadHeader()
241 {
242 // read a data header at the current stream position
243 // returns kFALSE if the mini header could not be read
244
245   if (!fStream && !OpenNextFile()) return kFALSE;
246   do {
247     if (fCount > 0) fStream->seekg(Int_t(fStream->tellg()) + fCount);
248     if (fHeader) {
249       while (!fStream->read((char*) fHeader, sizeof(AliRawDataHeader))) {
250         if (!OpenNextFile()) return kFALSE;
251       }
252     }
253     else {
254       if (fStream->eof())
255         if (!OpenNextFile()) return kFALSE;
256     }
257     if (fHeader && fHeader->fSize != 0xFFFFFFFF) {
258       fCount = fHeader->fSize - sizeof(AliRawDataHeader);
259     } else {
260       UInt_t currentPos = fStream->tellg();
261       fStream->seekg(0, ios::end);
262       fCount = UInt_t(fStream->tellg()) - currentPos;
263       fStream->seekg(currentPos);
264     }
265     fEquipmentSize = fCount;
266     if (fHeader) fEquipmentSize += sizeof(AliRawDataHeader);
267   } while (!IsSelected());
268   return kTRUE;
269 }
270
271 Bool_t AliRawReaderFile::ReadNextData(UChar_t*& data)
272 {
273 // reads the next payload at the current stream position
274 // returns kFALSE if the data could not be read
275
276   while (fCount == 0) {
277     if (!ReadHeader()) return kFALSE;
278   }
279   if (fBufferSize < fCount) {
280     if (fBuffer) delete[] fBuffer;
281     fBufferSize = Int_t(fCount*1.2);
282     fBuffer = new UChar_t[fBufferSize];
283   }
284   if (!fStream->read((char*) fBuffer, fCount)) {
285     Error("ReadNext", "could not read data!");
286     return kFALSE;
287   }
288   fCount = 0;
289
290   data = fBuffer;
291   return kTRUE;
292 }
293
294 Bool_t AliRawReaderFile::ReadNext(UChar_t* data, Int_t size)
295 {
296 // reads the next block of data at the current stream position
297 // returns kFALSE if the data could not be read
298
299   if (!fStream->read((char*) data, size)) {
300     Error("ReadNext", "could not read data!");
301     return kFALSE;
302   }
303   fCount -= size;
304   return kTRUE;
305 }
306
307
308 Bool_t AliRawReaderFile::Reset()
309 {
310 // reset the current stream position to the first DDL file of the curevent
311
312   void* directory = OpenDirectory();
313   if (!directory) return kFALSE;
314
315   if (fStream) {
316 #if defined(__HP_aCC) || defined(__DECCXX)
317     if (fStream->rdbuf()->is_open()) fStream->close();
318 #else
319     if (fStream->is_open()) fStream->close();
320 #endif
321     delete fStream;
322     fStream = NULL;
323   }
324
325   if (fDirectory) gSystem->FreeDirectory(fDirectory);
326   fDirectory = directory;
327
328   // Matthias 05.06.2008
329   // do not open the next file. That might collide with a subsequent
330   // SelectEquipment call as the 'file pointer' is already set.
331   // This is important for the indexing of the DDL files.
332   // ---------------------------------------------------------
333   // All ReadNext functions first require the fCount member to be
334   // non zero or call ReadHeader. That allows to postpone the call
335   // to OpenNextFile to the next invocation of ReadHeader.
336   // ReadHeader has been mofified according to that.
337   /*
338   OpenNextFile();
339   */
340   fEquipmentId=-1;
341   fDDLCurrent=-1;
342   fCount = 0;
343   return kTRUE;
344 }
345
346 Bool_t AliRawReaderFile::NextEvent()
347 {
348 // go to the next event directory
349
350   if (fDDLIndex) delete fDDLIndex;
351   fDDLIndex=NULL;
352   fDetectorPattern = 0;
353   if (fEventIndex < -1) return kFALSE;
354
355   do {
356     TString dirName = fDirName + "/raw";
357     dirName += (fEventIndex + 1);
358     void* directory = gSystem->OpenDirectory(dirName);
359     if (!directory) return kFALSE;
360     gSystem->FreeDirectory(directory);
361
362     fEventIndex++;
363     Reset();
364   } while (!IsEventSelected());
365
366   // Read the header of the first payload
367   // in order to fill the 'fake' event header
368   if (ReadHeader() && fHeader) {
369     fId[0] = ((fHeader->GetEventID2() >> 20) & 0xf);
370     fId[1] = (fHeader->GetEventID1() & 0xfff) | ((fHeader->GetEventID2() & 0xfffff) << 12);
371     fTriggerPattern[0] = (fHeader->GetTriggerClasses() & 0xffffffff);
372     fTriggerPattern[1] = ((fHeader->GetTriggerClasses() >> 32) & 0x3ffff);
373   }
374   else {
375     Warning("AliRawReaderFile","Can not read CDH header! The event header fields will be empty!");
376   }
377   Reset();
378
379   fEventNumber++;
380
381   return kTRUE;
382 }
383
384 Bool_t AliRawReaderFile::RewindEvents()
385 {
386 // reset the event counter
387
388   if (fEventIndex >= 0)  fEventIndex = -1;
389   fEventNumber = -1;
390   return Reset();
391 }