]> git.uio.no Git - u/mrichter/AliRoot.git/blame_incremental - ANALYSIS/AliAnalysisAlien.h
reverting revision 46127, better solution required
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisAlien.h
... / ...
CommitLineData
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
25class TGridJDL;
26
27class AliAnalysisAlien : public AliAnalysisGrid {
28
29public:
30
31 AliAnalysisAlien();
32 AliAnalysisAlien(const char *name);
33 virtual ~AliAnalysisAlien();
34 AliAnalysisAlien(const AliAnalysisAlien& other);
35 AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
36// Setters
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 SetMasterResubmitThreshold(Int_t percentage) {fMasterResubmitThreshold = percentage;}
79 virtual void SetNtestFiles(Int_t nfiles) {fNtestFiles = nfiles;}
80 virtual void SetNumberOfReplicas(Int_t ncopies) {fNreplicas = TMath::Min(ncopies,4);}
81 virtual void SetJDLName(const char *name="analysis.jdl") {fJDLName = name;}
82 virtual void SetPreferedSE(const char *se);
83 virtual void SetProductionMode(Int_t mode=1) {fProductionMode = mode;}
84 virtual void SetRunPrefix(const char *prefix);
85 virtual void SetOutputSingleFolder(const char *folder) {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}
86 virtual void SetFastReadOption(Bool_t on=kTRUE) {fFastReadOption = on ? 1 : 0;}
87 virtual void SetOverwriteMode(Bool_t on=kTRUE) {fOverwriteMode = on ? 1 : 0;}
88
89 TGridJDL *GetGridJDL() const {return fGridJDL;}
90 TGridJDL *GetMergingJDL() const {return fMergingJDL;}
91 const char *GetGridOutputDir() const {return fGridOutputDir;}
92//Utilities
93 Bool_t CheckFileCopy(const char *alienpath);
94 virtual Bool_t CreateDataset(const char *pattern);
95 virtual Bool_t CreateJDL();
96 virtual void EnablePackage(const char *package);
97 static Bool_t DirectoryExists(const char *lfn);
98 static Bool_t FileExists(const char *lfn);
99 static const char *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
100 const char *GetListOfFiles(const char *type);
101 Bool_t CheckMergedFiles(const char *filename, const char *aliendir, Int_t nperchunk, const char *jdl="");
102 static Bool_t MergeOutput(const char *output, const char *basedir, Int_t nmaxmerge, Int_t stage=0);
103 virtual Bool_t MergeOutputs();
104 virtual void Print(Option_t *option="") const;
105 virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
106 static Bool_t SetupPar(const char *package);
107 virtual Bool_t Submit();
108 virtual Bool_t SubmitMerging();
109 static Int_t SubmitSingleJob(const char *query);
110 virtual void WriteAnalysisFile();
111 virtual void WriteAnalysisMacro();
112 virtual void WriteMergingMacro();
113 virtual void WriteMergeExecutable();
114 virtual void WriteExecutable();
115 virtual Bool_t WriteJDL(Bool_t copy);
116 virtual void WriteProductionFile(const char *filename) const;
117 virtual void WriteValidationScript(Bool_t merge=kFALSE);
118
119// PROOF mode
120 virtual void SetProofCluster(const char *cluster) {fProofCluster = cluster;}
121 virtual void SetProofDataSet(const char *dataset) {fProofDataSet = dataset;}
122 virtual const char *GetProofDataSet() const {return fProofDataSet.Data();}
123 virtual void SetProofReset(Int_t mode) {fProofReset = mode;}
124 virtual void SetNproofWorkers(Int_t nworkers) {fNproofWorkers = nworkers;}
125 virtual void SetNproofWorkersPerSlave(Int_t nworkers) {fNproofWorkersPerSlave = nworkers;}
126 virtual void SetRootVersionForProof(const char *version) {fRootVersionForProof = version;}
127 virtual void SetAliRootMode(const char *mode) {fAliRootMode = mode;}
128 // .txt file containing the list of files to be chained in test mode
129 virtual void SetFileForTestMode(const char *filename) {fFileForTestMode = filename;}
130 virtual TChain *GetChainForTestMode(const char *treeName) const;
131
132protected:
133 void CdWork();
134 Bool_t CheckInputData();
135 void CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
136 virtual Bool_t Connect();
137 virtual void SetDefaults();
138 Bool_t SubmitNext();
139
140 Bool_t IsCollection(const char *lfn) const;
141 virtual Bool_t IsSingleOutput() const;
142 Bool_t IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
143
144private:
145 TGridJDL *fGridJDL; //! JDL maker
146 TGridJDL *fMergingJDL; //! JDL maker
147 Int_t fPrice; // Grid price for the job;
148 Int_t fTTL; // Time to live.
149 Int_t fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
150 Int_t fMaxInitFailed; // Maximum initial consecutive subjobs accepted to fail
151 Int_t fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
152 Int_t fNtestFiles; // Number of files used in the testing case
153 Int_t fRunRange[2]; // Run range
154 Int_t fNrunsPerMaster; // Number of runs per masterjob
155 Int_t fMaxMergeFiles; // Maximum number of files to be merged in one chunk
156 Int_t fMaxMergeStages; // Maximum number of merging stages
157 Int_t fNsubmitted; // Number of jobs submitted
158 Int_t fProductionMode; // Production mode (0-off, 1-on)
159 Int_t fOutputToRunNo; // Use run number as output directory
160 Int_t fMergeViaJDL; // Enable merging via automatic JDL
161 Int_t fFastReadOption; // Use xrootd tweaks to reduce timeouts in file access
162 Int_t fOverwriteMode; // Overwrite existing files if any
163 Int_t fNreplicas; // Number of replicas for the output files
164 Int_t fNproofWorkers; // Number of workers in proof mode
165 Int_t fNproofWorkersPerSlave; // Max number of workers per slave in proof mode
166 Int_t fProofReset; // Proof reset mode: 0=no reset, 1=soft, 2=hard
167 TString fRunNumbers; // List of runs to be processed
168 TString fExecutable; // Executable script for AliEn job
169 TString fExecutableCommand; // Command(s) to be executed in the executable script
170 TString fArguments; // Arguments for the executable script
171 TString fExecutableArgs; // arguments added to the executable script after the analysis macro
172 TString fAnalysisMacro; // Root macro steering the analysis
173 TString fAnalysisSource; // User analysis implementation (.cxx) file(s)
174 TString fValidationScript; // Name of the validation script
175 TString fAdditionalRootLibs; // List (separated by blacs) of additional libraries needed for/before analysis libs/par file compilation
176 TString fAdditionalLibs; // List (separated by blacs) of additional libraries needed for the analysis loaded AFTER all par files
177 TString fSplitMode; // Job split mode
178 TString fAPIVersion; // API version
179 TString fROOTVersion; // ROOT version
180 TString fAliROOTVersion; // AliROOT version
181 TString fExternalPackages; // External packages
182 TString fUser; // AliEn user name
183 TString fGridWorkingDir; // AliEn directory containing the input packages
184 TString fGridDataDir; // AliEn data production directory
185 TString fDataPattern; // Data pattern for 'find' command
186 TString fGridOutputDir; // AliEn directory (wrt work dir) where the output should be written
187 TString fOutputArchive; // List of output archives separated by blancs
188 TString fOutputFiles; // List of output files separated by blancs
189 TString fInputFormat; // Input format (xml-single)
190 TString fDatasetName; // Dataset xml file to be created
191 TString fJDLName; // JDL file to be generated
192 TString fTerminateFiles; // List of output files produced during Terminate
193 TString fMergeExcludes; // List of output files excluded from merging
194 TString fIncludePath; // Include path
195 TString fCloseSE; // Preffered storage element. Taken from alien_CLOSE_SE environment.
196 TString fFriendChainName; // File name to construct friend chain (for AOD)
197 TString fJobTag; // Job tag
198 TString fOutputSingle; // Directory name for the output when split is per file
199 TString fRunPrefix; // Run prefix to be applied to run numbers
200 TString fProofCluster; // Proof cluster name
201 TString fProofDataSet; // Proof dataset to be used
202 TString fFileForTestMode; // .txt file for the chain to be used in PROOF test mode
203 TString fRootVersionForProof; // ROOT version to be used in PROOF mode. The default one taken if empty.
204 TString fAliRootMode; // AliRoot mode among the list supported by the proof cluster
205 TObjArray *fInputFiles; // List of input files to be processed by the job
206 TObjArray *fPackages; // List of packages to be used
207
208 ClassDef(AliAnalysisAlien, 16) // Class providing some AliEn utilities
209};
210#endif