src/surf/network_cm02.cpp

   1 /* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/surf/network_cm02.hpp"
   7 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "simgrid/sg_config.hpp"
  11 #include "src/kernel/EngineImpl.hpp"
  12 #include "src/kernel/resource/profile/Event.hpp"
  13 #include "src/surf/network_wifi.hpp"
  14 #include "src/surf/surf_interface.hpp"
  15 #include "surf/surf.hpp"
  16
  17 #include <algorithm>
  18 #include <numeric>
  19
  20 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
  21
  22 double sg_latency_factor     = 1.0; /* default value; can be set by model or from command line */
  23 double sg_bandwidth_factor   = 1.0; /* default value; can be set by model or from command line */
  24 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
  25
  26 /************************************************************************/
  27 /* New model based on optimizations discussed during Pedro Velho's thesis*/
  28 /************************************************************************/
  29 /* @techreport{VELHO:2011:HAL-00646896:1, */
  30 /*      url = {http://hal.inria.fr/hal-00646896/en/}, */
  31 /*      title = {{Flow-level network models: have we reached the limits?}}, */
  32 /*      author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
  33 /*      type = {Rapport de recherche}, */
  34 /*      institution = {INRIA}, */
  35 /*      number = {RR-7821}, */
  36 /*      year = {2011}, */
  37 /*      month = Nov, */
  38 /*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
  39 /*  } */
  40 void surf_network_model_init_LegrandVelho()
  41 {
  42   auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
  43   simgrid::kernel::EngineImpl::get_instance()->add_model(net_model);
  44   simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
  45
  46   simgrid::config::set_default<double>("network/latency-factor", 13.01);
  47   simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
  48   simgrid::config::set_default<double>("network/weight-S", 20537);
  49 }
  50
  51 /***************************************************************************/
  52 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
  53 /***************************************************************************/
  54 /* @TechReport{      rr-lip2002-40, */
  55 /*   author        = {Henri Casanova and Loris Marchal}, */
  56 /*   institution   = {LIP}, */
  57 /*   title         = {A Network Model for Simulation of Grid Application}, */
  58 /*   number        = {2002-40}, */
  59 /*   month         = {oct}, */
  60 /*   year          = {2002} */
  61 /* } */
  62 void surf_network_model_init_CM02()
  63 {
  64   simgrid::config::set_default<double>("network/latency-factor", 1.0);
  65   simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
  66   simgrid::config::set_default<double>("network/weight-S", 0.0);
  67
  68   auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
  69   simgrid::kernel::EngineImpl::get_instance()->add_model(net_model);
  70   simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
  71 }
  72
  73 namespace simgrid {
  74 namespace kernel {
  75 namespace resource {
  76
  77 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
  78 {
  79   std::string optim = config::get_value<std::string>("network/optim");
  80   bool select       = config::get_value<bool>("network/maxmin-selective-update");
  81
  82   if (optim == "Lazy") {
  83     set_update_algorithm(Model::UpdateAlgo::LAZY);
  84     xbt_assert(select || config::is_default("network/maxmin-selective-update"),
  85                "You cannot disable network selective update when using the lazy update mechanism");
  86     select = true;
  87   }
  88
  89   set_maxmin_system(new lmm::System(select));
  90   loopback_ = NetworkCm02Model::create_link("__loopback__",
  91                                             std::vector<double>{config::get_value<double>("network/loopback-bw")},
  92                                             s4u::Link::SharingPolicy::FATPIPE)
  93                   ->set_latency(config::get_value<double>("network/loopback-lat"));
  94   loopback_->seal();
  95 }
  96
  97 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths,
  98                                         s4u::Link::SharingPolicy policy)
  99 {
 100   LinkImpl* link;
 101   if (policy == s4u::Link::SharingPolicy::WIFI) {
 102     link = new NetworkWifiLink(name, bandwidths, get_maxmin_system());
 103   } else {
 104     xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
 105     link = new NetworkCm02Link(name, bandwidths[0], policy, get_maxmin_system());
 106   }
 107
 108   link->set_model(this);
 109   return link;
 110 }
 111
 112 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
 113 {
 114   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
 115     auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
 116     XBT_DEBUG("Something happened to action %p", action);
 117
 118     // if I am wearing a latency hat
 119     if (action->get_type() == ActionHeap::Type::latency) {
 120       XBT_DEBUG("Latency paid for action %p. Activating", action);
 121       get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 122       get_action_heap().remove(action);
 123       action->set_last_update();
 124
 125       // if I am wearing a max_duration or normal hat
 126     } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
 127       // no need to communicate anymore
 128       // assume that flows that reached max_duration have remaining of 0
 129       XBT_DEBUG("Action %p finished", action);
 130       action->finish(Action::State::FINISHED);
 131       get_action_heap().remove(action);
 132     }
 133   }
 134 }
 135
 136 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
 137 {
 138   for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
 139     auto& action = static_cast<NetworkCm02Action&>(*it);
 140     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
 141     XBT_DEBUG("Something happened to action %p", &action);
 142     double deltap = delta;
 143     if (action.latency_ > 0) {
 144       if (action.latency_ > deltap) {
 145         double_update(&action.latency_, deltap, sg_surf_precision);
 146         deltap = 0.0;
 147       } else {
 148         double_update(&deltap, action.latency_, sg_surf_precision);
 149         action.latency_ = 0.0;
 150       }
 151       if (action.latency_ <= 0.0 && not action.is_suspended())
 152         get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
 153     }
 154
 155     if (not action.get_variable()->get_number_of_constraint()) {
 156       /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
 157        * vivaldi. In such case, just make sure that the action completes immediately.
 158        */
 159       action.update_remains(action.get_remains());
 160     }
 161     action.update_remains(action.get_variable()->get_value() * delta);
 162
 163     if (action.get_max_duration() != NO_MAX_DURATION)
 164       action.update_max_duration(delta);
 165
 166     if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
 167         ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
 168       action.finish(Action::State::FINISHED);
 169     }
 170   }
 171 }
 172
 173 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 174 {
 175   double latency = 0.0;
 176   std::vector<LinkImpl*> back_route;
 177   std::vector<LinkImpl*> route;
 178
 179   XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
 180
 181   src->route_to(dst, route, &latency);
 182   xbt_assert(not route.empty() || latency > 0,
 183              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
 184              src->get_cname(), dst->get_cname());
 185
 186   bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
 187
 188   if (cfg_crosstraffic) {
 189     dst->route_to(src, back_route, nullptr);
 190     if (not failed)
 191       failed =
 192           std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
 193   }
 194
 195   NetworkWifiLink* src_wifi_link = nullptr;
 196   NetworkWifiLink* dst_wifi_link = nullptr;
 197   if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 198     src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
 199     xbt_assert(src_wifi_link->get_host_rate(src) != -1,
 200                "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
 201                "WIFI link. Did you call link->set_host_rate()?",
 202                src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
 203   }
 204   if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 205     dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
 206     xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
 207                "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
 208                "WIFI link. Did you call link->set_host_rate()?",
 209                src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
 210   }
 211   if (route.size() > 2)
 212     for (unsigned i = 1; i < route.size() - 1; i++)
 213       xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
 214                  "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
 215                  "not in between (it is at position %u out of %zu). "
 216                  "Did you declare an access_point in your WIFI zones?",
 217                  route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
 218
 219   NetworkCm02Action* action;
 220   if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
 221     action = new NetworkCm02Action(this, *src, *dst, size, failed);
 222   else
 223     action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
 224   action->sharing_penalty_ = latency;
 225   action->latency_         = latency;
 226   action->set_user_bound(rate);
 227
 228   if (is_update_lazy()) {
 229     action->set_last_update();
 230   }
 231
 232   if (sg_weight_S_parameter > 0) {
 233     action->sharing_penalty_ =
 234         std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
 235           return total + sg_weight_S_parameter / link->get_bandwidth();
 236         });
 237   }
 238
 239   double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
 240
 241   for (auto const& link : route)
 242     bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
 243
 244   action->lat_current_ = action->latency_;
 245   action->latency_ *= get_latency_factor(size);
 246   action->set_user_bound(get_bandwidth_constraint(action->get_user_bound(), bandwidth_bound, size));
 247
 248   size_t constraints_per_variable = route.size();
 249   constraints_per_variable += back_route.size();
 250
 251   if (action->latency_ > 0) {
 252     action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
 253     if (is_update_lazy()) {
 254       // add to the heap the event when the latency is paid
 255       double date = action->latency_ + action->get_last_update();
 256
 257       ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
 258
 259       XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
 260       get_action_heap().insert(action, date, type);
 261     }
 262   } else
 263     action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
 264
 265   if (action->get_user_bound() < 0) {
 266     get_maxmin_system()->update_variable_bound(
 267         action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
 268   } else {
 269     get_maxmin_system()->update_variable_bound(
 270         action->get_variable(), (action->lat_current_ > 0)
 271                                     ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
 272                                     : action->get_user_bound());
 273   }
 274
 275   if (src_wifi_link != nullptr)
 276     get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
 277                                 1.0 / src_wifi_link->get_host_rate(src));
 278   if (dst_wifi_link != nullptr)
 279     get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
 280                                 1.0 / dst_wifi_link->get_host_rate(dst));
 281
 282   for (auto const* link : route) {
 283     // WIFI links are handled manually just above, so skip them now
 284     if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 285       xbt_assert(link == src_wifi_link || link == dst_wifi_link,
 286                  "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
 287                  "at its end (meaning that it's attached to the dst");
 288     } else {
 289       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
 290     }
 291   }
 292
 293   if (cfg_crosstraffic) {
 294     XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
 295     if (dst_wifi_link != nullptr)
 296       get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
 297                                   .05 / dst_wifi_link->get_host_rate(dst));
 298     if (src_wifi_link != nullptr)
 299       get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
 300                                   .05 / src_wifi_link->get_host_rate(src));
 301     for (auto const* link : back_route)
 302       if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
 303         get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
 304     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 305     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
 306     // action->getVariable()->set_concurrency_share(2)
 307   }
 308   XBT_OUT();
 309
 310   simgrid::s4u::Link::on_communicate(*action);
 311   return action;
 312 }
 313
 314 /************
 315  * Resource *
 316  ************/
 317 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, s4u::Link::SharingPolicy policy,
 318                                  kernel::lmm::System* system)
 319     : LinkImpl(name)
 320 {
 321   bandwidth_.scale = 1.0;
 322   bandwidth_.peak  = bandwidth;
 323   this->set_constraint(system->constraint_new(this, sg_bandwidth_factor * bandwidth));
 324
 325   if (policy == s4u::Link::SharingPolicy::FATPIPE)
 326     get_constraint()->unshare();
 327 }
 328
 329 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
 330 {
 331   /* Find out which of my iterators was triggered, and react accordingly */
 332   if (triggered == bandwidth_.event) {
 333     set_bandwidth(value);
 334     tmgr_trace_event_unref(&bandwidth_.event);
 335
 336   } else if (triggered == latency_.event) {
 337     set_latency(value);
 338     tmgr_trace_event_unref(&latency_.event);
 339
 340   } else if (triggered == state_event_) {
 341     if (value > 0)
 342       turn_on();
 343     else
 344       turn_off();
 345     tmgr_trace_event_unref(&state_event_);
 346   } else {
 347     xbt_die("Unknown event!\n");
 348   }
 349
 350   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
 351             get_constraint());
 352 }
 353
 354 void NetworkCm02Link::set_bandwidth(double value)
 355 {
 356   bandwidth_.peak = value;
 357
 358   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
 359                                                             sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
 360
 361   LinkImpl::on_bandwidth_change();
 362
 363   if (sg_weight_S_parameter > 0) {
 364     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 365
 366     const kernel::lmm::Element* elem     = nullptr;
 367     const kernel::lmm::Element* nextelem = nullptr;
 368     int numelem                          = 0;
 369     while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
 370       auto* action = static_cast<NetworkCm02Action*>(var->get_id());
 371       action->sharing_penalty_ += delta;
 372       if (not action->is_suspended())
 373         get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 374     }
 375   }
 376 }
 377
 378 LinkImpl* NetworkCm02Link::set_latency(double value)
 379 {
 380   latency_check(value);
 381
 382   double delta = value - latency_.peak;
 383   const kernel::lmm::Element* elem     = nullptr;
 384   const kernel::lmm::Element* nextelem = nullptr;
 385   int numelem                          = 0;
 386
 387   latency_.scale = 1.0;
 388   latency_.peak  = value;
 389
 390   while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
 391     auto* action = static_cast<NetworkCm02Action*>(var->get_id());
 392     action->lat_current_ += delta;
 393     action->sharing_penalty_ += delta;
 394     if (action->get_user_bound() < 0)
 395       get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
 396                                                                                           (2.0 * action->lat_current_));
 397     else {
 398       get_model()->get_maxmin_system()->update_variable_bound(
 399           action->get_variable(),
 400           std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
 401
 402       if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
 403         XBT_INFO("Flow is limited BYBANDWIDTH");
 404       } else {
 405         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
 406       }
 407     }
 408     if (not action->is_suspended())
 409       get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 410   }
 411   return this;
 412 }
 413
 414 /**********
 415  * Action *
 416  **********/
 417
 418 void NetworkCm02Action::update_remains_lazy(double now)
 419 {
 420   if (not is_running())
 421     return;
 422
 423   double delta = now - get_last_update();
 424
 425   if (get_remains_no_update() > 0) {
 426     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
 427               get_last_update());
 428     update_remains(get_last_value() * delta);
 429
 430     XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
 431   }
 432
 433   update_max_duration(delta);
 434
 435   if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
 436       ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
 437     finish(Action::State::FINISHED);
 438     get_model()->get_action_heap().remove(this);
 439   }
 440
 441   set_last_update();
 442   set_last_value(get_variable()->get_value());
 443 }
 444
 445 } // namespace resource
 446 } // namespace kernel
 447 } // namespace simgrid