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
  54         virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
  55                         Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
  56         virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
  57         virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
  58         virtual const char* GetFile(Int_t system, const char* detector,
  59                 const char* id, const char* source);
  60         virtual TList* GetFileSources(Int_t system, const char* detector, const char* id = 0);
  61         virtual TList* GetFileIDs(Int_t system, const char* detector, const char* source);
  62         virtual const char* GetRunParameter(const char* lbEntry);
  63         virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
  64         virtual const char* GetRunType();
  65         virtual Bool_t GetHLTStatus();
  66         virtual void Log(const char* detector, const char* message);
  67
  68         void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
  69
  70         void SetTestMode(TestMode testMode) { fTestMode = testMode; }
  71         void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
  72
  73         Bool_t Connect(Int_t system);
  74
  75         static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
  76         static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
  77
  78         static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
  79         static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
  80
  81         static void SetShuttleTempDir (const char* tmpDir);
  82         static void SetShuttleLogDir (const char* logDir);
  83
  84 private:
  85         AliShuttle(const AliShuttle& other);
  86         AliShuttle& operator= (const AliShuttle& other);
  87
  88         Bool_t ProcessCurrentDetector();
  89
  90         AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
  91         Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
  92         Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
  93
  94         Bool_t GetValueSet(const char* host, Int_t port, const char* alias,
  95                                 TObjArray* result, DCSType type);
  96         TMap* GetValueSet(const char* host, Int_t port, const TSeqCollection* entries,
  97                               DCSType type);
  98
  99         Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
 100
 101         Bool_t UpdateTable();
 102         Bool_t UpdateTableFailCase();
 103
 104         Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
 105                                 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
 106
 107         Bool_t StoreOCDB();
 108         Bool_t StoreOCDB(const TString& uri);
 109         Bool_t StoreRefFilesToGrid();
 110         void CleanLocalStorage(const TString& uri);
 111         Bool_t CleanReferenceStorage(const char* detector);
 112         void RemoveFile(const char* filename);
 113         const char* GetRefFilePrefix(const char* base, const char* detector);
 114
 115         AliShuttleStatus* ReadShuttleStatus();
 116         Bool_t WriteShuttleStatus(AliShuttleStatus* status);
 117         Bool_t ContinueProcessing();
 118         void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
 119         Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
 120         Bool_t SendMail();
 121
 122         TString GetLogFileName(const char* detector) const;
 123
 124         void SetLastAction(const char* action);
 125
 126         void SendMLInfo();
 127
 128         const AliShuttleConfig* fConfig;        // pointer to configuration object
 129
 130         UInt_t fTimeout;        // DCS server connection timeout parameter
 131         Int_t fRetries;         // Number of DCS server connection retries
 132
 133         TMap fPreprocessorMap;  // list of detector Preprocessors ("DET", "Preprocessor")
 134
 135         AliShuttleLogbookEntry* fLogbookEntry;   //! current Shuttle logbook entry
 136         TString fCurrentDetector; // current detector
 137
 138         TSQLServer *fServer[4];         // pointer to the three FXS + Run & Shuttle logbook servers
 139         Bool_t fFXSCalled[3];           // FXS call status
 140         TList  fFXSlist[3];             // List of files retrieved from each FXS
 141
 142         AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
 143
 144         TMutex* fMonitoringMutex;   // mutex to lock the monitoring class members
 145         UInt_t fLastActionTime;    // time of last action for monitoring
 146         TString fLastAction;       // string description for last action
 147
 148         Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors];       // array of flags for first unprocessed dets
 149
 150         TMonaLisaWriter* fMonaLisa;  // ML instance that sends the processing information
 151
 152         TestMode fTestMode;          // sets test mode flags, that e.g. simulate a dcs error etc.
 153         Bool_t fReadTestMode;        // Reads the test mode from the log entry of the given run (only for test)
 154
 155         Bool_t fOutputRedirected;    // is the output redirected to a file
 156
 157         ClassDef(AliShuttle, 0);
 158 };
 159
 160 #endif