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