src/smpi/internals/instr_smpi.cpp

   1 /* Copyright (c) 2010-2018. 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.78 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   {"migration", "0.2 0.5 0.2"},
  60   {"rput", "0.3 1 0"},
  61   {"rget", "0 1 0.3"},
  62   {"raccumulate", "1 0.3 0"},
  63   {"compare_and_swap", "0.3 1 0"},
  64   {"get_accumulate", "0 1 0.3"},
  65   {"rget_accumulate", "1 0.3 0"},
  66   {"win_fence", "1 0 0.3"},
  67   {"win_post", "1 0 0.8"},
  68   {"win_wait", "1 0.8 0"},
  69   {"win_start", "0.8 0 1"},
  70   {"win_complete", "0.8 1 0"},
  71   {"win_lock", "1 0 0.3"},
  72   {"win_unlock", "1 0 0.3"},
  73   {"win_lock_all", "1 0 0.8"},
  74   {"win_unlock_all", "1 0.8 0"},
  75   {"win_flush", "1 0 0.3"},
  76   {"win_flush_local", "1 0 0.8"},
  77   {"win_flush_all", "1 0.8 0"},
  78   {"win_flush_local_all", "1 0 0.3"}
  79 };
  80
  81 static const char* instr_find_color(std::string state)
  82 {
  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   // get the deque for src#dst
 106   std::string aux =
 107       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
 108   auto it = keys.find(aux);
 109   std::deque<std::string>* d;
 110
 111   if (it == keys.end()) {
 112     d         = new std::deque<std::string>;
 113     keys[aux] = d;
 114   } else
 115     d = it->second;
 116
 117   //generate the key
 118   static unsigned long long counter = 0;
 119   counter++;
 120   std::string key =
 121       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
 122
 123   //push it
 124   d->push_back(key);
 125
 126   return key;
 127 }
 128
 129 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
 130 {
 131   std::string key;
 132   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
 133                     std::to_string(send == 1 ? 0 : 1);
 134   auto it = keys.find(aux);
 135   if (it == keys.end()) {
 136     // first posted
 137     key = TRACE_smpi_put_key(src, dst, tag, send);
 138   } else {
 139     key = it->second->front();
 140     it->second->pop_front();
 141   }
 142   return key;
 143 }
 144
 145 static std::unordered_map<smx_actor_t, std::string> process_category;
 146
 147 void TRACE_internal_smpi_set_category (const char *category)
 148 {
 149   if (not TRACE_smpi_is_enabled())
 150     return;
 151
 152   //declare category
 153   TRACE_category (category);
 154
 155   if (category != nullptr)
 156     process_category[SIMIX_process_self()] = category;
 157 }
 158
 159 const char *TRACE_internal_smpi_get_category ()
 160 {
 161   if (not TRACE_smpi_is_enabled())
 162     return nullptr;
 163
 164   auto it = process_category.find(SIMIX_process_self());
 165   return (it == process_category.end()) ? nullptr : it->second.c_str();
 166 }
 167
 168 void TRACE_smpi_release()
 169 {
 170   for (auto const& elm : keys)
 171     delete elm.second;
 172 }
 173
 174 void TRACE_smpi_setup_container(int rank, sg_host_t host)
 175 {
 176   container_t father = simgrid::instr::Container::get_root();
 177   if (TRACE_smpi_is_grouped()) {
 178     father = simgrid::instr::Container::by_name_or_null(host->get_name());
 179     xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
 180   }
 181   father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
 182 }
 183
 184 void TRACE_smpi_init(int rank)
 185 {
 186   if (not TRACE_smpi_is_enabled())
 187     return;
 188
 189   TRACE_smpi_setup_container(rank, sg_host_self());
 190 #if HAVE_PAPI
 191   container_t container   = smpi_container(rank);
 192   papi_counter_t counters = smpi_process()->papi_counters();
 193
 194   for (auto const& it : counters) {
 195     /**
 196      * Check whether this variable already exists or not. Otherwise, it will be created
 197      * multiple times but only the last one would be used...
 198      */
 199     container->type_->by_name_or_create(it.first, "");
 200   }
 201 #endif
 202 }
 203
 204 void TRACE_smpi_finalize(int rank)
 205 {
 206   if (not TRACE_smpi_is_enabled())
 207     return;
 208
 209   smpi_container(rank)->remove_from_parent();
 210 }
 211
 212 void TRACE_smpi_computing_init(int rank)
 213 {
 214  //first use, initialize the color in the trace
 215  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 216    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
 217 }
 218
 219 void TRACE_smpi_sleeping_init(int rank)
 220 {
 221  //first use, initialize the color in the trace
 222  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 223    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
 224 }
 225
 226 void TRACE_smpi_computing_in(int rank, double amount)
 227 {
 228   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 229     smpi_container(rank)
 230         ->get_state("MPI_STATE")
 231         ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
 232 }
 233
 234 void TRACE_smpi_computing_out(int rank)
 235 {
 236   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 237     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 238 }
 239
 240 void TRACE_smpi_sleeping_in(int rank, double duration)
 241 {
 242   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 243     smpi_container(rank)
 244         ->get_state("MPI_STATE")
 245         ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 246 }
 247
 248 void TRACE_smpi_sleeping_out(int rank)
 249 {
 250   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 251     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 252 }
 253
 254 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 255 {
 256   if (not TRACE_smpi_is_enabled()) {
 257     delete extra;
 258     return;
 259   }
 260
 261   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
 262   state->add_entity_value(operation, instr_find_color(operation));
 263   state->push_event(operation, extra);
 264 }
 265
 266 void TRACE_smpi_comm_out(int rank)
 267 {
 268   if (TRACE_smpi_is_enabled())
 269     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 270 }
 271
 272 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 273 {
 274   if (not TRACE_smpi_is_enabled())
 275     return;
 276
 277   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 278
 279   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 280   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 281 }
 282
 283 void TRACE_smpi_recv(int src, int dst, int tag)
 284 {
 285   if (not TRACE_smpi_is_enabled())
 286     return;
 287
 288   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 289
 290   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 291   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
 292 }
 293
 294 /**************** Functions to trace the migration of tasks. *****************/
 295 void TRACE_smpi_send_process_data_in(int rank)
 296 {
 297   if (not TRACE_smpi_is_enabled()) return;
 298
 299   smpi_container(rank)->get_state("MIGRATE_STATE")->add_entity_value("migration", instr_find_color("migration"));
 300   smpi_container(rank)->get_state("MIGRATE_STATE")->push_event("migration");
 301 }
 302
 303 void TRACE_smpi_send_process_data_out(int rank)
 304 {
 305   if (not TRACE_smpi_is_enabled()) return;
 306
 307   /* Clean the process state. */
 308   smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
 309 }
 310
 311 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
 312 {
 313   if (!TRACE_smpi_is_enabled()) return;
 314
 315   /** The key is (most likely) used to match the events in the trace */
 316   static long long int counter = 0;
 317   std::string key              = std::to_string(counter);
 318   counter++;
 319
 320   // start link (= tell the trace that this rank moves from A to B)
 321   container_t cont = smpi_container(rank);
 322   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
 323
 324   // Destroy container of this rank on this host
 325   cont->remove_from_parent();
 326
 327   // Setup container on new host
 328   TRACE_smpi_setup_container(rank, new_host);
 329
 330   // end link
 331   cont = smpi_container(rank); // This points to the newly created container
 332   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);
 333 }