Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Allow to register plugins from their file, w/o touching the core implem
[simgrid.git] / src / plugins / link_energy.cpp
1 /* Copyright (c) 2017-2018. 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/s4u/Engine.hpp"
8 #include "src/surf/network_interface.hpp"
9 #include "src/surf/surf_interface.hpp"
10 #include "surf/surf.hpp"
11
12 #include <boost/algorithm/string/classification.hpp>
13 #include <boost/algorithm/string/split.hpp>
14
15 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
16
17 /** @addtogroup SURF_plugin_energy
18
19
20  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
21
22  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
23  platform file as follows:
24
25  \verbatim
26  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
27  <prop id="watt_range" value="100.0:200.0" />
28  <prop id="watt_off" value="10" />
29  </link>
30  \endverbatim
31
32  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
33  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
34  The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
35  values are arbitrary).
36
37  To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
38  #MSG_init(),
39  and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
40  */
41
42 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
43
44 namespace simgrid {
45 namespace plugin {
46
47 class LinkEnergy {
48 public:
49   static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
50
51   explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
52   ~LinkEnergy() = default;
53
54   void init_watts_range_list();
55   double get_consumed_energy();
56   void update();
57
58 private:
59   double get_power();
60
61   simgrid::s4u::Link* link_{};
62
63   bool inited_{false};
64   double idle_{0.0};
65   double busy_{0.0};
66
67   double total_energy_{0.0};
68   double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
69 };
70
71 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
72
73 void LinkEnergy::update()
74 {
75   double power = get_power();
76   double now   = surf_get_clock();
77   total_energy_ += power * (now - last_updated_);
78   last_updated_ = now;
79 }
80
81 void LinkEnergy::init_watts_range_list()
82 {
83
84   if (inited_)
85     return;
86   inited_ = true;
87
88   const char* all_power_values_str = this->link_->get_property("watt_range");
89
90   if (all_power_values_str == nullptr)
91     return;
92
93   std::vector<std::string> all_power_values;
94   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
95
96   for (auto current_power_values_str : all_power_values) {
97     /* retrieve the power values associated */
98     std::vector<std::string> current_power_values;
99     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
100     xbt_assert(current_power_values.size() == 2,
101                "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
102                this->link_->get_cname());
103
104     /* min_power corresponds to the idle power (link load = 0) */
105     /* max_power is the power consumed at 100% link load       */
106     char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->get_cname());
107     char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->get_cname());
108
109     idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
110     busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
111
112     xbt_free(idleMsg);
113     xbt_free(busyMsg);
114     update();
115   }
116 }
117
118 double LinkEnergy::get_power()
119 {
120
121   if (!inited_)
122     return 0.0;
123
124   double power_slope = busy_ - idle_;
125
126   double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
127   double dynamic_power         = power_slope * normalized_link_usage;
128
129   return idle_ + dynamic_power;
130 }
131
132 double LinkEnergy::get_consumed_energy()
133 {
134   if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
135     simgrid::simix::simcall(std::bind(&LinkEnergy::update, this));
136   return this->total_energy_;
137 }
138 } // namespace plugin
139 } // namespace simgrid
140
141 using simgrid::plugin::LinkEnergy;
142
143 /* **************************** events  callback *************************** */
144 static void on_communicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host*, simgrid::s4u::Host*)
145 {
146   XBT_DEBUG("onCommunicate is called");
147   for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
148
149     if (link == nullptr)
150       continue;
151
152     XBT_DEBUG("Update link %s", link->get_cname());
153     LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
154     link_energy->init_watts_range_list();
155     link_energy->update();
156   }
157 }
158
159 static void on_simulation_end()
160 {
161   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
162
163   double total_energy = 0.0; // Total dissipated energy (whole platform)
164   for (const auto link : links) {
165     double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
166     total_energy += link_energy;
167   }
168
169   XBT_INFO("Total energy over all links: %f", total_energy);
170 }
171 /* **************************** Public interface *************************** */
172
173 int sg_link_energy_is_inited()
174 {
175   return LinkEnergy::EXTENSION_ID.valid();
176 }
177 /** \ingroup SURF_plugin_energy
178  * \brief Enable energy plugin
179  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before
180  * #MSG_init().
181  */
182 void sg_link_energy_plugin_init()
183 {
184
185   if (LinkEnergy::EXTENSION_ID.valid())
186     return;
187   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
188
189   xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
190
191   simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
192
193   simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link& link) { link.extension<LinkEnergy>()->update(); });
194
195   simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link& link) {
196     if (strcmp(link.get_cname(), "__loopback__"))
197       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
198                link.extension<LinkEnergy>()->get_consumed_energy());
199   });
200
201   simgrid::s4u::Link::on_communication_state_change.connect([](simgrid::kernel::resource::NetworkAction* action) {
202     for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
203       if (link != nullptr)
204         link->piface_.extension<LinkEnergy>()->update();
205     }
206   });
207
208   simgrid::s4u::Link::on_communicate.connect(&on_communicate);
209   simgrid::s4u::on_simulation_end.connect(&on_simulation_end);
210 }
211
212 /** @ingroup plugin_energy
213  *  @brief Returns the total energy consumed by the link so far (in Joules)
214  *
215  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
216  *  The result is that the actor requesting this value will be interrupted,
217  *  the value will be updated in kernel mode before returning the control to the requesting actor.
218  */
219 double sg_link_get_consumed_energy(sg_link_t link)
220 {
221   return link->extension<LinkEnergy>()->get_consumed_energy();
222 }