1 /* Copyright (c) 2017-2021. The SimGrid Team. All rights reserved. */
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. */
6 #include <simgrid/plugins/energy.h>
7 #include <simgrid/s4u/Engine.hpp>
8 #include <simgrid/s4u/Link.hpp>
10 #include "src/surf/network_interface.hpp"
11 #include "src/surf/network_wifi.hpp"
13 #include <boost/algorithm/string/classification.hpp>
14 #include <boost/algorithm/string/split.hpp>
16 SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_plugin_init);
17 /** @defgroup plugin_link_energy_wifi Plugin WiFi energy
19 * This is the WiFi energy plugin, accounting for the dissipated energy of WiFi links.
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy_wifi, surf, "Logging specific to the link energy wifi plugin");
27 class XBT_PRIVATE LinkEnergyWifi {
28 // associative array keeping size of data already sent for a given flow (required for interleaved actions)
29 std::map<kernel::resource::NetworkWifiAction*, std::pair<int, double>> flowTmp{};
31 // WiFi link the plugin instance is attached to
34 // dynamic energy accumulated since the simulation start (active durations consumption)
36 // static energy (no activity consumption)
39 // duration since previous energy update
40 double prev_update_{0.0};
42 // Same energy calibration values as ns3 by default
43 // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details
49 // constant taking beacons into account (can be specified by the user)
50 double control_duration_{0.0036};
52 // Measurements for report
53 double dur_TxRx_{0}; // Duration of transmission
54 double dur_idle_{0}; // Duration of idle time
55 bool valuesInit_{false};
58 static xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
60 explicit LinkEnergyWifi(s4u::Link* ptr) : link_(ptr) {}
61 LinkEnergyWifi() = delete;
63 /** Update the energy consumed by link_ when transmissions start or end */
64 void update(const simgrid::kernel::resource::NetworkAction &);
66 /** Update the energy consumed when link_ is destroyed */
67 void update_destroy();
70 * Fetches energy consumption values from the platform file.
71 * The user can specify:
72 * - wifi_watt_values: energy consumption in each state (IDLE:Tx:Rx:SLEEP)
73 * default: 0.82:1.14:0.94:0.10
74 * - controlDuration: duration of active beacon transmissions per second
77 void init_watts_range_list();
79 double get_consumed_energy(void) const { return eDyn_ + eStat_; }
80 /** Get the dynamic part of the energy for this link */
81 double get_energy_dynamic(void) const { return eDyn_; }
82 double get_energy_static(void) const { return eStat_; }
83 double get_duration_comm(void) const { return dur_TxRx_; }
84 double get_duration_idle(void) const { return dur_idle_; }
86 /** Set the power consumed by this link while idle */
87 void set_power_idle(double value) { pIdle_ = value; }
88 /** Set the power consumed by this link while transmitting */
89 void set_power_tx(double value) { pTx_ = value; }
90 /** Set the power consumed by this link while receiving */
91 void set_power_rx(double value) { pRx_ = value; }
92 /** Set the power consumed by this link while sleeping */
93 void set_power_sleep(double value) { pSleep_ = value; }
96 xbt::Extension<s4u::Link, LinkEnergyWifi> LinkEnergyWifi::EXTENSION_ID;
98 void LinkEnergyWifi::update_destroy()
100 auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
101 double duration = simgrid::s4u::Engine::get_clock() - prev_update_;
102 prev_update_ = simgrid::s4u::Engine::get_clock();
104 dur_idle_ += duration;
106 // add IDLE energy usage, as well as beacons consumption since previous update
107 eDyn_ += duration * control_duration_ * wifi_link->get_host_count() * pRx_;
108 eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1);
110 XBT_DEBUG("finish eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_);
113 void LinkEnergyWifi::update(const kernel::resource::NetworkAction&)
115 init_watts_range_list();
117 double duration = simgrid::s4u::Engine::get_clock() - prev_update_;
118 prev_update_ = simgrid::s4u::Engine::get_clock();
120 // we don't update for null durations
124 auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
126 const kernel::lmm::Element* elem = nullptr;
129 * We update the energy consumed by each flow active on the link since the previous update.
131 * To do this, we need to know how much time each flow has been effectively sending data on the WiFi link since the
132 * previous update (durUsage). We compute this value using the size of the flow, the amount of data already spent
133 * (using flowTmp), as well as the bandwidth used by the flow since the previous update (using LMM variables). Since
134 * flows are sharing the medium, the total active duration on the link is equal to the transmission/reception duration
135 * used by the flow with the longest active time since the previous update
138 while (const auto* var = wifi_link->get_constraint()->get_variable(&elem)) {
139 auto* action = static_cast<kernel::resource::NetworkWifiAction*>(var->get_id());
140 XBT_DEBUG("cost: %f action value: %f link rate 1: %f link rate 2: %f", action->get_cost(), action->get_rate(),
141 wifi_link->get_host_rate(&action->get_src()), wifi_link->get_host_rate(&action->get_dst()));
143 if (action->get_rate() != 0.0) {
144 auto it = flowTmp.find(action);
146 // if the flow has not been registered, initialize it: 0 bytes sent, and not updated since its creation timestamp
147 if(it == flowTmp.end())
148 flowTmp[action] = std::pair<int,double>(0, action->get_start_time());
150 it = flowTmp.find(action);
153 * The active duration of the link is equal to the amount of data it had to send divided by the bandwidth on the link.
154 * If this is longer than the duration since the previous update, active duration = now - previous_update
156 double du = // durUsage on the current flow
157 (action->get_cost() - it->second.first) / action->get_rate();
159 if (du > simgrid::s4u::Engine::get_clock() - it->second.second)
160 du = simgrid::s4u::Engine::get_clock() - it->second.second;
162 // if the flow has been more active than the others
166 // update the amount of data already sent by the flow
167 it->second.first += du * action->get_rate();
168 it->second.second = simgrid::s4u::Engine::get_clock();
170 // important: if the transmission finished, remove it (needed for performance and multi-message flows)
171 if(it->second.first >= action->get_cost())
176 XBT_DEBUG("durUsage: %f", durUsage);
179 eDyn_ += duration * control_duration_ * wifi_link->get_host_count() * pRx_;
182 * Same principle as ns3:
183 * - if tx or rx, update P_{dyn}
184 * - if idle i.e. get_usage = 0, update P_{stat}
185 * P_{tot} = P_{dyn}+P_{stat}
187 if (link_->get_usage() != 0.0) {
188 eDyn_ += /*duration * */ durUsage * ((wifi_link->get_host_count() * pRx_) + pTx_);
189 eStat_ += (duration - durUsage) * pIdle_ * (wifi_link->get_host_count() + 1);
190 XBT_DEBUG("eDyn += %f * ((%d * %f) + %f) | eDyn = %f (durusage =%f)", durUsage, wifi_link->get_host_count(), pRx_,
191 pTx_, eDyn_, durUsage);
192 dur_TxRx_ += duration;
194 dur_idle_ += duration;
195 eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1);
198 XBT_DEBUG("eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_);
201 void LinkEnergyWifi::init_watts_range_list()
208 Set to 0 if you do not want to compute beacons,
209 otherwise to the duration of beacons transmissions per second
211 const char* beacons_factor = this->link_->get_property("control_duration");
212 if(beacons_factor != nullptr) {
214 control_duration_ = std::stod(beacons_factor);
215 } catch (const std::invalid_argument&) {
216 throw std::invalid_argument(std::string("Invalid beacons factor value for link ") + this->link_->get_cname());
220 const char* all_power_values_str = this->link_->get_property("wifi_watt_values");
221 if (all_power_values_str != nullptr)
223 std::vector<std::string> all_power_values;
224 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
226 for (auto current_power_values_str : all_power_values) {
227 /* retrieve the power values associated */
228 std::vector<std::string> current_power_values;
229 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
230 xbt_assert(current_power_values.size() == 4,
231 "Power properties incorrectly defined - could not retrieve idle, Tx, Rx, Sleep power values for link %s",
232 this->link_->get_cname());
234 /* min_power corresponds to the idle power (link load = 0) */
235 /* max_power is the power consumed at 100% link load */
237 pSleep_ = std::stod(current_power_values.at(3));
238 } catch (const std::invalid_argument&) {
239 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
242 pRx_ = std::stod(current_power_values.at(2));
243 } catch (const std::invalid_argument&) {
244 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
247 pTx_ = std::stod(current_power_values.at(1));
248 } catch (const std::invalid_argument&) {
249 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
252 pIdle_ = std::stod(current_power_values.at(0));
253 } catch (const std::invalid_argument&) {
254 throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
257 XBT_DEBUG("Values aa initialized with: pSleep=%f pIdle=%f pTx=%f pRx=%f", pSleep_, pIdle_, pTx_, pRx_);
262 } // namespace plugin
263 } // namespace simgrid
265 using simgrid::plugin::LinkEnergyWifi;
267 void sg_wifi_energy_plugin_init()
269 if (LinkEnergyWifi::EXTENSION_ID.valid())
272 XBT_INFO("Activating the wifi_energy plugin.");
273 LinkEnergyWifi::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergyWifi>();
276 * Attaching to events:
277 * - on_creation to initialize the plugin
278 * - on_destruction to produce final energy results
279 * - on_communication_state_change: to account the energy when communications are updated
280 * - on_communicate: ''
282 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
283 // verify the link is appropriate to WiFi energy computations
284 if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
285 XBT_DEBUG("Wifi Link: %s, initialization of wifi energy plugin", link.get_cname());
286 auto* plugin = new LinkEnergyWifi(&link);
287 link.extension_set(plugin);
289 XBT_DEBUG("Not Wifi Link: %s, wifi energy on link not computed", link.get_cname());
293 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
294 // output energy values if WiFi link
295 if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
296 link.extension<LinkEnergyWifi>()->update_destroy();
298 "Link %s destroyed, consumed: %f J dyn: %f stat: %f durIdle: %f durTxRx: %f", link.get_cname(),
299 link.extension<LinkEnergyWifi>()->get_consumed_energy(),
300 link.extension<LinkEnergyWifi>()->get_energy_dynamic(), link.extension<LinkEnergyWifi>()->get_energy_static(),
301 link.extension<LinkEnergyWifi>()->get_duration_idle(), link.extension<LinkEnergyWifi>()->get_duration_comm());
305 simgrid::s4u::Link::on_communication_state_change.connect(
306 [](simgrid::kernel::resource::NetworkAction const& action,
307 simgrid::kernel::resource::Action::State /* previous */) {
308 // update WiFi links encountered during the communication
309 for (auto const* link : action.get_links()) {
310 if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
311 link->get_iface()->extension<LinkEnergyWifi>()->update(action);
316 simgrid::s4u::Link::on_communicate.connect([](const simgrid::kernel::resource::NetworkAction& action) {
317 auto const* actionWifi = dynamic_cast<const simgrid::kernel::resource::NetworkWifiAction*>(&action);
319 if (actionWifi == nullptr)
322 auto const* link_src = actionWifi->get_src_link();
323 auto const* link_dst = actionWifi->get_dst_link();
325 if(link_src != nullptr)
326 link_src->get_iface()->extension<LinkEnergyWifi>()->update(action);
327 if(link_dst != nullptr)
328 link_dst->get_iface()->extension<LinkEnergyWifi>()->update(action);