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 patterns = NULL;
36 static xbt_dict_t random_value = NULL;
39 routing_global_t global_routing = NULL;
40 AS_t current_routing = NULL;
41 routing_model_description_t current_routing_model = NULL;
43 /* global parse functions */
44 xbt_dynar_t link_list = NULL; /* temporary store of current list link of a route */
45 static const char *src = NULL; /* temporary store the source name of a route */
46 static const char *dst = NULL; /* temporary store the destination name of a route */
47 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
48 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
50 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
52 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
53 static void routing_parse_Srandom(void); /* random bypass */
55 static char *replace_random_parameter(char *chaine);
56 static void routing_parse_postparse(void);
58 /* this lines are only for replace use like index in the model table */
63 SURF_MODEL_DIJKSTRACACHE,
70 struct s_model_type routing_models[] = {
72 "Full routing data (fast, large memory requirements, fully expressive)",
73 model_full_create, model_full_end},
75 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
76 model_floyd_create, model_floyd_end},
78 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
79 model_dijkstra_create, model_dijkstra_both_end},
81 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
82 model_dijkstracache_create, model_dijkstra_both_end},
83 {"none", "No routing (usable with Constant network only)",
84 model_none_create, NULL},
85 {"RuleBased", "Rule-Based routing data (...)",
86 model_rulebased_create, NULL},
87 {"Vivaldi", "Vivaldi routing",
88 model_vivaldi_create, NULL},
89 {"Cluster", "Cluster routing",
90 model_cluster_create, NULL},
91 {NULL, NULL, NULL, NULL}
95 * \brief Add a "host" to the network element list
97 static void parse_S_host(sg_platf_host_cbarg_t host)
99 network_element_info_t info = NULL;
100 if (current_routing->hierarchy == SURF_ROUTING_NULL)
101 current_routing->hierarchy = SURF_ROUTING_BASE;
102 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
103 "Reading a host, processing unit \"%s\" already exists", host->id);
105 (*(current_routing->parse_PU)) (current_routing, host->id);
106 info = xbt_new0(s_network_element_info_t, 1);
107 info->rc_component = current_routing;
108 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
109 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
110 if (host->coord && strcmp(host->coord, "")) {
111 if (!COORD_HOST_LEVEL)
113 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
114 xbt_dynar_t ctn = xbt_str_split_str(host->coord, " ");
115 xbt_dynar_shrink(ctn, 0);
116 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
121 * \brief Add a "router" to the network element list
123 static void parse_S_router(sg_platf_router_cbarg_t router)
125 network_element_info_t info = NULL;
126 if (current_routing->hierarchy == SURF_ROUTING_NULL)
127 current_routing->hierarchy = SURF_ROUTING_BASE;
128 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
129 "Reading a router, processing unit \"%s\" already exists",
132 (*(current_routing->parse_PU)) (current_routing, router->id);
133 info = xbt_new0(s_network_element_info_t, 1);
134 info->rc_component = current_routing;
135 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
137 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
138 if (strcmp(router->coord, "")) {
139 if (!COORD_ASR_LEVEL)
141 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
142 xbt_dynar_t ctn = xbt_str_split_str(router->coord, " ");
143 xbt_dynar_shrink(ctn, 0);
144 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
150 * \brief Set the end points for a route
152 static void routing_parse_S_route(void)
154 if (src != NULL && dst != NULL && link_list != NULL)
155 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
156 A_surfxml_route_src, A_surfxml_route_dst);
157 src = A_surfxml_route_src;
158 dst = A_surfxml_route_dst;
159 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
160 "Some limits are null in the route between \"%s\" and \"%s\"",
162 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
166 * \brief Set the end points and gateways for a ASroute
168 static void routing_parse_S_ASroute(void)
170 if (src != NULL && dst != NULL && link_list != NULL)
171 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
172 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
173 src = A_surfxml_ASroute_src;
174 dst = A_surfxml_ASroute_dst;
175 gw_src = A_surfxml_ASroute_gw_src;
176 gw_dst = A_surfxml_ASroute_gw_dst;
177 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
178 || strlen(gw_dst) > 0,
179 "Some limits are null in the route between \"%s\" and \"%s\"",
181 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
185 * \brief Set the end points for a bypassRoute
187 static void routing_parse_S_bypassRoute(void)
189 if (src != NULL && dst != NULL && link_list != NULL)
191 "Bypass Route between %s to %s can not be defined",
192 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
193 src = A_surfxml_bypassRoute_src;
194 dst = A_surfxml_bypassRoute_dst;
195 gw_src = A_surfxml_bypassRoute_gw_src;
196 gw_dst = A_surfxml_bypassRoute_gw_dst;
197 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
198 || strlen(gw_dst) > 0,
199 "Some limits are null in the route between \"%s\" and \"%s\"",
201 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
205 * \brief Set a new link on the actual list of link for a route or ASroute from XML
208 static void routing_parse_link_ctn(void)
211 switch (A_surfxml_link_ctn_direction) {
212 case AU_surfxml_link_ctn_direction:
213 case A_surfxml_link_ctn_direction_NONE:
214 link_id = xbt_strdup(A_surfxml_link_ctn_id);
216 case A_surfxml_link_ctn_direction_UP:
217 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
219 case A_surfxml_link_ctn_direction_DOWN:
220 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
223 xbt_dynar_push(link_list, &link_id);
227 * \brief Store the route by calling the set_route function of the current routing component
229 static void routing_parse_E_route(void)
231 route_extended_t route = xbt_new0(s_route_extended_t, 1);
232 route->generic_route.link_list = link_list;
233 xbt_assert(current_routing->parse_route,
234 "no defined method \"set_route\" in \"%s\"",
235 current_routing->name);
236 (*(current_routing->parse_route)) (current_routing, src, dst, route);
243 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
245 static void routing_parse_E_ASroute(void)
247 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
248 e_route->generic_route.link_list = link_list;
249 e_route->src_gateway = xbt_strdup(gw_src);
250 e_route->dst_gateway = xbt_strdup(gw_dst);
251 xbt_assert(current_routing->parse_ASroute,
252 "no defined method \"set_ASroute\" in \"%s\"",
253 current_routing->name);
254 (*(current_routing->parse_ASroute)) (current_routing, src, dst, e_route);
263 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
265 static void routing_parse_E_bypassRoute(void)
267 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
268 e_route->generic_route.link_list = link_list;
269 e_route->src_gateway = xbt_strdup(gw_src);
270 e_route->dst_gateway = xbt_strdup(gw_dst);
271 xbt_assert(current_routing->parse_bypassroute,
272 "Bypassing mechanism not implemented by routing '%s'",
273 current_routing->name);
274 (*(current_routing->parse_bypassroute)) (current_routing, src, dst, e_route);
283 * \brief Make a new routing component to the platform
285 * Add a new autonomous system to the platform. Any elements (such as host,
286 * router or sub-AS) added after this call and before the corresponding call
287 * to sg_platf_new_AS_close() will be added to this AS.
289 * Once this function was called, the configuration concerning the used
290 * models cannot be changed anymore.
292 * @param AS_id name of this autonomous system. Must be unique in the platform
293 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
295 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
298 routing_model_description_t model = NULL;
301 /* search the routing model */
302 for (cpt = 0; routing_models[cpt].name; cpt++)
303 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
304 model = &routing_models[cpt];
305 /* if its not exist, error */
307 fprintf(stderr, "Routing model %s not found. Existing models:\n",
308 wanted_routing_type);
309 for (cpt = 0; routing_models[cpt].name; cpt++)
310 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
311 routing_models[cpt].desc);
315 /* make a new routing component */
316 new_routing = (AS_t) (*(model->create)) ();
317 new_routing->routing = model;
318 new_routing->hierarchy = SURF_ROUTING_NULL;
319 new_routing->name = xbt_strdup(AS_id);
320 new_routing->routing_sons = xbt_dict_new();
322 if (current_routing == NULL && global_routing->root == NULL) {
324 /* it is the first one */
325 new_routing->routing_father = NULL;
326 global_routing->root = new_routing;
328 } else if (current_routing != NULL && global_routing->root != NULL) {
330 xbt_assert(!xbt_dict_get_or_null
331 (current_routing->routing_sons, AS_id),
332 "The AS \"%s\" already exists", AS_id);
333 /* it is a part of the tree */
334 new_routing->routing_father = current_routing;
335 /* set the father behavior */
336 if (current_routing->hierarchy == SURF_ROUTING_NULL)
337 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
338 /* add to the sons dictionary */
339 xbt_dict_set(current_routing->routing_sons, AS_id,
340 (void *) new_routing, NULL);
341 /* add to the father element list */
342 (*(current_routing->parse_AS)) (current_routing, AS_id);
344 THROWF(arg_error, 0, "All defined components must be belong to a AS");
346 /* set the new current component of the tree */
347 current_routing = new_routing;
351 * \brief Specify that the current description of AS is finished
353 * Once you've declared all the content of your AS, you have to close
354 * it with this call. Your AS is not usable until you call this function.
356 * @fixme: this call is not as robust as wanted: bad things WILL happen
357 * if you call it twice for the same AS, or if you forget calling it, or
358 * even if you add stuff to a closed AS
361 void routing_AS_end()
364 if (current_routing == NULL) {
365 THROWF(arg_error, 0, "Close an AS, but none was under construction");
367 network_element_info_t info = NULL;
368 xbt_assert(!xbt_lib_get_or_null
369 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
370 "The AS \"%s\" already exists", current_routing->name);
371 info = xbt_new0(s_network_element_info_t, 1);
372 info->rc_component = current_routing->routing_father;
373 info->rc_type = SURF_NETWORK_ELEMENT_AS;
374 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
377 if (current_routing->routing->end)
378 (*(current_routing->routing->end)) ();
379 current_routing = current_routing->routing_father;
383 /* Aux Business methods */
386 * \brief Get the AS father and the first elements of the chain
388 * \param src the source host name
389 * \param dst the destination host name
391 * Get the common father of the to processing units, and the first different
392 * father in the chain
394 static void elements_father(const char *src, const char *dst,
399 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
400 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
402 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
403 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
411 /* (1) find the as where the src and dst are located */
412 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
414 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
417 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
419 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
420 src_as = src_data->rc_component;
421 dst_as = dst_data->rc_component;
423 xbt_assert(src_as && dst_as,
424 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
426 /* (2) find the path to the root routing component */
427 for (current = src_as; current != NULL; current = current->routing_father) {
428 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
429 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
430 path_src[index_src++] = current;
432 for (current = dst_as; current != NULL; current = current->routing_father) {
433 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
434 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
435 path_dst[index_dst++] = current;
438 /* (3) find the common father */
440 current_src = path_src[--index_src];
441 current_dst = path_dst[--index_dst];
442 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
444 /* (4) they are not in the same routing component, make the path */
445 if (current_src == current_dst)
446 father = current_src;
448 father = path_src[index_src + 1];
450 /* (5) result generation */
451 *res_father = father; /* first the common father of src and dst */
452 *res_src = current_src; /* second the first different father of src */
453 *res_dst = current_dst; /* three the first different father of dst */
455 #undef ELEMENTS_FATHER_MAXDEPTH
458 /* Global Business methods */
461 * \brief Recursive function for get_route_latency
463 * \param src the source host name
464 * \param dst the destination host name
465 * \param *e_route the route where the links are stored
466 * \param *latency the latency, if needed
468 * This function is called by "get_route" and "get_latency". It allows to walk
469 * recursively through the routing components tree.
471 static void _get_route_latency(const char *src, const char *dst,
472 xbt_dynar_t * route, double *latency)
474 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
475 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
480 elements_father(src, dst, &common_father, &src_father, &dst_father);
482 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
484 route_extended_t e_route = NULL;
486 e_route = common_father->get_route(common_father, src, dst);
487 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
488 *route = e_route->generic_route.link_list;
491 *latency = common_father->get_latency(common_father, src, dst, e_route);
492 xbt_assert(*latency >= 0.0,
493 "latency error on route between \"%s\" and \"%s\"", src, dst);
496 xbt_free(e_route->src_gateway);
497 xbt_free(e_route->dst_gateway);
501 } else { /* SURF_ROUTING_RECURSIVE */
503 route_extended_t e_route_bypass = NULL;
504 if (common_father->get_bypass_route)
505 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
507 xbt_assert(!latency || !e_route_bypass,
508 "Bypass cannot work yet with get_latency");
510 route_extended_t e_route_cnt = e_route_bypass
511 ? e_route_bypass : common_father->get_route(common_father,
515 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
516 src_father->name, dst_father->name);
518 xbt_assert((e_route_cnt->src_gateway == NULL) ==
519 (e_route_cnt->dst_gateway == NULL),
520 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
523 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
526 *latency = common_father->get_latency(common_father,
527 src_father->name, dst_father->name,
529 xbt_assert(*latency >= 0.0,
530 "latency error on route between \"%s\" and \"%s\"",
531 src_father->name, dst_father->name);
537 if (strcmp(src, e_route_cnt->src_gateway)) {
539 xbt_dynar_t route_src;
541 _get_route_latency(src, e_route_cnt->src_gateway,
542 (route ? &route_src : NULL),
543 (latency ? &latency_src : NULL));
545 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
546 src, e_route_cnt->src_gateway);
547 xbt_dynar_foreach(route_src, cpt, link) {
548 xbt_dynar_push(*route, &link);
550 xbt_dynar_free(&route_src);
553 xbt_assert(latency_src >= 0.0,
554 "latency error on route between \"%s\" and \"%s\"",
555 src, e_route_cnt->src_gateway);
556 *latency += latency_src;
561 xbt_dynar_foreach(e_route_cnt->generic_route.link_list, cpt, link) {
562 xbt_dynar_push(*route, &link);
566 if (strcmp(e_route_cnt->dst_gateway, dst)) {
568 xbt_dynar_t route_dst;
570 _get_route_latency(e_route_cnt->dst_gateway, dst,
571 (route ? &route_dst : NULL),
572 (latency ? &latency_dst : NULL));
574 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
575 e_route_cnt->dst_gateway, dst);
576 xbt_dynar_foreach(route_dst, cpt, link) {
577 xbt_dynar_push(*route, &link);
579 xbt_dynar_free(&route_dst);
582 xbt_assert(latency_dst >= 0.0,
583 "latency error on route between \"%s\" and \"%s\"",
584 e_route_cnt->dst_gateway, dst);
585 *latency += latency_dst;
589 generic_free_extended_route(e_route_cnt);
594 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
596 static void get_route_latency(const char *src, const char *dst,
597 xbt_dynar_t * route, double *latency, int cleanup)
599 _get_route_latency(src, dst, route, latency);
600 xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
601 xbt_assert(!latency || *latency >= 0.0,
602 "latency error on route between \"%s\" and \"%s\"", src, dst);
604 xbt_dynar_free(&global_routing->last_route);
605 global_routing->last_route = cleanup ? *route : NULL;
610 * \brief Generic method: find a route between hosts
612 * \param src the source host name
613 * \param dst the destination host name
615 * walk through the routing components tree and find a route between hosts
616 * by calling the differents "get_route" functions in each routing component.
617 * No need to free the returned dynar. It will be freed at the next call.
619 static xbt_dynar_t get_route(const char *src, const char *dst)
621 xbt_dynar_t route = NULL;
622 get_route_latency(src, dst, &route, NULL, 1);
627 * \brief Generic method: find a route between hosts
629 * \param src the source host name
630 * \param dst the destination host name
632 * same as get_route, but return NULL if any exception is raised.
634 static xbt_dynar_t get_route_or_null(const char *src, const char *dst)
636 xbt_dynar_t route = NULL;
639 get_route_latency(src, dst, &route, NULL, 1);
641 xbt_ex_free(exception);
648 * \brief Generic method: find a route between hosts
650 * \param src the source host name
651 * \param dst the destination host name
653 * walk through the routing components tree and find a route between hosts
654 * by calling the differents "get_route" functions in each routing component.
655 * Leaves the caller the responsability to clean the returned dynar.
657 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
659 xbt_dynar_t route = NULL;
660 get_route_latency(src, dst, &route, NULL, 0);
665 static double get_latency(const char *src, const char *dst)
667 double latency = -1.0;
668 get_route_latency(src, dst, NULL, &latency, 0);
673 * \brief Recursive function for finalize
675 * \param rc the source host name
677 * This fuction is call by "finalize". It allow to finalize the
678 * AS or routing components. It delete all the structures.
680 static void finalize_rec(AS_t as)
683 xbt_dict_cursor_t cursor = NULL;
686 xbt_dict_foreach(as->routing_sons, cursor, key, elem)
689 xbt_dict_t tmp_sons = as->routing_sons;
690 char *tmp_name = as->name;
691 xbt_dict_free(&tmp_sons);
698 * \brief Generic method: delete all the routing structures
700 * walk through the routing components tree and delete the structures
701 * by calling the different "finalize" functions in each routing component
703 static void finalize(void)
705 /* delete recursively all the tree */
706 finalize_rec(global_routing->root);
707 /* delete last_route */
708 xbt_dynar_free(&(global_routing->last_route));
709 /* delete global routing structure */
710 xbt_free(global_routing);
713 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
715 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
717 //adding my one link routes
720 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
722 xbt_dynar_foreach(onelink_mine, cpt, link) {
723 xbt_dynar_push(ret, &link);
728 xbt_dict_cursor_t cursor = NULL;
730 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
731 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
733 xbt_dynar_foreach(onelink_child, cpt, link) {
734 xbt_dynar_push(ret, &link);
741 static xbt_dynar_t get_onelink_routes(void)
743 return recursive_get_onelink_routes(global_routing->root);
746 e_surf_network_element_type_t get_network_element_type(const char *name)
748 network_element_info_t rc = NULL;
750 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
754 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
758 return SURF_NETWORK_ELEMENT_NULL;
762 * \brief Generic method: create the global routing schema
764 * Make a global routing structure and set all the parsing functions.
766 void routing_model_create(size_t size_of_links, void *loopback)
768 /* config the uniq global routing */
769 global_routing = xbt_new0(s_routing_global_t, 1);
770 global_routing->root = NULL;
771 global_routing->get_route = get_route;
772 global_routing->get_route_or_null = get_route_or_null;
773 global_routing->get_latency = get_latency;
774 global_routing->get_route_no_cleanup = get_route_no_cleanup;
775 global_routing->get_onelink_routes = get_onelink_routes;
776 global_routing->get_route_latency = get_route_latency;
777 global_routing->get_network_element_type = get_network_element_type;
778 global_routing->finalize = finalize;
779 global_routing->loopback = loopback;
780 global_routing->size_of_link = size_of_links;
781 global_routing->last_route = NULL;
782 /* no current routing at moment */
783 current_routing = NULL;
787 /* ************************************************** */
788 /* ********** PATERN FOR NEW ROUTING **************** */
790 /* The minimal configuration of a new routing model need the next functions,
791 * also you need to set at the start of the file, the new model in the model
792 * list. Remember keep the null ending of the list.
794 /*** Routing model structure ***/
796 // s_routing_component_t generic_routing;
797 // /* things that your routing model need */
798 // } s_routing_component_NEW_t,*routing_component_NEW_t;
800 /*** Parse routing model functions ***/
801 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
802 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
803 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
804 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
805 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
807 /*** Business methods ***/
808 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
809 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
810 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
812 /*** Creation routing model functions ***/
813 // static void* model_NEW_create(void) {
814 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
815 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
816 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
817 // new_component->generic_routing.set_route = model_NEW_set_route;
818 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
819 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
820 // new_component->generic_routing.get_route = NEW_get_route;
821 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
822 // new_component->generic_routing.finalize = NEW_finalize;
823 // /* initialization of internal structures */
824 // return new_component;
826 // static void model_NEW_load(void) {} /* mandatory */
827 // static void model_NEW_unload(void) {} /* mandatory */
828 // static void model_NEW_end(void) {} /* mandatory */
830 /* ************************************************************************** */
831 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
834 static void routing_parse_cluster(void)
836 char *host_id, *groups, *link_id = NULL;
838 s_sg_platf_host_cbarg_t host;
839 s_sg_platf_link_cbarg_t link;
841 if (strcmp(struct_cluster->availability_trace, "")
842 || strcmp(struct_cluster->state_trace, "")) {
843 if (xbt_dict_size(patterns) == 0)
844 patterns = xbt_dict_new();
845 xbt_dict_set(patterns, "id", xbt_strdup(struct_cluster->id), free);
846 xbt_dict_set(patterns, "prefix", xbt_strdup(struct_cluster->prefix), free);
847 xbt_dict_set(patterns, "suffix", xbt_strdup(struct_cluster->suffix), free);
852 xbt_dynar_t radical_elements;
853 xbt_dynar_t radical_ends;
855 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", struct_cluster->id);
856 sg_platf_new_AS_begin(struct_cluster->id, "Cluster");
859 radical_elements = xbt_str_split(struct_cluster->radical, ",");
860 xbt_dynar_foreach(radical_elements, iter, groups) {
861 memset(&host, 0, sizeof(host));
863 radical_ends = xbt_str_split(groups, "-");
864 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
866 switch (xbt_dynar_length(radical_ends)) {
871 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
874 surf_parse_error("Malformed radical");
877 for (i = start; i <= end; i++) {
879 bprintf("%s%d%s", struct_cluster->prefix, i, struct_cluster->suffix);
880 link_id = bprintf("%s_link_%d", struct_cluster->id, i);
882 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id,
883 struct_cluster->power);
885 if (strcmp(struct_cluster->availability_trace, "")) {
886 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
887 char *tmp_availability_file =
888 xbt_strdup(struct_cluster->availability_trace);
889 xbt_str_varsubst(tmp_availability_file, patterns);
890 XBT_DEBUG("\tavailability_file=\"%s\"", tmp_availability_file);
891 host.power_trace = tmgr_trace_new(tmp_availability_file);
892 xbt_free(tmp_availability_file);
894 XBT_DEBUG("\tavailability_file=\"\"");
896 if (strcmp(struct_cluster->state_trace, "")) {
897 char *tmp_state_file = xbt_strdup(struct_cluster->state_trace);
898 xbt_str_varsubst(tmp_state_file, patterns);
899 XBT_DEBUG("\tstate_file=\"%s\"", tmp_state_file);
900 host.state_trace = tmgr_trace_new(tmp_state_file);
901 xbt_free(tmp_state_file);
903 XBT_DEBUG("\tstate_file=\"\"");
906 host.power_peak = struct_cluster->power;
907 host.power_scale = 1.0;
908 host.core_amount = struct_cluster->core_amount;
909 host.initial_state = SURF_RESOURCE_ON;
911 sg_platf_new_host(&host);
912 XBT_DEBUG("</host>");
914 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
915 struct_cluster->bw, struct_cluster->lat);
917 memset(&link, 0, sizeof(link));
919 link.bandwidth = struct_cluster->bw;
920 link.latency = struct_cluster->lat;
921 link.state = SURF_RESOURCE_ON;
923 switch (struct_cluster->sharing_policy) {
924 case A_surfxml_cluster_sharing_policy_SHARED:
925 link.policy = SURF_LINK_SHARED;
927 case A_surfxml_cluster_sharing_policy_FULLDUPLEX:
928 link.policy = SURF_LINK_FULLDUPLEX;
930 case A_surfxml_cluster_sharing_policy_FATPIPE:
931 link.policy = SURF_LINK_FATPIPE;
934 surf_parse_error(bprintf
935 ("Invalid cluster sharing policy for cluster %s",
936 struct_cluster->id));
939 sg_platf_new_link(&link);
941 surf_parsing_link_up_down_t info =
942 xbt_new0(s_surf_parsing_link_up_down_t, 1);
943 if (link.policy == SURF_LINK_FULLDUPLEX) {
944 char *tmp_link = bprintf("%s_UP", link_id);
946 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
948 tmp_link = bprintf("%s_DOWN", link_id);
950 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
953 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
954 info->link_down = info->link_up;
956 surf_routing_cluster_add_link(host_id, info);
962 xbt_dynar_free(&radical_ends);
964 xbt_dynar_free(&radical_elements);
966 // 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
968 XBT_DEBUG("<router id=\"%s\"/>", struct_cluster->router_id);
969 s_sg_platf_router_cbarg_t router;
971 memset(&router, 0, sizeof(router));
972 router.id = struct_cluster->router_id;
974 if (!router.id || !strcmp(router.id, ""))
976 bprintf("%s%s_router%s", struct_cluster->prefix, struct_cluster->id,
977 struct_cluster->suffix);
978 sg_platf_new_router(&router);
982 if ((struct_cluster->bb_bw != 0) && (struct_cluster->bb_lat != 0)) {
983 char *link_backbone = bprintf("%s_backbone", struct_cluster->id);
984 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
985 struct_cluster->bb_bw, struct_cluster->bb_lat);
987 memset(&link, 0, sizeof(link));
988 link.id = link_backbone;
989 link.bandwidth = struct_cluster->bb_bw;
990 link.latency = struct_cluster->bb_lat;
991 link.state = SURF_RESOURCE_ON;
993 switch (struct_cluster->bb_sharing_policy) {
994 case A_surfxml_cluster_bb_sharing_policy_FATPIPE:
995 link.policy = SURF_LINK_FATPIPE;
997 case A_surfxml_cluster_bb_sharing_policy_SHARED:
998 link.policy = SURF_LINK_SHARED;
1001 surf_parse_error(bprintf
1002 ("Invalid bb sharing policy in cluster %s",
1003 struct_cluster->id));
1007 sg_platf_new_link(&link);
1009 surf_parsing_link_up_down_t info =
1010 xbt_new0(s_surf_parsing_link_up_down_t, 1);
1012 xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL);
1013 info->link_down = info->link_up;
1014 surf_routing_cluster_add_link(struct_cluster->id, info);
1016 free(link_backbone);
1021 char *new_suffix = xbt_strdup("");
1023 radical_elements = xbt_str_split(struct_cluster->suffix, ".");
1024 xbt_dynar_foreach(radical_elements, iter, groups) {
1025 if (strcmp(groups, "")) {
1026 char *old_suffix = new_suffix;
1027 new_suffix = bprintf("%s\\.%s", old_suffix, groups);
1032 xbt_dynar_free(&radical_elements);
1033 xbt_free(new_suffix);
1035 if (strcmp(struct_cluster->availability_trace, "")
1036 || strcmp(struct_cluster->state_trace, ""))
1037 xbt_dict_free(&patterns);
1040 sg_platf_new_AS_end();
1044 static void routing_parse_postparse(void)
1046 xbt_dict_free(&random_value);
1047 xbt_dict_free(&patterns);
1050 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1052 static int AX_ptr = 0;
1053 char *host_id = NULL;
1054 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
1056 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
1057 static unsigned int surfxml_buffer_stack_stack[1024];
1059 surfxml_buffer_stack_stack[0] = 0;
1061 surfxml_bufferstack_push(1);
1063 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
1064 sg_platf_new_AS_begin(peer->id, "Full");
1067 host_id = HOST_PEER(peer->id);
1068 router_id = ROUTER_PEER(peer->id);
1069 link_id_up = LINK_UP_PEER(peer->id);
1070 link_id_down = LINK_DOWN_PEER(peer->id);
1072 link_router = bprintf("%s_link_router", peer->id);
1073 link_backbone = bprintf("%s_backbone", peer->id);
1075 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1076 s_sg_platf_host_cbarg_t host;
1077 memset(&host, 0, sizeof(host));
1078 host.initial_state = SURF_RESOURCE_ON;
1080 host.power_peak = peer->power;
1081 host.power_scale = 1.0;
1082 host.power_trace = peer->availability_trace;
1083 host.state_trace = peer->state_trace;
1084 host.core_amount = 1;
1085 sg_platf_new_host(&host);
1088 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1089 s_sg_platf_router_cbarg_t router;
1090 memset(&router, 0, sizeof(router));
1091 router.id = router_id;
1092 router.coord = peer->coord;
1093 sg_platf_new_router(&router);
1095 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1096 peer->bw_in, peer->lat);
1097 s_sg_platf_link_cbarg_t link;
1098 memset(&link, 0, sizeof(link));
1099 link.state = SURF_RESOURCE_ON;
1100 link.policy = SURF_LINK_SHARED;
1101 link.id = link_id_up;
1102 link.bandwidth = peer->bw_in;
1103 link.latency = peer->lat;
1104 sg_platf_new_link(&link);
1106 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1107 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1108 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1109 peer->bw_out, peer->lat);
1110 link.id = link_id_down;
1111 sg_platf_new_link(&link);
1116 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1117 XBT_DEBUG("symmetrical=\"NO\">");
1118 SURFXML_BUFFER_SET(route_src, host_id);
1119 SURFXML_BUFFER_SET(route_dst, router_id);
1120 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1121 SURFXML_START_TAG(route);
1123 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1124 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1125 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1126 SURFXML_START_TAG(link_ctn);
1127 SURFXML_END_TAG(link_ctn);
1129 XBT_DEBUG("</route>");
1130 SURFXML_END_TAG(route);
1133 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1134 XBT_DEBUG("symmetrical=\"NO\">");
1135 SURFXML_BUFFER_SET(route_src, router_id);
1136 SURFXML_BUFFER_SET(route_dst, host_id);
1137 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1138 SURFXML_START_TAG(route);
1140 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1141 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1142 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1143 SURFXML_START_TAG(link_ctn);
1144 SURFXML_END_TAG(link_ctn);
1146 XBT_DEBUG("</route>");
1147 SURFXML_END_TAG(route);
1150 sg_platf_new_AS_end();
1153 //xbt_dynar_free(&tab_elements_num);
1157 free(link_backbone);
1160 surfxml_bufferstack_pop(1);
1163 static void routing_parse_Srandom(void)
1165 double mean, std, min, max, seed;
1166 char *random_id = A_surfxml_random_id;
1167 char *random_radical = A_surfxml_random_radical;
1168 char *rd_name = NULL;
1170 mean = surf_parse_get_double(A_surfxml_random_mean);
1171 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1172 min = surf_parse_get_double(A_surfxml_random_min);
1173 max = surf_parse_get_double(A_surfxml_random_max);
1174 seed = surf_parse_get_double(A_surfxml_random_seed);
1178 random_data_t random = xbt_new0(s_random_data_t, 1);
1181 xbt_dynar_t radical_elements;
1185 xbt_dynar_t radical_ends;
1187 random->generator = A_surfxml_random_generator;
1188 random->seed = seed;
1192 /* Check user stupidities */
1194 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1196 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1198 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1200 /* normalize the mean and standard deviation before storing */
1201 random->mean = (mean - min) / (max - min);
1202 random->std = std / (max - min);
1204 if (random->mean * (1 - random->mean) < random->std * random->std)
1205 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1206 random->mean, random->std);
1209 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1210 random_id, random->min, random->max, random->mean, random->std,
1211 random->generator, random->seed, random_radical);
1213 if (xbt_dict_size(random_value) == 0)
1214 random_value = xbt_dict_new();
1216 if (!strcmp(random_radical, "")) {
1217 res = random_generate(random);
1218 rd_value = bprintf("%f", res);
1219 xbt_dict_set(random_value, random_id, rd_value, free);
1221 radical_elements = xbt_str_split(random_radical, ",");
1222 xbt_dynar_foreach(radical_elements, iter, groups) {
1223 radical_ends = xbt_str_split(groups, "-");
1224 switch (xbt_dynar_length(radical_ends)) {
1226 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1227 "Custom Random '%s' already exists !", random_id);
1228 res = random_generate(random);
1230 bprintf("%s%d", random_id,
1231 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1232 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1237 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1238 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1239 for (i = start; i <= end; i++) {
1240 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1241 "Custom Random '%s' already exists !", bprintf("%s%d",
1244 res = random_generate(random);
1245 tmpbuf = bprintf("%s%d", random_id, i);
1246 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1251 XBT_INFO("Malformed radical");
1254 res = random_generate(random);
1255 rd_name = bprintf("%s_router", random_id);
1256 rd_value = bprintf("%f", res);
1257 xbt_dict_set(random_value, rd_name, rd_value, free);
1259 xbt_dynar_free(&radical_ends);
1262 xbt_dynar_free(&radical_elements);
1266 void routing_register_callbacks()
1268 sg_platf_host_add_cb(parse_S_host);
1269 sg_platf_router_add_cb(parse_S_router);
1271 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1273 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1274 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1275 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1276 &routing_parse_S_bypassRoute);
1278 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1280 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1281 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1282 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1283 &routing_parse_E_bypassRoute);
1285 surfxml_add_callback(STag_surfxml_cluster_cb_list, &routing_parse_cluster);
1287 sg_platf_peer_add_cb(routing_parse_peer);
1288 sg_platf_postparse_add_cb(routing_parse_postparse);
1291 instr_routing_define_callbacks();