MC: also ignore a library that has multiple read-only segments on fedora

[simgrid.git] / src / plugins / link_energy.cpp

diff --git a/src/plugins/link_energy.cpp b/src/plugins/link_energy.cpp
index 17aa277f90075c61ad3491e8b63e918d99baf793..3a8158137f1a7603131ea5ee901fe5bf667d9ed3 100644 (file)
--- a/src/plugins/link_energy.cpp
+++ b/src/plugins/link_energy.cpp
@@ -1,30 +1,33 @@
-/* Copyright (c) 2017-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2019. 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. */
 
 
 /* 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 "src/surf/network_interface.hpp"
 #include "simgrid/plugins/energy.h"
 #include "simgrid/s4u/Engine.hpp"
 #include "src/surf/network_interface.hpp"

+#include "src/surf/surf_interface.hpp"

 #include "surf/surf.hpp"
 
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 
 #include "surf/surf.hpp"
 
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 

-/** @addtogroup SURF_plugin_energy
+SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)

 
 

+/** @defgroup plugin_link_energy

 
  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
 
  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  platform file as follows:
 
 
  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
 
  The energy consumption of a link depends directly on its current traffic load. Specify that consumption in your
  platform file as follows:
 

- \verbatim
+ @verbatim

  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >

- <prop id="watt_range" value="100.0:200.0" />
- <prop id="watt_off" value="10" />
+ <prop id="wattage_range" value="100.0:200.0" />
+ <prop id="wattage_off" value="10" />

  </link>
  </link>

- \endverbatim
+ @endverbatim

 
  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.
 
  The first property means that when your link is switched on, but without anything to do, it will dissipate 100 Watts.
  If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts.


@@ -45,15 +48,15 @@ class LinkEnergy {
 public:
   static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
 
 public:
   static simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> EXTENSION_ID;
 

-  explicit LinkEnergy(simgrid::s4u::Link* ptr);
-  ~LinkEnergy();
+  explicit LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), last_updated_(surf_get_clock()) {}
+  ~LinkEnergy() = default;

 
 

-  void initWattsRangeList();
-  double getConsumedEnergy();
+  void init_watts_range_list();
+  double get_consumed_energy();

   void update();
 
 private:
   void update();
 
 private:

-  double getPower();
+  double get_power();

 
   simgrid::s4u::Link* link_{};
 
 
   simgrid::s4u::Link* link_{};
 


@@ -61,32 +64,35 @@ private:
   double idle_{0.0};
   double busy_{0.0};
 
   double idle_{0.0};
   double busy_{0.0};
 

-  double totalEnergy_{0.0};
-  double lastUpdated_{0.0}; /*< Timestamp of the last energy update event*/
+  double total_energy_{0.0};
+  double last_updated_{0.0}; /*< Timestamp of the last energy update event*/

 };
 
 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
 
 };
 
 simgrid::xbt::Extension<simgrid::s4u::Link, LinkEnergy> LinkEnergy::EXTENSION_ID;
 

-LinkEnergy::LinkEnergy(simgrid::s4u::Link* ptr) : link_(ptr), lastUpdated_(surf_get_clock()) {}
-
-LinkEnergy::~LinkEnergy() = default;
-

 void LinkEnergy::update()
 {
 void LinkEnergy::update()
 {

-  double power = getPower();
+  if (!inited_)
+    init_watts_range_list();
+
+  double power = get_power();

   double now   = surf_get_clock();
   double now   = surf_get_clock();

-  totalEnergy_ += power * (now - lastUpdated_);
-  lastUpdated_ = now;
+  total_energy_ += power * (now - last_updated_);
+  last_updated_ = now;

 }
 
 }
 

