src/Container/SALOME_ContainerManager.hxx

   1 // Copyright (C) 2007-2022  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 #ifndef __SALOME_CONTAINERMANAGER_HXX__
  24 #define __SALOME_CONTAINERMANAGER_HXX__
  25
  26 #include "SALOME_Container.hxx"
  27
  28 #include <SALOMEconfig.h>
  29 #include CORBA_CLIENT_HEADER(SALOME_Component)
  30 #include CORBA_CLIENT_HEADER(SALOME_ContainerManager)
  31 #include "SALOME_ResourcesCatalog_Parser.hxx"
  32
  33 #include "Utils_Mutex.hxx"
  34
  35 #include <string>
  36 #include <set>
  37
  38 class SALOME_NamingService_Abstract;
  39 class SALOME_ResourcesManager_Client;
  40
  41 class CONTAINER_EXPORT SALOME_ContainerManager : public POA_Engines::ContainerManager
  42 {
  43
  44 public:
  45   SALOME_ContainerManager(CORBA::ORB_ptr orb, PortableServer::POA_var poa, SALOME_NamingService_Abstract *ns);
  46   ~SALOME_ContainerManager();
  47
  48   // Corba Methods
  49   Engines::Container_ptr GiveContainer(const Engines::ContainerParameters& params);
  50
  51   void ShutdownContainers();
  52
  53   // C++ Methods
  54   void Shutdown();
  55
  56   void DeclareUsingSalomeSession() { _isSSL = false; }
  57
  58   static const char *_ContainerManagerNameInNS;
  59
  60 protected:
  61   // C++ methods
  62   Engines::Container_ptr
  63   FindContainer(const Engines::ContainerParameters& params,
  64                 const Engines::ResourceList& possibleResources);
  65
  66   Engines::Container_ptr
  67   FindContainer(const Engines::ContainerParameters& params,
  68                 const std::string& resource);
  69
  70   std::string GetCppBinaryOfKernelContainer() const;
  71
  72   std::string GetRunRemoteExecutableScript() const;
  73
  74   std::string BuildCommandToLaunchRemoteContainer(const std::string & resource_name,
  75                                                   const Engines::ContainerParameters& params,
  76                                                   const std::string& container_exe="SALOME_Container") const;
  77
  78   std::string BuildCommandToLaunchLocalContainer(const Engines::ContainerParameters& params,
  79                                                  const std::string& machinesFile,
  80                                                  const std::string& container_exe,//"SALOME_Container"
  81                                                  std::string& tmpFileName) const;
  82
  83   std::string BuildTempFileToLaunchRemoteContainer(const std::string& resource_name,
  84                                                    const Engines::ContainerParameters& params, std::string& tmpFileName) const;
  85
  86   static void RmTmpFile(std::string& tmpFile);
  87
  88   void AddOmninamesParams(std::string& command) const;
  89
  90   void AddOmninamesParams(std::ostream& fileStream) const;
  91
  92   static std::string BuildTemporaryFileName();
  93
  94   std::string GetMPIZeroNode(const std::string machine, const std::string machinesFile) const;
  95
  96   std::string machinesFile(const int nbproc);
  97
  98   std::string getCommandToRunRemoteProcessCommon(const std::string& templateName, const std::string& remoteScript,
  99                                           AccessProtocolType protocol,
 100                                           const std::string & hostname,
 101                                           const std::string & username,
 102                                           const std::string & applipath,
 103                                           const std::string & workdir) const;
 104
 105   std::string getCommandToRunRemoteProcess(AccessProtocolType protocol,
 106                                           const std::string & hostname,
 107                                           const std::string & username,
 108                                           const std::string & applipath,
 109                                           const std::string & workdir="") const;
 110
 111   std::string getCommandToRunRemoteProcessNoAppli(AccessProtocolType protocol,
 112                                           const std::string & hostname,
 113                                           const std::string & username,
 114                                           const std::string & applipath,
 115                                           const std::string & workdir="") const;
 116
 117   Engines::Container_ptr
 118   LaunchContainer(const Engines::ContainerParameters& params,
 119                   const std::string & resource_selected,
 120                   const std::string & hostname,
 121                   const std::string & machFile,
 122                   const std::string & containerNameInNS);
 123
 124   CORBA::ORB_var _orb;
 125   PortableServer::POA_var _poa;
 126
 127   SALOME_ResourcesManager_Client *_resManager;
 128   SALOME_NamingService_Abstract *_NS;
 129
 130   //! different behaviour if $APPLI exists (SALOME Application)
 131   bool _isAppliSalomeDefined;
 132
 133   //! attribute that contains the number of processes used in batch mode by MPI containers
 134   int _nbprocUsed;
 135
 136   //! attribute that specifies the launch mode.
 137   bool _isSSL = true;
 138
 139   static omni_mutex _numInstanceMutex ; // lib and instance protection
 140
 141   //! attributes to allow concurrency for // GiveContainer
 142   Utils_Mutex _giveContainerMutex1;
 143
 144   pid_t _pid_mpiServer;
 145
 146   // Begin of PacO++ Parallel extension
 147   typedef std::vector<std::string> actual_launch_machine_t;
 148
 149   bool checkPaCOParameters(Engines::ContainerParameters & params, std::string resource_selected);
 150
 151   Engines::Container_ptr
 152   StartPaCOPPContainer(const Engines::ContainerParameters& params, std::string resource_selected);
 153
 154
 155
 156   std::string BuildCommandToLaunchPaCOProxyContainer(const Engines::ContainerParameters& params,
 157                                                      std::string machine_file_name,
 158                                                      std::string & proxy_hostname);
 159
 160   std::string BuildCommandToLaunchPaCONodeContainer(const Engines::ContainerParameters& params,
 161                                                     const std::string & machine_file_name,
 162                                                     SALOME_ContainerManager::actual_launch_machine_t & vect_machine,
 163                                                     const std::string & proxy_hostname);
 164
 165   void LogConfiguration(const std::string & log_type,
 166                         const std::string & exe_type,
 167                         const std::string & container_name,
 168                         const std::string & hostname,
 169                         std::string & begin,
 170                         std::string & end);
 171
 172   CORBA::Object_ptr
 173   LaunchPaCOProxyContainer(const std::string& command,
 174                            const Engines::ContainerParameters& params,
 175                            const std::string& hostname);
 176
 177   bool
 178   LaunchPaCONodeContainer(const std::string& command,
 179                           const Engines::ContainerParameters& params,
 180                           const std::string& name,
 181                           SALOME_ContainerManager::actual_launch_machine_t & vect_machine);
 182   // End of PaCO++ Parallel extension
 183 public:
 184   static char *GetenvThreadSafe(const char *name);
 185   static std::string GetenvThreadSafeAsString(const char *name);
 186   static int SystemThreadSafe(const char *command);
 187   static long SystemWithPIDThreadSafe(const std::vector<std::string>& command);
 188   static void AddOmninamesParams(std::ostream& fileStream, SALOME_NamingService_Abstract *ns);
 189   static void MakeTheCommandToBeLaunchedASync(std::string& command);
 190   static int GetTimeOutToLoaunchServer();
 191   static void SleepInSecond(int ellapseTimeInSecond);
 192  private:
 193   static const int TIME_OUT_TO_LAUNCH_CONT;
 194   static Utils_Mutex _getenvMutex;
 195   static Utils_Mutex _systemMutex;
 196 };
 197 #endif