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 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
124 "You have to be in model Cluster to use tag host_link!");
126 s_surf_parsing_link_up_down_t link_up_down;
127 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
128 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
130 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
131 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
133 if(!current_routing->link_up_down_list)
134 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
136 // If dynar is is greater than edge id and if the host_link is already defined
137 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
138 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
139 xbt_die("Host_link for '%s' is already defined!",host->id);
141 XBT_DEBUG("Push Host_link for host '%s' to position %d",info->name,info->id);
142 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
146 * \brief Add a "host" to the network element list
148 static void parse_S_host(sg_platf_host_cbarg_t host)
150 sg_routing_edge_t info = NULL;
151 if (current_routing->hierarchy == SURF_ROUTING_NULL)
152 current_routing->hierarchy = SURF_ROUTING_BASE;
153 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
154 "Reading a host, processing unit \"%s\" already exists", host->id);
156 info = xbt_new0(s_network_element_t, 1);
157 info->rc_component = current_routing;
158 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
159 info->name = xbt_strdup(host->id);
160 info->id = current_routing->parse_PU(current_routing, (void *) info);
161 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
162 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
165 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
169 if (host->coord && strcmp(host->coord, "")) {
173 if (!COORD_HOST_LEVEL)
174 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
175 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
176 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
177 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
178 xbt_dynar_foreach(ctn_str,cursor, str) {
179 double val = atof(str);
180 xbt_dynar_push(ctn,&val);
182 xbt_dynar_shrink(ctn, 0);
183 xbt_dynar_free(&ctn_str);
184 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
185 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
190 * \brief Add a "router" to the network element list
192 static void parse_S_router(sg_platf_router_cbarg_t router)
194 sg_routing_edge_t info = NULL;
195 if (current_routing->hierarchy == SURF_ROUTING_NULL)
196 current_routing->hierarchy = SURF_ROUTING_BASE;
197 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
198 "Reading a router, processing unit \"%s\" already exists",
201 info = xbt_new0(s_network_element_t, 1);
202 info->rc_component = current_routing;
203 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
204 info->name = xbt_strdup(router->id);
205 info->id = current_routing->parse_PU(current_routing, (void *) info);
206 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
207 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
209 if (strcmp(router->coord, "")) {
213 if (!COORD_ASR_LEVEL)
214 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
215 /* Pre-parse the host coordinates */
216 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
217 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
218 xbt_dynar_foreach(ctn_str,cursor, str) {
219 double val = atof(str);
220 xbt_dynar_push(ctn,&val);
222 xbt_dynar_shrink(ctn, 0);
223 xbt_dynar_free(&ctn_str);
224 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
225 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
231 * \brief Set the end points for a route
233 static void routing_parse_S_route(void)
235 src = A_surfxml_route_src;
236 dst = A_surfxml_route_dst;
237 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
238 "Missing end-points while defining route \"%s\"->\"%s\"",
240 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
244 * \brief Set the end points and gateways for a ASroute
246 static void routing_parse_S_ASroute(void)
248 src = A_surfxml_ASroute_src;
249 dst = A_surfxml_ASroute_dst;
250 gw_src = A_surfxml_ASroute_gw_src;
251 gw_dst = A_surfxml_ASroute_gw_dst;
252 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
253 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
254 src, dst,gw_src,gw_dst);
255 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
259 * \brief Set the end points for a bypassRoute
261 static void routing_parse_S_bypassRoute(void)
263 src = A_surfxml_bypassRoute_src;
264 dst = A_surfxml_bypassRoute_dst;
267 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
268 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
269 src, dst,gw_src,gw_dst);
270 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
274 * \brief Set the end points for a bypassASroute
276 static void routing_parse_S_bypassASroute(void)
278 src = A_surfxml_bypassASroute_src;
279 dst = A_surfxml_bypassASroute_dst;
280 gw_src = A_surfxml_bypassASroute_gw_src;
281 gw_dst = A_surfxml_bypassASroute_gw_dst;
282 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
283 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
284 src, dst,gw_src,gw_dst);
285 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
288 * \brief Set a new link on the actual list of link for a route or ASroute from XML
291 static void routing_parse_link_ctn(void)
294 switch (A_surfxml_link_ctn_direction) {
295 case AU_surfxml_link_ctn_direction:
296 case A_surfxml_link_ctn_direction_NONE:
297 link_id = xbt_strdup(A_surfxml_link_ctn_id);
299 case A_surfxml_link_ctn_direction_UP:
300 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
302 case A_surfxml_link_ctn_direction_DOWN:
303 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
306 xbt_dynar_push(parsed_link_list, &link_id);
310 * \brief Store the route by calling the set_route function of the current routing component
312 static void routing_parse_E_route(void)
314 route_t route = xbt_new0(s_route_t, 1);
315 route->link_list = parsed_link_list;
316 xbt_assert(current_routing->parse_route,
317 "no defined method \"set_route\" in \"%s\"",
318 current_routing->name);
319 current_routing->parse_route(current_routing, src, dst, route);
320 generic_free_route(route);
321 parsed_link_list = NULL;
327 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
329 static void routing_parse_E_ASroute(void)
331 route_t e_route = xbt_new0(s_route_t, 1);
332 e_route->link_list = parsed_link_list;
334 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
335 // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
336 // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
338 // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
339 e_route->src_gateway = (sg_routing_edge_t) gw_src;
340 e_route->dst_gateway = (sg_routing_edge_t) gw_dst;
342 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
343 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
345 xbt_assert(current_routing->parse_ASroute,
346 "no defined method \"set_ASroute\" in \"%s\"",
347 current_routing->name);
348 current_routing->parse_ASroute(current_routing, src, dst, e_route);
349 generic_free_route(e_route);
350 parsed_link_list = NULL;
358 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
360 static void routing_parse_E_bypassRoute(void)
362 route_t e_route = xbt_new0(s_route_t, 1);
363 e_route->link_list = parsed_link_list;
365 xbt_assert(current_routing->parse_bypassroute,
366 "Bypassing mechanism not implemented by routing '%s'",
367 current_routing->name);
369 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
370 parsed_link_list = NULL;
377 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
379 static void routing_parse_E_bypassASroute(void)
381 route_t e_route = xbt_new0(s_route_t, 1);
382 e_route->link_list = parsed_link_list;
383 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
384 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
385 xbt_assert(current_routing->parse_bypassroute,
386 "Bypassing mechanism not implemented by routing '%s'",
387 current_routing->name);
388 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
389 parsed_link_list = NULL;
397 * \brief Make a new routing component to the platform
399 * Add a new autonomous system to the platform. Any elements (such as host,
400 * router or sub-AS) added after this call and before the corresponding call
401 * to sg_platf_new_AS_close() will be added to this AS.
403 * Once this function was called, the configuration concerning the used
404 * models cannot be changed anymore.
406 * @param AS_id name of this autonomous system. Must be unique in the platform
407 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
409 void routing_AS_begin(const char *AS_id, int wanted_routing_type)
412 routing_model_description_t model = NULL;
414 xbt_assert(!xbt_lib_get_or_null
415 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
416 "The AS \"%s\" already exists", AS_id);
418 /* search the routing model */
419 switch(wanted_routing_type){
420 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
421 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
422 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
423 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
424 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
425 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
426 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
427 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
430 /* make a new routing component */
431 new_as = (AS_t) model->create();
432 new_as->model_desc = model;
433 new_as->hierarchy = SURF_ROUTING_NULL;
434 new_as->name = xbt_strdup(AS_id);
436 sg_routing_edge_t info = NULL;
437 info = xbt_new0(s_network_element_t, 1);
439 if (current_routing == NULL && routing_platf->root == NULL) {
441 /* it is the first one */
442 new_as->routing_father = NULL;
443 routing_platf->root = new_as;
445 } else if (current_routing != NULL && routing_platf->root != NULL) {
447 xbt_assert(!xbt_dict_get_or_null
448 (current_routing->routing_sons, AS_id),
449 "The AS \"%s\" already exists", AS_id);
450 /* it is a part of the tree */
451 new_as->routing_father = current_routing;
452 /* set the father behavior */
453 if (current_routing->hierarchy == SURF_ROUTING_NULL)
454 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
455 /* add to the sons dictionary */
456 xbt_dict_set(current_routing->routing_sons, AS_id,
457 (void *) new_as, NULL);
458 /* add to the father element list */
459 info->id = current_routing->parse_AS(current_routing, (void *) info);
461 THROWF(arg_error, 0, "All defined components must be belong to a AS");
464 info->rc_component = new_as->routing_father;
465 info->rc_type = SURF_NETWORK_ELEMENT_AS;
466 info->name = new_as->name;
468 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
470 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
472 /* set the new current component of the tree */
473 current_routing = new_as;
474 current_routing->net_elem = info;
479 * \brief Specify that the current description of AS is finished
481 * Once you've declared all the content of your AS, you have to close
482 * it with this call. Your AS is not usable until you call this function.
484 * @fixme: this call is not as robust as wanted: bad things WILL happen
485 * if you call it twice for the same AS, or if you forget calling it, or
486 * even if you add stuff to a closed AS
489 void routing_AS_end()
492 if (current_routing == NULL) {
493 THROWF(arg_error, 0, "Close an AS, but none was under construction");
495 if (current_routing->model_desc->end)
496 current_routing->model_desc->end(current_routing);
497 current_routing = current_routing->routing_father;
501 /* Aux Business methods */
504 * \brief Get the AS father and the first elements of the chain
506 * \param src the source host name
507 * \param dst the destination host name
509 * Get the common father of the to processing units, and the first different
510 * father in the chain
512 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
517 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
518 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
520 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
521 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
529 /* (1) find the as where the src and dst are located */
530 sg_routing_edge_t src_data = src;
531 sg_routing_edge_t dst_data = dst;
532 src_as = src_data->rc_component;
533 dst_as = dst_data->rc_component;
535 char* src_name = src_data->name;
536 char* dst_name = dst_data->name;
539 xbt_assert(src_as && dst_as,
540 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
542 /* (2) find the path to the root routing component */
543 for (current = src_as; current != NULL; current = current->routing_father) {
544 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
545 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
546 path_src[index_src++] = current;
548 for (current = dst_as; current != NULL; current = current->routing_father) {
549 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
550 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
551 path_dst[index_dst++] = current;
554 /* (3) find the common father */
556 current_src = path_src[--index_src];
557 current_dst = path_dst[--index_dst];
558 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
560 /* (4) they are not in the same routing component, make the path */
561 if (current_src == current_dst)
562 father = current_src;
564 father = path_src[index_src + 1];
566 /* (5) result generation */
567 *res_father = father; /* first the common father of src and dst */
568 *res_src = current_src; /* second the first different father of src */
569 *res_dst = current_dst; /* three the first different father of dst */
571 #undef ELEMENTS_FATHER_MAXDEPTH
574 /* Global Business methods */
577 * \brief Recursive function for get_route_latency
579 * \param src the source host name
580 * \param dst the destination host name
581 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
582 * \param *latency the latency, if needed
584 * This function is called by "get_route" and "get_latency". It allows to walk
585 * recursively through the ASes tree.
587 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
588 xbt_dynar_t * links, double *latency)
591 memset(&route,0,sizeof(route));
593 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
594 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
596 /* Find how src and dst are interconnected */
597 AS_t common_father, src_father, dst_father;
598 elements_father(src, dst, &common_father, &src_father, &dst_father);
599 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
600 common_father->name,src_father->name,dst_father->name);
602 /* Check whether a direct bypass is defined */
603 route_t e_route_bypass = NULL;
604 if (common_father->get_bypass_route)
605 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
607 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
608 if (e_route_bypass) {
609 xbt_dynar_merge(links, &e_route_bypass->link_list);
610 generic_free_route(e_route_bypass);
614 /* If src and dst are in the same AS, life is good */
615 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
616 route.link_list = *links;
617 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
618 // if vivaldi latency+=vivaldi(src,dst)
622 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
624 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
625 // Find the net_card corresponding to father
626 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
627 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
629 common_father->get_route_and_latency(common_father,
630 src_father_net_elm, dst_father_net_elm,
633 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
634 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
636 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
637 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
639 /* If source gateway is not our source, we have to recursively find our way up to this point */
640 if (src != src_gateway_net_elm)
641 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
642 xbt_dynar_merge(links, &route.link_list);
644 /* If dest gateway is not our destination, we have to recursively find our way from this point */
645 if (dst_gateway_net_elm != dst)
646 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
648 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
652 * \brief Find a route between hosts
654 * \param src the network_element_t for src host
655 * \param dst the network_element_t for dst host
656 * \param route where to store the list of links.
657 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
658 * \param latency where to store the latency experienced on the path (or NULL if not interested)
659 * It is the caller responsability to initialize latency to 0 (we add to provided route)
662 * walk through the routing components tree and find a route between hosts
663 * by calling the differents "get_route" functions in each routing component.
665 void routing_get_route_and_latency(sg_routing_edge_t src,
666 sg_routing_edge_t dst,
667 xbt_dynar_t * route, double *latency)
669 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
671 xbt_dynar_reset(routing_platf->last_route);
672 *route = routing_platf->last_route;
675 _get_route_and_latency(src, dst, route, latency);
677 xbt_assert(!latency || *latency >= 0.0,
678 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
681 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
683 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
685 //adding my one link routes
686 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
688 xbt_dynar_merge(&ret,&onelink_mine);
692 xbt_dict_cursor_t cursor = NULL;
694 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
695 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
697 xbt_dynar_merge(&ret,&onelink_child);
702 static xbt_dynar_t get_onelink_routes(void)
704 return recursive_get_onelink_routes(routing_platf->root);
707 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
709 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
713 return SURF_NETWORK_ELEMENT_NULL;
717 * \brief Generic method: create the global routing schema
719 * Make a global routing structure and set all the parsing functions.
721 void routing_model_create( void *loopback)
723 /* config the uniq global routing */
724 routing_platf = xbt_new0(s_routing_platf_t, 1);
725 routing_platf->root = NULL;
726 routing_platf->get_onelink_routes = get_onelink_routes;
727 routing_platf->loopback = loopback;
728 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
729 /* no current routing at moment */
730 current_routing = NULL;
734 /* ************************************************** */
735 /* ********** PATERN FOR NEW ROUTING **************** */
737 /* The minimal configuration of a new routing model need the next functions,
738 * also you need to set at the start of the file, the new model in the model
739 * list. Remember keep the null ending of the list.
741 /*** Routing model structure ***/
743 // s_routing_component_t generic_routing;
744 // /* things that your routing model need */
745 // } s_routing_component_NEW_t,*routing_component_NEW_t;
747 /*** Parse routing model functions ***/
748 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
749 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
750 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
751 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
752 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
754 /*** Business methods ***/
755 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
756 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
757 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
759 /*** Creation routing model functions ***/
760 // static void* model_NEW_create(void) {
761 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
762 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
763 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
764 // new_component->generic_routing.set_route = model_NEW_set_route;
765 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
766 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
767 // new_component->generic_routing.get_route = NEW_get_route;
768 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
769 // new_component->generic_routing.finalize = NEW_finalize;
770 // /* initialization of internal structures */
771 // return new_component;
773 // static void model_NEW_load(void) {} /* mandatory */
774 // static void model_NEW_unload(void) {} /* mandatory */
775 // static void model_NEW_end(void) {} /* mandatory */
777 /* ************************************************************************** */
778 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
780 void routing_cluster_add_backbone(void* bb) {
781 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
782 "You have to be in model Cluster to use tag backbone!");
783 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
784 ((as_cluster_t)current_routing)->backbone = bb;
785 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
788 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
791 char *groups , *host_id , *link_id = NULL;
793 xbt_dynar_t radical_elements;
794 xbt_dynar_t radical_ends;
796 XBT_INFO("See cabinet: %s",cabinet->id);
798 radical_elements = xbt_str_split(cabinet->radical, ",");
799 xbt_dynar_foreach(radical_elements, iter, groups) {
801 radical_ends = xbt_str_split(groups, "-");
802 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
804 switch (xbt_dynar_length(radical_ends)) {
809 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
812 surf_parse_error("Malformed radical");
815 s_sg_platf_host_cbarg_t host;
816 memset(&host, 0, sizeof(host));
817 host.initial_state = SURF_RESOURCE_ON;
818 host.power_peak = cabinet->power;
819 host.power_scale = 1.0;
820 host.core_amount = 1;
822 s_sg_platf_link_cbarg_t link;
823 memset(&link, 0, sizeof(link));
824 link.state = SURF_RESOURCE_ON;
825 link.policy = SURF_LINK_FULLDUPLEX;
826 link.latency = cabinet->lat;
827 link.bandwidth = cabinet->bw;
829 s_sg_platf_host_link_cbarg_t host_link;
830 memset(&host_link, 0, sizeof(host_link));
832 for (i = start; i <= end; i++) {
833 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
834 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
837 sg_platf_new_host(&host);
838 sg_platf_new_link(&link);
840 char* link_up = bprintf("%s_UP",link_id);
841 char* link_down = bprintf("%s_DOWN",link_id);
842 host_link.id = host_id;
843 host_link.link_up = link_up;
844 host_link.link_down= link_down;
845 sg_platf_new_host_link(&host_link);
853 xbt_dynar_free(&radical_ends);
855 xbt_dynar_free(&radical_elements);
858 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
860 char *host_id, *groups, *link_id = NULL;
861 xbt_dict_t patterns = NULL;
863 s_sg_platf_host_cbarg_t host;
864 s_sg_platf_link_cbarg_t link;
868 xbt_dynar_t radical_elements;
869 xbt_dynar_t radical_ends;
871 if (strcmp(cluster->availability_trace, "")
872 || strcmp(cluster->state_trace, "")) {
873 patterns = xbt_dict_new_homogeneous(xbt_free_f);
874 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
875 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
876 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
879 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
880 sg_platf_new_AS_begin(cluster->id, A_surfxml_AS_routing_Cluster);
882 current_routing->link_up_down_list
883 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
886 radical_elements = xbt_str_split(cluster->radical, ",");
887 xbt_dynar_foreach(radical_elements, iter, groups) {
889 radical_ends = xbt_str_split(groups, "-");
890 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
892 switch (xbt_dynar_length(radical_ends)) {
897 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
900 surf_parse_error("Malformed radical");
903 for (i = start; i <= end; i++) {
905 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
906 link_id = bprintf("%s_link_%d", cluster->id, i);
908 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
910 memset(&host, 0, sizeof(host));
912 if (strcmp(cluster->availability_trace, "")) {
913 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
914 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
915 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
916 host.power_trace = tmgr_trace_new_from_file(avail_file);
917 xbt_free(avail_file);
919 XBT_DEBUG("\tavailability_file=\"\"");
922 if (strcmp(cluster->state_trace, "")) {
923 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
924 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
925 host.state_trace = tmgr_trace_new_from_file(avail_file);
926 xbt_free(avail_file);
928 XBT_DEBUG("\tstate_file=\"\"");
931 host.power_peak = cluster->power;
932 host.power_scale = 1.0;
933 host.core_amount = cluster->core_amount;
934 host.initial_state = SURF_RESOURCE_ON;
936 sg_platf_new_host(&host);
937 XBT_DEBUG("</host>");
939 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
940 cluster->bw, cluster->lat);
942 memset(&link, 0, sizeof(link));
944 link.bandwidth = cluster->bw;
945 link.latency = cluster->lat;
946 link.state = SURF_RESOURCE_ON;
947 link.policy = cluster->sharing_policy;
948 sg_platf_new_link(&link);
950 s_surf_parsing_link_up_down_t info;
952 if (link.policy == SURF_LINK_FULLDUPLEX) {
953 char *tmp_link = bprintf("%s_UP", link_id);
955 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
957 tmp_link = bprintf("%s_DOWN", link_id);
959 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
962 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
963 info.link_down = info.link_up;
965 xbt_dynar_push(current_routing->link_up_down_list,&info);
970 xbt_dynar_free(&radical_ends);
972 xbt_dynar_free(&radical_elements);
974 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
975 // and it's very useful to connect clusters together
977 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
979 s_sg_platf_router_cbarg_t router;
980 memset(&router, 0, sizeof(router));
981 router.id = cluster->router_id;
983 if (!router.id || !strcmp(router.id, ""))
985 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
987 sg_platf_new_router(&router);
991 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
992 char *link_backbone = bprintf("%s_backbone", cluster->id);
993 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
994 cluster->bb_bw, cluster->bb_lat);
996 memset(&link, 0, sizeof(link));
997 link.id = link_backbone;
998 link.bandwidth = cluster->bb_bw;
999 link.latency = cluster->bb_lat;
1000 link.state = SURF_RESOURCE_ON;
1001 link.policy = cluster->bb_sharing_policy;
1003 sg_platf_new_link(&link);
1005 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
1007 free(link_backbone);
1011 sg_platf_new_AS_end();
1013 xbt_dict_free(&patterns); // no op if it were never set
1016 static void routing_parse_postparse(void) {
1017 xbt_dict_free(&random_value);
1020 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1022 char *host_id = NULL;
1026 host_id = HOST_PEER(peer->id);
1027 link_id = LINK_PEER(peer->id);
1029 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1030 s_sg_platf_host_cbarg_t host;
1031 memset(&host, 0, sizeof(host));
1032 host.initial_state = SURF_RESOURCE_ON;
1034 host.power_peak = peer->power;
1035 host.power_scale = 1.0;
1036 host.power_trace = peer->availability_trace;
1037 host.state_trace = peer->state_trace;
1038 host.core_amount = 1;
1039 host.coord = peer->coord;
1040 sg_platf_new_host(&host);
1042 s_sg_platf_link_cbarg_t link;
1043 memset(&link, 0, sizeof(link));
1044 link.state = SURF_RESOURCE_ON;
1045 link.policy = SURF_LINK_SHARED;
1046 link.latency = peer->lat;
1048 char* link_up = bprintf("%s_UP",link_id);
1049 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1050 peer->bw_out, peer->lat);
1052 link.bandwidth = peer->bw_out;
1053 sg_platf_new_link(&link);
1055 char* link_down = bprintf("%s_DOWN",link_id);
1056 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1057 peer->bw_in, peer->lat);
1058 link.id = link_down;
1059 link.bandwidth = peer->bw_in;
1060 sg_platf_new_link(&link);
1062 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1063 s_sg_platf_host_link_cbarg_t host_link;
1064 memset(&host_link, 0, sizeof(host_link));
1065 host_link.id = host_id;
1066 host_link.link_up = link_up;
1067 host_link.link_down= link_down;
1068 sg_platf_new_host_link(&host_link);
1072 //xbt_dynar_free(&tab_elements_num);
1079 static void routing_parse_Srandom(void)
1081 double mean, std, min, max, seed;
1082 char *random_id = A_surfxml_random_id;
1083 char *random_radical = A_surfxml_random_radical;
1084 char *rd_name = NULL;
1086 mean = surf_parse_get_double(A_surfxml_random_mean);
1087 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1088 min = surf_parse_get_double(A_surfxml_random_min);
1089 max = surf_parse_get_double(A_surfxml_random_max);
1090 seed = surf_parse_get_double(A_surfxml_random_seed);
1094 random_data_t random = xbt_new0(s_random_data_t, 1);
1097 xbt_dynar_t radical_elements;
1101 xbt_dynar_t radical_ends;
1103 switch (A_surfxml_random_generator) {
1104 case AU_surfxml_random_generator:
1105 case A_surfxml_random_generator_NONE:
1106 random->generator = NONE;
1108 case A_surfxml_random_generator_DRAND48:
1109 random->generator = DRAND48;
1111 case A_surfxml_random_generator_RAND:
1112 random->generator = RAND;
1114 case A_surfxml_random_generator_RNGSTREAM:
1115 random->generator = RNGSTREAM;
1118 surf_parse_error("Invalid random generator");
1121 random->seed = seed;
1125 /* Check user stupidities */
1127 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1129 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1131 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1133 /* normalize the mean and standard deviation before storing */
1134 random->mean = (mean - min) / (max - min);
1135 random->std = std / (max - min);
1137 if (random->mean * (1 - random->mean) < random->std * random->std)
1138 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1139 random->mean, random->std);
1142 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1143 random_id, random->min, random->max, random->mean, random->std,
1144 (int)random->generator, random->seed, random_radical);
1147 random_value = xbt_dict_new_homogeneous(free);
1149 if (!strcmp(random_radical, "")) {
1150 res = random_generate(random);
1151 rd_value = bprintf("%f", res);
1152 xbt_dict_set(random_value, random_id, rd_value, NULL);
1154 radical_elements = xbt_str_split(random_radical, ",");
1155 xbt_dynar_foreach(radical_elements, iter, groups) {
1156 radical_ends = xbt_str_split(groups, "-");
1157 switch (xbt_dynar_length(radical_ends)) {
1159 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1160 "Custom Random '%s' already exists !", random_id);
1161 res = random_generate(random);
1163 bprintf("%s%d", random_id,
1164 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1165 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1170 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1171 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1172 for (i = start; i <= end; i++) {
1173 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1174 "Custom Random '%s' already exists !", bprintf("%s%d",
1177 res = random_generate(random);
1178 tmpbuf = bprintf("%s%d", random_id, i);
1179 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1184 XBT_CRITICAL("Malformed radical");
1187 res = random_generate(random);
1188 rd_name = bprintf("%s_router", random_id);
1189 rd_value = bprintf("%f", res);
1190 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1192 xbt_dynar_free(&radical_ends);
1195 xbt_dynar_free(&radical_elements);
1199 void routing_register_callbacks()
1201 sg_platf_host_add_cb(parse_S_host);
1202 sg_platf_router_add_cb(parse_S_router);
1203 sg_platf_host_link_add_cb(parse_S_host_link);
1205 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1207 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1208 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1209 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1210 &routing_parse_S_bypassRoute);
1211 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1212 &routing_parse_S_bypassASroute);
1214 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1216 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1217 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1218 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1219 &routing_parse_E_bypassRoute);
1220 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1221 &routing_parse_E_bypassASroute);
1223 sg_platf_cluster_add_cb(routing_parse_cluster);
1224 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1226 sg_platf_peer_add_cb(routing_parse_peer);
1227 sg_platf_postparse_add_cb(routing_parse_postparse);
1229 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1230 sg_platf_AS_end_add_cb(routing_AS_end);
1231 sg_platf_AS_begin_add_cb(routing_AS_begin);
1234 instr_routing_define_callbacks();
1239 * \brief Recursive function for finalize
1241 * \param rc the source host name
1243 * This fuction is call by "finalize". It allow to finalize the
1244 * AS or routing components. It delete all the structures.
1246 static void finalize_rec(AS_t as) {
1247 xbt_dict_cursor_t cursor = NULL;
1251 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1258 /** \brief Frees all memory allocated by the routing module */
1259 void routing_exit(void) {
1262 xbt_dynar_free(&routing_platf->last_route);
1263 finalize_rec(routing_platf->root);
1264 xbt_free(routing_platf);