1 /* Copyright (c) 2004-2022. 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 SIMGRID_KERNEL_LMM_SYSTEM_HPP
7 #define SIMGRID_KERNEL_LMM_SYSTEM_HPP
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"
15 #include "xbt/mallocator.h"
17 #include <boost/intrusive/list.hpp>
23 namespace simgrid::kernel::lmm {
25 /** @addtogroup SURF_lmm
27 * A linear maxmin solver to resolve inequations systems.
29 * Most SimGrid model rely on a "fluid/steady-state" modeling that simulate the sharing of resources between actions at
30 * relatively coarse-grain. Such sharing is generally done by solving a set of linear inequations. Let's take an
31 * 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$
32 * 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
33 * case, we need to enforce:
35 * \f[ x_1 + x_2 \leq C_A \f]
37 * 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
38 * 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 * \f[ x_3 \leq C_{L_1} \f]
41 * \f[ x_3 + x_4 \leq C_{L_2} \f]
42 * \f[ x_4 \leq C_{L_3} \f]
44 * One could set every variable to 0 to make sure the constraints are satisfied but this would obviously not be very
45 * realistic. A possible objective is to try to maximize the minimum of the \f$x_i\f$ . This ensures that all the
46 * \f$x_i\f$ are positive and "as large as possible".
48 * This is called *max-min fairness* and is the most commonly used objective in SimGrid. Another possibility is to
49 * maximize \f$\sum_if(x_i)\f$, where \f$f\f$ is a strictly increasing concave function.
64 * A possible system could be:
65 * - three variables: `var1`, `var2`, `var3`
66 * - two constraints: `cons1`, `cons2`
67 * - four elements linking:
68 * - `elem1` linking `var1` and `cons1`
69 * - `elem2` linking `var2` and `cons1`
70 * - `elem3` linking `var2` and `cons2`
71 * - `elem4` linking `var3` and `cons2`
73 * And the corresponding inequations will be:
75 * var1.value <= var1.bound
76 * var2.value <= var2.bound
77 * var3.value <= var3.bound
78 * var1.weight * var1.value * elem1.value + var2.weight * var2.value * elem2.value <= cons1.bound
79 * var2.weight * var2.value * elem3.value + var3.weight * var3.value * elem4.value <= cons2.bound
81 * where `var1.value`, `var2.value` and `var3.value` are the unknown values.
83 * If a constraint is not shared, the sum is replaced by a max.
84 * For example, a third non-shared constraint `cons3` and the associated elements `elem5` and `elem6` could write as:
86 * max( var1.weight * var1.value * elem5.value , var3.weight * var3.value * elem6.value ) <= cons3.bound
88 * This is useful for the sharing of resources for various models.
89 * For instance, for the network model, each link is associated to a constraint and each communication to a variable.
91 * Implementation details
93 * For implementation reasons, we are interested in distinguishing variables that actually participate to the
94 * computation of constraints, and those who are part of the equations but are stuck to zero.
95 * We call enabled variables, those which var.weight is strictly positive. Zero-weight variables are called disabled
97 * Unfortunately this concept of enabled/disabled variables intersects with active/inactive variable.
98 * Semantically, the intent is similar, but the conditions under which a variable is active is slightly more strict
99 * than the conditions for it to be enabled.
100 * A variable is active only if its var.value is non-zero (and, by construction, its var.weight is non-zero).
101 * In general, variables remain disabled after their creation, which often models an initialization phase (e.g. first
102 * packet propagating in the network). Then, it is enabled by the corresponding model. Afterwards, the max-min solver
103 * (lmm_solve()) activates it when appropriate. It is possible that the variable is again disabled, e.g. to model the
104 * pausing of an action.
106 * Concurrency limit and maximum
108 * We call concurrency, the number of variables that can be enabled at any time for each constraint.
109 * From a model perspective, this "concurrency" often represents the number of actions that actually compete for one
111 * The LMM solver is able to limit the concurrency for each constraint, and to monitor its maximum value.
113 * One may want to limit the concurrency of constraints for essentially three reasons:
114 * - Keep LMM system in a size that can be solved (it does not react very well with tens of thousands of variables per
116 * - Stay within parameters where the fluid model is accurate enough.
117 * - Model serialization effects
119 * The concurrency limit can also be set to a negative value to disable concurrency limit. This can improve performance
122 * Overall, each constraint contains three fields related to concurrency:
123 * - concurrency_limit which is the limit enforced by the solver
124 * - concurrency_current which is the current concurrency
125 * - concurrency_maximum which is the observed maximum concurrency
127 * Variables consumes the concurrency_limit of each constraint they are using.
128 * Each pair variable/constrainst is linked by a *single* Element object. Through this
129 * object and the respective methods (get_concurrency(), increase_concurrency() and decrease_concurrency()),
130 * the variable changes the constraint's concurrency.
131 * The amount of concurrency slack taken by each variable is determined by the Element::get_concurrency() method.
132 * At the current state, each variable counts as 1 if its consumption weight is greater than 1.
135 /** @{ @ingroup SURF_lmm */
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.
144 class XBT_PUBLIC Element {
146 // Use rule-of-three, and implicitely disable the move constructor which should be 'noexcept' according to C++ Core
148 Element(Constraint* constraint, Variable* variable, double cweight);
149 Element(const Element&) = default;
150 ~Element() = default;
153 * @brief Gets the "weight" of this element for concurrency checks.
155 * This is the amount taken by this variable of the constraint's concurrency slack
157 * @return 1 if consumption_weight greater than 1, 0 otherwise
159 int get_concurrency() const;
161 * @brief Decreases the constraint's concurrency
163 * Decreases the equivalent of get_concurrency() from the constraint related to this element
165 void decrease_concurrency();
167 * @brief Increase constraint concurrency
168 * @param check_limit Don't check constraint concurrency overflow right now
170 void increase_concurrency(bool check_limit = true);
173 void make_inactive();
175 /* hookup to constraint */
176 boost::intrusive::list_member_hook<> enabled_element_set_hook;
177 boost::intrusive::list_member_hook<> disabled_element_set_hook;
178 boost::intrusive::list_member_hook<> active_element_set_hook;
180 Constraint* constraint;
183 // consumption_weight: impact of 1 byte or flop of your application onto the resource (in byte or flop)
184 // - if CPU, then probably 1.
185 // - If network, then 1 in forward direction and 0.05 backward for the ACKs
186 double consumption_weight;
187 // maximum consumption weight (can be different from consumption_weight with subflows/ptasks)
188 double max_consumption_weight;
191 class ConstraintLight {
193 double remaining_over_usage;
198 * @brief LMM constraint
199 * Each constraint contains several partially overlapping logical sets of elements:
200 * \li Disabled elements which variable's weight is zero. This variables are not at all processed by LMM, but eventually
201 * the corresponding action will enable it (at least this is the idea).
202 * \li Enabled elements which variable's weight is non-zero. They are utilized in some LMM functions.
203 * \li Active elements which variable's weight is non-zero (i.e. it is enabled) AND its element value is non-zero.
204 * LMM_solve iterates over active elements during resolution, dynamically making them active or inactive.
206 class XBT_PUBLIC Constraint {
208 enum class SharingPolicy { NONLINEAR = 2, SHARED = 1, FATPIPE = 0 };
210 Constraint(resource::Resource* id_value, double bound_value);
212 /** @brief Unshare a constraint. */
213 void unshare() { sharing_policy_ = SharingPolicy::FATPIPE; }
215 /** @brief Set how a constraint is shared */
216 void set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
217 /** @brief Check how a constraint is shared */
218 SharingPolicy get_sharing_policy() const { return sharing_policy_; }
220 /** @brief Get the usage of the constraint after the last lmm solve */
221 double get_usage() const;
223 /** @brief Sets the concurrency limit for this constraint */
224 void set_concurrency_limit(int limit)
226 xbt_assert(limit < 0 || concurrency_maximum_ <= limit,
227 "New concurrency limit should be larger than observed concurrency maximum. Maybe you want to call"
228 " concurrency_maximum_reset() to reset the maximum?");
229 concurrency_limit_ = limit;
232 /** @brief Gets the concurrency limit for this constraint */
233 int get_concurrency_limit() const { return concurrency_limit_; }
236 * @brief Reset the concurrency maximum for a given variable (we will update the maximum to reflect constraint
239 void reset_concurrency_maximum() { concurrency_maximum_ = 0; }
241 /** @brief Get the concurrency maximum for a given constraint (which reflects constraint evolution). */
242 int get_concurrency_maximum() const
244 xbt_assert(concurrency_limit_ < 0 || concurrency_maximum_ <= concurrency_limit_,
245 "Very bad: maximum observed concurrency is higher than limit. This is a bug of SURF, please report it.");
246 return concurrency_maximum_;
250 * @brief Get constraint current concurrency slack
252 * This represents the "space" available for new variables in this contraint.
253 * A variable can be enabled and use this constraint if its get_concurrency() <= slack
255 * @return Constraint's slack
257 int get_concurrency_slack() const
259 return concurrency_limit_ < 0 ? std::numeric_limits<int>::max() : concurrency_limit_ - concurrency_current_;
263 * @brief Get a var associated to a constraint
264 * @details Get the first variable of the next variable of elem if elem is not NULL
265 * @param elem A element of constraint of the constraint or NULL
266 * @return A variable associated to a constraint
268 Variable* get_variable(const Element** elem) const;
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 * @param nextelem A element of constraint of the constraint or NULL, the one after elem
275 * @param numelem parameter representing the number of elements to go
276 * @return A variable associated to a constraint
278 Variable* get_variable_safe(const Element** elem, const Element** nextelem, size_t* numelem) const;
281 * @brief Get the data associated to a constraint
282 * @return The data associated to the constraint
284 resource::Resource* get_id() const { return id_; }
286 /* hookup to system */
287 boost::intrusive::list_member_hook<> constraint_set_hook_;
288 boost::intrusive::list_member_hook<> active_constraint_set_hook_;
289 boost::intrusive::list_member_hook<> modified_constraint_set_hook_;
290 boost::intrusive::list_member_hook<> saturated_constraint_set_hook_;
291 boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
292 &Element::enabled_element_set_hook>>
293 enabled_element_set_;
294 boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
295 &Element::disabled_element_set_hook>>
296 disabled_element_set_;
297 boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
298 &Element::active_element_set_hook>>
300 double remaining_ = 0.0;
303 double dynamic_bound_ = 0.0; //!< dynamic bound for this constraint, defined by user's callback
304 // TODO MARTIN Check maximum value across resources at the end of simulation and give a warning is more than e.g. 500
305 int concurrency_current_ = 0; /* The current concurrency */
306 int concurrency_maximum_ = 0; /* The maximum number of (enabled and disabled) variables associated to the constraint
307 * at any given time (essentially for tracing)*/
309 SharingPolicy sharing_policy_ = SharingPolicy::SHARED;
310 int rank_; // Only used in debug messages to identify the constraint
311 double lambda_ = 0.0;
312 double new_lambda_ = 0.0;
313 ConstraintLight* cnst_light_ = nullptr;
314 s4u::NonLinearResourceCb dyn_constraint_cb_;
317 static int next_rank_; // To give a separate rank_ to each constraint
318 int concurrency_limit_ = sg_concurrency_limit; /* The maximum number of variables that may be enabled at any time
319 * (stage variables if necessary) */
320 resource::Resource* id_;
324 * @brief LMM variable
326 * When something prevents us from enabling a variable, we "stage" the weight that we would have like to set, so that as
327 * soon as possible we enable the variable with desired weight
329 class XBT_PUBLIC Variable {
331 void initialize(resource::Action* id_value, double sharing_penalty, double bound_value, size_t number_of_constraints,
332 unsigned visited_value);
334 /** @brief Get the value of the variable after the last lmm solve */
335 double get_value() const { return value_; }
337 /** @brief Get the maximum value of the variable (-1.0 if no specified maximum) */
338 double get_bound() const { return bound_; }
341 * @brief Get the numth constraint associated to the variable
342 * @param num The rank of constraint we want to get
343 * @return The numth constraint
345 Constraint* get_constraint(unsigned num) const { return num < cnsts_.size() ? cnsts_[num].constraint : nullptr; }
348 * @brief Get the weight of the numth constraint associated to the variable
349 * @param num The rank of constraint we want to get
350 * @return The numth constraint
352 double get_constraint_weight(unsigned num) const
354 return num < cnsts_.size() ? cnsts_[num].consumption_weight : 0.0;
357 /** @brief Get the number of constraint associated to a variable */
358 size_t get_number_of_constraint() const { return cnsts_.size(); }
360 /** @brief Get the data associated to a variable */
361 resource::Action* get_id() const { return id_; }
363 /** @brief Get the penalty of a variable */
364 double get_penalty() const { return sharing_penalty_; }
366 /** @brief Measure the minimum concurrency slack across all constraints where the given var is involved */
367 int get_min_concurrency_slack() const;
369 /** @brief Check if a variable can be enabled
370 * Make sure to set staged_penalty before, if your intent is only to check concurrency
372 bool can_enable() const { return staged_sharing_penalty_ > 0 && get_min_concurrency_slack() > 0; }
374 /* hookup to system */
375 boost::intrusive::list_member_hook<> variable_set_hook_;
376 boost::intrusive::list_member_hook<> saturated_variable_set_hook_;
378 std::vector<Element> cnsts_;
380 // sharing_penalty: variable's impact on the resource during the sharing
381 // if == 0, the variable is not considered by LMM
382 // on CPU, actions with N threads have a sharing of N
383 // on network, the actions with higher latency have a lesser sharing_penalty
384 double sharing_penalty_;
386 double staged_sharing_penalty_; /* If non-zero, variable is staged for addition as soon as maxconcurrency constraints
390 resource::Action* id_;
391 int rank_; // Only used in debug messages to identify the variable
392 unsigned visited_; /* used by System::update_modified_cnst_set() */
396 static int next_rank_; // To give a separate rank_ to each variable
399 inline void Element::make_active()
401 constraint->active_element_set_.push_front(*this);
403 inline void Element::make_inactive()
405 if (active_element_set_hook.is_linked())
406 xbt::intrusive_erase(constraint->active_element_set_, *this);
412 class XBT_PUBLIC System {
415 * @brief Creates a new System solver
417 * @param solver_name Name of the solver to be used
418 * @param selective_update Enables lazy updates
419 * @return pointer to System instance
421 static System* build(const std::string& solver_name, bool selective_update);
422 /** @brief Validates solver configuration */
423 static void validate_solver(const std::string& solver_name);
426 * @brief Create a new Linear MaxMim system
427 * @param selective_update whether we should do lazy updates
429 explicit System(bool selective_update);
430 /** @brief Free an existing Linear MaxMin system */
434 * @brief Create a new Linear MaxMin constraint
435 * @param id Data associated to the constraint (e.g.: a network link)
436 * @param bound_value The bound value of the constraint
438 Constraint* constraint_new(resource::Resource* id, double bound_value);
441 * @brief Create a new Linear MaxMin variable
442 * @param id Data associated to the variable (e.g.: a network communication)
443 * @param sharing_penalty The weight of the variable (0.0 if not used)
444 * @param bound The maximum value of the variable (-1.0 if no maximum value)
445 * @param number_of_constraints The maximum number of constraints to associate to the variable
447 Variable* variable_new(resource::Action* id, double sharing_penalty, double bound = -1.0,
448 size_t number_of_constraints = 1);
450 /** @brief Get the list of modified actions since last solve() */
451 resource::Action::ModifiedSet* get_modified_action_set() const;
454 * @brief Free a variable
455 * @param var The variable to free
457 void variable_free(Variable * var);
459 /** @brief Free all variables */
460 void variable_free_all();
463 * @brief Associate a variable to a constraint with a coefficient
464 * @param cnst A constraint
465 * @param var A variable
466 * @param value The coefficient associated to the variable in the constraint
467 * @param force_creation Force the creation of new element linking the variable to the constraint. Should be used only
468 * by the model ptask_L07 to cope with ptasks composed of flows running on the same resource (see
469 * https://framagit.org/simgrid/simgrid/-/issues/111)
471 void expand(Constraint* cnst, Variable* var, double value, bool force_creation = false);
473 /** @brief Update the bound of a variable */
474 void update_variable_bound(Variable * var, double bound);
476 /** @brief Update the sharing penalty of a variable */
477 void update_variable_penalty(Variable* var, double penalty);
479 /** @brief Update a constraint bound */
480 void update_constraint_bound(Constraint * cnst, double bound);
482 int constraint_used(const Constraint* cnst) const { return cnst->active_constraint_set_hook_.is_linked(); }
484 /** @brief Print the lmm system */
487 /** @brief Solve the lmm system. May be specialized in subclasses. */
491 static void* variable_mallocator_new_f();
492 static void variable_mallocator_free_f(void* var);
493 /** @brief Implements the solver. Must be specialized in subclasses. */
494 virtual void do_solve() = 0;
496 void var_free(Variable * var);
497 void cnst_free(Constraint * cnst);
498 Variable* extract_variable()
500 if (variable_set.empty())
502 Variable* res = &variable_set.front();
503 variable_set.pop_front();
506 Constraint* extract_constraint()
508 if (constraint_set.empty())
510 Constraint* res = &constraint_set.front();
511 constraint_set.pop_front();
514 void insert_constraint(Constraint * cnst) { constraint_set.push_back(*cnst); }
515 void remove_variable(Variable * var)
517 if (var->variable_set_hook_.is_linked())
518 xbt::intrusive_erase(variable_set, *var);
519 if (var->saturated_variable_set_hook_.is_linked())
520 xbt::intrusive_erase(saturated_variable_set, *var);
522 void make_constraint_active(Constraint * cnst)
524 if (not cnst->active_constraint_set_hook_.is_linked())
525 active_constraint_set.push_back(*cnst);
527 void make_constraint_inactive(Constraint * cnst)
529 if (cnst->active_constraint_set_hook_.is_linked())
530 xbt::intrusive_erase(active_constraint_set, *cnst);
531 if (cnst->modified_constraint_set_hook_.is_linked())
532 xbt::intrusive_erase(modified_constraint_set, *cnst);
535 void enable_var(Variable * var);
536 void disable_var(Variable * var);
537 void on_disabled_var(Constraint * cnstr);
538 void check_concurrency() const;
541 * @brief Auxiliary method to create a new Element which links a variable to a constraint
543 * @param cnst Constraint (resource)
544 * @param var Variable (action)
545 * @param consumption_weight how much of the resource is used for each unit of the action
546 * @return A reference to the new element
548 Element& expand_create_elem(Constraint* cnst, Variable* var, double consumption_weight);
550 * @brief Increments the element usage
552 * @param elem Element linking variable/action to resource
553 * @param cnst Constraint (resource)
554 * @param consumption_weight how much of the resource is used for each unit of the action
555 * @return elem itself
557 Element& expand_add_to_elem(Element& elem, const Constraint* cnst, double consumption_weight) const;
560 * @brief Update the value of element linking the constraint and the variable
561 * @param cnst A constraint
562 * @param var A variable
563 * @param value The new value
565 void update(Constraint * cnst, Variable * var, double value);
567 /** @brief Given a variable, update modified_constraint_set_ */
568 void update_modified_cnst_set_from_variable(const Variable* var);
569 void update_modified_cnst_set(Constraint* cnst);
570 void update_modified_cnst_set_rec(const Constraint* cnst);
571 /** @brief Remove all constraints of the modified_constraint_set. */
572 void remove_all_modified_cnst_set();
575 bool modified_ = false;
576 boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
577 &Variable::variable_set_hook_>>
579 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
580 &Constraint::active_constraint_set_hook_>>
581 active_constraint_set;
582 boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
583 &Variable::saturated_variable_set_hook_>>
584 saturated_variable_set;
585 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
586 &Constraint::saturated_constraint_set_hook_>>
587 saturated_constraint_set;
590 const bool selective_update_active; /* flag to update partially the system only selecting changed portions */
591 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
592 &Constraint::modified_constraint_set_hook_>>
593 modified_constraint_set;
596 unsigned visited_counter_ =
597 1; /* used by System::update_modified_cnst_set() and System::remove_all_modified_cnst_set() to
598 * cleverly (un-)flag the constraints (more details in these functions) */
599 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
600 &Constraint::constraint_set_hook_>>
602 xbt_mallocator_t variable_mallocator_ =
603 xbt_mallocator_new(65536, System::variable_mallocator_new_f, System::variable_mallocator_free_f, nullptr);
605 std::unique_ptr<resource::Action::ModifiedSet> modified_set_ = nullptr;
609 } // namespace simgrid::kernel::lmm