src/Container/SALOME_Container_i.hxx

   1 // Copyright (C) 2007-2021  CEA/DEN, EDF R&D, 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 Engines_Container_i:
  54   public virtual POA_Engines::Container,
  55   public virtual PortableServer::ServantBase
  56 {
  57 public:
  58   Engines_Container_i();
  59   Engines_Container_i(CORBA::ORB_ptr orb,
  60                       PortableServer::POA_ptr poa,
  61                       char * containerName ,
  62                       int argc, char* argv[],
  63                       SALOME_NamingService_Container_Abstract *ns = nullptr,
  64                       bool isServantAloneInProcess = true);
  65   virtual ~Engines_Container_i();
  66
  67   // --- CORBA methods
  68
  69   virtual bool load_component_Library(const char* componentName, CORBA::String_out reason);
  70
  71   virtual Engines::EngineComponent_ptr
  72   create_component_instance( const char* componentName);
  73
  74   virtual Engines::EngineComponent_ptr
  75   create_component_instance_env( const char* componentName,
  76                                  const Engines::FieldsDict& env,
  77                                  CORBA::String_out reason);
  78
  79   virtual char *
  80   create_python_service_instance(const char* CompName,
  81                                  CORBA::String_out reason);
  82
  83   Engines::EngineComponent_ptr
  84   find_component_instance( const char* registeredName);
  85
  86   Engines::EngineComponent_ptr
  87   load_impl(const char* nameToRegister,
  88             const char* componentName);
  89
  90   Engines::EmbeddedNamingService_ptr get_embedded_NS_if_ssl() override;
  91
  92   void remove_impl(Engines::EngineComponent_ptr component_i);
  93   void finalize_removal();
  94
  95   virtual void ping();
  96   char* name();
  97   char* workingdir();
  98   char* logfilename();
  99   void logfilename(const char* name);
 100
 101   virtual void Shutdown();
 102   char* getHostName();
 103   CORBA::Long getPID();
 104   //! Kill current container
 105   bool Kill_impl();
 106
 107   Engines::fileRef_ptr createFileRef(const char* origFileName);
 108   Engines::fileTransfer_ptr getFileTransfer();
 109
 110   virtual Engines::Salome_file_ptr createSalome_file(const char* origFileName);
 111   void copyFile(Engines::Container_ptr container, const char* remoteFile, const char* localFile);
 112   Engines::PyNode_ptr createPyNode(const char* nodeName, const char* code);
 113   Engines::PyNode_ptr getDefaultPyNode(const char *nodeName);
 114   Engines::PyScriptNode_ptr createPyScriptNode(const char* nodeName, const char* code);
 115   void removePyScriptNode(const char *nodeName) override;
 116   void cleanAllPyScripts() override;
 117   Engines::PyScriptNode_ptr getDefaultPyScriptNode(const char *nodeName);
 118   // --- local C++ methods
 119
 120   Engines::EngineComponent_ptr
 121   find_or_create_instance( std::string genericRegisterName,
 122                            std::string componentLibraryName);
 123
 124   bool load_component_CppImplementation(const char* componentName,std::string& reason);
 125   bool load_component_PythonImplementation(const char* componentName,std::string& reason);
 126   bool load_component_ExecutableImplementation(const char* componentName,std::string& reason);
 127
 128   Engines::EngineComponent_ptr createPythonInstance(std::string CompName, std::string& error);
 129   Engines::EngineComponent_ptr createExecutableInstance(std::string CompName, const Engines::FieldsDict& env, std::string& error);
 130   Engines::EngineComponent_ptr createInstance(std::string genericRegisterName, void *handle, std::string& error);
 131
 132   static bool isPythonContainer(const char* ContainerName);
 133   static void decInstanceCnt(std::string genericRegisterName);
 134   //??? char* machineName();
 135
 136   // --- needed for parallel components, Numerical Platon
 137
 138   int getArgc() { return _argc; }
 139   char **getArgv() { return _argv; }
 140
 141   void registerTemporaryFile( const std::string& fileName );
 142   void unregisterTemporaryFile( const std::string& fileName );
 143   void clearTemporaryFiles();
 144   PortableServer::ObjectId *getCORBAId() const { return _id; }
 145
 146 protected:
 147
 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
 152
 153   bool _isSupervContainer;
 154
 155   SALOME_NamingService_Container_Abstract *_NS ;
 156   std::string _library_path;
 157   std::string _containerName;
 158   std::string _logfilename;
 159   CORBA::ORB_var _orb;
 160   PortableServer::POA_var _poa;
 161   PortableServer::ObjectId * _id ;
 162   int _numInstance ;
 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;
 171
 172   int    _argc ;
 173   char** _argv ;
 174   long   _pid;
 175   bool   _isServantAloneInProcess;
 176 };
 177
 178 /*!
 179  * Methods to be used in SSL mode to skip NS.
 180  */
 181 namespace KERNEL
 182 {
 183   CONTAINER_EXPORT Engines_Container_i *getContainerSA();
 184   CONTAINER_EXPORT Engines::Container_var getContainerRefSA();
 185 }
 186
 187 #endif