src/surf/trace_mgr.cpp

   1 /* Copyright (c) 2004-2005, 2007, 2009-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "xbt/sysdep.h"
   8 #include "xbt/log.h"
   9 #include "xbt/str.h"
  10 #include "xbt/dict.h"
  11 #include "src/surf/trace_mgr.hpp"
  12 #include "surf_private.h"
  13 #include "xbt/RngStream.h"
  14 #include <math.h>
  15 #include <unordered_map>
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_trace, surf, "Surf trace management");
  18
  19 static std::unordered_map<const char *, simgrid::trace_mgr::trace*> trace_list;
  20
  21 simgrid::trace_mgr::trace::trace()
  22 {
  23   event_list = xbt_dynar_new(sizeof(s_tmgr_event_t), NULL);
  24 }
  25
  26 simgrid::trace_mgr::trace::~trace()
  27 {
  28   xbt_dynar_free(&event_list);
  29 }
  30 simgrid::trace_mgr::future_evt_set::future_evt_set()
  31 {
  32 }
  33
  34 simgrid::trace_mgr::future_evt_set::~future_evt_set()
  35 {
  36   xbt_heap_free(p_heap);
  37 }
  38
  39 tmgr_trace_t tmgr_trace_new_from_string(const char *name, const char *input, double periodicity)
  40 {
  41   int linecount = 0;
  42   tmgr_event_t last_event = NULL;
  43   unsigned int cpt;
  44   char *val;
  45
  46   xbt_assert(trace_list.find(name) == trace_list.end(), "Refusing to define trace %s twice", name);
  47   xbt_assert(periodicity >= 0, "Invalid periodicity %g (must be positive)", periodicity);
  48
  49   tmgr_trace_t trace = new simgrid::trace_mgr::trace();
  50
  51   xbt_dynar_t list = xbt_str_split(input, "\n\r");
  52   xbt_dynar_foreach(list, cpt, val) {
  53     s_tmgr_event_t event;
  54     linecount++;
  55     xbt_str_trim(val, " \t\n\r\x0B");
  56     if (val[0] == '#' || val[0] == '\0' || val[0] == '%') // pass comments
  57       continue;
  58
  59     if (sscanf(val, "PERIODICITY " "%lg" "\n", &periodicity) == 1)
  60       continue;
  61
  62     xbt_assert(sscanf(val, "%lg" " " "%lg" "\n", &event.delta, &event.value) == 2,
  63         "%s:%d: Syntax error in trace\n%s", name, linecount, input);
  64
  65     if (last_event) {
  66       xbt_assert(last_event->delta <= event.delta,
  67           "%s:%d: Invalid trace: Events must be sorted, but time %g > time %g.\n%s",
  68           name, linecount, last_event->delta, event.delta, input);
  69
  70       last_event->delta = event.delta - last_event->delta;
  71     } else {
  72       if(event.delta > 0.0){
  73         s_tmgr_event_t first_event;
  74         first_event.delta=event.delta;
  75         first_event.value=-1.0;
  76         xbt_dynar_push(trace->event_list, &first_event);
  77       }
  78     }
  79     xbt_dynar_push(trace->event_list, &event);
  80     last_event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, xbt_dynar_length(trace->event_list) - 1);
  81   }
  82   if (last_event)
  83     last_event->delta = periodicity;
  84
  85   trace_list.insert({xbt_strdup(name), trace});
  86
  87   xbt_dynar_free(&list);
  88   return trace;
  89 }
  90
  91 tmgr_trace_t tmgr_trace_new_from_file(const char *filename)
  92 {
  93   xbt_assert(filename && filename[0], "Cannot parse a trace from the null or empty filename");
  94   xbt_assert(trace_list.find(filename) == trace_list.end(), "Refusing to define trace %s twice", filename);
  95
  96   FILE *f = surf_fopen(filename, "r");
  97   xbt_assert(f != NULL,
  98       "Cannot open file '%s' (path=%s)", filename, xbt_str_join(surf_path, ":"));
  99
 100   char *tstr = xbt_str_from_file(f);
 101   fclose(f);
 102   tmgr_trace_t trace = tmgr_trace_new_from_string(filename, tstr, 0.);
 103   xbt_free(tstr);
 104
 105   return trace;
 106 }
 107
 108 tmgr_trace_t tmgr_empty_trace_new(void)
 109 {
 110   tmgr_trace_t trace = new simgrid::trace_mgr::trace();
 111   s_tmgr_event_t event;
 112   event.delta = 0.0;
 113   event.value = 0.0;
 114   xbt_dynar_push(trace->event_list, &event);
 115
 116   return trace;
 117 }
 118
 119 void tmgr_trace_free(tmgr_trace_t trace)
 120 {
 121   delete trace;
 122 }
 123
 124 /** @brief Registers a new trace into the future event set, and get an iterator over the integrated trace  */
 125 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(tmgr_trace_t trace, double start_time, surf::Resource *resource)
 126 {
 127   tmgr_trace_iterator_t trace_iterator = NULL;
 128
 129   trace_iterator = xbt_new0(s_tmgr_trace_event_t, 1);
 130   trace_iterator->trace = trace;
 131   trace_iterator->idx = 0;
 132   trace_iterator->resource = resource;
 133
 134   xbt_assert((trace_iterator->idx < xbt_dynar_length(trace->event_list)), "Your trace should have at least one event!");
 135
 136   xbt_heap_push(p_heap, trace_iterator, start_time);
 137
 138   return trace_iterator;
 139 }
 140
 141 /** @brief returns the date of the next occurring event (pure function) */
 142 double simgrid::trace_mgr::future_evt_set::next_date() const
 143 {
 144   if (xbt_heap_size(p_heap))
 145     return (xbt_heap_maxkey(p_heap));
 146   else
 147     return -1.0;
 148 }
 149
 150 /** @brief Retrieves the next occurring event, or NULL if none happens before #date */
 151 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::pop_leq(
 152     double date, double *value, simgrid::surf::Resource **resource)
 153 {
 154   double event_date = next_date();
 155   if (event_date > date)
 156     return NULL;
 157
 158   tmgr_trace_iterator_t trace_iterator = (tmgr_trace_iterator_t)xbt_heap_pop(p_heap);
 159   if (trace_iterator == NULL)
 160     return NULL;
 161
 162   tmgr_trace_t trace = trace_iterator->trace;
 163   *resource = trace_iterator->resource;
 164
 165   tmgr_event_t event = (tmgr_event_t)xbt_dynar_get_ptr(trace->event_list, trace_iterator->idx);
 166
 167   *value = event->value;
 168
 169   if (trace_iterator->idx < xbt_dynar_length(trace->event_list) - 1) {
 170     xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
 171     trace_iterator->idx++;
 172   } else if (event->delta > 0) {        /* Last element, checking for periodicity */
 173     xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
 174     trace_iterator->idx = 1; /* not 0 as the first event is a placeholder to handle when events really start */
 175   } else {                      /* We don't need this trace_event anymore */
 176     trace_iterator->free_me = 1;
 177   }
 178
 179   return trace_iterator;
 180 }
 181
 182 void tmgr_finalize(void)
 183 {
 184   for (auto kv : trace_list) {
 185     xbt_free((char*)kv.first);
 186     delete kv.second;
 187   }
 188 }
 189
 190 void tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event)
 191 {
 192   if ((*trace_event)->free_me) {
 193     xbt_free(*trace_event);
 194     *trace_event = nullptr;
 195   }
 196 }