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 SURF_MAXMIN_HPP
7 #define SURF_MAXMIN_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>
27 /** @addtogroup SURF_lmm
29 * A linear maxmin solver to resolve inequations systems.
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:
37 * \f[ x_1 + x_2 \leq C_A \f]
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:
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]
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".
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.
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`
75 * And the corresponding inequations will be:
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
83 * where `var1.value`, `var2.value` and `var3.value` are the unknown values.
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:
88 * max( var1.weight * var1.value * elem5.value , var3.weight * var3.value * elem6.value ) <= cons3.bound
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.
93 * Implementation details
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
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.
108 * Concurrency limit and maximum
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
113 * The LMM solver is able to limit the concurrency for each constraint, and to monitor its maximum value.
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
118 * - Stay within parameters where the fluid model is accurate enough.
119 * - Model serialization effects
121 * The concurrency limit can also be set to a negative value to disable concurrency limit. This can improve performance
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
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
136 /** @{ @ingroup SURF_lmm */
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.
145 class XBT_PUBLIC Element {
147 // Use rule-of-three, and implicitely disable the move constructor which should be 'noexcept' according to C++ Core
150 Element(const Element&) = default;
151 ~Element() = default;
153 int get_concurrency() const;
154 void decrease_concurrency();
155 void increase_concurrency();
158 void make_inactive();
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;
165 Constraint* constraint;
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;
174 class ConstraintLight {
176 double remaining_over_usage;
181 * @brief LMM constraint
182 * Each constraint contains several partially overlapping logical sets of elements:
183 * \li Disabled elements which variable's weight is zero. This variables are not at all processed by LMM, but eventually
184 * the corresponding action will enable it (at least this is the idea).
185 * \li Enabled elements which variable's weight is non-zero. They are utilized in some LMM functions.
186 * \li Active elements which variable's weight is non-zero (i.e. it is enabled) AND its element value is non-zero.
187 * LMM_solve iterates over active elements during resolution, dynamically making them active or inactive.
189 class XBT_PUBLIC Constraint {
191 enum class SharingPolicy { NONLINEAR = 2, SHARED = 1, FATPIPE = 0 };
193 Constraint() = delete;
194 Constraint(resource::Resource* id_value, double bound_value);
196 /** @brief Unshare a constraint. */
197 void unshare() { sharing_policy_ = SharingPolicy::FATPIPE; }
199 /** @brief Set how a constraint is shared */
200 void set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
201 /** @brief Check how a constraint is shared */
202 SharingPolicy get_sharing_policy() const { return sharing_policy_; }
204 /** @brief Get the usage of the constraint after the last lmm solve */
205 double get_usage() const;
206 int get_variable_amount() const;
208 /** @brief Sets the concurrency limit for this constraint */
209 void set_concurrency_limit(int limit)
211 xbt_assert(limit < 0 || concurrency_maximum_ <= limit,
212 "New concurrency limit should be larger than observed concurrency maximum. Maybe you want to call"
213 " concurrency_maximum_reset() to reset the maximum?");
214 concurrency_limit_ = limit;
217 /** @brief Gets the concurrency limit for this constraint */
218 int get_concurrency_limit() const { return concurrency_limit_; }
221 * @brief Reset the concurrency maximum for a given variable (we will update the maximum to reflect constraint
224 void reset_concurrency_maximum() { concurrency_maximum_ = 0; }
226 /** @brief Get the concurrency maximum for a given constraint (which reflects constraint evolution). */
227 int get_concurrency_maximum() const
229 xbt_assert(concurrency_limit_ < 0 || concurrency_maximum_ <= concurrency_limit_,
230 "Very bad: maximum observed concurrency is higher than limit. This is a bug of SURF, please report it.");
231 return concurrency_maximum_;
234 int get_concurrency_slack() const
236 return concurrency_limit_ < 0 ? std::numeric_limits<int>::max() : concurrency_limit_ - concurrency_current_;
240 * @brief Get a var associated to a constraint
241 * @details Get the first variable of the next variable of elem if elem is not NULL
242 * @param elem A element of constraint of the constraint or NULL
243 * @return A variable associated to a constraint
245 Variable* get_variable(const Element** elem) const;
248 * @brief Get a var associated to a constraint
249 * @details Get the first variable of the next variable of elem if elem is not NULL
250 * @param elem A element of constraint of the constraint or NULL
251 * @param nextelem A element of constraint of the constraint or NULL, the one after elem
252 * @param numelem parameter representing the number of elements to go
253 * @return A variable associated to a constraint
255 Variable* get_variable_safe(const Element** elem, const Element** nextelem, size_t* numelem) const;
258 * @brief Get the data associated to a constraint
259 * @return The data associated to the constraint
261 resource::Resource* get_id() const { return id_; }
263 /* hookup to system */
264 boost::intrusive::list_member_hook<> constraint_set_hook_;
265 boost::intrusive::list_member_hook<> active_constraint_set_hook_;
266 boost::intrusive::list_member_hook<> modified_constraint_set_hook_;
267 boost::intrusive::list_member_hook<> saturated_constraint_set_hook_;
268 boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
269 &Element::enabled_element_set_hook>>
270 enabled_element_set_;
271 boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
272 &Element::disabled_element_set_hook>>
273 disabled_element_set_;
274 boost::intrusive::list<Element, boost::intrusive::member_hook<Element, boost::intrusive::list_member_hook<>,
275 &Element::active_element_set_hook>>
277 double remaining_ = 0.0;
280 double dynamic_bound_ = 0.0; //!< dynamic bound for this constraint, defined by user's callback
281 // TODO MARTIN Check maximum value across resources at the end of simulation and give a warning is more than e.g. 500
282 int concurrency_current_ = 0; /* The current concurrency */
283 int concurrency_maximum_ = 0; /* The maximum number of (enabled and disabled) variables associated to the constraint
284 * at any given time (essentially for tracing)*/
286 SharingPolicy sharing_policy_ = SharingPolicy::SHARED;
287 int rank_; // Only used in debug messages to identify the constraint
288 double lambda_ = 0.0;
289 double new_lambda_ = 0.0;
290 ConstraintLight* cnst_light_ = nullptr;
291 s4u::NonLinearResourceCb dyn_constraint_cb_;
294 static int next_rank_; // To give a separate rank_ to each constraint
295 int concurrency_limit_ = sg_concurrency_limit; /* The maximum number of variables that may be enabled at any time
296 * (stage variables if necessary) */
297 resource::Resource* id_;
301 * @brief LMM variable
303 * When something prevents us from enabling a variable, we "stage" the weight that we would have like to set, so that as
304 * soon as possible we enable the variable with desired weight
306 class XBT_PUBLIC Variable {
308 void initialize(resource::Action* id_value, double sharing_penalty, double bound_value, size_t number_of_constraints,
309 unsigned visited_value);
311 /** @brief Get the value of the variable after the last lmm solve */
312 double get_value() const { return value_; }
314 /** @brief Get the maximum value of the variable (-1.0 if no specified maximum) */
315 double get_bound() const { return bound_; }
318 * @brief Set the concurrent share of the variable
319 * @param value The new concurrency share
321 void set_concurrency_share(short int value) { concurrency_share_ = value; }
324 * @brief Get the numth constraint associated to the variable
325 * @param num The rank of constraint we want to get
326 * @return The numth constraint
328 Constraint* get_constraint(unsigned num) const { return num < cnsts_.size() ? cnsts_[num].constraint : nullptr; }
331 * @brief Get the weight of the numth constraint associated to the variable
332 * @param num The rank of constraint we want to get
333 * @return The numth constraint
335 double get_constraint_weight(unsigned num) const
337 return num < cnsts_.size() ? cnsts_[num].consumption_weight : 0.0;
340 /** @brief Get the number of constraint associated to a variable */
341 size_t get_number_of_constraint() const { return cnsts_.size(); }
343 /** @brief Get the data associated to a variable */
344 resource::Action* get_id() const { return id_; }
346 /** @brief Get the penalty of a variable */
347 double get_penalty() const { return sharing_penalty_; }
349 /** @brief Measure the minimum concurrency slack across all constraints where the given var is involved */
350 int get_min_concurrency_slack() const;
352 /** @brief Check if a variable can be enabled
353 * Make sure to set staged_penalty before, if your intent is only to check concurrency
355 bool can_enable() const { return staged_penalty_ > 0 && get_min_concurrency_slack() >= concurrency_share_; }
357 /* hookup to system */
358 boost::intrusive::list_member_hook<> variable_set_hook_;
359 boost::intrusive::list_member_hook<> saturated_variable_set_hook_;
361 std::vector<Element> cnsts_;
363 // sharing_penalty: variable's impact on the resource during the sharing
364 // if == 0, the variable is not considered by LMM
365 // on CPU, actions with N threads have a sharing of N
366 // on network, the actions with higher latency have a lesser sharing_penalty
367 double sharing_penalty_;
369 double staged_penalty_; /* If non-zero, variable is staged for addition as soon as maxconcurrency constraints will be
373 short int concurrency_share_; /* The maximum number of elements that variable will add to a constraint */
374 resource::Action* id_;
375 int rank_; // Only used in debug messages to identify the variable
376 unsigned visited_; /* used by System::update_modified_set() */
380 static int next_rank_; // To give a separate rank_ to each variable
383 inline void Element::make_active()
385 constraint->active_element_set_.push_front(*this);
387 inline void Element::make_inactive()
389 if (active_element_set_hook.is_linked())
390 xbt::intrusive_erase(constraint->active_element_set_, *this);
396 class XBT_PUBLIC System {
399 * @brief Create a new Linear MaxMim system
400 * @param selective_update whether we should do lazy updates
402 explicit System(bool selective_update);
403 /** @brief Free an existing Linear MaxMin system */
407 * @brief Create a new Linear MaxMin constraint
408 * @param id Data associated to the constraint (e.g.: a network link)
409 * @param bound_value The bound value of the constraint
411 Constraint* constraint_new(resource::Resource* id, double bound_value);
414 * @brief Create a new Linear MaxMin variable
415 * @param id Data associated to the variable (e.g.: a network communication)
416 * @param sharing_penalty The weight of the variable (0.0 if not used)
417 * @param bound The maximum value of the variable (-1.0 if no maximum value)
418 * @param number_of_constraints The maximum number of constraints to associate to the variable
420 Variable* variable_new(resource::Action* id, double sharing_penalty, double bound = -1.0,
421 size_t number_of_constraints = 1);
424 * @brief Free a variable
425 * @param var The variable to free
427 void variable_free(Variable * var);
429 /** @brief Free all variables */
430 void variable_free_all();
433 * @brief Associate a variable to a constraint with a coefficient
434 * @param cnst A constraint
435 * @param var A variable
436 * @param value The coefficient associated to the variable in the constraint
438 void expand(Constraint * cnst, Variable * var, double value);
441 * @brief Add value to the coefficient between a constraint and a variable or create one
442 * @param cnst A constraint
443 * @param var A variable
444 * @param value The value to add to the coefficient associated to the variable in the constraint
446 void expand_add(Constraint * cnst, Variable * var, double value);
448 /** @brief Update the bound of a variable */
449 void update_variable_bound(Variable * var, double bound);
451 /** @brief Update the sharing penalty of a variable */
452 void update_variable_penalty(Variable* var, double penalty);
454 /** @brief Update a constraint bound */
455 void update_constraint_bound(Constraint * cnst, double bound);
457 int constraint_used(const Constraint* cnst) const { return cnst->active_constraint_set_hook_.is_linked(); }
459 /** @brief Print the lmm system */
462 /** @brief Solve the lmm system */
465 /** @brief Solve the lmm system. May be specialized in subclasses. */
466 virtual void solve() { lmm_solve(); }
469 static void* variable_mallocator_new_f();
470 static void variable_mallocator_free_f(void* var);
472 void var_free(Variable * var);
473 void cnst_free(Constraint * cnst);
474 Variable* extract_variable()
476 if (variable_set.empty())
478 Variable* res = &variable_set.front();
479 variable_set.pop_front();
482 Constraint* extract_constraint()
484 if (constraint_set.empty())
486 Constraint* res = &constraint_set.front();
487 constraint_set.pop_front();
490 void insert_constraint(Constraint * cnst) { constraint_set.push_back(*cnst); }
491 void remove_variable(Variable * var)
493 if (var->variable_set_hook_.is_linked())
494 xbt::intrusive_erase(variable_set, *var);
495 if (var->saturated_variable_set_hook_.is_linked())
496 xbt::intrusive_erase(saturated_variable_set, *var);
498 void make_constraint_active(Constraint * cnst)
500 if (not cnst->active_constraint_set_hook_.is_linked())
501 active_constraint_set.push_back(*cnst);
503 void make_constraint_inactive(Constraint * cnst)
505 if (cnst->active_constraint_set_hook_.is_linked())
506 xbt::intrusive_erase(active_constraint_set, *cnst);
507 if (cnst->modified_constraint_set_hook_.is_linked())
508 xbt::intrusive_erase(modified_constraint_set, *cnst);
511 void enable_var(Variable * var);
512 void disable_var(Variable * var);
513 void on_disabled_var(Constraint * cnstr);
516 * @brief Update the value of element linking the constraint and the variable
517 * @param cnst A constraint
518 * @param var A variable
519 * @param value The new value
521 void update(Constraint * cnst, Variable * var, double value);
523 void update_modified_set(Constraint* cnst);
524 void update_modified_set_rec(const Constraint* cnst);
526 /** @brief Remove all constraints of the modified_constraint_set. */
527 void remove_all_modified_set();
528 void check_concurrency() const;
530 template <class CnstList> void lmm_solve(CnstList& cnst_list);
533 bool modified_ = false;
534 boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
535 &Variable::variable_set_hook_>>
537 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
538 &Constraint::active_constraint_set_hook_>>
539 active_constraint_set;
540 boost::intrusive::list<Variable, boost::intrusive::member_hook<Variable, boost::intrusive::list_member_hook<>,
541 &Variable::saturated_variable_set_hook_>>
542 saturated_variable_set;
543 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
544 &Constraint::saturated_constraint_set_hook_>>
545 saturated_constraint_set;
547 std::unique_ptr<resource::Action::ModifiedSet> modified_set_ = nullptr;
550 using dyn_light_t = std::vector<int>;
552 //Data used in lmm::solve
553 std::vector<ConstraintLight> cnst_light_vec;
554 dyn_light_t saturated_constraints;
556 bool selective_update_active; /* flag to update partially the system only selecting changed portions */
557 unsigned visited_counter_ = 1; /* used by System::update_modified_set() and System::remove_all_modified_set() to
558 * cleverly (un-)flag the constraints (more details in these functions) */
559 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
560 &Constraint::constraint_set_hook_>>
562 boost::intrusive::list<Constraint, boost::intrusive::member_hook<Constraint, boost::intrusive::list_member_hook<>,
563 &Constraint::modified_constraint_set_hook_>>
564 modified_constraint_set;
565 xbt_mallocator_t variable_mallocator_ =
566 xbt_mallocator_new(65536, System::variable_mallocator_new_f, System::variable_mallocator_free_f, nullptr);
569 class XBT_PUBLIC FairBottleneck : public System {
571 using System::System;
572 void solve() final { bottleneck_solve(); }
575 void bottleneck_solve();
580 } // namespace kernel
581 } // namespace simgrid