Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] functions to be used by other parts of tracing (container handling)
[simgrid.git] / src / instr / instr_routing.c
1 /* Copyright (c) 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "instr/instr_private.h"
8
9 #ifdef HAVE_TRACING
10 #include "surf/surf_private.h"
11 #include "surf/network_private.h"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
14
15 extern xbt_dict_t defined_types; /* from instr_interface.c */
16
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 */
24
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);
34
35 static long long int newTypeId ()
36 {
37   static long long int counter = 0;
38   return counter++;
39 }
40
41 static type_t newType (const char *typename, e_entity_types kind, type_t father)
42 {
43   type_t ret = xbt_new0(s_type_t, 1);
44   ret->name = xbt_strdup (typename);
45   ret->father = father;
46   ret->kind = kind;
47   ret->children = xbt_dict_new ();
48
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);
53
54   if (father != NULL){
55     xbt_dict_set (father->children, typename, ret, NULL);
56   }
57   return ret;
58 }
59
60 static type_t newContainerType (const char *typename, e_entity_types kind, type_t father)
61 {
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);
65   return ret;
66 }
67
68 static type_t newVariableType (const char *typename, e_entity_types kind, const char *color, type_t father)
69 {
70   type_t ret = newType (typename, kind, father);
71 //  INFO4("VariableType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
72   if (color){
73     pajeDefineVariableTypeWithColor(ret->id, ret->father->id, ret->name, color);
74   }else{
75     pajeDefineVariableType(ret->id, ret->father->id, ret->name);
76   }
77   return ret;
78 }
79
80 static type_t newLinkType (const char *typename, e_entity_types kind, type_t father, type_t source, type_t dest)
81 {
82   type_t ret = newType (typename, kind, father);
83 //  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);
84   pajeDefineLinkType(ret->id, ret->father->id, source->id, dest->id, ret->name);
85   return ret;
86 }
87
88 static type_t newStateType (const char *typename, e_entity_types kind, type_t father)
89 {
90   type_t ret = newType (typename, kind, father);
91 //  INFO4("StateType %s(%s), child of %s(%s)", ret->name, ret->id, father->name, father->id);
92   pajeDefineStateType(ret->id, ret->father->id, ret->name);
93   return ret;
94 }
95
96 static type_t getContainerType (const char *typename, type_t father)
97 {
98   type_t ret;
99   if (father == NULL){
100     ret = newContainerType (typename, TYPE_CONTAINER, father);
101     rootType = ret;
102   }else{
103     //check if my father type already has my typename
104     ret = (type_t)xbt_dict_get_or_null (father->children, typename);
105     if (ret == NULL){
106       ret = newContainerType (typename, TYPE_CONTAINER, father);
107     }
108   }
109   return ret;
110 }
111
112 static type_t getVariableType (const char *typename, const char *color, type_t father)
113 {
114   type_t ret = xbt_dict_get_or_null (father->children, typename);
115   if (ret == NULL){
116     ret = newVariableType (typename, TYPE_VARIABLE, color, father);
117   }
118   return ret;
119 }
120
121 static type_t getLinkType (const char *typename, type_t father, type_t source, type_t dest)
122 {
123   type_t ret = xbt_dict_get_or_null (father->children, typename);
124   if (ret == NULL){
125     ret = newLinkType (typename, TYPE_LINK, father, source, dest);
126   }
127   return ret;
128 }
129
130 static type_t getStateType (const char *typename, type_t father)
131 {
132   type_t ret = xbt_dict_get_or_null (father->children, typename);
133   if (ret == NULL){
134     ret = newStateType (typename, TYPE_STATE, father);
135   }
136   return ret;
137 }
138
139 void instr_routing_define_callbacks ()
140 {
141   if (!TRACE_is_active())
142     return;
143   surfxml_add_callback(STag_surfxml_AS_cb_list, &instr_routing_parse_start_AS);
144   surfxml_add_callback(ETag_surfxml_AS_cb_list, &instr_routing_parse_end_AS);
145   surfxml_add_callback(STag_surfxml_link_cb_list, &instr_routing_parse_start_link);
146   surfxml_add_callback(ETag_surfxml_link_cb_list, &instr_routing_parse_end_link);
147   surfxml_add_callback(STag_surfxml_host_cb_list, &instr_routing_parse_start_host);
148   surfxml_add_callback(ETag_surfxml_host_cb_list, &instr_routing_parse_end_host);
149   surfxml_add_callback(STag_surfxml_router_cb_list, &instr_routing_parse_start_router);
150   surfxml_add_callback(ETag_surfxml_router_cb_list, &instr_routing_parse_end_router);
151   surfxml_add_callback(ETag_surfxml_platform_cb_list, &instr_routing_parse_end_platform);
152 }
153
154 static long long int newContainedId ()
155 {
156   static long long counter = 0;
157   return counter++;
158 }
159
160 container_t newContainer (const char *name, e_container_types kind, container_t father)
161 {
162   long long int counter = newContainedId();
163   char id_str[INSTR_DEFAULT_STR_SIZE];
164   snprintf (id_str, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
165
166   container_t new = xbt_new0(s_container_t, 1);
167   new->name = xbt_strdup (name); // name of the container
168   new->id = xbt_strdup (id_str); // id (or alias) of the container
169   new->father = father;
170   // level depends on level of father
171   if (new->father){
172     new->level = new->father->level+1;
173   }else{
174     new->level = 0;
175   }
176   // type definition (method depends on kind of this new container)
177   new->kind = kind;
178   if (new->kind == INSTR_AS){
179     //if this container is of an AS, its type name depends on its level
180     char as_typename[INSTR_DEFAULT_STR_SIZE];
181     snprintf (as_typename, INSTR_DEFAULT_STR_SIZE, "L%d", new->level);
182     if (new->father){
183       new->type = getContainerType (as_typename, new->father->type);
184     }else{
185       new->type = getContainerType ("0", NULL);
186     }
187   }else{
188     //otherwise, the name is its kind
189     switch (new->kind){
190       case INSTR_HOST: new->type = getContainerType ("HOST", new->father->type); break;
191       case INSTR_LINK: new->type = getContainerType ("LINK", new->father->type); break;
192       case INSTR_ROUTER: new->type = getContainerType ("ROUTER", new->father->type); break;
193       case INSTR_SMPI: new->type = getContainerType ("MPI", new->father->type); break;
194       default: xbt_die ("Congratulations, you have found a bug on newContainer function of instr_routing.c"); break;
195     }
196   }
197   new->children = xbt_dict_new();
198   if (new->father){
199     xbt_dict_set(new->father->children, new->name, new, NULL);
200     pajeCreateContainer (0, new->id, new->type->id, new->father->id, new->name);
201   }
202
203   //register hosts, routers, links containers
204   if (new->kind == INSTR_HOST || new->kind == INSTR_LINK || new->kind == INSTR_ROUTER) {
205     xbt_dict_set (allContainers, new->name, new, NULL);
206   }
207
208   //register the host container types
209   if (new->kind == INSTR_HOST){
210     xbt_dynar_push_as (allHostTypes, type_t, new->type);
211   }
212
213   //register the link container types
214   if (new->kind == INSTR_LINK){
215     xbt_dynar_push_as(allLinkTypes, type_t, new->type);
216   }
217   return new;
218 }
219
220 static container_t recursiveGetContainer (const char *name, container_t root)
221 {
222   if (strcmp (root->name, name) == 0) return root;
223
224   xbt_dict_cursor_t cursor = NULL;
225   container_t child;
226   char *child_name;
227   xbt_dict_foreach(root->children, cursor, child_name, child) {
228     container_t ret = recursiveGetContainer(name, child);
229     if (ret) return ret;
230   }
231   return NULL;
232 }
233
234 container_t getContainer (const char *name)
235 {
236   return recursiveGetContainer(name, rootContainer);
237 }
238
239 void destroyContainer (container_t container)
240 {
241   //remove me from my father
242   if (container->father){
243     xbt_dict_remove(container->father->children, container->name);
244   }
245
246   //trace my destruction
247   pajeDestroyContainer(SIMIX_get_clock(), container->type->id, container->id);
248
249   //free
250   xbt_free (container->name);
251   xbt_free (container->id);
252   xbt_free (container->children);
253   xbt_free (container);
254   container = NULL;
255 }
256
257 static container_t findChild (container_t root, container_t a1)
258 {
259   if (root == a1) return root;
260
261   xbt_dict_cursor_t cursor = NULL;
262   container_t child;
263   char *child_name;
264   xbt_dict_foreach(root->children, cursor, child_name, child) {
265     if (findChild (child, a1)) return child;
266   }
267   return NULL;
268 }
269
270 static container_t findCommonFather (container_t root, container_t a1, container_t a2)
271 {
272   if (a1->father == a2->father) return a1->father;
273
274   xbt_dict_cursor_t cursor = NULL;
275   container_t child;
276   char *child_name;
277   container_t a1_try = NULL;
278   container_t a2_try = NULL;
279   xbt_dict_foreach(root->children, cursor, child_name, child) {
280     a1_try = findChild (child, a1);
281     a2_try = findChild (child, a2);
282     if (a1_try && a2_try) return child;
283   }
284   return NULL;
285 }
286
287 static void linkContainers (const char *a1, const char *a2)
288 {
289   //ignore loopback
290   if (strcmp (a1, "__loopback__") == 0 || strcmp (a2, "__loopback__") == 0)
291     return;
292
293   container_t a1_container = ((container_t)xbt_dict_get (allContainers, a1));
294   type_t a1_type = a1_container->type;
295
296   container_t a2_container = ((container_t)xbt_dict_get (allContainers, a2));
297   type_t a2_type = a2_container->type;
298
299   container_t container = findCommonFather (rootContainer, a1_container, a2_container);
300   xbt_assert0 (container != NULL, "common father not found");
301
302   //declare type
303   char link_typename[INSTR_DEFAULT_STR_SIZE];
304   snprintf (link_typename, INSTR_DEFAULT_STR_SIZE, "%s-%s", a1_type->name, a2_type->name);
305   type_t link_type = getLinkType (link_typename, container->type, a1_type, a2_type);
306
307   //create the link
308   static long long counter = 0;
309   char key[INSTR_DEFAULT_STR_SIZE];
310   snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter++);
311   pajeStartLink(SIMIX_get_clock(), link_type->id, container->id, "G", a1_container->id, key);
312   pajeEndLink(SIMIX_get_clock(), link_type->id, container->id, "G", a2_container->id, key);
313 }
314
315 static void recursiveGraphExtraction (container_t container)
316 {
317   if (xbt_dict_length(container->children)){
318     xbt_dict_cursor_t cursor = NULL;
319     container_t child;
320     char *child_name;
321     //bottom-up recursion
322     xbt_dict_foreach(container->children, cursor, child_name, child) {
323       recursiveGraphExtraction (child);
324     }
325
326     //let's get routes
327     xbt_dict_cursor_t cursor1 = NULL, cursor2 = NULL;
328     container_t child1, child2;
329     const char *child_name1, *child_name2;
330
331     xbt_dict_t filter = xbt_dict_new ();
332
333     xbt_dict_foreach(container->children, cursor1, child_name1, child1) {
334       xbt_dict_foreach(container->children, cursor2, child_name2, child2) {
335         //check if we already register this pair (we only need one direction)
336         char aux1[INSTR_DEFAULT_STR_SIZE], aux2[INSTR_DEFAULT_STR_SIZE];
337         snprintf (aux1, INSTR_DEFAULT_STR_SIZE, "%s%s", child_name1, child_name2);
338         snprintf (aux2, INSTR_DEFAULT_STR_SIZE, "%s%s", child_name2, child_name1);
339         if (xbt_dict_get_or_null (filter, aux1)) continue;
340         if (xbt_dict_get_or_null (filter, aux2)) continue;
341
342         //ok, not found, register it
343         xbt_dict_set (filter, aux1, xbt_strdup ("1"), xbt_free);
344         xbt_dict_set (filter, aux2, xbt_strdup ("1"), xbt_free);
345
346         if ((child1->kind == INSTR_HOST || child1->kind == INSTR_ROUTER) &&
347             (child2->kind == INSTR_HOST  || child2->kind == INSTR_ROUTER)){
348
349           //getting route
350           xbt_dynar_t route;
351           xbt_ex_t exception;
352           TRY {
353             route = global_routing->get_route (child_name1, child_name2);
354           }CATCH(exception) {
355             //no route between them, that's possible
356             continue;
357           }
358
359           //link the route members
360           unsigned int cpt;
361           void *link;
362           char *previous_entity_name = (char*)child_name1;
363           xbt_dynar_foreach (route, cpt, link) {
364             char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
365             linkContainers (previous_entity_name, link_name);
366             previous_entity_name = link_name;
367           }
368           linkContainers (previous_entity_name, child_name2);
369         }else if (child1->kind == INSTR_AS &&
370                   child2->kind == INSTR_AS &&
371                   strcmp(child_name1, child_name2) != 0){
372
373           //getting route
374           routing_component_t root = global_routing->root;
375           route_extended_t route;
376           xbt_ex_t exception;
377           TRY {
378             route = root->get_route (root, child_name1, child_name2);
379           }CATCH(exception) {
380             //no route between them, that's possible
381             continue;
382           }
383           xbt_assert2(route!=NULL,
384               "there is no ASroute between %s and %s", child_name1, child_name2);
385           unsigned int cpt;
386           void *link;
387           char *previous_entity_name = route->src_gateway;
388           xbt_dynar_foreach (route->generic_route.link_list, cpt, link) {
389             char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
390             linkContainers (previous_entity_name, link_name);
391             previous_entity_name = link_name;
392           }
393           linkContainers (previous_entity_name, route->dst_gateway);
394         }
395       }
396     }
397     xbt_dict_free(&filter);
398   }
399 }
400
401 /*
402  * Callbacks
403  */
404 static void instr_routing_parse_start_AS ()
405 {
406   if (rootContainer == NULL){
407     currentContainer = xbt_dynar_new (sizeof(s_container_t), NULL);
408     allContainers = xbt_dict_new ();
409     allLinkTypes = xbt_dynar_new (sizeof(s_type_t), NULL);
410     allHostTypes = xbt_dynar_new (sizeof(s_type_t), NULL);
411
412     rootContainer = newContainer ("0", INSTR_AS, NULL);
413     xbt_dynar_push (currentContainer, rootContainer);
414
415     if (TRACE_smpi_is_enabled()) {
416       if (!TRACE_smpi_is_grouped()){
417         container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
418         type_t mpi = getContainerType("MPI", father->type);
419         getStateType ("MPI_STATE", mpi);
420         getLinkType ("MPI_LINK", rootType, mpi, mpi);
421       }
422     }
423   }
424   container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
425   container_t new = newContainer (A_surfxml_AS_id, INSTR_AS, father);
426
427   //push
428   xbt_dynar_push (currentContainer, new);
429 }
430
431 static void instr_routing_parse_end_AS ()
432 {
433   xbt_dynar_pop_ptr (currentContainer);
434 }
435
436 static void instr_routing_parse_start_link ()
437 {
438   container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
439   container_t new = newContainer (A_surfxml_link_id, INSTR_LINK, father);
440
441   type_t bandwidth = getVariableType ("bandwidth", NULL, new->type);
442   type_t latency = getVariableType ("latency", NULL, new->type);
443   pajeSetVariable (0, bandwidth->id, new->id, A_surfxml_link_bandwidth);
444   pajeSetVariable (0, latency->id, new->id, A_surfxml_link_latency);
445   if (TRACE_uncategorized()){
446     getVariableType ("bandwidth_used", "0.5 0.5 0.5", new->type);
447   }
448 }
449
450 static void instr_routing_parse_end_link ()
451 {
452 }
453
454 static void instr_routing_parse_start_host ()
455 {
456   container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
457   container_t new = newContainer (A_surfxml_host_id, INSTR_HOST, father);
458
459   type_t power = getVariableType ("power", NULL, new->type);
460   pajeSetVariable (0, power->id, new->id, A_surfxml_host_power);
461   if (TRACE_uncategorized()){
462     getVariableType ("power_used", "0.5 0.5 0.5", new->type);
463   }
464
465   if (TRACE_smpi_is_enabled()) {
466     if (TRACE_smpi_is_grouped()){
467       type_t mpi = getContainerType("MPI", new->type);
468       getStateType ("MPI_STATE", mpi);
469       getLinkType ("MPI_LINK", rootType, mpi, mpi);
470     }
471   }
472 }
473
474 static void instr_routing_parse_end_host ()
475 {
476 }
477
478 static void instr_routing_parse_start_router ()
479 {
480   container_t father = xbt_dynar_get_ptr(currentContainer, xbt_dynar_length(currentContainer)-1);
481   newContainer (A_surfxml_router_id, INSTR_ROUTER, father);
482 }
483
484 static void instr_routing_parse_end_router ()
485 {
486 }
487
488 static void instr_routing_parse_end_platform ()
489 {
490   currentContainer = NULL;
491   recursiveGraphExtraction (rootContainer);
492   platform_created = 1;
493 }
494
495 /*
496  * Support functions
497  */
498 int instr_link_is_traced (const char *name)
499 {
500   if (((container_t)xbt_dict_get_or_null (allContainers, name))){
501     return 1;
502   } else {
503     return 0;
504   }
505 }
506
507 char *instr_variable_type (const char *name, const char *resource)
508 {
509   container_t container = (container_t)xbt_dict_get (allContainers, resource);
510   xbt_dict_cursor_t cursor = NULL;
511   type_t type;
512   char *type_name;
513   xbt_dict_foreach(container->type->children, cursor, type_name, type) {
514     if (strcmp (name, type->name) == 0) return type->id;
515   }
516   return NULL;
517 }
518
519 char *instr_resource_type (const char *resource_name)
520 {
521   return ((container_t)xbt_dict_get_or_null (allContainers, resource_name))->id;
522 }
523
524 static void recursiveDestroyContainer (container_t container)
525 {
526   xbt_dict_cursor_t cursor = NULL;
527   container_t child;
528   char *child_name;
529   xbt_dict_foreach(container->children, cursor, child_name, child) {
530     recursiveDestroyContainer (child);
531   }
532   destroyContainer (container);
533 }
534
535 static void recursiveDestroyType (type_t type)
536 {
537   xbt_dict_cursor_t cursor = NULL;
538   type_t child;
539   char *child_name;
540   xbt_dict_foreach(type->children, cursor, child_name, child) {
541     recursiveDestroyType (child);
542   }
543   xbt_free (type->name);
544   xbt_free (type->id);
545   xbt_free (type->children);
546   xbt_free (type);
547   type = NULL;
548 }
549
550 void instr_destroy_platform ()
551 {
552   if (rootContainer) recursiveDestroyContainer (rootContainer);
553   if (rootType) recursiveDestroyType (rootType);
554 }
555
556 /*
557  * user categories support
558  */
559 static void recursiveNewUserVariableType (const char *new_typename, const char *color, type_t root)
560 {
561   if (!strcmp (root->name, "HOST") || !strcmp (root->name, "LINK")){
562     getVariableType(new_typename, color, root);
563   }
564   xbt_dict_cursor_t cursor = NULL;
565   type_t child_type;
566   char *name;
567   xbt_dict_foreach(root->children, cursor, name, child_type) {
568     recursiveNewUserVariableType (new_typename, color, child_type);
569   }
570 }
571
572 void instr_new_user_variable_type (const char *new_typename, const char *color)
573 {
574   recursiveNewUserVariableType (new_typename, color, rootType);
575 }
576
577 static void recursiveNewUserLinkVariableType (const char *new_typename, const char *color, type_t root)
578 {
579   if (!strcmp (root->name, "LINK")){
580     getVariableType(new_typename, color, root);
581   }
582   xbt_dict_cursor_t cursor = NULL;
583   type_t child_type;
584   char *name;
585   xbt_dict_foreach(root->children, cursor, name, child_type) {
586     recursiveNewUserLinkVariableType (new_typename, color, child_type);
587   }
588 }
589
590 void instr_new_user_link_variable_type  (const char *new_typename, const char *color)
591 {
592   recursiveNewUserLinkVariableType (new_typename, color, rootType);
593 }
594
595
596 static void recursiveNewUserHostVariableType (const char *new_typename, const char *color, type_t root)
597 {
598   if (!strcmp (root->name, "HOST")){
599     getVariableType(new_typename, color, root);
600   }
601   xbt_dict_cursor_t cursor = NULL;
602   type_t child_type;
603   char *name;
604   xbt_dict_foreach(root->children, cursor, name, child_type) {
605     recursiveNewUserHostVariableType (new_typename, color, child_type);
606   }
607 }
608
609 void instr_new_user_host_variable_type  (const char *new_typename, const char *color)
610 {
611   recursiveNewUserHostVariableType (new_typename, color, rootType);
612 }
613
614 int instr_platform_traced ()
615 {
616   return platform_created;
617 }
618
619 #endif /* HAVE_TRACING */
620