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. */
6 #include "src/instr/instr_private.hpp"
8 #include "simgrid/kernel/routing/NetPoint.hpp"
9 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
10 #include "simgrid/s4u/Engine.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "surf/surf.hpp"
15 #include "xbt/graph.h"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
19 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
21 static const char *instr_node_name (xbt_node_t node)
23 void *data = xbt_graph_node_get_data(node);
24 return static_cast<char*>(data);
27 static container_t lowestCommonAncestor (container_t a1, container_t a2)
29 //this is only an optimization (since most of a1 and a2 share the same parent)
30 if (a1->father_ == a2->father_)
33 //create an array with all ancestors of a1
34 std::vector<container_t> ancestors_a1;
35 container_t p = a1->father_;
37 ancestors_a1.push_back(p);
41 //create an array with all ancestors of a2
42 std::vector<container_t> ancestors_a2;
45 ancestors_a2.push_back(p);
49 //find the lowest ancestor
51 int i = ancestors_a1.size() - 1;
52 int j = ancestors_a2.size() - 1;
53 while (i >= 0 && j >= 0){
54 container_t a1p = ancestors_a1.at(i);
55 container_t a2p = ancestors_a2.at(j);
67 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
70 if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
71 XBT_DEBUG (" linkContainers: ignoring loopback link");
76 container_t father = lowestCommonAncestor (src, dst);
78 xbt_die ("common father unknown, this is a tracing problem");
81 // check if we already register this pair (we only need one direction)
82 std::string aux1 = src->get_name() + dst->get_name();
83 std::string aux2 = dst->get_name() + src->get_name();
84 if (filter->find(aux1) != filter->end()) {
85 XBT_DEBUG(" linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
88 if (filter->find(aux2) != filter->end()) {
89 XBT_DEBUG(" linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
93 // ok, not found, register it
98 std::string link_typename = father->type_->get_name() + "-" + src->type_->get_name() +
99 std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
100 std::to_string(dst->type_->get_id());
101 simgrid::instr::LinkType* link = father->type_->getOrCreateLinkType(link_typename, src->type_, dst->type_);
102 link->setCallingContainer(father);
104 //register EDGE types for triva configuration
105 trivaEdgeTypes.insert(link->get_name());
108 static long long counter = 0;
110 std::string key = std::to_string(counter);
113 link->startEvent(src, "topology", key);
114 link->endEvent(dst, "topology", key);
116 XBT_DEBUG(" linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
119 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
120 std::set<std::string>* filter)
122 if (not TRACE_platform_topology()) {
123 XBT_DEBUG("Graph extraction disabled by user.");
126 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->get_cname());
127 if (not netzone->getChildren()->empty()) {
128 //bottom-up recursion
129 for (auto const& nz_son : *netzone->getChildren()) {
130 container_t child_container = container->children_.at(nz_son->get_cname());
131 recursiveGraphExtraction(nz_son, child_container, filter);
135 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
136 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
137 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
139 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
140 for (auto elm : *edges) {
141 xbt_edge_t edge = elm.second;
142 linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
143 simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
147 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
153 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
155 std::string id = netzone.get_name();
157 if (simgrid::instr::Container::getRoot() == nullptr) {
158 simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
160 if (TRACE_smpi_is_enabled()) {
161 simgrid::instr::Type* mpi = root->type_->getOrCreateContainerType("MPI");
162 if (not TRACE_smpi_is_grouped())
163 mpi->getOrCreateStateType("MPI_STATE");
164 root->type_->getOrCreateLinkType("MPI_LINK", mpi, mpi);
165 // TODO See if we can move this to the LoadBalancer plugin
166 root->type_->getOrCreateLinkType("MIGRATE_LINK", mpi, mpi);
167 mpi->getOrCreateStateType("MIGRATE_STATE");
170 if (TRACE_needs_platform()){
171 currentContainer.push_back(root);
176 if (TRACE_needs_platform()){
177 simgrid::instr::NetZoneContainer* container =
178 new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
179 currentContainer.push_back(container);
183 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
185 if (TRACE_needs_platform()){
186 currentContainer.pop_back();
190 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
192 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
195 container_t father = currentContainer.back();
196 container_t container = new simgrid::instr::Container(link.get_name(), "LINK", father);
198 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
199 simgrid::instr::VariableType* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
200 bandwidth->setCallingContainer(container);
201 bandwidth->setEvent(0, link.bandwidth());
202 simgrid::instr::VariableType* latency = container->type_->getOrCreateVariableType("latency", "");
203 latency->setCallingContainer(container);
204 latency->setEvent(0, link.latency());
206 if (TRACE_uncategorized()) {
207 container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
211 static void sg_instr_new_host(simgrid::s4u::Host& host)
213 container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
214 container_t root = simgrid::instr::Container::getRoot();
216 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
217 simgrid::instr::VariableType* power = container->type_->getOrCreateVariableType("power", "");
218 power->setCallingContainer(container);
219 power->setEvent(0, host.getSpeed());
222 if (TRACE_uncategorized())
223 container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
225 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()) {
226 simgrid::instr::ContainerType* mpi = container->type_->getOrCreateContainerType("MPI");
227 mpi->getOrCreateStateType("MPI_STATE");
228 // TODO See if we can move this to the LoadBalancer plugin
229 root->type_->getOrCreateLinkType("MIGRATE_LINK", mpi, mpi);
230 mpi->getOrCreateStateType("MIGRATE_STATE");
233 if (TRACE_actor_is_enabled()) {
234 simgrid::instr::ContainerType* actor = container->type_->getOrCreateContainerType("ACTOR");
235 simgrid::instr::StateType* state = actor->getOrCreateStateType("ACTOR_STATE");
236 state->addEntityValue("suspend", "1 0 1");
237 state->addEntityValue("sleep", "1 1 0");
238 state->addEntityValue("receive", "1 0 0");
239 state->addEntityValue("send", "0 0 1");
240 state->addEntityValue("task_execute", "0 1 1");
241 root->type_->getOrCreateLinkType("ACTOR_LINK", actor, actor);
242 root->type_->getOrCreateLinkType("ACTOR_TASK_LINK", actor, actor);
245 if (TRACE_vm_is_enabled()) {
246 simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
247 simgrid::instr::StateType* state = msg_vm->getOrCreateStateType("MSG_VM_STATE");
248 state->addEntityValue("suspend", "1 0 1");
249 state->addEntityValue("sleep", "1 1 0");
250 state->addEntityValue("receive", "1 0 0");
251 state->addEntityValue("send", "0 0 1");
252 state->addEntityValue("task_execute", "0 1 1");
253 root->type_->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
254 root->type_->getOrCreateLinkType("MSG_VM_ACTOR_LINK", msg_vm, msg_vm);
258 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
260 if (netpoint->is_router() && TRACE_is_enabled() && TRACE_needs_platform())
261 new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
264 static void instr_routing_parse_end_platform ()
266 currentContainer.clear();
267 std::set<std::string>* filter = new std::set<std::string>;
268 XBT_DEBUG ("Starting graph extraction.");
269 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), simgrid::instr::Container::getRoot(),
271 XBT_DEBUG ("Graph extraction finished.");
273 TRACE_paje_dump_buffer(true);
276 void instr_routing_define_callbacks ()
278 // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
279 if (not TRACE_is_enabled())
281 if (TRACE_needs_platform()) {
282 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
283 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
284 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
286 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
287 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
288 simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
291 * user categories support
293 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
295 if (root->get_name() == "HOST" || root->get_name() == "MSG_VM")
296 root->getOrCreateVariableType(std::string("p") + new_typename, color);
298 if (root->get_name() == "LINK")
299 root->getOrCreateVariableType(std::string("b") + new_typename, color);
301 for (auto elm : root->children_) {
302 recursiveNewVariableType(new_typename, color, elm.second);
306 void instr_new_variable_type(std::string new_typename, std::string color)
308 recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRoot()->type_);
311 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
312 simgrid::instr::Type* root)
314 if (root->get_name() == father_type) {
315 root->getOrCreateVariableType(new_typename, color);
317 for (auto elm : root->children_)
318 recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
321 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
323 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRoot()->type_);
326 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
328 if (root->get_name() == father_type)
329 root->getOrCreateStateType(new_typename);
331 for (auto elm : root->children_)
332 recursiveNewUserStateType(father_type, new_typename, elm.second);
335 void instr_new_user_state_type(std::string father_type, std::string new_typename)
337 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRoot()->type_);
340 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
341 simgrid::instr::Type* root)
343 if (root->get_name() == type_name)
344 static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
346 for (auto elm : root->children_)
347 recursiveNewValueForUserStateType(type_name, val, color, elm.second);
350 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
352 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRoot()->type_);
355 #define GRAPHICATOR_SUPPORT_FUNCTIONS
357 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
358 std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
359 container_t container)
361 if (not netzone->getChildren()->empty()) {
362 //bottom-up recursion
363 for (auto const& netzone_child : *netzone->getChildren()) {
364 container_t child_container = container->children_.at(netzone_child->get_cname());
365 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
369 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
372 xbt_graph_t instr_routing_platform_graph ()
374 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
375 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
376 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
377 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
378 simgrid::instr::Container::getRoot());
384 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
386 unsigned int cursor = 0;
387 xbt_node_t node = nullptr;
388 xbt_edge_t edge = nullptr;
390 FILE *file = fopen(filename, "w");
391 xbt_assert(file, "Failed to open %s \n", filename);
394 fprintf(file, "digraph test {\n");
396 fprintf(file, "graph test {\n");
398 fprintf(file, " graph [overlap=scale]\n");
400 fprintf(file, " node [shape=box, style=filled]\n");
401 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
403 xbt_dynar_foreach(g->nodes, cursor, node) {
404 fprintf(file, " \"%s\";\n", instr_node_name(node));
406 xbt_dynar_foreach(g->edges, cursor, edge) {
407 const char *src_s = instr_node_name (edge->src);
408 const char *dst_s = instr_node_name (edge->dst);
410 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
412 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
414 fprintf(file, "}\n");