HLT/BASE/AliHLTComponentHandler.cxx

   1 // $Id$
   2
   3 /**************************************************************************
   4  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   5  *                                                                        *
   6  * Authors: Matthias Richter <Matthias.Richter@ift.uib.no>                *
   7  *          Timm Steinbeck <timm@kip.uni-heidelberg.de>                   *
   8  *          for The ALICE Off-line Project.                               *
   9  *                                                                        *
  10  * Permission to use, copy, modify and distribute this software and its   *
  11  * documentation strictly for non-commercial purposes is hereby granted   *
  12  * without fee, provided that the above copyright notice appears in all   *
  13  * copies and that both the copyright notice and this permission notice   *
  14  * appear in the supporting documentation. The authors make no claims     *
  15  * about the suitability of this software for any purpose. It is          *
  16  * provided "as is" without express or implied warranty.                  *
  17  **************************************************************************/
  18
  19 /** @file   AliHLTComponentHandler.cxx
  20     @author Matthias Richter, Timm Steinbeck
  21     @date
  22     @brief  Implementation of HLT component handler. */
  23
  24 #if __GNUC__>= 3
  25 using namespace std;
  26 #endif
  27 //#undef HAVE_DLFCN_H
  28 #ifdef HAVE_DLFCN_H
  29 #include <dlfcn.h>
  30 #else
  31 //#include <Riostream.h>
  32 #include <TSystem.h>
  33 #endif //HAVE_DLFCN_H
  34 #include "AliHLTStdIncludes.h"
  35 #include "AliHLTComponentHandler.h"
  36 #include "AliHLTComponent.h"
  37 #include "AliHLTDataTypes.h"
  38 #include "AliHLTSystem.h"
  39
  40 // the standard components
  41 // #include "AliHLTFilePublisher.h"
  42 #include "AliHLTFileWriter.h"
  43 // #include "AliHLTRootFilePublisherComponent.h"
  44 // #include "AliHLTRootFileWriterComponent.h"
  45
  46 /** ROOT macro for the implementation of ROOT specific class methods */
  47 ClassImp(AliHLTComponentHandler)
  48
  49 AliHLTComponentHandler::AliHLTComponentHandler()
  50   :
  51   fComponentList(),
  52   fScheduleList(),
  53   fLibraryList(),
  54   fEnvironment(),
  55   fStandardList()
  56 {
  57   // see header file for class documentation
  58   // or
  59   // refer to README to build package
  60   // or
  61   // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
  62   memset(&fEnvironment, 0, sizeof(AliHLTComponentEnvironment));
  63   AddStandardComponents();
  64 }
  65
  66 AliHLTComponentHandler::AliHLTComponentHandler(AliHLTComponentEnvironment* pEnv)
  67   :
  68   fComponentList(),
  69   fScheduleList(),
  70   fLibraryList(),
  71   fEnvironment(),
  72   fStandardList()
  73 {
  74   // see header file for class documentation
  75   if (pEnv) {
  76     memcpy(&fEnvironment, pEnv, sizeof(AliHLTComponentEnvironment));
  77     if (pEnv->fLoggingFunc) {
  78       // the AliHLTLogging::Init method also sets the stream output
  79       // and notification handler to AliLog. This should only be done
  80       // if the logging environment contains a logging function
  81       // for redirection
  82       AliHLTLogging::Init(pEnv->fLoggingFunc);
  83     }
  84   }  else
  85     memset(&fEnvironment, 0, sizeof(AliHLTComponentEnvironment));
  86   AddStandardComponents();
  87 }
  88
  89 AliHLTComponentHandler::~AliHLTComponentHandler()
  90 {
  91   // see header file for class documentation
  92   UnloadLibraries();
  93   DeleteStandardComponents();
  94 }
  95
  96 int AliHLTComponentHandler::AnnounceVersion()
  97 {
  98   // see header file for class documentation
  99   int iResult=0;
 100 #ifdef PACKAGE_STRING
 101   void HLTbaseCompileInfo( char*& date, char*& time);
 102   char* date="";
 103   char* time="";
 104   HLTbaseCompileInfo(date, time);
 105   if (!date) date="unknown";
 106   if (!time) time="unknown";
 107   HLTInfo("%s build on %s (%s)", PACKAGE_STRING, date, time);
 108 #else
 109   HLTInfo("ALICE High Level Trigger (embedded AliRoot build)");
 110 #endif
 111   return iResult;
 112 }
 113
 114 Int_t AliHLTComponentHandler::RegisterComponent(AliHLTComponent* pSample)
 115 {
 116   // see header file for class documentation
 117   Int_t iResult=0;
 118   if (pSample) {
 119     if (FindComponent(pSample->GetComponentID())==NULL) {
 120       iResult=InsertComponent(pSample);
 121       if (iResult>=0) {
 122         HLTInfo("component %s registered", pSample->GetComponentID());
 123       }
 124     } else {
 125       // component already registered
 126       HLTDebug("component %s already registered, skipped", pSample->GetComponentID());
 127       iResult=-EEXIST;
 128     }
 129   } else {
 130     iResult=-EINVAL;
 131   }
 132   return iResult;
 133 }
 134
 135 int AliHLTComponentHandler::DeregisterComponent( const char* componentID )
 136 {
 137   // see header file for class documentation
 138   int iResult=0;
 139   if (componentID) {
 140   } else {
 141     iResult=-EINVAL;
 142   }
 143   return iResult;
 144 }
 145
 146 Int_t AliHLTComponentHandler::ScheduleRegister(AliHLTComponent* pSample)
 147 {
 148   // see header file for class documentation
 149   Int_t iResult=0;
 150   if (pSample) {
 151     fScheduleList.push_back(pSample);
 152   } else {
 153     iResult=-EINVAL;
 154   }
 155   return iResult;
 156 }
 157
 158 int AliHLTComponentHandler::CreateComponent(const char* componentID, void* pEnvParam, int argc, const char** argv, AliHLTComponent*& component )
 159 {
 160   // see header file for class documentation
 161   int iResult=0;
 162   if (componentID) {
 163     AliHLTComponent* pSample=FindComponent(componentID);
 164     if (pSample!=NULL) {
 165       component=pSample->Spawn();
 166       if (component) {
 167         HLTDebug("component \"%s\" created (%p)", componentID, component);
 168         if ((iResult=component->Init(&fEnvironment, pEnvParam, argc, argv))!=0) {
 169           HLTError("Initialization of component \"%s\" failed with error %d", componentID, iResult);
 170           delete component;
 171           component=NULL;
 172         }
 173       } else {
 174         HLTError("can not spawn component \"%s\"", componentID);
 175         iResult=-ENOENT;
 176       }
 177     } else {
 178       HLTWarning("can not find component \"%s\"", componentID);
 179       iResult=-ENOENT;
 180     }
 181   } else {
 182     iResult=-EINVAL;
 183   }
 184   return iResult;
 185 }
 186
 187 Int_t AliHLTComponentHandler::FindComponentIndex(const char* componentID)
 188 {
 189   // see header file for class documentation
 190   Int_t iResult=0;
 191   if (componentID) {
 192     vector<AliHLTComponent*>::iterator element=fComponentList.begin();
 193     while (element!=fComponentList.end() && iResult>=0) {
 194       if (strcmp(componentID, (*element)->GetComponentID())==0) {
 195         break;
 196       }
 197       element++;
 198       iResult++;
 199     }
 200     if (element==fComponentList.end()) iResult=-ENOENT;
 201   } else {
 202     iResult=-EINVAL;
 203   }
 204   return iResult;
 205 }
 206
 207 AliHLTComponent* AliHLTComponentHandler::FindComponent(const char* componentID)
 208 {
 209   // see header file for class documentation
 210   AliHLTComponent* pSample=NULL;
 211   Int_t index=FindComponentIndex(componentID);
 212   if (index>=0) {
 213     pSample=(AliHLTComponent*)fComponentList.at(index);
 214   }
 215   return pSample;
 216 }
 217
 218 Int_t AliHLTComponentHandler::InsertComponent(AliHLTComponent* pSample)
 219 {
 220   // see header file for class documentation
 221   Int_t iResult=0;
 222   if (pSample!=NULL) {
 223     fComponentList.push_back(pSample);
 224   } else {
 225     iResult=-EINVAL;
 226   }
 227   return iResult;
 228 }
 229
 230 void AliHLTComponentHandler::List()
 231 {
 232   // see header file for class documentation
 233   vector<AliHLTComponent*>::iterator element=fComponentList.begin();
 234   int index=0;
 235   while (element!=fComponentList.end()) {
 236     HLTInfo("%d. %s", index++, (*element++)->GetComponentID());
 237   }
 238 }
 239
 240 void AliHLTComponentHandler::SetEnvironment(AliHLTComponentEnvironment* pEnv)
 241 {
 242   // see header file for class documentation
 243   if (pEnv) {
 244     memcpy(&fEnvironment, pEnv, sizeof(AliHLTComponentEnvironment));
 245     if (fEnvironment.fLoggingFunc) {
 246       // the AliHLTLogging::Init method also sets the stream output
 247       // and notification handler to AliLog. This should only be done
 248       // if the logging environment contains a logging function
 249       // for redirection
 250       AliHLTLogging::Init(fEnvironment.fLoggingFunc);
 251     }
 252   }
 253 }
 254
 255 int AliHLTComponentHandler::LoadLibrary( const char* libraryPath )
 256 {
 257   // see header file for class documentation
 258   int iResult=0;
 259   if (libraryPath) {
 260     AliHLTComponent::SetGlobalComponentHandler(this);
 261     AliHLTLibHandle hLib=NULL;
 262 #ifdef HAVE_DLFCN_H
 263     // use interface to the dynamic linking loader
 264     hLib=dlopen(libraryPath, RTLD_NOW);
 265 #else
 266     // use ROOT dynamic loader
 267     if (gSystem->Load(libraryPath)==0) {
 268       // create TString object to store library path and use pointer as handle
 269       hLib=reinterpret_cast<AliHLTLibHandle>(new TString(libraryPath));
 270     }
 271 #endif //HAVE_DLFCN_H
 272     if (hLib) {
 273       HLTInfo("library %s loaded", libraryPath);
 274       fLibraryList.push_back(hLib);
 275       iResult=RegisterScheduledComponents();
 276     } else {
 277       HLTError("can not load library %s", libraryPath);
 278 #ifdef HAVE_DLFCN_H
 279       HLTError("dlopen error: %s", dlerror());
 280 #endif //HAVE_DLFCN_H
 281 #ifdef __APPLE__
 282       iResult=-EFTYPE;
 283 #else
 284       iResult=-ELIBACC;
 285 #endif
 286     }
 287     AliHLTComponent::UnsetGlobalComponentHandler();
 288   } else {
 289     iResult=-EINVAL;
 290   }
 291   return iResult;
 292 }
 293
 294 int AliHLTComponentHandler::UnloadLibrary( const char* libraryPath )
 295 {
 296   // see header file for class documentation
 297   int iResult=0;
 298   if (libraryPath) {
 299   } else {
 300     iResult=-EINVAL;
 301   }
 302   return iResult;
 303 }
 304
 305 int AliHLTComponentHandler::UnloadLibraries()
 306 {
 307   // see header file for class documentation
 308   int iResult=0;
 309   vector<AliHLTLibHandle>::iterator element=fLibraryList.begin();
 310   while (element!=fLibraryList.end()) {
 311 #ifdef HAVE_DLFCN_H
 312     dlclose(*element);
 313 #else
 314     TString* libraryPath=reinterpret_cast<TString*>(*element);
 315     gSystem->Unload(libraryPath->Data());
 316     delete libraryPath;
 317 #endif //HAVE_DLFCN_H
 318     element++;
 319   }
 320   return iResult;
 321 }
 322
 323 int AliHLTComponentHandler::AddStandardComponents()
 324 {
 325   // see header file for class documentation
 326   int iResult=0;
 327   AliHLTComponent::SetGlobalComponentHandler(this);
 328 //   fStandardList.push_back(new AliHLTFilePublisher);
 329   fStandardList.push_back(new AliHLTFileWriter);
 330 //   fStandardList.push_back(new AliHLTRootFilePublisherComponent);
 331 //   fStandardList.push_back(new AliHLTRootFileWriterComponent);
 332   AliHLTComponent::UnsetGlobalComponentHandler();
 333   iResult=RegisterScheduledComponents();
 334   return iResult;
 335 }
 336
 337 int AliHLTComponentHandler::RegisterScheduledComponents()
 338 {
 339   // see header file for class documentation
 340   int iResult=0;
 341   vector<AliHLTComponent*>::iterator element=fScheduleList.begin();
 342   int iLocalResult=0;
 343   while (element!=fScheduleList.end()) {
 344     iLocalResult=RegisterComponent(*element);
 345     if (iResult==0) iResult=iLocalResult;
 346     fScheduleList.erase(element);
 347     element=fScheduleList.begin();
 348   }
 349   return iResult;
 350 }
 351
 352 int AliHLTComponentHandler::DeleteStandardComponents()
 353 {
 354   // see header file for class documentation
 355   int iResult=0;
 356   vector<AliHLTComponent*>::iterator element=fStandardList.begin();
 357   while (element!=fStandardList.end()) {
 358     DeregisterComponent((*element)->GetComponentID());
 359     delete(*element);
 360     fStandardList.erase(element);
 361     element=fStandardList.begin();
 362   }
 363   return iResult;
 364 }