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 AliHLTDataBuffer::AliHLTDataBuffer(const AliHLTDataBuffer&)
77 // see header file for function documentation
78 HLTFatal("copy constructor untested");
81 AliHLTDataBuffer& AliHLTDataBuffer::operator=(const AliHLTDataBuffer&)
83 // see header file for function documentation
84 HLTFatal("assignment operator untested");
88 int AliHLTDataBuffer::fgNofInstances=0;
89 vector<AliHLTDataBuffer::AliHLTRawBuffer*> AliHLTDataBuffer::fgFreeBuffers;
90 vector<AliHLTDataBuffer::AliHLTRawBuffer*> AliHLTDataBuffer::fgActiveBuffers;
91 AliHLTUInt32_t AliHLTDataBuffer::fgMargin=1024;
92 AliHLTLogging AliHLTDataBuffer::fgLogging;
93 const Int_t AliHLTDataBuffer::fgkSafetyPatternSize=16;
94 const char AliHLTDataBuffer::fgkSafetyPattern[]={0x28, 0x63, 0x29, 0x4d, 0x52, 0x49, 0x43, 0x48, 0x54, 0x45, 0x52, 0x20, 0x32, 0x30, 0x30, 0x37};
96 AliHLTDataBuffer::~AliHLTDataBuffer()
98 // see header file for function documentation
99 if (--fgNofInstances<=0) {
102 CleanupConsumerList();
105 int AliHLTDataBuffer::SetConsumer(AliHLTComponent* pConsumer)
107 // see header file for function documentation
110 if (FindConsumer(pConsumer)) {
111 HLTWarning("consumer %s (%p) already set to data buffer %p", pConsumer->GetComponentID(), pConsumer, this);
113 AliHLTConsumerDescriptor* pDesc=new AliHLTConsumerDescriptor(pConsumer);
115 fConsumers.push_back(pDesc);
116 HLTDebug("set consumer %s (%p) to data buffer %p", pConsumer->GetComponentID(), pConsumer, this);
118 HLTError("memory allocation failed");
122 HLTError("invalid parameter: consumer component (nil)");
128 int AliHLTDataBuffer::FindMatchingDataBlocks(const AliHLTComponent* pConsumer, vector<AliHLTComponentDataType>* tgtList)
130 // see header file for function documentation
133 vector<AliHLTDataBuffer::AliHLTDataSegment> segments;
134 if ((iResult=FindMatchingDataSegments(pConsumer, segments))>=0) {
136 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=segments.begin();
137 while (segment!=segments.end()) {
138 tgtList->push_back((*segment).fDataType);
142 iResult=segments.size();
150 int AliHLTDataBuffer::FindMatchingDataSegments(const AliHLTComponent* pConsumer, vector<AliHLTDataBuffer::AliHLTDataSegment>& tgtList)
152 // see header file for function documentation
155 vector<AliHLTComponentDataType> dtlist;
156 ((AliHLTComponent*)pConsumer)->GetInputDataTypes(dtlist);
157 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=fSegments.begin();
158 while (segment!=fSegments.end()) {
159 vector<AliHLTComponentDataType>::iterator type=dtlist.begin();
160 while (type!=dtlist.end()) {
161 if ((*segment).fDataType==(*type) ||
162 (*type)==kAliHLTAnyDataType) {
163 tgtList.push_back(*segment);
177 int AliHLTDataBuffer::Subscribe(const AliHLTComponent* pConsumer, AliHLTComponentBlockData* arrayBlockDesc, int iArraySize)
179 // see header file for function documentation
181 if (pConsumer && arrayBlockDesc) {
183 AliHLTConsumerDescriptor* pDesc=FindConsumer(pConsumer, fConsumers);
185 vector<AliHLTDataBuffer::AliHLTDataSegment> tgtList;
186 /* TODO: think about a good policy for this check
187 * is it enough that at least one segment is available, or have all to be available?
188 * or is it possible to have optional segments?
190 if ((iResult=FindMatchingDataSegments(pConsumer, tgtList))>0) {
192 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=tgtList.begin();
193 while (segment!=tgtList.end() && i<iArraySize) {
194 // fill the block data descriptor
195 arrayBlockDesc[i].fStructSize=sizeof(AliHLTComponentBlockData);
196 // the shared memory key is not used in AliRoot
197 arrayBlockDesc[i].fShmKey.fStructSize=sizeof(AliHLTComponentShmData);
198 arrayBlockDesc[i].fShmKey.fShmType=gkAliHLTComponentInvalidShmType;
199 arrayBlockDesc[i].fShmKey.fShmID=gkAliHLTComponentInvalidShmID;
200 arrayBlockDesc[i].fOffset=(*segment).fSegmentOffset;
201 arrayBlockDesc[i].fPtr=fpBuffer->fPtr;
202 arrayBlockDesc[i].fSize=(*segment).fSegmentSize;
203 arrayBlockDesc[i].fDataType=(*segment).fDataType;
204 arrayBlockDesc[i].fSpecification=(*segment).fSpecification;
205 pDesc->SetActiveDataSegment(arrayBlockDesc[i].fOffset, arrayBlockDesc[i].fSize);
206 HLTDebug("component %p (%s) subscribed to segment #%d offset %d", pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID(), i, arrayBlockDesc[i].fOffset);
210 // move this consumer to the active list
211 if (ChangeConsumerState(pDesc, fConsumers, fActiveConsumers)>=0) {
212 HLTDebug("component %p (%s) subscribed to data buffer %p", pConsumer, ((AliHLTComponent*)pConsumer)->GetComponentID(), this);
214 // TODO: cleanup the consumer descriptor correctly
215 memset(arrayBlockDesc, 0, iArraySize*sizeof(AliHLTComponentBlockData));
216 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 HLTError("data buffer %p is empty", this);
232 HLTError("invalid parameter");
238 int AliHLTDataBuffer::Release(AliHLTComponentBlockData* pBlockDesc, const AliHLTComponent* pConsumer)
240 // see header file for function documentation
242 if (pBlockDesc && pConsumer) {
243 AliHLTConsumerDescriptor* pDesc=FindConsumer(pConsumer, fActiveConsumers);
245 if ((iResult=pDesc->CheckActiveDataSegment(pBlockDesc->fOffset, pBlockDesc->fSize))!=1) {
246 HLTWarning("data segment missmatch, component %p has not subscribed to a segment with offset %#x and size %d", pConsumer, pBlockDesc->fOffset, pBlockDesc->fSize);
247 // TODO: appropriate error handling, but so far optional
250 pDesc->ReleaseActiveDataSegment(pBlockDesc->fOffset, pBlockDesc->fSize);
251 pBlockDesc->fOffset=0;
252 pBlockDesc->fPtr=NULL;
255 if (pDesc->GetNofActiveSegments()==0) {
256 if ((iResult=ChangeConsumerState(pDesc, fActiveConsumers, fReleasedConsumers))>=0) {
257 if (GetNofActiveConsumers()==0) {
258 // this is the last consumer, reset the consumer list and release the raw buffer
262 HLTError("can not deactivate consumer %p for data buffer %p", pConsumer, this);
267 HLTWarning("component %p has currently not subscribed to the data buffer %p", pConsumer, this);
271 HLTError("inavalid parameter: pBlockDesc=%p pConsumer=%p", pBlockDesc, pConsumer);
277 AliHLTUInt8_t* AliHLTDataBuffer::GetTargetBuffer(int iMinSize)
279 // see header file for function documentation
280 AliHLTUInt8_t* pTargetBuffer=NULL;
281 fpBuffer=CreateRawBuffer(iMinSize);
283 pTargetBuffer=(AliHLTUInt8_t*)fpBuffer->fPtr;
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->fPtr==(void*)pTgt) {
297 AliHLTDataBuffer::AliHLTDataSegment segment;
298 for (int i=0; i<iSize; i++) {
299 if (arrayBlockData[i].fOffset+arrayBlockData[i].fSize<=fpBuffer->fSize) {
300 segment.fSegmentOffset=arrayBlockData[i].fOffset;
301 segment.fSegmentSize=arrayBlockData[i].fSize;
302 segment.fDataType=arrayBlockData[i].fDataType;
303 segment.fSpecification=arrayBlockData[i].fSpecification;
304 fSegments.push_back(segment);
305 HLTDebug("set segment %s with size %d at offset %d", AliHLTComponent::DataType2Text(segment.fDataType).data(), segment.fSegmentSize, segment.fSegmentOffset);
307 HLTError("block data specification %#d (%s) exceeds size of data buffer", i, AliHLTComponent::DataType2Text(arrayBlockData[i].fDataType).data());
308 HLTError("block offset=%d, block size=%d, buffer size=%d", arrayBlockData[i].fOffset, arrayBlockData[i].fSize, fpBuffer->fSize);
313 HLTError("this data buffer (%p) does not match the internal data buffer %p of raw buffer %p", pTgt, fpBuffer->fPtr, fpBuffer);
317 HLTFatal("internal data structur missmatch");
321 HLTError("invalid parameter: pTgtBuffer=%p arrayBlockData=%p", pTgt, arrayBlockData);
327 int AliHLTDataBuffer::IsEmpty()
329 // see header file for function documentation
330 int iResult=fpBuffer==NULL || GetNofSegments()==0;
334 int AliHLTDataBuffer::GetNofSegments()
336 // see header file for function documentation
337 int iResult=fSegments.size();
341 int AliHLTDataBuffer::GetNofConsumers()
343 // see header file for function documentation
344 int iResult=fConsumers.size() + GetNofActiveConsumers() + fReleasedConsumers.size();
348 int AliHLTDataBuffer::GetNofActiveConsumers()
350 // see header file for function documentation
351 int iResult=fActiveConsumers.size();
355 AliHLTDataBuffer::AliHLTRawBuffer* AliHLTDataBuffer::CreateRawBuffer(AliHLTUInt32_t size)
357 // see header file for function documentation
358 AliHLTRawBuffer* pRawBuffer=NULL;
359 unsigned int reqSize=size+fgkSafetyPatternSize;
360 vector<AliHLTRawBuffer*>::iterator buffer=fgFreeBuffers.begin();
361 while (buffer!=fgFreeBuffers.end() && pRawBuffer==NULL) {
362 if ((*buffer)->fTotalSize>=reqSize && ((*buffer)->fTotalSize-reqSize)<fgMargin) {
363 // assign this element
365 pRawBuffer->fSize=size;
366 fgFreeBuffers.erase(buffer);
367 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);
368 fgActiveBuffers.push_back(pRawBuffer);
373 if (pRawBuffer==NULL) {
374 // no buffer found, create a new one
375 pRawBuffer=new AliHLTRawBuffer;
377 pRawBuffer->fPtr=malloc(reqSize);
378 if (pRawBuffer->fPtr) {
379 pRawBuffer->fSize=size;
380 pRawBuffer->fTotalSize=reqSize;
381 fgActiveBuffers.push_back(pRawBuffer);
382 fgLogging.Logging(kHLTLogDebug, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "new raw buffer %p of size %d created (container %p)", pRawBuffer->fPtr, pRawBuffer->fTotalSize, pRawBuffer);
383 if (fgkSafetyPatternSize>0) {
384 memcpy(((char*)pRawBuffer->fPtr)+pRawBuffer->fSize, fgkSafetyPattern, fgkSafetyPatternSize);
389 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "memory allocation failed");
392 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::CreateRawBuffer", "data buffer handling", "memory allocation failed");
398 int AliHLTDataBuffer::ReleaseRawBuffer(AliHLTRawBuffer* pBuffer)
400 // see header file for function documentation
403 vector<AliHLTRawBuffer*>::iterator buffer=fgActiveBuffers.begin();
404 while (buffer!=fgActiveBuffers.end() && (*buffer)!=pBuffer) {
407 if (buffer!=fgActiveBuffers.end()) {
408 if (fgkSafetyPatternSize>0) {
409 if (memcmp(((char*)(*buffer)->fPtr)+(*buffer)->fSize, fgkSafetyPattern, fgkSafetyPatternSize)!=0) {
410 fgLogging.Logging(kHLTLogFatal, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "component has written beyond end of data buffer %p size %d", (*buffer)->fPtr, (*buffer)->fSize);
414 fgFreeBuffers.push_back(*buffer);
415 fgActiveBuffers.erase(buffer);
417 fgLogging.Logging(kHLTLogWarning, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "can not find raw buffer container %p in the list of active containers", pBuffer);
421 fgLogging.Logging(kHLTLogError, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "invalid parameter");
428 int AliHLTDataBuffer::DeleteRawBuffers()
430 // see header file for function documentation
432 vector<AliHLTRawBuffer*>::iterator buffer=fgFreeBuffers.begin();
433 while (buffer!=fgFreeBuffers.end()) {
434 free((*buffer)->fPtr);
436 fgFreeBuffers.erase(buffer);
437 buffer=fgFreeBuffers.begin();
439 buffer=fgActiveBuffers.begin();
440 while (buffer!=fgActiveBuffers.end()) {
441 fgLogging.Logging(kHLTLogWarning, "AliHLTDataBuffer::ReleaseRawBuffer", "data buffer handling", "request to delete active raw buffer container (raw buffer %p, size %d)", (*buffer)->fPtr, (*buffer)->fTotalSize);
442 free((*buffer)->fPtr);
444 fgActiveBuffers.erase(buffer);
445 buffer=fgActiveBuffers.begin();
450 AliHLTConsumerDescriptor* AliHLTDataBuffer::FindConsumer(const AliHLTComponent* pConsumer, vector<AliHLTConsumerDescriptor*> &list) const
452 // see header file for function documentation
453 AliHLTConsumerDescriptor* pDesc=NULL;
454 vector<AliHLTConsumerDescriptor*>::iterator desc=list.begin();
455 while (desc!=list.end() && pDesc==NULL) {
456 if ((pConsumer==NULL || (*desc)->GetComponent()==pConsumer)) {
464 int AliHLTDataBuffer::ResetDataBuffer()
466 // see header file for function documentation
468 AliHLTRawBuffer* pBuffer=fpBuffer;
471 // cleanup consumer states
472 vector<AliHLTConsumerDescriptor*>::iterator desc=fReleasedConsumers.begin();
473 while (desc!=fReleasedConsumers.end()) {
474 AliHLTConsumerDescriptor* pDesc=*desc;
475 fReleasedConsumers.erase(desc);
476 desc=fReleasedConsumers.begin();
477 fConsumers.push_back(pDesc);
479 desc=fActiveConsumers.begin();
480 while (desc!=fActiveConsumers.end()) {
481 AliHLTConsumerDescriptor* pDesc=*desc;
482 HLTWarning("consumer %p was not released", pDesc);
483 fActiveConsumers.erase(desc);
484 desc=fActiveConsumers.begin();
485 fConsumers.push_back(pDesc);
489 vector<AliHLTDataBuffer::AliHLTDataSegment>::iterator segment=fSegments.begin();
490 while (segment!=fSegments.end()) {
491 fSegments.erase(segment);
492 segment=fSegments.begin();
495 // cleanup raw buffer
497 ReleaseRawBuffer(pBuffer);
502 int AliHLTDataBuffer::Reset()
504 // see header file for function documentation
505 return ResetDataBuffer();
508 // this is the version which works on lists of components instead of consumer descriptors
509 // int AliHLTDataBuffer::ChangeConsumerState(AliHLTComponent* pConsumer, vector<AliHLTComponent*> &srcList, vector<AliHLTComponent*> &tgtList)
513 // vector<AliHLTComponent*>::iterator desc=srcList.begin();
514 // while (desc!=srcList.end()) {
515 // if ((*desc)==pConsumer) {
516 // srcList.erase(desc);
517 // tgtList.push_back(pConsumer);
522 // if (desc==srcList.end()) {
523 // HLTError("can not find consumer component %p in list", pConsumer);
527 // HLTError("invalid parameter");
533 int AliHLTDataBuffer::ChangeConsumerState(AliHLTConsumerDescriptor* pDesc, vector<AliHLTConsumerDescriptor*> &srcList, vector<AliHLTConsumerDescriptor*> &tgtList)
535 // see header file for function documentation
538 vector<AliHLTConsumerDescriptor*>::iterator desc=srcList.begin();
539 while (desc!=srcList.end()) {
540 if ((*desc)==pDesc) {
542 tgtList.push_back(pDesc);
549 HLTError("can not find consumer descriptor %p in list", pDesc);
552 HLTError("invalid parameter");
558 int AliHLTDataBuffer::CleanupConsumerList()
560 // see header file for function documentation
563 vector<AliHLTConsumerDescriptor*>::iterator desc=fConsumers.begin();
564 while (desc!=fConsumers.end()) {
566 fConsumers.erase(desc);
567 desc=fConsumers.begin();
572 int AliHLTDataBuffer::FindConsumer(AliHLTComponent* pConsumer, int bAllLists)
574 // see header file for function documentation
575 vector<AliHLTConsumerDescriptor*>::iterator desc=fConsumers.begin();
576 while (desc!=fConsumers.end()) {
577 if ((*desc)->GetComponent()==pConsumer)
581 if (bAllLists==0) return 0;
583 desc=fActiveConsumers.begin();
584 while (desc!=fActiveConsumers.end()) {
585 if ((*desc)->GetComponent()==pConsumer)
589 desc=fReleasedConsumers.begin();
590 while (desc!=fReleasedConsumers.end()) {
591 if ((*desc)->GetComponent()==pConsumer)