1 /* Copyright (c) 2009-2011, 2013-2015. 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"
9 #include "surf_routing_cluster.hpp"
10 #include "surf_routing_cluster_torus.hpp"
11 #include "surf_routing_cluster_fat_tree.hpp"
13 #include "simgrid/platf_interface.h" // platform creation API internal interface
14 #include "simgrid/sg_config.h"
15 #include "storage_interface.hpp"
16 #include "src/surf/platform.hpp"
17 #include "surf/surfxml_parse_values.h"
26 simgrid::xbt::signal<void(simgrid::surf::NetCard*)> netcardCreatedCallbacks;
27 simgrid::xbt::signal<void(simgrid::surf::As*)> asCreatedCallbacks;
33 * @ingroup SURF_build_api
34 * @brief A library containing all known hosts
38 int COORD_HOST_LEVEL=0; //Coordinates level
40 int MSG_FILE_LEVEL; //Msg file level
42 int SIMIX_STORAGE_LEVEL; //Simix storage level
43 int MSG_STORAGE_LEVEL; //Msg storage level
45 xbt_lib_t as_router_lib;
46 int ROUTING_ASR_LEVEL; //Routing level
47 int COORD_ASR_LEVEL; //Coordinates level
48 int NS3_ASR_LEVEL; //host node for ns3
49 int ROUTING_PROP_ASR_LEVEL; //Where the properties are stored
51 static xbt_dict_t random_value = NULL;
54 /** @brief Retrieve a netcard from its name
56 * Netcards are the thing that connect host or routers to the network
58 simgrid::surf::NetCard *sg_netcard_by_name_or_null(const char *name)
60 sg_host_t h = sg_host_by_name(name);
61 simgrid::surf::NetCard *net_elm = h==NULL?NULL: h->pimpl_netcard;
63 net_elm = (simgrid::surf::NetCard*) xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL);
68 simgrid::surf::RoutingPlatf *routing_platf = NULL;
70 /* global parse functions */
71 extern xbt_dynar_t mount_list;
73 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route, surf, "Routing part of surf");
75 /** The current AS in the parsing */
76 static simgrid::surf::As *current_routing = NULL;
77 simgrid::surf::As* routing_get_current()
79 return current_routing;
82 static void routing_parse_postparse(void);
84 /* this lines are only for replace use like index in the model table */
89 SURF_MODEL_DIJKSTRACACHE,
93 SURF_MODEL_TORUS_CLUSTER,
94 SURF_MODEL_FAT_TREE_CLUSTER,
97 struct s_model_type routing_models[] = {
99 "Full routing data (fast, large memory requirements, fully expressive)",
100 model_full_create, model_full_end},
102 "Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only)",
103 model_floyd_create, model_floyd_end},
105 "Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only)",
106 model_dijkstra_create, model_dijkstra_both_end},
108 "Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only)",
109 model_dijkstracache_create, model_dijkstra_both_end},
110 {"none", "No routing (Unless you know what you are doing, avoid using this mode in combination with a non Constant network model).",
111 model_none_create, NULL},
112 {"Vivaldi", "Vivaldi routing",
113 model_vivaldi_create, NULL},
114 {"Cluster", "Cluster routing",
115 model_cluster_create, NULL},
116 {"Torus_Cluster", "Torus Cluster routing",
117 model_torus_cluster_create, NULL},
118 {"Fat_Tree_Cluster", "Fat Tree Cluster routing",
119 model_fat_tree_cluster_create, NULL},
120 {NULL, NULL, NULL, NULL}
124 * \brief Add a netcard connecting an host to the network element list
125 * FIXME: integrate into host constructor
127 void sg_platf_new_netcard(sg_platf_host_link_cbarg_t netcard)
129 simgrid::surf::NetCard *info = sg_host_by_name(netcard->id)->pimpl_netcard;
130 xbt_assert(info, "Host '%s' not found!", netcard->id);
131 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER] ||
132 current_routing->p_modelDesc == &routing_models[SURF_MODEL_VIVALDI],
133 "You have to be in model Cluster to use tag host_link!");
135 s_surf_parsing_link_up_down_t link_up_down;
136 link_up_down.link_up = Link::byName(netcard->link_up);
137 link_up_down.link_down = Link::byName(netcard->link_down);
139 xbt_assert(link_up_down.link_up, "Link '%s' not found!",netcard->link_up);
140 xbt_assert(link_up_down.link_down, "Link '%s' not found!",netcard->link_down);
142 if(!current_routing->p_linkUpDownList)
143 current_routing->p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
145 // If dynar is is greater than netcard id and if the host_link is already defined
146 if((int)xbt_dynar_length(current_routing->p_linkUpDownList) > info->getId() &&
147 xbt_dynar_get_as(current_routing->p_linkUpDownList, info->getId(), void*))
148 surf_parse_error("Host_link for '%s' is already defined!",netcard->id);
150 XBT_DEBUG("Push Host_link for host '%s' to position %d", info->getName(), info->getId());
151 xbt_dynar_set_as(current_routing->p_linkUpDownList, info->getId(), s_surf_parsing_link_up_down_t, link_up_down);
154 void sg_platf_new_trace(sg_platf_trace_cbarg_t trace)
156 tmgr_trace_t tmgr_trace;
157 if (!trace->file || strcmp(trace->file, "") != 0) {
158 tmgr_trace = tmgr_trace_new_from_file(trace->file);
160 xbt_assert(strcmp(trace->pc_data, ""),
161 "Trace '%s' must have either a content, or point to a file on disk.",trace->id);
162 tmgr_trace = tmgr_trace_new_from_string(trace->id, trace->pc_data, trace->periodicity);
164 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
168 * \brief Make a new routing component to the platform
170 * Add a new autonomous system to the platform. Any elements (such as host,
171 * router or sub-AS) added after this call and before the corresponding call
172 * to sg_platf_new_AS_close() will be added to this AS.
174 * Once this function was called, the configuration concerning the used
175 * models cannot be changed anymore.
177 * @param AS_id name of this autonomous system. Must be unique in the platform
178 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
180 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
182 XBT_DEBUG("routing_AS_begin");
183 routing_model_description_t model = NULL;
185 xbt_assert(!xbt_lib_get_or_null
186 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
187 "The AS \"%s\" already exists", AS->id);
189 _sg_cfg_init_status = 2; /* horrible hack: direct access to the global
190 * controlling the level of configuration to prevent
191 * any further config */
193 /* search the routing model */
195 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
196 case A_surfxml_AS_routing_Cluster___torus: model = &routing_models[SURF_MODEL_TORUS_CLUSTER];break;
197 case A_surfxml_AS_routing_Cluster___fat___tree: model = &routing_models[SURF_MODEL_FAT_TREE_CLUSTER];break;
198 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
199 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
200 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
201 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
202 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
203 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
204 default: xbt_die("Not a valid model!!!");
208 /* make a new routing component */
209 simgrid::surf::As *new_as = model->create();
211 new_as->p_modelDesc = model;
212 new_as->p_hierarchy = SURF_ROUTING_NULL;
213 new_as->p_name = xbt_strdup(AS->id);
215 simgrid::surf::NetCard *info =
216 new simgrid::surf::NetCardImpl(xbt_strdup(new_as->p_name),
218 SURF_NETWORK_ELEMENT_AS,
220 if (current_routing == NULL && routing_platf->p_root == NULL) {
222 /* it is the first one */
223 new_as->p_routingFather = NULL;
224 routing_platf->p_root = new_as;
226 } else if (current_routing != NULL && routing_platf->p_root != NULL) {
228 xbt_assert(!xbt_dict_get_or_null
229 (current_routing->p_routingSons, AS->id),
230 "The AS \"%s\" already exists", AS->id);
231 /* it is a part of the tree */
232 new_as->p_routingFather = current_routing;
233 /* set the father behavior */
234 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
235 current_routing->p_hierarchy = SURF_ROUTING_RECURSIVE;
236 /* add to the sons dictionary */
237 xbt_dict_set(current_routing->p_routingSons, AS->id,
238 (void *) new_as, NULL);
239 /* add to the father element list */
240 info->setId(current_routing->parseAS(info));
242 THROWF(arg_error, 0, "All defined components must belong to a AS");
245 xbt_lib_set(as_router_lib, info->getName(), ROUTING_ASR_LEVEL,
247 XBT_DEBUG("Having set name '%s' id '%d'", new_as->p_name, info->getId());
249 /* set the new current component of the tree */
250 current_routing = new_as;
251 current_routing->p_netcard = info;
253 simgrid::surf::netcardCreatedCallbacks(info);
254 simgrid::surf::asCreatedCallbacks(new_as);
258 * \brief Specify that the current description of AS is finished
260 * Once you've declared all the content of your AS, you have to close
261 * it with this call. Your AS is not usable until you call this function.
263 * @fixme: this call is not as robust as wanted: bad things WILL happen
264 * if you call it twice for the same AS, or if you forget calling it, or
265 * even if you add stuff to a closed AS
268 void routing_AS_end()
271 if (current_routing == NULL) {
272 THROWF(arg_error, 0, "Close an AS, but none was under construction");
274 if (current_routing->p_modelDesc->end)
275 current_routing->p_modelDesc->end(current_routing);
276 current_routing = current_routing->p_routingFather;
280 /* Aux Business methods */
283 * \brief Get the AS father and the first elements of the chain
285 * \param src the source host name
286 * \param dst the destination host name
288 * Get the common father of the to processing units, and the first different
289 * father in the chain
291 static void elements_father(sg_netcard_t src, sg_netcard_t dst,
296 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
297 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
298 simgrid::surf::As *src_as, *dst_as;
299 simgrid::surf::As *path_src[ELEMENTS_FATHER_MAXDEPTH];
300 simgrid::surf::As *path_dst[ELEMENTS_FATHER_MAXDEPTH];
303 simgrid::surf::As *current;
304 simgrid::surf::As *current_src;
305 simgrid::surf::As *current_dst;
306 simgrid::surf::As *father;
308 /* (1) find the as where the src and dst are located */
309 sg_netcard_t src_data = src;
310 sg_netcard_t dst_data = dst;
311 src_as = src_data->getRcComponent();
312 dst_as = dst_data->getRcComponent();
314 char* src_name = src_data->getName();
315 char* dst_name = dst_data->getName();
318 xbt_assert(src_as && dst_as,
319 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
321 /* (2) find the path to the root routing component */
322 for (current = src_as; current != NULL; current = current->p_routingFather) {
323 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
324 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
325 path_src[index_src++] = current;
327 for (current = dst_as; current != NULL; current = current->p_routingFather) {
328 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
329 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
330 path_dst[index_dst++] = current;
333 /* (3) find the common father */
335 current_src = path_src[--index_src];
336 current_dst = path_dst[--index_dst];
337 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
339 /* (4) they are not in the same routing component, make the path */
340 if (current_src == current_dst)
341 father = current_src;
343 father = path_src[index_src + 1];
345 /* (5) result generation */
346 *res_father = father; /* first the common father of src and dst */
347 *res_src = current_src; /* second the first different father of src */
348 *res_dst = current_dst; /* three the first different father of dst */
350 #undef ELEMENTS_FATHER_MAXDEPTH
353 /* Global Business methods */
356 * \brief Recursive function for get_route_latency
358 * \param src the source host name
359 * \param dst the destination host name
360 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
361 * \param *latency the latency, if needed
363 * This function is called by "get_route" and "get_latency". It allows to walk
364 * recursively through the ASes tree.
366 static void _get_route_and_latency(
367 simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst,
368 xbt_dynar_t * links, double *latency)
370 s_sg_platf_route_cbarg_t route = SG_PLATF_ROUTE_INITIALIZER;
371 memset(&route,0,sizeof(route));
373 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
374 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->getName(), dst->getName());
376 /* Find how src and dst are interconnected */
377 simgrid::surf::As *common_father, *src_father, *dst_father;
378 elements_father(src, dst, &common_father, &src_father, &dst_father);
379 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
380 common_father->p_name, src_father->p_name, dst_father->p_name);
382 /* Check whether a direct bypass is defined */
383 sg_platf_route_cbarg_t e_route_bypass = NULL;
384 //FIXME:REMOVE:if (common_father->get_bypass_route)
386 e_route_bypass = common_father->getBypassRoute(src, dst, latency);
388 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
389 if (e_route_bypass) {
390 xbt_dynar_merge(links, &e_route_bypass->link_list);
391 generic_free_route(e_route_bypass);
395 /* If src and dst are in the same AS, life is good */
396 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
397 route.link_list = *links;
398 common_father->getRouteAndLatency(src, dst, &route, latency);
399 // if vivaldi latency+=vivaldi(src,dst)
403 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
405 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
406 // Find the net_card corresponding to father
407 simgrid::surf::NetCard *src_father_netcard = src_father->p_netcard;
408 simgrid::surf::NetCard *dst_father_netcard = dst_father->p_netcard;
410 common_father->getRouteAndLatency(src_father_netcard, dst_father_netcard,
413 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
414 "bad gateways for route from \"%s\" to \"%s\"", src->getName(), dst->getName());
416 sg_netcard_t src_gateway_net_elm = route.gw_src;
417 sg_netcard_t dst_gateway_net_elm = route.gw_dst;
419 /* If source gateway is not our source, we have to recursively find our way up to this point */
420 if (src != src_gateway_net_elm)
421 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
422 xbt_dynar_merge(links, &route.link_list);
424 /* If dest gateway is not our destination, we have to recursively find our way from this point */
425 if (dst_gateway_net_elm != dst)
426 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
430 AS_t surf_platf_get_root(routing_platf_t platf){
431 return platf->p_root;
434 e_surf_network_element_type_t surf_routing_edge_get_rc_type(sg_netcard_t netcard){
435 return netcard->getRcType();
442 * \brief Find a route between hosts
444 * \param src the network_element_t for src host
445 * \param dst the network_element_t for dst host
446 * \param route where to store the list of links.
447 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
448 * \param latency where to store the latency experienced on the path (or NULL if not interested)
449 * It is the caller responsability to initialize latency to 0 (we add to provided route)
452 * walk through the routing components tree and find a route between hosts
453 * by calling each "get_route" function in each routing component.
455 void RoutingPlatf::getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t* route, double *latency)
457 XBT_DEBUG("getRouteAndLatency from %s to %s", src->getName(), dst->getName());
458 if (NULL == *route) {
459 xbt_dynar_reset(routing_platf->p_lastRoute);
460 *route = routing_platf->p_lastRoute;
463 _get_route_and_latency(src, dst, route, latency);
465 xbt_assert(!latency || *latency >= 0.0,
466 "negative latency on route between \"%s\" and \"%s\"", src->getName(), dst->getName());
469 xbt_dynar_t RoutingPlatf::getOneLinkRoutes(){
470 return recursiveGetOneLinkRoutes(p_root);
473 xbt_dynar_t RoutingPlatf::recursiveGetOneLinkRoutes(As *rc)
475 xbt_dynar_t ret = xbt_dynar_new(sizeof(Onelink*), xbt_free_f);
477 //adding my one link routes
478 xbt_dynar_t onelink_mine = rc->getOneLinkRoutes();
480 xbt_dynar_merge(&ret,&onelink_mine);
484 xbt_dict_cursor_t cursor = NULL;
486 xbt_dict_foreach(rc->p_routingSons, cursor, key, rc_child) {
487 xbt_dynar_t onelink_child = recursiveGetOneLinkRoutes(rc_child);
489 xbt_dynar_merge(&ret,&onelink_child);
497 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
499 simgrid::surf::NetCard *rc = sg_netcard_by_name_or_null(name);
501 return rc->getRcType();
503 return SURF_NETWORK_ELEMENT_NULL;
507 * \brief Generic method: create the global routing schema
509 * Make a global routing structure and set all the parsing functions.
511 void routing_model_create( void *loopback)
513 /* config the uniq global routing */
514 routing_platf = new simgrid::surf::RoutingPlatf();
515 routing_platf->p_root = NULL;
516 routing_platf->p_loopback = loopback;
517 routing_platf->p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
518 /* no current routing at moment */
519 current_routing = NULL;
523 /* ************************************************** */
524 /* ********** PATERN FOR NEW ROUTING **************** */
526 /* The minimal configuration of a new routing model need the next functions,
527 * also you need to set at the start of the file, the new model in the model
528 * list. Remember keep the null ending of the list.
530 /*** Routing model structure ***/
532 // s_routing_component_t generic_routing;
533 // /* things that your routing model need */
534 // } s_routing_component_NEW_t,*routing_component_NEW_t;
536 /*** Parse routing model functions ***/
537 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
538 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
539 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
540 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
541 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
543 /*** Business methods ***/
544 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
545 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
546 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
548 /*** Creation routing model functions ***/
549 // static void* model_NEW_create(void) {
550 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
551 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
552 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
553 // new_component->generic_routing.set_route = model_NEW_set_route;
554 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
555 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
556 // new_component->generic_routing.get_route = NEW_get_route;
557 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
558 // new_component->generic_routing.finalize = NEW_finalize;
559 // /* initialization of internal structures */
560 // return new_component;
562 // static void model_NEW_load(void) {} /* mandatory */
563 // static void model_NEW_unload(void) {} /* mandatory */
564 // static void model_NEW_end(void) {} /* mandatory */
566 /* ************************************************************************** */
567 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
569 void routing_cluster_add_backbone(void* bb) {
570 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER],
571 "You have to be in model Cluster to use tag backbone!");
572 xbt_assert(!static_cast<simgrid::surf::AsCluster*>(current_routing)->p_backbone, "The backbone link is already defined!");
573 static_cast<simgrid::surf::AsCluster*>(current_routing)->p_backbone =
574 static_cast<simgrid::surf::Link*>(bb);
575 XBT_DEBUG("Add a backbone to AS '%s'", current_routing->p_name);
578 void sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet)
581 char *groups , *host_id , *link_id = NULL;
583 xbt_dynar_t radical_elements;
584 xbt_dynar_t radical_ends;
587 radical_elements = xbt_str_split(cabinet->radical, ",");
588 xbt_dynar_foreach(radical_elements, iter, groups) {
590 radical_ends = xbt_str_split(groups, "-");
591 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
593 switch (xbt_dynar_length(radical_ends)) {
598 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
601 surf_parse_error("Malformed radical");
604 s_sg_platf_host_cbarg_t host = SG_PLATF_HOST_INITIALIZER;
605 memset(&host, 0, sizeof(host));
606 host.initiallyOn = 1;
608 host.speed_scale = 1.0;
609 host.core_amount = 1;
611 s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
612 memset(&link, 0, sizeof(link));
613 link.initiallyOn = 1;
614 link.policy = SURF_LINK_FULLDUPLEX;
615 link.latency = cabinet->lat;
616 link.bandwidth = cabinet->bw;
618 s_sg_platf_host_link_cbarg_t host_link = SG_PLATF_HOST_LINK_INITIALIZER;
619 memset(&host_link, 0, sizeof(host_link));
621 for (i = start; i <= end; i++) {
622 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
623 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
626 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
627 xbt_dynar_push(host.speed_peak,&cabinet->speed);
628 sg_platf_new_host(&host);
629 xbt_dynar_free(&host.speed_peak);
630 sg_platf_new_link(&link);
632 char* link_up = bprintf("%s_UP",link_id);
633 char* link_down = bprintf("%s_DOWN",link_id);
634 host_link.id = host_id;
635 host_link.link_up = link_up;
636 host_link.link_down = link_down;
637 sg_platf_new_netcard(&host_link);
645 xbt_dynar_free(&radical_ends);
647 xbt_dynar_free(&radical_elements);
650 void routing_new_cluster(sg_platf_cluster_cbarg_t cluster)
652 using simgrid::surf::AsCluster;
653 using simgrid::surf::AsClusterTorus;
654 using simgrid::surf::AsClusterFatTree;
656 char *host_id, *groups, *link_id = NULL;
657 xbt_dict_t patterns = NULL;
660 s_sg_platf_host_cbarg_t host = SG_PLATF_HOST_INITIALIZER;
661 s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
665 xbt_dynar_t radical_elements;
666 xbt_dynar_t radical_ends;
668 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
669 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
670 patterns = xbt_dict_new_homogeneous(xbt_free_f);
671 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
672 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
673 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
676 /* Parse the topology attributes.
677 * Nothing to do in a vanilla cluster, but that's another story for torus and flat_trees */
678 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
681 switch (cluster->topology) {
682 case SURF_CLUSTER_TORUS:
683 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Torus_Cluster\">", cluster->id);
684 AS.routing = A_surfxml_AS_routing_Cluster___torus;
686 case SURF_CLUSTER_FAT_TREE:
687 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Fat_Tree_Cluster\">", cluster->id);
688 AS.routing = A_surfxml_AS_routing_Cluster___fat___tree;
691 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
692 AS.routing = A_surfxml_AS_routing_Cluster;
696 sg_platf_new_AS_begin(&AS);
697 static_cast<AsCluster*>(current_routing)->parse_specific_arguments(cluster);
699 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
700 ((AsCluster*)current_routing)->p_nb_links_per_node++;
701 ((AsCluster*)current_routing)->p_has_loopback=1;
704 if(cluster->limiter_link!=0){
705 ((AsCluster*)current_routing)->p_nb_links_per_node++;
706 ((AsCluster*)current_routing)->p_has_limiter=1;
710 current_routing->p_linkUpDownList
711 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
714 radical_elements = xbt_str_split(cluster->radical, ",");
715 xbt_dynar_foreach(radical_elements, iter, groups) {
717 radical_ends = xbt_str_split(groups, "-");
718 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
720 switch (xbt_dynar_length(radical_ends)) {
725 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
728 surf_parse_error("Malformed radical");
731 for (i = start; i <= end; i++) {
733 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
734 link_id = bprintf("%s_link_%d", cluster->id, i);
736 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->speed);
738 memset(&host, 0, sizeof(host));
740 if ((cluster->properties != NULL) && (!xbt_dict_is_empty(cluster->properties))) {
741 xbt_dict_cursor_t cursor=NULL;
743 host.properties = xbt_dict_new();
745 xbt_dict_foreach(cluster->properties,cursor,key,data) {
746 xbt_dict_set(host.properties, key, xbt_strdup(data),free);
749 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
750 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
751 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
752 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
753 host.speed_trace = tmgr_trace_new_from_file(avail_file);
754 xbt_free(avail_file);
756 XBT_DEBUG("\tavailability_file=\"\"");
759 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
760 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
761 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
762 host.state_trace = tmgr_trace_new_from_file(avail_file);
763 xbt_free(avail_file);
765 XBT_DEBUG("\tstate_file=\"\"");
768 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
769 xbt_dynar_push(host.speed_peak,&cluster->speed);
772 //host.power_peak = cluster->power;
773 host.speed_scale = 1.0;
774 host.core_amount = cluster->core_amount;
775 host.initiallyOn = 1;
777 sg_platf_new_host(&host);
778 xbt_dynar_free(&host.speed_peak);
779 XBT_DEBUG("</host>");
781 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
782 cluster->bw, cluster->lat);
785 s_surf_parsing_link_up_down_t info_lim, info_loop;
786 // All links are saved in a matrix;
787 // every row describes a single node; every node
788 // may have multiple links.
789 // the first column may store a link from x to x if p_has_loopback is set
790 // the second column may store a limiter link if p_has_limiter is set
791 // other columns are to store one or more link for the node
793 //add a loopback link
794 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
795 char *tmp_link = bprintf("%s_loopback", link_id);
796 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
797 cluster->limiter_link);
800 memset(&link, 0, sizeof(link));
802 link.bandwidth = cluster->loopback_bw;
803 link.latency = cluster->loopback_lat;
804 link.initiallyOn = 1;
805 link.policy = SURF_LINK_FATPIPE;
806 sg_platf_new_link(&link);
807 info_loop.link_up = Link::byName(tmp_link);
808 info_loop.link_down = info_loop.link_up;
810 xbt_dynar_set(current_routing->p_linkUpDownList,
811 rankId*(static_cast<AsCluster*>(current_routing))->p_nb_links_per_node, &info_loop);
814 //add a limiter link (shared link to account for maximal bandwidth of the node)
815 if(cluster->limiter_link!=0){
816 char *tmp_link = bprintf("%s_limiter", link_id);
817 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
818 cluster->limiter_link);
821 memset(&link, 0, sizeof(link));
823 link.bandwidth = cluster->limiter_link;
825 link.initiallyOn = 1;
826 link.policy = SURF_LINK_SHARED;
827 sg_platf_new_link(&link);
828 info_lim.link_up = Link::byName(tmp_link);
829 info_lim.link_down = info_lim.link_up;
831 auto as_cluster = static_cast<AsCluster*>(current_routing);
832 xbt_dynar_set(current_routing->p_linkUpDownList,
833 rankId*(as_cluster)->p_nb_links_per_node + as_cluster->p_has_loopback ,
839 //call the cluster function that adds the others links
840 if (cluster->topology == SURF_CLUSTER_FAT_TREE) {
841 ((AsClusterFatTree*) current_routing)->addProcessingNode(i);
844 static_cast<AsCluster*>(current_routing)->create_links_for_node(cluster, i, rankId, rankId*
845 static_cast<AsCluster*>(current_routing)->p_nb_links_per_node
846 + static_cast<AsCluster*>(current_routing)->p_has_loopback
847 + static_cast<AsCluster*>(current_routing)->p_has_limiter );
854 xbt_dynar_free(&radical_ends);
856 xbt_dynar_free(&radical_elements);
858 // For fat trees, the links must be created once all nodes have been added
859 if(cluster->topology == SURF_CLUSTER_FAT_TREE) {
860 static_cast<simgrid::surf::AsClusterFatTree*>(current_routing)->create_links();
862 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
863 // and it's very useful to connect clusters together
865 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
867 s_sg_platf_router_cbarg_t router = SG_PLATF_ROUTER_INITIALIZER;
868 memset(&router, 0, sizeof(router));
869 router.id = cluster->router_id;
871 if (!router.id || !strcmp(router.id, ""))
873 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
875 sg_platf_new_router(&router);
876 ((AsCluster*)current_routing)->p_router = (simgrid::surf::NetCard*) xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
880 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
881 char *link_backbone = bprintf("%s_backbone", cluster->id);
882 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
883 cluster->bb_bw, cluster->bb_lat);
885 memset(&link, 0, sizeof(link));
886 link.id = link_backbone;
887 link.bandwidth = cluster->bb_bw;
888 link.latency = cluster->bb_lat;
889 link.initiallyOn = 1;
890 link.policy = cluster->bb_sharing_policy;
892 sg_platf_new_link(&link);
894 routing_cluster_add_backbone(Link::byName(link_backbone));
900 sg_platf_new_AS_end();
902 xbt_dict_free(&patterns); // no op if it were never set
905 static void routing_parse_postparse(void) {
906 xbt_dict_free(&random_value);
909 void sg_platf_new_peer(sg_platf_peer_cbarg_t peer)
911 using simgrid::surf::NetCard;
912 using simgrid::surf::AsCluster;
914 char *host_id = NULL;
915 char *link_id = NULL;
916 char *router_id = NULL;
919 host_id = HOST_PEER(peer->id);
920 link_id = LINK_PEER(peer->id);
921 router_id = ROUTER_PEER(peer->id);
923 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", peer->id);
924 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
926 AS.routing = A_surfxml_AS_routing_Cluster;
927 sg_platf_new_AS_begin(&AS);
929 current_routing->p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
931 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->speed);
932 s_sg_platf_host_cbarg_t host = SG_PLATF_HOST_INITIALIZER;
933 memset(&host, 0, sizeof(host));
934 host.initiallyOn = 1;
937 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
938 xbt_dynar_push(host.speed_peak,&peer->speed);
940 //host.power_peak = peer->power;
941 host.speed_scale = 1.0;
942 host.speed_trace = peer->availability_trace;
943 host.state_trace = peer->state_trace;
944 host.core_amount = 1;
945 sg_platf_new_host(&host);
946 xbt_dynar_free(&host.speed_peak);
948 s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
949 memset(&link, 0, sizeof(link));
950 link.initiallyOn = 1;
951 link.policy = SURF_LINK_SHARED;
952 link.latency = peer->lat;
954 char* link_up = bprintf("%s_UP",link_id);
955 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
956 peer->bw_out, peer->lat);
958 link.bandwidth = peer->bw_out;
959 sg_platf_new_link(&link);
961 char* link_down = bprintf("%s_DOWN",link_id);
962 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
963 peer->bw_in, peer->lat);
965 link.bandwidth = peer->bw_in;
966 sg_platf_new_link(&link);
968 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
969 s_sg_platf_host_link_cbarg_t host_link = SG_PLATF_HOST_LINK_INITIALIZER;
970 memset(&host_link, 0, sizeof(host_link));
971 host_link.id = host_id;
972 host_link.link_up = link_up;
973 host_link.link_down = link_down;
974 sg_platf_new_netcard(&host_link);
976 XBT_DEBUG("<router id=\"%s\"/>", router_id);
977 s_sg_platf_router_cbarg_t router = SG_PLATF_ROUTER_INITIALIZER;
978 memset(&router, 0, sizeof(router));
979 router.id = router_id;
980 router.coord = peer->coord;
981 sg_platf_new_router(&router);
982 static_cast<AsCluster*>(current_routing)->p_router = static_cast<NetCard*>(xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL));
985 sg_platf_new_AS_end();
988 //xbt_dynar_free(&tab_elements_num);
996 // static void routing_parse_Srandom(void)
998 // double mean, std, min, max, seed;
999 // char *random_id = A_surfxml_random_id;
1000 // char *random_radical = A_surfxml_random_radical;
1001 // char *rd_name = NULL;
1003 // mean = surf_parse_get_double(A_surfxml_random_mean);
1004 // std = surf_parse_get_double(A_surfxml_random_std___deviation);
1005 // min = surf_parse_get_double(A_surfxml_random_min);
1006 // max = surf_parse_get_double(A_surfxml_random_max);
1007 // seed = surf_parse_get_double(A_surfxml_random_seed);
1011 // random_data_t random = xbt_new0(s_random_data_t, 1);
1014 // xbt_dynar_t radical_elements;
1015 // unsigned int iter;
1018 // xbt_dynar_t radical_ends;
1020 // switch (A_surfxml_random_generator) {
1021 // case AU_surfxml_random_generator:
1022 // case A_surfxml_random_generator_NONE:
1023 // random->generator = NONE;
1025 // case A_surfxml_random_generator_DRAND48:
1026 // random->generator = DRAND48;
1028 // case A_surfxml_random_generator_RAND:
1029 // random->generator = RAND;
1031 // case A_surfxml_random_generator_RNGSTREAM:
1032 // random->generator = RNGSTREAM;
1035 // surf_parse_error("Invalid random generator");
1038 // random->seed = seed;
1039 // random->min = min;
1040 // random->max = max;
1042 // /* Check user stupidities */
1044 // THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1046 // THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1048 // THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1050 // /* normalize the mean and standard deviation before storing */
1051 // random->mean = (mean - min) / (max - min);
1052 // random->std = std / (max - min);
1054 // if (random->mean * (1 - random->mean) < random->std * random->std)
1055 // THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1056 // random->mean, random->std);
1059 // ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1060 // random_id, random->min, random->max, random->mean, random->std,
1061 // (int)random->generator, random->seed, random_radical);
1063 // if (!random_value)
1064 // random_value = xbt_dict_new_homogeneous(free);
1066 // if (!strcmp(random_radical, "")) {
1067 // res = random_generate(random);
1068 // rd_value = bprintf("%f", res);
1069 // xbt_dict_set(random_value, random_id, rd_value, NULL);
1071 // radical_elements = xbt_str_split(random_radical, ",");
1072 // xbt_dynar_foreach(radical_elements, iter, groups) {
1073 // radical_ends = xbt_str_split(groups, "-");
1074 // switch (xbt_dynar_length(radical_ends)) {
1076 // xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1077 // "Custom Random '%s' already exists !", random_id);
1078 // res = random_generate(random);
1080 // bprintf("%s%d", random_id,
1081 // atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1082 // xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1083 // xbt_free(tmpbuf);
1087 // start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1088 // end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1089 // for (i = start; i <= end; i++) {
1090 // xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1091 // "Custom Random '%s' already exists !", bprintf("%s%d",
1094 // res = random_generate(random);
1095 // tmpbuf = bprintf("%s%d", random_id, i);
1096 // xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1097 // xbt_free(tmpbuf);
1101 // XBT_CRITICAL("Malformed radical");
1104 // res = random_generate(random);
1105 // rd_name = bprintf("%s_router", random_id);
1106 // rd_value = bprintf("%f", res);
1107 // xbt_dict_set(random_value, rd_name, rd_value, NULL);
1109 // xbt_dynar_free(&radical_ends);
1112 // xbt_dynar_free(&radical_elements);
1116 static void check_disk_attachment()
1118 xbt_lib_cursor_t cursor;
1121 simgrid::surf::NetCard *host_elm;
1122 xbt_lib_foreach(storage_lib, cursor, key, data) {
1123 if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL) != NULL) {
1124 simgrid::surf::Storage *storage = static_cast<simgrid::surf::Storage*>(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL));
1125 host_elm = sg_netcard_by_name_or_null(storage->p_attach);
1127 surf_parse_error("Unable to attach storage %s: host %s doesn't exist.", storage->getName(), storage->p_attach);
1132 void routing_register_callbacks()
1134 simgrid::surf::on_postparse.connect(routing_parse_postparse);
1135 simgrid::surf::on_postparse.connect(check_disk_attachment);
1137 instr_routing_define_callbacks();
1141 * \brief Recursive function for finalize
1143 * \param rc the source host name
1145 * This fuction is call by "finalize". It allow to finalize the
1146 * AS or routing components. It delete all the structures.
1148 static void finalize_rec(simgrid::surf::As *as) {
1149 xbt_dict_cursor_t cursor = NULL;
1153 xbt_dict_foreach(as->p_routingSons, cursor, key, elem) {
1160 /** \brief Frees all memory allocated by the routing module */
1161 void routing_exit(void) {
1162 delete routing_platf;
1168 RoutingPlatf::~RoutingPlatf()
1170 xbt_dynar_free(&p_lastRoute);
1171 finalize_rec(p_root);
1177 AS_t surf_AS_get_routing_root() {
1178 return routing_platf->p_root;
1181 const char *surf_AS_get_name(simgrid::surf::As *as) {
1185 static simgrid::surf::As *surf_AS_recursive_get_by_name(
1186 simgrid::surf::As *current, const char * name)
1188 xbt_dict_cursor_t cursor = NULL;
1191 simgrid::surf::As *tmp = NULL;
1193 if(!strcmp(current->p_name, name))
1196 xbt_dict_foreach(current->p_routingSons, cursor, key, elem) {
1197 tmp = surf_AS_recursive_get_by_name(elem, name);
1205 simgrid::surf::As *surf_AS_get_by_name(const char * name)
1207 simgrid::surf::As *as = surf_AS_recursive_get_by_name(routing_platf->p_root, name);
1209 XBT_WARN("Impossible to find an AS with name %s, please check your input", name);
1213 xbt_dict_t surf_AS_get_routing_sons(simgrid::surf::As *as)
1215 return as->p_routingSons;
1218 const char *surf_AS_get_model(simgrid::surf::As *as)
1220 return as->p_modelDesc->name;
1223 xbt_dynar_t surf_AS_get_hosts(simgrid::surf::As *as)
1225 xbt_dynar_t elms = as->p_indexNetworkElm;
1226 int count = xbt_dynar_length(elms);
1227 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
1228 for (int index = 0; index < count; index++) {
1230 xbt_dynar_get_as(elms, index, simgrid::surf::NetCard*);
1231 sg_host_t delm = simgrid::s4u::Host::by_name_or_null(relm->getName());
1233 xbt_dynar_push(res, &delm);
1239 void surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) {
1240 as->getGraph(graph, nodes, edges);