1 /* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved. */
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. */
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"
14 #include <boost/algorithm/string/classification.hpp>
15 #include <boost/algorithm/string/split.hpp>
17 SIMGRID_REGISTER_PLUGIN(host_energy, "Cpu energy consumption.", &sg_host_energy_plugin_init)
19 /** @defgroup plugin_host_energy
22 This is the energy plugin, enabling to account not only for computation time, but also for the dissipated energy in the
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.
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>`_
32 As a result, our energy model takes 4 parameters:
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.
39 Here is an example of XML declaration:
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" />
48 If only two values are given, ``Idle`` is used for the missing ``Epsilon`` value.
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:
57 <tr><th>#Cores loaded</th><th>Wattage</th><th>Explanation</th></tr>
58 <tr><td>0 (idle)</td><td> 100 Watts </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>
69 <h4>How does DVFS interact with the host energy model?</h4>
71 If your host has several DVFS levels (several pstates), then you should give the energetic profile of each pstate level:
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" />
81 This encodes the following values:
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>
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()`.
97 <h4>How accurate are these models?</h4>
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.
108 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
110 // Forwards declaration needed to make this function a friend (because friends have external linkage by default)
111 static void on_simulation_end();
123 PowerRange(double idle, double epsilon, double max) : idle_(idle), epsilon_(epsilon), max_(max), slope_(max-epsilon) {}
127 friend void ::on_simulation_end(); // For access to host_was_used_
129 static simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> EXTENSION_ID;
131 explicit HostEnergy(simgrid::s4u::Host* ptr);
134 double get_current_watts_value();
135 double get_current_watts_value(double cpu_load);
136 double get_consumed_energy();
137 double get_idle_consumption();
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);
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_;
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!)
153 const int pstate_off_ = -1;
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
158 bool host_was_used_ = false;
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*/
165 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
167 /* Computes the consumption so far. Called lazily on need. */
168 void HostEnergy::update()
170 double start_time = this->last_updated_;
171 double finish_time = surf_get_clock();
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.
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_;
181 double instantaneous_power_consumption = this->get_current_watts_value();
183 double energy_this_step = instantaneous_power_consumption * (finish_time - start_time);
185 // TODO Trace: Trace energy_this_step from start_time to finish_time in host->getName()
187 this->total_energy_ = previous_energy + energy_this_step;
188 this->last_updated_ = finish_time;
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,
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_;
199 HostEnergy::HostEnergy(simgrid::s4u::Host* ptr) : host_(ptr), last_updated_(surf_get_clock())
201 init_watts_range_list();
202 static bool warned = false;
204 const char* off_power_str = host_->get_property("wattage_off");
205 if (off_power_str == nullptr) {
206 off_power_str = host_->get_property("watt_off");
207 if (off_power_str != nullptr && not warned) {
209 XBT_WARN("Please use 'wattage_off' instead of 'watt_off' to define the idle wattage of hosts in your XML.");
212 if (off_power_str != nullptr) {
214 this->watts_off_ = std::stod(std::string(off_power_str));
215 } catch (const std::invalid_argument&) {
216 throw std::invalid_argument(std::string("Invalid value for property wattage_off of host ") + host_->get_cname() +
217 ": " + off_power_str);
220 /* watts_off is 0 by default */
223 HostEnergy::~HostEnergy() = default;
225 double HostEnergy::get_idle_consumption()
227 xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
230 return power_range_watts_list_[0].idle_;
233 double HostEnergy::get_watt_min_at(int pstate)
235 xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
237 return power_range_watts_list_[pstate].epsilon_;
240 double HostEnergy::get_watt_max_at(int pstate)
242 xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
244 return power_range_watts_list_[pstate].max_;
247 double HostEnergy::get_power_range_slope_at(int pstate)
249 xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
251 return power_range_watts_list_[pstate].slope_;
254 /** @brief Computes the power consumed by the host according to the current situation
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()
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_;
263 double current_speed = host_->get_pstate_speed(this->pstate_);
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
272 cpu_load = host_->pimpl_cpu->get_constraint()->get_usage() / current_speed;
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();
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?
280 host_was_used_ = true;
283 return get_current_watts_value(cpu_load);
286 /** @brief Computes the power that the host would consume at the provided processor load
288 * Whether the host is ON or OFF is not taken into account.
290 double HostEnergy::get_current_watts_value(double cpu_load)
292 xbt_assert(not power_range_watts_list_.empty(), "No power range properties specified for host %s",
295 /* Return watts_off if pstate == pstate_off (ie, if the host is off) */
296 if (this->pstate_ == pstate_off_) {
300 PowerRange power_range = power_range_watts_list_.at(this->pstate_);
301 double current_power;
306 * Something is going on, the host is not idle.
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.
313 current_power = power_range.epsilon_ + cpu_load * power_range.slope_;
317 /* The host is idle, take the dedicated value! */
318 current_power = power_range.idle_;
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);
325 return current_power;
328 double HostEnergy::get_consumed_energy()
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));
333 return total_energy_;
336 void HostEnergy::init_watts_range_list()
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(","));
343 std::string msg = std::string("DEPRECATION WARNING: Property 'watt_per_state' will not work after v3.28.\n");
344 msg += std::string("The old syntax 'Idle:OneCore:AllCores' must be converted into 'Idle:Epsilon:AllCores' to "
345 "properly model the consumption of non-whole tasks on mono-core hosts. Here are the values to "
347 host_->get_cname() + "' in your XML file:\n";
348 msg += " <prop id=\"wattage_per_state\" value=\"";
349 for (auto const& current_power_values_str : all_power_values) {
350 std::vector<std::string> current_power_values;
351 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
352 double p_idle = xbt_str_parse_double((current_power_values.at(0)).c_str(),
353 "Invalid obsolete XML file. Fix your watt_per_state property.");
358 if (current_power_values.size() == 3) {
359 p_one_core = xbt_str_parse_double((current_power_values.at(1)).c_str(),
360 "Invalid obsolete XML file. Fix your watt_per_state property.");
361 p_full = xbt_str_parse_double((current_power_values.at(2)).c_str(),
362 "Invalid obsolete XML file. Fix your watt_per_state property.");
363 if (host_->get_core_count() == 1) {
366 p_epsilon = p_one_core - ((p_full - p_one_core) / (host_->get_core_count() - 1));
368 } else { // consuption given with idle and full only
369 p_full = xbt_str_parse_double((current_power_values.at(1)).c_str(),
370 "Invalid obsolete XML file. Fix your watt_per_state property.");
371 if (host_->get_core_count() == 1) {
378 PowerRange range(p_idle, p_epsilon, p_full);
379 power_range_watts_list_.push_back(range);
381 msg += std::to_string(p_idle) + ":" + std::to_string(p_epsilon) + ":" + std::to_string(p_full);
384 msg.pop_back(); // Remove the extraneous ','
386 XBT_WARN("%s", msg.c_str());
389 const char* all_power_values_str = host_->get_property("wattage_per_state");
390 if (all_power_values_str == nullptr)
393 std::vector<std::string> all_power_values;
394 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
395 XBT_DEBUG("%s: power properties: %s", host_->get_cname(), all_power_values_str);
398 for (auto const& current_power_values_str : all_power_values) {
399 /* retrieve the power values associated with the pstate i */
400 std::vector<std::string> current_power_values;
401 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
403 xbt_assert(current_power_values.size() == 2 || current_power_values.size() == 3,
404 "Power properties incorrectly defined for host %s."
405 "It should be 'Idle:AllCores' (or 'Idle:Epsilon:AllCores') power values.",
409 double epsilon_power;
412 char* msg_idle = bprintf("Invalid Idle value for pstate %d on host %s: %%s", i, host_->get_cname());
413 char* msg_epsilon = bprintf("Invalid Epsilon value for pstate %d on host %s: %%s", i, host_->get_cname());
414 char* msg_max = bprintf("Invalid AllCores value for pstate %d on host %s: %%s", i, host_->get_cname());
416 idle_power = xbt_str_parse_double((current_power_values.at(0)).c_str(), msg_idle);
417 if (current_power_values.size() == 2) { // Case: Idle:AllCores
418 epsilon_power = xbt_str_parse_double((current_power_values.at(0)).c_str(), msg_idle);
419 max_power = xbt_str_parse_double((current_power_values.at(1)).c_str(), msg_max);
420 } else { // Case: Idle:Epsilon:AllCores
421 epsilon_power = xbt_str_parse_double((current_power_values.at(1)).c_str(), msg_epsilon);
422 max_power = xbt_str_parse_double((current_power_values.at(2)).c_str(), msg_max);
425 XBT_DEBUG("Creating PowerRange for host %s. Idle:%f, Epsilon:%f, AllCores:%f.", host_->get_cname(), idle_power, epsilon_power, max_power);
427 PowerRange range(idle_power, epsilon_power, max_power);
428 power_range_watts_list_.push_back(range);
430 xbt_free(msg_epsilon);
435 } // namespace plugin
436 } // namespace simgrid
438 using simgrid::plugin::HostEnergy;
440 /* **************************** events callback *************************** */
441 static void on_creation(simgrid::s4u::Host& host)
443 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
446 // TODO Trace: set to zero the energy variable associated to host->getName()
448 host.extension_set(new HostEnergy(&host));
451 static void on_action_state_change(simgrid::kernel::resource::CpuAction const& action,
452 simgrid::kernel::resource::Action::State /*previous*/)
454 for (simgrid::kernel::resource::Cpu* const& cpu : action.cpus()) {
455 simgrid::s4u::Host* host = cpu->get_host();
456 if (host != nullptr) {
458 // If it's a VM, take the corresponding PM
459 simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
460 if (vm) // If it's a VM, take the corresponding PM
463 // Get the host_energy extension for the relevant host
464 HostEnergy* host_energy = host->extension<HostEnergy>();
466 if (host_energy->last_updated_ < surf_get_clock())
467 host_energy->update();
472 /* This callback is fired either when the host changes its state (on/off) ("onStateChange") or its speed
473 * (because the user changed the pstate, or because of external trace events) ("onSpeedChange") */
474 static void on_host_change(simgrid::s4u::Host const& host)
476 if (dynamic_cast<simgrid::s4u::VirtualMachine const*>(&host)) // Ignore virtual machines
479 HostEnergy* host_energy = host.extension<HostEnergy>();
481 host_energy->update();
484 static void on_host_destruction(simgrid::s4u::Host const& host)
486 if (dynamic_cast<simgrid::s4u::VirtualMachine const*>(&host)) // Ignore virtual machines
489 XBT_INFO("Energy consumption of host %s: %f Joules", host.get_cname(),
490 host.extension<HostEnergy>()->get_consumed_energy());
493 static void on_simulation_end()
495 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
497 double total_energy = 0.0; // Total energy consumption (whole platform)
498 double used_hosts_energy = 0.0; // Energy consumed by hosts that computed something
499 for (size_t i = 0; i < hosts.size(); i++) {
500 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts[i]) == nullptr) { // Ignore virtual machines
502 double energy = hosts[i]->extension<HostEnergy>()->get_consumed_energy();
503 total_energy += energy;
504 if (hosts[i]->extension<HostEnergy>()->host_was_used_)
505 used_hosts_energy += energy;
508 XBT_INFO("Total energy consumption: %f Joules (used hosts: %f Joules; unused/idle hosts: %f)", total_energy,
509 used_hosts_energy, total_energy - used_hosts_energy);
512 /* **************************** Public interface *************************** */
514 /** @ingroup plugin_host_energy
515 * @brief Enable host energy plugin
516 * @details Enable energy plugin to get joules consumption of each cpu. Call this function before #MSG_init().
518 void sg_host_energy_plugin_init()
520 if (HostEnergy::EXTENSION_ID.valid())
523 HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
525 simgrid::s4u::Host::on_creation.connect(&on_creation);
526 simgrid::s4u::Host::on_state_change.connect(&on_host_change);
527 simgrid::s4u::Host::on_speed_change.connect(&on_host_change);
528 simgrid::s4u::Host::on_destruction.connect(&on_host_destruction);
529 simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
530 simgrid::kernel::resource::CpuAction::on_state_change.connect(&on_action_state_change);
531 // We may only have one actor on a node. If that actor executes something like
532 // compute -> recv -> compute
533 // the recv operation will not trigger a "CpuAction::on_state_change". This means
534 // that the next trigger would be the 2nd compute, hence ignoring the idle time
535 // during the recv call. By updating at the beginning of a compute, we can
536 // fix that. (If the cpu is not idle, this is not required.)
537 simgrid::s4u::Exec::on_start.connect([](simgrid::s4u::Actor const&, simgrid::s4u::Exec const& activity) {
538 if (activity.get_host_number() == 1) { // We only run on one host
539 simgrid::s4u::Host* host = activity.get_host();
540 simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(host);
543 xbt_assert(host != nullptr);
544 host->extension<HostEnergy>()->update();
549 /** @ingroup plugin_host_energy
550 * @brief updates the consumption of all hosts
552 * After this call, sg_host_get_consumed_energy() will not interrupt your process
553 * (until after the next clock update).
555 void sg_host_energy_update_all()
557 simgrid::kernel::actor::simcall([]() {
558 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
559 for (auto const& host : list)
560 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host) == nullptr) { // Ignore virtual machines
561 xbt_assert(host != nullptr);
562 host->extension<HostEnergy>()->update();
567 /** @ingroup plugin_host_energy
568 * @brief Returns the total energy consumed by the host so far (in Joules)
570 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
571 * The result is that the actor requesting this value will be interrupted,
572 * the value will be updated in kernel mode before returning the control to the requesting actor.
574 double sg_host_get_consumed_energy(sg_host_t host)
576 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
577 "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
578 return host->extension<HostEnergy>()->get_consumed_energy();
581 /** @ingroup plugin_host_energy
582 * @brief Get the amount of watt dissipated when the host is idling
584 double sg_host_get_idle_consumption(sg_host_t host)
586 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
587 "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
588 return host->extension<HostEnergy>()->get_idle_consumption();
591 /** @ingroup plugin_host_energy
592 * @brief Get the amount of watt dissipated at the given pstate when the host is idling
594 double sg_host_get_wattmin_at(sg_host_t host, int pstate)
596 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
597 "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
598 return host->extension<HostEnergy>()->get_watt_min_at(pstate);
600 /** @ingroup plugin_host_energy
601 * @brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
603 double sg_host_get_wattmax_at(sg_host_t host, int pstate)
605 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
606 "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
607 return host->extension<HostEnergy>()->get_watt_max_at(pstate);
609 /** @ingroup plugin_host_energy
610 * @brief Returns the power slope at the given pstate
612 double sg_host_get_power_range_slope_at(sg_host_t host, int pstate)
614 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
615 "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
616 return host->extension<HostEnergy>()->get_power_range_slope_at(pstate);
618 /** @ingroup plugin_host_energy
619 * @brief Returns the current consumption of the host
621 double sg_host_get_current_consumption(sg_host_t host)
623 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
624 "The Energy plugin is not active. Please call sg_host_energy_plugin_init() during initialization.");
625 return host->extension<HostEnergy>()->get_current_watts_value();