src/surf/plugins/energy.cpp

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