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