Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
af8ccc4a6d7823e069e03f90274fb553d2d4d4ad
[simgrid.git] / src / surf / plugins / host_dvfs.cpp
1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simgrid/plugins/dvfs.h"
7 #include "simgrid/plugins/load.h"
8 #include "src/plugins/vm/VirtualMachineImpl.hpp"
9 #include <xbt/config.hpp>
10
11 #include <boost/algorithm/string.hpp>
12
13 /** @addtogroup SURF_plugin_load
14
15   This plugin makes it very simple for users to obtain the current load for each host.
16
17 */
18
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_dvfs, surf, "Logging specific to the SURF HostDvfs plugin");
20
21 static const char* property_sampling_rate = "plugin/dvfs/sampling_rate";
22 static const char* property_governor      = "plugin/dvfs/governor";
23
24 namespace simgrid {
25 namespace plugin {
26
27 namespace dvfs {
28 class Governor {
29
30 private:
31   simgrid::s4u::Host* const host_;
32
33 protected:
34   simgrid::s4u::Host* get_host() const { return host_; }
35
36 public:
37   double sampling_rate;
38
39   explicit Governor(simgrid::s4u::Host* ptr) : host_(ptr) { init(); }
40   virtual ~Governor() = default;
41
42   void init()
43   {
44     const char* local_sampling_rate_config = host_->get_property(property_sampling_rate);
45     double global_sampling_rate_config     = simgrid::config::get_value<double>(property_sampling_rate);
46     if (local_sampling_rate_config != nullptr) {
47       sampling_rate = std::stod(local_sampling_rate_config);
48     } else {
49       sampling_rate = global_sampling_rate_config;
50     }
51   }
52
53   virtual void update()         = 0;
54   virtual std::string getName() = 0;
55   double samplingRate() { return sampling_rate; }
56 };
57
58 /**
59  * The linux kernel doc describes this governor as follows:
60  * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
61  *
62  * > The CPUfreq governor "performance" sets the CPU statically to the
63  * > highest frequency within the borders of scaling_min_freq and
64  * > scaling_max_freq.
65  *
66  * We do not support scaling_min_freq/scaling_max_freq -- we just pick the lowest frequency.
67  */
68 class Performance : public Governor {
69 public:
70   explicit Performance(simgrid::s4u::Host* ptr) : Governor(ptr) {}
71
72   void update() override { get_host()->setPstate(0); }
73   std::string getName() override { return "Performance"; }
74 };
75
76 /**
77  * The linux kernel doc describes this governor as follows:
78  * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
79  *
80  * > The CPUfreq governor "powersave" sets the CPU statically to the
81  * > lowest frequency within the borders of scaling_min_freq and
82  * > scaling_max_freq.
83  *
84  * We do not support scaling_min_freq/scaling_max_freq -- we just pick the lowest frequency.
85  */
86 class Powersave : public Governor {
87 public:
88   explicit Powersave(simgrid::s4u::Host* ptr) : Governor(ptr) {}
89
90   void update() override { get_host()->setPstate(get_host()->getPstatesCount() - 1); }
91   std::string getName() override { return "Powersave"; }
92 };
93
94 /**
95  * The linux kernel doc describes this governor as follows:
96  * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
97  *
98  * > The CPUfreq governor "ondemand" sets the CPU frequency depending on the
99  * > current system load. [...] when triggered, cpufreq checks
100  * > the CPU-usage statistics over the last period and the governor sets the
101  * > CPU accordingly.
102  */
103 class OnDemand : public Governor {
104   /**
105    * See https://elixir.bootlin.com/linux/v4.15.4/source/drivers/cpufreq/cpufreq_ondemand.c
106    * DEF_FREQUENCY_UP_THRESHOLD and od_update()
107    */
108   double freq_up_threshold = 0.80;
109
110 public:
111   explicit OnDemand(simgrid::s4u::Host* ptr) : Governor(ptr) {}
112
113   std::string getName() override { return "OnDemand"; }
114   void update() override
115   {
116     double load = get_host()->getCoreCount() * sg_host_get_avg_load(get_host());
117     sg_host_load_reset(get_host()); // Only consider the period between two calls to this method!
118
119     if (load > freq_up_threshold) {
120       get_host()->setPstate(0); /* Run at max. performance! */
121       XBT_INFO("Load: %f > threshold: %f --> changed to pstate %i", load, freq_up_threshold, 0);
122     } else {
123       /* The actual implementation uses a formula here: (See Kernel file cpufreq_ondemand.c:158)
124        *
125        *    freq_next = min_f + load * (max_f - min_f) / 100
126        *
127        * So they assume that frequency increases by 100 MHz. We will just use
128        * lowest_pstate - load*pstatesCount()
129        */
130       int max_pstate = get_host()->getPstatesCount() - 1;
131       // Load is now < freq_up_threshold; exclude pstate 0 (the fastest)
132       // because pstate 0 can only be selected if load > freq_up_threshold
133       int new_pstate = max_pstate - load * (max_pstate + 1);
134       get_host()->setPstate(new_pstate);
135
136       XBT_DEBUG("Load: %f < threshold: %f --> changed to pstate %i", load, freq_up_threshold, new_pstate);
137     }
138   }
139 };
140
141 /**
142  * This is the conservative governor, which is very similar to the
143  * OnDemand governor. The Linux Kernel Documentation describes it
144  * very well, see https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt:
145  *
146  * > The CPUfreq governor "conservative", much like the "ondemand"
147  * > governor, sets the CPU frequency depending on the current usage.  It
148  * > differs in behaviour in that it gracefully increases and decreases the
149  * > CPU speed rather than jumping to max speed the moment there is any load
150  * > on the CPU. This behaviour is more suitable in a battery powered
151  * > environment.
152  */
153 class Conservative : public Governor {
154   double freq_up_threshold   = .8;
155   double freq_down_threshold = .2;
156
157 public:
158   explicit Conservative(simgrid::s4u::Host* ptr) : Governor(ptr) {}
159
160   virtual std::string getName() override { return "Conservative"; }
161   virtual void update() override
162   {
163     double load = get_host()->getCoreCount() * sg_host_get_avg_load(get_host());
164     int pstate  = get_host()->getPstate();
165     sg_host_load_reset(get_host()); // Only consider the period between two calls to this method!
166
167     if (load > freq_up_threshold) {
168       if (pstate != 0) {
169         get_host()->setPstate(pstate - 1);
170         XBT_INFO("Load: %f > threshold: %f -> increasing performance to pstate %d", load, freq_up_threshold, pstate - 1);
171       }
172       else {
173         XBT_DEBUG("Load: %f > threshold: %f -> but cannot speed up even more, already in highest pstate %d", load, freq_up_threshold, pstate);
174       }
175     } else if (load < freq_down_threshold) {
176       int max_pstate = get_host()->getPstatesCount() - 1;
177       if (pstate != max_pstate) { // Are we in the slowest pstate already?
178         get_host()->setPstate(pstate + 1);
179         XBT_INFO("Load: %f < threshold: %f -> slowing down to pstate %d", load, freq_down_threshold, pstate + 1);
180       }
181       else {
182         XBT_DEBUG("Load: %f < threshold: %f -> cannot slow down even more, already in slowest pstate %d", load, freq_down_threshold, pstate);
183       }
184     }
185   }
186 };
187
188 /**
189  *  Add this to your host tag:
190  *    - \<prop id="plugin/dvfs/governor" value="performance" /\>
191  *
192  *  Valid values as of now are: performance, powersave, ondemand, conservative
193  *  It doesn't matter if you use uppercase or lowercase.
194  *
195  *  For the sampling rate, use this:
196  *
197  *    - \<prop id="plugin/dvfs/sampling_rate" value="2" /\>
198  *
199  *  This will run the update() method of the specified governor every 2 seconds
200  *  on that host.
201  *
202  *  These properties can also be used within the \<config\> tag to configure
203  *  these values globally. Using them within the \<host\> will overwrite this
204  *  global configuration
205  */
206 class HostDvfs {
207 public:
208   static simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> EXTENSION_ID;
209
210   explicit HostDvfs(simgrid::s4u::Host*);
211   ~HostDvfs();
212 };
213
214 simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> HostDvfs::EXTENSION_ID;
215
216 HostDvfs::HostDvfs(simgrid::s4u::Host* ptr) {}
217
218 HostDvfs::~HostDvfs() = default;
219 }
220 }
221 }
222
223 using simgrid::plugin::dvfs::HostDvfs;
224
225 /* **************************** events  callback *************************** */
226 static void on_host_added(simgrid::s4u::Host& host)
227 {
228   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
229     return;
230
231   std::string name              = std::string("dvfs-daemon-") + host.get_cname();
232   simgrid::s4u::ActorPtr daemon = simgrid::s4u::Actor::create(name.c_str(), &host, []() {
233     /**
234      * This lambda function is the function the actor (daemon) will execute
235      * all the time - in the case of the dvfs plugin, this controls when to
236      * lower/raise the frequency.
237      */
238     simgrid::s4u::ActorPtr daemon_proc = simgrid::s4u::Actor::self();
239
240     XBT_DEBUG("DVFS process on %s is a daemon: %d", daemon_proc->get_host()->get_cname(), daemon_proc->is_daemon());
241
242     std::string dvfs_governor;
243     const char* host_conf = daemon_proc->get_host()->get_property(property_governor);
244     if (host_conf != nullptr) {
245       dvfs_governor = std::string(daemon_proc->get_host()->get_property(property_governor));
246       boost::algorithm::to_lower(dvfs_governor);
247     } else {
248       dvfs_governor = simgrid::config::get_value<std::string>(property_governor);
249       boost::algorithm::to_lower(dvfs_governor);
250     }
251
252     auto governor = [&dvfs_governor, &daemon_proc]() {
253       if (dvfs_governor == "conservative") {
254         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
255             new simgrid::plugin::dvfs::Conservative(daemon_proc->get_host()));
256       } else if (dvfs_governor == "ondemand") {
257         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
258             new simgrid::plugin::dvfs::OnDemand(daemon_proc->get_host()));
259       } else if (dvfs_governor == "performance") {
260         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
261             new simgrid::plugin::dvfs::Performance(daemon_proc->get_host()));
262       } else if (dvfs_governor == "powersave") {
263         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
264             new simgrid::plugin::dvfs::Powersave(daemon_proc->get_host()));
265       } else {
266         XBT_CRITICAL("No governor specified for host %s, falling back to Performance",
267                      daemon_proc->get_host()->get_cname());
268         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
269             new simgrid::plugin::dvfs::Performance(daemon_proc->get_host()));
270       }
271     }();
272
273     while (1) {
274       // Sleep *before* updating; important for startup (i.e., t = 0).
275       // In the beginning, we want to go with the pstates specified in the platform file
276       // (so we sleep first)
277       simgrid::s4u::this_actor::sleep_for(governor->samplingRate());
278       governor->update();
279       XBT_DEBUG("Governor (%s) just updated!", governor->getName().c_str());
280     }
281
282     XBT_WARN("I should have never reached this point: daemons should be killed when all regular processes are done");
283     return 0;
284   });
285
286   // This call must be placed in this function. Otherweise, the daemonize() call comes too late and
287   // SMPI will take this process as an MPI process!
288   daemon->daemonize();
289 }
290
291 /* **************************** Public interface *************************** */
292
293 /** \ingroup SURF_plugin_load
294  * \brief Initializes the HostDvfs plugin
295  * \details The HostDvfs plugin provides an API to get the current load of each host.
296  */
297 void sg_host_dvfs_plugin_init()
298 {
299   if (HostDvfs::EXTENSION_ID.valid())
300     return;
301
302   HostDvfs::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostDvfs>();
303
304   sg_host_load_plugin_init();
305
306   simgrid::s4u::Host::on_creation.connect(&on_host_added);
307   simgrid::config::declare_flag<double>(
308       property_sampling_rate, "How often should the dvfs plugin check whether the frequency needs to be changed?", 0.1);
309   simgrid::config::declare_flag<std::string>(
310       property_governor, "Which Governor should be used that adapts the CPU frequency?", "performance");
311 }