/* 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/surf/plugins/energy.hpp>
-#include <src/surf/cpu_interface.hpp>
-#include <src/surf/virtual_machine.hpp>
+#include <utility>
+#include <vector>
+
+#include "simgrid/plugins/energy.h"
+#include "simgrid/simix.hpp"
+#include "src/surf/plugins/energy.hpp"
+#include "src/surf/cpu_interface.hpp"
+#include "src/surf/virtual_machine.hpp"
/** @addtogroup SURF_plugin_energy
In this example, the idle consumption is 95 Watts, 93 Watts and 90 Watts in each pstate while the CPU burn consumption are at 200 Watts,
170 Watts and 150 Watts respectively.
-To change the pstate of a given CPU, use the following functions: #MSG_host_get_nb_pstates(), #MSG_host_set_pstate(), #MSG_host_get_power_peak_at().
+To change the pstate of a given CPU, use the following functions: #MSG_host_get_nb_pstates(), simgrid#s4u#Host#set_pstate(), #MSG_host_get_power_peak_at().
-To simulate the energy-related elements, first call the #sg_energy_plugin_init() before your #MSG_init(),
-and then use the following function to retrieve the consumption of a given host: #MSG_host_get_consumed_energy().
+To simulate the energy-related elements, first call the simgrid#energy#sg_energy_plugin_init() before your #MSG_init(),
+and then use the following function to retrieve the consumption of a given host: MSG_host_get_consumed_energy().
*/
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
"Logging specific to the SURF energy plugin");
-std::map<simgrid::surf::Host*, simgrid::energy::HostEnergy*> *simgrid::energy::surf_energy = NULL;
-
using simgrid::energy::HostEnergy;
-/* Computes the consumption so far. Called lazily on need. */
-static void update_consumption(simgrid::surf::Host *host, HostEnergy *host_energy) {
- double start_time = host_energy->last_updated;
- double finish_time = surf_get_clock();
- double cpu_load;
- if (host->p_cpu->m_speedPeak == 0)
- // Some users declare a pstate of speed 0 flops (eg to model boot time).
- // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
- cpu_load = 1;
- else
- cpu_load = lmm_constraint_get_usage(host->p_cpu->getConstraint()) / host->p_cpu->m_speedPeak;
-
- if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not mores
- cpu_load = 1;
-
- double previous_energy = host_energy->total_energy;
-
- double instantaneous_consumption;
- if (host->isOff())
- instantaneous_consumption = host_energy->watts_off;
- else
- instantaneous_consumption = host_energy->getCurrentWattsValue(cpu_load);
-
- double energy_this_step = instantaneous_consumption*(finish_time-start_time);
-
- host_energy->total_energy = previous_energy + energy_this_step;
- host_energy->last_updated = finish_time;
-
- XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
- host->getName(), start_time, finish_time, host->p_cpu->m_speedPeak, previous_energy, energy_this_step);
-}
-
-/** \ingroup SURF_plugin_energy
- * \brief Enable energy plugin
- * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
- */
-void sg_energy_plugin_init() {
- if (simgrid::energy::surf_energy == NULL) {
-
- simgrid::energy::surf_energy = new std::map<simgrid::surf::Host*, simgrid::energy::HostEnergy*>();
-
- /* The following attaches an anonymous function to the Host::onCreation signal */
- /* Search for "C++ lambda" for more information on the syntax used here */
- simgrid::surf::Host::onCreation.connect([](simgrid::surf::Host *host) {
- if (dynamic_cast<simgrid::surf::VirtualMachine*>(host)) // Ignore virtual machines
- return;
-
- (*simgrid::energy::surf_energy)[host] = new HostEnergy(host);
- });
-
- simgrid::surf::Host::onDestruction.connect([](simgrid::surf::Host *host) {
- if (dynamic_cast<simgrid::surf::VirtualMachine*>(host)) // Ignore virtual machines
- return;
+namespace simgrid {
+namespace energy {
- std::map<simgrid::surf::Host*, HostEnergy*>::iterator host_energy_it = simgrid::energy::surf_energy->find(host);
- xbt_assert(host_energy_it != simgrid::energy::surf_energy->end(), "The host is not in surf_energy.");
+simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
- HostEnergy *host_energy = host_energy_it->second;
- update_consumption(host, host_energy);
+/* Computes the consumption so far. Called lazily on need. */
+void HostEnergy::update()
+{
+ simgrid::surf::HostImpl* surf_host = host->extension<simgrid::surf::HostImpl>();
+ double start_time = this->last_updated;
+ double finish_time = surf_get_clock();
+ double cpu_load;
+ if (surf_host->p_cpu->speed_.peak == 0)
+ // Some users declare a pstate of speed 0 flops (eg to model boot time).
+ // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
+ cpu_load = 1;
+ else
+ cpu_load = lmm_constraint_get_usage(surf_host->p_cpu->getConstraint())
+ / surf_host->p_cpu->speed_.peak;
+
+ if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not mores
+ cpu_load = 1;
+
+ double previous_energy = this->total_energy;
+
+ double instantaneous_consumption;
+ if (host->isOff())
+ instantaneous_consumption = this->watts_off;
+ else
+ instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
+
+ double energy_this_step = instantaneous_consumption*(finish_time-start_time);
+
+ this->total_energy = previous_energy + energy_this_step;
+ this->last_updated = finish_time;
+
+ XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
+ surf_host->getName(), start_time, finish_time, surf_host->p_cpu->speed_.peak, previous_energy, energy_this_step);
+}
- XBT_INFO("Total energy of host %s: %f Joules", host->getName(), host_energy->getConsumedEnergy());
- host_energy_it->second->unref();
- simgrid::energy::surf_energy->erase(host_energy_it);
- });
+HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) :
+ host(ptr), last_updated(surf_get_clock())
+{
+ initWattsRangeList();
+
+ if (host->properties() != NULL) {
+ char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
+ if (off_power_str != NULL)
+ watts_off = xbt_str_parse_double(off_power_str,
+ bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str()));
+ else
+ watts_off = 0;
+ }
- simgrid::surf::CpuAction::onStateChange.connect([](simgrid::surf::CpuAction *action,
- e_surf_action_state_t old,
- e_surf_action_state_t cur) {
- const char *name = getActionCpu(action)->getName();
- simgrid::surf::Host *host = surf_host_resource_priv(sg_host_by_name(name));
- simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
- if (vm) // If it's a VM, take the corresponding PM
- host = surf_host_resource_priv(vm->getPm());
+}
- HostEnergy *host_energy = (*simgrid::energy::surf_energy)[host];
+HostEnergy::~HostEnergy()
+{
+}
- if(host_energy->last_updated < surf_get_clock())
- update_consumption(host, host_energy);
+double HostEnergy::getWattMinAt(int pstate)
+{
+ xbt_assert(!power_range_watts_list.empty(),
+ "No power range properties specified for host %s", host->name().c_str());
+ return power_range_watts_list[pstate].first;
+}
- });
+double HostEnergy::getWattMaxAt(int pstate)
+{
+ xbt_assert(!power_range_watts_list.empty(),
+ "No power range properties specified for host %s", host->name().c_str());
+ return power_range_watts_list[pstate].second;
+}
- simgrid::surf::Host::onStateChange.connect([] (simgrid::surf::Host *host) {
- if (dynamic_cast<simgrid::surf::VirtualMachine*>(host)) // Ignore virtual machines
- return;
+/** @brief Computes the power consumed by the host according to the current pstate and processor load */
+double HostEnergy::getCurrentWattsValue(double cpu_load)
+{
+ xbt_assert(!power_range_watts_list.empty(),
+ "No power range properties specified for host %s", host->name().c_str());
- HostEnergy *host_energy = (*simgrid::energy::surf_energy)[host];
+ /* min_power corresponds to the idle power (cpu load = 0) */
+ /* max_power is the power consumed at 100% cpu load */
+ auto range = power_range_watts_list.at(host->pstate());
+ double min_power = range.first;
+ double max_power = range.second;
+ double power_slope = max_power - min_power;
+ double current_power = min_power + cpu_load * power_slope;
- if(host_energy->last_updated < surf_get_clock())
- update_consumption(host, host_energy);
- });
+ XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
+ XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
- simgrid::surf::surfExitCallbacks.connect([]() {
- delete simgrid::energy::surf_energy;
- simgrid::energy::surf_energy = NULL;
- });
- }
+ return current_power;
}
-namespace simgrid {
-namespace energy {
-
-/**
- *
- */
-HostEnergy::HostEnergy(simgrid::surf::Host *ptr)
+double HostEnergy::getConsumedEnergy()
{
- host = ptr;
- total_energy = 0;
- power_range_watts_list = getWattsRangeList();
- last_updated = surf_get_clock();
-
- if (host->getProperties() != NULL) {
- char* off_power_str = (char*)xbt_dict_get_or_null(host->getProperties(), "watt_off");
- if (off_power_str != NULL)
- watts_off = atof(off_power_str);
- else
- watts_off = 0;
- }
+ if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
+ simgrid::simix::kernel(std::bind(&HostEnergy::update, this));
+ return total_energy;
}
-HostEnergy::~HostEnergy(){
- unsigned int iter;
- xbt_dynar_t power_tuple = NULL;
- xbt_dynar_foreach(power_range_watts_list, iter, power_tuple)
- xbt_dynar_free(&power_tuple);
- xbt_dynar_free(&power_range_watts_list);
+void HostEnergy::initWattsRangeList()
+{
+ if (host->properties() == NULL)
+ return;
+ char* all_power_values_str =
+ (char*)xbt_dict_get_or_null(host->properties(), "watt_per_state");
+ if (all_power_values_str == NULL)
+ return;
+
+ xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
+ int pstate_nb = xbt_dynar_length(all_power_values);
+
+ for (int i=0; i< pstate_nb; i++)
+ {
+ /* retrieve the power values associated with the current pstate */
+ xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
+ xbt_assert(xbt_dynar_length(current_power_values) > 1,
+ "Power properties incorrectly defined - "
+ "could not retrieve min and max power values for host %s",
+ host->name().c_str());
+
+ /* min_power corresponds to the idle power (cpu load = 0) */
+ /* max_power is the power consumed at 100% cpu load */
+ power_range_watts_list.push_back(power_range(
+ xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*),
+ bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str())),
+ xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*),
+ bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str()))
+ ));
+
+ xbt_dynar_free(¤t_power_values);
+ }
+ xbt_dynar_free(&all_power_values);
}
-
-double HostEnergy::getWattMinAt(int pstate) {
- xbt_dynar_t power_range_list = power_range_watts_list;
- xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
- xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, host->p_cpu->getPState(), xbt_dynar_t);
- double min_power = xbt_dynar_get_as(current_power_values, 0, double);
- return min_power;
}
-double HostEnergy::getWattMaxAt(int pstate) {
- xbt_dynar_t power_range_list = power_range_watts_list;
- xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
- xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, host->p_cpu->getPState(), xbt_dynar_t);
- double max_power = xbt_dynar_get_as(current_power_values, 1, double);
- return max_power;
}
-/** @brief Computes the power consumed by the host according to the current pstate and processor load */
-double HostEnergy::getCurrentWattsValue(double cpu_load)
-{
- xbt_dynar_t power_range_list = power_range_watts_list;
- xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
+/* **************************** events callback *************************** */
+static void onCreation(simgrid::s4u::Host& host) {
+ simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
+ return;
+ host.extension_set(new HostEnergy(&host));
+}
- int pstate = host->p_cpu->getPState();
- xbt_assert(pstate < (int)xbt_dynar_length(power_range_list),
- "pstate %d >= power range amound %d",pstate,(int)xbt_dynar_length(power_range_list));
- /* retrieve the power values associated with the current pstate */
- xbt_dynar_t current_power_values = xbt_dynar_get_as( power_range_list, pstate, xbt_dynar_t);
+static void onActionStateChange(simgrid::surf::CpuAction *action, e_surf_action_state_t previous) {
+ std::list<simgrid::surf::Cpu*> cpus = getActionCpus(action);
+ for(simgrid::surf::Cpu* cpu : cpus) {
+ const char *name = cpu->getName();
+ sg_host_t sghost = sg_host_by_name(name);
+ if(sghost == NULL)
+ continue;
+ simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
+ simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
+ if (vm) // If it's a VM, take the corresponding PM
+ host = vm->getPm()->extension<simgrid::surf::HostImpl>();
+
+ HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
+
+ if(host_energy->last_updated < surf_get_clock())
+ host_energy->update();
+ }
+}
- /* min_power corresponds to the idle power (cpu load = 0) */
- /* max_power is the power consumed at 100% cpu load */
- double min_power = xbt_dynar_get_as(current_power_values, 0, double);
- double max_power = xbt_dynar_get_as(current_power_values, 1, double);
- double power_slope = max_power - min_power;
+static void onHostStateChange(simgrid::s4u::Host &host) {
+ simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
+ return;
- double current_power = min_power + cpu_load * power_slope;
+ HostEnergy *host_energy = host.extension<HostEnergy>();
- XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
- XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
+ if(host_energy->last_updated < surf_get_clock())
+ host_energy->update();
+}
- return current_power;
+static void onHostDestruction(simgrid::s4u::Host& host) {
+ // Ignore virtual machines
+ simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
+ return;
+ HostEnergy *host_energy = host.extension<HostEnergy>();
+ host_energy->update();
+ XBT_INFO("Total energy of host %s: %f Joules",
+ host.name().c_str(), host_energy->getConsumedEnergy());
}
-double HostEnergy::getConsumedEnergy()
+/* **************************** Public interface *************************** */
+/** \ingroup SURF_plugin_energy
+ * \brief Enable energy plugin
+ * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
+ */
+void sg_energy_plugin_init(void)
{
- if(last_updated < surf_get_clock())
- update_consumption(host, this);
- return total_energy;
+ if (HostEnergy::EXTENSION_ID.valid())
+ return;
+
+ HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
+
+ simgrid::s4u::Host::onCreation.connect(&onCreation);
+ simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
+ simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
+ simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
}
-xbt_dynar_t HostEnergy::getWattsRangeList()
-{
- xbt_dynar_t power_range_list;
- xbt_dynar_t power_tuple;
- int i = 0, pstate_nb=0;
- xbt_dynar_t current_power_values;
- double min_power, max_power;
-
- if (host->getProperties() == NULL)
- return NULL;
-
- char* all_power_values_str = (char*)xbt_dict_get_or_null(host->getProperties(), "watt_per_state");
-
- if (all_power_values_str == NULL)
- return NULL;
-
-
- power_range_list = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
- xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
-
- pstate_nb = xbt_dynar_length(all_power_values);
- for (i=0; i< pstate_nb; i++)
- {
- /* retrieve the power values associated with the current pstate */
- current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
- xbt_assert(xbt_dynar_length(current_power_values) > 1,
- "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
- host->getName());
-
- /* min_power corresponds to the idle power (cpu load = 0) */
- /* max_power is the power consumed at 100% cpu load */
- min_power = atof(xbt_dynar_get_as(current_power_values, 0, char*));
- max_power = atof(xbt_dynar_get_as(current_power_values, 1, char*));
-
- power_tuple = xbt_dynar_new(sizeof(double), NULL);
- xbt_dynar_push_as(power_tuple, double, min_power);
- xbt_dynar_push_as(power_tuple, double, max_power);
-
- xbt_dynar_push_as(power_range_list, xbt_dynar_t, power_tuple);
- xbt_dynar_free(¤t_power_values);
- }
- xbt_dynar_free(&all_power_values);
- return power_range_list;
+/** @brief Returns the total energy consumed by the host so far (in Joules)
+ *
+ * See also @ref SURF_plugin_energy.
+ */
+double sg_host_get_consumed_energy(sg_host_t host) {
+ xbt_assert(HostEnergy::EXTENSION_ID.valid(),
+ "The Energy plugin is not active. "
+ "Please call sg_energy_plugin_init() during initialization.");
+ return host->extension<HostEnergy>()->getConsumedEnergy();
}
+/** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
+double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
+ xbt_assert(HostEnergy::EXTENSION_ID.valid(),
+ "The Energy plugin is not active. "
+ "Please call sg_energy_plugin_init() during initialization.");
+ return host->extension<HostEnergy>()->getWattMinAt(pstate);
}
+/** @brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
+double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
+ xbt_assert(HostEnergy::EXTENSION_ID.valid(),
+ "The Energy plugin is not active. "
+ "Please call sg_energy_plugin_init() during initialization.");
+ return host->extension<HostEnergy>()->getWattMaxAt(pstate);
}
