[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisAlien.h

#ifndef ALIANALYSISALIEN_H
#define ALIANALYSISALIEN_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

// Author: Mihaela Gheata, 01/09/2008

//==============================================================================
//   AliAnalysisAlien - AliEn utility class. Provides interface for creating
// a personalized JDL, finding and creating a dataset.
//==============================================================================

#ifndef ALIANALYSISGRID_H
#include "AliAnalysisGrid.h"
#endif

#ifndef ROOT_TString
#include <TString.h>
#endif

class TGridJDL;

class AliAnalysisAlien : public AliAnalysisGrid {

public:

   AliAnalysisAlien();
   AliAnalysisAlien(const char *name);
   virtual ~AliAnalysisAlien();
   AliAnalysisAlien(const AliAnalysisAlien& other); 
   AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
// Setters   
   virtual void        AddIncludePath(const char *path);
   virtual void        AddRunNumber(Int_t run);
   virtual void        AddRunNumber(const char *run);
   virtual void        AddDataFile(const char *lfn);
   virtual void        AddExternalPackage(const char *name);
   virtual void        SetExecutable(const char *name="analysis.sh")     {fExecutable = name;}
   virtual void        SetExecutableCommand(const char *command="root -b -q") {fExecutableCommand = command;}
   virtual void        SetArguments(const char *name="")                 {fArguments = name;}
   virtual void        SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
   virtual void        SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
   virtual void        SetAdditionalLibs(const char *list)               {fAdditionalLibs = list;}
   virtual void        SetPrice(Int_t price=1)                           {fPrice = price;}
   virtual void        SetRunRange(Int_t min, Int_t max)                 {fRunRange[0] = min; fRunRange[1] = max;}
   virtual void        SetJobTag(const char *tag="")                     {fJobTag = tag;}
   virtual void        SetNrunsPerMaster(Int_t nruns=1)                  {fNrunsPerMaster = nruns;}
   virtual void        SetMaxMergeFiles(Int_t nfiles)                    {fMaxMergeFiles = nfiles;}
   virtual void        SetSplitMode(const char *type="se")               {fSplitMode = type;}
   virtual void        SetSplitMaxInputFileNumber(Int_t nfiles=100)      {fSplitMaxInputFileNumber = nfiles;}
   virtual void        SetAPIVersion(const char *version="V2.4") {fAPIVersion = version;}
   virtual void        SetROOTVersion(const char *version="v5-21-01-alice") {fROOTVersion = version;}
   virtual void        SetAliROOTVersion(const char *version="v4-14-Rev-02") {fAliROOTVersion=version;}
   virtual void        SetUser(const char *user)                         {fUser = user;}
   virtual void        SetTTL(Int_t ttl=30000)                           {fTTL = ttl;}
   virtual void        SetGridWorkingDir(const char *name="workdir")     {fGridWorkingDir = name;}
   virtual void        SetGridDataDir(const char *name)                  {fGridDataDir = name;}
   virtual void        SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
   virtual void        SetFriendChainName(const char *name="")           {fFriendChainName = name;}
   virtual void        SetDefaultOutputs(Bool_t flag);
   virtual void        SetGridOutputDir(const char *name="output")       {fGridOutputDir = name;}
   virtual void        SetOutputArchive(const char *list="log_archive.zip:stdout,stderr root_archive.zip:*.root") {fOutputArchive = list;}
   virtual void        SetOutputFiles(const char *list)                  {fOutputFiles = list;}
   virtual void        SetInputFormat(const char *format="xml-single")   {fInputFormat = format;}
   virtual void        SetMaxInitFailed(Int_t nfail=5)                   {fMaxInitFailed = nfail;}
   virtual void        SetMergeExcludes(const char *list)                {fMergeExcludes = list;};
   virtual void        SetMasterResubmitThreshold(Int_t percentage)      {fMasterResubmitThreshold = percentage;}
   virtual void        SetNtestFiles(Int_t nfiles)                       {fNtestFiles = nfiles;}
   virtual void        SetJDLName(const char *name="analysis.jdl")       {fJDLName = name;}
   virtual void        SetPreferedSE(const char *se)                     {fCloseSE = se;}
   virtual void        SetProductionMode(Int_t mode=1)                   {fProductionMode = mode;}
   virtual void        SetOutputSingleFolder(const char *folder)         {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}

   TGridJDL           *GetGridJDL() {return fGridJDL;}
   const char         *GetGridOutputDir() const                          {return fGridOutputDir;}
//Utilities
   virtual Bool_t      CreateDataset(const char *pattern);
   virtual Bool_t      CreateJDL();
   virtual void        EnablePackage(const char *package);
   static Bool_t       DirectoryExists(const char *lfn);
   static Bool_t       FileExists(const char *lfn);
   static  const char *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
   virtual Bool_t      MergeOutputs();
   virtual void        Print(Option_t *option="") const;
   virtual Bool_t      StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
   virtual void        Submit();
   virtual void        WriteAnalysisFile();
   virtual void        WriteAnalysisMacro();
   virtual void        WriteExecutable();
   virtual Bool_t      WriteJDL(Bool_t copy);
   virtual void        WriteProductionFile(const char *filename) const;
   virtual void        WriteValidationScript();

protected:
   void                CdWork();
   Bool_t              CheckInputData();
   void                CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
   virtual Bool_t      Connect();
   virtual void        SetDefaults();  
   void                SubmitNext();

   Bool_t              IsCollection(const char *lfn) const;
   Bool_t              IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}

private:
   TGridJDL        *fGridJDL;         //! JDL maker
   Int_t            fPrice;           // Grid price for the job;
   Int_t            fTTL;             // Time to live.
   Int_t            fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
   Int_t            fMaxInitFailed;   // Maximum initial consecutive subjobs accepted to fail
   Int_t            fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
   Int_t            fNtestFiles;      // Number of files used in the testing case
   Int_t            fRunRange[2];     // Run range
   Int_t            fNrunsPerMaster;  // Number of runs per masterjob
   Int_t            fMaxMergeFiles;   // Maximum number of files to be merged in one chunk
   Int_t            fNsubmitted;      // Number of jobs submitted
   Int_t            fProductionMode;  // Production mode (0-off, 1-on)
   TString          fRunNumbers;      // List of runs to be processed
   TString          fExecutable;      // Executable script for AliEn job
   TString          fExecutableCommand;  // Command(s) to be executed in the executable script
   TString          fArguments;       // Arguments for the executable script
   TString          fAnalysisMacro;   // Root macro steering the analysis
   TString          fAnalysisSource;  // User analysis implementation (.cxx) file(s)
   TString          fAdditionalLibs;  // List (separated by blacs) of additional libraries needed for the analysis
   TString          fSplitMode;       // Job split mode
   TString          fAPIVersion;      // API version
   TString          fROOTVersion;     // ROOT version
   TString          fAliROOTVersion;  // AliROOT version
   TString          fExternalPackages; // External packages
   TString          fUser;            // AliEn user name
   TString          fGridWorkingDir;  // AliEn directory containing the input packages
   TString          fGridDataDir;     // AliEn data production directory
   TString          fDataPattern;     // Data pattern for 'find' command
   TString          fGridOutputDir;   // AliEn directory (wrt work dir) where the output should be written
   TString          fOutputArchive;   // List of output archives separated by blancs
   TString          fOutputFiles;     // List of output files separated by blancs
   TString          fInputFormat;     // Input format (xml-single)
   TString          fDatasetName;     // Dataset xml file to be created
   TString          fJDLName;         // JDL file to be generated
   TString          fMergeExcludes;   // List of output files excluded from merging
   TString          fIncludePath;     // Include path
   TString          fCloseSE;         // Preffered storage element. Taken from alien_CLOSE_SE environment.
   TString          fFriendChainName; // File name to construct friend chain (for AOD)
   TString          fJobTag;          // Job tag
   TString          fOutputSingle;    // Directory name for the output when split is per file
   TObjArray       *fInputFiles;      // List of input files to be processed by the job
   TObjArray       *fPackages;        // List of packages to be used
   
   ClassDef(AliAnalysisAlien, 8)   // Class providing some AliEn utilities
};
#endif
Commit	Line	Data
c57f56b7	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	class TGridJDL;
	22
	23	class AliAnalysisAlien : public AliAnalysisGrid {
	24
	25	public:
	26
	27	AliAnalysisAlien();
	28	AliAnalysisAlien(const char *name);
	29	virtual ~AliAnalysisAlien();
	30	AliAnalysisAlien(const AliAnalysisAlien& other);
	31	AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
	32	// Setters
f965131e	33	virtual void AddIncludePath(const char *path);
c57f56b7	34	virtual void AddRunNumber(Int_t run);
ee75cfc3	35	virtual void AddRunNumber(const char *run);
c57f56b7	36	virtual void AddDataFile(const char *lfn);
648174cf	37	virtual void AddExternalPackage(const char *name);
c57f56b7	38	virtual void SetExecutable(const char *name="analysis.sh") {fExecutable = name;}
0a1c1f7f	39	virtual void SetExecutableCommand(const char *command="root -b -q") {fExecutableCommand = command;}
c57f56b7	40	virtual void SetArguments(const char *name="") {fArguments = name;}
	41	virtual void SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
	42	virtual void SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
	43	virtual void SetAdditionalLibs(const char *list) {fAdditionalLibs = list;}
	44	virtual void SetPrice(Int_t price=1) {fPrice = price;}
a8739e8a	45	virtual void SetRunRange(Int_t min, Int_t max) {fRunRange[0] = min; fRunRange[1] = max;}
c6cb3634	46	virtual void SetJobTag(const char *tag="") {fJobTag = tag;}
319593fb	47	virtual void SetNrunsPerMaster(Int_t nruns=1) {fNrunsPerMaster = nruns;}
16a4353c	48	virtual void SetMaxMergeFiles(Int_t nfiles) {fMaxMergeFiles = nfiles;}
c57f56b7	49	virtual void SetSplitMode(const char *type="se") {fSplitMode = type;}
	50	virtual void SetSplitMaxInputFileNumber(Int_t nfiles=100) {fSplitMaxInputFileNumber = nfiles;}
	51	virtual void SetAPIVersion(const char *version="V2.4") {fAPIVersion = version;}
	52	virtual void SetROOTVersion(const char *version="v5-21-01-alice") {fROOTVersion = version;}
	53	virtual void SetAliROOTVersion(const char *version="v4-14-Rev-02") {fAliROOTVersion=version;}
	54	virtual void SetUser(const char *user) {fUser = user;}
	55	virtual void SetTTL(Int_t ttl=30000) {fTTL = ttl;}
	56	virtual void SetGridWorkingDir(const char *name="workdir") {fGridWorkingDir = name;}
	57	virtual void SetGridDataDir(const char *name) {fGridDataDir = name;}
	58	virtual void SetDataPattern(const char pattern="AliESDs.root") {fDataPattern = pattern;}
0df6ccf2	59	virtual void SetFriendChainName(const char *name="") {fFriendChainName = name;}
bb885a9e	60	virtual void SetDefaultOutputs(Bool_t flag);
c57f56b7	61	virtual void SetGridOutputDir(const char *name="output") {fGridOutputDir = name;}
	62	virtual void SetOutputArchive(const char list="log_archive.zip:stdout,stderr root_archive.zip:.root") {fOutputArchive = list;}
	63	virtual void SetOutputFiles(const char *list) {fOutputFiles = list;}
	64	virtual void SetInputFormat(const char *format="xml-single") {fInputFormat = format;}
	65	virtual void SetMaxInitFailed(Int_t nfail=5) {fMaxInitFailed = nfail;}
bb885a9e	66	virtual void SetMergeExcludes(const char *list) {fMergeExcludes = list;};
c57f56b7	67	virtual void SetMasterResubmitThreshold(Int_t percentage) {fMasterResubmitThreshold = percentage;}
bb885a9e	68	virtual void SetNtestFiles(Int_t nfiles) {fNtestFiles = nfiles;}
c57f56b7	69	virtual void SetJDLName(const char *name="analysis.jdl") {fJDLName = name;}
43da816a	70	virtual void SetPreferedSE(const char *se) {fCloseSE = se;}
a3e84053	71	virtual void SetProductionMode(Int_t mode=1) {fProductionMode = mode;}
648174cf	72	virtual void SetOutputSingleFolder(const char *folder) {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}
c57f56b7	73
c57f56b7	74	TGridJDL *GetGridJDL() {return fGridJDL;}
5513444a	75	const char *GetGridOutputDir() const {return fGridOutputDir;}
c57f56b7	76	//Utilities
	77	virtual Bool_t CreateDataset(const char *pattern);
	78	virtual Bool_t CreateJDL();
4e5c5506	79	virtual void EnablePackage(const char *package);
923e2ca5	80	static Bool_t DirectoryExists(const char *lfn);
5513444a	81	static Bool_t FileExists(const char *lfn);
d2a409b2	82	static const char *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
c57f56b7	83	virtual Bool_t MergeOutputs();
16a4353c	84	virtual void Print(Option_t *option="") const;
5513444a	85	virtual Bool_t StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
d2a409b2	86	virtual void Submit();
c57f56b7	87	virtual void WriteAnalysisFile();
	88	virtual void WriteAnalysisMacro();
	89	virtual void WriteExecutable();
5513444a	90	virtual Bool_t WriteJDL(Bool_t copy);
5513444a	91	virtual void WriteProductionFile(const char *filename) const;
c57f56b7	92	virtual void WriteValidationScript();
	93
	94	protected:
	95	void CdWork();
	96	Bool_t CheckInputData();
	97	void CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
	98	virtual Bool_t Connect();
	99	virtual void SetDefaults();
d2a409b2	100	void SubmitNext();
c57f56b7	101
c57f56b7	102	Bool_t IsCollection(const char *lfn) const;
	103	Bool_t IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
	104
	105	private:
	106	TGridJDL *fGridJDL; //! JDL maker
	107	Int_t fPrice; // Grid price for the job;
	108	Int_t fTTL; // Time to live.
	109	Int_t fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
	110	Int_t fMaxInitFailed; // Maximum initial consecutive subjobs accepted to fail
	111	Int_t fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
bb885a9e	112	Int_t fNtestFiles; // Number of files used in the testing case
a8739e8a	113	Int_t fRunRange[2]; // Run range
319593fb	114	Int_t fNrunsPerMaster; // Number of runs per masterjob
16a4353c	115	Int_t fMaxMergeFiles; // Maximum number of files to be merged in one chunk
d2a409b2	116	Int_t fNsubmitted; // Number of jobs submitted
a3e84053	117	Int_t fProductionMode; // Production mode (0-off, 1-on)
c57f56b7	118	TString fRunNumbers; // List of runs to be processed
c57f56b7	119	TString fExecutable; // Executable script for AliEn job
0a1c1f7f	120	TString fExecutableCommand; // Command(s) to be executed in the executable script
c57f56b7	121	TString fArguments; // Arguments for the executable script
	122	TString fAnalysisMacro; // Root macro steering the analysis
	123	TString fAnalysisSource; // User analysis implementation (.cxx) file(s)
	124	TString fAdditionalLibs; // List (separated by blacs) of additional libraries needed for the analysis
	125	TString fSplitMode; // Job split mode
	126	TString fAPIVersion; // API version
	127	TString fROOTVersion; // ROOT version
	128	TString fAliROOTVersion; // AliROOT version
648174cf	129	TString fExternalPackages; // External packages
c57f56b7	130	TString fUser; // AliEn user name
	131	TString fGridWorkingDir; // AliEn directory containing the input packages
	132	TString fGridDataDir; // AliEn data production directory
	133	TString fDataPattern; // Data pattern for 'find' command
	134	TString fGridOutputDir; // AliEn directory (wrt work dir) where the output should be written
	135	TString fOutputArchive; // List of output archives separated by blancs
	136	TString fOutputFiles; // List of output files separated by blancs
	137	TString fInputFormat; // Input format (xml-single)
	138	TString fDatasetName; // Dataset xml file to be created
	139	TString fJDLName; // JDL file to be generated
bb885a9e	140	TString fMergeExcludes; // List of output files excluded from merging
f965131e	141	TString fIncludePath; // Include path
bb885a9e	142	TString fCloseSE; // Preffered storage element. Taken from alien_CLOSE_SE environment.
0df6ccf2	143	TString fFriendChainName; // File name to construct friend chain (for AOD)
c6cb3634	144	TString fJobTag; // Job tag
648174cf	145	TString fOutputSingle; // Directory name for the output when split is per file
c57f56b7	146	TObjArray *fInputFiles; // List of input files to be processed by the job
4e5c5506	147	TObjArray *fPackages; // List of packages to be used
c57f56b7	148
648174cf	149	ClassDef(AliAnalysisAlien, 8) // Class providing some AliEn utilities
c57f56b7	150	};
c57f56b7	151	#endif