Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move the models to the right directory (empty src/surf a bit)
[simgrid.git] / src / surf / network_cm02.cpp
diff --git a/src/surf/network_cm02.cpp b/src/surf/network_cm02.cpp
deleted file mode 100644 (file)
index f70895c..0000000
+++ /dev/null
@@ -1,453 +0,0 @@
-/* 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/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(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 */
-
-/************************************************************************/
-/* New model based on optimizations discussed during Pedro Velho's thesis*/
-/************************************************************************/
-/* @techreport{VELHO:2011:HAL-00646896:1, */
-/*      url = {http://hal.inria.fr/hal-00646896/en/}, */
-/*      title = {{Flow-level network models: have we reached the limits?}}, */
-/*      author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
-/*      type = {Rapport de recherche}, */
-/*      institution = {INRIA}, */
-/*      number = {RR-7821}, */
-/*      year = {2011}, */
-/*      month = Nov, */
-/*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
-/*  } */
-void surf_network_model_init_LegrandVelho()
-{
-  auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>();
-  simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::NETWORK, net_model,
-                                                         true);
-  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);
-  simgrid::config::set_default<double>("network/weight-S", 20537);
-}
-
-/***************************************************************************/
-/* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
-/***************************************************************************/
-/* @TechReport{      rr-lip2002-40, */
-/*   author        = {Henri Casanova and Loris Marchal}, */
-/*   institution   = {LIP}, */
-/*   title         = {A Network Model for Simulation of Grid Application}, */
-/*   number        = {2002-40}, */
-/*   month         = {oct}, */
-/*   year          = {2002} */
-/* } */
-void surf_network_model_init_CM02()
-{
-  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);
-
-  auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>();
-  simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::NETWORK, net_model,
-                                                         true);
-  simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
-}
-
-namespace simgrid {
-namespace kernel {
-namespace resource {
-
-NetworkCm02Model::NetworkCm02Model()
-{
-  if (config::get_value<std::string>("network/optim") == "Lazy")
-    set_update_algorithm(Model::UpdateAlgo::LAZY);
-
-  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 || config::is_default("network/maxmin-selective-update"),
-               "You cannot disable network selective update when using the lazy update mechanism");
-    select = true;
-  }
-
-  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,
-                                        s4u::Link::SharingPolicy policy)
-{
-  LinkImpl* link;
-  if (policy == s4u::Link::SharingPolicy::WIFI) {
-    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());
-  }
-
-  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);
-
-    // if I am wearing a latency hat
-    if (action->get_type() == ActionHeap::Type::latency) {
-      XBT_DEBUG("Latency paid for action %p. Activating", action);
-      get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
-      get_action_heap().remove(action);
-      action->set_last_update();
-
-      // if I am wearing a max_duration or normal hat
-    } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
-      // no need to communicate anymore
-      // assume that flows that reached max_duration have remaining of 0
-      XBT_DEBUG("Action %p finished", action);
-      action->finish(Action::State::FINISHED);
-      get_action_heap().remove(action);
-    }
-  }
-}
-
-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());) {
-    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;
-    if (action.latency_ > 0) {
-      if (action.latency_ > deltap) {
-        double_update(&action.latency_, deltap, sg_surf_precision);
-        deltap = 0.0;
-      } else {
-        double_update(&deltap, action.latency_, sg_surf_precision);
-        action.latency_ = 0.0;
-      }
-      if (action.latency_ <= 0.0 && not action.is_suspended())
-        get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
-    }
-
-    if (not action.get_variable()->get_number_of_constraint()) {
-      /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
-       * vivaldi. In such case, just make sure that the action completes immediately.
-       */
-      action.update_remains(action.get_remains());
-    }
-    action.update_remains(action.get_variable()->get_value() * delta);
-
-    if (action.get_max_duration() != NO_MAX_DURATION)
-      action.update_max_duration(delta);
-
-    if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
-        ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
-      action.finish(Action::State::FINISHED);
-    }
-  }
-}
-
-Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
-{
-  double latency = 0.0;
-  std::vector<LinkImpl*> back_route;
-  std::vector<LinkImpl*> route;
-
-  XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
-
-  src->route_to(dst, route, &latency);
-  xbt_assert(not route.empty() || latency > 0,
-             "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
-             src->get_cname(), dst->get_cname());
-
-  bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
-
-  if (cfg_crosstraffic) {
-    dst->route_to(src, back_route, nullptr);
-    if (not failed)
-      failed =
-          std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
-  }
-
-  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();
-  }
-
-  if (sg_weight_S_parameter > 0) {
-    action->sharing_penalty_ =
-        std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
-          return total + sg_weight_S_parameter / link->get_bandwidth();
-        });
-  }
-
-  double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
-
-  for (auto const& link : route)
-    bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
-
-  action->lat_current_ = action->latency_;
-  action->latency_ *= get_latency_factor(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 (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;
-
-      XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
-      get_action_heap().insert(action, date, type);
-    }
-  } else
-    action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
-
-  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->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
-                                    : action->get_user_bound());
-  }
-
-  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);
-    }
-  }
-
-  if (cfg_crosstraffic) {
-    XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
-    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);
-  return action;
-}
-
-/************
- * Resource *
- ************/
-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;
-  this->set_constraint(system->constraint_new(this, sg_bandwidth_factor * bandwidth));
-
-  if (policy == s4u::Link::SharingPolicy::FATPIPE)
-    get_constraint()->unshare();
-}
-
-void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
-{
-  /* Find out which of my iterators was triggered, and react accordingly */
-  if (triggered == bandwidth_.event) {
-    set_bandwidth(value);
-    tmgr_trace_event_unref(&bandwidth_.event);
-
-  } else if (triggered == latency_.event) {
-    set_latency(value);
-    tmgr_trace_event_unref(&latency_.event);
-
-  } else if (triggered == state_event_) {
-    if (value > 0)
-      turn_on();
-    else
-      turn_off();
-    tmgr_trace_event_unref(&state_event_);
-  } else {
-    xbt_die("Unknown event!\n");
-  }
-
-  XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
-            get_constraint());
-}
-
-void NetworkCm02Link::set_bandwidth(double value)
-{
-  bandwidth_.peak = value;
-
-  get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
-                                                            sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
-
-  LinkImpl::on_bandwidth_change();
-
-  if (sg_weight_S_parameter > 0) {
-    double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
-
-    const 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))) {
-      auto* action = static_cast<NetworkCm02Action*>(var->get_id());
-      action->sharing_penalty_ += delta;
-      if (not action->is_suspended())
-        get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
-    }
-  }
-}
-
-LinkImpl* NetworkCm02Link::set_latency(double value)
-{
-  latency_check(value);
-
-  double delta = value - latency_.peak;
-  const kernel::lmm::Variable* var;
-  const kernel::lmm::Element* elem     = nullptr;
-  const kernel::lmm::Element* nextelem = nullptr;
-  int numelem                          = 0;
-
-  latency_.scale = 1.0;
-  latency_.peak  = value;
-
-  while ((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->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->get_user_bound(), 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_);
-      }
-    }
-    if (not action->is_suspended())
-      get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
-  }
-  return this;
-}
-
-/**********
- * Action *
- **********/
-
-void NetworkCm02Action::update_remains_lazy(double now)
-{
-  if (not is_running())
-    return;
-
-  double delta = now - get_last_update();
-
-  if (get_remains_no_update() > 0) {
-    XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
-              get_last_update());
-    update_remains(get_last_value() * delta);
-
-    XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
-  }
-
-  update_max_duration(delta);
-
-  if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
-      ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
-    finish(Action::State::FINISHED);
-    get_model()->get_action_heap().remove(this);
-  }
-
-  set_last_update();
-  set_last_value(get_variable()->get_value());
-}
-
-} // namespace resource
-} // namespace kernel
-} // namespace simgrid