Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Keep cleaning up func_f, func_fp, func_fpip...
[simgrid.git] / src / surf / maxmin.c
index c962d74..ee52f23 100644 (file)
@@ -8,10 +8,16 @@
 
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
+#include "xbt/mallocator.h"
 #include "maxmin_private.h"
 #include <stdlib.h>
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(maxmin, surf,
-                               "Logging specific to the SURF maxmin module");
+#include <math.h>
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_maxmin, surf,
+                               "Logging specific to SURF (maxmin)");
+
+static void* lmm_variable_mallocator_new_f(void);
+static void lmm_variable_mallocator_free_f(void *var);
+static void lmm_variable_mallocator_reset_f(void *var);
 
 lmm_system_t lmm_system_new(void)
 {
@@ -35,6 +41,11 @@ lmm_system_t lmm_system_new(void)
   xbt_swag_init(&(l->saturated_constraint_set),
                xbt_swag_offset(cnst, saturated_constraint_set_hookup));
 
+  l->variable_mallocator = xbt_mallocator_new(64,
+                                             lmm_variable_mallocator_new_f,
+                                             lmm_variable_mallocator_free_f,
+                                             lmm_variable_mallocator_reset_f);
+
   return l;
 }
 
@@ -49,6 +60,7 @@ void lmm_system_free(lmm_system_t sys)
   while ((cnst = extract_constraint(sys)))
     lmm_cnst_free(sys, cnst);
 
+  xbt_mallocator_free(sys->variable_mallocator);
   free(sys);
 }
 
@@ -57,6 +69,7 @@ void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
   int i;
   lmm_element_t elem = NULL;
 
+  XBT_IN2("(sys=%p, var=%p)",sys,var);
   sys->modified = 1;
 
   for (i = 0; i < var->cnsts_number; i++) {
@@ -67,15 +80,15 @@ void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
       make_constraint_inactive(sys, elem->constraint);
   }
   var->cnsts_number = 0;
+  XBT_OUT;
 }
 
 static void lmm_var_free(lmm_system_t sys, lmm_variable_t var)
 {
 
   lmm_variable_disable(sys, var);
-  memset(var->cnsts,0,var->cnsts_size*sizeof(s_lmm_element_t));
   free(var->cnsts);
-  free(var);
+  xbt_mallocator_release(sys->variable_mallocator, var);
 }
 
 static void lmm_cnst_free(lmm_system_t sys, lmm_constraint_t cnst)
@@ -118,13 +131,30 @@ void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst)
   lmm_cnst_free(sys, cnst);
 }
 
+static void* lmm_variable_mallocator_new_f(void) {
+  return xbt_new(s_lmm_variable_t, 1);
+}
+
+static void lmm_variable_mallocator_free_f(void *var) {
+  xbt_free(var);
+}
+
+static void lmm_variable_mallocator_reset_f(void *var) {
+  /* memset to zero like calloc */
+  memset(var, 0, sizeof(s_lmm_variable_t));
+}
+
 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
                                double weight,
                                double bound, int number_of_constraints)
 {
   lmm_variable_t var = NULL;
   int i;
-  var = xbt_new0(s_lmm_variable_t, 1);
+
+  XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
+         sys,id,weight,bound,number_of_constraints);
+
+  var = xbt_mallocator_get(sys->variable_mallocator);
   var->id = id;
   var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
   for(i=0; i<number_of_constraints; i++) {
@@ -144,9 +174,13 @@ lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
   var->weight = weight;
   var->bound = bound;
   var->value = 0.0;
+  var->df    = 0.0;
+
+  var->func_fpi  = func_fpi_def;
+
   if(weight) xbt_swag_insert_at_head(var,&(sys->variable_set));
   else xbt_swag_insert_at_tail(var,&(sys->variable_set));
-
+  XBT_OUT;
   return var;
 }
 
@@ -196,6 +230,20 @@ void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
   else lmm_expand(sys,cnst,var,value);
 }
 
