get rid of warning in HLT build system after exluding the hough tracking from compilation
[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTDataBuffer.h
CommitLineData
3f2a1b1c 1// @(#) $Id$
2
3#ifndef ALIHLTDATABUFFER_H
4#define ALIHLTDATABUFFER_H
5/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
6 * See cxx source for full Copyright notice */
7
b22e91eb 8/** @file AliHLTDataBuffer.h
9 @author Matthias Richter
10 @date
11 @brief Handling of Data Buffers for HLT components.
12 @note The class is used in Offline (AliRoot) context
13*/
3f2a1b1c 14
30338a30 15// see below for class documentation
16// or
17// refer to README to build package
18// or
19// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
20
8ede8717 21#include <vector>
3f2a1b1c 22#include "AliHLTLogging.h"
23#include "AliHLTDataTypes.h"
3f2a1b1c 24#include "TObject.h"
3f2a1b1c 25
b22e91eb 26class AliHLTComponent;
6235cd38 27class AliHLTConsumerDescriptor;
3f2a1b1c 28
0c0c9d99 29/**
bfccbf68 30 * @class AliHLTDataBuffer
31 * @brief Handling of data buffers for the HLT.
b22e91eb 32 *
70ed7d01 33 * The class provides handling of data buffers for HLT tasks. Each task gets
34 * its own Data Buffer instance. The buffer is grouped into different data
35 * segments according to the output of the component.<br>
36 * The Data Buffer keeps control over the data requests of the 'child'
37 * components. Each component can subscribe to a certain segment of the data
38 * buffer. It's state is then changed from 'reserved' to 'active'. After the
39 * data processing, the component has to release the segment and it's state is
40 * set to 'processed'. If all components have requested and released their data,
41 * the Raw Buffer is released and pushed back in the list of available buffers.
b22e91eb 42 *
43 * @note This class is only used for the @ref alihlt_system.
44 *
45 * @ingroup alihlt_system
0c0c9d99 46 */
6235cd38 47class AliHLTDataBuffer : public TObject, public AliHLTLogging
48{
3f2a1b1c 49 public:
70ed7d01 50 //////////////////////////////////////////////////////////////////////////////
6235cd38 51 // constructors and destructors
0c0c9d99 52
53 /* standard constructor
54 */
3f2a1b1c 55 AliHLTDataBuffer();
85869391 56 /** destructor */
3f2a1b1c 57 virtual ~AliHLTDataBuffer();
58
70ed7d01 59 //////////////////////////////////////////////////////////////////////////////
3f2a1b1c 60 // initialization
61
0c0c9d99 62 /**
63 * Add component to the list of consumers
64 * @param pConsumer - a consumer of type AliHLTComponent
3f2a1b1c 65 */
0c0c9d99 66 int SetConsumer(AliHLTComponent* pConsumer);
3f2a1b1c 67
70ed7d01 68 //////////////////////////////////////////////////////////////////////////////
3f2a1b1c 69 // component to component communication
70
0c0c9d99 71 /**
70ed7d01 72 * Determine the number of matching data blocks for the component and a
73 * consumer component. <br>
74 * The first approach will support only one output data type for processing
75 * components.
0c0c9d99 76 * @param pConsumer the component which subscribes to the buffer
77 * @param tgtList (optional) the list to receive the data types
78 * @return: number of data blocks which match the input data types
79 * of the consumer, neg. error code if failed <br>
80 * -EINVAL invalid parameter <br>
3f2a1b1c 81 */
70ed7d01 82 int FindMatchingDataBlocks(const AliHLTComponent* pConsumer,
83 vector<AliHLTComponentDataType>* tgtList=NULL);
0c0c9d99 84
85 /**
86 * Subscribe to a segment of the data buffer.
70ed7d01 87 * The function prepares the block descriptor for subsequent use with the
88 * AliHLTComponent::ProcessEvent method, the method can prepare several block
89 * descriptors up to the array size specified by iArraySize. The return value
90 * is independent from the array size the number of block descriptors which
91 * would have been prepared if there was enough space in the array<br>
0c0c9d99 92 * The method is used by the consumer component.
93 * @param pConsumer the component which subscribes to the buffer
94 * @param arrayBlockDesc pointer to block descriptor to be filled
95 * @param iArraySize size of the block descriptor array
70ed7d01 96 * @return: number of matching data blocks, neg. error code if failed<br>
97 * -EACCESS the consumer state can't be changed (activated)
0c0c9d99 98 * -EBADF unresolved data segments <br>
99 * -ENOENT consumer component not found <br>
100 * -ENODATA data buffer does not have raw data <br>
101 * -EINVAL invalid parameter <br>
102 */
70ed7d01 103 int Subscribe(const AliHLTComponent* pConsumer,
104 AliHLTComponentBlockData* arrayBlockDesc,
105 int iArraySize);
0c0c9d99 106
107 /**
108 * Release an instance of the data buffer.
109 * Resets the variables of the block descriptor.
110 * If all buffer segments are released, the Data Buffer is reseted
111 * and the Raw Buffer released.<br>
112 * The method is used by the consumer component.
113 * @param pBlockDesc descriptor of the data segment
114 * @param pConsumer the component which subscribes to the buffer
115 * @return: >0 if success, negative error code if failed <br>
70ed7d01 116 * -EACCESS the consumer state can not be changed (de-activated)
117 * -ENOENT consumer has not subscribed to the buffer <br>
0c0c9d99 118 * -EINVAL invalid parameter <br>
3f2a1b1c 119 */
8ede8717 120 int Release(AliHLTComponentBlockData* pBlockDesc, const AliHLTComponent* pConsumer);
3f2a1b1c 121
0c0c9d99 122 /**
123 * Get a target buffer of minimum size iMinSize.
124 * The method is used by the component which owns the Data Buffer to
125 * allocate a buffer for the data it is going to produce.
126 * @param iMinSize minumum size of the requested buffer
127 * @return: pointer to target buffer if
3f2a1b1c 128 */
129 AliHLTUInt8_t* GetTargetBuffer(int iMinSize);
130
0c0c9d99 131 /**
132 * Set the segments for the data buffer.
133 * This is usually done after the component has written the data to the buffer,
134 * which was requested by the @ref GetTargetBuffer method. The component might
135 * produce different types of data, for each type a segment has to be defined
2d7ff710 136 * which describes the data inside the buffer.<br>
70ed7d01 137 * The @ref AliHLTComponentBlockData segment descriptor comes directly from
138 * the @ref AliHLTComponent::ProcessEvent method.
0c0c9d99 139 * @param pTgt the target buffer which the segments refer to
140 * @param arraySegments the output block descriptors of the component
141 * @param iSize size of the array
3f2a1b1c 142 */
8ede8717 143 int SetSegments(AliHLTUInt8_t* pTgt, AliHLTComponentBlockData* arraySegments, int iSize);
3f2a1b1c 144
0c0c9d99 145 /**
146 * Check if the data buffer is empty.
147 * @return 1 if empty, 0 if not
3f2a1b1c 148 */
149 int IsEmpty();
150
0c0c9d99 151 /**
152 * Get the total and maximum size of the buffer.
153 * Lets see if this is needed later
3f2a1b1c 154 */
155 //int GetTotalSize();
156
0c0c9d99 157 /**
158 * Get the number of segments
159 * @return number of segments
3f2a1b1c 160 */
161 int GetNofSegments();
162
0c0c9d99 163 /**
b426991e 164 * Get the total number of consumers.
165 * This gives the number of consumers regardless of their state.
0c0c9d99 166 * @return number of consumers
3f2a1b1c 167 */
168 int GetNofConsumers();
169
0c0c9d99 170 /**
b426991e 171 * Get the number of consumers which still need to be processed during
172 * the current event.
173 * @return number of consumers
174 */
175 int GetNofPendingConsumers();
176
177 /**
178 * Get the number of consumers currently under processing.
0c0c9d99 179 * @return number of active consumers
3f2a1b1c 180 */
181 int GetNofActiveConsumers();
182
9ce4bf4a 183 /**
184 * Check if a consumer is already in the list
185 * @param pConsumer pointer to consumer component
186 * @param bAllLists search in all lists if 1
187 * search only in fConsumer list if 0
188 * @return 1 if found, 0 if not
189 */
190 int FindConsumer(AliHLTComponent* pConsumer, int bAllLists=1);
191
192 /**
193 * Public method to reset the buffer.
194 * Eventually with some additional checks. In normal operation,
195 * an external reset should not be necessary.
196 */
197 int Reset();
198
6235cd38 199 /**
965919c8 200 * @class AliHLTDataSegment
6235cd38 201 * @brief Descriptor of a data segment within the buffer.
202 */
66043029 203 class AliHLTDataSegment {
5df0cbb9 204 friend class AliHLTDataBuffer;
205 friend class AliHLTConsumerDescriptor;
66043029 206 public:
6235cd38 207 AliHLTDataSegment()
208 :
209 fDataType(),
210 fSegmentOffset(0),
211 fSegmentSize(0),
212 fSpecification(0)
213 {
214 memset(&fDataType, 0, sizeof(AliHLTComponentDataType));
215 }
216 AliHLTDataSegment(AliHLTUInt32_t offset, AliHLTUInt32_t size)
217 :
218 fDataType(),
219 fSegmentOffset(offset),
220 fSegmentSize(size),
221 fSpecification(0)
222 {
223 memset(&fDataType, 0, sizeof(AliHLTComponentDataType));
224 }
5df0cbb9 225 private:
6235cd38 226 /** the data type of this segment */
227 AliHLTComponentDataType fDataType; // see above
228 /** offset in byte within the data buffer */
229 AliHLTUInt32_t fSegmentOffset; // see above
230 /** size of the actual content */
231 AliHLTUInt32_t fSegmentSize; // see above
232 /** data specification */
233 AliHLTUInt32_t fSpecification; // see above
234 };
235
236 /**
965919c8 237 * @class AliHLTRawBuffer
6235cd38 238 * @brief Descriptor of the raw data buffer which can host several segments.
239 */
66043029 240 class AliHLTRawBuffer {
5df0cbb9 241 friend class AliHLTDataBuffer;
66043029 242 public:
243 /** standard constructor */
244 AliHLTRawBuffer() : fSize(0), fTotalSize(0), fPtr(NULL) {}
245 /** not a valid copy constructor, defined according to effective C++ style */
246 AliHLTRawBuffer(const AliHLTRawBuffer&) : fSize(0), fTotalSize(0), fPtr(NULL) {}
247 /** not a valid assignment op, but defined according to effective C++ style */
5df0cbb9 248 AliHLTRawBuffer& operator=(const AliHLTRawBuffer&) {return *this;}
66043029 249 /** standard destructor */
250 virtual ~AliHLTRawBuffer() {}
1e6e67ec 251
3a7c0444 252 int operator==(void*) const;
253 int operator==(AliHLTUInt8_t* ptr) const {return fPtr==ptr;}
254 int operator<=(void*) const;
255 int operator>(void*) const;
256 int operator-(void*) const;
1e6e67ec 257
3a7c0444 258 operator void*() const {return fPtr;}
259 operator AliHLTUInt8_t*() const {return fPtr;}
1e6e67ec 260
5df0cbb9 261 private:
6235cd38 262 /** size of the currently occupied partition of the buffer */
263 AliHLTUInt32_t fSize; // see above
264 /** total size of the buffer, including safety margin */
265 AliHLTUInt32_t fTotalSize; // see above
266 /** the buffer */
1e6e67ec 267 AliHLTUInt8_t* fPtr; //! transient
6235cd38 268 };
269
3f2a1b1c 270 private:
b426991e 271 /** copy constructor prohibited */
272 AliHLTDataBuffer(const AliHLTDataBuffer&);
273 /** assignment operator prohibited */
274 AliHLTDataBuffer& operator=(const AliHLTDataBuffer&);
275
0c0c9d99 276 /* lets see if this is needed
6235cd38 277 AliHLTDataSegment* FindDataSegment(AliHLTComponentDataType datatype);
0c0c9d99 278 */
279
280 /**
281 * Find those data segments which match the input types of a component.
282 * @param pConsumer the component which subscribes to the buffer
283 * @param tgtList the list to receive the data segment descriptors
284 * @return: number of data blocks which match the input data types
285 * of the consumer, neg. error code if failed <br>
286 * -EINVAL invalid parameter <br>
287 */
90ebac25 288 int FindMatchingDataSegments(const AliHLTComponent* pConsumer,
289 vector<AliHLTDataBuffer::AliHLTDataSegment>& tgtList);
3f2a1b1c 290
0c0c9d99 291 /**
292 * Reset the data buffer.
9ce4bf4a 293 * Removes all consumers back to the @ref fConsumers list, deletes
294 * segments and releases the Raw Buffer.
3f2a1b1c 295 */
296 int ResetDataBuffer();
297
70ed7d01 298 //////////////////////////////////////////////////////////////////////////////
299
3f2a1b1c 300 // the data description
3f2a1b1c 301
0c0c9d99 302 // the data segments within this buffer
70ed7d01 303 vector<AliHLTDataSegment> fSegments; // see above
3f2a1b1c 304
0c0c9d99 305 // the list of all consumers which are going to subscribe to the buffer
70ed7d01 306 vector<AliHLTConsumerDescriptor*> fConsumers; // see above
0c0c9d99 307 // the list of all consumers which are currently subscribed to the buffer
70ed7d01 308 vector<AliHLTConsumerDescriptor*> fActiveConsumers; // see above
0c0c9d99 309 // the list of all consumers which are already released for the current event
70ed7d01 310 vector<AliHLTConsumerDescriptor*> fReleasedConsumers; // see above
3f2a1b1c 311
0c0c9d99 312 // the buffer instance
70ed7d01 313 AliHLTRawBuffer* fpBuffer; //! transient
3f2a1b1c 314
0c0c9d99 315 // flags indicating the state of the buffer
70ed7d01 316 AliHLTUInt32_t fFlags; // see above
3f2a1b1c 317
70ed7d01 318 //////////////////////////////////////////////////////////////////////////////
0c0c9d99 319 // global buffer handling, internal use only
320
321 /**
322 * Create a raw buffer of a certain size.
323 * The function tries to find a buffer of the given size (or a bit bigger by a
9ddaea75 324 * certain margin @ref fgMargin) from the list of free buffers.
0c0c9d99 325 * If no buffer is available, a new one is created and added to the buffer handling.
326 * @param size min. size of the requested buffer
327 * @return pointer to raw buffer
3f2a1b1c 328 */
329 static AliHLTRawBuffer* CreateRawBuffer(AliHLTUInt32_t size);
330
0c0c9d99 331 /**
332 * Mark a buffer as free.
70ed7d01 333 * After the Data Buffer has finnished using the raw buffer, it is released
334 * and added to the list of available buffers.
0c0c9d99 335 * @param pBuffer the raw buffer to release
336 * @return >=0 if succeeded, neg. error code if failed
3f2a1b1c 337 */
338 static int ReleaseRawBuffer(AliHLTRawBuffer* pBuffer);
339
0c0c9d99 340 /**
341 * Deletes all the raw buffers.
70ed7d01 342 * When the last Data Buffer object is destructed, all raw data buffers are
343 * relesed.
3f2a1b1c 344 */
345 static int DeleteRawBuffers();
346
0c0c9d99 347 /**
348 * Number of instances of AliHLTDataBuffer.
70ed7d01 349 * The statice variable is incremented and decremented in the constructor/
350 * destructor. All internal data structures are cleaned up when the last
351 * instance is exiting.
0c0c9d99 352 */
70ed7d01 353 static int fgNofInstances; // see above
0c0c9d99 354 /** global list of free raw buffers */
70ed7d01 355 static vector<AliHLTRawBuffer*> fgFreeBuffers; // see above
0c0c9d99 356 /** global list of currently active raw buffers */
70ed7d01 357 static vector<AliHLTRawBuffer*> fgActiveBuffers; // see above
0c0c9d99 358 /** determines the raw buffer size margin at buffer requests */
70ed7d01 359 static AliHLTUInt32_t fgMargin; // see above
3f2a1b1c 360
0c0c9d99 361 /** global instance to HLT logging class for static methods */
70ed7d01 362 static AliHLTLogging fgLogging; // see above
3f2a1b1c 363
8451168b 364 /** size of the safety pattern */
365 static const Int_t fgkSafetyPatternSize; // see above
366
367 /** the safety pattern */
368 static const char fgkSafetyPattern[]; //!transient
369
70ed7d01 370 //////////////////////////////////////////////////////////////////////////////
0c0c9d99 371 // internal helper functions
372
373 /**
374 * Find the consumer descriptor for a certain component and data type in
375 * a list of consumers.<br>
70ed7d01 376 * <b>Note:</b> There are three lists which contain the consumers in the
377 * different states.
0c0c9d99 378 * @param pConsumer pointer to consumer component
379 * @param list list where to search for the consumer
380 */
70ed7d01 381 AliHLTConsumerDescriptor* FindConsumer(const AliHLTComponent* pConsumer,
382 vector<AliHLTConsumerDescriptor*> &list) const;
0c0c9d99 383
384 /**
385 * Change the state of a consumer.
70ed7d01 386 * The state of a consumer is determined by the list it is strored in, the
387 * method moves a consumer from the source to the target list.
0c0c9d99 388 * @param pDesc pointer to consumer descriptor
389 * @param srcList list where the consumer is currently to be found
390 * @param tgtList list where to move the consumer
391 */
70ed7d01 392 int ChangeConsumerState(AliHLTConsumerDescriptor* pDesc,
393 vector<AliHLTConsumerDescriptor*> &srcList,
394 vector<AliHLTConsumerDescriptor*> &tgtList);
3f2a1b1c 395
0c0c9d99 396 /**
397 * Cleanup a consumer list.
398 * Release all allocated data structures. <b>Note:</b> Not the component itself!
399 */
3f2a1b1c 400 int CleanupConsumerList();
401
402 ClassDef(AliHLTDataBuffer, 0)
403};
6235cd38 404
3f2a1b1c 405#endif // ALIHLTDATABUFFER_H