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