C++ implementation of Engines::Container interface for parallel container implemented with PaCO++. More...

#include <SALOME_ParallelContainer_i.hxx>

Inheritance diagram for Engines_Parallel_Container_i:

Public Member Functions
	Engines_Parallel_Container_i (CORBA::ORB_ptr orb, char *ior, int rank, PortableServer::POA_ptr poa, std::string containerName, bool isServantAloneInProcess=true)
	Construtor. More...

virtual	~Engines_Parallel_Container_i ()
	Destructor. More...

virtual bool	load_component_Library (const char *componentName, CORBA::String_out reason)
	load a new component class More...

virtual Engines::EngineComponent_ptr	create_component_instance (const char *componentName, CORBA::Long studyId)
	Create a new component instance. More...

virtual Engines::EngineComponent_ptr	create_component_instance_env (const char *componentName, CORBA::Long studyId, const Engines::FieldsDict &env, CORBA::String_out reason)
	Create a new component instance. More...

virtual char *	create_python_service_instance (const char *CompName, CORBA::String_out reason)

Engines::EngineComponent_ptr	find_component_instance (const char *registeredName, CORBA::Long studyId)
	Find an existing (in the container) component instance. More...

Engines::EngineComponent_ptr	load_impl (const char nameToRegister, const char componentName)
	Find or create a new component instance. More...

void	create_paco_component_node_instance (const char componentName, const char proxy_containerName, CORBA::Long studyId)

void	updateInstanceNumber ()

void	remove_impl (Engines::EngineComponent_ptr component_i)
	Remove the component instance from container. More...

void	finalize_removal ()
	Unload component libraries from the container. More...

virtual void	ping ()
	Ping the servant to check it is still alive. More...

char *	name ()
	Get container name. More...

char *	workingdir ()
	Get container working directory. More...

char *	logfilename ()
	Get container log file name. More...

void	logfilename (const char *name)
	Set container log file name. More...

virtual void	Shutdown ()
	Shutdown the container. More...

char *	getHostName ()
	Get container host name. More...

CORBA::Long	getPID ()
	Get container PID. More...

bool	Kill_impl ()
	Kill current container. More...

Engines::EngineComponent_ptr	find_or_create_instance (std::string genericRegisterName)
	Finds an already existing component instance or create a new instance. More...

Engines::EngineComponent_ptr	createCPPInstance (std::string genericRegisterName, void *handle, int studyId)
	Create a new CPP component instance. More...

Engines::EngineComponent_ptr	createPythonInstance (std::string genericRegisterName, int studyId)
	Create a new Python component instance. More...

void	set_id (PortableServer::ObjectId *id)

Engines::fileRef_ptr	createFileRef (const char *origFileName)
	Get or create a file reference object associated to a local file (to transfer it) More...

Engines::fileTransfer_ptr	getFileTransfer ()
	CORBA method: More...

virtual Engines::Salome_file_ptr	createSalome_file (const char *origFileName)

void	copyFile (Engines::Container_ptr container, const char remoteFile, const char localFile)
	copy a file from a remote host (container) to the local host More...

Engines::PyNode_ptr	createPyNode (const char nodeName, const char code)
	create a PyNode object to execute remote python code More...

Engines::PyNode_ptr	getDefaultPyNode (const char *nodeName)

Engines::PyScriptNode_ptr	createPyScriptNode (const char nodeName, const char code)

Engines::PyScriptNode_ptr	getDefaultPyScriptNode (const char *nodeName)

Static Public Member Functions
static bool	isPythonContainer (const char *ContainerName)
	Indicate if container is a python one. More...

static void	decInstanceCnt (std::string genericRegisterName)
	Decrement component instance reference count. More...

Protected Types
typedef std::map< std::string, Engines::EngineComponent_var >	_listInstances_map_t

typedef std::map< std::string, Engines::fileRef_var >	_fileRef_map_t

