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 // Create the guid files folder if it does not exist
134 if (fGuidFileFolder) {
135 gSystem->ResetErrno();
136 gSystem->MakeDirectory(fGuidFileFolder);
137 if (gSystem->GetErrno() && gSystem->GetErrno() != EEXIST) {
138 SysError("AliMDC", "mkdir %s", fGuidFileFolder);
142 // install SIGUSR1 handler to allow clean interrupts
143 gSystem->AddSignalHandler(new AliMDCInterruptHandler(this));
145 // create the high level filters
146 if (fFilterMode != kFilterOff) {
147 for (Int_t iFilter = 0; iFilter < kNFilters; iFilter++) {
148 TClass* filterClass = gROOT->GetClass(fgkFilterName[iFilter]);
150 Warning("AliMDC", "no filter class %s found", fgkFilterName[iFilter]);
153 AliFilter* filter = (AliFilter*) filterClass->New();
155 Warning("AliMDC", "creation of filter %s failed", fgkFilterName[iFilter]);
158 fFilters.Add(filter);
163 //______________________________________________________________________________
169 if(fTagDB) delete fTagDB;
177 //______________________________________________________________________________
178 Int_t AliMDC::Open(EWriteMode mode, const char* fileName,
179 Double_t maxFileSize,
180 const char* fs1, const char* fs2)
182 // open a new raw DB file
185 fRawDB = new AliRawRFIODB(fEvent, fESD, fCompress, fileName);
186 else if (mode == kROOTD)
187 fRawDB = new AliRawRootdDB(fEvent, fESD, fCompress, fileName);
188 else if (mode == kCASTOR)
189 fRawDB = new AliRawCastorDB(fEvent, fESD, fCompress, fileName);
190 else if (mode == kDEVNULL)
191 fRawDB = new AliRawNullDB(fEvent, fESD, fCompress, fileName);
193 fRawDB = new AliRawDB(fEvent, fESD, fCompress, fileName);
194 fRawDB->SetDeleteFiles(fDeleteFiles);
196 if (fRawDB->IsZombie()) {
202 if (fileName == NULL) {
203 fRawDB->SetMaxSize(maxFileSize);
204 fRawDB->SetFS(fs1, fs2);
205 if (!fRawDB->Create()) {
212 if (!fRawDB->WriteGuidFile(fGuidFileFolder)) {
218 Info("Open", "Filling raw DB %s\n", fRawDB->GetDBName());
220 // Create AliStats object
221 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
222 fFilterMode != kFilterOff);
226 //______________________________________________________________________________
227 Int_t AliMDC::ProcessEvent(void* event, Bool_t isIovecArray)
229 // Convert the DATE event to an AliRawEvent object and store it in the raw DB,
230 // optionally also run the filter.
231 // event is either a pointer to the streamlined event
232 // or, if isIovecArray is kTRUE, a pointer to an array of iovecs with one
233 // iovec per subevent (used by the event builder).
234 // The return value is the number of written bytes or an error code
235 const UInt_t kFileSizeErrorLevel = 1900000000;
237 UInt_t currentFileSize = GetTotalSize();
238 if(currentFileSize > kFileSizeErrorLevel) {
239 Error("ProcessEvent", "file size (%u) exceeds the limit "
245 char* data = (char*) event;
246 if (isIovecArray) data = (char*) ((iovec*) event)[0].iov_base;
248 // Shortcut for easy header access
249 AliRawEventHeaderBase *header = fEvent->GetHeader(data);
252 if ((status = header->ReadHeader(data)) != (Int_t)header->GetHeadSize()) {
256 if (AliDebugLevel() > 2) ToAliDebug(3, header->Dump(););
258 // Check event type and skip "Start of Run", "End of Run",
259 // "Start of Run Files" and "End of Run Files"
260 Int_t size = header->GetEventSize() - header->GetHeadSize();
262 AliDebug(1, Form("Processing %s (%d bytes)", header->GetTypeName(), size));
264 // Amount of data left to read for this event
267 // StartOfRun, EndOfRun etc. events have no payload
268 // Nevertheless, store the event headers in the tree
271 // If there is less data for this event than the next sub-event
272 // header, something is wrong. Skip to next event...
273 if (toRead < (Int_t)header->GetHeadSize()) {
274 Error("ProcessEvent", "header size (%d) exceeds number of bytes "
275 "to read (%d)", header->GetHeadSize(), toRead);
276 if (AliDebugLevel() > 0) ToAliDebug(1, header->Dump(););
277 return kErrHeaderSize;
280 // Loop over all sub-events... (LDCs)
283 if (isIovecArray) data = (char*) ((iovec*) event)[nsub].iov_base;
285 AliDebug(1, Form("reading LDC %d", nsub));
287 AliRawEvent *subEvent = fEvent->NextSubEvent();
289 // Read sub-event header
290 AliRawEventHeaderBase *subHeader = subEvent->GetHeader(data);
291 if ((status = subHeader->ReadHeader(data)) != (Int_t)subHeader->GetHeadSize()) {
292 return kErrSubHeader;
295 if (AliDebugLevel() > 2) ToAliDebug(3, subHeader->Dump(););
297 toRead -= subHeader->GetHeadSize();
299 Int_t rawSize = subHeader->GetEventSize() - subHeader->GetHeadSize();
301 // Make sure raw data less than left over bytes for current event
302 if (rawSize > toRead) {
303 Warning("ProcessEvent", "raw data size (%d) exceeds number of "
304 "bytes to read (%d)\n", rawSize, toRead);
305 if (AliDebugLevel() > 0) ToAliDebug(1, subHeader->Dump(););
309 // Read Equipment Headers (in case of physics or calibration event)
310 if (header->Get("Type") == AliRawEventHeaderBase::kPhysicsEvent ||
311 header->Get("Type") == AliRawEventHeaderBase::kCalibrationEvent ||
312 header->Get("Type") == AliRawEventHeaderBase::kSystemSoftwareTriggerEvent ||
313 header->Get("Type") == AliRawEventHeaderBase::kDetectorSoftwareTriggerEvent) {
314 while (rawSize > 0) {
315 AliRawEquipment &equipment = *subEvent->NextEquipment();
316 AliRawEquipmentHeader &equipmentHeader =
317 *equipment.GetEquipmentHeader();
318 Int_t equipHeaderSize = equipmentHeader.HeaderSize();
319 if ((status = ReadEquipmentHeader(equipmentHeader, header->DataIsSwapped(),
320 data)) != equipHeaderSize) {
321 return kErrEquipmentHeader;
324 if (AliDebugLevel() > 2) ToAliDebug(3, equipmentHeader.Dump(););
326 toRead -= equipHeaderSize;
327 rawSize -= equipHeaderSize;
329 // Read equipment raw data
330 AliRawData &subRaw = *equipment.GetRawData();
332 Int_t eqSize = equipmentHeader.GetEquipmentSize() - equipHeaderSize;
333 if ((status = ReadRawData(subRaw, eqSize, data)) != eqSize) {
334 return kErrEquipment;
341 } else { // Read only raw data but no equipment header
343 AliRawEquipment &equipment = *subEvent->NextEquipment();
344 AliRawData &subRaw = *equipment.GetRawData();
345 if ((status = ReadRawData(subRaw, rawSize, data)) != rawSize) {
346 return kErrEquipment;
356 // High Level Event Filter
357 if (fFilterMode != kFilterOff) {
358 if (header->Get("Type") == AliRawEventHeaderBase::kPhysicsEvent ||
359 header->Get("Type") == AliRawEventHeaderBase::kCalibrationEvent ||
360 header->Get("Type") == AliRawEventHeaderBase::kSystemSoftwareTriggerEvent ||
361 header->Get("Type") == AliRawEventHeaderBase::kDetectorSoftwareTriggerEvent) {
362 Bool_t result = kFALSE;
363 for (Int_t iFilter = 0; iFilter < fFilters.GetEntriesFast(); iFilter++) {
364 AliFilter* filter = (AliFilter*) fFilters[iFilter];
365 if (!filter) continue;
366 if (filter->Filter(fEvent, fESD)) result = kTRUE;
368 if ((fFilterMode == kFilterOn) && !result) return kFilterReject;
372 // Set stat info for first event of this file
373 if (fRawDB->GetEvents() == 0)
374 fStats->SetFirstId(header->Get("RunNb"), header->GetP("Id")[0]);
376 // Store raw event in tree
377 Int_t nBytes = fRawDB->Fill();
379 // Fill the event tag object
380 fEventTag->SetHeader(fEvent->GetHeader());
381 fEventTag->SetGUID(fRawDB->GetDB()->GetUUID().AsString());
382 fEventTag->SetEventNumber(fRawDB->GetEvents()-1);
384 // Create Tag DB here only after the raw data header
385 // version was already identified
386 if (!fIsTagDBCreated) {
387 if (fFileNameTagDB) {
388 if (fMaxSizeTagDB > 0) {
389 fTagDB = new AliTagDB(fEventTag, NULL);
390 fTagDB->SetMaxSize(fMaxSizeTagDB);
391 fTagDB->SetFS(fFileNameTagDB);
392 if (!fTagDB->Create()) return kErrTagFile;
394 fTagDB = new AliTagDB(fEventTag, fFileNameTagDB);
395 if (fTagDB->IsZombie()) return kErrTagFile;
398 fIsTagDBCreated = kTRUE;
401 // Store event tag in tree
402 if (fTagDB) fTagDB->Fill();
404 // Make top event object ready for next event data
406 // Clean up HLT ESD for the next event
407 if (fESD) fESD->Reset();
415 //______________________________________________________________________________
416 Int_t AliMDC::GetTotalSize()
418 // return the total current raw DB file size
420 if (!fRawDB) return -1;
422 return fRawDB->GetTotalSize();
425 //______________________________________________________________________________
426 Int_t AliMDC::Close()
428 // close the current raw DB file
430 if (!fRawDB) return -1;
432 fRawDB->WriteStats(fStats);
433 Int_t filesize = fRawDB->Close();
441 //______________________________________________________________________________
442 Int_t AliMDC::Run(const char* inputFile, Bool_t loop,
443 EWriteMode mode, Double_t maxFileSize,
444 const char* fs1, const char* fs2)
446 // Run the MDC processor. Read from the input stream and only return
447 // when the input gave and EOF or a fatal error occured. On success 0
448 // is returned, 1 in case of a fatality.
449 // inputFile is the name of the DATE input file; if NULL the input will
450 // be taken from the event builder.
451 // If loop is set the same input file will be reused in an infinite loop.
452 // mode specifies the type of the raw DB.
453 // maxFileSize is the maximal size of the raw DB.
454 // fs1 and fs2 are the file system locations of the raw DB.
456 Info("Run", "input = %s, rawdb size = %f, filter = %s, "
457 "looping = %s, compression = %d, delete files = %s",
458 inputFile ? inputFile : "event builder", maxFileSize,
459 fFilterMode == kFilterOff ? "off" :
460 (fFilterMode == kFilterOn ? "on" : "transparent"),
461 loop ? "yes" : "no", fCompress, fDeleteFiles ? "yes" : "no");
463 // Open the input file
466 if ((fd = open(inputFile, O_RDONLY)) == -1) {
467 Error("Run", "cannot open input file %s", inputFile);
472 // Used for statistics
475 Double_t told = 0, tnew = 0;
476 Float_t chunkSize = maxFileSize/100, nextChunk = chunkSize;
478 // Create new raw DB.
481 if (Open(mode,NULL,maxFileSize,fs1,fs2) < 0) return 1;
483 // Process input stream
488 UInt_t eventSize = 0;
491 AliRawEventHeaderBase header;
495 // If we were in looping mode stop directly after a SIGUSR1 signal
497 Info("Run", "Stopping loop, processed %d events", numEvents);
501 if (!inputFile) { // get data from event builder
503 if ((eorFlag = ebEor())) break;
504 if ((event = (char*)ebGetNextEvent()) == (char*)-1) {
505 Error("Run", "error getting next event (%s)", ebGetLastError());
509 // no event, sleep for 1 second and try again
510 gSystem->Sleep(1000);
514 Error("Run", "AliMDC was compiled without event builder support");
522 } else { // get data from a file
525 if ((nrecv = Read(fd, header.HeaderBaseBegin(), header.HeaderBaseSize())) !=
526 header.HeaderBaseSize()) {
527 if (nrecv == 0) { // eof
529 ::lseek(fd, 0, SEEK_SET);
535 Error("Run", "error reading base header");
542 char *data = (char *)header.HeaderBaseBegin();
543 AliRawEventHeaderBase *hdr = AliRawEventHeaderBase::Create(data);
545 if ((nrecv = Read(fd, hdr->HeaderBegin(), hdr->HeaderSize())) !=
547 if (nrecv == 0) { // eof
549 ::lseek(fd, 0, SEEK_SET);
557 Error("Run", "error reading header");
564 if (eventSize < hdr->GetEventSize()) {
566 eventSize = 2 * hdr->GetEventSize();
567 event = new char[eventSize];
569 memcpy(event, hdr->HeaderBaseBegin(), hdr->HeaderBaseSize());
570 memcpy(event+hdr->HeaderBaseSize(), hdr->HeaderBegin(), hdr->HeaderSize());
571 if (hdr->GetExtendedDataSize() != 0)
572 memcpy(event+hdr->HeaderBaseSize()+hdr->HeaderSize(),
573 hdr->GetExtendedData(), hdr->GetExtendedDataSize());
574 Int_t size = hdr->GetEventSize() - hdr->GetHeadSize();
575 if (Read(fd, event + hdr->GetHeadSize(), size) != size) {
576 Error("Run", "error reading data");
585 Int_t result = ProcessEvent(event, !inputFile);
587 Error("Run", "error writing data. Error code: %d",result);
592 printf("Processed event %d (%d)\n", numEvents, fRawDB->GetEvents());
596 // Filling time statistics
597 if (fRawDB->GetBytesWritten() > nextChunk) {
598 tnew = timer.RealTime();
599 fStats->Fill(tnew-told);
602 nextChunk += chunkSize;
605 // Check size of raw db. If bigger than maxFileSize, close file
606 // and continue with new file.
607 if (fRawDB->GetBytesWritten() > maxFileSize) {
609 printf("Written raw DB at a rate of %.1f MB/s\n",
610 fRawDB->GetBytesWritten() / timer.RealTime() / 1000000.);
612 // Write stats object to raw db, run db, MySQL and AliEn
613 fRawDB->WriteStats(fStats);
617 if (!fRawDB->NextFile()) {
618 Error("Run", "error opening next raw data file");
620 if (inputFile) delete[] event;
624 printf("Filling raw DB %s\n", fRawDB->GetDBName());
625 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
626 fFilterMode != kFilterOff);
630 nextChunk = chunkSize;
633 // Check size of tag db
634 if (fTagDB && fTagDB->FileFull()) {
635 if (!fTagDB->NextFile()) {
639 printf("Filling tag DB %s\n", fTagDB->GetDBName());
644 // Make top event object ready for next event data
645 //printf("Event %d has %d sub-events\n", numEvents, fEvent->GetNSubEvents());
647 // Clean up HLT ESD for the next event
648 // if (fESD) fESD->Reset();
652 if (!ebReleaseEvent((iovec*)event)) {
653 Error("Run", "problem releasing event (%s)", ebGetLastError());
660 printf("Written raw DB at a rate of %.1f MB/s\n",
661 fRawDB->GetBytesWritten() / timer.RealTime() / 1000000.);
663 // Write stats to raw db and run db and delete stats object
670 Info("Run", "event builder reported end of run (%d)", eorFlag);
674 // Close input source
682 //______________________________________________________________________________
683 Int_t AliMDC::Read(Int_t fd, void *buffer, Int_t length)
685 // Read exactly length bytes into buffer. Returns number of bytes
686 // received, returns -1 in case of error and 0 for EOF.
690 if (fd < 0) return -1;
693 char *buf = (char *)buffer;
695 for (n = 0; n < length; n += nrecv) {
696 if ((nrecv = read(fd, buf+n, length-n)) <= 0) {
700 SysError("Read", "read");
707 //______________________________________________________________________________
708 Int_t AliMDC::ReadEquipmentHeader(AliRawEquipmentHeader &header,
709 Bool_t isSwapped, char*& data)
711 // Read equipment header info from DATE data stream. Returns bytes read
712 // (i.e. AliRawEquipmentHeader::HeaderSize()), -1 in case of error and
713 // 0 for EOF. If isSwapped is kTRUE the event data is byte swapped
714 // and we will swap the header to host format.
716 memcpy(header.HeaderBegin(), data, header.HeaderSize());
717 data += header.HeaderSize();
719 // Swap equipment header data if needed
723 if (header.GetEquipmentSize() < (UInt_t)header.HeaderSize()) {
724 Error("ReadEquipmentHeader", "invalid equipment header size");
725 // try recovery... how?
729 return header.HeaderSize();
732 //______________________________________________________________________________
733 Int_t AliMDC::ReadRawData(AliRawData &raw, Int_t size, char*& data)
735 // Read raw data from DATE data stream. Returns bytes read (i.e.
736 // size), -1 in case of error and 0 for EOF.
738 raw.SetBuffer(data, size);
744 //______________________________________________________________________________
747 // Stop the event loop
750 if (fRawDB) fRawDB->Stop();