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 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, "")) {
108 if (!COORD_HOST_LEVEL)
110 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
111 xbt_dynar_t ctn = xbt_str_split_str(host->coord, " ");
112 xbt_dynar_shrink(ctn, 0);
113 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
118 * \brief Add a "router" to the network element list
120 static void parse_S_router(sg_platf_router_cbarg_t router)
122 network_element_info_t info = NULL;
123 if (current_routing->hierarchy == SURF_ROUTING_NULL)
124 current_routing->hierarchy = SURF_ROUTING_BASE;
125 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
126 "Reading a router, processing unit \"%s\" already exists",
129 current_routing->parse_PU(current_routing, router->id);
130 info = xbt_new0(s_network_element_info_t, 1);
131 info->rc_component = current_routing;
132 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
134 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
135 if (strcmp(router->coord, "")) {
136 if (!COORD_ASR_LEVEL)
138 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
139 xbt_dynar_t ctn = xbt_str_split_str(router->coord, " ");
140 xbt_dynar_shrink(ctn, 0);
141 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
147 * \brief Set the end points for a route
149 static void routing_parse_S_route(void)
151 if (src != NULL && dst != NULL && link_list != NULL)
152 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
153 A_surfxml_route_src, A_surfxml_route_dst);
154 src = A_surfxml_route_src;
155 dst = A_surfxml_route_dst;
156 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
157 "Some limits are null in the route between \"%s\" and \"%s\"",
159 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
163 * \brief Set the end points and gateways for a ASroute
165 static void routing_parse_S_ASroute(void)
167 if (src != NULL && dst != NULL && link_list != NULL)
168 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
169 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
170 src = A_surfxml_ASroute_src;
171 dst = A_surfxml_ASroute_dst;
172 gw_src = A_surfxml_ASroute_gw_src;
173 gw_dst = A_surfxml_ASroute_gw_dst;
174 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
175 || strlen(gw_dst) > 0,
176 "Some limits are null in the route between \"%s\" and \"%s\"",
178 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
182 * \brief Set the end points for a bypassRoute
184 static void routing_parse_S_bypassRoute(void)
186 if (src != NULL && dst != NULL && link_list != NULL)
188 "Bypass Route between %s to %s can not be defined",
189 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
190 src = A_surfxml_bypassRoute_src;
191 dst = A_surfxml_bypassRoute_dst;
192 gw_src = A_surfxml_bypassRoute_gw_src;
193 gw_dst = A_surfxml_bypassRoute_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 a new link on the actual list of link for a route or ASroute from XML
205 static void routing_parse_link_ctn(void)
208 switch (A_surfxml_link_ctn_direction) {
209 case AU_surfxml_link_ctn_direction:
210 case A_surfxml_link_ctn_direction_NONE:
211 link_id = xbt_strdup(A_surfxml_link_ctn_id);
213 case A_surfxml_link_ctn_direction_UP:
214 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
216 case A_surfxml_link_ctn_direction_DOWN:
217 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
220 xbt_dynar_push(link_list, &link_id);
224 * \brief Store the route by calling the set_route function of the current routing component
226 static void routing_parse_E_route(void)
228 route_t route = xbt_new0(s_route_t, 1);
229 route->link_list = link_list;
230 xbt_assert(current_routing->parse_route,
231 "no defined method \"set_route\" in \"%s\"",
232 current_routing->name);
233 current_routing->parse_route(current_routing, src, dst, route);
240 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
242 static void routing_parse_E_ASroute(void)
244 route_t e_route = xbt_new0(s_route_t, 1);
245 e_route->link_list = link_list;
246 e_route->src_gateway = xbt_strdup(gw_src);
247 e_route->dst_gateway = xbt_strdup(gw_dst);
248 xbt_assert(current_routing->parse_ASroute,
249 "no defined method \"set_ASroute\" in \"%s\"",
250 current_routing->name);
251 current_routing->parse_ASroute(current_routing, src, dst, e_route);
260 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
262 static void routing_parse_E_bypassRoute(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_bypassroute,
269 "Bypassing mechanism not implemented by routing '%s'",
270 current_routing->name);
271 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
280 * \brief Make a new routing component to the platform
282 * Add a new autonomous system to the platform. Any elements (such as host,
283 * router or sub-AS) added after this call and before the corresponding call
284 * to sg_platf_new_AS_close() will be added to this AS.
286 * Once this function was called, the configuration concerning the used
287 * models cannot be changed anymore.
289 * @param AS_id name of this autonomous system. Must be unique in the platform
290 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
292 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
295 routing_model_description_t model = NULL;
298 /* search the routing model */
299 for (cpt = 0; routing_models[cpt].name; cpt++)
300 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
301 model = &routing_models[cpt];
302 /* if its not exist, error */
304 fprintf(stderr, "Routing model %s not found. Existing models:\n",
305 wanted_routing_type);
306 for (cpt = 0; routing_models[cpt].name; cpt++)
307 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
308 routing_models[cpt].desc);
312 /* make a new routing component */
313 new_as = (AS_t) model->create();
314 new_as->model_desc = model;
315 new_as->hierarchy = SURF_ROUTING_NULL;
316 new_as->name = xbt_strdup(AS_id);
318 if (current_routing == NULL && global_routing->root == NULL) {
320 /* it is the first one */
321 new_as->routing_father = NULL;
322 global_routing->root = new_as;
324 } else if (current_routing != NULL && global_routing->root != NULL) {
326 xbt_assert(!xbt_dict_get_or_null
327 (current_routing->routing_sons, AS_id),
328 "The AS \"%s\" already exists", AS_id);
329 /* it is a part of the tree */
330 new_as->routing_father = current_routing;
331 /* set the father behavior */
332 if (current_routing->hierarchy == SURF_ROUTING_NULL)
333 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
334 /* add to the sons dictionary */
335 xbt_dict_set(current_routing->routing_sons, AS_id,
336 (void *) new_as, NULL);
337 /* add to the father element list */
338 current_routing->parse_AS(current_routing, AS_id);
340 THROWF(arg_error, 0, "All defined components must be belong to a AS");
342 /* set the new current component of the tree */
343 current_routing = new_as;
347 * \brief Specify that the current description of AS is finished
349 * Once you've declared all the content of your AS, you have to close
350 * it with this call. Your AS is not usable until you call this function.
352 * @fixme: this call is not as robust as wanted: bad things WILL happen
353 * if you call it twice for the same AS, or if you forget calling it, or
354 * even if you add stuff to a closed AS
357 void routing_AS_end()
360 if (current_routing == NULL) {
361 THROWF(arg_error, 0, "Close an AS, but none was under construction");
363 network_element_info_t info = NULL;
364 xbt_assert(!xbt_lib_get_or_null
365 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
366 "The AS \"%s\" already exists", current_routing->name);
367 info = xbt_new0(s_network_element_info_t, 1);
368 info->rc_component = current_routing->routing_father;
369 info->rc_type = SURF_NETWORK_ELEMENT_AS;
370 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
373 if (current_routing->model_desc->end)
374 current_routing->model_desc->end(current_routing);
375 current_routing = current_routing->routing_father;
379 /* Aux Business methods */
382 * \brief Get the AS father and the first elements of the chain
384 * \param src the source host name
385 * \param dst the destination host name
387 * Get the common father of the to processing units, and the first different
388 * father in the chain
390 static void elements_father(const char *src, const char *dst,
395 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
396 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
398 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
399 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
407 /* (1) find the as where the src and dst are located */
408 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
410 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
413 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
415 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
416 src_as = src_data->rc_component;
417 dst_as = dst_data->rc_component;
419 xbt_assert(src_as && dst_as,
420 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
422 /* (2) find the path to the root routing component */
423 for (current = src_as; current != NULL; current = current->routing_father) {
424 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
425 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
426 path_src[index_src++] = current;
428 for (current = dst_as; current != NULL; current = current->routing_father) {
429 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
430 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
431 path_dst[index_dst++] = current;
434 /* (3) find the common father */
436 current_src = path_src[--index_src];
437 current_dst = path_dst[--index_dst];
438 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
440 /* (4) they are not in the same routing component, make the path */
441 if (current_src == current_dst)
442 father = current_src;
444 father = path_src[index_src + 1];
446 /* (5) result generation */
447 *res_father = father; /* first the common father of src and dst */
448 *res_src = current_src; /* second the first different father of src */
449 *res_dst = current_dst; /* three the first different father of dst */
451 #undef ELEMENTS_FATHER_MAXDEPTH
454 /* Global Business methods */
457 * \brief Recursive function for get_route_latency
459 * \param src the source host name
460 * \param dst the destination host name
461 * \param *e_route the route where the links are stored
462 * \param *latency the latency, if needed
464 * This function is called by "get_route" and "get_latency". It allows to walk
465 * recursively through the routing components tree.
467 static void _get_route_and_latency(const char *src, const char *dst,
468 xbt_dynar_t * route, double *latency)
470 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
471 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
476 elements_father(src, dst, &common_father, &src_father, &dst_father);
478 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
480 route_t e_route = NULL;
482 e_route = common_father->get_route(common_father, src, dst);
483 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
484 *route = e_route->link_list;
487 *latency = common_father->get_latency(common_father, src, dst, e_route);
488 xbt_assert(*latency >= 0.0,
489 "latency error on route between \"%s\" and \"%s\"", src, dst);
492 xbt_free(e_route->src_gateway);
493 xbt_free(e_route->dst_gateway);
497 } else { /* SURF_ROUTING_RECURSIVE */
499 route_t e_route_bypass = NULL;
500 if (common_father->get_bypass_route)
501 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
503 xbt_assert(!latency || !e_route_bypass,
504 "Bypass cannot work yet with get_latency");
506 route_t e_route_cnt = e_route_bypass
507 ? e_route_bypass : common_father->get_route(common_father,
511 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
512 src_father->name, dst_father->name);
514 xbt_assert((e_route_cnt->src_gateway == NULL) ==
515 (e_route_cnt->dst_gateway == NULL),
516 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
519 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
522 *latency = common_father->get_latency(common_father,
523 src_father->name, dst_father->name,
525 xbt_assert(*latency >= 0.0,
526 "latency error on route between \"%s\" and \"%s\"",
527 src_father->name, dst_father->name);
533 if (strcmp(src, e_route_cnt->src_gateway)) {
535 xbt_dynar_t route_src;
537 _get_route_and_latency(src, e_route_cnt->src_gateway,
538 (route ? &route_src : NULL),
539 (latency ? &latency_src : NULL));
541 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
542 src, e_route_cnt->src_gateway);
543 xbt_dynar_foreach(route_src, cpt, link) {
544 xbt_dynar_push(*route, &link);
546 xbt_dynar_free(&route_src);
549 xbt_assert(latency_src >= 0.0,
550 "latency error on route between \"%s\" and \"%s\"",
551 src, e_route_cnt->src_gateway);
552 *latency += latency_src;
557 xbt_dynar_foreach(e_route_cnt->link_list, cpt, link) {
558 xbt_dynar_push(*route, &link);
562 if (strcmp(e_route_cnt->dst_gateway, dst)) {
564 xbt_dynar_t route_dst;
566 _get_route_and_latency(e_route_cnt->dst_gateway, dst,
567 (route ? &route_dst : NULL),
568 (latency ? &latency_dst : NULL));
570 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
571 e_route_cnt->dst_gateway, dst);
572 xbt_dynar_foreach(route_dst, cpt, link) {
573 xbt_dynar_push(*route, &link);
575 xbt_dynar_free(&route_dst);
578 xbt_assert(latency_dst >= 0.0,
579 "latency error on route between \"%s\" and \"%s\"",
580 e_route_cnt->dst_gateway, dst);
581 *latency += latency_dst;
585 generic_free_route(e_route_cnt);
590 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
592 void routing_get_route_and_latency(const char *src, const char *dst,
593 xbt_dynar_t * route, double *latency, int cleanup)
595 static xbt_dynar_t last_route = NULL;
597 _get_route_and_latency(src, dst, route, latency);
598 xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
599 xbt_assert(!latency || *latency >= 0.0,
600 "latency error on route between \"%s\" and \"%s\"", src, dst);
602 xbt_dynar_free(&last_route);
603 last_route = cleanup ? *route : NULL;
608 * \brief Find a route between hosts
610 * \param src the source host name
611 * \param dst the destination host name
613 * walk through the routing components tree and find a route between hosts
614 * by calling the differents "get_route" functions in each routing component.
615 * No need to free the returned dynar. It will be freed at the next call.
617 xbt_dynar_t routing_get_route(const char *src, const char *dst) {
618 xbt_dynar_t route = NULL;
619 routing_get_route_and_latency(src, dst, &route, NULL, 1);
624 * \brief Generic method: find a route between hosts
626 * \param src the source host name
627 * \param dst the destination host name
629 * walk through the routing components tree and find a route between hosts
630 * by calling the differents "get_route" functions in each routing component.
631 * Leaves the caller the responsability to clean the returned dynar.
633 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
635 xbt_dynar_t route = NULL;
636 routing_get_route_and_latency(src, dst, &route, NULL, 0);
640 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
642 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
644 //adding my one link routes
647 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
649 xbt_dynar_foreach(onelink_mine, cpt, link) {
650 xbt_dynar_push(ret, &link);
655 xbt_dict_cursor_t cursor = NULL;
657 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
658 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
660 xbt_dynar_foreach(onelink_child, cpt, link) {
661 xbt_dynar_push(ret, &link);
668 static xbt_dynar_t get_onelink_routes(void)
670 return recursive_get_onelink_routes(global_routing->root);
673 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
675 network_element_info_t rc = NULL;
677 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
681 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
685 return SURF_NETWORK_ELEMENT_NULL;
689 * \brief Generic method: create the global routing schema
691 * Make a global routing structure and set all the parsing functions.
693 void routing_model_create(size_t size_of_links, void *loopback)
695 /* config the uniq global routing */
696 global_routing = xbt_new0(s_routing_global_t, 1);
697 global_routing->root = NULL;
698 global_routing->get_route_no_cleanup = get_route_no_cleanup;
699 global_routing->get_onelink_routes = get_onelink_routes;
700 global_routing->loopback = loopback;
701 global_routing->size_of_link = size_of_links;
702 /* no current routing at moment */
703 current_routing = NULL;
707 /* ************************************************** */
708 /* ********** PATERN FOR NEW ROUTING **************** */
710 /* The minimal configuration of a new routing model need the next functions,
711 * also you need to set at the start of the file, the new model in the model
712 * list. Remember keep the null ending of the list.
714 /*** Routing model structure ***/
716 // s_routing_component_t generic_routing;
717 // /* things that your routing model need */
718 // } s_routing_component_NEW_t,*routing_component_NEW_t;
720 /*** Parse routing model functions ***/
721 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
722 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
723 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
724 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
725 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
727 /*** Business methods ***/
728 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
729 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
730 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
732 /*** Creation routing model functions ***/
733 // static void* model_NEW_create(void) {
734 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
735 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
736 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
737 // new_component->generic_routing.set_route = model_NEW_set_route;
738 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
739 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
740 // new_component->generic_routing.get_route = NEW_get_route;
741 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
742 // new_component->generic_routing.finalize = NEW_finalize;
743 // /* initialization of internal structures */
744 // return new_component;
746 // static void model_NEW_load(void) {} /* mandatory */
747 // static void model_NEW_unload(void) {} /* mandatory */
748 // static void model_NEW_end(void) {} /* mandatory */
750 /* ************************************************************************** */
751 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
754 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
756 char *host_id, *groups, *link_id = NULL;
757 xbt_dict_t patterns = NULL;
759 s_sg_platf_host_cbarg_t host;
760 s_sg_platf_link_cbarg_t link;
764 xbt_dynar_t radical_elements;
765 xbt_dynar_t radical_ends;
767 if (strcmp(cluster->availability_trace, "")
768 || strcmp(cluster->state_trace, "")) {
769 patterns = xbt_dict_new();
770 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), free);
771 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), free);
772 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), free);
776 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
777 sg_platf_new_AS_begin(cluster->id, "Cluster");
780 radical_elements = xbt_str_split(cluster->radical, ",");
781 xbt_dynar_foreach(radical_elements, iter, groups) {
783 radical_ends = xbt_str_split(groups, "-");
784 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
786 switch (xbt_dynar_length(radical_ends)) {
791 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
794 surf_parse_error("Malformed radical");
797 for (i = start; i <= end; i++) {
799 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
800 link_id = bprintf("%s_link_%d", cluster->id, i);
802 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
804 memset(&host, 0, sizeof(host));
806 if (strcmp(cluster->availability_trace, "")) {
807 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
808 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
809 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
810 host.power_trace = tmgr_trace_new(avail_file);
811 xbt_free(avail_file);
813 XBT_DEBUG("\tavailability_file=\"\"");
816 if (strcmp(cluster->state_trace, "")) {
817 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
818 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
819 host.state_trace = tmgr_trace_new(avail_file);
820 xbt_free(avail_file);
822 XBT_DEBUG("\tstate_file=\"\"");
825 host.power_peak = cluster->power;
826 host.power_scale = 1.0;
827 host.core_amount = cluster->core_amount;
828 host.initial_state = SURF_RESOURCE_ON;
830 sg_platf_new_host(&host);
831 XBT_DEBUG("</host>");
833 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
834 cluster->bw, cluster->lat);
836 memset(&link, 0, sizeof(link));
838 link.bandwidth = cluster->bw;
839 link.latency = cluster->lat;
840 link.state = SURF_RESOURCE_ON;
841 link.policy = cluster->sharing_policy;
842 sg_platf_new_link(&link);
844 surf_parsing_link_up_down_t info =
845 xbt_new0(s_surf_parsing_link_up_down_t, 1);
846 if (link.policy == SURF_LINK_FULLDUPLEX) {
847 char *tmp_link = bprintf("%s_UP", link_id);
849 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
851 tmp_link = bprintf("%s_DOWN", link_id);
853 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
856 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
857 info->link_down = info->link_up;
859 surf_routing_cluster_add_link(host_id, info);
865 xbt_dynar_free(&radical_ends);
867 xbt_dynar_free(&radical_elements);
869 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
870 // and it's very useful to connect clusters together
872 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
874 s_sg_platf_router_cbarg_t router;
875 memset(&router, 0, sizeof(router));
876 router.id = cluster->router_id;
878 if (!router.id || !strcmp(router.id, ""))
880 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
882 sg_platf_new_router(&router);
886 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
887 char *link_backbone = bprintf("%s_backbone", cluster->id);
888 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
889 cluster->bb_bw, cluster->bb_lat);
891 memset(&link, 0, sizeof(link));
892 link.id = link_backbone;
893 link.bandwidth = cluster->bb_bw;
894 link.latency = cluster->bb_lat;
895 link.state = SURF_RESOURCE_ON;
896 link.policy = cluster->bb_sharing_policy;
898 sg_platf_new_link(&link);
900 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
906 sg_platf_new_AS_end();
908 xbt_dict_free(&patterns); // no op if it were never set
911 static void routing_parse_postparse(void) {
912 xbt_dict_free(&random_value);
915 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
917 static int AX_ptr = 0;
918 char *host_id = NULL;
919 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
921 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
922 static unsigned int surfxml_buffer_stack_stack[1024];
924 surfxml_buffer_stack_stack[0] = 0;
926 surfxml_bufferstack_push(1);
928 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
929 sg_platf_new_AS_begin(peer->id, "Full");
932 host_id = HOST_PEER(peer->id);
933 router_id = ROUTER_PEER(peer->id);
934 link_id_up = LINK_UP_PEER(peer->id);
935 link_id_down = LINK_DOWN_PEER(peer->id);
937 link_router = bprintf("%s_link_router", peer->id);
938 link_backbone = bprintf("%s_backbone", peer->id);
940 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
941 s_sg_platf_host_cbarg_t host;
942 memset(&host, 0, sizeof(host));
943 host.initial_state = SURF_RESOURCE_ON;
945 host.power_peak = peer->power;
946 host.power_scale = 1.0;
947 host.power_trace = peer->availability_trace;
948 host.state_trace = peer->state_trace;
949 host.core_amount = 1;
950 sg_platf_new_host(&host);
953 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
954 s_sg_platf_router_cbarg_t router;
955 memset(&router, 0, sizeof(router));
956 router.id = router_id;
957 router.coord = peer->coord;
958 sg_platf_new_router(&router);
960 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
961 peer->bw_in, peer->lat);
962 s_sg_platf_link_cbarg_t link;
963 memset(&link, 0, sizeof(link));
964 link.state = SURF_RESOURCE_ON;
965 link.policy = SURF_LINK_SHARED;
966 link.id = link_id_up;
967 link.bandwidth = peer->bw_in;
968 link.latency = peer->lat;
969 sg_platf_new_link(&link);
971 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
972 // Instead, it should be created fullduplex, and the models will do what's needed in this case
973 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
974 peer->bw_out, peer->lat);
975 link.id = link_id_down;
976 sg_platf_new_link(&link);
981 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
982 XBT_DEBUG("symmetrical=\"NO\">");
983 SURFXML_BUFFER_SET(route_src, host_id);
984 SURFXML_BUFFER_SET(route_dst, router_id);
985 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
986 SURFXML_START_TAG(route);
988 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
989 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
990 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
991 SURFXML_START_TAG(link_ctn);
992 SURFXML_END_TAG(link_ctn);
994 XBT_DEBUG("</route>");
995 SURFXML_END_TAG(route);
998 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
999 XBT_DEBUG("symmetrical=\"NO\">");
1000 SURFXML_BUFFER_SET(route_src, router_id);
1001 SURFXML_BUFFER_SET(route_dst, host_id);
1002 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1003 SURFXML_START_TAG(route);
1005 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1006 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1007 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1008 SURFXML_START_TAG(link_ctn);
1009 SURFXML_END_TAG(link_ctn);
1011 XBT_DEBUG("</route>");
1012 SURFXML_END_TAG(route);
1015 sg_platf_new_AS_end();
1018 //xbt_dynar_free(&tab_elements_num);
1022 free(link_backbone);
1025 surfxml_bufferstack_pop(1);
1028 static void routing_parse_Srandom(void)
1030 double mean, std, min, max, seed;
1031 char *random_id = A_surfxml_random_id;
1032 char *random_radical = A_surfxml_random_radical;
1033 char *rd_name = NULL;
1035 mean = surf_parse_get_double(A_surfxml_random_mean);
1036 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1037 min = surf_parse_get_double(A_surfxml_random_min);
1038 max = surf_parse_get_double(A_surfxml_random_max);
1039 seed = surf_parse_get_double(A_surfxml_random_seed);
1043 random_data_t random = xbt_new0(s_random_data_t, 1);
1046 xbt_dynar_t radical_elements;
1050 xbt_dynar_t radical_ends;
1052 random->generator = A_surfxml_random_generator;
1053 random->seed = seed;
1057 /* Check user stupidities */
1059 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1061 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1063 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1065 /* normalize the mean and standard deviation before storing */
1066 random->mean = (mean - min) / (max - min);
1067 random->std = std / (max - min);
1069 if (random->mean * (1 - random->mean) < random->std * random->std)
1070 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1071 random->mean, random->std);
1074 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1075 random_id, random->min, random->max, random->mean, random->std,
1076 random->generator, random->seed, random_radical);
1079 random_value = xbt_dict_new();
1081 if (!strcmp(random_radical, "")) {
1082 res = random_generate(random);
1083 rd_value = bprintf("%f", res);
1084 xbt_dict_set(random_value, random_id, rd_value, free);
1086 radical_elements = xbt_str_split(random_radical, ",");
1087 xbt_dynar_foreach(radical_elements, iter, groups) {
1088 radical_ends = xbt_str_split(groups, "-");
1089 switch (xbt_dynar_length(radical_ends)) {
1091 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1092 "Custom Random '%s' already exists !", random_id);
1093 res = random_generate(random);
1095 bprintf("%s%d", random_id,
1096 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1097 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1102 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1103 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1104 for (i = start; i <= end; i++) {
1105 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1106 "Custom Random '%s' already exists !", bprintf("%s%d",
1109 res = random_generate(random);
1110 tmpbuf = bprintf("%s%d", random_id, i);
1111 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1116 XBT_INFO("Malformed radical");
1119 res = random_generate(random);
1120 rd_name = bprintf("%s_router", random_id);
1121 rd_value = bprintf("%f", res);
1122 xbt_dict_set(random_value, rd_name, rd_value, free);
1124 xbt_dynar_free(&radical_ends);
1127 xbt_dynar_free(&radical_elements);
1131 void routing_register_callbacks()
1133 sg_platf_host_add_cb(parse_S_host);
1134 sg_platf_router_add_cb(parse_S_router);
1136 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1138 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1139 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1140 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1141 &routing_parse_S_bypassRoute);
1143 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1145 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1146 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1147 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1148 &routing_parse_E_bypassRoute);
1150 sg_platf_cluster_add_cb(routing_parse_cluster);
1152 sg_platf_peer_add_cb(routing_parse_peer);
1153 sg_platf_postparse_add_cb(routing_parse_postparse);
1156 instr_routing_define_callbacks();
1161 * \brief Recursive function for finalize
1163 * \param rc the source host name
1165 * This fuction is call by "finalize". It allow to finalize the
1166 * AS or routing components. It delete all the structures.
1168 static void finalize_rec(AS_t as) {
1169 xbt_dict_cursor_t cursor = NULL;
1173 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1180 /** \brief Frees all memory allocated by the routing module */
1181 void routing_exit(void) {
1182 if (!global_routing)
1184 finalize_rec(global_routing->root);
1185 xbt_free(global_routing);