1 /* Copyright (c) 2009-2013. 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 "simgrid/platf_interface.h" // platform creation API internal interface
8 #include "simgrid/sg_config.h"
10 #include "surf_routing_private.h"
11 #include "surf/surf_routing.h"
12 #include "surf/surfxml_parse_values.h"
15 * @ingroup SURF_build_api
16 * @brief A library containing all known workstations
20 int ROUTING_HOST_LEVEL; //Routing level
21 int SURF_CPU_LEVEL; //Surf cpu level
22 int SURF_WKS_LEVEL; //Surf workstation level
23 int SIMIX_HOST_LEVEL; //Simix host level
24 int SIMIX_STORAGE_LEVEL; //Simix storage level
25 int MSG_HOST_LEVEL; //Msg host level
26 int MSG_STORAGE_LEVEL; //Msg storage level
27 int SD_HOST_LEVEL; //Simdag host level
28 int SD_STORAGE_LEVEL; //Simdag storage level
29 int COORD_HOST_LEVEL=0; //Coordinates level
30 int NS3_HOST_LEVEL; //host node for ns3
33 * @ingroup SURF_build_api
34 * @brief A library containing all known links
37 int SD_LINK_LEVEL; //Simdag level
38 int SURF_LINK_LEVEL; //Surf level
39 int NS3_LINK_LEVEL; //link for ns3
41 xbt_lib_t as_router_lib;
42 int ROUTING_ASR_LEVEL; //Routing level
43 int COORD_ASR_LEVEL; //Coordinates level
44 int NS3_ASR_LEVEL; //host node for ns3
45 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
47 static xbt_dict_t random_value = NULL;
49 /** @brief Retrieve a routing edge from its name
51 * Routing edges are either CPU/workstation and routers, whatever
53 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
54 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
55 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
60 routing_platf_t routing_platf = NULL;
61 AS_t current_routing = NULL;
63 /* global parse functions */
64 extern xbt_dynar_t mount_list;
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,
84 struct s_model_type routing_models[] = {
86 "Full routing data (fast, large memory requirements, fully expressive)",
87 model_full_create, model_full_end},
89 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
90 model_floyd_create, model_floyd_end},
92 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
93 model_dijkstra_create, model_dijkstra_both_end},
95 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
96 model_dijkstracache_create, model_dijkstra_both_end},
97 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
98 model_none_create, NULL},
99 {"Vivaldi", "Vivaldi routing",
100 model_vivaldi_create, NULL},
101 {"Cluster", "Cluster routing",
102 model_cluster_create, NULL},
103 {NULL, NULL, NULL, NULL}
107 * \brief Add a "host_link" to the network element list
109 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
111 sg_routing_edge_t info = NULL;
112 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
113 xbt_assert(info, "Host '%s' not found!",host->id);
114 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
115 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
116 "You have to be in model Cluster to use tag host_link!");
118 s_surf_parsing_link_up_down_t link_up_down;
119 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
120 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
121 link_up_down.limiter_link = NULL;
122 link_up_down.loopback_link = NULL;
124 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
125 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
127 if(!current_routing->link_up_down_list)
128 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
130 // If dynar is is greater than edge id and if the host_link is already defined
131 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
132 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
133 xbt_die("Host_link for '%s' is already defined!",host->id);
135 XBT_DEBUG("Push Host_link for host '%s' to position %d",info->name,info->id);
136 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
140 * \brief Add a "host" to the network element list
142 static void parse_S_host(sg_platf_host_cbarg_t host)
144 sg_routing_edge_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(host_lib, host->id, ROUTING_HOST_LEVEL),
148 "Reading a host, processing unit \"%s\" already exists", host->id);
150 info = xbt_new0(s_routing_edge_t, 1);
151 info->rc_component = current_routing;
152 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
153 info->name = xbt_strdup(host->id);
154 info->id = current_routing->parse_PU(current_routing, (void *) info);
155 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
156 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
159 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
163 if (host->coord && strcmp(host->coord, "")) {
167 if (!COORD_HOST_LEVEL)
168 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
169 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
170 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
171 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
172 xbt_dynar_foreach(ctn_str,cursor, str) {
173 double val = atof(str);
174 xbt_dynar_push(ctn,&val);
176 xbt_dynar_shrink(ctn, 0);
177 xbt_dynar_free(&ctn_str);
178 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
179 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
184 * \brief Add a "router" to the network element list
186 static void parse_S_router(sg_platf_router_cbarg_t router)
188 sg_routing_edge_t info = NULL;
189 if (current_routing->hierarchy == SURF_ROUTING_NULL)
190 current_routing->hierarchy = SURF_ROUTING_BASE;
191 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
192 "Reading a router, processing unit \"%s\" already exists",
195 info = xbt_new0(s_routing_edge_t, 1);
196 info->rc_component = current_routing;
197 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
198 info->name = xbt_strdup(router->id);
199 info->id = current_routing->parse_PU(current_routing, (void *) info);
200 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
201 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
203 if (router->coord && strcmp(router->coord, "")) {
207 if (!COORD_ASR_LEVEL)
208 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
209 /* Pre-parse the host coordinates */
210 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
211 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
212 xbt_dynar_foreach(ctn_str,cursor, str) {
213 double val = atof(str);
214 xbt_dynar_push(ctn,&val);
216 xbt_dynar_shrink(ctn, 0);
217 xbt_dynar_free(&ctn_str);
218 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
219 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
224 * \brief Store the route by calling the set_route function of the current routing component
226 static void parse_E_route(sg_platf_route_cbarg_t route)
228 xbt_assert(current_routing->parse_route,
229 "no defined method \"set_route\" in \"%s\"",
230 current_routing->name);
232 current_routing->parse_route(current_routing, route);
236 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
238 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
240 xbt_assert(current_routing->parse_ASroute,
241 "no defined method \"set_ASroute\" in \"%s\"",
242 current_routing->name);
243 current_routing->parse_ASroute(current_routing, ASroute);
247 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
249 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
251 xbt_assert(current_routing->parse_bypassroute,
252 "Bypassing mechanism not implemented by routing '%s'",
253 current_routing->name);
255 current_routing->parse_bypassroute(current_routing, route);
259 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
261 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
263 xbt_assert(current_routing->parse_bypassroute,
264 "Bypassing mechanism not implemented by routing '%s'",
265 current_routing->name);
266 current_routing->parse_bypassroute(current_routing, ASroute);
269 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
271 tmgr_trace_t tmgr_trace;
272 if (!trace->file || strcmp(trace->file, "") != 0) {
273 tmgr_trace = tmgr_trace_new_from_file(trace->file);
274 } else if (strcmp(trace->pc_data, "") == 0) {
278 tmgr_trace_new_from_string(trace->id, trace->pc_data,
281 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
284 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
286 xbt_assert(xbt_dict_get_or_null
287 (traces_set_list, trace_connect->trace),
288 "Cannot connect trace %s to %s: trace unknown",
289 trace_connect->trace,
290 trace_connect->element);
292 switch (trace_connect->kind) {
293 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
294 xbt_dict_set(trace_connect_list_host_avail,
295 trace_connect->trace,
296 xbt_strdup(trace_connect->element), NULL);
298 case SURF_TRACE_CONNECT_KIND_POWER:
299 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
300 xbt_strdup(trace_connect->element), NULL);
302 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
303 xbt_dict_set(trace_connect_list_link_avail,
304 trace_connect->trace,
305 xbt_strdup(trace_connect->element), NULL);
307 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
308 xbt_dict_set(trace_connect_list_bandwidth,
309 trace_connect->trace,
310 xbt_strdup(trace_connect->element), NULL);
312 case SURF_TRACE_CONNECT_KIND_LATENCY:
313 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
314 xbt_strdup(trace_connect->element), NULL);
317 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
318 trace_connect->trace, trace_connect->element);
324 * \brief Make a new routing component to the platform
326 * Add a new autonomous system to the platform. Any elements (such as host,
327 * router or sub-AS) added after this call and before the corresponding call
328 * to sg_platf_new_AS_close() will be added to this AS.
330 * Once this function was called, the configuration concerning the used
331 * models cannot be changed anymore.
333 * @param AS_id name of this autonomous system. Must be unique in the platform
334 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
336 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
338 XBT_DEBUG("routing_AS_begin");
340 routing_model_description_t model = NULL;
342 xbt_assert(!xbt_lib_get_or_null
343 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
344 "The AS \"%s\" already exists", AS->id);
346 _sg_cfg_init_status = 2; /* horrible hack: direct access to the global
347 * controlling the level of configuration to prevent
348 * any further config */
350 /* search the routing model */
352 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
353 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
354 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
355 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
356 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
357 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
358 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
359 default: xbt_die("Not a valid model!!!");
363 /* make a new routing component */
364 new_as = (AS_t) model->create();
365 new_as->model_desc = model;
366 new_as->hierarchy = SURF_ROUTING_NULL;
367 new_as->name = xbt_strdup(AS->id);
369 sg_routing_edge_t info = NULL;
370 info = xbt_new0(s_routing_edge_t, 1);
372 if (current_routing == NULL && routing_platf->root == NULL) {
374 /* it is the first one */
375 new_as->routing_father = NULL;
376 routing_platf->root = new_as;
378 } else if (current_routing != NULL && routing_platf->root != NULL) {
380 xbt_assert(!xbt_dict_get_or_null
381 (current_routing->routing_sons, AS->id),
382 "The AS \"%s\" already exists", AS->id);
383 /* it is a part of the tree */
384 new_as->routing_father = current_routing;
385 /* set the father behavior */
386 if (current_routing->hierarchy == SURF_ROUTING_NULL)
387 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
388 /* add to the sons dictionary */
389 xbt_dict_set(current_routing->routing_sons, AS->id,
390 (void *) new_as, NULL);
391 /* add to the father element list */
392 info->id = current_routing->parse_AS(current_routing, (void *) info);
394 THROWF(arg_error, 0, "All defined components must be belong to a AS");
397 info->rc_component = new_as->routing_father;
398 info->rc_type = SURF_NETWORK_ELEMENT_AS;
399 info->name = new_as->name;
401 xbt_lib_set(as_router_lib, info->name, ROUTING_ASR_LEVEL,
403 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
405 /* set the new current component of the tree */
406 current_routing = new_as;
407 current_routing->net_elem = info;
412 * \brief Specify that the current description of AS is finished
414 * Once you've declared all the content of your AS, you have to close
415 * it with this call. Your AS is not usable until you call this function.
417 * @fixme: this call is not as robust as wanted: bad things WILL happen
418 * if you call it twice for the same AS, or if you forget calling it, or
419 * even if you add stuff to a closed AS
422 void routing_AS_end(sg_platf_AS_cbarg_t AS)
425 if (current_routing == NULL) {
426 THROWF(arg_error, 0, "Close an AS, but none was under construction");
428 if (current_routing->model_desc->end)
429 current_routing->model_desc->end(current_routing);
430 current_routing = current_routing->routing_father;
434 /* Aux Business methods */
437 * \brief Get the AS father and the first elements of the chain
439 * \param src the source host name
440 * \param dst the destination host name
442 * Get the common father of the to processing units, and the first different
443 * father in the chain
445 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
450 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
451 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
453 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
454 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
462 /* (1) find the as where the src and dst are located */
463 sg_routing_edge_t src_data = src;
464 sg_routing_edge_t dst_data = dst;
465 src_as = src_data->rc_component;
466 dst_as = dst_data->rc_component;
468 char* src_name = src_data->name;
469 char* dst_name = dst_data->name;
472 xbt_assert(src_as && dst_as,
473 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
475 /* (2) find the path to the root routing component */
476 for (current = src_as; current != NULL; current = current->routing_father) {
477 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
478 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
479 path_src[index_src++] = current;
481 for (current = dst_as; current != NULL; current = current->routing_father) {
482 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
483 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
484 path_dst[index_dst++] = current;
487 /* (3) find the common father */
489 current_src = path_src[--index_src];
490 current_dst = path_dst[--index_dst];
491 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
493 /* (4) they are not in the same routing component, make the path */
494 if (current_src == current_dst)
495 father = current_src;
497 father = path_src[index_src + 1];
499 /* (5) result generation */
500 *res_father = father; /* first the common father of src and dst */
501 *res_src = current_src; /* second the first different father of src */
502 *res_dst = current_dst; /* three the first different father of dst */
504 #undef ELEMENTS_FATHER_MAXDEPTH
507 /* Global Business methods */
510 * \brief Recursive function for get_route_latency
512 * \param src the source host name
513 * \param dst the destination host name
514 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
515 * \param *latency the latency, if needed
517 * This function is called by "get_route" and "get_latency". It allows to walk
518 * recursively through the ASes tree.
520 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
521 xbt_dynar_t * links, double *latency)
523 s_sg_platf_route_cbarg_t route;
524 memset(&route,0,sizeof(route));
526 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
527 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
529 /* Find how src and dst are interconnected */
530 AS_t common_father, src_father, dst_father;
531 elements_father(src, dst, &common_father, &src_father, &dst_father);
532 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
533 common_father->name,src_father->name,dst_father->name);
535 /* Check whether a direct bypass is defined */
536 sg_platf_route_cbarg_t e_route_bypass = NULL;
537 if (common_father->get_bypass_route)
538 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
540 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
541 if (e_route_bypass) {
542 xbt_dynar_merge(links, &e_route_bypass->link_list);
543 generic_free_route(e_route_bypass);
547 /* If src and dst are in the same AS, life is good */
548 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
549 route.link_list = *links;
550 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
551 // if vivaldi latency+=vivaldi(src,dst)
555 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
557 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
558 // Find the net_card corresponding to father
559 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
560 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
562 common_father->get_route_and_latency(common_father,
563 src_father_net_elm, dst_father_net_elm,
566 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
567 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
569 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
570 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
572 /* If source gateway is not our source, we have to recursively find our way up to this point */
573 if (src != src_gateway_net_elm)
574 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
575 xbt_dynar_merge(links, &route.link_list);
577 /* If dest gateway is not our destination, we have to recursively find our way from this point */
578 if (dst_gateway_net_elm != dst)
579 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
581 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
585 * \brief Find a route between hosts
587 * \param src the network_element_t for src host
588 * \param dst the network_element_t for dst host
589 * \param route where to store the list of links.
590 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
591 * \param latency where to store the latency experienced on the path (or NULL if not interested)
592 * It is the caller responsability to initialize latency to 0 (we add to provided route)
595 * walk through the routing components tree and find a route between hosts
596 * by calling the differents "get_route" functions in each routing component.
598 void routing_get_route_and_latency(sg_routing_edge_t src,
599 sg_routing_edge_t dst,
600 xbt_dynar_t * route, double *latency)
602 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
604 xbt_dynar_reset(routing_platf->last_route);
605 *route = routing_platf->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->name, dst->name);
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
619 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
621 xbt_dynar_merge(&ret,&onelink_mine);
625 xbt_dict_cursor_t cursor = NULL;
627 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
628 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
630 xbt_dynar_merge(&ret,&onelink_child);
635 static xbt_dynar_t get_onelink_routes(void)
637 return recursive_get_onelink_routes(routing_platf->root);
640 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
642 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
646 return SURF_NETWORK_ELEMENT_NULL;
650 * \brief Generic method: create the global routing schema
652 * Make a global routing structure and set all the parsing functions.
654 void routing_model_create( void *loopback)
656 /* config the uniq global routing */
657 routing_platf = xbt_new0(s_routing_platf_t, 1);
658 routing_platf->root = NULL;
659 routing_platf->get_onelink_routes = get_onelink_routes;
660 routing_platf->loopback = loopback;
661 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
662 /* no current routing at moment */
663 current_routing = NULL;
667 /* ************************************************** */
668 /* ********** PATERN FOR NEW ROUTING **************** */
670 /* The minimal configuration of a new routing model need the next functions,
671 * also you need to set at the start of the file, the new model in the model
672 * list. Remember keep the null ending of the list.
674 /*** Routing model structure ***/
676 // s_routing_component_t generic_routing;
677 // /* things that your routing model need */
678 // } s_routing_component_NEW_t,*routing_component_NEW_t;
680 /*** Parse routing model functions ***/
681 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
682 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
683 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
684 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
685 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
687 /*** Business methods ***/
688 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
689 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
690 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
692 /*** Creation routing model functions ***/
693 // static void* model_NEW_create(void) {
694 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
695 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
696 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
697 // new_component->generic_routing.set_route = model_NEW_set_route;
698 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
699 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
700 // new_component->generic_routing.get_route = NEW_get_route;
701 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
702 // new_component->generic_routing.finalize = NEW_finalize;
703 // /* initialization of internal structures */
704 // return new_component;
706 // static void model_NEW_load(void) {} /* mandatory */
707 // static void model_NEW_unload(void) {} /* mandatory */
708 // static void model_NEW_end(void) {} /* mandatory */
710 /* ************************************************************************** */
711 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
713 void routing_cluster_add_backbone(void* bb) {
714 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
715 "You have to be in model Cluster to use tag backbone!");
716 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
717 ((as_cluster_t)current_routing)->backbone = bb;
718 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
721 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
724 char *groups , *host_id , *link_id = NULL;
726 xbt_dynar_t radical_elements;
727 xbt_dynar_t radical_ends;
730 radical_elements = xbt_str_split(cabinet->radical, ",");
731 xbt_dynar_foreach(radical_elements, iter, groups) {
733 radical_ends = xbt_str_split(groups, "-");
734 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
736 switch (xbt_dynar_length(radical_ends)) {
741 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
744 surf_parse_error("Malformed radical");
747 s_sg_platf_host_cbarg_t host;
748 memset(&host, 0, sizeof(host));
749 host.initial_state = SURF_RESOURCE_ON;
751 host.power_scale = 1.0;
752 host.core_amount = 1;
754 s_sg_platf_link_cbarg_t link;
755 memset(&link, 0, sizeof(link));
756 link.state = SURF_RESOURCE_ON;
757 link.policy = SURF_LINK_FULLDUPLEX;
758 link.latency = cabinet->lat;
759 link.bandwidth = cabinet->bw;
761 s_sg_platf_host_link_cbarg_t host_link;
762 memset(&host_link, 0, sizeof(host_link));
764 for (i = start; i <= end; i++) {
765 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
766 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
769 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
770 xbt_dynar_push(power_state_list,&cabinet->power);
771 host.power_peak = power_state_list;
772 sg_platf_new_host(&host);
773 sg_platf_new_link(&link);
775 char* link_up = bprintf("%s_UP",link_id);
776 char* link_down = bprintf("%s_DOWN",link_id);
777 host_link.id = host_id;
778 host_link.link_up = link_up;
779 host_link.link_down= link_down;
780 sg_platf_new_host_link(&host_link);
788 xbt_dynar_free(&radical_ends);
790 xbt_dynar_free(&radical_elements);
793 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
795 char *host_id, *groups, *link_id = NULL;
796 xbt_dict_t patterns = NULL;
798 s_sg_platf_host_cbarg_t host;
799 s_sg_platf_link_cbarg_t link;
803 xbt_dynar_t radical_elements;
804 xbt_dynar_t radical_ends;
806 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
807 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
808 patterns = xbt_dict_new_homogeneous(xbt_free_f);
809 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
810 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
811 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
814 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
815 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
817 AS.routing = A_surfxml_AS_routing_Cluster;
818 sg_platf_new_AS_begin(&AS);
820 current_routing->link_up_down_list
821 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
824 radical_elements = xbt_str_split(cluster->radical, ",");
825 xbt_dynar_foreach(radical_elements, iter, groups) {
827 radical_ends = xbt_str_split(groups, "-");
828 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
830 switch (xbt_dynar_length(radical_ends)) {
835 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
838 surf_parse_error("Malformed radical");
841 for (i = start; i <= end; i++) {
843 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
844 link_id = bprintf("%s_link_%d", cluster->id, i);
846 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
848 memset(&host, 0, sizeof(host));
850 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
851 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
852 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
853 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
854 host.power_trace = tmgr_trace_new_from_file(avail_file);
855 xbt_free(avail_file);
857 XBT_DEBUG("\tavailability_file=\"\"");
860 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
861 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
862 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
863 host.state_trace = tmgr_trace_new_from_file(avail_file);
864 xbt_free(avail_file);
866 XBT_DEBUG("\tstate_file=\"\"");
869 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
870 xbt_dynar_push(power_state_list,&cluster->power);
871 host.power_peak = power_state_list;
874 //host.power_peak = cluster->power;
875 host.power_scale = 1.0;
876 host.core_amount = cluster->core_amount;
877 host.initial_state = SURF_RESOURCE_ON;
879 sg_platf_new_host(&host);
880 XBT_DEBUG("</host>");
882 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
883 cluster->bw, cluster->lat);
885 memset(&link, 0, sizeof(link));
887 link.bandwidth = cluster->bw;
888 link.latency = cluster->lat;
889 link.state = SURF_RESOURCE_ON;
890 link.policy = cluster->sharing_policy;
891 sg_platf_new_link(&link);
893 s_surf_parsing_link_up_down_t info;
895 if (link.policy == SURF_LINK_FULLDUPLEX) {
896 char *tmp_link = bprintf("%s_UP", link_id);
898 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
900 tmp_link = bprintf("%s_DOWN", link_id);
902 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
905 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
906 info.link_down = info.link_up;
909 if(cluster->limiter_link!=0){
910 char *tmp_link = bprintf("%s_limiter", link_id);
911 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
912 cluster->limiter_link);
915 memset(&link, 0, sizeof(link));
917 link.bandwidth = cluster->limiter_link;
919 link.state = SURF_RESOURCE_ON;
920 link.policy = SURF_LINK_SHARED;
921 sg_platf_new_link(&link);
923 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
926 info.limiter_link =NULL;
929 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
930 char *tmp_link = bprintf("%s_loopback", link_id);
931 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
932 cluster->limiter_link);
935 memset(&link, 0, sizeof(link));
937 link.bandwidth = cluster->loopback_bw;
938 link.latency = cluster->loopback_lat;
939 link.state = SURF_RESOURCE_ON;
940 link.policy = SURF_LINK_FATPIPE;
941 sg_platf_new_link(&link);
943 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
946 info.loopback_link =NULL;
949 xbt_dynar_push(current_routing->link_up_down_list,&info);
954 xbt_dynar_free(&radical_ends);
956 xbt_dynar_free(&radical_elements);
958 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
959 // and it's very useful to connect clusters together
961 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
963 s_sg_platf_router_cbarg_t router;
964 memset(&router, 0, sizeof(router));
965 router.id = cluster->router_id;
967 if (!router.id || !strcmp(router.id, ""))
969 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
971 sg_platf_new_router(&router);
972 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
976 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
977 char *link_backbone = bprintf("%s_backbone", cluster->id);
978 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
979 cluster->bb_bw, cluster->bb_lat);
981 memset(&link, 0, sizeof(link));
982 link.id = link_backbone;
983 link.bandwidth = cluster->bb_bw;
984 link.latency = cluster->bb_lat;
985 link.state = SURF_RESOURCE_ON;
986 link.policy = cluster->bb_sharing_policy;
988 sg_platf_new_link(&link);
990 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
996 sg_platf_new_AS_end();
998 xbt_dict_free(&patterns); // no op if it were never set
1001 static void routing_parse_postparse(void) {
1002 xbt_dict_free(&random_value);
1005 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1007 char *host_id = NULL;
1008 char *link_id = NULL;
1009 char *router_id = NULL;
1012 host_id = HOST_PEER(peer->id);
1013 link_id = LINK_PEER(peer->id);
1014 router_id = ROUTER_PEER(peer->id);
1016 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", peer->id);
1017 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
1019 AS.routing = A_surfxml_AS_routing_Cluster;
1020 sg_platf_new_AS_begin(&AS);
1022 current_routing->link_up_down_list
1023 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
1025 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1026 s_sg_platf_host_cbarg_t host;
1027 memset(&host, 0, sizeof(host));
1028 host.initial_state = SURF_RESOURCE_ON;
1031 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
1032 xbt_dynar_push(power_state_list,&peer->power);
1033 host.power_peak = power_state_list;
1035 //host.power_peak = peer->power;
1036 host.power_scale = 1.0;
1037 host.power_trace = peer->availability_trace;
1038 host.state_trace = peer->state_trace;
1039 host.core_amount = 1;
1040 sg_platf_new_host(&host);
1042 s_sg_platf_link_cbarg_t link;
1043 memset(&link, 0, sizeof(link));
1044 link.state = SURF_RESOURCE_ON;
1045 link.policy = SURF_LINK_SHARED;
1046 link.latency = peer->lat;
1048 char* link_up = bprintf("%s_UP",link_id);
1049 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1050 peer->bw_out, peer->lat);
1052 link.bandwidth = peer->bw_out;
1053 sg_platf_new_link(&link);
1055 char* link_down = bprintf("%s_DOWN",link_id);
1056 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1057 peer->bw_in, peer->lat);
1058 link.id = link_down;
1059 link.bandwidth = peer->bw_in;
1060 sg_platf_new_link(&link);
1062 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1063 s_sg_platf_host_link_cbarg_t host_link;
1064 memset(&host_link, 0, sizeof(host_link));
1065 host_link.id = host_id;
1066 host_link.link_up = link_up;
1067 host_link.link_down= link_down;
1068 sg_platf_new_host_link(&host_link);
1070 XBT_DEBUG("<router id=\"%s\"/>", router_id);
1071 s_sg_platf_router_cbarg_t router;
1072 memset(&router, 0, sizeof(router));
1073 router.id = router_id;
1074 router.coord = peer->coord;
1075 sg_platf_new_router(&router);
1076 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
1079 sg_platf_new_AS_end();
1082 //xbt_dynar_free(&tab_elements_num);
1090 static void routing_parse_Srandom(void)
1092 double mean, std, min, max, seed;
1093 char *random_id = A_surfxml_random_id;
1094 char *random_radical = A_surfxml_random_radical;
1095 char *rd_name = NULL;
1097 mean = surf_parse_get_double(A_surfxml_random_mean);
1098 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1099 min = surf_parse_get_double(A_surfxml_random_min);
1100 max = surf_parse_get_double(A_surfxml_random_max);
1101 seed = surf_parse_get_double(A_surfxml_random_seed);
1105 random_data_t random = xbt_new0(s_random_data_t, 1);
1108 xbt_dynar_t radical_elements;
1112 xbt_dynar_t radical_ends;
1114 switch (A_surfxml_random_generator) {
1115 case AU_surfxml_random_generator:
1116 case A_surfxml_random_generator_NONE:
1117 random->generator = NONE;
1119 case A_surfxml_random_generator_DRAND48:
1120 random->generator = DRAND48;
1122 case A_surfxml_random_generator_RAND:
1123 random->generator = RAND;
1125 case A_surfxml_random_generator_RNGSTREAM:
1126 random->generator = RNGSTREAM;
1129 surf_parse_error("Invalid random generator");
1132 random->seed = seed;
1136 /* Check user stupidities */
1138 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1140 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1142 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1144 /* normalize the mean and standard deviation before storing */
1145 random->mean = (mean - min) / (max - min);
1146 random->std = std / (max - min);
1148 if (random->mean * (1 - random->mean) < random->std * random->std)
1149 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1150 random->mean, random->std);
1153 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1154 random_id, random->min, random->max, random->mean, random->std,
1155 (int)random->generator, random->seed, random_radical);
1158 random_value = xbt_dict_new_homogeneous(free);
1160 if (!strcmp(random_radical, "")) {
1161 res = random_generate(random);
1162 rd_value = bprintf("%f", res);
1163 xbt_dict_set(random_value, random_id, rd_value, NULL);
1165 radical_elements = xbt_str_split(random_radical, ",");
1166 xbt_dynar_foreach(radical_elements, iter, groups) {
1167 radical_ends = xbt_str_split(groups, "-");
1168 switch (xbt_dynar_length(radical_ends)) {
1170 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1171 "Custom Random '%s' already exists !", random_id);
1172 res = random_generate(random);
1174 bprintf("%s%d", random_id,
1175 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1176 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1181 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1182 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1183 for (i = start; i <= end; i++) {
1184 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1185 "Custom Random '%s' already exists !", bprintf("%s%d",
1188 res = random_generate(random);
1189 tmpbuf = bprintf("%s%d", random_id, i);
1190 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1195 XBT_CRITICAL("Malformed radical");
1198 res = random_generate(random);
1199 rd_name = bprintf("%s_router", random_id);
1200 rd_value = bprintf("%f", res);
1201 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1203 xbt_dynar_free(&radical_ends);
1206 xbt_dynar_free(&radical_elements);
1210 void routing_register_callbacks()
1212 sg_platf_host_add_cb(parse_S_host);
1213 sg_platf_router_add_cb(parse_S_router);
1214 sg_platf_host_link_add_cb(parse_S_host_link);
1215 sg_platf_route_add_cb(parse_E_route);
1216 sg_platf_ASroute_add_cb(parse_E_ASroute);
1217 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1218 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1220 sg_platf_cluster_add_cb(routing_parse_cluster);
1221 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1223 sg_platf_peer_add_cb(routing_parse_peer);
1224 sg_platf_postparse_add_cb(routing_parse_postparse);
1226 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1227 sg_platf_AS_end_add_cb(routing_AS_end);
1228 sg_platf_AS_begin_add_cb(routing_AS_begin);
1230 sg_platf_trace_add_cb(routing_parse_trace);
1231 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1234 instr_routing_define_callbacks();
1239 * \brief Recursive function for finalize
1241 * \param rc the source host name
1243 * This fuction is call by "finalize". It allow to finalize the
1244 * AS or routing components. It delete all the structures.
1246 static void finalize_rec(AS_t as) {
1247 xbt_dict_cursor_t cursor = NULL;
1251 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1258 /** \brief Frees all memory allocated by the routing module */
1259 void routing_exit(void) {
1262 xbt_dynar_free(&routing_platf->last_route);
1263 finalize_rec(routing_platf->root);
1264 xbt_free(routing_platf);
1267 AS_t surf_AS_get_routing_root() {
1268 return routing_platf->root;
1271 const char *surf_AS_get_name(AS_t as) {
1275 xbt_dict_t surf_AS_get_routing_sons(AS_t as) {
1276 return as->routing_sons;
1279 const char *surf_AS_get_model(AS_t as) {
1280 return as->model_desc->name;
1283 xbt_dynar_t surf_AS_get_hosts(AS_t as) {
1284 xbt_dynar_t elms = as->index_network_elm;
1285 sg_routing_edge_t relm;
1288 int count = xbt_dynar_length(elms);
1289 xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_dictelm_t), NULL);
1290 for (index = 0; index < count; index++) {
1291 relm = xbt_dynar_get_as(elms, index, sg_routing_edge_t);
1292 delm = xbt_lib_get_elm_or_null(host_lib, relm->name);
1294 xbt_dynar_push(res, &delm);