src/surf/maxmin.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8
   9 #include "xbt/sysdep.h"
  10 #include "xbt/log.h"
  11 #include "xbt/mallocator.h"
  12 #include "maxmin_private.h"
  13 #include <stdlib.h>
  14 #include <math.h>
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_maxmin, surf,
  16                                 "Logging specific to SURF (maxmin)");
  17
  18 static void* lmm_variable_mallocator_new_f(void);
  19 static void lmm_variable_mallocator_free_f(void *var);
  20 static void lmm_variable_mallocator_reset_f(void *var);
  21
  22 lmm_system_t lmm_system_new(void)
  23 {
  24   lmm_system_t l = NULL;
  25   s_lmm_variable_t var;
  26   s_lmm_constraint_t cnst;
  27
  28   l = xbt_new0(s_lmm_system_t, 1);
  29
  30   l->modified = 0;
  31   xbt_swag_init(&(l->variable_set),
  32                 xbt_swag_offset(var, variable_set_hookup));
  33   xbt_swag_init(&(l->constraint_set),
  34                 xbt_swag_offset(cnst, constraint_set_hookup));
  35
  36   xbt_swag_init(&(l->active_constraint_set),
  37                 xbt_swag_offset(cnst, active_constraint_set_hookup));
  38
  39   xbt_swag_init(&(l->saturated_variable_set),
  40                 xbt_swag_offset(var, saturated_variable_set_hookup));
  41   xbt_swag_init(&(l->saturated_constraint_set),
  42                 xbt_swag_offset(cnst, saturated_constraint_set_hookup));
  43
  44   l->variable_mallocator = xbt_mallocator_new(64,
  45                                               lmm_variable_mallocator_new_f,
  46                                               lmm_variable_mallocator_free_f,
  47                                               lmm_variable_mallocator_reset_f);
  48
  49   return l;
  50 }
  51
  52 void lmm_system_free(lmm_system_t sys)
  53 {
  54   lmm_variable_t var = NULL;
  55   lmm_constraint_t cnst = NULL;
  56
  57   while ((var = extract_variable(sys)))
  58     lmm_var_free(sys, var);
  59
  60   while ((cnst = extract_constraint(sys)))
  61     lmm_cnst_free(sys, cnst);
  62
  63   xbt_mallocator_free(sys->variable_mallocator);
  64   free(sys);
  65 }
  66
  67 void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
  68 {
  69   int i;
  70   lmm_element_t elem = NULL;
  71
  72   XBT_IN2("(sys=%p, var=%p)",sys,var);
  73   sys->modified = 1;
  74
  75   for (i = 0; i < var->cnsts_number; i++) {
  76     elem = &var->cnsts[i];
  77     xbt_swag_remove(elem, &(elem->constraint->element_set));
  78     xbt_swag_remove(elem, &(elem->constraint->active_element_set));
  79     if (!xbt_swag_size(&(elem->constraint->element_set)))
  80       make_constraint_inactive(sys, elem->constraint);
  81   }
  82   var->cnsts_number = 0;
  83   XBT_OUT;
  84 }
  85
  86 static void lmm_var_free(lmm_system_t sys, lmm_variable_t var)
  87 {
  88
  89   lmm_variable_disable(sys, var);
  90   free(var->cnsts);
  91   xbt_mallocator_release(sys->variable_mallocator, var);
  92 }
  93
  94 static void lmm_cnst_free(lmm_system_t sys, lmm_constraint_t cnst)
  95 {
  96 /*   xbt_assert0(xbt_swag_size(&(cnst->element_set)), */
  97 /*            "This list should be empty!"); */
  98   remove_active_constraint(sys, cnst);
  99   free(cnst);
 100 }
 101
 102 lmm_constraint_t lmm_constraint_new(lmm_system_t sys, void *id,
 103                                     double bound_value)
 104 {
 105   lmm_constraint_t cnst = NULL;
 106   s_lmm_element_t elem;
 107
 108   cnst = xbt_new0(s_lmm_constraint_t, 1);
 109   cnst->id = id;
 110   xbt_swag_init(&(cnst->element_set),
 111                 xbt_swag_offset(elem, element_set_hookup));
 112   xbt_swag_init(&(cnst->active_element_set),
 113                 xbt_swag_offset(elem, active_element_set_hookup));
 114
 115   cnst->bound = bound_value;
 116   cnst->usage = 0;
 117   cnst->shared = 1;
 118   insert_constraint(sys, cnst);
 119
 120   return cnst;
 121 }
 122
 123 void lmm_constraint_shared(lmm_constraint_t cnst)
 124 {
 125   cnst->shared = 0;
 126 }
 127
 128 void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst)
 129 {
 130   remove_constraint(sys, cnst);
 131   lmm_cnst_free(sys, cnst);
 132 }
 133
 134 static void* lmm_variable_mallocator_new_f(void) {
 135   return xbt_new(s_lmm_variable_t, 1);
 136 }
 137
 138 static void lmm_variable_mallocator_free_f(void *var) {
 139   xbt_free(var);
 140 }
 141
 142 static void lmm_variable_mallocator_reset_f(void *var) {
 143   /* memset to zero like calloc */
 144   memset(var, 0, sizeof(s_lmm_variable_t));
 145 }
 146
 147 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
 148                                 double weight,
 149                                 double bound, int number_of_constraints)
 150 {
 151   lmm_variable_t var = NULL;
 152   int i;
 153
 154   XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
 155           sys,id,weight,bound,number_of_constraints);
 156
 157   var = xbt_mallocator_get(sys->variable_mallocator);
 158   var->id = id;
 159   var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
 160   for(i=0; i<number_of_constraints; i++) {
 161     /* Should be useless because of the
 162        calloc but it seems to help valgrind... */
 163     var->cnsts[i].element_set_hookup.next = NULL;
 164     var->cnsts[i].element_set_hookup.prev = NULL;
 165     var->cnsts[i].active_element_set_hookup.next = NULL;
 166     var->cnsts[i].active_element_set_hookup.prev = NULL;
 167     var->cnsts[i].constraint = NULL;
 168     var->cnsts[i].variable = NULL;
 169     var->cnsts[i].value = 0.0;
 170   }
 171   var->cnsts_size = number_of_constraints;
 172   var->cnsts_number = 0; /* Should be useless because of the
 173                             calloc but it seems to help valgrind... */
 174   var->weight = weight;
 175   var->bound = bound;
 176   var->value = 0.0;
 177   var->df    = 0.0;
 178
 179   var->func_f    = func_f_def;
 180   var->func_fp   = func_fp_def;
 181   var->func_fpi  = func_fpi_def;
 182   var->func_fpip = func_fpip_def;
 183
 184   if(weight) xbt_swag_insert_at_head(var,&(sys->variable_set));
 185   else xbt_swag_insert_at_tail(var,&(sys->variable_set));
 186   XBT_OUT;
 187   return var;
 188 }
 189
 190 void lmm_variable_free(lmm_system_t sys, lmm_variable_t var)
 191 {
 192   remove_variable(sys, var);
 193   lmm_var_free(sys, var);
 194 }
 195
 196 double lmm_variable_getvalue(lmm_variable_t var)
 197 {
 198   return (var->value);
 199 }
 200
 201 void lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
 202                 lmm_variable_t var, double value)
 203 {
 204   lmm_element_t elem = NULL;
 205
 206   sys->modified = 1;
 207
 208   xbt_assert0(var->cnsts_number < var->cnsts_size,
 209               "Too much constraints");
 210
 211   elem = &(var->cnsts[var->cnsts_number++]);
 212
 213   elem->value = value;
 214   elem->constraint = cnst;
 215   elem->variable = var;
 216
 217   if(var->weight) xbt_swag_insert_at_head(elem,&(elem->constraint->element_set));
 218   else xbt_swag_insert_at_tail(elem,&(elem->constraint->element_set));
 219
 220   make_constraint_active(sys, cnst);
 221 }
 222
 223 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
 224                     lmm_variable_t var, double value)
 225 {
 226   int i ;
 227   sys->modified = 1;
 228
 229   for(i=0; i< var->cnsts_number ; i++)
 230     if(var->cnsts[i].constraint == cnst) break;
 231
 232   if(i<var->cnsts_number) var->cnsts[i].value +=value;
 233   else lmm_expand(sys,cnst,var,value);
 234 }
 235
 236 void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
 237                         lmm_variable_t var, double value)
 238 {
 239   int i ;
 240
 241   for(i=0; i< var->cnsts_number ; i++)
 242     if(var->cnsts[i].constraint == cnst) break;
 243
 244   if(i<var->cnsts_number) {
 245     var->cnsts[i].value =value;
 246     sys->modified = 1;
 247   } else DIE_IMPOSSIBLE;
 248 }
 249
 250 lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
 251                                        lmm_variable_t var, int num)
 252 {
 253   if (num < var->cnsts_number)
 254     return (var->cnsts[num].constraint);
 255   else
 256     return NULL;
 257 }
 258
 259 int lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var)
 260 {
 261   return (var->cnsts_number);
 262 }
 263
 264 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
 265                                      lmm_constraint_t cnst,
 266                                      lmm_variable_t * var)
 267 {
 268   if (!(*var))
 269     xbt_swag_getFirst(&(cnst->element_set));
 270   else
 271     *var = xbt_swag_getNext(*var, cnst->element_set.offset);
 272   return *var;
 273 }
 274
 275 void *lmm_constraint_id(lmm_constraint_t cnst)
 276 {
 277   return cnst->id;
 278 }
 279
 280 void *lmm_variable_id(lmm_variable_t var)
 281 {
 282   return var->id;
 283 }
 284
 285 static void saturated_constraint_set_update(lmm_system_t sys,
 286                                             lmm_constraint_t cnst,
 287                                             double *min_usage)
 288 {
 289   lmm_constraint_t useless_cnst = NULL;
 290
 291   XBT_IN3("sys=%p, cnst=%p, min_usage=%f",sys,cnst,*min_usage);
 292   if (cnst->usage <= 0) {
 293     XBT_OUT;
 294     return;
 295   }
 296   if (cnst->remaining <= 0) {
 297     XBT_OUT;
 298     return;
 299   }
 300   if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
 301     *min_usage = cnst->remaining / cnst->usage;
 302     LOG3(xbt_log_priority_trace,
 303          "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)",*min_usage,
 304          cnst->remaining, cnst->usage);
 305     while ((useless_cnst =
 306             xbt_swag_getFirst(&(sys->saturated_constraint_set))))
 307       xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
 308
 309     xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
 310   } else if (*min_usage == cnst->remaining / cnst->usage) {
 311     xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
 312   }
 313   XBT_OUT;
 314 }
 315
 316 static void saturated_variable_set_update(lmm_system_t sys)
 317 {
 318   lmm_constraint_t cnst = NULL;
 319   xbt_swag_t cnst_list = NULL;
 320   lmm_element_t elem = NULL;
 321   xbt_swag_t elem_list = NULL;
 322
 323   cnst_list = &(sys->saturated_constraint_set);
 324   while ((cnst = xbt_swag_getFirst(cnst_list))) {
 325     elem_list = &(cnst->active_element_set);
 326     xbt_swag_foreach(elem, elem_list) {
 327       if(elem->variable->weight<=0) break;
 328       if ((elem->value > 0))
 329         xbt_swag_insert(elem->variable, &(sys->saturated_variable_set));
 330     }
 331     xbt_swag_remove(cnst, cnst_list);
 332   }
 333 }
 334
 335 void lmm_print(lmm_system_t sys)
 336
 337 {
 338   lmm_constraint_t cnst = NULL;
 339   lmm_element_t elem = NULL;
 340   lmm_variable_t var = NULL;
 341   xbt_swag_t cnst_list = NULL;
 342   xbt_swag_t var_list = NULL;
 343   xbt_swag_t elem_list = NULL;
 344   char print_buf[1024];
 345   char *trace_buf=xbt_malloc0(sizeof(char));
 346   double sum=0.0;
 347
 348   /* Printing Objective */
 349   var_list = &(sys->variable_set);
 350   sprintf(print_buf,"MAX-MIN ( ");
 351   trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 352   strcat(trace_buf, print_buf);
 353   xbt_swag_foreach(var, var_list) {
 354     sprintf(print_buf,"'%p'(%f) ",var,var->weight);
 355     trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 356     strcat(trace_buf, print_buf);
 357   }
 358   sprintf(print_buf,")");
 359   trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 360   strcat(trace_buf, print_buf);
 361   DEBUG1("%s",trace_buf);
 362   trace_buf[0]='\000';
 363
 364   /* Printing Constraints */
 365   cnst_list = &(sys->active_constraint_set);
 366   xbt_swag_foreach(cnst, cnst_list) {
 367     sum=0.0;
 368     elem_list = &(cnst->element_set);
 369     sprintf(print_buf,"\t");
 370     trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 371     strcat(trace_buf, print_buf);
 372     xbt_swag_foreach(elem, elem_list) {
 373       sprintf(print_buf,"%f.'%p'(%f) + ",elem->value,
 374               elem->variable,elem->variable->value);
 375       trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 376       strcat(trace_buf, print_buf);
 377       sum += elem->value * elem->variable->value;
 378     }
 379     sprintf(print_buf,"0 <= %f ('%p')",cnst->bound,cnst);
 380     trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 381     strcat(trace_buf, print_buf);
 382
 383     if(!cnst->shared) {
 384       sprintf(print_buf," [MAX-Constraint]");
 385       trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
 386       strcat(trace_buf, print_buf);
 387     }
 388     DEBUG1("%s",trace_buf);
 389     trace_buf[0]='\000';
 390     xbt_assert3(!double_positive(sum-cnst->bound), "Incorrect value (%f is not smaller than %f): %g",
 391                 sum,cnst->bound,sum-cnst->bound);
 392   }
 393
 394   /* Printing Result */
 395   xbt_swag_foreach(var, var_list) {
 396     if(var->bound>0) {
 397       DEBUG4("'%p'(%f) : %f (<=%f)",var,var->weight,var->value, var->bound);
 398       xbt_assert0(!double_positive(var->value-var->bound), "Incorrect value");
 399     }
 400     else
 401       DEBUG3("'%p'(%f) : %f",var,var->weight,var->value);
 402   }
 403
 404   free(trace_buf);
 405 }
 406
 407 void lmm_solve(lmm_system_t sys)
 408 {
 409   lmm_variable_t var = NULL;
 410   lmm_constraint_t cnst = NULL;
 411   lmm_element_t elem = NULL;
 412   xbt_swag_t cnst_list = NULL;
 413   xbt_swag_t var_list = NULL;
 414   xbt_swag_t elem_list = NULL;
 415   double min_usage = -1;
 416
 417   if (!(sys->modified))
 418     return;
 419
 420   /* Init */
 421   var_list = &(sys->variable_set);
 422   DEBUG1("Variable set : %d", xbt_swag_size(var_list));
 423   xbt_swag_foreach(var, var_list) {
 424     var->value = 0.0;
 425   }
 426
 427   /*
 428    * Compute Usage and store the variables that reach the maximum.
 429    */
 430   cnst_list = &(sys->active_constraint_set);
 431   DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
 432   xbt_swag_foreach(cnst, cnst_list) {
 433     /* INIT */
 434     cnst->remaining = cnst->bound;
 435     cnst->usage = 0;
 436     elem_list = &(cnst->element_set);
 437     cnst->usage = 0.0;
 438     xbt_swag_foreach(elem, elem_list) {
 439       if(elem->variable->weight <=0) break;
 440       if ((elem->value > 0)) {
 441         if(cnst->shared)
 442           cnst->usage += elem->value / elem->variable->weight;
 443         else
 444           if(cnst->usage<elem->value / elem->variable->weight)
 445             cnst->usage = elem->value / elem->variable->weight;
 446         DEBUG2("Constraint Usage %p : %f",cnst,cnst->usage);
 447         make_elem_active(elem);
 448       }
 449     }
 450     /* Saturated constraints update */
 451     saturated_constraint_set_update(sys, cnst, &min_usage);
 452   }
 453   saturated_variable_set_update(sys);
 454
 455   /* Saturated variables update */
 456
 457   do {
 458     /* Fix the variables that have to be */
 459     var_list = &(sys->saturated_variable_set);
 460
 461     xbt_swag_foreach(var, var_list) {
 462       /* First check if some of these variables have reach their upper
 463          bound and update min_usage accordingly. */
 464       DEBUG5("var=%p, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
 465              var, var->bound, var->weight, min_usage,var->bound * var->weight);
 466       if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
 467         min_usage = var->bound * var->weight;
 468         DEBUG1("Updated min_usage=%f",min_usage);
 469       }
 470     }
 471
 472
 473     while ((var = xbt_swag_getFirst(var_list))) {
 474       int i;
 475
 476       var->value = min_usage / var->weight;
 477       DEBUG5("Min usage: %f, Var(%p)->weight: %f, Var(%p)->value: %f ",min_usage,var,var->weight,var,var->value);
 478
 479
 480       /* Update usage */
 481
 482       for (i = 0; i < var->cnsts_number; i++) {
 483         elem = &var->cnsts[i];
 484         cnst = elem->constraint;
 485         if(cnst->shared) {
 486           double_update(&(cnst->remaining), elem->value * var->value);
 487           double_update(&(cnst->usage), elem->value / var->weight);
 488           make_elem_inactive(elem);
 489         } else { /* FIXME one day: We recompute usage.... :( */
 490           cnst->usage = 0.0;
 491           make_elem_inactive(elem);
 492           xbt_swag_foreach(elem, elem_list) {
 493             if(elem->variable->weight <=0) break;
 494             if(elem->variable->value > 0) break;
 495             if ((elem->value > 0)) {
 496               if(cnst->usage<elem->value / elem->variable->weight)
 497                 cnst->usage = elem->value / elem->variable->weight;
 498               DEBUG2("Constraint Usage %p : %f",cnst,cnst->usage);
 499               make_elem_active(elem);
 500             }
 501           }
 502         }
 503       }
 504       xbt_swag_remove(var, var_list);
 505     }
 506
 507     /* Find out which variables reach the maximum */
 508     cnst_list = &(sys->active_constraint_set);
 509     min_usage = -1;
 510     xbt_swag_foreach(cnst, cnst_list) {
 511       saturated_constraint_set_update(sys, cnst, &min_usage);
 512     }
 513     saturated_variable_set_update(sys);
 514
 515   } while (xbt_swag_size(&(sys->saturated_variable_set)));
 516
 517   sys->modified = 0;
 518   if(XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
 519     lmm_print(sys);
 520   }
 521 }
 522
 523 /* Not a O(1) function */
 524
 525 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
 526                 lmm_variable_t var, double value)
 527 {
 528   int i;
 529
 530   sys->modified = 1;
 531   for (i = 0; i < var->cnsts_number; i++)
 532     if (var->cnsts[i].constraint == cnst) {
 533       var->cnsts[i].value = value;
 534       return;
 535     }
 536 }
 537
 538 /** \brief Attribute the value bound to var->bound.
 539  *
 540  *  \param sys the lmm_system_t
 541  *  \param var the lmm_variable_t
 542  *  \param bound the new bound to associate with var
 543  *
 544  *  Makes var->bound equal to bound. Whenever this function is called
 545  *  a change is  signed in the system. To
 546  *  avoid false system changing detection it is a good idea to test
 547  *  (bound != 0) before calling it.
 548  *
 549  */
 550 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
 551                                double bound)
 552 {
 553   sys->modified = 1;
 554   var->bound = bound;
 555 }
 556
 557 /** \brief Add the value delta to var->df (the sum of latencies).
 558  *
 559  *  \param sys the lmm_system_t associated
 560  *  \param var the lmm_variable_t which need to updated
 561  *  \param delta the variation of the latency
 562  *
 563  *  Add the value delta to var->df (the sum of latencys associated to the
 564  *  flow). Whenever this function is called a change is  signed in the system. To
 565  *  avoid false system changing detection it is a good idea to test
 566  *  (delta != 0) before calling it.
 567  *
 568  */
 569 void lmm_update_variable_latency(lmm_system_t sys, lmm_variable_t var,
 570                                double delta)
 571 {
 572   sys->modified = 1;
 573   var->df += delta;
 574 }
 575
 576 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
 577                                 double weight)
 578 {
 579   int i ;
 580   lmm_element_t elem;
 581
 582   XBT_IN3("(sys=%p, var=%p, weight=%f)",sys,var,weight);
 583   sys->modified = 1;
 584   var->weight = weight;
 585   xbt_swag_remove(var,&(sys->variable_set));
 586   if(weight) xbt_swag_insert_at_head(var,&(sys->variable_set));
 587   else xbt_swag_insert_at_tail(var,&(sys->variable_set));
 588
 589   for (i = 0; i < var->cnsts_number; i++) {
 590     elem = &var->cnsts[i];
 591     xbt_swag_remove(elem, &(elem->constraint->element_set));
 592     if(weight) xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
 593     else xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
 594   }
 595   XBT_OUT;
 596 }
 597
 598 double lmm_get_variable_weight(lmm_variable_t var)
 599
 600 {
 601   return var->weight;
 602 }
 603
 604 void lmm_update_constraint_bound(lmm_system_t sys, lmm_constraint_t cnst,
 605                                  double bound)
 606 {
 607   sys->modified = 1;
 608   cnst->bound = bound;
 609 }
 610
 611 int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst)
 612 {
 613   return xbt_swag_belongs(cnst, &(sys->active_constraint_set));
 614 }
 615
 616 lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t sys)
 617 {
 618   return xbt_swag_getFirst(&(sys->active_constraint_set));
 619 }
 620
 621 lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys, lmm_constraint_t cnst)
 622 {
 623   return xbt_swag_getNext(cnst,(sys->active_constraint_set).offset);
 624 }
 625
 626
 627
 628 /** \brief Attribute the value bound to var->bound.
 629  *
 630  *  \param func_f    default function f associated with the chosen protocol flavor
 631  *  \param func_fp   partial differential of f (f prime, f')
 632  *  \param func_fpi  inverse of the partial differential of f (f prime inverse, (f')^{-1})
 633  *  \param func_fpip partial differential of the inverse of the partial differential of f (f prime inverse prime, ((f')^{-1})')
 634  *
 635  *  Set default functions to the ones passed as parameters. This is a polimorfism in C pure, enjoy the roots of programming.
 636  *
 637  */
 638 void lmm_set_default_protocol_functions(double (* func_f)    (lmm_variable_t var, double x),
 639                                         double (* func_fp)   (lmm_variable_t var, double x),
 640                                         double (* func_fpi)  (lmm_variable_t var, double x),
 641                                         double (* func_fpip) (lmm_variable_t var, double x))
 642
 643 {
 644   func_f_def    = func_f;
 645   func_fp_def   = func_fp;
 646   func_fpi_def  = func_fpi;
 647   func_fpip_def = func_fpip;
 648 }
 649
 650
 651 /*
 652  * NOTE for Reno: all functions consider the network
 653  * coeficient (alpha) equal to 1.
 654  */
 655
 656 /*
 657  * For Vegas f: $\alpha_f d_f \log\left(x_f\right)$
 658  */
 659 double func_vegas_f(lmm_variable_t var, double x){
 660   return var->df * log(x);
 661 }
 662
 663 /*
 664  * For Vegas fp: $\frac{\alpha D_f}{x}$
 665  */
 666 double func_vegas_fp(lmm_variable_t var, double x){
 667   //avoid a disaster value - c'est du bricolage mais ca marche
 668 /*   if(x == 0) x = 10e-8; */
 669   return var->df/x;
 670 }
 671
 672 /*
 673  * For Vegas fpi: $\frac{\alpha D_f}{x}$
 674  */
 675 double func_vegas_fpi(lmm_variable_t var, double x){
 676   //avoid a disaster value - c'est du bricolage mais ca marche
 677 /*   if(x == 0) x = 10e-8; */
 678   return var->df/x;
 679 }
 680
 681 /*
 682  * For Vegas fpip: $-\frac{\alpha D_f}{x^2}$
 683  */
 684 double func_vegas_fpip(lmm_variable_t var, double x){
 685   //avoid a disaster value - c'est du bricolage mais ca marche
 686 /*   if(x == 0) x = 10e-8; */
 687   return -( var->df/(x*x) ) ;
 688 }
 689
 690
 691 /*
 692  * For Reno f: $\frac{\sqrt{\frac{3}{2}}}{D_f} \arctan\left(\sqrt{\frac{3}{2}}x_f D_f\right)$
 693  */
 694 double func_reno_f(lmm_variable_t var, double x){
 695   xbt_assert0(var->df>0.0,"Don't call me with stupid values!");
 696   // \sqrt{3/2} = 0.8164965808
 697   return (0.8164965808 / var->df) * atan( (0.8164965808 / var->df)*x );
 698 }
 699
 700 /*
 701  * For Reno fp: $\frac{3}{3 {D_f}^2 x^2 + 2}$
 702  */
 703 double func_reno_fp(lmm_variable_t var, double x){
 704   return 3 / (3*var->df*var->df*x*x + 2);
 705 }
 706
 707 /*
 708  * For Reno fpi: $\sqrt{\frac{1}{{D_f}^2 x} - \frac{2}{3{D_f}^2}}$
 709  */
 710 double func_reno_fpi(lmm_variable_t var, double x){
 711   double res_fpi;
 712
 713   xbt_assert0(var->df>0.0,"Don't call me with stupid values!");
 714   xbt_assert0(x>0.0,"Don't call me with stupid values!");
 715
 716   res_fpi = 1/(var->df*var->df*x) - 2/(3*var->df*var->df);
 717   if(res_fpi<=0.0) return 0.0;
 718   xbt_assert0(res_fpi>0.0,"Don't call me with stupid values!");
 719   return sqrt(res_fpi);
 720 }
 721
 722 /*
 723  * For Reno fpip:  $-\frac{1}{2 {D_f}^2 x^2\sqrt{\frac{1}{{D_f}^2 x} - \frac{2}{3{D_f}^2}}}$
 724  */
 725 double func_reno_fpip(lmm_variable_t var, double x){
 726   double res_fpip;
 727   double critical_test;
 728
 729   xbt_assert0(var->df>0.0,"Don't call me with stupid values!");
 730   xbt_assert0(x>0.0,"Don't call me with stupid values!");
 731
 732   res_fpip = 1/(var->df*var->df*x) - 2/(3*var->df*var->df);
 733   xbt_assert0(res_fpip>0.0,"Don't call me with stupid values!");
 734   critical_test = (2*var->df*var->df*x*x*sqrt(res_fpip));
 735
 736   return -(1.0/critical_test);
 737 }