1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved. */
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. */
7 #include <boost/algorithm/string.hpp>
8 #include <simgrid/s4u/Actor.hpp>
13 #include <simgrid/sg_config.hpp>
14 #include <simgrid/s4u/Host.hpp>
18 #include "src/smpi/include/smpi_actor.hpp"
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
22 static std::unordered_map<std::string, std::deque<std::string>*> keys;
24 static std::map<std::string, std::string> smpi_colors = {{"recv", "1 0 0"},
25 {"irecv", "1 0.52 0.52"},
27 {"isend", "0.52 0.52 1"},
28 {"sendrecv", "0 1 1"},
30 {"waitall", "0.78 0.78 0"},
31 {"waitany", "0.78 0.78 0.58"},
32 {"test", "0.52 0.52 0"},
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"},
42 {"gatherv", "1 1 0.52"},
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"},
50 {"computing", "0 1 1"},
51 {"sleeping", "0 0.5 0.5"},
54 {"finalize", "0 1 0"},
58 {"accumulate", "1 0.3 0"},
59 {"migration", "0.2 0.5 0.2"},
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"}
81 static const char* instr_find_color(std::string state)
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
87 if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
88 return smpi_colors.find(state)->second.c_str();
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();
95 return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
98 XBT_PRIVATE container_t smpi_container(int rank)
100 return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
103 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
105 // get the deque for src#dst
107 std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
108 auto it = keys.find(aux);
109 std::deque<std::string>* d;
111 if (it == keys.end()) {
112 d = new std::deque<std::string>;
118 static unsigned long long counter = 0;
121 std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
129 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
132 std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
133 std::to_string(send == 1 ? 0 : 1);
134 auto it = keys.find(aux);
135 if (it == keys.end()) {
137 key = TRACE_smpi_put_key(src, dst, tag, send);
139 key = it->second->front();
140 it->second->pop_front();
145 static std::unordered_map<smx_actor_t, std::string> process_category;
147 void TRACE_internal_smpi_set_category (const char *category)
149 if (not TRACE_smpi_is_enabled())
153 TRACE_category (category);
155 if (category != nullptr)
156 process_category[SIMIX_process_self()] = category;
159 const char *TRACE_internal_smpi_get_category ()
161 if (not TRACE_smpi_is_enabled())
164 auto it = process_category.find(SIMIX_process_self());
165 return (it == process_category.end()) ? nullptr : it->second.c_str();
168 void TRACE_smpi_release()
170 for (auto const& elm : keys)
174 void TRACE_smpi_setup_container(int rank, sg_host_t host)
176 container_t father = simgrid::instr::Container::get_root();
177 if (TRACE_smpi_is_grouped()) {
178 father = simgrid::instr::Container::by_name_or_null(host->get_name());
179 xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
181 father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
184 void TRACE_smpi_init(int rank)
186 if (not TRACE_smpi_is_enabled())
189 TRACE_smpi_setup_container(rank, sg_host_self());
191 container_t container = smpi_container(rank);
192 papi_counter_t counters = smpi_process()->papi_counters();
194 for (auto const& it : counters) {
196 * Check whether this variable already exists or not. Otherwise, it will be created
197 * multiple times but only the last one would be used...
199 container->type_->by_name_or_create(it.first, "");
204 void TRACE_smpi_finalize(int rank)
206 if (not TRACE_smpi_is_enabled())
209 smpi_container(rank)->remove_from_parent();
212 void TRACE_smpi_computing_init(int rank)
214 //first use, initialize the color in the trace
215 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
216 smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
219 void TRACE_smpi_sleeping_init(int rank)
221 //first use, initialize the color in the trace
222 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
223 smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
226 void TRACE_smpi_computing_in(int rank, double amount)
228 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
230 ->get_state("MPI_STATE")
231 ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
234 void TRACE_smpi_computing_out(int rank)
236 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
237 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
240 void TRACE_smpi_sleeping_in(int rank, double duration)
242 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
244 ->get_state("MPI_STATE")
245 ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
248 void TRACE_smpi_sleeping_out(int rank)
250 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
251 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
254 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
256 if (not TRACE_smpi_is_enabled()) {
261 simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
262 state->add_entity_value(operation, instr_find_color(operation));
263 state->push_event(operation, extra);
266 void TRACE_smpi_comm_out(int rank)
268 if (TRACE_smpi_is_enabled())
269 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
272 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
274 if (not TRACE_smpi_is_enabled())
277 std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
279 XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
280 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
283 void TRACE_smpi_recv(int src, int dst, int tag)
285 if (not TRACE_smpi_is_enabled())
288 std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
290 XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
291 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
294 /**************** Functions to trace the migration of tasks. *****************/
295 void TRACE_smpi_send_process_data_in(int rank)
297 if (not TRACE_smpi_is_enabled()) return;
299 smpi_container(rank)->get_state("MIGRATE_STATE")->add_entity_value("migration", instr_find_color("migration"));
300 smpi_container(rank)->get_state("MIGRATE_STATE")->push_event("migration");
303 void TRACE_smpi_send_process_data_out(int rank)
305 if (not TRACE_smpi_is_enabled()) return;
307 /* Clean the process state. */
308 smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
311 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
313 if (!TRACE_smpi_is_enabled()) return;
315 /** The key is (most likely) used to match the events in the trace */
316 static long long int counter = 0;
317 std::string key = std::to_string(counter);
320 // start link (= tell the trace that this rank moves from A to B)
321 container_t cont = smpi_container(rank);
322 simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
324 // Destroy container of this rank on this host
325 cont->remove_from_parent();
327 // Setup container on new host
328 TRACE_smpi_setup_container(rank, new_host);
331 cont = smpi_container(rank); // This points to the newly created container
332 simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);