Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rework State related events
[simgrid.git] / src / smpi / internals / instr_smpi.cpp
1 /* Copyright (c) 2010, 2012-2017. 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.h>
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     "win_fence", "1 0 0.3",     "win_post",      "1 0 0.8",        "win_wait",   "1 0.8 0",
37     "win_start", "0.8 0 1",     "win_complete",  "0.8 1 0",        nullptr,      nullptr,
38 };
39
40 static const char* instr_find_color(const char* state)
41 {
42   std::string target = std::string(state);
43   boost::algorithm::to_lower(target);
44   const char* ret     = nullptr;
45   unsigned int i      = 0;
46   const char* current = smpi_colors[i];
47   while (current != nullptr) {
48     if (target == current                          // exact match
49         || strstr(target.c_str(), current) != 0) { // as substring
50       ret = smpi_colors[i + 1];
51       break;
52     }
53     i+=2;
54     current = smpi_colors[i];
55   }
56   return ret;
57 }
58
59 XBT_PRIVATE std::string smpi_container(int rank)
60 {
61   return std::string("rank-") + std::to_string(rank);
62 }
63
64 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
65 {
66   // get the deque for src#dst
67   std::string aux =
68       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
69   auto it = keys.find(aux);
70   std::deque<std::string>* d;
71
72   if (it == keys.end()) {
73     d         = new std::deque<std::string>;
74     keys[aux] = d;
75   } else
76     d = it->second;
77
78   //generate the key
79   static unsigned long long counter = 0;
80   counter++;
81   std::string key =
82       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
83
84   //push it
85   d->push_back(key);
86
87   return key;
88 }
89
90 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
91 {
92   std::string key;
93   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
94                     std::to_string(send == 1 ? 0 : 1);
95   auto it = keys.find(aux);
96   if (it == keys.end()) {
97     // first posted
98     key = TRACE_smpi_put_key(src, dst, tag, send);
99   } else {
100     key = it->second->front();
101     it->second->pop_front();
102   }
103   return key;
104 }
105
106 static std::unordered_map<smx_actor_t, std::string> process_category;
107
108 static void cleanup_extra_data (instr_extra_data extra){
109   if(extra!=nullptr){
110     if(extra->sendcounts!=nullptr)
111       xbt_free(extra->sendcounts);
112     if(extra->recvcounts!=nullptr)
113       xbt_free(extra->recvcounts);
114     xbt_free(extra);
115   }
116 }
117
118 void TRACE_internal_smpi_set_category (const char *category)
119 {
120   if (not TRACE_smpi_is_enabled())
121     return;
122
123   //declare category
124   TRACE_category (category);
125
126   if (category != nullptr)
127     process_category[SIMIX_process_self()] = category;
128 }
129
130 const char *TRACE_internal_smpi_get_category ()
131 {
132   if (not TRACE_smpi_is_enabled())
133     return nullptr;
134
135   auto it = process_category.find(SIMIX_process_self());
136   return (it == process_category.end()) ? nullptr : it->second.c_str();
137 }
138
139 void TRACE_smpi_alloc()
140 {
141   // for symmetry
142 }
143
144 void TRACE_smpi_release()
145 {
146   for (auto const& elm : keys)
147     delete elm.second;
148 }
149
150 void TRACE_smpi_init(int rank)
151 {
152   if (not TRACE_smpi_is_enabled())
153     return;
154
155   std::string str = smpi_container(rank);
156
157   container_t father;
158   if (TRACE_smpi_is_grouped()){
159     father = simgrid::instr::Container::byNameOrNull(sg_host_self_get_name());
160   }else{
161     father = simgrid::instr::Container::getRootContainer();
162   }
163   xbt_assert(father != nullptr, "Could not find a parent for mpi rank %s at function %s", str.c_str(), __FUNCTION__);
164 #if HAVE_PAPI
165   container_t container =
166 #endif
167       new simgrid::instr::Container(str, "MPI", father);
168 #if HAVE_PAPI
169   papi_counter_t counters = smpi_process()->papi_counters();
170
171   for (auto const& it : counters) {
172     /**
173      * Check whether this variable already exists or not. Otherwise, it will be created
174      * multiple times but only the last one would be used...
175      */
176     if (s_type::getOrNull(it.first.c_str(), container->type_) == nullptr) {
177       Type::variableNew(it.first.c_str(), "", container->type_);
178     }
179   }
180 #endif
181 }
182
183 void TRACE_smpi_finalize(int rank)
184 {
185   if (not TRACE_smpi_is_enabled())
186     return;
187
188   container_t container = simgrid::instr::Container::byName(smpi_container(rank));
189   container->removeFromParent();
190   delete container;
191 }
192
193 void TRACE_smpi_collective_in(int rank, const char *operation, instr_extra_data extra)
194 {
195   if (not TRACE_smpi_is_enabled()) {
196     cleanup_extra_data(extra);
197     return;
198   }
199
200   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
201   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
202   const char *color = instr_find_color (operation);
203   state->addEntityValue(operation, color);
204   state->pushEvent(SIMIX_get_clock(), container, operation, static_cast<void*>(extra));
205 }
206
207 void TRACE_smpi_collective_out(int rank, const char *operation)
208 {
209   if (not TRACE_smpi_is_enabled())
210     return;
211
212   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
213   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
214   state->popEvent(SIMIX_get_clock(), container);
215 }
216
217 void TRACE_smpi_computing_init(int rank)
218 {
219  //first use, initialize the color in the trace
220  if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_computing())
221    return;
222
223  container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
224  simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
225  state->addEntityValue("computing", instr_find_color("computing"));
226  state->pushEvent(SIMIX_get_clock(), container, "computing");
227 }
228
229 void TRACE_smpi_computing_in(int rank, instr_extra_data extra)
230 {
231   //do not forget to set the color first, otherwise this will explode
232   if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_computing()) {
233     cleanup_extra_data(extra);
234     return;
235   }
236
237   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
238   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
239   state->addEntityValue("computing");
240   state->pushEvent(SIMIX_get_clock(), container, "computing", static_cast<void*>(extra));
241 }
242
243 void TRACE_smpi_computing_out(int rank)
244 {
245   if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_computing())
246     return;
247
248   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
249   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
250   state->popEvent(SIMIX_get_clock(), container);
251 }
252
253 void TRACE_smpi_sleeping_init(int rank)
254 {
255   //first use, initialize the color in the trace
256   if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_sleeping())
257     return;
258
259   container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
260   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
261   state->addEntityValue("sleeping", instr_find_color("sleeping"));
262   state->pushEvent(SIMIX_get_clock(), container, "sleeping");
263 }
264
265 void TRACE_smpi_sleeping_in(int rank, instr_extra_data extra)
266 {
267   //do not forget to set the color first, otherwise this will explode
268   if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_sleeping()) {
269     cleanup_extra_data(extra);
270     return;
271   }
272
273   container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
274   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
275   state->addEntityValue("sleeping");
276   state->pushEvent(SIMIX_get_clock(), container, "sleeping", static_cast<void*>(extra));
277 }
278
279 void TRACE_smpi_sleeping_out(int rank)
280 {
281   if (not TRACE_smpi_is_enabled() || not TRACE_smpi_is_sleeping())
282     return;
283
284   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
285   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
286   state->popEvent(SIMIX_get_clock(), container);
287 }
288
289 void TRACE_smpi_testing_in(int rank, instr_extra_data extra)
290 {
291   //do not forget to set the color first, otherwise this will explode
292   if (not TRACE_smpi_is_enabled()) {
293     cleanup_extra_data(extra);
294     return;
295   }
296
297   container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
298   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
299   state->addEntityValue("test");
300   state->pushEvent(SIMIX_get_clock(), container, "test", static_cast<void*>(extra));
301 }
302
303 void TRACE_smpi_testing_out(int rank)
304 {
305   if (not TRACE_smpi_is_enabled())
306     return;
307
308   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
309   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
310   state->popEvent(SIMIX_get_clock(), container);
311 }
312
313 void TRACE_smpi_ptp_in(int rank, const char *operation, instr_extra_data extra)
314 {
315   if (not TRACE_smpi_is_enabled()) {
316     cleanup_extra_data(extra);
317     return;
318   }
319
320   container_t container       = simgrid::instr::Container::byName(smpi_container(rank));
321   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
322   state->addEntityValue(operation, instr_find_color(operation));
323   state->pushEvent(SIMIX_get_clock(), container, operation, static_cast<void*>(extra));
324 }
325
326 void TRACE_smpi_ptp_out(int rank, int dst, const char *operation)
327 {
328   if (not TRACE_smpi_is_enabled())
329     return;
330
331   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
332   simgrid::instr::StateType* state = static_cast<simgrid::instr::StateType*>(container->type_->byName("MPI_STATE"));
333   state->popEvent(SIMIX_get_clock(), container);
334 }
335
336 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
337 {
338   if (not TRACE_smpi_is_enabled())
339     return;
340
341   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
342
343   container_t container      = simgrid::instr::Container::byName(smpi_container(rank));
344   simgrid::instr::Type* type = simgrid::instr::Type::getRootType()->byName("MPI_LINK");
345   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
346   new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), simgrid::instr::Container::getRootContainer(), type, container,
347                                      "PTP", key, size);
348 }
349
350 void TRACE_smpi_recv(int src, int dst, int tag)
351 {
352   if (not TRACE_smpi_is_enabled())
353     return;
354
355   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
356
357   container_t container      = simgrid::instr::Container::byName(smpi_container(dst));
358   simgrid::instr::Type* type = simgrid::instr::Type::getRootType()->byName("MPI_LINK");
359   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
360   new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), simgrid::instr::Container::getRootContainer(), type, container,
361                                    "PTP", key);
362 }