Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
change simgrid::surf::Resource into simgrid::kernel::model::Resource
[simgrid.git] / src / surf / trace_mgr.cpp
index cc0eedd..c5b9e2f 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2005, 2007, 2009-2014. The SimGrid Team.
+/* Copyright (c) 2004-2005, 2007, 2009-2014, 2016-2017. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
-#include "xbt/str.h"
-#include "xbt/dict.h"
+
+#include "src/surf/surf_interface.hpp"
 #include "src/surf/trace_mgr.hpp"
-#include "surf_private.h"
+#include "surf_private.hpp"
 #include "xbt/RngStream.h"
-#include <math.h>
+#include <boost/algorithm/string.hpp>
+#include <boost/algorithm/string/join.hpp>
+#include <boost/algorithm/string/split.hpp>
+#include <cmath>
+#include <fstream>
+#include <sstream>
+#include <unordered_map>
 
 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() {
-}
+namespace tmgr = simgrid::trace_mgr;
 
-simgrid::trace_mgr::future_evt_set::~future_evt_set()
-{
-  xbt_heap_free(p_heap);
-}
+static std::unordered_map<std::string, tmgr::trace*> trace_list;
 
-#if 0 /* probabilistic dead code. Should be reimplemented, not killed (please) */
-/**
- * \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)
+static inline bool doubleEq(double d1, double d2)
 {
-  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;
+  return fabs(d1 - d2) < 0.0001;
 }
+namespace simgrid {
+namespace trace_mgr {
 
-/**
- * \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)
+bool DatedValue::operator==(DatedValue e2)
 {
-  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;
+  return (doubleEq(date_, e2.date_)) && (doubleEq(value_, e2.value_));
 }
-
-/**
- * \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)
+std::ostream& operator<<(std::ostream& out, const DatedValue& e)
 {
-  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;
+  out << e.date_ << " " << e.value_;
+  return out;
 }
 
-/**
- * \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)
+trace::trace()
 {
-  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;
+  /* Add the first fake event storing the time at which the trace begins */
+  tmgr::DatedValue val(0, -1);
+  event_list.push_back(val);
 }
-
-
-/**
- * \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)
+trace::~trace()                  = default;
+future_evt_set::future_evt_set() = default;
+future_evt_set::~future_evt_set()
 {
-  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;
+  while (not heap_.empty()) {
+    delete heap_.top().second;
+    heap_.pop();
+  }
 }
-
-/**
- * \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;
 }
-#endif /* probabilistic dead code */
 
-tmgr_trace_t tmgr_trace_new_from_string(const char *id, const char *input,
-                                        double periodicity)
+tmgr_trace_t tmgr_trace_new_from_string(std::string name, std::string input, double periodicity)
 {
-  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 = (tmgr_trace_t)xbt_dict_get_or_null(trace_list, id);
-    if (trace) {
-      XBT_WARN("Ignoring redefinition of trace %s", id);
-      return trace;
-    }
-  }
-
-  xbt_assert(periodicity >= 0,
-              "Invalid periodicity %g (must be positive)", periodicity);
+  tmgr_trace_t trace           = new simgrid::trace_mgr::trace();
+  tmgr::DatedValue* last_event = &(trace->event_list.back());
 
-  trace = xbt_new0(s_tmgr_trace_t, 1);
-  trace->event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
+  xbt_assert(trace_list.find(name) == trace_list.end(), "Refusing to define trace %s twice", name.c_str());
 
