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 <src/surf/plugins/energy.hpp>
   8 #include <src/surf/cpu_interface.hpp>
   9 #include <src/surf/virtual_machine.hpp>
  10
  11 /** @addtogroup SURF_plugin_energy
  12
  13
  14 This is the energy plugin, enabling to account not only for computation time,
  15 but also for the dissipated energy in the simulated platform.
  16
  17 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
  18
  19 \verbatim
  20 <host id="HostA" power="100.0Mf" >
  21     <prop id="watt_per_state" value="100.0:200.0" />
  22     <prop id="watt_off" value="10" />
  23 </host>
  24 \endverbatim
  25
  26 The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
  27 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  28 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these values are arbitrary).
  29
  30 If your CPU is using pstates, then you can provide one consumption interval per pstate.
  31
  32 \verbatim
  33 <host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
  34     <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
  35     <prop id="watt_off" value="10" />
  36 </host>
  37 \endverbatim
  38
  39 That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
  40 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.
  41 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,
  42 170 Watts and 150 Watts respectively.
  43
  44 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().
  45
  46 To simulate the energy-related elements, first call the #sg_energy_plugin_init() before your #MSG_init(),
  47 and then use the following function to retrieve the consumption of a given host: #MSG_host_get_consumed_energy().
  48  */
  49
  50 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
  51                                 "Logging specific to the SURF energy plugin");
  52
  53 namespace simgrid {
  54 namespace energy {
  55
  56 std::map<simgrid::surf::Host*, HostEnergy*> *surf_energy = NULL;
  57
  58 }
  59 }
  60
  61 using simgrid::energy::HostEnergy;
  62 using simgrid::energy::surf_energy;
  63
  64 /* Computes the consumption so far.  Called lazily on need. */
  65 static void update_consumption(simgrid::surf::Host *host, HostEnergy *host_energy) {
  66         double cpu_load = lmm_constraint_get_usage(host->p_cpu->getConstraint()) / host->p_cpu->m_speedPeak;
  67         double start_time = host_energy->last_updated;
  68         double finish_time = surf_get_clock();
  69
  70         double previous_energy = host_energy->total_energy;
  71
  72         double instantaneous_consumption;
  73         if (host->getState() == SURF_RESOURCE_OFF)
  74                 instantaneous_consumption = host_energy->watts_off;
  75         else
  76                 instantaneous_consumption = host_energy->getCurrentWattsValue(cpu_load);
  77
  78         double energy_this_step = instantaneous_consumption*(finish_time-start_time);
  79
  80         host_energy->total_energy = previous_energy + energy_this_step;
  81         host_energy->last_updated = finish_time;
  82
  83         XBT_DEBUG("[cpu_update_energy] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
  84                   start_time, finish_time, host->p_cpu->m_speedPeak, previous_energy, energy_this_step);
  85 }
  86
  87 /** \ingroup SURF_plugin_energy
  88  * \brief Enable energy plugin
  89  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
  90  */
  91 void sg_energy_plugin_init() {
  92   if (simgrid::energy::surf_energy == NULL) {
  93
  94         simgrid::energy::surf_energy = new std::map<simgrid::surf::Host*, simgrid::energy::HostEnergy*>();
  95
  96     /* The following attaches an anonymous function to the Host::onCreation signal */
  97         /* Search for "C++ lambda" for more information on the syntax used here */
  98     simgrid::surf::Host::onCreation.connect([](simgrid::surf::Host *host) {
  99         (*surf_energy)[host] = new HostEnergy(host);
 100     });
 101
 102     simgrid::surf::VMCreatedCallbacks.connect([](simgrid::surf::VirtualMachine* vm) {
 103         std::map<simgrid::surf::Host*, HostEnergy*>::iterator host_energy_it =
 104                         surf_energy->find(vm->p_hostPM->extension(simgrid::surf::Host::EXTENSION_ID));
 105         xbt_assert(host_energy_it != surf_energy->end(), "The host is not in surf_energy.");
 106         (*surf_energy)[vm] = host_energy_it->second;
 107         host_energy_it->second->ref(); // protect the HostEnergy from getting deleted too early
 108     });
 109
 110     simgrid::surf::Host::onDestruction.connect([](simgrid::surf::Host *host) {
 111         std::map<simgrid::surf::Host*, HostEnergy*>::iterator host_energy_it = surf_energy->find(host);
 112         xbt_assert(host_energy_it != surf_energy->end(), "The host is not in surf_energy.");
 113
 114         HostEnergy *host_energy = host_energy_it->second;
 115         update_consumption(host, host_energy);
 116
 117         if (host_energy_it->second->refcount == 1) // Don't display anything for virtual CPUs
 118                 XBT_INFO("Total energy of host %s: %f Joules", host->getName(), host_energy->getConsumedEnergy());
 119         host_energy_it->second->unref();
 120         surf_energy->erase(host_energy_it);
 121     });
 122     simgrid::surf::CpuAction::onStateChange.connect([]
 123                                                                                                          (simgrid::surf::CpuAction *action,
 124                                                                                                                          e_surf_action_state_t old,
 125                                                                                                                          e_surf_action_state_t cur) {
 126         const char *name = getActionCpu(action)->getName();
 127         simgrid::surf::Host *host = static_cast<simgrid::surf::Host*>(surf_host_resource_priv(sg_host_by_name(name)));
 128
 129         HostEnergy *host_energy = (*surf_energy)[host];
 130
 131         if(host_energy->last_updated < surf_get_clock())
 132                 update_consumption(host, host_energy);
 133
 134     });
 135
 136     simgrid::surf::Host::onStateChange.connect([]
 137                                                                                                 (simgrid::surf::Host *host,
 138                                                                                                                 e_surf_resource_state_t oldState,
 139                                                                                                                 e_surf_resource_state_t newState) {
 140         HostEnergy *host_energy = (*surf_energy)[host];
 141
 142         if(host_energy->last_updated < surf_get_clock())
 143                 update_consumption(host, host_energy);
 144     });
 145
 146     simgrid::surf::surfExitCallbacks.connect([]() {
 147         delete surf_energy;
 148         surf_energy = NULL;
 149     });
 150   }
 151 }
 152
 153 namespace simgrid {
 154 namespace energy {
 155
 156 /**
 157  *
 158  */
 159 HostEnergy::HostEnergy(simgrid::surf::Host *ptr)
 160 {
 161   host = ptr;
 162   total_energy = 0;
 163   power_range_watts_list = getWattsRangeList();
 164   last_updated = surf_get_clock();
 165
 166   if (host->getProperties() != NULL) {
 167         char* off_power_str = (char*)xbt_dict_get_or_null(host->getProperties(), "watt_off");
 168         if (off_power_str != NULL)
 169                 watts_off = atof(off_power_str);
 170         else
 171                 watts_off = 0;
 172   }
 173
 174 }
 175
 176 HostEnergy::~HostEnergy(){
 177   unsigned int iter;
 178   xbt_dynar_t power_tuple = NULL;
 179   xbt_dynar_foreach(power_range_watts_list, iter, power_tuple)
 180     xbt_dynar_free(&power_tuple);
 181   xbt_dynar_free(&power_range_watts_list);
 182 }
 183
 184
 185 double HostEnergy::getWattMinAt(int pstate) {
 186   xbt_dynar_t power_range_list = power_range_watts_list;
 187   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
 188   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, host->p_cpu->getPState(), xbt_dynar_t);
 189   double min_power = xbt_dynar_get_as(current_power_values, 0, double);
 190   return min_power;
 191 }
 192 double HostEnergy::getWattMaxAt(int pstate) {
 193   xbt_dynar_t power_range_list = power_range_watts_list;
 194   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
 195   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, host->p_cpu->getPState(), xbt_dynar_t);
 196   double max_power = xbt_dynar_get_as(current_power_values, 1, double);
 197   return max_power;
 198 }
 199
 200 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
 201 double HostEnergy::getCurrentWattsValue(double cpu_load)
 202 {
 203         xbt_dynar_t power_range_list = power_range_watts_list;
 204         xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
 205
 206         int pstate = host->p_cpu->getPState();
 207         xbt_assert(pstate < (int)xbt_dynar_length(power_range_list),
 208                         "pstate %d >= power range amound %d",pstate,(int)xbt_dynar_length(power_range_list));
 209     /* retrieve the power values associated with the current pstate */
 210     xbt_dynar_t current_power_values = xbt_dynar_get_as( power_range_list, pstate, xbt_dynar_t);
 211
 212     /* min_power corresponds to the idle power (cpu load = 0) */
 213     /* max_power is the power consumed at 100% cpu load       */
 214     double min_power = xbt_dynar_get_as(current_power_values, 0, double);
 215     double max_power = xbt_dynar_get_as(current_power_values, 1, double);
 216     double power_slope = max_power - min_power;
 217
 218     double current_power = min_power + cpu_load * power_slope;
 219
 220         XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
 221     XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
 222
 223         return current_power;
 224 }
 225
 226 double HostEnergy::getConsumedEnergy()
 227 {
 228         if(last_updated < surf_get_clock())
 229                 update_consumption(host, this);
 230         return total_energy;
 231 }
 232
 233 xbt_dynar_t HostEnergy::getWattsRangeList()
 234 {
 235         xbt_dynar_t power_range_list;
 236         xbt_dynar_t power_tuple;
 237         int i = 0, pstate_nb=0;
 238         xbt_dynar_t current_power_values;
 239         double min_power, max_power;
 240
 241         if (host->getProperties() == NULL)
 242                 return NULL;
 243
 244         char* all_power_values_str = (char*)xbt_dict_get_or_null(host->getProperties(), "watt_per_state");
 245
 246         if (all_power_values_str == NULL)
 247                 return NULL;
 248
 249
 250         power_range_list = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
 251         xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
 252
 253         pstate_nb = xbt_dynar_length(all_power_values);
 254         for (i=0; i< pstate_nb; i++)
 255         {
 256                 /* retrieve the power values associated with the current pstate */
 257                 current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
 258                 xbt_assert(xbt_dynar_length(current_power_values) > 1,
 259                                 "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
 260                                 host->getName());
 261
 262                 /* min_power corresponds to the idle power (cpu load = 0) */
 263                 /* max_power is the power consumed at 100% cpu load       */
 264                 min_power = atof(xbt_dynar_get_as(current_power_values, 0, char*));
 265                 max_power = atof(xbt_dynar_get_as(current_power_values, 1, char*));
 266
 267                 power_tuple = xbt_dynar_new(sizeof(double), NULL);
 268                 xbt_dynar_push_as(power_tuple, double, min_power);
 269                 xbt_dynar_push_as(power_tuple, double, max_power);
 270
 271                 xbt_dynar_push_as(power_range_list, xbt_dynar_t, power_tuple);
 272                 xbt_dynar_free(&current_power_values);
 273         }
 274         xbt_dynar_free(&all_power_values);
 275         return power_range_list;
 276 }
 277
 278 }
 279 }