1 /* Copyright (c) 2010. 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. */
7 #include "instr/instr_private.h"
10 #include "surf/surf_private.h"
11 #include "surf/network_private.h"
12 #include "xbt/graph.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
16 extern xbt_dict_t defined_types; /* from instr_interface.c */
18 static int platform_created = 0; /* indicate whether the platform file has been traced */
19 static xbt_dynar_t currentContainer = NULL; /* 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 char *str = (char*)data;
29 static container_t lowestCommonAncestor (container_t a1, container_t a2)
31 //this is only an optimization (since most of a1 and a2 share the same parent)
32 if (a1->father == a2->father) return a1->father;
34 //create an array with all ancestors of a1
35 xbt_dynar_t ancestors_a1 = xbt_dynar_new(sizeof(container_t), NULL);
39 xbt_dynar_push_as (ancestors_a1, container_t, p);
43 //create an array with all ancestors of a2
44 xbt_dynar_t ancestors_a2 = xbt_dynar_new(sizeof(container_t), NULL);
47 xbt_dynar_push_as (ancestors_a2, container_t, p);
51 //find the lowest ancestor
53 int i = xbt_dynar_length (ancestors_a1) - 1;
54 int j = xbt_dynar_length (ancestors_a2) - 1;
55 while (i >= 0 && j >= 0){
56 container_t a1p = *(container_t*)xbt_dynar_get_ptr (ancestors_a1, i);
57 container_t a2p = *(container_t*)xbt_dynar_get_ptr (ancestors_a2, j);
66 xbt_dynar_free (&ancestors_a1);
67 xbt_dynar_free (&ancestors_a2);
71 static void linkContainers (container_t src, container_t dst, xbt_dict_t filter)
74 if (strcmp (src->name, "__loopback__") == 0 || strcmp (dst->name, "__loopback__") == 0){
75 XBT_DEBUG (" linkContainers: ignoring loopback link");
80 container_t father = lowestCommonAncestor (src, dst);
82 xbt_die ("common father unknown, this is a tracing problem");
86 //check if we already register this pair (we only need one direction)
87 char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
88 snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name, dst->name);
89 snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name, src->name);
90 if (xbt_dict_get_or_null (filter, aux1)){
91 XBT_DEBUG (" linkContainers: already registered %s <-> %s (1)", src->name, dst->name);
94 if (xbt_dict_get_or_null (filter, aux2)){
95 XBT_DEBUG (" linkContainers: already registered %s <-> %s (2)", dst->name, src->name);
99 //ok, not found, register it
100 xbt_dict_set (filter, aux1, xbt_strdup ("1"), NULL);
101 xbt_dict_set (filter, aux2, xbt_strdup ("1"), NULL);
105 char link_typename[INSTR_DEFAULT_STR_SIZE];
106 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
108 src->type->name, src->type->id,
109 dst->type->name, dst->type->id);
110 type_t link_type = PJ_type_get_or_null (link_typename, father->type);
111 if (link_type == NULL){
112 link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
115 //register EDGE types for triva configuration
116 xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), NULL);
119 static long long counter = 0;
120 char key[INSTR_DEFAULT_STR_SIZE];
121 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
122 new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "topology", key);
123 new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "topology", key);
125 XBT_DEBUG (" linkContainers %s <-> %s", src->name, dst->name);
128 static int graph_extraction_filter_out (container_t c1, container_t c2)
130 if (c1->kind == INSTR_LINK ||
131 c1->kind == INSTR_SMPI ||
132 c1->kind == INSTR_MSG_PROCESS ||
133 c1->kind == INSTR_MSG_TASK ||
134 (c2 && strcmp (c1->name, c2->name) == 0))
140 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
142 if (!TRACE_platform_topology()){
143 XBT_DEBUG("Graph extracing disable by user.");
146 XBT_DEBUG ("Graph extraction for routing_component = %s", rc->name);
147 if (!xbt_dict_is_empty(rc->routing_sons)){
148 xbt_dict_cursor_t cursor = NULL;
151 //bottom-up recursion
152 xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
153 container_t child_container = xbt_dict_get (container->children, rc_son->name);
154 recursiveGraphExtraction (rc_son, child_container, filter);
159 xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
160 container_t child1, child2;
161 const char *child1_name, *child2_name;
162 xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
163 if (graph_extraction_filter_out (child1, NULL)) continue;
164 xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
165 if (graph_extraction_filter_out (child2, child1)) continue;
166 XBT_DEBUG ("get_route from %s to %s", child1_name, child2_name);
169 sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t,1);
170 route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
171 rc->get_route_and_latency(rc, child1->net_elm, child2->net_elm,
174 //user might want to extract a graph using routes with only one link
175 //see --cfg=tracing/onelink_only:1 or --help-tracing for details
176 if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1){
177 generic_free_route(route);
181 //traverse the route connecting the containers
184 container_t current, previous;
186 previous = PJ_container_get(route->gw_src->name);
191 xbt_dynar_foreach (route->link_list, cpt, link) {
192 //FIXME (TODO): Should have a cleaner way to get the link name
193 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
194 current = PJ_container_get(link_name);
195 linkContainers(previous, current, filter);
199 current = PJ_container_get(route->gw_dst->name);
203 linkContainers(previous, current, filter);
204 generic_free_route(route);
212 static void instr_routing_parse_start_AS (sg_platf_AS_cbarg_t AS)
214 const char*id = AS->id;
216 if (PJ_container_get_root() == NULL){
217 PJ_container_alloc ();
219 container_t root = PJ_container_new (id, INSTR_AS, NULL);
220 PJ_container_set_root (root);
222 if (TRACE_smpi_is_enabled()) {
223 if (!TRACE_smpi_is_grouped()){
224 type_t mpi = PJ_type_get_or_null ("MPI", root->type);
226 mpi = PJ_type_container_new("MPI", root->type);
227 PJ_type_state_new ("MPI_STATE", mpi);
228 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
233 if (TRACE_needs_platform()){
234 currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
235 xbt_dynar_push (currentContainer, &root);
240 if (TRACE_needs_platform()){
241 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
242 container_t new = PJ_container_new (id, INSTR_AS, father);
243 xbt_dynar_push (currentContainer, &new);
247 static void instr_routing_parse_end_AS ()
249 if (TRACE_needs_platform()){
250 xbt_dynar_pop_ptr (currentContainer);
254 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
256 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
258 double bandwidth_value = link->bandwidth;
259 double latency_value = link->latency;
260 xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
262 if (link->policy == SURF_LINK_FULLDUPLEX){
263 char *up = bprintf("%s_UP", link->id);
264 char *down = bprintf("%s_DOWN", link->id);
265 xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
266 xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
270 xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
273 char *link_name = NULL;
275 xbt_dynar_foreach (links_to_create, i, link_name){
277 container_t new = PJ_container_new (link_name, INSTR_LINK, father);
279 if (TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()){
280 type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
281 if (bandwidth == NULL){
282 bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
284 type_t latency = PJ_type_get_or_null ("latency", new->type);
285 if (latency == NULL){
286 latency = PJ_type_variable_new ("latency", NULL, new->type);
288 new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
289 new_pajeSetVariable (0, new, latency, latency_value);
291 if (TRACE_uncategorized()){
292 type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
293 if (bandwidth_used == NULL){
294 bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
299 xbt_dynar_free (&links_to_create);
302 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
304 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
305 container_t new = PJ_container_new (host->id, INSTR_HOST, father);
307 if (TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) {
308 type_t power = PJ_type_get_or_null ("power", new->type);
310 power = PJ_type_variable_new ("power", NULL, new->type);
312 new_pajeSetVariable (0, new, power, host->power_peak);
314 if (TRACE_uncategorized()){
315 type_t power_used = PJ_type_get_or_null ("power_used", new->type);
316 if (power_used == NULL){
317 power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
321 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
322 type_t mpi = PJ_type_get_or_null ("MPI", new->type);
324 mpi = PJ_type_container_new("MPI", new->type);
325 PJ_type_state_new ("MPI_STATE", mpi);
326 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
330 if (TRACE_msg_process_is_enabled()) {
331 type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
332 if (msg_process == NULL){
333 msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
334 type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
335 PJ_value_new ("suspend", "1 0 1", state);
336 PJ_value_new ("sleep", "1 1 0", state);
337 PJ_value_new ("receive", "1 0 0", state);
338 PJ_value_new ("send", "0 0 1", state);
339 PJ_value_new ("task_execute", "0 1 1", state);
340 PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
341 PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
346 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
348 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
349 PJ_container_new (router->id, INSTR_ROUTER, father);
352 static void instr_routing_parse_end_platform ()
354 xbt_dynar_free(¤tContainer);
355 currentContainer = NULL;
356 xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
357 XBT_DEBUG ("Starting graph extraction.");
358 recursiveGraphExtraction (routing_platf->root, PJ_container_get_root(), filter);
359 XBT_DEBUG ("Graph extraction finished.");
360 xbt_dict_free(&filter);
361 platform_created = 1;
362 TRACE_paje_dump_buffer(1);
365 void instr_routing_define_callbacks ()
367 if (!TRACE_is_enabled()) return;
368 //always need the call backs to ASes (we need only the root AS),
369 //to create the rootContainer and the rootType properly
370 sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
371 sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
372 if (!TRACE_needs_platform()) return;
373 sg_platf_link_add_cb(instr_routing_parse_start_link);
374 sg_platf_host_add_cb(instr_routing_parse_start_host);
375 sg_platf_router_add_cb(instr_routing_parse_start_router);
377 sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
381 * user categories support
383 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
385 if (!strcmp (root->name, "HOST")){
386 char tnstr[INSTR_DEFAULT_STR_SIZE];
387 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
388 PJ_type_variable_new (tnstr, color, root);
390 if (!strcmp (root->name, "LINK")){
391 char tnstr[INSTR_DEFAULT_STR_SIZE];
392 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
393 PJ_type_variable_new (tnstr, color, root);
395 xbt_dict_cursor_t cursor = NULL;
398 xbt_dict_foreach(root->children, cursor, name, child_type) {
399 recursiveNewVariableType (new_typename, color, child_type);
403 void instr_new_variable_type (const char *new_typename, const char *color)
405 recursiveNewVariableType (new_typename, color, PJ_type_get_root());
408 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
410 if (!strcmp (root->name, father_type)){
411 PJ_type_variable_new (new_typename, color, root);
413 xbt_dict_cursor_t cursor = NULL;
416 xbt_dict_foreach(root->children, cursor, name, child_type) {
417 recursiveNewUserVariableType (father_type, new_typename, color, child_type);
421 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
423 recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
426 static void recursiveNewUserStateType (const char *father_type, const char *new_typename, type_t root)
428 if (!strcmp (root->name, father_type)){
429 PJ_type_state_new (new_typename, root);
431 xbt_dict_cursor_t cursor = NULL;
434 xbt_dict_foreach(root->children, cursor, name, child_type) {
435 recursiveNewUserStateType (father_type, new_typename, child_type);
439 void instr_new_user_state_type (const char *father_type, const char *new_typename)
441 recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
444 static void recursiveNewValueForUserStateType (const char *typename, const char *value, const char *color, type_t root)
446 if (!strcmp (root->name, typename)){
447 PJ_value_new (value, color, root);
449 xbt_dict_cursor_t cursor = NULL;
452 xbt_dict_foreach(root->children, cursor, name, child_type) {
453 recursiveNewValueForUserStateType (typename, value, color, child_type);
457 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color)
459 recursiveNewValueForUserStateType (typename, value, color, PJ_type_get_root());
462 int instr_platform_traced ()
464 return platform_created;
467 #define GRAPHICATOR_SUPPORT_FUNCTIONS
470 static xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes)
472 xbt_node_t ret = xbt_dict_get_or_null (nodes, name);
475 ret = xbt_graph_new_node (graph, xbt_strdup(name));
476 xbt_dict_set (nodes, name, ret, NULL);
480 static xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
484 const char *sn = instr_node_name (s);
485 const char *dn = instr_node_name (d);
486 int len = strlen(sn)+strlen(dn)+1;
487 char *name = (char*)malloc(len * sizeof(char));
490 snprintf (name, len, "%s%s", sn, dn);
491 ret = xbt_dict_get_or_null (edges, name);
493 snprintf (name, len, "%s%s", dn, sn);
494 ret = xbt_dict_get_or_null (edges, name);
498 ret = xbt_graph_new_edge(graph, s, d, NULL);
499 xbt_dict_set (edges, name, ret, NULL);
505 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
506 AS_t rc, container_t container)
508 if (!xbt_dict_is_empty(rc->routing_sons)){
509 xbt_dict_cursor_t cursor = NULL;
512 //bottom-up recursion
513 xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
514 container_t child_container = xbt_dict_get (container->children, rc_son->name);
515 recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
520 xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
521 container_t child1, child2;
522 const char *child1_name, *child2_name;
523 xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
524 //if child1 is not a link, a smpi node, a msg process or a msg task
525 if (child1->kind == INSTR_LINK || child1->kind == INSTR_SMPI || child1->kind == INSTR_MSG_PROCESS || child1->kind == INSTR_MSG_TASK) continue;
527 xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
528 //if child2 is not a link, a smpi node, a msg process or a msg task
529 if (child2->kind == INSTR_LINK || child2->kind == INSTR_SMPI || child2->kind == INSTR_MSG_PROCESS || child2->kind == INSTR_MSG_TASK) continue;
531 //if child1 is not child2
532 if (strcmp (child1_name, child2_name) == 0) continue;
535 sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t,1);
536 route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
537 rc->get_route_and_latency(rc, child1->net_elm, child2->net_elm,
540 //user might want to extract a graph using routes with only one link
541 //see --cfg=tracing/onelink_only:1 or --help-tracing for details
542 if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1) continue;
544 //traverse the route connecting the containers
547 xbt_node_t current, previous;
549 previous = new_xbt_graph_node(graph, route->gw_src->name, nodes);
551 previous = new_xbt_graph_node(graph, child1_name, nodes);
554 xbt_dynar_foreach (route->link_list, cpt, link) {
555 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
556 current = new_xbt_graph_node(graph, link_name, nodes);
557 new_xbt_graph_edge (graph, previous, current, edges);
558 //previous -> current
562 current = new_xbt_graph_node(graph, route->gw_dst->name, nodes);
564 current = new_xbt_graph_node(graph, child2_name, nodes);
566 new_xbt_graph_edge (graph, previous, current, edges);
567 generic_free_route(route);
573 xbt_graph_t instr_routing_platform_graph (void)
575 xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
576 xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
577 xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
578 recursiveXBTGraphExtraction (ret, nodes, edges, routing_platf->root, PJ_container_get_root());
579 xbt_dict_free (&nodes);
580 xbt_dict_free (&edges);
584 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
586 unsigned int cursor = 0;
587 xbt_node_t node = NULL;
588 xbt_edge_t edge = NULL;
591 file = fopen(filename, "w");
592 xbt_assert(file, "Failed to open %s \n", filename);
595 fprintf(file, "digraph test {\n");
597 fprintf(file, "graph test {\n");
599 fprintf(file, " graph [overlap=scale]\n");
601 fprintf(file, " node [shape=box, style=filled]\n");
603 " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
605 xbt_dynar_foreach(g->nodes, cursor, node) {
606 fprintf(file, " \"%s\";\n", instr_node_name(node));
608 xbt_dynar_foreach(g->edges, cursor, edge) {
609 const char *src_s = instr_node_name (edge->src);
610 const char *dst_s = instr_node_name (edge->dst);
612 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
614 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
616 fprintf(file, "}\n");
621 #endif /* HAVE_TRACING */