src/kernel/lmm/maxmin.cpp

   1 /* Copyright (c) 2004-2018. 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 "src/kernel/lmm/maxmin.hpp"
   7 #include "src/surf/surf_interface.hpp"
   8 #include "xbt/backtrace.hpp"
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_maxmin, surf, "Logging specific to SURF (maxmin)");
  11
  12 double sg_maxmin_precision = 0.00001; /* Change this with --cfg=maxmin/precision:VALUE */
  13 double sg_surf_precision   = 0.00001; /* Change this with --cfg=surf/precision:VALUE */
  14 int sg_concurrency_limit   = -1;      /* Change this with --cfg=maxmin/concurrency-limit:VALUE */
  15
  16 namespace simgrid {
  17 namespace kernel {
  18 namespace lmm {
  19
  20 typedef std::vector<int> dyn_light_t;
  21
  22 int Variable::Global_debug_id   = 1;
  23 int Constraint::Global_debug_id = 1;
  24
  25 System* make_new_maxmin_system(bool selective_update)
  26 {
  27   return new System(selective_update);
  28 }
  29
  30 int Element::get_concurrency() const
  31 {
  32   // Ignore element with weight less than one (e.g. cross-traffic)
  33   return (consumption_weight >= 1) ? 1 : 0;
  34   // There are other alternatives, but they will change the behaviour of the model..
  35   // So do not use it unless you want to make a new model.
  36   // If you do, remember to change the variables concurrency share to reflect it.
  37   // Potential examples are:
  38   // return (elem->weight>0)?1:0;//Include element as soon  as weight is non-zero
  39   // return (int)ceil(elem->weight);//Include element as the rounded-up integer value of the element weight
  40 }
  41
  42 void Element::decrease_concurrency()
  43 {
  44   xbt_assert(constraint->concurrency_current >= get_concurrency());
  45   constraint->concurrency_current -= get_concurrency();
  46 }
  47
  48 void Element::increase_concurrency()
  49 {
  50   constraint->concurrency_current += get_concurrency();
  51
  52   if (constraint->concurrency_current > constraint->concurrency_maximum)
  53     constraint->concurrency_maximum = constraint->concurrency_current;
  54
  55   xbt_assert(constraint->get_concurrency_limit() < 0 ||
  56                  constraint->concurrency_current <= constraint->get_concurrency_limit(),
  57              "Concurrency limit overflow!");
  58 }
  59
  60 void System::check_concurrency() const
  61 {
  62   // These checks are very expensive, so do them only if we want to debug SURF LMM
  63   if (not XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug))
  64     return;
  65
  66   for (Constraint const& cnst : constraint_set) {
  67     int concurrency       = 0;
  68     for (Element const& elem : cnst.enabled_element_set) {
  69       xbt_assert(elem.variable->sharing_weight > 0);
  70       concurrency += elem.get_concurrency();
  71     }
  72
  73     for (Element const& elem : cnst.disabled_element_set) {
  74       // We should have staged variables only if concurrency is reached in some constraint
  75       xbt_assert(cnst.get_concurrency_limit() < 0 || elem.variable->staged_weight == 0 ||
  76                      elem.variable->get_min_concurrency_slack() < elem.variable->concurrency_share,
  77                  "should not have staged variable!");
  78     }
  79
  80     xbt_assert(cnst.get_concurrency_limit() < 0 || cnst.get_concurrency_limit() >= concurrency,
  81                "concurrency check failed!");
  82     xbt_assert(cnst.concurrency_current == concurrency, "concurrency_current is out-of-date!");
  83   }
  84
  85   // Check that for each variable, all corresponding elements are in the same state (i.e. same element sets)
  86   for (Variable const& var : variable_set) {
  87     if (var.cnsts.empty())
  88       continue;
  89
  90     const Element& elem    = var.cnsts[0];
  91     int belong_to_enabled  = elem.enabled_element_set_hook.is_linked();
  92     int belong_to_disabled = elem.disabled_element_set_hook.is_linked();
  93     int belong_to_active   = elem.active_element_set_hook.is_linked();
  94
  95     for (Element const& elem2 : var.cnsts) {
  96       xbt_assert(belong_to_enabled == elem2.enabled_element_set_hook.is_linked(),
  97                  "Variable inconsistency (1): enabled_element_set");
  98       xbt_assert(belong_to_disabled == elem2.disabled_element_set_hook.is_linked(),
  99                  "Variable inconsistency (2): disabled_element_set");
 100       xbt_assert(belong_to_active == elem2.active_element_set_hook.is_linked(),
 101                  "Variable inconsistency (3): active_element_set");
 102     }
 103   }
 104 }
 105
 106 void System::var_free(Variable* var)
 107 {
 108   XBT_IN("(sys=%p, var=%p)", this, var);
 109   modified_ = true;
 110
 111   // TODOLATER Can do better than that by leaving only the variable in only one enabled_element_set, call
 112   // update_modified_set, and then remove it..
 113   if (not var->cnsts.empty())
 114     update_modified_set(var->cnsts[0].constraint);
 115
 116   for (Element& elem : var->cnsts) {
 117     if (var->sharing_weight > 0)
 118       elem.decrease_concurrency();
 119     if (elem.enabled_element_set_hook.is_linked())
 120       simgrid::xbt::intrusive_erase(elem.constraint->enabled_element_set, elem);
 121     if (elem.disabled_element_set_hook.is_linked())
 122       simgrid::xbt::intrusive_erase(elem.constraint->disabled_element_set, elem);
 123     if (elem.active_element_set_hook.is_linked())
 124       simgrid::xbt::intrusive_erase(elem.constraint->active_element_set, elem);
 125     int nelements = elem.constraint->enabled_element_set.size() + elem.constraint->disabled_element_set.size();
 126     if (nelements == 0)
 127       make_constraint_inactive(elem.constraint);
 128     else
 129       on_disabled_var(elem.constraint);
 130   }
 131
 132   var->cnsts.clear();
 133
 134   check_concurrency();
 135
 136   xbt_mallocator_release(variable_mallocator_, var);
 137   XBT_OUT();
 138 }
 139
 140 System::System(bool selective_update) : selective_update_active(selective_update)
 141 {
 142   XBT_DEBUG("Setting selective_update_active flag to %d", selective_update_active);
 143
 144   if (selective_update)
 145     modified_set_ = new kernel::resource::Action::ModifiedSet();
 146 }
 147
 148 System::~System()
 149 {
 150   Variable* var;
 151   Constraint* cnst;
 152
 153   while ((var = extract_variable())) {
 154     auto demangled = simgrid::xbt::demangle(typeid(*var->id).name());
 155     XBT_WARN("Probable bug: a %s variable (#%d) not removed before the LMM system destruction.", demangled.get(),
 156              var->id_int);
 157     var_free(var);
 158   }
 159   while ((cnst = extract_constraint()))
 160     cnst_free(cnst);
 161
 162   xbt_mallocator_free(variable_mallocator_);
 163   delete modified_set_;
 164 }
 165
 166 void System::cnst_free(Constraint* cnst)
 167 {
 168   make_constraint_inactive(cnst);
 169   delete cnst;
 170 }
 171
 172 Constraint::Constraint(void* id_value, double bound_value) : bound(bound_value), id(id_value)
 173 {
 174   id_int = Global_debug_id++;
 175
 176   remaining           = 0.0;
 177   usage               = 0.0;
 178   concurrency_limit   = sg_concurrency_limit;
 179   concurrency_current = 0;
 180   concurrency_maximum = 0;
 181   sharing_policy      = 1; /* FIXME: don't hardcode the value */
 182
 183   lambda     = 0.0;
 184   new_lambda = 0.0;
 185   cnst_light = nullptr;
 186 }
 187
 188 Constraint* System::constraint_new(void* id, double bound_value)
 189 {
 190   Constraint* cnst = new Constraint(id, bound_value);
 191   insert_constraint(cnst);
 192   return cnst;
 193 }
 194
 195 void* System::variable_mallocator_new_f()
 196 {
 197   return new Variable;
 198 }
 199
 200 void System::variable_mallocator_free_f(void* var)
 201 {
 202   delete static_cast<Variable*>(var);
 203 }
 204
 205 Variable* System::variable_new(resource::Action* id, double sharing_weight, double bound, int number_of_constraints)
 206 {
 207   XBT_IN("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)", this, id, sharing_weight, bound, number_of_constraints);
 208
 209   Variable* var = static_cast<Variable*>(xbt_mallocator_get(variable_mallocator_));
 210   var->initialize(id, sharing_weight, bound, number_of_constraints, visited_counter_ - 1);
 211   if (sharing_weight)
 212     variable_set.push_front(*var);
 213   else
 214     variable_set.push_back(*var);
 215
 216   XBT_OUT(" returns %p", var);
 217   return var;
 218 }
 219
 220 void System::variable_free(Variable* var)
 221 {
 222   remove_variable(var);
 223   var_free(var);
 224 }
 225
 226 void System::expand(Constraint* cnst, Variable* var, double consumption_weight)
 227 {
 228   modified_ = true;
 229
 230   // Check if this variable already has an active element in this constraint
 231   // If it does, substract it from the required slack
 232   int current_share = 0;
 233   if (var->concurrency_share > 1) {
 234     for (Element& elem : var->cnsts) {
 235       if (elem.constraint == cnst && elem.enabled_element_set_hook.is_linked())
 236         current_share += elem.get_concurrency();
 237     }
 238   }
 239
 240   // Check if we need to disable the variable
 241   if (var->sharing_weight > 0 && var->concurrency_share - current_share > cnst->get_concurrency_slack()) {
 242     double weight = var->sharing_weight;
 243     disable_var(var);
 244     for (Element const& elem : var->cnsts)
 245       on_disabled_var(elem.constraint);
 246     consumption_weight = 0;
 247     var->staged_weight = weight;
 248     xbt_assert(not var->sharing_weight);
 249   }
 250
 251   xbt_assert(var->cnsts.size() < var->cnsts.capacity(), "Too much constraints");
 252
 253   var->cnsts.resize(var->cnsts.size() + 1);
 254   Element& elem = var->cnsts.back();
 255
 256   elem.consumption_weight = consumption_weight;
 257   elem.constraint         = cnst;
 258   elem.variable           = var;
 259
 260   if (var->sharing_weight) {
 261     elem.constraint->enabled_element_set.push_front(elem);
 262     elem.increase_concurrency();
 263   } else
 264     elem.constraint->disabled_element_set.push_back(elem);
 265
 266   if (not selective_update_active) {
 267     make_constraint_active(cnst);
 268   } else if (elem.consumption_weight > 0 || var->sharing_weight > 0) {
 269     make_constraint_active(cnst);
 270     update_modified_set(cnst);
 271     // TODOLATER: Why do we need this second call?
 272     if (var->cnsts.size() > 1)
 273       update_modified_set(var->cnsts[0].constraint);
 274   }
 275
 276   check_concurrency();
 277 }
 278
 279 void System::expand_add(Constraint* cnst, Variable* var, double value)
 280 {
 281   modified_ = true;
 282
 283   check_concurrency();
 284
 285   // BEWARE: In case you have multiple elements in one constraint, this will always add value to the first element.
 286   auto elem_it =
 287       std::find_if(begin(var->cnsts), end(var->cnsts), [&cnst](Element const& x) { return x.constraint == cnst; });
 288   if (elem_it != end(var->cnsts)) {
 289     Element& elem = *elem_it;
 290     if (var->sharing_weight)
 291       elem.decrease_concurrency();
 292
 293     if (cnst->sharing_policy)
 294       elem.consumption_weight += value;
 295     else
 296       elem.consumption_weight = std::max(elem.consumption_weight, value);
 297
 298     // We need to check that increasing value of the element does not cross the concurrency limit
 299     if (var->sharing_weight) {
 300       if (cnst->get_concurrency_slack() < elem.get_concurrency()) {
 301         double weight = var->sharing_weight;
 302         disable_var(var);
 303         for (Element const& elem2 : var->cnsts)
 304           on_disabled_var(elem2.constraint);
 305         var->staged_weight = weight;
 306         xbt_assert(not var->sharing_weight);
 307       }
 308       elem.increase_concurrency();
 309     }
 310     update_modified_set(cnst);
 311   } else
 312     expand(cnst, var, value);
 313
 314   check_concurrency();
 315 }
 316
 317 Variable* Constraint::get_variable(const Element** elem) const
 318 {
 319   if (*elem == nullptr) {
 320     // That is the first call, pick the first element among enabled_element_set (or disabled_element_set if
 321     // enabled_element_set is empty)
 322     if (not enabled_element_set.empty())
 323       *elem = &enabled_element_set.front();
 324     else if (not disabled_element_set.empty())
 325       *elem = &disabled_element_set.front();
 326     else
 327       *elem = nullptr;
 328   } else {
 329     // elem is not null, so we carry on
 330     if ((*elem)->enabled_element_set_hook.is_linked()) {
 331       // Look at enabled_element_set, and jump to disabled_element_set when finished
 332       auto iter = std::next(enabled_element_set.iterator_to(**elem));
 333       if (iter != std::end(enabled_element_set))
 334         *elem = &*iter;
 335       else if (not disabled_element_set.empty())
 336         *elem = &disabled_element_set.front();
 337       else
 338         *elem = nullptr;
 339     } else {
 340       auto iter = std::next(disabled_element_set.iterator_to(**elem));
 341       *elem     = iter != std::end(disabled_element_set) ? &*iter : nullptr;
 342     }
 343   }
 344   if (*elem)
 345     return (*elem)->variable;
 346   else
 347     return nullptr;
 348 }
 349
 350 // if we modify the list between calls, normal version may loop forever
 351 // this safe version ensures that we browse the list elements only once
 352 Variable* Constraint::get_variable_safe(const Element** elem, const Element** nextelem, int* numelem) const
 353 {
 354   if (*elem == nullptr) {
 355     *numelem = enabled_element_set.size() + disabled_element_set.size() - 1;
 356     if (not enabled_element_set.empty())
 357       *elem = &enabled_element_set.front();
 358     else if (not disabled_element_set.empty())
 359       *elem = &disabled_element_set.front();
 360     else
 361       *elem = nullptr;
 362   } else {
 363     *elem = *nextelem;
 364     if (*numelem > 0) {
 365       (*numelem)--;
 366     } else
 367       return nullptr;
 368   }
 369   if (*elem) {
 370     // elem is not null, so we carry on
 371     if ((*elem)->enabled_element_set_hook.is_linked()) {
 372       // Look at enabled_element_set, and jump to disabled_element_set when finished
 373       auto iter = std::next(enabled_element_set.iterator_to(**elem));
 374       if (iter != std::end(enabled_element_set))
 375         *nextelem = &*iter;
 376       else if (not disabled_element_set.empty())
 377         *nextelem = &disabled_element_set.front();
 378       else
 379         *nextelem = nullptr;
 380     } else {
 381       auto iter = std::next(disabled_element_set.iterator_to(**elem));
 382       *nextelem = iter != std::end(disabled_element_set) ? &*iter : nullptr;
 383     }
 384     return (*elem)->variable;
 385   } else
 386     return nullptr;
 387 }
 388
 389 static inline void saturated_constraints_update(double usage, int cnst_light_num, dyn_light_t& saturated_constraints,
 390                                                 double* min_usage)
 391 {
 392   xbt_assert(usage > 0, "Impossible");
 393
 394   if (*min_usage < 0 || *min_usage > usage) {
 395     *min_usage = usage;
 396     XBT_HERE(" min_usage=%f (cnst->remaining / cnst->usage =%f)", *min_usage, usage);
 397     saturated_constraints.assign(1, cnst_light_num);
 398   } else if (*min_usage == usage) {
 399     saturated_constraints.emplace_back(cnst_light_num);
 400   }
 401 }
 402
 403 static inline void saturated_variable_set_update(ConstraintLight* cnst_light_tab,
 404                                                  const dyn_light_t& saturated_constraints, System* sys)
 405 {
 406   /* Add active variables (i.e. variables that need to be set) from the set of constraints to saturate
 407    * (cnst_light_tab)*/
 408   for (int const& saturated_cnst : saturated_constraints) {
 409     ConstraintLight& cnst = cnst_light_tab[saturated_cnst];
 410     for (Element const& elem : cnst.cnst->active_element_set) {
 411       // Visiting active_element_set, so, by construction, should never get a zero weight, correct?
 412       xbt_assert(elem.variable->sharing_weight > 0);
 413       if (elem.consumption_weight > 0 && not elem.variable->saturated_variable_set_hook.is_linked())
 414         sys->saturated_variable_set.push_back(*elem.variable);
 415     }
 416   }
 417 }
 418
 419 template <class ElemList>
 420 static void format_element_list(const ElemList& elem_list, int sharing_policy, double& sum, std::string& buf)
 421 {
 422   for (Element const& elem : elem_list) {
 423     buf += std::to_string(elem.consumption_weight) + ".'" + std::to_string(elem.variable->id_int) + "'(" +
 424            std::to_string(elem.variable->value) + ")" + (sharing_policy ? " + " : " , ");
 425     if (sharing_policy)
 426       sum += elem.consumption_weight * elem.variable->value;
 427     else
 428       sum = std::max(sum, elem.consumption_weight * elem.variable->value);
 429   }
 430 }
 431
 432 void System::print() const
 433 {
 434   std::string buf = std::string("MAX-MIN ( ");
 435
 436   /* Printing Objective */
 437   for (Variable const& var : variable_set)
 438     buf += "'" + std::to_string(var.id_int) + "'(" + std::to_string(var.sharing_weight) + ") ";
 439   buf += ")";
 440   XBT_DEBUG("%20s", buf.c_str());
 441   buf.clear();
 442
 443   XBT_DEBUG("Constraints");
 444   /* Printing Constraints */
 445   for (Constraint const& cnst : active_constraint_set) {
 446     double sum            = 0.0;
 447     // Show  the enabled variables
 448     buf += "\t";
 449     buf += cnst.sharing_policy ? "(" : "max(";
 450     format_element_list(cnst.enabled_element_set, cnst.sharing_policy, sum, buf);
 451     // TODO: Adding disabled elements only for test compatibility, but do we really want them to be printed?
 452     format_element_list(cnst.disabled_element_set, cnst.sharing_policy, sum, buf);
 453
 454     buf += "0) <= " + std::to_string(cnst.bound) + " ('" + std::to_string(cnst.id_int) + "')";
 455
 456     if (not cnst.sharing_policy) {
 457       buf += " [MAX-Constraint]";
 458     }
 459     XBT_DEBUG("%s", buf.c_str());
 460     buf.clear();
 461     xbt_assert(not double_positive(sum - cnst.bound, cnst.bound * sg_maxmin_precision),
 462                "Incorrect value (%f is not smaller than %f): %g", sum, cnst.bound, sum - cnst.bound);
 463   }
 464
 465   XBT_DEBUG("Variables");
 466   /* Printing Result */
 467   for (Variable const& var : variable_set) {
 468     if (var.bound > 0) {
 469       XBT_DEBUG("'%d'(%f) : %f (<=%f)", var.id_int, var.sharing_weight, var.value, var.bound);
 470       xbt_assert(not double_positive(var.value - var.bound, var.bound * sg_maxmin_precision),
 471                  "Incorrect value (%f is not smaller than %f", var.value, var.bound);
 472     } else {
 473       XBT_DEBUG("'%d'(%f) : %f", var.id_int, var.sharing_weight, var.value);
 474     }
 475   }
 476 }
 477
 478 void System::lmm_solve()
 479 {
 480   if (modified_) {
 481     XBT_IN("(sys=%p)", this);
 482     /* Compute Usage and store the variables that reach the maximum. If selective_update_active is true, only
 483      * constraints that changed are considered. Otherwise all constraints with active actions are considered.
 484      */
 485     if (selective_update_active)
 486       lmm_solve(modified_constraint_set);
 487     else
 488       lmm_solve(active_constraint_set);
 489     XBT_OUT();
 490   }
 491 }
 492
 493 template <class CnstList> void System::lmm_solve(CnstList& cnst_list)
 494 {
 495   double min_usage = -1;
 496   double min_bound = -1;
 497
 498   XBT_DEBUG("Active constraints : %zu", cnst_list.size());
 499   /* Init: Only modified code portions: reset the value of active variables */
 500   for (Constraint const& cnst : cnst_list) {
 501     for (Element const& elem : cnst.enabled_element_set) {
 502       xbt_assert(elem.variable->sharing_weight > 0.0);
 503       elem.variable->value = 0.0;
 504     }
 505   }
 506
 507   ConstraintLight* cnst_light_tab = new ConstraintLight[cnst_list.size()]();
 508   int cnst_light_num              = 0;
 509   dyn_light_t saturated_constraints;
 510
 511   for (Constraint& cnst : cnst_list) {
 512     /* INIT: Collect constraints that actually need to be saturated (i.e remaining  and usage are strictly positive)
 513      * into cnst_light_tab. */
 514     cnst.remaining = cnst.bound;
 515     if (not double_positive(cnst.remaining, cnst.bound * sg_maxmin_precision))
 516       continue;
 517     cnst.usage = 0;
 518     for (Element& elem : cnst.enabled_element_set) {
 519       xbt_assert(elem.variable->sharing_weight > 0);
 520       if (elem.consumption_weight > 0) {
 521         if (cnst.sharing_policy)
 522           cnst.usage += elem.consumption_weight / elem.variable->sharing_weight;
 523         else if (cnst.usage < elem.consumption_weight / elem.variable->sharing_weight)
 524           cnst.usage = elem.consumption_weight / elem.variable->sharing_weight;
 525
 526         elem.make_active();
 527         resource::Action* action = static_cast<resource::Action*>(elem.variable->id);
 528         if (modified_set_ && not action->is_within_modified_set())
 529           modified_set_->push_back(*action);
 530       }
 531     }
 532     XBT_DEBUG("Constraint '%d' usage: %f remaining: %f concurrency: %i<=%i<=%i", cnst.id_int, cnst.usage,
 533               cnst.remaining, cnst.concurrency_current, cnst.concurrency_maximum, cnst.get_concurrency_limit());
 534     /* Saturated constraints update */
 535
 536     if (cnst.usage > 0) {
 537       cnst_light_tab[cnst_light_num].cnst                 = &cnst;
 538       cnst.cnst_light                                     = &cnst_light_tab[cnst_light_num];
 539       cnst_light_tab[cnst_light_num].remaining_over_usage = cnst.remaining / cnst.usage;
 540       saturated_constraints_update(cnst_light_tab[cnst_light_num].remaining_over_usage, cnst_light_num,
 541                                    saturated_constraints, &min_usage);
 542       xbt_assert(not cnst.active_element_set.empty(),
 543                  "There is no sense adding a constraint that has no active element!");
 544       cnst_light_num++;
 545     }
 546   }
 547
 548   saturated_variable_set_update(cnst_light_tab, saturated_constraints, this);
 549
 550   /* Saturated variables update */
 551   do {
 552     /* Fix the variables that have to be */
 553     auto& var_list = saturated_variable_set;
 554     for (Variable const& var : var_list) {
 555       if (var.sharing_weight <= 0.0)
 556         DIE_IMPOSSIBLE;
 557       /* First check if some of these variables could reach their upper bound and update min_bound accordingly. */
 558       XBT_DEBUG("var=%d, var.bound=%f, var.weight=%f, min_usage=%f, var.bound*var.weight=%f", var.id_int, var.bound,
 559                 var.sharing_weight, min_usage, var.bound * var.sharing_weight);
 560       if ((var.bound > 0) && (var.bound * var.sharing_weight < min_usage)) {
 561         if (min_bound < 0)
 562           min_bound = var.bound * var.sharing_weight;
 563         else
 564           min_bound = std::min(min_bound, (var.bound * var.sharing_weight));
 565         XBT_DEBUG("Updated min_bound=%f", min_bound);
 566       }
 567     }
 568
 569     while (not var_list.empty()) {
 570       Variable& var = var_list.front();
 571       if (min_bound < 0) {
 572         // If no variable could reach its bound, deal iteratively the constraints usage ( at worst one constraint is
 573         // saturated at each cycle)
 574         var.value = min_usage / var.sharing_weight;
 575         XBT_DEBUG("Setting var (%d) value to %f\n", var.id_int, var.value);
 576       } else {
 577         // If there exist a variable that can reach its bound, only update it (and other with the same bound) for now.
 578         if (double_equals(min_bound, var.bound * var.sharing_weight, sg_maxmin_precision)) {
 579           var.value = var.bound;
 580           XBT_DEBUG("Setting %p (%d) value to %f\n", &var, var.id_int, var.value);
 581         } else {
 582           // Variables which bound is different are not considered for this cycle, but they will be afterwards.
 583           XBT_DEBUG("Do not consider %p (%d) \n", &var, var.id_int);
 584           var_list.pop_front();
 585           continue;
 586         }
 587       }
 588       XBT_DEBUG("Min usage: %f, Var(%d).weight: %f, Var(%d).value: %f ", min_usage, var.id_int, var.sharing_weight,
 589                 var.id_int, var.value);
 590
 591       /* Update the usage of contraints where this variable is involved */
 592       for (Element& elem : var.cnsts) {
 593         Constraint* cnst = elem.constraint;
 594         if (cnst->sharing_policy) {
 595           // Remember: shared constraints require that sum(elem.value * var.value) < cnst->bound
 596           double_update(&(cnst->remaining), elem.consumption_weight * var.value, cnst->bound * sg_maxmin_precision);
 597           double_update(&(cnst->usage), elem.consumption_weight / var.sharing_weight, sg_maxmin_precision);
 598           // If the constraint is saturated, remove it from the set of active constraints (light_tab)
 599           if (not double_positive(cnst->usage, sg_maxmin_precision) ||
 600               not double_positive(cnst->remaining, cnst->bound * sg_maxmin_precision)) {
 601             if (cnst->cnst_light) {
 602               int index = (cnst->cnst_light - cnst_light_tab);
 603               XBT_DEBUG("index: %d \t cnst_light_num: %d \t || usage: %f remaining: %f bound: %f  ", index,
 604                         cnst_light_num, cnst->usage, cnst->remaining, cnst->bound);
 605               cnst_light_tab[index]                  = cnst_light_tab[cnst_light_num - 1];
 606               cnst_light_tab[index].cnst->cnst_light = &cnst_light_tab[index];
 607               cnst_light_num--;
 608               cnst->cnst_light = nullptr;
 609             }
 610           } else {
 611             cnst->cnst_light->remaining_over_usage = cnst->remaining / cnst->usage;
 612           }
 613           elem.make_inactive();
 614         } else {
 615           // Remember: non-shared constraints only require that max(elem.value * var.value) < cnst->bound
 616           cnst->usage = 0.0;
 617           elem.make_inactive();
 618           for (Element& elem2 : cnst->enabled_element_set) {
 619             xbt_assert(elem2.variable->sharing_weight > 0);
 620             if (elem2.variable->value > 0)
 621               continue;
 622             if (elem2.consumption_weight > 0)
 623               cnst->usage = std::max(cnst->usage, elem2.consumption_weight / elem2.variable->sharing_weight);
 624           }
 625           // If the constraint is saturated, remove it from the set of active constraints (light_tab)
 626           if (not double_positive(cnst->usage, sg_maxmin_precision) ||
 627               not double_positive(cnst->remaining, cnst->bound * sg_maxmin_precision)) {
 628             if (cnst->cnst_light) {
 629               int index = (cnst->cnst_light - cnst_light_tab);
 630               XBT_DEBUG("index: %d \t cnst_light_num: %d \t || \t cnst: %p \t cnst->cnst_light: %p "
 631                         "\t cnst_light_tab: %p usage: %f remaining: %f bound: %f  ",
 632                         index, cnst_light_num, cnst, cnst->cnst_light, cnst_light_tab, cnst->usage, cnst->remaining,
 633                         cnst->bound);
 634               cnst_light_tab[index]                  = cnst_light_tab[cnst_light_num - 1];
 635               cnst_light_tab[index].cnst->cnst_light = &cnst_light_tab[index];
 636               cnst_light_num--;
 637               cnst->cnst_light = nullptr;
 638             }
 639           } else {
 640             cnst->cnst_light->remaining_over_usage = cnst->remaining / cnst->usage;
 641             xbt_assert(not cnst->active_element_set.empty(),
 642                        "Should not keep a maximum constraint that has no active"
 643                        " element! You want to check the maxmin precision and possible rounding effects.");
 644           }
 645         }
 646       }
 647       var_list.pop_front();
 648     }
 649
 650     /* Find out which variables reach the maximum */
 651     min_usage = -1;
 652     min_bound = -1;
 653     saturated_constraints.clear();
 654     int pos;
 655     for (pos = 0; pos < cnst_light_num; pos++) {
 656       xbt_assert(not cnst_light_tab[pos].cnst->active_element_set.empty(),
 657                  "Cannot saturate more a constraint that has"
 658                  " no active element! You may want to change the maxmin precision (--cfg=maxmin/precision:<new_value>)"
 659                  " because of possible rounding effects.\n\tFor the record, the usage of this constraint is %g while "
 660                  "the maxmin precision to which it is compared is %g.\n\tThe usage of the previous constraint is %g.",
 661                  cnst_light_tab[pos].cnst->usage, sg_maxmin_precision, cnst_light_tab[pos - 1].cnst->usage);
 662       saturated_constraints_update(cnst_light_tab[pos].remaining_over_usage, pos, saturated_constraints, &min_usage);
 663     }
 664
 665     saturated_variable_set_update(cnst_light_tab, saturated_constraints, this);
 666
 667   } while (cnst_light_num > 0);
 668
 669   modified_ = false;
 670   if (selective_update_active)
 671     remove_all_modified_set();
 672
 673   if (XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
 674     print();
 675   }
 676
 677   check_concurrency();
 678
 679   delete[] cnst_light_tab;
 680 }
 681
 682 /** \brief Attribute the value bound to var->bound.
 683  *
 684  *  \param var the Variable*
 685  *  \param bound the new bound to associate with var
 686  *
 687  *  Makes var->bound equal to bound. Whenever this function is called a change is  signed in the system. To
 688  *  avoid false system changing detection it is a good idea to test (bound != 0) before calling it.
 689  */
 690 void System::update_variable_bound(Variable* var, double bound)
 691 {
 692   modified_  = true;
 693   var->bound = bound;
 694
 695   if (not var->cnsts.empty())
 696     update_modified_set(var->cnsts[0].constraint);
 697 }
 698
 699 void Variable::initialize(resource::Action* id_value, double sharing_weight_value, double bound_value,
 700                           int number_of_constraints, unsigned visited_value)
 701 {
 702   id     = id_value;
 703   id_int = Global_debug_id++;
 704   cnsts.reserve(number_of_constraints);
 705   sharing_weight    = sharing_weight_value;
 706   staged_weight     = 0.0;
 707   bound             = bound_value;
 708   concurrency_share = 1;
 709   value             = 0.0;
 710   visited           = visited_value;
 711   mu                = 0.0;
 712   new_mu            = 0.0;
 713
 714   xbt_assert(not variable_set_hook.is_linked());
 715   xbt_assert(not saturated_variable_set_hook.is_linked());
 716 }
 717
 718 int Variable::get_min_concurrency_slack() const
 719 {
 720   int minslack = std::numeric_limits<int>::max();
 721   for (Element const& elem : cnsts) {
 722     int slack = elem.constraint->get_concurrency_slack();
 723     if (slack < minslack) {
 724       // This is only an optimization, to avoid looking at more constraints when slack is already zero
 725       if (slack == 0)
 726         return 0;
 727       minslack = slack;
 728     }
 729   }
 730   return minslack;
 731 }
 732
 733 // Small remark: In this implementation of System::enable_var() and System::disable_var(), we will meet multiple times
 734 // with var when running System::update_modified_set().
 735 // A priori not a big performance issue, but we might do better by calling System::update_modified_set() within the for
 736 // loops (after doing the first for enabling==1, and before doing the last for disabling==1)
 737 void System::enable_var(Variable* var)
 738 {
 739   xbt_assert(not XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug) || var->can_enable());
 740
 741   var->sharing_weight = var->staged_weight;
 742   var->staged_weight  = 0;
 743
 744   // Enabling the variable, move var to list head. Subtlety is: here, we need to call update_modified_set AFTER
 745   // moving at least one element of var.
 746
 747   simgrid::xbt::intrusive_erase(variable_set, *var);
 748   variable_set.push_front(*var);
 749   for (Element& elem : var->cnsts) {
 750     simgrid::xbt::intrusive_erase(elem.constraint->disabled_element_set, elem);
 751     elem.constraint->enabled_element_set.push_front(elem);
 752     elem.increase_concurrency();
 753   }
 754   if (not var->cnsts.empty())
 755     update_modified_set(var->cnsts[0].constraint);
 756
 757   // When used within on_disabled_var, we would get an assertion fail, because transiently there can be variables
 758   // that are staged and could be activated.
 759   // Anyway, caller functions all call check_concurrency() in the end.
 760 }
 761
 762 void System::disable_var(Variable* var)
 763 {
 764   xbt_assert(not var->staged_weight, "Staged weight should have been cleared");
 765   // Disabling the variable, move to var to list tail. Subtlety is: here, we need to call update_modified_set
 766   // BEFORE moving the last element of var.
 767   simgrid::xbt::intrusive_erase(variable_set, *var);
 768   variable_set.push_back(*var);
 769   if (not var->cnsts.empty())
 770     update_modified_set(var->cnsts[0].constraint);
 771   for (Element& elem : var->cnsts) {
 772     simgrid::xbt::intrusive_erase(elem.constraint->enabled_element_set, elem);
 773     elem.constraint->disabled_element_set.push_back(elem);
 774     if (elem.active_element_set_hook.is_linked())
 775       simgrid::xbt::intrusive_erase(elem.constraint->active_element_set, elem);
 776     elem.decrease_concurrency();
 777   }
 778
 779   var->sharing_weight = 0.0;
 780   var->staged_weight  = 0.0;
 781   var->value          = 0.0;
 782   check_concurrency();
 783 }
 784
 785 /* /brief Find variables that can be enabled and enable them.
 786  *
 787  * Assuming that the variable has already been removed from non-zero weights
 788  * Can we find a staged variable to add?
 789  * If yes, check that none of the constraints that this variable is involved in is at the limit of its concurrency
 790  * And then add it to enabled variables
 791  */
 792 void System::on_disabled_var(Constraint* cnstr)
 793 {
 794   if (cnstr->get_concurrency_limit() < 0)
 795     return;
 796
 797   int numelem = cnstr->disabled_element_set.size();
 798   if (not numelem)
 799     return;
 800
 801   Element* elem = &cnstr->disabled_element_set.front();
 802
 803   // Cannot use foreach loop, because System::enable_var() will modify disabled_element_set.. within the loop
 804   while (numelem-- && elem) {
 805
 806     Element* nextelem;
 807     if (elem->disabled_element_set_hook.is_linked()) {
 808       auto iter = std::next(cnstr->disabled_element_set.iterator_to(*elem));
 809       nextelem  = iter != std::end(cnstr->disabled_element_set) ? &*iter : nullptr;
 810     } else {
 811       nextelem = nullptr;
 812     }
 813
 814     if (elem->variable->staged_weight > 0 && elem->variable->can_enable()) {
 815       // Found a staged variable
 816       // TODOLATER: Add random timing function to model reservation protocol fuzziness? Then how to make sure that
 817       // staged variables will eventually be called?
 818       enable_var(elem->variable);
 819     }
 820
 821     xbt_assert(cnstr->concurrency_current <= cnstr->get_concurrency_limit(), "Concurrency overflow!");
 822     if (cnstr->concurrency_current == cnstr->get_concurrency_limit())
 823       break;
 824
 825     elem = nextelem;
 826   }
 827
 828   // We could get an assertion fail, because transiently there can be variables that are staged and could be activated.
 829   // And we need to go through all constraints of the disabled var before getting back a coherent state.
 830   // Anyway, caller functions all call check_concurrency() in the end.
 831 }
 832
 833 /* \brief update the weight of a variable, and enable/disable it.
 834  * @return Returns whether a change was made
 835  */
 836 void System::update_variable_weight(Variable* var, double weight)
 837 {
 838   xbt_assert(weight >= 0, "Variable weight should not be negative!");
 839
 840   if (weight == var->sharing_weight)
 841     return;
 842
 843   int enabling_var  = (weight > 0 && var->sharing_weight <= 0);
 844   int disabling_var = (weight <= 0 && var->sharing_weight > 0);
 845
 846   XBT_IN("(sys=%p, var=%p, weight=%f)", this, var, weight);
 847
 848   modified_ = true;
 849
 850   // Are we enabling this variable?
 851   if (enabling_var) {
 852     var->staged_weight = weight;
 853     int minslack       = var->get_min_concurrency_slack();
 854     if (minslack < var->concurrency_share) {
 855       XBT_DEBUG("Staging var (instead of enabling) because min concurrency slack %i, with weight %f and concurrency"
 856                 " share %i",
 857                 minslack, weight, var->concurrency_share);
 858       return;
 859     }
 860     XBT_DEBUG("Enabling var with min concurrency slack %i", minslack);
 861     enable_var(var);
 862   } else if (disabling_var) {
 863     // Are we disabling this variable?
 864     disable_var(var);
 865   } else {
 866     var->sharing_weight = weight;
 867   }
 868
 869   check_concurrency();
 870
 871   XBT_OUT();
 872 }
 873
 874 void System::update_constraint_bound(Constraint* cnst, double bound)
 875 {
 876   modified_ = true;
 877   update_modified_set(cnst);
 878   cnst->bound = bound;
 879 }
 880
 881 /** \brief Update the constraint set propagating recursively to other constraints so the system should not be entirely
 882  *  computed.
 883  *
 884  *  \param cnst the Constraint* affected by the change
 885  *
 886  *  A recursive algorithm to optimize the system recalculation selecting only constraints that have changed. Each
 887  *  constraint change is propagated to the list of constraints for each variable.
 888  */
 889 void System::update_modified_set_rec(Constraint* cnst)
 890 {
 891   for (Element const& elem : cnst->enabled_element_set) {
 892     Variable* var = elem.variable;
 893     for (Element const& elem2 : var->cnsts) {
 894       if (var->visited == visited_counter_)
 895         break;
 896       if (elem2.constraint != cnst && not elem2.constraint->modified_constraint_set_hook.is_linked()) {
 897         modified_constraint_set.push_back(*elem2.constraint);
 898         update_modified_set_rec(elem2.constraint);
 899       }
 900     }
 901     // var will be ignored in later visits as long as sys->visited_counter does not move
 902     var->visited = visited_counter_;
 903   }
 904 }
 905
 906 void System::update_modified_set(Constraint* cnst)
 907 {
 908   /* nothing to do if selective update isn't active */
 909   if (selective_update_active && not cnst->modified_constraint_set_hook.is_linked()) {
 910     modified_constraint_set.push_back(*cnst);
 911     update_modified_set_rec(cnst);
 912   }
 913 }
 914
 915 void System::remove_all_modified_set()
 916 {
 917   // We cleverly un-flag all variables just by incrementing visited_counter
 918   // In effect, the var->visited value will no more be equal to visited counter
 919   // To be clean, when visited counter has wrapped around, we force these var->visited values so that variables that
 920   // were in the modified a long long time ago are not wrongly skipped here, which would lead to very nasty bugs
 921   // (i.e. not readibily reproducible, and requiring a lot of run time before happening).
 922   if (++visited_counter_ == 1) {
 923     /* the counter wrapped around, reset each variable->visited */
 924     for (Variable& var : variable_set)
 925       var.visited = 0;
 926   }
 927   modified_constraint_set.clear();
 928 }
 929
 930 /**
 931  * Returns resource load (in flop per second, or byte per second, or similar)
 932  *
 933  * If the resource is shared (the default case), the load is sum of resource usage made by every variables located on
 934  * this resource.
 935  *
 936  * If the resource is not shared (ie in FATPIPE mode), then the load is the max (not the sum) of all resource usages
 937  * located on this resource.
 938  */
 939 double Constraint::get_usage() const
 940 {
 941   double result              = 0.0;
 942   if (sharing_policy) {
 943     for (Element const& elem : enabled_element_set)
 944       if (elem.consumption_weight > 0)
 945         result += elem.consumption_weight * elem.variable->value;
 946   } else {
 947     for (Element const& elem : enabled_element_set)
 948       if (elem.consumption_weight > 0)
 949         result = std::max(result, elem.consumption_weight * elem.variable->value);
 950   }
 951   return result;
 952 }
 953
 954 int Constraint::get_variable_amount() const
 955 {
 956   return std::count_if(std::begin(enabled_element_set), std::end(enabled_element_set),
 957                        [](const Element& elem) { return elem.consumption_weight > 0; });
 958 }
 959 }
 960 }
 961 }