#include <SALOME_ContainerManager.hxx>

Inheritance diagram for SALOME_ContainerManager:

Public Member Functions
	SALOME_ContainerManager (CORBA::ORB_ptr orb, PortableServer::POA_var poa, SALOME_NamingService *ns)
	Constructor. More...

	~SALOME_ContainerManager ()
	destructor More...

Engines::Container_ptr	GiveContainer (const Engines::ContainerParameters &params)
	Give a suitable Container given constraints. More...

void	ShutdownContainers ()
	Loop on all the containers listed in naming service, ask shutdown on each. More...

void	Shutdown ()
	shutdown all the containers, then the ContainerManager servant More...

Static Public Member Functions
static char *	GetenvThreadSafe (const char *name)

static std::string	GetenvThreadSafeAsString (const char *name)

static int	SystemThreadSafe (const char *command)

static void	AddOmninamesParams (std::ostream &fileStream, SALOME_NamingService *ns)
	add to command all options relative to naming service. More...

static void	MakeTheCommandToBeLaunchedASync (std::string &command)

static int	GetTimeOutToLoaunchServer ()

static void	SleepInSecond (int ellapseTimeInSecond)

Static Public Attributes
static const char *	_ContainerManagerNameInNS

Protected Types
typedef std::vector< std::string >	actual_launch_machine_t

Protected Member Functions
Engines::Container_ptr	FindContainer (const Engines::ContainerParameters &params, const Engines::ResourceList &possibleResources)
	Find a container given constraints (params) on a list of machines (possibleComputers) agy : this method is ThreadSafe. More...

Engines::Container_ptr	FindContainer (const Engines::ContainerParameters &params, const std::string &resource)
	Find a container given constraints (params) on a machine (theMachine) agy : this method is ThreadSafe. More...

std::string	BuildCommandToLaunchRemoteContainer (const std::string &resource_name, const Engines::ContainerParameters &params, const std::string &container_exe="SALOME_Container") const
	Builds the script to be launched. More...

std::string	BuildCommandToLaunchLocalContainer (const Engines::ContainerParameters &params, const std::string &machinesFile, const std::string &container_exe, std::string &tmpFileName) const
	builds the command to be launched. More...

std::string	BuildTempFileToLaunchRemoteContainer (const std::string &resource_name, const Engines::ContainerParameters &params, std::string &tmpFileName) const
	Builds in a temporary file the script to be launched. More...

void	AddOmninamesParams (std::string &command) const
	add to command all options relative to naming service. More...

void	AddOmninamesParams (std::ostream &fileStream) const
	add to command all options relative to naming service. More...

std::string	GetMPIZeroNode (const std::string machine, const std::string machinesFile) const

std::string	machinesFile (const int nbproc)

std::set< pid_t >	getpidofprogram (const std::string program)

Engines::Container_ptr	LaunchContainer (const Engines::ContainerParameters &params, const std::string &resource_selected, const std::string &hostname, const std::string &machFile, const std::string &containerNameInNS)

bool	checkPaCOParameters (Engines::ContainerParameters &params, std::string resource_selected)

Engines::Container_ptr	StartPaCOPPContainer (const Engines::ContainerParameters &params, std::string resource_selected)

std::string	BuildCommandToLaunchPaCOProxyContainer (const Engines::ContainerParameters &params, std::string machine_file_name, std::string &proxy_hostname)

std::string	BuildCommandToLaunchPaCONodeContainer (const Engines::ContainerParameters &params, const std::string &machine_file_name, SALOME_ContainerManager::actual_launch_machine_t &vect_machine, const std::string &proxy_hostname)

void	LogConfiguration (const std::string &log_type, const std::string &exe_type, const std::string &container_name, const std::string &hostname, std::string &begin, std::string &end)

CORBA::Object_ptr	LaunchPaCOProxyContainer (const std::string &command, const Engines::ContainerParameters &params, const std::string &hostname)

bool	LaunchPaCONodeContainer (const std::string &command, const Engines::ContainerParameters &params, const std::string &name, SALOME_ContainerManager::actual_launch_machine_t &vect_machine)

Static Protected Member Functions
static void	RmTmpFile (std::string &tmpFile)
	removes the generated temporary file in case of a remote launch. More...

static std::string	BuildTemporaryFileName ()
	generate a file name in /tmp directory More...

