src/plugins/link_energy.cpp

   1 /* Copyright (c) 2017-2023. 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/Comm.hpp"
  10 #include "simgrid/s4u/Engine.hpp"
  11 #include "simgrid/s4u/Link.hpp"
  12 #include "src/kernel/activity/CommImpl.hpp"
  13 #include "src/simgrid/module.hpp"
  14
  15 #include <boost/algorithm/string/classification.hpp>
  16 #include <boost/algorithm/string/split.hpp>
  17
  18 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
  19
  20 /** @defgroup plugin_link_energy Plugin Link Energy
  21
  22  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
  23
  24  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  25  platform file as follows:
  26
  27  @verbatim
  28  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
  29  <prop id="wattage_range" value="100.0:200.0" />
  30  <prop id="wattage_off" value="10" />
  31  </link>
  32  @endverbatim
  33
  34  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  35  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  36  The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
  37  values are arbitrary).
  38
  39  To simulate the energy-related elements, first call the sg_link_energy_plugin_init() before loading the platform
  40  and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
  41  */
  42
  43 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, kernel, "Logging specific to the LinkEnergy plugin");
  44
  45 namespace simgrid::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("Invalid idle power value for link " + this->link_->get_name());
 115     }
 116
 117     try {
 118       busy_ = std::stod(current_power_values.back());
 119     } catch (const std::invalid_argument&) {
 120       throw std::invalid_argument("Invalid busy power value for link " + this->link_->get_name());
 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_load() / 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_answered(std::bind(&LinkEnergy::update, this));
 142   return this->total_energy_;
 143 }
 144 } // namespace simgrid::plugin
 145
 146 using simgrid::plugin::LinkEnergy;
 147
 148 /* **************************** events  callback *************************** */
 149 static void on_simulation_end()
 150 {
 151   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 152
 153   double total_energy = 0.0; // Total dissipated energy (whole platform)
 154   for (auto const* link : links) {
 155     if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
 156       continue;
 157
 158     double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
 159     total_energy += link_energy;
 160   }
 161
 162   XBT_INFO("Total energy over all links: %f", total_energy);
 163 }
 164
 165 static void on_communication(const simgrid::s4u::Comm& comm)
 166 {
 167   const auto* pimpl = static_cast<simgrid::kernel::activity::CommImpl*>(comm.get_impl());
 168   for (auto const* link : pimpl->get_traversed_links()) {
 169     if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
 170       XBT_DEBUG("Update %s on Comm Start/End", link->get_cname());
 171       link->extension<LinkEnergy>()->update();
 172     }
 173   }
 174 }
 175
 176 /* **************************** Public interface *************************** */
 177
 178 int sg_link_energy_is_inited()
 179 {
 180   return LinkEnergy::EXTENSION_ID.valid();
 181 }
 182 /** @ingroup plugin_link_energy
 183  * @brief Enable energy plugin
 184  * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
 185  * loading your platform.
 186  */
 187 void sg_link_energy_plugin_init()
 188 {
 189   if (LinkEnergy::EXTENSION_ID.valid())
 190     return;
 191   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
 192
 193   xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
 194
 195   simgrid::s4u::Link::on_creation_cb([](simgrid::s4u::Link& link) {
 196     if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
 197       XBT_DEBUG("Wired Link created: %s", link.get_cname());
 198       link.extension_set(new LinkEnergy(&link));
 199     } else {
 200       XBT_DEBUG("Not Wired link: %s", link.get_cname());
 201     }
 202   });
 203
 204   simgrid::s4u::Link::on_onoff_cb([](simgrid::s4u::Link const& link) {
 205     if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
 206       link.extension<LinkEnergy>()->update();
 207   });
 208
 209   simgrid::s4u::Link::on_destruction_cb([](simgrid::s4u::Link const& link) {
 210     if (link.get_name() != "__loopback__" && link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
 211       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 212                link.extension<LinkEnergy>()->get_consumed_energy());
 213   });
 214
 215   simgrid::s4u::Comm::on_start_cb(&on_communication);
 216   simgrid::s4u::Comm::on_completion_cb(&on_communication);
 217
 218   simgrid::s4u::Engine::on_simulation_end_cb(&on_simulation_end);
 219 }
 220
 221 /** @ingroup plugin_link_energy
 222  *  @brief Returns the total energy consumed by the link so far (in Joules)
 223  *
 224  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
 225  *  The result is that the actor requesting this value will be interrupted,
 226  *  the value will be updated in kernel mode before returning the control to the requesting actor.
 227  */
 228 double sg_link_get_consumed_energy(const_sg_link_t link)
 229 {
 230   if (not LinkEnergy::EXTENSION_ID.valid())
 231     throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
 232                                             "before calling sg_link_get_consumed_energy().");
 233   return link->extension<LinkEnergy>()->get_consumed_energy();
 234 }