-void LinkEnergy::initWattsRangeList()
+void LinkEnergy::init_watts_range_list()

 {
 {

-

   if (inited_)
     return;
   inited_ = true;
 
   if (inited_)
     return;
   inited_ = true;
 

-  const char* all_power_values_str = this->link_->get_property("watt_range");
+  const char* all_power_values_str = this->link_->get_property("wattage_range");
+  if (all_power_values_str == nullptr) {
+    all_power_values_str = this->link_->get_property("watt_range");
+    if (all_power_values_str != nullptr)
+      XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
+  }

 
   if (all_power_values_str == nullptr)
     return;
 
   if (all_power_values_str == nullptr)
     return;


@@ -104,19 +110,21 @@ void LinkEnergy::initWattsRangeList()
 
     /* min_power corresponds to the idle power (link load = 0) */
     /* max_power is the power consumed at 100% link load       */
 
     /* min_power corresponds to the idle power (link load = 0) */
     /* max_power is the power consumed at 100% link load       */

-    char* idleMsg = bprintf("Invalid idle power value for link%s", this->link_->get_cname());
-    char* busyMsg = bprintf("Invalid busy power value for %s", this->link_->get_cname());
-
-    idle_ = xbt_str_parse_double((current_power_values.at(0)).c_str(), idleMsg);
-    busy_ = xbt_str_parse_double((current_power_values.at(1)).c_str(), busyMsg);
+    try {
+      idle_ = std::stod(current_power_values.front());
+    } catch (const std::invalid_argument&) {
+      throw std::invalid_argument(std::string("Invalid idle power value for link ") + this->link_->get_cname());
+    }

 
 

-    xbt_free(idleMsg);
-    xbt_free(busyMsg);
-    update();
+    try {
+      busy_ = std::stod(current_power_values.back());
+    } catch (const std::invalid_argument&) {
+      throw std::invalid_argument(std::string("Invalid busy power value for link ") + this->link_->get_cname());
+    }

   }
 }
 
   }
 }
 

-double LinkEnergy::getPower()
+double LinkEnergy::get_power()

 {
 
   if (!inited_)
 {
 
   if (!inited_)


@@ -130,11 +138,11 @@ double LinkEnergy::getPower()
   return idle_ + dynamic_power;
 }
 
   return idle_ + dynamic_power;
 }
 

-double LinkEnergy::getConsumedEnergy()
+double LinkEnergy::get_consumed_energy()

 {
 {

-  if (lastUpdated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
-    simgrid::simix::simcall(std::bind(&LinkEnergy::update, this));
-  return this->totalEnergy_;
+  if (last_updated_ < surf_get_clock()) // We need to simcall this as it modifies the environment
+    simgrid::kernel::actor::simcall(std::bind(&LinkEnergy::update, this));
+  return this->total_energy_;

 }
 } // namespace plugin
 } // namespace simgrid
 }
 } // namespace plugin
 } // namespace simgrid


@@ -142,29 +150,29 @@ double LinkEnergy::getConsumedEnergy()
 using simgrid::plugin::LinkEnergy;
 
 /* **************************** events  callback *************************** */
 using simgrid::plugin::LinkEnergy;
 
 /* **************************** events  callback *************************** */

-static void onCommunicate(simgrid::kernel::resource::NetworkAction* action, simgrid::s4u::Host* src,
-                          simgrid::s4u::Host* dst)
+static void on_communicate(simgrid::kernel::resource::NetworkAction const& action, simgrid::s4u::Host*,
+                           simgrid::s4u::Host*)

 {
   XBT_DEBUG("onCommunicate is called");
 {
   XBT_DEBUG("onCommunicate is called");

-  for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
+  for (simgrid::kernel::resource::LinkImpl* link : action.links()) {

 
     if (link == nullptr)
       continue;
 
     XBT_DEBUG("Update link %s", link->get_cname());
 
     if (link == nullptr)
       continue;
 
     XBT_DEBUG("Update link %s", link->get_cname());

-    LinkEnergy* link_energy = link->piface_.extension<LinkEnergy>();
-    link_energy->initWattsRangeList();
+    LinkEnergy* link_energy = link->get_iface()->extension<LinkEnergy>();
+    link_energy->init_watts_range_list();

     link_energy->update();
   }
 }
 
     link_energy->update();
   }
 }
 

