src/xbt/xbt_replay.cpp

   1 /* Copyright (c) 2010-2021. 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 "simgrid/Exception.hpp"
   7 #include "xbt/log.h"
   8 #include "xbt/replay.hpp"
   9
  10 #include <boost/algorithm/string.hpp>
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(replay,xbt,"Replay trace reader");
  13
  14 namespace simgrid {
  15 namespace xbt {
  16
  17 std::ifstream* action_fs = nullptr;
  18 std::unordered_map<std::string, action_fun> action_funs;
  19 static std::unordered_map<std::string, std::queue<ReplayAction*>*> action_queues;
  20
  21 static void read_and_trim_line(std::ifstream& fs, std::string* line)
  22 {
  23   do {
  24     std::getline(fs, *line);
  25     boost::trim(*line);
  26   } while (not fs.eof() && (line->length() == 0 || line->front() == '#'));
  27   XBT_DEBUG("got from trace: %s", line->c_str());
  28 }
  29
  30 class ReplayReader {
  31   std::ifstream fs;
  32   std::string line;
  33
  34 public:
  35   explicit ReplayReader(const char* filename) : fs(filename, std::ifstream::in)
  36   {
  37     XBT_VERB("Prepare to replay file '%s'", filename);
  38     xbt_assert(fs.is_open(), "Cannot read replay file '%s'", filename);
  39   }
  40   ReplayReader(const ReplayReader&) = delete;
  41   ReplayReader& operator=(const ReplayReader&) = delete;
  42   bool get(ReplayAction* action);
  43 };
  44
  45 bool ReplayReader::get(ReplayAction* action)
  46 {
  47   read_and_trim_line(fs, &line);
  48
  49   boost::split(*action, line, boost::is_any_of(" \t"), boost::token_compress_on);
  50   return not fs.eof();
  51 }
  52
  53 static ReplayAction* get_action(const char* name)
  54 {
  55   ReplayAction* action;
  56
  57   std::queue<ReplayAction*>* myqueue = nullptr;
  58   if (action_queues.find(std::string(name)) != action_queues.end())
  59     myqueue = action_queues.at(std::string(name));
  60   if (myqueue == nullptr || myqueue->empty()) { // Nothing stored for me. Read the file further
  61     // Read lines until I reach something for me (which breaks in loop body) or end of file reached
  62     while (true) {
  63       std::string action_line;
  64       read_and_trim_line(*action_fs, &action_line);
  65       if (action_fs->eof())
  66         break;
  67       /* we cannot split in place here because we parse&store several lines for the colleagues... */
  68       action = new ReplayAction();
  69       boost::split(*action, action_line, boost::is_any_of(" \t"), boost::token_compress_on);
  70
  71       // if it's for me, I'm done
  72       std::string evtname = action->front();
  73       if (evtname.compare(name) == 0)
  74         return action;
  75
  76       // Else, I have to store it for the relevant colleague
  77       std::queue<ReplayAction*>* otherqueue = nullptr;
  78       auto act                              = action_queues.find(evtname);
  79       if (act != action_queues.end()) {
  80         otherqueue = act->second;
  81       } else { // Damn. Create the queue of that guy
  82         otherqueue = new std::queue<ReplayAction*>();
  83         action_queues.insert({evtname, otherqueue});
  84       }
  85       otherqueue->push(action);
  86     }
  87     // end of file reached while searching in vain for more work
  88   } else {
  89     // Get something from my queue and return it
  90     action = myqueue->front();
  91     myqueue->pop();
  92     return action;
  93   }
  94
  95   return nullptr;
  96 }
  97
  98 static void handle_action(ReplayAction& action)
  99 {
 100   XBT_DEBUG("%s replays a %s action", action.at(0).c_str(), action.at(1).c_str());
 101   action_fun function = action_funs.at(action.at(1));
 102   try {
 103     function(action);
 104   } catch (const Exception& e) {
 105     action.clear();
 106     xbt_die("Replay error:\n %s", e.what());
 107   }
 108 }
 109
 110 /**
 111  * @ingroup XBT_replay
 112  * @brief function used internally to actually run the replay
 113  */
 114 int replay_runner(const char* actor_name, const char* trace_filename)
 115 {
 116   std::string actor_name_string(actor_name);
 117   if (simgrid::xbt::action_fs) { // <A unique trace file
 118     while (true) {
 119       simgrid::xbt::ReplayAction* evt = simgrid::xbt::get_action(actor_name);
 120       if (!evt)
 121         break;
 122       simgrid::xbt::handle_action(*evt);
 123       delete evt;
 124     }
 125     if (action_queues.find(actor_name_string) != action_queues.end()) {
 126       delete action_queues.at(actor_name_string);
 127       action_queues.erase(actor_name_string);
 128     }
 129   } else { // Should have got my trace file in argument
 130     xbt_assert(trace_filename != nullptr);
 131     simgrid::xbt::ReplayAction evt;
 132     simgrid::xbt::ReplayReader reader(trace_filename);
 133     while (reader.get(&evt)) {
 134       if (evt.front().compare(actor_name) == 0) {
 135         simgrid::xbt::handle_action(evt);
 136       } else {
 137         XBT_WARN("Ignore trace element not for me (target='%s', I am '%s')", evt.front().c_str(), actor_name);
 138       }
 139       evt.clear();
 140     }
 141   }
 142   return 0;
 143 }
 144 }
 145 }
 146
 147 /**
 148  * @ingroup XBT_replay
 149  * @brief Registers a function to handle a kind of action
 150  *
 151  * Registers a function to handle a kind of action
 152  * This table is then used by @ref simgrid::xbt::replay_runner
 153  *
 154  * The argument of the function is the line describing the action, fields separated by spaces.
 155  *
 156  * @param action_name the reference name of the action.
 157  * @param function prototype given by the type: void...(const char** action)
 158  */
 159 void xbt_replay_action_register(const char* action_name, const action_fun& function)
 160 {
 161   simgrid::xbt::action_funs[std::string(action_name)] = function;
 162 }
 163
 164 /**
 165  * @ingroup XBT_replay
 166  * @brief Get the function that was previously registered to handle a kind of action
 167  *
 168  * This can be useful if you want to override and extend an existing action.
 169  */
 170 action_fun xbt_replay_action_get(const char* action_name)
 171 {
 172   return simgrid::xbt::action_funs.at(std::string(action_name));
 173 }