YACS::ENGINE::SalomeContainerToolsBase Class Reference

#include <SalomeContainerTools.hxx>

Inheritance diagram for YACS::ENGINE::SalomeContainerToolsBase:

Public Member Functions
virtual	~SalomeContainerToolsBase ()
virtual std::string	getProperty (const std::string &name) const =0
virtual void	setProperty (const std::string &name, const std::string &value)=0
virtual const std::map< std::string, std::string > &	getProperties () const =0
virtual std::map< std::string, std::string >	getResourceProperties (const std::string &name) const =0
virtual void	clearProperties ()=0
virtual void	addToComponentList (const std::string &name)=0
virtual void	addToResourceList (const std::string &name)=0
virtual Engines::ContainerParameters	getParameters () const =0
virtual void	setContainerName (const std::string &name)=0
virtual std::string	getHostName () const =0
virtual std::string	getNotNullContainerName (const Container *contPtr, const Task *askingNode, bool &isEmpty) const =0
virtual std::string	getContainerName () const =0
virtual int	getNumberOfCoresPerWorker () const =0

Static Public Member Functions
static void	SetContainerNameOf (Engines::ContainerParameters &params, const std::string &name)
static void	Start (const std::vector< std::string > &compoNames, SalomeContainerHelper *schelp, SalomeContainerToolsBase &sct, int &shutdownLevel, const Container *cont, const Task *askingNode)
static CORBA::Object_ptr	LoadComponent (SalomeContainerHelper *launchModeType, Container *cont, Task *askingNode)
static CORBA::Object_ptr	CreateComponentInstance (Container *cont, Engines::Container_ptr contPtr, const ComponentInstance *inst)
static std::string	GetPlacementId (const SalomeContainerHelper *launchModeType, const Container *cont, const Task *askingNode)
static std::string	GetFullPlacementId (const SalomeContainerHelper *launchModeType, const Container *cont, const Task *askingNode)

Detailed Description

Definition at line 39 of file SalomeContainerTools.hxx.

Constructor & Destructor Documentation

~SalomeContainerToolsBase()

virtual YACS::ENGINE::SalomeContainerToolsBase::~SalomeContainerToolsBase ( )

inlinevirtual

Definition at line 42 of file SalomeContainerTools.hxx.

{ }

Member Function Documentation

addToComponentList()

virtual void YACS::ENGINE::SalomeContainerToolsBase::addToComponentList ( const std::string &  name )

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

Referenced by Start().

addToResourceList()

virtual void YACS::ENGINE::SalomeContainerToolsBase::addToResourceList ( const std::string &  name )

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

clearProperties()

virtual void YACS::ENGINE::SalomeContainerToolsBase::clearProperties ( )

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

CreateComponentInstance()

CORBA::Object_ptr SalomeContainerToolsBase::CreateComponentInstance ( Container *  cont, Engines::Container_ptr  contPtr, const ComponentInstance *  inst  )

static

Definition at line 475 of file SalomeContainerTools.cxx.

{
  if(!inst)
    throw Exception("SalomeContainerToolsBase::CreateComponentInstance : no instance of component in the task requesting for a load of its component !");
  char *reason(0);
  std::string compoName(inst->getCompoName());
  CORBA::Object_ptr objComponent=CORBA::Object::_nil();
  Proc* p(cont->getProc());
  // prepare component instance properties
  Engines::FieldsDict_var env(new Engines::FieldsDict);
  std::map<std::string, std::string> properties(inst->getProperties());
  if(p)
    {
      std::map<std::string,std::string> procMap=p->getProperties();
      properties.insert(procMap.begin(),procMap.end());
    }
 
  std::map<std::string, std::string>::const_iterator itm;
  env->length(properties.size());
  int item=0;
  for(itm = properties.begin(); itm != properties.end(); ++itm, item++)
    {
      DEBUG_YACSTRACE("envname="<<itm->first<<" envvalue="<< itm->second);
      env[item].key= CORBA::string_dup(itm->first.c_str());
      env[item].value <<= itm->second.c_str();
    }
 
  objComponent=contPtr->create_component_instance_env(compoName.c_str(), env, reason);
  if(CORBA::is_nil(objComponent))
    {
      std::string text="Error while trying to create a new component: component '"+ compoName;
      text=text+"' is not installed or it's a wrong name";
      text += '\n';
      text += reason;
      CORBA::string_free(reason);
      throw Exception(text);
    }
  return objComponent;
}

