Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill dead code
[simgrid.git] / src / surf / trace_mgr.cpp
index 834ceb7..32558c2 100644 (file)
@@ -17,7 +17,8 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_trace, surf, "Surf trace management");
 
 static xbt_dict_t trace_list = NULL;
 
-simgrid::trace_mgr::future_evt_set::future_evt_set() {
+simgrid::trace_mgr::future_evt_set::future_evt_set()
+{
 }
 
 simgrid::trace_mgr::future_evt_set::~future_evt_set()
@@ -25,223 +26,7 @@ simgrid::trace_mgr::future_evt_set::~future_evt_set()
   xbt_heap_free(p_heap);
 }
 
-
-/**
- * \brief Create a #tmgr_trace_t from probabilist generators
- *
- * This trace will generate an infinite set of events.
- * It needs two #probabilist_event_generator_t. The date when the event are
- * triggered is directed by date_generator, and will be interpreted as seconds.
- * The value of the event is set by value_generator. The value should be between
- * 0 and 1.
- *
- * \param id The name of the trace
- * \param date_generator The #probabilist_event_generator_t which generates the time
- *        between two events
- * \param generator2 The #probabilist_event_generator_t which generates the value
- *        of each events.
- * \return The new #tmgr_trace_t
- */
-tmgr_trace_t tmgr_trace_generator_value(const char *id,
-                                  probabilist_event_generator_t date_generator,
-                                  probabilist_event_generator_t value_generator)
-{
-  tmgr_trace_t trace = NULL;
-
-  trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->type = e_trace_probabilist;
-
-  trace->s_probabilist.event_generator[0] = date_generator;
-  trace->s_probabilist.event_generator[1] = value_generator;
-  trace->s_probabilist.is_state_trace = 0;
-
-  return trace;
-}
-
-/**
- * \brief Create a #tmgr_trace_t from probabilist generators
- *
- * This trace will generate an infinite set of events. Value of the events
- * will be alternatively 0 and 1, so this should be used as a state trace.
- *
- * \param id The name of the trace
- * \param date_generator The #probabilist_event_generator_t which generates the time
- *        between two events
- * \param first_event_value Set the first event value
- * \return The new #tmgr_trace_t
- */
-tmgr_trace_t tmgr_trace_generator_state(const char *id,
-                                  probabilist_event_generator_t date_generator,
-                                  int first_event_hostIsOn)
-{
-  tmgr_trace_t trace = NULL;
-
-  trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->type = e_trace_probabilist;
-
-  trace->s_probabilist.event_generator[0] = date_generator;
-  trace->s_probabilist.event_generator[1] = date_generator;
-  trace->s_probabilist.is_state_trace = 1;
-  trace->s_probabilist.next_event = first_event_hostIsOn;
-
-  return trace;
-}
-
-/**
- * \brief Create a #tmgr_trace_t from probabilist generators
- *
- * This trace will generate an infinite set of events. Value of the events
- * will be alternatively 0 and 1, so this should be used as a state trace.
- *
- * \param id The name of the trace
- * \param avail_duration_generator The #probabilist_event_generator_t which
- *        set the duration of the available state, (ie 1 value)
- * \param unavail_duration_generator The #probabilist_event_generator_t which
- *        set the duration of the unavailable state, (ie 0 value)
- * \param first_event_value Set the first event value
- * \return The new #tmgr_trace_t
- */
-tmgr_trace_t tmgr_trace_generator_avail_unavail(const char *id,
-                                probabilist_event_generator_t avail_duration_generator,
-                                probabilist_event_generator_t unavail_duration_generator,
-                                int first_event_hostIsOn)
-{
-  tmgr_trace_t trace = NULL;
-
-  trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->type = e_trace_probabilist;
-
-  trace->s_probabilist.event_generator[0] = unavail_duration_generator;
-  trace->s_probabilist.event_generator[1] = avail_duration_generator;
-  trace->s_probabilist.is_state_trace = 1;
-  trace->s_probabilist.next_event = first_event_hostIsOn;
-
-  return trace;
-}
-
-/**
- * \brief Create a new #probabilist_event_generator_t following the uniform distribution
- *
- * This generator will generate uniformly distributed random values between min and max
- * The id is important : it controls the seed of the generator. So, generators with the
- * same id and the same parameters will generate the same values.
- *
- * \param id The name of the generator
- * \param min The minimal generated value
- * \param max The maximal generated value
- * \return a new #probabilist_event_generator_t
- */
-probabilist_event_generator_t tmgr_event_generator_new_uniform(const char* id,
-                                                               double min,
-                                                               double max)
-{
-  probabilist_event_generator_t event_generator = NULL;
-  RngStream rng_stream = NULL;
-
-  rng_stream = sg_platf_rng_stream_get(id);
-
-  event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
-  event_generator->type = e_generator_uniform;
-  event_generator->s_uniform_parameters.min = min;
-  event_generator->s_uniform_parameters.max = max;
-  event_generator->rng_stream = rng_stream;
-
-  tmgr_event_generator_next_value(event_generator);
-
-  return event_generator;
-}
-
-
-/**
- * \brief Create a new #probabilist_event_generator_t following the exponential distribution
- *
- * This generator will generate random values following the exponential distribution.
- * The mean value is 1/rate .
- * The id is important : it controls the seed of the generator. So, generators with the
- * same id and the same parameters will generate the same values.
- *
- * \param id The name of the generator
- * \param rate The rate parameter
- * \return a new #probabilist_event_generator_t
- */
-probabilist_event_generator_t tmgr_event_generator_new_exponential(const char* id,
-                                                                   double rate)
-{
-  probabilist_event_generator_t event_generator = NULL;
-  RngStream rng_stream = NULL;
-
-  rng_stream = sg_platf_rng_stream_get(id);
-
-  event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
-  event_generator->type = e_generator_exponential;
-  event_generator->s_exponential_parameters.rate = rate;
-  event_generator->rng_stream = rng_stream;
-
-  tmgr_event_generator_next_value(event_generator);
-
-  return event_generator;
-}
-
-/**
- * \brief Create a new #probabilist_event_generator_t following the weibull distribution
- *
- * This generator will generate random values following the weibull distribution.
- * The id is important : it controls the seed of the generator. So, generators with the
- * same id and the same parameters will generate the same values.
- *
- * \param id The name of the generator
- * \param scale The scale parameter
- * \param shape The shape parameter
- * \return a new #probabilist_event_generator_t
- */
-probabilist_event_generator_t tmgr_event_generator_new_weibull(const char* id,
-                                                               double scale,
-                                                               double shape)
-{
-  probabilist_event_generator_t event_generator = NULL;
-  RngStream rng_stream = NULL;
-
-  rng_stream = sg_platf_rng_stream_get(id);
-
-  event_generator = xbt_new0(s_probabilist_event_generator_t, 1);
-  event_generator->type = e_generator_weibull;
-  event_generator->s_weibull_parameters.scale = scale;
-  event_generator->s_weibull_parameters.shape = shape;
-  event_generator->rng_stream = rng_stream;
-
-  tmgr_event_generator_next_value(event_generator);
-
-  return event_generator;
-}
-/**
- * \brief Get the next random value of a #probabilist_event_generator_t
- * \param generator The #probabilist_event_generator_t
- * \return the next random value
- */
-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.max - generator->s_uniform_parameters.min))
-                  + generator->s_uniform_parameters.min;
-      break;
-    case e_generator_exponential:
-      generator->next_value = -log(RngStream_RandU01(generator->rng_stream))
-                              / generator->s_exponential_parameters.rate;
-      break;
-    case e_generator_weibull:
-      generator->next_value = generator->s_weibull_parameters.scale
-                              * pow( -log(RngStream_RandU01(generator->rng_stream)),
-                                    1.0 / generator->s_weibull_parameters.shape );
-  }
-
-  return generator->next_value;
-}
-
-tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
-                                        double periodicity)
+tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input, double periodicity)
 {
   tmgr_trace_t trace = NULL;
   int linecount = 0;
@@ -263,8 +48,7 @@ tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
               "Invalid periodicity %g (must be positive)", periodicity);
 
   trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->type = e_trace_list;
