Logo AND Algorithmique Numérique Distribuée

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