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 */
6 // Author: Mihaela Gheata, 01/09/2008
8 //==============================================================================
9 // AliAnalysisAlien - AliEn utility class. Provides interface for creating
10 // a personalized JDL, finding and creating a dataset.
11 //==============================================================================
13 #ifndef ALIANALYSISGRID_H
14 #include "AliAnalysisGrid.h"
27 class AliAnalysisAlien : public AliAnalysisGrid {
32 AliAnalysisAlien(const char *name);
33 virtual ~AliAnalysisAlien();
34 AliAnalysisAlien(const AliAnalysisAlien& other);
35 AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
37 virtual void AddIncludePath(const char *path);
38 virtual void AddRunNumber(Int_t run);
39 virtual void AddRunNumber(const char *run);
40 virtual void AddDataFile(const char *lfn);
41 virtual void AddExternalPackage(const char *name);
42 virtual void SetExecutable(const char *name="analysis.sh") {fExecutable = name;}
43 virtual void SetExecutableCommand(const char *command="root -b -q") {fExecutableCommand = command;}
44 virtual void SetArguments(const char *name="") {fArguments = name;}
45 virtual void SetExecutableArgs(const char *name="") {fExecutableArgs = name;}
46 virtual void SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
47 virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
48 virtual void SetAdditionalLibs(const char *list) {fAdditionalLibs = list;}
49 virtual void SetAdditionalRootLibs(const char *list) {fAdditionalRootLibs = list;}
50 virtual void SetPrice(Int_t price=1) {fPrice = price;}
51 virtual void SetRunRange(Int_t min, Int_t max) {fRunRange[0] = min; fRunRange[1] = max;}
52 virtual void SetJobTag(const char *tag="") {fJobTag = tag;}
53 virtual void SetNrunsPerMaster(Int_t nruns=1) {fNrunsPerMaster = nruns;}
54 virtual void SetMaxMergeFiles(Int_t nfiles) {fMaxMergeFiles = nfiles;}
55 virtual void SetSplitMode(const char *type="se") {fSplitMode = type;}
56 virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) {fSplitMaxInputFileNumber = nfiles;}
57 virtual void SetAPIVersion(const char *version) {fAPIVersion = version;}
58 virtual void SetROOTVersion(const char *version) {fROOTVersion = version;}
59 virtual void SetAliROOTVersion(const char *version) {fAliROOTVersion=version;}
60 virtual void SetUser(const char *user) {fUser = user;}
61 virtual void SetTTL(Int_t ttl=30000) {fTTL = ttl;}
62 virtual void SetGridWorkingDir(const char *name="workdir") {fGridWorkingDir = name;}
63 virtual void SetGridDataDir(const char *name) {fGridDataDir = name;}
64 virtual void SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
65 virtual void SetFriendChainName(const char *name="") {fFriendChainName = name;}
66 virtual void SetDefaultOutputs(Bool_t flag);
67 virtual void SetGridOutputDir(const char *name="output") {fGridOutputDir = name;}
68 virtual void SetOutputArchive(const char *list="log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2");
69 virtual void SetOutputFiles(const char *list);
70 virtual void SetOutputToRunNo(Int_t mode=1) {fOutputToRunNo = mode;}
71 virtual void SetInputFormat(const char *format="xml-single") {fInputFormat = format;}
72 virtual void SetMaxInitFailed(Int_t nfail=5) {fMaxInitFailed = nfail;}
73 virtual void SetMergeExcludes(const char *list) {fMergeExcludes = list;};
74 virtual void SetMergeViaJDL(Bool_t on=kTRUE) {fMergeViaJDL = on ? 1 : 0;}
75 virtual void SetMasterResubmitThreshold(Int_t percentage) {fMasterResubmitThreshold = percentage;}
76 virtual void SetNtestFiles(Int_t nfiles) {fNtestFiles = nfiles;}
77 virtual void SetNumberOfReplicas(Int_t ncopies) {fNreplicas = TMath::Min(ncopies,4);}
78 virtual void SetJDLName(const char *name="analysis.jdl") {fJDLName = name;}
79 virtual void SetPreferedSE(const char *se);
80 virtual void SetProductionMode(Int_t mode=1) {fProductionMode = mode;}
81 virtual void SetRunPrefix(const char *prefix) {fRunPrefix = prefix;}
82 virtual void SetOutputSingleFolder(const char *folder) {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}
83 virtual void SetFastReadOption(Bool_t on=kTRUE) {fFastReadOption = on ? 1 : 0;}
84 virtual void SetOverwriteMode(Bool_t on=kTRUE) {fOverwriteMode = on ? 1 : 0;}
86 TGridJDL *GetGridJDL() const {return fGridJDL;}
87 TGridJDL *GetMergingJDL() const {return fMergingJDL;}
88 const char *GetGridOutputDir() const {return fGridOutputDir;}
90 Bool_t CheckFileCopy(const char *alienpath);
91 virtual Bool_t CreateDataset(const char *pattern);
92 virtual Bool_t CreateJDL();
93 virtual void EnablePackage(const char *package);
94 static Bool_t DirectoryExists(const char *lfn);
95 static Bool_t FileExists(const char *lfn);
96 static const char *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
97 static Bool_t CheckMergedFiles(const char *filename, const char *aliendir, Int_t nperchunk, Bool_t submit=kTRUE, const char *jdl="");
98 static Bool_t MergeOutput(const char *output, const char *basedir, Int_t nmaxmerge, Int_t stage=0, Int_t ichunk=0);
99 virtual Bool_t MergeOutputs();
100 virtual void Print(Option_t *option="") const;
101 virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
102 static Bool_t SetupPar(const char *package);
103 virtual Bool_t Submit();
104 virtual Bool_t SubmitMerging();
105 static Int_t SubmitSingleJob(const char *query);
106 virtual void WriteAnalysisFile();
107 virtual void WriteAnalysisMacro();
108 virtual void WriteMergingMacro();
109 virtual void WriteMergeExecutable();
110 virtual void WriteExecutable();
111 virtual Bool_t WriteJDL(Bool_t copy);
112 virtual void WriteProductionFile(const char *filename) const;
113 virtual void WriteValidationScript(Bool_t merge=kFALSE);
116 virtual void SetProofCluster(const char *cluster) {fProofCluster = cluster;}
117 virtual void SetProofDataSet(const char *dataset) {fProofDataSet = dataset;}
118 virtual const char *GetProofDataSet() const {return fProofDataSet.Data();}
119 virtual void SetProofReset(Int_t mode) {fProofReset = mode;}
120 virtual void SetNproofWorkers(Int_t nworkers) {fNproofWorkers = nworkers;}
121 virtual void SetNproofWorkersPerSlave(Int_t nworkers) {fNproofWorkersPerSlave = nworkers;}
122 virtual void SetRootVersionForProof(const char *version) {fRootVersionForProof = version;}
123 virtual void SetAliRootMode(const char *mode) {fAliRootMode = mode;}
124 // .txt file containing the list of files to be chained in test mode
125 virtual void SetFileForTestMode(const char *filename) {fFileForTestMode = filename;}
126 virtual TChain *GetChainForTestMode(const char *treeName) const;
130 Bool_t CheckInputData();
131 void CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
132 virtual Bool_t Connect();
133 virtual void SetDefaults();
136 Bool_t IsCollection(const char *lfn) const;
137 virtual Bool_t IsSingleOutput() const;
138 Bool_t IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
141 TGridJDL *fGridJDL; //! JDL maker
142 TGridJDL *fMergingJDL; //! JDL maker
143 Int_t fPrice; // Grid price for the job;
144 Int_t fTTL; // Time to live.
145 Int_t fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
146 Int_t fMaxInitFailed; // Maximum initial consecutive subjobs accepted to fail
147 Int_t fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
148 Int_t fNtestFiles; // Number of files used in the testing case
149 Int_t fRunRange[2]; // Run range
150 Int_t fNrunsPerMaster; // Number of runs per masterjob
151 Int_t fMaxMergeFiles; // Maximum number of files to be merged in one chunk
152 Int_t fNsubmitted; // Number of jobs submitted
153 Int_t fProductionMode; // Production mode (0-off, 1-on)
154 Int_t fOutputToRunNo; // Use run number as output directory
155 Int_t fMergeViaJDL; // Enable merging via automatic JDL
156 Int_t fFastReadOption; // Use xrootd tweaks to reduce timeouts in file access
157 Int_t fOverwriteMode; // Overwrite existing files if any
158 Int_t fNreplicas; // Number of replicas for the output files
159 Int_t fNproofWorkers; // Number of workers in proof mode
160 Int_t fNproofWorkersPerSlave; // Max number of workers per slave in proof mode
161 Int_t fProofReset; // Proof reset mode: 0=no reset, 1=soft, 2=hard
162 TString fRunNumbers; // List of runs to be processed
163 TString fExecutable; // Executable script for AliEn job
164 TString fExecutableCommand; // Command(s) to be executed in the executable script
165 TString fArguments; // Arguments for the executable script
166 TString fExecutableArgs; // arguments added to the executable script after the analysis macro
167 TString fAnalysisMacro; // Root macro steering the analysis
168 TString fAnalysisSource; // User analysis implementation (.cxx) file(s)
169 TString fAdditionalRootLibs; // List (separated by blacs) of additional libraries needed for/before analysis libs/par file compilation
170 TString fAdditionalLibs; // List (separated by blacs) of additional libraries needed for the analysis loaded AFTER all par files
171 TString fSplitMode; // Job split mode
172 TString fAPIVersion; // API version
173 TString fROOTVersion; // ROOT version
174 TString fAliROOTVersion; // AliROOT version
175 TString fExternalPackages; // External packages
176 TString fUser; // AliEn user name
177 TString fGridWorkingDir; // AliEn directory containing the input packages
178 TString fGridDataDir; // AliEn data production directory
179 TString fDataPattern; // Data pattern for 'find' command
180 TString fGridOutputDir; // AliEn directory (wrt work dir) where the output should be written
181 TString fOutputArchive; // List of output archives separated by blancs
182 TString fOutputFiles; // List of output files separated by blancs
183 TString fInputFormat; // Input format (xml-single)
184 TString fDatasetName; // Dataset xml file to be created
185 TString fJDLName; // JDL file to be generated
186 TString fMergeExcludes; // List of output files excluded from merging
187 TString fIncludePath; // Include path
188 TString fCloseSE; // Preffered storage element. Taken from alien_CLOSE_SE environment.
189 TString fFriendChainName; // File name to construct friend chain (for AOD)
190 TString fJobTag; // Job tag
191 TString fOutputSingle; // Directory name for the output when split is per file
192 TString fRunPrefix; // Run prefix to be applied to run numbers
193 TString fProofCluster; // Proof cluster name
194 TString fProofDataSet; // Proof dataset to be used
195 TString fFileForTestMode; // .txt file for the chain to be used in PROOF test mode
196 TString fRootVersionForProof; // ROOT version to be used in PROOF mode. The default one taken if empty.
197 TString fAliRootMode; // AliRoot mode among the list supported by the proof cluster
198 TObjArray *fInputFiles; // List of input files to be processed by the job
199 TObjArray *fPackages; // List of packages to be used
201 ClassDef(AliAnalysisAlien, 14) // Class providing some AliEn utilities