3 /**************************************************************************
4 * This file is property of and copyright by the ALICE HLT Project *
5 * ALICE Experiment at CERN, All rights reserved. *
7 * Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no> *
8 * Timm Steinbeck <timm@kip.uni-heidelberg.de> *
9 * for The ALICE HLT Project. *
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 **************************************************************************/
20 /** @file AliHLTComponent.cxx
21 @author Matthias Richter, Timm Steinbeck
23 @brief Base class implementation for HLT components. */
25 // see header file for class documentation
27 // refer to README to build package
29 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
35 //#include "AliHLTStdIncludes.h"
36 #include "AliHLTComponent.h"
37 #include "AliHLTComponentHandler.h"
38 #include "AliHLTMessage.h"
41 #include "TObjArray.h"
42 #include "TObjectTable.h"
44 #include "TStopwatch.h"
45 #include "AliHLTMemoryFile.h"
46 #include "AliHLTMisc.h"
49 /** ROOT macro for the implementation of ROOT specific class methods */
50 ClassImp(AliHLTComponent);
52 /** stopwatch macro using the stopwatch guard */
53 #define ALIHLTCOMPONENT_STOPWATCH(type) AliHLTStopwatchGuard swguard(fpStopwatches!=NULL?reinterpret_cast<TStopwatch*>(fpStopwatches->At((int)type)):NULL)
54 //#define ALIHLTCOMPONENT_STOPWATCH(type)
56 /** stopwatch macro for operations of the base class */
57 #define ALIHLTCOMPONENT_BASE_STOPWATCH() ALIHLTCOMPONENT_STOPWATCH(kSWBase)
58 /** stopwatch macro for operations of the detector algorithm (DA) */
59 #define ALIHLTCOMPONENT_DA_STOPWATCH() ALIHLTCOMPONENT_STOPWATCH(kSWDA)
61 AliHLTComponent::AliHLTComponent()
69 fCurrentInputBlock(-1),
70 fSearchDataType(kAliHLTVoidDataType),
75 fOutputBufferFilled(0),
77 fpStopwatches(new TObjArray(kSWTypeCount)),
81 fCDBInitialized(false),
84 // see header file for class documentation
86 // refer to README to build package
88 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
89 memset(&fEnvironment, 0, sizeof(AliHLTComponentEnvironment));
90 if (fgpComponentHandler)
91 fgpComponentHandler->ScheduleRegister(this);
92 //SetLocalLoggingLevel(kHLTLogDefault);
95 AliHLTComponent::~AliHLTComponent()
97 // see header file for function documentation
98 CleanupInputObjects();
99 if (fpStopwatches!=NULL) delete fpStopwatches;
101 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
102 while (element!=fMemFiles.end()) {
104 if ((*element)->IsClosed()==0) {
105 HLTWarning("memory file has not been closed, possible data loss or incomplete buffer");
106 // close but do not flush as we dont know whether the buffer is still valid
107 (*element)->CloseMemoryFile(0);
116 AliHLTComponentHandler* AliHLTComponent::fgpComponentHandler=NULL;
118 int AliHLTComponent::SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite)
120 // see header file for function documentation
122 if (fgpComponentHandler==NULL || bOverwrite!=0)
123 fgpComponentHandler=pCH;
129 int AliHLTComponent::UnsetGlobalComponentHandler()
131 // see header file for function documentation
132 return SetGlobalComponentHandler(NULL,1);
135 int AliHLTComponent::Init( AliHLTComponentEnvironment* environ, void* environParam, int argc, const char** argv )
137 // see header file for function documentation
140 memcpy(&fEnvironment, environ, sizeof(AliHLTComponentEnvironment));
141 fEnvironment.fParam=environParam;
143 const char** pArguments=NULL;
148 pArguments=new const char*[argc];
150 for (int i=0; i<argc && iResult>=0; i++) {
152 if (argument.IsNull()) continue;
155 if (argument.CompareTo("benchmark")==0) {
158 } else if (argument.CompareTo("loglevel")==0) {
159 if ((bMissingParam=(++i>=argc))) break;
160 TString parameter(argv[i]);
161 parameter.Remove(TString::kLeading, ' '); // remove all blanks
162 if (parameter.BeginsWith("0x") &&
163 parameter.Replace(0,2,"",0).IsHex()) {
164 AliHLTComponentLogSeverity loglevel=kHLTLogNone;
165 sscanf(parameter.Data(),"%x", (unsigned int*)&loglevel);
166 SetLocalLoggingLevel(loglevel);
168 HLTError("wrong parameter for argument %s, hex number expected", argument.Data());
172 pArguments[iNofChildArgs++]=argv[i];
180 HLTError("missing parameter for argument %s", argument.Data());
184 iResult=DoInit(iNofChildArgs, pArguments);
186 if (iResult>=0) fEventCount=0;
187 if (pArguments) delete [] pArguments;
191 int AliHLTComponent::Deinit()
193 // see header file for function documentation
197 HLTWarning("did not receive EOR for run %d", fpRunDesc->fRunNo);
198 AliHLTRunDesc* pRunDesc=fpRunDesc;
206 int AliHLTComponent::InitCDB(const char* cdbPath)
209 // we presume the library already to be loaded
211 AliHLTComponentHandler cHandler;
212 AliHLTMiscInitCDB_t pFunc=(AliHLTMiscInitCDB_t)cHandler.FindSymbol(ALIHLTMISC_LIBRARY, ALIHLTMISC_INIT_CDB);
214 iResult=(*pFunc)(cdbPath);
215 fCDBInitialized=iResult>=0;
217 Message(NULL, kHLTLogError, "AliHLTComponent::InitCDB", "init CDB",
218 "can not find initialization function");
224 int AliHLTComponent::SetCDBRunNo(int runNo)
227 if (!fCDBInitialized) return iResult;
228 // we presume the library already to be loaded
230 AliHLTComponentHandler cHandler;
231 AliHLTMiscSetCDBRunNo_t pFunc=(AliHLTMiscSetCDBRunNo_t)cHandler.FindSymbol(ALIHLTMISC_LIBRARY, ALIHLTMISC_SET_CDB_RUNNO);
233 iResult=(*pFunc)(runNo);
235 Message(NULL, kHLTLogError, "AliHLTComponent::SetCDBRunNo", "init CDB",
236 "can not find initialization function");
242 int AliHLTComponent::DoInit( int /*argc*/, const char** /*argv*/)
244 // default implementation, childs can overload
248 int AliHLTComponent::DoDeinit()
250 // default implementation, childs can overload
254 int AliHLTComponent::Reconfigure(const char* /*cdbEntry*/, const char* /*chainId*/)
256 // default implementation, childs can overload
260 int AliHLTComponent::GetOutputDataTypes(AliHLTComponentDataTypeList& /*tgtList*/)
262 HLTLogKeyword("dummy");
266 void AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2] ) const
268 // see header file for function documentation
269 memset( output, 0, kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2 );
270 strncat( output, type.fOrigin, kAliHLTComponentDataTypefOriginSize );
271 strcat( output, ":" );
272 strncat( output, type.fID, kAliHLTComponentDataTypefIDsize );
275 string AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, int mode)
277 // see header file for function documentation
283 for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
284 sprintf(tmp, "'%d", type.fOrigin[i]);
288 for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
289 sprintf(tmp, "%d'", type.fID[i]);
298 for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
299 unsigned char* puc=(unsigned char*)type.fOrigin;
301 sprintf(tmp, "'\\%x", type.fOrigin[i]);
303 sprintf(tmp, "'%c", type.fOrigin[i]);
307 for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
308 unsigned char* puc=(unsigned char*)type.fID;
310 sprintf(tmp, "\\%x'", type.fID[i]);
312 sprintf(tmp, "%c'", type.fID[i]);
318 if (type==kAliHLTVoidDataType) {
321 // some gymnastics in order to avoid a '0' which is part of either or both
322 // ID and origin terminating the whole string. Unfortunately, string doesn't
323 // stop appending at the '0' if the number of elements to append was
324 // explicitely specified
326 tmp.append(type.fOrigin, kAliHLTComponentDataTypefOriginSize);
327 out.append(tmp.c_str());
330 tmp.append(type.fID, kAliHLTComponentDataTypefIDsize);
331 out.append(tmp.c_str());
337 void* AliHLTComponent::AllocMemory( unsigned long size )
339 // see header file for function documentation
340 if (fEnvironment.fAllocMemoryFunc)
341 return (*fEnvironment.fAllocMemoryFunc)(fEnvironment.fParam, size );
342 HLTFatal("no memory allocation handler registered");
346 int AliHLTComponent::MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount,
347 AliHLTComponentBlockData** outputBlocks )
349 // see header file for function documentation
350 if ( blockCount==NULL || outputBlocks==NULL )
352 AliHLTUInt32_t count = blocks.size();
356 *outputBlocks = NULL;
359 *outputBlocks = reinterpret_cast<AliHLTComponentBlockData*>( AllocMemory( sizeof(AliHLTComponentBlockData)*count ) );
360 if ( !*outputBlocks )
362 for ( unsigned long i = 0; i < count; i++ ) {
363 (*outputBlocks)[i] = blocks[i];
364 if (blocks[i].fDataType==kAliHLTAnyDataType) {
365 (*outputBlocks)[i].fDataType=GetOutputDataType();
366 /* data type was set to the output data type by the PubSub AliRoot
367 Wrapper component, if data type of the block was ********:****.
368 Now handled by the component base class in order to have same
369 behavior when running embedded in AliRoot
370 memset((*outputBlocks)[i].fDataType.fID, '*', kAliHLTComponentDataTypefIDsize);
371 memset((*outputBlocks)[i].fDataType.fOrigin, '*', kAliHLTComponentDataTypefOriginSize);
380 int AliHLTComponent::GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd )
382 // see header file for function documentation
383 if (fEnvironment.fGetEventDoneDataFunc)
384 return (*fEnvironment.fGetEventDoneDataFunc)(fEnvironment.fParam, fCurrentEvent, size, edd );
388 int AliHLTComponent::FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList)
390 // see header file for function documentation
393 AliHLTComponentDataTypeList itypes;
394 AliHLTComponentDataTypeList otypes;
395 otypes.push_back(GetOutputDataType());
396 if (otypes[0]==kAliHLTMultipleDataType) {
399 if ((count=GetOutputDataTypes(otypes))>0) {
400 } else if (GetComponentType()!=kSink) {
401 HLTWarning("component %s indicates multiple output data types but GetOutputDataTypes returns %d", GetComponentID(), count);
404 ((AliHLTComponent*)pConsumer)->GetInputDataTypes(itypes);
405 AliHLTComponentDataTypeList::iterator itype=itypes.begin();
406 while (itype!=itypes.end()) {
407 //PrintDataTypeContent((*itype), "consumer \'%s\'");
408 AliHLTComponentDataTypeList::iterator otype=otypes.begin();
409 while (otype!=otypes.end() && (*itype)!=(*otype)) otype++;
410 //if (otype!=otypes.end()) PrintDataTypeContent(*otype, "publisher \'%s\'");
411 if (otype!=otypes.end() ||
412 (*itype)==kAliHLTAnyDataType) {
413 if (tgtList) tgtList->push_back(*itype);
424 void AliHLTComponent::PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format) const
426 // see header file for function documentation
427 const char* fmt="publisher \'%s\'";
428 if (format) fmt=format;
429 HLTMessage(fmt, (DataType2Text(dt)).c_str());
430 HLTMessage("%x %x %x %x %x %x %x %x : %x %x %x %x",
445 void AliHLTComponent::FillBlockData( AliHLTComponentBlockData& blockData )
447 // see header file for function documentation
448 blockData.fStructSize = sizeof(blockData);
449 FillShmData( blockData.fShmKey );
450 blockData.fOffset = ~(AliHLTUInt32_t)0;
451 blockData.fPtr = NULL;
453 FillDataType( blockData.fDataType );
454 blockData.fSpecification = kAliHLTVoidDataSpec;
457 void AliHLTComponent::FillShmData( AliHLTComponentShmData& shmData )
459 // see header file for function documentation
460 shmData.fStructSize = sizeof(shmData);
461 shmData.fShmType = gkAliHLTComponentInvalidShmType;
462 shmData.fShmID = gkAliHLTComponentInvalidShmID;
465 void AliHLTComponent::FillDataType( AliHLTComponentDataType& dataType )
467 // see header file for function documentation
468 dataType=kAliHLTAnyDataType;
471 void AliHLTComponent::CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt)
473 // see header file for function documentation
474 memcpy(&tgtdt.fID[0], &srcdt.fID[0], kAliHLTComponentDataTypefIDsize);
475 memcpy(&tgtdt.fOrigin[0], &srcdt.fOrigin[0], kAliHLTComponentDataTypefOriginSize);
478 void AliHLTComponent::SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin)
480 // see header file for function documentation
481 tgtdt.fStructSize=sizeof(AliHLTComponentDataType);
483 memset(&tgtdt.fID[0], 0, kAliHLTComponentDataTypefIDsize);
484 strncpy(&tgtdt.fID[0], id, strlen(id)<(size_t)kAliHLTComponentDataTypefIDsize?strlen(id):kAliHLTComponentDataTypefIDsize);
487 memset(&tgtdt.fOrigin[0], 0, kAliHLTComponentDataTypefOriginSize);
488 strncpy(&tgtdt.fOrigin[0], origin, strlen(origin)<(size_t)kAliHLTComponentDataTypefOriginSize?strlen(origin):kAliHLTComponentDataTypefOriginSize);
492 void AliHLTComponent::FillEventData(AliHLTComponentEventData& evtData)
494 // see header file for function documentation
495 memset(&evtData, 0, sizeof(AliHLTComponentEventData));
496 evtData.fStructSize=sizeof(AliHLTComponentEventData);
499 void AliHLTComponent::PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt)
501 // see header file for function documentation
503 msg.Form("AliHLTComponentDataType(%d): ID=\"", dt.fStructSize);
504 for ( int i = 0; i < kAliHLTComponentDataTypefIDsize; i++ ) {
505 if (dt.fID[i]!=0) msg+=dt.fID[i];
509 for ( int i = 0; i < kAliHLTComponentDataTypefOriginSize; i++ ) {
510 if (dt.fOrigin[i]!=0) msg+=dt.fOrigin[i];
514 AliHLTLogging::Message(NULL, kHLTLogNone, NULL , NULL, msg.Data());
517 int AliHLTComponent::GetEventCount() const
519 // see header file for function documentation
523 int AliHLTComponent::IncrementEventCounter()
525 // see header file for function documentation
526 if (fEventCount>=0) fEventCount++;
530 int AliHLTComponent::GetNumberOfInputBlocks() const
532 // see header file for function documentation
533 if (fpInputBlocks!=NULL) {
534 return fCurrentEventData.fBlockCnt;
539 const TObject* AliHLTComponent::GetFirstInputObject(const AliHLTComponentDataType& dt,
540 const char* classname,
543 // see header file for function documentation
544 ALIHLTCOMPONENT_BASE_STOPWATCH();
546 if (classname) fClassName=classname;
547 else fClassName.clear();
548 int idx=FindInputBlock(fSearchDataType, 0, 1);
551 HLTDebug("found block %d when searching for data type %s", idx, DataType2Text(dt).c_str());
552 if ((pObj=GetInputObject(idx, fClassName.c_str(), bForce))!=NULL) {
553 fCurrentInputBlock=idx;
560 const TObject* AliHLTComponent::GetFirstInputObject(const char* dtID,
561 const char* dtOrigin,
562 const char* classname,
565 // see header file for function documentation
566 ALIHLTCOMPONENT_BASE_STOPWATCH();
567 AliHLTComponentDataType dt;
568 SetDataType(dt, dtID, dtOrigin);
569 return GetFirstInputObject(dt, classname, bForce);
572 const TObject* AliHLTComponent::GetNextInputObject(int bForce)
574 // see header file for function documentation
575 ALIHLTCOMPONENT_BASE_STOPWATCH();
576 int idx=FindInputBlock(fSearchDataType, fCurrentInputBlock+1, 1);
577 //HLTDebug("found block %d when searching for data type %s", idx, DataType2Text(fSearchDataType).c_str());
580 if ((pObj=GetInputObject(idx, fClassName.c_str(), bForce))!=NULL) {
581 fCurrentInputBlock=idx;
587 int AliHLTComponent::FindInputBlock(const AliHLTComponentDataType& dt, int startIdx, int bObject) const
589 // see header file for function documentation
591 if (fpInputBlocks!=NULL) {
592 int idx=startIdx<0?0:startIdx;
593 for ( ; (UInt_t)idx<fCurrentEventData.fBlockCnt && iResult==-ENOENT; idx++) {
595 if (fpInputBlocks[idx].fPtr==NULL) continue;
596 AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)fpInputBlocks[idx].fPtr);
597 if (firstWord!=fpInputBlocks[idx].fSize-sizeof(AliHLTUInt32_t)) continue;
599 if (dt == kAliHLTAnyDataType || fpInputBlocks[idx].fDataType == dt ||
600 (memcmp(dt.fID, kAliHLTAnyDataTypeID, kAliHLTComponentDataTypefIDsize)==0 &&
601 memcmp(dt.fOrigin, fpInputBlocks[idx].fDataType.fOrigin, kAliHLTComponentDataTypefOriginSize)==0) ||
602 (memcmp(dt.fID, fpInputBlocks[idx].fDataType.fID, kAliHLTComponentDataTypefIDsize)==0) &&
603 memcmp(dt.fOrigin, kAliHLTDataOriginAny, kAliHLTComponentDataTypefOriginSize)==0) {
611 TObject* AliHLTComponent::CreateInputObject(int idx, int bForce)
613 // see header file for function documentation
615 if (fpInputBlocks!=NULL) {
616 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
617 if (fpInputBlocks[idx].fPtr) {
618 AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)fpInputBlocks[idx].fPtr);
619 if (firstWord==fpInputBlocks[idx].fSize-sizeof(AliHLTUInt32_t)) {
620 HLTDebug("create object from block %d size %d", idx, fpInputBlocks[idx].fSize);
621 AliHLTMessage msg(fpInputBlocks[idx].fPtr, fpInputBlocks[idx].fSize);
622 TClass* objclass=msg.GetClass();
623 pObj=msg.ReadObject(objclass);
624 if (pObj && objclass) {
625 HLTDebug("object %p type %s created", pObj, objclass->GetName());
629 } else if (bForce!=0) {
630 HLTError("size missmatch: block size %d, indicated %d", fpInputBlocks[idx].fSize, firstWord+sizeof(AliHLTUInt32_t));
633 HLTFatal("block descriptor empty");
636 HLTError("index %d out of range %d", idx, fCurrentEventData.fBlockCnt);
639 HLTError("no input blocks available");
645 TObject* AliHLTComponent::GetInputObject(int idx, const char* /*classname*/, int bForce)
647 // see header file for function documentation
648 if (fpInputObjects==NULL) {
649 fpInputObjects=new TObjArray(fCurrentEventData.fBlockCnt);
652 if (fpInputObjects) {
653 pObj=fpInputObjects->At(idx);
655 pObj=CreateInputObject(idx, bForce);
657 fpInputObjects->AddAt(pObj, idx);
661 HLTFatal("memory allocation failed: TObjArray of size %d", fCurrentEventData.fBlockCnt);
666 int AliHLTComponent::CleanupInputObjects()
668 // see header file for function documentation
669 if (!fpInputObjects) return 0;
670 TObjArray* array=fpInputObjects;
672 for (int i=0; i<array->GetEntries(); i++) {
673 TObject* pObj=array->At(i);
674 // grrr, garbage collection strikes back: When read via AliHLTMessage
675 // (CreateInputObject), and written to a TFile afterwards, the
676 // TFile::Close calls ROOOT's garbage collection. No clue why the
677 // object ended up in the key list and needs to be deleted
678 if (pObj && gObjectTable->PtrIsValid(pObj)) delete pObj;
684 AliHLTComponentDataType AliHLTComponent::GetDataType(const TObject* pObject)
686 // see header file for function documentation
687 ALIHLTCOMPONENT_BASE_STOPWATCH();
688 AliHLTComponentDataType dt=kAliHLTVoidDataType;
689 int idx=fCurrentInputBlock;
691 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
693 HLTError("unknown object %p", pObject);
697 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
698 dt=fpInputBlocks[idx].fDataType;
700 HLTFatal("severe internal error, index out of range");
706 AliHLTUInt32_t AliHLTComponent::GetSpecification(const TObject* pObject)
708 // see header file for function documentation
709 ALIHLTCOMPONENT_BASE_STOPWATCH();
710 AliHLTUInt32_t iSpec=kAliHLTVoidDataSpec;
711 int idx=fCurrentInputBlock;
713 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
715 HLTError("unknown object %p", pObject);
719 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
720 iSpec=fpInputBlocks[idx].fSpecification;
722 HLTFatal("severe internal error, index out of range");
728 int AliHLTComponent::Forward(const TObject* pObject)
730 // see header file for function documentation
732 int idx=fCurrentInputBlock;
734 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
736 HLTError("unknown object %p", pObject);
741 fOutputBlocks.push_back(fpInputBlocks[idx]);
746 int AliHLTComponent::Forward(const AliHLTComponentBlockData* pBlock)
748 // see header file for function documentation
750 int idx=fCurrentInputBlock;
752 if (fpInputObjects==NULL || (idx=FindInputBlock(pBlock))>=0) {
754 HLTError("unknown Block %p", pBlock);
759 // check for fpInputBlocks pointer done in FindInputBlock
760 fOutputBlocks.push_back(fpInputBlocks[idx]);
765 const AliHLTComponentBlockData* AliHLTComponent::GetFirstInputBlock(const AliHLTComponentDataType& dt)
767 // see header file for function documentation
768 ALIHLTCOMPONENT_BASE_STOPWATCH();
771 int idx=FindInputBlock(fSearchDataType, 0);
772 const AliHLTComponentBlockData* pBlock=NULL;
774 // check for fpInputBlocks pointer done in FindInputBlock
775 pBlock=&fpInputBlocks[idx];
776 fCurrentInputBlock=idx;
781 const AliHLTComponentBlockData* AliHLTComponent::GetFirstInputBlock(const char* dtID,
782 const char* dtOrigin)
784 // see header file for function documentation
785 ALIHLTCOMPONENT_BASE_STOPWATCH();
786 AliHLTComponentDataType dt;
787 SetDataType(dt, dtID, dtOrigin);
788 return GetFirstInputBlock(dt);
791 const AliHLTComponentBlockData* AliHLTComponent::GetInputBlock(int index)
793 // see header file for function documentation
794 ALIHLTCOMPONENT_BASE_STOPWATCH();
795 assert( 0 <= index and index < fCurrentEventData.fBlockCnt );
796 return &fpInputBlocks[index];
799 const AliHLTComponentBlockData* AliHLTComponent::GetNextInputBlock()
801 // see header file for function documentation
802 ALIHLTCOMPONENT_BASE_STOPWATCH();
803 int idx=FindInputBlock(fSearchDataType, fCurrentInputBlock+1);
804 const AliHLTComponentBlockData* pBlock=NULL;
806 // check for fpInputBlocks pointer done in FindInputBlock
807 pBlock=&fpInputBlocks[idx];
808 fCurrentInputBlock=idx;
813 int AliHLTComponent::FindInputBlock(const AliHLTComponentBlockData* pBlock) const
815 // see header file for function documentation
817 if (fpInputBlocks!=NULL) {
819 if (pBlock>=fpInputBlocks && pBlock<fpInputBlocks+fCurrentEventData.fBlockCnt) {
820 iResult=(int)(pBlock-fpInputBlocks);
829 AliHLTUInt32_t AliHLTComponent::GetSpecification(const AliHLTComponentBlockData* pBlock)
831 // see header file for function documentation
832 ALIHLTCOMPONENT_BASE_STOPWATCH();
833 AliHLTUInt32_t iSpec=kAliHLTVoidDataSpec;
834 int idx=fCurrentInputBlock;
836 if (fpInputObjects==NULL || (idx=FindInputBlock(pBlock))>=0) {
838 HLTError("unknown Block %p", pBlock);
842 // check for fpInputBlocks pointer done in FindInputBlock
843 iSpec=fpInputBlocks[idx].fSpecification;
848 int AliHLTComponent::PushBack(TObject* pObject, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
849 void* pHeader, int headerSize)
851 // see header file for function documentation
852 ALIHLTCOMPONENT_BASE_STOPWATCH();
855 AliHLTMessage msg(kMESS_OBJECT);
856 msg.WriteObject(pObject);
857 Int_t iMsgLength=msg.Length();
859 msg.SetLength(); // sets the length to the first (reserved) word
860 iResult=InsertOutputBlock(msg.Buffer(), iMsgLength, dt, spec, pHeader, headerSize);
862 HLTDebug("object %s (%p) size %d inserted to output", pObject->ClassName(), pObject, iMsgLength);
865 HLTError("object serialization failed for object %p", pObject);
874 int AliHLTComponent::PushBack(TObject* pObject, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec,
875 void* pHeader, int headerSize)
877 // see header file for function documentation
878 ALIHLTCOMPONENT_BASE_STOPWATCH();
879 AliHLTComponentDataType dt;
880 SetDataType(dt, dtID, dtOrigin);
881 return PushBack(pObject, dt, spec, pHeader, headerSize);
884 int AliHLTComponent::PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
885 void* pHeader, int headerSize)
887 // see header file for function documentation
888 ALIHLTCOMPONENT_BASE_STOPWATCH();
889 return InsertOutputBlock(pBuffer, iSize, dt, spec, pHeader, headerSize);
892 int AliHLTComponent::PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec,
893 void* pHeader, int headerSize)
895 // see header file for function documentation
896 ALIHLTCOMPONENT_BASE_STOPWATCH();
897 AliHLTComponentDataType dt;
898 SetDataType(dt, dtID, dtOrigin);
899 return PushBack(pBuffer, iSize, dt, spec, pHeader, headerSize);
902 int AliHLTComponent::InsertOutputBlock(void* pBuffer, int iBufferSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
903 void* pHeader, int iHeaderSize)
905 // see header file for function documentation
907 int iBlkSize = iBufferSize + iHeaderSize;
909 if (fpOutputBuffer && iBlkSize<=(int)(fOutputBufferSize-fOutputBufferFilled)) {
910 AliHLTUInt8_t* pTgt=fpOutputBuffer+fOutputBufferFilled;
911 AliHLTComponentBlockData bd;
913 bd.fOffset = fOutputBufferFilled;
916 bd.fSpecification = spec;
917 if (pHeader!=NULL && pHeader!=pTgt) {
918 memcpy(pTgt, pHeader, iHeaderSize);
921 pTgt += (AliHLTUInt8_t) iHeaderSize;
923 if (pBuffer!=NULL && pBuffer!=pTgt) {
924 memcpy(pTgt, pBuffer, iBufferSize);
926 //AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)pBuffer);
927 //HLTDebug("copy %d bytes from %p to output buffer %p, first word %#x", iBufferSize, pBuffer, pTgt, firstWord);
929 fOutputBufferFilled+=bd.fSize;
930 fOutputBlocks.push_back( bd );
931 //HLTDebug("buffer inserted to output: size %d data type %s spec %#x", iBlkSize, DataType2Text(dt).c_str(), spec);
933 if (fpOutputBuffer) {
934 HLTError("too little space in output buffer: %d, required %d", fOutputBufferSize-fOutputBufferFilled, iBlkSize);
936 HLTError("output buffer not available");
946 int AliHLTComponent::EstimateObjectSize(TObject* pObject) const
948 // see header file for function documentation
949 if (!pObject) return -EINVAL;
950 AliHLTMessage msg(kMESS_OBJECT);
951 msg.WriteObject(pObject);
955 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity, const char* dtID,
956 const char* dtOrigin,
959 // see header file for function documentation
960 ALIHLTCOMPONENT_BASE_STOPWATCH();
961 AliHLTComponentDataType dt;
962 SetDataType(dt, dtID, dtOrigin);
963 return CreateMemoryFile(capacity, dt, spec);
966 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity,
967 const AliHLTComponentDataType& dt,
970 // see header file for function documentation
971 ALIHLTCOMPONENT_BASE_STOPWATCH();
972 AliHLTMemoryFile* pFile=NULL;
973 if (capacity>=0 && static_cast<unsigned int>(capacity)<=fOutputBufferSize-fOutputBufferFilled){
974 AliHLTUInt8_t* pTgt=fpOutputBuffer+fOutputBufferFilled;
975 pFile=new AliHLTMemoryFile((char*)pTgt, capacity);
977 unsigned int nofBlocks=fOutputBlocks.size();
978 if (nofBlocks+1>fMemFiles.size()) {
979 fMemFiles.resize(nofBlocks+1, NULL);
981 if (nofBlocks<fMemFiles.size()) {
982 fMemFiles[nofBlocks]=pFile;
983 AliHLTComponentBlockData bd;
985 bd.fOffset = fOutputBufferFilled;
988 bd.fSpecification = spec;
989 fOutputBufferFilled+=bd.fSize;
990 fOutputBlocks.push_back( bd );
992 HLTError("can not allocate/grow object array");
993 pFile->CloseMemoryFile(0);
999 HLTError("can not create memory file of size %d (%d available)", capacity, fOutputBufferSize-fOutputBufferFilled);
1004 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(const char* dtID,
1005 const char* dtOrigin,
1006 AliHLTUInt32_t spec,
1009 // see header file for function documentation
1010 ALIHLTCOMPONENT_BASE_STOPWATCH();
1011 AliHLTComponentDataType dt;
1012 SetDataType(dt, dtID, dtOrigin);
1013 int size=fOutputBufferSize-fOutputBufferFilled;
1014 if (capacity<0 || capacity>1.0) {
1015 HLTError("invalid parameter: capacity %f", capacity);
1018 size=(int)(size*capacity);
1019 return CreateMemoryFile(size, dt, spec);
1022 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(const AliHLTComponentDataType& dt,
1023 AliHLTUInt32_t spec,
1026 // see header file for function documentation
1027 ALIHLTCOMPONENT_BASE_STOPWATCH();
1028 int size=fOutputBufferSize-fOutputBufferFilled;
1029 if (capacity<0 || capacity>1.0) {
1030 HLTError("invalid parameter: capacity %f", capacity);
1033 size=(int)(size*capacity);
1034 return CreateMemoryFile(size, dt, spec);
1037 int AliHLTComponent::Write(AliHLTMemoryFile* pFile, const TObject* pObject,
1038 const char* key, int option)
1040 // see header file for function documentation
1042 if (pFile && pObject) {
1044 iResult=pObject->Write(key, option);
1048 iResult=-pFile->GetErrno();
1049 if (iResult==-ENOSPC) {
1050 HLTError("error writing memory file, buffer too small");
1059 int AliHLTComponent::CloseMemoryFile(AliHLTMemoryFile* pFile)
1061 // see header file for function documentation
1064 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
1066 while (element!=fMemFiles.end() && iResult>=0) {
1067 if (*element && *element==pFile) {
1068 iResult=pFile->CloseMemoryFile();
1070 // sync memory files and descriptors
1072 fOutputBlocks[i].fSize=(*element)->GetSize()+(*element)->GetHeaderSize();
1080 HLTError("can not find memory file %p", pFile);
1088 int AliHLTComponent::CreateEventDoneData(AliHLTComponentEventDoneData /*edd*/)
1090 // see header file for function documentation
1091 int iResult=-ENOSYS;
1092 //#warning function not yet implemented
1093 HLTWarning("function not yet implemented");
1097 int AliHLTComponent::ProcessEvent( const AliHLTComponentEventData& evtData,
1098 const AliHLTComponentBlockData* blocks,
1099 AliHLTComponentTriggerData& trigData,
1100 AliHLTUInt8_t* outputPtr,
1101 AliHLTUInt32_t& size,
1102 AliHLTUInt32_t& outputBlockCnt,
1103 AliHLTComponentBlockData*& outputBlocks,
1104 AliHLTComponentEventDoneData*& edd )
1106 // see header file for function documentation
1107 ALIHLTCOMPONENT_BASE_STOPWATCH();
1109 fCurrentEvent=evtData.fEventID;
1110 fCurrentEventData=evtData;
1111 fpInputBlocks=blocks;
1112 fCurrentInputBlock=-1;
1113 fSearchDataType=kAliHLTAnyDataType;
1114 fpOutputBuffer=outputPtr;
1115 fOutputBufferSize=size;
1116 fOutputBufferFilled=0;
1117 fOutputBlocks.clear();
1119 // find special events
1120 if (fpInputBlocks) {
1121 // first look for all special events and execute in the appropriate
1122 // sequence afterwords
1123 int indexComConfEvent=-1;
1124 int indexSOREvent=-1;
1125 int indexEOREvent=-1;
1126 for (unsigned int i=0; i<evtData.fBlockCnt && iResult>=0; i++) {
1127 if (fpInputBlocks[i].fDataType==kAliHLTDataTypeSOR) {
1129 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeEOR) {
1131 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeDDL) {
1133 // this event is most likely deprecated
1134 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeComConf) {
1135 indexComConfEvent=i;
1138 if (indexSOREvent>=0) {
1140 if (fpRunDesc==NULL) {
1141 fpRunDesc=new AliHLTRunDesc;
1143 if ((iResult=CopyStruct(fpRunDesc, sizeof(AliHLTRunDesc), indexSOREvent, "AliHLTRunDesc", "SOR"))>0) {
1144 HLTDebug("set run decriptor, run no %d", fpRunDesc->fRunNo);
1145 SetCDBRunNo(fpRunDesc->fRunNo);
1151 HLTWarning("already received SOR event run no %d, ignoring SOR", fpRunDesc->fRunNo);
1154 if (indexEOREvent>=0) {
1155 if (fpRunDesc!=NULL) {
1157 AliHLTRunDesc rundesc;
1158 if ((iResult=CopyStruct(&rundesc, sizeof(AliHLTRunDesc), indexEOREvent, "AliHLTRunDesc", "SOR"))>0) {
1159 if (fpRunDesc->fRunNo!=rundesc.fRunNo) {
1160 HLTWarning("run no missmatch: SOR %d, EOR %d", fpRunDesc->fRunNo, rundesc.fRunNo);
1162 HLTDebug("EOR run no %d", fpRunDesc->fRunNo);
1165 AliHLTRunDesc* pRunDesc=fpRunDesc;
1170 HLTWarning("did not receive SOR, ignoring EOR");
1173 if (indexComConfEvent>=0) {
1175 if (fpInputBlocks[indexComConfEvent].fPtr!=NULL && fpInputBlocks[indexComConfEvent].fSize>0) {
1176 cdbEntry.Append(reinterpret_cast<const char*>(fpInputBlocks[indexComConfEvent].fPtr), fpInputBlocks[indexComConfEvent].fSize);
1178 HLTDebug("received component configuration command: entry %s", cdbEntry.IsNull()?"none":cdbEntry.Data());
1179 int tmpResult=Reconfigure(cdbEntry[0]==0?NULL:cdbEntry.Data(), fChainId.c_str());
1181 HLTWarning("reconfiguration of component %p (%s) failed with error code %d", this, GetComponentID(), tmpResult);
1186 AliHLTComponentBlockDataList blockData;
1187 { // dont delete, sets the scope for the stopwatch guard
1188 ALIHLTCOMPONENT_DA_STOPWATCH();
1189 iResult=DoProcessing(evtData, blocks, trigData, outputPtr, size, blockData, edd);
1190 } // end of the scope of the stopwatch guard
1192 if (fOutputBlocks.size()>0) {
1193 //HLTDebug("got %d block(s) via high level interface", fOutputBlocks.size());
1195 // sync memory files and descriptors
1196 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
1198 while (element!=fMemFiles.end() && iResult>=0) {
1200 if ((*element)->IsClosed()==0) {
1201 HLTWarning("memory file has not been closed, force flush");
1202 iResult=CloseMemoryFile(*element);
1209 // create the descriptor list
1210 if (blockData.size()>0) {
1211 HLTError("low level and high interface must not be mixed; use PushBack methods to insert data blocks");
1214 iResult=MakeOutputDataBlockList(fOutputBlocks, &outputBlockCnt, &outputBlocks);
1215 size=fOutputBufferFilled;
1219 iResult=MakeOutputDataBlockList(blockData, &outputBlockCnt, &outputBlocks);
1222 HLTFatal("component %s (%p): can not convert output block descriptor list", GetComponentID(), this);
1229 CleanupInputObjects();
1231 IncrementEventCounter();
1236 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard()
1241 // standard constructor (not for use)
1244 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard(TStopwatch* pStopwatch)
1246 fpStopwatch(pStopwatch),
1251 // check for already existing guard
1252 if (fgpCurrent) fpPrec=fgpCurrent;
1255 // stop the preceeding guard if it controls a different stopwatch
1257 if (fpPrec && fpPrec!=this) bStart=fpPrec->Hold(fpStopwatch);
1259 // start the stopwatch if the current guard controls a different one
1260 if (fpStopwatch && bStart==1) fpStopwatch->Start(kFALSE);
1263 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard(const AliHLTStopwatchGuard&)
1269 // copy constructor not for use
1273 AliHLTComponent::AliHLTStopwatchGuard& AliHLTComponent::AliHLTStopwatchGuard::operator=(const AliHLTStopwatchGuard&)
1276 // assignment operator not for use
1283 AliHLTComponent::AliHLTStopwatchGuard* AliHLTComponent::AliHLTStopwatchGuard::fgpCurrent=NULL;
1285 AliHLTComponent::AliHLTStopwatchGuard::~AliHLTStopwatchGuard()
1289 // resume the preceeding guard if it controls a different stopwatch
1291 if (fpPrec && fpPrec!=this) bStop=fpPrec->Resume(fpStopwatch);
1293 // stop the stopwatch if the current guard controls a different one
1294 if (fpStopwatch && bStop==1) fpStopwatch->Stop();
1296 // resume to the preceeding guard
1300 int AliHLTComponent::AliHLTStopwatchGuard::Hold(TStopwatch* pSucc)
1302 // see header file for function documentation
1303 if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Stop();
1304 return fpStopwatch!=pSucc?1:0;
1307 int AliHLTComponent::AliHLTStopwatchGuard::Resume(TStopwatch* pSucc)
1309 // see header file for function documentation
1310 if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Start(kFALSE);
1311 return fpStopwatch!=pSucc?1:0;
1314 int AliHLTComponent::SetStopwatch(TObject* pSW, AliHLTStopwatchType type)
1316 // see header file for function documentation
1318 if (pSW!=NULL && type<kSWTypeCount) {
1319 if (fpStopwatches) {
1320 TObject* pObj=fpStopwatches->At((int)type);
1321 if (pSW==NULL // explicit reset
1322 || pObj==NULL) { // explicit set
1323 fpStopwatches->AddAt(pSW, (int)type);
1324 } else if (pObj!=pSW) {
1325 HLTWarning("stopwatch %d already set, reset first", (int)type);
1335 int AliHLTComponent::SetStopwatches(TObjArray* pStopwatches)
1337 // see header file for function documentation
1338 if (pStopwatches==NULL) return -EINVAL;
1341 for (int i=0 ; i<(int)kSWTypeCount && pStopwatches->GetEntries(); i++)
1342 SetStopwatch(pStopwatches->At(i), (AliHLTStopwatchType)i);
1346 AliHLTUInt32_t AliHLTComponent::GetRunNo() const
1348 // see header file for function documentation
1349 if (fpRunDesc==NULL) return 0;
1350 return fpRunDesc->fRunNo;
1353 AliHLTUInt32_t AliHLTComponent::GetRunType() const
1355 // see header file for function documentation
1356 if (fpRunDesc==NULL) return 0;
1357 return fpRunDesc->fRunType;
1360 int AliHLTComponent::CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
1361 const char* structname, const char* eventname)
1363 // see header file for function documentation
1365 if (pStruct!=NULL && iStructSize>sizeof(AliHLTUInt32_t)) {
1366 if (fpInputBlocks!=NULL && iBlockNo<fCurrentEventData.fBlockCnt) {
1367 AliHLTUInt32_t* pTgt=(AliHLTUInt32_t*)pStruct;
1368 if (fpInputBlocks[iBlockNo].fPtr && fpInputBlocks[iBlockNo].fSize) {
1369 AliHLTUInt32_t copy=*((AliHLTUInt32_t*)fpInputBlocks[iBlockNo].fPtr);
1370 if (fpInputBlocks[iBlockNo].fSize!=copy) {
1371 HLTWarning("%s event: missmatch of block size (%d) and structure size (%d)", eventname, fpInputBlocks[iBlockNo].fSize, copy);
1372 if (copy>fpInputBlocks[iBlockNo].fSize) copy=fpInputBlocks[iBlockNo].fSize;
1374 if (copy!=iStructSize) {
1375 HLTWarning("%s event: missmatch in %s version (data type version %d)", eventname, structname, ALIHLT_DATA_TYPES_VERSION);
1376 if (copy>iStructSize) {
1379 memset(pTgt, 0, iStructSize);
1382 memcpy(pTgt, fpInputBlocks[iBlockNo].fPtr, copy);
1386 HLTWarning("%s event: missing data block", eventname);
1392 HLTError("invalid struct");
1398 void AliHLTComponent::SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const
1400 // see header file for function documentation
1402 // -- Detector offset
1403 Int_t ddlIdBase = TMath::FloorNint( (Double_t) ddlId / 256.0 );
1405 // -- Word Base = 1. word of detector ( TPC has 8 words, TOF 3 )
1408 if ( ddlIdBase <= 3 )
1409 wordBase = ddlIdBase;
1410 else if ( ddlIdBase > 3 && ddlIdBase < 5 )
1411 wordBase = ddlIdBase + 7;
1413 wordBase = ddlIdBase + 9;
1415 // -- Bit index in Word
1416 Int_t bitIdx = ddlId % 32;
1419 Int_t wordIdx = wordBase;
1421 // -- if TPC (3) or TOD (5) add word idx
1422 if ( ( ddlIdBase == 3 ) || ( ddlIdBase == 5 ) ) {
1423 wordIdx += TMath::FloorNint( (Double_t) ( ddlId - ( ddlIdBase * 256 ) ) / 32.0 );
1426 // -- Set -- 'OR' word with bit mask;
1428 list.fList[wordIdx] |= ( 0x00000001 << bitIdx );
1429 // -- Unset -- 'AND' word with bit mask;
1431 list.fList[wordIdx] &= ( 0xFFFFFFFF ^ ( 0x00000001 << bitIdx ) );
1434 Int_t AliHLTComponent::GetFirstUsedDDLWord(AliHLTEventDDL &list) const
1436 // see header file for function documentation
1440 for ( Int_t wordNdx = 0 ; wordNdx < gkAliHLTDDLListSize ; wordNdx++ ) {
1442 if ( list.fList[wordNdx] != 0 && iResult == -1 ) {
1443 // check for special cases TPC and TOF
1444 if ( wordNdx > 3 && wordNdx <= 10 ) {
1448 else if ( wordNdx > 12 && wordNdx <= 14 ) {
1455 else if ( list.fList[wordNdx] != 0 && iResult >= 0 ) {
1456 HLTError( "DDLIDs for minimum of TWO detectors ( %d, %d ) set, this function works only for ONE detector.", iResult, wordNdx );