1 /* Copyright (c) 2009, 2010, 2011. 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 <pcre.h> /* regular expression library */
9 #include "simgrid/platf_interface.h" // platform creation API internal interface
11 #include "surf_routing_private.h"
12 #include "surf/surf_routing.h"
13 #include "surf/surfxml_parse_values.h"
16 * @ingroup SURF_build_api
17 * @brief A library containing all known workstations
21 int ROUTING_HOST_LEVEL; //Routing level
22 int SURF_CPU_LEVEL; //Surf cpu level
23 int SURF_WKS_LEVEL; //Surf workstation level
24 int SIMIX_HOST_LEVEL; //Simix level
25 int MSG_HOST_LEVEL; //Msg level
26 int SD_HOST_LEVEL; //Simdag level
27 int COORD_HOST_LEVEL=0; //Coordinates level
28 int NS3_HOST_LEVEL; //host node for ns3
30 xbt_dict_t watched_hosts_lib;
33 * @ingroup SURF_build_api
34 * @brief A library containing all known links
37 int SD_LINK_LEVEL; //Simdag level
38 int SURF_LINK_LEVEL; //Surf level
39 int NS3_LINK_LEVEL; //link for ns3
41 xbt_lib_t as_router_lib;
42 int ROUTING_ASR_LEVEL; //Routing level
43 int COORD_ASR_LEVEL; //Coordinates level
44 int NS3_ASR_LEVEL; //host node for ns3
46 static xbt_dict_t random_value = NULL;
48 /** @brief Retrieve a routing edge from its name
50 * Routing edges are either CPU/workstation and routers, whatever
52 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
53 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
54 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
59 routing_platf_t routing_platf = NULL;
60 AS_t current_routing = NULL;
62 /* global parse functions */
63 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
64 extern xbt_dynar_t mount_list;
66 static const char *src = NULL; /* temporary store the source name of a route */
67 static const char *dst = NULL; /* temporary store the destination name of a route */
68 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
69 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
71 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
73 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
74 static void routing_parse_Srandom(void); /* random bypass */
76 static void routing_parse_postparse(void);
78 /* this lines are only for replace use like index in the model table */
83 SURF_MODEL_DIJKSTRACACHE,
90 struct s_model_type routing_models[] = {
92 "Full routing data (fast, large memory requirements, fully expressive)",
93 model_full_create, model_full_end},
95 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
96 model_floyd_create, model_floyd_end},
98 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
99 model_dijkstra_create, model_dijkstra_both_end},
101 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
102 model_dijkstracache_create, model_dijkstra_both_end},
103 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
104 model_none_create, NULL},
105 {"RuleBased", "Rule-Based routing data (...)",
106 model_rulebased_create, NULL},
107 {"Vivaldi", "Vivaldi routing",
108 model_vivaldi_create, NULL},
109 {"Cluster", "Cluster routing",
110 model_cluster_create, NULL},
111 {NULL, NULL, NULL, NULL}
115 * \brief Add a "host" to the network element list
117 static void parse_S_host(sg_platf_host_cbarg_t host)
119 sg_routing_edge_t info = NULL;
120 if (current_routing->hierarchy == SURF_ROUTING_NULL)
121 current_routing->hierarchy = SURF_ROUTING_BASE;
122 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
123 "Reading a host, processing unit \"%s\" already exists", host->id);
125 info = xbt_new0(s_network_element_t, 1);
126 info->rc_component = current_routing;
127 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
128 info->name = xbt_strdup(host->id);
129 info->id = current_routing->parse_PU(current_routing, (void *) info);
130 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
131 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
134 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
138 if (host->coord && strcmp(host->coord, "")) {
142 if (!COORD_HOST_LEVEL)
143 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
144 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
145 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
146 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
147 xbt_dynar_foreach(ctn_str,cursor, str) {
148 double val = atof(str);
149 xbt_dynar_push(ctn,&val);
151 xbt_dynar_shrink(ctn, 0);
152 xbt_dynar_free(&ctn_str);
153 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
154 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
159 * \brief Add a "router" to the network element list
161 static void parse_S_router(sg_platf_router_cbarg_t router)
163 sg_routing_edge_t info = NULL;
164 if (current_routing->hierarchy == SURF_ROUTING_NULL)
165 current_routing->hierarchy = SURF_ROUTING_BASE;
166 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
167 "Reading a router, processing unit \"%s\" already exists",
170 info = xbt_new0(s_network_element_t, 1);
171 info->rc_component = current_routing;
172 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
173 info->name = xbt_strdup(router->id);
174 info->id = current_routing->parse_PU(current_routing, (void *) info);
175 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
176 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
178 if (strcmp(router->coord, "")) {
182 if (!COORD_ASR_LEVEL)
183 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
184 /* Pre-parse the host coordinates */
185 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
186 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
187 xbt_dynar_foreach(ctn_str,cursor, str) {
188 double val = atof(str);
189 xbt_dynar_push(ctn,&val);
191 xbt_dynar_shrink(ctn, 0);
192 xbt_dynar_free(&ctn_str);
193 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
194 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
200 * \brief Set the end points for a route
202 static void routing_parse_S_route(void)
204 src = A_surfxml_route_src;
205 dst = A_surfxml_route_dst;
206 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
207 "Missing end-points while defining route \"%s\"->\"%s\"",
209 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
213 * \brief Set the end points and gateways for a ASroute
215 static void routing_parse_S_ASroute(void)
217 src = A_surfxml_ASroute_src;
218 dst = A_surfxml_ASroute_dst;
219 gw_src = A_surfxml_ASroute_gw_src;
220 gw_dst = A_surfxml_ASroute_gw_dst;
221 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
222 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
223 src, dst,gw_src,gw_dst);
224 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
228 * \brief Set the end points for a bypassRoute
230 static void routing_parse_S_bypassRoute(void)
232 src = A_surfxml_bypassRoute_src;
233 dst = A_surfxml_bypassRoute_dst;
236 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
237 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
238 src, dst,gw_src,gw_dst);
239 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
243 * \brief Set the end points for a bypassASroute
245 static void routing_parse_S_bypassASroute(void)
247 src = A_surfxml_bypassASroute_src;
248 dst = A_surfxml_bypassASroute_dst;
249 gw_src = A_surfxml_bypassASroute_gw_src;
250 gw_dst = A_surfxml_bypassASroute_gw_dst;
251 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
252 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
253 src, dst,gw_src,gw_dst);
254 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
257 * \brief Set a new link on the actual list of link for a route or ASroute from XML
260 static void routing_parse_link_ctn(void)
263 switch (A_surfxml_link_ctn_direction) {
264 case AU_surfxml_link_ctn_direction:
265 case A_surfxml_link_ctn_direction_NONE:
266 link_id = xbt_strdup(A_surfxml_link_ctn_id);
268 case A_surfxml_link_ctn_direction_UP:
269 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
271 case A_surfxml_link_ctn_direction_DOWN:
272 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
275 xbt_dynar_push(parsed_link_list, &link_id);
279 * \brief Store the route by calling the set_route function of the current routing component
281 static void routing_parse_E_route(void)
283 route_t route = xbt_new0(s_route_t, 1);
284 route->link_list = parsed_link_list;
285 xbt_assert(current_routing->parse_route,
286 "no defined method \"set_route\" in \"%s\"",
287 current_routing->name);
288 current_routing->parse_route(current_routing, src, dst, route);
289 generic_free_route(route);
290 parsed_link_list = NULL;
296 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
298 static void routing_parse_E_ASroute(void)
300 route_t e_route = xbt_new0(s_route_t, 1);
301 e_route->link_list = parsed_link_list;
303 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
304 // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
305 // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
307 // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
308 e_route->src_gateway = (sg_routing_edge_t) gw_src;
309 e_route->dst_gateway = (sg_routing_edge_t) gw_dst;
311 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
312 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
314 xbt_assert(current_routing->parse_ASroute,
315 "no defined method \"set_ASroute\" in \"%s\"",
316 current_routing->name);
317 current_routing->parse_ASroute(current_routing, src, dst, e_route);
318 generic_free_route(e_route);
319 parsed_link_list = NULL;
327 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
329 static void routing_parse_E_bypassRoute(void)
331 route_t e_route = xbt_new0(s_route_t, 1);
332 e_route->link_list = parsed_link_list;
334 xbt_assert(current_routing->parse_bypassroute,
335 "Bypassing mechanism not implemented by routing '%s'",
336 current_routing->name);
338 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
339 parsed_link_list = NULL;
346 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
348 static void routing_parse_E_bypassASroute(void)
350 route_t e_route = xbt_new0(s_route_t, 1);
351 e_route->link_list = parsed_link_list;
352 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
353 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
354 xbt_assert(current_routing->parse_bypassroute,
355 "Bypassing mechanism not implemented by routing '%s'",
356 current_routing->name);
357 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
358 parsed_link_list = NULL;
366 * \brief Make a new routing component to the platform
368 * Add a new autonomous system to the platform. Any elements (such as host,
369 * router or sub-AS) added after this call and before the corresponding call
370 * to sg_platf_new_AS_close() will be added to this AS.
372 * Once this function was called, the configuration concerning the used
373 * models cannot be changed anymore.
375 * @param AS_id name of this autonomous system. Must be unique in the platform
376 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
378 void routing_AS_begin(const char *AS_id, int wanted_routing_type)
381 routing_model_description_t model = NULL;
383 xbt_assert(!xbt_lib_get_or_null
384 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
385 "The AS \"%s\" already exists", AS_id);
387 /* search the routing model */
388 switch(wanted_routing_type){
389 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
390 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
391 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
392 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
393 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
394 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
395 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
396 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
399 /* make a new routing component */
400 new_as = (AS_t) model->create();
401 new_as->model_desc = model;
402 new_as->hierarchy = SURF_ROUTING_NULL;
403 new_as->name = xbt_strdup(AS_id);
405 sg_routing_edge_t info = NULL;
406 info = xbt_new0(s_network_element_t, 1);
408 if (current_routing == NULL && routing_platf->root == NULL) {
410 /* it is the first one */
411 new_as->routing_father = NULL;
412 routing_platf->root = new_as;
414 } else if (current_routing != NULL && routing_platf->root != NULL) {
416 xbt_assert(!xbt_dict_get_or_null
417 (current_routing->routing_sons, AS_id),
418 "The AS \"%s\" already exists", AS_id);
419 /* it is a part of the tree */
420 new_as->routing_father = current_routing;
421 /* set the father behavior */
422 if (current_routing->hierarchy == SURF_ROUTING_NULL)
423 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
424 /* add to the sons dictionary */
425 xbt_dict_set(current_routing->routing_sons, AS_id,
426 (void *) new_as, NULL);
427 /* add to the father element list */
428 info->id = current_routing->parse_AS(current_routing, (void *) info);
430 THROWF(arg_error, 0, "All defined components must be belong to a AS");
433 info->rc_component = new_as->routing_father;
434 info->rc_type = SURF_NETWORK_ELEMENT_AS;
435 info->name = new_as->name;
437 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
439 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
441 /* set the new current component of the tree */
442 current_routing = new_as;
443 current_routing->net_elem = info;
448 * \brief Specify that the current description of AS is finished
450 * Once you've declared all the content of your AS, you have to close
451 * it with this call. Your AS is not usable until you call this function.
453 * @fixme: this call is not as robust as wanted: bad things WILL happen
454 * if you call it twice for the same AS, or if you forget calling it, or
455 * even if you add stuff to a closed AS
458 void routing_AS_end()
461 if (current_routing == NULL) {
462 THROWF(arg_error, 0, "Close an AS, but none was under construction");
464 if (current_routing->model_desc->end)
465 current_routing->model_desc->end(current_routing);
466 current_routing = current_routing->routing_father;
470 /* Aux Business methods */
473 * \brief Get the AS father and the first elements of the chain
475 * \param src the source host name
476 * \param dst the destination host name
478 * Get the common father of the to processing units, and the first different
479 * father in the chain
481 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
486 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
487 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
489 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
490 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
498 /* (1) find the as where the src and dst are located */
499 sg_routing_edge_t src_data = src;
500 sg_routing_edge_t dst_data = dst;
501 src_as = src_data->rc_component;
502 dst_as = dst_data->rc_component;
504 char* src_name = src_data->name;
505 char* dst_name = dst_data->name;
508 xbt_assert(src_as && dst_as,
509 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
511 /* (2) find the path to the root routing component */
512 for (current = src_as; current != NULL; current = current->routing_father) {
513 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
514 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
515 path_src[index_src++] = current;
517 for (current = dst_as; current != NULL; current = current->routing_father) {
518 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
519 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
520 path_dst[index_dst++] = current;
523 /* (3) find the common father */
525 current_src = path_src[--index_src];
526 current_dst = path_dst[--index_dst];
527 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
529 /* (4) they are not in the same routing component, make the path */
530 if (current_src == current_dst)
531 father = current_src;
533 father = path_src[index_src + 1];
535 /* (5) result generation */
536 *res_father = father; /* first the common father of src and dst */
537 *res_src = current_src; /* second the first different father of src */
538 *res_dst = current_dst; /* three the first different father of dst */
540 #undef ELEMENTS_FATHER_MAXDEPTH
543 /* Global Business methods */
546 * \brief Recursive function for get_route_latency
548 * \param src the source host name
549 * \param dst the destination host name
550 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
551 * \param *latency the latency, if needed
553 * This function is called by "get_route" and "get_latency". It allows to walk
554 * recursively through the ASes tree.
556 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
557 xbt_dynar_t * links, double *latency)
560 memset(&route,0,sizeof(route));
562 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
563 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
565 /* Find how src and dst are interconnected */
566 AS_t common_father, src_father, dst_father;
567 elements_father(src, dst, &common_father, &src_father, &dst_father);
568 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
569 common_father->name,src_father->name,dst_father->name);
571 /* Check whether a direct bypass is defined */
572 route_t e_route_bypass = NULL;
573 if (common_father->get_bypass_route)
574 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
576 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
577 if (e_route_bypass) {
578 xbt_dynar_merge(links, &e_route_bypass->link_list);
579 generic_free_route(e_route_bypass);
583 /* If src and dst are in the same AS, life is good */
584 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
585 route.link_list = *links;
586 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
587 // if vivaldi latency+=vivaldi(src,dst)
591 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
593 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
594 // Find the net_card corresponding to father
595 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
596 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
598 common_father->get_route_and_latency(common_father,
599 src_father_net_elm, dst_father_net_elm,
602 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
603 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
605 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
606 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
608 /* If source gateway is not our source, we have to recursively find our way up to this point */
609 if (src != src_gateway_net_elm)
610 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
611 xbt_dynar_merge(links, &route.link_list);
613 /* If dest gateway is not our destination, we have to recursively find our way from this point */
614 if (dst_gateway_net_elm != dst)
615 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
617 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
621 * \brief Find a route between hosts
623 * \param src the network_element_t for src host
624 * \param dst the network_element_t for dst host
625 * \param route where to store the list of links.
626 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
627 * \param latency where to store the latency experienced on the path (or NULL if not interested)
628 * It is the caller responsability to initialize latency to 0 (we add to provided route)
631 * walk through the routing components tree and find a route between hosts
632 * by calling the differents "get_route" functions in each routing component.
634 void routing_get_route_and_latency(sg_routing_edge_t src,
635 sg_routing_edge_t dst,
636 xbt_dynar_t * route, double *latency)
638 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
640 xbt_dynar_reset(routing_platf->last_route);
641 *route = routing_platf->last_route;
644 _get_route_and_latency(src, dst, route, latency);
646 xbt_assert(!latency || *latency >= 0.0,
647 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
650 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
652 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
654 //adding my one link routes
655 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
657 xbt_dynar_merge(&ret,&onelink_mine);
661 xbt_dict_cursor_t cursor = NULL;
663 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
664 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
666 xbt_dynar_merge(&ret,&onelink_child);
671 static xbt_dynar_t get_onelink_routes(void)
673 return recursive_get_onelink_routes(routing_platf->root);
676 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
678 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
682 return SURF_NETWORK_ELEMENT_NULL;
686 * \brief Generic method: create the global routing schema
688 * Make a global routing structure and set all the parsing functions.
690 void routing_model_create( void *loopback)
692 /* config the uniq global routing */
693 routing_platf = xbt_new0(s_routing_platf_t, 1);
694 routing_platf->root = NULL;
695 routing_platf->get_onelink_routes = get_onelink_routes;
696 routing_platf->loopback = loopback;
697 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
698 /* no current routing at moment */
699 current_routing = NULL;
703 /* ************************************************** */
704 /* ********** PATERN FOR NEW ROUTING **************** */
706 /* The minimal configuration of a new routing model need the next functions,
707 * also you need to set at the start of the file, the new model in the model
708 * list. Remember keep the null ending of the list.
710 /*** Routing model structure ***/
712 // s_routing_component_t generic_routing;
713 // /* things that your routing model need */
714 // } s_routing_component_NEW_t,*routing_component_NEW_t;
716 /*** Parse routing model functions ***/
717 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
718 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
719 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
720 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
721 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
723 /*** Business methods ***/
724 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
725 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
726 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
728 /*** Creation routing model functions ***/
729 // static void* model_NEW_create(void) {
730 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
731 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
732 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
733 // new_component->generic_routing.set_route = model_NEW_set_route;
734 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
735 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
736 // new_component->generic_routing.get_route = NEW_get_route;
737 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
738 // new_component->generic_routing.finalize = NEW_finalize;
739 // /* initialization of internal structures */
740 // return new_component;
742 // static void model_NEW_load(void) {} /* mandatory */
743 // static void model_NEW_unload(void) {} /* mandatory */
744 // static void model_NEW_end(void) {} /* mandatory */
746 /* ************************************************************************** */
747 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
749 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
751 char *host_id, *groups, *link_id = NULL;
752 xbt_dict_t patterns = NULL;
754 s_sg_platf_host_cbarg_t host;
755 s_sg_platf_link_cbarg_t link;
759 xbt_dynar_t radical_elements;
760 xbt_dynar_t radical_ends;
762 if (strcmp(cluster->availability_trace, "")
763 || strcmp(cluster->state_trace, "")) {
764 patterns = xbt_dict_new_homogeneous(xbt_free_f);
765 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
766 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
767 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
770 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
771 sg_platf_new_AS_begin(cluster->id, A_surfxml_AS_routing_Cluster);
773 current_routing->link_up_down_list
774 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
777 radical_elements = xbt_str_split(cluster->radical, ",");
778 xbt_dynar_foreach(radical_elements, iter, groups) {
780 radical_ends = xbt_str_split(groups, "-");
781 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
783 switch (xbt_dynar_length(radical_ends)) {
788 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
791 surf_parse_error("Malformed radical");
794 for (i = start; i <= end; i++) {
796 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
797 link_id = bprintf("%s_link_%d", cluster->id, i);
799 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
801 memset(&host, 0, sizeof(host));
803 if (strcmp(cluster->availability_trace, "")) {
804 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
805 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
806 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
807 host.power_trace = tmgr_trace_new_from_file(avail_file);
808 xbt_free(avail_file);
810 XBT_DEBUG("\tavailability_file=\"\"");
813 if (strcmp(cluster->state_trace, "")) {
814 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
815 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
816 host.state_trace = tmgr_trace_new_from_file(avail_file);
817 xbt_free(avail_file);
819 XBT_DEBUG("\tstate_file=\"\"");
822 host.power_peak = cluster->power;
823 host.power_scale = 1.0;
824 host.core_amount = cluster->core_amount;
825 host.initial_state = SURF_RESOURCE_ON;
827 sg_platf_new_host(&host);
828 XBT_DEBUG("</host>");
830 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
831 cluster->bw, cluster->lat);
833 memset(&link, 0, sizeof(link));
835 link.bandwidth = cluster->bw;
836 link.latency = cluster->lat;
837 link.state = SURF_RESOURCE_ON;
838 link.policy = cluster->sharing_policy;
839 sg_platf_new_link(&link);
841 s_surf_parsing_link_up_down_t info;
843 if (link.policy == SURF_LINK_FULLDUPLEX) {
844 char *tmp_link = bprintf("%s_UP", link_id);
846 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
848 tmp_link = bprintf("%s_DOWN", link_id);
850 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
853 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
854 info.link_down = info.link_up;
856 xbt_dynar_push(current_routing->link_up_down_list,&info);
861 xbt_dynar_free(&radical_ends);
863 xbt_dynar_free(&radical_elements);
865 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
866 // and it's very useful to connect clusters together
868 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
870 s_sg_platf_router_cbarg_t router;
871 memset(&router, 0, sizeof(router));
872 router.id = cluster->router_id;
874 if (!router.id || !strcmp(router.id, ""))
876 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
878 sg_platf_new_router(&router);
882 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
883 char *link_backbone = bprintf("%s_backbone", cluster->id);
884 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
885 cluster->bb_bw, cluster->bb_lat);
887 memset(&link, 0, sizeof(link));
888 link.id = link_backbone;
889 link.bandwidth = cluster->bb_bw;
890 link.latency = cluster->bb_lat;
891 link.state = SURF_RESOURCE_ON;
892 link.policy = cluster->bb_sharing_policy;
894 sg_platf_new_link(&link);
896 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
902 sg_platf_new_AS_end();
904 xbt_dict_free(&patterns); // no op if it were never set
907 static void routing_parse_postparse(void) {
908 xbt_dict_free(&random_value);
911 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
913 static int AX_ptr = 0;
914 char *host_id = NULL;
915 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
917 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
918 static unsigned int surfxml_buffer_stack_stack[1024];
920 surfxml_buffer_stack_stack[0] = 0;
922 surfxml_bufferstack_push(1);
924 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
925 sg_platf_new_AS_begin(peer->id, A_surfxml_AS_routing_Full);
928 host_id = HOST_PEER(peer->id);
929 router_id = ROUTER_PEER(peer->id);
930 link_id_up = LINK_UP_PEER(peer->id);
931 link_id_down = LINK_DOWN_PEER(peer->id);
933 link_router = bprintf("%s_link_router", peer->id);
934 link_backbone = bprintf("%s_backbone", peer->id);
936 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
937 s_sg_platf_host_cbarg_t host;
938 memset(&host, 0, sizeof(host));
939 host.initial_state = SURF_RESOURCE_ON;
941 host.power_peak = peer->power;
942 host.power_scale = 1.0;
943 host.power_trace = peer->availability_trace;
944 host.state_trace = peer->state_trace;
945 host.core_amount = 1;
946 host.coord = peer->coord;
947 sg_platf_new_host(&host);
950 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
951 s_sg_platf_router_cbarg_t router;
952 memset(&router, 0, sizeof(router));
953 router.id = router_id;
954 router.coord = peer->coord;
955 sg_platf_new_router(&router);
957 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
958 peer->bw_in, peer->lat);
959 s_sg_platf_link_cbarg_t link;
960 memset(&link, 0, sizeof(link));
961 link.state = SURF_RESOURCE_ON;
962 link.policy = SURF_LINK_SHARED;
963 link.id = link_id_up;
964 link.bandwidth = peer->bw_in;
965 link.latency = peer->lat;
966 sg_platf_new_link(&link);
968 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
969 // Instead, it should be created fullduplex, and the models will do what's needed in this case
970 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
971 peer->bw_out, peer->lat);
972 link.id = link_id_down;
973 sg_platf_new_link(&link);
978 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
979 XBT_DEBUG("symmetrical=\"NO\">");
980 SURFXML_BUFFER_SET(route_src, host_id);
981 SURFXML_BUFFER_SET(route_dst, router_id);
982 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
983 SURFXML_START_TAG(route);
985 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
986 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
987 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
988 SURFXML_START_TAG(link_ctn);
989 SURFXML_END_TAG(link_ctn);
991 XBT_DEBUG("</route>");
992 SURFXML_END_TAG(route);
995 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
996 XBT_DEBUG("symmetrical=\"NO\">");
997 SURFXML_BUFFER_SET(route_src, router_id);
998 SURFXML_BUFFER_SET(route_dst, host_id);
999 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1000 SURFXML_START_TAG(route);
1002 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1003 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1004 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1005 SURFXML_START_TAG(link_ctn);
1006 SURFXML_END_TAG(link_ctn);
1008 XBT_DEBUG("</route>");
1009 SURFXML_END_TAG(route);
1012 sg_platf_new_AS_end();
1015 //xbt_dynar_free(&tab_elements_num);
1019 free(link_backbone);
1022 surfxml_bufferstack_pop(1);
1025 static void routing_parse_Srandom(void)
1027 double mean, std, min, max, seed;
1028 char *random_id = A_surfxml_random_id;
1029 char *random_radical = A_surfxml_random_radical;
1030 char *rd_name = NULL;
1032 mean = surf_parse_get_double(A_surfxml_random_mean);
1033 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1034 min = surf_parse_get_double(A_surfxml_random_min);
1035 max = surf_parse_get_double(A_surfxml_random_max);
1036 seed = surf_parse_get_double(A_surfxml_random_seed);
1040 random_data_t random = xbt_new0(s_random_data_t, 1);
1043 xbt_dynar_t radical_elements;
1047 xbt_dynar_t radical_ends;
1049 switch (A_surfxml_random_generator) {
1050 case AU_surfxml_random_generator:
1051 case A_surfxml_random_generator_NONE:
1052 random->generator = NONE;
1054 case A_surfxml_random_generator_DRAND48:
1055 random->generator = DRAND48;
1057 case A_surfxml_random_generator_RAND:
1058 random->generator = RAND;
1060 case A_surfxml_random_generator_RNGSTREAM:
1061 random->generator = RNGSTREAM;
1064 surf_parse_error("Invalid random generator");
1067 random->seed = seed;
1071 /* Check user stupidities */
1073 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1075 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1077 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1079 /* normalize the mean and standard deviation before storing */
1080 random->mean = (mean - min) / (max - min);
1081 random->std = std / (max - min);
1083 if (random->mean * (1 - random->mean) < random->std * random->std)
1084 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1085 random->mean, random->std);
1088 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1089 random_id, random->min, random->max, random->mean, random->std,
1090 (int)random->generator, random->seed, random_radical);
1093 random_value = xbt_dict_new_homogeneous(free);
1095 if (!strcmp(random_radical, "")) {
1096 res = random_generate(random);
1097 rd_value = bprintf("%f", res);
1098 xbt_dict_set(random_value, random_id, rd_value, NULL);
1100 radical_elements = xbt_str_split(random_radical, ",");
1101 xbt_dynar_foreach(radical_elements, iter, groups) {
1102 radical_ends = xbt_str_split(groups, "-");
1103 switch (xbt_dynar_length(radical_ends)) {
1105 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1106 "Custom Random '%s' already exists !", random_id);
1107 res = random_generate(random);
1109 bprintf("%s%d", random_id,
1110 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1111 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1116 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1117 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1118 for (i = start; i <= end; i++) {
1119 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1120 "Custom Random '%s' already exists !", bprintf("%s%d",
1123 res = random_generate(random);
1124 tmpbuf = bprintf("%s%d", random_id, i);
1125 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1130 XBT_CRITICAL("Malformed radical");
1133 res = random_generate(random);
1134 rd_name = bprintf("%s_router", random_id);
1135 rd_value = bprintf("%f", res);
1136 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1138 xbt_dynar_free(&radical_ends);
1141 xbt_dynar_free(&radical_elements);
1145 void routing_register_callbacks()
1147 sg_platf_host_add_cb(parse_S_host);
1148 sg_platf_router_add_cb(parse_S_router);
1150 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1152 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1153 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1154 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1155 &routing_parse_S_bypassRoute);
1156 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1157 &routing_parse_S_bypassASroute);
1159 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1161 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1162 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1163 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1164 &routing_parse_E_bypassRoute);
1165 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1166 &routing_parse_E_bypassASroute);
1168 sg_platf_cluster_add_cb(routing_parse_cluster);
1170 sg_platf_peer_add_cb(routing_parse_peer);
1171 sg_platf_postparse_add_cb(routing_parse_postparse);
1173 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1174 sg_platf_AS_end_add_cb(routing_AS_end);
1175 sg_platf_AS_begin_add_cb(routing_AS_begin);
1178 instr_routing_define_callbacks();
1183 * \brief Recursive function for finalize
1185 * \param rc the source host name
1187 * This fuction is call by "finalize". It allow to finalize the
1188 * AS or routing components. It delete all the structures.
1190 static void finalize_rec(AS_t as) {
1191 xbt_dict_cursor_t cursor = NULL;
1195 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1202 /** \brief Frees all memory allocated by the routing module */
1203 void routing_exit(void) {
1206 xbt_dynar_free(&routing_platf->last_route);
1207 finalize_rec(routing_platf->root);
1208 xbt_free(routing_platf);