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)
78 container_t father = lowestCommonAncestor (src, dst);
80 xbt_die ("common father unknown, this is a tracing problem");
84 //check if we already register this pair (we only need one direction)
85 char aux1[INSTR_DEFAULT_STR_SIZE], 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)) return;
89 if (xbt_dict_get_or_null (filter, aux2)) return;
91 //ok, not found, register it
92 xbt_dict_set (filter, aux1, xbt_strdup ("1"), NULL);
93 xbt_dict_set (filter, aux2, xbt_strdup ("1"), NULL);
97 char link_typename[INSTR_DEFAULT_STR_SIZE];
98 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
100 src->type->name, src->type->id,
101 dst->type->name, dst->type->id);
102 type_t link_type = PJ_type_get_or_null (link_typename, father->type);
103 if (link_type == NULL){
104 link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
107 //register EDGE types for triva configuration
108 xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), NULL);
111 static long long counter = 0;
112 char key[INSTR_DEFAULT_STR_SIZE];
113 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
114 new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "G", key);
115 new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "G", key);
118 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
120 if (!xbt_dict_is_empty(rc->routing_sons)){
121 xbt_dict_cursor_t cursor = NULL;
124 //bottom-up recursion
125 xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
126 container_t child_container = xbt_dict_get (container->children, rc_son->name);
127 recursiveGraphExtraction (rc_son, child_container, filter);
132 xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
133 container_t child1, child2;
134 const char *child1_name, *child2_name;
135 xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
136 //if child1 is not a link, a smpi node, a msg process or a msg task
137 if (child1->kind == INSTR_LINK || child1->kind == INSTR_SMPI || child1->kind == INSTR_MSG_PROCESS || child1->kind == INSTR_MSG_TASK) continue;
139 xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
140 //if child2 is not a link, a smpi node, a msg process or a msg task
141 if (child2->kind == INSTR_LINK || child2->kind == INSTR_SMPI || child2->kind == INSTR_MSG_PROCESS || child2->kind == INSTR_MSG_TASK) continue;
143 //if child1 is not child2
144 if (strcmp (child1_name, child2_name) == 0) continue;
147 route_t route = xbt_new0(s_route_t,1);
148 route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
149 rc->get_route_and_latency (rc,
150 (network_element_t)(child1->net_elm),
151 (network_element_t)(child2->net_elm),route, NULL);
153 //user might want to extract a graph using routes with only one link
154 //see --cfg=tracing/onelink_only:1 or --help-tracing for details
155 if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1) continue;
157 //traverse the route connecting the containers
160 container_t current, previous;
161 if (route->src_gateway){
162 previous = PJ_container_get(route->src_gateway->name);
167 xbt_dynar_foreach (route->link_list, cpt, link) {
168 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
169 current = PJ_container_get(link_name);
170 linkContainers(previous, current, filter);
173 if (route->dst_gateway){
174 current = PJ_container_get(route->dst_gateway->name);
178 linkContainers(previous, current, filter);
179 generic_free_route(route);
187 static void instr_routing_parse_start_AS (const char*id,const char*routing)
189 if (PJ_container_get_root() == NULL){
190 PJ_container_alloc ();
192 container_t root = PJ_container_new (id, INSTR_AS, NULL);
193 PJ_container_set_root (root);
195 if (TRACE_smpi_is_enabled()) {
196 if (!TRACE_smpi_is_grouped()){
197 type_t mpi = PJ_type_get_or_null ("MPI", root->type);
199 mpi = PJ_type_container_new("MPI", root->type);
200 PJ_type_state_new ("MPI_STATE", mpi);
201 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
206 if (TRACE_needs_platform()){
207 currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
208 xbt_dynar_push (currentContainer, &root);
213 if (TRACE_needs_platform()){
214 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
215 container_t new = PJ_container_new (id, INSTR_AS, father);
216 xbt_dynar_push (currentContainer, &new);
220 static void instr_routing_parse_end_AS ()
222 if (TRACE_needs_platform()){
223 xbt_dynar_pop_ptr (currentContainer);
227 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
229 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
231 double bandwidth_value = link->bandwidth;
232 double latency_value = link->latency;
233 xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
235 if (link->policy == SURF_LINK_FULLDUPLEX){
236 char *up = bprintf("%s_UP", link->id);
237 char *down = bprintf("%s_DOWN", link->id);
238 xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
239 xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
243 xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
246 char *link_name = NULL;
248 xbt_dynar_foreach (links_to_create, i, link_name){
250 container_t new = PJ_container_new (link_name, INSTR_LINK, father);
252 if (TRACE_categorized() || TRACE_uncategorized()){
253 type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
254 if (bandwidth == NULL){
255 bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
257 type_t latency = PJ_type_get_or_null ("latency", new->type);
258 if (latency == NULL){
259 latency = PJ_type_variable_new ("latency", NULL, new->type);
261 new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
262 new_pajeSetVariable (0, new, latency, latency_value);
264 if (TRACE_uncategorized()){
265 type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
266 if (bandwidth_used == NULL){
267 bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
272 xbt_dynar_free (&links_to_create);
275 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
277 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
278 container_t new = PJ_container_new (host->id, INSTR_HOST, father);
280 if (TRACE_categorized() || TRACE_uncategorized()) {
281 type_t power = PJ_type_get_or_null ("power", new->type);
283 power = PJ_type_variable_new ("power", NULL, new->type);
285 new_pajeSetVariable (0, new, power, host->power_peak);
287 if (TRACE_uncategorized()){
288 type_t power_used = PJ_type_get_or_null ("power_used", new->type);
289 if (power_used == NULL){
290 power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
294 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
295 type_t mpi = PJ_type_get_or_null ("MPI", new->type);
297 mpi = PJ_type_container_new("MPI", new->type);
298 PJ_type_state_new ("MPI_STATE", mpi);
299 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
303 if (TRACE_msg_process_is_enabled()) {
304 type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
305 if (msg_process == NULL){
306 msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
307 type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
308 PJ_value_new ("executing", "0 1 0", state);
309 PJ_value_new ("suspend", "1 0 1", state);
310 PJ_value_new ("sleep", "1 1 0", state);
311 PJ_value_new ("receive", "1 0 0", state);
312 PJ_value_new ("send", "0 0 1", state);
313 PJ_value_new ("task_execute", "0 1 1", state);
314 PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
315 PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
320 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
322 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
323 PJ_container_new (router->id, INSTR_ROUTER, father);
326 static void instr_routing_parse_end_platform ()
328 xbt_dynar_free(¤tContainer);
329 currentContainer = NULL;
330 xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
331 recursiveGraphExtraction (global_routing->root, PJ_container_get_root(), filter);
332 xbt_dict_free(&filter);
333 platform_created = 1;
334 TRACE_paje_dump_buffer(1);
337 void instr_routing_define_callbacks ()
339 if (!TRACE_is_enabled()) return;
340 //always need the call backs to ASes (we need only the root AS),
341 //to create the rootContainer and the rootType properly
342 sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
343 sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
344 if (!TRACE_needs_platform()) return;
345 sg_platf_link_add_cb(instr_routing_parse_start_link);
346 sg_platf_host_add_cb(instr_routing_parse_start_host);
347 sg_platf_router_add_cb(instr_routing_parse_start_router);
349 sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
353 * user categories support
355 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
357 if (!strcmp (root->name, "HOST")){
358 char tnstr[INSTR_DEFAULT_STR_SIZE];
359 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
360 PJ_type_variable_new (tnstr, color, root);
362 if (!strcmp (root->name, "LINK")){
363 char tnstr[INSTR_DEFAULT_STR_SIZE];
364 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
365 PJ_type_variable_new (tnstr, color, root);
367 xbt_dict_cursor_t cursor = NULL;
370 xbt_dict_foreach(root->children, cursor, name, child_type) {
371 recursiveNewVariableType (new_typename, color, child_type);
375 void instr_new_variable_type (const char *new_typename, const char *color)
377 recursiveNewVariableType (new_typename, color, PJ_type_get_root());
380 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
382 if (!strcmp (root->name, father_type)){
383 PJ_type_variable_new (new_typename, color, root);
385 xbt_dict_cursor_t cursor = NULL;
388 xbt_dict_foreach(root->children, cursor, name, child_type) {
389 recursiveNewUserVariableType (father_type, new_typename, color, child_type);
393 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
395 recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
400 int instr_platform_traced ()
402 return platform_created;
405 #define GRAPHICATOR_SUPPORT_FUNCTIONS
408 static xbt_node_t new_xbt_graph_node (xbt_graph_t graph, const char *name, xbt_dict_t nodes)
410 xbt_node_t ret = xbt_dict_get_or_null (nodes, name);
413 ret = xbt_graph_new_node (graph, xbt_strdup(name));
414 xbt_dict_set (nodes, name, ret, NULL);
418 static xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
422 const char *sn = instr_node_name (s);
423 const char *dn = instr_node_name (d);
424 int len = strlen(sn)+strlen(dn)+1;
425 char *name = (char*)malloc(len * sizeof(char));
428 snprintf (name, len, "%s%s", sn, dn);
429 ret = xbt_dict_get_or_null (edges, name);
431 snprintf (name, len, "%s%s", dn, sn);
432 ret = xbt_dict_get_or_null (edges, name);
436 ret = xbt_graph_new_edge(graph, s, d, NULL);
437 xbt_dict_set (edges, name, ret, NULL);
443 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
444 AS_t rc, container_t container)
446 if (!xbt_dict_is_empty(rc->routing_sons)){
447 xbt_dict_cursor_t cursor = NULL;
450 //bottom-up recursion
451 xbt_dict_foreach(rc->routing_sons, cursor, child_name, rc_son) {
452 container_t child_container = xbt_dict_get (container->children, rc_son->name);
453 recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
458 xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
459 container_t child1, child2;
460 const char *child1_name, *child2_name;
461 xbt_dict_foreach(container->children, cursor1, child1_name, child1) {
462 //if child1 is not a link, a smpi node, a msg process or a msg task
463 if (child1->kind == INSTR_LINK || child1->kind == INSTR_SMPI || child1->kind == INSTR_MSG_PROCESS || child1->kind == INSTR_MSG_TASK) continue;
465 xbt_dict_foreach(container->children, cursor2, child2_name, child2) {
466 //if child2 is not a link, a smpi node, a msg process or a msg task
467 if (child2->kind == INSTR_LINK || child2->kind == INSTR_SMPI || child2->kind == INSTR_MSG_PROCESS || child2->kind == INSTR_MSG_TASK) continue;
469 //if child1 is not child2
470 if (strcmp (child1_name, child2_name) == 0) continue;
473 route_t route = xbt_new0(s_route_t,1);
474 route->link_list = xbt_dynar_new(global_routing->size_of_link,NULL);
475 rc->get_route_and_latency (rc,
476 (network_element_t)(child1->net_elm),
477 (network_element_t)(child2->net_elm),route, NULL);
479 //user might want to extract a graph using routes with only one link
480 //see --cfg=tracing/onelink_only:1 or --help-tracing for details
481 if (TRACE_onelink_only() && xbt_dynar_length (route->link_list) > 1) continue;
483 //traverse the route connecting the containers
486 xbt_node_t current, previous;
487 if (route->src_gateway){
488 previous = new_xbt_graph_node(graph, route->src_gateway->name, nodes);
490 previous = new_xbt_graph_node(graph, child1_name, nodes);
493 xbt_dynar_foreach (route->link_list, cpt, link) {
494 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
495 current = new_xbt_graph_node(graph, link_name, nodes);
496 new_xbt_graph_edge (graph, previous, current, edges);
497 //previous -> current
500 if (route->dst_gateway){
501 current = new_xbt_graph_node(graph, route->dst_gateway->name, nodes);
503 current = new_xbt_graph_node(graph, child2_name, nodes);
505 new_xbt_graph_edge (graph, previous, current, edges);
506 generic_free_route(route);
512 xbt_graph_t instr_routing_platform_graph (void)
514 xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
515 xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
516 xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
517 recursiveXBTGraphExtraction (ret, nodes, edges, global_routing->root, PJ_container_get_root());
518 xbt_dict_free (&nodes);
519 xbt_dict_free (&edges);
523 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
525 unsigned int cursor = 0;
526 xbt_node_t node = NULL;
527 xbt_edge_t edge = NULL;
530 file = fopen(filename, "w");
531 xbt_assert(file, "Failed to open %s \n", filename);
534 fprintf(file, "digraph test {\n");
536 fprintf(file, "graph test {\n");
538 fprintf(file, " graph [overlap=scale]\n");
540 fprintf(file, " node [shape=box, style=filled]\n");
542 " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
544 xbt_dynar_foreach(g->nodes, cursor, node) {
545 fprintf(file, " \"%s\";\n", instr_node_name(node));
547 xbt_dynar_foreach(g->edges, cursor, edge) {
548 const char *src_s = instr_node_name (edge->src);
549 const char *dst_s = instr_node_name (edge->dst);
551 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
553 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
555 fprintf(file, "}\n");
560 #endif /* HAVE_TRACING */