+void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
+                       lmm_variable_t var, double value)
+{
+  int i ; 
+
+  for(i=0; i< var->cnsts_number ; i++)
+    if(var->cnsts[i].constraint == cnst) break;
+
+  if(i<var->cnsts_number) {
+    var->cnsts[i].value =value;
+    sys->modified = 1;
+  } else DIE_IMPOSSIBLE;
+}
+
 lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
                                       lmm_variable_t var, int num)
 {
@@ -237,13 +285,20 @@ static void saturated_constraint_set_update(lmm_system_t sys,
 {
   lmm_constraint_t useless_cnst = NULL;
 
-  if (cnst->usage <= 0)
+  XBT_IN3("sys=%p, cnst=%p, min_usage=%f",sys,cnst,*min_usage);
+  if (cnst->usage <= 0) {
+    XBT_OUT;
     return;
-  if (cnst->remaining <= 0)
+  }
+  if (cnst->remaining <= 0) {
+    XBT_OUT;
     return;
+  }
   if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
     *min_usage = cnst->remaining / cnst->usage;
-
+    LOG3(xbt_log_priority_trace, 
+        "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)",*min_usage, 
+        cnst->remaining, cnst->usage);
     while ((useless_cnst =
            xbt_swag_getFirst(&(sys->saturated_constraint_set))))
       xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
@@ -252,6 +307,7 @@ static void saturated_constraint_set_update(lmm_system_t sys,
   } else if (*min_usage == cnst->remaining / cnst->usage) {
     xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
   }
+  XBT_OUT;
 }
 
 static void saturated_variable_set_update(lmm_system_t sys)
@@ -271,7 +327,79 @@ static void saturated_variable_set_update(lmm_system_t sys)
     }
     xbt_swag_remove(cnst, cnst_list);
   }
+}
+
+void lmm_print(lmm_system_t sys)
 
+{
+  lmm_constraint_t cnst = NULL;
+  lmm_element_t elem = NULL;
+  lmm_variable_t var = NULL;
+  xbt_swag_t cnst_list = NULL;
+  xbt_swag_t var_list = NULL;
+  xbt_swag_t elem_list = NULL;
+  char print_buf[1024];
+  char *trace_buf=xbt_malloc0(sizeof(char));
+  double sum=0.0;
+
+  /* Printing Objective */
+  var_list = &(sys->variable_set);
+  sprintf(print_buf,"MAX-MIN ( ");
+  trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+  strcat(trace_buf, print_buf);
+  xbt_swag_foreach(var, var_list) {
+    sprintf(print_buf,"'%p'(%f) ",var,var->weight);
+    trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+    strcat(trace_buf, print_buf);
+  }
+  sprintf(print_buf,")");
+  trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+  strcat(trace_buf, print_buf);
+  DEBUG1("%s",trace_buf);
+  trace_buf[0]='\000';
+
+  /* Printing Constraints */
+  cnst_list = &(sys->active_constraint_set);
+  xbt_swag_foreach(cnst, cnst_list) {
+    sum=0.0;
+    elem_list = &(cnst->element_set);
+    sprintf(print_buf,"\t");
+    trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+    strcat(trace_buf, print_buf);
+    xbt_swag_foreach(elem, elem_list) {
+      sprintf(print_buf,"%f.'%p'(%f) + ",elem->value, 
+             elem->variable,elem->variable->value);
+      trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+      strcat(trace_buf, print_buf);
+      sum += elem->value * elem->variable->value;
+    }
+    sprintf(print_buf,"0 <= %f ('%p')",cnst->bound,cnst);
+    trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+    strcat(trace_buf, print_buf);
+
+    if(!cnst->shared) {
+      sprintf(print_buf," [MAX-Constraint]");
+      trace_buf = xbt_realloc(trace_buf,strlen(trace_buf)+strlen(print_buf)+1);
+      strcat(trace_buf, print_buf);
+    }
+    DEBUG1("%s",trace_buf);
+    trace_buf[0]='\000';
+    xbt_assert3(!double_positive(sum-cnst->bound), "Incorrect value (%f is not smaller than %f): %g",
+               sum,cnst->bound,sum-cnst->bound);
+  }
+
+  /* Printing Result */
+  xbt_swag_foreach(var, var_list) {
+    if(var->bound>0) {
+      DEBUG4("'%p'(%f) : %f (<=%f)",var,var->weight,var->value, var->bound);
+      xbt_assert2(!double_positive(var->value-var->bound), "Incorrect value (%f is not smaller than %f",
+                 var->value, var->bound);
+    }
+    else 
+      DEBUG3("'%p'(%f) : %f",var,var->weight,var->value);
+  }
+
+  free(trace_buf);
 }
 
 void lmm_solve(lmm_system_t sys)
