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()) {}
53 ~LinkEnergy() = default;
55 void init_watts_range_list();
56 double get_consumed_energy();
60 double get_power() const;
68 double total_energy_{0.0};
69 double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
72 xbt::Extension<s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
74 void LinkEnergy::update()
77 init_watts_range_list();
79 double power = get_power();
80 double now = surf_get_clock();
81 total_energy_ += power * (now - last_updated_);
85 void LinkEnergy::init_watts_range_list()
91 const char* all_power_values_str = this->link_->get_property("wattage_range");
92 if (all_power_values_str == nullptr) {
93 all_power_values_str = this->link_->get_property("watt_range");
94 if (all_power_values_str != nullptr)
95 XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
98 if (all_power_values_str == nullptr)
101 std::vector<std::string> all_power_values;
102 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
104 for (auto current_power_values_str : all_power_values) {
105 /* retrieve the power values associated */
106 std::vector<std::string> current_power_values;
107 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
108 xbt_assert(current_power_values.size() == 2,
109 "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
110 this->link_->get_cname());
112 /* min_power corresponds to the idle power (link load = 0) */
113 /* max_power is the power consumed at 100% link load */
115 idle_ = std::stod(current_power_values.front());
116 } catch (const std::invalid_argument&) {
117 throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
121 busy_ = std::stod(current_power_values.back());
122 } catch (const std::invalid_argument&) {
123 throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
128 double LinkEnergy::get_power() const
133 double power_slope = busy_ - idle_;
135 double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
136 double dynamic_power = power_slope * normalized_link_usage;
138 return idle_ + dynamic_power;
141 double LinkEnergy::get_consumed_energy()
143 if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
144 kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
145 return this->total_energy_;
147 } // namespace plugin
148 } // namespace simgrid
150 using simgrid::plugin::LinkEnergy;
152 /* **************************** events callback *************************** */
153 static void on_communicate(const simgrid::kernel::resource::NetworkAction& action)
155 XBT_DEBUG("onCommunicate is called");
156 for (auto const* link : action.get_links()) {
157 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
160 XBT_DEBUG("Update link %s", link->get_cname());
161 auto* link_energy = link->get_iface()->extension<LinkEnergy>();
162 link_energy->init_watts_range_list();
163 link_energy->update();
167 static void on_simulation_end()
169 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
171 double total_energy = 0.0; // Total dissipated energy (whole platform)
172 for (auto const* link : links) {
173 if (link == nullptr || link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI)
176 double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
177 total_energy += link_energy;
180 XBT_INFO("Total energy over all links: %f", total_energy);
182 /* **************************** Public interface *************************** */
184 int sg_link_energy_is_inited()
186 return LinkEnergy::EXTENSION_ID.valid();
188 /** @ingroup plugin_link_energy
189 * @brief Enable energy plugin
190 * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
191 * loading your platform.
193 void sg_link_energy_plugin_init()
195 if (LinkEnergy::EXTENSION_ID.valid())
197 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
199 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
201 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) {
202 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI) {
203 XBT_DEBUG("Wired Link created: %s", link.get_cname());
204 link.extension_set(new LinkEnergy(&link));
206 XBT_DEBUG("Not Wired link: %s", link.get_cname());
210 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link const& link) {
211 if (link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
212 link.extension<LinkEnergy>()->update();
215 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
216 if (link.get_name() != "__loopback__" && link.get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
217 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
218 link.extension<LinkEnergy>()->get_consumed_energy());
221 simgrid::s4u::Link::on_communication_state_change.connect(
222 [](simgrid::kernel::resource::NetworkAction const& action,
223 simgrid::kernel::resource::Action::State /* previous */) {
224 for (auto const* link : action.get_links()) {
225 if (link != nullptr && link->get_sharing_policy() != simgrid::s4u::Link::SharingPolicy::WIFI)
226 link->get_iface()->extension<LinkEnergy>()->update();
230 simgrid::s4u::Link::on_communicate.connect(&on_communicate);
231 simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
234 /** @ingroup plugin_link_energy
235 * @brief Returns the total energy consumed by the link so far (in Joules)
237 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
238 * The result is that the actor requesting this value will be interrupted,
239 * the value will be updated in kernel mode before returning the control to the requesting actor.
241 double sg_link_get_consumed_energy(const_sg_link_t link)
243 if (not LinkEnergy::EXTENSION_ID.valid())
244 throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
245 "before calling sg_link_get_consumed_energy().");
246 return link->extension<LinkEnergy>()->get_consumed_energy();