static std::string	getCommandToRunRemoteProcess (AccessProtocolType protocol, const std::string &hostname, const std::string &username)

Protected Attributes
CORBA::ORB_var	_orb

PortableServer::POA_var	_poa

SALOME_ResourcesManager_Client *	_resManager

SALOME_NamingService *	_NS

bool	_isAppliSalomeDefined
	different behaviour if $APPLI exists (SALOME Application) More...

int	_nbprocUsed
	attribute that contains the number of processes used in batch mode by MPI containers More...

Utils_Mutex	_giveContainerMutex1
	attributes to allow concurrency for // GiveContainer More...

pid_t	_pid_mpiServer

Static Protected Attributes
static omni_mutex	_numInstanceMutex

Static Private Attributes
static const int	TIME_OUT_TO_LAUNCH_CONT =60

static Utils_Mutex	_getenvMutex

static Utils_Mutex	_systemMutex

Member Typedef Documentation

typedef std::vector<std::string> SALOME_ContainerManager::actual_launch_machine_t

protected

Constructor & Destructor Documentation

SALOME_ContainerManager::SALOME_ContainerManager	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_var	poa,
		SALOME_NamingService *	ns
	)

Constructor.

Parameters

orb	Define a CORBA single thread policy for the server, which avoid to deal with non thread-safe usage like Change_Directory in SALOME naming service

References _ContainerManagerNameInNS, _isAppliSalomeDefined, _NS, _orb, _pid_mpiServer, _poa, _resManager, GetenvThreadSafe(), GetenvThreadSafeAsString(), getpidofprogram(), MESSAGE, SALOME_NamingService::Register(), and SystemThreadSafe().

SALOME_ContainerManager::~SALOME_ContainerManager ( )

destructor

References _pid_mpiServer, _resManager, GetenvThreadSafe(), MESSAGE, and SystemThreadSafe().

Member Function Documentation

void SALOME_ContainerManager::AddOmninamesParams ( std::string & command ) const

protected

add to command all options relative to naming service.

Referenced by AddOmninamesParams(), BuildCommandToLaunchLocalContainer(), BuildCommandToLaunchRemoteContainer(), BuildTempFileToLaunchRemoteContainer(), and CreateDataScope().

void SALOME_ContainerManager::AddOmninamesParams ( std::ostream & fileStream ) const

protected

add to command all options relative to naming service.

References _NS, and AddOmninamesParams().

void SALOME_ContainerManager::AddOmninamesParams	(	std::ostream &	fileStream,
		SALOME_NamingService *	ns
	)

static

add to command all options relative to naming service.

References SALOME_NamingService::getIORaddr().

std::string SALOME_ContainerManager::BuildCommandToLaunchLocalContainer	(	const Engines::ContainerParameters &	params,
		const std::string &	machinesFile,
		const std::string &	container_exe,
		std::string &	tmpFileName
	)		const

protected

builds the command to be launched.

References _NS, AddOmninamesParams(), BuildTemporaryFileName(), Engines::ContainerParameters::container_name, SALOME_NamingService::ContainerName(), GetenvThreadSafe(), GetenvThreadSafeAsString(), Kernel_Utils::GetHostname(), Kernel_Utils::GetTmpDir(), Engines::ContainerParameters::isMPI, isPythonContainer(), MESSAGE, Engines::ContainerParameters::nb_proc, and Engines::ContainerParameters::workingdir.

Referenced by LaunchContainer().

std::string SALOME_ContainerManager::BuildCommandToLaunchPaCONodeContainer	(	const Engines::ContainerParameters &	params,
		const std::string &	machine_file_name,
		SALOME_ContainerManager::actual_launch_machine_t &	vect_machine,
		const std::string &	proxy_hostname
	)

protected

std::string SALOME_ContainerManager::BuildCommandToLaunchPaCOProxyContainer	(	const Engines::ContainerParameters &	params,
		std::string	machine_file_name,
		std::string &	proxy_hostname
	)

protected

std::string SALOME_ContainerManager::BuildCommandToLaunchRemoteContainer	(	const std::string &	resource_name,
		const Engines::ContainerParameters &	params,
		const std::string &	container_exe = `"SALOME_Container"`
	)		const

protected

Builds the script to be launched.

If SALOME Application not defined ($APPLI), see BuildTempFileToLaunchRemoteContainer()