References DEBUG_YACSTRACE, YACS::ENGINE::ComponentInstance::getCompoName(), YACS::ENGINE::Container::getProc(), YACS::ENGINE::Node::getProperties(), YACS::ENGINE::PropertyInterface::getProperties(), and p.

Referenced by LoadComponent(), and YACS::ENGINE::SalomeContainerTmpForHP::loadComponent().

getContainerName()

virtual std::string YACS::ENGINE::SalomeContainerToolsBase::getContainerName ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

GetFullPlacementId()

std::string SalomeContainerToolsBase::GetFullPlacementId ( const SalomeContainerHelper *  launchModeType, const Container *  cont, const Task *  askingNode  )

static

Definition at line 535 of file SalomeContainerTools.cxx.

{
  if(cont->isAlreadyStarted(askingNode))
    {
      Engines::Container_var container(launchModeType->getContainer(askingNode));
      try
      {
          CORBA::String_var corbaStr(container->name());
          std::string ret(corbaStr);
          return ret;
      }
      catch(...)
      {
          return "Unknown_placement";
      }
    }
  else
    return "Not_placed_yet";
}

References YACS::ENGINE::SalomeContainerHelper::getContainer(), and YACS::ENGINE::Container::isAlreadyStarted().

Referenced by YACS::ENGINE::SalomeContainer::getFullPlacementId(), and YACS::ENGINE::SalomeHPContainer::getFullPlacementId().

getHostName()

virtual std::string YACS::ENGINE::SalomeContainerToolsBase::getHostName ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

Referenced by Start().

getNotNullContainerName()

