Changes from Martin: prepare new options field for handling big output in PROOF....
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisAlien.h
1 #ifndef ALIANALYSISALIEN_H
2 #define ALIANALYSISALIEN_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 // Author: Mihaela Gheata, 01/09/2008
7
8 //==============================================================================
9 //   AliAnalysisAlien - AliEn utility class. Provides interface for creating
10 // a personalized JDL, finding and creating a dataset.
11 //==============================================================================
12
13 #ifndef ALIANALYSISGRID_H
14 #include "AliAnalysisGrid.h"
15 #endif
16
17 #ifndef ROOT_TString
18 #include <TString.h>
19 #endif
20
21 #ifndef ROOT_TMath
22 #include <TMath.h>
23 #endif
24
25 #ifndef ROOT_TMap
26 #include <TMap.h>
27 #endif
28
29 class AliAnalysisManager;
30 class AliAnalysisTaskCfg;
31 class TGridJDL;
32
33 class AliAnalysisAlien : public AliAnalysisGrid {
34
35 public:
36
37    AliAnalysisAlien();
38    AliAnalysisAlien(const char *name);
39    virtual ~AliAnalysisAlien();
40    AliAnalysisAlien(const AliAnalysisAlien& other); 
41    AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
42 // Setters   
43    virtual void        AddAdditionalLibrary(const char *name);
44    virtual void        AddIncludePath(const char *path);
45    virtual void        AddRunNumber(Int_t run);
46    virtual void        AddRunNumber(const char *run);
47    virtual void        AddRunList(const char *runList);
48    virtual void        AddDataFile(const char *lfn);
49    virtual void        AddExternalPackage(const char *name);
50    virtual void        SetExecutable(const char *name="analysis.sh")     {fExecutable = name;}
51    virtual void        SetExecutableCommand(const char *command="root -b -q") {fExecutableCommand = command;}
52    virtual void        SetArguments(const char *name="")                 {fArguments = name;}
53    virtual void        SetExecutableArgs(const char *name="")            {fExecutableArgs = name;}
54    virtual void        SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
55    virtual void        SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
56    virtual void        SetValidationScript(const char *name="validation.sh") {fValidationScript = name;}
57    virtual void        SetAdditionalLibs(const char *list)               {fAdditionalLibs = list;}
58    virtual void        SetAdditionalRootLibs(const char *list)           {fAdditionalRootLibs = list;}
59    virtual void        SetPrice(Int_t price=1)                           {fPrice = price;}
60    virtual void        SetRunRange(Int_t min, Int_t max)                 {fRunRange[0] = min; fRunRange[1] = max;}
61    virtual void        SetJobTag(const char *tag="")                     {fJobTag = tag;}
62    virtual void        SetNrunsPerMaster(Int_t nruns=1)                  {fNrunsPerMaster = nruns;}
63    virtual void        SetMaxMergeFiles(Int_t nfiles)                    {fMaxMergeFiles = nfiles;}
64    virtual void        SetMaxMergeStages(Int_t nstages)                  {fMaxMergeStages = nstages;}
65    virtual void        SetSplitMode(const char *type="se")               {fSplitMode = type;}
66    virtual void        SetSplitMaxInputFileNumber(Int_t nfiles=100)      {fSplitMaxInputFileNumber = nfiles;}
67    virtual void        SetAPIVersion(const char *version)                {fAPIVersion = version;}
68    virtual void        SetROOTVersion(const char *version)               {fROOTVersion = version;}
69    virtual void        SetAliROOTVersion(const char *version)            {fAliROOTVersion=version;}
70    virtual void        SetUser(const char *user)                         {fUser = user;}
71    virtual void        SetTTL(Int_t ttl=30000)                           {fTTL = ttl;}
72    virtual void        SetGridWorkingDir(const char *name="workdir")     {fGridWorkingDir = name;}
73    virtual void        SetGridDataDir(const char *name)                  {fGridDataDir = name;}
74    virtual void        SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
75    virtual void        SetFriendChainName(const char *name="")           {fFriendChainName = name;}
76    virtual void        SetDefaultOutputs(Bool_t flag);
77    virtual void        SetGridOutputDir(const char *name="output")       {fGridOutputDir = name;}
78    virtual void        SetOutputArchive(const char *list="log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2");
79    virtual void        SetOutputFiles(const char *list);
80    virtual void        SetOutputToRunNo(Int_t mode=1)                    {fOutputToRunNo = mode;}
81    virtual void        SetInputFormat(const char *format="xml-single")   {fInputFormat = format;}
82    virtual void        SetMaxInitFailed(Int_t nfail=5)                   {fMaxInitFailed = nfail;}
83    virtual void        SetTerminateFiles(const char *list)               {fTerminateFiles = list;}
84    virtual void        SetMergeExcludes(const char *list)                {fMergeExcludes = list;};
85    virtual void        SetMergeViaJDL(Bool_t on=kTRUE)                   {fMergeViaJDL = on ? 1 : 0;}
86    virtual void        SetMergeDirName(const char *name)                 {fMergeDirName = name;}
87    virtual void        SetMasterResubmitThreshold(Int_t percentage)      {fMasterResubmitThreshold = percentage;}
88    virtual void        SetNtestFiles(Int_t nfiles)                       {fNtestFiles = nfiles;}
89    virtual void        SetNumberOfReplicas(Int_t ncopies)                {fNreplicas = TMath::Min(ncopies,4);}
90    virtual void        SetJDLName(const char *name="analysis.jdl")       {fJDLName = name;}
91    virtual void        SetPreferedSE(const char *se);
92    virtual void        SetProductionMode(Int_t mode=1)                   {fProductionMode = mode;}
93    virtual void        SetRegisterExcludes(const char *list)             {fRegisterExcludes = list;}
94    virtual void        SetRunPrefix(const char *prefix);
95    virtual void        SetOutputSingleFolder(const char *folder)         {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}
96    virtual void        SetFastReadOption(Bool_t on=kTRUE)                {fFastReadOption = on ? 1 : 0;}
97    virtual void        SetOverwriteMode(Bool_t on=kTRUE)                 {fOverwriteMode = on ? 1 : 0;}
98    virtual void        SetDropToShell(Bool_t drop=true)                  {fDropToShell = drop;}
99
100    TGridJDL           *GetGridJDL() const {return fGridJDL;}
101    TGridJDL           *GetMergingJDL() const {return fMergingJDL;}
102    const char         *GetGridOutputDir() const                          {return fGridOutputDir;}
103 //Utilities
104    void                AddModule(AliAnalysisTaskCfg *module);
105    void                AddModules(TObjArray *list);
106    AliAnalysisManager *CreateAnalysisManager(const char *name, const char *filename="");
107    Int_t               GetNmodules() const;
108    AliAnalysisTaskCfg *GetModule(const char *name);
109    Bool_t              LoadModules();
110    Bool_t              GenerateTest(const char *name, const char *modname="");
111    Bool_t              GenerateTrain(const char *name);
112    virtual Bool_t      CreateDataset(const char *pattern);
113    Int_t               CopyLocalDataset(const char *griddir, const char *pattern, Int_t nfiles, const char *output="data.txt", const char *archivefile="", const char *outputdir="data");
114    virtual Bool_t      CreateJDL();
115    virtual void        EnablePackage(const char *package);
116    static Bool_t       DirectoryExists(const char *lfn);
117    static Bool_t       FileExists(const char *lfn);
118    static const char  *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
119    const char         *GetListOfFiles(const char *type);
120    Bool_t              CheckMergedFiles(const char *filename, const char *aliendir, Int_t nperchunk, const char *jdl="");
121    static AliAnalysisManager *LoadAnalysisManager(const char *fname);
122    static Bool_t       MergeInfo(const char *output, const char *collection);
123    static Bool_t       MergeOutput(const char *output, const char *basedir, Int_t nmaxmerge, Int_t stage=0);
124    virtual Bool_t      MergeOutputs();
125    virtual void        Print(Option_t *option="") const;
126    virtual Bool_t      StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
127    static Bool_t       SetupPar(const char *package);
128    virtual Bool_t      Submit();
129    virtual Bool_t      SubmitMerging();
130    static Int_t        SubmitSingleJob(const char *query);
131    virtual void        WriteAnalysisFile();
132    virtual void        WriteAnalysisMacro();
133    virtual void        WriteMergingMacro();
134    virtual void        WriteMergeExecutable();
135    virtual void        WriteExecutable();
136    virtual Bool_t      WriteJDL(Bool_t copy);
137    virtual void        WriteProductionFile(const char *filename) const;
138    virtual void        WriteValidationScript(Bool_t merge=kFALSE);
139
140 // PROOF mode
141    virtual void        SetProofCluster(const char *cluster)              {fProofCluster = cluster;}
142    virtual void        SetProofDataSet(const char *dataset)              {fProofDataSet = dataset;}
143    virtual const char *GetProofDataSet() const                           {return fProofDataSet.Data();}
144    virtual void        SetProofParameter(const char *pname, const char *value);
145    const char         *GetProofParameter(const char *pname) const;
146    virtual void        SetProofReset(Int_t mode)                         {fProofReset = mode;}
147    virtual void        SetNproofWorkers(Int_t nworkers)                  {fNproofWorkers = nworkers;}
148    virtual void        SetNproofWorkersPerSlave(Int_t nworkers)          {fNproofWorkersPerSlave = nworkers;}
149    virtual void        SetRootVersionForProof(const char *version)       {fRootVersionForProof = version;}
150    virtual void        SetAliRootMode(const char *mode)                  {fAliRootMode = mode;}
151    virtual void        SetProofProcessOpt(const char *proofOpt="")       {fProofProcessOpt = proofOpt;}
152    virtual TString     GetProofProcessOpt()                              {return fProofProcessOpt;}
153    // .txt file containing the list of files to be chained in test mode
154    virtual void        SetFileForTestMode(const char *filename)          {fFileForTestMode = filename;}
155    virtual TChain     *GetChainForTestMode(const char *treeName) const;
156
157 protected:
158    void                CdWork();
159    Bool_t              CheckInputData();
160    void                CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
161    virtual Bool_t      Connect();
162    virtual void        SetDefaults();  
163    Bool_t              SubmitNext();
164
165    Bool_t              IsCollection(const char *lfn) const;
166    virtual Bool_t      IsSingleOutput() const;
167    Bool_t              IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
168    Bool_t              LoadModule(AliAnalysisTaskCfg *mod);
169    Bool_t              CheckDependencies();
170    Bool_t              CheckFileCopy(const char *alienpath);
171
172 private:
173    TGridJDL        *fGridJDL;         //! JDL maker
174    TGridJDL        *fMergingJDL;      //! JDL maker
175    Int_t            fPrice;           // Grid price for the job;
176    Int_t            fTTL;             // Time to live.
177    Int_t            fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
178    Int_t            fMaxInitFailed;   // Maximum initial consecutive subjobs accepted to fail
179    Int_t            fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
180    Int_t            fNtestFiles;      // Number of files used in the testing case
181    Int_t            fRunRange[2];     // Run range
182    Int_t            fNrunsPerMaster;  // Number of runs per masterjob
183    Int_t            fMaxMergeFiles;   // Maximum number of files to be merged in one chunk
184    Int_t            fMaxMergeStages;  // Maximum number of merging stages
185    Int_t            fNsubmitted;      // Number of jobs submitted
186    Int_t            fProductionMode;  // Production mode (0-off, 1-on)
187    Int_t            fOutputToRunNo;   // Use run number as output directory
188    Int_t            fMergeViaJDL;     // Enable merging via automatic JDL
189    Int_t            fFastReadOption;  // Use xrootd tweaks to reduce timeouts in file access
190    Int_t            fOverwriteMode;   // Overwrite existing files if any
191    Int_t            fNreplicas;       // Number of replicas for the output files
192    Int_t            fNproofWorkers;   // Number of workers in proof mode
193    Int_t            fNproofWorkersPerSlave; // Max number of workers per slave in proof mode
194    Int_t            fProofReset;      // Proof reset mode: 0=no reset, 1=soft, 2=hard
195    TString          fRunNumbers;      // List of runs to be processed
196    TString          fExecutable;      // Executable script for AliEn job
197    TString          fExecutableCommand;  // Command(s) to be executed in the executable script
198    TString          fArguments;       // Arguments for the executable script
199    TString          fExecutableArgs;  // arguments added to the executable script after the analysis macro
200    TString          fAnalysisMacro;   // Root macro steering the analysis
201    TString          fAnalysisSource;  // User analysis implementation (.cxx) file(s)
202    TString          fValidationScript; // Name of the validation script
203    TString          fAdditionalRootLibs;  // List (separated by blacs) of additional libraries needed for/before analysis libs/par file compilation
204    TString          fAdditionalLibs;  // List (separated by blacs) of additional libraries needed for the analysis loaded AFTER all par files
205    TString          fSplitMode;       // Job split mode
206    TString          fAPIVersion;      // API version
207    TString          fROOTVersion;     // ROOT version
208    TString          fAliROOTVersion;  // AliROOT version
209    TString          fExternalPackages; // External packages
210    TString          fUser;            // AliEn user name
211    TString          fGridWorkingDir;  // AliEn directory containing the input packages
212    TString          fGridDataDir;     // AliEn data production directory
213    TString          fDataPattern;     // Data pattern for 'find' command
214    TString          fGridOutputDir;   // AliEn directory (wrt work dir) where the output should be written
215    TString          fOutputArchive;   // List of output archives separated by blancs
216    TString          fOutputFiles;     // List of output files separated by blancs
217    TString          fInputFormat;     // Input format (xml-single)
218    TString          fDatasetName;     // Dataset xml file to be created
219    TString          fJDLName;         // JDL file to be generated
220    TString          fTerminateFiles;  // List of output files produced during Terminate
221    TString          fMergeExcludes;   // List of output files excluded from merging
222    TString          fRegisterExcludes; // List of liles not to be registered/merged
223    TString          fIncludePath;     // Include path
224    TString          fCloseSE;         // Preffered storage element. Taken from alien_CLOSE_SE environment.
225    TString          fFriendChainName; // File name to construct friend chain (for AOD)
226    TString          fJobTag;          // Job tag
227    TString          fOutputSingle;    // Directory name for the output when split is per file
228    TString          fRunPrefix;       // Run prefix to be applied to run numbers
229    TString          fProofCluster;    // Proof cluster name
230    TString          fProofDataSet;    // Proof dataset to be used
231    TString          fFileForTestMode; // .txt file for the chain to be used in PROOF test mode
232    TString          fRootVersionForProof; // ROOT version to be used in PROOF mode. The default one taken if empty.
233    TString          fAliRootMode;     // AliRoot mode among the list supported by the proof cluster
234    TString          fProofProcessOpt; // Option passed to proof process
235    TString          fMergeDirName;    // Name of the directory that should be added to the output directory
236    TObjArray       *fInputFiles;      // List of input files to be processed by the job
237    TObjArray       *fPackages;        // List of packages to be used
238    TObjArray       *fModules;         // List of AliAnalysisTaskCfg modules
239    TMap             fProofParam;      // Key-value pairs for proof mode
240    Bool_t           fDropToShell;     // If true, execute aliensh on start
241    
242    ClassDef(AliAnalysisAlien, 21)   // Class providing some AliEn utilities
243 };
244 #endif