typedef std::map< std::string, Engines::Salome_file_var >	_Salome_file_map_t

typedef PortableServer::ObjectId (	FACTORY_FUNCTION )(CORBA::ORB_ptr, char , int, PortableServer::POA_ptr, PortableServer::ObjectId , const char , const char )

Protected Attributes
SALOME_NamingService *	_NS

std::string	_hostname

std::string	_library_path

std::string	_containerName

std::string	_logfilename

CORBA::ORB_var	_orb

PortableServer::POA_var	_poa

PortableServer::ObjectId *	_id

int	_numInstance

CORBA::Long	_pid

bool	_isServantAloneInProcess

Engines::fileTransfer_var	_fileTransfer

_listInstances_map_t	_listInstances_map

_fileRef_map_t	_fileRef_map

_Salome_file_map_t	_Salome_file_map

std::map< std::string, PortableServer::ObjectId * >	_par_obj_inst_map

Static Protected Attributes
static std::map< std::string, int >	_cntInstances_map

static std::map< std::string, void * >	_library_map

static std::map< std::string, void * >	_toRemove_map

static omni_mutex	_numInstanceMutex

Detailed Description

C++ implementation of Engines::Container interface for parallel container implemented with PaCO++.

Member Typedef Documentation

typedef std::map<std::string,Engines::fileRef_var> Engines_Parallel_Container_i::_fileRef_map_t

protected

typedef std::map<std::string,Engines::EngineComponent_var> Engines_Parallel_Container_i::_listInstances_map_t

protected

typedef std::map<std::string,Engines::Salome_file_var> Engines_Parallel_Container_i::_Salome_file_map_t

protected

typedef PortableServer::ObjectId*(* Engines_Parallel_Container_i::FACTORY_FUNCTION)(CORBA::ORB_ptr, char *, int, PortableServer::POA_ptr, PortableServer::ObjectId *, const char *, const char *)

protected

Constructor & Destructor Documentation

Engines_Parallel_Container_i::Engines_Parallel_Container_i	(	CORBA::ORB_ptr	orb,
		char *	ior,
		int	rank,
		PortableServer::POA_ptr	poa,
		std::string	containerName,
		bool	isServantAloneInProcess = `true`
	)

Construtor.

References _containerName, _fileTransfer, _hostname, _id, _NS, _orb, _pid, _poa, ActSigIntHandler(), SALOME_NamingService::BuildContainerNameForNS(), Kernel_Utils::GetHostname(), SALOME_NamingService::init_orb(), Py_ACQUIRE_NEW_THREAD, and Py_RELEASE_NEW_THREAD.

Engines_Parallel_Container_i::~Engines_Parallel_Container_i ( )

virtual

Destructor.

References _id, _NS, and MESSAGE.

Member Function Documentation

void Engines_Parallel_Container_i::copyFile	(	Engines::Container_ptr	container,
		const char *	remoteFile,
		const char *	localFile
	)

copy a file from a remote host (container) to the local host

Parameters

container	the remote container
remoteFile	the file to copy locally from the remote host into localFile
localFile	the local file

References INFOS, MESSAGE, and SCRUTE.

Engines::EngineComponent_ptr Engines_Parallel_Container_i::create_component_instance	(	const char *	genericRegisterName,
		CORBA::Long	studyId
	)

virtual

Create a new component instance.

CORBA method: Creates a new servant instance of a component. The servant registers itself to naming service and Registry.

Parameters

genericRegisterName	Name of the component instance to register in Registry & Name Service (without _inst_n suffix)
studyId	0 for multiStudy instance, study Id (>0) otherwise

Returns: a loaded component

References create_component_instance_env().

Referenced by find_or_create_instance().

Engines::EngineComponent_ptr Engines_Parallel_Container_i::create_component_instance_env	(	const char *	genericRegisterName,
		CORBA::Long	studyId,
		const Engines::FieldsDict &	env,
		CORBA::String_out	reason
	)

