Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
No more types for models.
[simgrid.git] / src / surf / network_cm02.cpp
index 9945dbd..4e45f4d 100644 (file)
@@ -1,23 +1,27 @@
-/* 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 "network_cm02.hpp"
+#include "src/surf/network_cm02.hpp"
+#include "simgrid/kernel/routing/NetZoneImpl.hpp"
+#include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/Host.hpp"
 #include "simgrid/sg_config.hpp"
+#include "src/kernel/EngineImpl.hpp"
 #include "src/kernel/resource/profile/Event.hpp"
+#include "src/surf/network_wifi.hpp"
 #include "src/surf/surf_interface.hpp"
 #include "surf/surf.hpp"
 
 #include <algorithm>
 #include <numeric>
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
 
-double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
-double sg_bandwidth_factor = 1.0;       /* default value; can be set by model or from command line */
-double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or from command line */
+double sg_latency_factor     = 1.0; /* default value; can be set by model or from command line */
+double sg_bandwidth_factor   = 1.0; /* default value; can be set by model or from command line */
+double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
 
 /************************************************************************/
 /* New model based on optimizations discussed during Pedro Velho's thesis*/
@@ -35,9 +39,10 @@ double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or
 /*  } */
 void surf_network_model_init_LegrandVelho()
 {
-  xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
-
-  surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
+  auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>();
+  net_model->set_name("Network_LegrandVelho");
+  simgrid::kernel::EngineImpl::get_instance()->add_model(net_model, {});
+  simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
 
   simgrid::config::set_default<double>("network/latency-factor", 13.01);
   simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
@@ -57,53 +62,60 @@ void surf_network_model_init_LegrandVelho()
 /* } */
 void surf_network_model_init_CM02()
 {
-  xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
-
   simgrid::config::set_default<double>("network/latency-factor", 1.0);
   simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
   simgrid::config::set_default<double>("network/weight-S", 0.0);
 
-  surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
+  auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>();
+  net_model->set_name("Network_CM02");
+  simgrid::kernel::EngineImpl::get_instance()->add_model(net_model, {});
+  simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
 }
 
 namespace simgrid {
 namespace kernel {
 namespace resource {
 
-NetworkCm02Model::NetworkCm02Model(kernel::lmm::System* (*make_new_lmm_system)(bool))
-    : NetworkModel(simgrid::config::get_value<std::string>("network/optim") == "Full" ? Model::UpdateAlgo::FULL
-                                                                                      : Model::UpdateAlgo::LAZY)
+NetworkCm02Model::NetworkCm02Model()
 {
-  all_existing_models.push_back(this);
+  if (config::get_value<std::string>("network/optim") == "Lazy")
+    set_update_algorithm(Model::UpdateAlgo::LAZY);
 
-  std::string optim = simgrid::config::get_value<std::string>("network/optim");
-  bool select       = simgrid::config::get_value<bool>("network/maxmin-selective-update");
+  std::string optim = config::get_value<std::string>("network/optim");
+  bool select       = config::get_value<bool>("network/maxmin-selective-update");
 
   if (optim == "Lazy") {
-    xbt_assert(select || simgrid::config::is_default("network/maxmin-selective-update"),
+    xbt_assert(select || config::is_default("network/maxmin-selective-update"),
                "You cannot disable network selective update when using the lazy update mechanism");
     select = true;
   }
 
-  set_maxmin_system(make_new_lmm_system(select));
-  loopback_ = NetworkCm02Model::create_link("__loopback__", std::vector<double>(1, 498000000), 0.000015,
-                                            s4u::Link::SharingPolicy::FATPIPE);
+  set_maxmin_system(new lmm::System(select));
+  loopback_ = NetworkCm02Model::create_link("__loopback__",
+                                            std::vector<double>{config::get_value<double>("network/loopback-bw")},
+                                            s4u::Link::SharingPolicy::FATPIPE)
+                  ->set_latency(config::get_value<double>("network/loopback-lat"));
+  loopback_->seal();
 }
 
-LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
+LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths,
                                         s4u::Link::SharingPolicy policy)
 {
+  LinkImpl* link;
   if (policy == s4u::Link::SharingPolicy::WIFI) {
-    return (new NetworkWifiLink(this, name, bandwidths, policy, get_maxmin_system()));
+    link = new NetworkWifiLink(name, bandwidths, get_maxmin_system());
+  } else {
+    xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
+    link = new NetworkCm02Link(name, bandwidths[0], policy, get_maxmin_system());
   }
-  xbt_assert(bandwidths.size() == 1, "Non WIFI links must use only 1 bandwidth.");
-  return new NetworkCm02Link(this, name, bandwidths[0], latency, policy, get_maxmin_system());
+
+  link->set_model(this);
+  return link;
 }
 
 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
 {
   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
-
     auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
     XBT_DEBUG("Something happened to action %p", action);
 
@@ -128,7 +140,7 @@ void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
 {
   for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
-    NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
+    auto& action = static_cast<NetworkCm02Action&>(*it);
     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
     XBT_DEBUG("Something happened to action %p", &action);
     double deltap = delta;
@@ -184,12 +196,40 @@ Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double siz
           std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
   }
 
-  auto* action              = new NetworkCm02Action(this, size, failed);
-  action->sharing_penalty_  = latency;
-  action->latency_ = latency;
-  action->rate_ = rate;
-
-  if (get_update_algorithm() == Model::UpdateAlgo::LAZY) {
+  NetworkWifiLink* src_wifi_link = nullptr;
+  NetworkWifiLink* dst_wifi_link = nullptr;
+  if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
+    src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
+    xbt_assert(src_wifi_link->get_host_rate(src) != -1,
+               "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
+               "WIFI link. Did you call link->set_host_rate()?",
+               src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
+  }
+  if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
+    dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
+    xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
+               "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
+               "WIFI link. Did you call link->set_host_rate()?",
+               src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
+  }
+  if (route.size() > 2)
+    for (unsigned i = 1; i < route.size() - 1; i++)
+      xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
+                 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
+                 "not in between (it is at position %u out of %zu). "
+                 "Did you declare an access_point in your WIFI zones?",
+                 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
+
+  NetworkCm02Action* action;
+  if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
+    action = new NetworkCm02Action(this, *src, *dst, size, failed);
+  else
+    action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
+  action->sharing_penalty_ = latency;
+  action->latency_         = latency;
+  action->set_user_bound(rate);
+
+  if (is_update_lazy()) {
     action->set_last_update();
   }
 
@@ -207,15 +247,15 @@ Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double siz
 
   action->lat_current_ = action->latency_;
   action->latency_ *= get_latency_factor(size);
-  action->rate_ = get_bandwidth_constraint(action->rate_, bandwidth_bound, size);
+  action->set_user_bound(get_bandwidth_constraint(action->get_user_bound(), bandwidth_bound, size));
 
   size_t constraints_per_variable = route.size();
   constraints_per_variable += back_route.size();
 
   if (action->latency_ > 0) {
     action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
-    if (get_update_algorithm() == Model::UpdateAlgo::LAZY) {
-      // add to the heap the event when the latency is payed
+    if (is_update_lazy()) {
+      // add to the heap the event when the latency is paid
       double date = action->latency_ + action->get_last_update();
 
       ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
@@ -226,31 +266,29 @@ Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double siz
   } else
     action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
 
-  if (action->rate_ < 0) {
+  if (action->get_user_bound() < 0) {
     get_maxmin_system()->update_variable_bound(
         action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
   } else {
     get_maxmin_system()->update_variable_bound(
         action->get_variable(), (action->lat_current_ > 0)
-                                    ? std::min(action->rate_, cfg_tcp_gamma / (2.0 * action->lat_current_))
-                                    : action->rate_);
+                                    ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
+                                    : action->get_user_bound());
   }
 
-  for (auto const& link : route) {
-    // Handle WIFI links
-    if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
-      NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
-
-      double src_rate = wifi_link->get_host_rate(src);
-      double dst_rate = wifi_link->get_host_rate(dst);
-      xbt_assert(
-          !(src_rate == -1 && dst_rate == -1),
-          "Some Stations are not associated to any Access Point. Make sure to call set_host_rate on all Stations.");
-      if (src_rate != -1)
-        get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / src_rate);
-      else
-        get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / dst_rate);
+  if (src_wifi_link != nullptr)
+    get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
+                                1.0 / src_wifi_link->get_host_rate(src));
+  if (dst_wifi_link != nullptr)
+    get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
+                                1.0 / dst_wifi_link->get_host_rate(dst));
 
+  for (auto const* link : route) {
+    // WIFI links are handled manually just above, so skip them now
+    if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
+      xbt_assert(link == src_wifi_link || link == dst_wifi_link,
+                 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
+                 "at its end (meaning that it's attached to the dst");
     } else {
       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
     }
@@ -258,55 +296,38 @@ Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double siz
 
   if (cfg_crosstraffic) {
     XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
-    bool wifi_dst_assigned = false; // Used by wifi crosstraffic
-    for (auto const& link : back_route) {
-      if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
-        NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
-        /**
-         * For wifi links we should add 0.05/rate.
-         * However since we are using the "back_route" we should encounter in
-         * the first place the dst wifi link.
-         */
-        if (!wifi_dst_assigned && (wifi_link->get_host_rate(dst) != -1)) {
-          get_maxmin_system()->expand(link->get_constraint(), action->get_variable(),
-                                      .05 / wifi_link->get_host_rate(dst));
-          wifi_dst_assigned = true;
-        } else {
-          get_maxmin_system()->expand(link->get_constraint(), action->get_variable(),
-                                      .05 / wifi_link->get_host_rate(src));
-        }
-      } else {
+    if (dst_wifi_link != nullptr)
+      get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
+                                  .05 / dst_wifi_link->get_host_rate(dst));
+    if (src_wifi_link != nullptr)
+      get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
+                                  .05 / src_wifi_link->get_host_rate(src));
+    for (auto const* link : back_route)
+      if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
         get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
-      }
-    }
-
     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
     // action->getVariable()->set_concurrency_share(2)
   }
   XBT_OUT();
 
-  simgrid::s4u::Link::on_communicate(*action, src, dst);
+  simgrid::s4u::Link::on_communicate(*action);
   return action;
 }
 
 /************
  * Resource *
  ************/
-NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
-                                 s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
-    : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
+NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, s4u::Link::SharingPolicy policy,
+                                 kernel::lmm::System* system)
+    : LinkImpl(name)
 {
   bandwidth_.scale = 1.0;
   bandwidth_.peak  = bandwidth;
-
-  latency_.scale = 1.0;
-  latency_.peak  = latency;
+  this->set_constraint(system->constraint_new(this, sg_bandwidth_factor * bandwidth));
 
   if (policy == s4u::Link::SharingPolicy::FATPIPE)
     get_constraint()->unshare();
-
-  simgrid::s4u::Link::on_creation(this->piface_);
 }
 
 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
