1 /* Copyright (c) 2010, 2012-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "simgrid/plugins/energy.h"
10 #include "simgrid/simix.hpp"
11 #include "src/surf/plugins/energy.hpp"
12 #include "src/surf/cpu_interface.hpp"
13 #include "src/surf/virtual_machine.hpp"
15 /** @addtogroup SURF_plugin_energy
18 This is the energy plugin, enabling to account not only for computation time,
19 but also for the dissipated energy in the simulated platform.
21 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
24 <host id="HostA" power="100.0Mf" >
25 <prop id="watt_per_state" value="100.0:200.0" />
26 <prop id="watt_off" value="10" />
30 The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
31 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
32 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
33 values are arbitrary).
35 If your CPU is using pstates, then you can provide one consumption interval per pstate.
38 <host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
39 <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
40 <prop id="watt_off" value="10" />
44 That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
45 It starts at pstate 0 (ie, at 100 Mflop/s). In this case, you have to specify one interval per pstate in the
46 watt_per_state property.
47 In this example, the idle consumption is 95 Watts, 93 Watts and 90 Watts in each pstate while the CPU burn consumption
48 are at 200 Watts, 170 Watts, and 150 Watts respectively.
50 To change the pstate of a given CPU, use the following functions:
51 #MSG_host_get_nb_pstates(), simgrid#s4u#Host#setPstate(), #MSG_host_get_power_peak_at().
53 To simulate the energy-related elements, first call the simgrid#energy#sg_energy_plugin_init() before your #MSG_init(),
54 and then use the following function to retrieve the consumption of a given host: MSG_host_get_consumed_energy().
57 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
59 using simgrid::energy::HostEnergy;
64 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
66 /* Computes the consumption so far. Called lazily on need. */
67 void HostEnergy::update()
69 simgrid::surf::HostImpl* surf_host = host->extension<simgrid::surf::HostImpl>();
70 double start_time = this->last_updated;
71 double finish_time = surf_get_clock();
73 if (surf_host->cpu_->speed_.peak <= 0)
74 // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
75 // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
78 cpu_load = lmm_constraint_get_usage(surf_host->cpu_->getConstraint()) / surf_host->cpu_->speed_.peak;
80 if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not mores
83 double previous_energy = this->total_energy;
85 double instantaneous_consumption;
87 instantaneous_consumption = this->watts_off;
89 instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
91 double energy_this_step = instantaneous_consumption*(finish_time-start_time);
93 this->total_energy = previous_energy + energy_this_step;
94 this->last_updated = finish_time;
96 XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
97 surf_host->getName(), start_time, finish_time, surf_host->cpu_->speed_.peak, previous_energy, energy_this_step);
100 HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) : host(ptr), last_updated(surf_get_clock())
102 initWattsRangeList();
104 if (host->properties() != nullptr) {
105 char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
106 if (off_power_str != nullptr) {
107 char *msg = bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str());
108 watts_off = xbt_str_parse_double(off_power_str, msg);
116 HostEnergy::~HostEnergy()=default;
118 double HostEnergy::getWattMinAt(int pstate)
120 xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
121 return power_range_watts_list[pstate].first;
124 double HostEnergy::getWattMaxAt(int pstate)
126 xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
127 return power_range_watts_list[pstate].second;
130 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
131 double HostEnergy::getCurrentWattsValue(double cpu_load)
133 xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
135 /* min_power corresponds to the idle power (cpu load = 0) */
136 /* max_power is the power consumed at 100% cpu load */
137 auto range = power_range_watts_list.at(host->pstate());
138 double min_power = range.first;
139 double max_power = range.second;
140 double power_slope = max_power - min_power;
141 double current_power = min_power + cpu_load * power_slope;
143 XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
144 XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
146 return current_power;
149 double HostEnergy::getConsumedEnergy()
151 if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
152 simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
157 void HostEnergy::initWattsRangeList()
159 if (host->properties() == nullptr)
161 char* all_power_values_str = static_cast<char*>(xbt_dict_get_or_null(host->properties(), "watt_per_state"));
162 if (all_power_values_str == nullptr)
165 xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
166 int pstate_nb = xbt_dynar_length(all_power_values);
168 for (int i=0; i< pstate_nb; i++) {
169 /* retrieve the power values associated with the current pstate */
170 xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
171 xbt_assert(xbt_dynar_length(current_power_values) > 1,
172 "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
173 host->name().c_str());
175 /* min_power corresponds to the idle power (cpu load = 0) */
176 /* max_power is the power consumed at 100% cpu load */
177 char *msg_min = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
178 char *msg_max = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
179 power_range_watts_list.push_back(power_range(
180 xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*), msg_min),
181 xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*), msg_max)
186 xbt_dynar_free(¤t_power_values);
188 xbt_dynar_free(&all_power_values);
194 /* **************************** events callback *************************** */
195 static void onCreation(simgrid::s4u::Host& host) {
196 simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
197 if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
199 host.extension_set(new HostEnergy(&host));
202 static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
203 for(simgrid::surf::Cpu* cpu : action->cpus()) {
204 const char *name = cpu->getName();
205 sg_host_t sghost = sg_host_by_name(name);
206 if(sghost == nullptr)
208 simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
209 simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
210 if (vm) // If it's a VM, take the corresponding PM
211 host = vm->getPm()->extension<simgrid::surf::HostImpl>();
213 HostEnergy *host_energy = host->piface_->extension<HostEnergy>();
215 if(host_energy->last_updated < surf_get_clock())
216 host_energy->update();
220 static void onHostStateChange(simgrid::s4u::Host &host) {
221 simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
222 if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
225 HostEnergy *host_energy = host.extension<HostEnergy>();
227 if(host_energy->last_updated < surf_get_clock())
228 host_energy->update();
231 static void onHostDestruction(simgrid::s4u::Host& host) {
232 // Ignore virtual machines
233 simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
234 if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
236 HostEnergy *host_energy = host.extension<HostEnergy>();
237 host_energy->update();
238 XBT_INFO("Total energy of host %s: %f Joules", host.name().c_str(), host_energy->getConsumedEnergy());
241 /* **************************** Public interface *************************** */
242 /** \ingroup SURF_plugin_energy
243 * \brief Enable energy plugin
244 * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
246 void sg_energy_plugin_init()
248 if (HostEnergy::EXTENSION_ID.valid())
251 HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
253 simgrid::s4u::Host::onCreation.connect(&onCreation);
254 simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
255 simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
256 simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
259 /** @brief Returns the total energy consumed by the host so far (in Joules)
261 * See also @ref SURF_plugin_energy.
263 double sg_host_get_consumed_energy(sg_host_t host) {
264 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
265 "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
266 return host->extension<HostEnergy>()->getConsumedEnergy();
269 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
270 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
271 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
272 "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
273 return host->extension<HostEnergy>()->getWattMinAt(pstate);
275 /** @brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
276 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
277 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
278 "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
279 return host->extension<HostEnergy>()->getWattMaxAt(pstate);