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