Salome HOME
updated copyright message
[modules/yacs.git] / src / workloadmanager / DefaultAlgorithm.hxx
1 // Copyright (C) 2020-2023  CEA, EDF
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 #ifndef ALGORITHMIMPLEMENT_H
20 #define ALGORITHMIMPLEMENT_H
21
22 #include "YACSlibWorkloadmanagerExport.hxx"
23 #include "WorkloadAlgorithm.hxx"
24 #include <set>
25 #include <map>
26 #include <list>
27
28 namespace WorkloadManager
29 {
30 /**
31  * @todo write docs
32  */
33 class YACSLIBWLM_EXPORT DefaultAlgorithm : public WorkloadAlgorithm
34 {
35 public:
36   void addTask(Task* t)override;
37   void addResource(const Resource& r)override;
38   LaunchInfo chooseTask()override;
39   void liberate(const LaunchInfo& info)override;
40   bool empty()const override;
41   void freezeResources() override { _resourcesFrozen = true;}
42
43 // ----------------------------- PRIVATE ----------------------------- //
44 private:
45   class ResourceInfoForContainer
46   {
47   public:
48     ResourceInfoForContainer(const Resource& r, const ContainerType& ctype);
49     unsigned int maxContainers()const;
50     unsigned int  alloc();
51     void free(unsigned int index);
52     unsigned int nbRunningContainers()const;
53     bool isContainerRunning(unsigned int index)const;
54     bool operator<(const ResourceInfoForContainer& other)const
55     { return _ctype < other._ctype;}
56     bool operator==(const ContainerType& other)const
57     { return _ctype == other;}
58     const ContainerType& type()const { return _ctype;}
59   private:
60     ContainerType _ctype;
61     const Resource& _resource; // same ref as ResourceLoadInfo
62     std::set<unsigned int> _runningContainers; // 0 to max possible containers on this resource
63     unsigned int _firstFreeContainer;
64   };
65
66   class ResourceLoadInfo
67   {
68   public:
69     ResourceLoadInfo(const Resource& r);
70     bool isSupported(const ContainerType& ctype)const;
71     bool isAllocPossible(const ContainerType& ctype)const;
72     float cost(const ContainerType& ctype)const;
73     unsigned int alloc(const ContainerType& ctype);
74     void free(const ContainerType& ctype, int index);
75     bool operator<(const ResourceLoadInfo& other)const
76     { return _resource < other._resource;}
77     bool operator==(const Resource& other)const
78     { return _resource == other;}
79     const Resource& resource()const { return _resource;}
80     float COST_FOR_0_CORE_TASKS = 1.0 / 4096.0 ;
81   private:
82     Resource _resource;
83     float _load;
84     float _loadCost;
85     std::list<ResourceInfoForContainer> _ctypes;
86   };
87
88 private:
89   std::list<ResourceLoadInfo> _resources;
90   std::list<Task*> _waitingTasks;
91   bool _resourcesFrozen = false;
92 };
93 }
94 #endif // ALGORITHMIMPLEMENT_H