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; //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 char *replace_random_parameter(char *chaine);
54 static void routing_parse_postparse(void);
56 /* this lines are only for replace use like index in the model table */
61 SURF_MODEL_DIJKSTRACACHE,
68 struct s_model_type routing_models[] = {
70 "Full routing data (fast, large memory requirements, fully expressive)",
71 model_full_create, model_full_end},
73 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
74 model_floyd_create, model_floyd_end},
76 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
77 model_dijkstra_create, model_dijkstra_both_end},
79 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
80 model_dijkstracache_create, model_dijkstra_both_end},
81 {"none", "No routing (usable with Constant network only)",
82 model_none_create, NULL},
83 {"RuleBased", "Rule-Based routing data (...)",
84 model_rulebased_create, NULL},
85 {"Vivaldi", "Vivaldi routing",
86 model_vivaldi_create, NULL},
87 {"Cluster", "Cluster routing",
88 model_cluster_create, NULL},
89 {NULL, NULL, NULL, NULL}
93 * \brief Add a "host" to the network element list
95 static void parse_S_host(sg_platf_host_cbarg_t host)
97 network_element_info_t info = NULL;
98 if (current_routing->hierarchy == SURF_ROUTING_NULL)
99 current_routing->hierarchy = SURF_ROUTING_BASE;
100 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
101 "Reading a host, processing unit \"%s\" already exists", host->id);
103 (*(current_routing->parse_PU)) (current_routing, host->id);
104 info = xbt_new0(s_network_element_info_t, 1);
105 info->rc_component = current_routing;
106 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
107 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
108 if (host->coord && strcmp(host->coord, "")) {
109 if (!COORD_HOST_LEVEL)
111 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
112 xbt_dynar_t ctn = xbt_str_split_str(host->coord, " ");
113 xbt_dynar_shrink(ctn, 0);
114 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
119 * \brief Add a "router" to the network element list
121 static void parse_S_router(sg_platf_router_cbarg_t router)
123 network_element_info_t info = NULL;
124 if (current_routing->hierarchy == SURF_ROUTING_NULL)
125 current_routing->hierarchy = SURF_ROUTING_BASE;
126 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
127 "Reading a router, processing unit \"%s\" already exists",
130 (*(current_routing->parse_PU)) (current_routing, router->id);
131 info = xbt_new0(s_network_element_info_t, 1);
132 info->rc_component = current_routing;
133 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
135 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
136 if (strcmp(router->coord, "")) {
137 if (!COORD_ASR_LEVEL)
139 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
140 xbt_dynar_t ctn = xbt_str_split_str(router->coord, " ");
141 xbt_dynar_shrink(ctn, 0);
142 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
148 * \brief Set the end points for a route
150 static void routing_parse_S_route(void)
152 if (src != NULL && dst != NULL && link_list != NULL)
153 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
154 A_surfxml_route_src, A_surfxml_route_dst);
155 src = A_surfxml_route_src;
156 dst = A_surfxml_route_dst;
157 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
158 "Some limits are null in the route between \"%s\" and \"%s\"",
160 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
164 * \brief Set the end points and gateways for a ASroute
166 static void routing_parse_S_ASroute(void)
168 if (src != NULL && dst != NULL && link_list != NULL)
169 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
170 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
171 src = A_surfxml_ASroute_src;
172 dst = A_surfxml_ASroute_dst;
173 gw_src = A_surfxml_ASroute_gw_src;
174 gw_dst = A_surfxml_ASroute_gw_dst;
175 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
176 || strlen(gw_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 for a bypassRoute
185 static void routing_parse_S_bypassRoute(void)
187 if (src != NULL && dst != NULL && link_list != NULL)
189 "Bypass Route between %s to %s can not be defined",
190 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
191 src = A_surfxml_bypassRoute_src;
192 dst = A_surfxml_bypassRoute_dst;
193 gw_src = A_surfxml_bypassRoute_gw_src;
194 gw_dst = A_surfxml_bypassRoute_gw_dst;
195 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
196 || strlen(gw_dst) > 0,
197 "Some limits are null in the route between \"%s\" and \"%s\"",
199 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
203 * \brief Set a new link on the actual list of link for a route or ASroute from XML
206 static void routing_parse_link_ctn(void)
209 switch (A_surfxml_link_ctn_direction) {
210 case AU_surfxml_link_ctn_direction:
211 case A_surfxml_link_ctn_direction_NONE:
212 link_id = xbt_strdup(A_surfxml_link_ctn_id);
214 case A_surfxml_link_ctn_direction_UP:
215 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
217 case A_surfxml_link_ctn_direction_DOWN:
218 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
221 xbt_dynar_push(link_list, &link_id);
225 * \brief Store the route by calling the set_route function of the current routing component
227 static void routing_parse_E_route(void)
229 route_extended_t route = xbt_new0(s_route_extended_t, 1);
230 route->generic_route.link_list = link_list;
231 xbt_assert(current_routing->parse_route,
232 "no defined method \"set_route\" in \"%s\"",
233 current_routing->name);
234 (*(current_routing->parse_route)) (current_routing, src, dst, route);
241 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
243 static void routing_parse_E_ASroute(void)
245 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
246 e_route->generic_route.link_list = link_list;
247 e_route->src_gateway = xbt_strdup(gw_src);
248 e_route->dst_gateway = xbt_strdup(gw_dst);
249 xbt_assert(current_routing->parse_ASroute,
250 "no defined method \"set_ASroute\" in \"%s\"",
251 current_routing->name);
252 (*(current_routing->parse_ASroute)) (current_routing, src, dst, e_route);
261 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
263 static void routing_parse_E_bypassRoute(void)
265 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
266 e_route->generic_route.link_list = link_list;
267 e_route->src_gateway = xbt_strdup(gw_src);
268 e_route->dst_gateway = xbt_strdup(gw_dst);
269 xbt_assert(current_routing->parse_bypassroute,
270 "Bypassing mechanism not implemented by routing '%s'",
271 current_routing->name);
272 (*(current_routing->parse_bypassroute)) (current_routing, src, dst, e_route);
281 * \brief Make a new routing component to the platform
283 * Add a new autonomous system to the platform. Any elements (such as host,
284 * router or sub-AS) added after this call and before the corresponding call
285 * to sg_platf_new_AS_close() will be added to this AS.
287 * Once this function was called, the configuration concerning the used
288 * models cannot be changed anymore.
290 * @param AS_id name of this autonomous system. Must be unique in the platform
291 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
293 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
296 routing_model_description_t model = NULL;
299 /* search the routing model */
300 for (cpt = 0; routing_models[cpt].name; cpt++)
301 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
302 model = &routing_models[cpt];
303 /* if its not exist, error */
305 fprintf(stderr, "Routing model %s not found. Existing models:\n",
306 wanted_routing_type);
307 for (cpt = 0; routing_models[cpt].name; cpt++)
308 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
309 routing_models[cpt].desc);
313 /* make a new routing component */
314 new_as = (AS_t) (*(model->create)) ();
315 new_as->model_desc = model;
316 new_as->hierarchy = SURF_ROUTING_NULL;
317 new_as->name = xbt_strdup(AS_id);
319 if (current_routing == NULL && global_routing->root == NULL) {
321 /* it is the first one */
322 new_as->routing_father = NULL;
323 global_routing->root = new_as;
325 } else if (current_routing != NULL && global_routing->root != NULL) {
327 xbt_assert(!xbt_dict_get_or_null
328 (current_routing->routing_sons, AS_id),
329 "The AS \"%s\" already exists", AS_id);
330 /* it is a part of the tree */
331 new_as->routing_father = current_routing;
332 /* set the father behavior */
333 if (current_routing->hierarchy == SURF_ROUTING_NULL)
334 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
335 /* add to the sons dictionary */
336 xbt_dict_set(current_routing->routing_sons, AS_id,
337 (void *) new_as, NULL);
338 /* add to the father element list */
339 (*(current_routing->parse_AS)) (current_routing, AS_id);
341 THROWF(arg_error, 0, "All defined components must be belong to a AS");
343 /* set the new current component of the tree */
344 current_routing = new_as;
348 * \brief Specify that the current description of AS is finished
350 * Once you've declared all the content of your AS, you have to close
351 * it with this call. Your AS is not usable until you call this function.
353 * @fixme: this call is not as robust as wanted: bad things WILL happen
354 * if you call it twice for the same AS, or if you forget calling it, or
355 * even if you add stuff to a closed AS
358 void routing_AS_end()
361 if (current_routing == NULL) {
362 THROWF(arg_error, 0, "Close an AS, but none was under construction");
364 network_element_info_t info = NULL;
365 xbt_assert(!xbt_lib_get_or_null
366 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
367 "The AS \"%s\" already exists", current_routing->name);
368 info = xbt_new0(s_network_element_info_t, 1);
369 info->rc_component = current_routing->routing_father;
370 info->rc_type = SURF_NETWORK_ELEMENT_AS;
371 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
374 if (current_routing->model_desc->end)
375 (*(current_routing->model_desc->end)) (current_routing);
376 current_routing = current_routing->routing_father;
380 /* Aux Business methods */
383 * \brief Get the AS father and the first elements of the chain
385 * \param src the source host name
386 * \param dst the destination host name
388 * Get the common father of the to processing units, and the first different
389 * father in the chain
391 static void elements_father(const char *src, const char *dst,
396 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
397 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
399 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
400 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
408 /* (1) find the as where the src and dst are located */
409 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
411 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
414 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
416 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
417 src_as = src_data->rc_component;
418 dst_as = dst_data->rc_component;
420 xbt_assert(src_as && dst_as,
421 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
423 /* (2) find the path to the root routing component */
424 for (current = src_as; current != NULL; current = current->routing_father) {
425 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
426 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
427 path_src[index_src++] = current;
429 for (current = dst_as; current != NULL; current = current->routing_father) {
430 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
431 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
432 path_dst[index_dst++] = current;
435 /* (3) find the common father */
437 current_src = path_src[--index_src];
438 current_dst = path_dst[--index_dst];
439 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
441 /* (4) they are not in the same routing component, make the path */
442 if (current_src == current_dst)
443 father = current_src;
445 father = path_src[index_src + 1];
447 /* (5) result generation */
448 *res_father = father; /* first the common father of src and dst */
449 *res_src = current_src; /* second the first different father of src */
450 *res_dst = current_dst; /* three the first different father of dst */
452 #undef ELEMENTS_FATHER_MAXDEPTH
455 /* Global Business methods */
458 * \brief Recursive function for get_route_latency
460 * \param src the source host name
461 * \param dst the destination host name
462 * \param *e_route the route where the links are stored
463 * \param *latency the latency, if needed
465 * This function is called by "get_route" and "get_latency". It allows to walk
466 * recursively through the routing components tree.
468 static void _get_route_latency(const char *src, const char *dst,
469 xbt_dynar_t * route, double *latency)
471 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
472 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
477 elements_father(src, dst, &common_father, &src_father, &dst_father);
479 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
481 route_extended_t e_route = NULL;
483 e_route = common_father->get_route(common_father, src, dst);
484 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
485 *route = e_route->generic_route.link_list;
488 *latency = common_father->get_latency(common_father, src, dst, e_route);
489 xbt_assert(*latency >= 0.0,
490 "latency error on route between \"%s\" and \"%s\"", src, dst);
493 xbt_free(e_route->src_gateway);
494 xbt_free(e_route->dst_gateway);
498 } else { /* SURF_ROUTING_RECURSIVE */
500 route_extended_t e_route_bypass = NULL;
501 if (common_father->get_bypass_route)
502 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
504 xbt_assert(!latency || !e_route_bypass,
505 "Bypass cannot work yet with get_latency");
507 route_extended_t e_route_cnt = e_route_bypass
508 ? e_route_bypass : common_father->get_route(common_father,
512 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
513 src_father->name, dst_father->name);
515 xbt_assert((e_route_cnt->src_gateway == NULL) ==
516 (e_route_cnt->dst_gateway == NULL),
517 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
520 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
523 *latency = common_father->get_latency(common_father,
524 src_father->name, dst_father->name,
526 xbt_assert(*latency >= 0.0,
527 "latency error on route between \"%s\" and \"%s\"",
528 src_father->name, dst_father->name);
534 if (strcmp(src, e_route_cnt->src_gateway)) {
536 xbt_dynar_t route_src;
538 _get_route_latency(src, e_route_cnt->src_gateway,
539 (route ? &route_src : NULL),
540 (latency ? &latency_src : NULL));
542 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
543 src, e_route_cnt->src_gateway);
544 xbt_dynar_foreach(route_src, cpt, link) {
545 xbt_dynar_push(*route, &link);
547 xbt_dynar_free(&route_src);
550 xbt_assert(latency_src >= 0.0,
551 "latency error on route between \"%s\" and \"%s\"",
552 src, e_route_cnt->src_gateway);
553 *latency += latency_src;
558 xbt_dynar_foreach(e_route_cnt->generic_route.link_list, cpt, link) {
559 xbt_dynar_push(*route, &link);
563 if (strcmp(e_route_cnt->dst_gateway, dst)) {
565 xbt_dynar_t route_dst;
567 _get_route_latency(e_route_cnt->dst_gateway, dst,
568 (route ? &route_dst : NULL),
569 (latency ? &latency_dst : NULL));
571 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
572 e_route_cnt->dst_gateway, dst);
573 xbt_dynar_foreach(route_dst, cpt, link) {
574 xbt_dynar_push(*route, &link);
576 xbt_dynar_free(&route_dst);
579 xbt_assert(latency_dst >= 0.0,
580 "latency error on route between \"%s\" and \"%s\"",
581 e_route_cnt->dst_gateway, dst);
582 *latency += latency_dst;
586 generic_free_extended_route(e_route_cnt);
591 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
593 static void get_route_latency(const char *src, const char *dst,
594 xbt_dynar_t * route, double *latency, int cleanup)
596 static xbt_dynar_t last_route = NULL;
598 _get_route_latency(src, dst, route, latency);
599 xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
600 xbt_assert(!latency || *latency >= 0.0,
601 "latency error on route between \"%s\" and \"%s\"", src, dst);
603 xbt_dynar_free(&last_route);
604 last_route = cleanup ? *route : NULL;
609 * \brief Find a route between hosts
611 * \param src the source host name
612 * \param dst the destination host name
614 * walk through the routing components tree and find a route between hosts
615 * by calling the differents "get_route" functions in each routing component.
616 * No need to free the returned dynar. It will be freed at the next call.
618 xbt_dynar_t routing_get_route(const char *src, const char *dst) {
619 xbt_dynar_t route = NULL;
620 get_route_latency(src, dst, &route, NULL, 1);
625 * \brief Generic method: find a route between hosts
627 * \param src the source host name
628 * \param dst the destination host name
630 * walk through the routing components tree and find a route between hosts
631 * by calling the differents "get_route" functions in each routing component.
632 * Leaves the caller the responsability to clean the returned dynar.
634 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
636 xbt_dynar_t route = NULL;
637 get_route_latency(src, dst, &route, NULL, 0);
641 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
643 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
645 //adding my one link routes
648 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
650 xbt_dynar_foreach(onelink_mine, cpt, link) {
651 xbt_dynar_push(ret, &link);
656 xbt_dict_cursor_t cursor = NULL;
658 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
659 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
661 xbt_dynar_foreach(onelink_child, cpt, link) {
662 xbt_dynar_push(ret, &link);
669 static xbt_dynar_t get_onelink_routes(void)
671 return recursive_get_onelink_routes(global_routing->root);
674 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
676 network_element_info_t rc = NULL;
678 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
682 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
686 return SURF_NETWORK_ELEMENT_NULL;
690 * \brief Generic method: create the global routing schema
692 * Make a global routing structure and set all the parsing functions.
694 void routing_model_create(size_t size_of_links, void *loopback)
696 /* config the uniq global routing */
697 global_routing = xbt_new0(s_routing_global_t, 1);
698 global_routing->root = NULL;
699 global_routing->get_route_no_cleanup = get_route_no_cleanup;
700 global_routing->get_onelink_routes = get_onelink_routes;
701 global_routing->get_route_latency = get_route_latency;
702 global_routing->loopback = loopback;
703 global_routing->size_of_link = size_of_links;
704 /* no current routing at moment */
705 current_routing = NULL;
709 /* ************************************************** */
710 /* ********** PATERN FOR NEW ROUTING **************** */
712 /* The minimal configuration of a new routing model need the next functions,
713 * also you need to set at the start of the file, the new model in the model
714 * list. Remember keep the null ending of the list.
716 /*** Routing model structure ***/
718 // s_routing_component_t generic_routing;
719 // /* things that your routing model need */
720 // } s_routing_component_NEW_t,*routing_component_NEW_t;
722 /*** Parse routing model functions ***/
723 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
724 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
725 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
726 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
727 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
729 /*** Business methods ***/
730 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
731 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
732 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
734 /*** Creation routing model functions ***/
735 // static void* model_NEW_create(void) {
736 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
737 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
738 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
739 // new_component->generic_routing.set_route = model_NEW_set_route;
740 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
741 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
742 // new_component->generic_routing.get_route = NEW_get_route;
743 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
744 // new_component->generic_routing.finalize = NEW_finalize;
745 // /* initialization of internal structures */
746 // return new_component;
748 // static void model_NEW_load(void) {} /* mandatory */
749 // static void model_NEW_unload(void) {} /* mandatory */
750 // static void model_NEW_end(void) {} /* mandatory */
752 /* ************************************************************************** */
753 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
756 static void routing_parse_cluster(void)
758 char *host_id, *groups, *link_id = NULL;
759 xbt_dict_t patterns = NULL;
761 s_sg_platf_host_cbarg_t host;
762 s_sg_platf_link_cbarg_t link;
764 if (strcmp(struct_cluster->availability_trace, "")
765 || strcmp(struct_cluster->state_trace, "")) {
766 patterns = xbt_dict_new();
767 xbt_dict_set(patterns, "id", xbt_strdup(struct_cluster->id), free);
768 xbt_dict_set(patterns, "prefix", xbt_strdup(struct_cluster->prefix), free);
769 xbt_dict_set(patterns, "suffix", xbt_strdup(struct_cluster->suffix), free);
774 xbt_dynar_t radical_elements;
775 xbt_dynar_t radical_ends;
777 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", struct_cluster->id);
778 sg_platf_new_AS_begin(struct_cluster->id, "Cluster");
781 radical_elements = xbt_str_split(struct_cluster->radical, ",");
782 xbt_dynar_foreach(radical_elements, iter, groups) {
783 memset(&host, 0, sizeof(host));
785 radical_ends = xbt_str_split(groups, "-");
786 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
788 switch (xbt_dynar_length(radical_ends)) {
793 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
796 surf_parse_error("Malformed radical");
799 for (i = start; i <= end; i++) {
801 bprintf("%s%d%s", struct_cluster->prefix, i, struct_cluster->suffix);
802 link_id = bprintf("%s_link_%d", struct_cluster->id, i);
804 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id,
805 struct_cluster->power);
807 if (strcmp(struct_cluster->availability_trace, "")) {
808 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
809 char *tmp_availability_file =
810 xbt_str_varsubst(struct_cluster->availability_trace, patterns);
811 XBT_DEBUG("\tavailability_file=\"%s\"", tmp_availability_file);
812 host.power_trace = tmgr_trace_new(tmp_availability_file);
813 xbt_free(tmp_availability_file);
815 XBT_DEBUG("\tavailability_file=\"\"");
817 if (strcmp(struct_cluster->state_trace, "")) {
818 char *tmp_state_file =
819 xbt_str_varsubst(struct_cluster->state_trace, patterns);
820 XBT_DEBUG("\tstate_file=\"%s\"", tmp_state_file);
821 host.state_trace = tmgr_trace_new(tmp_state_file);
822 xbt_free(tmp_state_file);
824 XBT_DEBUG("\tstate_file=\"\"");
827 host.power_peak = struct_cluster->power;
828 host.power_scale = 1.0;
829 host.core_amount = struct_cluster->core_amount;
830 host.initial_state = SURF_RESOURCE_ON;
832 sg_platf_new_host(&host);
833 XBT_DEBUG("</host>");
835 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
836 struct_cluster->bw, struct_cluster->lat);
838 memset(&link, 0, sizeof(link));
840 link.bandwidth = struct_cluster->bw;
841 link.latency = struct_cluster->lat;
842 link.state = SURF_RESOURCE_ON;
844 switch (struct_cluster->sharing_policy) {
845 case A_surfxml_cluster_sharing_policy_SHARED:
846 link.policy = SURF_LINK_SHARED;
848 case A_surfxml_cluster_sharing_policy_FULLDUPLEX:
849 link.policy = SURF_LINK_FULLDUPLEX;
851 case A_surfxml_cluster_sharing_policy_FATPIPE:
852 link.policy = SURF_LINK_FATPIPE;
855 surf_parse_error(bprintf
856 ("Invalid cluster sharing policy for cluster %s",
857 struct_cluster->id));
860 sg_platf_new_link(&link);
862 surf_parsing_link_up_down_t info =
863 xbt_new0(s_surf_parsing_link_up_down_t, 1);
864 if (link.policy == SURF_LINK_FULLDUPLEX) {
865 char *tmp_link = bprintf("%s_UP", link_id);
867 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
869 tmp_link = bprintf("%s_DOWN", link_id);
871 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
874 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
875 info->link_down = info->link_up;
877 surf_routing_cluster_add_link(host_id, info);
883 xbt_dynar_free(&radical_ends);
885 xbt_dynar_free(&radical_elements);
887 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written, and it's very useful to connect clusters together
889 XBT_DEBUG("<router id=\"%s\"/>", struct_cluster->router_id);
890 s_sg_platf_router_cbarg_t router;
892 memset(&router, 0, sizeof(router));
893 router.id = struct_cluster->router_id;
895 if (!router.id || !strcmp(router.id, ""))
897 bprintf("%s%s_router%s", struct_cluster->prefix, struct_cluster->id,
898 struct_cluster->suffix);
899 sg_platf_new_router(&router);
903 if ((struct_cluster->bb_bw != 0) && (struct_cluster->bb_lat != 0)) {
904 char *link_backbone = bprintf("%s_backbone", struct_cluster->id);
905 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
906 struct_cluster->bb_bw, struct_cluster->bb_lat);
908 memset(&link, 0, sizeof(link));
909 link.id = link_backbone;
910 link.bandwidth = struct_cluster->bb_bw;
911 link.latency = struct_cluster->bb_lat;
912 link.state = SURF_RESOURCE_ON;
914 switch (struct_cluster->bb_sharing_policy) {
915 case A_surfxml_cluster_bb_sharing_policy_FATPIPE:
916 link.policy = SURF_LINK_FATPIPE;
918 case A_surfxml_cluster_bb_sharing_policy_SHARED:
919 link.policy = SURF_LINK_SHARED;
922 surf_parse_error(bprintf
923 ("Invalid bb sharing policy in cluster %s",
924 struct_cluster->id));
928 sg_platf_new_link(&link);
930 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
937 char *new_suffix = xbt_strdup("");
939 radical_elements = xbt_str_split(struct_cluster->suffix, ".");
940 xbt_dynar_foreach(radical_elements, iter, groups) {
941 if (strcmp(groups, "")) {
942 char *old_suffix = new_suffix;
943 new_suffix = bprintf("%s\\.%s", old_suffix, groups);
948 xbt_dynar_free(&radical_elements);
949 xbt_free(new_suffix);
952 sg_platf_new_AS_end();
954 xbt_dict_free(&patterns); // no op if it were never set
957 static void routing_parse_postparse(void) {
958 xbt_dict_free(&random_value);
961 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
963 static int AX_ptr = 0;
964 char *host_id = NULL;
965 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
967 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
968 static unsigned int surfxml_buffer_stack_stack[1024];
970 surfxml_buffer_stack_stack[0] = 0;
972 surfxml_bufferstack_push(1);
974 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
975 sg_platf_new_AS_begin(peer->id, "Full");
978 host_id = HOST_PEER(peer->id);
979 router_id = ROUTER_PEER(peer->id);
980 link_id_up = LINK_UP_PEER(peer->id);
981 link_id_down = LINK_DOWN_PEER(peer->id);
983 link_router = bprintf("%s_link_router", peer->id);
984 link_backbone = bprintf("%s_backbone", peer->id);
986 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
987 s_sg_platf_host_cbarg_t host;
988 memset(&host, 0, sizeof(host));
989 host.initial_state = SURF_RESOURCE_ON;
991 host.power_peak = peer->power;
992 host.power_scale = 1.0;
993 host.power_trace = peer->availability_trace;
994 host.state_trace = peer->state_trace;
995 host.core_amount = 1;
996 sg_platf_new_host(&host);
999 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1000 s_sg_platf_router_cbarg_t router;
1001 memset(&router, 0, sizeof(router));
1002 router.id = router_id;
1003 router.coord = peer->coord;
1004 sg_platf_new_router(&router);
1006 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1007 peer->bw_in, peer->lat);
1008 s_sg_platf_link_cbarg_t link;
1009 memset(&link, 0, sizeof(link));
1010 link.state = SURF_RESOURCE_ON;
1011 link.policy = SURF_LINK_SHARED;
1012 link.id = link_id_up;
1013 link.bandwidth = peer->bw_in;
1014 link.latency = peer->lat;
1015 sg_platf_new_link(&link);
1017 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1018 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1019 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1020 peer->bw_out, peer->lat);
1021 link.id = link_id_down;
1022 sg_platf_new_link(&link);
1027 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1028 XBT_DEBUG("symmetrical=\"NO\">");
1029 SURFXML_BUFFER_SET(route_src, host_id);
1030 SURFXML_BUFFER_SET(route_dst, router_id);
1031 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1032 SURFXML_START_TAG(route);
1034 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1035 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1036 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1037 SURFXML_START_TAG(link_ctn);
1038 SURFXML_END_TAG(link_ctn);
1040 XBT_DEBUG("</route>");
1041 SURFXML_END_TAG(route);
1044 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1045 XBT_DEBUG("symmetrical=\"NO\">");
1046 SURFXML_BUFFER_SET(route_src, router_id);
1047 SURFXML_BUFFER_SET(route_dst, host_id);
1048 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1049 SURFXML_START_TAG(route);
1051 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1052 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1053 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1054 SURFXML_START_TAG(link_ctn);
1055 SURFXML_END_TAG(link_ctn);
1057 XBT_DEBUG("</route>");
1058 SURFXML_END_TAG(route);
1061 sg_platf_new_AS_end();
1064 //xbt_dynar_free(&tab_elements_num);
1068 free(link_backbone);
1071 surfxml_bufferstack_pop(1);
1074 static void routing_parse_Srandom(void)
1076 double mean, std, min, max, seed;
1077 char *random_id = A_surfxml_random_id;
1078 char *random_radical = A_surfxml_random_radical;
1079 char *rd_name = NULL;
1081 mean = surf_parse_get_double(A_surfxml_random_mean);
1082 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1083 min = surf_parse_get_double(A_surfxml_random_min);
1084 max = surf_parse_get_double(A_surfxml_random_max);
1085 seed = surf_parse_get_double(A_surfxml_random_seed);
1089 random_data_t random = xbt_new0(s_random_data_t, 1);
1092 xbt_dynar_t radical_elements;
1096 xbt_dynar_t radical_ends;
1098 random->generator = A_surfxml_random_generator;
1099 random->seed = seed;
1103 /* Check user stupidities */
1105 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1107 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1109 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1111 /* normalize the mean and standard deviation before storing */
1112 random->mean = (mean - min) / (max - min);
1113 random->std = std / (max - min);
1115 if (random->mean * (1 - random->mean) < random->std * random->std)
1116 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1117 random->mean, random->std);
1120 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1121 random_id, random->min, random->max, random->mean, random->std,
1122 random->generator, random->seed, random_radical);
1124 if (xbt_dict_size(random_value) == 0)
1125 random_value = xbt_dict_new();
1127 if (!strcmp(random_radical, "")) {
1128 res = random_generate(random);
1129 rd_value = bprintf("%f", res);
1130 xbt_dict_set(random_value, random_id, rd_value, free);
1132 radical_elements = xbt_str_split(random_radical, ",");
1133 xbt_dynar_foreach(radical_elements, iter, groups) {
1134 radical_ends = xbt_str_split(groups, "-");
1135 switch (xbt_dynar_length(radical_ends)) {
1137 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1138 "Custom Random '%s' already exists !", random_id);
1139 res = random_generate(random);
1141 bprintf("%s%d", random_id,
1142 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1143 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1148 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1149 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1150 for (i = start; i <= end; i++) {
1151 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1152 "Custom Random '%s' already exists !", bprintf("%s%d",
1155 res = random_generate(random);
1156 tmpbuf = bprintf("%s%d", random_id, i);
1157 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1162 XBT_INFO("Malformed radical");
1165 res = random_generate(random);
1166 rd_name = bprintf("%s_router", random_id);
1167 rd_value = bprintf("%f", res);
1168 xbt_dict_set(random_value, rd_name, rd_value, free);
1170 xbt_dynar_free(&radical_ends);
1173 xbt_dynar_free(&radical_elements);
1177 void routing_register_callbacks()
1179 sg_platf_host_add_cb(parse_S_host);
1180 sg_platf_router_add_cb(parse_S_router);
1182 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1184 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1185 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1186 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1187 &routing_parse_S_bypassRoute);
1189 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1191 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1192 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1193 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1194 &routing_parse_E_bypassRoute);
1196 surfxml_add_callback(STag_surfxml_cluster_cb_list, &routing_parse_cluster);
1198 sg_platf_peer_add_cb(routing_parse_peer);
1199 sg_platf_postparse_add_cb(routing_parse_postparse);
1202 instr_routing_define_callbacks();
1207 * \brief Recursive function for finalize
1209 * \param rc the source host name
1211 * This fuction is call by "finalize". It allow to finalize the
1212 * AS or routing components. It delete all the structures.
1214 static void finalize_rec(AS_t as) {
1215 xbt_dict_cursor_t cursor = NULL;
1219 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1226 /** \brief Frees all memory allocated by the routing module */
1227 void routing_exit(void) {
1228 if (!global_routing)
1230 finalize_rec(global_routing->root);
1231 xbt_free(global_routing);