Logo AND Algorithmique Numérique Distribuée

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