X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fc646b32904fce0465f564d149a830c8e7aeffe4..501b1d3f4293a4a3c27ad38fd74e995584799576:/src/plugins/link_energy_wifi.cpp diff --git a/src/plugins/link_energy_wifi.cpp b/src/plugins/link_energy_wifi.cpp index c2ff738043..ec2e84ce34 100644 --- a/src/plugins/link_energy_wifi.cpp +++ b/src/plugins/link_energy_wifi.cpp @@ -1,23 +1,20 @@ -/* Copyright (c) 2017-2021. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2017-2023. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#include "simgrid/Exception.hpp" -#include "simgrid/plugins/energy.h" -#include "simgrid/s4u/Engine.hpp" -#include "simgrid/s4u/Host.hpp" -#include "simgrid/s4u/Link.hpp" -#include "src/surf/network_interface.hpp" -#include "src/surf/network_wifi.hpp" -#include "src/surf/surf_interface.hpp" -#include "surf/surf.hpp" -#include "src/kernel/lmm/maxmin.hpp" -#include "xbt/config.hpp" +#include +#include +#include +#include + +#include "src/kernel/activity/CommImpl.hpp" +#include "src/kernel/resource/StandardLinkImpl.hpp" +#include "src/kernel/resource/WifiLinkImpl.hpp" +#include "src/simgrid/module.hpp" #include #include -#include SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_plugin_init); /** @defgroup plugin_link_energy_wifi Plugin WiFi energy @@ -25,26 +22,50 @@ SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_pl * This is the WiFi energy plugin, accounting for the dissipated energy of WiFi links. */ -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy_wifi, surf, "Logging specific to the link energy wifi plugin"); +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(link_energy_wifi, kernel, "Logging specific to the link energy wifi plugin"); -namespace simgrid { -namespace plugin { +namespace simgrid::plugin { class XBT_PRIVATE LinkEnergyWifi { + // associative array keeping size of data already sent for a given flow (required for interleaved actions) + std::map> flowTmp{}; + + // WiFi link the plugin instance is attached to + s4u::Link* link_{}; + + // dynamic energy accumulated since the simulation start (active durations consumption) + double eDyn_{0.0}; + // static energy (no activity consumption) + double eStat_{0.0}; + + // duration since previous energy update + double prev_update_{0.0}; + + // Same energy calibration values as ns3 by default + // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details + double pIdle_{0.82}; + double pTx_{1.14}; + double pRx_{0.94}; + double pSleep_{0.10}; + + // constant taking beacons into account (can be specified by the user) + double control_duration_{0.0036}; + + // Measurements for report + double dur_TxRx_{0}; // Duration of transmission + double dur_idle_{0}; // Duration of idle time + bool valuesInit_{false}; + public: - static simgrid::xbt::Extension EXTENSION_ID; + static xbt::Extension EXTENSION_ID; - explicit LinkEnergyWifi(simgrid::s4u::Link* ptr) : link_(ptr) {} + explicit LinkEnergyWifi(s4u::Link* ptr) : link_(ptr) {} LinkEnergyWifi() = delete; - /** - * Update the energy consumed by link_ when transmissions start or end - */ - void update(const simgrid::kernel::resource::NetworkAction &); + /** Update the energy consumed by link_ when transmissions start or end */ + void update(); - /** - * Update the energy consumed when link_ is destroyed - */ + /** Update the energy consumed when link_ is destroyed */ void update_destroy(); /** @@ -72,69 +93,39 @@ public: void set_power_rx(double value) { pRx_ = value; } /** Set the power consumed by this link while sleeping */ void set_power_sleep(double value) { pSleep_ = value; } - -private: - // associative array keeping size of data already sent for a given flow (required for interleaved actions) - std::map> flowTmp{}; - - // WiFi link the plugin instance is attached to - s4u::Link* link_{}; - - // dynamic energy accumulated since the simulation start (active durations consumption) - double eDyn_{0.0}; - // static energy (no activity consumption) - double eStat_{0.0}; - - // duration since previous energy update - double prev_update_{0.0}; - - // Same energy calibration values as ns3 by default - // https://www.nsnam.org/docs/release/3.30/doxygen/classns3_1_1_wifi_radio_energy_model.html#details - double pIdle_{0.82}; - double pTx_{1.14}; - double pRx_{0.94}; - double pSleep_{0.10}; - - // constant taking beacons into account (can be specified by the user) - double control_duration_{0.0036}; - - // Measurements for report - double dur_TxRx_{0}; // Duration of transmission - double dur_idle_{0}; // Duration of idle time - bool valuesInit_{false}; }; xbt::Extension LinkEnergyWifi::EXTENSION_ID; void LinkEnergyWifi::update_destroy() { - auto const* wifi_link = static_cast(link_->get_impl()); - double duration = surf_get_clock() - prev_update_; - prev_update_ = surf_get_clock(); + auto const* wifi_link = static_cast(link_->get_impl()); + double duration = simgrid::s4u::Engine::get_clock() - prev_update_; + prev_update_ = simgrid::s4u::Engine::get_clock(); dur_idle_ += duration; // add IDLE energy usage, as well as beacons consumption since previous update - eDyn_ += duration * control_duration_ * wifi_link->get_host_count() * pRx_; - eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1); + const auto host_count = static_cast(wifi_link->get_host_count()); + eDyn_ += duration * control_duration_ * host_count * pRx_; + eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (host_count + 1); - XBT_DEBUG("finish eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_); + XBT_DEBUG("finish eStat_ += %f * %f * (%f+1) | eStat = %f", duration, pIdle_, host_count, eStat_); } -void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&) +void LinkEnergyWifi::update() { init_watts_range_list(); - double duration = surf_get_clock() - prev_update_; - prev_update_ = surf_get_clock(); + double duration = simgrid::s4u::Engine::get_clock() - prev_update_; + prev_update_ = simgrid::s4u::Engine::get_clock(); // we don't update for null durations if(duration < 1e-6) return; - auto const* wifi_link = static_cast(link_->get_impl()); + auto const* wifi_link = static_cast(link_->get_impl()); - const kernel::lmm::Variable* var; const kernel::lmm::Element* elem = nullptr; /** @@ -147,11 +138,12 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&) * used by the flow with the longest active time since the previous update */ double durUsage = 0; - while((var = wifi_link->get_constraint()->get_variable(&elem))) { - auto* action = static_cast(var->get_id()); - XBT_DEBUG("cost: %f action value: %f link rate 1: %f link rate 2: %f", action->get_cost(), action->get_variable()->get_value(), wifi_link->get_host_rate(&action->get_src()),wifi_link->get_host_rate(&action->get_dst())); + while (const auto* var = wifi_link->get_constraint()->get_variable(&elem)) { + auto* action = static_cast(var->get_id()); + XBT_DEBUG("cost: %f action value: %f link rate 1: %f link rate 2: %f", action->get_cost(), action->get_rate(), + wifi_link->get_host_rate(&action->get_src()), wifi_link->get_host_rate(&action->get_dst())); - if(action->get_variable()->get_value()) { + if (action->get_rate() != 0.0) { auto it = flowTmp.find(action); // if the flow has not been registered, initialize it: 0 bytes sent, and not updated since its creation timestamp @@ -165,18 +157,18 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&) * If this is longer than the duration since the previous update, active duration = now - previous_update */ double du = // durUsage on the current flow - (action->get_cost() - it->second.first) / action->get_variable()->get_value(); + (action->get_cost() - it->second.first) / action->get_rate(); - if(du > surf_get_clock()-it->second.second) - du = surf_get_clock()-it->second.second; + if (du > simgrid::s4u::Engine::get_clock() - it->second.second) + du = simgrid::s4u::Engine::get_clock() - it->second.second; // if the flow has been more active than the others if(du > durUsage) durUsage = du; // update the amount of data already sent by the flow - it->second.first += du*action->get_variable()->get_value(); - it->second.second = surf_get_clock(); + it->second.first += du * action->get_rate(); + it->second.second = simgrid::s4u::Engine::get_clock(); // important: if the transmission finished, remove it (needed for performance and multi-message flows) if(it->second.first >= action->get_cost()) @@ -187,7 +179,8 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&) XBT_DEBUG("durUsage: %f", durUsage); // beacons cost - eDyn_ += duration * control_duration_ * wifi_link->get_host_count() * pRx_; + const auto host_count = static_cast(wifi_link->get_host_count()); + eDyn_ += duration * control_duration_ * host_count * pRx_; /** * Same principle as ns3: @@ -195,18 +188,18 @@ void LinkEnergyWifi::update(const simgrid::kernel::resource::NetworkAction&) * - if idle i.e. get_usage = 0, update P_{stat} * P_{tot} = P_{dyn}+P_{stat} */ - if(link_->get_usage()){ - eDyn_ += /*duration * */ durUsage * ((wifi_link->get_host_count() * pRx_) + pTx_); - eStat_ += (duration - durUsage) * pIdle_ * (wifi_link->get_host_count() + 1); - XBT_DEBUG("eDyn += %f * ((%d * %f) + %f) | eDyn = %f (durusage =%f)", durUsage, wifi_link->get_host_count(), pRx_, - pTx_, eDyn_, durUsage); + if (link_->get_load() != 0.0) { + eDyn_ += /*duration * */ durUsage * ((host_count * pRx_) + pTx_); + eStat_ += (duration - durUsage) * pIdle_ * (host_count + 1); + XBT_DEBUG("eDyn += %f * ((%f * %f) + %f) | eDyn = %f (durusage =%f)", durUsage, host_count, pRx_, pTx_, eDyn_, + durUsage); dur_TxRx_ += duration; - }else{ + } else { dur_idle_ += duration; - eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1); + eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (host_count + 1); } - XBT_DEBUG("eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_host_count(), eStat_); + XBT_DEBUG("eStat_ += %f * %f * (%f+1) | eStat = %f", duration, pIdle_, host_count, eStat_); } void LinkEnergyWifi::init_watts_range_list() @@ -219,12 +212,11 @@ void LinkEnergyWifi::init_watts_range_list() Set to 0 if you do not want to compute beacons, otherwise to the duration of beacons transmissions per second */ - const char* beacons_factor = this->link_->get_property("control_duration"); - if(beacons_factor != nullptr) { + if (const char* beacons_factor = this->link_->get_property("control_duration")) { try { control_duration_ = std::stod(beacons_factor); } catch (const std::invalid_argument&) { - throw std::invalid_argument(std::string("Invalid beacons factor value for link ") + this->link_->get_cname()); + throw std::invalid_argument("Invalid beacons factor value for link " + this->link_->get_name()); } } @@ -247,22 +239,22 @@ void LinkEnergyWifi::init_watts_range_list() try { pSleep_ = std::stod(current_power_values.at(3)); } catch (const std::invalid_argument&) { - throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname()); + throw std::invalid_argument("Invalid idle power value for link " + this->link_->get_name()); } try { pRx_ = std::stod(current_power_values.at(2)); } catch (const std::invalid_argument&) { - throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname()); + throw std::invalid_argument("Invalid idle power value for link " + this->link_->get_name()); } try { pTx_ = std::stod(current_power_values.at(1)); } catch (const std::invalid_argument&) { - throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname()); + throw std::invalid_argument("Invalid idle power value for link " + this->link_->get_name()); } try { pIdle_ = std::stod(current_power_values.at(0)); } catch (const std::invalid_argument&) { - throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname()); + throw std::invalid_argument("Invalid busy power value for link " + this->link_->get_name()); } XBT_DEBUG("Values aa initialized with: pSleep=%f pIdle=%f pTx=%f pRx=%f", pSleep_, pIdle_, pTx_, pRx_); @@ -270,10 +262,21 @@ void LinkEnergyWifi::init_watts_range_list() } } -} // namespace plugin -} // namespace simgrid +} // namespace simgrid::plugin using simgrid::plugin::LinkEnergyWifi; +/* **************************** events callback *************************** */ +static void on_communication(const simgrid::s4u::Comm& comm) +{ + const auto* pimpl = static_cast(comm.get_impl()); + for (auto const* link : pimpl->get_traversed_links()) { + if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) { + auto* link_energy = link->extension(); + XBT_DEBUG("Update %s on Comm Start/End", link->get_cname()); + link_energy->update(); + } + } +} void sg_wifi_energy_plugin_init() { @@ -285,12 +288,12 @@ void sg_wifi_energy_plugin_init() /** * Attaching to events: - * - on_creation to initialize the plugin - * - on_destruction to produce final energy results - * - on_communication_state_change: to account the energy when communications are updated - * - on_communicate: '' + * - Link::on_creation to initialize the plugin + * - Link::on_destruction to produce final energy results + * - Link::on_communication_state_change: to account for the energy when communications are updated + * - CommImpl::on_start and CommImpl::on_completion: to account for the energy during communications */ - simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { + simgrid::s4u::Link::on_creation_cb([](simgrid::s4u::Link& link) { // verify the link is appropriate to WiFi energy computations if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) { XBT_DEBUG("Wifi Link: %s, initialization of wifi energy plugin", link.get_cname()); @@ -301,7 +304,7 @@ void sg_wifi_energy_plugin_init() } }); - simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) { + simgrid::s4u::Link::on_destruction_cb([](simgrid::s4u::Link const& link) { // output energy values if WiFi link if (link.get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) { link.extension()->update_destroy(); @@ -313,29 +316,16 @@ void sg_wifi_energy_plugin_init() } }); - simgrid::s4u::Link::on_communication_state_change.connect( - [](simgrid::kernel::resource::NetworkAction const& action, - simgrid::kernel::resource::Action::State /* previous */) { - // update WiFi links encountered during the communication - for (auto const* link : action.get_links()) { - if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) { - link->get_iface()->extension()->update(action); - } - } - }); - - simgrid::s4u::Link::on_communicate.connect([](const simgrid::kernel::resource::NetworkAction& action) { - auto const* actionWifi = dynamic_cast(&action); - - if (actionWifi == nullptr) - return; - - auto const* link_src = actionWifi->get_src_link(); - auto const* link_dst = actionWifi->get_dst_link(); - - if(link_src != nullptr) - link_src->get_iface()->extension()->update(action); - if(link_dst != nullptr) - link_dst->get_iface()->extension()->update(action); + simgrid::s4u::Link::on_communication_state_change_cb([](simgrid::kernel::resource::NetworkAction const& action, + simgrid::kernel::resource::Action::State /* previous */) { + // update WiFi links encountered during the communication + for (auto const* link : action.get_links()) { + if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) { + link->get_iface()->extension()->update(); + } + } }); + + simgrid::s4u::Comm::on_start_cb(&on_communication); + simgrid::s4u::Comm::on_completion_cb(&on_communication); }