Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Solver as an configuration option for CPU
[simgrid.git] / src / kernel / lmm / maxmin.hpp
1 /* Copyright (c) 2004-2022. 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/kernel/resource/Model.hpp"
11 #include "simgrid/s4u/Link.hpp"
12 #include "src/surf/surf_interface.hpp"
13 #include "xbt/asserts.h"
14 #include "xbt/ex.h"
15 #include "xbt/mallocator.h"
16
17 #include <boost/intrusive/list.hpp>
18 #include <cmath>
19 #include <limits>
20 #include <memory>
21 #include <vector>
22
23 namespace simgrid {
24 namespace kernel {
25 namespace lmm {
26
27 /** @addtogroup SURF_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  */
135
136 /** @{ @ingroup SURF_lmm */
137
138 /**
139  * @brief LMM element
140  * Elements can be seen as glue between constraint objects and variable objects.
141  * Basically, each variable will have a set of elements, one for each constraint where it is involved.
142  * Then, it is used to list all variables involved in constraint through constraint's xxx_element_set lists, or
143  * vice-versa list all constraints for a given variable.
144  */
145 class XBT_PUBLIC Element {
146 public:
147   // Use rule-of-three, and implicitely disable the move constructor which should be 'noexcept' according to C++ Core
148   // Guidelines.
149   Element(Constraint* constraint, Variable* variable, double cweight);
150   Element(const Element&) = default;
151   ~Element()              = default;
152
153   int get_concurrency() const;
154   void decrease_concurrency();
155   void increase_concurrency();
156
157   void make_active();
158   void make_inactive();
159
160   /* hookup to constraint */
161   boost::intrusive::list_member_hook<> enabled_element_set_hook;
162   boost::intrusive::list_member_hook<> disabled_element_set_hook;
163   boost::intrusive::list_member_hook<> active_element_set_hook;
164
165   Constraint* constraint;
166   Variable* variable;
167
168   // consumption_weight: impact of 1 byte or flop of your application onto the resource (in byte or flop)
169   //   - if CPU, then probably 1.
170   //   - If network, then 1 in forward direction and 0.05 backward for the ACKs
171   double consumption_weight;
172   // maximum consumption weight (can be different from consumption_weight with subflows/ptasks)
173   double max_consumption_weight;
174 };
175
176 class ConstraintLight {
177 public:
178   double remaining_over_usage;
179   Constraint* cnst;
180 };
181
182 /**
183  * @brief LMM constraint
184  * Each constraint contains several partially overlapping logical sets of elements:
185  * \li Disabled elements which variable's weight is zero. This variables are not at all processed by LMM, but eventually
186  *     the corresponding action will enable it (at least this is the idea).
187  * \li Enabled elements which variable's weight is non-zero. They are utilized in some LMM functions.
188  * \li Active elements which variable's weight is non-zero (i.e. it is enabled) AND its element value is non-zero.
189  *     LMM_solve iterates over active elements during resolution, dynamically making them active or inactive.
190  */
191 class XBT_PUBLIC Constraint {
192 public:
193   enum class SharingPolicy { NONLINEAR = 2, SHARED = 1, FATPIPE = 0 };
194
195   Constraint(resource::Resource* id_value, double bound_value);
196
197   /** @brief Unshare a constraint. */
198   void unshare() { sharing_policy_ = SharingPolicy::FATPIPE; }
199
200   /** @brief Set how a constraint is shared  */
201   void set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
202   /** @brief Check how a constraint is shared  */
203   SharingPolicy get_sharing_policy() const { return sharing_policy_; }
204
205   /** @brief Get the usage of the constraint after the last lmm solve */
206   double get_usage() const;
207   int get_variable_amount() const;
208
209   /** @brief Sets the concurrency limit for this constraint */
210   void set_concurrency_limit(int limit)
211   {
212     xbt_assert(limit < 0 || concurrency_maximum_ <= limit,
213                "New concurrency limit should be larger than observed concurrency maximum. Maybe you want to call"
214                " concurrency_maximum_reset() to reset the maximum?");
215     concurrency_limit_ = limit;
216   }
217
218   /** @brief Gets the concurrency limit for this constraint */
219   int get_concurrency_limit() const { return concurrency_limit_; }
220
221   /**
222    * @brief Reset the concurrency maximum for a given variable (we will update the maximum to reflect constraint
223    * evolution).
224    */
225   void reset_concurrency_maximum() { concurrency_maximum_ = 0; }
226
227   /** @brief Get the concurrency maximum for a given constraint (which reflects constraint evolution). */
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, size_t* numelem) const;
257
258   /**
259    * @brief Get the data associated to a constraint
260    * @return The data associated to the constraint
261    */
262   resource::Resource* 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_ = 0.0;
279   double usage_     = 0.0;
280   double bound_;
281   double dynamic_bound_ = 0.0; //!< dynamic bound for this constraint, defined by user's callback
282   // TODO MARTIN Check maximum value across resources at the end of simulation and give a warning is more than e.g. 500
283   int concurrency_current_ = 0; /* The current concurrency */
284   int concurrency_maximum_ = 0; /* The maximum number of (enabled and disabled) variables associated to the constraint
285                                  * at any given time (essentially for tracing)*/
286
287   SharingPolicy sharing_policy_ = SharingPolicy::SHARED;
288   int rank_; // Only used in debug messages to identify the constraint
289   double lambda_               = 0.0;
290   double new_lambda_           = 0.0;
291   ConstraintLight* cnst_light_ = nullptr;
292   s4u::NonLinearResourceCb dyn_constraint_cb_;
293
294 private:
295   static int next_rank_;  // To give a separate rank_ to each constraint
296   int concurrency_limit_ = sg_concurrency_limit; /* The maximum number of variables that may be enabled at any time
297                                                   * (stage variables if necessary) */
298   resource::Resource* id_;
299 };
300
301 /**
302  * @brief LMM variable
303  *
304  * When something prevents us from enabling a variable, we "stage" the weight that we would have like to set, so that as
305  * soon as possible we enable the variable with desired weight
306  */
307 class XBT_PUBLIC Variable {
308 public:
309   void initialize(resource::Action* id_value, double sharing_penalty, double bound_value, size_t number_of_constraints,
310                   unsigned visited_value);
311
312   /** @brief Get the value of the variable after the last lmm solve */
313   double get_value() const { return value_; }
314
315   /** @brief Get the maximum value of the variable (-1.0 if no specified maximum) */
316   double get_bound() const { return bound_; }
317
318   /**
319    * @brief Set the concurrent share of the variable
320    * @param value The new concurrency share
321    */
322   void set_concurrency_share(short int value) { concurrency_share_ = value; }
323
324   /**
325    * @brief Get the numth constraint associated to the variable
326    * @param num The rank of constraint we want to get
327    * @return The numth constraint
328    */
329   Constraint* get_constraint(unsigned num) const { return num < cnsts_.size() ? cnsts_[num].constraint : nullptr; }
330
331   /**
332    * @brief Get the weight of the numth constraint associated to the variable
333    * @param num The rank of constraint we want to get
334    * @return The numth constraint
335    */
336   double get_constraint_weight(unsigned num) const
337   {
338     return num < cnsts_.size() ? cnsts_[num].consumption_weight : 0.0;
339   }
340
341   /** @brief Get the number of constraint associated to a variable */
342   size_t get_number_of_constraint() const { return cnsts_.size(); }
343
344   /** @brief Get the data associated to a variable */
345   resource::Action* get_id() const { return id_; }
346
347   /** @brief Get the penalty of a variable */
348   double get_penalty() const { return sharing_penalty_; }
349
350   /** @brief Measure the minimum concurrency slack across all constraints where the given var is involved */
351   int get_min_concurrency_slack() const;
352
353   /** @brief Check if a variable can be enabled
354    * Make sure to set staged_penalty before, if your intent is only to check concurrency
355    */
356   bool can_enable() const { return staged_penalty_ > 0 && get_min_concurrency_slack() >= concurrency_share_; }
357
358   /* hookup to system */
359   boost::intrusive::list_member_hook<> variable_set_hook_;
360   boost::intrusive::list_member_hook<> saturated_variable_set_hook_;
361
362   std::vector<Element> cnsts_;
363
364   // sharing_penalty: variable's impact on the resource during the sharing
365   //   if == 0, the variable is not considered by LMM
366   //   on CPU, actions with N threads have a sharing of N
367   //   on network, the actions with higher latency have a lesser sharing_penalty
368   double sharing_penalty_;
369
370   double staged_penalty_; /* If non-zero, variable is staged for addition as soon as maxconcurrency constraints will be
371                             met */
372   double bound_;
373   double value_;
374   short int concurrency_share_; /* The maximum number of elements that variable will add to a constraint */
375   resource::Action* id_;
376   int rank_;         // Only used in debug messages to identify the variable
377   unsigned visited_; /* used by System::update_modified_set() */
378   double mu_;
379
380 private:
381   static int next_rank_; // To give a separate rank_ to each variable
382 };
383
384 inline void Element::make_active()
385 {
386   constraint->active_element_set_.push_front(*this);
387 }
388 inline void Element::make_inactive()
389 {
390   if (active_element_set_hook.is_linked())
391     xbt::intrusive_erase(constraint->active_element_set_, *this);
392 }
393
394 /**
395  * @brief LMM system
396  */
397 class XBT_PUBLIC System {
398 public:
399   /**
400    * @brief Creates a new System solver
401    *
402    * @param solver_name Name of the solver to be used
403    * @param selective_update Enables lazy updates
404    * @return pointer to System instance
405    */
406   static System* build(const std::string& solver_name, bool selective_update);
407   /** @brief Validates solver configuration */
408   static void validate_solver(const std::string& solver_name);
409
410   /**
411    * @brief Create a new Linear MaxMim system
412    * @param selective_update whether we should do lazy updates
413    */
414   explicit System(bool selective_update);
415   /** @brief Free an existing Linear MaxMin system */
416   virtual ~System();
417
418   /**
419    * @brief Create a new Linear MaxMin constraint
420    * @param id Data associated to the constraint (e.g.: a network link)
421    * @param bound_value The bound value of the constraint
422    */
423   Constraint* constraint_new(resource::Resource* id, double bound_value);
424
425   /**
426    * @brief Create a new Linear MaxMin variable
427    * @param id Data associated to the variable (e.g.: a network communication)
428    * @param sharing_penalty The weight of the variable (0.0 if not used)
429    * @param bound The maximum value of the variable (-1.0 if no maximum value)
430    * @param number_of_constraints The maximum number of constraints to associate to the variable
431    */
432   Variable* variable_new(resource::Action* id, double sharing_penalty, double bound = -1.0,
433                          size_t number_of_constraints = 1);
434
435   /**
436    * @brief Free a variable
437    * @param var The variable to free
438    */
439   void variable_free(Variable * var);
440
441   /** @brief Free all variables */
442   void variable_free_all();
443
444   /**
445    * @brief Associate a variable to a constraint with a coefficient
446    * @param cnst A constraint
447    * @param var A variable
448    * @param value The coefficient associated to the variable in the constraint
449    */
450   void expand(Constraint * cnst, Variable * var, double value);
451
452   /**
453    * @brief Add value to the coefficient between a constraint and a variable or create one
454    * @param cnst A constraint
455    * @param var A variable
456    * @param value The value to add to the coefficient associated to the variable in the constraint
457    */
458   void expand_add(Constraint * cnst, Variable * var, double value);
459
460   /** @brief Update the bound of a variable */
461   void update_variable_bound(Variable * var, double bound);
462
463   /** @brief Update the sharing penalty of a variable */
464   void update_variable_penalty(Variable* var, double penalty);
465
466   /** @brief Update a constraint bound */
467   void update_constraint_bound(Constraint * cnst, double bound);
468
469   int constraint_used(const Constraint* cnst) const { return cnst->active_constraint_set_hook_.is_linked(); }
470
471   /** @brief Print the lmm system */
472   void print() const;
473
474   /** @brief Solve the lmm system */
475   void lmm_solve();
476
477   /** @brief Solve the lmm system. May be specialized in subclasses. */
478   virtual void solve() { lmm_solve(); }
479
480 private:
481   static void* variable_mallocator_new_f();
482   static void variable_mallocator_free_f(void* var);
483
484   void var_free(Variable * var);
485   void cnst_free(Constraint * cnst);
486   Variable* extract_variable()
487   {
488     if (variable_set.empty())
489       return nullptr;
490     Variable* res = &variable_set.front();
491     variable_set.pop_front();
492     return res;
493   }
494   Constraint* extract_constraint()
495   {
496     if (constraint_set.empty())
497       return nullptr;
498     Constraint* res = &constraint_set.front();
499     constraint_set.pop_front();
500     return res;
501   }
502   void insert_constraint(Constraint * cnst) { constraint_set.push_back(*cnst); }
503   void remove_variable(Variable * var)
504   {
505     if (var->variable_set_hook_.is_linked())
506       xbt::intrusive_erase(variable_set, *var);
507     if (var->saturated_variable_set_hook_.is_linked())
508       xbt::intrusive_erase(saturated_variable_set, *var);
509   }
510   void make_constraint_active(Constraint * cnst)
511   {
512     if (not cnst->active_constraint_set_hook_.is_linked())
513       active_constraint_set.push_back(*cnst);
514   }
515   void make_constraint_inactive(Constraint * cnst)
516   {
517     if (cnst->active_constraint_set_hook_.is_linked())
518       xbt::intrusive_erase(active_constraint_set, *cnst);
519     if (cnst->modified_constraint_set_hook_.is_linked())
520       xbt::intrusive_erase(modified_constraint_set, *cnst);
521   }
522
523   void enable_var(Variable * var);
524   void disable_var(Variable * var);
525   void on_disabled_var(Constraint * cnstr);
526
527   /**
528    * @brief Update the value of element linking the constraint and the variable
529    * @param cnst A constraint
530    * @param var A variable
531    * @param value The new value
532    */
533   void update(Constraint * cnst, Variable * var, double value);
534
535   void update_modified_set(Constraint* cnst);
536   void update_modified_set_rec(const Constraint* cnst);
537
538   /** @brief Remove all constraints of the modified_constraint_set. */
539   void remove_all_modified_set();
540   void check_concurrency() const;
541
542   template <class CnstList> void lmm_solve(CnstList& cnst_list);
543
544 public:
545   bool modified_ = false;
546   boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
547                                                                  &Variable::variable_set_hook_>>
548       variable_set;
549   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
550                                                                    &Constraint::active_constraint_set_hook_>>
551       active_constraint_set;
552   boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
553                                                                  &Variable::saturated_variable_set_hook_>>
554       saturated_variable_set;
555   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
556                                                                    &Constraint::saturated_constraint_set_hook_>>
557       saturated_constraint_set;
558
559   std::unique_ptr<resource::Action::ModifiedSet> modified_set_ = nullptr;
560
561 protected:
562   bool selective_update_active; /* flag to update partially the system only selecting changed portions */
563   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
564                                                                    &Constraint::modified_constraint_set_hook_>>
565       modified_constraint_set;
566
567 private:
568   using dyn_light_t = std::vector<int>;
569
570   //Data used in lmm::solve
571   std::vector<ConstraintLight> cnst_light_vec;
572   dyn_light_t saturated_constraints;
573
574   unsigned visited_counter_ = 1; /* used by System::update_modified_set() and System::remove_all_modified_set() to
575                                   * cleverly (un-)flag the constraints (more details in these functions) */
576   boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
577                                                                    &Constraint::constraint_set_hook_>>
578       constraint_set;
579   xbt_mallocator_t variable_mallocator_ =
580       xbt_mallocator_new(65536, System::variable_mallocator_new_f, System::variable_mallocator_free_f, nullptr);
581 };
582
583 class XBT_PUBLIC FairBottleneck : public System {
584 public:
585   using System::System;
586   void solve() final { bottleneck_solve(); }
587
588 private:
589   void bottleneck_solve();
590 };
591
592 /** @} */
593 } // namespace lmm
594 } // namespace kernel
595 } // namespace simgrid
596
597 #endif