1 /* Copyright (c) 2017. The SimGrid Team. All rights reserved. */
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. */
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>
17 /** @addtogroup SURF_plugin_energy
20 This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
22 The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
23 platform file as follows:
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" />
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).
37 To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
39 and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
42 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
49 static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
51 explicit LinkEnergy(simgrid::s4u::Link* ptr);
54 void initWattsRangeList();
55 double getTotalEnergy();
61 simgrid::s4u::Link* link_{};
67 double totalEnergy_{0.0};
68 double lastUpdated_{0.0}; /*< Timestamp of the last energy update event*/
71 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
73 LinkEnergy::LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), lastUpdated_(surf_get_clock())
77 LinkEnergy::~LinkEnergy() = default;
79 void LinkEnergy::update()
81 double power = getPower();
82 double now = surf_get_clock();
83 totalEnergy_ += power * (now - lastUpdated_);
87 void LinkEnergy::initWattsRangeList()
94 const char* all_power_values_str = this->link_->getProperty("watt_range");
96 if (all_power_values_str == nullptr)
99 std::vector<std::string> all_power_values;
100 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
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());
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());
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);
124 double LinkEnergy::getPower()
130 double power_slope = busy_ - idle_;
132 double normalized_link_usage = link_->getUsage() / link_->bandwidth();
133 double dynamic_power = power_slope * normalized_link_usage;
135 return idle_ + dynamic_power;
138 double LinkEnergy::getTotalEnergy()
141 return this->totalEnergy_;
146 using simgrid::plugin::LinkEnergy;
148 /* **************************** events callback *************************** */
149 static void onCommunicate(simgrid::surf::NetworkAction* action, simgrid::s4u::Host* src, simgrid::s4u::Host* dst)
151 XBT_DEBUG("onCommunicate is called");
152 for (simgrid::surf::LinkImpl* link : action->links()) {
157 XBT_DEBUG("Update link %s", link->getCname());
158 LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
159 link_energy->initWattsRangeList();
160 link_energy->update();
164 static void onSimulationEnd()
166 std::vector<simgrid::s4u::Link*> links;
167 simgrid::s4u::Engine::getInstance()->getLinkList(&links);
169 double total_energy = 0.0; // Total dissipated energy (whole platform)
170 for (const auto link : links) {
171 double link_energy = link->extension<LinkEnergy>()->getTotalEnergy();
172 if (strcmp(link->getCname(), "__loopback__"))
173 XBT_INFO("Link '%s' total consumption: %f", link->getCname(), link_energy);
174 total_energy += link_energy;
177 XBT_INFO("Total energy over all links: %f", total_energy);
179 /* **************************** Public interface *************************** */
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
186 void sg_link_energy_plugin_init()
189 if (LinkEnergy::EXTENSION_ID.valid())
191 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
193 simgrid::s4u::Link::onCreation.connect([](simgrid::s4u::Link& link) {
194 link.extension_set(new LinkEnergy(&link));
197 simgrid::s4u::Link::onStateChange.connect([](simgrid::s4u::Link& link) {
198 link.extension<LinkEnergy>()->update();
201 simgrid::s4u::Link::onDestruction.connect([](simgrid::s4u::Link& link) {
202 link.extension<LinkEnergy>()->update();
205 simgrid::s4u::Link::onCommunicationStateChange.connect([](simgrid::surf::NetworkAction* action) {
206 for (simgrid::surf::LinkImpl* link : action->links()) {
208 link->piface_.extension<LinkEnergy>()->update();
212 simgrid::s4u::Link::onCommunicate.connect(&onCommunicate);
213 simgrid::s4u::onSimulationEnd.connect(&onSimulationEnd);