Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics in the VM/energy code
[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 "energy.hpp"
8 #include "../cpu_cas01.hpp"
9
10 /** @addtogroup SURF_plugin_energy
11
12
13 This is the energy plugin, enabling to account not only for computation time,
14 but also for the dissipated energy in the simulated platform.
15
16 The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows:
17
18 \verbatim
19 <host id="HostA" power="100.0Mf" >
20     <prop id="watt_per_state" value="100.0:200.0" />
21     <prop id="watt_off" value="10" />
22 </host>
23 \endverbatim
24
25 The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts.
26 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
27 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these values are arbitrary).
28
29 If your CPU is using pstates, then you can provide one consumption interval per pstate.
30
31 \verbatim
32 <host id="HostB" power="100.0Mf,50.0Mf,20.0Mf" pstate="0" >
33     <prop id="watt_per_state" value="95.0:200.0, 93.0:170.0, 90.0:150.0" />
34     <prop id="watt_off" value="10" />
35 </host>
36 \endverbatim
37
38 That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s.
39 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.
40 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,
41 170 Watts and 150 Watts respectively.
42
43 To change the pstate of a given CPU, use the following functions: #MSG_host_get_nb_pstates(), #MSG_host_set_pstate(), #MSG_host_get_power_peak_at().
44
45 To simulate the energy-related elements, first call the #sg_energy_plugin_init() before your #MSG_init(),
46 and then use the following function to retrieve the consumption of a given host: #MSG_host_get_consumed_energy().
47  */
48
49 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
50 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_energy, surf,
51                                 "Logging specific to the SURF energy plugin");
52
53 std::map<Cpu*, CpuEnergy*> *surf_energy=NULL;
54
55 static void energyCpuCreatedCallback(Cpu *cpu){
56   (*surf_energy)[cpu] = new CpuEnergy(cpu);
57 }
58
59
60 /* Computes the consumption so far.  Called lazily on need. */
61 static void update_consumption(Cpu *cpu, CpuEnergy *cpu_energy) {
62         double cpu_load = lmm_constraint_get_usage(cpu->getConstraint()) / cpu->m_powerPeak;
63         double start_time = cpu_energy->last_updated;
64         double finish_time = surf_get_clock();
65
66         double previous_energy = cpu_energy->total_energy;
67
68         double instantaneous_consumption;
69         if (cpu->getState() == SURF_RESOURCE_OFF)
70                 instantaneous_consumption = cpu_energy->watts_off;
71         else
72                 instantaneous_consumption = cpu_energy->getCurrentWattsValue(cpu_load);
73
74         double energy_this_step = instantaneous_consumption*(finish_time-start_time);
75
76         cpu_energy->total_energy = previous_energy + energy_this_step;
77         cpu_energy->last_updated = finish_time;
78
79         XBT_DEBUG("[cpu_update_energy] period=[%.2f-%.2f]; current power peak=%.0E flop/s; consumption change: %.2f J -> %.2f J",
80                   start_time, finish_time, cpu->m_powerPeak, previous_energy, energy_this_step);
81 }
82
83 static void energyCpuDestructedCallback(Cpu *cpu){
84   std::map<Cpu*, CpuEnergy*>::iterator cpu_energy_it = surf_energy->find(cpu);
85   xbt_assert(cpu_energy_it != surf_energy->end(), "The cpu is not in surf_energy.");
86
87   CpuEnergy *cpu_energy = cpu_energy_it->second;
88   update_consumption(cpu, cpu_energy);
89
90   // Do nothing if that's a virtual CPU, only act for physical CPUs
91   if(cpu->getPhysicalCPU() == NULL){
92     XBT_INFO("Total energy of host %s: %f Joules", cpu->getName(), cpu_energy->getConsumedEnergy());
93     delete cpu_energy_it->second;
94     surf_energy->erase(cpu_energy_it);
95   }
96
97 }
98
99 static void energyCpuActionStateChangedCallback(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t cur){
100   Cpu *cpu  = getActionCpu(action);
101
102   CpuEnergy *cpu_energy = (*surf_energy)[cpu];
103
104   if(cpu_energy->last_updated < surf_get_clock())
105           update_consumption(cpu, cpu_energy);
106 }
107
108 static void energyStateChangedCallback(Cpu *cpu, e_surf_resource_state_t oldState, e_surf_resource_state_t newState){
109   CpuEnergy *cpu_energy = (*surf_energy)[cpu];
110
111   if(cpu_energy->last_updated < surf_get_clock())
112           update_consumption(cpu, cpu_energy);
113 }
114
115 static void sg_energy_plugin_exit()
116 {
117   delete surf_energy;
118   surf_energy = NULL;
119 }
120
121 /** \ingroup SURF_plugin_energy
122  * \brief Enable energy plugin
123  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before #MSG_init().
124  */
125 void sg_energy_plugin_init() {
126   if (surf_energy == NULL) {
127     surf_energy = new std::map<Cpu*, CpuEnergy*>();
128     surf_callback_connect(cpuCreatedCallbacks, energyCpuCreatedCallback);
129     surf_callback_connect(cpuDestructedCallbacks, energyCpuDestructedCallback);
130     surf_callback_connect(cpuActionStateChangedCallbacks, energyCpuActionStateChangedCallback);
131     surf_callback_connect(surfExitCallbacks, sg_energy_plugin_exit);
132     surf_callback_connect(cpuStateChangedCallbacks, energyStateChangedCallback);
133   }
134 }
135
136 /**
137  *
138  */
139 CpuEnergy::CpuEnergy(Cpu *ptr)
140 {
141   cpu = ptr;
142   total_energy = 0;
143   power_range_watts_list = getWattsRangeList();
144   last_updated = surf_get_clock();
145
146   if (cpu->getProperties() != NULL) {
147         char* off_power_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_off");
148         if (off_power_str != NULL)
149                 watts_off = atof(off_power_str);
150         else
151                 watts_off = 0;
152   }
153
154 }
155
156 CpuEnergy::~CpuEnergy(){
157   unsigned int iter;
158   xbt_dynar_t power_tuple = NULL;
159   xbt_dynar_foreach(power_range_watts_list, iter, power_tuple)
160     xbt_dynar_free(&power_tuple);
161   xbt_dynar_free(&power_range_watts_list);
162 }
163
164
165 double CpuEnergy::getWattMinAt(int pstate) {
166   xbt_dynar_t power_range_list = power_range_watts_list;
167   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
168   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
169   double min_power = xbt_dynar_get_as(current_power_values, 0, double);
170   return min_power;
171 }
172 double CpuEnergy::getWattMaxAt(int pstate) {
173   xbt_dynar_t power_range_list = power_range_watts_list;
174   xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
175   xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
176   double max_power = xbt_dynar_get_as(current_power_values, 1, double);
177   return max_power;
178 }
179
180 /**
181  * Computes the power consumed by the host according to the current pstate and processor load
182  *
183  */
184 double CpuEnergy::getCurrentWattsValue(double cpu_load)
185 {
186         xbt_dynar_t power_range_list = power_range_watts_list;
187         xbt_assert(power_range_watts_list, "No power range properties specified for host %s", cpu->getName());
188
189     /* retrieve the power values associated with the current pstate */
190     xbt_dynar_t current_power_values = xbt_dynar_get_as(power_range_list, static_cast<CpuCas01*>(cpu)->getPState(), xbt_dynar_t);
191
192     /* min_power corresponds to the idle power (cpu load = 0) */
193     /* max_power is the power consumed at 100% cpu load       */
194     double min_power = xbt_dynar_get_as(current_power_values, 0, double);
195     double max_power = xbt_dynar_get_as(current_power_values, 1, double);
196     double power_slope = max_power - min_power;
197
198     double current_power = min_power + cpu_load * power_slope;
199
200         XBT_DEBUG("[get_current_watts] min_power=%f, max_power=%f, slope=%f", min_power, max_power, power_slope);
201     XBT_DEBUG("[get_current_watts] Current power (watts) = %f, load = %f", current_power, cpu_load);
202
203         return current_power;
204 }
205
206 double CpuEnergy::getConsumedEnergy()
207 {
208
209         if(last_updated < surf_get_clock())
210                 update_consumption(cpu, this);
211         return total_energy;
212
213 }
214
215 xbt_dynar_t CpuEnergy::getWattsRangeList()
216 {
217         xbt_dynar_t power_range_list;
218         xbt_dynar_t power_tuple;
219         int i = 0, pstate_nb=0;
220         xbt_dynar_t current_power_values;
221         double min_power, max_power;
222
223         if (cpu->getProperties() == NULL)
224                 return NULL;
225
226         char* all_power_values_str = (char*)xbt_dict_get_or_null(cpu->getProperties(), "watt_per_state");
227
228         if (all_power_values_str == NULL)
229                 return NULL;
230
231
232         power_range_list = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
233         xbt_dynar_t all_power_values = xbt_str_split(all_power_values_str, ",");
234
235         pstate_nb = xbt_dynar_length(all_power_values);
236         for (i=0; i< pstate_nb; i++)
237         {
238                 /* retrieve the power values associated with the current pstate */
239                 current_power_values = xbt_str_split(xbt_dynar_get_as(all_power_values, i, char*), ":");
240                 xbt_assert(xbt_dynar_length(current_power_values) > 1,
241                                 "Power properties incorrectly defined - could not retrieve min and max power values for host %s",
242                                 cpu->getName());
243
244                 /* min_power corresponds to the idle power (cpu load = 0) */
245                 /* max_power is the power consumed at 100% cpu load       */
246                 min_power = atof(xbt_dynar_get_as(current_power_values, 0, char*));
247                 max_power = atof(xbt_dynar_get_as(current_power_values, 1, char*));
248
249                 power_tuple = xbt_dynar_new(sizeof(double), NULL);
250                 xbt_dynar_push_as(power_tuple, double, min_power);
251                 xbt_dynar_push_as(power_tuple, double, max_power);
252
253                 xbt_dynar_push_as(power_range_list, xbt_dynar_t, power_tuple);
254                 xbt_dynar_free(&current_power_values);
255         }
256         xbt_dynar_free(&all_power_values);
257         return power_range_list;
258 }