1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
16 #include "AliAnalysisTaskCfg.h"
17 #include "AliAnalysisManager.h"
19 #include "Riostream.h"
22 #include "TInterpreter.h"
24 #include "TObjArray.h"
25 #include "TObjString.h"
28 // Author: Andrei Gheata, 12/08/2011
30 //==============================================================================
31 // AliAnalysysTaskCfg - Class embedding the configuration needed to run
32 // a given analysis task: libraries to be loaded, location and name of the macro
33 // used to add the task to the analysis manager, dependencies.
34 //==============================================================================
36 // This class is used to fully describe how to run a given analysis task. It
37 // requires that the user creates an AddTask macro for his task and defines:
38 // - The needed libs separated by commas,
39 // - The full path to the AddTask macro (starting with $ALICE_ROOT if needed)
40 // - The list of arguments to be provided to the AddTask macro. One can use
41 // here only constants that can be interpreted.
42 // - The list of dependencies (other modules required to run this task). These
43 // must be names of other AliAnalysisTaskCfg objects, separated by commas.
44 // - Data types supported by the task (e.g. ESD, AOD, MC)
45 // The class has normal ROOT IO, but it can also read from and write to text files.
47 // Content of file: QAsym.cfg
49 # Lines that do not start with #Module are ignored, except those in embedded
53 #Module.Deps PhysicsSelection
54 #Module.DataTypes ESD, AOD, MC
55 #Module.MacroName $ALICE_ROOT/PWGPP/PilotTrain/AddTaskQAsym.C
56 #Module.MacroArgs 0, AliVEvent::kAnyINT, AliVEvent::kHighMult, AliVEvent::kEMC7, AliVEvent::kMUU7
60 __R_ADDTASK__->SelectCollisionCandidates();
63 // The following special variable names can be used:
64 // __R_ADDTASK__ = the return value of the AddTask macro included
65 // __R_ESDH__ = pointer to ESD handler
66 // __R_AODH__ = pointer to AOD handler
67 // __R_MCH__ = pointer to MC handler
68 // The static method ExtractModulesFrom(const char *filename) allows reading
69 // several task configuration modules from the same text file and returning
70 // them in a TObjArray.
72 // A list of configuration modules representing a train should be injected in
73 // the right order in the grid handler to generate train macros.
81 ClassImp(AliAnalysisTaskCfg)
83 //______________________________________________________________________________
84 AliAnalysisTaskCfg::AliAnalysisTaskCfg()
100 //______________________________________________________________________________
101 AliAnalysisTaskCfg::AliAnalysisTaskCfg(const char *name)
114 // Constructor. All configuration objects need to be named since they are looked
118 //______________________________________________________________________________
119 AliAnalysisTaskCfg::AliAnalysisTaskCfg(const AliAnalysisTaskCfg &other)
121 fMacroName(other.fMacroName),
122 fMacroArgs(other.fMacroArgs),
125 fDataTypes(other.fDataTypes),
126 fOutputFile(other.fOutputFile),
127 fTerminateFile(other.fTerminateFile),
133 if (other.fMacro) fMacro = new TMacro(*other.fMacro);
134 if (other.fConfigDeps) fConfigDeps = new TMacro(*other.fConfigDeps);
137 //______________________________________________________________________________
138 AliAnalysisTaskCfg::~AliAnalysisTaskCfg()
145 //______________________________________________________________________________
146 AliAnalysisTaskCfg& AliAnalysisTaskCfg::operator=(const AliAnalysisTaskCfg &other)
148 // Assignment operator.
149 if (&other == this) return *this;
150 TNamed::operator=(other);
151 fMacroName = other.fMacroName;
152 fMacroArgs = other.fMacroArgs;
155 fDataTypes = other.fDataTypes;
156 fOutputFile = other.fOutputFile;
157 fTerminateFile = other.fTerminateFile;
158 if (other.fMacro) fMacro = new TMacro(*other.fMacro);
159 if (other.fConfigDeps) fConfigDeps = new TMacro(*other.fConfigDeps);
160 fRAddTask = other.fRAddTask;
164 //______________________________________________________________________________
165 TMacro *AliAnalysisTaskCfg::OpenMacro(const char *name)
167 // Opens the specified macro if name is not empty. In case of success updates
168 // fMacroName, creates the maco object and returns its pointer.
169 // Clean-up previous macro if any
175 if (strlen(name)) expname = gSystem->ExpandPathName(name);
176 else expname = gSystem->ExpandPathName(fMacroName.Data());
177 if (expname.IsNull()) {
178 Error("OpenMacro", "Macro name not provided and not previously set");
181 if (gSystem->AccessPathName(expname)) {
182 Error("OpenMacro", "Macro: %s cannot be opened.", expname.Data());
185 if (strlen(name)) fMacroName = name;
186 fMacro = new TMacro(expname);
190 //______________________________________________________________________________
191 void AliAnalysisTaskCfg::SetMacro(TMacro *macro)
193 // Set the AddTask macro from outside. This will discard the existing macro if
194 // any. The provided macro will be owned by this object.
195 if (fMacro) delete fMacro;
199 //______________________________________________________________________________
200 Long64_t AliAnalysisTaskCfg::ExecuteMacro(const char *newargs)
202 // Execute AddTask macro. Opens first the macro pointed by fMacroName if not yet
203 // done. Checks if the requested libraries are loaded, else loads them. Executes
204 // with stored fMacroArgs unless new arguments are provided. The flag IsLoaded
205 // is set once the macro was successfully executed.
206 if (IsLoaded()) return kTRUE;
207 if (!fMacro && !OpenMacro()) {
208 Error("ExecuteMacro", "Cannot execute this macro");
211 if (!CheckLoadLibraries()) {
212 Error("ExecuteMacro", "Cannot load requested libraries: %s", fLibs.Data());
216 AliAnalysisManager *mgr = AliAnalysisManager::GetAnalysisManager();
218 Error("ExecuteMacro", "Analysis manager not defined yet");
221 Int_t ntasks0 = mgr->GetTasks()->GetEntriesFast();
222 TString args = newargs;
223 if (args.IsNull()) args = fMacroArgs;
225 Long64_t retval = fMacro->Exec(args, &error);
226 if (error != TInterpreter::kNoError)
228 Error("ExecuteMacro", "Macro interpretation failed");
231 Int_t ntasks = mgr->GetTasks()->GetEntriesFast();
234 Error("ExecuteMacro", "The macro did not add any tasks to the manager");
237 Long64_t ptrTask = (Long64_t)mgr->GetTasks()->At(ntasks0);
238 if (retval >= ptrTask) {
239 TObject::SetBit(AliAnalysisTaskCfg::kLoaded, kTRUE);
240 fRAddTask = reinterpret_cast<TObject*>(retval);
241 if (fConfigDeps && dynamic_cast<TObject*>(fRAddTask)) {
242 TString classname = fRAddTask->ClassName();
243 classname += Form("* __R_ADDTASK__ = (%s*)0x%lx;", classname.Data(),(ULong_t)retval);
244 classname.Prepend(" ");
245 TObjString *line = fConfigDeps->GetLineWith("__R_ADDTASK__");
247 TList *lines = fConfigDeps->GetListOfLines();
248 lines->AddBefore(line, new TObjString(classname));
252 Info("ExecuteMacro", "Macro %s added %d tasks to the manager", fMacro->GetName(), ntasks-ntasks0);
256 //______________________________________________________________________________
257 Int_t AliAnalysisTaskCfg::GetNlibs() const
259 // Returns number of requested libraries.
260 if (fLibs.IsNull()) return 0;
261 TObjArray *list = fLibs.Tokenize(",");
262 Int_t nlibs = list->GetEntriesFast();
267 //______________________________________________________________________________
268 const char *AliAnalysisTaskCfg::GetLibrary(Int_t i) const
270 // Returns library name for the i-th library.
271 Int_t nlibs = GetNlibs();
272 if (i>=nlibs) return 0;
273 static TString libname;
274 TObjArray *list = fLibs.Tokenize(",");
275 libname = list->At(i)->GetName();
276 libname.ReplaceAll(".so","");
277 libname.ReplaceAll(" ","");
278 if (libname.BeginsWith("lib")) libname.Remove(0, 3);
280 return libname.Data();
283 //______________________________________________________________________________
284 Bool_t AliAnalysisTaskCfg::CheckLoadLibraries() const
286 // Check if all requested libraries were loaded, otherwise load them. If some
287 // library cannot be loaded return false.
289 Int_t nlibs = GetNlibs();
290 for (Int_t i=0; i<nlibs; i++) {
291 library = GetLibrary(i);
292 library.Prepend("lib");
293 Int_t loaded = strlen(gSystem->GetLibraries(library,"",kFALSE));
294 if (!loaded) loaded = gSystem->Load(library);
296 Error("CheckLoadLibraries", "Cannot load library %s", library.Data());
303 //______________________________________________________________________________
304 Bool_t AliAnalysisTaskCfg::NeedsLibrary(const char *lib) const
306 // Check if a given library is needed by the module.
307 TString libname = lib;
308 libname.ReplaceAll(".so","");
309 if (libname.BeginsWith("lib")) libname.Remove(0, 3);
310 return fLibs.Contains(libname);
313 //______________________________________________________________________________
314 Int_t AliAnalysisTaskCfg::GetNdeps() const
316 // Returns number of requested libraries.
317 if (fDeps.IsNull()) return 0;
318 Int_t ndeps = fDeps.CountChar(',')+1;
322 //______________________________________________________________________________
323 const char *AliAnalysisTaskCfg::GetDependency(Int_t i) const
325 // Returns library name for the i-th library.
326 Int_t ndeps = GetNdeps();
327 if (i>=ndeps) return 0;
328 static TString depname;
329 TObjArray *list = fDeps.Tokenize(",");
330 depname = list->At(i)->GetName();
331 depname.ReplaceAll(" ","");
333 return depname.Data();
336 //______________________________________________________________________________
337 Bool_t AliAnalysisTaskCfg::NeedsDependency(const char *dep) const
339 // Check if a given library is needed by the module.
340 return fDeps.Contains(dep);
343 //______________________________________________________________________________
344 TMacro *AliAnalysisTaskCfg::OpenConfigMacro(const char *name)
346 // Opens the specified macro if name is not empty.
352 TString expname = gSystem->ExpandPathName(name);
353 if (expname.IsNull()) {
354 Error("OpenConfigMacro", "Macro name not provided");
357 if (gSystem->AccessPathName(expname)) {
358 Error("OpenMacro", "Macro: %s cannot be opened.", expname.Data());
361 fConfigDeps = new TMacro(expname);
365 //______________________________________________________________________________
366 void AliAnalysisTaskCfg::SetConfigMacro(TMacro *macro)
368 // Set the macro for configuring deps from outside. This will discard the
369 // existing macro if any. The provided macro will be owned by this object.
370 if (fConfigDeps) delete fConfigDeps;
374 //______________________________________________________________________________
375 Long64_t AliAnalysisTaskCfg::ExecuteConfigMacro()
377 // Execute macro to configure dependencies. No arguments are supported.
379 Error("ExecuteConfigMacro", "Call OpenConfigMacro() first");
382 if (!CheckLoadLibraries()) {
383 Error("ExecuteConfigMacro", "Cannot load requested libraries: %s", fLibs.Data());
387 Long64_t retval = fConfigDeps->Exec("", &error);
388 if (error != TInterpreter::kNoError)
390 Error("ExecuteMacro", "Macro interpretation failed");
396 //______________________________________________________________________________
397 void AliAnalysisTaskCfg::SetDataTypes(const char *types)
399 // Sets the data types supported by the module. Stored in upper case.
401 fDataTypes.ToUpper();
404 //______________________________________________________________________________
405 Bool_t AliAnalysisTaskCfg::SupportsData(const char *type) const
407 // Checks if the given data type is supported.
408 TString stype = type;
410 return fDataTypes.Contains(stype);
413 //______________________________________________________________________________
414 void AliAnalysisTaskCfg::Print(Option_t * option) const
416 // Print content of the module.
418 Bool_t full = (opt.Length())?kTRUE:kFALSE;
419 printf("====================================================================\n");
420 printf("# Analysis task: %s\n", GetName());
421 printf("# Supported data types: %s\n", fDataTypes.Data());
422 printf("# Extra libraries: %s\n", fLibs.Data());
423 printf("# Extra dependencies: %s\n", fDeps.Data());
425 printf("# Macro to configure deps: %s\n", fConfigDeps->GetTitle());
426 if (full) fConfigDeps->Print();
428 printf("# Macro connecting this task: %s\n", fMacroName.Data());
429 printf("# Arguments to run the macro: %s\n", fMacroArgs.Data());
431 if (fMacro) fMacro->Print();
433 TMacro macro(gSystem->ExpandPathName(fMacroName.Data()));
439 //______________________________________________________________________________
440 void AliAnalysisTaskCfg::SaveAs(const char *filename, Option_t *option) const
442 // Save the configuration module as text file in the form key:value. The
443 // option can be APPEND, otherwise the file gets overwritten.
446 ios::openmode mode = ios::out;
447 if (opt == "APPEND") mode = ios::app;
449 out.open(filename, mode);
451 Error("SaveAs", "Bad file name: %s", filename);
454 out << "#Module.Begin " << GetName() << endl;
455 out << "#Module.Libs " << fLibs << endl;
456 out << "#Module.Deps " << fDeps << endl;
457 out << "#Module.DataTypes " << fDataTypes << endl;
458 out << "#Module.OutputFile " << fOutputFile << endl;
459 out << "#Module.TerminateFile " << fTerminateFile << endl;
460 out << "#Module.MacroName " << fMacroName << endl;
461 out << "#Module.MacroArgs " << fMacroArgs << endl;
463 out << "#Config.Deps " << fConfigDeps->GetTitle() << endl;
468 //______________________________________________________________________________
469 const char *AliAnalysisTaskCfg::DecodeValue(TString &line)
471 // Decode the value string from the line
472 static TString value;
473 value = line(line.Index(' '),line.Length());
474 value = value.Strip(TString::kLeading,' ');
475 value = value.Strip(TString::kTrailing,' ');
479 //______________________________________________________________________________
480 TObjArray *AliAnalysisTaskCfg::ExtractModulesFrom(const char *filename)
482 // Read all modules from a text file and add them to an object array. The
483 // caller must delete the array at the end. Any module must start with a line
484 // containing: #Module.Begin
485 TString expname = gSystem->ExpandPathName(filename);
486 if (gSystem->AccessPathName(expname)) {
487 ::Error("ExtractModulesFrom", "Cannot open file %s", filename);
490 AliAnalysisTaskCfg *cfg = 0;
491 TObjArray *array = 0;
497 TMacro *addMacro = 0;
498 TMacro *addConfig = 0;
500 in.getline(cline,1024);
502 if (line.BeginsWith("#Module.Begin")) {
503 // New module found, save previous if any
505 if (addMacro) cfg->SetMacro(addMacro);
506 if (addConfig) cfg->SetConfigMacro(addConfig);
507 if (!array) array = new TObjArray();
510 // Decode module name from the line
511 decode = AliAnalysisTaskCfg::DecodeValue(line);
512 cfg = new AliAnalysisTaskCfg(decode);
515 } else if (cfg && line.BeginsWith("#Module.Libs")) {
517 decode = AliAnalysisTaskCfg::DecodeValue(line);
518 cfg->SetLibraries(decode);
519 } else if (cfg && line.BeginsWith("#Module.Deps")) {
520 // Dependencies section
521 decode = AliAnalysisTaskCfg::DecodeValue(line);
522 cfg->SetDependencies(decode);
523 } else if (cfg && line.BeginsWith("#Module.DataTypes")) {
525 decode = AliAnalysisTaskCfg::DecodeValue(line);
526 cfg->SetDataTypes(decode);
527 } else if (cfg && line.BeginsWith("#Module.OutputFile")) {
528 // Desired output file name (via SetCommonOutput)
529 decode = AliAnalysisTaskCfg::DecodeValue(line);
530 cfg->SetOutputFileName(decode);
531 } else if (cfg && line.BeginsWith("#Module.TerminateFile")) {
532 // Custom file name produced in Terminate if any
533 decode = AliAnalysisTaskCfg::DecodeValue(line);
534 cfg->SetTerminateFileName(decode);
535 } else if (cfg && line.BeginsWith("#Module.MacroName")) {
536 // Name of the add task macro (including path)
537 decode = AliAnalysisTaskCfg::DecodeValue(line);
538 cfg->SetMacroName(decode);
539 } else if (cfg && line.BeginsWith("#Module.MacroArgs")) {
540 // Arguments for the AddTask macro
541 decode = AliAnalysisTaskCfg::DecodeValue(line);
542 cfg->SetMacroArgs(decode);
543 } else if (cfg && line.BeginsWith("#Module.StartMacro")) {
544 // Marker for start of the AddTask macro
545 addMacro = new TMacro();
546 TString shortName = gSystem->BaseName(cfg->GetMacroName());
547 shortName = shortName(0,shortName.Index("."));
548 addMacro->SetName(shortName);
549 addMacro->SetTitle(cfg->GetMacroName());
550 } else if (cfg && line.BeginsWith("#Module.StartConfig")) {
551 // Marker for start of the configuration macro
552 addConfig = new TMacro();
553 TString shortName = gSystem->BaseName(cfg->GetMacroName());
554 shortName = shortName(0,shortName.Index("."));
555 shortName += "Config";
556 addConfig->SetName(shortName);
557 shortName.Prepend("/");
558 shortName.Prepend(gSystem->DirName(cfg->GetMacroName()));
560 addConfig->SetTitle(shortName);
561 } else if (cfg && line.BeginsWith("#Module.EndMacro")) {
562 // Marker for the end of the embedded macro. EndMacro block mandatory.
563 if (cfg && addMacro) {
564 cfg->SetMacro(addMacro);
567 ::Error("ExtractModulesFrom", "Canot end un-started macro block");
569 } else if (cfg && line.BeginsWith("#Module.EndConfig")) {
570 // Marker for the end of the config macro. EndConfig block is mandatory
571 if (cfg && addConfig) {
572 addConfig->GetListOfLines()->AddFirst(new TObjString(Form("%s() {",gSystem->BaseName(addConfig->GetName()))));
573 addConfig->GetListOfLines()->AddLast(new TObjString("}"));
574 cfg->SetConfigMacro(addConfig);
577 ::Error("ExtractModulesFrom", "Canot end un-started config macro block");
580 // Reading a block line
581 if (addMacro) addMacro->AddLine(line);
582 else if (addConfig) addConfig->AddLine(line);
585 // Add last found object to the list
587 if (addMacro) ::Error("ExtractModulesFrom", "#Module.EndMacro block not found");
588 if (addConfig) ::Error("ExtractModulesFrom", "#Module.EndConfig block not found");
589 if (!array) array = new TObjArray();