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 arrayBlockDesc[i].fOffset=(*segment).fSegmentOffset;
186 arrayBlockDesc[i].fPtr=*fpBuffer;
187 arrayBlockDesc[i].fSize=(*segment).fSegmentSize;
188 arrayBlockDesc[i].fDataType=(*segment).fDataType;
189 arrayBlockDesc[i].fSpecification=(*segment).fSpecification;
190 pDesc->SetActiveDataSegment(arrayBlockDesc[i].fOffset, arrayBlockDesc[i].fSize);
191 HLTDebug("component %p (%s) subscribed to segment #%d offset %d size %d data type %s %#x",
192 pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID(), i, arrayBlockDesc[i].fOffset,
193 arrayBlockDesc[i].fSize, (AliHLTComponent::DataType2Text(arrayBlockDesc[i].fDataType)).c_str(),
194 arrayBlockDesc[i].fSpecification);
198 // check whether there was enough space for the segments
199 if (i!=(int)tgtList.size()) {
200 HLTError("too little space in block descriptor array: required %d, available %d", tgtList.size(), iArraySize);
203 // move this consumer to the active list
204 if (ChangeConsumerState(pDesc, fConsumers, fActiveConsumers)>=0) {
205 HLTDebug("component %p (%s) subscribed to data buffer %p", pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID(), this);
207 // TODO: cleanup the consumer descriptor correctly
208 memset(arrayBlockDesc, 0, iArraySize*sizeof(AliHLTComponentBlockData));
209 HLTError("can not activate consumer %p for data buffer %p", pConsumer, this);
214 HLTError("unresolved data segment(s) for component %p (%s)", pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID());
218 HLTError("component %p is not a data consumer of data buffer %s", pConsumer, this);
222 // Matthias 26.07.2007 until now, data had to be present for successful subscription
223 // in order to be consistent with the PubSub framework, this restiction has been
225 //HLTError("data buffer %p is empty", this);
229 HLTError("invalid parameter");
235 int AliHLTDataBuffer::Release(AliHLTComponentBlockData* pBlockDesc, const AliHLTComponent* pConsumer)
237 // see header file for function documentation
239 if (pBlockDesc && pConsumer) {
240 AliHLTConsumerDescriptor* pDesc=FindConsumer(pConsumer, fActiveConsumers);
242 if ((iResult=pDesc->CheckActiveDataSegment(pBlockDesc->fOffset, pBlockDesc->fSize))!=1) {
243 HLTWarning("data segment missmatch, component %p has not subscribed to a segment with offset %#x and size %d", pConsumer, pBlockDesc->fOffset, pBlockDesc->fSize);
244 // TODO: appropriate error handling, but so far optional
247 pDesc->ReleaseActiveDataSegment(pBlockDesc->fOffset, pBlockDesc->fSize);
248 pBlockDesc->fOffset=0;
249 pBlockDesc->fPtr=NULL;
252 if (pDesc->GetNofActiveSegments()==0) {
253 if ((iResult=ChangeConsumerState(pDesc, fActiveConsumers, fReleasedConsumers))>=0) {
254 if (GetNofActiveConsumers()==0 && GetNofPendingConsumers()==0) {
255 // this is the last consumer, reset the consumer list and release the raw buffer
259 HLTError("can not deactivate consumer %p for data buffer %p", pConsumer, this);
264 HLTWarning("component %p has currently not subscribed to the data buffer %p", pConsumer, this);
268 HLTError("inavalid parameter: pBlockDesc=%p pConsumer=%p", pBlockDesc, pConsumer);
274 AliHLTUInt8_t* AliHLTDataBuffer::GetTargetBuffer(int iMinSize)
276 // see header file for function documentation
277 AliHLTUInt8_t* pTargetBuffer=NULL;
278 if (fpBuffer!=NULL) {
279 HLTWarning("data buffer not properly reset, possible memory leak\n");
281 fpBuffer=CreateRawBuffer(iMinSize);
283 pTargetBuffer=*fpBuffer;
285 HLTError("can not create raw buffer");
287 return pTargetBuffer;
290 int AliHLTDataBuffer::SetSegments(AliHLTUInt8_t* pTgt, AliHLTComponentBlockData* arrayBlockData, int iSize)
292 // see header file for function documentation
294 if (pTgt && arrayBlockData && iSize>=0) {
296 if (*fpBuffer==pTgt) {
297 AliHLTDataBuffer::AliHLTDataSegment segment;
298 for (int i=0; i<iSize; i++) {
299 // the pointer can be either NULL, than only the offset is considered, or a valid
300 // pointer in the range of the buffer
301 // The operator '>' includes the size of the buffer
302 if (arrayBlockData[i].fPtr==NULL ||
303 ((*fpBuffer)<=arrayBlockData[i].fPtr && (*fpBuffer)>arrayBlockData[i].fPtr)) {
305 if (arrayBlockData[i].fPtr!=NULL) {
306 ptrOffset=(*fpBuffer)-arrayBlockData[i].fPtr;
308 if (arrayBlockData[i].fOffset+ptrOffset+arrayBlockData[i].fSize<=fpBuffer->fSize) {
309 segment.fSegmentOffset=arrayBlockData[i].fOffset+ptrOffset;
310 segment.fSegmentSize=arrayBlockData[i].fSize;
311 segment.fDataType=arrayBlockData[i].fDataType;
312 segment.fSpecification=arrayBlockData[i].fSpecification;
313 fSegments.push_back(segment);
314 HLTDebug("set segment %s with size %d at offset %d", AliHLTComponent::DataType2Text(segment.fDataType).data(), segment.fSegmentSize, segment.fSegmentOffset);
316 HLTError("block data specification %#d (%s) exceeds size of data buffer", i, AliHLTComponent::DataType2Text(arrayBlockData[i].fDataType).data());
317 HLTError("block offset=%d, block size=%d, buffer size=%d", arrayBlockData[i].fOffset, arrayBlockData[i].fSize, fpBuffer->fSize);
321 HLTError("invalid pointer (%p) in block data specification (buffer %p size %d)", arrayBlockData[i].fPtr, fpBuffer->fPtr, fpBuffer->fSize);
326 HLTError("this data buffer (%p) does not match the internal data buffer %p of raw buffer %p", pTgt, fpBuffer->fPtr, fpBuffer);
330 HLTFatal("internal data structur missmatch");
334 HLTError("invalid parameter: pTgtBuffer=%p arrayBlockData=%p", pTgt, arrayBlockData);
340 int AliHLTDataBuffer::IsEmpty()
342 // see header file for function documentation
343 int iResult=fpBuffer==NULL || GetNofSegments()==0;
347 int AliHLTDataBuffer::GetNofSegments()
349 // see header file for function documentation
350 int iResult=fSegments.size();
354 int AliHLTDataBuffer::GetNofConsumers()
356 // see header file for function documentation
357 int iResult=fConsumers.size() + GetNofActiveConsumers() + fReleasedConsumers.size();
361 int AliHLTDataBuffer::GetNofPendingConsumers()
363 // see header file for function documentation
364 int iResult=fConsumers.size();
368 int AliHLTDataBuffer::GetNofActiveConsumers()
370 // see header file for function documentation
371 int iResult=fActiveConsumers.size();
375 AliHLTDataBuffer::AliHLTRawBuffer* AliHLTDataBuffer::CreateRawBuffer(AliHLTUInt32_t size)
377 // see header file for function documentation
378 AliHLTRawBuffer* pRawBuffer=NULL;
379 unsigned int reqSize=size+fgkSafetyPatternSize;
380 vector<AliHLTRawBuffer*>::iterator buffer=fgFreeBuffers.begin();
381 while (buffer!=fgFreeBuffers.end() && pRawBuffer==NULL) {
382 if ((*buffer)->fTotalSize>=reqSize && ((*buffer)->fTotalSize-reqSize)<fgMargin) {
383 // assign this element
385 pRawBuffer->fSize=size;
386 fgFreeBuffers.erase(buffer);
387 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);
388 fgActiveBuffers.push_back(pRawBuffer);
393 if (pRawBuffer==NULL) {
394 // no buffer found, create a new one
395 pRawBuffer=new AliHLTRawBuffer;
397 pRawBuffer->fPtr=static_cast<AliHLTUInt8_t*>(malloc(reqSize));
398 if (pRawBuffer->fPtr) {
399 pRawBuffer->fSize=size;
400 pRawBuffer->fTotalSize=reqSize;
401 fgActiveBuffers.push_back(pRawBuffer);
402 fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "new raw buffer %p of size %d created (container %p)", pRawBuffer->fPtr, pRawBuffer->fTotalSize, pRawBuffer);
406 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "memory allocation failed");
409 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "memory allocation failed");
412 if (pRawBuffer!=NULL && fgkSafetyPatternSize>0) {
413 //fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "writing safety pattern to %p offset %d", pRawBuffer->fPtr, pRawBuffer->fSize);
414 memcpy(((char*)pRawBuffer->fPtr)+pRawBuffer->fSize, fgkSafetyPattern, fgkSafetyPatternSize);
419 int AliHLTDataBuffer::ReleaseRawBuffer(AliHLTRawBuffer* pBuffer)
421 // see header file for function documentation
424 vector<AliHLTRawBuffer*>::iterator buffer=fgActiveBuffers.begin();
425 while (buffer!=fgActiveBuffers.end() && (*buffer)!=pBuffer) {
428 if (buffer!=fgActiveBuffers.end()) {
429 if (fgkSafetyPatternSize>0) {
430 //fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "comparing safety pattern at %p offset %d", (*buffer)->fPtr, (*buffer)->fSize);
431 if (memcmp(((char*)(*buffer)->fPtr)+(*buffer)->fSize, fgkSafetyPattern, fgkSafetyPatternSize)!=0) {
432 fgLogging.Logging(kHLTLogFatal, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "component has written beyond end of data buffer %p size %d", (*buffer)->fPtr, (*buffer)->fSize);
436 fgFreeBuffers.push_back(*buffer);
437 fgActiveBuffers.erase(buffer);
439 fgLogging.Logging(kHLTLogWarning, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "can not find raw buffer container %p in the list of active containers", pBuffer);
443 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "invalid parameter");
450 int AliHLTDataBuffer::DeleteRawBuffers()
452 // see header file for function documentation
454 vector<AliHLTRawBuffer*>::iterator buffer=fgFreeBuffers.begin();
455 while (buffer!=fgFreeBuffers.end()) {
456 free((*buffer)->fPtr);
458 fgFreeBuffers.erase(buffer);
459 buffer=fgFreeBuffers.begin();
461 buffer=fgActiveBuffers.begin();
462 while (buffer!=fgActiveBuffers.end()) {
463 fgLogging.Logging(kHLTLogWarning, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "request to delete active raw buffer container (raw buffer %p, size %d)", (*buffer)->fPtr, (*buffer)->fTotalSize);
464 free((*buffer)->fPtr);
466 fgActiveBuffers.erase(buffer);
467 buffer=fgActiveBuffers.begin();
472 AliHLTConsumerDescriptor* AliHLTDataBuffer::FindConsumer(const AliHLTComponent* pConsumer, vector<AliHLTConsumerDescriptor*> &list) const
474 // see header file for function documentation
475 AliHLTConsumerDescriptor* pDesc=NULL;
476 vector<AliHLTConsumerDescriptor*>::iterator desc=list.begin();
477 while (desc!=list.end() && pDesc==NULL) {
478 if ((pConsumer==NULL || (*desc)->GetComponent()==pConsumer)) {
486 int AliHLTDataBuffer::ResetDataBuffer()
488 // see header file for function documentation
490 AliHLTRawBuffer* pBuffer=fpBuffer;
493 // cleanup consumer states
494 vector<AliHLTConsumerDescriptor*>::iterator desc;
495 // if (GetNofPendingConsumers()>0) {
496 // desc=fConsumers.begin();
497 // while (desc!=fConsumers.end()) {
498 // AliHLTComponent* pComp=(*desc)->GetComponent();
499 // HLTError("internal error: consumer %p (%s %p) did not get data from data buffer %p", *desc, pComp?pComp->GetComponentID():"", pComp, this);
503 desc=fReleasedConsumers.begin();
504 while (desc!=fReleasedConsumers.end()) {
505 AliHLTConsumerDescriptor* pDesc=*desc;
506 fReleasedConsumers.erase(desc);
507 desc=fReleasedConsumers.begin();
508 fConsumers.push_back(pDesc);
510 desc=fActiveConsumers.begin();
511 while (desc!=fActiveConsumers.end()) {
512 AliHLTConsumerDescriptor* pDesc=*desc;
513 HLTWarning("consumer %p was not released", pDesc);
514 fActiveConsumers.erase(desc);
515 desc=fActiveConsumers.begin();
516 fConsumers.push_back(pDesc);
520 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=fSegments.begin();
521 while (segment!=fSegments.end()) {
522 fSegments.erase(segment);
523 segment=fSegments.begin();
526 // cleanup raw buffer
528 ReleaseRawBuffer(pBuffer);
533 int AliHLTDataBuffer::Reset()
535 // see header file for function documentation
536 return ResetDataBuffer();
539 // this is the version which works on lists of components instead of consumer descriptors
540 // int AliHLTDataBuffer::ChangeConsumerState(AliHLTComponent* pConsumer, vector<AliHLTComponent*> &srcList, vector<AliHLTComponent*> &tgtList)
544 // vector<AliHLTComponent*>::iterator desc=srcList.begin();
545 // while (desc!=srcList.end()) {
546 // if ((*desc)==pConsumer) {
547 // srcList.erase(desc);
548 // tgtList.push_back(pConsumer);
553 // if (desc==srcList.end()) {
554 // HLTError("can not find consumer component %p in list", pConsumer);
558 // HLTError("invalid parameter");
564 int AliHLTDataBuffer::ChangeConsumerState(AliHLTConsumerDescriptor* pDesc, vector<AliHLTConsumerDescriptor*> &srcList, vector<AliHLTConsumerDescriptor*> &tgtList)
566 // see header file for function documentation
569 vector<AliHLTConsumerDescriptor*>::iterator desc=srcList.begin();
570 while (desc!=srcList.end()) {
571 if ((*desc)==pDesc) {
573 tgtList.push_back(pDesc);
580 HLTError("can not find consumer descriptor %p in list", pDesc);
583 HLTError("invalid parameter");
589 int AliHLTDataBuffer::CleanupConsumerList()
591 // see header file for function documentation
594 vector<AliHLTConsumerDescriptor*>::iterator desc=fConsumers.begin();
595 while (desc!=fConsumers.end()) {
597 fConsumers.erase(desc);
598 desc=fConsumers.begin();
603 int AliHLTDataBuffer::FindConsumer(AliHLTComponent* pConsumer, int bAllLists)
605 // see header file for function documentation
606 vector<AliHLTConsumerDescriptor*>::iterator desc=fConsumers.begin();
607 while (desc!=fConsumers.end()) {
608 if ((*desc)->GetComponent()==pConsumer)
612 if (bAllLists==0) return 0;
614 desc=fActiveConsumers.begin();
615 while (desc!=fActiveConsumers.end()) {
616 if ((*desc)->GetComponent()==pConsumer)
620 desc=fReleasedConsumers.begin();
621 while (desc!=fReleasedConsumers.end()) {
622 if ((*desc)->GetComponent()==pConsumer)
629 int AliHLTDataBuffer::AliHLTRawBuffer::operator==(void* ptr)
631 return fPtr == static_cast<AliHLTUInt8_t*>(ptr);
634 int AliHLTDataBuffer::AliHLTRawBuffer::operator<=(void* ptr)
636 int iResult=fPtr <= static_cast<AliHLTUInt8_t*>(ptr);
637 //printf("%p: %p <= %p (%d)\n", this, fPtr, ptr, iResult);
641 int AliHLTDataBuffer::AliHLTRawBuffer::operator>(void* ptr)
643 int iResult=fPtr+fSize > static_cast<AliHLTUInt8_t*>(ptr);
644 //printf("%p: %p + %d > %p (%d)\n", this, fPtr, fSize, ptr, iResult);
648 int AliHLTDataBuffer::AliHLTRawBuffer::operator-(void* ptr)
650 return static_cast<int>(static_cast<AliHLTUInt8_t*>(ptr)-fPtr);