1 // @(#)alimdc:$Name$:$Id$
2 // Author: Fons Rademakers 26/11/99
3 // Updated: Dario Favretto 15/04/2003
5 /**************************************************************************
6 * Copyright(c) 1998-2003, ALICE Experiment at CERN, All rights reserved. *
8 * Author: The ALICE Off-line Project. *
9 * Contributors are mentioned in the code where appropriate. *
11 * Permission to use, copy, modify and distribute this software and its *
12 * documentation strictly for non-commercial purposes is hereby granted *
13 * without fee, provided that the above copyright notice appears in all *
14 * copies and that both the copyright notice and this permission notice *
15 * appear in the supporting documentation. The authors make no claims *
16 * about the suitability of this software for any purpose. It is *
17 * provided "as is" without express or implied warranty. *
18 **************************************************************************/
22 //////////////////////////////////////////////////////////////////////////
26 // Set of classes defining the ALICE RAW event format. The AliRawEvent //
27 // class defines a RAW event. It consists of an AliEventHeader object //
28 // an AliEquipmentHeader object, an AliRawData object and an array of //
29 // sub-events, themselves also being AliRawEvents. The number of //
30 // sub-events depends on the number of DATE LDC's. //
31 // The AliRawEvent objects are written to a ROOT file using different //
32 // technologies, i.e. to local disk via AliRawDB or via rfiod using //
33 // AliRawRFIODB or via rootd using AliRawRootdDB or to CASTOR via //
34 // rootd using AliRawCastorDB (and for performance testing there is //
35 // also AliRawNullDB). //
36 // The AliStats class provides statics information that is added as //
37 // a single keyed object to each raw file. //
38 // The AliTagDB provides an interface to a TAG database. //
39 // The AliMDC class is usid by the "alimdc" stand-alone program //
40 // that reads data directly from DATE. //
42 //////////////////////////////////////////////////////////////////////////
44 #include <sys/types.h>
51 #include <TStopwatch.h>
52 #include <TPluginManager.h>
56 #include "libDateEb.h"
62 #include "AliRawEvent.h"
63 #include "AliRawEventHeaderBase.h"
64 #include "AliRawEquipment.h"
65 #include "AliRawEquipmentHeader.h"
66 #include "AliRawData.h"
69 #include "AliRawRFIODB.h"
70 #include "AliRawCastorDB.h"
71 #include "AliRawRootdDB.h"
72 #include "AliRawNullDB.h"
74 #include "AliRawEventTag.h"
75 #include "AliFilter.h"
83 const char* const AliMDC::fgkFilterName[kNFilters] = {"AliHoughFilter"};
85 //______________________________________________________________________________
86 AliMDC::AliMDC(Int_t compress, Bool_t deleteFiles, EFilterMode filterMode,
87 Double_t maxSizeTagDB, const char* fileNameTagDB,
88 const char *guidFileFolder) :
89 fEvent(new AliRawEvent),
94 fEventTag(new AliRawEventTag),
96 fDeleteFiles(deleteFiles),
97 fFilterMode(filterMode),
100 fIsTagDBCreated(kFALSE),
101 fMaxSizeTagDB(maxSizeTagDB),
102 fFileNameTagDB(fileNameTagDB),
103 fGuidFileFolder(guidFileFolder)
105 // Create MDC processor object.
106 // compress is the file compression mode.
107 // If deleteFiles is kTRUE the raw data files will be deleted after they
109 // If the filterMode if kFilterOff no filter algorithm will be, if it is
110 // kFilterTransparent the algorthims will be run but no events will be
111 // rejected, if it is kFilterOn the filters will be run and the event will
112 // be rejected if all filters return kFALSE.
113 // If maxSizeTagDB is greater than 0 it determines the maximal size of the
114 // tag DB and then fileNameTagDB is the directory name for the tag DB.
115 // Otherwise fileNameTagDB is the file name of the tag DB. If it is NULL
116 // no tag DB will be created.
117 // Optional 'guidFileFolder' specifies the folder in which *.guid files
118 // will be stored. In case this option is not given, the *.guid files
119 // will be written to the same folder as the raw-data files.
121 // This line is needed in case of a stand-alone application w/o
122 // $ROOTSYS/etc/system.rootrc file
123 gROOT->GetPluginManager()->AddHandler("TVirtualStreamerInfo",
129 if (fFilterMode != kFilterOff) {
133 // Tag DB is now created at the point where the header version is
135 // if (fileNameTagDB) {
136 // if (maxSizeTagDB > 0) {
137 // fTagDB = new AliTagDB(fEvent->GetHeader(), NULL);
138 // fTagDB->SetMaxSize(maxSizeTagDB);
139 // fTagDB->SetFS(fileNameTagDB);
142 // fTagDB = new AliTagDB(fEvent->GetHeader(), fileNameTagDB);
146 // Create the guid files folder if it does not exist
147 if (fGuidFileFolder) {
148 gSystem->ResetErrno();
149 gSystem->MakeDirectory(fGuidFileFolder);
150 if (gSystem->GetErrno() && gSystem->GetErrno() != EEXIST) {
151 SysError("AliMDC", "mkdir %s", fGuidFileFolder);
155 // install SIGUSR1 handler to allow clean interrupts
156 gSystem->AddSignalHandler(new AliMDCInterruptHandler(this));
158 // create the high level filters
159 if (fFilterMode != kFilterOff) {
160 for (Int_t iFilter = 0; iFilter < kNFilters; iFilter++) {
161 TClass* filterClass = gROOT->GetClass(fgkFilterName[iFilter]);
163 Warning("AliMDC", "no filter class %s found", fgkFilterName[iFilter]);
166 AliFilter* filter = (AliFilter*) filterClass->New();
168 Warning("AliMDC", "creation of filter %s failed", fgkFilterName[iFilter]);
171 fFilters.Add(filter);
176 //______________________________________________________________________________
182 if(fTagDB) delete fTagDB;
190 //______________________________________________________________________________
191 Int_t AliMDC::Open(EWriteMode mode, const char* fileName,
192 Double_t maxFileSize,
193 const char* fs1, const char* fs2)
195 // open a new raw DB file
198 fRawDB = new AliRawRFIODB(fEvent, fESD, fCompress, fileName);
199 else if (mode == kROOTD)
200 fRawDB = new AliRawRootdDB(fEvent, fESD, fCompress, fileName);
201 else if (mode == kCASTOR)
202 fRawDB = new AliRawCastorDB(fEvent, fESD, fCompress, fileName);
203 else if (mode == kDEVNULL)
204 fRawDB = new AliRawNullDB(fEvent, fESD, fCompress, fileName);
206 fRawDB = new AliRawDB(fEvent, fESD, fCompress, fileName);
207 fRawDB->SetDeleteFiles(fDeleteFiles);
209 if (fileName == NULL) {
210 fRawDB->SetMaxSize(maxFileSize);
211 fRawDB->SetFS(fs1, fs2);
215 if (fGuidFileFolder) fRawDB->SetGuidFileFolder(fGuidFileFolder);
217 if (fRawDB->IsZombie()) {
222 Info("Open", "Filling raw DB %s\n", fRawDB->GetDBName());
224 // Create AliStats object
225 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
226 fFilterMode != kFilterOff);
230 //______________________________________________________________________________
231 Int_t AliMDC::ProcessEvent(void* event, Bool_t isIovecArray)
233 // Convert the DATE event to an AliRawEvent object and store it in the raw DB,
234 // optionally also run the filter.
235 // event is either a pointer to the streamlined event
236 // or, if isIovecArray is kTRUE, a pointer to an array of iovecs with one
237 // iovec per subevent (used by the event builder).
238 // The return value is the number of written bytes or an error code
239 const UInt_t kFileSizeErrorLevel = 1900000000;
241 UInt_t currentFileSize = GetTotalSize();
242 if(currentFileSize > kFileSizeErrorLevel) {
243 Error("ProcessEvent", "file size (%u) exceeds the limit "
249 char* data = (char*) event;
250 if (isIovecArray) data = (char*) ((iovec*) event)[0].iov_base;
252 // Shortcut for easy header access
253 AliRawEventHeaderBase *header = fEvent->GetHeader(data);
256 if ((status = header->ReadHeader(data)) != (Int_t)header->GetHeadSize()) {
260 if (AliDebugLevel() > 2) ToAliDebug(3, header->Dump(););
262 // Check event type and skip "Start of Run", "End of Run",
263 // "Start of Run Files" and "End of Run Files"
264 Int_t size = header->GetEventSize() - header->GetHeadSize();
266 AliDebug(1, Form("Processing %s (%d bytes)", header->GetTypeName(), size));
268 // Amount of data left to read for this event
271 // StartOfRun, EndOfRun etc. events have no payload
272 // Nevertheless, store the event headers in the tree
275 // If there is less data for this event than the next sub-event
276 // header, something is wrong. Skip to next event...
277 if (toRead < (Int_t)header->GetHeadSize()) {
278 Error("ProcessEvent", "header size (%d) exceeds number of bytes "
279 "to read (%d)", header->GetHeadSize(), toRead);
280 if (AliDebugLevel() > 0) ToAliDebug(1, header->Dump(););
281 return kErrHeaderSize;
284 // Loop over all sub-events... (LDCs)
287 if (isIovecArray) data = (char*) ((iovec*) event)[nsub].iov_base;
289 AliDebug(1, Form("reading LDC %d", nsub));
291 AliRawEvent *subEvent = fEvent->NextSubEvent();
293 // Read sub-event header
294 AliRawEventHeaderBase *subHeader = subEvent->GetHeader(data);
295 if ((status = subHeader->ReadHeader(data)) != (Int_t)subHeader->GetHeadSize()) {
296 return kErrSubHeader;
299 if (AliDebugLevel() > 2) ToAliDebug(3, subHeader->Dump(););
301 toRead -= subHeader->GetHeadSize();
303 Int_t rawSize = subHeader->GetEventSize() - subHeader->GetHeadSize();
305 // Make sure raw data less than left over bytes for current event
306 if (rawSize > toRead) {
307 Warning("ProcessEvent", "raw data size (%d) exceeds number of "
308 "bytes to read (%d)\n", rawSize, toRead);
309 if (AliDebugLevel() > 0) ToAliDebug(1, subHeader->Dump(););
313 // Read Equipment Headers (in case of physics or calibration event)
314 if (header->Get("Type") == AliRawEventHeaderBase::kPhysicsEvent ||
315 header->Get("Type") == AliRawEventHeaderBase::kCalibrationEvent ||
316 header->Get("Type") == AliRawEventHeaderBase::kSystemSoftwareTriggerEvent ||
317 header->Get("Type") == AliRawEventHeaderBase::kDetectorSoftwareTriggerEvent) {
318 while (rawSize > 0) {
319 AliRawEquipment &equipment = *subEvent->NextEquipment();
320 AliRawEquipmentHeader &equipmentHeader =
321 *equipment.GetEquipmentHeader();
322 Int_t equipHeaderSize = equipmentHeader.HeaderSize();
323 if ((status = ReadEquipmentHeader(equipmentHeader, header->DataIsSwapped(),
324 data)) != equipHeaderSize) {
325 return kErrEquipmentHeader;
328 if (AliDebugLevel() > 2) ToAliDebug(3, equipmentHeader.Dump(););
330 toRead -= equipHeaderSize;
331 rawSize -= equipHeaderSize;
333 // Read equipment raw data
334 AliRawData &subRaw = *equipment.GetRawData();
336 Int_t eqSize = equipmentHeader.GetEquipmentSize() - equipHeaderSize;
337 if ((status = ReadRawData(subRaw, eqSize, data)) != eqSize) {
338 return kErrEquipment;
345 } else { // Read only raw data but no equipment header
347 AliRawEquipment &equipment = *subEvent->NextEquipment();
348 AliRawData &subRaw = *equipment.GetRawData();
349 if ((status = ReadRawData(subRaw, rawSize, data)) != rawSize) {
350 return kErrEquipment;
360 // High Level Event Filter
361 if (fFilterMode != kFilterOff) {
362 if (header->Get("Type") == AliRawEventHeaderBase::kPhysicsEvent ||
363 header->Get("Type") == AliRawEventHeaderBase::kCalibrationEvent ||
364 header->Get("Type") == AliRawEventHeaderBase::kSystemSoftwareTriggerEvent ||
365 header->Get("Type") == AliRawEventHeaderBase::kDetectorSoftwareTriggerEvent) {
366 Bool_t result = kFALSE;
367 for (Int_t iFilter = 0; iFilter < fFilters.GetEntriesFast(); iFilter++) {
368 AliFilter* filter = (AliFilter*) fFilters[iFilter];
369 if (!filter) continue;
370 if (filter->Filter(fEvent, fESD)) result = kTRUE;
372 if ((fFilterMode == kFilterOn) && !result) return kFilterReject;
376 // Set stat info for first event of this file
377 if (fRawDB->GetEvents() == 0)
378 fStats->SetFirstId(header->Get("RunNb"), header->GetP("Id")[0]);
380 // Store raw event in tree
381 Int_t nBytes = fRawDB->Fill();
383 // Fill the event tag object
384 fEventTag->SetHeader(fEvent->GetHeader());
385 fEventTag->SetGUID(fRawDB->GetDB()->GetUUID().AsString());
386 fEventTag->SetEventNumber(fRawDB->GetEvents()-1);
388 // Create Tag DB here only after the raw data header
389 // version was already identified
390 if (!fIsTagDBCreated) {
391 if (fFileNameTagDB) {
392 if (fMaxSizeTagDB > 0) {
393 fTagDB = new AliTagDB(fEventTag, NULL);
394 fTagDB->SetMaxSize(fMaxSizeTagDB);
395 fTagDB->SetFS(fFileNameTagDB);
398 fTagDB = new AliTagDB(fEventTag, fFileNameTagDB);
401 fIsTagDBCreated = kTRUE;
404 // Store event tag in tree
405 if (fTagDB) fTagDB->Fill();
407 // Make top event object ready for next event data
409 // Clean up HLT ESD for the next event
410 if (fESD) fESD->Reset();
418 //______________________________________________________________________________
419 Int_t AliMDC::GetTotalSize()
421 // return the total current raw DB file size
423 if (!fRawDB) return -1;
425 return fRawDB->GetTotalSize();
428 //______________________________________________________________________________
429 Int_t AliMDC::Close()
431 // close the current raw DB file
433 if (!fRawDB) return -1;
435 fRawDB->WriteStats(fStats);
436 Int_t filesize = fRawDB->Close();
444 //______________________________________________________________________________
445 Int_t AliMDC::Run(const char* inputFile, Bool_t loop,
446 EWriteMode mode, Double_t maxFileSize,
447 const char* fs1, const char* fs2)
449 // Run the MDC processor. Read from the input stream and only return
450 // when the input gave and EOF or a fatal error occured. On success 0
451 // is returned, 1 in case of a fatality.
452 // inputFile is the name of the DATE input file; if NULL the input will
453 // be taken from the event builder.
454 // If loop is set the same input file will be reused in an infinite loop.
455 // mode specifies the type of the raw DB.
456 // maxFileSize is the maximal size of the raw DB.
457 // fs1 and fs2 are the file system locations of the raw DB.
459 Info("Run", "input = %s, rawdb size = %f, filter = %s, "
460 "looping = %s, compression = %d, delete files = %s",
461 inputFile ? inputFile : "event builder", maxFileSize,
462 fFilterMode == kFilterOff ? "off" :
463 (fFilterMode == kFilterOn ? "on" : "transparent"),
464 loop ? "yes" : "no", fCompress, fDeleteFiles ? "yes" : "no");
466 // Open the input file
469 if ((fd = open(inputFile, O_RDONLY)) == -1) {
470 Error("Run", "cannot open input file %s", inputFile);
475 // Used for statistics
478 Double_t told = 0, tnew = 0;
479 Float_t chunkSize = maxFileSize/100, nextChunk = chunkSize;
481 // Create new raw DB.
484 if (Open(mode,NULL,maxFileSize,fs1,fs2) < 0) return 1;
486 // Process input stream
491 UInt_t eventSize = 0;
494 AliRawEventHeaderBase header;
498 // If we were in looping mode stop directly after a SIGUSR1 signal
500 Info("Run", "Stopping loop, processed %d events", numEvents);
504 if (!inputFile) { // get data from event builder
506 if ((eorFlag = ebEor())) break;
507 if ((event = (char*)ebGetNextEvent()) == (char*)-1) {
508 Error("Run", "error getting next event (%s)", ebGetLastError());
512 // no event, sleep for 1 second and try again
513 gSystem->Sleep(1000);
517 Error("Run", "AliMDC was compiled without event builder support");
525 } else { // get data from a file
528 if ((nrecv = Read(fd, header.HeaderBaseBegin(), header.HeaderBaseSize())) !=
529 header.HeaderBaseSize()) {
530 if (nrecv == 0) { // eof
532 ::lseek(fd, 0, SEEK_SET);
538 Error("Run", "error reading base header");
545 char *data = (char *)header.HeaderBaseBegin();
546 AliRawEventHeaderBase *hdr = AliRawEventHeaderBase::Create(data);
548 if ((nrecv = Read(fd, hdr->HeaderBegin(), hdr->HeaderSize())) !=
550 if (nrecv == 0) { // eof
552 ::lseek(fd, 0, SEEK_SET);
560 Error("Run", "error reading header");
567 if (eventSize < hdr->GetEventSize()) {
569 eventSize = 2 * hdr->GetEventSize();
570 event = new char[eventSize];
572 memcpy(event, hdr->HeaderBaseBegin(), hdr->HeaderBaseSize());
573 memcpy(event+hdr->HeaderBaseSize(), hdr->HeaderBegin(), hdr->HeaderSize());
574 if (hdr->GetExtendedDataSize() != 0)
575 memcpy(event+hdr->HeaderBaseSize()+hdr->HeaderSize(),
576 hdr->GetExtendedData(), hdr->GetExtendedDataSize());
577 Int_t size = hdr->GetEventSize() - hdr->GetHeadSize();
578 if (Read(fd, event + hdr->GetHeadSize(), size) != size) {
579 Error("Run", "error reading data");
588 Int_t result = ProcessEvent(event, !inputFile);
590 Error("Run", "error writing data. Error code: %d",result);
595 printf("Processed event %d (%d)\n", numEvents, fRawDB->GetEvents());
599 // Filling time statistics
600 if (fRawDB->GetBytesWritten() > nextChunk) {
601 tnew = timer.RealTime();
602 fStats->Fill(tnew-told);
605 nextChunk += chunkSize;
608 // Check size of raw db. If bigger than maxFileSize, close file
609 // and continue with new file.
610 if (fRawDB->GetBytesWritten() > maxFileSize) {
612 printf("Written raw DB at a rate of %.1f MB/s\n",
613 fRawDB->GetBytesWritten() / timer.RealTime() / 1000000.);
615 // Write stats object to raw db, run db, MySQL and AliEn
616 fRawDB->WriteStats(fStats);
620 if (!fRawDB->NextFile()) {
621 Error("Run", "error opening next raw data file");
623 if (inputFile) delete[] event;
627 printf("Filling raw DB %s\n", fRawDB->GetDBName());
628 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
629 fFilterMode != kFilterOff);
633 nextChunk = chunkSize;
636 // Check size of tag db
637 if (fTagDB && fTagDB->FileFull()) {
638 if (!fTagDB->NextFile()) {
642 printf("Filling tag DB %s\n", fTagDB->GetDBName());
647 // Make top event object ready for next event data
648 //printf("Event %d has %d sub-events\n", numEvents, fEvent->GetNSubEvents());
650 // Clean up HLT ESD for the next event
651 // if (fESD) fESD->Reset();
655 if (!ebReleaseEvent((iovec*)event)) {
656 Error("Run", "problem releasing event (%s)", ebGetLastError());
663 printf("Written raw DB at a rate of %.1f MB/s\n",
664 fRawDB->GetBytesWritten() / timer.RealTime() / 1000000.);
666 // Write stats to raw db and run db and delete stats object
673 Info("Run", "event builder reported end of run (%d)", eorFlag);
677 // Close input source
685 //______________________________________________________________________________
686 Int_t AliMDC::Read(Int_t fd, void *buffer, Int_t length)
688 // Read exactly length bytes into buffer. Returns number of bytes
689 // received, returns -1 in case of error and 0 for EOF.
693 if (fd < 0) return -1;
696 char *buf = (char *)buffer;
698 for (n = 0; n < length; n += nrecv) {
699 if ((nrecv = read(fd, buf+n, length-n)) <= 0) {
703 SysError("Read", "read");
710 //______________________________________________________________________________
711 Int_t AliMDC::ReadEquipmentHeader(AliRawEquipmentHeader &header,
712 Bool_t isSwapped, char*& data)
714 // Read equipment header info from DATE data stream. Returns bytes read
715 // (i.e. AliRawEquipmentHeader::HeaderSize()), -1 in case of error and
716 // 0 for EOF. If isSwapped is kTRUE the event data is byte swapped
717 // and we will swap the header to host format.
719 memcpy(header.HeaderBegin(), data, header.HeaderSize());
720 data += header.HeaderSize();
722 // Swap equipment header data if needed
726 if (header.GetEquipmentSize() < (UInt_t)header.HeaderSize()) {
727 Error("ReadEquipmentHeader", "invalid equipment header size");
728 // try recovery... how?
732 return header.HeaderSize();
735 //______________________________________________________________________________
736 Int_t AliMDC::ReadRawData(AliRawData &raw, Int_t size, char*& data)
738 // Read raw data from DATE data stream. Returns bytes read (i.e.
739 // size), -1 in case of error and 0 for EOF.
741 raw.SetBuffer(data, size);
747 //______________________________________________________________________________
750 // Stop the event loop
753 if (fRawDB) fRawDB->Stop();