virtual std::string YACS::ENGINE::SalomeContainerToolsBase::getNotNullContainerName ( const Container *  contPtr, const Task *  askingNode, bool &  isEmpty  ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

Referenced by Start().

getNumberOfCoresPerWorker()

virtual int YACS::ENGINE::SalomeContainerToolsBase::getNumberOfCoresPerWorker ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

getParameters()

virtual Engines::ContainerParameters YACS::ENGINE::SalomeContainerToolsBase::getParameters ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

Referenced by YACS::ENGINE::SalomeContainerToolsDecorator::getParameters(), and Start().

GetPlacementId()

std::string SalomeContainerToolsBase::GetPlacementId ( const SalomeContainerHelper *  launchModeType, const Container *  cont, const Task *  askingNode  )

static

Definition at line 515 of file SalomeContainerTools.cxx.

{
  if(cont->isAlreadyStarted(askingNode))
    {
      Engines::Container_var container(launchModeType->getContainer(askingNode));
      const char *what="/";
      CORBA::String_var corbaStr(container->name());
      std::string ret(corbaStr);
 
      //Salome FOREVER ...
      std::string::size_type i=ret.find_first_of(what,0);
      i=ret.find_first_of(what, i==std::string::npos ? i:i+1);
      if(i!=std::string::npos)
        return ret.substr(i+1);
      return ret;
    }
  else
    return "Not placed yet !!!";
}

References YACS::ENGINE::SalomeContainerHelper::getContainer(), yacsorb.CORBAEngineTest::i, and YACS::ENGINE::Container::isAlreadyStarted().

Referenced by YACS::ENGINE::SalomeContainer::getPlacementId(), and YACS::ENGINE::SalomeHPContainer::getPlacementId().

getProperties()

virtual const std::map< std::string, std::string > & YACS::ENGINE::SalomeContainerToolsBase::getProperties ( ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

getProperty()

virtual std::string YACS::ENGINE::SalomeContainerToolsBase::getProperty ( const std::string &  name ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

getResourceProperties()

virtual std::map< std::string, std::string > YACS::ENGINE::SalomeContainerToolsBase::getResourceProperties ( const std::string &  name ) const

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

LoadComponent()

CORBA::Object_ptr SalomeContainerToolsBase::LoadComponent ( SalomeContainerHelper *  launchModeType, Container *  cont, Task *  askingNode  )

static

Definition at line 450 of file SalomeContainerTools.cxx.

{
  DEBUG_YACSTRACE("SalomeContainer::loadComponent ");
  const ComponentInstance *inst(askingNode?askingNode->getComponent():0);
  {
    YACS::BASES::AutoLocker<Container> alck(cont);//To be sure
    if(!cont->isAlreadyStarted(askingNode))
      cont->start(askingNode);
  }
  if(!inst)
    throw Exception("SalomeContainerToolsBase::LoadComponent : no instance of component in the task requesting for a load of its component !");
  CORBA::Object_ptr objComponent=CORBA::Object::_nil();
  {
    YACS::BASES::AutoLocker<Container> alck(cont);//To be sure
    std::string compoName(inst->getCompoName());
    Engines::Container_var container(launchModeType->getContainer(askingNode));
 
    char *reason;
    bool isLoadable(container->load_component_Library(compoName.c_str(), reason));
    if(isLoadable)
      objComponent=CreateComponentInstance(cont,container,inst);
  }
  return objComponent;
}

References CreateComponentInstance(), DEBUG_YACSTRACE, YACS::ENGINE::ComponentInstance::getCompoName(), YACS::ENGINE::Task::getComponent(), YACS::ENGINE::SalomeContainerHelper::getContainer(), YACS::ENGINE::Container::isAlreadyStarted(), and YACS::ENGINE::Container::start().

Referenced by YACS::ENGINE::SalomeContainer::loadComponent().

setContainerName()

virtual void YACS::ENGINE::SalomeContainerToolsBase::setContainerName ( const std::string &  name )

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

SetContainerNameOf()

void SalomeContainerToolsBase::SetContainerNameOf ( Engines::ContainerParameters &  params, const std::string &  name  )

static

Definition at line 272 of file SalomeContainerTools.cxx.

{
  params.container_name=CORBA::string_dup(name.c_str());
}

Referenced by YACS::ENGINE::SalomeContainerTools::setContainerName(), and Start().

setProperty()

virtual void YACS::ENGINE::SalomeContainerToolsBase::setProperty ( const std::string &  name, const std::string &  value  )

pure virtual

Implemented in YACS::ENGINE::SalomeContainerTools, and YACS::ENGINE::SalomeContainerToolsDecorator.

Start()

void SalomeContainerToolsBase::Start ( const std::vector< std::string > &  compoNames, SalomeContainerHelper *  schelp, SalomeContainerToolsBase &  sct, int &  shutdownLevel, const Container *  cont, const Task *  askingNode  )

static

Parameters

[in]	compoNames
[in,out]	shutdownLevel

Definition at line 321 of file SalomeContainerTools.cxx.

{
  CORBA::ORB_ptr orb(getSALOMERuntime()->getOrb());
  SALOME_NamingService_Wrapper ns;
  try
  {
      ns.init_orb(orb);
  }
  catch(SALOME_Exception& e)
  {
      throw Exception("SalomeContainer::start : Unable to contact the SALOME Naming Service");
  }
  CORBA::Object_var obj(ns.Resolve(SALOME_ContainerManager::_ContainerManagerNameInNS));
  Engines::ContainerManager_var contManager(Engines::ContainerManager::_narrow(obj));
 
  bool isEmptyName;
  std::string str(sct.getNotNullContainerName(cont,askingNode,isEmptyName));
  DEBUG_YACSTRACE("SalomeContainer::start " << str <<";"<< sct.getHostName() );
 
  // Finalize parameters with components found in the container
 
  for(std::vector<std::string>::const_iterator iter=compoNames.begin();iter!=compoNames.end();iter++)
    sct.addToComponentList(*iter);
 
  Engines::ContainerParameters myparams(sct.getParameters());
  {
    std::string dftLauchMode(schelp->getDftLaunchMode());
    myparams.mode=CORBA::string_dup(dftLauchMode.c_str());
  }
 
  //If a container_name is given try to find an already existing container in naming service
  //If not found start a new container with the given parameters
  if (dynamic_cast<SalomeContainerMonoHelper *>(schelp) && !isEmptyName)
    {
      myparams.mode=CORBA::string_dup("getorstart");
    }
 
  if (isEmptyName)
    {
      shutdownLevel=1;
    }
  //sct.setContainerName(str);
  SetContainerNameOf(myparams,str);
  Engines::Container_var trueCont(Engines::Container::_nil());
  if(!isEmptyName && shutdownLevel==999)
    {
      //Make this only the first time start is called (_shutdownLevel==999)
      //If the container is named, first try to get an existing container
      //If there is an existing container use it and set the shutdown level to 3
      //If there is no existing container, try to launch a new one and set the shutdown level to 2
      myparams.mode="get";
      try
      {
          DEBUG_YACSTRACE("GiveContainer " << str << " mode " << myparams.mode);
          trueCont=contManager->GiveContainer(myparams);
      }
      catch( const SALOME::SALOME_Exception& ex )
      {
          std::string msg="SalomeContainer::start : no existing container : ";
          msg += '\n';
          msg += ex.details.text.in();
          DEBUG_YACSTRACE( msg );
      }
      catch(...)
      {
      }
 
      if(!CORBA::is_nil(trueCont))
        {
          shutdownLevel=3;
          DEBUG_YACSTRACE( "container found: " << str << " " << shutdownLevel );
        }
      else
        {
          shutdownLevel=2;
          myparams.mode="start";
          DEBUG_YACSTRACE( "container not found: " << str << " " << shutdownLevel);
        }
    }
 
  int nbTries=0;
  while(CORBA::is_nil(trueCont))
  {
    try
    {
          // --- GiveContainer is used in batch mode to retreive launched containers,
          //     and is equivalent to StartContainer when not in batch.
          DEBUG_YACSTRACE("GiveContainer " << str << " mode " << myparams.mode);
          trueCont=contManager->GiveContainer(myparams);
    }
    catch( const SALOME::SALOME_Exception& ex )
    {
        std::string msg="SalomeContainer::start : Unable to launch container in Salome : ";
        msg += '\n';
        msg += ex.details.text.in();
        throw Exception(msg);
    }
    catch(CORBA::COMM_FAILURE&)
    {
      //std::cerr << "SalomeContainer::start : CORBA Comm failure detected. Make another try!" << std::endl;
      DEBUG_YACSTRACE("SalomeContainer::start :" << str << " :CORBA Comm failure detected. Make another try!");
      nbTries++;
      if(nbTries > 5)
      {
        std::ostringstream oss; oss << "SalomeContainer::start : Unable to launch container " << myparams.container_name << " in Salome : CORBA Comm failure detected";
        throw Exception( oss.str() );
      }
    }
    catch(CORBA::Exception&)
    {
      std::ostringstream oss; oss << "SalomeContainer::start : Unable to launch container " << myparams.container_name << " in Salome : Unexpected CORBA failure detected";
      throw Exception( oss.str() );
    }
  }
 
  if(CORBA::is_nil(trueCont))
  {
    std::ostringstream oss; oss << "SalomeContainer::start : Unable to launch container " << myparams.container_name << " in Salome. Check your CatalogResources.xml file";
    throw Exception( oss.str() );
  }
 
  // TODO : thread safety!
  schelp->setContainer(askingNode,trueCont);
 
  CORBA::String_var containerName(trueCont->name()),hostName(trueCont->getHostName());
  //std::cerr << "SalomeContainer launched : " << containerName << " " << hostName << " " << trueCont->getPID() << std::endl;
  DEBUG_YACSTRACE("SalomeContainer launched : NS entry : " << containerName << " PID : " << trueCont->getPID() );
}

References addToComponentList(), DEBUG_YACSTRACE, testCppPluginInvokation::ex, YACS::ENGINE::SalomeContainerHelper::getDftLaunchMode(), getHostName(), getNotNullContainerName(), getParameters(), YACS::ENGINE::getSALOMERuntime(), SALOME_NamingService_Wrapper::init_orb(), orb, SALOME_NamingService_Wrapper::Resolve(), YACS::ENGINE::SalomeContainerHelper::setContainer(), and SetContainerNameOf().

Referenced by YACS::ENGINE::SalomeHPContainer::start(), and YACS::ENGINE::SalomeContainer::start().

---

The documentation for this class was generated from the following files:

• src/runtime/SalomeContainerTools.hxx
• src/runtime/SalomeContainerTools.cxx