4 #ifndef ALIHLTDATABUFFER_H
5 #define ALIHLTDATABUFFER_H
6 //* This file is property of and copyright by the *
7 //* ALICE Experiment at CERN, All rights reserved. *
8 //* See cxx source for full Copyright notice *
10 // @file AliHLTDataBuffer.h
11 // @author Matthias Richter
13 // @brief Handling of Data Buffers for HLT components.
14 // @note The class is used in Offline (AliRoot) context
18 #include "AliHLTLogging.h"
19 #include "AliHLTDataTypes.h"
20 #include "AliHLTComponent.h"
24 class AliHLTConsumerDescriptor;
27 /** list of AliHLTConsumerDescriptor pointers */
28 typedef vector<AliHLTConsumerDescriptor*> AliHLTConsumerDescriptorPList;
30 typedef AliHLTUInt8_t* AliHLTUInt8Pointer_t;
33 * @class AliHLTDataBuffer
34 * @brief Handling of data buffers for the HLT.
36 * The class provides handling of data buffers for HLT tasks. Each task gets
37 * its own Data Buffer instance. The buffer is grouped into different data
38 * segments according to the output of the component.<br>
39 * The Data Buffer keeps control over the data requests of the 'child'
40 * components. Each component can subscribe to a certain segment of the data
41 * buffer. It's state is then changed from 'reserved' to 'active'. After the
42 * data processing, the component has to release the segment and it's state is
43 * set to 'processed'. If all components have requested and released their data,
44 * the Raw Buffer is released and pushed back in the list of available buffers.
46 * @note This class is only used for the @ref alihlt_system.
48 * @ingroup alihlt_system
50 class AliHLTDataBuffer : public TObject, public AliHLTLogging
53 //////////////////////////////////////////////////////////////////////////////
54 // constructors and destructors
56 /* standard constructor
60 virtual ~AliHLTDataBuffer();
62 //////////////////////////////////////////////////////////////////////////////
66 * Add component to the list of consumers
67 * @param pConsumer - a consumer of type AliHLTComponent
69 int SetConsumer(AliHLTComponent* pConsumer);
71 //////////////////////////////////////////////////////////////////////////////
72 // component to component communication
75 * Determine the number of matching data blocks for the component and a
76 * consumer component. <br>
77 * The first approach will support only one output data type for processing
79 * @param pConsumer the component which subscribes to the buffer
80 * @param tgtList (optional) the list to receive the data types
81 * @return: number of data blocks which match the input data types
82 * of the consumer, neg. error code if failed <br>
83 * -EINVAL invalid parameter <br>
85 int FindMatchingDataBlocks(const AliHLTComponent* pConsumer,
86 AliHLTComponentDataTypeList* tgtList=NULL);
89 * Subscribe to a segment of the data buffer.
90 * The function prepares the block descriptor for subsequent use with the
91 * AliHLTComponent::ProcessEvent method, the method can prepare several block
92 * descriptors up to the array size specified by iArraySize. The return value
93 * is independent from the array size the number of block descriptors which
94 * would have been prepared if there was enough space in the array<br>
95 * The method is used by the consumer component.
96 * @param pConsumer the component which subscribes to the buffer
97 * @param blockDescList block descriptor vector to be filled
98 * @return: number of matching data blocks, neg. error code if failed<br>
99 * -EACCESS the consumer state can't be changed (activated)
100 * -EBADF unresolved data segments <br>
101 * -ENOENT consumer component not found <br>
102 * -ENODATA data buffer does not have raw data <br>
103 * -EINVAL invalid parameter <br>
105 int Subscribe(const AliHLTComponent* pConsumer,
106 AliHLTComponentBlockDataList& blockDescList);
109 * Release an instance of the data buffer.
110 * Resets the variables of the block descriptor.
111 * If all buffer segments are released, the Data Buffer is reseted
112 * and the Raw Buffer released.<br>
113 * The method is used by the consumer component.
114 * @param pBlockDesc descriptor of the data segment
115 * @param pConsumer the component which subscribes to the buffer
116 * @param pOwnerTask task owning this buffer
117 * @return: >0 if success, negative error code if failed <br>
118 * -EACCESS the consumer state can not be changed (de-activated)
119 * -ENOENT consumer has not subscribed to the buffer <br>
120 * -EINVAL invalid parameter <br>
122 int Release(AliHLTComponentBlockData* pBlockDesc, const AliHLTComponent* pConsumer,
123 const AliHLTTask* pOwnerTask);
126 * Release a forwarded data block.
128 int ReleaseForwardedBlock(AliHLTComponentBlockData* pBlockDesc,
129 const AliHLTTask* pOwnerTask);
132 * Register an input data block for forwarding.
133 * Consumer of this data buffer subscribe to forwarded data blocks in te same way.
134 * Forwarded data blocks are released when the last consumer has released the
136 * @param pSrcTask original source task of the data block
137 * @param pBlockDesc descriptor of the data segment
139 int Forward(AliHLTTask* pSrcTask, AliHLTComponentBlockData* pBlockDesc);
142 * Get a target buffer of minimum size iMinSize.
143 * The method is used by the component which owns the Data Buffer to
144 * allocate a buffer for the data it is going to produce.
145 * @param iMinSize minumum size of the requested buffer
146 * @return: pointer to target buffer if
148 AliHLTUInt8_t* GetTargetBuffer(int iMinSize);
149 static unsigned int GetMaxBufferSize();
152 * Set the segments for the data buffer.
153 * This is usually done after the component has written the data to the buffer,
154 * which was requested by the @ref GetTargetBuffer method. The component might
155 * produce different types of data, for each type a segment has to be defined
156 * which describes the data inside the buffer.<br>
157 * The @ref AliHLTComponentBlockData segment descriptor comes directly from
158 * the @ref AliHLTComponent::ProcessEvent method.
159 * @param pTgt the target buffer which the segments refer to
160 * @param arraySegments the output block descriptors of the component
161 * @param iSize size of the array
163 int SetSegments(AliHLTUInt8_t* pTgt, AliHLTComponentBlockData* arraySegments, int iSize);
166 * Check if the data buffer is empty.
167 * @return 1 if empty, 0 if not
172 * Get the total and maximum size of the buffer.
173 * Lets see if this is needed later
175 //int GetTotalSize();
178 * Get the number of segments including the forwarded data blocks.
179 * @return number of segments
181 int GetNofSegments() const;
184 * Get the total number of consumers.
185 * This gives the number of consumers regardless of their state.
186 * @return number of consumers
188 int GetNofConsumers() const;
191 * Get the number of consumers which still need to be processed during
193 * @return number of consumers
195 int GetNofPendingConsumers() const;
198 * Get the number of consumers currently under processing.
199 * @return number of active consumers
201 int GetNofActiveConsumers() const;
204 * Check if a consumer is already in the list
205 * @param pConsumer pointer to consumer component
206 * @param bAllLists search in all lists if 1
207 * search only in fConsumer list if 0
208 * @return 1 if found, 0 if not
210 int FindConsumer(const AliHLTComponent* pConsumer, int bAllLists=1);
213 * Public method to reset the buffer.
214 * Eventually with some additional checks. In normal operation,
215 * an external reset should not be necessary.
220 * Print info about the buffer
222 virtual void Print(const char* option) const;
225 * Set local logging level
226 * logging filter for individual object
228 void SetLocalLoggingLevel(AliHLTComponentLogSeverity level)
229 {fgLogging.SetLocalLoggingLevel(level); AliHLTLogging::SetLocalLoggingLevel(level);}
232 * Print summary of the global buffer management.
234 static int PrintStatistics();
237 * Set the global event count.
238 * The event count is deployed to find buffers which have not been used
239 * for a while. In such a case to policy to find an appropriate buffer is
242 static int SetGlobalEventCount(AliHLTUInt32_t eventCount) {fgEventCount=eventCount; return 0;}
245 * @class AliHLTDataSegment
246 * @brief Descriptor of a data segment within the buffer.
248 class AliHLTDataSegment {
249 friend class AliHLTDataBuffer; // TODO: implement some getters/setters
253 fDataType(kAliHLTVoidDataType),
261 AliHLTDataSegment(AliHLTUInt8_t* ptr, AliHLTUInt32_t offset, AliHLTUInt32_t size)
263 fDataType(kAliHLTVoidDataType),
265 fSegmentOffset(offset),
271 AliHLTDataSegment(void* ptr, AliHLTUInt32_t offset, AliHLTUInt32_t size)
273 fDataType(kAliHLTVoidDataType),
274 fPtr(reinterpret_cast<AliHLTUInt8_t*>(ptr)),
275 fSegmentOffset(offset),
281 AliHLTDataSegment(void* ptr, AliHLTUInt32_t offset, AliHLTUInt32_t size, AliHLTComponentDataType dt, AliHLTUInt32_t spec)
284 fPtr(reinterpret_cast<AliHLTUInt8_t*>(ptr)),
285 fSegmentOffset(offset),
291 AliHLTDataSegment(const AliHLTDataSegment& src)
293 fDataType(src.fDataType),
295 fSegmentOffset(src.fSegmentOffset),
296 fSegmentSize(src.fSegmentSize),
297 fSpecification(src.fSpecification)
299 // AliHLTDataSegment just stores external pointers and properties
302 AliHLTDataSegment& operator=(const AliHLTDataSegment& src)
304 // AliHLTDataSegment just stores external pointers and properties
305 if (this==&src) return *this;
306 fDataType=src.fDataType;
308 fSegmentOffset=src.fSegmentOffset;
309 fSegmentSize=src.fSegmentSize;
310 fSpecification=src.fSpecification;
314 virtual ~AliHLTDataSegment() {}
316 AliHLTUInt8_t* GetPtr() const {return (AliHLTUInt8_t*)*this;}
318 AliHLTUInt32_t GetSize() const {return fSegmentSize;}
320 int operator==(const AliHLTDataSegment& seg) const
322 return (fPtr+fSegmentOffset==seg.fPtr+seg.fSegmentOffset) && (fSegmentSize==seg.fSegmentSize);
324 operator AliHLTUInt8_t*() const {return fPtr+fSegmentOffset;}
326 virtual void Print(const char* option) const;
329 /** the data type of this segment */
330 AliHLTComponentDataType fDataType; // see above
331 /** pointer to the buffer */
332 AliHLTUInt8Pointer_t fPtr; //!transient
333 /** offset in byte within the data buffer */
334 AliHLTUInt32_t fSegmentOffset; // see above
335 /** size of the actual content */
336 AliHLTUInt32_t fSegmentSize; // see above
337 /** data specification */
338 AliHLTUInt32_t fSpecification; // see above
343 * @class AliHLTForwardedDataSegment
344 * @brief Descriptor of a forwarded data segment.
345 * Contains in addition information about the parent of this forwarded
346 * block and the original data type and specification
348 class AliHLTForwardedDataSegment : public AliHLTDataSegment {
349 friend class AliHLTDataBuffer; // TODO: implement some getters/setters
351 AliHLTForwardedDataSegment()
352 : AliHLTDataSegment()
358 AliHLTForwardedDataSegment(AliHLTDataSegment& mySegment, AliHLTDataSegment& parentSegment, AliHLTTask* parentTask)
359 : AliHLTDataSegment(mySegment)
360 , fParentSegment(parentSegment)
361 , fParentTask(parentTask)
365 AliHLTForwardedDataSegment(const AliHLTForwardedDataSegment& src)
366 : AliHLTDataSegment(src),
367 fParentSegment(src.fParentSegment),
368 fParentTask(src.fParentTask)
370 // AliHLTForwardedDataSegment just stores external pointers and properties
373 AliHLTForwardedDataSegment& operator=(const AliHLTForwardedDataSegment& src)
375 // AliHLTForwardedDataSegment just stores external pointers and properties
376 AliHLTDataSegment::operator=(src);
377 fParentSegment=src.fParentSegment;
378 fParentTask=src.fParentTask;
382 virtual ~AliHLTForwardedDataSegment() {}
384 virtual void Print(const char* option) const;
387 /// description of the original segment
388 AliHLTDataSegment fParentSegment; // see above
390 AliHLTTask* fParentTask; //!transient
393 typedef vector<AliHLTDataBuffer::AliHLTDataSegment> AliHLTDataSegmentList;
395 class AliHLTRawBuffer;
396 typedef vector<AliHLTRawBuffer*> AliHLTRawBufferPList;
399 * @class AliHLTRawPage
400 * Memory allocation is organized in pages of a fixed size. Within a
401 * page, AliHLTRawBuffer chunks are created.
403 class AliHLTRawPage : public AliHLTLogging {
405 /** standard constructor */
406 AliHLTRawPage() : fSize(0), fPtr(NULL), fFreeBuffers(), fUsedBuffers() {}
408 AliHLTRawPage(AliHLTUInt32_t pagesize);
410 virtual ~AliHLTRawPage();
412 /** alloc a buffer of specified size from the global pages*/
413 static AliHLTRawBuffer* GlobalAlloc(AliHLTUInt32_t size, int verbosity=0);
414 /** find buffer in the global pages */
415 static AliHLTRawPage* FindPage(AliHLTRawBuffer* buffer);
416 /** cleanup the global pages */
417 static int GlobalClean();
418 /** adjust global page size */
419 static void SetGlobalPageSize(AliHLTUInt32_t size) {fgGlobalPageSize=size;}
420 static AliHLTUInt32_t GetGlobalPageSize() {return fgGlobalPageSize;}
421 /** find next page after prev, or first page */
422 static AliHLTRawPage* NextPage(const AliHLTRawPage* prev=NULL);
424 /** alloc a buffer of specified size */
425 AliHLTRawBuffer* Alloc(AliHLTUInt32_t size);
426 /** free a buffer and merge consecutive free buffers */
427 int Free(AliHLTRawBuffer* pBuffer);
428 /** set the size of a raw buffer and release the remaining part */
429 int SetSize(const AliHLTRawBuffer* pBuffer, AliHLTUInt32_t size);
430 /// check if the buffer is in this page
431 bool HasBuffer(const AliHLTRawBuffer* pBuffer);
433 AliHLTUInt32_t Size() const {return fSize;}
434 AliHLTUInt32_t Capacity() const;
435 bool IsUsed() const {return fUsedBuffers.size()>0;}
436 bool IsFragmented() const {return (fFreeBuffers.size()+fUsedBuffers.size())>1;}
439 * Print page information
441 virtual void Print(const char* option);
444 /** copy constructor prohibited */
445 AliHLTRawPage(const AliHLTRawPage&);
446 /** assignment operator prohibited */
447 AliHLTRawPage& operator=(const AliHLTRawPage&);
449 /// list of global pages
450 static vector<AliHLTDataBuffer::AliHLTRawPage*> fgGlobalPages; //! transient
451 /// pages size of global pages
452 static AliHLTUInt32_t fgGlobalPageSize; //! transient
455 AliHLTUInt32_t fSize; // see above
456 /** the memory segment */
457 AliHLTUInt8_t* fPtr; //! transient
459 /** list of free buffers */
460 AliHLTRawBufferPList fFreeBuffers; //! transient
461 /** list of used buffers */
462 AliHLTRawBufferPList fUsedBuffers; //! transient
466 * @class AliHLTRawBuffer
467 * @brief Descriptor of the raw data buffer which can host several segments.
469 class AliHLTRawBuffer {
471 /** standard constructor */
472 AliHLTRawBuffer() : fSize(0), fTotalSize(0), fExternalPtr(NULL), fPtr(NULL), fLastEventCount(0) {}
474 AliHLTRawBuffer(AliHLTUInt32_t size);
476 AliHLTRawBuffer(AliHLTUInt32_t size, AliHLTUInt8_t* buffer);
478 virtual ~AliHLTRawBuffer();
481 * Use a fraction of the buffer.
482 * @param size size in bytes to be used
483 * @return pointer to buffer
485 AliHLTUInt8_t* UseBuffer(AliHLTUInt32_t size);
488 * split a buffer at specified size
489 * only possible for buffers with external memory
491 AliHLTRawBuffer* Split(AliHLTUInt32_t size);
494 * Check whether buffer fits for a request.
495 * A buffer fits if it is at least of the requested size and at most
496 * the requested size plus a margin. The margin increases with the
497 * number of events the buffer has not been used.
498 * @param size size of the request in bytes
499 * @return 1 if buffer is big enough, 0 if not
501 int CheckSize(AliHLTUInt32_t size) const;
504 * Get used size of the buffer
506 AliHLTUInt32_t GetUsedSize() const {return fSize;}
509 * Get total size of the buffer
511 AliHLTUInt32_t GetTotalSize() const {return fTotalSize;}
514 * Get pointer of data buffer
516 AliHLTUInt8_t* GetPointer() const {return fPtr;}
519 * Write check pattern
521 int WritePattern(const char* pattern, int size);
526 int CheckPattern(const char* pattern, int size) const;
530 * Data buffer remains allocated, used size set to 0
535 * Merge buffer with succeeding buffer.
536 * Only possible if the buffers are consecutive with out any gap.
538 int Merge(const AliHLTRawBuffer& succ);
541 * Print buffer information
543 virtual void Print(const char* option) const;
545 int operator==(void* ptr) const;
546 int operator==(AliHLTUInt8_t* ptr) const {return fPtr==ptr;}
547 int operator<(void* ptr) const;
548 int operator<=(void* ptr) const;
549 int operator>(void* ptr) const;
550 int operator-(void* ptr) const;
551 int operator<(const AliHLTRawBuffer& op) const;
552 int operator<=(const AliHLTRawBuffer& op) const;
553 int operator>(const AliHLTRawBuffer& op) const;
555 operator void*() const {return fPtr;}
556 operator AliHLTUInt8_t*() const {return fPtr;}
559 /** copy constructor prohibited */
560 AliHLTRawBuffer(const AliHLTRawBuffer&);
561 /** assignment operator prohibited */
562 AliHLTRawBuffer& operator=(const AliHLTRawBuffer&);
564 /** size of the currently occupied partition of the buffer */
565 AliHLTUInt32_t fSize; // see above
566 /** total size of the buffer, including safety margin */
567 AliHLTUInt32_t fTotalSize; // see above
568 /** optional external buffer */
569 AliHLTUInt8_t* fExternalPtr; //! transient
570 /** the buffer, external or allocated */
571 AliHLTUInt8_t* fPtr; //! transient
572 /** last event count where the buffer has been used */
573 AliHLTUInt32_t fLastEventCount; //! transient
577 /** copy constructor prohibited */
578 AliHLTDataBuffer(const AliHLTDataBuffer&);
579 /** assignment operator prohibited */
580 AliHLTDataBuffer& operator=(const AliHLTDataBuffer&);
582 /* lets see if this is needed
583 AliHLTDataSegment* FindDataSegment(AliHLTComponentDataType datatype);
587 * Find those data segments which match the input types of a component.
588 * @param pConsumer the component which subscribes to the buffer
589 * @param tgtList the list to receive the data segment descriptors
590 * @return: number of data blocks which match the input data types
591 * of the consumer, neg. error code if failed <br>
592 * -EINVAL invalid parameter <br>
594 int FindMatchingDataSegments(const AliHLTComponent* pConsumer,
595 AliHLTDataSegmentList& tgtList);
598 // 2010-02-01 make function protected in order to be used from unit test
600 * Reset the data buffer.
601 * Removes all consumers back to the @ref fConsumers list, deletes
602 * segments and releases the Raw Buffer.
604 int ResetDataBuffer();
607 //////////////////////////////////////////////////////////////////////////////
609 // the data description
611 // the data segments within this buffer
612 vector<AliHLTDataSegment> fSegments; // see above
614 // the list of all consumers which are going to subscribe to the buffer
615 AliHLTConsumerDescriptorPList fConsumers; // see above
616 // the list of all consumers which are currently subscribed to the buffer
617 AliHLTConsumerDescriptorPList fActiveConsumers; // see above
618 // the list of all consumers which are already released for the current event
619 AliHLTConsumerDescriptorPList fReleasedConsumers; // see above
621 // the buffer instance
622 AliHLTRawBuffer* fpBuffer; //! transient
624 // flags indicating the state of the buffer
625 AliHLTUInt32_t fFlags; // see above
627 /** list of tasks with forwarded data blocks */
628 vector<AliHLTTask*> fForwardedSegmentSources; //! transient
630 /** list of forwarded block descriptors */
631 vector<AliHLTDataSegment> fForwardedSegments; //! transient
633 //////////////////////////////////////////////////////////////////////////////
634 // global buffer handling, internal use only
637 * Create a raw buffer of a certain size.
638 * The function tries to find a buffer of the given size (or a bit bigger by a
639 * certain margin @ref fgMargin) from the list of free buffers.
640 * If no buffer is available, a new one is created and added to the buffer handling.
641 * @param size min. size of the requested buffer
642 * @return pointer to raw buffer
644 static AliHLTRawBuffer* CreateRawBuffer(AliHLTUInt32_t size);
647 * Set the data size of a raw buffer after it has been filled by
650 int SetRawBufferDataSize(AliHLTRawBuffer* pBuffer, AliHLTUInt32_t size) const;
653 * Mark a buffer as free.
654 * After the Data Buffer has finnished using the raw buffer, it is released
655 * and added to the list of available buffers.
656 * @param pBuffer the raw buffer to release
657 * @return >=0 if succeeded, neg. error code if failed
659 static int ReleaseRawBuffer(AliHLTRawBuffer* pBuffer);
662 * Deletes all the raw buffers.
663 * When the last Data Buffer object is destructed, all raw data buffers are
666 static int DeleteRawBuffers();
669 * Number of instances of AliHLTDataBuffer.
670 * The statice variable is incremented and decremented in the constructor/
671 * destructor. All internal data structures are cleaned up when the last
672 * instance is exiting.
674 static int fgNofInstances; // see above
675 /** global list of free raw buffers */
676 static vector<AliHLTRawBuffer*> fgFreeBuffers; // see above
677 /** global list of currently active raw buffers */
678 static vector<AliHLTRawBuffer*> fgActiveBuffers; // see above
679 /** determines the raw buffer size margin at buffer requests */
680 static AliHLTUInt32_t fgMargin; // see above
682 /** global instance to HLT logging class for static methods */
683 static AliHLTLogging fgLogging; // see above
685 /** size of the safety pattern */
686 static const Int_t fgkSafetyPatternSize; // see above
688 /** the safety pattern */
689 static const char fgkSafetyPattern[]; //!transient
691 static AliHLTUInt32_t fgEventCount; //!transient
693 //////////////////////////////////////////////////////////////////////////////
694 // internal helper functions
697 * Find the consumer descriptor for a certain component and data type in
698 * a list of consumers.<br>
699 * <b>Note:</b> There are three lists which contain the consumers in the
701 * @param pConsumer pointer to consumer component
702 * @param list list where to search for the consumer
704 AliHLTConsumerDescriptor* FindConsumer(const AliHLTComponent* pConsumer,
705 AliHLTConsumerDescriptorPList &list) const;
708 * Change the state of a consumer.
709 * The state of a consumer is determined by the list it is strored in, the
710 * method moves a consumer from the source to the target list.
711 * @param pDesc pointer to consumer descriptor
712 * @param srcList list where the consumer is currently to be found
713 * @param tgtList list where to move the consumer
715 int ChangeConsumerState(AliHLTConsumerDescriptor* pDesc,
716 AliHLTConsumerDescriptorPList &srcList,
717 AliHLTConsumerDescriptorPList &tgtList);
720 * Cleanup a consumer list.
721 * Release all allocated data structures. <b>Note:</b> Not the component itself!
723 int CleanupConsumerList();
725 ClassDef(AliHLTDataBuffer, 1)
728 #endif // ALIHLTDATABUFFER_H