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