src/surf/trace_mgr.cpp

   1 /* Copyright (c) 2004-2005, 2007, 2009-2014, 2016-2017. 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/log.h"
   9
  10 #include "src/surf/surf_interface.hpp"
  11 #include "src/surf/trace_mgr.hpp"
  12 #include "surf_private.hpp"
  13 #include "xbt/RngStream.h"
  14 #include <boost/algorithm/string.hpp>
  15 #include <boost/algorithm/string/join.hpp>
  16 #include <boost/algorithm/string/split.hpp>
  17 #include <cmath>
  18 #include <fstream>
  19 #include <sstream>
  20 #include <unordered_map>
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_trace, surf, "Surf trace management");
  23
  24 namespace tmgr = simgrid::trace_mgr;
  25
  26 static std::unordered_map<std::string, tmgr::trace*> trace_list;
  27
  28 static inline bool doubleEq(double d1, double d2)
  29 {
  30   return fabs(d1 - d2) < 0.0001;
  31 }
  32 namespace simgrid {
  33 namespace trace_mgr {
  34
  35 bool DatedValue::operator==(DatedValue e2)
  36 {
  37   return (doubleEq(date_, e2.date_)) && (doubleEq(value_, e2.value_));
  38 }
  39 std::ostream& operator<<(std::ostream& out, const DatedValue& e)
  40 {
  41   out << e.date_ << " " << e.value_;
  42   return out;
  43 }
  44
  45 trace::trace()
  46 {
  47   /* Add the first fake event storing the time at which the trace begins */
  48   tmgr::DatedValue val(0, -1);
  49   event_list.push_back(val);
  50 }
  51 trace::~trace()                  = default;
  52 future_evt_set::future_evt_set() = default;
  53 future_evt_set::~future_evt_set()
  54 {
  55   while (not heap_.empty()) {
  56     delete heap_.top().second;
  57     heap_.pop();
  58   }
  59 }
  60 }
  61 }
  62
  63 tmgr_trace_t tmgr_trace_new_from_string(std::string name, std::string input, double periodicity)
  64 {
  65   int linecount = 0;
  66   tmgr_trace_t trace           = new simgrid::trace_mgr::trace();
  67   tmgr::DatedValue* last_event = &(trace->event_list.back());
  68
  69   xbt_assert(trace_list.find(name) == trace_list.end(), "Refusing to define trace %s twice", name.c_str());
  70
  71   std::vector<std::string> list;
  72   boost::split(list, input, boost::is_any_of("\n\r"));
  73   for (auto val : list) {
  74     tmgr::DatedValue event;
  75     linecount++;
  76     boost::trim(val);
  77     if (val[0] == '#' || val[0] == '\0' || val[0] == '%') // pass comments
  78       continue;
  79     if (sscanf(val.c_str(), "PERIODICITY %lg\n", &periodicity) == 1)
  80       continue;
  81     if (sscanf(val.c_str(), "LOOPAFTER %lg\n", &periodicity) == 1)
  82       continue;
  83
  84     xbt_assert(sscanf(val.c_str(), "%lg  %lg\n", &event.date_, &event.value_) == 2, "%s:%d: Syntax error in trace\n%s",
  85                name.c_str(), linecount, input.c_str());
  86
  87     xbt_assert(last_event->date_ <= event.date_,
  88                "%s:%d: Invalid trace: Events must be sorted, but time %g > time %g.\n%s", name.c_str(), linecount,
  89                last_event->date_, event.date_, input.c_str());
  90     last_event->date_ = event.date_ - last_event->date_;
  91
  92     trace->event_list.push_back(event);
  93     last_event = &(trace->event_list.back());
  94   }
  95   if (last_event) {
  96     if (periodicity > 0) {
  97       last_event->date_ = periodicity + trace->event_list.at(0).date_;
  98     } else {
  99       last_event->date_ = -1;
 100     }
 101   }
 102
 103   trace_list.insert({name, trace});
 104
 105   return trace;
 106 }
 107
 108 tmgr_trace_t tmgr_trace_new_from_file(std::string filename)
 109 {
 110   xbt_assert(not filename.empty(), "Cannot parse a trace from an empty filename");
 111   xbt_assert(trace_list.find(filename) == trace_list.end(), "Refusing to define trace %s twice", filename.c_str());
 112
 113   std::ifstream* f = surf_ifsopen(filename);
 114   xbt_assert(not f->fail(), "Cannot open file '%s' (path=%s)", filename.c_str(), (boost::join(surf_path, ":")).c_str());
 115
 116   std::stringstream buffer;
 117   buffer << f->rdbuf();
 118   delete f;
 119
 120   return tmgr_trace_new_from_string(filename, buffer.str(), -1);
 121 }
 122
 123 /** @brief Registers a new trace into the future event set, and get an iterator over the integrated trace  */
 124 tmgr_trace_event_t simgrid::trace_mgr::future_evt_set::add_trace(tmgr_trace_t trace, surf::Resource* resource)
 125 {
 126   tmgr_trace_event_t trace_iterator = nullptr;
 127
 128   trace_iterator           = new s_tmgr_trace_event_t;
 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                                                                simgrid::surf::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 }