src/surf/network_cm02.cpp

   1 /* Copyright (c) 2013-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <algorithm>
   8
   9 #include "maxmin_private.hpp"
  10 #include "network_cm02.hpp"
  11 #include "simgrid/s4u/host.hpp"
  12 #include "simgrid/sg_config.h"
  13 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
  16
  17 double sg_sender_gap = 0.0;
  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 double sg_tcp_gamma = 0.0;
  23 int sg_network_crosstraffic = 0;
  24
  25 /************************************************************************/
  26 /* New model based on optimizations discussed during Pedro Velho's thesis*/
  27 /************************************************************************/
  28 /* @techreport{VELHO:2011:HAL-00646896:1, */
  29 /*      url = {http://hal.inria.fr/hal-00646896/en/}, */
  30 /*      title = {{Flow-level network models: have we reached the limits?}}, */
  31 /*      author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
  32 /*      type = {Rapport de recherche}, */
  33 /*      institution = {INRIA}, */
  34 /*      number = {RR-7821}, */
  35 /*      year = {2011}, */
  36 /*      month = Nov, */
  37 /*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
  38 /*  } */
  39 void surf_network_model_init_LegrandVelho()
  40 {
  41   if (surf_network_model)
  42     return;
  43
  44   surf_network_model = new simgrid::surf::NetworkCm02Model();
  45   all_existing_models->push_back(surf_network_model);
  46
  47   xbt_cfg_setdefault_double("network/latency-factor",      13.01);
  48   xbt_cfg_setdefault_double("network/bandwidth-factor",     0.97);
  49   xbt_cfg_setdefault_double("network/weight-S",         20537);
  50 }
  51
  52 /***************************************************************************/
  53 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
  54 /***************************************************************************/
  55 /* @TechReport{      rr-lip2002-40, */
  56 /*   author        = {Henri Casanova and Loris Marchal}, */
  57 /*   institution   = {LIP}, */
  58 /*   title         = {A Network Model for Simulation of Grid Application}, */
  59 /*   number        = {2002-40}, */
  60 /*   month         = {oct}, */
  61 /*   year          = {2002} */
  62 /* } */
  63 void surf_network_model_init_CM02()
  64 {
  65
  66   if (surf_network_model)
  67     return;
  68
  69   surf_network_model = new simgrid::surf::NetworkCm02Model();
  70   all_existing_models->push_back(surf_network_model);
  71
  72   xbt_cfg_setdefault_double("network/latency-factor",   1.0);
  73   xbt_cfg_setdefault_double("network/bandwidth-factor", 1.0);
  74   xbt_cfg_setdefault_double("network/weight-S",         0.0);
  75 }
  76
  77 /***************************************************************************/
  78 /* The models from Steven H. Low                                           */
  79 /***************************************************************************/
  80 /* @article{Low03,                                                         */
  81 /*   author={Steven H. Low},                                               */
  82 /*   title={A Duality Model of {TCP} and Queue Management Algorithms},     */
  83 /*   year={2003},                                                          */
  84 /*   journal={{IEEE/ACM} Transactions on Networking},                      */
  85 /*    volume={11}, number={4},                                             */
  86 /*  }                                                                      */
  87 void surf_network_model_init_Reno()
  88 {
  89   if (surf_network_model)
  90     return;
  91
  92   surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
  93   all_existing_models->push_back(surf_network_model);
  94
  95   lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
  96
  97   xbt_cfg_setdefault_double("network/latency-factor",     10.4);
  98   xbt_cfg_setdefault_double("network/bandwidth-factor",    0.92);
  99   xbt_cfg_setdefault_double("network/weight-S",         8775);
 100 }
 101
 102
 103 void surf_network_model_init_Reno2()
 104 {
 105   if (surf_network_model)
 106     return;
 107
 108   surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
 109   all_existing_models->push_back(surf_network_model);
 110
 111   lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
 112
 113   xbt_cfg_setdefault_double("network/latency-factor",    10.4);
 114   xbt_cfg_setdefault_double("network/bandwidth-factor",   0.92);
 115   xbt_cfg_setdefault_double("network/weight-S",        8775);
 116 }
 117
 118 void surf_network_model_init_Vegas()
 119 {
 120   if (surf_network_model)
 121     return;
 122
 123   surf_network_model = new simgrid::surf::NetworkCm02Model(lagrange_solve);
 124   all_existing_models->push_back(surf_network_model);
 125
 126   lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
 127
 128   xbt_cfg_setdefault_double("network/latency-factor",    10.4);
 129   xbt_cfg_setdefault_double("network/bandwidth-factor",   0.92);
 130   xbt_cfg_setdefault_double("network/weight-S",        8775);
 131 }
 132
 133 namespace simgrid {
 134 namespace surf {
 135
 136 NetworkCm02Model::NetworkCm02Model()
 137   :NetworkModel()
 138 {
 139   char *optim = xbt_cfg_get_string("network/optim");
 140   bool select = xbt_cfg_get_boolean("network/maxmin-selective-update");
 141
 142   if (!strcmp(optim, "Full")) {
 143     updateMechanism_ = UM_FULL;
 144     selectiveUpdate_ = select;
 145   } else if (!strcmp(optim, "Lazy")) {
 146     updateMechanism_ = UM_LAZY;
 147     selectiveUpdate_ = true;
 148     xbt_assert(select || (xbt_cfg_is_default_value("network/maxmin-selective-update")),
 149                "You cannot disable selective update when using the lazy update mechanism");
 150   } else {
 151     xbt_die("Unsupported optimization (%s) for this model. Accepted: Full, Lazy.", optim);
 152   }
 153
 154   maxminSystem_ = lmm_system_new(selectiveUpdate_);
 155   loopback_     = createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
 156
 157   if (updateMechanism_ == UM_LAZY) {
 158     actionHeap_ = xbt_heap_new(8, nullptr);
 159     xbt_heap_set_update_callback(actionHeap_, surf_action_lmm_update_index_heap);
 160     modifiedSet_ = new ActionLmmList();
 161     maxminSystem_->keep_track = modifiedSet_;
 162   }
 163 }
 164 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(lmm_system_t self))
 165   : NetworkCm02Model()
 166 {
 167   maxminSystem_->solve_fun = specificSolveFun;
 168 }
 169
 170
 171 NetworkCm02Model::~NetworkCm02Model() {}
 172
 173 LinkImpl* NetworkCm02Model::createLink(const char* name, double bandwidth, double latency,
 174                                        e_surf_link_sharing_policy_t policy)
 175 {
 176   return new NetworkCm02Link(this, name, bandwidth, latency, policy, maxminSystem_);
 177 }
 178
 179 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
 180 {
 181   while ((xbt_heap_size(actionHeap_) > 0)
 182          && (double_equals(xbt_heap_maxkey(actionHeap_), now, sg_surf_precision))) {
 183
 184     NetworkCm02Action *action = static_cast<NetworkCm02Action*> (xbt_heap_pop(actionHeap_));
 185     XBT_DEBUG("Something happened to action %p", action);
 186     if (TRACE_is_enabled()) {
 187       int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
 188
 189       for (int i = 0; i < n; i++){
 190         lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
 191         NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
 192         double value = lmm_variable_getvalue(action->getVariable())*
 193             lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i);
 194         TRACE_surf_link_set_utilization(link->cname(), action->getCategory(), value, action->getLastUpdate(),
 195                                         now - action->getLastUpdate());
 196       }
 197     }
 198
 199     // if I am wearing a latency hat
 200     if (action->getHat() == LATENCY) {
 201       XBT_DEBUG("Latency paid for action %p. Activating", action);
 202       lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
 203       action->heapRemove(actionHeap_);
 204       action->refreshLastUpdate();
 205
 206         // if I am wearing a max_duration or normal hat
 207     } else if (action->getHat() == MAX_DURATION || action->getHat() == NORMAL) {
 208         // no need to communicate anymore
 209         // assume that flows that reached max_duration have remaining of 0
 210       XBT_DEBUG("Action %p finished", action);
 211       action->setRemains(0);
 212       action->finish();
 213       action->setState(Action::State::done);
 214       action->heapRemove(actionHeap_);
 215
 216       action->gapRemove();
 217     }
 218   }
 219 }
 220
 221
 222 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
 223 {
 224   ActionList *running_actions = getRunningActionSet();
 225
 226   for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
 227      ; it != itend ; it=itNext) {
 228     ++itNext;
 229
 230     NetworkCm02Action *action = static_cast<NetworkCm02Action*> (&*it);
 231     XBT_DEBUG("Something happened to action %p", action);
 232       double deltap = delta;
 233       if (action->latency_ > 0) {
 234         if (action->latency_ > deltap) {
 235           double_update(&(action->latency_), deltap, sg_surf_precision);
 236           deltap = 0.0;
 237         } else {
 238           double_update(&(deltap), action->latency_, sg_surf_precision);
 239           action->latency_ = 0.0;
 240         }
 241         if (action->latency_ == 0.0 && !(action->isSuspended()))
 242           lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
 243       }
 244       if (TRACE_is_enabled()) {
 245         int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
 246         for (int i = 0; i < n; i++){
 247           lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
 248
 249           NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
 250           TRACE_surf_link_set_utilization(link->cname(), action->getCategory(),
 251                                           (lmm_variable_getvalue(action->getVariable()) *
 252                                            lmm_get_cnst_weight_from_var(maxminSystem_, action->getVariable(), i)),
 253                                           action->getLastUpdate(), now - action->getLastUpdate());
 254         }
 255       }
 256       if (!lmm_get_number_of_cnst_from_var (maxminSystem_, action->getVariable())) {
 257         /* There is actually no link used, hence an infinite bandwidth.
 258          * This happens often when using models like vivaldi.
 259          * In such case, just make sure that the action completes immediately.
 260          */
 261         action->updateRemains(action->getRemains());
 262       }
 263     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 264
 265     if (action->getMaxDuration() != NO_MAX_DURATION)
 266       action->updateMaxDuration(delta);
 267
 268     if (((action->getRemains() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
 269         ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
 270       action->finish();
 271       action->setState(Action::State::done);
 272       action->gapRemove();
 273     }
 274   }
 275 }
 276
 277 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
 278 {
 279   int failed = 0;
 280   double latency = 0.0;
 281   std::vector<LinkImpl*>* back_route = nullptr;
 282   std::vector<LinkImpl*>* route = new std::vector<LinkImpl*>();
 283
 284   XBT_IN("(%s,%s,%g,%g)", src->cname(), dst->cname(), size, rate);
 285
 286   src->routeTo(dst, route, &latency);
 287   xbt_assert(!route->empty() || latency,
 288              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
 289              src->cname(), dst->cname());
 290
 291   for (auto link: *route)
 292     if (link->isOff())
 293       failed = 1;
 294
 295   if (sg_network_crosstraffic == 1) {
 296     back_route = new std::vector<LinkImpl*>();
 297     dst->routeTo(src, back_route, nullptr);
 298     for (auto link: *back_route)
 299       if (link->isOff())
 300         failed = 1;
 301   }
 302
 303   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
 304   action->weight_ = latency;
 305   action->latency_ = latency;
 306   action->rate_ = rate;
 307   if (updateMechanism_ == UM_LAZY) {
 308     action->indexHeap_ = -1;
 309     action->lastUpdate_ = surf_get_clock();
 310   }
 311
 312   double bandwidth_bound = -1.0;
 313   if (sg_weight_S_parameter > 0)
 314     for (auto link : *route)
 315       action->weight_ += sg_weight_S_parameter / link->bandwidth();
 316
 317   for (auto link : *route) {
 318     double bb       = bandwidthFactor(size) * link->bandwidth();
 319     bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
 320   }
 321
 322   action->latCurrent_ = action->latency_;
 323   action->latency_ *= latencyFactor(size);
 324   action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
 325   if (haveGap_) {
 326     xbt_assert(! route->empty(),
 327                "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
 328
 329     gapAppend(size, route->at(0), action);
 330     XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)", action, src->cname(), dst->cname(), action->senderGap_,
 331               action->latency_);
 332   }
 333
 334   int constraints_per_variable = route->size();
 335   if (back_route != nullptr)
 336     constraints_per_variable += back_route->size();
 337
 338   if (action->latency_ > 0) {
 339     action->variable_ = lmm_variable_new(maxminSystem_, action, 0.0, -1.0, constraints_per_variable);
 340     if (updateMechanism_ == UM_LAZY) {
 341       // add to the heap the event when the latency is payed
 342       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->lastUpdate_);
 343       action->heapInsert(actionHeap_, action->latency_ + action->lastUpdate_, route->empty() ? NORMAL : LATENCY);
 344     }
 345   } else
 346     action->variable_ = lmm_variable_new(maxminSystem_, action, 1.0, -1.0, constraints_per_variable);
 347
 348   if (action->rate_ < 0) {
 349     lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
 350   } else {
 351     lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)) : action->rate_);
 352   }
 353
 354   for (auto link: *route)
 355     lmm_expand(maxminSystem_, link->constraint(), action->getVariable(), 1.0);
 356
 357   if (back_route != nullptr) { //  sg_network_crosstraffic was activated
 358     XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
 359     for (auto link : *back_route)
 360       lmm_expand(maxminSystem_, link->constraint(), action->getVariable(), .05);
 361
 362     //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
 363     //(You would also have to change lmm_element_concurrency())
 364     //lmm_variable_concurrency_share_set(action->getVariable(),2);
 365   }
 366
 367   delete route;
 368   delete back_route;
 369   XBT_OUT();
 370
 371   simgrid::s4u::Link::onCommunicate(action, src, dst);
 372   return action;
 373 }
 374
 375 void NetworkCm02Model::gapAppend(double size, const LinkImpl* link, NetworkAction* action){
 376     // Nothing
 377 };
 378
 379 /************
 380  * Resource *
 381  ************/
 382 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const char* name, double bandwidth, double latency,
 383                                  e_surf_link_sharing_policy_t policy, lmm_system_t system)
 384     : LinkImpl(model, name, lmm_constraint_new(system, this, sg_bandwidth_factor * bandwidth))
 385 {
 386   bandwidth_.scale = 1.0;
 387   bandwidth_.peak  = bandwidth;
 388
 389   latency_.scale = 1.0;
 390   latency_.peak  = latency;
 391
 392   if (policy == SURF_LINK_FATPIPE)
 393     lmm_constraint_shared(constraint());
 394
 395   simgrid::s4u::Link::onCreation(this->piface_);
 396 }
 397
 398 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
 399 {
 400
 401   /* Find out which of my iterators was triggered, and react accordingly */
 402   if (triggered == bandwidth_.event) {
 403     setBandwidth(value);
 404     tmgr_trace_event_unref(&bandwidth_.event);
 405
 406   } else if (triggered == latency_.event) {
 407     setLatency(value);
 408     tmgr_trace_event_unref(&latency_.event);
 409
 410   } else if (triggered == stateEvent_) {
 411     if (value > 0)
 412       turnOn();
 413     else {
 414       lmm_variable_t var = nullptr;
 415       lmm_element_t elem = nullptr;
 416       double now = surf_get_clock();
 417
 418       turnOff();
 419       while ((var = lmm_get_var_from_cnst(model()->getMaxminSystem(), constraint(), &elem))) {
 420         Action *action = static_cast<Action*>( lmm_variable_id(var) );
 421
 422         if (action->getState() == Action::State::running ||
 423             action->getState() == Action::State::ready) {
 424           action->setFinishTime(now);
 425           action->setState(Action::State::failed);
 426         }
 427       }
 428     }
 429     tmgr_trace_event_unref(&stateEvent_);
 430   } else {
 431     xbt_die("Unknown event!\n");
 432   }
 433
 434   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)", constraint());
 435 }
 436
 437 void NetworkCm02Link::setBandwidth(double value)
 438 {
 439
 440   bandwidth_.peak = value;
 441
 442   lmm_update_constraint_bound(model()->getMaxminSystem(), constraint(),
 443                               sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
 444   TRACE_surf_link_set_bandwidth(surf_get_clock(), cname(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
 445
 446   if (sg_weight_S_parameter > 0) {
 447     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
 448
 449     lmm_variable_t var;
 450     lmm_element_t elem = nullptr;
 451     lmm_element_t nextelem = nullptr;
 452     int numelem = 0;
 453     while ((var = lmm_get_var_from_cnst_safe(model()->getMaxminSystem(), constraint(), &elem, &nextelem, &numelem))) {
 454       NetworkCm02Action *action = static_cast<NetworkCm02Action*>(lmm_variable_id(var));
 455       action->weight_ += delta;
 456       if (!action->isSuspended())
 457         lmm_update_variable_weight(model()->getMaxminSystem(), action->getVariable(), action->weight_);
 458     }
 459   }
 460 }
 461
 462 void NetworkCm02Link::setLatency(double value)
 463 {
 464   double delta           = value - latency_.peak;
 465   lmm_variable_t var = nullptr;
 466   lmm_element_t elem = nullptr;
 467   lmm_element_t nextelem = nullptr;
 468   int numelem = 0;
 469
 470   latency_.peak = value;
 471
 472   while ((var = lmm_get_var_from_cnst_safe(model()->getMaxminSystem(), constraint(), &elem, &nextelem, &numelem))) {
 473     NetworkCm02Action *action = static_cast<NetworkCm02Action*>(lmm_variable_id(var));
 474     action->latCurrent_ += delta;
 475     action->weight_ += delta;
 476     if (action->rate_ < 0)
 477       lmm_update_variable_bound(model()->getMaxminSystem(), action->getVariable(),
 478                                 sg_tcp_gamma / (2.0 * action->latCurrent_));
 479     else {
 480       lmm_update_variable_bound(model()->getMaxminSystem(), action->getVariable(),
 481                                 std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
 482
 483       if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
 484         XBT_INFO("Flow is limited BYBANDWIDTH");
 485       } else {
 486         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
 487       }
 488     }
 489     if (!action->isSuspended())
 490       lmm_update_variable_weight(model()->getMaxminSystem(), action->getVariable(), action->weight_);
 491   }
 492 }
 493
 494 NetworkCm02Link::~NetworkCm02Link() {}
 495
 496 /**********
 497  * Action *
 498  **********/
 499
 500 NetworkCm02Action::~NetworkCm02Action() {}
 501
 502 void NetworkCm02Action::updateRemainingLazy(double now)
 503 {
 504   if (suspended_ != 0)
 505     return;
 506
 507   double delta = now - lastUpdate_;
 508
 509   if (remains_ > 0) {
 510     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
 511     double_update(&(remains_), lastValue_ * delta, sg_maxmin_precision*sg_surf_precision);
 512
 513     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
 514   }
 515
 516   if (maxDuration_ != NO_MAX_DURATION)
 517     double_update(&maxDuration_, delta, sg_surf_precision);
 518
 519   if ((remains_ <= 0 && (lmm_get_variable_weight(getVariable()) > 0)) ||
 520       (((maxDuration_ > NO_MAX_DURATION) && (maxDuration_ <= 0)))){
 521     finish();
 522     setState(Action::State::done);
 523     heapRemove(getModel()->getActionHeap());
 524   }
 525
 526   lastUpdate_ = now;
 527   lastValue_ = lmm_variable_getvalue(getVariable());
 528 }
 529
 530 void NetworkCm02Link::gapAppend(double size, const LinkImpl* link, NetworkAction* action){
 531     // Nothing
 532 };
 533 }
 534 }