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
31 * @ingroup SURF_build_api
32 * @brief A library containing all known links
35 int SD_LINK_LEVEL; //Simdag level
36 int SURF_LINK_LEVEL; //Surf level
37 int NS3_LINK_LEVEL; //link for ns3
39 xbt_lib_t as_router_lib;
40 int ROUTING_ASR_LEVEL; //Routing level
41 int COORD_ASR_LEVEL; //Coordinates level
42 int NS3_ASR_LEVEL; //host node for ns3
44 static xbt_dict_t random_value = NULL;
46 /** @brief Retrieve a routing edge from its name
48 * Routing edges are either CPU/workstation and routers, whatever
50 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
51 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
52 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
57 routing_platf_t routing_platf = NULL;
58 AS_t current_routing = NULL;
60 /* global parse functions */
61 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
62 extern xbt_dynar_t mount_list;
64 static const char *src = NULL; /* temporary store the source name of a route */
65 static const char *dst = NULL; /* temporary store the destination name of a route */
66 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
67 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
69 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
71 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
72 static void routing_parse_Srandom(void); /* random bypass */
74 static void routing_parse_postparse(void);
76 /* this lines are only for replace use like index in the model table */
81 SURF_MODEL_DIJKSTRACACHE,
88 struct s_model_type routing_models[] = {
90 "Full routing data (fast, large memory requirements, fully expressive)",
91 model_full_create, model_full_end},
93 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
94 model_floyd_create, model_floyd_end},
96 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
97 model_dijkstra_create, model_dijkstra_both_end},
99 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
100 model_dijkstracache_create, model_dijkstra_both_end},
101 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
102 model_none_create, NULL},
103 {"RuleBased", "Rule-Based routing data (...)",
104 model_rulebased_create, NULL},
105 {"Vivaldi", "Vivaldi routing",
106 model_vivaldi_create, NULL},
107 {"Cluster", "Cluster routing",
108 model_cluster_create, NULL},
109 {NULL, NULL, NULL, NULL}
113 * \brief Add a "host" to the network element list
115 static void parse_S_host(sg_platf_host_cbarg_t host)
117 sg_routing_edge_t info = NULL;
118 if (current_routing->hierarchy == SURF_ROUTING_NULL)
119 current_routing->hierarchy = SURF_ROUTING_BASE;
120 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
121 "Reading a host, processing unit \"%s\" already exists", host->id);
123 info = xbt_new0(s_network_element_t, 1);
124 info->rc_component = current_routing;
125 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
126 info->name = xbt_strdup(host->id);
127 info->id = current_routing->parse_PU(current_routing, (void *) info);
128 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
129 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
132 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
136 if (host->coord && strcmp(host->coord, "")) {
140 if (!COORD_HOST_LEVEL)
141 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
142 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
143 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
144 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
145 xbt_dynar_foreach(ctn_str,cursor, str) {
146 double val = atof(str);
147 xbt_dynar_push(ctn,&val);
149 xbt_dynar_shrink(ctn, 0);
150 xbt_dynar_free(&ctn_str);
151 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
152 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
157 * \brief Add a "router" to the network element list
159 static void parse_S_router(sg_platf_router_cbarg_t router)
161 sg_routing_edge_t info = NULL;
162 if (current_routing->hierarchy == SURF_ROUTING_NULL)
163 current_routing->hierarchy = SURF_ROUTING_BASE;
164 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
165 "Reading a router, processing unit \"%s\" already exists",
168 info = xbt_new0(s_network_element_t, 1);
169 info->rc_component = current_routing;
170 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
171 info->name = xbt_strdup(router->id);
172 info->id = current_routing->parse_PU(current_routing, (void *) info);
173 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
174 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
176 if (strcmp(router->coord, "")) {
180 if (!COORD_ASR_LEVEL)
181 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
182 /* Pre-parse the host coordinates */
183 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
184 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
185 xbt_dynar_foreach(ctn_str,cursor, str) {
186 double val = atof(str);
187 xbt_dynar_push(ctn,&val);
189 xbt_dynar_shrink(ctn, 0);
190 xbt_dynar_free(&ctn_str);
191 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
192 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
198 * \brief Set the end points for a route
200 static void routing_parse_S_route(void)
202 src = A_surfxml_route_src;
203 dst = A_surfxml_route_dst;
204 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
205 "Missing end-points while defining route \"%s\"->\"%s\"",
207 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
211 * \brief Set the end points and gateways for a ASroute
213 static void routing_parse_S_ASroute(void)
215 src = A_surfxml_ASroute_src;
216 dst = A_surfxml_ASroute_dst;
217 gw_src = A_surfxml_ASroute_gw_src;
218 gw_dst = A_surfxml_ASroute_gw_dst;
219 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
220 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
221 src, dst,gw_src,gw_dst);
222 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
226 * \brief Set the end points for a bypassRoute
228 static void routing_parse_S_bypassRoute(void)
230 src = A_surfxml_bypassRoute_src;
231 dst = A_surfxml_bypassRoute_dst;
234 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
235 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
236 src, dst,gw_src,gw_dst);
237 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
241 * \brief Set the end points for a bypassASroute
243 static void routing_parse_S_bypassASroute(void)
245 src = A_surfxml_bypassASroute_src;
246 dst = A_surfxml_bypassASroute_dst;
247 gw_src = A_surfxml_bypassASroute_gw_src;
248 gw_dst = A_surfxml_bypassASroute_gw_dst;
249 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0 || strlen(gw_dst) > 0,
250 "Missing end-points while defining route \"%s\"->\"%s\" (with %s and %s as gateways)",
251 src, dst,gw_src,gw_dst);
252 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
255 * \brief Set a new link on the actual list of link for a route or ASroute from XML
258 static void routing_parse_link_ctn(void)
261 switch (A_surfxml_link_ctn_direction) {
262 case AU_surfxml_link_ctn_direction:
263 case A_surfxml_link_ctn_direction_NONE:
264 link_id = xbt_strdup(A_surfxml_link_ctn_id);
266 case A_surfxml_link_ctn_direction_UP:
267 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
269 case A_surfxml_link_ctn_direction_DOWN:
270 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
273 xbt_dynar_push(parsed_link_list, &link_id);
277 * \brief Store the route by calling the set_route function of the current routing component
279 static void routing_parse_E_route(void)
281 route_t route = xbt_new0(s_route_t, 1);
282 route->link_list = parsed_link_list;
283 xbt_assert(current_routing->parse_route,
284 "no defined method \"set_route\" in \"%s\"",
285 current_routing->name);
286 current_routing->parse_route(current_routing, src, dst, route);
287 generic_free_route(route);
288 parsed_link_list = NULL;
294 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
296 static void routing_parse_E_ASroute(void)
298 route_t e_route = xbt_new0(s_route_t, 1);
299 e_route->link_list = parsed_link_list;
301 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
302 // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
303 // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
305 // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
306 e_route->src_gateway = (sg_routing_edge_t) gw_src;
307 e_route->dst_gateway = (sg_routing_edge_t) gw_dst;
309 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
310 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
312 xbt_assert(current_routing->parse_ASroute,
313 "no defined method \"set_ASroute\" in \"%s\"",
314 current_routing->name);
315 current_routing->parse_ASroute(current_routing, src, dst, e_route);
316 generic_free_route(e_route);
317 parsed_link_list = NULL;
325 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
327 static void routing_parse_E_bypassRoute(void)
329 route_t e_route = xbt_new0(s_route_t, 1);
330 e_route->link_list = parsed_link_list;
332 xbt_assert(current_routing->parse_bypassroute,
333 "Bypassing mechanism not implemented by routing '%s'",
334 current_routing->name);
336 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
337 parsed_link_list = NULL;
344 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
346 static void routing_parse_E_bypassASroute(void)
348 route_t e_route = xbt_new0(s_route_t, 1);
349 e_route->link_list = parsed_link_list;
350 e_route->src_gateway = sg_routing_edge_by_name_or_null(gw_src);
351 e_route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst);
352 xbt_assert(current_routing->parse_bypassroute,
353 "Bypassing mechanism not implemented by routing '%s'",
354 current_routing->name);
355 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
356 parsed_link_list = NULL;
364 * \brief Make a new routing component to the platform
366 * Add a new autonomous system to the platform. Any elements (such as host,
367 * router or sub-AS) added after this call and before the corresponding call
368 * to sg_platf_new_AS_close() will be added to this AS.
370 * Once this function was called, the configuration concerning the used
371 * models cannot be changed anymore.
373 * @param AS_id name of this autonomous system. Must be unique in the platform
374 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
376 void routing_AS_begin(const char *AS_id, int wanted_routing_type)
379 routing_model_description_t model = NULL;
382 xbt_assert(!xbt_lib_get_or_null
383 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
384 "The AS \"%s\" already exists", AS_id);
386 /* search the routing model */
387 switch(wanted_routing_type){
388 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
389 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
390 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
391 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
392 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
393 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
394 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
395 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
398 /* make a new routing component */
399 new_as = (AS_t) model->create();
400 new_as->model_desc = model;
401 new_as->hierarchy = SURF_ROUTING_NULL;
402 new_as->name = xbt_strdup(AS_id);
404 sg_routing_edge_t info = NULL;
405 info = xbt_new0(s_network_element_t, 1);
407 if (current_routing == NULL && routing_platf->root == NULL) {
409 /* it is the first one */
410 new_as->routing_father = NULL;
411 routing_platf->root = new_as;
413 } else if (current_routing != NULL && routing_platf->root != NULL) {
415 xbt_assert(!xbt_dict_get_or_null
416 (current_routing->routing_sons, AS_id),
417 "The AS \"%s\" already exists", AS_id);
418 /* it is a part of the tree */
419 new_as->routing_father = current_routing;
420 /* set the father behavior */
421 if (current_routing->hierarchy == SURF_ROUTING_NULL)
422 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
423 /* add to the sons dictionary */
424 xbt_dict_set(current_routing->routing_sons, AS_id,
425 (void *) new_as, NULL);
426 /* add to the father element list */
427 info->id = current_routing->parse_AS(current_routing, (void *) info);
429 THROWF(arg_error, 0, "All defined components must be belong to a AS");
432 info->rc_component = new_as->routing_father;
433 info->rc_type = SURF_NETWORK_ELEMENT_AS;
434 info->name = new_as->name;
436 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
438 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
440 /* set the new current component of the tree */
441 current_routing = new_as;
442 current_routing->net_elem = info;
447 * \brief Specify that the current description of AS is finished
449 * Once you've declared all the content of your AS, you have to close
450 * it with this call. Your AS is not usable until you call this function.
452 * @fixme: this call is not as robust as wanted: bad things WILL happen
453 * if you call it twice for the same AS, or if you forget calling it, or
454 * even if you add stuff to a closed AS
457 void routing_AS_end()
460 if (current_routing == NULL) {
461 THROWF(arg_error, 0, "Close an AS, but none was under construction");
463 if (current_routing->model_desc->end)
464 current_routing->model_desc->end(current_routing);
465 current_routing = current_routing->routing_father;
469 /* Aux Business methods */
472 * \brief Get the AS father and the first elements of the chain
474 * \param src the source host name
475 * \param dst the destination host name
477 * Get the common father of the to processing units, and the first different
478 * father in the chain
480 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
485 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
486 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
488 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
489 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
497 /* (1) find the as where the src and dst are located */
498 sg_routing_edge_t src_data = src;
499 sg_routing_edge_t dst_data = dst;
500 src_as = src_data->rc_component;
501 dst_as = dst_data->rc_component;
503 char* src_name = src_data->name;
504 char* dst_name = dst_data->name;
507 xbt_assert(src_as && dst_as,
508 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
510 /* (2) find the path to the root routing component */
511 for (current = src_as; current != NULL; current = current->routing_father) {
512 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
513 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
514 path_src[index_src++] = current;
516 for (current = dst_as; current != NULL; current = current->routing_father) {
517 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
518 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
519 path_dst[index_dst++] = current;
522 /* (3) find the common father */
524 current_src = path_src[--index_src];
525 current_dst = path_dst[--index_dst];
526 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
528 /* (4) they are not in the same routing component, make the path */
529 if (current_src == current_dst)
530 father = current_src;
532 father = path_src[index_src + 1];
534 /* (5) result generation */
535 *res_father = father; /* first the common father of src and dst */
536 *res_src = current_src; /* second the first different father of src */
537 *res_dst = current_dst; /* three the first different father of dst */
539 #undef ELEMENTS_FATHER_MAXDEPTH
542 /* Global Business methods */
545 * \brief Recursive function for get_route_latency
547 * \param src the source host name
548 * \param dst the destination host name
549 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
550 * \param *latency the latency, if needed
552 * This function is called by "get_route" and "get_latency". It allows to walk
553 * recursively through the ASes tree.
555 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
556 xbt_dynar_t * links, double *latency)
559 memset(&route,0,sizeof(route));
561 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
562 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
564 /* Find how src and dst are interconnected */
565 AS_t common_father, src_father, dst_father;
566 elements_father(src, dst, &common_father, &src_father, &dst_father);
567 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
568 common_father->name,src_father->name,dst_father->name);
570 /* Check whether a direct bypass is defined */
571 route_t e_route_bypass = NULL;
572 if (common_father->get_bypass_route)
573 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
575 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
576 if (e_route_bypass) {
577 xbt_dynar_merge(links, &e_route_bypass->link_list);
578 generic_free_route(e_route_bypass);
582 /* If src and dst are in the same AS, life is good */
583 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
584 route.link_list = *links;
585 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
589 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
591 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
592 // Find the net_card corresponding to father
593 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
594 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
596 common_father->get_route_and_latency(common_father,
597 src_father_net_elm, dst_father_net_elm,
600 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
601 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
603 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
604 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
606 /* If source gateway is not our source, we have to recursively find our way up to this point */
607 if (src != src_gateway_net_elm)
608 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
610 xbt_dynar_merge(links, &route.link_list);
612 /* If dest gateway is not our destination, we have to recursively find our way from this point */
613 if (dst_gateway_net_elm != dst)
614 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
618 * \brief Find a route between hosts
620 * \param src the network_element_t for src host
621 * \param dst the network_element_t for dst host
622 * \param route where to store the list of links.
623 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
624 * \param latency where to store the latency experienced on the path (or NULL if not interested)
625 * It is the caller responsability to initialize latency to 0 (we add to provided route)
628 * walk through the routing components tree and find a route between hosts
629 * by calling the differents "get_route" functions in each routing component.
631 void routing_get_route_and_latency(sg_routing_edge_t src,
632 sg_routing_edge_t dst,
633 xbt_dynar_t * route, double *latency)
635 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
637 xbt_dynar_reset(routing_platf->last_route);
638 *route = routing_platf->last_route;
641 _get_route_and_latency(src, dst, route, latency);
643 xbt_assert(!latency || *latency >= 0.0,
644 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
647 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
649 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
651 //adding my one link routes
652 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
654 xbt_dynar_merge(&ret,&onelink_mine);
658 xbt_dict_cursor_t cursor = NULL;
660 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
661 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
663 xbt_dynar_merge(&ret,&onelink_child);
668 static xbt_dynar_t get_onelink_routes(void)
670 return recursive_get_onelink_routes(routing_platf->root);
673 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
675 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
679 return SURF_NETWORK_ELEMENT_NULL;
683 * \brief Generic method: create the global routing schema
685 * Make a global routing structure and set all the parsing functions.
687 void routing_model_create( void *loopback)
689 /* config the uniq global routing */
690 routing_platf = xbt_new0(s_routing_platf_t, 1);
691 routing_platf->root = NULL;
692 routing_platf->get_onelink_routes = get_onelink_routes;
693 routing_platf->loopback = loopback;
694 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
695 /* no current routing at moment */
696 current_routing = NULL;
700 /* ************************************************** */
701 /* ********** PATERN FOR NEW ROUTING **************** */
703 /* The minimal configuration of a new routing model need the next functions,
704 * also you need to set at the start of the file, the new model in the model
705 * list. Remember keep the null ending of the list.
707 /*** Routing model structure ***/
709 // s_routing_component_t generic_routing;
710 // /* things that your routing model need */
711 // } s_routing_component_NEW_t,*routing_component_NEW_t;
713 /*** Parse routing model functions ***/
714 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
715 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
716 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
717 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
718 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
720 /*** Business methods ***/
721 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
722 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
723 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
725 /*** Creation routing model functions ***/
726 // static void* model_NEW_create(void) {
727 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
728 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
729 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
730 // new_component->generic_routing.set_route = model_NEW_set_route;
731 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
732 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
733 // new_component->generic_routing.get_route = NEW_get_route;
734 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
735 // new_component->generic_routing.finalize = NEW_finalize;
736 // /* initialization of internal structures */
737 // return new_component;
739 // static void model_NEW_load(void) {} /* mandatory */
740 // static void model_NEW_unload(void) {} /* mandatory */
741 // static void model_NEW_end(void) {} /* mandatory */
743 /* ************************************************************************** */
744 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
746 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
748 char *host_id, *groups, *link_id = NULL;
749 xbt_dict_t patterns = NULL;
751 s_sg_platf_host_cbarg_t host;
752 s_sg_platf_link_cbarg_t link;
756 xbt_dynar_t radical_elements;
757 xbt_dynar_t radical_ends;
759 if (strcmp(cluster->availability_trace, "")
760 || strcmp(cluster->state_trace, "")) {
761 patterns = xbt_dict_new_homogeneous(xbt_free_f);
762 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
763 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
764 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
767 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
768 sg_platf_new_AS_begin(cluster->id, A_surfxml_AS_routing_Cluster);
770 current_routing->link_up_down_list
771 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
774 radical_elements = xbt_str_split(cluster->radical, ",");
775 xbt_dynar_foreach(radical_elements, iter, groups) {
777 radical_ends = xbt_str_split(groups, "-");
778 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
780 switch (xbt_dynar_length(radical_ends)) {
785 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
788 surf_parse_error("Malformed radical");
791 for (i = start; i <= end; i++) {
793 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
794 link_id = bprintf("%s_link_%d", cluster->id, i);
796 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
798 memset(&host, 0, sizeof(host));
800 if (strcmp(cluster->availability_trace, "")) {
801 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
802 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
803 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
804 host.power_trace = tmgr_trace_new_from_file(avail_file);
805 xbt_free(avail_file);
807 XBT_DEBUG("\tavailability_file=\"\"");
810 if (strcmp(cluster->state_trace, "")) {
811 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
812 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
813 host.state_trace = tmgr_trace_new_from_file(avail_file);
814 xbt_free(avail_file);
816 XBT_DEBUG("\tstate_file=\"\"");
819 host.power_peak = cluster->power;
820 host.power_scale = 1.0;
821 host.core_amount = cluster->core_amount;
822 host.initial_state = SURF_RESOURCE_ON;
824 sg_platf_new_host(&host);
825 XBT_DEBUG("</host>");
827 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
828 cluster->bw, cluster->lat);
830 memset(&link, 0, sizeof(link));
832 link.bandwidth = cluster->bw;
833 link.latency = cluster->lat;
834 link.state = SURF_RESOURCE_ON;
835 link.policy = cluster->sharing_policy;
836 sg_platf_new_link(&link);
838 s_surf_parsing_link_up_down_t info;
840 if (link.policy == SURF_LINK_FULLDUPLEX) {
841 char *tmp_link = bprintf("%s_UP", link_id);
843 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
845 tmp_link = bprintf("%s_DOWN", link_id);
847 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
850 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
851 info.link_down = info.link_up;
853 xbt_dynar_push(current_routing->link_up_down_list,&info);
858 xbt_dynar_free(&radical_ends);
860 xbt_dynar_free(&radical_elements);
862 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
863 // and it's very useful to connect clusters together
865 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
867 s_sg_platf_router_cbarg_t router;
868 memset(&router, 0, sizeof(router));
869 router.id = cluster->router_id;
871 if (!router.id || !strcmp(router.id, ""))
873 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
875 sg_platf_new_router(&router);
879 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
880 char *link_backbone = bprintf("%s_backbone", cluster->id);
881 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
882 cluster->bb_bw, cluster->bb_lat);
884 memset(&link, 0, sizeof(link));
885 link.id = link_backbone;
886 link.bandwidth = cluster->bb_bw;
887 link.latency = cluster->bb_lat;
888 link.state = SURF_RESOURCE_ON;
889 link.policy = cluster->bb_sharing_policy;
891 sg_platf_new_link(&link);
893 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
899 sg_platf_new_AS_end();
901 xbt_dict_free(&patterns); // no op if it were never set
904 static void routing_parse_postparse(void) {
905 xbt_dict_free(&random_value);
908 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
910 static int AX_ptr = 0;
911 char *host_id = NULL;
912 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
914 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
915 static unsigned int surfxml_buffer_stack_stack[1024];
917 surfxml_buffer_stack_stack[0] = 0;
919 surfxml_bufferstack_push(1);
921 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
922 sg_platf_new_AS_begin(peer->id, A_surfxml_AS_routing_Full);
925 host_id = HOST_PEER(peer->id);
926 router_id = ROUTER_PEER(peer->id);
927 link_id_up = LINK_UP_PEER(peer->id);
928 link_id_down = LINK_DOWN_PEER(peer->id);
930 link_router = bprintf("%s_link_router", peer->id);
931 link_backbone = bprintf("%s_backbone", peer->id);
933 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
934 s_sg_platf_host_cbarg_t host;
935 memset(&host, 0, sizeof(host));
936 host.initial_state = SURF_RESOURCE_ON;
938 host.power_peak = peer->power;
939 host.power_scale = 1.0;
940 host.power_trace = peer->availability_trace;
941 host.state_trace = peer->state_trace;
942 host.core_amount = 1;
943 host.coord = peer->coord;
944 sg_platf_new_host(&host);
947 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
948 s_sg_platf_router_cbarg_t router;
949 memset(&router, 0, sizeof(router));
950 router.id = router_id;
951 router.coord = peer->coord;
952 sg_platf_new_router(&router);
954 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
955 peer->bw_in, peer->lat);
956 s_sg_platf_link_cbarg_t link;
957 memset(&link, 0, sizeof(link));
958 link.state = SURF_RESOURCE_ON;
959 link.policy = SURF_LINK_SHARED;
960 link.id = link_id_up;
961 link.bandwidth = peer->bw_in;
962 link.latency = peer->lat;
963 sg_platf_new_link(&link);
965 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
966 // Instead, it should be created fullduplex, and the models will do what's needed in this case
967 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
968 peer->bw_out, peer->lat);
969 link.id = link_id_down;
970 sg_platf_new_link(&link);
975 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
976 XBT_DEBUG("symmetrical=\"NO\">");
977 SURFXML_BUFFER_SET(route_src, host_id);
978 SURFXML_BUFFER_SET(route_dst, router_id);
979 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
980 SURFXML_START_TAG(route);
982 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
983 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
984 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
985 SURFXML_START_TAG(link_ctn);
986 SURFXML_END_TAG(link_ctn);
988 XBT_DEBUG("</route>");
989 SURFXML_END_TAG(route);
992 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
993 XBT_DEBUG("symmetrical=\"NO\">");
994 SURFXML_BUFFER_SET(route_src, router_id);
995 SURFXML_BUFFER_SET(route_dst, host_id);
996 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
997 SURFXML_START_TAG(route);
999 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1000 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1001 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1002 SURFXML_START_TAG(link_ctn);
1003 SURFXML_END_TAG(link_ctn);
1005 XBT_DEBUG("</route>");
1006 SURFXML_END_TAG(route);
1009 sg_platf_new_AS_end();
1012 //xbt_dynar_free(&tab_elements_num);
1016 free(link_backbone);
1019 surfxml_bufferstack_pop(1);
1022 static void routing_parse_Srandom(void)
1024 double mean, std, min, max, seed;
1025 char *random_id = A_surfxml_random_id;
1026 char *random_radical = A_surfxml_random_radical;
1027 char *rd_name = NULL;
1029 mean = surf_parse_get_double(A_surfxml_random_mean);
1030 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1031 min = surf_parse_get_double(A_surfxml_random_min);
1032 max = surf_parse_get_double(A_surfxml_random_max);
1033 seed = surf_parse_get_double(A_surfxml_random_seed);
1037 random_data_t random = xbt_new0(s_random_data_t, 1);
1040 xbt_dynar_t radical_elements;
1044 xbt_dynar_t radical_ends;
1046 switch (A_surfxml_random_generator) {
1047 case AU_surfxml_random_generator:
1048 case A_surfxml_random_generator_NONE:
1049 random->generator = NONE;
1051 case A_surfxml_random_generator_DRAND48:
1052 random->generator = DRAND48;
1054 case A_surfxml_random_generator_RAND:
1055 random->generator = RAND;
1057 case A_surfxml_random_generator_RNGSTREAM:
1058 random->generator = RNGSTREAM;
1061 surf_parse_error("Invalid random generator");
1064 random->seed = seed;
1068 /* Check user stupidities */
1070 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1072 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1074 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1076 /* normalize the mean and standard deviation before storing */
1077 random->mean = (mean - min) / (max - min);
1078 random->std = std / (max - min);
1080 if (random->mean * (1 - random->mean) < random->std * random->std)
1081 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1082 random->mean, random->std);
1085 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1086 random_id, random->min, random->max, random->mean, random->std,
1087 (int)random->generator, random->seed, random_radical);
1090 random_value = xbt_dict_new_homogeneous(free);
1092 if (!strcmp(random_radical, "")) {
1093 res = random_generate(random);
1094 rd_value = bprintf("%f", res);
1095 xbt_dict_set(random_value, random_id, rd_value, NULL);
1097 radical_elements = xbt_str_split(random_radical, ",");
1098 xbt_dynar_foreach(radical_elements, iter, groups) {
1099 radical_ends = xbt_str_split(groups, "-");
1100 switch (xbt_dynar_length(radical_ends)) {
1102 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1103 "Custom Random '%s' already exists !", random_id);
1104 res = random_generate(random);
1106 bprintf("%s%d", random_id,
1107 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1108 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1113 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1114 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1115 for (i = start; i <= end; i++) {
1116 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1117 "Custom Random '%s' already exists !", bprintf("%s%d",
1120 res = random_generate(random);
1121 tmpbuf = bprintf("%s%d", random_id, i);
1122 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1127 XBT_CRITICAL("Malformed radical");
1130 res = random_generate(random);
1131 rd_name = bprintf("%s_router", random_id);
1132 rd_value = bprintf("%f", res);
1133 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1135 xbt_dynar_free(&radical_ends);
1138 xbt_dynar_free(&radical_elements);
1142 void routing_register_callbacks()
1144 sg_platf_host_add_cb(parse_S_host);
1145 sg_platf_router_add_cb(parse_S_router);
1147 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1149 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1150 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1151 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1152 &routing_parse_S_bypassRoute);
1153 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1154 &routing_parse_S_bypassASroute);
1156 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1158 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1159 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1160 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1161 &routing_parse_E_bypassRoute);
1162 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1163 &routing_parse_E_bypassASroute);
1165 sg_platf_cluster_add_cb(routing_parse_cluster);
1167 sg_platf_peer_add_cb(routing_parse_peer);
1168 sg_platf_postparse_add_cb(routing_parse_postparse);
1170 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1171 sg_platf_AS_end_add_cb(routing_AS_end);
1172 sg_platf_AS_begin_add_cb(routing_AS_begin);
1175 instr_routing_define_callbacks();
1180 * \brief Recursive function for finalize
1182 * \param rc the source host name
1184 * This fuction is call by "finalize". It allow to finalize the
1185 * AS or routing components. It delete all the structures.
1187 static void finalize_rec(AS_t as) {
1188 xbt_dict_cursor_t cursor = NULL;
1192 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1199 /** \brief Frees all memory allocated by the routing module */
1200 void routing_exit(void) {
1203 xbt_dynar_free(&routing_platf->last_route);
1204 finalize_rec(routing_platf->root);
1205 xbt_free(routing_platf);