-/* Copyright (c) 2017-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2017-2021. 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 <simgrid/plugins/energy.h>
+#include <simgrid/s4u/Engine.hpp>
+#include <simgrid/s4u/Link.hpp>
+
+#include "src/kernel/activity/CommImpl.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 <boost/algorithm/string/classification.hpp>
#include <boost/algorithm/string/split.hpp>
-#include <map>
SIMGRID_REGISTER_PLUGIN(link_energy_wifi, "Energy wifi test", &sg_wifi_energy_plugin_init);
-/** @degroup plugin_link_energy_wifi Plugin WiFi energy
+/** @defgroup plugin_link_energy_wifi Plugin WiFi energy
*
* This is the WiFi energy plugin, accounting for the dissipated energy of WiFi links.
*/
namespace plugin {
class XBT_PRIVATE LinkEnergyWifi {
-public:
- static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
+ // associative array keeping size of data already sent for a given flow (required for interleaved actions)
+ std::map<kernel::resource::NetworkWifiAction*, std::pair<int, double>> 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};
- explicit LinkEnergyWifi(simgrid::s4u::Link* ptr) : link_(ptr) {}
+public:
+ static xbt::Extension<simgrid::s4u::Link, LinkEnergyWifi> EXTENSION_ID;
- ~LinkEnergyWifi() = default;
+ 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();
/**
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<simgrid::kernel::resource::NetworkWifiAction*, std::pair<int, double>> 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<s4u::Link, LinkEnergyWifi> LinkEnergyWifi::EXTENSION_ID;
void LinkEnergyWifi::update_destroy()
{
- auto const* wifi_link = static_cast<simgrid::kernel::resource::NetworkWifiLink*>(link_->get_impl());
- double duration = surf_get_clock() - prev_update_;
- prev_update_ = surf_get_clock();
+ auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
+ double duration = simgrid::s4u::Engine::get_clock() - prev_update_;
+ prev_update_ = simgrid::s4u::Engine::get_clock();
dur_idle_ += duration;
XBT_DEBUG("finish eStat_ += %f * %f * (%d+1) | eStat = %f", duration, pIdle_, wifi_link->get_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<simgrid::kernel::resource::NetworkWifiLink*>(link_->get_impl());
+ auto const* wifi_link = static_cast<kernel::resource::NetworkWifiLink*>(link_->get_impl());
- const kernel::lmm::Variable* var;
const kernel::lmm::Element* elem = nullptr;
/**
* 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))) {
+ while (const auto* var = wifi_link->get_constraint()->get_variable(&elem)) {
auto* action = static_cast<kernel::resource::NetworkWifiAction*>(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()));
- action->get_variable();
-
- double du = 0; // durUsage on the current flow
- std::map<simgrid::kernel::resource::NetworkWifiAction *, std::pair<int, double>>::iterator it;
+ 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()) {
- it = flowTmp.find(action);
+ 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
if(it == flowTmp.end())
* The active duration of the link is equal to the amount of data it had to send divided by the bandwidth on the link.
* If this is longer than the duration since the previous update, active duration = now - previous_update
*/
- du = (action->get_cost()-it->second.first) / action->get_variable()->get_value();
+ double du = // durUsage on the current flow
+ (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())
* - if idle i.e. get_usage = 0, update P_{stat}
* P_{tot} = P_{dyn}+P_{stat}
*/
- if(link_->get_usage()){
+ if (link_->get_usage() != 0.0) {
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);
dur_TxRx_ += duration;
- }else{
+ } else {
dur_idle_ += duration;
eStat_ += (duration - (duration * control_duration_)) * pIdle_ * (wifi_link->get_host_count() + 1);
}
} // namespace simgrid
using simgrid::plugin::LinkEnergyWifi;
+/* **************************** events callback *************************** */
+static void on_communication(const simgrid::kernel::activity::CommImpl& comm)
+{
+ for (const auto* link : comm.get_traversed_links()) {
+ if (link != nullptr && link->get_sharing_policy() == simgrid::s4u::Link::SharingPolicy::WIFI) {
+ auto* link_energy = link->extension<LinkEnergyWifi>();
+ XBT_DEBUG("Update %s on Comm Start/End", link->get_cname());
+ link_energy->update();
+ }
+ }
+}
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) {
// 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());
- LinkEnergyWifi* plugin = new LinkEnergyWifi(&link);
+ auto* plugin = new LinkEnergyWifi(&link);
link.extension_set(plugin);
} else {
XBT_DEBUG("Not Wifi Link: %s, wifi energy on link not computed", link.get_cname());
// 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<LinkEnergyWifi>()->update(action);
+ link->get_iface()->extension<LinkEnergyWifi>()->update();
}
}
});
- simgrid::s4u::Link::on_communicate.connect([](const simgrid::kernel::resource::NetworkAction& action) {
- const simgrid::kernel::resource::NetworkWifiAction* actionWifi = dynamic_cast<const simgrid::kernel::resource::NetworkWifiAction*>(&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<LinkEnergyWifi>()->update(action);
- if(link_dst != nullptr)
- link_dst->get_iface()->extension<LinkEnergyWifi>()->update(action);
- });
+ simgrid::kernel::activity::CommImpl::on_start.connect(&on_communication);
+ simgrid::kernel::activity::CommImpl::on_completion.connect(&on_communication);
}
