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;
46 /** @brief Retrieve a routing edge from its name
48 * Routing edges are either CPU/workstation and routers, whatever
50 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
51 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
52 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
57 routing_global_t global_routing = NULL;
58 AS_t current_routing = NULL;
60 /* global parse functions */
61 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
62 extern xbt_dynar_t mount_list;
64 static const char *src = NULL; /* temporary store the source name of a route */
65 static const char *dst = NULL; /* temporary store the destination name of a route */
66 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
67 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
69 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
71 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
72 static void routing_parse_Srandom(void); /* random bypass */
74 static void routing_parse_postparse(void);
76 /* this lines are only for replace use like index in the model table */
81 SURF_MODEL_DIJKSTRACACHE,
88 struct s_model_type routing_models[] = {
90 "Full routing data (fast, large memory requirements, fully expressive)",
91 model_full_create, model_full_end},
93 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
94 model_floyd_create, model_floyd_end},
96 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
97 model_dijkstra_create, model_dijkstra_both_end},
99 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
100 model_dijkstracache_create, model_dijkstra_both_end},
101 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
102 model_none_create, NULL},
103 {"RuleBased", "Rule-Based routing data (...)",
104 model_rulebased_create, NULL},
105 {"Vivaldi", "Vivaldi routing",
106 model_vivaldi_create, NULL},
107 {"Cluster", "Cluster routing",
108 model_cluster_create, NULL},
109 {NULL, NULL, NULL, NULL}
113 * \brief Add a "host" to the network element list
115 static void parse_S_host(sg_platf_host_cbarg_t host)
117 sg_routing_edge_t info = NULL;
118 if (current_routing->hierarchy == SURF_ROUTING_NULL)
119 current_routing->hierarchy = SURF_ROUTING_BASE;
120 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
121 "Reading a host, processing unit \"%s\" already exists", host->id);
123 info = xbt_new0(s_network_element_t, 1);
124 info->rc_component = current_routing;
125 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
126 info->name = xbt_strdup(host->id);
127 info->id = current_routing->parse_PU(current_routing, (void *) info);
128 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
129 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
132 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
136 if (host->coord && strcmp(host->coord, "")) {
140 if (!COORD_HOST_LEVEL)
141 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
142 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
143 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
144 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
145 xbt_dynar_foreach(ctn_str,cursor, str) {
146 double val = atof(str);
147 xbt_dynar_push(ctn,&val);
149 xbt_dynar_shrink(ctn, 0);
150 xbt_dynar_free(&ctn_str);
151 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
152 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
157 * \brief Add a "router" to the network element list
159 static void parse_S_router(sg_platf_router_cbarg_t router)
161 sg_routing_edge_t info = NULL;
162 if (current_routing->hierarchy == SURF_ROUTING_NULL)
163 current_routing->hierarchy = SURF_ROUTING_BASE;
164 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
165 "Reading a router, processing unit \"%s\" already exists",
168 info = xbt_new0(s_network_element_t, 1);
169 info->rc_component = current_routing;
170 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
171 info->name = xbt_strdup(router->id);
172 info->id = current_routing->parse_PU(current_routing, (void *) info);
173 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
174 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
176 if (strcmp(router->coord, "")) {
180 if (!COORD_ASR_LEVEL)
181 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
182 /* Pre-parse the host coordinates */
183 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
184 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
185 xbt_dynar_foreach(ctn_str,cursor, str) {
186 double val = atof(str);
187 xbt_dynar_push(ctn,&val);
189 xbt_dynar_shrink(ctn, 0);
190 xbt_dynar_free(&ctn_str);
191 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
192 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
198 * \brief Set the end points for a route
200 static void routing_parse_S_route(void)
202 if (src != NULL && dst != NULL && parsed_link_list != NULL)
203 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
204 A_surfxml_route_src, A_surfxml_route_dst);
205 src = A_surfxml_route_src;
206 dst = A_surfxml_route_dst;
207 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
208 "Some limits are null in the route between \"%s\" and \"%s\"",
210 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
214 * \brief Set the end points and gateways for a ASroute
216 static void routing_parse_S_ASroute(void)
218 if (src != NULL && dst != NULL && parsed_link_list != NULL)
219 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
220 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
221 src = A_surfxml_ASroute_src;
222 dst = A_surfxml_ASroute_dst;
223 gw_src = A_surfxml_ASroute_gw_src;
224 gw_dst = A_surfxml_ASroute_gw_dst;
225 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
226 || strlen(gw_dst) > 0,
227 "Some limits are null in the route between \"%s\" and \"%s\"",
229 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
233 * \brief Set the end points for a bypassRoute
235 static void routing_parse_S_bypassRoute(void)
237 if (src != NULL && dst != NULL && parsed_link_list != NULL)
239 "Bypass Route between %s to %s can not be defined",
240 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
241 src = A_surfxml_bypassRoute_src;
242 dst = A_surfxml_bypassRoute_dst;
245 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
246 || strlen(gw_dst) > 0,
247 "Some limits are null in the route between \"%s\" and \"%s\"",
249 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
253 * \brief Set the end points for a bypassASroute
255 static void routing_parse_S_bypassASroute(void)
257 if (src != NULL && dst != NULL && parsed_link_list != NULL)
259 "Bypass AS Route between %s to %s can not be defined",
260 A_surfxml_bypassASroute_src, A_surfxml_bypassASroute_dst);
261 src = A_surfxml_bypassASroute_src;
262 dst = A_surfxml_bypassASroute_dst;
263 gw_src = A_surfxml_bypassASroute_gw_src;
264 gw_dst = A_surfxml_bypassASroute_gw_dst;
265 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
266 || strlen(gw_dst) > 0,
267 "Some limits are null in the route between \"%s\" and \"%s\"",
269 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
272 * \brief Set a new link on the actual list of link for a route or ASroute from XML
275 static void routing_parse_link_ctn(void)
278 switch (A_surfxml_link_ctn_direction) {
279 case AU_surfxml_link_ctn_direction:
280 case A_surfxml_link_ctn_direction_NONE:
281 link_id = xbt_strdup(A_surfxml_link_ctn_id);
283 case A_surfxml_link_ctn_direction_UP:
284 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
286 case A_surfxml_link_ctn_direction_DOWN:
287 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
290 xbt_dynar_push(parsed_link_list, &link_id);
294 * \brief Store the route by calling the set_route function of the current routing component
296 static void routing_parse_E_route(void)
298 route_t route = xbt_new0(s_route_t, 1);
299 route->link_list = parsed_link_list;
300 xbt_assert(current_routing->parse_route,
301 "no defined method \"set_route\" in \"%s\"",
302 current_routing->name);
303 current_routing->parse_route(current_routing, src, dst, route);
304 generic_free_route(route);
305 parsed_link_list = NULL;
311 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
313 static void routing_parse_E_ASroute(void)
315 route_t e_route = xbt_new0(s_route_t, 1);
316 e_route->link_list = parsed_link_list;
318 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
319 e_route->src_gateway = (sg_routing_edge_t) gw_src; // DIRTY HACK possible only FIXME
320 e_route->dst_gateway = (sg_routing_edge_t) gw_dst; // because of what is in routing_parse_E_ASroute
322 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
323 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
325 xbt_assert(current_routing->parse_ASroute,
326 "no defined method \"set_ASroute\" in \"%s\"",
327 current_routing->name);
328 current_routing->parse_ASroute(current_routing, src, dst, e_route);
329 generic_free_route(e_route);
330 parsed_link_list = NULL;
338 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
340 static void routing_parse_E_bypassRoute(void)
342 route_t e_route = xbt_new0(s_route_t, 1);
343 e_route->link_list = parsed_link_list;
345 xbt_assert(current_routing->parse_bypassroute,
346 "Bypassing mechanism not implemented by routing '%s'",
347 current_routing->name);
349 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
350 parsed_link_list = NULL;
357 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
359 static void routing_parse_E_bypassASroute(void)
361 route_t e_route = xbt_new0(s_route_t, 1);
362 e_route->link_list = parsed_link_list;
363 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
364 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
365 xbt_assert(current_routing->parse_bypassroute,
366 "Bypassing mechanism not implemented by routing '%s'",
367 current_routing->name);
368 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
369 parsed_link_list = NULL;
377 * \brief Make a new routing component to the platform
379 * Add a new autonomous system to the platform. Any elements (such as host,
380 * router or sub-AS) added after this call and before the corresponding call
381 * to sg_platf_new_AS_close() will be added to this AS.
383 * Once this function was called, the configuration concerning the used
384 * models cannot be changed anymore.
386 * @param AS_id name of this autonomous system. Must be unique in the platform
387 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
389 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
392 routing_model_description_t model = NULL;
395 xbt_assert(!xbt_lib_get_or_null
396 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
397 "The AS \"%s\" already exists", AS_id);
399 /* search the routing model */
400 for (cpt = 0; routing_models[cpt].name; cpt++)
401 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
402 model = &routing_models[cpt];
403 /* if its not exist, error */
405 fprintf(stderr, "Routing model %s not found. Existing models:\n",
406 wanted_routing_type);
407 for (cpt = 0; routing_models[cpt].name; cpt++)
408 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
409 routing_models[cpt].desc);
413 /* make a new routing component */
414 new_as = (AS_t) model->create();
415 new_as->model_desc = model;
416 new_as->hierarchy = SURF_ROUTING_NULL;
417 new_as->name = xbt_strdup(AS_id);
419 sg_routing_edge_t info = NULL;
420 info = xbt_new0(s_network_element_t, 1);
422 if (current_routing == NULL && global_routing->root == NULL) {
424 /* it is the first one */
425 new_as->routing_father = NULL;
426 global_routing->root = new_as;
428 } else if (current_routing != NULL && global_routing->root != NULL) {
430 xbt_assert(!xbt_dict_get_or_null
431 (current_routing->routing_sons, AS_id),
432 "The AS \"%s\" already exists", AS_id);
433 /* it is a part of the tree */
434 new_as->routing_father = current_routing;
435 /* set the father behavior */
436 if (current_routing->hierarchy == SURF_ROUTING_NULL)
437 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
438 /* add to the sons dictionary */
439 xbt_dict_set(current_routing->routing_sons, AS_id,
440 (void *) new_as, NULL);
441 /* add to the father element list */
442 info->id = current_routing->parse_AS(current_routing, (void *) info);
444 THROWF(arg_error, 0, "All defined components must be belong to a AS");
447 info->rc_component = new_as->routing_father;
448 info->rc_type = SURF_NETWORK_ELEMENT_AS;
449 info->name = new_as->name;
451 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
453 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
455 /* set the new current component of the tree */
456 current_routing = new_as;
457 current_routing->net_elem = info;
462 * \brief Specify that the current description of AS is finished
464 * Once you've declared all the content of your AS, you have to close
465 * it with this call. Your AS is not usable until you call this function.
467 * @fixme: this call is not as robust as wanted: bad things WILL happen
468 * if you call it twice for the same AS, or if you forget calling it, or
469 * even if you add stuff to a closed AS
472 void routing_AS_end()
475 if (current_routing == NULL) {
476 THROWF(arg_error, 0, "Close an AS, but none was under construction");
478 if (current_routing->model_desc->end)
479 current_routing->model_desc->end(current_routing);
480 current_routing = current_routing->routing_father;
484 /* Aux Business methods */
487 * \brief Get the AS father and the first elements of the chain
489 * \param src the source host name
490 * \param dst the destination host name
492 * Get the common father of the to processing units, and the first different
493 * father in the chain
495 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
500 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
501 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
503 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
504 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
512 /* (1) find the as where the src and dst are located */
513 sg_routing_edge_t src_data = src;
514 sg_routing_edge_t dst_data = dst;
515 src_as = src_data->rc_component;
516 dst_as = dst_data->rc_component;
518 char* src_name = src_data->name;
519 char* dst_name = dst_data->name;
522 xbt_assert(src_as && dst_as,
523 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
525 /* (2) find the path to the root routing component */
526 for (current = src_as; current != NULL; current = current->routing_father) {
527 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
528 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
529 path_src[index_src++] = current;
531 for (current = dst_as; current != NULL; current = current->routing_father) {
532 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
533 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
534 path_dst[index_dst++] = current;
537 /* (3) find the common father */
539 current_src = path_src[--index_src];
540 current_dst = path_dst[--index_dst];
541 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
543 /* (4) they are not in the same routing component, make the path */
544 if (current_src == current_dst)
545 father = current_src;
547 father = path_src[index_src + 1];
549 /* (5) result generation */
550 *res_father = father; /* first the common father of src and dst */
551 *res_src = current_src; /* second the first different father of src */
552 *res_dst = current_dst; /* three the first different father of dst */
554 #undef ELEMENTS_FATHER_MAXDEPTH
557 /* Global Business methods */
560 * \brief Recursive function for get_route_latency
562 * \param src the source host name
563 * \param dst the destination host name
564 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
565 * \param *latency the latency, if needed
567 * This function is called by "get_route" and "get_latency". It allows to walk
568 * recursively through the ASes tree.
570 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
571 xbt_dynar_t * links, double *latency)
574 memset(&route,0,sizeof(route));
576 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
577 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
579 /* Find how src and dst are interconnected */
580 AS_t common_father, src_father, dst_father;
581 elements_father(src, dst, &common_father, &src_father, &dst_father);
582 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
583 common_father->name,src_father->name,dst_father->name);
585 /* Check whether a direct bypass is defined */
586 route_t e_route_bypass = NULL;
587 if (common_father->get_bypass_route)
588 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
590 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
591 if (e_route_bypass) {
592 xbt_dynar_merge(links,&(e_route_bypass->link_list));
593 generic_free_route(e_route_bypass);
597 /* If src and dst are in the same AS, life is good */
598 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
600 route.link_list = *links;
602 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
606 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
608 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
609 // Find the net_card corresponding to father
610 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
611 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
613 common_father->get_route_and_latency(common_father, src_father_net_elm, dst_father_net_elm, &route,latency);
615 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
616 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
618 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
619 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
621 /* If source gateway is not our source, we have to recursively find our way up to this point */
622 if (src != src_gateway_net_elm)
623 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
625 xbt_dynar_merge(links,&(route.link_list));
627 /* If dest gateway is not our destination, we have to recursively find our way from this point */
628 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
629 if (dst_gateway_net_elm != dst) {
630 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
632 xbt_dynar_free(&route.link_list);
636 * \brief Find a route between hosts
638 * \param src the network_element_t for src host
639 * \param dst the network_element_t for dst host
640 * \param route where to store the list of links.
641 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
642 * \param latency where to store the latency experienced on the path (or NULL if not interested)
643 * It is the caller responsability to initialize latency to 0 (we add to provided route)
646 * walk through the routing components tree and find a route between hosts
647 * by calling the differents "get_route" functions in each routing component.
649 void routing_get_route_and_latency(sg_routing_edge_t src,
650 sg_routing_edge_t dst,
651 xbt_dynar_t * route, double *latency)
653 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
655 xbt_dynar_reset(global_routing->last_route);
656 *route = global_routing->last_route;
659 _get_route_and_latency(src, dst, route, latency);
661 xbt_assert(!latency || *latency >= 0.0,
662 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
665 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
667 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
669 //adding my one link routes
670 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
672 xbt_dynar_merge(&ret,&onelink_mine);
676 xbt_dict_cursor_t cursor = NULL;
678 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
679 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
681 xbt_dynar_merge(&ret,&onelink_child);
686 static xbt_dynar_t get_onelink_routes(void)
688 return recursive_get_onelink_routes(global_routing->root);
691 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
693 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
697 return SURF_NETWORK_ELEMENT_NULL;
701 * \brief Generic method: create the global routing schema
703 * Make a global routing structure and set all the parsing functions.
705 void routing_model_create( void *loopback)
707 /* config the uniq global routing */
708 global_routing = xbt_new0(s_routing_global_t, 1);
709 global_routing->root = NULL;
710 global_routing->get_onelink_routes = get_onelink_routes;
711 global_routing->loopback = loopback;
712 global_routing->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
713 /* no current routing at moment */
714 current_routing = NULL;
718 /* ************************************************** */
719 /* ********** PATERN FOR NEW ROUTING **************** */
721 /* The minimal configuration of a new routing model need the next functions,
722 * also you need to set at the start of the file, the new model in the model
723 * list. Remember keep the null ending of the list.
725 /*** Routing model structure ***/
727 // s_routing_component_t generic_routing;
728 // /* things that your routing model need */
729 // } s_routing_component_NEW_t,*routing_component_NEW_t;
731 /*** Parse routing model functions ***/
732 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
733 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
734 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
735 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
736 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
738 /*** Business methods ***/
739 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
740 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
741 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
743 /*** Creation routing model functions ***/
744 // static void* model_NEW_create(void) {
745 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
746 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
747 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
748 // new_component->generic_routing.set_route = model_NEW_set_route;
749 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
750 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
751 // new_component->generic_routing.get_route = NEW_get_route;
752 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
753 // new_component->generic_routing.finalize = NEW_finalize;
754 // /* initialization of internal structures */
755 // return new_component;
757 // static void model_NEW_load(void) {} /* mandatory */
758 // static void model_NEW_unload(void) {} /* mandatory */
759 // static void model_NEW_end(void) {} /* mandatory */
761 /* ************************************************************************** */
762 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
764 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
766 char *host_id, *groups, *link_id = NULL;
767 xbt_dict_t patterns = NULL;
769 s_sg_platf_host_cbarg_t host;
770 s_sg_platf_link_cbarg_t link;
774 xbt_dynar_t radical_elements;
775 xbt_dynar_t radical_ends;
777 if (strcmp(cluster->availability_trace, "")
778 || strcmp(cluster->state_trace, "")) {
779 patterns = xbt_dict_new_homogeneous(xbt_free_f);
780 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
781 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
782 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
785 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
786 sg_platf_new_AS_begin(cluster->id, "Cluster");
788 current_routing->link_up_down_list
789 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
792 radical_elements = xbt_str_split(cluster->radical, ",");
793 xbt_dynar_foreach(radical_elements, iter, groups) {
795 radical_ends = xbt_str_split(groups, "-");
796 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
798 switch (xbt_dynar_length(radical_ends)) {
803 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
806 surf_parse_error("Malformed radical");
809 for (i = start; i <= end; i++) {
811 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
812 link_id = bprintf("%s_link_%d", cluster->id, i);
814 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
816 memset(&host, 0, sizeof(host));
818 if (strcmp(cluster->availability_trace, "")) {
819 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
820 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
821 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
822 host.power_trace = tmgr_trace_new(avail_file);
823 xbt_free(avail_file);
825 XBT_DEBUG("\tavailability_file=\"\"");
828 if (strcmp(cluster->state_trace, "")) {
829 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
830 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
831 host.state_trace = tmgr_trace_new(avail_file);
832 xbt_free(avail_file);
834 XBT_DEBUG("\tstate_file=\"\"");
837 host.power_peak = cluster->power;
838 host.power_scale = 1.0;
839 host.core_amount = cluster->core_amount;
840 host.initial_state = SURF_RESOURCE_ON;
842 sg_platf_new_host(&host);
843 XBT_DEBUG("</host>");
845 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
846 cluster->bw, cluster->lat);
848 memset(&link, 0, sizeof(link));
850 link.bandwidth = cluster->bw;
851 link.latency = cluster->lat;
852 link.state = SURF_RESOURCE_ON;
853 link.policy = cluster->sharing_policy;
854 sg_platf_new_link(&link);
856 s_surf_parsing_link_up_down_t info;
858 if (link.policy == SURF_LINK_FULLDUPLEX) {
859 char *tmp_link = bprintf("%s_UP", link_id);
861 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
863 tmp_link = bprintf("%s_DOWN", link_id);
865 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
868 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
869 info.link_down = info.link_up;
871 xbt_dynar_push(current_routing->link_up_down_list,&info);
876 xbt_dynar_free(&radical_ends);
878 xbt_dynar_free(&radical_elements);
880 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
881 // and it's very useful to connect clusters together
883 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
885 s_sg_platf_router_cbarg_t router;
886 memset(&router, 0, sizeof(router));
887 router.id = cluster->router_id;
889 if (!router.id || !strcmp(router.id, ""))
891 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
893 sg_platf_new_router(&router);
897 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
898 char *link_backbone = bprintf("%s_backbone", cluster->id);
899 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
900 cluster->bb_bw, cluster->bb_lat);
902 memset(&link, 0, sizeof(link));
903 link.id = link_backbone;
904 link.bandwidth = cluster->bb_bw;
905 link.latency = cluster->bb_lat;
906 link.state = SURF_RESOURCE_ON;
907 link.policy = cluster->bb_sharing_policy;
909 sg_platf_new_link(&link);
911 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
917 sg_platf_new_AS_end();
919 xbt_dict_free(&patterns); // no op if it were never set
922 static void routing_parse_postparse(void) {
923 xbt_dict_free(&random_value);
926 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
928 static int AX_ptr = 0;
929 char *host_id = NULL;
930 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
932 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
933 static unsigned int surfxml_buffer_stack_stack[1024];
935 surfxml_buffer_stack_stack[0] = 0;
937 surfxml_bufferstack_push(1);
939 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
940 sg_platf_new_AS_begin(peer->id, "Full");
943 host_id = HOST_PEER(peer->id);
944 router_id = ROUTER_PEER(peer->id);
945 link_id_up = LINK_UP_PEER(peer->id);
946 link_id_down = LINK_DOWN_PEER(peer->id);
948 link_router = bprintf("%s_link_router", peer->id);
949 link_backbone = bprintf("%s_backbone", peer->id);
951 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
952 s_sg_platf_host_cbarg_t host;
953 memset(&host, 0, sizeof(host));
954 host.initial_state = SURF_RESOURCE_ON;
956 host.power_peak = peer->power;
957 host.power_scale = 1.0;
958 host.power_trace = peer->availability_trace;
959 host.state_trace = peer->state_trace;
960 host.core_amount = 1;
961 host.coord = peer->coord;
962 sg_platf_new_host(&host);
965 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
966 s_sg_platf_router_cbarg_t router;
967 memset(&router, 0, sizeof(router));
968 router.id = router_id;
969 router.coord = peer->coord;
970 sg_platf_new_router(&router);
972 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
973 peer->bw_in, peer->lat);
974 s_sg_platf_link_cbarg_t link;
975 memset(&link, 0, sizeof(link));
976 link.state = SURF_RESOURCE_ON;
977 link.policy = SURF_LINK_SHARED;
978 link.id = link_id_up;
979 link.bandwidth = peer->bw_in;
980 link.latency = peer->lat;
981 sg_platf_new_link(&link);
983 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
984 // Instead, it should be created fullduplex, and the models will do what's needed in this case
985 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
986 peer->bw_out, peer->lat);
987 link.id = link_id_down;
988 sg_platf_new_link(&link);
993 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
994 XBT_DEBUG("symmetrical=\"NO\">");
995 SURFXML_BUFFER_SET(route_src, host_id);
996 SURFXML_BUFFER_SET(route_dst, router_id);
997 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
998 SURFXML_START_TAG(route);
1000 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1001 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1002 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1003 SURFXML_START_TAG(link_ctn);
1004 SURFXML_END_TAG(link_ctn);
1006 XBT_DEBUG("</route>");
1007 SURFXML_END_TAG(route);
1010 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1011 XBT_DEBUG("symmetrical=\"NO\">");
1012 SURFXML_BUFFER_SET(route_src, router_id);
1013 SURFXML_BUFFER_SET(route_dst, host_id);
1014 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1015 SURFXML_START_TAG(route);
1017 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1018 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1019 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1020 SURFXML_START_TAG(link_ctn);
1021 SURFXML_END_TAG(link_ctn);
1023 XBT_DEBUG("</route>");
1024 SURFXML_END_TAG(route);
1027 sg_platf_new_AS_end();
1030 //xbt_dynar_free(&tab_elements_num);
1034 free(link_backbone);
1037 surfxml_bufferstack_pop(1);
1040 static void routing_parse_Srandom(void)
1042 double mean, std, min, max, seed;
1043 char *random_id = A_surfxml_random_id;
1044 char *random_radical = A_surfxml_random_radical;
1045 char *rd_name = NULL;
1047 mean = surf_parse_get_double(A_surfxml_random_mean);
1048 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1049 min = surf_parse_get_double(A_surfxml_random_min);
1050 max = surf_parse_get_double(A_surfxml_random_max);
1051 seed = surf_parse_get_double(A_surfxml_random_seed);
1055 random_data_t random = xbt_new0(s_random_data_t, 1);
1058 xbt_dynar_t radical_elements;
1062 xbt_dynar_t radical_ends;
1064 switch (A_surfxml_random_generator) {
1065 case AU_surfxml_random_generator:
1066 case A_surfxml_random_generator_NONE:
1067 random->generator = NONE;
1069 case A_surfxml_random_generator_DRAND48:
1070 random->generator = DRAND48;
1072 case A_surfxml_random_generator_RAND:
1073 random->generator = RAND;
1075 case A_surfxml_random_generator_RNGSTREAM:
1076 random->generator = RNGSTREAM;
1079 surf_parse_error("Invalid random generator");
1082 random->seed = seed;
1086 /* Check user stupidities */
1088 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1090 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1092 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1094 /* normalize the mean and standard deviation before storing */
1095 random->mean = (mean - min) / (max - min);
1096 random->std = std / (max - min);
1098 if (random->mean * (1 - random->mean) < random->std * random->std)
1099 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1100 random->mean, random->std);
1103 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1104 random_id, random->min, random->max, random->mean, random->std,
1105 (int)random->generator, random->seed, random_radical);
1108 random_value = xbt_dict_new_homogeneous(free);
1110 if (!strcmp(random_radical, "")) {
1111 res = random_generate(random);
1112 rd_value = bprintf("%f", res);
1113 xbt_dict_set(random_value, random_id, rd_value, NULL);
1115 radical_elements = xbt_str_split(random_radical, ",");
1116 xbt_dynar_foreach(radical_elements, iter, groups) {
1117 radical_ends = xbt_str_split(groups, "-");
1118 switch (xbt_dynar_length(radical_ends)) {
1120 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1121 "Custom Random '%s' already exists !", random_id);
1122 res = random_generate(random);
1124 bprintf("%s%d", random_id,
1125 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1126 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1131 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1132 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1133 for (i = start; i <= end; i++) {
1134 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1135 "Custom Random '%s' already exists !", bprintf("%s%d",
1138 res = random_generate(random);
1139 tmpbuf = bprintf("%s%d", random_id, i);
1140 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1145 XBT_CRITICAL("Malformed radical");
1148 res = random_generate(random);
1149 rd_name = bprintf("%s_router", random_id);
1150 rd_value = bprintf("%f", res);
1151 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1153 xbt_dynar_free(&radical_ends);
1156 xbt_dynar_free(&radical_elements);
1160 void routing_register_callbacks()
1162 sg_platf_host_add_cb(parse_S_host);
1163 sg_platf_router_add_cb(parse_S_router);
1165 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1167 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1168 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1169 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1170 &routing_parse_S_bypassRoute);
1171 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1172 &routing_parse_S_bypassASroute);
1174 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1176 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1177 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1178 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1179 &routing_parse_E_bypassRoute);
1180 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1181 &routing_parse_E_bypassASroute);
1183 sg_platf_cluster_add_cb(routing_parse_cluster);
1185 sg_platf_peer_add_cb(routing_parse_peer);
1186 sg_platf_postparse_add_cb(routing_parse_postparse);
1188 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1189 sg_platf_AS_end_add_cb(routing_AS_end);
1190 sg_platf_AS_begin_add_cb(routing_AS_begin);
1193 instr_routing_define_callbacks();
1198 * \brief Recursive function for finalize
1200 * \param rc the source host name
1202 * This fuction is call by "finalize". It allow to finalize the
1203 * AS or routing components. It delete all the structures.
1205 static void finalize_rec(AS_t as) {
1206 xbt_dict_cursor_t cursor = NULL;
1210 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1217 /** \brief Frees all memory allocated by the routing module */
1218 void routing_exit(void) {
1219 if (!global_routing)
1221 xbt_dynar_free(&global_routing->last_route);
1222 finalize_rec(global_routing->root);
1223 xbt_free(global_routing);