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 "maxmin_private.hpp"
   9 #include "network_cm02.hpp"
  10 #include "simgrid/s4u/Host.hpp"
  11 #include "simgrid/sg_config.h"
  12 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  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_ = lmm_system_new(selectiveUpdate_);
 153   loopback_     = createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
 154
 155   if (getUpdateMechanism() == UM_LAZY) {
 156     actionHeap_ = xbt_heap_new(8, nullptr);
 157     xbt_heap_set_update_callback(actionHeap_, surf_action_lmm_update_index_heap);
 158     modifiedSet_ = new ActionLmmList();
 159     maxminSystem_->keep_track = modifiedSet_;
 160   }
 161 }
 162 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(lmm_system_t self))
 163   : NetworkCm02Model()
 164 {
 165   maxminSystem_->solve_fun = specificSolveFun;
 166 }
 167
 168 LinkImpl* NetworkCm02Model::createLink(const std::string& name, double bandwidth, double latency,
 169                                        e_surf_link_sharing_policy_t policy)
 170 {
 171   return new NetworkCm02Link(this, name, bandwidth, latency, policy, maxminSystem_);
 172 }
 173
 174 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
 175 {
 176   while ((xbt_heap_size(actionHeap_) > 0)
 177          && (double_equals(xbt_heap_maxkey(actionHeap_), now, sg_surf_precision))) {
 178
 179     NetworkCm02Action *action = static_cast<NetworkCm02Action*> (xbt_heap_pop(actionHeap_));
 180     XBT_DEBUG("Something happened to action %p", action);
 181     if (TRACE_is_enabled()) {
 182       int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
 183
 184       for (int i = 0; i < n; i++){
 185         lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
 186         NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
 187         double value = lmm_variable_getvalue(action->getVariable())*
 188             lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i);
 189         TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(), value, action->getLastUpdate(),
 190                                         now - action->getLastUpdate());
 191       }
 192     }
 193
 194     // if I am wearing a latency hat
 195     if (action->getHat() == LATENCY) {
 196       XBT_DEBUG("Latency paid for action %p. Activating", action);
 197       lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
 198       action->heapRemove(actionHeap_);
 199       action->refreshLastUpdate();
 200
 201         // if I am wearing a max_duration or normal hat
 202     } else if (action->getHat() == MAX_DURATION || action->getHat() == NORMAL) {
 203         // no need to communicate anymore
 204         // assume that flows that reached max_duration have remaining of 0
 205       XBT_DEBUG("Action %p finished", action);
 206       action->setRemains(0);
 207       action->finish(Action::State::done);
 208       action->heapRemove(actionHeap_);
 209     }
 210   }
 211 }
 212
 213
 214 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
 215 {
 216   ActionList *running_actions = getRunningActionSet();
 217   ActionList::iterator it(running_actions->begin());
 218   ActionList::iterator itend(running_actions->end());
 219   while (it != itend) {
 220     NetworkCm02Action *action = static_cast<NetworkCm02Action*> (&*it);
 221     ++it;
 222     XBT_DEBUG("Something happened to action %p", action);
 223       double deltap = delta;
 224       if (action->latency_ > 0) {
 225         if (action->latency_ > deltap) {
 226           double_update(&(action->latency_), deltap, sg_surf_precision);
 227           deltap = 0.0;
 228         } else {
 229           double_update(&(deltap), action->latency_, sg_surf_precision);
 230           action->latency_ = 0.0;
 231         }
 232         if (action->latency_ <= 0.0 && not action->isSuspended())
 233           lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
 234       }
 235       if (TRACE_is_enabled()) {
 236         int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
 237         for (int i = 0; i < n; i++){
 238           lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
 239
 240           NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
 241           TRACE_surf_link_set_utilization(link->getCname(), action->getCategory(),
 242                                           (lmm_variable_getvalue(action->getVariable()) *
 243                                            lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i)),
 244                                           action->getLastUpdate(), now - action->getLastUpdate());
 245         }
 246       }
 247       if (not lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable())) {
 248         /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
 249          * vivaldi. In such case, just make sure that the action completes immediately.
 250          */
 251         action->updateRemains(action->getRemains());
 252       }
 253     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 254
 255     if (action->getMaxDuration() > NO_MAX_DURATION)
 256       action->updateMaxDuration(delta);
 257
 258     if (((action->getRemains() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
 259         ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
 260       action->finish(Action::State::done);
 261     }
 262   }
 263 }
 264
 265 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 266 {
 267   int failed = 0;
 268   double latency = 0.0;
 269   std::vector<LinkImpl*>* back_route = nullptr;
 270   std::vector<LinkImpl*>* route = new std::vector<LinkImpl*>();
 271
 272   XBT_IN("(%s,%s,%g,%g)", src->getCname(), dst->getCname(), size, rate);
 273
 274   src->routeTo(dst, route, &latency);
 275   xbt_assert(not route->empty() || latency,
 276              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
 277              src->getCname(), dst->getCname());
 278
 279   for (auto const& link : *route)
 280     if (link->isOff())
 281       failed = 1;
 282
 283   if (sg_network_crosstraffic == 1) {
 284     back_route = new std::vector<LinkImpl*>();
 285     dst->routeTo(src, back_route, nullptr);
 286     for (auto const& link : *back_route)
 287       if (link->isOff())
 288         failed = 1;
 289   }
 290
 291   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
 292   action->weight_ = latency;
 293   action->latency_ = latency;
 294   action->rate_ = rate;
 295   if (getUpdateMechanism() == UM_LAZY) {
 296     action->updateIndexHeap(-1);
 297     action->refreshLastUpdate();
 298   }
 299
 300   double bandwidth_bound = -1.0;
 301   if (sg_weight_S_parameter > 0)
 302     for (auto const& link : *route)
 303       action->weight_ += sg_weight_S_parameter / link->bandwidth();
 304
 305   for (auto const& link : *route) {
 306     double bb       = bandwidthFactor(size) * link->bandwidth();
 307     bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
 308   }
 309
 310   action->latCurrent_ = action->latency_;
 311   action->latency_ *= latencyFactor(size);
 312   action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
 313
 314   int constraints_per_variable = route->size();
 315   if (back_route != nullptr)
 316     constraints_per_variable += back_route->size();
 317
 318   if (action->latency_ > 0) {
 319     action->setVariable(lmm_variable_new(maxminSystem_, action, 0.0, -1.0, constraints_per_variable));
 320     if (getUpdateMechanism() == UM_LAZY) {
 321       // add to the heap the event when the latency is payed
 322       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->getLastUpdate());
 323       action->heapInsert(actionHeap_, action->latency_ + action->getLastUpdate(), route->empty() ? NORMAL : LATENCY);
 324     }
 325   } else
 326     action->setVariable(lmm_variable_new(maxminSystem_, action, 1.0, -1.0, constraints_per_variable));
 327
 328   if (action->rate_ < 0) {
 329     lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
 330   } else {
 331     lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)) : action->rate_);
 332   }
 333
 334   for (auto const& link : *route)
 335     lmm_expand(maxminSystem_, link->constraint(), action->getVariable(), 1.0);
 336
 337   if (back_route != nullptr) { //  sg_network_crosstraffic was activated
 338     XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
 339     for (auto const& link : *back_route)
 340       lmm_expand(maxminSystem_, link->constraint(), action->getVariable(), .05);
 341
 342     //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 343     //(You would also have to change lmm_element_concurrency())
 344     //lmm_variable_concurrency_share_set(action->getVariable(),2);
 345   }
 346
 347   delete route;
 348   delete back_route;
 349   XBT_OUT();
 350
 351   simgrid::s4u::Link::onCommunicate(action, src, dst);
 352   return action;
 353 }
 354
 355 /************
 356  * Resource *
 357  ************/
 358 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
 359                                  e_surf_link_sharing_policy_t policy, lmm_system_t system)
 360     : LinkImpl(model, name, lmm_constraint_new(system, this, sg_bandwidth_factor * bandwidth))
 361 {
 362   bandwidth_.scale = 1.0;
 363   bandwidth_.peak  = bandwidth;
 364
 365   latency_.scale = 1.0;
 366   latency_.peak  = latency;
 367
 368   if (policy == SURF_LINK_FATPIPE)
 369     lmm_constraint_shared(constraint());
 370
 371   simgrid::s4u::Link::onCreation(this->piface_);
 372 }
 373
 374 void NetworkCm02Link::apply_event(tmgr_trace_event_t triggered, double value)
 375 {
 376   /* Find out which of my iterators was triggered, and react accordingly */
 377   if (triggered == bandwidth_.event) {
 378     setBandwidth(value);
 379     tmgr_trace_event_unref(&bandwidth_.event);
 380
 381   } else if (triggered == latency_.event) {
 382     setLatency(value);
 383     tmgr_trace_event_unref(&latency_.event);
 384
 385   } else if (triggered == stateEvent_) {
 386     if (value > 0)
 387       turnOn();
 388     else {
 389       lmm_variable_t var = nullptr;
 390       lmm_element_t elem = nullptr;
 391       double now = surf_get_clock();
 392
 393       turnOff();
 394       while ((var = lmm_get_var_from_cnst(model()->getMaxminSystem(), constraint(), &elem))) {
 395         Action *action = static_cast<Action*>( lmm_variable_id(var) );
 396
 397         if (action->getState() == Action::State::running ||
 398             action->getState() == Action::State::ready) {
 399           action->setFinishTime(now);
 400           action->setState(Action::State::failed);
 401         }
 402       }
 403     }
 404     tmgr_trace_event_unref(&stateEvent_);
 405   } else {
 406     xbt_die("Unknown event!\n");
 407   }
 408
 409   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)", constraint());
 410 }
 411
 412 void NetworkCm02Link::setBandwidth(double value)
 413 {
 414
 415   bandwidth_.peak = value;
 416
 417   lmm_update_constraint_bound(model()->getMaxminSystem(), constraint(),
 418                               sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
 419   TRACE_surf_link_set_bandwidth(surf_get_clock(), getCname(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
 420
 421   if (sg_weight_S_parameter > 0) {
 422     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 423
 424     lmm_variable_t var;
 425     lmm_element_t elem = nullptr;
 426     lmm_element_t nextelem = nullptr;
 427     int numelem = 0;
 428     while ((var = lmm_get_var_from_cnst_safe(model()->getMaxminSystem(), constraint(), &elem, &nextelem, &numelem))) {
 429       NetworkCm02Action *action = static_cast<NetworkCm02Action*>(lmm_variable_id(var));
 430       action->weight_ += delta;
 431       if (not action->isSuspended())
 432         lmm_update_variable_weight(model()->getMaxminSystem(), action->getVariable(), action->weight_);
 433     }
 434   }
 435 }
 436
 437 void NetworkCm02Link::setLatency(double value)
 438 {
 439   double delta           = value - latency_.peak;
 440   lmm_variable_t var = nullptr;
 441   lmm_element_t elem = nullptr;
 442   lmm_element_t nextelem = nullptr;
 443   int numelem = 0;
 444
 445   latency_.peak = value;
 446
 447   while ((var = lmm_get_var_from_cnst_safe(model()->getMaxminSystem(), constraint(), &elem, &nextelem, &numelem))) {
 448     NetworkCm02Action *action = static_cast<NetworkCm02Action*>(lmm_variable_id(var));
 449     action->latCurrent_ += delta;
 450     action->weight_ += delta;
 451     if (action->rate_ < 0)
 452       lmm_update_variable_bound(model()->getMaxminSystem(), action->getVariable(),
 453                                 sg_tcp_gamma / (2.0 * action->latCurrent_));
 454     else {
 455       lmm_update_variable_bound(model()->getMaxminSystem(), action->getVariable(),
 456                                 std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
 457
 458       if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
 459         XBT_INFO("Flow is limited BYBANDWIDTH");
 460       } else {
 461         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
 462       }
 463     }
 464     if (not action->isSuspended())
 465       lmm_update_variable_weight(model()->getMaxminSystem(), action->getVariable(), action->weight_);
 466   }
 467 }
 468
 469 /**********
 470  * Action *
 471  **********/
 472
 473 void NetworkCm02Action::updateRemainingLazy(double now)
 474 {
 475   if (suspended_ != 0)
 476     return;
 477
 478   double delta        = now - getLastUpdate();
 479   double max_duration = getMaxDuration();
 480
 481   if (getRemainsNoUpdate() > 0) {
 482     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, getRemainsNoUpdate(), getLastUpdate());
 483     updateRemains(getLastValue() * delta);
 484
 485     XBT_DEBUG("Updating action(%p): remains is now %f", this, getRemainsNoUpdate());
 486   }
 487
 488   if (max_duration > NO_MAX_DURATION) {
 489     double_update(&max_duration, delta, sg_surf_precision);
 490     setMaxDuration(max_duration);
 491   }
 492
 493   if ((getRemainsNoUpdate() <= 0 && (lmm_get_variable_weight(getVariable()) > 0)) ||
 494       ((max_duration > NO_MAX_DURATION) && (max_duration <= 0))) {
 495     finish(Action::State::done);
 496     heapRemove(getModel()->getActionHeap());
 497   }
 498
 499   refreshLastUpdate();
 500   setLastValue(lmm_variable_getvalue(getVariable()));
 501 }
 502
 503 }
 504 }