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