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/s4u/Link.hpp"
11 #include "src/kernel/activity/CommImpl.hpp"
12 #include "src/surf/surf_interface.hpp"
14 #include <boost/algorithm/string/classification.hpp>
15 #include <boost/algorithm/string/split.hpp>
17 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
19 /** @defgroup plugin_link_energy Plugin Link Energy
21 This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
23 The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
24 platform file as follows:
27 <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
28 <prop id="wattage_range" value="100.0:200.0" />
29 <prop id="wattage_off" value="10" />
33 The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
34 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
35 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
36 values are arbitrary).
38 To simulate the energy-related elements, first call the sg_link_energy_plugin_init() before loading the platform
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");
54 double total_energy_{0.0};
55 double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
57 double get_power() const;
60 static xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
62 explicit LinkEnergy(s4u::Link* ptr) : link_(ptr), last_updated_(simgrid::s4u::Engine::get_clock()) {}
64 void init_watts_range_list();
65 double get_consumed_energy();
69 xbt::Extension<s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
71 void LinkEnergy::update()
74 init_watts_range_list();
76 double power = get_power();
77 double now = simgrid::s4u::Engine::get_clock();
78 total_energy_ += power * (now - last_updated_);
82 void LinkEnergy::init_watts_range_list()
88 const char* all_power_values_str = this->link_->get_property("wattage_range");
89 if (all_power_values_str == nullptr) {
90 all_power_values_str = this->link_->get_property("watt_range");
91 if (all_power_values_str != nullptr)
92 XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
95 if (all_power_values_str == nullptr)
98 std::vector<std::string> all_power_values;
99 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
101 for (auto current_power_values_str : all_power_values) {
102 /* retrieve the power values associated */
103 std::vector<std::string> current_power_values;
104 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
105 xbt_assert(current_power_values.size() == 2,
106 "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
107 this->link_->get_cname());
109 /* min_power corresponds to the idle power (link load = 0) */
110 /* max_power is the power consumed at 100% link load */
112 idle_ = std::stod(current_power_values.front());
113 } catch (const std::invalid_argument&) {
114 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
118 busy_ = std::stod(current_power_values.back());
119 } catch (const std::invalid_argument&) {
120 throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
125 double LinkEnergy::get_power() const
130 double power_slope = busy_ - idle_;
132 double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
133 double dynamic_power = power_slope * normalized_link_usage;
135 return idle_ + dynamic_power;
138 double LinkEnergy::get_consumed_energy()
140 if (last_updated_ < simgrid::s4u::Engine::get_clock()) // We need to simcall this as it modifies the environment
141 kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
142 return this->total_energy_;
144 } // namespace plugin
145 } // namespace simgrid
147 using simgrid::plugin::LinkEnergy;
149 /* **************************** events callback *************************** */
150 static void on_simulation_end()
152 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
154 double total_energy = 0.0; // Total dissipated energy (whole platform)
155 for (auto const* link : links) {
156 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
159 double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
160 total_energy += link_energy;
163 XBT_INFO("Total energy over all links: %f", total_energy);
166 static void on_communication(const simgrid::kernel::activity::CommImpl& comm)
168 for (auto const* link : comm.get_traversed_links()) {
169 if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
170 XBT_DEBUG("Update %s on Comm Start/End", link->get_cname());
171 link->extension<LinkEnergy>()->update();
175 /* **************************** Public interface *************************** */
177 int sg_link_energy_is_inited()
179 return LinkEnergy::EXTENSION_ID.valid();
181 /** @ingroup plugin_link_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 * loading your platform.
186 void sg_link_energy_plugin_init()
188 if (LinkEnergy::EXTENSION_ID.valid())
190 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
192 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
194 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
195 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
196 XBT_DEBUG("Wired Link created: %s", link.get_cname());
197 link.extension_set(new LinkEnergy(&link));
199 XBT_DEBUG("Not Wired link: %s", link.get_cname());
203 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link const& link) {
204 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
205 link.extension<LinkEnergy>()->update();
208 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
209 if (link.get_name() != "__loopback__" && link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
210 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
211 link.extension<LinkEnergy>()->get_consumed_energy());
214 simgrid::kernel::activity::CommImpl::on_start.connect(&on_communication);
215 simgrid::kernel::activity::CommImpl::on_completion.connect(&on_communication);
217 simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
220 /** @ingroup plugin_link_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(const_sg_link_t link)
229 if (not LinkEnergy::EXTENSION_ID.valid())
230 throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
231 "before calling sg_link_get_consumed_energy().");
232 return link->extension<LinkEnergy>()->get_consumed_energy();