Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove lines of commented code spotted by sonar.
[simgrid.git] / src / surf / lagrange.cpp
1 /* Copyright (c) 2007-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 /*
7  * Modeling the proportional fairness using the Lagrangian Optimization Approach. For a detailed description see:
8  * "ssh://username@scm.gforge.inria.fr/svn/memo/people/pvelho/lagrange/ppf.ps".
9  */
10 #include "xbt/log.h"
11 #include "xbt/sysdep.h"
12 #include "maxmin_private.hpp"
13
14 #include <cstdlib>
15 #ifndef MATH
16 #include <cmath>
17 #endif
18
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_lagrange, surf, "Logging specific to SURF (lagrange)");
20 XBT_LOG_NEW_SUBCATEGORY(surf_lagrange_dichotomy, surf_lagrange, "Logging specific to SURF (lagrange dichotomy)");
21
22 #define SHOW_EXPR(expr) XBT_CDEBUG(surf_lagrange,#expr " = %g",expr);
23
24 double (*func_f_def) (lmm_variable_t, double);
25 double (*func_fp_def) (lmm_variable_t, double);
26 double (*func_fpi_def) (lmm_variable_t, double);
27
28 /*
29  * Local prototypes to implement the Lagrangian optimization with optimal step, also called dichotomy.
30  */
31 //solves the proportional fairness using a Lagrangian optimization with dichotomy step
32 void lagrange_solve(lmm_system_t sys);
33 //computes the value of the dichotomy using a initial values, init, with a specific variable or constraint
34 static double dichotomy(double init, double diff(double, void *), void *var_cnst, double min_error);
35 //computes the value of the differential of constraint param_cnst applied to lambda
36 static double partial_diff_lambda(double lambda, void *param_cnst);
37
38 static int __check_feasible(xbt_swag_t cnst_list, xbt_swag_t var_list, int warn)
39 {
40   void *_cnst, *_elem, *_var;
41   xbt_swag_t elem_list = nullptr;
42   lmm_element_t elem = nullptr;
43   lmm_constraint_t cnst = nullptr;
44   lmm_variable_t var = nullptr;
45
46   xbt_swag_foreach(_cnst, cnst_list) {
47     cnst       = static_cast<lmm_constraint_t>(_cnst);
48     double tmp = 0;
49     elem_list = &(cnst->enabled_element_set);
50     xbt_swag_foreach(_elem, elem_list) {
51       elem = static_cast<lmm_element_t>(_elem);
52       var = elem->variable;
53       xbt_assert(var->sharing_weight > 0);
54       tmp += var->value;
55     }
56
57     if (double_positive(tmp - cnst->bound, sg_maxmin_precision)) {
58       if (warn)
59         XBT_WARN ("The link (%p) is over-used. Expected less than %f and got %f", cnst, cnst->bound, tmp);
60       return 0;
61     }
62     XBT_DEBUG ("Checking feasability for constraint (%p): sat = %f, lambda = %f ", cnst, tmp - cnst->bound,
63                cnst->lambda);
64   }
65
66   xbt_swag_foreach(_var, var_list) {
67     var = static_cast<lmm_variable_t>(_var);
68     if (not var->sharing_weight)
69       break;
70     if (var->bound < 0)
71       continue;
72     XBT_DEBUG("Checking feasability for variable (%p): sat = %f mu = %f", var, var->value - var->bound, var->mu);
73
74     if (double_positive(var->value - var->bound, sg_maxmin_precision)) {
75       if (warn)
76         XBT_WARN ("The variable (%p) is too large. Expected less than %f and got %f", var, var->bound, var->value);
77       return 0;
78     }
79   }
80   return 1;
81 }
82
83 static double new_value(lmm_variable_t var)
84 {
85   double tmp = 0;
86
87   for (int i = 0; i < var->cnsts_number; i++) {
88     tmp += (var->cnsts[i].constraint)->lambda;
89   }
90   if (var->bound > 0)
91     tmp += var->mu;
92   XBT_DEBUG("\t Working on var (%p). cost = %e; Weight = %e", var, tmp, var->sharing_weight);
93   //uses the partial differential inverse function
94   return var->func_fpi(var, tmp);
95 }
96
97 static double new_mu(lmm_variable_t var)
98 {
99   double mu_i = 0.0;
100   double sigma_i = 0.0;
101
102   for (int j = 0; j < var->cnsts_number; j++) {
103     sigma_i += (var->cnsts[j].constraint)->lambda;
104   }
105   mu_i = var->func_fp(var, var->bound) - sigma_i;
106   if (mu_i < 0.0)
107     return 0.0;
108   return mu_i;
109 }
110
111 static double dual_objective(xbt_swag_t var_list, xbt_swag_t cnst_list)
112 {
113   void *_cnst;
114   void *_var;
115   lmm_constraint_t cnst = nullptr;
116   lmm_variable_t var = nullptr;
117
118   double obj = 0.0;
119
120   xbt_swag_foreach(_var, var_list) {
121     var = static_cast<lmm_variable_t>(_var);
122     double sigma_i = 0.0;
123
124     if (not var->sharing_weight)
125       break;
126
127     for (int j = 0; j < var->cnsts_number; j++)
128       sigma_i += (var->cnsts[j].constraint)->lambda;
129
130     if (var->bound > 0)
131       sigma_i += var->mu;
132
133     XBT_DEBUG("var %p : sigma_i = %1.20f", var, sigma_i);
134
135     obj += var->func_f(var, var->func_fpi(var, sigma_i)) - sigma_i * var->func_fpi(var, sigma_i);
136
137     if (var->bound > 0)
138       obj += var->mu * var->bound;
139   }
140
141   xbt_swag_foreach(_cnst, cnst_list) {
142     cnst = static_cast<lmm_constraint_t>(_cnst);
143     obj += cnst->lambda * cnst->bound;
144   }
145
146   return obj;
147 }
148
149 void lagrange_solve(lmm_system_t sys)
150 {
151   /* Lagrange Variables. */
152   int max_iterations = 100;
153   double epsilon_min_error = 0.00001; /* this is the precision on the objective function so it's none of the configurable values and this value is the legacy one */
154   double dichotomy_min_error = 1e-14;
155   double overall_modification = 1;
156
157   /* Variables to manipulate the data structure proposed to model the maxmin fairness. See documentation for details. */
158   xbt_swag_t cnst_list = nullptr;
159   void *_cnst;
160   lmm_constraint_t cnst = nullptr;
161
162   xbt_swag_t var_list = nullptr;
163   void *_var;
164   lmm_variable_t var = nullptr;
165
166   /* Auxiliary variables. */
167   int iteration = 0;
168   double tmp = 0;
169   int i;
170   double obj;
171   double new_obj;
172
173   XBT_DEBUG("Iterative method configuration snapshot =====>");
174   XBT_DEBUG("#### Maximum number of iterations        : %d", max_iterations);
175   XBT_DEBUG("#### Minimum error tolerated             : %e", epsilon_min_error);
176   XBT_DEBUG("#### Minimum error tolerated (dichotomy) : %e", dichotomy_min_error);
177
178   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
179     lmm_print(sys);
180   }
181
182   if (not sys->modified)
183     return;
184
185   /* Initialize lambda. */
186   cnst_list = &(sys->active_constraint_set);
187   xbt_swag_foreach(_cnst, cnst_list) {
188   cnst = (lmm_constraint_t)_cnst;
189     cnst->lambda = 1.0;
190     cnst->new_lambda = 2.0;
191     XBT_DEBUG("#### cnst(%p)->lambda :  %e", cnst, cnst->lambda);
192   }
193
194   /*
195    * Initialize the var list variable with only the active variables.
196    * Associate an index in the swag variables. Initialize mu.
197    */
198   var_list = &(sys->variable_set);
199   i = 0;
200   xbt_swag_foreach(_var, var_list) {
201   var = static_cast<lmm_variable_t>(_var);
202   if (not var->sharing_weight)
203     var->value = 0.0;
204   else {
205     int nb = 0;
206     if (var->bound < 0.0) {
207       XBT_DEBUG("#### NOTE var(%d) is a boundless variable", i);
208       var->mu    = -1.0;
209       var->value = new_value(var);
210     } else {
211       var->mu     = 1.0;
212       var->new_mu = 2.0;
213       var->value  = new_value(var);
214     }
215     XBT_DEBUG("#### var(%p) ->weight :  %e", var, var->sharing_weight);
216     XBT_DEBUG("#### var(%p) ->mu :  %e", var, var->mu);
217     XBT_DEBUG("#### var(%p) ->weight: %e", var, var->sharing_weight);
218     XBT_DEBUG("#### var(%p) ->bound: %e", var, var->bound);
219     for (i = 0; i < var->cnsts_number; i++) {
220       if (var->cnsts[i].consumption_weight == 0.0)
221         nb++;
222     }
223     if (nb == var->cnsts_number)
224       var->value = 1.0;
225     }
226   }
227
228   /*  Compute dual objective. */
229   obj = dual_objective(var_list, cnst_list);
230
231   /* While doesn't reach a minimum error or a number maximum of iterations. */
232   while (overall_modification > epsilon_min_error && iteration < max_iterations) {
233     iteration++;
234     XBT_DEBUG("************** ITERATION %d **************", iteration);
235     XBT_DEBUG("-------------- Gradient Descent ----------");
236
237     /* Improve the value of mu_i */
238     xbt_swag_foreach(_var, var_list) {
239       var = static_cast<lmm_variable_t>(_var);
240       if (not var->sharing_weight)
241         break;
242       if (var->bound >= 0) {
243         XBT_DEBUG("Working on var (%p)", var);
244         var->new_mu = new_mu(var);
245         XBT_DEBUG("Updating mu : var->mu (%p) : %1.20f -> %1.20f", var, var->mu, var->new_mu);
246         var->mu = var->new_mu;
247
248         new_obj = dual_objective(var_list, cnst_list);
249         XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
250         xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
251         obj = new_obj;
252       }
253     }
254
255     /* Improve the value of lambda_i */
256     xbt_swag_foreach(_cnst, cnst_list) {
257       cnst = static_cast<lmm_constraint_t>(_cnst);
258       XBT_DEBUG("Working on cnst (%p)", cnst);
259       cnst->new_lambda = dichotomy(cnst->lambda, partial_diff_lambda, cnst, dichotomy_min_error);
260       XBT_DEBUG("Updating lambda : cnst->lambda (%p) : %1.20f -> %1.20f", cnst, cnst->lambda, cnst->new_lambda);
261       cnst->lambda = cnst->new_lambda;
262
263       new_obj = dual_objective(var_list, cnst_list);
264       XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
265       xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
266       obj = new_obj;
267     }
268
269     /* Now computes the values of each variable (\rho) based on the values of \lambda and \mu. */
270     XBT_DEBUG("-------------- Check convergence ----------");
271     overall_modification = 0;
272     xbt_swag_foreach(_var, var_list) {
273       var = static_cast<lmm_variable_t>(_var);
274       if (var->sharing_weight <= 0)
275         var->value = 0.0;
276       else {
277         tmp = new_value(var);
278
279         overall_modification = MAX(overall_modification, fabs(var->value - tmp));
280
281         var->value = tmp;
282         XBT_DEBUG("New value of var (%p)  = %e, overall_modification = %e", var, var->value, overall_modification);
283       }
284     }
285
286     XBT_DEBUG("-------------- Check feasability ----------");
287     if (not __check_feasible(cnst_list, var_list, 0))
288       overall_modification = 1.0;
289     XBT_DEBUG("Iteration %d: overall_modification : %f", iteration, overall_modification);
290   }
291
292   __check_feasible(cnst_list, var_list, 1);
293
294   if (overall_modification <= epsilon_min_error) {
295     XBT_DEBUG("The method converges in %d iterations.", iteration);
296   }
297   if (iteration >= max_iterations) {
298     XBT_DEBUG ("Method reach %d iterations, which is the maximum number of iterations allowed.", iteration);
299   }
300
301   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
302     lmm_print(sys);
303   }
304 }
305
306 /*
307  * Returns a double value corresponding to the result of a dichotomy process with respect to a given
308  * variable/constraint (\mu in the case of a variable or \lambda in case of a constraint) and a initial value init.
309  *
310  * @param init initial value for \mu or \lambda
311  * @param diff a function that computes the differential of with respect a \mu or \lambda
312  * @param var_cnst a pointer to a variable or constraint
313  * @param min_erro a minimum error tolerated
314  *
315  * @return a double corresponding to the result of the dichotomy process
316  */
317 static double dichotomy(double init, double diff(double, void *), void *var_cnst, double min_error)
318 {
319   double min =init;
320   double max= init;
321   double overall_error;
322   double middle;
323   double middle_diff;
324   double diff_0 = 0.0;
325
326   XBT_IN();
327
328   if (fabs(init) < 1e-20) {
329     min = 0.5;
330     max = 0.5;
331   }
332
333   overall_error = 1;
334
335   diff_0 = diff(1e-16, var_cnst);
336   if (diff_0 >= 0) {
337     XBT_CDEBUG(surf_lagrange_dichotomy, "returning 0.0 (diff = %e)", diff_0);
338     XBT_OUT();
339     return 0.0;
340   }
341
342   double min_diff = diff(min, var_cnst);
343   double max_diff = diff(max, var_cnst);
344
345   while (overall_error > min_error) {
346     XBT_CDEBUG(surf_lagrange_dichotomy, "[min, max] = [%1.20f, %1.20f] || diffmin, diffmax = %1.20f, %1.20f",
347                min, max, min_diff, max_diff);
348
349     if (min_diff > 0 && max_diff > 0) {
350       if (min == max) {
351         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing min");
352         min = min / 2.0;
353         min_diff = diff(min, var_cnst);
354       } else {
355         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing max");
356         max = min;
357         max_diff = min_diff;
358       }
359     } else if (min_diff < 0 && max_diff < 0) {
360       if (min == max) {
361         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing max");
362         max = max * 2.0;
363         max_diff = diff(max, var_cnst);
364       } else {
365         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing min");
366         min = max;
367         min_diff = max_diff;
368       }
369     } else if (min_diff < 0 && max_diff > 0) {
370       middle = (max + min) / 2.0;
371       XBT_CDEBUG(surf_lagrange_dichotomy, "Trying (max+min)/2 : %1.20f", middle);
372
373       if ((fabs(min - middle) < 1e-20) || (fabs(max - middle) < 1e-20)){
374         XBT_CWARN(surf_lagrange_dichotomy, "Cannot improve the convergence! min=max=middle=%1.20f, diff = %1.20f."
375                   " Reaching the 'double' limits. Maybe scaling your function would help ([%1.20f,%1.20f]).",
376                   min, max - min, min_diff, max_diff);
377         break;
378       }
379       middle_diff = diff(middle, var_cnst);
380
381       if (middle_diff < 0) {
382         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing min");
383         min = middle;
384         overall_error = max_diff - middle_diff;
385         min_diff = middle_diff;
386       } else if (middle_diff > 0) {
387         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing max");
388         max = middle;
389         overall_error = max_diff - middle_diff;
390         max_diff = middle_diff;
391       } else {
392         overall_error = 0;
393       }
394     } else if (fabs(min_diff) < 1e-20) {
395       max = min;
396       overall_error = 0;
397     } else if (fabs(max_diff) < 1e-20) {
398       min = max;
399       overall_error = 0;
400     } else if (min_diff > 0 && max_diff < 0) {
401       XBT_CWARN(surf_lagrange_dichotomy, "The impossible happened, partial_diff(min) > 0 && partial_diff(max) < 0");
402       xbt_abort();
403     } else {
404       XBT_CWARN(surf_lagrange_dichotomy,
405              "diffmin (%1.20f) or diffmax (%1.20f) are something I don't know, taking no action.",
406              min_diff, max_diff);
407       xbt_abort();
408     }
409   }
410
411   XBT_CDEBUG(surf_lagrange_dichotomy, "returning %e", (min + max) / 2.0);
412   XBT_OUT();
413   return ((min + max) / 2.0);
414 }
415
416 static double partial_diff_lambda(double lambda, void *param_cnst)
417 {
418   lmm_constraint_t cnst = static_cast<lmm_constraint_t>(param_cnst);
419   double diff = 0.0;
420
421   XBT_IN();
422
423   XBT_CDEBUG(surf_lagrange_dichotomy, "Computing diff of cnst (%p)", cnst);
424
425   xbt_swag_t elem_list = &(cnst->enabled_element_set);
426   void* _elem;
427   xbt_swag_foreach(_elem, elem_list) {
428     lmm_element_t elem = static_cast<lmm_element_t>(_elem);
429     lmm_variable_t var = elem->variable;
430     xbt_assert(var->sharing_weight > 0);
431     XBT_CDEBUG(surf_lagrange_dichotomy, "Computing sigma_i for var (%p)", var);
432     // Initialize the summation variable
433     double sigma_i = 0.0;
434
435     // Compute sigma_i
436     for (int j = 0; j < var->cnsts_number; j++) {
437       sigma_i += (var->cnsts[j].constraint)->lambda;
438     }
439
440     //add mu_i if this flow has a RTT constraint associated
441     if (var->bound > 0)
442       sigma_i += var->mu;
443
444     //replace value of cnst->lambda by the value of parameter lambda
445     sigma_i = (sigma_i - cnst->lambda) + lambda;
446
447     diff += -var->func_fpi(var, sigma_i);
448   }
449
450   diff += cnst->bound;
451
452   XBT_CDEBUG(surf_lagrange_dichotomy, "d D/d lambda for cnst (%p) at %1.20f = %1.20f", cnst, lambda, diff);
453   XBT_OUT();
454   return diff;
455 }
456
457 /** \brief Attribute the value bound to var->bound.
458  *
459  *  \param func_fpi  inverse of the partial differential of f (f prime inverse, (f')^{-1})
460  *
461  *  Set default functions to the ones passed as parameters. This is a polymorphism in C pure, enjoy the roots of
462  *  programming.
463  *
464  */
465 void lmm_set_default_protocol_function(double (*func_f) (lmm_variable_t var, double x),
466                                        double (*func_fp) (lmm_variable_t var, double x),
467                                        double (*func_fpi) (lmm_variable_t var, double x))
468 {
469   func_f_def = func_f;
470   func_fp_def = func_fp;
471   func_fpi_def = func_fpi;
472 }
473
474 /**************** Vegas and Reno functions *************************/
475 /* NOTE for Reno: all functions consider the network coefficient (alpha) equal to 1. */
476
477 /*
478  * For Vegas: $f(x) = \alpha D_f\ln(x)$
479  * Therefore: $fp(x) = \frac{\alpha D_f}{x}$
480  * Therefore: $fpi(x) = \frac{\alpha D_f}{x}$
481  */
482 #define VEGAS_SCALING 1000.0
483
484 double func_vegas_f(lmm_variable_t var, double x)
485 {
486   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
487   return VEGAS_SCALING * var->sharing_weight * log(x);
488 }
489
490 double func_vegas_fp(lmm_variable_t var, double x)
491 {
492   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
493   return VEGAS_SCALING * var->sharing_weight / x;
494 }
495
496 double func_vegas_fpi(lmm_variable_t var, double x)
497 {
498   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
499   return var->sharing_weight / (x / VEGAS_SCALING);
500 }
501
502 /*
503  * For Reno:  $f(x) = \frac{\sqrt{3/2}}{D_f} atan(\sqrt{3/2}D_f x)$
504  * Therefore: $fp(x)  = \frac{3}{3 D_f^2 x^2+2}$
505  * Therefore: $fpi(x)  = \sqrt{\frac{1}{{D_f}^2 x} - \frac{2}{3{D_f}^2}}$
506  */
507 #define RENO_SCALING 1.0
508 double func_reno_f(lmm_variable_t var, double x)
509 {
510   xbt_assert(var->sharing_weight > 0.0, "Don't call me with stupid values!");
511
512   return RENO_SCALING * sqrt(3.0 / 2.0) / var->sharing_weight * atan(sqrt(3.0 / 2.0) * var->sharing_weight * x);
513 }
514
515 double func_reno_fp(lmm_variable_t var, double x)
516 {
517   return RENO_SCALING * 3.0 / (3.0 * var->sharing_weight * var->sharing_weight * x * x + 2.0);
518 }
519
520 double func_reno_fpi(lmm_variable_t var, double x)
521 {
522   double res_fpi;
523
524   xbt_assert(var->sharing_weight > 0.0, "Don't call me with stupid values!");
525   xbt_assert(x > 0.0, "Don't call me with stupid values!");
526
527   res_fpi = 1.0 / (var->sharing_weight * var->sharing_weight * (x / RENO_SCALING)) -
528             2.0 / (3.0 * var->sharing_weight * var->sharing_weight);
529   if (res_fpi <= 0.0)
530     return 0.0;
531   return sqrt(res_fpi);
532 }
533
534 /* Implementing new Reno-2
535  * For Reno-2:  $f(x)   = U_f(x_f) = \frac{{2}{D_f}}*ln(2+x*D_f)$
536  * Therefore:   $fp(x)  = 2/(Weight*x + 2)
537  * Therefore:   $fpi(x) = (2*Weight)/x - 4
538  */
539 #define RENO2_SCALING 1.0
540 double func_reno2_f(lmm_variable_t var, double x)
541 {
542   xbt_assert(var->sharing_weight > 0.0, "Don't call me with stupid values!");
543   return RENO2_SCALING * (1.0 / var->sharing_weight) *
544          log((x * var->sharing_weight) / (2.0 * x * var->sharing_weight + 3.0));
545 }
546
547 double func_reno2_fp(lmm_variable_t var, double x)
548 {
549   return RENO2_SCALING * 3.0 / (var->sharing_weight * x * (2.0 * var->sharing_weight * x + 3.0));
550 }
551
552 double func_reno2_fpi(lmm_variable_t var, double x)
553 {
554   xbt_assert(x > 0.0, "Don't call me with stupid values!");
555   double tmp     = x * var->sharing_weight * var->sharing_weight;
556   double res_fpi = tmp * (9.0 * x + 24.0);
557
558   if (res_fpi <= 0.0)
559     return 0.0;
560
561   res_fpi = RENO2_SCALING * (-3.0 * tmp + sqrt(res_fpi)) / (4.0 * tmp);
562   return res_fpi;
563 }