virtual

Create a new component instance.

CORBA method: Creates a new servant instance of a component. The servant registers itself to naming service and Registry.

Parameters

genericRegisterName	Name of the component instance to register in Registry & Name Service (without _inst_n suffix)
studyId	0 for multiStudy instance, study Id (>0) otherwise
env	dict of environment variables

Returns: a loaded component

References ParallelGlobalProcessVar_i::_library_map, _numInstance, ParallelGlobalProcessVar_i::_numInstanceMutex, createCPPInstance(), createPythonInstance(), INFOS, and MESSAGE.

Referenced by create_component_instance().

void Engines_Parallel_Container_i::create_paco_component_node_instance	(	const char *	componentName,
		const char *	proxy_containerName,
		CORBA::Long	studyId
	)

References _containerName, _id, ParallelGlobalProcessVar_i::_library_map, _NS, _numInstance, ParallelGlobalProcessVar_i::_numInstanceMutex, _orb, _par_obj_inst_map, _poa, INFOS, SALOME::INTERNAL_ERROR, MESSAGE, SALOME_NamingService::Register(), SALOME_NamingService::Resolve(), SALOME::ExceptionStruct::text, and SALOME::ExceptionStruct::type.

char * Engines_Parallel_Container_i::create_python_service_instance	(	const char *	CompName,
		CORBA::String_out	reason
	)

virtual

Engines::EngineComponent_ptr Engines_Parallel_Container_i::createCPPInstance	(	std::string	genericRegisterName,
		void *	handle,
		int	studyId
	)

Create a new CPP component instance.

C++ method: create a servant instance of a component.

Parameters

genericRegisterName	Name of the component instance to register in Registry & Name Service, (without _inst_n suffix, like "COMPONENT")
handle	loaded library handle
studyId	0 for multiStudy instance, study Id (>0) otherwise

Returns: a loaded component

example with names: aGenRegisterName = COMPONENT (= first argument) _containerName = /Containers/cli76ce/FactoryServer factoryName = COMPONENTEngine_factory component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT instanceName = COMPONENT_inst_1 component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1

References ParallelGlobalProcessVar_i::_cntInstances_map, _containerName, _id, _listInstances_map, _NS, _numInstance, _orb, _poa, ASSERT, INFOS, MESSAGE, SALOME_NamingService::Register(), and Engines_Component_i::setStudyId().

Referenced by create_component_instance_env().

Engines::fileRef_ptr Engines_Parallel_Container_i::createFileRef ( const char * origFileName )

Get or create a file reference object associated to a local file (to transfer it)

CORBA method: get or create a fileRef object associated to a local file (a file on the computer on which runs the container server), which stores a list of (machine, localFileName) corresponding to copies already done.

Parameters

origFileName absolute path for a local file to copy on other computers

Returns: a fileRef object associated to the file.

References _fileRef_map, _id, ParallelGlobalProcessVar_i::_numInstanceMutex, _poa, ASSERT, and INFOS.

Engines::PyNode_ptr Engines_Parallel_Container_i::createPyNode	(	const char *	nodeName,
		const char *	code
	)

create a PyNode object to execute remote python code

Parameters

nodeName	the name of the node
code	the python code to load

Returns: the PyNode

References INFOS.

Engines::PyScriptNode_ptr Engines_Parallel_Container_i::createPyScriptNode	(	const char *	nodeName,
		const char *	code
	)

References INFOS.

Engines::EngineComponent_ptr Engines_Parallel_Container_i::createPythonInstance	(	std::string	genericRegisterName,
		int	studyId
	)

Create a new Python component instance.

C++ method: create a servant instance of a component.

Parameters

genericRegisterName	Name of the component instance to register in Registry & Name Service, (without _inst_n suffix, like "COMPONENT")
handle	loaded library handle
studyId	0 for multiStudy instance, study Id (>0) otherwise

