src/plugins/link_energy.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/host.h"
   8 #include "simgrid/plugins/energy.h"
   9 #include "simgrid/s4u/Engine.hpp"
  10 #include "simgrid/simix.hpp"
  11 #include "src/surf/network_interface.hpp"
  12 #include "src/surf/surf_interface.hpp"
  13
  14 #include <boost/algorithm/string/classification.hpp>
  15 #include <boost/algorithm/string/split.hpp>
  16
  17 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
  18
  19 /** @defgroup plugin_link_energy Plugin Link Energy
  20
  21  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
  22
  23  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  24  platform file as follows:
  25
  26  @verbatim
  27  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
  28  <prop id="wattage_range" value="100.0:200.0" />
  29  <prop id="wattage_off" value="10" />
  30  </link>
  31  @endverbatim
  32
  33  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  34  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  35  The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
  36  values are arbitrary).
  37
  38  To simulate the energy-related elements, first call the sg_link_energy_plugin_init() before loading the platform
  39  and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
  40  */
  41
  42 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
  43
  44 namespace simgrid {
  45 namespace plugin {
  46
  47 class LinkEnergy {
  48   s4u::Link* link_{};
  49
  50   bool inited_{false};
  51   double idle_{0.0};
  52   double busy_{0.0};
  53
  54   double total_energy_{0.0};
  55   double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
  56
  57   double get_power() const;
  58
  59 public:
  60   static xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
  61
  62   explicit LinkEnergy(s4u::Link* ptr) : link_(ptr), last_updated_(simgrid::s4u::Engine::get_clock()) {}
  63
  64   void init_watts_range_list();
  65   double get_consumed_energy();
  66   void update();
  67 };
  68
  69 xbt::Extension<s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
  70
  71 void LinkEnergy::update()
  72 {
  73   if (not inited_)
  74     init_watts_range_list();
  75
  76   double power = get_power();
  77   double now   = simgrid::s4u::Engine::get_clock();
  78   total_energy_ += power * (now - last_updated_);
  79   last_updated_ = now;
  80 }
  81
  82 void LinkEnergy::init_watts_range_list()
  83 {
  84   if (inited_)
  85     return;
  86   inited_ = true;
  87
  88   const char* all_power_values_str = this->link_->get_property("wattage_range");
  89   if (all_power_values_str == nullptr) {
  90     all_power_values_str = this->link_->get_property("watt_range");
  91     if (all_power_values_str != nullptr)
  92       XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
  93   }
  94
  95   if (all_power_values_str == nullptr)
  96     return;
  97
  98   std::vector<std::string> all_power_values;
  99   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
 100
 101   for (auto current_power_values_str : all_power_values) {
 102     /* retrieve the power values associated */
 103     std::vector<std::string> current_power_values;
 104     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
 105     xbt_assert(current_power_values.size() == 2,
 106                "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
 107                this->link_->get_cname());
 108
 109     /* min_power corresponds to the idle power (link load = 0) */
 110     /* max_power is the power consumed at 100% link load       */
 111     try {
 112       idle_ = std::stod(current_power_values.front());
 113     } catch (const std::invalid_argument&) {
 114       throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
 115     }
 116
 117     try {
 118       busy_ = std::stod(current_power_values.back());
 119     } catch (const std::invalid_argument&) {
 120       throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
 121     }
 122   }
 123 }
 124
 125 double LinkEnergy::get_power() const
 126 {
 127   if (not inited_)
 128     return 0.0;
 129
 130   double power_slope = busy_ - idle_;
 131
 132   double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
 133   double dynamic_power         = power_slope * normalized_link_usage;
 134
 135   return idle_ + dynamic_power;
 136 }
 137
 138 double LinkEnergy::get_consumed_energy()
 139 {
 140   if (last_updated_ < simgrid::s4u::Engine::get_clock()) // We need to simcall this as it modifies the environment
 141     kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
 142   return this->total_energy_;
 143 }
 144 } // namespace plugin
 145 } // namespace simgrid
 146
 147 using simgrid::plugin::LinkEnergy;
 148
 149 /* **************************** events  callback *************************** */
 150 static void on_communicate(const simgrid::kernel::resource::NetworkAction& action)
 151 {
 152   XBT_DEBUG("onCommunicate is called");
 153   for (auto const* link : action.get_links()) {
 154     if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
 155       continue;
 156
 157     XBT_DEBUG("Update link %s", link->get_cname());
 158     auto* link_energy = link->get_iface()->extension<LinkEnergy>();
 159     link_energy->init_watts_range_list();
 160     link_energy->update();
 161   }
 162 }
 163
 164 static void on_simulation_end()
 165 {
 166   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 167
 168   double total_energy = 0.0; // Total dissipated energy (whole platform)
 169   for (auto const* link : links) {
 170     if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
 171       continue;
 172
 173     double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
 174     total_energy += link_energy;
 175   }
 176
 177   XBT_INFO("Total energy over all links: %f", total_energy);
 178 }
 179 /* **************************** Public interface *************************** */
 180
 181 int sg_link_energy_is_inited()
 182 {
 183   return LinkEnergy::EXTENSION_ID.valid();
 184 }
 185 /** @ingroup plugin_link_energy
 186  * @brief Enable energy plugin
 187  * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
 188  * loading your platform.
 189  */
 190 void sg_link_energy_plugin_init()
 191 {
 192   if (LinkEnergy::EXTENSION_ID.valid())
 193     return;
 194   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
 195
 196   xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
 197
 198   simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
 199     if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
 200       XBT_DEBUG("Wired Link created: %s", link.get_cname());
 201       link.extension_set(new LinkEnergy(&link));
 202     } else {
 203       XBT_DEBUG("Not Wired link: %s", link.get_cname());
 204     }
 205   });
 206
 207   simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link const& link) {
 208     if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
 209       link.extension<LinkEnergy>()->update();
 210   });
 211
 212   simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
 213     if (link.get_name() != "__loopback__" && link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
 214       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 215                link.extension<LinkEnergy>()->get_consumed_energy());
 216   });
 217
 218   simgrid::s4u::Link::on_communication_state_change.connect(
 219       [](simgrid::kernel::resource::NetworkAction const& action,
 220          simgrid::kernel::resource::Action::State /* previous */) {
 221         for (auto const* link : action.get_links()) {
 222           if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
 223             link->get_iface()->extension<LinkEnergy>()->update();
 224         }
 225       });
 226
 227   simgrid::s4u::Link::on_communicate.connect(&on_communicate);
 228   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 229 }
 230
 231 /** @ingroup plugin_link_energy
 232  *  @brief Returns the total energy consumed by the link so far (in Joules)
 233  *
 234  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
 235  *  The result is that the actor requesting this value will be interrupted,
 236  *  the value will be updated in kernel mode before returning the control to the requesting actor.
 237  */
 238 double sg_link_get_consumed_energy(const_sg_link_t link)
 239 {
 240   if (not LinkEnergy::EXTENSION_ID.valid())
 241     throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
 242                                             "before calling sg_link_get_consumed_energy().");
 243   return link->extension<LinkEnergy>()->get_consumed_energy();
 244 }