Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Extern "C" is not needed anymore here.
[simgrid.git] / src / include / surf / maxmin.hpp
1 /* Copyright (c) 2004-2017. 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 "src/internal_config.h"
10 #include "surf/surf.hpp"
11 #include "xbt/asserts.h"
12 #include "xbt/misc.h"
13 #include <cmath>
14
15 /** @addtogroup SURF_lmm
16  * @details
17  * A linear maxmin solver to resolve inequations systems.
18  *
19  * Most SimGrid model rely on a "fluid/steady-state" modeling that simulate the sharing of resources between actions at
20  * relatively coarse-grain.  Such sharing is generally done by solving a set of linear inequations. Let's take an
21  * 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$
22  * 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
23  * case, we need to enforce:
24  *
25  *   \f[ x_1 + x_2 \leq C_A \f]
26  *
27  * 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
28  * 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:
29  *
30  *   \f[ x_3  \leq C_{L_1} \f]
31  *   \f[ x_3 + x_4 \leq C_{L_2} \f]
32  *   \f[ x_4 \leq C_{L_3} \f]
33  *
34  * One could set every variable to 0 to make sure the constraints are satisfied but this would obviously not be very
35  * realistic. A possible objective is to try to maximize the minimum of the \f$x_i\f$ . This ensures that all the
36  * \f$x_i\f$ are positive and "as large as possible".
37  *
38  * This is called *max-min fairness* and is the most commonly used objective in SimGrid. Another possibility is to
39  * maximize \f$\sum_if(x_i)\f$, where \f$f\f$ is a strictly increasing concave function.
40  *
41  * Constraint:
42  *  - bound (set)
43  *  - shared (set)
44  *  - usage (computed)
45  *
46  * Variable:
47  *  - weight (set)
48  *  - bound (set)
49  *  - value (computed)
50  *
51  * Element:
52  *  - value (set)
53  *
54  * A possible system could be:
55  * - three variables: `var1`, `var2`, `var3`
56  * - two constraints: `cons1`, `cons2`
57  * - four elements linking:
58  *  - `elem1` linking `var1` and `cons1`
59  *  - `elem2` linking `var2` and `cons1`
60  *  - `elem3` linking `var2` and `cons2`
61  *  - `elem4` linking `var3` and `cons2`
62  *
63  * And the corresponding inequations will be:
64  *
65  *     var1.value <= var1.bound
66  *     var2.value <= var2.bound
67  *     var3.value <= var3.bound
68  *     var1.weight * var1.value * elem1.value + var2.weight * var2.value * elem2.value <= cons1.bound
69  *     var2.weight * var2.value * elem3.value + var3.weight * var3.value * elem4.value <= cons2.bound
70  *
71  * where `var1.value`, `var2.value` and `var3.value` are the unknown values.
72  *
73  * If a constraint is not shared, the sum is replaced by a max.
74  * For example, a third non-shared constraint `cons3` and the associated elements `elem5` and `elem6` could write as:
75  *
76  *     max( var1.weight * var1.value * elem5.value  ,  var3.weight * var3.value * elem6.value ) <= cons3.bound
77  *
78  * This is usefull for the sharing of resources for various models.
79  * For instance, for the network model, each link is associated to a constraint and each communication to a variable.
80  *
81  * Implementation details
82  *
83  * For implementation reasons, we are interested in distinguishing variables that actually participate to the
84  * computation of constraints, and those who are part of the equations but are stuck to zero.
85  * We call enabled variables, those which var.weight is strictly positive. Zero-weight variables are called disabled
86  * variables.
87  * Unfortunately this concept of enabled/disabled variables intersects with active/inactive variable.
88  * Semantically, the intent is similar, but the conditions under which a variable is active is slightly more strict
89  * than the conditions for it to be enabled.
90  * A variable is active only if its var.value is non-zero (and, by construction, its var.weight is non-zero).
91  * In general, variables remain disabled after their creation, which often models an initialization phase (e.g. first
92  * packet propagating in the network). Then, it is enabled by the corresponding model. Afterwards, the max-min solver
93  * (lmm_solve()) activates it when appropriate. It is possible that the variable is again disabled, e.g. to model the
94  * pausing of an action.
95  *
96  * Concurrency limit and maximum
97  *
98  * We call concurrency, the number of variables that can be enabled at any time for each constraint.
99  * From a model perspective, this "concurrency" often represents the number of actions that actually compete for one
100  * constraint.
101  * The LMM solver is able to limit the concurrency for each constraint, and to monitor its maximum value.
102  *
103  * One may want to limit the concurrency of constraints for essentially three reasons:
104  *  - Keep LMM system in a size that can be solved (it does not react very well with tens of thousands of variables per
105  *    constraint)
106  *  - Stay within parameters where the fluid model is accurate enough.
107  *  - Model serialization effects
108  *
109  * The concurrency limit can also be set to a negative value to disable concurrency limit. This can improve performance
110  * slightly.
111  *
112  * Overall, each constraint contains three fields related to concurrency:
113  *  - concurrency_limit which is the limit enforced by the solver
114  *  - concurrency_current which is the current concurrency
115  *  - concurrency_maximum which is the observed maximum concurrency
116  *
117  * Variables also have one field related to concurrency: concurrency_share.
118  * In effect, in some cases, one variable is involved multiple times (i.e. two elements) in a constraint.
119  * For example, cross-traffic is modeled using 2 elements per constraint.
120  * concurrency_share formally corresponds to the maximum number of elements that associate the variable and any given
121  * constraint.
122  */
123
124 XBT_PUBLIC_DATA(double) sg_maxmin_precision;
125 XBT_PUBLIC_DATA(double) sg_surf_precision;
126 XBT_PUBLIC_DATA(int) sg_concurrency_limit;
127
128 static inline void double_update(double* variable, double value, double precision)
129 {
130   // printf("Updating %g -= %g +- %g\n",*variable,value,precision);
131   // xbt_assert(value==0  || value>precision);
132   // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may
133   // happen, and the precision mechanism is not active...
134   // xbt_assert(*variable< (2<<DBL_MANT_DIG)*precision && FLT_RADIX==2);
135   *variable -= value;
136   if (*variable < precision)
137     *variable = 0.0;
138 }
139
140 static inline int double_positive(double value, double precision)
141 {
142   return (value > precision);
143 }
144
145 static inline int double_equals(double value1, double value2, double precision)
146 {
147   return (fabs(value1 - value2) < precision);
148 }
149
150 /** @{ @ingroup SURF_lmm */
151 /**
152  * @brief Create a new Linear MaxMim system
153  * @param selective_update whether we should do lazy updates
154  */
155 XBT_PUBLIC(lmm_system_t) lmm_system_new(bool selective_update);
156
157 /**
158  * @brief Free an existing Linear MaxMin system
159  * @param sys The lmm system to free
160  */
161 XBT_PUBLIC(void) lmm_system_free(lmm_system_t sys);
162
163 /**
164  * @brief Create a new Linear MaxMin constraint
165  * @param sys The system in which we add a constraint
166  * @param id Data associated to the constraint (e.g.: a network link)
167  * @param bound_value The bound value of the constraint
168  */
169 XBT_PUBLIC(lmm_constraint_t) lmm_constraint_new(lmm_system_t sys, void* id, double bound_value);
170
171 /**
172  * @brief Share a constraint
173  * @param cnst The constraint to share
174  */
175 XBT_PUBLIC(void) lmm_constraint_shared(lmm_constraint_t cnst);
176
177 /**
178  * @brief Check if a constraint is shared (shared by default)
179  * @param cnst The constraint to share
180  * @return 1 if shared, 0 otherwise
181  */
182 XBT_PUBLIC(int) lmm_constraint_sharing_policy(lmm_constraint_t cnst);
183
184 /**
185  * @brief Get the usage of the constraint after the last lmm solve
186  * @param cnst A constraint
187  * @return The usage of the constraint
188  */
189 XBT_PUBLIC(double) lmm_constraint_get_usage(lmm_constraint_t cnst);
190
191 XBT_PUBLIC(int) lmm_constraint_get_variable_amount(lmm_constraint_t cnst);
192
193 /**
194  * @brief Sets the concurrency limit for this constraint
195  * @param cnst A constraint
196  * @param concurrency_limit The concurrency limit to use for this constraint
197  */
198 XBT_PUBLIC(void) lmm_constraint_concurrency_limit_set(lmm_constraint_t cnst, int concurrency_limit);
199
200 /**
201  * @brief Gets the concurrency limit for this constraint
202  * @param cnst A constraint
203  * @return The concurrency limit used by this constraint
204  */
205 XBT_PUBLIC(int) lmm_constraint_concurrency_limit_get(lmm_constraint_t cnst);
206
207 /**
208  * @brief Reset the concurrency maximum for a given variable (we will update the maximum to reflect constraint
209  * evolution).
210  * @param cnst A constraint
211 */
212 XBT_PUBLIC(void) lmm_constraint_concurrency_maximum_reset(lmm_constraint_t cnst);
213
214 /**
215  * @brief Get the concurrency maximum for a given variable (which reflects constraint evolution).
216  * @param cnst A constraint
217  * @return the maximum concurrency of the constraint
218  */
219 XBT_PUBLIC(int) lmm_constraint_concurrency_maximum_get(lmm_constraint_t cnst);
220
221 /**
222  * @brief Create a new Linear MaxMin variable
223  * @param sys The system in which we add a constaint
224  * @param id Data associated to the variable (e.g.: a network communication)
225  * @param weight_value The weight of the variable (0.0 if not used)
226  * @param bound The maximum value of the variable (-1.0 if no maximum value)
227  * @param number_of_constraints The maximum number of constraint to associate to the variable
228  */
229 XBT_PUBLIC(lmm_variable_t)
230 lmm_variable_new(lmm_system_t sys, simgrid::surf::Action* id, double weight_value, double bound,
231                  int number_of_constraints);
232 /**
233  * @brief Free a variable
234  * @param sys The system associated to the variable
235  * @param var The variable to free
236  */
237 XBT_PUBLIC(void) lmm_variable_free(lmm_system_t sys, lmm_variable_t var);
238
239 /**
240  * @brief Get the value of the variable after the last lmm solve
241  * @param var A variable
242  * @return The value of the variable
243  */
244 XBT_PUBLIC(double) lmm_variable_getvalue(lmm_variable_t var);
245
246 /**
247  * @brief Get the maximum value of the variable (-1.0 if no maximum value)
248  * @param var A variable
249  * @return The bound of the variable
250  */
251 XBT_PUBLIC(double) lmm_variable_getbound(lmm_variable_t var);
252
253 /**
254  * @brief Set the concurrent share of the variable
255  * @param var A variable
256  * @param concurrency_share The new concurrency share
257  */
258 XBT_PUBLIC(void) lmm_variable_concurrency_share_set(lmm_variable_t var, short int concurrency_share);
259
260 /**
261  * @brief Associate a variable to a constraint with a coefficient
262  * @param sys A system
263  * @param cnst A constraint
264  * @param var A variable
265  * @param value The coefficient associated to the variable in the constraint
266  */
267 XBT_PUBLIC(void) lmm_expand(lmm_system_t sys, lmm_constraint_t cnst, lmm_variable_t var, double value);
268
269 /**
270  * @brief Add value to the coefficient between a constraint and a variable or create one
271  * @param sys A system
272  * @param cnst A constraint
273  * @param var A variable
274  * @param value The value to add to the coefficient associated to the variable in the constraint
275  */
276 XBT_PUBLIC(void) lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst, lmm_variable_t var, double value);
277
278 /**
279  * @brief Get the numth constraint associated to the variable
280  * @param sys The system associated to the variable (not used)
281  * @param var A variable
282  * @param num The rank of constraint we want to get
283  * @return The numth constraint
284  */
285 XBT_PUBLIC(lmm_constraint_t) lmm_get_cnst_from_var(lmm_system_t sys, lmm_variable_t var, unsigned num);
286
287 /**
288  * @brief Get the weigth of the numth constraint associated to the variable
289  * @param sys The system associated to the variable (not used)
290  * @param var A variable
291  * @param num The rank of constraint we want to get
292  * @return The numth constraint
293  */
294 XBT_PUBLIC(double) lmm_get_cnst_weight_from_var(lmm_system_t sys, lmm_variable_t var, unsigned num);
295
296 /**
297  * @brief Get the number of constraint associated to a variable
298  * @param sys The system associated to the variable (not used)
299  * @param var A variable
300  * @return The number of constraint associated to the variable
301  */
302 XBT_PUBLIC(int) lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var);
303
304 /**
305  * @brief Get a var associated to a constraint
306  * @details Get the first variable of the next variable of elem if elem is not NULL
307  * @param sys The system associated to the variable (not used)
308  * @param cnst A constraint
309  * @param elem A element of constraint of the constraint or NULL
310  * @return A variable associated to a constraint
311  */
312 XBT_PUBLIC(lmm_variable_t) lmm_get_var_from_cnst(lmm_system_t sys, lmm_constraint_t cnst, lmm_element_t* elem);
313
314 /**
315  * @brief Get a var associated to a constraint
316  * @details Get the first variable of the next variable of elem if elem is not NULL
317  * @param cnst A constraint
318  * @param elem A element of constraint of the constraint or NULL
319  * @param nextelem A element of constraint of the constraint or NULL, the one after elem
320  * @param numelem parameter representing the number of elements to go
321  *
322  * @return A variable associated to a constraint
323  */
324 XBT_PUBLIC(lmm_variable_t)
325 lmm_get_var_from_cnst_safe(lmm_system_t sys, lmm_constraint_t cnst, lmm_element_t* elem, lmm_element_t* nextelem,
326                            int* numelem);
327
328 /**
329  * @brief Get the first active constraint of a system
330  * @param sys A system
331  * @return The first active constraint
332  */
333 XBT_PUBLIC(lmm_constraint_t) lmm_get_first_active_constraint(lmm_system_t sys);
334
335 /**
336  * @brief Get the next active constraint of a constraint in a system
337  * @param sys A system
338  * @param cnst An active constraint of the system
339  *
340  * @return The next active constraint
341  */
342 XBT_PUBLIC(lmm_constraint_t) lmm_get_next_active_constraint(lmm_system_t sys, lmm_constraint_t cnst);
343
344 /**
345  * @brief Get the data associated to a constraint
346  * @param cnst A constraint
347  * @return The data associated to the constraint
348  */
349 XBT_PUBLIC(void*) lmm_constraint_id(lmm_constraint_t cnst);
350
351 /**
352  * @brief Get the data associated to a variable
353  * @param var A variable
354  * @return The data associated to the variable
355  */
356 XBT_PUBLIC(void*) lmm_variable_id(lmm_variable_t var);
357
358 /**
359  * @brief Update the value of element linking the constraint and the variable
360  * @param sys A system
361  * @param cnst A constraint
362  * @param var A variable
363  * @param value The new value
364  */
365 XBT_PUBLIC(void) lmm_update(lmm_system_t sys, lmm_constraint_t cnst, lmm_variable_t var, double value);
366
367 /**
368  * @brief Update the bound of a variable
369  * @param sys A system
370  * @param var A constraint
371  * @param bound The new bound
372  */
373 XBT_PUBLIC(void) lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var, double bound);
374
375 /**
376  * @brief Update the weight of a variable
377  * @param sys A system
378  * @param var A variable
379  * @param weight The new weight of the variable
380  */
381 XBT_PUBLIC(void) lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var, double weight);
382
383 /**
384  * @brief Get the weight of a variable
385  * @param var A variable
386  * @return The weight of the variable
387  */
388 XBT_PUBLIC(double) lmm_get_variable_weight(lmm_variable_t var);
389
390 /**
391  * @brief Update a constraint bound
392  * @param sys A system
393  * @param cnst A constraint
394  * @param bound The new bound of the consrtaint
395  */
396 XBT_PUBLIC(void) lmm_update_constraint_bound(lmm_system_t sys, lmm_constraint_t cnst, double bound);
397
398 /**
399  * @brief [brief description]
400  * @param sys A system
401  * @param cnst A constraint
402  * @return [description]
403  */
404 XBT_PUBLIC(int) lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst);
405
406 /**
407  * @brief Print the lmm system
408  * @param sys The lmm system to print
409  */
410 XBT_PUBLIC(void) lmm_print(lmm_system_t sys);
411
412 /**
413  * @brief Solve the lmm system
414  * @param sys The lmm system to solve
415  */
416 XBT_PUBLIC(void) lmm_solve(lmm_system_t sys);
417
418 XBT_PUBLIC(void) lagrange_solve(lmm_system_t sys);
419 XBT_PUBLIC(void) bottleneck_solve(lmm_system_t sys);
420
421 /** Default functions associated to the chosen protocol. When using the lagrangian approach. */
422
423 XBT_PUBLIC(void)
424 lmm_set_default_protocol_function(double (*func_f)(lmm_variable_t var, double x),
425                                   double (*func_fp)(lmm_variable_t var, double x),
426                                   double (*func_fpi)(lmm_variable_t var, double x));
427
428 XBT_PUBLIC(double) func_reno_f(lmm_variable_t var, double x);
429 XBT_PUBLIC(double) func_reno_fp(lmm_variable_t var, double x);
430 XBT_PUBLIC(double) func_reno_fpi(lmm_variable_t var, double x);
431
432 XBT_PUBLIC(double) func_reno2_f(lmm_variable_t var, double x);
433 XBT_PUBLIC(double) func_reno2_fp(lmm_variable_t var, double x);
434 XBT_PUBLIC(double) func_reno2_fpi(lmm_variable_t var, double x);
435
436 XBT_PUBLIC(double) func_vegas_f(lmm_variable_t var, double x);
437 XBT_PUBLIC(double) func_vegas_fp(lmm_variable_t var, double x);
438 XBT_PUBLIC(double) func_vegas_fpi(lmm_variable_t var, double x);
439
440 /** @} */
441
442 #endif