Returns: a loaded component

example with names: aGenRegisterName = COMPONENT (= first argument) _containerName = /Containers/cli76ce/FactoryServer factoryName = COMPONENTEngine_factory component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT instanceName = COMPONENT_inst_1 component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1

References _containerName, _listInstances_map, _numInstance, _orb, Py_ACQUIRE_NEW_THREAD, and Py_RELEASE_NEW_THREAD.

Referenced by create_component_instance_env().

Engines::Salome_file_ptr Engines_Parallel_Container_i::createSalome_file ( const char * origFileName )

virtual

References ParallelGlobalProcessVar_i::_numInstanceMutex, _Salome_file_map, ASSERT, Salome_file_i::recvFiles(), and Salome_file_i::setLocalFile().

void Engines_Parallel_Container_i::decInstanceCnt ( std::string genericRegisterName )

static

Decrement component instance reference count.

References ParallelGlobalProcessVar_i::_cntInstances_map, ParallelGlobalProcessVar_i::_library_map, ParallelGlobalProcessVar_i::_numInstanceMutex, ParallelGlobalProcessVar_i::_toRemove_map, ASSERT, Engines_Component_i::GetDynLibraryName(), MESSAGE, and SCRUTE.

Referenced by Engines_Parallel_Component_i::~Engines_Parallel_Component_i().

void Engines_Parallel_Container_i::finalize_removal ( )

Unload component libraries from the container.

CORBA method: Discharges unused libraries from the container.

References ParallelGlobalProcessVar_i::_numInstanceMutex, ParallelGlobalProcessVar_i::_toRemove_map, and MESSAGE.

Engines::EngineComponent_ptr Engines_Parallel_Container_i::find_component_instance	(	const char *	registeredName,
		CORBA::Long	studyId
	)

Find an existing (in the container) component instance.

CORBA method: Finds a servant instance of a component

Parameters

registeredName	Name of the component in Registry or Name Service, without instance suffix number
studyId	0 if instance is not associated to a study, >0 otherwise (== study id)

Returns: the first instance found with same studyId

References _listInstances_map, and SCRUTE.

Engines::EngineComponent_ptr Engines_Parallel_Container_i::find_or_create_instance ( std::string genericRegisterName )

Finds an already existing component instance or create a new instance.

C++ method: Finds an already existing servant instance of a component, or create an instance. -— USE ONLY FOR MULTISTUDY INSTANCES ! -----—

Parameters

genericRegisterName Name of the component instance to register in Registry & Name Service, (without _inst_n suffix, like "COMPONENT")

Returns: a loaded component

example with names: aGenRegisterName = COMPONENT (= first argument) impl_name = libCOMPONENTEngine.so (= second argument) _containerName = /Containers/cli76ce/FactoryServer factoryName = COMPONENTEngine_factory component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT

instanceName = COMPONENT_inst_1 component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1

References _containerName, _NS, _poa, ASSERT, create_component_instance(), Engines_Component_i::getStudyId(), INFOS, and SALOME_NamingService::ResolveFirst().

Referenced by load_impl().

Engines::PyNode_ptr Engines_Parallel_Container_i::getDefaultPyNode ( const char * nodeName )

References INFOS.

Engines::PyScriptNode_ptr Engines_Parallel_Container_i::getDefaultPyScriptNode ( const char * nodeName )

References INFOS.

Engines::fileTransfer_ptr Engines_Parallel_Container_i::getFileTransfer ( )

CORBA method:

Returns: a reference to the fileTransfer object

References _fileTransfer.

char * Engines_Parallel_Container_i::getHostName ( )

Get container host name.

CORBA method: Get the hostName of the Container (without domain extensions)

References _hostname, and MESSAGE.

CORBA::Long Engines_Parallel_Container_i::getPID ( )

Get container PID.

CORBA method: Get the PID (process identification) of the Container

