1 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include <pcre.h> /* regular expression library */
9 #include "simgrid/platf_interface.h" // platform creation API internal interface
11 #include "surf_routing_private.h"
12 #include "surf/surf_routing.h"
13 #include "surf/surfxml_parse_values.h"
16 * @ingroup SURF_build_api
17 * @brief A library containing all known workstations
21 int ROUTING_HOST_LEVEL; //Routing level
22 int SURF_CPU_LEVEL; //Surf cpu level
23 int SURF_WKS_LEVEL; //Surf workstation level
24 int SIMIX_HOST_LEVEL; //Simix level
25 int MSG_HOST_LEVEL; //Msg level
26 int SD_HOST_LEVEL; //Simdag level
27 int COORD_HOST_LEVEL=0; //Coordinates level
28 int NS3_HOST_LEVEL; //host node for ns3
31 * @ingroup SURF_build_api
32 * @brief A library containing all known links
35 int SD_LINK_LEVEL; //Simdag level
36 int SURF_LINK_LEVEL; //Surf level
37 int NS3_LINK_LEVEL; //link for ns3
39 xbt_lib_t as_router_lib;
40 int ROUTING_ASR_LEVEL; //Routing level
41 int COORD_ASR_LEVEL; //Coordinates level
42 int NS3_ASR_LEVEL; //host node for ns3
44 static xbt_dict_t random_value = NULL;
46 xbt_lib_t storage_lib;
47 int ROUTING_STORAGE_LEVEL; //Routing for storagelevel
48 int ROUTING_STORAGE_HOST_LEVEL;
49 int SURF_STORAGE_LEVEL;
51 xbt_lib_t storage_type_lib;
52 int ROUTING_STORAGE_TYPE_LEVEL; //Routing for storage_type level
55 routing_global_t global_routing = NULL;
56 AS_t current_routing = NULL;
58 /* global parse functions */
59 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
60 xbt_dynar_t mount_list = NULL; /* temporary store of current mount storage */
61 static const char *src = NULL; /* temporary store the source name of a route */
62 static const char *dst = NULL; /* temporary store the destination name of a route */
63 static char *gw_src = NULL; /* temporary store the gateway source name of a route */
64 static char *gw_dst = NULL; /* temporary store the gateway destination name of a route */
66 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
68 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
69 static void routing_parse_Srandom(void); /* random bypass */
71 static void routing_parse_postparse(void);
73 /* this lines are only for replace use like index in the model table */
78 SURF_MODEL_DIJKSTRACACHE,
85 struct s_model_type routing_models[] = {
87 "Full routing data (fast, large memory requirements, fully expressive)",
88 model_full_create, model_full_end},
90 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
91 model_floyd_create, model_floyd_end},
93 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
94 model_dijkstra_create, model_dijkstra_both_end},
96 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
97 model_dijkstracache_create, model_dijkstra_both_end},
98 {"none", "No routing (usable with Constant network only)",
99 model_none_create, NULL},
100 {"RuleBased", "Rule-Based routing data (...)",
101 model_rulebased_create, NULL},
102 {"Vivaldi", "Vivaldi routing",
103 model_vivaldi_create, NULL},
104 {"Cluster", "Cluster routing",
105 model_cluster_create, NULL},
106 {NULL, NULL, NULL, NULL}
110 * \brief Add a "host" to the network element list
112 static void parse_S_host(sg_platf_host_cbarg_t host)
114 network_element_t info = NULL;
115 if (current_routing->hierarchy == SURF_ROUTING_NULL)
116 current_routing->hierarchy = SURF_ROUTING_BASE;
117 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
118 "Reading a host, processing unit \"%s\" already exists", host->id);
120 info = xbt_new0(s_network_element_t, 1);
121 info->rc_component = current_routing;
122 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
123 info->name = xbt_strdup(host->id);
124 info->id = current_routing->parse_PU(current_routing, (void *) info);
125 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
126 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
129 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
133 if (host->coord && strcmp(host->coord, "")) {
137 if (!COORD_HOST_LEVEL)
138 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
139 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
140 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
141 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
142 xbt_dynar_foreach(ctn_str,cursor, str) {
143 double val = atof(str);
144 xbt_dynar_push(ctn,&val);
146 xbt_dynar_shrink(ctn, 0);
147 xbt_dynar_free(&ctn_str);
148 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
149 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
154 * \brief Add a "router" to the network element list
156 static void parse_S_router(sg_platf_router_cbarg_t router)
158 network_element_t info = NULL;
159 if (current_routing->hierarchy == SURF_ROUTING_NULL)
160 current_routing->hierarchy = SURF_ROUTING_BASE;
161 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
162 "Reading a router, processing unit \"%s\" already exists",
165 info = xbt_new0(s_network_element_t, 1);
166 info->rc_component = current_routing;
167 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
168 info->name = xbt_strdup(router->id);
169 info->id = current_routing->parse_PU(current_routing, (void *) info);
170 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
171 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
173 if (strcmp(router->coord, "")) {
177 if (!COORD_ASR_LEVEL)
178 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
179 /* Pre-parse the host coordinates */
180 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
181 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
182 xbt_dynar_foreach(ctn_str,cursor, str) {
183 double val = atof(str);
184 xbt_dynar_push(ctn,&val);
186 xbt_dynar_shrink(ctn, 0);
187 xbt_dynar_free(&ctn_str);
188 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
189 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
195 * \brief Set the end points for a route
197 static void routing_parse_S_route(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_route_src, A_surfxml_route_dst);
202 src = A_surfxml_route_src;
203 dst = A_surfxml_route_dst;
204 xbt_assert(strlen(src) > 0 || strlen(dst) > 0,
205 "Some limits are null in the route between \"%s\" and \"%s\"",
207 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
211 * \brief Set the end points and gateways for a ASroute
213 static void routing_parse_S_ASroute(void)
215 if (src != NULL && dst != NULL && parsed_link_list != NULL)
216 THROWF(arg_error, 0, "Route between %s to %s can not be defined",
217 A_surfxml_ASroute_src, A_surfxml_ASroute_dst);
218 src = A_surfxml_ASroute_src;
219 dst = A_surfxml_ASroute_dst;
220 gw_src = A_surfxml_ASroute_gw_src;
221 gw_dst = A_surfxml_ASroute_gw_dst;
222 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
223 || strlen(gw_dst) > 0,
224 "Some limits are null in the route between \"%s\" and \"%s\"",
226 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
230 * \brief Set the end points for a bypassRoute
232 static void routing_parse_S_bypassRoute(void)
234 if (src != NULL && dst != NULL && parsed_link_list != NULL)
236 "Bypass Route between %s to %s can not be defined",
237 A_surfxml_bypassRoute_src, A_surfxml_bypassRoute_dst);
238 src = A_surfxml_bypassRoute_src;
239 dst = A_surfxml_bypassRoute_dst;
240 gw_src = A_surfxml_bypassRoute_gw_src;
241 gw_dst = A_surfxml_bypassRoute_gw_dst;
242 xbt_assert(strlen(src) > 0 || strlen(dst) > 0 || strlen(gw_src) > 0
243 || strlen(gw_dst) > 0,
244 "Some limits are null in the route between \"%s\" and \"%s\"",
246 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
250 * \brief Set a new link on the actual list of link for a route or ASroute from XML
253 static void routing_parse_link_ctn(void)
256 switch (A_surfxml_link_ctn_direction) {
257 case AU_surfxml_link_ctn_direction:
258 case A_surfxml_link_ctn_direction_NONE:
259 link_id = xbt_strdup(A_surfxml_link_ctn_id);
261 case A_surfxml_link_ctn_direction_UP:
262 link_id = bprintf("%s_UP", A_surfxml_link_ctn_id);
264 case A_surfxml_link_ctn_direction_DOWN:
265 link_id = bprintf("%s_DOWN", A_surfxml_link_ctn_id);
268 xbt_dynar_push(parsed_link_list, &link_id);
272 * \brief Store the route by calling the set_route function of the current routing component
274 static void routing_parse_E_route(void)
276 route_t route = xbt_new0(s_route_t, 1);
277 route->link_list = parsed_link_list;
278 xbt_assert(current_routing->parse_route,
279 "no defined method \"set_route\" in \"%s\"",
280 current_routing->name);
281 current_routing->parse_route(current_routing, src, dst, route);
282 generic_free_route(route);
283 parsed_link_list = NULL;
289 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
291 static void routing_parse_E_ASroute(void)
293 route_t e_route = xbt_new0(s_route_t, 1);
294 e_route->link_list = parsed_link_list;
296 if(!strcmp(current_routing->model_desc->name,"RuleBased")) {
297 e_route->src_gateway = (network_element_t) gw_src; // DIRTY HACK possible only
298 e_route->dst_gateway = (network_element_t) gw_dst; // because of what is in routing_parse_E_ASroute
301 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_src,ROUTING_ASR_LEVEL));
302 if(!e_route->src_gateway)
303 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_src,ROUTING_HOST_LEVEL));
304 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_dst,ROUTING_ASR_LEVEL));
305 if(!e_route->dst_gateway)
306 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_dst,ROUTING_HOST_LEVEL));
308 xbt_assert(current_routing->parse_ASroute,
309 "no defined method \"set_ASroute\" in \"%s\"",
310 current_routing->name);
311 current_routing->parse_ASroute(current_routing, src, dst, e_route);
312 generic_free_route(e_route);
313 parsed_link_list = NULL;
321 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
323 static void routing_parse_E_bypassRoute(void)
325 route_t e_route = xbt_new0(s_route_t, 1);
326 e_route->link_list = parsed_link_list;
327 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_src,ROUTING_ASR_LEVEL));
328 if(!e_route->src_gateway)
329 e_route->src_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_src,ROUTING_HOST_LEVEL));
330 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(as_router_lib,gw_dst,ROUTING_ASR_LEVEL));
331 if(!e_route->dst_gateway)
332 e_route->dst_gateway = ((network_element_t)xbt_lib_get_or_null(host_lib,gw_dst,ROUTING_HOST_LEVEL));
333 xbt_assert(current_routing->parse_bypassroute,
334 "Bypassing mechanism not implemented by routing '%s'",
335 current_routing->name);
336 current_routing->parse_bypassroute(current_routing, src, dst, e_route);
337 parsed_link_list = NULL;
345 * \brief Make a new routing component to the platform
347 * Add a new autonomous system to the platform. Any elements (such as host,
348 * router or sub-AS) added after this call and before the corresponding call
349 * to sg_platf_new_AS_close() will be added to this AS.
351 * Once this function was called, the configuration concerning the used
352 * models cannot be changed anymore.
354 * @param AS_id name of this autonomous system. Must be unique in the platform
355 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
357 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
360 routing_model_description_t model = NULL;
363 xbt_assert(!xbt_lib_get_or_null
364 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
365 "The AS \"%s\" already exists", AS_id);
367 /* search the routing model */
368 for (cpt = 0; routing_models[cpt].name; cpt++)
369 if (!strcmp(wanted_routing_type, routing_models[cpt].name))
370 model = &routing_models[cpt];
371 /* if its not exist, error */
373 fprintf(stderr, "Routing model %s not found. Existing models:\n",
374 wanted_routing_type);
375 for (cpt = 0; routing_models[cpt].name; cpt++)
376 fprintf(stderr, " %s: %s\n", routing_models[cpt].name,
377 routing_models[cpt].desc);
381 /* make a new routing component */
382 new_as = (AS_t) model->create();
383 new_as->model_desc = model;
384 new_as->hierarchy = SURF_ROUTING_NULL;
385 new_as->name = xbt_strdup(AS_id);
387 network_element_t info = NULL;
388 info = xbt_new0(s_network_element_t, 1);
390 if (current_routing == NULL && global_routing->root == NULL) {
392 /* it is the first one */
393 new_as->routing_father = NULL;
394 global_routing->root = new_as;
396 } else if (current_routing != NULL && global_routing->root != NULL) {
398 xbt_assert(!xbt_dict_get_or_null
399 (current_routing->routing_sons, AS_id),
400 "The AS \"%s\" already exists", AS_id);
401 /* it is a part of the tree */
402 new_as->routing_father = current_routing;
403 /* set the father behavior */
404 if (current_routing->hierarchy == SURF_ROUTING_NULL)
405 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
406 /* add to the sons dictionary */
407 xbt_dict_set(current_routing->routing_sons, AS_id,
408 (void *) new_as, NULL);
409 /* add to the father element list */
410 info->id = current_routing->parse_AS(current_routing, (void *) info);
412 THROWF(arg_error, 0, "All defined components must be belong to a AS");
415 info->rc_component = new_as->routing_father;
416 info->rc_type = SURF_NETWORK_ELEMENT_AS;
417 info->name = new_as->name;
419 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
421 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
423 /* set the new current component of the tree */
424 current_routing = new_as;
425 current_routing->net_elem = info;
430 * \brief Specify that the current description of AS is finished
432 * Once you've declared all the content of your AS, you have to close
433 * it with this call. Your AS is not usable until you call this function.
435 * @fixme: this call is not as robust as wanted: bad things WILL happen
436 * if you call it twice for the same AS, or if you forget calling it, or
437 * even if you add stuff to a closed AS
440 void routing_AS_end()
443 if (current_routing == NULL) {
444 THROWF(arg_error, 0, "Close an AS, but none was under construction");
446 if (current_routing->model_desc->end)
447 current_routing->model_desc->end(current_routing);
448 current_routing = current_routing->routing_father;
452 /* Aux Business methods */
455 * \brief Get the AS father and the first elements of the chain
457 * \param src the source host name
458 * \param dst the destination host name
460 * Get the common father of the to processing units, and the first different
461 * father in the chain
463 static void elements_father(network_element_t src, network_element_t dst,
468 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
469 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
471 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
472 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
480 /* (1) find the as where the src and dst are located */
481 network_element_t src_data = src;
482 network_element_t dst_data = dst;
483 src_as = src_data->rc_component;
484 dst_as = dst_data->rc_component;
485 char* src_name = src_data->name;
486 char* dst_name = dst_data->name;
488 xbt_assert(src_as && dst_as,
489 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
491 /* (2) find the path to the root routing component */
492 for (current = src_as; current != NULL; current = current->routing_father) {
493 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
494 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
495 path_src[index_src++] = current;
497 for (current = dst_as; current != NULL; current = current->routing_father) {
498 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
499 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
500 path_dst[index_dst++] = current;
503 /* (3) find the common father */
505 current_src = path_src[--index_src];
506 current_dst = path_dst[--index_dst];
507 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
509 /* (4) they are not in the same routing component, make the path */
510 if (current_src == current_dst)
511 father = current_src;
513 father = path_src[index_src + 1];
515 /* (5) result generation */
516 *res_father = father; /* first the common father of src and dst */
517 *res_src = current_src; /* second the first different father of src */
518 *res_dst = current_dst; /* three the first different father of dst */
520 #undef ELEMENTS_FATHER_MAXDEPTH
523 /* Global Business methods */
526 * \brief Recursive function for get_route_latency
528 * \param src the source host name
529 * \param dst the destination host name
530 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
531 * \param *latency the latency, if needed
533 * This function is called by "get_route" and "get_latency". It allows to walk
534 * recursively through the ASes tree.
536 static void _get_route_and_latency(network_element_t src, network_element_t dst,
537 xbt_dynar_t * links, double *latency)
540 memset(&route,0,sizeof(route));
542 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
543 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
545 /* Find how src and dst are interconnected */
546 AS_t common_father, src_father, dst_father;
547 elements_father(src, dst, &common_father, &src_father, &dst_father);
548 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
549 common_father->name,src_father->name,dst_father->name);
551 /* If src and dst are in the same AS, life is good */
552 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
554 route.link_list = *links;
556 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
560 /* If we are here, src and dst are not in the same AS; check whether a direct bypass is defined */
562 route_t e_route_bypass = NULL;
563 if (common_father->get_bypass_route)
564 e_route_bypass = common_father->get_bypass_route(common_father, src, dst);
566 if (e_route_bypass) { /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
568 xbt_die("Bypass cannot work yet with get_latency"); // FIXME: get_bypass_route should update the latency itself, just like get_route
570 // // FIXME this path is never tested. I need examples to check the bypass mechanism...
571 // THROW_UNIMPLEMENTED; // let's warn the users of the problem
572 xbt_dynar_merge(links,&(e_route_bypass->link_list));
573 generic_free_route(e_route_bypass);
577 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
579 route.link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
580 // Find the net_card corresponding to father
581 network_element_t src_father_net_elm = src_father->net_elem;
582 network_element_t dst_father_net_elm = dst_father->net_elem;
584 common_father->get_route_and_latency(common_father, src_father_net_elm, dst_father_net_elm, &route,latency);
586 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
587 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
589 network_element_t src_gateway_net_elm = route.src_gateway;
590 network_element_t dst_gateway_net_elm = route.dst_gateway;
592 /* If source gateway is not our source, we have to recursively find our way up to this point */
593 if (strcmp(src->name, src_gateway_net_elm->name))
594 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
596 xbt_dynar_merge(links,&(route.link_list));
598 /* If dest gateway is not our destination, we have to recursively find our way from this point */
599 // FIXME why can't I factorize it the same way than [src;src_gw] without breaking the examples??
600 if (strcmp(dst_gateway_net_elm->name, dst->name)) {
601 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
603 xbt_dynar_free(&route.link_list);
607 * \brief Find a route between hosts
609 * \param src the network_element_t for src host
610 * \param dst the network_element_t for dst host
611 * \param route where to store the list of links.
612 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
613 * \param latency where to store the latency experienced on the path (or NULL if not interested)
614 * It is the caller responsability to initialize latency to 0 (we add to provided route)
617 * walk through the routing components tree and find a route between hosts
618 * by calling the differents "get_route" functions in each routing component.
620 void routing_get_route_and_latency(network_element_t src, network_element_t dst,
621 xbt_dynar_t * route, double *latency)
624 xbt_dynar_reset(global_routing->last_route);
625 *route = global_routing->last_route;
628 _get_route_and_latency(src, dst, route, latency);
630 xbt_assert(!latency || *latency >= 0.0,
631 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
634 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
636 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
638 //adding my one link routes
639 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
641 xbt_dynar_merge(&ret,&onelink_mine);
645 xbt_dict_cursor_t cursor = NULL;
647 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
648 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
650 xbt_dynar_merge(&ret,&onelink_child);
655 static xbt_dynar_t get_onelink_routes(void)
657 return recursive_get_onelink_routes(global_routing->root);
660 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
662 network_element_t rc = NULL;
664 rc = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
668 rc = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
672 return SURF_NETWORK_ELEMENT_NULL;
676 * \brief Generic method: create the global routing schema
678 * Make a global routing structure and set all the parsing functions.
680 void routing_model_create(size_t size_of_links, void *loopback)
682 /* config the uniq global routing */
683 global_routing = xbt_new0(s_routing_global_t, 1);
684 global_routing->root = NULL;
685 global_routing->get_onelink_routes = get_onelink_routes;
686 global_routing->loopback = loopback;
687 global_routing->size_of_link = size_of_links;
688 global_routing->last_route = xbt_dynar_new(global_routing->size_of_link,NULL);
689 /* no current routing at moment */
690 current_routing = NULL;
694 /* ************************************************** */
695 /* ********** PATERN FOR NEW ROUTING **************** */
697 /* The minimal configuration of a new routing model need the next functions,
698 * also you need to set at the start of the file, the new model in the model
699 * list. Remember keep the null ending of the list.
701 /*** Routing model structure ***/
703 // s_routing_component_t generic_routing;
704 // /* things that your routing model need */
705 // } s_routing_component_NEW_t,*routing_component_NEW_t;
707 /*** Parse routing model functions ***/
708 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
709 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
710 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
711 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
712 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
714 /*** Business methods ***/
715 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
716 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
717 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
719 /*** Creation routing model functions ***/
720 // static void* model_NEW_create(void) {
721 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
722 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
723 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
724 // new_component->generic_routing.set_route = model_NEW_set_route;
725 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
726 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
727 // new_component->generic_routing.get_route = NEW_get_route;
728 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
729 // new_component->generic_routing.finalize = NEW_finalize;
730 // /* initialization of internal structures */
731 // return new_component;
733 // static void model_NEW_load(void) {} /* mandatory */
734 // static void model_NEW_unload(void) {} /* mandatory */
735 // static void model_NEW_end(void) {} /* mandatory */
737 /* ************************************************************************** */
738 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
740 static void routing_parse_storage(sg_platf_storage_cbarg_t storage)
742 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
743 "Reading a storage, processing unit \"%s\" already exists", storage->id);
745 // Verification of an existing type_id
746 void* storage_type = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
747 xbt_assert(storage_type,"Reading a storage, type id \"%s\" does not exists", storage->type_id);
749 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s'",
753 xbt_lib_set(storage_lib,
755 ROUTING_STORAGE_LEVEL,
756 (void *) xbt_strdup(storage->type_id));
758 static void routing_parse_storage_type(sg_platf_storage_type_cbarg_t storage_type)
760 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
761 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
763 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
764 stype->model = xbt_strdup(storage_type->model);
765 stype->properties = storage_type->properties;
766 stype->content = xbt_strdup(storage_type->content);
767 stype->type_id = xbt_strdup(storage_type->id);
769 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s' content '%s' and properties '%p'",
775 xbt_lib_set(storage_type_lib,
777 ROUTING_STORAGE_TYPE_LEVEL,
780 static void routing_parse_mstorage(sg_platf_mstorage_cbarg_t mstorage)
783 // mount_t mnt = xbt_new0(s_mount_t, 1);
784 // mnt->id = xbt_strdup(mstorage->type_id);
785 // mnt->name = xbt_strdup(mstorage->name);
788 // XBT_DEBUG("Creata a Mount list for %s",A_surfxml_host_id);
789 // mount_list = xbt_dynar_new(sizeof(char *), NULL);
791 // xbt_dynar_push(mount_list,(void *) mnt);
795 // XBT_DEBUG("ROUTING Mount a storage name '%s' with type_id '%s'",mstorage->name, mstorage->id);
798 static void mount_free(void *p)
804 static void routing_parse_mount(sg_platf_mount_cbarg_t mount)
806 // Verification of an existing storage
807 void* storage = xbt_lib_get_or_null(storage_lib, mount->id,ROUTING_STORAGE_LEVEL);
808 xbt_assert(storage,"Disk id \"%s\" does not exists", mount->id);
810 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->id, mount->name);
813 mnt.id = surf_storage_resource_by_name(mount->id);
814 mnt.name = xbt_strdup(mount->name);
817 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
818 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
820 xbt_dynar_push(mount_list,&mnt);
823 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
825 char *host_id, *groups, *link_id = NULL;
826 xbt_dict_t patterns = NULL;
828 s_sg_platf_host_cbarg_t host;
829 s_sg_platf_link_cbarg_t link;
833 xbt_dynar_t radical_elements;
834 xbt_dynar_t radical_ends;
836 if (strcmp(cluster->availability_trace, "")
837 || strcmp(cluster->state_trace, "")) {
838 patterns = xbt_dict_new_homogeneous(xbt_free_f);
839 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
840 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
841 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
844 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
845 sg_platf_new_AS_begin(cluster->id, "Cluster");
847 current_routing->link_up_down_list
848 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
851 radical_elements = xbt_str_split(cluster->radical, ",");
852 xbt_dynar_foreach(radical_elements, iter, groups) {
854 radical_ends = xbt_str_split(groups, "-");
855 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
857 switch (xbt_dynar_length(radical_ends)) {
862 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
865 surf_parse_error("Malformed radical");
868 for (i = start; i <= end; i++) {
870 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
871 link_id = bprintf("%s_link_%d", cluster->id, i);
873 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
875 memset(&host, 0, sizeof(host));
877 if (strcmp(cluster->availability_trace, "")) {
878 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
879 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
880 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
881 host.power_trace = tmgr_trace_new(avail_file);
882 xbt_free(avail_file);
884 XBT_DEBUG("\tavailability_file=\"\"");
887 if (strcmp(cluster->state_trace, "")) {
888 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
889 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
890 host.state_trace = tmgr_trace_new(avail_file);
891 xbt_free(avail_file);
893 XBT_DEBUG("\tstate_file=\"\"");
896 host.power_peak = cluster->power;
897 host.power_scale = 1.0;
898 host.core_amount = cluster->core_amount;
899 host.initial_state = SURF_RESOURCE_ON;
901 sg_platf_new_host(&host);
902 XBT_DEBUG("</host>");
904 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
905 cluster->bw, cluster->lat);
907 memset(&link, 0, sizeof(link));
909 link.bandwidth = cluster->bw;
910 link.latency = cluster->lat;
911 link.state = SURF_RESOURCE_ON;
912 link.policy = cluster->sharing_policy;
913 sg_platf_new_link(&link);
915 s_surf_parsing_link_up_down_t info;
917 if (link.policy == SURF_LINK_FULLDUPLEX) {
918 char *tmp_link = bprintf("%s_UP", link_id);
920 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
922 tmp_link = bprintf("%s_DOWN", link_id);
924 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
927 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
928 info.link_down = info.link_up;
930 xbt_dynar_push(current_routing->link_up_down_list,&info);
935 xbt_dynar_free(&radical_ends);
937 xbt_dynar_free(&radical_elements);
939 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
940 // and it's very useful to connect clusters together
942 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
944 s_sg_platf_router_cbarg_t router;
945 memset(&router, 0, sizeof(router));
946 router.id = cluster->router_id;
948 if (!router.id || !strcmp(router.id, ""))
950 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
952 sg_platf_new_router(&router);
956 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
957 char *link_backbone = bprintf("%s_backbone", cluster->id);
958 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
959 cluster->bb_bw, cluster->bb_lat);
961 memset(&link, 0, sizeof(link));
962 link.id = link_backbone;
963 link.bandwidth = cluster->bb_bw;
964 link.latency = cluster->bb_lat;
965 link.state = SURF_RESOURCE_ON;
966 link.policy = cluster->bb_sharing_policy;
968 sg_platf_new_link(&link);
970 surf_routing_cluster_add_backbone(current_routing, xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
976 sg_platf_new_AS_end();
978 xbt_dict_free(&patterns); // no op if it were never set
981 static void routing_parse_postparse(void) {
982 xbt_dict_free(&random_value);
985 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
987 static int AX_ptr = 0;
988 char *host_id = NULL;
989 char *router_id, *link_router, *link_backbone, *link_id_up, *link_id_down;
991 static unsigned int surfxml_buffer_stack_stack_ptr = 1;
992 static unsigned int surfxml_buffer_stack_stack[1024];
994 surfxml_buffer_stack_stack[0] = 0;
996 surfxml_bufferstack_push(1);
998 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Full\">", peer->id);
999 sg_platf_new_AS_begin(peer->id, "Full");
1002 host_id = HOST_PEER(peer->id);
1003 router_id = ROUTER_PEER(peer->id);
1004 link_id_up = LINK_UP_PEER(peer->id);
1005 link_id_down = LINK_DOWN_PEER(peer->id);
1007 link_router = bprintf("%s_link_router", peer->id);
1008 link_backbone = bprintf("%s_backbone", peer->id);
1010 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1011 s_sg_platf_host_cbarg_t host;
1012 memset(&host, 0, sizeof(host));
1013 host.initial_state = SURF_RESOURCE_ON;
1015 host.power_peak = peer->power;
1016 host.power_scale = 1.0;
1017 host.power_trace = peer->availability_trace;
1018 host.state_trace = peer->state_trace;
1019 host.core_amount = 1;
1020 host.coord = peer->coord;
1021 sg_platf_new_host(&host);
1024 XBT_DEBUG("<router id=\"%s\"\tcoordinates=\"%s\"/>", router_id, peer->coord);
1025 s_sg_platf_router_cbarg_t router;
1026 memset(&router, 0, sizeof(router));
1027 router.id = router_id;
1028 router.coord = peer->coord;
1029 sg_platf_new_router(&router);
1031 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_up,
1032 peer->bw_in, peer->lat);
1033 s_sg_platf_link_cbarg_t link;
1034 memset(&link, 0, sizeof(link));
1035 link.state = SURF_RESOURCE_ON;
1036 link.policy = SURF_LINK_SHARED;
1037 link.id = link_id_up;
1038 link.bandwidth = peer->bw_in;
1039 link.latency = peer->lat;
1040 sg_platf_new_link(&link);
1042 // FIXME: dealing with full duplex is not the role of this piece of code, I'd say [Mt]
1043 // Instead, it should be created fullduplex, and the models will do what's needed in this case
1044 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id_down,
1045 peer->bw_out, peer->lat);
1046 link.id = link_id_down;
1047 sg_platf_new_link(&link);
1052 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", host_id, router_id);
1053 XBT_DEBUG("symmetrical=\"NO\">");
1054 SURFXML_BUFFER_SET(route_src, host_id);
1055 SURFXML_BUFFER_SET(route_dst, router_id);
1056 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1057 SURFXML_START_TAG(route);
1059 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_up);
1060 SURFXML_BUFFER_SET(link_ctn_id, link_id_up);
1061 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1062 SURFXML_START_TAG(link_ctn);
1063 SURFXML_END_TAG(link_ctn);
1065 XBT_DEBUG("</route>");
1066 SURFXML_END_TAG(route);
1069 XBT_DEBUG("<route\tsrc=\"%s\"\tdst=\"%s\"", router_id, host_id);
1070 XBT_DEBUG("symmetrical=\"NO\">");
1071 SURFXML_BUFFER_SET(route_src, router_id);
1072 SURFXML_BUFFER_SET(route_dst, host_id);
1073 A_surfxml_route_symmetrical = A_surfxml_route_symmetrical_NO;
1074 SURFXML_START_TAG(route);
1076 XBT_DEBUG("<link_ctn\tid=\"%s\"/>", link_id_down);
1077 SURFXML_BUFFER_SET(link_ctn_id, link_id_down);
1078 A_surfxml_link_ctn_direction = A_surfxml_link_ctn_direction_NONE;
1079 SURFXML_START_TAG(link_ctn);
1080 SURFXML_END_TAG(link_ctn);
1082 XBT_DEBUG("</route>");
1083 SURFXML_END_TAG(route);
1086 sg_platf_new_AS_end();
1089 //xbt_dynar_free(&tab_elements_num);
1093 free(link_backbone);
1096 surfxml_bufferstack_pop(1);
1099 static void routing_parse_Srandom(void)
1101 double mean, std, min, max, seed;
1102 char *random_id = A_surfxml_random_id;
1103 char *random_radical = A_surfxml_random_radical;
1104 char *rd_name = NULL;
1106 mean = surf_parse_get_double(A_surfxml_random_mean);
1107 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1108 min = surf_parse_get_double(A_surfxml_random_min);
1109 max = surf_parse_get_double(A_surfxml_random_max);
1110 seed = surf_parse_get_double(A_surfxml_random_seed);
1114 random_data_t random = xbt_new0(s_random_data_t, 1);
1117 xbt_dynar_t radical_elements;
1121 xbt_dynar_t radical_ends;
1123 switch (A_surfxml_random_generator) {
1124 case AU_surfxml_random_generator:
1125 case A_surfxml_random_generator_NONE:
1126 random->generator = NONE;
1128 case A_surfxml_random_generator_DRAND48:
1129 random->generator = DRAND48;
1131 case A_surfxml_random_generator_RAND:
1132 random->generator = RAND;
1134 case A_surfxml_random_generator_RNGSTREAM:
1135 random->generator = RNGSTREAM;
1138 surf_parse_error("Invalid random generator");
1141 random->seed = seed;
1145 /* Check user stupidities */
1147 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1149 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1151 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1153 /* normalize the mean and standard deviation before storing */
1154 random->mean = (mean - min) / (max - min);
1155 random->std = std / (max - min);
1157 if (random->mean * (1 - random->mean) < random->std * random->std)
1158 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1159 random->mean, random->std);
1162 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1163 random_id, random->min, random->max, random->mean, random->std,
1164 (int)random->generator, random->seed, random_radical);
1167 random_value = xbt_dict_new_homogeneous(free);
1169 if (!strcmp(random_radical, "")) {
1170 res = random_generate(random);
1171 rd_value = bprintf("%f", res);
1172 xbt_dict_set(random_value, random_id, rd_value, NULL);
1174 radical_elements = xbt_str_split(random_radical, ",");
1175 xbt_dynar_foreach(radical_elements, iter, groups) {
1176 radical_ends = xbt_str_split(groups, "-");
1177 switch (xbt_dynar_length(radical_ends)) {
1179 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1180 "Custom Random '%s' already exists !", random_id);
1181 res = random_generate(random);
1183 bprintf("%s%d", random_id,
1184 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1185 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1190 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1191 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1192 for (i = start; i <= end; i++) {
1193 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1194 "Custom Random '%s' already exists !", bprintf("%s%d",
1197 res = random_generate(random);
1198 tmpbuf = bprintf("%s%d", random_id, i);
1199 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1204 XBT_CRITICAL("Malformed radical");
1207 res = random_generate(random);
1208 rd_name = bprintf("%s_router", random_id);
1209 rd_value = bprintf("%f", res);
1210 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1212 xbt_dynar_free(&radical_ends);
1215 xbt_dynar_free(&radical_elements);
1219 void routing_register_callbacks()
1221 sg_platf_host_add_cb(parse_S_host);
1222 sg_platf_router_add_cb(parse_S_router);
1224 surfxml_add_callback(STag_surfxml_random_cb_list, &routing_parse_Srandom);
1226 surfxml_add_callback(STag_surfxml_route_cb_list, &routing_parse_S_route);
1227 surfxml_add_callback(STag_surfxml_ASroute_cb_list, &routing_parse_S_ASroute);
1228 surfxml_add_callback(STag_surfxml_bypassRoute_cb_list,
1229 &routing_parse_S_bypassRoute);
1231 surfxml_add_callback(ETag_surfxml_link_ctn_cb_list, &routing_parse_link_ctn);
1233 surfxml_add_callback(ETag_surfxml_route_cb_list, &routing_parse_E_route);
1234 surfxml_add_callback(ETag_surfxml_ASroute_cb_list, &routing_parse_E_ASroute);
1235 surfxml_add_callback(ETag_surfxml_bypassRoute_cb_list,
1236 &routing_parse_E_bypassRoute);
1238 sg_platf_cluster_add_cb(routing_parse_cluster);
1240 sg_platf_peer_add_cb(routing_parse_peer);
1241 sg_platf_postparse_add_cb(routing_parse_postparse);
1243 sg_platf_storage_add_cb(routing_parse_storage);
1244 sg_platf_mstorage_add_cb(routing_parse_mstorage);
1245 sg_platf_storage_type_add_cb(routing_parse_storage_type);
1246 sg_platf_mount_add_cb(routing_parse_mount);
1248 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1249 sg_platf_AS_end_add_cb(routing_AS_end);
1250 sg_platf_AS_begin_add_cb(routing_AS_begin);
1253 instr_routing_define_callbacks();
1258 * \brief Recursive function for finalize
1260 * \param rc the source host name
1262 * This fuction is call by "finalize". It allow to finalize the
1263 * AS or routing components. It delete all the structures.
1265 static void finalize_rec(AS_t as) {
1266 xbt_dict_cursor_t cursor = NULL;
1270 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1277 /** \brief Frees all memory allocated by the routing module */
1278 void routing_exit(void) {
1279 if (!global_routing)
1281 xbt_dynar_free(&global_routing->last_route);
1282 finalize_rec(global_routing->root);
1283 xbt_free(global_routing);