src/surf/surf_routing_generic.c

   1 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "simgrid/platf_interface.h"    // platform creation API internal interface
   8
   9 #include "surf_routing_private.h"
  10 #include "surf/surf_routing.h"
  11 #include "surf/surfxml_parse_values.h"
  12 #include "xbt/graph.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
  15
  16 static int no_bypassroute_declared = 1;
  17
  18 AS_t model_generic_create_sized(size_t childsize) {
  19   AS_t new_component = model_none_create_sized(childsize);
  20
  21   new_component->parse_PU = generic_parse_PU;
  22   new_component->parse_AS = generic_parse_AS;
  23   new_component->parse_route = NULL;
  24   new_component->parse_ASroute = NULL;
  25   new_component->parse_bypassroute = generic_parse_bypassroute;
  26   new_component->get_route_and_latency = NULL;
  27   new_component->get_onelink_routes = NULL;
  28   new_component->get_bypass_route =
  29       generic_get_bypassroute;
  30   new_component->finalize = model_generic_finalize;
  31   new_component->bypassRoutes = xbt_dict_new_homogeneous((void (*)(void *)) generic_free_route);
  32
  33   return new_component;
  34 }
  35 void model_generic_finalize(AS_t as) {
  36   xbt_dict_free(&as->bypassRoutes);
  37   model_none_finalize(as);
  38 }
  39
  40 int generic_parse_PU(AS_t as, sg_routing_edge_t elm)
  41 {
  42   XBT_DEBUG("Load process unit \"%s\"", elm->name);
  43   xbt_dynar_push_as(as->index_network_elm,sg_routing_edge_t,elm);
  44   return xbt_dynar_length(as->index_network_elm)-1;
  45 }
  46
  47 int generic_parse_AS(AS_t as, sg_routing_edge_t elm)
  48 {
  49   XBT_DEBUG("Load Autonomous system \"%s\"", elm->name);
  50   xbt_dynar_push_as(as->index_network_elm,sg_routing_edge_t,elm);
  51   return xbt_dynar_length(as->index_network_elm)-1;
  52 }
  53
  54 void generic_parse_bypassroute(AS_t rc, sg_platf_route_cbarg_t e_route)
  55 {
  56   char *src = (char*)(e_route->src);
  57   char *dst = (char*)(e_route->dst);
  58
  59   if(e_route->gw_dst)
  60     XBT_DEBUG("Load bypassASroute from \"%s\" to \"%s\"", src, dst);
  61   else
  62     XBT_DEBUG("Load bypassRoute from \"%s\" to \"%s\"", src, dst);
  63   xbt_dict_t dict_bypassRoutes = rc->bypassRoutes;
  64   char *route_name;
  65
  66   route_name = bprintf("%s#%s", src, dst);
  67   xbt_assert(!xbt_dynar_is_empty(e_route->link_list),
  68       "Invalid count of links, must be greater than zero (%s,%s)",
  69       src, dst);
  70   xbt_assert(!xbt_dict_get_or_null(dict_bypassRoutes, route_name),
  71       "The bypass route between \"%s\"(\"%s\") and \"%s\"(\"%s\") already exists",
  72       src, e_route->gw_src->name, dst, e_route->gw_dst->name);
  73
  74   sg_platf_route_cbarg_t new_e_route = NULL;
  75   if(e_route->gw_dst)
  76     new_e_route =  generic_new_extended_route(SURF_ROUTING_RECURSIVE, e_route, 1);
  77   else
  78     new_e_route =  generic_new_extended_route(SURF_ROUTING_BASE, e_route, 1);
  79
  80   xbt_dynar_free(&(e_route->link_list));
  81
  82   xbt_dict_set(dict_bypassRoutes, route_name, new_e_route, NULL);
  83   no_bypassroute_declared = 0;
  84   xbt_free(route_name);
  85 }
  86
  87 /* ************************************************************************** */
  88 /* *********************** GENERIC BUSINESS METHODS ************************* */
  89
  90 xbt_dynar_t generic_get_onelink_routes(AS_t rc) { // FIXME: kill that stub
  91   xbt_die("\"generic_get_onelink_routes\" not implemented yet");
  92   return NULL;
  93 }
  94
  95 static const char *instr_node_name(xbt_node_t node)
  96 {
  97   void *data = xbt_graph_node_get_data(node);
  98   char *str = (char *) data;
  99   return str;
 100 }
 101
 102 xbt_node_t new_xbt_graph_node(xbt_graph_t graph, const char *name,
 103                               xbt_dict_t nodes)
 104 {
 105   xbt_node_t ret = xbt_dict_get_or_null(nodes, name);
 106   if (ret)
 107     return ret;
 108
 109   ret = xbt_graph_new_node(graph, xbt_strdup(name));
 110   xbt_dict_set(nodes, name, ret, NULL);
 111   return ret;
 112 }
 113
 114 xbt_edge_t new_xbt_graph_edge(xbt_graph_t graph, xbt_node_t s, xbt_node_t d,
 115                               xbt_dict_t edges)
 116 {
 117   xbt_edge_t ret;
 118
 119   const char *sn = instr_node_name(s);
 120   const char *dn = instr_node_name(d);
 121   int len = strlen(sn) + strlen(dn) + 1;
 122   char *name = (char *) xbt_malloc(len * sizeof(char));
 123
 124
 125   snprintf(name, len, "%s%s", sn, dn);
 126   ret = xbt_dict_get_or_null(edges, name);
 127   if (ret == NULL) {
 128     snprintf(name, len, "%s%s", dn, sn);
 129     ret = xbt_dict_get_or_null(edges, name);
 130   }
 131
 132   if (ret == NULL) {
 133     ret = xbt_graph_new_edge(graph, s, d, NULL);
 134     xbt_dict_set(edges, name, ret, NULL);
 135   }
 136   free(name);
 137   return ret;
 138 }
 139
 140 void generic_get_graph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges,
 141                        AS_t rc)
 142 {
 143   int src, dst;
 144   int table_size = xbt_dynar_length(rc->index_network_elm);
 145
 146
 147   for (src = 0; src < table_size; src++) {
 148     sg_routing_edge_t my_src =
 149         xbt_dynar_get_as(rc->index_network_elm, src, sg_routing_edge_t);
 150     for (dst = 0; dst < table_size; dst++) {
 151       if (src == dst)
 152         continue;
 153       sg_routing_edge_t my_dst =
 154           xbt_dynar_get_as(rc->index_network_elm, dst, sg_routing_edge_t);
 155
 156       sg_platf_route_cbarg_t route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
 157       route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
 158
 159       rc->get_route_and_latency(rc, my_src, my_dst, route, NULL);
 160
 161       XBT_DEBUG ("get_route_and_latency %s -> %s", my_src->name, my_dst->name);
 162
 163       unsigned int cpt;
 164       void *link;
 165
 166       xbt_node_t current, previous;
 167       const char *previous_name, *current_name;
 168
 169       if (route->gw_src) {
 170         previous = new_xbt_graph_node(graph, route->gw_src->name, nodes);
 171         previous_name = route->gw_src->name;
 172       } else {
 173         previous = new_xbt_graph_node(graph, my_src->name, nodes);
 174         previous_name = my_src->name;
 175       }
 176
 177       xbt_dynar_foreach(route->link_list, cpt, link) {
 178         char *link_name = ((surf_resource_t) link)->name;
 179         current = new_xbt_graph_node(graph, link_name, nodes);
 180         current_name = link_name;
 181         new_xbt_graph_edge(graph, previous, current, edges);
 182         XBT_DEBUG ("  %s -> %s", previous_name, current_name);
 183         previous = current;
 184         previous_name = current_name;
 185       }
 186
 187       if (route->gw_dst) {
 188         current = new_xbt_graph_node(graph, route->gw_dst->name, nodes);
 189         current_name = route->gw_dst->name;
 190       } else {
 191         current = new_xbt_graph_node(graph, my_dst->name, nodes);
 192         current_name = my_dst->name;
 193       }
 194       new_xbt_graph_edge(graph, previous, current, edges);
 195       XBT_DEBUG ("  %s -> %s", previous_name, current_name);
 196
 197       xbt_dynar_free (&(route->link_list));
 198       xbt_free (route);
 199     }
 200   }
 201 }
 202
 203 sg_platf_route_cbarg_t generic_get_bypassroute(AS_t rc, sg_routing_edge_t src,
 204                                                sg_routing_edge_t dst,
 205                                                double *lat)
 206 {
 207   // If never set a bypass route return NULL without any further computations
 208   XBT_DEBUG("generic_get_bypassroute from %s to %s", src->name, dst->name);
 209   if (no_bypassroute_declared)
 210     return NULL;
 211
 212   sg_platf_route_cbarg_t e_route_bypass = NULL;
 213   xbt_dict_t dict_bypassRoutes = rc->bypassRoutes;
 214
 215   if(dst->rc_component == rc && src->rc_component == rc ){
 216     char *route_name = bprintf("%s#%s", src->name, dst->name);
 217     e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 218     if(e_route_bypass)
 219       XBT_DEBUG("Find bypass route with %ld links",xbt_dynar_length(e_route_bypass->link_list));
 220     free(route_name);
 221   }
 222   else{
 223     AS_t src_as, dst_as;
 224     int index_src, index_dst;
 225     xbt_dynar_t path_src = NULL;
 226     xbt_dynar_t path_dst = NULL;
 227     AS_t current = NULL;
 228     AS_t *current_src = NULL;
 229     AS_t *current_dst = NULL;
 230
 231     if (src == NULL || dst == NULL)
 232       xbt_die("Ask for route \"from\"(%s) or \"to\"(%s) no found at AS \"%s\"",
 233           src->name, dst->name, rc->name);
 234
 235     src_as = src->rc_component;
 236     dst_as = dst->rc_component;
 237
 238     /* (2) find the path to the root routing component */
 239     path_src = xbt_dynar_new(sizeof(AS_t), NULL);
 240     current = src_as;
 241     while (current != NULL) {
 242       xbt_dynar_push(path_src, &current);
 243       current = current->routing_father;
 244     }
 245     path_dst = xbt_dynar_new(sizeof(AS_t), NULL);
 246     current = dst_as;
 247     while (current != NULL) {
 248       xbt_dynar_push(path_dst, &current);
 249       current = current->routing_father;
 250     }
 251
 252     /* (3) find the common father */
 253     index_src = path_src->used - 1;
 254     index_dst = path_dst->used - 1;
 255     current_src = xbt_dynar_get_ptr(path_src, index_src);
 256     current_dst = xbt_dynar_get_ptr(path_dst, index_dst);
 257     while (index_src >= 0 && index_dst >= 0 && *current_src == *current_dst) {
 258       xbt_dynar_pop_ptr(path_src);
 259       xbt_dynar_pop_ptr(path_dst);
 260       index_src--;
 261       index_dst--;
 262       current_src = xbt_dynar_get_ptr(path_src, index_src);
 263       current_dst = xbt_dynar_get_ptr(path_dst, index_dst);
 264     }
 265
 266     int max_index_src = path_src->used - 1;
 267     int max_index_dst = path_dst->used - 1;
 268
 269     int max_index = max(max_index_src, max_index_dst);
 270     int i, max;
 271
 272     for (max = 0; max <= max_index; max++) {
 273       for (i = 0; i < max; i++) {
 274         if (i <= max_index_src && max <= max_index_dst) {
 275           char *route_name = bprintf("%s#%s",
 276               (*(AS_t *)
 277                   (xbt_dynar_get_ptr(path_src, i)))->name,
 278                   (*(AS_t *)
 279                       (xbt_dynar_get_ptr(path_dst, max)))->name);
 280           e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 281           xbt_free(route_name);
 282         }
 283         if (e_route_bypass)
 284           break;
 285         if (max <= max_index_src && i <= max_index_dst) {
 286           char *route_name = bprintf("%s#%s",
 287               (*(AS_t *)
 288                   (xbt_dynar_get_ptr(path_src, max)))->name,
 289                   (*(AS_t *)
 290                       (xbt_dynar_get_ptr(path_dst, i)))->name);
 291           e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 292           xbt_free(route_name);
 293         }
 294         if (e_route_bypass)
 295           break;
 296       }
 297
 298       if (e_route_bypass)
 299         break;
 300
 301       if (max <= max_index_src && max <= max_index_dst) {
 302         char *route_name = bprintf("%s#%s",
 303             (*(AS_t *)
 304                 (xbt_dynar_get_ptr(path_src, max)))->name,
 305                 (*(AS_t *)
 306                     (xbt_dynar_get_ptr(path_dst, max)))->name);
 307         e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 308         xbt_free(route_name);
 309       }
 310       if (e_route_bypass)
 311         break;
 312     }
 313
 314     xbt_dynar_free(&path_src);
 315     xbt_dynar_free(&path_dst);
 316   }
 317
 318   sg_platf_route_cbarg_t new_e_route = NULL;
 319   if (e_route_bypass) {
 320     void *link;
 321     unsigned int cpt = 0;
 322     new_e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
 323     new_e_route->gw_src = e_route_bypass->gw_src;
 324     new_e_route->gw_dst = e_route_bypass->gw_dst;
 325     new_e_route->link_list =
 326         xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
 327     xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
 328       xbt_dynar_push(new_e_route->link_list, &link);
 329       if (lat)
 330         *lat += surf_network_model->extension.network.get_link_latency(link);
 331     }
 332   }
 333
 334   return new_e_route;
 335 }
 336
 337 /* ************************************************************************** */
 338 /* ************************* GENERIC AUX FUNCTIONS ************************** */
 339 /* change a route containing link names into a route containing link entities */
 340 sg_platf_route_cbarg_t
 341 generic_new_extended_route(e_surf_routing_hierarchy_t hierarchy,
 342     sg_platf_route_cbarg_t routearg, int change_order) {
 343
 344   sg_platf_route_cbarg_t result;
 345   char *link_name;
 346   unsigned int cpt;
 347
 348   result = xbt_new0(s_sg_platf_route_cbarg_t, 1);
 349   result->link_list = xbt_dynar_new(sizeof(sg_routing_link_t), NULL);
 350
 351   xbt_assert(hierarchy == SURF_ROUTING_BASE
 352       || hierarchy == SURF_ROUTING_RECURSIVE,
 353       "The hierarchy of this AS is neither BASIC nor RECURSIVE, I'm lost here.");
 354
 355   if (hierarchy == SURF_ROUTING_RECURSIVE) {
 356
 357     xbt_assert(routearg->gw_src && routearg->gw_dst,
 358         "NULL is obviously a bad gateway");
 359
 360     /* remeber not erase the gateway names */
 361     result->gw_src = routearg->gw_src;
 362     result->gw_dst = routearg->gw_dst;
 363   }
 364
 365   xbt_dynar_foreach(routearg->link_list, cpt, link_name) {
 366
 367     void *link = xbt_lib_get_or_null(link_lib, link_name, SURF_LINK_LEVEL);
 368     if (link) {
 369       if (change_order)
 370         xbt_dynar_push(result->link_list, &link);
 371       else
 372         xbt_dynar_unshift(result->link_list, &link);
 373     } else
 374       THROWF(mismatch_error, 0, "Link %s not found", link_name);
 375   }
 376
 377   return result;
 378 }
 379
 380 void generic_free_route(sg_platf_route_cbarg_t route)
 381 {
 382   if (route) {
 383     xbt_dynar_free(&route->link_list);
 384     xbt_free(route);
 385   }
 386 }
 387
 388 static AS_t generic_as_exist(AS_t find_from,
 389     AS_t to_find)
 390 {
 391   //return to_find; // FIXME: BYPASSERROR OF FOREACH WITH BREAK
 392   xbt_dict_cursor_t cursor = NULL;
 393   char *key;
 394   int found = 0;
 395   AS_t elem;
 396   xbt_dict_foreach(find_from->routing_sons, cursor, key, elem) {
 397     if (to_find == elem || generic_as_exist(elem, to_find)) {
 398       found = 1;
 399       break;
 400     }
 401   }
 402   if (found)
 403     return to_find;
 404   return NULL;
 405 }
 406
 407 AS_t
 408 generic_autonomous_system_exist(AS_t rc, char *element)
 409 {
 410   //return rc; // FIXME: BYPASSERROR OF FOREACH WITH BREAK
 411   AS_t element_as, result, elem;
 412   xbt_dict_cursor_t cursor = NULL;
 413   char *key;
 414   element_as = ((sg_routing_edge_t)
 415       xbt_lib_get_or_null(as_router_lib, element,
 416           ROUTING_ASR_LEVEL))->rc_component;
 417   result = ((AS_t) - 1);
 418   if (element_as != rc)
 419     result = generic_as_exist(rc, element_as);
 420
 421   int found = 0;
 422   if (result) {
 423     xbt_dict_foreach(element_as->routing_sons, cursor, key, elem) {
 424       found = !strcmp(elem->name, element);
 425       if (found)
 426         break;
 427     }
 428     if (found)
 429       return element_as;
 430   }
 431   return NULL;
 432 }
 433
 434 AS_t
 435 generic_processing_units_exist(AS_t rc, char *element)
 436 {
 437   AS_t element_as;
 438   element_as = ((sg_routing_edge_t)
 439       xbt_lib_get_or_null(host_lib,
 440           element, ROUTING_HOST_LEVEL))->rc_component;
 441   if (element_as == rc)
 442     return element_as;
 443   return generic_as_exist(rc, element_as);
 444 }
 445
 446 void generic_src_dst_check(AS_t rc, sg_routing_edge_t src,
 447     sg_routing_edge_t dst)
 448 {
 449
 450   sg_routing_edge_t src_data = src;
 451   sg_routing_edge_t dst_data = dst;
 452
 453   if (src_data == NULL || dst_data == NULL)
 454     xbt_die("Ask for route \"from\"(%s) or \"to\"(%s) no found at AS \"%s\"",
 455         src->name,
 456         dst->name,
 457         rc->name);
 458
 459   AS_t src_as =
 460       (src_data)->rc_component;
 461   AS_t dst_as =
 462       (dst_data)->rc_component;
 463
 464   if (src_as != dst_as)
 465     xbt_die("The src(%s in %s) and dst(%s in %s) are in differents AS",
 466         src->name, src_as->name,
 467         dst->name, dst_as->name);
 468
 469   if (rc != dst_as)
 470     xbt_die
 471     ("The routing component of src'%s' and dst'%s' is not the same as the network elements belong (%s?=%s?=%s)",
 472         src->name,
 473         dst->name,
 474         src_as->name,
 475         dst_as->name,
 476         rc->name);
 477 }