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,
82 struct s_model_type routing_models[] = {
84 "Full routing data (fast, large memory requirements, fully expressive)",
85 model_full_create, model_full_end},
87 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
88 model_floyd_create, model_floyd_end},
90 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
91 model_dijkstra_create, model_dijkstra_both_end},
93 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
94 model_dijkstracache_create, model_dijkstra_both_end},
95 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
96 model_none_create, NULL},
97 {"Vivaldi", "Vivaldi routing",
98 model_vivaldi_create, NULL},
99 {"Cluster", "Cluster routing",
100 model_cluster_create, NULL},
101 {NULL, NULL, NULL, NULL}
105 * \brief Add a "host_link" to the network element list
107 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
109 sg_routing_edge_t info = NULL;
110 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
111 xbt_assert(info, "Host '%s' not found!",host->id);
112 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
113 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
114 "You have to be in model Cluster to use tag host_link!");
116 s_surf_parsing_link_up_down_t link_up_down;
117 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
118 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
119 link_up_down.limiter_link = NULL;
120 link_up_down.loopback_link = NULL;
122 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
123 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
125 if(!current_routing->link_up_down_list)
126 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
128 // If dynar is is greater than edge id and if the host_link is already defined
129 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
130 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
131 xbt_die("Host_link for '%s' is already defined!",host->id);
133 XBT_DEBUG("Push Host_link for host '%s' to position %d",info->name,info->id);
134 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
138 * \brief Add a "host" to the network element list
140 static void parse_S_host(sg_platf_host_cbarg_t host)
142 sg_routing_edge_t info = NULL;
143 if (current_routing->hierarchy == SURF_ROUTING_NULL)
144 current_routing->hierarchy = SURF_ROUTING_BASE;
145 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
146 "Reading a host, processing unit \"%s\" already exists", host->id);
148 info = xbt_new0(s_routing_edge_t, 1);
149 info->rc_component = current_routing;
150 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
151 info->name = xbt_strdup(host->id);
152 info->id = current_routing->parse_PU(current_routing, (void *) info);
153 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
154 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
157 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
161 if (host->coord && strcmp(host->coord, "")) {
165 if (!COORD_HOST_LEVEL)
166 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
167 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
168 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
169 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
170 xbt_dynar_foreach(ctn_str,cursor, str) {
171 double val = atof(str);
172 xbt_dynar_push(ctn,&val);
174 xbt_dynar_shrink(ctn, 0);
175 xbt_dynar_free(&ctn_str);
176 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
177 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
182 * \brief Add a "router" to the network element list
184 static void parse_S_router(sg_platf_router_cbarg_t router)
186 sg_routing_edge_t info = NULL;
187 if (current_routing->hierarchy == SURF_ROUTING_NULL)
188 current_routing->hierarchy = SURF_ROUTING_BASE;
189 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
190 "Reading a router, processing unit \"%s\" already exists",
193 info = xbt_new0(s_routing_edge_t, 1);
194 info->rc_component = current_routing;
195 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
196 info->name = xbt_strdup(router->id);
197 info->id = current_routing->parse_PU(current_routing, (void *) info);
198 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
199 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
201 if (router->coord && strcmp(router->coord, "")) {
205 if (!COORD_ASR_LEVEL)
206 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
207 /* Pre-parse the host coordinates */
208 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
209 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
210 xbt_dynar_foreach(ctn_str,cursor, str) {
211 double val = atof(str);
212 xbt_dynar_push(ctn,&val);
214 xbt_dynar_shrink(ctn, 0);
215 xbt_dynar_free(&ctn_str);
216 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
217 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
222 * \brief Store the route by calling the set_route function of the current routing component
224 static void parse_E_route(sg_platf_route_cbarg_t route)
226 xbt_assert(current_routing->parse_route,
227 "no defined method \"set_route\" in \"%s\"",
228 current_routing->name);
230 current_routing->parse_route(current_routing, route);
234 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
236 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
238 xbt_assert(current_routing->parse_ASroute,
239 "no defined method \"set_ASroute\" in \"%s\"",
240 current_routing->name);
241 current_routing->parse_ASroute(current_routing, ASroute);
245 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
247 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
249 xbt_assert(current_routing->parse_bypassroute,
250 "Bypassing mechanism not implemented by routing '%s'",
251 current_routing->name);
253 current_routing->parse_bypassroute(current_routing, route);
257 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
259 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
261 xbt_assert(current_routing->parse_bypassroute,
262 "Bypassing mechanism not implemented by routing '%s'",
263 current_routing->name);
264 current_routing->parse_bypassroute(current_routing, ASroute);
267 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
269 tmgr_trace_t tmgr_trace;
270 if (!trace->file || strcmp(trace->file, "") != 0) {
271 tmgr_trace = tmgr_trace_new_from_file(trace->file);
272 } else if (strcmp(trace->pc_data, "") == 0) {
276 tmgr_trace_new_from_string(trace->id, trace->pc_data,
279 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
282 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
284 xbt_assert(xbt_dict_get_or_null
285 (traces_set_list, trace_connect->trace),
286 "Cannot connect trace %s to %s: trace unknown",
287 trace_connect->trace,
288 trace_connect->element);
290 switch (trace_connect->kind) {
291 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
292 xbt_dict_set(trace_connect_list_host_avail,
293 trace_connect->trace,
294 xbt_strdup(trace_connect->element), NULL);
296 case SURF_TRACE_CONNECT_KIND_POWER:
297 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
298 xbt_strdup(trace_connect->element), NULL);
300 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
301 xbt_dict_set(trace_connect_list_link_avail,
302 trace_connect->trace,
303 xbt_strdup(trace_connect->element), NULL);
305 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
306 xbt_dict_set(trace_connect_list_bandwidth,
307 trace_connect->trace,
308 xbt_strdup(trace_connect->element), NULL);
310 case SURF_TRACE_CONNECT_KIND_LATENCY:
311 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
312 xbt_strdup(trace_connect->element), NULL);
315 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
316 trace_connect->trace, trace_connect->element);
321 extern int _sg_init_status; /* yay, this is an horrible hack */
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_init_status = 2; /* horrible hack: direct access to the global controlling the level of configuration to prevent any further config */
348 /* search the routing model */
350 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
351 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
352 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
353 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
354 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
355 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
356 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
357 default: xbt_die("Not a valid model!!!");
361 /* make a new routing component */
362 new_as = (AS_t) model->create();
363 new_as->model_desc = model;
364 new_as->hierarchy = SURF_ROUTING_NULL;
365 new_as->name = xbt_strdup(AS->id);
367 sg_routing_edge_t info = NULL;
368 info = xbt_new0(s_routing_edge_t, 1);
370 if (current_routing == NULL && routing_platf->root == NULL) {
372 /* it is the first one */
373 new_as->routing_father = NULL;
374 routing_platf->root = new_as;
376 } else if (current_routing != NULL && routing_platf->root != NULL) {
378 xbt_assert(!xbt_dict_get_or_null
379 (current_routing->routing_sons, AS->id),
380 "The AS \"%s\" already exists", AS->id);
381 /* it is a part of the tree */
382 new_as->routing_father = current_routing;
383 /* set the father behavior */
384 if (current_routing->hierarchy == SURF_ROUTING_NULL)
385 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
386 /* add to the sons dictionary */
387 xbt_dict_set(current_routing->routing_sons, AS->id,
388 (void *) new_as, NULL);
389 /* add to the father element list */
390 info->id = current_routing->parse_AS(current_routing, (void *) info);
392 THROWF(arg_error, 0, "All defined components must be belong to a AS");
395 info->rc_component = new_as->routing_father;
396 info->rc_type = SURF_NETWORK_ELEMENT_AS;
397 info->name = new_as->name;
399 xbt_lib_set(as_router_lib, info->name, ROUTING_ASR_LEVEL,
401 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
403 /* set the new current component of the tree */
404 current_routing = new_as;
405 current_routing->net_elem = info;
410 * \brief Specify that the current description of AS is finished
412 * Once you've declared all the content of your AS, you have to close
413 * it with this call. Your AS is not usable until you call this function.
415 * @fixme: this call is not as robust as wanted: bad things WILL happen
416 * if you call it twice for the same AS, or if you forget calling it, or
417 * even if you add stuff to a closed AS
420 void routing_AS_end(sg_platf_AS_cbarg_t AS)
423 if (current_routing == NULL) {
424 THROWF(arg_error, 0, "Close an AS, but none was under construction");
426 if (current_routing->model_desc->end)
427 current_routing->model_desc->end(current_routing);
428 current_routing = current_routing->routing_father;
432 /* Aux Business methods */
435 * \brief Get the AS father and the first elements of the chain
437 * \param src the source host name
438 * \param dst the destination host name
440 * Get the common father of the to processing units, and the first different
441 * father in the chain
443 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
448 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
449 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
451 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
452 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
460 /* (1) find the as where the src and dst are located */
461 sg_routing_edge_t src_data = src;
462 sg_routing_edge_t dst_data = dst;
463 src_as = src_data->rc_component;
464 dst_as = dst_data->rc_component;
466 char* src_name = src_data->name;
467 char* dst_name = dst_data->name;
470 xbt_assert(src_as && dst_as,
471 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
473 /* (2) find the path to the root routing component */
474 for (current = src_as; current != NULL; current = current->routing_father) {
475 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
476 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
477 path_src[index_src++] = current;
479 for (current = dst_as; current != NULL; current = current->routing_father) {
480 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
481 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
482 path_dst[index_dst++] = current;
485 /* (3) find the common father */
487 current_src = path_src[--index_src];
488 current_dst = path_dst[--index_dst];
489 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
491 /* (4) they are not in the same routing component, make the path */
492 if (current_src == current_dst)
493 father = current_src;
495 father = path_src[index_src + 1];
497 /* (5) result generation */
498 *res_father = father; /* first the common father of src and dst */
499 *res_src = current_src; /* second the first different father of src */
500 *res_dst = current_dst; /* three the first different father of dst */
502 #undef ELEMENTS_FATHER_MAXDEPTH
505 /* Global Business methods */
508 * \brief Recursive function for get_route_latency
510 * \param src the source host name
511 * \param dst the destination host name
512 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
513 * \param *latency the latency, if needed
515 * This function is called by "get_route" and "get_latency". It allows to walk
516 * recursively through the ASes tree.
518 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
519 xbt_dynar_t * links, double *latency)
521 s_sg_platf_route_cbarg_t route;
522 memset(&route,0,sizeof(route));
524 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
525 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
527 /* Find how src and dst are interconnected */
528 AS_t common_father, src_father, dst_father;
529 elements_father(src, dst, &common_father, &src_father, &dst_father);
530 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
531 common_father->name,src_father->name,dst_father->name);
533 /* Check whether a direct bypass is defined */
534 sg_platf_route_cbarg_t e_route_bypass = NULL;
535 if (common_father->get_bypass_route)
536 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
538 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
539 if (e_route_bypass) {
540 xbt_dynar_merge(links, &e_route_bypass->link_list);
541 generic_free_route(e_route_bypass);
545 /* If src and dst are in the same AS, life is good */
546 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
547 route.link_list = *links;
548 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
549 // if vivaldi latency+=vivaldi(src,dst)
553 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
555 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
556 // Find the net_card corresponding to father
557 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
558 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
560 common_father->get_route_and_latency(common_father,
561 src_father_net_elm, dst_father_net_elm,
564 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
565 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
567 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
568 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
570 /* If source gateway is not our source, we have to recursively find our way up to this point */
571 if (src != src_gateway_net_elm)
572 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
573 xbt_dynar_merge(links, &route.link_list);
575 /* If dest gateway is not our destination, we have to recursively find our way from this point */
576 if (dst_gateway_net_elm != dst)
577 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
579 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
583 * \brief Find a route between hosts
585 * \param src the network_element_t for src host
586 * \param dst the network_element_t for dst host
587 * \param route where to store the list of links.
588 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
589 * \param latency where to store the latency experienced on the path (or NULL if not interested)
590 * It is the caller responsability to initialize latency to 0 (we add to provided route)
593 * walk through the routing components tree and find a route between hosts
594 * by calling the differents "get_route" functions in each routing component.
596 void routing_get_route_and_latency(sg_routing_edge_t src,
597 sg_routing_edge_t dst,
598 xbt_dynar_t * route, double *latency)
600 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
602 xbt_dynar_reset(routing_platf->last_route);
603 *route = routing_platf->last_route;
606 _get_route_and_latency(src, dst, route, latency);
608 xbt_assert(!latency || *latency >= 0.0,
609 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
612 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
614 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
616 //adding my one link routes
617 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
619 xbt_dynar_merge(&ret,&onelink_mine);
623 xbt_dict_cursor_t cursor = NULL;
625 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
626 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
628 xbt_dynar_merge(&ret,&onelink_child);
633 static xbt_dynar_t get_onelink_routes(void)
635 return recursive_get_onelink_routes(routing_platf->root);
638 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
640 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
644 return SURF_NETWORK_ELEMENT_NULL;
648 * \brief Generic method: create the global routing schema
650 * Make a global routing structure and set all the parsing functions.
652 void routing_model_create( void *loopback)
654 /* config the uniq global routing */
655 routing_platf = xbt_new0(s_routing_platf_t, 1);
656 routing_platf->root = NULL;
657 routing_platf->get_onelink_routes = get_onelink_routes;
658 routing_platf->loopback = loopback;
659 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
660 /* no current routing at moment */
661 current_routing = NULL;
665 /* ************************************************** */
666 /* ********** PATERN FOR NEW ROUTING **************** */
668 /* The minimal configuration of a new routing model need the next functions,
669 * also you need to set at the start of the file, the new model in the model
670 * list. Remember keep the null ending of the list.
672 /*** Routing model structure ***/
674 // s_routing_component_t generic_routing;
675 // /* things that your routing model need */
676 // } s_routing_component_NEW_t,*routing_component_NEW_t;
678 /*** Parse routing model functions ***/
679 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
680 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
681 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
682 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
683 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
685 /*** Business methods ***/
686 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
687 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
688 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
690 /*** Creation routing model functions ***/
691 // static void* model_NEW_create(void) {
692 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
693 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
694 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
695 // new_component->generic_routing.set_route = model_NEW_set_route;
696 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
697 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
698 // new_component->generic_routing.get_route = NEW_get_route;
699 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
700 // new_component->generic_routing.finalize = NEW_finalize;
701 // /* initialization of internal structures */
702 // return new_component;
704 // static void model_NEW_load(void) {} /* mandatory */
705 // static void model_NEW_unload(void) {} /* mandatory */
706 // static void model_NEW_end(void) {} /* mandatory */
708 /* ************************************************************************** */
709 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
711 void routing_cluster_add_backbone(void* bb) {
712 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
713 "You have to be in model Cluster to use tag backbone!");
714 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
715 ((as_cluster_t)current_routing)->backbone = bb;
716 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
719 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
722 char *groups , *host_id , *link_id = NULL;
724 xbt_dynar_t radical_elements;
725 xbt_dynar_t radical_ends;
728 radical_elements = xbt_str_split(cabinet->radical, ",");
729 xbt_dynar_foreach(radical_elements, iter, groups) {
731 radical_ends = xbt_str_split(groups, "-");
732 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
734 switch (xbt_dynar_length(radical_ends)) {
739 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
742 surf_parse_error("Malformed radical");
745 s_sg_platf_host_cbarg_t host;
746 memset(&host, 0, sizeof(host));
747 host.initial_state = SURF_RESOURCE_ON;
748 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
749 xbt_dynar_push(power_state_list,&cabinet->power);
750 host.power_peak = power_state_list;
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 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
868 xbt_dynar_push(power_state_list,&cluster->power);
869 host.power_peak = power_state_list;
872 //host.power_peak = cluster->power;
873 host.power_scale = 1.0;
874 host.core_amount = cluster->core_amount;
875 host.initial_state = SURF_RESOURCE_ON;
877 sg_platf_new_host(&host);
878 XBT_DEBUG("</host>");
880 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
881 cluster->bw, cluster->lat);
883 memset(&link, 0, sizeof(link));
885 link.bandwidth = cluster->bw;
886 link.latency = cluster->lat;
887 link.state = SURF_RESOURCE_ON;
888 link.policy = cluster->sharing_policy;
889 sg_platf_new_link(&link);
891 s_surf_parsing_link_up_down_t info;
893 if (link.policy == SURF_LINK_FULLDUPLEX) {
894 char *tmp_link = bprintf("%s_UP", link_id);
896 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
898 tmp_link = bprintf("%s_DOWN", link_id);
900 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
903 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
904 info.link_down = info.link_up;
907 if(cluster->limiter_link!=0){
908 char *tmp_link = bprintf("%s_limiter", link_id);
909 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
910 cluster->limiter_link);
913 memset(&link, 0, sizeof(link));
915 link.bandwidth = cluster->limiter_link;
917 link.state = SURF_RESOURCE_ON;
918 link.policy = SURF_LINK_SHARED;
919 sg_platf_new_link(&link);
921 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
924 info.limiter_link =NULL;
927 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
928 char *tmp_link = bprintf("%s_loopback", link_id);
929 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
930 cluster->limiter_link);
933 memset(&link, 0, sizeof(link));
935 link.bandwidth = cluster->loopback_bw;
936 link.latency = cluster->loopback_lat;
937 link.state = SURF_RESOURCE_ON;
938 link.policy = SURF_LINK_FATPIPE;
939 sg_platf_new_link(&link);
941 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
944 info.loopback_link =NULL;
947 xbt_dynar_push(current_routing->link_up_down_list,&info);
952 xbt_dynar_free(&radical_ends);
954 xbt_dynar_free(&radical_elements);
956 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
957 // and it's very useful to connect clusters together
959 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
961 s_sg_platf_router_cbarg_t router;
962 memset(&router, 0, sizeof(router));
963 router.id = cluster->router_id;
965 if (!router.id || !strcmp(router.id, ""))
967 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
969 sg_platf_new_router(&router);
970 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
974 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
975 char *link_backbone = bprintf("%s_backbone", cluster->id);
976 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
977 cluster->bb_bw, cluster->bb_lat);
979 memset(&link, 0, sizeof(link));
980 link.id = link_backbone;
981 link.bandwidth = cluster->bb_bw;
982 link.latency = cluster->bb_lat;
983 link.state = SURF_RESOURCE_ON;
984 link.policy = cluster->bb_sharing_policy;
986 sg_platf_new_link(&link);
988 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
994 sg_platf_new_AS_end();
996 xbt_dict_free(&patterns); // no op if it were never set
999 static void routing_parse_postparse(void) {
1000 xbt_dict_free(&random_value);
1003 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1005 char *host_id = NULL;
1009 host_id = HOST_PEER(peer->id);
1010 link_id = LINK_PEER(peer->id);
1012 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1013 s_sg_platf_host_cbarg_t host;
1014 memset(&host, 0, sizeof(host));
1015 host.initial_state = SURF_RESOURCE_ON;
1018 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
1019 xbt_dynar_push(power_state_list,&peer->power);
1020 host.power_peak = power_state_list;
1022 //host.power_peak = peer->power;
1023 host.power_scale = 1.0;
1024 host.power_trace = peer->availability_trace;
1025 host.state_trace = peer->state_trace;
1026 host.core_amount = 1;
1027 host.coord = peer->coord;
1028 sg_platf_new_host(&host);
1030 s_sg_platf_link_cbarg_t link;
1031 memset(&link, 0, sizeof(link));
1032 link.state = SURF_RESOURCE_ON;
1033 link.policy = SURF_LINK_SHARED;
1034 link.latency = peer->lat;
1036 char* link_up = bprintf("%s_UP",link_id);
1037 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1038 peer->bw_out, peer->lat);
1040 link.bandwidth = peer->bw_out;
1041 sg_platf_new_link(&link);
1043 char* link_down = bprintf("%s_DOWN",link_id);
1044 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1045 peer->bw_in, peer->lat);
1046 link.id = link_down;
1047 link.bandwidth = peer->bw_in;
1048 sg_platf_new_link(&link);
1050 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1051 s_sg_platf_host_link_cbarg_t host_link;
1052 memset(&host_link, 0, sizeof(host_link));
1053 host_link.id = host_id;
1054 host_link.link_up = link_up;
1055 host_link.link_down= link_down;
1056 sg_platf_new_host_link(&host_link);
1060 //xbt_dynar_free(&tab_elements_num);
1067 static void routing_parse_Srandom(void)
1069 double mean, std, min, max, seed;
1070 char *random_id = A_surfxml_random_id;
1071 char *random_radical = A_surfxml_random_radical;
1072 char *rd_name = NULL;
1074 mean = surf_parse_get_double(A_surfxml_random_mean);
1075 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1076 min = surf_parse_get_double(A_surfxml_random_min);
1077 max = surf_parse_get_double(A_surfxml_random_max);
1078 seed = surf_parse_get_double(A_surfxml_random_seed);
1082 random_data_t random = xbt_new0(s_random_data_t, 1);
1085 xbt_dynar_t radical_elements;
1089 xbt_dynar_t radical_ends;
1091 switch (A_surfxml_random_generator) {
1092 case AU_surfxml_random_generator:
1093 case A_surfxml_random_generator_NONE:
1094 random->generator = NONE;
1096 case A_surfxml_random_generator_DRAND48:
1097 random->generator = DRAND48;
1099 case A_surfxml_random_generator_RAND:
1100 random->generator = RAND;
1102 case A_surfxml_random_generator_RNGSTREAM:
1103 random->generator = RNGSTREAM;
1106 surf_parse_error("Invalid random generator");
1109 random->seed = seed;
1113 /* Check user stupidities */
1115 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1117 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1119 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1121 /* normalize the mean and standard deviation before storing */
1122 random->mean = (mean - min) / (max - min);
1123 random->std = std / (max - min);
1125 if (random->mean * (1 - random->mean) < random->std * random->std)
1126 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1127 random->mean, random->std);
1130 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1131 random_id, random->min, random->max, random->mean, random->std,
1132 (int)random->generator, random->seed, random_radical);
1135 random_value = xbt_dict_new_homogeneous(free);
1137 if (!strcmp(random_radical, "")) {
1138 res = random_generate(random);
1139 rd_value = bprintf("%f", res);
1140 xbt_dict_set(random_value, random_id, rd_value, NULL);
1142 radical_elements = xbt_str_split(random_radical, ",");
1143 xbt_dynar_foreach(radical_elements, iter, groups) {
1144 radical_ends = xbt_str_split(groups, "-");
1145 switch (xbt_dynar_length(radical_ends)) {
1147 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1148 "Custom Random '%s' already exists !", random_id);
1149 res = random_generate(random);
1151 bprintf("%s%d", random_id,
1152 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1153 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1158 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1159 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1160 for (i = start; i <= end; i++) {
1161 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1162 "Custom Random '%s' already exists !", bprintf("%s%d",
1165 res = random_generate(random);
1166 tmpbuf = bprintf("%s%d", random_id, i);
1167 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1172 XBT_CRITICAL("Malformed radical");
1175 res = random_generate(random);
1176 rd_name = bprintf("%s_router", random_id);
1177 rd_value = bprintf("%f", res);
1178 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1180 xbt_dynar_free(&radical_ends);
1183 xbt_dynar_free(&radical_elements);
1187 void routing_register_callbacks()
1189 sg_platf_host_add_cb(parse_S_host);
1190 sg_platf_router_add_cb(parse_S_router);
1191 sg_platf_host_link_add_cb(parse_S_host_link);
1192 sg_platf_route_add_cb(parse_E_route);
1193 sg_platf_ASroute_add_cb(parse_E_ASroute);
1194 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1195 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1197 sg_platf_cluster_add_cb(routing_parse_cluster);
1198 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1200 sg_platf_peer_add_cb(routing_parse_peer);
1201 sg_platf_postparse_add_cb(routing_parse_postparse);
1203 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1204 sg_platf_AS_end_add_cb(routing_AS_end);
1205 sg_platf_AS_begin_add_cb(routing_AS_begin);
1207 sg_platf_trace_add_cb(routing_parse_trace);
1208 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1211 instr_routing_define_callbacks();
1216 * \brief Recursive function for finalize
1218 * \param rc the source host name
1220 * This fuction is call by "finalize". It allow to finalize the
1221 * AS or routing components. It delete all the structures.
1223 static void finalize_rec(AS_t as) {
1224 xbt_dict_cursor_t cursor = NULL;
1228 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1235 /** \brief Frees all memory allocated by the routing module */
1236 void routing_exit(void) {
1239 xbt_dynar_free(&routing_platf->last_route);
1240 finalize_rec(routing_platf->root);
1241 xbt_free(routing_platf);
1244 AS_t surf_AS_get_routing_root() {
1245 return routing_platf->root;
1248 const char *surf_AS_get_name(AS_t as) {
1252 xbt_dict_t surf_AS_get_routing_sons(AS_t as) {
1253 return as->routing_sons;
1256 const char *surf_AS_get_model(AS_t as) {
1257 return as->model_desc->name;
1260 xbt_dynar_t surf_AS_get_hosts(AS_t as) {
1261 xbt_dynar_t elms = as->index_network_elm;
1262 sg_routing_edge_t relm;
1265 int count = xbt_dynar_length(elms);
1266 xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_dictelm_t), NULL);
1267 for (index = 0; index < count; index++) {
1268 relm = xbt_dynar_get_as(elms, index, sg_routing_edge_t);
1269 delm = xbt_lib_get_elm_or_null(host_lib, relm->name);
1271 xbt_dynar_push(res, &delm);