src/smpi/internals/instr_smpi.cpp

   1 /* Copyright (c) 2010-2018. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "private.hpp"
   8 #include <boost/algorithm/string.hpp>
   9 #include <simgrid/s4u/Actor.hpp>
  10 #include <cctype>
  11 #include <cstdarg>
  12 #include <cwchar>
  13 #include <deque>
  14 #include <simgrid/sg_config.hpp>
  15 #include <simgrid/s4u/Host.hpp>
  16 #include <string>
  17 #include <vector>
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
  20
  21 static std::unordered_map<std::string, std::deque<std::string>*> keys;
  22
  23 static std::map<std::string, std::string> smpi_colors = {{"recv", "1 0 0"},
  24   {"irecv", "1 0.52 0.52"},
  25   {"send", "0 0 1"},
  26   {"isend", "0.52 0.52 1"},
  27   {"sendrecv", "0 1 1"},
  28   {"wait", "1 1 0"},
  29   {"waitall", "0.78 0.78 0"},
  30   {"waitany", "0.78 0.78 0.58"},
  31   {"test", "0.52 0.52 0"},
  32
  33   {"allgather", "1 0 0"},
  34   {"allgatherv", "1 0.52 0.52"},
  35   {"allreduce", "1 0 1"},
  36   {"alltoall", "0.52 0 1"},
  37   {"alltoallv", "0.78 0.52 1"},
  38   {"barrier", "0 0.78 0.78"},
  39   {"bcast", "0 0.78 0.39"},
  40   {"gather", "1 1 0"},
  41   {"gatherv", "1 1 0.52"},
  42   {"reduce", "0 1 0"},
  43   {"reducescatter", "0.52 1 0.52"},
  44   {"scan", "1 0.58 0.23"},
  45   {"exscan", "1 0.54 0.25"},
  46   {"scatterv", "0.52 0 0.52"},
  47   {"scatter", "1 0.74 0.54"},
  48
  49   {"computing", "0 1 1"},
  50   {"sleeping", "0 0.5 0.5"},
  51
  52   {"init", "0 1 0"},
  53   {"finalize", "0 1 0"},
  54
  55   {"put", "0.3 1 0"},
  56   {"get", "0 1 0.3"},
  57   {"accumulate", "1 0.3 0"},
  58   {"migration", "0.2 0.5 0.2"},
  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(std::string state)
  81 {
  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& pair : smpi_colors) { // Is an entry of our map a substring of this state name?
  90     if (std::strstr(state.c_str(), pair.first.c_str()) != 0)
  91       return pair.second.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 container_t smpi_container(int rank)
  98 {
  99   return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
 100 }
 101
 102 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
 103 {
 104   // get the deque for src#dst
 105   std::string aux =
 106       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
 107   auto it = keys.find(aux);
 108   std::deque<std::string>* d;
 109
 110   if (it == keys.end()) {
 111     d         = new std::deque<std::string>;
 112     keys[aux] = d;
 113   } else
 114     d = it->second;
 115
 116   //generate the key
 117   static unsigned long long counter = 0;
 118   counter++;
 119   std::string key =
 120       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
 121
 122   //push it
 123   d->push_back(key);
 124
 125   return key;
 126 }
 127
 128 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
 129 {
 130   std::string key;
 131   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
 132                     std::to_string(send == 1 ? 0 : 1);
 133   auto it = keys.find(aux);
 134   if (it == keys.end()) {
 135     // first posted
 136     key = TRACE_smpi_put_key(src, dst, tag, send);
 137   } else {
 138     key = it->second->front();
 139     it->second->pop_front();
 140   }
 141   return key;
 142 }
 143
 144 static std::unordered_map<smx_actor_t, std::string> process_category;
 145
 146 void TRACE_internal_smpi_set_category (const char *category)
 147 {
 148   if (not TRACE_smpi_is_enabled())
 149     return;
 150
 151   //declare category
 152   TRACE_category (category);
 153
 154   if (category != nullptr)
 155     process_category[SIMIX_process_self()] = category;
 156 }
 157
 158 const char *TRACE_internal_smpi_get_category ()
 159 {
 160   if (not TRACE_smpi_is_enabled())
 161     return nullptr;
 162
 163   auto it = process_category.find(SIMIX_process_self());
 164   return (it == process_category.end()) ? nullptr : it->second.c_str();
 165 }
 166
 167 void TRACE_smpi_release()
 168 {
 169   for (auto const& elm : keys)
 170     delete elm.second;
 171 }
 172
 173 void TRACE_smpi_setup_container(int rank, sg_host_t host)
 174 {
 175   container_t father = simgrid::instr::Container::get_root();
 176   if (TRACE_smpi_is_grouped()) {
 177     father = simgrid::instr::Container::by_name_or_null(host->get_name());
 178     xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
 179   }
 180   father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
 181 }
 182
 183 void TRACE_smpi_init(int rank)
 184 {
 185   if (not TRACE_smpi_is_enabled())
 186     return;
 187
 188   TRACE_smpi_setup_container(rank, sg_host_self());
 189 #if HAVE_PAPI
 190   container_t container   = smpi_container(rank);
 191   papi_counter_t counters = smpi_process()->papi_counters();
 192
 193   for (auto const& it : counters) {
 194     /**
 195      * Check whether this variable already exists or not. Otherwise, it will be created
 196      * multiple times but only the last one would be used...
 197      */
 198     container->type_->by_name_or_create(it.first, "");
 199   }
 200 #endif
 201 }
 202
 203 void TRACE_smpi_finalize(int rank)
 204 {
 205   if (not TRACE_smpi_is_enabled())
 206     return;
 207
 208   smpi_container(rank)->remove_from_parent();
 209 }
 210
 211 void TRACE_smpi_computing_init(int rank)
 212 {
 213  //first use, initialize the color in the trace
 214  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 215    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
 216 }
 217
 218 void TRACE_smpi_sleeping_init(int rank)
 219 {
 220  //first use, initialize the color in the trace
 221  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 222    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
 223 }
 224
 225 void TRACE_smpi_computing_in(int rank, double amount)
 226 {
 227   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 228     smpi_container(rank)
 229         ->get_state("MPI_STATE")
 230         ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
 231 }
 232
 233 void TRACE_smpi_computing_out(int rank)
 234 {
 235   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 236     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 237 }
 238
 239 void TRACE_smpi_sleeping_in(int rank, double duration)
 240 {
 241   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 242     smpi_container(rank)
 243         ->get_state("MPI_STATE")
 244         ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 245 }
 246
 247 void TRACE_smpi_sleeping_out(int rank)
 248 {
 249   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 250     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 251 }
 252
 253 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 254 {
 255   if (not TRACE_smpi_is_enabled()) {
 256     delete extra;
 257     return;
 258   }
 259
 260   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
 261   state->add_entity_value(operation, instr_find_color(operation));
 262   state->push_event(operation, extra);
 263 }
 264
 265 void TRACE_smpi_comm_out(int rank)
 266 {
 267   if (TRACE_smpi_is_enabled())
 268     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 269 }
 270
 271 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 272 {
 273   if (not TRACE_smpi_is_enabled())
 274     return;
 275
 276   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 277
 278   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 279   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 280 }
 281
 282 void TRACE_smpi_recv(int src, int dst, int tag)
 283 {
 284   if (not TRACE_smpi_is_enabled())
 285     return;
 286
 287   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 288
 289   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 290   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
 291 }
 292
 293 /**************** Functions to trace the migration of tasks. *****************/
 294 void TRACE_smpi_send_process_data_in(int rank)
 295 {
 296   if (not TRACE_smpi_is_enabled()) return;
 297
 298   smpi_container(rank)->get_state("MIGRATE_STATE")->add_entity_value("migration", instr_find_color("migration"));
 299   smpi_container(rank)->get_state("MIGRATE_STATE")->push_event("migration");
 300 }
 301
 302 void TRACE_smpi_send_process_data_out(int rank)
 303 {
 304   if (not TRACE_smpi_is_enabled()) return;
 305
 306   /* Clean the process state. */
 307   smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
 308 }
 309
 310 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
 311 {
 312   if (!TRACE_smpi_is_enabled()) return;
 313
 314   /** The key is (most likely) used to match the events in the trace */
 315   static long long int counter = 0;
 316   std::string key              = std::to_string(counter);
 317   counter++;
 318
 319   // start link (= tell the trace that this rank moves from A to B)
 320   container_t cont = smpi_container(rank);
 321   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
 322
 323   // Destroy container of this rank on this host
 324   cont->remove_from_parent();
 325
 326   // Setup container on new host
 327   TRACE_smpi_setup_container(rank, new_host);
 328
 329   // end link
 330   cont = smpi_container(rank); // This points to the newly created container
 331   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);
 332 }