/* 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 "energy.hpp"
-#include "../cpu_cas01.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_EXTERNAL_CATEGORY(surf_kernel);
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
"Logging specific to the SURF energy plugin");
-std::map<Cpu*, CpuEnergy*> *surf_energy=NULL;
+using simgrid::energy::HostEnergy;
-static void energyCpuCreatedCallback(Cpu *cpu){
- (*surf_energy)[cpu] = new CpuEnergy(cpu);
-}
+namespace simgrid {
+namespace energy {
-static void update_consumption_running(Cpu *cpu, CpuEnergy *cpu_energy) {
- double cpu_load = lmm_constraint_get_usage(cpu->getConstraint()) / cpu->m_powerPeak;
- double start_time = cpu_energy->last_updated;
- double finish_time = surf_get_clock();
+simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
+
+/* Computes the consumption so far. Called lazily on need. */
+void HostEnergy::update()
+{
+ simgrid::surf::Host* surf_host = host->extension<simgrid::surf::Host>();
+ double start_time = this->last_updated;
+ double finish_time = surf_get_clock();
+ double cpu_load;
+ if (surf_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(surf_host->p_cpu->getConstraint())
+ / surf_host->p_cpu->m_speedPeak;
- double previous_energy = cpu_energy->total_energy;
- double energy_this_step = cpu_energy->getCurrentWattsValue(cpu_load)*(finish_time-start_time);
+ if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not mores
+ cpu_load = 1;
- cpu_energy->total_energy = previous_energy + energy_this_step;
- cpu_energy->last_updated = finish_time;
+ double previous_energy = this->total_energy;
- XBT_DEBUG("[cpu_update_energy] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
- start_time, finish_time, cpu->m_powerPeak, previous_energy, energy_this_step);
-}
-static void update_consumption_off(Cpu *cpu, CpuEnergy *cpu_energy) {
- double start_time = cpu_energy->last_updated;
- double finish_time = surf_get_clock();
+ double instantaneous_consumption;
+ if (host->is_off())
+ instantaneous_consumption = this->watts_off;
+ else
+ instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
- double previous_energy = cpu_energy->total_energy;
- double energy_this_step = cpu_energy->watts_off*(finish_time-start_time);
+ double energy_this_step = instantaneous_consumption*(finish_time-start_time);
- cpu_energy->total_energy = previous_energy + energy_this_step;
- cpu_energy->last_updated = finish_time;
+ this->total_energy = previous_energy + energy_this_step;
+ this->last_updated = finish_time;
- XBT_DEBUG("[cpu_update_energy] off period=[%.2f-%.2f]; consumption change: %.2f J -> %.2f J",
- start_time, finish_time, previous_energy, energy_this_step);
+ 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->m_speedPeak, previous_energy, energy_this_step);
}
-static void energyCpuDestructedCallback(Cpu *cpu){
- std::map<Cpu*, CpuEnergy*>::iterator cpu_energy_it = surf_energy->find(cpu);
- xbt_assert(cpu_energy_it != surf_energy->end(), "The cpu is not in surf_energy.");
+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 = atof(off_power_str);
+ else
+ watts_off = 0;
+ }
- CpuEnergy *cpu_energy = cpu_energy_it->second;
- if (cpu->getState() == SURF_RESOURCE_OFF)
- update_consumption_off(cpu, cpu_energy);
- else
- update_consumption_running(cpu, cpu_energy);
+}
- XBT_INFO("Total energy of host %s: %f Joules", cpu->getName(), cpu_energy->getConsumedEnergy());
- delete cpu_energy_it->second;
- surf_energy->erase(cpu_energy_it);
+HostEnergy::~HostEnergy()
+{
}
-static void energyCpuActionStateChangedCallback(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t cur){
- Cpu *cpu = getActionCpu(action);
- CpuEnergy *cpu_energy = (*surf_energy)[cpu];
+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;
+}
- if(cpu_energy->last_updated < surf_get_clock()) {
- update_consumption_running(cpu, cpu_energy);
- }
+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;
}
-static void energyStateChangedCallback(Cpu *cpu, e_surf_resource_state_t oldState, e_surf_resource_state_t newState){
- CpuEnergy *cpu_energy = (*surf_energy)[cpu];
+/** @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());
+
+ /* 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(cpu_energy->last_updated < surf_get_clock()) {
- if (oldState == SURF_RESOURCE_OFF)
- update_consumption_off(cpu, cpu_energy);
- else
- update_consumption_running(cpu, cpu_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);
+
+ return current_power;
}
-static void sg_energy_plugin_exit()
+double HostEnergy::getConsumedEnergy()
{
- delete surf_energy;
- surf_energy = NULL;
-}
+ if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
+ simgrid::simix::kernel(std::bind(&HostEnergy::update, this));
-/** \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 (surf_energy == NULL) {
- surf_energy = new std::map<Cpu*, CpuEnergy*>();
- surf_callback_connect(cpuCreatedCallbacks, energyCpuCreatedCallback);
- surf_callback_connect(cpuDestructedCallbacks, energyCpuDestructedCallback);
- surf_callback_connect(cpuActionStateChangedCallbacks, energyCpuActionStateChangedCallback);
- surf_callback_connect(surfExitCallbacks, sg_energy_plugin_exit);
- surf_callback_connect(cpuStateChangedCallbacks, energyStateChangedCallback);
- }
+ return total_energy;
}
-/**
- *
- */
-CpuEnergy::CpuEnergy(Cpu *ptr)
+void HostEnergy::initWattsRangeList()
{
- cpu = ptr;
- total_energy = 0;
- power_range_watts_list = getWattsRangeList();
- last_updated = surf_get_clock();
-
- if (cpu->getProperties() != NULL) {
- char* off_power_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_off");
- if (off_power_str != NULL)
- watts_off = atof(off_power_str);
- else
- watts_off = 0;
+ 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(
+ atof(xbt_dynar_get_as(current_power_values, 0, char*)),
+ atof(xbt_dynar_get_as(current_power_values, 1, char*))
+ ));
+
+ xbt_dynar_free(¤t_power_values);
}
+ xbt_dynar_free(&all_power_values);
+}
+}
}
-CpuEnergy::~CpuEnergy(){
- 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);
+/* **************************** events callback *************************** */
+static void onCreation(simgrid::s4u::Host& host) {
+ simgrid::surf::Host* surf_host = host.extension<simgrid::surf::Host>();
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
+ return;
+ host.extension_set(new HostEnergy(&host));
}
+static void onActionStateChange(simgrid::surf::CpuAction *action, e_surf_action_state_t previous) {
+ const char *name = getActionCpu(action)->getName();
+ simgrid::surf::Host *host = sg_host_by_name(name)->extension<simgrid::surf::Host>();
+ 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::Host>();
-double CpuEnergy::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", cpu->getName());
- xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
- double min_power = xbt_dynar_get_as(current_power_values, 0, double);
- return min_power;
-}
-double CpuEnergy::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", cpu->getName());
- xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
- double max_power = xbt_dynar_get_as(current_power_values, 1, double);
- return max_power;
+ HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
+
+ if(host_energy->last_updated < surf_get_clock())
+ host_energy->update();
}
-/**
- * Computes the power consumed by the host according to the current pstate and processor load
- *
- */
-double CpuEnergy::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", cpu->getName());
+static void onHostStateChange(simgrid::s4u::Host &host) {
+ simgrid::surf::Host* surf_host = host.extension<simgrid::surf::Host>();
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
+ return;
- /* retrieve the power values associated with the current pstate */
- xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
+ HostEnergy *host_energy = host.extension<HostEnergy>();
- /* 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;
+ if(host_energy->last_updated < surf_get_clock())
+ host_energy->update();
+}
+
+static void onHostDestruction(simgrid::s4u::Host& host) {
+ // Ignore virtual machines
+ simgrid::surf::Host* surf_host = host.extension<simgrid::surf::Host>();
+ 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 current_power = min_power + cpu_load * power_slope;
+/* **************************** 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 (HostEnergy::EXTENSION_ID.valid())
+ return;
- 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);
+ HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
- return current_power;
+ simgrid::s4u::Host::onCreation.connect(&onCreation);
+ simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
+ simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
+ simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
}
-double CpuEnergy::getConsumedEnergy()
-{
- if(last_updated < surf_get_clock()) {
- if (cpu->getState() == SURF_RESOURCE_OFF)
- update_consumption_off(cpu, this);
- else
- update_consumption_running(cpu, this);
- }
- return total_energy;
+/** @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();
}
-xbt_dynar_t CpuEnergy::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 (cpu->getProperties() == NULL)
- return NULL;
-
- char* all_power_values_str = (char*)xbt_dict_get_or_null(cpu->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",
- cpu->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 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);
}
