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_->getPstateSpeedCurrent() <= 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_->getPstateSpeedCurrent();
  79
  80   /** Divide by the number of cores here **/
  81   cpu_load /= surf_host->cpu_->getCoreCount();
  82
  83   if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
  84     cpu_load = 1;
  85
  86   /* The problem with this model is that the load is always 0 or 1, never something less.
  87    * Another possibility could be to model the total energy as
  88    *
  89    *   X/(X+Y)*W_idle + Y/(X+Y)*W_burn
  90    *
  91    * where X is the amount of ideling cores, and Y the amount of computing cores.
  92    */
  93
  94   double previous_energy = this->total_energy;
  95
  96   double instantaneous_consumption;
  97   if (host->isOff())
  98     instantaneous_consumption = this->watts_off;
  99   else
 100     instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
 101
 102   double energy_this_step = instantaneous_consumption*(finish_time-start_time);
 103
 104   this->total_energy = previous_energy + energy_this_step;
 105   this->last_updated = finish_time;
 106
 107   XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
 108       surf_host->getName(), start_time, finish_time, surf_host->cpu_->speed_.peak, previous_energy, energy_this_step);
 109 }
 110
 111 HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) : host(ptr), last_updated(surf_get_clock())
 112 {
 113   initWattsRangeList();
 114
 115   if (host->properties() != nullptr) {
 116     char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
 117     if (off_power_str != nullptr) {
 118       char *msg = bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str());
 119       watts_off = xbt_str_parse_double(off_power_str, msg);
 120       xbt_free(msg);
 121     }
 122     else
 123       watts_off = 0;
 124   }
 125 }
 126
 127 HostEnergy::~HostEnergy()=default;
 128
 129 double HostEnergy::getWattMinAt(int pstate)
 130 {
 131   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 132   return power_range_watts_list[pstate].min;
 133 }
 134
 135 double HostEnergy::getWattMaxAt(int pstate)
 136 {
 137   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 138   return power_range_watts_list[pstate].max;
 139 }
 140
 141 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
 142 double HostEnergy::getCurrentWattsValue(double cpu_load)
 143 {
 144   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
 145
 146   /* min_power corresponds to the idle power (cpu load = 0) */
 147   /* max_power is the power consumed at 100% cpu load       */
 148   auto range           = power_range_watts_list.at(host->pstate());
 149   double current_power = 0;
 150   double min_power     = 0;
 151   double max_power     = 0;
 152   double power_slope   = 0;
 153
 154   if (cpu_load != 0) { /* Something is going on, the machine is not idle */
 155     double min_power = range.min;
 156     double max_power = range.max;
 157     double power_slope = max_power - min_power;
 158     current_power = min_power + cpu_load * power_slope;
 159   }
 160   else { /* Our machine is idle, take the dedicated value! */
 161     current_power = range.idle;
 162   }
 163
 164   XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
 165   XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
 166
 167   return current_power;
 168 }
 169
 170 double HostEnergy::getConsumedEnergy()
 171 {
 172   if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
 173     simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
 174
 175   return total_energy;
 176 }
 177
 178 void HostEnergy::initWattsRangeList()
 179 {
 180   if (host->properties() == nullptr)
 181     return;
 182   char* all_power_values_str = static_cast<char*>(xbt_dict_get_or_null(host->properties(), "watt_per_state"));
 183   if (all_power_values_str == nullptr)
 184     return;
 185
 186   xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
 187   int pstate_nb = xbt_dynar_length(all_power_values);
 188
 189   for (int i=0; i< pstate_nb; i++) {
 190     /* retrieve the power values associated with the current pstate */
 191     xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
 192     xbt_assert(xbt_dynar_length(current_power_values) > 1,
 193         "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
 194         host->name().c_str());
 195
 196     /* min_power corresponds to the idle power (cpu load = 0) */
 197     /* max_power is the power consumed at 100% cpu load       */
 198     char *msg_idle = bprintf("Invalid idle value for pstate %d on host %s: %%s", i, host->name().c_str());
 199     char *msg_min = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
 200     char *msg_max = bprintf("Invalid max value for pstate %d on host %s: %%s", i, host->name().c_str());
 201     PowerRange range(
 202       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*), msg_idle),
 203       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*), msg_min),
 204       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 2, char*), msg_max)
 205     );
 206     power_range_watts_list.push_back(range);
 207     xbt_free(msg_min);
 208     xbt_free(msg_max);
 209
 210     xbt_dynar_free(&current_power_values);
 211   }
 212   xbt_dynar_free(&all_power_values);
 213 }
 214
 215 }
 216 }
 217
 218 /* **************************** events  callback *************************** */
 219 static void onCreation(simgrid::s4u::Host& host) {
 220   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
 221   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
 222     return;
 223   host.extension_set(new HostEnergy(&host));
 224 }
 225
 226 static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
 227   for(simgrid::surf::Cpu* cpu : action->cpus()) {
 228     const char *name = cpu->getName();
 229     sg_host_t sghost = sg_host_by_name(name);
 230     if(sghost == nullptr)
 231       continue;
 232     simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
 233     simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
 234     if (vm) // If it's a VM, take the corresponding PM
 235       host = vm->getPm()->extension<simgrid::surf::HostImpl>();
 236
 237     HostEnergy *host_energy = host->piface_->extension<HostEnergy>();
 238
 239     if(host_energy->last_updated < surf_get_clock())
 240       host_energy->update();
 241   }
 242 }
 243
 244 static void onHostStateChange(simgrid::s4u::Host &host) {
 245   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
 246   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
 247     return;
 248
 249   HostEnergy *host_energy = host.extension<HostEnergy>();
 250
 251   if(host_energy->last_updated < surf_get_clock())
 252     host_energy->update();
 253 }
 254
 255 static void onHostDestruction(simgrid::s4u::Host& host) {
 256   // Ignore virtual machines
 257   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
 258   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
 259     return;
 260   HostEnergy *host_energy = host.extension<HostEnergy>();
 261   host_energy->update();
 262   XBT_INFO("Total energy of host %s: %f Joules", host.name().c_str(), host_energy->getConsumedEnergy());
 263 }
 264
 265 /* **************************** Public interface *************************** */
 266 /** \ingroup SURF_plugin_energy
 267  * \brief Enable energy plugin
 268  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
 269  */
 270 void sg_energy_plugin_init()
 271 {
 272   if (HostEnergy::EXTENSION_ID.valid())
 273     return;
 274
 275   HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
 276
 277   simgrid::s4u::Host::onCreation.connect(&onCreation);
 278   simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
 279   simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
 280   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
 281 }
 282
 283 /** @brief Returns the total energy consumed by the host so far (in Joules)
 284  *
 285  *  See also @ref SURF_plugin_energy.
 286  */
 287 double sg_host_get_consumed_energy(sg_host_t host) {
 288   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
 289     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 290   return host->extension<HostEnergy>()->getConsumedEnergy();
 291 }
 292
 293 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
 294 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
 295   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
 296     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 297   return host->extension<HostEnergy>()->getWattMinAt(pstate);
 298 }
 299 /** @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
 300 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
 301   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
 302     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
 303   return host->extension<HostEnergy>()->getWattMaxAt(pstate);
 304 }