Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Remove commented out code.
[simgrid.git] / src / plugins / host_energy.cpp
1 /* Copyright (c) 2010-2019. 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/s4u/Engine.hpp"
8 #include "simgrid/s4u/Exec.hpp"
9 #include "src/include/surf/surf.hpp"
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "src/plugins/vm/VirtualMachineImpl.hpp"
12 #include "src/surf/cpu_interface.hpp"
13
14 #include <boost/algorithm/string/classification.hpp>
15 #include <boost/algorithm/string/split.hpp>
16
17 SIMGRID_REGISTER_PLUGIN(host_energy, "Cpu energy consumption.", &sg_host_energy_plugin_init)
18
19 /** @defgroup plugin_host_energy
20
21   @rst
22 This is the energy plugin, enabling to account not only for computation time, but also for the dissipated energy in the
23 simulated platform.
24 To activate this plugin, first call :cpp:func:`sg_host_energy_plugin_init()` before your :cpp:func:`MSG_init()`, and then use
25 :cpp:func:`MSG_host_get_consumed_energy()` to retrieve the consumption of a given host.
26
27 When the host is on, this energy consumption naturally depends on both the current CPU load and the host energy profile.
28 According to our measurements, the consumption is somehow linear in the amount of cores at full speed, with an
29 abnormality when all the cores are idle. The full details are in `our scientific paper <https://hal.inria.fr/hal-01523608>`_
30 on that topic.
31
32 As a result, our energy model takes 4 parameters:
33
34   - ``Idle`` wattage (i.e., instantaneous consumption in Watt) when your host is up and running, but without anything to do.
35   - ``Epsilon`` wattage when all cores are at 0 or epsilon%, but not in Idle state.
36   - ``AllCores`` wattage when all cores of the host are at 100%.
37   - ``Off`` wattage when the host is turned off.
38
39 Here is an example of XML declaration:
40
41 .. code-block:: xml
42
43    <host id="HostA" speed="100.0Mf" core="4">
44        <prop id="wattage_per_state" value="100.0:120.0:200.0" />
45        <prop id="wattage_off" value="10" />
46    </host>
47
48 If only two values are given, ``Idle`` is used for the missing ``Epsilon`` value.
49
50 This example gives the following parameters: ``Off`` is 10 Watts; ``Idle`` is 100 Watts; ``Epsilon`` is 120 Watts and
51 ``AllCores`` is 200 Watts.
52 This is enough to compute the wattage as a function of the amount of loaded cores:
53
54 .. raw:: html
55
56    <table border="1">
57    <tr><th>#Cores loaded</th><th>Wattage</th><th>Explanation</th></tr>
58    <tr><td>0 (idle)</td><td> 100 Watts&nbsp;</td><td> Idle value</td></tr>
59    <tr><td>0 (not idle)</td><td> 120 Watts</td><td> Epsilon value</td></tr>
60    <tr><td>1</td><td> 140 Watts</td><td> Linear extrapolation between Epsilon and AllCores</td></tr>
61    <tr><td>2</td><td> 160 Watts</td><td> Linear extrapolation between Epsilon and AllCores</td></tr>
62    <tr><td>3</td><td> 180 Watts</td><td> Linear extrapolation between Epsilon and AllCores</td></tr>
63    <tr><td>4</td><td> 200 Watts</td><td> AllCores value</td></tr>
64    </table>
65
66
67 .. raw:: html
68
69    <h4>How does DVFS interact with the host energy model?</h4>
70
71 If your host has several DVFS levels (several pstates), then you should give the energetic profile of each pstate level:
72
73 .. code-block:: xml
74
75    <host id="HostC" speed="100.0Mf,50.0Mf,20.0Mf" core="4">
76        <prop id="wattage_per_state"
77              value="95.0:120.0:200.0, 93.0:115.0:170.0, 90.0:110.0:150.0" />
78        <prop id="wattage_off" value="10" />
79    </host>
80
81 This encodes the following values:
82
83 .. raw:: html
84
85    <table border="1">
86    <tr><th>pstate</th><th>Performance</th><th>Idle</th><th>Epsilon</th><th>AllCores</th></tr>
87    <tr><td>0</td><td>100 Mflop/s</td><td>95 Watts</td><td>120 Watts</td><td>200 Watts</td></tr>
88    <tr><td>1</td><td>50 Mflop/s</td><td>93 Watts</td><td>115 Watts</td><td>170 Watts</td></tr>
89    <tr><td>2</td><td>20 Mflop/s</td><td>90 Watts</td><td>110 Watts</td><td>150 Watts</td></tr>
90    </table>
91
92 To change the pstate of a given CPU, use the following functions:
93 :cpp:func:`MSG_host_get_nb_pstates()`, :cpp:func:`simgrid::s4u::Host::set_pstate()`, :cpp:func:`MSG_host_get_power_peak_at()`.
94
95 .. raw:: html
96
97    <h4>How accurate are these models?</h4>
98
99 This model cannot be more accurate than your instantiation: with the default values, your result will not be accurate at
100 all. You can still get accurate energy prediction, provided that you carefully instantiate the model.
101 The first step is to ensure that your timing prediction match perfectly. But this is only the first step of the path,
102 and you really want to read `this paper <https://hal.inria.fr/hal-01523608>`_ to see all what you need to do
103 before you can get accurate energy predictions.
104
105   @endrst
106  */
107
108 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
109
110 // Forwards declaration needed to make this function a friend (because friends have external linkage by default)
111 static void on_simulation_end();
112
113 namespace simgrid {
114 namespace plugin {
115
116 class PowerRange {
117 public:
118   double idle_;
119   double epsilon_;
120   double max_;
121   double slope_;
122
123   PowerRange(double idle, double epsilon, double max) : idle_(idle), epsilon_(epsilon), max_(max), slope_(max-epsilon) {}
124 };
125
126 class HostEnergy {
127   friend void ::on_simulation_end(); // For access to host_was_used_
128 public:
129   static simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> EXTENSION_ID;
130
131   explicit HostEnergy(simgrid::s4u::Host* ptr);
132   ~HostEnergy();
133
134   double get_current_watts_value();
135   double get_current_watts_value(double cpu_load);
136   double get_consumed_energy();
137   double get_watt_idle_at(int pstate);
138   double get_watt_min_at(int pstate);
139   double get_watt_max_at(int pstate);
140   double get_power_range_slope_at(int pstate);
141   void update();
142
143 private:
144   void init_watts_range_list();
145   simgrid::s4u::Host* host_ = nullptr;
146   /*< List of (idle_power, epsilon_power, max_power) tuple corresponding to each cpu pstate */
147   std::vector<PowerRange> power_range_watts_list_;
148
149   /* We need to keep track of what pstate has been used, as we will sometimes be notified only *after* a pstate has been
150    * used (but we need to update the energy consumption with the old pstate!)
151    */
152   int pstate_           = 0;
153   const int pstate_off_ = -1;
154
155   /* Only used to split total energy into unused/used hosts.
156    * If you want to get this info for something else, rather use the host_load plugin
157    */
158   bool host_was_used_  = false;
159 public:
160   double watts_off_    = 0.0; /*< Consumption when the machine is turned off (shutdown) */
161   double total_energy_ = 0.0; /*< Total energy consumed by the host */
162   double last_updated_;       /*< Timestamp of the last energy update event*/
163 };
164
165 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
166
167 /* Computes the consumption so far. Called lazily on need. */
168 void HostEnergy::update()
169 {
170   double start_time  = this->last_updated_;
171   double finish_time = surf_get_clock();
172   //
173   // We may have start == finish if the past consumption was updated since the simcall was started
174   // for example if 2 actors requested to update the same host's consumption in a given scheduling round.
175   //
176   // Even in this case, we need to save the pstate for the next call (after this if),
177   // which may have changed since that recent update.
178   if (start_time < finish_time) {
179     double previous_energy = this->total_energy_;
180
181     double instantaneous_power_consumption = this->get_current_watts_value();
182
183     double energy_this_step = instantaneous_power_consumption * (finish_time - start_time);
184
185     // TODO Trace: Trace energy_this_step from start_time to finish_time in host->getName()
186
187     this->total_energy_ = previous_energy + energy_this_step;
188     this->last_updated_ = finish_time;
189
190     XBT_DEBUG("[update_energy of %s] period=[%.8f-%.8f]; current speed=%.2E flop/s (pstate %i); total consumption before: %.8f J -> added now: %.8f J",
191               host_->get_cname(), start_time, finish_time, host_->pimpl_cpu->get_pstate_peak_speed(this->pstate_), this->pstate_, previous_energy,
192               energy_this_step);
193   }
194
195   /* Save data for the upcoming time interval: whether it's on/off and the pstate if it's on */
196   this->pstate_ = host_->is_on() ? host_->get_pstate() : pstate_off_;
197 }
198
199 HostEnergy::HostEnergy(simgrid::s4u::Host* ptr) : host_(ptr), last_updated_(surf_get_clock())
200 {
201   init_watts_range_list();
202
203   const char* off_power_str = host_->get_property("wattage_off");
204   if (off_power_str == nullptr) {
205     off_power_str = host_->get_property("watt_off");
206
207     static bool warned = false;
208     if (off_power_str != nullptr && not warned) {
209       warned = true;
210       XBT_WARN("Please use 'wattage_off' instead of 'watt_off' to define the idle wattage of hosts in your XML.");
211     }
212   }
213   if (off_power_str != nullptr) {
214     try {
215       this->watts_off_ = std::stod(std::string(off_power_str));
216     } catch (const std::invalid_argument&) {
217       throw std::invalid_argument(std::string("Invalid value for property wattage_off of host ") + host_->get_cname() +
218                                   ": " + off_power_str);
219     }
220   }
221   /* watts_off is 0 by default */
222 }
223
224 HostEnergy::~HostEnergy() = default;
225
226 double HostEnergy::get_watt_idle_at(int pstate)
227 {
228   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
229              host_->get_cname());
230   return power_range_watts_list_[pstate].idle_;
231 }
232
233 double HostEnergy::get_watt_min_at(int pstate)
234 {
235   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
236              host_->get_cname());
237   return power_range_watts_list_[pstate].epsilon_;
238 }
239
240 double HostEnergy::get_watt_max_at(int pstate)
241 {
242   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
243              host_->get_cname());
244   return power_range_watts_list_[pstate].max_;
245 }
246
247 double HostEnergy::get_power_range_slope_at(int pstate)
248 {
249   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
250              host_->get_cname());
251   return power_range_watts_list_[pstate].slope_;
252 }
253
254 /** @brief Computes the power consumed by the host according to the current situation
255  *
256  * - If the host is off, that's the watts_off value
257  * - if it's on, take the current pstate and the current processor load into account */
258 double HostEnergy::get_current_watts_value()
259 {
260   if (this->pstate_ == pstate_off_) // The host is off (or was off at the beginning of this time interval)
261     return this->watts_off_;
262
263   double current_speed = host_->get_pstate_speed(this->pstate_);
264
265   double cpu_load;
266
267   if (current_speed <= 0)
268     // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
269     // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
270     cpu_load = 1;
271   else {
272     cpu_load = host_->pimpl_cpu->get_constraint()->get_usage() / current_speed;
273
274     /* Divide by the number of cores here to have a value between 0 and 1 */
275     cpu_load /= host_->pimpl_cpu->get_core_count();
276
277     if (cpu_load > 1) // This condition is true for energy_ptask on 32 bits, even if cpu_load is displayed as 1.000000
278       cpu_load = 1;   // That may be an harmless rounding error?
279     if (cpu_load > 0)
280       host_was_used_ = true;
281   }
282
283   return get_current_watts_value(cpu_load);
284 }
285
286 /** @brief Computes the power that the host would consume at the provided processor load
287  *
288  * Whether the host is ON or OFF is not taken into account.
289  */
290 double HostEnergy::get_current_watts_value(double cpu_load)
291 {
292   xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
293              host_->get_cname());
294
295   /* Return watts_off if pstate == pstate_off (ie, if the host is off) */
296   if (this->pstate_ == pstate_off_) {
297     return watts_off_;
298   }
299
300   PowerRange power_range = power_range_watts_list_.at(this->pstate_);
301   double current_power;
302
303   if (cpu_load > 0)
304   {
305       /**
306        * Something is going on, the host is not idle.
307        *
308        * The power consumption follows the regular model:
309        * P(cpu_load) = Pstatic + Pdynamic * cpu_load
310        * where Pstatic = power_range.epsilon_ and Pdynamic = power_range.slope_
311        * and the cpu_load is a value between 0 and 1.
312        */
313       current_power = power_range.epsilon_ + cpu_load * power_range.slope_;
314   }
315   else
316   {
317       /* The host is idle, take the dedicated value! */
318       current_power = power_range.idle_;
319   }
320
321   XBT_DEBUG("[get_current_watts] pstate=%i, epsilon_power=%f, max_power=%f, slope=%f", this->pstate_, power_range.epsilon_,
322             power_range.max_, power_range.slope_);
323   XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
324
325   return current_power;
326 }
327
328 double HostEnergy::get_consumed_energy()
329 {
330   if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
331     simgrid::kernel::actor::simcall(std::bind(&HostEnergy::update, this));
332
333   return total_energy_;
334 }
335
336 void HostEnergy::init_watts_range_list()
337 {
338   const char* old_prop = host_->get_property("watt_per_state");
339   if (old_prop != nullptr) {
340     std::vector<std::string> all_power_values;
341     boost::split(all_power_values, old_prop, boost::is_any_of(","));
342
343     xbt_assert(all_power_values.size() == (unsigned)host_->get_pstate_count(),
344                "Invalid XML file. Found %zu energetic profiles for %d pstates", all_power_values.size(),
345                host_->get_pstate_count());
346
347     // XBT_ATTRIB_DEPRECATED_v328: putting this macro name here so that we find it during the deprecation cleanups
348     std::string msg = std::string("DEPRECATION WARNING: Property 'watt_per_state' will only work until v3.28.\n");
349     msg += std::string("The old syntax 'Idle:OneCore:AllCores' must be converted into 'Idle:Epsilon:AllCores' to "
350                        "properly model the consumption of non-whole tasks on mono-core hosts. Here are the values to "
351                        "use for host '") +
352            host_->get_cname() + "' in your XML file:\n";
353     msg += "     <prop id=\"wattage_per_state\" value=\"";
354     for (auto const& current_power_values_str : all_power_values) {
355       std::vector<std::string> current_power_values;
356       boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
357       double p_idle = xbt_str_parse_double((current_power_values.at(0)).c_str(),
358                                            "Invalid obsolete XML file. Fix your watt_per_state property.");
359       double p_full;
360       double p_epsilon;
361
362       if (current_power_values.size() == 3) {
363         double p_one_core = xbt_str_parse_double((current_power_values.at(1)).c_str(),
364                                                  "Invalid obsolete XML file. Fix your watt_per_state property.");
365         p_full     = xbt_str_parse_double((current_power_values.at(2)).c_str(),
366                                       "Invalid obsolete XML file. Fix your watt_per_state property.");
367         if (host_->get_core_count() == 1) {
368           p_epsilon = p_full;
369         } else {
370           p_epsilon = p_one_core - ((p_full - p_one_core) / (host_->get_core_count() - 1));
371         }
372       } else { // consuption given with idle and full only
373         p_full = xbt_str_parse_double((current_power_values.at(1)).c_str(),
374                                       "Invalid obsolete XML file. Fix your watt_per_state property.");
375         if (host_->get_core_count() == 1) {
376           p_epsilon = p_full;
377         } else {
378           p_epsilon = p_idle;
379         }
380       }
381
382       PowerRange range(p_idle, p_epsilon, p_full);
383       power_range_watts_list_.push_back(range);
384
385       msg += std::to_string(p_idle) + ":" + std::to_string(p_epsilon) + ":" + std::to_string(p_full);
386       msg += ",";
387     }
388     msg.pop_back(); // Remove the extraneous ','
389     msg += "\" />";
390     XBT_WARN("%s", msg.c_str());
391     return;
392   }
393
394   const char* all_power_values_str = host_->get_property("wattage_per_state");
395   if (all_power_values_str == nullptr) {
396     /* If no power values are given, we assume it's 0 everywhere */
397     XBT_DEBUG("No energetic profiles given for host %s, using 0 W by default.", host_->get_cname());
398     for (int i = 0; i < host_->get_pstate_count(); ++i) {
399         PowerRange range(0,0,0);
400         power_range_watts_list_.push_back(range);
401     }
402     return;
403   }
404
405   std::vector<std::string> all_power_values;
406   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
407   XBT_DEBUG("%s: power properties: %s", host_->get_cname(), all_power_values_str);
408
409   xbt_assert(all_power_values.size() == (unsigned)host_->get_pstate_count(),
410              "Invalid XML file. Found %zu energetic profiles for %d pstates", all_power_values.size(),
411              host_->get_pstate_count());
412
413   int i = 0;
414   for (auto const& current_power_values_str : all_power_values) {
415     /* retrieve the power values associated with the pstate i */
416     std::vector<std::string> current_power_values;
417     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
418
419     xbt_assert(current_power_values.size() == 2 || current_power_values.size() == 3,
420                "Power properties incorrectly defined for host %s."
421                "It should be 'Idle:AllCores' (or 'Idle:Epsilon:AllCores') power values.",
422                host_->get_cname());
423
424     double idle_power;
425     double epsilon_power;
426     double max_power;
427
428     char* msg_idle    = bprintf("Invalid Idle value for pstate %d on host %s: %%s", i, host_->get_cname());
429     char* msg_epsilon = bprintf("Invalid Epsilon value for pstate %d on host %s: %%s", i, host_->get_cname());
430     char* msg_max     = bprintf("Invalid AllCores value for pstate %d on host %s: %%s", i, host_->get_cname());
431
432     idle_power = xbt_str_parse_double((current_power_values.at(0)).c_str(), msg_idle);
433     if (current_power_values.size() == 2) { // Case: Idle:AllCores
434       epsilon_power = xbt_str_parse_double((current_power_values.at(0)).c_str(), msg_idle);
435       max_power     = xbt_str_parse_double((current_power_values.at(1)).c_str(), msg_max);
436     } else { // Case: Idle:Epsilon:AllCores
437       epsilon_power = xbt_str_parse_double((current_power_values.at(1)).c_str(), msg_epsilon);
438       max_power     = xbt_str_parse_double((current_power_values.at(2)).c_str(), msg_max);
439     }
440
441     XBT_DEBUG("Creating PowerRange for host %s. Idle:%f, Epsilon:%f, AllCores:%f.", host_->get_cname(), idle_power, epsilon_power, max_power);
442
443     PowerRange range(idle_power, epsilon_power, max_power);
444     power_range_watts_list_.push_back(range);
445     xbt_free(msg_idle);
446     xbt_free(msg_epsilon);
447     xbt_free(msg_max);
448     ++i;
449   }
450 }
451 } // namespace plugin
452 } // namespace simgrid
453
454 using simgrid::plugin::HostEnergy;
455
456 /* **************************** events  callback *************************** */
457 static void on_creation(simgrid::s4u::Host& host)
458 {
459   if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
460     return;
461
462   // TODO Trace: set to zero the energy variable associated to host->getName()
463
464   host.extension_set(new HostEnergy(&host));
465 }
466
467 static void on_action_state_change(simgrid::kernel::resource::CpuAction const& action,
468                                    simgrid::kernel::resource::Action::State /*previous*/)
469 {
470   for (simgrid::kernel::resource::Cpu* const& cpu : action.cpus()) {
471     simgrid::s4u::Host* host = cpu->get_host();
472     if (host != nullptr) {
473
474       // If it's a VM, take the corresponding PM
475       simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
476       if (vm) // If it's a VM, take the corresponding PM
477         host = vm->get_pm();
478
479       // Get the host_energy extension for the relevant host
480       HostEnergy* host_energy = host->extension<HostEnergy>();
481
482       if (host_energy->last_updated_ < surf_get_clock())
483         host_energy->update();
484     }
485   }
486 }
487
488 /* This callback is fired either when the host changes its state (on/off) ("onStateChange") or its speed
489  * (because the user changed the pstate, or because of external trace events) ("onSpeedChange") */
490 static void on_host_change(simgrid::s4u::Host const& host)
491 {
492   if (dynamic_cast<simgrid::s4u::VirtualMachine const*>(&host)) // Ignore virtual machines
493     return;
494
495   HostEnergy* host_energy = host.extension<HostEnergy>();
496
497   host_energy->update();
498 }
499
500 static void on_host_destruction(simgrid::s4u::Host const& host)
501 {
502   if (dynamic_cast<simgrid::s4u::VirtualMachine const*>(&host)) // Ignore virtual machines
503     return;
504
505   XBT_INFO("Energy consumption of host %s: %f Joules", host.get_cname(),
506            host.extension<HostEnergy>()->get_consumed_energy());
507 }
508
509 static void on_simulation_end()
510 {
511   std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
512
513   double total_energy      = 0.0; // Total energy consumption (whole platform)
514   double used_hosts_energy = 0.0; // Energy consumed by hosts that computed something
515   for (size_t i = 0; i < hosts.size(); i++) {
516     if (dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts[i]) == nullptr) { // Ignore virtual machines
517
518       double energy      = hosts[i]->extension<HostEnergy>()->get_consumed_energy();
519       total_energy += energy;
520       if (hosts[i]->extension<HostEnergy>()->host_was_used_)
521         used_hosts_energy += energy;
522     }
523   }
524   XBT_INFO("Total energy consumption: %f Joules (used hosts: %f Joules; unused/idle hosts: %f)", total_energy,
525            used_hosts_energy, total_energy - used_hosts_energy);
526 }
527
528 /* **************************** Public interface *************************** */
529
530 /** @ingroup plugin_host_energy
531  * @brief Enable host energy plugin
532  * @details Enable energy plugin to get joules consumption of each cpu. Call this function before #MSG_init().
533  */
534 void sg_host_energy_plugin_init()
535 {
536   if (HostEnergy::EXTENSION_ID.valid())
537     return;
538
539   HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
540
541   simgrid::s4u::Host::on_creation.connect(&on_creation);
542   simgrid::s4u::Host::on_state_change.connect(&on_host_change);
543   simgrid::s4u::Host::on_speed_change.connect(&on_host_change);
544   simgrid::s4u::Host::on_destruction.connect(&on_host_destruction);
545   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
546   simgrid::kernel::resource::CpuAction::on_state_change.connect(&on_action_state_change);
547   // We may only have one actor on a node. If that actor executes something like
548   //   compute -> recv -> compute
549   // the recv operation will not trigger a "CpuAction::on_state_change". This means
550   // that the next trigger would be the 2nd compute, hence ignoring the idle time
551   // during the recv call. By updating at the beginning of a compute, we can
552   // fix that. (If the cpu is not idle, this is not required.)
553   simgrid::s4u::Exec::on_start.connect([](simgrid::s4u::Actor const&, simgrid::s4u::Exec const& activity) {
554     if (activity.get_host_number() == 1) { // We only run on one host
555       simgrid::s4u::Host* host         = activity.get_host();
556       simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
557       if (vm != nullptr)
558         host = vm->get_pm();
559       xbt_assert(host != nullptr);
560       host->extension<HostEnergy>()->update();
561     }
562   });
563 }
564
565 /** @ingroup plugin_host_energy
566  *  @brief updates the consumption of all hosts
567  *
568  * After this call, sg_host_get_consumed_energy() will not interrupt your process
569  * (until after the next clock update).
570  */
571 void sg_host_energy_update_all()
572 {
573   simgrid::kernel::actor::simcall([]() {
574     std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
575     for (auto const& host : list)
576       if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host) == nullptr) { // Ignore virtual machines
577         xbt_assert(host != nullptr);
578         host->extension<HostEnergy>()->update();
579       }
580   });
581 }
582
583 /** @ingroup plugin_host_energy
584  *  @brief Returns the total energy consumed by the host so far (in Joules)
585  *
586  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
587  *  The result is that the actor requesting this value will be interrupted,
588  *  the value will be updated in kernel mode before returning the control to the requesting actor.
589  */
590 double sg_host_get_consumed_energy(sg_host_t host)
591 {
592   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
593              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
594   return host->extension<HostEnergy>()->get_consumed_energy();
595 }
596
597 /** @ingroup plugin_host_energy
598  *  @brief Get the amount of watt dissipated when the host is idling
599  */
600 double sg_host_get_idle_consumption(sg_host_t host)
601 {
602   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
603              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
604   return host->extension<HostEnergy>()->get_watt_idle_at(0);
605 }
606
607 /** @ingroup plugin_host_energy
608  *  @brief Get the amount of watt dissipated at the given pstate when the host is idling
609  */
610 double sg_host_get_idle_consumption_at(sg_host_t host, int pstate)
611 {
612   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
613              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
614   return host->extension<HostEnergy>()->get_watt_idle_at(pstate);
615 }
616
617 /** @ingroup plugin_host_energy
618  *  @brief Get the amount of watt dissipated at the given pstate when the host is at 0 or epsilon% CPU usage.
619  */
620 double sg_host_get_wattmin_at(sg_host_t host, int pstate)
621 {
622   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
623              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
624   return host->extension<HostEnergy>()->get_watt_min_at(pstate);
625 }
626 /** @ingroup plugin_host_energy
627  *  @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
628  */
629 double sg_host_get_wattmax_at(sg_host_t host, int pstate)
630 {
631   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
632              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
633   return host->extension<HostEnergy>()->get_watt_max_at(pstate);
634 }
635 /** @ingroup plugin_host_energy
636  *  @brief  Returns the power slope at the given pstate
637  */
638 double sg_host_get_power_range_slope_at(sg_host_t host, int pstate)
639 {
640   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
641              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
642   return host->extension<HostEnergy>()->get_power_range_slope_at(pstate);
643 }
644 /** @ingroup plugin_host_energy
645  *  @brief Returns the current consumption of the host
646  */
647 double sg_host_get_current_consumption(sg_host_t host)
648 {
649   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
650              "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
651   return host->extension<HostEnergy>()->get_current_watts_value();
652 }