src/surf/network_cm02.cpp

   1 /* Copyright (c) 2013-2019. 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 "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/surf_interface.hpp"
  11 #include "surf/surf.hpp"
  12
  13 #include <algorithm>
  14 #include <numeric>
  15
  16 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
  17
  18 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
  19 double sg_bandwidth_factor = 1.0;       /* default value; can be set by model or from command line */
  20 double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or from command line */
  21
  22 /************************************************************************/
  23 /* New model based on optimizations discussed during Pedro Velho's thesis*/
  24 /************************************************************************/
  25 /* @techreport{VELHO:2011:HAL-00646896:1, */
  26 /*      url = {http://hal.inria.fr/hal-00646896/en/}, */
  27 /*      title = {{Flow-level network models: have we reached the limits?}}, */
  28 /*      author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
  29 /*      type = {Rapport de recherche}, */
  30 /*      institution = {INRIA}, */
  31 /*      number = {RR-7821}, */
  32 /*      year = {2011}, */
  33 /*      month = Nov, */
  34 /*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
  35 /*  } */
  36 void surf_network_model_init_LegrandVelho()
  37 {
  38   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
  39
  40   surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
  41
  42   simgrid::config::set_default<double>("network/latency-factor", 13.01);
  43   simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
  44   simgrid::config::set_default<double>("network/weight-S", 20537);
  45 }
  46
  47 /***************************************************************************/
  48 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
  49 /***************************************************************************/
  50 /* @TechReport{      rr-lip2002-40, */
  51 /*   author        = {Henri Casanova and Loris Marchal}, */
  52 /*   institution   = {LIP}, */
  53 /*   title         = {A Network Model for Simulation of Grid Application}, */
  54 /*   number        = {2002-40}, */
  55 /*   month         = {oct}, */
  56 /*   year          = {2002} */
  57 /* } */
  58 void surf_network_model_init_CM02()
  59 {
  60   xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
  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   surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
  67 }
  68
  69 namespace simgrid {
  70 namespace kernel {
  71 namespace resource {
  72
  73 NetworkCm02Model::NetworkCm02Model(kernel::lmm::System* (*make_new_lmm_system)(bool))
  74     : NetworkModel(simgrid::config::get_value<std::string>("network/optim") == "Full" ? Model::UpdateAlgo::FULL
  75                                                                                       : Model::UpdateAlgo::LAZY)
  76 {
  77   all_existing_models.push_back(this);
  78
  79   std::string optim = simgrid::config::get_value<std::string>("network/optim");
  80   bool select       = simgrid::config::get_value<bool>("network/maxmin-selective-update");
  81
  82   if (optim == "Lazy") {
  83     xbt_assert(select || simgrid::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(make_new_lmm_system(select));
  89   loopback_ = NetworkCm02Model::create_link("__loopback__", std::vector<double>(1, 498000000), 0.000015,
  90                                             s4u::Link::SharingPolicy::FATPIPE);
  91 }
  92
  93 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
  94                                         s4u::Link::SharingPolicy policy)
  95 {
  96   if (policy == s4u::Link::SharingPolicy::WIFI) {
  97     return (new NetworkWifiLink(this, name, bandwidths, policy, get_maxmin_system()));
  98   }
  99   xbt_assert(bandwidths.size() == 1, "Non WIFI links must use only 1 bandwidth.");
 100   return new NetworkCm02Link(this, name, bandwidths[0], latency, policy, get_maxmin_system());
 101 }
 102
 103 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
 104 {
 105   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
 106
 107     NetworkCm02Action* 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   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
 188   action->sharing_penalty_  = latency;
 189   action->latency_ = latency;
 190   action->rate_ = rate;
 191
 192   if (get_update_algorithm() == Model::UpdateAlgo::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 (get_update_algorithm() == Model::UpdateAlgo::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       xbt_assert(!cfg_crosstraffic,
 243                  "Cross-traffic is not yet supported when using WIFI. Please use --cfg=network/crosstraffic:0");
 244       NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
 245
 246       double src_rate = wifi_link->get_host_rate(src);
 247       double dst_rate = wifi_link->get_host_rate(dst);
 248
 249       // TODO: What do to when src and dst are on the same AP ? (for the moment we use src rate)
 250       if (src_rate != -1 && dst_rate != -1) {
 251         get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / src_rate);
 252       } else {
 253         xbt_assert(
 254             !(src_rate == -1 && dst_rate == -1),
 255             "Some Stations are not associated to any Access Point. Make sure to call set_host_rate on all Stations.");
 256         if (src_rate != -1)
 257           get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / src_rate);
 258         else
 259           get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / dst_rate);
 260       }
 261     } else {
 262       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
 263     }
 264   }
 265
 266   if (cfg_crosstraffic) {
 267     XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
 268     for (auto const& link : back_route)
 269       get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
 270
 271     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 272     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
 273     // action->getVariable()->set_concurrency_share(2)
 274   }
 275   XBT_OUT();
 276
 277   simgrid::s4u::Link::on_communicate(*action, src, dst);
 278   return action;
 279 }
 280
 281 /************
 282  * Resource *
 283  ************/
 284 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
 285                                  s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
 286     : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
 287 {
 288   bandwidth_.scale = 1.0;
 289   bandwidth_.peak  = bandwidth;
 290
 291   latency_.scale = 1.0;
 292   latency_.peak  = latency;
 293
 294   if (policy == s4u::Link::SharingPolicy::FATPIPE)
 295     get_constraint()->unshare();
 296
 297   simgrid::s4u::Link::on_creation(this->piface_);
 298 }
 299
 300 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
 301 {
 302   /* Find out which of my iterators was triggered, and react accordingly */
 303   if (triggered == bandwidth_.event) {
 304     set_bandwidth(value);
 305     tmgr_trace_event_unref(&bandwidth_.event);
 306
 307   } else if (triggered == latency_.event) {
 308     set_latency(value);
 309     tmgr_trace_event_unref(&latency_.event);
 310
 311   } else if (triggered == state_event_) {
 312     if (value > 0)
 313       turn_on();
 314     else {
 315       turn_off();
 316     }
 317     tmgr_trace_event_unref(&state_event_);
 318   } else {
 319     xbt_die("Unknown event!\n");
 320   }
 321
 322   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
 323             get_constraint());
 324 }
 325
 326 void NetworkCm02Link::set_bandwidth(double value)
 327 {
 328   bandwidth_.peak = value;
 329
 330   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
 331                                                             sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
 332
 333   LinkImpl::on_bandwidth_change();
 334
 335   if (sg_weight_S_parameter > 0) {
 336     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 337
 338     kernel::lmm::Variable* var;
 339     const kernel::lmm::Element* elem     = nullptr;
 340     const kernel::lmm::Element* nextelem = nullptr;
 341     int numelem                  = 0;
 342     while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 343       NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
 344       action->sharing_penalty_ += delta;
 345       if (not action->is_suspended())
 346         get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 347     }
 348   }
 349 }
 350
 351 void NetworkCm02Link::set_latency(double value)
 352 {
 353   double delta                 = value - latency_.peak;
 354   kernel::lmm::Variable* var   = nullptr;
 355   const kernel::lmm::Element* elem     = nullptr;
 356   const kernel::lmm::Element* nextelem = nullptr;
 357   int numelem                  = 0;
 358
 359   latency_.peak = value;
 360
 361   while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 362     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
 363     action->lat_current_ += delta;
 364     action->sharing_penalty_ += delta;
 365     if (action->rate_ < 0)
 366       get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
 367                                                                                           (2.0 * action->lat_current_));
 368     else {
 369       get_model()->get_maxmin_system()->update_variable_bound(
 370           action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
 371
 372       if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
 373         XBT_INFO("Flow is limited BYBANDWIDTH");
 374       } else {
 375         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
 376       }
 377     }
 378     if (not action->is_suspended())
 379       get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
 380   }
 381 }
 382
 383 NetworkWifiLink::NetworkWifiLink(NetworkCm02Model* model, const std::string& name, std::vector<double> bandwidths,
 384                                  s4u::Link::SharingPolicy policy, lmm::System* system)
 385     : NetworkCm02Link(
 386           model, name, 1 / sg_bandwidth_factor, 0, policy,
 387           system) // Since link use bw*sg_bandwidth_factor we should divise in order to as 1 as bound in the lmm system
 388 {
 389   for (auto bandwidth : bandwidths) {
 390     bandwidths_.push_back({bandwidth, 1.0, nullptr});
 391   }
 392 }
 393
 394 void NetworkWifiLink::set_host_rate(s4u::Host* host, int rate_level)
 395 {
 396   auto insert_done = host_rates_.insert(std::make_pair(host->get_name(), rate_level));
 397   if (insert_done.second == false)
 398     insert_done.first->second = rate_level;
 399 }
 400
 401 double NetworkWifiLink::get_host_rate(sg_host_t host)
 402 {
 403   std::map<xbt::string, int>::iterator host_rates_it;
 404   host_rates_it = host_rates_.find(host->get_name());
 405
 406   if (host_rates_it == host_rates_.end())
 407     return -1;
 408
 409   int rate_id = host_rates_it->second;
 410   xbt_assert(rate_id >= 0 && rate_id < (int)bandwidths_.size(), "Host \"%s\" has an invalid rate \"%d\"",
 411              host->get_name().c_str(), rate_id);
 412
 413   Metric rate = bandwidths_[rate_id];
 414   return rate.peak * rate.scale;
 415 }
 416
 417 s4u::Link::SharingPolicy NetworkWifiLink::get_sharing_policy()
 418 {
 419   return s4u::Link::SharingPolicy::WIFI;
 420 }
 421
 422 /**********
 423  * Action *
 424  **********/
 425
 426 void NetworkCm02Action::update_remains_lazy(double now)
 427 {
 428   if (not is_running())
 429     return;
 430
 431   double delta = now - get_last_update();
 432
 433   if (get_remains_no_update() > 0) {
 434     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
 435               get_last_update());
 436     update_remains(get_last_value() * delta);
 437
 438     XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
 439   }
 440
 441   update_max_duration(delta);
 442
 443   if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
 444       ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
 445     finish(Action::State::FINISHED);
 446     get_model()->get_action_heap().remove(this);
 447   }
 448
 449   set_last_update();
 450   set_last_value(get_variable()->get_value());
 451 }
 452
 453 }
 454 }
 455 } // namespace simgrid