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
  14 /** @addtogroup SURF_plugin_energy
  15
  16
  17  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
  18
  19  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  20  platform file as follows:
  21
  22  \verbatim
  23  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
  24  <prop id="watt_range" value="100.0:200.0" />
  25  <prop id="watt_off" value="10" />
  26  </link>
  27  \endverbatim
  28
  29  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  30  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
  31  The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
  32  values are arbitrary).
  33
  34  To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
  35  #MSG_init(),
  36  and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
  37  */
  38
  39 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
  40
  41 namespace simgrid {
  42 namespace plugin {
  43
  44 class LinkEnergy {
  45 public:
  46   static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
  47
  48   explicit LinkEnergy(simgrid::s4u::Link* ptr);
  49   ~LinkEnergy();
  50
  51   void initWattsRangeList();
  52   double getConsumedEnergy();
  53   void update();
  54
  55 private:
  56   double getPower();
  57
  58   simgrid::s4u::Link* link_{};
  59
  60   bool inited_{false};
  61   double idle_{0.0};
  62   double busy_{0.0};
  63
  64   double totalEnergy_{0.0};
  65   double lastUpdated_{0.0}; /*< Timestamp of the last energy update event*/
  66 };
  67
  68 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
  69
  70 LinkEnergy::LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), lastUpdated_(surf_get_clock())
  71 {
  72 }
  73
  74 LinkEnergy::~LinkEnergy() = default;
  75
  76 void LinkEnergy::update()
  77 {
  78   double power = getPower();
  79   double now   = surf_get_clock();
  80   totalEnergy_ += power * (now - lastUpdated_);
  81   lastUpdated_ = now;
  82 }
  83
  84 void LinkEnergy::initWattsRangeList()
  85 {
  86
  87   if (inited_)
  88     return;
  89   inited_ = true;
  90
  91   const char* all_power_values_str = this->link_->getProperty("watt_range");
  92
  93   if (all_power_values_str == nullptr)
  94     return;
  95
  96   std::vector<std::string> all_power_values;
  97   boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
  98
  99   for (auto current_power_values_str : all_power_values) {
 100     /* retrieve the power values associated */
 101     std::vector<std::string> current_power_values;
 102     boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
 103     xbt_assert(current_power_values.size() == 2,
 104                "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
 105                this->link_->get_cname());
 106
 107     /* min_power corresponds to the idle power (link load = 0) */
 108     /* max_power is the power consumed at 100% link load       */
 109     char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->get_cname());
 110     char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->get_cname());
 111
 112     idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
 113     busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
 114
 115     xbt_free(idleMsg);
 116     xbt_free(busyMsg);
 117     update();
 118   }
 119 }
 120
 121 double LinkEnergy::getPower()
 122 {
 123
 124   if (!inited_)
 125     return 0.0;
 126
 127   double power_slope = busy_ - idle_;
 128
 129   double normalized_link_usage = link_->getUsage() / link_->bandwidth();
 130   double dynamic_power         = power_slope * normalized_link_usage;
 131
 132   return idle_ + dynamic_power;
 133 }
 134
 135 double LinkEnergy::getConsumedEnergy()
 136 {
 137   if (lastUpdated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
 138     simgrid::simix::simcall(std::bind(&LinkEnergy::update, this));
 139   return this->totalEnergy_;
 140 }
 141 }
 142 }
 143
 144 using simgrid::plugin::LinkEnergy;
 145
 146 /* **************************** events  callback *************************** */
 147 static void onCommunicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host* src,
 148                           simgrid::s4u::Host* dst)
 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->initWattsRangeList();
 159     link_energy->update();
 160   }
 161 }
 162
 163 static void onSimulationEnd()
 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>()->getConsumedEnergy();
 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 (strcmp(link.get_cname(), "__loopback__"))
 201       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
 202                link.extension<LinkEnergy>()->getConsumedEnergy());
 203   });
 204
 205   simgrid::s4u::Link::on_communication_state_change.connect([](simgrid::kernel::resource::NetworkAction* action) {
 206     for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
 207       if (link != nullptr)
 208         link->piface_.extension<LinkEnergy>()->update();
 209     }
 210   });
 211
 212   simgrid::s4u::Link::on_communicate.connect(&onCommunicate);
 213   simgrid::s4u::on_simulation_end.connect(&onSimulationEnd);
 214 }
 215
 216 /** @ingroup plugin_energy
 217  *  @brief Returns the total energy consumed by the link so far (in Joules)
 218  *
 219  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
 220  *  The result is that the actor requesting this value will be interrupted,
 221  *  the value will be updated in kernel mode before returning the control to the requesting actor.
 222  */
 223 double sg_link_get_consumed_energy(sg_link_t link)
 224 {
 225   return link->extension<LinkEnergy>()->getConsumedEnergy();
 226 }