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 routing_component_t current_routing = NULL;
41 model_type_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 name_route_extended_t route = xbt_new0(s_name_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 name_route_extended_t e_route = xbt_new0(s_name_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)
297 routing_component_t new_routing;
298 model_type_t model = NULL;
301 surf_parse_models_setup(); /* ensure that the models are created after the last <config> tag and before the first <AS>-like */
303 /* search the routing model */
304 for (cpt = 0; routing_models[cpt].name; cpt++)
305 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
306 model = &routing_models[cpt];
307 /* if its not exist, error */
309 fprintf(stderr, "Routing model %s not found. Existing models:\n",
310 wanted_routing_type);
311 for (cpt = 0; routing_models[cpt].name; cpt++)
312 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
313 routing_models[cpt].desc);
317 /* make a new routing component */
318 new_routing = (routing_component_t) (*(model->create)) ();
319 new_routing->routing = model;
320 new_routing->hierarchy = SURF_ROUTING_NULL;
321 new_routing->name = xbt_strdup(AS_id);
322 new_routing->routing_sons = xbt_dict_new();
324 if (current_routing == NULL && global_routing->root == NULL) {
326 /* it is the first one */
327 new_routing->routing_father = NULL;
328 global_routing->root = new_routing;
330 } else if (current_routing != NULL && global_routing->root != NULL) {
332 xbt_assert(!xbt_dict_get_or_null
333 (current_routing->routing_sons, AS_id),
334 "The AS \"%s\" already exists", AS_id);
335 /* it is a part of the tree */
336 new_routing->routing_father = current_routing;
337 /* set the father behavior */
338 if (current_routing->hierarchy == SURF_ROUTING_NULL)
339 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
340 /* add to the sons dictionary */
341 xbt_dict_set(current_routing->routing_sons, AS_id,
342 (void *) new_routing, NULL);
343 /* add to the father element list */
344 (*(current_routing->parse_AS)) (current_routing, AS_id);
346 THROWF(arg_error, 0, "All defined components must be belong to a AS");
348 /* set the new current component of the tree */
349 current_routing = new_routing;
353 * \brief Specify that the current description of AS is finished
355 * Once you've declared all the content of your AS, you have to close
356 * it with this call. Your AS is not usable until you call this function.
358 * @fixme: this call is not as robust as wanted: bad things WILL happen
359 * if you call it twice for the same AS, or if you forget calling it, or
360 * even if you add stuff to a closed AS
363 void routing_AS_end()
366 if (current_routing == NULL) {
367 THROWF(arg_error, 0, "Close an AS, but none was under construction");
369 network_element_info_t info = NULL;
370 xbt_assert(!xbt_lib_get_or_null
371 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
372 "The AS \"%s\" already exists", current_routing->name);
373 info = xbt_new0(s_network_element_info_t, 1);
374 info->rc_component = current_routing->routing_father;
375 info->rc_type = SURF_NETWORK_ELEMENT_AS;
376 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
379 if (current_routing->routing->end)
380 (*(current_routing->routing->end)) ();
381 current_routing = current_routing->routing_father;
385 /* Aux Business methods */
388 * \brief Get the AS name of the element
390 * \param name the host name
393 static char *elements_As_name(const char *name)
395 routing_component_t as_comp;
397 /* (1) find the as where the host is located */
398 as_comp = ((network_element_info_t)
399 xbt_lib_get_or_null(host_lib, name,
400 ROUTING_HOST_LEVEL))->rc_component;
401 return as_comp->name;
406 * \brief Get the AS father and the first elements of the chain
408 * \param src the source host name
409 * \param dst the destination host name
411 * Get the common father of the to processing units, and the first different
412 * father in the chain
414 static void elements_father(const char *src, const char *dst,
415 routing_component_t * res_father,
416 routing_component_t * res_src,
417 routing_component_t * res_dst)
419 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
420 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
421 routing_component_t src_as, dst_as;
422 routing_component_t path_src[ELEMENTS_FATHER_MAXDEPTH];
423 routing_component_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
426 routing_component_t current;
427 routing_component_t current_src;
428 routing_component_t current_dst;
429 routing_component_t father;
431 /* (1) find the as where the src and dst are located */
432 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
434 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
437 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
439 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
440 src_as = src_data->rc_component;
441 dst_as = dst_data->rc_component;
443 xbt_assert(src_as && dst_as,
444 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
446 /* (2) find the path to the root routing component */
447 for (current = src_as; current != NULL; current = current->routing_father) {
448 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
449 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
450 path_src[index_src++] = current;
452 for (current = dst_as; current != NULL; current = current->routing_father) {
453 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
454 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
455 path_dst[index_dst++] = current;
458 /* (3) find the common father */
460 current_src = path_src[--index_src];
461 current_dst = path_dst[--index_dst];
462 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
464 /* (4) they are not in the same routing component, make the path */
465 if (current_src == current_dst)
466 father = current_src;
468 father = path_src[index_src + 1];
470 /* (5) result generation */
471 *res_father = father; /* first the common father of src and dst */
472 *res_src = current_src; /* second the first different father of src */
473 *res_dst = current_dst; /* three the first different father of dst */
475 #undef ELEMENTS_FATHER_MAXDEPTH
478 /* Global Business methods */
481 * \brief Recursive function for get_route_latency
483 * \param src the source host name
484 * \param dst the destination host name
485 * \param *e_route the route where the links are stored
486 * \param *latency the latency, if needed
488 * This function is called by "get_route" and "get_latency". It allows to walk
489 * recursively through the routing components tree.
491 static void _get_route_latency(const char *src, const char *dst,
492 xbt_dynar_t * route, double *latency)
494 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
495 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
497 routing_component_t common_father;
498 routing_component_t src_father;
499 routing_component_t dst_father;
500 elements_father(src, dst, &common_father, &src_father, &dst_father);
502 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
504 route_extended_t e_route = NULL;
506 e_route = common_father->get_route(common_father, src, dst);
507 xbt_assert(e_route, "no route between \"%s\" and \"%s\"", src, dst);
508 *route = e_route->generic_route.link_list;
511 *latency = common_father->get_latency(common_father, src, dst, e_route);
512 xbt_assert(*latency >= 0.0,
513 "latency error on route between \"%s\" and \"%s\"", src, dst);
516 xbt_free(e_route->src_gateway);
517 xbt_free(e_route->dst_gateway);
521 } else { /* SURF_ROUTING_RECURSIVE */
523 route_extended_t e_route_bypass = NULL;
524 if (common_father->get_bypass_route)
525 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
527 xbt_assert(!latency || !e_route_bypass,
528 "Bypass cannot work yet with get_latency");
530 route_extended_t e_route_cnt = e_route_bypass
531 ? e_route_bypass : common_father->get_route(common_father,
535 xbt_assert(e_route_cnt, "no route between \"%s\" and \"%s\"",
536 src_father->name, dst_father->name);
538 xbt_assert((e_route_cnt->src_gateway == NULL) ==
539 (e_route_cnt->dst_gateway == NULL),
540 "bad gateway for route between \"%s\" and \"%s\"", src, dst);
543 *route = xbt_dynar_new(global_routing->size_of_link, NULL);
546 *latency = common_father->get_latency(common_father,
547 src_father->name, dst_father->name,
549 xbt_assert(*latency >= 0.0,
550 "latency error on route between \"%s\" and \"%s\"",
551 src_father->name, dst_father->name);
557 if (strcmp(src, e_route_cnt->src_gateway)) {
559 xbt_dynar_t route_src;
561 _get_route_latency(src, e_route_cnt->src_gateway,
562 (route ? &route_src : NULL),
563 (latency ? &latency_src : NULL));
565 xbt_assert(route_src, "no route between \"%s\" and \"%s\"",
566 src, e_route_cnt->src_gateway);
567 xbt_dynar_foreach(route_src, cpt, link) {
568 xbt_dynar_push(*route, &link);
570 xbt_dynar_free(&route_src);
573 xbt_assert(latency_src >= 0.0,
574 "latency error on route between \"%s\" and \"%s\"",
575 src, e_route_cnt->src_gateway);
576 *latency += latency_src;
581 xbt_dynar_foreach(e_route_cnt->generic_route.link_list, cpt, link) {
582 xbt_dynar_push(*route, &link);
586 if (strcmp(e_route_cnt->dst_gateway, dst)) {
588 xbt_dynar_t route_dst;
590 _get_route_latency(e_route_cnt->dst_gateway, dst,
591 (route ? &route_dst : NULL),
592 (latency ? &latency_dst : NULL));
594 xbt_assert(route_dst, "no route between \"%s\" and \"%s\"",
595 e_route_cnt->dst_gateway, dst);
596 xbt_dynar_foreach(route_dst, cpt, link) {
597 xbt_dynar_push(*route, &link);
599 xbt_dynar_free(&route_dst);
602 xbt_assert(latency_dst >= 0.0,
603 "latency error on route between \"%s\" and \"%s\"",
604 e_route_cnt->dst_gateway, dst);
605 *latency += latency_dst;
609 generic_free_extended_route(e_route_cnt);
614 * \brief Generic function for get_route, get_route_no_cleanup, and get_latency
616 static void get_route_latency(const char *src, const char *dst,
617 xbt_dynar_t * route, double *latency, int cleanup)
619 _get_route_latency(src, dst, route, latency);
620 xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
621 xbt_assert(!latency || *latency >= 0.0,
622 "latency error on route between \"%s\" and \"%s\"", src, dst);
624 xbt_dynar_free(&global_routing->last_route);
625 global_routing->last_route = cleanup ? *route : NULL;
630 * \brief Generic method: find a route between hosts
632 * \param src the source host name
633 * \param dst the destination host name
635 * walk through the routing components tree and find a route between hosts
636 * by calling the differents "get_route" functions in each routing component.
637 * No need to free the returned dynar. It will be freed at the next call.
639 static xbt_dynar_t get_route(const char *src, const char *dst)
641 xbt_dynar_t route = NULL;
642 get_route_latency(src, dst, &route, NULL, 1);
647 * \brief Generic method: find a route between hosts
649 * \param src the source host name
650 * \param dst the destination host name
652 * same as get_route, but return NULL if any exception is raised.
654 static xbt_dynar_t get_route_or_null(const char *src, const char *dst)
656 xbt_dynar_t route = NULL;
659 get_route_latency(src, dst, &route, NULL, 1);
661 xbt_ex_free(exception);
668 * \brief Generic method: find a route between hosts
670 * \param src the source host name
671 * \param dst the destination host name
673 * walk through the routing components tree and find a route between hosts
674 * by calling the differents "get_route" functions in each routing component.
675 * Leaves the caller the responsability to clean the returned dynar.
677 static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
679 xbt_dynar_t route = NULL;
680 get_route_latency(src, dst, &route, NULL, 0);
685 static double get_latency(const char *src, const char *dst)
687 double latency = -1.0;
688 get_route_latency(src, dst, NULL, &latency, 0);
692 static int surf_parse_models_setup_already_called = 0;
693 /* Call the last initialization functions, that must be called after the
694 * <config> tag, if any, and before the first of cluster|peer|AS|trace|trace_connect
696 void surf_parse_models_setup()
698 if (surf_parse_models_setup_already_called)
700 surf_parse_models_setup_already_called = 1;
701 surf_config_models_setup();
706 * \brief Recursive function for finalize
708 * \param rc the source host name
710 * This fuction is call by "finalize". It allow to finalize the
711 * AS or routing components. It delete all the structures.
713 static void _finalize(routing_component_t rc)
716 xbt_dict_cursor_t cursor = NULL;
718 routing_component_t elem;
719 xbt_dict_foreach(rc->routing_sons, cursor, key, elem) {
722 xbt_dict_t tmp_sons = rc->routing_sons;
723 char *tmp_name = rc->name;
724 xbt_dict_free(&tmp_sons);
726 xbt_assert(rc->finalize, "no defined method \"finalize\" in \"%s\"",
727 current_routing->name);
728 (*(rc->finalize)) (rc);
733 * \brief Generic method: delete all the routing structures
735 * walk through the routing components tree and delete the structures
736 * by calling the differents "finalize" functions in each routing component
738 static void finalize(void)
740 /* delete recursively all the tree */
741 _finalize(global_routing->root);
742 /* delete last_route */
743 xbt_dynar_free(&(global_routing->last_route));
744 /* delete global routing structure */
745 xbt_free(global_routing);
746 /* make sure that we will reinit the models while loading the platf once reinited -- HACK but there is no proper surf_routing_init() */
747 surf_parse_models_setup_already_called = 0;
750 static xbt_dynar_t recursive_get_onelink_routes(routing_component_t rc)
752 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
754 //adding my one link routes
757 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
759 xbt_dynar_foreach(onelink_mine, cpt, link) {
760 xbt_dynar_push(ret, &link);
765 xbt_dict_cursor_t cursor = NULL;
766 routing_component_t rc_child;
767 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
768 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
770 xbt_dynar_foreach(onelink_child, cpt, link) {
771 xbt_dynar_push(ret, &link);
778 static xbt_dynar_t get_onelink_routes(void)
780 return recursive_get_onelink_routes(global_routing->root);
783 e_surf_network_element_type_t get_network_element_type(const char *name)
785 network_element_info_t rc = NULL;
787 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
791 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
795 return SURF_NETWORK_ELEMENT_NULL;
799 * \brief Generic method: create the global routing schema
801 * Make a global routing structure and set all the parsing functions.
803 void routing_model_create(size_t size_of_links, void *loopback)
805 /* config the uniq global routing */
806 global_routing = xbt_new0(s_routing_global_t, 1);
807 global_routing->root = NULL;
808 global_routing->get_route = get_route;
809 global_routing->get_route_or_null = get_route_or_null;
810 global_routing->get_latency = get_latency;
811 global_routing->get_route_no_cleanup = get_route_no_cleanup;
812 global_routing->get_onelink_routes = get_onelink_routes;
813 global_routing->get_route_latency = get_route_latency;
814 global_routing->get_network_element_type = get_network_element_type;
815 global_routing->finalize = finalize;
816 global_routing->loopback = loopback;
817 global_routing->size_of_link = size_of_links;
818 global_routing->last_route = NULL;
819 /* no current routing at moment */
820 current_routing = NULL;
824 /* ************************************************** */
825 /* ********** PATERN FOR NEW ROUTING **************** */
827 /* The minimal configuration of a new routing model need the next functions,
828 * also you need to set at the start of the file, the new model in the model
829 * list. Remember keep the null ending of the list.
831 /*** Routing model structure ***/
833 // s_routing_component_t generic_routing;
834 // /* things that your routing model need */
835 // } s_routing_component_NEW_t,*routing_component_NEW_t;
837 /*** Parse routing model functions ***/
838 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
839 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
840 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
841 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
842 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
844 /*** Business methods ***/
845 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
846 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
847 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
849 /*** Creation routing model functions ***/
850 // static void* model_NEW_create(void) {
851 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
852 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
853 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
854 // new_component->generic_routing.set_route = model_NEW_set_route;
855 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
856 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
857 // new_component->generic_routing.get_route = NEW_get_route;
858 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
859 // new_component->generic_routing.finalize = NEW_finalize;
860 // /* initialization of internal structures */
861 // return new_component;
863 // static void model_NEW_load(void) {} /* mandatory */
864 // static void model_NEW_unload(void) {} /* mandatory */
865 // static void model_NEW_end(void) {} /* mandatory */
867 /* ************************************************************************** */
868 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
871 static void routing_parse_cluster(void)
873 char *host_id, *groups, *link_id = NULL;
875 s_sg_platf_host_cbarg_t host;
876 s_sg_platf_link_cbarg_t link;
878 if (strcmp(struct_cluster->availability_trace, "")
879 || strcmp(struct_cluster->state_trace, "")) {
880 if (xbt_dict_size(patterns) == 0)
881 patterns = xbt_dict_new();
882 xbt_dict_set(patterns, "id", xbt_strdup(struct_cluster->id), free);
883 xbt_dict_set(patterns, "prefix", xbt_strdup(struct_cluster->prefix), free);
884 xbt_dict_set(patterns, "suffix", xbt_strdup(struct_cluster->suffix), free);
889 xbt_dynar_t radical_elements;
890 xbt_dynar_t radical_ends;
892 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", struct_cluster->id);
893 sg_platf_new_AS_begin(struct_cluster->id, "Cluster");
896 radical_elements = xbt_str_split(struct_cluster->radical, ",");
897 xbt_dynar_foreach(radical_elements, iter, groups) {
898 memset(&host, 0, sizeof(host));
900 radical_ends = xbt_str_split(groups, "-");
901 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
903 switch (xbt_dynar_length(radical_ends)) {
908 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
911 surf_parse_error("Malformed radical");
914 for (i = start; i <= end; i++) {
916 bprintf("%s%d%s", struct_cluster->prefix, i, struct_cluster->suffix);
917 link_id = bprintf("%s_link_%d", struct_cluster->id, i);
919 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id,
920 struct_cluster->power);
922 if (strcmp(struct_cluster->availability_trace, "")) {
923 xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
924 char *tmp_availability_file =
925 xbt_strdup(struct_cluster->availability_trace);
926 xbt_str_varsubst(tmp_availability_file, patterns);
927 XBT_DEBUG("\tavailability_file=\"%s\"", tmp_availability_file);
928 host.power_trace = tmgr_trace_new(tmp_availability_file);
929 xbt_free(tmp_availability_file);
931 XBT_DEBUG("\tavailability_file=\"\"");
933 if (strcmp(struct_cluster->state_trace, "")) {
934 char *tmp_state_file = xbt_strdup(struct_cluster->state_trace);
935 xbt_str_varsubst(tmp_state_file, patterns);
936 XBT_DEBUG("\tstate_file=\"%s\"", tmp_state_file);
937 host.state_trace = tmgr_trace_new(tmp_state_file);
938 xbt_free(tmp_state_file);
940 XBT_DEBUG("\tstate_file=\"\"");
943 host.power_peak = struct_cluster->power;
944 host.power_scale = 1.0;
945 host.core_amount = struct_cluster->core_amount;
946 host.initial_state = SURF_RESOURCE_ON;
948 sg_platf_new_host(&host);
949 XBT_DEBUG("</host>");
951 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
952 struct_cluster->bw, struct_cluster->lat);
954 memset(&link, 0, sizeof(link));
956 link.bandwidth = struct_cluster->bw;
957 link.latency = struct_cluster->lat;
958 link.state = SURF_RESOURCE_ON;
960 switch (struct_cluster->sharing_policy) {
961 case A_surfxml_cluster_sharing_policy_SHARED:
962 link.policy = SURF_LINK_SHARED;
964 case A_surfxml_cluster_sharing_policy_FULLDUPLEX:
965 link.policy = SURF_LINK_FULLDUPLEX;
967 case A_surfxml_cluster_sharing_policy_FATPIPE:
968 link.policy = SURF_LINK_FATPIPE;
971 surf_parse_error(bprintf
972 ("Invalid cluster sharing policy for cluster %s",
973 struct_cluster->id));
976 sg_platf_new_link(&link);
978 surf_parsing_link_up_down_t info =
979 xbt_new0(s_surf_parsing_link_up_down_t, 1);
980 if (link.policy == SURF_LINK_FULLDUPLEX) {
981 char *tmp_link = bprintf("%s_UP", link_id);
983 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
985 tmp_link = bprintf("%s_DOWN", link_id);
987 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
990 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
991 info->link_down = info->link_up;
993 surf_routing_cluster_add_link(host_id, info);
999 xbt_dynar_free(&radical_ends);
1001 xbt_dynar_free(&radical_elements);
1003 // 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
1005 XBT_DEBUG("<router id=\"%s\"/>", struct_cluster->router_id);
1006 s_sg_platf_router_cbarg_t router;
1008 memset(&router, 0, sizeof(router));
1009 router.id = struct_cluster->router_id;
1011 if (!router.id || !strcmp(router.id, ""))
1013 bprintf("%s%s_router%s", struct_cluster->prefix, struct_cluster->id,
1014 struct_cluster->suffix);
1015 sg_platf_new_router(&router);
1019 if ((struct_cluster->bb_bw != 0) && (struct_cluster->bb_lat != 0)) {
1020 char *link_backbone = bprintf("%s_backbone", struct_cluster->id);
1021 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
1022 struct_cluster->bb_bw, struct_cluster->bb_lat);
1024 memset(&link, 0, sizeof(link));
1025 link.id = link_backbone;
1026 link.bandwidth = struct_cluster->bb_bw;
1027 link.latency = struct_cluster->bb_lat;
1028 link.state = SURF_RESOURCE_ON;
1030 switch (struct_cluster->bb_sharing_policy) {
1031 case A_surfxml_cluster_bb_sharing_policy_FATPIPE:
1032 link.policy = SURF_LINK_FATPIPE;
1034 case A_surfxml_cluster_bb_sharing_policy_SHARED:
1035 link.policy = SURF_LINK_SHARED;
1038 surf_parse_error(bprintf
1039 ("Invalid bb sharing policy in cluster %s",
1040 struct_cluster->id));
1044 sg_platf_new_link(&link);
1046 surf_parsing_link_up_down_t info =
1047 xbt_new0(s_surf_parsing_link_up_down_t, 1);
1049 xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL);
1050 info->link_down = info->link_up;
1051 surf_routing_cluster_add_link(struct_cluster->id, info);
1053 free(link_backbone);
1058 char *new_suffix = xbt_strdup("");
1060 radical_elements = xbt_str_split(struct_cluster->suffix, ".");
1061 xbt_dynar_foreach(radical_elements, iter, groups) {
1062 if (strcmp(groups, "")) {
1063 char *old_suffix = new_suffix;
1064 new_suffix = bprintf("%s\\.%s", old_suffix, groups);
1069 xbt_dynar_free(&radical_elements);
1070 xbt_free(new_suffix);
1072 if (strcmp(struct_cluster->availability_trace, "")
1073 || strcmp(struct_cluster->state_trace, ""))
1074 xbt_dict_free(&patterns);
1077 sg_platf_new_AS_end();
1082 * This function take a string and replace parameters from patterns dict.
1083 * It returns the new value.
1085 static char *replace_random_parameter(char *string)
1087 char *test_string = NULL;
1089 if (xbt_dict_size(random_value) == 0)
1092 string = xbt_str_varsubst(string, patterns); // for patterns of cluster
1093 test_string = bprintf("${%s}", string);
1094 test_string = xbt_str_varsubst(test_string, random_value); //Add ${xxxxx} for random Generator
1096 if (strcmp(test_string, "")) { //if not empty, keep this value.
1098 string = test_string;
1099 } //In other case take old value (without ${})
1105 static void routing_parse_postparse(void)
1107 xbt_dict_free(&random_value);
1108 xbt_dict_free(&patterns);
1111 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1113 static int AX_ptr = 0;
1114 char *host_id = NULL;
1115 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
1117 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
1118 static unsigned int surfxml_buffer_stack_stack[1024];
1120 surfxml_buffer_stack_stack[0] = 0;
1122 surfxml_bufferstack_push(1);
1124 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
1125 sg_platf_new_AS_begin(peer->id, "Full");
1128 host_id = HOST_PEER(peer->id);
1129 router_id = ROUTER_PEER(peer->id);
1130 link_id_up = LINK_UP_PEER(peer->id);
1131 link_id_down = LINK_DOWN_PEER(peer->id);
1133 link_router = bprintf("%s_link_router", peer->id);
1134 link_backbone = bprintf("%s_backbone", peer->id);
1136 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1137 s_sg_platf_host_cbarg_t host;
1138 memset(&host, 0, sizeof(host));
1139 host.initial_state = SURF_RESOURCE_ON;
1141 host.power_peak = peer->power;
1142 host.power_scale = 1.0;
1143 host.power_trace = peer->availability_trace;
1144 host.state_trace = peer->state_trace;
1145 host.core_amount = 1;
1146 sg_platf_new_host(&host);
1149 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1150 s_sg_platf_router_cbarg_t router;
1151 memset(&router, 0, sizeof(router));
1152 router.id = router_id;
1153 router.coord = peer->coord;
1154 sg_platf_new_router(&router);
1156 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1157 peer->bw_in, peer->lat);
1158 s_sg_platf_link_cbarg_t link;
1159 memset(&link, 0, sizeof(link));
1160 link.state = SURF_RESOURCE_ON;
1161 link.policy = SURF_LINK_SHARED;
1162 link.id = link_id_up;
1163 link.bandwidth = peer->bw_in;
1164 link.latency = peer->lat;
1165 sg_platf_new_link(&link);
1167 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1168 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1169 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1170 peer->bw_out, peer->lat);
1171 link.id = link_id_down;
1172 sg_platf_new_link(&link);
1177 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1178 XBT_DEBUG("symmetrical=\"NO\">");
1179 SURFXML_BUFFER_SET(route_src, host_id);
1180 SURFXML_BUFFER_SET(route_dst, router_id);
1181 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1182 SURFXML_START_TAG(route);
1184 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1185 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1186 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1187 SURFXML_START_TAG(link_ctn);
1188 SURFXML_END_TAG(link_ctn);
1190 XBT_DEBUG("</route>");
1191 SURFXML_END_TAG(route);
1194 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1195 XBT_DEBUG("symmetrical=\"NO\">");
1196 SURFXML_BUFFER_SET(route_src, router_id);
1197 SURFXML_BUFFER_SET(route_dst, host_id);
1198 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1199 SURFXML_START_TAG(route);
1201 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1202 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1203 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1204 SURFXML_START_TAG(link_ctn);
1205 SURFXML_END_TAG(link_ctn);
1207 XBT_DEBUG("</route>");
1208 SURFXML_END_TAG(route);
1211 sg_platf_new_AS_end();
1214 //xbt_dynar_free(&tab_elements_num);
1218 free(link_backbone);
1221 surfxml_bufferstack_pop(1);
1224 static void routing_parse_Srandom(void)
1226 double mean, std, min, max, seed;
1227 char *random_id = A_surfxml_random_id;
1228 char *random_radical = A_surfxml_random_radical;
1229 char *rd_name = NULL;
1231 mean = surf_parse_get_double(A_surfxml_random_mean);
1232 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1233 min = surf_parse_get_double(A_surfxml_random_min);
1234 max = surf_parse_get_double(A_surfxml_random_max);
1235 seed = surf_parse_get_double(A_surfxml_random_seed);
1239 random_data_t random = xbt_new0(s_random_data_t, 1);
1242 xbt_dynar_t radical_elements;
1246 xbt_dynar_t radical_ends;
1248 random->generator = A_surfxml_random_generator;
1249 random->seed = seed;
1253 /* Check user stupidities */
1255 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1257 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1259 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1261 /* normalize the mean and standard deviation before storing */
1262 random->mean = (mean - min) / (max - min);
1263 random->std = std / (max - min);
1265 if (random->mean * (1 - random->mean) < random->std * random->std)
1266 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1267 random->mean, random->std);
1270 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1271 random_id, random->min, random->max, random->mean, random->std,
1272 random->generator, random->seed, random_radical);
1274 if (xbt_dict_size(random_value) == 0)
1275 random_value = xbt_dict_new();
1277 if (!strcmp(random_radical, "")) {
1278 res = random_generate(random);
1279 rd_value = bprintf("%f", res);
1280 xbt_dict_set(random_value, random_id, rd_value, free);
1282 radical_elements = xbt_str_split(random_radical, ",");
1283 xbt_dynar_foreach(radical_elements, iter, groups) {
1284 radical_ends = xbt_str_split(groups, "-");
1285 switch (xbt_dynar_length(radical_ends)) {
1287 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1288 "Custom Random '%s' already exists !", random_id);
1289 res = random_generate(random);
1291 bprintf("%s%d", random_id,
1292 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1293 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1298 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1299 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1300 for (i = start; i <= end; i++) {
1301 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1302 "Custom Random '%s' already exists !", bprintf("%s%d",
1305 res = random_generate(random);
1306 tmpbuf = bprintf("%s%d", random_id, i);
1307 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), free);
1312 XBT_INFO("Malformed radical");
1315 res = random_generate(random);
1316 rd_name = bprintf("%s_router", random_id);
1317 rd_value = bprintf("%f", res);
1318 xbt_dict_set(random_value, rd_name, rd_value, free);
1320 xbt_dynar_free(&radical_ends);
1323 xbt_dynar_free(&radical_elements);
1327 void routing_register_callbacks()
1329 sg_platf_host_add_cb(parse_S_host);
1330 sg_platf_router_add_cb(parse_S_router);
1332 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1334 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1335 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1336 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1337 &routing_parse_S_bypassRoute);
1339 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1341 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1342 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1343 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1344 &routing_parse_E_bypassRoute);
1346 surfxml_add_callback(STag_surfxml_cluster_cb_list, &routing_parse_cluster);
1348 sg_platf_peer_add_cb(routing_parse_peer);
1349 sg_platf_postparse_add_cb(routing_parse_postparse);
1352 instr_routing_define_callbacks();