src/smpi/internals/instr_smpi.cpp

   1 /* Copyright (c) 2010, 2012-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 <cctype>
  10 #include <cstdarg>
  11 #include <cwchar>
  12 #include <deque>
  13 #include <simgrid/sg_config.hpp>
  14 #include <string>
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
  17
  18 static std::unordered_map<std::string, std::deque<std::string>*> keys;
  19
  20 static const char* smpi_colors[] = {
  21     "recv",      "1 0 0",       "irecv",         "1 0.52 0.52",    "send",       "0 0 1",
  22     "isend",     "0.52 0.52 1", "sendrecv",      "0 1 1",          "wait",       "1 1 0",
  23     "waitall",   "0.78 0.78 0", "waitany",       "0.78 0.78 0.58", "test",       "0.52 0.52 0",
  24
  25     "allgather", "1 0 0",       "allgatherv",    "1 0.52 0.52",    "allreduce",  "1 0 1",
  26     "alltoall",  "0.52 0 1",    "alltoallv",     "0.78 0.52 1",    "barrier",    "0 0.78 0.78",
  27     "bcast",     "0 0.78 0.39", "gather",        "1 1 0",          "gatherv",    "1 1 0.52",
  28     "reduce",    "0 1 0",       "reducescatter", "0.52 1 0.52",    "scan",       "1 0.58 0.23",
  29     "exscan",    "1 0.54 0.25", "scatterv",      "0.52 0 0.52",    "scatter",    "1 0.74 0.54",
  30
  31     "computing", "0 1 1",       "sleeping",      "0 0.5 0.5",
  32
  33     "init",      "0 1 0",       "finalize",      "0 1 0",
  34
  35     "put",       "0.3 1 0",     "get",           "0 1 0.3",        "accumulate", "1 0.3 0",
  36     "rput",       "0.3 1 0",     "rget",           "0 1 0.3",        "raccumulate", "1 0.3 0",
  37     "compare_and_swap",       "0.3 1 0",     "get_accumulate",           "0 1 0.3",        "rget_accumulate", "1 0.3 0",
  38     "win_fence", "1 0 0.3",     "win_post",      "1 0 0.8",        "win_wait",   "1 0.8 0",
  39     "win_start", "0.8 0 1",     "win_complete",  "0.8 1 0",        "win_lock", "1 0 0.3",
  40     "win_unlock", "1 0 0.3",     "win_lock_all",      "1 0 0.8",        "win_unlock_all",   "1 0.8 0",
  41     "win_flush", "1 0 0.3",     "win_flush_local",      "1 0 0.8",        "win_flush_all",   "1 0.8 0",
  42     "win_flush_local_all", "1 0 0.3", ""  , ""
  43 };
  44
  45 static const char* instr_find_color(const char* state)
  46 {
  47   std::string target = std::string(state);
  48   boost::algorithm::to_lower(target);
  49   const char* ret     = nullptr;
  50   unsigned int i      = 0;
  51   const char* current = smpi_colors[i];
  52   while (current != nullptr) {
  53     if (target == current                          // exact match
  54         || strstr(target.c_str(), current) != 0) { // as substring
  55       ret = smpi_colors[i + 1];
  56       break;
  57     }
  58     i+=2;
  59     current = smpi_colors[i];
  60   }
  61   return ret;
  62 }
  63
  64 XBT_PRIVATE container_t smpi_container(int rank)
  65 {
  66   return simgrid::instr::Container::byName(std::string("rank-") + std::to_string(rank));
  67 }
  68
  69 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
  70 {
  71   // get the deque for src#dst
  72   std::string aux =
  73       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
  74   auto it = keys.find(aux);
  75   std::deque<std::string>* d;
  76
  77   if (it == keys.end()) {
  78     d         = new std::deque<std::string>;
  79     keys[aux] = d;
  80   } else
  81     d = it->second;
  82
  83   //generate the key
  84   static unsigned long long counter = 0;
  85   counter++;
  86   std::string key =
  87       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
  88
  89   //push it
  90   d->push_back(key);
  91
  92   return key;
  93 }
  94
  95 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
  96 {
  97   std::string key;
  98   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
  99                     std::to_string(send == 1 ? 0 : 1);
 100   auto it = keys.find(aux);
 101   if (it == keys.end()) {
 102     // first posted
 103     key = TRACE_smpi_put_key(src, dst, tag, send);
 104   } else {
 105     key = it->second->front();
 106     it->second->pop_front();
 107   }
 108   return key;
 109 }
 110
 111 static std::unordered_map<smx_actor_t, std::string> process_category;
 112
 113 void TRACE_internal_smpi_set_category (const char *category)
 114 {
 115   if (not TRACE_smpi_is_enabled())
 116     return;
 117
 118   //declare category
 119   TRACE_category (category);
 120
 121   if (category != nullptr)
 122     process_category[SIMIX_process_self()] = category;
 123 }
 124
 125 const char *TRACE_internal_smpi_get_category ()
 126 {
 127   if (not TRACE_smpi_is_enabled())
 128     return nullptr;
 129
 130   auto it = process_category.find(SIMIX_process_self());
 131   return (it == process_category.end()) ? nullptr : it->second.c_str();
 132 }
 133
 134 void TRACE_smpi_alloc()
 135 {
 136   // for symmetry
 137 }
 138
 139 void TRACE_smpi_release()
 140 {
 141   for (auto const& elm : keys)
 142     delete elm.second;
 143 }
 144
 145 void TRACE_smpi_init(int rank)
 146 {
 147   if (not TRACE_smpi_is_enabled())
 148     return;
 149
 150   std::string str = std::string("rank-") + std::to_string(rank);
 151
 152   container_t father;
 153   if (TRACE_smpi_is_grouped()){
 154     father = simgrid::instr::Container::byNameOrNull(sg_host_self_get_name());
 155   }else{
 156     father = simgrid::instr::Container::getRoot();
 157   }
 158   xbt_assert(father != nullptr, "Could not find a parent for mpi rank %s at function %s", str.c_str(), __FUNCTION__);
 159   father->createChild(str, "MPI");
 160 #if HAVE_PAPI
 161   container_t container   = simgrid::instr::Container::byName(str);
 162   papi_counter_t counters = smpi_process()->papi_counters();
 163
 164   for (auto const& it : counters) {
 165     /**
 166      * Check whether this variable already exists or not. Otherwise, it will be created
 167      * multiple times but only the last one would be used...
 168      */
 169     if (s_type::getOrNull(it.first.c_str(), container->type_) == nullptr) {
 170       Type::variableNew(it.first.c_str(), "", container->type_);
 171     }
 172   }
 173 #endif
 174 }
 175
 176 void TRACE_smpi_finalize(int rank)
 177 {
 178   if (not TRACE_smpi_is_enabled())
 179     return;
 180
 181   smpi_container(rank)->removeFromParent();
 182 }
 183
 184 void TRACE_smpi_computing_init(int rank)
 185 {
 186  //first use, initialize the color in the trace
 187  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 188    smpi_container(rank)->getState("MPI_STATE")->addEntityValue("computing", instr_find_color("computing"));
 189 }
 190
 191 void TRACE_smpi_computing_in(int rank, double amount)
 192 {
 193   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 194     smpi_container(rank)
 195         ->getState("MPI_STATE")
 196         ->pushEvent("computing", new simgrid::instr::CpuTIData("compute", amount));
 197 }
 198
 199 void TRACE_smpi_computing_out(int rank)
 200 {
 201   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
 202     smpi_container(rank)->getState("MPI_STATE")->popEvent();
 203 }
 204
 205 void TRACE_smpi_sleeping_in(int rank, double duration)
 206 {
 207   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
 208     smpi_container(rank)
 209         ->getState("MPI_STATE")
 210         ->pushEvent("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
 211 }
 212
 213 void TRACE_smpi_sleeping_out(int rank)
 214 {
 215   if (TRACE_smpi_is_enabled() && not TRACE_smpi_is_sleeping())
 216     smpi_container(rank)->getState("MPI_STATE")->popEvent();
 217 }
 218
 219 void TRACE_smpi_testing_in(int rank)
 220 {
 221   //do not forget to set the color first, otherwise this will explode
 222   if (not TRACE_smpi_is_enabled())
 223     return;
 224
 225   simgrid::instr::StateType* state = smpi_container(rank)->getState("MPI_STATE");
 226   state->addEntityValue("test");
 227   state->pushEvent("test", new simgrid::instr::NoOpTIData("test"));
 228 }
 229
 230 void TRACE_smpi_testing_out(int rank)
 231 {
 232   if (TRACE_smpi_is_enabled())
 233     smpi_container(rank)->getState("MPI_STATE")->popEvent();
 234 }
 235
 236 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
 237 {
 238   if (not TRACE_smpi_is_enabled()) {
 239     delete extra;
 240     return;
 241   }
 242
 243   simgrid::instr::StateType* state = smpi_container(rank)->getState("MPI_STATE");
 244   state->addEntityValue(operation, instr_find_color(operation));
 245   state->pushEvent(operation, extra);
 246 }
 247
 248 void TRACE_smpi_comm_out(int rank)
 249 {
 250   if (TRACE_smpi_is_enabled())
 251     smpi_container(rank)->getState("MPI_STATE")->popEvent();
 252 }
 253
 254 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
 255 {
 256   if (not TRACE_smpi_is_enabled())
 257     return;
 258
 259   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
 260
 261   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 262   simgrid::instr::Container::getRoot()->getLink("MPI_LINK")->startEvent(smpi_container(rank), "PTP", key, size);
 263 }
 264
 265 void TRACE_smpi_recv(int src, int dst, int tag)
 266 {
 267   if (not TRACE_smpi_is_enabled())
 268     return;
 269
 270   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
 271
 272   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
 273   simgrid::instr::Container::getRoot()->getLink("MPI_LINK")->endEvent(smpi_container(dst), "PTP", key);
 274 }