Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further snake_case in routing
[simgrid.git] / src / surf / instr_routing.cpp
1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "src/instr/instr_private.hpp"
7
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"
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
18
19 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
20
21 static const char *instr_node_name (xbt_node_t node)
22 {
23   void *data = xbt_graph_node_get_data(node);
24   return static_cast<char*>(data);
25 }
26
27 static container_t lowestCommonAncestor (container_t a1, container_t a2)
28 {
29   //this is only an optimization (since most of a1 and a2 share the same parent)
30   if (a1->father_ == a2->father_)
31     return a1->father_;
32
33   //create an array with all ancestors of a1
34   std::vector<container_t> ancestors_a1;
35   container_t p = a1->father_;
36   while (p){
37     ancestors_a1.push_back(p);
38     p = p->father_;
39   }
40
41   //create an array with all ancestors of a2
42   std::vector<container_t> ancestors_a2;
43   p = a2->father_;
44   while (p){
45     ancestors_a2.push_back(p);
46     p = p->father_;
47   }
48
49   //find the lowest ancestor
50   p = nullptr;
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);
56     if (a1p == a2p){
57       p = a1p;
58     }else{
59       break;
60     }
61     i--;
62     j--;
63   }
64   return p;
65 }
66
67 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
68 {
69   //ignore loopback
70   if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
71     XBT_DEBUG ("  linkContainers: ignoring loopback link");
72     return;
73   }
74
75   //find common father
76   container_t father = lowestCommonAncestor (src, dst);
77   if (not father) {
78     xbt_die ("common father unknown, this is a tracing problem");
79   }
80
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());
86     return;
87   }
88   if (filter->find(aux2) != filter->end()) {
89     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
90     return;
91   }
92
93   // ok, not found, register it
94   filter->insert(aux1);
95   filter->insert(aux2);
96
97   //declare type
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);
103
104   //register EDGE types for triva configuration
105   trivaEdgeTypes.insert(link->get_name());
106
107   //create the link
108   static long long counter = 0;
109
110   std::string key = std::to_string(counter);
111   counter++;
112
113   link->startEvent(src, "topology", key);
114   link->endEvent(dst, "topology", key);
115
116   XBT_DEBUG("  linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
117 }
118
119 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
120                                      std::set<std::string>* filter)
121 {
122   if (not TRACE_platform_topology()) {
123     XBT_DEBUG("Graph extraction disabled by user.");
124     return;
125   }
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);
132     }
133   }
134
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>;
138
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);
144   }
145   delete nodes;
146   delete edges;
147   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
148 }
149
150 /*
151  * Callbacks
152  */
153 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
154 {
155   std::string id = netzone.get_name();
156
157   if (simgrid::instr::Container::getRoot() == nullptr) {
158     simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
159
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     }
166
167     if (TRACE_needs_platform()){
168       currentContainer.push_back(root);
169     }
170     return;
171   }
172
173   if (TRACE_needs_platform()){
174     simgrid::instr::NetZoneContainer* container =
175         new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
176     currentContainer.push_back(container);
177   }
178 }
179
180 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
181 {
182   if (TRACE_needs_platform()){
183     currentContainer.pop_back();
184   }
185 }
186
187 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
188 {
189   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
190     return;
191
192   container_t father    = currentContainer.back();
193   container_t container = new simgrid::instr::Container(link.get_name(), "LINK", father);
194
195   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
196     simgrid::instr::VariableType* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
197     bandwidth->setCallingContainer(container);
198     bandwidth->setEvent(0, link.bandwidth());
199     simgrid::instr::VariableType* latency = container->type_->getOrCreateVariableType("latency", "");
200     latency->setCallingContainer(container);
201     latency->setEvent(0, link.latency());
202   }
203   if (TRACE_uncategorized()) {
204     container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
205   }
206 }
207
208 static void sg_instr_new_host(simgrid::s4u::Host& host)
209 {
210   container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
211   container_t root      = simgrid::instr::Container::getRoot();
212
213   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
214     simgrid::instr::VariableType* power = container->type_->getOrCreateVariableType("power", "");
215     power->setCallingContainer(container);
216     power->setEvent(0, host.getSpeed());
217   }
218
219   if (TRACE_uncategorized())
220     container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
221
222   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped())
223     container->type_->getOrCreateContainerType("MPI")->getOrCreateStateType("MPI_STATE");
224
225   if (TRACE_actor_is_enabled()) {
226     simgrid::instr::ContainerType* actor = container->type_->getOrCreateContainerType("ACTOR");
227     simgrid::instr::StateType* state     = actor->getOrCreateStateType("ACTOR_STATE");
228     state->addEntityValue("suspend", "1 0 1");
229     state->addEntityValue("sleep", "1 1 0");
230     state->addEntityValue("receive", "1 0 0");
231     state->addEntityValue("send", "0 0 1");
232     state->addEntityValue("task_execute", "0 1 1");
233     root->type_->getOrCreateLinkType("ACTOR_LINK", actor, actor);
234     root->type_->getOrCreateLinkType("ACTOR_TASK_LINK", actor, actor);
235   }
236
237   if (TRACE_vm_is_enabled()) {
238     simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
239     simgrid::instr::StateType* state      = msg_vm->getOrCreateStateType("MSG_VM_STATE");
240     state->addEntityValue("suspend", "1 0 1");
241     state->addEntityValue("sleep", "1 1 0");
242     state->addEntityValue("receive", "1 0 0");
243     state->addEntityValue("send", "0 0 1");
244     state->addEntityValue("task_execute", "0 1 1");
245     root->type_->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
246     root->type_->getOrCreateLinkType("MSG_VM_ACTOR_LINK", msg_vm, msg_vm);
247   }
248 }
249
250 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
251 {
252   if (netpoint->is_router() && TRACE_is_enabled() && TRACE_needs_platform())
253     new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
254 }
255
256 static void instr_routing_parse_end_platform ()
257 {
258   currentContainer.clear();
259   std::set<std::string>* filter = new std::set<std::string>;
260   XBT_DEBUG ("Starting graph extraction.");
261   recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), simgrid::instr::Container::getRoot(),
262                            filter);
263   XBT_DEBUG ("Graph extraction finished.");
264   delete filter;
265   TRACE_paje_dump_buffer(true);
266 }
267
268 void instr_routing_define_callbacks ()
269 {
270   // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
271   if (not TRACE_is_enabled())
272     return;
273   if (TRACE_needs_platform()) {
274     simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
275     simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
276     simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
277   }
278   simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
279   simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
280   simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
281 }
282 /*
283  * user categories support
284  */
285 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
286 {
287   if (root->get_name() == "HOST" || root->get_name() == "MSG_VM")
288     root->getOrCreateVariableType(std::string("p") + new_typename, color);
289
290   if (root->get_name() == "LINK")
291     root->getOrCreateVariableType(std::string("b") + new_typename, color);
292
293   for (auto elm : root->children_) {
294     recursiveNewVariableType(new_typename, color, elm.second);
295   }
296 }
297
298 void instr_new_variable_type(std::string new_typename, std::string color)
299 {
300   recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRoot()->type_);
301 }
302
303 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
304                                          simgrid::instr::Type* root)
305 {
306   if (root->get_name() == father_type) {
307     root->getOrCreateVariableType(new_typename, color);
308   }
309   for (auto elm : root->children_)
310     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
311 }
312
313 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
314 {
315   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRoot()->type_);
316 }
317
318 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
319 {
320   if (root->get_name() == father_type)
321     root->getOrCreateStateType(new_typename);
322
323   for (auto elm : root->children_)
324     recursiveNewUserStateType(father_type, new_typename, elm.second);
325 }
326
327 void instr_new_user_state_type(std::string father_type, std::string new_typename)
328 {
329   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRoot()->type_);
330 }
331
332 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
333                                               simgrid::instr::Type* root)
334 {
335   if (root->get_name() == type_name)
336     static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
337
338   for (auto elm : root->children_)
339     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
340 }
341
342 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
343 {
344   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRoot()->type_);
345 }
346
347 #define GRAPHICATOR_SUPPORT_FUNCTIONS
348
349 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
350                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
351                                         container_t container)
352 {
353   if (not netzone->getChildren()->empty()) {
354     //bottom-up recursion
355     for (auto const& netzone_child : *netzone->getChildren()) {
356       container_t child_container = container->children_.at(netzone_child->get_cname());
357       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
358     }
359   }
360
361   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
362 }
363
364 xbt_graph_t instr_routing_platform_graph ()
365 {
366   xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
367   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
368   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
369   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
370                               simgrid::instr::Container::getRoot());
371   delete nodes;
372   delete edges;
373   return ret;
374 }
375
376 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
377 {
378   unsigned int cursor = 0;
379   xbt_node_t node = nullptr;
380   xbt_edge_t edge = nullptr;
381
382   FILE *file = fopen(filename, "w");
383   xbt_assert(file, "Failed to open %s \n", filename);
384
385   if (g->directed)
386     fprintf(file, "digraph test {\n");
387   else
388     fprintf(file, "graph test {\n");
389
390   fprintf(file, "  graph [overlap=scale]\n");
391
392   fprintf(file, "  node [shape=box, style=filled]\n");
393   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
394
395   xbt_dynar_foreach(g->nodes, cursor, node) {
396     fprintf(file, "  \"%s\";\n", instr_node_name(node));
397   }
398   xbt_dynar_foreach(g->edges, cursor, edge) {
399     const char *src_s = instr_node_name (edge->src);
400     const char *dst_s = instr_node_name (edge->dst);
401     if (g->directed)
402       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
403     else
404       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
405   }
406   fprintf(file, "}\n");
407   fclose(file);
408 }