Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Declare method const.
[simgrid.git] / src / surf / network_interface.cpp
index 5a23538..de4f57e 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2013-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 "src/surf/surf_interface.hpp"
 #include "surf/surf.hpp"
 
+#include <numeric>
+
 #ifndef NETWORK_INTERFACE_CPP_
 #define NETWORK_INTERFACE_CPP_
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network, surf, "Logging specific to the SURF network module");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_network, ker_resource, "Network resources, that fuel communications");
 
 /*********
  * Model *
  *********/
 
-simgrid::kernel::resource::NetworkModel* surf_network_model = nullptr;
-
 namespace simgrid {
 namespace kernel {
 namespace resource {
 
 /** @brief Command-line option 'network/TCP-gamma' -- see @ref options_model_network_gamma */
-simgrid::config::Flag<double> NetworkModel::cfg_tcp_gamma(
-    "network/TCP-gamma", {"network/TCP_gamma"},
+config::Flag<double> NetworkModel::cfg_tcp_gamma(
+    "network/TCP-gamma",
     "Size of the biggest TCP window (cat /proc/sys/net/ipv4/tcp_[rw]mem for recv/send window; "
     "Use the last given value, which is the max window size)",
     4194304.0);
 
 /** @brief Command-line option 'network/crosstraffic' -- see @ref options_model_network_crosstraffic */
-simgrid::config::Flag<bool> NetworkModel::cfg_crosstraffic(
+config::Flag<bool> NetworkModel::cfg_crosstraffic(
     "network/crosstraffic",
     "Activate the interferences between uploads and downloads for fluid max-min models (LV08, CM02)", "yes");
 
 NetworkModel::~NetworkModel() = default;
 
-double NetworkModel::get_latency_factor(double /*size*/)
-{
-  return sg_latency_factor;
-}
-
-double NetworkModel::get_bandwidth_factor(double /*size*/)
-{
-  return sg_bandwidth_factor;
-}
-
-double NetworkModel::get_bandwidth_constraint(double rate, double /*bound*/, double /*size*/)
-{
-  return rate;
-}
-
 double NetworkModel::next_occurring_event_full(double now)
 {
   double minRes = Model::next_occurring_event_full(now);
 
   for (Action const& action : *get_started_action_set()) {
-    const NetworkAction& net_action = static_cast<const NetworkAction&>(action);
+    const auto& net_action = static_cast<const NetworkAction&>(action);
     if (net_action.latency_ > 0)
       minRes = (minRes < 0) ? net_action.latency_ : std::min(minRes, net_action.latency_);
   }
@@ -73,63 +58,56 @@ double NetworkModel::next_occurring_event_full(double now)
  * Resource *
  ************/
 
-LinkImpl::LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint)
-    : Resource(model, name, constraint), piface_(this)
+LinkImpl::LinkImpl(const std::string& name) : Resource_T(name), piface_(this)
 {
-
   if (name != "__loopback__")
     xbt_assert(not s4u::Link::by_name_or_null(name), "Link '%s' declared several times in the platform.", name.c_str());
 
-  latency_.scale   = 1;
-  bandwidth_.scale = 1;
-
   s4u::Engine::get_instance()->link_register(name, &piface_);
   XBT_DEBUG("Create link '%s'", name.c_str());
 }
 
-/** @brief use destroy() instead of this destructor */
-LinkImpl::~LinkImpl()
-{
-  xbt_assert(currently_destroying_, "Don't delete Links directly. Call destroy() instead.");
-}
 /** @brief Fire the required callbacks and destroy the object
  *
  * Don't delete directly a Link, call l->destroy() instead.
  */
 void LinkImpl::destroy()
 {
-  if (not currently_destroying_) {
-    currently_destroying_ = true;
-    s4u::Link::on_destruction(this->piface_);
-    delete this;
-  }
+  s4u::Link::on_destruction(this->piface_);
+  delete this;
 }
 
-bool LinkImpl::is_used()
+bool LinkImpl::is_used() const
 {
   return get_model()->get_maxmin_system()->constraint_used(get_constraint());
 }
 
-double LinkImpl::get_latency()
+LinkImpl* LinkImpl::set_sharing_policy(s4u::Link::SharingPolicy policy)
 {
-  return latency_.peak * latency_.scale;
+  get_constraint()->set_sharing_policy(policy);
+  return this;
 }
-
-double LinkImpl::get_bandwidth()
+s4u::Link::SharingPolicy LinkImpl::get_sharing_policy() const
 {
-  return bandwidth_.peak * bandwidth_.scale;
+  return get_constraint()->get_sharing_policy();
 }
 
-s4u::Link::SharingPolicy LinkImpl::get_sharing_policy()
+void LinkImpl::latency_check(double latency) const
 {
-  return get_constraint()->get_sharing_policy();
+  static double last_warned_latency = sg_surf_precision;
+  if (latency != 0.0 && latency < last_warned_latency) {
+    XBT_WARN("Latency for link %s is smaller than surf/precision (%g < %g)."
+        " For more accuracy, consider setting \"--cfg=surf/precision:%g\".",
+        get_cname(), latency, sg_surf_precision, latency);
+    last_warned_latency = latency;
+  }
 }
 
 void LinkImpl::turn_on()
 {
   if (not is_on()) {
     Resource::turn_on();
-    s4u::Link::on_state_change(this->piface_);
+    s4u::Link::on_state_change(piface_);
   }
 }
 
@@ -137,13 +115,12 @@ void LinkImpl::turn_off()
 {
   if (is_on()) {
     Resource::turn_off();
-    s4u::Link::on_state_change(this->piface_);
+    s4u::Link::on_state_change(piface_);
 
-    kernel::lmm::Variable* var       = nullptr;
     const kernel::lmm::Element* elem = nullptr;
     double now                       = surf_get_clock();
-    while ((var = get_constraint()->get_variable(&elem))) {
-      Action* action = static_cast<Action*>(var->get_id());
+    while (const auto* var = get_constraint()->get_variable(&elem)) {
+      Action* action = var->get_id();
       if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED) {
         action->set_finish_time(now);
         action->set_state(Action::State::FAILED);
@@ -152,21 +129,45 @@ void LinkImpl::turn_off()
   }
 }
 
-void LinkImpl::on_bandwidth_change()
+void LinkImpl::seal()
+{
+  if (is_sealed())
+    return;
+
+  xbt_assert(this->get_model(), "Cannot seal Link(%s) without setting the Network model first", this->get_cname());
+  Resource::seal();
+  s4u::Link::on_creation(piface_);
+}
+
+void LinkImpl::on_bandwidth_change() const
 {
-  s4u::Link::on_bandwidth_change(this->piface_);
+  s4u::Link::on_bandwidth_change(piface_);
 }
 
-void LinkImpl::set_bandwidth_profile(profile::Profile* profile)
+LinkImpl* LinkImpl::set_bandwidth_profile(profile::Profile* profile)
 {
-  xbt_assert(bandwidth_.event == nullptr, "Cannot set a second bandwidth profile to Link %s", get_cname());
-  bandwidth_.event = profile->schedule(&profile::future_evt_set, this);
+  if (profile) {
+    xbt_assert(bandwidth_.event == nullptr, "Cannot set a second bandwidth profile to Link %s", get_cname());
+    bandwidth_.event = profile->schedule(&profile::future_evt_set, this);
+  }
+  return this;
 }
 
-void LinkImpl::set_latency_profile(profile::Profile* profile)
+LinkImpl* LinkImpl::set_latency_profile(profile::Profile* profile)
 {
-  xbt_assert(latency_.event == nullptr, "Cannot set a second latency profile to Link %s", get_cname());
-  latency_.event = profile->schedule(&profile::future_evt_set, this);
+  if (profile) {
+    xbt_assert(latency_.event == nullptr, "Cannot set a second latency profile to Link %s", get_cname());
+    latency_.event = profile->schedule(&profile::future_evt_set, this);
+  }
+  return this;
+}
+
+void LinkImpl::set_concurrency_limit(int limit) const
+{
+  if (limit != -1) {
+    get_constraint()->reset_concurrency_maximum();
+  }
+  get_constraint()->set_concurrency_limit(limit);
 }
 
 /**********
@@ -176,30 +177,55 @@ void LinkImpl::set_latency_profile(profile::Profile* profile)
 void NetworkAction::set_state(Action::State state)
 {
   Action::State previous = get_state();
-  Action::set_state(state);
-  if (previous != state) // Trigger only if the state changed
+  if (previous != state) { // Trigger only if the state changed
+    Action::set_state(state);
     s4u::Link::on_communication_state_change(*this, previous);
+  }
 }
 
 /** @brief returns a list of all Links that this action is using */
-std::list<LinkImpl*> NetworkAction::links() const
+std::list<LinkImpl*> NetworkAction::get_links() const
 {
   std::list<LinkImpl*> retlist;
   int llen = get_variable()->get_number_of_constraint();
 
   for (int i = 0; i < llen; i++) {
     /* Beware of composite actions: ptasks put links and cpus together */
-    // extra pb: we cannot dynamic_cast from void*...
-    Resource* resource = get_variable()->get_constraint(i)->get_id();
-    LinkImpl* link     = dynamic_cast<LinkImpl*>(resource);
-    if (link != nullptr)
+    if (auto* link = dynamic_cast<LinkImpl*>(get_variable()->get_constraint(i)->get_id()))
       retlist.push_back(link);
   }
 
   return retlist;
 }
+
+static void add_latency(const std::vector<LinkImpl*>& links, double* latency)
+{
+  if (latency)
+    *latency = std::accumulate(begin(links), end(links), *latency,
+                               [](double lat, const auto* link) { return lat + link->get_latency(); });
+}
+
+void add_link_latency(std::vector<LinkImpl*>& result, LinkImpl* link, double* latency)
+{
+  result.push_back(link);
+  if (latency)
+    *latency += link->get_latency();
 }
-} // namespace kernel
+
+void add_link_latency(std::vector<LinkImpl*>& result, const std::vector<LinkImpl*>& links, double* latency)
+{
+  result.insert(result.end(), begin(links), end(links));
+  add_latency(links, latency);
 }
 
+void insert_link_latency(std::vector<LinkImpl*>& result, const std::vector<LinkImpl*>& links, double* latency)
+{
+  result.insert(result.begin(), rbegin(links), rend(links));
+  add_latency(links, latency);
+}
+
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
+
 #endif /* NETWORK_INTERFACE_CPP_ */