Logo AND Algorithmique Numérique Distribuée

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