1 /* Copyright (c) 2010-2022. 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>
9 #include <simgrid/host.h>
10 #include <simgrid/s4u/Actor.hpp>
11 #include <simgrid/s4u/Host.hpp>
12 #include <simgrid/sg_config.hpp>
16 #include "src/smpi/include/smpi_actor.hpp"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_smpi, instr, "Tracing SMPI");
20 static std::unordered_map<std::string, std::deque<std::string>> keys;
22 static const std::map<std::string, std::string, std::less<>> smpi_colors = {{"recv", "1 0 0"},
23 {"irecv", "1 0.52 0.52"},
25 {"isend", "0.52 0.52 1"},
26 {"sendrecv", "0 1 1"},
28 {"waitall", "0.78 0.78 0"},
29 {"waitany", "0.78 0.78 0.58"},
30 {"test", "0.52 0.52 0"},
32 {"allgather", "1 0 0"},
33 {"allgatherv", "1 0.52 0.52"},
34 {"allreduce", "1 0 1"},
35 {"alltoall", "0.52 0 1"},
36 {"alltoallv", "0.78 0.52 1"},
37 {"barrier", "0 0.39 0.78"},
38 {"bcast", "0 0.78 0.39"},
40 {"gatherv", "1 1 0.52"},
42 {"reducescatter", "0.52 1 0.52"},
43 {"scan", "1 0.58 0.23"},
44 {"exscan", "1 0.54 0.25"},
45 {"scatterv", "0.52 0 0.52"},
46 {"scatter", "1 0.74 0.54"},
48 {"computing", "0 1 1"},
49 {"sleeping", "0 0.5 0.5"},
52 {"finalize", "0 1 0"},
56 {"accumulate", "1 0.3 0"},
59 {"raccumulate", "1 0.3 0"},
60 {"compare_and_swap", "0.3 1 0"},
61 {"get_accumulate", "0 1 0.3"},
62 {"rget_accumulate", "1 0.3 0"},
63 {"win_fence", "1 0 0.3"},
64 {"win_post", "1 0 0.8"},
65 {"win_wait", "1 0.8 0"},
66 {"win_start", "0.8 0 1"},
67 {"win_complete", "0.8 1 0"},
68 {"win_lock", "1 0 0.3"},
69 {"win_unlock", "1 0 0.3"},
70 {"win_lock_all", "1 0 0.8"},
71 {"win_unlock_all", "1 0.8 0"},
72 {"win_flush", "1 0 0.3"},
73 {"win_flush_local", "1 0 0.8"},
74 {"win_flush_all", "1 0.8 0"},
75 {"win_flush_local_all", "1 0 0.3"},
77 {"file_read", "1 1 0.3"}};
79 static const char* instr_find_color(const char* c_state)
81 std::string state(c_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& [smpi_state, color] : smpi_colors) { // Is an entry of our map a substring of this state name?
90 if (state.find(smpi_state) != std::string::npos)
94 return "0.5 0.5 0.5"; // Just in case we find nothing in the map ...
97 XBT_PRIVATE simgrid::instr::Container* smpi_container(aid_t pid)
99 return simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(pid));
102 static std::string TRACE_smpi_put_key(aid_t src, aid_t dst, int tag, int send)
105 static unsigned long long counter = 0;
108 std::to_string(src) + "_" + std::to_string(dst) + "_" + std::to_string(tag) + "_" + std::to_string(counter);
112 std::to_string(src) + "#" + std::to_string(dst) + "#" + std::to_string(tag) + "#" + std::to_string(send);
113 keys[aux].push_back(key);
118 static std::string TRACE_smpi_get_key(aid_t src, aid_t dst, int tag, int send)
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()) {
126 key = TRACE_smpi_put_key(src, dst, tag, send);
128 key = it->second.front();
129 it->second.pop_front();
130 if (it->second.empty())
136 void TRACE_smpi_setup_container(aid_t pid, const_sg_host_t host)
138 auto* parent = simgrid::instr::Container::get_root();
139 if (TRACE_smpi_is_grouped()) {
140 parent = simgrid::instr::Container::by_name_or_null(host->get_name());
141 xbt_assert(parent != nullptr, "Could not find a parent for mpi rank 'rank-%ld' at function %s", pid, __func__);
143 parent->create_child(std::string("rank-") + std::to_string(pid), "MPI"); // This container is of type MPI
146 void TRACE_smpi_init(aid_t pid, const std::string& calling_func)
148 if (not TRACE_smpi_is_enabled())
151 auto self = simgrid::s4u::Actor::self();
153 TRACE_smpi_setup_container(pid, sg_host_self());
154 simgrid::s4u::this_actor::on_exit([self](bool) { smpi_container(self->get_pid())->remove_from_parent(); });
156 simgrid::instr::StateType* state = smpi_container(pid)->get_state("MPI_STATE");
158 state->add_entity_value(calling_func, instr_find_color(calling_func.c_str()));
159 state->push_event(calling_func, new simgrid::instr::NoOpTIData("init"));
161 if (TRACE_smpi_is_computing())
162 state->add_entity_value("computing", instr_find_color("computing"));
163 if (TRACE_smpi_is_sleeping())
164 state->add_entity_value("sleeping", instr_find_color("sleeping"));
167 const simgrid::instr::Container* container = smpi_container(pid);
168 papi_counter_t counters = smpi_process()->papi_counters();
170 for (auto const& [counter, _] : counters) {
172 * Check whether this variable already exists or not. Otherwise, it will be created
173 * multiple times but only the last one would be used...
175 container->get_type()->by_name_or_create(counter, "");
180 void TRACE_smpi_sleeping_in(aid_t pid, double duration)
182 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
184 ->get_state("MPI_STATE")
185 ->push_event("sleeping", new simgrid::instr::CpuTIData("sleep", duration));
188 void TRACE_smpi_sleeping_out(aid_t pid)
190 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_sleeping())
191 smpi_container(pid)->get_state("MPI_STATE")->pop_event();
194 void TRACE_smpi_comm_in(aid_t pid, const char* operation, simgrid::instr::TIData* extra)
196 if (not TRACE_smpi_is_enabled()) {
201 simgrid::instr::StateType* state = smpi_container(pid)->get_state("MPI_STATE");
202 state->add_entity_value(operation, instr_find_color(operation));
203 state->push_event(operation, extra);
206 void TRACE_smpi_comm_out(aid_t pid)
208 if (TRACE_smpi_is_enabled())
209 smpi_container(pid)->get_state("MPI_STATE")->pop_event();
212 void TRACE_smpi_send(aid_t rank, aid_t src, aid_t dst, int tag, size_t size)
214 if (not TRACE_smpi_is_enabled())
217 std::string key = TRACE_smpi_get_key(src, dst, tag, 1);
219 XBT_DEBUG("Send tracing from %ld to %ld, tag %d, with key %s", src, dst, tag, key.c_str());
220 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->start_event(smpi_container(rank), "PTP", key, size);
223 void TRACE_smpi_recv(aid_t src, aid_t dst, int tag)
225 if (not TRACE_smpi_is_enabled())
228 std::string key = TRACE_smpi_get_key(src, dst, tag, 0);
230 XBT_DEBUG("Recv tracing from %ld to %ld, tag %d, with key %s", src, dst, tag, key.c_str());
231 simgrid::instr::Container::get_root()->get_link("MPI_LINK")->end_event(smpi_container(dst), "PTP", key);