-  list = xbt_str_split(input, "\n\r");
-
-  xbt_dynar_foreach(list, cpt, val) {
+  std::vector<std::string> list;
+  boost::split(list, input, boost::is_any_of("\n\r"));
+  for (auto val : list) {
+    tmgr::DatedValue event;
     linecount++;
-    xbt_str_trim(val, " \t\n\r\x0B");
-    if (val[0] == '#' || val[0] == '\0' || val[0] == '%')
+    boost::trim(val);
+    if (val[0] == '#' || val[0] == '\0' || val[0] == '%') // pass comments
       continue;
-
-    if (sscanf(val, "PERIODICITY " "%lg" "\n", &periodicity) == 1)
+    if (sscanf(val.c_str(), "PERIODICITY %lg\n", &periodicity) == 1)
+      continue;
+    if (sscanf(val.c_str(), "LOOPAFTER %lg\n", &periodicity) == 1)
       continue;
 
-    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) {
-        xbt_die("%s:%d: Invalid trace: Events must be sorted, "
-                "but time %g > time %g.\n%s",
-                id, linecount, last_event->delta, event.delta, input);
-      }
-      last_event->delta = event.delta - last_event->delta;
-    } else {
-      if(event.delta > 0.0){
-        s_tmgr_event_t first_event;
-        first_event.delta=event.delta;
-        first_event.value=-1.0;
-        xbt_dynar_push(trace->event_list, &first_event);
-      }
-    }
-    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;
-
-  if (!trace_list)
-    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;
-}
-
-tmgr_trace_t tmgr_trace_new_from_file(const char *filename)
-{
-  tmgr_trace_t trace = NULL;
+    xbt_assert(sscanf(val.c_str(), "%lg  %lg\n", &event.date_, &event.value_) == 2, "%s:%d: Syntax error in trace\n%s",
+               name.c_str(), linecount, input.c_str());
 
-  if ((!filename) || (strcmp(filename, "") == 0))
-    return NULL;
+    xbt_assert(last_event->date_ <= event.date_,
+               "%s:%d: Invalid trace: Events must be sorted, but time %g > time %g.\n%s", name.c_str(), linecount,
+               last_event->date_, event.date_, input.c_str());
+    last_event->date_ = event.date_ - last_event->date_;
 
-  if (trace_list) {
-    trace = (tmgr_trace_t)xbt_dict_get_or_null(trace_list, filename);
-    if (trace) {
-      XBT_WARN("Ignoring redefinition of trace %s", filename);
-      return trace;
+    trace->event_list.push_back(event);
+    last_event = &(trace->event_list.back());
+  }
+  if (last_event) {
+    if (periodicity > 0) {
+      last_event->date_ = periodicity + trace->event_list.at(0).date_;
+    } else {
+      last_event->date_ = -1;
     }
   }
 
-  FILE *f = surf_fopen(filename, "r");
-  xbt_assert(f != NULL,
-      "Cannot open file '%s' (path=%s)", filename, xbt_str_join(surf_path, ":"));
-
-  char *tstr = xbt_str_from_file(f);
-  fclose(f);
-  trace = tmgr_trace_new_from_string(filename, tstr, 0.);
-  xbt_free(tstr);
+  trace_list.insert({name, trace});
 
   return trace;
 }
 
-tmgr_trace_t tmgr_empty_trace_new(void)
+tmgr_trace_t tmgr_trace_new_from_file(std::string filename)
 {
-  tmgr_trace_t trace = 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);
+  xbt_assert(not filename.empty(), "Cannot parse a trace from an empty filename");
+  xbt_assert(trace_list.find(filename) == trace_list.end(), "Refusing to define trace %s twice", filename.c_str());
 
-  event.delta = 0.0;
-  event.value = 0.0;
-  xbt_dynar_push(trace->event_list, &event);
+  std::ifstream* f = surf_ifsopen(filename);
+  xbt_assert(not f->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(), (boost::join(surf_path, ":")).c_str());
 
-  return trace;
-}
-
-void tmgr_trace_free(tmgr_trace_t trace)
-{
-  if (!trace)
-    return;
+  std::stringstream buffer;
+  buffer << f->rdbuf();
+  delete f;
 
-  xbt_dynar_free(&(trace->event_list));
-  free(trace);
+  return tmgr_trace_new_from_string(filename, buffer.str(), -1);
 }
 
 /** @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_event_t simgrid::trace_mgr::future_evt_set::add_trace(tmgr_trace_t trace, kernel::model::Resource* resource)
 {
-  tmgr_trace_iterator_t trace_iterator = NULL;
+  tmgr_trace_event_t trace_iterator = nullptr;
 
-  trace_iterator = xbt_new0(s_tmgr_trace_event_t, 1);
-  trace_iterator->trace = trace;
-  trace_iterator->idx = 0;
+  trace_iterator           = new s_tmgr_trace_event_t;
+  trace_iterator->trace    = trace;
+  trace_iterator->idx      = 0;
   trace_iterator->resource = resource;
+  trace_iterator->free_me  = false;
 
-  xbt_assert((trace_iterator->idx < xbt_dynar_length(trace->event_list)),
-      "Your trace should have at least one event!");
+  xbt_assert((trace_iterator->idx < trace->event_list.size()), "Your trace should have at least one event!");
 
-  xbt_heap_push(p_heap, trace_iterator, start_time);
+  heap_.emplace(0.0 /* start time */, trace_iterator);
 
   return trace_iterator;
 }
@@ -383,53 +141,53 @@ tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(
 /** @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));
-  else
-    return -1.0;
+  return heap_.empty() ? -1.0 : heap_.top().first;
 }
 
-/** @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, simgrid::surf::Resource **resource)
+/** @brief Retrieves the next occurring event, or nullptr if none happens before #date */
+tmgr_trace_event_t simgrid::trace_mgr::future_evt_set::pop_leq(double date, double* value,
+                                                               kernel::model::Resource** resource)
 {
   double event_date = next_date();
   if (event_date > date)
-    return NULL;
+    return nullptr;
 
-  tmgr_trace_iterator_t trace_iterator = (tmgr_trace_iterator_t)xbt_heap_pop(p_heap);
-  if (trace_iterator == NULL)
-    return NULL;
+  if (heap_.empty())
+    return nullptr;
+  tmgr_trace_event_t trace_iterator = heap_.top().second;
+  heap_.pop();
 
   tmgr_trace_t trace = trace_iterator->trace;
   *resource = trace_iterator->resource;
 
-  tmgr_event_t event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, trace_iterator->idx);
+  tmgr::DatedValue dateVal = trace->event_list.at(trace_iterator->idx);
 
-  *value = event->value;
+  *value = dateVal.value_;
 
-  if (trace_iterator->idx < xbt_dynar_length(trace->event_list) - 1) {
-    xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
+  if (trace_iterator->idx < trace->event_list.size() - 1) {
+    heap_.emplace(event_date + dateVal.date_, trace_iterator);
     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;
+  } else if (dateVal.date_ > 0) { /* Last element. Shall we loop? */
+    heap_.emplace(event_date + dateVal.date_, trace_iterator);
+    trace_iterator->idx = 1; /* idx=0 is a placeholder to store when events really start */
+  } else {                   /* If we don't loop, we don't need this trace_event anymore */
+    trace_iterator->free_me = true;
   }
 
   return trace_iterator;
 }
 
-void tmgr_finalize(void)
+void tmgr_finalize()
 {
-  xbt_dict_free(&trace_list);
+  for (auto const& kv : trace_list)
+    delete kv.second;
+  trace_list.clear();
 }
 
-void tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event)
+void tmgr_trace_event_unref(tmgr_trace_event_t* trace_event)
 {
   if ((*trace_event)->free_me) {
-    xbt_free(*trace_event);
+    delete *trace_event;
     *trace_event = nullptr;
   }
 }