src/Container/SALOME_Container_i.hxx

   1 // Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  SALOME Container : implementation of container and engine for Kernel
  24 //  File   : SALOME_Container_i.hxx
  25 //  Author : Paul RASCLE, EDF - MARC TAJCHMAN, CEA
  26 //  Module : SALOME
  27 //  $Header$
  28 //
  29 #ifndef _SALOME_CONTAINER_I_HXX_
  30 #define _SALOME_CONTAINER_I_HXX_
  31
  32 #include "SALOME_Container.hxx"
  33 #include "Utils_Mutex.hxx"
  34
  35 #include <SALOMEconfig.h>
  36 #include CORBA_SERVER_HEADER(SALOME_Component)
  37 #include CORBA_SERVER_HEADER(SALOME_PyNode)
  38
  39 #include <iostream>
  40 #include <signal.h>
  41 #include <stdlib.h>
  42 #ifndef WIN32
  43 #include <unistd.h>
  44 #endif
  45 #include <sys/types.h>
  46 #include <omnithread.h>
  47 #include <map>
  48 #include <list>
  49 #include <string>
  50
  51 class SALOME_NamingService_Container_Abstract;
  52
  53 class CONTAINER_EXPORT Abstract_Engines_Container_i : public virtual POA_Engines::Container,
  54                                                       public virtual PortableServer::ServantBase
  55 {
  56 public:
  57   Abstract_Engines_Container_i();
  58   Abstract_Engines_Container_i(CORBA::ORB_ptr orb,
  59                                PortableServer::POA_ptr poa,
  60                                char *containerName,
  61                                int argc, char *argv[],
  62                                SALOME_NamingService_Container_Abstract *ns = nullptr,
  63                                bool isServantAloneInProcess = true);
  64   virtual ~Abstract_Engines_Container_i();
  65
  66   virtual bool isSSLMode() const = 0;
  67
  68   // --- CORBA methods
  69
  70   virtual bool load_component_Library(const char *componentName, CORBA::String_out reason);
  71
  72   virtual Engines::EngineComponent_ptr
  73   create_component_instance(const char *componentName);
  74
  75   virtual Engines::EngineComponent_ptr
  76   create_component_instance_env(const char *componentName,
  77                                 const Engines::FieldsDict &env,
  78                                 CORBA::String_out reason);
  79
  80   virtual char *
  81   create_python_service_instance(const char *CompName,
  82                                  CORBA::String_out reason);
  83
  84   Engines::EngineComponent_ptr
  85   find_component_instance(const char *registeredName);
  86
  87   Engines::EngineComponent_ptr
  88   load_impl(const char *nameToRegister,
  89             const char *componentName);
  90
  91   bool is_SSL_mode() override { return this->isSSLMode(); }
  92
  93   Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
  94
  95   SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
  96
  97   void remove_impl(Engines::EngineComponent_ptr component_i);
  98   void finalize_removal();
  99
 100   virtual void ping();
 101   CORBA::Long getNumberOfCPUCores();
 102   Engines::vectorOfDouble* loadOfCPUCores();
 103   void setPyScriptForCPULoad(const char *script);
 104   void resetScriptForCPULoad();
 105   CORBA::Long getTotalPhysicalMemory();
 106   CORBA::Long getTotalPhysicalMemoryInUse();
 107   CORBA::Long getTotalPhysicalMemoryInUseByMe();
 108   char *name();
 109   char *workingdir();
 110   char *logfilename();
 111   void logfilename(const char *name);
 112
 113   virtual void Shutdown();
 114   char *getHostName();
 115   CORBA::Long getPID();
 116   //! Kill current container
 117   bool Kill_impl();
 118
 119   Engines::fileRef_ptr createFileRef(const char *origFileName);
 120   Engines::fileTransfer_ptr getFileTransfer();
 121
 122   virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
 123   void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
 124   Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
 125   Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
 126   Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
 127   void removePyScriptNode(const char *nodeName) override;
 128   void cleanAllPyScripts() override;
 129   Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
 130   // --- local C++ methods
 131
 132   Engines::EngineComponent_ptr
 133   find_or_create_instance(std::string genericRegisterName,
 134                           std::string componentLibraryName);
 135
 136   bool load_component_CppImplementation(const char *componentName, std::string &reason);
 137   bool load_component_PythonImplementation(const char *componentName, std::string &reason);
 138   bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
 139
 140   Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
 141   Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
 142   Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
 143
 144   static bool isPythonContainer(const char *ContainerName);
 145   static void decInstanceCnt(std::string genericRegisterName);
 146   //??? char* machineName();
 147
 148   // --- needed for parallel components, Numerical Platon
 149
 150   int getArgc() { return _argc; }
 151   char **getArgv() { return _argv; }
 152
 153   void registerTemporaryFile(const std::string &fileName);
 154   void unregisterTemporaryFile(const std::string &fileName);
 155   void clearTemporaryFiles();
 156   PortableServer::ObjectId *getCORBAId() const { return _id; }
 157
 158 protected:
 159   static std::map<std::string, int> _cntInstances_map;
 160   static std::map<std::string, void *> _library_map;  // library names, loaded
 161   static std::map<std::string, void *> _toRemove_map; // library names to remove
 162   static omni_mutex _numInstanceMutex;                // lib and instance protection
 163
 164   bool _isSupervContainer;
 165
 166   SALOME_NamingService_Container_Abstract *_NS;
 167   std::string _library_path;
 168   std::string _containerName;
 169   std::string _logfilename;
 170   std::string _load_script;
 171   CORBA::ORB_var _orb;
 172   PortableServer::POA_var _poa;
 173   PortableServer::ObjectId *_id;
 174   int _numInstance;
 175   std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
 176   std::map<std::string, Engines::fileRef_var> _fileRef_map;
 177   std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
 178   std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
 179   std::map<std::string, Engines::PyNode_var> _dftPyNode;
 180   Utils_Mutex _mutexForDftPy;
 181   std::list<std::string> _tmp_files;
 182   Engines::fileTransfer_var _fileTransfer;
 183
 184   int _argc;
 185   char **_argv;
 186   long _pid;
 187   bool _isServantAloneInProcess;
 188 };
 189
 190 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
 191 {
 192 public:
 193   Engines_Container_i() { }
 194   Engines_Container_i(CORBA::ORB_ptr orb,
 195                       PortableServer::POA_ptr poa,
 196                       char *containerName,
 197                       int argc, char *argv[],
 198                       SALOME_NamingService_Container_Abstract *ns = nullptr,
 199                       bool isServantAloneInProcess = true) :
 200                       Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 201   bool isSSLMode() const override { return false; }
 202 };
 203
 204 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_i
 205 {
 206 public:
 207   Engines_Container_SSL_i();
 208   Engines_Container_SSL_i(CORBA::ORB_ptr orb,
 209                           PortableServer::POA_ptr poa,
 210                           char *containerName,
 211                           int argc, char *argv[],
 212                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 213                           bool isServantAloneInProcess = true) :
 214                           Abstract_Engines_Container_i(orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 215     bool isSSLMode() const override { return true; }
 216 };
 217
 218 /*!
 219  * Methods to be used in SSL mode to skip NS.
 220  */
 221 namespace KERNEL
 222 {
 223   CONTAINER_EXPORT Engines_Container_SSL_i *getContainerSA();
 224   CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
 225 } // namespace KERNEL
 226
 227 #endif