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