src/kernel/lmm/lagrange.cpp

   1 /* Copyright (c) 2007-2019. 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_,
  51               cnst.lambda_);
  52   }
  53
  54   for (Variable const& var : variable_set) {
  55     if (not var.sharing_weight_)
  56       break;
  57     if (var.bound_ < 0)
  58       continue;
  59     XBT_DEBUG("Checking feasability for variable (%p): sat = %f mu = %f", &var, var.value_ - var.bound_, var.mu_);
  60
  61     if (double_positive(var.value_ - var.bound_, sg_maxmin_precision)) {
  62       if (warn)
  63         XBT_WARN("The variable (%p) is too large. Expected less than %f and got %f", &var, var.bound_, var.value_);
  64       return false;
  65     }
  66   }
  67   return true;
  68 }
  69
  70 double Lagrange::new_value(const Variable& var)
  71 {
  72   double tmp = 0;
  73
  74   for (Element const& elem : var.cnsts_) {
  75     tmp += elem.constraint->lambda_;
  76   }
  77   if (var.bound_ > 0)
  78     tmp += var.mu_;
  79   XBT_DEBUG("\t Working on var (%p). cost = %e; Weight = %e", &var, tmp, var.sharing_weight_);
  80   // uses the partial differential inverse function
  81   return func_fpi(var, tmp);
  82 }
  83
  84 double Lagrange::new_mu(const Variable& var)
  85 {
  86   double mu_i    = 0.0;
  87   double sigma_i = 0.0;
  88
  89   for (Element const& elem : var.cnsts_) {
  90     sigma_i += elem.constraint->lambda_;
  91   }
  92   mu_i = func_fp(var, var.bound_) - sigma_i;
  93   if (mu_i < 0.0)
  94     return 0.0;
  95   return mu_i;
  96 }
  97
  98 double Lagrange::dual_objective()
  99 {
 100   double obj = 0.0;
 101
 102   for (Variable const& var : variable_set) {
 103     double sigma_i = 0.0;
 104
 105     if (not var.sharing_weight_)
 106       break;
 107
 108     for (Element const& elem : var.cnsts_)
 109       sigma_i += elem.constraint->lambda_;
 110
 111     if (var.bound_ > 0)
 112       sigma_i += var.mu_;
 113
 114     XBT_DEBUG("var %p : sigma_i = %1.20f", &var, sigma_i);
 115
 116     obj += func_f(var, func_fpi(var, sigma_i)) - sigma_i * func_fpi(var, sigma_i);
 117
 118     if (var.bound_ > 0)
 119       obj += var.mu_ * var.bound_;
 120   }
 121
 122   for (Constraint const& cnst : active_constraint_set)
 123     obj += cnst.lambda_ * cnst.bound_;
 124
 125   return obj;
 126 }
 127
 128 // solves the proportional fairness using a Lagrangian optimization with dichotomy step
 129 void Lagrange::lagrange_solve()
 130 {
 131   /* Lagrange Variables. */
 132   int max_iterations       = 100;
 133   double epsilon_min_error = 0.00001; /* this is the precision on the objective function so it's none of the
 134                                          configurable values and this value is the legacy one */
 135   double dichotomy_min_error  = 1e-14;
 136   double overall_modification = 1;
 137
 138   XBT_DEBUG("Iterative method configuration snapshot =====>");
 139   XBT_DEBUG("#### Maximum number of iterations        : %d", max_iterations);
 140   XBT_DEBUG("#### Minimum error tolerated             : %e", epsilon_min_error);
 141   XBT_DEBUG("#### Minimum error tolerated (dichotomy) : %e", dichotomy_min_error);
 142
 143   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
 144     print();
 145   }
 146
 147   if (not modified_)
 148     return;
 149
 150   /* Initialize lambda. */
 151   for (Constraint& cnst : active_constraint_set) {
 152     cnst.lambda_     = 1.0;
 153     cnst.new_lambda_ = 2.0;
 154     XBT_DEBUG("#### cnst(%p)->lambda :  %e", &cnst, cnst.lambda_);
 155   }
 156
 157   /*
 158    * Initialize the active variables. Initialize mu.
 159    */
 160   for (Variable& var : variable_set) {
 161     if (not var.sharing_weight_)
 162       var.value_ = 0.0;
 163     else {
 164       if (var.bound_ < 0.0) {
 165         XBT_DEBUG("#### NOTE var(%p) is a boundless variable", &var);
 166         var.mu_ = -1.0;
 167       } else {
 168         var.mu_     = 1.0;
 169         var.new_mu_ = 2.0;
 170       }
 171       var.value_ = new_value(var);
 172       XBT_DEBUG("#### var(%p) ->weight :  %e", &var, var.sharing_weight_);
 173       XBT_DEBUG("#### var(%p) ->mu :  %e", &var, var.mu_);
 174       XBT_DEBUG("#### var(%p) ->weight: %e", &var, var.sharing_weight_);
 175       XBT_DEBUG("#### var(%p) ->bound: %e", &var, var.bound_);
 176       auto weighted = std::find_if(begin(var.cnsts_), end(var.cnsts_),
 177                                    [](Element const& x) { return x.consumption_weight != 0.0; });
 178       if (weighted == end(var.cnsts_))
 179         var.value_ = 1.0;
 180     }
 181   }
 182
 183   /*  Compute dual objective. */
 184   double obj = dual_objective();
 185
 186   /* While doesn't reach a minimum error or a number maximum of iterations. */
 187   int iteration = 0;
 188   while (overall_modification > epsilon_min_error && iteration < max_iterations) {
 189     iteration++;
 190     XBT_DEBUG("************** ITERATION %d **************", iteration);
 191     XBT_DEBUG("-------------- Gradient Descent ----------");
 192
 193     /* Improve the value of mu_i */
 194     for (Variable& var : variable_set) {
 195       if (var.sharing_weight_ && var.bound_ >= 0) {
 196         XBT_DEBUG("Working on var (%p)", &var);
 197         var.new_mu_ = new_mu(var);
 198         XBT_DEBUG("Updating mu : var->mu (%p) : %1.20f -> %1.20f", &var, var.mu_, var.new_mu_);
 199         var.mu_ = var.new_mu_;
 200
 201         double new_obj = dual_objective();
 202         XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
 203         xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
 204         obj = new_obj;
 205       }
 206     }
 207
 208     /* Improve the value of lambda_i */
 209     for (Constraint& cnst : active_constraint_set) {
 210       XBT_DEBUG("Working on cnst (%p)", &cnst);
 211       cnst.new_lambda_ = dichotomy(cnst.lambda_, cnst, dichotomy_min_error);
 212       XBT_DEBUG("Updating lambda : cnst->lambda (%p) : %1.20f -> %1.20f", &cnst, cnst.lambda_, cnst.new_lambda_);
 213       cnst.lambda_ = cnst.new_lambda_;
 214
 215       double new_obj = dual_objective();
 216       XBT_DEBUG("Improvement for Objective (%g -> %g) : %g", obj, new_obj, obj - new_obj);
 217       xbt_assert(obj - new_obj >= -epsilon_min_error, "Our gradient sucks! (%1.20f)", obj - new_obj);
 218       obj = new_obj;
 219     }
 220
 221     /* Now computes the values of each variable (@rho) based on the values of @lambda and @mu. */
 222     XBT_DEBUG("-------------- Check convergence ----------");
 223     overall_modification = 0;
 224     for (Variable& var : variable_set) {
 225       if (var.sharing_weight_ <= 0)
 226         var.value_ = 0.0;
 227       else {
 228         double tmp = new_value(var);
 229
 230         overall_modification = std::max(overall_modification, fabs(var.value_ - tmp));
 231
 232         var.value_ = tmp;
 233         XBT_DEBUG("New value of var (%p)  = %e, overall_modification = %e", &var, var.value_, overall_modification);
 234       }
 235     }
 236
 237     XBT_DEBUG("-------------- Check feasability ----------");
 238     if (not check_feasible(false))
 239       overall_modification = 1.0;
 240     XBT_DEBUG("Iteration %d: overall_modification : %f", iteration, overall_modification);
 241   }
 242
 243   check_feasible(true);
 244
 245   if (overall_modification <= epsilon_min_error) {
 246     XBT_DEBUG("The method converges in %d iterations.", iteration);
 247   }
 248   if (iteration >= max_iterations) {
 249     XBT_DEBUG("Method reach %d iterations, which is the maximum number of iterations allowed.", iteration);
 250   }
 251
 252   if (XBT_LOG_ISENABLED(surf_lagrange, xbt_log_priority_debug)) {
 253     print();
 254   }
 255 }
 256
 257 /*
 258  * Returns a double value corresponding to the result of a dichotomy process with respect to a given
 259  * variable/constraint (@mu in the case of a variable or @lambda in case of a constraint) and a initial value init.
 260  *
 261  * @param init initial value for @mu or @lambda
 262  * @param diff a function that computes the differential of with respect a @mu or @lambda
 263  * @param var_cnst a pointer to a variable or constraint
 264  * @param min_erro a minimum error tolerated
 265  *
 266  * @return a double corresponding to the result of the dichotomy process
 267  */
 268 double Lagrange::dichotomy(double init, const Constraint& cnst, 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 = partial_diff_lambda(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 = partial_diff_lambda(min, cnst);
 294   double max_diff = partial_diff_lambda(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 = partial_diff_lambda(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 = partial_diff_lambda(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 = partial_diff_lambda(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 f    function (f)
 407  *  @param fp   partial differential of f (f prime, (f'))
 408  *  @param 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 (*f)(const Variable& var, double x),
 413                                              double (*fp)(const Variable& var, double x),
 414                                              double (*fpi)(const Variable& var, double x))
 415 {
 416   func_f   = f;
 417   func_fp  = fp;
 418   func_fpi = 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 }