@@ -294,31 +422,32 @@ void lmm_solve(lmm_system_t sys)
     var->value = 0.0;
   }
 
-
-  /* Compute Usage and store the variables that reach the maximum */
-
+  /* 
+   * Compute Usage and store the variables that reach the maximum.
+   */
   cnst_list = &(sys->active_constraint_set);
-  DEBUG1("cnst_list : %d", xbt_swag_size(cnst_list));
+  DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
   xbt_swag_foreach(cnst, cnst_list) {
     /* INIT */
     cnst->remaining = cnst->bound;
     cnst->usage = 0;
     elem_list = &(cnst->element_set);
+    cnst->usage = 0.0;
     xbt_swag_foreach(elem, elem_list) {
       if(elem->variable->weight <=0) break;
       if ((elem->value > 0)) {
        if(cnst->shared)
          cnst->usage += elem->value / elem->variable->weight;
        else 
-         cnst->usage = 1;
+         if(cnst->usage<elem->value / elem->variable->weight)
+           cnst->usage = elem->value / elem->variable->weight;
+       DEBUG2("Constraint Usage %p : %f",cnst,cnst->usage);
        make_elem_active(elem);
       }
     }
-
     /* Saturated constraints update */
     saturated_constraint_set_update(sys, cnst, &min_usage);
   }
-
   saturated_variable_set_update(sys);
 
   /* Saturated variables update */
@@ -330,8 +459,11 @@ void lmm_solve(lmm_system_t sys)
     xbt_swag_foreach(var, var_list) {
       /* First check if some of these variables have reach their upper
          bound and update min_usage accordingly. */
-      if ((var->bound > 0) && (var->bound / var->weight < min_usage)) {
-       min_usage = var->bound / var->weight;
+      DEBUG5("var=%p, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
+            var, var->bound, var->weight, min_usage,var->bound * var->weight);
+      if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
+       min_usage = var->bound * var->weight;
+       DEBUG1("Updated min_usage=%f",min_usage);
       }
     }
 
@@ -340,6 +472,8 @@ void lmm_solve(lmm_system_t sys)
       int i;
 
       var->value = min_usage / var->weight;
+      DEBUG5("Min usage: %f, Var(%p)->weight: %f, Var(%p)->value: %f ",min_usage,var,var->weight,var,var->value);
+
 
       /* Update usage */
 
@@ -347,10 +481,23 @@ void lmm_solve(lmm_system_t sys)
        elem = &var->cnsts[i];
        cnst = elem->constraint;
        if(cnst->shared) {
-         cnst->remaining -= elem->value * var->value;
-         cnst->usage -= elem->value / var->weight;
+         double_update(&(cnst->remaining), elem->value * var->value);
+         double_update(&(cnst->usage), elem->value / var->weight);
+         make_elem_inactive(elem);
+       } else { /* FIXME one day: We recompute usage.... :( */
+         cnst->usage = 0.0;
+         make_elem_inactive(elem);
+         xbt_swag_foreach(elem, elem_list) {
+           if(elem->variable->weight <=0) break;
+           if(elem->variable->value > 0) break;
+           if ((elem->value > 0)) {
+             if(cnst->usage<elem->value / elem->variable->weight)
+               cnst->usage = elem->value / elem->variable->weight;
+             DEBUG2("Constraint Usage %p : %f",cnst,cnst->usage);
+             make_elem_active(elem);
+           }
+         } 
        }
