]>
Commit | Line | Data |
---|---|---|
a655eae3 | 1 | //-*- Mode: C++ -*- |
45c0a780 | 2 | // $Id$ |
f23a6e1a | 3 | |
4 | #ifndef ALIHLTCOMPONENT_H | |
5 | #define ALIHLTCOMPONENT_H | |
45c0a780 | 6 | //* This file is property of and copyright by the ALICE HLT Project * |
7 | //* ALICE Experiment at CERN, All rights reserved. * | |
8 | //* See cxx source for full Copyright notice * | |
f23a6e1a | 9 | |
bfccbf68 | 10 | /** @file AliHLTComponent.h |
11 | @author Matthias Richter, Timm Steinbeck | |
12 | @date | |
b22e91eb | 13 | @brief Base class declaration for HLT components. |
14 | @note The class is both used in Online (PubSub) and Offline (AliRoot) | |
15 | context | |
45c0a780 | 16 | */ |
30338a30 | 17 | |
b22e91eb | 18 | /** |
19 | * @defgroup alihlt_component Component handling of the HLT module | |
45c0a780 | 20 | * This section describes the the component base classes and handling for |
21 | * the HLT module. | |
22 | * | |
23 | * @section alihlt_component_intro General remarks | |
24 | * HLT analysis is organized in so called components. Each component can | |
25 | * subscribe to the data produced by other components and can from the | |
26 | * analysis publish new data for the subsequent components. Only the | |
27 | * input data blocks and entries from CDB are available for the analysis. | |
28 | * | |
29 | * @section alihlt_component_intro Component implementation | |
30 | * AliHLTComponent provides the interface for all components, see there | |
31 | * for details. Three types are provided: | |
32 | * - AliHLTProcessor | |
33 | * - AliHLTDataSource | |
34 | * - AliHLTDataSink | |
35 | * | |
36 | * The two last represent data sinks and sources for the HLT integration | |
37 | * into AliRoot. When running only, only the processors are relevant, | |
38 | * sources and sinks are provided by the HLT PubSub framework. Please check | |
39 | * AliHLTComponent for detailed description. | |
40 | * | |
41 | * @section alihlt_component_registration Component registration | |
42 | * Components need to be registered with the AliHLTComponentHandler in | |
43 | * order to be used with the system. Registration is purely done from the | |
44 | * module library. Two methods are possible: | |
45 | * - the module library implements an AliHLTModuleAgent and overloads the | |
46 | * AliHLTModuleAgent::RegisterComponents() function | |
47 | * - in the implementation file, one object is defined. The global object is | |
48 | * automatically instantiated when the library is loaded for the first | |
49 | * time and the object is used for registration. | |
50 | * | |
51 | * In both cases, the library must be loaded via the method | |
52 | * <pre> | |
53 | * AliHLTComponentHandler::LoadComponentLibraries() | |
54 | * </pre> | |
55 | * For the global object approach it is important that the library is | |
56 | * not loaded elsewhere before (e.g. a gSystem->Load operation in your | |
57 | * rootlogon.C). | |
58 | * | |
59 | * | |
b22e91eb | 60 | */ |
8ede8717 | 61 | |
62 | #include <vector> | |
9ce4bf4a | 63 | #include <string> |
5ec8e281 | 64 | #include "AliHLTLogging.h" |
f23a6e1a | 65 | #include "AliHLTDataTypes.h" |
1ac82ce6 | 66 | #include "AliHLTCommonCDBEntries.h" |
f23a6e1a | 67 | |
2d7ff710 | 68 | /* Matthias Dec 2006 |
69 | * The names have been changed for Aliroot's coding conventions sake | |
70 | * The old names are defined for backward compatibility with the | |
71 | * stand alone SampleLib package | |
72 | */ | |
73 | typedef AliHLTComponentLogSeverity AliHLTComponent_LogSeverity; | |
74 | typedef AliHLTComponentEventData AliHLTComponent_EventData; | |
75 | typedef AliHLTComponentShmData AliHLTComponent_ShmData; | |
76 | typedef AliHLTComponentDataType AliHLTComponent_DataType; | |
77 | typedef AliHLTComponentBlockData AliHLTComponent_BlockData; | |
78 | typedef AliHLTComponentTriggerData AliHLTComponent_TriggerData; | |
79 | typedef AliHLTComponentEventDoneData AliHLTComponent_EventDoneData; | |
80 | ||
f23a6e1a | 81 | class AliHLTComponentHandler; |
a655eae3 | 82 | class TObjArray; |
90ebac25 | 83 | class TStopwatch; |
2be3f004 | 84 | class AliHLTComponent; |
79c114b5 | 85 | class AliHLTMemoryFile; |
f23a6e1a | 86 | |
2be3f004 | 87 | /** list of component data type structures */ |
88 | typedef vector<AliHLTComponentDataType> AliHLTComponentDataTypeList; | |
89 | /** list of component block data structures */ | |
90 | typedef vector<AliHLTComponentBlockData> AliHLTComponentBlockDataList; | |
a0aeb701 | 91 | /** list of component statistics struct */ |
92 | typedef vector<AliHLTComponentStatistics> AliHLTComponentStatisticsList; | |
2be3f004 | 93 | /** list of component pointers */ |
94 | typedef vector<AliHLTComponent*> AliHLTComponentPList; | |
95 | /** list of memory file pointers */ | |
96 | typedef vector<AliHLTMemoryFile*> AliHLTMemoryFilePList; | |
97 | ||
bfccbf68 | 98 | /** |
99 | * @class AliHLTComponent | |
100 | * Base class of HLT data processing components. | |
101 | * The class provides a common interface for HLT data processing components. | |
102 | * The interface can be accessed from the online HLT framework or the AliRoot | |
103 | * offline analysis framework. | |
a655eae3 | 104 | * @section alihltcomponent-properties Component identification and properties |
105 | * Each component must provide a unique ID, input and output data type indications, | |
106 | * and a spawn function. | |
107 | * @subsection alihltcomponent-req-methods Required property methods | |
108 | * - @ref GetComponentID | |
109 | * - @ref GetInputDataTypes (see @ref alihltcomponent-type for default | |
110 | * implementations.) | |
111 | * - @ref GetOutputDataType (see @ref alihltcomponent-type for default | |
112 | * implementations.) | |
113 | * - @ref GetOutputDataSize (see @ref alihltcomponent-type for default | |
114 | * implementations.) | |
115 | * - @ref Spawn | |
bfccbf68 | 116 | * |
a655eae3 | 117 | * @subsection alihltcomponent-opt-mehods Optional handlers |
118 | * - @ref DoInit | |
119 | * - @ref DoDeinit | |
de6593d0 | 120 | * - @ref GetOutputDataTypes |
121 | * If the component has multiple output data types @ref GetOutputDataType | |
122 | * should return @ref kAliHLTMultipleDataType. The framework will invoke | |
123 | * @ref GetOutputDataTypes, a list can be filled. | |
a655eae3 | 124 | * |
125 | * @subsection alihltcomponent-processing-mehods Data processing | |
126 | * | |
127 | * | |
128 | * @subsection alihltcomponent-type Component type | |
129 | * Components can be of type | |
90ebac25 | 130 | * - @ref kSource components which only produce data |
131 | * - @ref kProcessor components which consume and produce data | |
132 | * - @ref kSink components which only consume data | |
a655eae3 | 133 | * |
134 | * where data production and consumption refer to the analysis data stream. In | |
135 | * order to indicate the type, a child component can overload the | |
136 | * @ref GetComponentType function. | |
137 | * @subsubsection alihltcomponent-type-std Standard implementations | |
138 | * Components in general do not need to implement this function, standard | |
139 | * implementations of the 3 types are available: | |
140 | * - AliHLTDataSource for components of type @ref kSource <br> | |
141 | * All types of data sources can inherit from AliHLTDataSource and must | |
142 | * implement the @ref AliHLTDataSource::GetEvent method. The class | |
143 | * also implements a standard method for @ref GetInputDataTypes. | |
144 | * | |
145 | * - AliHLTProcessor for components of type @ref kProcessor <br> | |
146 | * All types of data processors can inherit from AliHLTDataSource and must | |
147 | * implement the @ref AliHLTProcessor::DoEvent method. | |
148 | * | |
149 | * - AliHLTDataSink for components of type @ref kSink <br> | |
150 | * All types of data processors can inherit from AliHLTDataSource and must | |
151 | * implement the @ref AliHLTDataSink::DumpEvent method. The class | |
152 | * also implements a standard method for @ref GetOutputDataType and @ref | |
153 | * GetOutputDataSize. | |
154 | * | |
155 | * @subsection alihltcomponent-environment Running environment | |
bfccbf68 | 156 | * |
157 | * In order to adapt to different environments (on-line/off-line), the component | |
158 | * gets an environment structure with function pointers. The base class provides | |
159 | * member functions for those environment dependend functions. The member | |
160 | * functions are used by the component implementation and are re-mapped to the | |
161 | * corresponding functions. | |
b6800be0 | 162 | * |
a655eae3 | 163 | * @section alihltcomponent-interfaces Component interfaces |
164 | * Each of the 3 standard component base classes AliHLTProcessor, AliHLTDataSource | |
165 | * and AliHLTDataSink provides it's own processing method (see | |
166 | * @ref alihltcomponent-type-std), which splits into a high and a low-level | |
167 | * method. For the @ref alihltcomponent-low-level-interface, all parameters are | |
168 | * shipped as function arguments, the component is supposed to dump data to the | |
169 | * output buffer and handle all block descriptors. | |
170 | * The @ref alihltcomponent-high-level-interface is the standard processing | |
171 | * method and will be used whenever the low-level method is not overloaded. | |
172 | * | |
b6800be0 | 173 | * In both cases it is necessary to calculate/estimate the size of the output |
174 | * buffer before the processing. Output buffers can never be allocated inside | |
175 | * the component because of the push-architecture of the HLT. | |
176 | * For that reason the @ref GetOutputDataSize function should return a rough | |
177 | * estimatian of the data to be produced by the component. The component is | |
178 | * responsible for checking the memory size and must return -ENOSPC if the | |
179 | * available buffer is to small, and update the estimator respectively. The | |
180 | * framework will allocate a buffer of appropriate size and call the processing | |
181 | * again. | |
182 | * | |
b426991e | 183 | * @subsection alihltcomponent-error-codes Data processing |
184 | * For return codes, the following scheme applies: | |
185 | * - The data processing methods have to indicate error conditions by a negative | |
186 | * error/return code. Preferably the system error codes are used like | |
187 | * e.g. -EINVAL. This requires to include the header | |
188 | * <pre> | |
616eb170 | 189 | * \#include \<cerrno\> |
b426991e | 190 | * </pre> |
191 | * - If no suitable input block could be found (e.g. no clusters for the TPC cluster | |
192 | * finder) set size to 0, block list is empty, return 0 | |
193 | * - If no ususable or significant signal could be found in the input blocks | |
194 | * return an empty output block, set size accordingly, and return 0. An empty output | |
195 | * block here could be either a real empty one of size 0 (in which case size also | |
196 | * would have to be set to zero) or a block filled with just the minimum necessary | |
197 | * accounting/meta-structures. E.g. in the TPC | |
198 | * | |
a655eae3 | 199 | * @subsection alihltcomponent-high-level-interface High-level interface |
200 | * The high-level component interface provides functionality to exchange ROOT | |
201 | * structures between components. In contrast to the | |
202 | * @ref alihltcomponent-low-level-interface, a couple of functions can be used | |
203 | * to access data blocks of the input stream | |
204 | * and send data blocks or ROOT TObject's to the output stream. The functionality | |
205 | * is hidden from the user and is implemented by using ROOT's TMessage class. | |
206 | * | |
207 | * @subsubsection alihltcomponent-high-level-int-methods Interface methods | |
208 | * The interface provides a couple of methods in order to get objects from the | |
209 | * input, data blocks (non TObject) from the input, and to push back objects and | |
210 | * data blocks to the output. For convenience there are several functions of | |
211 | * identical name (and similar behavior) with different parameters defined. | |
212 | * Please refer to the function documentation. | |
213 | * - @ref GetNumberOfInputBlocks <br> | |
214 | * return the number of data blocks in the input stream | |
215 | * - @ref GetFirstInputObject <br> | |
216 | * get the first object of a specific data type | |
217 | * - @ref GetNextInputObject <br> | |
218 | * get the next object of same data type as last GetFirstInputObject/Block call | |
219 | * - @ref GetFirstInputBlock <br> | |
220 | * get the first block of a specific data type | |
221 | * - @ref GetNextInputBlock <br> | |
222 | * get the next block of same data type as last GetFirstInputBlock/Block call | |
223 | * - @ref PushBack <br> | |
224 | * insert an object or data buffer into the output | |
225 | * - @ref CreateEventDoneData <br> | |
226 | * add event information to the output | |
227 | * | |
228 | * In addition, the processing methods are simplified a bit by cutting out most of | |
79c114b5 | 229 | * the parameters. |
230 | * @see | |
231 | * - @ref AliHLTProcessor::DoEvent | |
232 | * - @ref AliHLTDataSource::GetEvent | |
233 | * - @ref AliHLTDataSink::DumpEvent | |
a655eae3 | 234 | * |
8451168b | 235 | * \em IMPORTANT: objects and block descriptors provided by the high-level interface |
236 | * <b>MUST NOT BE DELETED</b> by the caller. | |
237 | * | |
a655eae3 | 238 | * @subsubsection alihltcomponent-high-level-int-guidelines High-level interface guidelines |
239 | * - Structures must inherit from the ROOT object base class TObject in order be | |
240 | * transported by the transportation framework. | |
241 | * - all pointer members must be transient (marked <tt>//!</tt> behind the member | |
242 | * definition), i.e. will not be stored/transported, or properly marked | |
243 | * (<tt>//-></tt>) in order to call the streamer of the object the member is pointing | |
244 | * to. The latter is not recomended. Structures to be transported between components | |
245 | * should be streamlined. | |
246 | * - no use of stl vectors/strings, use appropriate ROOT classes instead | |
247 | * | |
248 | * @subsection alihltcomponent-low-level-interface Low-level interface | |
249 | * The low-level component interface consists of the specific data processing | |
250 | * methods for @ref AliHLTProcessor, @ref AliHLTDataSource, and @ref AliHLTDataSink. | |
251 | * - @ref AliHLTProcessor::DoEvent | |
252 | * - @ref AliHLTDataSource::GetEvent | |
253 | * - @ref AliHLTDataSink::DumpEvent | |
254 | * | |
255 | * | |
256 | * @section alihltcomponent-handling Component handling | |
257 | * The handling of HLT analysis components is carried out by the AliHLTComponentHandler. | |
258 | * Component are registered automatically at load-time of the component shared library | |
259 | * under the following suppositions: | |
260 | * - the component library has to be loaded from the AliHLTComponentHandler using the | |
261 | * @ref AliHLTComponentHandler::LoadLibrary method. | |
262 | * - the component implementation defines one global object (which is generated | |
263 | * when the library is loaded) | |
264 | * | |
265 | * @subsection alihltcomponent-design-rules General design considerations | |
266 | * The analysis code should be implemented in one or more destict class(es). A | |
267 | * \em component should be implemented which interface the destict analysis code to the | |
268 | * component interface. This component generates the analysis object dynamically. <br> | |
269 | * | |
270 | * Assume you have an implemetation <tt> AliHLTDetMyAnalysis </tt>, another class <tt> | |
271 | * AliHLTDetMyAnalysisComponent </tt> contains: | |
272 | * <pre> | |
273 | * private: | |
274 | * AliHLTDetMyAnalysis* fMyAnalysis; //! | |
275 | * </pre> | |
276 | * The object should then be instantiated in the DoInit handler of | |
277 | * <tt>AliHLTDetMyAnalysisComponent </tt>, and cleaned in the DoDeinit handler. | |
278 | * | |
279 | * Further rules: | |
280 | * - avoid big static arrays in the component, allocate the memory at runtime | |
281 | * | |
b22e91eb | 282 | * @ingroup alihlt_component |
a655eae3 | 283 | * @section alihltcomponent-members Class members |
bfccbf68 | 284 | */ |
5ec8e281 | 285 | class AliHLTComponent : public AliHLTLogging { |
f23a6e1a | 286 | public: |
bfccbf68 | 287 | /** standard constructor */ |
f23a6e1a | 288 | AliHLTComponent(); |
bfccbf68 | 289 | /** standard destructor */ |
f23a6e1a | 290 | virtual ~AliHLTComponent(); |
291 | ||
bfccbf68 | 292 | /** component type definitions */ |
f23a6e1a | 293 | enum TComponentType { kUnknown=0, kSource=1, kProcessor=2, kSink=3 }; |
bfccbf68 | 294 | |
295 | /** | |
296 | * Init function to prepare data processing. | |
297 | * Initialization of common data structures for a sequence of events. | |
298 | * The call is redirected to the internal method @ref DoInit which can be | |
299 | * overridden by the child class.<br> | |
300 | * During Init also the environment structure is passed to the component. | |
301 | * @param environ environment pointer with environment dependend function | |
302 | * calls | |
70ed7d01 | 303 | * @param environParam additionel parameter for function calls, the pointer |
bfccbf68 | 304 | * is passed as it is |
305 | * @param argc size of the argument array | |
306 | * @param argv agument array for component initialization | |
307 | */ | |
9a0ef890 | 308 | virtual int Init( const AliHLTComponentEnvironment* environ, void* environParam, int argc, const char** argv ); |
bfccbf68 | 309 | |
310 | /** | |
311 | * Clean-up function to terminate data processing. | |
312 | * Clean-up of common data structures after data processing. | |
313 | * The call is redirected to the internal method @ref DoDeinit which can be | |
314 | * overridden by the child class. | |
315 | */ | |
f23a6e1a | 316 | virtual int Deinit(); |
bfccbf68 | 317 | |
318 | /** | |
319 | * Processing of one event. | |
3cde846d | 320 | * The method is the entrance of the event processing. The parameters are |
321 | * cached for uses with the high-level interface and the DoProcessing | |
322 | * implementation is called. | |
323 | * | |
324 | * @param evtData | |
325 | * @param blocks | |
326 | * @param trigData | |
327 | * @param outputPtr | |
328 | * @param size | |
329 | * @param outputBlockCnt out: size of the output block array, set by the component | |
330 | * @param outputBlocks out: the output block array is allocated internally | |
331 | * @param edd | |
332 | * @return neg. error code if failed | |
333 | */ | |
334 | int ProcessEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, | |
335 | AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, | |
336 | AliHLTUInt32_t& size, AliHLTUInt32_t& outputBlockCnt, | |
337 | AliHLTComponentBlockData*& outputBlocks, | |
338 | AliHLTComponentEventDoneData*& edd ); | |
339 | ||
340 | /** | |
341 | * Internal processing of one event. | |
bfccbf68 | 342 | * The method is pure virtual and implemented by the child classes |
343 | * - @ref AliHLTProcessor | |
344 | * - @ref AliHLTDataSource | |
345 | * - @ref AliHLTDataSink | |
346 | * | |
347 | * @param evtData | |
348 | * @param blocks | |
349 | * @param trigData | |
350 | * @param outputPtr | |
351 | * @param size | |
2d7ff710 | 352 | * @param outputBlocks out: the output block array is allocated internally |
bfccbf68 | 353 | * @param edd |
354 | * @return neg. error code if failed | |
355 | */ | |
3cde846d | 356 | virtual int DoProcessing( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, |
8ede8717 | 357 | AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, |
a655eae3 | 358 | AliHLTUInt32_t& size, |
2be3f004 | 359 | AliHLTComponentBlockDataList& outputBlocks, |
8ede8717 | 360 | AliHLTComponentEventDoneData*& edd ) = 0; |
f23a6e1a | 361 | |
579d9eb7 | 362 | /** |
363 | * Init the CDB. | |
364 | * The function must not be called when running in AliRoot unless it it | |
365 | * really wanted. The CDB path will be set to the specified path, which might | |
366 | * override the path initialized at the beginning of the AliRoot reconstruction. | |
367 | * | |
368 | * The method is used from the external interface in order to set the correct | |
82c58a87 | 369 | * path when running on-line. The function also initializes the function |
370 | * callback for setting the run no during operation. | |
371 | * | |
372 | * A separation of library and component handling is maybe appropriate in the | |
373 | * future. Using the global component handler here is maybe not the cleanest | |
374 | * solution. | |
375 | * @param cdbPath path of the CDB | |
376 | * @param pHandler the component handler used for llibrary handling. | |
579d9eb7 | 377 | */ |
82c58a87 | 378 | int InitCDB(const char* cdbPath, AliHLTComponentHandler* pHandler); |
579d9eb7 | 379 | |
380 | /** | |
381 | * Set the run no for the CDB. | |
382 | * The function must not be called when running in AliRoot unless it it | |
383 | * really wanted. The CDB path will be set to the specified path, which might | |
384 | * override the run no initialized at the beginning of the AliRoot reconstruction. | |
45c0a780 | 385 | * InitCDB() has to be called before in order to really change the CDB settings. |
579d9eb7 | 386 | * |
387 | * The method is used from the external interface in order to set the correct | |
388 | * path when running on-line. | |
389 | */ | |
390 | int SetCDBRunNo(int runNo); | |
391 | ||
45c0a780 | 392 | /** |
393 | * Set the run description. | |
394 | * The run description is set before the call of Init() -> DoInit(). | |
395 | * @note: This functionality has been added in Juli 2008. The transmission of | |
396 | * run properties by a special SOR (SOD event in DAQ terminalogy but this was | |
397 | * changed after the HLT interface was designed) event is not sufficient because | |
398 | * the data might be needed already in the DoInit handler of the component. | |
399 | * @param desc run descriptor, currently only the run no member is used | |
400 | * @param runType originally, run type was supposed to be a number and part | |
401 | * of the run descriptor. But it was defined as string later | |
402 | */ | |
403 | int SetRunDescription(const AliHLTRunDesc* desc, const char* runType); | |
404 | ||
9a0ef890 | 405 | /** |
406 | * Set the component description. | |
407 | * The description string can contain tokens separated by blanks, a token | |
408 | * consists of a key and an optional value separated by '='. | |
409 | * Possible keys: | |
410 | * \li -chainid=id string id within the chain of the instance | |
411 | * | |
412 | * @param desc component description | |
413 | */ | |
414 | int SetComponentDescription(const char* desc); | |
415 | ||
f23a6e1a | 416 | // Information member functions for registration. |
bfccbf68 | 417 | |
418 | /** | |
419 | * Get the type of the component. | |
420 | * The function is pure virtual and must be implemented by the child class. | |
421 | * @return component type id | |
422 | */ | |
f23a6e1a | 423 | virtual TComponentType GetComponentType() = 0; // Source, sink, or processor |
bfccbf68 | 424 | |
425 | /** | |
426 | * Get the id of the component. | |
427 | * Each component is identified by a unique id. | |
428 | * The function is pure virtual and must be implemented by the child class. | |
429 | * @return component id (string) | |
430 | */ | |
f23a6e1a | 431 | virtual const char* GetComponentID() = 0; |
bfccbf68 | 432 | |
433 | /** | |
434 | * Get the input data types of the component. | |
435 | * The function is pure virtual and must be implemented by the child class. | |
436 | * @return list of data types in the vector reference | |
437 | */ | |
2be3f004 | 438 | virtual void GetInputDataTypes( AliHLTComponentDataTypeList& ) = 0; |
bfccbf68 | 439 | |
440 | /** | |
441 | * Get the output data type of the component. | |
442 | * The function is pure virtual and must be implemented by the child class. | |
443 | * @return output data type | |
444 | */ | |
8ede8717 | 445 | virtual AliHLTComponentDataType GetOutputDataType() = 0; |
bfccbf68 | 446 | |
de6593d0 | 447 | /** |
448 | * Get the output data types of the component. | |
449 | * The function can be implemented to indicate multiple output data types | |
450 | * in the target array. | |
451 | * @ref GetOutputDataType must return @ref kAliHLTMultipleDataType in order | |
452 | * to invoke this method. | |
453 | * @param tgtList list to receive the data types | |
454 | * @return no of output data types, data types in the target list | |
455 | */ | |
2be3f004 | 456 | virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList); |
de6593d0 | 457 | |
bfccbf68 | 458 | /** |
459 | * Get a ratio by how much the data volume is shrinked or enhanced. | |
460 | * The function is pure virtual and must be implemented by the child class. | |
461 | * @param constBase <i>return</i>: additive part, independent of the | |
462 | * input data volume | |
463 | * @param inputMultiplier <i>return</i>: multiplication ratio | |
464 | * @return values in the reference variables | |
465 | */ | |
71d7c760 | 466 | virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ) = 0; |
f23a6e1a | 467 | |
bfccbf68 | 468 | /** |
469 | * Spawn function. | |
470 | * Each component must implement a spawn function to create a new instance of | |
471 | * the class. Basically the function must return <i>new <b>my_class_name</b></i>. | |
472 | * @return new class instance | |
473 | */ | |
f23a6e1a | 474 | virtual AliHLTComponent* Spawn() = 0; |
0c0c9d99 | 475 | |
bfccbf68 | 476 | /** |
477 | * Find matching data types between this component and a consumer component. | |
478 | * Currently, a component can produce only one type of data. This restriction is most | |
479 | * likely to be abolished in the future. | |
480 | * @param pConsumer a component and consumer of the data produced by this component | |
481 | * @param tgtList reference to a vector list to receive the matching data types. | |
482 | * @return >= 0 success, neg. error code if failed | |
483 | */ | |
2be3f004 | 484 | int FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList); |
f23a6e1a | 485 | |
bfccbf68 | 486 | /** |
487 | * Set the global component handler. | |
488 | * The static method is needed for the automatic registration of components. | |
489 | */ | |
85869391 | 490 | static int SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite=0); |
bfccbf68 | 491 | |
492 | /** | |
493 | * Clear the global component handler. | |
494 | * The static method is needed for the automatic registration of components. | |
495 | */ | |
85869391 | 496 | static int UnsetGlobalComponentHandler(); |
bfccbf68 | 497 | |
9ce4bf4a | 498 | /** |
499 | * Helper function to convert the data type to a string. | |
fbdb63fd | 500 | * @param type data type structure |
501 | * @param mode 0 print string origin:type <br> | |
502 | * 1 print chars <br> | |
503 | * 2 print numbers | |
9ce4bf4a | 504 | */ |
fbdb63fd | 505 | static string DataType2Text( const AliHLTComponentDataType& type, int mode=0); |
9ce4bf4a | 506 | |
5f5b708b | 507 | /** |
508 | * Helper function to print content of data type. | |
509 | */ | |
8b97f4f1 | 510 | static void PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format=NULL); |
5f5b708b | 511 | |
9ce4bf4a | 512 | /** |
513 | * helper function to initialize AliHLTComponentEventData structure | |
514 | */ | |
515 | static void FillEventData(AliHLTComponentEventData& evtData); | |
516 | ||
517 | /** | |
518 | * Print info on an AliHLTComponentDataType structure | |
519 | * This is just a helper function to examine an @ref AliHLTComponentDataType | |
520 | * structur. | |
521 | */ | |
8b97f4f1 | 522 | static void PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt); |
9ce4bf4a | 523 | |
fbdb63fd | 524 | /** |
525 | * Fill AliHLTComponentBlockData structure with default values. | |
526 | * @param blockData reference to data structure | |
527 | */ | |
528 | static void FillBlockData( AliHLTComponentBlockData& blockData ); | |
529 | ||
530 | /** | |
531 | * Fill AliHLTComponentShmData structure with default values. | |
532 | * @param shmData reference to data structure | |
533 | */ | |
534 | static void FillShmData( AliHLTComponentShmData& shmData ); | |
535 | ||
536 | /** | |
537 | * Fill AliHLTComponentDataType structure with default values. | |
538 | * @param dataType reference to data structure | |
539 | */ | |
540 | static void FillDataType( AliHLTComponentDataType& dataType ); | |
541 | ||
542 | /** | |
543 | * Copy data type structure | |
544 | * Copies the value an AliHLTComponentDataType structure to another one | |
545 | * @param[out] tgtdt target structure | |
546 | * @param[in] srcdt source structure | |
547 | */ | |
548 | static void CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt); | |
549 | ||
550 | /** | |
551 | * Set the ID and Origin of an AliHLTComponentDataType structure. | |
552 | * The function sets the fStructureSize member and copies the strings | |
553 | * to the ID and Origin. Only characters from the valid part of the string | |
7e3efc8f | 554 | * are copied, the rest is filled with 0's. <br> |
fbdb63fd | 555 | * Please note that the fID and fOrigin members are not strings, just arrays of |
556 | * chars of size @ref kAliHLTComponentDataTypefIDsize and | |
557 | * @ref kAliHLTComponentDataTypefOriginSize respectively and not necessarily with | |
7e3efc8f | 558 | * a terminating zero. <br> |
559 | * It is possible to pass NULL pointers as id or origin argument, in that case they | |
560 | * are just ignored. | |
fbdb63fd | 561 | * @param tgtdt target data type structure |
562 | * @param id ID string | |
563 | * @param origin Origin string | |
564 | */ | |
565 | static void SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin); | |
566 | ||
18b56222 | 567 | /** |
568 | * Set the ID and Origin of an AliHLTComponentDataType structure. | |
569 | * Given the fact that the data type ID is 64bit wide and origin 32, this helper | |
570 | * function sets the data type from those two parameters. | |
af2ed151 | 571 | * @param dt target data type structure |
18b56222 | 572 | * @param id 64bit id |
af2ed151 | 573 | * @param orig 32bit origin |
18b56222 | 574 | */ |
575 | static void SetDataType(AliHLTComponentDataType& dt, AliHLTUInt64_t id, AliHLTUInt32_t orig); | |
576 | ||
90ebac25 | 577 | /** |
578 | * Stopwatch type for benchmarking. | |
579 | */ | |
580 | enum AliHLTStopwatchType { | |
581 | /** total time for event processing */ | |
582 | kSWBase, | |
583 | /** detector algorithm w/o interface callbacks */ | |
584 | kSWDA, | |
585 | /** data sources */ | |
586 | kSWInput, | |
587 | /** data sinks */ | |
588 | kSWOutput, | |
589 | /** number of types */ | |
590 | kSWTypeCount | |
591 | }; | |
592 | ||
593 | /** | |
594 | * Helper class for starting and stopping a stopwatch. | |
595 | * The guard can be used by instantiating an object in a function. The | |
596 | * specified stopwatch is started and the previous stopwatch put on | |
597 | * hold. When the function is terminated, the object is deleted automatically | |
598 | * deleted, stopping the stopwatch and starting the one on hold.<br> | |
599 | * \em IMPORTANT: never create dynamic objects from this guard as this violates | |
600 | * the idea of a guard. | |
601 | */ | |
602 | class AliHLTStopwatchGuard { | |
603 | public: | |
604 | /** standard constructor (not for use) */ | |
605 | AliHLTStopwatchGuard(); | |
606 | /** constructor */ | |
607 | AliHLTStopwatchGuard(TStopwatch* pStart); | |
608 | /** copy constructor (not for use) */ | |
e419b223 | 609 | AliHLTStopwatchGuard(const AliHLTStopwatchGuard&); |
610 | /** assignment operator (not for use) */ | |
611 | AliHLTStopwatchGuard& operator=(const AliHLTStopwatchGuard&); | |
90ebac25 | 612 | /** destructor */ |
613 | ~AliHLTStopwatchGuard(); | |
614 | ||
615 | private: | |
616 | /** | |
617 | * Hold the previous guard for the existence of this guard. | |
618 | * Checks whether this guard controls a new stopwatch. In that case, the | |
619 | * previous guard and its stopwatch are put on hold. | |
620 | * @param pSucc instance of the stopwatch of the new guard | |
621 | * @return 1 if pSucc is a different stopwatch which should | |
622 | * be started<br> | |
623 | * 0 if it controls the same stopwatch | |
624 | */ | |
625 | int Hold(TStopwatch* pSucc); | |
626 | ||
627 | /** | |
628 | * Resume the previous guard. | |
629 | * Checks whether the peceeding guard controls a different stopwatch. In that | |
630 | * case, the its stopwatch is resumed. | |
631 | * @param pSucc instance of the stopwatch of the new guard | |
632 | * @return 1 if pSucc is a different stopwatch which should | |
633 | * be stopped<br> | |
634 | * 0 if it controls the same stopwatch | |
635 | */ | |
636 | int Resume(TStopwatch* pSucc); | |
637 | ||
638 | /** the stopwatch controlled by this guard */ | |
639 | TStopwatch* fpStopwatch; //!transient | |
640 | ||
641 | /** previous stopwatch guard, put on hold during existence of the guard */ | |
642 | AliHLTStopwatchGuard* fpPrec; //!transient | |
643 | ||
644 | /** active stopwatch guard */ | |
645 | static AliHLTStopwatchGuard* fgpCurrent; //!transient | |
646 | }; | |
647 | ||
648 | /** | |
649 | * Set a stopwatch for a given purpose. | |
650 | * @param pSW stopwatch object | |
651 | * @param type type of the stopwatch | |
652 | */ | |
653 | int SetStopwatch(TObject* pSW, AliHLTStopwatchType type=kSWBase); | |
654 | ||
655 | /** | |
656 | * Init a set of stopwatches. | |
657 | * @param pStopwatches object array of stopwatches | |
658 | */ | |
659 | int SetStopwatches(TObjArray* pStopwatches); | |
a655eae3 | 660 | |
f23a6e1a | 661 | protected: |
71d7c760 | 662 | |
bfccbf68 | 663 | /** |
664 | * Default method for the internal initialization. | |
665 | * The method is called by @ref Init | |
666 | */ | |
53feaef5 | 667 | virtual int DoInit( int argc, const char** argv ); |
f23a6e1a | 668 | |
bfccbf68 | 669 | /** |
670 | * Default method for the internal clean-up. | |
671 | * The method is called by @ref Deinit | |
672 | */ | |
53feaef5 | 673 | virtual int DoDeinit(); |
f23a6e1a | 674 | |
579d9eb7 | 675 | /** |
676 | * Reconfigure the component. | |
677 | * The method is called when an event of type @ref kAliHLTDataTypeComConf | |
678 | * {COM_CONF:PRIV} is received by the component. If the event is sent as | |
679 | * part of a normal event, the component configuration is called first. | |
680 | * | |
681 | * The CDB path parameter specifies the path in the CDB, i.e. without | |
682 | * leading absolute path of the CDB location. The framework might alse | |
683 | * provide the id of the component in the analysis chain. | |
684 | * | |
685 | * \b Note: The CDB will be initialized by the framework, either already set | |
686 | * from AliRoot or from the wrapper interface during initialization. | |
687 | * | |
688 | * @param cdbEntry path of the cdbEntry | |
e63b561e | 689 | * @param chainId the id/name of the component in the current analysis |
690 | * chain. This is not necessarily the same as what is | |
691 | * returned by the GetComponentID() method. | |
579d9eb7 | 692 | * @note both parameters can be NULL, check before usage |
693 | */ | |
694 | virtual int Reconfigure(const char* cdbEntry, const char* chainId); | |
b543e186 | 695 | |
696 | /** | |
697 | * Read the Preprocessor values. | |
698 | * The function is invoked when the component is notified about available/ | |
699 | * updated data points from the detector Preprocessors. The 'modules' | |
700 | * argument contains all detectors for which the Preprocessors have | |
701 | * updated data points. The component has to implement the CDB access to | |
702 | * get the desired data points. | |
703 | * @param modules detectors for which the Preprocessors have updated | |
d6b69874 | 704 | * data points: TPC, TRD, ITS, PHOS, MUON, or ALL if |
705 | * no argument was received. | |
b543e186 | 706 | * @return neg. error code if failed |
707 | */ | |
708 | virtual int ReadPreprocessorValues(const char* modules); | |
579d9eb7 | 709 | |
45c0a780 | 710 | /** |
711 | * Custom handler for the SOR event. | |
712 | * Is invoked from the base class if an SOR event is in the block list. | |
713 | * The handler is called before the processing function. The processing | |
714 | * function is skipped if there are no other data blocks available. | |
715 | * | |
716 | * The SOR event is generated by the PubSub framework in response to | |
717 | * the DAQ start of data (SOD - has been renamed after HLT interface | |
718 | * was designed). The SOD event consists of 3 blocks: | |
719 | * - ::kAliHLTDataTypeEvent block: spec ::gkAliEventTypeStartOfRun | |
720 | * - SOD block of type ::kAliHLTDataTypeSOR, payload: AliHLTRunDesc struct | |
721 | * - run type block ::kAliHLTDataTypeRunType, payload: run type string | |
722 | * | |
723 | * Run properties can be retrieved by getters like GetRunNo(). | |
724 | * @return neg. error code if failed | |
725 | */ | |
726 | virtual int StartOfRun(); | |
727 | ||
728 | /** | |
729 | * Custom handler for the EOR event. | |
730 | * Is invoked from the base class if an EOR event is in the block list. | |
731 | * The handler is called before the processing function. The processing | |
732 | * function is skipped if there are no other data blocks available. | |
733 | * | |
734 | * See StartOfRun() for mor ecomments of the sequence of steering events. | |
735 | * | |
736 | * @return neg. error code if failed | |
737 | */ | |
738 | virtual int EndOfRun(); | |
739 | ||
bfccbf68 | 740 | /** |
741 | * General memory allocation method. | |
742 | * All memory which is going to be used 'outside' of the interface must | |
743 | * be provided by the framework (online or offline). | |
744 | * The method is redirected to a function provided by the current | |
745 | * framework. Function pointers are transferred via the @ref | |
746 | * AliHLTComponentEnvironment structure. | |
747 | */ | |
85869391 | 748 | void* AllocMemory( unsigned long size ); |
f23a6e1a | 749 | |
bfccbf68 | 750 | /** |
751 | * Helper function to create a monolithic BlockData description block out | |
752 | * of a list BlockData descriptors. | |
753 | * For convenience, inside the interface vector lists are used, to make the | |
754 | * interface pure C style, monilithic blocks must be exchanged. | |
755 | * The method is redirected to a function provided by the current | |
756 | * framework. Function pointers are transferred via the @ref | |
757 | * AliHLTComponentEnvironment structure. | |
758 | */ | |
2be3f004 | 759 | int MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount, |
8ede8717 | 760 | AliHLTComponentBlockData** outputBlocks ); |
f23a6e1a | 761 | |
bfccbf68 | 762 | /** |
763 | * Fill the EventDoneData structure. | |
764 | * The method is redirected to a function provided by the current | |
765 | * framework. Function pointers are transferred via the @ref | |
766 | * AliHLTComponentEnvironment structure. | |
767 | */ | |
8ede8717 | 768 | int GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd ); |
f23a6e1a | 769 | |
bfccbf68 | 770 | /** |
771 | * Helper function to convert the data type to a string. | |
772 | */ | |
70ed7d01 | 773 | void DataType2Text(const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2]) const; |
fa2e9b7c | 774 | |
3cde846d | 775 | /** |
776 | * Get event number. | |
777 | * @return value of the internal event counter | |
778 | */ | |
70ed7d01 | 779 | int GetEventCount() const; |
3cde846d | 780 | |
a655eae3 | 781 | /** |
782 | * Get the number of input blocks. | |
783 | * @return number of input blocks | |
784 | */ | |
66043029 | 785 | int GetNumberOfInputBlocks() const; |
a655eae3 | 786 | |
787 | /** | |
788 | * Get the first object of a specific data type from the input data. | |
789 | * The hight-level methods provide functionality to transfer ROOT data | |
790 | * structures which inherit from TObject. | |
3dd8541e | 791 | * |
a655eae3 | 792 | * The method looks for the first ROOT object of type dt in the input stream. |
793 | * If also the class name is provided, the object is checked for the right | |
794 | * class type. The input data block needs a certain structure, namely the | |
795 | * buffer size as first word. If the cross check fails, the retrieval is | |
8451168b | 796 | * silently abondoned, unless the \em bForce parameter is set.<br> |
3dd8541e | 797 | * \b Note: THE OBJECT MUST NOT BE DELETED by the caller. |
798 | * | |
799 | * If called without parameters, the function tries to create objects from | |
800 | * all available input blocks, also the ones of data type kAliHLTVoidDataType | |
801 | * which are not matched by kAliHLTAnyDataType. | |
802 | * | |
a655eae3 | 803 | * @param dt data type of the object |
804 | * @param classname class name of the object | |
805 | * @param bForce force the retrieval of an object, error messages | |
806 | * are suppressed if \em bForce is not set | |
807 | * @return pointer to @ref TObject, NULL if no objects of specified type | |
808 | * available | |
809 | */ | |
3dd8541e | 810 | const TObject* GetFirstInputObject(const AliHLTComponentDataType& dt=kAliHLTAllDataTypes, |
a655eae3 | 811 | const char* classname=NULL, |
812 | int bForce=0); | |
813 | ||
814 | /** | |
815 | * Get the first object of a specific data type from the input data. | |
816 | * The hight-level methods provide functionality to transfer ROOT data | |
817 | * structures which inherit from TObject. | |
818 | * The method looks for the first ROOT object of type specified by the ID and | |
819 | * Origin strings in the input stream. | |
820 | * If also the class name is provided, the object is checked for the right | |
821 | * class type. The input data block needs a certain structure, namely the | |
822 | * buffer size as first word. If the cross check fails, the retrieval is | |
8451168b | 823 | * silently abondoned, unless the \em bForce parameter is set.<br> |
824 | * \em Note: THE OBJECT MUST NOT BE DELETED by the caller. | |
a655eae3 | 825 | * @param dtID data type ID of the object |
826 | * @param dtOrigin data type origin of the object | |
827 | * @param classname class name of the object | |
828 | * @param bForce force the retrieval of an object, error messages | |
829 | * are suppressed if \em bForce is not set | |
830 | * @return pointer to @ref TObject, NULL if no objects of specified type | |
831 | * available | |
832 | */ | |
833 | const TObject* GetFirstInputObject(const char* dtID, | |
834 | const char* dtOrigin, | |
835 | const char* classname=NULL, | |
836 | int bForce=0); | |
837 | ||
838 | /** | |
839 | * Get the next object of a specific data type from the input data. | |
840 | * The hight-level methods provide functionality to transfer ROOT data | |
841 | * structures which inherit from TObject. | |
842 | * The method looks for the next ROOT object of type and class specified | |
8451168b | 843 | * to the previous @ref GetFirstInputObject call.<br> |
844 | * \em Note: THE OBJECT MUST NOT BE DELETED by the caller. | |
a655eae3 | 845 | * @param bForce force the retrieval of an object, error messages |
846 | * are suppressed if \em bForce is not set | |
847 | * @return pointer to @ref TObject, NULL if no more objects available | |
848 | */ | |
849 | const TObject* GetNextInputObject(int bForce=0); | |
850 | ||
851 | /** | |
852 | * Get data type of an input block. | |
853 | * Get data type of the object previously fetched via | |
854 | * GetFirstInputObject/NextInputObject or the last one if no object | |
855 | * specified. | |
856 | * @param pObject pointer to TObject | |
857 | * @return data specification, kAliHLTVoidDataSpec if failed | |
858 | */ | |
859 | AliHLTComponentDataType GetDataType(const TObject* pObject=NULL); | |
860 | ||
861 | /** | |
862 | * Get data specification of an input block. | |
863 | * Get data specification of the object previously fetched via | |
864 | * GetFirstInputObject/NextInputObject or the last one if no object | |
865 | * specified. | |
866 | * @param pObject pointer to TObject | |
867 | * @return data specification, kAliHLTVoidDataSpec if failed | |
868 | */ | |
869 | AliHLTUInt32_t GetSpecification(const TObject* pObject=NULL); | |
870 | ||
871 | /** | |
872 | * Get the first block of a specific data type from the input data. | |
3dd8541e | 873 | * The method looks for the first block of type dt in the input stream. |
874 | * It is intended to be used within the high-level interface.<br> | |
8451168b | 875 | * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller. |
3dd8541e | 876 | * |
877 | * If called without parameters, the function works on all input blocks, | |
878 | * also the ones of data type kAliHLTVoidDataType which are not matched by | |
879 | * kAliHLTAnyDataType. | |
880 | * | |
a655eae3 | 881 | * @param dt data type of the block |
882 | * @return pointer to @ref AliHLTComponentBlockData | |
883 | */ | |
3dd8541e | 884 | const AliHLTComponentBlockData* GetFirstInputBlock(const AliHLTComponentDataType& dt=kAliHLTAllDataTypes); |
a655eae3 | 885 | |
886 | /** | |
887 | * Get the first block of a specific data type from the input data. | |
888 | * The method looks for the first block of type specified by the ID and | |
889 | * Origin strings in the input stream. It is intended | |
8451168b | 890 | * to be used within the high-level interface.<br> |
891 | * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller. | |
a655eae3 | 892 | * @param dtID data type ID of the block |
893 | * @param dtOrigin data type origin of the block | |
894 | * @return pointer to @ref AliHLTComponentBlockData | |
895 | */ | |
896 | const AliHLTComponentBlockData* GetFirstInputBlock(const char* dtID, | |
897 | const char* dtOrigin); | |
898 | ||
899 | /** | |
8451168b | 900 | * Get input block by index.<br> |
901 | * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller. | |
a655eae3 | 902 | * @return pointer to AliHLTComponentBlockData, NULL if index out of range |
903 | */ | |
904 | const AliHLTComponentBlockData* GetInputBlock(int index); | |
905 | ||
906 | /** | |
907 | * Get the next block of a specific data type from the input data. | |
908 | * The method looks for the next block of type and class specified | |
909 | * to the previous @ref GetFirstInputBlock call. | |
8451168b | 910 | * To be used within the high-level interface.<br> |
911 | * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller. | |
a655eae3 | 912 | */ |
913 | const AliHLTComponentBlockData* GetNextInputBlock(); | |
914 | ||
915 | /** | |
916 | * Get data specification of an input block. | |
917 | * Get data specification of the input bblock previously fetched via | |
918 | * GetFirstInputObject/NextInputObject or the last one if no block | |
919 | * specified. | |
920 | * @param pBlock pointer to input block | |
921 | * @return data specification, kAliHLTVoidDataSpec if failed | |
922 | */ | |
923 | AliHLTUInt32_t GetSpecification(const AliHLTComponentBlockData* pBlock=NULL); | |
924 | ||
c7e9e2f2 | 925 | /** |
926 | * Forward an input object to the output. | |
927 | * Forward the input block of an object previously fetched via | |
928 | * GetFirstInputObject/NextInputObject or the last one if no object | |
929 | * specified. | |
930 | * The block descriptor of the input block is forwarded to the | |
931 | * output block list. | |
932 | * @param pObject pointer to TObject | |
933 | * @return neg. error code if failed | |
934 | */ | |
935 | int Forward(const TObject* pObject); | |
936 | ||
937 | /** | |
938 | * Forward an input block to the output. | |
939 | * Forward the input block fetched via GetFirstInputObject/ | |
940 | * NextInputBlock or the last one if no block specified. | |
941 | * The block descriptor of the input block is forwarded to the | |
942 | * output block list. | |
943 | * @param pBlock pointer to input block | |
944 | * @return neg. error code if failed | |
945 | */ | |
946 | int Forward(const AliHLTComponentBlockData* pBlock=NULL); | |
947 | ||
a655eae3 | 948 | /** |
949 | * Insert an object into the output. | |
79c114b5 | 950 | * If header is specified, it will be inserted before the root object, |
951 | * default is no header. | |
a655eae3 | 952 | * @param pObject pointer to root object |
953 | * @param dt data type of the object | |
954 | * @param spec data specification | |
79c114b5 | 955 | * @param pHeader pointer to header |
956 | * @param headerSize size of Header | |
a655eae3 | 957 | * @return neg. error code if failed |
958 | */ | |
959 | int PushBack(TObject* pObject, const AliHLTComponentDataType& dt, | |
79c114b5 | 960 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec, |
961 | void* pHeader=NULL, int headerSize=0); | |
a655eae3 | 962 | |
963 | /** | |
964 | * Insert an object into the output. | |
79c114b5 | 965 | * If header is specified, it will be inserted before the root object, |
966 | * default is no header. | |
a655eae3 | 967 | * @param pObject pointer to root object |
968 | * @param dtID data type ID of the object | |
969 | * @param dtOrigin data type origin of the object | |
970 | * @param spec data specification | |
79c114b5 | 971 | * @param pHeader pointer to header |
972 | * @param headerSize size of Header | |
a655eae3 | 973 | * @return neg. error code if failed |
974 | */ | |
975 | int PushBack(TObject* pObject, const char* dtID, const char* dtOrigin, | |
79c114b5 | 976 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec, |
977 | void* pHeader=NULL, int headerSize=0); | |
978 | ||
a655eae3 | 979 | /** |
980 | * Insert an object into the output. | |
981 | * @param pBuffer pointer to buffer | |
982 | * @param iSize size of the buffer | |
983 | * @param dt data type of the object | |
984 | * @param spec data specification | |
9d9ffd37 | 985 | * @param pHeader pointer to header |
7c4091c1 | 986 | * @param headerSize size of Header |
a655eae3 | 987 | * @return neg. error code if failed |
988 | */ | |
989 | int PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt, | |
9d9ffd37 | 990 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec, |
991 | void* pHeader=NULL, int headerSize=0); | |
a655eae3 | 992 | |
993 | /** | |
994 | * Insert an object into the output. | |
995 | * @param pBuffer pointer to buffer | |
996 | * @param iSize size of the buffer | |
997 | * @param dtID data type ID of the object | |
998 | * @param dtOrigin data type origin of the object | |
999 | * @param spec data specification | |
9d9ffd37 | 1000 | * @param pHeader pointer to header |
7c4091c1 | 1001 | * @param headerSize size of Header |
a655eae3 | 1002 | * @return neg. error code if failed |
1003 | */ | |
1004 | int PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin, | |
9d9ffd37 | 1005 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec, |
1006 | void* pHeader=NULL, int headerSize=0); | |
a655eae3 | 1007 | |
8451168b | 1008 | /** |
1009 | * Estimate size of a TObject | |
1010 | * @param pObject | |
1011 | * @return buffer size in byte | |
1012 | */ | |
1013 | int EstimateObjectSize(TObject* pObject) const; | |
1014 | ||
79c114b5 | 1015 | /** |
1016 | * Create a memory file in the output stream. | |
1017 | * This method creates a TFile object which stores all data in | |
1018 | * memory instead of disk. The TFile object is published as binary data. | |
1019 | * The instance can be used like a normal TFile object. The TFile::Close | |
1020 | * or @ref CloseMemoryFile method has to be called in order to flush the | |
1021 | * output stream. | |
1022 | * | |
1023 | * \b Note: The returned object is deleted by the framework. | |
1024 | * @param capacity total size reserved for the memory file | |
1025 | * @param dtID data type ID of the file | |
1026 | * @param dtOrigin data type origin of the file | |
1027 | * @param spec data specification | |
1028 | * @return file handle, NULL if failed | |
1029 | */ | |
1030 | AliHLTMemoryFile* CreateMemoryFile(int capacity, const char* dtID, const char* dtOrigin, | |
1031 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec); | |
1032 | ||
1033 | /** | |
1034 | * Create a memory file in the output stream. | |
1035 | * This method creates a TFile object which stores all data in | |
1036 | * memory instead of disk. The TFile object is published as binary data. | |
1037 | * The instance can be used like a normal TFile object. The TFile::Close | |
1038 | * or @ref CloseMemoryFile method has to be called in order to flush the | |
1039 | * output stream. | |
1040 | * | |
1041 | * \b Note: The returned object is deleted by the framework. | |
1042 | * @param capacity total size reserved for the memory file | |
1043 | * @param dt data type of the file | |
1044 | * @param spec data specification | |
1045 | * @return file handle, NULL if failed | |
1046 | */ | |
1047 | AliHLTMemoryFile* CreateMemoryFile(int capacity, | |
1048 | const AliHLTComponentDataType& dt=kAliHLTAnyDataType, | |
1049 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec); | |
1050 | ||
1051 | /** | |
1052 | * Create a memory file in the output stream. | |
1053 | * This method creates a TFile object which stores all data in | |
1054 | * memory instead of disk. The TFile object is published as binary data. | |
1055 | * The instance can be used like a normal TFile object. The TFile::Close | |
1056 | * or @ref CloseMemoryFile method has to be called in order to flush the | |
1057 | * output stream. | |
1058 | * | |
1059 | * \b Note: The returned object is deleted by the framework. | |
1060 | * @param dtID data type ID of the file | |
1061 | * @param dtOrigin data type origin of the file | |
1062 | * @param spec data specification | |
1063 | * @param capacity fraction of the available output buffer size | |
1064 | * @return file handle, NULL if failed | |
1065 | */ | |
1066 | AliHLTMemoryFile* CreateMemoryFile(const char* dtID, const char* dtOrigin, | |
1067 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec, | |
1068 | float capacity=1.0); | |
1069 | ||
1070 | /** | |
1071 | * Create a memory file in the output stream. | |
1072 | * This method creates a TFile object which stores all data in | |
1073 | * memory instead of disk. The TFile object is published as binary data. | |
1074 | * The instance can be used like a normal TFile object. The TFile::Close | |
1075 | * or @ref CloseMemoryFile method has to be called in order to flush the | |
1076 | * output stream. | |
1077 | * | |
1078 | * \b Note: The returned object is deleted by the framework. | |
1079 | * @param dt data type of the file | |
1080 | * @param spec data specification | |
1081 | * @param capacity fraction of the available output buffer size | |
1082 | * @return file handle, NULL if failed | |
1083 | */ | |
1084 | AliHLTMemoryFile* CreateMemoryFile(const AliHLTComponentDataType& dt=kAliHLTAnyDataType, | |
1085 | AliHLTUInt32_t spec=kAliHLTVoidDataSpec, | |
1086 | float capacity=1.0); | |
1087 | ||
1088 | /** | |
1089 | * Write an object to memory file in the output stream. | |
1090 | * @param pFile file handle | |
1091 | * @param pObject pointer to root object | |
1092 | * @param key key in ROOT file | |
1093 | * @param option options, see TObject::Write | |
1094 | * @return neg. error code if failed | |
1095 | * - -ENOSPC no space left | |
1096 | */ | |
1097 | int Write(AliHLTMemoryFile* pFile, const TObject* pObject, const char* key=NULL, int option=TObject::kOverwrite); | |
1098 | ||
1099 | /** | |
1100 | * Close object memory file. | |
1101 | * @param pFile file handle | |
1102 | * @return neg. error code if failed | |
1103 | * - -ENOSPC buffer size too small | |
1104 | */ | |
1105 | int CloseMemoryFile(AliHLTMemoryFile* pFile); | |
1106 | ||
a655eae3 | 1107 | /** |
1108 | * Insert event-done data information into the output. | |
1109 | * @param edd event-done data information | |
1110 | */ | |
1111 | int CreateEventDoneData(AliHLTComponentEventDoneData edd); | |
1112 | ||
559631d5 | 1113 | /** |
1114 | * Get current run number | |
1115 | */ | |
1116 | AliHLTUInt32_t GetRunNo() const; | |
1117 | ||
1118 | /** | |
1119 | * Get the current run type. | |
1120 | */ | |
1121 | AliHLTUInt32_t GetRunType() const; | |
1122 | ||
9a0ef890 | 1123 | /** |
1124 | * Get the chain id of the component. | |
1125 | */ | |
1126 | const char* GetChainId() const {return fChainId.c_str();} | |
1127 | ||
ed504011 | 1128 | /** |
1129 | * Set a bit to 1 in a readout list ( = AliHLTEventDDL ) | |
1130 | * -> enable DDL for readout | |
1131 | * @param list readout list | |
1132 | * @param ddlId DDL Id to be turned on ( Decimal ) | |
1133 | */ | |
1134 | void EnableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const { | |
1135 | SetDDLBit( list, ddlId, kTRUE ); | |
1136 | } | |
1137 | ||
1138 | /** | |
1139 | * Set a bit to 0 in a readout list ( = AliHLTEventDDL ) | |
1140 | * -> disable DDL for readout | |
1141 | * @param list readout list | |
1142 | * @param ddlId DDL Id to be turned on ( Decimal ) | |
1143 | */ | |
1144 | void DisableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const { | |
1145 | SetDDLBit( list, ddlId, kFALSE ); | |
1146 | } | |
1147 | ||
1148 | /** | |
1149 | * Set or unset bit a readout list ( = AliHLTEventDDL ) | |
1150 | * -> enable or disable DDL for readout | |
1151 | * @param list readout list | |
1152 | * @param ddlId DDL Id to be turned on ( Decimal ) | |
1153 | * @param state kTRUE sets it, kFALSE unsets it | |
1154 | */ | |
1155 | void SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const; | |
1156 | ||
1157 | /** | |
1158 | * Get the first word of a detector, which has a set DDL bit. | |
1159 | * Beware, this only works if DDLs of 1 detector are set. In the | |
1160 | * case of the TPC and TOF, which use 8 and 3 words, the first | |
1161 | * word is returned. | |
1162 | * @param list readout list | |
1163 | * @return returns the detector index, -1 if no bit is set | |
1164 | * at all or several detectors (=error) | |
1165 | */ | |
1166 | Int_t GetFirstUsedDDLWord(AliHLTEventDDL &list) const; | |
1167 | ||
559631d5 | 1168 | /** |
1169 | * Copy a struct from block data. | |
1170 | * The function checks for block size and struct size. The least common | |
1171 | * size will be copied to the target struct, remaining fields are initialized | |
1172 | * to zero.<br> | |
1173 | * The target struct must have a 32bit struct size indicator as first member. | |
1174 | * @param pStruct target struct | |
1175 | * @param iStructSize size of the struct | |
559631d5 | 1176 | * @param iBlockNo index of input block |
1177 | * @param structname name of the struct (log messages) | |
1178 | * @param eventname name of the event (log messages) | |
1179 | * @return size copied, neg. error if failed | |
1180 | */ | |
83fec083 | 1181 | int CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo, |
559631d5 | 1182 | const char* structname="", const char* eventname=""); |
1183 | ||
f23a6e1a | 1184 | private: |
b426991e | 1185 | /** copy constructor prohibited */ |
559631d5 | 1186 | AliHLTComponent(const AliHLTComponent&); |
b426991e | 1187 | /** assignment operator prohibited */ |
559631d5 | 1188 | AliHLTComponent& operator=(const AliHLTComponent&); |
1189 | ||
3cde846d | 1190 | /** |
1191 | * Increment the internal event counter. | |
1192 | * To be used by the friend classes AliHLTProcessor, AliHLTDataSource | |
1193 | * and AliHLTDataSink. | |
1194 | * @return new value of the internal event counter | |
a655eae3 | 1195 | * @internal |
3cde846d | 1196 | */ |
1197 | int IncrementEventCounter(); | |
1198 | ||
a655eae3 | 1199 | /** |
1200 | * Find the first input block of specified data type beginning at index. | |
1edbbe49 | 1201 | * Input blocks containing a TObject have the size of the object as an |
1202 | * unsigned 32 bit number in the first 4 bytes. This has to match the block | |
1203 | * size minus 4. | |
3dd8541e | 1204 | * |
1205 | * kAliHLTAllDataTypes is a special data type which includes both | |
1206 | * kAliHLTVoidDataType and kAliHLTAnyDataType. | |
1207 | * | |
a655eae3 | 1208 | * @param dt data type |
1209 | * @param startIdx index to start the search | |
1edbbe49 | 1210 | * @param bObject check if this is an object |
a655eae3 | 1211 | * @return index of the block, -ENOENT if no block found |
1212 | * | |
1213 | * @internal | |
1214 | */ | |
1edbbe49 | 1215 | int FindInputBlock(const AliHLTComponentDataType& dt, int startIdx=-1, int bObject=0) const; |
a655eae3 | 1216 | |
1217 | /** | |
1218 | * Get index in the array of input bocks. | |
1219 | * Calculate index and check integrety of a block data structure pointer. | |
1220 | * @param pBlock pointer to block data | |
1221 | * @return index of the block, -ENOENT if no block found | |
1222 | * | |
1223 | * @internal | |
1224 | */ | |
66043029 | 1225 | int FindInputBlock(const AliHLTComponentBlockData* pBlock) const; |
a655eae3 | 1226 | |
1227 | /** | |
1228 | * Create an object from a specified input block. | |
1229 | * @param idx index of the input block | |
1230 | * @param bForce force the retrieval of an object, error messages | |
1231 | * are suppressed if \em bForce is not set | |
1232 | * @return pointer to TObject, caller must delete the object after use | |
1233 | * | |
1234 | * @internal | |
1235 | */ | |
1236 | TObject* CreateInputObject(int idx, int bForce=0); | |
1237 | ||
1238 | /** | |
1239 | * Get input object | |
8451168b | 1240 | * Get object from the input block list. The methods first checks whether the |
1241 | * object was already created. If not, it is created by @ref CreateInputObject | |
1242 | * and inserted into the list of objects. | |
a655eae3 | 1243 | * @param idx index in the input block list |
1244 | * @param classname name of the class, object is checked for correct class | |
1245 | * name if set | |
1246 | * @param bForce force the retrieval of an object, error messages | |
1247 | * are suppressed if \em bForce is not set | |
1248 | * @return pointer to TObject | |
1249 | * | |
1250 | * @internal | |
1251 | */ | |
1252 | TObject* GetInputObject(int idx, const char* classname=NULL, int bForce=0); | |
1253 | ||
8451168b | 1254 | /** |
1255 | * Clean the list of input objects. | |
1256 | * Cleanup is done at the end of each event processing. | |
1257 | */ | |
1258 | int CleanupInputObjects(); | |
1259 | ||
a655eae3 | 1260 | /** |
1261 | * Insert a buffer into the output block stream. | |
1262 | * This is the only method to insert blocks into the output stream, called | |
1263 | * from all types of the Pushback method. The actual data might have been | |
1264 | * written to the output buffer already. In that case NULL can be provided | |
79c114b5 | 1265 | * as buffer, only the block descriptor will be build. If a header is specified, |
1266 | * it will be inserted before the buffer, default is no header. | |
a655eae3 | 1267 | * @param pBuffer pointer to buffer |
32db4144 | 1268 | * @param iBufferSize size of the buffer in byte |
a655eae3 | 1269 | * @param dt data type |
1270 | * @param spec data specification | |
79c114b5 | 1271 | * @param pHeader pointer to header |
1272 | * @param iHeaderSize size of Header | |
b6800be0 | 1273 | * @return neg. error code if failed |
a655eae3 | 1274 | */ |
79c114b5 | 1275 | int InsertOutputBlock(void* pBuffer, int iBufferSize, |
a655eae3 | 1276 | const AliHLTComponentDataType& dt, |
79c114b5 | 1277 | AliHLTUInt32_t spec, |
1278 | void* pHeader=NULL, int iHeaderSize=0); | |
a655eae3 | 1279 | |
a0aeb701 | 1280 | /** |
1281 | * Add a component statistics block to the output. | |
1282 | */ | |
1283 | int AddComponentStatistics(AliHLTComponentBlockDataList& blocks, | |
1284 | AliHLTUInt8_t* buffer, | |
1285 | AliHLTUInt32_t bufferSize, | |
1286 | AliHLTUInt32_t offset, | |
1287 | AliHLTComponentStatisticsList& stats) const; | |
1288 | ||
bfccbf68 | 1289 | /** The global component handler instance */ |
a655eae3 | 1290 | static AliHLTComponentHandler* fgpComponentHandler; //! transient |
70ed7d01 | 1291 | |
bfccbf68 | 1292 | /** The environment where the component is running in */ |
a655eae3 | 1293 | AliHLTComponentEnvironment fEnvironment; // see above |
f23a6e1a | 1294 | |
a655eae3 | 1295 | /** Set by ProcessEvent before the processing starts */ |
1296 | AliHLTEventID_t fCurrentEvent; // see above | |
f23a6e1a | 1297 | |
3cde846d | 1298 | /** internal event no */ |
a655eae3 | 1299 | int fEventCount; // see above |
1300 | ||
1301 | /** the number of failed events */ | |
1302 | int fFailedEvents; // see above | |
1303 | ||
1304 | /** event data struct of the current event under processing */ | |
1305 | AliHLTComponentEventData fCurrentEventData; // see above | |
1306 | ||
1307 | /** array of input data blocks of the current event */ | |
1308 | const AliHLTComponentBlockData* fpInputBlocks; //! transient | |
1309 | ||
1310 | /** index of the current input block */ | |
1311 | int fCurrentInputBlock; // see above | |
1312 | ||
1313 | /** data type of the last block search */ | |
1314 | AliHLTComponentDataType fSearchDataType; // see above | |
1315 | ||
1316 | /** name of the class for the object to search for */ | |
1317 | string fClassName; // see above | |
1318 | ||
1319 | /** array of generated input objects */ | |
1320 | TObjArray* fpInputObjects; //! transient | |
1321 | ||
1322 | /** the output buffer */ | |
1323 | AliHLTUInt8_t* fpOutputBuffer; //! transient | |
1324 | ||
1325 | /** size of the output buffer */ | |
1326 | AliHLTUInt32_t fOutputBufferSize; // see above | |
1327 | ||
1328 | /** size of data written to output buffer */ | |
1329 | AliHLTUInt32_t fOutputBufferFilled; // see above | |
1330 | ||
1331 | /** list of ouput block data descriptors */ | |
2be3f004 | 1332 | AliHLTComponentBlockDataList fOutputBlocks; // see above |
3cde846d | 1333 | |
90ebac25 | 1334 | /** stopwatch array */ |
1335 | TObjArray* fpStopwatches; //! transient | |
1336 | ||
79c114b5 | 1337 | /** array of memory files AliHLTMemoryFile */ |
2be3f004 | 1338 | AliHLTMemoryFilePList fMemFiles; //! transient |
79c114b5 | 1339 | |
559631d5 | 1340 | /** descriptor of the current run */ |
1341 | AliHLTRunDesc* fpRunDesc; //! transient | |
1342 | ||
1343 | /** the current DDL list */ | |
1344 | AliHLTEventDDL* fpDDLList; //! transient | |
1345 | ||
82c58a87 | 1346 | /** external fct to set CDB run no, indicates external CDB initialization */ |
1347 | void* fCDBSetRunNoFunc; //! transient | |
579d9eb7 | 1348 | |
1349 | /** id of the component in the analysis chain */ | |
1350 | string fChainId; //! transient | |
1351 | ||
a0aeb701 | 1352 | /** optional benchmarking for the component statistics */ |
1353 | TStopwatch* fpBenchmark; //! transient | |
1354 | ||
1355 | /** component requires steering data blocks */ | |
1356 | bool fRequireSteeringBlocks; //! transient | |
1357 | ||
1358 | ClassDef(AliHLTComponent, 7) | |
f23a6e1a | 1359 | }; |
1360 | #endif |