X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d50966bb4d6140a3cffa65cb45812a1f67c3bcf7..HEAD:/src/xbt/xbt_replay.cpp

diff --git a/src/xbt/xbt_replay.cpp b/src/xbt/xbt_replay.cpp
index f2c6ae26d6..d58bab1efc 100644
--- a/src/xbt/xbt_replay.cpp
+++ b/src/xbt/xbt_replay.cpp
@@ -1,230 +1,176 @@
-/* Copyright (c) 2010, 2012-2015, 2017. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2010-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "src/internal_config.h"
-#include "xbt/ex.hpp"
+#include "simgrid/Exception.hpp"
 #include "xbt/log.h"
 #include "xbt/replay.hpp"
-#include "xbt/str.h"
-#include "xbt/sysdep.h"
 
 #include <boost/algorithm/string.hpp>
-#include <ctype.h>
-#include <errno.h>
-#include <fstream>
-#include <queue>
-#include <unordered_map>
-#include <wchar.h>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(replay,xbt,"Replay trace reader");
 
-xbt_dict_t xbt_action_queues = nullptr;
-bool is_replay_active        = false;
+namespace simgrid::xbt {
 
-namespace simgrid {
-namespace xbt {
+static std::ifstream action_fs;
 
-std::ifstream* action_fs = nullptr;
 std::unordered_map<std::string, action_fun> action_funs;
-typedef std::vector<std::string> ReplayAction;
+static std::unordered_map<std::string, std::queue<std::unique_ptr<ReplayAction>>> action_queues;
 
-static void read_and_trim_line(std::ifstream* fs, std::string* line)
+static void read_and_trim_line(std::ifstream& fs, std::string* line)
 {
-  std::getline(*fs, *line);
-  boost::trim(*line);
+  do {
+    std::getline(fs, *line);
+    boost::trim(*line);
+  } while (not fs.eof() && (line->length() == 0 || line->front() == '#'));
   XBT_DEBUG("got from trace: %s", line->c_str());
 }
 
 class ReplayReader {
-  std::ifstream* fs;
+  std::ifstream fs;
   std::string line;
 
 public:
-  char* filename_;
-  int linenum = 0;
-
-  explicit ReplayReader(const char* filename)
-  {
-    filename_ = xbt_strdup(filename);
-    fs        = new std::ifstream(filename, std::ifstream::in);
-  }
-  ~ReplayReader()
+  explicit ReplayReader(const char* filename) : fs(filename, std::ifstream::in)
   {
-    free(filename_);
-    delete fs;
+    XBT_VERB("Prepare to replay file '%s'", filename);
+    xbt_assert(fs.is_open(), "Cannot read replay file '%s'", filename);
   }
+  ReplayReader(const ReplayReader&) = delete;
+  ReplayReader& operator=(const ReplayReader&) = delete;
   bool get(ReplayAction* action);
 };
 
 bool ReplayReader::get(ReplayAction* action)
 {
   read_and_trim_line(fs, &line);
-  linenum++;
-
-  if (line.length() > 0 && line.find("#") == std::string::npos) {
-    boost::split(*action, line, boost::is_any_of(" \t"), boost::token_compress_on);
-    return !fs->eof();
-  } else {
-    if (fs->eof())
-      return false;
-    else
-      return this->get(action);
-  }
-}
 
-void replay_init()
-{
-  if (!is_replay_active) {
-    xbt_action_queues = xbt_dict_new_homogeneous(nullptr);
-    is_replay_active  = true;
-  }
+  boost::split(*action, line, boost::is_any_of(" \t"), boost::token_compress_on);
+  return not fs.eof();
 }
 
-void replay_exit()
+static std::unique_ptr<ReplayAction> get_action(const char* name)
 {
-  xbt_dict_free(&xbt_action_queues);
-  xbt_action_queues = nullptr;
-}
-
-bool replay_is_active()
-{
-  return is_replay_active;
-}
-
-static ReplayAction* get_action(char* name)
-{
-  ReplayAction* action;
-
-  std::queue<ReplayAction*>* myqueue =
-      static_cast<std::queue<ReplayAction*>*>(xbt_dict_get_or_null(xbt_action_queues, name));
-  if (myqueue == nullptr || myqueue->empty()) { // Nothing stored for me. Read the file further
-    if (action_fs == nullptr) {                 // File closed now. There's nothing more to read. I'm out of here
-      goto todo_done;
-    }
-    // Read lines until I reach something for me (which breaks in loop body) or end of file reached
-    while (!action_fs->eof()) {
-      std::string action_line;
-      read_and_trim_line(action_fs, &action_line);
-      if (action_line.length() > 0 && action_line.find("#") == std::string::npos) {
-        /* we cannot split in place here because we parse&store several lines for the colleagues... */
-        action = new ReplayAction();
-        boost::split(*action, action_line, boost::is_any_of(" \t"), boost::token_compress_on);
-
-        // if it's for me, I'm done
-        std::string evtname = action->front();
-        if (evtname.compare(name) == 0) {
-          return action;
-        } else {
-          // Else, I have to store it for the relevant colleague
-          std::queue<ReplayAction*>* otherqueue =
-              static_cast<std::queue<ReplayAction*>*>(xbt_dict_get_or_null(xbt_action_queues, evtname.c_str()));
-          if (otherqueue == nullptr) { // Damn. Create the queue of that guy
-            otherqueue = new std::queue<ReplayAction*>();
-            xbt_dict_set(xbt_action_queues, evtname.c_str(), otherqueue, nullptr);
-          }
-          otherqueue->push(action);
-        }
-      }
+  if (auto queue_elt = action_queues.find(name); queue_elt != action_queues.end()) {
+    if (auto& my_queue = queue_elt->second; not my_queue.empty()) {
+      // Get something from my queue and return it
+      auto action = std::move(my_queue.front());
+      my_queue.pop();
+      return action;
     }
-    // end of file reached while searching in vain for more work
-  } else {
-    // Get something from my queue and return it
-    action = myqueue->front();
-    myqueue->pop();
-    return action;
   }
 
