1 /* Copyright (c) 2010-2018. 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/plugins/load.h"
8 #include "simgrid/simix.hpp"
9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
10 #include "src/surf/cpu_interface.hpp"
12 #include "simgrid/s4u/Engine.hpp"
14 #include <boost/algorithm/string/classification.hpp>
15 #include <boost/algorithm/string/split.hpp>
20 /** @addtogroup plugin_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 sg_host_energy_plugin_init() before your #MSG_init(), and then use
25 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
30 <a href="https://hal.inria.fr/hal-01523608">our scientific paper</a> on that topic.
32 As a result, our energy model takes 4 parameters:
34 - \b Idle: instantaneous consumption (in Watt) when your host is up and running, but without anything to do.
35 - \b OneCore: instantaneous consumption (in Watt) when only one core is active, at 100%.
36 - \b AllCores: instantaneous consumption (in Watt) when all cores of the host are at 100%.
37 - \b Off: instantaneous consumption (in Watt) when the host is turned off.
39 Here is an example of XML declaration:
42 <host id="HostA" power="100.0Mf" cores="4">
43 <prop id="watt_per_state" value="100.0:120.0:200.0" />
44 <prop id="watt_off" value="10" />
48 This example gives the following parameters: \b Off is 10 Watts; \b Idle is 100 Watts; \b OneCore is 120 Watts and \b
49 AllCores is 200 Watts.
50 This is enough to compute the consumption as a function of the amount of loaded cores:
53 <tr><th>#Cores loaded</th><th>Consumption</th><th>Explanation</th></tr>
54 <tr><td>0</td><td> 100 Watts</td><td>Idle value</td></tr>
55 <tr><td>1</td><td> 120 Watts</td><td>OneCore value</td></tr>
56 <tr><td>2</td><td> 147 Watts</td><td>linear extrapolation between OneCore and AllCores</td></tr>
57 <tr><td>3</td><td> 173 Watts</td><td>linear extrapolation between OneCore and AllCores</td></tr>
58 <tr><td>4</td><td> 200 Watts</td><td>AllCores value</td></tr>
61 ### What if a given core is only at load 50%?
63 This is impossible in SimGrid because we recompute everything each time that the CPU starts or stops doing something.
64 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
65 the time, and our model holds.
67 ### What if the host has only one core?
69 In this case, the parameters \b OneCore and \b AllCores are obviously the same.
70 Actually, SimGrid expect an energetic profile formatted as 'Idle:Running' for mono-cores hosts.
71 If you insist on passing 3 parameters in this case, then you must have the same value for \b OneCore and \b AllCores.
74 <host id="HostC" power="100.0Mf" cores="1">
75 <prop id="watt_per_state" value="95.0:200.0" /> <!-- we may have used '95:200:200' instead -->
76 <prop id="watt_off" value="10" />
80 ### How does DVFS interact with the host energy model?
82 If your host has several DVFS levels (several pstates), then you should give the energetic profile of each pstate level:
85 <host id="HostC" power="100.0Mf,50.0Mf,20.0Mf" cores="4">
86 <prop id="watt_per_state" value="95.0:120.0:200.0, 93.0:115.0:170.0, 90.0:110.0:150.0" />
87 <prop id="watt_off" value="10" />
91 This encodes the following values
93 <tr><th>pstate</th><th>Performance</th><th>Idle</th><th>OneCore</th><th>AllCores</th></tr>
94 <tr><td>0</td><td>100 Mflop/s</td><td>95 Watts</td><td>120 Watts</td><td>200 Watts</td></tr>
95 <tr><td>1</td><td>50 Mflop/s</td><td>93 Watts</td><td>115 Watts</td><td>170 Watts</td></tr>
96 <tr><td>2</td><td>20 Mflop/s</td><td>90 Watts</td><td>110 Watts</td><td>150 Watts</td></tr>
99 To change the pstate of a given CPU, use the following functions:
100 #MSG_host_get_nb_pstates(), simgrid#s4u#Host#setPstate(), #MSG_host_get_power_peak_at().
102 ### How accurate are these models?
104 This model cannot be more accurate than your instantiation: with the default values, your result will not be accurate at
105 all. You can still get accurate energy prediction, provided that you carefully instantiate the model.
106 The first step is to ensure that your timing prediction match perfectly. But this is only the first step of the path,
107 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
108 before you can get accurate energy predictions.
111 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
122 PowerRange(double idle, double min, double max) : idle(idle), min(min), max(max) {}
127 static simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> EXTENSION_ID;
129 explicit HostEnergy(simgrid::s4u::Host* ptr);
132 double getCurrentWattsValue();
133 double getCurrentWattsValue(double cpu_load);
134 double getConsumedEnergy();
135 double getWattMinAt(int pstate);
136 double getWattMaxAt(int pstate);
140 void initWattsRangeList();
141 simgrid::s4u::Host* host = nullptr;
142 std::vector<PowerRange>
143 power_range_watts_list; /*< List of (min_power,max_power) pairs corresponding to each cpu pstate */
145 /* We need to keep track of what pstate has been used, as we will sometimes be notified only *after* a pstate has been
146 * used (but we need to update the energy consumption with the old pstate!)
149 const int pstate_off = -1;
152 double watts_off = 0.0; /*< Consumption when the machine is turned off (shutdown) */
153 double total_energy = 0.0; /*< Total energy consumed by the host */
154 double last_updated; /*< Timestamp of the last energy update event*/
157 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
159 /* Computes the consumption so far. Called lazily on need. */
160 void HostEnergy::update()
162 double start_time = this->last_updated;
163 double finish_time = surf_get_clock();
165 if (start_time < finish_time) {
166 double previous_energy = this->total_energy;
168 double instantaneous_consumption = this->getCurrentWattsValue();
170 double energy_this_step = instantaneous_consumption * (finish_time - start_time);
172 // TODO Trace: Trace energy_this_step from start_time to finish_time in host->getName()
174 this->total_energy = previous_energy + energy_this_step;
175 this->last_updated = finish_time;
177 XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> "
179 host->get_cname(), start_time, finish_time, host->pimpl_cpu->speed_.peak, previous_energy,
183 /* Save data for the upcoming time interval: whether it's on/off and the pstate if it's on */
184 this->pstate = host->isOn() ? host->getPstate() : pstate_off;
187 HostEnergy::HostEnergy(simgrid::s4u::Host* ptr) : host(ptr), last_updated(surf_get_clock())
189 initWattsRangeList();
191 const char* off_power_str = host->getProperty("watt_off");
192 if (off_power_str != nullptr) {
194 this->watts_off = std::stod(std::string(off_power_str));
195 } catch (std::invalid_argument& ia) {
196 throw std::invalid_argument(std::string("Invalid value for property watt_off of host ") + host->get_cname() +
197 ": " + off_power_str);
200 /* watts_off is 0 by default */
203 HostEnergy::~HostEnergy() = default;
205 double HostEnergy::getWattMinAt(int pstate)
207 xbt_assert(not power_range_watts_list.empty(), "No power range properties specified for host %s", host->get_cname());
208 return power_range_watts_list[pstate].min;
211 double HostEnergy::getWattMaxAt(int pstate)
213 xbt_assert(not power_range_watts_list.empty(), "No power range properties specified for host %s", host->get_cname());
214 return power_range_watts_list[pstate].max;
217 /** @brief Computes the power consumed by the host according to the current situation
219 * - If the host is off, that's the watts_off value
220 * - if it's on, take the current pstate and the current processor load into account */
221 double HostEnergy::getCurrentWattsValue()
223 if (this->pstate == pstate_off) // The host is off (or was off at the beginning of this time interval)
224 return this->watts_off;
226 double current_speed = host->getSpeed();
229 // We may have start == finish if the past consumption was updated since the simcall was started
230 // for example if 2 actors requested to update the same host's consumption in a given scheduling round.
232 // Even in this case, we need to save the pstate for the next call (after this big if),
233 // which may have changed since that recent update.
235 if (current_speed <= 0)
236 // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
237 // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
240 cpu_load = host->pimpl_cpu->constraint()->get_usage() / current_speed;
242 /** Divide by the number of cores here **/
243 cpu_load /= host->pimpl_cpu->coreCount();
245 if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
248 /* The problem with this model is that the load is always 0 or 1, never something less.
249 * Another possibility could be to model the total energy as
251 * X/(X+Y)*W_idle + Y/(X+Y)*W_burn
253 * where X is the amount of idling cores, and Y the amount of computing cores.
255 return getCurrentWattsValue(cpu_load);
258 /** @brief Computes the power that the host would consume at the provided processor load
260 * Whether the host is ON or OFF is not taken into account.
262 double HostEnergy::getCurrentWattsValue(double cpu_load)
264 xbt_assert(not power_range_watts_list.empty(), "No power range properties specified for host %s", host->get_cname());
266 /* Return watts_off if pstate == pstate_off (ie, if the host is off) */
267 if (this->pstate == pstate_off) {
271 /* min_power corresponds to the power consumed when only one core is active */
272 /* max_power is the power consumed at 100% cpu load */
273 auto range = power_range_watts_list.at(this->pstate);
274 double current_power = 0;
275 double min_power = 0;
276 double max_power = 0;
277 double power_slope = 0;
279 if (cpu_load > 0) { /* Something is going on, the machine is not idle */
280 double min_power = range.min;
281 double max_power = range.max;
284 * The min_power states how much we consume when only one single
285 * core is working. This means that when cpu_load == 1/coreCount, then
286 * current_power == min_power.
288 * The maximum must be reached when all cores are working (but 1 core was
289 * already accounted for by min_power)
290 * i.e., we need min_power + (maxCpuLoad-1/coreCount)*power_slope == max_power
291 * (maxCpuLoad is by definition 1)
294 int coreCount = host->getCoreCount();
295 double coreReciprocal = static_cast<double>(1) / static_cast<double>(coreCount);
297 power_slope = (max_power - min_power) / (1 - coreReciprocal);
299 power_slope = 0; // Should be 0, since max_power == min_power (in this case)
301 current_power = min_power + (cpu_load - coreReciprocal) * power_slope;
302 } else { /* Our machine is idle, take the dedicated value! */
303 current_power = range.idle;
306 XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
307 XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
309 return current_power;
312 double HostEnergy::getConsumedEnergy()
314 if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
315 simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
320 void HostEnergy::initWattsRangeList()
322 const char* all_power_values_str = host->getProperty("watt_per_state");
323 if (all_power_values_str == nullptr)
326 std::vector<std::string> all_power_values;
327 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
328 XBT_DEBUG("%s: profile: %s, cores: %d", host->get_cname(), all_power_values_str, host->getCoreCount());
331 for (auto const& current_power_values_str : all_power_values) {
332 /* retrieve the power values associated with the current pstate */
333 std::vector<std::string> current_power_values;
334 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
335 if (host->getCoreCount() == 1) {
336 xbt_assert(current_power_values.size() == 2 || current_power_values.size() == 3,
337 "Power properties incorrectly defined for host %s."
338 "It should be 'Idle:FullSpeed' power values because you have one core only.",
340 if (current_power_values.size() == 2) {
341 // In this case, 1core == AllCores
342 current_power_values.push_back(current_power_values.at(1));
343 } else { // size == 3
344 xbt_assert((current_power_values.at(1)) == (current_power_values.at(2)),
345 "Power properties incorrectly defined for host %s.\n"
346 "The energy profile of mono-cores should be formatted as 'Idle:FullSpeed' only.\n"
347 "If you go for a 'Idle:OneCore:AllCores' power profile on mono-cores, then OneCore and AllCores "
352 xbt_assert(current_power_values.size() == 3,
353 "Power properties incorrectly defined for host %s."
354 "It should be 'Idle:OneCore:AllCores' power values because you have more than one core.",
358 /* min_power corresponds to the idle power (cpu load = 0) */
359 /* max_power is the power consumed at 100% cpu load */
360 char* msg_idle = bprintf("Invalid idle value for pstate %d on host %s: %%s", i, host->get_cname());
361 char* msg_min = bprintf("Invalid OneCore value for pstate %d on host %s: %%s", i, host->get_cname());
362 char* msg_max = bprintf("Invalid AllCores value for pstate %d on host %s: %%s", i, host->get_cname());
363 PowerRange range(xbt_str_parse_double((current_power_values.at(0)).c_str(), msg_idle),
364 xbt_str_parse_double((current_power_values.at(1)).c_str(), msg_min),
365 xbt_str_parse_double((current_power_values.at(2)).c_str(), msg_max));
366 power_range_watts_list.push_back(range);
376 using simgrid::plugin::HostEnergy;
378 /* **************************** events callback *************************** */
379 static void onCreation(simgrid::s4u::Host& host)
381 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
384 // TODO Trace: set to zero the energy variable associated to host->getName()
386 host.extension_set(new HostEnergy(&host));
389 static void onActionStateChange(simgrid::surf::CpuAction* action, simgrid::kernel::resource::Action::State previous)
391 for (simgrid::surf::Cpu* const& cpu : action->cpus()) {
392 simgrid::s4u::Host* host = cpu->getHost();
393 if (host != nullptr) {
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
400 // Get the host_energy extension for the relevant host
401 HostEnergy* host_energy = host->extension<HostEnergy>();
403 if (host_energy->last_updated < surf_get_clock())
404 host_energy->update();
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 onHostChange(simgrid::s4u::Host& host)
413 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
416 HostEnergy* host_energy = host.extension<HostEnergy>();
418 host_energy->update();
421 static void onHostDestruction(simgrid::s4u::Host& host)
423 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(&host)) // Ignore virtual machines
426 XBT_INFO("Energy consumption of host %s: %f Joules", host.get_cname(),
427 host.extension<HostEnergy>()->getConsumedEnergy());
430 static void onSimulationEnd()
432 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::getInstance()->getAllHosts();
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
439 bool host_was_used = (sg_host_get_computed_flops(hosts[i]) != 0);
440 double energy = hosts[i]->extension<HostEnergy>()->getConsumedEnergy();
441 total_energy += energy;
443 used_hosts_energy += energy;
446 XBT_INFO("Total energy consumption: %f Joules (used hosts: %f Joules; unused/idle hosts: %f)",
447 total_energy, used_hosts_energy, total_energy - used_hosts_energy);
450 /* **************************** Public interface *************************** */
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().
456 void sg_host_energy_plugin_init()
458 if (HostEnergy::EXTENSION_ID.valid())
461 sg_host_load_plugin_init();
463 HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
465 simgrid::s4u::Host::onCreation.connect(&onCreation);
466 simgrid::s4u::Host::onStateChange.connect(&onHostChange);
467 simgrid::s4u::Host::onSpeedChange.connect(&onHostChange);
468 simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
469 simgrid::s4u::onSimulationEnd.connect(&onSimulationEnd);
470 simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
473 /** @ingroup plugin_energy
474 * @brief updates the consumption of all hosts
476 * After this call, sg_host_get_consumed_energy() will not interrupt your process
477 * (until after the next clock update).
479 void sg_host_energy_update_all()
481 simgrid::simix::kernelImmediate([]() {
482 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::getInstance()->getAllHosts();
483 for (auto const& host : list)
484 if (dynamic_cast<simgrid::s4u::VirtualMachine*>(host) == nullptr) // Ignore virtual machines
485 host->extension<HostEnergy>()->update();
489 /** @ingroup plugin_energy
490 * @brief Returns the total energy consumed by the host so far (in Joules)
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.
496 double sg_host_get_consumed_energy(sg_host_t host)
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>()->getConsumedEnergy();
503 /** @ingroup plugin_energy
504 * @brief Get the amount of watt dissipated at the given pstate when the host is idling
506 double sg_host_get_wattmin_at(sg_host_t host, int pstate)
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>()->getWattMinAt(pstate);
512 /** @ingroup plugin_energy
513 * @brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
515 double sg_host_get_wattmax_at(sg_host_t host, int pstate)
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>()->getWattMaxAt(pstate);
522 /** @ingroup plugin_energy
523 * @brief Returns the current consumption of the host
525 double sg_host_get_current_consumption(sg_host_t host)
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>()->getCurrentWattsValue();