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"
40 #include "TObjArray.h"
41 #include "TObjectTable.h"
43 #include "TStopwatch.h"
44 #include "AliHLTMemoryFile.h"
47 /** ROOT macro for the implementation of ROOT specific class methods */
48 ClassImp(AliHLTComponent);
50 /** stopwatch macro using the stopwatch guard */
51 #define ALIHLTCOMPONENT_STOPWATCH(type) AliHLTStopwatchGuard swguard(fpStopwatches!=NULL?reinterpret_cast<TStopwatch*>(fpStopwatches->At((int)type)):NULL)
52 //#define ALIHLTCOMPONENT_STOPWATCH(type)
54 /** stopwatch macro for operations of the base class */
55 #define ALIHLTCOMPONENT_BASE_STOPWATCH() ALIHLTCOMPONENT_STOPWATCH(kSWBase)
56 /** stopwatch macro for operations of the detector algorithm (DA) */
57 #define ALIHLTCOMPONENT_DA_STOPWATCH() ALIHLTCOMPONENT_STOPWATCH(kSWDA)
59 AliHLTComponent::AliHLTComponent()
67 fCurrentInputBlock(-1),
68 fSearchDataType(kAliHLTVoidDataType),
73 fOutputBufferFilled(0),
75 fpStopwatches(new TObjArray(kSWTypeCount)),
81 // see header file for class documentation
83 // refer to README to build package
85 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
86 memset(&fEnvironment, 0, sizeof(AliHLTComponentEnvironment));
87 if (fgpComponentHandler)
88 fgpComponentHandler->ScheduleRegister(this);
89 //SetLocalLoggingLevel(kHLTLogDefault);
92 AliHLTComponent::~AliHLTComponent()
94 // see header file for function documentation
95 CleanupInputObjects();
96 if (fpStopwatches!=NULL) delete fpStopwatches;
98 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
99 while (element!=fMemFiles.end()) {
101 if ((*element)->IsClosed()==0) {
102 HLTWarning("memory file has not been closed, possible data loss or incomplete buffer");
103 // close but do not flush as we dont know whether the buffer is still valid
104 (*element)->CloseMemoryFile(0);
113 AliHLTComponentHandler* AliHLTComponent::fgpComponentHandler=NULL;
115 int AliHLTComponent::SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite)
117 // see header file for function documentation
119 if (fgpComponentHandler==NULL || bOverwrite!=0)
120 fgpComponentHandler=pCH;
126 int AliHLTComponent::UnsetGlobalComponentHandler()
128 // see header file for function documentation
129 return SetGlobalComponentHandler(NULL,1);
132 int AliHLTComponent::Init( AliHLTComponentEnvironment* environ, void* environParam, int argc, const char** argv )
134 // see header file for function documentation
137 memcpy(&fEnvironment, environ, sizeof(AliHLTComponentEnvironment));
138 fEnvironment.fParam=environParam;
140 const char** pArguments=NULL;
145 pArguments=new const char*[argc];
147 for (int i=0; i<argc && iResult>=0; i++) {
149 if (argument.IsNull()) continue;
152 if (argument.CompareTo("benchmark")==0) {
155 } else if (argument.CompareTo("loglevel")==0) {
156 if ((bMissingParam=(++i>=argc))) break;
157 TString parameter(argv[i]);
158 parameter.Remove(TString::kLeading, ' '); // remove all blanks
159 if (parameter.BeginsWith("0x") &&
160 parameter.Replace(0,2,"",0).IsHex()) {
161 AliHLTComponentLogSeverity loglevel=kHLTLogNone;
162 sscanf(parameter.Data(),"%x", (unsigned int*)&loglevel);
163 SetLocalLoggingLevel(loglevel);
165 HLTError("wrong parameter for argument %s, hex number expected", argument.Data());
169 pArguments[iNofChildArgs++]=argv[i];
177 HLTError("missing parameter for argument %s", argument.Data());
181 iResult=DoInit(iNofChildArgs, pArguments);
183 if (iResult>=0) fEventCount=0;
184 if (pArguments) delete [] pArguments;
188 int AliHLTComponent::Deinit()
190 // see header file for function documentation
194 HLTWarning("did not receive EOR for run %d", fpRunDesc->fRunNo);
195 AliHLTRunDesc* pRunDesc=fpRunDesc;
202 int AliHLTComponent::DoInit( int argc, const char** argv )
204 // see header file for function documentation
205 if (argc==0 && argv==NULL) {
206 // this is currently just to get rid of the warning "unused parameter"
212 int AliHLTComponent::DoDeinit()
214 // see header file for function documentation
219 int AliHLTComponent::GetOutputDataTypes(AliHLTComponentDataTypeList& /*tgtList*/)
221 HLTLogKeyword("dummy");
225 void AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2] ) const
227 // see header file for function documentation
228 memset( output, 0, kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2 );
229 strncat( output, type.fOrigin, kAliHLTComponentDataTypefOriginSize );
230 strcat( output, ":" );
231 strncat( output, type.fID, kAliHLTComponentDataTypefIDsize );
234 string AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, int mode)
236 // see header file for function documentation
242 for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
243 sprintf(tmp, "'%d", type.fOrigin[i]);
247 for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
248 sprintf(tmp, "%d'", type.fID[i]);
257 for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
258 unsigned char* puc=(unsigned char*)type.fOrigin;
260 sprintf(tmp, "'\\%x", type.fOrigin[i]);
262 sprintf(tmp, "'%c", type.fOrigin[i]);
266 for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
267 unsigned char* puc=(unsigned char*)type.fID;
269 sprintf(tmp, "\\%x'", type.fID[i]);
271 sprintf(tmp, "%c'", type.fID[i]);
277 if (type==kAliHLTVoidDataType) {
280 // some gymnastics in order to avoid a '0' which is part of either or both
281 // ID and origin terminating the whole string. Unfortunately, string doesn't
282 // stop appending at the '0' if the number of elements to append was
283 // explicitely specified
285 tmp.append(type.fOrigin, kAliHLTComponentDataTypefOriginSize);
286 out.append(tmp.c_str());
289 tmp.append(type.fID, kAliHLTComponentDataTypefIDsize);
290 out.append(tmp.c_str());
296 void* AliHLTComponent::AllocMemory( unsigned long size )
298 // see header file for function documentation
299 if (fEnvironment.fAllocMemoryFunc)
300 return (*fEnvironment.fAllocMemoryFunc)(fEnvironment.fParam, size );
301 HLTFatal("no memory allocation handler registered");
305 int AliHLTComponent::MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount,
306 AliHLTComponentBlockData** outputBlocks )
308 // see header file for function documentation
309 if ( blockCount==NULL || outputBlocks==NULL )
311 AliHLTUInt32_t count = blocks.size();
315 *outputBlocks = NULL;
318 *outputBlocks = reinterpret_cast<AliHLTComponentBlockData*>( AllocMemory( sizeof(AliHLTComponentBlockData)*count ) );
319 if ( !*outputBlocks )
321 for ( unsigned long i = 0; i < count; i++ ) {
322 (*outputBlocks)[i] = blocks[i];
323 if (blocks[i].fDataType==kAliHLTAnyDataType) {
324 (*outputBlocks)[i].fDataType=GetOutputDataType();
325 /* data type was set to the output data type by the PubSub AliRoot
326 Wrapper component, if data type of the block was ********:****.
327 Now handled by the component base class in order to have same
328 behavior when running embedded in AliRoot
329 memset((*outputBlocks)[i].fDataType.fID, '*', kAliHLTComponentDataTypefIDsize);
330 memset((*outputBlocks)[i].fDataType.fOrigin, '*', kAliHLTComponentDataTypefOriginSize);
339 int AliHLTComponent::GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd )
341 // see header file for function documentation
342 if (fEnvironment.fGetEventDoneDataFunc)
343 return (*fEnvironment.fGetEventDoneDataFunc)(fEnvironment.fParam, fCurrentEvent, size, edd );
347 int AliHLTComponent::FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList)
349 // see header file for function documentation
352 AliHLTComponentDataTypeList itypes;
353 AliHLTComponentDataTypeList otypes;
354 otypes.push_back(GetOutputDataType());
355 if (otypes[0]==kAliHLTMultipleDataType) {
358 if ((count=GetOutputDataTypes(otypes))>0) {
359 } else if (GetComponentType()!=kSink) {
360 HLTWarning("component %s indicates multiple output data types but GetOutputDataTypes returns %d", GetComponentID(), count);
363 ((AliHLTComponent*)pConsumer)->GetInputDataTypes(itypes);
364 AliHLTComponentDataTypeList::iterator itype=itypes.begin();
365 while (itype!=itypes.end()) {
366 //PrintDataTypeContent((*itype), "consumer \'%s\'");
367 AliHLTComponentDataTypeList::iterator otype=otypes.begin();
368 while (otype!=otypes.end() && (*itype)!=(*otype)) otype++;
369 //if (otype!=otypes.end()) PrintDataTypeContent(*otype, "publisher \'%s\'");
370 if (otype!=otypes.end() ||
371 (*itype)==kAliHLTAnyDataType) {
372 if (tgtList) tgtList->push_back(*itype);
383 void AliHLTComponent::PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format) const
385 // see header file for function documentation
386 const char* fmt="publisher \'%s\'";
387 if (format) fmt=format;
388 HLTMessage(fmt, (DataType2Text(dt)).c_str());
389 HLTMessage("%x %x %x %x %x %x %x %x : %x %x %x %x",
404 void AliHLTComponent::FillBlockData( AliHLTComponentBlockData& blockData )
406 // see header file for function documentation
407 blockData.fStructSize = sizeof(blockData);
408 FillShmData( blockData.fShmKey );
409 blockData.fOffset = ~(AliHLTUInt32_t)0;
410 blockData.fPtr = NULL;
412 FillDataType( blockData.fDataType );
413 blockData.fSpecification = kAliHLTVoidDataSpec;
416 void AliHLTComponent::FillShmData( AliHLTComponentShmData& shmData )
418 // see header file for function documentation
419 shmData.fStructSize = sizeof(shmData);
420 shmData.fShmType = gkAliHLTComponentInvalidShmType;
421 shmData.fShmID = gkAliHLTComponentInvalidShmID;
424 void AliHLTComponent::FillDataType( AliHLTComponentDataType& dataType )
426 // see header file for function documentation
427 dataType=kAliHLTAnyDataType;
430 void AliHLTComponent::CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt)
432 // see header file for function documentation
433 memcpy(&tgtdt.fID[0], &srcdt.fID[0], kAliHLTComponentDataTypefIDsize);
434 memcpy(&tgtdt.fOrigin[0], &srcdt.fOrigin[0], kAliHLTComponentDataTypefOriginSize);
437 void AliHLTComponent::SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin)
439 // see header file for function documentation
440 tgtdt.fStructSize=sizeof(AliHLTComponentDataType);
442 memset(&tgtdt.fID[0], 0, kAliHLTComponentDataTypefIDsize);
443 strncpy(&tgtdt.fID[0], id, strlen(id)<(size_t)kAliHLTComponentDataTypefIDsize?strlen(id):kAliHLTComponentDataTypefIDsize);
446 memset(&tgtdt.fOrigin[0], 0, kAliHLTComponentDataTypefOriginSize);
447 strncpy(&tgtdt.fOrigin[0], origin, strlen(origin)<(size_t)kAliHLTComponentDataTypefOriginSize?strlen(origin):kAliHLTComponentDataTypefOriginSize);
451 void AliHLTComponent::FillEventData(AliHLTComponentEventData& evtData)
453 // see header file for function documentation
454 memset(&evtData, 0, sizeof(AliHLTComponentEventData));
455 evtData.fStructSize=sizeof(AliHLTComponentEventData);
458 void AliHLTComponent::PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt)
460 // see header file for function documentation
462 msg.Form("AliHLTComponentDataType(%d): ID=\"", dt.fStructSize);
463 for ( int i = 0; i < kAliHLTComponentDataTypefIDsize; i++ ) {
464 if (dt.fID[i]!=0) msg+=dt.fID[i];
468 for ( int i = 0; i < kAliHLTComponentDataTypefOriginSize; i++ ) {
469 if (dt.fOrigin[i]!=0) msg+=dt.fOrigin[i];
473 AliHLTLogging::Message(NULL, kHLTLogNone, NULL , NULL, msg.Data());
476 int AliHLTComponent::GetEventCount() const
478 // see header file for function documentation
482 int AliHLTComponent::IncrementEventCounter()
484 // see header file for function documentation
485 if (fEventCount>=0) fEventCount++;
489 int AliHLTComponent::GetNumberOfInputBlocks() const
491 // see header file for function documentation
492 if (fpInputBlocks!=NULL) {
493 return fCurrentEventData.fBlockCnt;
498 const TObject* AliHLTComponent::GetFirstInputObject(const AliHLTComponentDataType& dt,
499 const char* classname,
502 // see header file for function documentation
503 ALIHLTCOMPONENT_BASE_STOPWATCH();
505 if (classname) fClassName=classname;
506 else fClassName.clear();
507 int idx=FindInputBlock(fSearchDataType, 0, 1);
510 HLTDebug("found block %d when searching for data type %s", idx, DataType2Text(dt).c_str());
511 if ((pObj=GetInputObject(idx, fClassName.c_str(), bForce))!=NULL) {
512 fCurrentInputBlock=idx;
519 const TObject* AliHLTComponent::GetFirstInputObject(const char* dtID,
520 const char* dtOrigin,
521 const char* classname,
524 // see header file for function documentation
525 ALIHLTCOMPONENT_BASE_STOPWATCH();
526 AliHLTComponentDataType dt;
527 SetDataType(dt, dtID, dtOrigin);
528 return GetFirstInputObject(dt, classname, bForce);
531 const TObject* AliHLTComponent::GetNextInputObject(int bForce)
533 // see header file for function documentation
534 ALIHLTCOMPONENT_BASE_STOPWATCH();
535 int idx=FindInputBlock(fSearchDataType, fCurrentInputBlock+1, 1);
536 //HLTDebug("found block %d when searching for data type %s", idx, DataType2Text(fSearchDataType).c_str());
539 if ((pObj=GetInputObject(idx, fClassName.c_str(), bForce))!=NULL) {
540 fCurrentInputBlock=idx;
546 int AliHLTComponent::FindInputBlock(const AliHLTComponentDataType& dt, int startIdx, int bObject) const
548 // see header file for function documentation
550 if (fpInputBlocks!=NULL) {
551 int idx=startIdx<0?0:startIdx;
552 for ( ; (UInt_t)idx<fCurrentEventData.fBlockCnt && iResult==-ENOENT; idx++) {
554 if (fpInputBlocks[idx].fPtr==NULL) continue;
555 AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)fpInputBlocks[idx].fPtr);
556 if (firstWord!=fpInputBlocks[idx].fSize-sizeof(AliHLTUInt32_t)) continue;
558 if (dt == kAliHLTAnyDataType || fpInputBlocks[idx].fDataType == dt ||
559 (memcmp(dt.fID, kAliHLTAnyDataTypeID, kAliHLTComponentDataTypefIDsize)==0 &&
560 memcmp(dt.fOrigin, fpInputBlocks[idx].fDataType.fOrigin, kAliHLTComponentDataTypefOriginSize)==0) ||
561 (memcmp(dt.fID, fpInputBlocks[idx].fDataType.fID, kAliHLTComponentDataTypefIDsize)==0) &&
562 memcmp(dt.fOrigin, kAliHLTDataOriginAny, kAliHLTComponentDataTypefOriginSize)==0) {
570 TObject* AliHLTComponent::CreateInputObject(int idx, int bForce)
572 // see header file for function documentation
574 if (fpInputBlocks!=NULL) {
575 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
576 if (fpInputBlocks[idx].fPtr) {
577 AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)fpInputBlocks[idx].fPtr);
578 if (firstWord==fpInputBlocks[idx].fSize-sizeof(AliHLTUInt32_t)) {
579 HLTDebug("create object from block %d size %d", idx, fpInputBlocks[idx].fSize);
580 AliHLTMessage msg(fpInputBlocks[idx].fPtr, fpInputBlocks[idx].fSize);
581 TClass* objclass=msg.GetClass();
582 pObj=msg.ReadObject(objclass);
583 if (pObj && objclass) {
584 HLTDebug("object %p type %s created", pObj, objclass->GetName());
588 } else if (bForce!=0) {
589 HLTError("size missmatch: block size %d, indicated %d", fpInputBlocks[idx].fSize, firstWord+sizeof(AliHLTUInt32_t));
592 HLTFatal("block descriptor empty");
595 HLTError("index %d out of range %d", idx, fCurrentEventData.fBlockCnt);
598 HLTError("no input blocks available");
604 TObject* AliHLTComponent::GetInputObject(int idx, const char* /*classname*/, int bForce)
606 // see header file for function documentation
607 if (fpInputObjects==NULL) {
608 fpInputObjects=new TObjArray(fCurrentEventData.fBlockCnt);
611 if (fpInputObjects) {
612 pObj=fpInputObjects->At(idx);
614 pObj=CreateInputObject(idx, bForce);
616 fpInputObjects->AddAt(pObj, idx);
620 HLTFatal("memory allocation failed: TObjArray of size %d", fCurrentEventData.fBlockCnt);
625 int AliHLTComponent::CleanupInputObjects()
627 // see header file for function documentation
628 if (!fpInputObjects) return 0;
629 TObjArray* array=fpInputObjects;
631 for (int i=0; i<array->GetEntries(); i++) {
632 TObject* pObj=array->At(i);
633 // grrr, garbage collection strikes back: When read via AliHLTMessage
634 // (CreateInputObject), and written to a TFile afterwards, the
635 // TFile::Close calls ROOOT's garbage collection. No clue why the
636 // object ended up in the key list and needs to be deleted
637 if (pObj && gObjectTable->PtrIsValid(pObj)) delete pObj;
643 AliHLTComponentDataType AliHLTComponent::GetDataType(const TObject* pObject)
645 // see header file for function documentation
646 ALIHLTCOMPONENT_BASE_STOPWATCH();
647 AliHLTComponentDataType dt=kAliHLTVoidDataType;
648 int idx=fCurrentInputBlock;
650 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
652 HLTError("unknown object %p", pObject);
656 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
657 dt=fpInputBlocks[idx].fDataType;
659 HLTFatal("severe internal error, index out of range");
665 AliHLTUInt32_t AliHLTComponent::GetSpecification(const TObject* pObject)
667 // see header file for function documentation
668 ALIHLTCOMPONENT_BASE_STOPWATCH();
669 AliHLTUInt32_t iSpec=kAliHLTVoidDataSpec;
670 int idx=fCurrentInputBlock;
672 if (fpInputObjects==NULL || (idx=fpInputObjects->IndexOf(pObject))>=0) {
674 HLTError("unknown object %p", pObject);
678 if ((UInt_t)idx<fCurrentEventData.fBlockCnt) {
679 iSpec=fpInputBlocks[idx].fSpecification;
681 HLTFatal("severe internal error, index out of range");
687 const AliHLTComponentBlockData* AliHLTComponent::GetFirstInputBlock(const AliHLTComponentDataType& dt)
689 // see header file for function documentation
690 ALIHLTCOMPONENT_BASE_STOPWATCH();
693 int idx=FindInputBlock(fSearchDataType, 0);
694 const AliHLTComponentBlockData* pBlock=NULL;
696 // check for fpInputBlocks pointer done in FindInputBlock
697 pBlock=&fpInputBlocks[idx];
698 fCurrentInputBlock=idx;
703 const AliHLTComponentBlockData* AliHLTComponent::GetFirstInputBlock(const char* dtID,
704 const char* dtOrigin)
706 // see header file for function documentation
707 ALIHLTCOMPONENT_BASE_STOPWATCH();
708 AliHLTComponentDataType dt;
709 SetDataType(dt, dtID, dtOrigin);
710 return GetFirstInputBlock(dt);
713 const AliHLTComponentBlockData* AliHLTComponent::GetInputBlock(int index)
715 // see header file for function documentation
716 ALIHLTCOMPONENT_BASE_STOPWATCH();
717 assert( 0 <= index and index < fCurrentEventData.fBlockCnt );
718 return &fpInputBlocks[index];
721 const AliHLTComponentBlockData* AliHLTComponent::GetNextInputBlock()
723 // see header file for function documentation
724 ALIHLTCOMPONENT_BASE_STOPWATCH();
725 int idx=FindInputBlock(fSearchDataType, fCurrentInputBlock+1);
726 const AliHLTComponentBlockData* pBlock=NULL;
728 // check for fpInputBlocks pointer done in FindInputBlock
729 pBlock=&fpInputBlocks[idx];
730 fCurrentInputBlock=idx;
735 int AliHLTComponent::FindInputBlock(const AliHLTComponentBlockData* pBlock) const
737 // see header file for function documentation
739 if (fpInputBlocks!=NULL) {
741 if (pBlock>=fpInputBlocks && pBlock<fpInputBlocks+fCurrentEventData.fBlockCnt) {
742 iResult=(int)(pBlock-fpInputBlocks);
751 AliHLTUInt32_t AliHLTComponent::GetSpecification(const AliHLTComponentBlockData* pBlock)
753 // see header file for function documentation
754 ALIHLTCOMPONENT_BASE_STOPWATCH();
755 AliHLTUInt32_t iSpec=kAliHLTVoidDataSpec;
756 int idx=fCurrentInputBlock;
758 if (fpInputObjects==NULL || (idx=FindInputBlock(pBlock))>=0) {
760 HLTError("unknown Block %p", pBlock);
764 // check for fpInputBlocks pointer done in FindInputBlock
765 iSpec=fpInputBlocks[idx].fSpecification;
770 int AliHLTComponent::PushBack(TObject* pObject, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
771 void* pHeader, int headerSize)
773 // see header file for function documentation
774 ALIHLTCOMPONENT_BASE_STOPWATCH();
777 AliHLTMessage msg(kMESS_OBJECT);
778 msg.WriteObject(pObject);
779 Int_t iMsgLength=msg.Length();
781 msg.SetLength(); // sets the length to the first (reserved) word
782 iResult=InsertOutputBlock(msg.Buffer(), iMsgLength, dt, spec, pHeader, headerSize);
784 HLTDebug("object %s (%p) size %d inserted to output", pObject->ClassName(), pObject, iMsgLength);
787 HLTError("object serialization failed for object %p", pObject);
796 int AliHLTComponent::PushBack(TObject* pObject, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec,
797 void* pHeader, int headerSize)
799 // see header file for function documentation
800 ALIHLTCOMPONENT_BASE_STOPWATCH();
801 AliHLTComponentDataType dt;
802 SetDataType(dt, dtID, dtOrigin);
803 return PushBack(pObject, dt, spec, pHeader, headerSize);
806 int AliHLTComponent::PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
807 void* pHeader, int headerSize)
809 // see header file for function documentation
810 ALIHLTCOMPONENT_BASE_STOPWATCH();
811 return InsertOutputBlock(pBuffer, iSize, dt, spec, pHeader, headerSize);
814 int AliHLTComponent::PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec,
815 void* pHeader, int headerSize)
817 // see header file for function documentation
818 ALIHLTCOMPONENT_BASE_STOPWATCH();
819 AliHLTComponentDataType dt;
820 SetDataType(dt, dtID, dtOrigin);
821 return PushBack(pBuffer, iSize, dt, spec, pHeader, headerSize);
824 int AliHLTComponent::InsertOutputBlock(void* pBuffer, int iBufferSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec,
825 void* pHeader, int iHeaderSize)
827 // see header file for function documentation
829 int iBlkSize = iBufferSize + iHeaderSize;
831 if (fpOutputBuffer && iBlkSize<=(int)(fOutputBufferSize-fOutputBufferFilled)) {
832 AliHLTUInt8_t* pTgt=fpOutputBuffer+fOutputBufferFilled;
833 AliHLTComponentBlockData bd;
835 bd.fOffset = fOutputBufferFilled;
838 bd.fSpecification = spec;
839 if (pHeader!=NULL && pHeader!=pTgt) {
840 memcpy(pTgt, pHeader, iHeaderSize);
843 pTgt += (AliHLTUInt8_t) iHeaderSize;
845 if (pBuffer!=NULL && pBuffer!=pTgt) {
846 memcpy(pTgt, pBuffer, iBufferSize);
848 //AliHLTUInt32_t firstWord=*((AliHLTUInt32_t*)pBuffer);
849 //HLTDebug("copy %d bytes from %p to output buffer %p, first word %#x", iBufferSize, pBuffer, pTgt, firstWord);
851 fOutputBufferFilled+=bd.fSize;
852 fOutputBlocks.push_back( bd );
853 //HLTDebug("buffer inserted to output: size %d data type %s spec %#x", iBlkSize, DataType2Text(dt).c_str(), spec);
855 if (fpOutputBuffer) {
856 HLTError("too little space in output buffer: %d, required %d", fOutputBufferSize-fOutputBufferFilled, iBlkSize);
858 HLTError("output buffer not available");
868 int AliHLTComponent::EstimateObjectSize(TObject* pObject) const
870 // see header file for function documentation
871 if (!pObject) return -EINVAL;
872 AliHLTMessage msg(kMESS_OBJECT);
873 msg.WriteObject(pObject);
877 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity, const char* dtID,
878 const char* dtOrigin,
881 // see header file for function documentation
882 ALIHLTCOMPONENT_BASE_STOPWATCH();
883 AliHLTComponentDataType dt;
884 SetDataType(dt, dtID, dtOrigin);
885 return CreateMemoryFile(capacity, dt, spec);
888 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity,
889 const AliHLTComponentDataType& dt,
892 // see header file for function documentation
893 ALIHLTCOMPONENT_BASE_STOPWATCH();
894 AliHLTMemoryFile* pFile=NULL;
895 if (capacity>=0 && static_cast<unsigned int>(capacity)<=fOutputBufferSize-fOutputBufferFilled){
896 AliHLTUInt8_t* pTgt=fpOutputBuffer+fOutputBufferFilled;
897 pFile=new AliHLTMemoryFile((char*)pTgt, capacity);
899 unsigned int nofBlocks=fOutputBlocks.size();
900 if (nofBlocks+1>fMemFiles.size()) {
901 fMemFiles.resize(nofBlocks+1, NULL);
903 if (nofBlocks<fMemFiles.size()) {
904 fMemFiles[nofBlocks]=pFile;
905 AliHLTComponentBlockData bd;
907 bd.fOffset = fOutputBufferFilled;
910 bd.fSpecification = spec;
911 fOutputBufferFilled+=bd.fSize;
912 fOutputBlocks.push_back( bd );
914 HLTError("can not allocate/grow object array");
915 pFile->CloseMemoryFile(0);
921 HLTError("can not create memory file of size %d (%d available)", capacity, fOutputBufferSize-fOutputBufferFilled);
926 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(const char* dtID,
927 const char* dtOrigin,
931 // see header file for function documentation
932 ALIHLTCOMPONENT_BASE_STOPWATCH();
933 AliHLTComponentDataType dt;
934 SetDataType(dt, dtID, dtOrigin);
935 int size=fOutputBufferSize-fOutputBufferFilled;
936 if (capacity<0 || capacity>1.0) {
937 HLTError("invalid parameter: capacity %f", capacity);
940 size=(int)(size*capacity);
941 return CreateMemoryFile(size, dt, spec);
944 AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(const AliHLTComponentDataType& dt,
948 // see header file for function documentation
949 ALIHLTCOMPONENT_BASE_STOPWATCH();
950 int size=fOutputBufferSize-fOutputBufferFilled;
951 if (capacity<0 || capacity>1.0) {
952 HLTError("invalid parameter: capacity %f", capacity);
955 size=(int)(size*capacity);
956 return CreateMemoryFile(size, dt, spec);
959 int AliHLTComponent::Write(AliHLTMemoryFile* pFile, const TObject* pObject,
960 const char* key, int option)
962 // see header file for function documentation
964 if (pFile && pObject) {
966 iResult=pObject->Write(key, option);
970 iResult=-pFile->GetErrno();
971 if (iResult==-ENOSPC) {
972 HLTError("error writing memory file, buffer too small");
981 int AliHLTComponent::CloseMemoryFile(AliHLTMemoryFile* pFile)
983 // see header file for function documentation
986 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
988 while (element!=fMemFiles.end() && iResult>=0) {
989 if (*element && *element==pFile) {
990 iResult=pFile->CloseMemoryFile();
992 // sync memory files and descriptors
994 fOutputBlocks[i].fSize=(*element)->GetSize()+(*element)->GetHeaderSize();
1002 HLTError("can not find memory file %p", pFile);
1010 int AliHLTComponent::CreateEventDoneData(AliHLTComponentEventDoneData /*edd*/)
1012 // see header file for function documentation
1013 int iResult=-ENOSYS;
1014 //#warning function not yet implemented
1015 HLTWarning("function not yet implemented");
1019 int AliHLTComponent::ProcessEvent( const AliHLTComponentEventData& evtData,
1020 const AliHLTComponentBlockData* blocks,
1021 AliHLTComponentTriggerData& trigData,
1022 AliHLTUInt8_t* outputPtr,
1023 AliHLTUInt32_t& size,
1024 AliHLTUInt32_t& outputBlockCnt,
1025 AliHLTComponentBlockData*& outputBlocks,
1026 AliHLTComponentEventDoneData*& edd )
1028 // see header file for function documentation
1029 ALIHLTCOMPONENT_BASE_STOPWATCH();
1031 fCurrentEvent=evtData.fEventID;
1032 fCurrentEventData=evtData;
1033 fpInputBlocks=blocks;
1034 fCurrentInputBlock=-1;
1035 fSearchDataType=kAliHLTAnyDataType;
1036 fpOutputBuffer=outputPtr;
1037 fOutputBufferSize=size;
1038 fOutputBufferFilled=0;
1039 fOutputBlocks.clear();
1041 // find special events
1042 if (fpInputBlocks) {
1043 for (unsigned int i=0; i<evtData.fBlockCnt && iResult>=0; i++) {
1044 if (fpInputBlocks[i].fDataType==kAliHLTDataTypeSOR) {
1046 if (fpRunDesc==NULL) {
1047 fpRunDesc=new AliHLTRunDesc;
1049 if ((iResult=CopyStruct(fpRunDesc, sizeof(AliHLTRunDesc), i, "AliHLTRunDesc", "SOR"))>0) {
1050 HLTDebug("set run decriptor, run no %d", fpRunDesc->fRunNo);
1056 HLTWarning("already received SOR event run no %d, ignoring SOR", fpRunDesc->fRunNo);
1058 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeEOR) {
1059 if (fpRunDesc!=NULL) {
1061 AliHLTRunDesc rundesc;
1062 if ((iResult=CopyStruct(&rundesc, sizeof(AliHLTRunDesc), i, "AliHLTRunDesc", "SOR"))>0) {
1063 if (fpRunDesc->fRunNo!=rundesc.fRunNo) {
1064 HLTWarning("run no missmatch: SOR %d, EOR %d", fpRunDesc->fRunNo, rundesc.fRunNo);
1066 HLTDebug("EOR run no %d", fpRunDesc->fRunNo);
1069 AliHLTRunDesc* pRunDesc=fpRunDesc;
1074 HLTWarning("did not receive SOR, ignoring EOR");
1077 } else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeDDL) {
1083 AliHLTComponentBlockDataList blockData;
1084 { // dont delete, sets the scope for the stopwatch guard
1085 ALIHLTCOMPONENT_DA_STOPWATCH();
1086 iResult=DoProcessing(evtData, blocks, trigData, outputPtr, size, blockData, edd);
1087 } // end of the scope of the stopwatch guard
1089 if (fOutputBlocks.size()>0) {
1090 //HLTDebug("got %d block(s) via high level interface", fOutputBlocks.size());
1092 // sync memory files and descriptors
1093 AliHLTMemoryFilePList::iterator element=fMemFiles.begin();
1095 while (element!=fMemFiles.end() && iResult>=0) {
1097 if ((*element)->IsClosed()==0) {
1098 HLTWarning("memory file has not been closed, force flush");
1099 iResult=CloseMemoryFile(*element);
1106 // create the descriptor list
1107 if (blockData.size()>0) {
1108 HLTError("low level and high interface must not be mixed; use PushBack methods to insert data blocks");
1111 iResult=MakeOutputDataBlockList(fOutputBlocks, &outputBlockCnt, &outputBlocks);
1112 size=fOutputBufferFilled;
1116 iResult=MakeOutputDataBlockList(blockData, &outputBlockCnt, &outputBlocks);
1119 HLTFatal("component %s (%p): can not convert output block descriptor list", GetComponentID(), this);
1126 CleanupInputObjects();
1128 IncrementEventCounter();
1133 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard()
1138 // standard constructor (not for use)
1141 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard(TStopwatch* pStopwatch)
1143 fpStopwatch(pStopwatch),
1148 // check for already existing guard
1149 if (fgpCurrent) fpPrec=fgpCurrent;
1152 // stop the preceeding guard if it controls a different stopwatch
1154 if (fpPrec && fpPrec!=this) bStart=fpPrec->Hold(fpStopwatch);
1156 // start the stopwatch if the current guard controls a different one
1157 if (fpStopwatch && bStart==1) fpStopwatch->Start(kFALSE);
1160 AliHLTComponent::AliHLTStopwatchGuard::AliHLTStopwatchGuard(const AliHLTStopwatchGuard&)
1166 // copy constructor not for use
1170 AliHLTComponent::AliHLTStopwatchGuard& AliHLTComponent::AliHLTStopwatchGuard::operator=(const AliHLTStopwatchGuard&)
1173 // assignment operator not for use
1180 AliHLTComponent::AliHLTStopwatchGuard* AliHLTComponent::AliHLTStopwatchGuard::fgpCurrent=NULL;
1182 AliHLTComponent::AliHLTStopwatchGuard::~AliHLTStopwatchGuard()
1186 // resume the preceeding guard if it controls a different stopwatch
1188 if (fpPrec && fpPrec!=this) bStop=fpPrec->Resume(fpStopwatch);
1190 // stop the stopwatch if the current guard controls a different one
1191 if (fpStopwatch && bStop==1) fpStopwatch->Stop();
1193 // resume to the preceeding guard
1197 int AliHLTComponent::AliHLTStopwatchGuard::Hold(TStopwatch* pSucc)
1199 // see header file for function documentation
1200 if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Stop();
1201 return fpStopwatch!=pSucc?1:0;
1204 int AliHLTComponent::AliHLTStopwatchGuard::Resume(TStopwatch* pSucc)
1206 // see header file for function documentation
1207 if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Start(kFALSE);
1208 return fpStopwatch!=pSucc?1:0;
1211 int AliHLTComponent::SetStopwatch(TObject* pSW, AliHLTStopwatchType type)
1213 // see header file for function documentation
1215 if (pSW!=NULL && type<kSWTypeCount) {
1216 if (fpStopwatches) {
1217 TObject* pObj=fpStopwatches->At((int)type);
1218 if (pSW==NULL // explicit reset
1219 || pObj==NULL) { // explicit set
1220 fpStopwatches->AddAt(pSW, (int)type);
1221 } else if (pObj!=pSW) {
1222 HLTWarning("stopwatch %d already set, reset first", (int)type);
1232 int AliHLTComponent::SetStopwatches(TObjArray* pStopwatches)
1234 // see header file for function documentation
1235 if (pStopwatches==NULL) return -EINVAL;
1238 for (int i=0 ; i<(int)kSWTypeCount && pStopwatches->GetEntries(); i++)
1239 SetStopwatch(pStopwatches->At(i), (AliHLTStopwatchType)i);
1243 AliHLTUInt32_t AliHLTComponent::GetRunNo() const
1245 // see header file for function documentation
1246 if (fpRunDesc==NULL) return 0;
1247 return fpRunDesc->fRunNo;
1250 AliHLTUInt32_t AliHLTComponent::GetRunType() const
1252 // see header file for function documentation
1253 if (fpRunDesc==NULL) return 0;
1254 return fpRunDesc->fRunType;
1257 int AliHLTComponent::CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
1258 const char* structname, const char* eventname)
1260 // see header file for function documentation
1262 if (pStruct!=NULL && iStructSize>sizeof(AliHLTUInt32_t)) {
1263 if (fpInputBlocks!=NULL && iBlockNo<fCurrentEventData.fBlockCnt) {
1264 AliHLTUInt32_t* pTgt=(AliHLTUInt32_t*)pStruct;
1265 if (fpInputBlocks[iBlockNo].fPtr && fpInputBlocks[iBlockNo].fSize) {
1266 AliHLTUInt32_t copy=*((AliHLTUInt32_t*)fpInputBlocks[iBlockNo].fPtr);
1267 if (fpInputBlocks[iBlockNo].fSize!=copy) {
1268 HLTWarning("%s event: missmatch of block size (%d) and structure size (%d)", eventname, fpInputBlocks[iBlockNo].fSize, copy);
1269 if (copy>fpInputBlocks[iBlockNo].fSize) copy=fpInputBlocks[iBlockNo].fSize;
1271 if (copy!=iStructSize) {
1272 HLTWarning("%s event: missmatch in %s version (data type version %d)", eventname, structname, ALIHLT_DATA_TYPES_VERSION);
1273 if (copy>iStructSize) {
1276 memset(pTgt, 0, iStructSize);
1279 memcpy(pTgt, fpInputBlocks[iBlockNo].fPtr, copy);
1283 HLTWarning("%s event: missing data block", eventname);
1289 HLTError("invalid struct");