src/smpi/internals/instr_smpi.cpp

   1 /* Copyright (c) 2010-2019. 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> 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
  80 static const char* instr_find_color(const char* c_state)
  81 {
  82   std::string state(c_state);
  83   boost::algorithm::to_lower(state);
  84   if (state.substr(0, 5) == "pmpi_")
  85     state = state.substr(5, std::string::npos); // Remove pmpi_ to allow for exact matches
  86
  87   if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
  88     return smpi_colors.find(state)->second.c_str();
  89   }
  90   for (const auto& pair : smpi_colors) { // Is an entry of our map a substring of this state name?
  91     if (std::strstr(state.c_str(), pair.first.c_str()) != 0)
  92       return pair.second.c_str();
  93   }
  94
  95   return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
  96 }
  97
  98 XBT_PRIVATE container_t smpi_container(int rank)
  99 {
 100   return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
 101 }
 102
 103 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
 104 {
 105   //generate the key
 106   static unsigned long long counter = 0;
 107   counter++;
 108   std::string key =
 109       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
 110
 111   //push it
 112   std::string aux =
 113       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
 114   keys[aux].push_back(key);
 115
 116   return key;
 117 }
 118
 119 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
 120 {
 121   std::string key;
 122   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
 123                     std::to_string(send == 1 ? 0 : 1);
 124   auto it = keys.find(aux);
 125   if (it == keys.end()) {
 126     // first posted
 127     key = TRACE_smpi_put_key(src, dst, tag, send);
 128   } else {
 129     key = it->second.front();
 130     it->second.pop_front();
 131     if (it->second.empty())
 132       keys.erase(it);
 133   }
 134   return key;
 135 }
 136
 137 void TRACE_smpi_setup_container(int rank, sg_host_t host)
 138 {
 139   container_t father = simgrid::instr::Container::get_root();
 140   if (TRACE_smpi_is_grouped()) {
 141     father = simgrid::instr::Container::by_name_or_null(host->get_name());
 142     xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
 143   }
 144   father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
 145 }
 146
 147 void TRACE_smpi_init(int rank)
 148 {
 149   if (not TRACE_smpi_is_enabled())
 150     return;
 151
 152   TRACE_smpi_setup_container(rank, sg_host_self());
 153 #if HAVE_PAPI
 154   container_t container   = smpi_container(rank);
 155   papi_counter_t counters = smpi_process()->papi_counters();
 156
 157   for (auto const& it : counters) {
 158     /**
 159      * Check whether this variable already exists or not. Otherwise, it will be created
 160      * multiple times but only the last one would be used...
 161      */
 162     container->type_->by_name_or_create(it.first, "");
 163   }
 164 #endif
 165 }
 166
 167 void TRACE_smpi_finalize(int rank)
 168 {
 169   if (not TRACE_smpi_is_enabled())
 170     return;
 171
 172   smpi_container(rank)->remove_from_parent();
 173 }
 174
 175 void TRACE_smpi_computing_init(int rank)
 176 {
 177  //first use, initialize the color in the trace
 178  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 179    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
 180 }
 181
 182 void TRACE_smpi_sleeping_init(int rank)
 183 {
 184  //first use, initialize the color in the trace
 185  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 186    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
 187 }
 188
 189 void TRACE_smpi_computing_in(int rank, double amount)
 190 {
 191   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 192     smpi_container(rank)
 193         ->get_state("MPI_STATE")
 194         ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
 195 }
 196
 197 void TRACE_smpi_computing_out(int rank)
 198 {
 199   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 200     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 201 }
 202
 203 void TRACE_smpi_sleeping_in(int rank, double duration)
 204 {
 205   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 206     smpi_container(rank)
 207         ->get_state("MPI_STATE")
 208         ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 209 }
 210
 211 void TRACE_smpi_sleeping_out(int rank)
 212 {
 213   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 214     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 215 }
 216
 217 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 218 {
 219   if (not TRACE_smpi_is_enabled()) {
 220     delete extra;
 221     return;
 222   }
 223
 224   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
 225   state->add_entity_value(operation, instr_find_color(operation));
 226   state->push_event(operation, extra);
 227 }
 228
 229 void TRACE_smpi_comm_out(int rank)
 230 {
 231   if (TRACE_smpi_is_enabled())
 232     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 233 }
 234
 235 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 236 {
 237   if (not TRACE_smpi_is_enabled())
 238     return;
 239
 240   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 241
 242   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 243   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 244 }
 245
 246 void TRACE_smpi_recv(int src, int dst, int tag)
 247 {
 248   if (not TRACE_smpi_is_enabled())
 249     return;
 250
 251   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 252
 253   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 254   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
 255 }
 256
 257 /**************** Functions to trace the migration of tasks. *****************/
 258 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
 259 {
 260   if (not TRACE_smpi_is_enabled()) return;
 261
 262   /** The key is (most likely) used to match the events in the trace */
 263   static long long int counter = 0;
 264   std::string key              = std::to_string(counter);
 265   counter++;
 266
 267   // start link (= tell the trace that this rank moves from A to B)
 268   container_t cont = smpi_container(rank);
 269   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
 270
 271   // Destroy container of this rank on this host
 272   cont->remove_from_parent();
 273
 274   // Setup container on new host
 275   TRACE_smpi_setup_container(rank, new_host);
 276
 277   // end link
 278   cont = smpi_container(rank); // This points to the newly created container
 279   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);
 280 }