src/surf/network_ns3.c

   1 /* Copyright (c) 2007, 2008, 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 "surf_private.h"
   8 #include "surf/maxmin.h"
   9 #include "surf/ns3/ns3_interface.h"
  10 #include "xbt/lib.h"
  11 #include "surf/network_ns3_private.h"
  12 #include "xbt/str.h"
  13
  14 extern xbt_lib_t host_lib;
  15 extern xbt_lib_t link_lib;
  16 extern xbt_lib_t as_router_lib;
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_ns3, surf,
  19                                 "Logging specific to the SURF network NS3 module");
  20
  21 extern routing_global_t global_routing;
  22 extern xbt_dict_t dict_socket;
  23
  24 static double time_to_next_flow_completion = -1;
  25
  26 static double ns3_share_resources(double min);
  27 static void ns3_update_actions_state(double now, double delta);
  28 static void finalize(void);
  29 static surf_action_t ns3_communicate(const char *src_name,
  30                                  const char *dst_name, double size, double rate);
  31 static void action_suspend(surf_action_t action);
  32 static void action_resume(surf_action_t action);
  33 static int action_is_suspended(surf_action_t action);
  34 static int action_unref(surf_action_t action);
  35
  36 xbt_dynar_t IPV4addr;
  37
  38 static void replace_str(char *str, const char *orig, const char *rep)
  39 {
  40   char buffer[30];
  41   char *p;
  42
  43   if(!(p = strstr(str, orig)))  // Is 'orig' even in 'str'?
  44     return;
  45
  46   strncpy(buffer, str, p-str); // Copy characters from 'str' start to 'orig' st$
  47   buffer[p-str] = '\0';
  48
  49   sprintf(buffer+(p-str), "%s%s", rep, p+strlen(orig));
  50   xbt_free(str);
  51   str = xbt_strdup(buffer);
  52 }
  53
  54 static void replace_bdw_ns3(char ** bdw)
  55 {
  56         char *temp = xbt_strdup(*bdw);
  57         xbt_free(*bdw);
  58         *bdw = bprintf("%fBps",atof(temp));
  59         xbt_free(temp);
  60
  61 }
  62
  63 static void replace_lat_ns3(char ** lat)
  64 {
  65         char *temp = xbt_strdup(*lat);
  66         xbt_free(*lat);
  67         *lat = bprintf("%fs",atof(temp));
  68         xbt_free(temp);
  69 }
  70
  71 void parse_ns3_add_host(void)
  72 {
  73         XBT_DEBUG("NS3_ADD_HOST '%s'",A_surfxml_host_id);
  74         xbt_lib_set(host_lib,
  75                                 A_surfxml_host_id,
  76                                 NS3_HOST_LEVEL,
  77                                 ns3_add_host(A_surfxml_host_id)
  78                                 );
  79 }
  80
  81 static void ns3_free_dynar(void * elmts){
  82         free(elmts);
  83         return;
  84 }
  85
  86 void parse_ns3_add_link(void)
  87 {
  88         XBT_DEBUG("NS3_ADD_LINK '%s'",A_surfxml_link_id);
  89
  90         if(!IPV4addr) IPV4addr = xbt_dynar_new(sizeof(char*),ns3_free_dynar);
  91
  92         tmgr_trace_t bw_trace;
  93         tmgr_trace_t state_trace;
  94         tmgr_trace_t lat_trace;
  95
  96         bw_trace = tmgr_trace_new(A_surfxml_link_bandwidth_file);
  97         lat_trace = tmgr_trace_new(A_surfxml_link_latency_file);
  98         state_trace = tmgr_trace_new(A_surfxml_link_state_file);
  99
 100         if (bw_trace)
 101                 XBT_INFO("The NS3 network model doesn't support bandwidth state traces");
 102         if (lat_trace)
 103                 XBT_INFO("The NS3 network model doesn't support latency state traces");
 104         if (state_trace)
 105                 XBT_INFO("The NS3 network model doesn't support link state traces");
 106
 107         ns3_link_t link_ns3 = xbt_new0(s_ns3_link_t,1);;
 108         link_ns3->id = xbt_strdup(A_surfxml_link_id);
 109         link_ns3->bdw = xbt_strdup(A_surfxml_link_bandwidth);
 110         link_ns3->lat = xbt_strdup(A_surfxml_link_latency);
 111
 112         surf_ns3_link_t link = xbt_new0(s_surf_ns3_link_t,1);
 113         link->generic_resource.name = xbt_strdup(A_surfxml_link_id);
 114         link->generic_resource.properties = current_property_set;
 115         link->data = link_ns3;
 116         link->created = 1;
 117
 118         xbt_lib_set(link_lib,A_surfxml_link_id,NS3_LINK_LEVEL,link_ns3);
 119         xbt_lib_set(link_lib,A_surfxml_link_id,SURF_LINK_LEVEL,link);
 120 }
 121 void parse_ns3_add_router(void)
 122 {
 123         XBT_DEBUG("NS3_ADD_ROUTER '%s'",A_surfxml_router_id);
 124         xbt_lib_set(as_router_lib,
 125                                 A_surfxml_router_id,
 126                                 NS3_ASR_LEVEL,
 127                                 ns3_add_router(A_surfxml_router_id)
 128                                 );
 129 }
 130 void parse_ns3_add_AS(void)
 131 {
 132         XBT_DEBUG("NS3_ADD_AS '%s'",A_surfxml_AS_id);
 133         xbt_lib_set(as_router_lib,
 134                                 A_surfxml_AS_id,
 135                                 NS3_ASR_LEVEL,
 136                                 ns3_add_AS(A_surfxml_AS_id)
 137                                 );
 138 }
 139 void parse_ns3_add_cluster(void)
 140 {
 141         char *cluster_prefix = A_surfxml_cluster_prefix;
 142         char *cluster_suffix = A_surfxml_cluster_suffix;
 143         char *cluster_radical = A_surfxml_cluster_radical;
 144         char *cluster_bb_bw = A_surfxml_cluster_bb_bw;
 145         char *cluster_bb_lat = A_surfxml_cluster_bb_lat;
 146         char *cluster_bw = A_surfxml_cluster_bw;
 147         char *cluster_lat = A_surfxml_cluster_lat;
 148         char *groups = NULL;
 149
 150         int start, end, i;
 151         unsigned int iter;
 152
 153         xbt_dynar_t radical_elements;
 154         xbt_dynar_t radical_ends;
 155         xbt_dynar_t tab_elements_num = xbt_dynar_new(sizeof(int), NULL);
 156
 157         char *router_id,*host_id;
 158
 159         radical_elements = xbt_str_split(cluster_radical, ",");
 160         xbt_dynar_foreach(radical_elements, iter, groups) {
 161                 radical_ends = xbt_str_split(groups, "-");
 162
 163                 switch (xbt_dynar_length(radical_ends)) {
 164                 case 1:
 165                   surf_parse_get_int(&start,xbt_dynar_get_as(radical_ends, 0, char *));
 166                   xbt_dynar_push_as(tab_elements_num, int, start);
 167                   router_id = bprintf("ns3_%s%d%s", cluster_prefix, start, cluster_suffix);
 168                   xbt_lib_set(host_lib,
 169                                                 router_id,
 170                                                 NS3_HOST_LEVEL,
 171                                                 ns3_add_host_cluster(router_id)
 172                                                 );
 173                   XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
 174                   free(router_id);
 175                   break;
 176
 177                 case 2:
 178                   surf_parse_get_int(&start,xbt_dynar_get_as(radical_ends, 0, char *));
 179                   surf_parse_get_int(&end, xbt_dynar_get_as(radical_ends, 1, char *));
 180                   for (i = start; i <= end; i++){
 181                         xbt_dynar_push_as(tab_elements_num, int, i);
 182                         router_id = bprintf("ns3_%s%d%s", cluster_prefix, i, cluster_suffix);
 183                         xbt_lib_set(host_lib,
 184                                                 router_id,
 185                                                 NS3_HOST_LEVEL,
 186                                                 ns3_add_host_cluster(router_id)
 187                                                 );
 188                         XBT_DEBUG("NS3_ADD_ROUTER '%s'",router_id);
 189                         free(router_id);
 190                   }
 191                   break;
 192
 193                 default:
 194                   XBT_DEBUG("Malformed radical");
 195                 }
 196         }
 197
 198         //Create links
 199         unsigned int cpt;
 200         int elmts;
 201         char * lat = xbt_strdup(cluster_lat);
 202         char * bw =  xbt_strdup(cluster_bw);
 203         replace_lat_ns3(&lat);
 204         replace_bdw_ns3(&bw);
 205
 206         xbt_dynar_foreach(tab_elements_num,cpt,elmts)
 207         {
 208                 host_id   = bprintf("%s%d%s", cluster_prefix, elmts, cluster_suffix);
 209                 router_id = bprintf("ns3_%s%d%s", cluster_prefix, elmts, cluster_suffix);
 210                 XBT_DEBUG("Create link from '%s' to '%s'",host_id,router_id);
 211
 212                 ns3_nodes_t host_src = xbt_lib_get_or_null(host_lib,host_id,  NS3_HOST_LEVEL);
 213                 ns3_nodes_t host_dst = xbt_lib_get_or_null(host_lib,router_id,NS3_HOST_LEVEL);
 214
 215                 if(host_src && host_dst){}
 216                 else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
 217
 218                 ns3_add_link(host_src->node_num,host_src->type,
 219                                          host_dst->node_num,host_dst->type,
 220                                          bw,lat);
 221
 222                 free(router_id);
 223                 free(host_id);
 224         }
 225         xbt_dynar_free(&tab_elements_num);
 226
 227
 228         //Create link backbone
 229         lat = xbt_strdup(cluster_bb_lat);
 230         bw =  xbt_strdup(cluster_bb_bw);
 231         replace_lat_ns3(&lat);
 232         replace_bdw_ns3(&bw);
 233         ns3_add_cluster(bw,lat,A_surfxml_cluster_id);
 234         xbt_free(lat);
 235         xbt_free(bw);
 236 }
 237
 238 double ns3_get_link_latency (const void *link)
 239 {
 240         double lat;
 241         //XBT_DEBUG("link_id:%s link_lat:%s link_bdw:%s",((surf_ns3_link_t)link)->data->id,((surf_ns3_link_t)link)->data->lat,((surf_ns3_link_t)link)->data->bdw);
 242         sscanf(((surf_ns3_link_t)link)->data->lat,"%lg",&lat);
 243         return lat;
 244 }
 245 double ns3_get_link_bandwidth (const void *link)
 246 {
 247         double bdw;
 248         //XBT_DEBUG("link_id:%s link_lat:%s link_bdw:%s",((surf_ns3_link_t)link)->data->id,((surf_ns3_link_t)link)->data->lat,((surf_ns3_link_t)link)->data->bdw);
 249         sscanf(((surf_ns3_link_t)link)->data->bdw,"%lg",&bdw);
 250         return bdw;
 251 }
 252
 253 static xbt_dynar_t ns3_get_route(const char *src, const char *dst)
 254 {
 255   return global_routing->get_route(src, dst);
 256 }
 257
 258 void parse_ns3_end_platform(void)
 259 {
 260         ns3_end_platform();
 261 }
 262
 263 /* Create the ns3 topology based on routing strategy */
 264 void create_ns3_topology()
 265 {
 266    XBT_DEBUG("Starting topology generation");
 267
 268    xbt_dynar_shrink(IPV4addr,0);
 269
 270    //get the onelinks from the parsed platform
 271    xbt_dynar_t onelink_routes = global_routing->get_onelink_routes();
 272    if (!onelink_routes)
 273      xbt_die("There is no routes!");
 274    XBT_DEBUG("Have get_onelink_routes, found %ld routes",onelink_routes->used);
 275    //save them in trace file
 276    onelink_t onelink;
 277    unsigned int iter;
 278    xbt_dynar_foreach(onelink_routes, iter, onelink) {
 279      char *src = onelink->src;
 280      char *dst = onelink->dst;
 281      void *link = onelink->link_ptr;
 282
 283      if( strcmp(src,dst) && ((surf_ns3_link_t)link)->created){
 284      XBT_DEBUG("Route from '%s' to '%s' with link '%s'",src,dst,((surf_ns3_link_t)link)->data->id);
 285      char * link_bdw = xbt_strdup(((surf_ns3_link_t)link)->data->bdw);
 286          char * link_lat = xbt_strdup(((surf_ns3_link_t)link)->data->lat);
 287          replace_lat_ns3(&link_lat);
 288          replace_bdw_ns3(&link_bdw);
 289          ((surf_ns3_link_t)link)->created = 0;
 290
 291          //      XBT_DEBUG("src (%s), dst (%s), src_id = %d, dst_id = %d",src,dst, src_id, dst_id);
 292      XBT_DEBUG("\tLink (%s) bdw:%s lat:%s",((surf_ns3_link_t)link)->data->id,
 293                  link_bdw,
 294                  link_lat
 295                  );
 296
 297      //create link ns3
 298      ns3_nodes_t host_src = xbt_lib_get_or_null(host_lib,src,NS3_HOST_LEVEL);
 299      if(!host_src) host_src = xbt_lib_get_or_null(as_router_lib,src,NS3_ASR_LEVEL);
 300      ns3_nodes_t host_dst = xbt_lib_get_or_null(host_lib,dst,NS3_HOST_LEVEL);
 301      if(!host_dst) host_dst = xbt_lib_get_or_null(as_router_lib,dst,NS3_ASR_LEVEL);
 302
 303      if(host_src && host_dst){}
 304      else xbt_die("\tns3_add_link from %d to %d",host_src->node_num,host_dst->node_num);
 305
 306      ns3_add_link(host_src->node_num,host_src->type,host_dst->node_num,host_dst->type,link_bdw,link_lat);
 307
 308      xbt_free(link_bdw);
 309      xbt_free(link_lat);
 310      }
 311    }
 312 }
 313
 314 static void define_callbacks_ns3(void)
 315 {
 316   surfxml_add_callback(STag_surfxml_host_cb_list, &parse_ns3_add_host);       //HOST
 317   surfxml_add_callback(STag_surfxml_router_cb_list, &parse_ns3_add_router);       //ROUTER
 318   surfxml_add_callback(STag_surfxml_link_cb_list, &parse_ns3_add_link);       //LINK
 319   surfxml_add_callback(STag_surfxml_AS_cb_list, &parse_ns3_add_AS);                   //AS
 320   surfxml_add_callback(STag_surfxml_cluster_cb_list, &parse_ns3_add_cluster); //CLUSTER
 321
 322   surfxml_add_callback(ETag_surfxml_platform_cb_list, &create_ns3_topology);    //get_one_link_routes
 323   surfxml_add_callback(ETag_surfxml_platform_cb_list, &parse_ns3_end_platform); //InitializeRoutes
 324 }
 325
 326 static void free_ns3_elmts(void * elmts)
 327 {
 328 }
 329
 330 static void free_ns3_link(void * elmts)
 331 {
 332         ns3_link_t link = elmts;
 333         free(link->id);
 334         free(link->bdw);
 335         free(link->lat);
 336         free(link);
 337 }
 338
 339 static void free_ns3_host(void * elmts)
 340 {
 341         ns3_nodes_t host = elmts;
 342         free(host);
 343 }
 344
 345 #ifdef HAVE_LATENCY_BOUND_TRACKING
 346 static int ns3_get_link_latency_limited(surf_action_t action)
 347 {
 348   return 0;
 349 }
 350 #endif
 351
 352 #ifdef HAVE_TRACING
 353 static void ns3_action_set_category(surf_action_t action, const char *category)
 354 {
 355   action->category = xbt_strdup (category);
 356 }
 357 #endif
 358
 359 void surf_network_model_init_NS3()
 360 {
 361         if (surf_network_model)
 362                 return;
 363
 364         surf_network_model = surf_model_init();
 365         surf_network_model->name = "network NS3";
 366         surf_network_model->extension.network.get_link_latency = ns3_get_link_latency;
 367         surf_network_model->extension.network.get_link_bandwidth = ns3_get_link_bandwidth;
 368         surf_network_model->extension.network.get_route = ns3_get_route;
 369
 370         surf_network_model->model_private->share_resources = ns3_share_resources;
 371         surf_network_model->model_private->update_actions_state = ns3_update_actions_state;
 372         surf_network_model->model_private->finalize = finalize;
 373
 374         surf_network_model->suspend = action_suspend;
 375         surf_network_model->resume = action_resume;
 376         surf_network_model->is_suspended = action_is_suspended;
 377         surf_network_model->action_unref = action_unref;
 378         surf_network_model->extension.network.communicate = ns3_communicate;
 379
 380 #ifdef HAVE_TRACING
 381   surf_network_model->set_category = ns3_action_set_category;
 382 #endif
 383
 384         /* Added the initialization for NS3 interface */
 385
 386         if (ns3_initialize(xbt_cfg_get_string(_surf_cfg_set,"ns3/TcpModel"))) {
 387         xbt_die("Impossible to initialize NS3 interface");
 388         }
 389
 390         routing_model_create(sizeof(s_surf_ns3_link_t), NULL, NULL);
 391         define_callbacks_ns3();
 392
 393         NS3_HOST_LEVEL = xbt_lib_add_level(host_lib,(void_f_pvoid_t)free_ns3_host);
 394         NS3_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,(void_f_pvoid_t)free_ns3_host);
 395         NS3_LINK_LEVEL = xbt_lib_add_level(link_lib,(void_f_pvoid_t)free_ns3_link);
 396
 397         xbt_dynar_push(model_list, &surf_network_model);
 398         update_model_description(surf_network_model_description,
 399                     "NS3", surf_network_model);
 400
 401 #ifdef HAVE_LATENCY_BOUND_TRACKING
 402         surf_network_model->get_latency_limited = ns3_get_link_latency_limited;
 403 #endif
 404 }
 405
 406 static void finalize(void)
 407 {
 408         ns3_finalize();
 409         xbt_dynar_free_container(&IPV4addr);
 410         xbt_dict_free(&dict_socket);
 411 }
 412
 413 static double ns3_share_resources(double min)
 414 {
 415         XBT_DEBUG("ns3_share_resources");
 416
 417         xbt_swag_t running_actions =
 418           surf_network_model->states.running_action_set;
 419
 420         //get the first relevant value from the running_actions list
 421         if (!xbt_swag_size(running_actions) || min == 0.0)
 422           return -1.0;
 423         else
 424          do {
 425            ns3_simulator(min);
 426            time_to_next_flow_completion = ns3_time() - surf_get_clock();
 427          } while(double_equals(time_to_next_flow_completion,0));
 428
 429         XBT_DEBUG("min       : %f",min);
 430         XBT_DEBUG("ns3  time : %f",ns3_time());
 431         XBT_DEBUG("surf time : %f",surf_get_clock());
 432         XBT_DEBUG("Next completion %f :",time_to_next_flow_completion);
 433
 434         return time_to_next_flow_completion;
 435 }
 436
 437 static void ns3_update_actions_state(double now, double delta)
 438 {
 439           xbt_dict_cursor_t cursor = NULL;
 440           char *key;
 441           void *data;
 442
 443           static xbt_dynar_t socket_to_destroy = NULL;
 444     if(!socket_to_destroy) socket_to_destroy = xbt_dynar_new(sizeof(char*),NULL);
 445
 446           surf_action_network_ns3_t action = NULL;
 447           xbt_swag_t running_actions =
 448               surf_network_model->states.running_action_set;
 449
 450           /* If there are no running flows, just return */
 451           if (!xbt_swag_size(running_actions)) {
 452             while(double_positive(now-ns3_time())) {
 453               ns3_simulator(now-ns3_time());
 454             }
 455             return;
 456           }
 457
 458           xbt_dict_foreach(dict_socket,cursor,key,data){
 459             action = (surf_action_network_ns3_t)ns3_get_socket_action(data);
 460             XBT_DEBUG("Processing socket %p (action %p)",data,action);
 461             action->generic_action.remains = action->generic_action.cost - ns3_get_socket_sent(data);
 462
 463 #ifdef HAVE_TRACING
 464             if (TRACE_is_enabled() &&
 465                 surf_action_state_get(&(action->generic_action)) == SURF_ACTION_RUNNING){
 466               double data_sent = ns3_get_socket_sent(data);
 467               double data_delta_sent = data_sent - action->last_sent;
 468
 469               xbt_dynar_t route = global_routing->get_route(action->src_name, action->dst_name);
 470               unsigned int i;
 471               for (i = 0; i < xbt_dynar_length (route); i++){
 472                 surf_ns3_link_t *link = ((surf_ns3_link_t*)xbt_dynar_get_ptr (route, i));
 473                 TRACE_surf_link_set_utilization ((*link)->generic_resource.name,
 474                     action->generic_action.data,
 475                     (surf_action_t) action,
 476                     (data_delta_sent)/delta,
 477                     now-delta,
 478                     delta);
 479               }
 480               action->last_sent = data_sent;
 481             }
 482 #endif
 483
 484             if(ns3_get_socket_is_finished(data) == 1){
 485               xbt_dynar_push(socket_to_destroy,&key);
 486               XBT_DEBUG("Destroy socket %p of action %p", key, action);
 487               action->generic_action.finish = now;
 488               surf_action_state_set(&(action->generic_action), SURF_ACTION_DONE);
 489             }
 490           }
 491
 492           while (!xbt_dynar_is_empty(socket_to_destroy)){
 493             xbt_dynar_pop(socket_to_destroy,&key);
 494
 495             void *data = xbt_dict_get (dict_socket, key);
 496             surf_action_network_ns3_t action = (surf_action_network_ns3_t)ns3_get_socket_action(data);
 497             XBT_DEBUG ("Removing socket %p of action %p", key, action);
 498             xbt_dict_remove(dict_socket,key);
 499           }
 500           return;
 501 }
 502
 503 /* Max durations are not supported */
 504 static surf_action_t ns3_communicate(const char *src_name,
 505                                  const char *dst_name, double size, double rate)
 506 {
 507   surf_action_network_ns3_t action = NULL;
 508
 509   XBT_DEBUG("Communicate from %s to %s",src_name,dst_name);
 510   action = surf_action_new(sizeof(s_surf_action_network_ns3_t), size, surf_network_model, 0);
 511
 512   ns3_create_flow(src_name, dst_name, surf_get_clock(), size, action);
 513
 514 #ifdef HAVE_TRACING
 515   action->last_sent = 0;
 516   action->src_name = xbt_strdup (src_name);
 517   action->dst_name = xbt_strdup (dst_name);
 518 #endif
 519
 520   return (surf_action_t) action;
 521 }
 522
 523 /* Suspend a flow() */
 524 static void action_suspend(surf_action_t action)
 525 {
 526   THROW_UNIMPLEMENTED;
 527 }
 528
 529 /* Resume a flow() */
 530 static void action_resume(surf_action_t action)
 531 {
 532   THROW_UNIMPLEMENTED;
 533 }
 534
 535 /* Test whether a flow is suspended */
 536 static int action_is_suspended(surf_action_t action)
 537 {
 538   return 0;
 539 }
 540
 541 static int action_unref(surf_action_t action)
 542 {
 543   action->refcount--;
 544   if (!action->refcount) {
 545     xbt_swag_remove(action, action->state_set);
 546
 547 #ifdef HAVE_TRACING
 548     xbt_free(((surf_action_network_ns3_t)action)->src_name);
 549     xbt_free(((surf_action_network_ns3_t)action)->dst_name);
 550     xbt_free(action->category);
 551 #endif
 552     XBT_DEBUG ("Removing action %p", action);
 553     surf_action_free(&action);
 554     return 1;
 555   }
 556   return 0;
 557 }