1 /* Copyright (c) 2017-2022. 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/kernel/activity/CommImpl.hpp"
11 #include "src/kernel/resource/StandardLinkImpl.hpp"
12 #include "src/kernel/resource/WifiLinkImpl.hpp"
14 #include <boost/algorithm/string/classification.hpp>
15 #include <boost/algorithm/string/split.hpp>
17 SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_plugin_init);
18 /** @defgroup plugin_link_energy_wifi Plugin WiFi energy
20 * This is the WiFi energy plugin, accounting for the dissipated energy of WiFi links.
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy_wifi, kernel, "Logging specific to the link energy wifi plugin");
28 class XBT_PRIVATE LinkEnergyWifi {
29 // associative array keeping size of data already sent for a given flow (required for interleaved actions)
30 std::map<kernel::resource::WifiLinkAction*, std::pair<int, double>> flowTmp{};
32 // WiFi link the plugin instance is attached to
35 // dynamic energy accumulated since the simulation start (active durations consumption)
37 // static energy (no activity consumption)
40 // duration since previous energy update
41 double prev_update_{0.0};
43 // Same energy calibration values as ns3 by default
44 // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details
50 // constant taking beacons into account (can be specified by the user)
51 double control_duration_{0.0036};
53 // Measurements for report
54 double dur_TxRx_{0}; // Duration of transmission
55 double dur_idle_{0}; // Duration of idle time
56 bool valuesInit_{false};
59 static xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
61 explicit LinkEnergyWifi(s4u::Link* ptr) : link_(ptr) {}
62 LinkEnergyWifi() = delete;
64 /** Update the energy consumed by link_ when transmissions start or end */
67 /** Update the energy consumed when link_ is destroyed */
68 void update_destroy();
71 * Fetches energy consumption values from the platform file.
72 * The user can specify:
73 * - wifi_watt_values: energy consumption in each state (IDLE:Tx:Rx:SLEEP)
74 * default: 0.82:1.14:0.94:0.10
75 * - controlDuration: duration of active beacon transmissions per second
78 void init_watts_range_list();
80 double get_consumed_energy(void) const { return eDyn_ + eStat_; }
81 /** Get the dynamic part of the energy for this link */
82 double get_energy_dynamic(void) const { return eDyn_; }
83 double get_energy_static(void) const { return eStat_; }
84 double get_duration_comm(void) const { return dur_TxRx_; }
85 double get_duration_idle(void) const { return dur_idle_; }
87 /** Set the power consumed by this link while idle */
88 void set_power_idle(double value) { pIdle_ = value; }
89 /** Set the power consumed by this link while transmitting */
90 void set_power_tx(double value) { pTx_ = value; }
91 /** Set the power consumed by this link while receiving */
92 void set_power_rx(double value) { pRx_ = value; }
93 /** Set the power consumed by this link while sleeping */
94 void set_power_sleep(double value) { pSleep_ = value; }
97 xbt::Extension<s4u::Link, LinkEnergyWifi> LinkEnergyWifi::EXTENSION_ID;
99 void LinkEnergyWifi::update_destroy()
101 auto const* wifi_link = static_cast<kernel::resource::WifiLinkImpl*>(link_->get_impl());
102 double duration = simgrid::s4u::Engine::get_clock() - prev_update_;
103 prev_update_ = simgrid::s4u::Engine::get_clock();
105 dur_idle_ += duration;
107 // add IDLE energy usage, as well as beacons consumption since previous update
108 const auto host_count = static_cast<double>(wifi_link->get_host_count());
109 eDyn_ += duration * control_duration_ * host_count * pRx_;
110 eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (host_count + 1);
112 XBT_DEBUG("finish eStat_ += %f * %f * (%f+1) | eStat = %f", duration, pIdle_, host_count, eStat_);
115 void LinkEnergyWifi::update()
117 init_watts_range_list();
119 double duration = simgrid::s4u::Engine::get_clock() - prev_update_;
120 prev_update_ = simgrid::s4u::Engine::get_clock();
122 // we don't update for null durations
126 auto const* wifi_link = static_cast<kernel::resource::WifiLinkImpl*>(link_->get_impl());
128 const kernel::lmm::Element* elem = nullptr;
131 * We update the energy consumed by each flow active on the link since the previous update.
133 * To do this, we need to know how much time each flow has been effectively sending data on the WiFi link since the
134 * previous update (durUsage). We compute this value using the size of the flow, the amount of data already spent
135 * (using flowTmp), as well as the bandwidth used by the flow since the previous update (using LMM variables). Since
136 * flows are sharing the medium, the total active duration on the link is equal to the transmission/reception duration
137 * used by the flow with the longest active time since the previous update
140 while (const auto* var = wifi_link->get_constraint()->get_variable(&elem)) {
141 auto* action = static_cast<kernel::resource::WifiLinkAction*>(var->get_id());
142 XBT_DEBUG("cost: %f action value: %f link rate 1: %f link rate 2: %f", action->get_cost(), action->get_rate(),
143 wifi_link->get_host_rate(&action->get_src()), wifi_link->get_host_rate(&action->get_dst()));
145 if (action->get_rate() != 0.0) {
146 auto it = flowTmp.find(action);
148 // if the flow has not been registered, initialize it: 0 bytes sent, and not updated since its creation timestamp
149 if(it == flowTmp.end())
150 flowTmp[action] = std::pair<int,double>(0, action->get_start_time());
152 it = flowTmp.find(action);
155 * The active duration of the link is equal to the amount of data it had to send divided by the bandwidth on the link.
156 * If this is longer than the duration since the previous update, active duration = now - previous_update
158 double du = // durUsage on the current flow
159 (action->get_cost() - it->second.first) / action->get_rate();
161 if (du > simgrid::s4u::Engine::get_clock() - it->second.second)
162 du = simgrid::s4u::Engine::get_clock() - it->second.second;
164 // if the flow has been more active than the others
168 // update the amount of data already sent by the flow
169 it->second.first += du * action->get_rate();
170 it->second.second = simgrid::s4u::Engine::get_clock();
172 // important: if the transmission finished, remove it (needed for performance and multi-message flows)
173 if(it->second.first >= action->get_cost())
178 XBT_DEBUG("durUsage: %f", durUsage);
181 const auto host_count = static_cast<double>(wifi_link->get_host_count());
182 eDyn_ += duration * control_duration_ * host_count * pRx_;
185 * Same principle as ns3:
186 * - if tx or rx, update P_{dyn}
187 * - if idle i.e. get_usage = 0, update P_{stat}
188 * P_{tot} = P_{dyn}+P_{stat}
190 if (link_->get_usage() != 0.0) {
191 eDyn_ += /*duration * */ durUsage * ((host_count * pRx_) + pTx_);
192 eStat_ += (duration - durUsage) * pIdle_ * (host_count + 1);
193 XBT_DEBUG("eDyn += %f * ((%f * %f) + %f) | eDyn = %f (durusage =%f)", durUsage, host_count, pRx_, pTx_, eDyn_,
195 dur_TxRx_ += duration;
197 dur_idle_ += duration;
198 eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (host_count + 1);
201 XBT_DEBUG("eStat_ += %f * %f * (%f+1) | eStat = %f", duration, pIdle_, host_count, eStat_);
204 void LinkEnergyWifi::init_watts_range_list()
211 Set to 0 if you do not want to compute beacons,
212 otherwise to the duration of beacons transmissions per second
214 if (const char* beacons_factor = this->link_->get_property("control_duration")) {
216 control_duration_ = std::stod(beacons_factor);
217 } catch (const std::invalid_argument&) {
218 throw std::invalid_argument(std::string("Invalid beacons factor value for link ") + this->link_->get_cname());
222 const char* all_power_values_str = this->link_->get_property("wifi_watt_values");
223 if (all_power_values_str != nullptr)
225 std::vector<std::string> all_power_values;
226 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
228 for (auto current_power_values_str : all_power_values) {
229 /* retrieve the power values associated */
230 std::vector<std::string> current_power_values;
231 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
232 xbt_assert(current_power_values.size() == 4,
233 "Power properties incorrectly defined - could not retrieve idle, Tx, Rx, Sleep power values for link %s",
234 this->link_->get_cname());
236 /* min_power corresponds to the idle power (link load = 0) */
237 /* max_power is the power consumed at 100% link load */
239 pSleep_ = std::stod(current_power_values.at(3));
240 } catch (const std::invalid_argument&) {
241 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
244 pRx_ = std::stod(current_power_values.at(2));
245 } catch (const std::invalid_argument&) {
246 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
249 pTx_ = std::stod(current_power_values.at(1));
250 } catch (const std::invalid_argument&) {
251 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
254 pIdle_ = std::stod(current_power_values.at(0));
255 } catch (const std::invalid_argument&) {
256 throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
259 XBT_DEBUG("Values aa initialized with: pSleep=%f pIdle=%f pTx=%f pRx=%f", pSleep_, pIdle_, pTx_, pRx_);
264 } // namespace plugin
265 } // namespace simgrid
267 using simgrid::plugin::LinkEnergyWifi;
268 /* **************************** events callback *************************** */
269 static void on_communication(const simgrid::kernel::activity::CommImpl& comm)
271 for (const auto* link : comm.get_traversed_links()) {
272 if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
273 auto* link_energy = link->extension<LinkEnergyWifi>();
274 XBT_DEBUG("Update %s on Comm Start/End", link->get_cname());
275 link_energy->update();
280 void sg_wifi_energy_plugin_init()
282 if (LinkEnergyWifi::EXTENSION_ID.valid())
285 XBT_INFO("Activating the wifi_energy plugin.");
286 LinkEnergyWifi::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergyWifi>();
289 * Attaching to events:
290 * - Link::on_creation to initialize the plugin
291 * - Link::on_destruction to produce final energy results
292 * - Link::on_communication_state_change: to account for the energy when communications are updated
293 * - CommImpl::on_start and CommImpl::on_completion: to account for the energy during communications
295 simgrid::s4u::Link::on_creation_cb([](simgrid::s4u::Link& link) {
296 // verify the link is appropriate to WiFi energy computations
297 if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
298 XBT_DEBUG("Wifi Link: %s, initialization of wifi energy plugin", link.get_cname());
299 auto* plugin = new LinkEnergyWifi(&link);
300 link.extension_set(plugin);
302 XBT_DEBUG("Not Wifi Link: %s, wifi energy on link not computed", link.get_cname());
306 simgrid::s4u::Link::on_destruction_cb([](simgrid::s4u::Link const& link) {
307 // output energy values if WiFi link
308 if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
309 link.extension<LinkEnergyWifi>()->update_destroy();
311 "Link %s destroyed, consumed: %f J dyn: %f stat: %f durIdle: %f durTxRx: %f", link.get_cname(),
312 link.extension<LinkEnergyWifi>()->get_consumed_energy(),
313 link.extension<LinkEnergyWifi>()->get_energy_dynamic(), link.extension<LinkEnergyWifi>()->get_energy_static(),
314 link.extension<LinkEnergyWifi>()->get_duration_idle(), link.extension<LinkEnergyWifi>()->get_duration_comm());
318 simgrid::s4u::Link::on_communication_state_change_cb([](simgrid::kernel::resource::NetworkAction const& action,
319 simgrid::kernel::resource::Action::State /* previous */) {
320 // update WiFi links encountered during the communication
321 for (auto const* link : action.get_links()) {
322 if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
323 link->get_iface()->extension<LinkEnergyWifi>()->update();
328 simgrid::kernel::activity::CommImpl::on_start.connect(&on_communication);
329 simgrid::kernel::activity::CommImpl::on_completion.connect(&on_communication);