-  trace->s_list.event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+  trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
 
   list = xbt_str_split(input, "\n\r");
 
@@ -292,11 +76,11 @@ tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
         s_tmgr_event_t first_event;
         first_event.delta=event.delta;
         first_event.value=-1.0;
-        xbt_dynar_push(trace->s_list.event_list, &first_event);
+        xbt_dynar_push(trace->event_list, &first_event);
       }
     }
-    xbt_dynar_push(trace->s_list.event_list, &event);
-    last_event = (tmgr_event_t)xbt_dynar_get_ptr(trace->s_list.event_list, xbt_dynar_length(trace->s_list.event_list) - 1);
+    xbt_dynar_push(trace->event_list, &event);
+    last_event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, xbt_dynar_length(trace->event_list) - 1);
   }
   if (last_event)
     last_event->delta = periodicity;
@@ -312,8 +96,6 @@ tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
 
 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))
@@ -327,12 +109,11 @@ tmgr_trace_t tmgr_trace_new_from_file(const char *filename)
     }
   }
 
-  f = surf_fopen(filename, "r");
-  if (f == NULL)
-    xbt_die("Cannot open file '%s' (path=%s)", filename,
-            xbt_str_join(surf_path, ":"));
+  FILE *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);
+  char *tstr = xbt_str_from_file(f);
   fclose(f);
   trace = tmgr_trace_new_from_string(filename, tstr, 0.);
   xbt_free(tstr);
@@ -346,12 +127,11 @@ tmgr_trace_t tmgr_empty_trace_new(void)
   s_tmgr_event_t event;
 
   trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->type = e_trace_list;
-  trace->s_list.event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+  trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
 
   event.delta = 0.0;
   event.value = 0.0;
-  xbt_dynar_push(trace->s_list.event_list, &event);
+  xbt_dynar_push(trace->event_list, &event);
 
   return trace;
 }
@@ -361,22 +141,12 @@ void tmgr_trace_free(tmgr_trace_t trace)
   if (!trace)
     return;
 