-       make_elem_inactive(elem);
       }
       xbt_swag_remove(var, var_list);
     }
@@ -366,6 +513,9 @@ void lmm_solve(lmm_system_t sys)
   } while (xbt_swag_size(&(sys->saturated_variable_set)));
 
   sys->modified = 0;
+  if(XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
+    lmm_print(sys);
+  }
 }
 
 /* Not a O(1) function */
@@ -383,6 +533,18 @@ void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
     }
 }
 
+/** \brief Attribute the value bound to var->bound.
+ * 
+ *  \param sys the lmm_system_t
+ *  \param var the lmm_variable_t
+ *  \param bound the new bound to associate with var
+ * 
+ *  Makes var->bound equal to bound. Whenever this function is called 
+ *  a change is  signed in the system. To
+ *  avoid false system changing detection it is a good idea to test 
+ *  (bound != 0) before calling it.
+ *
+ */
 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
                               double bound)
 {
@@ -390,12 +552,32 @@ void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
   var->bound = bound;
 }
 
+/** \brief Add the value delta to var->df (the sum of latencies).
+ * 
+ *  \param sys the lmm_system_t associated
+ *  \param var the lmm_variable_t which need to updated
+ *  \param delta the variation of the latency
+ * 
+ *  Add the value delta to var->df (the sum of latencys associated to the
+ *  flow). Whenever this function is called a change is  signed in the system. To
+ *  avoid false system changing detection it is a good idea to test 
+ *  (delta != 0) before calling it.
+ *
+ */
+void lmm_update_variable_latency(lmm_system_t sys, lmm_variable_t var,
+                              double delta)
+{
+  sys->modified = 1;
+  var->df += delta;
+}
+
 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
                                double weight)
 {
   int i ;
   lmm_element_t elem;
 
+  XBT_IN3("(sys=%p, var=%p, weight=%f)",sys,var,weight);
   sys->modified = 1;
   var->weight = weight;
   xbt_swag_remove(var,&(sys->variable_set));
@@ -408,6 +590,7 @@ void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
     if(weight) xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
     else xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
   }
+  XBT_OUT;
 }
 
 double lmm_get_variable_weight(lmm_variable_t var)
@@ -439,18 +622,19 @@ lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys, lmm_constraint
 }
 
 
-/* void lmm_print(lmm_system_t sys) */
-/* { */
-/*   lmm_variable_t var = NULL; */
-/*   lmm_constraint_t cnst = NULL; */
-/*   lmm_element_t elem = NULL; */
-/*   xbt_swag_t cnst_list = NULL; */
-/*   xbt_swag_t var_list = NULL; */
-/*   xbt_swag_t elem_list = NULL; */
 
-/*   var_list = &(sys->variable_set); */
-/*   xbt_swag_foreach(var, var_list) { */
-/*     printf("%s : {\n",var->id); */
-/*     printf("\t %s : {\n",var->id); */
-/*   } */
-/* } */
+/** \brief Attribute the value bound to var->bound.
+ * 
+ *  \param func_f    default function f associated with the chosen protocol flavor
+ *  \param func_fp   partial differential of f (f prime, f')
+ *  \param func_fpi  inverse of the partial differential of f (f prime inverse, (f')^{-1})
+ *  \param func_fpip partial differential of the inverse of the partial differential of f (f prime inverse prime, ((f')^{-1})')
+ * 
+ *  Set default functions to the ones passed as parameters. This is a polimorfism in C pure, enjoy the roots of programming.
+ *
+ */
+void lmm_set_default_protocol_functions(double (* func_fpi)  (lmm_variable_t var, double x))
+{
+  func_fpi_def  = func_fpi;
+}
+