1 // Copyright (C) 2007-2021 CEA/DEN, EDF R&D, 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 virtual Engines::EngineComponent_ptr
76 create_component_instance_env(const char *componentName,
77 const Engines::FieldsDict &env,
78 CORBA::String_out reason);
81 create_python_service_instance(const char *CompName,
82 CORBA::String_out reason);
84 Engines::EngineComponent_ptr
85 find_component_instance(const char *registeredName);
87 Engines::EngineComponent_ptr
88 load_impl(const char *nameToRegister,
89 const char *componentName);
91 Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
93 void remove_impl(Engines::EngineComponent_ptr component_i);
94 void finalize_removal();
100 void logfilename(const char *name);
102 virtual void Shutdown();
104 CORBA::Long getPID();
105 //! Kill current container
108 Engines::fileRef_ptr createFileRef(const char *origFileName);
109 Engines::fileTransfer_ptr getFileTransfer();
111 virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
112 void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
113 Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
114 Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
115 Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
116 void removePyScriptNode(const char *nodeName) override;
117 void cleanAllPyScripts() override;
118 Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
119 // --- local C++ methods
121 Engines::EngineComponent_ptr
122 find_or_create_instance(std::string genericRegisterName,
123 std::string componentLibraryName);
125 bool load_component_CppImplementation(const char *componentName, std::string &reason);
126 bool load_component_PythonImplementation(const char *componentName, std::string &reason);
127 bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
129 Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
130 Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
131 Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
133 static bool isPythonContainer(const char *ContainerName);
134 static void decInstanceCnt(std::string genericRegisterName);
135 //??? char* machineName();
137 // --- needed for parallel components, Numerical Platon
139 int getArgc() { return _argc; }
140 char **getArgv() { return _argv; }
142 void registerTemporaryFile(const std::string &fileName);
143 void unregisterTemporaryFile(const std::string &fileName);
144 void clearTemporaryFiles();
145 PortableServer::ObjectId *getCORBAId() const { return _id; }
148 static std::map<std::string, int> _cntInstances_map;
149 static std::map<std::string, void *> _library_map; // library names, loaded
150 static std::map<std::string, void *> _toRemove_map; // library names to remove
151 static omni_mutex _numInstanceMutex; // lib and instance protection
153 bool _isSupervContainer;
155 SALOME_NamingService_Container_Abstract *_NS;
156 std::string _library_path;
157 std::string _containerName;
158 std::string _logfilename;
160 PortableServer::POA_var _poa;
161 PortableServer::ObjectId *_id;
163 std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
164 std::map<std::string, Engines::fileRef_var> _fileRef_map;
165 std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
166 std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
167 std::map<std::string, Engines::PyNode_var> _dftPyNode;
168 Utils_Mutex _mutexForDftPy;
169 std::list<std::string> _tmp_files;
170 Engines::fileTransfer_var _fileTransfer;
175 bool _isServantAloneInProcess;
178 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
181 Engines_Container_i();
182 Engines_Container_i(CORBA::ORB_ptr orb,
183 PortableServer::POA_ptr poa,
185 int argc, char *argv[],
186 SALOME_NamingService_Container_Abstract *ns = nullptr,
187 bool isServantAloneInProcess = true) :
188 Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
189 bool isSSLMode() const override { return false; }
192 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_i
195 Engines_Container_SSL_i();
196 Engines_Container_SSL_i(CORBA::ORB_ptr orb,
197 PortableServer::POA_ptr poa,
199 int argc, char *argv[],
200 SALOME_NamingService_Container_Abstract *ns = nullptr,
201 bool isServantAloneInProcess = true) :
202 Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
203 bool isSSLMode() const override { return true; }
207 * Methods to be used in SSL mode to skip NS.
211 CONTAINER_EXPORT Engines_Container_SSL_i *getContainerSA();
212 CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
213 } // namespace KERNEL