src/plugins/link_energy_wifi.cpp

   1 /* Copyright (c) 2017-2021. 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/Exception.hpp"
   7 #include "simgrid/plugins/energy.h"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "simgrid/s4u/Link.hpp"
  11 #include "src/surf/network_interface.hpp"
  12 #include "src/surf/network_wifi.hpp"
  13 #include "src/surf/surf_interface.hpp"
  14 #include "surf/surf.hpp"
  15 #include "src/kernel/lmm/maxmin.hpp"
  16 #include "xbt/config.hpp"
  17
  18 #include <boost/algorithm/string/classification.hpp>
  19 #include <boost/algorithm/string/split.hpp>
  20 #include <map>
  21
  22 SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_plugin_init);
  23 /** @defgroup plugin_link_energy_wifi Plugin WiFi energy
  24  *
  25  * This is the WiFi energy plugin, accounting for the dissipated energy of WiFi links.
  26  */
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy_wifi, surf, "Logging specific to the link energy wifi plugin");
  29
  30 namespace simgrid {
  31 namespace plugin {
  32
  33 class XBT_PRIVATE LinkEnergyWifi {
  34   // associative array keeping size of data already sent for a given flow (required for interleaved actions)
  35   std::map<kernel::resource::NetworkWifiAction*, std::pair<int, double>> flowTmp{};
  36
  37   // WiFi link the plugin instance is attached to
  38   s4u::Link* link_{};
  39
  40   // dynamic energy accumulated since the simulation start (active durations consumption)
  41   double eDyn_{0.0};
  42   // static energy (no activity consumption)
  43   double eStat_{0.0};
  44
  45   // duration since previous energy update
  46   double prev_update_{0.0};
  47
  48   // Same energy calibration values as ns3 by default
  49   // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details
  50   double pIdle_{0.82};
  51   double pTx_{1.14};
  52   double pRx_{0.94};
  53   double pSleep_{0.10};
  54
  55   // constant taking beacons into account (can be specified by the user)
  56   double control_duration_{0.0036};
  57
  58   // Measurements for report
  59   double dur_TxRx_{0}; // Duration of transmission
  60   double dur_idle_{0}; // Duration of idle time
  61   bool valuesInit_{false};
  62
  63 public:
  64   static xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
  65
  66   explicit LinkEnergyWifi(s4u::Link* ptr) : link_(ptr) {}
  67   LinkEnergyWifi()  = delete;
  68
  69   /** Update the energy consumed by link_ when transmissions start or end */
  70   void update(const simgrid::kernel::resource::NetworkAction &);
  71
  72   /** Update the energy consumed when link_ is destroyed */
  73   void update_destroy();
  74
  75   /**
  76    * Fetches energy consumption values from the platform file.
  77    * The user can specify:
  78    *  - wifi_watt_values: energy consumption in each state (IDLE:Tx:Rx:SLEEP)
  79    *      default: 0.82:1.14:0.94:0.10
  80    *  - controlDuration: duration of active beacon transmissions per second
  81    *      default: 0.0036
  82    */
  83   void init_watts_range_list();
  84
  85   double get_consumed_energy(void) const { return eDyn_ + eStat_; }
  86   /** Get the dynamic part of the energy for this link */
  87   double get_energy_dynamic(void) const { return eDyn_; }
  88   double get_energy_static(void) const { return eStat_; }
  89   double get_duration_comm(void) const { return dur_TxRx_; }
  90   double get_duration_idle(void) const { return dur_idle_; }
  91
  92   /** Set the power consumed by this link while idle */
  93   void set_power_idle(double value) { pIdle_ = value; }
  94   /** Set the power consumed by this link while transmitting */
  95   void set_power_tx(double value) { pTx_ = value; }
  96   /** Set the power consumed by this link while receiving */
  97   void set_power_rx(double value) { pRx_ = value; }
  98   /** Set the power consumed by this link while sleeping */
  99   void set_power_sleep(double value) { pSleep_ = value; }
 100 };
 101
 102 xbt::Extension<s4u::Link, LinkEnergyWifi> LinkEnergyWifi::EXTENSION_ID;
 103
 104 void LinkEnergyWifi::update_destroy()
 105 {
 106   auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
 107   double duration       = surf_get_clock() - prev_update_;
 108   prev_update_          = surf_get_clock();
 109
 110   dur_idle_ += duration;
 111
 112   // add IDLE energy usage, as well as beacons consumption since previous update
 113   eDyn_ += duration * control_duration_ * wifi_link->get_host_count() * pRx_;
 114   eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1);
 115
 116   XBT_DEBUG("finish eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_);
 117 }
 118
 119 void LinkEnergyWifi::update(const kernel::resource::NetworkAction&)
 120 {
 121   init_watts_range_list();
 122
 123   double duration = surf_get_clock() - prev_update_;
 124   prev_update_    = surf_get_clock();
 125
 126   // we don't update for null durations
 127   if(duration < 1e-6)
 128     return;
 129
 130   auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
 131
 132   const kernel::lmm::Element* elem = nullptr;
 133
 134   /**
 135    * We update the energy consumed by each flow active on the link since the previous update.
 136    *
 137    * To do this, we need to know how much time each flow has been effectively sending data on the WiFi link since the
 138    * previous update (durUsage).  We compute this value using the size of the flow, the amount of data already spent
 139    * (using flowTmp), as well as the bandwidth used by the flow since the previous update (using LMM variables).  Since
 140    * flows are sharing the medium, the total active duration on the link is equal to the transmission/reception duration
 141    * used by the flow with the longest active time since the previous update
 142    */
 143   double durUsage = 0;
 144   while (const auto* var = wifi_link->get_constraint()->get_variable(&elem)) {
 145     auto* action = static_cast<kernel::resource::NetworkWifiAction*>(var->get_id());
 146     XBT_DEBUG("cost: %f action value: %f link rate 1: %f link rate 2: %f", action->get_cost(),
 147               action->get_variable()->get_value(), wifi_link->get_host_rate(&action->get_src()),
 148               wifi_link->get_host_rate(&action->get_dst()));
 149
 150     if (action->get_variable()->get_value() != 0.0) {
 151       auto it = flowTmp.find(action);
 152
 153       // if the flow has not been registered, initialize it: 0 bytes sent, and not updated since its creation timestamp
 154       if(it == flowTmp.end())
 155         flowTmp[action] = std::pair<int,double>(0, action->get_start_time());
 156
 157       it = flowTmp.find(action);
 158
 159       /**
 160        * The active duration of the link is equal to the amount of data it had to send divided by the bandwidth on the link.
 161        * If this is longer than the duration since the previous update, active duration = now - previous_update
 162        */
 163       double du = // durUsage on the current flow
 164           (action->get_cost() - it->second.first) / action->get_variable()->get_value();
 165
 166       if(du > surf_get_clock()-it->second.second)
 167         du = surf_get_clock()-it->second.second;
 168
 169       // if the flow has been more active than the others
 170       if(du > durUsage)
 171         durUsage = du;
 172
 173       // update the amount of data already sent by the flow
 174       it->second.first += du*action->get_variable()->get_value();
 175       it->second.second =  surf_get_clock();
 176
 177       // important: if the transmission finished, remove it (needed for performance and multi-message flows)
 178       if(it->second.first >= action->get_cost())
 179         flowTmp.erase (it);
 180     }
 181   }
 182
 183   XBT_DEBUG("durUsage: %f", durUsage);
 184
 185   // beacons cost
 186   eDyn_ += duration * control_duration_ * wifi_link->get_host_count() * pRx_;
 187
 188   /**
 189    * Same principle as ns3:
 190    *  - if tx or rx, update P_{dyn}
 191    *  - if idle i.e. get_usage = 0, update P_{stat}
 192    * P_{tot} = P_{dyn}+P_{stat}
 193    */
 194   if (link_->get_usage() != 0.0) {
 195     eDyn_ += /*duration * */ durUsage * ((wifi_link->get_host_count() * pRx_) + pTx_);
 196     eStat_ += (duration - durUsage) * pIdle_ * (wifi_link->get_host_count() + 1);
 197     XBT_DEBUG("eDyn +=  %f * ((%d * %f) + %f) | eDyn = %f (durusage =%f)", durUsage, wifi_link->get_host_count(), pRx_,
 198               pTx_, eDyn_, durUsage);
 199     dur_TxRx_ += duration;
 200   } else {
 201     dur_idle_ += duration;
 202     eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1);
 203   }
 204
 205   XBT_DEBUG("eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_);
 206 }
 207
 208 void LinkEnergyWifi::init_watts_range_list()
 209 {
 210   if (valuesInit_)
 211     return;
 212   valuesInit_                      = true;
 213
 214   /* beacons factor
 215   Set to 0 if you do not want to compute beacons,
 216   otherwise to the duration of beacons transmissions per second
 217   */
 218   const char* beacons_factor = this->link_->get_property("control_duration");
 219   if(beacons_factor != nullptr) {
 220     try {
 221       control_duration_ = std::stod(beacons_factor);
 222     } catch (const std::invalid_argument&) {
 223       throw std::invalid_argument(std::string("Invalid beacons factor value for link ") + this->link_->get_cname());
 224     }
 225   }
 226
 227   const char* all_power_values_str = this->link_->get_property("wifi_watt_values");
 228   if (all_power_values_str != nullptr)
 229   {
 230     std::vector<std::string> all_power_values;
 231     boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
 232
 233     for (auto current_power_values_str : all_power_values) {
 234       /* retrieve the power values associated */
 235       std::vector<std::string> current_power_values;
 236       boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
 237       xbt_assert(current_power_values.size() == 4,
 238                 "Power properties incorrectly defined - could not retrieve idle, Tx, Rx, Sleep power values for link %s",
 239                 this->link_->get_cname());
 240
 241       /* min_power corresponds to the idle power (link load = 0) */
 242       /* max_power is the power consumed at 100% link load       */
 243       try {
 244         pSleep_ = std::stod(current_power_values.at(3));
 245       } catch (const std::invalid_argument&) {
 246         throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
 247       }
 248       try {
 249         pRx_ = std::stod(current_power_values.at(2));
 250       } catch (const std::invalid_argument&) {
 251         throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
 252       }
 253       try {
 254         pTx_ = std::stod(current_power_values.at(1));
 255       } catch (const std::invalid_argument&) {
 256         throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
 257       }
 258       try {
 259         pIdle_ = std::stod(current_power_values.at(0));
 260       } catch (const std::invalid_argument&) {
 261         throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
 262       }
 263
 264       XBT_DEBUG("Values aa initialized with: pSleep=%f pIdle=%f pTx=%f pRx=%f", pSleep_, pIdle_, pTx_, pRx_);
 265     }
 266   }
 267 }
 268
 269 } // namespace plugin
 270 } // namespace simgrid
 271
 272 using simgrid::plugin::LinkEnergyWifi;
 273
 274 void sg_wifi_energy_plugin_init()
 275 {
 276   if (LinkEnergyWifi::EXTENSION_ID.valid())
 277     return;
 278
 279   XBT_INFO("Activating the wifi_energy plugin.");
 280   LinkEnergyWifi::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergyWifi>();
 281
 282   /**
 283    * Attaching to events:
 284    * - on_creation to initialize the plugin
 285    * - on_destruction to produce final energy results
 286    * - on_communication_state_change: to account the energy when communications are updated
 287    * - on_communicate: ''
 288    */
 289   simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
 290     // verify the link is appropriate to WiFi energy computations
 291     if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
 292       XBT_DEBUG("Wifi Link: %s, initialization of wifi energy plugin", link.get_cname());
 293       auto* plugin = new LinkEnergyWifi(&link);
 294       link.extension_set(plugin);
 295     } else {
 296       XBT_DEBUG("Not Wifi Link: %s, wifi energy on link not computed", link.get_cname());
 297     }
 298   });
 299
 300   simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
 301     // output energy values if WiFi link
 302     if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
 303       link.extension<LinkEnergyWifi>()->update_destroy();
 304       XBT_INFO(
 305           "Link %s destroyed, consumed: %f J dyn: %f stat: %f durIdle: %f durTxRx: %f", link.get_cname(),
 306           link.extension<LinkEnergyWifi>()->get_consumed_energy(),
 307           link.extension<LinkEnergyWifi>()->get_energy_dynamic(), link.extension<LinkEnergyWifi>()->get_energy_static(),
 308           link.extension<LinkEnergyWifi>()->get_duration_idle(), link.extension<LinkEnergyWifi>()->get_duration_comm());
 309     }
 310   });
 311
 312   simgrid::s4u::Link::on_communication_state_change.connect(
 313       [](simgrid::kernel::resource::NetworkAction const& action,
 314          simgrid::kernel::resource::Action::State /* previous */) {
 315         // update WiFi links encountered during the communication
 316         for (auto const* link : action.get_links()) {
 317           if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
 318             link->get_iface()->extension<LinkEnergyWifi>()->update(action);
 319           }
 320         }
 321       });
 322
 323   simgrid::s4u::Link::on_communicate.connect([](const simgrid::kernel::resource::NetworkAction& action) {
 324     auto const* actionWifi = dynamic_cast<const simgrid::kernel::resource::NetworkWifiAction*>(&action);
 325
 326     if (actionWifi == nullptr)
 327       return;
 328
 329     auto const* link_src = actionWifi->get_src_link();
 330     auto const* link_dst = actionWifi->get_dst_link();
 331
 332     if(link_src != nullptr)
 333       link_src->get_iface()->extension<LinkEnergyWifi>()->update(action);
 334     if(link_dst != nullptr)
 335       link_dst->get_iface()->extension<LinkEnergyWifi>()->update(action);
 336   });
 337 }