New module TRIGGER (Chiara, Annalisa)
[u/mrichter/AliRoot.git] / SHUTTLE / AliShuttle.h
CommitLineData
73abe331 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
a7160fe9 14// AliPreprocessor.
73abe331 15//
16
73abe331 17#include <TMap.h>
b948db8d 18#include <TString.h>
57f50b3c 19#include <TList.h>
b948db8d 20
21#include "AliShuttleInterface.h"
5164a766 22#include "AliShuttleStatus.h"
73abe331 23
58bc3020 24class TObject;
73abe331 25class AliShuttleConfig;
2bb7b766 26class AliShuttleLogbookEntry;
b948db8d 27class AliPreprocessor;
57f50b3c 28class TSQLServer;
cb343cfd 29class TMutex;
e7f62f16 30class TMonaLisaWriter;
73abe331 31
b948db8d 32class AliShuttle: public AliShuttleInterface {
73abe331 33public:
2c15234c 34 enum DCSType {kAlias=0, kDP};
9827400b 35 enum TestMode { kNone = 0, kSkipDCS = 1, kErrorDCS = 2, kErrorFXSSources = 4, kErrorFXSFiles = 8, kErrorOCDB = 16, kErrorStorage = 32, kErrorGrid = 64 };
339adafa 36 enum EMailTarget { kDCSEMail = 0, kFXSEMail, kPPEMail };
2c15234c 37
b948db8d 38 AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
73abe331 39 virtual ~AliShuttle();
40
b948db8d 41 virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
42
cb343cfd 43 Bool_t Collect(Int_t run = -1);
2bb7b766 44
45 Bool_t Process(AliShuttleLogbookEntry* entry);
73abe331 46
cb343cfd 47 // monitoring functions
48 ULong_t GetTimeOfLastAction() const;
49 const TString GetLastAction() const;
50
2bb7b766 51 Int_t GetCurrentRun() const;
52 UInt_t GetCurrentStartTime() const;
53 UInt_t GetCurrentEndTime() const;
675f64cd 54 UInt_t GetCurrentYear() const;
55
56 const char* GetLHCPeriod() const;
73abe331 57
3301427a 58 virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
84090f85 59 Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
3301427a 60 virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
9827400b 61 virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
c88ad5db 62 virtual Bool_t StoreRunMetadataFile(const char* localFile, const char* gridFileName);
b948db8d 63 virtual const char* GetFile(Int_t system, const char* detector,
64 const char* id, const char* source);
4a33bdd9 65 virtual TList* GetFileSources(Int_t system, const char* detector, const char* id = 0);
66 virtual TList* GetFileIDs(Int_t system, const char* detector, const char* source);
eba76848 67 virtual const char* GetRunParameter(const char* lbEntry);
f100adeb 68 virtual UInt_t GetStartTimeDCSQuery();
69 virtual UInt_t GetEndTimeDCSQuery();
9827400b 70 virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
71 virtual const char* GetRunType();
4859271b 72 virtual Bool_t GetHLTStatus();
ca8ea066 73 virtual const char* GetTriggerConfiguration();
b48d2542 74 virtual const char* GetTriggerDetectorMask();
b948db8d 75 virtual void Log(const char* detector, const char* message);
76
eba76848 77 void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
9827400b 78
79 void SetTestMode(TestMode testMode) { fTestMode = testMode; }
80 void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
57f50b3c 81
57f50b3c 82 Bool_t Connect(Int_t system);
83
d386d623 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
73abe331 93private:
57f50b3c 94 AliShuttle(const AliShuttle& other);
95 AliShuttle& operator= (const AliShuttle& other);
96
ffa25f20 97 Int_t ProcessCurrentDetector();
2bb7b766 98
eba76848 99 AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
2bb7b766 100 Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
fbc112e3 101 void CountOpenRuns();
2bb7b766 102 Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
103
a038aa70 104 TMap* GetValueSet(const char* host, Int_t port, const TSeqCollection* entries,
542b6cc8 105 DCSType type, Int_t valueSet);
57f50b3c 106
9d733021 107 Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
108
109 Bool_t UpdateTable();
bd23d48b 110 Bool_t UpdateTableSkippedCase(const char* detector="ALL");
3301427a 111 Bool_t UpdateTableFailCase();
57f50b3c 112
3301427a 113 Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
114 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
85a80aa9 115
3301427a 116 Bool_t StoreOCDB();
5e993b6f 117 Int_t StoreOCDB(const TString& uri);
d524ade6 118 Bool_t CopyFileLocally(const char* localFile, const TString& target);
c88ad5db 119 Bool_t CopyFilesToGrid(const char* type);
3301427a 120 void CleanLocalStorage(const TString& uri);
546242fb 121 Bool_t CleanReferenceStorage(const char* detector);
3301427a 122 void RemoveFile(const char* filename);
2d9019b4 123 const char* GetRefFilePrefix(const char* base, const char* detector);
2bb7b766 124
e7f62f16 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);
339adafa 130 Bool_t SendMail(EMailTarget target, Int_t system = -1);
ef83773f 131 Int_t GetMem(Int_t pid);
ffa29e93 132
133 TString GetLogFileName(const char* detector) const;
57c1a579 134
e7f62f16 135 void SetLastAction(const char* action);
136
ee6f7523 137 void SendAlive();
8e828d39 138 void SendMLDetInfo();
139 void SendMLRunInfo(const char* status);
503ff24f 140 virtual Bool_t TouchFile();
b948db8d 141
2bb7b766 142 const AliShuttleConfig* fConfig; // pointer to configuration object
73abe331 143
2bb7b766 144 UInt_t fTimeout; // DCS server connection timeout parameter
145 Int_t fRetries; // Number of DCS server connection retries
5164a766 146
2bb7b766 147 TMap fPreprocessorMap; // list of detector Preprocessors ("DET", "Preprocessor")
57f50b3c 148
2bb7b766 149 AliShuttleLogbookEntry* fLogbookEntry; //! current Shuttle logbook entry
150 TString fCurrentDetector; // current detector
926cbc0e 151 Bool_t fFirstProcessing; // processing this detector the first time in this run
57f50b3c 152
2c15234c 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
339adafa 156 Int_t fFXSError; // Variable to keep track of any FXS errors; contains -1 for no error, kDAQ, kDCS, kHLT otherwise
85a80aa9 157
2bb7b766 158 AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
be48e3ea 159
cb343cfd 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
4f0ab988 163
be48e3ea 164 Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors]; // array of flags for first unprocessed dets
165
e7f62f16 166 TMonaLisaWriter* fMonaLisa; // ML instance that sends the processing information
167
9827400b 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)
ffa29e93 170
171 Bool_t fOutputRedirected; // is the output redirected to a file
b948db8d 172
73abe331 173 ClassDef(AliShuttle, 0);
174};
175
176#endif