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 xbt_dynar_t parsed_link_list = NULL; /* temporary store of current list link of a route */
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_network_element_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_network_element_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 route_t created_route = xbt_new0(s_route_t, 1);
230 created_route->link_list = parsed_link_list;
232 xbt_assert(current_routing->parse_route,
233 "no defined method \"set_route\" in \"%s\"",
234 current_routing->name);
236 current_routing->parse_route(current_routing,
237 route->src, route->dst, created_route);
238 generic_free_route(created_route);
239 parsed_link_list = NULL;
243 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
245 static void parse_E_ASroute(sg_platf_ASroute_cbarg_t ASroute)
247 route_t e_route = xbt_new0(s_route_t, 1);
248 e_route->link_list = parsed_link_list;
250 if (!strcmp(current_routing->model_desc->name,"RuleBased")) {
251 // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
252 // store the provided name instead of the entity directly (model_rulebased_parse_ASroute knows)
254 // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
255 e_route->src_gateway = (sg_routing_edge_t) ASroute->gw_src;
256 e_route->dst_gateway = (sg_routing_edge_t) ASroute->gw_dst;
258 e_route->src_gateway = sg_routing_edge_by_name_or_null(ASroute->gw_src);
259 e_route->dst_gateway = sg_routing_edge_by_name_or_null(ASroute->gw_dst);
261 xbt_assert(current_routing->parse_ASroute,
262 "no defined method \"set_ASroute\" in \"%s\"",
263 current_routing->name);
264 current_routing->parse_ASroute(current_routing, ASroute->src, ASroute->dst, e_route);
265 generic_free_route(e_route);
266 parsed_link_list = NULL;
270 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
272 static void parse_E_bypassRoute(sg_platf_bypassRoute_cbarg_t route)
274 route_t e_route = xbt_new0(s_route_t, 1);
275 e_route->link_list = parsed_link_list;
277 xbt_assert(current_routing->parse_bypassroute,
278 "Bypassing mechanism not implemented by routing '%s'",
279 current_routing->name);
281 current_routing->parse_bypassroute(current_routing, route->src, route->dst, e_route);
282 parsed_link_list = NULL;
286 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
288 static void parse_E_bypassASroute(sg_platf_bypassASroute_cbarg_t ASroute)
290 route_t e_route = xbt_new0(s_route_t, 1);
291 e_route->link_list = parsed_link_list;
292 e_route->src_gateway = sg_routing_edge_by_name_or_null(ASroute->gw_src);
293 e_route->dst_gateway = sg_routing_edge_by_name_or_null(ASroute->gw_dst);
294 xbt_assert(current_routing->parse_bypassroute,
295 "Bypassing mechanism not implemented by routing '%s'",
296 current_routing->name);
297 current_routing->parse_bypassroute(current_routing, ASroute->src, ASroute->dst, e_route);
298 parsed_link_list = NULL;
302 * \brief Set a new link on the actual list of link for a route or ASroute from XML
305 static void routing_parse_link_ctn(sg_platf_linkctn_cbarg_t linkctn)
308 switch (linkctn->direction) {
309 case SURF_LINK_DIRECTION_NONE:
310 link_id = xbt_strdup(linkctn->id);
312 case SURF_LINK_DIRECTION_UP:
313 link_id = bprintf("%s_UP", linkctn->id);
315 case SURF_LINK_DIRECTION_DOWN:
316 link_id = bprintf("%s_DOWN", linkctn->id);
320 if(parsed_link_list == NULL)
321 parsed_link_list = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
323 xbt_dynar_push(parsed_link_list, &link_id);
326 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
328 tmgr_trace_t tmgr_trace;
329 if (!trace->file || strcmp(trace->file, "") != 0) {
330 tmgr_trace = tmgr_trace_new_from_file(trace->file);
331 } else if (strcmp(trace->pc_data, "") == 0) {
335 tmgr_trace_new_from_string(trace->id, trace->pc_data,
338 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
341 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
343 xbt_assert(xbt_dict_get_or_null
344 (traces_set_list, trace_connect->trace),
345 "Cannot connect trace %s to %s: trace unknown",
346 trace_connect->trace,
347 trace_connect->element);
349 switch (trace_connect->kind) {
350 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
351 xbt_dict_set(trace_connect_list_host_avail,
352 trace_connect->trace,
353 xbt_strdup(trace_connect->element), NULL);
355 case SURF_TRACE_CONNECT_KIND_POWER:
356 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
357 xbt_strdup(trace_connect->element), NULL);
359 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
360 xbt_dict_set(trace_connect_list_link_avail,
361 trace_connect->trace,
362 xbt_strdup(trace_connect->element), NULL);
364 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
365 xbt_dict_set(trace_connect_list_bandwidth,
366 trace_connect->trace,
367 xbt_strdup(trace_connect->element), NULL);
369 case SURF_TRACE_CONNECT_KIND_LATENCY:
370 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
371 xbt_strdup(trace_connect->element), NULL);
374 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
375 trace_connect->trace, trace_connect->element);
381 * \brief Make a new routing component to the platform
383 * Add a new autonomous system to the platform. Any elements (such as host,
384 * router or sub-AS) added after this call and before the corresponding call
385 * to sg_platf_new_AS_close() will be added to this AS.
387 * Once this function was called, the configuration concerning the used
388 * models cannot be changed anymore.
390 * @param AS_id name of this autonomous system. Must be unique in the platform
391 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
393 void routing_AS_begin(const char *AS_id, int wanted_routing_type)
396 routing_model_description_t model = NULL;
398 xbt_assert(!xbt_lib_get_or_null
399 (as_router_lib, AS_id, ROUTING_ASR_LEVEL),
400 "The AS \"%s\" already exists", AS_id);
402 /* search the routing model */
403 switch(wanted_routing_type){
404 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
405 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
406 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
407 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
408 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
409 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
410 case A_surfxml_AS_routing_RuleBased: model = &routing_models[SURF_MODEL_RULEBASED];break;
411 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
414 /* make a new routing component */
415 new_as = (AS_t) model->create();
416 new_as->model_desc = model;
417 new_as->hierarchy = SURF_ROUTING_NULL;
418 new_as->name = xbt_strdup(AS_id);
420 sg_routing_edge_t info = NULL;
421 info = xbt_new0(s_network_element_t, 1);
423 if (current_routing == NULL && routing_platf->root == NULL) {
425 /* it is the first one */
426 new_as->routing_father = NULL;
427 routing_platf->root = new_as;
429 } else if (current_routing != NULL && routing_platf->root != NULL) {
431 xbt_assert(!xbt_dict_get_or_null
432 (current_routing->routing_sons, AS_id),
433 "The AS \"%s\" already exists", AS_id);
434 /* it is a part of the tree */
435 new_as->routing_father = current_routing;
436 /* set the father behavior */
437 if (current_routing->hierarchy == SURF_ROUTING_NULL)
438 current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
439 /* add to the sons dictionary */
440 xbt_dict_set(current_routing->routing_sons, AS_id,
441 (void *) new_as, NULL);
442 /* add to the father element list */
443 info->id = current_routing->parse_AS(current_routing, (void *) info);
445 THROWF(arg_error, 0, "All defined components must be belong to a AS");
448 info->rc_component = new_as->routing_father;
449 info->rc_type = SURF_NETWORK_ELEMENT_AS;
450 info->name = new_as->name;
452 xbt_lib_set(as_router_lib, new_as->name, ROUTING_ASR_LEVEL,
454 XBT_DEBUG("Having set name '%s' id '%d'",new_as->name,info->id);
456 /* set the new current component of the tree */
457 current_routing = new_as;
458 current_routing->net_elem = info;
463 * \brief Specify that the current description of AS is finished
465 * Once you've declared all the content of your AS, you have to close
466 * it with this call. Your AS is not usable until you call this function.
468 * @fixme: this call is not as robust as wanted: bad things WILL happen
469 * if you call it twice for the same AS, or if you forget calling it, or
470 * even if you add stuff to a closed AS
473 void routing_AS_end()
476 if (current_routing == NULL) {
477 THROWF(arg_error, 0, "Close an AS, but none was under construction");
479 if (current_routing->model_desc->end)
480 current_routing->model_desc->end(current_routing);
481 current_routing = current_routing->routing_father;
485 /* Aux Business methods */
488 * \brief Get the AS father and the first elements of the chain
490 * \param src the source host name
491 * \param dst the destination host name
493 * Get the common father of the to processing units, and the first different
494 * father in the chain
496 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
501 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
502 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
504 AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
505 AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
513 /* (1) find the as where the src and dst are located */
514 sg_routing_edge_t src_data = src;
515 sg_routing_edge_t dst_data = dst;
516 src_as = src_data->rc_component;
517 dst_as = dst_data->rc_component;
519 char* src_name = src_data->name;
520 char* dst_name = dst_data->name;
523 xbt_assert(src_as && dst_as,
524 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
526 /* (2) find the path to the root routing component */
527 for (current = src_as; current != NULL; current = current->routing_father) {
528 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
529 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
530 path_src[index_src++] = current;
532 for (current = dst_as; current != NULL; current = current->routing_father) {
533 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
534 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
535 path_dst[index_dst++] = current;
538 /* (3) find the common father */
540 current_src = path_src[--index_src];
541 current_dst = path_dst[--index_dst];
542 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
544 /* (4) they are not in the same routing component, make the path */
545 if (current_src == current_dst)
546 father = current_src;
548 father = path_src[index_src + 1];
550 /* (5) result generation */
551 *res_father = father; /* first the common father of src and dst */
552 *res_src = current_src; /* second the first different father of src */
553 *res_dst = current_dst; /* three the first different father of dst */
555 #undef ELEMENTS_FATHER_MAXDEPTH
558 /* Global Business methods */
561 * \brief Recursive function for get_route_latency
563 * \param src the source host name
564 * \param dst the destination host name
565 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
566 * \param *latency the latency, if needed
568 * This function is called by "get_route" and "get_latency". It allows to walk
569 * recursively through the ASes tree.
571 static void _get_route_and_latency(sg_routing_edge_t src, sg_routing_edge_t dst,
572 xbt_dynar_t * links, double *latency)
575 memset(&route,0,sizeof(route));
577 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name, dst->name);
578 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
580 /* Find how src and dst are interconnected */
581 AS_t common_father, src_father, dst_father;
582 elements_father(src, dst, &common_father, &src_father, &dst_father);
583 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
584 common_father->name,src_father->name,dst_father->name);
586 /* Check whether a direct bypass is defined */
587 route_t e_route_bypass = NULL;
588 if (common_father->get_bypass_route)
589 e_route_bypass = common_father->get_bypass_route(common_father, src, dst, latency);
591 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
592 if (e_route_bypass) {
593 xbt_dynar_merge(links, &e_route_bypass->link_list);
594 generic_free_route(e_route_bypass);
598 /* If src and dst are in the same AS, life is good */
599 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
600 route.link_list = *links;
601 common_father->get_route_and_latency(common_father, src, dst, &route,latency);
602 // if vivaldi latency+=vivaldi(src,dst)
606 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
608 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
609 // Find the net_card corresponding to father
610 sg_routing_edge_t src_father_net_elm = src_father->net_elem;
611 sg_routing_edge_t dst_father_net_elm = dst_father->net_elem;
613 common_father->get_route_and_latency(common_father,
614 src_father_net_elm, dst_father_net_elm,
617 xbt_assert((route.src_gateway != NULL) && (route.dst_gateway != NULL),
618 "bad gateways for route from \"%s\" to \"%s\"", src->name, dst->name);
620 sg_routing_edge_t src_gateway_net_elm = route.src_gateway;
621 sg_routing_edge_t dst_gateway_net_elm = route.dst_gateway;
623 /* If source gateway is not our source, we have to recursively find our way up to this point */
624 if (src != src_gateway_net_elm)
625 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
626 xbt_dynar_merge(links, &route.link_list);
628 /* If dest gateway is not our destination, we have to recursively find our way from this point */
629 if (dst_gateway_net_elm != dst)
630 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
632 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
636 * \brief Find a route between hosts
638 * \param src the network_element_t for src host
639 * \param dst the network_element_t for dst host
640 * \param route where to store the list of links.
641 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
642 * \param latency where to store the latency experienced on the path (or NULL if not interested)
643 * It is the caller responsability to initialize latency to 0 (we add to provided route)
646 * walk through the routing components tree and find a route between hosts
647 * by calling the differents "get_route" functions in each routing component.
649 void routing_get_route_and_latency(sg_routing_edge_t src,
650 sg_routing_edge_t dst,
651 xbt_dynar_t * route, double *latency)
653 XBT_DEBUG("routing_get_route_and_latency from %s to %s",src->name,dst->name);
655 xbt_dynar_reset(routing_platf->last_route);
656 *route = routing_platf->last_route;
659 _get_route_and_latency(src, dst, route, latency);
661 xbt_assert(!latency || *latency >= 0.0,
662 "negative latency on route between \"%s\" and \"%s\"", src->name, dst->name);
665 static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
667 xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
669 //adding my one link routes
670 xbt_dynar_t onelink_mine = rc->get_onelink_routes(rc);
672 xbt_dynar_merge(&ret,&onelink_mine);
676 xbt_dict_cursor_t cursor = NULL;
678 xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
679 xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
681 xbt_dynar_merge(&ret,&onelink_child);
686 static xbt_dynar_t get_onelink_routes(void)
688 return recursive_get_onelink_routes(routing_platf->root);
691 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
693 sg_routing_edge_t rc = sg_routing_edge_by_name_or_null(name);
697 return SURF_NETWORK_ELEMENT_NULL;
701 * \brief Generic method: create the global routing schema
703 * Make a global routing structure and set all the parsing functions.
705 void routing_model_create( void *loopback)
707 /* config the uniq global routing */
708 routing_platf = xbt_new0(s_routing_platf_t, 1);
709 routing_platf->root = NULL;
710 routing_platf->get_onelink_routes = get_onelink_routes;
711 routing_platf->loopback = loopback;
712 routing_platf->last_route = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
713 /* no current routing at moment */
714 current_routing = NULL;
718 /* ************************************************** */
719 /* ********** PATERN FOR NEW ROUTING **************** */
721 /* The minimal configuration of a new routing model need the next functions,
722 * also you need to set at the start of the file, the new model in the model
723 * list. Remember keep the null ending of the list.
725 /*** Routing model structure ***/
727 // s_routing_component_t generic_routing;
728 // /* things that your routing model need */
729 // } s_routing_component_NEW_t,*routing_component_NEW_t;
731 /*** Parse routing model functions ***/
732 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
733 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
734 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
735 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
736 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
738 /*** Business methods ***/
739 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
740 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
741 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
743 /*** Creation routing model functions ***/
744 // static void* model_NEW_create(void) {
745 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
746 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
747 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
748 // new_component->generic_routing.set_route = model_NEW_set_route;
749 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
750 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
751 // new_component->generic_routing.get_route = NEW_get_route;
752 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
753 // new_component->generic_routing.finalize = NEW_finalize;
754 // /* initialization of internal structures */
755 // return new_component;
757 // static void model_NEW_load(void) {} /* mandatory */
758 // static void model_NEW_unload(void) {} /* mandatory */
759 // static void model_NEW_end(void) {} /* mandatory */
761 /* ************************************************************************** */
762 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
764 void routing_cluster_add_backbone(void* bb) {
765 xbt_assert(current_routing->model_desc == &routing_models[SURF_MODEL_CLUSTER],
766 "You have to be in model Cluster to use tag backbone!");
767 xbt_assert(!((as_cluster_t)current_routing)->backbone,"The backbone link is already defined!");
768 ((as_cluster_t)current_routing)->backbone = bb;
769 XBT_DEBUG("Add a backbone to AS '%s'",current_routing->name);
772 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
775 char *groups , *host_id , *link_id = NULL;
777 xbt_dynar_t radical_elements;
778 xbt_dynar_t radical_ends;
781 radical_elements = xbt_str_split(cabinet->radical, ",");
782 xbt_dynar_foreach(radical_elements, iter, groups) {
784 radical_ends = xbt_str_split(groups, "-");
785 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
787 switch (xbt_dynar_length(radical_ends)) {
792 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
795 surf_parse_error("Malformed radical");
798 s_sg_platf_host_cbarg_t host;
799 memset(&host, 0, sizeof(host));
800 host.initial_state = SURF_RESOURCE_ON;
801 host.power_peak = cabinet->power;
802 host.power_scale = 1.0;
803 host.core_amount = 1;
805 s_sg_platf_link_cbarg_t link;
806 memset(&link, 0, sizeof(link));
807 link.state = SURF_RESOURCE_ON;
808 link.policy = SURF_LINK_FULLDUPLEX;
809 link.latency = cabinet->lat;
810 link.bandwidth = cabinet->bw;
812 s_sg_platf_host_link_cbarg_t host_link;
813 memset(&host_link, 0, sizeof(host_link));
815 for (i = start; i <= end; i++) {
816 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
817 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
820 sg_platf_new_host(&host);
821 sg_platf_new_link(&link);
823 char* link_up = bprintf("%s_UP",link_id);
824 char* link_down = bprintf("%s_DOWN",link_id);
825 host_link.id = host_id;
826 host_link.link_up = link_up;
827 host_link.link_down= link_down;
828 sg_platf_new_host_link(&host_link);
836 xbt_dynar_free(&radical_ends);
838 xbt_dynar_free(&radical_elements);
841 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
843 char *host_id, *groups, *link_id = NULL;
844 xbt_dict_t patterns = NULL;
846 s_sg_platf_host_cbarg_t host;
847 s_sg_platf_link_cbarg_t link;
851 xbt_dynar_t radical_elements;
852 xbt_dynar_t radical_ends;
854 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
855 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
856 patterns = xbt_dict_new_homogeneous(xbt_free_f);
857 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
858 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
859 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
862 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
863 sg_platf_new_AS_begin(cluster->id, A_surfxml_AS_routing_Cluster);
865 current_routing->link_up_down_list
866 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
869 radical_elements = xbt_str_split(cluster->radical, ",");
870 xbt_dynar_foreach(radical_elements, iter, groups) {
872 radical_ends = xbt_str_split(groups, "-");
873 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
875 switch (xbt_dynar_length(radical_ends)) {
880 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
883 surf_parse_error("Malformed radical");
886 for (i = start; i <= end; i++) {
888 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
889 link_id = bprintf("%s_link_%d", cluster->id, i);
891 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
893 memset(&host, 0, sizeof(host));
895 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
896 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
897 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
898 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
899 host.power_trace = tmgr_trace_new_from_file(avail_file);
900 xbt_free(avail_file);
902 XBT_DEBUG("\tavailability_file=\"\"");
905 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
906 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
907 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
908 host.state_trace = tmgr_trace_new_from_file(avail_file);
909 xbt_free(avail_file);
911 XBT_DEBUG("\tstate_file=\"\"");
914 host.power_peak = cluster->power;
915 host.power_scale = 1.0;
916 host.core_amount = cluster->core_amount;
917 host.initial_state = SURF_RESOURCE_ON;
919 sg_platf_new_host(&host);
920 XBT_DEBUG("</host>");
922 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
923 cluster->bw, cluster->lat);
925 memset(&link, 0, sizeof(link));
927 link.bandwidth = cluster->bw;
928 link.latency = cluster->lat;
929 link.state = SURF_RESOURCE_ON;
930 link.policy = cluster->sharing_policy;
931 sg_platf_new_link(&link);
933 s_surf_parsing_link_up_down_t info;
935 if (link.policy == SURF_LINK_FULLDUPLEX) {
936 char *tmp_link = bprintf("%s_UP", link_id);
938 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
940 tmp_link = bprintf("%s_DOWN", link_id);
942 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
945 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
946 info.link_down = info.link_up;
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);
974 if ((cluster->bb_bw != 0) && (cluster->bb_lat != 0)) {
975 char *link_backbone = bprintf("%s_backbone", cluster->id);
976 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
977 cluster->bb_bw, cluster->bb_lat);
979 memset(&link, 0, sizeof(link));
980 link.id = link_backbone;
981 link.bandwidth = cluster->bb_bw;
982 link.latency = cluster->bb_lat;
983 link.state = SURF_RESOURCE_ON;
984 link.policy = cluster->bb_sharing_policy;
986 sg_platf_new_link(&link);
988 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
994 sg_platf_new_AS_end();
996 xbt_dict_free(&patterns); // no op if it were never set
999 static void routing_parse_postparse(void) {
1000 xbt_dict_free(&random_value);
1003 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1005 char *host_id = NULL;
1009 host_id = HOST_PEER(peer->id);
1010 link_id = LINK_PEER(peer->id);
1012 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1013 s_sg_platf_host_cbarg_t host;
1014 memset(&host, 0, sizeof(host));
1015 host.initial_state = SURF_RESOURCE_ON;
1017 host.power_peak = peer->power;
1018 host.power_scale = 1.0;
1019 host.power_trace = peer->availability_trace;
1020 host.state_trace = peer->state_trace;
1021 host.core_amount = 1;
1022 host.coord = peer->coord;
1023 sg_platf_new_host(&host);
1025 s_sg_platf_link_cbarg_t link;
1026 memset(&link, 0, sizeof(link));
1027 link.state = SURF_RESOURCE_ON;
1028 link.policy = SURF_LINK_SHARED;
1029 link.latency = peer->lat;
1031 char* link_up = bprintf("%s_UP",link_id);
1032 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1033 peer->bw_out, peer->lat);
1035 link.bandwidth = peer->bw_out;
1036 sg_platf_new_link(&link);
1038 char* link_down = bprintf("%s_DOWN",link_id);
1039 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1040 peer->bw_in, peer->lat);
1041 link.id = link_down;
1042 link.bandwidth = peer->bw_in;
1043 sg_platf_new_link(&link);
1045 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1046 s_sg_platf_host_link_cbarg_t host_link;
1047 memset(&host_link, 0, sizeof(host_link));
1048 host_link.id = host_id;
1049 host_link.link_up = link_up;
1050 host_link.link_down= link_down;
1051 sg_platf_new_host_link(&host_link);
1055 //xbt_dynar_free(&tab_elements_num);
1062 static void routing_parse_Srandom(void)
1064 double mean, std, min, max, seed;
1065 char *random_id = A_surfxml_random_id;
1066 char *random_radical = A_surfxml_random_radical;
1067 char *rd_name = NULL;
1069 mean = surf_parse_get_double(A_surfxml_random_mean);
1070 std = surf_parse_get_double(A_surfxml_random_std_deviation);
1071 min = surf_parse_get_double(A_surfxml_random_min);
1072 max = surf_parse_get_double(A_surfxml_random_max);
1073 seed = surf_parse_get_double(A_surfxml_random_seed);
1077 random_data_t random = xbt_new0(s_random_data_t, 1);
1080 xbt_dynar_t radical_elements;
1084 xbt_dynar_t radical_ends;
1086 switch (A_surfxml_random_generator) {
1087 case AU_surfxml_random_generator:
1088 case A_surfxml_random_generator_NONE:
1089 random->generator = NONE;
1091 case A_surfxml_random_generator_DRAND48:
1092 random->generator = DRAND48;
1094 case A_surfxml_random_generator_RAND:
1095 random->generator = RAND;
1097 case A_surfxml_random_generator_RNGSTREAM:
1098 random->generator = RNGSTREAM;
1101 surf_parse_error("Invalid random generator");
1104 random->seed = seed;
1108 /* Check user stupidities */
1110 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1112 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1114 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1116 /* normalize the mean and standard deviation before storing */
1117 random->mean = (mean - min) / (max - min);
1118 random->std = std / (max - min);
1120 if (random->mean * (1 - random->mean) < random->std * random->std)
1121 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1122 random->mean, random->std);
1125 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1126 random_id, random->min, random->max, random->mean, random->std,
1127 (int)random->generator, random->seed, random_radical);
1130 random_value = xbt_dict_new_homogeneous(free);
1132 if (!strcmp(random_radical, "")) {
1133 res = random_generate(random);
1134 rd_value = bprintf("%f", res);
1135 xbt_dict_set(random_value, random_id, rd_value, NULL);
1137 radical_elements = xbt_str_split(random_radical, ",");
1138 xbt_dynar_foreach(radical_elements, iter, groups) {
1139 radical_ends = xbt_str_split(groups, "-");
1140 switch (xbt_dynar_length(radical_ends)) {
1142 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1143 "Custom Random '%s' already exists !", random_id);
1144 res = random_generate(random);
1146 bprintf("%s%d", random_id,
1147 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1148 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1153 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1154 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1155 for (i = start; i <= end; i++) {
1156 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1157 "Custom Random '%s' already exists !", bprintf("%s%d",
1160 res = random_generate(random);
1161 tmpbuf = bprintf("%s%d", random_id, i);
1162 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1167 XBT_CRITICAL("Malformed radical");
1170 res = random_generate(random);
1171 rd_name = bprintf("%s_router", random_id);
1172 rd_value = bprintf("%f", res);
1173 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1175 xbt_dynar_free(&radical_ends);
1178 xbt_dynar_free(&radical_elements);
1182 void routing_register_callbacks()
1184 sg_platf_host_add_cb(parse_S_host);
1185 sg_platf_router_add_cb(parse_S_router);
1186 sg_platf_host_link_add_cb(parse_S_host_link);
1187 sg_platf_route_add_cb(parse_E_route);
1188 sg_platf_ASroute_add_cb(parse_E_ASroute);
1189 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1190 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1192 sg_platf_cluster_add_cb(routing_parse_cluster);
1193 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1195 sg_platf_peer_add_cb(routing_parse_peer);
1196 sg_platf_postparse_add_cb(routing_parse_postparse);
1198 sg_platf_linkctn_add_cb(routing_parse_link_ctn);
1200 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1201 sg_platf_AS_end_add_cb(routing_AS_end);
1202 sg_platf_AS_begin_add_cb(routing_AS_begin);
1204 sg_platf_trace_add_cb(routing_parse_trace);
1205 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1208 instr_routing_define_callbacks();
1213 * \brief Recursive function for finalize
1215 * \param rc the source host name
1217 * This fuction is call by "finalize". It allow to finalize the
1218 * AS or routing components. It delete all the structures.
1220 static void finalize_rec(AS_t as) {
1221 xbt_dict_cursor_t cursor = NULL;
1225 xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
1232 /** \brief Frees all memory allocated by the routing module */
1233 void routing_exit(void) {
1236 xbt_dynar_free(&routing_platf->last_route);
1237 finalize_rec(routing_platf->root);
1238 xbt_free(routing_platf);