ANALYSIS/AliAnalysisAlien.h

   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
  25 #ifndef ROOT_TMap
  26 #include <TMap.h>
  27 #endif
  28
  29 class AliAnalysisManager;
  30 class AliAnalysisTaskCfg;
  31 class TGridJDL;
  32
  33 class AliAnalysisAlien : public AliAnalysisGrid {
  34
  35 public:
  36
  37    AliAnalysisAlien();
  38    AliAnalysisAlien(const char *name);
  39    virtual ~AliAnalysisAlien();
  40    AliAnalysisAlien(const AliAnalysisAlien& other);
  41    AliAnalysisAlien& operator=(const AliAnalysisAlien& other);
  42 // Setters
  43    virtual void        AddAdditionalLibrary(const char *name);
  44    virtual void        AddIncludePath(const char *path);
  45    virtual void        AddRunNumber(Int_t run);
  46    virtual void        AddRunNumber(const char *run);
  47    virtual void        AddRunList(const char *runList);
  48    virtual void        AddDataFile(const char *lfn);
  49    virtual void        AddExternalPackage(const char *name);
  50    virtual void        SetExecutable(const char *name="analysis.sh")     {fExecutable = name;}
  51    const char         *GetExecutable() const                             {return fExecutable;}
  52    virtual void        SetExecutableCommand(const char *command="root -b -q") {fExecutableCommand = command;}
  53    const char         *GetExecutableCommand() const                      {return fExecutableCommand;}
  54    virtual void        SetArguments(const char *name="")                 {fArguments = name;}
  55    const char         *GetArguments() const                              {return fArguments;}
  56    virtual void        SetExecutableArgs(const char *name="")            {fExecutableArgs = name;}
  57    const char         *GetExecutableArgs() const                         {return fExecutableArgs;}
  58    virtual void        SetAnalysisMacro(const char *name="myAnalysis.C") {fAnalysisMacro = name;}
  59    const char         *GetAnalysisMacro() const                          {return fAnalysisMacro;}
  60    virtual void        SetAnalysisSource(const char *name="myAnalysisClass.cxx") {fAnalysisSource = name;}
  61    const char         *GetAnalysisSource() const                         {return fAnalysisSource;}
  62    virtual void        SetValidationScript(const char *name="validation.sh") {fValidationScript = name;}
  63    const char         *GetValidationScript() const                       {return fValidationScript;}
  64    virtual void        SetAdditionalLibs(const char *list)               {fAdditionalLibs = list;}
  65    const char         *GetAdditionalLibs() const                         {return fAdditionalLibs;}
  66    virtual void        SetAdditionalRootLibs(const char *list)           {fAdditionalRootLibs = list;}
  67    const char         *GetAdditionalRootLibs() const                     {return fAdditionalRootLibs;}
  68    virtual void        SetPrice(Int_t price=1)                           {fPrice = price;}
  69    Int_t               GetPrice() const                                  {return fPrice;}
  70    virtual void        SetRunRange(Int_t min, Int_t max)                 {fRunRange[0] = min; fRunRange[1] = max;}
  71    void                GetRunRange(Int_t &min, Int_t &max)               {min = fRunRange[0]; max = fRunRange[1];}
  72    virtual void        SetJobTag(const char *tag="")                     {fJobTag = tag;}
  73    const char         *GetJobTag() const                                 {return fJobTag;}
  74    virtual void        SetNrunsPerMaster(Int_t nruns=1)                  {fNrunsPerMaster = nruns;}
  75    Int_t               GetNrunsPerMaster() const                         {return fNrunsPerMaster;}
  76    virtual void        SetMaxMergeFiles(Int_t nfiles)                    {fMaxMergeFiles = nfiles;}
  77    Int_t               GetMaxMergeFiles()  const                         {return fMaxMergeFiles;}
  78    virtual void        SetMaxMergeStages(Int_t nstages)                  {fMaxMergeStages = nstages;}
  79    Int_t               GetMaxMergeStages() const                         {return fMaxMergeStages;}
  80    virtual void        SetSplitMode(const char *type="se")               {fSplitMode = type;}
  81    const char         *GetSplitMode() const                              {return fSplitMode;}
  82    virtual void        SetSplitMaxInputFileNumber(Int_t nfiles=100)      {fSplitMaxInputFileNumber = nfiles;}
  83    Int_t               GetSplitMaxInputFileNumber() const                {return fSplitMaxInputFileNumber;}
  84    virtual void        SetAPIVersion(const char *version)                {fAPIVersion = version;}
  85    const char         *GetAPIVersion() const                             {return fAPIVersion;}
  86    virtual void        SetROOTVersion(const char *version)               {fROOTVersion = version;}
  87    const char         *GetROOTVersion() const                            {return fROOTVersion;}
  88    virtual void        SetAliROOTVersion(const char *version)            {fAliROOTVersion=version;}
  89    const char         *GetAliROOTVersion() const                         {return fAliROOTVersion;}
  90    virtual void        SetUser(const char *user)                         {fUser = user;}
  91    const char         *GetUser() const                                   {return fUser;}
  92    virtual void        SetTTL(Int_t ttl=30000)                           {fTTL = ttl;}
  93    Int_t               GetTTL() const                                    {return fTTL;}
  94    virtual void        SetGridWorkingDir(const char *name="workdir")     {fGridWorkingDir = name;}
  95    const char         *GetGridWorkingDir() const                         {return fGridWorkingDir;}
  96    virtual void        SetGridDataDir(const char *name)                  {fGridDataDir = name;}
  97    const char         *GetGridDataDir() const                            {return fGridDataDir;}
  98    void                SetGeneratorLibs(const char *libs)                {fGeneratorLibs = libs;}
  99    const char         *GetGeneratorLibs() const                          {return fGeneratorLibs;}
 100    virtual void        SetDataPattern(const char *pattern="*AliESDs.root") {fDataPattern = pattern;}
 101    const char         *GetDataPattern() const                            {return fDataPattern;}
 102    virtual void        SetFriendChainName(const char *name="", const char *libnames="");
 103    const char         *GetFriendChainName() const                        {return fFriendChainName;}
 104    virtual void        SetDefaultOutputs(Bool_t flag);
 105    virtual void        SetGridOutputDir(const char *name="output")       {fGridOutputDir = name;}
 106    const char         *GetGridOutputDir() const                          {return fGridOutputDir;}
 107    virtual void        SetOutputArchive(const char *list="log_archive.zip:std*@disk=1 root_archive.zip:*.root@disk=2");
 108    const char         *GetOutputArchive() const                          {return fOutputArchive;}
 109    virtual void        SetOutputFiles(const char *list);
 110    const char         *GetOutputFiles() const                            {return fOutputFiles;}
 111    virtual void        SetOutputToRunNo(Int_t mode=1)                    {fOutputToRunNo = mode;}
 112    Int_t               GetOutputToRunNoMode() const                      {return fOutputToRunNo;}
 113    virtual void        SetInputFormat(const char *format="xml-single")   {fInputFormat = format;}
 114    const char         *GetInputFormat() const                            {return fInputFormat;}
 115    virtual void        SetMaxInitFailed(Int_t nfail=5)                   {fMaxInitFailed = nfail;}
 116    Int_t               GetMaxInitFailed() const                          {return fMaxInitFailed;}
 117    virtual void        SetTerminateFiles(const char *list)               {fTerminateFiles = list;}
 118    const char         *GetTerminateFiles() const                         {return fTerminateFiles;}
 119    virtual void        SetMergeExcludes(const char *list)                {fMergeExcludes = list; fMergeExcludes.ReplaceAll(",", " "); }
 120    const char         *GetMergeExcludes() const                          {return fMergeExcludes;}
 121    virtual void        SetMergeViaJDL(Bool_t on=kTRUE)                   {fMergeViaJDL = on ? 1 : 0;}
 122    Bool_t              IsMergeViaJDL() const                             {return fMergeViaJDL;}
 123    virtual void        SetMergeDirName(const char *name)                 {fMergeDirName = name;}
 124    const char         *GetMergeDirName() const                           {return fMergeDirName;}
 125    virtual void        SetMasterResubmitThreshold(Int_t percentage)      {fMasterResubmitThreshold = percentage;}
 126    Int_t               GetMasterResubmitThreshold() const                {return fMasterResubmitThreshold;}
 127    void                SetMCLoop(Bool_t flag=kTRUE)                      {fMCLoop = flag;}
 128    virtual void        SetNtestFiles(Int_t nfiles)                       {fNtestFiles = nfiles;}
 129    Int_t               GetNtestFiles() const                             {return fNtestFiles;}
 130    virtual void        SetNumberOfReplicas(Int_t ncopies)                {fNreplicas = TMath::Min(ncopies,4);}
 131    Int_t               GetNumberOfReplicas() const                       {return fNreplicas;}
 132    virtual void        SetJDLName(const char *name="analysis.jdl")       {fJDLName = name;}
 133    const char         *GetJDLName() const                                {return fJDLName;}
 134    virtual void        SetProductionMode(Int_t mode=1)                   {fProductionMode = mode;}
 135    Int_t               GetProductionMode() const                         {return fProductionMode;}
 136    virtual void        SetRegisterExcludes(const char *list)             {fRegisterExcludes = list; fRegisterExcludes.ReplaceAll(",", " "); }
 137    const char         *GetRegisterExcludes() const                       {return fRegisterExcludes;}
 138    virtual void        SetRunPrefix(const char *prefix);
 139    const char         *GetRunPrefix() const                              {return fRunPrefix;}
 140    virtual void        SetOutputSingleFolder(const char *folder)         {fOutputSingle = folder; fSplitMode="file"; fSplitMaxInputFileNumber=1;}
 141    const char         *GetOutputSingleFolder() const                     {return fOutputSingle;}
 142    virtual void        SetFastReadOption(Bool_t on=kTRUE)                {fFastReadOption = on ? 1 : 0;}
 143    Bool_t              IsFastReadOption() const                          {return fFastReadOption;}
 144    virtual void        SetOverwriteMode(Bool_t on=kTRUE)                 {fOverwriteMode = on ? 1 : 0;}
 145    Bool_t              IsOverwriteMode() const                           {return fOverwriteMode;}
 146    virtual void        SetDropToShell(Bool_t drop=true)                  {fDropToShell = drop;}
 147    Bool_t              IsDropToShell() const                             {return fDropToShell;}
 148    virtual void        SetTreeName(const char *name)                     {fTreeName = name;}
 149    const char         *GetTreeName() const                               {return fTreeName;}
 150
 151    TGridJDL           *GetGridJDL() const                                {return fGridJDL;}
 152    TGridJDL           *GetMergingJDL() const                             {return fMergingJDL;}
 153    Int_t               GetNMCevents() const                              {return fNMCevents;}
 154    Int_t               GetNMCjobs() const                                {return fNMCjobs;}
 155    void                SetNMCevents(Int_t nevents)                       {fNMCevents = nevents;}
 156    void                SetNMCjobs(Int_t njobs)                           {fNMCjobs = njobs;}
 157 //Utilities
 158    void                AddModule(AliAnalysisTaskCfg *module);
 159    void                AddModules(TObjArray *list);
 160    AliAnalysisManager *CreateAnalysisManager(const char *name, const char *filename="");
 161    Int_t               GetNmodules() const;
 162    AliAnalysisTaskCfg *GetModule(const char *name);
 163    Bool_t              LoadModules();
 164    Bool_t              LoadFriendLibs() const;
 165    Bool_t              GenerateTest(const char *name, const char *modname="");
 166    Bool_t              GenerateTrain(const char *name);
 167    virtual Bool_t      CreateDataset(const char *pattern);
 168    Int_t               CopyLocalDataset(const char *griddir, const char *pattern, Int_t nfiles, const char *output="data.txt", const char *archivefile="", const char *outputdir="data");
 169    virtual Bool_t      CreateJDL();
 170    virtual void        EnablePackage(const char *package);
 171    static Bool_t       DirectoryExists(const char *lfn);
 172    static Bool_t       FileExists(const char *lfn);
 173    static const char  *GetJobStatus(Int_t jobidstart, Int_t lastid, Int_t &nrunning, Int_t &nwaiting, Int_t &nerror, Int_t &ndone);
 174    const char         *GetListOfFiles(const char *type);
 175    Bool_t              CheckMergedFiles(const char *filename, const char *aliendir, Int_t nperchunk, const char *jdl="");
 176    static AliAnalysisManager *LoadAnalysisManager(const char *fname);
 177    static Bool_t       MergeInfo(const char *output, const char *collection);
 178    static Bool_t       MergeOutput(const char *output, const char *basedir, Int_t nmaxmerge, Int_t stage=0);
 179    virtual Bool_t      MergeOutputs();
 180    virtual void        Print(Option_t *option="") const;
 181    static Long64_t     RunMacroAndExtractLibs(const char* macro, const char *args, TString &libs);
 182    virtual Bool_t      StartAnalysis(Long64_t nentries=123456789, Long64_t firstentry=0);
 183    static Bool_t       SetupPar(const char *package);
 184    virtual Bool_t      Submit();
 185    virtual Bool_t      SubmitMerging();
 186    static Int_t        SubmitSingleJob(const char *query);
 187    virtual void        WriteAnalysisFile();
 188    virtual void        WriteAnalysisMacro();
 189    virtual void        WriteMergingMacro();
 190    virtual void        WriteMergeExecutable();
 191    virtual void        WriteExecutable();
 192    virtual Bool_t      WriteJDL(Bool_t copy);
 193    virtual void        WriteProductionFile(const char *filename) const;
 194    virtual void        WriteValidationScript(Bool_t merge=kFALSE);
 195
 196 // PROOF mode
 197    virtual void        SetProofCluster(const char *cluster)              {fProofCluster = cluster;}
 198    virtual void        SetProofDataSet(const char *dataset)              {fProofDataSet = dataset;}
 199    virtual const char *GetProofDataSet() const                           {return fProofDataSet;}
 200    virtual void        SetProofParameter(const char *pname, const char *value);
 201    const char         *GetProofParameter(const char *pname) const;
 202    virtual void        SetProofReset(Int_t mode)                         {fProofReset = mode;}
 203    virtual void        SetNproofWorkers(Int_t nworkers)                  {fNproofWorkers = nworkers;}
 204    virtual void        SetNproofWorkersPerSlave(Int_t nworkers)          {fNproofWorkersPerSlave = nworkers;}
 205    virtual void        SetRootVersionForProof(const char *version);
 206    virtual void        SetAliRootMode(const char *mode)                  {fAliRootMode = mode;}
 207    virtual void        SetProofProcessOpt(const char *proofOpt="")       {fProofProcessOpt = proofOpt;}
 208    virtual TString     GetProofProcessOpt()                              {return fProofProcessOpt;}
 209    // .txt file containing the list of files to be chained in test mode
 210    virtual void        SetFileForTestMode(const char *filename)          {fFileForTestMode = filename;}
 211    const char         *GetFileForTestMode() const                        {return fFileForTestMode;}
 212    virtual TChain     *GetChainForTestMode(const char *treeName) const;
 213    virtual const TString& GetGridJobIDs() const { return fGridJobIDs; }
 214    virtual const TString& GetGridStages() const { return fGridStages; }
 215 protected:
 216    void                CdWork();
 217    Bool_t              CheckInputData();
 218    void                CheckDataType(const char *lfn, Bool_t &is_collection, Bool_t &is_xml, Bool_t &use_tags);
 219    virtual Bool_t      Connect();
 220    virtual void        SetDefaults();
 221    Bool_t              SubmitNext();
 222
 223    Bool_t              IsCollection(const char *lfn) const;
 224    Bool_t              IsMCLoop() const {return fMCLoop;}
 225    virtual Bool_t      IsSingleOutput() const;
 226    Bool_t              IsUsingTags() const {return TObject::TestBit(AliAnalysisGrid::kUseTags);}
 227    Bool_t              LoadModule(AliAnalysisTaskCfg *mod);
 228    Bool_t              CheckDependencies();
 229    Bool_t              CheckFileCopy(const char *alienpath);
 230
 231 private:
 232    TGridJDL        *fGridJDL;         //! JDL maker
 233    TGridJDL        *fMergingJDL;      //! JDL maker
 234    Int_t            fPrice;           // Grid price for the job;
 235    Int_t            fTTL;             // Time to live.
 236    Int_t            fSplitMaxInputFileNumber; // Maximum number of files to be processed per subjob
 237    Int_t            fMaxInitFailed;   // Maximum initial consecutive subjobs accepted to fail
 238    Int_t            fMasterResubmitThreshold; // Failed jobs will be resubmitted until this DONE ratio
 239    Int_t            fNtestFiles;      // Number of files used in the testing case
 240    Int_t            fRunRange[2];     // Run range
 241    Int_t            fNrunsPerMaster;  // Number of runs per masterjob
 242    Int_t            fMaxMergeFiles;   // Maximum number of files to be merged in one chunk
 243    Int_t            fMaxMergeStages;  // Maximum number of merging stages
 244    Int_t            fNsubmitted;      // Number of jobs submitted
 245    Int_t            fProductionMode;  // Production mode (0-off, 1-on)
 246    Int_t            fOutputToRunNo;   // Use run number as output directory
 247    Int_t            fMergeViaJDL;     // Enable merging via automatic JDL
 248    Int_t            fFastReadOption;  // Use xrootd tweaks to reduce timeouts in file access
 249    Int_t            fOverwriteMode;   // Overwrite existing files if any
 250    Int_t            fNreplicas;       // Number of replicas for the output files
 251    Int_t            fNproofWorkers;   // Number of workers in proof mode
 252    Int_t            fNproofWorkersPerSlave; // Max number of workers per slave in proof mode
 253    Int_t            fProofReset;      // Proof reset mode: 0=no reset, 1=soft, 2=hard
 254    Int_t            fNMCevents;       // Number of MC events in MC loop mode
 255    Int_t            fNMCjobs;         // Number of MC jobs in MC loop mode
 256    TString          fRunNumbers;      // List of runs to be processed
 257    TString          fExecutable;      // Executable script for AliEn job
 258    TString          fExecutableCommand;  // Command(s) to be executed in the executable script
 259    TString          fArguments;       // Arguments for the executable script
 260    TString          fExecutableArgs;  // arguments added to the executable script after the analysis macro
 261    TString          fAnalysisMacro;   // Root macro steering the analysis
 262    TString          fAnalysisSource;  // User analysis implementation (.cxx) file(s)
 263    TString          fValidationScript; // Name of the validation script
 264    TString          fAdditionalRootLibs;  // List (separated by blacs) of additional libraries needed for/before analysis libs/par file compilation
 265    TString          fAdditionalLibs;  // List (separated by blacs) of additional libraries needed for the analysis loaded AFTER all par files
 266    TString          fGeneratorLibs;   // Extra libraries needed by the generator
 267    TString          fSplitMode;       // Job split mode
 268    TString          fAPIVersion;      // API version
 269    TString          fROOTVersion;     // ROOT version
 270    TString          fAliROOTVersion;  // AliROOT version
 271    TString          fExternalPackages; // External packages
 272    TString          fUser;            // AliEn user name
 273    TString          fGridWorkingDir;  // AliEn directory containing the input packages
 274    TString          fGridDataDir;     // AliEn data production directory
 275    TString          fDataPattern;     // Data pattern for 'find' command
 276    TString          fGridOutputDir;   // AliEn directory (wrt work dir) where the output should be written
 277    TString          fOutputArchive;   // List of output archives separated by blancs
 278    TString          fOutputFiles;     // List of output files separated by blancs
 279    TString          fInputFormat;     // Input format (xml-single)
 280    TString          fDatasetName;     // Dataset xml file to be created
 281    TString          fJDLName;         // JDL file to be generated
 282    TString          fTerminateFiles;  // List of output files produced during Terminate
 283    TString          fMergeExcludes;   // List of output files excluded from merging
 284    TString          fRegisterExcludes; // List of liles not to be registered/merged
 285    TString          fIncludePath;     // Include path
 286    TString          fCloseSE;         // Preffered storage element. Taken from alien_CLOSE_SE environment.
 287    TString          fFriendChainName; // File name to construct friend chain (for AOD)
 288    TString          fJobTag;          // Job tag
 289    TString          fOutputSingle;    // Directory name for the output when split is per file
 290    TString          fRunPrefix;       // Run prefix to be applied to run numbers
 291    TString          fProofCluster;    // Proof cluster name
 292    TString          fProofDataSet;    // Proof dataset to be used
 293    TString          fFileForTestMode; // .txt file for the chain to be used in PROOF test mode
 294    TString          fAliRootMode;     // AliRoot mode among the list supported by the proof cluster
 295    TString          fProofProcessOpt; // Option passed to proof process
 296    TString          fMergeDirName;    // Name of the directory that should be added to the output directory
 297    TObjArray       *fInputFiles;      // List of input files to be processed by the job
 298    TObjArray       *fPackages;        // List of packages to be used
 299    TObjArray       *fModules;         // List of AliAnalysisTaskCfg modules
 300    TMap             fProofParam;      // Key-value pairs for proof mode
 301    Bool_t           fDropToShell;     // If true, execute aliensh on start
 302    Bool_t           fMCLoop;          // MC loop flag
 303    TString          fGridJobIDs;      // List of last committed jobs
 304    TString          fGridStages;      // List of last committed jobs
 305    TString          fFriendLibs;      // List of libs (separated by blacs) needed for friends processing
 306    TString          fTreeName;        // Name of the tree to be analyzed
 307
 308    ClassDef(AliAnalysisAlien, 26)   // Class providing some AliEn utilities
 309 };
 310 #endif