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