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