6 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
7 * See cxx source for full Copyright notice */
9 /** @file AliHLTSystem.h
10 @author Matthias Richter
12 @brief Global HLT module management and AliRoot integration.
13 @note The class is used in Offline (AliRoot) context
16 // see below for class documentation
18 // refer to README to build package
20 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
23 * @defgroup alihlt_system HLT integration into AliRoot
24 * This section describes the HLT integration into AliRoot.
27 #include "AliHLTLogging.h"
31 class AliHLTComponentHandler;
32 class AliHLTConfiguration;
33 class AliHLTConfigurationHandler;
43 * Main class for the HLT integration into AliRoot.
44 * The class handles a list of configurations. Configurations are translated
45 * into task lists which can be executed.
47 * @note This class is only used for the @ref alihlt_system.
49 * @ingroup alihlt_system
51 class AliHLTSystem : public AliHLTLogging {
53 /** default constructor */
56 virtual ~AliHLTSystem();
59 * Pointer to an instance of @ref AliHLTComponentHandler.
61 AliHLTComponentHandler* fpComponentHandler; //! transient
64 * Pointer to an instance of @ref AliHLTConfigurationHandler.
66 AliHLTConfigurationHandler* fpConfigurationHandler; //! transient
69 * Add a configuration to the end of the list.
70 * @param pConf pointer to configuration to add
72 int AddConfiguration(AliHLTConfiguration* pConf);
75 * Insert a configuration to the end of the list after the specified
77 * @param pConf pointer to configuration to insert
78 * @param pPrec pointer to configuration to insert the new one after
80 int InsertConfiguration(AliHLTConfiguration* pConf, AliHLTConfiguration* pPrec);
83 * Remove a configuration from the list.
84 * @param pConf pointer to configuration to delete
86 int DeleteConfiguration(AliHLTConfiguration* pConf);
90 * This method is used to build the tasks from the 'master' configuration
91 * objects which are added to the HLT system handler. This is an iterative
92 * process since the task might depend upon other configurations. For each
93 * configuration object which has not yet been converted into a task, the
94 * method will be called iteratively. Finally, after building all tasks which
95 * the current one depends on have been created, the task is inserted to the
96 * list of tasks with the InsertTask method.
97 * @param pConf configuration name/id
99 int BuildTaskList(const char* pConf);
102 * Build task list from a configuration object.
103 * This method is kept for backward compatibility. Use the version
104 * with the configuration name.
105 * @param pConf pointer to configuration to build the task list from
107 int BuildTaskList(AliHLTConfiguration* pConf);
110 * Clean the list of tasks and delete all the task objects.
115 * Insert a task to the task list.
116 * The method first checks whether all dependencies are resolved (i.e. exist
117 * already in the task list). During this iteration the cross links between
118 * the tasks are set as well. If all dependencies are resolved, the task is
119 * added at the end of the list.
120 * @param pTask pointer to task to add
122 int InsertTask(AliHLTTask* pTask);
125 * Find a task with an id.
126 * @param id CONFIGURATION id (not a COMPONENT id!)
128 AliHLTTask* FindTask(const char* id);
131 * Print the task list.
133 void PrintTaskList();
137 * The method checks whether the task list has already been build. If not,
138 * or the configuration list has been changed, the @ref BuildTaskList
139 * method is called. <br>
140 * All tasks of the list will be subsequently processed for each event.
141 * The system can remain started if the \em bStop parameter is 0. In that
142 * case the system just waits for the next event. A specific call with
143 * nofEvents==0 is needed to execute the stop sequence.
144 * @param iNofEvents number of events
145 * @param bStop stop the chain after processing
146 * @return number of reconstructed events, neg error code if failed
148 int Run(Int_t iNofEvents=1, int bStop=1);
151 * Init all tasks from the list.
152 * The @ref AliHLTTask::Init method is called for each task, the components
154 * @return neg error code if failed
159 * Init the stopwatches for all tasks.
160 * @param pStopwatches object array of stopwatches, for types
161 * @see AliHLTComponent::AliHLTStopwatchType
162 * @return neg error code if failed
164 int InitBenchmarking(TObjArray* pStopwatches);
167 * Print benchmarking summary.
168 * Optionak: clean up stop watches.
169 * @param pStopwatches object array of stopwatches
170 * @param bClean delete stop watches if 1
171 * @return neg error code if failed
173 int PrintBenchmarking(TObjArray* pStopwatches, int bClean=0);
177 * The @ref AliHLTTask::StartRun method is called for each task, the
178 * components will be prepared for event processing.
179 * @return neg error code if failed
185 * The @ref AliHLTTask::ProcessTask method is called for each task.
186 * @return neg error code if failed
188 int ProcessTasks(Int_t eventNo);
192 * The @ref AliHLTTask::EndRun method is called for each task, the components
193 * will be cleaned after event processing.
194 * @return neg error code if failed
199 * De-init all tasks from the list.
200 * The @ref AliHLTTask::Deinit method is called for each task, the components
202 * @return neg error code if failed
207 * The memory allocation function for components.
208 * This function is part of the running environment of the components.
210 static void* AllocMemory( void* param, unsigned long size );
213 * AliRoot embedded reconstruction.
214 * Main entry point to execute the HLT reconstruction from AliRoot. Called
215 * either by the AliHLTReconstructor plugin during AliRoot reconstruction
216 * of raw data, or AliHLTSimulation during simulation of data.
218 * The two cases are distinguished by the availablility of the run loader
220 * - AliRoot simulation: run loader is available and is propagated to the
221 * module agents (AliHLTModuleAgent) to generate the corresponding
222 * configurations and chains, and to the AliHLTOfflineSource components.
223 * - AliRoot reconstruction: raw reader is available and is propagated to
224 * the agents and AliHLTOfflineSource components.
226 * The system remains started after the processing and just waits for the
227 * next event. A specific call with nofEvents==0 is needed to execute the
230 * The 'runLoader' and 'rawReader' parameters are set to all active
231 * AliHLTOfflineDataSource's and the HLT chain is processed for the given
232 * number of events. If the rawReader is NULL, reconstruction is done on
233 * simulated data, from real data if a RawReader is specified.
234 * @param nofEvents number of events
235 * @param runLoader the AliRoot runloader
236 * @param rawReader the AliRoot RawReader
237 * @return number of reconstructed events, neg. error code if failed
239 int Reconstruct(int nofEvents, AliRunLoader* runLoader,
240 AliRawReader* rawReader=NULL);
243 * Fill ESD for one event.
244 * To be called by the AliHLTReconstructor plugin during the event loop
245 * and FillESD method of the AliRoot reconstruction.
246 * This method is called on event basis, and thus must copy the previously
247 * reconstructed data of the event from the 'ESD' recorder. The FillESD
248 * method of all active AliHLTOfflineDataSink's is called.
249 * @param eventNo current event no (Note: this event number is just a
250 * processing counter and is not related to the nature/
251 * origin of the event
252 * @param runLoader the AliRoot runloader
253 * @param esd an AliESDEvent instance
254 * @return neg. error code if failed
256 int FillESD(int eventNo, AliRunLoader* runLoader, AliESDEvent* esd);
259 * Load component libraries.
260 * @param libs string of blank separated library names
261 * @return neg. error code if failed
263 int LoadComponentLibraries(const char* libs);
266 * Find a symbol in a dynamically loaded library.
267 * @param library library
268 * @param symbol the symbol to find
269 * @return void pointer to function
271 void* FindDynamicSymbol(const char* library, const char* symbol);
274 * Prepare the HLT system for running.
275 * - module agents are requested to register configurations
276 * - task lists are built from the top configurations of the modules
278 * @param rawReader instance of the raw reader or NULL
279 * @param runloader optional instance of the run loader
280 * @return neg. error code if failed <br>
281 * -EBUSY system is in kRunning state <br>
283 int Configure(AliRawReader* rawReader, AliRunLoader* runloader=NULL);
286 * Old method kept for backward compatibilty.
288 * @param runloader optional instance of the run loader
289 * @return neg. error code if failed <br>
290 * -EBUSY system is in kRunning state <br>
292 int Configure(AliRunLoader* runloader=NULL);
297 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
298 * \li loglevel=<i>level</i> <br>
299 * logging level for this processing
300 * \li frameworklog=<i>level</i> <br>
301 * logging level for framework classes
303 * disable redirection of log messages to AliLog class
304 * \li config=<i>macro</i>
305 * configuration macro
306 * \li chains=<i>configuration</i>
307 * comma separated list of configurations to be run during local
309 * \li libmode=<i>static,dynamic(default)</i>
310 * libraries are persistent if loaded in mode <i>static</i>, i.e. they
313 int ScanOptions(const char* options);
316 * Reset the HLT system.
317 * Reset is not possible while the system is in running state.
318 * @param bForce force the reset
319 * @return neg. error code if failed <br>
320 * -EBUSY system is in kRunning state <br>
322 int Reset(int bForce=0);
325 * Load the configurations specified by the module agents.
326 * The runLoader is passed to the agent and allows configuration
328 * @param rawReader instance of the raw reader or NULL
329 * @param runloader optional instance of the run loader
330 * @return neg. error code if failed
332 int LoadConfigurations(AliRawReader* rawReader, AliRunLoader* runloader=NULL);
335 * Get the top configurations of all agents and build the task lists.
336 * @param rawReader instance of the raw reader or NULL
337 * @param runloader optional instance of the run loader
338 * @return neg. error code if failed
340 int BuildTaskListsFromReconstructionChains(AliRawReader* rawReader,
341 AliRunLoader* runloader=NULL);
343 enum AliHLTSystemState_t {
344 kUninitialized = 0x0,
345 kLibrariesLoaded = 0x1,
346 kConfigurationLoaded = 0x2,
347 kTaskListCreated = 0x4,
355 * Check status of the system.
356 * @param flag AliHLTSystemState_t value to check for
357 * @return 1 if set, 0 if not
359 int CheckStatus(int flag);
362 * Get the current status.
363 * @return status flags of @ref AliHLTSystemState_t
365 int GetStatusFlags();
370 /** copy constructor prohibited */
371 AliHLTSystem(const AliHLTSystem&);
372 /** assignment operator prohibited */
373 AliHLTSystem& operator=(const AliHLTSystem&);
378 int SetStatusFlags(int flags);
381 * clear status flags.
383 int ClearStatusFlags(int flags);
386 * Set logging level for framework classes.
387 * This sets the local logging level of this instance and all subsequent
388 * framework classes to \em level.
389 * @param level local logging level for the framework classes
391 void SetFrameworkLog(AliHLTComponentLogSeverity level);
393 /* TList fConfList; */
394 /* int fbListChanged; */
397 TList fTaskList; // see above
399 /** the number of instances of AliHLTSystem */
400 static int fgNofInstances; // see above
402 /** state of the object */
403 int fState; // see above
405 /** chains to be run during reconstruction */
406 TString fChains; //!transient
408 /* array of stopwatches */
409 TObjArray* fStopwatches; //!transient
411 /* number of events processed in total */
412 int fEventCount; //!transient
414 /* number of events processed successfully */
415 int fGoodEvents; //!transient
418 ClassDef(AliHLTSystem, 4);