1 #include "surf_routing.hpp"
2 #include "surf_routing_private.hpp"
3 #include "surf/surfxml_parse_values.h"
4 #include "surf/random_mgr.h"
7 * @ingroup SURF_build_api
8 * @brief A library containing all known workstations
12 int ROUTING_HOST_LEVEL; //Routing level
13 int SURF_CPU_LEVEL; //Surf cpu level
14 int SURF_WKS_LEVEL; //Surf workstation level
15 int SIMIX_HOST_LEVEL; //Simix level
16 int MSG_HOST_LEVEL; //Msg level
17 int SD_HOST_LEVEL; //Simdag level
18 int COORD_HOST_LEVEL=0; //Coordinates level
19 int NS3_HOST_LEVEL; //host node for ns3
21 xbt_dict_t watched_hosts_lib;
24 * @ingroup SURF_build_api
25 * @brief A library containing all known links
28 int SD_LINK_LEVEL; //Simdag level
29 int SURF_LINK_LEVEL; //Surf level
30 int NS3_LINK_LEVEL; //link for ns3
32 xbt_lib_t as_router_lib;
33 int ROUTING_ASR_LEVEL; //Routing level
34 int COORD_ASR_LEVEL; //Coordinates level
35 int NS3_ASR_LEVEL; //host node for ns3
36 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
38 static xbt_dict_t random_value = NULL;
41 /** @brief Retrieve a routing edge from its name
43 * Routing edges are either CPU/workstation and routers, whatever
45 RoutingEdgePtr sg_routing_edge_by_name_or_null(const char *name) {
46 RoutingEdgePtr net_elm = (RoutingEdgePtr) xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL);
48 net_elm = (RoutingEdgePtr) xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
53 RoutingPlatfPtr routing_platf = NULL;
54 AsPtr current_routing = NULL;
56 /* global parse functions */
57 extern xbt_dynar_t mount_list;
60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
63 static void routing_parse_peer(sg_platf_peer_cbarg_t peer); /* peer bypass */
64 static void routing_parse_Srandom(void); /* random bypass */
66 static void routing_parse_postparse(void);
68 /* this lines are only for replace use like index in the model table */
73 SURF_MODEL_DIJKSTRACACHE,
79 struct s_model_type routing_models[] = {
81 "Full routing data (fast, large memory requirements, fully expressive)",
82 model_full_create, model_full_end},
84 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
85 model_floyd_create, model_floyd_end},
87 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
88 model_dijkstra_create, model_dijkstra_both_end},
90 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
91 model_dijkstracache_create, model_dijkstra_both_end},
92 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
93 model_none_create, NULL},
94 {"Vivaldi", "Vivaldi routing",
95 model_vivaldi_create, NULL},
96 {"Cluster", "Cluster routing",
97 model_cluster_create, NULL},
98 {NULL, NULL, NULL, NULL}
102 * \brief Add a "host_link" to the network element list
104 static void parse_S_host_link(sg_platf_host_link_cbarg_t host)
106 RoutingEdgePtr info = static_cast<RoutingEdgePtr>(xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL));
107 xbt_assert(info, "Host '%s' not found!", host->id);
108 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER] ||
109 current_routing->p_modelDesc == &routing_models[SURF_MODEL_VIVALDI],
110 "You have to be in model Cluster to use tag host_link!");
112 s_surf_parsing_link_up_down_t link_up_down;
113 link_up_down.link_up = xbt_lib_get_or_null(link_lib, host->link_up, SURF_LINK_LEVEL);
114 link_up_down.link_down = xbt_lib_get_or_null(link_lib, host->link_down, SURF_LINK_LEVEL);
115 link_up_down.limiter_link = NULL;
116 link_up_down.loopback_link = NULL;
118 xbt_assert(link_up_down.link_up, "Link '%s' not found!",host->link_up);
119 xbt_assert(link_up_down.link_down, "Link '%s' not found!",host->link_down);
121 if(!current_routing->p_linkUpDownList)
122 current_routing->p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
124 // If dynar is is greater than edge id and if the host_link is already defined
125 if(xbt_dynar_length(current_routing->p_linkUpDownList) > info->m_id &&
126 xbt_dynar_get_as(current_routing->p_linkUpDownList, info->m_id, void*))
127 xbt_die("Host_link for '%s' is already defined!",host->id);
129 XBT_DEBUG("Push Host_link for host '%s' to position %d", info->p_name, info->m_id);
130 xbt_dynar_set_as(current_routing->p_linkUpDownList, info->m_id, s_surf_parsing_link_up_down_t, link_up_down);
134 * \brief Add a "host" to the network element list
136 static void parse_S_host(sg_platf_host_cbarg_t host)
138 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
139 current_routing->p_hierarchy = SURF_ROUTING_BASE;
140 xbt_assert(!xbt_lib_get_or_null(host_lib, host->id, ROUTING_HOST_LEVEL),
141 "Reading a host, processing unit \"%s\" already exists", host->id);
143 RoutingEdgePtr info = new RoutingEdge();
144 info->p_rcComponent = current_routing;
145 info->p_rcType = SURF_NETWORK_ELEMENT_HOST;
146 info->p_name = xbt_strdup(host->id);
147 info->m_id = current_routing->parsePU(info);
148 xbt_lib_set(host_lib, host->id, ROUTING_HOST_LEVEL, (void *) info);
149 XBT_DEBUG("Having set name '%s' id '%d'", host->id, info->m_id);
152 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
156 if (host->coord && strcmp(host->coord, "")) {
160 if (!COORD_HOST_LEVEL)
161 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
162 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
163 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
164 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
165 xbt_dynar_foreach(ctn_str,cursor, str) {
166 double val = atof(str);
167 xbt_dynar_push(ctn,&val);
169 xbt_dynar_shrink(ctn, 0);
170 xbt_dynar_free(&ctn_str);
171 xbt_lib_set(host_lib, host->id, COORD_HOST_LEVEL, (void *) ctn);
172 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
177 * \brief Add a "router" to the network element list
179 static void parse_S_router(sg_platf_router_cbarg_t router)
181 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
182 current_routing->p_hierarchy = SURF_ROUTING_BASE;
183 xbt_assert(!xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
184 "Reading a router, processing unit \"%s\" already exists",
187 RoutingEdgePtr info = new RoutingEdge();
188 info->p_rcComponent = current_routing;
189 info->p_rcType = SURF_NETWORK_ELEMENT_ROUTER;
190 info->p_name = xbt_strdup(router->id);
191 info->m_id = current_routing->parsePU(info);
192 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, (void *) info);
193 XBT_DEBUG("Having set name '%s' id '%d'", router->id, info->m_id);
195 if (router->coord && strcmp(router->coord, "")) {
199 if (!COORD_ASR_LEVEL)
200 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
201 /* Pre-parse the host coordinates */
202 xbt_dynar_t ctn_str = xbt_str_split_str(router->coord, " ");
203 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
204 xbt_dynar_foreach(ctn_str,cursor, str) {
205 double val = atof(str);
206 xbt_dynar_push(ctn,&val);
208 xbt_dynar_shrink(ctn, 0);
209 xbt_dynar_free(&ctn_str);
210 xbt_lib_set(as_router_lib, router->id, COORD_ASR_LEVEL, (void *) ctn);
211 XBT_DEBUG("Having set router coordinates for '%s'",router->id);
216 * \brief Store the route by calling the set_route function of the current routing component
218 static void parse_E_route(sg_platf_route_cbarg_t route)
220 /*FIXME:REMOVE:xbt_assert(current_routing->parse_route,
221 "no defined method \"set_route\" in \"%s\"",
222 current_routing->name);*/
224 current_routing->parseRoute(route);
228 * \brief Store the ASroute by calling the set_ASroute function of the current routing component
230 static void parse_E_ASroute(sg_platf_route_cbarg_t ASroute)
232 /*FIXME:REMOVE:xbt_assert(current_routing->parse_ASroute,
233 "no defined method \"set_ASroute\" in \"%s\"",
234 current_routing->name);*/
235 current_routing->parseASroute(ASroute);
239 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
241 static void parse_E_bypassRoute(sg_platf_route_cbarg_t route)
243 /*FIXME:REMOVE:xbt_assert(current_routing->parse_bypassroute,
244 "Bypassing mechanism not implemented by routing '%s'",
245 current_routing->name);*/
247 current_routing->parseBypassroute(route);
251 * \brief Store the bypass route by calling the set_bypassroute function of the current routing component
253 static void parse_E_bypassASroute(sg_platf_route_cbarg_t ASroute)
255 /*FIXME:REMOVE:xbt_assert(current_routing->parse_bypassroute,
256 "Bypassing mechanism not implemented by routing '%s'",
257 current_routing->name);*/
258 current_routing->parseBypassroute(ASroute);
261 static void routing_parse_trace(sg_platf_trace_cbarg_t trace)
263 tmgr_trace_t tmgr_trace;
264 if (!trace->file || strcmp(trace->file, "") != 0) {
265 tmgr_trace = tmgr_trace_new_from_file(trace->file);
266 } else if (strcmp(trace->pc_data, "") == 0) {
270 tmgr_trace_new_from_string(trace->id, trace->pc_data,
273 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
276 static void routing_parse_trace_connect(sg_platf_trace_connect_cbarg_t trace_connect)
278 xbt_assert(xbt_dict_get_or_null
279 (traces_set_list, trace_connect->trace),
280 "Cannot connect trace %s to %s: trace unknown",
281 trace_connect->trace,
282 trace_connect->element);
284 switch (trace_connect->kind) {
285 case SURF_TRACE_CONNECT_KIND_HOST_AVAIL:
286 xbt_dict_set(trace_connect_list_host_avail,
287 trace_connect->trace,
288 xbt_strdup(trace_connect->element), NULL);
290 case SURF_TRACE_CONNECT_KIND_POWER:
291 xbt_dict_set(trace_connect_list_power, trace_connect->trace,
292 xbt_strdup(trace_connect->element), NULL);
294 case SURF_TRACE_CONNECT_KIND_LINK_AVAIL:
295 xbt_dict_set(trace_connect_list_link_avail,
296 trace_connect->trace,
297 xbt_strdup(trace_connect->element), NULL);
299 case SURF_TRACE_CONNECT_KIND_BANDWIDTH:
300 xbt_dict_set(trace_connect_list_bandwidth,
301 trace_connect->trace,
302 xbt_strdup(trace_connect->element), NULL);
304 case SURF_TRACE_CONNECT_KIND_LATENCY:
305 xbt_dict_set(trace_connect_list_latency, trace_connect->trace,
306 xbt_strdup(trace_connect->element), NULL);
309 xbt_die("Cannot connect trace %s to %s: kind of trace unknown",
310 trace_connect->trace, trace_connect->element);
315 extern int _sg_init_status; /* yay, this is an horrible hack */
318 * \brief Make a new routing component to the platform
320 * Add a new autonomous system to the platform. Any elements (such as host,
321 * router or sub-AS) added after this call and before the corresponding call
322 * to sg_platf_new_AS_close() will be added to this AS.
324 * Once this function was called, the configuration concerning the used
325 * models cannot be changed anymore.
327 * @param AS_id name of this autonomous system. Must be unique in the platform
328 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
330 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
332 XBT_DEBUG("routing_AS_begin");
333 routing_model_description_t model = NULL;
335 xbt_assert(!xbt_lib_get_or_null
336 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
337 "The AS \"%s\" already exists", AS->id);
339 _sg_init_status = 2; /* horrible hack: direct access to the global controlling the level of configuration to prevent any further config */
341 /* search the routing model */
343 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
344 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
345 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
346 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
347 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
348 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
349 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
350 default: xbt_die("Not a valid model!!!");
354 /* make a new routing component */
355 AsPtr new_as = model->create();
357 new_as->p_modelDesc = model;
358 new_as->p_hierarchy = SURF_ROUTING_NULL;
359 new_as->p_name = xbt_strdup(AS->id);
361 RoutingEdgePtr info = new RoutingEdge();
363 if (current_routing == NULL && routing_platf->p_root == NULL) {
365 /* it is the first one */
366 new_as->p_routingFather = NULL;
367 routing_platf->p_root = new_as;
369 } else if (current_routing != NULL && routing_platf->p_root != NULL) {
371 xbt_assert(!xbt_dict_get_or_null
372 (current_routing->p_routingSons, AS->id),
373 "The AS \"%s\" already exists", AS->id);
374 /* it is a part of the tree */
375 new_as->p_routingFather = current_routing;
376 /* set the father behavior */
377 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
378 current_routing->p_hierarchy = SURF_ROUTING_RECURSIVE;
379 /* add to the sons dictionary */
380 xbt_dict_set(current_routing->p_routingSons, AS->id,
381 (void *) new_as, NULL);
382 /* add to the father element list */
383 info->m_id = current_routing->parseAS(info);
385 THROWF(arg_error, 0, "All defined components must be belong to a AS");
388 info->p_rcComponent = new_as->p_routingFather;
389 info->p_rcType = SURF_NETWORK_ELEMENT_AS;
390 info->p_name = new_as->p_name;
392 xbt_lib_set(as_router_lib, info->p_name, ROUTING_ASR_LEVEL,
394 XBT_DEBUG("Having set name '%s' id '%d'", new_as->p_name, info->m_id);
396 /* set the new current component of the tree */
397 current_routing = new_as;
398 current_routing->p_netElem = info;
403 * \brief Specify that the current description of AS is finished
405 * Once you've declared all the content of your AS, you have to close
406 * it with this call. Your AS is not usable until you call this function.
408 * @fixme: this call is not as robust as wanted: bad things WILL happen
409 * if you call it twice for the same AS, or if you forget calling it, or
410 * even if you add stuff to a closed AS
413 void routing_AS_end(sg_platf_AS_cbarg_t AS)
416 if (current_routing == NULL) {
417 THROWF(arg_error, 0, "Close an AS, but none was under construction");
419 if (current_routing->p_modelDesc->end)
420 current_routing->p_modelDesc->end(current_routing);
421 current_routing = current_routing->p_routingFather;
425 /* Aux Business methods */
428 * \brief Get the AS father and the first elements of the chain
430 * \param src the source host name
431 * \param dst the destination host name
433 * Get the common father of the to processing units, and the first different
434 * father in the chain
436 static void elements_father(sg_routing_edge_t src, sg_routing_edge_t dst,
441 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
442 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
443 AsPtr src_as, dst_as;
444 AsPtr path_src[ELEMENTS_FATHER_MAXDEPTH];
445 AsPtr path_dst[ELEMENTS_FATHER_MAXDEPTH];
453 /* (1) find the as where the src and dst are located */
454 sg_routing_edge_t src_data = src;
455 sg_routing_edge_t dst_data = dst;
456 src_as = src_data->p_rcComponent;
457 dst_as = dst_data->p_rcComponent;
459 char* src_name = src_data->p_name;
460 char* dst_name = dst_data->p_name;
463 xbt_assert(src_as && dst_as,
464 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
466 /* (2) find the path to the root routing component */
467 for (current = src_as; current != NULL; current = current->p_routingFather) {
468 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
469 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
470 path_src[index_src++] = current;
472 for (current = dst_as; current != NULL; current = current->p_routingFather) {
473 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
474 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
475 path_dst[index_dst++] = current;
478 /* (3) find the common father */
480 current_src = path_src[--index_src];
481 current_dst = path_dst[--index_dst];
482 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
484 /* (4) they are not in the same routing component, make the path */
485 if (current_src == current_dst)
486 father = current_src;
488 father = path_src[index_src + 1];
490 /* (5) result generation */
491 *res_father = father; /* first the common father of src and dst */
492 *res_src = current_src; /* second the first different father of src */
493 *res_dst = current_dst; /* three the first different father of dst */
495 #undef ELEMENTS_FATHER_MAXDEPTH
498 /* Global Business methods */
501 * \brief Recursive function for get_route_latency
503 * \param src the source host name
504 * \param dst the destination host name
505 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
506 * \param *latency the latency, if needed
508 * This function is called by "get_route" and "get_latency". It allows to walk
509 * recursively through the ASes tree.
511 static void _get_route_and_latency(RoutingEdgePtr src, RoutingEdgePtr dst,
512 xbt_dynar_t * links, double *latency)
514 s_sg_platf_route_cbarg_t route;
515 memset(&route,0,sizeof(route));
517 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
518 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->p_name, dst->p_name);
520 /* Find how src and dst are interconnected */
521 AsPtr common_father, src_father, dst_father;
522 elements_father(src, dst, &common_father, &src_father, &dst_father);
523 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
524 common_father->p_name, src_father->p_name, dst_father->p_name);
526 /* Check whether a direct bypass is defined */
527 sg_platf_route_cbarg_t e_route_bypass = NULL;
528 //FIXME:REMOVE:if (common_father->get_bypass_route)
530 e_route_bypass = common_father->getBypassRoute(src, dst, latency);
532 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
533 if (e_route_bypass) {
534 xbt_dynar_merge(links, &e_route_bypass->link_list);
535 //FIXME:generic_free_route(e_route_bypass);
539 /* If src and dst are in the same AS, life is good */
540 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
541 route.link_list = *links;
542 common_father->getRouteAndLatency(src, dst, &route, latency);
543 // if vivaldi latency+=vivaldi(src,dst)
547 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
549 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
550 // Find the net_card corresponding to father
551 RoutingEdgePtr src_father_net_elm = src_father->p_netElem;
552 RoutingEdgePtr dst_father_net_elm = dst_father->p_netElem;
554 common_father->getRouteAndLatency(src_father_net_elm, dst_father_net_elm,
557 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
558 "bad gateways for route from \"%s\" to \"%s\"", src->p_name, dst->p_name);
560 sg_routing_edge_t src_gateway_net_elm = route.gw_src;
561 sg_routing_edge_t dst_gateway_net_elm = route.gw_dst;
563 /* If source gateway is not our source, we have to recursively find our way up to this point */
564 if (src != src_gateway_net_elm)
565 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
566 xbt_dynar_merge(links, &route.link_list);
568 /* If dest gateway is not our destination, we have to recursively find our way from this point */
569 if (dst_gateway_net_elm != dst)
570 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
572 // if vivaldi latency+=vivaldi(src_gateway,dst_gateway)
575 AS_t surf_platf_get_root(routing_platf_t platf){
576 return platf->p_root;
579 e_surf_network_element_type_t surf_routing_edge_get_rc_type(sg_routing_edge_t edge){
580 return edge->p_rcType;
585 * \brief Find a route between hosts
587 * \param src the network_element_t for src host
588 * \param dst the network_element_t for dst host
589 * \param route where to store the list of links.
590 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
591 * \param latency where to store the latency experienced on the path (or NULL if not interested)
592 * It is the caller responsability to initialize latency to 0 (we add to provided route)
595 * walk through the routing components tree and find a route between hosts
596 * by calling the differents "get_route" functions in each routing component.
598 void RoutingPlatf::getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst,
599 xbt_dynar_t* route, double *latency)
601 XBT_DEBUG("routing_get_route_and_latency from %s to %s", src->p_name, dst->p_name);
603 xbt_dynar_reset(routing_platf->p_lastRoute);
604 *route = routing_platf->p_lastRoute;
607 _get_route_and_latency(src, dst, route, latency);
609 xbt_assert(!latency || *latency >= 0.0,
610 "negative latency on route between \"%s\" and \"%s\"", src->p_name, dst->p_name);
613 xbt_dynar_t RoutingPlatf::getOneLinkRoutes(){
614 return recursiveGetOneLinkRoutes(p_root);
617 xbt_dynar_t RoutingPlatf::recursiveGetOneLinkRoutes(AsPtr rc)
619 xbt_dynar_t ret = xbt_dynar_new(sizeof(OnelinkPtr), xbt_free);
621 //adding my one link routes
622 xbt_dynar_t onelink_mine = rc->getOneLinkRoutes();
624 xbt_dynar_merge(&ret,&onelink_mine);
628 xbt_dict_cursor_t cursor = NULL;
630 xbt_dict_foreach(rc->p_routingSons, cursor, key, rc_child) {
631 xbt_dynar_t onelink_child = recursiveGetOneLinkRoutes(rc_child);
633 xbt_dynar_merge(&ret,&onelink_child);
638 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
640 RoutingEdgePtr rc = sg_routing_edge_by_name_or_null(name);
644 return SURF_NETWORK_ELEMENT_NULL;
648 * \brief Generic method: create the global routing schema
650 * Make a global routing structure and set all the parsing functions.
652 void routing_model_create( void *loopback)
654 /* config the uniq global routing */
655 routing_platf = new RoutingPlatf();
656 routing_platf->p_root = NULL;
657 routing_platf->p_loopback = loopback;
658 routing_platf->p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
659 /* no current routing at moment */
660 current_routing = NULL;
664 /* ************************************************** */
665 /* ********** PATERN FOR NEW ROUTING **************** */
667 /* The minimal configuration of a new routing model need the next functions,
668 * also you need to set at the start of the file, the new model in the model
669 * list. Remember keep the null ending of the list.
671 /*** Routing model structure ***/
673 // s_routing_component_t generic_routing;
674 // /* things that your routing model need */
675 // } s_routing_component_NEW_t,*routing_component_NEW_t;
677 /*** Parse routing model functions ***/
678 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
679 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
680 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
681 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
682 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
684 /*** Business methods ***/
685 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
686 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
687 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
689 /*** Creation routing model functions ***/
690 // static void* model_NEW_create(void) {
691 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
692 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
693 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
694 // new_component->generic_routing.set_route = model_NEW_set_route;
695 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
696 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
697 // new_component->generic_routing.get_route = NEW_get_route;
698 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
699 // new_component->generic_routing.finalize = NEW_finalize;
700 // /* initialization of internal structures */
701 // return new_component;
703 // static void model_NEW_load(void) {} /* mandatory */
704 // static void model_NEW_unload(void) {} /* mandatory */
705 // static void model_NEW_end(void) {} /* mandatory */
707 /* ************************************************************************** */
708 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
710 void routing_cluster_add_backbone(void* bb) {
711 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER],
712 "You have to be in model Cluster to use tag backbone!");
713 xbt_assert(!surf_as_cluster_get_backbone(current_routing), "The backbone link is already defined!");
714 surf_as_cluster_set_backbone(current_routing, bb);
715 XBT_DEBUG("Add a backbone to AS '%s'", current_routing->p_name);
718 static void routing_parse_cabinet(sg_platf_cabinet_cbarg_t cabinet)
721 char *groups , *host_id , *link_id = NULL;
723 xbt_dynar_t radical_elements;
724 xbt_dynar_t radical_ends;
727 radical_elements = xbt_str_split(cabinet->radical, ",");
728 xbt_dynar_foreach(radical_elements, iter, groups) {
730 radical_ends = xbt_str_split(groups, "-");
731 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
733 switch (xbt_dynar_length(radical_ends)) {
738 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
741 surf_parse_error("Malformed radical");
744 s_sg_platf_host_cbarg_t host;
745 memset(&host, 0, sizeof(host));
746 host.initial_state = SURF_RESOURCE_ON;
747 host.power_peak = cabinet->power;
748 host.power_scale = 1.0;
749 host.core_amount = 1;
751 s_sg_platf_link_cbarg_t link;
752 memset(&link, 0, sizeof(link));
753 link.state = SURF_RESOURCE_ON;
754 link.policy = SURF_LINK_FULLDUPLEX;
755 link.latency = cabinet->lat;
756 link.bandwidth = cabinet->bw;
758 s_sg_platf_host_link_cbarg_t host_link;
759 memset(&host_link, 0, sizeof(host_link));
761 for (i = start; i <= end; i++) {
762 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
763 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
766 sg_platf_new_host(&host);
767 sg_platf_new_link(&link);
769 char* link_up = bprintf("%s_UP",link_id);
770 char* link_down = bprintf("%s_DOWN",link_id);
771 host_link.id = host_id;
772 host_link.link_up = link_up;
773 host_link.link_down= link_down;
774 sg_platf_new_host_link(&host_link);
782 xbt_dynar_free(&radical_ends);
784 xbt_dynar_free(&radical_elements);
787 static void routing_parse_cluster(sg_platf_cluster_cbarg_t cluster)
789 char *host_id, *groups, *link_id = NULL;
790 xbt_dict_t patterns = NULL;
792 s_sg_platf_host_cbarg_t host;
793 s_sg_platf_link_cbarg_t link;
797 xbt_dynar_t radical_elements;
798 xbt_dynar_t radical_ends;
800 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
801 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
802 patterns = xbt_dict_new_homogeneous(xbt_free_f);
803 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
804 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
805 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
808 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
809 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
811 AS.routing = A_surfxml_AS_routing_Cluster;
812 sg_platf_new_AS_begin(&AS);
814 current_routing->p_linkUpDownList
815 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
818 radical_elements = xbt_str_split(cluster->radical, ",");
819 xbt_dynar_foreach(radical_elements, iter, groups) {
821 radical_ends = xbt_str_split(groups, "-");
822 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
824 switch (xbt_dynar_length(radical_ends)) {
829 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
832 surf_parse_error("Malformed radical");
835 for (i = start; i <= end; i++) {
837 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
838 link_id = bprintf("%s_link_%d", cluster->id, i);
840 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->power);
842 memset(&host, 0, sizeof(host));
844 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
845 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
846 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
847 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
848 host.power_trace = tmgr_trace_new_from_file(avail_file);
849 xbt_free(avail_file);
851 XBT_DEBUG("\tavailability_file=\"\"");
854 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
855 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
856 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
857 host.state_trace = tmgr_trace_new_from_file(avail_file);
858 xbt_free(avail_file);
860 XBT_DEBUG("\tstate_file=\"\"");
863 host.power_peak = cluster->power;
864 host.power_scale = 1.0;
865 host.core_amount = cluster->core_amount;
866 host.initial_state = SURF_RESOURCE_ON;
868 sg_platf_new_host(&host);
869 XBT_DEBUG("</host>");
871 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
872 cluster->bw, cluster->lat);
874 memset(&link, 0, sizeof(link));
876 link.bandwidth = cluster->bw;
877 link.latency = cluster->lat;
878 link.state = SURF_RESOURCE_ON;
879 link.policy = cluster->sharing_policy;
880 sg_platf_new_link(&link);
882 s_surf_parsing_link_up_down_t info;
884 if (link.policy == SURF_LINK_FULLDUPLEX) {
885 char *tmp_link = bprintf("%s_UP", link_id);
887 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
889 tmp_link = bprintf("%s_DOWN", link_id);
891 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
894 info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
895 info.link_down = info.link_up;
898 if(cluster->limiter_link!=0){
899 char *tmp_link = bprintf("%s_limiter", link_id);
900 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
901 cluster->limiter_link);
904 memset(&link, 0, sizeof(link));
906 link.bandwidth = cluster->limiter_link;
908 link.state = SURF_RESOURCE_ON;
909 link.policy = SURF_LINK_SHARED;
910 sg_platf_new_link(&link);
912 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
915 info.limiter_link =NULL;
918 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
919 char *tmp_link = bprintf("%s_loopback", link_id);
920 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
921 cluster->limiter_link);
924 memset(&link, 0, sizeof(link));
926 link.bandwidth = cluster->loopback_bw;
927 link.latency = cluster->loopback_lat;
928 link.state = SURF_RESOURCE_ON;
929 link.policy = SURF_LINK_FATPIPE;
930 sg_platf_new_link(&link);
932 xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
935 info.loopback_link =NULL;
938 xbt_dynar_push(current_routing->p_linkUpDownList, &info);
943 xbt_dynar_free(&radical_ends);
945 xbt_dynar_free(&radical_elements);
947 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
948 // and it's very useful to connect clusters together
950 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
952 s_sg_platf_router_cbarg_t router;
953 memset(&router, 0, sizeof(router));
954 router.id = cluster->router_id;
956 if (!router.id || !strcmp(router.id, ""))
958 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
960 sg_platf_new_router(&router);
961 ((AsClusterPtr)current_routing)->p_router = (RoutingEdgePtr) xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
965 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
966 char *link_backbone = bprintf("%s_backbone", cluster->id);
967 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
968 cluster->bb_bw, cluster->bb_lat);
970 memset(&link, 0, sizeof(link));
971 link.id = link_backbone;
972 link.bandwidth = cluster->bb_bw;
973 link.latency = cluster->bb_lat;
974 link.state = SURF_RESOURCE_ON;
975 link.policy = cluster->bb_sharing_policy;
977 sg_platf_new_link(&link);
979 routing_cluster_add_backbone(xbt_lib_get_or_null(link_lib, link_backbone, SURF_LINK_LEVEL));
985 sg_platf_new_AS_end();
987 xbt_dict_free(&patterns); // no op if it were never set
990 static void routing_parse_postparse(void) {
991 xbt_dict_free(&random_value);
994 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
996 char *host_id = NULL;
1000 host_id = HOST_PEER(peer->id);
1001 link_id = LINK_PEER(peer->id);
1003 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->power);
1004 s_sg_platf_host_cbarg_t host;
1005 memset(&host, 0, sizeof(host));
1006 host.initial_state = SURF_RESOURCE_ON;
1008 host.power_peak = peer->power;
1009 host.power_scale = 1.0;
1010 host.power_trace = peer->availability_trace;
1011 host.state_trace = peer->state_trace;
1012 host.core_amount = 1;
1013 host.coord = peer->coord;
1014 sg_platf_new_host(&host);
1016 s_sg_platf_link_cbarg_t link;
1017 memset(&link, 0, sizeof(link));
1018 link.state = SURF_RESOURCE_ON;
1019 link.policy = SURF_LINK_SHARED;
1020 link.latency = peer->lat;
1022 char* link_up = bprintf("%s_UP",link_id);
1023 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1024 peer->bw_out, peer->lat);
1026 link.bandwidth = peer->bw_out;
1027 sg_platf_new_link(&link);
1029 char* link_down = bprintf("%s_DOWN",link_id);
1030 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1031 peer->bw_in, peer->lat);
1032 link.id = link_down;
1033 link.bandwidth = peer->bw_in;
1034 sg_platf_new_link(&link);
1036 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1037 s_sg_platf_host_link_cbarg_t host_link;
1038 memset(&host_link, 0, sizeof(host_link));
1039 host_link.id = host_id;
1040 host_link.link_up = link_up;
1041 host_link.link_down= link_down;
1042 sg_platf_new_host_link(&host_link);
1046 //xbt_dynar_free(&tab_elements_num);
1053 static void routing_parse_Srandom(void)
1055 double mean, std, min, max, seed;
1056 char *random_id = A_surfxml_random_id;
1057 char *random_radical = A_surfxml_random_radical;
1058 char *rd_name = NULL;
1060 mean = surf_parse_get_double(A_surfxml_random_mean);
1061 std = surf_parse_get_double(A_surfxml_random_std___deviation);
1062 min = surf_parse_get_double(A_surfxml_random_min);
1063 max = surf_parse_get_double(A_surfxml_random_max);
1064 seed = surf_parse_get_double(A_surfxml_random_seed);
1068 random_data_t random = xbt_new0(s_random_data_t, 1);
1071 xbt_dynar_t radical_elements;
1075 xbt_dynar_t radical_ends;
1077 switch (A_surfxml_random_generator) {
1078 case AU_surfxml_random_generator:
1079 case A_surfxml_random_generator_NONE:
1080 random->generator = NONE;
1082 case A_surfxml_random_generator_DRAND48:
1083 random->generator = DRAND48;
1085 case A_surfxml_random_generator_RAND:
1086 random->generator = RAND;
1088 case A_surfxml_random_generator_RNGSTREAM:
1089 random->generator = RNGSTREAM;
1092 surf_parse_error("Invalid random generator");
1095 random->seed = seed;
1099 /* Check user stupidities */
1101 THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1103 THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1105 THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1107 /* normalize the mean and standard deviation before storing */
1108 random->mean = (mean - min) / (max - min);
1109 random->std = std / (max - min);
1111 if (random->mean * (1 - random->mean) < random->std * random->std)
1112 THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1113 random->mean, random->std);
1116 ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1117 random_id, random->min, random->max, random->mean, random->std,
1118 (int)random->generator, random->seed, random_radical);
1121 random_value = xbt_dict_new_homogeneous(free);
1123 if (!strcmp(random_radical, "")) {
1124 res = random_generate(random);
1125 rd_value = bprintf("%f", res);
1126 xbt_dict_set(random_value, random_id, rd_value, NULL);
1128 radical_elements = xbt_str_split(random_radical, ",");
1129 xbt_dynar_foreach(radical_elements, iter, groups) {
1130 radical_ends = xbt_str_split(groups, "-");
1131 switch (xbt_dynar_length(radical_ends)) {
1133 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1134 "Custom Random '%s' already exists !", random_id);
1135 res = random_generate(random);
1137 bprintf("%s%d", random_id,
1138 atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1139 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1144 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1145 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1146 for (i = start; i <= end; i++) {
1147 xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1148 "Custom Random '%s' already exists !", bprintf("%s%d",
1151 res = random_generate(random);
1152 tmpbuf = bprintf("%s%d", random_id, i);
1153 xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1158 XBT_CRITICAL("Malformed radical");
1161 res = random_generate(random);
1162 rd_name = bprintf("%s_router", random_id);
1163 rd_value = bprintf("%f", res);
1164 xbt_dict_set(random_value, rd_name, rd_value, NULL);
1166 xbt_dynar_free(&radical_ends);
1169 xbt_dynar_free(&radical_elements);
1173 void routing_register_callbacks()
1175 sg_platf_host_add_cb(parse_S_host);
1176 sg_platf_router_add_cb(parse_S_router);
1177 sg_platf_host_link_add_cb(parse_S_host_link);
1178 sg_platf_route_add_cb(parse_E_route);
1179 sg_platf_ASroute_add_cb(parse_E_ASroute);
1180 sg_platf_bypassRoute_add_cb(parse_E_bypassRoute);
1181 sg_platf_bypassASroute_add_cb(parse_E_bypassASroute);
1183 sg_platf_cluster_add_cb(routing_parse_cluster);
1184 sg_platf_cabinet_add_cb(routing_parse_cabinet);
1186 sg_platf_peer_add_cb(routing_parse_peer);
1187 sg_platf_postparse_add_cb(routing_parse_postparse);
1189 /* we care about the ASes while parsing the platf. Incredible, isnt it? */
1190 sg_platf_AS_end_add_cb(routing_AS_end);
1191 sg_platf_AS_begin_add_cb(routing_AS_begin);
1193 sg_platf_trace_add_cb(routing_parse_trace);
1194 sg_platf_trace_connect_add_cb(routing_parse_trace_connect);
1197 instr_routing_define_callbacks();
1202 * \brief Recursive function for finalize
1204 * \param rc the source host name
1206 * This fuction is call by "finalize". It allow to finalize the
1207 * AS or routing components. It delete all the structures.
1209 static void finalize_rec(AsPtr as) {
1210 xbt_dict_cursor_t cursor = NULL;
1214 xbt_dict_foreach(as->p_routingSons, cursor, key, elem) {
1221 /** \brief Frees all memory allocated by the routing module */
1222 void routing_exit(void) {
1225 xbt_dynar_free(&routing_platf->p_lastRoute);
1226 finalize_rec(routing_platf->p_root);
1227 xbt_free(routing_platf);
1230 AS_t surf_AS_get_routing_root() {
1231 return routing_platf->p_root;
1234 const char *surf_AS_get_name(AsPtr as) {
1238 xbt_dict_t surf_AS_get_routing_sons(AsPtr as) {
1239 return as->p_routingSons;
1242 const char *surf_AS_get_model(AsPtr as) {
1243 return as->p_modelDesc->name;
1246 xbt_dynar_t surf_AS_get_hosts(AsPtr as) {
1247 xbt_dynar_t elms = as->p_indexNetworkElm;
1248 sg_routing_edge_t relm;
1251 int count = xbt_dynar_length(elms);
1252 xbt_dynar_t res = xbt_dynar_new(sizeof(xbt_dictelm_t), NULL);
1253 for (index = 0; index < count; index++) {
1254 relm = xbt_dynar_get_as(elms, index, RoutingEdgePtr);
1255 delm = xbt_lib_get_elm_or_null(host_lib, relm->p_name);
1257 xbt_dynar_push(res, &delm);
1263 void surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) {
1264 as->getGraph(graph, nodes, edges);