Logo AND Algorithmique Numérique Distribuée

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