Else rely on distant configuration. Command is under the form (example): ssh user distantPath/runRemote.sh hostNS portNS WORKINGDIR workingdir \ SALOME_Container containerName &"

where user is ommited if not specified in CatalogResources,
where distant path is always relative to user $HOME, and equal to $APPLI if not specified in CatalogResources,
where hostNS is the hostname of CORBA naming server (set by scripts to use to launch SALOME and servers in $APPLI: runAppli.sh, runRemote.sh)
where portNS is the port used by CORBA naming server (set by scripts to use to launch SALOME and servers in $APPLI: runAppli.sh, runRemote.sh)
where workingdir is the requested working directory for the container. If WORKINGDIR (and workingdir) is not present the working dir will be $HOME

References _isAppliSalomeDefined, _NS, _resManager, AddOmninamesParams(), ASSERT, BuildTempFileToLaunchRemoteContainer(), SALOME_NamingService::ContainerName(), getCommandToRunRemoteProcess(), GetenvThreadSafe(), GetenvThreadSafeAsString(), Kernel_Utils::GetHostname(), SALOME_ResourcesManager_Client::GetResourceDefinition(), Engines::ContainerParameters::isMPI, MESSAGE, Engines::ContainerParameters::nb_proc, and Engines::ContainerParameters::workingdir.

Referenced by LaunchContainer().

std::string SALOME_ContainerManager::BuildTempFileToLaunchRemoteContainer	(	const std::string &	resource_name,
		const Engines::ContainerParameters &	params,
		std::string &	tmpFileName
	)		const

protected

Builds in a temporary file the script to be launched.

Used if SALOME Application ($APPLI) is not defined. The command is build with data from CatalogResources, in which every path used on remote computer must be defined.

References _NS, _resManager, AddOmninamesParams(), BuildTemporaryFileName(), Engines::ContainerParameters::container_name, SALOME_NamingService::ContainerName(), GetenvThreadSafe(), GetenvThreadSafeAsString(), Kernel_Utils::GetHostname(), SALOME_ResourcesManager_Client::GetResourceDefinition(), Engines::ContainerParameters::isMPI, isPythonContainer(), Engines::ContainerParameters::nb_proc, out, rsh, SCRUTE, srun, ssh, and SystemThreadSafe().

Referenced by BuildCommandToLaunchRemoteContainer().

std::string SALOME_ContainerManager::BuildTemporaryFileName ( )

staticprotected

generate a file name in /tmp directory

References Kernel_Utils::GetTmpFileName().

Referenced by BuildCommandToLaunchLocalContainer(), BuildTempFileToLaunchRemoteContainer(), and GetMPIZeroNode().

bool SALOME_ContainerManager::checkPaCOParameters	(	Engines::ContainerParameters &	params,
		std::string	resource_selected
	)

protected

References _resManager, ParserResourcesType::AppliPath, Engines::ContainerParameters::container_name, ParserResourcesType::getAccessProtocolTypeStr(), SALOME_ResourcesManager_Client::GetResourceDefinition(), ParserResourcesType::HostName, INFOS, ParserResourcesType::Name, Engines::ContainerParameters::nb_proc, Engines::ContainerParameters::parallelLib, and ParserResourcesType::UserName.

Engines::Container_ptr SALOME_ContainerManager::FindContainer	(	const Engines::ContainerParameters &	params,
		const Engines::ResourceList &	possibleResources
	)

protected

Find a container given constraints (params) on a list of machines (possibleComputers) agy : this method is ThreadSafe.

References MESSAGE.

Referenced by GiveContainer().

Engines::Container_ptr SALOME_ContainerManager::FindContainer	(	const Engines::ContainerParameters &	params,
		const std::string &	resource
	)

protected

Find a container given constraints (params) on a machine (theMachine) agy : this method is ThreadSafe.

References _NS, _resManager, SALOME_NamingService::BuildContainerNameForNS(), SALOME_ResourcesManager_Client::GetResourceDefinition(), ParserResourcesType::HostName, MESSAGE, and SALOME_NamingService::Resolve().

std::string SALOME_ContainerManager::getCommandToRunRemoteProcess	(	AccessProtocolType	protocol,
		const std::string &	hostname,
		const std::string &	username
	)

staticprotected

