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