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