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(surf_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   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
  40
  41   surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
  42
  43   simgrid::config::set_default<double>("network/latency-factor", 13.01);
  44   simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
  45   simgrid::config::set_default<double>("network/weight-S", 20537);
  46 }
  47
  48 /***************************************************************************/
  49 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
  50 /***************************************************************************/
  51 /* @TechReport{      rr-lip2002-40, */
  52 /*   author        = {Henri Casanova and Loris Marchal}, */
  53 /*   institution   = {LIP}, */
  54 /*   title         = {A Network Model for Simulation of Grid Application}, */
  55 /*   number        = {2002-40}, */
  56 /*   month         = {oct}, */
  57 /*   year          = {2002} */
  58 /* } */
  59 void surf_network_model_init_CM02()
  60 {
  61   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
  62
  63   simgrid::config::set_default<double>("network/latency-factor", 1.0);
  64   simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
  65   simgrid::config::set_default<double>("network/weight-S", 0.0);
  66
  67   surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
  68 }
  69
  70 namespace simgrid {
  71 namespace kernel {
  72 namespace resource {
  73
  74 NetworkCm02Model::NetworkCm02Model()
  75     : NetworkModel(simgrid::config::get_value<std::string>("network/optim") == "Full" ? Model::UpdateAlgo::FULL
  76                                                                                       : Model::UpdateAlgo::LAZY)
  77 {
  78   all_existing_models.push_back(this);
  79
  80   std::string optim = simgrid::config::get_value<std::string>("network/optim");
  81   bool select       = simgrid::config::get_value<bool>("network/maxmin-selective-update");
  82
  83   if (optim == "Lazy") {
  84     xbt_assert(select || simgrid::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>{simgrid::config::get_value<double>("network/loopback-bw")},
  92                                             simgrid::config::get_value<double>("network/loopback-lat"),
  93                                             s4u::Link::SharingPolicy::FATPIPE);
  94 }
  95
  96 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
  97                                         s4u::Link::SharingPolicy policy)
  98 {
  99   if (policy == s4u::Link::SharingPolicy::WIFI)
 100     return new NetworkWifiLink(this, name, bandwidths, get_maxmin_system());
 101
 102   xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
 103   return new NetworkCm02Link(this, name, bandwidths[0], latency, policy, get_maxmin_system());
 104 }
 105
 106 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
 107 {
 108   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
 109     auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
 110     XBT_DEBUG("Something happened to action %p", action);
 111
 112     // if I am wearing a latency hat
 113     if (action->get_type() == ActionHeap::Type::latency) {
 114       XBT_DEBUG("Latency paid for action %p. Activating", action);
 115       get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 116       get_action_heap().remove(action);
 117       action->set_last_update();
 118
 119       // if I am wearing a max_duration or normal hat
 120     } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
 121       // no need to communicate anymore
 122       // assume that flows that reached max_duration have remaining of 0
 123       XBT_DEBUG("Action %p finished", action);
 124       action->finish(Action::State::FINISHED);
 125       get_action_heap().remove(action);
 126     }
 127   }
 128 }
 129
 130 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
 131 {
 132   for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
 133     auto& action = static_cast<NetworkCm02Action&>(*it);
 134     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
 135     XBT_DEBUG("Something happened to action %p", &action);
 136     double deltap = delta;
 137     if (action.latency_ > 0) {
 138       if (action.latency_ > deltap) {
 139         double_update(&action.latency_, deltap, sg_surf_precision);
 140         deltap = 0.0;
 141       } else {
 142         double_update(&deltap, action.latency_, sg_surf_precision);
 143         action.latency_ = 0.0;
 144       }
 145       if (action.latency_ <= 0.0 && not action.is_suspended())
 146         get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
 147     }
 148
 149     if (not action.get_variable()->get_number_of_constraint()) {
 150       /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
 151        * vivaldi. In such case, just make sure that the action completes immediately.
 152        */
 153       action.update_remains(action.get_remains());
 154     }
 155     action.update_remains(action.get_variable()->get_value() * delta);
 156
 157     if (action.get_max_duration() != NO_MAX_DURATION)
 158       action.update_max_duration(delta);
 159
 160     if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
 161         ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
 162       action.finish(Action::State::FINISHED);
 163     }
 164   }
 165 }
 166
 167 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 168 {
 169   double latency = 0.0;
 170   std::vector<LinkImpl*> back_route;
 171   std::vector<LinkImpl*> route;
 172
 173   XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
 174
 175   src->route_to(dst, route, &latency);
 176   xbt_assert(not route.empty() || latency > 0,
 177              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
 178              src->get_cname(), dst->get_cname());
 179
 180   bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
 181
 182   if (cfg_crosstraffic) {
 183     dst->route_to(src, back_route, nullptr);
 184     if (not failed)
 185       failed =
 186           std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
 187   }
 188
 189   NetworkWifiLink* src_wifi_link = nullptr;
 190   NetworkWifiLink* dst_wifi_link = nullptr;
 191   if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 192     src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
 193     xbt_assert(src_wifi_link->get_host_rate(src) != -1,
 194                "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
 195                "WIFI link. Did you call link->set_host_rate()?",
 196                src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
 197   }
 198   if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 199     dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
 200     xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
 201                "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
 202                "WIFI link. Did you call link->set_host_rate()?",
 203                src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
 204   }
 205   if (route.size() > 2)
 206     for (unsigned i = 1; i < route.size() - 1; i++)
 207       xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
 208                  "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
 209                  "not in between (it is at position %u out of %zu). "
 210                  "Did you declare an access_point in your WIFI zones?",
 211                  route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
 212
 213   NetworkCm02Action* action;
 214   if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
 215     action = new NetworkCm02Action(this, *src, *dst, size, failed);
 216   else
 217     action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
 218   action->sharing_penalty_  = latency;
 219   action->latency_ = latency;
 220   action->rate_ = rate;
 221
 222   if (is_update_lazy()) {
 223     action->set_last_update();
 224   }
 225
 226   if (sg_weight_S_parameter > 0) {
 227     action->sharing_penalty_ =
 228         std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
 229           return total + sg_weight_S_parameter / link->get_bandwidth();
 230         });
 231   }
 232
 233   double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
 234
 235   for (auto const& link : route)
 236     bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
 237
 238   action->lat_current_ = action->latency_;
 239   action->latency_ *= get_latency_factor(size);
 240   action->rate_ = get_bandwidth_constraint(action->rate_, bandwidth_bound, size);
 241
 242   size_t constraints_per_variable = route.size();
 243   constraints_per_variable += back_route.size();
 244
 245   if (action->latency_ > 0) {
 246     action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
 247     if (is_update_lazy()) {
 248       // add to the heap the event when the latency is paid
 249       double date = action->latency_ + action->get_last_update();
 250
 251       ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
 252
 253       XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
 254       get_action_heap().insert(action, date, type);
 255     }
 256   } else
 257     action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
 258
 259   if (action->rate_ < 0) {
 260     get_maxmin_system()->update_variable_bound(
 261         action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
 262   } else {
 263     get_maxmin_system()->update_variable_bound(
 264         action->get_variable(), (action->lat_current_ > 0)
 265                                     ? std::min(action->rate_, cfg_tcp_gamma / (2.0 * action->lat_current_))
 266                                     : action->rate_);
 267   }
 268
 269   if (src_wifi_link != nullptr)
 270     get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
 271                                 1.0 / src_wifi_link->get_host_rate(src));
 272   if (dst_wifi_link != nullptr)
 273     get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
 274                                 1.0 / dst_wifi_link->get_host_rate(dst));
 275
 276   for (auto const* link : route) {
 277     // WIFI links are handled manually just above, so skip them now
 278     if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 279       xbt_assert(link == src_wifi_link || link == dst_wifi_link,
 280                  "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
 281                  "at its end (meaning that it's attached to the dst");
 282     } else {
 283       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
 284     }
 285   }
 286
 287   if (cfg_crosstraffic) {
 288     XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
 289     if (dst_wifi_link != nullptr)
 290       get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
 291                                   .05 / dst_wifi_link->get_host_rate(dst));
 292     if (src_wifi_link != nullptr)
 293       get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
 294                                   .05 / src_wifi_link->get_host_rate(src));
 295     for (auto const* link : back_route)
 296       if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
 297         get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
 298     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 299     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
 300     // action->getVariable()->set_concurrency_share(2)
 301   }
 302   XBT_OUT();
 303
 304   simgrid::s4u::Link::on_communicate(*action);
 305   return action;
 306 }
 307
 308 /************
 309  * Resource *
 310  ************/
 311 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
 312                                  s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
 313     : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
 314 {
 315   bandwidth_.scale = 1.0;
 316   bandwidth_.peak  = bandwidth;
 317
 318   latency_.scale = 1.0;
 319   latency_.peak  = latency;
 320
 321   if (policy == s4u::Link::SharingPolicy::FATPIPE)
 322     get_constraint()->unshare();
 323
 324   simgrid::s4u::Link::on_creation(*get_iface());
 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 void NetworkCm02Link::set_latency(double value)
 378 {
 379   double delta                 = value - latency_.peak;
 380   const kernel::lmm::Variable* var;
 381   const kernel::lmm::Element* elem     = nullptr;
 382   const kernel::lmm::Element* nextelem = nullptr;
 383   int numelem                  = 0;
 384
 385   latency_.peak = value;
 386
 387   while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 388     auto* action = static_cast<NetworkCm02Action*>(var->get_id());
 389     action->lat_current_ += delta;
 390     action->sharing_penalty_ += delta;
 391     if (action->rate_ < 0)
 392       get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
 393                                                                                           (2.0 * action->lat_current_));
 394     else {
 395       get_model()->get_maxmin_system()->update_variable_bound(
 396           action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
 397
 398       if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
 399         XBT_INFO("Flow is limited BYBANDWIDTH");
 400       } else {
 401         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
 402       }
 403     }
 404     if (not action->is_suspended())
 405       get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 406   }
 407 }
 408
 409 /**********
 410  * Action *
 411  **********/
 412
 413 void NetworkCm02Action::update_remains_lazy(double now)
 414 {
 415   if (not is_running())
 416     return;
 417
 418   double delta = now - get_last_update();
 419
 420   if (get_remains_no_update() > 0) {
 421     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
 422               get_last_update());
 423     update_remains(get_last_value() * delta);
 424
 425     XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
 426   }
 427
 428   update_max_duration(delta);
 429
 430   if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
 431       ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
 432     finish(Action::State::FINISHED);
 433     get_model()->get_action_heap().remove(this);
 434   }
 435
 436   set_last_update();
 437   set_last_value(get_variable()->get_value());
 438 }
 439
 440 } // namespace resource
 441 } // namespace kernel
 442 } // namespace simgrid