src/plugins/link_energy.cpp

   1 /* Copyright (c) 2017-2019. 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
  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 simgrid#energy#sg_link_energy_plugin_init() before your
  38  #MSG_init(),
  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 public:
  49   static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
  50
  51   explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
  52   ~LinkEnergy() = default;
  53
  54   void init_watts_range_list();
  55   double get_consumed_energy();
  56   void update();
  57
  58 private:
  59   double get_power();
  60
  61   simgrid::s4u::Link* link_{};
  62
  63   bool inited_{false};
  64   double idle_{0.0};
  65   double busy_{0.0};
  66
  67   double total_energy_{0.0};
  68   double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
  69 };
  70
  71 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
  72
  73 void LinkEnergy::update()
  74 {
  75   if (!inited_)
  76     init_watts_range_list();
  77
  78   double power = get_power();
  79   double now   = surf_get_clock();
  80   total_energy_ += power * (now - last_updated_);
  81   last_updated_ = now;
  82 }
  83
  84 void LinkEnergy::init_watts_range_list()
  85 {
  86   if (inited_)
  87     return;
  88   inited_ = true;
  89
  90   const char* all_power_values_str = this->link_->get_property("wattage_range");
  91   if (all_power_values_str == nullptr) {
  92     all_power_values_str = this->link_->get_property("watt_range");
  93     if (all_power_values_str != nullptr)
  94       XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
  95   }
  96
  97   if (all_power_values_str == nullptr)
  98     return;
  99
 100   std::vector<std::string> all_power_values;
 101   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
 102
 103   for (auto current_power_values_str : all_power_values) {
 104     /* retrieve the power values associated */
 105     std::vector<std::string> current_power_values;
 106     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
 107     xbt_assert(current_power_values.size() == 2,
 108                "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
 109                this->link_->get_cname());
 110
 111     /* min_power corresponds to the idle power (link load = 0) */
 112     /* max_power is the power consumed at 100% link load       */
 113     try {
 114       idle_ = std::stod(current_power_values.front());
 115     } catch (const std::invalid_argument&) {
 116       throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
 117     }
 118
 119     try {
 120       busy_ = std::stod(current_power_values.back());
 121     } catch (const std::invalid_argument&) {
 122       throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
 123     }
 124   }
 125 }
 126
 127 double LinkEnergy::get_power()
 128 {
 129
 130   if (!inited_)
 131     return 0.0;
 132
 133   double power_slope = busy_ - idle_;
 134
 135   double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
 136   double dynamic_power         = power_slope * normalized_link_usage;
 137
 138   return idle_ + dynamic_power;
 139 }
 140
 141 double LinkEnergy::get_consumed_energy()
 142 {
 143   if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
 144     simgrid::kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
 145   return this->total_energy_;
 146 }
 147 } // namespace plugin
 148 } // namespace simgrid
 149
 150 using simgrid::plugin::LinkEnergy;
 151
 152 /* **************************** events  callback *************************** */
 153 static void on_communicate(simgrid::kernel::resource::NetworkAction const& action, simgrid::s4u::Host*,
 154                            simgrid::s4u::Host*)
 155 {
 156   XBT_DEBUG("onCommunicate is called");
 157   for (simgrid::kernel::resource::LinkImpl* link : action.links()) {
 158
 159     if (link == nullptr)
 160       continue;
 161
 162     XBT_DEBUG("Update link %s", link->get_cname());
 163     LinkEnergy* link_energy = link->get_iface()->extension<LinkEnergy>();
 164     link_energy->init_watts_range_list();
 165     link_energy->update();
 166   }
 167 }
 168
 169 static void on_simulation_end()
 170 {
 171   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 172
 173   double total_energy = 0.0; // Total dissipated energy (whole platform)
 174   for (const auto link : links) {
 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  * #MSG_init().
 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) { link.extension_set(new LinkEnergy(&link)); });
 201
 202   simgrid::s4u::Link::on_state_change.connect(
 203       [](simgrid::s4u::Link const& link) { link.extension<LinkEnergy>()->update(); });
 204
 205   simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
 206     if (link.get_name() != "__loopback__")
 207       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 208                link.extension<LinkEnergy>()->get_consumed_energy());
 209   });
 210
 211   simgrid::s4u::Link::on_communication_state_change.connect([](
 212       simgrid::kernel::resource::NetworkAction const& action, simgrid::kernel::resource::Action::State /* previous */) {
 213     for (simgrid::kernel::resource::LinkImpl* link : action.links()) {
 214       if (link != nullptr)
 215         link->get_iface()->extension<LinkEnergy>()->update();
 216     }
 217   });
 218
 219   simgrid::s4u::Link::on_communicate.connect(&on_communicate);
 220   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 221 }
 222
 223 /** @ingroup plugin_link_energy
 224  *  @brief Returns the total energy consumed by the link so far (in Joules)
 225  *
 226  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
 227  *  The result is that the actor requesting this value will be interrupted,
 228  *  the value will be updated in kernel mode before returning the control to the requesting actor.
 229  */
 230 double sg_link_get_consumed_energy(sg_link_t link)
 231 {
 232   if (not LinkEnergy::EXTENSION_ID.valid())
 233     throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
 234                                             "before calling sg_link_get_consumed_energy().");
 235   return link->extension<LinkEnergy>()->get_consumed_energy();
 236 }