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_TYPE_LEVEL; //Routing for storage_type level
40 int ROUTING_STORAGE_HOST_LEVEL;
43 routing_global_t global_routing = NULL;
44 AS_t current_routing = NULL;
46 /* global parse functions */
47 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
48 xbt_dynar_t mount_list = NULL; /* temporary store of current mount storage */
49 static const char *src = NULL; /* temporary store the source name of a route */
50 static const char *dst = NULL; /* temporary store the destination name of a route */
51 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
52 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
54 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
56 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
57 static void routing_parse_Srandom(void); /* random bypass */
59 static void routing_parse_postparse(void);
61 /* this lines are only for replace use like index in the model table */
66 SURF_MODEL_DIJKSTRACACHE,
73 struct s_model_type routing_models[] = {
75 "Full routing data (fast, large memory requirements, fully expressive)",
76 model_full_create, model_full_end},
78 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
79 model_floyd_create, model_floyd_end},
81 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
82 model_dijkstra_create, model_dijkstra_both_end},
84 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
85 model_dijkstracache_create, model_dijkstra_both_end},
86 {"none", "No routing (usable with Constant network only)",
87 model_none_create, NULL},
88 {"RuleBased", "Rule-Based routing data (...)",
89 model_rulebased_create, NULL},
90 {"Vivaldi", "Vivaldi routing",
91 model_vivaldi_create, NULL},
92 {"Cluster", "Cluster routing",
93 model_cluster_create, NULL},
94 {NULL, NULL, NULL, NULL}
98 * \brief Add a "host" to the network element list
100 static void parse_S_host(sg_platf_host_cbarg_t host)
102 network_element_info_t info = NULL;
103 if (current_routing->hierarchy == SURF_ROUTING_NULL)
104 current_routing->hierarchy = SURF_ROUTING_BASE;
105 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
106 "Reading a host, processing unit \"%s\" already exists", host->id);
108 current_routing->parse_PU(current_routing, host->id);
109 info = xbt_new0(s_network_element_info_t, 1);
110 info->rc_component = current_routing;
111 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
112 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
115 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
119 if (host->coord && strcmp(host->coord, "")) {
123 if (!COORD_HOST_LEVEL)
124 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
126 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
127 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
128 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
129 xbt_dynar_foreach(ctn_str,cursor, str) {
130 double val = atof(str);
131 xbt_dynar_push(ctn,&val);
133 xbt_dynar_shrink(ctn, 0);
134 xbt_dynar_free(&ctn_str);
135 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
140 * \brief Add a "router" to the network element list
142 static void parse_S_router(sg_platf_router_cbarg_t router)
144 network_element_info_t info = NULL;
145 if (current_routing->hierarchy == SURF_ROUTING_NULL)
146 current_routing->hierarchy = SURF_ROUTING_BASE;
147 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
148 "Reading a router, processing unit \"%s\" already exists",
151 current_routing->parse_PU(current_routing, router->id);
152 info = xbt_new0(s_network_element_info_t, 1);
153 info->rc_component = current_routing;
154 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
156 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
157 if (strcmp(router->coord, "")) {
161 if (!COORD_ASR_LEVEL)
162 xbt_die ("To use host coordinates, please add --cfg=coordinates:yes to your command line");
164 /* Pre-parse the host coordinates */
165 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
166 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
167 xbt_dynar_foreach(ctn_str,cursor, str) {
168 double val = atof(str);
169 xbt_dynar_push(ctn,&val);
171 xbt_dynar_shrink(ctn, 0);
172 xbt_dynar_free(&ctn_str);
173 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
179 * \brief Set the end points for a route
181 static void routing_parse_S_route(void)
183 if (src != NULL && dst != NULL && parsed_link_list != NULL)
184 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
185 A_surfxml_route_src, A_surfxml_route_dst);
186 src = A_surfxml_route_src;
187 dst = A_surfxml_route_dst;
188 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
189 "Some limits are null in the route between \"%s\" and \"%s\"",
191 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
195 * \brief Set the end points and gateways for a ASroute
197 static void routing_parse_S_ASroute(void)
199 if (src != NULL && dst != NULL && parsed_link_list != NULL)
200 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
201 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
202 src = A_surfxml_ASroute_src;
203 dst = A_surfxml_ASroute_dst;
204 gw_src = A_surfxml_ASroute_gw_src;
205 gw_dst = A_surfxml_ASroute_gw_dst;
206 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
207 || strlen(gw_dst) > 0,
208 "Some limits are null in the route between \"%s\" and \"%s\"",
210 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
214 * \brief Set the end points for a bypassRoute
216 static void routing_parse_S_bypassRoute(void)
218 if (src != NULL && dst != NULL && parsed_link_list != NULL)
220 "Bypass Route between %s to %s can not be defined",
221 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
222 src = A_surfxml_bypassRoute_src;
223 dst = A_surfxml_bypassRoute_dst;
224 gw_src = A_surfxml_bypassRoute_gw_src;
225 gw_dst = A_surfxml_bypassRoute_gw_dst;
226 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
227 || strlen(gw_dst) > 0,
228 "Some limits are null in the route between \"%s\" and \"%s\"",
230 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
234 * \brief Set a new link on the actual list of link for a route or ASroute from XML
237 static void routing_parse_link_ctn(void)
240 switch (A_surfxml_link_ctn_direction) {
241 case AU_surfxml_link_ctn_direction:
242 case A_surfxml_link_ctn_direction_NONE:
243 link_id = xbt_strdup(A_surfxml_link_ctn_id);
245 case A_surfxml_link_ctn_direction_UP:
246 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
248 case A_surfxml_link_ctn_direction_DOWN:
249 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
252 xbt_dynar_push(parsed_link_list, &link_id);
256 * \brief Store the route by calling the set_route function of the current routing component
258 static void routing_parse_E_route(void)
260 route_t route = xbt_new0(s_route_t, 1);
261 route->link_list = parsed_link_list;
262 xbt_assert(current_routing->parse_route,
263 "no defined method \"set_route\" in \"%s\"",
264 current_routing->name);
265 current_routing->parse_route(current_routing, src, dst, route);
266 generic_free_route(route);
267 parsed_link_list = NULL;
273 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
275 static void routing_parse_E_ASroute(void)
277 route_t e_route = xbt_new0(s_route_t, 1);
278 e_route->link_list = parsed_link_list;
279 e_route->src_gateway = xbt_strdup(gw_src);
280 e_route->dst_gateway = xbt_strdup(gw_dst);
281 xbt_assert(current_routing->parse_ASroute,
282 "no defined method \"set_ASroute\" in \"%s\"",
283 current_routing->name);
284 current_routing->parse_ASroute(current_routing, src, dst, e_route);
285 generic_free_route(e_route);
286 parsed_link_list = NULL;
294 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
296 static void routing_parse_E_bypassRoute(void)
298 route_t e_route = xbt_new0(s_route_t, 1);
299 e_route->link_list = parsed_link_list;
300 e_route->src_gateway = xbt_strdup(gw_src);
301 e_route->dst_gateway = xbt_strdup(gw_dst);
302 xbt_assert(current_routing->parse_bypassroute,
303 "Bypassing mechanism not implemented by routing '%s'",
304 current_routing->name);
305 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
306 parsed_link_list = NULL;
314 * \brief Make a new routing component to the platform
316 * Add a new autonomous system to the platform. Any elements (such as host,
317 * router or sub-AS) added after this call and before the corresponding call
318 * to sg_platf_new_AS_close() will be added to this AS.
320 * Once this function was called, the configuration concerning the used
321 * models cannot be changed anymore.
323 * @param AS_id name of this autonomous system. Must be unique in the platform
324 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
326 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
329 routing_model_description_t model = NULL;
332 /* search the routing model */
333 for (cpt = 0; routing_models[cpt].name; cpt++)
334 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
335 model = &routing_models[cpt];
336 /* if its not exist, error */
338 fprintf(stderr, "Routing model %s not found. Existing models:\n",
339 wanted_routing_type);
340 for (cpt = 0; routing_models[cpt].name; cpt++)
341 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
342 routing_models[cpt].desc);
346 /* make a new routing component */
347 new_as = (AS_t) model->create();
348 new_as->model_desc = model;
349 new_as->hierarchy = SURF_ROUTING_NULL;
350 new_as->name = xbt_strdup(AS_id);
352 if (current_routing == NULL && global_routing->root == NULL) {
354 /* it is the first one */
355 new_as->routing_father = NULL;
356 global_routing->root = new_as;
358 } else if (current_routing != NULL && global_routing->root != NULL) {
360 xbt_assert(!xbt_dict_get_or_null
361 (current_routing->routing_sons, AS_id),
362 "The AS \"%s\" already exists", AS_id);
363 /* it is a part of the tree */
364 new_as->routing_father = current_routing;
365 /* set the father behavior */
366 if (current_routing->hierarchy == SURF_ROUTING_NULL)
367 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
368 /* add to the sons dictionary */
369 xbt_dict_set(current_routing->routing_sons, AS_id,
370 (void *) new_as, NULL);
371 /* add to the father element list */
372 current_routing->parse_AS(current_routing, AS_id);
374 THROWF(arg_error, 0, "All defined components must be belong to a AS");
376 /* set the new current component of the tree */
377 current_routing = new_as;
381 * \brief Specify that the current description of AS is finished
383 * Once you've declared all the content of your AS, you have to close
384 * it with this call. Your AS is not usable until you call this function.
386 * @fixme: this call is not as robust as wanted: bad things WILL happen
387 * if you call it twice for the same AS, or if you forget calling it, or
388 * even if you add stuff to a closed AS
391 void routing_AS_end()
394 if (current_routing == NULL) {
395 THROWF(arg_error, 0, "Close an AS, but none was under construction");
397 network_element_info_t info = NULL;
398 xbt_assert(!xbt_lib_get_or_null
399 (as_router_lib, current_routing->name, ROUTING_ASR_LEVEL),
400 "The AS \"%s\" already exists", current_routing->name);
401 info = xbt_new0(s_network_element_info_t, 1);
402 info->rc_component = current_routing->routing_father;
403 info->rc_type = SURF_NETWORK_ELEMENT_AS;
404 xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
407 if (current_routing->model_desc->end)
408 current_routing->model_desc->end(current_routing);
409 current_routing = current_routing->routing_father;
413 /* Aux Business methods */
416 * \brief Get the AS father and the first elements of the chain
418 * \param src the source host name
419 * \param dst the destination host name
421 * Get the common father of the to processing units, and the first different
422 * father in the chain
424 static void elements_father(const char *src, const char *dst,
429 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
430 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
432 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
433 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
441 /* (1) find the as where the src and dst are located */
442 network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
444 network_element_info_t dst_data = xbt_lib_get_or_null(host_lib, dst,
447 src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
449 dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
450 src_as = src_data->rc_component;
451 dst_as = dst_data->rc_component;
453 xbt_assert(src_as && dst_as,
454 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src, dst);
456 /* (2) find the path to the root routing component */
457 for (current = src_as; current != NULL; current = current->routing_father) {
458 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
459 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
460 path_src[index_src++] = current;
462 for (current = dst_as; current != NULL; current = current->routing_father) {
463 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
464 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
465 path_dst[index_dst++] = current;
468 /* (3) find the common father */
470 current_src = path_src[--index_src];
471 current_dst = path_dst[--index_dst];
472 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
474 /* (4) they are not in the same routing component, make the path */
475 if (current_src == current_dst)
476 father = current_src;
478 father = path_src[index_src + 1];
480 /* (5) result generation */
481 *res_father = father; /* first the common father of src and dst */
482 *res_src = current_src; /* second the first different father of src */
483 *res_dst = current_dst; /* three the first different father of dst */
485 #undef ELEMENTS_FATHER_MAXDEPTH
488 /* Global Business methods */
491 * \brief Recursive function for get_route_latency
493 * \param src the source host name
494 * \param dst the destination host name
495 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
496 * \param *latency the latency, if needed
498 * This function is called by "get_route" and "get_latency". It allows to walk
499 * recursively through the ASes tree.
501 static void _get_route_and_latency(const char *src, const char *dst,
502 xbt_dynar_t * links, double *latency)
507 memset(&route,0,sizeof(route));
509 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src, dst);
510 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
512 /* Find how src and dst are interconnected */
513 AS_t common_father, src_father, dst_father;
514 elements_father(src, dst, &common_father, &src_father, &dst_father);
516 /* If src and dst are in the same AS, life is good */
517 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
519 route.link_list = *links;
521 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
523 xbt_free(route.src_gateway);
524 xbt_free(route.dst_gateway);
528 /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
530 route_t e_route_bypass = NULL;
531 if (common_father->get_bypass_route)
532 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
534 if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
536 xbt_die("Bypass cannot work yet with get_latency"); // FIXME: get_bypass_route should update the latency itself, just like get_route
538 // // FIXME this path is never tested. I need examples to check the bypass mechanism...
539 // THROW_UNIMPLEMENTED; // let's warn the users of the problem
540 xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
541 xbt_dynar_push(*links, &link);
544 generic_free_route(e_route_bypass);
549 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
551 route.link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
552 common_father->get_route_and_latency(common_father, src_father->name, dst_father->name, &route,latency);
554 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
555 "bad gateways for route from \"%s\" to \"%s\"", src, dst);
557 char*src_gateway = route.src_gateway;
558 char*dst_gateway = route.dst_gateway;
560 /* If source gateway is not our source, we have to recursively find our way up to this point */
561 if (strcmp(src, src_gateway))
562 _get_route_and_latency(src, src_gateway, links, latency);
564 xbt_dynar_foreach(route.link_list, cpt, link) {
565 xbt_dynar_push(*links, &link);
568 /* If dest gateway is not our destination, we have to recursively find our way from this point */
569 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
570 if (strcmp(dst_gateway, dst)) {
571 xbt_dynar_t route_dst = xbt_dynar_new(global_routing->size_of_link,NULL);
573 _get_route_and_latency(dst_gateway, dst, &route_dst, latency);
575 xbt_dynar_foreach(route_dst, cpt, link) {
576 xbt_dynar_push(*links, &link);
578 xbt_dynar_free(&route_dst);
581 xbt_free(src_gateway);
582 xbt_free_f(dst_gateway);
583 xbt_dynar_free(&route.link_list);
587 * \brief Find a route between hosts
589 * \param src the source host name
590 * \param dst the destination host name
591 * \param route where to store the list of links.
592 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
593 * \param latency where to store the latency experienced on the path (or NULL if not interested)
594 * It is the caller responsability to initialize latency to 0 (we add to provided route)
597 * walk through the routing components tree and find a route between hosts
598 * by calling the differents "get_route" functions in each routing component.
600 void routing_get_route_and_latency(const char *src, const char *dst,
601 xbt_dynar_t * route, double *latency)
604 xbt_dynar_reset(global_routing->last_route);
605 *route = global_routing->last_route;
608 _get_route_and_latency(src, dst, route, latency);
610 xbt_assert(!latency || *latency >= 0.0,
611 "negative latency on route between \"%s\" and \"%s\"", src, dst);
614 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
616 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
618 //adding my one link routes
621 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
623 xbt_dynar_foreach(onelink_mine, cpt, link) {
624 xbt_dynar_push(ret, &link);
629 xbt_dict_cursor_t cursor = NULL;
631 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
632 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
634 xbt_dynar_foreach(onelink_child, cpt, link) {
635 xbt_dynar_push(ret, &link);
642 static xbt_dynar_t get_onelink_routes(void)
644 return recursive_get_onelink_routes(global_routing->root);
647 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
649 network_element_info_t rc = NULL;
651 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
655 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
659 return SURF_NETWORK_ELEMENT_NULL;
663 * \brief Generic method: create the global routing schema
665 * Make a global routing structure and set all the parsing functions.
667 void routing_model_create(size_t size_of_links, void *loopback)
669 /* config the uniq global routing */
670 global_routing = xbt_new0(s_routing_global_t, 1);
671 global_routing->root = NULL;
672 global_routing->get_onelink_routes = get_onelink_routes;
673 global_routing->loopback = loopback;
674 global_routing->size_of_link = size_of_links;
675 global_routing->last_route = xbt_dynar_new(global_routing->size_of_link,NULL);
676 /* no current routing at moment */
677 current_routing = NULL;
681 /* ************************************************** */
682 /* ********** PATERN FOR NEW ROUTING **************** */
684 /* The minimal configuration of a new routing model need the next functions,
685 * also you need to set at the start of the file, the new model in the model
686 * list. Remember keep the null ending of the list.
688 /*** Routing model structure ***/
690 // s_routing_component_t generic_routing;
691 // /* things that your routing model need */
692 // } s_routing_component_NEW_t,*routing_component_NEW_t;
694 /*** Parse routing model functions ***/
695 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
696 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
697 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
698 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
699 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
701 /*** Business methods ***/
702 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
703 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
704 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
706 /*** Creation routing model functions ***/
707 // static void* model_NEW_create(void) {
708 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
709 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
710 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
711 // new_component->generic_routing.set_route = model_NEW_set_route;
712 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
713 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
714 // new_component->generic_routing.get_route = NEW_get_route;
715 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
716 // new_component->generic_routing.finalize = NEW_finalize;
717 // /* initialization of internal structures */
718 // return new_component;
720 // static void model_NEW_load(void) {} /* mandatory */
721 // static void model_NEW_unload(void) {} /* mandatory */
722 // static void model_NEW_end(void) {} /* mandatory */
724 /* ************************************************************************** */
725 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
727 static void routing_parse_storage(sg_platf_storage_cbarg_t storage)
729 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
730 "Reading a storage, processing unit \"%s\" already exists", storage->id);
732 // Verification of an existing type_id
733 void* storage_type = xbt_lib_get_or_null(storage_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
734 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
736 XBT_INFO("ROUTING Create a storage name '%s' with type_id '%s'",storage->id,storage->type_id);
738 xbt_lib_set(storage_lib,storage->id,ROUTING_STORAGE_LEVEL,(void *) xbt_strdup(storage->type_id));
740 static void routing_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
742 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
743 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
745 XBT_INFO("ROUTING Create a storage type_id '%s' with model '%s'",storage_type->id,storage_type->model);
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_lib_set(storage_lib,storage_type->id,ROUTING_STORAGE_TYPE_LEVEL,(void *) stype);
754 static void routing_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
756 mount_t mnt = xbt_new0(s_mount_t, 1);
757 mnt->type_id = xbt_strdup(mstorage->type_id);
758 mnt->name = xbt_strdup(mstorage->name);
761 XBT_INFO("Creata a Mount list for %s",A_surfxml_host_id);
762 mount_list = xbt_dynar_new(sizeof(char *), NULL);
764 xbt_dynar_push(mount_list,(void *) mnt);
768 XBT_INFO("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->type_id);
770 static void routing_parse_mount(sg_platf_mount_cbarg_t mount)
773 // Verification of an existing storage
774 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
775 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
777 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
778 sg_platf_mstorage_cbarg_t mstorage = xbt_new0(s_sg_platf_mstorage_cbarg_t, 1);
779 mstorage->name = xbt_strdup(mount->name);
780 mstorage->type_id = xbt_strdup((const char*)storage);
782 routing_parse_mstorage(mstorage);
783 free(mstorage->name);
784 free(mstorage->type_id);
788 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
790 char *host_id, *groups, *link_id = NULL;
791 xbt_dict_t patterns = NULL;
793 s_sg_platf_host_cbarg_t host;
794 s_sg_platf_link_cbarg_t link;
798 xbt_dynar_t radical_elements;
799 xbt_dynar_t radical_ends;
801 if (strcmp(cluster->availability_trace, "")
802 || strcmp(cluster->state_trace, "")) {
803 patterns = xbt_dict_new_homogeneous(xbt_free_f);
804 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
805 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
806 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
810 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
811 sg_platf_new_AS_begin(cluster->id, "Cluster");
814 radical_elements = xbt_str_split(cluster->radical, ",");
815 xbt_dynar_foreach(radical_elements, iter, groups) {
817 radical_ends = xbt_str_split(groups, "-");
818 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
820 switch (xbt_dynar_length(radical_ends)) {
825 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
828 surf_parse_error("Malformed radical");
831 for (i = start; i <= end; i++) {
833 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
834 link_id = bprintf("%s_link_%d", cluster->id, i);
836 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
838 memset(&host, 0, sizeof(host));
840 if (strcmp(cluster->availability_trace, "")) {
841 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
842 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
843 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
844 host.power_trace = tmgr_trace_new(avail_file);
845 xbt_free(avail_file);
847 XBT_DEBUG("\tavailability_file=\"\"");
850 if (strcmp(cluster->state_trace, "")) {
851 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
852 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
853 host.state_trace = tmgr_trace_new(avail_file);
854 xbt_free(avail_file);
856 XBT_DEBUG("\tstate_file=\"\"");
859 host.power_peak = cluster->power;
860 host.power_scale = 1.0;
861 host.core_amount = cluster->core_amount;
862 host.initial_state = SURF_RESOURCE_ON;
864 sg_platf_new_host(&host);
865 XBT_DEBUG("</host>");
867 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
868 cluster->bw, cluster->lat);
870 memset(&link, 0, sizeof(link));
872 link.bandwidth = cluster->bw;
873 link.latency = cluster->lat;
874 link.state = SURF_RESOURCE_ON;
875 link.policy = cluster->sharing_policy;
876 sg_platf_new_link(&link);
878 surf_parsing_link_up_down_t info =
879 xbt_new0(s_surf_parsing_link_up_down_t, 1);
880 if (link.policy == SURF_LINK_FULLDUPLEX) {
881 char *tmp_link = bprintf("%s_UP", link_id);
883 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
885 tmp_link = bprintf("%s_DOWN", link_id);
887 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
890 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
891 info->link_down = info->link_up;
893 surf_routing_cluster_add_link(host_id, info);
899 xbt_dynar_free(&radical_ends);
901 xbt_dynar_free(&radical_elements);
903 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
904 // and it's very useful to connect clusters together
906 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
908 s_sg_platf_router_cbarg_t router;
909 memset(&router, 0, sizeof(router));
910 router.id = cluster->router_id;
912 if (!router.id || !strcmp(router.id, ""))
914 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
916 sg_platf_new_router(&router);
920 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
921 char *link_backbone = bprintf("%s_backbone", cluster->id);
922 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
923 cluster->bb_bw, cluster->bb_lat);
925 memset(&link, 0, sizeof(link));
926 link.id = link_backbone;
927 link.bandwidth = cluster->bb_bw;
928 link.latency = cluster->bb_lat;
929 link.state = SURF_RESOURCE_ON;
930 link.policy = cluster->bb_sharing_policy;
932 sg_platf_new_link(&link);
934 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
940 sg_platf_new_AS_end();
942 xbt_dict_free(&patterns); // no op if it were never set
945 static void routing_parse_postparse(void) {
946 xbt_dict_free(&random_value);
949 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
951 static int AX_ptr = 0;
952 char *host_id = NULL;
953 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
955 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
956 static unsigned int surfxml_buffer_stack_stack[1024];
958 surfxml_buffer_stack_stack[0] = 0;
960 surfxml_bufferstack_push(1);
962 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
963 sg_platf_new_AS_begin(peer->id, "Full");
966 host_id = HOST_PEER(peer->id);
967 router_id = ROUTER_PEER(peer->id);
968 link_id_up = LINK_UP_PEER(peer->id);
969 link_id_down = LINK_DOWN_PEER(peer->id);
971 link_router = bprintf("%s_link_router", peer->id);
972 link_backbone = bprintf("%s_backbone", peer->id);
974 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
975 s_sg_platf_host_cbarg_t host;
976 memset(&host, 0, sizeof(host));
977 host.initial_state = SURF_RESOURCE_ON;
979 host.power_peak = peer->power;
980 host.power_scale = 1.0;
981 host.power_trace = peer->availability_trace;
982 host.state_trace = peer->state_trace;
983 host.core_amount = 1;
984 host.coord = peer->coord;
985 sg_platf_new_host(&host);
988 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
989 s_sg_platf_router_cbarg_t router;
990 memset(&router, 0, sizeof(router));
991 router.id = router_id;
992 router.coord = peer->coord;
993 sg_platf_new_router(&router);
995 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
996 peer->bw_in, peer->lat);
997 s_sg_platf_link_cbarg_t link;
998 memset(&link, 0, sizeof(link));
999 link.state = SURF_RESOURCE_ON;
1000 link.policy = SURF_LINK_SHARED;
1001 link.id = link_id_up;
1002 link.bandwidth = peer->bw_in;
1003 link.latency = peer->lat;
1004 sg_platf_new_link(&link);
1006 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1007 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1008 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1009 peer->bw_out, peer->lat);
1010 link.id = link_id_down;
1011 sg_platf_new_link(&link);
1016 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1017 XBT_DEBUG("symmetrical=\"NO\">");
1018 SURFXML_BUFFER_SET(route_src, host_id);
1019 SURFXML_BUFFER_SET(route_dst, router_id);
1020 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1021 SURFXML_START_TAG(route);
1023 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1024 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1025 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1026 SURFXML_START_TAG(link_ctn);
1027 SURFXML_END_TAG(link_ctn);
1029 XBT_DEBUG("</route>");
1030 SURFXML_END_TAG(route);
1033 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1034 XBT_DEBUG("symmetrical=\"NO\">");
1035 SURFXML_BUFFER_SET(route_src, router_id);
1036 SURFXML_BUFFER_SET(route_dst, host_id);
1037 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1038 SURFXML_START_TAG(route);
1040 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1041 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1042 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1043 SURFXML_START_TAG(link_ctn);
1044 SURFXML_END_TAG(link_ctn);
1046 XBT_DEBUG("</route>");
1047 SURFXML_END_TAG(route);
1050 sg_platf_new_AS_end();
1053 //xbt_dynar_free(&tab_elements_num);
1057 free(link_backbone);
1060 surfxml_bufferstack_pop(1);
1063 static void routing_parse_Srandom(void)
1065 double mean, std, min, max, seed;
1066 char *random_id = A_surfxml_random_id;
1067 char *random_radical = A_surfxml_random_radical;
1068 char *rd_name = NULL;
1070 mean = surf_parse_get_double(A_surfxml_random_mean);
1071 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1072 min = surf_parse_get_double(A_surfxml_random_min);
1073 max = surf_parse_get_double(A_surfxml_random_max);
1074 seed = surf_parse_get_double(A_surfxml_random_seed);
1078 random_data_t random = xbt_new0(s_random_data_t, 1);
1081 xbt_dynar_t radical_elements;
1085 xbt_dynar_t radical_ends;
1087 switch (A_surfxml_random_generator) {
1088 case AU_surfxml_random_generator:
1089 case A_surfxml_random_generator_NONE:
1090 random->generator = NONE;
1092 case A_surfxml_random_generator_DRAND48:
1093 random->generator = DRAND48;
1095 case A_surfxml_random_generator_RAND:
1096 random->generator = RAND;
1098 case A_surfxml_random_generator_RNGSTREAM:
1099 random->generator = RNGSTREAM;
1102 surf_parse_error("Invalid random generator");
1105 random->seed = seed;
1109 /* Check user stupidities */
1111 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1113 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1115 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1117 /* normalize the mean and standard deviation before storing */
1118 random->mean = (mean - min) / (max - min);
1119 random->std = std / (max - min);
1121 if (random->mean * (1 - random->mean) < random->std * random->std)
1122 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1123 random->mean, random->std);
1126 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1127 random_id, random->min, random->max, random->mean, random->std,
1128 (int)random->generator, random->seed, random_radical);
1131 random_value = xbt_dict_new_homogeneous(free);
1133 if (!strcmp(random_radical, "")) {
1134 res = random_generate(random);
1135 rd_value = bprintf("%f", res);
1136 xbt_dict_set(random_value, random_id, rd_value, NULL);
1138 radical_elements = xbt_str_split(random_radical, ",");
1139 xbt_dynar_foreach(radical_elements, iter, groups) {
1140 radical_ends = xbt_str_split(groups, "-");
1141 switch (xbt_dynar_length(radical_ends)) {
1143 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1144 "Custom Random '%s' already exists !", random_id);
1145 res = random_generate(random);
1147 bprintf("%s%d", random_id,
1148 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1149 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1154 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1155 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1156 for (i = start; i <= end; i++) {
1157 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1158 "Custom Random '%s' already exists !", bprintf("%s%d",
1161 res = random_generate(random);
1162 tmpbuf = bprintf("%s%d", random_id, i);
1163 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1168 XBT_CRITICAL("Malformed radical");
1171 res = random_generate(random);
1172 rd_name = bprintf("%s_router", random_id);
1173 rd_value = bprintf("%f", res);
1174 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1176 xbt_dynar_free(&radical_ends);
1179 xbt_dynar_free(&radical_elements);
1183 void routing_register_callbacks()
1185 sg_platf_host_add_cb(parse_S_host);
1186 sg_platf_router_add_cb(parse_S_router);
1188 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1190 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1191 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1192 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1193 &routing_parse_S_bypassRoute);
1195 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1197 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1198 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1199 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1200 &routing_parse_E_bypassRoute);
1202 sg_platf_cluster_add_cb(routing_parse_cluster);
1204 sg_platf_peer_add_cb(routing_parse_peer);
1205 sg_platf_postparse_add_cb(routing_parse_postparse);
1207 sg_platf_storage_add_cb(routing_parse_storage);
1208 sg_platf_mstorage_add_cb(routing_parse_mstorage);
1209 sg_platf_storage_type_add_cb(routing_parse_storage_type);
1210 sg_platf_mount_add_cb(routing_parse_mount);
1213 instr_routing_define_callbacks();
1218 * \brief Recursive function for finalize
1220 * \param rc the source host name
1222 * This fuction is call by "finalize". It allow to finalize the
1223 * AS or routing components. It delete all the structures.
1225 static void finalize_rec(AS_t as) {
1226 xbt_dict_cursor_t cursor = NULL;
1230 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1237 /** \brief Frees all memory allocated by the routing module */
1238 void routing_exit(void) {
1239 if (!global_routing)
1241 xbt_dynar_free(&global_routing->last_route);
1242 finalize_rec(global_routing->root);
1243 xbt_free(global_routing);