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 fCDBSetRunNoFunc(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, AliHLTComponentHandler* pHandler)
208 // see header file for function documentation
210 if (cdbPath, pHandler) {
211 // I have to think about separating the library handling from the
212 // component handler. Requiring the component hanlder here is not
213 // the cleanest solution.
214 // We presume the library already to be loaded
216 AliHLTMiscInitCDB_t pFunc=(AliHLTMiscInitCDB_t)pHandler->FindSymbol(ALIHLTMISC_LIBRARY, ALIHLTMISC_INIT_CDB);
218 if ((iResult=(*pFunc)(cdbPath))>=0) {
219 if (!(fCDBSetRunNoFunc=pHandler->FindSymbol(ALIHLTMISC_LIBRARY, ALIHLTMISC_SET_CDB_RUNNO))) {
220 Message(NULL, kHLTLogWarning, "AliHLTComponent::InitCDB", "init CDB",
221 "can not find function to set CDB run no");
225 Message(NULL, kHLTLogError, "AliHLTComponent::InitCDB", "init CDB",
226 "can not find initialization function");
235 int AliHLTComponent::SetCDBRunNo(int runNo)
237 // see header file for function documentation
238 if (!fCDBSetRunNoFunc) return 0;
239 return (*((AliHLTMiscSetCDBRunNo_t)fCDBSetRunNoFunc))(runNo);
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 // default implementation, childs can overload
263 HLTLogKeyword("dummy");
267 void AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2] ) const
269 // see header file for function documentation
270 memset( output, 0, kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2 );
271 strncat( output, type.fOrigin, kAliHLTComponentDataTypefOriginSize );
272 strcat( output, ":" );
273 strncat( output, type.fID, kAliHLTComponentDataTypefIDsize );
276 string AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, int mode)
278 // see header file for function documentation
284 for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
285 sprintf(tmp, "'%d", type.fOrigin[i]);
289 for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
290 sprintf(tmp, "%d'", type.fID[i]);
299 for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
300 unsigned char* puc=(unsigned char*)type.fOrigin;
302 sprintf(tmp, "'\\%x", type.fOrigin[i]);
304 sprintf(tmp, "'%c", type.fOrigin[i]);
308 for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
309 unsigned char* puc=(unsigned char*)type.fID;
311 sprintf(tmp, "\\%x'", type.fID[i]);
313 sprintf(tmp, "%c'", type.fID[i]);
319 if (type==kAliHLTVoidDataType) {
322 // some gymnastics in order to avoid a '0' which is part of either or both
323 // ID and origin terminating the whole string. Unfortunately, string doesn't
324 // stop appending at the '0' if the number of elements to append was
325 // explicitely specified
327 tmp.append(type.fOrigin, kAliHLTComponentDataTypefOriginSize);
328 out.append(tmp.c_str());
331 tmp.append(type.fID, kAliHLTComponentDataTypefIDsize);
332 out.append(tmp.c_str());
338 void* AliHLTComponent::AllocMemory( unsigned long size )
340 // see header file for function documentation
341 if (fEnvironment.fAllocMemoryFunc)
342 return (*fEnvironment.fAllocMemoryFunc)(fEnvironment.fParam, size );
343 HLTFatal("no memory allocation handler registered");
347 int AliHLTComponent::MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount,
348 AliHLTComponentBlockData** outputBlocks )
350 // see header file for function documentation
351 if ( blockCount==NULL || outputBlocks==NULL )
353 AliHLTUInt32_t count = blocks.size();
357 *outputBlocks = NULL;
360 *outputBlocks = reinterpret_cast<AliHLTComponentBlockData*>( AllocMemory( sizeof(AliHLTComponentBlockData)*count ) );
361 if ( !*outputBlocks )
363 for ( unsigned long i = 0; i < count; i++ ) {
364 (*outputBlocks)[i] = blocks[i];
365 if (blocks[i].fDataType==kAliHLTAnyDataType) {
366 (*outputBlocks)[i].fDataType=GetOutputDataType();
367 /* data type was set to the output data type by the PubSub AliRoot
368 Wrapper component, if data type of the block was ********:****.
369 Now handled by the component base class in order to have same
370 behavior when running embedded in AliRoot
371 memset((*outputBlocks)[i].fDataType.fID, '*', kAliHLTComponentDataTypefIDsize);
372 memset((*outputBlocks)[i].fDataType.fOrigin, '*', kAliHLTComponentDataTypefOriginSize);
381 int AliHLTComponent::GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd )
383 // see header file for function documentation
384 if (fEnvironment.fGetEventDoneDataFunc)
385 return (*fEnvironment.fGetEventDoneDataFunc)(fEnvironment.fParam, fCurrentEvent, size, edd );
389 int AliHLTComponent::FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList)
391 // see header file for function documentation
394 AliHLTComponentDataTypeList itypes;
395 AliHLTComponentDataTypeList otypes;
396 otypes.push_back(GetOutputDataType());
397 if (otypes[0]==kAliHLTMultipleDataType) {
400 if ((count=GetOutputDataTypes(otypes))>0) {
401 } else if (GetComponentType()!=kSink) {
402 HLTWarning("component %s indicates multiple output data types but GetOutputDataTypes returns %d", GetComponentID(), count);
405 ((AliHLTComponent*)pConsumer)->GetInputDataTypes(itypes);
406 AliHLTComponentDataTypeList::iterator itype=itypes.begin();
407 while (itype!=itypes.end()) {
408 //PrintDataTypeContent((*itype), "consumer \'%s\'");
409 AliHLTComponentDataTypeList::iterator otype=otypes.begin();
410 while (otype!=otypes.end() && (*itype)!=(*otype)) otype++;
411 //if (otype!=otypes.end()) PrintDataTypeContent(*otype, "publisher \'%s\'");
412 if (otype!=otypes.end() ||
413 (*itype)==kAliHLTAnyDataType) {
414 if (tgtList) tgtList->push_back(*itype);
425 void AliHLTComponent::PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format) const
427 // see header file for function documentation
428 const char* fmt="publisher \'%s\'";
429 if (format) fmt=format;
430 HLTMessage(fmt, (DataType2Text(dt)).c_str());
431 HLTMessage("%x %x %x %x %x %x %x %x : %x %x %x %x",
446 void AliHLTComponent::FillBlockData( AliHLTComponentBlockData& blockData )
448 // see header file for function documentation
449 blockData.fStructSize = sizeof(blockData);
450 FillShmData( blockData.fShmKey );
451 blockData.fOffset = ~(AliHLTUInt32_t)0;
452 blockData.fPtr = NULL;
454 FillDataType( blockData.fDataType );
455 blockData.fSpecification = kAliHLTVoidDataSpec;
458 void AliHLTComponent::FillShmData( AliHLTComponentShmData& shmData )
460 // see header file for function documentation
461 shmData.fStructSize = sizeof(shmData);
462 shmData.fShmType = gkAliHLTComponentInvalidShmType;
463 shmData.fShmID = gkAliHLTComponentInvalidShmID;
466 void AliHLTComponent::FillDataType( AliHLTComponentDataType& dataType )
468 // see header file for function documentation
469 dataType=kAliHLTAnyDataType;
472 void AliHLTComponent::CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt)
474 // see header file for function documentation
475 memcpy(&tgtdt.fID[0], &srcdt.fID[0], kAliHLTComponentDataTypefIDsize);
476 memcpy(&tgtdt.fOrigin[0], &srcdt.fOrigin[0], kAliHLTComponentDataTypefOriginSize);
479 void AliHLTComponent::SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin)
481 // see header file for function documentation
482 tgtdt.fStructSize=sizeof(AliHLTComponentDataType);
484 memset(&tgtdt.fID[0], 0, kAliHLTComponentDataTypefIDsize);
485 strncpy(&tgtdt.fID[0], id, strlen(id)<(size_t)kAliHLTComponentDataTypefIDsize?strlen(id):kAliHLTComponentDataTypefIDsize);
488 memset(&tgtdt.fOrigin[0], 0, kAliHLTComponentDataTypefOriginSize);
489 strncpy(&tgtdt.fOrigin[0], origin, strlen(origin)<(size_t)kAliHLTComponentDataTypefOriginSize?strlen(origin):kAliHLTComponentDataTypefOriginSize);
493 void AliHLTComponent::FillEventData(AliHLTComponentEventData& evtData)
495 // see header file for function documentation
496 memset(&evtData, 0, sizeof(AliHLTComponentEventData));
497 evtData.fStructSize=sizeof(AliHLTComponentEventData);
500 void AliHLTComponent::PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt)
502 // see header file for function documentation
504 msg.Form("AliHLTComponentDataType(%d): ID=\"", dt.fStructSize);
505 for ( int i = 0; i < kAliHLTComponentDataTypefIDsize; i++ ) {
506 if (dt.fID[i]!=0) msg+=dt.fID[i];
510 for ( int i = 0; i < kAliHLTComponentDataTypefOriginSize; i++ ) {
511 if (dt.fOrigin[i]!=0) msg+=dt.fOrigin[i];
515 AliHLTLogging::Message(NULL, kHLTLogNone, NULL , NULL, msg.Data());
518 int AliHLTComponent::GetEventCount() const
520 // see header file for function documentation
524 int AliHLTComponent::IncrementEventCounter()
526 // see header file for function documentation
527 if (fEventCount>=0) fEventCount++;
531 int AliHLTComponent::GetNumberOfInputBlocks() const
533 // see header file for function documentation
534 if (fpInputBlocks!=NULL) {
535 return fCurrentEventData.fBlockCnt;
540 const TObject* AliHLTComponent::GetFirstInputObject(const AliHLTComponentDataType& dt,
541 const char* classname,
544 // see header file for function documentation
545 ALIHLTCOMPONENT_BASE_STOPWATCH();
547 if (classname) fClassName=classname;
548 else fClassName.clear();
549 int idx=FindInputBlock(fSearchDataType, 0, 1);
552 HLTDebug("found block %d when searching for data type %s", idx, DataType2Text(dt).c_str());
553 if ((pObj=GetInputObject(idx, fClassName.c_str(), bForce))!=NULL) {
554 fCurrentInputBlock=idx;
561 const TObject* AliHLTComponent::GetFirstInputObject(const char* dtID,
562 const char* dtOrigin,
563 const char* classname,
566 // see header file for function documentation
567 ALIHLTCOMPONENT_BASE_STOPWATCH();
568 AliHLTComponentDataType dt;
569 SetDataType(dt, dtID, dtOrigin);
570 return GetFirstInputObject(dt, classname, bForce);
573 const TObject* AliHLTComponent::GetNextInputObject(int bForce)
575 // see header file for function documentation
576 ALIHLTCOMPONENT_BASE_STOPWATCH();
577 int idx=FindInputBlock(fSearchDataType, fCurrentInputBlock+1, 1);
578 //HLTDebug("found block %d when searching for data type %s", idx, DataType2Text(fSearchDataType).c_str());
581 if ((pObj=GetInputObject(idx, fClassName.c_str(), bForce))!=NULL) {
582 fCurrentInputBlock=idx;
588 int AliHLTComponent::FindInputBlock(const AliHLTComponentDataType& dt, int startIdx, int bObject) const
590 // see header file for function documentation
592 if (fpInputBlocks!=NULL) {
593 int idx=startIdx<0?0:startIdx;
594 for ( ; (UInt_t)idx<fCurrentEventData.fBlockCnt && iResult==-ENOENT; idx++) {
596 if (fpInputBlocks[idx].fPtr==NULL) continue;
597 AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)fpInputBlocks[idx].fPtr);
598 if (firstWord!=fpInputBlocks[idx].fSize-sizeof(AliHLTUInt32_t)) continue;
600 if (dt == kAliHLTAnyDataType || fpInputBlocks[idx].fDataType == dt ||
601 (memcmp(dt.fID, kAliHLTAnyDataTypeID, kAliHLTComponentDataTypefIDsize)==0 &&
602 memcmp(dt.fOrigin, fpInputBlocks[idx].fDataType.fOrigin, kAliHLTComponentDataTypefOriginSize)==0) ||
603 (memcmp(dt.fID, fpInputBlocks[idx].fDataType.fID, kAliHLTComponentDataTypefIDsize)==0) &&
604 memcmp(dt.fOrigin, kAliHLTDataOriginAny, kAliHLTComponentDataTypefOriginSize)==0) {
612 TObject* AliHLTComponent::CreateInputObject(int idx, int bForce)
614 // see header file for function documentation
616 if (fpInputBlocks!=NULL) {
617 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
618 if (fpInputBlocks[idx].fPtr) {
619 AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)fpInputBlocks[idx].fPtr);
620 if (firstWord==fpInputBlocks[idx].fSize-sizeof(AliHLTUInt32_t)) {
621 HLTDebug("create object from block %d size %d", idx, fpInputBlocks[idx].fSize);
622 AliHLTMessage msg(fpInputBlocks[idx].fPtr, fpInputBlocks[idx].fSize);
623 TClass* objclass=msg.GetClass();
624 pObj=msg.ReadObject(objclass);
625 if (pObj && objclass) {
626 HLTDebug("object %p type %s created", pObj, objclass->GetName());
630 } else if (bForce!=0) {
631 HLTError("size missmatch: block size %d, indicated %d", fpInputBlocks[idx].fSize, firstWord+sizeof(AliHLTUInt32_t));
634 HLTFatal("block descriptor empty");
637 HLTError("index %d out of range %d", idx, fCurrentEventData.fBlockCnt);
640 HLTError("no input blocks available");
646 TObject* AliHLTComponent::GetInputObject(int idx, const char* /*classname*/, int bForce)
648 // see header file for function documentation
649 if (fpInputObjects==NULL) {
650 fpInputObjects=new TObjArray(fCurrentEventData.fBlockCnt);
653 if (fpInputObjects) {
654 pObj=fpInputObjects->At(idx);
656 pObj=CreateInputObject(idx, bForce);
658 fpInputObjects->AddAt(pObj, idx);
662 HLTFatal("memory allocation failed: TObjArray of size %d", fCurrentEventData.fBlockCnt);
667 int AliHLTComponent::CleanupInputObjects()
669 // see header file for function documentation
670 if (!fpInputObjects) return 0;
671 TObjArray* array=fpInputObjects;
673 for (int i=0; i<array->GetEntries(); i++) {
674 TObject* pObj=array->At(i);
675 // grrr, garbage collection strikes back: When read via AliHLTMessage
676 // (CreateInputObject), and written to a TFile afterwards, the
677 // TFile::Close calls ROOOT's garbage collection. No clue why the
678 // object ended up in the key list and needs to be deleted
679 if (pObj && gObjectTable->PtrIsValid(pObj)) delete pObj;
685 AliHLTComponentDataType AliHLTComponent::GetDataType(const TObject* pObject)
687 // see header file for function documentation
688 ALIHLTCOMPONENT_BASE_STOPWATCH();
689 AliHLTComponentDataType dt=kAliHLTVoidDataType;
690 int idx=fCurrentInputBlock;
692 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
694 HLTError("unknown object %p", pObject);
698 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
699 dt=fpInputBlocks[idx].fDataType;
701 HLTFatal("severe internal error, index out of range");
707 AliHLTUInt32_t AliHLTComponent::GetSpecification(const TObject* pObject)
709 // see header file for function documentation
710 ALIHLTCOMPONENT_BASE_STOPWATCH();
711 AliHLTUInt32_t iSpec=kAliHLTVoidDataSpec;
712 int idx=fCurrentInputBlock;
714 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
716 HLTError("unknown object %p", pObject);
720 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
721 iSpec=fpInputBlocks[idx].fSpecification;
723 HLTFatal("severe internal error, index out of range");
729 int AliHLTComponent::Forward(const TObject* pObject)
731 // see header file for function documentation
733 int idx=fCurrentInputBlock;
735 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
737 HLTError("unknown object %p", pObject);
742 fOutputBlocks.push_back(fpInputBlocks[idx]);
747 int AliHLTComponent::Forward(const AliHLTComponentBlockData* pBlock)
749 // see header file for function documentation
751 int idx=fCurrentInputBlock;
753 if (fpInputObjects==NULL || (idx=FindInputBlock(pBlock))>=0) {
755 HLTError("unknown Block %p", pBlock);
760 // check for fpInputBlocks pointer done in FindInputBlock
761 fOutputBlocks.push_back(fpInputBlocks[idx]);
766 const AliHLTComponentBlockData* AliHLTComponent::GetFirstInputBlock(const AliHLTComponentDataType& dt)
768 // see header file for function documentation
769 ALIHLTCOMPONENT_BASE_STOPWATCH();
772 int idx=FindInputBlock(fSearchDataType, 0);
773 const AliHLTComponentBlockData* pBlock=NULL;
775 // check for fpInputBlocks pointer done in FindInputBlock
776 pBlock=&fpInputBlocks[idx];
777 fCurrentInputBlock=idx;
782 const AliHLTComponentBlockData* AliHLTComponent::GetFirstInputBlock(const char* dtID,
783 const char* dtOrigin)
785 // see header file for function documentation
786 ALIHLTCOMPONENT_BASE_STOPWATCH();
787 AliHLTComponentDataType dt;
788 SetDataType(dt, dtID, dtOrigin);
789 return GetFirstInputBlock(dt);
792 const AliHLTComponentBlockData* AliHLTComponent::GetInputBlock(int index)
794 // see header file for function documentation
795 ALIHLTCOMPONENT_BASE_STOPWATCH();
796 assert( 0 <= index and index < fCurrentEventData.fBlockCnt );
797 return &fpInputBlocks[index];
800 const AliHLTComponentBlockData* AliHLTComponent::GetNextInputBlock()
802 // see header file for function documentation
803 ALIHLTCOMPONENT_BASE_STOPWATCH();
804 int idx=FindInputBlock(fSearchDataType, fCurrentInputBlock+1);
805 const AliHLTComponentBlockData* pBlock=NULL;
807 // check for fpInputBlocks pointer done in FindInputBlock
808 pBlock=&fpInputBlocks[idx];
809 fCurrentInputBlock=idx;
814 int AliHLTComponent::FindInputBlock(const AliHLTComponentBlockData* pBlock) const
816 // see header file for function documentation
818 if (fpInputBlocks!=NULL) {
820 if (pBlock>=fpInputBlocks && pBlock<fpInputBlocks+fCurrentEventData.fBlockCnt) {
821 iResult=(int)(pBlock-fpInputBlocks);
830 AliHLTUInt32_t AliHLTComponent::GetSpecification(const AliHLTComponentBlockData* pBlock)
832 // see header file for function documentation
833 ALIHLTCOMPONENT_BASE_STOPWATCH();
834 AliHLTUInt32_t iSpec=kAliHLTVoidDataSpec;
835 int idx=fCurrentInputBlock;
837 if (fpInputObjects==NULL || (idx=FindInputBlock(pBlock))>=0) {
839 HLTError("unknown Block %p", pBlock);
843 // check for fpInputBlocks pointer done in FindInputBlock
844 iSpec=fpInputBlocks[idx].fSpecification;
849 int AliHLTComponent::PushBack(TObject* pObject, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
850 void* pHeader, int headerSize)
852 // see header file for function documentation
853 ALIHLTCOMPONENT_BASE_STOPWATCH();
856 AliHLTMessage msg(kMESS_OBJECT);
857 msg.WriteObject(pObject);
858 Int_t iMsgLength=msg.Length();
860 msg.SetLength(); // sets the length to the first (reserved) word
861 iResult=InsertOutputBlock(msg.Buffer(), iMsgLength, dt, spec, pHeader, headerSize);
863 HLTDebug("object %s (%p) size %d inserted to output", pObject->ClassName(), pObject, iMsgLength);
866 HLTError("object serialization failed for object %p", pObject);
875 int AliHLTComponent::PushBack(TObject* pObject, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec,
876 void* pHeader, int headerSize)
878 // see header file for function documentation
879 ALIHLTCOMPONENT_BASE_STOPWATCH();
880 AliHLTComponentDataType dt;
881 SetDataType(dt, dtID, dtOrigin);
882 return PushBack(pObject, dt, spec, pHeader, headerSize);
885 int AliHLTComponent::PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
886 void* pHeader, int headerSize)
888 // see header file for function documentation
889 ALIHLTCOMPONENT_BASE_STOPWATCH();
890 return InsertOutputBlock(pBuffer, iSize, dt, spec, pHeader, headerSize);
893 int AliHLTComponent::PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec,
894 void* pHeader, int headerSize)
896 // see header file for function documentation
897 ALIHLTCOMPONENT_BASE_STOPWATCH();
898 AliHLTComponentDataType dt;
899 SetDataType(dt, dtID, dtOrigin);
900 return PushBack(pBuffer, iSize, dt, spec, pHeader, headerSize);
903 int AliHLTComponent::InsertOutputBlock(void* pBuffer, int iBufferSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
904 void* pHeader, int iHeaderSize)
906 // see header file for function documentation
908 int iBlkSize = iBufferSize + iHeaderSize;
910 if (fpOutputBuffer && iBlkSize<=(int)(fOutputBufferSize-fOutputBufferFilled)) {
911 AliHLTUInt8_t* pTgt=fpOutputBuffer+fOutputBufferFilled;
912 AliHLTComponentBlockData bd;
914 bd.fOffset = fOutputBufferFilled;
917 bd.fSpecification = spec;
918 if (pHeader!=NULL && pHeader!=pTgt) {
919 memcpy(pTgt, pHeader, iHeaderSize);
922 pTgt += (AliHLTUInt8_t) iHeaderSize;
924 if (pBuffer!=NULL && pBuffer!=pTgt) {
925 memcpy(pTgt, pBuffer, iBufferSize);
927 //AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)pBuffer);
928 //HLTDebug("copy %d bytes from %p to output buffer %p, first word %#x", iBufferSize, pBuffer, pTgt, firstWord);
930 fOutputBufferFilled+=bd.fSize;
931 fOutputBlocks.push_back( bd );
932 //HLTDebug("buffer inserted to output: size %d data type %s spec %#x", iBlkSize, DataType2Text(dt).c_str(), spec);
934 if (fpOutputBuffer) {
935 HLTError("too little space in output buffer: %d, required %d", fOutputBufferSize-fOutputBufferFilled, iBlkSize);
937 HLTError("output buffer not available");
947 int AliHLTComponent::EstimateObjectSize(TObject* pObject) const
949 // see header file for function documentation
950 if (!pObject) return -EINVAL;
951 AliHLTMessage msg(kMESS_OBJECT);
952 msg.WriteObject(pObject);
956 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity, const char* dtID,
957 const char* dtOrigin,
960 // see header file for function documentation
961 ALIHLTCOMPONENT_BASE_STOPWATCH();
962 AliHLTComponentDataType dt;
963 SetDataType(dt, dtID, dtOrigin);
964 return CreateMemoryFile(capacity, dt, spec);
967 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity,
968 const AliHLTComponentDataType& dt,
971 // see header file for function documentation
972 ALIHLTCOMPONENT_BASE_STOPWATCH();
973 AliHLTMemoryFile* pFile=NULL;
974 if (capacity>=0 && static_cast<unsigned int>(capacity)<=fOutputBufferSize-fOutputBufferFilled){
975 AliHLTUInt8_t* pTgt=fpOutputBuffer+fOutputBufferFilled;
976 pFile=new AliHLTMemoryFile((char*)pTgt, capacity);
978 unsigned int nofBlocks=fOutputBlocks.size();
979 if (nofBlocks+1>fMemFiles.size()) {
980 fMemFiles.resize(nofBlocks+1, NULL);
982 if (nofBlocks<fMemFiles.size()) {
983 fMemFiles[nofBlocks]=pFile;
984 AliHLTComponentBlockData bd;
986 bd.fOffset = fOutputBufferFilled;
989 bd.fSpecification = spec;
990 fOutputBufferFilled+=bd.fSize;
991 fOutputBlocks.push_back( bd );
993 HLTError("can not allocate/grow object array");
994 pFile->CloseMemoryFile(0);
1000 HLTError("can not create memory file of size %d (%d available)", capacity, fOutputBufferSize-fOutputBufferFilled);
1005 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(const char* dtID,
1006 const char* dtOrigin,
1007 AliHLTUInt32_t spec,
1010 // see header file for function documentation
1011 ALIHLTCOMPONENT_BASE_STOPWATCH();
1012 AliHLTComponentDataType dt;
1013 SetDataType(dt, dtID, dtOrigin);
1014 int size=fOutputBufferSize-fOutputBufferFilled;
1015 if (capacity<0 || capacity>1.0) {
1016 HLTError("invalid parameter: capacity %f", capacity);
1019 size=(int)(size*capacity);
1020 return CreateMemoryFile(size, dt, spec);
1023 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(const AliHLTComponentDataType& dt,
1024 AliHLTUInt32_t spec,
1027 // see header file for function documentation
1028 ALIHLTCOMPONENT_BASE_STOPWATCH();
1029 int size=fOutputBufferSize-fOutputBufferFilled;
1030 if (capacity<0 || capacity>1.0) {
1031 HLTError("invalid parameter: capacity %f", capacity);
1034 size=(int)(size*capacity);
1035 return CreateMemoryFile(size, dt, spec);
1038 int AliHLTComponent::Write(AliHLTMemoryFile* pFile, const TObject* pObject,
1039 const char* key, int option)
1041 // see header file for function documentation
1043 if (pFile && pObject) {
1045 iResult=pObject->Write(key, option);
1049 iResult=-pFile->GetErrno();
1050 if (iResult==-ENOSPC) {
1051 HLTError("error writing memory file, buffer too small");
1060 int AliHLTComponent::CloseMemoryFile(AliHLTMemoryFile* pFile)
1062 // see header file for function documentation
1065 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
1067 while (element!=fMemFiles.end() && iResult>=0) {
1068 if (*element && *element==pFile) {
1069 iResult=pFile->CloseMemoryFile();
1071 // sync memory files and descriptors
1073 fOutputBlocks[i].fSize=(*element)->GetSize()+(*element)->GetHeaderSize();
1081 HLTError("can not find memory file %p", pFile);
1089 int AliHLTComponent::CreateEventDoneData(AliHLTComponentEventDoneData /*edd*/)
1091 // see header file for function documentation
1092 int iResult=-ENOSYS;
1093 //#warning function not yet implemented
1094 HLTWarning("function not yet implemented");
1098 int AliHLTComponent::ProcessEvent( const AliHLTComponentEventData& evtData,
1099 const AliHLTComponentBlockData* blocks,
1100 AliHLTComponentTriggerData& trigData,
1101 AliHLTUInt8_t* outputPtr,
1102 AliHLTUInt32_t& size,
1103 AliHLTUInt32_t& outputBlockCnt,
1104 AliHLTComponentBlockData*& outputBlocks,
1105 AliHLTComponentEventDoneData*& edd )
1107 // see header file for function documentation
1108 ALIHLTCOMPONENT_BASE_STOPWATCH();
1110 fCurrentEvent=evtData.fEventID;
1111 fCurrentEventData=evtData;
1112 fpInputBlocks=blocks;
1113 fCurrentInputBlock=-1;
1114 fSearchDataType=kAliHLTAnyDataType;
1115 fpOutputBuffer=outputPtr;
1116 fOutputBufferSize=size;
1117 fOutputBufferFilled=0;
1118 fOutputBlocks.clear();
1120 // find special events
1121 if (fpInputBlocks) {
1122 // first look for all special events and execute in the appropriate
1123 // sequence afterwords
1124 int indexComConfEvent=-1;
1125 int indexSOREvent=-1;
1126 int indexEOREvent=-1;
1127 for (unsigned int i=0; i<evtData.fBlockCnt && iResult>=0; i++) {
1128 if (fpInputBlocks[i].fDataType==kAliHLTDataTypeSOR) {
1130 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeEOR) {
1132 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeDDL) {
1134 // this event is most likely deprecated
1135 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeComConf) {
1136 indexComConfEvent=i;
1139 if (indexSOREvent>=0) {
1141 if (fpRunDesc==NULL) {
1142 fpRunDesc=new AliHLTRunDesc;
1144 if ((iResult=CopyStruct(fpRunDesc, sizeof(AliHLTRunDesc), indexSOREvent, "AliHLTRunDesc", "SOR"))>0) {
1145 HLTDebug("set run decriptor, run no %d", fpRunDesc->fRunNo);
1146 SetCDBRunNo(fpRunDesc->fRunNo);
1152 HLTWarning("already received SOR event run no %d, ignoring SOR", fpRunDesc->fRunNo);
1155 if (indexEOREvent>=0) {
1156 if (fpRunDesc!=NULL) {
1158 AliHLTRunDesc rundesc;
1159 if ((iResult=CopyStruct(&rundesc, sizeof(AliHLTRunDesc), indexEOREvent, "AliHLTRunDesc", "SOR"))>0) {
1160 if (fpRunDesc->fRunNo!=rundesc.fRunNo) {
1161 HLTWarning("run no missmatch: SOR %d, EOR %d", fpRunDesc->fRunNo, rundesc.fRunNo);
1163 HLTDebug("EOR run no %d", fpRunDesc->fRunNo);
1166 AliHLTRunDesc* pRunDesc=fpRunDesc;
1171 HLTWarning("did not receive SOR, ignoring EOR");
1174 if (indexComConfEvent>=0) {
1176 if (fpInputBlocks[indexComConfEvent].fPtr!=NULL && fpInputBlocks[indexComConfEvent].fSize>0) {
1177 cdbEntry.Append(reinterpret_cast<const char*>(fpInputBlocks[indexComConfEvent].fPtr), fpInputBlocks[indexComConfEvent].fSize);
1179 HLTDebug("received component configuration command: entry %s", cdbEntry.IsNull()?"none":cdbEntry.Data());
1180 int tmpResult=Reconfigure(cdbEntry[0]==0?NULL:cdbEntry.Data(), fChainId.c_str());
1182 HLTWarning("reconfiguration of component %p (%s) failed with error code %d", this, GetComponentID(), tmpResult);
1187 AliHLTComponentBlockDataList blockData;
1188 { // dont delete, sets the scope for the stopwatch guard
1189 ALIHLTCOMPONENT_DA_STOPWATCH();
1190 iResult=DoProcessing(evtData, blocks, trigData, outputPtr, size, blockData, edd);
1191 } // end of the scope of the stopwatch guard
1193 if (fOutputBlocks.size()>0) {
1194 //HLTDebug("got %d block(s) via high level interface", fOutputBlocks.size());
1196 // sync memory files and descriptors
1197 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
1199 while (element!=fMemFiles.end() && iResult>=0) {
1201 if ((*element)->IsClosed()==0) {
1202 HLTWarning("memory file has not been closed, force flush");
1203 iResult=CloseMemoryFile(*element);
1210 // create the descriptor list
1211 if (blockData.size()>0) {
1212 HLTError("low level and high interface must not be mixed; use PushBack methods to insert data blocks");
1215 iResult=MakeOutputDataBlockList(fOutputBlocks, &outputBlockCnt, &outputBlocks);
1216 size=fOutputBufferFilled;
1220 iResult=MakeOutputDataBlockList(blockData, &outputBlockCnt, &outputBlocks);
1223 HLTFatal("component %s (%p): can not convert output block descriptor list", GetComponentID(), this);
1230 CleanupInputObjects();
1232 IncrementEventCounter();
1237 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard()
1242 // standard constructor (not for use)
1245 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard(TStopwatch* pStopwatch)
1247 fpStopwatch(pStopwatch),
1252 // check for already existing guard
1253 if (fgpCurrent) fpPrec=fgpCurrent;
1256 // stop the preceeding guard if it controls a different stopwatch
1258 if (fpPrec && fpPrec!=this) bStart=fpPrec->Hold(fpStopwatch);
1260 // start the stopwatch if the current guard controls a different one
1261 if (fpStopwatch && bStart==1) fpStopwatch->Start(kFALSE);
1264 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard(const AliHLTStopwatchGuard&)
1270 // copy constructor not for use
1274 AliHLTComponent::AliHLTStopwatchGuard& AliHLTComponent::AliHLTStopwatchGuard::operator=(const AliHLTStopwatchGuard&)
1277 // assignment operator not for use
1284 AliHLTComponent::AliHLTStopwatchGuard* AliHLTComponent::AliHLTStopwatchGuard::fgpCurrent=NULL;
1286 AliHLTComponent::AliHLTStopwatchGuard::~AliHLTStopwatchGuard()
1290 // resume the preceeding guard if it controls a different stopwatch
1292 if (fpPrec && fpPrec!=this) bStop=fpPrec->Resume(fpStopwatch);
1294 // stop the stopwatch if the current guard controls a different one
1295 if (fpStopwatch && bStop==1) fpStopwatch->Stop();
1297 // resume to the preceeding guard
1301 int AliHLTComponent::AliHLTStopwatchGuard::Hold(TStopwatch* pSucc)
1303 // see header file for function documentation
1304 if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Stop();
1305 return fpStopwatch!=pSucc?1:0;
1308 int AliHLTComponent::AliHLTStopwatchGuard::Resume(TStopwatch* pSucc)
1310 // see header file for function documentation
1311 if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Start(kFALSE);
1312 return fpStopwatch!=pSucc?1:0;
1315 int AliHLTComponent::SetStopwatch(TObject* pSW, AliHLTStopwatchType type)
1317 // see header file for function documentation
1319 if (pSW!=NULL && type<kSWTypeCount) {
1320 if (fpStopwatches) {
1321 TObject* pObj=fpStopwatches->At((int)type);
1322 if (pSW==NULL // explicit reset
1323 || pObj==NULL) { // explicit set
1324 fpStopwatches->AddAt(pSW, (int)type);
1325 } else if (pObj!=pSW) {
1326 HLTWarning("stopwatch %d already set, reset first", (int)type);
1336 int AliHLTComponent::SetStopwatches(TObjArray* pStopwatches)
1338 // see header file for function documentation
1339 if (pStopwatches==NULL) return -EINVAL;
1342 for (int i=0 ; i<(int)kSWTypeCount && pStopwatches->GetEntries(); i++)
1343 SetStopwatch(pStopwatches->At(i), (AliHLTStopwatchType)i);
1347 AliHLTUInt32_t AliHLTComponent::GetRunNo() const
1349 // see header file for function documentation
1350 if (fpRunDesc==NULL) return 0;
1351 return fpRunDesc->fRunNo;
1354 AliHLTUInt32_t AliHLTComponent::GetRunType() const
1356 // see header file for function documentation
1357 if (fpRunDesc==NULL) return 0;
1358 return fpRunDesc->fRunType;
1361 int AliHLTComponent::CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
1362 const char* structname, const char* eventname)
1364 // see header file for function documentation
1366 if (pStruct!=NULL && iStructSize>sizeof(AliHLTUInt32_t)) {
1367 if (fpInputBlocks!=NULL && iBlockNo<fCurrentEventData.fBlockCnt) {
1368 AliHLTUInt32_t* pTgt=(AliHLTUInt32_t*)pStruct;
1369 if (fpInputBlocks[iBlockNo].fPtr && fpInputBlocks[iBlockNo].fSize) {
1370 AliHLTUInt32_t copy=*((AliHLTUInt32_t*)fpInputBlocks[iBlockNo].fPtr);
1371 if (fpInputBlocks[iBlockNo].fSize!=copy) {
1372 HLTWarning("%s event: missmatch of block size (%d) and structure size (%d)", eventname, fpInputBlocks[iBlockNo].fSize, copy);
1373 if (copy>fpInputBlocks[iBlockNo].fSize) copy=fpInputBlocks[iBlockNo].fSize;
1375 if (copy!=iStructSize) {
1376 HLTWarning("%s event: missmatch in %s version (data type version %d)", eventname, structname, ALIHLT_DATA_TYPES_VERSION);
1377 if (copy>iStructSize) {
1380 memset(pTgt, 0, iStructSize);
1383 memcpy(pTgt, fpInputBlocks[iBlockNo].fPtr, copy);
1387 HLTWarning("%s event: missing data block", eventname);
1393 HLTError("invalid struct");
1399 void AliHLTComponent::SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const
1401 // see header file for function documentation
1403 // -- Detector offset
1404 Int_t ddlIdBase = TMath::FloorNint( (Double_t) ddlId / 256.0 );
1406 // -- Word Base = 1. word of detector ( TPC has 8 words, TOF 3 )
1409 if ( ddlIdBase <= 3 )
1410 wordBase = ddlIdBase;
1411 else if ( ddlIdBase > 3 && ddlIdBase < 5 )
1412 wordBase = ddlIdBase + 7;
1414 wordBase = ddlIdBase + 9;
1416 // -- Bit index in Word
1417 Int_t bitIdx = ddlId % 32;
1420 Int_t wordIdx = wordBase;
1422 // -- if TPC (3) or TOD (5) add word idx
1423 if ( ( ddlIdBase == 3 ) || ( ddlIdBase == 5 ) ) {
1424 wordIdx += TMath::FloorNint( (Double_t) ( ddlId - ( ddlIdBase * 256 ) ) / 32.0 );
1427 // -- Set -- 'OR' word with bit mask;
1429 list.fList[wordIdx] |= ( 0x00000001 << bitIdx );
1430 // -- Unset -- 'AND' word with bit mask;
1432 list.fList[wordIdx] &= ( 0xFFFFFFFF ^ ( 0x00000001 << bitIdx ) );
1435 Int_t AliHLTComponent::GetFirstUsedDDLWord(AliHLTEventDDL &list) const
1437 // see header file for function documentation
1441 for ( Int_t wordNdx = 0 ; wordNdx < gkAliHLTDDLListSize ; wordNdx++ ) {
1443 if ( list.fList[wordNdx] != 0 && iResult == -1 ) {
1444 // check for special cases TPC and TOF
1445 if ( wordNdx > 3 && wordNdx <= 10 ) {
1449 else if ( wordNdx > 12 && wordNdx <= 14 ) {
1456 else if ( list.fList[wordNdx] != 0 && iResult >= 0 ) {
1457 HLTError( "DDLIDs for minimum of TWO detectors ( %d, %d ) set, this function works only for ONE detector.", iResult, wordNdx );