1 // Copyright (C) 2007-2023 CEA, EDF, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef __SALOME_CONTAINERMANAGER_HXX__
24 #define __SALOME_CONTAINERMANAGER_HXX__
26 #include "SALOME_Container.hxx"
28 #include <SALOMEconfig.h>
29 #include CORBA_CLIENT_HEADER(SALOME_Component)
30 #include CORBA_CLIENT_HEADER(SALOME_ContainerManager)
31 #include "SALOME_ResourcesCatalog_Parser.hxx"
33 #include "Utils_Mutex.hxx"
40 class SALOME_NamingService_Abstract;
41 class SALOME_ResourcesManager_Client;
43 class CONTAINER_EXPORT SALOME_ContainerManager : public POA_Engines::ContainerManager
47 SALOME_ContainerManager(CORBA::ORB_ptr orb, PortableServer::POA_var poa, SALOME_NamingService_Abstract *ns);
48 ~SALOME_ContainerManager();
51 Engines::Container_ptr GiveContainer(const Engines::ContainerParameters& params) override;
53 void ShutdownContainers() override;
55 void SetOverrideEnvForContainers(const Engines::KeyValDict& env) override;
57 Engines::KeyValDict *GetOverrideEnvForContainers() override;
59 void SetCodeOnContainerStartUp(const char *code) override;
64 void DeclareUsingSalomeSession() { _isSSL = false; }
66 CORBA::Long GetTimeOutToLaunchServerInSecond() override;
68 void SetTimeOutToLaunchServerInSecond(CORBA::Long timeInSecond) override;
70 CORBA::Long GetDeltaTimeBetweenNSLookupAtLaunchTimeInMilliSecond() override;
72 void SetDeltaTimeBetweenNSLookupAtLaunchTimeInMilliSecond(CORBA::Long timeInMS) override;
74 static const char *_ContainerManagerNameInNS;
78 Engines::Container_ptr
79 FindContainer(const Engines::ContainerParameters& params,
80 const Engines::ResourceList& possibleResources);
82 Engines::Container_ptr
83 FindContainer(const Engines::ContainerParameters& params,
84 const std::string& resource);
86 std::string GetCppBinaryOfKernelContainer() const;
88 std::string GetRunRemoteExecutableScript() const;
90 std::string BuildCommandToLaunchRemoteContainer(const std::string & resource_name,
91 const Engines::ContainerParameters& params,
92 const std::string& container_exe="SALOME_Container") const;
94 std::string BuildCommandToLaunchLocalContainer(const Engines::ContainerParameters& params,
95 const std::string& machinesFile,
96 const std::string& container_exe,//"SALOME_Container"
97 std::string& tmpFileName) const;
99 std::string BuildTempFileToLaunchRemoteContainer(const std::string& resource_name,
100 const Engines::ContainerParameters& params, std::string& tmpFileName) const;
102 static void RmTmpFile(std::string& tmpFile);
104 void AddOmninamesParams(std::string& command) const;
106 void AddOmninamesParams(std::ostream& fileStream) const;
108 static std::string BuildTemporaryFileName();
110 std::string GetMPIZeroNode(const std::string machine, const std::string machinesFile) const;
112 std::string machinesFile(const int nbproc);
114 std::string getCommandToRunRemoteProcessCommon(const std::string& templateName, const std::string& remoteScript,
115 AccessProtocolType protocol,
116 const std::string & hostname,
117 const std::string & username,
118 const std::string & applipath,
119 const std::string & workdir) const;
121 std::string getCommandToRunRemoteProcess(AccessProtocolType protocol,
122 const std::string & hostname,
123 const std::string & username,
124 const std::string & applipath,
125 const std::string & workdir="") const;
127 std::string getCommandToRunRemoteProcessNoAppli(AccessProtocolType protocol,
128 const std::string & hostname,
129 const std::string & username,
130 const std::string & applipath,
131 const std::string & workdir="") const;
133 Engines::Container_ptr
134 LaunchContainer(const Engines::ContainerParameters& params,
135 const std::string & resource_selected,
136 const std::string & hostname,
137 const std::string & machFile,
138 const std::string & containerNameInNS);
141 PortableServer::POA_var _poa;
143 SALOME_ResourcesManager_Client *_resManager;
144 SALOME_NamingService_Abstract *_NS;
146 //! different behaviour if $APPLI exists (SALOME Application)
147 bool _isAppliSalomeDefined;
149 //! attribute that contains the number of processes used in batch mode by MPI containers
152 //! attribute that specifies the launch mode.
155 static omni_mutex _numInstanceMutex ; // lib and instance protection
157 //! attributes to allow concurrency for // GiveContainer
158 Utils_Mutex _giveContainerMutex1;
160 pid_t _pid_mpiServer;
162 // Begin of PacO++ Parallel extension
163 typedef std::vector<std::string> actual_launch_machine_t;
165 bool checkPaCOParameters(Engines::ContainerParameters & params, std::string resource_selected);
167 Engines::Container_ptr
168 StartPaCOPPContainer(const Engines::ContainerParameters& params, std::string resource_selected);
172 std::string BuildCommandToLaunchPaCOProxyContainer(const Engines::ContainerParameters& params,
173 std::string machine_file_name,
174 std::string & proxy_hostname);
176 std::string BuildCommandToLaunchPaCONodeContainer(const Engines::ContainerParameters& params,
177 const std::string & machine_file_name,
178 SALOME_ContainerManager::actual_launch_machine_t & vect_machine,
179 const std::string & proxy_hostname);
181 void LogConfiguration(const std::string & log_type,
182 const std::string & exe_type,
183 const std::string & container_name,
184 const std::string & hostname,
189 LaunchPaCOProxyContainer(const std::string& command,
190 const Engines::ContainerParameters& params,
191 const std::string& hostname);
194 LaunchPaCONodeContainer(const std::string& command,
195 const Engines::ContainerParameters& params,
196 const std::string& name,
197 SALOME_ContainerManager::actual_launch_machine_t & vect_machine);
198 // End of PaCO++ Parallel extension
200 static char *GetenvThreadSafe(const char *name);
201 static std::string GetenvThreadSafeAsString(const char *name);
202 static int SystemThreadSafe(const char *command);
203 static long SystemWithPIDThreadSafe(const std::vector<std::string>& command);
204 static void AddOmninamesParams(std::ostream& fileStream, SALOME_NamingService_Abstract *ns);
205 static void MakeTheCommandToBeLaunchedASync(std::string& command);
206 static int GetTimeOutToLoaunchServer();
207 static void SleepInSecond(int ellapseTimeInSecond);
209 static const int TIME_OUT_TO_LAUNCH_CONT;
210 static const int DFT_DELTA_TIME_NS_LOOKUP_IN_MS;
211 static Utils_Mutex _getenvMutex;
212 static Utils_Mutex _systemMutex;
214 std::vector< std::pair<std::string, std::string> > _override_env;
215 int _time_out_in_second;
216 int _delta_time_ns_lookup_in_ms;
217 std::string _code_to_exe_on_startup;