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_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 info = xbt_new0(s_network_element_t, 1);
112 info->rc_component = current_routing;
113 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
114 info->name = xbt_strdup(host->id);
115 info->id = current_routing->parse_PU(current_routing, host->id);
116 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
117 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
120 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
124 if (host->coord && strcmp(host->coord, "")) {
128 if (!COORD_HOST_LEVEL)
129 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
130 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
131 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
132 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
133 xbt_dynar_foreach(ctn_str,cursor, str) {
134 double val = atof(str);
135 xbt_dynar_push(ctn,&val);
137 xbt_dynar_shrink(ctn, 0);
138 xbt_dynar_free(&ctn_str);
139 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
140 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
145 * \brief Add a "router" to the network element list
147 static void parse_S_router(sg_platf_router_cbarg_t router)
149 network_element_t info = NULL;
150 if (current_routing->hierarchy == SURF_ROUTING_NULL)
151 current_routing->hierarchy = SURF_ROUTING_BASE;
152 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
153 "Reading a router, processing unit \"%s\" already exists",
156 info = xbt_new0(s_network_element_t, 1);
157 info->rc_component = current_routing;
158 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
159 info->name = xbt_strdup(router->id);
160 info->id = current_routing->parse_PU(current_routing, router->id);
161 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
162 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
164 if (strcmp(router->coord, "")) {
168 if (!COORD_ASR_LEVEL)
169 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
170 /* Pre-parse the host coordinates */
171 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
172 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
173 xbt_dynar_foreach(ctn_str,cursor, str) {
174 double val = atof(str);
175 xbt_dynar_push(ctn,&val);
177 xbt_dynar_shrink(ctn, 0);
178 xbt_dynar_free(&ctn_str);
179 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
180 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
186 * \brief Set the end points for a route
188 static void routing_parse_S_route(void)
190 if (src != NULL && dst != NULL && parsed_link_list != NULL)
191 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
192 A_surfxml_route_src, A_surfxml_route_dst);
193 src = A_surfxml_route_src;
194 dst = A_surfxml_route_dst;
195 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
196 "Some limits are null in the route between \"%s\" and \"%s\"",
198 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
202 * \brief Set the end points and gateways for a ASroute
204 static void routing_parse_S_ASroute(void)
206 if (src != NULL && dst != NULL && parsed_link_list != NULL)
207 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
208 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
209 src = A_surfxml_ASroute_src;
210 dst = A_surfxml_ASroute_dst;
211 gw_src = A_surfxml_ASroute_gw_src;
212 gw_dst = A_surfxml_ASroute_gw_dst;
213 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
214 || strlen(gw_dst) > 0,
215 "Some limits are null in the route between \"%s\" and \"%s\"",
217 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
221 * \brief Set the end points for a bypassRoute
223 static void routing_parse_S_bypassRoute(void)
225 if (src != NULL && dst != NULL && parsed_link_list != NULL)
227 "Bypass Route between %s to %s can not be defined",
228 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
229 src = A_surfxml_bypassRoute_src;
230 dst = A_surfxml_bypassRoute_dst;
231 gw_src = A_surfxml_bypassRoute_gw_src;
232 gw_dst = A_surfxml_bypassRoute_gw_dst;
233 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
234 || strlen(gw_dst) > 0,
235 "Some limits are null in the route between \"%s\" and \"%s\"",
237 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
241 * \brief Set a new link on the actual list of link for a route or ASroute from XML
244 static void routing_parse_link_ctn(void)
247 switch (A_surfxml_link_ctn_direction) {
248 case AU_surfxml_link_ctn_direction:
249 case A_surfxml_link_ctn_direction_NONE:
250 link_id = xbt_strdup(A_surfxml_link_ctn_id);
252 case A_surfxml_link_ctn_direction_UP:
253 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
255 case A_surfxml_link_ctn_direction_DOWN:
256 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
259 xbt_dynar_push(parsed_link_list, &link_id);
263 * \brief Store the route by calling the set_route function of the current routing component
265 static void routing_parse_E_route(void)
267 route_t route = xbt_new0(s_route_t, 1);
268 route->link_list = parsed_link_list;
269 xbt_assert(current_routing->parse_route,
270 "no defined method \"set_route\" in \"%s\"",
271 current_routing->name);
272 current_routing->parse_route(current_routing, src, dst, route);
273 generic_free_route(route);
274 parsed_link_list = NULL;
280 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
282 static void routing_parse_E_ASroute(void)
284 route_t e_route = xbt_new0(s_route_t, 1);
285 e_route->link_list = parsed_link_list;
287 if(!strcmp(current_routing->model_desc->name,"RuleBased")) {
288 e_route->src_gateway = (network_element_t) gw_src; // DIRTY HACK possible only
289 e_route->dst_gateway = (network_element_t) gw_dst; // because of what is in routing_parse_E_ASroute
292 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_src,ROUTING_ASR_LEVEL));
293 if(!e_route->src_gateway)
294 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_src,ROUTING_HOST_LEVEL));
295 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_dst,ROUTING_ASR_LEVEL));
296 if(!e_route->dst_gateway)
297 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_dst,ROUTING_HOST_LEVEL));
299 xbt_assert(current_routing->parse_ASroute,
300 "no defined method \"set_ASroute\" in \"%s\"",
301 current_routing->name);
302 current_routing->parse_ASroute(current_routing, src, dst, e_route);
303 generic_free_route(e_route);
304 parsed_link_list = NULL;
312 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
314 static void routing_parse_E_bypassRoute(void)
316 route_t e_route = xbt_new0(s_route_t, 1);
317 e_route->link_list = parsed_link_list;
318 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_src,ROUTING_ASR_LEVEL));
319 if(!e_route->src_gateway)
320 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_src,ROUTING_HOST_LEVEL));
321 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_dst,ROUTING_ASR_LEVEL));
322 if(!e_route->dst_gateway)
323 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_dst,ROUTING_HOST_LEVEL));
324 xbt_assert(current_routing->parse_bypassroute,
325 "Bypassing mechanism not implemented by routing '%s'",
326 current_routing->name);
327 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
328 parsed_link_list = NULL;
336 * \brief Make a new routing component to the platform
338 * Add a new autonomous system to the platform. Any elements (such as host,
339 * router or sub-AS) added after this call and before the corresponding call
340 * to sg_platf_new_AS_close() will be added to this AS.
342 * Once this function was called, the configuration concerning the used
343 * models cannot be changed anymore.
345 * @param AS_id name of this autonomous system. Must be unique in the platform
346 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
348 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
351 routing_model_description_t model = NULL;
354 xbt_assert(!xbt_lib_get_or_null
355 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
356 "The AS \"%s\" already exists", AS_id);
358 /* search the routing model */
359 for (cpt = 0; routing_models[cpt].name; cpt++)
360 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
361 model = &routing_models[cpt];
362 /* if its not exist, error */
364 fprintf(stderr, "Routing model %s not found. Existing models:\n",
365 wanted_routing_type);
366 for (cpt = 0; routing_models[cpt].name; cpt++)
367 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
368 routing_models[cpt].desc);
372 /* make a new routing component */
373 new_as = (AS_t) model->create();
374 new_as->model_desc = model;
375 new_as->hierarchy = SURF_ROUTING_NULL;
376 new_as->name = xbt_strdup(AS_id);
378 network_element_t info = NULL;
379 info = xbt_new0(s_network_element_t, 1);
381 if (current_routing == NULL && global_routing->root == NULL) {
383 /* it is the first one */
384 new_as->routing_father = NULL;
385 global_routing->root = new_as;
387 } else if (current_routing != NULL && global_routing->root != NULL) {
389 xbt_assert(!xbt_dict_get_or_null
390 (current_routing->routing_sons, AS_id),
391 "The AS \"%s\" already exists", AS_id);
392 /* it is a part of the tree */
393 new_as->routing_father = current_routing;
394 /* set the father behavior */
395 if (current_routing->hierarchy == SURF_ROUTING_NULL)
396 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
397 /* add to the sons dictionary */
398 xbt_dict_set(current_routing->routing_sons, AS_id,
399 (void *) new_as, NULL);
400 /* add to the father element list */
401 info->id = current_routing->parse_AS(current_routing, AS_id);
403 THROWF(arg_error, 0, "All defined components must be belong to a AS");
406 info->rc_component = new_as->routing_father;
407 info->rc_type = SURF_NETWORK_ELEMENT_AS;
408 info->name = new_as->name;
410 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
412 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
414 /* set the new current component of the tree */
415 current_routing = new_as;
416 current_routing->net_elem = info;
421 * \brief Specify that the current description of AS is finished
423 * Once you've declared all the content of your AS, you have to close
424 * it with this call. Your AS is not usable until you call this function.
426 * @fixme: this call is not as robust as wanted: bad things WILL happen
427 * if you call it twice for the same AS, or if you forget calling it, or
428 * even if you add stuff to a closed AS
431 void routing_AS_end()
434 if (current_routing == NULL) {
435 THROWF(arg_error, 0, "Close an AS, but none was under construction");
437 if (current_routing->model_desc->end)
438 current_routing->model_desc->end(current_routing);
439 current_routing = current_routing->routing_father;
443 /* Aux Business methods */
446 * \brief Get the AS father and the first elements of the chain
448 * \param src the source host name
449 * \param dst the destination host name
451 * Get the common father of the to processing units, and the first different
452 * father in the chain
454 static void elements_father(network_element_t src, network_element_t dst,
459 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
460 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
462 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
463 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
471 /* (1) find the as where the src and dst are located */
472 network_element_t src_data = src;
473 network_element_t dst_data = dst;
474 src_as = src_data->rc_component;
475 dst_as = dst_data->rc_component;
476 char* src_name = src_data->name;
477 char* dst_name = dst_data->name;
479 xbt_assert(src_as && dst_as,
480 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
482 /* (2) find the path to the root routing component */
483 for (current = src_as; current != NULL; current = current->routing_father) {
484 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
485 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
486 path_src[index_src++] = current;
488 for (current = dst_as; current != NULL; current = current->routing_father) {
489 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
490 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
491 path_dst[index_dst++] = current;
494 /* (3) find the common father */
496 current_src = path_src[--index_src];
497 current_dst = path_dst[--index_dst];
498 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
500 /* (4) they are not in the same routing component, make the path */
501 if (current_src == current_dst)
502 father = current_src;
504 father = path_src[index_src + 1];
506 /* (5) result generation */
507 *res_father = father; /* first the common father of src and dst */
508 *res_src = current_src; /* second the first different father of src */
509 *res_dst = current_dst; /* three the first different father of dst */
511 #undef ELEMENTS_FATHER_MAXDEPTH
514 /* Global Business methods */
517 * \brief Recursive function for get_route_latency
519 * \param src the source host name
520 * \param dst the destination host name
521 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
522 * \param *latency the latency, if needed
524 * This function is called by "get_route" and "get_latency". It allows to walk
525 * recursively through the ASes tree.
527 static void _get_route_and_latency(network_element_t src, network_element_t dst,
528 xbt_dynar_t * links, double *latency)
531 memset(&route,0,sizeof(route));
533 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
534 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
536 /* Find how src and dst are interconnected */
537 AS_t common_father, src_father, dst_father;
538 elements_father(src, dst, &common_father, &src_father, &dst_father);
539 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
540 common_father->name,src_father->name,dst_father->name);
542 /* If src and dst are in the same AS, life is good */
543 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
545 route.link_list = *links;
547 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
551 /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
553 route_t e_route_bypass = NULL;
554 if (common_father->get_bypass_route)
555 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
557 if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
559 xbt_die("Bypass cannot work yet with get_latency"); // FIXME: get_bypass_route should update the latency itself, just like get_route
561 // // FIXME this path is never tested. I need examples to check the bypass mechanism...
562 // THROW_UNIMPLEMENTED; // let's warn the users of the problem
563 xbt_dynar_merge(links,&(e_route_bypass->link_list));
564 generic_free_route(e_route_bypass);
568 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
570 route.link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
571 // Find the net_card corresponding to father
572 network_element_t src_father_net_elm = src_father->net_elem;
573 network_element_t dst_father_net_elm = dst_father->net_elem;
575 common_father->get_route_and_latency(common_father, src_father_net_elm, dst_father_net_elm, &route,latency);
577 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
578 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
580 network_element_t src_gateway_net_elm = route.src_gateway;
581 network_element_t dst_gateway_net_elm = route.dst_gateway;
583 /* If source gateway is not our source, we have to recursively find our way up to this point */
584 if (strcmp(src->name, src_gateway_net_elm->name))
585 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
587 xbt_dynar_merge(links,&(route.link_list));
589 /* If dest gateway is not our destination, we have to recursively find our way from this point */
590 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
591 if (strcmp(dst_gateway_net_elm->name, dst->name)) {
592 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
594 xbt_dynar_free(&route.link_list);
598 * \brief Find a route between hosts
600 * \param src the source host name
601 * \param dst the destination host name
602 * \param route where to store the list of links.
603 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
604 * \param latency where to store the latency experienced on the path (or NULL if not interested)
605 * It is the caller responsability to initialize latency to 0 (we add to provided route)
608 * walk through the routing components tree and find a route between hosts
609 * by calling the differents "get_route" functions in each routing component.
611 void routing_get_route_and_latency(network_element_t src, network_element_t dst,
612 xbt_dynar_t * route, double *latency)
615 xbt_dynar_reset(global_routing->last_route);
616 *route = global_routing->last_route;
619 _get_route_and_latency(src, dst, route, latency);
621 xbt_assert(!latency || *latency >= 0.0,
622 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
625 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
627 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
629 //adding my one link routes
630 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
632 xbt_dynar_merge(&ret,&onelink_mine);
636 xbt_dict_cursor_t cursor = NULL;
638 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
639 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
641 xbt_dynar_merge(&ret,&onelink_child);
646 static xbt_dynar_t get_onelink_routes(void)
648 return recursive_get_onelink_routes(global_routing->root);
651 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
653 network_element_t rc = NULL;
655 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
659 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
663 return SURF_NETWORK_ELEMENT_NULL;
667 * \brief Generic method: create the global routing schema
669 * Make a global routing structure and set all the parsing functions.
671 void routing_model_create(size_t size_of_links, void *loopback)
673 /* config the uniq global routing */
674 global_routing = xbt_new0(s_routing_global_t, 1);
675 global_routing->root = NULL;
676 global_routing->get_onelink_routes = get_onelink_routes;
677 global_routing->loopback = loopback;
678 global_routing->size_of_link = size_of_links;
679 global_routing->last_route = xbt_dynar_new(global_routing->size_of_link,NULL);
680 /* no current routing at moment */
681 current_routing = NULL;
685 /* ************************************************** */
686 /* ********** PATERN FOR NEW ROUTING **************** */
688 /* The minimal configuration of a new routing model need the next functions,
689 * also you need to set at the start of the file, the new model in the model
690 * list. Remember keep the null ending of the list.
692 /*** Routing model structure ***/
694 // s_routing_component_t generic_routing;
695 // /* things that your routing model need */
696 // } s_routing_component_NEW_t,*routing_component_NEW_t;
698 /*** Parse routing model functions ***/
699 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
700 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
701 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
702 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
703 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
705 /*** Business methods ***/
706 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
707 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
708 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
710 /*** Creation routing model functions ***/
711 // static void* model_NEW_create(void) {
712 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
713 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
714 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
715 // new_component->generic_routing.set_route = model_NEW_set_route;
716 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
717 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
718 // new_component->generic_routing.get_route = NEW_get_route;
719 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
720 // new_component->generic_routing.finalize = NEW_finalize;
721 // /* initialization of internal structures */
722 // return new_component;
724 // static void model_NEW_load(void) {} /* mandatory */
725 // static void model_NEW_unload(void) {} /* mandatory */
726 // static void model_NEW_end(void) {} /* mandatory */
728 /* ************************************************************************** */
729 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
731 static void routing_parse_storage(sg_platf_storage_cbarg_t storage)
733 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
734 "Reading a storage, processing unit \"%s\" already exists", storage->id);
736 // Verification of an existing type_id
737 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
738 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
740 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s'",
744 xbt_lib_set(storage_lib,
746 ROUTING_STORAGE_LEVEL,
747 (void *) xbt_strdup(storage->type_id));
749 static void routing_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
751 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
752 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
754 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
755 stype->model = xbt_strdup(storage_type->model);
756 stype->properties = storage_type->properties;
757 stype->content = xbt_strdup(storage_type->content);
758 stype->type_id = xbt_strdup(storage_type->id);
760 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s' and properties '%p'",
766 xbt_lib_set(storage_type_lib,
768 ROUTING_STORAGE_TYPE_LEVEL,
771 static void routing_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
774 // mount_t mnt = xbt_new0(s_mount_t, 1);
775 // mnt->id = xbt_strdup(mstorage->type_id);
776 // mnt->name = xbt_strdup(mstorage->name);
779 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
780 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
782 // xbt_dynar_push(mount_list,(void *) mnt);
786 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
789 static void mount_free(void *p)
795 static void routing_parse_mount(sg_platf_mount_cbarg_t mount)
797 // Verification of an existing storage
798 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
799 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
801 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
804 mnt.id = surf_storage_resource_by_name(mount->id);
805 mnt.name = xbt_strdup(mount->name);
808 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
809 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
811 xbt_dynar_push(mount_list,&mnt);
814 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
816 char *host_id, *groups, *link_id = NULL;
817 xbt_dict_t patterns = NULL;
819 s_sg_platf_host_cbarg_t host;
820 s_sg_platf_link_cbarg_t link;
824 xbt_dynar_t radical_elements;
825 xbt_dynar_t radical_ends;
827 if (strcmp(cluster->availability_trace, "")
828 || strcmp(cluster->state_trace, "")) {
829 patterns = xbt_dict_new_homogeneous(xbt_free_f);
830 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
831 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
832 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
836 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
837 sg_platf_new_AS_begin(cluster->id, "Cluster");
840 radical_elements = xbt_str_split(cluster->radical, ",");
841 xbt_dynar_foreach(radical_elements, iter, groups) {
843 radical_ends = xbt_str_split(groups, "-");
844 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
846 switch (xbt_dynar_length(radical_ends)) {
851 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
854 surf_parse_error("Malformed radical");
857 for (i = start; i <= end; i++) {
859 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
860 link_id = bprintf("%s_link_%d", cluster->id, i);
862 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
864 memset(&host, 0, sizeof(host));
866 if (strcmp(cluster->availability_trace, "")) {
867 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
868 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
869 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
870 host.power_trace = tmgr_trace_new(avail_file);
871 xbt_free(avail_file);
873 XBT_DEBUG("\tavailability_file=\"\"");
876 if (strcmp(cluster->state_trace, "")) {
877 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
878 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
879 host.state_trace = tmgr_trace_new(avail_file);
880 xbt_free(avail_file);
882 XBT_DEBUG("\tstate_file=\"\"");
885 host.power_peak = cluster->power;
886 host.power_scale = 1.0;
887 host.core_amount = cluster->core_amount;
888 host.initial_state = SURF_RESOURCE_ON;
890 sg_platf_new_host(&host);
891 XBT_DEBUG("</host>");
893 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
894 cluster->bw, cluster->lat);
896 memset(&link, 0, sizeof(link));
898 link.bandwidth = cluster->bw;
899 link.latency = cluster->lat;
900 link.state = SURF_RESOURCE_ON;
901 link.policy = cluster->sharing_policy;
902 sg_platf_new_link(&link);
904 surf_parsing_link_up_down_t info =
905 xbt_new0(s_surf_parsing_link_up_down_t, 1);
906 if (link.policy == SURF_LINK_FULLDUPLEX) {
907 char *tmp_link = bprintf("%s_UP", link_id);
909 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
911 tmp_link = bprintf("%s_DOWN", link_id);
913 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
916 info->link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
917 info->link_down = info->link_up;
919 surf_routing_cluster_add_link(host_id, info);
925 xbt_dynar_free(&radical_ends);
927 xbt_dynar_free(&radical_elements);
929 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
930 // and it's very useful to connect clusters together
932 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
934 s_sg_platf_router_cbarg_t router;
935 memset(&router, 0, sizeof(router));
936 router.id = cluster->router_id;
938 if (!router.id || !strcmp(router.id, ""))
940 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
942 sg_platf_new_router(&router);
946 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
947 char *link_backbone = bprintf("%s_backbone", cluster->id);
948 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
949 cluster->bb_bw, cluster->bb_lat);
951 memset(&link, 0, sizeof(link));
952 link.id = link_backbone;
953 link.bandwidth = cluster->bb_bw;
954 link.latency = cluster->bb_lat;
955 link.state = SURF_RESOURCE_ON;
956 link.policy = cluster->bb_sharing_policy;
958 sg_platf_new_link(&link);
960 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
966 sg_platf_new_AS_end();
968 xbt_dict_free(&patterns); // no op if it were never set
971 static void routing_parse_postparse(void) {
972 xbt_dict_free(&random_value);
975 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
977 static int AX_ptr = 0;
978 char *host_id = NULL;
979 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
981 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
982 static unsigned int surfxml_buffer_stack_stack[1024];
984 surfxml_buffer_stack_stack[0] = 0;
986 surfxml_bufferstack_push(1);
988 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
989 sg_platf_new_AS_begin(peer->id, "Full");
992 host_id = HOST_PEER(peer->id);
993 router_id = ROUTER_PEER(peer->id);
994 link_id_up = LINK_UP_PEER(peer->id);
995 link_id_down = LINK_DOWN_PEER(peer->id);
997 link_router = bprintf("%s_link_router", peer->id);
998 link_backbone = bprintf("%s_backbone", peer->id);
1000 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1001 s_sg_platf_host_cbarg_t host;
1002 memset(&host, 0, sizeof(host));
1003 host.initial_state = SURF_RESOURCE_ON;
1005 host.power_peak = peer->power;
1006 host.power_scale = 1.0;
1007 host.power_trace = peer->availability_trace;
1008 host.state_trace = peer->state_trace;
1009 host.core_amount = 1;
1010 host.coord = peer->coord;
1011 sg_platf_new_host(&host);
1014 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1015 s_sg_platf_router_cbarg_t router;
1016 memset(&router, 0, sizeof(router));
1017 router.id = router_id;
1018 router.coord = peer->coord;
1019 sg_platf_new_router(&router);
1021 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1022 peer->bw_in, peer->lat);
1023 s_sg_platf_link_cbarg_t link;
1024 memset(&link, 0, sizeof(link));
1025 link.state = SURF_RESOURCE_ON;
1026 link.policy = SURF_LINK_SHARED;
1027 link.id = link_id_up;
1028 link.bandwidth = peer->bw_in;
1029 link.latency = peer->lat;
1030 sg_platf_new_link(&link);
1032 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1033 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1034 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1035 peer->bw_out, peer->lat);
1036 link.id = link_id_down;
1037 sg_platf_new_link(&link);
1042 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1043 XBT_DEBUG("symmetrical=\"NO\">");
1044 SURFXML_BUFFER_SET(route_src, host_id);
1045 SURFXML_BUFFER_SET(route_dst, router_id);
1046 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1047 SURFXML_START_TAG(route);
1049 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1050 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1051 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1052 SURFXML_START_TAG(link_ctn);
1053 SURFXML_END_TAG(link_ctn);
1055 XBT_DEBUG("</route>");
1056 SURFXML_END_TAG(route);
1059 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1060 XBT_DEBUG("symmetrical=\"NO\">");
1061 SURFXML_BUFFER_SET(route_src, router_id);
1062 SURFXML_BUFFER_SET(route_dst, host_id);
1063 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1064 SURFXML_START_TAG(route);
1066 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1067 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1068 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1069 SURFXML_START_TAG(link_ctn);
1070 SURFXML_END_TAG(link_ctn);
1072 XBT_DEBUG("</route>");
1073 SURFXML_END_TAG(route);
1076 sg_platf_new_AS_end();
1079 //xbt_dynar_free(&tab_elements_num);
1083 free(link_backbone);
1086 surfxml_bufferstack_pop(1);
1089 static void routing_parse_Srandom(void)
1091 double mean, std, min, max, seed;
1092 char *random_id = A_surfxml_random_id;
1093 char *random_radical = A_surfxml_random_radical;
1094 char *rd_name = NULL;
1096 mean = surf_parse_get_double(A_surfxml_random_mean);
1097 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1098 min = surf_parse_get_double(A_surfxml_random_min);
1099 max = surf_parse_get_double(A_surfxml_random_max);
1100 seed = surf_parse_get_double(A_surfxml_random_seed);
1104 random_data_t random = xbt_new0(s_random_data_t, 1);
1107 xbt_dynar_t radical_elements;
1111 xbt_dynar_t radical_ends;
1113 switch (A_surfxml_random_generator) {
1114 case AU_surfxml_random_generator:
1115 case A_surfxml_random_generator_NONE:
1116 random->generator = NONE;
1118 case A_surfxml_random_generator_DRAND48:
1119 random->generator = DRAND48;
1121 case A_surfxml_random_generator_RAND:
1122 random->generator = RAND;
1124 case A_surfxml_random_generator_RNGSTREAM:
1125 random->generator = RNGSTREAM;
1128 surf_parse_error("Invalid random generator");
1131 random->seed = seed;
1135 /* Check user stupidities */
1137 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1139 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1141 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1143 /* normalize the mean and standard deviation before storing */
1144 random->mean = (mean - min) / (max - min);
1145 random->std = std / (max - min);
1147 if (random->mean * (1 - random->mean) < random->std * random->std)
1148 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1149 random->mean, random->std);
1152 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1153 random_id, random->min, random->max, random->mean, random->std,
1154 (int)random->generator, random->seed, random_radical);
1157 random_value = xbt_dict_new_homogeneous(free);
1159 if (!strcmp(random_radical, "")) {
1160 res = random_generate(random);
1161 rd_value = bprintf("%f", res);
1162 xbt_dict_set(random_value, random_id, rd_value, NULL);
1164 radical_elements = xbt_str_split(random_radical, ",");
1165 xbt_dynar_foreach(radical_elements, iter, groups) {
1166 radical_ends = xbt_str_split(groups, "-");
1167 switch (xbt_dynar_length(radical_ends)) {
1169 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1170 "Custom Random '%s' already exists !", random_id);
1171 res = random_generate(random);
1173 bprintf("%s%d", random_id,
1174 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1175 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1180 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1181 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1182 for (i = start; i <= end; i++) {
1183 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1184 "Custom Random '%s' already exists !", bprintf("%s%d",
1187 res = random_generate(random);
1188 tmpbuf = bprintf("%s%d", random_id, i);
1189 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1194 XBT_CRITICAL("Malformed radical");
1197 res = random_generate(random);
1198 rd_name = bprintf("%s_router", random_id);
1199 rd_value = bprintf("%f", res);
1200 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1202 xbt_dynar_free(&radical_ends);
1205 xbt_dynar_free(&radical_elements);
1209 void routing_register_callbacks()
1211 sg_platf_host_add_cb(parse_S_host);
1212 sg_platf_router_add_cb(parse_S_router);
1214 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1216 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1217 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1218 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1219 &routing_parse_S_bypassRoute);
1221 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1223 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1224 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1225 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1226 &routing_parse_E_bypassRoute);
1228 sg_platf_cluster_add_cb(routing_parse_cluster);
1230 sg_platf_peer_add_cb(routing_parse_peer);
1231 sg_platf_postparse_add_cb(routing_parse_postparse);
1233 sg_platf_storage_add_cb(routing_parse_storage);
1234 sg_platf_mstorage_add_cb(routing_parse_mstorage);
1235 sg_platf_storage_type_add_cb(routing_parse_storage_type);
1236 sg_platf_mount_add_cb(routing_parse_mount);
1239 instr_routing_define_callbacks();
1244 * \brief Recursive function for finalize
1246 * \param rc the source host name
1248 * This fuction is call by "finalize". It allow to finalize the
1249 * AS or routing components. It delete all the structures.
1251 static void finalize_rec(AS_t as) {
1252 xbt_dict_cursor_t cursor = NULL;
1256 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1263 /** \brief Frees all memory allocated by the routing module */
1264 void routing_exit(void) {
1265 if (!global_routing)
1267 xbt_dynar_free(&global_routing->last_route);
1268 finalize_rec(global_routing->root);
1269 xbt_free(global_routing);