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