1 /* Copyright (c) 2017-2018. 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 "src/surf/network_interface.hpp"
9 #include "surf/surf.hpp"
11 #include <boost/algorithm/string/classification.hpp>
12 #include <boost/algorithm/string/split.hpp>
14 /** @addtogroup SURF_plugin_energy
17 This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
19 The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
20 platform file as follows:
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" />
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).
34 To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
36 and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
39 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
46 static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
48 explicit LinkEnergy(simgrid::s4u::Link* ptr);
51 void initWattsRangeList();
52 double getConsumedEnergy();
58 simgrid::s4u::Link* link_{};
64 double totalEnergy_{0.0};
65 double lastUpdated_{0.0}; /*< Timestamp of the last energy update event*/
68 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
70 LinkEnergy::LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), lastUpdated_(surf_get_clock())
74 LinkEnergy::~LinkEnergy() = default;
76 void LinkEnergy::update()
78 double power = getPower();
79 double now = surf_get_clock();
80 totalEnergy_ += power * (now - lastUpdated_);
84 void LinkEnergy::initWattsRangeList()
91 const char* all_power_values_str = this->link_->getProperty("watt_range");
93 if (all_power_values_str == nullptr)
96 std::vector<std::string> all_power_values;
97 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
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());
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());
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);
121 double LinkEnergy::getPower()
127 double power_slope = busy_ - idle_;
129 double normalized_link_usage = link_->getUsage() / link_->bandwidth();
130 double dynamic_power = power_slope * normalized_link_usage;
132 return idle_ + dynamic_power;
135 double LinkEnergy::getConsumedEnergy()
137 if (lastUpdated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
138 simgrid::simix::kernelImmediate(std::bind(&LinkEnergy::update, this));
139 return this->totalEnergy_;
144 using simgrid::plugin::LinkEnergy;
146 /* **************************** events callback *************************** */
147 static void onCommunicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host* src,
148 simgrid::s4u::Host* dst)
150 XBT_DEBUG("onCommunicate is called");
151 for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
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();
163 static void onSimulationEnd()
165 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::getInstance()->getAllLinks();
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;
173 XBT_INFO("Total energy over all links: %f", total_energy);
175 /* **************************** Public interface *************************** */
177 int sg_link_energy_is_inited()
179 return LinkEnergy::EXTENSION_ID.valid();
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 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
195 simgrid::s4u::Link::onCreation.connect([](simgrid::s4u::Link& link) {
196 link.extension_set(new LinkEnergy(&link));
199 simgrid::s4u::Link::onStateChange.connect([](simgrid::s4u::Link& link) {
200 link.extension<LinkEnergy>()->update();
203 simgrid::s4u::Link::onDestruction.connect([](simgrid::s4u::Link& link) {
204 if (strcmp(link.get_cname(), "__loopback__"))
205 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
206 link.extension<LinkEnergy>()->getConsumedEnergy());
209 simgrid::s4u::Link::onCommunicationStateChange.connect([](simgrid::kernel::resource::NetworkAction* action) {
210 for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
212 link->piface_.extension<LinkEnergy>()->update();
216 simgrid::s4u::Link::onCommunicate.connect(&onCommunicate);
217 simgrid::s4u::onSimulationEnd.connect(&onSimulationEnd);
220 /** @ingroup plugin_energy
221 * @brief Returns the total energy consumed by the link so far (in Joules)
223 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
224 * The result is that the actor requesting this value will be interrupted,
225 * the value will be updated in kernel mode before returning the control to the requesting actor.
227 double sg_link_get_consumed_energy(sg_link_t link)
229 return link->extension<LinkEnergy>()->getConsumedEnergy();