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_nb_pstates(), #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<Cpu*, CpuEnergy*> *surf_energy=NULL;
  54
  55 static void energyCpuCreatedCallback(Cpu *cpu){
  56   (*surf_energy)[cpu] = new CpuEnergy(cpu);
  57 }
  58
  59
  60 /* Computes the consumption so far.  Called lazily on need. */
  61 static void update_consumption(Cpu *cpu, CpuEnergy *cpu_energy) {
  62         double cpu_load = lmm_constraint_get_usage(cpu->getConstraint()) / cpu->m_powerPeak;
  63         double start_time = cpu_energy->last_updated;
  64         double finish_time = surf_get_clock();
  65
  66         double previous_energy = cpu_energy->total_energy;
  67
  68         double instantaneous_consumption;
  69         if (cpu->getState() == SURF_RESOURCE_OFF)
  70                 instantaneous_consumption = cpu_energy->watts_off;
  71         else
  72                 instantaneous_consumption = cpu_energy->getCurrentWattsValue(cpu_load);
  73
  74         double energy_this_step = instantaneous_consumption*(finish_time-start_time);
  75
  76         cpu_energy->total_energy = previous_energy + energy_this_step;
  77         cpu_energy->last_updated = finish_time;
  78
  79         XBT_DEBUG("[cpu_update_energy] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
  80                   start_time, finish_time, cpu->m_powerPeak, previous_energy, energy_this_step);
  81 }
  82
  83 static void energyCpuDestructedCallback(Cpu *cpu){
  84   std::map<Cpu*, CpuEnergy*>::iterator cpu_energy_it = surf_energy->find(cpu);
  85   xbt_assert(cpu_energy_it != surf_energy->end(), "The cpu is not in surf_energy.");
  86
  87   CpuEnergy *cpu_energy = cpu_energy_it->second;
  88   update_consumption(cpu, cpu_energy);
  89
  90   XBT_INFO("Total energy of host %s: %f Joules", cpu->getName(), cpu_energy->getConsumedEnergy());
  91   delete cpu_energy_it->second;
  92   surf_energy->erase(cpu_energy_it);
  93 }
  94
  95 static void energyCpuActionStateChangedCallback(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t cur){
  96   Cpu *cpu  = getActionCpu(action);
  97   CpuEnergy *cpu_energy = (*surf_energy)[cpu];
  98
  99   if(cpu_energy->last_updated < surf_get_clock())
 100           update_consumption(cpu, cpu_energy);
 101 }
 102
 103 static void energyStateChangedCallback(Cpu *cpu, e_surf_resource_state_t oldState, e_surf_resource_state_t newState){
 104   CpuEnergy *cpu_energy = (*surf_energy)[cpu];
 105
 106   if(cpu_energy->last_updated < surf_get_clock())
 107           update_consumption(cpu, cpu_energy);
 108 }
 109
 110 static void sg_energy_plugin_exit()
 111 {
 112   delete surf_energy;
 113   surf_energy = NULL;
 114 }
 115
 116 /** \ingroup SURF_plugin_energy
 117  * \brief Enable energy plugin
 118  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
 119  */
 120 void sg_energy_plugin_init() {
 121   if (surf_energy == NULL) {
 122     surf_energy = new std::map<Cpu*, CpuEnergy*>();
 123     surf_callback_connect(cpuCreatedCallbacks, energyCpuCreatedCallback);
 124     surf_callback_connect(cpuDestructedCallbacks, energyCpuDestructedCallback);
 125     surf_callback_connect(cpuActionStateChangedCallbacks, energyCpuActionStateChangedCallback);
 126     surf_callback_connect(surfExitCallbacks, sg_energy_plugin_exit);
 127     surf_callback_connect(cpuStateChangedCallbacks, energyStateChangedCallback);
 128   }
 129 }
 130
 131 /**
 132  *
 133  */
 134 CpuEnergy::CpuEnergy(Cpu *ptr)
 135 {
 136   cpu = ptr;
 137   total_energy = 0;
 138   power_range_watts_list = getWattsRangeList();
 139   last_updated = surf_get_clock();
 140
 141   if (cpu->getProperties() != NULL) {
 142         char* off_power_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_off");
 143         if (off_power_str != NULL)
 144                 watts_off = atof(off_power_str);
 145         else
 146                 watts_off = 0;
 147   }
 148
 149 }
 150
 151 CpuEnergy::~CpuEnergy(){
 152   unsigned int iter;
 153   xbt_dynar_t power_tuple = NULL;
 154   xbt_dynar_foreach(power_range_watts_list, iter, power_tuple)
 155     xbt_dynar_free(&power_tuple);
 156   xbt_dynar_free(&power_range_watts_list);
 157 }
 158
 159
 160 double CpuEnergy::getWattMinAt(int pstate) {
 161   xbt_dynar_t power_range_list = power_range_watts_list;
 162   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
 163   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
 164   double min_power = xbt_dynar_get_as(current_power_values, 0, double);
 165   return min_power;
 166 }
 167 double CpuEnergy::getWattMaxAt(int pstate) {
 168   xbt_dynar_t power_range_list = power_range_watts_list;
 169   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
 170   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
 171   double max_power = xbt_dynar_get_as(current_power_values, 1, double);
 172   return max_power;
 173 }
 174
 175 /**
 176  * Computes the power consumed by the host according to the current pstate and processor load
 177  *
 178  */
 179 double CpuEnergy::getCurrentWattsValue(double cpu_load)
 180 {
 181         xbt_dynar_t power_range_list = power_range_watts_list;
 182         xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
 183
 184     /* retrieve the power values associated with the current pstate */
 185     xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
 186
 187     /* min_power corresponds to the idle power (cpu load = 0) */
 188     /* max_power is the power consumed at 100% cpu load       */
 189     double min_power = xbt_dynar_get_as(current_power_values, 0, double);
 190     double max_power = xbt_dynar_get_as(current_power_values, 1, double);
 191     double power_slope = max_power - min_power;
 192
 193     double current_power = min_power + cpu_load * power_slope;
 194
 195         XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
 196     XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
 197
 198         return current_power;
 199 }
 200
 201 double CpuEnergy::getConsumedEnergy()
 202 {
 203         if(last_updated < surf_get_clock())
 204                 update_consumption(cpu, this);
 205         return total_energy;
 206 }
 207
 208 xbt_dynar_t CpuEnergy::getWattsRangeList()
 209 {
 210         xbt_dynar_t power_range_list;
 211         xbt_dynar_t power_tuple;
 212         int i = 0, pstate_nb=0;
 213         xbt_dynar_t current_power_values;
 214         double min_power, max_power;
 215
 216         if (cpu->getProperties() == NULL)
 217                 return NULL;
 218
 219         char* all_power_values_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_per_state");
 220
 221         if (all_power_values_str == NULL)
 222                 return NULL;
 223
 224
 225         power_range_list = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
 226         xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
 227
 228         pstate_nb = xbt_dynar_length(all_power_values);
 229         for (i=0; i< pstate_nb; i++)
 230         {
 231                 /* retrieve the power values associated with the current pstate */
 232                 current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
 233                 xbt_assert(xbt_dynar_length(current_power_values) > 1,
 234                                 "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
 235                                 cpu->getName());
 236
 237                 /* min_power corresponds to the idle power (cpu load = 0) */
 238                 /* max_power is the power consumed at 100% cpu load       */
 239                 min_power = atof(xbt_dynar_get_as(current_power_values, 0, char*));
 240                 max_power = atof(xbt_dynar_get_as(current_power_values, 1, char*));
 241
 242                 power_tuple = xbt_dynar_new(sizeof(double), NULL);
 243                 xbt_dynar_push_as(power_tuple, double, min_power);
 244                 xbt_dynar_push_as(power_tuple, double, max_power);
 245
 246                 xbt_dynar_push_as(power_range_list, xbt_dynar_t, power_tuple);
 247                 xbt_dynar_free(&current_power_values);
 248         }
 249         xbt_dynar_free(&all_power_values);
 250         return power_range_list;
 251 }