Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1e7bdb7b464ff1fdeac9e1cf4041bb0d96a78e54
[simgrid.git] / src / plugins / host_energy.cpp
1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simgrid/plugins/energy.h"
7 #include "simgrid/plugins/load.h"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "src/include/surf/surf.hpp"
10 #include "src/plugins/vm/VirtualMachineImpl.hpp"
11 #include "src/surf/cpu_interface.hpp"
12
13 #include <boost/algorithm/string/classification.hpp>
14 #include <boost/algorithm/string/split.hpp>
15
16 /** @addtogroup plugin_energy
17
18 This is the energy plugin, enabling to account not only for computation time, but also for the dissipated energy in the
19 simulated platform.
20 To activate this plugin, first call sg_host_energy_plugin_init() before your #MSG_init(), and then use
21 MSG_host_get_consumed_energy() to retrieve the consumption of a given host.
22
23 When the host is on, this energy consumption naturally depends on both the current CPU load and the host energy profile.
24 According to our measurements, the consumption is somehow linear in the amount of cores at full speed, with an
25 abnormality when all the cores are idle. The full details are in
26 <a href="https://hal.inria.fr/hal-01523608">our scientific paper</a> on that topic.
27
28 As a result, our energy model takes 4 parameters:
29
30   - \b Idle: instantaneous consumption (in Watt) when your host is up and running, but without anything to do.
31   - \b OneCore: instantaneous consumption (in Watt) when only one core is active, at 100%.
32   - \b AllCores: instantaneous consumption (in Watt) when all cores of the host are at 100%.
33   - \b Off: instantaneous consumption (in Watt) when the host is turned off.
34
35 Here is an example of XML declaration:
36
37 \code{.xml}
38 <host id="HostA" power="100.0Mf" cores="4">
39     <prop id="watt_per_state" value="100.0:120.0:200.0" />
40     <prop id="watt_off" value="10" />
41 </host>
42 \endcode
43
44 This example gives the following parameters: \b Off is 10 Watts; \b Idle is 100 Watts; \b OneCore is 120 Watts and \b
45 AllCores is 200 Watts.
46 This is enough to compute the consumption as a function of the amount of loaded cores:
47
48 <table>
49 <tr><th>\#Cores loaded</th><th>Consumption</th><th>Explanation</th></tr>
50 <tr><td>0</td><td> 100 Watts</td><td>Idle value</td></tr>
51 <tr><td>1</td><td> 120 Watts</td><td>OneCore value</td></tr>
52 <tr><td>2</td><td> 147 Watts</td><td>linear extrapolation between OneCore and AllCores</td></tr>
53 <tr><td>3</td><td> 173 Watts</td><td>linear extrapolation between OneCore and AllCores</td></tr>
54 <tr><td>4</td><td> 200 Watts</td><td>AllCores value</td></tr>
55 </table>
56
57 ### What if a given core is only at load 50%?
58
59 This is impossible in SimGrid because we recompute everything each time that the CPU starts or stops doing something.
60 So if a core is at load 50% over a period, it means that it is at load 100% half of the time and at load 0% the rest of
61 the time, and our model holds.
62
63 ### What if the host has only one core?
64
65 In this case, the parameters \b OneCore and \b AllCores are obviously the same.
66 Actually, SimGrid expect an energetic profile formatted as 'Idle:Running' for mono-cores hosts.
67 If you insist on passing 3 parameters in this case, then you must have the same value for \b OneCore and \b AllCores.
68
69 \code{.xml}
70 <host id="HostC" power="100.0Mf" cores="1">
71     <prop id="watt_per_state" value="95.0:200.0" /> <!-- we may have used '95:200:200' instead -->
72     <prop id="watt_off" value="10" />
73 </host>
74 \endcode
75
76 ### How does DVFS interact with the host energy model?
77
78 If your host has several DVFS levels (several pstates), then you should give the energetic profile of each pstate level:
79
80 \code{.xml}
81 <host id="HostC" power="100.0Mf,50.0Mf,20.0Mf" cores="4">
82     <prop id="watt_per_state" value="95.0:120.0:200.0, 93.0:115.0:170.0, 90.0:110.0:150.0" />
83     <prop id="watt_off" value="10" />
84 </host>
85 \endcode
86
87 This encodes the following values
88 <table>
89 <tr><th>pstate</th><th>Performance</th><th>Idle</th><th>OneCore</th><th>AllCores</th></tr>
90 <tr><td>0</td><td>100 Mflop/s</td><td>95 Watts</td><td>120 Watts</td><td>200 Watts</td></tr>
91 <tr><td>1</td><td>50 Mflop/s</td><td>93 Watts</td><td>115 Watts</td><td>170 Watts</td></tr>
92 <tr><td>2</td><td>20 Mflop/s</td><td>90 Watts</td><td>110 Watts</td><td>150 Watts</td></tr>
93 </table>
94
95 To change the pstate of a given CPU, use the following functions:
96 #MSG_host_get_nb_pstates(), simgrid#s4u#Host#setPstate(), #MSG_host_get_power_peak_at().
97
98 ### How accurate are these models?
99
100 This model cannot be more accurate than your instantiation: with the default values, your result will not be accurate at
101 all. You can still get accurate energy prediction, provided that you carefully instantiate the model.
102 The first step is to ensure that your timing prediction match perfectly. But this is only the first step of the path,
103 and you really want to read <a href="https://hal.inria.fr/hal-01523608">this paper</a> to see all what you need to do
104 before you can get accurate energy predictions.
105  */
106
107 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
108
109 namespace simgrid {
110 namespace plugin {
111
112 class PowerRange {
113 public:
114   double idle_;
115   double min_;
116   double max_;
117
118   PowerRange(double idle, double min, double max) : idle_(idle), min_(min), max_(max) {}
119 };
120
121 class HostEnergy {
122 public:
123   static simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> EXTENSION_ID;
124
125   explicit HostEnergy(simgrid::s4u::Host* ptr);
126   ~HostEnergy();
127
128   double get_current_watts_value();
129   double get_current_watts_value(double cpu_load);
130   double get_consumed_energy();
131   double get_watt_min_at(int pstate);
132   double get_watt_max_at(int pstate);
133   void update();
134
135 private:
136   void init_watts_range_list();
137   simgrid::s4u::Host* host_ = nullptr;
138   /*< List of (min_power,max_power) pairs corresponding to each cpu pstate */
139   std::vector<PowerRange> power_range_watts_list_;
140
141   /* We need to keep track of what pstate has been used, as we will sometimes be notified only *after* a pstate has been
142    * used (but we need to update the energy consumption with the old pstate!)
143    */
144   int pstate_           = 0;
145   const int pstate_off_ = -1;
146
147 public:
148   double watts_off_    = 0.0; /*< Consumption when the machine is turned off (shutdown) */
149   double total_energy_ = 0.0; /*< Total energy consumed by the host */
150   double last_updated_;       /*< Timestamp of the last energy update event*/
151 };
152
153 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
154
155 /* Computes the consumption so far. Called lazily on need. */
156 void HostEnergy::update()
157 {
158   double start_time  = this->last_updated_;
159   double finish_time = surf_get_clock();
160   //
161   // We may have start == finish if the past consumption was updated since the simcall was started
162   // for example if 2 actors requested to update the same host's consumption in a given scheduling round.
163   //
164   // Even in this case, we need to save the pstate for the next call (after this if),
165   // which may have changed since that recent update.
166   if (start_time < finish_time) {
167     double previous_energy = this->total_energy_;
168
169     double instantaneous_consumption = this->get_current_watts_value();
170
171     double energy_this_step = instantaneous_consumption * (finish_time - start_time);
172
173     // TODO Trace: Trace energy_this_step from start_time to finish_time in host->getName()
174
175     this->total_energy_ = previous_energy + energy_this_step;
176     this->last_updated_ = finish_time;
177
178     XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> "
179               "%.2f J",
180               host_->get_cname(), start_time, finish_time, host_->pimpl_cpu->get_speed(1.0), previous_energy,
181               energy_this_step);
182   }
183
184   /* Save data for the upcoming time interval: whether it's on/off and the pstate if it's on */
185   this->pstate_ = host_->is_on() ? host_->get_pstate() : pstate_off_;
186 }
187
188 HostEnergy::HostEnergy(simgrid::s4u::Host* ptr) : host_(ptr), last_updated_(surf_get_clock())
189 {
190   init_watts_range_list();
191
192   const char* off_power_str = host_->get_property("watt_off");
193   if (off_power_str != nullptr) {
194     try {
195       this->watts_off_ = std::stod(std::string(off_power_str));
196     } catch (std::invalid_argument& ia) {
197       throw std::invalid_argument(std::string("Invalid value for property watt_off of host ") + host_->get_cname() +
198                                   ": " + off_power_str);
199     }
200   }
201   /* watts_off is 0 by default */
202 }
203
204 HostEnergy::~HostEnergy() = default;
205
206 double HostEnergy::get_watt_min_at(int pstate)
207 {
208   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
209              host_->get_cname());
210   return power_range_watts_list_[pstate].min_;
211 }
212
213 double HostEnergy::get_watt_max_at(int pstate)
214 {
215   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
216              host_->get_cname());
217   return power_range_watts_list_[pstate].max_;
218 }
219
220 /** @brief Computes the power consumed by the host according to the current situation
221  *
222  * - If the host is off, that's the watts_off value
223  * - if it's on, take the current pstate and the current processor load into account */
224 double HostEnergy::get_current_watts_value()
225 {
226   if (this->pstate_ == pstate_off_) // The host is off (or was off at the beginning of this time interval)
227     return this->watts_off_;
228
229   double current_speed = host_->get_speed();
230
231   double cpu_load;
232
233   if (current_speed <= 0)
234     // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
235     // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
236     cpu_load = 1;
237   else
238     cpu_load = host_->pimpl_cpu->get_constraint()->get_usage() / current_speed;
239
240   /** Divide by the number of cores here **/
241   cpu_load /= host_->pimpl_cpu->get_core_count();
242
243   if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
244     cpu_load = 1;
245
246   /* The problem with this model is that the load is always 0 or 1, never something less.
247    * Another possibility could be to model the total energy as
248    *
249    *   X/(X+Y)*W_idle + Y/(X+Y)*W_burn
250    *
251    * where X is the amount of idling cores, and Y the amount of computing cores.
252    */
253   return get_current_watts_value(cpu_load);
254 }
255
256 /** @brief Computes the power that the host would consume at the provided processor load
257  *
258  * Whether the host is ON or OFF is not taken into account.
259  */
260 double HostEnergy::get_current_watts_value(double cpu_load)
261 {
262   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
263              host_->get_cname());
264
265   /* Return watts_off if pstate == pstate_off (ie, if the host is off) */
266   if (this->pstate_ == pstate_off_) {
267     return watts_off_;
268   }
269
270   /* min_power corresponds to the power consumed when only one core is active */
271   /* max_power is the power consumed at 100% cpu load       */
272   auto range           = power_range_watts_list_.at(this->pstate_);
273   double current_power = 0;
274   double min_power     = 0;
275   double max_power     = 0;
276   double power_slope   = 0;
277
278   if (cpu_load > 0) { /* Something is going on, the machine is not idle */
279     min_power = range.min_;
280     max_power = range.max_;
281
282     /**
283      * The min_power states how much we consume when only one single
284      * core is working. This means that when cpu_load == 1/coreCount, then
285      * current_power == min_power.
286      *
287      * The maximum must be reached when all cores are working (but 1 core was
288      * already accounted for by min_power)
289      * i.e., we need min_power + (maxCpuLoad-1/coreCount)*power_slope == max_power
290      * (maxCpuLoad is by definition 1)
291      */
292     double power_slope;
293     int coreCount         = host_->get_core_count();
294     double coreReciprocal = static_cast<double>(1) / static_cast<double>(coreCount);
295     if (coreCount > 1)
296       power_slope = (max_power - min_power) / (1 - coreReciprocal);
297     else
298       power_slope = 0; // Should be 0, since max_power == min_power (in this case)
299
300     current_power = min_power + (cpu_load - coreReciprocal) * power_slope;
301   } else { /* Our machine is idle, take the dedicated value! */
302     current_power = range.idle_;
303   }
304
305   XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
306   XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
307
308   return current_power;
309 }
310
311 double HostEnergy::get_consumed_energy()
312 {
313   if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
314     simgrid::simix::simcall(std::bind(&HostEnergy::update, this));
315
316   return total_energy_;
317 }
318
319 void HostEnergy::init_watts_range_list()
320 {
321   const char* all_power_values_str = host_->get_property("watt_per_state");
322   if (all_power_values_str == nullptr)
323     return;
324
325   std::vector<std::string> all_power_values;
326   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
327   XBT_DEBUG("%s: profile: %s, cores: %d", host_->get_cname(), all_power_values_str, host_->get_core_count());
328
329   int i = 0;
330   for (auto const& current_power_values_str : all_power_values) {
331     /* retrieve the power values associated with the current pstate */
332     std::vector<std::string> current_power_values;
333     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
334     if (host_->get_core_count() == 1) {
335       xbt_assert(current_power_values.size() == 2 || current_power_values.size() == 3,
336                  "Power properties incorrectly defined for host %s."
337                  "It should be 'Idle:FullSpeed' power values because you have one core only.",
338                  host_->get_cname());
339       if (current_power_values.size() == 2) {
340         // In this case, 1core == AllCores
341         current_power_values.push_back(current_power_values.at(1));
342       } else { // size == 3
343         xbt_assert((current_power_values.at(1)) == (current_power_values.at(2)),
344                    "Power properties incorrectly defined for host %s.\n"
345                    "The energy profile of mono-cores should be formatted as 'Idle:FullSpeed' only.\n"
346                    "If you go for a 'Idle:OneCore:AllCores' power profile on mono-cores, then OneCore and AllCores "
347                    "must be equal.",
348                    host_->get_cname());
349       }
350     } else {
351       xbt_assert(current_power_values.size() == 3,
352                  "Power properties incorrectly defined for host %s."
353                  "It should be 'Idle:OneCore:AllCores' power values because you have more than one core.",
354                  host_->get_cname());
355     }
356
357     /* min_power corresponds to the idle power (cpu load = 0) */
358     /* max_power is the power consumed at 100% cpu load       */
359     char* msg_idle = bprintf("Invalid idle value for pstate %d on host %s: %%s", i, host_->get_cname());
360     char* msg_min  = bprintf("Invalid OneCore value for pstate %d on host %s: %%s", i, host_->get_cname());
361     char* msg_max  = bprintf("Invalid AllCores value for pstate %d on host %s: %%s", i, host_->get_cname());
362     PowerRange range(xbt_str_parse_double((current_power_values.at(0)).c_str(), msg_idle),
363                      xbt_str_parse_double((current_power_values.at(1)).c_str(), msg_min),
364                      xbt_str_parse_double((current_power_values.at(2)).c_str(), msg_max));
365     power_range_watts_list_.push_back(range);
366     xbt_free(msg_idle);
367     xbt_free(msg_min);
368     xbt_free(msg_max);
369     i++;
370   }
371 }
372 } // namespace plugin
373 } // namespace simgrid
374
375 using simgrid::plugin::HostEnergy;
376
377 /* **************************** events  callback *************************** */
378 static void on_creation(simgrid::s4u::Host& host)
379 {
380   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
381     return;
382
383   // TODO Trace: set to zero the energy variable associated to host->getName()
384
385   host.extension_set(new HostEnergy(&host));
386 }
387
388 static void on_action_state_change(simgrid::surf::CpuAction* action,
389                                    simgrid::kernel::resource::Action::State /*previous*/)
390 {
391   for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
392     simgrid::s4u::Host* host = cpu->get_host();
393     if (host != nullptr) {
394
395       // If it's a VM, take the corresponding PM
396       simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
397       if (vm) // If it's a VM, take the corresponding PM
398         host = vm->get_pm();
399
400       // Get the host_energy extension for the relevant host
401       HostEnergy* host_energy = host->extension<HostEnergy>();
402
403       if (host_energy->last_updated_ < surf_get_clock())
404         host_energy->update();
405     }
406   }
407 }
408
409 /* This callback is fired either when the host changes its state (on/off) ("onStateChange") or its speed
410  * (because the user changed the pstate, or because of external trace events) ("onSpeedChange") */
411 static void on_host_change(simgrid::s4u::Host& host)
412 {
413   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
414     return;
415
416   HostEnergy* host_energy = host.extension<HostEnergy>();
417
418   host_energy->update();
419 }
420
421 static void on_host_destruction(simgrid::s4u::Host& host)
422 {
423   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
424     return;
425
426   XBT_INFO("Energy consumption of host %s: %f Joules", host.get_cname(),
427            host.extension<HostEnergy>()->get_consumed_energy());
428 }
429
430 static void on_simulation_end()
431 {
432   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
433
434   double total_energy      = 0.0; // Total energy consumption (whole platform)
435   double used_hosts_energy = 0.0; // Energy consumed by hosts that computed something
436   for (size_t i = 0; i < hosts.size(); i++) {
437     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts[i]) == nullptr) { // Ignore virtual machines
438
439       bool host_was_used = (sg_host_get_computed_flops(hosts[i]) != 0);
440       double energy      = hosts[i]->extension<HostEnergy>()->get_consumed_energy();
441       total_energy += energy;
442       if (host_was_used)
443         used_hosts_energy += energy;
444     }
445   }
446   XBT_INFO("Total energy consumption: %f Joules (used hosts: %f Joules; unused/idle hosts: %f)", total_energy,
447            used_hosts_energy, total_energy - used_hosts_energy);
448 }
449
450 /* **************************** Public interface *************************** */
451
452 /** \ingroup plugin_energy
453  * \brief Enable host energy plugin
454  * \details Enable energy plugin to get joules consumption of each cpu. Call this function before #MSG_init().
455  */
456 void sg_host_energy_plugin_init()
457 {
458   if (HostEnergy::EXTENSION_ID.valid())
459     return;
460
461   sg_host_load_plugin_init();
462
463   HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
464
465   simgrid::s4u::Host::on_creation.connect(&on_creation);
466   simgrid::s4u::Host::on_state_change.connect(&on_host_change);
467   simgrid::s4u::Host::on_speed_change.connect(&on_host_change);
468   simgrid::s4u::Host::on_destruction.connect(&on_host_destruction);
469   simgrid::s4u::on_simulation_end.connect(&on_simulation_end);
470   simgrid::surf::CpuAction::on_state_change.connect(&on_action_state_change);
471 }
472
473 /** @ingroup plugin_energy
474  *  @brief updates the consumption of all hosts
475  *
476  * After this call, sg_host_get_consumed_energy() will not interrupt your process
477  * (until after the next clock update).
478  */
479 void sg_host_energy_update_all()
480 {
481   simgrid::simix::simcall([]() {
482     std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
483     for (auto const& host : list)
484       if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host) == nullptr) // Ignore virtual machines
485         host->extension<HostEnergy>()->update();
486   });
487 }
488
489 /** @ingroup plugin_energy
490  *  @brief Returns the total energy consumed by the host so far (in Joules)
491  *
492  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
493  *  The result is that the actor requesting this value will be interrupted,
494  *  the value will be updated in kernel mode before returning the control to the requesting actor.
495  */
496 double sg_host_get_consumed_energy(sg_host_t host)
497 {
498   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
499              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
500   return host->extension<HostEnergy>()->get_consumed_energy();
501 }
502
503 /** @ingroup plugin_energy
504  *  @brief Get the amount of watt dissipated at the given pstate when the host is idling
505  */
506 double sg_host_get_wattmin_at(sg_host_t host, int pstate)
507 {
508   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
509              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
510   return host->extension<HostEnergy>()->get_watt_min_at(pstate);
511 }
512 /** @ingroup plugin_energy
513  *  @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
514  */
515 double sg_host_get_wattmax_at(sg_host_t host, int pstate)
516 {
517   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
518              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
519   return host->extension<HostEnergy>()->get_watt_max_at(pstate);
520 }
521
522 /** @ingroup plugin_energy
523  *  @brief Returns the current consumption of the host
524  */
525 double sg_host_get_current_consumption(sg_host_t host)
526 {
527   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
528              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
529   return host->extension<HostEnergy>()->get_current_watts_value();
530 }