src/surf/network_cm02.cpp

   1 /* Copyright (c) 2013-2020. 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(kernel::lmm::System* (*make_new_lmm_system)(bool))
  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(make_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     NetworkCm02Action& 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   auto* action              = new NetworkCm02Action(this, *src, *dst, size, failed);
 190   action->sharing_penalty_  = latency;
 191   action->latency_ = latency;
 192   action->rate_ = rate;
 193
 194   if (is_update_lazy()) {
 195     action->set_last_update();
 196   }
 197
 198   if (sg_weight_S_parameter > 0) {
 199     action->sharing_penalty_ =
 200         std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
 201           return total + sg_weight_S_parameter / link->get_bandwidth();
 202         });
 203   }
 204
 205   double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
 206
 207   for (auto const& link : route)
 208     bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
 209
 210   action->lat_current_ = action->latency_;
 211   action->latency_ *= get_latency_factor(size);
 212   action->rate_ = get_bandwidth_constraint(action->rate_, bandwidth_bound, size);
 213
 214   size_t constraints_per_variable = route.size();
 215   constraints_per_variable += back_route.size();
 216
 217   if (action->latency_ > 0) {
 218     action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
 219     if (is_update_lazy()) {
 220       // add to the heap the event when the latency is payed
 221       double date = action->latency_ + action->get_last_update();
 222
 223       ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
 224
 225       XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
 226       get_action_heap().insert(action, date, type);
 227     }
 228   } else
 229     action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
 230
 231   if (action->rate_ < 0) {
 232     get_maxmin_system()->update_variable_bound(
 233         action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
 234   } else {
 235     get_maxmin_system()->update_variable_bound(
 236         action->get_variable(), (action->lat_current_ > 0)
 237                                     ? std::min(action->rate_, cfg_tcp_gamma / (2.0 * action->lat_current_))
 238                                     : action->rate_);
 239   }
 240
 241   for (auto const& link : route) {
 242     // Handle WIFI links
 243     if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 244       NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
 245
 246       double wifi_rate = wifi_link->get_host_rate(src);
 247       if (wifi_rate == -1.0)
 248         wifi_rate = wifi_link->get_host_rate(dst);
 249       xbt_assert(wifi_rate != -1.0,
 250                  "None of the source (%s) or destination (%s) is connected to the Access Point '%s'. "
 251                  "Please use set_host_rate() on all stations.",
 252                  src->get_cname(), dst->get_cname(), link->get_cname());
 253       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / wifi_rate);
 254
 255     } else {
 256       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
 257     }
 258   }
 259
 260   if (cfg_crosstraffic) {
 261     XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
 262     bool wifi_dst_assigned = false; // Used by wifi crosstraffic
 263     for (auto const& link : back_route) {
 264       if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
 265         NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
 266         /**
 267          * For wifi links we should add 0.05/rate.
 268          * However since we are using the "back_route" we should encounter in
 269          * the first place the dst wifi link.
 270          */
 271         if (!wifi_dst_assigned && (wifi_link->get_host_rate(dst) != -1)) {
 272           get_maxmin_system()->expand(link->get_constraint(), action->get_variable(),
 273                                       .05 / wifi_link->get_host_rate(dst));
 274           wifi_dst_assigned = true;
 275         } else {
 276           get_maxmin_system()->expand(link->get_constraint(), action->get_variable(),
 277                                       .05 / wifi_link->get_host_rate(src));
 278         }
 279       } else {
 280         get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
 281       }
 282     }
 283
 284     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 285     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
 286     // action->getVariable()->set_concurrency_share(2)
 287   }
 288   XBT_OUT();
 289
 290   simgrid::s4u::Link::on_communicate(*action, src, dst);
 291   return action;
 292 }
 293
 294 /************
 295  * Resource *
 296  ************/
 297 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
 298                                  s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
 299     : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
 300 {
 301   bandwidth_.scale = 1.0;
 302   bandwidth_.peak  = bandwidth;
 303
 304   latency_.scale = 1.0;
 305   latency_.peak  = latency;
 306
 307   if (policy == s4u::Link::SharingPolicy::FATPIPE)
 308     get_constraint()->unshare();
 309
 310   simgrid::s4u::Link::on_creation(*get_iface());
 311 }
 312
 313 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
 314 {
 315   /* Find out which of my iterators was triggered, and react accordingly */
 316   if (triggered == bandwidth_.event) {
 317     set_bandwidth(value);
 318     tmgr_trace_event_unref(&bandwidth_.event);
 319
 320   } else if (triggered == latency_.event) {
 321     set_latency(value);
 322     tmgr_trace_event_unref(&latency_.event);
 323
 324   } else if (triggered == state_event_) {
 325     if (value > 0)
 326       turn_on();
 327     else
 328       turn_off();
 329     tmgr_trace_event_unref(&state_event_);
 330   } else {
 331     xbt_die("Unknown event!\n");
 332   }
 333
 334   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
 335             get_constraint());
 336 }
 337
 338 void NetworkCm02Link::set_bandwidth(double value)
 339 {
 340   bandwidth_.peak = value;
 341
 342   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
 343                                                             sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
 344
 345   LinkImpl::on_bandwidth_change();
 346
 347   if (sg_weight_S_parameter > 0) {
 348     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 349
 350     const kernel::lmm::Variable* var;
 351     const kernel::lmm::Element* elem     = nullptr;
 352     const kernel::lmm::Element* nextelem = nullptr;
 353     int numelem                  = 0;
 354     while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 355       auto* action = static_cast<NetworkCm02Action*>(var->get_id());
 356       action->sharing_penalty_ += delta;
 357       if (not action->is_suspended())
 358         get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 359     }
 360   }
 361 }
 362
 363 void NetworkCm02Link::set_latency(double value)
 364 {
 365   double delta                 = value - latency_.peak;
 366   const kernel::lmm::Variable* var;
 367   const kernel::lmm::Element* elem     = nullptr;
 368   const kernel::lmm::Element* nextelem = nullptr;
 369   int numelem                  = 0;
 370
 371   latency_.peak = value;
 372
 373   while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 374     auto* action = static_cast<NetworkCm02Action*>(var->get_id());
 375     action->lat_current_ += delta;
 376     action->sharing_penalty_ += delta;
 377     if (action->rate_ < 0)
 378       get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
 379                                                                                           (2.0 * action->lat_current_));
 380     else {
 381       get_model()->get_maxmin_system()->update_variable_bound(
 382           action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
 383
 384       if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
 385         XBT_INFO("Flow is limited BYBANDWIDTH");
 386       } else {
 387         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
 388       }
 389     }
 390     if (not action->is_suspended())
 391       get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 392   }
 393 }
 394
 395 /**********
 396  * Action *
 397  **********/
 398
 399 void NetworkCm02Action::update_remains_lazy(double now)
 400 {
 401   if (not is_running())
 402     return;
 403
 404   double delta = now - get_last_update();
 405
 406   if (get_remains_no_update() > 0) {
 407     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
 408               get_last_update());
 409     update_remains(get_last_value() * delta);
 410
 411     XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
 412   }
 413
 414   update_max_duration(delta);
 415
 416   if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
 417       ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
 418     finish(Action::State::FINISHED);
 419     get_model()->get_action_heap().remove(this);
 420   }
 421
 422   set_last_update();
 423   set_last_value(get_variable()->get_value());
 424 }
 425
 426 } // namespace resource
 427 } // namespace kernel
 428 } // namespace simgrid