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