2 // splitted from AliHLTConfiguration.cxx,v 1.25 2007/10/12 13:24:47
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 * for The ALICE HLT Project. *
10 * Permission to use, copy, modify and distribute this software and its *
11 * documentation strictly for non-commercial purposes is hereby granted *
12 * without fee, provided that the above copyright notice appears in all *
13 * copies and that both the copyright notice and this permission notice *
14 * appear in the supporting documentation. The authors make no claims *
15 * about the suitability of this software for any purpose. It is *
16 * provided "as is" without express or implied warranty. *
17 **************************************************************************/
19 /** @file AliHLTTask.cxx
20 @author Matthias Richter
22 @brief Implementation of HLT tasks.
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
39 #include "AliHLTTask.h"
40 #include "AliHLTConfiguration.h"
41 #include "AliHLTComponent.h"
42 #include "AliHLTComponentHandler.h"
45 /** ROOT macro for the implementation of ROOT specific class methods */
48 AliHLTTask::AliHLTTask()
50 fpConfiguration(NULL),
57 // see header file for class documentation
59 // refer to README to build package
61 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
64 AliHLTTask::AliHLTTask(AliHLTConfiguration* pConf)
66 fpConfiguration(pConf),
73 // see header file for function documentation
76 AliHLTTask::~AliHLTTask()
78 // see header file for function documentation
79 TObjLink* lnk=fListDependencies.FirstLink();
82 AliHLTTask* pTask=(AliHLTTask*)lnk->GetObject();
83 pTask->UnsetTarget(this);
86 lnk=fListTargets.FirstLink();
89 AliHLTTask* pTask=(AliHLTTask*)lnk->GetObject();
90 pTask->UnsetDependency(this);
94 if (fpComponent) delete fpComponent;
98 int AliHLTTask::Init(AliHLTConfiguration* pConf, AliHLTComponentHandler* pCH)
100 // see header file for function documentation
102 if (fpConfiguration!=NULL && pConf!=NULL && fpConfiguration!=pConf) {
103 HLTWarning("overriding existing reference to configuration object %p (%s) by %p",
104 fpConfiguration, GetName(), pConf);
106 if (pConf!=NULL) fpConfiguration=pConf;
107 if (fpConfiguration) {
110 const char** argv=NULL;
111 if ((iResult=fpConfiguration->GetArguments(&argv))>=0) {
112 argc=iResult; // just to make it clear
113 // TODO: we have to think about the optional environment parameter,
114 // currently just set to NULL.
115 iResult=pCH->CreateComponent(fpConfiguration->GetComponentID(), NULL, argc, argv, fpComponent);
116 if (fpComponent || iResult<=0) {
117 //HLTDebug("component %s (%p) created", fpComponent->GetComponentID(), fpComponent);
119 //HLTError("can not find component \"%s\" (%d)", fpConfiguration->GetComponentID(), iResult);
122 HLTError("can not get argument list for configuration %s (%s)", fpConfiguration->GetName(), fpConfiguration->GetComponentID());
126 HLTError("component handler instance needed for task initialization");
130 HLTError("configuration object instance needed for task initialization");
136 int AliHLTTask::Deinit()
138 // see header file for function documentation
140 AliHLTComponent* pComponent=GetComponent();
143 //HLTDebug("delete component %s (%p)", pComponent->GetComponentID(), pComponent);
144 pComponent->Deinit();
147 HLTWarning("task %s (%p) doesn't seem to be in initialized", GetName(), this);
152 const char *AliHLTTask::GetName() const
154 // see header file for function documentation
156 return fpConfiguration->GetName();
157 return TObject::GetName();
160 AliHLTConfiguration* AliHLTTask::GetConf() const
162 // see header file for function documentation
163 return fpConfiguration;
166 AliHLTComponent* AliHLTTask::GetComponent() const
168 // see header file for function documentation
172 AliHLTTask* AliHLTTask::FindDependency(const char* id)
174 // see header file for function documentation
175 AliHLTTask* pTask=NULL;
177 pTask=(AliHLTTask*)fListDependencies.FindObject(id);
182 int AliHLTTask::FollowDependency(const char* id, TList* pTgtList)
184 // see header file for function documentation
187 AliHLTTask* pDep=NULL;
188 if ((pDep=(AliHLTTask*)fListDependencies.FindObject(id))!=NULL) {
189 if (pTgtList) pTgtList->Add(pDep);
192 TObjLink* lnk=fListDependencies.FirstLink();
193 while (lnk && iResult==0) {
194 pDep=(AliHLTTask*)lnk->GetObject();
196 if ((iResult=pDep->FollowDependency(id, pTgtList))>0) {
197 if (pTgtList) pTgtList->AddFirst(pDep);
212 void AliHLTTask::PrintDependencyTree(const char* id, int bFromConfiguration)
214 // see header file for function documentation
215 HLTLogKeyword("task dependencies");
218 if (bFromConfiguration) {
220 iResult=fpConfiguration->FollowDependency(id, &tgtList);
224 iResult=FollowDependency(id, &tgtList);
226 HLTMessage(" task \"%s\": dependency level %d ", GetName(), iResult);
227 TObjLink* lnk=tgtList.FirstLink();
229 char* pSpace = new char[iResult+1];
231 memset(pSpace, 32, iResult);
234 TObject* obj=lnk->GetObject();
235 HLTMessage(" %s^-- %s ", &pSpace[i--], obj->GetName());
245 int AliHLTTask::SetDependency(AliHLTTask* pDep)
247 // see header file for function documentation
250 if (FindDependency(pDep->GetName())==NULL) {
251 fListDependencies.Add(pDep);
261 int AliHLTTask::UnsetDependency(AliHLTTask* pDep)
263 // see header file for function documentation
264 fListDependencies.Remove(pDep);
265 if (fpConfiguration) {
266 fpConfiguration->InvalidateSources();
271 int AliHLTTask::CheckDependencies()
273 // see header file for function documentation
275 AliHLTConfiguration* pSrc=fpConfiguration->GetFirstSource();
277 if (FindDependency(pSrc->GetName())==NULL) {
278 //HLTDebug("dependency \"%s\" unresolved", pSrc->GetName());
281 pSrc=fpConfiguration->GetNextSource();
287 int AliHLTTask::Depends(AliHLTTask* pTask)
289 // see header file for function documentation
292 if (fpConfiguration) {
293 iResult=fpConfiguration->GetSource(pTask->GetName())!=NULL;
295 //HLTDebug("task \"%s\" depends on \"%s\"", GetName(), pTask->GetName());
297 //HLTDebug("task \"%s\" independend of \"%s\"", GetName(), pTask->GetName());
308 AliHLTTask* AliHLTTask::FindTarget(const char* id)
310 // see header file for function documentation
311 AliHLTTask* pTask=NULL;
313 pTask=(AliHLTTask*)fListTargets.FindObject(id);
318 int AliHLTTask::SetTarget(AliHLTTask* pTgt)
320 // see header file for function documentation
323 if (FindTarget(pTgt->GetName())==NULL) {
324 fListTargets.Add(pTgt);
334 int AliHLTTask::UnsetTarget(AliHLTTask* pTarget)
336 // see header file for function documentation
337 fListTargets.Remove(pTarget);
341 int AliHLTTask::StartRun()
343 // see header file for function documentation
345 int iNofInputDataBlocks=0;
346 AliHLTComponent* pComponent=GetComponent();
348 // determine the number of input data blocks provided from the source tasks
349 { // set scope for lnk as a local variable
350 TObjLink* lnk=fListDependencies.FirstLink();
351 while (lnk && iResult>=0) {
352 AliHLTTask* pSrcTask=(AliHLTTask*)lnk->GetObject();
354 if ((iResult=pSrcTask->GetNofMatchingDataTypes(this))>0) {
355 iNofInputDataBlocks+=iResult;
356 } else if (iResult==0) {
357 HLTWarning("source task %s (%p) does not provide any matching data type for task %s (%p)", pSrcTask->GetName(), pSrcTask, GetName(), this);
359 HLTError("task %s (%p): error getting matching data types for source task %s (%p)", GetName(), this, pSrcTask->GetName(), pSrcTask);
367 if (fBlockDataArray.size()>0) {
368 HLTWarning("block data array for task %s (%p) was not cleaned", GetName(), this);
369 fBlockDataArray.clear();
373 // the initialization of the component is done by the ComponentHandler after creation
375 //iResult=Init( AliHLTComponentEnvironment* environ, void* environ_param, int argc, const char** argv );
377 // allocate the data buffer, which controls the output buffer and subscriptions
379 fpDataBuffer=new AliHLTDataBuffer;
380 if (fpDataBuffer!=NULL) {
381 fpDataBuffer->SetLocalLoggingLevel(GetLocalLoggingLevel());
382 HLTDebug("created data buffer %p for task %s (%p)", fpDataBuffer, GetName(), this);
383 TObjLink* lnk=fListTargets.FirstLink();
384 while (lnk && iResult>=0) {
385 AliHLTTask* pTgtTask=(AliHLTTask*)lnk->GetObject();
387 if ((iResult=fpDataBuffer->SetConsumer(pTgtTask->GetComponent()))>=0) {
396 HLTFatal("can not create data buffer object, memory allocation failed");
402 // send the SOR event
406 HLTError("task %s (%p) does not have a component", GetName(), this);
412 int AliHLTTask::EndRun()
414 // see header file for function documentation
416 if (fBlockDataArray.size()>0) {
417 fBlockDataArray.clear();
420 AliHLTDataBuffer* pBuffer=fpDataBuffer;
427 int AliHLTTask::ProcessTask(Int_t eventNo)
429 // see header file for function documentation
431 AliHLTComponent* pComponent=GetComponent();
432 if (pComponent && fpDataBuffer) {
433 HLTDebug("Processing task %s (%p) fpDataBuffer %p", GetName(), this, fpDataBuffer);
434 fpDataBuffer->Reset();
435 int iSourceDataBlock=0;
436 int iInputDataVolume=0;
438 AliHLTTask* pSrcTask=NULL;
439 AliHLTTaskPList subscribedTaskList;
440 TObjLink* lnk=fListDependencies.FirstLink();
442 // instances of SOR and EOR events to be kept
446 // subscribe to all source tasks
447 fBlockDataArray.clear();
448 while (lnk && iResult>=0) {
449 pSrcTask=(AliHLTTask*)lnk->GetObject();
451 int iMatchingDB=pSrcTask->GetNofMatchingDataBlocks(this);
453 HLTError("task %s (%p): error getting no of matching data blocks from task %s (%p), error %d", GetName(), this, pSrcTask->GetName(), pSrcTask, iMatchingDB);
456 } else if (iMatchingDB==0) {
457 HLTDebug("source task %s (%p) does not provide any matching data type for task %s (%p)", pSrcTask->GetName(), pSrcTask, GetName(), this);
459 if ((iResult=pSrcTask->Subscribe(this, fBlockDataArray))>=0) {
461 AliHLTComponentBlockDataList::iterator block=fBlockDataArray.begin();
462 for (int i=0; block!=fBlockDataArray.end(); i++) {
464 bRemove|=(*block).fDataType==kAliHLTDataTypeSOR && !(iSOR<0 && (iSOR=i)>=0);
465 bRemove|=(*block).fDataType==kAliHLTDataTypeEOR && !(iEOR<0 && (iEOR=i)>=0);
466 //HLTInfo("block %d, iSOR=%d iEOR=%d remove=%d", i, iSOR, iEOR, bRemove);
467 if (i<iSourceDataBlock) {
469 } else if (bRemove) {
470 HLTDebug("remove duplicated event %s (%d)", AliHLTComponent::DataType2Text((*block).fDataType).c_str(), i);
471 pSrcTask->Release(&(*block), this);
472 block=fBlockDataArray.erase(block);
475 iInputDataVolume+=(*block).fSize;
476 // put the source task as many times into the list as it provides data blocks
477 // makes the bookkeeping for the data release easier
478 subscribedTaskList.push_back(pSrcTask);
482 HLTDebug("Task %s (%p) successfully subscribed to %d data block(s) of task %s (%p)", GetName(), this, iResult, pSrcTask->GetName(), pSrcTask);
483 iSourceDataBlock=fBlockDataArray.size();
486 HLTError("Task %s (%p): subscription to task %s (%p) failed with error %d", GetName(), this, pSrcTask->GetName(), pSrcTask, iResult);
490 HLTFatal("fatal internal error in ROOT list handling");
497 int iNofTrial=0; // repeat processing if component returns -ENOSPC
498 AliHLTUInt32_t size=0;
501 long unsigned int iOutputDataSize=0;
502 AliHLTConfiguration* pConf=GetConf();
504 // check if there was a buffer size specified, query output size
505 // estimator from component otherwize
506 if (pConf && pConf->GetOutputBufferSize()>=0) {
507 iOutputDataSize=pConf->GetOutputBufferSize();
509 long unsigned int iConstBase=0;
510 double fInputMultiplier=0;
511 if (pComponent->GetComponentType()!=AliHLTComponent::kSink)
512 pComponent->GetOutputDataSize(iConstBase, fInputMultiplier);
513 if (fInputMultiplier<0) {
514 HLTWarning("ignoring negative input multiplier");
517 iOutputDataSize=int(fInputMultiplier*iInputDataVolume) + iConstBase;
518 //HLTDebug("task %s: reqired output size %d", GetName(), iOutputDataSize);
521 // dont process again if the buffer size is the same
522 if (size==iOutputDataSize) break;
523 HLTInfo("processing task %s again with buffer size %d", GetName(), iOutputDataSize);
525 AliHLTUInt8_t* pTgtBuffer=NULL;
526 if (iOutputDataSize>0) pTgtBuffer=fpDataBuffer->GetTargetBuffer(iOutputDataSize);
527 //HLTDebug("provided raw buffer %p", pTgtBuffer);
528 AliHLTComponentEventData evtData;
529 AliHLTComponent::FillEventData(evtData);
530 evtData.fEventID=(AliHLTEventID_t)eventNo;
531 evtData.fBlockCnt=iSourceDataBlock;
532 AliHLTComponentTriggerData trigData;
533 size=iOutputDataSize;
534 AliHLTUInt32_t outputBlockCnt=0;
535 AliHLTComponentBlockData* outputBlocks=NULL;
536 AliHLTComponentEventDoneData* edd;
537 if (pTgtBuffer!=NULL || iOutputDataSize==0) {
538 iResult=pComponent->ProcessEvent(evtData, &fBlockDataArray[0], trigData, pTgtBuffer, size, outputBlockCnt, outputBlocks, edd);
539 HLTDebug("task %s: component %s ProcessEvent finnished (%d): size=%d blocks=%d", GetName(), pComponent->GetComponentID(), iResult, size, outputBlockCnt);
540 if (iResult>=0 && outputBlocks) {
541 if (fListTargets.First()!=NULL) {
542 AliHLTComponentBlockDataList segments;
543 for (AliHLTUInt32_t oblock=0; oblock<outputBlockCnt; oblock++) {
544 AliHLTUInt32_t iblock=0;
545 for (; iblock<evtData.fBlockCnt; iblock++) {
546 if (fBlockDataArray[iblock].fPtr==outputBlocks[oblock].fPtr) {
547 assert(subscribedTaskList[iblock]!=NULL);
548 if (subscribedTaskList[iblock]==NULL) continue;
549 HLTDebug("forward segment %d (source task %s %p) to data buffer %p", iblock, pSrcTask->GetName(), pSrcTask, fpDataBuffer);
550 fpDataBuffer->Forward(subscribedTaskList[iblock], &fBlockDataArray[iblock]);
551 subscribedTaskList[iblock]=NULL; // not to be released in the loop further down
555 if (iblock==evtData.fBlockCnt) segments.push_back(outputBlocks[oblock]);
557 if (pTgtBuffer && segments.size()>0) {
558 iResult=fpDataBuffer->SetSegments(pTgtBuffer, &segments[0], segments.size());
561 // no forwarding, actually we dont even need to keep the data, this is a
562 // dead end (fListTargets empty)
563 //iResult=fpDataBuffer->SetSegments(pTgtBuffer, outputBlocks, outputBlockCnt);
565 delete [] outputBlocks; outputBlocks=NULL; outputBlockCnt=0;
567 fpDataBuffer->Reset();
569 if (fListTargets.First()!=NULL) {
570 if (iSOR>=0 && subscribedTaskList[iSOR]!=NULL) {
571 HLTDebug("forward SOR event segment %d (source task %s %p) to data buffer %p", iSOR, pSrcTask->GetName(), pSrcTask, fpDataBuffer);
572 fpDataBuffer->Forward(subscribedTaskList[iSOR], &fBlockDataArray[iSOR]);
573 subscribedTaskList[iSOR]=NULL; // not to be released in the loop further down
575 if (iEOR>=0 && subscribedTaskList[iEOR]!=NULL) {
576 HLTDebug("forward EOR event (%s) segment %d (source task %s %p) to data buffer %p", AliHLTComponent::DataType2Text(fBlockDataArray[iEOR].fDataType).c_str(), iEOR, pSrcTask->GetName(), pSrcTask, fpDataBuffer);
577 fpDataBuffer->Forward(subscribedTaskList[iEOR], &fBlockDataArray[iEOR]);
578 subscribedTaskList[iEOR]=NULL; // not to be released in the loop further down
582 HLTError("task %s: no target buffer available", GetName());
585 } while (iResult==-ENOSPC && iNofTrial++<1);
588 // now release all buffers which we have subscribed to
590 AliHLTTaskPList::iterator element;
591 while ((element=subscribedTaskList.begin())!=subscribedTaskList.end()) {
595 if ((iTempRes=pSrcTask->Release(&fBlockDataArray[iSourceDataBlock], this))>=0) {
596 HLTDebug("Task %s (%p) successfully released segment of task %s (%p)", GetName(), this, pSrcTask->GetName(), pSrcTask);
598 HLTError("Task %s (%p): realease of task %s (%p) failed with error %d", GetName(), this, pSrcTask->GetName(), pSrcTask, iTempRes);
601 subscribedTaskList.erase(element);
604 if (subscribedTaskList.size()>0) {
605 HLTError("task %s (%p): could not release all data buffers", GetName(), this);
608 HLTError("task %s (%p): internal failure (not initialized component %p, data buffer %p)", GetName(), this, fpComponent, fpDataBuffer);
614 int AliHLTTask::GetNofMatchingDataBlocks(const AliHLTTask* pConsumerTask) const
616 // see header file for function documentation
620 iResult=fpDataBuffer->FindMatchingDataBlocks(pConsumerTask->GetComponent(), NULL);
622 HLTFatal("internal data buffer missing");
631 int AliHLTTask::GetNofMatchingDataTypes(const AliHLTTask* pConsumerTask) const
633 // see header file for function documentation
636 AliHLTComponent* pComponent=GetComponent();
639 HLTError("component not initialized");
643 iResult=pComponent->FindMatchingDataTypes(pConsumerTask->GetComponent(), NULL);
645 HLTFatal("task initialization failed");
654 int AliHLTTask::Subscribe(const AliHLTTask* pConsumerTask, AliHLTComponentBlockDataList& blockDescList)
656 // see header file for function documentation
660 iResult=fpDataBuffer->Subscribe(pConsumerTask->GetComponent(), blockDescList);
662 HLTFatal("internal data buffer missing");
671 int AliHLTTask::Release(AliHLTComponentBlockData* pBlockDesc, const AliHLTTask* pConsumerTask)
673 // see header file for function documentation
675 if (pConsumerTask && pBlockDesc) {
677 iResult=fpDataBuffer->Release(pBlockDesc, pConsumerTask->GetComponent(), this);
679 HLTFatal("internal data buffer missing");
688 void AliHLTTask::PrintStatus()
690 // see header file for function documentation
691 HLTLogKeyword("task properties");
692 AliHLTComponent* pComponent=GetComponent();
694 HLTMessage(" component: %s (%p)", pComponent->GetComponentID(), pComponent);
696 HLTMessage(" no component set!");
698 if (fpConfiguration) {
699 AliHLTConfiguration* pSrc=fpConfiguration->GetFirstSource();
701 const char* pQualifier="unresolved";
702 if (FindDependency(pSrc->GetName()))
703 pQualifier="resolved";
704 HLTMessage(" source: %s (%s)", pSrc->GetName(), pQualifier);
705 pSrc=fpConfiguration->GetNextSource();
707 TObjLink* lnk = fListTargets.FirstLink();
709 TObject *obj = lnk->GetObject();
710 HLTMessage(" target: %s", obj->GetName());
714 HLTMessage(" task \"%s\" not initialized", GetName());