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 case INSTR_MSG_PROCESS: new->type = getContainerType ("MSG_PROCESS", new->father->type); break;
216 case INSTR_MSG_TASK: new->type = getContainerType ("MSG_TASK", new->father->type); break;
217 default: xbt_die ("Congratulations, you have found a bug on newContainer function of instr_routing.c"); break;
220 new->children = xbt_dict_new();
222 xbt_dict_set(new->father->children, new->name, new, NULL);
223 pajeCreateContainer (SIMIX_get_clock(), new->id, new->type->id, new->father->id, new->name);
226 //register hosts, routers, links containers
227 if (new->kind == INSTR_HOST || new->kind == INSTR_LINK || new->kind == INSTR_ROUTER) {
228 xbt_dict_set (allContainers, new->name, new, NULL);
231 //register the host container types
232 if (new->kind == INSTR_HOST){
233 xbt_dynar_push_as (allHostTypes, type_t, new->type);
236 //register the link container types
237 if (new->kind == INSTR_LINK){
238 xbt_dynar_push_as(allLinkTypes, type_t, new->type);
243 static container_t recursiveGetContainer (const char *name, container_t root)
245 if (strcmp (root->name, name) == 0) return root;
247 xbt_dict_cursor_t cursor = NULL;
250 xbt_dict_foreach(root->children, cursor, child_name, child) {
251 container_t ret = recursiveGetContainer(name, child);
257 container_t getContainer (const char *name)
259 return recursiveGetContainer(name, rootContainer);
262 static type_t recursiveGetType (const char *name, type_t root)
264 if (strcmp (root->name, name) == 0) return root;
266 xbt_dict_cursor_t cursor = NULL;
269 xbt_dict_foreach(root->children, cursor, child_name, child) {
270 type_t ret = recursiveGetType(name, child);
276 type_t getType (const char *name)
278 return recursiveGetType (name, rootType);
281 void destroyContainer (container_t container)
283 //remove me from my father
284 if (container->father){
285 xbt_dict_remove(container->father->children, container->name);
288 //trace my destruction
289 pajeDestroyContainer(SIMIX_get_clock(), container->type->id, container->id);
292 xbt_free (container->name);
293 xbt_free (container->id);
294 xbt_free (container->children);
295 xbt_free (container);
299 static container_t findChild (container_t root, container_t a1)
301 if (root == a1) return root;
303 xbt_dict_cursor_t cursor = NULL;
306 xbt_dict_foreach(root->children, cursor, child_name, child) {
307 if (findChild (child, a1)) return child;
312 static container_t findCommonFather (container_t root, container_t a1, container_t a2)
314 if (a1->father == a2->father) return a1->father;
316 xbt_dict_cursor_t cursor = NULL;
319 container_t a1_try = NULL;
320 container_t a2_try = NULL;
321 xbt_dict_foreach(root->children, cursor, child_name, child) {
322 a1_try = findChild (child, a1);
323 a2_try = findChild (child, a2);
324 if (a1_try && a2_try) return child;
329 static void linkContainers (const char *a1, const char *a2)
332 if (strcmp (a1, "__loopback__") == 0 || strcmp (a2, "__loopback__") == 0)
335 container_t a1_container = ((container_t)xbt_dict_get (allContainers, a1));
336 type_t a1_type = a1_container->type;
338 container_t a2_container = ((container_t)xbt_dict_get (allContainers, a2));
339 type_t a2_type = a2_container->type;
341 container_t container = findCommonFather (rootContainer, a1_container, a2_container);
342 xbt_assert0 (container != NULL, "common father not found");
345 char link_typename[INSTR_DEFAULT_STR_SIZE];
346 snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s", a1_type->name, a2_type->name);
347 type_t link_type = getLinkType (link_typename, container->type, a1_type, a2_type);
350 static long long counter = 0;
351 char key[INSTR_DEFAULT_STR_SIZE];
352 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
353 pajeStartLink(SIMIX_get_clock(), link_type->id, container->id, "G", a1_container->id, key);
354 pajeEndLink(SIMIX_get_clock(), link_type->id, container->id, "G", a2_container->id, key);
357 static void recursiveGraphExtraction (container_t container)
359 if (xbt_dict_length(container->children)){
360 xbt_dict_cursor_t cursor = NULL;
363 //bottom-up recursion
364 xbt_dict_foreach(container->children, cursor, child_name, child) {
365 recursiveGraphExtraction (child);
369 xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
370 container_t child1, child2;
371 const char *child_name1, *child_name2;
373 xbt_dict_t filter = xbt_dict_new ();
375 xbt_dict_foreach(container->children, cursor1, child_name1, child1) {
376 xbt_dict_foreach(container->children, cursor2, child_name2, child2) {
377 //check if we already register this pair (we only need one direction)
378 char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
379 snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", child_name1, child_name2);
380 snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", child_name2, child_name1);
381 if (xbt_dict_get_or_null (filter, aux1)) continue;
382 if (xbt_dict_get_or_null (filter, aux2)) continue;
384 //ok, not found, register it
385 xbt_dict_set (filter, aux1, xbt_strdup ("1"), xbt_free);
386 xbt_dict_set (filter, aux2, xbt_strdup ("1"), xbt_free);
388 if ((child1->kind == INSTR_HOST || child1->kind == INSTR_ROUTER) &&
389 (child2->kind == INSTR_HOST || child2->kind == INSTR_ROUTER)){
392 xbt_dynar_t route = NULL;
395 route = global_routing->get_route (child_name1, child_name2);
397 //no route between them, that's possible
401 //link the route members
404 char *previous_entity_name = (char*)child_name1;
405 xbt_dynar_foreach (route, cpt, link) {
406 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
407 linkContainers (previous_entity_name, link_name);
408 previous_entity_name = link_name;
410 linkContainers (previous_entity_name, child_name2);
411 }else if (child1->kind == INSTR_AS &&
412 child2->kind == INSTR_AS &&
413 strcmp(child_name1, child_name2) != 0){
416 routing_component_t root = global_routing->root;
417 route_extended_t route = NULL;
420 route = root->get_route (root, child_name1, child_name2);
422 //no route between them, that's possible
425 xbt_assert2(route!=NULL,
426 "there is no ASroute between %s and %s", child_name1, child_name2);
429 char *previous_entity_name = route->src_gateway;
430 xbt_dynar_foreach (route->generic_route.link_list, cpt, link) {
431 char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
432 linkContainers (previous_entity_name, link_name);
433 previous_entity_name = link_name;
435 linkContainers (previous_entity_name, route->dst_gateway);
439 xbt_dict_free(&filter);
446 static void instr_routing_parse_start_AS ()
448 if (rootContainer == NULL){
449 currentContainer = xbt_dynar_new (sizeof(s_container_t), NULL);
450 allContainers = xbt_dict_new ();
451 allLinkTypes = xbt_dynar_new (sizeof(s_type_t), NULL);
452 allHostTypes = xbt_dynar_new (sizeof(s_type_t), NULL);
454 rootContainer = newContainer ("0", INSTR_AS, NULL);
455 xbt_dynar_push (currentContainer, rootContainer);
457 if (TRACE_smpi_is_enabled()) {
458 if (!TRACE_smpi_is_grouped()){
459 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
460 type_t mpi = getContainerType("MPI", father->type);
461 getStateType ("MPI_STATE", mpi);
462 getLinkType ("MPI_LINK", rootType, mpi, mpi);
466 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
467 container_t new = newContainer (A_surfxml_AS_id, INSTR_AS, father);
470 xbt_dynar_push (currentContainer, new);
473 static void instr_routing_parse_end_AS ()
475 xbt_dynar_pop_ptr (currentContainer);
478 static void instr_routing_parse_start_link ()
480 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
481 container_t new = newContainer (A_surfxml_link_id, INSTR_LINK, father);
483 type_t bandwidth = getVariableType ("bandwidth", NULL, new->type);
484 type_t latency = getVariableType ("latency", NULL, new->type);
485 pajeSetVariable (0, bandwidth->id, new->id, A_surfxml_link_bandwidth);
486 pajeSetVariable (0, latency->id, new->id, A_surfxml_link_latency);
487 if (TRACE_uncategorized()){
488 getVariableType ("bandwidth_used", "0.5 0.5 0.5", new->type);
492 static void instr_routing_parse_end_link ()
496 static void instr_routing_parse_start_host ()
498 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
499 container_t new = newContainer (A_surfxml_host_id, INSTR_HOST, father);
501 type_t power = getVariableType ("power", NULL, new->type);
502 pajeSetVariable (0, power->id, new->id, A_surfxml_host_power);
503 if (TRACE_uncategorized()){
504 getVariableType ("power_used", "0.5 0.5 0.5", new->type);
507 if (TRACE_smpi_is_enabled()) {
508 if (TRACE_smpi_is_grouped()){
509 type_t mpi = getContainerType("MPI", new->type);
510 getStateType ("MPI_STATE", mpi);
511 getLinkType ("MPI_LINK", rootType, mpi, mpi);
515 if (TRACE_msg_process_is_enabled()) {
516 type_t msg_process = getContainerType("MSG_PROCESS", new->type);
517 getStateType ("MSG_PROCESS_STATE", msg_process);
518 getLinkType ("MSG_PROCESS_LINK", rootType, msg_process, msg_process);
521 if (TRACE_msg_task_is_enabled()) {
522 type_t msg_task = getContainerType ("MSG_TASK", new->type);
523 getStateType ("MSG_TASK_STATE", msg_task);
524 getLinkType ("MSG_TASK_LINK", rootType, msg_task, msg_task);
528 static void instr_routing_parse_end_host ()
532 static void instr_routing_parse_start_router ()
534 container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
535 newContainer (A_surfxml_router_id, INSTR_ROUTER, father);
538 static void instr_routing_parse_end_router ()
542 static void instr_routing_parse_end_platform ()
544 currentContainer = NULL;
545 recursiveGraphExtraction (rootContainer);
546 platform_created = 1;
552 int instr_link_is_traced (const char *name)
554 if (((container_t)xbt_dict_get_or_null (allContainers, name))){
561 char *instr_variable_type (const char *name, const char *resource)
563 container_t container = (container_t)xbt_dict_get (allContainers, resource);
564 xbt_dict_cursor_t cursor = NULL;
567 xbt_dict_foreach(container->type->children, cursor, type_name, type) {
568 if (strcmp (name, type->name) == 0) return type->id;
573 char *instr_resource_type (const char *resource_name)
575 return ((container_t)xbt_dict_get_or_null (allContainers, resource_name))->id;
578 static void recursiveDestroyContainer (container_t container)
580 xbt_dict_cursor_t cursor = NULL;
583 xbt_dict_foreach(container->children, cursor, child_name, child) {
584 recursiveDestroyContainer (child);
586 destroyContainer (container);
589 static void recursiveDestroyType (type_t type)
591 xbt_dict_cursor_t cursor = NULL;
594 xbt_dict_foreach(type->children, cursor, child_name, child) {
595 recursiveDestroyType (child);
597 xbt_free (type->name);
599 xbt_free (type->children);
604 void instr_destroy_platform ()
606 if (rootContainer) recursiveDestroyContainer (rootContainer);
607 if (rootType) recursiveDestroyType (rootType);
611 * user categories support
613 static void recursiveNewUserVariableType (const char *new_typename, const char *color, type_t root)
615 if (!strcmp (root->name, "HOST") || !strcmp (root->name, "LINK")){
616 getVariableType(new_typename, color, root);
618 xbt_dict_cursor_t cursor = NULL;
621 xbt_dict_foreach(root->children, cursor, name, child_type) {
622 recursiveNewUserVariableType (new_typename, color, child_type);
626 void instr_new_user_variable_type (const char *new_typename, const char *color)
628 recursiveNewUserVariableType (new_typename, color, rootType);
631 static void recursiveNewUserLinkVariableType (const char *new_typename, const char *color, type_t root)
633 if (!strcmp (root->name, "LINK")){
634 getVariableType(new_typename, color, root);
636 xbt_dict_cursor_t cursor = NULL;
639 xbt_dict_foreach(root->children, cursor, name, child_type) {
640 recursiveNewUserLinkVariableType (new_typename, color, child_type);
644 void instr_new_user_link_variable_type (const char *new_typename, const char *color)
646 recursiveNewUserLinkVariableType (new_typename, color, rootType);
650 static void recursiveNewUserHostVariableType (const char *new_typename, const char *color, type_t root)
652 if (!strcmp (root->name, "HOST")){
653 getVariableType(new_typename, color, root);
655 xbt_dict_cursor_t cursor = NULL;
658 xbt_dict_foreach(root->children, cursor, name, child_type) {
659 recursiveNewUserHostVariableType (new_typename, color, child_type);
663 void instr_new_user_host_variable_type (const char *new_typename, const char *color)
665 recursiveNewUserHostVariableType (new_typename, color, rootType);
668 int instr_platform_traced ()
670 return platform_created;
673 #endif /* HAVE_TRACING */