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 start_time = host_energy->last_updated;
  67         double finish_time = surf_get_clock();
  68         double cpu_load;
  69         if (host->p_cpu->m_speedPeak == 0)
  70                 // Some users declare a pstate of speed 0 flops (eg to model boot time).
  71                 // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
  72                 cpu_load = 1;
  73         else
  74                 cpu_load = lmm_constraint_get_usage(host->p_cpu->getConstraint()) / host->p_cpu->m_speedPeak;
  75
  76         double previous_energy = host_energy->total_energy;
  77
  78         double instantaneous_consumption;
  79         if (host->getState() == SURF_RESOURCE_OFF)
  80                 instantaneous_consumption = host_energy->watts_off;
  81         else
  82                 instantaneous_consumption = host_energy->getCurrentWattsValue(cpu_load);
  83
  84         double energy_this_step = instantaneous_consumption*(finish_time-start_time);
  85
  86         host_energy->total_energy = previous_energy + energy_this_step;
  87         host_energy->last_updated = finish_time;
  88
  89         XBT_DEBUG("[cpu_update_energy] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
  90                   start_time, finish_time, host->p_cpu->m_speedPeak, previous_energy, energy_this_step);
  91 }
  92
  93 /** \ingroup SURF_plugin_energy
  94  * \brief Enable energy plugin
  95  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
  96  */
  97 void sg_energy_plugin_init() {
  98   if (simgrid::energy::surf_energy == NULL) {
  99
 100         simgrid::energy::surf_energy = new std::map<simgrid::surf::Host*, simgrid::energy::HostEnergy*>();
 101
 102     /* The following attaches an anonymous function to the Host::onCreation signal */
 103         /* Search for "C++ lambda" for more information on the syntax used here */
 104     simgrid::surf::Host::onCreation.connect([](simgrid::surf::Host *host) {
 105         (*surf_energy)[host] = new HostEnergy(host);
 106     });
 107
 108     simgrid::surf::VMCreatedCallbacks.connect([](simgrid::surf::VirtualMachine* vm) {
 109         std::map<simgrid::surf::Host*, HostEnergy*>::iterator host_energy_it =
 110                         surf_energy->find(vm->p_hostPM->extension(simgrid::surf::Host::EXTENSION_ID));
 111         xbt_assert(host_energy_it != surf_energy->end(), "The host is not in surf_energy.");
 112         (*surf_energy)[vm] = host_energy_it->second;
 113         host_energy_it->second->ref(); // protect the HostEnergy from getting deleted too early
 114     });
 115
 116     simgrid::surf::Host::onDestruction.connect([](simgrid::surf::Host *host) {
 117         std::map<simgrid::surf::Host*, HostEnergy*>::iterator host_energy_it = surf_energy->find(host);
 118         xbt_assert(host_energy_it != surf_energy->end(), "The host is not in surf_energy.");
 119
 120         HostEnergy *host_energy = host_energy_it->second;
 121         update_consumption(host, host_energy);
 122
 123         if (host_energy_it->second->refcount == 1) // Don't display anything for virtual CPUs
 124                 XBT_INFO("Total energy of host %s: %f Joules", host->getName(), host_energy->getConsumedEnergy());
 125         host_energy_it->second->unref();
 126         surf_energy->erase(host_energy_it);
 127     });
 128     simgrid::surf::CpuAction::onStateChange.connect([](simgrid::surf::CpuAction *action,
 129                                                        e_surf_action_state_t old,
 130                                                        e_surf_action_state_t cur) {
 131         const char *name = getActionCpu(action)->getName();
 132         simgrid::surf::Host *host = static_cast<simgrid::surf::Host*>(surf_host_resource_priv(sg_host_by_name(name)));
 133
 134         HostEnergy *host_energy = (*surf_energy)[host];
 135
 136         if(host_energy->last_updated < surf_get_clock())
 137                 update_consumption(host, host_energy);
 138
 139     });
 140
 141     simgrid::surf::Host::onStateChange.connect([]
 142                                                                                                 (simgrid::surf::Host *host,
 143                                                                                                                 e_surf_resource_state_t oldState,
 144                                                                                                                 e_surf_resource_state_t newState) {
 145         HostEnergy *host_energy = (*surf_energy)[host];
 146
 147         if(host_energy->last_updated < surf_get_clock())
 148                 update_consumption(host, host_energy);
 149     });
 150
 151     simgrid::surf::surfExitCallbacks.connect([]() {
 152         delete surf_energy;
 153         surf_energy = NULL;
 154     });
 155   }
 156 }
 157
 158 namespace simgrid {
 159 namespace energy {
 160
 161 /**
 162  *
 163  */
 164 HostEnergy::HostEnergy(simgrid::surf::Host *ptr)
 165 {
 166   host = ptr;
 167   total_energy = 0;
 168   power_range_watts_list = getWattsRangeList();
 169   last_updated = surf_get_clock();
 170
 171   if (host->getProperties() != NULL) {
 172         char* off_power_str = (char*)xbt_dict_get_or_null(host->getProperties(), "watt_off");
 173         if (off_power_str != NULL)
 174                 watts_off = atof(off_power_str);
 175         else
 176                 watts_off = 0;
 177   }
 178
 179 }
 180
 181 HostEnergy::~HostEnergy(){
 182   unsigned int iter;
 183   xbt_dynar_t power_tuple = NULL;
 184   xbt_dynar_foreach(power_range_watts_list, iter, power_tuple)
 185     xbt_dynar_free(&power_tuple);
 186   xbt_dynar_free(&power_range_watts_list);
 187 }
 188
 189
 190 double HostEnergy::getWattMinAt(int pstate) {
 191   xbt_dynar_t power_range_list = power_range_watts_list;
 192   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
 193   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, host->p_cpu->getPState(), xbt_dynar_t);
 194   double min_power = xbt_dynar_get_as(current_power_values, 0, double);
 195   return min_power;
 196 }
 197 double HostEnergy::getWattMaxAt(int pstate) {
 198   xbt_dynar_t power_range_list = power_range_watts_list;
 199   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
 200   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, host->p_cpu->getPState(), xbt_dynar_t);
 201   double max_power = xbt_dynar_get_as(current_power_values, 1, double);
 202   return max_power;
 203 }
 204
 205 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
 206 double HostEnergy::getCurrentWattsValue(double cpu_load)
 207 {
 208         xbt_dynar_t power_range_list = power_range_watts_list;
 209         xbt_assert(power_range_watts_list, "No power range properties specified for host %s", host->getName());
 210
 211         int pstate = host->p_cpu->getPState();
 212         xbt_assert(pstate < (int)xbt_dynar_length(power_range_list),
 213                         "pstate %d >= power range amound %d",pstate,(int)xbt_dynar_length(power_range_list));
 214     /* retrieve the power values associated with the current pstate */
 215     xbt_dynar_t current_power_values = xbt_dynar_get_as( power_range_list, pstate, xbt_dynar_t);
 216
 217     /* min_power corresponds to the idle power (cpu load = 0) */
 218     /* max_power is the power consumed at 100% cpu load       */
 219     double min_power = xbt_dynar_get_as(current_power_values, 0, double);
 220     double max_power = xbt_dynar_get_as(current_power_values, 1, double);
 221     double power_slope = max_power - min_power;
 222
 223     double current_power = min_power + cpu_load * power_slope;
 224
 225         XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
 226     XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
 227
 228         return current_power;
 229 }
 230
 231 double HostEnergy::getConsumedEnergy()
 232 {
 233         if(last_updated < surf_get_clock())
 234                 update_consumption(host, this);
 235         return total_energy;
 236 }
 237
 238 xbt_dynar_t HostEnergy::getWattsRangeList()
 239 {
 240         xbt_dynar_t power_range_list;
 241         xbt_dynar_t power_tuple;
 242         int i = 0, pstate_nb=0;
 243         xbt_dynar_t current_power_values;
 244         double min_power, max_power;
 245
 246         if (host->getProperties() == NULL)
 247                 return NULL;
 248
 249         char* all_power_values_str = (char*)xbt_dict_get_or_null(host->getProperties(), "watt_per_state");
 250
 251         if (all_power_values_str == NULL)
 252                 return NULL;
 253
 254
 255         power_range_list = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
 256         xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
 257
 258         pstate_nb = xbt_dynar_length(all_power_values);
 259         for (i=0; i< pstate_nb; i++)
 260         {
 261                 /* retrieve the power values associated with the current pstate */
 262                 current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
 263                 xbt_assert(xbt_dynar_length(current_power_values) > 1,
 264                                 "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
 265                                 host->getName());
 266
 267                 /* min_power corresponds to the idle power (cpu load = 0) */
 268                 /* max_power is the power consumed at 100% cpu load       */
 269                 min_power = atof(xbt_dynar_get_as(current_power_values, 0, char*));
 270                 max_power = atof(xbt_dynar_get_as(current_power_values, 1, char*));
 271
 272                 power_tuple = xbt_dynar_new(sizeof(double), NULL);
 273                 xbt_dynar_push_as(power_tuple, double, min_power);
 274                 xbt_dynar_push_as(power_tuple, double, max_power);
 275
 276                 xbt_dynar_push_as(power_range_list, xbt_dynar_t, power_tuple);
 277                 xbt_dynar_free(&current_power_values);
 278         }
 279         xbt_dynar_free(&all_power_values);
 280         return power_range_list;
 281 }
 282
 283 }
 284 }