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 // 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>
51 class SALOME_NamingService_Container_Abstract;
53 class CONTAINER_EXPORT Abstract_Engines_Container_i : public virtual POA_Engines::Container,
54 public virtual PortableServer::ServantBase
57 Abstract_Engines_Container_i();
58 Abstract_Engines_Container_i(CORBA::ORB_ptr orb,
59 PortableServer::POA_ptr poa,
61 int argc, char *argv[],
62 SALOME_NamingService_Container_Abstract *ns = nullptr,
63 bool isServantAloneInProcess = true);
64 virtual ~Abstract_Engines_Container_i();
66 virtual bool isSSLMode() const = 0;
70 virtual bool load_component_Library(const char *componentName, CORBA::String_out reason);
72 virtual Engines::EngineComponent_ptr
73 create_component_instance(const char *componentName);
75 void override_environment_python( const Engines::FieldsDict& env ) override;
77 void override_environment( const Engines::FieldsDict& env ) override;
79 Engines::FieldsDict *get_os_environment() override;
81 virtual Engines::EngineComponent_ptr
82 create_component_instance_env(const char *componentName,
83 const Engines::FieldsDict &env,
84 CORBA::String_out reason);
87 create_python_service_instance(const char *CompName,
88 CORBA::String_out reason);
90 Engines::EngineComponent_ptr
91 find_component_instance(const char *registeredName);
93 Engines::EngineComponent_ptr
94 load_impl(const char *nameToRegister,
95 const char *componentName);
97 bool is_SSL_mode() override { return this->isSSLMode(); }
99 Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
101 SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
103 void remove_impl(Engines::EngineComponent_ptr component_i);
104 void finalize_removal();
107 CORBA::Long getNumberOfCPUCores();
108 Engines::vectorOfDouble* loadOfCPUCores();
109 void setPyScriptForCPULoad(const char *script);
110 void resetScriptForCPULoad();
111 CORBA::Long getTotalPhysicalMemory();
112 CORBA::Long getTotalPhysicalMemoryInUse();
113 CORBA::Long getTotalPhysicalMemoryInUseByMe();
117 void logfilename(const char *name);
119 virtual void Shutdown();
121 CORBA::Long getPID();
122 //! Kill current container
125 Engines::fileRef_ptr createFileRef(const char *origFileName);
126 Engines::fileTransfer_ptr getFileTransfer();
128 virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
129 void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
130 Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
131 Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
132 Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
133 void removePyScriptNode(const char *nodeName) override;
134 void cleanAllPyScripts() override;
135 Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
136 // --- local C++ methods
138 Engines::EngineComponent_ptr
139 find_or_create_instance(std::string genericRegisterName,
140 std::string componentLibraryName);
142 bool load_component_CppImplementation(const char *componentName, std::string &reason);
143 bool load_component_PythonImplementation(const char *componentName, std::string &reason);
144 bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
146 Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
147 Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
148 Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
150 static bool isPythonContainer(const char *ContainerName);
151 static void decInstanceCnt(std::string genericRegisterName);
152 //??? char* machineName();
154 // --- needed for parallel components, Numerical Platon
156 int getArgc() { return _argc; }
157 char **getArgv() { return _argv; }
159 void registerTemporaryFile(const std::string &fileName);
160 void unregisterTemporaryFile(const std::string &fileName);
161 void clearTemporaryFiles();
162 PortableServer::ObjectId *getCORBAId() const { return _id; }
165 static std::map<std::string, int> _cntInstances_map;
166 static std::map<std::string, void *> _library_map; // library names, loaded
167 static std::map<std::string, void *> _toRemove_map; // library names to remove
168 static omni_mutex _numInstanceMutex; // lib and instance protection
170 bool _isSupervContainer;
172 SALOME_NamingService_Container_Abstract *_NS;
173 std::string _library_path;
174 std::string _containerName;
175 std::string _logfilename;
176 std::string _load_script;
178 PortableServer::POA_var _poa;
179 PortableServer::ObjectId *_id;
181 std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
182 std::map<std::string, Engines::fileRef_var> _fileRef_map;
183 std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
184 std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
185 std::map<std::string, Engines::PyNode_var> _dftPyNode;
186 Utils_Mutex _mutexForDftPy;
187 std::list<std::string> _tmp_files;
188 Engines::fileTransfer_var _fileTransfer;
193 bool _isServantAloneInProcess;
196 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
199 Engines_Container_i() { }
200 Engines_Container_i(CORBA::ORB_ptr orb,
201 PortableServer::POA_ptr poa,
203 int argc, char *argv[],
204 SALOME_NamingService_Container_Abstract *ns = nullptr,
205 bool isServantAloneInProcess = true) :
206 Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
207 bool isSSLMode() const override { return false; }
210 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_i
213 Engines_Container_SSL_i();
214 Engines_Container_SSL_i(CORBA::ORB_ptr orb,
215 PortableServer::POA_ptr poa,
217 int argc, char *argv[],
218 SALOME_NamingService_Container_Abstract *ns = nullptr,
219 bool isServantAloneInProcess = true) :
220 Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
221 bool isSSLMode() const override { return true; }
225 * Methods to be used in SSL mode to skip NS.
229 CONTAINER_EXPORT Engines_Container_SSL_i *getContainerSA();
230 CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
231 } // namespace KERNEL