]>
Commit | Line | Data |
---|---|---|
30338a30 | 1 | //-*- Mode: C++ -*- |
c38ba6f9 | 2 | // $Id$ |
3 | ||
4 | #ifndef ALIHLTTASK_H | |
5 | #define ALIHLTTASK_H | |
b6800be0 | 6 | /* This file is property of and copyright by the ALICE HLT Project * |
7 | * ALICE Experiment at CERN, All rights reserved. * | |
c38ba6f9 | 8 | * See cxx source for full Copyright notice */ |
9 | ||
b22e91eb | 10 | /** @file AliHLTTask.h |
c38ba6f9 | 11 | @author Matthias Richter |
12 | @date | |
13 | @brief base class for HLT tasks | |
14 | */ | |
15 | ||
30338a30 | 16 | // see below for class documentation |
17 | // or | |
18 | // refer to README to build package | |
19 | // or | |
20 | // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt | |
21 | ||
b46ca65e | 22 | #include <vector> |
c38ba6f9 | 23 | #include <TObject.h> |
24 | #include <TList.h> | |
25 | #include "AliHLTDataTypes.h" | |
26 | #include "AliHLTLogging.h" | |
27 | #include "AliHLTDataBuffer.h" | |
28 | ||
8ede8717 | 29 | struct AliHLTComponentBlockData; |
c38ba6f9 | 30 | class AliHLTComponent; |
31 | class AliHLTComponentHandler; | |
7a436c89 | 32 | class AliHLTConfiguration; |
b46ca65e | 33 | class AliHLTTask; |
34 | ||
35 | typedef vector<AliHLTTask*> AliHLTTaskPList; | |
c38ba6f9 | 36 | |
37 | /******************************************************************************/ | |
38 | ||
b22e91eb | 39 | /** |
40 | * @class AliHLTTask | |
41 | * A task collects all the information which is necessary to process a certain | |
42 | * step in the HLT data processing chain. | |
43 | * - the instance of the component | |
53feaef5 | 44 | * the task object creates and deletes the component object |
b22e91eb | 45 | * - the data buffer which receives the result of the component and provides |
46 | * the data to other tasks/components | |
47 | * - a list of all dependencies | |
48 | * - a list of consumers | |
53feaef5 | 49 | * - the task object holds an external pointer to the configuration object; |
50 | * \b Note: the configuration object must exist through the existence of the | |
51 | * task object!!! | |
52 | * | |
b22e91eb | 53 | * |
54 | * @note This class is only used for the @ref alihlt_system. | |
55 | * | |
56 | * @ingroup alihlt_system | |
57 | */ | |
c38ba6f9 | 58 | class AliHLTTask : public TObject, public AliHLTLogging { |
59 | public: | |
60 | /** standard constructor */ | |
61 | AliHLTTask(); | |
62 | /** constructor | |
63 | @param pConf pointer to configuration descriptor | |
c38ba6f9 | 64 | */ |
53feaef5 | 65 | AliHLTTask(AliHLTConfiguration* pConf); |
c38ba6f9 | 66 | /** destructor */ |
67 | virtual ~AliHLTTask(); | |
68 | ||
69 | /** | |
70 | * Initialize the task. | |
71 | * The task is initialized with a configuration descriptor. It needs a | |
2d7ff710 | 72 | * component handler instance to create the analysis component. The |
73 | * component is created and initialized. | |
53feaef5 | 74 | * @param pConf pointer to configuration descriptor, can be NULL if it |
75 | * was already provided to the constructor | |
c38ba6f9 | 76 | * @param pCH the HLT component handler |
77 | */ | |
78 | int Init(AliHLTConfiguration* pConf, AliHLTComponentHandler* pCH); | |
79 | ||
48abe484 | 80 | /** |
81 | * Create the component. | |
82 | * @param pConf configuration descritption | |
83 | * @param pCH component handler | |
4646c6e3 | 84 | * @param pComponent [OUT] target to get the component instance |
48abe484 | 85 | * @return component instance |
86 | */ | |
87 | virtual int CreateComponent(AliHLTConfiguration* pConf, AliHLTComponentHandler* pCH, AliHLTComponent*& pComponent) const; | |
88 | ||
53feaef5 | 89 | /** |
90 | * De-Initialize the task. | |
2d7ff710 | 91 | * Final cleanup after the run. The @ref AliHLTComponent::Deinit method of |
92 | * the component is called. The analysis component is deleted. | |
53feaef5 | 93 | */ |
94 | int Deinit(); | |
95 | ||
c38ba6f9 | 96 | /** |
97 | * Get the name of the object. | |
98 | * This is an overridden TObject function in order to return the configuration | |
99 | * name instead of the class name. Enables use of TList standard functions. | |
100 | * @return name of the configuration | |
101 | */ | |
102 | const char *GetName() const; | |
103 | ||
104 | /** | |
105 | * Return pointer to configuration. | |
106 | * The tasks holds internally the configuration object. | |
107 | * @return pointer to configuration | |
108 | */ | |
109 | AliHLTConfiguration* GetConf() const; | |
110 | ||
111 | /** | |
112 | * Return pointer to component, which the task internally holds. | |
113 | * <b>Never delete this object!!!</b> | |
114 | * @return instance of the component | |
115 | */ | |
116 | AliHLTComponent* GetComponent() const; | |
117 | ||
118 | /** | |
119 | * Find a dependency with a certain <i>name id</i>. | |
120 | * Searches in the list of dependencies for a task. | |
121 | * @param id the id of the <b>CONFIGURATION</b><br> | |
122 | * <b>NOTE:</b> the id does NOT specify a COMPONENT | |
123 | * @return pointer to task | |
124 | */ | |
125 | AliHLTTask* FindDependency(const char* id); | |
126 | ||
c38ba6f9 | 127 | /** |
128 | * Add a dependency for the task. | |
129 | * The task maintains a list of other tasks it depends on. | |
130 | * @param pDep pointer to a task descriptor | |
131 | * @return 0 if suceeded, neg error code if failed <br> | |
132 | * -EEXIST : the dependencie exists already | |
133 | * | |
134 | */ | |
135 | int SetDependency(AliHLTTask* pDep); | |
136 | ||
a742f6f8 | 137 | /** |
138 | * Clear a dependency. | |
139 | * The ROOT TList touches the object which is in the list, even though | |
140 | * it shouldn't care about. Thats why all lists have to be cleared before | |
141 | * objects are deleted. | |
142 | */ | |
143 | int UnsetDependency(AliHLTTask* pDep); | |
144 | ||
c38ba6f9 | 145 | /** |
146 | * Return number of unresolved dependencies. | |
147 | * Iterate through all the configurations the task depends on and check | |
148 | * whether a corresponding task is available in the list. | |
149 | * @return number of unresolved dependencies | |
150 | */ | |
151 | int CheckDependencies(); | |
152 | ||
153 | /** | |
154 | * Check whether the current task depends on the task pTask. | |
155 | * @param pTask pointer to Task descriptor | |
156 | * @return 1 the current task depends on pTask <br> | |
157 | * 0 no dependency <br> | |
158 | * neg. error code if failed | |
159 | */ | |
160 | int Depends(AliHLTTask* pTask); | |
161 | ||
162 | /** | |
163 | * Find a target with a certain id. | |
164 | * Tasks which depend on the current task are referred to be <i>targets</i>. | |
165 | * @param id configuration id to search for | |
166 | * @return pointer to task instance | |
167 | */ | |
168 | AliHLTTask* FindTarget(const char* id); | |
169 | ||
170 | /** | |
171 | * Insert task into target list. | |
172 | * The target list specifies all the tasks which depend on the current task. | |
173 | * @param pDep pointer task object | |
174 | * @return >=0 if succeeded, neg. error code if failed | |
175 | */ | |
176 | int SetTarget(AliHLTTask* pDep); | |
177 | ||
a742f6f8 | 178 | /** |
179 | * Clear a target. | |
180 | * The ROOT TList touches the object which is in the list, even though | |
181 | * it shouldn't care about. Thats why all lists have to be cleared before | |
182 | * objects are deleted. | |
183 | */ | |
184 | int UnsetTarget(AliHLTTask* pTarget); | |
185 | ||
c38ba6f9 | 186 | /** |
187 | * Prepare the task for event processing. | |
188 | * The method initializes the Data Buffer and calls the | |
189 | * @ref AliHLTComponent::Init method of the component.<br> | |
2d7ff710 | 190 | * The @ref ProcessTask method can be called an arbitrary number of times |
c38ba6f9 | 191 | * as soon as the task is in <i>running</i> mode. |
192 | */ | |
193 | int StartRun(); | |
194 | ||
195 | /** | |
196 | * Clean-up the task after event processing. | |
2d7ff710 | 197 | * The method cleans up internal structures. |
c38ba6f9 | 198 | */ |
199 | int EndRun(); | |
200 | ||
201 | /** | |
202 | * Process the task. | |
203 | * If all dependencies are resolved the tasks subscribes to the data of | |
204 | * all source tasks, builds the block descriptor and calls the | |
205 | * @ref AliHLTComponent::ProcessEvent method of the component, after | |
206 | * processing, the data blocks are released. <br> | |
207 | * The @ref StartRun method must be called before. | |
208 | */ | |
48abe484 | 209 | int ProcessTask(Int_t eventNo, AliHLTUInt32_t eventType=gkAliEventTypeData); |
c38ba6f9 | 210 | |
211 | /** | |
212 | * Determine the number of matching data block between the component and the | |
213 | * data buffer of a consumer component. It checks which data types from the | |
214 | * list of input data types of the consumer component can be provided by data | |
215 | * blocks of the current component. | |
216 | * @param pConsumerTask the task which subscribes to the data | |
217 | * @return number of matching data blocks | |
218 | */ | |
2d7ff710 | 219 | int GetNofMatchingDataBlocks(const AliHLTTask* pConsumerTask) const; |
c38ba6f9 | 220 | |
221 | /** | |
222 | * Determine the number of matching data types between the component and a | |
223 | * consumer component. It checks which data types from the list of input data | |
224 | * types of the consumer component can be provided by the current component. | |
225 | * @param pConsumerTask the task which subscribes to the data | |
226 | * @return number of matching data types | |
227 | */ | |
2d7ff710 | 228 | int GetNofMatchingDataTypes(const AliHLTTask* pConsumerTask) const; |
c38ba6f9 | 229 | |
230 | /** | |
231 | * Subscribe to the data of a source task. | |
232 | * The function prepares the block descriptors for subsequent use with the | |
233 | * @ref AliHLTComponent::ProcessEvent method, the method prepares all block | |
234 | * descriptors which match the input data type of the consumer the function | |
235 | * returns the number of blocks which would be prepared in case the target | |
236 | * array is big enough. | |
237 | * @param pConsumerTask the task which subscribes to the data | |
457ec821 | 238 | * @param blockDescList block descriptor list to be filled |
c38ba6f9 | 239 | * @return number of matching data blocks, negative error code if failed |
240 | */ | |
457ec821 | 241 | int Subscribe(const AliHLTTask* pConsumerTask, AliHLTComponentBlockDataList& blockDescList); |
c38ba6f9 | 242 | |
243 | /** | |
244 | * Release a block descriptor. | |
245 | * Notification from consumer task. | |
246 | * @param pBlockDesc descriptor of the data segment | |
247 | * @param pConsumerTask the task which subscribed to the data | |
248 | * @return: >0 if success, negative error code if failed | |
249 | */ | |
8ede8717 | 250 | int Release(AliHLTComponentBlockData* pBlockDesc, |
c38ba6f9 | 251 | const AliHLTTask* pConsumerTask); |
252 | ||
253 | /** | |
254 | * Print the status of the task with component, dependencies and targets. | |
255 | */ | |
256 | void PrintStatus(); | |
257 | ||
258 | /** | |
259 | * Search task dependency list recursively to find a dependency. | |
260 | * @param id id of the task to search for | |
261 | * @param pTgtList (optional) target list to receive dependency tree | |
262 | * @return 0 if not found, >0 found in the n-th level, | |
263 | dependency list in the target list | |
264 | */ | |
265 | int FollowDependency(const char* id, TList* pTgtList=NULL); | |
266 | ||
267 | /** | |
268 | * Print the tree for a certain dependency either from the task or | |
269 | * configuration list. | |
270 | * Each task posseses two "link lists": The configurations are the origin | |
271 | * of the task list. In case of an error during the built of the task list, | |
272 | * the dependencies for the task list might be incomplete. In this case the | |
273 | * configurations can give infomation on the error reason. | |
274 | * @param id id of the dependency to search for | |
275 | * @param bMode 0 (default) from task dependency list, <br> | |
276 | * 1 from configuration list | |
277 | */ | |
278 | void PrintDependencyTree(const char* id, int bMode=0); | |
279 | ||
280 | /** | |
281 | * Get number of source tasks. | |
282 | * @return number of source tasks | |
283 | */ | |
2d7ff710 | 284 | int GetNofSources() const {return fListDependencies.GetSize();} |
c38ba6f9 | 285 | |
97d2b87a | 286 | /** |
287 | * Customized logging function. | |
288 | * The task id and pointer is added at the beginning of each message. | |
289 | */ | |
290 | int LoggingVarargs(AliHLTComponentLogSeverity severity, | |
291 | const char* originClass, const char* originFunc, | |
292 | const char* file, int line, ... ) const; | |
293 | ||
c38ba6f9 | 294 | private: |
1e6e67ec | 295 | /** prohibited copy constructor */ |
296 | AliHLTTask(const AliHLTTask&); | |
297 | /** prohibited assignment operator */ | |
298 | AliHLTTask& operator=(const AliHLTTask&); | |
299 | ||
7131ea63 | 300 | /** |
301 | * Custom initialization for child tasks. | |
302 | */ | |
303 | virtual int CustomInit(AliHLTComponentHandler* pCH); | |
304 | ||
305 | /** | |
306 | * Custom clean up for child tasks. | |
307 | */ | |
308 | virtual int CustomCleanup(); | |
309 | ||
310 | protected: | |
53feaef5 | 311 | /** the configuration descriptor (external pointer) */ |
70ed7d01 | 312 | AliHLTConfiguration* fpConfiguration; //! transient |
313 | /** the component described by this task (created and deleted internally) */ | |
314 | AliHLTComponent* fpComponent; //! transient | |
c38ba6f9 | 315 | /** the data buffer for the component processing */ |
70ed7d01 | 316 | AliHLTDataBuffer* fpDataBuffer; //! transient |
7131ea63 | 317 | |
318 | private: | |
c38ba6f9 | 319 | /** the list of targets (tasks which depend upon the current one) */ |
70ed7d01 | 320 | TList fListTargets; // see above |
c38ba6f9 | 321 | /** the list of sources (tasks upon which the current one depends) */ |
70ed7d01 | 322 | TList fListDependencies; // see above |
c38ba6f9 | 323 | |
324 | /** | |
325 | * block data array to be passed as argument to the | |
326 | * @ref AliHLTComponent::ProcessEvent method. | |
327 | * Filled through subscription to source tasks (@ref Subscribe). | |
328 | */ | |
1e6e67ec | 329 | vector<AliHLTComponentBlockData> fBlockDataArray; //! transient |
c38ba6f9 | 330 | |
1e6e67ec | 331 | ClassDef(AliHLTTask, 2); |
c38ba6f9 | 332 | }; |
333 | ||
334 | #endif |