Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fbd9ebff93b192cb3abe203ef5d7bea57b816a93
[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, void*), void* var_cnst, double min_error);
43 // computes the value of the differential of constraint param_cnst applied to lambda
44 static double partial_diff_lambda(double lambda, void* param_cnst);
45
46 static int __check_feasible(xbt_swag_t cnst_list, xbt_swag_t var_list, int warn)
47 {
48   void* _cnst;
49   void* _elem;
50   void* _var;
51   xbt_swag_t elem_list  = nullptr;
52   lmm_element_t elem    = nullptr;
53   lmm_constraint_t cnst = nullptr;
54   lmm_variable_t var    = nullptr;
55
56   xbt_swag_foreach(_cnst, cnst_list)
57   {
58     cnst       = static_cast<lmm_constraint_t>(_cnst);
59     double tmp = 0;
60     elem_list  = &(cnst->enabled_element_set);
61     xbt_swag_foreach(_elem, elem_list)
62     {
63       elem = static_cast<lmm_element_t>(_elem);
64       var  = elem->variable;
65       xbt_assert(var->sharing_weight > 0);
66       tmp += var->value;
67     }
68
69     if (double_positive(tmp - cnst->bound, sg_maxmin_precision)) {
70       if (warn)
71         XBT_WARN("The link (%p) is over-used. Expected less than %f and got %f", cnst, cnst->bound, tmp);
72       return 0;
73     }
74     XBT_DEBUG("Checking feasability for constraint (%p): sat = %f, lambda = %f ", cnst, tmp - cnst->bound,
75               cnst->lambda);
76   }
77
78   xbt_swag_foreach(_var, var_list)
79   {
80     var = static_cast<lmm_variable_t>(_var);
81     if (not var->sharing_weight)
82       break;
83     if (var->bound < 0)
84       continue;
85     XBT_DEBUG("Checking feasability for variable (%p): sat = %f mu = %f", var, var->value - var->bound, var->mu);
86
87     if (double_positive(var->value - var->bound, sg_maxmin_precision)) {
88       if (warn)
89         XBT_WARN("The variable (%p) is too large. Expected less than %f and got %f", var, var->bound, var->value);
90       return 0;
91     }
92   }
93   return 1;
94 }
95
96 static double new_value(lmm_variable_t var)
97 {
98   double tmp = 0;
99
100   for (s_lmm_element_t const& elem : var->cnsts) {
101     tmp += elem.constraint->lambda;
102   }
103   if (var->bound > 0)
104     tmp += var->mu;
105   XBT_DEBUG("\t Working on var (%p). cost = %e; Weight = %e", var, tmp, var->sharing_weight);
106   // uses the partial differential inverse function
107   return var->func_fpi(*var, tmp);
108 }
109
110 static double new_mu(lmm_variable_t var)
111 {
112   double mu_i    = 0.0;
113   double sigma_i = 0.0;
114
115   for (s_lmm_element_t const& elem : var->cnsts) {
116     sigma_i += elem.constraint->lambda;
117   }
118   mu_i = var->func_fp(*var, var->bound) - sigma_i;
119   if (mu_i < 0.0)
120     return 0.0;
121   return mu_i;
122 }
123
124 static double dual_objective(xbt_swag_t var_list, xbt_swag_t cnst_list)
125 {
126   void* _cnst;
127   void* _var;
128   lmm_constraint_t cnst = nullptr;
129   lmm_variable_t var    = nullptr;
130
131   double obj = 0.0;
132
133   xbt_swag_foreach(_var, var_list)
134   {
135     var            = static_cast<lmm_variable_t>(_var);
136     double sigma_i = 0.0;
137
138     if (not var->sharing_weight)
139       break;
140
141     for (s_lmm_element_t const& elem : var->cnsts)
142       sigma_i += elem.constraint->lambda;
143
144     if (var->bound > 0)
145       sigma_i += var->mu;
146
147     XBT_DEBUG("var %p : sigma_i = %1.20f", var, sigma_i);
148
149     obj += var->func_f(*var, var->func_fpi(*var, sigma_i)) - sigma_i * var->func_fpi(*var, sigma_i);
150
151     if (var->bound > 0)
152       obj += var->mu * var->bound;
153   }
154
155   xbt_swag_foreach(_cnst, cnst_list)
156   {
157     cnst = static_cast<lmm_constraint_t>(_cnst);
158     obj += cnst->lambda * cnst->bound;
159   }
160
161   return obj;
162 }
163
164 void lagrange_solve(lmm_system_t sys)
165 {
166   /* Lagrange Variables. */
167   int max_iterations       = 100;
168   double epsilon_min_error = 0.00001; /* this is the precision on the objective function so it's none of the
169                                          configurable values and this value is the legacy one */
170   double dichotomy_min_error  = 1e-14;
171   double overall_modification = 1;
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     sys->print();
180   }
181
182   if (not sys->modified)
183     return;
184
185   /* Initialize lambda. */
186   xbt_swag_t cnst_list = &(sys->active_constraint_set);
187   void* _cnst;
188   xbt_swag_foreach(_cnst, cnst_list)
189   {
190     lmm_constraint_t cnst = (lmm_constraint_t)_cnst;
191     cnst->lambda          = 1.0;
192     cnst->new_lambda      = 2.0;
193     XBT_DEBUG("#### cnst(%p)->lambda :  %e", cnst, cnst->lambda);
194   }
195
196   /*
197    * Initialize the var list variable with only the active variables.
198    * Associate an index in the swag variables. Initialize mu.
199    */
200   xbt_swag_t var_list = &(sys->variable_set);
201   void* _var;
202   xbt_swag_foreach(_var, var_list)
203   {
204     lmm_variable_t var = static_cast<lmm_variable_t>(_var);
205     if (not var->sharing_weight)
206       var->value = 0.0;
207     else {
208       if (var->bound < 0.0) {
209         XBT_DEBUG("#### NOTE var(%p) is a boundless variable", var);
210         var->mu = -1.0;
211       } else {
212         var->mu     = 1.0;
213         var->new_mu = 2.0;
214       }
215       var->value = new_value(var);
216       XBT_DEBUG("#### var(%p) ->weight :  %e", var, var->sharing_weight);
217       XBT_DEBUG("#### var(%p) ->mu :  %e", var, var->mu);
218       XBT_DEBUG("#### var(%p) ->weight: %e", var, var->sharing_weight);
219       XBT_DEBUG("#### var(%p) ->bound: %e", var, var->bound);
220       auto weighted = std::find_if(begin(var->cnsts), end(var->cnsts),
221                                    [](s_lmm_element_t const& x) { return x.consumption_weight != 0.0; });
222       if (weighted == end(var->cnsts))
223         var->value = 1.0;
224     }
225   }
226
227   /*  Compute dual objective. */
228   double obj = dual_objective(var_list, cnst_list);
229
230   /* While doesn't reach a minimum error or a number maximum of iterations. */
231   int iteration = 0;
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     {
240       lmm_variable_t var = static_cast<lmm_variable_t>(_var);
241       if (var->sharing_weight && var->bound >= 0) {
242         XBT_DEBUG("Working on var (%p)", var);
243         var->new_mu = new_mu(var);
244         XBT_DEBUG("Updating mu : var->mu (%p) : %1.20f -> %1.20f", var, var->mu, var->new_mu);
245         var->mu = var->new_mu;
246
247         double new_obj = dual_objective(var_list, cnst_list);
248         XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
249         xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
250         obj = new_obj;
251       }
252     }
253
254     /* Improve the value of lambda_i */
255     xbt_swag_foreach(_cnst, cnst_list)
256     {
257       lmm_constraint_t 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       double 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     {
274       lmm_variable_t var = static_cast<lmm_variable_t>(_var);
275       if (var->sharing_weight <= 0)
276         var->value = 0.0;
277       else {
278         double tmp = new_value(var);
279
280         overall_modification = std::max(overall_modification, fabs(var->value - tmp));
281
282         var->value = tmp;
283         XBT_DEBUG("New value of var (%p)  = %e, overall_modification = %e", var, var->value, overall_modification);
284       }
285     }
286
287     XBT_DEBUG("-------------- Check feasability ----------");
288     if (not __check_feasible(cnst_list, var_list, 0))
289       overall_modification = 1.0;
290     XBT_DEBUG("Iteration %d: overall_modification : %f", iteration, overall_modification);
291   }
292
293   __check_feasible(cnst_list, var_list, 1);
294
295   if (overall_modification <= epsilon_min_error) {
296     XBT_DEBUG("The method converges in %d iterations.", iteration);
297   }
298   if (iteration >= max_iterations) {
299     XBT_DEBUG("Method reach %d iterations, which is the maximum number of iterations allowed.", iteration);
300   }
301
302   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
303     sys->print();
304   }
305 }
306
307 /*
308  * Returns a double value corresponding to the result of a dichotomy process with respect to a given
309  * variable/constraint (\mu in the case of a variable or \lambda in case of a constraint) and a initial value init.
310  *
311  * @param init initial value for \mu or \lambda
312  * @param diff a function that computes the differential of with respect a \mu or \lambda
313  * @param var_cnst a pointer to a variable or constraint
314  * @param min_erro a minimum error tolerated
315  *
316  * @return a double corresponding to the result of the dichotomy process
317  */
318 static double dichotomy(double init, double diff(double, void*), void* var_cnst, double min_error)
319 {
320   double min = init;
321   double max = init;
322   double overall_error;
323   double middle;
324   double middle_diff;
325   double diff_0 = 0.0;
326
327   XBT_IN();
328
329   if (fabs(init) < 1e-20) {
330     min = 0.5;
331     max = 0.5;
332   }
333
334   overall_error = 1;
335
336   diff_0 = diff(1e-16, var_cnst);
337   if (diff_0 >= 0) {
338     XBT_CDEBUG(surf_lagrange_dichotomy, "returning 0.0 (diff = %e)", diff_0);
339     XBT_OUT();
340     return 0.0;
341   }
342
343   double min_diff = diff(min, var_cnst);
344   double max_diff = diff(max, var_cnst);
345
346   while (overall_error > min_error) {
347     XBT_CDEBUG(surf_lagrange_dichotomy, "[min, max] = [%1.20f, %1.20f] || diffmin, diffmax = %1.20f, %1.20f", min, max,
348                min_diff, max_diff);
349
350     if (min_diff > 0 && max_diff > 0) {
351       if (min == max) {
352         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing min");
353         min      = min / 2.0;
354         min_diff = diff(min, var_cnst);
355       } else {
356         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing max");
357         max      = min;
358         max_diff = min_diff;
359       }
360     } else if (min_diff < 0 && max_diff < 0) {
361       if (min == max) {
362         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing max");
363         max      = max * 2.0;
364         max_diff = diff(max, var_cnst);
365       } else {
366         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing min");
367         min      = max;
368         min_diff = max_diff;
369       }
370     } else if (min_diff < 0 && max_diff > 0) {
371       middle = (max + min) / 2.0;
372       XBT_CDEBUG(surf_lagrange_dichotomy, "Trying (max+min)/2 : %1.20f", middle);
373
374       if ((fabs(min - middle) < 1e-20) || (fabs(max - middle) < 1e-20)) {
375         XBT_CWARN(surf_lagrange_dichotomy,
376                   "Cannot improve the convergence! min=max=middle=%1.20f, diff = %1.20f."
377                   " Reaching the 'double' limits. Maybe scaling your function would help ([%1.20f,%1.20f]).",
378                   min, max - min, min_diff, max_diff);
379         break;
380       }
381       middle_diff = diff(middle, var_cnst);
382
383       if (middle_diff < 0) {
384         XBT_CDEBUG(surf_lagrange_dichotomy, "Increasing min");
385         min           = middle;
386         overall_error = max_diff - middle_diff;
387         min_diff      = middle_diff;
388       } else if (middle_diff > 0) {
389         XBT_CDEBUG(surf_lagrange_dichotomy, "Decreasing max");
390         max           = middle;
391         overall_error = max_diff - middle_diff;
392         max_diff      = middle_diff;
393       } else {
394         overall_error = 0;
395       }
396     } else if (fabs(min_diff) < 1e-20) {
397       max           = min;
398       overall_error = 0;
399     } else if (fabs(max_diff) < 1e-20) {
400       min           = max;
401       overall_error = 0;
402     } else if (min_diff > 0 && max_diff < 0) {
403       XBT_CWARN(surf_lagrange_dichotomy, "The impossible happened, partial_diff(min) > 0 && partial_diff(max) < 0");
404       xbt_abort();
405     } else {
406       XBT_CWARN(surf_lagrange_dichotomy,
407                 "diffmin (%1.20f) or diffmax (%1.20f) are something I don't know, taking no action.", min_diff,
408                 max_diff);
409       xbt_abort();
410     }
411   }
412
413   XBT_CDEBUG(surf_lagrange_dichotomy, "returning %e", (min + max) / 2.0);
414   XBT_OUT();
415   return ((min + max) / 2.0);
416 }
417
418 static double partial_diff_lambda(double lambda, void* param_cnst)
419 {
420   lmm_constraint_t cnst = static_cast<lmm_constraint_t>(param_cnst);
421   double diff           = 0.0;
422
423   XBT_IN();
424
425   XBT_CDEBUG(surf_lagrange_dichotomy, "Computing diff of cnst (%p)", cnst);
426
427   xbt_swag_t elem_list = &(cnst->enabled_element_set);
428   void* _elem;
429   xbt_swag_foreach(_elem, elem_list)
430   {
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)(const s_lmm_variable_t& var, double x),
469                                        double (*func_fp)(const s_lmm_variable_t& var, double x),
470                                        double (*func_fpi)(const s_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 double func_vegas_f(const s_lmm_variable_t& var, double x)
486 {
487   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
488   return VEGAS_SCALING * var.sharing_weight * log(x);
489 }
490
491 double func_vegas_fp(const s_lmm_variable_t& var, double x)
492 {
493   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
494   return VEGAS_SCALING * var.sharing_weight / x;
495 }
496
497 double func_vegas_fpi(const s_lmm_variable_t& var, double x)
498 {
499   xbt_assert(x > 0.0, "Don't call me with stupid values! (%1.20f)", x);
500   return var.sharing_weight / (x / VEGAS_SCALING);
501 }
502
503 /*
504  * For Reno:  $f(x) = \frac{\sqrt{3/2}}{D_f} atan(\sqrt{3/2}D_f x)$
505  * Therefore: $fp(x)  = \frac{3}{3 D_f^2 x^2+2}$
506  * Therefore: $fpi(x)  = \sqrt{\frac{1}{{D_f}^2 x} - \frac{2}{3{D_f}^2}}$
507  */
508 double func_reno_f(const s_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(const s_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(const s_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 double func_reno2_f(const s_lmm_variable_t& var, double x)
540 {
541   xbt_assert(var.sharing_weight > 0.0, "Don't call me with stupid values!");
542   return RENO2_SCALING * (1.0 / var.sharing_weight) *
543          log((x * var.sharing_weight) / (2.0 * x * var.sharing_weight + 3.0));
544 }
545
546 double func_reno2_fp(const s_lmm_variable_t& var, double x)
547 {
548   return RENO2_SCALING * 3.0 / (var.sharing_weight * x * (2.0 * var.sharing_weight * x + 3.0));
549 }
550
551 double func_reno2_fpi(const s_lmm_variable_t& var, double x)
552 {
553   xbt_assert(x > 0.0, "Don't call me with stupid values!");
554   double tmp     = x * var.sharing_weight * var.sharing_weight;
555   double res_fpi = tmp * (9.0 * x + 24.0);
556
557   if (res_fpi <= 0.0)
558     return 0.0;
559
560   res_fpi = RENO2_SCALING * (-3.0 * tmp + sqrt(res_fpi)) / (4.0 * tmp);
561   return res_fpi;
562 }
563 }
564 }
565 }