src/kernel/lmm/lagrange.cpp

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