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);
155 * \brief Add a "host" to the network element list
157 simgrid::surf::NetCard *routing_add_host(
158 simgrid::surf::As* current_routing, sg_platf_host_cbarg_t host)
160 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
161 current_routing->p_hierarchy = SURF_ROUTING_BASE;
162 xbt_assert(!sg_host_by_name(host->id),
163 "Reading a host, processing unit \"%s\" already exists", host->id);
165 simgrid::surf::NetCard *netcard =
166 new simgrid::surf::NetCardImpl(xbt_strdup(host->id),
168 SURF_NETWORK_ELEMENT_HOST,
170 netcard->setId(current_routing->parsePU(netcard));
171 sg_host_t h = sg_host_by_name_or_create(host->id);
172 h->pimpl_netcard = netcard;
173 XBT_DEBUG("Having set name '%s' id '%d'", host->id, netcard->getId());
174 simgrid::surf::netcardCreatedCallbacks(netcard);
177 xbt_lib_set(storage_lib, host->id, ROUTING_STORAGE_HOST_LEVEL, (void *) mount_list);
181 if (host->coord && strcmp(host->coord, "")) {
185 if (!COORD_HOST_LEVEL)
186 xbt_die ("To use host coordinates, please add --cfg=network/coordinates:yes to your command line");
187 /* Pre-parse the host coordinates -- FIXME factorize with routers by overloading the routing->parse_PU function*/
188 xbt_dynar_t ctn_str = xbt_str_split_str(host->coord, " ");
189 xbt_dynar_t ctn = xbt_dynar_new(sizeof(double),NULL);
190 xbt_dynar_foreach(ctn_str,cursor, str) {
191 double val = xbt_str_parse_double(str, "Invalid coordinate: %s");
192 xbt_dynar_push(ctn,&val);
194 xbt_dynar_shrink(ctn, 0);
195 xbt_dynar_free(&ctn_str);
196 h->extension_set(COORD_HOST_LEVEL, (void *) ctn);
197 XBT_DEBUG("Having set host coordinates for '%s'",host->id);
203 void sg_platf_new_trace(sg_platf_trace_cbarg_t trace)
205 tmgr_trace_t tmgr_trace;
206 if (!trace->file || strcmp(trace->file, "") != 0) {
207 tmgr_trace = tmgr_trace_new_from_file(trace->file);
209 xbt_assert(strcmp(trace->pc_data, ""),
210 "Trace '%s' must have either a content, or point to a file on disk.",trace->id);
211 tmgr_trace = tmgr_trace_new_from_string(trace->id, trace->pc_data, trace->periodicity);
213 xbt_dict_set(traces_set_list, trace->id, (void *) tmgr_trace, NULL);
217 * \brief Make a new routing component to the platform
219 * Add a new autonomous system to the platform. Any elements (such as host,
220 * router or sub-AS) added after this call and before the corresponding call
221 * to sg_platf_new_AS_close() will be added to this AS.
223 * Once this function was called, the configuration concerning the used
224 * models cannot be changed anymore.
226 * @param AS_id name of this autonomous system. Must be unique in the platform
227 * @param wanted_routing_type one of Full, Floyd, Dijkstra or similar. Full list in the variable routing_models, in src/surf/surf_routing.c
229 void routing_AS_begin(sg_platf_AS_cbarg_t AS)
231 XBT_DEBUG("routing_AS_begin");
232 routing_model_description_t model = NULL;
234 xbt_assert(!xbt_lib_get_or_null
235 (as_router_lib, AS->id, ROUTING_ASR_LEVEL),
236 "The AS \"%s\" already exists", AS->id);
238 _sg_cfg_init_status = 2; /* horrible hack: direct access to the global
239 * controlling the level of configuration to prevent
240 * any further config */
242 /* search the routing model */
244 case A_surfxml_AS_routing_Cluster: model = &routing_models[SURF_MODEL_CLUSTER];break;
245 case A_surfxml_AS_routing_Cluster___torus: model = &routing_models[SURF_MODEL_TORUS_CLUSTER];break;
246 case A_surfxml_AS_routing_Cluster___fat___tree: model = &routing_models[SURF_MODEL_FAT_TREE_CLUSTER];break;
247 case A_surfxml_AS_routing_Dijkstra: model = &routing_models[SURF_MODEL_DIJKSTRA];break;
248 case A_surfxml_AS_routing_DijkstraCache: model = &routing_models[SURF_MODEL_DIJKSTRACACHE];break;
249 case A_surfxml_AS_routing_Floyd: model = &routing_models[SURF_MODEL_FLOYD];break;
250 case A_surfxml_AS_routing_Full: model = &routing_models[SURF_MODEL_FULL];break;
251 case A_surfxml_AS_routing_None: model = &routing_models[SURF_MODEL_NONE];break;
252 case A_surfxml_AS_routing_Vivaldi: model = &routing_models[SURF_MODEL_VIVALDI];break;
253 default: xbt_die("Not a valid model!!!");
257 /* make a new routing component */
258 simgrid::surf::As *new_as = model->create();
260 new_as->p_modelDesc = model;
261 new_as->p_hierarchy = SURF_ROUTING_NULL;
262 new_as->p_name = xbt_strdup(AS->id);
264 simgrid::surf::NetCard *info =
265 new simgrid::surf::NetCardImpl(xbt_strdup(new_as->p_name),
267 SURF_NETWORK_ELEMENT_AS,
269 if (current_routing == NULL && routing_platf->p_root == NULL) {
271 /* it is the first one */
272 new_as->p_routingFather = NULL;
273 routing_platf->p_root = new_as;
275 } else if (current_routing != NULL && routing_platf->p_root != NULL) {
277 xbt_assert(!xbt_dict_get_or_null
278 (current_routing->p_routingSons, AS->id),
279 "The AS \"%s\" already exists", AS->id);
280 /* it is a part of the tree */
281 new_as->p_routingFather = current_routing;
282 /* set the father behavior */
283 if (current_routing->p_hierarchy == SURF_ROUTING_NULL)
284 current_routing->p_hierarchy = SURF_ROUTING_RECURSIVE;
285 /* add to the sons dictionary */
286 xbt_dict_set(current_routing->p_routingSons, AS->id,
287 (void *) new_as, NULL);
288 /* add to the father element list */
289 info->setId(current_routing->parseAS(info));
291 THROWF(arg_error, 0, "All defined components must belong to a AS");
294 xbt_lib_set(as_router_lib, info->getName(), ROUTING_ASR_LEVEL,
296 XBT_DEBUG("Having set name '%s' id '%d'", new_as->p_name, info->getId());
298 /* set the new current component of the tree */
299 current_routing = new_as;
300 current_routing->p_netcard = info;
302 simgrid::surf::netcardCreatedCallbacks(info);
303 simgrid::surf::asCreatedCallbacks(new_as);
307 * \brief Specify that the current description of AS is finished
309 * Once you've declared all the content of your AS, you have to close
310 * it with this call. Your AS is not usable until you call this function.
312 * @fixme: this call is not as robust as wanted: bad things WILL happen
313 * if you call it twice for the same AS, or if you forget calling it, or
314 * even if you add stuff to a closed AS
317 void routing_AS_end()
320 if (current_routing == NULL) {
321 THROWF(arg_error, 0, "Close an AS, but none was under construction");
323 if (current_routing->p_modelDesc->end)
324 current_routing->p_modelDesc->end(current_routing);
325 current_routing = current_routing->p_routingFather;
329 /* Aux Business methods */
332 * \brief Get the AS father and the first elements of the chain
334 * \param src the source host name
335 * \param dst the destination host name
337 * Get the common father of the to processing units, and the first different
338 * father in the chain
340 static void elements_father(sg_netcard_t src, sg_netcard_t dst,
345 xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
346 #define ELEMENTS_FATHER_MAXDEPTH 16 /* increase if it is not enough */
347 simgrid::surf::As *src_as, *dst_as;
348 simgrid::surf::As *path_src[ELEMENTS_FATHER_MAXDEPTH];
349 simgrid::surf::As *path_dst[ELEMENTS_FATHER_MAXDEPTH];
352 simgrid::surf::As *current;
353 simgrid::surf::As *current_src;
354 simgrid::surf::As *current_dst;
355 simgrid::surf::As *father;
357 /* (1) find the as where the src and dst are located */
358 sg_netcard_t src_data = src;
359 sg_netcard_t dst_data = dst;
360 src_as = src_data->getRcComponent();
361 dst_as = dst_data->getRcComponent();
363 char* src_name = src_data->getName();
364 char* dst_name = dst_data->getName();
367 xbt_assert(src_as && dst_as,
368 "Ask for route \"from\"(%s) or \"to\"(%s) no found", src_name, dst_name);
370 /* (2) find the path to the root routing component */
371 for (current = src_as; current != NULL; current = current->p_routingFather) {
372 if (index_src >= ELEMENTS_FATHER_MAXDEPTH)
373 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_src");
374 path_src[index_src++] = current;
376 for (current = dst_as; current != NULL; current = current->p_routingFather) {
377 if (index_dst >= ELEMENTS_FATHER_MAXDEPTH)
378 xbt_die("ELEMENTS_FATHER_MAXDEPTH should be increased for path_dst");
379 path_dst[index_dst++] = current;
382 /* (3) find the common father */
384 current_src = path_src[--index_src];
385 current_dst = path_dst[--index_dst];
386 } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
388 /* (4) they are not in the same routing component, make the path */
389 if (current_src == current_dst)
390 father = current_src;
392 father = path_src[index_src + 1];
394 /* (5) result generation */
395 *res_father = father; /* first the common father of src and dst */
396 *res_src = current_src; /* second the first different father of src */
397 *res_dst = current_dst; /* three the first different father of dst */
399 #undef ELEMENTS_FATHER_MAXDEPTH
402 /* Global Business methods */
405 * \brief Recursive function for get_route_latency
407 * \param src the source host name
408 * \param dst the destination host name
409 * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
410 * \param *latency the latency, if needed
412 * This function is called by "get_route" and "get_latency". It allows to walk
413 * recursively through the ASes tree.
415 static void _get_route_and_latency(
416 simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst,
417 xbt_dynar_t * links, double *latency)
419 s_sg_platf_route_cbarg_t route = SG_PLATF_ROUTE_INITIALIZER;
420 memset(&route,0,sizeof(route));
422 xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
423 XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->getName(), dst->getName());
425 /* Find how src and dst are interconnected */
426 simgrid::surf::As *common_father, *src_father, *dst_father;
427 elements_father(src, dst, &common_father, &src_father, &dst_father);
428 XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
429 common_father->p_name, src_father->p_name, dst_father->p_name);
431 /* Check whether a direct bypass is defined */
432 sg_platf_route_cbarg_t e_route_bypass = NULL;
433 //FIXME:REMOVE:if (common_father->get_bypass_route)
435 e_route_bypass = common_father->getBypassRoute(src, dst, latency);
437 /* Common ancestor is kind enough to declare a bypass route from src to dst -- use it and bail out */
438 if (e_route_bypass) {
439 xbt_dynar_merge(links, &e_route_bypass->link_list);
440 generic_free_route(e_route_bypass);
444 /* If src and dst are in the same AS, life is good */
445 if (src_father == dst_father) { /* SURF_ROUTING_BASE */
446 route.link_list = *links;
447 common_father->getRouteAndLatency(src, dst, &route, latency);
448 // if vivaldi latency+=vivaldi(src,dst)
452 /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
454 route.link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
455 // Find the net_card corresponding to father
456 simgrid::surf::NetCard *src_father_netcard = src_father->p_netcard;
457 simgrid::surf::NetCard *dst_father_netcard = dst_father->p_netcard;
459 common_father->getRouteAndLatency(src_father_netcard, dst_father_netcard,
462 xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
463 "bad gateways for route from \"%s\" to \"%s\"", src->getName(), dst->getName());
465 sg_netcard_t src_gateway_net_elm = route.gw_src;
466 sg_netcard_t dst_gateway_net_elm = route.gw_dst;
468 /* If source gateway is not our source, we have to recursively find our way up to this point */
469 if (src != src_gateway_net_elm)
470 _get_route_and_latency(src, src_gateway_net_elm, links, latency);
471 xbt_dynar_merge(links, &route.link_list);
473 /* If dest gateway is not our destination, we have to recursively find our way from this point */
474 if (dst_gateway_net_elm != dst)
475 _get_route_and_latency(dst_gateway_net_elm, dst, links, latency);
479 AS_t surf_platf_get_root(routing_platf_t platf){
480 return platf->p_root;
483 e_surf_network_element_type_t surf_routing_edge_get_rc_type(sg_netcard_t netcard){
484 return netcard->getRcType();
491 * \brief Find a route between hosts
493 * \param src the network_element_t for src host
494 * \param dst the network_element_t for dst host
495 * \param route where to store the list of links.
496 * If *route=NULL, create a short lived dynar. Else, fill the provided dynar
497 * \param latency where to store the latency experienced on the path (or NULL if not interested)
498 * It is the caller responsability to initialize latency to 0 (we add to provided route)
501 * walk through the routing components tree and find a route between hosts
502 * by calling each "get_route" function in each routing component.
504 void RoutingPlatf::getRouteAndLatency(NetCard *src, NetCard *dst, xbt_dynar_t* route, double *latency)
506 XBT_DEBUG("getRouteAndLatency from %s to %s", src->getName(), dst->getName());
507 if (NULL == *route) {
508 xbt_dynar_reset(routing_platf->p_lastRoute);
509 *route = routing_platf->p_lastRoute;
512 _get_route_and_latency(src, dst, route, latency);
514 xbt_assert(!latency || *latency >= 0.0,
515 "negative latency on route between \"%s\" and \"%s\"", src->getName(), dst->getName());
518 xbt_dynar_t RoutingPlatf::getOneLinkRoutes(){
519 return recursiveGetOneLinkRoutes(p_root);
522 xbt_dynar_t RoutingPlatf::recursiveGetOneLinkRoutes(As *rc)
524 xbt_dynar_t ret = xbt_dynar_new(sizeof(Onelink*), xbt_free_f);
526 //adding my one link routes
527 xbt_dynar_t onelink_mine = rc->getOneLinkRoutes();
529 xbt_dynar_merge(&ret,&onelink_mine);
533 xbt_dict_cursor_t cursor = NULL;
535 xbt_dict_foreach(rc->p_routingSons, cursor, key, rc_child) {
536 xbt_dynar_t onelink_child = recursiveGetOneLinkRoutes(rc_child);
538 xbt_dynar_merge(&ret,&onelink_child);
546 e_surf_network_element_type_t routing_get_network_element_type(const char *name)
548 simgrid::surf::NetCard *rc = sg_netcard_by_name_or_null(name);
550 return rc->getRcType();
552 return SURF_NETWORK_ELEMENT_NULL;
556 * \brief Generic method: create the global routing schema
558 * Make a global routing structure and set all the parsing functions.
560 void routing_model_create( void *loopback)
562 /* config the uniq global routing */
563 routing_platf = new simgrid::surf::RoutingPlatf();
564 routing_platf->p_root = NULL;
565 routing_platf->p_loopback = loopback;
566 routing_platf->p_lastRoute = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
567 /* no current routing at moment */
568 current_routing = NULL;
572 /* ************************************************** */
573 /* ********** PATERN FOR NEW ROUTING **************** */
575 /* The minimal configuration of a new routing model need the next functions,
576 * also you need to set at the start of the file, the new model in the model
577 * list. Remember keep the null ending of the list.
579 /*** Routing model structure ***/
581 // s_routing_component_t generic_routing;
582 // /* things that your routing model need */
583 // } s_routing_component_NEW_t,*routing_component_NEW_t;
585 /*** Parse routing model functions ***/
586 // static void model_NEW_set_processing_unit(routing_component_t rc, const char* name) {}
587 // static void model_NEW_set_autonomous_system(routing_component_t rc, const char* name) {}
588 // static void model_NEW_set_route(routing_component_t rc, const char* src, const char* dst, route_t route) {}
589 // static void model_NEW_set_ASroute(routing_component_t rc, const char* src, const char* dst, route_extended_t route) {}
590 // static void model_NEW_set_bypassroute(routing_component_t rc, const char* src, const char* dst, route_extended_t e_route) {}
592 /*** Business methods ***/
593 // static route_extended_t NEW_get_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
594 // static route_extended_t NEW_get_bypass_route(routing_component_t rc, const char* src,const char* dst) {return NULL;}
595 // static void NEW_finalize(routing_component_t rc) { xbt_free(rc);}
597 /*** Creation routing model functions ***/
598 // static void* model_NEW_create(void) {
599 // routing_component_NEW_t new_component = xbt_new0(s_routing_component_NEW_t,1);
600 // new_component->generic_routing.set_processing_unit = model_NEW_set_processing_unit;
601 // new_component->generic_routing.set_autonomous_system = model_NEW_set_autonomous_system;
602 // new_component->generic_routing.set_route = model_NEW_set_route;
603 // new_component->generic_routing.set_ASroute = model_NEW_set_ASroute;
604 // new_component->generic_routing.set_bypassroute = model_NEW_set_bypassroute;
605 // new_component->generic_routing.get_route = NEW_get_route;
606 // new_component->generic_routing.get_bypass_route = NEW_get_bypass_route;
607 // new_component->generic_routing.finalize = NEW_finalize;
608 // /* initialization of internal structures */
609 // return new_component;
611 // static void model_NEW_load(void) {} /* mandatory */
612 // static void model_NEW_unload(void) {} /* mandatory */
613 // static void model_NEW_end(void) {} /* mandatory */
615 /* ************************************************************************** */
616 /* ************************* GENERIC PARSE FUNCTIONS ************************ */
618 void routing_cluster_add_backbone(void* bb) {
619 xbt_assert(current_routing->p_modelDesc == &routing_models[SURF_MODEL_CLUSTER],
620 "You have to be in model Cluster to use tag backbone!");
621 xbt_assert(!static_cast<simgrid::surf::AsCluster*>(current_routing)->p_backbone, "The backbone link is already defined!");
622 static_cast<simgrid::surf::AsCluster*>(current_routing)->p_backbone =
623 static_cast<simgrid::surf::Link*>(bb);
624 XBT_DEBUG("Add a backbone to AS '%s'", current_routing->p_name);
627 void sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet)
630 char *groups , *host_id , *link_id = NULL;
632 xbt_dynar_t radical_elements;
633 xbt_dynar_t radical_ends;
636 radical_elements = xbt_str_split(cabinet->radical, ",");
637 xbt_dynar_foreach(radical_elements, iter, groups) {
639 radical_ends = xbt_str_split(groups, "-");
640 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
642 switch (xbt_dynar_length(radical_ends)) {
647 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
650 surf_parse_error("Malformed radical");
653 s_sg_platf_host_cbarg_t host = SG_PLATF_HOST_INITIALIZER;
654 memset(&host, 0, sizeof(host));
655 host.initiallyOn = 1;
657 host.speed_scale = 1.0;
658 host.core_amount = 1;
660 s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
661 memset(&link, 0, sizeof(link));
662 link.initiallyOn = 1;
663 link.policy = SURF_LINK_FULLDUPLEX;
664 link.latency = cabinet->lat;
665 link.bandwidth = cabinet->bw;
667 s_sg_platf_host_link_cbarg_t host_link = SG_PLATF_HOST_LINK_INITIALIZER;
668 memset(&host_link, 0, sizeof(host_link));
670 for (i = start; i <= end; i++) {
671 host_id = bprintf("%s%d%s",cabinet->prefix,i,cabinet->suffix);
672 link_id = bprintf("link_%s%d%s",cabinet->prefix,i,cabinet->suffix);
675 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
676 xbt_dynar_push(host.speed_peak,&cabinet->speed);
677 sg_platf_new_host(&host);
678 xbt_dynar_free(&host.speed_peak);
679 sg_platf_new_link(&link);
681 char* link_up = bprintf("%s_UP",link_id);
682 char* link_down = bprintf("%s_DOWN",link_id);
683 host_link.id = host_id;
684 host_link.link_up = link_up;
685 host_link.link_down = link_down;
686 sg_platf_new_netcard(&host_link);
694 xbt_dynar_free(&radical_ends);
696 xbt_dynar_free(&radical_elements);
699 void routing_new_cluster(sg_platf_cluster_cbarg_t cluster)
701 using simgrid::surf::AsCluster;
702 using simgrid::surf::AsClusterTorus;
703 using simgrid::surf::AsClusterFatTree;
705 char *host_id, *groups, *link_id = NULL;
706 xbt_dict_t patterns = NULL;
709 s_sg_platf_host_cbarg_t host = SG_PLATF_HOST_INITIALIZER;
710 s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
714 xbt_dynar_t radical_elements;
715 xbt_dynar_t radical_ends;
717 if ((cluster->availability_trace && strcmp(cluster->availability_trace, ""))
718 || (cluster->state_trace && strcmp(cluster->state_trace, ""))) {
719 patterns = xbt_dict_new_homogeneous(xbt_free_f);
720 xbt_dict_set(patterns, "id", xbt_strdup(cluster->id), NULL);
721 xbt_dict_set(patterns, "prefix", xbt_strdup(cluster->prefix), NULL);
722 xbt_dict_set(patterns, "suffix", xbt_strdup(cluster->suffix), NULL);
725 /* parse the topology attribute. If we are not in a flat cluster,
726 * switch to the right mode and initialize the routing with
727 * the parameters in topo_parameters attribute
729 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
732 if(cluster->topology == SURF_CLUSTER_TORUS){
733 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Torus_Cluster\">", cluster->id);
734 AS.routing = A_surfxml_AS_routing_Cluster___torus;
735 sg_platf_new_AS_begin(&AS);
736 ((AsClusterTorus*)current_routing)->parse_specific_arguments(cluster);
738 else if (cluster->topology == SURF_CLUSTER_FAT_TREE) {
739 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Fat_Tree_Cluster\">", cluster->id);
740 AS.routing = A_surfxml_AS_routing_Cluster___fat___tree;
741 sg_platf_new_AS_begin(&AS);
742 ((AsClusterFatTree*)current_routing)->parse_specific_arguments(cluster);
746 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", cluster->id);
747 AS.routing = A_surfxml_AS_routing_Cluster;
748 sg_platf_new_AS_begin(&AS);
751 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
752 ((AsCluster*)current_routing)->p_nb_links_per_node++;
753 ((AsCluster*)current_routing)->p_has_loopback=1;
756 if(cluster->limiter_link!=0){
757 ((AsCluster*)current_routing)->p_nb_links_per_node++;
758 ((AsCluster*)current_routing)->p_has_limiter=1;
763 current_routing->p_linkUpDownList
764 = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
767 radical_elements = xbt_str_split(cluster->radical, ",");
768 xbt_dynar_foreach(radical_elements, iter, groups) {
770 radical_ends = xbt_str_split(groups, "-");
771 start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
773 switch (xbt_dynar_length(radical_ends)) {
778 end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
781 surf_parse_error("Malformed radical");
784 for (i = start; i <= end; i++) {
786 bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
787 link_id = bprintf("%s_link_%d", cluster->id, i);
789 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->speed);
791 memset(&host, 0, sizeof(host));
793 if ((cluster->properties != NULL) && (!xbt_dict_is_empty(cluster->properties))) {
794 xbt_dict_cursor_t cursor=NULL;
796 host.properties = xbt_dict_new();
798 xbt_dict_foreach(cluster->properties,cursor,key,data) {
799 xbt_dict_set(host.properties, key, xbt_strdup(data),free);
802 if (cluster->availability_trace && strcmp(cluster->availability_trace, "")) {
803 xbt_dict_set(patterns, "radical", bprintf("%d", i), NULL);
804 char *avail_file = xbt_str_varsubst(cluster->availability_trace, patterns);
805 XBT_DEBUG("\tavailability_file=\"%s\"", avail_file);
806 host.speed_trace = tmgr_trace_new_from_file(avail_file);
807 xbt_free(avail_file);
809 XBT_DEBUG("\tavailability_file=\"\"");
812 if (cluster->state_trace && strcmp(cluster->state_trace, "")) {
813 char *avail_file = xbt_str_varsubst(cluster->state_trace, patterns);
814 XBT_DEBUG("\tstate_file=\"%s\"", avail_file);
815 host.state_trace = tmgr_trace_new_from_file(avail_file);
816 xbt_free(avail_file);
818 XBT_DEBUG("\tstate_file=\"\"");
821 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
822 xbt_dynar_push(host.speed_peak,&cluster->speed);
825 //host.power_peak = cluster->power;
826 host.speed_scale = 1.0;
827 host.core_amount = cluster->core_amount;
828 host.initiallyOn = 1;
830 sg_platf_new_host(&host);
831 xbt_dynar_free(&host.speed_peak);
832 XBT_DEBUG("</host>");
834 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id,
835 cluster->bw, cluster->lat);
838 s_surf_parsing_link_up_down_t info_lim, info_loop;
839 // All links are saved in a matrix;
840 // every row describes a single node; every node
841 // may have multiple links.
842 // the first column may store a link from x to x if p_has_loopback is set
843 // the second column may store a limiter link if p_has_limiter is set
844 // other columns are to store one or more link for the node
846 //add a loopback link
847 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
848 char *tmp_link = bprintf("%s_loopback", link_id);
849 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
850 cluster->limiter_link);
853 memset(&link, 0, sizeof(link));
855 link.bandwidth = cluster->loopback_bw;
856 link.latency = cluster->loopback_lat;
857 link.initiallyOn = 1;
858 link.policy = SURF_LINK_FATPIPE;
859 sg_platf_new_link(&link);
860 info_loop.link_up = Link::byName(tmp_link);
861 info_loop.link_down = info_loop.link_up;
863 xbt_dynar_set(current_routing->p_linkUpDownList,
864 rankId*(static_cast<AsCluster*>(current_routing))->p_nb_links_per_node, &info_loop);
867 //add a limiter link (shared link to account for maximal bandwidth of the node)
868 if(cluster->limiter_link!=0){
869 char *tmp_link = bprintf("%s_limiter", link_id);
870 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link,
871 cluster->limiter_link);
874 memset(&link, 0, sizeof(link));
876 link.bandwidth = cluster->limiter_link;
878 link.initiallyOn = 1;
879 link.policy = SURF_LINK_SHARED;
880 sg_platf_new_link(&link);
881 info_lim.link_up = Link::byName(tmp_link);
882 info_lim.link_down = info_lim.link_up;
884 auto as_cluster = static_cast<AsCluster*>(current_routing);
885 xbt_dynar_set(current_routing->p_linkUpDownList,
886 rankId*(as_cluster)->p_nb_links_per_node + as_cluster->p_has_loopback ,
892 //call the cluster function that adds the others links
893 if (cluster->topology == SURF_CLUSTER_FAT_TREE) {
894 ((AsClusterFatTree*) current_routing)->addProcessingNode(i);
897 static_cast<AsCluster*>(current_routing)->create_links_for_node(cluster, i, rankId, rankId*
898 static_cast<AsCluster*>(current_routing)->p_nb_links_per_node
899 + static_cast<AsCluster*>(current_routing)->p_has_loopback
900 + static_cast<AsCluster*>(current_routing)->p_has_limiter );
907 xbt_dynar_free(&radical_ends);
909 xbt_dynar_free(&radical_elements);
911 // For fat trees, the links must be created once all nodes have been added
912 if(cluster->topology == SURF_CLUSTER_FAT_TREE) {
913 static_cast<simgrid::surf::AsClusterFatTree*>(current_routing)->create_links();
915 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
916 // and it's very useful to connect clusters together
918 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
920 s_sg_platf_router_cbarg_t router = SG_PLATF_ROUTER_INITIALIZER;
921 memset(&router, 0, sizeof(router));
922 router.id = cluster->router_id;
924 if (!router.id || !strcmp(router.id, ""))
926 bprintf("%s%s_router%s", cluster->prefix, cluster->id,
928 sg_platf_new_router(&router);
929 ((AsCluster*)current_routing)->p_router = (simgrid::surf::NetCard*) xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
933 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
934 char *link_backbone = bprintf("%s_backbone", cluster->id);
935 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link_backbone,
936 cluster->bb_bw, cluster->bb_lat);
938 memset(&link, 0, sizeof(link));
939 link.id = link_backbone;
940 link.bandwidth = cluster->bb_bw;
941 link.latency = cluster->bb_lat;
942 link.initiallyOn = 1;
943 link.policy = cluster->bb_sharing_policy;
945 sg_platf_new_link(&link);
947 routing_cluster_add_backbone(Link::byName(link_backbone));
953 sg_platf_new_AS_end();
955 xbt_dict_free(&patterns); // no op if it were never set
958 static void routing_parse_postparse(void) {
959 xbt_dict_free(&random_value);
962 void sg_platf_new_peer(sg_platf_peer_cbarg_t peer)
964 using simgrid::surf::NetCard;
965 using simgrid::surf::AsCluster;
967 char *host_id = NULL;
968 char *link_id = NULL;
969 char *router_id = NULL;
972 host_id = HOST_PEER(peer->id);
973 link_id = LINK_PEER(peer->id);
974 router_id = ROUTER_PEER(peer->id);
976 XBT_DEBUG("<AS id=\"%s\"\trouting=\"Cluster\">", peer->id);
977 s_sg_platf_AS_cbarg_t AS = SG_PLATF_AS_INITIALIZER;
979 AS.routing = A_surfxml_AS_routing_Cluster;
980 sg_platf_new_AS_begin(&AS);
982 current_routing->p_linkUpDownList = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
984 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\"/>", host_id, peer->speed);
985 s_sg_platf_host_cbarg_t host = SG_PLATF_HOST_INITIALIZER;
986 memset(&host, 0, sizeof(host));
987 host.initiallyOn = 1;
990 host.speed_peak = xbt_dynar_new(sizeof(double), NULL);
991 xbt_dynar_push(host.speed_peak,&peer->speed);
993 //host.power_peak = peer->power;
994 host.speed_scale = 1.0;
995 host.speed_trace = peer->availability_trace;
996 host.state_trace = peer->state_trace;
997 host.core_amount = 1;
998 sg_platf_new_host(&host);
999 xbt_dynar_free(&host.speed_peak);
1001 s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
1002 memset(&link, 0, sizeof(link));
1003 link.initiallyOn = 1;
1004 link.policy = SURF_LINK_SHARED;
1005 link.latency = peer->lat;
1007 char* link_up = bprintf("%s_UP",link_id);
1008 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_up,
1009 peer->bw_out, peer->lat);
1011 link.bandwidth = peer->bw_out;
1012 sg_platf_new_link(&link);
1014 char* link_down = bprintf("%s_DOWN",link_id);
1015 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_down,
1016 peer->bw_in, peer->lat);
1017 link.id = link_down;
1018 link.bandwidth = peer->bw_in;
1019 sg_platf_new_link(&link);
1021 XBT_DEBUG("<host_link\tid=\"%s\"\tup=\"%s\"\tdown=\"%s\" />", host_id,link_up,link_down);
1022 s_sg_platf_host_link_cbarg_t host_link = SG_PLATF_HOST_LINK_INITIALIZER;
1023 memset(&host_link, 0, sizeof(host_link));
1024 host_link.id = host_id;
1025 host_link.link_up = link_up;
1026 host_link.link_down = link_down;
1027 sg_platf_new_netcard(&host_link);
1029 XBT_DEBUG("<router id=\"%s\"/>", router_id);
1030 s_sg_platf_router_cbarg_t router = SG_PLATF_ROUTER_INITIALIZER;
1031 memset(&router, 0, sizeof(router));
1032 router.id = router_id;
1033 router.coord = peer->coord;
1034 sg_platf_new_router(&router);
1035 static_cast<AsCluster*>(current_routing)->p_router = static_cast<NetCard*>(xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL));
1038 sg_platf_new_AS_end();
1041 //xbt_dynar_free(&tab_elements_num);
1049 // static void routing_parse_Srandom(void)
1051 // double mean, std, min, max, seed;
1052 // char *random_id = A_surfxml_random_id;
1053 // char *random_radical = A_surfxml_random_radical;
1054 // char *rd_name = NULL;
1056 // mean = surf_parse_get_double(A_surfxml_random_mean);
1057 // std = surf_parse_get_double(A_surfxml_random_std___deviation);
1058 // min = surf_parse_get_double(A_surfxml_random_min);
1059 // max = surf_parse_get_double(A_surfxml_random_max);
1060 // seed = surf_parse_get_double(A_surfxml_random_seed);
1064 // random_data_t random = xbt_new0(s_random_data_t, 1);
1067 // xbt_dynar_t radical_elements;
1068 // unsigned int iter;
1071 // xbt_dynar_t radical_ends;
1073 // switch (A_surfxml_random_generator) {
1074 // case AU_surfxml_random_generator:
1075 // case A_surfxml_random_generator_NONE:
1076 // random->generator = NONE;
1078 // case A_surfxml_random_generator_DRAND48:
1079 // random->generator = DRAND48;
1081 // case A_surfxml_random_generator_RAND:
1082 // random->generator = RAND;
1084 // case A_surfxml_random_generator_RNGSTREAM:
1085 // random->generator = RNGSTREAM;
1088 // surf_parse_error("Invalid random generator");
1091 // random->seed = seed;
1092 // random->min = min;
1093 // random->max = max;
1095 // /* Check user stupidities */
1097 // THROWF(arg_error, 0, "random->max < random->min (%f < %f)", max, min);
1099 // THROWF(arg_error, 0, "random->mean < random->min (%f < %f)", mean, min);
1101 // THROWF(arg_error, 0, "random->mean > random->max (%f > %f)", mean, max);
1103 // /* normalize the mean and standard deviation before storing */
1104 // random->mean = (mean - min) / (max - min);
1105 // random->std = std / (max - min);
1107 // if (random->mean * (1 - random->mean) < random->std * random->std)
1108 // THROWF(arg_error, 0, "Invalid mean and standard deviation (%f and %f)",
1109 // random->mean, random->std);
1112 // ("id = '%s' min = '%f' max = '%f' mean = '%f' std_deviatinon = '%f' generator = '%d' seed = '%ld' radical = '%s'",
1113 // random_id, random->min, random->max, random->mean, random->std,
1114 // (int)random->generator, random->seed, random_radical);
1116 // if (!random_value)
1117 // random_value = xbt_dict_new_homogeneous(free);
1119 // if (!strcmp(random_radical, "")) {
1120 // res = random_generate(random);
1121 // rd_value = bprintf("%f", res);
1122 // xbt_dict_set(random_value, random_id, rd_value, NULL);
1124 // radical_elements = xbt_str_split(random_radical, ",");
1125 // xbt_dynar_foreach(radical_elements, iter, groups) {
1126 // radical_ends = xbt_str_split(groups, "-");
1127 // switch (xbt_dynar_length(radical_ends)) {
1129 // xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1130 // "Custom Random '%s' already exists !", random_id);
1131 // res = random_generate(random);
1133 // bprintf("%s%d", random_id,
1134 // atoi(xbt_dynar_getfirst_as(radical_ends, char *)));
1135 // xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1136 // xbt_free(tmpbuf);
1140 // start = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 0, char *));
1141 // end = surf_parse_get_int(xbt_dynar_get_as(radical_ends, 1, char *));
1142 // for (i = start; i <= end; i++) {
1143 // xbt_assert(!xbt_dict_get_or_null(random_value, random_id),
1144 // "Custom Random '%s' already exists !", bprintf("%s%d",
1147 // res = random_generate(random);
1148 // tmpbuf = bprintf("%s%d", random_id, i);
1149 // xbt_dict_set(random_value, tmpbuf, bprintf("%f", res), NULL);
1150 // xbt_free(tmpbuf);
1154 // XBT_CRITICAL("Malformed radical");
1157 // res = random_generate(random);
1158 // rd_name = bprintf("%s_router", random_id);
1159 // rd_value = bprintf("%f", res);
1160 // xbt_dict_set(random_value, rd_name, rd_value, NULL);
1162 // xbt_dynar_free(&radical_ends);
1165 // xbt_dynar_free(&radical_elements);
1169 static void check_disk_attachment()
1171 xbt_lib_cursor_t cursor;
1174 simgrid::surf::NetCard *host_elm;
1175 xbt_lib_foreach(storage_lib, cursor, key, data) {
1176 if(xbt_lib_get_level(xbt_lib_get_elm_or_null(storage_lib, key), SURF_STORAGE_LEVEL) != NULL) {
1177 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));
1178 host_elm = sg_netcard_by_name_or_null(storage->p_attach);
1180 surf_parse_error("Unable to attach storage %s: host %s doesn't exist.", storage->getName(), storage->p_attach);
1185 void routing_register_callbacks()
1187 simgrid::surf::on_postparse.connect(routing_parse_postparse);
1188 simgrid::surf::on_postparse.connect(check_disk_attachment);
1190 instr_routing_define_callbacks();
1194 * \brief Recursive function for finalize
1196 * \param rc the source host name
1198 * This fuction is call by "finalize". It allow to finalize the
1199 * AS or routing components. It delete all the structures.
1201 static void finalize_rec(simgrid::surf::As *as) {
1202 xbt_dict_cursor_t cursor = NULL;
1206 xbt_dict_foreach(as->p_routingSons, cursor, key, elem) {
1213 /** \brief Frees all memory allocated by the routing module */
1214 void routing_exit(void) {
1215 delete routing_platf;
1221 RoutingPlatf::~RoutingPlatf()
1223 xbt_dynar_free(&p_lastRoute);
1224 finalize_rec(p_root);
1230 AS_t surf_AS_get_routing_root() {
1231 return routing_platf->p_root;
1234 const char *surf_AS_get_name(simgrid::surf::As *as) {
1238 static simgrid::surf::As *surf_AS_recursive_get_by_name(
1239 simgrid::surf::As *current, const char * name)
1241 xbt_dict_cursor_t cursor = NULL;
1244 simgrid::surf::As *tmp = NULL;
1246 if(!strcmp(current->p_name, name))
1249 xbt_dict_foreach(current->p_routingSons, cursor, key, elem) {
1250 tmp = surf_AS_recursive_get_by_name(elem, name);
1258 simgrid::surf::As *surf_AS_get_by_name(const char * name)
1260 simgrid::surf::As *as = surf_AS_recursive_get_by_name(routing_platf->p_root, name);
1262 XBT_WARN("Impossible to find an AS with name %s, please check your input", name);
1266 xbt_dict_t surf_AS_get_routing_sons(simgrid::surf::As *as)
1268 return as->p_routingSons;
1271 const char *surf_AS_get_model(simgrid::surf::As *as)
1273 return as->p_modelDesc->name;
1276 xbt_dynar_t surf_AS_get_hosts(simgrid::surf::As *as)
1278 xbt_dynar_t elms = as->p_indexNetworkElm;
1279 int count = xbt_dynar_length(elms);
1280 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
1281 for (int index = 0; index < count; index++) {
1283 xbt_dynar_get_as(elms, index, simgrid::surf::NetCard*);
1284 sg_host_t delm = simgrid::s4u::Host::by_name_or_null(relm->getName());
1286 xbt_dynar_push(res, &delm);
1292 void surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) {
1293 as->getGraph(graph, nodes, edges);