References blaunch, pbsdsh, rsh, srun, and ssh.

Referenced by BuildCommandToLaunchRemoteContainer(), and LaunchContainer().

char * SALOME_ContainerManager::GetenvThreadSafe ( const char * name )

static

References _getenvMutex, and SALOMEDS::lock().

Referenced by BuildCommandToLaunchLocalContainer(), BuildCommandToLaunchRemoteContainer(), BuildTempFileToLaunchRemoteContainer(), GetenvThreadSafeAsString(), GetMPIZeroNode(), GetTimeOutToLoaunchServer(), GiveContainer(), LaunchContainer(), SALOME_ContainerManager(), and ~SALOME_ContainerManager().

std::string SALOME_ContainerManager::GetenvThreadSafeAsString ( const char * name )

static

References GetenvThreadSafe().

Referenced by BuildCommandToLaunchLocalContainer(), BuildCommandToLaunchRemoteContainer(), BuildTempFileToLaunchRemoteContainer(), GetMPIZeroNode(), GetTimeOutToLoaunchServer(), LaunchContainer(), machinesFile(), and SALOME_ContainerManager().

std::string SALOME_ContainerManager::GetMPIZeroNode	(	const std::string	machine,
		const std::string	machinesFile
	)		const

protected

References _isAppliSalomeDefined, _resManager, ASSERT, BuildTemporaryFileName(), GetenvThreadSafe(), GetenvThreadSafeAsString(), SALOME_ResourcesManager_Client::GetResourceDefinition(), ParserResourcesType::HostName, RmTmpFile(), rsh, sh, srun, ssh, and SystemThreadSafe().

Referenced by GiveContainer().

std::set< pid_t > SALOME_ContainerManager::getpidofprogram ( const std::string program )

protected

References Kernel_Utils::GetTmpFileName(), and SystemThreadSafe().

Referenced by SALOME_ContainerManager().

int SALOME_ContainerManager::GetTimeOutToLoaunchServer ( )

static

References GetenvThreadSafe(), GetenvThreadSafeAsString(), INFOS, and TIME_OUT_TO_LAUNCH_CONT.

Referenced by CreateDataScope(), and LaunchContainer().

Engines::Container_ptr SALOME_ContainerManager::GiveContainer ( const Engines::ContainerParameters & params )

Give a suitable Container given constraints.

CORBA Method:

Parameters

params Container Parameters required for the container

Returns: the container or nil

References _giveContainerMutex1, _NS, _resManager, SALOME_NamingService::BuildContainerNameForNS(), resourceParams::can_run_containers, Engines::ContainerParameters::container_name, SALOME_ResourcesManager_Client::Find(), FindContainer(), GetenvThreadSafe(), SALOME_ResourcesManager_Client::GetFittingResources(), GetMPIZeroNode(), SALOME_ResourcesManager_Client::GetResourceDefinition(), ParserResourcesType::HostName, INFOS, Engines::ContainerParameters::isMPI, LaunchContainer(), SALOMEDS::lock(), machinesFile(), MESSAGE, Engines::ContainerParameters::mode, Engines::ContainerParameters::nb_proc, Engines::ResourceParameters::policy, Engines::ResourceParameters::resList, SALOME_NamingService::Resolve(), Engines::ContainerParameters::resource_params, resourceParameters_CORBAtoCPP(), and SALOME_Exception::what().

Engines::Container_ptr SALOME_ContainerManager::LaunchContainer	(	const Engines::ContainerParameters &	params,
		const std::string &	resource_selected,
		const std::string &	hostname,
		const std::string &	machFile,
		const std::string &	containerNameInNS
	)

protected

bool SALOME_ContainerManager::LaunchPaCONodeContainer	(	const std::string &	command,
		const Engines::ContainerParameters &	params,
		const std::string &	name,
		SALOME_ContainerManager::actual_launch_machine_t &	vect_machine
	)

protected

CORBA::Object_ptr SALOME_ContainerManager::LaunchPaCOProxyContainer	(	const std::string &	command,
		const Engines::ContainerParameters &	params,
		const std::string &	hostname
	)

protected

void SALOME_ContainerManager::LogConfiguration	(	const std::string &	log_type,
		const std::string &	exe_type,
		const std::string &	container_name,
		const std::string &	hostname,
		std::string &	begin,
		std::string &	end
	)