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