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