1 /* Copyright (c) 2010-2017. 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.h"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/kernel/routing/NetZoneImpl.hpp"
11 #include "src/kernel/routing/NetPoint.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "surf/surf.h"
15 #include "xbt/graph.h"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
19 static int platform_created = 0; /* indicate whether the platform file has been traced */
20 static std::vector<container_t> currentContainer; /* push and pop, used only in creation */
22 static const char *instr_node_name (xbt_node_t node)
24 void *data = xbt_graph_node_get_data(node);
25 return static_cast<char*>(data);
28 static container_t lowestCommonAncestor (container_t a1, container_t a2)
30 //this is only an optimization (since most of a1 and a2 share the same parent)
31 if (a1->father == a2->father)
34 //create an array with all ancestors of a1
35 std::vector<container_t> ancestors_a1;
36 container_t p = a1->father;
38 ancestors_a1.push_back(p);
42 //create an array with all ancestors of a2
43 std::vector<container_t> ancestors_a2;
46 ancestors_a2.push_back(p);
50 //find the lowest ancestor
52 int i = ancestors_a1.size() - 1;
53 int j = ancestors_a2.size() - 1;
54 while (i >= 0 && j >= 0){
55 container_t a1p = ancestors_a1.at(i);
56 container_t a2p = ancestors_a2.at(j);
68 static void linkContainers (container_t src, container_t dst, xbt_dict_t filter)
71 if (strcmp (src->name, "__loopback__") == 0 || strcmp (dst->name, "__loopback__") == 0){
72 XBT_DEBUG (" linkContainers: ignoring loopback link");
77 container_t father = lowestCommonAncestor (src, dst);
79 xbt_die ("common father unknown, this is a tracing problem");
82 if (filter != nullptr){
83 //check if we already register this pair (we only need one direction)
84 char aux1[INSTR_DEFAULT_STR_SIZE];
85 char aux2[INSTR_DEFAULT_STR_SIZE];
86 snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name, dst->name);
87 snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name, src->name);
88 if (xbt_dict_get_or_null (filter, aux1)){
89 XBT_DEBUG (" linkContainers: already registered %s <-> %s (1)", src->name, dst->name);
92 if (xbt_dict_get_or_null (filter, aux2)){
93 XBT_DEBUG (" linkContainers: already registered %s <-> %s (2)", dst->name, src->name);
97 //ok, not found, register it
98 xbt_dict_set (filter, aux1, xbt_strdup ("1"), nullptr);
99 xbt_dict_set (filter, aux2, xbt_strdup ("1"), nullptr);
103 char link_typename[INSTR_DEFAULT_STR_SIZE];
104 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
106 src->type->name, src->type->id,
107 dst->type->name, dst->type->id);
108 type_t link_type = PJ_type_get_or_null (link_typename, father->type);
109 if (link_type == nullptr){
110 link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
113 //register EDGE types for triva configuration
114 xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), nullptr);
117 static long long counter = 0;
119 char key[INSTR_DEFAULT_STR_SIZE];
120 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
123 new StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
124 new EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
126 XBT_DEBUG (" linkContainers %s <-> %s", src->name, dst->name);
129 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container, xbt_dict_t filter)
131 if (not TRACE_platform_topology()) {
132 XBT_DEBUG("Graph extraction disabled by user.");
135 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
136 if (not netzone->getChildren()->empty()) {
137 //bottom-up recursion
138 for (auto nz_son : *netzone->getChildren()) {
139 container_t child_container = static_cast<container_t>(xbt_dict_get(container->children, nz_son->getCname()));
140 recursiveGraphExtraction(nz_son, child_container, filter);
144 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
145 xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
146 xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
147 xbt_edge_t edge = nullptr;
149 xbt_dict_cursor_t cursor = nullptr;
152 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
153 xbt_dict_foreach(edges,cursor,edge_name,edge) {
155 PJ_container_get(static_cast<const char*>(edge->src->data)),
156 PJ_container_get(static_cast<const char*>(edge->dst->data)), filter);
158 xbt_dict_free (&nodes);
159 xbt_dict_free (&edges);
160 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
166 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
168 const char* id = netzone.getCname();
170 if (PJ_container_get_root() == nullptr){
171 PJ_container_alloc ();
173 container_t root = PJ_container_new (id, INSTR_AS, nullptr);
174 PJ_container_set_root (root);
176 if (TRACE_smpi_is_enabled()) {
177 type_t mpi = PJ_type_get_or_null ("MPI", root->type);
179 mpi = PJ_type_container_new("MPI", root->type);
180 if (not TRACE_smpi_is_grouped())
181 PJ_type_state_new ("MPI_STATE", mpi);
182 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
186 if (TRACE_needs_platform()){
187 currentContainer.push_back(root);
192 if (TRACE_needs_platform()){
193 container_t father = currentContainer.back();
194 container_t container = PJ_container_new (id, INSTR_AS, father);
195 currentContainer.push_back(container);
199 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
201 if (TRACE_needs_platform()){
202 currentContainer.pop_back();
206 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
208 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
210 container_t father = currentContainer.back();
212 double bandwidth_value = link.bandwidth();
213 double latency_value = link.latency();
215 container_t container = PJ_container_new(link.name(), INSTR_LINK, father);
217 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
218 type_t bandwidth = PJ_type_get_or_null("bandwidth", container->type);
219 if (bandwidth == nullptr) {
220 bandwidth = PJ_type_variable_new("bandwidth", nullptr, container->type);
222 type_t latency = PJ_type_get_or_null("latency", container->type);
223 if (latency == nullptr) {
224 latency = PJ_type_variable_new("latency", nullptr, container->type);
226 new SetVariableEvent(0, container, bandwidth, bandwidth_value);
227 new SetVariableEvent(0, container, latency, latency_value);
229 if (TRACE_uncategorized()) {
230 type_t bandwidth_used = PJ_type_get_or_null("bandwidth_used", container->type);
231 if (bandwidth_used == nullptr) {
232 PJ_type_variable_new("bandwidth_used", "0.5 0.5 0.5", container->type);
237 static void sg_instr_new_host(simgrid::s4u::Host& host)
239 container_t father = currentContainer.back();
240 container_t container = PJ_container_new(host.getCname(), INSTR_HOST, father);
242 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
243 type_t speed = PJ_type_get_or_null ("power", container->type);
244 if (speed == nullptr){
245 speed = PJ_type_variable_new ("power", nullptr, container->type);
248 double current_speed_state = host.getSpeed();
249 new SetVariableEvent (0, container, speed, current_speed_state);
251 if (TRACE_uncategorized()){
252 type_t speed_used = PJ_type_get_or_null ("power_used", container->type);
253 if (speed_used == nullptr){
254 PJ_type_variable_new ("power_used", "0.5 0.5 0.5", container->type);
258 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
259 type_t mpi = PJ_type_get_or_null ("MPI", container->type);
261 mpi = PJ_type_container_new("MPI", container->type);
262 PJ_type_state_new ("MPI_STATE", mpi);
266 if (TRACE_msg_process_is_enabled()) {
267 type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", container->type);
268 if (msg_process == nullptr){
269 msg_process = PJ_type_container_new("MSG_PROCESS", container->type);
270 type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
271 PJ_value_new ("suspend", "1 0 1", state);
272 PJ_value_new ("sleep", "1 1 0", state);
273 PJ_value_new ("receive", "1 0 0", state);
274 PJ_value_new ("send", "0 0 1", state);
275 PJ_value_new ("task_execute", "0 1 1", state);
276 PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
277 PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
281 if (TRACE_msg_vm_is_enabled()) {
282 type_t msg_vm = PJ_type_get_or_null ("MSG_VM", container->type);
283 if (msg_vm == nullptr){
284 msg_vm = PJ_type_container_new("MSG_VM", container->type);
285 type_t state = PJ_type_state_new ("MSG_VM_STATE", msg_vm);
286 PJ_value_new ("suspend", "1 0 1", state);
287 PJ_value_new ("sleep", "1 1 0", state);
288 PJ_value_new ("receive", "1 0 0", state);
289 PJ_value_new ("send", "0 0 1", state);
290 PJ_value_new ("task_execute", "0 1 1", state);
291 PJ_type_link_new ("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
292 PJ_type_link_new ("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
298 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
300 if (not netpoint->isRouter())
302 if (TRACE_is_enabled() && TRACE_needs_platform()) {
303 container_t father = currentContainer.back();
304 PJ_container_new(netpoint->cname(), INSTR_ROUTER, father);
308 static void instr_routing_parse_end_platform ()
310 currentContainer.clear();
311 xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free_f);
312 XBT_DEBUG ("Starting graph extraction.");
313 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
314 XBT_DEBUG ("Graph extraction finished.");
315 xbt_dict_free(&filter);
316 platform_created = 1;
317 TRACE_paje_dump_buffer(1);
320 void instr_routing_define_callbacks ()
322 //always need the call backs to ASes (we need only the root AS),
323 //to create the rootContainer and the rootType properly
324 if (not TRACE_is_enabled())
326 if (TRACE_needs_platform()) {
327 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
328 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
329 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
331 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
332 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
333 simgrid::kernel::routing::NetPoint::onCreation.connect(&sg_instr_new_router);
336 * user categories support
338 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
340 if (not strcmp(root->name, "HOST")) {
341 char tnstr[INSTR_DEFAULT_STR_SIZE];
342 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
343 PJ_type_variable_new (tnstr, color, root);
345 if (not strcmp(root->name, "MSG_VM")) {
346 char tnstr[INSTR_DEFAULT_STR_SIZE];
347 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
348 PJ_type_variable_new (tnstr, color, root);
350 if (not strcmp(root->name, "LINK")) {
351 char tnstr[INSTR_DEFAULT_STR_SIZE];
352 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
353 PJ_type_variable_new (tnstr, color, root);
355 xbt_dict_cursor_t cursor = nullptr;
358 xbt_dict_foreach(root->children, cursor, name, child_type) {
359 recursiveNewVariableType (new_typename, color, child_type);
363 void instr_new_variable_type (const char *new_typename, const char *color)
365 recursiveNewVariableType (new_typename, color, PJ_type_get_root());
368 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
370 if (not strcmp(root->name, father_type)) {
371 PJ_type_variable_new (new_typename, color, root);
373 xbt_dict_cursor_t cursor = nullptr;
376 xbt_dict_foreach(root->children, cursor, name, child_type) {
377 recursiveNewUserVariableType (father_type, new_typename, color, child_type);
381 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
383 recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
386 static void recursiveNewUserStateType (const char *father_type, const char *new_typename, type_t root)
388 if (not strcmp(root->name, father_type)) {
389 PJ_type_state_new (new_typename, root);
391 xbt_dict_cursor_t cursor = nullptr;
394 xbt_dict_foreach(root->children, cursor, name, child_type) {
395 recursiveNewUserStateType (father_type, new_typename, child_type);
399 void instr_new_user_state_type (const char *father_type, const char *new_typename)
401 recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
404 static void recursiveNewValueForUserStateType (const char *type_name, const char *value, const char *color, type_t root)
406 if (not strcmp(root->name, type_name)) {
407 PJ_value_new (value, color, root);
409 xbt_dict_cursor_t cursor = nullptr;
412 xbt_dict_foreach(root->children, cursor, name, child_type) {
413 recursiveNewValueForUserStateType (type_name, value, color, child_type);
417 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
419 recursiveNewValueForUserStateType (type_name, value, color, PJ_type_get_root());
422 int instr_platform_traced ()
424 return platform_created;
427 #define GRAPHICATOR_SUPPORT_FUNCTIONS
429 static void recursiveXBTGraphExtraction(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges, sg_netzone_t netzone,
430 container_t container)
432 if (not netzone->getChildren()->empty()) {
433 //bottom-up recursion
434 for (auto netzone_child : *netzone->getChildren()) {
435 container_t child_container =
436 static_cast<container_t>(xbt_dict_get(container->children, netzone_child->getCname()));
437 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
441 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
444 xbt_graph_t instr_routing_platform_graph ()
446 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
447 xbt_dict_t nodes = xbt_dict_new_homogeneous(nullptr);
448 xbt_dict_t edges = xbt_dict_new_homogeneous(nullptr);
449 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
450 PJ_container_get_root());
451 xbt_dict_free (&nodes);
452 xbt_dict_free (&edges);
456 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
458 unsigned int cursor = 0;
459 xbt_node_t node = nullptr;
460 xbt_edge_t edge = nullptr;
462 FILE *file = fopen(filename, "w");
463 xbt_assert(file, "Failed to open %s \n", filename);
466 fprintf(file, "digraph test {\n");
468 fprintf(file, "graph test {\n");
470 fprintf(file, " graph [overlap=scale]\n");
472 fprintf(file, " node [shape=box, style=filled]\n");
473 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
475 xbt_dynar_foreach(g->nodes, cursor, node) {
476 fprintf(file, " \"%s\";\n", instr_node_name(node));
478 xbt_dynar_foreach(g->edges, cursor, edge) {
479 const char *src_s = instr_node_name (edge->src);
480 const char *dst_s = instr_node_name (edge->dst);
482 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
484 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
486 fprintf(file, "}\n");