1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
15 //-------------------------------------------------------------------------
16 // Implementation of AliCDBManager and AliCDBParam classe
17 // Author: Alberto Colla
18 // e-mail: Alberto.Colla@cern.ch
19 //-------------------------------------------------------------------------
23 #include "AliCDBManager.h"
24 #include "AliCDBStorage.h"
26 #include "AliCDBDump.h"
27 #include "AliCDBLocal.h"
28 #include "AliCDBGrid.h"
29 #include "AliCDBEntry.h"
30 #include "AliCDBHandler.h"
32 #include <TObjString.h>
33 #include <TSAXParser.h>
41 ClassImp(AliCDBManager)
43 //TODO OCDB and Reference folder should not be fully hardcoded but built from run number (or year/LHC period)
44 TString AliCDBManager::fgkCondUri("alien://folder=/alice/cern.ch/user/a/aliprod/testCDB/CDB?user=aliprod");
45 TString AliCDBManager::fgkRefUri("alien://folder=/alice/cern.ch/user/a/aliprod/testCDB/Reference?user=aliprod");
46 TString AliCDBManager::fgkMCIdealStorage("alien://folder=/alice/simulation/2008/v4-15-Release/Ideal");
47 TString AliCDBManager::fgkMCFullStorage("alien://folder=/alice/simulation/2008/v4-15-Release/Full");
48 TString AliCDBManager::fgkMCResidualStorage("alien://folder=/alice/simulation/2008/v4-15-Release/Residual");
49 TString AliCDBManager::fgkOCDBFolderXMLfile("alien:///alice/data/OCDBFoldervsRunRange.xml");
50 AliCDBManager* AliCDBManager::fgInstance = 0x0;
52 //_____________________________________________________________________________
53 AliCDBManager* AliCDBManager::Instance(TMap *entryCache, Int_t run)
55 // returns AliCDBManager instance (singleton)
58 fgInstance = new AliCDBManager();
62 fgInstance->InitFromCache(entryCache,run);
68 //_____________________________________________________________________________
69 void AliCDBManager::Init() {
70 // factory registering
72 RegisterFactory(new AliCDBDumpFactory());
73 RegisterFactory(new AliCDBLocalFactory());
74 // AliCDBGridFactory is registered only if AliEn libraries are enabled in Root
75 if(!gSystem->Exec("root-config --has-alien 2>/dev/null |grep yes 2>&1 > /dev/null")){ // returns 0 if yes
76 AliInfo("AliEn classes enabled in Root. AliCDBGrid factory registered.");
77 RegisterFactory(new AliCDBGridFactory());
78 fCondParam = CreateParameter(fgkCondUri);
79 fRefParam = CreateParameter(fgkRefUri);
85 //_____________________________________________________________________________
86 void AliCDBManager::InitFromCache(TMap *entryCache, Int_t run) {
87 // initialize manager from existing cache
88 // used on the slaves in case of parallel reconstruction
91 TIter iter(entryCache->GetTable());
94 while((pair = dynamic_cast<TPair*> (iter.Next()))){
95 fEntryCache.Add(pair->Key(),pair->Value());
97 // fEntry is the new owner of the cache
98 fEntryCache.SetOwnerKeyValue(kTRUE,kTRUE);
99 entryCache->SetOwnerKeyValue(kFALSE,kFALSE);
100 AliInfo(Form("%d cache entries have been loaded",fEntryCache.GetEntries()));
103 //_____________________________________________________________________________
104 void AliCDBManager::DumpToSnapshotFile(const char* snapshotFileName, Bool_t singleKeys){
106 // dump the entries map and the ids list to
110 TFile *f = TFile::Open(snapshotFileName,"RECREATE");
111 if (!f || f->IsZombie()){
112 AliError(Form("Cannot open file %s",snapshotFileName));
116 Printf("\ndumping entriesMap (entries'cache) with %d entries!\n", fEntryCache.GetEntries());
117 Printf("\ndumping entriesList with %d entries!\n", fIds->GetEntries());
122 f->WriteObject(&fEntryCache,"CDBentriesMap");
123 f->WriteObject(fIds,"CDBidsList");
125 // We write the entries one by one named by their calibration path
127 fEntryCache.Write("CDBentriesMap");
128 fIds->Write("CDBidsList");
130 TIter iter(fEntryCache.GetTable());
132 while((pair = dynamic_cast<TPair*> (iter.Next()))){
133 TObjString *os = dynamic_cast<TObjString*>(pair->Key());
135 TString path = os->GetString();
136 AliCDBEntry *entry = dynamic_cast<AliCDBEntry*>(pair->Value());
137 if (!entry) continue;
138 path.ReplaceAll("/","*");
139 entry->Write(path.Data());
148 //_____________________________________________________________________________
149 Bool_t AliCDBManager::InitFromSnapshot(const char* snapshotFileName, Bool_t overwrite){
150 // initialize manager from a CDB snapshot, that is add the entries
151 // to the entries map and the ids to the ids list taking them from
152 // the map and the list found in the input file
154 // if the manager is locked it cannot initialize from a snapshot
156 AliError("Being locked I cannot initialize from the snapshot!");
161 TString snapshotFile(snapshotFileName);
162 if(snapshotFile.BeginsWith("alien://")){
164 TGrid::Connect("alien://","");
166 AliError("Connection to alien failed!");
172 TFile *f = TFile::Open(snapshotFileName);
173 if (!f || f->IsZombie()){
174 AliError(Form("Cannot open file %s",snapshotFileName));
178 // retrieve entries' map from snapshot file
179 TMap *entriesMap = 0;
180 TIter next(f->GetListOfKeys());
182 while ((key = (TKey*)next())) {
183 if (strcmp(key->GetClassName(),"TMap") != 0) continue;
184 entriesMap = (TMap*)key->ReadObj();
187 if (!entriesMap || entriesMap->GetEntries()==0){
188 AliError("Cannot get valid map of CDB entries from snapshot file");
192 // retrieve ids' list from snapshot file
194 TIter nextKey(f->GetListOfKeys());
196 while ((keyN = (TKey*)nextKey())) {
197 if (strcmp(keyN->GetClassName(),"TList") != 0) continue;
198 idsList = (TList*)keyN->ReadObj();
201 if (!idsList || idsList->GetEntries()==0){
202 AliError("Cannot get valid list of CDB entries from snapshot file");
206 // Add each (entry,id) from the snapshot to the memory: entry to the cache, id to the list of ids.
207 // If "overwrite" is false: add the entry to the cache and its id to the list of ids
208 // only if neither of them is already there.
209 // If "overwrite" is true: write the snapshot entry,id in any case. If something
210 // was already there for that calibration type, remove it and issue a warning
211 TIter iterObj(entriesMap->GetTable());
214 while((pair = dynamic_cast<TPair*> (iterObj.Next()))){
215 TObjString* os = (TObjString*) pair->Key();
216 TString path = os->GetString();
217 TIter iterId(idsList);
219 AliCDBId* correspondingId=0;
220 while((id = dynamic_cast<AliCDBId*> (iterId.Next()))){
221 TString idpath(id->GetPath());
227 if(!correspondingId){
228 AliError(Form("id for \"%s\" not found in the snapshot (while entry was). This entry is skipped!",path.Data()));
231 Bool_t cached = fEntryCache.Contains(path.Data());
232 Bool_t registeredId = kFALSE;
235 while((idT = dynamic_cast<AliCDBId*> (iter.Next()))){
236 if(idT->GetPath()==path){
237 registeredId = kTRUE;
243 if(cached || registeredId){
244 AliWarning(Form("An entry was already cached for \"%s\". Removing it before caching from snapshot",path.Data()));
245 UnloadFromCache(path.Data());
247 fEntryCache.Add(pair->Key(),pair->Value());
251 if(cached || registeredId){
252 AliWarning(Form("An entry was already cached for \"%s\". Not adding this object from snapshot",path.Data()));
254 fEntryCache.Add(pair->Key(),pair->Value());
261 // fEntry is the new owner of the cache
262 fEntryCache.SetOwnerKeyValue(kTRUE,kTRUE);
263 entriesMap->SetOwnerKeyValue(kFALSE,kFALSE);
264 fIds->SetOwner(kTRUE);
265 idsList->SetOwner(kFALSE);
266 AliInfo(Form("%d new (entry,id) cached. Total number %d",nAdded,fEntryCache.GetEntries()));
274 //_____________________________________________________________________________
275 void AliCDBManager::Destroy() {
276 // delete ALCDBManager instance and active storages
279 //fgInstance->Delete();
285 //_____________________________________________________________________________
286 AliCDBManager::AliCDBManager():
295 fDefaultStorage(NULL),
302 fSnapshotMode(kFALSE),
305 fStartRunLHCPeriod(-1),
306 fEndRunLHCPeriod(-1),
310 // default constuctor
311 fFactories.SetOwner(1);
312 fActiveStorages.SetOwner(1);
313 fSpecificStorages.SetOwner(1);
314 fEntryCache.SetName("CDBEntryCache");
315 fEntryCache.SetOwnerKeyValue(kTRUE,kTRUE);
317 fStorageMap = new TMap();
318 fStorageMap->SetOwner(1);
323 //_____________________________________________________________________________
324 AliCDBManager::~AliCDBManager() {
327 DestroyActiveStorages();
330 fDefaultStorage = 0x0;
331 delete fStorageMap; fStorageMap = 0;
332 delete fIds; fIds = 0;
335 delete fShortLived; fShortLived = 0x0;
336 //fSnapshotCache = 0;
337 //fSnapshotIdsList = 0;
339 fSnapshotFile->Close();
344 //_____________________________________________________________________________
345 void AliCDBManager::PutActiveStorage(AliCDBParam* param, AliCDBStorage* storage){
346 // put a storage object into the list of active storages
348 fActiveStorages.Add(param, storage);
349 AliDebug(1, Form("Active storages: %d", fActiveStorages.GetEntries()));
352 //_____________________________________________________________________________
353 void AliCDBManager::RegisterFactory(AliCDBStorageFactory* factory) {
354 // add a storage factory to the list of registerd factories
356 if (!fFactories.Contains(factory)) {
357 fFactories.Add(factory);
361 //_____________________________________________________________________________
362 Bool_t AliCDBManager::HasStorage(const char* dbString) const {
363 // check if dbString is a URI valid for one of the registered factories
365 TIter iter(&fFactories);
367 AliCDBStorageFactory* factory=0;
368 while ((factory = (AliCDBStorageFactory*) iter.Next())) {
370 if (factory->Validate(dbString)) {
378 //_____________________________________________________________________________
379 AliCDBParam* AliCDBManager::CreateParameter(const char* dbString) const {
380 // create AliCDBParam object from URI string
382 TIter iter(&fFactories);
384 AliCDBStorageFactory* factory=0;
385 while ((factory = (AliCDBStorageFactory*) iter.Next())) {
386 AliCDBParam* param = factory->CreateParameter(dbString);
387 if(param) return param;
393 //_____________________________________________________________________________
394 AliCDBStorage* AliCDBManager::GetStorage(const char* dbString) {
395 // get storage object from URI string
397 AliCDBParam* param = CreateParameter(dbString);
399 AliError(Form("Failed to activate requested storage! Check URI: %s", dbString));
403 AliCDBStorage* aStorage = GetStorage(param);
409 //_____________________________________________________________________________
410 AliCDBStorage* AliCDBManager::GetStorage(const AliCDBParam* param) {
411 // get storage object from AliCDBParam object
413 // if the list of active storages already contains
414 // the requested storage, return it
415 AliCDBStorage* aStorage = GetActiveStorage(param);
420 // if lock is ON, cannot activate more storages!
422 if (fDefaultStorage) {
423 AliFatal("Lock is ON, and default storage is already set: "
424 "cannot reset it or activate more storages!");
428 TIter iter(&fFactories);
430 AliCDBStorageFactory* factory=0;
432 // loop on the list of registered factories
433 while ((factory = (AliCDBStorageFactory*) iter.Next())) {
435 // each factory tries to create its storage from the parameter
436 aStorage = factory->Create(param);
438 PutActiveStorage(param->CloneParam(), aStorage);
439 aStorage->SetURI(param->GetURI());
441 if(aStorage->GetType() == "alien"){
442 aStorage->QueryCDB(fRun);
445 "Skipping query for valid files, it is used only in grid...");
452 AliError(Form("Failed to activate requested storage! Check URI: %s", param->GetURI().Data()));
457 //_____________________________________________________________________________
458 AliCDBStorage* AliCDBManager::GetActiveStorage(const AliCDBParam* param) {
459 // get a storage object from the list of active storages
461 return dynamic_cast<AliCDBStorage*> (fActiveStorages.GetValue(param));
464 //_____________________________________________________________________________
465 TList* AliCDBManager::GetActiveStorages() {
466 // return list of active storages
467 // user has responsibility to delete returned object
469 TList* result = new TList();
471 TIter iter(fActiveStorages.GetTable());
473 while ((aPair = (TPair*) iter.Next())) {
474 result->Add(aPair->Value());
480 //_____________________________________________________________________________
481 void AliCDBManager::SetDrain(const char* dbString) {
482 // set drain storage from URI string
484 fDrainStorage = GetStorage(dbString);
487 //_____________________________________________________________________________
488 void AliCDBManager::SetDrain(const AliCDBParam* param) {
489 // set drain storage from AliCDBParam
491 fDrainStorage = GetStorage(param);
494 //_____________________________________________________________________________
495 void AliCDBManager::SetDrain(AliCDBStorage* storage) {
496 // set drain storage from another active storage
498 fDrainStorage = storage;
501 //_____________________________________________________________________________
502 Bool_t AliCDBManager::Drain(AliCDBEntry *entry) {
503 // drain retrieved object to drain storage
505 AliDebug(2, "Draining into drain storage...");
506 return fDrainStorage->Put(entry);
509 //____________________________________________________________________________
510 void AliCDBManager::SetDefaultStorage(const char* dbString) {
511 // sets default storage from URI string
513 // checking whether we are in the raw case
514 TString dbStringTemp(dbString);
515 if (dbStringTemp == "raw://")
518 AliInfo("Setting the run-number will set the corresponding OCDB for raw data reconstruction.");
519 AliInfo("Connecting to the grid...");
521 TGrid::Connect("alien://","");
523 AliError("Connection to alien failed!");
530 AliCDBStorage* bckStorage = fDefaultStorage;
532 fDefaultStorage = GetStorage(dbString);
534 if(!fDefaultStorage) return;
536 if(bckStorage && (fDefaultStorage != bckStorage)){
537 AliWarning("Existing default storage replaced: clearing cache!");
541 if (fStorageMap->Contains("default")) {
542 delete fStorageMap->Remove(((TPair*)fStorageMap->FindObject("default"))->Key());
544 fStorageMap->Add(new TObjString("default"), new TObjString(fDefaultStorage->GetURI()));
546 //_____________________________________________________________________________
547 void AliCDBManager::SetDefaultStorage(const AliCDBParam* param) {
548 // set default storage from AliCDBParam object
550 AliCDBStorage* bckStorage = fDefaultStorage;
552 fDefaultStorage = GetStorage(param);
554 if(!fDefaultStorage) return;
556 if(bckStorage && (fDefaultStorage != bckStorage)){
557 AliWarning("Existing default storage replaced: clearing cache!");
561 if (fStorageMap->Contains("default")) {
562 delete fStorageMap->Remove(((TPair*)fStorageMap->FindObject("default"))->Key());
564 fStorageMap->Add(new TObjString("default"), new TObjString(fDefaultStorage->GetURI()));
567 //_____________________________________________________________________________
568 void AliCDBManager::SetDefaultStorage(AliCDBStorage* storage) {
569 // set default storage from another active storage
571 // if lock is ON, cannot activate more storages!
573 if (fDefaultStorage) {
574 AliFatal("Lock is ON, and default storage is already set: "
575 "cannot reset it or activate more storages!");
580 UnsetDefaultStorage();
584 AliCDBStorage* bckStorage = fDefaultStorage;
586 fDefaultStorage = storage;
588 if(bckStorage && (fDefaultStorage != bckStorage)){
589 AliWarning("Existing default storage replaced: clearing cache!");
593 if (fStorageMap->Contains("default")) {
594 delete fStorageMap->Remove(((TPair*)fStorageMap->FindObject("default"))->Key());
596 fStorageMap->Add(new TObjString("default"), new TObjString(fDefaultStorage->GetURI()));
599 //_____________________________________________________________________________
600 void AliCDBManager::SetDefaultStorage(const char* mcString, const char* simType) {
601 // sets default storage for MC data
602 // mcString MUST be "MC",
603 // simType can be "Ideal","Residual","Full"
605 TString strmcString(mcString);
606 TString strsimType(simType);
608 if (strmcString != "MC"){
609 AliFatal("Method requires first string to be MC!");
612 if (strsimType == "Ideal"){
613 dbString = fgkMCIdealStorage;
615 else if (strsimType == "Full"){
616 dbString = fgkMCFullStorage;
618 else if (strsimType == "Residual"){
619 dbString = fgkMCResidualStorage;
622 AliFatal("Error in setting the storage for MC data, second argument MUST be either \"Ideal\" or \"Full\" or \"Residual\".");
625 SetDefaultStorage(dbString.Data());
626 if(!fDefaultStorage) AliFatal(Form("%s storage not there! Please check!",fLHCPeriod.Data()));
629 //_____________________________________________________________________________
630 void AliCDBManager::SetDefaultStorageFromRun(Int_t run) {
631 // set default storage from the run number - to be used only with raw data
633 // if lock is ON, cannot activate more storages!
635 if (fDefaultStorage) {
636 AliFatal("Lock is ON, and default storage is already set: "
637 "cannot activate default storage from run number");
641 // retrieve XML file from alien
643 TGrid::Connect("alien://","");
645 AliError("Connection to alien failed!");
650 TString rndname = "/tmp/";
651 rndname += "OCDBFolderXML.";
652 rndname += uuid.AsString();
654 AliDebug(2, Form("file to be copied = %s", fgkOCDBFolderXMLfile.Data()));
655 if (!TFile::Cp(fgkOCDBFolderXMLfile.Data(), rndname.Data())) {
656 AliFatal(Form("Cannot make a local copy of OCDBFolder xml file in %s",rndname.Data()));
658 AliCDBHandler* saxcdb = new AliCDBHandler();
660 TSAXParser *saxParser = new TSAXParser();
661 saxParser->ConnectToHandler("AliCDBHandler", saxcdb);
662 saxParser->ParseFile(rndname.Data());
663 AliInfo(Form(" LHC folder = %s", saxcdb->GetOCDBFolder().Data()));
664 AliInfo(Form(" LHC period start run = %d", saxcdb->GetStartRunRange()));
665 AliInfo(Form(" LHC period end run = %d", saxcdb->GetEndRunRange()));
666 fLHCPeriod = saxcdb->GetOCDBFolder();
667 fStartRunLHCPeriod = saxcdb->GetStartRunRange();
668 fEndRunLHCPeriod = saxcdb->GetEndRunRange();
670 SetDefaultStorage(fLHCPeriod.Data());
671 if(!fDefaultStorage) AliFatal(Form("%s storage not there! Please check!",fLHCPeriod.Data()));
675 //_____________________________________________________________________________
676 void AliCDBManager::UnsetDefaultStorage() {
677 // Unset default storage
679 // if lock is ON, action is forbidden!
681 if (fDefaultStorage) {
682 AliFatal("Lock is ON: cannot unset default storage!");
686 if (fDefaultStorage) {
687 AliWarning("Clearing cache!");
691 fRun = fStartRunLHCPeriod = fEndRunLHCPeriod = -1;
694 fDefaultStorage = 0x0;
697 //_____________________________________________________________________________
698 void AliCDBManager::SetSpecificStorage(const char* calibType, const char* dbString) {
699 // sets storage specific for detector or calibration type (works with AliCDBManager::Get(...))
701 AliCDBParam *aPar = CreateParameter(dbString);
703 SetSpecificStorage(calibType, aPar);
707 //_____________________________________________________________________________
708 void AliCDBManager::SetSpecificStorage(const char* calibType, const AliCDBParam* param) {
709 // sets storage specific for detector or calibration type (works with AliCDBManager::Get(...))
710 // Default storage should be defined prior to any specific storages, e.g.:
711 // AliCDBManager::instance()->SetDefaultStorage("alien://");
712 // AliCDBManager::instance()->SetSpecificStorage("TPC/*","local://DB_TPC");
713 // AliCDBManager::instance()->SetSpecificStorage("*/Align/*","local://DB_TPCAlign");
714 // calibType must be a valid CDB path! (3 level folder structure)
717 if(!fDefaultStorage && !fRaw) {
718 AliError("Please activate a default storage first!");
723 AliCDBPath aPath(calibType);
724 if(!aPath.IsValid()){
725 AliError(Form("Not a valid path: %s", calibType));
729 TObjString *objCalibType = new TObjString(aPath.GetPath());
730 if(fSpecificStorages.Contains(objCalibType)){
731 AliWarning(Form("Storage \"%s\" already activated! It will be replaced by the new one",
733 AliCDBParam *checkPar = dynamic_cast<AliCDBParam*> (fSpecificStorages.GetValue(calibType));
734 if(checkPar) delete checkPar;
735 delete fSpecificStorages.Remove(objCalibType);
737 AliCDBStorage *aStorage = GetStorage(param);
738 if(!aStorage) return;
740 fSpecificStorages.Add(objCalibType, param->CloneParam());
742 if(fStorageMap->Contains(objCalibType)){
743 delete fStorageMap->Remove(objCalibType);
745 fStorageMap->Add(objCalibType->Clone(), new TObjString(param->GetURI()));
749 //_____________________________________________________________________________
750 AliCDBStorage* AliCDBManager::GetSpecificStorage(const char* calibType) {
751 // get storage specific for detector or calibration type
753 AliCDBPath calibPath(calibType);
754 if(!calibPath.IsValid()) return NULL;
756 AliCDBParam *checkPar = (AliCDBParam*) fSpecificStorages.GetValue(calibPath.GetPath());
758 AliError(Form("%s storage not found!", calibType));
761 return GetStorage(checkPar);
766 //_____________________________________________________________________________
767 AliCDBParam* AliCDBManager::SelectSpecificStorage(const TString& path) {
768 // select storage valid for path from the list of specific storages
770 AliCDBPath aPath(path);
771 if(!aPath.IsValid()) return NULL;
773 TIter iter(&fSpecificStorages);
774 TObjString *aCalibType=0;
775 AliCDBPath tmpPath("null/null/null");
777 while((aCalibType = (TObjString*) iter.Next())){
778 AliCDBPath calibTypePath(aCalibType->GetName());
779 if(calibTypePath.Comprises(aPath)) {
780 if(calibTypePath.Comprises(tmpPath)) continue;
781 aPar = (AliCDBParam*) fSpecificStorages.GetValue(aCalibType);
782 tmpPath.SetPath(calibTypePath.GetPath());
788 //_____________________________________________________________________________
789 AliCDBEntry* AliCDBManager::Get(const AliCDBPath& path, Int_t runNumber,
790 Int_t version, Int_t subVersion) {
791 // get an AliCDBEntry object from the database
794 // RunNumber is not specified. Try with fRun
796 AliError("Run number neither specified in query nor set in AliCDBManager! Use AliCDBManager::SetRun.");
802 return Get(AliCDBId(path, runNumber, runNumber, version, subVersion));
805 //_____________________________________________________________________________
806 AliCDBEntry* AliCDBManager::Get(const AliCDBPath& path,
807 const AliCDBRunRange& runRange, Int_t version,
809 // get an AliCDBEntry object from the database!
811 return Get(AliCDBId(path, runRange, version, subVersion));
814 //_____________________________________________________________________________
815 AliCDBEntry* AliCDBManager::Get(const AliCDBId& query, Bool_t forceCaching) {
816 // get an AliCDBEntry object from the database
818 // check if query's path and runRange are valid
819 // query is invalid also if version is not specified and subversion is!
820 if (!query.IsValid()) {
821 AliError(Form("Invalid query: %s", query.ToString().Data()));
825 // query is not specified if path contains wildcard or run range= [-1,-1]
826 if (!query.IsSpecified()) {
827 AliError(Form("Unspecified query: %s",
828 query.ToString().Data()));
832 if(fLock && !(fRun >= query.GetFirstRun() && fRun <= query.GetLastRun()))
833 AliFatal("Lock is ON: cannot use different run number than the internal one!");
835 if(fCache && !(fRun >= query.GetFirstRun() && fRun <= query.GetLastRun()))
836 AliWarning("Run number explicitly set in query: CDB cache temporarily disabled!");
838 AliCDBEntry *entry=0;
840 // first look into map of cached objects
841 if(fCache && query.GetFirstRun() == fRun)
842 entry = (AliCDBEntry*) fEntryCache.GetValue(query.GetPath());
844 AliDebug(2, Form("Object %s retrieved from cache !!",query.GetPath().Data()));
848 // if snapshot flag is set, try getting from the snapshot
849 // but in the case a specific storage is specified for this path
850 AliCDBParam *aPar=SelectSpecificStorage(query.GetPath());
852 if(fSnapshotMode && query.GetFirstRun() == fRun)
854 entry = GetEntryFromSnapshot(query.GetPath());
856 AliInfo(Form("Object \"%s\" retrieved from the snapshot.",query.GetPath().Data()));
857 if(query.GetFirstRun() == fRun) // no need to check fCache, fSnapshotMode not possible otherwise
858 CacheEntry(query.GetPath(), entry);
860 if(!fIds->Contains(&entry->GetId()))
861 fIds->Add(entry->GetId().Clone());
868 // Entry is not in cache (and, in case we are in snapshot mode, not in the snapshot either)
869 // => retrieve it from the storage and cache it!!
870 if(!fDefaultStorage) {
871 AliError("No storage set!");
875 AliCDBStorage *aStorage=0;
877 aStorage=GetStorage(aPar);
878 TString str = aPar->GetURI();
879 AliDebug(2,Form("Looking into storage: %s",str.Data()));
881 aStorage=GetDefaultStorage();
882 AliDebug(2,"Looking into default storage");
885 entry = aStorage->Get(query);
887 if(entry && fCache && (query.GetFirstRun()==fRun || forceCaching)){
888 CacheEntry(query.GetPath(), entry);
891 if(entry && !fIds->Contains(&entry->GetId())){
892 fIds->Add(entry->GetId().Clone());
900 //_____________________________________________________________________________
901 AliCDBEntry* AliCDBManager::GetEntryFromSnapshot(const char* path) {
902 // get the entry from the open snapshot file
905 sPath.ReplaceAll("/","*");
906 AliCDBEntry *entry = dynamic_cast<AliCDBEntry*>(fSnapshotFile->Get(sPath.Data()));
908 AliDebug(2,Form("Cannot get a CDB entry for \"%s\" from snapshot file",path));
915 //_____________________________________________________________________________
916 Bool_t AliCDBManager::SetSnapshotMode(const char* snapshotFileName) {
917 // set the manager in snapshot mode
920 AliError("Cannot set the CDB manage in snapshot mode if the cache is not active!");
925 TString snapshotFile(snapshotFileName);
926 if(snapshotFile.BeginsWith("alien://")){
928 TGrid::Connect("alien://","");
930 AliError("Connection to alien failed!");
936 fSnapshotFile = TFile::Open(snapshotFileName);
937 if (!fSnapshotFile || fSnapshotFile->IsZombie()){
938 AliError(Form("Cannot open file %s",snapshotFileName));
942 Printf("The CDB manager is set in snapshot mode: cache->snapshot->defaultstorage");
943 fSnapshotMode = kTRUE;
948 //_____________________________________________________________________________
949 const char* AliCDBManager::GetURI(const char* path) {
950 // return the URI of the storage where to look for path
952 if(!IsDefaultStorageSet()) return 0;
954 AliCDBParam *aPar=SelectSpecificStorage(path);
957 return aPar->GetURI().Data();
960 return GetDefaultStorage()->GetURI().Data();
966 //_____________________________________________________________________________
967 AliCDBId* AliCDBManager::GetId(const AliCDBPath& path, Int_t runNumber,
968 Int_t version, Int_t subVersion) {
969 // get the AliCDBId of the valid object from the database (does not retrieve the object)
970 // User must delete returned object!
973 // RunNumber is not specified. Try with fRun
975 AliError("Run number neither specified in query nor set in AliCDBManager! Use AliCDBManager::SetRun.");
981 return GetId(AliCDBId(path, runNumber, runNumber, version, subVersion));
984 //_____________________________________________________________________________
985 AliCDBId* AliCDBManager::GetId(const AliCDBPath& path,
986 const AliCDBRunRange& runRange, Int_t version,
988 // get the AliCDBId of the valid object from the database (does not retrieve the object)
989 // User must delete returned object!
991 return GetId(AliCDBId(path, runRange, version, subVersion));
994 //_____________________________________________________________________________
995 AliCDBId* AliCDBManager::GetId(const AliCDBId& query) {
996 // get the AliCDBId of the valid object from the database (does not retrieve the object)
997 // User must delete returned object!
999 if(!fDefaultStorage) {
1000 AliError("No storage set!");
1004 // check if query's path and runRange are valid
1005 // query is invalid also if version is not specified and subversion is!
1006 if (!query.IsValid()) {
1007 AliError(Form("Invalid query: %s", query.ToString().Data()));
1011 // query is not specified if path contains wildcard or run range= [-1,-1]
1012 if (!query.IsSpecified()) {
1013 AliError(Form("Unspecified query: %s",
1014 query.ToString().Data()));
1018 if(fCache && query.GetFirstRun() != fRun)
1019 AliWarning("Run number explicitly set in query: CDB cache temporarily disabled!");
1021 AliCDBEntry* entry = 0;
1023 // first look into map of cached objects
1024 if(fCache && query.GetFirstRun() == fRun)
1025 entry = (AliCDBEntry*) fEntryCache.GetValue(query.GetPath());
1028 AliDebug(2, Form("Object %s retrieved from cache !!",query.GetPath().Data()));
1029 return dynamic_cast<AliCDBId*> (entry->GetId().Clone());
1032 // Entry is not in cache -> retrieve it from CDB and cache it!!
1033 AliCDBStorage *aStorage=0;
1034 AliCDBParam *aPar=SelectSpecificStorage(query.GetPath());
1037 aStorage=GetStorage(aPar);
1038 TString str = aPar->GetURI();
1039 AliDebug(2,Form("Looking into storage: %s",str.Data()));
1042 aStorage=GetDefaultStorage();
1043 AliDebug(2,"Looking into default storage");
1046 return aStorage->GetId(query);
1050 //_____________________________________________________________________________
1051 TList* AliCDBManager::GetAll(const AliCDBPath& path, Int_t runNumber,
1052 Int_t version, Int_t subVersion) {
1053 // get multiple AliCDBEntry objects from the database
1056 // RunNumber is not specified. Try with fRun
1058 AliError("Run number neither specified in query nor set in AliCDBManager! Use AliCDBManager::SetRun.");
1064 return GetAll(AliCDBId(path, runNumber, runNumber, version,
1068 //_____________________________________________________________________________
1069 TList* AliCDBManager::GetAll(const AliCDBPath& path,
1070 const AliCDBRunRange& runRange, Int_t version, Int_t subVersion) {
1071 // get multiple AliCDBEntry objects from the database
1073 return GetAll(AliCDBId(path, runRange, version, subVersion));
1076 //_____________________________________________________________________________
1077 TList* AliCDBManager::GetAll(const AliCDBId& query) {
1078 // get multiple AliCDBEntry objects from the database
1079 // Warning: this method works correctly only for queries of the type "Detector/*"
1080 // and not for more specific queries e.g. "Detector/Calib/*" !
1081 // Warning #2: Entries are cached, but GetAll will keep on retrieving objects from OCDB!
1082 // To get an object from cache use Get() function
1084 if(!fDefaultStorage) {
1085 AliError("No storage set!");
1089 if (!query.IsValid()) {
1090 AliError(Form("Invalid query: %s", query.ToString().Data()));
1094 if((fSpecificStorages.GetEntries()>0) && query.GetPath().BeginsWith('*')){
1095 // if specific storages are active a query with "*" is ambiguous
1096 AliError("Query too generic in this context!");
1100 if (query.IsAnyRange()) {
1101 AliError(Form("Unspecified run or runrange: %s",
1102 query.ToString().Data()));
1106 if(fLock && query.GetFirstRun() != fRun)
1107 AliFatal("Lock is ON: cannot use different run number than the internal one!");
1109 AliCDBParam *aPar=SelectSpecificStorage(query.GetPath());
1111 AliCDBStorage *aStorage;
1113 aStorage=GetStorage(aPar);
1114 AliDebug(2,Form("Looking into storage: %s", aPar->GetURI().Data()));
1117 aStorage=GetDefaultStorage();
1118 AliDebug(2,"Looking into default storage");
1122 if(aStorage) result = aStorage->GetAll(query);
1123 if(!result) return 0;
1125 // loop on result to check whether entries should be re-queried with specific storages
1126 if(fSpecificStorages.GetEntries()>0 && ! (fSpecificStorages.GetEntries() == 1 && aPar)) {
1127 AliInfo("Now look into all other specific storages...");
1130 AliCDBEntry* chkEntry=0;
1132 while((chkEntry = dynamic_cast<AliCDBEntry*> (iter.Next()))){
1133 AliCDBId& chkId = chkEntry->GetId();
1134 AliDebug(2, Form("Checking id %s ", chkId.GetPath().Data()));
1135 AliCDBParam *chkPar=SelectSpecificStorage(chkId.GetPath());
1136 if (!chkPar || aPar == chkPar) continue;
1137 AliCDBStorage *chkStorage = GetStorage(chkPar);
1138 AliDebug(2, Form("Found specific storage! %s", chkPar->GetURI().Data()));
1140 AliCDBEntry *newEntry=0;
1141 chkId.SetRunRange(query.GetFirstRun(), query.GetLastRun());
1142 chkId.SetVersion(query.GetVersion());
1143 chkId.SetSubVersion(query.GetSubVersion());
1145 if(chkStorage) newEntry = chkStorage->Get(chkId);
1146 if(!newEntry) continue;
1148 // object is found in specific storage: replace entry in the result list!
1149 chkEntry->SetOwner(1);
1150 delete result->Remove(chkEntry);
1151 result->AddFirst(newEntry);
1154 Int_t nEntries = result->GetEntries();
1155 AliInfo("After look into other specific storages, result list is:");
1156 for(int i=0; i<nEntries;i++){
1157 AliCDBEntry *entry = (AliCDBEntry*) result->At(i);
1158 AliInfo(Form("%s",entry->GetId().ToString().Data()));
1164 AliCDBEntry* entry=0;
1165 while((entry = dynamic_cast<AliCDBEntry*> (iter.Next()))){
1167 if(!fIds->Contains(&entry->GetId())){
1168 fIds->Add(entry->GetId().Clone());
1170 if(fCache && (query.GetFirstRun() == fRun)){
1171 CacheEntry(entry->GetId().GetPath(), entry);
1179 //_____________________________________________________________________________
1180 Bool_t AliCDBManager::Put(TObject* object, const AliCDBId& id, AliCDBMetaData* metaData, const DataType type){
1181 // store an AliCDBEntry object into the database
1184 AliError("Null Entry! No storage will be done!");
1188 AliCDBEntry anEntry(object, id, metaData);
1189 return Put(&anEntry, type);
1194 //_____________________________________________________________________________
1195 Bool_t AliCDBManager::Put(AliCDBEntry* entry, DataType type){
1196 // store an AliCDBEntry object into the database
1198 if(type == kPrivate && !fDefaultStorage) {
1199 AliError("No storage set!");
1204 AliError("No entry!");
1208 if (entry->GetObject()==0x0){
1209 AliError("No valid object in CDB entry!");
1213 if (!entry->GetId().IsValid()) {
1214 AliError(Form("Invalid entry ID: %s",
1215 entry->GetId().ToString().Data()));
1219 if (!entry->GetId().IsSpecified()) {
1220 AliError(Form("Unspecified entry ID: %s",
1221 entry->GetId().ToString().Data()));
1225 AliCDBId id = entry->GetId();
1226 AliCDBParam *aPar = SelectSpecificStorage(id.GetPath());
1228 AliCDBStorage *aStorage=0;
1231 aStorage=GetStorage(aPar);
1235 aStorage = GetStorage(fCondParam);
1238 aStorage = GetStorage(fRefParam);
1241 aStorage = GetDefaultStorage();
1246 AliDebug(2,Form("Storing object into storage: %s", aStorage->GetURI().Data()));
1248 Bool_t result = aStorage->Put(entry, type);
1250 if(fRun >= 0) QueryCDB();
1257 //_____________________________________________________________________________
1258 void AliCDBManager::CacheEntry(const char* path, AliCDBEntry* entry)
1260 // cache AliCDBEntry. Cache is valid until run number is changed.
1262 AliCDBEntry *chkEntry = dynamic_cast<AliCDBEntry*> (fEntryCache.GetValue(path));
1265 AliDebug(2, Form("Object %s already in cache !!", path));
1268 AliDebug(2,Form("Caching entry %s", path));
1271 fEntryCache.Add(new TObjString(path), entry);
1272 AliDebug(2,Form("Cache entries: %d", fEntryCache.GetEntries()));
1276 //_____________________________________________________________________________
1277 void AliCDBManager::Print(Option_t* /*option*/) const
1279 // Print list of active storages and their URIs
1281 TString output=Form("Run number = %d; ",fRun);
1282 output += "Cache is ";
1283 if(!fCache) output += "NOT ";
1284 output += Form("ACTIVE; Number of active storages: %d\n",fActiveStorages.GetEntries());
1286 if(fDefaultStorage) {
1287 output += Form("\t*** Default Storage URI: \"%s\"\n",fDefaultStorage->GetURI().Data());
1288 // AliInfo(output.Data());
1290 if(fSpecificStorages.GetEntries()>0) {
1291 TIter iter(fSpecificStorages.GetTable());
1294 while((aPair = (TPair*) iter.Next())){
1295 output += Form("\t*** Specific storage %d: Path \"%s\" -> URI \"%s\"\n",
1296 i++, ((TObjString*) aPair->Key())->GetName(),
1297 ((AliCDBParam*) aPair->Value())->GetURI().Data());
1301 output += Form("*** Drain Storage URI: %s\n",fDrainStorage->GetURI().Data());
1303 AliInfo(output.Data());
1306 //_____________________________________________________________________________
1307 void AliCDBManager::SetRun(Int_t run)
1309 // Sets current run number.
1310 // When the run number changes the caching is cleared.
1315 if(fLock && fRun >= 0) {
1316 AliFatal("Lock is ON, cannot reset run number!");
1321 // here the LHCPeriod xml file is parsed; the string containing the correct period is returned; the default storage is set
1322 if (fStartRunLHCPeriod <= run && fEndRunLHCPeriod >= run){
1323 AliInfo("LHCPeriod alien folder for current run already in memory");
1325 SetDefaultStorageFromRun(run);
1326 if(fEntryCache.GetEntries()!=0) ClearCache();
1334 //_____________________________________________________________________________
1335 void AliCDBManager::ClearCache(){
1336 // clear AliCDBEntry cache
1338 AliDebug(2, Form("Cache entries to be deleted: %d",fEntryCache.GetEntries()));
1341 // To clean entries one by one
1342 TIter iter(fEntryCache.GetTable());
1344 while((pair= dynamic_cast<TPair*> (iter.Next()))){
1346 TObjString* key = dynamic_cast<TObjString*> (pair->Key());
1347 AliCDBEntry* entry = dynamic_cast<AliCDBEntry*> (pair->Value());
1348 AliDebug(2, Form("Deleting entry: %s", key->GetName()));
1349 if (entry) delete entry;
1350 delete fEntryCache.Remove(key);
1353 fEntryCache.DeleteAll();
1354 AliDebug(2, Form("After deleting - Cache entries: %d",fEntryCache.GetEntries()));
1357 //_____________________________________________________________________________
1358 void AliCDBManager::UnloadFromCache(const char* path){
1359 // unload cached object
1360 // that is remove the entry from the cache and the id from the list of ids
1362 if(!fActiveStorages.GetEntries()) {
1363 AliDebug(2, Form("No active storages. Object \"%s\" is not unloaded from cache", path));
1367 AliCDBPath queryPath(path);
1368 if(!queryPath.IsValid()) return;
1370 if(!queryPath.IsWildcard()) { // path is not wildcard, get it directly from the cache and unload it!
1371 if(fEntryCache.Contains(path)){
1372 AliDebug(2, Form("Unloading object \"%s\" from cache and from list of ids", path));
1373 TObjString pathStr(path);
1374 delete fEntryCache.Remove(&pathStr);
1375 // we do not remove from the list of Id's (it's not very coherent but we leave the
1376 // id for the benefit of the userinfo)
1380 while((id = dynamic_cast<AliCDBId*> (iter.Next()))){
1381 if(queryPath.Comprises(id->GetPath()))
1382 delete fIds->Remove(id);
1385 AliError(Form("Cache does not contain object \"%s\"!", path));
1387 AliDebug(2, Form("Cache entries: %d",fEntryCache.GetEntries()));
1391 // path is wildcard: loop on the cache and unload all comprised objects!
1392 TIter iter(fEntryCache.GetTable());
1396 while((pair = dynamic_cast<TPair*> (iter.Next()))){
1397 AliCDBPath entryPath = pair->Key()->GetName();
1398 if(queryPath.Comprises(entryPath)) {
1399 AliDebug(2, Form("Unloading object \"%s\" from cache and from list of ids", entryPath.GetPath().Data()));
1400 TObjString pathStr(entryPath.GetPath());
1401 delete fEntryCache.Remove(&pathStr);
1404 // we do not remove from the list of Id's (it's not very coherent but we leave the
1405 // id for the benefit of the userinfo)
1407 TIter iterids(fIds);
1409 while((anId = dynamic_cast<AliCDBId*> (iterids.Next()))){
1410 AliCDBPath aPath = anId->GetPath();
1411 TString aPathStr = aPath.GetPath();
1412 if(queryPath.Comprises(aPath)) {
1413 delete fIds->Remove(anId);
1418 AliDebug(2,Form("Cache entries and ids removed: %d Remaining: %d",removed,fEntryCache.GetEntries()));
1421 //_____________________________________________________________________________
1422 void AliCDBManager::DestroyActiveStorages() {
1423 // delete list of active storages
1425 fActiveStorages.DeleteAll();
1426 fSpecificStorages.DeleteAll();
1429 //_____________________________________________________________________________
1430 void AliCDBManager::DestroyActiveStorage(AliCDBStorage* /*storage*/) {
1431 // destroys active storage
1434 TIter iter(fActiveStorages.GetTable());
1436 while ((aPair = (TPair*) iter.Next())) {
1437 if(storage == (AliCDBStorage*) aPair->Value())
1438 delete fActiveStorages.Remove(aPair->Key());
1439 storage->Delete(); storage=0x0;
1445 //_____________________________________________________________________________
1446 void AliCDBManager::QueryCDB() {
1447 // query default and specific storages for files valid for fRun. Every storage loads the Ids into its list.
1450 AliError("Run number not yet set! Use AliCDBManager::SetRun.");
1453 if (!fDefaultStorage){
1454 AliError("Default storage is not set! Use AliCDBManager::SetDefaultStorage");
1457 if(fDefaultStorage->GetType() == "alien"){
1458 fDefaultStorage->QueryCDB(fRun);
1460 AliDebug(2,"Skipping query for valid files, it used only in grid...");
1463 TIter iter(&fSpecificStorages);
1464 TObjString *aCalibType=0;
1465 AliCDBParam* aPar=0;
1466 while((aCalibType = dynamic_cast<TObjString*> (iter.Next()))){
1467 aPar = (AliCDBParam*) fSpecificStorages.GetValue(aCalibType);
1469 AliDebug(2,Form("Querying specific storage %s",aCalibType->GetName()));
1470 AliCDBStorage *aStorage = GetStorage(aPar);
1471 if(aStorage->GetType() == "alien"){
1472 aStorage->QueryCDB(fRun,aCalibType->GetName());
1475 "Skipping query for valid files, it is used only in grid...");
1481 //______________________________________________________________________________________________
1482 const char* AliCDBManager::GetDataTypeName(DataType type)
1484 // returns the name (string) of the data type
1487 case kCondition: return "Conditions";
1488 case kReference: return "Reference";
1489 case kPrivate: return "Private";
1495 //______________________________________________________________________________________________
1496 void AliCDBManager::InitShortLived()
1498 // Init the list of short-lived objects
1499 // currently disabled
1503 // fShortLived = new TList();
1504 // fShortLived->SetOwner(1);
1506 // fShortLived->Add(new TObjString("EMCAL/Calib/Data"));
1508 // fShortLived->Add(new TObjString("HMPID/Calib/Nmean"));
1509 // fShortLived->Add(new TObjString("HMPID/Calib/Qthre"));
1511 // fShortLived->Add(new TObjString("ITS/Calib/CalibSPD"));
1513 // fShortLived->Add(new TObjString("MUON/Calib/Gains"));
1514 // fShortLived->Add(new TObjString("MUON/Calib/HV"));
1515 // fShortLived->Add(new TObjString("MUON/Calib/Pedestals"));
1517 // fShortLived->Add(new TObjString("PHOS/Calib/CpvGainPedestals"));
1518 // fShortLived->Add(new TObjString("PHOS/Calib/EmcGainPedestals"));
1520 // fShortLived->Add(new TObjString("PMD/Calib/Data"));
1522 // fShortLived->Add(new TObjString("TRD/Calib/ChamberGainFactor"));
1523 // fShortLived->Add(new TObjString("TRD/Calib/LocalGainFactor"));
1524 // fShortLived->Add(new TObjString("TRD/Calib/ChamberT0"));
1525 // fShortLived->Add(new TObjString("TRD/Calib/LocalT0"));
1526 // fShortLived->Add(new TObjString("TRD/Calib/ChamberVdrift"));
1527 // fShortLived->Add(new TObjString("TRD/Calib/LocalVdrift"));
1529 // fShortLived->Add(new TObjString("ZDC/Calib/Data"));
1533 //______________________________________________________________________________________________
1534 Bool_t AliCDBManager::IsShortLived(const char* path)
1536 // returns the name (string) of the data type
1538 if(!fShortLived) return kFALSE;
1540 AliCDBPath aPath(path);
1541 if(!aPath.IsValid()){
1542 AliError(Form("Not a valid path: %s", path));
1546 return fShortLived->Contains(path);
1550 //______________________________________________________________________________________________
1551 ULong_t AliCDBManager::SetLock(Bool_t lock, ULong_t key){
1552 // To lock/unlock user must provide the key. A new key is provided after
1553 // each successful lock. User should always backup the returned key and
1554 // use it on next access.
1555 if (fLock == lock) return 0; // nothing to be done
1557 // User wants to lock - check his identity
1559 // Lock has a user - check his key
1561 AliFatal("Wrong key provided to lock CDB. Please remove CDB lock access from your code !");
1566 fKey = gSystem->Now();
1570 // User wants to unlock - check the provided key
1572 AliFatal("Lock is ON: wrong key provided");
1579 ///////////////////////////////////////////////////////////
1580 // AliCDBManager Parameter class //
1581 // interface to specific AliCDBParameter class //
1582 // (AliCDBGridParam, AliCDBLocalParam, AliCDBDumpParam) //
1583 ///////////////////////////////////////////////////////////
1585 AliCDBParam::AliCDBParam():
1593 //_____________________________________________________________________________
1594 AliCDBParam::~AliCDBParam() {