Array of bits introduced to control better the "atomic" operations of the plugin...
[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 class TGridJDL;
22
23 class AliAnalysisAlien : public AliAnalysisGrid {
24
25 public:
26
27    AliAnalysisAlien();
28    AliAnalysisAlien(const char *name);
29    virtual ~AliAnalysisAlien();
30    AliAnalysisAlien(const AliAnalysisAlien& other); 
31    AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
32 // Setters   
33    virtual void        AddIncludePath(const char *path);
34    virtual void        AddRunNumber(Int_t run);
35    virtual void        AddRunNumber(const char *run);
36    virtual void        AddDataFile(const char *lfn);
37    virtual void        AddExternalPackage(const char *name);
38    virtual void        SetExecutable(const char *name="analysis.sh")     {fExecutable = name;}
39    virtual void        SetExecutableCommand(const char *command="root -b -q") {fExecutableCommand = command;}
40    virtual void        SetArguments(const char *name="")                 {fArguments = name;}
41    virtual void        SetExecutableArgs(const char *name="")            {fExecutableArgs = name;}
42    virtual void        SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
43    virtual void        SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
44    virtual void        SetAdditionalLibs(const char *list)               {fAdditionalLibs = list;}
45    virtual void        SetAdditionalRootLibs(const char *list)           {fAdditionalRootLibs = list;}
46    virtual void        SetPrice(Int_t price=1)                           {fPrice = price;}
47    virtual void        SetRunRange(Int_t min, Int_t max)                 {fRunRange[0] = min; fRunRange[1] = max;}
48    virtual void        SetJobTag(const char *tag="")                     {fJobTag = tag;}
49    virtual void        SetNrunsPerMaster(Int_t nruns=1)                  {fNrunsPerMaster = nruns;}
50    virtual void        SetMaxMergeFiles(Int_t nfiles)                    {fMaxMergeFiles = nfiles;}
51    virtual void        SetSplitMode(const char *type="se")               {fSplitMode = type;}
52    virtual void        SetSplitMaxInputFileNumber(Int_t nfiles=100)      {fSplitMaxInputFileNumber = nfiles;}
53    virtual void        SetAPIVersion(const char *version="V2.4") {fAPIVersion = version;}
54    virtual void        SetROOTVersion(const char *version="v5-21-01-alice") {fROOTVersion = version;}
55    virtual void        SetAliROOTVersion(const char *version="v4-14-Rev-02") {fAliROOTVersion=version;}
56    virtual void        SetUser(const char *user)                         {fUser = user;}
57    virtual void        SetTTL(Int_t ttl=30000)                           {fTTL = ttl;}
58    virtual void        SetGridWorkingDir(const char *name="workdir")     {fGridWorkingDir = name;}
59    virtual void        SetGridDataDir(const char *name)                  {fGridDataDir = name;}
60    virtual void        SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
61    virtual void        SetFriendChainName(const char *name="")           {fFriendChainName = name;}
62    virtual void        SetDefaultOutputs(Bool_t flag);
63    virtual void        SetGridOutputDir(const char *name="output")       {fGridOutputDir = name;}
64    virtual void        SetOutputArchive(const char *list="log_archive.zip:stdout,stderr root_archive.zip:*.root") {fOutputArchive = list;}
65    virtual void        SetOutputFiles(const char *list)                  {fOutputFiles = list;}
66    virtual void        SetOutputToRunNo(Int_t mode=1)                    {fOutputToRunNo = mode;}
67    virtual void        SetInputFormat(const char *format="xml-single")   {fInputFormat = format;}
68    virtual void        SetMaxInitFailed(Int_t nfail=5)                   {fMaxInitFailed = nfail;}
69    virtual void        SetMergeExcludes(const char *list)                {fMergeExcludes = list;};
70    virtual void        SetMergeViaJDL(Bool_t on=kTRUE)                   {fMergeViaJDL = on ? 1 : 0;}
71    virtual void        SetMasterResubmitThreshold(Int_t percentage)      {fMasterResubmitThreshold = percentage;}
72    virtual void        SetNtestFiles(Int_t nfiles)                       {fNtestFiles = nfiles;}
73    virtual void        SetJDLName(const char *name="analysis.jdl")       {fJDLName = name;}
74    virtual void        SetPreferedSE(const char *se)                     {fCloseSE = se;}
75    virtual void        SetProductionMode(Int_t mode=1)                   {fProductionMode = mode;}
76    virtual void        SetRunPrefix(const char *prefix)                  {fRunPrefix = prefix;}
77    virtual void        SetOutputSingleFolder(const char *folder)         {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}
78    virtual void        SetFastReadOption(Bool_t on=kTRUE)                {fFastReadOption = on ? 1 : 0;}
79    virtual void        SetOverwriteMode(Bool_t on=kTRUE)                 {fOverwriteMode = on ? 1 : 0;}
80
81    TGridJDL           *GetGridJDL() const {return fGridJDL;}
82    TGridJDL           *GetMergingJDL() const {return fMergingJDL;}
83    const char         *GetGridOutputDir() const                          {return fGridOutputDir;}
84 //Utilities
85    Bool_t              CheckFileCopy(const char *alienpath);
86    virtual Bool_t      CreateDataset(const char *pattern);
87    virtual Bool_t      CreateJDL();
88    virtual void        EnablePackage(const char *package);
89    static Bool_t       DirectoryExists(const char *lfn);
90    static Bool_t       FileExists(const char *lfn);
91    static const char  *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
92    static Bool_t       MergeOutput(const char *output, const char *basedir, Int_t nmaxmerge);
93    virtual Bool_t      MergeOutputs();
94    virtual void        Print(Option_t *option="") const;
95    virtual Bool_t      StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
96    static Bool_t       SetupPar(const char *package);
97    virtual Bool_t      Submit();
98    virtual Bool_t      SubmitMerging();
99    virtual void        WriteAnalysisFile();
100    virtual void        WriteAnalysisMacro();
101    virtual void        WriteMergingMacro();
102    virtual void        WriteMergeExecutable();
103    virtual void        WriteExecutable();
104    virtual Bool_t      WriteJDL(Bool_t copy);
105    virtual void        WriteProductionFile(const char *filename) const;
106    virtual void        WriteValidationScript(Bool_t merge=kFALSE);
107
108 protected:
109    void                CdWork();
110    Bool_t              CheckInputData();
111    void                CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
112    virtual Bool_t      Connect();
113    virtual void        SetDefaults();  
114    Bool_t              SubmitNext();
115
116    Bool_t              IsCollection(const char *lfn) const;
117    virtual Bool_t      IsSingleOutput() const;
118    Bool_t              IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
119
120 private:
121    TGridJDL        *fGridJDL;         //! JDL maker
122    TGridJDL        *fMergingJDL;      //! JDL maker
123    Int_t            fPrice;           // Grid price for the job;
124    Int_t            fTTL;             // Time to live.
125    Int_t            fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
126    Int_t            fMaxInitFailed;   // Maximum initial consecutive subjobs accepted to fail
127    Int_t            fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
128    Int_t            fNtestFiles;      // Number of files used in the testing case
129    Int_t            fRunRange[2];     // Run range
130    Int_t            fNrunsPerMaster;  // Number of runs per masterjob
131    Int_t            fMaxMergeFiles;   // Maximum number of files to be merged in one chunk
132    Int_t            fNsubmitted;      // Number of jobs submitted
133    Int_t            fProductionMode;  // Production mode (0-off, 1-on)
134    Int_t            fOutputToRunNo;   // Use run number as output directory
135    Int_t            fMergeViaJDL;     // Enable merging via automatic JDL
136    Int_t            fFastReadOption;  // Use xrootd tweaks to reduce timeouts in file access
137    Int_t            fOverwriteMode;   // Overwrite existing files if any
138    TString          fRunNumbers;      // List of runs to be processed
139    TString          fExecutable;      // Executable script for AliEn job
140    TString          fExecutableCommand;  // Command(s) to be executed in the executable script
141    TString          fArguments;       // Arguments for the executable script
142    TString          fExecutableArgs;  // arguments added to the executable script after the analysis macro
143    TString          fAnalysisMacro;   // Root macro steering the analysis
144    TString          fAnalysisSource;  // User analysis implementation (.cxx) file(s)
145    TString          fAdditionalRootLibs;  // List (separated by blacs) of additional libraries needed for/before analysis libs/par file compilation
146    TString          fAdditionalLibs;  // List (separated by blacs) of additional libraries needed for the analysis loaded AFTER all par files
147    TString          fSplitMode;       // Job split mode
148    TString          fAPIVersion;      // API version
149    TString          fROOTVersion;     // ROOT version
150    TString          fAliROOTVersion;  // AliROOT version
151    TString          fExternalPackages; // External packages
152    TString          fUser;            // AliEn user name
153    TString          fGridWorkingDir;  // AliEn directory containing the input packages
154    TString          fGridDataDir;     // AliEn data production directory
155    TString          fDataPattern;     // Data pattern for 'find' command
156    TString          fGridOutputDir;   // AliEn directory (wrt work dir) where the output should be written
157    TString          fOutputArchive;   // List of output archives separated by blancs
158    TString          fOutputFiles;     // List of output files separated by blancs
159    TString          fInputFormat;     // Input format (xml-single)
160    TString          fDatasetName;     // Dataset xml file to be created
161    TString          fJDLName;         // JDL file to be generated
162    TString          fMergeExcludes;   // List of output files excluded from merging
163    TString          fIncludePath;     // Include path
164    TString          fCloseSE;         // Preffered storage element. Taken from alien_CLOSE_SE environment.
165    TString          fFriendChainName; // File name to construct friend chain (for AOD)
166    TString          fJobTag;          // Job tag
167    TString          fOutputSingle;    // Directory name for the output when split is per file
168    TString          fRunPrefix;       // Run prefix to be applied to run numbers
169    TObjArray       *fInputFiles;      // List of input files to be processed by the job
170    TObjArray       *fPackages;        // List of packages to be used
171    
172    ClassDef(AliAnalysisAlien, 12)   // Class providing some AliEn utilities
173 };
174 #endif