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;
40 routing_model_description_t current_routing_model = NULL;
42 /* global parse functions */
43 xbt_dynar_t link_list = NULL; /* temporary store of current list link of a route */
44 static const char *src = NULL; /* temporary store the source name of a route */
45 static const char *dst = NULL; /* temporary store the destination name of a route */
46 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
47 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
49 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
51 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
52 static void routing_parse_Srandom(void); /* random bypass */
54 static char *replace_random_parameter(char *chaine);
55 static void routing_parse_postparse(void);
57 /* this lines are only for replace use like index in the model table */
62 SURF_MODEL_DIJKSTRACACHE,
69 struct s_model_type routing_models[] = {
71 "Full routing data (fast, large memory requirements, fully expressive)",
72 model_full_create, model_full_end},
74 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
75 model_floyd_create, model_floyd_end},
77 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
78 model_dijkstra_create, model_dijkstra_both_end},
80 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
81 model_dijkstracache_create, model_dijkstra_both_end},
82 {"none", "No routing (usable with Constant network only)",
83 model_none_create, NULL},
84 {"RuleBased", "Rule-Based routing data (...)",
85 model_rulebased_create, NULL},
86 {"Vivaldi", "Vivaldi routing",
87 model_vivaldi_create, NULL},
88 {"Cluster", "Cluster routing",
89 model_cluster_create, NULL},
90 {NULL, NULL, NULL, NULL}
94 * \brief Add a "host" to the network element list
96 static void parse_S_host(sg_platf_host_cbarg_t host)
98 network_element_info_t info = NULL;
99 if (current_routing->hierarchy == SURF_ROUTING_NULL)
100 current_routing->hierarchy = SURF_ROUTING_BASE;
101 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
102 "Reading a host, processing unit \"%s\" already exists", host->id);
104 (*(current_routing->parse_PU)) (current_routing, host->id);
105 info = xbt_new0(s_network_element_info_t, 1);
106 info->rc_component = current_routing;
107 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
108 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
109 if (host->coord && strcmp(host->coord, "")) {
110 if (!COORD_HOST_LEVEL)
112 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
113 xbt_dynar_t ctn = xbt_str_split_str(host->coord, " ");
114 xbt_dynar_shrink(ctn, 0);
115 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
120 * \brief Add a "router" to the network element list
122 static void parse_S_router(sg_platf_router_cbarg_t router)
124 network_element_info_t info = NULL;
125 if (current_routing->hierarchy == SURF_ROUTING_NULL)
126 current_routing->hierarchy = SURF_ROUTING_BASE;
127 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
128 "Reading a router, processing unit \"%s\" already exists",
131 (*(current_routing->parse_PU)) (current_routing, router->id);
132 info = xbt_new0(s_network_element_info_t, 1);
133 info->rc_component = current_routing;
134 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
136 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
137 if (strcmp(router->coord, "")) {
138 if (!COORD_ASR_LEVEL)
140 ("To use coordinates, you must set configuration 'coordinates' to 'yes'");
141 xbt_dynar_t ctn = xbt_str_split_str(router->coord, " ");
142 xbt_dynar_shrink(ctn, 0);
143 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
149 * \brief Set the end points for a route
151 static void routing_parse_S_route(void)
153 if (src != NULL && dst != NULL && link_list != NULL)
154 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
155 A_surfxml_route_src, A_surfxml_route_dst);
156 src = A_surfxml_route_src;
157 dst = A_surfxml_route_dst;
158 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
159 "Some limits are null in the route between \"%s\" and \"%s\"",
161 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
165 * \brief Set the end points and gateways for a ASroute
167 static void routing_parse_S_ASroute(void)
169 if (src != NULL && dst != NULL && link_list != NULL)
170 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
171 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
172 src = A_surfxml_ASroute_src;
173 dst = A_surfxml_ASroute_dst;
174 gw_src = A_surfxml_ASroute_gw_src;
175 gw_dst = A_surfxml_ASroute_gw_dst;
176 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
177 || strlen(gw_dst) > 0,
178 "Some limits are null in the route between \"%s\" and \"%s\"",
180 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
184 * \brief Set the end points for a bypassRoute
186 static void routing_parse_S_bypassRoute(void)
188 if (src != NULL && dst != NULL && link_list != NULL)
190 "Bypass Route between %s to %s can not be defined",
191 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
192 src = A_surfxml_bypassRoute_src;
193 dst = A_surfxml_bypassRoute_dst;
194 gw_src = A_surfxml_bypassRoute_gw_src;
195 gw_dst = A_surfxml_bypassRoute_gw_dst;
196 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
197 || strlen(gw_dst) > 0,
198 "Some limits are null in the route between \"%s\" and \"%s\"",
200 link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
204 * \brief Set a new link on the actual list of link for a route or ASroute from XML
207 static void routing_parse_link_ctn(void)
210 switch (A_surfxml_link_ctn_direction) {
211 case AU_surfxml_link_ctn_direction:
212 case A_surfxml_link_ctn_direction_NONE:
213 link_id = xbt_strdup(A_surfxml_link_ctn_id);
215 case A_surfxml_link_ctn_direction_UP:
216 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
218 case A_surfxml_link_ctn_direction_DOWN:
219 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
222 xbt_dynar_push(link_list, &link_id);
226 * \brief Store the route by calling the set_route function of the current routing component
228 static void routing_parse_E_route(void)
230 route_extended_t route = xbt_new0(s_route_extended_t, 1);
231 route->generic_route.link_list = link_list;
232 xbt_assert(current_routing->parse_route,
233 "no defined method \"set_route\" in \"%s\"",
234 current_routing->name);
235 (*(current_routing->parse_route)) (current_routing, src, dst, route);
242 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
244 static void routing_parse_E_ASroute(void)
246 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
247 e_route->generic_route.link_list = link_list;
248 e_route->src_gateway = xbt_strdup(gw_src);
249 e_route->dst_gateway = xbt_strdup(gw_dst);
250 xbt_assert(current_routing->parse_ASroute,
251 "no defined method \"set_ASroute\" in \"%s\"",
252 current_routing->name);
253 (*(current_routing->parse_ASroute)) (current_routing, src, dst, e_route);
262 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
264 static void routing_parse_E_bypassRoute(void)
266 route_extended_t e_route = xbt_new0(s_route_extended_t, 1);
267 e_route->generic_route.link_list = link_list;
268 e_route->src_gateway = xbt_strdup(gw_src);
269 e_route->dst_gateway = xbt_strdup(gw_dst);
270 xbt_assert(current_routing->parse_bypassroute,
271 "Bypassing mechanism not implemented by routing '%s'",
272 current_routing->name);
273 (*(current_routing->parse_bypassroute)) (current_routing, src, dst, e_route);
282 * \brief Make a new routing component to the platform
284 * Add a new autonomous system to the platform. Any elements (such as host,
285 * router or sub-AS) added after this call and before the corresponding call
286 * to sg_platf_new_AS_close() will be added to this AS.
288 * Once this function was called, the configuration concerning the used
289 * models cannot be changed anymore.
291 * @param AS_id name of this autonomous system. Must be unique in the platform
292 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
294 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
297 routing_model_description_t model = NULL;
300 /* search the routing model */
301 for (cpt = 0; routing_models[cpt].name; cpt++)
302 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
303 model = &routing_models[cpt];
304 /* if its not exist, error */
306 fprintf(stderr, "Routing model %s not found. Existing models:\n",
307 wanted_routing_type);
308 for (cpt = 0; routing_models[cpt].name; cpt++)
309 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
310 routing_models[cpt].desc);
314 /* make a new routing component */
315 new_routing = (AS_t) (*(model->create)) ();
316 new_routing->routing = model;
317 new_routing->hierarchy = SURF_ROUTING_NULL;
318 new_routing->name = xbt_strdup(AS_id);
319 new_routing->routing_sons = xbt_dict_new();
321 if (current_routing == NULL && global_routing->root == NULL) {
323 /* it is the first one */
324 new_routing->routing_father = NULL;
325 global_routing->root = new_routing;
327 } else if (current_routing != NULL && global_routing->root != NULL) {
329 xbt_assert(!xbt_dict_get_or_null
330 (current_routing->routing_sons, AS_id),
331 "The AS \"%s\" already exists", AS_id);
332 /* it is a part of the tree */
333 new_routing->routing_father = current_routing;
334 /* set the father behavior */
335 if (current_routing->hierarchy == SURF_ROUTING_NULL)
336 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
337 /* add to the sons dictionary */
338 xbt_dict_set(current_routing->routing_sons, AS_id,
339 (void *) new_routing, NULL);
340 /* add to the father element list */
341 (*(current_routing->parse_AS)) (current_routing, AS_id);
343 THROWF(arg_error, 0, "All defined components must be belong to a AS");
345 /* set the new current component of the tree */
346 current_routing = new_routing;
350 * \brief Specify that the current description of AS is finished
352 * Once you've declared all the content of your AS, you have to close
353 * it with this call. Your AS is not usable until you call this function.
355 * @fixme: this call is not as robust as wanted: bad things WILL happen
356 * if you call it twice for the same AS, or if you forget calling it, or
357 * even if you add stuff to a closed AS
360 void routing_AS_end()
363 if (current_routing == NULL) {
364 THROWF(arg_error, 0, "Close an AS, but none was under construction");
366 network_element_info_t info = NULL;
367 xbt_assert(!xbt_lib_get_or_null
368 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
369 "The AS \"%s\" already exists", current_routing->name);
370 info = xbt_new0(s_network_element_info_t, 1);
371 info->rc_component = current_routing->routing_father;
372 info->rc_type = SURF_NETWORK_ELEMENT_AS;
373 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
376 if (current_routing->routing->end)
377 (*(current_routing->routing->end)) ();
378 current_routing = current_routing->routing_father;
382 /* Aux Business methods */
385 * \brief Get the AS father and the first elements of the chain
387 * \param src the source host name
388 * \param dst the destination host name
390 * Get the common father of the to processing units, and the first different
391 * father in the chain
393 static void elements_father(const char *src, const char *dst,
398 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
399 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
401 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
402 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
410 /* (1) find the as where the src and dst are located */
411 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
413 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
416 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
418 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
419 src_as = src_data->rc_component;
420 dst_as = dst_data->rc_component;
422 xbt_assert(src_as && dst_as,
423 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
425 /* (2) find the path to the root routing component */
426 for (current = src_as; current != NULL; current = current->routing_father) {
427 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
428 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
429 path_src[index_src++] = current;
431 for (current = dst_as; current != NULL; current = current->routing_father) {
432 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
433 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
434 path_dst[index_dst++] = current;
437 /* (3) find the common father */
439 current_src = path_src[--index_src];
440 current_dst = path_dst[--index_dst];
441 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
443 /* (4) they are not in the same routing component, make the path */
444 if (current_src == current_dst)
445 father = current_src;
447 father = path_src[index_src + 1];
449 /* (5) result generation */
450 *res_father = father; /* first the common father of src and dst */
451 *res_src = current_src; /* second the first different father of src */
452 *res_dst = current_dst; /* three the first different father of dst */
454 #undef ELEMENTS_FATHER_MAXDEPTH
457 /* Global Business methods */
460 * \brief Recursive function for get_route_latency
462 * \param src the source host name
463 * \param dst the destination host name
464 * \param *e_route the route where the links are stored
465 * \param *latency the latency, if needed
467 * This function is called by "get_route" and "get_latency". It allows to walk
468 * recursively through the routing components tree.
470 static void _get_route_latency(const char *src, const char *dst,
471 xbt_dynar_t * route, double *latency)
473 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
474 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
479 elements_father(src, dst, &common_father, &src_father, &dst_father);
481 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
483 route_extended_t e_route = NULL;
485 e_route = common_father->get_route(common_father, src, dst);
486 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
487 *route = e_route->generic_route.link_list;
490 *latency = common_father->get_latency(common_father, src, dst, e_route);
491 xbt_assert(*latency >= 0.0,
492 "latency error on route between \"%s\" and \"%s\"", src, dst);
495 xbt_free(e_route->src_gateway);
496 xbt_free(e_route->dst_gateway);
500 } else { /* SURF_ROUTING_RECURSIVE */
502 route_extended_t e_route_bypass = NULL;
503 if (common_father->get_bypass_route)
504 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
506 xbt_assert(!latency || !e_route_bypass,
507 "Bypass cannot work yet with get_latency");
509 route_extended_t e_route_cnt = e_route_bypass
510 ? e_route_bypass : common_father->get_route(common_father,
514 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
515 src_father->name, dst_father->name);
517 xbt_assert((e_route_cnt->src_gateway == NULL) ==
518 (e_route_cnt->dst_gateway == NULL),
519 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
522 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
525 *latency = common_father->get_latency(common_father,
526 src_father->name, dst_father->name,
528 xbt_assert(*latency >= 0.0,
529 "latency error on route between \"%s\" and \"%s\"",
530 src_father->name, dst_father->name);
536 if (strcmp(src, e_route_cnt->src_gateway)) {
538 xbt_dynar_t route_src;
540 _get_route_latency(src, e_route_cnt->src_gateway,
541 (route ? &route_src : NULL),
542 (latency ? &latency_src : NULL));
544 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
545 src, e_route_cnt->src_gateway);
546 xbt_dynar_foreach(route_src, cpt, link) {
547 xbt_dynar_push(*route, &link);
549 xbt_dynar_free(&route_src);
552 xbt_assert(latency_src >= 0.0,
553 "latency error on route between \"%s\" and \"%s\"",
554 src, e_route_cnt->src_gateway);
555 *latency += latency_src;
560 xbt_dynar_foreach(e_route_cnt->generic_route.link_list, cpt, link) {
561 xbt_dynar_push(*route, &link);
565 if (strcmp(e_route_cnt->dst_gateway, dst)) {
567 xbt_dynar_t route_dst;
569 _get_route_latency(e_route_cnt->dst_gateway, dst,
570 (route ? &route_dst : NULL),
571 (latency ? &latency_dst : NULL));
573 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
574 e_route_cnt->dst_gateway, dst);
575 xbt_dynar_foreach(route_dst, cpt, link) {
576 xbt_dynar_push(*route, &link);
578 xbt_dynar_free(&route_dst);
581 xbt_assert(latency_dst >= 0.0,
582 "latency error on route between \"%s\" and \"%s\"",
583 e_route_cnt->dst_gateway, dst);
584 *latency += latency_dst;
588 generic_free_extended_route(e_route_cnt);
593 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
595 static void get_route_latency(const char *src, const char *dst,
596 xbt_dynar_t * route, double *latency, int cleanup)
598 _get_route_latency(src, dst, route, latency);
599 xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
600 xbt_assert(!latency || *latency >= 0.0,
601 "latency error on route between \"%s\" and \"%s\"", src, dst);
603 xbt_dynar_free(&global_routing->last_route);
604 global_routing->last_route = cleanup ? *route : NULL;
609 * \brief Generic method: find a route between hosts
611 * \param src the source host name
612 * \param dst the destination host name
614 * walk through the routing components tree and find a route between hosts
615 * by calling the differents "get_route" functions in each routing component.
616 * No need to free the returned dynar. It will be freed at the next call.
618 static xbt_dynar_t get_route(const char *src, const char *dst)
620 xbt_dynar_t route = NULL;
621 get_route_latency(src, dst, &route, NULL, 1);
626 * \brief Generic method: find a route between hosts
628 * \param src the source host name
629 * \param dst the destination host name
631 * same as get_route, but return NULL if any exception is raised.
633 static xbt_dynar_t get_route_or_null(const char *src, const char *dst)
635 xbt_dynar_t route = NULL;
638 get_route_latency(src, dst, &route, NULL, 1);
640 xbt_ex_free(exception);
647 * \brief Generic method: find a route between hosts
649 * \param src the source host name
650 * \param dst the destination host name
652 * walk through the routing components tree and find a route between hosts
653 * by calling the differents "get_route" functions in each routing component.
654 * Leaves the caller the responsability to clean the returned dynar.
656 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
658 xbt_dynar_t route = NULL;
659 get_route_latency(src, dst, &route, NULL, 0);
663 static double get_latency(const char *src, const char *dst) {
664 double latency = -1.0;
665 get_route_latency(src, dst, NULL, &latency, 0);
670 * \brief Recursive function for finalize
672 * \param rc the source host name
674 * This fuction is call by "finalize". It allow to finalize the
675 * AS or routing components. It delete all the structures.
677 static void finalize_rec(AS_t as) {
678 xbt_dict_cursor_t cursor = NULL;
682 xbt_dict_foreach(as->routing_sons, cursor, key, elem)
685 xbt_dict_free(&as->routing_sons);
691 * \brief Generic method: delete all the routing structures
693 * walk through the routing components tree and delete the structures
694 * by calling the different "finalize" functions in each routing component
696 static void finalize(void) {
697 finalize_rec(global_routing->root);
698 xbt_dynar_free(&global_routing->last_route);
699 xbt_free(global_routing);
702 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
704 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
706 //adding my one link routes
709 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
711 xbt_dynar_foreach(onelink_mine, cpt, link) {
712 xbt_dynar_push(ret, &link);
717 xbt_dict_cursor_t cursor = NULL;
719 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
720 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
722 xbt_dynar_foreach(onelink_child, cpt, link) {
723 xbt_dynar_push(ret, &link);
730 static xbt_dynar_t get_onelink_routes(void)
732 return recursive_get_onelink_routes(global_routing->root);
735 e_surf_network_element_type_t get_network_element_type(const char *name)
737 network_element_info_t rc = NULL;
739 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
743 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
747 return SURF_NETWORK_ELEMENT_NULL;
751 * \brief Generic method: create the global routing schema
753 * Make a global routing structure and set all the parsing functions.
755 void routing_model_create(size_t size_of_links, void *loopback)
757 /* config the uniq global routing */
758 global_routing = xbt_new0(s_routing_global_t, 1);
759 global_routing->root = NULL;
760 global_routing->get_route = get_route;
761 global_routing->get_route_or_null = get_route_or_null;
762 global_routing->get_latency = get_latency;
763 global_routing->get_route_no_cleanup = get_route_no_cleanup;
764 global_routing->get_onelink_routes = get_onelink_routes;
765 global_routing->get_route_latency = get_route_latency;
766 global_routing->get_network_element_type = get_network_element_type;
767 global_routing->finalize = finalize;
768 global_routing->loopback = loopback;
769 global_routing->size_of_link = size_of_links;
770 global_routing->last_route = NULL;
771 /* no current routing at moment */
772 current_routing = NULL;
776 /* ************************************************** */
777 /* ********** PATERN FOR NEW ROUTING **************** */
779 /* The minimal configuration of a new routing model need the next functions,
780 * also you need to set at the start of the file, the new model in the model
781 * list. Remember keep the null ending of the list.
783 /*** Routing model structure ***/
785 // s_routing_component_t generic_routing;
786 // /* things that your routing model need */
787 // } s_routing_component_NEW_t,*routing_component_NEW_t;
789 /*** Parse routing model functions ***/
790 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
791 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
792 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
793 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
794 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
796 /*** Business methods ***/
797 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
798 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
799 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
801 /*** Creation routing model functions ***/
802 // static void* model_NEW_create(void) {
803 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
804 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
805 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
806 // new_component->generic_routing.set_route = model_NEW_set_route;
807 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
808 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
809 // new_component->generic_routing.get_route = NEW_get_route;
810 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
811 // new_component->generic_routing.finalize = NEW_finalize;
812 // /* initialization of internal structures */
813 // return new_component;
815 // static void model_NEW_load(void) {} /* mandatory */
816 // static void model_NEW_unload(void) {} /* mandatory */
817 // static void model_NEW_end(void) {} /* mandatory */
819 /* ************************************************************************** */
820 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
823 static void routing_parse_cluster(void)
825 char *host_id, *groups, *link_id = NULL;
826 xbt_dict_t patterns = NULL;
828 s_sg_platf_host_cbarg_t host;
829 s_sg_platf_link_cbarg_t link;
831 if (strcmp(struct_cluster->availability_trace, "")
832 || strcmp(struct_cluster->state_trace, "")) {
833 patterns = xbt_dict_new();
834 xbt_dict_set(patterns, "id", xbt_strdup(struct_cluster->id), free);
835 xbt_dict_set(patterns, "prefix", xbt_strdup(struct_cluster->prefix), free);
836 xbt_dict_set(patterns, "suffix", xbt_strdup(struct_cluster->suffix), free);
841 xbt_dynar_t radical_elements;
842 xbt_dynar_t radical_ends;
844 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", struct_cluster->id);
845 sg_platf_new_AS_begin(struct_cluster->id, "Cluster");
848 radical_elements = xbt_str_split(struct_cluster->radical, ",");
849 xbt_dynar_foreach(radical_elements, iter, groups) {
850 memset(&host, 0, sizeof(host));
852 radical_ends = xbt_str_split(groups, "-");
853 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
855 switch (xbt_dynar_length(radical_ends)) {
860 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
863 surf_parse_error("Malformed radical");
866 for (i = start; i <= end; i++) {
868 bprintf("%s%d%s", struct_cluster->prefix, i, struct_cluster->suffix);
869 link_id = bprintf("%s_link_%d", struct_cluster->id, i);
871 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id,
872 struct_cluster->power);
874 if (strcmp(struct_cluster->availability_trace, "")) {
875 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
876 char *tmp_availability_file =
877 xbt_strdup(struct_cluster->availability_trace);
878 xbt_str_varsubst(tmp_availability_file, patterns);
879 XBT_DEBUG("\tavailability_file=\"%s\"", tmp_availability_file);
880 host.power_trace = tmgr_trace_new(tmp_availability_file);
881 xbt_free(tmp_availability_file);
883 XBT_DEBUG("\tavailability_file=\"\"");
885 if (strcmp(struct_cluster->state_trace, "")) {
886 char *tmp_state_file = xbt_strdup(struct_cluster->state_trace);
887 xbt_str_varsubst(tmp_state_file, patterns);
888 XBT_DEBUG("\tstate_file=\"%s\"", tmp_state_file);
889 host.state_trace = tmgr_trace_new(tmp_state_file);
890 xbt_free(tmp_state_file);
892 XBT_DEBUG("\tstate_file=\"\"");
895 host.power_peak = struct_cluster->power;
896 host.power_scale = 1.0;
897 host.core_amount = struct_cluster->core_amount;
898 host.initial_state = SURF_RESOURCE_ON;
900 sg_platf_new_host(&host);
901 XBT_DEBUG("</host>");
903 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
904 struct_cluster->bw, struct_cluster->lat);
906 memset(&link, 0, sizeof(link));
908 link.bandwidth = struct_cluster->bw;
909 link.latency = struct_cluster->lat;
910 link.state = SURF_RESOURCE_ON;
912 switch (struct_cluster->sharing_policy) {
913 case A_surfxml_cluster_sharing_policy_SHARED:
914 link.policy = SURF_LINK_SHARED;
916 case A_surfxml_cluster_sharing_policy_FULLDUPLEX:
917 link.policy = SURF_LINK_FULLDUPLEX;
919 case A_surfxml_cluster_sharing_policy_FATPIPE:
920 link.policy = SURF_LINK_FATPIPE;
923 surf_parse_error(bprintf
924 ("Invalid cluster sharing policy for cluster %s",
925 struct_cluster->id));
928 sg_platf_new_link(&link);
930 surf_parsing_link_up_down_t info =
931 xbt_new0(s_surf_parsing_link_up_down_t, 1);
932 if (link.policy == SURF_LINK_FULLDUPLEX) {
933 char *tmp_link = bprintf("%s_UP", link_id);
935 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
937 tmp_link = bprintf("%s_DOWN", link_id);
939 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
942 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
943 info->link_down = info->link_up;
945 surf_routing_cluster_add_link(host_id, info);
951 xbt_dynar_free(&radical_ends);
953 xbt_dynar_free(&radical_elements);
955 // 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
957 XBT_DEBUG("<router id=\"%s\"/>", struct_cluster->router_id);
958 s_sg_platf_router_cbarg_t router;
960 memset(&router, 0, sizeof(router));
961 router.id = struct_cluster->router_id;
963 if (!router.id || !strcmp(router.id, ""))
965 bprintf("%s%s_router%s", struct_cluster->prefix, struct_cluster->id,
966 struct_cluster->suffix);
967 sg_platf_new_router(&router);
971 if ((struct_cluster->bb_bw != 0) && (struct_cluster->bb_lat != 0)) {
972 char *link_backbone = bprintf("%s_backbone", struct_cluster->id);
973 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
974 struct_cluster->bb_bw, struct_cluster->bb_lat);
976 memset(&link, 0, sizeof(link));
977 link.id = link_backbone;
978 link.bandwidth = struct_cluster->bb_bw;
979 link.latency = struct_cluster->bb_lat;
980 link.state = SURF_RESOURCE_ON;
982 switch (struct_cluster->bb_sharing_policy) {
983 case A_surfxml_cluster_bb_sharing_policy_FATPIPE:
984 link.policy = SURF_LINK_FATPIPE;
986 case A_surfxml_cluster_bb_sharing_policy_SHARED:
987 link.policy = SURF_LINK_SHARED;
990 surf_parse_error(bprintf
991 ("Invalid bb sharing policy in cluster %s",
992 struct_cluster->id));
996 sg_platf_new_link(&link);
998 surf_parsing_link_up_down_t info =
999 xbt_new0(s_surf_parsing_link_up_down_t, 1);
1001 xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL);
1002 info->link_down = info->link_up;
1003 surf_routing_cluster_add_link(struct_cluster->id, info);
1005 free(link_backbone);
1010 char *new_suffix = xbt_strdup("");
1012 radical_elements = xbt_str_split(struct_cluster->suffix, ".");
1013 xbt_dynar_foreach(radical_elements, iter, groups) {
1014 if (strcmp(groups, "")) {
1015 char *old_suffix = new_suffix;
1016 new_suffix = bprintf("%s\\.%s", old_suffix, groups);
1021 xbt_dynar_free(&radical_elements);
1022 xbt_free(new_suffix);
1025 sg_platf_new_AS_end();
1027 xbt_dict_free(&patterns); // no op if it were never set
1030 static void routing_parse_postparse(void) {
1031 xbt_dict_free(&random_value);
1034 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1036 static int AX_ptr = 0;
1037 char *host_id = NULL;
1038 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
1040 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
1041 static unsigned int surfxml_buffer_stack_stack[1024];
1043 surfxml_buffer_stack_stack[0] = 0;
1045 surfxml_bufferstack_push(1);
1047 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
1048 sg_platf_new_AS_begin(peer->id, "Full");
1051 host_id = HOST_PEER(peer->id);
1052 router_id = ROUTER_PEER(peer->id);
1053 link_id_up = LINK_UP_PEER(peer->id);
1054 link_id_down = LINK_DOWN_PEER(peer->id);
1056 link_router = bprintf("%s_link_router", peer->id);
1057 link_backbone = bprintf("%s_backbone", peer->id);
1059 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1060 s_sg_platf_host_cbarg_t host;
1061 memset(&host, 0, sizeof(host));
1062 host.initial_state = SURF_RESOURCE_ON;
1064 host.power_peak = peer->power;
1065 host.power_scale = 1.0;
1066 host.power_trace = peer->availability_trace;
1067 host.state_trace = peer->state_trace;
1068 host.core_amount = 1;
1069 sg_platf_new_host(&host);
1072 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1073 s_sg_platf_router_cbarg_t router;
1074 memset(&router, 0, sizeof(router));
1075 router.id = router_id;
1076 router.coord = peer->coord;
1077 sg_platf_new_router(&router);
1079 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1080 peer->bw_in, peer->lat);
1081 s_sg_platf_link_cbarg_t link;
1082 memset(&link, 0, sizeof(link));
1083 link.state = SURF_RESOURCE_ON;
1084 link.policy = SURF_LINK_SHARED;
1085 link.id = link_id_up;
1086 link.bandwidth = peer->bw_in;
1087 link.latency = peer->lat;
1088 sg_platf_new_link(&link);
1090 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1091 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1092 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1093 peer->bw_out, peer->lat);
1094 link.id = link_id_down;
1095 sg_platf_new_link(&link);
1100 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1101 XBT_DEBUG("symmetrical=\"NO\">");
1102 SURFXML_BUFFER_SET(route_src, host_id);
1103 SURFXML_BUFFER_SET(route_dst, router_id);
1104 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1105 SURFXML_START_TAG(route);
1107 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1108 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1109 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1110 SURFXML_START_TAG(link_ctn);
1111 SURFXML_END_TAG(link_ctn);
1113 XBT_DEBUG("</route>");
1114 SURFXML_END_TAG(route);
1117 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1118 XBT_DEBUG("symmetrical=\"NO\">");
1119 SURFXML_BUFFER_SET(route_src, router_id);
1120 SURFXML_BUFFER_SET(route_dst, host_id);
1121 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1122 SURFXML_START_TAG(route);
1124 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1125 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1126 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1127 SURFXML_START_TAG(link_ctn);
1128 SURFXML_END_TAG(link_ctn);
1130 XBT_DEBUG("</route>");
1131 SURFXML_END_TAG(route);
1134 sg_platf_new_AS_end();
1137 //xbt_dynar_free(&tab_elements_num);
1141 free(link_backbone);
1144 surfxml_bufferstack_pop(1);
1147 static void routing_parse_Srandom(void)
1149 double mean, std, min, max, seed;
1150 char *random_id = A_surfxml_random_id;
1151 char *random_radical = A_surfxml_random_radical;
1152 char *rd_name = NULL;
1154 mean = surf_parse_get_double(A_surfxml_random_mean);
1155 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1156 min = surf_parse_get_double(A_surfxml_random_min);
1157 max = surf_parse_get_double(A_surfxml_random_max);
1158 seed = surf_parse_get_double(A_surfxml_random_seed);
1162 random_data_t random = xbt_new0(s_random_data_t, 1);
1165 xbt_dynar_t radical_elements;
1169 xbt_dynar_t radical_ends;
1171 random->generator = A_surfxml_random_generator;
1172 random->seed = seed;
1176 /* Check user stupidities */
1178 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1180 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1182 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1184 /* normalize the mean and standard deviation before storing */
1185 random->mean = (mean - min) / (max - min);
1186 random->std = std / (max - min);
1188 if (random->mean * (1 - random->mean) < random->std * random->std)
1189 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1190 random->mean, random->std);
1193 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1194 random_id, random->min, random->max, random->mean, random->std,
1195 random->generator, random->seed, random_radical);
1197 if (xbt_dict_size(random_value) == 0)
1198 random_value = xbt_dict_new();
1200 if (!strcmp(random_radical, "")) {
1201 res = random_generate(random);
1202 rd_value = bprintf("%f", res);
1203 xbt_dict_set(random_value, random_id, rd_value, free);
1205 radical_elements = xbt_str_split(random_radical, ",");
1206 xbt_dynar_foreach(radical_elements, iter, groups) {
1207 radical_ends = xbt_str_split(groups, "-");
1208 switch (xbt_dynar_length(radical_ends)) {
1210 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1211 "Custom Random '%s' already exists !", random_id);
1212 res = random_generate(random);
1214 bprintf("%s%d", random_id,
1215 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1216 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1221 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1222 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1223 for (i = start; i <= end; i++) {
1224 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1225 "Custom Random '%s' already exists !", bprintf("%s%d",
1228 res = random_generate(random);
1229 tmpbuf = bprintf("%s%d", random_id, i);
1230 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1235 XBT_INFO("Malformed radical");
1238 res = random_generate(random);
1239 rd_name = bprintf("%s_router", random_id);
1240 rd_value = bprintf("%f", res);
1241 xbt_dict_set(random_value, rd_name, rd_value, free);
1243 xbt_dynar_free(&radical_ends);
1246 xbt_dynar_free(&radical_elements);
1250 void routing_register_callbacks()
1252 sg_platf_host_add_cb(parse_S_host);
1253 sg_platf_router_add_cb(parse_S_router);
1255 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1257 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1258 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1259 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1260 &routing_parse_S_bypassRoute);
1262 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1264 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1265 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1266 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1267 &routing_parse_E_bypassRoute);
1269 surfxml_add_callback(STag_surfxml_cluster_cb_list, &routing_parse_cluster);
1271 sg_platf_peer_add_cb(routing_parse_peer);
1272 sg_platf_postparse_add_cb(routing_parse_postparse);
1275 instr_routing_define_callbacks();