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