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"
13 #include <pcre.h> /* regular expression library */
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
45 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
47 static xbt_dict_t random_value = NULL;
49 /** @brief Retrieve a routing edge from its name
51 * Routing edges are either CPU/workstation and routers, whatever
53 sg_routing_edge_t sg_routing_edge_by_name_or_null(const char *name) {
54 sg_routing_edge_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
55 if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
60 routing_platf_t routing_platf = NULL;
61 AS_t current_routing = NULL;
63 /* global parse functions */
64 extern xbt_dynar_t mount_list;
66 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
68 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
69 static void routing_parse_Srandom(void); /* random bypass */
71 static void routing_parse_postparse(void);
73 /* this lines are only for replace use like index in the model table */
78 SURF_MODEL_DIJKSTRACACHE,
85 struct s_model_type routing_models[] = {
87 "Full routing data (fast, large memory requirements, fully expressive)",
88 model_full_create, model_full_end},
90 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
91 model_floyd_create, model_floyd_end},
93 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
94 model_dijkstra_create, model_dijkstra_both_end},
96 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
97 model_dijkstracache_create, model_dijkstra_both_end},
98 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
99 model_none_create, NULL},
100 {"RuleBased", "Rule-Based routing data (...)",
101 model_rulebased_create, NULL},
102 {"Vivaldi", "Vivaldi routing",
103 model_vivaldi_create, NULL},
104 {"Cluster", "Cluster routing",
105 model_cluster_create, NULL},
106 {NULL, NULL, NULL, NULL}
110 * \brief Add a "host_link" to the network element list
112 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
114 sg_routing_edge_t info = NULL;
115 info = xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL);
116 xbt_assert(info, "Host '%s' not found!",host->id);
117 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER] ||
118 current_routing->model_desc == &routing_models[SURF_MODEL_VIVALDI],
119 "You have to be in model Cluster to use tag host_link!");
121 s_surf_parsing_link_up_down_t link_up_down;
122 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
123 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
125 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
126 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
128 if(!current_routing->link_up_down_list)
129 current_routing->link_up_down_list = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
131 // If dynar is is greater than edge id and if the host_link is already defined
132 if(xbt_dynar_length(current_routing->link_up_down_list) > info->id &&
133 xbt_dynar_get_as(current_routing->link_up_down_list,info->id,void*))
134 xbt_die("Host_link for '%s' is already defined!",host->id);
136 XBT_DEBUG("Push Host_link for host '%s' to position %d",info->name,info->id);
137 xbt_dynar_set_as(current_routing->link_up_down_list,info->id,s_surf_parsing_link_up_down_t,link_up_down);
141 * \brief Add a "host" to the network element list
143 static void parse_S_host(sg_platf_host_cbarg_t host)
145 sg_routing_edge_t info = NULL;
146 if (current_routing->hierarchy == SURF_ROUTING_NULL)
147 current_routing->hierarchy = SURF_ROUTING_BASE;
148 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
149 "Reading a host, processing unit \"%s\" already exists", host->id);
151 info = xbt_new0(s_routing_edge_t, 1);
152 info->rc_component = current_routing;
153 info->rc_type = SURF_NETWORK_ELEMENT_HOST;
154 info->name = xbt_strdup(host->id);
155 info->id = current_routing->parse_PU(current_routing, (void *) info);
156 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
157 XBT_DEBUG("Having set name '%s' id '%d'",host->id,info->id);
160 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
164 if (host->coord && strcmp(host->coord, "")) {
168 if (!COORD_HOST_LEVEL)
169 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
170 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
171 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
172 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
173 xbt_dynar_foreach(ctn_str,cursor, str) {
174 double val = atof(str);
175 xbt_dynar_push(ctn,&val);
177 xbt_dynar_shrink(ctn, 0);
178 xbt_dynar_free(&ctn_str);
179 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
180 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
185 * \brief Add a "router" to the network element list
187 static void parse_S_router(sg_platf_router_cbarg_t router)
189 sg_routing_edge_t info = NULL;
190 if (current_routing->hierarchy == SURF_ROUTING_NULL)
191 current_routing->hierarchy = SURF_ROUTING_BASE;
192 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
193 "Reading a router, processing unit \"%s\" already exists",
196 info = xbt_new0(s_routing_edge_t, 1);
197 info->rc_component = current_routing;
198 info->rc_type = SURF_NETWORK_ELEMENT_ROUTER;
199 info->name = xbt_strdup(router->id);
200 info->id = current_routing->parse_PU(current_routing, (void *) info);
201 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
202 XBT_DEBUG("Having set name '%s' id '%d'",router->id,info->id);
204 if (router->coord && strcmp(router->coord, "")) {
208 if (!COORD_ASR_LEVEL)
209 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
210 /* Pre-parse the host coordinates */
211 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
212 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
213 xbt_dynar_foreach(ctn_str,cursor, str) {
214 double val = atof(str);
215 xbt_dynar_push(ctn,&val);
217 xbt_dynar_shrink(ctn, 0);
218 xbt_dynar_free(&ctn_str);
219 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
220 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
225 * \brief Store the route by calling the set_route function of the current routing component
227 static void parse_E_route(sg_platf_route_cbarg_t route)
229 xbt_assert(current_routing->parse_route,
230 "no defined method \"set_route\" in \"%s\"",
231 current_routing->name);
233 current_routing->parse_route(current_routing, route);
237 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
239 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
241 xbt_assert(current_routing->parse_ASroute,
242 "no defined method \"set_ASroute\" in \"%s\"",
243 current_routing->name);
244 current_routing->parse_ASroute(current_routing, ASroute);
248 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
250 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
252 xbt_assert(current_routing->parse_bypassroute,
253 "Bypassing mechanism not implemented by routing '%s'",
254 current_routing->name);
256 current_routing->parse_bypassroute(current_routing, route);
260 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
262 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
264 xbt_assert(current_routing->parse_bypassroute,
265 "Bypassing mechanism not implemented by routing '%s'",
266 current_routing->name);
267 current_routing->parse_bypassroute(current_routing, ASroute);
270 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
272 tmgr_trace_t tmgr_trace;
273 if (!trace->file || strcmp(trace->file, "") != 0) {
274 tmgr_trace = tmgr_trace_new_from_file(trace->file);
275 } else if (strcmp(trace->pc_data, "") == 0) {
279 tmgr_trace_new_from_string(trace->id, trace->pc_data,
282 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
285 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
287 xbt_assert(xbt_dict_get_or_null
288 (traces_set_list, trace_connect->trace),
289 "Cannot connect trace %s to %s: trace unknown",
290 trace_connect->trace,
291 trace_connect->element);
293 switch (trace_connect->kind) {
294 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
295 xbt_dict_set(trace_connect_list_host_avail,
296 trace_connect->trace,
297 xbt_strdup(trace_connect->element), NULL);
299 case SURF_TRACE_CONNECT_KIND_POWER:
300 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
301 xbt_strdup(trace_connect->element), NULL);
303 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
304 xbt_dict_set(trace_connect_list_link_avail,
305 trace_connect->trace,
306 xbt_strdup(trace_connect->element), NULL);
308 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
309 xbt_dict_set(trace_connect_list_bandwidth,
310 trace_connect->trace,
311 xbt_strdup(trace_connect->element), NULL);
313 case SURF_TRACE_CONNECT_KIND_LATENCY:
314 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
315 xbt_strdup(trace_connect->element), NULL);
318 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
319 trace_connect->trace, trace_connect->element);
324 extern int _surf_init_status; /* yay, this is an horrible hack */
327 * \brief Make a new routing component to the platform
329 * Add a new autonomous system to the platform. Any elements (such as host,
330 * router or sub-AS) added after this call and before the corresponding call
331 * to sg_platf_new_AS_close() will be added to this AS.
333 * Once this function was called, the configuration concerning the used
334 * models cannot be changed anymore.
336 * @param AS_id name of this autonomous system. Must be unique in the platform
337 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
339 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
341 XBT_DEBUG("routing_AS_begin");
343 routing_model_description_t model = NULL;
345 xbt_assert(!xbt_lib_get_or_null
346 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
347 "The AS \"%s\" already exists", AS->id);
349 _surf_init_status = 2; /* horrible hack: direct access to the global controlling the level of configuration to prevent any further config */
351 /* search the routing model */
353 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
354 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
355 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
356 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
357 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
358 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
359 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
360 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
361 default: xbt_die("Not a valid model!!!");
365 /* make a new routing component */
366 new_as = (AS_t) model->create();
367 new_as->model_desc = model;
368 new_as->hierarchy = SURF_ROUTING_NULL;
369 new_as->name = xbt_strdup(AS->id);
371 sg_routing_edge_t info = NULL;
372 info = xbt_new0(s_routing_edge_t, 1);
374 if (current_routing == NULL && routing_platf->root == NULL) {
376 /* it is the first one */
377 new_as->routing_father = NULL;
378 routing_platf->root = new_as;
380 } else if (current_routing != NULL && routing_platf->root != NULL) {
382 xbt_assert(!xbt_dict_get_or_null
383 (current_routing->routing_sons, AS->id),
384 "The AS \"%s\" already exists", AS->id);
385 /* it is a part of the tree */
386 new_as->routing_father = current_routing;
387 /* set the father behavior */
388 if (current_routing->hierarchy == SURF_ROUTING_NULL)
389 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
390 /* add to the sons dictionary */
391 xbt_dict_set(current_routing->routing_sons, AS->id,
392 (void *) new_as, NULL);
393 /* add to the father element list */
394 info->id = current_routing->parse_AS(current_routing, (void *) info);
396 THROWF(arg_error, 0, "All defined components must be belong to a AS");
399 info->rc_component = new_as->routing_father;
400 info->rc_type = SURF_NETWORK_ELEMENT_AS;
401 info->name = new_as->name;
403 xbt_lib_set(as_router_lib, info->name, ROUTING_ASR_LEVEL,
405 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
407 /* set the new current component of the tree */
408 current_routing = new_as;
409 current_routing->net_elem = info;
414 * \brief Specify that the current description of AS is finished
416 * Once you've declared all the content of your AS, you have to close
417 * it with this call. Your AS is not usable until you call this function.
419 * @fixme: this call is not as robust as wanted: bad things WILL happen
420 * if you call it twice for the same AS, or if you forget calling it, or
421 * even if you add stuff to a closed AS
424 void routing_AS_end(sg_platf_AS_cbarg_t AS)
427 if (current_routing == NULL) {
428 THROWF(arg_error, 0, "Close an AS, but none was under construction");
430 if (current_routing->model_desc->end)
431 current_routing->model_desc->end(current_routing);
432 current_routing = current_routing->routing_father;
436 /* Aux Business methods */
439 * \brief Get the AS father and the first elements of the chain
441 * \param src the source host name
442 * \param dst the destination host name
444 * Get the common father of the to processing units, and the first different
445 * father in the chain
447 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
452 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
453 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
455 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
456 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
464 /* (1) find the as where the src and dst are located */
465 sg_routing_edge_t src_data = src;
466 sg_routing_edge_t dst_data = dst;
467 src_as = src_data->rc_component;
468 dst_as = dst_data->rc_component;
470 char* src_name = src_data->name;
471 char* dst_name = dst_data->name;
474 xbt_assert(src_as && dst_as,
475 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
477 /* (2) find the path to the root routing component */
478 for (current = src_as; current != NULL; current = current->routing_father) {
479 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
480 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
481 path_src[index_src++] = current;
483 for (current = dst_as; current != NULL; current = current->routing_father) {
484 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
485 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
486 path_dst[index_dst++] = current;
489 /* (3) find the common father */
491 current_src = path_src[--index_src];
492 current_dst = path_dst[--index_dst];
493 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
495 /* (4) they are not in the same routing component, make the path */
496 if (current_src == current_dst)
497 father = current_src;
499 father = path_src[index_src + 1];
501 /* (5) result generation */
502 *res_father = father; /* first the common father of src and dst */
503 *res_src = current_src; /* second the first different father of src */
504 *res_dst = current_dst; /* three the first different father of dst */
506 #undef ELEMENTS_FATHER_MAXDEPTH
509 /* Global Business methods */
512 * \brief Recursive function for get_route_latency
514 * \param src the source host name
515 * \param dst the destination host name
516 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
517 * \param *latency the latency, if needed
519 * This function is called by "get_route" and "get_latency". It allows to walk
520 * recursively through the ASes tree.
522 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
523 xbt_dynar_t * links, double *latency)
525 s_sg_platf_route_cbarg_t route;
526 memset(&route,0,sizeof(route));
528 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
529 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
531 /* Find how src and dst are interconnected */
532 AS_t common_father, src_father, dst_father;
533 elements_father(src, dst, &common_father, &src_father, &dst_father);
534 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
535 common_father->name,src_father->name,dst_father->name);
537 /* Check whether a direct bypass is defined */
538 sg_platf_route_cbarg_t e_route_bypass = NULL;
539 if (common_father->get_bypass_route)
540 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
542 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
543 if (e_route_bypass) {
544 xbt_dynar_merge(links, &e_route_bypass->link_list);
545 generic_free_route(e_route_bypass);
549 /* If src and dst are in the same AS, life is good */
550 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
551 route.link_list = *links;
552 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
553 // if vivaldi latency+=vivaldi(src,dst)
557 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
559 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
560 // Find the net_card corresponding to father
561 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
562 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
564 common_father->get_route_and_latency(common_father,
565 src_father_net_elm, dst_father_net_elm,
568 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
569 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
571 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
572 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
574 /* If source gateway is not our source, we have to recursively find our way up to this point */
575 if (src != src_gateway_net_elm)
576 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
577 xbt_dynar_merge(links, &route.link_list);
579 /* If dest gateway is not our destination, we have to recursively find our way from this point */
580 if (dst_gateway_net_elm != dst)
581 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
583 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
587 * \brief Find a route between hosts
589 * \param src the network_element_t for src host
590 * \param dst the network_element_t for dst host
591 * \param route where to store the list of links.
592 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
593 * \param latency where to store the latency experienced on the path (or NULL if not interested)
594 * It is the caller responsability to initialize latency to 0 (we add to provided route)
597 * walk through the routing components tree and find a route between hosts
598 * by calling the differents "get_route" functions in each routing component.
600 void routing_get_route_and_latency(sg_routing_edge_t src,
601 sg_routing_edge_t dst,
602 xbt_dynar_t * route, double *latency)
604 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
606 xbt_dynar_reset(routing_platf->last_route);
607 *route = routing_platf->last_route;
610 _get_route_and_latency(src, dst, route, latency);
612 xbt_assert(!latency || *latency >= 0.0,
613 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
616 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
618 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
620 //adding my one link routes
621 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
623 xbt_dynar_merge(&ret,&onelink_mine);
627 xbt_dict_cursor_t cursor = NULL;
629 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
630 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
632 xbt_dynar_merge(&ret,&onelink_child);
637 static xbt_dynar_t get_onelink_routes(void)
639 return recursive_get_onelink_routes(routing_platf->root);
642 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
644 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
648 return SURF_NETWORK_ELEMENT_NULL;
652 * \brief Generic method: create the global routing schema
654 * Make a global routing structure and set all the parsing functions.
656 void routing_model_create( void *loopback)
658 /* config the uniq global routing */
659 routing_platf = xbt_new0(s_routing_platf_t, 1);
660 routing_platf->root = NULL;
661 routing_platf->get_onelink_routes = get_onelink_routes;
662 routing_platf->loopback = loopback;
663 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
664 /* no current routing at moment */
665 current_routing = NULL;
669 /* ************************************************** */
670 /* ********** PATERN FOR NEW ROUTING **************** */
672 /* The minimal configuration of a new routing model need the next functions,
673 * also you need to set at the start of the file, the new model in the model
674 * list. Remember keep the null ending of the list.
676 /*** Routing model structure ***/
678 // s_routing_component_t generic_routing;
679 // /* things that your routing model need */
680 // } s_routing_component_NEW_t,*routing_component_NEW_t;
682 /*** Parse routing model functions ***/
683 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
684 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
685 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
686 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
687 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
689 /*** Business methods ***/
690 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
691 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
692 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
694 /*** Creation routing model functions ***/
695 // static void* model_NEW_create(void) {
696 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
697 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
698 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
699 // new_component->generic_routing.set_route = model_NEW_set_route;
700 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
701 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
702 // new_component->generic_routing.get_route = NEW_get_route;
703 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
704 // new_component->generic_routing.finalize = NEW_finalize;
705 // /* initialization of internal structures */
706 // return new_component;
708 // static void model_NEW_load(void) {} /* mandatory */
709 // static void model_NEW_unload(void) {} /* mandatory */
710 // static void model_NEW_end(void) {} /* mandatory */
712 /* ************************************************************************** */
713 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
715 void routing_cluster_add_backbone(void* bb) {
716 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
717 "You have to be in model Cluster to use tag backbone!");
718 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
719 ((as_cluster_t)current_routing)->backbone = bb;
720 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
723 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
726 char *groups , *host_id , *link_id = NULL;
728 xbt_dynar_t radical_elements;
729 xbt_dynar_t radical_ends;
732 radical_elements = xbt_str_split(cabinet->radical, ",");
733 xbt_dynar_foreach(radical_elements, iter, groups) {
735 radical_ends = xbt_str_split(groups, "-");
736 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
738 switch (xbt_dynar_length(radical_ends)) {
743 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
746 surf_parse_error("Malformed radical");
749 s_sg_platf_host_cbarg_t host;
750 memset(&host, 0, sizeof(host));
751 host.initial_state = SURF_RESOURCE_ON;
752 host.power_peak = cabinet->power;
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 host.power_peak = cluster->power;
869 host.power_scale = 1.0;
870 host.core_amount = cluster->core_amount;
871 host.initial_state = SURF_RESOURCE_ON;
873 sg_platf_new_host(&host);
874 XBT_DEBUG("</host>");
876 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
877 cluster->bw, cluster->lat);
879 memset(&link, 0, sizeof(link));
881 link.bandwidth = cluster->bw;
882 link.latency = cluster->lat;
883 link.state = SURF_RESOURCE_ON;
884 link.policy = cluster->sharing_policy;
885 sg_platf_new_link(&link);
887 s_surf_parsing_link_up_down_t info;
889 if (link.policy == SURF_LINK_FULLDUPLEX) {
890 char *tmp_link = bprintf("%s_UP", link_id);
892 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
894 tmp_link = bprintf("%s_DOWN", link_id);
896 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
899 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
900 info.link_down = info.link_up;
902 xbt_dynar_push(current_routing->link_up_down_list,&info);
907 xbt_dynar_free(&radical_ends);
909 xbt_dynar_free(&radical_elements);
911 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
912 // and it's very useful to connect clusters together
914 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
916 s_sg_platf_router_cbarg_t router;
917 memset(&router, 0, sizeof(router));
918 router.id = cluster->router_id;
920 if (!router.id || !strcmp(router.id, ""))
922 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
924 sg_platf_new_router(&router);
928 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
929 char *link_backbone = bprintf("%s_backbone", cluster->id);
930 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
931 cluster->bb_bw, cluster->bb_lat);
933 memset(&link, 0, sizeof(link));
934 link.id = link_backbone;
935 link.bandwidth = cluster->bb_bw;
936 link.latency = cluster->bb_lat;
937 link.state = SURF_RESOURCE_ON;
938 link.policy = cluster->bb_sharing_policy;
940 sg_platf_new_link(&link);
942 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
948 sg_platf_new_AS_end();
950 xbt_dict_free(&patterns); // no op if it were never set
953 static void routing_parse_postparse(void) {
954 xbt_dict_free(&random_value);
957 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
959 char *host_id = NULL;
963 host_id = HOST_PEER(peer->id);
964 link_id = LINK_PEER(peer->id);
966 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
967 s_sg_platf_host_cbarg_t host;
968 memset(&host, 0, sizeof(host));
969 host.initial_state = SURF_RESOURCE_ON;
971 host.power_peak = peer->power;
972 host.power_scale = 1.0;
973 host.power_trace = peer->availability_trace;
974 host.state_trace = peer->state_trace;
975 host.core_amount = 1;
976 host.coord = peer->coord;
977 sg_platf_new_host(&host);
979 s_sg_platf_link_cbarg_t link;
980 memset(&link, 0, sizeof(link));
981 link.state = SURF_RESOURCE_ON;
982 link.policy = SURF_LINK_SHARED;
983 link.latency = peer->lat;
985 char* link_up = bprintf("%s_UP",link_id);
986 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
987 peer->bw_out, peer->lat);
989 link.bandwidth = peer->bw_out;
990 sg_platf_new_link(&link);
992 char* link_down = bprintf("%s_DOWN",link_id);
993 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
994 peer->bw_in, peer->lat);
996 link.bandwidth = peer->bw_in;
997 sg_platf_new_link(&link);
999 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1000 s_sg_platf_host_link_cbarg_t host_link;
1001 memset(&host_link, 0, sizeof(host_link));
1002 host_link.id = host_id;
1003 host_link.link_up = link_up;
1004 host_link.link_down= link_down;
1005 sg_platf_new_host_link(&host_link);
1009 //xbt_dynar_free(&tab_elements_num);
1016 static void routing_parse_Srandom(void)
1018 double mean, std, min, max, seed;
1019 char *random_id = A_surfxml_random_id;
1020 char *random_radical = A_surfxml_random_radical;
1021 char *rd_name = NULL;
1023 mean = surf_parse_get_double(A_surfxml_random_mean);
1024 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1025 min = surf_parse_get_double(A_surfxml_random_min);
1026 max = surf_parse_get_double(A_surfxml_random_max);
1027 seed = surf_parse_get_double(A_surfxml_random_seed);
1031 random_data_t random = xbt_new0(s_random_data_t, 1);
1034 xbt_dynar_t radical_elements;
1038 xbt_dynar_t radical_ends;
1040 switch (A_surfxml_random_generator) {
1041 case AU_surfxml_random_generator:
1042 case A_surfxml_random_generator_NONE:
1043 random->generator = NONE;
1045 case A_surfxml_random_generator_DRAND48:
1046 random->generator = DRAND48;
1048 case A_surfxml_random_generator_RAND:
1049 random->generator = RAND;
1051 case A_surfxml_random_generator_RNGSTREAM:
1052 random->generator = RNGSTREAM;
1055 surf_parse_error("Invalid random generator");
1058 random->seed = seed;
1062 /* Check user stupidities */
1064 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1066 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1068 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1070 /* normalize the mean and standard deviation before storing */
1071 random->mean = (mean - min) / (max - min);
1072 random->std = std / (max - min);
1074 if (random->mean * (1 - random->mean) < random->std * random->std)
1075 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1076 random->mean, random->std);
1079 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1080 random_id, random->min, random->max, random->mean, random->std,
1081 (int)random->generator, random->seed, random_radical);
1084 random_value = xbt_dict_new_homogeneous(free);
1086 if (!strcmp(random_radical, "")) {
1087 res = random_generate(random);
1088 rd_value = bprintf("%f", res);
1089 xbt_dict_set(random_value, random_id, rd_value, NULL);
1091 radical_elements = xbt_str_split(random_radical, ",");
1092 xbt_dynar_foreach(radical_elements, iter, groups) {
1093 radical_ends = xbt_str_split(groups, "-");
1094 switch (xbt_dynar_length(radical_ends)) {
1096 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1097 "Custom Random '%s' already exists !", random_id);
1098 res = random_generate(random);
1100 bprintf("%s%d", random_id,
1101 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1102 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1107 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1108 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1109 for (i = start; i <= end; i++) {
1110 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1111 "Custom Random '%s' already exists !", bprintf("%s%d",
1114 res = random_generate(random);
1115 tmpbuf = bprintf("%s%d", random_id, i);
1116 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1121 XBT_CRITICAL("Malformed radical");
1124 res = random_generate(random);
1125 rd_name = bprintf("%s_router", random_id);
1126 rd_value = bprintf("%f", res);
1127 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1129 xbt_dynar_free(&radical_ends);
1132 xbt_dynar_free(&radical_elements);
1136 void routing_register_callbacks()
1138 sg_platf_host_add_cb(parse_S_host);
1139 sg_platf_router_add_cb(parse_S_router);
1140 sg_platf_host_link_add_cb(parse_S_host_link);
1141 sg_platf_route_add_cb(parse_E_route);
1142 sg_platf_ASroute_add_cb(parse_E_ASroute);
1143 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1144 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1146 sg_platf_cluster_add_cb(routing_parse_cluster);
1147 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1149 sg_platf_peer_add_cb(routing_parse_peer);
1150 sg_platf_postparse_add_cb(routing_parse_postparse);
1152 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1153 sg_platf_AS_end_add_cb(routing_AS_end);
1154 sg_platf_AS_begin_add_cb(routing_AS_begin);
1156 sg_platf_trace_add_cb(routing_parse_trace);
1157 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1160 instr_routing_define_callbacks();
1165 * \brief Recursive function for finalize
1167 * \param rc the source host name
1169 * This fuction is call by "finalize". It allow to finalize the
1170 * AS or routing components. It delete all the structures.
1172 static void finalize_rec(AS_t as) {
1173 xbt_dict_cursor_t cursor = NULL;
1177 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1184 /** \brief Frees all memory allocated by the routing module */
1185 void routing_exit(void) {
1188 xbt_dynar_free(&routing_platf->last_route);
1189 finalize_rec(routing_platf->root);
1190 xbt_free(routing_platf);