src/runtime/SalomeContainerTools.hxx

   1 // Copyright (C) 2006-2019  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef __SALOMECONTAINERTOOLS_HXX__
  21 #define __SALOMECONTAINERTOOLS_HXX__
  22
  23 #include "YACSRuntimeSALOMEExport.hxx"
  24 #include "SALOMEconfig.h"
  25 #include CORBA_CLIENT_HEADER(SALOME_ContainerManager)
  26
  27 #include <string>
  28 #include <vector>
  29 #include <map>
  30
  31 namespace YACS
  32 {
  33   namespace ENGINE
  34   {
  35     class Task;
  36     class Container;
  37     class ComponentInstance;
  38     class SalomeContainerHelper;
  39
  40     class YACSRUNTIMESALOME_EXPORT SalomeContainerToolsBase
  41     {
  42     public:
  43       virtual ~SalomeContainerToolsBase() { }
  44       virtual std::string getProperty(const std::string& name) const = 0;
  45       virtual void setProperty(const std::string& name, const std::string& value) = 0;
  46       virtual const std::map<std::string,std::string>& getProperties() const = 0;
  47       virtual void clearProperties() = 0;
  48       virtual std::map<std::string,std::string> getResourceProperties(const std::string& name) const = 0;
  49       virtual void addToComponentList(const std::string& name) = 0;
  50       virtual void addToResourceList(const std::string& name) = 0;
  51       virtual Engines::ContainerParameters getParameters() const = 0;
  52       virtual std::string getContainerName() const = 0;
  53       virtual void setContainerName(const std::string& name) = 0;
  54       virtual std::string getHostName() const = 0;
  55       virtual std::string getNotNullContainerName(const Container *contPtr, const Task *askingNode, bool& isEmpty) const = 0;
  56     public:
  57       static void Start(const std::vector<std::string>& compoNames, SalomeContainerHelper *schelp, SalomeContainerToolsBase& sct, int& shutdownLevel, const Container *cont, const Task *askingNode);
  58       static CORBA::Object_ptr LoadComponent(SalomeContainerHelper *launchModeType, Container *cont, Task *askingNode);
  59       static CORBA::Object_ptr CreateComponentInstance(Container *cont, Engines::Container_ptr contPtr, const ComponentInstance *inst);
  60       static std::string GetPlacementId(const SalomeContainerHelper *launchModeType, const Container *cont, const Task *askingNode);
  61       static std::string GetFullPlacementId(const SalomeContainerHelper *launchModeType, const Container *cont, const Task *askingNode);
  62       static void SetContainerNameOf(Engines::ContainerParameters& params, const std::string& name);
  63     };
  64
  65     class YACSRUNTIMESALOME_EXPORT SalomeContainerToolsInter : public SalomeContainerToolsBase
  66     {
  67     public:
  68       SalomeContainerToolsInter() { }
  69       SalomeContainerToolsInter(const SalomeContainerToolsInter& other);
  70       std::string getProperty(const std::string& name) const;
  71       const std::map<std::string,std::string>& getProperties() const { return _propertyMap; }
  72       void clearProperties();
  73       std::map<std::string,std::string> getResourceProperties(const std::string& name) const;
  74     protected:
  75       std::map<std::string,std::string> _propertyMap;
  76     };
  77
  78     class YACSRUNTIMESALOME_EXPORT SalomeContainerTools : public SalomeContainerToolsInter
  79     {
  80     public:
  81       SalomeContainerTools();
  82       SalomeContainerTools(const SalomeContainerTools& other);
  83       int getNumberOfCoresPerWorker() const;
  84     public:
  85       Engines::ContainerParameters getParameters() const { return _params; }
  86       void clearProperties();
  87       void setProperty(const std::string& name, const std::string& value);
  88       void addToComponentList(const std::string& name);
  89       void addToResourceList(const std::string& name);
  90       std::string getContainerName() const;
  91       void setContainerName(const std::string& name);
  92       std::string getHostName() const;
  93       std::string getNotNullContainerName(const Container *contPtr, const Task *askingNode, bool& isEmpty) const;
  94     protected:
  95       Engines::ContainerParameters _params;
  96     };
  97
  98     class PlayGround;
  99
 100     class YACSRUNTIMESALOME_EXPORT SalomeContainerToolsDecoratorBase : public SalomeContainerToolsBase
 101     {
 102     protected:
 103       SalomeContainerToolsDecoratorBase(SalomeContainerToolsBase *sct):_sct(sct) { }
 104       SalomeContainerToolsBase *getWorker() { return _sct; }
 105       const SalomeContainerToolsBase *getWorker() const { return _sct; }
 106     public:
 107       std::string getProperty(const std::string& name) const;
 108       void setProperty(const std::string& name, const std::string& value);
 109       const std::map<std::string,std::string>& getProperties() const;
 110       void clearProperties();
 111       std::map<std::string,std::string> getResourceProperties(const std::string& name) const;
 112       void addToComponentList(const std::string& name);
 113       void addToResourceList(const std::string& name);
 114       Engines::ContainerParameters getParameters() const;
 115       std::string getContainerName() const;
 116       void setContainerName(const std::string& name);
 117       std::string getHostName() const;
 118       std::string getNotNullContainerName(const Container *contPtr, const Task *askingNode, bool& isEmpty) const;
 119     private:
 120       SalomeContainerToolsBase *_sct;
 121     };
 122
 123     class SalomeHPContainerVectOfHelper;
 124
 125     class YACSRUNTIMESALOME_EXPORT SalomeContainerToolsSpreadOverTheResDecorator : public SalomeContainerToolsDecoratorBase
 126     {
 127     public:
 128       SalomeContainerToolsSpreadOverTheResDecorator(SalomeContainerToolsBase *sct, const PlayGround *pg, const SalomeHPContainerVectOfHelper *vh, const Task *node):SalomeContainerToolsDecoratorBase(sct),_pg(pg),_vh(vh),_node(node) { }
 129       Engines::ContainerParameters getParameters() const;
 130     private:
 131       static std::string DeduceMachineFrom(const std::vector< std::pair<std::string,int> >& allResInfo, int iPos, int sz, int nbProcPerNode);
 132     private:
 133       const PlayGround *_pg;
 134       const SalomeHPContainerVectOfHelper *_vh;
 135       const Task *_node;
 136     };
 137   }
 138 }
 139
 140 #endif