Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
finish the removal of lagrange-related things
[simgrid.git] / src / kernel / lmm / maxmin.hpp
1 /* Copyright (c) 2004-2019. 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 #ifndef SURF_MAXMIN_HPP
7 #define SURF_MAXMIN_HPP
8
9 #include "simgrid/kernel/resource/Action.hpp"
10 #include "simgrid/s4u/Link.hpp"
11 #include "xbt/asserts.h"
12 #include "xbt/mallocator.h"
13
14 #include <boost/intrusive/list.hpp>
15 #include <cmath>
16 #include <limits>
17 #include <vector>
18
19 namespace simgrid {
20 namespace kernel {
21 namespace lmm {
22
23 /** @addtogroup SURF_lmm
24  * @details
25  * A linear maxmin solver to resolve inequations systems.
26  *
27  * Most SimGrid model rely on a "fluid/steady-state" modeling that simulate the sharing of resources between actions at
28  * relatively coarse-grain.  Such sharing is generally done by solving a set of linear inequations. Let's take an
29  * example and assume we have the variables \f$x_1\f$, \f$x_2\f$, \f$x_3\f$, and \f$x_4\f$ . Let's say that \f$x_1\f$
30  * and \f$x_2\f$ correspond to activities running and the same CPU \f$A\f$ whose capacity is \f$C_A\f$. In such a
31  * case, we need to enforce:
32  *
33  *   \f[ x_1 + x_2 \leq C_A \f]
34  *
35  * Likewise, if \f$x_3\f$ (resp. \f$x_4\f$) corresponds to a network flow \f$F_3\f$ (resp. \f$F_4\f$) that goes through
36  * a set of links \f$L_1\f$ and \f$L_2\f$ (resp. \f$L_2\f$ and \f$L_3\f$), then we need to enforce:
37  *
38  *   \f[ x_3  \leq C_{L_1} \f]
39  *   \f[ x_3 + x_4 \leq C_{L_2} \f]
40  *   \f[ x_4 \leq C_{L_3} \f]
41  *
42  * One could set every variable to 0 to make sure the constraints are satisfied but this would obviously not be very
43  * realistic. A possible objective is to try to maximize the minimum of the \f$x_i\f$ . This ensures that all the
44  * \f$x_i\f$ are positive and "as large as possible".
45  *
46  * This is called *max-min fairness* and is the most commonly used objective in SimGrid. Another possibility is to
47  * maximize \f$\sum_if(x_i)\f$, where \f$f\f$ is a strictly increasing concave function.
48  *
49  * Constraint:
50  *  - bound (set)
51  *  - shared (set)
52  *  - usage (computed)
53  *
54  * Variable:
55  *  - weight (set)
56  *  - bound (set)
57  *  - value (computed)
58  *
59  * Element:
60  *  - value (set)
61  *
62  * A possible system could be:
63  * - three variables: `var1`, `var2`, `var3`
64  * - two constraints: `cons1`, `cons2`
65  * - four elements linking:
66  *  - `elem1` linking `var1` and `cons1`
67  *  - `elem2` linking `var2` and `cons1`
68  *  - `elem3` linking `var2` and `cons2`
69  *  - `elem4` linking `var3` and `cons2`
70  *
71  * And the corresponding inequations will be:
72  *
73  *     var1.value <= var1.bound
74  *     var2.value <= var2.bound
75  *     var3.value <= var3.bound
76  *     var1.weight * var1.value * elem1.value + var2.weight * var2.value * elem2.value <= cons1.bound
77  *     var2.weight * var2.value * elem3.value + var3.weight * var3.value * elem4.value <= cons2.bound
78  *
79  * where `var1.value`, `var2.value` and `var3.value` are the unknown values.
80  *
81  * If a constraint is not shared, the sum is replaced by a max.
82  * For example, a third non-shared constraint `cons3` and the associated elements `elem5` and `elem6` could write as:
83  *
84  *     max( var1.weight * var1.value * elem5.value  ,  var3.weight * var3.value * elem6.value ) <= cons3.bound
85  *
86  * This is useful for the sharing of resources for various models.
87  * For instance, for the network model, each link is associated to a constraint and each communication to a variable.
88  *
89  * Implementation details
90  *
91  * For implementation reasons, we are interested in distinguishing variables that actually participate to the
92  * computation of constraints, and those who are part of the equations but are stuck to zero.
93  * We call enabled variables, those which var.weight is strictly positive. Zero-weight variables are called disabled
94  * variables.
95  * Unfortunately this concept of enabled/disabled variables intersects with active/inactive variable.
96  * Semantically, the intent is similar, but the conditions under which a variable is active is slightly more strict
97  * than the conditions for it to be enabled.
98  * A variable is active only if its var.value is non-zero (and, by construction, its var.weight is non-zero).
99  * In general, variables remain disabled after their creation, which often models an initialization phase (e.g. first
100  * packet propagating in the network). Then, it is enabled by the corresponding model. Afterwards, the max-min solver
101  * (lmm_solve()) activates it when appropriate. It is possible that the variable is again disabled, e.g. to model the
102  * pausing of an action.
103  *
104  * Concurrency limit and maximum
105  *
106  * We call concurrency, the number of variables that can be enabled at any time for each constraint.
107  * From a model perspective, this "concurrency" often represents the number of actions that actually compete for one
108  * constraint.
109  * The LMM solver is able to limit the concurrency for each constraint, and to monitor its maximum value.
110  *
111  * One may want to limit the concurrency of constraints for essentially three reasons:
112  *  - Keep LMM system in a size that can be solved (it does not react very well with tens of thousands of variables per
113  *    constraint)
114  *  - Stay within parameters where the fluid model is accurate enough.
115  *  - Model serialization effects
116  *
117  * The concurrency limit can also be set to a negative value to disable concurrency limit. This can improve performance
118  * slightly.
119  *
120  * Overall, each constraint contains three fields related to concurrency:
121  *  - concurrency_limit which is the limit enforced by the solver
122  *  - concurrency_current which is the current concurrency
123  *  - concurrency_maximum which is the observed maximum concurrency
124  *
125  * Variables also have one field related to concurrency: concurrency_share.
126  * In effect, in some cases, one variable is involved multiple times (i.e. two elements) in a constraint.
127  * For example, cross-traffic is modeled using 2 elements per constraint.
128  * concurrency_share formally corresponds to the maximum number of elements that associate the variable and any given
129  * constraint.
130  */
131
132 /** @{ @ingroup SURF_lmm */
133
134 /**
135  * @brief LMM element
136  * Elements can be seen as glue between constraint objects and variable objects.
137  * Basically, each variable will have a set of elements, one for each constraint where it is involved.
138  * Then, it is used to list all variables involved in constraint through constraint's xxx_element_set lists, or
139  * vice-versa list all constraints for a given variable.
140  */
141 class XBT_PUBLIC Element {
142 public:
143   int get_concurrency() const;
144   void decrease_concurrency();
145   void increase_concurrency();
146
147   void make_active();
148   void make_inactive();
149
150   /* hookup to constraint */
151   boost::intrusive::list_member_hook<> enabled_element_set_hook;
152   boost::intrusive::list_member_hook<> disabled_element_set_hook;
153   boost::intrusive::list_member_hook<> active_element_set_hook;
154
155   Constraint* constraint;
156   Variable* variable;
157
158   // consumption_weight: impact of 1 byte or flop of your application onto the resource (in byte or flop)
159   //   - if CPU, then probably 1.
160   //   - If network, then 1 in forward direction and 0.05 backward for the ACKs
161   double consumption_weight;
162 };
163
164 class ConstraintLight {
165 public:
166   double remaining_over_usage;
167   Constraint* cnst;
168 };
169
170 /**
171  * @brief LMM constraint
172  * Each constraint contains several partially overlapping logical sets of elements:
173  * \li Disabled elements which variable's weight is zero. This variables are not at all processed by LMM, but eventually
174  *     the corresponding action will enable it (at least this is the idea).
175  * \li Enabled elements which variable's weight is non-zero. They are utilized in some LMM functions.
176  * \li Active elements which variable's weight is non-zero (i.e. it is enabled) AND its element value is non-zero.
177  *     LMM_solve iterates over active elements during resolution, dynamically making them active or unactive.
178  */
179 class XBT_PUBLIC Constraint {
180 public:
181   Constraint() = delete;
182   Constraint(void* id_value, double bound_value);
183
184   /** @brief Unshare a constraint. */
185   void unshare() { sharing_policy_ = s4u::Link::SharingPolicy::FATPIPE; }
186
187   /**
188    * @brief Check if a constraint is shared (shared by default)
189    * @return 1 if shared, 0 otherwise
190    */
191   s4u::Link::SharingPolicy get_sharing_policy() const { return sharing_policy_; }
192
193   /**
194    * @brief Get the usage of the constraint after the last lmm solve
195    * @return The usage of the constraint
196    */
197   double get_usage() const;
198   int get_variable_amount() const;
199
200   /**
201    * @brief Sets the concurrency limit for this constraint
202    * @param limit The concurrency limit to use for this constraint
203    */
204   void set_concurrency_limit(int limit)
205   {
206     xbt_assert(limit < 0 || concurrency_maximum_ <= limit,
207                "New concurrency limit should be larger than observed concurrency maximum. Maybe you want to call"
208                " concurrency_maximum_reset() to reset the maximum?");
209     concurrency_limit_ = limit;
210   }
211
212   /**
213    * @brief Gets the concurrency limit for this constraint
214    * @return The concurrency limit used by this constraint
215    */
216   int get_concurrency_limit() const { return concurrency_limit_; }
217
218   /**
219    * @brief Reset the concurrency maximum for a given variable (we will update the maximum to reflect constraint
220    * evolution).
221    */
222   void reset_concurrency_maximum() { concurrency_maximum_ = 0; }
223
224   /**
225    * @brief Get the concurrency maximum for a given variable (which reflects constraint evolution).
226    * @return the maximum concurrency of the constraint
227    */
228   int get_concurrency_maximum() const
229   {
230     xbt_assert(concurrency_limit_ < 0 || concurrency_maximum_ <= concurrency_limit_,
231                "Very bad: maximum observed concurrency is higher than limit. This is a bug of SURF, please report it.");
232     return concurrency_maximum_;
233   }
234
235   int get_concurrency_slack() const
236   {
237     return concurrency_limit_ < 0 ? std::numeric_limits<int>::max() : concurrency_limit_ - concurrency_current_;
238   }
239
240   /**
241    * @brief Get a var associated to a constraint
242    * @details Get the first variable of the next variable of elem if elem is not NULL
243    * @param elem A element of constraint of the constraint or NULL
244    * @return A variable associated to a constraint
245    */
246   Variable* get_variable(const Element** elem) const;
247
248   /**
249    * @brief Get a var associated to a constraint
250    * @details Get the first variable of the next variable of elem if elem is not NULL
251    * @param elem A element of constraint of the constraint or NULL
252    * @param nextelem A element of constraint of the constraint or NULL, the one after elem
253    * @param numelem parameter representing the number of elements to go
254    * @return A variable associated to a constraint
255    */
256   Variable* get_variable_safe(const Element** elem, const Element** nextelem, int* numelem) const;
257
258   /**
259    * @brief Get the data associated to a constraint
260    * @return The data associated to the constraint
261    */
262   void* get_id() const { return id_; }
263
264   /* hookup to system */
265   boost::intrusive::list_member_hook<> constraint_set_hook_;
266   boost::intrusive::list_member_hook<> active_constraint_set_hook_;
267   boost::intrusive::list_member_hook<> modified_constraint_set_hook_;
268   boost::intrusive::list_member_hook<> saturated_constraint_set_hook_;
269   boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
270                                                                 &Element::enabled_element_set_hook>>
271       enabled_element_set_;
272   boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
273                                                                 &Element::disabled_element_set_hook>>
274       disabled_element_set_;
275   boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
276                                                                 &Element::active_element_set_hook>>
277       active_element_set_;
278   double remaining_;
279   double usage_;
280   double bound_;
281   // TODO MARTIN Check maximum value across resources at the end of simulation and give a warning is more than e.g. 500
282   int concurrency_current_; /* The current concurrency */
283   int concurrency_maximum_; /* The maximum number of (enabled and disabled) variables associated to the constraint at
284                              * any given time (essentially for tracing)*/
285
286   s4u::Link::SharingPolicy sharing_policy_;
287   int rank_; // Only used in debug messages to identify the constraint
288   double lambda_;
289   double new_lambda_;
290   ConstraintLight* cnst_light_;
291
292 private:
293   static int next_rank_;  // To give a separate rank_ to each contraint
294   int concurrency_limit_; /* The maximum number of variables that may be enabled at any time (stage variables if
295                            * necessary) */
296   void* id_;
297 };
298
299 /**
300  * @brief LMM variable
301  *
302  * When something prevents us from enabling a variable, we "stage" the weight that we would have like to set, so that as
303  * soon as possible we enable the variable with desired weight
304  */
305 class XBT_PUBLIC Variable {
306 public:
307   void initialize(resource::Action* id_value, double sharing_weight_value, double bound_value,
308                   int number_of_constraints, unsigned visited_value);
309
310   /**
311    * @brief Get the value of the variable after the last lmm solve
312    * @return The value of the variable
313    */
314   double get_value() const { return value_; }
315
316   /**
317    * @brief Get the maximum value of the variable (-1.0 if no maximum value)
318    * @return The bound of the variable
319    */
320   double get_bound() const { return bound_; }
321
322   /**
323    * @brief Set the concurrent share of the variable
324    * @param value The new concurrency share
325    */
326   void set_concurrency_share(short int value) { concurrency_share_ = value; }
327
328   /**
329    * @brief Get the numth constraint associated to the variable
330    * @param num The rank of constraint we want to get
331    * @return The numth constraint
332    */
333   Constraint* get_constraint(unsigned num) const { return num < cnsts_.size() ? cnsts_[num].constraint : nullptr; }
334
335   /**
336    * @brief Get the weigth of the numth constraint associated to the variable
337    * @param num The rank of constraint we want to get
338    * @return The numth constraint
339    */
340   double get_constraint_weight(unsigned num) const
341   {
342     return num < cnsts_.size() ? cnsts_[num].consumption_weight : 0.0;
343   }
344
345   /**
346    * @brief Get the number of constraint associated to a variable
347    * @return The number of constraint associated to the variable
348    */
349   size_t get_number_of_constraint() const { return cnsts_.size(); }
350
351   /**
352    * @brief Get the data associated to a variable
353    * @return The data associated to the variable
354    */
355   resource::Action* get_id() const { return id_; }
356
357   /**
358    * @brief Get the weight of a variable
359    * @return The weight of the variable
360    */
361   double get_weight() const { return sharing_weight_; }
362
363   /** @brief Measure the minimum concurrency slack across all constraints where the given var is involved */
364   int get_min_concurrency_slack() const;
365
366   /** @brief Check if a variable can be enabled
367    * Make sure to set staged_weight before, if your intent is only to check concurrency
368    */
369   int can_enable() const { return staged_weight_ > 0 && get_min_concurrency_slack() >= concurrency_share_; }
370
371   /* hookup to system */
372   boost::intrusive::list_member_hook<> variable_set_hook_;
373   boost::intrusive::list_member_hook<> saturated_variable_set_hook_;
374
375   std::vector<Element> cnsts_;
376
377   // sharing_weight: variable's impact on the resource during the sharing
378   //   if == 0, the variable is not considered by LMM
379   //   on CPU, actions with N threads have a sharing of N
380   //   on network, the actions with higher latency have a lesser sharing_weight
381   double sharing_weight_;
382
383   double staged_weight_; /* If non-zero, variable is staged for addition as soon as maxconcurrency constraints will be
384                             met */
385   double bound_;
386   double value_;
387   short int concurrency_share_; /* The maximum number of elements that variable will add to a constraint */
388   resource::Action* id_;
389   int rank_;         // Only used in debug messages to identify the variable
390   unsigned visited_; /* used by System::update_modified_set() */
391   double mu_;
392
393 private:
394   static int next_rank_; // To give a separate rank_ to each variable
395 };
396
397 inline void Element::make_active()
398 {
399   constraint->active_element_set_.push_front(*this);
400 }
401 inline void Element::make_inactive()
402 {
403   if (active_element_set_hook.is_linked())
404     simgrid::xbt::intrusive_erase(constraint->active_element_set_, *this);
405 }
406
407 /**
408  * @brief LMM system
409  */
410 class XBT_PUBLIC System {
411 public:
412   /**
413    * @brief Create a new Linear MaxMim system
414    * @param selective_update whether we should do lazy updates
415    */
416   explicit System(bool selective_update);
417   /** @brief Free an existing Linear MaxMin system */
418   virtual ~System();
419
420   /**
421    * @brief Create a new Linear MaxMin constraint
422    * @param id Data associated to the constraint (e.g.: a network link)
423    * @param bound_value The bound value of the constraint
424    */
425   Constraint* constraint_new(void* id, double bound_value);
426
427   /**
428    * @brief Create a new Linear MaxMin variable
429    * @param id Data associated to the variable (e.g.: a network communication)
430    * @param weight_value The weight of the variable (0.0 if not used)
431    * @param bound The maximum value of the variable (-1.0 if no maximum value)
432    * @param number_of_constraints The maximum number of constraint to associate to the variable
433    */
434   Variable* variable_new(resource::Action* id, double weight_value, double bound, size_t number_of_constraints);
435
436   /**
437    * @brief Free a variable
438    * @param var The variable to free
439    */
440   void variable_free(Variable * var);
441
442   /**
443    * @brief Associate a variable to a constraint with a coefficient
444    * @param cnst A constraint
445    * @param var A variable
446    * @param value The coefficient associated to the variable in the constraint
447    */
448   void expand(Constraint * cnst, Variable * var, double value);
449
450   /**
451    * @brief Add value to the coefficient between a constraint and a variable or create one
452    * @param cnst A constraint
453    * @param var A variable
454    * @param value The value to add to the coefficient associated to the variable in the constraint
455    */
456   void expand_add(Constraint * cnst, Variable * var, double value);
457
458   /**
459    * @brief Update the bound of a variable
460    * @param var A constraint
461    * @param bound The new bound
462    */
463   void update_variable_bound(Variable * var, double bound);
464
465   /**
466    * @brief Update the weight of a variable
467    * @param var A variable
468    * @param weight The new weight of the variable
469    */
470   void update_variable_weight(Variable * var, double weight);
471
472   /**
473    * @brief Update a constraint bound
474    * @param cnst A constraint
475    * @param bound The new bound of the consrtaint
476    */
477   void update_constraint_bound(Constraint * cnst, double bound);
478
479   /**
480    * @brief [brief description]
481    * @param cnst A constraint
482    * @return [description]
483    */
484   int constraint_used(Constraint* cnst) { return cnst->active_constraint_set_hook_.is_linked(); }
485
486   /** @brief Print the lmm system */
487   void print() const;
488
489   /** @brief Solve the lmm system */
490   void lmm_solve();
491
492   /** @brief Solve the lmm system. May be specialized in subclasses. */
493   virtual void solve() { lmm_solve(); }
494
495 private:
496   static void* variable_mallocator_new_f();
497   static void variable_mallocator_free_f(void* var);
498
499   void var_free(Variable * var);
500   void cnst_free(Constraint * cnst);
501   Variable* extract_variable()
502   {
503     if (variable_set.empty())
504       return nullptr;
505     Variable* res = &variable_set.front();
506     variable_set.pop_front();
507     return res;
508   }
509   Constraint* extract_constraint()
510   {
511     if (constraint_set.empty())
512       return nullptr;
513     Constraint* res = &constraint_set.front();
514     constraint_set.pop_front();
515     return res;
516   }
517   void insert_constraint(Constraint * cnst) { constraint_set.push_back(*cnst); }
518   void remove_variable(Variable * var)
519   {
520     if (var->variable_set_hook_.is_linked())
521       simgrid::xbt::intrusive_erase(variable_set, *var);
522     if (var->saturated_variable_set_hook_.is_linked())
523       simgrid::xbt::intrusive_erase(saturated_variable_set, *var);
524   }
525   void make_constraint_active(Constraint * cnst)
526   {
527     if (not cnst->active_constraint_set_hook_.is_linked())
528       active_constraint_set.push_back(*cnst);
529   }
530   void make_constraint_inactive(Constraint * cnst)
531   {
532     if (cnst->active_constraint_set_hook_.is_linked())
533       simgrid::xbt::intrusive_erase(active_constraint_set, *cnst);
534     if (cnst->modified_constraint_set_hook_.is_linked())
535       simgrid::xbt::intrusive_erase(modified_constraint_set, *cnst);
536   }
537
538   void enable_var(Variable * var);
539   void disable_var(Variable * var);
540   void on_disabled_var(Constraint * cnstr);
541
542   /**
543    * @brief Update the value of element linking the constraint and the variable
544    * @param cnst A constraint
545    * @param var A variable
546    * @param value The new value
547    */
548   void update(Constraint * cnst, Variable * var, double value);
549
550   void update_modified_set(Constraint * cnst);
551   void update_modified_set_rec(Constraint * cnst);
552
553   /** @brief Remove all constraints of the modified_constraint_set. */
554   void remove_all_modified_set();
555   void check_concurrency() const;
556
557   template <class CnstList> void lmm_solve(CnstList& cnst_list);
558
559 public:
560   bool modified_ = false;
561   boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
562                                                                  &Variable::variable_set_hook_>>
563       variable_set;
564   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
565                                                                    &Constraint::active_constraint_set_hook_>>
566       active_constraint_set;
567   boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
568                                                                  &Variable::saturated_variable_set_hook_>>
569       saturated_variable_set;
570   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
571                                                                    &Constraint::saturated_constraint_set_hook_>>
572       saturated_constraint_set;
573
574   resource::Action::ModifiedSet* modified_set_ = nullptr;
575
576 private:
577   bool selective_update_active; /* flag to update partially the system only selecting changed portions */
578   unsigned visited_counter_ = 1; /* used by System::update_modified_set() and System::remove_all_modified_set() to
579                                   * cleverly (un-)flag the constraints (more details in these functions) */
580   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
581                                                                    &Constraint::constraint_set_hook_>>
582       constraint_set;
583   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
584                                                                    &Constraint::modified_constraint_set_hook_>>
585       modified_constraint_set;
586   xbt_mallocator_t variable_mallocator_ =
587       xbt_mallocator_new(65536, System::variable_mallocator_new_f, System::variable_mallocator_free_f, nullptr);
588 };
589
590 class XBT_PUBLIC FairBottleneck : public System {
591 public:
592   explicit FairBottleneck(bool selective_update) : System(selective_update) {}
593   void solve() final { bottleneck_solve(); }
594
595 private:
596   void bottleneck_solve();
597 };
598
599 XBT_PUBLIC System* make_new_maxmin_system(bool selective_update);
600 XBT_PUBLIC System* make_new_fair_bottleneck_system(bool selective_update);
601
602 /** @} */
603 }
604 }
605 }
606
607 #endif