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 "surf/surf.hpp"
11 #include <boost/algorithm/string/classification.hpp>
12 #include <boost/algorithm/string/split.hpp>
14 /** @addtogroup SURF_plugin_energy
17 This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
19 The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
20 platform file as follows:
23 <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
24 <prop id="watt_range" value="100.0:200.0" />
25 <prop id="watt_off" value="10" />
29 The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
30 If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
31 The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these
32 values are arbitrary).
34 To simulate the energy-related elements, first call the simgrid#energy#sg_link_energy_plugin_init() before your
36 and then use the following function to retrieve the consumption of a given link: sg_link_get_consumed_energy().
39 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy, surf, "Logging specific to the SURF LinkEnergy plugin");
46 static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
48 explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
49 ~LinkEnergy() = default;
51 void init_watts_range_list();
52 double get_consumed_energy();
58 simgrid::s4u::Link* link_{};
64 double total_energy_{0.0};
65 double last_updated_{0.0}; /*< Timestamp of the last energy update event*/
68 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
70 void LinkEnergy::update()
72 double power = get_power();
73 double now = surf_get_clock();
74 total_energy_ += power * (now - last_updated_);
78 void LinkEnergy::init_watts_range_list()
85 const char* all_power_values_str = this->link_->get_property("watt_range");
87 if (all_power_values_str == nullptr)
90 std::vector<std::string> all_power_values;
91 boost::split(all_power_values, all_power_values_str, boost::is_any_of(","));
93 for (auto current_power_values_str : all_power_values) {
94 /* retrieve the power values associated */
95 std::vector<std::string> current_power_values;
96 boost::split(current_power_values, current_power_values_str, boost::is_any_of(":"));
97 xbt_assert(current_power_values.size() == 2,
98 "Power properties incorrectly defined - could not retrieve idle and busy power values for link %s",
99 this->link_->get_cname());
101 /* min_power corresponds to the idle power (link load = 0) */
102 /* max_power is the power consumed at 100% link load */
103 char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->get_cname());
104 char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->get_cname());
106 idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
107 busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
115 double LinkEnergy::get_power()
121 double power_slope = busy_ - idle_;
123 double normalized_link_usage = link_->get_usage() / link_->get_bandwidth();
124 double dynamic_power = power_slope * normalized_link_usage;
126 return idle_ + dynamic_power;
129 double LinkEnergy::get_consumed_energy()
131 if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
132 simgrid::simix::simcall(std::bind(&LinkEnergy::update, this));
133 return this->total_energy_;
135 } // namespace plugin
136 } // namespace simgrid
138 using simgrid::plugin::LinkEnergy;
140 /* **************************** events callback *************************** */
141 static void on_communicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host* src,
142 simgrid::s4u::Host* dst)
144 XBT_DEBUG("onCommunicate is called");
145 for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
150 XBT_DEBUG("Update link %s", link->get_cname());
151 LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
152 link_energy->init_watts_range_list();
153 link_energy->update();
157 static void on_simulation_end()
159 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
161 double total_energy = 0.0; // Total dissipated energy (whole platform)
162 for (const auto link : links) {
163 double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();
164 total_energy += link_energy;
167 XBT_INFO("Total energy over all links: %f", total_energy);
169 /* **************************** Public interface *************************** */
171 int sg_link_energy_is_inited()
173 return LinkEnergy::EXTENSION_ID.valid();
175 /** \ingroup SURF_plugin_energy
176 * \brief Enable energy plugin
177 * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before
180 void sg_link_energy_plugin_init()
183 if (LinkEnergy::EXTENSION_ID.valid())
185 LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
187 xbt_assert(sg_host_count() == 0, "Please call sg_link_energy_plugin_init() before initializing the platform.");
189 simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
191 simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link& link) { link.extension<LinkEnergy>()->update(); });
193 simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link& link) {
194 if (strcmp(link.get_cname(), "__loopback__"))
195 XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
196 link.extension<LinkEnergy>()->get_consumed_energy());
199 simgrid::s4u::Link::on_communication_state_change.connect([](simgrid::kernel::resource::NetworkAction* action) {
200 for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
202 link->piface_.extension<LinkEnergy>()->update();
206 simgrid::s4u::Link::on_communicate.connect(&on_communicate);
207 simgrid::s4u::on_simulation_end.connect(&on_simulation_end);
210 /** @ingroup plugin_energy
211 * @brief Returns the total energy consumed by the link so far (in Joules)
213 * Please note that since the consumption is lazily updated, it may require a simcall to update it.
214 * The result is that the actor requesting this value will be interrupted,
215 * the value will be updated in kernel mode before returning the control to the requesting actor.
217 double sg_link_get_consumed_energy(sg_link_t link)
219 return link->extension<LinkEnergy>()->get_consumed_energy();