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       /* We need to add the first fake event stating the time at which the trace begins */
  70       if (event.delta > 0.0) {
  71         s_tmgr_event_t first_event;
  72         first_event.delta=event.delta;
  73         first_event.value=-1.0;
  74         trace->event_list.push_back(first_event);
  75       }
  76     }
  77     trace->event_list.push_back(event);
  78     last_event = &(trace->event_list.back());
  79   }
  80   if (last_event) {
  81     last_event->delta = periodicity > 0 ? periodicity + trace->event_list.at(0).delta : -1;
  82   }
  83
  84   trace_list.insert({xbt_strdup(name), trace});
  85
  86   return trace;
  87 }
  88
  89 tmgr_trace_t tmgr_trace_new_from_file(const char *filename)
  90 {
  91   xbt_assert(filename && filename[0], "Cannot parse a trace from the null or empty filename");
  92   xbt_assert(trace_list.find(filename) == trace_list.end(), "Refusing to define trace %s twice", filename);
  93
  94   std::ifstream* f = surf_ifsopen(filename);
  95   xbt_assert(!f->fail(), "Cannot open file '%s' (path=%s)", filename, (boost::join(surf_path, ":")).c_str());
  96
  97   std::stringstream buffer;
  98   buffer << f->rdbuf();
  99   tmgr_trace_t trace = tmgr_trace_new_from_string(filename, buffer.str(), -1);
 100
 101   delete f;
 102
 103   return trace;
 104 }
 105
 106 tmgr_trace_t tmgr_empty_trace_new()
 107 {
 108   tmgr_trace_t trace = new simgrid::trace_mgr::trace();
 109   s_tmgr_event_t event;
 110   event.delta = 0.0;
 111   event.value = 0.0;
 112   trace->event_list.push_back(event);
 113
 114   return trace;
 115 }
 116
 117 void tmgr_trace_free(tmgr_trace_t trace)
 118 {
 119   delete trace;
 120 }
 121
 122 /** @brief Registers a new trace into the future event set, and get an iterator over the integrated trace  */
 123 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::add_trace(tmgr_trace_t trace, double start_time, surf::Resource *resource)
 124 {
 125   tmgr_trace_iterator_t trace_iterator = nullptr;
 126
 127   trace_iterator = xbt_new0(s_tmgr_trace_event_t, 1);
 128   trace_iterator->trace = trace;
 129   trace_iterator->idx = 0;
 130   trace_iterator->resource = resource;
 131
 132   xbt_assert((trace_iterator->idx < trace->event_list.size()), "Your trace should have at least one event!");
 133
 134   xbt_heap_push(p_heap, trace_iterator, start_time);
 135
 136   return trace_iterator;
 137 }
 138
 139 /** @brief returns the date of the next occurring event (pure function) */
 140 double simgrid::trace_mgr::future_evt_set::next_date() const
 141 {
 142   if (xbt_heap_size(p_heap))
 143     return (xbt_heap_maxkey(p_heap));
 144   else
 145     return -1.0;
 146 }
 147
 148 /** @brief Retrieves the next occurring event, or nullptr if none happens before #date */
 149 tmgr_trace_iterator_t simgrid::trace_mgr::future_evt_set::pop_leq(double date, double* value,
 150                                                                   simgrid::surf::Resource** resource)
 151 {
 152   double event_date = next_date();
 153   if (event_date > date)
 154     return nullptr;
 155
 156   tmgr_trace_iterator_t trace_iterator = (tmgr_trace_iterator_t)xbt_heap_pop(p_heap);
 157   if (trace_iterator == nullptr)
 158     return nullptr;
 159
 160   tmgr_trace_t trace = trace_iterator->trace;
 161   *resource = trace_iterator->resource;
 162
 163   tmgr_event_t event = &(trace->event_list.at(trace_iterator->idx));
 164
 165   *value = event->value;
 166
 167   if (trace_iterator->idx < trace->event_list.size() - 1) {
 168     xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
 169     trace_iterator->idx++;
 170   } else if (event->delta > 0) { /* Last element. Shall we loop? */
 171     xbt_heap_push(p_heap, trace_iterator, event_date + event->delta);
 172     trace_iterator->idx = 1; /* idx=0 is a placeholder to store when events really start */
 173   } else {                   /* If we don't loop, we don't need this trace_event anymore */
 174     trace_iterator->free_me = 1;
 175   }
 176
 177   return trace_iterator;
 178 }
 179
 180 void tmgr_finalize()
 181 {
 182   for (auto kv : trace_list) {
 183     xbt_free((char*)kv.first);
 184     delete kv.second;
 185   }
 186 }
 187
 188 void tmgr_trace_event_unref(tmgr_trace_iterator_t *trace_event)
 189 {
 190   if ((*trace_event)->free_me) {
 191     xbt_free(*trace_event);
 192     *trace_event = nullptr;
 193   }
 194 }