JobCModuleRegistry.cxx

Go to the documentation of this file.

// $Id: JobCModuleRegistry.cxx,v 1.15 2003/10/17 00:41:12 messier Exp $
//
// A place for the modules available to a given job to register
// themselves
//
// messier@huhepl.harvard.edu
#include "JobControl/JobCModuleRegistry.h"
#include <cstdio>
#include <cstring>
#include "TSystem.h" // Load() library
#include "MessageService/MsgService.h"

CVSID("$Id: JobCModuleRegistry.cxx,v 1.15 2003/10/17 00:41:12 messier Exp $");

JobCModuleRegistry* JobCModuleRegistry::fInstance = 0;

//......................................................................

ostream& operator<<(ostream& os, const JobCModuleRegistry& jcr) 
{
  list<JobCModuleProxy*>::const_iterator itrModuleTable;
  os << "Registered job modules:\n";
  for (itrModuleTable  = jcr.fModuleTable.begin();
       itrModuleTable != jcr.fModuleTable.end();
       ++itrModuleTable) {
    os << " " << 
      (*itrModuleTable)->GetName() << " - " <<
      (*itrModuleTable)->GetFunc() << "\n";
  }
  return os;
}

//......................................................................

JobCModuleRegistry::~JobCModuleRegistry() {}

//......................................................................

void JobCModuleRegistry::Register(JobCModuleProxy* proxy)
{
  const char* modName = proxy->GetName();
  // Add the module to the table
  if (this->LookUp(modName,false)) {
    // MSG("JobC", Msg::kWarning)
    // << "A job module named " << modName << " is already registered!\n"
    // << "Duplicate module names are not allowed!\n";
    return;
  }
  else {
    // Do insertions in alphabetical order
    list<JobCModuleProxy*>::iterator itrModuleTable;
    for (itrModuleTable  = fModuleTable.begin();
         itrModuleTable != fModuleTable.end();
         ++itrModuleTable) {
      if (strcmp(modName,(*itrModuleTable)->GetName())<0) {
        break;
      }
    }
    fModuleTable.insert(itrModuleTable,proxy);
#ifdef SITE_HAS_SIGC // temporary
    this->SigRegister(modName);
#endif
    MSG("JobC", Msg::kDebug) 
      << "Registered job module " << modName << " " 
      << proxy << ".\n";
  }
}

//......................................................................

JobCModuleProxy* JobCModuleRegistry::LookUp(const char *name, bool loadlib)
{
  // Check if its in table
  list<JobCModuleProxy*>::iterator itrModuleTable;
  for (itrModuleTable  = fModuleTable.begin();
       itrModuleTable != fModuleTable.end();
       ++itrModuleTable) {
    if (strcmp(name,(*itrModuleTable)->GetName())==0) {
      return (*itrModuleTable);
    }
  }
  
  // Not in table... try loading libraries
  if (loadlib && this->CheckLibMap(name)) return this->LookUp(name);

  return 0;
}

//......................................................................

JobCModuleRegistry::JobCModuleRegistry()
{
#ifdef DEBUG_JOBC
#include <MessageService/MsgStream.h>
  // Setting this debug level at run time is too late in this case...
  MsgService::Instance()->GetStream("JobC")->SetLogLevel(Msg::kVerbose);
#endif
  this->BuildModToLibMap();
}

//......................................................................

JobCModuleRegistry& JobCModuleRegistry::Instance() 
{
  static JobCModuleRegistry::Cleaner c; // end-of-run clean up
  if (fInstance==0) {
    c.ClassIsUsed(); // Keeps compiler's quite if I "use" this object
    fInstance = new JobCModuleRegistry;
  }
  return *fInstance;
}

//......................................................................

int JobCModuleRegistry::BuildModToLibMap()
{
//======================================================================
// Poke around looking for a "jobmodules.txt" file and use it to build
// the map of which libraries provide which modules
//======================================================================

  // Try to find a jobmodules file which lists which libraries provide
  // which modules
  FILE* fp = 0;
  // First try in the private release
  const char* tmp = getenv("SRT_PRIVATE_CONTEXT");
  if (!tmp) return 0;
  std::string modfile = tmp;
  modfile += "/tmp/jobmodules.txt";
  if ( (fp=fopen(modfile.c_str(),"r"))==0 ) {
    // Next, try the public release
    tmp = getenv("SRT_PUBLIC_CONTEXT");
    if (!tmp) return 0;
    std::string modfile = tmp;
    modfile += "/tmp/jobmodules.txt";
    if ( (fp=fopen(modfile.c_str(),"r"))==0 ) {
      // Finally try in /tmp
      modfile = "/tmp/jobmodules.txt";
      if ( (fp=fopen(modfile.c_str(),"r"))==0 ) {
        // Give up...
        return 0;
      }
    }
  }
  
  // To get here fp must be valid
  std::string lib = "";
  char buff[256];
  while (fgets(buff,255,fp)) {
    if (buff[0]=='#') continue;

    // Get rid of leading and training white space
    const char* b = buff;
    for (; *b==' ' && *b!='\0'; ++b);
    int len = strlen(buff)-1;
    for (; len>0 && (buff[len]==' '||buff[len]=='\n'); --len);
    buff[len+1] = '\0';
    
    // Figure out if entry is library or module
    len = strlen(b);
    if (len<2) continue;
    const char* tag = b + len - 3;
    if (strncmp(b,"lib",3)==0 && strncmp(tag, ".so",3)==0) {
      lib = b;
    }
    else {
      std::string module = b;
      if (fModLibMap[module]=="") {
        fModLibMap[module] = lib;
      }
      else {
        if (!(fModLibMap[module] == lib)) {
          MSG("JobC",Msg::kWarning) << 
            "Duplicate entry: " << 
            module << "->" << fModLibMap[module] << "," <<
            module << "->" << lib                << "." << 
            std::endl;
        }
      }
    }
  }
  fclose(fp);
  return 1;
}

//......................................................................

int JobCModuleRegistry::CheckLibMap(const std::string& module) 
{
  std::string lib = fModLibMap[module];
  if (lib=="") {
    MSG("JobC",Msg::kWarning) << 
      "\n" <<
      "Unable to find module '"<<module<<"' in job module list.\n" <<
      "Consider regenerating list with 'makemodulemap' command or\n" <<
      "edit the $SRT_PRIVATE_CONTEXT/tmp/jobmodules.txt file by hand.\n";
    return 0;
  }
  if (gSystem) {
    if (gSystem->Load(lib.c_str())==0) {
      // Loaded OK, we can remove entries pointing at this library
      std::map<std::string,std::string>::iterator itr(fModLibMap.begin());
      std::map<std::string,std::string>::iterator itrEnd(fModLibMap.end());
      for (;itr!=itrEnd;++itr) {
        if (itr->first == lib) fModLibMap.erase(itr);
      }
      return 1;
    }
  }
  return 0;
}

---