1 /* Copyright (c) 2010, 2012-2015, 2017. The SimGrid Team.
2 * All rights reserved. */
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. */
9 #include "xbt/replay.hpp"
11 #include <boost/algorithm/string.hpp>
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(replay,xbt,"Replay trace reader");
18 std::ifstream* action_fs = nullptr;
19 std::unordered_map<std::string, action_fun> action_funs;
21 static void read_and_trim_line(std::ifstream* fs, std::string* line)
24 std::getline(*fs, *line);
26 } while (not fs->eof() && (line->length() == 0 || line->front() == '#'));
27 XBT_DEBUG("got from trace: %s", line->c_str());
35 explicit ReplayReader(const char* filename)
37 XBT_VERB("Prepare to replay file '%s'", filename);
38 fs = new std::ifstream(filename, std::ifstream::in);
39 xbt_assert(fs->is_open(), "Cannot read replay file '%s'", filename);
41 ReplayReader(const ReplayReader&) = delete;
46 bool get(ReplayAction* action);
49 bool ReplayReader::get(ReplayAction* action)
51 read_and_trim_line(fs, &line);
53 boost::split(*action, line, boost::is_any_of(" \t"), boost::token_compress_on);
57 static ReplayAction get_action(char* name)
61 std::queue<ReplayAction*>* myqueue = nullptr;
62 if (action_queues.find(std::string(name)) != action_queues.end())
63 myqueue = action_queues.at(std::string(name));
64 if (myqueue == nullptr || myqueue->empty()) { // Nothing stored for me. Read the file further
65 // Read lines until I reach something for me (which breaks in loop body) or end of file reached
67 std::string action_line;
68 read_and_trim_line(action_fs, &action_line);
71 /* we cannot split in place here because we parse&store several lines for the colleagues... */
72 action = new ReplayAction();
73 boost::split(*action, action_line, boost::is_any_of(" \t"), boost::token_compress_on);
75 // if it's for me, I'm done
76 std::string evtname = action->front();
77 if (evtname.compare(name) == 0) {
80 // Else, I have to store it for the relevant colleague
81 std::queue<ReplayAction*>* otherqueue = nullptr;
82 auto act = action_queues.find(evtname);
83 if (act != action_queues.end()) {
84 otherqueue = act->second;
85 } else { // Damn. Create the queue of that guy
86 otherqueue = new std::queue<ReplayAction*>();
87 action_queues.insert({evtname, otherqueue});
89 otherqueue->push(action);
92 // end of file reached while searching in vain for more work
94 // Get something from my queue and return it
95 action = myqueue->front();
100 return ReplayAction();
103 static void handle_action(ReplayAction& action)
105 XBT_DEBUG("%s replays a %s action", action.at(0).c_str(), action.at(1).c_str());
106 action_fun function = action_funs.at(action.at(1));
109 } catch (xbt_ex& e) {
111 xbt_die("Replay error:\n %s", e.what());
116 * \ingroup XBT_replay
117 * \brief function used internally to actually run the replay
119 int replay_runner(int argc, char* argv[])
121 if (simgrid::xbt::action_fs) { // A unique trace file
123 simgrid::xbt::ReplayAction evt(std::move(simgrid::xbt::get_action(argv[0])));
126 simgrid::xbt::handle_action(evt);
128 if (action_queues.find(std::string(argv[0])) != action_queues.end()) {
129 std::queue<ReplayAction*>* myqueue = action_queues.at(std::string(argv[0]));
131 action_queues.erase(std::string(argv[0]));
133 } else { // Should have got my trace file in argument
134 simgrid::xbt::ReplayAction evt;
135 xbt_assert(argc >= 2, "No '%s' agent function provided, no simulation-wide trace file provided, "
136 "and no process-wide trace file provided in deployment file. Aborting.",
138 simgrid::xbt::ReplayReader reader(argv[1]);
139 while (reader.get(&evt)) {
140 if (evt.front().compare(argv[0]) == 0) {
141 simgrid::xbt::handle_action(evt);
143 XBT_WARN("Ignore trace element not for me");
154 * \ingroup XBT_replay
155 * \brief Registers a function to handle a kind of action
157 * Registers a function to handle a kind of action
158 * This table is then used by \ref xbt_replay_action_runner
160 * The argument of the function is the line describing the action, fields separated by spaces.
162 * \param action_name the reference name of the action.
163 * \param function prototype given by the type: void...(const char** action)
165 void xbt_replay_action_register(const char* action_name, action_fun function)
167 simgrid::xbt::action_funs[std::string(action_name)] = function;
171 * \ingroup XBT_replay
172 * \brief Get the function that was previously registered to handle a kind of action
174 * This can be useful if you want to override and extend an existing action.
176 action_fun xbt_replay_action_get(const char* action_name)
178 return simgrid::xbt::action_funs.at(std::string(action_name));