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 AliRunDB class provides the interface to the run and file //
37 // catalogues (AliEn or plain MySQL). //
38 // The AliStats class provides statics information that is added as //
39 // a single keyed object to each raw file. //
40 // The AliTagDB provides an interface to a TAG database. //
41 // The AliMDC class is usid by the "alimdc" stand-alone program //
42 // that reads data directly from DATE. //
44 //////////////////////////////////////////////////////////////////////////
46 #include <sys/types.h>
53 #include <TStopwatch.h>
57 #include "libDateEb.h"
63 #include "AliRawEvent.h"
64 #include "AliRawEventHeader.h"
65 #include "AliRawEquipment.h"
66 #include "AliRawEquipmentHeader.h"
67 #include "AliRawData.h"
70 #include "AliRawRFIODB.h"
71 #include "AliRawCastorDB.h"
72 #include "AliRawRootdDB.h"
73 #include "AliRawNullDB.h"
76 #include "AliFilter.h"
84 const char* const AliMDC::fgkFilterName[kNFilters] = {"AliHoughFilter"};
86 //______________________________________________________________________________
87 AliMDC::AliMDC(Int_t compress, Bool_t deleteFiles, EFilterMode filterMode,
88 const char* localRunDB, Bool_t rdbmsRunDB,
89 const char* alienHostRunDB, const char* alienDirRunDB,
90 Double_t maxSizeTagDB, const char* fileNameTagDB) :
91 fEvent(new AliRawEvent),
95 fRunDB(new AliRunDB(localRunDB, rdbmsRunDB, alienHostRunDB, alienDirRunDB)),
98 fDeleteFiles(deleteFiles),
99 fFilterMode(filterMode),
103 // Create MDC processor object.
104 // compress is the file compression mode.
105 // If deleteFiles is kTRUE the raw data files will be deleted after they
107 // If the filterMode if kFilterOff no filter algorithm will be, if it is
108 // kFilterTransparent the algorthims will be run but no events will be
109 // rejected, if it is kFilterOn the filters will be run and the event will
110 // be rejected if all filters return kFALSE.
111 // localRunDB is the file name of the local run DB; if NULL no local run DB
113 // The filling of a MySQL run DB can be switch on or off with rdbmsRunDB.
114 // The host and directory name of the alien run DB can be specified by
115 // alienHostRunDB and alienDirRunDB; if NULL no alien DB will be filled.
116 // If maxSizeTagDB is greater than 0 it determines the maximal size of the
117 // tag DB and then fileNameTagDB is the directory name for the tag DB.
118 // Otherwise fileNameTagDB is the file name of the tag DB. If it is NULL
119 // no tag DB will be created.
122 if (fFilterMode != kFilterOff) {
127 if (maxSizeTagDB > 0) {
128 fTagDB = new AliTagDB(fEvent->GetHeader(), NULL);
129 fTagDB->SetMaxSize(maxSizeTagDB);
130 fTagDB->SetFS(fileNameTagDB);
133 fTagDB = new AliTagDB(fEvent->GetHeader(), fileNameTagDB);
137 // install SIGUSR1 handler to allow clean interrupts
138 gSystem->AddSignalHandler(new AliMDCInterruptHandler(this));
140 // create the high level filters
141 if (fFilterMode != kFilterOff) {
142 for (Int_t iFilter = 0; iFilter < kNFilters; iFilter++) {
143 TClass* filterClass = gROOT->GetClass(fgkFilterName[iFilter]);
145 Warning("AliMDC", "no filter class %s found", fgkFilterName[iFilter]);
148 AliFilter* filter = (AliFilter*) filterClass->New();
150 Warning("AliMDC", "creation of filter %s failed", fgkFilterName[iFilter]);
153 fFilters.Add(filter);
158 //______________________________________________________________________________
172 //______________________________________________________________________________
173 AliMDC::AliMDC(const AliMDC& mdc): TObject(mdc)
177 Fatal("AliMDC", "copy constructor not implemented");
180 //______________________________________________________________________________
181 AliMDC& AliMDC::operator = (const AliMDC& /*mdc*/)
183 // assignment operator
185 Fatal("operator =", "assignment operator not implemented");
190 //______________________________________________________________________________
191 Int_t AliMDC::Open(EWriteMode mode, const char* fileName)
193 // open a new raw DB file
196 fRawDB = new AliRawRFIODB(fEvent, fESD, fCompress, fileName);
197 else if (mode == kROOTD)
198 fRawDB = new AliRawRootdDB(fEvent, fESD, fCompress, fileName);
199 else if (mode == kCASTOR)
200 fRawDB = new AliRawCastorDB(fEvent, fESD, fCompress, fileName);
201 else if (mode == kDEVNULL)
202 fRawDB = new AliRawNullDB(fEvent, fESD, fCompress, fileName);
204 fRawDB = new AliRawDB(fEvent, fESD, fCompress, fileName);
205 fRawDB->SetDeleteFiles(fDeleteFiles);
207 if (fRawDB->IsZombie()) {
212 Info("Open", "Filling raw DB %s\n", fRawDB->GetDBName());
214 // Create AliStats object
215 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
216 fFilterMode != kFilterOff);
220 //______________________________________________________________________________
221 Int_t AliMDC::ProcessEvent(void* event, Bool_t isIovecArray)
223 // Convert the DATE event to an AliRawEvent object and store it in the raw DB,
224 // optionally also run the filter.
225 // event is either a pointer to the streamlined event
226 // or, if isIovecArray is kTRUE, a pointer to an array of iovecs with one
227 // iovec per subevent (used by the event builder).
228 // The return value is the number of written bytes or an error code
229 const UInt_t kFileSizeErrorLevel = 1900000000;
231 UInt_t currentFileSize = GetTotalSize();
232 if(currentFileSize > kFileSizeErrorLevel) {
233 Error("ProcessEvent", "file size (%u) exceeds the limit "
239 char* data = (char*) event;
240 if (isIovecArray) data = (char*) ((iovec*) event)[0].iov_base;
242 // Shortcut for easy header access
243 AliRawEventHeader &header = *fEvent->GetHeader();
246 if ((status = ReadHeader(header, data)) != header.HeaderSize()) {
250 if (AliDebugLevel() > 2) ToAliDebug(3, header.Dump(););
252 // Check event type and skip "Start of Run", "End of Run",
253 // "Start of Run Files" and "End of Run Files"
254 Int_t size = header.GetEventSize() - header.HeaderSize();
255 switch (header.GetType()) {
256 case AliRawEventHeader::kStartOfRun:
257 case AliRawEventHeader::kEndOfRun:
258 case AliRawEventHeader::kStartOfRunFiles:
259 case AliRawEventHeader::kEndOfRunFiles:
261 AliDebug(1, Form("Skipping %s (%d bytes)", header.GetTypeName(), size));
262 return kErrStartEndRun;
266 AliDebug(1, Form("Processing %s (%d bytes)", header.GetTypeName(), size));
270 // Amount of data left to read for this event
273 // If there is less data for this event than the next sub-event
274 // header, something is wrong. Skip to next event...
275 if (toRead < header.HeaderSize()) {
276 Error("ProcessEvent", "header size (%d) exceeds number of bytes "
277 "to read (%d)", header.HeaderSize(), toRead);
278 if (AliDebugLevel() > 0) ToAliDebug(1, header.Dump(););
279 return kErrHeaderSize;
282 // Loop over all sub-events... (LDCs)
285 if (isIovecArray) data = (char*) ((iovec*) event)[nsub].iov_base;
287 AliDebug(1, Form("reading LDC %d", nsub));
289 AliRawEvent *subEvent = fEvent->NextSubEvent();
291 // Read sub-event header
292 AliRawEventHeader &subHeader = *subEvent->GetHeader();
293 if ((status = ReadHeader(subHeader, data)) != subHeader.HeaderSize()) {
294 return kErrSubHeader;
297 if (AliDebugLevel() > 2) ToAliDebug(3, subHeader.Dump(););
299 toRead -= subHeader.HeaderSize();
301 Int_t rawSize = subHeader.GetEventSize() - subHeader.HeaderSize();
303 // Make sure raw data less than left over bytes for current event
304 if (rawSize > toRead) {
305 Warning("ProcessEvent", "raw data size (%d) exceeds number of "
306 "bytes to read (%d)\n", rawSize, toRead);
307 if (AliDebugLevel() > 0) ToAliDebug(1, subHeader.Dump(););
311 // Read Equipment Headers (in case of physics or calibration event)
312 if (header.GetType() == AliRawEventHeader::kPhysicsEvent ||
313 header.GetType() == AliRawEventHeader::kCalibrationEvent) {
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;
323 toRead -= equipHeaderSize;
324 rawSize -= equipHeaderSize;
326 // Read equipment raw data
327 AliRawData &subRaw = *equipment.GetRawData();
329 Int_t eqSize = equipmentHeader.GetEquipmentSize() - equipHeaderSize;
330 if ((status = ReadRawData(subRaw, eqSize, data)) != eqSize) {
331 return kErrEquipment;
338 } else { // Read only raw data but no equipment header
339 AliRawEquipment &equipment = *subEvent->NextEquipment();
340 AliRawData &subRaw = *equipment.GetRawData();
341 if ((status = ReadRawData(subRaw, rawSize, data)) != rawSize) {
342 return kErrEquipment;
351 // High Level Event Filter
352 if (fFilterMode != kFilterOff) {
353 if (header.GetType() == AliRawEventHeader::kPhysicsEvent ||
354 header.GetType() == AliRawEventHeader::kCalibrationEvent) {
355 Bool_t result = kFALSE;
356 for (Int_t iFilter = 0; iFilter < fFilters.GetEntriesFast(); iFilter++) {
357 AliFilter* filter = (AliFilter*) fFilters[iFilter];
358 if (!filter) continue;
359 if (filter->Filter(fEvent, fESD)) result = kTRUE;
361 if ((fFilterMode == kFilterOn) && !result) return kFilterReject;
365 // Set stat info for first event of this file
366 if (fRawDB->GetEvents() == 0)
367 fStats->SetFirstId(header.GetRunNumber(), header.GetEventInRun());
369 // Store raw event in tree
370 Int_t nBytes = fRawDB->Fill();
372 // Store header in tree
373 if (fTagDB) fTagDB->Fill();
375 // Make top event object ready for next event data
377 // Clean up HLT ESD for the next event
378 if (fESD) fESD->Reset();
386 //______________________________________________________________________________
387 Int_t AliMDC::GetTotalSize()
389 // return the total current raw DB file size
391 if (!fRawDB) return -1;
393 return fRawDB->GetTotalSize();
396 //______________________________________________________________________________
397 Int_t AliMDC::Close()
399 // close the current raw DB file
401 if (!fRawDB) return -1;
403 fRawDB->WriteStats(fStats);
404 fRunDB->Update(fStats);
405 Int_t filesize = fRawDB->Close();
413 //______________________________________________________________________________
414 Int_t AliMDC::Run(const char* inputFile, Bool_t loop,
415 EWriteMode mode, Double_t maxFileSize,
416 const char* fs1, const char* fs2)
418 // Run the MDC processor. Read from the input stream and only return
419 // when the input gave and EOF or a fatal error occured. On success 0
420 // is returned, 1 in case of a fatality.
421 // inputFile is the name of the DATE input file; if NULL the input will
422 // be taken from the event builder.
423 // If loop is set the same input file will be reused in an infinite loop.
424 // mode specifies the type of the raw DB.
425 // maxFileSize is the maximal size of the raw DB.
426 // fs1 and fs2 are the file system locations of the raw DB.
428 Info("Run", "input = %s, rawdb size = %f, filter = %s, "
429 "looping = %s, compression = %d, delete files = %s",
430 inputFile ? inputFile : "event builder", maxFileSize,
431 fFilterMode == kFilterOff ? "off" :
432 (fFilterMode == kFilterOn ? "on" : "transparent"),
433 loop ? "yes" : "no", fCompress, fDeleteFiles ? "yes" : "no");
435 // Open the input file
438 if ((fd = open(inputFile, O_RDONLY)) == -1) {
439 Error("Run", "cannot open input file %s", inputFile);
444 // Used for statistics
447 Double_t told = 0, tnew = 0;
448 Float_t chunkSize = maxFileSize/100, nextChunk = chunkSize;
450 // Create new raw DB.
453 fRawDB = new AliRawRFIODB(fEvent, fESD, fCompress, NULL);
454 } else if (mode == kROOTD) {
455 fRawDB = new AliRawRootdDB(fEvent, fESD, fCompress, NULL);
456 } else if (mode == kCASTOR) {
457 fRawDB = new AliRawCastorDB(fEvent, fESD, fCompress, NULL);
458 } else if (mode == kDEVNULL) {
459 fRawDB = new AliRawNullDB(fEvent, fESD, fCompress, NULL);
461 fRawDB = new AliRawDB(fEvent, fESD, fCompress, NULL);
463 fRawDB->SetMaxSize(maxFileSize);
464 fRawDB->SetFS(fs1, fs2);
465 fRawDB->SetDeleteFiles(fDeleteFiles);
468 if (fRawDB->IsZombie()) {
473 printf("Filling raw DB %s\n", fRawDB->GetDBName());
475 // Create AliStats object
476 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
477 fFilterMode != kFilterOff);
479 // Process input stream
484 UInt_t eventSize = 0;
489 // If we were in looping mode stop directly after a SIGUSR1 signal
491 Info("Run", "Stopping loop, processed %d events", numEvents);
495 if (!inputFile) { // get data from event builder
497 if ((eorFlag = ebEor())) break;
498 if ((event = (char*)ebGetNextEvent()) == (char*)-1) {
499 Error("Run", "error getting next event (%s)", ebGetLastError());
503 // no event, sleep for 1 second and try again
504 gSystem->Sleep(1000);
508 Error("Run", "AliMDC was compiled without event builder support");
516 } else { // get data from a file
517 AliRawEventHeader header;
519 if ((nrecv = Read(fd, header.HeaderBegin(), header.HeaderSize())) !=
520 header.HeaderSize()) {
521 if (nrecv == 0) { // eof
523 ::lseek(fd, 0, SEEK_SET);
529 Error("Run", "error reading header");
535 if (eventSize < header.GetEventSize()) {
537 eventSize = 2 * header.GetEventSize();
538 event = new char[eventSize];
540 memcpy(event, header.HeaderBegin(), header.HeaderSize());
541 Int_t size = header.GetEventSize() - header.HeaderSize();
542 if (Read(fd, event + header.HeaderSize(), size) != size) {
543 Error("Run", "error reading data");
550 Int_t result = ProcessEvent(event, !inputFile);
552 Error("Run", "error writing data. Error code: %d",result);
557 printf("Processed event %d (%d)\n", numEvents, fRawDB->GetEvents());
561 // Filling time statistics
562 if (fRawDB->GetBytesWritten() > nextChunk) {
563 tnew = timer.RealTime();
564 fStats->Fill(tnew-told);
567 nextChunk += chunkSize;
570 // Check size of raw db. If bigger than maxFileSize, close file
571 // and continue with new file.
572 if (fRawDB->GetBytesWritten() > maxFileSize) {
574 printf("Written raw DB at a rate of %.1f MB/s\n",
575 fRawDB->GetBytesWritten() / timer.RealTime() / 1000000.);
577 // Write stats object to raw db, run db, MySQL and AliEn
578 fRawDB->WriteStats(fStats);
579 if (fRunDB) fRunDB->Update(fStats);
583 if (!fRawDB->NextFile()) {
584 Error("Run", "error opening next raw data file");
586 if (inputFile) delete[] event;
590 printf("Filling raw DB %s\n", fRawDB->GetDBName());
591 fStats = new AliStats(fRawDB->GetDBName(), fCompress,
592 fFilterMode != kFilterOff);
596 nextChunk = chunkSize;
599 // Check size of tag db
600 if (fTagDB && fTagDB->FileFull()) {
601 if (!fTagDB->NextFile()) {
605 printf("Filling tag DB %s\n", fTagDB->GetDBName());
610 // Make top event object ready for next event data
611 //printf("Event %d has %d sub-events\n", numEvents, fEvent->GetNSubEvents());
613 // Clean up HLT ESD for the next event
614 // if (fESD) fESD->Reset();
618 if (!ebReleaseEvent((iovec*)event)) {
619 Error("Run", "problem releasing event (%s)", ebGetLastError());
626 printf("Written raw DB at a rate of %.1f MB/s\n",
627 fRawDB->GetBytesWritten() / timer.RealTime() / 1000000.);
629 // Write stats to raw db and run db and delete stats object
636 Info("Run", "event builder reported end of run (%d)", eorFlag);
640 // Close input source
647 //______________________________________________________________________________
648 Int_t AliMDC::Read(Int_t fd, void *buffer, Int_t length)
650 // Read exactly length bytes into buffer. Returns number of bytes
651 // received, returns -1 in case of error and 0 for EOF.
655 if (fd < 0) return -1;
658 char *buf = (char *)buffer;
660 for (n = 0; n < length; n += nrecv) {
661 if ((nrecv = read(fd, buf+n, length-n)) <= 0) {
665 SysError("Read", "read");
672 //______________________________________________________________________________
673 Int_t AliMDC::ReadHeader(AliRawEventHeader &header, char*& data)
675 // Read header info from DATE data stream. Returns bytes read (i.e.
676 // AliRawEventHeader::HeaderSize()), -1 in case of error and 0 for EOF.
678 memcpy(header.HeaderBegin(), data, header.HeaderSize());
679 data += header.HeaderSize();
681 // Swap header data if needed
682 if (header.IsSwapped())
685 // Is header valid...
686 if (!header.IsValid()) {
687 Error("ReadHeader", "invalid header format");
688 // try recovery... how?
691 if (header.GetEventSize() < (UInt_t)header.HeaderSize()) {
692 Error("ReadHeader", "invalid header size");
693 // try recovery... how?
697 return header.HeaderSize();
700 //______________________________________________________________________________
701 Int_t AliMDC::ReadEquipmentHeader(AliRawEquipmentHeader &header,
702 Bool_t isSwapped, char*& data)
704 // Read equipment header info from DATE data stream. Returns bytes read
705 // (i.e. AliRawEquipmentHeader::HeaderSize()), -1 in case of error and
706 // 0 for EOF. If isSwapped is kTRUE the event data is byte swapped
707 // and we will swap the header to host format.
709 memcpy(header.HeaderBegin(), data, header.HeaderSize());
710 data += header.HeaderSize();
712 // Swap equipment header data if needed
716 if (header.GetEquipmentSize() < (UInt_t)header.HeaderSize()) {
717 Error("ReadEquipmentHeader", "invalid equipment header size");
718 // try recovery... how?
722 return header.HeaderSize();
725 //______________________________________________________________________________
726 Int_t AliMDC::ReadRawData(AliRawData &raw, Int_t size, char*& data)
728 // Read raw data from DATE data stream. Returns bytes read (i.e.
729 // size), -1 in case of error and 0 for EOF.
731 raw.SetBuffer(data, size);
737 //______________________________________________________________________________
740 // Stop the event loop
743 if (fRawDB) fRawDB->Stop();
747 //______________________________________________________________________________
748 AliMDC::AliMDCInterruptHandler::AliMDCInterruptHandler(const
749 AliMDCInterruptHandler&
751 TSignalHandler(handler)
755 Fatal("AliMDCInterruptHandler", "copy constructor not implemented");
758 //______________________________________________________________________________
759 AliMDC::AliMDCInterruptHandler&
760 AliMDC::AliMDCInterruptHandler::operator = (const AliMDCInterruptHandler&
763 // assignment operator
765 Fatal("operator =", "assignment operator not implemented");