]>
Commit | Line | Data |
---|---|---|
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 */ | |
5 | ||
6 | // Author: Mihaela Gheata, 01/09/2008 | |
7 | ||
8 | //============================================================================== | |
9 | // AliAnalysisGrid - Base grid utility class. Provides interface for creating | |
10 | // a personalized JDL, finding and creating a dataset. | |
11 | //============================================================================== | |
12 | ||
13 | #ifndef ROOT_TNamed | |
14 | #include <TNamed.h> | |
15 | #endif | |
16 | ||
17 | class TChain; | |
18 | ||
19 | class AliAnalysisGrid : public TNamed { | |
20 | ||
21 | public: | |
22 | ||
23 | enum EPluginRunMode { | |
24 | kFull = 0, | |
25 | kTest = BIT(14), | |
26 | kOffline = BIT(15), | |
27 | kSubmit = BIT(16), | |
28 | kMerge = BIT(17), | |
29 | kUseTags = BIT(18), | |
30 | kUseESD = BIT(19), | |
31 | kUseAOD = BIT(20), | |
32 | kUseMC = BIT(21), | |
33 | kUsePars = BIT(22), | |
34 | kDefaultOutputs = BIT(23) | |
35 | }; | |
36 | enum EPluginBits { | |
37 | kBitMask32 = 0xffffffff, | |
38 | kUseCopy = BIT(0), | |
39 | kCheckCopy = BIT(1), | |
40 | kKeepLogs = BIT(2), | |
41 | kClearPackages = BIT(3), | |
42 | kUseSubmitPolicy = BIT(4), | |
43 | kProofConnectGrid = BIT(5), | |
44 | kOneStageMerging = BIT(6), | |
45 | kUseMCchain = BIT(7) | |
46 | }; | |
47 | ||
48 | AliAnalysisGrid() : TNamed(), fSpecialBits(0) {} | |
49 | AliAnalysisGrid(const char *name) : TNamed(name,""), fSpecialBits(0) {} | |
50 | virtual ~AliAnalysisGrid() {} | |
51 | AliAnalysisGrid(const AliAnalysisGrid& other); | |
52 | AliAnalysisGrid& operator=(const AliAnalysisGrid& other); | |
53 | // Getters | |
54 | virtual EPluginRunMode GetRunMode() const; | |
55 | // Setters | |
56 | virtual void AddIncludePath(const char *path) = 0; | |
57 | virtual void AddRunNumber(Int_t run) = 0; | |
58 | virtual void AddRunNumber(const char *run) = 0; | |
59 | virtual void AddDataFile(const char *lfn) = 0; | |
60 | virtual Bool_t IsSingleOutput() const = 0; | |
61 | virtual void SetExecutable(const char *name="analysis.sh") = 0; | |
62 | virtual void SetArguments(const char *name="") = 0; | |
63 | virtual void SetAnalysisMacro(const char *name="myAnalysis.C") = 0; | |
64 | virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") = 0; | |
65 | virtual void SetValidationScript(const char *name="validation.sh") = 0; | |
66 | virtual void SetAdditionalLibs(const char *list) = 0; | |
67 | virtual void SetPrice(Int_t price=1) = 0; | |
68 | virtual void SetJobTag(const char *tag="") = 0; | |
69 | virtual void SetSplitMode(const char *type="se") = 0; | |
70 | virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) = 0; | |
71 | virtual void SetAPIVersion(const char *version) = 0; | |
72 | virtual void SetROOTVersion(const char *version) = 0; | |
73 | virtual void SetAliROOTVersion(const char *version) = 0; | |
74 | virtual void SetUser(const char *user) = 0; | |
75 | virtual void SetTTL(Int_t ttl=30000) = 0; | |
76 | virtual void SetGridWorkingDir(const char *name="workdir") = 0; | |
77 | virtual void SetGridDataDir(const char *name) = 0; | |
78 | virtual void SetDataPattern(const char *pattern) = 0; | |
79 | virtual void SetDefaultOutputs(Bool_t flag=kTRUE) = 0; | |
80 | virtual void SetGridOutputDir(const char *name="output") = 0; | |
81 | virtual void SetOutputArchive(const char *list="log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2") = 0; | |
82 | virtual void SetOutputFiles(const char *list) = 0; | |
83 | virtual void SetInputFormat(const char *format="xml-single") = 0; | |
84 | virtual void SetMaxInitFailed(Int_t nfail=5) = 0; | |
85 | virtual void SetTerminateFiles(const char *list) = 0; | |
86 | virtual void SetMergeExcludes(const char *list) = 0; | |
87 | virtual void SetMergeViaJDL(Bool_t on=kTRUE) = 0; | |
88 | virtual void SetMasterResubmitThreshold(Int_t percentage) = 0; | |
89 | virtual void SetNtestFiles(Int_t nfiles) = 0; | |
90 | virtual void SetJDLName(const char *name="analysis.jdl") = 0; | |
91 | virtual void SetPreferedSE(const char *se) = 0; | |
92 | virtual void SetProductionMode(Int_t mode=1) = 0; | |
93 | virtual void SetRunPrefix(const char *prefix) = 0; | |
94 | virtual void SetOutputSingleFolder(const char *folder) = 0; | |
95 | virtual void SetFastReadOption(Bool_t on=kTRUE) = 0; | |
96 | virtual void SetOverwriteMode(Bool_t on=kTRUE) = 0; | |
97 | ||
98 | // Set run mode. Can be "full", "test", "offline", "submit" or "merge" | |
99 | virtual void SetRunMode(const char *mode="full"); | |
100 | //Utilities | |
101 | static Bool_t CreateToken(const char *username=0); | |
102 | virtual Bool_t CreateDataset(const char *pattern) = 0; | |
103 | virtual Bool_t CreateJDL() = 0; | |
104 | virtual void EnablePackage(const char *package) = 0; | |
105 | virtual Bool_t MergeOutputs() = 0; | |
106 | virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0) = 0; | |
107 | virtual void WriteAnalysisFile() = 0; | |
108 | virtual void WriteAnalysisMacro() = 0; | |
109 | virtual void WriteExecutable() = 0; | |
110 | virtual void WriteValidationScript(Bool_t merge=kFALSE) = 0; | |
111 | ||
112 | // Flags | |
113 | Bool_t IsUseCopy() const {return TestSpecialBit(kUseCopy);} | |
114 | void SetUseCopy(Bool_t flag=kTRUE) {SetSpecialBit(kUseCopy,flag);} | |
115 | Bool_t IsCheckCopy() const {return TestSpecialBit(kCheckCopy);} | |
116 | void SetCheckCopy(Bool_t flag=kTRUE) {SetSpecialBit(kCheckCopy,flag);} | |
117 | Bool_t IsKeepLogs() const {return TestSpecialBit(kKeepLogs);} | |
118 | void SetKeepLogs(Bool_t flag=kTRUE) {SetSpecialBit(kKeepLogs,flag);} | |
119 | Bool_t IsUseSubmitPolicy() const {return TestSpecialBit(kUseSubmitPolicy);} | |
120 | void SetUseSubmitPolicy(Bool_t flag=kTRUE) {SetSpecialBit(kUseSubmitPolicy,flag);} | |
121 | Bool_t IsOneStageMerging() const {return TestSpecialBit(kOneStageMerging);} | |
122 | void SetOneStageMerging(Bool_t flag) {SetSpecialBit(kOneStageMerging,flag);} | |
123 | Bool_t IsUseMCchain() const {return TestSpecialBit(kUseMCchain);} | |
124 | void SetUseMCchain(Bool_t flag=kTRUE) {SetSpecialBit(kUseMCchain,flag);} | |
125 | ||
126 | // PROOF mode | |
127 | virtual void SetProofCluster(const char *cluster) = 0; | |
128 | virtual void SetProofDataSet(const char *dataset) = 0; | |
129 | virtual const char *GetProofDataSet() const = 0; | |
130 | virtual void SetProofReset(Int_t mode) = 0; | |
131 | virtual void SetClearPackages(Bool_t flag=kTRUE) {SetSpecialBit(kClearPackages,flag);} | |
132 | virtual void SetProofConnectGrid(Bool_t flag=kTRUE) {SetSpecialBit(kProofConnectGrid,flag);} | |
133 | virtual void SetNproofWorkers(Int_t nworkers) = 0; | |
134 | virtual void SetNproofWorkersPerSlave(Int_t nworkers) = 0; | |
135 | virtual void SetRootVersionForProof(const char *version) = 0; | |
136 | virtual void SetAliRootMode(const char *mode) = 0; | |
137 | // .txt file containing the list of files to be chained in test mode | |
138 | virtual void SetFileForTestMode(const char *filename) = 0; | |
139 | virtual TChain *GetChainForTestMode(const char *treeName) const = 0; | |
140 | ||
141 | protected: | |
142 | // Methods | |
143 | virtual Bool_t Connect() = 0; | |
144 | virtual void SetDefaults() = 0; | |
145 | void SetSpecialBit(UInt_t f) { fSpecialBits |= f & kBitMask32; } | |
146 | void ResetSpecialBit(UInt_t f) { fSpecialBits &= ~(f & kBitMask32); } | |
147 | void SetSpecialBit(UInt_t f, Bool_t set) {(set)?SetSpecialBit(f):ResetSpecialBit(f);} | |
148 | Bool_t TestSpecialBit(UInt_t f) const { return (Bool_t) ((fSpecialBits & f) != 0); } | |
149 | Int_t TestSpecialBits(UInt_t f) const { return (Int_t) (fSpecialBits & f); } | |
150 | void InvertSpecialBit(UInt_t f) { fSpecialBits ^= f & kBitMask32; } | |
151 | ||
152 | protected: | |
153 | UInt_t fSpecialBits; // special bits | |
154 | ||
155 | ||
156 | ClassDef(AliAnalysisGrid, 2) // Base class for GRID utilities | |
157 | }; | |
158 | #endif |