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_routing = (AS_t) (*(model->create)) ();
315 new_routing->routing = model;
316 new_routing->hierarchy = SURF_ROUTING_NULL;
317 new_routing->name = xbt_strdup(AS_id);
318 new_routing->routing_sons = xbt_dict_new();
320 if (current_routing == NULL && global_routing->root == NULL) {
322 /* it is the first one */
323 new_routing->routing_father = NULL;
324 global_routing->root = new_routing;
326 } else if (current_routing != NULL && global_routing->root != NULL) {
328 xbt_assert(!xbt_dict_get_or_null
329 (current_routing->routing_sons, AS_id),
330 "The AS \"%s\" already exists", AS_id);
331 /* it is a part of the tree */
332 new_routing->routing_father = current_routing;
333 /* set the father behavior */
334 if (current_routing->hierarchy == SURF_ROUTING_NULL)
335 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
336 /* add to the sons dictionary */
337 xbt_dict_set(current_routing->routing_sons, AS_id,
338 (void *) new_routing, NULL);
339 /* add to the father element list */
340 (*(current_routing->parse_AS)) (current_routing, AS_id);
342 THROWF(arg_error, 0, "All defined components must be belong to a AS");
344 /* set the new current component of the tree */
345 current_routing = new_routing;
349 * \brief Specify that the current description of AS is finished
351 * Once you've declared all the content of your AS, you have to close
352 * it with this call. Your AS is not usable until you call this function.
354 * @fixme: this call is not as robust as wanted: bad things WILL happen
355 * if you call it twice for the same AS, or if you forget calling it, or
356 * even if you add stuff to a closed AS
359 void routing_AS_end()
362 if (current_routing == NULL) {
363 THROWF(arg_error, 0, "Close an AS, but none was under construction");
365 network_element_info_t info = NULL;
366 xbt_assert(!xbt_lib_get_or_null
367 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
368 "The AS \"%s\" already exists", current_routing->name);
369 info = xbt_new0(s_network_element_info_t, 1);
370 info->rc_component = current_routing->routing_father;
371 info->rc_type = SURF_NETWORK_ELEMENT_AS;
372 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
375 if (current_routing->routing->end)
376 (*(current_routing->routing->end)) (current_routing);
377 current_routing = current_routing->routing_father;
381 /* Aux Business methods */
384 * \brief Get the AS father and the first elements of the chain
386 * \param src the source host name
387 * \param dst the destination host name
389 * Get the common father of the to processing units, and the first different
390 * father in the chain
392 static void elements_father(const char *src, const char *dst,
397 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
398 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
400 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
401 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
409 /* (1) find the as where the src and dst are located */
410 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
412 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
415 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
417 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
418 src_as = src_data->rc_component;
419 dst_as = dst_data->rc_component;
421 xbt_assert(src_as && dst_as,
422 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
424 /* (2) find the path to the root routing component */
425 for (current = src_as; current != NULL; current = current->routing_father) {
426 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
427 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
428 path_src[index_src++] = current;
430 for (current = dst_as; current != NULL; current = current->routing_father) {
431 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
432 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
433 path_dst[index_dst++] = current;
436 /* (3) find the common father */
438 current_src = path_src[--index_src];
439 current_dst = path_dst[--index_dst];
440 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
442 /* (4) they are not in the same routing component, make the path */
443 if (current_src == current_dst)
444 father = current_src;
446 father = path_src[index_src + 1];
448 /* (5) result generation */
449 *res_father = father; /* first the common father of src and dst */
450 *res_src = current_src; /* second the first different father of src */
451 *res_dst = current_dst; /* three the first different father of dst */
453 #undef ELEMENTS_FATHER_MAXDEPTH
456 /* Global Business methods */
459 * \brief Recursive function for get_route_latency
461 * \param src the source host name
462 * \param dst the destination host name
463 * \param *e_route the route where the links are stored
464 * \param *latency the latency, if needed
466 * This function is called by "get_route" and "get_latency". It allows to walk
467 * recursively through the routing components tree.
469 static void _get_route_latency(const char *src, const char *dst,
470 xbt_dynar_t * route, double *latency)
472 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
473 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
478 elements_father(src, dst, &common_father, &src_father, &dst_father);
480 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
482 route_extended_t e_route = NULL;
484 e_route = common_father->get_route(common_father, src, dst);
485 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
486 *route = e_route->generic_route.link_list;
489 *latency = common_father->get_latency(common_father, src, dst, e_route);
490 xbt_assert(*latency >= 0.0,
491 "latency error on route between \"%s\" and \"%s\"", src, dst);
494 xbt_free(e_route->src_gateway);
495 xbt_free(e_route->dst_gateway);
499 } else { /* SURF_ROUTING_RECURSIVE */
501 route_extended_t e_route_bypass = NULL;
502 if (common_father->get_bypass_route)
503 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
505 xbt_assert(!latency || !e_route_bypass,
506 "Bypass cannot work yet with get_latency");
508 route_extended_t e_route_cnt = e_route_bypass
509 ? e_route_bypass : common_father->get_route(common_father,
513 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
514 src_father->name, dst_father->name);
516 xbt_assert((e_route_cnt->src_gateway == NULL) ==
517 (e_route_cnt->dst_gateway == NULL),
518 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
521 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
524 *latency = common_father->get_latency(common_father,
525 src_father->name, dst_father->name,
527 xbt_assert(*latency >= 0.0,
528 "latency error on route between \"%s\" and \"%s\"",
529 src_father->name, dst_father->name);
535 if (strcmp(src, e_route_cnt->src_gateway)) {
537 xbt_dynar_t route_src;
539 _get_route_latency(src, e_route_cnt->src_gateway,
540 (route ? &route_src : NULL),
541 (latency ? &latency_src : NULL));
543 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
544 src, e_route_cnt->src_gateway);
545 xbt_dynar_foreach(route_src, cpt, link) {
546 xbt_dynar_push(*route, &link);
548 xbt_dynar_free(&route_src);
551 xbt_assert(latency_src >= 0.0,
552 "latency error on route between \"%s\" and \"%s\"",
553 src, e_route_cnt->src_gateway);
554 *latency += latency_src;
559 xbt_dynar_foreach(e_route_cnt->generic_route.link_list, cpt, link) {
560 xbt_dynar_push(*route, &link);
564 if (strcmp(e_route_cnt->dst_gateway, dst)) {
566 xbt_dynar_t route_dst;
568 _get_route_latency(e_route_cnt->dst_gateway, dst,
569 (route ? &route_dst : NULL),
570 (latency ? &latency_dst : NULL));
572 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
573 e_route_cnt->dst_gateway, dst);
574 xbt_dynar_foreach(route_dst, cpt, link) {
575 xbt_dynar_push(*route, &link);
577 xbt_dynar_free(&route_dst);
580 xbt_assert(latency_dst >= 0.0,
581 "latency error on route between \"%s\" and \"%s\"",
582 e_route_cnt->dst_gateway, dst);
583 *latency += latency_dst;
587 generic_free_extended_route(e_route_cnt);
592 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
594 static void get_route_latency(const char *src, const char *dst,
595 xbt_dynar_t * route, double *latency, int cleanup)
597 _get_route_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(&global_routing->last_route);
603 global_routing->last_route = cleanup ? *route : NULL;
608 * \brief Generic method: 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 static xbt_dynar_t 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 * same as get_route, but return NULL if any exception is raised.
632 static xbt_dynar_t get_route_or_null(const char *src, const char *dst)
634 xbt_dynar_t route = NULL;
637 get_route_latency(src, dst, &route, NULL, 1);
639 xbt_ex_free(exception);
646 * \brief Generic method: find a route between hosts
648 * \param src the source host name
649 * \param dst the destination host name
651 * walk through the routing components tree and find a route between hosts
652 * by calling the differents "get_route" functions in each routing component.
653 * Leaves the caller the responsability to clean the returned dynar.
655 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
657 xbt_dynar_t route = NULL;
658 get_route_latency(src, dst, &route, NULL, 0);
662 static double get_latency(const char *src, const char *dst) {
663 double latency = -1.0;
664 get_route_latency(src, dst, NULL, &latency, 0);
669 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
671 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
673 //adding my one link routes
676 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
678 xbt_dynar_foreach(onelink_mine, cpt, link) {
679 xbt_dynar_push(ret, &link);
684 xbt_dict_cursor_t cursor = NULL;
686 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
687 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
689 xbt_dynar_foreach(onelink_child, cpt, link) {
690 xbt_dynar_push(ret, &link);
697 static xbt_dynar_t get_onelink_routes(void)
699 return recursive_get_onelink_routes(global_routing->root);
702 e_surf_network_element_type_t get_network_element_type(const char *name)
704 network_element_info_t rc = NULL;
706 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
710 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
714 return SURF_NETWORK_ELEMENT_NULL;
718 * \brief Generic method: create the global routing schema
720 * Make a global routing structure and set all the parsing functions.
722 void routing_model_create(size_t size_of_links, void *loopback)
724 /* config the uniq global routing */
725 global_routing = xbt_new0(s_routing_global_t, 1);
726 global_routing->root = NULL;
727 global_routing->get_route = get_route;
728 global_routing->get_route_or_null = get_route_or_null;
729 global_routing->get_latency = get_latency;
730 global_routing->get_route_no_cleanup = get_route_no_cleanup;
731 global_routing->get_onelink_routes = get_onelink_routes;
732 global_routing->get_route_latency = get_route_latency;
733 global_routing->get_network_element_type = get_network_element_type;
734 global_routing->loopback = loopback;
735 global_routing->size_of_link = size_of_links;
736 global_routing->last_route = NULL;
737 /* no current routing at moment */
738 current_routing = NULL;
742 /* ************************************************** */
743 /* ********** PATERN FOR NEW ROUTING **************** */
745 /* The minimal configuration of a new routing model need the next functions,
746 * also you need to set at the start of the file, the new model in the model
747 * list. Remember keep the null ending of the list.
749 /*** Routing model structure ***/
751 // s_routing_component_t generic_routing;
752 // /* things that your routing model need */
753 // } s_routing_component_NEW_t,*routing_component_NEW_t;
755 /*** Parse routing model functions ***/
756 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
757 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
758 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
759 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
760 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
762 /*** Business methods ***/
763 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
764 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
765 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
767 /*** Creation routing model functions ***/
768 // static void* model_NEW_create(void) {
769 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
770 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
771 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
772 // new_component->generic_routing.set_route = model_NEW_set_route;
773 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
774 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
775 // new_component->generic_routing.get_route = NEW_get_route;
776 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
777 // new_component->generic_routing.finalize = NEW_finalize;
778 // /* initialization of internal structures */
779 // return new_component;
781 // static void model_NEW_load(void) {} /* mandatory */
782 // static void model_NEW_unload(void) {} /* mandatory */
783 // static void model_NEW_end(void) {} /* mandatory */
785 /* ************************************************************************** */
786 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
789 static void routing_parse_cluster(void)
791 char *host_id, *groups, *link_id = NULL;
792 xbt_dict_t patterns = NULL;
794 s_sg_platf_host_cbarg_t host;
795 s_sg_platf_link_cbarg_t link;
797 if (strcmp(struct_cluster->availability_trace, "")
798 || strcmp(struct_cluster->state_trace, "")) {
799 patterns = xbt_dict_new();
800 xbt_dict_set(patterns, "id", xbt_strdup(struct_cluster->id), free);
801 xbt_dict_set(patterns, "prefix", xbt_strdup(struct_cluster->prefix), free);
802 xbt_dict_set(patterns, "suffix", xbt_strdup(struct_cluster->suffix), free);
807 xbt_dynar_t radical_elements;
808 xbt_dynar_t radical_ends;
810 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", struct_cluster->id);
811 sg_platf_new_AS_begin(struct_cluster->id, "Cluster");
814 radical_elements = xbt_str_split(struct_cluster->radical, ",");
815 xbt_dynar_foreach(radical_elements, iter, groups) {
816 memset(&host, 0, sizeof(host));
818 radical_ends = xbt_str_split(groups, "-");
819 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
821 switch (xbt_dynar_length(radical_ends)) {
826 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
829 surf_parse_error("Malformed radical");
832 for (i = start; i <= end; i++) {
834 bprintf("%s%d%s", struct_cluster->prefix, i, struct_cluster->suffix);
835 link_id = bprintf("%s_link_%d", struct_cluster->id, i);
837 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id,
838 struct_cluster->power);
840 if (strcmp(struct_cluster->availability_trace, "")) {
841 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
842 char *tmp_availability_file =
843 xbt_str_varsubst(struct_cluster->availability_trace, patterns);
844 XBT_DEBUG("\tavailability_file=\"%s\"", tmp_availability_file);
845 host.power_trace = tmgr_trace_new(tmp_availability_file);
846 xbt_free(tmp_availability_file);
848 XBT_DEBUG("\tavailability_file=\"\"");
850 if (strcmp(struct_cluster->state_trace, "")) {
851 char *tmp_state_file =
852 xbt_str_varsubst(struct_cluster->state_trace, patterns);
853 XBT_DEBUG("\tstate_file=\"%s\"", tmp_state_file);
854 host.state_trace = tmgr_trace_new(tmp_state_file);
855 xbt_free(tmp_state_file);
857 XBT_DEBUG("\tstate_file=\"\"");
860 host.power_peak = struct_cluster->power;
861 host.power_scale = 1.0;
862 host.core_amount = struct_cluster->core_amount;
863 host.initial_state = SURF_RESOURCE_ON;
865 sg_platf_new_host(&host);
866 XBT_DEBUG("</host>");
868 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
869 struct_cluster->bw, struct_cluster->lat);
871 memset(&link, 0, sizeof(link));
873 link.bandwidth = struct_cluster->bw;
874 link.latency = struct_cluster->lat;
875 link.state = SURF_RESOURCE_ON;
877 switch (struct_cluster->sharing_policy) {
878 case A_surfxml_cluster_sharing_policy_SHARED:
879 link.policy = SURF_LINK_SHARED;
881 case A_surfxml_cluster_sharing_policy_FULLDUPLEX:
882 link.policy = SURF_LINK_FULLDUPLEX;
884 case A_surfxml_cluster_sharing_policy_FATPIPE:
885 link.policy = SURF_LINK_FATPIPE;
888 surf_parse_error(bprintf
889 ("Invalid cluster sharing policy for cluster %s",
890 struct_cluster->id));
893 sg_platf_new_link(&link);
895 surf_parsing_link_up_down_t info =
896 xbt_new0(s_surf_parsing_link_up_down_t, 1);
897 if (link.policy == SURF_LINK_FULLDUPLEX) {
898 char *tmp_link = bprintf("%s_UP", link_id);
900 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
902 tmp_link = bprintf("%s_DOWN", link_id);
904 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
907 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
908 info->link_down = info->link_up;
910 surf_routing_cluster_add_link(host_id, info);
916 xbt_dynar_free(&radical_ends);
918 xbt_dynar_free(&radical_elements);
920 // 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
922 XBT_DEBUG("<router id=\"%s\"/>", struct_cluster->router_id);
923 s_sg_platf_router_cbarg_t router;
925 memset(&router, 0, sizeof(router));
926 router.id = struct_cluster->router_id;
928 if (!router.id || !strcmp(router.id, ""))
930 bprintf("%s%s_router%s", struct_cluster->prefix, struct_cluster->id,
931 struct_cluster->suffix);
932 sg_platf_new_router(&router);
936 if ((struct_cluster->bb_bw != 0) && (struct_cluster->bb_lat != 0)) {
937 char *link_backbone = bprintf("%s_backbone", struct_cluster->id);
938 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
939 struct_cluster->bb_bw, struct_cluster->bb_lat);
941 memset(&link, 0, sizeof(link));
942 link.id = link_backbone;
943 link.bandwidth = struct_cluster->bb_bw;
944 link.latency = struct_cluster->bb_lat;
945 link.state = SURF_RESOURCE_ON;
947 switch (struct_cluster->bb_sharing_policy) {
948 case A_surfxml_cluster_bb_sharing_policy_FATPIPE:
949 link.policy = SURF_LINK_FATPIPE;
951 case A_surfxml_cluster_bb_sharing_policy_SHARED:
952 link.policy = SURF_LINK_SHARED;
955 surf_parse_error(bprintf
956 ("Invalid bb sharing policy in cluster %s",
957 struct_cluster->id));
961 sg_platf_new_link(&link);
963 surf_parsing_link_up_down_t info =
964 xbt_new0(s_surf_parsing_link_up_down_t, 1);
966 xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL);
967 info->link_down = info->link_up;
968 surf_routing_cluster_add_link(struct_cluster->id, info);
975 char *new_suffix = xbt_strdup("");
977 radical_elements = xbt_str_split(struct_cluster->suffix, ".");
978 xbt_dynar_foreach(radical_elements, iter, groups) {
979 if (strcmp(groups, "")) {
980 char *old_suffix = new_suffix;
981 new_suffix = bprintf("%s\\.%s", old_suffix, groups);
986 xbt_dynar_free(&radical_elements);
987 xbt_free(new_suffix);
990 sg_platf_new_AS_end();
992 xbt_dict_free(&patterns); // no op if it were never set
995 static void routing_parse_postparse(void) {
996 xbt_dict_free(&random_value);
999 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1001 static int AX_ptr = 0;
1002 char *host_id = NULL;
1003 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
1005 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
1006 static unsigned int surfxml_buffer_stack_stack[1024];
1008 surfxml_buffer_stack_stack[0] = 0;
1010 surfxml_bufferstack_push(1);
1012 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
1013 sg_platf_new_AS_begin(peer->id, "Full");
1016 host_id = HOST_PEER(peer->id);
1017 router_id = ROUTER_PEER(peer->id);
1018 link_id_up = LINK_UP_PEER(peer->id);
1019 link_id_down = LINK_DOWN_PEER(peer->id);
1021 link_router = bprintf("%s_link_router", peer->id);
1022 link_backbone = bprintf("%s_backbone", peer->id);
1024 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1025 s_sg_platf_host_cbarg_t host;
1026 memset(&host, 0, sizeof(host));
1027 host.initial_state = SURF_RESOURCE_ON;
1029 host.power_peak = peer->power;
1030 host.power_scale = 1.0;
1031 host.power_trace = peer->availability_trace;
1032 host.state_trace = peer->state_trace;
1033 host.core_amount = 1;
1034 sg_platf_new_host(&host);
1037 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1038 s_sg_platf_router_cbarg_t router;
1039 memset(&router, 0, sizeof(router));
1040 router.id = router_id;
1041 router.coord = peer->coord;
1042 sg_platf_new_router(&router);
1044 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1045 peer->bw_in, peer->lat);
1046 s_sg_platf_link_cbarg_t link;
1047 memset(&link, 0, sizeof(link));
1048 link.state = SURF_RESOURCE_ON;
1049 link.policy = SURF_LINK_SHARED;
1050 link.id = link_id_up;
1051 link.bandwidth = peer->bw_in;
1052 link.latency = peer->lat;
1053 sg_platf_new_link(&link);
1055 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1056 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1057 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1058 peer->bw_out, peer->lat);
1059 link.id = link_id_down;
1060 sg_platf_new_link(&link);
1065 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1066 XBT_DEBUG("symmetrical=\"NO\">");
1067 SURFXML_BUFFER_SET(route_src, host_id);
1068 SURFXML_BUFFER_SET(route_dst, router_id);
1069 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1070 SURFXML_START_TAG(route);
1072 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1073 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1074 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1075 SURFXML_START_TAG(link_ctn);
1076 SURFXML_END_TAG(link_ctn);
1078 XBT_DEBUG("</route>");
1079 SURFXML_END_TAG(route);
1082 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1083 XBT_DEBUG("symmetrical=\"NO\">");
1084 SURFXML_BUFFER_SET(route_src, router_id);
1085 SURFXML_BUFFER_SET(route_dst, host_id);
1086 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1087 SURFXML_START_TAG(route);
1089 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1090 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1091 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1092 SURFXML_START_TAG(link_ctn);
1093 SURFXML_END_TAG(link_ctn);
1095 XBT_DEBUG("</route>");
1096 SURFXML_END_TAG(route);
1099 sg_platf_new_AS_end();
1102 //xbt_dynar_free(&tab_elements_num);
1106 free(link_backbone);
1109 surfxml_bufferstack_pop(1);
1112 static void routing_parse_Srandom(void)
1114 double mean, std, min, max, seed;
1115 char *random_id = A_surfxml_random_id;
1116 char *random_radical = A_surfxml_random_radical;
1117 char *rd_name = NULL;
1119 mean = surf_parse_get_double(A_surfxml_random_mean);
1120 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1121 min = surf_parse_get_double(A_surfxml_random_min);
1122 max = surf_parse_get_double(A_surfxml_random_max);
1123 seed = surf_parse_get_double(A_surfxml_random_seed);
1127 random_data_t random = xbt_new0(s_random_data_t, 1);
1130 xbt_dynar_t radical_elements;
1134 xbt_dynar_t radical_ends;
1136 random->generator = A_surfxml_random_generator;
1137 random->seed = seed;
1141 /* Check user stupidities */
1143 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1145 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1147 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1149 /* normalize the mean and standard deviation before storing */
1150 random->mean = (mean - min) / (max - min);
1151 random->std = std / (max - min);
1153 if (random->mean * (1 - random->mean) < random->std * random->std)
1154 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1155 random->mean, random->std);
1158 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1159 random_id, random->min, random->max, random->mean, random->std,
1160 random->generator, random->seed, random_radical);
1162 if (xbt_dict_size(random_value) == 0)
1163 random_value = xbt_dict_new();
1165 if (!strcmp(random_radical, "")) {
1166 res = random_generate(random);
1167 rd_value = bprintf("%f", res);
1168 xbt_dict_set(random_value, random_id, rd_value, free);
1170 radical_elements = xbt_str_split(random_radical, ",");
1171 xbt_dynar_foreach(radical_elements, iter, groups) {
1172 radical_ends = xbt_str_split(groups, "-");
1173 switch (xbt_dynar_length(radical_ends)) {
1175 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1176 "Custom Random '%s' already exists !", random_id);
1177 res = random_generate(random);
1179 bprintf("%s%d", random_id,
1180 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1181 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1186 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1187 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1188 for (i = start; i <= end; i++) {
1189 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1190 "Custom Random '%s' already exists !", bprintf("%s%d",
1193 res = random_generate(random);
1194 tmpbuf = bprintf("%s%d", random_id, i);
1195 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1200 XBT_INFO("Malformed radical");
1203 res = random_generate(random);
1204 rd_name = bprintf("%s_router", random_id);
1205 rd_value = bprintf("%f", res);
1206 xbt_dict_set(random_value, rd_name, rd_value, free);
1208 xbt_dynar_free(&radical_ends);
1211 xbt_dynar_free(&radical_elements);
1215 void routing_register_callbacks()
1217 sg_platf_host_add_cb(parse_S_host);
1218 sg_platf_router_add_cb(parse_S_router);
1220 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1222 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1223 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1224 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1225 &routing_parse_S_bypassRoute);
1227 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1229 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1230 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1231 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1232 &routing_parse_E_bypassRoute);
1234 surfxml_add_callback(STag_surfxml_cluster_cb_list, &routing_parse_cluster);
1236 sg_platf_peer_add_cb(routing_parse_peer);
1237 sg_platf_postparse_add_cb(routing_parse_postparse);
1240 instr_routing_define_callbacks();
1245 * \brief Recursive function for finalize
1247 * \param rc the source host name
1249 * This fuction is call by "finalize". It allow to finalize the
1250 * AS or routing components. It delete all the structures.
1252 static void finalize_rec(AS_t as) {
1253 xbt_dict_cursor_t cursor = NULL;
1257 xbt_dict_foreach(as->routing_sons, cursor, key, elem)
1260 xbt_dict_free(&as->routing_sons);
1265 /** \brief Frees all memory allocated by the routing module */
1266 void routing_exit(void) {
1267 if (!global_routing)
1269 finalize_rec(global_routing->root);
1270 xbt_dynar_free(&global_routing->last_route);
1271 xbt_free(global_routing);