src/surf/network_gtnets.c

   1 /* Copyright (c) 2007, 2008, 2009, 2010. 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 "network_gtnets_private.h"
   8 #include "gtnets/gtnets_interface.h"
   9 #include "xbt/str.h"
  10 #include "surf/surfxml_parse_values.h"
  11
  12 static double time_to_next_flow_completion = -1;
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network_gtnets, surf,
  15                                 "Logging specific to the SURF network GTNetS module");
  16
  17 extern routing_global_t global_routing;
  18
  19 double sg_gtnets_jitter = 0.0;
  20 int sg_gtnets_jitter_seed = 10;
  21
  22 static void link_new(char *name, double bw, double lat, xbt_dict_t props)
  23 {
  24   static int link_count = -1;
  25   network_link_GTNETS_t gtnets_link;
  26
  27   if (xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL)) {
  28     return;
  29   }
  30
  31   XBT_DEBUG("Scanning link name %s", name);
  32
  33
  34   gtnets_link = xbt_new0(s_network_link_GTNETS_t, 1);
  35   gtnets_link->generic_resource.name = name;
  36   gtnets_link->generic_resource.properties = props;
  37   gtnets_link->bw_current = bw;
  38   gtnets_link->lat_current = lat;
  39
  40   link_count++;
  41
  42   XBT_DEBUG("Adding new link, linkid %d, name %s, latency %g, bandwidth %g",
  43            link_count, name, lat, bw);
  44
  45   if (gtnets_add_link(link_count, bw, lat)) {
  46           xbt_die("Cannot create GTNetS link");
  47   }
  48   gtnets_link->id = link_count;
  49
  50   xbt_lib_set(link_lib, name, SURF_LINK_LEVEL, gtnets_link);
  51 }
  52
  53 static void route_new(int src_id, int dst_id, xbt_dynar_t links,
  54                       int nb_link)
  55 {
  56   network_link_GTNETS_t link;
  57   unsigned int cursor;
  58   int i = 0;
  59   int *gtnets_links;
  60
  61   XBT_IN("(src_id=%d, dst_id=%d, links=%p, nb_link=%d)",
  62           src_id, dst_id, links, nb_link);
  63
  64   /* Build the list of gtnets link IDs */
  65   gtnets_links = (int *) calloc(nb_link, sizeof(int));
  66   i = 0;
  67   xbt_dynar_foreach(links, cursor, link) {
  68     gtnets_links[i++] = link->id;
  69   }
  70
  71   if (gtnets_add_route(src_id, dst_id, gtnets_links, nb_link)) {
  72     xbt_die("Cannot create GTNetS route");
  73   }
  74   XBT_OUT();
  75 }
  76
  77 static void route_onehop_new(int src_id, int dst_id,
  78                              network_link_GTNETS_t link)
  79 {
  80   if (gtnets_add_onehop_route(src_id, dst_id, link->id)) {
  81     xbt_die("Cannot create GTNetS route");
  82   }
  83 }
  84
  85 /* Parse the XML for a network link */
  86 static void parse_link_init(void)
  87 {
  88   e_surf_resource_state_t state;
  89   state = SURF_RESOURCE_ON;
  90   XBT_DEBUG("link_gtnets");
  91
  92   if (struct_lnk->V_link_bandwidth_file)
  93     XBT_INFO
  94         ("The GTNetS network model doesn't support bandwidth state traces");
  95   if (struct_lnk->V_link_latency_file)
  96     XBT_INFO("The GTNetS network model doesn't support latency state traces");
  97   if (struct_lnk->V_link_state_file)
  98     XBT_INFO("The GTNetS network model doesn't support link state traces");
  99
 100   if (struct_lnk->V_link_sharing_policy == A_surfxml_link_sharing_policy_FULLDUPLEX)
 101   {
 102           link_new(bprintf("%s_UP",struct_lnk->V_link_id), struct_lnk->V_link_bandwidth, struct_lnk->V_link_latency, current_property_set);
 103           link_new(bprintf("%s_DOWN",struct_lnk->V_link_id), struct_lnk->V_link_bandwidth, struct_lnk->V_link_latency, current_property_set);
 104
 105   }
 106   else  link_new(struct_lnk->V_link_id, struct_lnk->V_link_bandwidth, struct_lnk->V_link_latency, current_property_set);
 107   current_property_set = NULL;
 108 }
 109
 110 /* Create the gtnets topology based on routing strategy */
 111 static void create_gtnets_topology()
 112 {
 113   int src_id,dst_id;
 114
 115    XBT_DEBUG("Starting topology generation");
 116 // À refaire plus tard. Il faut prendre la liste des hôtes/routeurs (dans routing)
 117 // À partir de cette liste, on les numérote.
 118 // Ensuite, on peut utiliser les id pour refaire les appels GTNets qui suivent.
 119
 120    //get the onelinks from the parsed platform
 121    xbt_dynar_t onelink_routes = global_routing->get_onelink_routes();
 122    if (!onelink_routes)
 123      return;
 124
 125    //save them in trace file
 126    onelink_t onelink;
 127    unsigned int iter;
 128    xbt_dynar_foreach(onelink_routes, iter, onelink) {
 129      char *src = onelink->src;
 130      char *dst = onelink->dst;
 131      void *link = onelink->link_ptr;
 132      src_id = *((int *) xbt_dict_get_or_null(global_routing->root->to_index,src));
 133      dst_id = *((int *) xbt_dict_get_or_null(global_routing->root->to_index,dst));
 134
 135      if(src_id != dst_id){
 136      XBT_DEBUG("Link (#%p), src (#%s), dst (#%s), src_id = %d, dst_id = %d", link,src,dst, src_id, dst_id);
 137      XBT_DEBUG("Calling one link route");
 138         if(global_routing->get_network_element_type(src) == SURF_NETWORK_ELEMENT_ROUTER){
 139                 gtnets_add_router(src_id);
 140         }
 141         if(global_routing->get_network_element_type(dst) == SURF_NETWORK_ELEMENT_ROUTER){
 142          gtnets_add_router(dst_id);
 143         }
 144         route_onehop_new(src_id, dst_id, (network_link_GTNETS_t)(link));
 145      }
 146    }
 147
 148    if (XBT_LOG_ISENABLED(surf_network_gtnets, xbt_log_priority_debug)) {
 149         gtnets_print_topology();
 150    }
 151 }
 152
 153 /* Main XML parsing */
 154 static void define_callbacks(const char *file)
 155 {
 156   /* Figuring out the network links */
 157   surfxml_add_callback(ETag_surfxml_link_cb_list, &parse_link_init);
 158   surfxml_add_callback(ETag_surfxml_platform_cb_list,
 159                        &create_gtnets_topology);
 160 }
 161
 162 static int resource_used(void *resource_id)
 163 {
 164   xbt_die("The resource_used feature is not implemented in GTNets model");
 165 }
 166
 167 static int action_unref(surf_action_t action)
 168 {
 169   action->refcount--;
 170   if (!action->refcount) {
 171     xbt_swag_remove(action, action->state_set);
 172 #ifdef HAVE_TRACING
 173     if (action->category)
 174       xbt_free(action->category);
 175 #endif
 176     surf_action_free(&action);
 177     return 1;
 178   }
 179   return 0;
 180 }
 181
 182 static void action_cancel(surf_action_t action)
 183 {
 184   xbt_die("Cannot cancel GTNetS flow");
 185   return;
 186 }
 187
 188 static void action_recycle(surf_action_t action)
 189 {
 190   xbt_die("Cannot recycle GTNetS flow");
 191   return;
 192 }
 193
 194 static double action_get_remains(surf_action_t action)
 195 {
 196   return action->remains;
 197 }
 198
 199 static void action_state_set(surf_action_t action,
 200                              e_surf_action_state_t state)
 201 {
 202   surf_action_state_set(action, state);
 203 }
 204
 205 static double share_resources(double now)
 206 {
 207   xbt_swag_t running_actions =
 208       surf_network_model->states.running_action_set;
 209
 210   //get the first relevant value from the running_actions list
 211   if (!xbt_swag_size(running_actions))
 212     return -1.0;
 213
 214   xbt_assert(time_to_next_flow_completion,
 215               "Time to next flow completion not initialized!\n");
 216
 217   XBT_DEBUG("Calling gtnets_get_time_to_next_flow_completion");
 218   time_to_next_flow_completion = gtnets_get_time_to_next_flow_completion();
 219   XBT_DEBUG("gtnets_get_time_to_next_flow_completion received %lg",
 220          time_to_next_flow_completion);
 221
 222   return time_to_next_flow_completion;
 223 }
 224
 225 static void update_actions_state(double now, double delta)
 226 {
 227   surf_action_network_GTNETS_t action = NULL;
 228   xbt_swag_t running_actions =
 229       surf_network_model->states.running_action_set;
 230
 231   /* If there are no running flows, just return */
 232   if (time_to_next_flow_completion < 0.0) {
 233     return;
 234   }
 235
 236   /* if delta == time_to_next_flow_completion, too. */
 237   if (time_to_next_flow_completion <= delta) {  /* run until the first flow completes */
 238     void **metadata;
 239     int i, num_flows;
 240
 241     num_flows = 0;
 242
 243     if (gtnets_run_until_next_flow_completion(&metadata, &num_flows)) {
 244       xbt_die("Cannot run GTNetS simulation until next flow completion");
 245     }
 246     if (num_flows < 1) {
 247       xbt_die("GTNetS simulation couldn't find a flow that would complete");
 248     }
 249
 250     xbt_swag_foreach(action, running_actions) {
 251       XBT_DEBUG("Action (%p) remains old value: %f", action,
 252              action->generic_action.remains);
 253       double sent = gtnets_get_flow_rx(action);
 254
 255       XBT_DEBUG("Sent value returned by GTNetS : %f", sent);
 256
 257 #ifdef HAVE_TRACING
 258       action->last_remains = action->generic_action.remains;
 259 #endif
 260
 261      //need to trust this remain value
 262      if (sent == 0) {
 263        action->generic_action.remains = 0;
 264       } else {
 265         action->generic_action.remains =
 266             action->generic_action.cost - sent;
 267       }
 268
 269      // verify that this action is a finishing action.
 270      int found=0;
 271      for (i = 0; i < num_flows; i++) {
 272        if(action == (surf_action_network_GTNETS_t) (metadata[i])){
 273            found = 1;
 274            break;
 275        }
 276      }
 277
 278      // indeed this action have not yet started
 279      // because of that we need to fix the remaining to the
 280      // original total cost
 281      if(found != 1 && action->generic_action.remains == 0 ){
 282          action->generic_action.remains = action->generic_action.cost;
 283      }
 284
 285      XBT_DEBUG("Action (%p) remains new value: %f", action,
 286              action->generic_action.remains);
 287
 288 #ifdef HAVE_TRACING
 289       if (TRACE_is_enabled()) {
 290         double last_amount_sent = (action->generic_action.cost - action->last_remains);
 291         double amount_sent = (action->generic_action.cost - action->generic_action.remains);
 292
 293         // tracing resource utilization
 294         xbt_dynar_t route = global_routing->get_route(action->src_name,
 295                                                       action->dst_name);
 296         network_link_GTNETS_t link;
 297         unsigned int i;
 298         xbt_dynar_foreach(route, i, link) {
 299           TRACE_surf_link_set_utilization (link->generic_resource.name,
 300                                            action->generic_action.data,
 301                                            (surf_action_t) action,
 302                                            (amount_sent - last_amount_sent)/(delta),
 303                                            now-delta,
 304                                            delta);
 305         }
 306       }
 307 #endif
 308
 309
 310     }
 311
 312     for (i = 0; i < num_flows; i++) {
 313       action = (surf_action_network_GTNETS_t) (metadata[i]);
 314
 315
 316
 317       action->generic_action.finish = now + time_to_next_flow_completion;
 318       action_state_set((surf_action_t) action, SURF_ACTION_DONE);
 319       XBT_DEBUG("----> Action (%p) just terminated", action);
 320
 321 #ifdef HAVE_TRACING
 322       TRACE_surf_gtnets_destroy(action);
 323 #endif
 324     }
 325
 326
 327   } else {                      /* run for a given number of seconds */
 328     if (gtnets_run(delta)) {
 329       xbt_die("Cannot run GTNetS simulation");
 330     }
 331   }
 332
 333   return;
 334 }
 335
 336 static void update_resource_state(void *id,
 337                                   tmgr_trace_event_t event_type,
 338                                   double value, double date)
 339 {
 340   xbt_die("Cannot update model state for GTNetS simulation");
 341 }
 342
 343 /* Max durations are not supported */
 344 static surf_action_t communicate(const char *src_name,
 345                                  const char *dst_name, double size,
 346                                  double rate)
 347 {
 348   int src, dst;
 349
 350   // Utiliser le dictionnaire définit dans create_gtnets_topology pour initialiser correctement src et dst
 351   src = dst = -1;
 352   surf_action_network_GTNETS_t action = NULL;
 353
 354   src = *((int *) xbt_dict_get_or_null(global_routing->root->to_index,src_name));
 355   dst = *((int *) xbt_dict_get_or_null(global_routing->root->to_index,dst_name));
 356   xbt_assert((src >= 0
 357                && dst >= 0), "Either src or dst have invalid id (id<0)");
 358
 359   XBT_DEBUG("Setting flow src %d \"%s\", dst %d \"%s\"", src, src_name, dst,
 360          dst_name);
 361
 362   xbt_dynar_t links = global_routing->get_route(src_name, dst_name);
 363   route_new(src, dst, links, xbt_dynar_length(links));
 364
 365   action =
 366       surf_action_new(sizeof(s_surf_action_network_GTNETS_t), size,
 367                       surf_network_model, 0);
 368
 369 #ifdef HAVE_TRACING
 370   action->last_remains = 0;
 371 #endif
 372
 373   /* Add a flow to the GTNets Simulation, associated to this action */
 374   if (gtnets_create_flow(src, dst, size, (void *) action) < 0) {
 375     xbt_die("Not route between host %s and host %s", src_name, dst_name);
 376   }
 377 #ifdef HAVE_TRACING
 378   TRACE_surf_gtnets_communicate(action, src_name, dst_name);
 379 #endif
 380
 381   return (surf_action_t) action;
 382 }
 383
 384 /* Suspend a flow() */
 385 static void action_suspend(surf_action_t action)
 386 {
 387   THROW_UNIMPLEMENTED;
 388 }
 389
 390 /* Resume a flow() */
 391 static void action_resume(surf_action_t action)
 392 {
 393   THROW_UNIMPLEMENTED;
 394 }
 395
 396 /* Test whether a flow is suspended */
 397 static int action_is_suspended(surf_action_t action)
 398 {
 399   return 0;
 400 }
 401
 402 #ifdef HAVE_TRACING
 403 static void gtnets_action_set_category(surf_action_t action, const char *category)
 404 {
 405   action->category = xbt_strdup (category);
 406 }
 407 #endif
 408
 409 static void finalize(void)
 410 {
 411   gtnets_finalize();
 412 }
 413
 414 static void surf_network_model_init_internal(void)
 415 {
 416   surf_network_model = surf_model_init();
 417
 418   surf_network_model->name = "network GTNetS";
 419   surf_network_model->action_unref = action_unref;
 420   surf_network_model->action_cancel = action_cancel;
 421   surf_network_model->action_recycle = action_recycle;
 422   surf_network_model->action_state_set = action_state_set;
 423   surf_network_model->get_remains = action_get_remains;
 424
 425   surf_network_model->model_private->resource_used = resource_used;
 426   surf_network_model->model_private->share_resources = share_resources;
 427   surf_network_model->model_private->update_actions_state =
 428       update_actions_state;
 429   surf_network_model->model_private->update_resource_state =
 430       update_resource_state;
 431   surf_network_model->model_private->finalize = finalize;
 432
 433   surf_network_model->suspend = action_suspend;
 434   surf_network_model->resume = action_resume;
 435   surf_network_model->is_suspended = action_is_suspended;
 436 #ifdef HAVE_TRACING
 437   surf_network_model->set_category = gtnets_action_set_category;
 438 #endif
 439
 440   surf_network_model->extension.network.communicate = communicate;
 441
 442   /* Added the initialization for GTNetS interface */
 443   if (gtnets_initialize(sg_tcp_gamma)) {
 444     xbt_die("Impossible to initialize GTNetS interface");
 445   }
 446
 447   routing_model_create(sizeof(network_link_GTNETS_t), NULL, NULL);
 448 }
 449
 450 #ifdef HAVE_LATENCY_BOUND_TRACKING
 451 static int get_latency_limited(surf_action_t action)
 452 {
 453   return 0;
 454 }
 455 #endif
 456
 457 void surf_network_model_init_GTNETS(const char *filename)
 458 {
 459   if (surf_network_model)
 460     return;
 461   surf_network_model_init_internal();
 462   define_callbacks(filename);
 463   xbt_dynar_push(model_list, &surf_network_model);
 464
 465 #ifdef HAVE_LATENCY_BOUND_TRACKING
 466   surf_network_model->get_latency_limited = get_latency_limited;
 467 #endif
 468
 469   if (sg_gtnets_jitter > 0.0) {
 470     gtnets_set_jitter(sg_gtnets_jitter);
 471     gtnets_set_jitter_seed(sg_gtnets_jitter_seed);
 472   }
 473
 474   update_model_description(surf_network_model_description,
 475                            "GTNets", surf_network_model);
 476 }