src/Container/SALOME_Container_i.hxx

   1 // Copyright (C) 2007-2024  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 #include <vector>
  51
  52 class SALOME_NamingService_Container_Abstract;
  53
  54 class CONTAINER_EXPORT Abstract_Engines_Container_i : public virtual POA_Engines::Container,
  55                                                       public virtual PortableServer::ServantBase
  56 {
  57 public:
  58   Abstract_Engines_Container_i();
  59   Abstract_Engines_Container_i(const std::string& pyContainerClsName,
  60                                CORBA::ORB_ptr orb,
  61                                PortableServer::POA_ptr poa,
  62                                char *containerName,
  63                                int argc, char *argv[],
  64                                SALOME_NamingService_Container_Abstract *ns = nullptr,
  65                                bool isServantAloneInProcess = true);
  66   virtual ~Abstract_Engines_Container_i();
  67
  68   virtual bool isSSLMode() const = 0;
  69
  70  std::string getPyContainerClassName() const { return _py_container_name; }
  71
  72   // --- CORBA methods
  73
  74   virtual bool load_component_Library(const char *componentName, CORBA::String_out reason);
  75
  76   virtual Engines::EngineComponent_ptr
  77   create_component_instance(const char *componentName);
  78
  79   void override_environment_python( const Engines::FieldsDict& env ) override;
  80
  81   void override_environment( const Engines::FieldsDict& env ) override;
  82
  83   Engines::FieldsDict *get_os_environment() override;
  84
  85   void set_big_obj_on_disk_threshold(CORBA::Long thresholdInByte) override;
  86
  87   void set_big_obj_on_disk_directory(const char *directory) override;
  88
  89   void set_number_of_retry(CORBA::Long nbRetry) override;
  90
  91   void set_directory_for_replay_files(const char *directory) override;
  92
  93   void set_startup_code(const char *codeAtStartUp) override;
  94
  95   char *get_startup_code() override;
  96
  97   void addLogFileNameGroup(const Engines::vectorOfString& groupOfLogFileNames) override;
  98
  99   Engines::vectorOfVectorOfString *getAllLogFileNameGroups() override;
 100
 101   void execute_python_code(const char *code) override;
 102
 103   virtual Engines::EngineComponent_ptr
 104   create_component_instance_env(const char *componentName,
 105                                 const Engines::FieldsDict &env,
 106                                 CORBA::String_out reason);
 107
 108   virtual char *
 109   create_python_service_instance(const char *CompName,
 110                                  CORBA::String_out reason);
 111
 112   Engines::EngineComponent_ptr
 113   find_component_instance(const char *registeredName);
 114
 115   Engines::EngineComponent_ptr
 116   load_impl(const char *nameToRegister,
 117             const char *componentName);
 118
 119   bool is_SSL_mode() override { return this->isSSLMode(); }
 120
 121   Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
 122
 123   SALOME_NamingService_Container_Abstract *getNS() const { return _NS; }
 124
 125   void remove_impl(Engines::EngineComponent_ptr component_i);
 126   void finalize_removal();
 127
 128   virtual void ping();
 129   CORBA::Long getNumberOfCPUCores();
 130   Engines::vectorOfDouble* loadOfCPUCores();
 131   void setPyScriptForCPULoad(const char *script);
 132   void resetScriptForCPULoad();
 133   CORBA::Long getTotalPhysicalMemory();
 134   CORBA::Long getTotalPhysicalMemoryInUse();
 135   CORBA::Long getTotalPhysicalMemoryInUseByMe();
 136   char *name();
 137   char *workingdir();
 138   char *logfilename() override;
 139   void logfilename(const char *name) override;
 140   char *locallogfilename() override;
 141   void locallogfilename(const char *name) override;
 142   CORBA::Long monitoringtimeresms() override;
 143   void monitoringtimeresms(CORBA::Long intervalInMs) override;
 144   void verbosity(bool& activated, CORBA::String_out level) override;
 145   void setVerbosity(bool activated, const char *level) override;
 146
 147   void Shutdown() override;
 148   void ShutdownNow() override;
 149   char *getHostName();
 150   CORBA::Long getPID();
 151   //! Kill current container
 152   bool Kill_impl();
 153
 154   Engines::fileRef_ptr createFileRef(const char *origFileName);
 155   Engines::fileTransfer_ptr getFileTransfer();
 156
 157   virtual Engines::Salome_file_ptr createSalome_file(const char *origFileName);
 158   void copyFile(Engines::Container_ptr container, const char *remoteFile, const char *localFile);
 159   Engines::PyNode_ptr createPyNode(const char *nodeName, const char *code);
 160   Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
 161   Engines::PyScriptNode_ptr createPyScriptNode(const char *nodeName, const char *code);
 162   void removePyScriptNode(const char *nodeName) override;
 163   void cleanAllPyScripts() override;
 164   Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
 165   // --- local C++ methods
 166
 167   Engines::EngineComponent_ptr
 168   find_or_create_instance(std::string genericRegisterName,
 169                           std::string componentLibraryName);
 170
 171   bool load_component_CppImplementation(const char *componentName, std::string &reason);
 172   bool load_component_PythonImplementation(const char *componentName, std::string &reason);
 173   bool load_component_ExecutableImplementation(const char *componentName, std::string &reason);
 174
 175   Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string &error);
 176   Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict &env, std::string &error);
 177   Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string &error);
 178
 179   static bool isPythonContainer(const char *ContainerName);
 180   static void decInstanceCnt(std::string genericRegisterName);
 181   //??? char* machineName();
 182
 183   // --- needed for parallel components, Numerical Platon
 184
 185   int getArgc() { return _argc; }
 186   char **getArgv() { return _argv; }
 187
 188   void registerTemporaryFile(const std::string &fileName);
 189   void unregisterTemporaryFile(const std::string &fileName);
 190   void clearTemporaryFiles();
 191   PortableServer::ObjectId *getCORBAId() const { return _id; }
 192 public:
 193   static const int DFT_TIME_INTERVAL_BTW_MEASURE;
 194 private:
 195   void ShutdownCommonPart();
 196 protected:
 197   static std::map<std::string, int> _cntInstances_map;
 198   static std::map<std::string, void *> _library_map;  // library names, loaded
 199   static std::map<std::string, void *> _toRemove_map; // library names to remove
 200   static omni_mutex _numInstanceMutex;                // lib and instance protection
 201
 202   bool _isSupervContainer;
 203
 204   SALOME_NamingService_Container_Abstract *_NS;
 205   std::string _library_path;
 206   std::string _containerName;
 207   std::string _logfilename;
 208   std::string _localfilename;
 209   std::string _load_script;
 210   std::string _py_container_name;
 211   std::string _code_at_startup;
 212   CORBA::ORB_var _orb;
 213   PortableServer::POA_var _poa;
 214   PortableServer::ObjectId *_id;
 215   int _numInstance;
 216   std::map<std::string, Engines::EngineComponent_var> _listInstances_map;
 217   std::map<std::string, Engines::fileRef_var> _fileRef_map;
 218   std::map<std::string, Engines::Salome_file_var> _Salome_file_map;
 219   std::map<std::string, Engines::PyScriptNode_var> _dftPyScriptNode;
 220   std::map<std::string, Engines::PyNode_var> _dftPyNode;
 221   Utils_Mutex _mutexForDftPy;
 222   std::list<std::string> _tmp_files;
 223   Engines::fileTransfer_var _fileTransfer;
 224   std::vector< std::vector<std::string> > _groups_of_log_files;
 225
 226   int _argc;
 227   char **_argv;
 228   long _pid;
 229   bool _isServantAloneInProcess;
 230 };
 231
 232 constexpr char PY_CONTAINER_CLS_NAME_IN_PROCESS[] = "SALOME_Container_i";
 233 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY[] = "SALOME_Container_OutOfProcess_i";
 234 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY[] = "SALOME_Container_OutOfProcess_Replay_i";
 235 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY_FT[] = "SALOME_Container_OutOfProcess_FT_i";
 236 constexpr char PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY_FT[] = "SALOME_Container_OutOfProcess_Replay_FT_i";
 237
 238 class CONTAINER_EXPORT Engines_Container_i : public Abstract_Engines_Container_i
 239 {
 240 public:
 241   Engines_Container_i() { }
 242   Engines_Container_i(CORBA::ORB_ptr orb,
 243                       PortableServer::POA_ptr poa,
 244                       char *containerName,
 245                       int argc, char *argv[],
 246                       SALOME_NamingService_Container_Abstract *ns = nullptr,
 247                       bool isServantAloneInProcess = true) :
 248                       Abstract_Engines_Container_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 249   bool isSSLMode() const override { return false; }
 250 };
 251
 252 class CONTAINER_EXPORT Abstract_Engines_Container_SSL_i : public Abstract_Engines_Container_i
 253 {
 254 public:
 255   Abstract_Engines_Container_SSL_i(const std::string& pyContainerClsName,
 256                           CORBA::ORB_ptr orb,
 257                           PortableServer::POA_ptr poa,
 258                           char *containerName,
 259                           int argc, char *argv[],
 260                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 261                           bool isServantAloneInProcess = true) :
 262                           Abstract_Engines_Container_i(pyContainerClsName, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 263     bool isSSLMode() const override { return true; }
 264 };
 265
 266 class CONTAINER_EXPORT Engines_Container_SSL_i : public Abstract_Engines_Container_SSL_i
 267 {
 268 public:
 269   Engines_Container_SSL_i(CORBA::ORB_ptr orb,
 270                           PortableServer::POA_ptr poa,
 271                           char *containerName,
 272                           int argc, char *argv[],
 273                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 274                           bool isServantAloneInProcess = true) :
 275                           Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_IN_PROCESS, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 276 };
 277
 278 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_i : public Abstract_Engines_Container_SSL_i
 279 {
 280 public:
 281   Engines_Container_SSL_OutOfProcess_i(CORBA::ORB_ptr orb,
 282                           PortableServer::POA_ptr poa,
 283                           char *containerName,
 284                           int argc, char *argv[],
 285                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 286                           bool isServantAloneInProcess = true) :
 287                           Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 288 };
 289
 290 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_i : public Abstract_Engines_Container_SSL_i
 291 {
 292 public:
 293   Engines_Container_SSL_OutOfProcess_Replay_i(CORBA::ORB_ptr orb,
 294                           PortableServer::POA_ptr poa,
 295                           char *containerName,
 296                           int argc, char *argv[],
 297                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 298                           bool isServantAloneInProcess = true) :
 299                           Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 300 };
 301
 302 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_FT_i : public Abstract_Engines_Container_SSL_i
 303 {
 304 public:
 305   Engines_Container_SSL_OutOfProcess_FT_i(CORBA::ORB_ptr orb,
 306                           PortableServer::POA_ptr poa,
 307                           char *containerName,
 308                           int argc, char *argv[],
 309                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 310                           bool isServantAloneInProcess = true) :
 311                           Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_NO_REPLAY_FT, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 312 };
 313
 314 class CONTAINER_EXPORT Engines_Container_SSL_OutOfProcess_Replay_FT_i : public Abstract_Engines_Container_SSL_i
 315 {
 316 public:
 317   Engines_Container_SSL_OutOfProcess_Replay_FT_i(CORBA::ORB_ptr orb,
 318                           PortableServer::POA_ptr poa,
 319                           char *containerName,
 320                           int argc, char *argv[],
 321                           SALOME_NamingService_Container_Abstract *ns = nullptr,
 322                           bool isServantAloneInProcess = true) :
 323                           Abstract_Engines_Container_SSL_i(PY_CONTAINER_CLS_NAME_OUT_PROCESS_WITH_REPLAY_FT, orb, poa, containerName, argc, argv, ns, isServantAloneInProcess) {}
 324 };
 325
 326 /*!
 327  * Methods to be used in SSL mode to skip NS.
 328  */
 329 namespace KERNEL
 330 {
 331   CONTAINER_EXPORT Abstract_Engines_Container_SSL_i *getContainerSA();
 332   CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
 333 } // namespace KERNEL
 334
 335 #endif