References _pid, and MESSAGE.

bool Engines_Parallel_Container_i::isPythonContainer ( const char * ContainerName )

static

Indicate if container is a python one.

Retrieves only with container naming convention if it is a python container

bool Engines_Parallel_Container_i::Kill_impl ( )

Kill current container.

Kill the container.

CORBA method: Kill the container process with exit(0). To remove : never returns !

References _containerName, _hostname, _pid, ASSERT, INFOS, and MESSAGE.

bool Engines_Parallel_Container_i::load_component_Library	(	const char *	componentName,
		CORBA::String_out	reason
	)

virtual

load a new component class

CORBA method: load a new component class (Python or C++ implementation)

Parameters

componentName like COMPONENT try to make a Python import of COMPONENT, then a lib open of libCOMPONENTEngine.so

Returns: true if dlopen successfull or already done, false otherwise

References ParallelGlobalProcessVar_i::_library_map, ParallelGlobalProcessVar_i::_numInstanceMutex, ParallelGlobalProcessVar_i::_toRemove_map, MESSAGE, Py_ACQUIRE_NEW_THREAD, and Py_RELEASE_NEW_THREAD.

Referenced by load_impl().

Engines::EngineComponent_ptr Engines_Parallel_Container_i::load_impl	(	const char *	genericRegisterName,
		const char *	componentName
	)

Find or create a new component instance.

CORBA method: find or create an instance of the component (servant), load a new component class (dynamic library) if required, -— FOR COMPATIBILITY WITH 2.2 -— -— USE ONLY FOR MULTISTUDY INSTANCES ! -----— The servant registers itself to naming service and Registry.

Parameters

genericRegisterName	Name of the component to register in Registry & Name Service
componentName	Name of the constructed library of the component

Returns: a loaded component

References find_or_create_instance(), and load_component_Library().

char * Engines_Parallel_Container_i::logfilename ( )

Get container log file name.

CORBA attribute: Container log file name

References _logfilename.

void Engines_Parallel_Container_i::logfilename ( const char * name )

Set container log file name.

References _logfilename, and name().

char * Engines_Parallel_Container_i::name ( )

Get container name.

CORBA attribute: Container name (see constructor)

References _containerName.

Referenced by logfilename().

void Engines_Parallel_Container_i::ping ( )

virtual

Ping the servant to check it is still alive.

CORBA method: check if servant is still alive

References _pid, and MESSAGE.

void Engines_Parallel_Container_i::remove_impl ( Engines::EngineComponent_ptr component_i )

Remove the component instance from container.

CORBA method: Stops the component servant, and deletes all related objects

Parameters

component_i Component to be removed

References _listInstances_map, _NS, ParallelGlobalProcessVar_i::_numInstanceMutex, ASSERT, SALOME_NamingService::Destroy_Name(), and MESSAGE.

void Engines_Parallel_Container_i::set_id ( PortableServer::ObjectId * id )

void Engines_Parallel_Container_i::Shutdown ( )

virtual

Shutdown the container.

CORBA method, oneway: Server shutdown.

Container name removed from naming service,
servant deactivation,
orb shutdown if no other servants in the process

References _containerName, _isServantAloneInProcess, _listInstances_map, _NS, _orb, _par_obj_inst_map, _poa, SALOME_NamingService::Destroy_FullDirectory(), SALOME_NamingService::Destroy_Name(), and MESSAGE.

void Engines_Parallel_Container_i::updateInstanceNumber ( )

References _numInstance, and ParallelGlobalProcessVar_i::_numInstanceMutex.

char * Engines_Parallel_Container_i::workingdir ( )

Get container working directory.

CORBA attribute: Container working directory

Field Documentation

std::map< std::string, int > ParallelGlobalProcessVar_i::_cntInstances_map

staticprotectedinherited

Referenced by Container_proxy_impl_final::create_component_instance_env(), createCPPInstance(), and decInstanceCnt().

