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