Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
sanitize the handling of trace:connect for host_avail
[simgrid.git] / src / include / surf / maxmin.h
1 /* Copyright (c) 2004-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef _SURF_MAXMIN_H
8 #define _SURF_MAXMIN_H
9
10 #include "src/portable.h"
11 #include "xbt/misc.h"
12 #include "xbt/asserts.h"
13 #include "surf/datatypes.h"
14 #include <math.h>
15
16
17 /** @addtogroup SURF_lmm 
18  * @details 
19  * A linear maxmin solver to resolve inequations systems.
20  * 
21  * Most SimGrid model rely on a "fluid/steady-state" modeling that
22  * simulate the sharing of resources between actions at relatively
23  * coarse-grain.  Such sharing is generally done by solving a set of
24  * linear inequations. Let's take an example and assume we have the
25  * variables \f$x_1\f$, \f$x_2\f$, \f$x_3\f$, and \f$x_4\f$ . Let's
26  * say that \f$x_1\f$ and \f$x_2\f$ correspond to activities running
27  * and the same CPU \f$A\f$ whose capacity is \f$C_A\f$. In such a
28  * case, we need to enforce:
29  *
30  *   \f[ x_1 + x_2 \leq C_A \f]
31  *
32  * Likewise, if \f$x_3\f$ (resp. \f$x_4\f$) corresponds to a network
33  * flow \f$F_3\f$ (resp. \f$F_4\f$) that goes through a set of links
34  * \f$L_1\f$ and \f$L_2\f$ (resp. \f$L_2\f$ and \f$L_3\f$), then we
35  * need to enforce:
36  *
37  *   \f[ x_3  \leq C_{L_1} \f]
38  *   \f[ x_3 + x_4 \leq C_{L_2} \f]
39  *   \f[ x_4 \leq C_{L_3} \f]
40  * 
41  * One could set every variable to 0 to make sure the constraints are
42  * satisfied but this would obviously not be very realistic. A
43  * possible objective is to try to maximize the minimum of the
44  * \f$x_i\f$ . This ensures that all the \f$x_i\f$ are positive and "as
45  * large as possible". 
46  *
47  * This is called *max-min fairness* and is the most commonly used
48  * objective in SimGrid. Another possibility is to maximize
49  * \f$\sum_if(x_i)\f$, where \f$f\f$ is a strictly increasing concave
50  * 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 usefull for the sharing of resources for various models.
90  * For instance, for the network model, each link is associated 
91  * to a constraint and each communication to a variable. 
92  * 
93  */
94
95 XBT_PUBLIC_DATA(double) sg_maxmin_precision;
96 XBT_PUBLIC_DATA(double) sg_surf_precision;
97  
98 static XBT_INLINE void double_update(double *variable, double value, double precision)
99 {
100   //printf("Updating %g -= %g +- %g\n",*variable,value,precision);
101   //xbt_assert(value==0  || value>precision);
102   //Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may happen, and the precision mechanism is not active... 
103   //xbt_assert(*variable< (2<<DBL_MANT_DIG)*precision && FLT_RADIX==2);
104   *variable -= value;
105   if (*variable < precision)
106     *variable = 0.0;
107 }
108
109 static XBT_INLINE int double_positive(double value, double precision)
110 {
111   return (value > precision);
112 }
113
114 static XBT_INLINE int double_equals(double value1, double value2, double precision)
115 {
116   return (fabs(value1 - value2) < precision);
117 }
118
119 SG_BEGIN_DECL()
120
121 /** @{ @ingroup SURF_lmm */
122 /**
123  * @brief Create a new Linear MaxMim system
124  * 
125  * @param selective_update [description]
126  */
127 XBT_PUBLIC(lmm_system_t) lmm_system_new(int selective_update);
128
129 /**
130  * @brief Free an existing Linear MaxMin system
131  * 
132  * @param sys The lmm system to free
133  */
134 XBT_PUBLIC(void) lmm_system_free(lmm_system_t sys);
135
136 /**
137  * @brief Create a new Linear MaxMin constraint
138  * 
139  * @param sys The system in which we add a constraint
140  * @param id Data associated to the constraint (e.g.: a network link)
141  * @param bound_value The bound value of the constraint 
142  */
143 XBT_PUBLIC(lmm_constraint_t) lmm_constraint_new(lmm_system_t sys, void *id,
144                                                 double bound_value);
145
146 /**
147  * @brief Share a constraint
148  * @details [long description]
149  * 
150  * @param cnst The constraint to share
151  */
152 XBT_PUBLIC(void) lmm_constraint_shared(lmm_constraint_t cnst);
153
154 /**
155  * @brief Check if a constraint is shared (shared by default)
156  * 
157  * @param cnst The constraint to share
158  * @return 1 if shared, 0 otherwise
159  */
160 XBT_PUBLIC(int) lmm_constraint_sharing_policy(lmm_constraint_t cnst);
161
162 /**
163  * @brief Free a constraint
164  * 
165  * @param sys The system associated to the constraint
166  * @param cnst The constraint to free
167  */
168 XBT_PUBLIC(void) lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst);
169
170 /**
171  * @brief Get the usage of the constraint after the last lmm solve
172  * 
173  * @param cnst A constraint
174  * @return The usage of the constraint
175  */
176 XBT_PUBLIC(double) lmm_constraint_get_usage(lmm_constraint_t cnst);
177
178 /**
179  * @brief Create a new Linear MaxMin variable
180  * 
181  * @param sys The system in which we add a constaint
182  * @param id Data associated to the variable (e.g.: a network communication)
183  * @param weight_value The weight of the variable (0.0 if not used)
184  * @param bound The maximum value of the variable (-1.0 if no maximum value)
185  * @param number_of_constraints The maximum number of constraint to associate to the variable
186  */
187 XBT_PUBLIC(lmm_variable_t) lmm_variable_new(lmm_system_t sys, void *id,
188                                             double weight_value,
189                                             double bound,
190                                             int number_of_constraints);
191 /**
192  * @brief Free a variable
193  * 
194  * @param sys The system associated to the variable
195  * @param var The variable to free
196  */
197 XBT_PUBLIC(void) lmm_variable_free(lmm_system_t sys, lmm_variable_t var);
198
199 /**
200  * @brief Get the value of the variable after the last lmm solve
201  * 
202  * @param var A variable
203  * @return The value of the variable
204  */
205 XBT_PUBLIC(double) lmm_variable_getvalue(lmm_variable_t var);
206
207 /**
208  * @brief Get the maximum value of the variable (-1.0 if no maximum value)
209  * 
210  * @param var A variable
211  * @return The bound of the variable
212  */
213 XBT_PUBLIC(double) lmm_variable_getbound(lmm_variable_t var);
214
215 /**
216  * @brief Remove a variable from a constraint
217  * 
218  * @param sys A system
219  * @param cnst A constraint
220  * @param var The variable to remove
221  */
222 XBT_PUBLIC(void) lmm_shrink(lmm_system_t sys, lmm_constraint_t cnst,
223                             lmm_variable_t var);
224
225 /**
226  * @brief Associate a variable to a constraint with a coefficient
227  * 
228  * @param sys A system
229  * @param cnst A constraint
230  * @param var A variable
231  * @param value The coefficient associated to the variable in the constraint
232  */
233 XBT_PUBLIC(void) lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
234                             lmm_variable_t var, double value);
235
236 /**
237  * @brief Add value to the coefficient between a constraint and a variable or 
238  *        create one
239  * 
240  * @param sys A system
241  * @param cnst A constraint
242  * @param var A variable
243  * @param value The value to add to the coefficient associated to the variable in the constraint
244  */
245 XBT_PUBLIC(void) lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
246                     lmm_variable_t var, double value);
247
248 /**
249  * @brief Get the numth constraint associated to the variable
250  * 
251  * @param sys The system associated to the variable (not used)
252  * @param var A variable
253  * @param num The rank of constraint we want to get
254  * @return The numth constraint
255  */
256 XBT_PUBLIC(lmm_constraint_t) lmm_get_cnst_from_var(lmm_system_t sys,
257                                        lmm_variable_t var, int num);
258
259 /**
260  * @brief Get the weigth of the numth constraint associated to the variable
261  * 
262  * @param sys The system associated to the variable (not used)
263  * @param var A variable
264  * @param num The rank of constraint we want to get
265  * @return The numth constraint
266  */
267 XBT_PUBLIC(double) lmm_get_cnst_weight_from_var(lmm_system_t sys, lmm_variable_t var,
268                                     int num);
269
270 /**
271  * @brief Get the number of constraint associated to a variable
272  * 
273  * @param sys The system associated to the variable (not used)
274  * @param var A variable
275  * @return The number of constraint associated to the variable
276  */
277 XBT_PUBLIC(int) lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var);
278
279 /**
280  * @brief Get a var associated to a constraint 
281  * @details Get the first variable of the next variable of elem if elem is not NULL
282  * 
283  * @param sys The system associated to the variable (not used)
284  * @param cnst A constraint
285  * @param elem A element of constraint of the constraint or NULL
286  * @return A variable associated to a constraint
287  */
288 XBT_PUBLIC(lmm_variable_t) lmm_get_var_from_cnst(lmm_system_t sys,
289                                      lmm_constraint_t cnst,
290                                      lmm_element_t * elem);
291
292 /**
293  * @brief Get a var associated to a constraint
294  * @details Get the first variable of the next variable of elem if elem is not NULL
295  *
296  * @param cnst A constraint
297  * @param elem A element of constraint of the constraint or NULL
298  * @param nextelem A element of constraint of the constraint or NULL, the one after elem
299  * @param numelem parameter representing the number of elements to go
300  *
301  * @return A variable associated to a constraint
302  */
303 XBT_PUBLIC(lmm_variable_t) lmm_get_var_from_cnst_safe(lmm_system_t /*sys*/,
304                                      lmm_constraint_t cnst,
305                                      lmm_element_t * elem,
306                                      lmm_element_t * nextelem,
307                                      int * numelem);
308
309 /**
310  * @brief Get the first active constraint of a system
311  * 
312  * @param sys A system
313  * @return The first active constraint
314  */
315 XBT_PUBLIC(lmm_constraint_t) lmm_get_first_active_constraint(lmm_system_t sys);
316
317 /**
318  * @brief Get the next active constraint of a constraint in a system
319  * 
320  * @param sys A system
321  * @param cnst An active constraint of the system
322  * 
323  * @return The next active constraint
324  */
325 XBT_PUBLIC(lmm_constraint_t) lmm_get_next_active_constraint(lmm_system_t sys,
326                                                 lmm_constraint_t cnst);
327
328 #ifdef HAVE_LATENCY_BOUND_TRACKING
329 XBT_PUBLIC(int) lmm_is_variable_limited_by_latency(lmm_variable_t var);
330 #endif
331
332 /**
333  * @brief Get the data associated to a constraint
334  * 
335  * @param cnst A constraint
336  * @return The data associated to the constraint
337  */
338 XBT_PUBLIC(void *) lmm_constraint_id(lmm_constraint_t cnst);
339
340 /**
341  * @brief Get the data associated to a variable
342  * 
343  * @param var A variable
344  * @return The data associated to the variable
345  */
346 XBT_PUBLIC(void *) lmm_variable_id(lmm_variable_t var);
347
348 /**
349  * @brief Update the value of element linking the constraint and the variable
350  * 
351  * @param sys A system
352  * @param cnst A constraint
353  * @param var A variable
354  * @param value The new value
355  */
356 XBT_PUBLIC(void) lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
357                 lmm_variable_t var, double value);
358
359 /**
360  * @brief Update the bound of a variable
361  * 
362  * @param sys A system
363  * @param var A constraint
364  * @param bound The new bound
365  */
366 XBT_PUBLIC(void) lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
367                                double bound);
368
369 /**
370  * @brief Update the weight of a variable
371  * 
372  * @param sys A system
373  * @param var A variable
374  * @param weight The new weight of the variable
375  */
376 XBT_PUBLIC(void) lmm_update_variable_weight(lmm_system_t sys,
377                                             lmm_variable_t var,
378                                             double weight);
379
380 /**
381  * @brief Get the weight of a variable
382  * 
383  * @param var A variable
384  * @return The weight of the variable
385  */
386 XBT_PUBLIC(double) lmm_get_variable_weight(lmm_variable_t var);
387
388 /**
389  * @brief Update a constraint bound
390  * 
391  * @param sys A system
392  * @param cnst A constraint
393  * @param bound The new bound of the consrtaint
394  */
395 XBT_PUBLIC(void) lmm_update_constraint_bound(lmm_system_t sys,
396                                              lmm_constraint_t cnst,
397                                              double bound);
398
399 /**
400  * @brief [brief description]
401  * 
402  * @param sys A system
403  * @param cnst A constraint
404  * @return [description]
405  */
406 XBT_PUBLIC(int) lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst);
407
408 /**
409  * @brief Solve the lmm system
410  * 
411  * @param sys The lmm system to solve
412  */
413 XBT_PUBLIC(void) lmm_solve(lmm_system_t sys);
414
415 XBT_PUBLIC(void) lagrange_solve(lmm_system_t sys);
416 XBT_PUBLIC(void) bottleneck_solve(lmm_system_t sys);
417
418 /**
419  * Default functions associated to the chosen protocol. When
420  * using the lagrangian approach.
421  */
422
423 XBT_PUBLIC(void) lmm_set_default_protocol_function(double (*func_f)
424                                                     (lmm_variable_t var,
425                                                      double x),
426                                                    double (*func_fp)
427                                                     (lmm_variable_t var,
428                                                      double x),
429                                                    double (*func_fpi)
430                                                     (lmm_variable_t var,
431                                                      double x));
432
433 XBT_PUBLIC(double func_reno_f) (lmm_variable_t var, double x);
434 XBT_PUBLIC(double func_reno_fp) (lmm_variable_t var, double x);
435 XBT_PUBLIC(double func_reno_fpi) (lmm_variable_t var, double x);
436
437 XBT_PUBLIC(double func_reno2_f) (lmm_variable_t var, double x);
438 XBT_PUBLIC(double func_reno2_fp) (lmm_variable_t var, double x);
439 XBT_PUBLIC(double func_reno2_fpi) (lmm_variable_t var, double x);
440
441 XBT_PUBLIC(double func_vegas_f) (lmm_variable_t var, double x);
442 XBT_PUBLIC(double func_vegas_fp) (lmm_variable_t var, double x);
443 XBT_PUBLIC(double func_vegas_fpi) (lmm_variable_t var, double x);
444
445 /** @} */
446 SG_END_DECL()
447
448 #endif                          /* _SURF_MAXMIN_H */