ALIROOT-5433 Transition to CDHv3 in HLT
[u/mrichter/AliRoot.git] / HLT / trigger / AliHLTGlobalTriggerComponent.h
1 //-*- Mode: C++ -*-
2 // $Id$
3 #ifndef ALIHLTGLOBALTRIGGERCOMPONENT_H
4 #define ALIHLTGLOBALTRIGGERCOMPONENT_H
5 /* This file is property of and copyright by the ALICE HLT Project        *
6  * ALICE Experiment at CERN, All rights reserved.                         *
7  * See cxx source for full Copyright notice                               */
8
9 /// @file   AliHLTGlobalTriggerComponent.h
10 /// @author Artur Szostak <artursz@iafrica.com>
11 /// @date   26 Nov 2008
12 /// @brief  Declaration of the AliHLTGlobalTriggerComponent component class.
13
14 #include "AliHLTTrigger.h"
15 #include "AliHLTTriggerDecision.h"
16 #include "TClonesArray.h"
17 #include "AliHLTCDHWrapper.h"
18
19 class AliHLTTriggerMenu;
20 class AliHLTGlobalTrigger;
21
22 /**
23  * \class AliHLTGlobalTriggerComponent
24  * This class applies the global HLT trigger to all trigger information produced
25  * by components deriving from AliHLTTrigger.
26  * Any information delivered by other components in data blocks that contain
27  * TObjects can also be used for the trigger algorithm. In such cases a symbol
28  * needs to be defined in the global trigger menu which can then be used inside
29  * the trigger condition expressions.
30  *
31  * <h2>General properties:</h2>
32  *
33  * Component ID: \b HLTGlobalTrigger <br>
34  * Library: \b libAliHLTTrigger.so   <br>
35  * Input Data Types: ::kAliHLTAnyDataType <br>
36  * Output Data Types: kAliHLTDataTypeGlobalTrigger and kAliHLTDataTypeReadoutList <br>
37  *
38  * <h2>Mandatory arguments:</h2>
39  * None.
40  *
41  * <h2>Optional arguments:</h2>
42  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
43  * \li -config <i>filename</i> <br>
44  *      Indicates the configuration macro file to use for the global HLT trigger menu.
45  * \li -includepath <i>path</i> <br>
46  *      Indicates the include path to use if the automatically generated code that
47  *      implements the global HLT trigger requires non-standard includes.
48  * \li -include <i>filename</i> <br>
49  *      Indicates a file name that should be included in the automatically generated
50  *      trigger implementation code.
51  * \li -debug <br>
52  *      If specified the automatically generated class will contain extra debugging
53  *      code and the ACLiC system will have debugging compilation turned on.
54  * \li -cint <br>
55  *      Use CINT to interprete the generated global trigger instead of compiling it.
56  *      This will also be the case if no compiler is available.
57  * \li -usecode <i>filename</i> <i>classname</i> <br>
58  *      Used to force the component to use an existing class for the global HLT trigger
59  *      class implementation, with the name of <i>classname</i> and found in the file
60  *      <i>filename</i>.
61  * \li -skipctp <br>
62  *      Indicates that the CTP data should not be added to the global HLT trigger decision.
63  * \li -forward-input <br>
64  *      Forward the input objects instead of adding them to the global HLT trigger decision.
65  *      This will also add a short info on the input objects and decisions, like
66  *      -include-input=short, to switch off -include-input=none can be placed after the
67  *      parameter
68  * \li -include-input[=none,short,objects,both] <br>
69  *      Steer adding of input objects to the global HLT trigger decision.
70  *      Options: none - include nothing, short - include a short TNames array,
71  *               objects - include objects, by default on
72  *               both - include both objects and short info
73  * \li -process-all-events <br>
74  *      Indicates that all events should be processed with the global trigger logic and
75  *      not just the data events. The default is not to process just the data events.
76  * \li -monitoring[=n] <br>
77  *      enable monitoring trigger once every n seconds, enable for every event if
78  *      parameter n is omitted
79  * \li -dont-make-software-triggers <br>
80  *      This option prevents the Common Data Header from being interpreted to generate
81  *      software event input triggers for the trigger menu. Normally the following default
82  *      triggers are available in the trigger menu:
83  *        START_OF_DATA - start of data event.
84  *        END_OF_DATA - end of data event.
85  *        SOFTWARE - general software trigger.
86  *        CALIBRATION - calibration trigger.
87  *      With this option these will not be automatically generated by the global trigger.
88  * \li -randomseed <i>number</i> <br>
89  *      Specifies the random number seed to give to the internal random number generator.
90  *      This is only useful for debugging to generate reproducible number sequences.
91  *      The random numbers are only used if a trigger is scaled down using the scale down
92  *      option in a trigger menu item. The seed is normally randomly chosen by default.
93  *
94  * <h2>Configuration:</h2>
95  * Configured from CDB but can be overridden with the -config argument.
96  *
97  * <h2>Default CDB entries:</h2>
98  * HLT/ConfigHLT/HLTGlobalTrigger - Contains the global trigger menu.
99  *
100  * <h2>Performance:</h2>
101  * This is a linear function of the number of input triggers (AliHLTTrigger) that
102  * need to be processed.
103  * For a modest trigger menu configurations the processing time per event should
104  * be on the order of a few milliseconds.
105  *
106  * <h2>Memory consumption:</h2>
107  * Memory consumption is minimal. It should be on the order of 2 or 3 MBytes.
108  *
109  * <h2>Output size:</h2>
110  * This will depend almost linearly on the number of intput triggers and summary
111  * data objects used. Thus, for every trigger (AliHLTTrigger object) specified
112  * in the trigger menu the output size will require about 1 kBytes.
113  * Then for every summary data object (i.e. TObject symbol defined in the trigger
114  * menu configuration) one will need an extra few kBytes, depending on the size
115  * of the summary objects.
116  * In total one would expect no more than a MByte output size for a large trigger
117  * configuration and typically only a few kBytes for a small or optimised one.
118  *
119  * \ingroup alihlt_trigger_components
120  */
121 class AliHLTGlobalTriggerComponent : public AliHLTTrigger
122 {
123  public:
124  
125   AliHLTGlobalTriggerComponent();
126   virtual ~AliHLTGlobalTriggerComponent();
127   
128   /**
129    * Inherited from AliHLTTrigger.
130    * @return string containing the global trigger name.
131    */
132   virtual const char* GetTriggerName() const { return "HLTGlobalTrigger"; };
133
134   /**
135    * Inherited from AliHLTTrigger.
136    * This returns kAliHLTDataTypeGlobalTrigger by default.
137    * @param [out] list The list of data types to be filled.
138    */
139   virtual void GetOutputDataTypes(AliHLTComponentDataTypeList& list) const;
140   
141   /**
142    * Get a ratio by how much the data volume is shrunk or enhanced.
143    * The method returns a size proportional to the trigger name string length
144    * for constBase, and 1 for inputMultiplier.
145    * @param [out] constBase        Additive part, independent of the input data volume.
146    * @param [out] inputMultiplier  Multiplication ratio.
147    */
148   virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
149   
150   /**
151    * Initialise the component.
152    * \param argc  The number of arguments in argv.
153    * \param argv  Array of component argument strings.
154    * \returns  Zero on success and negative number on failure.
155    */
156   virtual Int_t DoInit(int argc, const char** argv);
157   
158   /**
159    * Cleanup the component.
160    * \returns  Zero on success and negative number on failure.
161    */
162   virtual Int_t DoDeinit();
163   
164   /**
165    * Spawn function creates a new object.
166    * @return new class instance.
167    */
168   virtual AliHLTComponent* Spawn();
169
170   enum StatusBits {
171     kForwardInput       = BIT(14),  // forward input objects instead of adding them to the decision object
172     kIncludeInput       = BIT(15),  // include input objects in the decision object
173     kIncludeShort       = BIT(16),  // include short description of input objects: name, title, decision
174     kSkipCTP            = BIT(17),  // skip CTP data object in the decision object
175   };
176
177   void   SetBit(AliHLTUInt32_t f, bool set) {
178     if (set) SetBit(f);
179     else ResetBit(f);
180   }
181   void   SetBit(AliHLTUInt32_t f) { fBits |= f; }
182   void   ResetBit(AliHLTUInt32_t f) { fBits &= ~f; }
183   bool   TestBit(AliHLTUInt32_t f) const { return (bool) ((fBits & f) != 0); }
184
185  protected:
186
187   /**
188    * Applies the global HLT trigger.
189    * @return Zero is returned on success and a negative error code on failure.
190    */
191   virtual int DoTrigger();
192   
193   /**
194    * Reconfigures the component by loading the trigger menu from the given
195    * CDB entry.
196    * \param cdbEntry  The CDB path to the trigger menu to load.
197    * \param chainId   The ID of the component in the chain.
198    * \returns  Zero on success and non-zero values otherwise.
199    */
200   virtual int Reconfigure(const char* cdbEntry, const char* chainId);
201   
202  private:
203
204   /// Not implemented. Do not allow copying of this object.
205   AliHLTGlobalTriggerComponent(const AliHLTGlobalTriggerComponent& obj);
206   /// Not implemented. Do not allow copying of this object.
207   AliHLTGlobalTriggerComponent& operator = (const AliHLTGlobalTriggerComponent& obj);
208   
209   /**
210    * Loads a trigger menu object from the CDB.
211    * \param [in] cdbPath The path in the CDB to load the trigger menu object from.
212    * \param [out] menu   A pointer that gets filled with the new trigger menu object.
213    * \returns  Zero if the trigger menu object was found and the pointer to it
214    *   set in the <i>menu</i> variable. If a non-zero error code is returned then
215    *   the <i>menu</i> variable is not changed at all.
216    */
217   int LoadTriggerMenu(const char* cdbPath, const AliHLTTriggerMenu*& menu);
218   
219   /**
220    * Generates a file name for the generated on the fly code using a GUID.
221    * \param [out] name The name of the class to use.
222    * \param [out] filename The name of the file containing the code.
223    */
224   void GenerateFileName(TString& name, TString& filename);
225   
226   /**
227    * Generates the code for the global trigger to apply the given trigger menu.
228    * The code will then be compiled on the fly and loaded. The name of the new
229    * class is returned so that a new instance of the class can be created via:
230    * \code
231    *  AliHLTGlobalTrigger::CreateNew(name)
232    * \endcode
233    * where name is the name of the generated class as returned by this method.
234    *
235    * The name of the generated code file is stored in the variable fCodeFileName
236    * and the fDeleteCodeFile is set to true.
237    *
238    * \param [in] menu The trigger menu to create the global trigger class from.
239    * \param [out] name The name of the generated class.
240    * \param [out] filename The name of the generated file containing the code.
241    * \param [in] includePaths The list of include path strings.
242    * \param [in] includeFiles The list of include file strings.
243    * \returns  The error code suitable to return in DoInit. Zero on success.
244    */
245   int GenerateTrigger(
246       const AliHLTTriggerMenu* menu, TString& name, TString& filename,
247       const TClonesArray& includePaths, const TClonesArray& includeFiles
248     );
249   
250   /**
251    * Loads the code for the generated HLT global trigger class. The code is compiled
252    * on the fly if possible, otherwise the CINT interpreter is used to interpret
253    * the class.
254    * \param [in] filename  The name of the file containing the code for the global trigger class.
255    * \param [in] includePaths The list of include path strings.
256    * \returns  The error code suitable to return in DoInit. Zero on success.
257    */
258   int LoadTriggerClass(const char* filename, const TClonesArray& includePaths);
259   
260   /**
261    * Unloads the code that was previously loaded by LoadTriggerClass.
262    * \param filename  The name of the file containing the global trigger class logic to be unloaded.
263    * \returns  The error code suitable to return in DoInit. Zero on success.
264    */
265   int UnloadTriggerClass(const char* filename);
266   
267   /**
268    * Searches for the specified symbol name in the given list.
269    * \param name  The name of the symbol to find.
270    * \param list  The list to search for the symbol in.
271    * \returns  The position (index) of the symbol found or -1 if it was not found.
272    */
273   int FindSymbol(const char* name, const TClonesArray& list);
274   
275   /**
276    * Builds the list of symbols to use in the custom global trigger menu
277    * implementation class.
278    * \param  menu  The trigger menu to create the global trigger class from.
279    * \param  list  The list to fill with symbols.
280    * \returns  The error code suitable to return in DoInit. Zero on success.
281    */
282   int BuildSymbolList(const AliHLTTriggerMenu* menu, TClonesArray& list);
283   
284   /**
285    * Extracts the trailing operator in a C++ expression and returns the found
286    * operator in a separate output string.
287    * \param [in,out]  expr  The C++ expression to check. The trailing operator
288    *      is removed from the expression if found.
289    * \param [out]  op   The output variable which will be filled with the
290    *      operator found in the expression.
291    * \return  true if the trailing operator was found in the expression and
292    *      false otherwise.
293    */
294   bool ExtractedOperator(TString& expr, TString& op);
295
296   /**
297    * Add trigger decisions according to the active CTP trigger classes
298    * An internal TClonesArray holds the trigger decisions to be added. The trigger
299    * decisions are updated according to the active CTP trigger mask.
300    * \param pTrigger  The instance of the global trigger
301    * \param pCTPData  Instance of the CTP data
302    * \param trigData  Current trigger data, if NULL, the active trigger data from the CTP data is used
303    */
304   int AddCTPDecisions(AliHLTGlobalTrigger* pTrigger, const AliHLTCTPData* pCTPData, const AliHLTComponentTriggerData* trigData);
305   
306   /**
307    * This method handles the software trigger by checking the Common Data Header
308    * and filling fSoftwareTrigger with appropriate information for one of the
309    * following triggers: START_OF_DATA, END_OF_DATA, SOFTWARE or CALIBRATION, if
310    * it is indicated in the CDH L1 trigger message.
311    * \returns true if the trigger decision object was filled and false otherwise.
312    */
313   bool FillSoftwareTrigger();
314
315   /**
316    * Print some statistics based on the trigger counters
317    */
318   int PrintStatistics(const AliHLTGlobalTrigger* pTrigger, AliHLTComponentLogSeverity level=kHLTLogInfo, int offset=1) const;
319   
320   AliHLTGlobalTrigger* fTrigger;  //! Trigger object which implements the global trigger menu.
321   bool fDebugMode;  //! Indicates if the generated global trigger class should be in debug mode.
322   bool fRuntimeCompile;  //! Indicates if the generated global trigger class should be compiled
323   bool fDeleteCodeFile; //! If true then the code file indicated by fCodeFileName should be deleted during DoDeinit.
324   bool fMakeSoftwareTriggers;  //! Indicates if the software triggers should be filled automatically or not.
325   TString fCodeFileName; //! base file name of the generated code for the global trigger
326   TString fClassName;  //! The generated/loaded trigger class name.
327   TClonesArray* fCTPDecisions; //! AliHLTTriggerDecision objects for the CTP classes
328   unsigned long fBufferSizeConst; //! Constant size estimate for GetOutputDataSize.
329   double fBufferSizeMultiplier; //! Buffer size multiplier estimate for GetOutputDataSize.
330   TClonesArray fIncludePaths; //! Paths specified by the -includepath command line option.
331   TClonesArray fIncludeFiles; //! Files specified by the -include command line option.
332   TString fLibStateAtLoad; //! This stores the loaded libraries just before we tell CINT to load the interpreted file.
333   AliHLTUInt32_t fBits; //! Status bits
334   bool fDataEventsOnly; //! Flag indicating if only data events are processed with trigger logic.
335   int fMonitorPeriod; //! Period of the monitoring trigger in s, -1 means monitoring trigger off
336   UInt_t fUniqueID; //! Unique ID for the decision output objects.
337   AliHLTTriggerDecision fSoftwareTrigger; //! Software or calibration trigger decision object to be added to trigger logic.
338   AliHLTUInt64_t fTotalEventCounter; //! Counts the total number of events handled.
339   AliHLTCDHWrapper fCDH; //! The extracted CDH from the trigger data passed by the framework.
340
341   static const char* fgkTriggerMenuCDBPath; //! The path string to read the trigger menu from the CDB.
342   
343   ClassDef(AliHLTGlobalTriggerComponent, 0) // Global HLT trigger component class which produces the final trigger decision and readout list.
344 };
345
346 #endif // ALIHLTGLOBALTRIGGERCOMPONENT_H
347