Logo AND Algorithmique Numérique Distribuée

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