1 /* Copyright (c) 2010-2020. 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.39 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"},
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"},
79 {"file_read", "1 1 0.3"}
82 static const char* instr_find_color(const char* c_state)
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
89 if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
90 return smpi_colors.find(state)->second.c_str();
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();
97 return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
100 XBT_PRIVATE container_t smpi_container(int rank)
102 return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
105 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
108 static unsigned long long counter = 0;
111 std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
115 std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
116 keys[aux].push_back(key);
121 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
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()) {
129 key = TRACE_smpi_put_key(src, dst, tag, send);
131 key = it->second.front();
132 it->second.pop_front();
133 if (it->second.empty())
139 void TRACE_smpi_setup_container(int rank, const_sg_host_t host)
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__);
146 father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
149 void TRACE_smpi_init(int rank, std::string calling_func)
151 if (not TRACE_smpi_is_enabled())
154 auto self = simgrid::s4u::Actor::self();
156 TRACE_smpi_setup_container(rank, sg_host_self());
157 simgrid::s4u::this_actor::on_exit([self](bool) { smpi_container(self->get_pid())->remove_from_parent(); });
159 simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
161 state->add_entity_value(calling_func, instr_find_color(calling_func.c_str()));
162 state->push_event(calling_func, new simgrid::instr::NoOpTIData("init"));
164 if (TRACE_smpi_is_computing())
165 state->add_entity_value("computing", instr_find_color("computing"));
166 if (TRACE_smpi_is_sleeping())
167 state->add_entity_value("sleeping", instr_find_color("sleeping"));
170 const simgrid::instr::Container* container = smpi_container(rank);
171 papi_counter_t counters = smpi_process()->papi_counters();
173 for (auto const& it : counters) {
175 * Check whether this variable already exists or not. Otherwise, it will be created
176 * multiple times but only the last one would be used...
178 container->type_->by_name_or_create(it.first, "");
183 void TRACE_smpi_computing_in(int rank, double amount)
185 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
187 ->get_state("MPI_STATE")
188 ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
191 void TRACE_smpi_computing_out(int rank)
193 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
194 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
197 void TRACE_smpi_sleeping_in(int rank, double duration)
199 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
201 ->get_state("MPI_STATE")
202 ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
205 void TRACE_smpi_sleeping_out(int rank)
207 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
208 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
211 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
213 if (not TRACE_smpi_is_enabled()) {
218 simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
219 state->add_entity_value(operation, instr_find_color(operation));
220 state->push_event(operation, extra);
223 void TRACE_smpi_comm_out(int rank)
225 if (TRACE_smpi_is_enabled())
226 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
229 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
231 if (not TRACE_smpi_is_enabled())
234 std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
236 XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
237 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
240 void TRACE_smpi_recv(int src, int dst, int tag)
242 if (not TRACE_smpi_is_enabled())
245 std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
247 XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
248 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
251 /**************** Functions to trace the migration of tasks. *****************/
252 void TRACE_smpi_process_change_host(int rank, const_sg_host_t new_host)
254 if (not TRACE_smpi_is_enabled()) return;
256 /** The key is (most likely) used to match the events in the trace */
257 static long long int counter = 0;
258 std::string key = std::to_string(counter);
261 // start link (= tell the trace that this rank moves from A to B)
262 container_t cont = smpi_container(rank);
263 simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
265 // Destroy container of this rank on this host
266 cont->remove_from_parent();
268 // Setup container on new host
269 TRACE_smpi_setup_container(rank, new_host);
272 cont = smpi_container(rank); // This points to the newly created container
273 simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);