1 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include <pcre.h> /* regular expression library */
9 #include "simgrid/platf_interface.h" // platform creation API internal interface
11 #include "surf_routing_private.h"
12 #include "surf/surf_routing.h"
13 #include "surf/surfxml_parse_values.h"
16 * @ingroup SURF_build_api
17 * @brief A library containing all known workstations
21 int ROUTING_HOST_LEVEL; //Routing level
22 int SURF_CPU_LEVEL; //Surf cpu level
23 int SURF_WKS_LEVEL; //Surf workstation level
24 int SIMIX_HOST_LEVEL; //Simix level
25 int MSG_HOST_LEVEL; //Msg level
26 int SD_HOST_LEVEL; //Simdag level
27 int COORD_HOST_LEVEL=0; //Coordinates level
28 int NS3_HOST_LEVEL; //host node for ns3
30 xbt_dict_t watched_hosts_lib;
33 * @ingroup SURF_build_api
34 * @brief A library containing all known links
37 int SD_LINK_LEVEL; //Simdag level
38 int SURF_LINK_LEVEL; //Surf level
39 int NS3_LINK_LEVEL; //link for ns3
41 xbt_lib_t as_router_lib;
42 int ROUTING_ASR_LEVEL; //Routing level
43 int COORD_ASR_LEVEL; //Coordinates level
44 int NS3_ASR_LEVEL; //host node for ns3
46 static xbt_dict_t random_value = NULL;
48 /** @brief Retrieve a routing edge from its name
50 * Routing edges are either CPU/workstation and routers, whatever
52 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
53 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
54 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
59 routing_platf_t routing_platf = NULL;
60 AS_t current_routing = NULL;
62 /* global parse functions */
63 extern xbt_dynar_t mount_list;
65 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
67 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
68 static void routing_parse_Srandom(void); /* random bypass */
70 static void routing_parse_postparse(void);
72 /* this lines are only for replace use like index in the model table */
77 SURF_MODEL_DIJKSTRACACHE,
84 struct s_model_type routing_models[] = {
86 "Full routing data (fast, large memory requirements, fully expressive)",
87 model_full_create, model_full_end},
89 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
90 model_floyd_create, model_floyd_end},
92 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
93 model_dijkstra_create, model_dijkstra_both_end},
95 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
96 model_dijkstracache_create, model_dijkstra_both_end},
97 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
98 model_none_create, NULL},
99 {"RuleBased", "Rule-Based routing data (...)",
100 model_rulebased_create, NULL},
101 {"Vivaldi", "Vivaldi routing",
102 model_vivaldi_create, NULL},
103 {"Cluster", "Cluster routing",
104 model_cluster_create, NULL},
105 {NULL, NULL, NULL, NULL}
109 * \brief Add a "host_link" to the network element list
111 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
113 sg_routing_edge_t info = NULL;
114 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
115 xbt_assert(info, "Host '%s' not found!",host->id);
116 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
117 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
118 "You have to be in model Cluster to use tag host_link!");
120 s_surf_parsing_link_up_down_t link_up_down;
121 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
122 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
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_network_element_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_network_element_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 route_t created_route = xbt_new0(s_route_t, 1);
229 created_route->link_list = route->link_list;
231 xbt_assert(current_routing->parse_route,
232 "no defined method \"set_route\" in \"%s\"",
233 current_routing->name);
235 current_routing->parse_route(current_routing,
236 route->src, route->dst, created_route);
237 generic_free_route(created_route);
241 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
243 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
245 route_t e_route = xbt_new0(s_route_t, 1);
246 e_route->link_list = ASroute->link_list;
247 e_route->src_gateway = ASroute->gw_src;
248 e_route->dst_gateway = ASroute->gw_dst;
250 xbt_assert(current_routing->parse_ASroute,
251 "no defined method \"set_ASroute\" in \"%s\"",
252 current_routing->name);
253 current_routing->parse_ASroute(current_routing, ASroute->src, ASroute->dst, e_route);
254 generic_free_route(e_route);
258 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
260 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
262 route_t e_route = xbt_new0(s_route_t, 1);
263 e_route->link_list = route->link_list;
265 xbt_assert(current_routing->parse_bypassroute,
266 "Bypassing mechanism not implemented by routing '%s'",
267 current_routing->name);
269 current_routing->parse_bypassroute(current_routing, route->src, route->dst, e_route);
273 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
275 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
277 route_t e_route = xbt_new0(s_route_t, 1);
278 e_route->link_list = ASroute->link_list;
279 e_route->src_gateway = ASroute->gw_src;
280 e_route->dst_gateway = ASroute->gw_dst;
281 xbt_assert(current_routing->parse_bypassroute,
282 "Bypassing mechanism not implemented by routing '%s'",
283 current_routing->name);
284 current_routing->parse_bypassroute(current_routing, ASroute->src, ASroute->dst, e_route);
287 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
289 tmgr_trace_t tmgr_trace;
290 if (!trace->file || strcmp(trace->file, "") != 0) {
291 tmgr_trace = tmgr_trace_new_from_file(trace->file);
292 } else if (strcmp(trace->pc_data, "") == 0) {
296 tmgr_trace_new_from_string(trace->id, trace->pc_data,
299 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
302 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
304 xbt_assert(xbt_dict_get_or_null
305 (traces_set_list, trace_connect->trace),
306 "Cannot connect trace %s to %s: trace unknown",
307 trace_connect->trace,
308 trace_connect->element);
310 switch (trace_connect->kind) {
311 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
312 xbt_dict_set(trace_connect_list_host_avail,
313 trace_connect->trace,
314 xbt_strdup(trace_connect->element), NULL);
316 case SURF_TRACE_CONNECT_KIND_POWER:
317 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
318 xbt_strdup(trace_connect->element), NULL);
320 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
321 xbt_dict_set(trace_connect_list_link_avail,
322 trace_connect->trace,
323 xbt_strdup(trace_connect->element), NULL);
325 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
326 xbt_dict_set(trace_connect_list_bandwidth,
327 trace_connect->trace,
328 xbt_strdup(trace_connect->element), NULL);
330 case SURF_TRACE_CONNECT_KIND_LATENCY:
331 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
332 xbt_strdup(trace_connect->element), NULL);
335 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
336 trace_connect->trace, trace_connect->element);
342 * \brief Make a new routing component to the platform
344 * Add a new autonomous system to the platform. Any elements (such as host,
345 * router or sub-AS) added after this call and before the corresponding call
346 * to sg_platf_new_AS_close() will be added to this AS.
348 * Once this function was called, the configuration concerning the used
349 * models cannot be changed anymore.
351 * @param AS_id name of this autonomous system. Must be unique in the platform
352 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
354 void routing_AS_begin(const char *AS_id, int wanted_routing_type)
356 XBT_DEBUG("routing_AS_begin");
358 routing_model_description_t model = NULL;
360 xbt_assert(!xbt_lib_get_or_null
361 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
362 "The AS \"%s\" already exists", AS_id);
364 /* search the routing model */
365 switch(wanted_routing_type){
366 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
367 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
368 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
369 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
370 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
371 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
372 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
373 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
374 default: xbt_die("Not a valid model!!!");
378 /* make a new routing component */
379 new_as = (AS_t) model->create();
380 new_as->model_desc = model;
381 new_as->hierarchy = SURF_ROUTING_NULL;
382 new_as->name = xbt_strdup(AS_id);
384 sg_routing_edge_t info = NULL;
385 info = xbt_new0(s_network_element_t, 1);
387 if (current_routing == NULL && routing_platf->root == NULL) {
389 /* it is the first one */
390 new_as->routing_father = NULL;
391 routing_platf->root = new_as;
393 } else if (current_routing != NULL && routing_platf->root != NULL) {
395 xbt_assert(!xbt_dict_get_or_null
396 (current_routing->routing_sons, AS_id),
397 "The AS \"%s\" already exists", AS_id);
398 /* it is a part of the tree */
399 new_as->routing_father = current_routing;
400 /* set the father behavior */
401 if (current_routing->hierarchy == SURF_ROUTING_NULL)
402 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
403 /* add to the sons dictionary */
404 xbt_dict_set(current_routing->routing_sons, AS_id,
405 (void *) new_as, NULL);
406 /* add to the father element list */
407 info->id = current_routing->parse_AS(current_routing, (void *) info);
409 THROWF(arg_error, 0, "All defined components must be belong to a AS");
412 info->rc_component = new_as->routing_father;
413 info->rc_type = SURF_NETWORK_ELEMENT_AS;
414 info->name = new_as->name;
416 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
418 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
420 /* set the new current component of the tree */
421 current_routing = new_as;
422 current_routing->net_elem = info;
427 * \brief Specify that the current description of AS is finished
429 * Once you've declared all the content of your AS, you have to close
430 * it with this call. Your AS is not usable until you call this function.
432 * @fixme: this call is not as robust as wanted: bad things WILL happen
433 * if you call it twice for the same AS, or if you forget calling it, or
434 * even if you add stuff to a closed AS
437 void routing_AS_end()
440 if (current_routing == NULL) {
441 THROWF(arg_error, 0, "Close an AS, but none was under construction");
443 if (current_routing->model_desc->end)
444 current_routing->model_desc->end(current_routing);
445 current_routing = current_routing->routing_father;
449 /* Aux Business methods */
452 * \brief Get the AS father and the first elements of the chain
454 * \param src the source host name
455 * \param dst the destination host name
457 * Get the common father of the to processing units, and the first different
458 * father in the chain
460 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
465 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
466 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
468 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
469 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
477 /* (1) find the as where the src and dst are located */
478 sg_routing_edge_t src_data = src;
479 sg_routing_edge_t dst_data = dst;
480 src_as = src_data->rc_component;
481 dst_as = dst_data->rc_component;
483 char* src_name = src_data->name;
484 char* dst_name = dst_data->name;
487 xbt_assert(src_as && dst_as,
488 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
490 /* (2) find the path to the root routing component */
491 for (current = src_as; current != NULL; current = current->routing_father) {
492 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
493 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
494 path_src[index_src++] = current;
496 for (current = dst_as; current != NULL; current = current->routing_father) {
497 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
498 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
499 path_dst[index_dst++] = current;
502 /* (3) find the common father */
504 current_src = path_src[--index_src];
505 current_dst = path_dst[--index_dst];
506 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
508 /* (4) they are not in the same routing component, make the path */
509 if (current_src == current_dst)
510 father = current_src;
512 father = path_src[index_src + 1];
514 /* (5) result generation */
515 *res_father = father; /* first the common father of src and dst */
516 *res_src = current_src; /* second the first different father of src */
517 *res_dst = current_dst; /* three the first different father of dst */
519 #undef ELEMENTS_FATHER_MAXDEPTH
522 /* Global Business methods */
525 * \brief Recursive function for get_route_latency
527 * \param src the source host name
528 * \param dst the destination host name
529 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
530 * \param *latency the latency, if needed
532 * This function is called by "get_route" and "get_latency". It allows to walk
533 * recursively through the ASes tree.
535 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
536 xbt_dynar_t * links, double *latency)
539 memset(&route,0,sizeof(route));
541 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
542 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
544 /* Find how src and dst are interconnected */
545 AS_t common_father, src_father, dst_father;
546 elements_father(src, dst, &common_father, &src_father, &dst_father);
547 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
548 common_father->name,src_father->name,dst_father->name);
550 /* Check whether a direct bypass is defined */
551 route_t e_route_bypass = NULL;
552 if (common_father->get_bypass_route)
553 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
555 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
556 if (e_route_bypass) {
557 xbt_dynar_merge(links, &e_route_bypass->link_list);
558 generic_free_route(e_route_bypass);
562 /* If src and dst are in the same AS, life is good */
563 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
564 route.link_list = *links;
565 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
566 // if vivaldi latency+=vivaldi(src,dst)
570 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
572 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
573 // Find the net_card corresponding to father
574 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
575 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
577 common_father->get_route_and_latency(common_father,
578 src_father_net_elm, dst_father_net_elm,
581 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
582 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
584 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
585 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
587 /* If source gateway is not our source, we have to recursively find our way up to this point */
588 if (src != src_gateway_net_elm)
589 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
590 xbt_dynar_merge(links, &route.link_list);
592 /* If dest gateway is not our destination, we have to recursively find our way from this point */
593 if (dst_gateway_net_elm != dst)
594 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
596 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
600 * \brief Find a route between hosts
602 * \param src the network_element_t for src host
603 * \param dst the network_element_t for dst host
604 * \param route where to store the list of links.
605 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
606 * \param latency where to store the latency experienced on the path (or NULL if not interested)
607 * It is the caller responsability to initialize latency to 0 (we add to provided route)
610 * walk through the routing components tree and find a route between hosts
611 * by calling the differents "get_route" functions in each routing component.
613 void routing_get_route_and_latency(sg_routing_edge_t src,
614 sg_routing_edge_t dst,
615 xbt_dynar_t * route, double *latency)
617 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
619 xbt_dynar_reset(routing_platf->last_route);
620 *route = routing_platf->last_route;
623 _get_route_and_latency(src, dst, route, latency);
625 xbt_assert(!latency || *latency >= 0.0,
626 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
629 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
631 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
633 //adding my one link routes
634 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
636 xbt_dynar_merge(&ret,&onelink_mine);
640 xbt_dict_cursor_t cursor = NULL;
642 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
643 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
645 xbt_dynar_merge(&ret,&onelink_child);
650 static xbt_dynar_t get_onelink_routes(void)
652 return recursive_get_onelink_routes(routing_platf->root);
655 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
657 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
661 return SURF_NETWORK_ELEMENT_NULL;
665 * \brief Generic method: create the global routing schema
667 * Make a global routing structure and set all the parsing functions.
669 void routing_model_create( void *loopback)
671 /* config the uniq global routing */
672 routing_platf = xbt_new0(s_routing_platf_t, 1);
673 routing_platf->root = NULL;
674 routing_platf->get_onelink_routes = get_onelink_routes;
675 routing_platf->loopback = loopback;
676 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
677 /* no current routing at moment */
678 current_routing = NULL;
682 /* ************************************************** */
683 /* ********** PATERN FOR NEW ROUTING **************** */
685 /* The minimal configuration of a new routing model need the next functions,
686 * also you need to set at the start of the file, the new model in the model
687 * list. Remember keep the null ending of the list.
689 /*** Routing model structure ***/
691 // s_routing_component_t generic_routing;
692 // /* things that your routing model need */
693 // } s_routing_component_NEW_t,*routing_component_NEW_t;
695 /*** Parse routing model functions ***/
696 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
697 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
698 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
699 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
700 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
702 /*** Business methods ***/
703 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
704 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
705 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
707 /*** Creation routing model functions ***/
708 // static void* model_NEW_create(void) {
709 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
710 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
711 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
712 // new_component->generic_routing.set_route = model_NEW_set_route;
713 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
714 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
715 // new_component->generic_routing.get_route = NEW_get_route;
716 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
717 // new_component->generic_routing.finalize = NEW_finalize;
718 // /* initialization of internal structures */
719 // return new_component;
721 // static void model_NEW_load(void) {} /* mandatory */
722 // static void model_NEW_unload(void) {} /* mandatory */
723 // static void model_NEW_end(void) {} /* mandatory */
725 /* ************************************************************************** */
726 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
728 void routing_cluster_add_backbone(void* bb) {
729 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
730 "You have to be in model Cluster to use tag backbone!");
731 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
732 ((as_cluster_t)current_routing)->backbone = bb;
733 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
736 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
739 char *groups , *host_id , *link_id = NULL;
741 xbt_dynar_t radical_elements;
742 xbt_dynar_t radical_ends;
745 radical_elements = xbt_str_split(cabinet->radical, ",");
746 xbt_dynar_foreach(radical_elements, iter, groups) {
748 radical_ends = xbt_str_split(groups, "-");
749 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
751 switch (xbt_dynar_length(radical_ends)) {
756 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
759 surf_parse_error("Malformed radical");
762 s_sg_platf_host_cbarg_t host;
763 memset(&host, 0, sizeof(host));
764 host.initial_state = SURF_RESOURCE_ON;
765 host.power_peak = cabinet->power;
766 host.power_scale = 1.0;
767 host.core_amount = 1;
769 s_sg_platf_link_cbarg_t link;
770 memset(&link, 0, sizeof(link));
771 link.state = SURF_RESOURCE_ON;
772 link.policy = SURF_LINK_FULLDUPLEX;
773 link.latency = cabinet->lat;
774 link.bandwidth = cabinet->bw;
776 s_sg_platf_host_link_cbarg_t host_link;
777 memset(&host_link, 0, sizeof(host_link));
779 for (i = start; i <= end; i++) {
780 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
781 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
784 sg_platf_new_host(&host);
785 sg_platf_new_link(&link);
787 char* link_up = bprintf("%s_UP",link_id);
788 char* link_down = bprintf("%s_DOWN",link_id);
789 host_link.id = host_id;
790 host_link.link_up = link_up;
791 host_link.link_down= link_down;
792 sg_platf_new_host_link(&host_link);
800 xbt_dynar_free(&radical_ends);
802 xbt_dynar_free(&radical_elements);
805 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
807 char *host_id, *groups, *link_id = NULL;
808 xbt_dict_t patterns = NULL;
810 s_sg_platf_host_cbarg_t host;
811 s_sg_platf_link_cbarg_t link;
815 xbt_dynar_t radical_elements;
816 xbt_dynar_t radical_ends;
818 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
819 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
820 patterns = xbt_dict_new_homogeneous(xbt_free_f);
821 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
822 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
823 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
826 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
827 sg_platf_new_AS_begin(cluster->id, A_surfxml_AS_routing_Cluster);
829 current_routing->link_up_down_list
830 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
833 radical_elements = xbt_str_split(cluster->radical, ",");
834 xbt_dynar_foreach(radical_elements, iter, groups) {
836 radical_ends = xbt_str_split(groups, "-");
837 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
839 switch (xbt_dynar_length(radical_ends)) {
844 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
847 surf_parse_error("Malformed radical");
850 for (i = start; i <= end; i++) {
852 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
853 link_id = bprintf("%s_link_%d", cluster->id, i);
855 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
857 memset(&host, 0, sizeof(host));
859 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
860 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
861 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
862 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
863 host.power_trace = tmgr_trace_new_from_file(avail_file);
864 xbt_free(avail_file);
866 XBT_DEBUG("\tavailability_file=\"\"");
869 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
870 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
871 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
872 host.state_trace = tmgr_trace_new_from_file(avail_file);
873 xbt_free(avail_file);
875 XBT_DEBUG("\tstate_file=\"\"");
878 host.power_peak = cluster->power;
879 host.power_scale = 1.0;
880 host.core_amount = cluster->core_amount;
881 host.initial_state = SURF_RESOURCE_ON;
883 sg_platf_new_host(&host);
884 XBT_DEBUG("</host>");
886 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
887 cluster->bw, cluster->lat);
889 memset(&link, 0, sizeof(link));
891 link.bandwidth = cluster->bw;
892 link.latency = cluster->lat;
893 link.state = SURF_RESOURCE_ON;
894 link.policy = cluster->sharing_policy;
895 sg_platf_new_link(&link);
897 s_surf_parsing_link_up_down_t info;
899 if (link.policy == SURF_LINK_FULLDUPLEX) {
900 char *tmp_link = bprintf("%s_UP", link_id);
902 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
904 tmp_link = bprintf("%s_DOWN", link_id);
906 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
909 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
910 info.link_down = info.link_up;
912 xbt_dynar_push(current_routing->link_up_down_list,&info);
917 xbt_dynar_free(&radical_ends);
919 xbt_dynar_free(&radical_elements);
921 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
922 // and it's very useful to connect clusters together
924 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
926 s_sg_platf_router_cbarg_t router;
927 memset(&router, 0, sizeof(router));
928 router.id = cluster->router_id;
930 if (!router.id || !strcmp(router.id, ""))
932 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
934 sg_platf_new_router(&router);
938 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
939 char *link_backbone = bprintf("%s_backbone", cluster->id);
940 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
941 cluster->bb_bw, cluster->bb_lat);
943 memset(&link, 0, sizeof(link));
944 link.id = link_backbone;
945 link.bandwidth = cluster->bb_bw;
946 link.latency = cluster->bb_lat;
947 link.state = SURF_RESOURCE_ON;
948 link.policy = cluster->bb_sharing_policy;
950 sg_platf_new_link(&link);
952 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
958 sg_platf_new_AS_end();
960 xbt_dict_free(&patterns); // no op if it were never set
963 static void routing_parse_postparse(void) {
964 xbt_dict_free(&random_value);
967 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
969 char *host_id = NULL;
973 host_id = HOST_PEER(peer->id);
974 link_id = LINK_PEER(peer->id);
976 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
977 s_sg_platf_host_cbarg_t host;
978 memset(&host, 0, sizeof(host));
979 host.initial_state = SURF_RESOURCE_ON;
981 host.power_peak = peer->power;
982 host.power_scale = 1.0;
983 host.power_trace = peer->availability_trace;
984 host.state_trace = peer->state_trace;
985 host.core_amount = 1;
986 host.coord = peer->coord;
987 sg_platf_new_host(&host);
989 s_sg_platf_link_cbarg_t link;
990 memset(&link, 0, sizeof(link));
991 link.state = SURF_RESOURCE_ON;
992 link.policy = SURF_LINK_SHARED;
993 link.latency = peer->lat;
995 char* link_up = bprintf("%s_UP",link_id);
996 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
997 peer->bw_out, peer->lat);
999 link.bandwidth = peer->bw_out;
1000 sg_platf_new_link(&link);
1002 char* link_down = bprintf("%s_DOWN",link_id);
1003 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1004 peer->bw_in, peer->lat);
1005 link.id = link_down;
1006 link.bandwidth = peer->bw_in;
1007 sg_platf_new_link(&link);
1009 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1010 s_sg_platf_host_link_cbarg_t host_link;
1011 memset(&host_link, 0, sizeof(host_link));
1012 host_link.id = host_id;
1013 host_link.link_up = link_up;
1014 host_link.link_down= link_down;
1015 sg_platf_new_host_link(&host_link);
1019 //xbt_dynar_free(&tab_elements_num);
1026 static void routing_parse_Srandom(void)
1028 double mean, std, min, max, seed;
1029 char *random_id = A_surfxml_random_id;
1030 char *random_radical = A_surfxml_random_radical;
1031 char *rd_name = NULL;
1033 mean = surf_parse_get_double(A_surfxml_random_mean);
1034 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1035 min = surf_parse_get_double(A_surfxml_random_min);
1036 max = surf_parse_get_double(A_surfxml_random_max);
1037 seed = surf_parse_get_double(A_surfxml_random_seed);
1041 random_data_t random = xbt_new0(s_random_data_t, 1);
1044 xbt_dynar_t radical_elements;
1048 xbt_dynar_t radical_ends;
1050 switch (A_surfxml_random_generator) {
1051 case AU_surfxml_random_generator:
1052 case A_surfxml_random_generator_NONE:
1053 random->generator = NONE;
1055 case A_surfxml_random_generator_DRAND48:
1056 random->generator = DRAND48;
1058 case A_surfxml_random_generator_RAND:
1059 random->generator = RAND;
1061 case A_surfxml_random_generator_RNGSTREAM:
1062 random->generator = RNGSTREAM;
1065 surf_parse_error("Invalid random generator");
1068 random->seed = seed;
1072 /* Check user stupidities */
1074 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1076 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1078 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1080 /* normalize the mean and standard deviation before storing */
1081 random->mean = (mean - min) / (max - min);
1082 random->std = std / (max - min);
1084 if (random->mean * (1 - random->mean) < random->std * random->std)
1085 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1086 random->mean, random->std);
1089 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1090 random_id, random->min, random->max, random->mean, random->std,
1091 (int)random->generator, random->seed, random_radical);
1094 random_value = xbt_dict_new_homogeneous(free);
1096 if (!strcmp(random_radical, "")) {
1097 res = random_generate(random);
1098 rd_value = bprintf("%f", res);
1099 xbt_dict_set(random_value, random_id, rd_value, NULL);
1101 radical_elements = xbt_str_split(random_radical, ",");
1102 xbt_dynar_foreach(radical_elements, iter, groups) {
1103 radical_ends = xbt_str_split(groups, "-");
1104 switch (xbt_dynar_length(radical_ends)) {
1106 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1107 "Custom Random '%s' already exists !", random_id);
1108 res = random_generate(random);
1110 bprintf("%s%d", random_id,
1111 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1112 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1117 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1118 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1119 for (i = start; i <= end; i++) {
1120 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1121 "Custom Random '%s' already exists !", bprintf("%s%d",
1124 res = random_generate(random);
1125 tmpbuf = bprintf("%s%d", random_id, i);
1126 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1131 XBT_CRITICAL("Malformed radical");
1134 res = random_generate(random);
1135 rd_name = bprintf("%s_router", random_id);
1136 rd_value = bprintf("%f", res);
1137 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1139 xbt_dynar_free(&radical_ends);
1142 xbt_dynar_free(&radical_elements);
1146 void routing_register_callbacks()
1148 sg_platf_host_add_cb(parse_S_host);
1149 sg_platf_router_add_cb(parse_S_router);
1150 sg_platf_host_link_add_cb(parse_S_host_link);
1151 sg_platf_route_add_cb(parse_E_route);
1152 sg_platf_ASroute_add_cb(parse_E_ASroute);
1153 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1154 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1156 sg_platf_cluster_add_cb(routing_parse_cluster);
1157 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1159 sg_platf_peer_add_cb(routing_parse_peer);
1160 sg_platf_postparse_add_cb(routing_parse_postparse);
1162 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1163 sg_platf_AS_end_add_cb(routing_AS_end);
1164 sg_platf_AS_begin_add_cb(routing_AS_begin);
1166 sg_platf_trace_add_cb(routing_parse_trace);
1167 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1170 instr_routing_define_callbacks();
1175 * \brief Recursive function for finalize
1177 * \param rc the source host name
1179 * This fuction is call by "finalize". It allow to finalize the
1180 * AS or routing components. It delete all the structures.
1182 static void finalize_rec(AS_t as) {
1183 xbt_dict_cursor_t cursor = NULL;
1187 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1194 /** \brief Frees all memory allocated by the routing module */
1195 void routing_exit(void) {
1198 xbt_dynar_free(&routing_platf->last_route);
1199 finalize_rec(routing_platf->root);
1200 xbt_free(routing_platf);