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