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