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 "surf_routing.hpp"
8 #include "surf_routing_private.hpp"
10 #include "simgrid/platf_interface.h" // platform creation API internal interface
11 #include "simgrid/sg_config.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 host level
25 int SIMIX_STORAGE_LEVEL; //Simix storage level
26 int MSG_HOST_LEVEL; //Msg host level
27 int MSG_STORAGE_LEVEL; //Msg storage level
28 int SD_HOST_LEVEL; //Simdag host level
29 int SD_STORAGE_LEVEL; //Simdag storage level
30 int COORD_HOST_LEVEL=0; //Coordinates level
31 int NS3_HOST_LEVEL; //host node for ns3
34 * @ingroup SURF_build_api
35 * @brief A library containing all known links
38 int SD_LINK_LEVEL; //Simdag level
39 int SURF_LINK_LEVEL; //Surf level
40 int NS3_LINK_LEVEL; //link for ns3
42 xbt_lib_t as_router_lib;
43 int ROUTING_ASR_LEVEL; //Routing level
44 int COORD_ASR_LEVEL; //Coordinates level
45 int NS3_ASR_LEVEL; //host node for ns3
46 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
48 static xbt_dict_t random_value = NULL;
51 /** @brief Retrieve a routing edge from its name
53 * Routing edges are either CPU/workstation and routers, whatever
55 RoutingEdgePtr sg_routing_edge_by_name_or_null(const char *name) {
56 RoutingEdgePtr net_elm = (RoutingEdgePtr) xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
58 net_elm = (RoutingEdgePtr) xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
63 RoutingPlatfPtr routing_platf = NULL;
64 AsPtr current_routing = NULL;
66 /* global parse functions */
67 extern xbt_dynar_t mount_list;
70 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
73 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
74 static void routing_parse_Srandom(void); /* random bypass */
76 static void routing_parse_postparse(void);
78 /* this lines are only for replace use like index in the model table */
83 SURF_MODEL_DIJKSTRACACHE,
89 struct s_model_type routing_models[] = {
91 "Full routing data (fast, large memory requirements, fully expressive)",
92 model_full_create, model_full_end},
94 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
95 model_floyd_create, model_floyd_end},
97 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
98 model_dijkstra_create, model_dijkstra_both_end},
100 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
101 model_dijkstracache_create, model_dijkstra_both_end},
102 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
103 model_none_create, NULL},
104 {"Vivaldi", "Vivaldi routing",
105 model_vivaldi_create, NULL},
106 {"Cluster", "Cluster routing",
107 model_cluster_create, NULL},
108 {NULL, NULL, NULL, NULL}
112 * \brief Add a "host_link" to the network element list
114 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
116 RoutingEdgePtr info = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL));
117 xbt_assert(info, "Host '%s' not found!", host->id);
118 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER] ||
119 current_routing->p_modelDesc == &routing_models[SURF_MODEL_VIVALDI],
120 "You have to be in model Cluster to use tag host_link!");
122 s_surf_parsing_link_up_down_t link_up_down;
123 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
124 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
125 link_up_down.limiter_link = NULL;
126 link_up_down.loopback_link = NULL;
128 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
129 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
131 if(!current_routing->p_linkUpDownList)
132 current_routing->p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
134 // If dynar is is greater than edge id and if the host_link is already defined
135 if(xbt_dynar_length(current_routing->p_linkUpDownList) > info->m_id &&
136 xbt_dynar_get_as(current_routing->p_linkUpDownList, info->m_id, void*))
137 xbt_die("Host_link for '%s' is already defined!",host->id);
139 XBT_DEBUG("Push Host_link for host '%s' to position %d", info->p_name, info->m_id);
140 xbt_dynar_set_as(current_routing->p_linkUpDownList, info->m_id, s_surf_parsing_link_up_down_t, link_up_down);
144 * \brief Add a "host" to the network element list
146 static void parse_S_host(sg_platf_host_cbarg_t host)
148 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
149 current_routing->p_hierarchy = SURF_ROUTING_BASE;
150 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
151 "Reading a host, processing unit \"%s\" already exists", host->id);
153 RoutingEdgePtr info = new RoutingEdge();
154 info->p_rcComponent = current_routing;
155 info->p_rcType = SURF_NETWORK_ELEMENT_HOST;
156 info->p_name = xbt_strdup(host->id);
157 info->m_id = current_routing->parsePU(info);
158 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
159 XBT_DEBUG("Having set name '%s' id '%d'", host->id, info->m_id);
162 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
166 if (host->coord && strcmp(host->coord, "")) {
170 if (!COORD_HOST_LEVEL)
171 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
172 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
173 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
174 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
175 xbt_dynar_foreach(ctn_str,cursor, str) {
176 double val = atof(str);
177 xbt_dynar_push(ctn,&val);
179 xbt_dynar_shrink(ctn, 0);
180 xbt_dynar_free(&ctn_str);
181 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
182 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
187 * \brief Add a "router" to the network element list
189 static void parse_S_router(sg_platf_router_cbarg_t router)
191 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
192 current_routing->p_hierarchy = SURF_ROUTING_BASE;
193 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
194 "Reading a router, processing unit \"%s\" already exists",
197 RoutingEdgePtr info = new RoutingEdge();
198 info->p_rcComponent = current_routing;
199 info->p_rcType = SURF_NETWORK_ELEMENT_ROUTER;
200 info->p_name = xbt_strdup(router->id);
201 info->m_id = current_routing->parsePU(info);
202 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
203 XBT_DEBUG("Having set name '%s' id '%d'", router->id, info->m_id);
205 if (router->coord && strcmp(router->coord, "")) {
209 if (!COORD_ASR_LEVEL)
210 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
211 /* Pre-parse the host coordinates */
212 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
213 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
214 xbt_dynar_foreach(ctn_str,cursor, str) {
215 double val = atof(str);
216 xbt_dynar_push(ctn,&val);
218 xbt_dynar_shrink(ctn, 0);
219 xbt_dynar_free(&ctn_str);
220 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
221 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
226 * \brief Store the route by calling the set_route function of the current routing component
228 static void parse_E_route(sg_platf_route_cbarg_t route)
230 /*FIXME:REMOVE:xbt_assert(current_routing->parse_route,
231 "no defined method \"set_route\" in \"%s\"",
232 current_routing->name);*/
234 current_routing->parseRoute(route);
238 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
240 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
242 /*FIXME:REMOVE:xbt_assert(current_routing->parse_ASroute,
243 "no defined method \"set_ASroute\" in \"%s\"",
244 current_routing->name);*/
245 current_routing->parseASroute(ASroute);
249 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
251 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
253 /*FIXME:REMOVE:xbt_assert(current_routing->parse_bypassroute,
254 "Bypassing mechanism not implemented by routing '%s'",
255 current_routing->name);*/
257 current_routing->parseBypassroute(route);
261 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
263 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
265 /*FIXME:REMOVE:xbt_assert(current_routing->parse_bypassroute,
266 "Bypassing mechanism not implemented by routing '%s'",
267 current_routing->name);*/
268 current_routing->parseBypassroute(ASroute);
271 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
273 tmgr_trace_t tmgr_trace;
274 if (!trace->file || strcmp(trace->file, "") != 0) {
275 tmgr_trace = tmgr_trace_new_from_file(trace->file);
276 } else if (strcmp(trace->pc_data, "") == 0) {
280 tmgr_trace_new_from_string(trace->id, trace->pc_data,
283 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
286 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
288 xbt_assert(xbt_dict_get_or_null
289 (traces_set_list, trace_connect->trace),
290 "Cannot connect trace %s to %s: trace unknown",
291 trace_connect->trace,
292 trace_connect->element);
294 switch (trace_connect->kind) {
295 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
296 xbt_dict_set(trace_connect_list_host_avail,
297 trace_connect->trace,
298 xbt_strdup(trace_connect->element), NULL);
300 case SURF_TRACE_CONNECT_KIND_POWER:
301 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
302 xbt_strdup(trace_connect->element), NULL);
304 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
305 xbt_dict_set(trace_connect_list_link_avail,
306 trace_connect->trace,
307 xbt_strdup(trace_connect->element), NULL);
309 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
310 xbt_dict_set(trace_connect_list_bandwidth,
311 trace_connect->trace,
312 xbt_strdup(trace_connect->element), NULL);
314 case SURF_TRACE_CONNECT_KIND_LATENCY:
315 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
316 xbt_strdup(trace_connect->element), NULL);
319 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
320 trace_connect->trace, trace_connect->element);
326 * \brief Make a new routing component to the platform
328 * Add a new autonomous system to the platform. Any elements (such as host,
329 * router or sub-AS) added after this call and before the corresponding call
330 * to sg_platf_new_AS_close() will be added to this AS.
332 * Once this function was called, the configuration concerning the used
333 * models cannot be changed anymore.
335 * @param AS_id name of this autonomous system. Must be unique in the platform
336 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
338 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
340 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_cfg_init_status = 2; /* horrible hack: direct access to the global
348 * controlling the level of configuration to prevent
349 * 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_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
360 default: xbt_die("Not a valid model!!!");
364 /* make a new routing component */
365 AsPtr new_as = model->create();
367 new_as->p_modelDesc = model;
368 new_as->p_hierarchy = SURF_ROUTING_NULL;
369 new_as->p_name = xbt_strdup(AS->id);
371 RoutingEdgePtr info = new RoutingEdge();
373 if (current_routing == NULL && routing_platf->p_root == NULL) {
375 /* it is the first one */
376 new_as->p_routingFather = NULL;
377 routing_platf->p_root = new_as;
379 } else if (current_routing != NULL && routing_platf->p_root != NULL) {
381 xbt_assert(!xbt_dict_get_or_null
382 (current_routing->p_routingSons, AS->id),
383 "The AS \"%s\" already exists", AS->id);
384 /* it is a part of the tree */
385 new_as->p_routingFather = current_routing;
386 /* set the father behavior */
387 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
388 current_routing->p_hierarchy = SURF_ROUTING_RECURSIVE;
389 /* add to the sons dictionary */
390 xbt_dict_set(current_routing->p_routingSons, AS->id,
391 (void *) new_as, NULL);
392 /* add to the father element list */
393 info->m_id = current_routing->parseAS(info);
395 THROWF(arg_error, 0, "All defined components must be belong to a AS");
398 info->p_rcComponent = new_as->p_routingFather;
399 info->p_rcType = SURF_NETWORK_ELEMENT_AS;
400 info->p_name = new_as->p_name;
402 xbt_lib_set(as_router_lib, info->p_name, ROUTING_ASR_LEVEL,
404 XBT_DEBUG("Having set name '%s' id '%d'", new_as->p_name, info->m_id);
406 /* set the new current component of the tree */
407 current_routing = new_as;
408 current_routing->p_netElem = info;
413 * \brief Specify that the current description of AS is finished
415 * Once you've declared all the content of your AS, you have to close
416 * it with this call. Your AS is not usable until you call this function.
418 * @fixme: this call is not as robust as wanted: bad things WILL happen
419 * if you call it twice for the same AS, or if you forget calling it, or
420 * even if you add stuff to a closed AS
423 void routing_AS_end(sg_platf_AS_cbarg_t AS)
426 if (current_routing == NULL) {
427 THROWF(arg_error, 0, "Close an AS, but none was under construction");
429 if (current_routing->p_modelDesc->end)
430 current_routing->p_modelDesc->end(current_routing);
431 current_routing = current_routing->p_routingFather;
435 /* Aux Business methods */
438 * \brief Get the AS father and the first elements of the chain
440 * \param src the source host name
441 * \param dst the destination host name
443 * Get the common father of the to processing units, and the first different
444 * father in the chain
446 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
451 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
452 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
453 AsPtr src_as, dst_as;
454 AsPtr path_src[ELEMENTS_FATHER_MAXDEPTH];
455 AsPtr path_dst[ELEMENTS_FATHER_MAXDEPTH];
463 /* (1) find the as where the src and dst are located */
464 sg_routing_edge_t src_data = src;
465 sg_routing_edge_t dst_data = dst;
466 src_as = src_data->p_rcComponent;
467 dst_as = dst_data->p_rcComponent;
469 char* src_name = src_data->p_name;
470 char* dst_name = dst_data->p_name;
473 xbt_assert(src_as && dst_as,
474 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
476 /* (2) find the path to the root routing component */
477 for (current = src_as; current != NULL; current = current->p_routingFather) {
478 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
479 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
480 path_src[index_src++] = current;
482 for (current = dst_as; current != NULL; current = current->p_routingFather) {
483 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
484 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
485 path_dst[index_dst++] = current;
488 /* (3) find the common father */
490 current_src = path_src[--index_src];
491 current_dst = path_dst[--index_dst];
492 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
494 /* (4) they are not in the same routing component, make the path */
495 if (current_src == current_dst)
496 father = current_src;
498 father = path_src[index_src + 1];
500 /* (5) result generation */
501 *res_father = father; /* first the common father of src and dst */
502 *res_src = current_src; /* second the first different father of src */
503 *res_dst = current_dst; /* three the first different father of dst */
505 #undef ELEMENTS_FATHER_MAXDEPTH
508 /* Global Business methods */
511 * \brief Recursive function for get_route_latency
513 * \param src the source host name
514 * \param dst the destination host name
515 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
516 * \param *latency the latency, if needed
518 * This function is called by "get_route" and "get_latency". It allows to walk
519 * recursively through the ASes tree.
521 static void _get_route_and_latency(RoutingEdgePtr src, RoutingEdgePtr dst,
522 xbt_dynar_t * links, double *latency)
524 s_sg_platf_route_cbarg_t route;
525 memset(&route,0,sizeof(route));
527 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
528 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->p_name, dst->p_name);
530 /* Find how src and dst are interconnected */
531 AsPtr common_father, src_father, dst_father;
532 elements_father(src, dst, &common_father, &src_father, &dst_father);
533 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
534 common_father->p_name, src_father->p_name, dst_father->p_name);
536 /* Check whether a direct bypass is defined */
537 sg_platf_route_cbarg_t e_route_bypass = NULL;
538 //FIXME:REMOVE:if (common_father->get_bypass_route)
540 e_route_bypass = common_father->getBypassRoute(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 //FIXME: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->getRouteAndLatency(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 RoutingEdgePtr src_father_net_elm = src_father->p_netElem;
562 RoutingEdgePtr dst_father_net_elm = dst_father->p_netElem;
564 common_father->getRouteAndLatency(src_father_net_elm, dst_father_net_elm,
567 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
568 "bad gateways for route from \"%s\" to \"%s\"", src->p_name, dst->p_name);
570 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
571 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
573 /* If source gateway is not our source, we have to recursively find our way up to this point */
574 if (src != src_gateway_net_elm)
575 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
576 xbt_dynar_merge(links, &route.link_list);
578 /* If dest gateway is not our destination, we have to recursively find our way from this point */
579 if (dst_gateway_net_elm != dst)
580 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
582 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
585 AS_t surf_platf_get_root(routing_platf_t platf){
586 return platf->p_root;
589 e_surf_network_element_type_t surf_routing_edge_get_rc_type(sg_routing_edge_t edge){
590 return edge->p_rcType;
595 * \brief Find a route between hosts
597 * \param src the network_element_t for src host
598 * \param dst the network_element_t for dst host
599 * \param route where to store the list of links.
600 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
601 * \param latency where to store the latency experienced on the path (or NULL if not interested)
602 * It is the caller responsability to initialize latency to 0 (we add to provided route)
605 * walk through the routing components tree and find a route between hosts
606 * by calling the differents "get_route" functions in each routing component.
608 void RoutingPlatf::getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst,
609 xbt_dynar_t* route, double *latency)
611 XBT_DEBUG("routing_get_route_and_latency from %s to %s", src->p_name, dst->p_name);
613 xbt_dynar_reset(routing_platf->p_lastRoute);
614 *route = routing_platf->p_lastRoute;
617 _get_route_and_latency(src, dst, route, latency);
619 xbt_assert(!latency || *latency >= 0.0,
620 "negative latency on route between \"%s\" and \"%s\"", src->p_name, dst->p_name);
623 xbt_dynar_t RoutingPlatf::getOneLinkRoutes(){
624 return recursiveGetOneLinkRoutes(p_root);
627 xbt_dynar_t RoutingPlatf::recursiveGetOneLinkRoutes(AsPtr rc)
629 xbt_dynar_t ret = xbt_dynar_new(sizeof(OnelinkPtr), xbt_free);
631 //adding my one link routes
632 xbt_dynar_t onelink_mine = rc->getOneLinkRoutes();
634 xbt_dynar_merge(&ret,&onelink_mine);
638 xbt_dict_cursor_t cursor = NULL;
640 xbt_dict_foreach(rc->p_routingSons, cursor, key, rc_child) {
641 xbt_dynar_t onelink_child = recursiveGetOneLinkRoutes(rc_child);
643 xbt_dynar_merge(&ret,&onelink_child);
648 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
650 RoutingEdgePtr rc = sg_routing_edge_by_name_or_null(name);
654 return SURF_NETWORK_ELEMENT_NULL;
658 * \brief Generic method: create the global routing schema
660 * Make a global routing structure and set all the parsing functions.
662 void routing_model_create( void *loopback)
664 /* config the uniq global routing */
665 routing_platf = new RoutingPlatf();
666 routing_platf->p_root = NULL;
667 routing_platf->p_loopback = loopback;
668 routing_platf->p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
669 /* no current routing at moment */
670 current_routing = NULL;
674 /* ************************************************** */
675 /* ********** PATERN FOR NEW ROUTING **************** */
677 /* The minimal configuration of a new routing model need the next functions,
678 * also you need to set at the start of the file, the new model in the model
679 * list. Remember keep the null ending of the list.
681 /*** Routing model structure ***/
683 // s_routing_component_t generic_routing;
684 // /* things that your routing model need */
685 // } s_routing_component_NEW_t,*routing_component_NEW_t;
687 /*** Parse routing model functions ***/
688 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
689 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
690 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
691 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
692 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
694 /*** Business methods ***/
695 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
696 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
697 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
699 /*** Creation routing model functions ***/
700 // static void* model_NEW_create(void) {
701 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
702 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
703 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
704 // new_component->generic_routing.set_route = model_NEW_set_route;
705 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
706 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
707 // new_component->generic_routing.get_route = NEW_get_route;
708 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
709 // new_component->generic_routing.finalize = NEW_finalize;
710 // /* initialization of internal structures */
711 // return new_component;
713 // static void model_NEW_load(void) {} /* mandatory */
714 // static void model_NEW_unload(void) {} /* mandatory */
715 // static void model_NEW_end(void) {} /* mandatory */
717 /* ************************************************************************** */
718 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
720 void routing_cluster_add_backbone(void* bb) {
721 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER],
722 "You have to be in model Cluster to use tag backbone!");
723 xbt_assert(!surf_as_cluster_get_backbone(current_routing), "The backbone link is already defined!");
724 surf_as_cluster_set_backbone(current_routing, bb);
725 XBT_DEBUG("Add a backbone to AS '%s'", current_routing->p_name);
728 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
731 char *groups , *host_id , *link_id = NULL;
733 xbt_dynar_t radical_elements;
734 xbt_dynar_t radical_ends;
737 radical_elements = xbt_str_split(cabinet->radical, ",");
738 xbt_dynar_foreach(radical_elements, iter, groups) {
740 radical_ends = xbt_str_split(groups, "-");
741 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
743 switch (xbt_dynar_length(radical_ends)) {
748 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
751 surf_parse_error("Malformed radical");
754 s_sg_platf_host_cbarg_t host;
755 memset(&host, 0, sizeof(host));
756 host.initial_state = SURF_RESOURCE_ON;
758 host.power_scale = 1.0;
759 host.core_amount = 1;
761 s_sg_platf_link_cbarg_t link;
762 memset(&link, 0, sizeof(link));
763 link.state = SURF_RESOURCE_ON;
764 link.policy = SURF_LINK_FULLDUPLEX;
765 link.latency = cabinet->lat;
766 link.bandwidth = cabinet->bw;
768 s_sg_platf_host_link_cbarg_t host_link;
769 memset(&host_link, 0, sizeof(host_link));
771 for (i = start; i <= end; i++) {
772 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
773 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
776 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
777 xbt_dynar_push(power_state_list,&cabinet->power);
778 host.power_peak = power_state_list;
779 sg_platf_new_host(&host);
780 sg_platf_new_link(&link);
782 char* link_up = bprintf("%s_UP",link_id);
783 char* link_down = bprintf("%s_DOWN",link_id);
784 host_link.id = host_id;
785 host_link.link_up = link_up;
786 host_link.link_down= link_down;
787 sg_platf_new_host_link(&host_link);
795 xbt_dynar_free(&radical_ends);
797 xbt_dynar_free(&radical_elements);
800 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
802 char *host_id, *groups, *link_id = NULL;
803 xbt_dict_t patterns = NULL;
805 s_sg_platf_host_cbarg_t host;
806 s_sg_platf_link_cbarg_t link;
810 xbt_dynar_t radical_elements;
811 xbt_dynar_t radical_ends;
813 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
814 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
815 patterns = xbt_dict_new_homogeneous(xbt_free_f);
816 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
817 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
818 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
821 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
822 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
824 AS.routing = A_surfxml_AS_routing_Cluster;
825 sg_platf_new_AS_begin(&AS);
827 current_routing->p_linkUpDownList
828 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
831 radical_elements = xbt_str_split(cluster->radical, ",");
832 xbt_dynar_foreach(radical_elements, iter, groups) {
834 radical_ends = xbt_str_split(groups, "-");
835 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
837 switch (xbt_dynar_length(radical_ends)) {
842 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
845 surf_parse_error("Malformed radical");
848 for (i = start; i <= end; i++) {
850 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
851 link_id = bprintf("%s_link_%d", cluster->id, i);
853 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
855 memset(&host, 0, sizeof(host));
857 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
858 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
859 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
860 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
861 host.power_trace = tmgr_trace_new_from_file(avail_file);
862 xbt_free(avail_file);
864 XBT_DEBUG("\tavailability_file=\"\"");
867 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
868 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
869 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
870 host.state_trace = tmgr_trace_new_from_file(avail_file);
871 xbt_free(avail_file);
873 XBT_DEBUG("\tstate_file=\"\"");
876 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
877 xbt_dynar_push(power_state_list,&cluster->power);
878 host.power_peak = power_state_list;
881 //host.power_peak = cluster->power;
882 host.power_scale = 1.0;
883 host.core_amount = cluster->core_amount;
884 host.initial_state = SURF_RESOURCE_ON;
886 sg_platf_new_host(&host);
887 XBT_DEBUG("</host>");
889 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
890 cluster->bw, cluster->lat);
892 memset(&link, 0, sizeof(link));
894 link.bandwidth = cluster->bw;
895 link.latency = cluster->lat;
896 link.state = SURF_RESOURCE_ON;
897 link.policy = cluster->sharing_policy;
898 sg_platf_new_link(&link);
900 s_surf_parsing_link_up_down_t info;
902 if (link.policy == SURF_LINK_FULLDUPLEX) {
903 char *tmp_link = bprintf("%s_UP", link_id);
905 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
907 tmp_link = bprintf("%s_DOWN", link_id);
909 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
912 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
913 info.link_down = info.link_up;
916 if(cluster->limiter_link!=0){
917 char *tmp_link = bprintf("%s_limiter", link_id);
918 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
919 cluster->limiter_link);
922 memset(&link, 0, sizeof(link));
924 link.bandwidth = cluster->limiter_link;
926 link.state = SURF_RESOURCE_ON;
927 link.policy = SURF_LINK_SHARED;
928 sg_platf_new_link(&link);
930 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
933 info.limiter_link =NULL;
936 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
937 char *tmp_link = bprintf("%s_loopback", link_id);
938 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
939 cluster->limiter_link);
942 memset(&link, 0, sizeof(link));
944 link.bandwidth = cluster->loopback_bw;
945 link.latency = cluster->loopback_lat;
946 link.state = SURF_RESOURCE_ON;
947 link.policy = SURF_LINK_FATPIPE;
948 sg_platf_new_link(&link);
950 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
953 info.loopback_link =NULL;
956 xbt_dynar_push(current_routing->p_linkUpDownList, &info);
961 xbt_dynar_free(&radical_ends);
963 xbt_dynar_free(&radical_elements);
965 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
966 // and it's very useful to connect clusters together
968 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
970 s_sg_platf_router_cbarg_t router;
971 memset(&router, 0, sizeof(router));
972 router.id = cluster->router_id;
974 if (!router.id || !strcmp(router.id, ""))
976 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
978 sg_platf_new_router(&router);
979 ((AsClusterPtr)current_routing)->p_router = (RoutingEdgePtr) xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
983 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
984 char *link_backbone = bprintf("%s_backbone", cluster->id);
985 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
986 cluster->bb_bw, cluster->bb_lat);
988 memset(&link, 0, sizeof(link));
989 link.id = link_backbone;
990 link.bandwidth = cluster->bb_bw;
991 link.latency = cluster->bb_lat;
992 link.state = SURF_RESOURCE_ON;
993 link.policy = cluster->bb_sharing_policy;
995 sg_platf_new_link(&link);
997 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
1003 sg_platf_new_AS_end();
1005 xbt_dict_free(&patterns); // no op if it were never set
1008 static void routing_parse_postparse(void) {
1009 xbt_dict_free(&random_value);
1012 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
1014 char *host_id = NULL;
1015 char *link_id = NULL;
1016 char *router_id = NULL;
1019 host_id = HOST_PEER(peer->id);
1020 link_id = LINK_PEER(peer->id);
1021 router_id = ROUTER_PEER(peer->id);
1023 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", peer->id);
1024 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
1026 AS.routing = A_surfxml_AS_routing_Cluster;
1027 sg_platf_new_AS_begin(&AS);
1029 current_routing->p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
1031 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1032 s_sg_platf_host_cbarg_t host;
1033 memset(&host, 0, sizeof(host));
1034 host.initial_state = SURF_RESOURCE_ON;
1037 xbt_dynar_t power_state_list = xbt_dynar_new(sizeof(double), NULL);
1038 xbt_dynar_push(power_state_list,&peer->power);
1039 host.power_peak = power_state_list;
1041 //host.power_peak = peer->power;
1042 host.power_scale = 1.0;
1043 host.power_trace = peer->availability_trace;
1044 host.state_trace = peer->state_trace;
1045 host.core_amount = 1;
1046 sg_platf_new_host(&host);
1048 s_sg_platf_link_cbarg_t link;
1049 memset(&link, 0, sizeof(link));
1050 link.state = SURF_RESOURCE_ON;
1051 link.policy = SURF_LINK_SHARED;
1052 link.latency = peer->lat;
1054 char* link_up = bprintf("%s_UP",link_id);
1055 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1056 peer->bw_out, peer->lat);
1058 link.bandwidth = peer->bw_out;
1059 sg_platf_new_link(&link);
1061 char* link_down = bprintf("%s_DOWN",link_id);
1062 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1063 peer->bw_in, peer->lat);
1064 link.id = link_down;
1065 link.bandwidth = peer->bw_in;
1066 sg_platf_new_link(&link);
1068 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1069 s_sg_platf_host_link_cbarg_t host_link;
1070 memset(&host_link, 0, sizeof(host_link));
1071 host_link.id = host_id;
1072 host_link.link_up = link_up;
1073 host_link.link_down= link_down;
1074 sg_platf_new_host_link(&host_link);
1076 XBT_DEBUG("<router id=\"%s\"/>", router_id);
1077 s_sg_platf_router_cbarg_t router;
1078 memset(&router, 0, sizeof(router));
1079 router.id = router_id;
1080 router.coord = peer->coord;
1081 sg_platf_new_router(&router);
1082 static_cast<AsClusterPtr>(current_routing)->p_router = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL));
1085 sg_platf_new_AS_end();
1088 //xbt_dynar_free(&tab_elements_num);
1096 static void routing_parse_Srandom(void)
1098 double mean, std, min, max, seed;
1099 char *random_id = A_surfxml_random_id;
1100 char *random_radical = A_surfxml_random_radical;
1101 char *rd_name = NULL;
1103 mean = surf_parse_get_double(A_surfxml_random_mean);
1104 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1105 min = surf_parse_get_double(A_surfxml_random_min);
1106 max = surf_parse_get_double(A_surfxml_random_max);
1107 seed = surf_parse_get_double(A_surfxml_random_seed);
1111 random_data_t random = xbt_new0(s_random_data_t, 1);
1114 xbt_dynar_t radical_elements;
1118 xbt_dynar_t radical_ends;
1120 switch (A_surfxml_random_generator) {
1121 case AU_surfxml_random_generator:
1122 case A_surfxml_random_generator_NONE:
1123 random->generator = NONE;
1125 case A_surfxml_random_generator_DRAND48:
1126 random->generator = DRAND48;
1128 case A_surfxml_random_generator_RAND:
1129 random->generator = RAND;
1131 case A_surfxml_random_generator_RNGSTREAM:
1132 random->generator = RNGSTREAM;
1135 surf_parse_error("Invalid random generator");
1138 random->seed = seed;
1142 /* Check user stupidities */
1144 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1146 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1148 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1150 /* normalize the mean and standard deviation before storing */
1151 random->mean = (mean - min) / (max - min);
1152 random->std = std / (max - min);
1154 if (random->mean * (1 - random->mean) < random->std * random->std)
1155 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1156 random->mean, random->std);
1159 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1160 random_id, random->min, random->max, random->mean, random->std,
1161 (int)random->generator, random->seed, random_radical);
1164 random_value = xbt_dict_new_homogeneous(free);
1166 if (!strcmp(random_radical, "")) {
1167 res = random_generate(random);
1168 rd_value = bprintf("%f", res);
1169 xbt_dict_set(random_value, random_id, rd_value, NULL);
1171 radical_elements = xbt_str_split(random_radical, ",");
1172 xbt_dynar_foreach(radical_elements, iter, groups) {
1173 radical_ends = xbt_str_split(groups, "-");
1174 switch (xbt_dynar_length(radical_ends)) {
1176 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1177 "Custom Random '%s' already exists !", random_id);
1178 res = random_generate(random);
1180 bprintf("%s%d", random_id,
1181 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1182 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1187 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1188 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1189 for (i = start; i <= end; i++) {
1190 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1191 "Custom Random '%s' already exists !", bprintf("%s%d",
1194 res = random_generate(random);
1195 tmpbuf = bprintf("%s%d", random_id, i);
1196 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1201 XBT_CRITICAL("Malformed radical");
1204 res = random_generate(random);
1205 rd_name = bprintf("%s_router", random_id);
1206 rd_value = bprintf("%f", res);
1207 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1209 xbt_dynar_free(&radical_ends);
1212 xbt_dynar_free(&radical_elements);
1216 void routing_register_callbacks()
1218 sg_platf_host_add_cb(parse_S_host);
1219 sg_platf_router_add_cb(parse_S_router);
1220 sg_platf_host_link_add_cb(parse_S_host_link);
1221 sg_platf_route_add_cb(parse_E_route);
1222 sg_platf_ASroute_add_cb(parse_E_ASroute);
1223 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1224 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1226 sg_platf_cluster_add_cb(routing_parse_cluster);
1227 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1229 sg_platf_peer_add_cb(routing_parse_peer);
1230 sg_platf_postparse_add_cb(routing_parse_postparse);
1232 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1233 sg_platf_AS_end_add_cb(routing_AS_end);
1234 sg_platf_AS_begin_add_cb(routing_AS_begin);
1236 sg_platf_trace_add_cb(routing_parse_trace);
1237 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1240 instr_routing_define_callbacks();
1245 * \brief Recursive function for finalize
1247 * \param rc the source host name
1249 * This fuction is call by "finalize". It allow to finalize the
1250 * AS or routing components. It delete all the structures.
1252 static void finalize_rec(AsPtr as) {
1253 xbt_dict_cursor_t cursor = NULL;
1257 xbt_dict_foreach(as->p_routingSons, cursor, key, elem) {
1264 /** \brief Frees all memory allocated by the routing module */
1265 void routing_exit(void) {
1268 xbt_dynar_free(&routing_platf->p_lastRoute);
1269 finalize_rec(routing_platf->p_root);
1270 xbt_free(routing_platf);
1273 AS_t surf_AS_get_routing_root() {
1274 return routing_platf->p_root;
1277 const char *surf_AS_get_name(AsPtr as) {
1281 xbt_dict_t surf_AS_get_routing_sons(AsPtr as) {
1282 return as->p_routingSons;
1285 const char *surf_AS_get_model(AsPtr as) {
1286 return as->p_modelDesc->name;
1289 xbt_dynar_t surf_AS_get_hosts(AsPtr as) {
1290 xbt_dynar_t elms = as->p_indexNetworkElm;
1291 sg_routing_edge_t relm;
1294 int count = xbt_dynar_length(elms);
1295 xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_dictelm_t), NULL);
1296 for (index = 0; index < count; index++) {
1297 relm = xbt_dynar_get_as(elms, index, RoutingEdgePtr);
1298 delm = xbt_lib_get_elm_or_null(host_lib, relm->p_name);
1300 xbt_dynar_push(res, &delm);
1306 void surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) {
1307 as->getGraph(graph, nodes, edges);