Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
79247139a8ae12ecb1fa2a775c6b93c6729630e7
[simgrid.git] / src / surf / surf_routing.c
1 /* Copyright (c) 2009, 2010, 2011. 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 <pcre.h>               /* regular expression library */
8
9 #include "simgrid/platf_interface.h"    // platform creation API internal interface
10
11 #include "surf_routing_private.h"
12 #include "surf/surf_routing.h"
13 #include "surf/surfxml_parse_values.h"
14
15 xbt_lib_t host_lib;
16 int ROUTING_HOST_LEVEL;         //Routing level
17 int SURF_CPU_LEVEL;             //Surf cpu level
18 int SURF_WKS_LEVEL;             //Surf workstation level
19 int SIMIX_HOST_LEVEL;           //Simix level
20 int MSG_HOST_LEVEL;             //Msg level
21 int SD_HOST_LEVEL;              //Simdag level
22 int COORD_HOST_LEVEL=0;         //Coordinates level
23 int NS3_HOST_LEVEL;             //host node for ns3
24
25 xbt_lib_t link_lib;
26 int SD_LINK_LEVEL;              //Simdag level
27 int SURF_LINK_LEVEL;            //Surf level
28 int NS3_LINK_LEVEL;             //link for ns3
29
30 xbt_lib_t as_router_lib;
31 int ROUTING_ASR_LEVEL;          //Routing level
32 int COORD_ASR_LEVEL;            //Coordinates level
33 int NS3_ASR_LEVEL;              //host node for ns3
34
35 static xbt_dict_t random_value = NULL;
36
37 /* Global vars */
38 routing_global_t global_routing = NULL;
39 AS_t current_routing = NULL;
40
41 /* global parse functions */
42 xbt_dynar_t parsed_link_list = NULL;   /* temporary store of current list link of a route */
43 static const char *src = NULL;  /* temporary store the source name of a route */
44 static const char *dst = NULL;  /* temporary store the destination name of a route */
45 static char *gw_src = NULL;     /* temporary store the gateway source name of a route */
46 static char *gw_dst = NULL;     /* temporary store the gateway destination name of a route */
47
48 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
49
50 static void routing_parse_peer(sg_platf_peer_cbarg_t peer);     /* peer bypass */
51 static void routing_parse_Srandom(void);        /* random bypass */
52
53 static void routing_parse_postparse(void);
54
55 /* this lines are only for replace use like index in the model table */
56 typedef enum {
57   SURF_MODEL_FULL = 0,
58   SURF_MODEL_FLOYD,
59   SURF_MODEL_DIJKSTRA,
60   SURF_MODEL_DIJKSTRACACHE,
61   SURF_MODEL_NONE,
62   SURF_MODEL_RULEBASED,
63   SURF_MODEL_VIVALDI,
64   SURF_MODEL_CLUSTER
65 } e_routing_types;
66
67 struct s_model_type routing_models[] = {
68   {"Full",
69    "Full routing data (fast, large memory requirements, fully expressive)",
70    model_full_create, model_full_end},
71   {"Floyd",
72    "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
73    model_floyd_create, model_floyd_end},
74   {"Dijkstra",
75    "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
76    model_dijkstra_create, model_dijkstra_both_end},
77   {"DijkstraCache",
78    "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
79    model_dijkstracache_create, model_dijkstra_both_end},
80   {"none", "No routing (usable with Constant network only)",
81    model_none_create,  NULL},
82   {"RuleBased", "Rule-Based routing data (...)",
83    model_rulebased_create, NULL},
84   {"Vivaldi", "Vivaldi routing",
85    model_vivaldi_create, NULL},
86   {"Cluster", "Cluster routing",
87    model_cluster_create, NULL},
88   {NULL, NULL, NULL, NULL}
89 };
90
91 /**
92  * \brief Add a "host" to the network element list
93  */
94 static void parse_S_host(sg_platf_host_cbarg_t host)
95 {
96   network_element_info_t info = NULL;
97   if (current_routing->hierarchy == SURF_ROUTING_NULL)
98     current_routing->hierarchy = SURF_ROUTING_BASE;
99   xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
100              "Reading a host, processing unit \"%s\" already exists", host->id);
101
102   current_routing->parse_PU(current_routing, host->id);
103   info = xbt_new0(s_network_element_info_t, 1);
104   info->rc_component = current_routing;
105   info->rc_type = SURF_NETWORK_ELEMENT_HOST;
106   xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
107   if (host->coord && strcmp(host->coord, "")) {
108     unsigned int cursor;
109     char*str;
110
111     if (!COORD_HOST_LEVEL)
112       xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
113
114     /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
115     xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
116     xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
117     xbt_dynar_foreach(ctn_str,cursor, str) {
118       double val = atof(str);
119       xbt_dynar_push(ctn,&val);
120     }
121     xbt_dynar_shrink(ctn, 0);
122     xbt_dynar_free(&ctn_str);
123     xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
124   }
125 }
126
127 /**
128  * \brief Add a "router" to the network element list
129  */
130 static void parse_S_router(sg_platf_router_cbarg_t router)
131 {
132   network_element_info_t info = NULL;
133   if (current_routing->hierarchy == SURF_ROUTING_NULL)
134     current_routing->hierarchy = SURF_ROUTING_BASE;
135   xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
136              "Reading a router, processing unit \"%s\" already exists",
137              router->id);
138
139   current_routing->parse_PU(current_routing, router->id);
140   info = xbt_new0(s_network_element_info_t, 1);
141   info->rc_component = current_routing;
142   info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
143
144   xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
145   if (strcmp(router->coord, "")) {
146     unsigned int cursor;
147     char*str;
148
149     if (!COORD_ASR_LEVEL)
150       xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
151
152     /* Pre-parse the host coordinates */
153     xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
154     xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
155     xbt_dynar_foreach(ctn_str,cursor, str) {
156       double val = atof(str);
157       xbt_dynar_push(ctn,&val);
158     }
159     xbt_dynar_shrink(ctn, 0);
160     xbt_dynar_free(&ctn_str);
161     xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
162   }
163 }
164
165
166 /**
167  * \brief Set the end points for a route
168  */
169 static void routing_parse_S_route(void)
170 {
171   if (src != NULL && dst != NULL && parsed_link_list != NULL)
172     THROWF(arg_error, 0, "Route between %s to %s can not be defined",
173            A_surfxml_route_src, A_surfxml_route_dst);
174   src = A_surfxml_route_src;
175   dst = A_surfxml_route_dst;
176   xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
177              "Some limits are null in the route between \"%s\" and \"%s\"",
178              src, dst);
179   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
180 }
181
182 /**
183  * \brief Set the end points and gateways for a ASroute
184  */
185 static void routing_parse_S_ASroute(void)
186 {
187   if (src != NULL && dst != NULL && parsed_link_list != NULL)
188     THROWF(arg_error, 0, "Route between %s to %s can not be defined",
189            A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
190   src = A_surfxml_ASroute_src;
191   dst = A_surfxml_ASroute_dst;
192   gw_src = A_surfxml_ASroute_gw_src;
193   gw_dst = A_surfxml_ASroute_gw_dst;
194   xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
195              || strlen(gw_dst) > 0,
196              "Some limits are null in the route between \"%s\" and \"%s\"",
197              src, dst);
198   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
199 }
200
201 /**
202  * \brief Set the end points for a bypassRoute
203  */
204 static void routing_parse_S_bypassRoute(void)
205 {
206   if (src != NULL && dst != NULL && parsed_link_list != NULL)
207     THROWF(arg_error, 0,
208            "Bypass Route between %s to %s can not be defined",
209            A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
210   src = A_surfxml_bypassRoute_src;
211   dst = A_surfxml_bypassRoute_dst;
212   gw_src = A_surfxml_bypassRoute_gw_src;
213   gw_dst = A_surfxml_bypassRoute_gw_dst;
214   xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
215              || strlen(gw_dst) > 0,
216              "Some limits are null in the route between \"%s\" and \"%s\"",
217              src, dst);
218   parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
219 }
220
221 /**
222  * \brief Set a new link on the actual list of link for a route or ASroute from XML
223  */
224
225 static void routing_parse_link_ctn(void)
226 {
227   char *link_id;
228   switch (A_surfxml_link_ctn_direction) {
229   case AU_surfxml_link_ctn_direction:
230   case A_surfxml_link_ctn_direction_NONE:
231     link_id = xbt_strdup(A_surfxml_link_ctn_id);
232     break;
233   case A_surfxml_link_ctn_direction_UP:
234     link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
235     break;
236   case A_surfxml_link_ctn_direction_DOWN:
237     link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
238     break;
239   }
240   xbt_dynar_push(parsed_link_list, &link_id);
241 }
242
243 /**
244  * \brief Store the route by calling the set_route function of the current routing component
245  */
246 static void routing_parse_E_route(void)
247 {
248   route_t route = xbt_new0(s_route_t, 1);
249   route->link_list = parsed_link_list;
250   xbt_assert(current_routing->parse_route,
251              "no defined method \"set_route\" in \"%s\"",
252              current_routing->name);
253   current_routing->parse_route(current_routing, src, dst, route);
254   parsed_link_list = NULL;
255   src = NULL;
256   dst = NULL;
257 }
258
259 /**
260  * \brief Store the ASroute by calling the set_ASroute function of the current routing component
261  */
262 static void routing_parse_E_ASroute(void)
263 {
264   route_t e_route = xbt_new0(s_route_t, 1);
265   e_route->link_list = parsed_link_list;
266   e_route->src_gateway = xbt_strdup(gw_src);
267   e_route->dst_gateway = xbt_strdup(gw_dst);
268   xbt_assert(current_routing->parse_ASroute,
269              "no defined method \"set_ASroute\" in \"%s\"",
270              current_routing->name);
271   current_routing->parse_ASroute(current_routing, src, dst, e_route);
272   parsed_link_list = NULL;
273   src = NULL;
274   dst = NULL;
275   gw_src = NULL;
276   gw_dst = NULL;
277 }
278
279 /**
280  * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
281  */
282 static void routing_parse_E_bypassRoute(void)
283 {
284   route_t e_route = xbt_new0(s_route_t, 1);
285   e_route->link_list = parsed_link_list;
286   e_route->src_gateway = xbt_strdup(gw_src);
287   e_route->dst_gateway = xbt_strdup(gw_dst);
288   xbt_assert(current_routing->parse_bypassroute,
289              "Bypassing mechanism not implemented by routing '%s'",
290              current_routing->name);
291   current_routing->parse_bypassroute(current_routing, src, dst, e_route);
292   parsed_link_list = NULL;
293   src = NULL;
294   dst = NULL;
295   gw_src = NULL;
296   gw_dst = NULL;
297 }
298
299 /**
300  * \brief Make a new routing component to the platform
301  *
302  * Add a new autonomous system to the platform. Any elements (such as host,
303  * router or sub-AS) added after this call and before the corresponding call
304  * to sg_platf_new_AS_close() will be added to this AS.
305  *
306  * Once this function was called, the configuration concerning the used
307  * models cannot be changed anymore.
308  *
309  * @param AS_id name of this autonomous system. Must be unique in the platform
310  * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
311  */
312 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
313 {
314   AS_t new_as;
315   routing_model_description_t model = NULL;
316   int cpt;
317
318   /* search the routing model */
319   for (cpt = 0; routing_models[cpt].name; cpt++)
320     if (!strcmp(wanted_routing_type, routing_models[cpt].name))
321       model = &routing_models[cpt];
322   /* if its not exist, error */
323   if (model == NULL) {
324     fprintf(stderr, "Routing model %s not found. Existing models:\n",
325             wanted_routing_type);
326     for (cpt = 0; routing_models[cpt].name; cpt++)
327       fprintf(stderr, "   %s: %s\n", routing_models[cpt].name,
328               routing_models[cpt].desc);
329     xbt_die(NULL);
330   }
331
332   /* make a new routing component */
333   new_as = (AS_t) model->create();
334   new_as->model_desc = model;
335   new_as->hierarchy = SURF_ROUTING_NULL;
336   new_as->name = xbt_strdup(AS_id);
337
338   if (current_routing == NULL && global_routing->root == NULL) {
339
340     /* it is the first one */
341     new_as->routing_father = NULL;
342     global_routing->root = new_as;
343
344   } else if (current_routing != NULL && global_routing->root != NULL) {
345
346     xbt_assert(!xbt_dict_get_or_null
347                (current_routing->routing_sons, AS_id),
348                "The AS \"%s\" already exists", AS_id);
349     /* it is a part of the tree */
350     new_as->routing_father = current_routing;
351     /* set the father behavior */
352     if (current_routing->hierarchy == SURF_ROUTING_NULL)
353       current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
354     /* add to the sons dictionary */
355     xbt_dict_set(current_routing->routing_sons, AS_id,
356                  (void *) new_as, NULL);
357     /* add to the father element list */
358     current_routing->parse_AS(current_routing, AS_id);
359   } else {
360     THROWF(arg_error, 0, "All defined components must be belong to a AS");
361   }
362   /* set the new current component of the tree */
363   current_routing = new_as;
364 }
365
366 /**
367  * \brief Specify that the current description of AS is finished
368  *
369  * Once you've declared all the content of your AS, you have to close
370  * it with this call. Your AS is not usable until you call this function.
371  *
372  * @fixme: this call is not as robust as wanted: bad things WILL happen
373  * if you call it twice for the same AS, or if you forget calling it, or
374  * even if you add stuff to a closed AS
375  *
376  */
377 void routing_AS_end()
378 {
379
380   if (current_routing == NULL) {
381     THROWF(arg_error, 0, "Close an AS, but none was under construction");
382   } else {
383     network_element_info_t info = NULL;
384     xbt_assert(!xbt_lib_get_or_null
385                (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
386                "The AS \"%s\" already exists", current_routing->name);
387     info = xbt_new0(s_network_element_info_t, 1);
388     info->rc_component = current_routing->routing_father;
389     info->rc_type = SURF_NETWORK_ELEMENT_AS;
390     xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
391                 (void *) info);
392
393     if (current_routing->model_desc->end)
394       current_routing->model_desc->end(current_routing);
395     current_routing = current_routing->routing_father;
396   }
397 }
398
399 /* Aux Business methods */
400
401 /**
402  * \brief Get the AS father and the first elements of the chain
403  *
404  * \param src the source host name 
405  * \param dst the destination host name
406  * 
407  * Get the common father of the to processing units, and the first different 
408  * father in the chain
409  */
410 static void elements_father(const char *src, const char *dst,
411                             AS_t * res_father,
412                             AS_t * res_src,
413                             AS_t * res_dst)
414 {
415   xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
416 #define ELEMENTS_FATHER_MAXDEPTH 16     /* increase if it is not enough */
417   AS_t src_as, dst_as;
418   AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
419   AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
420   int index_src = 0;
421   int index_dst = 0;
422   AS_t current;
423   AS_t current_src;
424   AS_t current_dst;
425   AS_t father;
426
427   /* (1) find the as where the src and dst are located */
428   network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
429                                                         ROUTING_HOST_LEVEL);
430   network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
431                                                         ROUTING_HOST_LEVEL);
432   if (!src_data)
433     src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
434   if (!dst_data)
435     dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
436   src_as = src_data->rc_component;
437   dst_as = dst_data->rc_component;
438
439   xbt_assert(src_as && dst_as,
440              "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
441
442   /* (2) find the path to the root routing component */
443   for (current = src_as; current != NULL; current = current->routing_father) {
444     if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
445       xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
446     path_src[index_src++] = current;
447   }
448   for (current = dst_as; current != NULL; current = current->routing_father) {
449     if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
450       xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
451     path_dst[index_dst++] = current;
452   }
453
454   /* (3) find the common father */
455   do {
456     current_src = path_src[--index_src];
457     current_dst = path_dst[--index_dst];
458   } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
459
460   /* (4) they are not in the same routing component, make the path */
461   if (current_src == current_dst)
462     father = current_src;
463   else
464     father = path_src[index_src + 1];
465
466   /* (5) result generation */
467   *res_father = father;         /* first the common father of src and dst */
468   *res_src = current_src;       /* second the first different father of src */
469   *res_dst = current_dst;       /* three  the first different father of dst */
470
471 #undef ELEMENTS_FATHER_MAXDEPTH
472 }
473
474 /* Global Business methods */
475
476 /**
477  * \brief Recursive function for get_route_latency
478  *
479  * \param src the source host name 
480  * \param dst the destination host name
481  * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
482  * \param *latency the latency, if needed
483  * 
484  * This function is called by "get_route" and "get_latency". It allows to walk
485  * recursively through the ASes tree.
486  */
487 static void _get_route_and_latency(const char *src, const char *dst,
488                                    xbt_dynar_t * links, double *latency)
489 {
490   void *link;
491   unsigned int cpt;
492   s_route_t route;
493   memset(&route,0,sizeof(route));
494
495   XBT_DEBUG("Solve route/latency  \"%s\" to \"%s\"", src, dst);
496   xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
497
498   /* Find how src and dst are interconnected */
499   AS_t common_father, src_father, dst_father;
500   elements_father(src, dst, &common_father, &src_father, &dst_father);
501
502   /* If src and dst are in the same AS, life is good */
503   if (src_father == dst_father) {       /* SURF_ROUTING_BASE */
504
505     route.link_list = *links;
506
507     common_father->get_route_and_latency(common_father, src, dst, &route,latency);
508
509     xbt_free(route.src_gateway);
510     xbt_free(route.dst_gateway);
511     return;
512   }
513
514   /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
515
516   route_t e_route_bypass = NULL;
517   if (common_father->get_bypass_route)
518     e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
519
520   if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
521     if (latency)
522       xbt_die("Bypass cannot work yet with get_latency"); // FIXME: that limitation seems supurious to me -- check with alvin
523
524     *links = xbt_dynar_new(global_routing->size_of_link, NULL);
525
526     xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
527       xbt_dynar_push(*links, &link);
528     }
529
530     generic_free_route(e_route_bypass);
531     return;
532   }
533
534
535   /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
536
537   route_t e_route_cnt = xbt_new0(s_route_t, 1);
538   e_route_cnt->link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
539   common_father->get_route_and_latency(common_father, src_father->name, dst_father->name, e_route_cnt,latency);
540
541   xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
542       src_father->name, dst_father->name);
543
544   xbt_assert((e_route_cnt->src_gateway == NULL) ==
545       (e_route_cnt->dst_gateway == NULL),
546       "bad gateways for route from \"%s\" to \"%s\"", src, dst);
547
548   *links = xbt_dynar_new(global_routing->size_of_link, NULL);
549
550   char*src_gateway = e_route_cnt->src_gateway;
551   char*dst_gateway = e_route_cnt->dst_gateway;
552
553   /* If source gateway is not our source, we have to recursively find our way up to this point */
554   if (strcmp(src, src_gateway))
555     _get_route_and_latency(src, src_gateway, links, latency);
556
557   xbt_dynar_foreach(e_route_cnt->link_list, cpt, link) {
558     xbt_dynar_push(*links, &link);
559   }
560
561   /* If dest gateway is not our destination, we have to recursively find our way from this point */
562   // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
563   if (strcmp(dst_gateway, dst)) {
564     xbt_dynar_t route_dst = xbt_dynar_new(global_routing->size_of_link,NULL);
565
566     _get_route_and_latency(dst_gateway, dst, &route_dst, latency);
567
568     xbt_dynar_foreach(route_dst, cpt, link) {
569       xbt_dynar_push(*links, &link);
570     }
571     xbt_dynar_free(&route_dst);
572
573   }
574
575   generic_free_route(e_route_cnt);
576 }
577
578 /**
579  * \brief Find a route between hosts
580  *
581  * \param src the source host name
582  * \param dst the destination host name
583  * \param route where to store the list of links.
584  *              If *route=NULL, create a short lived dynar. Else, fill the provided dynar
585  * \param latency where to store the latency experienced on the path (or NULL if not interested)
586  *                It is the caller responsability to initialize latency to 0 (we add to provided route)
587  * \pre route!=NULL
588  *
589  * walk through the routing components tree and find a route between hosts
590  * by calling the differents "get_route" functions in each routing component.
591  */
592 void routing_get_route_and_latency(const char *src, const char *dst,
593                                    xbt_dynar_t * route, double *latency)
594 {
595   static xbt_dynar_t last_route = NULL;
596
597   int need_cleanup = !(*route);
598
599   if (need_cleanup) {
600     xbt_dynar_free(&last_route);
601     last_route = *route = xbt_dynar_new(global_routing->size_of_link,NULL);
602   }
603
604   _get_route_and_latency(src, dst, route, latency);
605
606   xbt_assert(!latency || *latency >= 0.0,
607              "negative latency on route between \"%s\" and \"%s\"", src, dst);
608 }
609
610 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
611 {
612   xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
613
614   //adding my one link routes
615   unsigned int cpt;
616   void *link;
617   xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
618   if (onelink_mine) {
619     xbt_dynar_foreach(onelink_mine, cpt, link) {
620       xbt_dynar_push(ret, &link);
621     }
622   }
623   //recursing
624   char *key;
625   xbt_dict_cursor_t cursor = NULL;
626   AS_t rc_child;
627   xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
628     xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
629     if (onelink_child) {
630       xbt_dynar_foreach(onelink_child, cpt, link) {
631         xbt_dynar_push(ret, &link);
632       }
633     }
634   }
635   return ret;
636 }
637
638 static xbt_dynar_t get_onelink_routes(void)
639 {
640   return recursive_get_onelink_routes(global_routing->root);
641 }
642
643 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
644 {
645   network_element_info_t rc = NULL;
646
647   rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
648   if (rc)
649     return rc->rc_type;
650
651   rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
652   if (rc)
653     return rc->rc_type;
654
655   return SURF_NETWORK_ELEMENT_NULL;
656 }
657
658 /**
659  * \brief Generic method: create the global routing schema
660  * 
661  * Make a global routing structure and set all the parsing functions.
662  */
663 void routing_model_create(size_t size_of_links, void *loopback)
664 {
665   /* config the uniq global routing */
666   global_routing = xbt_new0(s_routing_global_t, 1);
667   global_routing->root = NULL;
668   global_routing->get_onelink_routes = get_onelink_routes;
669   global_routing->loopback = loopback;
670   global_routing->size_of_link = size_of_links;
671   /* no current routing at moment */
672   current_routing = NULL;
673 }
674
675
676 /* ************************************************** */
677 /* ********** PATERN FOR NEW ROUTING **************** */
678
679 /* The minimal configuration of a new routing model need the next functions,
680  * also you need to set at the start of the file, the new model in the model
681  * list. Remember keep the null ending of the list.
682  */
683 /*** Routing model structure ***/
684 // typedef struct {
685 //   s_routing_component_t generic_routing;
686 //   /* things that your routing model need */
687 // } s_routing_component_NEW_t,*routing_component_NEW_t;
688
689 /*** Parse routing model functions ***/
690 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
691 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
692 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
693 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
694 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
695
696 /*** Business methods ***/
697 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
698 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
699 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
700
701 /*** Creation routing model functions ***/
702 // static void* model_NEW_create(void) {
703 //   routing_component_NEW_t new_component =  xbt_new0(s_routing_component_NEW_t,1);
704 //   new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
705 //   new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
706 //   new_component->generic_routing.set_route = model_NEW_set_route;
707 //   new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
708 //   new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
709 //   new_component->generic_routing.get_route = NEW_get_route;
710 //   new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
711 //   new_component->generic_routing.finalize = NEW_finalize;
712 //   /* initialization of internal structures */
713 //   return new_component;
714 // } /* mandatory */
715 // static void  model_NEW_load(void) {}   /* mandatory */
716 // static void  model_NEW_unload(void) {} /* mandatory */
717 // static void  model_NEW_end(void) {}    /* mandatory */
718
719 /* ************************************************************************** */
720 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
721
722
723 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
724 {
725   char *host_id, *groups, *link_id = NULL;
726   xbt_dict_t patterns = NULL;
727
728   s_sg_platf_host_cbarg_t host;
729   s_sg_platf_link_cbarg_t link;
730
731   unsigned int iter;
732   int start, end, i;
733   xbt_dynar_t radical_elements;
734   xbt_dynar_t radical_ends;
735
736   if (strcmp(cluster->availability_trace, "")
737       || strcmp(cluster->state_trace, "")) {
738     patterns = xbt_dict_new();
739     xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), free);
740     xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), free);
741     xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), free);
742   }
743
744
745   XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
746   sg_platf_new_AS_begin(cluster->id, "Cluster");
747
748   //Make all hosts
749   radical_elements = xbt_str_split(cluster->radical, ",");
750   xbt_dynar_foreach(radical_elements, iter, groups) {
751
752     radical_ends = xbt_str_split(groups, "-");
753     start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
754
755     switch (xbt_dynar_length(radical_ends)) {
756     case 1:
757       end = start;
758       break;
759     case 2:
760       end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
761       break;
762     default:
763       surf_parse_error("Malformed radical");
764       break;
765     }
766     for (i = start; i <= end; i++) {
767       host_id =
768           bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
769       link_id = bprintf("%s_link_%d", cluster->id, i);
770
771       XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
772
773       memset(&host, 0, sizeof(host));
774       host.id = host_id;
775       if (strcmp(cluster->availability_trace, "")) {
776         xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
777         char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
778         XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
779         host.power_trace = tmgr_trace_new(avail_file);
780         xbt_free(avail_file);
781       } else {
782         XBT_DEBUG("\tavailability_file=\"\"");
783       }
784
785       if (strcmp(cluster->state_trace, "")) {
786         char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
787         XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
788         host.state_trace = tmgr_trace_new(avail_file);
789         xbt_free(avail_file);
790       } else {
791         XBT_DEBUG("\tstate_file=\"\"");
792       }
793
794       host.power_peak = cluster->power;
795       host.power_scale = 1.0;
796       host.core_amount = cluster->core_amount;
797       host.initial_state = SURF_RESOURCE_ON;
798       host.coord = "";
799       sg_platf_new_host(&host);
800       XBT_DEBUG("</host>");
801
802       XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
803                 cluster->bw, cluster->lat);
804
805       memset(&link, 0, sizeof(link));
806       link.id = link_id;
807       link.bandwidth = cluster->bw;
808       link.latency = cluster->lat;
809       link.state = SURF_RESOURCE_ON;
810       link.policy = cluster->sharing_policy;
811       sg_platf_new_link(&link);
812
813       surf_parsing_link_up_down_t info =
814           xbt_new0(s_surf_parsing_link_up_down_t, 1);
815       if (link.policy == SURF_LINK_FULLDUPLEX) {
816         char *tmp_link = bprintf("%s_UP", link_id);
817         info->link_up =
818             xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
819         free(tmp_link);
820         tmp_link = bprintf("%s_DOWN", link_id);
821         info->link_down =
822             xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
823         free(tmp_link);
824       } else {
825         info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
826         info->link_down = info->link_up;
827       }
828       surf_routing_cluster_add_link(host_id, info);
829
830       xbt_free(link_id);
831       xbt_free(host_id);
832     }
833
834     xbt_dynar_free(&radical_ends);
835   }
836   xbt_dynar_free(&radical_elements);
837
838   // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
839   // and it's very useful to connect clusters together
840   XBT_DEBUG(" ");
841   XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
842   char *newid = NULL;
843   s_sg_platf_router_cbarg_t router;
844   memset(&router, 0, sizeof(router));
845   router.id = cluster->router_id;
846   router.coord = "";
847   if (!router.id || !strcmp(router.id, ""))
848     router.id = newid =
849         bprintf("%s%s_router%s", cluster->prefix, cluster->id,
850                 cluster->suffix);
851   sg_platf_new_router(&router);
852   free(newid);
853
854   //Make the backbone
855   if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
856     char *link_backbone = bprintf("%s_backbone", cluster->id);
857     XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
858               cluster->bb_bw, cluster->bb_lat);
859
860     memset(&link, 0, sizeof(link));
861     link.id = link_backbone;
862     link.bandwidth = cluster->bb_bw;
863     link.latency = cluster->bb_lat;
864     link.state = SURF_RESOURCE_ON;
865     link.policy = cluster->bb_sharing_policy;
866
867     sg_platf_new_link(&link);
868
869     surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
870
871     free(link_backbone);
872   }
873
874   XBT_DEBUG("</AS>");
875   sg_platf_new_AS_end();
876   XBT_DEBUG(" ");
877   xbt_dict_free(&patterns); // no op if it were never set
878 }
879
880 static void routing_parse_postparse(void) {
881   xbt_dict_free(&random_value);
882 }
883
884 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
885 {
886   static int AX_ptr = 0;
887   char *host_id = NULL;
888   char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
889
890   static unsigned int surfxml_buffer_stack_stack_ptr = 1;
891   static unsigned int surfxml_buffer_stack_stack[1024];
892
893   surfxml_buffer_stack_stack[0] = 0;
894
895   surfxml_bufferstack_push(1);
896
897   XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
898   sg_platf_new_AS_begin(peer->id, "Full");
899
900   XBT_DEBUG(" ");
901   host_id = HOST_PEER(peer->id);
902   router_id = ROUTER_PEER(peer->id);
903   link_id_up = LINK_UP_PEER(peer->id);
904   link_id_down = LINK_DOWN_PEER(peer->id);
905
906   link_router = bprintf("%s_link_router", peer->id);
907   link_backbone = bprintf("%s_backbone", peer->id);
908
909   XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
910   s_sg_platf_host_cbarg_t host;
911   memset(&host, 0, sizeof(host));
912   host.initial_state = SURF_RESOURCE_ON;
913   host.id = host_id;
914   host.power_peak = peer->power;
915   host.power_scale = 1.0;
916   host.power_trace = peer->availability_trace;
917   host.state_trace = peer->state_trace;
918   host.core_amount = 1;
919   host.coord = peer->coord;
920   sg_platf_new_host(&host);
921
922
923   XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
924   s_sg_platf_router_cbarg_t router;
925   memset(&router, 0, sizeof(router));
926   router.id = router_id;
927   router.coord = peer->coord;
928   sg_platf_new_router(&router);
929
930   XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
931             peer->bw_in, peer->lat);
932   s_sg_platf_link_cbarg_t link;
933   memset(&link, 0, sizeof(link));
934   link.state = SURF_RESOURCE_ON;
935   link.policy = SURF_LINK_SHARED;
936   link.id = link_id_up;
937   link.bandwidth = peer->bw_in;
938   link.latency = peer->lat;
939   sg_platf_new_link(&link);
940
941   // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
942   // Instead, it should be created fullduplex, and the models will do what's needed in this case
943   XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
944             peer->bw_out, peer->lat);
945   link.id = link_id_down;
946   sg_platf_new_link(&link);
947
948   XBT_DEBUG(" ");
949
950   // begin here
951   XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
952   XBT_DEBUG("symmetrical=\"NO\">");
953   SURFXML_BUFFER_SET(route_src, host_id);
954   SURFXML_BUFFER_SET(route_dst, router_id);
955   A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
956   SURFXML_START_TAG(route);
957
958   XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
959   SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
960   A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
961   SURFXML_START_TAG(link_ctn);
962   SURFXML_END_TAG(link_ctn);
963
964   XBT_DEBUG("</route>");
965   SURFXML_END_TAG(route);
966
967   //Opposite Route
968   XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
969   XBT_DEBUG("symmetrical=\"NO\">");
970   SURFXML_BUFFER_SET(route_src, router_id);
971   SURFXML_BUFFER_SET(route_dst, host_id);
972   A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
973   SURFXML_START_TAG(route);
974
975   XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
976   SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
977   A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
978   SURFXML_START_TAG(link_ctn);
979   SURFXML_END_TAG(link_ctn);
980
981   XBT_DEBUG("</route>");
982   SURFXML_END_TAG(route);
983
984   XBT_DEBUG("</AS>");
985   sg_platf_new_AS_end();
986   XBT_DEBUG(" ");
987
988   //xbt_dynar_free(&tab_elements_num);
989   free(host_id);
990   free(router_id);
991   free(link_router);
992   free(link_backbone);
993   free(link_id_up);
994   free(link_id_down);
995   surfxml_bufferstack_pop(1);
996 }
997
998 static void routing_parse_Srandom(void)
999 {
1000   double mean, std, min, max, seed;
1001   char *random_id = A_surfxml_random_id;
1002   char *random_radical = A_surfxml_random_radical;
1003   char *rd_name = NULL;
1004   char *rd_value;
1005   mean = surf_parse_get_double(A_surfxml_random_mean);
1006   std = surf_parse_get_double(A_surfxml_random_std_deviation);
1007   min = surf_parse_get_double(A_surfxml_random_min);
1008   max = surf_parse_get_double(A_surfxml_random_max);
1009   seed = surf_parse_get_double(A_surfxml_random_seed);
1010
1011   double res = 0;
1012   int i = 0;
1013   random_data_t random = xbt_new0(s_random_data_t, 1);
1014   char *tmpbuf;
1015
1016   xbt_dynar_t radical_elements;
1017   unsigned int iter;
1018   char *groups;
1019   int start, end;
1020   xbt_dynar_t radical_ends;
1021
1022   random->generator = A_surfxml_random_generator;
1023   random->seed = seed;
1024   random->min = min;
1025   random->max = max;
1026
1027   /* Check user stupidities */
1028   if (max < min)
1029     THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1030   if (mean < min)
1031     THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1032   if (mean > max)
1033     THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1034
1035   /* normalize the mean and standard deviation before storing */
1036   random->mean = (mean - min) / (max - min);
1037   random->std = std / (max - min);
1038
1039   if (random->mean * (1 - random->mean) < random->std * random->std)
1040     THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1041            random->mean, random->std);
1042
1043   XBT_DEBUG
1044       ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1045        random_id, random->min, random->max, random->mean, random->std,
1046        random->generator, random->seed, random_radical);
1047
1048   if (!random_value)
1049     random_value = xbt_dict_new();
1050
1051   if (!strcmp(random_radical, "")) {
1052     res = random_generate(random);
1053     rd_value = bprintf("%f", res);
1054     xbt_dict_set(random_value, random_id, rd_value, free);
1055   } else {
1056     radical_elements = xbt_str_split(random_radical, ",");
1057     xbt_dynar_foreach(radical_elements, iter, groups) {
1058       radical_ends = xbt_str_split(groups, "-");
1059       switch (xbt_dynar_length(radical_ends)) {
1060       case 1:
1061         xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1062                    "Custom Random '%s' already exists !", random_id);
1063         res = random_generate(random);
1064         tmpbuf =
1065             bprintf("%s%d", random_id,
1066                     atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1067         xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1068         xbt_free(tmpbuf);
1069         break;
1070
1071       case 2:
1072         start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1073         end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1074         for (i = start; i <= end; i++) {
1075           xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1076                      "Custom Random '%s' already exists !", bprintf("%s%d",
1077                                                                     random_id,
1078                                                                     i));
1079           res = random_generate(random);
1080           tmpbuf = bprintf("%s%d", random_id, i);
1081           xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1082           xbt_free(tmpbuf);
1083         }
1084         break;
1085       default:
1086         XBT_CRITICAL("Malformed radical");
1087         break;
1088       }
1089       res = random_generate(random);
1090       rd_name = bprintf("%s_router", random_id);
1091       rd_value = bprintf("%f", res);
1092       xbt_dict_set(random_value, rd_name, rd_value, free);
1093
1094       xbt_dynar_free(&radical_ends);
1095     }
1096     free(rd_name);
1097     xbt_dynar_free(&radical_elements);
1098   }
1099 }
1100
1101 void routing_register_callbacks()
1102 {
1103   sg_platf_host_add_cb(parse_S_host);
1104   sg_platf_router_add_cb(parse_S_router);
1105
1106   surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1107
1108   surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1109   surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1110   surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1111                        &routing_parse_S_bypassRoute);
1112
1113   surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1114
1115   surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1116   surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1117   surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1118                        &routing_parse_E_bypassRoute);
1119
1120   sg_platf_cluster_add_cb(routing_parse_cluster);
1121
1122   sg_platf_peer_add_cb(routing_parse_peer);
1123   sg_platf_postparse_add_cb(routing_parse_postparse);
1124
1125 #ifdef HAVE_TRACING
1126   instr_routing_define_callbacks();
1127 #endif
1128 }
1129
1130 /**
1131  * \brief Recursive function for finalize
1132  *
1133  * \param rc the source host name
1134  *
1135  * This fuction is call by "finalize". It allow to finalize the
1136  * AS or routing components. It delete all the structures.
1137  */
1138 static void finalize_rec(AS_t as) {
1139   xbt_dict_cursor_t cursor = NULL;
1140   char *key;
1141   AS_t elem;
1142
1143   xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1144     finalize_rec(elem);
1145   }
1146
1147   as->finalize(as);
1148 }
1149
1150 /** \brief Frees all memory allocated by the routing module */
1151 void routing_exit(void) {
1152   if (!global_routing)
1153     return;
1154   finalize_rec(global_routing->root);
1155   xbt_free(global_routing);
1156 }