src/surf/lagrange.c

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