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   //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 static std::unordered_map<smx_actor_t, std::string> process_category;
 138
 139 void TRACE_internal_smpi_set_category(std::string category)
 140 {
 141   if (not TRACE_smpi_is_enabled())
 142     return;
 143
 144   //declare category
 145   TRACE_category(category.c_str());
 146
 147   if (not category.empty())
 148     process_category[SIMIX_process_self()] = category;
 149 }
 150
 151 std::string TRACE_internal_smpi_get_category()
 152 {
 153   if (not TRACE_smpi_is_enabled())
 154     return "";
 155
 156   auto it = process_category.find(SIMIX_process_self());
 157   return (it == process_category.end()) ? "" : it->second.c_str();
 158 }
 159
 160 void TRACE_smpi_setup_container(int rank, sg_host_t host)
 161 {
 162   container_t father = simgrid::instr::Container::get_root();
 163   if (TRACE_smpi_is_grouped()) {
 164     father = simgrid::instr::Container::by_name_or_null(host->get_name());
 165     xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
 166   }
 167   father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
 168 }
 169
 170 void TRACE_smpi_init(int rank)
 171 {
 172   if (not TRACE_smpi_is_enabled())
 173     return;
 174
 175   TRACE_smpi_setup_container(rank, sg_host_self());
 176 #if HAVE_PAPI
 177   container_t container   = smpi_container(rank);
 178   papi_counter_t counters = smpi_process()->papi_counters();
 179
 180   for (auto const& it : counters) {
 181     /**
 182      * Check whether this variable already exists or not. Otherwise, it will be created
 183      * multiple times but only the last one would be used...
 184      */
 185     container->type_->by_name_or_create(it.first, "");
 186   }
 187 #endif
 188 }
 189
 190 void TRACE_smpi_finalize(int rank)
 191 {
 192   if (not TRACE_smpi_is_enabled())
 193     return;
 194
 195   smpi_container(rank)->remove_from_parent();
 196 }
 197
 198 void TRACE_smpi_computing_init(int rank)
 199 {
 200  //first use, initialize the color in the trace
 201  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 202    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
 203 }
 204
 205 void TRACE_smpi_sleeping_init(int rank)
 206 {
 207  //first use, initialize the color in the trace
 208  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 209    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
 210 }
 211
 212 void TRACE_smpi_computing_in(int rank, double amount)
 213 {
 214   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 215     smpi_container(rank)
 216         ->get_state("MPI_STATE")
 217         ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
 218 }
 219
 220 void TRACE_smpi_computing_out(int rank)
 221 {
 222   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 223     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 224 }
 225
 226 void TRACE_smpi_sleeping_in(int rank, double duration)
 227 {
 228   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 229     smpi_container(rank)
 230         ->get_state("MPI_STATE")
 231         ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 232 }
 233
 234 void TRACE_smpi_sleeping_out(int rank)
 235 {
 236   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 237     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 238 }
 239
 240 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 241 {
 242   if (not TRACE_smpi_is_enabled()) {
 243     delete extra;
 244     return;
 245   }
 246
 247   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
 248   state->add_entity_value(operation, instr_find_color(operation));
 249   state->push_event(operation, extra);
 250 }
 251
 252 void TRACE_smpi_comm_out(int rank)
 253 {
 254   if (TRACE_smpi_is_enabled())
 255     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
 256 }
 257
 258 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 259 {
 260   if (not TRACE_smpi_is_enabled())
 261     return;
 262
 263   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 264
 265   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 266   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
 267 }
 268
 269 void TRACE_smpi_recv(int src, int dst, int tag)
 270 {
 271   if (not TRACE_smpi_is_enabled())
 272     return;
 273
 274   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 275
 276   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 277   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
 278 }
 279
 280 /**************** Functions to trace the migration of tasks. *****************/
 281 void TRACE_smpi_send_process_data_in(int rank)
 282 {
 283   if (not TRACE_smpi_is_enabled()) return;
 284
 285   smpi_container(rank)->get_state("MIGRATE_STATE")->add_entity_value("migration", instr_find_color("migration"));
 286   smpi_container(rank)->get_state("MIGRATE_STATE")->push_event("migration");
 287 }
 288
 289 void TRACE_smpi_send_process_data_out(int rank)
 290 {
 291   if (not TRACE_smpi_is_enabled()) return;
 292
 293   /* Clean the process state. */
 294   smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
 295 }
 296
 297 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
 298 {
 299   if (!TRACE_smpi_is_enabled()) return;
 300
 301   /** The key is (most likely) used to match the events in the trace */
 302   static long long int counter = 0;
 303   std::string key              = std::to_string(counter);
 304   counter++;
 305
 306   // start link (= tell the trace that this rank moves from A to B)
 307   container_t cont = smpi_container(rank);
 308   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
 309
 310   // Destroy container of this rank on this host
 311   cont->remove_from_parent();
 312
 313   // Setup container on new host
 314   TRACE_smpi_setup_container(rank, new_host);
 315
 316   // end link
 317   cont = smpi_container(rank); // This points to the newly created container
 318   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);
 319 }