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 * @ingroup SURF_build_api
17 * @brief A library containing all known workstations
21 int ROUTING_HOST_LEVEL; //Routing level
22 int SURF_CPU_LEVEL; //Surf cpu level
23 int SURF_WKS_LEVEL; //Surf workstation level
24 int SIMIX_HOST_LEVEL; //Simix level
25 int MSG_HOST_LEVEL; //Msg level
26 int SD_HOST_LEVEL; //Simdag level
27 int COORD_HOST_LEVEL=0; //Coordinates level
28 int NS3_HOST_LEVEL; //host node for ns3
30 xbt_dict_t watched_hosts_lib;
33 * @ingroup SURF_build_api
34 * @brief A library containing all known links
37 int SD_LINK_LEVEL; //Simdag level
38 int SURF_LINK_LEVEL; //Surf level
39 int NS3_LINK_LEVEL; //link for ns3
41 xbt_lib_t as_router_lib;
42 int ROUTING_ASR_LEVEL; //Routing level
43 int COORD_ASR_LEVEL; //Coordinates level
44 int NS3_ASR_LEVEL; //host node for ns3
46 static xbt_dict_t random_value = NULL;
48 /** @brief Retrieve a routing edge from its name
50 * Routing edges are either CPU/workstation and routers, whatever
52 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
53 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
54 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
59 routing_platf_t routing_platf = NULL;
60 AS_t current_routing = NULL;
62 /* global parse functions */
63 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
64 extern xbt_dynar_t mount_list;
66 static const char *src = NULL; /* temporary store the source name of a route */
67 static const char *dst = NULL; /* temporary store the destination name of a route */
68 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
69 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
71 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
73 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
74 static void routing_parse_Srandom(void); /* random bypass */
76 static void routing_parse_postparse(void);
78 /* this lines are only for replace use like index in the model table */
83 SURF_MODEL_DIJKSTRACACHE,
90 struct s_model_type routing_models[] = {
92 "Full routing data (fast, large memory requirements, fully expressive)",
93 model_full_create, model_full_end},
95 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
96 model_floyd_create, model_floyd_end},
98 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
99 model_dijkstra_create, model_dijkstra_both_end},
101 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
102 model_dijkstracache_create, model_dijkstra_both_end},
103 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
104 model_none_create, NULL},
105 {"RuleBased", "Rule-Based routing data (...)",
106 model_rulebased_create, NULL},
107 {"Vivaldi", "Vivaldi routing",
108 model_vivaldi_create, NULL},
109 {"Cluster", "Cluster routing",
110 model_cluster_create, NULL},
111 {NULL, NULL, NULL, NULL}
115 * \brief Add a "host_link" to the network element list
117 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
119 sg_routing_edge_t info = NULL;
120 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
121 xbt_assert(info, "Host '%s' not found!",host->id);
122 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
123 "You have to be in model Cluster to use tag host_link!");
125 s_surf_parsing_link_up_down_t link_up_down;
126 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
127 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
129 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
130 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
132 if(!current_routing->link_up_down_list)
133 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
135 // If dynar is is greater than edge id and if the host_link is already defined
136 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
137 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
138 xbt_die("Host_link for '%s' is already defined!",host->id);
140 XBT_INFO("Push Host_link for host '%s' to position %d",info->name,info->id);
141 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
145 * \brief Add a "host" to the network element list
147 static void parse_S_host(sg_platf_host_cbarg_t host)
149 sg_routing_edge_t info = NULL;
150 if (current_routing->hierarchy == SURF_ROUTING_NULL)
151 current_routing->hierarchy = SURF_ROUTING_BASE;
152 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
153 "Reading a host, processing unit \"%s\" already exists", host->id);
155 info = xbt_new0(s_network_element_t, 1);
156 info->rc_component = current_routing;
157 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
158 info->name = xbt_strdup(host->id);
159 info->id = current_routing->parse_PU(current_routing, (void *) info);
160 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
161 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
164 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
168 if (host->coord && strcmp(host->coord, "")) {
172 if (!COORD_HOST_LEVEL)
173 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
174 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
175 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
176 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
177 xbt_dynar_foreach(ctn_str,cursor, str) {
178 double val = atof(str);
179 xbt_dynar_push(ctn,&val);
181 xbt_dynar_shrink(ctn, 0);
182 xbt_dynar_free(&ctn_str);
183 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
184 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
189 * \brief Add a "router" to the network element list
191 static void parse_S_router(sg_platf_router_cbarg_t router)
193 sg_routing_edge_t info = NULL;
194 if (current_routing->hierarchy == SURF_ROUTING_NULL)
195 current_routing->hierarchy = SURF_ROUTING_BASE;
196 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
197 "Reading a router, processing unit \"%s\" already exists",
200 info = xbt_new0(s_network_element_t, 1);
201 info->rc_component = current_routing;
202 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
203 info->name = xbt_strdup(router->id);
204 info->id = current_routing->parse_PU(current_routing, (void *) info);
205 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
206 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
208 if (strcmp(router->coord, "")) {
212 if (!COORD_ASR_LEVEL)
213 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
214 /* Pre-parse the host coordinates */
215 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
216 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
217 xbt_dynar_foreach(ctn_str,cursor, str) {
218 double val = atof(str);
219 xbt_dynar_push(ctn,&val);
221 xbt_dynar_shrink(ctn, 0);
222 xbt_dynar_free(&ctn_str);
223 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
224 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
230 * \brief Set the end points for a route
232 static void routing_parse_S_route(void)
234 src = A_surfxml_route_src;
235 dst = A_surfxml_route_dst;
236 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
237 "Missing end-points while defining route \"%s\"->\"%s\"",
239 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
243 * \brief Set the end points and gateways for a ASroute
245 static void routing_parse_S_ASroute(void)
247 src = A_surfxml_ASroute_src;
248 dst = A_surfxml_ASroute_dst;
249 gw_src = A_surfxml_ASroute_gw_src;
250 gw_dst = A_surfxml_ASroute_gw_dst;
251 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
252 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
253 src, dst,gw_src,gw_dst);
254 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
258 * \brief Set the end points for a bypassRoute
260 static void routing_parse_S_bypassRoute(void)
262 src = A_surfxml_bypassRoute_src;
263 dst = A_surfxml_bypassRoute_dst;
266 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
267 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
268 src, dst,gw_src,gw_dst);
269 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
273 * \brief Set the end points for a bypassASroute
275 static void routing_parse_S_bypassASroute(void)
277 src = A_surfxml_bypassASroute_src;
278 dst = A_surfxml_bypassASroute_dst;
279 gw_src = A_surfxml_bypassASroute_gw_src;
280 gw_dst = A_surfxml_bypassASroute_gw_dst;
281 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
282 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
283 src, dst,gw_src,gw_dst);
284 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
287 * \brief Set a new link on the actual list of link for a route or ASroute from XML
290 static void routing_parse_link_ctn(void)
293 switch (A_surfxml_link_ctn_direction) {
294 case AU_surfxml_link_ctn_direction:
295 case A_surfxml_link_ctn_direction_NONE:
296 link_id = xbt_strdup(A_surfxml_link_ctn_id);
298 case A_surfxml_link_ctn_direction_UP:
299 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
301 case A_surfxml_link_ctn_direction_DOWN:
302 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
305 xbt_dynar_push(parsed_link_list, &link_id);
309 * \brief Store the route by calling the set_route function of the current routing component
311 static void routing_parse_E_route(void)
313 route_t route = xbt_new0(s_route_t, 1);
314 route->link_list = parsed_link_list;
315 xbt_assert(current_routing->parse_route,
316 "no defined method \"set_route\" in \"%s\"",
317 current_routing->name);
318 current_routing->parse_route(current_routing, src, dst, route);
319 generic_free_route(route);
320 parsed_link_list = NULL;
326 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
328 static void routing_parse_E_ASroute(void)
330 route_t e_route = xbt_new0(s_route_t, 1);
331 e_route->link_list = parsed_link_list;
333 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
334 // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
335 // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
337 // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
338 e_route->src_gateway = (sg_routing_edge_t) gw_src;
339 e_route->dst_gateway = (sg_routing_edge_t) gw_dst;
341 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
342 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
344 xbt_assert(current_routing->parse_ASroute,
345 "no defined method \"set_ASroute\" in \"%s\"",
346 current_routing->name);
347 current_routing->parse_ASroute(current_routing, src, dst, e_route);
348 generic_free_route(e_route);
349 parsed_link_list = NULL;
357 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
359 static void routing_parse_E_bypassRoute(void)
361 route_t e_route = xbt_new0(s_route_t, 1);
362 e_route->link_list = parsed_link_list;
364 xbt_assert(current_routing->parse_bypassroute,
365 "Bypassing mechanism not implemented by routing '%s'",
366 current_routing->name);
368 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
369 parsed_link_list = NULL;
376 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
378 static void routing_parse_E_bypassASroute(void)
380 route_t e_route = xbt_new0(s_route_t, 1);
381 e_route->link_list = parsed_link_list;
382 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
383 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
384 xbt_assert(current_routing->parse_bypassroute,
385 "Bypassing mechanism not implemented by routing '%s'",
386 current_routing->name);
387 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
388 parsed_link_list = NULL;
396 * \brief Make a new routing component to the platform
398 * Add a new autonomous system to the platform. Any elements (such as host,
399 * router or sub-AS) added after this call and before the corresponding call
400 * to sg_platf_new_AS_close() will be added to this AS.
402 * Once this function was called, the configuration concerning the used
403 * models cannot be changed anymore.
405 * @param AS_id name of this autonomous system. Must be unique in the platform
406 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
408 void routing_AS_begin(const char *AS_id, int wanted_routing_type)
411 routing_model_description_t model = NULL;
413 xbt_assert(!xbt_lib_get_or_null
414 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
415 "The AS \"%s\" already exists", AS_id);
417 /* search the routing model */
418 switch(wanted_routing_type){
419 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
420 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
421 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
422 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
423 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
424 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
425 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
426 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
429 /* make a new routing component */
430 new_as = (AS_t) model->create();
431 new_as->model_desc = model;
432 new_as->hierarchy = SURF_ROUTING_NULL;
433 new_as->name = xbt_strdup(AS_id);
435 sg_routing_edge_t info = NULL;
436 info = xbt_new0(s_network_element_t, 1);
438 if (current_routing == NULL && routing_platf->root == NULL) {
440 /* it is the first one */
441 new_as->routing_father = NULL;
442 routing_platf->root = new_as;
444 } else if (current_routing != NULL && routing_platf->root != NULL) {
446 xbt_assert(!xbt_dict_get_or_null
447 (current_routing->routing_sons, AS_id),
448 "The AS \"%s\" already exists", AS_id);
449 /* it is a part of the tree */
450 new_as->routing_father = current_routing;
451 /* set the father behavior */
452 if (current_routing->hierarchy == SURF_ROUTING_NULL)
453 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
454 /* add to the sons dictionary */
455 xbt_dict_set(current_routing->routing_sons, AS_id,
456 (void *) new_as, NULL);
457 /* add to the father element list */
458 info->id = current_routing->parse_AS(current_routing, (void *) info);
460 THROWF(arg_error, 0, "All defined components must be belong to a AS");
463 info->rc_component = new_as->routing_father;
464 info->rc_type = SURF_NETWORK_ELEMENT_AS;
465 info->name = new_as->name;
467 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
469 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
471 /* set the new current component of the tree */
472 current_routing = new_as;
473 current_routing->net_elem = info;
478 * \brief Specify that the current description of AS is finished
480 * Once you've declared all the content of your AS, you have to close
481 * it with this call. Your AS is not usable until you call this function.
483 * @fixme: this call is not as robust as wanted: bad things WILL happen
484 * if you call it twice for the same AS, or if you forget calling it, or
485 * even if you add stuff to a closed AS
488 void routing_AS_end()
491 if (current_routing == NULL) {
492 THROWF(arg_error, 0, "Close an AS, but none was under construction");
494 if (current_routing->model_desc->end)
495 current_routing->model_desc->end(current_routing);
496 current_routing = current_routing->routing_father;
500 /* Aux Business methods */
503 * \brief Get the AS father and the first elements of the chain
505 * \param src the source host name
506 * \param dst the destination host name
508 * Get the common father of the to processing units, and the first different
509 * father in the chain
511 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
516 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
517 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
519 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
520 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
528 /* (1) find the as where the src and dst are located */
529 sg_routing_edge_t src_data = src;
530 sg_routing_edge_t dst_data = dst;
531 src_as = src_data->rc_component;
532 dst_as = dst_data->rc_component;
534 char* src_name = src_data->name;
535 char* dst_name = dst_data->name;
538 xbt_assert(src_as && dst_as,
539 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
541 /* (2) find the path to the root routing component */
542 for (current = src_as; current != NULL; current = current->routing_father) {
543 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
544 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
545 path_src[index_src++] = current;
547 for (current = dst_as; current != NULL; current = current->routing_father) {
548 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
549 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
550 path_dst[index_dst++] = current;
553 /* (3) find the common father */
555 current_src = path_src[--index_src];
556 current_dst = path_dst[--index_dst];
557 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
559 /* (4) they are not in the same routing component, make the path */
560 if (current_src == current_dst)
561 father = current_src;
563 father = path_src[index_src + 1];
565 /* (5) result generation */
566 *res_father = father; /* first the common father of src and dst */
567 *res_src = current_src; /* second the first different father of src */
568 *res_dst = current_dst; /* three the first different father of dst */
570 #undef ELEMENTS_FATHER_MAXDEPTH
573 /* Global Business methods */
576 * \brief Recursive function for get_route_latency
578 * \param src the source host name
579 * \param dst the destination host name
580 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
581 * \param *latency the latency, if needed
583 * This function is called by "get_route" and "get_latency". It allows to walk
584 * recursively through the ASes tree.
586 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
587 xbt_dynar_t * links, double *latency)
590 memset(&route,0,sizeof(route));
592 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
593 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
595 /* Find how src and dst are interconnected */
596 AS_t common_father, src_father, dst_father;
597 elements_father(src, dst, &common_father, &src_father, &dst_father);
598 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
599 common_father->name,src_father->name,dst_father->name);
601 /* Check whether a direct bypass is defined */
602 route_t e_route_bypass = NULL;
603 if (common_father->get_bypass_route)
604 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
606 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
607 if (e_route_bypass) {
608 xbt_dynar_merge(links, &e_route_bypass->link_list);
609 generic_free_route(e_route_bypass);
613 /* If src and dst are in the same AS, life is good */
614 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
615 route.link_list = *links;
616 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
617 // if vivaldi latency+=vivaldi(src,dst)
621 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
623 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
624 // Find the net_card corresponding to father
625 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
626 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
628 common_father->get_route_and_latency(common_father,
629 src_father_net_elm, dst_father_net_elm,
632 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
633 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
635 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
636 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
638 /* If source gateway is not our source, we have to recursively find our way up to this point */
639 if (src != src_gateway_net_elm)
640 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
641 xbt_dynar_merge(links, &route.link_list);
643 /* If dest gateway is not our destination, we have to recursively find our way from this point */
644 if (dst_gateway_net_elm != dst)
645 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
647 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
651 * \brief Find a route between hosts
653 * \param src the network_element_t for src host
654 * \param dst the network_element_t for dst host
655 * \param route where to store the list of links.
656 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
657 * \param latency where to store the latency experienced on the path (or NULL if not interested)
658 * It is the caller responsability to initialize latency to 0 (we add to provided route)
661 * walk through the routing components tree and find a route between hosts
662 * by calling the differents "get_route" functions in each routing component.
664 void routing_get_route_and_latency(sg_routing_edge_t src,
665 sg_routing_edge_t dst,
666 xbt_dynar_t * route, double *latency)
668 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
670 xbt_dynar_reset(routing_platf->last_route);
671 *route = routing_platf->last_route;
674 _get_route_and_latency(src, dst, route, latency);
676 xbt_assert(!latency || *latency >= 0.0,
677 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
680 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
682 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
684 //adding my one link routes
685 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
687 xbt_dynar_merge(&ret,&onelink_mine);
691 xbt_dict_cursor_t cursor = NULL;
693 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
694 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
696 xbt_dynar_merge(&ret,&onelink_child);
701 static xbt_dynar_t get_onelink_routes(void)
703 return recursive_get_onelink_routes(routing_platf->root);
706 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
708 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
712 return SURF_NETWORK_ELEMENT_NULL;
716 * \brief Generic method: create the global routing schema
718 * Make a global routing structure and set all the parsing functions.
720 void routing_model_create( void *loopback)
722 /* config the uniq global routing */
723 routing_platf = xbt_new0(s_routing_platf_t, 1);
724 routing_platf->root = NULL;
725 routing_platf->get_onelink_routes = get_onelink_routes;
726 routing_platf->loopback = loopback;
727 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
728 /* no current routing at moment */
729 current_routing = NULL;
733 /* ************************************************** */
734 /* ********** PATERN FOR NEW ROUTING **************** */
736 /* The minimal configuration of a new routing model need the next functions,
737 * also you need to set at the start of the file, the new model in the model
738 * list. Remember keep the null ending of the list.
740 /*** Routing model structure ***/
742 // s_routing_component_t generic_routing;
743 // /* things that your routing model need */
744 // } s_routing_component_NEW_t,*routing_component_NEW_t;
746 /*** Parse routing model functions ***/
747 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
748 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
749 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
750 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
751 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
753 /*** Business methods ***/
754 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
755 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
756 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
758 /*** Creation routing model functions ***/
759 // static void* model_NEW_create(void) {
760 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
761 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
762 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
763 // new_component->generic_routing.set_route = model_NEW_set_route;
764 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
765 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
766 // new_component->generic_routing.get_route = NEW_get_route;
767 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
768 // new_component->generic_routing.finalize = NEW_finalize;
769 // /* initialization of internal structures */
770 // return new_component;
772 // static void model_NEW_load(void) {} /* mandatory */
773 // static void model_NEW_unload(void) {} /* mandatory */
774 // static void model_NEW_end(void) {} /* mandatory */
776 /* ************************************************************************** */
777 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
779 void routing_cluster_add_backbone(void* bb) {
780 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
781 "You have to be in model Cluster to use tag backbone!");
782 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
783 ((as_cluster_t)current_routing)->backbone = bb;
784 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
787 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
789 char *host_id, *groups, *link_id = NULL;
790 xbt_dict_t patterns = NULL;
792 s_sg_platf_host_cbarg_t host;
793 s_sg_platf_link_cbarg_t link;
797 xbt_dynar_t radical_elements;
798 xbt_dynar_t radical_ends;
800 if (strcmp(cluster->availability_trace, "")
801 || strcmp(cluster->state_trace, "")) {
802 patterns = xbt_dict_new_homogeneous(xbt_free_f);
803 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
804 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
805 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
808 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
809 sg_platf_new_AS_begin(cluster->id, A_surfxml_AS_routing_Cluster);
811 current_routing->link_up_down_list
812 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
815 radical_elements = xbt_str_split(cluster->radical, ",");
816 xbt_dynar_foreach(radical_elements, iter, groups) {
818 radical_ends = xbt_str_split(groups, "-");
819 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
821 switch (xbt_dynar_length(radical_ends)) {
826 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
829 surf_parse_error("Malformed radical");
832 for (i = start; i <= end; i++) {
834 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
835 link_id = bprintf("%s_link_%d", cluster->id, i);
837 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
839 memset(&host, 0, sizeof(host));
841 if (strcmp(cluster->availability_trace, "")) {
842 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
843 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
844 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
845 host.power_trace = tmgr_trace_new_from_file(avail_file);
846 xbt_free(avail_file);
848 XBT_DEBUG("\tavailability_file=\"\"");
851 if (strcmp(cluster->state_trace, "")) {
852 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
853 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
854 host.state_trace = tmgr_trace_new_from_file(avail_file);
855 xbt_free(avail_file);
857 XBT_DEBUG("\tstate_file=\"\"");
860 host.power_peak = cluster->power;
861 host.power_scale = 1.0;
862 host.core_amount = cluster->core_amount;
863 host.initial_state = SURF_RESOURCE_ON;
865 sg_platf_new_host(&host);
866 XBT_DEBUG("</host>");
868 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
869 cluster->bw, cluster->lat);
871 memset(&link, 0, sizeof(link));
873 link.bandwidth = cluster->bw;
874 link.latency = cluster->lat;
875 link.state = SURF_RESOURCE_ON;
876 link.policy = cluster->sharing_policy;
877 sg_platf_new_link(&link);
879 s_surf_parsing_link_up_down_t info;
881 if (link.policy == SURF_LINK_FULLDUPLEX) {
882 char *tmp_link = bprintf("%s_UP", link_id);
884 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
886 tmp_link = bprintf("%s_DOWN", link_id);
888 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
891 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
892 info.link_down = info.link_up;
894 xbt_dynar_push(current_routing->link_up_down_list,&info);
899 xbt_dynar_free(&radical_ends);
901 xbt_dynar_free(&radical_elements);
903 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
904 // and it's very useful to connect clusters together
906 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
908 s_sg_platf_router_cbarg_t router;
909 memset(&router, 0, sizeof(router));
910 router.id = cluster->router_id;
912 if (!router.id || !strcmp(router.id, ""))
914 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
916 sg_platf_new_router(&router);
920 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
921 char *link_backbone = bprintf("%s_backbone", cluster->id);
922 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
923 cluster->bb_bw, cluster->bb_lat);
925 memset(&link, 0, sizeof(link));
926 link.id = link_backbone;
927 link.bandwidth = cluster->bb_bw;
928 link.latency = cluster->bb_lat;
929 link.state = SURF_RESOURCE_ON;
930 link.policy = cluster->bb_sharing_policy;
932 sg_platf_new_link(&link);
934 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
940 sg_platf_new_AS_end();
942 xbt_dict_free(&patterns); // no op if it were never set
945 static void routing_parse_postparse(void) {
946 xbt_dict_free(&random_value);
949 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
951 static int AX_ptr = 0;
952 char *host_id = NULL;
953 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
955 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
956 static unsigned int surfxml_buffer_stack_stack[1024];
958 surfxml_buffer_stack_stack[0] = 0;
960 surfxml_bufferstack_push(1);
962 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
963 sg_platf_new_AS_begin(peer->id, A_surfxml_AS_routing_Full);
966 host_id = HOST_PEER(peer->id);
967 router_id = ROUTER_PEER(peer->id);
968 link_id_up = LINK_UP_PEER(peer->id);
969 link_id_down = LINK_DOWN_PEER(peer->id);
971 link_router = bprintf("%s_link_router", peer->id);
972 link_backbone = bprintf("%s_backbone", peer->id);
974 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
975 s_sg_platf_host_cbarg_t host;
976 memset(&host, 0, sizeof(host));
977 host.initial_state = SURF_RESOURCE_ON;
979 host.power_peak = peer->power;
980 host.power_scale = 1.0;
981 host.power_trace = peer->availability_trace;
982 host.state_trace = peer->state_trace;
983 host.core_amount = 1;
984 host.coord = peer->coord;
985 sg_platf_new_host(&host);
988 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
989 s_sg_platf_router_cbarg_t router;
990 memset(&router, 0, sizeof(router));
991 router.id = router_id;
992 router.coord = peer->coord;
993 sg_platf_new_router(&router);
995 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
996 peer->bw_in, peer->lat);
997 s_sg_platf_link_cbarg_t link;
998 memset(&link, 0, sizeof(link));
999 link.state = SURF_RESOURCE_ON;
1000 link.policy = SURF_LINK_SHARED;
1001 link.id = link_id_up;
1002 link.bandwidth = peer->bw_in;
1003 link.latency = peer->lat;
1004 sg_platf_new_link(&link);
1006 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1007 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1008 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1009 peer->bw_out, peer->lat);
1010 link.id = link_id_down;
1011 sg_platf_new_link(&link);
1016 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1017 XBT_DEBUG("symmetrical=\"NO\">");
1018 SURFXML_BUFFER_SET(route_src, host_id);
1019 SURFXML_BUFFER_SET(route_dst, router_id);
1020 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1021 SURFXML_START_TAG(route);
1023 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1024 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1025 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1026 SURFXML_START_TAG(link_ctn);
1027 SURFXML_END_TAG(link_ctn);
1029 XBT_DEBUG("</route>");
1030 SURFXML_END_TAG(route);
1033 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1034 XBT_DEBUG("symmetrical=\"NO\">");
1035 SURFXML_BUFFER_SET(route_src, router_id);
1036 SURFXML_BUFFER_SET(route_dst, host_id);
1037 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1038 SURFXML_START_TAG(route);
1040 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1041 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1042 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1043 SURFXML_START_TAG(link_ctn);
1044 SURFXML_END_TAG(link_ctn);
1046 XBT_DEBUG("</route>");
1047 SURFXML_END_TAG(route);
1050 sg_platf_new_AS_end();
1053 //xbt_dynar_free(&tab_elements_num);
1057 free(link_backbone);
1060 surfxml_bufferstack_pop(1);
1063 static void routing_parse_Srandom(void)
1065 double mean, std, min, max, seed;
1066 char *random_id = A_surfxml_random_id;
1067 char *random_radical = A_surfxml_random_radical;
1068 char *rd_name = NULL;
1070 mean = surf_parse_get_double(A_surfxml_random_mean);
1071 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1072 min = surf_parse_get_double(A_surfxml_random_min);
1073 max = surf_parse_get_double(A_surfxml_random_max);
1074 seed = surf_parse_get_double(A_surfxml_random_seed);
1078 random_data_t random = xbt_new0(s_random_data_t, 1);
1081 xbt_dynar_t radical_elements;
1085 xbt_dynar_t radical_ends;
1087 switch (A_surfxml_random_generator) {
1088 case AU_surfxml_random_generator:
1089 case A_surfxml_random_generator_NONE:
1090 random->generator = NONE;
1092 case A_surfxml_random_generator_DRAND48:
1093 random->generator = DRAND48;
1095 case A_surfxml_random_generator_RAND:
1096 random->generator = RAND;
1098 case A_surfxml_random_generator_RNGSTREAM:
1099 random->generator = RNGSTREAM;
1102 surf_parse_error("Invalid random generator");
1105 random->seed = seed;
1109 /* Check user stupidities */
1111 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1113 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1115 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1117 /* normalize the mean and standard deviation before storing */
1118 random->mean = (mean - min) / (max - min);
1119 random->std = std / (max - min);
1121 if (random->mean * (1 - random->mean) < random->std * random->std)
1122 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1123 random->mean, random->std);
1126 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1127 random_id, random->min, random->max, random->mean, random->std,
1128 (int)random->generator, random->seed, random_radical);
1131 random_value = xbt_dict_new_homogeneous(free);
1133 if (!strcmp(random_radical, "")) {
1134 res = random_generate(random);
1135 rd_value = bprintf("%f", res);
1136 xbt_dict_set(random_value, random_id, rd_value, NULL);
1138 radical_elements = xbt_str_split(random_radical, ",");
1139 xbt_dynar_foreach(radical_elements, iter, groups) {
1140 radical_ends = xbt_str_split(groups, "-");
1141 switch (xbt_dynar_length(radical_ends)) {
1143 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1144 "Custom Random '%s' already exists !", random_id);
1145 res = random_generate(random);
1147 bprintf("%s%d", random_id,
1148 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1149 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1154 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1155 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1156 for (i = start; i <= end; i++) {
1157 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1158 "Custom Random '%s' already exists !", bprintf("%s%d",
1161 res = random_generate(random);
1162 tmpbuf = bprintf("%s%d", random_id, i);
1163 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1168 XBT_CRITICAL("Malformed radical");
1171 res = random_generate(random);
1172 rd_name = bprintf("%s_router", random_id);
1173 rd_value = bprintf("%f", res);
1174 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1176 xbt_dynar_free(&radical_ends);
1179 xbt_dynar_free(&radical_elements);
1183 void routing_register_callbacks()
1185 sg_platf_host_add_cb(parse_S_host);
1186 sg_platf_router_add_cb(parse_S_router);
1187 sg_platf_host_link_add_cb(parse_S_host_link);
1189 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1191 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1192 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1193 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1194 &routing_parse_S_bypassRoute);
1195 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1196 &routing_parse_S_bypassASroute);
1198 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1200 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1201 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1202 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1203 &routing_parse_E_bypassRoute);
1204 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1205 &routing_parse_E_bypassASroute);
1207 sg_platf_cluster_add_cb(routing_parse_cluster);
1209 sg_platf_peer_add_cb(routing_parse_peer);
1210 sg_platf_postparse_add_cb(routing_parse_postparse);
1212 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1213 sg_platf_AS_end_add_cb(routing_AS_end);
1214 sg_platf_AS_begin_add_cb(routing_AS_begin);
1217 instr_routing_define_callbacks();
1222 * \brief Recursive function for finalize
1224 * \param rc the source host name
1226 * This fuction is call by "finalize". It allow to finalize the
1227 * AS or routing components. It delete all the structures.
1229 static void finalize_rec(AS_t as) {
1230 xbt_dict_cursor_t cursor = NULL;
1234 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1241 /** \brief Frees all memory allocated by the routing module */
1242 void routing_exit(void) {
1245 xbt_dynar_free(&routing_platf->last_route);
1246 finalize_rec(routing_platf->root);
1247 xbt_free(routing_platf);