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