-/* Copyright (c) 2010, 2012-2014. The SimGrid Team.
+/* Copyright (c) 2010, 2012-2015. 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 "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
- *
- *
- * BlaBla energy
- */
-XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
- "Logging specific to the SURF energy plugin");
-std::map<CpuPtr, CpuEnergyPtr> *surf_energy=NULL;
+This is the energy plugin, enabling to account not only for computation time,
+but also for the dissipated energy in the simulated platform.
-static void energyCpuCreatedCallback(CpuPtr cpu){
- (*surf_energy)[cpu] = new CpuEnergy(cpu);
-}
+The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
-static void energyCpuDestructedCallback(CpuPtr cpu){
- std::map<CpuPtr, CpuEnergyPtr>::iterator cpuIt = surf_energy->find(cpu);
- xbt_assert(cpuIt != surf_energy->end(), "The cpu is not in surf_energy.");
- XBT_INFO("Total energy (Joules) of host %s: %f", cpu->getName(), cpuIt->second->getConsumedEnergy());
- delete cpuIt->second;
- surf_energy->erase(cpuIt);
-}
+\verbatim
+<host id="HostA" power="100.0Mf" >
+ <prop id="watt_per_state" value="100.0:200.0" />
+ <prop id="watt_off" value="10" />
+</host>
+\endverbatim
-static void energyCpuActionStateChangedCallback(CpuActionPtr action){
- CpuPtr cpu = getActionCpu(action);
- CpuEnergyPtr cpu_energy = (*surf_energy)[cpu];
+The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
+If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
+The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these values are arbitrary).
- if(cpu_energy->last_updated < surf_get_clock()) {
- 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();
+If your CPU is using pstates, then you can provide one consumption interval per pstate.
- /*XBT_DEBUG("[cpu_update_energy] action time interval=(%f-%f), current power peak=%f, current pstate=%d",
- start_time, finish_time, cpu->m_powerPeak, cpu->m_pstate);*/
- XBT_DEBUG("[cpu_update_energy] action time interval=(%f-%f), current power peak=%f",
- start_time, finish_time, cpu->m_powerPeak);
- double current_energy = cpu_energy->total_energy;
- double action_energy = cpu_energy->getCurrentWattsValue(cpu_load)*(finish_time-start_time);
+\verbatim
+<host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
+ <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
+ <prop id="watt_off" value="10" />
+</host>
+\endverbatim
- cpu_energy->total_energy = current_energy + action_energy;
- cpu_energy->last_updated = finish_time;
+That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
+It starts at pstate 0 (ie, at 100 Mflop/s). In this case, you have to specify one interval per pstate in the watt_per_state property.
+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.
- XBT_DEBUG("[cpu_update_energy] old_energy_value=%f, action_energy_value=%f", current_energy, action_energy);
- }
-}
+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 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().
+ */
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
+ "Logging specific to the SURF energy plugin");
+
+using simgrid::energy::HostEnergy;
-static void sg_energy_plugin_exit()
+namespace simgrid {
+namespace energy {
+
+simgrid::xbt::Extension<simgrid::Host, HostEnergy> HostEnergy::EXTENSION_ID;
+
+/* Computes the consumption so far. Called lazily on need. */
+void HostEnergy::update()
{
- delete surf_energy;
- surf_energy = NULL;
+ 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;
+
+ 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->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.
- */
-void sg_energy_plugin_init() {
- if (surf_energy == NULL) {
- surf_energy = new std::map<CpuPtr, CpuEnergyPtr>();
- surf_callback_connect(cpuCreatedCallbacks, energyCpuCreatedCallback);
- surf_callback_connect(cpuDestructedCallbacks, energyCpuDestructedCallback);
- surf_callback_connect(cpuActionStateChangedCallbacks, energyCpuActionStateChangedCallback);
- surf_callback_connect(surfExitCallbacks, sg_energy_plugin_exit);
+HostEnergy::HostEnergy(simgrid::Host *ptr) :
+ host(ptr), last_updated(surf_get_clock())
+{
+ initWattsRangeList();
+
+ 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;
}
+
}
-/**
- *
- */
-CpuEnergy::CpuEnergy(CpuPtr ptr)
- : cpu(ptr)
+HostEnergy::~HostEnergy()
{
- total_energy = 0;
- power_range_watts_list = getWattsRangeList();
- last_updated = surf_get_clock();
}
-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);
+double HostEnergy::getWattMinAt(int pstate)
+{
+ xbt_assert(!power_range_watts_list.empty(),
+ "No power range properties specified for host %s", host->getName().c_str());
+ return power_range_watts_list[pstate].first;
}
-
-/**
- * Computes the power consumed by the host according to the current pstate and processor load
- *
- */
-double CpuEnergy::getCurrentWattsValue(double cpu_load)
+double HostEnergy::getWattMaxAt(int pstate)
{
- xbt_dynar_t power_range_list = power_range_watts_list;
-
- if (power_range_list == NULL)
- {
- XBT_DEBUG("No power range properties specified for host %s", cpu->getName());
- return 0;
- }
- /*xbt_assert(xbt_dynar_length(power_range_list) == xbt_dynar_length(cpu->p_powerPeakList),
- "The number of power ranges in the properties does not match the number of pstates for host %s",
- cpu->getName());*/
-
- /* retrieve the power values associated with the current pstate */
- xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01Ptr>(cpu)->getPState(), xbt_dynar_t);
+ xbt_assert(!power_range_watts_list.empty(),
+ "No power range properties specified for host %s", host->getName().c_str());
+ return power_range_watts_list[pstate].second;
+}
- /* 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;
+/** @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->getName().c_str());
- double current_power = min_power + cpu_load * power_slope;
+ /* 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->getPState());
+ 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;
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);
+ XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
return current_power;
}
-double CpuEnergy::getConsumedEnergy()
+double HostEnergy::getConsumedEnergy()
{
- return total_energy;
+ 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;
}
-xbt_dynar_t CpuEnergy::getWattsRangeList()
+void HostEnergy::initWattsRangeList()
{
- 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(), "power_per_state");
-
+ if (host->getProperties() == NULL)
+ return;
+ char* all_power_values_str =
+ (char*)xbt_dict_get_or_null(host->getProperties(), "watt_per_state");
if (all_power_values_str == NULL)
- return NULL;
-
+ return;
- power_range_list = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
+ int pstate_nb = xbt_dynar_length(all_power_values);
- pstate_nb = xbt_dynar_length(all_power_values);
- for (i=0; i< pstate_nb; i++)
+ for (int 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_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",
- cpu->getName());
+ "Power properties incorrectly defined - "
+ "could not retrieve min and max power values for host %s",
+ host->getName().c_str());
/* 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);
+ 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(&all_power_values);
- return power_range_list;
+}
+
+}
+}
+
+/* **************************** events callback *************************** */
+static void onCreation(simgrid::surf::Host *host) {
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(host)) // Ignore virtual machines
+ return;
+ host->p_host->extension_set(new HostEnergy(host->p_host));
+}
+
+static void onActionStateChange(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 = 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>();
+
+ HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
+
+ if(host_energy->last_updated < surf_get_clock())
+ host_energy->update();
+}
+
+static void onHostStateChange(simgrid::surf::Host *host) {
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(host)) // Ignore virtual machines
+ return;
+
+ HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
+
+ if(host_energy->last_updated < surf_get_clock())
+ host_energy->update();
+}
+
+static void onHostDestruction(simgrid::surf::Host *host) {
+ // Ignore virtual machines
+ if (dynamic_cast<simgrid::surf::VirtualMachine*>(host))
+ return;
+ HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
+ host_energy->update();
+ XBT_INFO("Total energy of host %s: %f Joules", host->getName(), host_energy->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 (HostEnergy::EXTENSION_ID.valid())
+ return;
+
+ HostEnergy::EXTENSION_ID = simgrid::Host::extension_create<HostEnergy>();
+
+ simgrid::surf::Host::onCreation.connect(&onCreation);
+ simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
+ simgrid::surf::Host::onStateChange.connect(&onHostStateChange);
+ simgrid::surf::Host::onDestruction.connect(&onHostDestruction);
+}
+
+/** @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);
}
