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