1 /* Copyright (c) 2010, 2012-2014. 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 "xbt/graph.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
15 static int platform_created = 0; /* indicate whether the platform file has been traced */
16 static xbt_dynar_t currentContainer = NULL; /* push and pop, used only in creation */
18 static const char *instr_node_name (xbt_node_t node)
20 void *data = xbt_graph_node_get_data(node);
21 char *str = (char*)data;
26 static container_t lowestCommonAncestor (container_t a1, container_t a2)
28 //this is only an optimization (since most of a1 and a2 share the same parent)
29 if (a1->father == a2->father) return a1->father;
31 //create an array with all ancestors of a1
32 xbt_dynar_t ancestors_a1 = xbt_dynar_new(sizeof(container_t), NULL);
36 xbt_dynar_push_as (ancestors_a1, container_t, p);
40 //create an array with all ancestors of a2
41 xbt_dynar_t ancestors_a2 = xbt_dynar_new(sizeof(container_t), NULL);
44 xbt_dynar_push_as (ancestors_a2, container_t, p);
48 //find the lowest ancestor
50 int i = xbt_dynar_length (ancestors_a1) - 1;
51 int j = xbt_dynar_length (ancestors_a2) - 1;
52 while (i >= 0 && j >= 0){
53 container_t a1p = *(container_t*)xbt_dynar_get_ptr (ancestors_a1, i);
54 container_t a2p = *(container_t*)xbt_dynar_get_ptr (ancestors_a2, j);
63 xbt_dynar_free (&ancestors_a1);
64 xbt_dynar_free (&ancestors_a2);
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");
83 //check if we already register this pair (we only need one direction)
84 char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
85 snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", src->name, dst->name);
86 snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", dst->name, src->name);
87 if (xbt_dict_get_or_null (filter, aux1)){
88 XBT_DEBUG (" linkContainers: already registered %s <-> %s (1)", src->name, dst->name);
91 if (xbt_dict_get_or_null (filter, aux2)){
92 XBT_DEBUG (" linkContainers: already registered %s <-> %s (2)", dst->name, src->name);
96 //ok, not found, register it
97 xbt_dict_set (filter, aux1, xbt_strdup ("1"), NULL);
98 xbt_dict_set (filter, aux2, xbt_strdup ("1"), NULL);
102 char link_typename[INSTR_DEFAULT_STR_SIZE];
103 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s%s-%s%s",
105 src->type->name, src->type->id,
106 dst->type->name, dst->type->id);
107 type_t link_type = PJ_type_get_or_null (link_typename, father->type);
108 if (link_type == NULL){
109 link_type = PJ_type_link_new (link_typename, father->type, src->type, dst->type);
112 //register EDGE types for triva configuration
113 xbt_dict_set (trivaEdgeTypes, link_type->name, xbt_strdup("1"), NULL);
116 static long long counter = 0;
118 char key[INSTR_DEFAULT_STR_SIZE];
119 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
120 new_pajeStartLink(SIMIX_get_clock(), father, link_type, src, "topology", key);
121 new_pajeEndLink(SIMIX_get_clock(), father, link_type, dst, "topology", key);
123 XBT_DEBUG (" linkContainers %s <-> %s", src->name, dst->name);
126 static void recursiveGraphExtraction (AS_t rc, container_t container, xbt_dict_t filter)
128 if (!TRACE_platform_topology()){
129 XBT_DEBUG("Graph extraction disabled by user.");
132 XBT_DEBUG ("Graph extraction for routing_component = %s", surf_AS_get_name(rc));
133 if (!xbt_dict_is_empty(surf_AS_get_routing_sons(rc))){
134 xbt_dict_cursor_t cursor = NULL;
137 //bottom-up recursion
138 xbt_dict_foreach(surf_AS_get_routing_sons(rc), cursor, child_name, rc_son) {
139 container_t child_container = xbt_dict_get (container->children, surf_AS_get_name(rc_son));
140 recursiveGraphExtraction (rc_son, child_container, filter);
145 xbt_graph_t graph = xbt_graph_new_graph (0, NULL);
146 xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
147 xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
148 xbt_edge_t edge = NULL;
150 xbt_dict_cursor_t cursor = NULL;
153 surf_AS_get_graph(rc, graph, nodes, edges);
154 xbt_dict_foreach(edges,cursor,edge_name,edge) {
155 linkContainers(PJ_container_get(edge->src->data), PJ_container_get(edge->dst->data), filter);
157 xbt_dict_free (&nodes);
158 xbt_dict_free (&edges);
159 xbt_graph_free_graph(graph,xbt_free, xbt_free, NULL);
166 static void instr_routing_parse_start_AS (sg_platf_AS_cbarg_t AS)
168 const char*id = AS->id;
170 if (PJ_container_get_root() == NULL){
171 PJ_container_alloc ();
173 container_t root = PJ_container_new (id, INSTR_AS, NULL);
174 PJ_container_set_root (root);
176 if (TRACE_smpi_is_enabled()) {
177 if (!TRACE_smpi_is_grouped()){
178 type_t mpi = PJ_type_get_or_null ("MPI", root->type);
180 mpi = PJ_type_container_new("MPI", root->type);
181 PJ_type_state_new ("MPI_STATE", mpi);
182 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
187 if (TRACE_needs_platform()){
188 currentContainer = xbt_dynar_new (sizeof(container_t), NULL);
189 xbt_dynar_push (currentContainer, &root);
194 if (TRACE_needs_platform()){
195 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
196 container_t new = PJ_container_new (id, INSTR_AS, father);
197 xbt_dynar_push (currentContainer, &new);
201 static void instr_routing_parse_end_AS ()
203 if (TRACE_needs_platform()){
204 xbt_dynar_pop_ptr (currentContainer);
208 static void instr_routing_parse_start_link (sg_platf_link_cbarg_t link)
210 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
212 double bandwidth_value = link->bandwidth;
213 double latency_value = link->latency;
214 xbt_dynar_t links_to_create = xbt_dynar_new (sizeof(char*), &xbt_free_ref);
216 if (link->policy == SURF_LINK_FULLDUPLEX){
217 char *up = bprintf("%s_UP", link->id);
218 char *down = bprintf("%s_DOWN", link->id);
219 xbt_dynar_push_as (links_to_create, char*, xbt_strdup(up));
220 xbt_dynar_push_as (links_to_create, char*, xbt_strdup(down));
224 xbt_dynar_push_as (links_to_create, char*, strdup(link->id));
227 char *link_name = NULL;
229 xbt_dynar_foreach (links_to_create, i, link_name){
231 container_t new = PJ_container_new (link_name, INSTR_LINK, father);
233 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (! TRACE_disable_link())) {
234 type_t bandwidth = PJ_type_get_or_null ("bandwidth", new->type);
235 if (bandwidth == NULL){
236 bandwidth = PJ_type_variable_new ("bandwidth", NULL, new->type);
238 type_t latency = PJ_type_get_or_null ("latency", new->type);
239 if (latency == NULL){
240 latency = PJ_type_variable_new ("latency", NULL, new->type);
242 new_pajeSetVariable (0, new, bandwidth, bandwidth_value);
243 new_pajeSetVariable (0, new, latency, latency_value);
245 if (TRACE_uncategorized()){
246 type_t bandwidth_used = PJ_type_get_or_null ("bandwidth_used", new->type);
247 if (bandwidth_used == NULL){
248 bandwidth_used = PJ_type_variable_new ("bandwidth_used", "0.5 0.5 0.5", new->type);
253 xbt_dynar_free (&links_to_create);
256 static void instr_routing_parse_start_host (sg_platf_host_cbarg_t host)
258 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
259 container_t new = PJ_container_new (host->id, INSTR_HOST, father);
261 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (! TRACE_disable_power())) {
262 type_t power = PJ_type_get_or_null ("power", new->type);
264 power = PJ_type_variable_new ("power", NULL, new->type);
267 double current_power_state;
268 xbt_dynar_get_cpy(host->power_peak, host->pstate, ¤t_power_state);
269 new_pajeSetVariable (0, new, power, current_power_state);
271 if (TRACE_uncategorized()){
272 type_t power_used = PJ_type_get_or_null ("power_used", new->type);
273 if (power_used == NULL){
274 power_used = PJ_type_variable_new ("power_used", "0.5 0.5 0.5", new->type);
278 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()){
279 type_t mpi = PJ_type_get_or_null ("MPI", new->type);
281 mpi = PJ_type_container_new("MPI", new->type);
282 PJ_type_state_new ("MPI_STATE", mpi);
283 PJ_type_link_new ("MPI_LINK", PJ_type_get_root(), mpi, mpi);
287 if (TRACE_msg_process_is_enabled()) {
288 type_t msg_process = PJ_type_get_or_null ("MSG_PROCESS", new->type);
289 if (msg_process == NULL){
290 msg_process = PJ_type_container_new("MSG_PROCESS", new->type);
291 type_t state = PJ_type_state_new ("MSG_PROCESS_STATE", msg_process);
292 PJ_value_new ("suspend", "1 0 1", state);
293 PJ_value_new ("sleep", "1 1 0", state);
294 PJ_value_new ("receive", "1 0 0", state);
295 PJ_value_new ("send", "0 0 1", state);
296 PJ_value_new ("task_execute", "0 1 1", state);
297 PJ_type_link_new ("MSG_PROCESS_LINK", PJ_type_get_root(), msg_process, msg_process);
298 PJ_type_link_new ("MSG_PROCESS_TASK_LINK", PJ_type_get_root(), msg_process, msg_process);
302 if (TRACE_msg_vm_is_enabled()) {
303 type_t msg_vm = PJ_type_get_or_null ("MSG_VM", new->type);
305 msg_vm = PJ_type_container_new("MSG_VM", new->type);
306 type_t state = PJ_type_state_new ("MSG_VM_STATE", msg_vm);
307 PJ_value_new ("suspend", "1 0 1", state);
308 PJ_value_new ("sleep", "1 1 0", state);
309 PJ_value_new ("receive", "1 0 0", state);
310 PJ_value_new ("send", "0 0 1", state);
311 PJ_value_new ("task_execute", "0 1 1", state);
312 PJ_type_link_new ("MSG_VM_LINK", PJ_type_get_root(), msg_vm, msg_vm);
313 PJ_type_link_new ("MSG_VM_PROCESS_LINK", PJ_type_get_root(), msg_vm, msg_vm);
319 static void instr_routing_parse_start_router (sg_platf_router_cbarg_t router)
321 container_t father = *(container_t*)xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
322 PJ_container_new (router->id, INSTR_ROUTER, father);
325 static void instr_routing_parse_end_platform ()
327 xbt_dynar_free(¤tContainer);
328 currentContainer = NULL;
329 xbt_dict_t filter = xbt_dict_new_homogeneous(xbt_free);
330 XBT_DEBUG ("Starting graph extraction.");
331 recursiveGraphExtraction (surf_platf_get_root(routing_platf), PJ_container_get_root(), filter);
332 XBT_DEBUG ("Graph extraction finished.");
333 xbt_dict_free(&filter);
334 platform_created = 1;
335 TRACE_paje_dump_buffer(1);
338 void instr_routing_define_callbacks ()
340 if (!TRACE_is_enabled()) return;
341 //always need the call backs to ASes (we need only the root AS),
342 //to create the rootContainer and the rootType properly
343 sg_platf_AS_begin_add_cb(instr_routing_parse_start_AS);
344 sg_platf_AS_end_add_cb(instr_routing_parse_end_AS);
345 if (!TRACE_needs_platform()) return;
346 sg_platf_link_add_cb(instr_routing_parse_start_link);
347 sg_platf_host_add_cb(instr_routing_parse_start_host);
348 sg_platf_router_add_cb(instr_routing_parse_start_router);
350 sg_platf_postparse_add_cb(instr_routing_parse_end_platform);
354 * user categories support
356 static void recursiveNewVariableType (const char *new_typename, const char *color, type_t root)
358 if (!strcmp (root->name, "HOST")){
359 char tnstr[INSTR_DEFAULT_STR_SIZE];
360 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
361 PJ_type_variable_new (tnstr, color, root);
363 if (!strcmp (root->name, "MSG_VM")){
364 char tnstr[INSTR_DEFAULT_STR_SIZE];
365 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "p%s", new_typename);
366 PJ_type_variable_new (tnstr, color, root);
368 if (!strcmp (root->name, "LINK")){
369 char tnstr[INSTR_DEFAULT_STR_SIZE];
370 snprintf (tnstr, INSTR_DEFAULT_STR_SIZE, "b%s", new_typename);
371 PJ_type_variable_new (tnstr, color, root);
373 xbt_dict_cursor_t cursor = NULL;
376 xbt_dict_foreach(root->children, cursor, name, child_type) {
377 recursiveNewVariableType (new_typename, color, child_type);
381 void instr_new_variable_type (const char *new_typename, const char *color)
383 recursiveNewVariableType (new_typename, color, PJ_type_get_root());
386 static void recursiveNewUserVariableType (const char *father_type, const char *new_typename, const char *color, type_t root)
388 if (!strcmp (root->name, father_type)){
389 PJ_type_variable_new (new_typename, color, root);
391 xbt_dict_cursor_t cursor = NULL;
394 xbt_dict_foreach(root->children, cursor, name, child_type) {
395 recursiveNewUserVariableType (father_type, new_typename, color, child_type);
399 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
401 recursiveNewUserVariableType (father_type, new_typename, color, PJ_type_get_root());
404 static void recursiveNewUserStateType (const char *father_type, const char *new_typename, type_t root)
406 if (!strcmp (root->name, father_type)){
407 PJ_type_state_new (new_typename, root);
409 xbt_dict_cursor_t cursor = NULL;
412 xbt_dict_foreach(root->children, cursor, name, child_type) {
413 recursiveNewUserStateType (father_type, new_typename, child_type);
417 void instr_new_user_state_type (const char *father_type, const char *new_typename)
419 recursiveNewUserStateType (father_type, new_typename, PJ_type_get_root());
422 static void recursiveNewValueForUserStateType (const char *typename, const char *value, const char *color, type_t root)
424 if (!strcmp (root->name, typename)){
425 PJ_value_new (value, color, root);
427 xbt_dict_cursor_t cursor = NULL;
430 xbt_dict_foreach(root->children, cursor, name, child_type) {
431 recursiveNewValueForUserStateType (typename, value, color, child_type);
435 void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color)
437 recursiveNewValueForUserStateType (typename, value, color, PJ_type_get_root());
440 int instr_platform_traced ()
442 return platform_created;
445 #define GRAPHICATOR_SUPPORT_FUNCTIONS
448 static void recursiveXBTGraphExtraction (xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
449 AS_t rc, container_t container)
451 if (!xbt_dict_is_empty(surf_AS_get_routing_sons(rc))){
452 xbt_dict_cursor_t cursor = NULL;
455 //bottom-up recursion
456 xbt_dict_foreach(surf_AS_get_routing_sons(rc), cursor, child_name, rc_son) {
457 container_t child_container = xbt_dict_get (container->children, surf_AS_get_name(rc_son));
458 recursiveXBTGraphExtraction (graph, nodes, edges, rc_son, child_container);
462 surf_AS_get_graph(rc, graph, nodes, edges);
465 xbt_graph_t instr_routing_platform_graph (void)
467 xbt_graph_t ret = xbt_graph_new_graph (0, NULL);
468 xbt_dict_t nodes = xbt_dict_new_homogeneous(NULL);
469 xbt_dict_t edges = xbt_dict_new_homogeneous(NULL);
470 recursiveXBTGraphExtraction (ret, nodes, edges, surf_platf_get_root(routing_platf), PJ_container_get_root());
471 xbt_dict_free (&nodes);
472 xbt_dict_free (&edges);
476 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
478 unsigned int cursor = 0;
479 xbt_node_t node = NULL;
480 xbt_edge_t edge = NULL;
483 file = fopen(filename, "w");
484 xbt_assert(file, "Failed to open %s \n", filename);
487 fprintf(file, "digraph test {\n");
489 fprintf(file, "graph test {\n");
491 fprintf(file, " graph [overlap=scale]\n");
493 fprintf(file, " node [shape=box, style=filled]\n");
495 " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
497 xbt_dynar_foreach(g->nodes, cursor, node) {
498 fprintf(file, " \"%s\";\n", instr_node_name(node));
500 xbt_dynar_foreach(g->edges, cursor, edge) {
501 const char *src_s = instr_node_name (edge->src);
502 const char *dst_s = instr_node_name (edge->dst);
504 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
506 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
508 fprintf(file, "}\n");
513 #endif /* HAVE_TRACING */