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
31 * @ingroup SURF_build_api
32 * @brief A library containing all known links
35 int SD_LINK_LEVEL; //Simdag level
36 int SURF_LINK_LEVEL; //Surf level
37 int NS3_LINK_LEVEL; //link for ns3
39 xbt_lib_t as_router_lib;
40 int ROUTING_ASR_LEVEL; //Routing level
41 int COORD_ASR_LEVEL; //Coordinates level
42 int NS3_ASR_LEVEL; //host node for ns3
44 static xbt_dict_t random_value = NULL;
47 routing_global_t global_routing = NULL;
48 AS_t current_routing = NULL;
50 /* global parse functions */
51 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
52 extern xbt_dynar_t mount_list;
54 static const char *src = NULL; /* temporary store the source name of a route */
55 static const char *dst = NULL; /* temporary store the destination name of a route */
56 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
57 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
59 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
61 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
62 static void routing_parse_Srandom(void); /* random bypass */
64 static void routing_parse_postparse(void);
66 /* this lines are only for replace use like index in the model table */
71 SURF_MODEL_DIJKSTRACACHE,
78 struct s_model_type routing_models[] = {
80 "Full routing data (fast, large memory requirements, fully expressive)",
81 model_full_create, model_full_end},
83 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
84 model_floyd_create, model_floyd_end},
86 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
87 model_dijkstra_create, model_dijkstra_both_end},
89 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
90 model_dijkstracache_create, model_dijkstra_both_end},
91 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
92 model_none_create, NULL},
93 {"RuleBased", "Rule-Based routing data (...)",
94 model_rulebased_create, NULL},
95 {"Vivaldi", "Vivaldi routing",
96 model_vivaldi_create, NULL},
97 {"Cluster", "Cluster routing",
98 model_cluster_create, NULL},
99 {NULL, NULL, NULL, NULL}
103 * \brief Add a "host" to the network element list
105 static void parse_S_host(sg_platf_host_cbarg_t host)
107 network_element_t info = NULL;
108 if (current_routing->hierarchy == SURF_ROUTING_NULL)
109 current_routing->hierarchy = SURF_ROUTING_BASE;
110 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
111 "Reading a host, processing unit \"%s\" already exists", host->id);
113 info = xbt_new0(s_network_element_t, 1);
114 info->rc_component = current_routing;
115 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
116 info->name = xbt_strdup(host->id);
117 info->id = current_routing->parse_PU(current_routing, (void *) info);
118 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
119 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
122 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
126 if (host->coord && strcmp(host->coord, "")) {
130 if (!COORD_HOST_LEVEL)
131 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
132 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
133 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
134 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
135 xbt_dynar_foreach(ctn_str,cursor, str) {
136 double val = atof(str);
137 xbt_dynar_push(ctn,&val);
139 xbt_dynar_shrink(ctn, 0);
140 xbt_dynar_free(&ctn_str);
141 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
142 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
147 * \brief Add a "router" to the network element list
149 static void parse_S_router(sg_platf_router_cbarg_t router)
151 network_element_t info = NULL;
152 if (current_routing->hierarchy == SURF_ROUTING_NULL)
153 current_routing->hierarchy = SURF_ROUTING_BASE;
154 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
155 "Reading a router, processing unit \"%s\" already exists",
158 info = xbt_new0(s_network_element_t, 1);
159 info->rc_component = current_routing;
160 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
161 info->name = xbt_strdup(router->id);
162 info->id = current_routing->parse_PU(current_routing, (void *) info);
163 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
164 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
166 if (strcmp(router->coord, "")) {
170 if (!COORD_ASR_LEVEL)
171 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
172 /* Pre-parse the host coordinates */
173 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
174 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
175 xbt_dynar_foreach(ctn_str,cursor, str) {
176 double val = atof(str);
177 xbt_dynar_push(ctn,&val);
179 xbt_dynar_shrink(ctn, 0);
180 xbt_dynar_free(&ctn_str);
181 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
182 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
188 * \brief Set the end points for a route
190 static void routing_parse_S_route(void)
192 if (src != NULL && dst != NULL && parsed_link_list != NULL)
193 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
194 A_surfxml_route_src, A_surfxml_route_dst);
195 src = A_surfxml_route_src;
196 dst = A_surfxml_route_dst;
197 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
198 "Some limits are null in the route between \"%s\" and \"%s\"",
200 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
204 * \brief Set the end points and gateways for a ASroute
206 static void routing_parse_S_ASroute(void)
208 if (src != NULL && dst != NULL && parsed_link_list != NULL)
209 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
210 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
211 src = A_surfxml_ASroute_src;
212 dst = A_surfxml_ASroute_dst;
213 gw_src = A_surfxml_ASroute_gw_src;
214 gw_dst = A_surfxml_ASroute_gw_dst;
215 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
216 || strlen(gw_dst) > 0,
217 "Some limits are null in the route between \"%s\" and \"%s\"",
219 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
223 * \brief Set the end points for a bypassRoute
225 static void routing_parse_S_bypassRoute(void)
227 if (src != NULL && dst != NULL && parsed_link_list != NULL)
229 "Bypass Route between %s to %s can not be defined",
230 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
231 src = A_surfxml_bypassRoute_src;
232 dst = A_surfxml_bypassRoute_dst;
235 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
236 || strlen(gw_dst) > 0,
237 "Some limits are null in the route between \"%s\" and \"%s\"",
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 if (src != NULL && dst != NULL && parsed_link_list != NULL)
249 "Bypass AS Route between %s to %s can not be defined",
250 A_surfxml_bypassASroute_src, A_surfxml_bypassASroute_dst);
251 src = A_surfxml_bypassASroute_src;
252 dst = A_surfxml_bypassASroute_dst;
253 gw_src = A_surfxml_bypassASroute_gw_src;
254 gw_dst = A_surfxml_bypassASroute_gw_dst;
255 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
256 || strlen(gw_dst) > 0,
257 "Some limits are null in the route between \"%s\" and \"%s\"",
259 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
262 * \brief Set a new link on the actual list of link for a route or ASroute from XML
265 static void routing_parse_link_ctn(void)
268 switch (A_surfxml_link_ctn_direction) {
269 case AU_surfxml_link_ctn_direction:
270 case A_surfxml_link_ctn_direction_NONE:
271 link_id = xbt_strdup(A_surfxml_link_ctn_id);
273 case A_surfxml_link_ctn_direction_UP:
274 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
276 case A_surfxml_link_ctn_direction_DOWN:
277 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
280 xbt_dynar_push(parsed_link_list, &link_id);
284 * \brief Store the route by calling the set_route function of the current routing component
286 static void routing_parse_E_route(void)
288 route_t route = xbt_new0(s_route_t, 1);
289 route->link_list = parsed_link_list;
290 xbt_assert(current_routing->parse_route,
291 "no defined method \"set_route\" in \"%s\"",
292 current_routing->name);
293 current_routing->parse_route(current_routing, src, dst, route);
294 generic_free_route(route);
295 parsed_link_list = NULL;
301 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
303 static void routing_parse_E_ASroute(void)
305 route_t e_route = xbt_new0(s_route_t, 1);
306 e_route->link_list = parsed_link_list;
308 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
309 e_route->src_gateway = (network_element_t) gw_src; // DIRTY HACK possible only
310 e_route->dst_gateway = (network_element_t) gw_dst; // because of what is in routing_parse_E_ASroute
312 e_route->src_gateway = xbt_lib_get_or_null(as_router_lib, gw_src,
314 if (!e_route->src_gateway)
315 e_route->src_gateway = xbt_lib_get_or_null(host_lib, gw_src,
317 e_route->dst_gateway = xbt_lib_get_or_null(as_router_lib, gw_dst,
319 if (!e_route->dst_gateway)
320 e_route->dst_gateway = xbt_lib_get_or_null(host_lib, gw_dst,
323 xbt_assert(current_routing->parse_ASroute,
324 "no defined method \"set_ASroute\" in \"%s\"",
325 current_routing->name);
326 current_routing->parse_ASroute(current_routing, src, dst, e_route);
327 generic_free_route(e_route);
328 parsed_link_list = NULL;
336 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
338 static void routing_parse_E_bypassRoute(void)
340 route_t e_route = xbt_new0(s_route_t, 1);
341 e_route->link_list = parsed_link_list;
343 xbt_assert(current_routing->parse_bypassroute,
344 "Bypassing mechanism not implemented by routing '%s'",
345 current_routing->name);
347 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
348 parsed_link_list = NULL;
355 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
357 static void routing_parse_E_bypassASroute(void)
359 route_t e_route = xbt_new0(s_route_t, 1);
360 e_route->link_list = parsed_link_list;
361 e_route->src_gateway = xbt_lib_get_or_null(as_router_lib, gw_src,
363 if (!e_route->src_gateway)
364 e_route->src_gateway = xbt_lib_get_or_null(host_lib, gw_src,
366 e_route->dst_gateway = xbt_lib_get_or_null(as_router_lib, gw_dst,
368 if (!e_route->dst_gateway)
369 e_route->dst_gateway = xbt_lib_get_or_null(host_lib, gw_dst,
371 xbt_assert(current_routing->parse_bypassroute,
372 "Bypassing mechanism not implemented by routing '%s'",
373 current_routing->name);
374 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
375 parsed_link_list = NULL;
383 * \brief Make a new routing component to the platform
385 * Add a new autonomous system to the platform. Any elements (such as host,
386 * router or sub-AS) added after this call and before the corresponding call
387 * to sg_platf_new_AS_close() will be added to this AS.
389 * Once this function was called, the configuration concerning the used
390 * models cannot be changed anymore.
392 * @param AS_id name of this autonomous system. Must be unique in the platform
393 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
395 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
398 routing_model_description_t model = NULL;
401 xbt_assert(!xbt_lib_get_or_null
402 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
403 "The AS \"%s\" already exists", AS_id);
405 /* search the routing model */
406 for (cpt = 0; routing_models[cpt].name; cpt++)
407 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
408 model = &routing_models[cpt];
409 /* if its not exist, error */
411 fprintf(stderr, "Routing model %s not found. Existing models:\n",
412 wanted_routing_type);
413 for (cpt = 0; routing_models[cpt].name; cpt++)
414 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
415 routing_models[cpt].desc);
419 /* make a new routing component */
420 new_as = (AS_t) model->create();
421 new_as->model_desc = model;
422 new_as->hierarchy = SURF_ROUTING_NULL;
423 new_as->name = xbt_strdup(AS_id);
425 network_element_t info = NULL;
426 info = xbt_new0(s_network_element_t, 1);
428 if (current_routing == NULL && global_routing->root == NULL) {
430 /* it is the first one */
431 new_as->routing_father = NULL;
432 global_routing->root = new_as;
434 } else if (current_routing != NULL && global_routing->root != NULL) {
436 xbt_assert(!xbt_dict_get_or_null
437 (current_routing->routing_sons, AS_id),
438 "The AS \"%s\" already exists", AS_id);
439 /* it is a part of the tree */
440 new_as->routing_father = current_routing;
441 /* set the father behavior */
442 if (current_routing->hierarchy == SURF_ROUTING_NULL)
443 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
444 /* add to the sons dictionary */
445 xbt_dict_set(current_routing->routing_sons, AS_id,
446 (void *) new_as, NULL);
447 /* add to the father element list */
448 info->id = current_routing->parse_AS(current_routing, (void *) info);
450 THROWF(arg_error, 0, "All defined components must be belong to a AS");
453 info->rc_component = new_as->routing_father;
454 info->rc_type = SURF_NETWORK_ELEMENT_AS;
455 info->name = new_as->name;
457 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
459 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
461 /* set the new current component of the tree */
462 current_routing = new_as;
463 current_routing->net_elem = info;
468 * \brief Specify that the current description of AS is finished
470 * Once you've declared all the content of your AS, you have to close
471 * it with this call. Your AS is not usable until you call this function.
473 * @fixme: this call is not as robust as wanted: bad things WILL happen
474 * if you call it twice for the same AS, or if you forget calling it, or
475 * even if you add stuff to a closed AS
478 void routing_AS_end()
481 if (current_routing == NULL) {
482 THROWF(arg_error, 0, "Close an AS, but none was under construction");
484 if (current_routing->model_desc->end)
485 current_routing->model_desc->end(current_routing);
486 current_routing = current_routing->routing_father;
490 /* Aux Business methods */
493 * \brief Get the AS father and the first elements of the chain
495 * \param src the source host name
496 * \param dst the destination host name
498 * Get the common father of the to processing units, and the first different
499 * father in the chain
501 static void elements_father(network_element_t src, network_element_t dst,
506 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
507 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
509 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
510 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
518 /* (1) find the as where the src and dst are located */
519 network_element_t src_data = src;
520 network_element_t dst_data = dst;
521 src_as = src_data->rc_component;
522 dst_as = dst_data->rc_component;
524 char* src_name = src_data->name;
525 char* dst_name = dst_data->name;
528 xbt_assert(src_as && dst_as,
529 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
531 /* (2) find the path to the root routing component */
532 for (current = src_as; current != NULL; current = current->routing_father) {
533 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
534 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
535 path_src[index_src++] = current;
537 for (current = dst_as; current != NULL; current = current->routing_father) {
538 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
539 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
540 path_dst[index_dst++] = current;
543 /* (3) find the common father */
545 current_src = path_src[--index_src];
546 current_dst = path_dst[--index_dst];
547 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
549 /* (4) they are not in the same routing component, make the path */
550 if (current_src == current_dst)
551 father = current_src;
553 father = path_src[index_src + 1];
555 /* (5) result generation */
556 *res_father = father; /* first the common father of src and dst */
557 *res_src = current_src; /* second the first different father of src */
558 *res_dst = current_dst; /* three the first different father of dst */
560 #undef ELEMENTS_FATHER_MAXDEPTH
563 /* Global Business methods */
566 * \brief Recursive function for get_route_latency
568 * \param src the source host name
569 * \param dst the destination host name
570 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
571 * \param *latency the latency, if needed
573 * This function is called by "get_route" and "get_latency". It allows to walk
574 * recursively through the ASes tree.
576 static void _get_route_and_latency(network_element_t src, network_element_t dst,
577 xbt_dynar_t * links, double *latency)
580 memset(&route,0,sizeof(route));
582 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
583 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
585 /* Find how src and dst are interconnected */
586 AS_t common_father, src_father, dst_father;
587 elements_father(src, dst, &common_father, &src_father, &dst_father);
588 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
589 common_father->name,src_father->name,dst_father->name);
591 /* Check whether a direct bypass is defined */
592 route_t e_route_bypass = NULL;
593 if (common_father->get_bypass_route)
594 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
596 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
597 if (e_route_bypass) {
598 xbt_dynar_merge(links,&(e_route_bypass->link_list));
599 generic_free_route(e_route_bypass);
603 /* If src and dst are in the same AS, life is good */
604 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
606 route.link_list = *links;
608 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
612 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
614 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
615 // Find the net_card corresponding to father
616 network_element_t src_father_net_elm = src_father->net_elem;
617 network_element_t dst_father_net_elm = dst_father->net_elem;
619 common_father->get_route_and_latency(common_father, src_father_net_elm, dst_father_net_elm, &route,latency);
621 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
622 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
624 network_element_t src_gateway_net_elm = route.src_gateway;
625 network_element_t dst_gateway_net_elm = route.dst_gateway;
627 /* If source gateway is not our source, we have to recursively find our way up to this point */
628 if (src != src_gateway_net_elm)
629 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
631 xbt_dynar_merge(links,&(route.link_list));
633 /* If dest gateway is not our destination, we have to recursively find our way from this point */
634 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
635 if (dst_gateway_net_elm != dst) {
636 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
638 xbt_dynar_free(&route.link_list);
642 * \brief Find a route between hosts
644 * \param src the network_element_t for src host
645 * \param dst the network_element_t for dst host
646 * \param route where to store the list of links.
647 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
648 * \param latency where to store the latency experienced on the path (or NULL if not interested)
649 * It is the caller responsability to initialize latency to 0 (we add to provided route)
652 * walk through the routing components tree and find a route between hosts
653 * by calling the differents "get_route" functions in each routing component.
655 void routing_get_route_and_latency(network_element_t src,
656 network_element_t dst,
657 xbt_dynar_t * route, double *latency)
659 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
661 xbt_dynar_reset(global_routing->last_route);
662 *route = global_routing->last_route;
665 _get_route_and_latency(src, dst, route, latency);
667 xbt_assert(!latency || *latency >= 0.0,
668 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
671 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
673 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
675 //adding my one link routes
676 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
678 xbt_dynar_merge(&ret,&onelink_mine);
682 xbt_dict_cursor_t cursor = NULL;
684 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
685 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
687 xbt_dynar_merge(&ret,&onelink_child);
692 static xbt_dynar_t get_onelink_routes(void)
694 return recursive_get_onelink_routes(global_routing->root);
697 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
699 network_element_t rc = NULL;
701 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
705 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
709 return SURF_NETWORK_ELEMENT_NULL;
713 * \brief Generic method: create the global routing schema
715 * Make a global routing structure and set all the parsing functions.
717 void routing_model_create( void *loopback)
719 /* config the uniq global routing */
720 global_routing = xbt_new0(s_routing_global_t, 1);
721 global_routing->root = NULL;
722 global_routing->get_onelink_routes = get_onelink_routes;
723 global_routing->loopback = loopback;
724 global_routing->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
725 /* no current routing at moment */
726 current_routing = NULL;
730 /* ************************************************** */
731 /* ********** PATERN FOR NEW ROUTING **************** */
733 /* The minimal configuration of a new routing model need the next functions,
734 * also you need to set at the start of the file, the new model in the model
735 * list. Remember keep the null ending of the list.
737 /*** Routing model structure ***/
739 // s_routing_component_t generic_routing;
740 // /* things that your routing model need */
741 // } s_routing_component_NEW_t,*routing_component_NEW_t;
743 /*** Parse routing model functions ***/
744 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
745 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
746 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
747 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
748 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
750 /*** Business methods ***/
751 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
752 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
753 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
755 /*** Creation routing model functions ***/
756 // static void* model_NEW_create(void) {
757 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
758 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
759 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
760 // new_component->generic_routing.set_route = model_NEW_set_route;
761 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
762 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
763 // new_component->generic_routing.get_route = NEW_get_route;
764 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
765 // new_component->generic_routing.finalize = NEW_finalize;
766 // /* initialization of internal structures */
767 // return new_component;
769 // static void model_NEW_load(void) {} /* mandatory */
770 // static void model_NEW_unload(void) {} /* mandatory */
771 // static void model_NEW_end(void) {} /* mandatory */
773 /* ************************************************************************** */
774 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
776 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
778 char *host_id, *groups, *link_id = NULL;
779 xbt_dict_t patterns = NULL;
781 s_sg_platf_host_cbarg_t host;
782 s_sg_platf_link_cbarg_t link;
786 xbt_dynar_t radical_elements;
787 xbt_dynar_t radical_ends;
789 if (strcmp(cluster->availability_trace, "")
790 || strcmp(cluster->state_trace, "")) {
791 patterns = xbt_dict_new_homogeneous(xbt_free_f);
792 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
793 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
794 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
797 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
798 sg_platf_new_AS_begin(cluster->id, "Cluster");
800 current_routing->link_up_down_list
801 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
804 radical_elements = xbt_str_split(cluster->radical, ",");
805 xbt_dynar_foreach(radical_elements, iter, groups) {
807 radical_ends = xbt_str_split(groups, "-");
808 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
810 switch (xbt_dynar_length(radical_ends)) {
815 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
818 surf_parse_error("Malformed radical");
821 for (i = start; i <= end; i++) {
823 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
824 link_id = bprintf("%s_link_%d", cluster->id, i);
826 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
828 memset(&host, 0, sizeof(host));
830 if (strcmp(cluster->availability_trace, "")) {
831 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
832 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
833 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
834 host.power_trace = tmgr_trace_new(avail_file);
835 xbt_free(avail_file);
837 XBT_DEBUG("\tavailability_file=\"\"");
840 if (strcmp(cluster->state_trace, "")) {
841 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
842 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
843 host.state_trace = tmgr_trace_new(avail_file);
844 xbt_free(avail_file);
846 XBT_DEBUG("\tstate_file=\"\"");
849 host.power_peak = cluster->power;
850 host.power_scale = 1.0;
851 host.core_amount = cluster->core_amount;
852 host.initial_state = SURF_RESOURCE_ON;
854 sg_platf_new_host(&host);
855 XBT_DEBUG("</host>");
857 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
858 cluster->bw, cluster->lat);
860 memset(&link, 0, sizeof(link));
862 link.bandwidth = cluster->bw;
863 link.latency = cluster->lat;
864 link.state = SURF_RESOURCE_ON;
865 link.policy = cluster->sharing_policy;
866 sg_platf_new_link(&link);
868 s_surf_parsing_link_up_down_t info;
870 if (link.policy == SURF_LINK_FULLDUPLEX) {
871 char *tmp_link = bprintf("%s_UP", link_id);
873 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
875 tmp_link = bprintf("%s_DOWN", link_id);
877 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
880 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
881 info.link_down = info.link_up;
883 xbt_dynar_push(current_routing->link_up_down_list,&info);
888 xbt_dynar_free(&radical_ends);
890 xbt_dynar_free(&radical_elements);
892 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
893 // and it's very useful to connect clusters together
895 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
897 s_sg_platf_router_cbarg_t router;
898 memset(&router, 0, sizeof(router));
899 router.id = cluster->router_id;
901 if (!router.id || !strcmp(router.id, ""))
903 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
905 sg_platf_new_router(&router);
909 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
910 char *link_backbone = bprintf("%s_backbone", cluster->id);
911 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
912 cluster->bb_bw, cluster->bb_lat);
914 memset(&link, 0, sizeof(link));
915 link.id = link_backbone;
916 link.bandwidth = cluster->bb_bw;
917 link.latency = cluster->bb_lat;
918 link.state = SURF_RESOURCE_ON;
919 link.policy = cluster->bb_sharing_policy;
921 sg_platf_new_link(&link);
923 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
929 sg_platf_new_AS_end();
931 xbt_dict_free(&patterns); // no op if it were never set
934 static void routing_parse_postparse(void) {
935 xbt_dict_free(&random_value);
938 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
940 static int AX_ptr = 0;
941 char *host_id = NULL;
942 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
944 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
945 static unsigned int surfxml_buffer_stack_stack[1024];
947 surfxml_buffer_stack_stack[0] = 0;
949 surfxml_bufferstack_push(1);
951 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
952 sg_platf_new_AS_begin(peer->id, "Full");
955 host_id = HOST_PEER(peer->id);
956 router_id = ROUTER_PEER(peer->id);
957 link_id_up = LINK_UP_PEER(peer->id);
958 link_id_down = LINK_DOWN_PEER(peer->id);
960 link_router = bprintf("%s_link_router", peer->id);
961 link_backbone = bprintf("%s_backbone", peer->id);
963 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
964 s_sg_platf_host_cbarg_t host;
965 memset(&host, 0, sizeof(host));
966 host.initial_state = SURF_RESOURCE_ON;
968 host.power_peak = peer->power;
969 host.power_scale = 1.0;
970 host.power_trace = peer->availability_trace;
971 host.state_trace = peer->state_trace;
972 host.core_amount = 1;
973 host.coord = peer->coord;
974 sg_platf_new_host(&host);
977 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
978 s_sg_platf_router_cbarg_t router;
979 memset(&router, 0, sizeof(router));
980 router.id = router_id;
981 router.coord = peer->coord;
982 sg_platf_new_router(&router);
984 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
985 peer->bw_in, peer->lat);
986 s_sg_platf_link_cbarg_t link;
987 memset(&link, 0, sizeof(link));
988 link.state = SURF_RESOURCE_ON;
989 link.policy = SURF_LINK_SHARED;
990 link.id = link_id_up;
991 link.bandwidth = peer->bw_in;
992 link.latency = peer->lat;
993 sg_platf_new_link(&link);
995 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
996 // Instead, it should be created fullduplex, and the models will do what's needed in this case
997 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
998 peer->bw_out, peer->lat);
999 link.id = link_id_down;
1000 sg_platf_new_link(&link);
1005 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1006 XBT_DEBUG("symmetrical=\"NO\">");
1007 SURFXML_BUFFER_SET(route_src, host_id);
1008 SURFXML_BUFFER_SET(route_dst, router_id);
1009 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1010 SURFXML_START_TAG(route);
1012 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1013 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1014 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1015 SURFXML_START_TAG(link_ctn);
1016 SURFXML_END_TAG(link_ctn);
1018 XBT_DEBUG("</route>");
1019 SURFXML_END_TAG(route);
1022 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1023 XBT_DEBUG("symmetrical=\"NO\">");
1024 SURFXML_BUFFER_SET(route_src, router_id);
1025 SURFXML_BUFFER_SET(route_dst, host_id);
1026 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1027 SURFXML_START_TAG(route);
1029 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1030 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1031 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1032 SURFXML_START_TAG(link_ctn);
1033 SURFXML_END_TAG(link_ctn);
1035 XBT_DEBUG("</route>");
1036 SURFXML_END_TAG(route);
1039 sg_platf_new_AS_end();
1042 //xbt_dynar_free(&tab_elements_num);
1046 free(link_backbone);
1049 surfxml_bufferstack_pop(1);
1052 static void routing_parse_Srandom(void)
1054 double mean, std, min, max, seed;
1055 char *random_id = A_surfxml_random_id;
1056 char *random_radical = A_surfxml_random_radical;
1057 char *rd_name = NULL;
1059 mean = surf_parse_get_double(A_surfxml_random_mean);
1060 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1061 min = surf_parse_get_double(A_surfxml_random_min);
1062 max = surf_parse_get_double(A_surfxml_random_max);
1063 seed = surf_parse_get_double(A_surfxml_random_seed);
1067 random_data_t random = xbt_new0(s_random_data_t, 1);
1070 xbt_dynar_t radical_elements;
1074 xbt_dynar_t radical_ends;
1076 switch (A_surfxml_random_generator) {
1077 case AU_surfxml_random_generator:
1078 case A_surfxml_random_generator_NONE:
1079 random->generator = NONE;
1081 case A_surfxml_random_generator_DRAND48:
1082 random->generator = DRAND48;
1084 case A_surfxml_random_generator_RAND:
1085 random->generator = RAND;
1087 case A_surfxml_random_generator_RNGSTREAM:
1088 random->generator = RNGSTREAM;
1091 surf_parse_error("Invalid random generator");
1094 random->seed = seed;
1098 /* Check user stupidities */
1100 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1102 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1104 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1106 /* normalize the mean and standard deviation before storing */
1107 random->mean = (mean - min) / (max - min);
1108 random->std = std / (max - min);
1110 if (random->mean * (1 - random->mean) < random->std * random->std)
1111 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1112 random->mean, random->std);
1115 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1116 random_id, random->min, random->max, random->mean, random->std,
1117 (int)random->generator, random->seed, random_radical);
1120 random_value = xbt_dict_new_homogeneous(free);
1122 if (!strcmp(random_radical, "")) {
1123 res = random_generate(random);
1124 rd_value = bprintf("%f", res);
1125 xbt_dict_set(random_value, random_id, rd_value, NULL);
1127 radical_elements = xbt_str_split(random_radical, ",");
1128 xbt_dynar_foreach(radical_elements, iter, groups) {
1129 radical_ends = xbt_str_split(groups, "-");
1130 switch (xbt_dynar_length(radical_ends)) {
1132 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1133 "Custom Random '%s' already exists !", random_id);
1134 res = random_generate(random);
1136 bprintf("%s%d", random_id,
1137 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1138 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1143 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1144 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1145 for (i = start; i <= end; i++) {
1146 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1147 "Custom Random '%s' already exists !", bprintf("%s%d",
1150 res = random_generate(random);
1151 tmpbuf = bprintf("%s%d", random_id, i);
1152 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1157 XBT_CRITICAL("Malformed radical");
1160 res = random_generate(random);
1161 rd_name = bprintf("%s_router", random_id);
1162 rd_value = bprintf("%f", res);
1163 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1165 xbt_dynar_free(&radical_ends);
1168 xbt_dynar_free(&radical_elements);
1172 void routing_register_callbacks()
1174 sg_platf_host_add_cb(parse_S_host);
1175 sg_platf_router_add_cb(parse_S_router);
1177 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1179 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1180 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1181 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1182 &routing_parse_S_bypassRoute);
1183 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1184 &routing_parse_S_bypassASroute);
1186 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1188 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1189 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1190 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1191 &routing_parse_E_bypassRoute);
1192 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1193 &routing_parse_E_bypassASroute);
1195 sg_platf_cluster_add_cb(routing_parse_cluster);
1197 sg_platf_peer_add_cb(routing_parse_peer);
1198 sg_platf_postparse_add_cb(routing_parse_postparse);
1200 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1201 sg_platf_AS_end_add_cb(routing_AS_end);
1202 sg_platf_AS_begin_add_cb(routing_AS_begin);
1205 instr_routing_define_callbacks();
1210 * \brief Recursive function for finalize
1212 * \param rc the source host name
1214 * This fuction is call by "finalize". It allow to finalize the
1215 * AS or routing components. It delete all the structures.
1217 static void finalize_rec(AS_t as) {
1218 xbt_dict_cursor_t cursor = NULL;
1222 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1229 /** \brief Frees all memory allocated by the routing module */
1230 void routing_exit(void) {
1231 if (!global_routing)
1233 xbt_dynar_free(&global_routing->last_route);
1234 finalize_rec(global_routing->root);
1235 xbt_free(global_routing);