Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / smpi / internals / instr_smpi.cpp
index 91fcf92..00d1a46 100644 (file)
 
 #include "private.hpp"
 #include <boost/algorithm/string.hpp>
+#include <simgrid/s4u/Actor.hpp>
 #include <cctype>
 #include <cstdarg>
 #include <cwchar>
 #include <deque>
 #include <simgrid/sg_config.hpp>
+#include <simgrid/s4u/Host.hpp>
 #include <string>
+#include <vector>
+#include "smpi_process.hpp"
+
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
 
 static std::unordered_map<std::string, std::deque<std::string>*> keys;
 
-static const char* smpi_colors[] = {"recv",
-                                    "1 0 0",
-                                    "irecv",
-                                    "1 0.52 0.52",
-                                    "send",
-                                    "0 0 1",
-                                    "isend",
-                                    "0.52 0.52 1",
-                                    "sendrecv",
-                                    "0 1 1",
-                                    "wait",
-                                    "1 1 0",
-                                    "waitall",
-                                    "0.78 0.78 0",
-                                    "waitany",
-                                    "0.78 0.78 0.58",
-                                    "test",
-                                    "0.52 0.52 0",
-
-                                    "allgather",
-                                    "1 0 0",
-                                    "allgatherv",
-                                    "1 0.52 0.52",
-                                    "allreduce",
-                                    "1 0 1",
-                                    "alltoall",
-                                    "0.52 0 1",
-                                    "alltoallv",
-                                    "0.78 0.52 1",
-                                    "barrier",
-                                    "0 0.78 0.78",
-                                    "bcast",
-                                    "0 0.78 0.39",
-                                    "gather",
-                                    "1 1 0",
-                                    "gatherv",
-                                    "1 1 0.52",
-                                    "reduce",
-                                    "0 1 0",
-                                    "reducescatter",
-                                    "0.52 1 0.52",
-                                    "scan",
-                                    "1 0.58 0.23",
-                                    "exscan",
-                                    "1 0.54 0.25",
-                                    "scatterv",
-                                    "0.52 0 0.52",
-                                    "scatter",
-                                    "1 0.74 0.54",
-
-                                    "computing",
-                                    "0 1 1",
-                                    "sleeping",
-                                    "0 0.5 0.5",
-
-                                    "init",
-                                    "0 1 0",
-                                    "finalize",
-                                    "0 1 0",
-
-                                    "put",
-                                    "0.3 1 0",
-                                    "get",
-                                    "0 1 0.3",
-                                    "accumulate",
-                                    "1 0.3 0",
-                                    "rput",
-                                    "0.3 1 0",
-                                    "rget",
-                                    "0 1 0.3",
-                                    "raccumulate",
-                                    "1 0.3 0",
-                                    "compare_and_swap",
-                                    "0.3 1 0",
-                                    "get_accumulate",
-                                    "0 1 0.3",
-                                    "rget_accumulate",
-                                    "1 0.3 0",
-                                    "win_fence",
-                                    "1 0 0.3",
-                                    "win_post",
-                                    "1 0 0.8",
-                                    "win_wait",
-                                    "1 0.8 0",
-                                    "win_start",
-                                    "0.8 0 1",
-                                    "win_complete",
-                                    "0.8 1 0",
-                                    "win_lock",
-                                    "1 0 0.3",
-                                    "win_unlock",
-                                    "1 0 0.3",
-                                    "win_lock_all",
-                                    "1 0 0.8",
-                                    "win_unlock_all",
-                                    "1 0.8 0",
-                                    "win_flush",
-                                    "1 0 0.3",
-                                    "win_flush_local",
-                                    "1 0 0.8",
-                                    "win_flush_all",
-                                    "1 0.8 0",
-                                    "win_flush_local_all",
-                                    "1 0 0.3",
-                                    "",
-                                    ""};
-
-static const char* instr_find_color(const char* state)
+static std::map<std::string, std::string> smpi_colors = {{"recv", "1 0 0"},
+  {"irecv", "1 0.52 0.52"},
+  {"send", "0 0 1"},
+  {"isend", "0.52 0.52 1"},
+  {"sendrecv", "0 1 1"},
+  {"wait", "1 1 0"},
+  {"waitall", "0.78 0.78 0"},
+  {"waitany", "0.78 0.78 0.58"},
+  {"test", "0.52 0.52 0"},
+
+  {"allgather", "1 0 0"},
+  {"allgatherv", "1 0.52 0.52"},
+  {"allreduce", "1 0 1"},
+  {"alltoall", "0.52 0 1"},
+  {"alltoallv", "0.78 0.52 1"},
+  {"barrier", "0 0.78 0.78"},
+  {"bcast", "0 0.78 0.39"},
+  {"gather", "1 1 0"},
+  {"gatherv", "1 1 0.52"},
+  {"reduce", "0 1 0"},
+  {"reducescatter", "0.52 1 0.52"},
+  {"scan", "1 0.58 0.23"},
+  {"exscan", "1 0.54 0.25"},
+  {"scatterv", "0.52 0 0.52"},
+  {"scatter", "1 0.74 0.54"},
+
+  {"computing", "0 1 1"},
+  {"sleeping", "0 0.5 0.5"},
+
+  {"init", "0 1 0"},
+  {"finalize", "0 1 0"},
+
+  {"put", "0.3 1 0"},
+  {"get", "0 1 0.3"},
+  {"accumulate", "1 0.3 0"},
+  {"migration", "0.2 0.5 0.2"},
+  {"rput", "0.3 1 0"},
+  {"rget", "0 1 0.3"},
+  {"raccumulate", "1 0.3 0"},
+  {"compare_and_swap", "0.3 1 0"},
+  {"get_accumulate", "0 1 0.3"},
+  {"rget_accumulate", "1 0.3 0"},
+  {"win_fence", "1 0 0.3"},
+  {"win_post", "1 0 0.8"},
+  {"win_wait", "1 0.8 0"},
+  {"win_start", "0.8 0 1"},
+  {"win_complete", "0.8 1 0"},
+  {"win_lock", "1 0 0.3"},
+  {"win_unlock", "1 0 0.3"},
+  {"win_lock_all", "1 0 0.8"},
+  {"win_unlock_all", "1 0.8 0"},
+  {"win_flush", "1 0 0.3"},
+  {"win_flush_local", "1 0 0.8"},
+  {"win_flush_all", "1 0.8 0"},
+  {"win_flush_local_all", "1 0 0.3"}
+};
+
+static const char* instr_find_color(std::string state)
 {
-  std::string target = std::string(state);
-  boost::algorithm::to_lower(target);
-  const char* ret     = nullptr;
-  unsigned int i      = 0;
-  const char* current = smpi_colors[i];
-  while (current != nullptr) {
-    if (target == current                          // exact match
-        || strstr(target.c_str(), current) != 0) { // as substring
-      ret = smpi_colors[i + 1];
-      break;
-    }
-    i+=2;
-    current = smpi_colors[i];
+  boost::algorithm::to_lower(state);
+  if (state.substr(0, 5) == "pmpi_")
+    state = state.substr(5, std::string::npos); // Remove pmpi_ to allow for exact matches
+
+  if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
+    return smpi_colors.find(state)->second.c_str();
+  }
+  for (const auto& pair : smpi_colors) { // Is an entry of our map a substring of this state name?
+    if (std::strstr(state.c_str(), pair.first.c_str()) != 0)
+      return pair.second.c_str();
   }
-  return ret;
+
+  return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
 }
 
 XBT_PRIVATE container_t smpi_container(int rank)
 {
-  return simgrid::instr::Container::byName(std::string("rank-") + std::to_string(rank));
+  return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
 }
 
 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
