Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[DVFS] Update HostDvfs class documentation
[simgrid.git] / src / surf / plugins / host_dvfs.cpp
index d74cc16..5ff2dcb 100644 (file)
@@ -27,6 +27,9 @@
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_plugin_dvfs, surf, "Logging specific to the SURF HostDvfs plugin");
 
+static const char* property_sampling_rate = "plugin/dvfs/sampling_rate";
+static const char* property_governor      = "plugin/dvfs/governor";
+
 namespace simgrid {
 namespace plugin {
 
@@ -40,11 +43,12 @@ public:
   double sampling_rate;
 
   explicit Governor(simgrid::s4u::Host* ptr) : host(ptr) { init(); }
+  virtual ~Governor() = default;
 
   void init()
   {
-    const char* local_sampling_rate_config = host->getProperty("plugin/dvfs/sampling_rate");
-    double global_sampling_rate_config     = xbt_cfg_get_double("plugin/dvfs/sampling_rate");
+    const char* local_sampling_rate_config = host->getProperty(property_sampling_rate);
+    double global_sampling_rate_config     = xbt_cfg_get_double(property_sampling_rate);
     if (local_sampling_rate_config != nullptr) {
       sampling_rate = std::stod(local_sampling_rate_config);
     } else {
@@ -52,7 +56,8 @@ public:
     }
   }
 
-  virtual void update() {}
+  virtual void update()         = 0;
+  virtual std::string getName() = 0;
   double samplingRate() { return sampling_rate; }
 };
 
@@ -60,14 +65,16 @@ class Performance : public Governor {
 public:
   explicit Performance(simgrid::s4u::Host* ptr) : Governor(ptr) {}
 
-  void update() { host->setPstate(0); }
+  void update() override { host->setPstate(0); }
+  std::string getName() override { return "Performance"; }
 };
 
 class Powersave : public Governor {
 public:
   explicit Powersave(simgrid::s4u::Host* ptr) : Governor(ptr) {}
 
-  void update() { host->setPstate(host->getPstatesCount() - 1); }
+  void update() override { host->setPstate(host->getPstatesCount() - 1); }
+  std::string getName() override { return "Powersave"; }
 };
 
 class OnDemand : public Governor {
@@ -76,25 +83,28 @@ class OnDemand : public Governor {
 public:
   explicit OnDemand(simgrid::s4u::Host* ptr) : Governor(ptr) {}
 
-  void update()
+  std::string getName() override { return "OnDemand"; }
+  void update() override
   {
     double load = sg_host_get_current_load(host);
 
-    if (load > freq_up_threshold) {
+    // FIXME I don't like that we multiply with the getCoreCount() just here...
+    if (load*host->getCoreCount() > freq_up_threshold) {
       host->setPstate(0); /* Run at max. performance! */
-      XBT_INFO("Changed to pstate %f", 0.0);
+      XBT_INFO("Load: %f > threshold: %f --> changed to pstate %i", load * host->getCoreCount(), freq_up_threshold, 0);
     } else {
       /* The actual implementation uses a formula here: (See Kernel file cpufreq_ondemand.c:158)
        *
-       *    freq_next = min_f + load * (max_f - min_f) / 100;
+       *    freq_next = min_f + load * (max_f - min_f) / 100
        *
        * So they assume that frequency increases by 100 MHz. We will just use
-       * lowest_pstate - load*pstatesCount();
+       * lowest_pstate - load*pstatesCount()
        */
       int max_pstate = host->getPstatesCount() - 1;
+      int new_pstate = max_pstate - load * max_pstate;
+      host->setPstate(new_pstate);
 
-      host->setPstate(max_pstate - load * max_pstate);
-      XBT_INFO("Changed to pstate %f -- check: %i", max_pstate - load * max_pstate, host->getPstate());
+      XBT_DEBUG("Load: %f --> changed to pstate %i", load*host->getCoreCount(), new_pstate);
     }
   }
 };
@@ -106,35 +116,51 @@ class Conservative : public Governor {
 public:
   explicit Conservative(simgrid::s4u::Host* ptr) : Governor(ptr) {}
 
-  void update()
+  virtual std::string getName() override { return "Conservative"; }
+  virtual void update() override
   {
-    double load = sg_host_get_current_load(host);
+    double load = sg_host_get_current_load(host)*host->getCoreCount();
     int pstate  = host->getPstate();
 
     if (load > freq_up_threshold) {
       if (pstate != 0) {
         host->setPstate(pstate - 1);
-        XBT_INFO("Increasing performance to pstate %d", pstate - 1);
+        XBT_INFO("Load: %f > threshold: %f -> increasing performance to pstate %d", load, freq_up_threshold, pstate - 1);
       }
       else {
-        XBT_DEBUG("Cannot speed up even more, already in slowest pstate %d", pstate);
+        XBT_DEBUG("Load: %f > threshold: %f -> but cannot speed up even more, already in highest pstate %d", load, freq_up_threshold, pstate);
       }
-    }
-
-    if (load < freq_down_threshold) {
+    } else if (load < freq_down_threshold) {
       int max_pstate = host->getPstatesCount() - 1;
       if (pstate != max_pstate) { // Are we in the slowest pstate already?
         host->setPstate(pstate + 1);
-        XBT_INFO("Slowing down to pstate %d", pstate + 1);
+        XBT_INFO("Load: %f < threshold: %f -> slowing down to pstate %d", load, freq_down_threshold, pstate + 1);
       }
       else {
-        XBT_DEBUG("Cannot slow down even more, already in slowest pstate %d", pstate);
+        XBT_DEBUG("Load: %f < threshold: %f -> cannot slow down even more, already in slowest pstate %d", load, freq_down_threshold, pstate);
       }
     }
   }
 };
-}
 
+/**
+ *  Add this to your host tag:
+ *    - <prop id="plugin/dvfs/governor" value="performance" />
+ *
+ *  Valid values as of now are: performance, powersave, ondemand, conservative
+ *  It doesn't matter if you use uppercase or lowercase.
+ *
+ *  For the sampling rate, use this:
+ *
+ *    - <prop id="plugin/dvfs/sampling_rate" value="2" />
+ *
+ *  This will run the update() method of the specified governor every 2 seconds
+ *  on that host.
+ *
+ *  These properties can also be used within the <config> tag to configure
+ *  these values globally. Using them within the <host> will overwrite this
+ *  global configuration
+ */
 class HostDvfs {
 public:
   static simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> EXTENSION_ID;
@@ -150,8 +176,9 @@ HostDvfs::HostDvfs(simgrid::s4u::Host* ptr) {}
 HostDvfs::~HostDvfs() = default;
 }
 }
+}
 
