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 for storagelevel
39 int ROUTING_STORAGE_HOST_LEVEL;
40 int SURF_STORAGE_LEVEL;
42 xbt_lib_t storage_type_lib;
43 int ROUTING_STORAGE_TYPE_LEVEL; //Routing for storage_type level
46 routing_global_t global_routing = NULL;
47 AS_t current_routing = NULL;
49 /* global parse functions */
50 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
51 xbt_dynar_t mount_list = NULL; /* temporary store of current mount storage */
52 static const char *src = NULL; /* temporary store the source name of a route */
53 static const char *dst = NULL; /* temporary store the destination name of a route */
54 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
55 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
57 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
59 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
60 static void routing_parse_Srandom(void); /* random bypass */
62 static void routing_parse_postparse(void);
64 /* this lines are only for replace use like index in the model table */
69 SURF_MODEL_DIJKSTRACACHE,
76 struct s_model_type routing_models[] = {
78 "Full routing data (fast, large memory requirements, fully expressive)",
79 model_full_create, model_full_end},
81 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
82 model_floyd_create, model_floyd_end},
84 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
85 model_dijkstra_create, model_dijkstra_both_end},
87 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
88 model_dijkstracache_create, model_dijkstra_both_end},
89 {"none", "No routing (usable with Constant network only)",
90 model_none_create, NULL},
91 {"RuleBased", "Rule-Based routing data (...)",
92 model_rulebased_create, NULL},
93 {"Vivaldi", "Vivaldi routing",
94 model_vivaldi_create, NULL},
95 {"Cluster", "Cluster routing",
96 model_cluster_create, NULL},
97 {NULL, NULL, NULL, NULL}
101 * \brief Add a "host" to the network element list
103 static void parse_S_host(sg_platf_host_cbarg_t host)
105 network_element_info_t info = NULL;
106 if (current_routing->hierarchy == SURF_ROUTING_NULL)
107 current_routing->hierarchy = SURF_ROUTING_BASE;
108 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
109 "Reading a host, processing unit \"%s\" already exists", host->id);
111 current_routing->parse_PU(current_routing, host->id);
112 info = xbt_new0(s_network_element_info_t, 1);
113 info->rc_component = current_routing;
114 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
115 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
118 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
122 if (host->coord && strcmp(host->coord, "")) {
126 if (!COORD_HOST_LEVEL)
127 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
129 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
130 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
131 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
132 xbt_dynar_foreach(ctn_str,cursor, str) {
133 double val = atof(str);
134 xbt_dynar_push(ctn,&val);
136 xbt_dynar_shrink(ctn, 0);
137 xbt_dynar_free(&ctn_str);
138 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
143 * \brief Add a "router" to the network element list
145 static void parse_S_router(sg_platf_router_cbarg_t router)
147 network_element_info_t info = NULL;
148 if (current_routing->hierarchy == SURF_ROUTING_NULL)
149 current_routing->hierarchy = SURF_ROUTING_BASE;
150 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
151 "Reading a router, processing unit \"%s\" already exists",
154 current_routing->parse_PU(current_routing, router->id);
155 info = xbt_new0(s_network_element_info_t, 1);
156 info->rc_component = current_routing;
157 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
159 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
160 if (strcmp(router->coord, "")) {
164 if (!COORD_ASR_LEVEL)
165 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
167 /* Pre-parse the host coordinates */
168 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
169 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
170 xbt_dynar_foreach(ctn_str,cursor, str) {
171 double val = atof(str);
172 xbt_dynar_push(ctn,&val);
174 xbt_dynar_shrink(ctn, 0);
175 xbt_dynar_free(&ctn_str);
176 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
182 * \brief Set the end points for a route
184 static void routing_parse_S_route(void)
186 if (src != NULL && dst != NULL && parsed_link_list != NULL)
187 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
188 A_surfxml_route_src, A_surfxml_route_dst);
189 src = A_surfxml_route_src;
190 dst = A_surfxml_route_dst;
191 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
192 "Some limits are null in the route between \"%s\" and \"%s\"",
194 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
198 * \brief Set the end points and gateways for a ASroute
200 static void routing_parse_S_ASroute(void)
202 if (src != NULL && dst != NULL && parsed_link_list != NULL)
203 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
204 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
205 src = A_surfxml_ASroute_src;
206 dst = A_surfxml_ASroute_dst;
207 gw_src = A_surfxml_ASroute_gw_src;
208 gw_dst = A_surfxml_ASroute_gw_dst;
209 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
210 || strlen(gw_dst) > 0,
211 "Some limits are null in the route between \"%s\" and \"%s\"",
213 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
217 * \brief Set the end points for a bypassRoute
219 static void routing_parse_S_bypassRoute(void)
221 if (src != NULL && dst != NULL && parsed_link_list != NULL)
223 "Bypass Route between %s to %s can not be defined",
224 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
225 src = A_surfxml_bypassRoute_src;
226 dst = A_surfxml_bypassRoute_dst;
227 gw_src = A_surfxml_bypassRoute_gw_src;
228 gw_dst = A_surfxml_bypassRoute_gw_dst;
229 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
230 || strlen(gw_dst) > 0,
231 "Some limits are null in the route between \"%s\" and \"%s\"",
233 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
237 * \brief Set a new link on the actual list of link for a route or ASroute from XML
240 static void routing_parse_link_ctn(void)
243 switch (A_surfxml_link_ctn_direction) {
244 case AU_surfxml_link_ctn_direction:
245 case A_surfxml_link_ctn_direction_NONE:
246 link_id = xbt_strdup(A_surfxml_link_ctn_id);
248 case A_surfxml_link_ctn_direction_UP:
249 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
251 case A_surfxml_link_ctn_direction_DOWN:
252 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
255 xbt_dynar_push(parsed_link_list, &link_id);
259 * \brief Store the route by calling the set_route function of the current routing component
261 static void routing_parse_E_route(void)
263 route_t route = xbt_new0(s_route_t, 1);
264 route->link_list = parsed_link_list;
265 xbt_assert(current_routing->parse_route,
266 "no defined method \"set_route\" in \"%s\"",
267 current_routing->name);
268 current_routing->parse_route(current_routing, src, dst, route);
269 generic_free_route(route);
270 parsed_link_list = NULL;
276 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
278 static void routing_parse_E_ASroute(void)
280 route_t e_route = xbt_new0(s_route_t, 1);
281 e_route->link_list = parsed_link_list;
282 e_route->src_gateway = xbt_strdup(gw_src);
283 e_route->dst_gateway = xbt_strdup(gw_dst);
284 xbt_assert(current_routing->parse_ASroute,
285 "no defined method \"set_ASroute\" in \"%s\"",
286 current_routing->name);
287 current_routing->parse_ASroute(current_routing, src, dst, e_route);
288 generic_free_route(e_route);
289 parsed_link_list = NULL;
297 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
299 static void routing_parse_E_bypassRoute(void)
301 route_t e_route = xbt_new0(s_route_t, 1);
302 e_route->link_list = parsed_link_list;
303 e_route->src_gateway = xbt_strdup(gw_src);
304 e_route->dst_gateway = xbt_strdup(gw_dst);
305 xbt_assert(current_routing->parse_bypassroute,
306 "Bypassing mechanism not implemented by routing '%s'",
307 current_routing->name);
308 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
309 parsed_link_list = NULL;
317 * \brief Make a new routing component to the platform
319 * Add a new autonomous system to the platform. Any elements (such as host,
320 * router or sub-AS) added after this call and before the corresponding call
321 * to sg_platf_new_AS_close() will be added to this AS.
323 * Once this function was called, the configuration concerning the used
324 * models cannot be changed anymore.
326 * @param AS_id name of this autonomous system. Must be unique in the platform
327 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
329 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
332 routing_model_description_t model = NULL;
335 /* search the routing model */
336 for (cpt = 0; routing_models[cpt].name; cpt++)
337 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
338 model = &routing_models[cpt];
339 /* if its not exist, error */
341 fprintf(stderr, "Routing model %s not found. Existing models:\n",
342 wanted_routing_type);
343 for (cpt = 0; routing_models[cpt].name; cpt++)
344 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
345 routing_models[cpt].desc);
349 /* make a new routing component */
350 new_as = (AS_t) model->create();
351 new_as->model_desc = model;
352 new_as->hierarchy = SURF_ROUTING_NULL;
353 new_as->name = xbt_strdup(AS_id);
355 if (current_routing == NULL && global_routing->root == NULL) {
357 /* it is the first one */
358 new_as->routing_father = NULL;
359 global_routing->root = new_as;
361 } else if (current_routing != NULL && global_routing->root != NULL) {
363 xbt_assert(!xbt_dict_get_or_null
364 (current_routing->routing_sons, AS_id),
365 "The AS \"%s\" already exists", AS_id);
366 /* it is a part of the tree */
367 new_as->routing_father = current_routing;
368 /* set the father behavior */
369 if (current_routing->hierarchy == SURF_ROUTING_NULL)
370 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
371 /* add to the sons dictionary */
372 xbt_dict_set(current_routing->routing_sons, AS_id,
373 (void *) new_as, NULL);
374 /* add to the father element list */
375 current_routing->parse_AS(current_routing, AS_id);
377 THROWF(arg_error, 0, "All defined components must be belong to a AS");
379 /* set the new current component of the tree */
380 current_routing = new_as;
384 * \brief Specify that the current description of AS is finished
386 * Once you've declared all the content of your AS, you have to close
387 * it with this call. Your AS is not usable until you call this function.
389 * @fixme: this call is not as robust as wanted: bad things WILL happen
390 * if you call it twice for the same AS, or if you forget calling it, or
391 * even if you add stuff to a closed AS
394 void routing_AS_end()
397 if (current_routing == NULL) {
398 THROWF(arg_error, 0, "Close an AS, but none was under construction");
400 network_element_info_t info = NULL;
401 xbt_assert(!xbt_lib_get_or_null
402 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
403 "The AS \"%s\" already exists", current_routing->name);
404 info = xbt_new0(s_network_element_info_t, 1);
405 info->rc_component = current_routing->routing_father;
406 info->rc_type = SURF_NETWORK_ELEMENT_AS;
407 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
410 if (current_routing->model_desc->end)
411 current_routing->model_desc->end(current_routing);
412 current_routing = current_routing->routing_father;
416 /* Aux Business methods */
419 * \brief Get the AS father and the first elements of the chain
421 * \param src the source host name
422 * \param dst the destination host name
424 * Get the common father of the to processing units, and the first different
425 * father in the chain
427 static void elements_father(const char *src, const char *dst,
432 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
433 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
435 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
436 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
444 /* (1) find the as where the src and dst are located */
445 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
447 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
450 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
452 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
453 src_as = src_data->rc_component;
454 dst_as = dst_data->rc_component;
456 xbt_assert(src_as && dst_as,
457 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
459 /* (2) find the path to the root routing component */
460 for (current = src_as; current != NULL; current = current->routing_father) {
461 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
462 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
463 path_src[index_src++] = current;
465 for (current = dst_as; current != NULL; current = current->routing_father) {
466 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
467 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
468 path_dst[index_dst++] = current;
471 /* (3) find the common father */
473 current_src = path_src[--index_src];
474 current_dst = path_dst[--index_dst];
475 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
477 /* (4) they are not in the same routing component, make the path */
478 if (current_src == current_dst)
479 father = current_src;
481 father = path_src[index_src + 1];
483 /* (5) result generation */
484 *res_father = father; /* first the common father of src and dst */
485 *res_src = current_src; /* second the first different father of src */
486 *res_dst = current_dst; /* three the first different father of dst */
488 #undef ELEMENTS_FATHER_MAXDEPTH
491 /* Global Business methods */
494 * \brief Recursive function for get_route_latency
496 * \param src the source host name
497 * \param dst the destination host name
498 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
499 * \param *latency the latency, if needed
501 * This function is called by "get_route" and "get_latency". It allows to walk
502 * recursively through the ASes tree.
504 static void _get_route_and_latency(const char *src, const char *dst,
505 xbt_dynar_t * links, double *latency)
510 memset(&route,0,sizeof(route));
512 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
513 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
515 /* Find how src and dst are interconnected */
516 AS_t common_father, src_father, dst_father;
517 elements_father(src, dst, &common_father, &src_father, &dst_father);
519 /* If src and dst are in the same AS, life is good */
520 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
522 route.link_list = *links;
524 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
526 xbt_free(route.src_gateway);
527 xbt_free(route.dst_gateway);
531 /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
533 route_t e_route_bypass = NULL;
534 if (common_father->get_bypass_route)
535 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
537 if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
539 xbt_die("Bypass cannot work yet with get_latency"); // FIXME: get_bypass_route should update the latency itself, just like get_route
541 // // FIXME this path is never tested. I need examples to check the bypass mechanism...
542 // THROW_UNIMPLEMENTED; // let's warn the users of the problem
543 xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
544 xbt_dynar_push(*links, &link);
547 generic_free_route(e_route_bypass);
552 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
554 route.link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
555 common_father->get_route_and_latency(common_father, src_father->name, dst_father->name, &route,latency);
557 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
558 "bad gateways for route from \"%s\" to \"%s\"", src, dst);
560 char*src_gateway = route.src_gateway;
561 char*dst_gateway = route.dst_gateway;
563 /* If source gateway is not our source, we have to recursively find our way up to this point */
564 if (strcmp(src, src_gateway))
565 _get_route_and_latency(src, src_gateway, links, latency);
567 xbt_dynar_foreach(route.link_list, cpt, link) {
568 xbt_dynar_push(*links, &link);
571 /* If dest gateway is not our destination, we have to recursively find our way from this point */
572 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
573 if (strcmp(dst_gateway, dst)) {
574 _get_route_and_latency(dst_gateway, dst, links, latency);
577 xbt_free(src_gateway);
578 xbt_free_f(dst_gateway);
579 xbt_dynar_free(&route.link_list);
583 * \brief Find a route between hosts
585 * \param src the source host name
586 * \param dst the destination host name
587 * \param route where to store the list of links.
588 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
589 * \param latency where to store the latency experienced on the path (or NULL if not interested)
590 * It is the caller responsability to initialize latency to 0 (we add to provided route)
593 * walk through the routing components tree and find a route between hosts
594 * by calling the differents "get_route" functions in each routing component.
596 void routing_get_route_and_latency(const char *src, const char *dst,
597 xbt_dynar_t * route, double *latency)
600 xbt_dynar_reset(global_routing->last_route);
601 *route = global_routing->last_route;
604 _get_route_and_latency(src, dst, route, latency);
606 xbt_assert(!latency || *latency >= 0.0,
607 "negative latency on route between \"%s\" and \"%s\"", src, dst);
610 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
612 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
614 //adding my one link routes
617 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
619 xbt_dynar_foreach(onelink_mine, cpt, link) {
620 xbt_dynar_push(ret, &link);
625 xbt_dict_cursor_t cursor = NULL;
627 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
628 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
630 xbt_dynar_foreach(onelink_child, cpt, link) {
631 xbt_dynar_push(ret, &link);
638 static xbt_dynar_t get_onelink_routes(void)
640 return recursive_get_onelink_routes(global_routing->root);
643 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
645 network_element_info_t rc = NULL;
647 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
651 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
655 return SURF_NETWORK_ELEMENT_NULL;
659 * \brief Generic method: create the global routing schema
661 * Make a global routing structure and set all the parsing functions.
663 void routing_model_create(size_t size_of_links, void *loopback)
665 /* config the uniq global routing */
666 global_routing = xbt_new0(s_routing_global_t, 1);
667 global_routing->root = NULL;
668 global_routing->get_onelink_routes = get_onelink_routes;
669 global_routing->loopback = loopback;
670 global_routing->size_of_link = size_of_links;
671 global_routing->last_route = xbt_dynar_new(global_routing->size_of_link,NULL);
672 /* no current routing at moment */
673 current_routing = NULL;
677 /* ************************************************** */
678 /* ********** PATERN FOR NEW ROUTING **************** */
680 /* The minimal configuration of a new routing model need the next functions,
681 * also you need to set at the start of the file, the new model in the model
682 * list. Remember keep the null ending of the list.
684 /*** Routing model structure ***/
686 // s_routing_component_t generic_routing;
687 // /* things that your routing model need */
688 // } s_routing_component_NEW_t,*routing_component_NEW_t;
690 /*** Parse routing model functions ***/
691 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
692 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
693 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
694 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
695 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
697 /*** Business methods ***/
698 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
699 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
700 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
702 /*** Creation routing model functions ***/
703 // static void* model_NEW_create(void) {
704 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
705 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
706 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
707 // new_component->generic_routing.set_route = model_NEW_set_route;
708 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
709 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
710 // new_component->generic_routing.get_route = NEW_get_route;
711 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
712 // new_component->generic_routing.finalize = NEW_finalize;
713 // /* initialization of internal structures */
714 // return new_component;
716 // static void model_NEW_load(void) {} /* mandatory */
717 // static void model_NEW_unload(void) {} /* mandatory */
718 // static void model_NEW_end(void) {} /* mandatory */
720 /* ************************************************************************** */
721 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
723 static void routing_parse_storage(sg_platf_storage_cbarg_t storage)
725 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
726 "Reading a storage, processing unit \"%s\" already exists", storage->id);
728 // Verification of an existing type_id
729 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
730 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
732 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s'",
736 xbt_lib_set(storage_lib,
738 ROUTING_STORAGE_LEVEL,
739 (void *) xbt_strdup(storage->type_id));
741 static void routing_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
743 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
744 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
746 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
747 stype->model = xbt_strdup(storage_type->model);
748 stype->properties = storage_type->properties;
749 stype->content = xbt_strdup(storage_type->content);
750 stype->type_id = xbt_strdup(storage_type->id);
752 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s' and properties '%p'",
758 xbt_lib_set(storage_type_lib,
760 ROUTING_STORAGE_TYPE_LEVEL,
763 static void routing_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
766 // mount_t mnt = xbt_new0(s_mount_t, 1);
767 // mnt->id = xbt_strdup(mstorage->type_id);
768 // mnt->name = xbt_strdup(mstorage->name);
771 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
772 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
774 // xbt_dynar_push(mount_list,(void *) mnt);
778 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
781 static void mount_free(void *p)
787 static void routing_parse_mount(sg_platf_mount_cbarg_t mount)
789 // Verification of an existing storage
790 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
791 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
793 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
796 mnt.id = surf_storage_resource_by_name(mount->id);
797 mnt.name = xbt_strdup(mount->name);
800 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
801 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
803 xbt_dynar_push(mount_list,&mnt);
806 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
808 char *host_id, *groups, *link_id = NULL;
809 xbt_dict_t patterns = NULL;
811 s_sg_platf_host_cbarg_t host;
812 s_sg_platf_link_cbarg_t link;
816 xbt_dynar_t radical_elements;
817 xbt_dynar_t radical_ends;
819 if (strcmp(cluster->availability_trace, "")
820 || strcmp(cluster->state_trace, "")) {
821 patterns = xbt_dict_new_homogeneous(xbt_free_f);
822 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
823 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
824 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
828 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
829 sg_platf_new_AS_begin(cluster->id, "Cluster");
832 radical_elements = xbt_str_split(cluster->radical, ",");
833 xbt_dynar_foreach(radical_elements, iter, groups) {
835 radical_ends = xbt_str_split(groups, "-");
836 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
838 switch (xbt_dynar_length(radical_ends)) {
843 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
846 surf_parse_error("Malformed radical");
849 for (i = start; i <= end; i++) {
851 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
852 link_id = bprintf("%s_link_%d", cluster->id, i);
854 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
856 memset(&host, 0, sizeof(host));
858 if (strcmp(cluster->availability_trace, "")) {
859 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
860 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
861 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
862 host.power_trace = tmgr_trace_new(avail_file);
863 xbt_free(avail_file);
865 XBT_DEBUG("\tavailability_file=\"\"");
868 if (strcmp(cluster->state_trace, "")) {
869 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
870 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
871 host.state_trace = tmgr_trace_new(avail_file);
872 xbt_free(avail_file);
874 XBT_DEBUG("\tstate_file=\"\"");
877 host.power_peak = cluster->power;
878 host.power_scale = 1.0;
879 host.core_amount = cluster->core_amount;
880 host.initial_state = SURF_RESOURCE_ON;
882 sg_platf_new_host(&host);
883 XBT_DEBUG("</host>");
885 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
886 cluster->bw, cluster->lat);
888 memset(&link, 0, sizeof(link));
890 link.bandwidth = cluster->bw;
891 link.latency = cluster->lat;
892 link.state = SURF_RESOURCE_ON;
893 link.policy = cluster->sharing_policy;
894 sg_platf_new_link(&link);
896 surf_parsing_link_up_down_t info =
897 xbt_new0(s_surf_parsing_link_up_down_t, 1);
898 if (link.policy == SURF_LINK_FULLDUPLEX) {
899 char *tmp_link = bprintf("%s_UP", link_id);
901 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
903 tmp_link = bprintf("%s_DOWN", link_id);
905 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
908 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
909 info->link_down = info->link_up;
911 surf_routing_cluster_add_link(host_id, info);
917 xbt_dynar_free(&radical_ends);
919 xbt_dynar_free(&radical_elements);
921 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
922 // and it's very useful to connect clusters together
924 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
926 s_sg_platf_router_cbarg_t router;
927 memset(&router, 0, sizeof(router));
928 router.id = cluster->router_id;
930 if (!router.id || !strcmp(router.id, ""))
932 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
934 sg_platf_new_router(&router);
938 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
939 char *link_backbone = bprintf("%s_backbone", cluster->id);
940 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
941 cluster->bb_bw, cluster->bb_lat);
943 memset(&link, 0, sizeof(link));
944 link.id = link_backbone;
945 link.bandwidth = cluster->bb_bw;
946 link.latency = cluster->bb_lat;
947 link.state = SURF_RESOURCE_ON;
948 link.policy = cluster->bb_sharing_policy;
950 sg_platf_new_link(&link);
952 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
958 sg_platf_new_AS_end();
960 xbt_dict_free(&patterns); // no op if it were never set
963 static void routing_parse_postparse(void) {
964 xbt_dict_free(&random_value);
967 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
969 static int AX_ptr = 0;
970 char *host_id = NULL;
971 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
973 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
974 static unsigned int surfxml_buffer_stack_stack[1024];
976 surfxml_buffer_stack_stack[0] = 0;
978 surfxml_bufferstack_push(1);
980 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
981 sg_platf_new_AS_begin(peer->id, "Full");
984 host_id = HOST_PEER(peer->id);
985 router_id = ROUTER_PEER(peer->id);
986 link_id_up = LINK_UP_PEER(peer->id);
987 link_id_down = LINK_DOWN_PEER(peer->id);
989 link_router = bprintf("%s_link_router", peer->id);
990 link_backbone = bprintf("%s_backbone", peer->id);
992 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
993 s_sg_platf_host_cbarg_t host;
994 memset(&host, 0, sizeof(host));
995 host.initial_state = SURF_RESOURCE_ON;
997 host.power_peak = peer->power;
998 host.power_scale = 1.0;
999 host.power_trace = peer->availability_trace;
1000 host.state_trace = peer->state_trace;
1001 host.core_amount = 1;
1002 host.coord = peer->coord;
1003 sg_platf_new_host(&host);
1006 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1007 s_sg_platf_router_cbarg_t router;
1008 memset(&router, 0, sizeof(router));
1009 router.id = router_id;
1010 router.coord = peer->coord;
1011 sg_platf_new_router(&router);
1013 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1014 peer->bw_in, peer->lat);
1015 s_sg_platf_link_cbarg_t link;
1016 memset(&link, 0, sizeof(link));
1017 link.state = SURF_RESOURCE_ON;
1018 link.policy = SURF_LINK_SHARED;
1019 link.id = link_id_up;
1020 link.bandwidth = peer->bw_in;
1021 link.latency = peer->lat;
1022 sg_platf_new_link(&link);
1024 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1025 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1026 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1027 peer->bw_out, peer->lat);
1028 link.id = link_id_down;
1029 sg_platf_new_link(&link);
1034 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1035 XBT_DEBUG("symmetrical=\"NO\">");
1036 SURFXML_BUFFER_SET(route_src, host_id);
1037 SURFXML_BUFFER_SET(route_dst, router_id);
1038 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1039 SURFXML_START_TAG(route);
1041 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1042 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1043 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1044 SURFXML_START_TAG(link_ctn);
1045 SURFXML_END_TAG(link_ctn);
1047 XBT_DEBUG("</route>");
1048 SURFXML_END_TAG(route);
1051 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1052 XBT_DEBUG("symmetrical=\"NO\">");
1053 SURFXML_BUFFER_SET(route_src, router_id);
1054 SURFXML_BUFFER_SET(route_dst, host_id);
1055 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1056 SURFXML_START_TAG(route);
1058 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1059 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1060 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1061 SURFXML_START_TAG(link_ctn);
1062 SURFXML_END_TAG(link_ctn);
1064 XBT_DEBUG("</route>");
1065 SURFXML_END_TAG(route);
1068 sg_platf_new_AS_end();
1071 //xbt_dynar_free(&tab_elements_num);
1075 free(link_backbone);
1078 surfxml_bufferstack_pop(1);
1081 static void routing_parse_Srandom(void)
1083 double mean, std, min, max, seed;
1084 char *random_id = A_surfxml_random_id;
1085 char *random_radical = A_surfxml_random_radical;
1086 char *rd_name = NULL;
1088 mean = surf_parse_get_double(A_surfxml_random_mean);
1089 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1090 min = surf_parse_get_double(A_surfxml_random_min);
1091 max = surf_parse_get_double(A_surfxml_random_max);
1092 seed = surf_parse_get_double(A_surfxml_random_seed);
1096 random_data_t random = xbt_new0(s_random_data_t, 1);
1099 xbt_dynar_t radical_elements;
1103 xbt_dynar_t radical_ends;
1105 switch (A_surfxml_random_generator) {
1106 case AU_surfxml_random_generator:
1107 case A_surfxml_random_generator_NONE:
1108 random->generator = NONE;
1110 case A_surfxml_random_generator_DRAND48:
1111 random->generator = DRAND48;
1113 case A_surfxml_random_generator_RAND:
1114 random->generator = RAND;
1116 case A_surfxml_random_generator_RNGSTREAM:
1117 random->generator = RNGSTREAM;
1120 surf_parse_error("Invalid random generator");
1123 random->seed = seed;
1127 /* Check user stupidities */
1129 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1131 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1133 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1135 /* normalize the mean and standard deviation before storing */
1136 random->mean = (mean - min) / (max - min);
1137 random->std = std / (max - min);
1139 if (random->mean * (1 - random->mean) < random->std * random->std)
1140 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1141 random->mean, random->std);
1144 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1145 random_id, random->min, random->max, random->mean, random->std,
1146 (int)random->generator, random->seed, random_radical);
1149 random_value = xbt_dict_new_homogeneous(free);
1151 if (!strcmp(random_radical, "")) {
1152 res = random_generate(random);
1153 rd_value = bprintf("%f", res);
1154 xbt_dict_set(random_value, random_id, rd_value, NULL);
1156 radical_elements = xbt_str_split(random_radical, ",");
1157 xbt_dynar_foreach(radical_elements, iter, groups) {
1158 radical_ends = xbt_str_split(groups, "-");
1159 switch (xbt_dynar_length(radical_ends)) {
1161 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1162 "Custom Random '%s' already exists !", random_id);
1163 res = random_generate(random);
1165 bprintf("%s%d", random_id,
1166 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1167 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1172 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1173 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1174 for (i = start; i <= end; i++) {
1175 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1176 "Custom Random '%s' already exists !", bprintf("%s%d",
1179 res = random_generate(random);
1180 tmpbuf = bprintf("%s%d", random_id, i);
1181 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1186 XBT_CRITICAL("Malformed radical");
1189 res = random_generate(random);
1190 rd_name = bprintf("%s_router", random_id);
1191 rd_value = bprintf("%f", res);
1192 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1194 xbt_dynar_free(&radical_ends);
1197 xbt_dynar_free(&radical_elements);
1201 void routing_register_callbacks()
1203 sg_platf_host_add_cb(parse_S_host);
1204 sg_platf_router_add_cb(parse_S_router);
1206 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1208 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1209 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1210 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1211 &routing_parse_S_bypassRoute);
1213 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1215 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1216 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1217 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1218 &routing_parse_E_bypassRoute);
1220 sg_platf_cluster_add_cb(routing_parse_cluster);
1222 sg_platf_peer_add_cb(routing_parse_peer);
1223 sg_platf_postparse_add_cb(routing_parse_postparse);
1225 sg_platf_storage_add_cb(routing_parse_storage);
1226 sg_platf_mstorage_add_cb(routing_parse_mstorage);
1227 sg_platf_storage_type_add_cb(routing_parse_storage_type);
1228 sg_platf_mount_add_cb(routing_parse_mount);
1231 instr_routing_define_callbacks();
1236 * \brief Recursive function for finalize
1238 * \param rc the source host name
1240 * This fuction is call by "finalize". It allow to finalize the
1241 * AS or routing components. It delete all the structures.
1243 static void finalize_rec(AS_t as) {
1244 xbt_dict_cursor_t cursor = NULL;
1248 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1255 /** \brief Frees all memory allocated by the routing module */
1256 void routing_exit(void) {
1257 if (!global_routing)
1259 xbt_dynar_free(&global_routing->last_route);
1260 finalize_rec(global_routing->root);
1261 xbt_free(global_routing);