@@ -219,23 +172,24 @@ void TRACE_smpi_release()
     delete elm.second;
 }
 
+void TRACE_smpi_setup_container(int rank, sg_host_t host)
+{
+  container_t father = simgrid::instr::Container::get_root();
+  if (TRACE_smpi_is_grouped()) {
+    father = simgrid::instr::Container::by_name_or_null(host->get_name());
+    xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
+  }
+  father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
+}
+
 void TRACE_smpi_init(int rank)
 {
   if (not TRACE_smpi_is_enabled())
     return;
 
-  std::string str = std::string("rank-") + std::to_string(rank);
-
-  container_t father;
-  if (TRACE_smpi_is_grouped()){
-    father = simgrid::instr::Container::byNameOrNull(sg_host_self_get_name());
-  }else{
-    father = simgrid::instr::Container::getRoot();
-  }
-  xbt_assert(father != nullptr, "Could not find a parent for mpi rank %s at function %s", str.c_str(), __func__);
-  father->createChild(str, "MPI");
+  TRACE_smpi_setup_container(rank, sg_host_self());
 #if HAVE_PAPI
-  container_t container   = simgrid::instr::Container::byName(str);
+  container_t container   = smpi_container(rank);
   papi_counter_t counters = smpi_process()->papi_counters();
 
   for (auto const& it : counters) {
@@ -243,9 +197,7 @@ void TRACE_smpi_init(int rank)
      * Check whether this variable already exists or not. Otherwise, it will be created
      * multiple times but only the last one would be used...
      */
-    if (s_type::getOrNull(it.first.c_str(), container->type_) == nullptr) {
-      Type::variableNew(it.first.c_str(), "", container->type_);
-    }
+    container->type_->by_name_or_create(it.first, "");
   }
 #endif
 }
