]>
Commit | Line | Data |
---|---|---|
c580e182 | 1 | //-*- Mode: C++ -*- |
3da1c6d7 | 2 | // $Id$ |
1b9a175e | 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" | |
81d62bb4 | 15 | #include "TClonesArray.h" |
1b9a175e | 16 | |
e2bb8ddd | 17 | class AliHLTTriggerMenu; |
18 | class AliHLTGlobalTrigger; | |
19 | ||
1b9a175e | 20 | /** |
21 | * \class AliHLTGlobalTriggerComponent | |
22 | * This class applies the global HLT trigger to all trigger information produced | |
23 | * by components deriving from AliHLTTrigger. | |
24 | * Any information delivered by other components in data blocks that contain | |
52f67e50 | 25 | * TObjects can also be used for the trigger algorithm. In such cases a symbol |
26 | * needs to be defined in the global trigger menu which can then be used inside | |
27 | * the trigger condition expressions. | |
28 | * | |
29 | * <h2>General properties:</h2> | |
30 | * | |
31 | * Component ID: \b HLTGlobalTrigger <br> | |
32 | * Library: \b libAliHLTTrigger.so <br> | |
33 | * Input Data Types: ::kAliHLTAnyDataType <br> | |
1d8ae082 | 34 | * Output Data Types: kAliHLTDataTypeGlobalTrigger and kAliHLTDataTypeReadoutList <br> |
52f67e50 | 35 | * |
36 | * <h2>Mandatory arguments:</h2> | |
1d8ae082 | 37 | * None. |
52f67e50 | 38 | * |
39 | * <h2>Optional arguments:</h2> | |
40 | * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting --> | |
41 | * \li -config <i>filename</i> <br> | |
42 | * Indicates the configuration macro file to use for the global HLT trigger menu. | |
43 | * \li -includepath <i>path</i> <br> | |
44 | * Indicates the include path to use if the automatically generated code that | |
45 | * implements the global HLT trigger requires non-standard includes. | |
46 | * \li -include <i>filename</i> <br> | |
47 | * Indicates a file name that should be included in the automatically generated | |
48 | * trigger implementation code. | |
49 | * \li -debug <br> | |
50 | * If specified the automatically generated class will contain extra debugging | |
51 | * code and the ACLiC system will have debugging compilation turned on. | |
566a01d0 | 52 | * \li -cint <br> |
53 | * Use CINT to interprete the generated global trigger instead of compiling it. | |
54 | * This will also be the case if no compiler is available. | |
52f67e50 | 55 | * \li -usecode <i>filename</i> <i>classname</i> <br> |
56 | * Used to force the component to use an existing class for the global HLT trigger | |
57 | * class implementation, with the name of <i>classname</i> and found in the file | |
58 | * <i>filename</i>. | |
81d62bb4 | 59 | * \li -skipctp <br> |
60 | * Indicates that the CTP data should not be added to the global HLT trigger decision. | |
52f67e50 | 61 | * |
62 | * <h2>Configuration:</h2> | |
1d8ae082 | 63 | * Configured from CDB but can be overridden with the -config argument. |
52f67e50 | 64 | * |
65 | * <h2>Default CDB entries:</h2> | |
3da1c6d7 | 66 | * HLT/ConfigHLT/HLTGlobalTrigger - Contains the global trigger menu. |
52f67e50 | 67 | * |
68 | * <h2>Performance:</h2> | |
3da1c6d7 | 69 | * This is a linear function of the number of input triggers (AliHLTTrigger) that |
70 | * need to be processed. | |
71 | * For a modest trigger menu configurations the processing time per event should | |
72 | * be on the order of a few milliseconds. | |
52f67e50 | 73 | * |
74 | * <h2>Memory consumption:</h2> | |
3da1c6d7 | 75 | * Memory consumption is minimal. It should be on the order of 2 or 3 MBytes. |
52f67e50 | 76 | * |
77 | * <h2>Output size:</h2> | |
3da1c6d7 | 78 | * This will depend almost linearly on the number of intput triggers and summary |
79 | * data objects used. Thus, for every trigger (AliHLTTrigger object) specified | |
80 | * in the trigger menu the output size will require about 1 kBytes. | |
81 | * Then for every summary data object (i.e. TObject symbol defined in the trigger | |
82 | * menu configuration) one will need an extra few kBytes, depending on the size | |
83 | * of the summary objects. | |
84 | * In total one would expect no more than a MByte output size for a large trigger | |
85 | * configuration and typically only a few kBytes for a small or optimised one. | |
52f67e50 | 86 | * |
87 | * \ingroup alihlt_trigger_components | |
1b9a175e | 88 | */ |
89 | class AliHLTGlobalTriggerComponent : public AliHLTTrigger | |
90 | { | |
91 | public: | |
92 | ||
93 | AliHLTGlobalTriggerComponent(); | |
94 | virtual ~AliHLTGlobalTriggerComponent(); | |
95 | ||
96 | /** | |
97 | * Inherited from AliHLTTrigger. | |
98 | * @return string containing the global trigger name. | |
99 | */ | |
100 | virtual const char* GetTriggerName() const { return "HLTGlobalTrigger"; }; | |
025443e0 | 101 | |
102 | /** | |
103 | * Inherited from AliHLTTrigger. | |
104 | * This returns kAliHLTDataTypeGlobalTrigger by default. | |
105 | * @param list <i>[out]</i>: The list of data types to be filled. | |
106 | */ | |
107 | virtual void GetOutputDataTypes(AliHLTComponentDataTypeList& list) const; | |
e2bb8ddd | 108 | |
1b9a175e | 109 | /** |
110 | * Get a ratio by how much the data volume is shrunk or enhanced. | |
111 | * The method returns a size proportional to the trigger name string length | |
112 | * for constBase, and 1 for inputMultiplier. | |
113 | * @param constBase <i>[out]</i>: additive part, independent of the | |
114 | * input data volume | |
115 | * @param inputMultiplier <i>[out]</i>: multiplication ratio | |
116 | */ | |
117 | virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier); | |
4f1d6b68 | 118 | |
e2bb8ddd | 119 | /** |
120 | * Initialise the component. | |
121 | * \param argc The number of arguments in argv. | |
122 | * \param argv Array of component argument strings. | |
123 | * \returns Zero on success and negative number on failure. | |
124 | */ | |
125 | virtual Int_t DoInit(int argc, const char** argv); | |
126 | ||
127 | /** | |
128 | * Cleanup the component. | |
129 | * \returns Zero on success and negative number on failure. | |
130 | */ | |
131 | virtual Int_t DoDeinit(); | |
132 | ||
4f1d6b68 | 133 | /** |
134 | * Spawn function creates a new object. | |
135 | * @return new class instance. | |
136 | */ | |
137 | virtual AliHLTComponent* Spawn(); | |
1b9a175e | 138 | |
139 | protected: | |
140 | ||
1b9a175e | 141 | /** |
142 | * Applies the global HLT trigger. | |
143 | * @return Zero is returned on success and a negative error code on failure. | |
144 | */ | |
145 | virtual int DoTrigger(); | |
146 | ||
81d62bb4 | 147 | /** |
148 | * Reconfigures the component by loading the trigger menu from the given | |
149 | * CDB entry. | |
150 | * \param cdbEntry The CDB path to the trigger menu to load. | |
151 | * \param chainId The ID of the component in the chain. | |
152 | * \returns Zero on success and non-zero values otherwise. | |
153 | */ | |
154 | virtual int Reconfigure(const char* cdbEntry, const char* chainId); | |
155 | ||
1b9a175e | 156 | private: |
52f67e50 | 157 | |
158 | /// Not implemented. Do not allow copying of this object. | |
159 | AliHLTGlobalTriggerComponent(const AliHLTGlobalTriggerComponent& obj); | |
160 | /// Not implemented. Do not allow copying of this object. | |
161 | AliHLTGlobalTriggerComponent& operator = (const AliHLTGlobalTriggerComponent& obj); | |
1b9a175e | 162 | |
81d62bb4 | 163 | /** |
164 | * Loads a trigger menu object from the CDB. | |
165 | * \param cdbPath <i>in</i> The path in the CDB to load the trigger menu object from. | |
166 | * \param menu <i>out</i> A pointer that gets filled with the new trigger menu object. | |
167 | * \returns Zero if the trigger menu object was found and the pointer to it | |
168 | * set in the <i>menu</i> variable. If a non-zero error code is returned then | |
169 | * the <i>menu</i> variable is not changed at all. | |
170 | */ | |
171 | int LoadTriggerMenu(const char* cdbPath, const AliHLTTriggerMenu*& menu); | |
172 | ||
e2bb8ddd | 173 | /** |
174 | * Generates the code for the global trigger to apply the given trigger menu. | |
175 | * The code will then be compiled on the fly and loaded. The name of the new | |
176 | * class is returned so that a new instance of the class can be created via: | |
177 | * \code | |
178 | * AliHLTGlobalTrigger::CreateNew(name) | |
179 | * \endcode | |
180 | * where name is the name of the generated class as returned by this method. | |
81d62bb4 | 181 | * |
182 | * The name of the generated code file is stored in the variable fCodeFileName | |
183 | * and the fDeleteCodeFile is set to true. | |
184 | * | |
52f67e50 | 185 | * \param menu <i>in</i> The trigger menu to create the global trigger class from. |
186 | * \param name <i>out</i> The name of the generated class. | |
81d62bb4 | 187 | * \param filename <i>out</i> The name of the generated file containing the code. |
52f67e50 | 188 | * \param includePaths <i>in</i> The list of include path strings. |
189 | * \param includeFiles <i>in</i> The list of include file strings. | |
190 | * \returns The error code suitable to return in DoInit. Zero on success. | |
191 | */ | |
192 | int GenerateTrigger( | |
81d62bb4 | 193 | const AliHLTTriggerMenu* menu, TString& name, TString& filename, |
52f67e50 | 194 | const TClonesArray& includePaths, const TClonesArray& includeFiles |
195 | ); | |
196 | ||
197 | /** | |
198 | * Loads the code for the generated HLT global trigger class. The code is compiled | |
199 | * on the fly if possible, otherwise the CINT interpreter is used to interpret | |
200 | * the class. | |
201 | * \param filename The name of the file containing the code for the global trigger class. | |
202 | * \param includePaths <i>in</i> The list of include path strings. | |
203 | * \returns The error code suitable to return in DoInit. Zero on success. | |
204 | */ | |
205 | int LoadTriggerClass(const char* filename, const TClonesArray& includePaths); | |
206 | ||
81d62bb4 | 207 | /** |
208 | * Unloads the code that was previously loaded by LoadTriggerClass. | |
209 | * \param filename The name of the file containing the global trigger class logic to be unloaded. | |
210 | * \returns The error code suitable to return in DoInit. Zero on success. | |
211 | */ | |
212 | int UnloadTriggerClass(const char* filename); | |
213 | ||
52f67e50 | 214 | /** |
215 | * Searches for the specified symbol name in the given list. | |
216 | * \param name The name of the symbol to find. | |
217 | * \param list The list to search for the symbol in. | |
218 | * \returns The position (index) of the symbol found or -1 if it was not found. | |
219 | */ | |
220 | int FindSymbol(const char* name, const TClonesArray& list); | |
221 | ||
222 | /** | |
223 | * Builds the list of symbols to use in the custom global trigger menu | |
224 | * implementation class. | |
e2bb8ddd | 225 | * \param menu The trigger menu to create the global trigger class from. |
52f67e50 | 226 | * \param list The list to fill with symbols. |
e2bb8ddd | 227 | * \returns The error code suitable to return in DoInit. Zero on success. |
228 | */ | |
52f67e50 | 229 | int BuildSymbolList(const AliHLTTriggerMenu* menu, TClonesArray& list); |
81d62bb4 | 230 | |
231 | /** | |
232 | * Extracts the trailing operator in a C++ expression and returns the found | |
233 | * operator in a separate output string. | |
234 | * [in/out] \param expr The C++ expression to check. The trailing operator | |
235 | * is removed from the expression if found. | |
236 | * [out] \param op The output variable which will be filled with the | |
237 | * operator found in the expression. | |
238 | * \return true if the trailing operator was found in the expression and | |
239 | * false otherwise. | |
240 | */ | |
241 | bool ExtractedOperator(TString& expr, TString& op); | |
2974f8dc | 242 | |
566a01d0 | 243 | /** |
244 | * Add trigger decisions according to the active CTP trigger classes | |
245 | * An internal TclonesArray holds the trigger decisions to be added. The trigger | |
246 | * decisions are updated according to the active CTP trigger mask. | |
247 | * \param pTrigger The instance of the global trigger | |
248 | * \param pCTPData Instance of the CTP data | |
249 | * \param trigData Current trigger data, if NULL, the active trigger data from the CTP data is used | |
250 | */ | |
251 | int AddCTPDecisions(AliHLTGlobalTrigger* pTrigger, const AliHLTCTPData* pCTPData, const AliHLTComponentTriggerData* trigData); | |
252 | ||
2974f8dc | 253 | /** |
254 | * Print some statistics based on the trigger counters | |
255 | */ | |
256 | int PrintStatistics(const AliHLTGlobalTrigger* pTrigger, AliHLTComponentLogSeverity level=kHLTLogInfo, int offset=1) const; | |
e2bb8ddd | 257 | |
258 | AliHLTGlobalTrigger* fTrigger; //! Trigger object which implements the global trigger menu. | |
52f67e50 | 259 | bool fDebugMode; //! Indicates if the generated global trigger class should be in debug mode. |
566a01d0 | 260 | bool fRuntimeCompile; //! Indicates if the generated global trigger class should be compiled |
261 | bool fSkipCTPCounters; //! Indicates whether to ship CTP info with the trigger decision | |
81d62bb4 | 262 | bool fDeleteCodeFile; //! If true then the code file indicated by fCodeFileName should be deleted during DoDeinit. |
72bc5ab0 | 263 | TString fCodeFileName; //! base file name of the generated code for the global trigger |
81d62bb4 | 264 | TString fClassName; //! The generated/loaded trigger class name. |
566a01d0 | 265 | TClonesArray* fCTPDecisions; //! AliHLTTriggerDecision objects for the CTP classes |
81d62bb4 | 266 | unsigned long fBufferSizeConst; //! Constant size estimate for GetOutputDataSize. |
267 | double fBufferSizeMultiplier; //! Buffer size multiplier estimate for GetOutputDataSize. | |
268 | TClonesArray fIncludePaths; //! Paths specified by the -includepath command line option. | |
269 | TClonesArray fIncludeFiles; //! Files specified by the -include command line option. | |
1b820a65 | 270 | TString fLibStateAtLoad; //! This stores the loaded libraries just before we tell CINT to load the interpreted file. |
566a01d0 | 271 | |
3da1c6d7 | 272 | static const char* fgkTriggerMenuCDBPath; //! The path string to read the trigger menu from the CDB. |
273 | ||
1b9a175e | 274 | ClassDef(AliHLTGlobalTriggerComponent, 0) // Global HLT trigger component class which produces the final trigger decision and readout list. |
275 | }; | |
276 | ||
277 | #endif // ALIHLTGLOBALTRIGGERCOMPONENT_H | |
278 |