Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
unify the naming of that property
[simgrid.git] / src / surf / plugins / energy.cpp
1 /* Copyright (c) 2010, 2012-2016. 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/simix.hpp"
8 #include "src/surf/plugins/energy.hpp"
9 #include "src/surf/cpu_interface.hpp"
10 #include "src/surf/virtual_machine.hpp"
11
12 #include <utility>
13
14 /** @addtogroup SURF_plugin_energy
15
16
17 This is the energy plugin, enabling to account not only for computation time,
18 but also for the dissipated energy in the simulated platform.
19
20 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
21
22 \verbatim
23 <host id="HostA" power="100.0Mf" >
24     <prop id="watt_per_state" value="100.0:200.0" />
25     <prop id="watt_off" value="10" />
26 </host>
27 \endverbatim
28
29 The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
30 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
31 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
32 values are arbitrary).
33
34 If your CPU is using pstates, then you can provide one consumption interval per pstate.
35
36 \verbatim
37 <host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
38     <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
39     <prop id="watt_off" value="10" />
40 </host>
41 \endverbatim
42
43 That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
44 It starts at pstate 0 (ie, at 100 Mflop/s). In this case, you have to specify one interval per pstate in the
45 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
47 are at 200 Watts, 170 Watts, and 150 Watts respectively.
48
49 To change the pstate of a given CPU, use the following functions:
50 #MSG_host_get_nb_pstates(), simgrid#s4u#Host#setPstate(), #MSG_host_get_power_peak_at().
51
52 To simulate the energy-related elements, first call the simgrid#energy#sg_energy_plugin_init() before your #MSG_init(),
53 and then use the following function to retrieve the consumption of a given host: MSG_host_get_consumed_energy().
54  */
55
56 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf, "Logging specific to the SURF energy plugin");
57
58 using simgrid::energy::HostEnergy;
59
60 namespace simgrid {
61 namespace energy {
62
63 simgrid::xbt::Extension<simgrid::s4u::Host, HostEnergy> HostEnergy::EXTENSION_ID;
64
65 /* Computes the consumption so far.  Called lazily on need. */
66 void HostEnergy::update()
67 {
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();
71   double cpu_load;
72   if (surf_host->cpu_->getPstateSpeedCurrent() <= 0)
73     // Some users declare a pstate of speed 0 flops (e.g., to model boot time).
74     // We consider that the machine is then fully loaded. That's arbitrary but it avoids a NaN
75     cpu_load = 1;
76   else
77     cpu_load = lmm_constraint_get_usage(surf_host->cpu_->getConstraint()) / surf_host->cpu_->getPstateSpeedCurrent();
78
79   /** Divide by the number of cores here **/
80   cpu_load /= surf_host->cpu_->coreCount();
81
82   if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not more
83     cpu_load = 1;
84
85   /* The problem with this model is that the load is always 0 or 1, never something less.
86    * Another possibility could be to model the total energy as
87    *
88    *   X/(X+Y)*W_idle + Y/(X+Y)*W_burn
89    *
90    * where X is the amount of ideling cores, and Y the amount of computing cores.
91    */
92
93   double previous_energy = this->total_energy;
94
95   double instantaneous_consumption;
96   if (host->isOff())
97     instantaneous_consumption = this->watts_off;
98   else
99     instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
100
101   double energy_this_step = instantaneous_consumption*(finish_time-start_time);
102
103   this->total_energy = previous_energy + energy_this_step;
104   this->last_updated = finish_time;
105
106   XBT_DEBUG("[update_energy of %s] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
107       surf_host->getName(), start_time, finish_time, surf_host->cpu_->speed_.peak, previous_energy, energy_this_step);
108 }
109
110 HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) : host(ptr), last_updated(surf_get_clock())
111 {
112   initWattsRangeList();
113
114   if (host->properties() != nullptr) {
115     char* off_power_str = (char*)xbt_dict_get_or_null(host->properties(), "watt_off");
116     if (off_power_str != nullptr) {
117       char *msg = bprintf("Invalid value for property watt_off of host %s: %%s",host->name().c_str());
118       watts_off = xbt_str_parse_double(off_power_str, msg);
119       xbt_free(msg);
120     }
121     else
122       watts_off = 0;
123   }
124 }
125
126 HostEnergy::~HostEnergy()=default;
127
128 double HostEnergy::getWattMinAt(int pstate)
129 {
130   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
131   return power_range_watts_list[pstate].min;
132 }
133
134 double HostEnergy::getWattMaxAt(int pstate)
135 {
136   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
137   return power_range_watts_list[pstate].max;
138 }
139
140 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
141 double HostEnergy::getCurrentWattsValue(double cpu_load)
142 {
143   xbt_assert(!power_range_watts_list.empty(), "No power range properties specified for host %s", host->name().c_str());
144
145   /* min_power corresponds to the idle power (cpu load = 0) */
146   /* max_power is the power consumed at 100% cpu load       */
147   auto range           = power_range_watts_list.at(host->pstate());
148   double current_power = 0;
149   double min_power     = 0;
150   double max_power     = 0;
151   double power_slope   = 0;
152
153   if (cpu_load > 0) { /* Something is going on, the machine is not idle */
154     double min_power = range.min;
155     double max_power = range.max;
156     double power_slope = max_power - min_power;
157     current_power = min_power + cpu_load * power_slope;
158   }
159   else { /* Our machine is idle, take the dedicated value! */
160     current_power = range.idle;
161   }
162
163   XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
164   XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
165
166   return current_power;
167 }
168
169 double HostEnergy::getConsumedEnergy()
170 {
171   if (last_updated < surf_get_clock()) // We need to simcall this as it modifies the environment
172     simgrid::simix::kernelImmediate(std::bind(&HostEnergy::update, this));
173
174   return total_energy;
175 }
176
177 void HostEnergy::initWattsRangeList()
178 {
179   if (host->properties() == nullptr)
180     return;
181   char* all_power_values_str = static_cast<char*>(xbt_dict_get_or_null(host->properties(), "watt_per_state"));
182   if (all_power_values_str == nullptr)
183     return;
184
185   xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
186   int pstate_nb = xbt_dynar_length(all_power_values);
187
188   for (int i=0; i< pstate_nb; i++) {
189     /* retrieve the power values associated with the current pstate */
190     xbt_dynar_t current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
191     xbt_assert(xbt_dynar_length(current_power_values) > 1,
192         "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
193         host->name().c_str());
194
195     /* min_power corresponds to the idle power (cpu load = 0) */
196     /* max_power is the power consumed at 100% cpu load       */
197     char *msg_idle = bprintf("Invalid idle value for pstate %d on host %s: %%s", i, host->name().c_str());
198     char *msg_min = bprintf("Invalid min value for pstate %d on host %s: %%s", i, host->name().c_str());
199     char *msg_max = bprintf("Invalid max value for pstate %d on host %s: %%s", i, host->name().c_str());
200     PowerRange range(
201       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 0, char*), msg_idle),
202       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 1, char*), msg_min),
203       xbt_str_parse_double(xbt_dynar_get_as(current_power_values, 2, char*), msg_max)
204     );
205     power_range_watts_list.push_back(range);
206     xbt_free(msg_min);
207     xbt_free(msg_max);
208
209     xbt_dynar_free(&current_power_values);
210   }
211   xbt_dynar_free(&all_power_values);
212 }
213
214 }
215 }
216
217 /* **************************** events  callback *************************** */
218 static void onCreation(simgrid::s4u::Host& host) {
219   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
220   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
221     return;
222   host.extension_set(new HostEnergy(&host));
223 }
224
225 static void onActionStateChange(simgrid::surf::CpuAction *action, simgrid::surf::Action::State previous) {
226   for(simgrid::surf::Cpu* cpu : action->cpus()) {
227     const char *name = cpu->getName();
228     sg_host_t sghost = sg_host_by_name(name);
229     if(sghost == nullptr)
230       continue;
231     simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
232     simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
233     if (vm) // If it's a VM, take the corresponding PM
234       host = vm->getPm()->extension<simgrid::surf::HostImpl>();
235
236     HostEnergy *host_energy = host->piface_->extension<HostEnergy>();
237
238     if(host_energy->last_updated < surf_get_clock())
239       host_energy->update();
240   }
241 }
242
243 static void onHostStateChange(simgrid::s4u::Host &host) {
244   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
245   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
246     return;
247
248   HostEnergy *host_energy = host.extension<HostEnergy>();
249
250   if(host_energy->last_updated < surf_get_clock())
251     host_energy->update();
252 }
253
254 static void onHostDestruction(simgrid::s4u::Host& host) {
255   // Ignore virtual machines
256   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
257   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
258     return;
259   HostEnergy *host_energy = host.extension<HostEnergy>();
260   host_energy->update();
261   XBT_INFO("Total energy of host %s: %f Joules", host.name().c_str(), host_energy->getConsumedEnergy());
262 }
263
264 /* **************************** Public interface *************************** */
265 /** \ingroup SURF_plugin_energy
266  * \brief Enable energy plugin
267  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
268  */
269 void sg_energy_plugin_init()
270 {
271   if (HostEnergy::EXTENSION_ID.valid())
272     return;
273
274   HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
275
276   simgrid::s4u::Host::onCreation.connect(&onCreation);
277   simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
278   simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
279   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
280 }
281
282 /** @brief Returns the total energy consumed by the host so far (in Joules)
283  *
284  *  See also @ref SURF_plugin_energy.
285  */
286 double sg_host_get_consumed_energy(sg_host_t host) {
287   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
288     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
289   return host->extension<HostEnergy>()->getConsumedEnergy();
290 }
291
292 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
293 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
294   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
295     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
296   return host->extension<HostEnergy>()->getWattMinAt(pstate);
297 }
298 /** @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
299 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
300   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
301     "The Energy plugin is not active. Please call sg_energy_plugin_init() during initialization.");
302   return host->extension<HostEnergy>()->getWattMaxAt(pstate);
303 }