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. */
10 #include "simgrid/plugins/energy.h"
11 #include "simgrid/simix.hpp"
12 #include "src/surf/plugins/energy.hpp"
13 #include "src/surf/cpu_interface.hpp"
14 #include "src/surf/virtual_machine.hpp"
16 /** @addtogroup SURF_plugin_energy
19 This is the energy plugin, enabling to account not only for computation time,
20 but also for the dissipated energy in the simulated platform.
22 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
25 <host id="HostA" power="100.0Mf" >
26 <prop id="watt_per_state" value="100.0:200.0" />
27 <prop id="watt_off" value="10" />
31 The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
32 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
33 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these 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 watt_per_state property.
46 In this example, the idle consumption is 95 Watts, 93 Watts and 90 Watts in each pstate while the CPU burn consumption are at 200 Watts,
47 170 Watts and 150 Watts respectively.
49 To change the pstate of a given CPU, use the following functions: #MSG_host_get_nb_pstates(), simgrid#s4u#Host#set_pstate(), #MSG_host_get_power_peak_at().
51 To simulate the energy-related elements, first call the simgrid#energy#sg_energy_plugin_init() before your #MSG_init(),
52 and then use the following function to retrieve the consumption of a given host: MSG_host_get_consumed_energy().
55 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
56 "Logging specific to the SURF energy plugin");
58 using simgrid::energy::HostEnergy;
63 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
65 /* Computes the consumption so far. Called lazily on need. */
66 void HostEnergy::update()
68 simgrid::surf::HostImpl* surf_host = host->extension<simgrid::surf::HostImpl>();
69 double start_time = this->last_updated;
70 double finish_time = surf_get_clock();
72 if (surf_host->p_cpu->speed_.peak == 0)
73 // Some users declare a pstate of speed 0 flops (eg to model boot time).
74 // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
77 cpu_load = lmm_constraint_get_usage(surf_host->p_cpu->getConstraint())
78 / surf_host->p_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->p_cpu->speed_.peak, previous_energy, energy_this_step);
100 HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) :
101 host(ptr), last_updated(surf_get_clock())
103 initWattsRangeList();
105 if (host->properties() != NULL) {
106 char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
107 if (off_power_str != NULL)
108 watts_off = xbt_str_parse_double(off_power_str,
109 bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str()));
116 HostEnergy::~HostEnergy()
120 double HostEnergy::getWattMinAt(int pstate)
122 xbt_assert(!power_range_watts_list.empty(),
123 "No power range properties specified for host %s", host->name().c_str());
124 return power_range_watts_list[pstate].first;
127 double HostEnergy::getWattMaxAt(int pstate)
129 xbt_assert(!power_range_watts_list.empty(),
130 "No power range properties specified for host %s", host->name().c_str());
131 return power_range_watts_list[pstate].second;
134 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
135 double HostEnergy::getCurrentWattsValue(double cpu_load)
137 xbt_assert(!power_range_watts_list.empty(),
138 "No power range properties specified for host %s", host->name().c_str());
140 /* min_power corresponds to the idle power (cpu load = 0) */
141 /* max_power is the power consumed at 100% cpu load */
142 auto range = power_range_watts_list.at(host->pstate());
143 double min_power = range.first;
144 double max_power = range.second;
145 double power_slope = max_power - min_power;
146 double current_power = min_power + cpu_load * power_slope;
148 XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
149 XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
151 return current_power;
154 double HostEnergy::getConsumedEnergy()
156 if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
157 simgrid::simix::kernel(std::bind(&HostEnergy::update, this));
162 void HostEnergy::initWattsRangeList()
164 if (host->properties() == NULL)
166 char* all_power_values_str =
167 (char*)xbt_dict_get_or_null(host->properties(), "watt_per_state");
168 if (all_power_values_str == NULL)
171 xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
172 int pstate_nb = xbt_dynar_length(all_power_values);
174 for (int i=0; i< pstate_nb; i++)
176 /* retrieve the power values associated with the current pstate */
177 xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
178 xbt_assert(xbt_dynar_length(current_power_values) > 1,
179 "Power properties incorrectly defined - "
180 "could not retrieve min and max power values for host %s",
181 host->name().c_str());
183 /* min_power corresponds to the idle power (cpu load = 0) */
184 /* max_power is the power consumed at 100% cpu load */
185 power_range_watts_list.push_back(power_range(
186 xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*),
187 bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str())),
188 xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*),
189 bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str()))
192 xbt_dynar_free(¤t_power_values);
194 xbt_dynar_free(&all_power_values);
200 /* **************************** events callback *************************** */
201 static void onCreation(simgrid::s4u::Host& host) {
202 simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
203 if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
205 host.extension_set(new HostEnergy(&host));
208 static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
209 for(simgrid::surf::Cpu* cpu : action->cpus()) {
210 const char *name = cpu->getName();
211 sg_host_t sghost = sg_host_by_name(name);
214 simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
215 simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
216 if (vm) // If it's a VM, take the corresponding PM
217 host = vm->getPm()->extension<simgrid::surf::HostImpl>();
219 HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
221 if(host_energy->last_updated < surf_get_clock())
222 host_energy->update();
226 static void onHostStateChange(simgrid::s4u::Host &host) {
227 simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
228 if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
231 HostEnergy *host_energy = host.extension<HostEnergy>();
233 if(host_energy->last_updated < surf_get_clock())
234 host_energy->update();
237 static void onHostDestruction(simgrid::s4u::Host& host) {
238 // Ignore virtual machines
239 simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
240 if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
242 HostEnergy *host_energy = host.extension<HostEnergy>();
243 host_energy->update();
244 XBT_INFO("Total energy of host %s: %f Joules",
245 host.name().c_str(), host_energy->getConsumedEnergy());
248 /* **************************** Public interface *************************** */
249 /** \ingroup SURF_plugin_energy
250 * \brief Enable energy plugin
251 * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
253 void sg_energy_plugin_init(void)
255 if (HostEnergy::EXTENSION_ID.valid())
258 HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
260 simgrid::s4u::Host::onCreation.connect(&onCreation);
261 simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
262 simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
263 simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
266 /** @brief Returns the total energy consumed by the host so far (in Joules)
268 * See also @ref SURF_plugin_energy.
270 double sg_host_get_consumed_energy(sg_host_t host) {
271 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
272 "The Energy plugin is not active. "
273 "Please call sg_energy_plugin_init() during initialization.");
274 return host->extension<HostEnergy>()->getConsumedEnergy();
277 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
278 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
279 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
280 "The Energy plugin is not active. "
281 "Please call sg_energy_plugin_init() during initialization.");
282 return host->extension<HostEnergy>()->getWattMinAt(pstate);
284 /** @brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
285 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
286 xbt_assert(HostEnergy::EXTENSION_ID.valid(),
287 "The Energy plugin is not active. "
288 "Please call sg_energy_plugin_init() during initialization.");
289 return host->extension<HostEnergy>()->getWattMaxAt(pstate);