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         enum EMailTarget { kDCSEMail = 0, kFXSEMail, kPPEMail };
  37
  38         AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
  39         virtual ~AliShuttle();
  40
  41         virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
  42
  43         Bool_t Collect(Int_t run = -1);
  44
  45         Bool_t Process(AliShuttleLogbookEntry* entry);
  46
  47         // monitoring functions
  48         ULong_t GetTimeOfLastAction() const;
  49         const TString GetLastAction() const;
  50
  51         Int_t GetCurrentRun() const;
  52         UInt_t GetCurrentStartTime() const;
  53         UInt_t GetCurrentEndTime() const;
  54         UInt_t GetCurrentTimeCreated() const;
  55         UInt_t GetCurrentYear() const;
  56
  57         const char* GetLHCPeriod() const;
  58
  59         virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
  60                         Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
  61         virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
  62         virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
  63         virtual Bool_t StoreRunMetadataFile(const char* localFile, const char* gridFileName);
  64         virtual const char* GetFile(Int_t system, const char* detector,
  65                 const char* id, const char* source);
  66         virtual TList* GetFileSources(Int_t system, const char* detector, const char* id = 0);
  67         virtual TList* GetFileIDs(Int_t system, const char* detector, const char* source);
  68         virtual const char* GetRunParameter(const char* lbEntry);
  69         virtual const UInt_t GetStartTimeDCSQuery();
  70         virtual const UInt_t GetEndTimeDCSQuery();
  71         virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
  72         virtual const char* GetRunType();
  73         virtual Bool_t GetHLTStatus();
  74         virtual const char* GetTriggerConfiguration();
  75         virtual void Log(const char* detector, const char* message);
  76
  77         void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
  78
  79         void SetTestMode(TestMode testMode) { fTestMode = testMode; }
  80         void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
  81
  82         Bool_t Connect(Int_t system);
  83
  84         static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
  85         static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
  86
  87         static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
  88         static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
  89
  90         static void SetShuttleTempDir (const char* tmpDir);
  91         static void SetShuttleLogDir (const char* logDir);
  92
  93 private:
  94         AliShuttle(const AliShuttle& other);
  95         AliShuttle& operator= (const AliShuttle& other);
  96
  97         Int_t ProcessCurrentDetector();
  98
  99         AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
 100         Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
 101         void CountOpenRuns();
 102         Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
 103
 104         TMap* GetValueSet(const char* host, Int_t port, const TSeqCollection* entries,
 105                               DCSType type, Int_t valueSet);
 106
 107         Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
 108
 109         Bool_t UpdateTable();
 110         Bool_t UpdateTableSkippedCase(const char* detector="ALL");
 111         Bool_t UpdateTableFailCase();
 112
 113         Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
 114                                 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
 115
 116         Bool_t StoreOCDB();
 117         Int_t StoreOCDB(const TString& uri);
 118         Bool_t CopyFileLocally(const char* localFile, const TString& target);
 119         Bool_t CopyFilesToGrid(const char* type);
 120         void CleanLocalStorage(const TString& uri);
 121         Bool_t CleanReferenceStorage(const char* detector);
 122         void RemoveFile(const char* filename);
 123         const char* GetRefFilePrefix(const char* base, const char* detector);
 124
 125         AliShuttleStatus* ReadShuttleStatus();
 126         Bool_t WriteShuttleStatus(AliShuttleStatus* status);
 127         Bool_t ContinueProcessing();
 128         void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
 129         Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
 130         Bool_t SendMail(EMailTarget target, Int_t system = -1);
 131         Int_t GetMem(Int_t pid);
 132
 133         TString GetLogFileName(const char* detector) const;
 134
 135         void SetLastAction(const char* action);
 136
 137         void SendAlive();
 138         void SendMLDetInfo();
 139         void SendMLRunInfo(const char* status);
 140         virtual Bool_t TouchFile();
 141
 142         const AliShuttleConfig* fConfig;        // pointer to configuration object
 143
 144         UInt_t fTimeout;        // DCS server connection timeout parameter
 145         Int_t fRetries;         // Number of DCS server connection retries
 146
 147         TMap fPreprocessorMap;  // list of detector Preprocessors ("DET", "Preprocessor")
 148
 149         AliShuttleLogbookEntry* fLogbookEntry;   //! current Shuttle logbook entry
 150         TString fCurrentDetector; // current detector
 151         Bool_t fFirstProcessing;  // processing this detector the first time in this run
 152
 153         TSQLServer *fServer[4];         // pointer to the three FXS + Run & Shuttle logbook servers
 154         Bool_t fFXSCalled[3];           // FXS call status
 155         TList  fFXSlist[3];             // List of files retrieved from each FXS
 156         Int_t  fFXSError;               // Variable to keep track of any FXS errors; contains -1 for no error, kDAQ, kDCS, kHLT otherwise
 157
 158         AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
 159
 160         TMutex* fMonitoringMutex;   // mutex to lock the monitoring class members
 161         UInt_t fLastActionTime;    // time of last action for monitoring
 162         TString fLastAction;       // string description for last action
 163
 164         Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors];       // array of flags for first unprocessed dets
 165
 166         TMonaLisaWriter* fMonaLisa;  // ML instance that sends the processing information
 167
 168         TestMode fTestMode;          // sets test mode flags, that e.g. simulate a dcs error etc.
 169         Bool_t fReadTestMode;        // Reads the test mode from the log entry of the given run (only for test)
 170
 171         Bool_t fOutputRedirected;    // is the output redirected to a file
 172
 173         ClassDef(AliShuttle, 0);
 174 };
 175
 176 #endif