src/ResourcesManager/SALOME_ResourcesManager.cxx

   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 #include "SALOME_ResourcesManager.hxx"
  24 #include "Utils_ExceptHandlers.hxx"
  25 #include "Utils_CorbaException.hxx"
  26 #include "OpUtil.hxx"
  27
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #ifndef WIN32
  31 #include <unistd.h>
  32 #else
  33 #include <io.h>
  34 #include <process.h>
  35 #endif
  36 #include <fstream>
  37 #include <iostream>
  38 #include <sstream>
  39 #include <string.h>
  40 #include <map>
  41 #include <list>
  42
  43 #include <sys/types.h>
  44 #include <sys/stat.h>
  45 #include "utilities.h"
  46
  47 #define MAX_SIZE_FOR_HOSTNAME 256;
  48
  49 using namespace std;
  50
  51 const char *SALOME_ResourcesManager::_ResourcesManagerNameInNS = "/ResourcesManager";
  52
  53 //=============================================================================
  54 /*!
  55  * just for test
  56  */
  57 //=============================================================================
  58
  59 SALOME_ResourcesManager::SALOME_ResourcesManager(CORBA::ORB_ptr orb,
  60                                                  PortableServer::POA_var poa,
  61                                                  SALOME_NamingService_Abstract *ns,
  62                                                  const char *xmlFilePath)
  63 : _rm(new ResourcesManager_cpp(xmlFilePath))
  64 {
  65   MESSAGE("SALOME_ResourcesManager constructor");
  66   _NS = ns;
  67   _orb = CORBA::ORB::_duplicate(orb) ;
  68   //
  69   PortableServer::POAManager_var pman = poa->the_POAManager();
  70   CORBA::PolicyList policies;
  71   policies.length(1);
  72   PortableServer::ThreadPolicy_var threadPol(poa->create_thread_policy(PortableServer::SINGLE_THREAD_MODEL));
  73   policies[0] = PortableServer::ThreadPolicy::_duplicate(threadPol);
  74   _poa = poa->create_POA("SingleThreadPOA",pman,policies);
  75   threadPol->destroy();
  76   //
  77   PortableServer::ObjectId_var id = _poa->activate_object(this);
  78   CORBA::Object_var obj = _poa->id_to_reference(id);
  79   Engines::ResourcesManager_var refContMan = Engines::ResourcesManager::_narrow(obj);
  80   _NS->Register(refContMan,_ResourcesManagerNameInNS);
  81   MESSAGE("SALOME_ResourcesManager constructor end");
  82 }
  83
  84 //=============================================================================
  85 /*!
  86  *  Standard constructor, parse resource file.
  87  *  - if ${APPLI} exists in environment,
  88  *    look for ${HOME}/${APPLI}/CatalogResources.xml
  89  *  - else look for default:
  90  *    ${KERNEL_ROOT_DIR}/share/salome/resources/kernel/CatalogResources.xml
  91  *  - parse XML resource file.
  92  */
  93 //=============================================================================
  94
  95 SALOME_ResourcesManager::SALOME_ResourcesManager(CORBA::ORB_ptr orb,
  96                                                  PortableServer::POA_var poa,
  97                                                  SALOME_NamingService_Abstract *ns) : _rm(new ResourcesManager_cpp())
  98 {
  99   MESSAGE("SALOME_ResourcesManager constructor");
 100   _NS = ns;
 101   _orb = CORBA::ORB::_duplicate(orb) ;
 102   //
 103   PortableServer::POAManager_var pman = poa->the_POAManager();
 104   CORBA::PolicyList policies;
 105   policies.length(1);
 106   PortableServer::ThreadPolicy_var threadPol(poa->create_thread_policy(PortableServer::SINGLE_THREAD_MODEL));
 107   policies[0] = PortableServer::ThreadPolicy::_duplicate(threadPol);
 108   _poa = poa->create_POA("SingleThreadPOA",pman,policies);
 109   threadPol->destroy();
 110   //
 111   PortableServer::ObjectId_var id = _poa->activate_object(this);
 112   CORBA::Object_var obj = _poa->id_to_reference(id);
 113   Engines::ResourcesManager_var refContMan = Engines::ResourcesManager::_narrow(obj);
 114   if(_NS)
 115     _NS->Register(refContMan,_ResourcesManagerNameInNS);
 116
 117   MESSAGE("SALOME_ResourcesManager constructor end");
 118 }
 119
 120 //=============================================================================
 121 /*!
 122  *  Standard Destructor
 123  */
 124 //=============================================================================
 125
 126 SALOME_ResourcesManager::~SALOME_ResourcesManager()
 127 {
 128   MESSAGE("SALOME_ResourcesManager destructor");
 129 }
 130
 131
 132 //=============================================================================
 133 /*! CORBA method:
 134  *  shutdown all the containers, then the ContainerManager servant
 135  */
 136 //=============================================================================
 137
 138 void SALOME_ResourcesManager::Shutdown()
 139 {
 140   MESSAGE("Shutdown");
 141   if(!_NS)
 142     return ;
 143   _NS->Destroy_Name(_ResourcesManagerNameInNS);
 144   PortableServer::ObjectId_var oid = _poa->servant_to_id(this);
 145   _poa->deactivate_object(oid);
 146 }
 147
 148 /*!
 149  * Return list of resources available (regarding content of CatalogResources.xml). And for each resource the number of proc available of it.
 150  */
 151 void SALOME_ResourcesManager::ListAllAvailableResources(Engines::ResourceList_out machines, Engines::IntegerList_out nbProcsOfMachines)
 152 {
 153   const MapOfParserResourcesType& zeList(_rm->GetList());
 154   std::vector<std::string> ret0;
 155   std::vector<int> ret1;
 156   for(MapOfParserResourcesType::const_iterator it=zeList.begin();it!=zeList.end();it++)
 157   {
 158     const ParserResourcesType& elt((*it).second);
 159     if(elt.can_run_containers)
 160     {
 161       ret0.push_back(elt.HostName);
 162       ret1.push_back(elt.DataForSort._nbOfNodes*elt.DataForSort._nbOfProcPerNode);
 163     }
 164   }
 165   machines=new Engines::ResourceList;
 166   nbProcsOfMachines=new Engines::IntegerList;
 167   std::size_t sz(ret0.size());
 168   machines->length((CORBA::ULong)sz); nbProcsOfMachines->length((CORBA::ULong)sz);
 169   for(std::size_t j=0;j<sz;j++)
 170     {
 171       (*machines)[(CORBA::ULong)j]=CORBA::string_dup(ret0[j].c_str());
 172       (*nbProcsOfMachines)[(CORBA::ULong)j]=ret1[j];
 173     }
 174 }
 175
 176 //=============================================================================
 177 //! get the name of resources fitting the specified constraints (params)
 178 /*!
 179  *  If hostname specified, check it is local or known in resources catalog.
 180  *
 181  *  Else
 182  *  - select first machines with corresponding OS (all machines if
 183  *    parameter OS empty),
 184  *  - then select the sublist of machines on which the component is known
 185  *    (if the result is empty, that probably means that the inventory of
 186  *    components is probably not done, so give complete list from previous step)
 187  */
 188 //=============================================================================
 189
 190 Engines::ResourceList *
 191 SALOME_ResourcesManager::GetFittingResources(const Engines::ResourceParameters& params)
 192 {
 193   //MESSAGE("ResourcesManager::GetFittingResources");
 194   Engines::ResourceList_var ret;
 195
 196   // CORBA -> C++
 197   resourceParams p = resourceParameters_CORBAtoCPP(params);
 198
 199   try
 200   {
 201     // Call C++ ResourceManager
 202     std::vector <std::string> vec = _rm->GetFittingResources(p);
 203
 204     // C++ -> CORBA
 205     ret = resourceList_CPPtoCORBA(vec);
 206   }
 207   catch(const ResourcesException &ex)
 208   {
 209     INFOS("Caught exception in GetFittingResources C++:  " << ex.msg);
 210     THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
 211   }
 212
 213   return ret._retn();
 214 }
 215
 216 //=============================================================================
 217 /*!
 218  *  dynamically obtains the first machines
 219  */
 220 //=============================================================================
 221
 222 char *
 223 SALOME_ResourcesManager::FindFirst(const Engines::ResourceList& listOfResources)
 224 {
 225   // CORBA -> C++
 226   std::vector<std::string> rl = resourceList_CORBAtoCPP(listOfResources);
 227
 228   return CORBA::string_dup(_rm->Find("first", rl).c_str());
 229 }
 230
 231 char *
 232 SALOME_ResourcesManager::Find(const char* policy, const Engines::ResourceList& listOfResources)
 233 {
 234   // CORBA -> C++
 235   std::vector<std::string> rl = resourceList_CORBAtoCPP(listOfResources);
 236
 237   return CORBA::string_dup(_rm->Find(policy, rl).c_str());
 238 }
 239
 240 Engines::ResourceDefinition*
 241 SALOME_ResourcesManager::GetResourceDefinition(const char * name)
 242 {
 243   Engines::ResourceDefinition_var resDef;
 244   try {
 245     ParserResourcesType resource = _rm->GetResourcesDescr(name);
 246     resDef = resourceDefinition_CPPtoCORBA(resource);
 247   } catch (const exception & ex) {
 248     INFOS("Caught exception in GetResourceDefinition: " << ex.what());
 249     THROW_SALOME_CORBA_EXCEPTION(ex.what(), SALOME::BAD_PARAM);
 250   }
 251
 252   return resDef._retn();
 253 }
 254
 255 void
 256 SALOME_ResourcesManager::AddResource(const Engines::ResourceDefinition& new_resource,
 257                                      CORBA::Boolean write,
 258                                      const char * xml_file)
 259 {
 260   try
 261   {
 262     ParserResourcesType resource = resourceDefinition_CORBAtoCPP(new_resource);
 263     _rm->AddResourceInCatalog(resource);
 264
 265     if (write)
 266     {
 267       _rm->WriteInXmlFile(std::string(xml_file));
 268       _rm->ParseXmlFiles();
 269     }
 270   }
 271   catch (const SALOME_Exception & e)
 272   {
 273     INFOS("Error in AddResourceInCatalog: " << e);
 274     THROW_SALOME_CORBA_EXCEPTION(e.what(), SALOME::BAD_PARAM);
 275   }
 276   catch (const ResourcesException & e)
 277   {
 278     INFOS("Error in AddResourceInCatalog: " << e.msg);
 279     THROW_SALOME_CORBA_EXCEPTION(e.msg.c_str(), SALOME::BAD_PARAM);
 280   }
 281 }
 282
 283 void
 284 SALOME_ResourcesManager::RemoveResource(const char * resource_name,
 285                                         CORBA::Boolean write,
 286                                         const char * xml_file)
 287 {
 288   try
 289   {
 290     _rm->DeleteResourceInCatalog(resource_name);
 291   }
 292   catch (const SALOME_Exception & e)
 293   {
 294     INFOS("Error in DeleteResourceInCatalog: " << e);
 295     THROW_SALOME_CORBA_EXCEPTION(e.what(), SALOME::BAD_PARAM);
 296   }
 297
 298   if (write)
 299   {
 300     _rm->WriteInXmlFile(std::string(xml_file));
 301     _rm->ParseXmlFiles();
 302   }
 303 }
 304
 305 char *
 306 SALOME_ResourcesManager::getMachineFile(const char * resource_name,
 307                                         CORBA::Long nb_procs,
 308                                         const char * parallelLib)
 309 {
 310   std::string machine_file_name("");
 311
 312   if (std::string(parallelLib) == "Dummy")
 313   {
 314     MESSAGE("[getMachineFile] parallelLib is Dummy");
 315     MapOfParserResourcesType resourcesList = _rm->GetList();
 316     if (resourcesList.find(std::string(resource_name)) != resourcesList.end())
 317     {
 318       ParserResourcesType resource = resourcesList[std::string(resource_name)];
 319
 320       // Check if resource is cluster or not
 321       if (resource.ClusterMembersList.empty())
 322       {
 323         //It is not a cluster so we create a cluster with one machine
 324         ParserResourcesType fake_node;
 325         fake_node.HostName = resource.HostName;
 326         fake_node.Protocol = resource.Protocol;
 327         fake_node.ClusterInternalProtocol = resource.ClusterInternalProtocol;
 328         fake_node.UserName = resource.UserName;
 329         fake_node.AppliPath = resource.AppliPath;
 330         fake_node.DataForSort = resource.DataForSort;
 331
 332         resource.ClusterMembersList.push_front(fake_node);
 333       }
 334
 335       // Creating list of machines for creating the machine file
 336       std::list<std::string> list_of_machines;
 337       std::list<ParserResourcesType>::iterator cluster_it =
 338         resource.ClusterMembersList.begin();
 339       while (cluster_it != resource.ClusterMembersList.end())
 340       {
 341         // For each member of the cluster we add a nbOfNodes * nbOfProcPerNode in the list
 342         unsigned int number_of_proc = (*cluster_it).DataForSort._nbOfNodes *
 343                                       (*cluster_it).DataForSort._nbOfProcPerNode;
 344         for (unsigned int i = 0; i < number_of_proc; i++)
 345           list_of_machines.push_back((*cluster_it).HostName);
 346         cluster_it++;
 347       }
 348
 349       // Creating machine file
 350       machine_file_name = tmpnam(NULL);
 351       std::ofstream machine_file(machine_file_name.c_str(), std::ios_base::out);
 352
 353       CORBA::Long machine_number = 0;
 354       std::list<std::string>::iterator it = list_of_machines.begin();
 355       while (machine_number != nb_procs)
 356       {
 357         // Adding a new node to the machine file
 358         machine_file << *it << std::endl;
 359
 360         // counting...
 361         it++;
 362         if (it == list_of_machines.end())
 363           it = list_of_machines.begin();
 364         machine_number++;
 365       }
 366     }
 367     else
 368       INFOS("[getMachineFile] Error resource_name not found in resourcesList -> " << resource_name);
 369   }
 370   else if (std::string(parallelLib) == "Mpi")
 371   {
 372     MESSAGE("[getMachineFile] parallelLib is Mpi");
 373
 374     MapOfParserResourcesType resourcesList = _rm->GetList();
 375     if (resourcesList.find(std::string(resource_name)) != resourcesList.end())
 376     {
 377       ParserResourcesType resource = resourcesList[std::string(resource_name)];
 378       // Check if resource is cluster or not
 379       if (resource.ClusterMembersList.empty())
 380       {
 381         //It is not a cluster so we create a cluster with one machine
 382         ParserResourcesType fake_node;
 383         fake_node.HostName = resource.HostName;
 384         fake_node.Protocol = resource.Protocol;
 385         fake_node.ClusterInternalProtocol = resource.ClusterInternalProtocol;
 386         fake_node.UserName = resource.UserName;
 387         fake_node.AppliPath = resource.AppliPath;
 388         fake_node.DataForSort = resource.DataForSort;
 389
 390         resource.ClusterMembersList.push_front(fake_node);
 391       }
 392
 393       // Choose mpi implementation -> each MPI implementation has is own machinefile...
 394       if (resource.mpi == lam)
 395       {
 396         // Creating machine file
 397         machine_file_name = tmpnam(NULL);
 398         std::ofstream machine_file(machine_file_name.c_str(), std::ios_base::out);
 399
 400         // We add all cluster machines to the file
 401         std::list<ParserResourcesType>::iterator cluster_it =
 402           resource.ClusterMembersList.begin();
 403         while (cluster_it != resource.ClusterMembersList.end())
 404         {
 405           unsigned int number_of_proc = (*cluster_it).DataForSort._nbOfNodes *
 406             (*cluster_it).DataForSort._nbOfProcPerNode;
 407           machine_file << (*cluster_it).HostName << " cpu=" << number_of_proc << std::endl;
 408           cluster_it++;
 409         }
 410       }
 411       else if ((resource.mpi == openmpi) || (resource.mpi == ompi))
 412       {
 413         // Creating machine file
 414         machine_file_name = tmpnam(NULL);
 415         std::ofstream machine_file(machine_file_name.c_str(), std::ios_base::out);
 416
 417         // We add all cluster machines to the file
 418         std::list<ParserResourcesType>::iterator cluster_it =
 419           resource.ClusterMembersList.begin();
 420         while (cluster_it != resource.ClusterMembersList.end())
 421         {
 422           unsigned int number_of_proc = (*cluster_it).DataForSort._nbOfNodes *
 423             (*cluster_it).DataForSort._nbOfProcPerNode;
 424           machine_file << (*cluster_it).HostName << " slots=" << number_of_proc << std::endl;
 425           cluster_it++;
 426         }
 427       }
 428       else if (resource.mpi == nompi)
 429       {
 430         INFOS("[getMachineFile] Error resource_name MPI implementation was defined for " << resource_name);
 431       }
 432       else
 433         INFOS("[getMachineFile] Error resource_name MPI implementation not currently handled for " << resource_name);
 434     }
 435     else
 436       INFOS("[getMachineFile] Error resource_name not found in resourcesList -> " << resource_name);
 437   }
 438   else
 439     INFOS("[getMachineFile] Error parallelLib is not handled -> " << parallelLib);
 440
 441   return CORBA::string_dup(machine_file_name.c_str());
 442 }