@@ -323,9 +344,8 @@ void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double valu
   } else if (triggered == state_event_) {
     if (value > 0)
       turn_on();
-    else {
+    else
       turn_off();
-    }
     tmgr_trace_event_unref(&state_event_);
   } else {
     xbt_die("Unknown event!\n");
@@ -347,11 +367,10 @@ void NetworkCm02Link::set_bandwidth(double value)
   if (sg_weight_S_parameter > 0) {
     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 
-    kernel::lmm::Variable* var;
     const kernel::lmm::Element* elem     = nullptr;
     const kernel::lmm::Element* nextelem = nullptr;
-    int numelem                  = 0;
-    while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
+    int numelem                          = 0;
+    while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
       auto* action = static_cast<NetworkCm02Action*>(var->get_id());
       action->sharing_penalty_ += delta;
       if (not action->is_suspended())
@@ -360,28 +379,31 @@ void NetworkCm02Link::set_bandwidth(double value)
   }
 }
 
-void NetworkCm02Link::set_latency(double value)
+LinkImpl* NetworkCm02Link::set_latency(double value)
 {
-  double delta                 = value - latency_.peak;
-  kernel::lmm::Variable* var   = nullptr;
+  latency_check(value);
+
+  double delta = value - latency_.peak;
   const kernel::lmm::Element* elem     = nullptr;
   const kernel::lmm::Element* nextelem = nullptr;
-  int numelem                  = 0;
+  int numelem                          = 0;
 
-  latency_.peak = value;
+  latency_.scale = 1.0;
+  latency_.peak  = value;
 
-  while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
+  while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
     auto* action = static_cast<NetworkCm02Action*>(var->get_id());
     action->lat_current_ += delta;
     action->sharing_penalty_ += delta;
-    if (action->rate_ < 0)
+    if (action->get_user_bound() < 0)
       get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
                                                                                           (2.0 * action->lat_current_));
     else {
       get_model()->get_maxmin_system()->update_variable_bound(
-          action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
+          action->get_variable(),
+          std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
 
-      if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
+      if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
         XBT_INFO("Flow is limited BYBANDWIDTH");
       } else {
         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
@@ -390,45 +412,7 @@ void NetworkCm02Link::set_latency(double value)
     if (not action->is_suspended())
       get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
   }
-}
-
-NetworkWifiLink::NetworkWifiLink(NetworkCm02Model* model, const std::string& name, std::vector<double> bandwidths,
-                                 s4u::Link::SharingPolicy policy, lmm::System* system)
-    : NetworkCm02Link(
-          model, name, 1 / sg_bandwidth_factor, 0, policy,
-          system) // Since link use bw*sg_bandwidth_factor we should divise in order to as 1 as bound in the lmm system
-{
-  for (auto bandwidth : bandwidths) {
-    bandwidths_.push_back({bandwidth, 1.0, nullptr});
-  }
-}
-
-void NetworkWifiLink::set_host_rate(s4u::Host* host, int rate_level)
-{
-  auto insert_done = host_rates_.insert(std::make_pair(host->get_name(), rate_level));
-  if (insert_done.second == false)
-    insert_done.first->second = rate_level;
-}
-
-double NetworkWifiLink::get_host_rate(sg_host_t host)
-{
-  std::map<xbt::string, int>::iterator host_rates_it;
-  host_rates_it = host_rates_.find(host->get_name());
-
-  if (host_rates_it == host_rates_.end())
-    return -1;
-
-  int rate_id = host_rates_it->second;
-  xbt_assert(rate_id >= 0 && rate_id < (int)bandwidths_.size(), "Host \"%s\" has an invalid rate \"%d\"",
-             host->get_name().c_str(), rate_id);
-
-  Metric rate = bandwidths_[rate_id];
-  return rate.peak * rate.scale;
-}
-
-s4u::Link::SharingPolicy NetworkWifiLink::get_sharing_policy()
-{
-  return s4u::Link::SharingPolicy::WIFI;
+  return this;
 }
 
 /**********