src/surf/plugins/energy.cpp

   1 /* Copyright (c) 2010, 2012-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <utility>
   8
   9 #include "simgrid/plugins/energy.h"
  10 #include "simgrid/simix.hpp"
  11 #include "src/surf/plugins/energy.hpp"
  12 #include "src/surf/cpu_interface.hpp"
  13 #include "src/surf/virtual_machine.hpp"
  14
  15 /** @addtogroup SURF_plugin_energy
  16
  17
  18 This is the energy plugin, enabling to account not only for computation time,
  19 but also for the dissipated energy in the simulated platform.
  20
  21 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
  22
  23 \verbatim
  24 <host id="HostA" power="100.0Mf" >
  25     <prop id="watt_per_state" value="100.0:200.0" />
  26     <prop id="watt_off" value="10" />
  27 </host>
  28 \endverbatim
  29
  30 The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
  31 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  32 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
  33 values are arbitrary).
  34
  35 If your CPU is using pstates, then you can provide one consumption interval per pstate.
  36
  37 \verbatim
  38 <host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
  39     <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
  40     <prop id="watt_off" value="10" />
  41 </host>
  42 \endverbatim
  43
  44 That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
  45 It starts at pstate 0 (ie, at 100 Mflop/s). In this case, you have to specify one interval per pstate in the
  46 watt_per_state property.
  47 In this example, the idle consumption is 95 Watts, 93 Watts and 90 Watts in each pstate while the CPU burn consumption
  48 are at 200 Watts, 170 Watts, and 150 Watts respectively.
  49
  50 To change the pstate of a given CPU, use the following functions:
  51 #MSG_host_get_nb_pstates(), simgrid#s4u#Host#setPstate(), #MSG_host_get_power_peak_at().
  52
  53 To simulate the energy-related elements, first call the simgrid#energy#sg_energy_plugin_init() before your #MSG_init(),
  54 and then use the following function to retrieve the consumption of a given host: MSG_host_get_consumed_energy().
  55  */
  56
  57 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
  58
  59 using simgrid::energy::HostEnergy;
  60
  61 namespace simgrid {
  62 namespace energy {
  63
  64 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
  65
  66 /* Computes the consumption so far.  Called lazily on need. */
  67 void HostEnergy::update()
  68 {
  69   simgrid::surf::HostImpl* surf_host = host->extension<simgrid::surf::HostImpl>();
  70   double start_time = this->last_updated;
  71   double finish_time = surf_get_clock();
  72   double cpu_load;
  73   if (surf_host->cpu_->speed_.peak <= 0)
  74     // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
  75     // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
  76     cpu_load = 1;
  77   else
  78     cpu_load = lmm_constraint_get_usage(surf_host->cpu_->getConstraint()) / surf_host->cpu_->speed_.peak;
  79
  80   if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
  81     cpu_load = 1;
  82   /* The problem with this model is that the load is always 0 or 1, never something less.
  83    * Another possibility could be to model the total energy as
  84    *
  85    *   X/(X+Y)*W_idle + Y/(X+Y)*W_burn
  86    *
  87    * where X is the amount of ideling cores, and Y the amount of computing cores.
  88    */
  89
  90   double previous_energy = this->total_energy;
  91
  92   double instantaneous_consumption;
  93   if (host->isOff())
  94     instantaneous_consumption = this->watts_off;
  95   else
  96     instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
  97
  98   double energy_this_step = instantaneous_consumption*(finish_time-start_time);
  99
 100   this->total_energy = previous_energy + energy_this_step;
 101   this->last_updated = finish_time;
 102
 103   XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
 104       surf_host->getName(), start_time, finish_time, surf_host->cpu_->speed_.peak, previous_energy, energy_this_step);
 105 }
 106
 107 HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) : host(ptr), last_updated(surf_get_clock())
 108 {
 109   initWattsRangeList();
 110
 111   if (host->properties() != nullptr) {
 112     char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
 113     if (off_power_str != nullptr) {
 114       char *msg = bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str());
 115       watts_off = xbt_str_parse_double(off_power_str, msg);
 116       xbt_free(msg);
 117     }
 118     else
 119       watts_off = 0;
 120   }
 121 }
 122
 123 HostEnergy::~HostEnergy()=default;
 124
 125 double HostEnergy::getWattMinAt(int pstate)
 126 {
 127   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 128   return power_range_watts_list[pstate].first;
 129 }
 130
 131 double HostEnergy::getWattMaxAt(int pstate)
 132 {
 133   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 134   return power_range_watts_list[pstate].second;
 135 }
 136
 137 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
 138 double HostEnergy::getCurrentWattsValue(double cpu_load)
 139 {
 140   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 141
 142   /* min_power corresponds to the idle power (cpu load = 0) */
 143   /* max_power is the power consumed at 100% cpu load       */
 144   auto range = power_range_watts_list.at(host->pstate());
 145   double min_power = range.first;
 146   double max_power = range.second;
 147   double power_slope = max_power - min_power;
 148   double current_power = min_power + cpu_load * power_slope;
 149
 150   XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
 151   XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
 152
 153   return current_power;
 154 }
 155
 156 double HostEnergy::getConsumedEnergy()
 157 {
 158   if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
 159     simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
 160
 161   return total_energy;
 162 }
 163
 164 void HostEnergy::initWattsRangeList()
 165 {
 166   if (host->properties() == nullptr)
 167     return;
 168   char* all_power_values_str = static_cast<char*>(xbt_dict_get_or_null(host->properties(), "watt_per_state"));
 169   if (all_power_values_str == nullptr)
 170     return;
 171
 172   xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
 173   int pstate_nb = xbt_dynar_length(all_power_values);
 174
 175   for (int i=0; i< pstate_nb; i++) {
 176     /* retrieve the power values associated with the current pstate */
 177     xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
 178     xbt_assert(xbt_dynar_length(current_power_values) > 1,
 179         "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
 180         host->name().c_str());
 181
 182     /* min_power corresponds to the idle power (cpu load = 0) */
 183     /* max_power is the power consumed at 100% cpu load       */
 184     char *msg_min = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
 185     char *msg_max = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
 186     power_range_watts_list.push_back(power_range(
 187       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*), msg_min),
 188       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*), msg_max)
 189     ));
 190     xbt_free(msg_min);
 191     xbt_free(msg_max);
 192
 193     xbt_dynar_free(&current_power_values);
 194   }
 195   xbt_dynar_free(&all_power_values);
 196 }
 197
 198 }
 199 }
 200
 201 /* **************************** events  callback *************************** */
 202 static void onCreation(simgrid::s4u::Host& host) {
 203   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
 204   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
 205     return;
 206   host.extension_set(new HostEnergy(&host));
 207 }
 208
 209 static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
 210   for(simgrid::surf::Cpu* cpu : action->cpus()) {
 211     const char *name = cpu->getName();
 212     sg_host_t sghost = sg_host_by_name(name);
 213     if(sghost == nullptr)
 214       continue;
 215     simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
 216     simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
 217     if (vm) // If it's a VM, take the corresponding PM
 218       host = vm->getPm()->extension<simgrid::surf::HostImpl>();
 219
 220     HostEnergy *host_energy = host->piface_->extension<HostEnergy>();
 221
 222     if(host_energy->last_updated < surf_get_clock())
 223       host_energy->update();
 224   }
 225 }
 226
 227 static void onHostStateChange(simgrid::s4u::Host &host) {
 228   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
 229   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
 230     return;
 231
 232   HostEnergy *host_energy = host.extension<HostEnergy>();
 233
 234   if(host_energy->last_updated < surf_get_clock())
 235     host_energy->update();
 236 }
 237
 238 static void onHostDestruction(simgrid::s4u::Host& host) {
 239   // Ignore virtual machines
 240   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
 241   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
 242     return;
 243   HostEnergy *host_energy = host.extension<HostEnergy>();
 244   host_energy->update();
 245   XBT_INFO("Total energy of host %s: %f Joules", host.name().c_str(), host_energy->getConsumedEnergy());
 246 }
 247
 248 /* **************************** Public interface *************************** */
 249 /** \ingroup SURF_plugin_energy
 250  * \brief Enable energy plugin
 251  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
 252  */
 253 void sg_energy_plugin_init()
 254 {
 255   if (HostEnergy::EXTENSION_ID.valid())
 256     return;
 257
 258   HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
 259
 260   simgrid::s4u::Host::onCreation.connect(&onCreation);
 261   simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
 262   simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
 263   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
 264 }
 265
 266 /** @brief Returns the total energy consumed by the host so far (in Joules)
 267  *
 268  *  See also @ref SURF_plugin_energy.
 269  */
 270 double sg_host_get_consumed_energy(sg_host_t host) {
 271   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
 272     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 273   return host->extension<HostEnergy>()->getConsumedEnergy();
 274 }
 275
 276 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
 277 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
 278   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
 279     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 280   return host->extension<HostEnergy>()->getWattMinAt(pstate);
 281 }
 282 /** @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
 283 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
 284   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
 285     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 286   return host->extension<HostEnergy>()->getWattMaxAt(pstate);
 287 }