Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / src / plugins / link_energy_wifi.cpp
index 13a8f49..9396746 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -20,7 +20,7 @@
 #include <map>
 
 SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_plugin_init);
-/** @degroup plugin_link_energy_wifi Plugin WiFi energy
+/** @defgroup plugin_link_energy_wifi Plugin WiFi energy
  *
  * This is the WiFi energy plugin, accounting for the dissipated energy of WiFi links.
  */
@@ -31,22 +31,45 @@ namespace simgrid {
 namespace plugin {
 
 class XBT_PRIVATE LinkEnergyWifi {
-public:
-  static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
+  // associative array keeping size of data already sent for a given flow (required for interleaved actions)
+  std::map<kernel::resource::NetworkWifiAction*, std::pair<int, double>> flowTmp{};
+
+  // WiFi link the plugin instance is attached to
+  s4u::Link* link_{};
 
-  explicit LinkEnergyWifi(simgrid::s4u::Link* ptr) : link_(ptr) {}
+  // dynamic energy accumulated since the simulation start (active durations consumption)
+  double eDyn_{0.0};
+  // static energy (no activity consumption)
+  double eStat_{0.0};
 
-  ~LinkEnergyWifi() = default;
+  // duration since previous energy update
+  double prev_update_{0.0};
+
+  // Same energy calibration values as ns3 by default
+  // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details
+  double pIdle_{0.82};
+  double pTx_{1.14};
+  double pRx_{0.94};
+  double pSleep_{0.10};
+
+  // constant taking beacons into account (can be specified by the user)
+  double control_duration_{0.0036};
+
+  // Measurements for report
+  double dur_TxRx_{0}; // Duration of transmission
+  double dur_idle_{0}; // Duration of idle time
+  bool valuesInit_{false};
+
+public:
+  static xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
+
+  explicit LinkEnergyWifi(s4u::Link* ptr) : link_(ptr) {}
   LinkEnergyWifi()  = delete;
 
-  /**
-   * Update the energy consumed by link_ when transmissions start or end
-   */
+  /** Update the energy consumed by link_ when transmissions start or end */
   void update(const simgrid::kernel::resource::NetworkAction &);
 
-  /**
-   * Update the energy consumed when link_ is destroyed
-   */
+  /** Update the energy consumed when link_ is destroyed */
   void update_destroy();
 
   /**
@@ -74,45 +97,15 @@ public:
   void set_power_rx(double value) { pRx_ = value; }
   /** Set the power consumed by this link while sleeping */
   void set_power_sleep(double value) { pSleep_ = value; }
-
-private:
-  // associative array keeping size of data already sent for a given flow (required for interleaved actions)
-  std::map<simgrid::kernel::resource::NetworkWifiAction*, std::pair<int, double>> flowTmp{};
-
-  // WiFi link the plugin instance is attached to
-  s4u::Link* link_{};
-
-  // dynamic energy accumulated since the simulation start (active durations consumption)
-  double eDyn_{0.0};
-  // static energy (no activity consumption)
-  double eStat_{0.0};
-
-  // duration since previous energy update
-  double prev_update_{0.0};
-
-  // Same energy calibration values as ns3 by default
-  // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details
-  double pIdle_{0.82};
-  double pTx_{1.14};
-  double pRx_{0.94};
-  double pSleep_{0.10};
-
-  // constant taking beacons into account (can be specified by the user)
-  double control_duration_{0.0036};
-
-  // Measurements for report
-  double dur_TxRx_{0}; // Duration of transmission
-  double dur_idle_{0}; // Duration of idle time
-  bool valuesInit_{false};
 };
 
 xbt::Extension<s4u::Link, LinkEnergyWifi> LinkEnergyWifi::EXTENSION_ID;
 
 void LinkEnergyWifi::update_destroy()
 {
-  auto const* wifi_link = static_cast<simgrid::kernel::resource::NetworkWifiLink*>(link_->get_impl());
-  double duration = surf_get_clock() - prev_update_;
-  prev_update_    = surf_get_clock();
+  auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
+  double duration       = surf_get_clock() - prev_update_;
+  prev_update_          = surf_get_clock();
 
   dur_idle_ += duration;
 
@@ -123,7 +116,7 @@ void LinkEnergyWifi::update_destroy()
   XBT_DEBUG("finish eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_);
 }
 
-void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&)
+void LinkEnergyWifi::update(const kernel::resource::NetworkAction&)
 {
   init_watts_range_list();
 
@@ -134,9 +127,8 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&)
   if(duration < 1e-6)
     return;
 
-  auto const* wifi_link = static_cast<simgrid::kernel::resource::NetworkWifiLink*>(link_->get_impl());
+  auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
 
-  const kernel::lmm::Variable* var;
   const kernel::lmm::Element* elem = nullptr;
 
   /**
@@ -149,16 +141,14 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&)
    * used by the flow with the longest active time since the previous update
    */
   double durUsage = 0;
-  while((var = wifi_link->get_constraint()->get_variable(&elem))) {
+  while (const auto* var = wifi_link->get_constraint()->get_variable(&elem)) {
     auto* action = static_cast<kernel::resource::NetworkWifiAction*>(var->get_id());
-    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()));
-    action->get_variable();
-
-    double du = 0; // durUsage on the current flow
-    std::map<simgrid::kernel::resource::NetworkWifiAction *, std::pair<int, double>>::iterator it;
+    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()));
 
     if(action->get_variable()->get_value()) {
-      it = flowTmp.find(action);
+      auto it = flowTmp.find(action);
 
       // if the flow has not been registered, initialize it: 0 bytes sent, and not updated since its creation timestamp
       if(it == flowTmp.end())
@@ -170,7 +160,8 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&)
        * The active duration of the link is equal to the amount of data it had to send divided by the bandwidth on the link.
        * If this is longer than the duration since the previous update, active duration = now - previous_update
        */
-      du = (action->get_cost()-it->second.first) / action->get_variable()->get_value();
+      double du = // durUsage on the current flow
+          (action->get_cost() - it->second.first) / action->get_variable()->get_value();
 
       if(du > surf_get_clock()-it->second.second)
         du = surf_get_clock()-it->second.second;
@@ -299,7 +290,7 @@ void sg_wifi_energy_plugin_init()
     // verify the link is appropriate to WiFi energy computations
     if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
       XBT_DEBUG("Wifi Link: %s, initialization of wifi energy plugin", link.get_cname());
-      LinkEnergyWifi* plugin = new LinkEnergyWifi(&link);
+      auto* plugin = new LinkEnergyWifi(&link);
       link.extension_set(plugin);
     } else {
       XBT_DEBUG("Not Wifi Link: %s, wifi energy on link not computed", link.get_cname());
@@ -330,7 +321,7 @@ void sg_wifi_energy_plugin_init()
       });
 
   simgrid::s4u::Link::on_communicate.connect([](const simgrid::kernel::resource::NetworkAction& action) {
-    const simgrid::kernel::resource::NetworkWifiAction* actionWifi = dynamic_cast<const simgrid::kernel::resource::NetworkWifiAction*>(&action);
+    auto const* actionWifi = dynamic_cast<const simgrid::kernel::resource::NetworkWifiAction*>(&action);
 
     if (actionWifi == nullptr)
       return;