src/smpi/internals/instr_smpi.cpp

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