SHUTTLE/AliShuttle.h

   1 #ifndef ALI_SHUTTLE_H
   2 #define ALI_SHUTTLE_H
   3
   4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   5  * See cxx source for full Copyright notice                               */
   6
   7 /* $Id$ */
   8
   9
  10 //
  11 // This class is the main manager for
  12 // AliShuttle. It organizes the data retrieval
  13 // from DCS and call the interface methods of
  14 // AliPreprocessor.
  15 //
  16
  17 #include <TMap.h>
  18 #include <TString.h>
  19 #include <TList.h>
  20
  21 #include "AliShuttleInterface.h"
  22 #include "AliShuttleStatus.h"
  23
  24 class TObject;
  25 class AliShuttleConfig;
  26 class AliShuttleLogbookEntry;
  27 class AliPreprocessor;
  28 class TSQLServer;
  29 class TMutex;
  30 class TMonaLisaWriter;
  31
  32 class AliShuttle: public AliShuttleInterface {
  33 public:
  34         enum DCSType {kAlias=0, kDP};
  35         enum TestMode { kNone = 0, kSkipDCS = 1, kErrorDCS = 2, kErrorFXSSources = 4, kErrorFXSFiles = 8, kErrorOCDB = 16, kErrorStorage = 32, kErrorGrid = 64 };
  36
  37         AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
  38         virtual ~AliShuttle();
  39
  40         virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
  41
  42         Bool_t Collect(Int_t run = -1);
  43
  44         Bool_t Process(AliShuttleLogbookEntry* entry);
  45
  46         // monitoring functions
  47         ULong_t GetTimeOfLastAction() const;
  48         const TString GetLastAction() const;
  49
  50         Int_t GetCurrentRun() const;
  51         UInt_t GetCurrentStartTime() const;
  52         UInt_t GetCurrentEndTime() const;
  53         UInt_t GetCurrentYear() const;
  54
  55         const char* GetLHCPeriod() const;
  56
  57         virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
  58                         Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
  59         virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
  60         virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
  61         virtual Bool_t StoreRunMetadataFile(const char* localFile, const char* gridFileName);
  62         virtual const char* GetFile(Int_t system, const char* detector,
  63                 const char* id, const char* source);
  64         virtual TList* GetFileSources(Int_t system, const char* detector, const char* id = 0);
  65         virtual TList* GetFileIDs(Int_t system, const char* detector, const char* source);
  66         virtual const char* GetRunParameter(const char* lbEntry);
  67         virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
  68         virtual const char* GetRunType();
  69         virtual Bool_t GetHLTStatus();
  70         virtual void Log(const char* detector, const char* message);
  71
  72         void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
  73
  74         void SetTestMode(TestMode testMode) { fTestMode = testMode; }
  75         void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
  76
  77         Bool_t Connect(Int_t system);
  78
  79         static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
  80         static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
  81
  82         static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
  83         static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
  84
  85         static void SetShuttleTempDir (const char* tmpDir);
  86         static void SetShuttleLogDir (const char* logDir);
  87
  88 private:
  89         AliShuttle(const AliShuttle& other);
  90         AliShuttle& operator= (const AliShuttle& other);
  91
  92         Bool_t ProcessCurrentDetector();
  93
  94         AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
  95         Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
  96         void CountOpenRuns();
  97         Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
  98
  99         TMap* GetValueSet(const char* host, Int_t port, const TSeqCollection* entries,
 100                               DCSType type, Int_t valueSet);
 101
 102         Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
 103
 104         Bool_t UpdateTable();
 105         Bool_t UpdateTableFailCase();
 106
 107         Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
 108                                 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
 109
 110         Bool_t StoreOCDB();
 111         Bool_t StoreOCDB(const TString& uri);
 112         Bool_t CopyFileLocally(const char* localFile, const TString& target);
 113         Bool_t CopyFilesToGrid(const char* type);
 114         void CleanLocalStorage(const TString& uri);
 115         Bool_t CleanReferenceStorage(const char* detector);
 116         void RemoveFile(const char* filename);
 117         const char* GetRefFilePrefix(const char* base, const char* detector);
 118
 119         AliShuttleStatus* ReadShuttleStatus();
 120         Bool_t WriteShuttleStatus(AliShuttleStatus* status);
 121         Bool_t ContinueProcessing();
 122         void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
 123         Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
 124         Bool_t SendMail();
 125         Bool_t SendMailToDCS();
 126
 127         TString GetLogFileName(const char* detector) const;
 128
 129         void SetLastAction(const char* action);
 130
 131         void SendAlive();
 132         void SendMLInfo();
 133
 134         const AliShuttleConfig* fConfig;        // pointer to configuration object
 135
 136         UInt_t fTimeout;        // DCS server connection timeout parameter
 137         Int_t fRetries;         // Number of DCS server connection retries
 138
 139         TMap fPreprocessorMap;  // list of detector Preprocessors ("DET", "Preprocessor")
 140
 141         AliShuttleLogbookEntry* fLogbookEntry;   //! current Shuttle logbook entry
 142         TString fCurrentDetector; // current detector
 143
 144         TSQLServer *fServer[4];         // pointer to the three FXS + Run & Shuttle logbook servers
 145         Bool_t fFXSCalled[3];           // FXS call status
 146         TList  fFXSlist[3];             // List of files retrieved from each FXS
 147
 148         AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
 149
 150         TMutex* fMonitoringMutex;   // mutex to lock the monitoring class members
 151         UInt_t fLastActionTime;    // time of last action for monitoring
 152         TString fLastAction;       // string description for last action
 153
 154         Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors];       // array of flags for first unprocessed dets
 155
 156         TMonaLisaWriter* fMonaLisa;  // ML instance that sends the processing information
 157
 158         TestMode fTestMode;          // sets test mode flags, that e.g. simulate a dcs error etc.
 159         Bool_t fReadTestMode;        // Reads the test mode from the log entry of the given run (only for test)
 160
 161         Bool_t fOutputRedirected;    // is the output redirected to a file
 162
 163         ClassDef(AliShuttle, 0);
 164 };
 165
 166 #endif