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
29 * @ingroup SURF_build_api
30 * @brief A library containing all known links
33 int SD_LINK_LEVEL; //Simdag level
34 int SURF_LINK_LEVEL; //Surf level
35 int NS3_LINK_LEVEL; //link for ns3
37 xbt_lib_t as_router_lib;
38 int ROUTING_ASR_LEVEL; //Routing level
39 int COORD_ASR_LEVEL; //Coordinates level
40 int NS3_ASR_LEVEL; //host node for ns3
41 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
43 static xbt_dict_t random_value = NULL;
45 /** @brief Retrieve a routing edge from its name
47 * Routing edges are either CPU/workstation and routers, whatever
49 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
50 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
51 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
56 routing_platf_t routing_platf = NULL;
57 AS_t current_routing = NULL;
59 /* global parse functions */
60 extern xbt_dynar_t mount_list;
62 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
64 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
65 static void routing_parse_Srandom(void); /* random bypass */
67 static void routing_parse_postparse(void);
69 /* this lines are only for replace use like index in the model table */
74 SURF_MODEL_DIJKSTRACACHE,
80 struct s_model_type routing_models[] = {
82 "Full routing data (fast, large memory requirements, fully expressive)",
83 model_full_create, model_full_end},
85 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
86 model_floyd_create, model_floyd_end},
88 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
89 model_dijkstra_create, model_dijkstra_both_end},
91 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
92 model_dijkstracache_create, model_dijkstra_both_end},
93 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
94 model_none_create, NULL},
95 {"Vivaldi", "Vivaldi routing",
96 model_vivaldi_create, NULL},
97 {"Cluster", "Cluster routing",
98 model_cluster_create, NULL},
99 {NULL, NULL, NULL, NULL}
103 * \brief Add a "host_link" to the network element list
105 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
107 sg_routing_edge_t info = NULL;
108 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
109 xbt_assert(info, "Host '%s' not found!",host->id);
110 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
111 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
112 "You have to be in model Cluster to use tag host_link!");
114 s_surf_parsing_link_up_down_t link_up_down;
115 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
116 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
117 link_up_down.limiter_link = NULL;
118 link_up_down.loopback_link = NULL;
120 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
121 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
123 if(!current_routing->link_up_down_list)
124 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
126 // If dynar is is greater than edge id and if the host_link is already defined
127 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
128 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
129 xbt_die("Host_link for '%s' is already defined!",host->id);
131 XBT_DEBUG("Push Host_link for host '%s' to position %d",info->name,info->id);
132 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
136 * \brief Add a "host" to the network element list
138 static void parse_S_host(sg_platf_host_cbarg_t host)
140 sg_routing_edge_t info = NULL;
141 if (current_routing->hierarchy == SURF_ROUTING_NULL)
142 current_routing->hierarchy = SURF_ROUTING_BASE;
143 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
144 "Reading a host, processing unit \"%s\" already exists", host->id);
146 info = xbt_new0(s_routing_edge_t, 1);
147 info->rc_component = current_routing;
148 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
149 info->name = xbt_strdup(host->id);
150 info->id = current_routing->parse_PU(current_routing, (void *) info);
151 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
152 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
155 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
159 if (host->coord && strcmp(host->coord, "")) {
163 if (!COORD_HOST_LEVEL)
164 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
165 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
166 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
167 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
168 xbt_dynar_foreach(ctn_str,cursor, str) {
169 double val = atof(str);
170 xbt_dynar_push(ctn,&val);
172 xbt_dynar_shrink(ctn, 0);
173 xbt_dynar_free(&ctn_str);
174 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
175 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
180 * \brief Add a "router" to the network element list
182 static void parse_S_router(sg_platf_router_cbarg_t router)
184 sg_routing_edge_t info = NULL;
185 if (current_routing->hierarchy == SURF_ROUTING_NULL)
186 current_routing->hierarchy = SURF_ROUTING_BASE;
187 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
188 "Reading a router, processing unit \"%s\" already exists",
191 info = xbt_new0(s_routing_edge_t, 1);
192 info->rc_component = current_routing;
193 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
194 info->name = xbt_strdup(router->id);
195 info->id = current_routing->parse_PU(current_routing, (void *) info);
196 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
197 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
199 if (router->coord && strcmp(router->coord, "")) {
203 if (!COORD_ASR_LEVEL)
204 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
205 /* Pre-parse the host coordinates */
206 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
207 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
208 xbt_dynar_foreach(ctn_str,cursor, str) {
209 double val = atof(str);
210 xbt_dynar_push(ctn,&val);
212 xbt_dynar_shrink(ctn, 0);
213 xbt_dynar_free(&ctn_str);
214 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
215 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
220 * \brief Store the route by calling the set_route function of the current routing component
222 static void parse_E_route(sg_platf_route_cbarg_t route)
224 xbt_assert(current_routing->parse_route,
225 "no defined method \"set_route\" in \"%s\"",
226 current_routing->name);
228 current_routing->parse_route(current_routing, route);
232 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
234 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
236 xbt_assert(current_routing->parse_ASroute,
237 "no defined method \"set_ASroute\" in \"%s\"",
238 current_routing->name);
239 current_routing->parse_ASroute(current_routing, ASroute);
243 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
245 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
247 xbt_assert(current_routing->parse_bypassroute,
248 "Bypassing mechanism not implemented by routing '%s'",
249 current_routing->name);
251 current_routing->parse_bypassroute(current_routing, route);
255 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
257 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
259 xbt_assert(current_routing->parse_bypassroute,
260 "Bypassing mechanism not implemented by routing '%s'",
261 current_routing->name);
262 current_routing->parse_bypassroute(current_routing, ASroute);
265 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
267 tmgr_trace_t tmgr_trace;
268 if (!trace->file || strcmp(trace->file, "") != 0) {
269 tmgr_trace = tmgr_trace_new_from_file(trace->file);
270 } else if (strcmp(trace->pc_data, "") == 0) {
274 tmgr_trace_new_from_string(trace->id, trace->pc_data,
277 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
280 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
282 xbt_assert(xbt_dict_get_or_null
283 (traces_set_list, trace_connect->trace),
284 "Cannot connect trace %s to %s: trace unknown",
285 trace_connect->trace,
286 trace_connect->element);
288 switch (trace_connect->kind) {
289 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
290 xbt_dict_set(trace_connect_list_host_avail,
291 trace_connect->trace,
292 xbt_strdup(trace_connect->element), NULL);
294 case SURF_TRACE_CONNECT_KIND_POWER:
295 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
296 xbt_strdup(trace_connect->element), NULL);
298 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
299 xbt_dict_set(trace_connect_list_link_avail,
300 trace_connect->trace,
301 xbt_strdup(trace_connect->element), NULL);
303 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
304 xbt_dict_set(trace_connect_list_bandwidth,
305 trace_connect->trace,
306 xbt_strdup(trace_connect->element), NULL);
308 case SURF_TRACE_CONNECT_KIND_LATENCY:
309 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
310 xbt_strdup(trace_connect->element), NULL);
313 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
314 trace_connect->trace, trace_connect->element);
319 extern int _sg_init_status; /* yay, this is an horrible hack */
322 * \brief Make a new routing component to the platform
324 * Add a new autonomous system to the platform. Any elements (such as host,
325 * router or sub-AS) added after this call and before the corresponding call
326 * to sg_platf_new_AS_close() will be added to this AS.
328 * Once this function was called, the configuration concerning the used
329 * models cannot be changed anymore.
331 * @param AS_id name of this autonomous system. Must be unique in the platform
332 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
334 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
336 XBT_DEBUG("routing_AS_begin");
338 routing_model_description_t model = NULL;
340 xbt_assert(!xbt_lib_get_or_null
341 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
342 "The AS \"%s\" already exists", AS->id);
344 _sg_init_status = 2; /* horrible hack: direct access to the global controlling the level of configuration to prevent any further config */
346 /* search the routing model */
348 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
349 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
350 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
351 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
352 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
353 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
354 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
355 default: xbt_die("Not a valid model!!!");
359 /* make a new routing component */
360 new_as = (AS_t) model->create();
361 new_as->model_desc = model;
362 new_as->hierarchy = SURF_ROUTING_NULL;
363 new_as->name = xbt_strdup(AS->id);
365 sg_routing_edge_t info = NULL;
366 info = xbt_new0(s_routing_edge_t, 1);
368 if (current_routing == NULL && routing_platf->root == NULL) {
370 /* it is the first one */
371 new_as->routing_father = NULL;
372 routing_platf->root = new_as;
374 } else if (current_routing != NULL && routing_platf->root != NULL) {
376 xbt_assert(!xbt_dict_get_or_null
377 (current_routing->routing_sons, AS->id),
378 "The AS \"%s\" already exists", AS->id);
379 /* it is a part of the tree */
380 new_as->routing_father = current_routing;
381 /* set the father behavior */
382 if (current_routing->hierarchy == SURF_ROUTING_NULL)
383 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
384 /* add to the sons dictionary */
385 xbt_dict_set(current_routing->routing_sons, AS->id,
386 (void *) new_as, NULL);
387 /* add to the father element list */
388 info->id = current_routing->parse_AS(current_routing, (void *) info);
390 THROWF(arg_error, 0, "All defined components must be belong to a AS");
393 info->rc_component = new_as->routing_father;
394 info->rc_type = SURF_NETWORK_ELEMENT_AS;
395 info->name = new_as->name;
397 xbt_lib_set(as_router_lib, info->name, ROUTING_ASR_LEVEL,
399 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
401 /* set the new current component of the tree */
402 current_routing = new_as;
403 current_routing->net_elem = info;
408 * \brief Specify that the current description of AS is finished
410 * Once you've declared all the content of your AS, you have to close
411 * it with this call. Your AS is not usable until you call this function.
413 * @fixme: this call is not as robust as wanted: bad things WILL happen
414 * if you call it twice for the same AS, or if you forget calling it, or
415 * even if you add stuff to a closed AS
418 void routing_AS_end(sg_platf_AS_cbarg_t AS)
421 if (current_routing == NULL) {
422 THROWF(arg_error, 0, "Close an AS, but none was under construction");
424 if (current_routing->model_desc->end)
425 current_routing->model_desc->end(current_routing);
426 current_routing = current_routing->routing_father;
430 /* Aux Business methods */
433 * \brief Get the AS father and the first elements of the chain
435 * \param src the source host name
436 * \param dst the destination host name
438 * Get the common father of the to processing units, and the first different
439 * father in the chain
441 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
446 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
447 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
449 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
450 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
458 /* (1) find the as where the src and dst are located */
459 sg_routing_edge_t src_data = src;
460 sg_routing_edge_t dst_data = dst;
461 src_as = src_data->rc_component;
462 dst_as = dst_data->rc_component;
464 char* src_name = src_data->name;
465 char* dst_name = dst_data->name;
468 xbt_assert(src_as && dst_as,
469 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
471 /* (2) find the path to the root routing component */
472 for (current = src_as; current != NULL; current = current->routing_father) {
473 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
474 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
475 path_src[index_src++] = current;
477 for (current = dst_as; current != NULL; current = current->routing_father) {
478 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
479 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
480 path_dst[index_dst++] = current;
483 /* (3) find the common father */
485 current_src = path_src[--index_src];
486 current_dst = path_dst[--index_dst];
487 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
489 /* (4) they are not in the same routing component, make the path */
490 if (current_src == current_dst)
491 father = current_src;
493 father = path_src[index_src + 1];
495 /* (5) result generation */
496 *res_father = father; /* first the common father of src and dst */
497 *res_src = current_src; /* second the first different father of src */
498 *res_dst = current_dst; /* three the first different father of dst */
500 #undef ELEMENTS_FATHER_MAXDEPTH
503 /* Global Business methods */
506 * \brief Recursive function for get_route_latency
508 * \param src the source host name
509 * \param dst the destination host name
510 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
511 * \param *latency the latency, if needed
513 * This function is called by "get_route" and "get_latency". It allows to walk
514 * recursively through the ASes tree.
516 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
517 xbt_dynar_t * links, double *latency)
519 s_sg_platf_route_cbarg_t route;
520 memset(&route,0,sizeof(route));
522 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
523 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
525 /* Find how src and dst are interconnected */
526 AS_t common_father, src_father, dst_father;
527 elements_father(src, dst, &common_father, &src_father, &dst_father);
528 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
529 common_father->name,src_father->name,dst_father->name);
531 /* Check whether a direct bypass is defined */
532 sg_platf_route_cbarg_t e_route_bypass = NULL;
533 if (common_father->get_bypass_route)
534 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
536 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
537 if (e_route_bypass) {
538 xbt_dynar_merge(links, &e_route_bypass->link_list);
539 generic_free_route(e_route_bypass);
543 /* If src and dst are in the same AS, life is good */
544 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
545 route.link_list = *links;
546 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
547 // if vivaldi latency+=vivaldi(src,dst)
551 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
553 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
554 // Find the net_card corresponding to father
555 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
556 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
558 common_father->get_route_and_latency(common_father,
559 src_father_net_elm, dst_father_net_elm,
562 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
563 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
565 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
566 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
568 /* If source gateway is not our source, we have to recursively find our way up to this point */
569 if (src != src_gateway_net_elm)
570 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
571 xbt_dynar_merge(links, &route.link_list);
573 /* If dest gateway is not our destination, we have to recursively find our way from this point */
574 if (dst_gateway_net_elm != dst)
575 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
577 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
581 * \brief Find a route between hosts
583 * \param src the network_element_t for src host
584 * \param dst the network_element_t for dst host
585 * \param route where to store the list of links.
586 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
587 * \param latency where to store the latency experienced on the path (or NULL if not interested)
588 * It is the caller responsability to initialize latency to 0 (we add to provided route)
591 * walk through the routing components tree and find a route between hosts
592 * by calling the differents "get_route" functions in each routing component.
594 void routing_get_route_and_latency(sg_routing_edge_t src,
595 sg_routing_edge_t dst,
596 xbt_dynar_t * route, double *latency)
598 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
600 xbt_dynar_reset(routing_platf->last_route);
601 *route = routing_platf->last_route;
604 _get_route_and_latency(src, dst, route, latency);
606 xbt_assert(!latency || *latency >= 0.0,
607 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
610 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
612 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
614 //adding my one link routes
615 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
617 xbt_dynar_merge(&ret,&onelink_mine);
621 xbt_dict_cursor_t cursor = NULL;
623 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
624 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
626 xbt_dynar_merge(&ret,&onelink_child);
631 static xbt_dynar_t get_onelink_routes(void)
633 return recursive_get_onelink_routes(routing_platf->root);
636 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
638 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
642 return SURF_NETWORK_ELEMENT_NULL;
646 * \brief Generic method: create the global routing schema
648 * Make a global routing structure and set all the parsing functions.
650 void routing_model_create( void *loopback)
652 /* config the uniq global routing */
653 routing_platf = xbt_new0(s_routing_platf_t, 1);
654 routing_platf->root = NULL;
655 routing_platf->get_onelink_routes = get_onelink_routes;
656 routing_platf->loopback = loopback;
657 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
658 /* no current routing at moment */
659 current_routing = NULL;
663 /* ************************************************** */
664 /* ********** PATERN FOR NEW ROUTING **************** */
666 /* The minimal configuration of a new routing model need the next functions,
667 * also you need to set at the start of the file, the new model in the model
668 * list. Remember keep the null ending of the list.
670 /*** Routing model structure ***/
672 // s_routing_component_t generic_routing;
673 // /* things that your routing model need */
674 // } s_routing_component_NEW_t,*routing_component_NEW_t;
676 /*** Parse routing model functions ***/
677 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
678 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
679 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
680 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
681 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
683 /*** Business methods ***/
684 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
685 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
686 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
688 /*** Creation routing model functions ***/
689 // static void* model_NEW_create(void) {
690 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
691 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
692 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
693 // new_component->generic_routing.set_route = model_NEW_set_route;
694 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
695 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
696 // new_component->generic_routing.get_route = NEW_get_route;
697 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
698 // new_component->generic_routing.finalize = NEW_finalize;
699 // /* initialization of internal structures */
700 // return new_component;
702 // static void model_NEW_load(void) {} /* mandatory */
703 // static void model_NEW_unload(void) {} /* mandatory */
704 // static void model_NEW_end(void) {} /* mandatory */
706 /* ************************************************************************** */
707 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
709 void routing_cluster_add_backbone(void* bb) {
710 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
711 "You have to be in model Cluster to use tag backbone!");
712 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
713 ((as_cluster_t)current_routing)->backbone = bb;
714 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
717 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
720 char *groups , *host_id , *link_id = NULL;
722 xbt_dynar_t radical_elements;
723 xbt_dynar_t radical_ends;
726 radical_elements = xbt_str_split(cabinet->radical, ",");
727 xbt_dynar_foreach(radical_elements, iter, groups) {
729 radical_ends = xbt_str_split(groups, "-");
730 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
732 switch (xbt_dynar_length(radical_ends)) {
737 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
740 surf_parse_error("Malformed radical");
743 s_sg_platf_host_cbarg_t host;
744 memset(&host, 0, sizeof(host));
745 host.initial_state = SURF_RESOURCE_ON;
746 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
747 xbt_dynar_push(power_state_list,&cabinet->power);
748 host.power_peak = power_state_list;
750 host.power_scale = 1.0;
751 host.core_amount = 1;
753 s_sg_platf_link_cbarg_t link;
754 memset(&link, 0, sizeof(link));
755 link.state = SURF_RESOURCE_ON;
756 link.policy = SURF_LINK_FULLDUPLEX;
757 link.latency = cabinet->lat;
758 link.bandwidth = cabinet->bw;
760 s_sg_platf_host_link_cbarg_t host_link;
761 memset(&host_link, 0, sizeof(host_link));
763 for (i = start; i <= end; i++) {
764 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
765 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
768 sg_platf_new_host(&host);
769 sg_platf_new_link(&link);
771 char* link_up = bprintf("%s_UP",link_id);
772 char* link_down = bprintf("%s_DOWN",link_id);
773 host_link.id = host_id;
774 host_link.link_up = link_up;
775 host_link.link_down= link_down;
776 sg_platf_new_host_link(&host_link);
784 xbt_dynar_free(&radical_ends);
786 xbt_dynar_free(&radical_elements);
789 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
791 char *host_id, *groups, *link_id = NULL;
792 xbt_dict_t patterns = NULL;
794 s_sg_platf_host_cbarg_t host;
795 s_sg_platf_link_cbarg_t link;
799 xbt_dynar_t radical_elements;
800 xbt_dynar_t radical_ends;
802 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
803 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
804 patterns = xbt_dict_new_homogeneous(xbt_free_f);
805 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
806 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
807 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
810 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
811 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
813 AS.routing = A_surfxml_AS_routing_Cluster;
814 sg_platf_new_AS_begin(&AS);
816 current_routing->link_up_down_list
817 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
820 radical_elements = xbt_str_split(cluster->radical, ",");
821 xbt_dynar_foreach(radical_elements, iter, groups) {
823 radical_ends = xbt_str_split(groups, "-");
824 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
826 switch (xbt_dynar_length(radical_ends)) {
831 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
834 surf_parse_error("Malformed radical");
837 for (i = start; i <= end; i++) {
839 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
840 link_id = bprintf("%s_link_%d", cluster->id, i);
842 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
844 memset(&host, 0, sizeof(host));
846 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
847 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
848 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
849 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
850 host.power_trace = tmgr_trace_new_from_file(avail_file);
851 xbt_free(avail_file);
853 XBT_DEBUG("\tavailability_file=\"\"");
856 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
857 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
858 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
859 host.state_trace = tmgr_trace_new_from_file(avail_file);
860 xbt_free(avail_file);
862 XBT_DEBUG("\tstate_file=\"\"");
865 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
866 xbt_dynar_push(power_state_list,&cluster->power);
867 host.power_peak = power_state_list;
870 //host.power_peak = cluster->power;
871 host.power_scale = 1.0;
872 host.core_amount = cluster->core_amount;
873 host.initial_state = SURF_RESOURCE_ON;
875 sg_platf_new_host(&host);
876 XBT_DEBUG("</host>");
878 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
879 cluster->bw, cluster->lat);
881 memset(&link, 0, sizeof(link));
883 link.bandwidth = cluster->bw;
884 link.latency = cluster->lat;
885 link.state = SURF_RESOURCE_ON;
886 link.policy = cluster->sharing_policy;
887 sg_platf_new_link(&link);
889 s_surf_parsing_link_up_down_t info;
891 if (link.policy == SURF_LINK_FULLDUPLEX) {
892 char *tmp_link = bprintf("%s_UP", link_id);
894 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
896 tmp_link = bprintf("%s_DOWN", link_id);
898 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
901 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
902 info.link_down = info.link_up;
905 if(cluster->limiter_link!=0){
906 char *tmp_link = bprintf("%s_limiter", link_id);
907 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
908 cluster->limiter_link);
911 memset(&link, 0, sizeof(link));
913 link.bandwidth = cluster->limiter_link;
915 link.state = SURF_RESOURCE_ON;
916 link.policy = SURF_LINK_SHARED;
917 sg_platf_new_link(&link);
919 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
922 info.limiter_link =NULL;
925 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
926 char *tmp_link = bprintf("%s_loopback", link_id);
927 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
928 cluster->limiter_link);
931 memset(&link, 0, sizeof(link));
933 link.bandwidth = cluster->loopback_bw;
934 link.latency = cluster->loopback_lat;
935 link.state = SURF_RESOURCE_ON;
936 link.policy = SURF_LINK_FATPIPE;
937 sg_platf_new_link(&link);
939 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
942 info.loopback_link =NULL;
945 xbt_dynar_push(current_routing->link_up_down_list,&info);
950 xbt_dynar_free(&radical_ends);
952 xbt_dynar_free(&radical_elements);
954 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
955 // and it's very useful to connect clusters together
957 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
959 s_sg_platf_router_cbarg_t router;
960 memset(&router, 0, sizeof(router));
961 router.id = cluster->router_id;
963 if (!router.id || !strcmp(router.id, ""))
965 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
967 sg_platf_new_router(&router);
968 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
972 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
973 char *link_backbone = bprintf("%s_backbone", cluster->id);
974 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
975 cluster->bb_bw, cluster->bb_lat);
977 memset(&link, 0, sizeof(link));
978 link.id = link_backbone;
979 link.bandwidth = cluster->bb_bw;
980 link.latency = cluster->bb_lat;
981 link.state = SURF_RESOURCE_ON;
982 link.policy = cluster->bb_sharing_policy;
984 sg_platf_new_link(&link);
986 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
992 sg_platf_new_AS_end();
994 xbt_dict_free(&patterns); // no op if it were never set
997 static void routing_parse_postparse(void) {
998 xbt_dict_free(&random_value);
1001 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1003 char *host_id = NULL;
1004 char *link_id = NULL;
1005 char *router_id = NULL;
1008 host_id = HOST_PEER(peer->id);
1009 link_id = LINK_PEER(peer->id);
1010 router_id = ROUTER_PEER(peer->id);
1012 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", peer->id);
1013 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
1015 AS.routing = A_surfxml_AS_routing_Cluster;
1016 sg_platf_new_AS_begin(&AS);
1018 current_routing->link_up_down_list
1019 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
1021 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1022 s_sg_platf_host_cbarg_t host;
1023 memset(&host, 0, sizeof(host));
1024 host.initial_state = SURF_RESOURCE_ON;
1027 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
1028 xbt_dynar_push(power_state_list,&peer->power);
1029 host.power_peak = power_state_list;
1031 //host.power_peak = peer->power;
1032 host.power_scale = 1.0;
1033 host.power_trace = peer->availability_trace;
1034 host.state_trace = peer->state_trace;
1035 host.core_amount = 1;
1036 sg_platf_new_host(&host);
1038 s_sg_platf_link_cbarg_t link;
1039 memset(&link, 0, sizeof(link));
1040 link.state = SURF_RESOURCE_ON;
1041 link.policy = SURF_LINK_SHARED;
1042 link.latency = peer->lat;
1044 char* link_up = bprintf("%s_UP",link_id);
1045 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1046 peer->bw_out, peer->lat);
1048 link.bandwidth = peer->bw_out;
1049 sg_platf_new_link(&link);
1051 char* link_down = bprintf("%s_DOWN",link_id);
1052 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1053 peer->bw_in, peer->lat);
1054 link.id = link_down;
1055 link.bandwidth = peer->bw_in;
1056 sg_platf_new_link(&link);
1058 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1059 s_sg_platf_host_link_cbarg_t host_link;
1060 memset(&host_link, 0, sizeof(host_link));
1061 host_link.id = host_id;
1062 host_link.link_up = link_up;
1063 host_link.link_down= link_down;
1064 sg_platf_new_host_link(&host_link);
1066 XBT_DEBUG("<router id=\"%s\"/>", router_id);
1067 s_sg_platf_router_cbarg_t router;
1068 memset(&router, 0, sizeof(router));
1069 router.id = router_id;
1070 router.coord = peer->coord;
1071 sg_platf_new_router(&router);
1072 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
1075 sg_platf_new_AS_end();
1078 //xbt_dynar_free(&tab_elements_num);
1085 static void routing_parse_Srandom(void)
1087 double mean, std, min, max, seed;
1088 char *random_id = A_surfxml_random_id;
1089 char *random_radical = A_surfxml_random_radical;
1090 char *rd_name = NULL;
1092 mean = surf_parse_get_double(A_surfxml_random_mean);
1093 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1094 min = surf_parse_get_double(A_surfxml_random_min);
1095 max = surf_parse_get_double(A_surfxml_random_max);
1096 seed = surf_parse_get_double(A_surfxml_random_seed);
1100 random_data_t random = xbt_new0(s_random_data_t, 1);
1103 xbt_dynar_t radical_elements;
1107 xbt_dynar_t radical_ends;
1109 switch (A_surfxml_random_generator) {
1110 case AU_surfxml_random_generator:
1111 case A_surfxml_random_generator_NONE:
1112 random->generator = NONE;
1114 case A_surfxml_random_generator_DRAND48:
1115 random->generator = DRAND48;
1117 case A_surfxml_random_generator_RAND:
1118 random->generator = RAND;
1120 case A_surfxml_random_generator_RNGSTREAM:
1121 random->generator = RNGSTREAM;
1124 surf_parse_error("Invalid random generator");
1127 random->seed = seed;
1131 /* Check user stupidities */
1133 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1135 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1137 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1139 /* normalize the mean and standard deviation before storing */
1140 random->mean = (mean - min) / (max - min);
1141 random->std = std / (max - min);
1143 if (random->mean * (1 - random->mean) < random->std * random->std)
1144 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1145 random->mean, random->std);
1148 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1149 random_id, random->min, random->max, random->mean, random->std,
1150 (int)random->generator, random->seed, random_radical);
1153 random_value = xbt_dict_new_homogeneous(free);
1155 if (!strcmp(random_radical, "")) {
1156 res = random_generate(random);
1157 rd_value = bprintf("%f", res);
1158 xbt_dict_set(random_value, random_id, rd_value, NULL);
1160 radical_elements = xbt_str_split(random_radical, ",");
1161 xbt_dynar_foreach(radical_elements, iter, groups) {
1162 radical_ends = xbt_str_split(groups, "-");
1163 switch (xbt_dynar_length(radical_ends)) {
1165 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1166 "Custom Random '%s' already exists !", random_id);
1167 res = random_generate(random);
1169 bprintf("%s%d", random_id,
1170 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1171 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1176 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1177 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1178 for (i = start; i <= end; i++) {
1179 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1180 "Custom Random '%s' already exists !", bprintf("%s%d",
1183 res = random_generate(random);
1184 tmpbuf = bprintf("%s%d", random_id, i);
1185 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1190 XBT_CRITICAL("Malformed radical");
1193 res = random_generate(random);
1194 rd_name = bprintf("%s_router", random_id);
1195 rd_value = bprintf("%f", res);
1196 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1198 xbt_dynar_free(&radical_ends);
1201 xbt_dynar_free(&radical_elements);
1205 void routing_register_callbacks()
1207 sg_platf_host_add_cb(parse_S_host);
1208 sg_platf_router_add_cb(parse_S_router);
1209 sg_platf_host_link_add_cb(parse_S_host_link);
1210 sg_platf_route_add_cb(parse_E_route);
1211 sg_platf_ASroute_add_cb(parse_E_ASroute);
1212 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1213 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1215 sg_platf_cluster_add_cb(routing_parse_cluster);
1216 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1218 sg_platf_peer_add_cb(routing_parse_peer);
1219 sg_platf_postparse_add_cb(routing_parse_postparse);
1221 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1222 sg_platf_AS_end_add_cb(routing_AS_end);
1223 sg_platf_AS_begin_add_cb(routing_AS_begin);
1225 sg_platf_trace_add_cb(routing_parse_trace);
1226 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1229 instr_routing_define_callbacks();
1234 * \brief Recursive function for finalize
1236 * \param rc the source host name
1238 * This fuction is call by "finalize". It allow to finalize the
1239 * AS or routing components. It delete all the structures.
1241 static void finalize_rec(AS_t as) {
1242 xbt_dict_cursor_t cursor = NULL;
1246 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1253 /** \brief Frees all memory allocated by the routing module */
1254 void routing_exit(void) {
1257 xbt_dynar_free(&routing_platf->last_route);
1258 finalize_rec(routing_platf->root);
1259 xbt_free(routing_platf);
1262 AS_t surf_AS_get_routing_root() {
1263 return routing_platf->root;
1266 const char *surf_AS_get_name(AS_t as) {
1270 xbt_dict_t surf_AS_get_routing_sons(AS_t as) {
1271 return as->routing_sons;
1274 const char *surf_AS_get_model(AS_t as) {
1275 return as->model_desc->name;
1278 xbt_dynar_t surf_AS_get_hosts(AS_t as) {
1279 xbt_dynar_t elms = as->index_network_elm;
1280 sg_routing_edge_t relm;
1283 int count = xbt_dynar_length(elms);
1284 xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_dictelm_t), NULL);
1285 for (index = 0; index < count; index++) {
1286 relm = xbt_dynar_get_as(elms, index, sg_routing_edge_t);
1287 delm = xbt_lib_get_elm_or_null(host_lib, relm->name);
1289 xbt_dynar_push(res, &delm);