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 addLogFileNameGroup(const Engines::vectorOfString& groupOfLogFileNames) override;
91 Engines::vectorOfVectorOfString *getAllLogFileNameGroups() override;
93 void execute_python_code(const char *code) override;
95 virtual Engines::EngineComponent_ptr
96 create_component_instance_env(const char *componentName,
97 const Engines::FieldsDict &env,
98 CORBA::String_out reason);
101 create_python_service_instance(const char *CompName,
102 CORBA::String_out reason);
104 Engines::EngineComponent_ptr
105 find_component_instance(const char *registeredName);
107 Engines::EngineComponent_ptr
108 load_impl(const char *nameToRegister,
109 const char *componentName);
111 bool is_SSL_mode() override { return this->isSSLMode(); }
113 Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
115 SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
117 void remove_impl(Engines::EngineComponent_ptr component_i);
118 void finalize_removal();
121 CORBA::Long getNumberOfCPUCores();
122 Engines::vectorOfDouble* loadOfCPUCores();
123 void setPyScriptForCPULoad(const char *script);
124 void resetScriptForCPULoad();
125 CORBA::Long getTotalPhysicalMemory();
126 CORBA::Long getTotalPhysicalMemoryInUse();
127 CORBA::Long getTotalPhysicalMemoryInUseByMe();
130 char *logfilename() override;
131 void logfilename(const char *name) override;
132 char *locallogfilename() override;
133 void locallogfilename(const char *name) override;
134 CORBA::Long monitoringtimeresms() override;
135 void monitoringtimeresms(CORBA::Long intervalInMs) override;
136 void verbosity(bool& activated, CORBA::String_out level) override;
137 void setVerbosity(bool activated, const char *level) override;
139 void Shutdown() override;
140 void ShutdownNow() override;
142 CORBA::Long getPID();
143 //! Kill current container
146 Engines::fileRef_ptr createFileRef(const char *origFileName);
147 Engines::fileTransfer_ptr getFileTransfer();
149 virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
150 void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
151 Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
152 Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
153 Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
154 void removePyScriptNode(const char *nodeName) override;
155 void cleanAllPyScripts() override;
156 Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
157 // --- local C++ methods
159 Engines::EngineComponent_ptr
160 find_or_create_instance(std::string genericRegisterName,
161 std::string componentLibraryName);
163 bool load_component_CppImplementation(const char *componentName, std::string &reason);
164 bool load_component_PythonImplementation(const char *componentName, std::string &reason);
165 bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
167 Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
168 Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
169 Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
171 static bool isPythonContainer(const char *ContainerName);
172 static void decInstanceCnt(std::string genericRegisterName);
173 //??? char* machineName();
175 // --- needed for parallel components, Numerical Platon
177 int getArgc() { return _argc; }
178 char **getArgv() { return _argv; }
180 void registerTemporaryFile(const std::string &fileName);
181 void unregisterTemporaryFile(const std::string &fileName);
182 void clearTemporaryFiles();
183 PortableServer::ObjectId *getCORBAId() const { return _id; }
185 static const int DFT_TIME_INTERVAL_BTW_MEASURE;
187 void ShutdownCommonPart();
189 static std::map<std::string, int> _cntInstances_map;
190 static std::map<std::string, void *> _library_map; // library names, loaded
191 static std::map<std::string, void *> _toRemove_map; // library names to remove
192 static omni_mutex _numInstanceMutex; // lib and instance protection
194 bool _isSupervContainer;
196 SALOME_NamingService_Container_Abstract *_NS;
197 std::string _library_path;
198 std::string _containerName;
199 std::string _logfilename;
200 std::string _localfilename;
201 std::string _load_script;
202 std::string _py_container_name;
204 PortableServer::POA_var _poa;
205 PortableServer::ObjectId *_id;
207 std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
208 std::map<std::string, Engines::fileRef_var> _fileRef_map;
209 std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
210 std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
211 std::map<std::string, Engines::PyNode_var> _dftPyNode;
212 Utils_Mutex _mutexForDftPy;
213 std::list<std::string> _tmp_files;
214 Engines::fileTransfer_var _fileTransfer;
215 std::vector< std::vector<std::string> > _groups_of_log_files;
220 bool _isServantAloneInProcess;
223 constexpr char PY_CONTAINER_CLS_NAME_IN_PROCESS[] = "SALOME_Container_i";
224 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY[] = "SALOME_Container_OutOfProcess_i";
225 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY[] = "SALOME_Container_OutOfProcess_Replay_i";
228 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
231 Engines_Container_i() { }
232 Engines_Container_i(CORBA::ORB_ptr orb,
233 PortableServer::POA_ptr poa,
235 int argc, char *argv[],
236 SALOME_NamingService_Container_Abstract *ns = nullptr,
237 bool isServantAloneInProcess = true) :
238 Abstract_Engines_Container_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
239 bool isSSLMode() const override { return false; }
242 class CONTAINER_EXPORT Abstract_Engines_Container_SSL_i : public Abstract_Engines_Container_i
245 Abstract_Engines_Container_SSL_i(const std::string& pyContainerClsName,
247 PortableServer::POA_ptr poa,
249 int argc, char *argv[],
250 SALOME_NamingService_Container_Abstract *ns = nullptr,
251 bool isServantAloneInProcess = true) :
252 Abstract_Engines_Container_i(pyContainerClsName, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
253 bool isSSLMode() const override { return true; }
256 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_SSL_i
259 Engines_Container_SSL_i(CORBA::ORB_ptr orb,
260 PortableServer::POA_ptr poa,
262 int argc, char *argv[],
263 SALOME_NamingService_Container_Abstract *ns = nullptr,
264 bool isServantAloneInProcess = true) :
265 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
268 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_i : public Abstract_Engines_Container_SSL_i
271 Engines_Container_SSL_OutOfProcess_i(CORBA::ORB_ptr orb,
272 PortableServer::POA_ptr poa,
274 int argc, char *argv[],
275 SALOME_NamingService_Container_Abstract *ns = nullptr,
276 bool isServantAloneInProcess = true) :
277 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
280 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_i : public Abstract_Engines_Container_SSL_i
283 Engines_Container_SSL_OutOfProcess_Replay_i(CORBA::ORB_ptr orb,
284 PortableServer::POA_ptr poa,
286 int argc, char *argv[],
287 SALOME_NamingService_Container_Abstract *ns = nullptr,
288 bool isServantAloneInProcess = true) :
289 Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
293 * Methods to be used in SSL mode to skip NS.
297 CONTAINER_EXPORT Abstract_Engines_Container_SSL_i *getContainerSA();
298 CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
299 } // namespace KERNEL