1 /* Copyright (c) 2017-2020. 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/Exception.hpp"
7 #include "simgrid/plugins/energy.h"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "src/surf/network_interface.hpp"
10 #include "src/surf/surf_interface.hpp"
11 #include "surf/surf.hpp"
13 #include <boost/algorithm/string/classification.hpp>
14 #include <boost/algorithm/string/split.hpp>
16 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
18 /** @defgroup plugin_link_energy Plugin Link 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="wattage_range" value="100.0:200.0" />
28 <prop id="wattage_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 sg_link_energy_plugin_init() before loading the platform
38 and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
41 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
48 static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
50 explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
51 ~LinkEnergy() = default;
53 void init_watts_range_list();
54 double get_consumed_energy();
58 double get_power() const;
66 double total_energy_{0.0};
67 double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
70 xbt::Extension<s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
72 void LinkEnergy::update()
75 init_watts_range_list();
77 double power = get_power();
78 double now = surf_get_clock();
79 total_energy_ += power * (now - last_updated_);
83 void LinkEnergy::init_watts_range_list()
89 const char* all_power_values_str = this->link_->get_property("wattage_range");
90 if (all_power_values_str == nullptr) {
91 all_power_values_str = this->link_->get_property("watt_range");
92 if (all_power_values_str != nullptr)
93 XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
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_->get_cname());
110 /* min_power corresponds to the idle power (link load = 0) */
111 /* max_power is the power consumed at 100% link load */
113 idle_ = std::stod(current_power_values.front());
114 } catch (const std::invalid_argument&) {
115 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
119 busy_ = std::stod(current_power_values.back());
120 } catch (const std::invalid_argument&) {
121 throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
126 double LinkEnergy::get_power() const
131 double power_slope = busy_ - idle_;
133 double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
134 double dynamic_power = power_slope * normalized_link_usage;
136 return idle_ + dynamic_power;
139 double LinkEnergy::get_consumed_energy()
141 if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
142 kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
143 return this->total_energy_;
145 } // namespace plugin
146 } // namespace simgrid
148 using simgrid::plugin::LinkEnergy;
150 /* **************************** events callback *************************** */
151 static void on_communicate(const simgrid::kernel::resource::NetworkAction& action)
153 XBT_DEBUG("onCommunicate is called");
154 for (simgrid::kernel::resource::LinkImpl* link : action.get_links()) {
155 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
158 XBT_DEBUG("Update link %s", link->get_cname());
159 auto* link_energy = link->get_iface()->extension<LinkEnergy>();
160 link_energy->init_watts_range_list();
161 link_energy->update();
165 static void on_simulation_end()
167 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
169 double total_energy = 0.0; // Total dissipated energy (whole platform)
170 for (const auto link : links) {
171 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
174 double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
175 total_energy += link_energy;
178 XBT_INFO("Total energy over all links: %f", total_energy);
180 /* **************************** Public interface *************************** */
182 int sg_link_energy_is_inited()
184 return LinkEnergy::EXTENSION_ID.valid();
186 /** @ingroup plugin_link_energy
187 * @brief Enable energy plugin
188 * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
189 * loading your platform.
191 void sg_link_energy_plugin_init()
193 if (LinkEnergy::EXTENSION_ID.valid())
195 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
197 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
199 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
200 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
201 XBT_DEBUG("Wired Link created: %s", link.get_cname());
202 link.extension_set(new LinkEnergy(&link));
204 XBT_DEBUG("Not Wired link: %s", link.get_cname());
208 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link const& link) {
209 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
210 link.extension<LinkEnergy>()->update();
213 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
214 if (link.get_name() != "__loopback__" && link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
215 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
216 link.extension<LinkEnergy>()->get_consumed_energy());
219 simgrid::s4u::Link::on_communication_state_change.connect(
220 [](simgrid::kernel::resource::NetworkAction const& action,
221 simgrid::kernel::resource::Action::State /* previous */) {
222 for (simgrid::kernel::resource::LinkImpl* link : action.get_links()) {
223 if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
224 link->get_iface()->extension<LinkEnergy>()->update();
228 simgrid::s4u::Link::on_communicate.connect(&on_communicate);
229 simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
232 /** @ingroup plugin_link_energy
233 * @brief Returns the total energy consumed by the link so far (in Joules)
235 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
236 * The result is that the actor requesting this value will be interrupted,
237 * the value will be updated in kernel mode before returning the control to the requesting actor.
239 double sg_link_get_consumed_energy(const_sg_link_t link)
241 if (not LinkEnergy::EXTENSION_ID.valid())
242 throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
243 "before calling sg_link_get_consumed_energy().");
244 return link->extension<LinkEnergy>()->get_consumed_energy();