-// All my actions in the file are done and either I or a colleague closed the file. Let's cleanup before leaving.
-todo_done:
-  if (myqueue != nullptr) {
-    delete myqueue;
-    xbt_dict_remove(xbt_action_queues, name);
+  // Nothing stored for me. Read the file further
+  // Read lines until I reach something for me (which breaks in loop body) or end of file reached
+  while (true) {
+    std::string action_line;
+    read_and_trim_line(action_fs, &action_line);
+    if (action_fs.eof())
+      break;
+    /* we cannot split in place here because we parse&store several lines for the colleagues... */
+    auto action = std::make_unique<ReplayAction>();
+    boost::split(*action, action_line, boost::is_any_of(" \t"), boost::token_compress_on);
+
+    // if it's for me, I'm done
+    std::string evtname = action->front();
+    if (evtname == name)
+      return action;
+
+    // else, I have to store it for the relevant colleague
+    action_queues[evtname].emplace(std::move(action));
   }
+  // end of file reached while searching in vain for more work
+
   return nullptr;
 }
 
-static void handle_action(ReplayAction* action)
+static void handle_action(ReplayAction& action)
 {
-  XBT_DEBUG("%s replays a %s action", action->at(0).c_str(), action->at(1).c_str());
-  char** c_action     = new char*[action->size() + 1];
-  action_fun function = action_funs.at(action->at(1));
-  int i               = 0;
-  for (auto arg : *action) {
-    c_action[i] = xbt_strdup(arg.c_str());
-    i++;
+  XBT_DEBUG("%s replays a %s action", action.at(0).c_str(), action.at(1).c_str());
+  action_fun function;
+  try {
+    function = action_funs.at(action.at(1));
+  } catch (const std::out_of_range&) {
+    xbt_die("Replay Error: action %s is unknown, please register it properly in the replay engine",  action.at(1).c_str());
   }
-  c_action[i] = nullptr;
   try {
-    function(c_action);
-  } catch (xbt_ex& e) {
-    for (unsigned int j = 0; j < action->size(); j++)
-      xbt_free(c_action[j]);
-    delete[] c_action;
-    action->clear();
-    xbt_die("Replay error:\n %s", e.what());
+    function(action);
+  } catch (const Exception&) {
+    action.clear();
+    throw;
   }
-  for (unsigned int j = 0; j < action->size(); j++)
-    xbt_free(c_action[j]);
-  delete[] c_action;
 }
 
 /**
- * \ingroup XBT_replay
- * \brief function used internally to actually run the replay
-
- * \param argc argc .
- * \param argv argv
+ * @ingroup XBT_replay
+ * @brief function used internally to actually run the replay
  */
-int replay_runner(int argc, char* argv[])
+int replay_runner(const char* actor_name, const char* trace_filename)
 {
-  if (simgrid::xbt::action_fs) { // A unique trace file
+  std::string actor_name_string(actor_name);
+  if (simgrid::xbt::action_fs.is_open()) { // <A unique trace file
+    xbt_assert(trace_filename == nullptr,
+               "Passing nullptr to replay_runner() means that you want to use a shared trace, but you did not provide "
+               "any. Please use xbt_replay_set_tracefile().");
     while (true) {
-      simgrid::xbt::ReplayAction* evt = simgrid::xbt::get_action(argv[0]);
-      if (evt == nullptr)
+      auto evt = simgrid::xbt::get_action(actor_name);
+      if (not evt)
         break;
-      simgrid::xbt::handle_action(evt);
-      delete evt;
+      simgrid::xbt::handle_action(*evt);
     }
+    action_queues.erase(actor_name_string);
   } else { // Should have got my trace file in argument
-    simgrid::xbt::ReplayAction* evt = new simgrid::xbt::ReplayAction();
-    xbt_assert(argc >= 2, "No '%s' agent function provided, no simulation-wide trace file provided, "
-                          "and no process-wide trace file provided in deployment file. Aborting.",
-               argv[0]);
-    simgrid::xbt::ReplayReader* reader = new simgrid::xbt::ReplayReader(argv[1]);
-    while (reader->get(evt)) {
-      if (evt->at(0).compare(argv[0]) == 0) {
+    xbt_assert(trace_filename != nullptr,
+               "Trace replay cannot mix shared and unshared traces for now. Please don't set a shared tracefile with "
+               "xbt_replay_set_tracefile() if you use actor-specific trace files using the second parameter of "
+               "replay_runner().");
+    simgrid::xbt::ReplayAction evt;
+    simgrid::xbt::ReplayReader reader(trace_filename);
+    while (reader.get(&evt)) {
+      if (evt.front() == actor_name) {
         simgrid::xbt::handle_action(evt);
       } else {
-        XBT_WARN("%s:%d: Ignore trace element not for me", reader->filename_, reader->linenum);
+        XBT_WARN("Ignore trace element not for me (target='%s', I am '%s')", evt.front().c_str(), actor_name);
       }
-      evt->clear();
+      evt.clear();
     }
-    delete evt;
-    delete reader;
   }
   return 0;
 }
-}
-}
+} // namespace simgrid::xbt
 
 /**
- * \ingroup XBT_replay
- * \brief Registers a function to handle a kind of action
+ * @ingroup XBT_replay
+ * @brief Registers a function to handle a kind of action
  *
  * Registers a function to handle a kind of action
- * This table is then used by \ref xbt_replay_action_runner
+ * This table is then used by @ref simgrid::xbt::replay_runner
  *
  * The argument of the function is the line describing the action, fields separated by spaces.
  *
- * \param action_name the reference name of the action.
- * \param function prototype given by the type: void...(const char** action)
+ * @param action_name the reference name of the action.
+ * @param function prototype given by the type: void...(simgrid::xbt::ReplayAction& action)
  */
-void xbt_replay_action_register(const char* action_name, action_fun function)
+void xbt_replay_action_register(const char* action_name, const action_fun& function)
+{
+  simgrid::xbt::action_funs[action_name] = function;
+}
+
+/**
+ * @ingroup XBT_replay
+ * @brief Get the function that was previously registered to handle a kind of action
+ *
+ * This can be useful if you want to override and extend an existing action.
+ */
+action_fun xbt_replay_action_get(const char* action_name)
+{
+  return simgrid::xbt::action_funs.at(action_name);
+}
+
+void xbt_replay_set_tracefile(const std::string& filename)
 {
-  if (!is_replay_active) // If the user registers a function before the start
-    simgrid::xbt::replay_init();
-  simgrid::xbt::action_funs.insert({std::string(action_name), function});
+  xbt_assert(not simgrid::xbt::action_fs.is_open(), "Tracefile already set");
+  simgrid::xbt::action_fs.open(filename, std::ifstream::in);
+  xbt_assert(simgrid::xbt::action_fs.is_open(), "Failed to open file: %s", filename.c_str());
 }