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 "simgrid/platf_interface.h" // platform creation API internal interface
9 #include "surf_routing_private.h"
10 #include "surf/surf_routing.h"
11 #include "surf/surfxml_parse_values.h"
14 * @ingroup SURF_build_api
15 * @brief A library containing all known workstations
19 int ROUTING_HOST_LEVEL; //Routing level
20 int SURF_CPU_LEVEL; //Surf cpu level
21 int SURF_WKS_LEVEL; //Surf workstation level
22 int SIMIX_HOST_LEVEL; //Simix level
23 int MSG_HOST_LEVEL; //Msg level
24 int SD_HOST_LEVEL; //Simdag level
25 int COORD_HOST_LEVEL=0; //Coordinates level
26 int NS3_HOST_LEVEL; //host node for ns3
28 xbt_dict_t watched_hosts_lib;
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
43 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
45 static xbt_dict_t random_value = NULL;
47 /** @brief Retrieve a routing edge from its name
49 * Routing edges are either CPU/workstation and routers, whatever
51 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
52 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
53 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
58 routing_platf_t routing_platf = NULL;
59 AS_t current_routing = NULL;
61 /* global parse functions */
62 extern xbt_dynar_t mount_list;
64 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
66 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
67 static void routing_parse_Srandom(void); /* random bypass */
69 static void routing_parse_postparse(void);
71 /* this lines are only for replace use like index in the model table */
76 SURF_MODEL_DIJKSTRACACHE,
83 struct s_model_type routing_models[] = {
85 "Full routing data (fast, large memory requirements, fully expressive)",
86 model_full_create, model_full_end},
88 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
89 model_floyd_create, model_floyd_end},
91 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
92 model_dijkstra_create, model_dijkstra_both_end},
94 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
95 model_dijkstracache_create, model_dijkstra_both_end},
96 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
97 model_none_create, NULL},
98 {"RuleBased", "Rule-Based routing data (...)",
99 model_rulebased_create, NULL},
100 {"Vivaldi", "Vivaldi routing",
101 model_vivaldi_create, NULL},
102 {"Cluster", "Cluster routing",
103 model_cluster_create, NULL},
104 {NULL, NULL, NULL, NULL}
108 * \brief Add a "host_link" to the network element list
110 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
112 sg_routing_edge_t info = NULL;
113 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
114 xbt_assert(info, "Host '%s' not found!",host->id);
115 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
116 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
117 "You have to be in model Cluster to use tag host_link!");
119 s_surf_parsing_link_up_down_t link_up_down;
120 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
121 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
122 link_up_down.limiter_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);
323 extern int _sg_init_status; /* yay, this is an horrible hack */
326 * \brief Make a new routing component to the platform
328 * Add a new autonomous system to the platform. Any elements (such as host,
329 * router or sub-AS) added after this call and before the corresponding call
330 * to sg_platf_new_AS_close() will be added to this AS.
332 * Once this function was called, the configuration concerning the used
333 * models cannot be changed anymore.
335 * @param AS_id name of this autonomous system. Must be unique in the platform
336 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
338 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
340 XBT_DEBUG("routing_AS_begin");
342 routing_model_description_t model = NULL;
344 xbt_assert(!xbt_lib_get_or_null
345 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
346 "The AS \"%s\" already exists", AS->id);
348 _sg_init_status = 2; /* horrible hack: direct access to the global controlling the level of configuration to prevent 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_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
359 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
360 default: xbt_die("Not a valid model!!!");
364 /* make a new routing component */
365 new_as = (AS_t) model->create();
366 new_as->model_desc = model;
367 new_as->hierarchy = SURF_ROUTING_NULL;
368 new_as->name = xbt_strdup(AS->id);
370 sg_routing_edge_t info = NULL;
371 info = xbt_new0(s_routing_edge_t, 1);
373 if (current_routing == NULL && routing_platf->root == NULL) {
375 /* it is the first one */
376 new_as->routing_father = NULL;
377 routing_platf->root = new_as;
379 } else if (current_routing != NULL && routing_platf->root != NULL) {
381 xbt_assert(!xbt_dict_get_or_null
382 (current_routing->routing_sons, AS->id),
383 "The AS \"%s\" already exists", AS->id);
384 /* it is a part of the tree */
385 new_as->routing_father = current_routing;
386 /* set the father behavior */
387 if (current_routing->hierarchy == SURF_ROUTING_NULL)
388 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
389 /* add to the sons dictionary */
390 xbt_dict_set(current_routing->routing_sons, AS->id,
391 (void *) new_as, NULL);
392 /* add to the father element list */
393 info->id = current_routing->parse_AS(current_routing, (void *) info);
395 THROWF(arg_error, 0, "All defined components must be belong to a AS");
398 info->rc_component = new_as->routing_father;
399 info->rc_type = SURF_NETWORK_ELEMENT_AS;
400 info->name = new_as->name;
402 xbt_lib_set(as_router_lib, info->name, ROUTING_ASR_LEVEL,
404 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
406 /* set the new current component of the tree */
407 current_routing = new_as;
408 current_routing->net_elem = info;
413 * \brief Specify that the current description of AS is finished
415 * Once you've declared all the content of your AS, you have to close
416 * it with this call. Your AS is not usable until you call this function.
418 * @fixme: this call is not as robust as wanted: bad things WILL happen
419 * if you call it twice for the same AS, or if you forget calling it, or
420 * even if you add stuff to a closed AS
423 void routing_AS_end(sg_platf_AS_cbarg_t AS)
426 if (current_routing == NULL) {
427 THROWF(arg_error, 0, "Close an AS, but none was under construction");
429 if (current_routing->model_desc->end)
430 current_routing->model_desc->end(current_routing);
431 current_routing = current_routing->routing_father;
435 /* Aux Business methods */
438 * \brief Get the AS father and the first elements of the chain
440 * \param src the source host name
441 * \param dst the destination host name
443 * Get the common father of the to processing units, and the first different
444 * father in the chain
446 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
451 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
452 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
454 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
455 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
463 /* (1) find the as where the src and dst are located */
464 sg_routing_edge_t src_data = src;
465 sg_routing_edge_t dst_data = dst;
466 src_as = src_data->rc_component;
467 dst_as = dst_data->rc_component;
469 char* src_name = src_data->name;
470 char* dst_name = dst_data->name;
473 xbt_assert(src_as && dst_as,
474 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
476 /* (2) find the path to the root routing component */
477 for (current = src_as; current != NULL; current = current->routing_father) {
478 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
479 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
480 path_src[index_src++] = current;
482 for (current = dst_as; current != NULL; current = current->routing_father) {
483 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
484 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
485 path_dst[index_dst++] = current;
488 /* (3) find the common father */
490 current_src = path_src[--index_src];
491 current_dst = path_dst[--index_dst];
492 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
494 /* (4) they are not in the same routing component, make the path */
495 if (current_src == current_dst)
496 father = current_src;
498 father = path_src[index_src + 1];
500 /* (5) result generation */
501 *res_father = father; /* first the common father of src and dst */
502 *res_src = current_src; /* second the first different father of src */
503 *res_dst = current_dst; /* three the first different father of dst */
505 #undef ELEMENTS_FATHER_MAXDEPTH
508 /* Global Business methods */
511 * \brief Recursive function for get_route_latency
513 * \param src the source host name
514 * \param dst the destination host name
515 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
516 * \param *latency the latency, if needed
518 * This function is called by "get_route" and "get_latency". It allows to walk
519 * recursively through the ASes tree.
521 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
522 xbt_dynar_t * links, double *latency)
524 s_sg_platf_route_cbarg_t route;
525 memset(&route,0,sizeof(route));
527 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
528 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
530 /* Find how src and dst are interconnected */
531 AS_t common_father, src_father, dst_father;
532 elements_father(src, dst, &common_father, &src_father, &dst_father);
533 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
534 common_father->name,src_father->name,dst_father->name);
536 /* Check whether a direct bypass is defined */
537 sg_platf_route_cbarg_t e_route_bypass = NULL;
538 if (common_father->get_bypass_route)
539 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
541 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
542 if (e_route_bypass) {
543 xbt_dynar_merge(links, &e_route_bypass->link_list);
544 generic_free_route(e_route_bypass);
548 /* If src and dst are in the same AS, life is good */
549 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
550 route.link_list = *links;
551 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
552 // if vivaldi latency+=vivaldi(src,dst)
556 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
558 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
559 // Find the net_card corresponding to father
560 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
561 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
563 common_father->get_route_and_latency(common_father,
564 src_father_net_elm, dst_father_net_elm,
567 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
568 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
570 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
571 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
573 /* If source gateway is not our source, we have to recursively find our way up to this point */
574 if (src != src_gateway_net_elm)
575 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
576 xbt_dynar_merge(links, &route.link_list);
578 /* If dest gateway is not our destination, we have to recursively find our way from this point */
579 if (dst_gateway_net_elm != dst)
580 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
582 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
586 * \brief Find a route between hosts
588 * \param src the network_element_t for src host
589 * \param dst the network_element_t for dst host
590 * \param route where to store the list of links.
591 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
592 * \param latency where to store the latency experienced on the path (or NULL if not interested)
593 * It is the caller responsability to initialize latency to 0 (we add to provided route)
596 * walk through the routing components tree and find a route between hosts
597 * by calling the differents "get_route" functions in each routing component.
599 void routing_get_route_and_latency(sg_routing_edge_t src,
600 sg_routing_edge_t dst,
601 xbt_dynar_t * route, double *latency)
603 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
605 xbt_dynar_reset(routing_platf->last_route);
606 *route = routing_platf->last_route;
609 _get_route_and_latency(src, dst, route, latency);
611 xbt_assert(!latency || *latency >= 0.0,
612 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
615 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
617 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
619 //adding my one link routes
620 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
622 xbt_dynar_merge(&ret,&onelink_mine);
626 xbt_dict_cursor_t cursor = NULL;
628 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
629 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
631 xbt_dynar_merge(&ret,&onelink_child);
636 static xbt_dynar_t get_onelink_routes(void)
638 return recursive_get_onelink_routes(routing_platf->root);
641 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
643 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
647 return SURF_NETWORK_ELEMENT_NULL;
651 * \brief Generic method: create the global routing schema
653 * Make a global routing structure and set all the parsing functions.
655 void routing_model_create( void *loopback)
657 /* config the uniq global routing */
658 routing_platf = xbt_new0(s_routing_platf_t, 1);
659 routing_platf->root = NULL;
660 routing_platf->get_onelink_routes = get_onelink_routes;
661 routing_platf->loopback = loopback;
662 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
663 /* no current routing at moment */
664 current_routing = NULL;
668 /* ************************************************** */
669 /* ********** PATERN FOR NEW ROUTING **************** */
671 /* The minimal configuration of a new routing model need the next functions,
672 * also you need to set at the start of the file, the new model in the model
673 * list. Remember keep the null ending of the list.
675 /*** Routing model structure ***/
677 // s_routing_component_t generic_routing;
678 // /* things that your routing model need */
679 // } s_routing_component_NEW_t,*routing_component_NEW_t;
681 /*** Parse routing model functions ***/
682 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
683 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
684 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
685 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
686 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
688 /*** Business methods ***/
689 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
690 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
691 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
693 /*** Creation routing model functions ***/
694 // static void* model_NEW_create(void) {
695 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
696 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
697 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
698 // new_component->generic_routing.set_route = model_NEW_set_route;
699 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
700 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
701 // new_component->generic_routing.get_route = NEW_get_route;
702 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
703 // new_component->generic_routing.finalize = NEW_finalize;
704 // /* initialization of internal structures */
705 // return new_component;
707 // static void model_NEW_load(void) {} /* mandatory */
708 // static void model_NEW_unload(void) {} /* mandatory */
709 // static void model_NEW_end(void) {} /* mandatory */
711 /* ************************************************************************** */
712 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
714 void routing_cluster_add_backbone(void* bb) {
715 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
716 "You have to be in model Cluster to use tag backbone!");
717 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
718 ((as_cluster_t)current_routing)->backbone = bb;
719 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
722 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
725 char *groups , *host_id , *link_id = NULL;
727 xbt_dynar_t radical_elements;
728 xbt_dynar_t radical_ends;
731 radical_elements = xbt_str_split(cabinet->radical, ",");
732 xbt_dynar_foreach(radical_elements, iter, groups) {
734 radical_ends = xbt_str_split(groups, "-");
735 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
737 switch (xbt_dynar_length(radical_ends)) {
742 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
745 surf_parse_error("Malformed radical");
748 s_sg_platf_host_cbarg_t host;
749 memset(&host, 0, sizeof(host));
750 host.initial_state = SURF_RESOURCE_ON;
751 host.power_peak = cabinet->power;
752 host.power_scale = 1.0;
753 host.core_amount = 1;
755 s_sg_platf_link_cbarg_t link;
756 memset(&link, 0, sizeof(link));
757 link.state = SURF_RESOURCE_ON;
758 link.policy = SURF_LINK_FULLDUPLEX;
759 link.latency = cabinet->lat;
760 link.bandwidth = cabinet->bw;
762 s_sg_platf_host_link_cbarg_t host_link;
763 memset(&host_link, 0, sizeof(host_link));
765 for (i = start; i <= end; i++) {
766 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
767 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
770 sg_platf_new_host(&host);
771 sg_platf_new_link(&link);
773 char* link_up = bprintf("%s_UP",link_id);
774 char* link_down = bprintf("%s_DOWN",link_id);
775 host_link.id = host_id;
776 host_link.link_up = link_up;
777 host_link.link_down= link_down;
778 sg_platf_new_host_link(&host_link);
786 xbt_dynar_free(&radical_ends);
788 xbt_dynar_free(&radical_elements);
791 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
793 char *host_id, *groups, *link_id = NULL;
794 xbt_dict_t patterns = NULL;
796 s_sg_platf_host_cbarg_t host;
797 s_sg_platf_link_cbarg_t link;
801 xbt_dynar_t radical_elements;
802 xbt_dynar_t radical_ends;
804 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
805 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
806 patterns = xbt_dict_new_homogeneous(xbt_free_f);
807 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
808 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
809 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
812 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
813 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
815 AS.routing = A_surfxml_AS_routing_Cluster;
816 sg_platf_new_AS_begin(&AS);
818 current_routing->link_up_down_list
819 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
822 radical_elements = xbt_str_split(cluster->radical, ",");
823 xbt_dynar_foreach(radical_elements, iter, groups) {
825 radical_ends = xbt_str_split(groups, "-");
826 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
828 switch (xbt_dynar_length(radical_ends)) {
833 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
836 surf_parse_error("Malformed radical");
839 for (i = start; i <= end; i++) {
841 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
842 link_id = bprintf("%s_link_%d", cluster->id, i);
844 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
846 memset(&host, 0, sizeof(host));
848 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
849 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
850 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
851 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
852 host.power_trace = tmgr_trace_new_from_file(avail_file);
853 xbt_free(avail_file);
855 XBT_DEBUG("\tavailability_file=\"\"");
858 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
859 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
860 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
861 host.state_trace = tmgr_trace_new_from_file(avail_file);
862 xbt_free(avail_file);
864 XBT_DEBUG("\tstate_file=\"\"");
867 host.power_peak = cluster->power;
868 host.power_scale = 1.0;
869 host.core_amount = cluster->core_amount;
870 host.initial_state = SURF_RESOURCE_ON;
872 sg_platf_new_host(&host);
873 XBT_DEBUG("</host>");
875 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
876 cluster->bw, cluster->lat);
878 memset(&link, 0, sizeof(link));
880 link.bandwidth = cluster->bw;
881 link.latency = cluster->lat;
882 link.state = SURF_RESOURCE_ON;
883 link.policy = cluster->sharing_policy;
884 sg_platf_new_link(&link);
886 s_surf_parsing_link_up_down_t info;
888 if (link.policy == SURF_LINK_FULLDUPLEX) {
889 char *tmp_link = bprintf("%s_UP", link_id);
891 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
893 tmp_link = bprintf("%s_DOWN", link_id);
895 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
898 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
899 info.link_down = info.link_up;
902 if(cluster->limiter_link!=0){
903 char *tmp_link = bprintf("%s_limiter", link_id);
904 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
905 cluster->limiter_link);
908 memset(&link, 0, sizeof(link));
910 link.bandwidth = cluster->limiter_link;
912 link.state = SURF_RESOURCE_ON;
913 link.policy = SURF_LINK_SHARED;
914 sg_platf_new_link(&link);
916 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
919 info.limiter_link =NULL;
922 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
923 char *tmp_link = bprintf("%s_loopback", link_id);
924 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
925 cluster->limiter_link);
928 memset(&link, 0, sizeof(link));
930 link.bandwidth = cluster->loopback_bw;
931 link.latency = cluster->loopback_lat;
932 link.state = SURF_RESOURCE_ON;
933 link.policy = SURF_LINK_FATPIPE;
934 sg_platf_new_link(&link);
936 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
939 info.loopback_link =NULL;
942 xbt_dynar_push(current_routing->link_up_down_list,&info);
947 xbt_dynar_free(&radical_ends);
949 xbt_dynar_free(&radical_elements);
951 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
952 // and it's very useful to connect clusters together
954 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
956 s_sg_platf_router_cbarg_t router;
957 memset(&router, 0, sizeof(router));
958 router.id = cluster->router_id;
960 if (!router.id || !strcmp(router.id, ""))
962 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
964 sg_platf_new_router(&router);
965 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
969 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
970 char *link_backbone = bprintf("%s_backbone", cluster->id);
971 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
972 cluster->bb_bw, cluster->bb_lat);
974 memset(&link, 0, sizeof(link));
975 link.id = link_backbone;
976 link.bandwidth = cluster->bb_bw;
977 link.latency = cluster->bb_lat;
978 link.state = SURF_RESOURCE_ON;
979 link.policy = cluster->bb_sharing_policy;
981 sg_platf_new_link(&link);
983 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
989 sg_platf_new_AS_end();
991 xbt_dict_free(&patterns); // no op if it were never set
994 static void routing_parse_postparse(void) {
995 xbt_dict_free(&random_value);
998 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1000 char *host_id = NULL;
1004 host_id = HOST_PEER(peer->id);
1005 link_id = LINK_PEER(peer->id);
1007 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1008 s_sg_platf_host_cbarg_t host;
1009 memset(&host, 0, sizeof(host));
1010 host.initial_state = SURF_RESOURCE_ON;
1012 host.power_peak = peer->power;
1013 host.power_scale = 1.0;
1014 host.power_trace = peer->availability_trace;
1015 host.state_trace = peer->state_trace;
1016 host.core_amount = 1;
1017 host.coord = peer->coord;
1018 sg_platf_new_host(&host);
1020 s_sg_platf_link_cbarg_t link;
1021 memset(&link, 0, sizeof(link));
1022 link.state = SURF_RESOURCE_ON;
1023 link.policy = SURF_LINK_SHARED;
1024 link.latency = peer->lat;
1026 char* link_up = bprintf("%s_UP",link_id);
1027 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1028 peer->bw_out, peer->lat);
1030 link.bandwidth = peer->bw_out;
1031 sg_platf_new_link(&link);
1033 char* link_down = bprintf("%s_DOWN",link_id);
1034 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1035 peer->bw_in, peer->lat);
1036 link.id = link_down;
1037 link.bandwidth = peer->bw_in;
1038 sg_platf_new_link(&link);
1040 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1041 s_sg_platf_host_link_cbarg_t host_link;
1042 memset(&host_link, 0, sizeof(host_link));
1043 host_link.id = host_id;
1044 host_link.link_up = link_up;
1045 host_link.link_down= link_down;
1046 sg_platf_new_host_link(&host_link);
1050 //xbt_dynar_free(&tab_elements_num);
1057 static void routing_parse_Srandom(void)
1059 double mean, std, min, max, seed;
1060 char *random_id = A_surfxml_random_id;
1061 char *random_radical = A_surfxml_random_radical;
1062 char *rd_name = NULL;
1064 mean = surf_parse_get_double(A_surfxml_random_mean);
1065 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1066 min = surf_parse_get_double(A_surfxml_random_min);
1067 max = surf_parse_get_double(A_surfxml_random_max);
1068 seed = surf_parse_get_double(A_surfxml_random_seed);
1072 random_data_t random = xbt_new0(s_random_data_t, 1);
1075 xbt_dynar_t radical_elements;
1079 xbt_dynar_t radical_ends;
1081 switch (A_surfxml_random_generator) {
1082 case AU_surfxml_random_generator:
1083 case A_surfxml_random_generator_NONE:
1084 random->generator = NONE;
1086 case A_surfxml_random_generator_DRAND48:
1087 random->generator = DRAND48;
1089 case A_surfxml_random_generator_RAND:
1090 random->generator = RAND;
1092 case A_surfxml_random_generator_RNGSTREAM:
1093 random->generator = RNGSTREAM;
1096 surf_parse_error("Invalid random generator");
1099 random->seed = seed;
1103 /* Check user stupidities */
1105 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1107 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1109 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1111 /* normalize the mean and standard deviation before storing */
1112 random->mean = (mean - min) / (max - min);
1113 random->std = std / (max - min);
1115 if (random->mean * (1 - random->mean) < random->std * random->std)
1116 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1117 random->mean, random->std);
1120 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1121 random_id, random->min, random->max, random->mean, random->std,
1122 (int)random->generator, random->seed, random_radical);
1125 random_value = xbt_dict_new_homogeneous(free);
1127 if (!strcmp(random_radical, "")) {
1128 res = random_generate(random);
1129 rd_value = bprintf("%f", res);
1130 xbt_dict_set(random_value, random_id, rd_value, NULL);
1132 radical_elements = xbt_str_split(random_radical, ",");
1133 xbt_dynar_foreach(radical_elements, iter, groups) {
1134 radical_ends = xbt_str_split(groups, "-");
1135 switch (xbt_dynar_length(radical_ends)) {
1137 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1138 "Custom Random '%s' already exists !", random_id);
1139 res = random_generate(random);
1141 bprintf("%s%d", random_id,
1142 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1143 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1148 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1149 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1150 for (i = start; i <= end; i++) {
1151 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1152 "Custom Random '%s' already exists !", bprintf("%s%d",
1155 res = random_generate(random);
1156 tmpbuf = bprintf("%s%d", random_id, i);
1157 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1162 XBT_CRITICAL("Malformed radical");
1165 res = random_generate(random);
1166 rd_name = bprintf("%s_router", random_id);
1167 rd_value = bprintf("%f", res);
1168 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1170 xbt_dynar_free(&radical_ends);
1173 xbt_dynar_free(&radical_elements);
1177 void routing_register_callbacks()
1179 sg_platf_host_add_cb(parse_S_host);
1180 sg_platf_router_add_cb(parse_S_router);
1181 sg_platf_host_link_add_cb(parse_S_host_link);
1182 sg_platf_route_add_cb(parse_E_route);
1183 sg_platf_ASroute_add_cb(parse_E_ASroute);
1184 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1185 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1187 sg_platf_cluster_add_cb(routing_parse_cluster);
1188 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1190 sg_platf_peer_add_cb(routing_parse_peer);
1191 sg_platf_postparse_add_cb(routing_parse_postparse);
1193 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1194 sg_platf_AS_end_add_cb(routing_AS_end);
1195 sg_platf_AS_begin_add_cb(routing_AS_begin);
1197 sg_platf_trace_add_cb(routing_parse_trace);
1198 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1201 instr_routing_define_callbacks();
1206 * \brief Recursive function for finalize
1208 * \param rc the source host name
1210 * This fuction is call by "finalize". It allow to finalize the
1211 * AS or routing components. It delete all the structures.
1213 static void finalize_rec(AS_t as) {
1214 xbt_dict_cursor_t cursor = NULL;
1218 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1225 /** \brief Frees all memory allocated by the routing module */
1226 void routing_exit(void) {
1229 xbt_dynar_free(&routing_platf->last_route);
1230 finalize_rec(routing_platf->root);
1231 xbt_free(routing_platf);