src/surf/network_cm02.cpp

   1 /* Copyright (c) 2013-2017. 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 <algorithm>
   7
   8 #include "network_cm02.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "simgrid/sg_config.h"
  11 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  12 #include "surf/maxmin.hpp"
  13
  14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
  15
  16 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
  17 double sg_bandwidth_factor = 1.0;       /* default value; can be set by model or from command line */
  18 double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or from command line */
  19
  20 double sg_tcp_gamma = 0.0;
  21 int sg_network_crosstraffic = 0;
  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   if (surf_network_model)
  40     return;
  41
  42   surf_network_model = new simgrid::surf::NetworkCm02Model();
  43   all_existing_models->push_back(surf_network_model);
  44
  45   xbt_cfg_setdefault_double("network/latency-factor",      13.01);
  46   xbt_cfg_setdefault_double("network/bandwidth-factor",     0.97);
  47   xbt_cfg_setdefault_double("network/weight-S",         20537);
  48 }
  49
  50 /***************************************************************************/
  51 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
  52 /***************************************************************************/
  53 /* @TechReport{      rr-lip2002-40, */
  54 /*   author        = {Henri Casanova and Loris Marchal}, */
  55 /*   institution   = {LIP}, */
  56 /*   title         = {A Network Model for Simulation of Grid Application}, */
  57 /*   number        = {2002-40}, */
  58 /*   month         = {oct}, */
  59 /*   year          = {2002} */
  60 /* } */
  61 void surf_network_model_init_CM02()
  62 {
  63
  64   if (surf_network_model)
  65     return;
  66
  67   xbt_cfg_setdefault_double("network/latency-factor",   1.0);
  68   xbt_cfg_setdefault_double("network/bandwidth-factor", 1.0);
  69   xbt_cfg_setdefault_double("network/weight-S",         0.0);
  70
  71   surf_network_model = new simgrid::surf::NetworkCm02Model();
  72   all_existing_models->push_back(surf_network_model);
  73 }
  74
  75 /***************************************************************************/
  76 /* The models from Steven H. Low                                           */
  77 /***************************************************************************/
  78 /* @article{Low03,                                                         */
  79 /*   author={Steven H. Low},                                               */
  80 /*   title={A Duality Model of {TCP} and Queue Management Algorithms},     */
  81 /*   year={2003},                                                          */
  82 /*   journal={{IEEE/ACM} Transactions on Networking},                      */
  83 /*    volume={11}, number={4},                                             */
  84 /*  }                                                                      */
  85 void surf_network_model_init_Reno()
  86 {
  87   if (surf_network_model)
  88     return;
  89
  90   lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
  91
  92   xbt_cfg_setdefault_double("network/latency-factor", 13.01);
  93   xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
  94   xbt_cfg_setdefault_double("network/weight-S", 20537);
  95
  96   surf_network_model = new simgrid::surf::NetworkCm02Model(&lagrange_solve);
  97   all_existing_models->push_back(surf_network_model);
  98 }
  99
 100
 101 void surf_network_model_init_Reno2()
 102 {
 103   if (surf_network_model)
 104     return;
 105
 106   lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
 107
 108   xbt_cfg_setdefault_double("network/latency-factor", 13.01);
 109   xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
 110   xbt_cfg_setdefault_double("network/weight-S", 20537);
 111
 112   surf_network_model = new simgrid::surf::NetworkCm02Model(&lagrange_solve);
 113   all_existing_models->push_back(surf_network_model);
 114 }
 115
 116 void surf_network_model_init_Vegas()
 117 {
 118   if (surf_network_model)
 119     return;
 120
 121   lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
 122
 123   xbt_cfg_setdefault_double("network/latency-factor", 13.01);
 124   xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
 125   xbt_cfg_setdefault_double("network/weight-S", 20537);
 126
 127   surf_network_model = new simgrid::surf::NetworkCm02Model(&lagrange_solve);
 128   all_existing_models->push_back(surf_network_model);
 129 }
 130
 131 namespace simgrid {
 132 namespace surf {
 133
 134 NetworkCm02Model::NetworkCm02Model()
 135   :NetworkModel()
 136 {
 137   std::string optim = xbt_cfg_get_string("network/optim");
 138   bool select = xbt_cfg_get_boolean("network/maxmin-selective-update");
 139
 140   if (optim == "Full") {
 141     setUpdateMechanism(UM_FULL);
 142     selectiveUpdate_ = select;
 143   } else if (optim == "Lazy") {
 144     setUpdateMechanism(UM_LAZY);
 145     selectiveUpdate_ = true;
 146     xbt_assert(select || (xbt_cfg_is_default_value("network/maxmin-selective-update")),
 147                "You cannot disable selective update when using the lazy update mechanism");
 148   } else {
 149     xbt_die("Unsupported optimization (%s) for this model. Accepted: Full, Lazy.", optim.c_str());
 150   }
 151
 152   maxminSystem_ = new s_lmm_system_t(selectiveUpdate_);
 153   loopback_     = NetworkCm02Model::createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
 154
 155   if (getUpdateMechanism() == UM_LAZY) {
 156     modifiedSet_ = new ActionLmmList();
 157     maxminSystem_->keep_track = modifiedSet_;
 158   }
 159 }
 160 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(lmm_system_t self))
 161   : NetworkCm02Model()
 162 {
 163   maxminSystem_->solve_fun = specificSolveFun;
 164 }
 165
 166 LinkImpl* NetworkCm02Model::createLink(const std::string& name, double bandwidth, double latency,
 167                                        e_surf_link_sharing_policy_t policy)
 168 {
 169   return new NetworkCm02Link(this, name, bandwidth, latency, policy, maxminSystem_);
 170 }
 171
 172 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
 173 {
 174   while (not actionHeapIsEmpty() && double_equals(actionHeapTopDate(), now, sg_surf_precision)) {
 175
 176     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(actionHeapPop());
 177     XBT_DEBUG("Something happened to action %p", action);
 178     if (TRACE_is_enabled()) {
 179       int n = action->getVariable()->get_number_of_constraint();
 180
 181       for (int i = 0; i < n; i++){
 182         lmm_constraint_t constraint = action->getVariable()->get_constraint(i);
 183         NetworkCm02Link* link       = static_cast<NetworkCm02Link*>(constraint->get_id());
 184         double value = action->getVariable()->get_value() * action->getVariable()->get_constraint_weight(i);
 185         TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), value, action->getLastUpdate(),
 186                                         now - action->getLastUpdate());
 187       }
 188     }
 189
 190     // if I am wearing a latency hat
 191     if (action->getHat() == LATENCY) {
 192       XBT_DEBUG("Latency paid for action %p. Activating", action);
 193       maxminSystem_->update_variable_weight(action->getVariable(), action->weight_);
 194       action->heapRemove(getActionHeap());
 195       action->refreshLastUpdate();
 196
 197         // if I am wearing a max_duration or normal hat
 198     } else if (action->getHat() == MAX_DURATION || action->getHat() == NORMAL) {
 199         // no need to communicate anymore
 200         // assume that flows that reached max_duration have remaining of 0
 201       XBT_DEBUG("Action %p finished", action);
 202       action->setRemains(0);
 203       action->finish(Action::State::done);
 204       action->heapRemove(getActionHeap());
 205     }
 206   }
 207 }
 208
 209
 210 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
 211 {
 212   for (auto it = std::begin(*getRunningActionSet()); it != std::end(*getRunningActionSet());) {
 213     NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
 214     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
 215     XBT_DEBUG("Something happened to action %p", &action);
 216     double deltap = delta;
 217     if (action.latency_ > 0) {
 218       if (action.latency_ > deltap) {
 219         double_update(&action.latency_, deltap, sg_surf_precision);
 220         deltap = 0.0;
 221       } else {
 222         double_update(&deltap, action.latency_, sg_surf_precision);
 223         action.latency_ = 0.0;
 224       }
 225       if (action.latency_ <= 0.0 && not action.isSuspended())
 226         maxminSystem_->update_variable_weight(action.getVariable(), action.weight_);
 227     }
 228     if (TRACE_is_enabled()) {
 229       int n = action.getVariable()->get_number_of_constraint();
 230       for (int i = 0; i < n; i++) {
 231         lmm_constraint_t constraint = action.getVariable()->get_constraint(i);
 232         NetworkCm02Link* link = static_cast<NetworkCm02Link*>(constraint->get_id());
 233         TRACE_surf_link_set_utilization(
 234             link->getCname(), action.getCategory(),
 235             (action.getVariable()->get_value() * action.getVariable()->get_constraint_weight(i)),
 236             action.getLastUpdate(), now - action.getLastUpdate());
 237       }
 238     }
 239     if (not action.getVariable()->get_number_of_constraint()) {
 240       /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
 241        * vivaldi. In such case, just make sure that the action completes immediately.
 242        */
 243       action.updateRemains(action.getRemains());
 244     }
 245     action.updateRemains(action.getVariable()->get_value() * delta);
 246
 247     if (action.getMaxDuration() > NO_MAX_DURATION)
 248       action.updateMaxDuration(delta);
 249
 250     if (((action.getRemains() <= 0) && (action.getVariable()->get_weight() > 0)) ||
 251         ((action.getMaxDuration() > NO_MAX_DURATION) && (action.getMaxDuration() <= 0))) {
 252       action.finish(Action::State::done);
 253     }
 254   }
 255 }
 256
 257 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 258 {
 259   int failed = 0;
 260   double latency = 0.0;
 261   std::vector<LinkImpl*> back_route;
 262   std::vector<LinkImpl*> route;
 263
 264   XBT_IN("(%s,%s,%g,%g)", src->getCname(), dst->getCname(), size, rate);
 265
 266   src->routeTo(dst, route, &latency);
 267   xbt_assert(not route.empty() || latency,
 268              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
 269              src->getCname(), dst->getCname());
 270
 271   for (auto const& link : route)
 272     if (link->isOff())
 273       failed = 1;
 274
 275   if (sg_network_crosstraffic == 1) {
 276     dst->routeTo(src, back_route, nullptr);
 277     for (auto const& link : back_route)
 278       if (link->isOff())
 279         failed = 1;
 280   }
 281
 282   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
 283   action->weight_ = latency;
 284   action->latency_ = latency;
 285   action->rate_ = rate;
 286   if (getUpdateMechanism() == UM_LAZY) {
 287     action->refreshLastUpdate();
 288   }
 289
 290   double bandwidth_bound = -1.0;
 291   if (sg_weight_S_parameter > 0)
 292     for (auto const& link : route)
 293       action->weight_ += sg_weight_S_parameter / link->bandwidth();
 294
 295   for (auto const& link : route) {
 296     double bb       = bandwidthFactor(size) * link->bandwidth();
 297     bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
 298   }
 299
 300   action->latCurrent_ = action->latency_;
 301   action->latency_ *= latencyFactor(size);
 302   action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
 303
 304   int constraints_per_variable = route.size();
 305   constraints_per_variable += back_route.size();
 306
 307   if (action->latency_ > 0) {
 308     action->setVariable(maxminSystem_->variable_new(action, 0.0, -1.0, constraints_per_variable));
 309     if (getUpdateMechanism() == UM_LAZY) {
 310       // add to the heap the event when the latency is payed
 311       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->getLastUpdate());
 312       action->heapInsert(getActionHeap(), action->latency_ + action->getLastUpdate(), route.empty() ? NORMAL : LATENCY);
 313     }
 314   } else
 315     action->setVariable(maxminSystem_->variable_new(action, 1.0, -1.0, constraints_per_variable));
 316
 317   if (action->rate_ < 0) {
 318     maxminSystem_->update_variable_bound(action->getVariable(),
 319                                          (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
 320   } else {
 321     maxminSystem_->update_variable_bound(action->getVariable(),
 322                                          (action->latCurrent_ > 0)
 323                                              ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_))
 324                                              : action->rate_);
 325   }
 326
 327   for (auto const& link : route)
 328     maxminSystem_->expand(link->constraint(), action->getVariable(), 1.0);
 329
 330   if (not back_route.empty()) { //  sg_network_crosstraffic was activated
 331     XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
 332     for (auto const& link : back_route)
 333       maxminSystem_->expand(link->constraint(), action->getVariable(), .05);
 334
 335     //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 336     //(You would also have to change lmm_element_concurrency())
 337     //lmm_variable_concurrency_share_set(action->getVariable(),2);
 338   }
 339   XBT_OUT();
 340
 341   simgrid::s4u::Link::onCommunicate(action, src, dst);
 342   return action;
 343 }
 344
 345 /************
 346  * Resource *
 347  ************/
 348 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
 349                                  e_surf_link_sharing_policy_t policy, lmm_system_t system)
 350     : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
 351 {
 352   bandwidth_.scale = 1.0;
 353   bandwidth_.peak  = bandwidth;
 354
 355   latency_.scale = 1.0;
 356   latency_.peak  = latency;
 357
 358   if (policy == SURF_LINK_FATPIPE)
 359     constraint()->unshare();
 360
 361   simgrid::s4u::Link::onCreation(this->piface_);
 362 }
 363
 364 void NetworkCm02Link::apply_event(tmgr_trace_event_t triggered, double value)
 365 {
 366   /* Find out which of my iterators was triggered, and react accordingly */
 367   if (triggered == bandwidth_.event) {
 368     setBandwidth(value);
 369     tmgr_trace_event_unref(&bandwidth_.event);
 370
 371   } else if (triggered == latency_.event) {
 372     setLatency(value);
 373     tmgr_trace_event_unref(&latency_.event);
 374
 375   } else if (triggered == stateEvent_) {
 376     if (value > 0)
 377       turnOn();
 378     else {
 379       lmm_variable_t var = nullptr;
 380       lmm_element_t elem = nullptr;
 381       double now = surf_get_clock();
 382
 383       turnOff();
 384       while ((var = constraint()->get_variable(&elem))) {
 385         Action* action = static_cast<Action*>(var->get_id());
 386
 387         if (action->getState() == Action::State::running ||
 388             action->getState() == Action::State::ready) {
 389           action->setFinishTime(now);
 390           action->setState(Action::State::failed);
 391         }
 392       }
 393     }
 394     tmgr_trace_event_unref(&stateEvent_);
 395   } else {
 396     xbt_die("Unknown event!\n");
 397   }
 398
 399   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)", constraint());
 400 }
 401
 402 void NetworkCm02Link::setBandwidth(double value)
 403 {
 404   bandwidth_.peak = value;
 405
 406   model()->getMaxminSystem()->update_constraint_bound(constraint(),
 407                                                       sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
 408   TRACE_surf_link_set_bandwidth(surf_get_clock(), getCname(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
 409
 410   if (sg_weight_S_parameter > 0) {
 411     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 412
 413     lmm_variable_t var;
 414     lmm_element_t elem = nullptr;
 415     lmm_element_t nextelem = nullptr;
 416     int numelem = 0;
 417     while ((var = constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 418       NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
 419       action->weight_ += delta;
 420       if (not action->isSuspended())
 421         model()->getMaxminSystem()->update_variable_weight(action->getVariable(), action->weight_);
 422     }
 423   }
 424 }
 425
 426 void NetworkCm02Link::setLatency(double value)
 427 {
 428   double delta           = value - latency_.peak;
 429   lmm_variable_t var = nullptr;
 430   lmm_element_t elem = nullptr;
 431   lmm_element_t nextelem = nullptr;
 432   int numelem = 0;
 433
 434   latency_.peak = value;
 435
 436   while ((var = constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
 437     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
 438     action->latCurrent_ += delta;
 439     action->weight_ += delta;
 440     if (action->rate_ < 0)
 441       model()->getMaxminSystem()->update_variable_bound(action->getVariable(),
 442                                                         sg_tcp_gamma / (2.0 * action->latCurrent_));
 443     else {
 444       model()->getMaxminSystem()->update_variable_bound(
 445           action->getVariable(), std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
 446
 447       if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
 448         XBT_INFO("Flow is limited BYBANDWIDTH");
 449       } else {
 450         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
 451       }
 452     }
 453     if (not action->isSuspended())
 454       model()->getMaxminSystem()->update_variable_weight(action->getVariable(), action->weight_);
 455   }
 456 }
 457
 458 /**********
 459  * Action *
 460  **********/
 461
 462 void NetworkCm02Action::updateRemainingLazy(double now)
 463 {
 464   if (suspended_ != 0)
 465     return;
 466
 467   double delta        = now - getLastUpdate();
 468   double max_duration = getMaxDuration();
 469
 470   if (getRemainsNoUpdate() > 0) {
 471     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, getRemainsNoUpdate(), getLastUpdate());
 472     updateRemains(getLastValue() * delta);
 473
 474     XBT_DEBUG("Updating action(%p): remains is now %f", this, getRemainsNoUpdate());
 475   }
 476
 477   if (max_duration > NO_MAX_DURATION) {
 478     double_update(&max_duration, delta, sg_surf_precision);
 479     setMaxDuration(max_duration);
 480   }
 481
 482   if ((getRemainsNoUpdate() <= 0 && (getVariable()->get_weight() > 0)) ||
 483       ((max_duration > NO_MAX_DURATION) && (max_duration <= 0))) {
 484     finish(Action::State::done);
 485     heapRemove(getModel()->getActionHeap());
 486   }
 487
 488   refreshLastUpdate();
 489   setLastValue(getVariable()->get_value());
 490 }
 491
 492 }
 493 }