-  switch(trace->type) {
-    case e_trace_list:
-      xbt_dynar_free(&(trace->s_list.event_list));
-      break;
-    case e_trace_probabilist:
-      THROW_UNIMPLEMENTED;
-      break;
-  }
+  xbt_dynar_free(&(trace->event_list));
   free(trace);
 }
 
-/** Register a new trace into the future event set, and get an iterator over the integrated trace  */
-tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(
-    tmgr_trace_t trace,
-    double start_time,
-    void *resource)
+/** @brief Registers a new trace into the future event set, and get an iterator over the integrated trace  */
+tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(tmgr_trace_t trace, double start_time, surf::Resource *resource)
 {
   tmgr_trace_iterator_t trace_iterator = NULL;
 
@@ -385,17 +155,15 @@ tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(
   trace_iterator->idx = 0;
   trace_iterator->resource = resource;
 
-  if(trace->type == e_trace_list) {
-    xbt_assert((trace_iterator->idx < xbt_dynar_length(trace->s_list.event_list)),
-              "You're referring to an event that does not exist!");
-  }
+  xbt_assert((trace_iterator->idx < xbt_dynar_length(trace->event_list)), "Your trace should have at least one event!");
 
   xbt_heap_push(p_heap, trace_iterator, start_time);
 
   return trace_iterator;
 }
 
-double simgrid::trace_mgr::future_evt_set::next_date()
+/** @brief returns the date of the next occurring event (pure function) */
+double simgrid::trace_mgr::future_evt_set::next_date() const
 {
   if (xbt_heap_size(p_heap))
     return (xbt_heap_maxkey(p_heap));
@@ -403,64 +171,33 @@ double simgrid::trace_mgr::future_evt_set::next_date()
     return -1.0;
 }
 
+/** @brief Retrieves the next occurring event, or NULL if none happens before #date */
 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::pop_leq(
-    double date,
-    double *value,
-    void** resource)
+    double date, double *value, simgrid::surf::Resource **resource)
 {
   double event_date = next_date();
-  tmgr_trace_iterator_t trace_iterator = NULL;
-  tmgr_event_t event = NULL;
-  tmgr_trace_t trace = NULL;
-  double event_delta;
-
   if (event_date > date)
     return NULL;
 
-  if (!(trace_iterator = (tmgr_trace_iterator_t)xbt_heap_pop(p_heap)))
+  tmgr_trace_iterator_t trace_iterator = (tmgr_trace_iterator_t)xbt_heap_pop(p_heap);
+  if (trace_iterator == NULL)
     return NULL;
 
-  trace = trace_iterator->trace;
+  tmgr_trace_t trace = trace_iterator->trace;
   *resource = trace_iterator->resource;
 
-  switch(trace->type) {
-    case e_trace_list:
+  tmgr_event_t event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, trace_iterator->idx);
 
-      event = (tmgr_event_t)xbt_dynar_get_ptr(trace->s_list.event_list, trace_iterator->idx);
-
-      *value = event->value;
-
-      if (trace_iterator->idx < xbt_dynar_length(trace->s_list.event_list) - 1) {
-        xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
-        trace_iterator->idx++;
-      } else if (event->delta > 0) {        /* Last element, checking for periodicity */
-        xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
-        trace_iterator->idx = 1; /* not 0 as the first event is a placeholder to handle when events really start */
-      } else {                      /* We don't need this trace_event anymore */
-        trace_iterator->free_me = 1;
-      }
-      break;
-
-    case e_trace_probabilist:
-
-      //FIXME : not tested yet
-      if(trace->s_probabilist.is_state_trace) {
-        *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 = 1;
-        } else {
-          event_delta = tmgr_event_generator_next_value(trace->s_probabilist.event_generator[1]);
-          trace->s_probabilist.next_event = 0;
-        }
-      } else {
-        event_delta = tmgr_event_generator_next_value(trace->s_probabilist.event_generator[0]);
-        *value = tmgr_event_generator_next_value(trace->s_probabilist.event_generator[1]);
-      }
-      xbt_heap_push(p_heap, trace_iterator, event_date + event_delta);
-      XBT_DEBUG("Generating a new event at date %f, with value %f", event_date + event_delta, *value);
+  *value = event->value;
 
-      break;
+  if (trace_iterator->idx < xbt_dynar_length(trace->event_list) - 1) {
+    xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
+    trace_iterator->idx++;
+  } else if (event->delta > 0) {        /* Last element, checking for periodicity */
+    xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
+    trace_iterator->idx = 1; /* not 0 as the first event is a placeholder to handle when events really start */
+  } else {                      /* We don't need this trace_event anymore */
+    trace_iterator->free_me = 1;
   }
 
   return trace_iterator;
@@ -471,11 +208,10 @@ void tmgr_finalize(void)
   xbt_dict_free(&trace_list);
 }
 
-int tmgr_trace_event_free(tmgr_trace_iterator_t trace_event)
+void tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event)
 {
-  if (trace_event->free_me) {
-    xbt_free(trace_event);
-    return 1;
+  if ((*trace_event)->free_me) {
+    xbt_free(*trace_event);
+    *trace_event = nullptr;
   }
-  return 0;
 }