Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / src / surf / plugins / energy.cpp
1 /* Copyright (c) 2010, 2012-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include <utility>
8 #include <vector>
9
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"
15
16 /** @addtogroup SURF_plugin_energy
17
18
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.
21
22 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
23
24 \verbatim
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" />
28 </host>
29 \endverbatim
30
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).
34
35 If your CPU is using pstates, then you can provide one consumption interval per pstate.
36
37 \verbatim
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" />
41 </host>
42 \endverbatim
43
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.
48
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().
50
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().
53  */
54
55 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
56                                 "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->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
75     cpu_load = 1;
76   else
77     cpu_load = lmm_constraint_get_usage(surf_host->p_cpu->getConstraint())
78                 / surf_host->p_cpu->speed_.peak;
79
80   if (cpu_load > 1) // A machine with a load > 1 consumes as much as a fully loaded machine, not mores
81     cpu_load = 1;
82
83   double previous_energy = this->total_energy;
84
85   double instantaneous_consumption;
86   if (host->isOff())
87     instantaneous_consumption = this->watts_off;
88   else
89     instantaneous_consumption = this->getCurrentWattsValue(cpu_load);
90
91   double energy_this_step = instantaneous_consumption*(finish_time-start_time);
92
93   this->total_energy = previous_energy + energy_this_step;
94   this->last_updated = finish_time;
95
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);
98 }
99
100 HostEnergy::HostEnergy(simgrid::s4u::Host *ptr) :
101   host(ptr), last_updated(surf_get_clock())
102 {
103   initWattsRangeList();
104
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()));
110     else
111       watts_off = 0;
112   }
113
114 }
115
116 HostEnergy::~HostEnergy()
117 {
118 }
119
120 double HostEnergy::getWattMinAt(int pstate)
121 {
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;
125 }
126
127 double HostEnergy::getWattMaxAt(int pstate)
128 {
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;
132 }
133
134 /** @brief Computes the power consumed by the host according to the current pstate and processor load */
135 double HostEnergy::getCurrentWattsValue(double cpu_load)
136 {
137   xbt_assert(!power_range_watts_list.empty(),
138     "No power range properties specified for host %s", host->name().c_str());
139
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;
147
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);
150
151   return current_power;
152 }
153
154 double HostEnergy::getConsumedEnergy()
155 {
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));
158
159   return total_energy;
160 }
161
162 void HostEnergy::initWattsRangeList()
163 {
164   if (host->properties() == NULL)
165     return;
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)
169     return;
170
171   xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
172   int pstate_nb = xbt_dynar_length(all_power_values);
173
174   for (int i=0; i< pstate_nb; i++)
175   {
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());
182
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()))
190     ));
191
192     xbt_dynar_free(&current_power_values);
193   }
194   xbt_dynar_free(&all_power_values);
195 }
196
197 }
198 }
199
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
204     return;
205   host.extension_set(new HostEnergy(&host));
206 }
207
208 static void onActionStateChange(simgrid::surf::CpuAction *action, e_surf_action_state_t previous) {
209   std::list<simgrid::surf::Cpu*> cpus = getActionCpus(action);
210   for(simgrid::surf::Cpu* cpu : cpus) {
211     const char *name = cpu->getName();
212     sg_host_t sghost = sg_host_by_name(name);
213     if(sghost == NULL)
214       continue;
215     simgrid::surf::HostImpl *host = sghost->extension<simgrid::surf::HostImpl>();
216     simgrid::surf::VirtualMachine *vm = dynamic_cast<simgrid::surf::VirtualMachine*>(host);
217     if (vm) // If it's a VM, take the corresponding PM
218       host = vm->getPm()->extension<simgrid::surf::HostImpl>();
219
220     HostEnergy *host_energy = host->p_host->extension<HostEnergy>();
221
222     if(host_energy->last_updated < surf_get_clock())
223       host_energy->update();
224   }
225 }
226
227 static void onHostStateChange(simgrid::s4u::Host &host) {
228   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
229   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host)) // Ignore virtual machines
230     return;
231
232   HostEnergy *host_energy = host.extension<HostEnergy>();
233
234   if(host_energy->last_updated < surf_get_clock())
235     host_energy->update();
236 }
237
238 static void onHostDestruction(simgrid::s4u::Host& host) {
239   // Ignore virtual machines
240   simgrid::surf::HostImpl* surf_host = host.extension<simgrid::surf::HostImpl>();
241   if (dynamic_cast<simgrid::surf::VirtualMachine*>(surf_host))
242     return;
243   HostEnergy *host_energy = host.extension<HostEnergy>();
244   host_energy->update();
245   XBT_INFO("Total energy of host %s: %f Joules",
246     host.name().c_str(), host_energy->getConsumedEnergy());
247 }
248
249 /* **************************** Public interface *************************** */
250 /** \ingroup SURF_plugin_energy
251  * \brief Enable energy plugin
252  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
253  */
254 void sg_energy_plugin_init(void)
255 {
256   if (HostEnergy::EXTENSION_ID.valid())
257     return;
258
259   HostEnergy::EXTENSION_ID = simgrid::s4u::Host::extension_create<HostEnergy>();
260
261   simgrid::s4u::Host::onCreation.connect(&onCreation);
262   simgrid::s4u::Host::onStateChange.connect(&onHostStateChange);
263   simgrid::s4u::Host::onDestruction.connect(&onHostDestruction);
264   simgrid::surf::CpuAction::onStateChange.connect(&onActionStateChange);
265 }
266
267 /** @brief Returns the total energy consumed by the host so far (in Joules)
268  *
269  *  See also @ref SURF_plugin_energy.
270  */
271 double sg_host_get_consumed_energy(sg_host_t host) {
272   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
273     "The Energy plugin is not active. "
274     "Please call sg_energy_plugin_init() during initialization.");
275   return host->extension<HostEnergy>()->getConsumedEnergy();
276 }
277
278 /** @brief Get the amount of watt dissipated at the given pstate when the host is idling */
279 double sg_host_get_wattmin_at(sg_host_t host, int pstate) {
280   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
281     "The Energy plugin is not active. "
282     "Please call sg_energy_plugin_init() during initialization.");
283   return host->extension<HostEnergy>()->getWattMinAt(pstate);
284 }
285 /** @brief  Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100% */
286 double sg_host_get_wattmax_at(sg_host_t host, int pstate) {
287   xbt_assert(HostEnergy::EXTENSION_ID.valid(),
288     "The Energy plugin is not active. "
289     "Please call sg_energy_plugin_init() during initialization.");
290   return host->extension<HostEnergy>()->getWattMaxAt(pstate);
291 }