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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
15 extern xbt_dict_t defined_types; /* from instr_interface.c */
17 static int platform_created = 0; /* indicate whether the platform file has been traced */
18 static type_t rootType = NULL; /* the root type */
19 static container_t rootContainer = NULL; /* the root container */
20 static xbt_dynar_t currentContainer = NULL; /* push and pop, used only in creation */
21 static xbt_dict_t allContainers = NULL; /* all created containers indexed by name */
22 xbt_dynar_t allLinkTypes = NULL; /* all link types defined */
23 xbt_dynar_t allHostTypes = NULL; /* all host types defined */
25 static void instr_routing_parse_start_AS (void);
26 static void instr_routing_parse_end_AS (void);
27 static void instr_routing_parse_start_link (void);
28 static void instr_routing_parse_end_link (void);
29 static void instr_routing_parse_start_host (void);
30 static void instr_routing_parse_end_host (void);
31 static void instr_routing_parse_start_router (void);
32 static void instr_routing_parse_end_router (void);
33 static void instr_routing_parse_end_platform (void);
35 static long long int newTypeId ()
37 static long long int counter = 0;
41 static type_t newType (const char *typename, e_entity_types kind, type_t father)
43 type_t ret = xbt_new0(s_type_t, 1);
44 ret->name = xbt_strdup (typename);
47 ret->children = xbt_dict_new ();
49 long long int id = newTypeId();
50 char str_id[INSTR_DEFAULT_STR_SIZE];
51 snprintf (str_id, INSTR_DEFAULT_STR_SIZE, "%lld", id);
52 ret->id = xbt_strdup (str_id);
55 xbt_dict_set (father->children, typename, ret, NULL);
60 type_t newContainerType (const char *typename, e_entity_types kind, type_t father)
62 type_t ret = newType (typename, kind, father);
63 // if (father) INFO4("ContainerType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
64 if (father) pajeDefineContainerType(ret->id, ret->father->id, ret->name);
68 type_t newEventType (const char *typename, e_entity_types kind, const char *color, type_t father)
70 type_t ret = newType (typename, kind, father);
71 // INFO4("EventType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
73 pajeDefineEventTypeWithColor (ret->id, ret->father->id, ret->name, color);
75 pajeDefineEventType(ret->id, ret->father->id, ret->name);
80 type_t newVariableType (const char *typename, e_entity_types kind, const char *color, type_t father)
82 type_t ret = newType (typename, kind, father);
83 // INFO4("VariableType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
85 pajeDefineVariableTypeWithColor(ret->id, ret->father->id, ret->name, color);
87 pajeDefineVariableType(ret->id, ret->father->id, ret->name);
92 type_t newLinkType (const char *typename, e_entity_types kind, type_t father, type_t source, type_t dest)
94 type_t ret = newType (typename, kind, father);
95 // INFO8("LinkType %s(%s), child of %s(%s) %s(%s)->%s(%s)", ret->name, ret->id, father->name, father->id, source->name, source->id, dest->name, dest->id);
96 pajeDefineLinkType(ret->id, ret->father->id, source->id, dest->id, ret->name);
100 type_t newStateType (const char *typename, e_entity_types kind, type_t father)
102 type_t ret = newType (typename, kind, father);
103 // INFO4("StateType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
104 pajeDefineStateType(ret->id, ret->father->id, ret->name);
108 static type_t getContainerType (const char *typename, type_t father)
112 ret = newContainerType (typename, TYPE_CONTAINER, father);
115 //check if my father type already has my typename
116 ret = (type_t)xbt_dict_get_or_null (father->children, typename);
118 ret = newContainerType (typename, TYPE_CONTAINER, father);
124 static type_t getEventType (const char *typename, const char *color, type_t father)
126 type_t ret = xbt_dict_get_or_null (father->children, typename);
128 ret = newEventType (typename, TYPE_EVENT, color, father);
133 static type_t getVariableType (const char *typename, const char *color, type_t father)
135 type_t ret = xbt_dict_get_or_null (father->children, typename);
137 ret = newVariableType (typename, TYPE_VARIABLE, color, father);
142 static type_t getLinkType (const char *typename, type_t father, type_t source, type_t dest)
144 type_t ret = xbt_dict_get_or_null (father->children, typename);
146 ret = newLinkType (typename, TYPE_LINK, father, source, dest);
151 static type_t getStateType (const char *typename, type_t father)
153 type_t ret = xbt_dict_get_or_null (father->children, typename);
155 ret = newStateType (typename, TYPE_STATE, father);
160 void instr_routing_define_callbacks ()
162 if (!TRACE_is_active())
164 surfxml_add_callback(STag_surfxml_AS_cb_list, &instr_routing_parse_start_AS);
165 surfxml_add_callback(ETag_surfxml_AS_cb_list, &instr_routing_parse_end_AS);
166 surfxml_add_callback(STag_surfxml_link_cb_list, &instr_routing_parse_start_link);
167 surfxml_add_callback(ETag_surfxml_link_cb_list, &instr_routing_parse_end_link);
168 surfxml_add_callback(STag_surfxml_host_cb_list, &instr_routing_parse_start_host);
169 surfxml_add_callback(ETag_surfxml_host_cb_list, &instr_routing_parse_end_host);
170 surfxml_add_callback(STag_surfxml_router_cb_list, &instr_routing_parse_start_router);
171 surfxml_add_callback(ETag_surfxml_router_cb_list, &instr_routing_parse_end_router);
172 surfxml_add_callback(ETag_surfxml_platform_cb_list, &instr_routing_parse_end_platform);
175 static long long int newContainedId ()
177 static long long counter = 0;
181 container_t newContainer (const char *name, e_container_types kind, container_t father)
183 long long int counter = newContainedId();
184 char id_str[INSTR_DEFAULT_STR_SIZE];
185 snprintf (id_str, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
187 container_t new = xbt_new0(s_container_t, 1);
188 new->name = xbt_strdup (name); // name of the container
189 new->id = xbt_strdup (id_str); // id (or alias) of the container
190 new->father = father;
191 // level depends on level of father
193 new->level = new->father->level+1;
197 // type definition (method depends on kind of this new container)
199 if (new->kind == INSTR_AS){
200 //if this container is of an AS, its type name depends on its level
201 char as_typename[INSTR_DEFAULT_STR_SIZE];
202 snprintf (as_typename, INSTR_DEFAULT_STR_SIZE, "L%d", new->level);
204 new->type = getContainerType (as_typename, new->father->type);
206 new->type = getContainerType ("0", NULL);
209 //otherwise, the name is its kind
211 case INSTR_HOST: new->type = getContainerType ("HOST", new->father->type); break;
212 case INSTR_LINK: new->type = getContainerType ("LINK", new->father->type); break;
213 case INSTR_ROUTER: new->type = getContainerType ("ROUTER", new->father->type); break;
214 case INSTR_SMPI: new->type = getContainerType ("MPI", new->father->type); break;
215 default: xbt_die ("Congratulations, you have found a bug on newContainer function of instr_routing.c"); break;
218 new->children = xbt_dict_new();
220 xbt_dict_set(new->father->children, new->name, new, NULL);
221 pajeCreateContainer (SIMIX_get_clock(), new->id, new->type->id, new->father->id, new->name);
224 //register hosts, routers, links containers
225 if (new->kind == INSTR_HOST || new->kind == INSTR_LINK || new->kind == INSTR_ROUTER) {
226 xbt_dict_set (allContainers, new->name, new, NULL);
229 //register the host container types
230 if (new->kind == INSTR_HOST){
231 xbt_dynar_push_as (allHostTypes, type_t, new->type);
234 //register the link container types
235 if (new->kind == INSTR_LINK){
236 xbt_dynar_push_as(allLinkTypes, type_t, new->type);
241 static container_t recursiveGetContainer (const char *name, container_t root)
243 if (strcmp (root->name, name) == 0) return root;
245 xbt_dict_cursor_t cursor = NULL;
248 xbt_dict_foreach(root->children, cursor, child_name, child) {
249 container_t ret = recursiveGetContainer(name, child);
255 container_t getContainer (const char *name)
257 return recursiveGetContainer(name, rootContainer);
260 static type_t recursiveGetType (const char *name, type_t root)
262 if (strcmp (root->name, name) == 0) return root;
264 xbt_dict_cursor_t cursor = NULL;
267 xbt_dict_foreach(root->children, cursor, child_name, child) {
268 type_t ret = recursiveGetType(name, child);
274 type_t getType (const char *name)
276 return recursiveGetType (name, rootType);
279 void destroyContainer (container_t container)
281 //remove me from my father
282 if (container->father){
283 xbt_dict_remove(container->father->children, container->name);
286 //trace my destruction
287 pajeDestroyContainer(SIMIX_get_clock(), container->type->id, container->id);
290 xbt_free (container->name);
291 xbt_free (container->id);
292 xbt_free (container->children);
293 xbt_free (container);
297 static container_t findChild (container_t root, container_t a1)
299 if (root == a1) return root;
301 xbt_dict_cursor_t cursor = NULL;
304 xbt_dict_foreach(root->children, cursor, child_name, child) {
305 if (findChild (child, a1)) return child;
310 static container_t findCommonFather (container_t root, container_t a1, container_t a2)
312 if (a1->father == a2->father) return a1->father;
314 xbt_dict_cursor_t cursor = NULL;
317 container_t a1_try = NULL;
318 container_t a2_try = NULL;
319 xbt_dict_foreach(root->children, cursor, child_name, child) {
320 a1_try = findChild (child, a1);
321 a2_try = findChild (child, a2);
322 if (a1_try && a2_try) return child;
327 static void linkContainers (const char *a1, const char *a2)
330 if (strcmp (a1, "__loopback__") == 0 || strcmp (a2, "__loopback__") == 0)
333 container_t a1_container = ((container_t)xbt_dict_get (allContainers, a1));
334 type_t a1_type = a1_container->type;
336 container_t a2_container = ((container_t)xbt_dict_get (allContainers, a2));
337 type_t a2_type = a2_container->type;
339 container_t container = findCommonFather (rootContainer, a1_container, a2_container);
340 xbt_assert0 (container != NULL, "common father not found");
343 char link_typename[INSTR_DEFAULT_STR_SIZE];
344 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s", a1_type->name, a2_type->name);
345 type_t link_type = getLinkType (link_typename, container->type, a1_type, a2_type);
348 static long long counter = 0;
349 char key[INSTR_DEFAULT_STR_SIZE];
350 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
351 pajeStartLink(SIMIX_get_clock(), link_type->id, container->id, "G", a1_container->id, key);
352 pajeEndLink(SIMIX_get_clock(), link_type->id, container->id, "G", a2_container->id, key);
355 static void recursiveGraphExtraction (container_t container)
357 if (xbt_dict_length(container->children)){
358 xbt_dict_cursor_t cursor = NULL;
361 //bottom-up recursion
362 xbt_dict_foreach(container->children, cursor, child_name, child) {
363 recursiveGraphExtraction (child);
367 xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
368 container_t child1, child2;
369 const char *child_name1, *child_name2;
371 xbt_dict_t filter = xbt_dict_new ();
373 xbt_dict_foreach(container->children, cursor1, child_name1, child1) {
374 xbt_dict_foreach(container->children, cursor2, child_name2, child2) {
375 //check if we already register this pair (we only need one direction)
376 char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
377 snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", child_name1, child_name2);
378 snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", child_name2, child_name1);
379 if (xbt_dict_get_or_null (filter, aux1)) continue;
380 if (xbt_dict_get_or_null (filter, aux2)) continue;
382 //ok, not found, register it
383 xbt_dict_set (filter, aux1, xbt_strdup ("1"), xbt_free);
384 xbt_dict_set (filter, aux2, xbt_strdup ("1"), xbt_free);
386 if ((child1->kind == INSTR_HOST || child1->kind == INSTR_ROUTER) &&
387 (child2->kind == INSTR_HOST || child2->kind == INSTR_ROUTER)){
393 route = global_routing->get_route (child_name1, child_name2);
395 //no route between them, that's possible
399 //link the route members
402 char *previous_entity_name = (char*)child_name1;
403 xbt_dynar_foreach (route, cpt, link) {
404 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
405 linkContainers (previous_entity_name, link_name);
406 previous_entity_name = link_name;
408 linkContainers (previous_entity_name, child_name2);
409 }else if (child1->kind == INSTR_AS &&
410 child2->kind == INSTR_AS &&
411 strcmp(child_name1, child_name2) != 0){
414 routing_component_t root = global_routing->root;
415 route_extended_t route;
418 route = root->get_route (root, child_name1, child_name2);
420 //no route between them, that's possible
423 xbt_assert2(route!=NULL,
424 "there is no ASroute between %s and %s", child_name1, child_name2);
427 char *previous_entity_name = route->src_gateway;
428 xbt_dynar_foreach (route->generic_route.link_list, cpt, link) {
429 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
430 linkContainers (previous_entity_name, link_name);
431 previous_entity_name = link_name;
433 linkContainers (previous_entity_name, route->dst_gateway);
437 xbt_dict_free(&filter);
444 static void instr_routing_parse_start_AS ()
446 if (rootContainer == NULL){
447 currentContainer = xbt_dynar_new (sizeof(s_container_t), NULL);
448 allContainers = xbt_dict_new ();
449 allLinkTypes = xbt_dynar_new (sizeof(s_type_t), NULL);
450 allHostTypes = xbt_dynar_new (sizeof(s_type_t), NULL);
452 rootContainer = newContainer ("0", INSTR_AS, NULL);
453 xbt_dynar_push (currentContainer, rootContainer);
455 if (TRACE_smpi_is_enabled()) {
456 if (!TRACE_smpi_is_grouped()){
457 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
458 type_t mpi = getContainerType("MPI", father->type);
459 getStateType ("MPI_STATE", mpi);
460 getLinkType ("MPI_LINK", rootType, mpi, mpi);
464 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
465 container_t new = newContainer (A_surfxml_AS_id, INSTR_AS, father);
468 xbt_dynar_push (currentContainer, new);
471 static void instr_routing_parse_end_AS ()
473 xbt_dynar_pop_ptr (currentContainer);
476 static void instr_routing_parse_start_link ()
478 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
479 container_t new = newContainer (A_surfxml_link_id, INSTR_LINK, father);
481 type_t bandwidth = getVariableType ("bandwidth", NULL, new->type);
482 type_t latency = getVariableType ("latency", NULL, new->type);
483 pajeSetVariable (0, bandwidth->id, new->id, A_surfxml_link_bandwidth);
484 pajeSetVariable (0, latency->id, new->id, A_surfxml_link_latency);
485 if (TRACE_uncategorized()){
486 getVariableType ("bandwidth_used", "0.5 0.5 0.5", new->type);
490 static void instr_routing_parse_end_link ()
494 static void instr_routing_parse_start_host ()
496 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
497 container_t new = newContainer (A_surfxml_host_id, INSTR_HOST, father);
499 type_t power = getVariableType ("power", NULL, new->type);
500 pajeSetVariable (0, power->id, new->id, A_surfxml_host_power);
501 if (TRACE_uncategorized()){
502 getVariableType ("power_used", "0.5 0.5 0.5", new->type);
505 if (TRACE_smpi_is_enabled()) {
506 if (TRACE_smpi_is_grouped()){
507 type_t mpi = getContainerType("MPI", new->type);
508 getStateType ("MPI_STATE", mpi);
509 getLinkType ("MPI_LINK", rootType, mpi, mpi);
514 static void instr_routing_parse_end_host ()
518 static void instr_routing_parse_start_router ()
520 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
521 newContainer (A_surfxml_router_id, INSTR_ROUTER, father);
524 static void instr_routing_parse_end_router ()
528 static void instr_routing_parse_end_platform ()
530 currentContainer = NULL;
531 recursiveGraphExtraction (rootContainer);
532 platform_created = 1;
538 int instr_link_is_traced (const char *name)
540 if (((container_t)xbt_dict_get_or_null (allContainers, name))){
547 char *instr_variable_type (const char *name, const char *resource)
549 container_t container = (container_t)xbt_dict_get (allContainers, resource);
550 xbt_dict_cursor_t cursor = NULL;
553 xbt_dict_foreach(container->type->children, cursor, type_name, type) {
554 if (strcmp (name, type->name) == 0) return type->id;
559 char *instr_resource_type (const char *resource_name)
561 return ((container_t)xbt_dict_get_or_null (allContainers, resource_name))->id;
564 static void recursiveDestroyContainer (container_t container)
566 xbt_dict_cursor_t cursor = NULL;
569 xbt_dict_foreach(container->children, cursor, child_name, child) {
570 recursiveDestroyContainer (child);
572 destroyContainer (container);
575 static void recursiveDestroyType (type_t type)
577 xbt_dict_cursor_t cursor = NULL;
580 xbt_dict_foreach(type->children, cursor, child_name, child) {
581 recursiveDestroyType (child);
583 xbt_free (type->name);
585 xbt_free (type->children);
590 void instr_destroy_platform ()
592 if (rootContainer) recursiveDestroyContainer (rootContainer);
593 if (rootType) recursiveDestroyType (rootType);
597 * user categories support
599 static void recursiveNewUserVariableType (const char *new_typename, const char *color, type_t root)
601 if (!strcmp (root->name, "HOST") || !strcmp (root->name, "LINK")){
602 getVariableType(new_typename, color, root);
604 xbt_dict_cursor_t cursor = NULL;
607 xbt_dict_foreach(root->children, cursor, name, child_type) {
608 recursiveNewUserVariableType (new_typename, color, child_type);
612 void instr_new_user_variable_type (const char *new_typename, const char *color)
614 recursiveNewUserVariableType (new_typename, color, rootType);
617 static void recursiveNewUserLinkVariableType (const char *new_typename, const char *color, type_t root)
619 if (!strcmp (root->name, "LINK")){
620 getVariableType(new_typename, color, root);
622 xbt_dict_cursor_t cursor = NULL;
625 xbt_dict_foreach(root->children, cursor, name, child_type) {
626 recursiveNewUserLinkVariableType (new_typename, color, child_type);
630 void instr_new_user_link_variable_type (const char *new_typename, const char *color)
632 recursiveNewUserLinkVariableType (new_typename, color, rootType);
636 static void recursiveNewUserHostVariableType (const char *new_typename, const char *color, type_t root)
638 if (!strcmp (root->name, "HOST")){
639 getVariableType(new_typename, color, root);
641 xbt_dict_cursor_t cursor = NULL;
644 xbt_dict_foreach(root->children, cursor, name, child_type) {
645 recursiveNewUserHostVariableType (new_typename, color, child_type);
649 void instr_new_user_host_variable_type (const char *new_typename, const char *color)
651 recursiveNewUserHostVariableType (new_typename, color, rootType);
654 int instr_platform_traced ()
656 return platform_created;
659 #endif /* HAVE_TRACING */