Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Apply the default settings of 'smpi/buffering' too
[simgrid.git] / src / plugins / host_dvfs.cpp
1 /* Copyright (c) 2010-2019. 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 "simgrid/s4u/Engine.hpp"
9 #include "src/internal_config.h" // HAVE_SMPI
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "src/plugins/vm/VirtualMachineImpl.hpp"
12 #if HAVE_SMPI
13 #include "src/smpi/plugins/ampi/ampi.hpp"
14 #endif
15 #include <xbt/config.hpp>
16
17 #include <boost/algorithm/string.hpp>
18 #if HAVE_SMPI
19 #include "src/smpi/include/smpi_request.hpp"
20 #endif
21
22 SIMGRID_REGISTER_PLUGIN(host_dvfs, "Dvfs support", &sg_host_dvfs_plugin_init)
23
24 static simgrid::config::Flag<double> cfg_sampling_rate("plugin/dvfs/sampling-rate", {"plugin/dvfs/sampling_rate"},
25     "How often should the dvfs plugin check whether the frequency needs to be changed?", 0.1,
26     [](double val){if (val != 0.1) sg_host_dvfs_plugin_init();});
27
28 static simgrid::config::Flag<std::string> cfg_governor("plugin/dvfs/governor",
29                                                        "Which Governor should be used that adapts the CPU frequency?",
30                                                        "performance",
31
32                                                        std::map<std::string, std::string>({
33 #if HAVE_SMPI
34                                                          {"adagio", "TODO: Doc"},
35 #endif
36                                                              {"conservative", "TODO: Doc"}, {"ondemand", "TODO: Doc"},
37                                                              {"performance", "TODO: Doc"}, {"powersave", "TODO: Doc"},
38                                                        }),
39
40                                                        [](const std::string& val) {
41                                                          if (val != "performance")
42                                                            sg_host_dvfs_plugin_init();
43                                                        });
44
45 static simgrid::config::Flag<int>
46     cfg_min_pstate("plugin/dvfs/min-pstate", {"plugin/dvfs/min_pstate"},
47                    "Which pstate is the minimum (and hence fastest) pstate for this governor?", 0);
48
49 static const int max_pstate_not_limited = -1;
50 static simgrid::config::Flag<int>
51     cfg_max_pstate("plugin/dvfs/max-pstate", {"plugin/dvfs/max_pstate"},
52                    "Which pstate is the maximum (and hence slowest) pstate for this governor?", max_pstate_not_limited);
53
54 /** @addtogroup SURF_plugin_load
55
56   This plugin makes it very simple for users to obtain the current load for each host.
57
58 */
59
60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_dvfs, surf, "Logging specific to the SURF HostDvfs plugin");
61
62 namespace simgrid {
63 namespace plugin {
64
65 namespace dvfs {
66
67 /**
68  *  Add this to your host tag:
69  *    - \<prop id="plugin/dvfs/governor" value="performance" /\>
70  *
71  *  Valid values as of now are: performance, powersave, ondemand, conservative
72  *  It doesn't matter if you use uppercase or lowercase.
73  *
74  *  For the sampling rate, use this:
75  *
76  *    - \<prop id="plugin/dvfs/sampling-rate" value="2" /\>
77  *
78  *  This will run the update() method of the specified governor every 2 seconds
79  *  on that host.
80  *
81  *  These properties can also be used within the \<config\> tag to configure
82  *  these values globally. Using them within the \<host\> will overwrite this
83  *  global configuration
84  */
85 class Governor {
86
87 private:
88   simgrid::s4u::Host* const host_;
89   double sampling_rate_;
90   int min_pstate; //< Never use a pstate less than this one
91   int max_pstate; //< Never use a pstate larger than this one
92
93 public:
94   explicit Governor(simgrid::s4u::Host* ptr)
95       : host_(ptr)
96       , min_pstate(cfg_min_pstate)
97       , max_pstate(cfg_max_pstate == max_pstate_not_limited ? host_->get_pstate_count() - 1 : cfg_max_pstate)
98   {
99     init();
100   }
101   virtual ~Governor() = default;
102   virtual std::string get_name() const = 0;
103   simgrid::s4u::Host* get_host() const { return host_; }
104   int get_min_pstate() const { return min_pstate; }
105   int get_max_pstate() const { return max_pstate; }
106
107   void init()
108   {
109     const char* local_sampling_rate_config = host_->get_property(cfg_sampling_rate.get_name());
110     if (local_sampling_rate_config != nullptr) {
111       sampling_rate_ = std::stod(local_sampling_rate_config);
112     } else {
113       sampling_rate_ = cfg_sampling_rate;
114     }
115     const char* local_min_pstate_config = host_->get_property(cfg_min_pstate.get_name());
116     if (local_min_pstate_config != nullptr) {
117       min_pstate = std::stoi(local_min_pstate_config);
118     }
119
120     const char* local_max_pstate_config = host_->get_property(cfg_max_pstate.get_name());
121     if (local_max_pstate_config != nullptr) {
122       max_pstate = std::stod(local_max_pstate_config);
123     }
124     xbt_assert(max_pstate <= host_->get_pstate_count() - 1, "Value for max_pstate too large!");
125     xbt_assert(min_pstate <= max_pstate, "min_pstate is larger than max_pstate!");
126     xbt_assert(0 <= min_pstate, "min_pstate is negative!");
127   }
128
129   virtual void update()         = 0;
130   double get_sampling_rate() const { return sampling_rate_; }
131 };
132
133 /**
134  * The linux kernel doc describes this governor as follows:
135  * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
136  *
137  * > The CPUfreq governor "performance" sets the CPU statically to the
138  * > highest frequency within the borders of scaling_min_freq and
139  * > scaling_max_freq.
140  *
141  * We do not support scaling_min_freq/scaling_max_freq -- we just pick the lowest frequency.
142  */
143 class Performance : public Governor {
144 public:
145   explicit Performance(simgrid::s4u::Host* ptr) : Governor(ptr) {}
146   std::string get_name() const override { return "Performance"; }
147
148   void update() override { get_host()->set_pstate(get_min_pstate()); }
149 };
150
151 /**
152  * The linux kernel doc describes this governor as follows:
153  * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
154  *
155  * > The CPUfreq governor "powersave" sets the CPU statically to the
156  * > lowest frequency within the borders of scaling_min_freq and
157  * > scaling_max_freq.
158  *
159  * We do not support scaling_min_freq/scaling_max_freq -- we just pick the lowest frequency.
160  */
161 class Powersave : public Governor {
162 public:
163   explicit Powersave(simgrid::s4u::Host* ptr) : Governor(ptr) {}
164   std::string get_name() const override { return "Powersave"; }
165
166   void update() override { get_host()->set_pstate(get_max_pstate()); }
167 };
168
169 /**
170  * The linux kernel doc describes this governor as follows:
171  * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
172  *
173  * > The CPUfreq governor "ondemand" sets the CPU frequency depending on the
174  * > current system load. [...] when triggered, cpufreq checks
175  * > the CPU-usage statistics over the last period and the governor sets the
176  * > CPU accordingly.
177  */
178 class OnDemand : public Governor {
179   /**
180    * See https://elixir.bootlin.com/linux/v4.15.4/source/drivers/cpufreq/cpufreq_ondemand.c
181    * DEF_FREQUENCY_UP_THRESHOLD and od_update()
182    */
183   double freq_up_threshold_ = 0.80;
184
185 public:
186   explicit OnDemand(simgrid::s4u::Host* ptr) : Governor(ptr) {}
187   std::string get_name() const override { return "OnDemand"; }
188
189   void update() override
190   {
191     double load = get_host()->get_core_count() * sg_host_get_avg_load(get_host());
192     sg_host_load_reset(get_host()); // Only consider the period between two calls to this method!
193
194     if (load > freq_up_threshold_) {
195       get_host()->set_pstate(get_min_pstate()); /* Run at max. performance! */
196       XBT_INFO("Load: %f > threshold: %f --> changed to pstate %i", load, freq_up_threshold_, get_min_pstate());
197     } else {
198       /* The actual implementation uses a formula here: (See Kernel file cpufreq_ondemand.c:158)
199        *
200        *    freq_next = min_f + load * (max_f - min_f) / 100
201        *
202        * So they assume that frequency increases by 100 MHz. We will just use
203        * lowest_pstate - load*pstatesCount()
204        */
205       // Load is now < freq_up_threshold; exclude pstate 0 (the fastest)
206       // because pstate 0 can only be selected if load > freq_up_threshold_
207       int new_pstate = get_max_pstate() - load * (get_max_pstate() + 1);
208       if (new_pstate < get_min_pstate())
209         new_pstate = get_min_pstate();
210       get_host()->set_pstate(new_pstate);
211
212       XBT_DEBUG("Load: %f < threshold: %f --> changed to pstate %i", load, freq_up_threshold_, new_pstate);
213     }
214   }
215 };
216
217 /**
218  * This is the conservative governor, which is very similar to the
219  * OnDemand governor. The Linux Kernel Documentation describes it
220  * very well, see https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt:
221  *
222  * > The CPUfreq governor "conservative", much like the "ondemand"
223  * > governor, sets the CPU frequency depending on the current usage.  It
224  * > differs in behaviour in that it gracefully increases and decreases the
225  * > CPU speed rather than jumping to max speed the moment there is any load
226  * > on the CPU. This behaviour is more suitable in a battery powered
227  * > environment.
228  */
229 class Conservative : public Governor {
230   double freq_up_threshold_   = .8;
231   double freq_down_threshold_ = .2;
232
233 public:
234   explicit Conservative(simgrid::s4u::Host* ptr) : Governor(ptr) {}
235   virtual std::string get_name() const override { return "Conservative"; }
236
237   virtual void update() override
238   {
239     double load = get_host()->get_core_count() * sg_host_get_avg_load(get_host());
240     int pstate  = get_host()->get_pstate();
241     sg_host_load_reset(get_host()); // Only consider the period between two calls to this method!
242
243     if (load > freq_up_threshold_) {
244       if (pstate != get_min_pstate()) {
245         get_host()->set_pstate(pstate - 1);
246         XBT_INFO("Load: %f > threshold: %f -> increasing performance to pstate %d", load, freq_up_threshold_,
247                  pstate - 1);
248       } else {
249         XBT_DEBUG("Load: %f > threshold: %f -> but cannot speed up even more, already in highest pstate %d", load,
250                   freq_up_threshold_, pstate);
251       }
252     } else if (load < freq_down_threshold_) {
253       if (pstate != get_max_pstate()) { // Are we in the slowest pstate already?
254         get_host()->set_pstate(pstate + 1);
255         XBT_INFO("Load: %f < threshold: %f -> slowing down to pstate %d", load, freq_down_threshold_, pstate + 1);
256       } else {
257         XBT_DEBUG("Load: %f < threshold: %f -> cannot slow down even more, already in slowest pstate %d", load,
258                   freq_down_threshold_, pstate);
259       }
260     }
261   }
262 };
263
264 #if HAVE_SMPI
265 class Adagio : public Governor {
266 private:
267   int best_pstate     = 0;
268   double start_time   = 0;
269   double comp_counter = 0;
270   double comp_timer   = 0;
271
272   std::vector<std::vector<double>> rates; // Each host + all frequencies of that host
273
274   unsigned int task_id   = 0;
275   bool iteration_running = false; /*< Are we currently between iteration_in and iteration_out calls? */
276
277 public:
278   explicit Adagio(simgrid::s4u::Host* ptr)
279       : Governor(ptr), rates(100, std::vector<double>(ptr->get_pstate_count(), 0.0))
280   {
281     simgrid::smpi::plugin::ampi::on_iteration_in.connect([this](simgrid::s4u::Actor const& actor) {
282       // Every instance of this class subscribes to this event, so one per host
283       // This means that for any actor, all 'hosts' are normally notified of these
284       // changes, even those who don't currently run the actor 'proc_id'.
285       // -> Let's check if this signal call is for us!
286       if (get_host() == actor.get_host()) {
287         iteration_running = true;
288       }
289     });
290     simgrid::smpi::plugin::ampi::on_iteration_out.connect([this](simgrid::s4u::Actor const& actor) {
291       if (get_host() == actor.get_host()) {
292         iteration_running = false;
293         task_id           = 0;
294       }
295     });
296     simgrid::kernel::activity::ExecImpl::on_creation.connect(
297         [this](simgrid::kernel::activity::ExecImpl const& activity) {
298           if (activity.get_host() == get_host())
299             pre_task();
300         });
301     simgrid::kernel::activity::ExecImpl::on_completion.connect(
302         [this](simgrid::kernel::activity::ExecImpl const& activity) {
303           // For more than one host (not yet supported), we can access the host via
304           // simcalls_.front()->issuer->iface()->get_host()
305           if (activity.get_host() == get_host() && iteration_running) {
306             comp_timer += activity.surf_action_->get_finish_time() - activity.surf_action_->get_start_time();
307           }
308         });
309     // FIXME I think that this fires at the same time for all hosts, so when the src sends something,
310     // the dst will be notified even though it didn't even arrive at the recv yet
311     simgrid::s4u::Link::on_communicate.connect(
312         [this](kernel::resource::NetworkAction const&, s4u::Host* src, s4u::Host* dst) {
313           if ((get_host() == src || get_host() == dst) && iteration_running) {
314             post_task();
315           }
316         });
317   }
318
319   virtual std::string get_name() const override { return "Adagio"; }
320
321   void pre_task()
322   {
323     sg_host_load_reset(get_host());
324     comp_counter = sg_host_get_computed_flops(get_host()); // Should be 0 because of the reset
325     comp_timer   = 0;
326     start_time   = simgrid::s4u::Engine::get_clock();
327     if (rates.size() <= task_id)
328       rates.resize(task_id + 5, std::vector<double>(get_host()->get_pstate_count(), 0.0));
329     if (rates[task_id][best_pstate] == 0)
330       best_pstate = 0;
331     get_host()->set_pstate(best_pstate); // Load our schedule
332     XBT_DEBUG("Set pstate to %i", best_pstate);
333   }
334
335   void post_task()
336   {
337     double computed_flops = sg_host_get_computed_flops(get_host()) - comp_counter;
338     double target_time    = (simgrid::s4u::Engine::get_clock() - start_time);
339     target_time           = target_time * 99.0 / 100.0; // FIXME We account for t_copy arbitrarily with 1%
340                                                         // -- this needs to be fixed
341
342     bool is_initialized         = rates[task_id][best_pstate] != 0;
343     rates[task_id][best_pstate] = computed_flops / comp_timer;
344     if (not is_initialized) {
345       for (int i = 1; i < get_host()->get_pstate_count(); i++) {
346         rates[task_id][i] = rates[task_id][0] * (get_host()->get_pstate_speed(i) / get_host()->get_speed());
347       }
348     }
349
350     for (int pstate = get_host()->get_pstate_count() - 1; pstate >= 0; pstate--) {
351       if (computed_flops / rates[task_id][pstate] <= target_time) {
352         // We just found the pstate we want to use!
353         best_pstate = pstate;
354         break;
355       }
356     }
357     task_id++;
358   }
359
360   virtual void update() override {}
361 };
362 #endif
363 } // namespace dvfs
364 } // namespace plugin
365 } // namespace simgrid
366
367 /* **************************** events  callback *************************** */
368 static void on_host_added(simgrid::s4u::Host& host)
369 {
370   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
371     return;
372
373   std::string name              = std::string("dvfs-daemon-") + host.get_cname();
374   simgrid::s4u::ActorPtr daemon = simgrid::s4u::Actor::create(name.c_str(), &host, []() {
375     /**
376      * This lambda function is the function the actor (daemon) will execute
377      * all the time - in the case of the dvfs plugin, this controls when to
378      * lower/raise the frequency.
379      */
380     simgrid::s4u::ActorPtr daemon_proc = simgrid::s4u::Actor::self();
381
382     XBT_DEBUG("DVFS process on %s is a daemon: %d", daemon_proc->get_host()->get_cname(), daemon_proc->is_daemon());
383
384     std::string dvfs_governor;
385     const char* host_conf = daemon_proc->get_host()->get_property("plugin/dvfs/governor");
386     if (host_conf != nullptr) {
387       dvfs_governor = std::string(host_conf);
388       boost::algorithm::to_lower(dvfs_governor);
389     } else {
390       dvfs_governor = cfg_governor;
391       boost::algorithm::to_lower(dvfs_governor);
392     }
393
394     auto governor = [&dvfs_governor, &daemon_proc]() {
395       if (dvfs_governor == "conservative") {
396         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
397             new simgrid::plugin::dvfs::Conservative(daemon_proc->get_host()));
398       } else if (dvfs_governor == "ondemand") {
399         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
400             new simgrid::plugin::dvfs::OnDemand(daemon_proc->get_host()));
401       }
402 #if HAVE_SMPI
403       else if (dvfs_governor == "adagio") {
404         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
405             new simgrid::plugin::dvfs::Adagio(daemon_proc->get_host()));
406       }
407 #endif
408       else if (dvfs_governor == "performance") {
409         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
410             new simgrid::plugin::dvfs::Performance(daemon_proc->get_host()));
411       } else if (dvfs_governor == "powersave") {
412         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
413             new simgrid::plugin::dvfs::Powersave(daemon_proc->get_host()));
414       } else {
415         XBT_CRITICAL("No governor specified for host %s, falling back to Performance",
416                      daemon_proc->get_host()->get_cname());
417         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
418             new simgrid::plugin::dvfs::Performance(daemon_proc->get_host()));
419       }
420     }();
421
422     while (1) {
423       // Sleep *before* updating; important for startup (i.e., t = 0).
424       // In the beginning, we want to go with the pstates specified in the platform file
425       // (so we sleep first)
426       simgrid::s4u::this_actor::sleep_for(governor->get_sampling_rate());
427       governor->update();
428       XBT_DEBUG("Governor (%s) just updated!", governor->get_name().c_str());
429     }
430
431     XBT_WARN("I should have never reached this point: daemons should be killed when all regular processes are done");
432     return 0;
433   });
434
435   // This call must be placed in this function. Otherwise, the daemonize() call comes too late and
436   // SMPI will take this process as an MPI process!
437   daemon->daemonize();
438 }
439
440 /* **************************** Public interface *************************** */
441
442 /** @ingroup SURF_plugin_load
443  * @brief Initializes the HostDvfs plugin
444  * @details The HostDvfs plugin provides an API to get the current load of each host.
445  */
446 void sg_host_dvfs_plugin_init()
447 {
448   static bool inited = false;
449   if (inited)
450     return;
451   inited = true;
452
453   sg_host_load_plugin_init();
454
455   simgrid::s4u::Host::on_creation.connect(&on_host_added);
456 }