1 /* Copyright (c) 2010-2018. The SimGrid Team.
2 * All rights reserved. */
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. */
8 #include <boost/algorithm/string.hpp>
9 #include <simgrid/s4u/Actor.hpp>
14 #include <simgrid/sg_config.hpp>
15 #include <simgrid/s4u/Host.hpp>
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
21 static std::unordered_map<std::string, std::deque<std::string>*> keys;
23 static std::map<std::string, std::string> smpi_colors = {{"recv", "1 0 0"},
24 {"irecv", "1 0.52 0.52"},
26 {"isend", "0.52 0.52 1"},
27 {"sendrecv", "0 1 1"},
29 {"waitall", "0.78 0.78 0"},
30 {"waitany", "0.78 0.78 0.58"},
31 {"test", "0.52 0.52 0"},
33 {"allgather", "1 0 0"},
34 {"allgatherv", "1 0.52 0.52"},
35 {"allreduce", "1 0 1"},
36 {"alltoall", "0.52 0 1"},
37 {"alltoallv", "0.78 0.52 1"},
38 {"barrier", "0 0.78 0.78"},
39 {"bcast", "0 0.78 0.39"},
41 {"gatherv", "1 1 0.52"},
43 {"reducescatter", "0.52 1 0.52"},
44 {"scan", "1 0.58 0.23"},
45 {"exscan", "1 0.54 0.25"},
46 {"scatterv", "0.52 0 0.52"},
47 {"scatter", "1 0.74 0.54"},
49 {"computing", "0 1 1"},
50 {"sleeping", "0 0.5 0.5"},
53 {"finalize", "0 1 0"},
57 {"accumulate", "1 0.3 0"},
58 {"migration", "0.2 0.5 0.2"},
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"}
80 static const char* instr_find_color(std::string state)
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
86 if (smpi_colors.find(state) != smpi_colors.end()) { // Exact match in the map?
87 return smpi_colors.find(state)->second.c_str();
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();
94 return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
97 XBT_PRIVATE container_t smpi_container(int rank)
99 return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(rank));
102 static std::string TRACE_smpi_put_key(int src, int dst, int tag, int send)
104 // get the deque for src#dst
106 std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
107 auto it = keys.find(aux);
108 std::deque<std::string>* d;
110 if (it == keys.end()) {
111 d = new std::deque<std::string>;
117 static unsigned long long counter = 0;
120 std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
128 static std::string TRACE_smpi_get_key(int src, int dst, int tag, int send)
131 std::string aux = std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" +
132 std::to_string(send == 1 ? 0 : 1);
133 auto it = keys.find(aux);
134 if (it == keys.end()) {
136 key = TRACE_smpi_put_key(src, dst, tag, send);
138 key = it->second->front();
139 it->second->pop_front();
144 static std::unordered_map<smx_actor_t, std::string> process_category;
146 void TRACE_internal_smpi_set_category (const char *category)
148 if (not TRACE_smpi_is_enabled())
152 TRACE_category (category);
154 if (category != nullptr)
155 process_category[SIMIX_process_self()] = category;
158 const char *TRACE_internal_smpi_get_category ()
160 if (not TRACE_smpi_is_enabled())
163 auto it = process_category.find(SIMIX_process_self());
164 return (it == process_category.end()) ? nullptr : it->second.c_str();
167 void TRACE_smpi_release()
169 for (auto const& elm : keys)
173 void TRACE_smpi_setup_container(int rank, sg_host_t host)
175 container_t father = simgrid::instr::Container::get_root();
176 if (TRACE_smpi_is_grouped()) {
177 father = simgrid::instr::Container::by_name_or_null(host->get_name());
178 xbt_assert(father != nullptr, "Could not find a parent for mpi rank 'rank-%d' at function %s", rank, __func__);
180 father->create_child(std::string("rank-") + std::to_string(rank), "MPI"); // This container is of type MPI
183 void TRACE_smpi_init(int rank)
185 if (not TRACE_smpi_is_enabled())
188 TRACE_smpi_setup_container(rank, sg_host_self());
190 container_t container = simgrid::instr::Container::by_name(str);
191 papi_counter_t counters = smpi_process()->papi_counters();
193 for (auto const& it : counters) {
195 * Check whether this variable already exists or not. Otherwise, it will be created
196 * multiple times but only the last one would be used...
198 if (s_type::getOrNull(it.first.c_str(), container->type_) == nullptr) {
199 Type::variableNew(it.first.c_str(), "", container->type_);
205 void TRACE_smpi_finalize(int rank)
207 if (not TRACE_smpi_is_enabled())
210 smpi_container(rank)->remove_from_parent();
213 void TRACE_smpi_computing_init(int rank)
215 //first use, initialize the color in the trace
216 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
217 smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("computing", instr_find_color("computing"));
220 void TRACE_smpi_sleeping_init(int rank)
222 //first use, initialize the color in the trace
223 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
224 smpi_container(rank)->get_state("MPI_STATE")->add_entity_value("sleeping", instr_find_color("sleeping"));
227 void TRACE_smpi_computing_in(int rank, double amount)
229 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
231 ->get_state("MPI_STATE")
232 ->push_event("computing", new simgrid::instr::CpuTIData("compute", amount));
235 void TRACE_smpi_computing_out(int rank)
237 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing())
238 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
241 void TRACE_smpi_sleeping_in(int rank, double duration)
243 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
245 ->get_state("MPI_STATE")
246 ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
249 void TRACE_smpi_sleeping_out(int rank)
251 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
252 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
255 void TRACE_smpi_comm_in(int rank, const char* operation, simgrid::instr::TIData* extra)
257 if (not TRACE_smpi_is_enabled()) {
262 simgrid::instr::StateType* state = smpi_container(rank)->get_state("MPI_STATE");
263 state->add_entity_value(operation, instr_find_color(operation));
264 state->push_event(operation, extra);
267 void TRACE_smpi_comm_out(int rank)
269 if (TRACE_smpi_is_enabled())
270 smpi_container(rank)->get_state("MPI_STATE")->pop_event();
273 void TRACE_smpi_send(int rank, int src, int dst, int tag, int size)
275 if (not TRACE_smpi_is_enabled())
278 std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
280 XBT_DEBUG("Send tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
281 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
284 void TRACE_smpi_recv(int src, int dst, int tag)
286 if (not TRACE_smpi_is_enabled())
289 std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
291 XBT_DEBUG("Recv tracing from %d to %d, tag %d, with key %s", src, dst, tag, key.c_str());
292 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);
295 /**************** Functions to trace the migration of tasks. *****************/
296 void TRACE_smpi_send_process_data_in(int rank)
298 if (not TRACE_smpi_is_enabled()) return;
300 smpi_container(rank)->get_state("MIGRATE_STATE")->add_entity_value("migration", instr_find_color("migration"));
301 smpi_container(rank)->get_state("MIGRATE_STATE")->push_event("migration");
304 void TRACE_smpi_send_process_data_out(int rank)
306 if (not TRACE_smpi_is_enabled()) return;
308 /* Clean the process state. */
309 smpi_container(rank)->get_state("MIGRATE_STATE")->pop_event();
312 void TRACE_smpi_process_change_host(int rank, sg_host_t new_host)
314 if (!TRACE_smpi_is_enabled()) return;
316 /** The key is (most likely) used to match the events in the trace */
317 static long long int counter = 0;
318 std::string key = std::to_string(counter);
321 // start link (= tell the trace that this rank moves from A to B)
322 container_t cont = smpi_container(rank);
323 simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->start_event(cont, "M", key);
325 // Destroy container of this rank on this host
326 cont->remove_from_parent();
328 // Setup container on new host
329 TRACE_smpi_setup_container(rank, new_host);
332 cont = smpi_container(rank); // This points to the newly created container
333 simgrid::instr::Container::get_root()->get_link("MIGRATE_LINK")->end_event(cont, "M", key);