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 host level
23 int SIMIX_STORAGE_LEVEL; //Simix storage level
24 int MSG_HOST_LEVEL; //Msg host level
25 int MSG_STORAGE_LEVEL; //Msg storage level
26 int SD_HOST_LEVEL; //Simdag host level
27 int SD_STORAGE_LEVEL; //Simdag storage level
28 int COORD_HOST_LEVEL=0; //Coordinates level
29 int NS3_HOST_LEVEL; //host node for ns3
32 * @ingroup SURF_build_api
33 * @brief A library containing all known links
36 int SD_LINK_LEVEL; //Simdag level
37 int SURF_LINK_LEVEL; //Surf level
38 int NS3_LINK_LEVEL; //link for ns3
40 xbt_lib_t as_router_lib;
41 int ROUTING_ASR_LEVEL; //Routing level
42 int COORD_ASR_LEVEL; //Coordinates level
43 int NS3_ASR_LEVEL; //host node for ns3
44 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
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,
83 struct s_model_type routing_models[] = {
85 "Full routing data (fast, large memory requirements, fully expressive)",
86 model_full_create, model_full_end},
88 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
89 model_floyd_create, model_floyd_end},
91 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
92 model_dijkstra_create, model_dijkstra_both_end},
94 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
95 model_dijkstracache_create, model_dijkstra_both_end},
96 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
97 model_none_create, NULL},
98 {"Vivaldi", "Vivaldi routing",
99 model_vivaldi_create, NULL},
100 {"Cluster", "Cluster routing",
101 model_cluster_create, NULL},
102 {NULL, NULL, NULL, NULL}
106 * \brief Add a "host_link" to the network element list
108 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
110 sg_routing_edge_t info = NULL;
111 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
112 xbt_assert(info, "Host '%s' not found!",host->id);
113 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
114 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
115 "You have to be in model Cluster to use tag host_link!");
117 s_surf_parsing_link_up_down_t link_up_down;
118 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
119 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
120 link_up_down.limiter_link = NULL;
121 link_up_down.loopback_link = NULL;
123 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
124 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
126 if(!current_routing->link_up_down_list)
127 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
129 // If dynar is is greater than edge id and if the host_link is already defined
130 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
131 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
132 xbt_die("Host_link for '%s' is already defined!",host->id);
134 XBT_DEBUG("Push Host_link for host '%s' to position %d",info->name,info->id);
135 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
139 * \brief Add a "host" to the network element list
141 static void parse_S_host(sg_platf_host_cbarg_t host)
143 sg_routing_edge_t info = NULL;
144 if (current_routing->hierarchy == SURF_ROUTING_NULL)
145 current_routing->hierarchy = SURF_ROUTING_BASE;
146 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
147 "Reading a host, processing unit \"%s\" already exists", host->id);
149 info = xbt_new0(s_routing_edge_t, 1);
150 info->rc_component = current_routing;
151 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
152 info->name = xbt_strdup(host->id);
153 info->id = current_routing->parse_PU(current_routing, (void *) info);
154 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
155 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
158 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
162 if (host->coord && strcmp(host->coord, "")) {
166 if (!COORD_HOST_LEVEL)
167 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
168 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
169 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
170 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
171 xbt_dynar_foreach(ctn_str,cursor, str) {
172 double val = atof(str);
173 xbt_dynar_push(ctn,&val);
175 xbt_dynar_shrink(ctn, 0);
176 xbt_dynar_free(&ctn_str);
177 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
178 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
183 * \brief Add a "router" to the network element list
185 static void parse_S_router(sg_platf_router_cbarg_t router)
187 sg_routing_edge_t info = NULL;
188 if (current_routing->hierarchy == SURF_ROUTING_NULL)
189 current_routing->hierarchy = SURF_ROUTING_BASE;
190 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
191 "Reading a router, processing unit \"%s\" already exists",
194 info = xbt_new0(s_routing_edge_t, 1);
195 info->rc_component = current_routing;
196 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
197 info->name = xbt_strdup(router->id);
198 info->id = current_routing->parse_PU(current_routing, (void *) info);
199 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
200 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
202 if (router->coord && strcmp(router->coord, "")) {
206 if (!COORD_ASR_LEVEL)
207 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
208 /* Pre-parse the host coordinates */
209 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
210 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
211 xbt_dynar_foreach(ctn_str,cursor, str) {
212 double val = atof(str);
213 xbt_dynar_push(ctn,&val);
215 xbt_dynar_shrink(ctn, 0);
216 xbt_dynar_free(&ctn_str);
217 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
218 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
223 * \brief Store the route by calling the set_route function of the current routing component
225 static void parse_E_route(sg_platf_route_cbarg_t route)
227 xbt_assert(current_routing->parse_route,
228 "no defined method \"set_route\" in \"%s\"",
229 current_routing->name);
231 current_routing->parse_route(current_routing, route);
235 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
237 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
239 xbt_assert(current_routing->parse_ASroute,
240 "no defined method \"set_ASroute\" in \"%s\"",
241 current_routing->name);
242 current_routing->parse_ASroute(current_routing, ASroute);
246 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
248 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
250 xbt_assert(current_routing->parse_bypassroute,
251 "Bypassing mechanism not implemented by routing '%s'",
252 current_routing->name);
254 current_routing->parse_bypassroute(current_routing, route);
258 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
260 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
262 xbt_assert(current_routing->parse_bypassroute,
263 "Bypassing mechanism not implemented by routing '%s'",
264 current_routing->name);
265 current_routing->parse_bypassroute(current_routing, ASroute);
268 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
270 tmgr_trace_t tmgr_trace;
271 if (!trace->file || strcmp(trace->file, "") != 0) {
272 tmgr_trace = tmgr_trace_new_from_file(trace->file);
273 } else if (strcmp(trace->pc_data, "") == 0) {
277 tmgr_trace_new_from_string(trace->id, trace->pc_data,
280 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
283 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
285 xbt_assert(xbt_dict_get_or_null
286 (traces_set_list, trace_connect->trace),
287 "Cannot connect trace %s to %s: trace unknown",
288 trace_connect->trace,
289 trace_connect->element);
291 switch (trace_connect->kind) {
292 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
293 xbt_dict_set(trace_connect_list_host_avail,
294 trace_connect->trace,
295 xbt_strdup(trace_connect->element), NULL);
297 case SURF_TRACE_CONNECT_KIND_POWER:
298 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
299 xbt_strdup(trace_connect->element), NULL);
301 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
302 xbt_dict_set(trace_connect_list_link_avail,
303 trace_connect->trace,
304 xbt_strdup(trace_connect->element), NULL);
306 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
307 xbt_dict_set(trace_connect_list_bandwidth,
308 trace_connect->trace,
309 xbt_strdup(trace_connect->element), NULL);
311 case SURF_TRACE_CONNECT_KIND_LATENCY:
312 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
313 xbt_strdup(trace_connect->element), NULL);
316 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
317 trace_connect->trace, trace_connect->element);
322 extern int _sg_init_status; /* yay, this is an horrible hack */
325 * \brief Make a new routing component to the platform
327 * Add a new autonomous system to the platform. Any elements (such as host,
328 * router or sub-AS) added after this call and before the corresponding call
329 * to sg_platf_new_AS_close() will be added to this AS.
331 * Once this function was called, the configuration concerning the used
332 * models cannot be changed anymore.
334 * @param AS_id name of this autonomous system. Must be unique in the platform
335 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
337 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
339 XBT_DEBUG("routing_AS_begin");
341 routing_model_description_t model = NULL;
343 xbt_assert(!xbt_lib_get_or_null
344 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
345 "The AS \"%s\" already exists", AS->id);
347 _sg_init_status = 2; /* horrible hack: direct access to the global controlling the level of configuration to prevent any further config */
349 /* search the routing model */
351 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
352 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
353 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
354 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
355 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
356 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
357 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
358 default: xbt_die("Not a valid model!!!");
362 /* make a new routing component */
363 new_as = (AS_t) model->create();
364 new_as->model_desc = model;
365 new_as->hierarchy = SURF_ROUTING_NULL;
366 new_as->name = xbt_strdup(AS->id);
368 sg_routing_edge_t info = NULL;
369 info = xbt_new0(s_routing_edge_t, 1);
371 if (current_routing == NULL && routing_platf->root == NULL) {
373 /* it is the first one */
374 new_as->routing_father = NULL;
375 routing_platf->root = new_as;
377 } else if (current_routing != NULL && routing_platf->root != NULL) {
379 xbt_assert(!xbt_dict_get_or_null
380 (current_routing->routing_sons, AS->id),
381 "The AS \"%s\" already exists", AS->id);
382 /* it is a part of the tree */
383 new_as->routing_father = current_routing;
384 /* set the father behavior */
385 if (current_routing->hierarchy == SURF_ROUTING_NULL)
386 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
387 /* add to the sons dictionary */
388 xbt_dict_set(current_routing->routing_sons, AS->id,
389 (void *) new_as, NULL);
390 /* add to the father element list */
391 info->id = current_routing->parse_AS(current_routing, (void *) info);
393 THROWF(arg_error, 0, "All defined components must be belong to a AS");
396 info->rc_component = new_as->routing_father;
397 info->rc_type = SURF_NETWORK_ELEMENT_AS;
398 info->name = new_as->name;
400 xbt_lib_set(as_router_lib, info->name, ROUTING_ASR_LEVEL,
402 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
404 /* set the new current component of the tree */
405 current_routing = new_as;
406 current_routing->net_elem = info;
411 * \brief Specify that the current description of AS is finished
413 * Once you've declared all the content of your AS, you have to close
414 * it with this call. Your AS is not usable until you call this function.
416 * @fixme: this call is not as robust as wanted: bad things WILL happen
417 * if you call it twice for the same AS, or if you forget calling it, or
418 * even if you add stuff to a closed AS
421 void routing_AS_end(sg_platf_AS_cbarg_t AS)
424 if (current_routing == NULL) {
425 THROWF(arg_error, 0, "Close an AS, but none was under construction");
427 if (current_routing->model_desc->end)
428 current_routing->model_desc->end(current_routing);
429 current_routing = current_routing->routing_father;
433 /* Aux Business methods */
436 * \brief Get the AS father and the first elements of the chain
438 * \param src the source host name
439 * \param dst the destination host name
441 * Get the common father of the to processing units, and the first different
442 * father in the chain
444 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
449 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
450 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
452 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
453 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
461 /* (1) find the as where the src and dst are located */
462 sg_routing_edge_t src_data = src;
463 sg_routing_edge_t dst_data = dst;
464 src_as = src_data->rc_component;
465 dst_as = dst_data->rc_component;
467 char* src_name = src_data->name;
468 char* dst_name = dst_data->name;
471 xbt_assert(src_as && dst_as,
472 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
474 /* (2) find the path to the root routing component */
475 for (current = src_as; current != NULL; current = current->routing_father) {
476 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
477 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
478 path_src[index_src++] = current;
480 for (current = dst_as; current != NULL; current = current->routing_father) {
481 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
482 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
483 path_dst[index_dst++] = current;
486 /* (3) find the common father */
488 current_src = path_src[--index_src];
489 current_dst = path_dst[--index_dst];
490 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
492 /* (4) they are not in the same routing component, make the path */
493 if (current_src == current_dst)
494 father = current_src;
496 father = path_src[index_src + 1];
498 /* (5) result generation */
499 *res_father = father; /* first the common father of src and dst */
500 *res_src = current_src; /* second the first different father of src */
501 *res_dst = current_dst; /* three the first different father of dst */
503 #undef ELEMENTS_FATHER_MAXDEPTH
506 /* Global Business methods */
509 * \brief Recursive function for get_route_latency
511 * \param src the source host name
512 * \param dst the destination host name
513 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
514 * \param *latency the latency, if needed
516 * This function is called by "get_route" and "get_latency". It allows to walk
517 * recursively through the ASes tree.
519 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
520 xbt_dynar_t * links, double *latency)
522 s_sg_platf_route_cbarg_t route;
523 memset(&route,0,sizeof(route));
525 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
526 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
528 /* Find how src and dst are interconnected */
529 AS_t common_father, src_father, dst_father;
530 elements_father(src, dst, &common_father, &src_father, &dst_father);
531 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
532 common_father->name,src_father->name,dst_father->name);
534 /* Check whether a direct bypass is defined */
535 sg_platf_route_cbarg_t e_route_bypass = NULL;
536 if (common_father->get_bypass_route)
537 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
539 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
540 if (e_route_bypass) {
541 xbt_dynar_merge(links, &e_route_bypass->link_list);
542 generic_free_route(e_route_bypass);
546 /* If src and dst are in the same AS, life is good */
547 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
548 route.link_list = *links;
549 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
550 // if vivaldi latency+=vivaldi(src,dst)
554 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
556 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
557 // Find the net_card corresponding to father
558 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
559 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
561 common_father->get_route_and_latency(common_father,
562 src_father_net_elm, dst_father_net_elm,
565 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
566 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
568 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
569 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
571 /* If source gateway is not our source, we have to recursively find our way up to this point */
572 if (src != src_gateway_net_elm)
573 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
574 xbt_dynar_merge(links, &route.link_list);
576 /* If dest gateway is not our destination, we have to recursively find our way from this point */
577 if (dst_gateway_net_elm != dst)
578 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
580 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
584 * \brief Find a route between hosts
586 * \param src the network_element_t for src host
587 * \param dst the network_element_t for dst host
588 * \param route where to store the list of links.
589 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
590 * \param latency where to store the latency experienced on the path (or NULL if not interested)
591 * It is the caller responsability to initialize latency to 0 (we add to provided route)
594 * walk through the routing components tree and find a route between hosts
595 * by calling the differents "get_route" functions in each routing component.
597 void routing_get_route_and_latency(sg_routing_edge_t src,
598 sg_routing_edge_t dst,
599 xbt_dynar_t * route, double *latency)
601 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
603 xbt_dynar_reset(routing_platf->last_route);
604 *route = routing_platf->last_route;
607 _get_route_and_latency(src, dst, route, latency);
609 xbt_assert(!latency || *latency >= 0.0,
610 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
613 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
615 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
617 //adding my one link routes
618 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
620 xbt_dynar_merge(&ret,&onelink_mine);
624 xbt_dict_cursor_t cursor = NULL;
626 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
627 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
629 xbt_dynar_merge(&ret,&onelink_child);
634 static xbt_dynar_t get_onelink_routes(void)
636 return recursive_get_onelink_routes(routing_platf->root);
639 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
641 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
645 return SURF_NETWORK_ELEMENT_NULL;
649 * \brief Generic method: create the global routing schema
651 * Make a global routing structure and set all the parsing functions.
653 void routing_model_create( void *loopback)
655 /* config the uniq global routing */
656 routing_platf = xbt_new0(s_routing_platf_t, 1);
657 routing_platf->root = NULL;
658 routing_platf->get_onelink_routes = get_onelink_routes;
659 routing_platf->loopback = loopback;
660 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
661 /* no current routing at moment */
662 current_routing = NULL;
666 /* ************************************************** */
667 /* ********** PATERN FOR NEW ROUTING **************** */
669 /* The minimal configuration of a new routing model need the next functions,
670 * also you need to set at the start of the file, the new model in the model
671 * list. Remember keep the null ending of the list.
673 /*** Routing model structure ***/
675 // s_routing_component_t generic_routing;
676 // /* things that your routing model need */
677 // } s_routing_component_NEW_t,*routing_component_NEW_t;
679 /*** Parse routing model functions ***/
680 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
681 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
682 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
683 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
684 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
686 /*** Business methods ***/
687 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
688 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
689 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
691 /*** Creation routing model functions ***/
692 // static void* model_NEW_create(void) {
693 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
694 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
695 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
696 // new_component->generic_routing.set_route = model_NEW_set_route;
697 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
698 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
699 // new_component->generic_routing.get_route = NEW_get_route;
700 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
701 // new_component->generic_routing.finalize = NEW_finalize;
702 // /* initialization of internal structures */
703 // return new_component;
705 // static void model_NEW_load(void) {} /* mandatory */
706 // static void model_NEW_unload(void) {} /* mandatory */
707 // static void model_NEW_end(void) {} /* mandatory */
709 /* ************************************************************************** */
710 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
712 void routing_cluster_add_backbone(void* bb) {
713 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
714 "You have to be in model Cluster to use tag backbone!");
715 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
716 ((as_cluster_t)current_routing)->backbone = bb;
717 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
720 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
723 char *groups , *host_id , *link_id = NULL;
725 xbt_dynar_t radical_elements;
726 xbt_dynar_t radical_ends;
729 radical_elements = xbt_str_split(cabinet->radical, ",");
730 xbt_dynar_foreach(radical_elements, iter, groups) {
732 radical_ends = xbt_str_split(groups, "-");
733 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
735 switch (xbt_dynar_length(radical_ends)) {
740 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
743 surf_parse_error("Malformed radical");
746 s_sg_platf_host_cbarg_t host;
747 memset(&host, 0, sizeof(host));
748 host.initial_state = SURF_RESOURCE_ON;
749 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
750 xbt_dynar_push(power_state_list,&cabinet->power);
751 host.power_peak = power_state_list;
753 host.power_scale = 1.0;
754 host.core_amount = 1;
756 s_sg_platf_link_cbarg_t link;
757 memset(&link, 0, sizeof(link));
758 link.state = SURF_RESOURCE_ON;
759 link.policy = SURF_LINK_FULLDUPLEX;
760 link.latency = cabinet->lat;
761 link.bandwidth = cabinet->bw;
763 s_sg_platf_host_link_cbarg_t host_link;
764 memset(&host_link, 0, sizeof(host_link));
766 for (i = start; i <= end; i++) {
767 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
768 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
771 sg_platf_new_host(&host);
772 sg_platf_new_link(&link);
774 char* link_up = bprintf("%s_UP",link_id);
775 char* link_down = bprintf("%s_DOWN",link_id);
776 host_link.id = host_id;
777 host_link.link_up = link_up;
778 host_link.link_down= link_down;
779 sg_platf_new_host_link(&host_link);
787 xbt_dynar_free(&radical_ends);
789 xbt_dynar_free(&radical_elements);
792 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
794 char *host_id, *groups, *link_id = NULL;
795 xbt_dict_t patterns = NULL;
797 s_sg_platf_host_cbarg_t host;
798 s_sg_platf_link_cbarg_t link;
802 xbt_dynar_t radical_elements;
803 xbt_dynar_t radical_ends;
805 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
806 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
807 patterns = xbt_dict_new_homogeneous(xbt_free_f);
808 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
809 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
810 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
813 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
814 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
816 AS.routing = A_surfxml_AS_routing_Cluster;
817 sg_platf_new_AS_begin(&AS);
819 current_routing->link_up_down_list
820 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
823 radical_elements = xbt_str_split(cluster->radical, ",");
824 xbt_dynar_foreach(radical_elements, iter, groups) {
826 radical_ends = xbt_str_split(groups, "-");
827 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
829 switch (xbt_dynar_length(radical_ends)) {
834 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
837 surf_parse_error("Malformed radical");
840 for (i = start; i <= end; i++) {
842 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
843 link_id = bprintf("%s_link_%d", cluster->id, i);
845 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
847 memset(&host, 0, sizeof(host));
849 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
850 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
851 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
852 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
853 host.power_trace = tmgr_trace_new_from_file(avail_file);
854 xbt_free(avail_file);
856 XBT_DEBUG("\tavailability_file=\"\"");
859 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
860 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
861 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
862 host.state_trace = tmgr_trace_new_from_file(avail_file);
863 xbt_free(avail_file);
865 XBT_DEBUG("\tstate_file=\"\"");
868 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
869 xbt_dynar_push(power_state_list,&cluster->power);
870 host.power_peak = power_state_list;
873 //host.power_peak = cluster->power;
874 host.power_scale = 1.0;
875 host.core_amount = cluster->core_amount;
876 host.initial_state = SURF_RESOURCE_ON;
878 sg_platf_new_host(&host);
879 XBT_DEBUG("</host>");
881 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
882 cluster->bw, cluster->lat);
884 memset(&link, 0, sizeof(link));
886 link.bandwidth = cluster->bw;
887 link.latency = cluster->lat;
888 link.state = SURF_RESOURCE_ON;
889 link.policy = cluster->sharing_policy;
890 sg_platf_new_link(&link);
892 s_surf_parsing_link_up_down_t info;
894 if (link.policy == SURF_LINK_FULLDUPLEX) {
895 char *tmp_link = bprintf("%s_UP", link_id);
897 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
899 tmp_link = bprintf("%s_DOWN", link_id);
901 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
904 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
905 info.link_down = info.link_up;
908 if(cluster->limiter_link!=0){
909 char *tmp_link = bprintf("%s_limiter", link_id);
910 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
911 cluster->limiter_link);
914 memset(&link, 0, sizeof(link));
916 link.bandwidth = cluster->limiter_link;
918 link.state = SURF_RESOURCE_ON;
919 link.policy = SURF_LINK_SHARED;
920 sg_platf_new_link(&link);
922 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
925 info.limiter_link =NULL;
928 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
929 char *tmp_link = bprintf("%s_loopback", link_id);
930 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
931 cluster->limiter_link);
934 memset(&link, 0, sizeof(link));
936 link.bandwidth = cluster->loopback_bw;
937 link.latency = cluster->loopback_lat;
938 link.state = SURF_RESOURCE_ON;
939 link.policy = SURF_LINK_FATPIPE;
940 sg_platf_new_link(&link);
942 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
945 info.loopback_link =NULL;
948 xbt_dynar_push(current_routing->link_up_down_list,&info);
953 xbt_dynar_free(&radical_ends);
955 xbt_dynar_free(&radical_elements);
957 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
958 // and it's very useful to connect clusters together
960 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
962 s_sg_platf_router_cbarg_t router;
963 memset(&router, 0, sizeof(router));
964 router.id = cluster->router_id;
966 if (!router.id || !strcmp(router.id, ""))
968 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
970 sg_platf_new_router(&router);
971 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
975 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
976 char *link_backbone = bprintf("%s_backbone", cluster->id);
977 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
978 cluster->bb_bw, cluster->bb_lat);
980 memset(&link, 0, sizeof(link));
981 link.id = link_backbone;
982 link.bandwidth = cluster->bb_bw;
983 link.latency = cluster->bb_lat;
984 link.state = SURF_RESOURCE_ON;
985 link.policy = cluster->bb_sharing_policy;
987 sg_platf_new_link(&link);
989 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
995 sg_platf_new_AS_end();
997 xbt_dict_free(&patterns); // no op if it were never set
1000 static void routing_parse_postparse(void) {
1001 xbt_dict_free(&random_value);
1004 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1006 char *host_id = NULL;
1007 char *link_id = NULL;
1008 char *router_id = NULL;
1011 host_id = HOST_PEER(peer->id);
1012 link_id = LINK_PEER(peer->id);
1013 router_id = ROUTER_PEER(peer->id);
1015 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", peer->id);
1016 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
1018 AS.routing = A_surfxml_AS_routing_Cluster;
1019 sg_platf_new_AS_begin(&AS);
1021 current_routing->link_up_down_list
1022 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
1024 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1025 s_sg_platf_host_cbarg_t host;
1026 memset(&host, 0, sizeof(host));
1027 host.initial_state = SURF_RESOURCE_ON;
1030 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
1031 xbt_dynar_push(power_state_list,&peer->power);
1032 host.power_peak = power_state_list;
1034 //host.power_peak = peer->power;
1035 host.power_scale = 1.0;
1036 host.power_trace = peer->availability_trace;
1037 host.state_trace = peer->state_trace;
1038 host.core_amount = 1;
1039 sg_platf_new_host(&host);
1041 s_sg_platf_link_cbarg_t link;
1042 memset(&link, 0, sizeof(link));
1043 link.state = SURF_RESOURCE_ON;
1044 link.policy = SURF_LINK_SHARED;
1045 link.latency = peer->lat;
1047 char* link_up = bprintf("%s_UP",link_id);
1048 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1049 peer->bw_out, peer->lat);
1051 link.bandwidth = peer->bw_out;
1052 sg_platf_new_link(&link);
1054 char* link_down = bprintf("%s_DOWN",link_id);
1055 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1056 peer->bw_in, peer->lat);
1057 link.id = link_down;
1058 link.bandwidth = peer->bw_in;
1059 sg_platf_new_link(&link);
1061 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1062 s_sg_platf_host_link_cbarg_t host_link;
1063 memset(&host_link, 0, sizeof(host_link));
1064 host_link.id = host_id;
1065 host_link.link_up = link_up;
1066 host_link.link_down= link_down;
1067 sg_platf_new_host_link(&host_link);
1069 XBT_DEBUG("<router id=\"%s\"/>", router_id);
1070 s_sg_platf_router_cbarg_t router;
1071 memset(&router, 0, sizeof(router));
1072 router.id = router_id;
1073 router.coord = peer->coord;
1074 sg_platf_new_router(&router);
1075 ((as_cluster_t)current_routing)->router = xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
1078 sg_platf_new_AS_end();
1081 //xbt_dynar_free(&tab_elements_num);
1088 static void routing_parse_Srandom(void)
1090 double mean, std, min, max, seed;
1091 char *random_id = A_surfxml_random_id;
1092 char *random_radical = A_surfxml_random_radical;
1093 char *rd_name = NULL;
1095 mean = surf_parse_get_double(A_surfxml_random_mean);
1096 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1097 min = surf_parse_get_double(A_surfxml_random_min);
1098 max = surf_parse_get_double(A_surfxml_random_max);
1099 seed = surf_parse_get_double(A_surfxml_random_seed);
1103 random_data_t random = xbt_new0(s_random_data_t, 1);
1106 xbt_dynar_t radical_elements;
1110 xbt_dynar_t radical_ends;
1112 switch (A_surfxml_random_generator) {
1113 case AU_surfxml_random_generator:
1114 case A_surfxml_random_generator_NONE:
1115 random->generator = NONE;
1117 case A_surfxml_random_generator_DRAND48:
1118 random->generator = DRAND48;
1120 case A_surfxml_random_generator_RAND:
1121 random->generator = RAND;
1123 case A_surfxml_random_generator_RNGSTREAM:
1124 random->generator = RNGSTREAM;
1127 surf_parse_error("Invalid random generator");
1130 random->seed = seed;
1134 /* Check user stupidities */
1136 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1138 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1140 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1142 /* normalize the mean and standard deviation before storing */
1143 random->mean = (mean - min) / (max - min);
1144 random->std = std / (max - min);
1146 if (random->mean * (1 - random->mean) < random->std * random->std)
1147 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1148 random->mean, random->std);
1151 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1152 random_id, random->min, random->max, random->mean, random->std,
1153 (int)random->generator, random->seed, random_radical);
1156 random_value = xbt_dict_new_homogeneous(free);
1158 if (!strcmp(random_radical, "")) {
1159 res = random_generate(random);
1160 rd_value = bprintf("%f", res);
1161 xbt_dict_set(random_value, random_id, rd_value, NULL);
1163 radical_elements = xbt_str_split(random_radical, ",");
1164 xbt_dynar_foreach(radical_elements, iter, groups) {
1165 radical_ends = xbt_str_split(groups, "-");
1166 switch (xbt_dynar_length(radical_ends)) {
1168 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1169 "Custom Random '%s' already exists !", random_id);
1170 res = random_generate(random);
1172 bprintf("%s%d", random_id,
1173 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1174 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1179 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1180 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1181 for (i = start; i <= end; i++) {
1182 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1183 "Custom Random '%s' already exists !", bprintf("%s%d",
1186 res = random_generate(random);
1187 tmpbuf = bprintf("%s%d", random_id, i);
1188 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1193 XBT_CRITICAL("Malformed radical");
1196 res = random_generate(random);
1197 rd_name = bprintf("%s_router", random_id);
1198 rd_value = bprintf("%f", res);
1199 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1201 xbt_dynar_free(&radical_ends);
1204 xbt_dynar_free(&radical_elements);
1208 void routing_register_callbacks()
1210 sg_platf_host_add_cb(parse_S_host);
1211 sg_platf_router_add_cb(parse_S_router);
1212 sg_platf_host_link_add_cb(parse_S_host_link);
1213 sg_platf_route_add_cb(parse_E_route);
1214 sg_platf_ASroute_add_cb(parse_E_ASroute);
1215 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1216 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1218 sg_platf_cluster_add_cb(routing_parse_cluster);
1219 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1221 sg_platf_peer_add_cb(routing_parse_peer);
1222 sg_platf_postparse_add_cb(routing_parse_postparse);
1224 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1225 sg_platf_AS_end_add_cb(routing_AS_end);
1226 sg_platf_AS_begin_add_cb(routing_AS_begin);
1228 sg_platf_trace_add_cb(routing_parse_trace);
1229 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1232 instr_routing_define_callbacks();
1237 * \brief Recursive function for finalize
1239 * \param rc the source host name
1241 * This fuction is call by "finalize". It allow to finalize the
1242 * AS or routing components. It delete all the structures.
1244 static void finalize_rec(AS_t as) {
1245 xbt_dict_cursor_t cursor = NULL;
1249 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1256 /** \brief Frees all memory allocated by the routing module */
1257 void routing_exit(void) {
1260 xbt_dynar_free(&routing_platf->last_route);
1261 finalize_rec(routing_platf->root);
1262 xbt_free(routing_platf);
1265 AS_t surf_AS_get_routing_root() {
1266 return routing_platf->root;
1269 const char *surf_AS_get_name(AS_t as) {
1273 xbt_dict_t surf_AS_get_routing_sons(AS_t as) {
1274 return as->routing_sons;
1277 const char *surf_AS_get_model(AS_t as) {
1278 return as->model_desc->name;
1281 xbt_dynar_t surf_AS_get_hosts(AS_t as) {
1282 xbt_dynar_t elms = as->index_network_elm;
1283 sg_routing_edge_t relm;
1286 int count = xbt_dynar_length(elms);
1287 xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_dictelm_t), NULL);
1288 for (index = 0; index < count; index++) {
1289 relm = xbt_dynar_get_as(elms, index, sg_routing_edge_t);
1290 delm = xbt_lib_get_elm_or_null(host_lib, relm->name);
1292 xbt_dynar_push(res, &delm);