Salome HOME
[EDF28648] : On container launch time from ContainerManager it s possible to execute...
[modules/kernel.git] / src / Container / SALOME_Container_i.hxx
index 14d51c5df40be9f53a0a4f6a7b03dbcccb4eedcb..ca2fac0a354aeb7b477a68bdfbbb6c61f4e2714a 100644 (file)
-//  SALOME Container : implementation of container and engine for Kernel
+// Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
 //
-//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
 //
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
+
+//  SALOME Container : implementation of container and engine for Kernel
 //  File   : SALOME_Container_i.hxx
 //  Author : Paul RASCLE, EDF - MARC TAJCHMAN, CEA
 //  Module : SALOME
 //  $Header$
-
+//
 #ifndef _SALOME_CONTAINER_I_HXX_
 #define _SALOME_CONTAINER_I_HXX_
 
+#include "SALOME_Container.hxx"
+#include "Utils_Mutex.hxx"
+
 #include <SALOMEconfig.h>
 #include CORBA_SERVER_HEADER(SALOME_Component)
+#include CORBA_SERVER_HEADER(SALOME_PyNode)
 
 #include <iostream>
 #include <signal.h>
 #include <stdlib.h>
-#ifndef WNT
+#ifndef WIN32
 #include <unistd.h>
 #endif
 #include <sys/types.h>
 #include <omnithread.h>
 #include <map>
+#include <list>
 #include <string>
 
-class SALOME_NamingService;
+class SALOME_NamingService_Container_Abstract;
 