std::string Engines_Parallel_Container_i::_containerName

protected

Referenced by create_paco_component_node_instance(), createCPPInstance(), createPythonInstance(), Engines_Parallel_Container_i(), find_or_create_instance(), Kill_impl(), name(), and Shutdown().

_fileRef_map_t Engines_Parallel_Container_i::_fileRef_map

protected

Referenced by createFileRef().

Engines::fileTransfer_var Engines_Parallel_Container_i::_fileTransfer

protected

Referenced by Engines_Parallel_Container_i(), and getFileTransfer().

std::string Engines_Parallel_Container_i::_hostname

protected

Referenced by Engines_Parallel_Container_i(), getHostName(), and Kill_impl().

PortableServer::ObjectId* Engines_Parallel_Container_i::_id

protected

Referenced by create_paco_component_node_instance(), createCPPInstance(), createFileRef(), Engines_Parallel_Container_i(), and ~Engines_Parallel_Container_i().

bool Engines_Parallel_Container_i::_isServantAloneInProcess

protected

Referenced by Shutdown().

std::map< std::string, void * > ParallelGlobalProcessVar_i::_library_map

staticprotectedinherited

Referenced by Container_proxy_impl_final::create_component_instance_env(), create_component_instance_env(), create_paco_component_node_instance(), decInstanceCnt(), Container_proxy_impl_final::load_component_Library(), and load_component_Library().

std::string Engines_Parallel_Container_i::_library_path

protected

_listInstances_map_t Engines_Parallel_Container_i::_listInstances_map

protected

Referenced by createCPPInstance(), createPythonInstance(), find_component_instance(), remove_impl(), and Shutdown().

std::string Engines_Parallel_Container_i::_logfilename

protected

Referenced by logfilename().

SALOME_NamingService* Engines_Parallel_Container_i::_NS

protected

Referenced by create_paco_component_node_instance(), createCPPInstance(), Engines_Parallel_Container_i(), find_or_create_instance(), remove_impl(), Shutdown(), and ~Engines_Parallel_Container_i().

int Engines_Parallel_Container_i::_numInstance

protected

Referenced by create_component_instance_env(), create_paco_component_node_instance(), createCPPInstance(), createPythonInstance(), and updateInstanceNumber().

omni_mutex ParallelGlobalProcessVar_i::_numInstanceMutex

staticprotectedinherited

Referenced by Container_proxy_impl_final::create_component_instance_env(), create_component_instance_env(), create_paco_component_node_instance(), createFileRef(), createSalome_file(), decInstanceCnt(), finalize_removal(), Container_proxy_impl_final::load_component_Library(), load_component_Library(), remove_impl(), and updateInstanceNumber().

CORBA::ORB_var Engines_Parallel_Container_i::_orb

protected

Referenced by create_paco_component_node_instance(), createCPPInstance(), createPythonInstance(), Engines_Parallel_Container_i(), and Shutdown().

std::map<std::string, PortableServer::ObjectId *> Engines_Parallel_Container_i::_par_obj_inst_map

protected

Referenced by create_paco_component_node_instance(), and Shutdown().

CORBA::Long Engines_Parallel_Container_i::_pid

protected

Referenced by Engines_Parallel_Container_i(), getPID(), Kill_impl(), and ping().

PortableServer::POA_var Engines_Parallel_Container_i::_poa

protected

Referenced by create_paco_component_node_instance(), createCPPInstance(), createFileRef(), Engines_Parallel_Container_i(), find_or_create_instance(), and Shutdown().

_Salome_file_map_t Engines_Parallel_Container_i::_Salome_file_map

protected

Referenced by createSalome_file().

std::map< std::string, void * > ParallelGlobalProcessVar_i::_toRemove_map

staticprotectedinherited

Referenced by decInstanceCnt(), finalize_removal(), and load_component_Library().

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation