src/surf/surf_routing_rulebased.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 #include "surf_routing_private.h"
   7 #include <pcre.h>               /* regular expression library */
   8
   9 /* Global vars */
  10 extern routing_global_t global_routing;
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_rulebased, surf, "Routing part of surf");
  13
  14 /* Routing model structure */
  15
  16 typedef struct {
  17   s_as_t generic_routing;
  18   xbt_dynar_t list_route;
  19   xbt_dynar_t list_ASroute;
  20 } s_AS_rulebased_t, *AS_rulebased_t;
  21
  22 typedef struct s_rule_route s_rule_route_t, *rule_route_t;
  23 typedef struct s_rule_route_extended s_rule_route_extended_t,
  24 *rule_route_extended_t;
  25
  26 struct s_rule_route {
  27   xbt_dynar_t re_str_link;      // dynar of char*
  28   pcre *re_src;
  29   pcre *re_dst;
  30 };
  31
  32 struct s_rule_route_extended {
  33   s_rule_route_t generic_rule_route;
  34   char *re_src_gateway;
  35   char *re_dst_gateway;
  36 };
  37
  38 static void rule_route_free(void *e)
  39 {
  40   rule_route_t *elem = (rule_route_t *) (e);
  41   if (*elem) {
  42     xbt_dynar_free(&(*elem)->re_str_link);
  43     pcre_free((*elem)->re_src);
  44     pcre_free((*elem)->re_dst);
  45     xbt_free(*elem);
  46   }
  47   *elem = NULL;
  48 }
  49
  50 static void rule_route_extended_free(void *e)
  51 {
  52   rule_route_extended_t *elem = (rule_route_extended_t *) e;
  53   if (*elem) {
  54     xbt_dynar_free(&(*elem)->generic_rule_route.re_str_link);
  55     pcre_free((*elem)->generic_rule_route.re_src);
  56     pcre_free((*elem)->generic_rule_route.re_dst);
  57     xbt_free((*elem)->re_src_gateway);
  58     xbt_free((*elem)->re_dst_gateway);
  59     xbt_free(*elem);
  60   }
  61 }
  62
  63 /* Parse routing model functions */
  64
  65 static int model_rulebased_parse_PU(AS_t rc, sg_routing_edge_t elm)
  66 {
  67   AS_rulebased_t routing = (AS_rulebased_t) rc;
  68   xbt_dynar_push(routing->generic_routing.index_network_elm,(void *)elm);
  69   return -1;
  70 }
  71
  72 static int model_rulebased_parse_AS(AS_t rc, sg_routing_edge_t elm)
  73 {
  74   AS_rulebased_t routing = (AS_rulebased_t) rc;
  75   xbt_dynar_push(routing->generic_routing.index_network_elm,(void *)elm);
  76   return -1;
  77 }
  78
  79 static void model_rulebased_parse_route(AS_t rc,
  80     const char *src, const char *dst,
  81     route_t route)
  82 {
  83   AS_rulebased_t routing = (AS_rulebased_t) rc;
  84   rule_route_t ruleroute = xbt_new0(s_rule_route_t, 1);
  85   const char *error;
  86   int erroffset;
  87
  88   if(!strcmp(rc->model_desc->name,"Vivaldi")){
  89     if(!xbt_dynar_is_empty(route->link_list))
  90       xbt_die("You can't have link_ctn with Model Vivaldi.");
  91   }
  92
  93   ruleroute->re_src = pcre_compile(src, 0, &error, &erroffset, NULL);
  94   xbt_assert(ruleroute->re_src,
  95       "PCRE compilation failed at offset %d (\"%s\"): %s\n",
  96       erroffset, src, error);
  97   ruleroute->re_dst = pcre_compile(dst, 0, &error, &erroffset, NULL);
  98   xbt_assert(ruleroute->re_src,
  99       "PCRE compilation failed at offset %d (\"%s\"): %s\n",
 100       erroffset, dst, error);
 101
 102   ruleroute->re_str_link = route->link_list;
 103   route->link_list = NULL; // Don't free it twice in each container
 104
 105   xbt_dynar_push(routing->list_route, &ruleroute);
 106 }
 107
 108 static void model_rulebased_parse_ASroute(AS_t rc,
 109     const char *src, const char *dst,
 110     route_t route)
 111 {
 112   AS_rulebased_t routing = (AS_rulebased_t) rc;
 113   rule_route_extended_t ruleroute_e = xbt_new0(s_rule_route_extended_t, 1);
 114   const char *error;
 115   int erroffset;
 116
 117   if(!strcmp(rc->model_desc->name,"Vivaldi")){
 118     if(!xbt_dynar_is_empty(route->link_list))
 119       xbt_die("You can't have link_ctn with Model Vivaldi.");
 120   }
 121
 122   ruleroute_e->generic_rule_route.re_src =
 123       pcre_compile(src, 0, &error, &erroffset, NULL);
 124   xbt_assert(ruleroute_e->generic_rule_route.re_src,
 125       "PCRE compilation failed at offset %d (\"%s\"): %s\n",
 126       erroffset, src, error);
 127   ruleroute_e->generic_rule_route.re_dst =
 128       pcre_compile(dst, 0, &error, &erroffset, NULL);
 129   xbt_assert(ruleroute_e->generic_rule_route.re_src,
 130       "PCRE compilation failed at offset %d (\"%s\"): %s\n",
 131       erroffset, dst, error);
 132   ruleroute_e->generic_rule_route.re_str_link =
 133       route->link_list;
 134
 135   // DIRTY PERL HACK AHEAD: with the rulebased routing, the {src,dst}_gateway fields
 136   // store the provided name instead of the entity directly (routing_parse_E_ASroute knows)
 137   //
 138   // This is because the user will provide something like "^AS_(.*)$" instead of the proper name of a given entity
 139   ruleroute_e->re_src_gateway = xbt_strdup((char *)route->src_gateway);
 140   ruleroute_e->re_dst_gateway = xbt_strdup((char *)route->dst_gateway);
 141   xbt_dynar_push(routing->list_ASroute, &ruleroute_e);
 142
 143   /* make sure that they don't get freed */
 144   route->link_list = NULL;
 145   route->src_gateway = route->dst_gateway = NULL;
 146 }
 147
 148 static void model_rulebased_parse_bypassroute(AS_t rc,
 149     const char *src,
 150     const char *dst,
 151     route_t e_route)
 152 {
 153   xbt_die("bypass routing not supported for Route-Based model");
 154 }
 155
 156 #define BUFFER_SIZE 4096        /* result buffer size */
 157 #define OVECCOUNT 30            /* should be a multiple of 3 */
 158
 159 static char *remplace(char *value, const char **src_list, int src_size,
 160     const char **dst_list, int dst_size)
 161 {
 162   char result[BUFFER_SIZE];
 163   int i_res = 0;
 164   int i = 0;
 165
 166   while (value[i]) {
 167     if (value[i] == '$') {
 168       i++;                      /* skip the '$' */
 169       if (value[i] < '0' || value[i] > '9')
 170         xbt_die("bad string parameter, no number indication, at offset: "
 171             "%d (\"%s\")", i, value);
 172
 173       /* solve the number */
 174       int number = value[i++] - '0';
 175       while (value[i] >= '0' && value[i] <= '9')
 176         number = 10 * number + (value[i++] - '0');
 177
 178       /* solve the indication */
 179       const char **param_list;
 180       _XBT_GNUC_UNUSED int param_size;
 181       if (value[i] == 's' && value[i + 1] == 'r' && value[i + 2] == 'c') {
 182         param_list = src_list;
 183         param_size = src_size;
 184       } else if (value[i] == 'd' && value[i + 1] == 's'
 185           && value[i + 2] == 't') {
 186         param_list = dst_list;
 187         param_size = dst_size;
 188       } else {
 189         xbt_die("bad string parameter, support only \"src\" and \"dst\", "
 190             "at offset: %d (\"%s\")", i, value);
 191       }
 192       i += 3;
 193
 194       xbt_assert(number < param_size,
 195           "bad string parameter, not enough length param_size, "
 196           "at offset: %d (\"%s\") %d %d", i, value, param_size, number);
 197
 198       const char *param = param_list[number];
 199       int j = 0;
 200       while (param[j] && i_res < BUFFER_SIZE)
 201         result[i_res++] = param[j++];
 202     } else {
 203       result[i_res++] = value[i++]; /* next char */
 204     }
 205     if (i_res >= BUFFER_SIZE)
 206       xbt_die("solving string \"%s\", small buffer size (%d)",
 207           value, BUFFER_SIZE);
 208   }
 209   result[i_res++] = '\0';
 210   char *res = xbt_malloc(i_res);
 211   return memcpy(res, result, i_res);
 212 }
 213
 214 static void rulebased_get_route_and_latency(AS_t rc,
 215     sg_routing_edge_t src, sg_routing_edge_t dst,
 216     route_t res,double*lat);
 217 static xbt_dynar_t rulebased_get_onelink_routes(AS_t rc)
 218 {
 219   xbt_dynar_t ret = xbt_dynar_new (sizeof(onelink_t), xbt_free);
 220   //We have already bypass cluster routes with network NS3
 221   if(!strcmp(surf_network_model->name,"network NS3"))
 222     return ret;
 223
 224   char *k1;
 225
 226   //find router
 227   sg_routing_edge_t router = NULL;
 228   xbt_lib_cursor_t cursor;
 229   xbt_lib_foreach(as_router_lib, cursor, k1, router)
 230   {
 231     if (router->rc_type == SURF_NETWORK_ELEMENT_ROUTER)
 232       break;
 233   }
 234
 235   if (!router)
 236     xbt_die ("rulebased_get_onelink_routes works only if the AS is a cluster, sorry.");
 237
 238   sg_routing_edge_t host = NULL;
 239   xbt_lib_foreach(as_router_lib, cursor, k1, host){
 240     route_t route = xbt_new0(s_route_t,1);
 241     route->link_list = xbt_dynar_new(sizeof(sg_routing_link_t),NULL);
 242     rulebased_get_route_and_latency (rc, router, host, route,NULL);
 243
 244     int number_of_links = xbt_dynar_length(route->link_list);
 245
 246     if(number_of_links == 1) {
 247       //loopback
 248     }
 249     else{
 250       if (number_of_links != 2) {
 251         xbt_die ("rulebased_get_onelink_routes works only if the AS is a cluster, sorry.");
 252       }
 253
 254       void *link_ptr;
 255       xbt_dynar_get_cpy (route->link_list, 1, &link_ptr);
 256       onelink_t onelink = xbt_new0 (s_onelink_t, 1);
 257       onelink->src = host;
 258       onelink->dst = router;
 259       onelink->link_ptr = link_ptr;
 260       xbt_dynar_push (ret, &onelink);
 261     }
 262   }
 263   return ret;
 264 }
 265
 266 /* Business methods */
 267 static void rulebased_get_route_and_latency(AS_t rc,
 268     sg_routing_edge_t src, sg_routing_edge_t dst,
 269     route_t route, double *lat)
 270 {
 271   XBT_DEBUG("rulebased_get_route_and_latency from '%s' to '%s'",src->name,dst->name);
 272   xbt_assert(rc && src
 273       && dst,
 274       "Invalid params for \"get_route\" function at AS \"%s\"",
 275       rc->name);
 276
 277   /* set utils vars */
 278   AS_rulebased_t routing = (AS_rulebased_t) rc;
 279
 280   char* src_name = src->name;
 281   char* dst_name = dst->name;
 282
 283   int are_processing_units=0;
 284   xbt_dynar_t rule_list;
 285   if ((src->rc_type == SURF_NETWORK_ELEMENT_HOST || src->rc_type == SURF_NETWORK_ELEMENT_ROUTER)&&
 286       (dst->rc_type == SURF_NETWORK_ELEMENT_HOST || dst->rc_type == SURF_NETWORK_ELEMENT_ROUTER)){
 287     are_processing_units = 1;
 288     rule_list = routing->list_route;
 289   } else if (src->rc_type == SURF_NETWORK_ELEMENT_AS && dst->rc_type == SURF_NETWORK_ELEMENT_AS) {
 290     are_processing_units = 0;
 291     rule_list = routing->list_ASroute;
 292   } else
 293     THROWF(arg_error,0,"No route from '%s' to '%s'",src_name,dst_name);
 294
 295   int rc_src = -1;
 296   int rc_dst = -1;
 297   int src_length = (int) strlen(src_name);
 298   int dst_length = (int) strlen(dst_name);
 299
 300   rule_route_t ruleroute;
 301   unsigned int cpt;
 302   int ovector_src[OVECCOUNT];
 303   int ovector_dst[OVECCOUNT];
 304   const char **list_src = NULL;
 305   const char **list_dst = NULL;
 306   _XBT_GNUC_UNUSED int res;
 307   xbt_dynar_foreach(rule_list, cpt, ruleroute) {
 308     rc_src =
 309         pcre_exec(ruleroute->re_src, NULL, src_name, src_length, 0, 0,
 310             ovector_src, OVECCOUNT);
 311     if (rc_src >= 0) {
 312       rc_dst =
 313           pcre_exec(ruleroute->re_dst, NULL, dst_name, dst_length, 0, 0,
 314               ovector_dst, OVECCOUNT);
 315       if (rc_dst >= 0) {
 316         res = pcre_get_substring_list(src_name, ovector_src, rc_src, &list_src);
 317         xbt_assert(!res, "error solving substring list for src \"%s\"", src_name);
 318         res = pcre_get_substring_list(dst_name, ovector_dst, rc_dst, &list_dst);
 319         xbt_assert(!res, "error solving substring list for dst \"%s\"", dst_name);
 320         char *link_name;
 321         xbt_dynar_foreach(ruleroute->re_str_link, cpt, link_name) {
 322           char *new_link_name =
 323               remplace(link_name, list_src, rc_src, list_dst, rc_dst);
 324           void *link =
 325               xbt_lib_get_or_null(link_lib, new_link_name, SURF_LINK_LEVEL);
 326           if (link) {
 327             xbt_dynar_push(route->link_list, &link);
 328             if (lat)
 329               *lat += surf_network_model->extension.network.get_link_latency(link);
 330           } else
 331             THROWF(mismatch_error, 0, "Link %s not found", new_link_name);
 332           xbt_free(new_link_name);
 333         }
 334       }
 335     }
 336     if (rc_src >= 0 && rc_dst >= 0)
 337       break;
 338   }
 339
 340   if (rc_src >= 0 && rc_dst >= 0) {
 341     /* matched src and dest, nothing more to do (?) */
 342   } else if (!strcmp(src_name, dst_name) && are_processing_units) {
 343     xbt_dynar_push(route->link_list, &(global_routing->loopback));
 344     if (lat)
 345       *lat += surf_network_model->extension.network.get_link_latency(global_routing->loopback);
 346   } else {
 347     THROWF(arg_error,0,"No route from '%s' to '%s'??",src_name,dst_name);
 348     //xbt_dynar_reset(route->link_list);
 349   }
 350
 351   if (!are_processing_units && !xbt_dynar_is_empty(route->link_list)) {
 352     rule_route_extended_t ruleroute_extended =
 353         (rule_route_extended_t) ruleroute;
 354     char *gw_src_name = remplace(ruleroute_extended->re_src_gateway, list_src, rc_src,
 355         list_dst, rc_dst);
 356     route->src_gateway = sg_routing_edge_by_name_or_null(gw_src_name);
 357     xbt_free(gw_src_name);
 358
 359     char *gw_dst_name = remplace(ruleroute_extended->re_dst_gateway, list_src, rc_src,
 360         list_dst, rc_dst);
 361     route->dst_gateway = sg_routing_edge_by_name_or_null(gw_dst_name);
 362     xbt_free(gw_dst_name);
 363   }
 364
 365   if (list_src)
 366     pcre_free_substring_list(list_src);
 367   if (list_dst)
 368     pcre_free_substring_list(list_dst);
 369 }
 370
 371 static route_t rulebased_get_bypass_route(AS_t rc, sg_routing_edge_t src, sg_routing_edge_t dst, double *lat) {
 372   return NULL;
 373 }
 374
 375 static void rulebased_finalize(AS_t rc)
 376 {
 377   AS_rulebased_t routing =
 378       (AS_rulebased_t) rc;
 379   if (routing) {
 380     xbt_dynar_free(&routing->list_route);
 381     xbt_dynar_free(&routing->list_ASroute);
 382     model_generic_finalize(rc);
 383   }
 384 }
 385
 386 /* Creation routing model functions */
 387 AS_t model_rulebased_create(void) {
 388
 389   AS_rulebased_t new_component = (AS_rulebased_t)
 390           model_generic_create_sized(sizeof(s_AS_rulebased_t));
 391
 392   new_component->generic_routing.parse_PU = model_rulebased_parse_PU;
 393   new_component->generic_routing.parse_AS = model_rulebased_parse_AS;
 394   new_component->generic_routing.parse_route = model_rulebased_parse_route;
 395   new_component->generic_routing.parse_ASroute = model_rulebased_parse_ASroute;
 396   new_component->generic_routing.parse_bypassroute = model_rulebased_parse_bypassroute;
 397   new_component->generic_routing.get_onelink_routes = rulebased_get_onelink_routes;
 398   new_component->generic_routing.get_route_and_latency = rulebased_get_route_and_latency;
 399   new_component->generic_routing.get_bypass_route = rulebased_get_bypass_route;
 400   new_component->generic_routing.finalize = rulebased_finalize;
 401   /* initialization of internal structures */
 402   new_component->list_route = xbt_dynar_new(sizeof(rule_route_t), &rule_route_free);
 403   new_component->list_ASroute =
 404       xbt_dynar_new(sizeof(rule_route_extended_t),
 405           &rule_route_extended_free);
 406
 407   return (AS_t) new_component;
 408 }