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/plugins/energy.h"
   7 #include "simgrid/s4u/Engine.hpp"
   8 #include "src/surf/network_interface.hpp"
   9 #include "src/surf/surf_interface.hpp"
  10 #include "surf/surf.hpp"
  11
  12 #include <boost/algorithm/string/classification.hpp>
  13 #include <boost/algorithm/string/split.hpp>
  14
  15 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
  16
  17 /** @addtogroup SURF_plugin_energy
  18
  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="watt_range" value="100.0:200.0" />
  28  <prop id="watt_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("watt_range");
  91
  92   if (all_power_values_str == nullptr)
  93     return;
  94
  95   std::vector<std::string> all_power_values;
  96   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
  97
  98   for (auto current_power_values_str : all_power_values) {
  99     /* retrieve the power values associated */
 100     std::vector<std::string> current_power_values;
 101     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
 102     xbt_assert(current_power_values.size() == 2,
 103                "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
 104                this->link_->get_cname());
 105
 106     /* min_power corresponds to the idle power (link load = 0) */
 107     /* max_power is the power consumed at 100% link load       */
 108     try {
 109       idle_ = std::stod(current_power_values.front());
 110     } catch (std::invalid_argument& ia) {
 111       throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
 112     }
 113
 114     try {
 115       busy_ = std::stod(current_power_values.back());
 116     } catch (std::invalid_argument& ia) {
 117       throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
 118     }
 119   }
 120 }
 121
 122 double LinkEnergy::get_power()
 123 {
 124
 125   if (!inited_)
 126     return 0.0;
 127
 128   double power_slope = busy_ - idle_;
 129
 130   double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
 131   double dynamic_power         = power_slope * normalized_link_usage;
 132
 133   return idle_ + dynamic_power;
 134 }
 135
 136 double LinkEnergy::get_consumed_energy()
 137 {
 138   if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
 139     simgrid::simix::simcall(std::bind(&LinkEnergy::update, this));
 140   return this->total_energy_;
 141 }
 142 } // namespace plugin
 143 } // namespace simgrid
 144
 145 using simgrid::plugin::LinkEnergy;
 146
 147 /* **************************** events  callback *************************** */
 148 static void on_communicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host*, simgrid::s4u::Host*)
 149 {
 150   XBT_DEBUG("onCommunicate is called");
 151   for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
 152
 153     if (link == nullptr)
 154       continue;
 155
 156     XBT_DEBUG("Update link %s", link->get_cname());
 157     LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
 158     link_energy->init_watts_range_list();
 159     link_energy->update();
 160   }
 161 }
 162
 163 static void on_simulation_end()
 164 {
 165   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 166
 167   double total_energy = 0.0; // Total dissipated energy (whole platform)
 168   for (const auto link : links) {
 169     double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
 170     total_energy += link_energy;
 171   }
 172
 173   XBT_INFO("Total energy over all links: %f", total_energy);
 174 }
 175 /* **************************** Public interface *************************** */
 176
 177 int sg_link_energy_is_inited()
 178 {
 179   return LinkEnergy::EXTENSION_ID.valid();
 180 }
 181 /** @ingroup SURF_plugin_energy
 182  * @brief Enable energy plugin
 183  * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
 184  * #MSG_init().
 185  */
 186 void sg_link_energy_plugin_init()
 187 {
 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.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
 196
 197   simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link& link) { link.extension<LinkEnergy>()->update(); });
 198
 199   simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link& link) {
 200     if (link.get_name() != "__loopback__")
 201       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 202                link.extension<LinkEnergy>()->get_consumed_energy());
 203   });
 204
 205   simgrid::s4u::Link::on_communication_state_change.connect(
 206       [](simgrid::kernel::resource::NetworkAction* action, simgrid::kernel::resource::Action::State /* previous */) {
 207         for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
 208           if (link != nullptr)
 209             link->piface_.extension<LinkEnergy>()->update();
 210         }
 211       });
 212
 213   simgrid::s4u::Link::on_communicate.connect(&on_communicate);
 214   simgrid::s4u::on_simulation_end.connect(&on_simulation_end);
 215 }
 216
 217 /** @ingroup plugin_energy
 218  *  @brief Returns the total energy consumed by the link so far (in Joules)
 219  *
 220  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
 221  *  The result is that the actor requesting this value will be interrupted,
 222  *  the value will be updated in kernel mode before returning the control to the requesting actor.
 223  */
 224 double sg_link_get_consumed_energy(sg_link_t link)
 225 {
 226   return link->extension<LinkEnergy>()->get_consumed_energy();
 227 }