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, const char *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 for (cpt = 0; routing_models[cpt].name; cpt++)
388 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
389 model = &routing_models[cpt];
390 /* if its not exist, error */
392 fprintf(stderr, "Routing model %s not found. Existing models:\n",
393 wanted_routing_type);
394 for (cpt = 0; routing_models[cpt].name; cpt++)
395 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
396 routing_models[cpt].desc);
400 /* make a new routing component */
401 new_as = (AS_t) model->create();
402 new_as->model_desc = model;
403 new_as->hierarchy = SURF_ROUTING_NULL;
404 new_as->name = xbt_strdup(AS_id);
406 sg_routing_edge_t info = NULL;
407 info = xbt_new0(s_network_element_t, 1);
409 if (current_routing == NULL && routing_platf->root == NULL) {
411 /* it is the first one */
412 new_as->routing_father = NULL;
413 routing_platf->root = new_as;
415 } else if (current_routing != NULL && routing_platf->root != NULL) {
417 xbt_assert(!xbt_dict_get_or_null
418 (current_routing->routing_sons, AS_id),
419 "The AS \"%s\" already exists", AS_id);
420 /* it is a part of the tree */
421 new_as->routing_father = current_routing;
422 /* set the father behavior */
423 if (current_routing->hierarchy == SURF_ROUTING_NULL)
424 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
425 /* add to the sons dictionary */
426 xbt_dict_set(current_routing->routing_sons, AS_id,
427 (void *) new_as, NULL);
428 /* add to the father element list */
429 info->id = current_routing->parse_AS(current_routing, (void *) info);
431 THROWF(arg_error, 0, "All defined components must be belong to a AS");
434 info->rc_component = new_as->routing_father;
435 info->rc_type = SURF_NETWORK_ELEMENT_AS;
436 info->name = new_as->name;
438 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
440 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
442 /* set the new current component of the tree */
443 current_routing = new_as;
444 current_routing->net_elem = info;
449 * \brief Specify that the current description of AS is finished
451 * Once you've declared all the content of your AS, you have to close
452 * it with this call. Your AS is not usable until you call this function.
454 * @fixme: this call is not as robust as wanted: bad things WILL happen
455 * if you call it twice for the same AS, or if you forget calling it, or
456 * even if you add stuff to a closed AS
459 void routing_AS_end()
462 if (current_routing == NULL) {
463 THROWF(arg_error, 0, "Close an AS, but none was under construction");
465 if (current_routing->model_desc->end)
466 current_routing->model_desc->end(current_routing);
467 current_routing = current_routing->routing_father;
471 /* Aux Business methods */
474 * \brief Get the AS father and the first elements of the chain
476 * \param src the source host name
477 * \param dst the destination host name
479 * Get the common father of the to processing units, and the first different
480 * father in the chain
482 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
487 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
488 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
490 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
491 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
499 /* (1) find the as where the src and dst are located */
500 sg_routing_edge_t src_data = src;
501 sg_routing_edge_t dst_data = dst;
502 src_as = src_data->rc_component;
503 dst_as = dst_data->rc_component;
505 char* src_name = src_data->name;
506 char* dst_name = dst_data->name;
509 xbt_assert(src_as && dst_as,
510 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
512 /* (2) find the path to the root routing component */
513 for (current = src_as; current != NULL; current = current->routing_father) {
514 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
515 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
516 path_src[index_src++] = current;
518 for (current = dst_as; current != NULL; current = current->routing_father) {
519 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
520 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
521 path_dst[index_dst++] = current;
524 /* (3) find the common father */
526 current_src = path_src[--index_src];
527 current_dst = path_dst[--index_dst];
528 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
530 /* (4) they are not in the same routing component, make the path */
531 if (current_src == current_dst)
532 father = current_src;
534 father = path_src[index_src + 1];
536 /* (5) result generation */
537 *res_father = father; /* first the common father of src and dst */
538 *res_src = current_src; /* second the first different father of src */
539 *res_dst = current_dst; /* three the first different father of dst */
541 #undef ELEMENTS_FATHER_MAXDEPTH
544 /* Global Business methods */
547 * \brief Recursive function for get_route_latency
549 * \param src the source host name
550 * \param dst the destination host name
551 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
552 * \param *latency the latency, if needed
554 * This function is called by "get_route" and "get_latency". It allows to walk
555 * recursively through the ASes tree.
557 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
558 xbt_dynar_t * links, double *latency)
561 memset(&route,0,sizeof(route));
563 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
564 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
566 /* Find how src and dst are interconnected */
567 AS_t common_father, src_father, dst_father;
568 elements_father(src, dst, &common_father, &src_father, &dst_father);
569 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
570 common_father->name,src_father->name,dst_father->name);
572 /* Check whether a direct bypass is defined */
573 route_t e_route_bypass = NULL;
574 if (common_father->get_bypass_route)
575 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
577 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
578 if (e_route_bypass) {
579 xbt_dynar_merge(links,&(e_route_bypass->link_list));
580 generic_free_route(e_route_bypass);
584 /* If src and dst are in the same AS, life is good */
585 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
587 route.link_list = *links;
589 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
593 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
595 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
596 // Find the net_card corresponding to father
597 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
598 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
600 common_father->get_route_and_latency(common_father, src_father_net_elm, dst_father_net_elm, &route,latency);
602 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
603 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
605 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
606 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
608 /* If source gateway is not our source, we have to recursively find our way up to this point */
609 if (src != src_gateway_net_elm)
610 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
612 xbt_dynar_merge(links,&(route.link_list));
614 /* If dest gateway is not our destination, we have to recursively find our way from this point */
615 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
616 if (dst_gateway_net_elm != dst) {
617 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
619 xbt_dynar_free(&route.link_list);
623 * \brief Find a route between hosts
625 * \param src the network_element_t for src host
626 * \param dst the network_element_t for dst host
627 * \param route where to store the list of links.
628 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
629 * \param latency where to store the latency experienced on the path (or NULL if not interested)
630 * It is the caller responsability to initialize latency to 0 (we add to provided route)
633 * walk through the routing components tree and find a route between hosts
634 * by calling the differents "get_route" functions in each routing component.
636 void routing_get_route_and_latency(sg_routing_edge_t src,
637 sg_routing_edge_t dst,
638 xbt_dynar_t * route, double *latency)
640 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
642 xbt_dynar_reset(routing_platf->last_route);
643 *route = routing_platf->last_route;
646 _get_route_and_latency(src, dst, route, latency);
648 xbt_assert(!latency || *latency >= 0.0,
649 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
652 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
654 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
656 //adding my one link routes
657 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
659 xbt_dynar_merge(&ret,&onelink_mine);
663 xbt_dict_cursor_t cursor = NULL;
665 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
666 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
668 xbt_dynar_merge(&ret,&onelink_child);
673 static xbt_dynar_t get_onelink_routes(void)
675 return recursive_get_onelink_routes(routing_platf->root);
678 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
680 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
684 return SURF_NETWORK_ELEMENT_NULL;
688 * \brief Generic method: create the global routing schema
690 * Make a global routing structure and set all the parsing functions.
692 void routing_model_create( void *loopback)
694 /* config the uniq global routing */
695 routing_platf = xbt_new0(s_routing_platf_t, 1);
696 routing_platf->root = NULL;
697 routing_platf->get_onelink_routes = get_onelink_routes;
698 routing_platf->loopback = loopback;
699 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
700 /* no current routing at moment */
701 current_routing = NULL;
705 /* ************************************************** */
706 /* ********** PATERN FOR NEW ROUTING **************** */
708 /* The minimal configuration of a new routing model need the next functions,
709 * also you need to set at the start of the file, the new model in the model
710 * list. Remember keep the null ending of the list.
712 /*** Routing model structure ***/
714 // s_routing_component_t generic_routing;
715 // /* things that your routing model need */
716 // } s_routing_component_NEW_t,*routing_component_NEW_t;
718 /*** Parse routing model functions ***/
719 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
720 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
721 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
722 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
723 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
725 /*** Business methods ***/
726 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
727 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
728 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
730 /*** Creation routing model functions ***/
731 // static void* model_NEW_create(void) {
732 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
733 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
734 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
735 // new_component->generic_routing.set_route = model_NEW_set_route;
736 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
737 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
738 // new_component->generic_routing.get_route = NEW_get_route;
739 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
740 // new_component->generic_routing.finalize = NEW_finalize;
741 // /* initialization of internal structures */
742 // return new_component;
744 // static void model_NEW_load(void) {} /* mandatory */
745 // static void model_NEW_unload(void) {} /* mandatory */
746 // static void model_NEW_end(void) {} /* mandatory */
748 /* ************************************************************************** */
749 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
751 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
753 char *host_id, *groups, *link_id = NULL;
754 xbt_dict_t patterns = NULL;
756 s_sg_platf_host_cbarg_t host;
757 s_sg_platf_link_cbarg_t link;
761 xbt_dynar_t radical_elements;
762 xbt_dynar_t radical_ends;
764 if (strcmp(cluster->availability_trace, "")
765 || strcmp(cluster->state_trace, "")) {
766 patterns = xbt_dict_new_homogeneous(xbt_free_f);
767 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
768 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
769 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
772 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
773 sg_platf_new_AS_begin(cluster->id, "Cluster");
775 current_routing->link_up_down_list
776 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
779 radical_elements = xbt_str_split(cluster->radical, ",");
780 xbt_dynar_foreach(radical_elements, iter, groups) {
782 radical_ends = xbt_str_split(groups, "-");
783 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
785 switch (xbt_dynar_length(radical_ends)) {
790 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
793 surf_parse_error("Malformed radical");
796 for (i = start; i <= end; i++) {
798 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
799 link_id = bprintf("%s_link_%d", cluster->id, i);
801 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
803 memset(&host, 0, sizeof(host));
805 if (strcmp(cluster->availability_trace, "")) {
806 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
807 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
808 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
809 host.power_trace = tmgr_trace_new(avail_file);
810 xbt_free(avail_file);
812 XBT_DEBUG("\tavailability_file=\"\"");
815 if (strcmp(cluster->state_trace, "")) {
816 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
817 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
818 host.state_trace = tmgr_trace_new(avail_file);
819 xbt_free(avail_file);
821 XBT_DEBUG("\tstate_file=\"\"");
824 host.power_peak = cluster->power;
825 host.power_scale = 1.0;
826 host.core_amount = cluster->core_amount;
827 host.initial_state = SURF_RESOURCE_ON;
829 sg_platf_new_host(&host);
830 XBT_DEBUG("</host>");
832 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
833 cluster->bw, cluster->lat);
835 memset(&link, 0, sizeof(link));
837 link.bandwidth = cluster->bw;
838 link.latency = cluster->lat;
839 link.state = SURF_RESOURCE_ON;
840 link.policy = cluster->sharing_policy;
841 sg_platf_new_link(&link);
843 s_surf_parsing_link_up_down_t info;
845 if (link.policy == SURF_LINK_FULLDUPLEX) {
846 char *tmp_link = bprintf("%s_UP", link_id);
848 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
850 tmp_link = bprintf("%s_DOWN", link_id);
852 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
855 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
856 info.link_down = info.link_up;
858 xbt_dynar_push(current_routing->link_up_down_list,&info);
863 xbt_dynar_free(&radical_ends);
865 xbt_dynar_free(&radical_elements);
867 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
868 // and it's very useful to connect clusters together
870 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
872 s_sg_platf_router_cbarg_t router;
873 memset(&router, 0, sizeof(router));
874 router.id = cluster->router_id;
876 if (!router.id || !strcmp(router.id, ""))
878 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
880 sg_platf_new_router(&router);
884 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
885 char *link_backbone = bprintf("%s_backbone", cluster->id);
886 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
887 cluster->bb_bw, cluster->bb_lat);
889 memset(&link, 0, sizeof(link));
890 link.id = link_backbone;
891 link.bandwidth = cluster->bb_bw;
892 link.latency = cluster->bb_lat;
893 link.state = SURF_RESOURCE_ON;
894 link.policy = cluster->bb_sharing_policy;
896 sg_platf_new_link(&link);
898 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
904 sg_platf_new_AS_end();
906 xbt_dict_free(&patterns); // no op if it were never set
909 static void routing_parse_postparse(void) {
910 xbt_dict_free(&random_value);
913 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
915 static int AX_ptr = 0;
916 char *host_id = NULL;
917 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
919 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
920 static unsigned int surfxml_buffer_stack_stack[1024];
922 surfxml_buffer_stack_stack[0] = 0;
924 surfxml_bufferstack_push(1);
926 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
927 sg_platf_new_AS_begin(peer->id, "Full");
930 host_id = HOST_PEER(peer->id);
931 router_id = ROUTER_PEER(peer->id);
932 link_id_up = LINK_UP_PEER(peer->id);
933 link_id_down = LINK_DOWN_PEER(peer->id);
935 link_router = bprintf("%s_link_router", peer->id);
936 link_backbone = bprintf("%s_backbone", peer->id);
938 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
939 s_sg_platf_host_cbarg_t host;
940 memset(&host, 0, sizeof(host));
941 host.initial_state = SURF_RESOURCE_ON;
943 host.power_peak = peer->power;
944 host.power_scale = 1.0;
945 host.power_trace = peer->availability_trace;
946 host.state_trace = peer->state_trace;
947 host.core_amount = 1;
948 host.coord = peer->coord;
949 sg_platf_new_host(&host);
952 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
953 s_sg_platf_router_cbarg_t router;
954 memset(&router, 0, sizeof(router));
955 router.id = router_id;
956 router.coord = peer->coord;
957 sg_platf_new_router(&router);
959 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
960 peer->bw_in, peer->lat);
961 s_sg_platf_link_cbarg_t link;
962 memset(&link, 0, sizeof(link));
963 link.state = SURF_RESOURCE_ON;
964 link.policy = SURF_LINK_SHARED;
965 link.id = link_id_up;
966 link.bandwidth = peer->bw_in;
967 link.latency = peer->lat;
968 sg_platf_new_link(&link);
970 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
971 // Instead, it should be created fullduplex, and the models will do what's needed in this case
972 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
973 peer->bw_out, peer->lat);
974 link.id = link_id_down;
975 sg_platf_new_link(&link);
980 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
981 XBT_DEBUG("symmetrical=\"NO\">");
982 SURFXML_BUFFER_SET(route_src, host_id);
983 SURFXML_BUFFER_SET(route_dst, router_id);
984 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
985 SURFXML_START_TAG(route);
987 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
988 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
989 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
990 SURFXML_START_TAG(link_ctn);
991 SURFXML_END_TAG(link_ctn);
993 XBT_DEBUG("</route>");
994 SURFXML_END_TAG(route);
997 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
998 XBT_DEBUG("symmetrical=\"NO\">");
999 SURFXML_BUFFER_SET(route_src, router_id);
1000 SURFXML_BUFFER_SET(route_dst, host_id);
1001 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1002 SURFXML_START_TAG(route);
1004 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1005 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1006 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1007 SURFXML_START_TAG(link_ctn);
1008 SURFXML_END_TAG(link_ctn);
1010 XBT_DEBUG("</route>");
1011 SURFXML_END_TAG(route);
1014 sg_platf_new_AS_end();
1017 //xbt_dynar_free(&tab_elements_num);
1021 free(link_backbone);
1024 surfxml_bufferstack_pop(1);
1027 static void routing_parse_Srandom(void)
1029 double mean, std, min, max, seed;
1030 char *random_id = A_surfxml_random_id;
1031 char *random_radical = A_surfxml_random_radical;
1032 char *rd_name = NULL;
1034 mean = surf_parse_get_double(A_surfxml_random_mean);
1035 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1036 min = surf_parse_get_double(A_surfxml_random_min);
1037 max = surf_parse_get_double(A_surfxml_random_max);
1038 seed = surf_parse_get_double(A_surfxml_random_seed);
1042 random_data_t random = xbt_new0(s_random_data_t, 1);
1045 xbt_dynar_t radical_elements;
1049 xbt_dynar_t radical_ends;
1051 switch (A_surfxml_random_generator) {
1052 case AU_surfxml_random_generator:
1053 case A_surfxml_random_generator_NONE:
1054 random->generator = NONE;
1056 case A_surfxml_random_generator_DRAND48:
1057 random->generator = DRAND48;
1059 case A_surfxml_random_generator_RAND:
1060 random->generator = RAND;
1062 case A_surfxml_random_generator_RNGSTREAM:
1063 random->generator = RNGSTREAM;
1066 surf_parse_error("Invalid random generator");
1069 random->seed = seed;
1073 /* Check user stupidities */
1075 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1077 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1079 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1081 /* normalize the mean and standard deviation before storing */
1082 random->mean = (mean - min) / (max - min);
1083 random->std = std / (max - min);
1085 if (random->mean * (1 - random->mean) < random->std * random->std)
1086 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1087 random->mean, random->std);
1090 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1091 random_id, random->min, random->max, random->mean, random->std,
1092 (int)random->generator, random->seed, random_radical);
1095 random_value = xbt_dict_new_homogeneous(free);
1097 if (!strcmp(random_radical, "")) {
1098 res = random_generate(random);
1099 rd_value = bprintf("%f", res);
1100 xbt_dict_set(random_value, random_id, rd_value, NULL);
1102 radical_elements = xbt_str_split(random_radical, ",");
1103 xbt_dynar_foreach(radical_elements, iter, groups) {
1104 radical_ends = xbt_str_split(groups, "-");
1105 switch (xbt_dynar_length(radical_ends)) {
1107 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1108 "Custom Random '%s' already exists !", random_id);
1109 res = random_generate(random);
1111 bprintf("%s%d", random_id,
1112 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1113 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1118 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1119 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1120 for (i = start; i <= end; i++) {
1121 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1122 "Custom Random '%s' already exists !", bprintf("%s%d",
1125 res = random_generate(random);
1126 tmpbuf = bprintf("%s%d", random_id, i);
1127 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1132 XBT_CRITICAL("Malformed radical");
1135 res = random_generate(random);
1136 rd_name = bprintf("%s_router", random_id);
1137 rd_value = bprintf("%f", res);
1138 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1140 xbt_dynar_free(&radical_ends);
1143 xbt_dynar_free(&radical_elements);
1147 void routing_register_callbacks()
1149 sg_platf_host_add_cb(parse_S_host);
1150 sg_platf_router_add_cb(parse_S_router);
1152 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1154 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1155 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1156 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1157 &routing_parse_S_bypassRoute);
1158 surfxml_add_callback(STag_surfxml_bypassASroute_cb_list,
1159 &routing_parse_S_bypassASroute);
1161 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1163 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1164 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1165 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1166 &routing_parse_E_bypassRoute);
1167 surfxml_add_callback(ETag_surfxml_bypassASroute_cb_list,
1168 &routing_parse_E_bypassASroute);
1170 sg_platf_cluster_add_cb(routing_parse_cluster);
1172 sg_platf_peer_add_cb(routing_parse_peer);
1173 sg_platf_postparse_add_cb(routing_parse_postparse);
1175 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1176 sg_platf_AS_end_add_cb(routing_AS_end);
1177 sg_platf_AS_begin_add_cb(routing_AS_begin);
1180 instr_routing_define_callbacks();
1185 * \brief Recursive function for finalize
1187 * \param rc the source host name
1189 * This fuction is call by "finalize". It allow to finalize the
1190 * AS or routing components. It delete all the structures.
1192 static void finalize_rec(AS_t as) {
1193 xbt_dict_cursor_t cursor = NULL;
1197 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1204 /** \brief Frees all memory allocated by the routing module */
1205 void routing_exit(void) {
1208 xbt_dynar_free(&routing_platf->last_route);
1209 finalize_rec(routing_platf->root);
1210 xbt_free(routing_platf);