Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make rngStream management functions in platform more visible
[simgrid.git] / src / surf / trace_mgr.c
index 65a9259..b3db085 100644 (file)
-/*     $Id$     */
-
-/* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
+/* Copyright (c) 2004, 2005, 2007, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
+#include "xbt/str.h"
 #include "xbt/dict.h"
 #include "trace_mgr_private.h"
 #include "surf_private.h"
+#include "xbt/RngStream.h"
+#include <math.h>
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_trace, surf, "Surf trace management");
 
 static xbt_dict_t trace_list = NULL;
-static void _tmgr_trace_free(void *trace)
-{
-  tmgr_trace_free(trace);
-}
 
-tmgr_history_t tmgr_history_new(void)
+XBT_INLINE tmgr_history_t tmgr_history_new(void)
 {
   tmgr_history_t h;
 
   h = xbt_new0(s_tmgr_history_t, 1);
 
-  h->heap = xbt_heap_new(8, xbt_free_f);       /* Why 8 ? Well, why not... */
+  h->heap = xbt_heap_new(8, xbt_free_f);        /* Why 8 ? Well, why not... */
 
   return h;
 }
 
-void tmgr_history_free(tmgr_history_t h)
+XBT_INLINE void tmgr_history_free(tmgr_history_t h)
 {
   xbt_heap_free(h->heap);
   free(h);
 }
 
