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