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 AliHLTDataBuffer.cxx
20 @author Matthias Richter
22 @brief Handling of Data Buffers 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 "AliHLTDataBuffer.h"
36 #include "AliHLTConsumerDescriptor.h"
37 #include "AliHLTComponent.h"
40 //#include "AliHLTSystem.h"
42 /** ROOT macro for the implementation of ROOT specific class methods */
43 ClassImp(AliHLTDataBuffer)
45 AliHLTDataBuffer::AliHLTDataBuffer()
54 // see header file for class documentation
56 // refer to README to build package
58 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
61 fActiveConsumers.empty();
62 fReleasedConsumers.empty();
66 int AliHLTDataBuffer::fgNofInstances=0;
67 vector<AliHLTDataBuffer::AliHLTRawBuffer*> AliHLTDataBuffer::fgFreeBuffers;
68 vector<AliHLTDataBuffer::AliHLTRawBuffer*> AliHLTDataBuffer::fgActiveBuffers;
69 AliHLTUInt32_t AliHLTDataBuffer::fgMargin=1024;
70 AliHLTLogging AliHLTDataBuffer::fgLogging;
71 const Int_t AliHLTDataBuffer::fgkSafetyPatternSize=16;
72 const char AliHLTDataBuffer::fgkSafetyPattern[]={0x28, 0x63, 0x29, 0x4d, 0x52, 0x49, 0x43, 0x48, 0x54, 0x45, 0x52, 0x20, 0x32, 0x30, 0x30, 0x37};
74 AliHLTDataBuffer::~AliHLTDataBuffer()
76 // see header file for function documentation
77 if (--fgNofInstances<=0) {
80 CleanupConsumerList();
83 int AliHLTDataBuffer::SetConsumer(AliHLTComponent* pConsumer)
85 // see header file for function documentation
88 if (FindConsumer(pConsumer)) {
89 HLTWarning("consumer %s (%p) already set to data buffer %p", pConsumer->GetComponentID(), pConsumer, this);
91 AliHLTConsumerDescriptor* pDesc=new AliHLTConsumerDescriptor(pConsumer);
93 fConsumers.push_back(pDesc);
94 HLTDebug("set consumer %s (%p) to data buffer %p", pConsumer->GetComponentID(), pConsumer, this);
96 HLTError("memory allocation failed");
100 HLTError("invalid parameter: consumer component (nil)");
106 int AliHLTDataBuffer::FindMatchingDataBlocks(const AliHLTComponent* pConsumer, vector<AliHLTComponentDataType>* tgtList)
108 // see header file for function documentation
111 vector<AliHLTDataBuffer::AliHLTDataSegment> segments;
112 if ((iResult=FindMatchingDataSegments(pConsumer, segments))>=0) {
114 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=segments.begin();
115 while (segment!=segments.end()) {
116 tgtList->push_back((*segment).fDataType);
120 iResult=segments.size();
128 int AliHLTDataBuffer::FindMatchingDataSegments(const AliHLTComponent* pConsumer, vector<AliHLTDataBuffer::AliHLTDataSegment>& tgtList)
130 // see header file for function documentation
133 // Matthias 26.09.2007 relax the restriction to matching data blocks
134 // all blocks are passed to the consumer, which is the policy also in
136 tgtList.assign(fSegments.begin(), fSegments.end());
137 iResult=tgtList.size();
141 vector<AliHLTComponentDataType> dtlist;
142 ((AliHLTComponent*)pConsumer)->GetInputDataTypes(dtlist);
143 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=fSegments.begin();
144 while (segment!=fSegments.end()) {
145 vector<AliHLTComponentDataType>::iterator type=dtlist.begin();
146 while (type!=dtlist.end()) {
147 if ((*segment).fDataType==(*type) ||
148 (*type)==kAliHLTAnyDataType) {
149 tgtList.push_back(*segment);
163 int AliHLTDataBuffer::Subscribe(const AliHLTComponent* pConsumer, AliHLTComponentBlockData* arrayBlockDesc, int iArraySize)
165 // see header file for function documentation
167 if (pConsumer && arrayBlockDesc) {
169 AliHLTConsumerDescriptor* pDesc=FindConsumer(pConsumer, fConsumers);
171 vector<AliHLTDataBuffer::AliHLTDataSegment> tgtList;
172 // Matthias 26.07.2007 AliHLTSystem should behave the same way as PubSub
173 // so it does not matter if there are matching data types or not, unless
174 // we implement such a check in PubSub
175 if ((iResult=FindMatchingDataSegments(pConsumer, tgtList))>=0) {
177 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=tgtList.begin();
178 while (segment!=tgtList.end() && i<iArraySize) {
179 // fill the block data descriptor
180 arrayBlockDesc[i].fStructSize=sizeof(AliHLTComponentBlockData);
181 // the shared memory key is not used in AliRoot
182 arrayBlockDesc[i].fShmKey.fStructSize=sizeof(AliHLTComponentShmData);
183 arrayBlockDesc[i].fShmKey.fShmType=gkAliHLTComponentInvalidShmType;
184 arrayBlockDesc[i].fShmKey.fShmID=gkAliHLTComponentInvalidShmID;
185 // This models the behavior of PubSub.
186 // For incoming data blocks, fOffset must be ignored by the
187 // processing component. It is set for bookkeeping in the framework.
188 // fPtr always points to the beginning of the data.
189 arrayBlockDesc[i].fOffset=(*segment).fSegmentOffset;
190 AliHLTUInt8_t* pTgt=*fpBuffer;
191 pTgt+=(*segment).fSegmentOffset;
192 arrayBlockDesc[i].fPtr=reinterpret_cast<void*>(pTgt);
193 arrayBlockDesc[i].fSize=(*segment).fSegmentSize;
194 arrayBlockDesc[i].fDataType=(*segment).fDataType;
195 arrayBlockDesc[i].fSpecification=(*segment).fSpecification;
196 pDesc->SetActiveDataSegment(arrayBlockDesc[i].fOffset, arrayBlockDesc[i].fSize);
197 HLTDebug("component %p (%s) subscribed to segment #%d offset %d size %d data type %s %#x",
198 pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID(), i, arrayBlockDesc[i].fOffset,
199 arrayBlockDesc[i].fSize, (AliHLTComponent::DataType2Text(arrayBlockDesc[i].fDataType)).c_str(),
200 arrayBlockDesc[i].fSpecification);
204 // check whether there was enough space for the segments
205 if (i!=(int)tgtList.size()) {
206 HLTError("too little space in block descriptor array: required %d, available %d", tgtList.size(), iArraySize);
209 // move this consumer to the active list
210 if (ChangeConsumerState(pDesc, fConsumers, fActiveConsumers)>=0) {
211 HLTDebug("component %p (%s) subscribed to data buffer %p", pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID(), this);
213 // TODO: cleanup the consumer descriptor correctly
214 memset(arrayBlockDesc, 0, iArraySize*sizeof(AliHLTComponentBlockData));
215 HLTError("can not activate consumer %p for data buffer %p", pConsumer, this);
220 HLTError("unresolved data segment(s) for component %p (%s)", pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID());
224 HLTError("component %p is not a data consumer of data buffer %s", pConsumer, this);
228 // Matthias 26.07.2007 until now, data had to be present for successful subscription
229 // in order to be consistent with the PubSub framework, this restiction has been
231 //HLTError("data buffer %p is empty", this);
235 HLTError("invalid parameter");
241 int AliHLTDataBuffer::Release(AliHLTComponentBlockData* pBlockDesc, const AliHLTComponent* pConsumer)
243 // see header file for function documentation
245 if (pBlockDesc && pConsumer) {
246 AliHLTConsumerDescriptor* pDesc=FindConsumer(pConsumer, fActiveConsumers);
248 if ((iResult=pDesc->CheckActiveDataSegment(pBlockDesc->fOffset, pBlockDesc->fSize))!=1) {
249 HLTWarning("data segment missmatch, component %p has not subscribed to a segment with offset %#x and size %d", pConsumer, pBlockDesc->fOffset, pBlockDesc->fSize);
250 // TODO: appropriate error handling, but so far optional
253 pDesc->ReleaseActiveDataSegment(pBlockDesc->fOffset, pBlockDesc->fSize);
254 pBlockDesc->fOffset=0;
255 pBlockDesc->fPtr=NULL;
258 if (pDesc->GetNofActiveSegments()==0) {
259 if ((iResult=ChangeConsumerState(pDesc, fActiveConsumers, fReleasedConsumers))>=0) {
260 if (GetNofActiveConsumers()==0 && GetNofPendingConsumers()==0) {
261 // this is the last consumer, reset the consumer list and release the raw buffer
265 HLTError("can not deactivate consumer %p for data buffer %p", pConsumer, this);
270 HLTWarning("component %p has currently not subscribed to the data buffer %p", pConsumer, this);
274 HLTError("inavalid parameter: pBlockDesc=%p pConsumer=%p", pBlockDesc, pConsumer);
280 AliHLTUInt8_t* AliHLTDataBuffer::GetTargetBuffer(int iMinSize)
282 // see header file for function documentation
283 AliHLTUInt8_t* pTargetBuffer=NULL;
284 if (fpBuffer!=NULL) {
285 HLTWarning("data buffer not properly reset, possible memory leak\n");
287 fpBuffer=CreateRawBuffer(iMinSize);
289 pTargetBuffer=*fpBuffer;
291 HLTError("can not create raw buffer");
293 return pTargetBuffer;
296 int AliHLTDataBuffer::SetSegments(AliHLTUInt8_t* pTgt, AliHLTComponentBlockData* arrayBlockData, int iSize)
298 // see header file for function documentation
300 if (pTgt && arrayBlockData && iSize>=0) {
302 if (*fpBuffer==pTgt) {
303 AliHLTDataBuffer::AliHLTDataSegment segment;
304 for (int i=0; i<iSize; i++) {
305 // This function has to model the behavior of PubSub
306 // For output blocks only the fOffset value is used, this must be the offset
307 // relative to the output pointer. fPtr must be either NULL or the output
309 if (arrayBlockData[i].fPtr==NULL ||
310 arrayBlockData[i].fPtr==*fpBuffer) {
311 if (arrayBlockData[i].fOffset+arrayBlockData[i].fSize<=fpBuffer->fSize) {
312 segment.fSegmentOffset=arrayBlockData[i].fOffset;
313 segment.fSegmentSize=arrayBlockData[i].fSize;
314 segment.fDataType=arrayBlockData[i].fDataType;
315 segment.fSpecification=arrayBlockData[i].fSpecification;
316 fSegments.push_back(segment);
317 HLTDebug("set segment %s with size %d at offset %d", AliHLTComponent::DataType2Text(segment.fDataType).data(), segment.fSegmentSize, segment.fSegmentOffset);
319 HLTError("block data specification %#d (%s) exceeds size of data buffer", i, AliHLTComponent::DataType2Text(arrayBlockData[i].fDataType).data());
320 HLTError("block offset=%d, block size=%d, buffer size=%d", arrayBlockData[i].fOffset, arrayBlockData[i].fSize, fpBuffer->fSize);
324 HLTError("invalid pointer (%p) in block data specification (buffer %p size %d)."
325 "please note: for output blocks only the fOffset value is valid and must "
326 "be relative to the output buffer", arrayBlockData[i].fPtr, fpBuffer->fPtr, fpBuffer->fSize);
331 HLTError("this data buffer (%p) does not match the internal data buffer %p of raw buffer %p", pTgt, fpBuffer->fPtr, fpBuffer);
335 HLTFatal("internal data structur missmatch");
339 HLTError("invalid parameter: pTgtBuffer=%p arrayBlockData=%p", pTgt, arrayBlockData);
345 int AliHLTDataBuffer::IsEmpty()
347 // see header file for function documentation
348 int iResult=fpBuffer==NULL || GetNofSegments()==0;
352 int AliHLTDataBuffer::GetNofSegments()
354 // see header file for function documentation
355 int iResult=fSegments.size();
359 int AliHLTDataBuffer::GetNofConsumers()
361 // see header file for function documentation
362 int iResult=fConsumers.size() + GetNofActiveConsumers() + fReleasedConsumers.size();
366 int AliHLTDataBuffer::GetNofPendingConsumers()
368 // see header file for function documentation
369 int iResult=fConsumers.size();
373 int AliHLTDataBuffer::GetNofActiveConsumers()
375 // see header file for function documentation
376 int iResult=fActiveConsumers.size();
380 AliHLTDataBuffer::AliHLTRawBuffer* AliHLTDataBuffer::CreateRawBuffer(AliHLTUInt32_t size)
382 // see header file for function documentation
383 AliHLTRawBuffer* pRawBuffer=NULL;
384 unsigned int reqSize=size+fgkSafetyPatternSize;
385 vector<AliHLTRawBuffer*>::iterator buffer=fgFreeBuffers.begin();
386 while (buffer!=fgFreeBuffers.end() && pRawBuffer==NULL) {
387 if ((*buffer)->fTotalSize>=reqSize && ((*buffer)->fTotalSize-reqSize)<fgMargin) {
388 // assign this element
390 pRawBuffer->fSize=size;
391 fgFreeBuffers.erase(buffer);
392 fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "raw buffer container %p provided for request of %d bytes (total %d available in buffer %p)", pRawBuffer, size, pRawBuffer->fTotalSize, pRawBuffer->fPtr);
393 fgActiveBuffers.push_back(pRawBuffer);
398 if (pRawBuffer==NULL) {
399 // no buffer found, create a new one
400 pRawBuffer=new AliHLTRawBuffer;
402 pRawBuffer->fPtr=static_cast<AliHLTUInt8_t*>(malloc(reqSize));
403 if (pRawBuffer->fPtr) {
404 pRawBuffer->fSize=size;
405 pRawBuffer->fTotalSize=reqSize;
406 fgActiveBuffers.push_back(pRawBuffer);
407 fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "new raw buffer %p of size %d created (container %p)", pRawBuffer->fPtr, pRawBuffer->fTotalSize, pRawBuffer);
411 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "memory allocation failed");
414 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "memory allocation failed");
417 if (pRawBuffer!=NULL && fgkSafetyPatternSize>0) {
418 //fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "writing safety pattern to %p offset %d", pRawBuffer->fPtr, pRawBuffer->fSize);
419 memcpy(((char*)pRawBuffer->fPtr)+pRawBuffer->fSize, fgkSafetyPattern, fgkSafetyPatternSize);
424 int AliHLTDataBuffer::ReleaseRawBuffer(AliHLTRawBuffer* pBuffer)
426 // see header file for function documentation
429 vector<AliHLTRawBuffer*>::iterator buffer=fgActiveBuffers.begin();
430 while (buffer!=fgActiveBuffers.end() && (*buffer)!=pBuffer) {
433 if (buffer!=fgActiveBuffers.end()) {
434 if (fgkSafetyPatternSize>0) {
435 //fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "comparing safety pattern at %p offset %d", (*buffer)->fPtr, (*buffer)->fSize);
436 if (memcmp(((char*)(*buffer)->fPtr)+(*buffer)->fSize, fgkSafetyPattern, fgkSafetyPatternSize)!=0) {
437 fgLogging.Logging(kHLTLogFatal, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "component has written beyond end of data buffer %p size %d", (*buffer)->fPtr, (*buffer)->fSize);
441 fgFreeBuffers.push_back(*buffer);
442 fgActiveBuffers.erase(buffer);
444 fgLogging.Logging(kHLTLogWarning, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "can not find raw buffer container %p in the list of active containers", pBuffer);
448 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "invalid parameter");
455 int AliHLTDataBuffer::DeleteRawBuffers()
457 // see header file for function documentation
459 vector<AliHLTRawBuffer*>::iterator buffer=fgFreeBuffers.begin();
460 while (buffer!=fgFreeBuffers.end()) {
461 free((*buffer)->fPtr);
463 fgFreeBuffers.erase(buffer);
464 buffer=fgFreeBuffers.begin();
466 buffer=fgActiveBuffers.begin();
467 while (buffer!=fgActiveBuffers.end()) {
468 fgLogging.Logging(kHLTLogWarning, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "request to delete active raw buffer container (raw buffer %p, size %d)", (*buffer)->fPtr, (*buffer)->fTotalSize);
469 free((*buffer)->fPtr);
471 fgActiveBuffers.erase(buffer);
472 buffer=fgActiveBuffers.begin();
477 AliHLTConsumerDescriptor* AliHLTDataBuffer::FindConsumer(const AliHLTComponent* pConsumer, vector<AliHLTConsumerDescriptor*> &list) const
479 // see header file for function documentation
480 AliHLTConsumerDescriptor* pDesc=NULL;
481 vector<AliHLTConsumerDescriptor*>::iterator desc=list.begin();
482 while (desc!=list.end() && pDesc==NULL) {
483 if ((pConsumer==NULL || (*desc)->GetComponent()==pConsumer)) {
491 int AliHLTDataBuffer::ResetDataBuffer()
493 // see header file for function documentation
495 AliHLTRawBuffer* pBuffer=fpBuffer;
498 // cleanup consumer states
499 vector<AliHLTConsumerDescriptor*>::iterator desc;
500 // if (GetNofPendingConsumers()>0) {
501 // desc=fConsumers.begin();
502 // while (desc!=fConsumers.end()) {
503 // AliHLTComponent* pComp=(*desc)->GetComponent();
504 // HLTError("internal error: consumer %p (%s %p) did not get data from data buffer %p", *desc, pComp?pComp->GetComponentID():"", pComp, this);
508 desc=fReleasedConsumers.begin();
509 while (desc!=fReleasedConsumers.end()) {
510 AliHLTConsumerDescriptor* pDesc=*desc;
511 fReleasedConsumers.erase(desc);
512 desc=fReleasedConsumers.begin();
513 fConsumers.push_back(pDesc);
515 desc=fActiveConsumers.begin();
516 while (desc!=fActiveConsumers.end()) {
517 AliHLTConsumerDescriptor* pDesc=*desc;
518 HLTWarning("consumer %p was not released", pDesc);
519 fActiveConsumers.erase(desc);
520 desc=fActiveConsumers.begin();
521 fConsumers.push_back(pDesc);
525 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=fSegments.begin();
526 while (segment!=fSegments.end()) {
527 fSegments.erase(segment);
528 segment=fSegments.begin();
531 // cleanup raw buffer
533 ReleaseRawBuffer(pBuffer);
538 int AliHLTDataBuffer::Reset()
540 // see header file for function documentation
541 return ResetDataBuffer();
544 // this is the version which works on lists of components instead of consumer descriptors
545 // int AliHLTDataBuffer::ChangeConsumerState(AliHLTComponent* pConsumer, vector<AliHLTComponent*> &srcList, vector<AliHLTComponent*> &tgtList)
549 // vector<AliHLTComponent*>::iterator desc=srcList.begin();
550 // while (desc!=srcList.end()) {
551 // if ((*desc)==pConsumer) {
552 // srcList.erase(desc);
553 // tgtList.push_back(pConsumer);
558 // if (desc==srcList.end()) {
559 // HLTError("can not find consumer component %p in list", pConsumer);
563 // HLTError("invalid parameter");
569 int AliHLTDataBuffer::ChangeConsumerState(AliHLTConsumerDescriptor* pDesc, vector<AliHLTConsumerDescriptor*> &srcList, vector<AliHLTConsumerDescriptor*> &tgtList)
571 // see header file for function documentation
574 vector<AliHLTConsumerDescriptor*>::iterator desc=srcList.begin();
575 while (desc!=srcList.end()) {
576 if ((*desc)==pDesc) {
578 tgtList.push_back(pDesc);
585 HLTError("can not find consumer descriptor %p in list", pDesc);
588 HLTError("invalid parameter");
594 int AliHLTDataBuffer::CleanupConsumerList()
596 // see header file for function documentation
599 vector<AliHLTConsumerDescriptor*>::iterator desc=fConsumers.begin();
600 while (desc!=fConsumers.end()) {
602 fConsumers.erase(desc);
603 desc=fConsumers.begin();
608 int AliHLTDataBuffer::FindConsumer(AliHLTComponent* pConsumer, int bAllLists)
610 // see header file for function documentation
611 vector<AliHLTConsumerDescriptor*>::iterator desc=fConsumers.begin();
612 while (desc!=fConsumers.end()) {
613 if ((*desc)->GetComponent()==pConsumer)
617 if (bAllLists==0) return 0;
619 desc=fActiveConsumers.begin();
620 while (desc!=fActiveConsumers.end()) {
621 if ((*desc)->GetComponent()==pConsumer)
625 desc=fReleasedConsumers.begin();
626 while (desc!=fReleasedConsumers.end()) {
627 if ((*desc)->GetComponent()==pConsumer)
634 int AliHLTDataBuffer::AliHLTRawBuffer::operator==(void* ptr)
636 return fPtr == static_cast<AliHLTUInt8_t*>(ptr);
639 int AliHLTDataBuffer::AliHLTRawBuffer::operator<=(void* ptr)
641 int iResult=fPtr <= static_cast<AliHLTUInt8_t*>(ptr);
642 //printf("%p: %p <= %p (%d)\n", this, fPtr, ptr, iResult);
646 int AliHLTDataBuffer::AliHLTRawBuffer::operator>(void* ptr)
648 int iResult=fPtr+fSize > static_cast<AliHLTUInt8_t*>(ptr);
649 //printf("%p: %p + %d > %p (%d)\n", this, fPtr, fSize, ptr, iResult);
653 int AliHLTDataBuffer::AliHLTRawBuffer::operator-(void* ptr)
655 return static_cast<int>(static_cast<AliHLTUInt8_t*>(ptr)-fPtr);