src/surf/trace_mgr.cpp

   1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "xbt/sysdep.h"
   7 #include "xbt/log.h"
   8
   9 #include "src/surf/surf_interface.hpp"
  10 #include "src/surf/trace_mgr.hpp"
  11 #include "surf_private.hpp"
  12 #include "xbt/RngStream.h"
  13 #include <boost/algorithm/string.hpp>
  14 #include <boost/algorithm/string/join.hpp>
  15 #include <boost/algorithm/string/split.hpp>
  16 #include <cmath>
  17 #include <fstream>
  18 #include <sstream>
  19 #include <unordered_map>
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_trace, surf, "Surf trace management");
  22
  23 namespace tmgr = simgrid::trace_mgr;
  24
  25 static std::unordered_map<std::string, tmgr::trace*> trace_list;
  26
  27 static inline bool doubleEq(double d1, double d2)
  28 {
  29   return fabs(d1 - d2) < 0.0001;
  30 }
  31 namespace simgrid {
  32 namespace trace_mgr {
  33
  34 bool DatedValue::operator==(DatedValue e2)
  35 {
  36   return (doubleEq(date_, e2.date_)) && (doubleEq(value_, e2.value_));
  37 }
  38 std::ostream& operator<<(std::ostream& out, const DatedValue& e)
  39 {
  40   out << e.date_ << " " << e.value_;
  41   return out;
  42 }
  43
  44 trace::trace()
  45 {
  46   /* Add the first fake event storing the time at which the trace begins */
  47   tmgr::DatedValue val(0, -1);
  48   event_list.push_back(val);
  49 }
  50 trace::~trace()                  = default;
  51 future_evt_set::future_evt_set() = default;
  52 future_evt_set::~future_evt_set()
  53 {
  54   while (not heap_.empty()) {
  55     delete heap_.top().second;
  56     heap_.pop();
  57   }
  58 }
  59 }
  60 }
  61
  62 tmgr_trace_t tmgr_trace_new_from_string(std::string name, std::string input, double periodicity)
  63 {
  64   int linecount = 0;
  65   tmgr_trace_t trace           = new simgrid::trace_mgr::trace();
  66   tmgr::DatedValue* last_event = &(trace->event_list.back());
  67
  68   xbt_assert(trace_list.find(name) == trace_list.end(), "Refusing to define trace %s twice", name.c_str());
  69
  70   std::vector<std::string> list;
  71   boost::split(list, input, boost::is_any_of("\n\r"));
  72   for (auto val : list) {
  73     tmgr::DatedValue event;
  74     linecount++;
  75     boost::trim(val);
  76     if (val[0] == '#' || val[0] == '\0' || val[0] == '%') // pass comments
  77       continue;
  78     if (sscanf(val.c_str(), "PERIODICITY %lg\n", &periodicity) == 1)
  79       continue;
  80     if (sscanf(val.c_str(), "LOOPAFTER %lg\n", &periodicity) == 1)
  81       continue;
  82
  83     xbt_assert(sscanf(val.c_str(), "%lg  %lg\n", &event.date_, &event.value_) == 2, "%s:%d: Syntax error in trace\n%s",
  84                name.c_str(), linecount, input.c_str());
  85
  86     xbt_assert(last_event->date_ <= event.date_,
  87                "%s:%d: Invalid trace: Events must be sorted, but time %g > time %g.\n%s", name.c_str(), linecount,
  88                last_event->date_, event.date_, input.c_str());
  89     last_event->date_ = event.date_ - last_event->date_;
  90
  91     trace->event_list.push_back(event);
  92     last_event = &(trace->event_list.back());
  93   }
  94   if (last_event) {
  95     if (periodicity > 0) {
  96       last_event->date_ = periodicity + trace->event_list.at(0).date_;
  97     } else {
  98       last_event->date_ = -1;
  99     }
 100   }
 101
 102   trace_list.insert({name, trace});
 103
 104   return trace;
 105 }
 106
 107 tmgr_trace_t tmgr_trace_new_from_file(std::string filename)
 108 {
 109   xbt_assert(not filename.empty(), "Cannot parse a trace from an empty filename");
 110   xbt_assert(trace_list.find(filename) == trace_list.end(), "Refusing to define trace %s twice", filename.c_str());
 111
 112   std::ifstream* f = surf_ifsopen(filename);
 113   xbt_assert(not f->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(), (boost::join(surf_path, ":")).c_str());
 114
 115   std::stringstream buffer;
 116   buffer << f->rdbuf();
 117   delete f;
 118
 119   return tmgr_trace_new_from_string(filename, buffer.str(), -1);
 120 }
 121
 122 /** @brief Registers a new trace into the future event set, and get an iterator over the integrated trace  */
 123 tmgr_trace_event_t simgrid::trace_mgr::future_evt_set::add_trace(tmgr_trace_t trace,
 124                                                                  kernel::resource::Resource* resource)
 125 {
 126   tmgr_trace_event_t trace_iterator = nullptr;
 127
 128   trace_iterator           = new simgrid::kernel::resource::TraceEvent();
 129   trace_iterator->trace    = trace;
 130   trace_iterator->idx      = 0;
 131   trace_iterator->resource = resource;
 132   trace_iterator->free_me  = false;
 133
 134   xbt_assert((trace_iterator->idx < trace->event_list.size()), "Your trace should have at least one event!");
 135
 136   heap_.emplace(0.0 /* start time */, trace_iterator);
 137
 138   return trace_iterator;
 139 }
 140
 141 /** @brief returns the date of the next occurring event (pure function) */
 142 double simgrid::trace_mgr::future_evt_set::next_date() const
 143 {
 144   return heap_.empty() ? -1.0 : heap_.top().first;
 145 }
 146
 147 /** @brief Retrieves the next occurring event, or nullptr if none happens before date */
 148 tmgr_trace_event_t simgrid::trace_mgr::future_evt_set::pop_leq(double date, double* value,
 149                                                                kernel::resource::Resource** resource)
 150 {
 151   double event_date = next_date();
 152   if (event_date > date)
 153     return nullptr;
 154
 155   if (heap_.empty())
 156     return nullptr;
 157   tmgr_trace_event_t trace_iterator = heap_.top().second;
 158   heap_.pop();
 159
 160   tmgr_trace_t trace = trace_iterator->trace;
 161   *resource = trace_iterator->resource;
 162
 163   tmgr::DatedValue dateVal = trace->event_list.at(trace_iterator->idx);
 164
 165   *value = dateVal.value_;
 166
 167   if (trace_iterator->idx < trace->event_list.size() - 1) {
 168     heap_.emplace(event_date + dateVal.date_, trace_iterator);
 169     trace_iterator->idx++;
 170   } else if (dateVal.date_ > 0) { /* Last element. Shall we loop? */
 171     heap_.emplace(event_date + dateVal.date_, trace_iterator);
 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 = true;
 175   }
 176
 177   return trace_iterator;
 178 }
 179
 180 void tmgr_finalize()
 181 {
 182   for (auto const& kv : trace_list)
 183     delete kv.second;
 184   trace_list.clear();
 185 }
 186
 187 void tmgr_trace_event_unref(tmgr_trace_event_t* trace_event)
 188 {
 189   if ((*trace_event)->free_me) {
 190     delete *trace_event;
 191     *trace_event = nullptr;
 192   }
 193 }