src/surf/maxmin.cpp

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