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 int ROUTING_HOST_LEVEL; //Routing level
17 int SURF_CPU_LEVEL; //Surf cpu level
18 int SURF_WKS_LEVEL; //Surf workstation level
19 int SIMIX_HOST_LEVEL; //Simix level
20 int MSG_HOST_LEVEL; //Msg level
21 int SD_HOST_LEVEL; //Simdag level
22 int COORD_HOST_LEVEL=0; //Coordinates level
23 int NS3_HOST_LEVEL; //host node for ns3
26 int SD_LINK_LEVEL; //Simdag level
27 int SURF_LINK_LEVEL; //Surf level
28 int NS3_LINK_LEVEL; //link for ns3
30 xbt_lib_t as_router_lib;
31 int ROUTING_ASR_LEVEL; //Routing level
32 int COORD_ASR_LEVEL; //Coordinates level
33 int NS3_ASR_LEVEL; //host node for ns3
35 static xbt_dict_t random_value = NULL;
38 routing_global_t global_routing = NULL;
39 AS_t current_routing = NULL;
41 /* global parse functions */
42 xbt_dynar_t link_list = NULL; /* temporary store of current list link of a route */
43 static const char *src = NULL; /* temporary store the source name of a route */
44 static const char *dst = NULL; /* temporary store the destination name of a route */
45 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
46 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
48 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
50 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
51 static void routing_parse_Srandom(void); /* random bypass */
53 static void routing_parse_postparse(void);
55 /* this lines are only for replace use like index in the model table */
60 SURF_MODEL_DIJKSTRACACHE,
67 struct s_model_type routing_models[] = {
69 "Full routing data (fast, large memory requirements, fully expressive)",
70 model_full_create, model_full_end},
72 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
73 model_floyd_create, model_floyd_end},
75 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
76 model_dijkstra_create, model_dijkstra_both_end},
78 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
79 model_dijkstracache_create, model_dijkstra_both_end},
80 {"none", "No routing (usable with Constant network only)",
81 model_none_create, NULL},
82 {"RuleBased", "Rule-Based routing data (...)",
83 model_rulebased_create, NULL},
84 {"Vivaldi", "Vivaldi routing",
85 model_vivaldi_create, NULL},
86 {"Cluster", "Cluster routing",
87 model_cluster_create, NULL},
88 {NULL, NULL, NULL, NULL}
92 * \brief Add a "host" to the network element list
94 static void parse_S_host(sg_platf_host_cbarg_t host)
96 network_element_info_t info = NULL;
97 if (current_routing->hierarchy == SURF_ROUTING_NULL)
98 current_routing->hierarchy = SURF_ROUTING_BASE;
99 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
100 "Reading a host, processing unit \"%s\" already exists", host->id);
102 current_routing->parse_PU(current_routing, host->id);
103 info = xbt_new0(s_network_element_info_t, 1);
104 info->rc_component = current_routing;
105 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
106 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
107 if (host->coord && strcmp(host->coord, "")) {
111 if (!COORD_HOST_LEVEL)
112 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
114 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
115 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
116 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
117 xbt_dynar_foreach(ctn_str,cursor, str) {
118 double val = atof(str);
119 xbt_dynar_push(ctn,&val);
121 xbt_dynar_shrink(ctn, 0);
122 xbt_dynar_free(&ctn_str);
123 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
128 * \brief Add a "router" to the network element list
130 static void parse_S_router(sg_platf_router_cbarg_t router)
132 network_element_info_t info = NULL;
133 if (current_routing->hierarchy == SURF_ROUTING_NULL)
134 current_routing->hierarchy = SURF_ROUTING_BASE;
135 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
136 "Reading a router, processing unit \"%s\" already exists",
139 current_routing->parse_PU(current_routing, router->id);
140 info = xbt_new0(s_network_element_info_t, 1);
141 info->rc_component = current_routing;
142 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
144 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
145 if (strcmp(router->coord, "")) {
149 if (!COORD_ASR_LEVEL)
150 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
152 /* Pre-parse the host coordinates */
153 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
154 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
155 xbt_dynar_foreach(ctn_str,cursor, str) {
156 double val = atof(str);
157 xbt_dynar_push(ctn,&val);
159 xbt_dynar_shrink(ctn, 0);
160 xbt_dynar_free(&ctn_str);
161 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
167 * \brief Set the end points for a route
169 static void routing_parse_S_route(void)
171 if (src != NULL && dst != NULL && link_list != NULL)
172 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
173 A_surfxml_route_src, A_surfxml_route_dst);
174 src = A_surfxml_route_src;
175 dst = A_surfxml_route_dst;
176 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
177 "Some limits are null in the route between \"%s\" and \"%s\"",
179 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
183 * \brief Set the end points and gateways for a ASroute
185 static void routing_parse_S_ASroute(void)
187 if (src != NULL && dst != NULL && link_list != NULL)
188 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
189 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
190 src = A_surfxml_ASroute_src;
191 dst = A_surfxml_ASroute_dst;
192 gw_src = A_surfxml_ASroute_gw_src;
193 gw_dst = A_surfxml_ASroute_gw_dst;
194 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
195 || strlen(gw_dst) > 0,
196 "Some limits are null in the route between \"%s\" and \"%s\"",
198 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
202 * \brief Set the end points for a bypassRoute
204 static void routing_parse_S_bypassRoute(void)
206 if (src != NULL && dst != NULL && link_list != NULL)
208 "Bypass Route between %s to %s can not be defined",
209 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
210 src = A_surfxml_bypassRoute_src;
211 dst = A_surfxml_bypassRoute_dst;
212 gw_src = A_surfxml_bypassRoute_gw_src;
213 gw_dst = A_surfxml_bypassRoute_gw_dst;
214 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
215 || strlen(gw_dst) > 0,
216 "Some limits are null in the route between \"%s\" and \"%s\"",
218 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
222 * \brief Set a new link on the actual list of link for a route or ASroute from XML
225 static void routing_parse_link_ctn(void)
228 switch (A_surfxml_link_ctn_direction) {
229 case AU_surfxml_link_ctn_direction:
230 case A_surfxml_link_ctn_direction_NONE:
231 link_id = xbt_strdup(A_surfxml_link_ctn_id);
233 case A_surfxml_link_ctn_direction_UP:
234 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
236 case A_surfxml_link_ctn_direction_DOWN:
237 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
240 xbt_dynar_push(link_list, &link_id);
244 * \brief Store the route by calling the set_route function of the current routing component
246 static void routing_parse_E_route(void)
248 route_t route = xbt_new0(s_route_t, 1);
249 route->link_list = link_list;
250 xbt_assert(current_routing->parse_route,
251 "no defined method \"set_route\" in \"%s\"",
252 current_routing->name);
253 current_routing->parse_route(current_routing, src, dst, route);
260 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
262 static void routing_parse_E_ASroute(void)
264 route_t e_route = xbt_new0(s_route_t, 1);
265 e_route->link_list = link_list;
266 e_route->src_gateway = xbt_strdup(gw_src);
267 e_route->dst_gateway = xbt_strdup(gw_dst);
268 xbt_assert(current_routing->parse_ASroute,
269 "no defined method \"set_ASroute\" in \"%s\"",
270 current_routing->name);
271 current_routing->parse_ASroute(current_routing, src, dst, e_route);
280 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
282 static void routing_parse_E_bypassRoute(void)
284 route_t e_route = xbt_new0(s_route_t, 1);
285 e_route->link_list = link_list;
286 e_route->src_gateway = xbt_strdup(gw_src);
287 e_route->dst_gateway = xbt_strdup(gw_dst);
288 xbt_assert(current_routing->parse_bypassroute,
289 "Bypassing mechanism not implemented by routing '%s'",
290 current_routing->name);
291 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
300 * \brief Make a new routing component to the platform
302 * Add a new autonomous system to the platform. Any elements (such as host,
303 * router or sub-AS) added after this call and before the corresponding call
304 * to sg_platf_new_AS_close() will be added to this AS.
306 * Once this function was called, the configuration concerning the used
307 * models cannot be changed anymore.
309 * @param AS_id name of this autonomous system. Must be unique in the platform
310 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
312 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
315 routing_model_description_t model = NULL;
318 /* search the routing model */
319 for (cpt = 0; routing_models[cpt].name; cpt++)
320 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
321 model = &routing_models[cpt];
322 /* if its not exist, error */
324 fprintf(stderr, "Routing model %s not found. Existing models:\n",
325 wanted_routing_type);
326 for (cpt = 0; routing_models[cpt].name; cpt++)
327 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
328 routing_models[cpt].desc);
332 /* make a new routing component */
333 new_as = (AS_t) model->create();
334 new_as->model_desc = model;
335 new_as->hierarchy = SURF_ROUTING_NULL;
336 new_as->name = xbt_strdup(AS_id);
338 if (current_routing == NULL && global_routing->root == NULL) {
340 /* it is the first one */
341 new_as->routing_father = NULL;
342 global_routing->root = new_as;
344 } else if (current_routing != NULL && global_routing->root != NULL) {
346 xbt_assert(!xbt_dict_get_or_null
347 (current_routing->routing_sons, AS_id),
348 "The AS \"%s\" already exists", AS_id);
349 /* it is a part of the tree */
350 new_as->routing_father = current_routing;
351 /* set the father behavior */
352 if (current_routing->hierarchy == SURF_ROUTING_NULL)
353 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
354 /* add to the sons dictionary */
355 xbt_dict_set(current_routing->routing_sons, AS_id,
356 (void *) new_as, NULL);
357 /* add to the father element list */
358 current_routing->parse_AS(current_routing, AS_id);
360 THROWF(arg_error, 0, "All defined components must be belong to a AS");
362 /* set the new current component of the tree */
363 current_routing = new_as;
367 * \brief Specify that the current description of AS is finished
369 * Once you've declared all the content of your AS, you have to close
370 * it with this call. Your AS is not usable until you call this function.
372 * @fixme: this call is not as robust as wanted: bad things WILL happen
373 * if you call it twice for the same AS, or if you forget calling it, or
374 * even if you add stuff to a closed AS
377 void routing_AS_end()
380 if (current_routing == NULL) {
381 THROWF(arg_error, 0, "Close an AS, but none was under construction");
383 network_element_info_t info = NULL;
384 xbt_assert(!xbt_lib_get_or_null
385 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
386 "The AS \"%s\" already exists", current_routing->name);
387 info = xbt_new0(s_network_element_info_t, 1);
388 info->rc_component = current_routing->routing_father;
389 info->rc_type = SURF_NETWORK_ELEMENT_AS;
390 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
393 if (current_routing->model_desc->end)
394 current_routing->model_desc->end(current_routing);
395 current_routing = current_routing->routing_father;
399 /* Aux Business methods */
402 * \brief Get the AS father and the first elements of the chain
404 * \param src the source host name
405 * \param dst the destination host name
407 * Get the common father of the to processing units, and the first different
408 * father in the chain
410 static void elements_father(const char *src, const char *dst,
415 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
416 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
418 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
419 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
427 /* (1) find the as where the src and dst are located */
428 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
430 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
433 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
435 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
436 src_as = src_data->rc_component;
437 dst_as = dst_data->rc_component;
439 xbt_assert(src_as && dst_as,
440 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
442 /* (2) find the path to the root routing component */
443 for (current = src_as; current != NULL; current = current->routing_father) {
444 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
445 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
446 path_src[index_src++] = current;
448 for (current = dst_as; current != NULL; current = current->routing_father) {
449 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
450 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
451 path_dst[index_dst++] = current;
454 /* (3) find the common father */
456 current_src = path_src[--index_src];
457 current_dst = path_dst[--index_dst];
458 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
460 /* (4) they are not in the same routing component, make the path */
461 if (current_src == current_dst)
462 father = current_src;
464 father = path_src[index_src + 1];
466 /* (5) result generation */
467 *res_father = father; /* first the common father of src and dst */
468 *res_src = current_src; /* second the first different father of src */
469 *res_dst = current_dst; /* three the first different father of dst */
471 #undef ELEMENTS_FATHER_MAXDEPTH
474 /* Global Business methods */
477 * \brief Recursive function for get_route_latency
479 * \param src the source host name
480 * \param dst the destination host name
481 * \param *e_route the route where the links are stored
482 * \param *latency the latency, if needed
484 * This function is called by "get_route" and "get_latency". It allows to walk
485 * recursively through the ASes tree.
487 static void _get_route_and_latency(const char *src, const char *dst,
488 xbt_dynar_t * route, double *latency)
493 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
494 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
496 /* Find how src and dst are interconnected */
497 AS_t common_father, src_father, dst_father;
498 elements_father(src, dst, &common_father, &src_father, &dst_father);
500 /* If src and dst are in the same AS, life is good */
501 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
503 route_t e_route = NULL;
505 e_route = common_father->get_route(common_father, src, dst);
506 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
507 *route = e_route->link_list;
510 *latency = common_father->get_latency(common_father, src, dst, e_route);
511 xbt_assert(*latency >= 0.0,
512 "latency error on route between \"%s\" and \"%s\"", src, dst);
515 xbt_free(e_route->src_gateway);
516 xbt_free(e_route->dst_gateway);
522 /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
524 route_t e_route_bypass = NULL;
525 if (common_father->get_bypass_route)
526 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
528 if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
530 xbt_die("Bypass cannot work yet with get_latency"); // FIXME: that limitation seems supurious to me -- check with alvin
533 xbt_die("You're asking for route and latency but don't ask for any of them, you weirdo");
534 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
536 xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
537 xbt_dynar_push(*route, &link);
540 generic_free_route(e_route_bypass);
545 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
547 route_t e_route_cnt = e_route_bypass
548 ? e_route_bypass : common_father->get_route(common_father,
552 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
553 src_father->name, dst_father->name);
555 xbt_assert((e_route_cnt->src_gateway == NULL) ==
556 (e_route_cnt->dst_gateway == NULL),
557 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
560 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
563 *latency = common_father->get_latency(common_father,
564 src_father->name, dst_father->name,
566 xbt_assert(*latency >= 0.0,
567 "latency error on route between \"%s\" and \"%s\"",
568 src_father->name, dst_father->name);
572 /* If source gateway is not our source, we have to recursively find our way up to this point */
573 if (strcmp(src, e_route_cnt->src_gateway)) {
575 xbt_dynar_t route_src;
577 _get_route_and_latency(src, e_route_cnt->src_gateway,
578 (route ? &route_src : NULL),
579 (latency ? &latency_src : NULL));
581 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
582 src, e_route_cnt->src_gateway);
583 xbt_dynar_foreach(route_src, cpt, link) {
584 xbt_dynar_push(*route, &link);
586 xbt_dynar_free(&route_src);
589 xbt_assert(latency_src >= 0.0,
590 "latency error on route between \"%s\" and \"%s\"",
591 src, e_route_cnt->src_gateway);
592 *latency += latency_src;
597 xbt_dynar_foreach(e_route_cnt->link_list, cpt, link) {
598 xbt_dynar_push(*route, &link);
602 /* If dest gateway is not our destination, we have to recursively find our way from this point */
603 if (strcmp(e_route_cnt->dst_gateway, dst)) {
605 xbt_dynar_t route_dst;
607 _get_route_and_latency(e_route_cnt->dst_gateway, dst,
608 (route ? &route_dst : NULL),
609 (latency ? &latency_dst : NULL));
611 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
612 e_route_cnt->dst_gateway, dst);
613 xbt_dynar_foreach(route_dst, cpt, link) {
614 xbt_dynar_push(*route, &link);
616 xbt_dynar_free(&route_dst);
619 xbt_assert(latency_dst >= 0.0,
620 "latency error on route between \"%s\" and \"%s\"",
621 e_route_cnt->dst_gateway, dst);
622 *latency += latency_dst;
626 generic_free_route(e_route_cnt);
630 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
632 void routing_get_route_and_latency(const char *src, const char *dst,
633 xbt_dynar_t * route, double *latency, int cleanup)
635 static xbt_dynar_t last_route = NULL;
637 _get_route_and_latency(src, dst, route, latency);
638 xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
639 xbt_assert(!latency || *latency >= 0.0,
640 "latency error on route between \"%s\" and \"%s\"", src, dst);
642 xbt_dynar_free(&last_route);
643 last_route = cleanup ? *route : NULL;
648 * \brief Find a route between hosts
650 * \param src the source host name
651 * \param dst the destination host name
653 * walk through the routing components tree and find a route between hosts
654 * by calling the differents "get_route" functions in each routing component.
655 * No need to free the returned dynar. It will be freed at the next call.
657 xbt_dynar_t routing_get_route(const char *src, const char *dst) {
658 xbt_dynar_t route = NULL;
659 routing_get_route_and_latency(src, dst, &route, NULL, 1);
664 * \brief Generic method: find a route between hosts
666 * \param src the source host name
667 * \param dst the destination host name
669 * walk through the routing components tree and find a route between hosts
670 * by calling the differents "get_route" functions in each routing component.
671 * Leaves the caller the responsability to clean the returned dynar.
673 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
675 xbt_dynar_t route = NULL;
676 routing_get_route_and_latency(src, dst, &route, NULL, 0);
680 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
682 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
684 //adding my one link routes
687 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
689 xbt_dynar_foreach(onelink_mine, cpt, link) {
690 xbt_dynar_push(ret, &link);
695 xbt_dict_cursor_t cursor = NULL;
697 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
698 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
700 xbt_dynar_foreach(onelink_child, cpt, link) {
701 xbt_dynar_push(ret, &link);
708 static xbt_dynar_t get_onelink_routes(void)
710 return recursive_get_onelink_routes(global_routing->root);
713 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
715 network_element_info_t rc = NULL;
717 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
721 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
725 return SURF_NETWORK_ELEMENT_NULL;
729 * \brief Generic method: create the global routing schema
731 * Make a global routing structure and set all the parsing functions.
733 void routing_model_create(size_t size_of_links, void *loopback)
735 /* config the uniq global routing */
736 global_routing = xbt_new0(s_routing_global_t, 1);
737 global_routing->root = NULL;
738 global_routing->get_route_no_cleanup = get_route_no_cleanup;
739 global_routing->get_onelink_routes = get_onelink_routes;
740 global_routing->loopback = loopback;
741 global_routing->size_of_link = size_of_links;
742 /* no current routing at moment */
743 current_routing = NULL;
747 /* ************************************************** */
748 /* ********** PATERN FOR NEW ROUTING **************** */
750 /* The minimal configuration of a new routing model need the next functions,
751 * also you need to set at the start of the file, the new model in the model
752 * list. Remember keep the null ending of the list.
754 /*** Routing model structure ***/
756 // s_routing_component_t generic_routing;
757 // /* things that your routing model need */
758 // } s_routing_component_NEW_t,*routing_component_NEW_t;
760 /*** Parse routing model functions ***/
761 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
762 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
763 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
764 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
765 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
767 /*** Business methods ***/
768 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
769 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
770 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
772 /*** Creation routing model functions ***/
773 // static void* model_NEW_create(void) {
774 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
775 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
776 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
777 // new_component->generic_routing.set_route = model_NEW_set_route;
778 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
779 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
780 // new_component->generic_routing.get_route = NEW_get_route;
781 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
782 // new_component->generic_routing.finalize = NEW_finalize;
783 // /* initialization of internal structures */
784 // return new_component;
786 // static void model_NEW_load(void) {} /* mandatory */
787 // static void model_NEW_unload(void) {} /* mandatory */
788 // static void model_NEW_end(void) {} /* mandatory */
790 /* ************************************************************************** */
791 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
794 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
796 char *host_id, *groups, *link_id = NULL;
797 xbt_dict_t patterns = NULL;
799 s_sg_platf_host_cbarg_t host;
800 s_sg_platf_link_cbarg_t link;
804 xbt_dynar_t radical_elements;
805 xbt_dynar_t radical_ends;
807 if (strcmp(cluster->availability_trace, "")
808 || strcmp(cluster->state_trace, "")) {
809 patterns = xbt_dict_new();
810 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), free);
811 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), free);
812 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), free);
816 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
817 sg_platf_new_AS_begin(cluster->id, "Cluster");
820 radical_elements = xbt_str_split(cluster->radical, ",");
821 xbt_dynar_foreach(radical_elements, iter, groups) {
823 radical_ends = xbt_str_split(groups, "-");
824 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
826 switch (xbt_dynar_length(radical_ends)) {
831 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
834 surf_parse_error("Malformed radical");
837 for (i = start; i <= end; i++) {
839 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
840 link_id = bprintf("%s_link_%d", cluster->id, i);
842 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
844 memset(&host, 0, sizeof(host));
846 if (strcmp(cluster->availability_trace, "")) {
847 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
848 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
849 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
850 host.power_trace = tmgr_trace_new(avail_file);
851 xbt_free(avail_file);
853 XBT_DEBUG("\tavailability_file=\"\"");
856 if (strcmp(cluster->state_trace, "")) {
857 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
858 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
859 host.state_trace = tmgr_trace_new(avail_file);
860 xbt_free(avail_file);
862 XBT_DEBUG("\tstate_file=\"\"");
865 host.power_peak = cluster->power;
866 host.power_scale = 1.0;
867 host.core_amount = cluster->core_amount;
868 host.initial_state = SURF_RESOURCE_ON;
870 sg_platf_new_host(&host);
871 XBT_DEBUG("</host>");
873 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
874 cluster->bw, cluster->lat);
876 memset(&link, 0, sizeof(link));
878 link.bandwidth = cluster->bw;
879 link.latency = cluster->lat;
880 link.state = SURF_RESOURCE_ON;
881 link.policy = cluster->sharing_policy;
882 sg_platf_new_link(&link);
884 surf_parsing_link_up_down_t info =
885 xbt_new0(s_surf_parsing_link_up_down_t, 1);
886 if (link.policy == SURF_LINK_FULLDUPLEX) {
887 char *tmp_link = bprintf("%s_UP", link_id);
889 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
891 tmp_link = bprintf("%s_DOWN", link_id);
893 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
896 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
897 info->link_down = info->link_up;
899 surf_routing_cluster_add_link(host_id, info);
905 xbt_dynar_free(&radical_ends);
907 xbt_dynar_free(&radical_elements);
909 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
910 // and it's very useful to connect clusters together
912 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
914 s_sg_platf_router_cbarg_t router;
915 memset(&router, 0, sizeof(router));
916 router.id = cluster->router_id;
918 if (!router.id || !strcmp(router.id, ""))
920 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
922 sg_platf_new_router(&router);
926 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
927 char *link_backbone = bprintf("%s_backbone", cluster->id);
928 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
929 cluster->bb_bw, cluster->bb_lat);
931 memset(&link, 0, sizeof(link));
932 link.id = link_backbone;
933 link.bandwidth = cluster->bb_bw;
934 link.latency = cluster->bb_lat;
935 link.state = SURF_RESOURCE_ON;
936 link.policy = cluster->bb_sharing_policy;
938 sg_platf_new_link(&link);
940 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
946 sg_platf_new_AS_end();
948 xbt_dict_free(&patterns); // no op if it were never set
951 static void routing_parse_postparse(void) {
952 xbt_dict_free(&random_value);
955 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
957 static int AX_ptr = 0;
958 char *host_id = NULL;
959 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
961 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
962 static unsigned int surfxml_buffer_stack_stack[1024];
964 surfxml_buffer_stack_stack[0] = 0;
966 surfxml_bufferstack_push(1);
968 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
969 sg_platf_new_AS_begin(peer->id, "Full");
972 host_id = HOST_PEER(peer->id);
973 router_id = ROUTER_PEER(peer->id);
974 link_id_up = LINK_UP_PEER(peer->id);
975 link_id_down = LINK_DOWN_PEER(peer->id);
977 link_router = bprintf("%s_link_router", peer->id);
978 link_backbone = bprintf("%s_backbone", peer->id);
980 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
981 s_sg_platf_host_cbarg_t host;
982 memset(&host, 0, sizeof(host));
983 host.initial_state = SURF_RESOURCE_ON;
985 host.power_peak = peer->power;
986 host.power_scale = 1.0;
987 host.power_trace = peer->availability_trace;
988 host.state_trace = peer->state_trace;
989 host.core_amount = 1;
990 host.coord = peer->coord;
991 sg_platf_new_host(&host);
994 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
995 s_sg_platf_router_cbarg_t router;
996 memset(&router, 0, sizeof(router));
997 router.id = router_id;
998 router.coord = peer->coord;
999 sg_platf_new_router(&router);
1001 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1002 peer->bw_in, peer->lat);
1003 s_sg_platf_link_cbarg_t link;
1004 memset(&link, 0, sizeof(link));
1005 link.state = SURF_RESOURCE_ON;
1006 link.policy = SURF_LINK_SHARED;
1007 link.id = link_id_up;
1008 link.bandwidth = peer->bw_in;
1009 link.latency = peer->lat;
1010 sg_platf_new_link(&link);
1012 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1013 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1014 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1015 peer->bw_out, peer->lat);
1016 link.id = link_id_down;
1017 sg_platf_new_link(&link);
1022 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1023 XBT_DEBUG("symmetrical=\"NO\">");
1024 SURFXML_BUFFER_SET(route_src, host_id);
1025 SURFXML_BUFFER_SET(route_dst, router_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_up);
1030 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
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 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1040 XBT_DEBUG("symmetrical=\"NO\">");
1041 SURFXML_BUFFER_SET(route_src, router_id);
1042 SURFXML_BUFFER_SET(route_dst, host_id);
1043 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1044 SURFXML_START_TAG(route);
1046 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1047 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1048 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1049 SURFXML_START_TAG(link_ctn);
1050 SURFXML_END_TAG(link_ctn);
1052 XBT_DEBUG("</route>");
1053 SURFXML_END_TAG(route);
1056 sg_platf_new_AS_end();
1059 //xbt_dynar_free(&tab_elements_num);
1063 free(link_backbone);
1066 surfxml_bufferstack_pop(1);
1069 static void routing_parse_Srandom(void)
1071 double mean, std, min, max, seed;
1072 char *random_id = A_surfxml_random_id;
1073 char *random_radical = A_surfxml_random_radical;
1074 char *rd_name = NULL;
1076 mean = surf_parse_get_double(A_surfxml_random_mean);
1077 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1078 min = surf_parse_get_double(A_surfxml_random_min);
1079 max = surf_parse_get_double(A_surfxml_random_max);
1080 seed = surf_parse_get_double(A_surfxml_random_seed);
1084 random_data_t random = xbt_new0(s_random_data_t, 1);
1087 xbt_dynar_t radical_elements;
1091 xbt_dynar_t radical_ends;
1093 random->generator = A_surfxml_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 random->generator, random->seed, random_radical);
1120 random_value = xbt_dict_new();
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, free);
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), free);
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), free);
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, free);
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);
1184 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1186 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1187 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1188 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1189 &routing_parse_E_bypassRoute);
1191 sg_platf_cluster_add_cb(routing_parse_cluster);
1193 sg_platf_peer_add_cb(routing_parse_peer);
1194 sg_platf_postparse_add_cb(routing_parse_postparse);
1197 instr_routing_define_callbacks();
1202 * \brief Recursive function for finalize
1204 * \param rc the source host name
1206 * This fuction is call by "finalize". It allow to finalize the
1207 * AS or routing components. It delete all the structures.
1209 static void finalize_rec(AS_t as) {
1210 xbt_dict_cursor_t cursor = NULL;
1214 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1221 /** \brief Frees all memory allocated by the routing module */
1222 void routing_exit(void) {
1223 if (!global_routing)
1225 finalize_rec(global_routing->root);
1226 xbt_free(global_routing);