-static void onSimulationEnd()
+static void on_simulation_end()

 {
   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 
   double total_energy = 0.0; // Total dissipated energy (whole platform)
   for (const auto link : links) {
 {
   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 
   double total_energy = 0.0; // Total dissipated energy (whole platform)
   for (const auto link : links) {

-    double link_energy = link->extension<LinkEnergy>()->getConsumedEnergy();
+    double link_energy = link->extension<LinkEnergy>()->get_consumed_energy();

     total_energy += link_energy;
   }
 
     total_energy += link_energy;
   }
 


@@ -176,14 +184,13 @@ int sg_link_energy_is_inited()
 {
   return LinkEnergy::EXTENSION_ID.valid();
 }
 {
   return LinkEnergy::EXTENSION_ID.valid();
 }

-/** \ingroup SURF_plugin_energy
- * \brief Enable energy plugin
- * \details Enable energy plugin to get joules consumption of each cpu. You should call this function before
+/** @ingroup plugin_link_energy
+ * @brief Enable energy plugin
+ * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before

  * #MSG_init().
  */
 void sg_link_energy_plugin_init()
 {
  * #MSG_init().
  */
 void sg_link_energy_plugin_init()
 {

-

   if (LinkEnergy::EXTENSION_ID.valid())
     return;
   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();
   if (LinkEnergy::EXTENSION_ID.valid())
     return;
   LinkEnergy::EXTENSION_ID = simgrid::s4u::Link::extension_create<LinkEnergy>();


@@ -192,26 +199,28 @@ void sg_link_energy_plugin_init()
 
   simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
 
 
   simgrid::s4u::Link::on_creation.connect([](simgrid::s4u::Link& link) { link.extension_set(new LinkEnergy(&link)); });
 

-  simgrid::s4u::Link::on_state_change.connect([](simgrid::s4u::Link& link) { link.extension<LinkEnergy>()->update(); });
+  simgrid::s4u::Link::on_state_change.connect(
+      [](simgrid::s4u::Link const& link) { link.extension<LinkEnergy>()->update(); });

 
 

-  simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link& link) {
-    if (strcmp(link.get_cname(), "__loopback__"))
+  simgrid::s4u::Link::on_destruction.connect([](simgrid::s4u::Link const& link) {
+    if (link.get_name() != "__loopback__")

       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),
       XBT_INFO("Energy consumption of link '%s': %f Joules", link.get_cname(),

-               link.extension<LinkEnergy>()->getConsumedEnergy());
+               link.extension<LinkEnergy>()->get_consumed_energy());

   });
 
   });
 

-  simgrid::s4u::Link::on_communication_state_change.connect([](simgrid::kernel::resource::NetworkAction* action) {
-    for (simgrid::kernel::resource::LinkImpl* link : action->links()) {
+  simgrid::s4u::Link::on_communication_state_change.connect([](
+      simgrid::kernel::resource::NetworkAction const& action, simgrid::kernel::resource::Action::State /* previous */) {
+    for (simgrid::kernel::resource::LinkImpl* link : action.links()) {

       if (link != nullptr)
       if (link != nullptr)

-        link->piface_.extension<LinkEnergy>()->update();
+        link->get_iface()->extension<LinkEnergy>()->update();

     }
   });
 
     }
   });
 

-  simgrid::s4u::Link::on_communicate.connect(&onCommunicate);
-  simgrid::s4u::on_simulation_end.connect(&onSimulationEnd);
+  simgrid::s4u::Link::on_communicate.connect(&on_communicate);
+  simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);

 }
 
 }
 

-/** @ingroup plugin_energy
+/** @ingroup plugin_link_energy

  *  @brief Returns the total energy consumed by the link so far (in Joules)
  *
  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
  *  @brief Returns the total energy consumed by the link so far (in Joules)
  *
  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.


@@ -220,5 +229,8 @@ void sg_link_energy_plugin_init()
  */
 double sg_link_get_consumed_energy(sg_link_t link)
 {
  */
 double sg_link_get_consumed_energy(sg_link_t link)
 {

-  return link->extension<LinkEnergy>()->getConsumedEnergy();
+  if (not LinkEnergy::EXTENSION_ID.valid())
+    throw simgrid::xbt::InitializationError("The Energy plugin is not active. Please call sg_link_energy_plugin_init() "
+                                            "before calling sg_link_get_consumed_energy().");
+  return link->extension<LinkEnergy>()->get_consumed_energy();

 }
 }