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