@@ -255,59 +207,49 @@ void TRACE_smpi_finalize(int rank)
   if (not TRACE_smpi_is_enabled())
     return;
 
-  smpi_container(rank)->removeFromParent();
+  smpi_container(rank)->remove_from_parent();
 }
 
 void TRACE_smpi_computing_init(int rank)
 {
  //first use, initialize the color in the trace
  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
-   smpi_container(rank)->getState("MPI_STATE")->addEntityValue("computing", instr_find_color("computing"));
+   smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
+}
+
+void TRACE_smpi_sleeping_init(int rank)
+{
+ //first use, initialize the color in the trace
+ if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
+   smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
 }
 
 void TRACE_smpi_computing_in(int rank, double amount)
 {
   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
     smpi_container(rank)
-        ->getState("MPI_STATE")
-        ->pushEvent("computing", new simgrid::instr::CpuTIData("compute", amount));
+        ->get_state("MPI_STATE")
+        ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
 }
 
 void TRACE_smpi_computing_out(int rank)
 {
   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
-    smpi_container(rank)->getState("MPI_STATE")->popEvent();
+    smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 }
 
 void TRACE_smpi_sleeping_in(int rank, double duration)
 {
   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
     smpi_container(rank)
-        ->getState("MPI_STATE")
-        ->pushEvent("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
+        ->get_state("MPI_STATE")
+        ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 }
 
 void TRACE_smpi_sleeping_out(int rank)
 {
-  if (TRACE_smpi_is_enabled() && not TRACE_smpi_is_sleeping())
-    smpi_container(rank)->getState("MPI_STATE")->popEvent();
-}
-
-void TRACE_smpi_testing_in(int rank)
-{
-  //do not forget to set the color first, otherwise this will explode
-  if (not TRACE_smpi_is_enabled())
-    return;
-
-  simgrid::instr::StateType* state = smpi_container(rank)->getState("MPI_STATE");
-  state->addEntityValue("test");
-  state->pushEvent("test", new simgrid::instr::NoOpTIData("test"));
-}
-
-void TRACE_smpi_testing_out(int rank)
-{
-  if (TRACE_smpi_is_enabled())
-    smpi_container(rank)->getState("MPI_STATE")->popEvent();
+  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
+    smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 }
 
 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
@@ -317,15 +259,15 @@ void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData*
     return;
   }
 
-  simgrid::instr::StateType* state = smpi_container(rank)->getState("MPI_STATE");
-  state->addEntityValue(operation, instr_find_color(operation));
-  state->pushEvent(operation, extra);
+  simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
+  state->add_entity_value(operation, instr_find_color(operation));
+  state->push_event(operation, extra);
 }
 
 void TRACE_smpi_comm_out(int rank)
 {
   if (TRACE_smpi_is_enabled())
-    smpi_container(rank)->getState("MPI_STATE")->popEvent();
+    smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 }
 
 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
@@ -336,7 +278,7 @@ void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 
   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
-  simgrid::instr::Container::getRoot()->getLink("MPI_LINK")->startEvent(smpi_container(rank), "PTP", key, size);
+  simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 }
 
 void TRACE_smpi_recv(int src, int dst, int tag)
@@ -347,5 +289,46 @@ void TRACE_smpi_recv(int src, int dst, int tag)
   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 
   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
-  simgrid::instr::Container::getRoot()->getLink("MPI_LINK")->endEvent(smpi_container(dst), "PTP", key);
+  simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
+}
+
+/**************** Functions to trace the migration of tasks. *****************/
+void TRACE_smpi_send_process_data_in(int rank)
+{
+  if (not TRACE_smpi_is_enabled()) return;
+
+  smpi_container(rank)->get_state("MIGRATE_STATE")->add_entity_value("migration", instr_find_color("migration"));
+  smpi_container(rank)->get_state("MIGRATE_STATE")->push_event("migration");
+}
+
+void TRACE_smpi_send_process_data_out(int rank)
+{
+  if (not TRACE_smpi_is_enabled()) return; 
+
+  /* Clean the process state. */
+  smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
+}
+
+void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
+{
+  if (!TRACE_smpi_is_enabled()) return;
+
+  /** The key is (most likely) used to match the events in the trace */
+  static long long int counter = 0;
+  std::string key              = std::to_string(counter);
+  counter++;
+
+  // start link (= tell the trace that this rank moves from A to B)
+  container_t cont = smpi_container(rank);
+  simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
+
+  // Destroy container of this rank on this host
+  cont->remove_from_parent();
+
+  // Setup container on new host
+  TRACE_smpi_setup_container(rank, new_host);
+
+  // end link
+  cont = smpi_container(rank); // This points to the newly created container
+  simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);
 }