Logo AND Algorithmique Numérique Distribuée

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