Logo AND Algorithmique Numérique Distribuée

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