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