1 /* Copyright (c) 2017-2021. 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/host.h"
8 #include "simgrid/plugins/energy.h"
9 #include "simgrid/s4u/Engine.hpp"
10 #include "simgrid/simix.hpp"
11 #include "src/surf/network_interface.hpp"
12 #include "src/surf/surf_interface.hpp"
13 #include "surf/surf.hpp"
15 #include <boost/algorithm/string/classification.hpp>
16 #include <boost/algorithm/string/split.hpp>
18 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
20 /** @defgroup plugin_link_energy Plugin Link Energy
22 This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
24 The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
25 platform file as follows:
28 <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
29 <prop id="wattage_range" value="100.0:200.0" />
30 <prop id="wattage_off" value="10" />
34 The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
35 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
36 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
37 values are arbitrary).
39 To simulate the energy-related elements, first call the sg_link_energy_plugin_init() before loading the platform
40 and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
43 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
50 static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
52 explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
54 void init_watts_range_list();
55 double get_consumed_energy();
59 double get_power() const;
67 double total_energy_{0.0};
68 double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
71 xbt::Extension<s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
73 void LinkEnergy::update()
76 init_watts_range_list();
78 double power = get_power();
79 double now = surf_get_clock();
80 total_energy_ += power * (now - last_updated_);
84 void LinkEnergy::init_watts_range_list()
90 const char* all_power_values_str = this->link_->get_property("wattage_range");
91 if (all_power_values_str == nullptr) {
92 all_power_values_str = this->link_->get_property("watt_range");
93 if (all_power_values_str != nullptr)
94 XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
97 if (all_power_values_str == nullptr)
100 std::vector<std::string> all_power_values;
101 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
103 for (auto current_power_values_str : all_power_values) {
104 /* retrieve the power values associated */
105 std::vector<std::string> current_power_values;
106 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
107 xbt_assert(current_power_values.size() == 2,
108 "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
109 this->link_->get_cname());
111 /* min_power corresponds to the idle power (link load = 0) */
112 /* max_power is the power consumed at 100% link load */
114 idle_ = std::stod(current_power_values.front());
115 } catch (const std::invalid_argument&) {
116 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
120 busy_ = std::stod(current_power_values.back());
121 } catch (const std::invalid_argument&) {
122 throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
127 double LinkEnergy::get_power() const
132 double power_slope = busy_ - idle_;
134 double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
135 double dynamic_power = power_slope * normalized_link_usage;
137 return idle_ + dynamic_power;
140 double LinkEnergy::get_consumed_energy()
142 if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
143 kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
144 return this->total_energy_;
146 } // namespace plugin
147 } // namespace simgrid
149 using simgrid::plugin::LinkEnergy;
151 /* **************************** events callback *************************** */
152 static void on_communicate(const simgrid::kernel::resource::NetworkAction& action)
154 XBT_DEBUG("onCommunicate is called");
155 for (auto const* link : action.get_links()) {
156 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
159 XBT_DEBUG("Update link %s", link->get_cname());
160 auto* link_energy = link->get_iface()->extension<LinkEnergy>();
161 link_energy->init_watts_range_list();
162 link_energy->update();
166 static void on_simulation_end()
168 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
170 double total_energy = 0.0; // Total dissipated energy (whole platform)
171 for (auto const* link : links) {
172 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
175 double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
176 total_energy += link_energy;
179 XBT_INFO("Total energy over all links: %f", total_energy);
181 /* **************************** Public interface *************************** */
183 int sg_link_energy_is_inited()
185 return LinkEnergy::EXTENSION_ID.valid();
187 /** @ingroup plugin_link_energy
188 * @brief Enable energy plugin
189 * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
190 * loading your platform.
192 void sg_link_energy_plugin_init()
194 if (LinkEnergy::EXTENSION_ID.valid())
196 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
198 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
200 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
201 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
202 XBT_DEBUG("Wired Link created: %s", link.get_cname());
203 link.extension_set(new LinkEnergy(&link));
205 XBT_DEBUG("Not Wired link: %s", link.get_cname());
209 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link const& link) {
210 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
211 link.extension<LinkEnergy>()->update();
214 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
215 if (link.get_name() != "__loopback__" && link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
216 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
217 link.extension<LinkEnergy>()->get_consumed_energy());
220 simgrid::s4u::Link::on_communication_state_change.connect(
221 [](simgrid::kernel::resource::NetworkAction const& action,
222 simgrid::kernel::resource::Action::State /* previous */) {
223 for (auto const* link : action.get_links()) {
224 if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
225 link->get_iface()->extension<LinkEnergy>()->update();
229 simgrid::s4u::Link::on_communicate.connect(&on_communicate);
230 simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
233 /** @ingroup plugin_link_energy
234 * @brief Returns the total energy consumed by the link so far (in Joules)
236 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
237 * The result is that the actor requesting this value will be interrupted,
238 * the value will be updated in kernel mode before returning the control to the requesting actor.
240 double sg_link_get_consumed_energy(const_sg_link_t link)
242 if (not LinkEnergy::EXTENSION_ID.valid())
243 throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
244 "before calling sg_link_get_consumed_energy().");
245 return link->extension<LinkEnergy>()->get_consumed_energy();