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