src/smpi/internals/instr_smpi.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 "private.hpp"
   7 #include <boost/algorithm/string.hpp>
   8 #include <simgrid/s4u/Actor.hpp>
   9 #include <cctype>
  10 #include <cstdarg>
  11 #include <cwchar>
  12 #include <deque>
  13 #include <simgrid/sg_config.hpp>
  14 #include <simgrid/s4u/Host.hpp>
  15 #include <string>
  16 #include <vector>
  17
  18 #include "src/smpi/include/smpi_actor.hpp"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
  21
  22 static std::unordered_map<std::string, std::deque<std::string>> keys;
  23
  24 static std::map<std::string, std::string, std::less<>> smpi_colors = {{"recv", "1 0 0"},
  25                                                                       {"irecv", "1 0.52 0.52"},
  26                                                                       {"send", "0 0 1"},
  27                                                                       {"isend", "0.52 0.52 1"},
  28                                                                       {"sendrecv", "0 1 1"},
  29                                                                       {"wait", "1 1 0"},
  30                                                                       {"waitall", "0.78 0.78 0"},
  31                                                                       {"waitany", "0.78 0.78 0.58"},
  32                                                                       {"test", "0.52 0.52 0"},
  33
  34                                                                       {"allgather", "1 0 0"},
  35                                                                       {"allgatherv", "1 0.52 0.52"},
  36                                                                       {"allreduce", "1 0 1"},
  37                                                                       {"alltoall", "0.52 0 1"},
  38                                                                       {"alltoallv", "0.78 0.52 1"},
  39                                                                       {"barrier", "0 0.39 0.78"},
  40                                                                       {"bcast", "0 0.78 0.39"},
  41                                                                       {"gather", "1 1 0"},
  42                                                                       {"gatherv", "1 1 0.52"},
  43                                                                       {"reduce", "0 1 0"},
  44                                                                       {"reducescatter", "0.52 1 0.52"},
  45                                                                       {"scan", "1 0.58 0.23"},
  46                                                                       {"exscan", "1 0.54 0.25"},
  47                                                                       {"scatterv", "0.52 0 0.52"},
  48                                                                       {"scatter", "1 0.74 0.54"},
  49
  50                                                                       {"computing", "0 1 1"},
  51                                                                       {"sleeping", "0 0.5 0.5"},
  52
  53                                                                       {"init", "0 1 0"},
  54                                                                       {"finalize", "0 1 0"},
  55
  56                                                                       {"put", "0.3 1 0"},
  57                                                                       {"get", "0 1 0.3"},
  58                                                                       {"accumulate", "1 0.3 0"},
  59                                                                       {"rput", "0.3 1 0"},
  60                                                                       {"rget", "0 1 0.3"},
  61                                                                       {"raccumulate", "1 0.3 0"},
  62                                                                       {"compare_and_swap", "0.3 1 0"},
  63                                                                       {"get_accumulate", "0 1 0.3"},
  64                                                                       {"rget_accumulate", "1 0.3 0"},
  65                                                                       {"win_fence", "1 0 0.3"},
  66                                                                       {"win_post", "1 0 0.8"},
  67                                                                       {"win_wait", "1 0.8 0"},
  68                                                                       {"win_start", "0.8 0 1"},
  69                                                                       {"win_complete", "0.8 1 0"},
  70                                                                       {"win_lock", "1 0 0.3"},
  71                                                                       {"win_unlock", "1 0 0.3"},
  72                                                                       {"win_lock_all", "1 0 0.8"},
  73                                                                       {"win_unlock_all", "1 0.8 0"},
  74                                                                       {"win_flush", "1 0 0.3"},
  75                                                                       {"win_flush_local", "1 0 0.8"},
  76                                                                       {"win_flush_all", "1 0.8 0"},
  77                                                                       {"win_flush_local_all", "1 0 0.3"},
  78
  79                                                                       {"file_read", "1 1 0.3"}};
  80
  81 static const char* instr_find_color(const char* c_state)
  82 {
  83   std::string state(c_state);
  84   boost::algorithm::to_lower(state);
  85   if (state.substr(0, 5) == "pmpi_")
  86     state = state.substr(5, std::string::npos); // Remove pmpi_ to allow for exact matches
  87
  88   if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
  89     return smpi_colors.find(state)->second.c_str();
  90   }
  91   for (const auto& pair : smpi_colors) { // Is an entry of our map a substring of this state name?
  92     if (std::strstr(state.c_str(), pair.first.c_str()) != nullptr)
  93       return pair.second.c_str();
  94   }
  95
  96   return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
  97 }
  98
  99 XBT_PRIVATE simgrid::instr::Container* smpi_container(int rank)
 100 {
 101   return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
 102 }
 103
 104 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
 105 {
 106   //generate the key
 107   static unsigned long long counter = 0;
 108   counter++;
 109   std::string key =
 110       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
 111
 112   //push it
 113   std::string aux =
 114       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
 115   keys[aux].push_back(key);
 116
 117   return key;
 118 }
 119
 120 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
 121 {
 122   std::string key;
 123   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
 124                     std::to_string(send == 1 ? 0 : 1);
 125   auto it = keys.find(aux);
 126   if (it == keys.end()) {
 127     // first posted
 128     key = TRACE_smpi_put_key(src, dst, tag, send);
 129   } else {
 130     key = it->second.front();
 131     it->second.pop_front();
 132     if (it->second.empty())
 133       keys.erase(it);
 134   }
 135   return key;
 136 }
 137
 138 void TRACE_smpi_setup_container(int rank, const_sg_host_t host)
 139 {
 140   auto* father = simgrid::instr::Container::get_root();
 141   if (TRACE_smpi_is_grouped()) {
 142     father = simgrid::instr::Container::by_name_or_null(host->get_name());
 143     xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
 144   }
 145   father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
 146 }
 147
 148 void TRACE_smpi_init(int rank, const std::string& calling_func)
 149 {
 150   if (not TRACE_smpi_is_enabled())
 151     return;
 152
 153   auto self = simgrid::s4u::Actor::self();
 154
 155   TRACE_smpi_setup_container(rank, sg_host_self());
 156   simgrid::s4u::this_actor::on_exit([self](bool) { smpi_container(self->get_pid())->remove_from_parent(); });
 157
 158   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
 159
 160   state->add_entity_value(calling_func, instr_find_color(calling_func.c_str()));
 161   state->push_event(calling_func, new simgrid::instr::NoOpTIData("init"));
 162   state->pop_event();
 163   if (TRACE_smpi_is_computing())
 164     state->add_entity_value("computing", instr_find_color("computing"));
 165   if (TRACE_smpi_is_sleeping())
 166     state->add_entity_value("sleeping", instr_find_color("sleeping"));
 167
 168 #if HAVE_PAPI
 169   const simgrid::instr::Container* container = smpi_container(rank);
 170   papi_counter_t counters = smpi_process()->papi_counters();
 171
 172   for (auto const& it : counters) {
 173     /**
 174      * Check whether this variable already exists or not. Otherwise, it will be created
 175      * multiple times but only the last one would be used...
 176      */
 177     container->type_->by_name_or_create(it.first, "");
 178   }
 179 #endif
 180 }
 181
 182 void TRACE_smpi_sleeping_in(int rank, double duration)
 183 {
 184   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 185     smpi_container(rank)
 186         ->get_state("MPI_STATE")
 187         ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 188 }
 189
 190 void TRACE_smpi_sleeping_out(int rank)
 191 {
 192   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 193     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 194 }
 195
 196 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 197 {
 198   if (not TRACE_smpi_is_enabled()) {
 199     delete extra;
 200     return;
 201   }
 202
 203   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
 204   state->add_entity_value(operation, instr_find_color(operation));
 205   state->push_event(operation, extra);
 206 }
 207
 208 void TRACE_smpi_comm_out(int rank)
 209 {
 210   if (TRACE_smpi_is_enabled())
 211     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 212 }
 213
 214 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 215 {
 216   if (not TRACE_smpi_is_enabled())
 217     return;
 218
 219   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 220
 221   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 222   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 223 }
 224
 225 void TRACE_smpi_recv(int src, int dst, int tag)
 226 {
 227   if (not TRACE_smpi_is_enabled())
 228     return;
 229
 230   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 231
 232   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 233   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
 234 }