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_startup_code(const char *codeAtStartUp) override;
93 char *get_startup_code() override;
95 void addLogFileNameGroup(const Engines::vectorOfString& groupOfLogFileNames) override;
97 Engines::vectorOfVectorOfString *getAllLogFileNameGroups() override;
99 void execute_python_code(const char *code) override;
101 virtual Engines::EngineComponent_ptr
102 create_component_instance_env(const char *componentName,
103 const Engines::FieldsDict &env,
104 CORBA::String_out reason);
107 create_python_service_instance(const char *CompName,
108 CORBA::String_out reason);
110 Engines::EngineComponent_ptr
111 find_component_instance(const char *registeredName);
113 Engines::EngineComponent_ptr
114 load_impl(const char *nameToRegister,
115 const char *componentName);
117 bool is_SSL_mode() override { return this->isSSLMode(); }
119 Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
121 SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
123 void remove_impl(Engines::EngineComponent_ptr component_i);
124 void finalize_removal();
127 CORBA::Long getNumberOfCPUCores();
128 Engines::vectorOfDouble* loadOfCPUCores();
129 void setPyScriptForCPULoad(const char *script);
130 void resetScriptForCPULoad();
131 CORBA::Long getTotalPhysicalMemory();
132 CORBA::Long getTotalPhysicalMemoryInUse();
133 CORBA::Long getTotalPhysicalMemoryInUseByMe();
136 char *logfilename() override;
137 void logfilename(const char *name) override;
138 char *locallogfilename() override;
139 void locallogfilename(const char *name) override;
140 CORBA::Long monitoringtimeresms() override;
141 void monitoringtimeresms(CORBA::Long intervalInMs) override;
142 void verbosity(bool& activated, CORBA::String_out level) override;
143 void setVerbosity(bool activated, const char *level) override;
145 void Shutdown() override;
146 void ShutdownNow() override;
148 CORBA::Long getPID();
149 //! Kill current container
152 Engines::fileRef_ptr createFileRef(const char *origFileName);
153 Engines::fileTransfer_ptr getFileTransfer();
155 virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
156 void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
157 Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
158 Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
159 Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
160 void removePyScriptNode(const char *nodeName) override;
161 void cleanAllPyScripts() override;
162 Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
163 // --- local C++ methods
165 Engines::EngineComponent_ptr
166 find_or_create_instance(std::string genericRegisterName,
167 std::string componentLibraryName);
169 bool load_component_CppImplementation(const char *componentName, std::string &reason);
170 bool load_component_PythonImplementation(const char *componentName, std::string &reason);
171 bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
173 Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
174 Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
175 Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
177 static bool isPythonContainer(const char *ContainerName);
178 static void decInstanceCnt(std::string genericRegisterName);
179 //??? char* machineName();
181 // --- needed for parallel components, Numerical Platon
183 int getArgc() { return _argc; }
184 char **getArgv() { return _argv; }
186 void registerTemporaryFile(const std::string &fileName);
187 void unregisterTemporaryFile(const std::string &fileName);
188 void clearTemporaryFiles();
189 PortableServer::ObjectId *getCORBAId() const { return _id; }
191 static const int DFT_TIME_INTERVAL_BTW_MEASURE;
193 void ShutdownCommonPart();
195 static std::map<std::string, int> _cntInstances_map;
196 static std::map<std::string, void *> _library_map; // library names, loaded
197 static std::map<std::string, void *> _toRemove_map; // library names to remove
198 static omni_mutex _numInstanceMutex; // lib and instance protection
200 bool _isSupervContainer;
202 SALOME_NamingService_Container_Abstract *_NS;
203 std::string _library_path;
204 std::string _containerName;
205 std::string _logfilename;
206 std::string _localfilename;
207 std::string _load_script;
208 std::string _py_container_name;
209 std::string _code_at_startup;
211 PortableServer::POA_var _poa;
212 PortableServer::ObjectId *_id;
214 std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
215 std::map<std::string, Engines::fileRef_var> _fileRef_map;
216 std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
217 std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
218 std::map<std::string, Engines::PyNode_var> _dftPyNode;
219 Utils_Mutex _mutexForDftPy;
220 std::list<std::string> _tmp_files;
221 Engines::fileTransfer_var _fileTransfer;
222 std::vector< std::vector<std::string> > _groups_of_log_files;
227 bool _isServantAloneInProcess;
230 constexpr char PY_CONTAINER_CLS_NAME_IN_PROCESS[] = "SALOME_Container_i";
231 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY[] = "SALOME_Container_OutOfProcess_i";
232 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY[] = "SALOME_Container_OutOfProcess_Replay_i";
233 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY_FT[] = "SALOME_Container_OutOfProcess_FT_i";
234 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY_FT[] = "SALOME_Container_OutOfProcess_Replay_FT_i";
236 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
239 Engines_Container_i() { }
240 Engines_Container_i(CORBA::ORB_ptr orb,
241 PortableServer::POA_ptr poa,
243 int argc, char *argv[],
244 SALOME_NamingService_Container_Abstract *ns = nullptr,
245 bool isServantAloneInProcess = true) :
246 Abstract_Engines_Container_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
247 bool isSSLMode() const override { return false; }
250 class CONTAINER_EXPORT Abstract_Engines_Container_SSL_i : public Abstract_Engines_Container_i
253 Abstract_Engines_Container_SSL_i(const std::string& pyContainerClsName,
255 PortableServer::POA_ptr poa,
257 int argc, char *argv[],
258 SALOME_NamingService_Container_Abstract *ns = nullptr,
259 bool isServantAloneInProcess = true) :
260 Abstract_Engines_Container_i(pyContainerClsName, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
261 bool isSSLMode() const override { return true; }
264 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_SSL_i
267 Engines_Container_SSL_i(CORBA::ORB_ptr orb,
268 PortableServer::POA_ptr poa,
270 int argc, char *argv[],
271 SALOME_NamingService_Container_Abstract *ns = nullptr,
272 bool isServantAloneInProcess = true) :
273 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
276 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_i : public Abstract_Engines_Container_SSL_i
279 Engines_Container_SSL_OutOfProcess_i(CORBA::ORB_ptr orb,
280 PortableServer::POA_ptr poa,
282 int argc, char *argv[],
283 SALOME_NamingService_Container_Abstract *ns = nullptr,
284 bool isServantAloneInProcess = true) :
285 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
288 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_i : public Abstract_Engines_Container_SSL_i
291 Engines_Container_SSL_OutOfProcess_Replay_i(CORBA::ORB_ptr orb,
292 PortableServer::POA_ptr poa,
294 int argc, char *argv[],
295 SALOME_NamingService_Container_Abstract *ns = nullptr,
296 bool isServantAloneInProcess = true) :
297 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
300 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_FT_i : public Abstract_Engines_Container_SSL_i
303 Engines_Container_SSL_OutOfProcess_FT_i(CORBA::ORB_ptr orb,
304 PortableServer::POA_ptr poa,
306 int argc, char *argv[],
307 SALOME_NamingService_Container_Abstract *ns = nullptr,
308 bool isServantAloneInProcess = true) :
309 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY_FT, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
312 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_FT_i : public Abstract_Engines_Container_SSL_i
315 Engines_Container_SSL_OutOfProcess_Replay_FT_i(CORBA::ORB_ptr orb,
316 PortableServer::POA_ptr poa,
318 int argc, char *argv[],
319 SALOME_NamingService_Container_Abstract *ns = nullptr,
320 bool isServantAloneInProcess = true) :
321 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY_FT, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
325 * Methods to be used in SSL mode to skip NS.
329 CONTAINER_EXPORT Abstract_Engines_Container_SSL_i *getContainerSA();
330 CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
331 } // namespace KERNEL