-tmgr_trace_t tmgr_trace_new_from_string(const char* id, const char *input, double periodicity)
+tmgr_trace_t tmgr_trace_new_from_generator(const char *id,
+                                          probabilist_event_generator_t generator1,
+                                          probabilist_event_generator_t generator2)
 {
   tmgr_trace_t trace = NULL;
-  int linecount = 0;
-  s_tmgr_event_t event;
-  tmgr_event_t last_event = NULL;
-  xbt_dynar_t list;
-  unsigned int cpt;
-  char * val;
-
-  if (trace_list) {
-    trace = xbt_dict_get_or_null(trace_list, id);
-    if (trace)
-      return trace;
-  }
-
-  if (periodicity <= 0) {
-    xbt_assert1(0, "Periodicity has to be positive. Your value %lg", periodicity);
+  RngStream rng_stream = NULL;
+  
+  rng_stream = sg_platf_rng_stream_get(id);
+  
+  trace = xbt_new0(s_tmgr_trace_t, 1);
+  trace->type = e_trace_probabilist;
+  
+  trace->s_probabilist.event_generator[0] = generator1;
+  trace->s_probabilist.event_generator[0]->rng_stream = rng_stream;
+  tmgr_event_generator_next_value(trace->s_probabilist.event_generator[0]);
+  
+  //FIXME : may also be a parameter
+  trace->s_probabilist.next_event = 0;
+  
+  if(generator2 == NULL) {
+    trace->s_probabilist.event_generator[1] = generator1;
+  } else {
+    trace->s_probabilist.event_generator[1] = generator2;
+    trace->s_probabilist.event_generator[1]->rng_stream = rng_stream;
+    tmgr_event_generator_next_value(trace->s_probabilist.event_generator[1]);
   }
+  
+  return trace;
+}
 
-  trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+probabilist_event_generator_t tmgr_event_generator_new_uniform(double alpha,
+                                                               double beta)
+{  
+  probabilist_event_generator_t event_generator = NULL;
+  
+  event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
+  event_generator->type = e_generator_uniform;
+  event_generator->s_uniform_parameters.alpha = alpha;
+  event_generator->s_uniform_parameters.beta = beta;
 
-  list = xbt_str_split(input,"\n\r");
+  tmgr_event_generator_next_value(event_generator);
   
+  return event_generator;
+}
+
+probabilist_event_generator_t tmgr_event_generator_new_exponential(double lambda)
+{  
+  probabilist_event_generator_t event_generator = NULL;
   
-  xbt_dynar_foreach(list, cpt, val) {
-     linecount++;
-     xbt_str_trim(val, " \t\n\r\x0B");
-     if (strlen(val) > 0) {
-       if (sscanf(val, "%lg" " " "%lg" "\n", &event.delta, &event.value) != 2) {
-          xbt_assert2(0, "%s\n%d: Syntax error", input, linecount);
-       }
-       if (last_event) {
-           if ((last_event->delta = event.delta - last_event->delta) <= 0) {
-              xbt_assert2(0, "%s\n%d: Invalid trace value, events have to be sorted", input, linecount);
-           }
-       }
-       xbt_dynar_push(trace->event_list, &event);
-       last_event = xbt_dynar_get_ptr(trace->event_list, xbt_dynar_length(trace->event_list) - 1);
-       if (periodicity > 0) {
-         if (last_event)
-           last_event->delta = periodicity;
-       }
-     }
-  }
+  event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
+  event_generator->type = e_generator_exponential;
+  event_generator->s_exponential_parameters.lambda = lambda;
 
-  if (!trace_list)
-    trace_list = xbt_dict_new();
+  return event_generator;
+}
+
+probabilist_event_generator_t tmgr_event_generator_new_weibull(double lambda,
+                                                               double k)
+{  
+  probabilist_event_generator_t event_generator = NULL;
+  
+  event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
+  event_generator->type = e_generator_weibull;
+  event_generator->s_weibull_parameters.lambda = lambda;
+  event_generator->s_weibull_parameters.k = k;
 
-  xbt_dict_set(trace_list, id, (void *) trace, _tmgr_trace_free);
+  tmgr_event_generator_next_value(event_generator);
+  
+  return event_generator;
+}
 
-  xbt_dynar_free(&list);
-  return trace;
+double tmgr_event_generator_next_value(probabilist_event_generator_t generator)
+{
+  
+  switch(generator->type) {
+    case e_generator_uniform:
+      generator->next_value = (RngStream_RandU01(generator->rng_stream)
+                  * (generator->s_uniform_parameters.beta - generator->s_uniform_parameters.alpha))
+                  + generator->s_uniform_parameters.alpha;
+      break;
+    case e_generator_exponential:
+      generator->next_value = -log(RngStream_RandU01(generator->rng_stream))
+                              / generator->s_exponential_parameters.lambda;
+      break;
+    case e_generator_weibull:
+      generator->next_value = - generator->s_weibull_parameters.lambda
+                              * pow( log(RngStream_RandU01(generator->rng_stream)),
+                                    1.0 / generator->s_weibull_parameters.k );
+  }
+  
+  return generator->next_value;
 }
 
-tmgr_trace_t tmgr_trace_new(const char *filename)
+tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
+                                        double periodicity)
 {
   tmgr_trace_t trace = NULL;
-  FILE *f = NULL;
   int linecount = 0;
-  char line[256];
-  double periodicity = -1.0;   /* No periodicity by default */
   s_tmgr_event_t event;
   tmgr_event_t last_event = NULL;
+  xbt_dynar_t list;
+  unsigned int cpt;
+  char *val;
 
   if (trace_list) {
-    trace = xbt_dict_get_or_null(trace_list, filename);
-    if (trace)
+    trace = xbt_dict_get_or_null(trace_list, id);
+    if (trace) {
+      XBT_WARN("Ignoring redefinition of trace %s", id);
       return trace;
+    }
   }
 
-  if ((f = surf_fopen(filename, "r")) == NULL) {
-    xbt_assert1(0, "Cannot open file '%s'", filename);
-  }
+  xbt_assert(periodicity >= 0,
+              "Invalid periodicity %lg (must be positive)", periodicity);
 
   trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+  trace->type = e_trace_list;
+  trace->s_list.event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+
+  list = xbt_str_split(input, "\n\r");
 
-  while (fgets(line, 256, f)) {
+  xbt_dynar_foreach(list, cpt, val) {
     linecount++;
-    if ((line[0] == '#') || (line[0] == '\n') || (line[0] == '%'))
+    xbt_str_trim(val, " \t\n\r\x0B");
+    if (val[0] == '#' || val[0] == '\0' || val[0] == '%')
       continue;
 
-    if (sscanf(line, "PERIODICITY " "%lg" "\n", &(periodicity))
-       == 1) {
-      if (periodicity <= 0) {
-       xbt_assert2(0,
-                   "%s,%d: Syntax error. Periodicity has to be positive",
-                   filename, linecount);
-      }
+    if (sscanf(val, "PERIODICITY " "%lg" "\n", &periodicity) == 1)
       continue;
-    }
 
-    if (sscanf
-       (line, "%lg" " " "%lg" "\n", &event.delta, &event.value) != 2) {
-      xbt_assert2(0, "%s,%d: Syntax error", filename, linecount);
-    }
+    if (sscanf(val, "%lg" " " "%lg" "\n", &event.delta, &event.value) != 2)
+      xbt_die("%s:%d: Syntax error in trace\n%s", id, linecount, input);
 
     if (last_event) {
-      if ((last_event->delta = event.delta - last_event->delta) <= 0) {
-       xbt_assert2(0,
-                   "%s,%d: Invalid trace value, events have to be sorted",
-                   filename, linecount);
+      if (last_event->delta > event.delta) {
+        xbt_die("%s:%d: Invalid trace: Events must be sorted, "
+                "but time %lg > time %lg.\n%s",
+                id, linecount, last_event->delta, event.delta, input);
       }
+      last_event->delta = event.delta - last_event->delta;
     }
-    xbt_dynar_push(trace->event_list, &event);
-    last_event = xbt_dynar_get_ptr(trace->event_list,
-                                  xbt_dynar_length(trace->event_list) -
-                                  1);
-  }
-
-  if (periodicity > 0) {
-    if (last_event)
-      last_event->delta = periodicity;
+    xbt_dynar_push(trace->s_list.event_list, &event);
+    last_event =
+        xbt_dynar_get_ptr(trace->s_list.event_list,
+                          xbt_dynar_length(trace->s_list.event_list) - 1);
   }
+  if (last_event)
+    last_event->delta = periodicity;
 
   if (!trace_list)
-    trace_list = xbt_dict_new();
+    trace_list = xbt_dict_new_homogeneous((void (*)(void *)) tmgr_trace_free);
+
+  xbt_dict_set(trace_list, id, (void *) trace, NULL);
+
+  xbt_dynar_free(&list);
+  return trace;
+}
 
-  xbt_dict_set(trace_list, filename, (void *) trace, _tmgr_trace_free);
+tmgr_trace_t tmgr_trace_new_from_file(const char *filename)
+{
+  char *tstr = NULL;
+  FILE *f = NULL;
+  tmgr_trace_t trace = NULL;
+
+  if ((!filename) || (strcmp(filename, "") == 0))
+    return NULL;
 
+  if (trace_list) {
+    trace = xbt_dict_get_or_null(trace_list, filename);
+    if (trace) {
+      XBT_WARN("Ignoring redefinition of trace %s", filename);
+      return trace;
+    }
+  }
+
+  f = surf_fopen(filename, "r");
+  xbt_assert(f != NULL, "Cannot open file '%s' (path=%s)", filename,
+              xbt_str_join(surf_path, ":"));
+
+  tstr = xbt_str_from_file(f);
   fclose(f);
+  trace = tmgr_trace_new_from_string(filename, tstr, 0.);
+  xbt_free(tstr);
 
   return trace;
 }
@@ -164,32 +224,39 @@ tmgr_trace_t tmgr_trace_new(const char *filename)
 tmgr_trace_t tmgr_empty_trace_new(void)
 {
   tmgr_trace_t trace = NULL;
-  /*double periodicity = -1.0;   No periodicity by default; unused variables
-     tmgr_event_t last_event = NULL; */
   s_tmgr_event_t event;
 
   trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+  trace->type = e_trace_list;
+  trace->s_list.event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
 
   event.delta = 0.0;
   event.value = 0.0;
-  xbt_dynar_push(trace->event_list, &event);
+  xbt_dynar_push(trace->s_list.event_list, &event);
 
   return trace;
 }
 
-void tmgr_trace_free(tmgr_trace_t trace)
+XBT_INLINE void tmgr_trace_free(tmgr_trace_t trace)
 {
   if (!trace)
     return;
-  xbt_dynar_free(&(trace->event_list));
+  
+  switch(trace->type) {
+    case e_trace_list:
+      xbt_dynar_free(&(trace->s_list.event_list));
+      break;
+    case e_trace_probabilist:
+      THROW_UNIMPLEMENTED;
+      break;
+  }
   free(trace);
 }
 
 tmgr_trace_event_t tmgr_history_add_trace(tmgr_history_t h,
-                                         tmgr_trace_t trace,
-                                         double start_time, unsigned int offset,
-                                         void *model)
+                                          tmgr_trace_t trace,
+                                          double start_time,
+                                          unsigned int offset, void *model)
 {
   tmgr_trace_event_t trace_event = NULL;
 
@@ -198,15 +265,17 @@ tmgr_trace_event_t tmgr_history_add_trace(tmgr_history_t h,
   trace_event->idx = offset;
   trace_event->model = model;
 
-  xbt_assert0((trace_event->idx < xbt_dynar_length(trace->event_list)),
-             "You're refering to an event that does not exist!");
-
+  if(trace->type == e_trace_list) {
+    xbt_assert((trace_event->idx < xbt_dynar_length(trace->s_list.event_list)),
+              "You're referring to an event that does not exist!");
+  }
+  
   xbt_heap_push(h->heap, trace_event, start_time);
 
   return trace_event;
 }
 
-double tmgr_history_next_date(tmgr_history_t h)
+XBT_INLINE double tmgr_history_next_date(tmgr_history_t h)
 {
   if (xbt_heap_size(h->heap))
     return (xbt_heap_maxkey(h->heap));
@@ -215,14 +284,15 @@ double tmgr_history_next_date(tmgr_history_t h)
 }
 
 tmgr_trace_event_t tmgr_history_get_next_event_leq(tmgr_history_t h,
-                                                  double date,
-                                                  double *value,
-                                                  void **model)
+                                                   double date,
+                                                   double *value,
+                                                   void **model)
 {
   double event_date = tmgr_history_next_date(h);
   tmgr_trace_event_t trace_event = NULL;
   tmgr_event_t event = NULL;
   tmgr_trace_t trace = NULL;
+  double event_delta;
 
   if (event_date > date)
     return NULL;
@@ -231,26 +301,56 @@ tmgr_trace_event_t tmgr_history_get_next_event_leq(tmgr_history_t h,
     return NULL;
 
   trace = trace_event->trace;
-  event = xbt_dynar_get_ptr(trace->event_list, trace_event->idx);
-
-  *value = event->value;
   *model = trace_event->model;
-
-  if (trace_event->idx < xbt_dynar_length(trace->event_list) - 1) {
-    xbt_heap_push(h->heap, trace_event, event_date + event->delta);
-    trace_event->idx++;
-  } else if (event->delta > 0) {       /* Last element, checking for periodicity */
-    xbt_heap_push(h->heap, trace_event, event_date + event->delta);
-    trace_event->idx = 0;
-  } else {                     /* We don't need this trace_event anymore */
-    free(trace_event);
-       return NULL;
+  
+  switch(trace->type) {
+    case e_trace_list:
+        
+      event = xbt_dynar_get_ptr(trace->s_list.event_list, trace_event->idx);
+
+      *value = event->value;
+
+      if (trace_event->idx < xbt_dynar_length(trace->s_list.event_list) - 1) {
+        xbt_heap_push(h->heap, trace_event, event_date + event->delta);
+        trace_event->idx++;
+      } else if (event->delta > 0) {        /* Last element, checking for periodicity */
+        xbt_heap_push(h->heap, trace_event, event_date + event->delta);
+        trace_event->idx = 0;
+      } else {                      /* We don't need this trace_event anymore */
+        trace_event->free_me = 1;
+      }
+      break;
+      
+    case e_trace_probabilist:
+      
+      //FIXME : Simplist and not tested
+      //Would only work for failure events for now
+      *value = (double) trace->s_probabilist.next_event;
+      if(trace->s_probabilist.next_event == 0) {
+        event_delta = tmgr_event_generator_next_value(trace->s_probabilist.event_generator[0]);
+        trace->s_probabilist.next_event = 0;
+      } else {
+        event_delta = tmgr_event_generator_next_value(trace->s_probabilist.event_generator[1]);
+        trace->s_probabilist.next_event = 1;
+      }
+      xbt_heap_push(h->heap, trace_event, event_date + event_delta);
+      
+      break;
   }
 
   return trace_event;
 }
 
-void tmgr_finalize(void)
+XBT_INLINE void tmgr_finalize(void)
 {
   xbt_dict_free(&trace_list);
 }
+
+int tmgr_trace_event_free(tmgr_trace_event_t trace_event)
+{
+  if (trace_event->free_me) {
+    xbt_free(trace_event);
+    return 1;
+  }
+  return 0;
+}