-
-#if defined CONTAINER_EXPORTS
-#if defined WIN32
-#define CONTAINER_EXPORT __declspec( dllexport )
-#else
-#define CONTAINER_EXPORT
-#endif
-#else
-#if defined WNT
-#define CONTAINER_EXPORT __declspec( dllimport )
-#else
-#define CONTAINER_EXPORT
-#endif
-#endif
-
-class CONTAINER_EXPORT Engines_Container_i:
-  public virtual POA_Engines::Container,
-  public virtual PortableServer::RefCountServantBase
+class CONTAINER_EXPORT Abstract_Engines_Container_i : public virtual POA_Engines::Container,
+                                                      public virtual PortableServer::ServantBase
 {
 public:
-  Engines_Container_i();
-  Engines_Container_i(CORBA::ORB_ptr orb, 
-                     PortableServer::POA_var poa,
-                     char * containerName ,
-                      int argc, char* argv[],
-                     bool activAndRegist = true,
-                     bool isServantAloneInProcess = true);
-  virtual ~Engines_Container_i();
+  Abstract_Engines_Container_i();
+  Abstract_Engines_Container_i(CORBA::ORB_ptr orb,
+                               PortableServer::POA_ptr poa,
+                               char *containerName,
+                               int argc, char *argv[],
+                               SALOME_NamingService_Container_Abstract *ns = nullptr,
+                               bool isServantAloneInProcess = true);
+  virtual ~Abstract_Engines_Container_i();
+
+  virtual bool isSSLMode() const = 0;
 
   // --- CORBA methods
 
-  virtual bool load_component_Library(const char* componentName);
+  virtual bool load_component_Library(const char *componentName, CORBA::String_out reason);
+
+  virtual Engines::EngineComponent_ptr
+  create_component_instance(const char *componentName);
+
+  void override_environment_python( const Engines::FieldsDict& env ) override;
+
+  void override_environment( const Engines::FieldsDict& env ) override;
+
+  Engines::FieldsDict *get_os_environment() override;
+  
+  void execute_python_code(const char *code) override;
 
-  virtual Engines::Component_ptr
-  create_component_instance( const char* componentName,
-                            CORBA::Long studyId); // 0 for multiStudy
+  virtual Engines::EngineComponent_ptr
+  create_component_instance_env(const char *componentName,
+                                const Engines::FieldsDict &env,
+                                CORBA::String_out reason);
 
-  Engines::Component_ptr
-  find_component_instance( const char* registeredName,
-                          CORBA::Long studyId); // 0 for multiStudy
+  virtual char *
+  create_python_service_instance(const char *CompName,
+                                 CORBA::String_out reason);
 
-  Engines::Component_ptr
-  load_impl(const char* nameToRegister,
-           const char* componentName);
+  Engines::EngineComponent_ptr
+  find_component_instance(const char *registeredName);
 
+  Engines::EngineComponent_ptr
+  load_impl(const char *nameToRegister,
+            const char *componentName);
 
-  void remove_impl(Engines::Component_ptr component_i);
+  bool is_SSL_mode() override { return this->isSSLMode(); }
+
+  Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
+
+  SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
+
+  void remove_impl(Engines::EngineComponent_ptr component_i);
   void finalize_removal();
 
   virtual void ping();
-  char* name();
+  CORBA::Long getNumberOfCPUCores();
+  Engines::vectorOfDouble* loadOfCPUCores();
+  void setPyScriptForCPULoad(const char *script);
+  void resetScriptForCPULoad();
+  CORBA::Long getTotalPhysicalMemory();
+  CORBA::Long getTotalPhysicalMemoryInUse();
+  CORBA::Long getTotalPhysicalMemoryInUseByMe();
+  char *name();
+  char *workingdir();
+  char *logfilename();
+  void logfilename(const char *name);
+
   virtual void Shutdown();
-  chargetHostName();
+  char *getHostName();
   CORBA::Long getPID();
   //! Kill current container
   bool Kill_impl();
 
-  Engines::fileRef_ptr createFileRef(const charorigFileName);
+  Engines::fileRef_ptr createFileRef(const char *origFileName);
   Engines::fileTransfer_ptr getFileTransfer();
 
-
+  virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
+  void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
+  Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
+  Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
+  Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
+  void removePyScriptNode(const char *nodeName) override;
+  void cleanAllPyScripts() override;
+  Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
   // --- local C++ methods
 
-  Engines::Component_ptr
-  find_or_create_instance( std::string genericRegisterName,
-                          std::string componentLibraryName);
+  Engines::EngineComponent_ptr
+  find_or_create_instance(std::string genericRegisterName,
+                          std::string componentLibraryName);
 
-  Engines::Component_ptr
-  createInstance(std::string genericRegisterName,
-                void *handle,
-                int studyId);
+  bool load_component_CppImplementation(const char *componentName, std::string &reason);
+  bool load_component_PythonImplementation(const char *componentName, std::string &reason);
+  bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
 
-  static bool isPythonContainer(const char* ContainerName);
+  Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
+  Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
+  Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
+
+  static bool isPythonContainer(const char *ContainerName);
   static void decInstanceCnt(std::string genericRegisterName);
   //??? char* machineName();
 
@@ -126,31 +158,78 @@ public:
   int getArgc() { return _argc; }
   char **getArgv() { return _argv; }
 
-protected:
+  void registerTemporaryFile(const std::string &fileName);
+  void unregisterTemporaryFile(const std::string &fileName);
+  void clearTemporaryFiles();
+  PortableServer::ObjectId *getCORBAId() const { return _id; }
 
+protected:
   static std::map<std::string, int> _cntInstances_map;
-  static std::map<std::string, void *> _library_map; // library names, loaded
-  static std::map<std::string, void *> _toRemove_map;// library names to remove
-  static omni_mutex _numInstanceMutex ; // lib and instance protection
+  static std::map<std::string, void *> _library_map;  // library names, loaded
+  static std::map<std::string, void *> _toRemove_map; // library names to remove
+  static omni_mutex _numInstanceMutex;                // lib and instance protection
 
   bool _isSupervContainer;
 
-  SALOME_NamingService *_NS ;
+  SALOME_NamingService_Container_Abstract *_NS;
   std::string _library_path;
   std::string _containerName;
+  std::string _logfilename;
+  std::string _load_script;
   CORBA::ORB_var _orb;
   PortableServer::POA_var _poa;
-  PortableServer::ObjectId * _id ;
-  int _numInstance ;
-  std::map<std::string,Engines::Component_var> _listInstances_map;
-  std::map<std::string,Engines::fileRef_var> _fileRef_map;
+  PortableServer::ObjectId *_id;
+  int _numInstance;
+  std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
+  std::map<std::string, Engines::fileRef_var> _fileRef_map;
+  std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
+  std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
+  std::map<std::string, Engines::PyNode_var> _dftPyNode;
+  Utils_Mutex _mutexForDftPy;
+  std::list<std::string> _tmp_files;
   Engines::fileTransfer_var _fileTransfer;
 
-  int    _argc ;
-  char** _argv ;
-  long   _pid;
-  bool   _isServantAloneInProcess;
+  int _argc;
+  char **_argv;
+  long _pid;
+  bool _isServantAloneInProcess;
 };
 
-#endif
+class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
+{
+public:
+  Engines_Container_i() { }
+  Engines_Container_i(CORBA::ORB_ptr orb,
+                      PortableServer::POA_ptr poa,
+                      char *containerName,
+                      int argc, char *argv[],
+                      SALOME_NamingService_Container_Abstract *ns = nullptr,
+                      bool isServantAloneInProcess = true) :
+                      Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
+  bool isSSLMode() const override { return false; }
+};
 
+class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_i
+{
+public:
+  Engines_Container_SSL_i();
+  Engines_Container_SSL_i(CORBA::ORB_ptr orb,
+                          PortableServer::POA_ptr poa,
+                          char *containerName,
+                          int argc, char *argv[],
+                          SALOME_NamingService_Container_Abstract *ns = nullptr,
+                          bool isServantAloneInProcess = true) :
+                          Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
+    bool isSSLMode() const override { return true; }
+};
+
+/*!
+ * Methods to be used in SSL mode to skip NS.
+ */
+namespace KERNEL
+{
+  CONTAINER_EXPORT Engines_Container_SSL_i *getContainerSA();
+  CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
+} // namespace KERNEL
+
+#endif