Logo AND Algorithmique Numérique Distribuée

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