Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Actor: make the refcount observable, and improve debug messages
[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.39 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   {"file_read", "1 1 0.3"}
80 };
81
82 static const char* instr_find_color(const char* c_state)
83 {
84   std::string state(c_state);
85   boost::algorithm::to_lower(state);
86   if (state.substr(0, 5) == "pmpi_")
87     state = state.substr(5, std::string::npos); // Remove pmpi_ to allow for exact matches
88
89   if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
90     return smpi_colors.find(state)->second.c_str();
91   }
92   for (const auto& pair : smpi_colors) { // Is an entry of our map a substring of this state name?
93     if (std::strstr(state.c_str(), pair.first.c_str()) != 0)
94       return pair.second.c_str();
95   }
96
97   return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
98 }
99
100 XBT_PRIVATE container_t smpi_container(int rank)
101 {
102   return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
103 }
104
105 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
106 {
107   //generate the key
108   static unsigned long long counter = 0;
109   counter++;
110   std::string key =
111       std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
112
113   //push it
114   std::string aux =
115       std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
116   keys[aux].push_back(key);
117
118   return key;
119 }
120
121 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
122 {
123   std::string key;
124   std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
125                     std::to_string(send == 1 ? 0 : 1);
126   auto it = keys.find(aux);
127   if (it == keys.end()) {
128     // first posted
129     key = TRACE_smpi_put_key(src, dst, tag, send);
130   } else {
131     key = it->second.front();
132     it->second.pop_front();
133     if (it->second.empty())
134       keys.erase(it);
135   }
136   return key;
137 }
138
139 void TRACE_smpi_setup_container(int rank, sg_host_t host)
140 {
141   container_t father = simgrid::instr::Container::get_root();
142   if (TRACE_smpi_is_grouped()) {
143     father = simgrid::instr::Container::by_name_or_null(host->get_name());
144     xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
145   }
146   father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
147 }
148
149 void TRACE_smpi_init(int rank)
150 {
151   if (not TRACE_smpi_is_enabled())
152     return;
153
154   TRACE_smpi_setup_container(rank, sg_host_self());
155 #if HAVE_PAPI
156   container_t container   = smpi_container(rank);
157   papi_counter_t counters = smpi_process()->papi_counters();
158
159   for (auto const& it : counters) {
160     /**
161      * Check whether this variable already exists or not. Otherwise, it will be created
162      * multiple times but only the last one would be used...
163      */
164     container->type_->by_name_or_create(it.first, "");
165   }
166 #endif
167 }
168
169 void TRACE_smpi_finalize(int rank)
170 {
171   if (not TRACE_smpi_is_enabled())
172     return;
173
174   smpi_container(rank)->remove_from_parent();
175 }
176
177 void TRACE_smpi_computing_init(int rank)
178 {
179  //first use, initialize the color in the trace
180  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
181    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
182 }
183
184 void TRACE_smpi_sleeping_init(int rank)
185 {
186  //first use, initialize the color in the trace
187  if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
188    smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
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         ->get_state("MPI_STATE")
196         ->push_event("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)->get_state("MPI_STATE")->pop_event();
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         ->get_state("MPI_STATE")
210         ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
211 }
212
213 void TRACE_smpi_sleeping_out(int rank)
214 {
215   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
216     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
217 }
218
219 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
220 {
221   if (not TRACE_smpi_is_enabled()) {
222     delete extra;
223     return;
224   }
225
226   simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
227   state->add_entity_value(operation, instr_find_color(operation));
228   state->push_event(operation, extra);
229 }
230
231 void TRACE_smpi_comm_out(int rank)
232 {
233   if (TRACE_smpi_is_enabled())
234     smpi_container(rank)->get_state("MPI_STATE")->pop_event();
235 }
236
237 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
238 {
239   if (not TRACE_smpi_is_enabled())
240     return;
241
242   std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
243
244   XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
245   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
246 }
247
248 void TRACE_smpi_recv(int src, int dst, int tag)
249 {
250   if (not TRACE_smpi_is_enabled())
251     return;
252
253   std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
254
255   XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
256   simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
257 }
258
259 /**************** Functions to trace the migration of tasks. *****************/
260 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
261 {
262   if (not TRACE_smpi_is_enabled()) return;
263
264   /** The key is (most likely) used to match the events in the trace */
265   static long long int counter = 0;
266   std::string key              = std::to_string(counter);
267   counter++;
268
269   // start link (= tell the trace that this rank moves from A to B)
270   container_t cont = smpi_container(rank);
271   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
272
273   // Destroy container of this rank on this host
274   cont->remove_from_parent();
275
276   // Setup container on new host
277   TRACE_smpi_setup_container(rank, new_host);
278
279   // end link
280   cont = smpi_container(rank); // This points to the newly created container
281   simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);
282 }