-using simgrid::plugin::HostDvfs;
+using simgrid::plugin::dvfs::HostDvfs;
 
 /* **************************** events  callback *************************** */
 static void on_host_added(simgrid::s4u::Host& host)
@@ -171,27 +198,43 @@ static void on_host_added(simgrid::s4u::Host& host)
     XBT_DEBUG("DVFS process on %s is a daemon: %d", daemonProc->getHost()->getName().c_str(), daemonProc->isDaemon());
 
     std::string dvfs_governor;
-    const char* host_conf = daemonProc->getHost()->getProperty("plugin/dvfs/governor");
+    const char* host_conf = daemonProc->getHost()->getProperty(property_governor);
     if (host_conf != nullptr) {
-      dvfs_governor = std::string(daemonProc->getHost()->getProperty("plugin/dvfs/governor"));
+      dvfs_governor = std::string(daemonProc->getHost()->getProperty(property_governor));
       boost::algorithm::to_lower(dvfs_governor);
     } else {
-      dvfs_governor = xbt_cfg_get_string("plugin/dvfs/governor");
+      dvfs_governor = xbt_cfg_get_string(property_governor);
       boost::algorithm::to_lower(dvfs_governor);
     }
 
-    simgrid::plugin::dvfs::Governor governor(daemonProc->getHost());
-    if (dvfs_governor == "conservative") {
-      governor = simgrid::plugin::dvfs::Conservative(daemonProc->getHost());
-    }
+    auto governor = [&dvfs_governor, &daemonProc]() {
+      if (dvfs_governor == "conservative") {
+        return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
+            new simgrid::plugin::dvfs::Conservative(daemonProc->getHost()));
+      } else if (dvfs_governor == "ondemand") {
+        return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
+            new simgrid::plugin::dvfs::OnDemand(daemonProc->getHost()));
+      } else if (dvfs_governor == "performance") {
+        return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
+            new simgrid::plugin::dvfs::Performance(daemonProc->getHost()));
+      } else if (dvfs_governor == "powersave") {
+        return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
+            new simgrid::plugin::dvfs::Powersave(daemonProc->getHost()));
+      } else {
+        XBT_CRITICAL("No governor specified for host %s, falling back to Performance",
+                     daemonProc->getHost()->getCname());
+        return std::unique_ptr<simgrid::plugin::dvfs::Governor>(
+            new simgrid::plugin::dvfs::Performance(daemonProc->getHost()));
+      }
+    }();
 
     while (1) {
       // Sleep *before* updating; important for startup (i.e., t = 0).
       // In the beginning, we want to go with the pstates specified in the platform file
       // (so we sleep first)
-      simgrid::s4u::this_actor::sleep_for(governor.samplingRate());
-      governor.update();
-      XBT_INFO("Governor just updated!");
+      simgrid::s4u::this_actor::sleep_for(governor->samplingRate());
+      governor->update();
+      XBT_DEBUG("Governor (%s) just updated!", governor->getName().c_str());
     }
 
     XBT_WARN("I should have never reached this point: daemons should be killed when all regular processes are done");
@@ -220,9 +263,9 @@ void sg_host_dvfs_plugin_init()
   sg_host_load_plugin_init();
 
   simgrid::s4u::Host::onCreation.connect(&on_host_added);
-  xbt_cfg_register_double("plugin/dvfs/sampling_rate", 0.1, nullptr,
+  xbt_cfg_register_double(property_sampling_rate, 0.1, nullptr,
                           "How often should the dvfs plugin check whether the frequency needs to be changed?");
-  xbt_cfg_register_string("plugin/dvfs/governor", "performance", nullptr,
+  xbt_cfg_register_string(property_governor, "performance", nullptr,
                           "Which Governor should be used that adapts the CPU frequency?");
 }
 }