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 "src/surf/surf_interface.hpp"
10 #include "surf/surf.hpp"
12 #include <boost/algorithm/string/classification.hpp>
13 #include <boost/algorithm/string/split.hpp>
15 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
17 /** @addtogroup SURF_plugin_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="watt_range" value="100.0:200.0" />
28 <prop id="watt_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 simgrid#energy#sg_link_energy_plugin_init() before your
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");
49 static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
51 explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
52 ~LinkEnergy() = default;
54 void init_watts_range_list();
55 double get_consumed_energy();
61 simgrid::s4u::Link* link_{};
67 double total_energy_{0.0};
68 double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
71 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
73 void LinkEnergy::update()
75 double power = get_power();
76 double now = surf_get_clock();
77 total_energy_ += power * (now - last_updated_);
81 void LinkEnergy::init_watts_range_list()
88 const char* all_power_values_str = this->link_->get_property("watt_range");
90 if (all_power_values_str == nullptr)
93 std::vector<std::string> all_power_values;
94 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
96 for (auto current_power_values_str : all_power_values) {
97 /* retrieve the power values associated */
98 std::vector<std::string> current_power_values;
99 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
100 xbt_assert(current_power_values.size() == 2,
101 "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
102 this->link_->get_cname());
104 /* min_power corresponds to the idle power (link load = 0) */
105 /* max_power is the power consumed at 100% link load */
106 char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->get_cname());
107 char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->get_cname());
109 idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
110 busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
118 double LinkEnergy::get_power()
124 double power_slope = busy_ - idle_;
126 double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
127 double dynamic_power = power_slope * normalized_link_usage;
129 return idle_ + dynamic_power;
132 double LinkEnergy::get_consumed_energy()
134 if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
135 simgrid::simix::simcall(std::bind(&LinkEnergy::update, this));
136 return this->total_energy_;
138 } // namespace plugin
139 } // namespace simgrid
141 using simgrid::plugin::LinkEnergy;
143 /* **************************** events callback *************************** */
144 static void on_communicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host*, simgrid::s4u::Host*)
146 XBT_DEBUG("onCommunicate is called");
147 for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
152 XBT_DEBUG("Update link %s", link->get_cname());
153 LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
154 link_energy->init_watts_range_list();
155 link_energy->update();
159 static void on_simulation_end()
161 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
163 double total_energy = 0.0; // Total dissipated energy (whole platform)
164 for (const auto link : links) {
165 double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
166 total_energy += link_energy;
169 XBT_INFO("Total energy over all links: %f", total_energy);
171 /* **************************** Public interface *************************** */
173 int sg_link_energy_is_inited()
175 return LinkEnergy::EXTENSION_ID.valid();
177 /** \ingroup SURF_plugin_energy
178 * \brief Enable energy plugin
179 * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before
182 void sg_link_energy_plugin_init()
185 if (LinkEnergy::EXTENSION_ID.valid())
187 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
189 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
191 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
193 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link& link) { link.extension<LinkEnergy>()->update(); });
195 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link& link) {
196 if (strcmp(link.get_cname(), "__loopback__"))
197 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
198 link.extension<LinkEnergy>()->get_consumed_energy());
201 simgrid::s4u::Link::on_communication_state_change.connect(
202 [](simgrid::kernel::resource::NetworkAction* action, simgrid::kernel::resource::Action::State /* previous */) {
203 for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
205 link->piface_.extension<LinkEnergy>()->update();
209 simgrid::s4u::Link::on_communicate.connect(&on_communicate);
210 simgrid::s4u::on_simulation_end.connect(&on_simulation_end);
213 /** @ingroup plugin_energy
214 * @brief Returns the total energy consumed by the link so far (in Joules)
216 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
217 * The result is that the actor requesting this value will be interrupted,
218 * the value will be updated in kernel mode before returning the control to the requesting actor.
220 double sg_link_get_consumed_energy(sg_link_t link)
222 return link->extension<LinkEnergy>()->get_consumed_energy();