-/* Copyright (c) 2010, 2012-2016. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2010, 2012-2018. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include "src/plugins/vm/VirtualMachineImpl.hpp"
#include "src/surf/cpu_interface.hpp"
+#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/classification.hpp>
#include <boost/algorithm/string/split.hpp>
-#include <simgrid/msg.h>
#include <simgrid/s4u/Engine.hpp>
#include <string>
#include <utility>
#include <vector>
+#include <xbt/config.hpp>
/** @addtogroup SURF_plugin_load
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 {
public:
double sampling_rate;
- Governor(simgrid::s4u::Host* ptr) : host(ptr) { init(); }
+ 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 {
}
}
- virtual void update() = 0;
+ virtual void update() = 0;
+ virtual std::string getName() = 0;
double samplingRate() { return sampling_rate; }
};
+/**
+ * The linux kernel doc describes this governor as follows:
+ * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
+ *
+ * > The CPUfreq governor "performance" sets the CPU statically to the
+ * > highest frequency within the borders of scaling_min_freq and
+ * > scaling_max_freq.
+ *
+ * We do not support scaling_min_freq/scaling_max_freq -- we just pick the lowest frequency.
+ */
class Performance : public Governor {
public:
- Performance(simgrid::s4u::Host* ptr) : Governor(ptr) {}
+ 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"; }
};
+/**
+ * The linux kernel doc describes this governor as follows:
+ * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
+ *
+ * > The CPUfreq governor "powersave" sets the CPU statically to the
+ * > lowest frequency within the borders of scaling_min_freq and
+ * > scaling_max_freq.
+ *
+ * We do not support scaling_min_freq/scaling_max_freq -- we just pick the lowest frequency.
+ */
class Powersave : public Governor {
public:
- Powersave(simgrid::s4u::Host* ptr) : Governor(ptr) {}
+ 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"; }
};
+/**
+ * The linux kernel doc describes this governor as follows:
+ * https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
+ *
+ * > The CPUfreq governor "ondemand" sets the CPU frequency depending on the
+ * > current system load. [...] when triggered, cpufreq checks
+ * > the CPU-usage statistics over the last period and the governor sets the
+ * > CPU accordingly.
+ */
class OnDemand : public Governor {
- double freq_up_threshold = 0.95;
+ /**
+ * See https://elixir.bootlin.com/linux/v4.15.4/source/drivers/cpufreq/cpufreq_ondemand.c
+ * DEF_FREQUENCY_UP_THRESHOLD and od_update()
+ */
+ double freq_up_threshold = 0.80;
public:
- OnDemand(simgrid::s4u::Host* ptr) : Governor(ptr) {}
+ 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);
+ double load = host->getCoreCount() * sg_host_get_avg_load(host);
+ sg_host_load_reset(host); // Only consider the period between two calls to this method!
if (load > 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, 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;
+ // Load is now < freq_up_threshold; exclude pstate 0 (the fastest)
+ // because pstate 0 can only be selected if load > freq_up_threshold
+ int new_pstate = max_pstate - load * (max_pstate + 1);
+ 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 < threshold: %f --> changed to pstate %i", load, freq_up_threshold, new_pstate);
}
}
};
+/**
+ * This is the conservative governor, which is very similar to the
+ * OnDemand governor. The Linux Kernel Documentation describes it
+ * very well, see https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt:
+ *
+ * > The CPUfreq governor "conservative", much like the "ondemand"
+ * > governor, sets the CPU frequency depending on the current usage. It
+ * > differs in behaviour in that it gracefully increases and decreases the
+ * > CPU speed rather than jumping to max speed the moment there is any load
+ * > on the CPU. This behaviour is more suitable in a battery powered
+ * > environment.
+ */
class Conservative : public Governor {
double freq_up_threshold = .8;
double freq_down_threshold = .2;
public:
- Conservative(simgrid::s4u::Host* ptr) : Governor(ptr) {}
+ 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 = host->getCoreCount() * sg_host_get_avg_load(host);
int pstate = host->getPstate();
+ sg_host_load_reset(host); // Only consider the period between two calls to this method!
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;
- explicit HostDvfs(simgrid::s4u::Host* ptr);
+ explicit HostDvfs(simgrid::s4u::Host*);
~HostDvfs();
-
-private:
- simgrid::s4u::Host* host = nullptr;
};
simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> HostDvfs::EXTENSION_ID;
-HostDvfs::HostDvfs(simgrid::s4u::Host* ptr) : host(ptr)
-{
-}
+HostDvfs::HostDvfs(simgrid::s4u::Host* ptr) {}
HostDvfs::~HostDvfs() = default;
}
}
+}
-using simgrid::plugin::HostDvfs;
+using simgrid::plugin::dvfs::HostDvfs;
/* **************************** events callback *************************** */
-static int check(int argc, char* argv[]);
-
static void on_host_added(simgrid::s4u::Host& host)
{
if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
return;
- // host.extension_set(new HostDvfs(&host));
- // This call must be placed in this function. Otherweise, the daemonize() call comes too late and
- // SMPI will take this process as an MPI process!
- MSG_process_daemonize(MSG_process_create("daemon", check, NULL, &host));
-}
+ std::string name = std::string("dvfs-daemon-") + host.getCname();
+ simgrid::s4u::ActorPtr daemon = simgrid::s4u::Actor::createActor(name.c_str(), &host, []() {
+ /**
+ * This lambda function is the function the actor (daemon) will execute
+ * all the time - in the case of the dvfs plugin, this controls when to
+ * lower/raise the frequency.
+ */
+ simgrid::s4u::ActorPtr daemonProc = simgrid::s4u::Actor::self();
+
+ 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(property_governor);
+ if (host_conf != nullptr) {
+ dvfs_governor = std::string(daemonProc->getHost()->getProperty(property_governor));
+ boost::algorithm::to_lower(dvfs_governor);
+ } else {
+ dvfs_governor = xbt_cfg_get_string(property_governor);
+ boost::algorithm::to_lower(dvfs_governor);
+ }
-static int check(int argc, char* argv[])
-{
- msg_host_t host = MSG_host_self();
-
- int isDaemon = (MSG_process_self())->getImpl()->isDaemon();
- XBT_INFO("Bin ein Daemon: %d", isDaemon);
-
- simgrid::plugin::dvfs::Conservative governor(host);
- 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)
- MSG_process_sleep(governor.samplingRate());
- governor.update();
- XBT_INFO("Governor just updated!");
- }
+ 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_DEBUG("Governor (%s) just updated!", governor->getName().c_str());
+ }
- // const char* dvfs_governor = host->property("plugin/dvfs/governor");
+ XBT_WARN("I should have never reached this point: daemons should be killed when all regular processes are done");
+ return 0;
+ });
- XBT_INFO("I will never reach that point: daemons are killed when regular processes are done");
- return 0;
+ // This call must be placed in this function. Otherweise, the daemonize() call comes too late and
+ // SMPI will take this process as an MPI process!
+ daemon->daemonize();
}
/* **************************** Public interface *************************** */
-SG_BEGIN_DECL()
+extern "C" {
/** \ingroup SURF_plugin_load
* \brief Initializes the HostDvfs plugin
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(property_governor, "performance", nullptr,
+ "Which Governor should be used that adapts the CPU frequency?");
+}
}
-
-SG_END_DECL()
