src/surf/plugins/link_energy.cpp

   1 /* Copyright (c) 2017-2018. 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 "surf/surf.hpp"
  10
  11 #include <boost/algorithm/string/classification.hpp>
  12 #include <boost/algorithm/string/split.hpp>
  13 #include <string>
  14
  15 /** @addtogroup SURF_plugin_energy
  16
  17
  18  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
  19
  20  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  21  platform file as follows:
  22
  23  \verbatim
  24  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
  25  <prop id="watt_range" value="100.0:200.0" />
  26  <prop id="watt_off" value="10" />
  27  </link>
  28  \endverbatim
  29
  30  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  31  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  32  The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
  33  values are arbitrary).
  34
  35  To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
  36  #MSG_init(),
  37  and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
  38  */
  39
  40 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
  41
  42 namespace simgrid {
  43 namespace plugin {
  44
  45 class LinkEnergy {
  46 public:
  47   static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
  48
  49   explicit LinkEnergy(simgrid::s4u::Link* ptr);
  50   ~LinkEnergy();
  51
  52   void initWattsRangeList();
  53   double getConsumedEnergy();
  54   void update();
  55
  56 private:
  57   double getPower();
  58
  59   simgrid::s4u::Link* link_{};
  60
  61   bool inited_{false};
  62   double idle_{0.0};
  63   double busy_{0.0};
  64
  65   double totalEnergy_{0.0};
  66   double lastUpdated_{0.0}; /*< Timestamp of the last energy update event*/
  67 };
  68
  69 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
  70
  71 LinkEnergy::LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), lastUpdated_(surf_get_clock())
  72 {
  73 }
  74
  75 LinkEnergy::~LinkEnergy() = default;
  76
  77 void LinkEnergy::update()
  78 {
  79   double power = getPower();
  80   double now   = surf_get_clock();
  81   totalEnergy_ += power * (now - lastUpdated_);
  82   lastUpdated_ = now;
  83 }
  84
  85 void LinkEnergy::initWattsRangeList()
  86 {
  87
  88   if (inited_)
  89     return;
  90   inited_ = true;
  91
  92   const char* all_power_values_str = this->link_->getProperty("watt_range");
  93
  94   if (all_power_values_str == nullptr)
  95     return;
  96
  97   std::vector<std::string> all_power_values;
  98   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
  99
 100   for (auto current_power_values_str : all_power_values) {
 101     /* retrieve the power values associated */
 102     std::vector<std::string> current_power_values;
 103     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
 104     xbt_assert(current_power_values.size() == 2,
 105                "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
 106                this->link_->get_cname());
 107
 108     /* min_power corresponds to the idle power (link load = 0) */
 109     /* max_power is the power consumed at 100% link load       */
 110     char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->get_cname());
 111     char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->get_cname());
 112
 113     idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
 114     busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
 115
 116     xbt_free(idleMsg);
 117     xbt_free(busyMsg);
 118     update();
 119   }
 120 }
 121
 122 double LinkEnergy::getPower()
 123 {
 124
 125   if (!inited_)
 126     return 0.0;
 127
 128   double power_slope = busy_ - idle_;
 129
 130   double normalized_link_usage = link_->getUsage() / link_->bandwidth();
 131   double dynamic_power         = power_slope * normalized_link_usage;
 132
 133   return idle_ + dynamic_power;
 134 }
 135
 136 double LinkEnergy::getConsumedEnergy()
 137 {
 138   if (lastUpdated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
 139     simgrid::simix::kernelImmediate(std::bind(&LinkEnergy::update, this));
 140   return this->totalEnergy_;
 141 }
 142 }
 143 }
 144
 145 using simgrid::plugin::LinkEnergy;
 146
 147 /* **************************** events  callback *************************** */
 148 static void onCommunicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host* src,
 149                           simgrid::s4u::Host* dst)
 150 {
 151   XBT_DEBUG("onCommunicate is called");
 152   for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
 153
 154     if (link == nullptr)
 155       continue;
 156
 157     XBT_DEBUG("Update link %s", link->get_cname());
 158     LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
 159     link_energy->initWattsRangeList();
 160     link_energy->update();
 161   }
 162 }
 163
 164 static void onSimulationEnd()
 165 {
 166   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::getInstance()->getAllLinks();
 167
 168   double total_energy = 0.0; // Total dissipated energy (whole platform)
 169   for (const auto link : links) {
 170     double link_energy = link->extension<LinkEnergy>()->getConsumedEnergy();
 171     total_energy += link_energy;
 172   }
 173
 174   XBT_INFO("Total energy over all links: %f", total_energy);
 175 }
 176 /* **************************** Public interface *************************** */
 177
 178 int sg_link_energy_is_inited()
 179 {
 180   return LinkEnergy::EXTENSION_ID.valid();
 181 }
 182 /** \ingroup SURF_plugin_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  * #MSG_init().
 186  */
 187 void sg_link_energy_plugin_init()
 188 {
 189
 190   if (LinkEnergy::EXTENSION_ID.valid())
 191     return;
 192   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
 193
 194   xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
 195
 196   simgrid::s4u::Link::onCreation.connect([](simgrid::s4u::Link& link) {
 197     link.extension_set(new LinkEnergy(&link));
 198   });
 199
 200   simgrid::s4u::Link::onStateChange.connect([](simgrid::s4u::Link& link) {
 201     link.extension<LinkEnergy>()->update();
 202   });
 203
 204   simgrid::s4u::Link::onDestruction.connect([](simgrid::s4u::Link& link) {
 205     if (strcmp(link.get_cname(), "__loopback__"))
 206       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 207                link.extension<LinkEnergy>()->getConsumedEnergy());
 208   });
 209
 210   simgrid::s4u::Link::onCommunicationStateChange.connect([](simgrid::kernel::resource::NetworkAction* action) {
 211     for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
 212       if (link != nullptr)
 213         link->piface_.extension<LinkEnergy>()->update();
 214     }
 215   });
 216
 217   simgrid::s4u::Link::onCommunicate.connect(&onCommunicate);
 218   simgrid::s4u::onSimulationEnd.connect(&onSimulationEnd);
 219 }
 220
 221 /** @ingroup plugin_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(sg_link_t link)
 229 {
 230   return link->extension<LinkEnergy>()->getConsumedEnergy();
 231 }