src/plugins/link_energy_wifi.cpp

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