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