src/surf/plugins/host_dvfs.cpp

   1 /* Copyright (c) 2010, 2012-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/simix.hpp"
   9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  10 #include "src/surf/cpu_interface.hpp"
  11
  12 #include <boost/algorithm/string.hpp>
  13 #include <boost/algorithm/string/classification.hpp>
  14 #include <boost/algorithm/string/split.hpp>
  15 #include <simgrid/msg.h>
  16 #include <simgrid/s4u/Engine.hpp>
  17 #include <string>
  18 #include <utility>
  19 #include <vector>
  20 #include <xbt/config.hpp>
  21
  22 /** @addtogroup SURF_plugin_load
  23
  24   This plugin makes it very simple for users to obtain the current load for each host.
  25
  26 */
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_dvfs, surf, "Logging specific to the SURF HostDvfs plugin");
  29
  30 static const char* property_sampling_rate = "plugin/dvfs/sampling_rate";
  31 static const char* property_governor      = "plugin/dvfs/governor";
  32
  33 namespace simgrid {
  34 namespace plugin {
  35
  36 namespace dvfs {
  37 class Governor {
  38
  39 protected:
  40   simgrid::s4u::Host* host;
  41
  42 public:
  43   double sampling_rate;
  44
  45   explicit Governor(simgrid::s4u::Host* ptr) : host(ptr) { init(); }
  46   virtual ~Governor() = default;
  47
  48   void init()
  49   {
  50     const char* local_sampling_rate_config = host->getProperty(property_sampling_rate);
  51     double global_sampling_rate_config     = xbt_cfg_get_double(property_sampling_rate);
  52     if (local_sampling_rate_config != nullptr) {
  53       sampling_rate = std::stod(local_sampling_rate_config);
  54     } else {
  55       sampling_rate = global_sampling_rate_config;
  56     }
  57   }
  58
  59   virtual void update()         = 0;
  60   virtual std::string getName() = 0;
  61   double samplingRate() { return sampling_rate; }
  62 };
  63
  64 class Performance : public Governor {
  65 public:
  66   explicit Performance(simgrid::s4u::Host* ptr) : Governor(ptr) {}
  67
  68   void update() override { host->setPstate(0); }
  69   std::string getName() override { return "Performance"; }
  70 };
  71
  72 class Powersave : public Governor {
  73 public:
  74   explicit Powersave(simgrid::s4u::Host* ptr) : Governor(ptr) {}
  75
  76   void update() override { host->setPstate(host->getPstatesCount() - 1); }
  77   std::string getName() override { return "Powersave"; }
  78 };
  79
  80 class OnDemand : public Governor {
  81   double freq_up_threshold = 0.95;
  82
  83 public:
  84   explicit OnDemand(simgrid::s4u::Host* ptr) : Governor(ptr) {}
  85
  86   std::string getName() override { return "OnDemand"; }
  87   void update() override
  88   {
  89     double load = sg_host_get_current_load(host);
  90
  91     // FIXME I don't like that we multiply with the getCoreCount() just here...
  92     if (load*host->getCoreCount() > freq_up_threshold) {
  93       host->setPstate(0); /* Run at max. performance! */
  94       XBT_INFO("Load: %f > threshold: %f --> changed to pstate %i", load * host->getCoreCount(), freq_up_threshold, 0);
  95     } else {
  96       /* The actual implementation uses a formula here: (See Kernel file cpufreq_ondemand.c:158)
  97        *
  98        *    freq_next = min_f + load * (max_f - min_f) / 100
  99        *
 100        * So they assume that frequency increases by 100 MHz. We will just use
 101        * lowest_pstate - load*pstatesCount()
 102        */
 103       int max_pstate = host->getPstatesCount() - 1;
 104       int new_pstate = max_pstate - load * max_pstate;
 105       host->setPstate(new_pstate);
 106
 107       XBT_DEBUG("Load: %f --> changed to pstate %i", load*host->getCoreCount(), new_pstate);
 108     }
 109   }
 110 };
 111
 112 class Conservative : public Governor {
 113   double freq_up_threshold   = .8;
 114   double freq_down_threshold = .2;
 115
 116 public:
 117   explicit Conservative(simgrid::s4u::Host* ptr) : Governor(ptr) {}
 118
 119   virtual std::string getName() override { return "Conservative"; }
 120   virtual void update() override
 121   {
 122     double load = sg_host_get_current_load(host)*host->getCoreCount();
 123     int pstate  = host->getPstate();
 124
 125     if (load > freq_up_threshold) {
 126       if (pstate != 0) {
 127         host->setPstate(pstate - 1);
 128         XBT_INFO("Load: %f > threshold: %f -> increasing performance to pstate %d", load, freq_up_threshold, pstate - 1);
 129       }
 130       else {
 131         XBT_DEBUG("Load: %f > threshold: %f -> but cannot speed up even more, already in highest pstate %d", load, freq_up_threshold, pstate);
 132       }
 133     } else if (load < freq_down_threshold) {
 134       int max_pstate = host->getPstatesCount() - 1;
 135       if (pstate != max_pstate) { // Are we in the slowest pstate already?
 136         host->setPstate(pstate + 1);
 137         XBT_INFO("Load: %f < threshold: %f -> slowing down to pstate %d", load, freq_down_threshold, pstate + 1);
 138       }
 139       else {
 140         XBT_DEBUG("Load: %f < threshold: %f -> cannot slow down even more, already in slowest pstate %d", load, freq_down_threshold, pstate);
 141       }
 142     }
 143   }
 144 };
 145
 146 class HostDvfs {
 147 public:
 148   static simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> EXTENSION_ID;
 149
 150   explicit HostDvfs(simgrid::s4u::Host*);
 151   ~HostDvfs();
 152 };
 153
 154 simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> HostDvfs::EXTENSION_ID;
 155
 156 HostDvfs::HostDvfs(simgrid::s4u::Host* ptr) {}
 157
 158 HostDvfs::~HostDvfs() = default;
 159 }
 160 }
 161 }
 162
 163 using simgrid::plugin::dvfs::HostDvfs;
 164
 165 /* **************************** events  callback *************************** */
 166 static void on_host_added(simgrid::s4u::Host& host)
 167 {
 168   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
 169     return;
 170
 171   std::string name              = std::string("dvfs-daemon-") + host.getCname();
 172   simgrid::s4u::ActorPtr daemon = simgrid::s4u::Actor::createActor(name.c_str(), &host, []() {
 173     /**
 174      * This lambda function is the function the actor (daemon) will execute
 175      * all the time - in the case of the dvfs plugin, this controls when to
 176      * lower/raise the frequency.
 177      */
 178     simgrid::s4u::ActorPtr daemonProc = simgrid::s4u::Actor::self();
 179
 180     XBT_DEBUG("DVFS process on %s is a daemon: %d", daemonProc->getHost()->getName().c_str(), daemonProc->isDaemon());
 181
 182     std::string dvfs_governor;
 183     const char* host_conf = daemonProc->getHost()->getProperty(property_governor);
 184     if (host_conf != nullptr) {
 185       dvfs_governor = std::string(daemonProc->getHost()->getProperty(property_governor));
 186       boost::algorithm::to_lower(dvfs_governor);
 187     } else {
 188       dvfs_governor = xbt_cfg_get_string(property_governor);
 189       boost::algorithm::to_lower(dvfs_governor);
 190     }
 191
 192     auto governor = [&dvfs_governor, &daemonProc]() {
 193       if (dvfs_governor == "conservative") {
 194         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
 195             new simgrid::plugin::dvfs::Conservative(daemonProc->getHost()));
 196       } else if (dvfs_governor == "ondemand") {
 197         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
 198             new simgrid::plugin::dvfs::OnDemand(daemonProc->getHost()));
 199       } else if (dvfs_governor == "performance") {
 200         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
 201             new simgrid::plugin::dvfs::Performance(daemonProc->getHost()));
 202       } else if (dvfs_governor == "powersave") {
 203         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
 204             new simgrid::plugin::dvfs::Powersave(daemonProc->getHost()));
 205       } else {
 206         XBT_CRITICAL("No governor specified for host %s, falling back to Performance",
 207                      daemonProc->getHost()->getCname());
 208         return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
 209             new simgrid::plugin::dvfs::Performance(daemonProc->getHost()));
 210       }
 211     }();
 212
 213     while (1) {
 214       // Sleep *before* updating; important for startup (i.e., t = 0).
 215       // In the beginning, we want to go with the pstates specified in the platform file
 216       // (so we sleep first)
 217       simgrid::s4u::this_actor::sleep_for(governor->samplingRate());
 218       governor->update();
 219       XBT_DEBUG("Governor (%s) just updated!", governor->getName().c_str());
 220     }
 221
 222     XBT_WARN("I should have never reached this point: daemons should be killed when all regular processes are done");
 223     return 0;
 224   });
 225
 226   // This call must be placed in this function. Otherweise, the daemonize() call comes too late and
 227   // SMPI will take this process as an MPI process!
 228   daemon->daemonize();
 229 }
 230
 231 /* **************************** Public interface *************************** */
 232 extern "C" {
 233
 234 /** \ingroup SURF_plugin_load
 235  * \brief Initializes the HostDvfs plugin
 236  * \details The HostDvfs plugin provides an API to get the current load of each host.
 237  */
 238 void sg_host_dvfs_plugin_init()
 239 {
 240   if (HostDvfs::EXTENSION_ID.valid())
 241     return;
 242
 243   HostDvfs::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostDvfs>();
 244
 245   sg_host_load_plugin_init();
 246
 247   simgrid::s4u::Host::onCreation.connect(&on_host_added);
 248   xbt_cfg_register_double(property_sampling_rate, 0.1, nullptr,
 249                           "How often should the dvfs plugin check whether the frequency needs to be changed?");
 250   xbt_cfg_register_string(property_governor, "performance", nullptr,
 251                           "Which Governor should be used that adapts the CPU frequency?");
 252 }
 253 }