Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / src / smpi / internals / instr_smpi.cpp
index 5c9cf7d..b55f098 100644 (file)
-/* Copyright (c) 2010, 2012-2017. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2010-2018. 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 "private.hpp"
 #include <boost/algorithm/string.hpp>
+#include <simgrid/s4u/Actor.hpp>
 #include <cctype>
 #include <cstdarg>
 #include <cwchar>
 #include <deque>
-#include <simgrid/sg_config.h>
+#include <simgrid/sg_config.hpp>
+#include <simgrid/s4u/Host.hpp>
 #include <string>
+#include <vector>
+
+#include "src/smpi/include/smpi_actor.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",
-    "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",        nullptr,      nullptr,
+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(const char* state)
+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 std::string smpi_container(int rank)
+XBT_PRIVATE container_t smpi_container(int rank)
 {
-  return 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)
@@ -99,22 +138,14 @@ static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
   } else {
     key = it->second->front();
     it->second->pop_front();
+    if (it->second->empty())
+      keys.erase(it);
   }
   return key;
 }
 
 static std::unordered_map<smx_actor_t, std::string> process_category;
 
-static void cleanup_extra_data (instr_extra_data extra){
-  if(extra!=nullptr){
-    if(extra->sendcounts!=nullptr)
-      xbt_free(extra->sendcounts);
-    if(extra->recvcounts!=nullptr)
-      xbt_free(extra->recvcounts);
-    xbt_free(extra);
-  }
-}
-
 void TRACE_internal_smpi_set_category (const char *category)
 {
   if (not TRACE_smpi_is_enabled())
@@ -136,36 +167,30 @@ const char *TRACE_internal_smpi_get_category ()
   return (it == process_category.end()) ? nullptr : it->second.c_str();
 }
 
-void TRACE_smpi_alloc()
-{
-  // for symmetry
-}
-
 void TRACE_smpi_release()
 {
   for (auto const& elm : keys)
     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 = smpi_container(rank);
-
-  container_t father;
-  if (TRACE_smpi_is_grouped()){
-    father = simgrid::instr::Container::byNameOrNull(sg_host_self_get_name());
-  }else{
-    father = simgrid::instr::Container::getRootContainer();
-  }
-  xbt_assert(father != nullptr, "Could not find a parent for mpi rank %s at function %s", str.c_str(), __FUNCTION__);
-#if HAVE_PAPI
-  container_t container =
-#endif
-      new simgrid::instr::Container(str, "MPI", father);
+  TRACE_smpi_setup_container(rank, sg_host_self());
 #if HAVE_PAPI
+  container_t container   = smpi_container(rank);
   papi_counter_t counters = smpi_process()->papi_counters();
 
   for (auto const& it : counters) {
@@ -173,9 +198,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
 }
@@ -185,178 +208,128 @@ void TRACE_smpi_finalize(int rank)
   if (not TRACE_smpi_is_enabled())
     return;
 
-  container_t container = simgrid::instr::Container::byName(smpi_container(rank));
-  container->removeFromParent();
-  delete container;
-}
-
-void TRACE_smpi_collective_in(int rank, const char *operation, instr_extra_data extra)
-{
-  if (not TRACE_smpi_is_enabled()) {
-    cleanup_extra_data(extra);
-    return;
-  }
-
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  const char *color = instr_find_color (operation);
-  state->addEntityValue(operation, color);
-  state->pushEvent(SIMIX_get_clock(), container, operation, static_cast<void*>(extra));
+  smpi_container(rank)->remove_from_parent();
 }
 
-void TRACE_smpi_collective_out(int rank, const char *operation)
+void TRACE_smpi_computing_init(int rank)
 {
-  if (not TRACE_smpi_is_enabled())
-    return;
-
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->popEvent(SIMIX_get_clock(), container);
+ //first use, initialize the color in the trace
+ if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
+   smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
 }
 
-void TRACE_smpi_computing_init(int rank)
+void TRACE_smpi_sleeping_init(int rank)
 {
  //first use, initialize the color in the trace
- if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_computing())
-   return;
-
- container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
- simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
- state->addEntityValue("computing", instr_find_color("computing"));
- state->pushEvent(SIMIX_get_clock(), container, "computing");
+ 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, instr_extra_data extra)
+void TRACE_smpi_computing_in(int rank, double amount)
 {
-  //do not forget to set the color first, otherwise this will explode
-  if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_computing()) {
-    cleanup_extra_data(extra);
-    return;
-  }
-
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->addEntityValue("computing");
-  state->pushEvent(SIMIX_get_clock(), container, "computing", static_cast<void*>(extra));
+  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
+    smpi_container(rank)
+        ->get_state("MPI_STATE")
+        ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
 }
 
 void TRACE_smpi_computing_out(int rank)
 {
-  if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_computing())
-    return;
-
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->popEvent(SIMIX_get_clock(), container);
+  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
+    smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 }
 
-void TRACE_smpi_sleeping_init(int rank)
+void TRACE_smpi_sleeping_in(int rank, double duration)
 {
-  //first use, initialize the color in the trace
-  if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_sleeping())
-    return;
+  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
+    smpi_container(rank)
+        ->get_state("MPI_STATE")
+        ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
+}
 
-  container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->addEntityValue("sleeping", instr_find_color("sleeping"));
-  state->pushEvent(SIMIX_get_clock(), container, "sleeping");
+void TRACE_smpi_sleeping_out(int rank)
+{
+  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
+    smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 }
 
-void TRACE_smpi_sleeping_in(int rank, instr_extra_data extra)
+void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 {
-  //do not forget to set the color first, otherwise this will explode
-  if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_sleeping()) {
-    cleanup_extra_data(extra);
+  if (not TRACE_smpi_is_enabled()) {
+    delete extra;
     return;
   }
 
-  container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->addEntityValue("sleeping");
-  state->pushEvent(SIMIX_get_clock(), container, "sleeping", static_cast<void*>(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_sleeping_out(int rank)
+void TRACE_smpi_comm_out(int rank)
 {
-  if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_sleeping())
-    return;
-
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->popEvent(SIMIX_get_clock(), container);
+  if (TRACE_smpi_is_enabled())
+    smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 }
 
-void TRACE_smpi_testing_in(int rank, instr_extra_data extra)
+void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 {
-  //do not forget to set the color first, otherwise this will explode
-  if (not TRACE_smpi_is_enabled()) {
-    cleanup_extra_data(extra);
+  if (not TRACE_smpi_is_enabled())
     return;
-  }
 
-  container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->addEntityValue("test");
-  state->pushEvent(SIMIX_get_clock(), container, "test", static_cast<void*>(extra));
+  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::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 }
 
-void TRACE_smpi_testing_out(int rank)
+void TRACE_smpi_recv(int src, int dst, int tag)
 {
   if (not TRACE_smpi_is_enabled())
     return;
 
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->popEvent(SIMIX_get_clock(), container);
+  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::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
 }
 
-void TRACE_smpi_ptp_in(int rank, const char *operation, instr_extra_data extra)
+/**************** Functions to trace the migration of tasks. *****************/
+void TRACE_smpi_send_process_data_in(int rank)
 {
-  if (not TRACE_smpi_is_enabled()) {
-    cleanup_extra_data(extra);
-    return;
-  }
+  if (not TRACE_smpi_is_enabled()) return;
 
-  container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->addEntityValue(operation, instr_find_color(operation));
-  state->pushEvent(SIMIX_get_clock(), container, operation, static_cast<void*>(extra));
+  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_ptp_out(int rank, int dst, const char *operation)
+void TRACE_smpi_send_process_data_out(int rank)
 {
-  if (not TRACE_smpi_is_enabled())
-    return;
+  if (not TRACE_smpi_is_enabled()) return; 
 
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
-  state->popEvent(SIMIX_get_clock(), container);
+  /* Clean the process state. */
+  smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
 }
 
-void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
+void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
 {
-  if (not TRACE_smpi_is_enabled())
-    return;
+  if (!TRACE_smpi_is_enabled()) return;
 
-  std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
+  /** 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++;
 
-  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
-  simgrid::instr::Type* type = simgrid::instr::Type::getRootType()->byName("MPI_LINK");
-  XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
-  new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), simgrid::instr::Container::getRootContainer(), type, container,
-                                     "PTP", key, size);
-}
+  // 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);
 
-void TRACE_smpi_recv(int src, int dst, int tag)
-{
-  if (not TRACE_smpi_is_enabled())
-    return;
+  // Destroy container of this rank on this host
+  cont->remove_from_parent();
 
-  std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
+  // Setup container on new host
+  TRACE_smpi_setup_container(rank, new_host);
 
-  container_t container      = simgrid::instr::Container::byName(smpi_container(dst));
-  simgrid::instr::Type* type = simgrid::instr::Type::getRootType()->byName("MPI_LINK");
-  XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
-  new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), simgrid::instr::Container::getRootContainer(), type, container,
-                                   "PTP", key);
+  // 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);
 }