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 /** @defgroup plugin_link_energy
  18
  19  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
  20
  21  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  22  platform file as follows:
  23
  24  @verbatim
  25  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
  26  <prop id="wattage_range" value="100.0:200.0" />
  27  <prop id="wattage_off" value="10" />
  28  </link>
  29  @endverbatim
  30
  31  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  32  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  33  The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
  34  values are arbitrary).
  35
  36  To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
  37  #MSG_init(),
  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   simgrid::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 simgrid::xbt::Extension<simgrid::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
 129   if (!inited_)
 130     return 0.0;
 131
 132   double power_slope = busy_ - idle_;
 133
 134   double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
 135   double dynamic_power         = power_slope * normalized_link_usage;
 136
 137   return idle_ + dynamic_power;
 138 }
 139
 140 double LinkEnergy::get_consumed_energy()
 141 {
 142   if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
 143     simgrid::kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
 144   return this->total_energy_;
 145 }
 146 } // namespace plugin
 147 } // namespace simgrid
 148
 149 using simgrid::plugin::LinkEnergy;
 150
 151 /* **************************** events  callback *************************** */
 152 static void on_communicate(simgrid::kernel::resource::NetworkAction const& action, simgrid::s4u::Host*,
 153                            simgrid::s4u::Host*)
 154 {
 155   XBT_DEBUG("onCommunicate is called");
 156   for (simgrid::kernel::resource::LinkImpl* link : action.links()) {
 157
 158     if (link == nullptr)
 159       continue;
 160
 161     XBT_DEBUG("Update link %s", link->get_cname());
 162     LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
 163     link_energy->init_watts_range_list();
 164     link_energy->update();
 165   }
 166 }
 167
 168 static void on_simulation_end()
 169 {
 170   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 171
 172   double total_energy = 0.0; // Total dissipated energy (whole platform)
 173   for (const auto link : links) {
 174     double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
 175     total_energy += link_energy;
 176   }
 177
 178   XBT_INFO("Total energy over all links: %f", total_energy);
 179 }
 180 /* **************************** Public interface *************************** */
 181
 182 int sg_link_energy_is_inited()
 183 {
 184   return LinkEnergy::EXTENSION_ID.valid();
 185 }
 186 /** @ingroup plugin_link_energy
 187  * @brief Enable energy plugin
 188  * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
 189  * #MSG_init().
 190  */
 191 void sg_link_energy_plugin_init()
 192 {
 193   if (LinkEnergy::EXTENSION_ID.valid())
 194     return;
 195   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
 196
 197   xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
 198
 199   simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
 200
 201   simgrid::s4u::Link::on_state_change.connect(
 202       [](simgrid::s4u::Link const& link) { link.extension<LinkEnergy>()->update(); });
 203
 204   simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
 205     if (link.get_name() != "__loopback__")
 206       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 207                link.extension<LinkEnergy>()->get_consumed_energy());
 208   });
 209
 210   simgrid::s4u::Link::on_communication_state_change.connect([](
 211       simgrid::kernel::resource::NetworkAction const& action, simgrid::kernel::resource::Action::State /* previous */) {
 212     for (simgrid::kernel::resource::LinkImpl* link : action.links()) {
 213       if (link != nullptr)
 214         link->piface_.extension<LinkEnergy>()->update();
 215     }
 216   });
 217
 218   simgrid::s4u::Link::on_communicate.connect(&on_communicate);
 219   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 220 }
 221
 222 /** @ingroup plugin_link_energy
 223  *  @brief Returns the total energy consumed by the link so far (in Joules)
 224  *
 225  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
 226  *  The result is that the actor requesting this value will be interrupted,
 227  *  the value will be updated in kernel mode before returning the control to the requesting actor.
 228  */
 229 double sg_link_get_consumed_energy(sg_link_t link)
 230 {
 231   return link->extension<LinkEnergy>()->get_consumed_energy();
 232 }