1 #ifndef ALIANALYSISGRID_H
2 #define ALIANALYSISGRID_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 // AliAnalysisGrid - Base grid utility class. Provides interface for creating
10 // a personalized JDL, finding and creating a dataset.
11 //==============================================================================
19 class AliAnalysisGrid : public TNamed {
34 kDefaultOutputs = BIT(23)
37 kBitMask32 = 0xffffffff,
41 kClearPackages = BIT(3),
42 kUseSubmitPolicy = BIT(4),
43 kProofConnectGrid = BIT(5),
44 kOneStageMerging = BIT(6)
47 AliAnalysisGrid() : TNamed(), fSpecialBits(0) {}
48 AliAnalysisGrid(const char *name) : TNamed(name,""), fSpecialBits(0) {}
49 virtual ~AliAnalysisGrid() {}
50 AliAnalysisGrid(const AliAnalysisGrid& other);
51 AliAnalysisGrid& operator=(const AliAnalysisGrid& other);
53 virtual EPluginRunMode GetRunMode() const;
55 virtual void AddIncludePath(const char *path) = 0;
56 virtual void AddRunNumber(Int_t run) = 0;
57 virtual void AddRunNumber(const char *run) = 0;
58 virtual void AddDataFile(const char *lfn) = 0;
59 virtual Bool_t IsSingleOutput() const = 0;
60 virtual void SetExecutable(const char *name="analysis.sh") = 0;
61 virtual void SetArguments(const char *name="") = 0;
62 virtual void SetAnalysisMacro(const char *name="myAnalysis.C") = 0;
63 virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0;
64 virtual void SetValidationScript(const char *name="validation.sh") = 0;
65 virtual void SetAdditionalLibs(const char *list) = 0;
66 virtual void SetPrice(Int_t price=1) = 0;
67 virtual void SetJobTag(const char *tag="") = 0;
68 virtual void SetSplitMode(const char *type="se") = 0;
69 virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) = 0;
70 virtual void SetAPIVersion(const char *version) = 0;
71 virtual void SetROOTVersion(const char *version) = 0;
72 virtual void SetAliROOTVersion(const char *version) = 0;
73 virtual void SetUser(const char *user) = 0;
74 virtual void SetTTL(Int_t ttl=30000) = 0;
75 virtual void SetGridWorkingDir(const char *name="workdir") = 0;
76 virtual void SetGridDataDir(const char *name) = 0;
77 virtual void SetDataPattern(const char *pattern) = 0;
78 virtual void SetDefaultOutputs(Bool_t flag=kTRUE) = 0;
79 virtual void SetGridOutputDir(const char *name="output") = 0;
80 virtual void SetOutputArchive(const char *list="log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2") = 0;
81 virtual void SetOutputFiles(const char *list) = 0;
82 virtual void SetInputFormat(const char *format="xml-single") = 0;
83 virtual void SetMaxInitFailed(Int_t nfail=5) = 0;
84 virtual void SetTerminateFiles(const char *list) = 0;
85 virtual void SetMergeExcludes(const char *list) = 0;
86 virtual void SetMergeViaJDL(Bool_t on=kTRUE) = 0;
87 virtual void SetMasterResubmitThreshold(Int_t percentage) = 0;
88 virtual void SetNtestFiles(Int_t nfiles) = 0;
89 virtual void SetJDLName(const char *name="analysis.jdl") = 0;
90 virtual void SetPreferedSE(const char *se) = 0;
91 virtual void SetProductionMode(Int_t mode=1) = 0;
92 virtual void SetRunPrefix(const char *prefix) = 0;
93 virtual void SetOutputSingleFolder(const char *folder) = 0;
94 virtual void SetFastReadOption(Bool_t on=kTRUE) = 0;
95 virtual void SetOverwriteMode(Bool_t on=kTRUE) = 0;
97 // Set run mode. Can be "full", "test", "offline", "submit" or "merge"
98 virtual void SetRunMode(const char *mode="full");
100 static Bool_t CreateToken(const char *username=0);
101 virtual Bool_t CreateDataset(const char *pattern) = 0;
102 virtual Bool_t CreateJDL() = 0;
103 virtual void EnablePackage(const char *package) = 0;
104 virtual Bool_t MergeOutputs() = 0;
105 virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0;
106 virtual void WriteAnalysisFile() = 0;
107 virtual void WriteAnalysisMacro() = 0;
108 virtual void WriteExecutable() = 0;
109 virtual void WriteValidationScript(Bool_t merge=kFALSE) = 0;
112 Bool_t IsUseCopy() const {return TestSpecialBit(kUseCopy);}
113 void SetUseCopy(Bool_t flag=kTRUE) {SetSpecialBit(kUseCopy,flag);}
114 Bool_t IsCheckCopy() const {return TestSpecialBit(kCheckCopy);}
115 void SetCheckCopy(Bool_t flag=kTRUE) {SetSpecialBit(kCheckCopy,flag);}
116 Bool_t IsKeepLogs() const {return TestSpecialBit(kKeepLogs);}
117 void SetKeepLogs(Bool_t flag=kTRUE) {SetSpecialBit(kKeepLogs,flag);}
118 Bool_t IsUseSubmitPolicy() const {return TestSpecialBit(kUseSubmitPolicy);}
119 void SetUseSubmitPolicy(Bool_t flag=kTRUE) {SetSpecialBit(kUseSubmitPolicy,flag);}
120 Bool_t IsOneStageMerging() const {return TestSpecialBit(kOneStageMerging);}
121 void SetOneStageMerging(Bool_t flag) {SetSpecialBit(kOneStageMerging,flag);}
124 virtual void SetProofCluster(const char *cluster) = 0;
125 virtual void SetProofDataSet(const char *dataset) = 0;
126 virtual const char *GetProofDataSet() const = 0;
127 virtual void SetProofReset(Int_t mode) = 0;
128 virtual void SetClearPackages(Bool_t flag=kTRUE) {SetSpecialBit(kClearPackages,flag);}
129 virtual void SetProofConnectGrid(Bool_t flag=kTRUE) {SetSpecialBit(kProofConnectGrid,flag);}
130 virtual void SetNproofWorkers(Int_t nworkers) = 0;
131 virtual void SetNproofWorkersPerSlave(Int_t nworkers) = 0;
132 virtual void SetRootVersionForProof(const char *version) = 0;
133 virtual void SetAliRootMode(const char *mode) = 0;
134 // .txt file containing the list of files to be chained in test mode
135 virtual void SetFileForTestMode(const char *filename) = 0;
136 virtual TChain *GetChainForTestMode(const char *treeName) const = 0;
140 virtual Bool_t Connect() = 0;
141 virtual void SetDefaults() = 0;
142 void SetSpecialBit(UInt_t f) { fSpecialBits |= f & kBitMask32; }
143 void ResetSpecialBit(UInt_t f) { fSpecialBits &= ~(f & kBitMask32); }
144 void SetSpecialBit(UInt_t f, Bool_t set) {(set)?SetSpecialBit(f):ResetSpecialBit(f);}
145 Bool_t TestSpecialBit(UInt_t f) const { return (Bool_t) ((fSpecialBits & f) != 0); }
146 Int_t TestSpecialBits(UInt_t f) const { return (Int_t) (fSpecialBits & f); }
147 void InvertSpecialBit(UInt_t f) { fSpecialBits ^= f & kBitMask32; }
150 UInt_t fSpecialBits; // special bits
153 ClassDef(AliAnalysisGrid, 2) // Base class for GRID utilities