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