4 #ifndef ALIHLTCOMPONENT_H
5 #define ALIHLTCOMPONENT_H
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 */
10 /** @file AliHLTComponent.h
11 @author Matthias Richter, Timm Steinbeck
13 @brief Base class declaration for HLT components.
14 @note The class is both used in Online (PubSub) and Offline (AliRoot)
17 // see below for class documentation
19 // refer to README to build package
21 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
24 * @defgroup alihlt_component Component handling of the HLT module
25 * This section describes the the component handling for the HLT module.
30 #include "AliHLTLogging.h"
31 #include "AliHLTDataTypes.h"
32 //#include "AliHLTDefinitions.h"
35 * The names have been changed for Aliroot's coding conventions sake
36 * The old names are defined for backward compatibility with the
37 * stand alone SampleLib package
39 typedef AliHLTComponentLogSeverity AliHLTComponent_LogSeverity;
40 typedef AliHLTComponentEventData AliHLTComponent_EventData;
41 typedef AliHLTComponentShmData AliHLTComponent_ShmData;
42 typedef AliHLTComponentDataType AliHLTComponent_DataType;
43 typedef AliHLTComponentBlockData AliHLTComponent_BlockData;
44 typedef AliHLTComponentTriggerData AliHLTComponent_TriggerData;
45 typedef AliHLTComponentEventDoneData AliHLTComponent_EventDoneData;
47 class AliHLTComponentHandler;
50 class AliHLTComponent;
51 class AliHLTMemoryFile;
53 /** list of component data type structures */
54 typedef vector<AliHLTComponentDataType> AliHLTComponentDataTypeList;
55 /** list of component block data structures */
56 typedef vector<AliHLTComponentBlockData> AliHLTComponentBlockDataList;
57 /** list of component pointers */
58 typedef vector<AliHLTComponent*> AliHLTComponentPList;
59 /** list of memory file pointers */
60 typedef vector<AliHLTMemoryFile*> AliHLTMemoryFilePList;
63 * @class AliHLTComponent
64 * Base class of HLT data processing components.
65 * The class provides a common interface for HLT data processing components.
66 * The interface can be accessed from the online HLT framework or the AliRoot
67 * offline analysis framework.
68 * @section alihltcomponent-properties Component identification and properties
69 * Each component must provide a unique ID, input and output data type indications,
70 * and a spawn function.
71 * @subsection alihltcomponent-req-methods Required property methods
72 * - @ref GetComponentID
73 * - @ref GetInputDataTypes (see @ref alihltcomponent-type for default
75 * - @ref GetOutputDataType (see @ref alihltcomponent-type for default
77 * - @ref GetOutputDataSize (see @ref alihltcomponent-type for default
81 * @subsection alihltcomponent-opt-mehods Optional handlers
84 * - @ref GetOutputDataTypes
85 * If the component has multiple output data types @ref GetOutputDataType
86 * should return @ref kAliHLTMultipleDataType. The framework will invoke
87 * @ref GetOutputDataTypes, a list can be filled.
89 * @subsection alihltcomponent-processing-mehods Data processing
92 * @subsection alihltcomponent-type Component type
93 * Components can be of type
94 * - @ref kSource components which only produce data
95 * - @ref kProcessor components which consume and produce data
96 * - @ref kSink components which only consume data
98 * where data production and consumption refer to the analysis data stream. In
99 * order to indicate the type, a child component can overload the
100 * @ref GetComponentType function.
101 * @subsubsection alihltcomponent-type-std Standard implementations
102 * Components in general do not need to implement this function, standard
103 * implementations of the 3 types are available:
104 * - AliHLTDataSource for components of type @ref kSource <br>
105 * All types of data sources can inherit from AliHLTDataSource and must
106 * implement the @ref AliHLTDataSource::GetEvent method. The class
107 * also implements a standard method for @ref GetInputDataTypes.
109 * - AliHLTProcessor for components of type @ref kProcessor <br>
110 * All types of data processors can inherit from AliHLTDataSource and must
111 * implement the @ref AliHLTProcessor::DoEvent method.
113 * - AliHLTDataSink for components of type @ref kSink <br>
114 * All types of data processors can inherit from AliHLTDataSource and must
115 * implement the @ref AliHLTDataSink::DumpEvent method. The class
116 * also implements a standard method for @ref GetOutputDataType and @ref
119 * @subsection alihltcomponent-environment Running environment
121 * In order to adapt to different environments (on-line/off-line), the component
122 * gets an environment structure with function pointers. The base class provides
123 * member functions for those environment dependend functions. The member
124 * functions are used by the component implementation and are re-mapped to the
125 * corresponding functions.
127 * @section alihltcomponent-interfaces Component interfaces
128 * Each of the 3 standard component base classes AliHLTProcessor, AliHLTDataSource
129 * and AliHLTDataSink provides it's own processing method (see
130 * @ref alihltcomponent-type-std), which splits into a high and a low-level
131 * method. For the @ref alihltcomponent-low-level-interface, all parameters are
132 * shipped as function arguments, the component is supposed to dump data to the
133 * output buffer and handle all block descriptors.
134 * The @ref alihltcomponent-high-level-interface is the standard processing
135 * method and will be used whenever the low-level method is not overloaded.
137 * In both cases it is necessary to calculate/estimate the size of the output
138 * buffer before the processing. Output buffers can never be allocated inside
139 * the component because of the push-architecture of the HLT.
140 * For that reason the @ref GetOutputDataSize function should return a rough
141 * estimatian of the data to be produced by the component. The component is
142 * responsible for checking the memory size and must return -ENOSPC if the
143 * available buffer is to small, and update the estimator respectively. The
144 * framework will allocate a buffer of appropriate size and call the processing
147 * @subsection alihltcomponent-error-codes Data processing
148 * For return codes, the following scheme applies:
149 * - The data processing methods have to indicate error conditions by a negative
150 * error/return code. Preferably the system error codes are used like
151 * e.g. -EINVAL. This requires to include the header
153 * \#include \<cerrno\>
155 * - If no suitable input block could be found (e.g. no clusters for the TPC cluster
156 * finder) set size to 0, block list is empty, return 0
157 * - If no ususable or significant signal could be found in the input blocks
158 * return an empty output block, set size accordingly, and return 0. An empty output
159 * block here could be either a real empty one of size 0 (in which case size also
160 * would have to be set to zero) or a block filled with just the minimum necessary
161 * accounting/meta-structures. E.g. in the TPC
163 * @subsection alihltcomponent-high-level-interface High-level interface
164 * The high-level component interface provides functionality to exchange ROOT
165 * structures between components. In contrast to the
166 * @ref alihltcomponent-low-level-interface, a couple of functions can be used
167 * to access data blocks of the input stream
168 * and send data blocks or ROOT TObject's to the output stream. The functionality
169 * is hidden from the user and is implemented by using ROOT's TMessage class.
171 * @subsubsection alihltcomponent-high-level-int-methods Interface methods
172 * The interface provides a couple of methods in order to get objects from the
173 * input, data blocks (non TObject) from the input, and to push back objects and
174 * data blocks to the output. For convenience there are several functions of
175 * identical name (and similar behavior) with different parameters defined.
176 * Please refer to the function documentation.
177 * - @ref GetNumberOfInputBlocks <br>
178 * return the number of data blocks in the input stream
179 * - @ref GetFirstInputObject <br>
180 * get the first object of a specific data type
181 * - @ref GetNextInputObject <br>
182 * get the next object of same data type as last GetFirstInputObject/Block call
183 * - @ref GetFirstInputBlock <br>
184 * get the first block of a specific data type
185 * - @ref GetNextInputBlock <br>
186 * get the next block of same data type as last GetFirstInputBlock/Block call
187 * - @ref PushBack <br>
188 * insert an object or data buffer into the output
189 * - @ref CreateEventDoneData <br>
190 * add event information to the output
192 * In addition, the processing methods are simplified a bit by cutting out most of
195 * - @ref AliHLTProcessor::DoEvent
196 * - @ref AliHLTDataSource::GetEvent
197 * - @ref AliHLTDataSink::DumpEvent
199 * \em IMPORTANT: objects and block descriptors provided by the high-level interface
200 * <b>MUST NOT BE DELETED</b> by the caller.
202 * @subsubsection alihltcomponent-high-level-int-guidelines High-level interface guidelines
203 * - Structures must inherit from the ROOT object base class TObject in order be
204 * transported by the transportation framework.
205 * - all pointer members must be transient (marked <tt>//!</tt> behind the member
206 * definition), i.e. will not be stored/transported, or properly marked
207 * (<tt>//-></tt>) in order to call the streamer of the object the member is pointing
208 * to. The latter is not recomended. Structures to be transported between components
209 * should be streamlined.
210 * - no use of stl vectors/strings, use appropriate ROOT classes instead
212 * @subsection alihltcomponent-low-level-interface Low-level interface
213 * The low-level component interface consists of the specific data processing
214 * methods for @ref AliHLTProcessor, @ref AliHLTDataSource, and @ref AliHLTDataSink.
215 * - @ref AliHLTProcessor::DoEvent
216 * - @ref AliHLTDataSource::GetEvent
217 * - @ref AliHLTDataSink::DumpEvent
220 * @section alihltcomponent-handling Component handling
221 * The handling of HLT analysis components is carried out by the AliHLTComponentHandler.
222 * Component are registered automatically at load-time of the component shared library
223 * under the following suppositions:
224 * - the component library has to be loaded from the AliHLTComponentHandler using the
225 * @ref AliHLTComponentHandler::LoadLibrary method.
226 * - the component implementation defines one global object (which is generated
227 * when the library is loaded)
229 * @subsection alihltcomponent-design-rules General design considerations
230 * The analysis code should be implemented in one or more destict class(es). A
231 * \em component should be implemented which interface the destict analysis code to the
232 * component interface. This component generates the analysis object dynamically. <br>
234 * Assume you have an implemetation <tt> AliHLTDetMyAnalysis </tt>, another class <tt>
235 * AliHLTDetMyAnalysisComponent </tt> contains:
238 * AliHLTDetMyAnalysis* fMyAnalysis; //!
240 * The object should then be instantiated in the DoInit handler of
241 * <tt>AliHLTDetMyAnalysisComponent </tt>, and cleaned in the DoDeinit handler.
244 * - avoid big static arrays in the component, allocate the memory at runtime
246 * @ingroup alihlt_component
247 * @section alihltcomponent-members Class members
249 class AliHLTComponent : public AliHLTLogging {
251 /** standard constructor */
253 /** standard destructor */
254 virtual ~AliHLTComponent();
256 /** component type definitions */
257 enum TComponentType { kUnknown=0, kSource=1, kProcessor=2, kSink=3 };
260 * Init function to prepare data processing.
261 * Initialization of common data structures for a sequence of events.
262 * The call is redirected to the internal method @ref DoInit which can be
263 * overridden by the child class.<br>
264 * During Init also the environment structure is passed to the component.
265 * @param environ environment pointer with environment dependend function
267 * @param environParam additionel parameter for function calls, the pointer
269 * @param argc size of the argument array
270 * @param argv agument array for component initialization
272 virtual int Init( AliHLTComponentEnvironment* environ, void* environParam, int argc, const char** argv );
275 * Clean-up function to terminate data processing.
276 * Clean-up of common data structures after data processing.
277 * The call is redirected to the internal method @ref DoDeinit which can be
278 * overridden by the child class.
280 virtual int Deinit();
283 * Processing of one event.
284 * The method is the entrance of the event processing. The parameters are
285 * cached for uses with the high-level interface and the DoProcessing
286 * implementation is called.
293 * @param outputBlockCnt out: size of the output block array, set by the component
294 * @param outputBlocks out: the output block array is allocated internally
296 * @return neg. error code if failed
298 int ProcessEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
299 AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr,
300 AliHLTUInt32_t& size, AliHLTUInt32_t& outputBlockCnt,
301 AliHLTComponentBlockData*& outputBlocks,
302 AliHLTComponentEventDoneData*& edd );
305 * Internal processing of one event.
306 * The method is pure virtual and implemented by the child classes
307 * - @ref AliHLTProcessor
308 * - @ref AliHLTDataSource
309 * - @ref AliHLTDataSink
316 * @param outputBlocks out: the output block array is allocated internally
318 * @return neg. error code if failed
320 virtual int DoProcessing( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
321 AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr,
322 AliHLTUInt32_t& size,
323 AliHLTComponentBlockDataList& outputBlocks,
324 AliHLTComponentEventDoneData*& edd ) = 0;
328 * The function must not be called when running in AliRoot unless it it
329 * really wanted. The CDB path will be set to the specified path, which might
330 * override the path initialized at the beginning of the AliRoot reconstruction.
332 * The method is used from the external interface in order to set the correct
333 * path when running on-line. The function also initializes the function
334 * callback for setting the run no during operation.
336 * A separation of library and component handling is maybe appropriate in the
337 * future. Using the global component handler here is maybe not the cleanest
339 * @param cdbPath path of the CDB
340 * @param pHandler the component handler used for llibrary handling.
342 int InitCDB(const char* cdbPath, AliHLTComponentHandler* pHandler);
345 * Set the run no for the CDB.
346 * The function must not be called when running in AliRoot unless it it
347 * really wanted. The CDB path will be set to the specified path, which might
348 * override the run no initialized at the beginning of the AliRoot reconstruction.
350 * The method is used from the external interface in order to set the correct
351 * path when running on-line.
353 int SetCDBRunNo(int runNo);
355 // Information member functions for registration.
358 * Get the type of the component.
359 * The function is pure virtual and must be implemented by the child class.
360 * @return component type id
362 virtual TComponentType GetComponentType() = 0; // Source, sink, or processor
365 * Get the id of the component.
366 * Each component is identified by a unique id.
367 * The function is pure virtual and must be implemented by the child class.
368 * @return component id (string)
370 virtual const char* GetComponentID() = 0;
373 * Get the input data types of the component.
374 * The function is pure virtual and must be implemented by the child class.
375 * @return list of data types in the vector reference
377 virtual void GetInputDataTypes( AliHLTComponentDataTypeList& ) = 0;
380 * Get the output data type of the component.
381 * The function is pure virtual and must be implemented by the child class.
382 * @return output data type
384 virtual AliHLTComponentDataType GetOutputDataType() = 0;
387 * Get the output data types of the component.
388 * The function can be implemented to indicate multiple output data types
389 * in the target array.
390 * @ref GetOutputDataType must return @ref kAliHLTMultipleDataType in order
391 * to invoke this method.
392 * @param tgtList list to receive the data types
393 * @return no of output data types, data types in the target list
395 virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
398 * Get a ratio by how much the data volume is shrinked or enhanced.
399 * The function is pure virtual and must be implemented by the child class.
400 * @param constBase <i>return</i>: additive part, independent of the
402 * @param inputMultiplier <i>return</i>: multiplication ratio
403 * @return values in the reference variables
405 virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ) = 0;
409 * Each component must implement a spawn function to create a new instance of
410 * the class. Basically the function must return <i>new <b>my_class_name</b></i>.
411 * @return new class instance
413 virtual AliHLTComponent* Spawn() = 0;
416 * Find matching data types between this component and a consumer component.
417 * Currently, a component can produce only one type of data. This restriction is most
418 * likely to be abolished in the future.
419 * @param pConsumer a component and consumer of the data produced by this component
420 * @param tgtList reference to a vector list to receive the matching data types.
421 * @return >= 0 success, neg. error code if failed
423 int FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList);
426 * Set the global component handler.
427 * The static method is needed for the automatic registration of components.
429 static int SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite=0);
432 * Clear the global component handler.
433 * The static method is needed for the automatic registration of components.
435 static int UnsetGlobalComponentHandler();
438 * Helper function to convert the data type to a string.
439 * @param type data type structure
440 * @param mode 0 print string origin:type <br>
444 static string DataType2Text( const AliHLTComponentDataType& type, int mode=0);
447 * Helper function to print content of data type.
449 static void PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format=NULL);
452 * helper function to initialize AliHLTComponentEventData structure
454 static void FillEventData(AliHLTComponentEventData& evtData);
457 * Print info on an AliHLTComponentDataType structure
458 * This is just a helper function to examine an @ref AliHLTComponentDataType
461 static void PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt);
464 * Fill AliHLTComponentBlockData structure with default values.
465 * @param blockData reference to data structure
467 static void FillBlockData( AliHLTComponentBlockData& blockData );
470 * Fill AliHLTComponentShmData structure with default values.
471 * @param shmData reference to data structure
473 static void FillShmData( AliHLTComponentShmData& shmData );
476 * Fill AliHLTComponentDataType structure with default values.
477 * @param dataType reference to data structure
479 static void FillDataType( AliHLTComponentDataType& dataType );
482 * Copy data type structure
483 * Copies the value an AliHLTComponentDataType structure to another one
484 * @param[out] tgtdt target structure
485 * @param[in] srcdt source structure
487 static void CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt);
490 * Set the ID and Origin of an AliHLTComponentDataType structure.
491 * The function sets the fStructureSize member and copies the strings
492 * to the ID and Origin. Only characters from the valid part of the string
493 * are copied, the rest is filled with 0's. <br>
494 * Please note that the fID and fOrigin members are not strings, just arrays of
495 * chars of size @ref kAliHLTComponentDataTypefIDsize and
496 * @ref kAliHLTComponentDataTypefOriginSize respectively and not necessarily with
497 * a terminating zero. <br>
498 * It is possible to pass NULL pointers as id or origin argument, in that case they
500 * @param tgtdt target data type structure
501 * @param id ID string
502 * @param origin Origin string
504 static void SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin);
507 * Set the ID and Origin of an AliHLTComponentDataType structure.
508 * Given the fact that the data type ID is 64bit wide and origin 32, this helper
509 * function sets the data type from those two parameters.
510 * @param tgtdt target data type structure
512 * @param origin 32bit origin
514 static void SetDataType(AliHLTComponentDataType& dt, AliHLTUInt64_t id, AliHLTUInt32_t orig);
517 * Stopwatch type for benchmarking.
519 enum AliHLTStopwatchType {
520 /** total time for event processing */
522 /** detector algorithm w/o interface callbacks */
528 /** number of types */
533 * Helper class for starting and stopping a stopwatch.
534 * The guard can be used by instantiating an object in a function. The
535 * specified stopwatch is started and the previous stopwatch put on
536 * hold. When the function is terminated, the object is deleted automatically
537 * deleted, stopping the stopwatch and starting the one on hold.<br>
538 * \em IMPORTANT: never create dynamic objects from this guard as this violates
539 * the idea of a guard.
541 class AliHLTStopwatchGuard {
543 /** standard constructor (not for use) */
544 AliHLTStopwatchGuard();
546 AliHLTStopwatchGuard(TStopwatch* pStart);
547 /** copy constructor (not for use) */
548 AliHLTStopwatchGuard(const AliHLTStopwatchGuard&);
549 /** assignment operator (not for use) */
550 AliHLTStopwatchGuard& operator=(const AliHLTStopwatchGuard&);
552 ~AliHLTStopwatchGuard();
556 * Hold the previous guard for the existence of this guard.
557 * Checks whether this guard controls a new stopwatch. In that case, the
558 * previous guard and its stopwatch are put on hold.
559 * @param pSucc instance of the stopwatch of the new guard
560 * @return 1 if pSucc is a different stopwatch which should
562 * 0 if it controls the same stopwatch
564 int Hold(TStopwatch* pSucc);
567 * Resume the previous guard.
568 * Checks whether the peceeding guard controls a different stopwatch. In that
569 * case, the its stopwatch is resumed.
570 * @param pSucc instance of the stopwatch of the new guard
571 * @return 1 if pSucc is a different stopwatch which should
573 * 0 if it controls the same stopwatch
575 int Resume(TStopwatch* pSucc);
577 /** the stopwatch controlled by this guard */
578 TStopwatch* fpStopwatch; //!transient
580 /** previous stopwatch guard, put on hold during existence of the guard */
581 AliHLTStopwatchGuard* fpPrec; //!transient
583 /** active stopwatch guard */
584 static AliHLTStopwatchGuard* fgpCurrent; //!transient
588 * Set a stopwatch for a given purpose.
589 * @param pSW stopwatch object
590 * @param type type of the stopwatch
592 int SetStopwatch(TObject* pSW, AliHLTStopwatchType type=kSWBase);
595 * Init a set of stopwatches.
596 * @param pStopwatches object array of stopwatches
598 int SetStopwatches(TObjArray* pStopwatches);
603 * Default method for the internal initialization.
604 * The method is called by @ref Init
606 virtual int DoInit( int argc, const char** argv );
609 * Default method for the internal clean-up.
610 * The method is called by @ref Deinit
612 virtual int DoDeinit();
615 * Reconfigure the component.
616 * The method is called when an event of type @ref kAliHLTDataTypeComConf
617 * {COM_CONF:PRIV} is received by the component. If the event is sent as
618 * part of a normal event, the component configuration is called first.
620 * The CDB path parameter specifies the path in the CDB, i.e. without
621 * leading absolute path of the CDB location. The framework might alse
622 * provide the id of the component in the analysis chain.
624 * \b Note: The CDB will be initialized by the framework, either already set
625 * from AliRoot or from the wrapper interface during initialization.
627 * @param cdbEntry path of the cdbEntry
628 * @param chainId the id of the component in the analysis chain
629 * @note both parameters can be NULL, check before usage
631 virtual int Reconfigure(const char* cdbEntry, const char* chainId);
634 * Read the Preprocessor values.
635 * The function is invoked when the component is notified about available/
636 * updated data points from the detector Preprocessors. The 'modules'
637 * argument contains all detectors for which the Preprocessors have
638 * updated data points. The component has to implement the CDB access to
639 * get the desired data points.
640 * @param modules detectors for which the Preprocessors have updated
641 * data points: TPC, TRD, ITS, PHOS, MUON, or ALL if
642 * no argument was received.
643 * @return neg. error code if failed
645 virtual int ReadPreprocessorValues(const char* modules);
648 * General memory allocation method.
649 * All memory which is going to be used 'outside' of the interface must
650 * be provided by the framework (online or offline).
651 * The method is redirected to a function provided by the current
652 * framework. Function pointers are transferred via the @ref
653 * AliHLTComponentEnvironment structure.
655 void* AllocMemory( unsigned long size );
658 * Helper function to create a monolithic BlockData description block out
659 * of a list BlockData descriptors.
660 * For convenience, inside the interface vector lists are used, to make the
661 * interface pure C style, monilithic blocks must be exchanged.
662 * The method is redirected to a function provided by the current
663 * framework. Function pointers are transferred via the @ref
664 * AliHLTComponentEnvironment structure.
666 int MakeOutputDataBlockList( const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount,
667 AliHLTComponentBlockData** outputBlocks );
670 * Fill the EventDoneData structure.
671 * The method is redirected to a function provided by the current
672 * framework. Function pointers are transferred via the @ref
673 * AliHLTComponentEnvironment structure.
675 int GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd );
678 * Helper function to convert the data type to a string.
680 void DataType2Text(const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2]) const;
684 * @return value of the internal event counter
686 int GetEventCount() const;
689 * Get the number of input blocks.
690 * @return number of input blocks
692 int GetNumberOfInputBlocks() const;
695 * Get the first object of a specific data type from the input data.
696 * The hight-level methods provide functionality to transfer ROOT data
697 * structures which inherit from TObject.
698 * The method looks for the first ROOT object of type dt in the input stream.
699 * If also the class name is provided, the object is checked for the right
700 * class type. The input data block needs a certain structure, namely the
701 * buffer size as first word. If the cross check fails, the retrieval is
702 * silently abondoned, unless the \em bForce parameter is set.<br>
703 * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
704 * @param dt data type of the object
705 * @param classname class name of the object
706 * @param bForce force the retrieval of an object, error messages
707 * are suppressed if \em bForce is not set
708 * @return pointer to @ref TObject, NULL if no objects of specified type
711 const TObject* GetFirstInputObject(const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
712 const char* classname=NULL,
716 * Get the first object of a specific data type from the input data.
717 * The hight-level methods provide functionality to transfer ROOT data
718 * structures which inherit from TObject.
719 * The method looks for the first ROOT object of type specified by the ID and
720 * Origin strings in the input stream.
721 * If also the class name is provided, the object is checked for the right
722 * class type. The input data block needs a certain structure, namely the
723 * buffer size as first word. If the cross check fails, the retrieval is
724 * silently abondoned, unless the \em bForce parameter is set.<br>
725 * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
726 * @param dtID data type ID of the object
727 * @param dtOrigin data type origin of the object
728 * @param classname class name of the object
729 * @param bForce force the retrieval of an object, error messages
730 * are suppressed if \em bForce is not set
731 * @return pointer to @ref TObject, NULL if no objects of specified type
734 const TObject* GetFirstInputObject(const char* dtID,
735 const char* dtOrigin,
736 const char* classname=NULL,
740 * Get the next object of a specific data type from the input data.
741 * The hight-level methods provide functionality to transfer ROOT data
742 * structures which inherit from TObject.
743 * The method looks for the next ROOT object of type and class specified
744 * to the previous @ref GetFirstInputObject call.<br>
745 * \em Note: THE OBJECT MUST NOT BE DELETED by the caller.
746 * @param bForce force the retrieval of an object, error messages
747 * are suppressed if \em bForce is not set
748 * @return pointer to @ref TObject, NULL if no more objects available
750 const TObject* GetNextInputObject(int bForce=0);
753 * Get data type of an input block.
754 * Get data type of the object previously fetched via
755 * GetFirstInputObject/NextInputObject or the last one if no object
757 * @param pObject pointer to TObject
758 * @return data specification, kAliHLTVoidDataSpec if failed
760 AliHLTComponentDataType GetDataType(const TObject* pObject=NULL);
763 * Get data specification of an input block.
764 * Get data specification of the object previously fetched via
765 * GetFirstInputObject/NextInputObject or the last one if no object
767 * @param pObject pointer to TObject
768 * @return data specification, kAliHLTVoidDataSpec if failed
770 AliHLTUInt32_t GetSpecification(const TObject* pObject=NULL);
773 * Get the first block of a specific data type from the input data.
774 * The method looks for the first block of type dt in the input stream. It is intended
775 * to be used within the high-level interface.<br>
776 * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
777 * @param dt data type of the block
778 * @return pointer to @ref AliHLTComponentBlockData
780 const AliHLTComponentBlockData* GetFirstInputBlock(const AliHLTComponentDataType& dt=kAliHLTAnyDataType);
783 * Get the first block of a specific data type from the input data.
784 * The method looks for the first block of type specified by the ID and
785 * Origin strings in the input stream. It is intended
786 * to be used within the high-level interface.<br>
787 * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
788 * @param dtID data type ID of the block
789 * @param dtOrigin data type origin of the block
790 * @return pointer to @ref AliHLTComponentBlockData
792 const AliHLTComponentBlockData* GetFirstInputBlock(const char* dtID,
793 const char* dtOrigin);
796 * Get input block by index.<br>
797 * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
798 * @return pointer to AliHLTComponentBlockData, NULL if index out of range
800 const AliHLTComponentBlockData* GetInputBlock(int index);
803 * Get the next block of a specific data type from the input data.
804 * The method looks for the next block of type and class specified
805 * to the previous @ref GetFirstInputBlock call.
806 * To be used within the high-level interface.<br>
807 * \em Note: THE BLOCK DESCRIPTOR MUST NOT BE DELETED by the caller.
809 const AliHLTComponentBlockData* GetNextInputBlock();
812 * Get data specification of an input block.
813 * Get data specification of the input bblock previously fetched via
814 * GetFirstInputObject/NextInputObject or the last one if no block
816 * @param pBlock pointer to input block
817 * @return data specification, kAliHLTVoidDataSpec if failed
819 AliHLTUInt32_t GetSpecification(const AliHLTComponentBlockData* pBlock=NULL);
822 * Forward an input object to the output.
823 * Forward the input block of an object previously fetched via
824 * GetFirstInputObject/NextInputObject or the last one if no object
826 * The block descriptor of the input block is forwarded to the
828 * @param pObject pointer to TObject
829 * @return neg. error code if failed
831 int Forward(const TObject* pObject);
834 * Forward an input block to the output.
835 * Forward the input block fetched via GetFirstInputObject/
836 * NextInputBlock or the last one if no block specified.
837 * The block descriptor of the input block is forwarded to the
839 * @param pBlock pointer to input block
840 * @return neg. error code if failed
842 int Forward(const AliHLTComponentBlockData* pBlock=NULL);
845 * Insert an object into the output.
846 * If header is specified, it will be inserted before the root object,
847 * default is no header.
848 * @param pObject pointer to root object
849 * @param dt data type of the object
850 * @param spec data specification
851 * @param pHeader pointer to header
852 * @param headerSize size of Header
853 * @return neg. error code if failed
855 int PushBack(TObject* pObject, const AliHLTComponentDataType& dt,
856 AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
857 void* pHeader=NULL, int headerSize=0);
860 * Insert an object into the output.
861 * If header is specified, it will be inserted before the root object,
862 * default is no header.
863 * @param pObject pointer to root object
864 * @param dtID data type ID of the object
865 * @param dtOrigin data type origin of the object
866 * @param spec data specification
867 * @param pHeader pointer to header
868 * @param headerSize size of Header
869 * @return neg. error code if failed
871 int PushBack(TObject* pObject, const char* dtID, const char* dtOrigin,
872 AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
873 void* pHeader=NULL, int headerSize=0);
876 * Insert an object into the output.
877 * @param pBuffer pointer to buffer
878 * @param iSize size of the buffer
879 * @param dt data type of the object
880 * @param spec data specification
881 * @param pHeader pointer to header
882 * @param headerSize size of Header
883 * @return neg. error code if failed
885 int PushBack(void* pBuffer, int iSize, const AliHLTComponentDataType& dt,
886 AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
887 void* pHeader=NULL, int headerSize=0);
890 * Insert an object into the output.
891 * @param pBuffer pointer to buffer
892 * @param iSize size of the buffer
893 * @param dtID data type ID of the object
894 * @param dtOrigin data type origin of the object
895 * @param spec data specification
896 * @param pHeader pointer to header
897 * @param headerSize size of Header
898 * @return neg. error code if failed
900 int PushBack(void* pBuffer, int iSize, const char* dtID, const char* dtOrigin,
901 AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
902 void* pHeader=NULL, int headerSize=0);
905 * Estimate size of a TObject
907 * @return buffer size in byte
909 int EstimateObjectSize(TObject* pObject) const;
912 * Create a memory file in the output stream.
913 * This method creates a TFile object which stores all data in
914 * memory instead of disk. The TFile object is published as binary data.
915 * The instance can be used like a normal TFile object. The TFile::Close
916 * or @ref CloseMemoryFile method has to be called in order to flush the
919 * \b Note: The returned object is deleted by the framework.
920 * @param capacity total size reserved for the memory file
921 * @param dtID data type ID of the file
922 * @param dtOrigin data type origin of the file
923 * @param spec data specification
924 * @return file handle, NULL if failed
926 AliHLTMemoryFile* CreateMemoryFile(int capacity, const char* dtID, const char* dtOrigin,
927 AliHLTUInt32_t spec=kAliHLTVoidDataSpec);
930 * Create a memory file in the output stream.
931 * This method creates a TFile object which stores all data in
932 * memory instead of disk. The TFile object is published as binary data.
933 * The instance can be used like a normal TFile object. The TFile::Close
934 * or @ref CloseMemoryFile method has to be called in order to flush the
937 * \b Note: The returned object is deleted by the framework.
938 * @param capacity total size reserved for the memory file
939 * @param dt data type of the file
940 * @param spec data specification
941 * @return file handle, NULL if failed
943 AliHLTMemoryFile* CreateMemoryFile(int capacity,
944 const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
945 AliHLTUInt32_t spec=kAliHLTVoidDataSpec);
948 * Create a memory file in the output stream.
949 * This method creates a TFile object which stores all data in
950 * memory instead of disk. The TFile object is published as binary data.
951 * The instance can be used like a normal TFile object. The TFile::Close
952 * or @ref CloseMemoryFile method has to be called in order to flush the
955 * \b Note: The returned object is deleted by the framework.
956 * @param dtID data type ID of the file
957 * @param dtOrigin data type origin of the file
958 * @param spec data specification
959 * @param capacity fraction of the available output buffer size
960 * @return file handle, NULL if failed
962 AliHLTMemoryFile* CreateMemoryFile(const char* dtID, const char* dtOrigin,
963 AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
967 * Create a memory file in the output stream.
968 * This method creates a TFile object which stores all data in
969 * memory instead of disk. The TFile object is published as binary data.
970 * The instance can be used like a normal TFile object. The TFile::Close
971 * or @ref CloseMemoryFile method has to be called in order to flush the
974 * \b Note: The returned object is deleted by the framework.
975 * @param dt data type of the file
976 * @param spec data specification
977 * @param capacity fraction of the available output buffer size
978 * @return file handle, NULL if failed
980 AliHLTMemoryFile* CreateMemoryFile(const AliHLTComponentDataType& dt=kAliHLTAnyDataType,
981 AliHLTUInt32_t spec=kAliHLTVoidDataSpec,
985 * Write an object to memory file in the output stream.
986 * @param pFile file handle
987 * @param pObject pointer to root object
988 * @param key key in ROOT file
989 * @param option options, see TObject::Write
990 * @return neg. error code if failed
991 * - -ENOSPC no space left
993 int Write(AliHLTMemoryFile* pFile, const TObject* pObject, const char* key=NULL, int option=TObject::kOverwrite);
996 * Close object memory file.
997 * @param pFile file handle
998 * @return neg. error code if failed
999 * - -ENOSPC buffer size too small
1001 int CloseMemoryFile(AliHLTMemoryFile* pFile);
1004 * Insert event-done data information into the output.
1005 * @param edd event-done data information
1007 int CreateEventDoneData(AliHLTComponentEventDoneData edd);
1010 * Get current run number
1012 AliHLTUInt32_t GetRunNo() const;
1015 * Get the current run type.
1017 AliHLTUInt32_t GetRunType() const;
1020 * Set a bit to 1 in a readout list ( = AliHLTEventDDL )
1021 * -> enable DDL for readout
1022 * @param list readout list
1023 * @param ddlId DDL Id to be turned on ( Decimal )
1025 void EnableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const {
1026 SetDDLBit( list, ddlId, kTRUE );
1030 * Set a bit to 0 in a readout list ( = AliHLTEventDDL )
1031 * -> disable DDL for readout
1032 * @param list readout list
1033 * @param ddlId DDL Id to be turned on ( Decimal )
1035 void DisableDDLBit(AliHLTEventDDL &list, Int_t ddlId ) const {
1036 SetDDLBit( list, ddlId, kFALSE );
1040 * Set or unset bit a readout list ( = AliHLTEventDDL )
1041 * -> enable or disable DDL for readout
1042 * @param list readout list
1043 * @param ddlId DDL Id to be turned on ( Decimal )
1044 * @param state kTRUE sets it, kFALSE unsets it
1046 void SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const;
1049 * Get the first word of a detector, which has a set DDL bit.
1050 * Beware, this only works if DDLs of 1 detector are set. In the
1051 * case of the TPC and TOF, which use 8 and 3 words, the first
1053 * @param list readout list
1054 * @return returns the detector index, -1 if no bit is set
1055 * at all or several detectors (=error)
1057 Int_t GetFirstUsedDDLWord(AliHLTEventDDL &list) const;
1060 * Copy a struct from block data.
1061 * The function checks for block size and struct size. The least common
1062 * size will be copied to the target struct, remaining fields are initialized
1064 * The target struct must have a 32bit struct size indicator as first member.
1065 * @param pStruct target struct
1066 * @param iStructSize size of the struct
1067 * @param iBlockNo index of input block
1068 * @param structname name of the struct (log messages)
1069 * @param eventname name of the event (log messages)
1070 * @return size copied, neg. error if failed
1072 int CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
1073 const char* structname="", const char* eventname="");
1076 /** copy constructor prohibited */
1077 AliHLTComponent(const AliHLTComponent&);
1078 /** assignment operator prohibited */
1079 AliHLTComponent& operator=(const AliHLTComponent&);
1082 * Increment the internal event counter.
1083 * To be used by the friend classes AliHLTProcessor, AliHLTDataSource
1084 * and AliHLTDataSink.
1085 * @return new value of the internal event counter
1088 int IncrementEventCounter();
1091 * Find the first input block of specified data type beginning at index.
1092 * Input blocks containing a TObject have the size of the object as an
1093 * unsigned 32 bit number in the first 4 bytes. This has to match the block
1095 * @param dt data type
1096 * @param startIdx index to start the search
1097 * @param bObject check if this is an object
1098 * @return index of the block, -ENOENT if no block found
1102 int FindInputBlock(const AliHLTComponentDataType& dt, int startIdx=-1, int bObject=0) const;
1105 * Get index in the array of input bocks.
1106 * Calculate index and check integrety of a block data structure pointer.
1107 * @param pBlock pointer to block data
1108 * @return index of the block, -ENOENT if no block found
1112 int FindInputBlock(const AliHLTComponentBlockData* pBlock) const;
1115 * Create an object from a specified input block.
1116 * @param idx index of the input block
1117 * @param bForce force the retrieval of an object, error messages
1118 * are suppressed if \em bForce is not set
1119 * @return pointer to TObject, caller must delete the object after use
1123 TObject* CreateInputObject(int idx, int bForce=0);
1127 * Get object from the input block list. The methods first checks whether the
1128 * object was already created. If not, it is created by @ref CreateInputObject
1129 * and inserted into the list of objects.
1130 * @param idx index in the input block list
1131 * @param classname name of the class, object is checked for correct class
1133 * @param bForce force the retrieval of an object, error messages
1134 * are suppressed if \em bForce is not set
1135 * @return pointer to TObject
1139 TObject* GetInputObject(int idx, const char* classname=NULL, int bForce=0);
1142 * Clean the list of input objects.
1143 * Cleanup is done at the end of each event processing.
1145 int CleanupInputObjects();
1148 * Insert a buffer into the output block stream.
1149 * This is the only method to insert blocks into the output stream, called
1150 * from all types of the Pushback method. The actual data might have been
1151 * written to the output buffer already. In that case NULL can be provided
1152 * as buffer, only the block descriptor will be build. If a header is specified,
1153 * it will be inserted before the buffer, default is no header.
1154 * @param pBuffer pointer to buffer
1155 * @param iBufferSize size of the buffer in byte
1156 * @param dt data type
1157 * @param spec data specification
1158 * @param pHeader pointer to header
1159 * @param iHeaderSize size of Header
1160 * @return neg. error code if failed
1162 int InsertOutputBlock(void* pBuffer, int iBufferSize,
1163 const AliHLTComponentDataType& dt,
1164 AliHLTUInt32_t spec,
1165 void* pHeader=NULL, int iHeaderSize=0);
1167 /** The global component handler instance */
1168 static AliHLTComponentHandler* fgpComponentHandler; //! transient
1170 /** The environment where the component is running in */
1171 AliHLTComponentEnvironment fEnvironment; // see above
1173 /** Set by ProcessEvent before the processing starts */
1174 AliHLTEventID_t fCurrentEvent; // see above
1176 /** internal event no */
1177 int fEventCount; // see above
1179 /** the number of failed events */
1180 int fFailedEvents; // see above
1182 /** event data struct of the current event under processing */
1183 AliHLTComponentEventData fCurrentEventData; // see above
1185 /** array of input data blocks of the current event */
1186 const AliHLTComponentBlockData* fpInputBlocks; //! transient
1188 /** index of the current input block */
1189 int fCurrentInputBlock; // see above
1191 /** data type of the last block search */
1192 AliHLTComponentDataType fSearchDataType; // see above
1194 /** name of the class for the object to search for */
1195 string fClassName; // see above
1197 /** array of generated input objects */
1198 TObjArray* fpInputObjects; //! transient
1200 /** the output buffer */
1201 AliHLTUInt8_t* fpOutputBuffer; //! transient
1203 /** size of the output buffer */
1204 AliHLTUInt32_t fOutputBufferSize; // see above
1206 /** size of data written to output buffer */
1207 AliHLTUInt32_t fOutputBufferFilled; // see above
1209 /** list of ouput block data descriptors */
1210 AliHLTComponentBlockDataList fOutputBlocks; // see above
1212 /** stopwatch array */
1213 TObjArray* fpStopwatches; //! transient
1215 /** array of memory files AliHLTMemoryFile */
1216 AliHLTMemoryFilePList fMemFiles; //! transient
1218 /** descriptor of the current run */
1219 AliHLTRunDesc* fpRunDesc; //! transient
1221 /** the current DDL list */
1222 AliHLTEventDDL* fpDDLList; //! transient
1224 /** external fct to set CDB run no, indicates external CDB initialization */
1225 void* fCDBSetRunNoFunc; //! transient
1227 /** id of the component in the analysis chain */
1228 string fChainId; //! transient
1230 ClassDef(AliHLTComponent, 5)