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