1 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include <pcre.h> /* regular expression library */
9 #include "simgrid/platf_interface.h" // platform creation API internal interface
11 #include "surf_routing_private.h"
12 #include "surf/surf_routing.h"
13 #include "surf/surfxml_parse_values.h"
16 int ROUTING_HOST_LEVEL; //Routing level
17 int SURF_CPU_LEVEL; //Surf cpu level
18 int SURF_WKS_LEVEL; //Surf workstation level
19 int SIMIX_HOST_LEVEL; //Simix level
20 int MSG_HOST_LEVEL; //Msg level
21 int SD_HOST_LEVEL; //Simdag level
22 int COORD_HOST_LEVEL=0; //Coordinates level
23 int NS3_HOST_LEVEL; //host node for ns3
26 int SD_LINK_LEVEL; //Simdag level
27 int SURF_LINK_LEVEL; //Surf level
28 int NS3_LINK_LEVEL; //link for ns3
30 xbt_lib_t as_router_lib;
31 int ROUTING_ASR_LEVEL; //Routing level
32 int COORD_ASR_LEVEL; //Coordinates level
33 int NS3_ASR_LEVEL; //host node for ns3
35 static xbt_dict_t random_value = NULL;
37 xbt_lib_t storage_lib;
38 int ROUTING_STORAGE_LEVEL; //Routing level
39 int SURF_STORAGE_LEVEL; //Surf level
42 routing_global_t global_routing = NULL;
43 AS_t current_routing = NULL;
45 /* global parse functions */
46 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
47 static const char *src = NULL; /* temporary store the source name of a route */
48 static const char *dst = NULL; /* temporary store the destination name of a route */
49 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
50 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
52 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
54 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
55 static void routing_parse_Srandom(void); /* random bypass */
57 static void routing_parse_postparse(void);
59 /* this lines are only for replace use like index in the model table */
64 SURF_MODEL_DIJKSTRACACHE,
71 struct s_model_type routing_models[] = {
73 "Full routing data (fast, large memory requirements, fully expressive)",
74 model_full_create, model_full_end},
76 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
77 model_floyd_create, model_floyd_end},
79 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
80 model_dijkstra_create, model_dijkstra_both_end},
82 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
83 model_dijkstracache_create, model_dijkstra_both_end},
84 {"none", "No routing (usable with Constant network only)",
85 model_none_create, NULL},
86 {"RuleBased", "Rule-Based routing data (...)",
87 model_rulebased_create, NULL},
88 {"Vivaldi", "Vivaldi routing",
89 model_vivaldi_create, NULL},
90 {"Cluster", "Cluster routing",
91 model_cluster_create, NULL},
92 {NULL, NULL, NULL, NULL}
96 * \brief Add a "host" to the network element list
98 static void parse_S_host(sg_platf_host_cbarg_t host)
100 network_element_info_t info = NULL;
101 if (current_routing->hierarchy == SURF_ROUTING_NULL)
102 current_routing->hierarchy = SURF_ROUTING_BASE;
103 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
104 "Reading a host, processing unit \"%s\" already exists", host->id);
106 current_routing->parse_PU(current_routing, host->id);
107 info = xbt_new0(s_network_element_info_t, 1);
108 info->rc_component = current_routing;
109 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
110 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
111 if (host->coord && strcmp(host->coord, "")) {
115 if (!COORD_HOST_LEVEL)
116 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
118 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
119 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
120 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
121 xbt_dynar_foreach(ctn_str,cursor, str) {
122 double val = atof(str);
123 xbt_dynar_push(ctn,&val);
125 xbt_dynar_shrink(ctn, 0);
126 xbt_dynar_free(&ctn_str);
127 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
132 * \brief Add a "router" to the network element list
134 static void parse_S_router(sg_platf_router_cbarg_t router)
136 network_element_info_t info = NULL;
137 if (current_routing->hierarchy == SURF_ROUTING_NULL)
138 current_routing->hierarchy = SURF_ROUTING_BASE;
139 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
140 "Reading a router, processing unit \"%s\" already exists",
143 current_routing->parse_PU(current_routing, router->id);
144 info = xbt_new0(s_network_element_info_t, 1);
145 info->rc_component = current_routing;
146 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
148 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
149 if (strcmp(router->coord, "")) {
153 if (!COORD_ASR_LEVEL)
154 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
156 /* Pre-parse the host coordinates */
157 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
158 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
159 xbt_dynar_foreach(ctn_str,cursor, str) {
160 double val = atof(str);
161 xbt_dynar_push(ctn,&val);
163 xbt_dynar_shrink(ctn, 0);
164 xbt_dynar_free(&ctn_str);
165 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
171 * \brief Set the end points for a route
173 static void routing_parse_S_route(void)
175 if (src != NULL && dst != NULL && parsed_link_list != NULL)
176 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
177 A_surfxml_route_src, A_surfxml_route_dst);
178 src = A_surfxml_route_src;
179 dst = A_surfxml_route_dst;
180 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
181 "Some limits are null in the route between \"%s\" and \"%s\"",
183 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
187 * \brief Set the end points and gateways for a ASroute
189 static void routing_parse_S_ASroute(void)
191 if (src != NULL && dst != NULL && parsed_link_list != NULL)
192 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
193 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
194 src = A_surfxml_ASroute_src;
195 dst = A_surfxml_ASroute_dst;
196 gw_src = A_surfxml_ASroute_gw_src;
197 gw_dst = A_surfxml_ASroute_gw_dst;
198 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
199 || strlen(gw_dst) > 0,
200 "Some limits are null in the route between \"%s\" and \"%s\"",
202 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
206 * \brief Set the end points for a bypassRoute
208 static void routing_parse_S_bypassRoute(void)
210 if (src != NULL && dst != NULL && parsed_link_list != NULL)
212 "Bypass Route between %s to %s can not be defined",
213 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
214 src = A_surfxml_bypassRoute_src;
215 dst = A_surfxml_bypassRoute_dst;
216 gw_src = A_surfxml_bypassRoute_gw_src;
217 gw_dst = A_surfxml_bypassRoute_gw_dst;
218 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
219 || strlen(gw_dst) > 0,
220 "Some limits are null in the route between \"%s\" and \"%s\"",
222 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
226 * \brief Set a new link on the actual list of link for a route or ASroute from XML
229 static void routing_parse_link_ctn(void)
232 switch (A_surfxml_link_ctn_direction) {
233 case AU_surfxml_link_ctn_direction:
234 case A_surfxml_link_ctn_direction_NONE:
235 link_id = xbt_strdup(A_surfxml_link_ctn_id);
237 case A_surfxml_link_ctn_direction_UP:
238 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
240 case A_surfxml_link_ctn_direction_DOWN:
241 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
244 xbt_dynar_push(parsed_link_list, &link_id);
248 * \brief Store the route by calling the set_route function of the current routing component
250 static void routing_parse_E_route(void)
252 route_t route = xbt_new0(s_route_t, 1);
253 route->link_list = parsed_link_list;
254 xbt_assert(current_routing->parse_route,
255 "no defined method \"set_route\" in \"%s\"",
256 current_routing->name);
257 current_routing->parse_route(current_routing, src, dst, route);
258 generic_free_route(route);
259 parsed_link_list = NULL;
265 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
267 static void routing_parse_E_ASroute(void)
269 route_t e_route = xbt_new0(s_route_t, 1);
270 e_route->link_list = parsed_link_list;
271 e_route->src_gateway = xbt_strdup(gw_src);
272 e_route->dst_gateway = xbt_strdup(gw_dst);
273 xbt_assert(current_routing->parse_ASroute,
274 "no defined method \"set_ASroute\" in \"%s\"",
275 current_routing->name);
276 current_routing->parse_ASroute(current_routing, src, dst, e_route);
277 generic_free_route(e_route);
278 parsed_link_list = NULL;
286 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
288 static void routing_parse_E_bypassRoute(void)
290 route_t e_route = xbt_new0(s_route_t, 1);
291 e_route->link_list = parsed_link_list;
292 e_route->src_gateway = xbt_strdup(gw_src);
293 e_route->dst_gateway = xbt_strdup(gw_dst);
294 xbt_assert(current_routing->parse_bypassroute,
295 "Bypassing mechanism not implemented by routing '%s'",
296 current_routing->name);
297 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
298 parsed_link_list = NULL;
306 * \brief Make a new routing component to the platform
308 * Add a new autonomous system to the platform. Any elements (such as host,
309 * router or sub-AS) added after this call and before the corresponding call
310 * to sg_platf_new_AS_close() will be added to this AS.
312 * Once this function was called, the configuration concerning the used
313 * models cannot be changed anymore.
315 * @param AS_id name of this autonomous system. Must be unique in the platform
316 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
318 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
321 routing_model_description_t model = NULL;
324 /* search the routing model */
325 for (cpt = 0; routing_models[cpt].name; cpt++)
326 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
327 model = &routing_models[cpt];
328 /* if its not exist, error */
330 fprintf(stderr, "Routing model %s not found. Existing models:\n",
331 wanted_routing_type);
332 for (cpt = 0; routing_models[cpt].name; cpt++)
333 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
334 routing_models[cpt].desc);
338 /* make a new routing component */
339 new_as = (AS_t) model->create();
340 new_as->model_desc = model;
341 new_as->hierarchy = SURF_ROUTING_NULL;
342 new_as->name = xbt_strdup(AS_id);
344 if (current_routing == NULL && global_routing->root == NULL) {
346 /* it is the first one */
347 new_as->routing_father = NULL;
348 global_routing->root = new_as;
350 } else if (current_routing != NULL && global_routing->root != NULL) {
352 xbt_assert(!xbt_dict_get_or_null
353 (current_routing->routing_sons, AS_id),
354 "The AS \"%s\" already exists", AS_id);
355 /* it is a part of the tree */
356 new_as->routing_father = current_routing;
357 /* set the father behavior */
358 if (current_routing->hierarchy == SURF_ROUTING_NULL)
359 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
360 /* add to the sons dictionary */
361 xbt_dict_set(current_routing->routing_sons, AS_id,
362 (void *) new_as, NULL);
363 /* add to the father element list */
364 current_routing->parse_AS(current_routing, AS_id);
366 THROWF(arg_error, 0, "All defined components must be belong to a AS");
368 /* set the new current component of the tree */
369 current_routing = new_as;
373 * \brief Specify that the current description of AS is finished
375 * Once you've declared all the content of your AS, you have to close
376 * it with this call. Your AS is not usable until you call this function.
378 * @fixme: this call is not as robust as wanted: bad things WILL happen
379 * if you call it twice for the same AS, or if you forget calling it, or
380 * even if you add stuff to a closed AS
383 void routing_AS_end()
386 if (current_routing == NULL) {
387 THROWF(arg_error, 0, "Close an AS, but none was under construction");
389 network_element_info_t info = NULL;
390 xbt_assert(!xbt_lib_get_or_null
391 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
392 "The AS \"%s\" already exists", current_routing->name);
393 info = xbt_new0(s_network_element_info_t, 1);
394 info->rc_component = current_routing->routing_father;
395 info->rc_type = SURF_NETWORK_ELEMENT_AS;
396 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
399 if (current_routing->model_desc->end)
400 current_routing->model_desc->end(current_routing);
401 current_routing = current_routing->routing_father;
405 /* Aux Business methods */
408 * \brief Get the AS father and the first elements of the chain
410 * \param src the source host name
411 * \param dst the destination host name
413 * Get the common father of the to processing units, and the first different
414 * father in the chain
416 static void elements_father(const char *src, const char *dst,
421 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
422 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
424 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
425 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
433 /* (1) find the as where the src and dst are located */
434 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
436 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
439 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
441 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
442 src_as = src_data->rc_component;
443 dst_as = dst_data->rc_component;
445 xbt_assert(src_as && dst_as,
446 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
448 /* (2) find the path to the root routing component */
449 for (current = src_as; current != NULL; current = current->routing_father) {
450 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
451 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
452 path_src[index_src++] = current;
454 for (current = dst_as; current != NULL; current = current->routing_father) {
455 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
456 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
457 path_dst[index_dst++] = current;
460 /* (3) find the common father */
462 current_src = path_src[--index_src];
463 current_dst = path_dst[--index_dst];
464 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
466 /* (4) they are not in the same routing component, make the path */
467 if (current_src == current_dst)
468 father = current_src;
470 father = path_src[index_src + 1];
472 /* (5) result generation */
473 *res_father = father; /* first the common father of src and dst */
474 *res_src = current_src; /* second the first different father of src */
475 *res_dst = current_dst; /* three the first different father of dst */
477 #undef ELEMENTS_FATHER_MAXDEPTH
480 /* Global Business methods */
483 * \brief Recursive function for get_route_latency
485 * \param src the source host name
486 * \param dst the destination host name
487 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
488 * \param *latency the latency, if needed
490 * This function is called by "get_route" and "get_latency". It allows to walk
491 * recursively through the ASes tree.
493 static void _get_route_and_latency(const char *src, const char *dst,
494 xbt_dynar_t * links, double *latency)
499 memset(&route,0,sizeof(route));
501 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
502 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
504 /* Find how src and dst are interconnected */
505 AS_t common_father, src_father, dst_father;
506 elements_father(src, dst, &common_father, &src_father, &dst_father);
508 /* If src and dst are in the same AS, life is good */
509 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
511 route.link_list = *links;
513 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
515 xbt_free(route.src_gateway);
516 xbt_free(route.dst_gateway);
520 /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
522 route_t e_route_bypass = NULL;
523 if (common_father->get_bypass_route)
524 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
526 if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
528 xbt_die("Bypass cannot work yet with get_latency"); // FIXME: get_bypass_route should update the latency itself, just like get_route
530 // // FIXME this path is never tested. I need examples to check the bypass mechanism...
531 // THROW_UNIMPLEMENTED; // let's warn the users of the problem
532 xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
533 xbt_dynar_push(*links, &link);
536 generic_free_route(e_route_bypass);
541 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
543 route.link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
544 common_father->get_route_and_latency(common_father, src_father->name, dst_father->name, &route,latency);
546 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
547 "bad gateways for route from \"%s\" to \"%s\"", src, dst);
549 char*src_gateway = route.src_gateway;
550 char*dst_gateway = route.dst_gateway;
552 /* If source gateway is not our source, we have to recursively find our way up to this point */
553 if (strcmp(src, src_gateway))
554 _get_route_and_latency(src, src_gateway, links, latency);
556 xbt_dynar_foreach(route.link_list, cpt, link) {
557 xbt_dynar_push(*links, &link);
560 /* If dest gateway is not our destination, we have to recursively find our way from this point */
561 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
562 if (strcmp(dst_gateway, dst)) {
563 xbt_dynar_t route_dst = xbt_dynar_new(global_routing->size_of_link,NULL);
565 _get_route_and_latency(dst_gateway, dst, &route_dst, latency);
567 xbt_dynar_foreach(route_dst, cpt, link) {
568 xbt_dynar_push(*links, &link);
570 xbt_dynar_free(&route_dst);
573 xbt_free(src_gateway);
574 xbt_free_f(dst_gateway);
575 xbt_dynar_free(&route.link_list);
579 * \brief Find a route between hosts
581 * \param src the source host name
582 * \param dst the destination host name
583 * \param route where to store the list of links.
584 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
585 * \param latency where to store the latency experienced on the path (or NULL if not interested)
586 * It is the caller responsability to initialize latency to 0 (we add to provided route)
589 * walk through the routing components tree and find a route between hosts
590 * by calling the differents "get_route" functions in each routing component.
592 void routing_get_route_and_latency(const char *src, const char *dst,
593 xbt_dynar_t * route, double *latency)
596 xbt_dynar_reset(global_routing->last_route);
597 *route = global_routing->last_route;
600 _get_route_and_latency(src, dst, route, latency);
602 xbt_assert(!latency || *latency >= 0.0,
603 "negative latency on route between \"%s\" and \"%s\"", src, dst);
606 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
608 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
610 //adding my one link routes
613 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
615 xbt_dynar_foreach(onelink_mine, cpt, link) {
616 xbt_dynar_push(ret, &link);
621 xbt_dict_cursor_t cursor = NULL;
623 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
624 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
626 xbt_dynar_foreach(onelink_child, cpt, link) {
627 xbt_dynar_push(ret, &link);
634 static xbt_dynar_t get_onelink_routes(void)
636 return recursive_get_onelink_routes(global_routing->root);
639 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
641 network_element_info_t rc = NULL;
643 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
647 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
651 return SURF_NETWORK_ELEMENT_NULL;
655 * \brief Generic method: create the global routing schema
657 * Make a global routing structure and set all the parsing functions.
659 void routing_model_create(size_t size_of_links, void *loopback)
661 /* config the uniq global routing */
662 global_routing = xbt_new0(s_routing_global_t, 1);
663 global_routing->root = NULL;
664 global_routing->get_onelink_routes = get_onelink_routes;
665 global_routing->loopback = loopback;
666 global_routing->size_of_link = size_of_links;
667 global_routing->last_route = xbt_dynar_new(global_routing->size_of_link,NULL);
668 /* no current routing at moment */
669 current_routing = NULL;
673 /* ************************************************** */
674 /* ********** PATERN FOR NEW ROUTING **************** */
676 /* The minimal configuration of a new routing model need the next functions,
677 * also you need to set at the start of the file, the new model in the model
678 * list. Remember keep the null ending of the list.
680 /*** Routing model structure ***/
682 // s_routing_component_t generic_routing;
683 // /* things that your routing model need */
684 // } s_routing_component_NEW_t,*routing_component_NEW_t;
686 /*** Parse routing model functions ***/
687 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
688 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
689 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
690 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
691 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
693 /*** Business methods ***/
694 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
695 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
696 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
698 /*** Creation routing model functions ***/
699 // static void* model_NEW_create(void) {
700 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
701 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
702 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
703 // new_component->generic_routing.set_route = model_NEW_set_route;
704 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
705 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
706 // new_component->generic_routing.get_route = NEW_get_route;
707 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
708 // new_component->generic_routing.finalize = NEW_finalize;
709 // /* initialization of internal structures */
710 // return new_component;
712 // static void model_NEW_load(void) {} /* mandatory */
713 // static void model_NEW_unload(void) {} /* mandatory */
714 // static void model_NEW_end(void) {} /* mandatory */
716 /* ************************************************************************** */
717 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
719 static void routing_parse_storage(sg_platf_storage_cbarg_t storage)
721 XBT_INFO("ROUTING Create a storage name '%s' with type_id '%s'",storage->id,storage->type_id);
723 static void routing_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
725 XBT_INFO("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->type_id);
727 static void routing_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
729 XBT_INFO("ROUTING Create a storage type_id '%s' with model '%s'",storage_type->type_id,storage_type->model);
731 static void routing_parse_mount(sg_platf_mount_cbarg_t mount)
733 XBT_INFO("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
736 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
738 char *host_id, *groups, *link_id = NULL;
739 xbt_dict_t patterns = NULL;
741 s_sg_platf_host_cbarg_t host;
742 s_sg_platf_link_cbarg_t link;
746 xbt_dynar_t radical_elements;
747 xbt_dynar_t radical_ends;
749 if (strcmp(cluster->availability_trace, "")
750 || strcmp(cluster->state_trace, "")) {
751 patterns = xbt_dict_new_homogeneous(xbt_free_f);
752 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
753 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
754 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
758 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
759 sg_platf_new_AS_begin(cluster->id, "Cluster");
762 radical_elements = xbt_str_split(cluster->radical, ",");
763 xbt_dynar_foreach(radical_elements, iter, groups) {
765 radical_ends = xbt_str_split(groups, "-");
766 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
768 switch (xbt_dynar_length(radical_ends)) {
773 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
776 surf_parse_error("Malformed radical");
779 for (i = start; i <= end; i++) {
781 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
782 link_id = bprintf("%s_link_%d", cluster->id, i);
784 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
786 memset(&host, 0, sizeof(host));
788 if (strcmp(cluster->availability_trace, "")) {
789 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
790 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
791 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
792 host.power_trace = tmgr_trace_new(avail_file);
793 xbt_free(avail_file);
795 XBT_DEBUG("\tavailability_file=\"\"");
798 if (strcmp(cluster->state_trace, "")) {
799 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
800 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
801 host.state_trace = tmgr_trace_new(avail_file);
802 xbt_free(avail_file);
804 XBT_DEBUG("\tstate_file=\"\"");
807 host.power_peak = cluster->power;
808 host.power_scale = 1.0;
809 host.core_amount = cluster->core_amount;
810 host.initial_state = SURF_RESOURCE_ON;
812 sg_platf_new_host(&host);
813 XBT_DEBUG("</host>");
815 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
816 cluster->bw, cluster->lat);
818 memset(&link, 0, sizeof(link));
820 link.bandwidth = cluster->bw;
821 link.latency = cluster->lat;
822 link.state = SURF_RESOURCE_ON;
823 link.policy = cluster->sharing_policy;
824 sg_platf_new_link(&link);
826 surf_parsing_link_up_down_t info =
827 xbt_new0(s_surf_parsing_link_up_down_t, 1);
828 if (link.policy == SURF_LINK_FULLDUPLEX) {
829 char *tmp_link = bprintf("%s_UP", link_id);
831 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
833 tmp_link = bprintf("%s_DOWN", link_id);
835 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
838 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
839 info->link_down = info->link_up;
841 surf_routing_cluster_add_link(host_id, info);
847 xbt_dynar_free(&radical_ends);
849 xbt_dynar_free(&radical_elements);
851 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
852 // and it's very useful to connect clusters together
854 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
856 s_sg_platf_router_cbarg_t router;
857 memset(&router, 0, sizeof(router));
858 router.id = cluster->router_id;
860 if (!router.id || !strcmp(router.id, ""))
862 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
864 sg_platf_new_router(&router);
868 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
869 char *link_backbone = bprintf("%s_backbone", cluster->id);
870 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
871 cluster->bb_bw, cluster->bb_lat);
873 memset(&link, 0, sizeof(link));
874 link.id = link_backbone;
875 link.bandwidth = cluster->bb_bw;
876 link.latency = cluster->bb_lat;
877 link.state = SURF_RESOURCE_ON;
878 link.policy = cluster->bb_sharing_policy;
880 sg_platf_new_link(&link);
882 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
888 sg_platf_new_AS_end();
890 xbt_dict_free(&patterns); // no op if it were never set
893 static void routing_parse_postparse(void) {
894 xbt_dict_free(&random_value);
897 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
899 static int AX_ptr = 0;
900 char *host_id = NULL;
901 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
903 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
904 static unsigned int surfxml_buffer_stack_stack[1024];
906 surfxml_buffer_stack_stack[0] = 0;
908 surfxml_bufferstack_push(1);
910 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
911 sg_platf_new_AS_begin(peer->id, "Full");
914 host_id = HOST_PEER(peer->id);
915 router_id = ROUTER_PEER(peer->id);
916 link_id_up = LINK_UP_PEER(peer->id);
917 link_id_down = LINK_DOWN_PEER(peer->id);
919 link_router = bprintf("%s_link_router", peer->id);
920 link_backbone = bprintf("%s_backbone", peer->id);
922 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
923 s_sg_platf_host_cbarg_t host;
924 memset(&host, 0, sizeof(host));
925 host.initial_state = SURF_RESOURCE_ON;
927 host.power_peak = peer->power;
928 host.power_scale = 1.0;
929 host.power_trace = peer->availability_trace;
930 host.state_trace = peer->state_trace;
931 host.core_amount = 1;
932 host.coord = peer->coord;
933 sg_platf_new_host(&host);
936 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
937 s_sg_platf_router_cbarg_t router;
938 memset(&router, 0, sizeof(router));
939 router.id = router_id;
940 router.coord = peer->coord;
941 sg_platf_new_router(&router);
943 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
944 peer->bw_in, peer->lat);
945 s_sg_platf_link_cbarg_t link;
946 memset(&link, 0, sizeof(link));
947 link.state = SURF_RESOURCE_ON;
948 link.policy = SURF_LINK_SHARED;
949 link.id = link_id_up;
950 link.bandwidth = peer->bw_in;
951 link.latency = peer->lat;
952 sg_platf_new_link(&link);
954 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
955 // Instead, it should be created fullduplex, and the models will do what's needed in this case
956 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
957 peer->bw_out, peer->lat);
958 link.id = link_id_down;
959 sg_platf_new_link(&link);
964 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
965 XBT_DEBUG("symmetrical=\"NO\">");
966 SURFXML_BUFFER_SET(route_src, host_id);
967 SURFXML_BUFFER_SET(route_dst, router_id);
968 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
969 SURFXML_START_TAG(route);
971 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
972 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
973 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
974 SURFXML_START_TAG(link_ctn);
975 SURFXML_END_TAG(link_ctn);
977 XBT_DEBUG("</route>");
978 SURFXML_END_TAG(route);
981 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
982 XBT_DEBUG("symmetrical=\"NO\">");
983 SURFXML_BUFFER_SET(route_src, router_id);
984 SURFXML_BUFFER_SET(route_dst, host_id);
985 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
986 SURFXML_START_TAG(route);
988 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
989 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
990 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
991 SURFXML_START_TAG(link_ctn);
992 SURFXML_END_TAG(link_ctn);
994 XBT_DEBUG("</route>");
995 SURFXML_END_TAG(route);
998 sg_platf_new_AS_end();
1001 //xbt_dynar_free(&tab_elements_num);
1005 free(link_backbone);
1008 surfxml_bufferstack_pop(1);
1011 static void routing_parse_Srandom(void)
1013 double mean, std, min, max, seed;
1014 char *random_id = A_surfxml_random_id;
1015 char *random_radical = A_surfxml_random_radical;
1016 char *rd_name = NULL;
1018 mean = surf_parse_get_double(A_surfxml_random_mean);
1019 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1020 min = surf_parse_get_double(A_surfxml_random_min);
1021 max = surf_parse_get_double(A_surfxml_random_max);
1022 seed = surf_parse_get_double(A_surfxml_random_seed);
1026 random_data_t random = xbt_new0(s_random_data_t, 1);
1029 xbt_dynar_t radical_elements;
1033 xbt_dynar_t radical_ends;
1035 switch (A_surfxml_random_generator) {
1036 case AU_surfxml_random_generator:
1037 case A_surfxml_random_generator_NONE:
1038 random->generator = NONE;
1040 case A_surfxml_random_generator_DRAND48:
1041 random->generator = DRAND48;
1043 case A_surfxml_random_generator_RAND:
1044 random->generator = RAND;
1046 case A_surfxml_random_generator_RNGSTREAM:
1047 random->generator = RNGSTREAM;
1050 surf_parse_error("Invalid random generator");
1053 random->seed = seed;
1057 /* Check user stupidities */
1059 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1061 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1063 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1065 /* normalize the mean and standard deviation before storing */
1066 random->mean = (mean - min) / (max - min);
1067 random->std = std / (max - min);
1069 if (random->mean * (1 - random->mean) < random->std * random->std)
1070 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1071 random->mean, random->std);
1074 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1075 random_id, random->min, random->max, random->mean, random->std,
1076 (int)random->generator, random->seed, random_radical);
1079 random_value = xbt_dict_new_homogeneous(free);
1081 if (!strcmp(random_radical, "")) {
1082 res = random_generate(random);
1083 rd_value = bprintf("%f", res);
1084 xbt_dict_set(random_value, random_id, rd_value, NULL);
1086 radical_elements = xbt_str_split(random_radical, ",");
1087 xbt_dynar_foreach(radical_elements, iter, groups) {
1088 radical_ends = xbt_str_split(groups, "-");
1089 switch (xbt_dynar_length(radical_ends)) {
1091 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1092 "Custom Random '%s' already exists !", random_id);
1093 res = random_generate(random);
1095 bprintf("%s%d", random_id,
1096 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1097 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1102 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1103 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1104 for (i = start; i <= end; i++) {
1105 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1106 "Custom Random '%s' already exists !", bprintf("%s%d",
1109 res = random_generate(random);
1110 tmpbuf = bprintf("%s%d", random_id, i);
1111 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1116 XBT_CRITICAL("Malformed radical");
1119 res = random_generate(random);
1120 rd_name = bprintf("%s_router", random_id);
1121 rd_value = bprintf("%f", res);
1122 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1124 xbt_dynar_free(&radical_ends);
1127 xbt_dynar_free(&radical_elements);
1131 void routing_register_callbacks()
1133 sg_platf_host_add_cb(parse_S_host);
1134 sg_platf_router_add_cb(parse_S_router);
1136 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1138 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1139 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1140 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1141 &routing_parse_S_bypassRoute);
1143 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1145 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1146 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1147 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1148 &routing_parse_E_bypassRoute);
1150 sg_platf_cluster_add_cb(routing_parse_cluster);
1152 sg_platf_peer_add_cb(routing_parse_peer);
1153 sg_platf_postparse_add_cb(routing_parse_postparse);
1155 sg_platf_storage_add_cb(routing_parse_storage);
1156 sg_platf_mstorage_add_cb(routing_parse_mstorage);
1157 sg_platf_storage_type_add_cb(routing_parse_storage_type);
1158 sg_platf_mount_add_cb(routing_parse_mount);
1161 instr_routing_define_callbacks();
1166 * \brief Recursive function for finalize
1168 * \param rc the source host name
1170 * This fuction is call by "finalize". It allow to finalize the
1171 * AS or routing components. It delete all the structures.
1173 static void finalize_rec(AS_t as) {
1174 xbt_dict_cursor_t cursor = NULL;
1178 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1185 /** \brief Frees all memory allocated by the routing module */
1186 void routing_exit(void) {
1187 if (!global_routing)
1189 xbt_dynar_free(&global_routing->last_route);
1190 finalize_rec(global_routing->root);
1191 xbt_free(global_routing);