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