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 <pcre.h>               /* regular expression library */
   8
   9 #include "simgrid/platf_interface.h"    // platform creation API internal interface
  10
  11 #include "surf_routing_private.h"
  12 #include "surf/surf_routing.h"
  13 #include "surf/surfxml_parse_values.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
  16
  17 AS_t model_generic_create_sized(size_t childsize) {
  18   AS_t new_component = model_none_create_sized(childsize);
  19
  20   new_component->parse_PU = generic_parse_PU;
  21   new_component->parse_AS = generic_parse_AS;
  22   new_component->parse_route = NULL;
  23   new_component->parse_ASroute = NULL;
  24   new_component->parse_bypassroute = generic_parse_bypassroute;
  25   new_component->get_route_and_latency = NULL;
  26   new_component->get_onelink_routes = NULL;
  27   new_component->get_bypass_route =
  28       generic_get_bypassroute;
  29   new_component->finalize = model_generic_finalize;
  30
  31   new_component->to_index = xbt_dict_new_homogeneous(xbt_free);
  32   new_component->bypassRoutes = xbt_dict_new_homogeneous((void (*)(void *)) generic_free_route);
  33
  34   return new_component;
  35 }
  36 void model_generic_finalize(AS_t as) {
  37   xbt_dict_free(&as->to_index);
  38   xbt_dict_free(&as->bypassRoutes);
  39   model_none_finalize(as);
  40 }
  41
  42 void generic_parse_PU(AS_t as, const char *name)
  43 {
  44   XBT_DEBUG("Load process unit \"%s\"", name);
  45   int *id = xbt_new0(int, 1);
  46   xbt_dict_t _to_index;
  47   _to_index = as->to_index;
  48   *id = xbt_dict_length(_to_index);
  49   xbt_dict_set(_to_index, name, id, NULL);
  50 }
  51
  52 void generic_parse_AS(AS_t as, const char *name)
  53 {
  54   XBT_DEBUG("Load Autonomous system \"%s\"", name);
  55   int *id = xbt_new0(int, 1);
  56   xbt_dict_t _to_index;
  57   _to_index = as->to_index;
  58   *id = xbt_dict_length(_to_index);
  59   xbt_dict_set(_to_index, name, id, NULL);
  60 }
  61
  62 void generic_parse_bypassroute(AS_t rc,
  63                              const char *src, const char *dst,
  64                              route_t e_route)
  65 {
  66   XBT_DEBUG("Load bypassRoute from \"%s\" to \"%s\"", src, dst);
  67   xbt_dict_t dict_bypassRoutes = rc->bypassRoutes;
  68   char *route_name;
  69
  70   route_name = bprintf("%s#%s", src, dst);
  71   xbt_assert(!xbt_dynar_is_empty(e_route->link_list),
  72              "Invalid count of links, must be greater than zero (%s,%s)",
  73              src, dst);
  74   xbt_assert(!xbt_dict_get_or_null(dict_bypassRoutes, route_name),
  75              "The bypass route between \"%s\"(\"%s\") and \"%s\"(\"%s\") already exists",
  76              src, e_route->src_gateway, dst, e_route->dst_gateway);
  77
  78   route_t new_e_route =
  79       generic_new_extended_route(SURF_ROUTING_RECURSIVE, e_route, 0);
  80   xbt_dynar_free(&(e_route->link_list));
  81   xbt_free(e_route);
  82
  83   xbt_dict_set(dict_bypassRoutes, route_name, new_e_route, NULL);
  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 }
  93
  94 route_t generic_get_bypassroute(AS_t rc, const char *src, const char *dst)
  95 {
  96   xbt_dict_t dict_bypassRoutes = rc->bypassRoutes;
  97   AS_t src_as, dst_as;
  98   int index_src, index_dst;
  99   xbt_dynar_t path_src = NULL;
 100   xbt_dynar_t path_dst = NULL;
 101   AS_t current = NULL;
 102   AS_t *current_src = NULL;
 103   AS_t *current_dst = NULL;
 104
 105   /* (1) find the as where the src and dst are located */
 106   void *src_data = xbt_lib_get_or_null(host_lib, src, ROUTING_HOST_LEVEL);
 107   void *dst_data = xbt_lib_get_or_null(host_lib, dst, ROUTING_HOST_LEVEL);
 108   if (!src_data)
 109     src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
 110   if (!dst_data)
 111     dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
 112
 113   if (src_data == NULL || dst_data == NULL)
 114     xbt_die("Ask for route \"from\"(%s) or \"to\"(%s) no found at AS \"%s\"",
 115             src, dst, rc->name);
 116
 117   src_as = ((network_element_info_t) src_data)->rc_component;
 118   dst_as = ((network_element_info_t) dst_data)->rc_component;
 119
 120   /* (2) find the path to the root routing component */
 121   path_src = xbt_dynar_new(sizeof(AS_t), NULL);
 122   current = src_as;
 123   while (current != NULL) {
 124     xbt_dynar_push(path_src, &current);
 125     current = current->routing_father;
 126   }
 127   path_dst = xbt_dynar_new(sizeof(AS_t), NULL);
 128   current = dst_as;
 129   while (current != NULL) {
 130     xbt_dynar_push(path_dst, &current);
 131     current = current->routing_father;
 132   }
 133
 134   /* (3) find the common father */
 135   index_src = path_src->used - 1;
 136   index_dst = path_dst->used - 1;
 137   current_src = xbt_dynar_get_ptr(path_src, index_src);
 138   current_dst = xbt_dynar_get_ptr(path_dst, index_dst);
 139   while (index_src >= 0 && index_dst >= 0 && *current_src == *current_dst) {
 140     xbt_dynar_pop_ptr(path_src);
 141     xbt_dynar_pop_ptr(path_dst);
 142     index_src--;
 143     index_dst--;
 144     current_src = xbt_dynar_get_ptr(path_src, index_src);
 145     current_dst = xbt_dynar_get_ptr(path_dst, index_dst);
 146   }
 147
 148   int max_index_src = path_src->used - 1;
 149   int max_index_dst = path_dst->used - 1;
 150
 151   int max_index = max(max_index_src, max_index_dst);
 152   int i, max;
 153
 154   route_t e_route_bypass = NULL;
 155
 156   for (max = 0; max <= max_index; max++) {
 157     for (i = 0; i < max; i++) {
 158       if (i <= max_index_src && max <= max_index_dst) {
 159         char *route_name = bprintf("%s#%s",
 160                                    (*(AS_t *)
 161                                     (xbt_dynar_get_ptr(path_src, i)))->name,
 162                                    (*(AS_t *)
 163                                     (xbt_dynar_get_ptr(path_dst, max)))->name);
 164         e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 165         xbt_free(route_name);
 166       }
 167       if (e_route_bypass)
 168         break;
 169       if (max <= max_index_src && i <= max_index_dst) {
 170         char *route_name = bprintf("%s#%s",
 171                                    (*(AS_t *)
 172                                     (xbt_dynar_get_ptr(path_src, max)))->name,
 173                                    (*(AS_t *)
 174                                     (xbt_dynar_get_ptr(path_dst, i)))->name);
 175         e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 176         xbt_free(route_name);
 177       }
 178       if (e_route_bypass)
 179         break;
 180     }
 181
 182     if (e_route_bypass)
 183       break;
 184
 185     if (max <= max_index_src && max <= max_index_dst) {
 186       char *route_name = bprintf("%s#%s",
 187                                  (*(AS_t *)
 188                                   (xbt_dynar_get_ptr(path_src, max)))->name,
 189                                  (*(AS_t *)
 190                                   (xbt_dynar_get_ptr(path_dst, max)))->name);
 191       e_route_bypass = xbt_dict_get_or_null(dict_bypassRoutes, route_name);
 192       xbt_free(route_name);
 193     }
 194     if (e_route_bypass)
 195       break;
 196   }
 197
 198   xbt_dynar_free(&path_src);
 199   xbt_dynar_free(&path_dst);
 200
 201   route_t new_e_route = NULL;
 202
 203   if (e_route_bypass) {
 204     void *link;
 205     unsigned int cpt = 0;
 206     new_e_route = xbt_new0(s_route_t, 1);
 207     new_e_route->src_gateway = xbt_strdup(e_route_bypass->src_gateway);
 208     new_e_route->dst_gateway = xbt_strdup(e_route_bypass->dst_gateway);
 209     new_e_route->link_list =
 210         xbt_dynar_new(global_routing->size_of_link, NULL);
 211     xbt_dynar_foreach(e_route_bypass->link_list, cpt, link) {
 212       xbt_dynar_push(new_e_route->link_list, &link);
 213     }
 214   }
 215
 216   return new_e_route;
 217 }
 218
 219 /* ************************************************************************** */
 220 /* ************************* GENERIC AUX FUNCTIONS ************************** */
 221
 222 route_t
 223 generic_new_route(e_surf_routing_hierarchy_t hierarchy, void *data, int order)
 224 {
 225
 226   char *link_name;
 227   route_t new_route;
 228   unsigned int cpt;
 229   xbt_dynar_t links = NULL, links_id = NULL;
 230
 231   new_route = xbt_new0(s_route_t, 1);
 232   new_route->link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
 233
 234   xbt_assert(hierarchy == SURF_ROUTING_BASE,
 235              "the hierarchy type is not SURF_ROUTING_BASE");
 236
 237   links = ((route_t) data)->link_list;
 238
 239
 240   links_id = new_route->link_list;
 241
 242   xbt_dynar_foreach(links, cpt, link_name) {
 243
 244     void *link = xbt_lib_get_or_null(link_lib, link_name, SURF_LINK_LEVEL);
 245     if (link) {
 246       if (order)
 247         xbt_dynar_push(links_id, &link);
 248       else
 249         xbt_dynar_unshift(links_id, &link);
 250     } else
 251       THROWF(mismatch_error, 0, "Link %s not found", link_name);
 252   }
 253
 254   return new_route;
 255 }
 256
 257 route_t
 258 generic_new_extended_route(e_surf_routing_hierarchy_t hierarchy,
 259                            void *data, int order)
 260 {
 261
 262   char *link_name;
 263   route_t e_route, new_e_route;
 264   route_t route;
 265   unsigned int cpt;
 266   xbt_dynar_t links = NULL, links_id = NULL;
 267
 268   new_e_route = xbt_new0(s_route_t, 1);
 269   new_e_route->link_list = xbt_dynar_new(global_routing->size_of_link, NULL);
 270
 271   xbt_assert(hierarchy == SURF_ROUTING_BASE
 272              || hierarchy == SURF_ROUTING_RECURSIVE,
 273              "the hierarchy type is not defined");
 274
 275   if (hierarchy == SURF_ROUTING_BASE) {
 276
 277     route = (route_t) data;
 278     links = route->link_list;
 279
 280   } else if (hierarchy == SURF_ROUTING_RECURSIVE) {
 281
 282     e_route = (route_t) data;
 283     xbt_assert(e_route->src_gateway
 284                && e_route->dst_gateway, "bad gateway, is null");
 285     links = e_route->link_list;
 286
 287     /* remeber not erase the gateway names */
 288     new_e_route->src_gateway = strdup(e_route->src_gateway);
 289     new_e_route->dst_gateway = strdup(e_route->dst_gateway);
 290   }
 291
 292   links_id = new_e_route->link_list;
 293
 294   xbt_dynar_foreach(links, cpt, link_name) {
 295
 296     void *link = xbt_lib_get_or_null(link_lib, link_name, SURF_LINK_LEVEL);
 297     if (link) {
 298       if (order)
 299         xbt_dynar_push(links_id, &link);
 300       else
 301         xbt_dynar_unshift(links_id, &link);
 302     } else
 303       THROWF(mismatch_error, 0, "Link %s not found", link_name);
 304   }
 305
 306   return new_e_route;
 307 }
 308
 309 void generic_free_route(route_t route)
 310 {
 311   if (route) {
 312     xbt_dynar_free(&route->link_list);
 313     xbt_free(route->src_gateway);
 314     xbt_free(route->dst_gateway);
 315     xbt_free(route);
 316   }
 317 }
 318
 319 static AS_t generic_as_exist(AS_t find_from,
 320                                             AS_t to_find)
 321 {
 322   //return to_find; // FIXME: BYPASSERROR OF FOREACH WITH BREAK
 323   xbt_dict_cursor_t cursor = NULL;
 324   char *key;
 325   int found = 0;
 326   AS_t elem;
 327   xbt_dict_foreach(find_from->routing_sons, cursor, key, elem) {
 328     if (to_find == elem || generic_as_exist(elem, to_find)) {
 329       found = 1;
 330       break;
 331     }
 332   }
 333   if (found)
 334     return to_find;
 335   return NULL;
 336 }
 337
 338 AS_t
 339 generic_autonomous_system_exist(AS_t rc, char *element)
 340 {
 341   //return rc; // FIXME: BYPASSERROR OF FOREACH WITH BREAK
 342   AS_t element_as, result, elem;
 343   xbt_dict_cursor_t cursor = NULL;
 344   char *key;
 345   element_as = ((network_element_info_t)
 346                 xbt_lib_get_or_null(as_router_lib, element,
 347                                     ROUTING_ASR_LEVEL))->rc_component;
 348   result = ((AS_t) - 1);
 349   if (element_as != rc)
 350     result = generic_as_exist(rc, element_as);
 351
 352   int found = 0;
 353   if (result) {
 354     xbt_dict_foreach(element_as->routing_sons, cursor, key, elem) {
 355       found = !strcmp(elem->name, element);
 356       if (found)
 357         break;
 358     }
 359     if (found)
 360       return element_as;
 361   }
 362   return NULL;
 363 }
 364
 365 AS_t
 366 generic_processing_units_exist(AS_t rc, char *element)
 367 {
 368   AS_t element_as;
 369   element_as = ((network_element_info_t)
 370                 xbt_lib_get_or_null(host_lib,
 371                                     element, ROUTING_HOST_LEVEL))->rc_component;
 372   if (element_as == rc)
 373     return element_as;
 374   return generic_as_exist(rc, element_as);
 375 }
 376
 377 void generic_src_dst_check(AS_t rc, const char *src,
 378                            const char *dst)
 379 {
 380
 381   void *src_data = xbt_lib_get_or_null(host_lib, src, ROUTING_HOST_LEVEL);
 382   void *dst_data = xbt_lib_get_or_null(host_lib, dst, ROUTING_HOST_LEVEL);
 383   if (!src_data)
 384     src_data = xbt_lib_get_or_null(as_router_lib, src, ROUTING_ASR_LEVEL);
 385   if (!dst_data)
 386     dst_data = xbt_lib_get_or_null(as_router_lib, dst, ROUTING_ASR_LEVEL);
 387
 388   if (src_data == NULL || dst_data == NULL)
 389     xbt_die("Ask for route \"from\"(%s) or \"to\"(%s) no found at AS \"%s\"",
 390             src, dst, rc->name);
 391
 392   AS_t src_as =
 393       ((network_element_info_t) src_data)->rc_component;
 394   AS_t dst_as =
 395       ((network_element_info_t) dst_data)->rc_component;
 396
 397   if (src_as != dst_as)
 398     xbt_die("The src(%s in %s) and dst(%s in %s) are in differents AS",
 399             src, src_as->name, dst, dst_as->name);
 400   if (rc != dst_as)
 401     xbt_die
 402         ("The routing component of src'%s' and dst'%s' is not the same as the network elements belong (%s?=%s?=%s)",
 403          src, dst, src_as->name, dst_as->name, rc->name);
 404 }