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 //-------------------------------------------------------------------------
21 #include "AliCDBManager.h"
22 #include "AliCDBStorage.h"
24 #include "AliCDBDump.h"
25 #include "AliCDBLocal.h"
26 #include "AliCDBGrid.h"
27 #include "AliCDBEntry.h"
28 #include "AliCDBMetaData.h"
30 #include <TObjString.h>
35 ClassImp(AliCDBManager)
37 //TODO OCDB and Reference folder should not be fully hardcoded but built from run number (or year/LHC period)
38 TString AliCDBManager::fgkCondUri("alien://folder=/alice/cern.ch/user/a/aliprod/testCDB/CDB?user=aliprod");
39 TString AliCDBManager::fgkRefUri("alien://folder=/alice/cern.ch/user/a/aliprod/testCDB/Reference?user=aliprod");
40 AliCDBManager* AliCDBManager::fgInstance = 0x0;
42 //_____________________________________________________________________________
43 AliCDBManager* AliCDBManager::Instance()
45 // returns AliCDBManager instance (singleton)
48 fgInstance = new AliCDBManager();
55 //_____________________________________________________________________________
56 void AliCDBManager::Init() {
57 // factory registering
59 RegisterFactory(new AliCDBDumpFactory());
60 RegisterFactory(new AliCDBLocalFactory());
61 // AliCDBGridFactory is registered only if AliEn libraries are enabled in Root
62 if(!gSystem->Exec("root-config --has-alien |grep yes 2>&1 > /dev/null")){ // returns 0 if yes
63 AliInfo("AliEn classes enabled in Root. AliCDBGrid factory registered.");
64 RegisterFactory(new AliCDBGridFactory());
65 fCondParam = CreateParameter(fgkCondUri);
66 fRefParam = CreateParameter(fgkRefUri);
69 //_____________________________________________________________________________
70 void AliCDBManager::Destroy() {
71 // delete ALCDBManager instance and active storages
74 //fgInstance->Delete();
80 //_____________________________________________________________________________
81 AliCDBManager::AliCDBManager():
88 fDefaultStorage(NULL),
95 fFactories.SetOwner(1);
96 fActiveStorages.SetOwner(1);
97 fSpecificStorages.SetOwner(1);
98 fEntryCache.SetOwner(1);
101 //_____________________________________________________________________________
102 AliCDBManager::~AliCDBManager() {
105 DestroyActiveStorages();
108 fDefaultStorage = 0x0;
113 //_____________________________________________________________________________
114 void AliCDBManager::PutActiveStorage(AliCDBParam* param, AliCDBStorage* storage){
115 // put a storage object into the list of active storages
117 fActiveStorages.Add(param, storage);
118 AliDebug(1, Form("Active storages: %d", fActiveStorages.GetEntries()));
121 //_____________________________________________________________________________
122 void AliCDBManager::RegisterFactory(AliCDBStorageFactory* factory) {
123 // add a storage factory to the list of registerd factories
125 if (!fFactories.Contains(factory)) {
126 fFactories.Add(factory);
130 //_____________________________________________________________________________
131 Bool_t AliCDBManager::HasStorage(const char* dbString) const {
132 // check if dbString is a URI valid for one of the registered factories
134 TIter iter(&fFactories);
136 AliCDBStorageFactory* factory=0;
137 while ((factory = (AliCDBStorageFactory*) iter.Next())) {
139 if (factory->Validate(dbString)) {
147 //_____________________________________________________________________________
148 AliCDBParam* AliCDBManager::CreateParameter(const char* dbString) const {
149 // create AliCDBParam object from URI string
151 TIter iter(&fFactories);
153 AliCDBStorageFactory* factory=0;
154 while ((factory = (AliCDBStorageFactory*) iter.Next())) {
155 AliCDBParam* param = factory->CreateParameter(dbString);
156 if(param) return param;
162 //_____________________________________________________________________________
163 AliCDBStorage* AliCDBManager::GetStorage(const char* dbString) {
164 // get storage object from URI string
166 AliCDBParam* param = CreateParameter(dbString);
168 AliError(Form("Failed to activate requested storage! Check URI: %s", dbString));
172 AliCDBStorage* aStorage = GetStorage(param);
178 //_____________________________________________________________________________
179 AliCDBStorage* AliCDBManager::GetStorage(const AliCDBParam* param) {
180 // get storage object from AliCDBParam object
182 // if the list of active storages already contains
183 // the requested storage, return it
184 AliCDBStorage* aStorage = GetActiveStorage(param);
189 TIter iter(&fFactories);
191 AliCDBStorageFactory* factory=0;
193 // loop on the list of registered factories
194 while ((factory = (AliCDBStorageFactory*) iter.Next())) {
196 // each factory tries to create its storage from the parameter
197 aStorage = factory->Create(param);
199 PutActiveStorage(param->CloneParam(), aStorage);
200 aStorage->SetURI(param->GetURI());
202 aStorage->QueryCDB(fRun);
208 AliError(Form("Failed to activate requested storage! Check URI: %s", param->GetURI().Data()));
213 //_____________________________________________________________________________
214 AliCDBStorage* AliCDBManager::GetActiveStorage(const AliCDBParam* param) {
215 // get a storage object from the list of active storages
217 return dynamic_cast<AliCDBStorage*> (fActiveStorages.GetValue(param));
220 //_____________________________________________________________________________
221 TList* AliCDBManager::GetActiveStorages() {
222 // return list of active storages
223 // user has responsibility to delete returned object
225 TList* result = new TList();
227 TIter iter(fActiveStorages.GetTable());
229 while ((aPair = (TPair*) iter.Next())) {
230 result->Add(aPair->Value());
236 //_____________________________________________________________________________
237 void AliCDBManager::SetDrain(const char* dbString) {
238 // set drain storage from URI string
240 fDrainStorage = GetStorage(dbString);
243 //_____________________________________________________________________________
244 void AliCDBManager::SetDrain(const AliCDBParam* param) {
245 // set drain storage from AliCDBParam
247 fDrainStorage = GetStorage(param);
250 //_____________________________________________________________________________
251 void AliCDBManager::SetDrain(AliCDBStorage* storage) {
252 // set drain storage from another active storage
254 fDrainStorage = storage;
257 //_____________________________________________________________________________
258 Bool_t AliCDBManager::Drain(AliCDBEntry *entry) {
259 // drain retrieved object to drain storage
261 AliDebug(2, "Draining into drain storage...");
262 return fDrainStorage->Put(entry);
265 //_____________________________________________________________________________
266 void AliCDBManager::SetDefaultStorage(const char* dbString) {
267 // sets default storage from URI string
269 AliInfo(Form("Setting Default storage to: %s",dbString));
270 fDefaultStorage = GetStorage(dbString);
273 //_____________________________________________________________________________
274 void AliCDBManager::SetDefaultStorage(const AliCDBParam* param) {
275 // set default storage from AliCDBParam object
277 fDefaultStorage = GetStorage(param);
280 //_____________________________________________________________________________
281 void AliCDBManager::SetDefaultStorage(AliCDBStorage* storage) {
282 // set default storage from another active storage
284 fDefaultStorage = storage;
287 //_____________________________________________________________________________
288 void AliCDBManager::SetSpecificStorage(const char* calibType, const char* dbString) {
289 // sets storage specific for detector or calibration type (works with AliCDBManager::Get(...))
291 AliCDBParam *aPar = CreateParameter(dbString);
293 SetSpecificStorage(calibType, aPar);
297 //_____________________________________________________________________________
298 void AliCDBManager::SetSpecificStorage(const char* calibType, AliCDBParam* param) {
299 // sets storage specific for detector or calibration type (works with AliCDBManager::Get(...))
300 // Default storage should be defined prior to any specific storages, e.g.:
301 // AliCDBManager::instance()->SetDefaultStorage("alien://");
302 // AliCDBManager::instance()->SetSpecificStorage("TPC/*","local://DB_TPC");
303 // AliCDBManager::instance()->SetSpecificStorage("*/Align/*","local://DB_TPCAlign");
304 // calibType must be a valid CDB path! (3 level folder structure)
306 if(!fDefaultStorage) {
307 AliError("Please activate a default storage first!");
311 AliCDBPath aPath(calibType);
312 if(!aPath.IsValid()){
313 AliError(Form("Not a valid path: %s", calibType));
317 TObjString *objCalibType = new TObjString(aPath.GetPath());
318 if(fSpecificStorages.Contains(objCalibType)){
319 AliWarning(Form("Storage \"%s\" already activated! It will be replaced by the new one",
321 AliCDBParam *checkPar = dynamic_cast<AliCDBParam*> (fSpecificStorages.GetValue(calibType));
322 if(checkPar) delete checkPar;
323 delete fSpecificStorages.Remove(objCalibType);
326 fSpecificStorages.Add(objCalibType, param->CloneParam());
329 //_____________________________________________________________________________
330 AliCDBStorage* AliCDBManager::GetSpecificStorage(const char* calibType) {
331 // get storage specific for detector or calibration type
333 AliCDBPath calibPath(calibType);
334 if(!calibPath.IsValid()) return NULL;
336 AliCDBParam *checkPar = (AliCDBParam*) fSpecificStorages.GetValue(calibPath.GetPath());
338 AliError(Form("%s storage not found!", calibType));
341 return GetStorage(checkPar);
346 //_____________________________________________________________________________
347 AliCDBParam* AliCDBManager::SelectSpecificStorage(const TString& path) {
348 // select storage valid for path from the list of specific storages
350 AliCDBPath aPath(path);
351 if(!aPath.IsValid()) return NULL;
353 TIter iter(&fSpecificStorages);
354 TObjString *aCalibType=0;
356 while((aCalibType = (TObjString*) iter.Next())){
357 AliCDBPath calibTypePath(aCalibType->GetName());
358 if(calibTypePath.Comprises(aPath)) {
359 aPar = (AliCDBParam*) fSpecificStorages.GetValue(aCalibType);
366 //_____________________________________________________________________________
367 AliCDBEntry* AliCDBManager::Get(const AliCDBPath& path, Int_t runNumber,
368 Int_t version, Int_t subVersion) {
369 // get an AliCDBEntry object from the database
372 // RunNumber is not specified. Try with fRun
374 AliError("Run number neither specified in query nor set in AliCDBManager! Use AliCDBManager::SetRun.");
380 return Get(AliCDBId(path, runNumber, runNumber, version, subVersion));
383 //_____________________________________________________________________________
384 AliCDBEntry* AliCDBManager::Get(const AliCDBPath& path,
385 const AliCDBRunRange& runRange, Int_t version,
387 // get an AliCDBEntry object from the database!
389 return Get(AliCDBId(path, runRange, version, subVersion));
392 //_____________________________________________________________________________
393 AliCDBEntry* AliCDBManager::Get(const AliCDBId& query) {
394 // get an AliCDBEntry object from the database
396 if(!fDefaultStorage) {
397 AliError("No storage set!");
401 // check if query's path and runRange are valid
402 // query is invalid also if version is not specified and subversion is!
403 if (!query.IsValid()) {
404 AliError(Form("Invalid query: %s", query.ToString().Data()));
408 // query is not specified if path contains wildcard or run range= [-1,-1]
409 if (!query.IsSpecified()) {
410 AliError(Form("Unspecified query: %s",
411 query.ToString().Data()));
415 if(fCache && query.GetFirstRun() != fRun)
416 AliWarning("Run number explicitly set in query: CDB cache temporarily disabled!");
419 AliCDBEntry *entry=0;
421 // first look into map of cached objects
422 if(fCache && query.GetFirstRun() == fRun)
423 entry = (AliCDBEntry*) fEntryCache.GetValue(query.GetPath());
426 AliDebug(2, Form("Object %s retrieved from cache !!",query.GetPath().Data()));
430 // Entry is not in cache -> retrieve it from CDB and cache it!!
431 AliCDBStorage *aStorage=0;
432 AliCDBParam *aPar=SelectSpecificStorage(query.GetPath());
435 aStorage=GetStorage(aPar);
436 TString str = aPar->GetURI();
437 AliDebug(2,Form("Looking into storage: %s",str.Data()));
440 aStorage=GetDefaultStorage();
441 AliDebug(2,"Looking into default storage");
444 entry = aStorage->Get(query);
445 if (!entry) return NULL;
447 if(fCache && (query.GetFirstRun() == fRun)){
448 AliDebug(2,Form("Caching entry %s !",query.GetPath().Data()));
449 CacheEntry(query.GetPath(), entry);
456 //_____________________________________________________________________________
457 TList* AliCDBManager::GetAll(const AliCDBPath& path, Int_t runNumber,
458 Int_t version, Int_t subVersion) {
459 // get multiple AliCDBEntry objects from the database
462 // RunNumber is not specified. Try with fRun
464 AliError("Run number neither specified in query nor set in AliCDBManager! Use AliCDBManager::SetRun.");
470 return GetAll(AliCDBId(path, runNumber, runNumber, version,
474 //_____________________________________________________________________________
475 TList* AliCDBManager::GetAll(const AliCDBPath& path,
476 const AliCDBRunRange& runRange, Int_t version, Int_t subVersion) {
477 // get multiple AliCDBEntry objects from the database
479 return GetAll(AliCDBId(path, runRange, version, subVersion));
482 //_____________________________________________________________________________
483 TList* AliCDBManager::GetAll(const AliCDBId& query) {
484 // get multiple AliCDBEntry objects from the database
485 // Warning: this method works correctly only for queries of the type "Detector/*"
486 // and not for more specific queries e.g. "Detector/Calib/*" !
487 // Warning #2: Entries are cached, but GetAll will keep on retrieving objects from OCDB!
488 // To get an object from cache use Get() function
490 if(!fDefaultStorage) {
491 AliError("No storage set!");
495 if (!query.IsValid()) {
496 AliError(Form("Invalid query: %s", query.ToString().Data()));
500 if((fSpecificStorages.GetEntries()>0) && query.GetPath().BeginsWith('*')){
501 // if specific storages are active a query with "*" is ambiguous
502 AliError("Query too generic in this context!");
506 if (query.IsAnyRange()) {
507 AliError(Form("Unspecified run or runrange: %s",
508 query.ToString().Data()));
512 TObjString objStrLev0(query.GetLevel0());
513 //AliCDBParam *aPar = (AliCDBParam*) fSpecificStorages.GetValue(&objStrLev0);
514 AliCDBParam *aPar=SelectSpecificStorage(query.GetPath());
516 AliCDBStorage *aStorage;
518 aStorage=GetStorage(aPar);
519 TString str = aPar->GetURI();
520 AliDebug(2,Form("Looking into storage: %s",str.Data()));
523 aStorage=GetDefaultStorage();
524 AliDebug(2,"Looking into default storage");
527 TList *result = aStorage->GetAll(query);
528 if(!result) return 0;
531 if(fCache && (query.GetFirstRun() == fRun)){
534 AliCDBEntry* entry=0;
535 while((entry = dynamic_cast<AliCDBEntry*> (iter.Next()))){
536 const AliCDBId& anId = entry->GetId();
537 AliDebug(2,Form("Caching entry %s !", anId.GetPath().Data()));
538 CacheEntry(anId.GetPath(), entry);
545 //_____________________________________________________________________________
546 Bool_t AliCDBManager::Put(TObject* object, AliCDBId& id, AliCDBMetaData* metaData, DataType type){
547 // store an AliCDBEntry object into the database
549 AliCDBEntry anEntry(object, id, metaData);
550 return Put(&anEntry, type);
555 //_____________________________________________________________________________
556 Bool_t AliCDBManager::Put(AliCDBEntry* entry, DataType type){
557 // store an AliCDBEntry object into the database
559 if(type == kPrivate && !fDefaultStorage) {
560 AliError("No storage set!");
565 AliError("No entry!");
569 if (!entry->GetId().IsValid()) {
570 AliError(Form("Invalid entry ID: %s",
571 entry->GetId().ToString().Data()));
575 if (!entry->GetId().IsSpecified()) {
576 AliError(Form("Unspecified entry ID: %s",
577 entry->GetId().ToString().Data()));
581 AliCDBId id = entry->GetId();
582 AliCDBParam *aPar = SelectSpecificStorage(id.GetPath());
584 AliCDBStorage *aStorage=0;
587 aStorage=GetStorage(aPar);
591 aStorage = GetStorage(fCondParam);
594 aStorage = GetStorage(fRefParam);
597 aStorage = GetDefaultStorage();
602 AliDebug(2,Form("Storing object into storage: %s", aStorage->GetURI().Data()));
604 Bool_t result = aStorage->Put(entry, type);
606 if(fRun >= 0) QueryCDB();
613 //_____________________________________________________________________________
614 void AliCDBManager::CacheEntry(const char* path, AliCDBEntry* entry)
616 // cache AliCDBEntry. Cache is valid until run number is changed.
618 AliDebug(2,Form("Filling cache with entry %s",path));
619 fEntryCache.Add(new TObjString(path), entry);
620 AliDebug(2,Form("Cache entries: %d",fEntryCache.GetEntries()));
624 //_____________________________________________________________________________
625 void AliCDBManager::Print(Option_t* /*option*/) const
627 // Print list of active storages and their URIs
629 TString output=Form("Run number = %d; ",fRun);
630 output += "Cache is ";
631 if(!fCache) output += "NOT ";
632 output += Form("ACTIVE; Number of active storages: %d\n",fActiveStorages.GetEntries());
634 if(fDefaultStorage) {
635 output += Form("\t*** Default Storage URI: \"%s\"\n",fDefaultStorage->GetURI().Data());
636 // AliInfo(output.Data());
638 if(fSpecificStorages.GetEntries()>0) {
639 TIter iter(fSpecificStorages.GetTable());
642 while((aPair = (TPair*) iter.Next())){
643 output += Form("\t*** Specific storage %d: Path \"%s\" -> URI \"%s\"\n",
644 i++, ((TObjString*) aPair->Key())->GetName(),
645 ((AliCDBParam*) aPair->Value())->GetURI().Data());
649 output += Form("*** Drain Storage URI: %s\n",fDrainStorage->GetURI().Data());
651 AliInfo(output.Data());
654 //_____________________________________________________________________________
655 void AliCDBManager::SetRun(Int_t run)
657 // Sets current run number.
658 // When the run number changes the caching is cleared.
668 //_____________________________________________________________________________
669 void AliCDBManager::ClearCache(){
670 // clear AliCDBEntry cache
672 AliDebug(2,Form("Clearing cache!"));
673 fEntryCache.DeleteAll();
674 AliDebug(2,Form("Cache entries: %d",fEntryCache.GetEntries()));
678 //_____________________________________________________________________________
679 void AliCDBManager::UnloadFromCache(const char* path){
680 // unload cached object
682 AliCDBPath queryPath(path);
683 if(!queryPath.IsValid()) return;
685 if(!queryPath.IsWildcard()) { // path is not wildcard, get it directly from the cache and unload it!
686 if(fEntryCache.Contains(path)){
687 AliInfo(Form("Unloading object \"%s\" from cache", path));
688 TObjString pathStr(path);
689 AliCDBEntry *entry = dynamic_cast<AliCDBEntry*> (fEntryCache.GetValue(&pathStr));
690 if(entry) delete entry;
691 delete fEntryCache.Remove(&pathStr);
693 AliError(Form("Cache does not contain object \"%s\"!", path))
695 AliDebug(2,Form("Cache entries: %d",fEntryCache.GetEntries()));
699 // path is wildcard: loop on the cache and unload all comprised objects!
700 TIter iter(fEntryCache.GetTable());
703 while((pair = dynamic_cast<TPair*> (iter.Next()))){
704 AliCDBPath entryPath = pair->Key()->GetName();
705 if(queryPath.Comprises(entryPath)) {
706 AliInfo(Form("Unloading object \"%s\" from cache", entryPath.GetPath().Data()));
707 TObjString pathStr(entryPath.GetPath().Data());
708 AliCDBEntry *entry = dynamic_cast<AliCDBEntry*> (fEntryCache.GetValue(&pathStr));
709 if(entry) delete entry;
710 delete fEntryCache.Remove(&pathStr);
713 AliDebug(2,Form("Cache entries: %d",fEntryCache.GetEntries()));
716 //_____________________________________________________________________________
717 void AliCDBManager::DestroyActiveStorages() {
718 // delete list of active storages
720 fActiveStorages.DeleteAll();
721 fSpecificStorages.DeleteAll();
724 //_____________________________________________________________________________
725 void AliCDBManager::DestroyActiveStorage(AliCDBStorage* /*storage*/) {
726 // destroys active storage
729 TIter iter(fActiveStorages.GetTable());
731 while ((aPair = (TPair*) iter.Next())) {
732 if(storage == (AliCDBStorage*) aPair->Value())
733 delete fActiveStorages.Remove(aPair->Key());
734 storage->Delete(); storage=0x0;
740 //_____________________________________________________________________________
741 void AliCDBManager::QueryCDB() {
742 // query default and specific storages for files valid for fRun. Every storage loads the Ids into its list.
745 AliError("Run number not yet set! Use AliCDBManager::SetRun.");
748 if (!fDefaultStorage){
749 AliError("Default storage is not set! Use AliCDBManager::SetDefaultStorage");
752 if(fDefaultStorage->GetType() == "alien"){
753 fDefaultStorage->QueryCDB(fRun);
755 AliDebug(2,"Skipping query for valid files, it used only in grid...");
758 TIter iter(&fSpecificStorages);
759 TObjString *aCalibType=0;
761 while((aCalibType = dynamic_cast<TObjString*> (iter.Next()))){
762 aPar = (AliCDBParam*) fSpecificStorages.GetValue(aCalibType);
764 AliDebug(2,Form("Querying specific storage %s",aCalibType->GetName()));
765 AliCDBStorage *aStorage = GetStorage(aPar);
766 if(aStorage->GetType() == "alien"){
767 aStorage->QueryCDB(fRun,aCalibType->GetName());
770 "Skipping query for valid files, it is used only in grid...");
776 //______________________________________________________________________________________________
777 const char* AliCDBManager::GetDataTypeName(DataType type)
779 // returns the name (string) of the data type
782 case kCondition: return "Conditions";
783 case kReference: return "Reference";
784 case kPrivate: return "Private";
790 ///////////////////////////////////////////////////////////
791 // AliCDBManager Parameter class //
792 // interface to specific AliCDBParameter class //
793 // (AliCDBGridParam, AliCDBLocalParam, AliCDBDumpParam) //
794 ///////////////////////////////////////////////////////////
796 AliCDBParam::AliCDBParam():
804 //_____________________________________________________________________________
805 AliCDBParam::~AliCDBParam() {