src/surf/plugins/link_energy.cpp

   1 /* Copyright (c) 2017. 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 "simgrid/simix.hpp"
   9 #include "src/surf/network_interface.hpp"
  10 #include <boost/algorithm/string/classification.hpp>
  11 #include <boost/algorithm/string/split.hpp>
  12 #include <map>
  13 #include <string>
  14 #include <utility>
  15 #include <vector>
  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);
  52   ~LinkEnergy();
  53
  54   void initWattsRangeList();
  55   double getConsumedEnergy();
  56   void update();
  57
  58 private:
  59   double getPower();
  60
  61   simgrid::s4u::Link* link_{};
  62
  63   bool inited_{false};
  64   double idle_{0.0};
  65   double busy_{0.0};
  66
  67   double totalEnergy_{0.0};
  68   double lastUpdated_{0.0}; /*< Timestamp of the last energy update event*/
  69 };
  70
  71 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
  72
  73 LinkEnergy::LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), lastUpdated_(surf_get_clock())
  74 {
  75 }
  76
  77 LinkEnergy::~LinkEnergy() = default;
  78
  79 void LinkEnergy::update()
  80 {
  81   double power = getPower();
  82   double now   = surf_get_clock();
  83   totalEnergy_ += power * (now - lastUpdated_);
  84   lastUpdated_ = now;
  85 }
  86
  87 void LinkEnergy::initWattsRangeList()
  88 {
  89
  90   if (inited_)
  91     return;
  92   inited_ = true;
  93
  94   const char* all_power_values_str = this->link_->getProperty("watt_range");
  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_->getCname());
 109
 110     /* min_power corresponds to the idle power (link load = 0) */
 111     /* max_power is the power consumed at 100% link load       */
 112     char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->getCname());
 113     char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->getCname());
 114
 115     idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
 116     busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
 117
 118     xbt_free(idleMsg);
 119     xbt_free(busyMsg);
 120     update();
 121   }
 122 }
 123
 124 double LinkEnergy::getPower()
 125 {
 126
 127   if (!inited_)
 128     return 0.0;
 129
 130   double power_slope = busy_ - idle_;
 131
 132   double normalized_link_usage = link_->getUsage() / link_->bandwidth();
 133   double dynamic_power         = power_slope * normalized_link_usage;
 134
 135   return idle_ + dynamic_power;
 136 }
 137
 138 double LinkEnergy::getConsumedEnergy()
 139 {
 140   if (lastUpdated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
 141     simgrid::simix::kernelImmediate(std::bind(&LinkEnergy::update, this));
 142   return this->totalEnergy_;
 143 }
 144 }
 145 }
 146
 147 using simgrid::plugin::LinkEnergy;
 148
 149 /* **************************** events  callback *************************** */
 150 static void onCommunicate(simgrid::surf::NetworkAction* action, simgrid::s4u::Host* src, simgrid::s4u::Host* dst)
 151 {
 152   XBT_DEBUG("onCommunicate is called");
 153   for (simgrid::surf::LinkImpl* link : action->links()) {
 154
 155     if (link == nullptr)
 156       continue;
 157
 158     XBT_DEBUG("Update link %s", link->getCname());
 159     LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
 160     link_energy->initWattsRangeList();
 161     link_energy->update();
 162   }
 163 }
 164
 165 static void onSimulationEnd()
 166 {
 167   std::vector<simgrid::s4u::Link*> links;
 168   simgrid::s4u::Engine::getInstance()->getLinkList(&links);
 169
 170   double total_energy = 0.0; // Total dissipated energy (whole platform)
 171   for (const auto link : links) {
 172     double link_energy = link->extension<LinkEnergy>()->getConsumedEnergy();
 173     total_energy += link_energy;
 174   }
 175
 176   XBT_INFO("Total energy over all links: %f", total_energy);
 177 }
 178 /* **************************** Public interface *************************** */
 179 SG_BEGIN_DECL()
 180 int sg_link_energy_is_inited()
 181 {
 182   return LinkEnergy::EXTENSION_ID.valid();
 183 }
 184 /** \ingroup SURF_plugin_energy
 185  * \brief Enable energy plugin
 186  * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before
 187  * #MSG_init().
 188  */
 189 void sg_link_energy_plugin_init()
 190 {
 191
 192   if (LinkEnergy::EXTENSION_ID.valid())
 193     return;
 194   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
 195
 196   xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
 197
 198   simgrid::s4u::Link::onCreation.connect([](simgrid::s4u::Link& link) {
 199     link.extension_set(new LinkEnergy(&link));
 200   });
 201
 202   simgrid::s4u::Link::onStateChange.connect([](simgrid::s4u::Link& link) {
 203     link.extension<LinkEnergy>()->update();
 204   });
 205
 206   simgrid::s4u::Link::onDestruction.connect([](simgrid::s4u::Link& link) {
 207     if (strcmp(link.getCname(), "__loopback__"))
 208       XBT_INFO("Energy consumption of link '%s': %f Joules", link.getCname(),
 209                link.extension<LinkEnergy>()->getConsumedEnergy());
 210   });
 211
 212   simgrid::s4u::Link::onCommunicationStateChange.connect([](simgrid::surf::NetworkAction* action) {
 213     for (simgrid::surf::LinkImpl* link : action->links()) {
 214       if (link != nullptr)
 215         link->piface_.extension<LinkEnergy>()->update();
 216     }
 217   });
 218
 219   simgrid::s4u::Link::onCommunicate.connect(&onCommunicate);
 220   simgrid::s4u::onSimulationEnd.connect(&onSimulationEnd);
 221 }
 222
 223 /** @ingroup plugin_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   return link->extension<LinkEnergy>()->getConsumedEnergy();
 233 }
 234 SG_END_DECL()