1 // Copyright (C) 2007-2024 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 // SALOME Container : implementation of container and engine for Kernel
24 // File : SALOME_Container_i.hxx
25 // Author : Paul RASCLE, EDF - MARC TAJCHMAN, CEA
29 #ifndef _SALOME_CONTAINER_I_HXX_
30 #define _SALOME_CONTAINER_I_HXX_
32 #include "SALOME_Container.hxx"
33 #include "Utils_Mutex.hxx"
35 #include <SALOMEconfig.h>
36 #include CORBA_SERVER_HEADER(SALOME_Component)
37 #include CORBA_SERVER_HEADER(SALOME_PyNode)
45 #include <sys/types.h>
46 #include <omnithread.h>
52 class SALOME_NamingService_Container_Abstract;
54 class CONTAINER_EXPORT Abstract_Engines_Container_i : public virtual POA_Engines::Container,
55 public virtual PortableServer::ServantBase
58 Abstract_Engines_Container_i();
59 Abstract_Engines_Container_i(const std::string& pyContainerClsName,
61 PortableServer::POA_ptr poa,
63 int argc, char *argv[],
64 SALOME_NamingService_Container_Abstract *ns = nullptr,
65 bool isServantAloneInProcess = true);
66 virtual ~Abstract_Engines_Container_i();
68 virtual bool isSSLMode() const = 0;
70 std::string getPyContainerClassName() const { return _py_container_name; }
74 virtual bool load_component_Library(const char *componentName, CORBA::String_out reason);
76 virtual Engines::EngineComponent_ptr
77 create_component_instance(const char *componentName);
79 void override_environment_python( const Engines::FieldsDict& env ) override;
81 void override_environment( const Engines::FieldsDict& env ) override;
83 Engines::FieldsDict *get_os_environment() override;
85 void set_big_obj_on_disk_threshold(CORBA::Long thresholdInByte) override;
87 void set_big_obj_on_disk_directory(const char *directory) override;
89 void set_number_of_retry(CORBA::Long nbRetry) override;
91 void set_directory_for_replay_files(const char *directory) override;
93 void set_startup_code(const char *codeAtStartUp) override;
95 char *get_startup_code() override;
97 void addLogFileNameGroup(const Engines::vectorOfString& groupOfLogFileNames) override;
99 Engines::vectorOfVectorOfString *getAllLogFileNameGroups() override;
101 void execute_python_code(const char *code) override;
103 virtual Engines::EngineComponent_ptr
104 create_component_instance_env(const char *componentName,
105 const Engines::FieldsDict &env,
106 CORBA::String_out reason);
109 create_python_service_instance(const char *CompName,
110 CORBA::String_out reason);
112 Engines::EngineComponent_ptr
113 find_component_instance(const char *registeredName);
115 Engines::EngineComponent_ptr
116 load_impl(const char *nameToRegister,
117 const char *componentName);
119 bool is_SSL_mode() override { return this->isSSLMode(); }
121 Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
123 SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
125 void remove_impl(Engines::EngineComponent_ptr component_i);
126 void finalize_removal();
129 CORBA::Long getNumberOfCPUCores();
130 Engines::vectorOfDouble* loadOfCPUCores();
131 void setPyScriptForCPULoad(const char *script);
132 void resetScriptForCPULoad();
133 CORBA::Long getTotalPhysicalMemory();
134 CORBA::Long getTotalPhysicalMemoryInUse();
135 CORBA::Long getTotalPhysicalMemoryInUseByMe();
138 char *logfilename() override;
139 void logfilename(const char *name) override;
140 char *locallogfilename() override;
141 void locallogfilename(const char *name) override;
142 CORBA::Long monitoringtimeresms() override;
143 void monitoringtimeresms(CORBA::Long intervalInMs) override;
144 void verbosity(bool& activated, CORBA::String_out level) override;
145 void setVerbosity(bool activated, const char *level) override;
147 void Shutdown() override;
148 void ShutdownNow() override;
150 CORBA::Long getPID();
151 //! Kill current container
154 Engines::fileRef_ptr createFileRef(const char *origFileName);
155 Engines::fileTransfer_ptr getFileTransfer();
157 virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
158 void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
159 Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
160 Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
161 Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
162 void removePyScriptNode(const char *nodeName) override;
163 void cleanAllPyScripts() override;
164 Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
165 // --- local C++ methods
167 Engines::EngineComponent_ptr
168 find_or_create_instance(std::string genericRegisterName,
169 std::string componentLibraryName);
171 bool load_component_CppImplementation(const char *componentName, std::string &reason);
172 bool load_component_PythonImplementation(const char *componentName, std::string &reason);
173 bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
175 Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
176 Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
177 Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
179 static bool isPythonContainer(const char *ContainerName);
180 static void decInstanceCnt(std::string genericRegisterName);
181 //??? char* machineName();
183 // --- needed for parallel components, Numerical Platon
185 int getArgc() { return _argc; }
186 char **getArgv() { return _argv; }
188 void registerTemporaryFile(const std::string &fileName);
189 void unregisterTemporaryFile(const std::string &fileName);
190 void clearTemporaryFiles();
191 PortableServer::ObjectId *getCORBAId() const { return _id; }
193 static const int DFT_TIME_INTERVAL_BTW_MEASURE;
195 void ShutdownCommonPart();
197 static std::map<std::string, int> _cntInstances_map;
198 static std::map<std::string, void *> _library_map; // library names, loaded
199 static std::map<std::string, void *> _toRemove_map; // library names to remove
200 static omni_mutex _numInstanceMutex; // lib and instance protection
202 bool _isSupervContainer;
204 SALOME_NamingService_Container_Abstract *_NS;
205 std::string _library_path;
206 std::string _containerName;
207 std::string _logfilename;
208 std::string _localfilename;
209 std::string _load_script;
210 std::string _py_container_name;
211 std::string _code_at_startup;
213 PortableServer::POA_var _poa;
214 PortableServer::ObjectId *_id;
216 std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
217 std::map<std::string, Engines::fileRef_var> _fileRef_map;
218 std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
219 std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
220 std::map<std::string, Engines::PyNode_var> _dftPyNode;
221 Utils_Mutex _mutexForDftPy;
222 std::list<std::string> _tmp_files;
223 Engines::fileTransfer_var _fileTransfer;
224 std::vector< std::vector<std::string> > _groups_of_log_files;
229 bool _isServantAloneInProcess;
232 constexpr char PY_CONTAINER_CLS_NAME_IN_PROCESS[] = "SALOME_Container_i";
233 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY[] = "SALOME_Container_OutOfProcess_i";
234 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY[] = "SALOME_Container_OutOfProcess_Replay_i";
235 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY_FT[] = "SALOME_Container_OutOfProcess_FT_i";
236 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY_FT[] = "SALOME_Container_OutOfProcess_Replay_FT_i";
238 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
241 Engines_Container_i() { }
242 Engines_Container_i(CORBA::ORB_ptr orb,
243 PortableServer::POA_ptr poa,
245 int argc, char *argv[],
246 SALOME_NamingService_Container_Abstract *ns = nullptr,
247 bool isServantAloneInProcess = true) :
248 Abstract_Engines_Container_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
249 bool isSSLMode() const override { return false; }
252 class CONTAINER_EXPORT Abstract_Engines_Container_SSL_i : public Abstract_Engines_Container_i
255 Abstract_Engines_Container_SSL_i(const std::string& pyContainerClsName,
257 PortableServer::POA_ptr poa,
259 int argc, char *argv[],
260 SALOME_NamingService_Container_Abstract *ns = nullptr,
261 bool isServantAloneInProcess = true) :
262 Abstract_Engines_Container_i(pyContainerClsName, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
263 bool isSSLMode() const override { return true; }
266 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_SSL_i
269 Engines_Container_SSL_i(CORBA::ORB_ptr orb,
270 PortableServer::POA_ptr poa,
272 int argc, char *argv[],
273 SALOME_NamingService_Container_Abstract *ns = nullptr,
274 bool isServantAloneInProcess = true) :
275 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
278 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_i : public Abstract_Engines_Container_SSL_i
281 Engines_Container_SSL_OutOfProcess_i(CORBA::ORB_ptr orb,
282 PortableServer::POA_ptr poa,
284 int argc, char *argv[],
285 SALOME_NamingService_Container_Abstract *ns = nullptr,
286 bool isServantAloneInProcess = true) :
287 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
290 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_i : public Abstract_Engines_Container_SSL_i
293 Engines_Container_SSL_OutOfProcess_Replay_i(CORBA::ORB_ptr orb,
294 PortableServer::POA_ptr poa,
296 int argc, char *argv[],
297 SALOME_NamingService_Container_Abstract *ns = nullptr,
298 bool isServantAloneInProcess = true) :
299 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
302 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_FT_i : public Abstract_Engines_Container_SSL_i
305 Engines_Container_SSL_OutOfProcess_FT_i(CORBA::ORB_ptr orb,
306 PortableServer::POA_ptr poa,
308 int argc, char *argv[],
309 SALOME_NamingService_Container_Abstract *ns = nullptr,
310 bool isServantAloneInProcess = true) :
311 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY_FT, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
314 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_FT_i : public Abstract_Engines_Container_SSL_i
317 Engines_Container_SSL_OutOfProcess_Replay_FT_i(CORBA::ORB_ptr orb,
318 PortableServer::POA_ptr poa,
320 int argc, char *argv[],
321 SALOME_NamingService_Container_Abstract *ns = nullptr,
322 bool isServantAloneInProcess = true) :
323 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY_FT, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
327 * Methods to be used in SSL mode to skip NS.
331 CONTAINER_EXPORT Abstract_Engines_Container_SSL_i *getContainerSA();
332 CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
333 } // namespace KERNEL