Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Put lmm definitions in namespace simgrid::surf.
[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
25 namespace simgrid {
26 namespace surf {
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   /* Variables to manipulate the data structure proposed to model the maxmin fairness. See documentation for details. */
164   xbt_swag_t cnst_list = nullptr;
165   void *_cnst;
166   lmm_constraint_t cnst = nullptr;
167
168   xbt_swag_t var_list = nullptr;
169   void *_var;
170   lmm_variable_t var = nullptr;
171
172   /* Auxiliary variables. */
173   int iteration = 0;
174   double tmp = 0;
175   int i;
176   double obj;
177   double new_obj;
178
179   XBT_DEBUG("Iterative method configuration snapshot =====>");
180   XBT_DEBUG("#### Maximum number of iterations        : %d", max_iterations);
181   XBT_DEBUG("#### Minimum error tolerated             : %e", epsilon_min_error);
182   XBT_DEBUG("#### Minimum error tolerated (dichotomy) : %e", dichotomy_min_error);
183
184   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
185     sys->print();
186   }
187
188   if (not sys->modified)
189     return;
190
191   /* Initialize lambda. */
192   cnst_list = &(sys->active_constraint_set);
193   xbt_swag_foreach(_cnst, cnst_list) {
194   cnst = (lmm_constraint_t)_cnst;
195     cnst->lambda = 1.0;
196     cnst->new_lambda = 2.0;
197     XBT_DEBUG("#### cnst(%p)->lambda :  %e", cnst, cnst->lambda);
198   }
199
200   /*
201    * Initialize the var list variable with only the active variables.
202    * Associate an index in the swag variables. Initialize mu.
203    */
204   var_list = &(sys->variable_set);
205   i = 0;
206   xbt_swag_foreach(_var, var_list) {
207     var = static_cast<lmm_variable_t>(_var);
208     if (not var->sharing_weight)
209       var->value = 0.0;
210     else {
211       if (var->bound < 0.0) {
212         XBT_DEBUG("#### NOTE var(%d) is a boundless variable", i);
213         var->mu    = -1.0;
214         var->value = new_value(var);
215       } else {
216         var->mu     = 1.0;
217         var->new_mu = 2.0;
218         var->value  = new_value(var);
219       }
220       XBT_DEBUG("#### var(%p) ->weight :  %e", var, var->sharing_weight);
221       XBT_DEBUG("#### var(%p) ->mu :  %e", var, var->mu);
222       XBT_DEBUG("#### var(%p) ->weight: %e", var, var->sharing_weight);
223       XBT_DEBUG("#### var(%p) ->bound: %e", var, var->bound);
224       auto weighted = std::find_if(begin(var->cnsts), end(var->cnsts),
225                                    [](s_lmm_element_t const& x) { return x.consumption_weight != 0.0; });
226       if (weighted == end(var->cnsts))
227         var->value = 1.0;
228     }
229   }
230
231   /*  Compute dual objective. */
232   obj = dual_objective(var_list, cnst_list);
233
234   /* While doesn't reach a minimum error or a number maximum of iterations. */
235   while (overall_modification > epsilon_min_error && iteration < max_iterations) {
236     iteration++;
237     XBT_DEBUG("************** ITERATION %d **************", iteration);
238     XBT_DEBUG("-------------- Gradient Descent ----------");
239
240     /* Improve the value of mu_i */
241     xbt_swag_foreach(_var, var_list) {
242       var = static_cast<lmm_variable_t>(_var);
243       if (not var->sharing_weight)
244         break;
245       if (var->bound >= 0) {
246         XBT_DEBUG("Working on var (%p)", var);
247         var->new_mu = new_mu(var);
248         XBT_DEBUG("Updating mu : var->mu (%p) : %1.20f -> %1.20f", var, var->mu, var->new_mu);
249         var->mu = var->new_mu;
250
251         new_obj = dual_objective(var_list, cnst_list);
252         XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
253         xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
254         obj = new_obj;
255       }
256     }
257
258     /* Improve the value of lambda_i */
259     xbt_swag_foreach(_cnst, cnst_list) {
260       cnst = static_cast<lmm_constraint_t>(_cnst);
261       XBT_DEBUG("Working on cnst (%p)", cnst);
262       cnst->new_lambda = dichotomy(cnst->lambda, partial_diff_lambda, cnst, dichotomy_min_error);
263       XBT_DEBUG("Updating lambda : cnst->lambda (%p) : %1.20f -> %1.20f", cnst, cnst->lambda, cnst->new_lambda);
264       cnst->lambda = cnst->new_lambda;
265
266       new_obj = dual_objective(var_list, cnst_list);
267       XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
268       xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
269       obj = new_obj;
270     }
271
272     /* Now computes the values of each variable (\rho) based on the values of \lambda and \mu. */
273     XBT_DEBUG("-------------- Check convergence ----------");
274     overall_modification = 0;
275     xbt_swag_foreach(_var, var_list) {
276       var = static_cast<lmm_variable_t>(_var);
277       if (var->sharing_weight <= 0)
278         var->value = 0.0;
279       else {
280         tmp = new_value(var);
281
282         overall_modification = std::max(overall_modification, fabs(var->value - tmp));
283
284         var->value = tmp;
285         XBT_DEBUG("New value of var (%p)  = %e, overall_modification = %e", var, var->value, overall_modification);
286       }
287     }
288
289     XBT_DEBUG("-------------- Check feasability ----------");
290     if (not __check_feasible(cnst_list, var_list, 0))
291       overall_modification = 1.0;
292     XBT_DEBUG("Iteration %d: overall_modification : %f", iteration, overall_modification);
293   }
294
295   __check_feasible(cnst_list, var_list, 1);
296
297   if (overall_modification <= epsilon_min_error) {
298     XBT_DEBUG("The method converges in %d iterations.", iteration);
299   }
300   if (iteration >= max_iterations) {
301     XBT_DEBUG ("Method reach %d iterations, which is the maximum number of iterations allowed.", iteration);
302   }
303
304   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
305     sys->print();
306   }
307 }
308
309 /*
310  * Returns a double value corresponding to the result of a dichotomy process with respect to a given
311  * variable/constraint (\mu in the case of a variable or \lambda in case of a constraint) and a initial value init.
312  *
313  * @param init initial value for \mu or \lambda
314  * @param diff a function that computes the differential of with respect a \mu or \lambda
315  * @param var_cnst a pointer to a variable or constraint
316  * @param min_erro a minimum error tolerated
317  *
318  * @return a double corresponding to the result of the dichotomy process
319  */
320 static double dichotomy(double init, double diff(double, void *), void *var_cnst, double min_error)
321 {
322   double min =init;
323   double max= init;
324   double overall_error;
325   double middle;
326   double middle_diff;
327   double diff_0 = 0.0;
328
329   XBT_IN();
330
331   if (fabs(init) < 1e-20) {
332     min = 0.5;
333     max = 0.5;
334   }
335
336   overall_error = 1;
337
338   diff_0 = diff(1e-16, var_cnst);
339   if (diff_0 >= 0) {
340     XBT_CDEBUG(surf_lagrange_dichotomy, "returning 0.0 (diff = %e)", diff_0);
341     XBT_OUT();
342     return 0.0;
343   }
344
345   double min_diff = diff(min, var_cnst);
346   double max_diff = diff(max, var_cnst);
347
348   while (overall_error > min_error) {
349     XBT_CDEBUG(surf_lagrange_dichotomy, "[min, max] = [%1.20f, %1.20f] || diffmin, diffmax = %1.20f, %1.20f",
350                min, max, min_diff, max_diff);
351
352     if (min_diff > 0 && max_diff > 0) {
353       if (min == max) {
354         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing min");
355         min = min / 2.0;
356         min_diff = diff(min, var_cnst);
357       } else {
358         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing max");
359         max = min;
360         max_diff = min_diff;
361       }
362     } else if (min_diff < 0 && max_diff < 0) {
363       if (min == max) {
364         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing max");
365         max = max * 2.0;
366         max_diff = diff(max, var_cnst);
367       } else {
368         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing min");
369         min = max;
370         min_diff = max_diff;
371       }
372     } else if (min_diff < 0 && max_diff > 0) {
373       middle = (max + min) / 2.0;
374       XBT_CDEBUG(surf_lagrange_dichotomy, "Trying (max+min)/2 : %1.20f", middle);
375
376       if ((fabs(min - middle) < 1e-20) || (fabs(max - middle) < 1e-20)){
377         XBT_CWARN(surf_lagrange_dichotomy, "Cannot improve the convergence! min=max=middle=%1.20f, diff = %1.20f."
378                   " Reaching the 'double' limits. Maybe scaling your function would help ([%1.20f,%1.20f]).",
379                   min, max - min, min_diff, max_diff);
380         break;
381       }
382       middle_diff = diff(middle, var_cnst);
383
384       if (middle_diff < 0) {
385         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing min");
386         min = middle;
387         overall_error = max_diff - middle_diff;
388         min_diff = middle_diff;
389       } else if (middle_diff > 0) {
390         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing max");
391         max = middle;
392         overall_error = max_diff - middle_diff;
393         max_diff = middle_diff;
394       } else {
395         overall_error = 0;
396       }
397     } else if (fabs(min_diff) < 1e-20) {
398       max = min;
399       overall_error = 0;
400     } else if (fabs(max_diff) < 1e-20) {
401       min = max;
402       overall_error = 0;
403     } else if (min_diff > 0 && max_diff < 0) {
404       XBT_CWARN(surf_lagrange_dichotomy, "The impossible happened, partial_diff(min) > 0 && partial_diff(max) < 0");
405       xbt_abort();
406     } else {
407       XBT_CWARN(surf_lagrange_dichotomy,
408              "diffmin (%1.20f) or diffmax (%1.20f) are something I don't know, taking no action.",
409              min_diff, max_diff);
410       xbt_abort();
411     }
412   }
413
414   XBT_CDEBUG(surf_lagrange_dichotomy, "returning %e", (min + max) / 2.0);
415   XBT_OUT();
416   return ((min + max) / 2.0);
417 }
418
419 static double partial_diff_lambda(double lambda, void *param_cnst)
420 {
421   lmm_constraint_t cnst = static_cast<lmm_constraint_t>(param_cnst);
422   double diff = 0.0;
423
424   XBT_IN();
425
426   XBT_CDEBUG(surf_lagrange_dichotomy, "Computing diff of cnst (%p)", cnst);
427
428   xbt_swag_t elem_list = &(cnst->enabled_element_set);
429   void* _elem;
430   xbt_swag_foreach(_elem, elem_list) {
431     lmm_element_t elem = static_cast<lmm_element_t>(_elem);
432     lmm_variable_t var = elem->variable;
433     xbt_assert(var->sharing_weight > 0);
434     XBT_CDEBUG(surf_lagrange_dichotomy, "Computing sigma_i for var (%p)", var);
435     // Initialize the summation variable
436     double sigma_i = 0.0;
437
438     // Compute sigma_i
439     for (s_lmm_element_t const& elem : var->cnsts) {
440       sigma_i += elem.constraint->lambda;
441     }
442
443     //add mu_i if this flow has a RTT constraint associated
444     if (var->bound > 0)
445       sigma_i += var->mu;
446
447     //replace value of cnst->lambda by the value of parameter lambda
448     sigma_i = (sigma_i - cnst->lambda) + lambda;
449
450     diff += -var->func_fpi(var, sigma_i);
451   }
452
453   diff += cnst->bound;
454
455   XBT_CDEBUG(surf_lagrange_dichotomy, "d D/d lambda for cnst (%p) at %1.20f = %1.20f", cnst, lambda, diff);
456   XBT_OUT();
457   return diff;
458 }
459
460 /** \brief Attribute the value bound to var->bound.
461  *
462  *  \param func_fpi  inverse of the partial differential of f (f prime inverse, (f')^{-1})
463  *
464  *  Set default functions to the ones passed as parameters. This is a polymorphism in C pure, enjoy the roots of
465  *  programming.
466  *
467  */
468 void lmm_set_default_protocol_function(double (*func_f) (lmm_variable_t var, double x),
469                                        double (*func_fp) (lmm_variable_t var, double x),
470                                        double (*func_fpi) (lmm_variable_t var, double x))
471 {
472   func_f_def = func_f;
473   func_fp_def = func_fp;
474   func_fpi_def = func_fpi;
475 }
476
477 /**************** Vegas and Reno functions *************************/
478 /* NOTE for Reno: all functions consider the network coefficient (alpha) equal to 1. */
479
480 /*
481  * For Vegas: $f(x) = \alpha D_f\ln(x)$
482  * Therefore: $fp(x) = \frac{\alpha D_f}{x}$
483  * Therefore: $fpi(x) = \frac{\alpha D_f}{x}$
484  */
485 #define VEGAS_SCALING 1000.0
486
487 double func_vegas_f(lmm_variable_t var, double x)
488 {
489   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
490   return VEGAS_SCALING * var->sharing_weight * log(x);
491 }
492
493 double func_vegas_fp(lmm_variable_t var, double x)
494 {
495   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
496   return VEGAS_SCALING * var->sharing_weight / x;
497 }
498
499 double func_vegas_fpi(lmm_variable_t var, double x)
500 {
501   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
502   return var->sharing_weight / (x / VEGAS_SCALING);
503 }
504
505 /*
506  * For Reno:  $f(x) = \frac{\sqrt{3/2}}{D_f} atan(\sqrt{3/2}D_f x)$
507  * Therefore: $fp(x)  = \frac{3}{3 D_f^2 x^2+2}$
508  * Therefore: $fpi(x)  = \sqrt{\frac{1}{{D_f}^2 x} - \frac{2}{3{D_f}^2}}$
509  */
510 #define RENO_SCALING 1.0
511 double func_reno_f(lmm_variable_t var, double x)
512 {
513   xbt_assert(var->sharing_weight > 0.0, "Don't call me with stupid values!");
514
515   return RENO_SCALING * sqrt(3.0 / 2.0) / var->sharing_weight * atan(sqrt(3.0 / 2.0) * var->sharing_weight * x);
516 }
517
518 double func_reno_fp(lmm_variable_t var, double x)
519 {
520   return RENO_SCALING * 3.0 / (3.0 * var->sharing_weight * var->sharing_weight * x * x + 2.0);
521 }
522
523 double func_reno_fpi(lmm_variable_t var, double x)
524 {
525   double res_fpi;
526
527   xbt_assert(var->sharing_weight > 0.0, "Don't call me with stupid values!");
528   xbt_assert(x > 0.0, "Don't call me with stupid values!");
529
530   res_fpi = 1.0 / (var->sharing_weight * var->sharing_weight * (x / RENO_SCALING)) -
531             2.0 / (3.0 * var->sharing_weight * var->sharing_weight);
532   if (res_fpi <= 0.0)
533     return 0.0;
534   return sqrt(res_fpi);
535 }
536
537 /* Implementing new Reno-2
538  * For Reno-2:  $f(x)   = U_f(x_f) = \frac{{2}{D_f}}*ln(2+x*D_f)$
539  * Therefore:   $fp(x)  = 2/(Weight*x + 2)
540  * Therefore:   $fpi(x) = (2*Weight)/x - 4
541  */
542 #define RENO2_SCALING 1.0
543 double func_reno2_f(lmm_variable_t var, double x)
544 {
545   xbt_assert(var->sharing_weight > 0.0, "Don't call me with stupid values!");
546   return RENO2_SCALING * (1.0 / var->sharing_weight) *
547          log((x * var->sharing_weight) / (2.0 * x * var->sharing_weight + 3.0));
548 }
549
550 double func_reno2_fp(lmm_variable_t var, double x)
551 {
552   return RENO2_SCALING * 3.0 / (var->sharing_weight * x * (2.0 * var->sharing_weight * x + 3.0));
553 }
554
555 double func_reno2_fpi(lmm_variable_t var, double x)
556 {
557   xbt_assert(x > 0.0, "Don't call me with stupid values!");
558   double tmp     = x * var->sharing_weight * var->sharing_weight;
559   double res_fpi = tmp * (9.0 * x + 24.0);
560
561   if (res_fpi <= 0.0)
562     return 0.0;
563
564   res_fpi = RENO2_SCALING * (-3.0 * tmp + sqrt(res_fpi)) / (4.0 * tmp);
565   return res_fpi;
566 }
567 }
568 }